//
-// RMAC - Reboot's Macro Assembler for the Atari Jaguar Console System
+// RMAC - Renamed Macro Assembler for all Atari computers
// SYMBOL.C - Symbol Handling
-// Copyright (C) 199x Landon Dyer, 2011-2012 Reboot and Friends
+// Copyright (C) 199x Landon Dyer, 2011-2022 Reboot and Friends
// RMAC derived from MADMAC v1.07 Written by Landon Dyer, 1986
-// Source Utilised with the Kind Permission of Landon Dyer
+// Source utilised with the kind permission of Landon Dyer
//
#include "symbol.h"
+#include "dsp56k.h"
+#include "error.h"
#include "listing.h"
+#include "object.h"
#include "procln.h"
-#include "error.h"
// Macros
-#define NBUCKETS 256 // Number of hash buckets (power of 2)
-
-static SYM * symbolTable[NBUCKETS]; // User symbol-table header
-int curenv; // Current enviroment number
-static SYM * sorder; // * -> Symbols, in order of reference
-static SYM * sordtail; // * -> Last symbol in sorder list
-static SYM * sdecl; // * -> Symbols, in order of declaration
-static SYM * sdecltail; // * -> Last symbol in sdecl list
-static uint32_t currentUID; // Symbol UID tracking (done by NewSymbol())
-
-// Tags for marking symbol spaces
+#define NBUCKETS 256 // Number of hash buckets (power of 2)
+
+static SYM * symbolTable[NBUCKETS]; // User symbol-table header
+int curenv; // Current enviroment number
+static SYM * sorder; // * -> Symbols, in order of reference
+static SYM * sordtail; // * -> Last symbol in sorder list
+static SYM * sdecl; // * -> Symbols, in order of declaration
+static SYM * sdecltail; // * -> Last symbol in sdecl list
+static uint32_t currentUID; // Symbol UID tracking (done by NewSymbol())
+uint32_t firstglobal; // Index of the first global symbol in an ELF object.
+
+// Tags for marking symbol spaces:
// a = absolute
// t = text
// d = data
// ! = "impossible!"
// b = BSS
-static char tdb_text[8] = {
+static uint8_t tdb_text[8] = {
'a', 't', 'd', '!', 'b', SPACE, SPACE, SPACE
};
+// Internal function prototypes
+static uint16_t WriteLODSection(int, uint16_t);
//
// Initialize symbol table
//
void InitSymbolTable(void)
{
- int i; // Iterator
-
- for(i=0; i<NBUCKETS; i++) // Initialise symbol hash table
+ for(int i=0; i<NBUCKETS; i++) // Initialise symbol hash table
symbolTable[i] = NULL;
curenv = 1; // Init local symbol enviroment
currentUID = 0;
}
-
//
-// Hash the print name and enviroment number
+// Hash the ASCII name and enviroment number
//
-int HashSymbol(char * name, int envno)
+int HashSymbol(const uint8_t * name, int envno)
{
- int sum, k = 0; // Hash calculation
+ int sum = envno, k = 0;
- for(sum=envno; *name; name++)
+ for(; *name; name++)
{
if (k++ == 1)
sum += *name << 2;
return sum & (NBUCKETS - 1);
}
-
//
-// Make a new symbol of type `type' in enviroment `envno'
+// Make a new symbol of type 'type' in enviroment 'envno'
//
-SYM * NewSymbol(char * name, int type, int envno)
+SYM * NewSymbol(const uint8_t * name, int type, int envno)
{
// Allocate the symbol
SYM * symbol = malloc(sizeof(SYM));
}
// Fill-in the symbol
- symbol->sname = strdup(name);
- symbol->stype = (BYTE)type;
- symbol->senv = (WORD)envno;
+ symbol->sname = name ? strdup(name) : NULL;
+ symbol->stype = (uint8_t)type;
+ symbol->senv = (uint16_t)envno;
+ // We don't set this as DEFINED, as it could be a forward reference!
symbol->sattr = 0;
- // Don't do this, it could be a forward reference!
-// symbol->sattr = DEFINED; // We just defined it...
- // This is a bad assumption. Not every symbol 1st seen in a RISC section is
- // a RISC symbol!
-// symbol->sattre = (rgpu || rdsp ? RISCSYM : 0);
+ // We don't set RISCSYM here as not every symbol first seen in a RISC
+ // section is a RISC symbol!
symbol->sattre = 0;
symbol->svalue = 0;
symbol->sorder = NULL;
symbol->uid = currentUID++;
+ // We don't set st_type, st_desc, or st_other here because they are only
+ // used by stabs debug symbols, which are always initialized by
+ // NewDebugSymbol(), which always sets these fields. Hence, initializing
+ // them here would be redundant.
+
+ // Record filename the symbol is defined (Used by macro error reporting and some debug symbols)
+ symbol->cfileno = cfileno;
- // Install symbol in symbol table
- int hash = HashSymbol(name, envno);
- symbol->snext = symbolTable[hash];
- symbolTable[hash] = symbol;
+ // Don't hash debug symbols: they are never looked up and may have no name.
+ if (type != DBGSYM)
+ {
+ // Install symbol in the symbol table
+ int hash = HashSymbol(name, envno);
+ symbol->snext = symbolTable[hash];
+ symbolTable[hash] = symbol;
+ }
- // Append symbol to symbol-order list
+ // Append symbol to the symbol-order list
if (sorder == NULL)
- sorder = symbol; // Add first symbol
+ sorder = symbol; // Add first symbol
else
sordtail->sorder = symbol; // Or append to tail of list
return symbol;
}
-
//
// Look up the symbol name by its UID and return the pointer to the name.
// If it's not found, return NULL.
//
-char * GetSymbolNameByUID(uint32_t uid)
+uint8_t * GetSymbolNameByUID(uint32_t uid)
{
//problem is with string lookup, that's why we're writing this
//so once this is written, we can put the uid in the token stream
return NULL;
}
-
//
-// Lookup the symbol `name', of the specified type, with the specified
+// Lookup the symbol 'name', of the specified type, with the specified
// enviroment level
//
-SYM * lookup(char * name, int type, int envno)
+SYM * lookup(uint8_t * name, int type, int envno)
{
SYM * symbol = symbolTable[HashSymbol(name, envno)];
return symbol;
}
-
//
// Put symbol on "order-of-declaration" list of symbols
//
-//void sym_decl(SYM * symbol)
-void AddToSymbolOrderList(SYM * symbol)
+void AddToSymbolDeclarationList(SYM * symbol)
{
- if (symbol->sattr & SDECLLIST)
- return; // Already on list
+ // Don't add if already on list, or it's an equated register/CC
+ if ((symbol->sattr & SDECLLIST)
+ || (symbol->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC)))
+ return;
- symbol->sattr |= SDECLLIST; // Mark "already on list"
+ // Mark as "on .sdecl list"
+ symbol->sattr |= SDECLLIST;
if (sdecl == NULL)
- sdecl = symbol; // First on decl-list
- else
- sdecltail->sdecl = symbol; // Add to end of list
+ sdecl = symbol; // First on decl-list
+ else
+ sdecltail->sdecl = symbol; // Add to end of list
- symbol->sdecl = NULL; // Fix up list's tail
+ // Fix up list's tail
+ symbol->sdecl = NULL;
sdecltail = symbol;
}
-
//
// Make all referenced, undefined symbols global
//
DEBUG printf("~ForceUndefinedSymbolsGlobal()\n");
- // Scan through all symbols;
- // If a symbol is REFERENCED but not DEFINED, then make it global.
+ // Scan through all symbols; if a symbol is REFERENCED but not DEFINED,
+ // then make it global.
for(sy=sorder; sy!=NULL; sy=sy->sorder)
{
if (sy->stype == LABEL && sy->senv == 0
}
}
-
-//
-// Convert string to uppercase
-//
-int uc_string(char * s)
-{
- for(; *s; s++)
- {
- if (*s >= 'a' && *s <= 'z')
- *s -= 32;
- }
-
- return 0;
-}
-
-
//
// Assign numbers to symbols that are to be exported or imported. The symbol
-// number is put in `.senv'. Return the number of symbols that will be in the
+// number is put in 'senv'. Returns the number of symbols that will be in the
// symbol table.
//
-int sy_assign(char * buf, char *(* constr)())
+// N.B.: This is usually called twice; first time with NULL parameters and the
+// second time with real ones. The first one is typically done to get a
+// count of the # of symbols in the symbol table, and the second is to
+// actually create it.
+//
+uint32_t AssignSymbolNos(uint8_t * buf, uint8_t *(* construct)())
{
- SYM * sy;
- int scount = 0;
+ uint16_t scount = 0;
+ // Done only on first pass...
if (buf == NULL)
{
// Append all symbols not appearing on the .sdecl list to the end of
// the .sdecl list
- for(sy=sorder; sy!=NULL; sy=sy->sorder)
- {
- // Essentially the same as 'sym_decl()' above:
- if (sy->sattr & SDECLLIST)
- continue; // Already on list
+ for(SYM * sy=sorder; sy!=NULL; sy=sy->sorder)
+ AddToSymbolDeclarationList(sy);
+ }
- sy->sattr |= SDECLLIST; // Mark "on the list"
+ // Run through all symbols (now on the .sdecl list) and assign numbers to
+ // them. We also pick which symbols should be global or not here.
+ for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
+ {
+ // Always export debug symbols. Don't force them global.
+ if (DBGSYM == sy->stype) {
+ sy->senv = scount++;
- if (sdecl == NULL)
- sdecl = sy; // First on decl-list
- else
- sdecltail->sdecl = sy; // Add to end of list
+ if (buf != NULL)
+ buf = construct(buf, sy, 0);
+ continue;
+ }
+
+ // Skip non-labels.
+ if (sy->stype != LABEL)
+ continue;
+
+ // Nuke equated register/CC symbols from orbit:
+ if (sy->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC))
+ continue;
+
+ // Export or import external references, and export COMMON blocks.
+ // N.B.: This says to mark the symbol as global if either 1) the symbol
+ // is global AND the symbol is defined OR referenced, or 2) this
+ // symbol is a common symbol.
+ if (((sy->sattr & GLOBAL) && (sy->sattr & (DEFINED | REFERENCED)))
+ || (sy->sattr & COMMON))
+ {
+ sy->senv = scount++;
- sy->sdecl = NULL; // Fix up list's tail
- sdecltail = sy;
+ if (buf != NULL)
+ buf = construct(buf, sy, 1);
+ }
+ // Export vanilla labels (but don't make them global). An exception is
+ // made for equates, which are not exported unless they are referenced.
+ // ^^^ The above just might be bullshit. ^^^
+ // N.B.: This says if the symbol is either defined OR referenced (but
+ // because of the above we know it *won't* be GLOBAL). And
+ // lsym_flag is always set true in Process() in rmac.c.
+ else if (lsym_flag && (sy->sattr & (DEFINED | REFERENCED)))
+ {
+ sy->senv = scount++;
+
+ if (buf != NULL)
+ buf = construct(buf, sy, 0);
}
}
+ return scount;
+}
+
+//
+// Custom version of AssignSymbolNos for ELF .o files.
+// The order that the symbols should be dumped is different.
+// (globals must be explicitly at the end of the table)
+//
+// N.B.: It should be possible to merge this with AssignSymbolNos, as there's
+// nothing really ELF specific in here, other than the "globals go at the
+// end of the queue" thing, which doesn't break the others. :-P
+uint32_t AssignSymbolNosELF(uint8_t * buf, uint8_t *(* construct)())
+{
+ uint16_t scount = 0;
+
+ // Append all symbols not appearing on the .sdecl list to the end of
+ // the .sdecl list
+ for(SYM * sy=sorder; sy!=NULL; sy=sy->sorder)
+ AddToSymbolDeclarationList(sy);
+
// Run through all symbols (now on the .sdecl list) and assign numbers to
// them. We also pick which symbols should be global or not here.
- for(sy=sdecl; sy!=NULL; sy=sy->sdecl)
+ for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
{
- if (sy->sattre & UNDEF_EQUR)
- continue; // Don't want undefined on our list
+ // Export vanilla labels (but don't make them global). An exception is
+ // made for equates, which are not exported unless they are referenced.
+ if (sy->stype == LABEL && lsym_flag
+ && (sy->sattr & (DEFINED | REFERENCED)) != 0
+ && (*sy->sname != '.')
+ && (sy->sattr & GLOBAL) == 0
+ && (sy->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC)) == 0)
+ {
+ sy->senv = scount++;
- if (sy->sattre & UNDEF_CC)
- continue;
-
- // Export or import external references, and export COMMON blocks.
+ if (buf != NULL)
+ buf = construct(buf, sy, 0);
+ }
+ }
+
+ firstglobal = scount;
+
+ // For ELF object mode run through all symbols in reference order
+ // and export all global-referenced labels. Not sure if this is
+ // required but it's here nonetheless
+
+ for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
+ {
if ((sy->stype == LABEL)
+ && (sy->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC)) == 0
&& ((sy->sattr & (GLOBAL | DEFINED)) == (GLOBAL | DEFINED)
|| (sy->sattr & (GLOBAL | REFERENCED)) == (GLOBAL | REFERENCED))
|| (sy->sattr & COMMON))
{
- sy->senv = (WORD)scount++;
+ sy->senv = scount++;
if (buf != NULL)
- buf = (*constr)(buf, sy, 1);
+ buf = construct(buf, sy, 1);
}
+ else if ((sy->sattr == (GLOBAL | REFERENCED)) && (buf != NULL) && (sy->sattre & (EQUATEDREG | UNDEF_EQUR | EQUATEDCC | UNDEF_CC)) == 0)
+ {
+ buf = construct(buf, sy, 0); // <-- this creates a NON-global symbol...
+ scount++;
+ }
+ }
+
+ return scount;
+}
+
+//
+// Helper function for dsp_lod_symbols
+//
+static uint16_t WriteLODSection(int section, uint16_t symbolCount)
+{
+ for(SYM * sy=sdecl; sy!=NULL; sy=sy->sdecl)
+ {
// Export vanilla labels (but don't make them global). An exception is
// made for equates, which are not exported unless they are referenced.
- else if (sy->stype == LABEL && lsym_flag
+ if (sy->stype == LABEL && lsym_flag
&& (sy->sattr & (DEFINED | REFERENCED)) != 0
- && (!as68_flag || *sy->sname != 'L'))
+ && (*sy->sname != '.')
+ && (sy->sattr & GLOBAL) == 0
+ && (sy->sattr & (section)))
{
- sy->senv = (WORD)scount++;
- if (buf != NULL) buf = (*constr)(buf, sy, 0);
+ sy->senv = symbolCount++;
+ D_printf("%-19s I %.6" PRIX64 "\n", sy->sname, sy->svalue);
}
}
- return scount;
+ return symbolCount;
}
+//
+// Dump LOD style symbols into the passed in buffer
+//
+void DumpLODSymbols(void)
+{
+ D_printf("_SYMBOL P\n");
+ uint16_t count = WriteLODSection(M56001P, 0);
+
+ D_printf("_SYMBOL X\n");
+ count = WriteLODSection(M56001X, count);
+
+ D_printf("_SYMBOL Y\n");
+ count = WriteLODSection(M56001Y, count);
+
+ D_printf("_SYMBOL L\n");
+ count = WriteLODSection(M56001L, count);
+
+ // TODO: I've seen _SYMBOL N in there but no idea what symbols it needs...
+ //D_printf("_SYMBOL N\n");
+ //WriteLODSection(M56001?, count);
+}
+
+//
+// Convert string to uppercase
+//
+void ToUppercase(uint8_t * s)
+{
+ for(; *s; s++)
+ {
+ if (*s >= 'a' && *s <= 'z')
+ *s -= 0x20;
+ }
+}
//
// Generate symbol table for listing file
SYM * p;
SYM * r;
SYM * k;
- SYM ** sy;
SYM * colptr[4];
- char ln[150];
- char ln1[150];
+ char ln[1024];
+ char ln1[1024];
char ln2[20];
char c, c1;
WORD w;
int ww;
- int colhei;
- extern int pagelen;
-
- colhei = pagelen - 5;
+ int colhei = pagelen - 5;
- // Allocate storage for list headers and partition all labels.
- // Throw away macros and macro arguments.
- sy = (SYM **)malloc(128 * sizeof(LONG));
+ // Allocate storage for list headers and partition all labels. Throw away
+ // macros and macro arguments.
+ SYM ** sy = (SYM **)malloc(128 * sizeof(SYM **));
- for(i=0; i<128; ++i)
+ for(i=0; i<128; i++)
sy[i] = NULL;
- for(i=0; i<NBUCKETS; ++i)
+ for(i=0; i<NBUCKETS; i++)
{
for(p=symbolTable[i]; p!=NULL; p=k)
{
while (p != NULL)
{
- for(i=0; i<4; ++i)
+ for(i=0; i<4; i++)
{
colptr[i] = p;
- for(j=0; j<colhei; ++j)
+ for(j=0; j<colhei; j++)
{
if (p == NULL)
break;
}
}
- for(i=0; i<colhei; ++i)
+ for(i=0; i<colhei; i++)
{
*ln = EOS;
if (colptr[0] == NULL)
break;
- for(j=0; j<4; ++j)
+ for(j=0; j<4; j++)
{
if ((q = colptr[j]) == NULL)
break;
if (w & COMMON)
c = 'c';
- else if ((w & (DEFINED|GLOBAL)) == GLOBAL)
+ else if ((w & (DEFINED | GLOBAL)) == GLOBAL)
c = 'x';
else if (w & GLOBAL)
c = 'g';
strcpy(ln2, "external");
else
{
- sprintf(ln2, "%08X", q->svalue);
- uc_string(ln2);
+ sprintf(ln2, "%016lX", q->svalue);
+ ToUppercase(ln2);
}
sprintf(ln1, " %16s %s %c%c%c", q->sname, ln2, (ww & EQUATEDREG) ? 'e' : SPACE, c1, c);
return 0;
}
+SYM * NewDebugSymbol(const uint8_t * str, uint8_t type, uint8_t other, uint16_t desc)
+{
+ SYM * symbol = NewSymbol(str, DBGSYM, 0);
+
+ if (NULL == symbol)
+ fatal("Could not allocate space for debug symbol");
+
+ AddToSymbolDeclarationList(symbol);
+
+ symbol->st_type = type;
+ symbol->st_other = other;
+ symbol->st_desc = desc;
+
+ return symbol;
+}
+
+char *FilePath(const char * fname)
+{
+ char buf1[256];
+ char * fpath;
+ int i, j;
+
+ if ((fpath = realpath(fname, NULL)) != NULL)
+ return fpath;
+
+ for(i=0; nthpath("RMACPATH", i, buf1)!=0; i++)
+ {
+ j = strlen(buf1);
+
+ // Append path char if necessary
+ if (j > 0 && buf1[j - 1] != SLASHCHAR)
+ strcat(buf1, SLASHSTRING);
+
+ strcat(buf1, fname);
+
+ if ((fpath = realpath(buf1, NULL)) != NULL)
+ return fpath;
+ }
+
+ return NULL;
+}
+
+static void GenFileSym(const char * fname, uint8_t type, uint32_t addr, uint32_t sattr)
+{
+ char *fpath;
+
+ if (!(fpath = FilePath(fname)))
+ {
+ // Don't treat this as an error. Any file rmac can read is valid enough.
+ // Just use the relative filename in place of an absolute path for the
+ // debug information.
+ fpath = strdup(fname);
+
+ if (!fpath)
+ fatal("Could not allocate memory for fake path name");
+ }
+
+ SYM * symbol = NewDebugSymbol(fpath, type, 0, 0);
+
+ free(fpath);
+
+ symbol->svalue = addr;
+ symbol->sattr |= sattr;
+}
+
+void GenMainFileSym(const char * fname)
+{
+ GenFileSym(fname, 0x64 /* N_SO */, 0, DEFINED | TEXT);
+}
+
+void GenLineNoSym(void)
+{
+ uint32_t addr;
+ uint32_t sattr;
+ uint8_t type;
+ SYM * symbol;
+
+ static uint16_t prevlineno = -1;
+ static uint32_t prevaddr = -1;
+ static uint16_t prevfileno = 0;
+
+ if (orgactive)
+ {
+ addr = orgaddr;
+ sattr = ABS | DEFINED | EQUATED;
+ // 0x4c is N_FLINE, function start/body/end line number, repurposed by
+ // MADMAC/ALN for ABS line numbers.
+ type = 0x4c;
+ }
+ else
+ {
+ addr = pcloc;
+ sattr = DEFINED | cursect;
+ type = 0x44; // N_SLINE, text section line number
+ }
+
+ if ((addr == prevaddr) || ((curlineno == prevlineno) && (prevfileno == cfileno)))
+ return;
+
+ prevaddr = addr;
+ prevlineno = curlineno;
+
+ if (prevfileno != cfileno)
+ GenFileSym(curfname, 0x84 /* N_SOL */, addr, sattr);
+
+ prevfileno = cfileno;
+
+ /* MADMAC counts lines starting at 0. Offset curlineno accordingly */
+ symbol = NewDebugSymbol(NULL, type, 0, curlineno - 1);
+
+ symbol->svalue = addr;
+ symbol->sattr |= sattr;
+}
projects / rmac / blobdiff