labels.c

   1 /* labels.c  label handling for the Netwide Assembler
   2  *
   3  * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
   4  * Julian Hall. All rights reserved. The software is
   5  * redistributable under the licence given in the file "Licence"
   6  * distributed in the NASM archive.
   7  */
   8
   9 #include "compiler.h"
  10
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <stdlib.h>
  14 #include <inttypes.h>
  15
  16 #include "nasm.h"
  17 #include "nasmlib.h"
  18 #include "hashtbl.h"
  19
  20 /*
  21  * A local label is one that begins with exactly one period. Things
  22  * that begin with _two_ periods are NASM-specific things.
  23  *
  24  * If TASM compatibility is enabled, a local label can also begin with
  25  * @@, so @@local is a TASM compatible local label. Note that we only
  26  * check for the first @ symbol, although TASM requires both.
  27  */
  28 #define islocal(l)                                              \
  29         (tasm_compatible_mode ?                                 \
  30         (((l)[0] == '.' || (l)[0] == '@') && (l)[1] != '.') :   \
  31         ((l)[0] == '.' && (l)[1] != '.'))
  32 #define islocalchar(c)                                          \
  33         (tasm_compatible_mode ?                                  \
  34         ((c) == '.' || (c) == '@') :                            \
  35         ((c) == '.'))
  36
  37 #define LABEL_BLOCK  128        /* no. of labels/block */
  38 #define LBLK_SIZE    (LABEL_BLOCK*sizeof(union label))
  39
  40 #define END_LIST -3             /* don't clash with NO_SEG! */
  41 #define END_BLOCK -2
  42 #define BOGUS_VALUE -4
  43
  44 #define PERMTS_SIZE  4096       /* size of text blocks */
  45 #if (PERMTS_SIZE > IDLEN_MAX)
  46 #error "IPERMTS_SIZE must be less than or equal to IDLEN_MAX"
  47 #endif
  48
  49 /* values for label.defn.is_global */
  50 #define DEFINED_BIT 1
  51 #define GLOBAL_BIT 2
  52 #define EXTERN_BIT 4
  53
  54 #define NOT_DEFINED_YET 0
  55 #define TYPE_MASK 3
  56 #define LOCAL_SYMBOL (DEFINED_BIT)
  57 #define GLOBAL_PLACEHOLDER (GLOBAL_BIT)
  58 #define GLOBAL_SYMBOL (DEFINED_BIT|GLOBAL_BIT)
  59
  60 union label {                   /* actual label structures */
  61     struct {
  62         int32_t segment, offset;
  63         char *label, *special;
  64         int is_global, is_norm;
  65     } defn;
  66     struct {
  67         int32_t movingon, dummy;
  68         union label *next;
  69     } admin;
  70 };
  71
  72 struct permts {                 /* permanent text storage */
  73     struct permts *next;        /* for the linked list */
  74     int size, usage;            /* size and used space in ... */
  75     char data[PERMTS_SIZE];     /* ... the data block itself */
  76 };
  77
  78 extern int global_offset_changed;       /* defined in nasm.c */
  79
  80 static struct hash_table *ltab;         /* labels hash table */
  81 static union label *ldata;              /* all label data blocks */
  82 static union label *lfree;              /* labels free block */
  83 static struct permts *perm_head;        /* start of perm. text storage */
  84 static struct permts *perm_tail;        /* end of perm. text storage */
  85
  86 static void init_block(union label *blk);
  87 static char *perm_copy(const char *string);
  88
  89 static char *prevlabel;
  90
  91 static int initialized = false;
  92
  93 char lprefix[PREFIX_MAX] = { 0 };
  94 char lpostfix[PREFIX_MAX] = { 0 };
  95
  96 /*
  97  * Internal routine: finds the `union label' corresponding to the
  98  * given label name. Creates a new one, if it isn't found, and if
  99  * `create' is true.
 100  */
 101 static union label *find_label(char *label, int create)
 102 {
 103     char *prev;
 104     int prevlen, len;
 105     union label *lptr, **lpp;
 106     char label_str[IDLEN_MAX];
 107     struct hash_insert ip;
 108
 109     if (islocal(label)) {
 110         prev = prevlabel;
 111         prevlen = strlen(prev);
 112         len = strlen(label);
 113         if (prevlen+len >= IDLEN_MAX)
 114             return NULL;        /* Error... */
 115         memcpy(label_str, prev, prevlen);
 116         memcpy(label_str+prevlen, label, len+1);
 117         label = label_str;
 118     } else {
 119         prev = "";
 120         prevlen = 0;
 121     }
 122
 123     lpp = (union label **) hash_find(ltab, label, &ip);
 124     lptr = lpp ? *lpp : NULL;
 125
 126     if (lptr || !create)
 127         return lptr;
 128
 129     /* Create a new label... */
 130     if (lfree->admin.movingon == END_BLOCK) {
 131         /*
 132          * must allocate a new block
 133          */
 134         lfree->admin.next =
 135             (union label *)nasm_malloc(LBLK_SIZE);
 136         lfree = lfree->admin.next;
 137         init_block(lfree);
 138     }
 139
 140     lfree->admin.movingon = BOGUS_VALUE;
 141     lfree->defn.label = perm_copy(label);
 142     lfree->defn.special = NULL;
 143     lfree->defn.is_global = NOT_DEFINED_YET;
 144
 145     hash_add(&ip, lfree->defn.label, lfree);
 146     return lfree++;
 147 }
 148
 149 int lookup_label(char *label, int32_t *segment, int32_t *offset)
 150 {
 151     union label *lptr;
 152
 153     if (!initialized)
 154         return 0;
 155
 156     lptr = find_label(label, 0);
 157     if (lptr && (lptr->defn.is_global & DEFINED_BIT)) {
 158         *segment = lptr->defn.segment;
 159         *offset = lptr->defn.offset;
 160         return 1;
 161     } else
 162         return 0;
 163 }
 164
 165 int is_extern(char *label)
 166 {
 167     union label *lptr;
 168
 169     if (!initialized)
 170         return 0;
 171
 172     lptr = find_label(label, 0);
 173     if (lptr && (lptr->defn.is_global & EXTERN_BIT))
 174         return 1;
 175     else
 176         return 0;
 177 }
 178
 179 void redefine_label(char *label, int32_t segment, int32_t offset, char *special,
 180                     int is_norm, int isextrn, struct ofmt *ofmt,
 181                     efunc error)
 182 {
 183     union label *lptr;
 184     int exi;
 185
 186     /* This routine possibly ought to check for phase errors.  Most assemblers
 187      * check for phase errors at this point.  I don't know whether phase errors
 188      * are even possible, nor whether they are checked somewhere else
 189      */
 190
 191     (void)segment;              /* Don't warn that this parameter is unused */
 192     (void)special;              /* Don't warn that this parameter is unused */
 193     (void)is_norm;              /* Don't warn that this parameter is unused */
 194     (void)isextrn;              /* Don't warn that this parameter is unused */
 195     (void)ofmt;                 /* Don't warn that this parameter is unused */
 196
 197 #ifdef DEBUG
 198 #if DEBUG<3
 199     if (!strncmp(label, "debugdump", 9))
 200 #endif
 201         error(ERR_DEBUG, "redefine_label (%s, %ld, %08lx, %s, %d, %d)",
 202               label, segment, offset, special, is_norm, isextrn);
 203 #endif
 204
 205     lptr = find_label(label, 1);
 206     if (!lptr)
 207         error(ERR_PANIC, "can't find label `%s' on pass two", label);
 208
 209     if (!islocal(label)) {
 210         if (!islocalchar(*label) && lptr->defn.is_norm)
 211             prevlabel = lptr->defn.label;
 212     }
 213
 214     global_offset_changed |= (lptr->defn.offset != offset);
 215     lptr->defn.offset = offset;
 216
 217     if (pass0 == 1) {
 218         exi = !!(lptr->defn.is_global & GLOBAL_BIT);
 219         if (exi) {
 220             char *xsymbol;
 221             int slen;
 222             slen = strlen(lprefix);
 223             slen += strlen(lptr->defn.label);
 224             slen += strlen(lpostfix);
 225             slen++;             /* room for that null char */
 226             xsymbol = nasm_malloc(slen);
 227             snprintf(xsymbol, slen, "%s%s%s", lprefix, lptr->defn.label,
 228                      lpostfix);
 229
 230             ofmt->symdef(xsymbol, segment, offset, exi,
 231                          special ? special : lptr->defn.special);
 232             ofmt->current_dfmt->debug_deflabel(xsymbol, segment, offset,
 233                                                exi,
 234                                                special ? special : lptr->
 235                                                defn.special);
 236 /**     nasm_free(xsymbol);  ! outobj.c stores the pointer; ouch!!! **/
 237         } else {
 238             if ((lptr->defn.is_global & (GLOBAL_BIT | EXTERN_BIT)) !=
 239                 EXTERN_BIT) {
 240                 ofmt->symdef(lptr->defn.label, segment, offset, exi,
 241                              special ? special : lptr->defn.special);
 242                 ofmt->current_dfmt->debug_deflabel(label, segment, offset,
 243                                                    exi,
 244                                                    special ? special :
 245                                                    lptr->defn.special);
 246             }
 247         }
 248     }
 249     /* if (pass0 == 1) */
 250 }
 251
 252 void define_label(char *label, int32_t segment, int32_t offset, char *special,
 253                   int is_norm, int isextrn, struct ofmt *ofmt, efunc error)
 254 {
 255     union label *lptr;
 256     int exi;
 257
 258 #ifdef DEBUG
 259 #if DEBUG<3
 260     if (!strncmp(label, "debugdump", 9))
 261 #endif
 262         error(ERR_DEBUG, "define_label (%s, %ld, %08lx, %s, %d, %d)",
 263               label, segment, offset, special, is_norm, isextrn);
 264 #endif
 265     lptr = find_label(label, 1);
 266     if (lptr->defn.is_global & DEFINED_BIT) {
 267         error(ERR_NONFATAL, "symbol `%s' redefined", label);
 268         return;
 269     }
 270     lptr->defn.is_global |= DEFINED_BIT;
 271     if (isextrn)
 272         lptr->defn.is_global |= EXTERN_BIT;
 273
 274     if (!islocalchar(label[0]) && is_norm)      /* not local, but not special either */
 275         prevlabel = lptr->defn.label;
 276     else if (islocal(label) && !*prevlabel) {
 277         error(ERR_NONFATAL, "attempt to define a local label before any"
 278               " non-local labels");
 279     }
 280
 281     lptr->defn.segment = segment;
 282     lptr->defn.offset = offset;
 283     lptr->defn.is_norm = (!islocalchar(label[0]) && is_norm);
 284
 285     if (pass0 == 1 || (!is_norm && !isextrn && (segment & 1))) {
 286         exi = !!(lptr->defn.is_global & GLOBAL_BIT);
 287         if (exi) {
 288             char *xsymbol;
 289             int slen;
 290             slen = strlen(lprefix);
 291             slen += strlen(lptr->defn.label);
 292             slen += strlen(lpostfix);
 293             slen++;             /* room for that null char */
 294             xsymbol = nasm_malloc(slen);
 295             snprintf(xsymbol, slen, "%s%s%s", lprefix, lptr->defn.label,
 296                      lpostfix);
 297
 298             ofmt->symdef(xsymbol, segment, offset, exi,
 299                          special ? special : lptr->defn.special);
 300             ofmt->current_dfmt->debug_deflabel(xsymbol, segment, offset,
 301                                                exi,
 302                                                special ? special : lptr->
 303                                                defn.special);
 304 /**     nasm_free(xsymbol);  ! outobj.c stores the pointer; ouch!!! **/
 305         } else {
 306             if ((lptr->defn.is_global & (GLOBAL_BIT | EXTERN_BIT)) !=
 307                 EXTERN_BIT) {
 308                 ofmt->symdef(lptr->defn.label, segment, offset, exi,
 309                              special ? special : lptr->defn.special);
 310                 ofmt->current_dfmt->debug_deflabel(label, segment, offset,
 311                                                    exi,
 312                                                    special ? special :
 313                                                    lptr->defn.special);
 314             }
 315         }
 316     }                           /* if (pass0 == 1) */
 317 }
 318
 319 void define_common(char *label, int32_t segment, int32_t size, char *special,
 320                    struct ofmt *ofmt, efunc error)
 321 {
 322     union label *lptr;
 323
 324     lptr = find_label(label, 1);
 325     if (lptr->defn.is_global & DEFINED_BIT) {
 326         error(ERR_NONFATAL, "symbol `%s' redefined", label);
 327         return;
 328     }
 329     lptr->defn.is_global |= DEFINED_BIT;
 330
 331     if (!islocalchar(label[0])) /* not local, but not special either */
 332         prevlabel = lptr->defn.label;
 333     else
 334         error(ERR_NONFATAL, "attempt to define a local label as a "
 335               "common variable");
 336
 337     lptr->defn.segment = segment;
 338     lptr->defn.offset = 0;
 339
 340     ofmt->symdef(lptr->defn.label, segment, size, 2,
 341                  special ? special : lptr->defn.special);
 342     ofmt->current_dfmt->debug_deflabel(lptr->defn.label, segment, size, 2,
 343                                        special ? special : lptr->defn.
 344                                        special);
 345 }
 346
 347 void declare_as_global(char *label, char *special, efunc error)
 348 {
 349     union label *lptr;
 350
 351     if (islocal(label)) {
 352         error(ERR_NONFATAL, "attempt to declare local symbol `%s' as"
 353               " global", label);
 354         return;
 355     }
 356     lptr = find_label(label, 1);
 357     switch (lptr->defn.is_global & TYPE_MASK) {
 358     case NOT_DEFINED_YET:
 359         lptr->defn.is_global = GLOBAL_PLACEHOLDER;
 360         lptr->defn.special = special ? perm_copy(special) : NULL;
 361         break;
 362     case GLOBAL_PLACEHOLDER:   /* already done: silently ignore */
 363     case GLOBAL_SYMBOL:
 364         break;
 365     case LOCAL_SYMBOL:
 366         if (!lptr->defn.is_global & EXTERN_BIT)
 367             error(ERR_NONFATAL, "symbol `%s': GLOBAL directive must"
 368                   " appear before symbol definition", label);
 369         break;
 370     }
 371 }
 372
 373 int init_labels(void)
 374 {
 375     ltab = hash_init();
 376
 377     ldata = lfree = (union label *)nasm_malloc(LBLK_SIZE);
 378     init_block(lfree);
 379
 380     perm_head =
 381         perm_tail = (struct permts *)nasm_malloc(sizeof(struct permts));
 382
 383     perm_head->next = NULL;
 384     perm_head->size = PERMTS_SIZE;
 385     perm_head->usage = 0;
 386
 387     prevlabel = "";
 388
 389     initialized = true;
 390
 391     return 0;
 392 }
 393
 394 void cleanup_labels(void)
 395 {
 396     union label *lptr, *lhold;
 397
 398     initialized = false;
 399
 400     hash_free(ltab);
 401
 402     lptr = lhold = ldata;
 403     while (lptr) {
 404         lptr = &lptr[LABEL_BLOCK-1];
 405         lptr = lptr->admin.next;
 406         nasm_free(lhold);
 407         lhold = lptr;
 408     }
 409
 410     while (perm_head) {
 411         perm_tail = perm_head;
 412         perm_head = perm_head->next;
 413         nasm_free(perm_tail);
 414     }
 415 }
 416
 417 static void init_block(union label *blk)
 418 {
 419     int j;
 420
 421     for (j = 0; j < LABEL_BLOCK - 1; j++)
 422         blk[j].admin.movingon = END_LIST;
 423     blk[LABEL_BLOCK - 1].admin.movingon = END_BLOCK;
 424     blk[LABEL_BLOCK - 1].admin.next = NULL;
 425 }
 426
 427 static char *perm_copy(const char *string)
 428 {
 429     char *p;
 430     int len = strlen(string)+1;
 431
 432     if (perm_tail->size - perm_tail->usage < len) {
 433         perm_tail->next =
 434             (struct permts *)nasm_malloc(sizeof(struct permts));
 435         perm_tail = perm_tail->next;
 436         perm_tail->next = NULL;
 437         perm_tail->size = PERMTS_SIZE;
 438         perm_tail->usage = 0;
 439     }
 440     p = perm_tail->data + perm_tail->usage;
 441     memcpy(p, string, len);
 442     perm_tail->usage += len;
 443
 444     return p;
 445 }
 446
 447 /*
 448  * Notes regarding bug involving redefinition of external segments.
 449  *
 450  * Up to and including v0.97, the following code didn't work. From 0.97
 451  * developers release 2 onwards, it will generate an error.
 452  *
 453  * EXTERN extlabel
 454  * newlabel EQU extlabel + 1
 455  *
 456  * The results of allowing this code through are that two import records
 457  * are generated, one for 'extlabel' and one for 'newlabel'.
 458  *
 459  * The reason for this is an inadequacy in the defined interface between
 460  * the label manager and the output formats. The problem lies in how the
 461  * output format driver tells that a label is an external label for which
 462  * a label import record must be produced. Most (all except bin?) produce
 463  * the record if the segment number of the label is not one of the internal
 464  * segments that the output driver is producing.
 465  *
 466  * A simple fix to this would be to make the output formats keep track of
 467  * which symbols they've produced import records for, and make them not
 468  * produce import records for segments that are already defined.
 469  *
 470  * The best way, which is slightly harder but reduces duplication of code
 471  * and should therefore make the entire system smaller and more stable is
 472  * to change the interface between assembler, define_label(), and
 473  * the output module. The changes that are needed are:
 474  *
 475  * The semantics of the 'isextern' flag passed to define_label() need
 476  * examining. This information may or may not tell us what we need to
 477  * know (ie should we be generating an import record at this point for this
 478  * label). If these aren't the semantics, the semantics should be changed
 479  * to this.
 480  *
 481  * The output module interface needs changing, so that the `isextern' flag
 482  * is passed to the module, so that it can be easily tested for.
 483  */