2 // RMAC - Renamed Macro Assembler for all Atari computers
3 // SYMBOL.C - Symbol Handling
4 // Copyright (C) 199x Landon Dyer, 2011-2021 Reboot and Friends
5 // RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
6 // Source utilised with the kind permission of Landon Dyer
18 #define NBUCKETS 256 // Number of hash buckets (power of 2)
20 static SYM * symbolTable[NBUCKETS]; // User symbol-table header
21 int curenv; // Current enviroment number
22 static SYM * sorder; // * -> Symbols, in order of reference
23 static SYM * sordtail; // * -> Last symbol in sorder list
24 static SYM * sdecl; // * -> Symbols, in order of declaration
25 static SYM * sdecltail; // * -> Last symbol in sdecl list
26 static uint32_t currentUID; // Symbol UID tracking (done by NewSymbol())
27 uint32_t firstglobal; // Index of the first global symbol in an ELF object.
29 // Tags for marking symbol spaces:
35 static uint8_t tdb_text[8] = {
36 'a', 't', 'd', '!', 'b', SPACE, SPACE, SPACE
39 // Internal function prototypes
40 static uint16_t WriteLODSection(int, uint16_t);
44 // Initialize symbol table
46 void InitSymbolTable(void)
48 for(int i=0; i<NBUCKETS; i++) // Initialise symbol hash table
49 symbolTable[i] = NULL;
51 curenv = 1; // Init local symbol enviroment
52 sorder = NULL; // Init symbol-reference list
54 sdecl = NULL; // Init symbol-decl list
61 // Hash the ASCII name and enviroment number
63 int HashSymbol(uint8_t * name, int envno)
65 int sum = envno, k = 0;
75 return sum & (NBUCKETS - 1);
80 // Make a new symbol of type 'type' in enviroment 'envno'
82 SYM * NewSymbol(uint8_t * name, int type, int envno)
84 // Allocate the symbol
85 SYM * symbol = malloc(sizeof(SYM));
89 printf("NewSymbol: MALLOC ERROR (symbol=\"%s\")\n", name);
94 symbol->sname = strdup(name);
95 symbol->stype = (uint8_t)type;
96 symbol->senv = (uint16_t)envno;
97 // We don't set this as DEFINED, as it could be a forward reference!
99 // We don't set RISCSYM here as not every symbol first seen in a RISC
100 // section is a RISC symbol!
103 symbol->sorder = NULL;
104 symbol->uid = currentUID++;
106 // Record filename the symbol is defined (for now only used by macro error reporting)
107 symbol->cfileno = cfileno;
109 // Install symbol in the symbol table
110 int hash = HashSymbol(name, envno);
111 symbol->snext = symbolTable[hash];
112 symbolTable[hash] = symbol;
114 // Append symbol to the symbol-order list
116 sorder = symbol; // Add first symbol
118 sordtail->sorder = symbol; // Or append to tail of list
126 // Look up the symbol name by its UID and return the pointer to the name.
127 // If it's not found, return NULL.
129 uint8_t * GetSymbolNameByUID(uint32_t uid)
131 //problem is with string lookup, that's why we're writing this
132 //so once this is written, we can put the uid in the token stream
134 // A much better approach to the symbol order list would be to make an
135 // array--that way you can do away with the UIDs and all the rest, and
136 // simply do an array lookup based on position. But meh, let's do this for
137 // now until we can rewrite things so they make sense.
138 SYM * symbol = sorder;
140 for(; symbol; symbol=symbol->sorder)
142 if (symbol->uid == uid)
143 return symbol->sname;
151 // Lookup the symbol 'name', of the specified type, with the specified
154 SYM * lookup(uint8_t * name, int type, int envno)
156 SYM * symbol = symbolTable[HashSymbol(name, envno)];
158 // Do linear-search for symbol in bucket
159 while (symbol != NULL)
161 if (symbol->stype == type // Type, envno and name must match
162 && symbol->senv == envno
163 && *name == *symbol->sname // Fast check for first character
164 && !strcmp(name, symbol->sname)) // More expensive check
167 symbol = symbol->snext;
170 // Return NULL or matching symbol
176 // Put symbol on "order-of-declaration" list of symbols
178 void AddToSymbolDeclarationList(SYM * symbol)
180 // Don't add if already on list, or it's an equated register/CC
181 if ((symbol->sattr & SDECLLIST)
182 || (symbol->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC)))
185 // Mark as "on .sdecl list"
186 symbol->sattr |= SDECLLIST;
189 sdecl = symbol; // First on decl-list
191 sdecltail->sdecl = symbol; // Add to end of list
193 // Fix up list's tail
194 symbol->sdecl = NULL;
200 // Make all referenced, undefined symbols global
202 void ForceUndefinedSymbolsGlobal(void)
206 DEBUG printf("~ForceUndefinedSymbolsGlobal()\n");
208 // Scan through all symbols; if a symbol is REFERENCED but not DEFINED,
209 // then make it global.
210 for(sy=sorder; sy!=NULL; sy=sy->sorder)
212 if (sy->stype == LABEL && sy->senv == 0
213 && ((sy->sattr & (REFERENCED | DEFINED)) == REFERENCED))
220 // Assign numbers to symbols that are to be exported or imported. The symbol
221 // number is put in 'senv'. Returns the number of symbols that will be in the
224 // N.B.: This is usually called twice; first time with NULL parameters and the
225 // second time with real ones. The first one is typically done to get a
226 // count of the # of symbols in the symbol table, and the second is to
227 // actually create it.
229 uint32_t sy_assign(uint8_t * buf, uint8_t *(* construct)())
233 // Done only on first pass...
236 // Append all symbols not appearing on the .sdecl list to the end of
238 for(SYM * sy=sorder; sy!=NULL; sy=sy->sorder)
239 AddToSymbolDeclarationList(sy);
242 // Run through all symbols (now on the .sdecl list) and assign numbers to
243 // them. We also pick which symbols should be global or not here.
244 for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
246 // Export or import external references, and export COMMON blocks.
247 if ((sy->stype == LABEL)
248 && ((sy->sattr & (GLOBAL | DEFINED)) == (GLOBAL | DEFINED)
249 || (sy->sattr & (GLOBAL | REFERENCED)) == (GLOBAL | REFERENCED))
250 || (sy->sattr & COMMON))
255 buf = construct(buf, sy, 1);
257 // Export vanilla labels (but don't make them global). An exception is
258 // made for equates, which are not exported unless they are referenced.
259 else if (sy->stype == LABEL && lsym_flag
260 && (sy->sattr & (DEFINED | REFERENCED)) != 0)
265 buf = construct(buf, sy, 0);
274 // Custom version of sy_assign for ELF .o files.
275 // The order that the symbols should be dumped is different.
276 // (globals must be explicitly at the end of the table)
278 // N.B.: It should be possible to merge this with sy_assign, as there's nothing
279 // really ELF specific in here, other than the "globals go at the end of
280 // the queue" thing, which doesn't break the others. :-P
281 uint32_t sy_assign_ELF(uint8_t * buf, uint8_t *(* construct)())
285 // if (construct == (uint8_t *(*)())constr_elfsymtab)
288 // Append all symbols not appearing on the .sdecl list to the end of
290 for(SYM * sy=sorder; sy!=NULL; sy=sy->sorder)
291 AddToSymbolDeclarationList(sy);
294 // Run through all symbols (now on the .sdecl list) and assign numbers to
295 // them. We also pick which symbols should be global or not here.
296 for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
298 // Export vanilla labels (but don't make them global). An exception is
299 // made for equates, which are not exported unless they are referenced.
300 if (sy->stype == LABEL && lsym_flag
301 && (sy->sattr & (DEFINED | REFERENCED)) != 0
302 && (*sy->sname != '.')
303 && (sy->sattr & GLOBAL) == 0)
308 buf = construct(buf, sy, 0);
312 firstglobal = scount;
314 // For ELF object mode run through all symbols in reference order
315 // and export all global-referenced labels. Not sure if this is
316 // required but it's here nonetheless
318 for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
320 if ((sy->stype == LABEL)
321 && ((sy->sattr & (GLOBAL | DEFINED)) == (GLOBAL | DEFINED)
322 || (sy->sattr & (GLOBAL | REFERENCED)) == (GLOBAL | REFERENCED))
323 || (sy->sattr & COMMON))
328 buf = construct(buf, sy, 1);
330 else if ((sy->sattr == (GLOBAL | REFERENCED)) && (buf != NULL))
332 buf = construct(buf, sy, 0);
342 // Helper function for dsp_lod_symbols
344 static uint16_t WriteLODSection(int section, uint16_t symbolCount)
346 for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
348 // Export vanilla labels (but don't make them global). An exception is
349 // made for equates, which are not exported unless they are referenced.
350 if (sy->stype == LABEL && lsym_flag
351 && (sy->sattr & (DEFINED | REFERENCED)) != 0
352 && (*sy->sname != '.')
353 && (sy->sattr & GLOBAL) == 0
354 && (sy->sattr & (section)))
356 sy->senv = symbolCount++;
357 D_printf("%-19s I %.6" PRIX64 "\n", sy->sname, sy->svalue);
366 // Dump LOD style symbols into the passed in buffer
368 void DumpLODSymbols(void)
370 D_printf("_SYMBOL P\n");
371 uint16_t count = WriteLODSection(M56001P, 0);
373 D_printf("_SYMBOL X\n");
374 count = WriteLODSection(M56001X, count);
376 D_printf("_SYMBOL Y\n");
377 count = WriteLODSection(M56001Y, count);
379 D_printf("_SYMBOL L\n");
380 count = WriteLODSection(M56001L, count);
382 // TODO: I've seen _SYMBOL N in there but no idea what symbols it needs...
383 //D_printf("_SYMBOL N\n");
384 //WriteLODSection(M56001?, count);
389 // Convert string to uppercase
391 void ToUppercase(uint8_t * s)
395 if (*s >= 'a' && *s <= 'z')
402 // Generate symbol table for listing file
419 int colhei = pagelen - 5;
421 // Allocate storage for list headers and partition all labels. Throw away
422 // macros and macro arguments.
423 SYM ** sy = (SYM **)malloc(128 * sizeof(SYM **));
428 for(i=0; i<NBUCKETS; i++)
430 for(p=symbolTable[i]; p!=NULL; p=k)
437 if ((p->stype != LABEL) || (p->sattre & UNDEF_EQUR))
440 for(q=sy[j]; q!=NULL; q=q->snext)
442 if (strcmp(p->sname, q->sname) < 0)
450 // Insert at front of list
456 // Insert in middle or append to list
463 // Link all symbols onto one list again
468 if ((r = sy[i]) != NULL)
475 while (q->snext != NULL)
484 strcpy(subttl, "Symbol Table");
492 for(j=0; j<colhei; j++)
501 for(i=0; i<colhei; i++)
505 if (colptr[0] == NULL)
510 if ((q = colptr[j]) == NULL)
513 colptr[j] = q->snext;
518 // x external reference
520 // space nothing special
526 else if ((w & (DEFINED | GLOBAL)) == GLOBAL)
531 c1 = tdb_text[w & TDB];
534 strcpy(ln2, "external");
537 sprintf(ln2, "%016lX", q->svalue);
541 sprintf(ln1, " %16s %s %c%c%c", q->sname, ln2, (ww & EQUATEDREG) ? 'e' : SPACE, c1, c);