]> Shamusworld >> Repos - rmac/blobdiff - symbol.c
Fix a small buglet in the last patch. :-)
[rmac] / symbol.c
index 0e3cac04e49e182e48ae4778c419b6c3f518f02d..f8a43d6ff62e189492914cf0646354ed1c994b58 100644 (file)
--- a/symbol.c
+++ b/symbol.c
@@ -1,45 +1,51 @@
 //
-// RMAC - Reboot's Macro Assembler for the Atari Jaguar Console System
+// RMAC - Reboot's 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-2020 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
-
-// Tags for marking symbol spaces
+// 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())
+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
+// 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
@@ -47,17 +53,18 @@ void InitSymbolTable(void)
        sordtail = NULL;
        sdecl = NULL;                                                   // Init symbol-decl list
        sdecltail = NULL;
+       currentUID = 0;
 }
 
 
 //
-// Hash the Print Name and Enviroment Number
+// Hash the ASCII name and enviroment number
 //
-int HashSymbol(char * name, int envno)
+int HashSymbol(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;
@@ -70,73 +77,80 @@ int HashSymbol(char * name, int envno)
 
 
 //
-// 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(uint8_t * name, int type, int envno)
 {
        // Allocate the symbol
        SYM * symbol = malloc(sizeof(SYM));
 
        if (symbol == NULL)
        {
-               printf("SYMALLOC ERROR (%s)\n", name);
+               printf("NewSymbol: MALLOC ERROR (symbol=\"%s\")\n", name);
                return NULL;
        }
 
-       symbol->sname = strdup(name);
-
        // Fill-in the symbol
-       symbol->stype  = (BYTE)type;
-       symbol->senv   = (WORD)envno;
+       symbol->sname  = strdup(name);
+       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;
-       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++;
 
-       // Install symbol in symbol table
+       // 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
 
-       symbol->sorder = NULL;
        sordtail = symbol;
-
        return symbol;
 }
 
 
 //
-// Lookup the symbol `name', of the specified type, with the specified
-// enviroment level
+// Look up the symbol name by its UID and return the pointer to the name.
+// If it's not found, return NULL.
 //
-SYM * lookup(char * name, int type, int envno)
+uint8_t * GetSymbolNameByUID(uint32_t uid)
 {
-#if 0
-       SYM * sy;                                   // Symbol record pointer
-       int k, sum;                                 // Hash bucket calculation
-       char * s;                                   // String pointer
+       //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
 
-       // Pick a hash-bucket (SAME algorithm as HashSymbol())
-       k = 0;
-       s = name;
+       // A much better approach to the symbol order list would be to make an
+       // array--that way you can do away with the UIDs and all the rest, and
+       // simply do an array lookup based on position. But meh, let's do this for
+       // now until we can rewrite things so they make sense.
+       SYM * symbol = sorder;
 
-       for(sum=envno; *s;)
+       for(; symbol; symbol=symbol->sorder)
        {
-               if (k++ == 1)
-                       sum += *s++ << 2;
-               else
-                       sum += *s++;
+               if (symbol->uid == uid)
+                       return symbol->sname;
        }
 
-       sy = symbolTable[sum & (NBUCKETS-1)];
-#else
+       return NULL;
+}
+
+
+//
+// Lookup the symbol 'name', of the specified type, with the specified
+// enviroment level
+//
+SYM * lookup(uint8_t * name, int type, int envno)
+{
        SYM * symbol = symbolTable[HashSymbol(name, envno)];
-#endif
 
        // Do linear-search for symbol in bucket
        while (symbol != NULL)
@@ -144,141 +158,241 @@ SYM * lookup(char * name, int type, int envno)
                if (symbol->stype == type                       // Type, envno and name must match
                        && symbol->senv  == envno
                        && *name == *symbol->sname              // Fast check for first character
-                       && !strcmp(name, symbol->sname))
+                       && !strcmp(name, symbol->sname))        // More expensive check
                        break;
-               else
-                       symbol = symbol->snext;
+
+               symbol = symbol->snext;
        }
 
-       return symbol;                                                  // Return NULL or matching symbol
+       // Return NULL or matching symbol
+       return symbol;
 }
 
 
 //
 // Put symbol on "order-of-declaration" list of symbols
 //
-void sym_decl(SYM * sym)
+void AddToSymbolDeclarationList(SYM * symbol)
 {
-       if (sym->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;
 
-       sym->sattr |= SDECLLIST;                                // Mark "already on list"
+       // Mark as "on .sdecl list"
+       symbol->sattr |= SDECLLIST;
 
        if (sdecl == NULL)
-               sdecl = sym;                                            // First on decl-list
-       else 
-               sdecltail->sdecl = sym;                         // Add to end of list
+               sdecl = symbol;                         // First on decl-list
+       else
+               sdecltail->sdecl = symbol;      // Add to end of list
 
-       sym->sdecl = NULL;                                              // Fix up list's tail
-       sdecltail = sym;
+       // Fix up list's tail
+       symbol->sdecl = NULL;
+       sdecltail = symbol;
 }
 
 
 //
 // Make all referenced, undefined symbols global
 //
-int syg_fix(void)
+void ForceUndefinedSymbolsGlobal(void)
 {
        SYM * sy;
 
-       DEBUG printf("~syg_fix()\n");
+       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
                        && ((sy->sattr & (REFERENCED | DEFINED)) == REFERENCED))
                        sy->sattr |= GLOBAL;
        }
-
-       return 0;
 }
 
 
 //
-// Convert string to uppercase
+// Assign numbers to symbols that are to be exported or imported. The symbol
+// number is put in 'senv'. Returns the number of symbols that will be in the
+// symbol table.
+//
+// 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.
 //
-int uc_string(char * s)
+uint32_t sy_assign(uint8_t * buf, uint8_t *(* construct)())
 {
-       for(; *s; s++)
+       uint16_t scount = 0;
+
+       // Done only on first pass...
+       if (buf == NULL)
        {
-               if (*s >= 'a' && *s <= 'z')
-                       *s -= 32;
+               // 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);
        }
 
-       return 0;
+       // 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)
+       {
+               // Export or import external references, and export COMMON blocks.
+               if ((sy->stype == LABEL)
+                       && ((sy->sattr & (GLOBAL | DEFINED)) == (GLOBAL | DEFINED)
+                       || (sy->sattr & (GLOBAL | REFERENCED)) == (GLOBAL | REFERENCED))
+                       || (sy->sattr & COMMON))
+               {
+                       sy->senv = scount++;
+
+                       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.
+               else if (sy->stype == LABEL && lsym_flag
+                       && (sy->sattr & (DEFINED | REFERENCED)) != 0
+                       && (!as68_flag || *sy->sname != 'L'))
+               {
+                       sy->senv = scount++;
+
+                       if (buf != NULL)
+                               buf = construct(buf, sy, 0);
+               }
+       }
+
+       return scount;
 }
 
 
 //
-// 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
-// symbol table.
+// Custom version of sy_assign for ELF .o files.
+// The order that the symbols should be dumped is different.
+// (globals must be explicitly at the end of the table)
 //
-int sy_assign(char * buf, char *(* constr)())
+// N.B.: It should be possible to merge this with sy_assign, 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 sy_assign_ELF(uint8_t * buf, uint8_t *(* construct)())
 {
-       SYM * sy;
-       int scount;
-       //int i;
+       uint16_t scount = 0;
 
-       scount = 0;
-
-       if (buf == NULL)
+//     if (construct == (uint8_t *(*)())constr_elfsymtab)
+//     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 
-
-                       sy->sattr |= SDECLLIST;                            // Mark "on the list"
-
-                       if (sdecl == NULL)
-                               sdecl = sy;                      // First on decl-list 
-                       else
-                               sdecltail->sdecl = sy;                        // Add to end of list
-
-                       sy->sdecl = NULL;                                  // Fix up list's tail
-                       sdecltail = sy;
-               }
+               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->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->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))
+               {
+                       buf = construct(buf, sy, 0);
+                       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;
+       }
 }
 
 
@@ -293,28 +407,23 @@ int symtable(void)
        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;
+       int colhei = pagelen - 5;
 
-       colhei = pagelen - 5;
+       // Allocate storage for list headers and partition all labels. Throw away
+       // macros and macro arguments.
+       SYM ** sy = (SYM **)malloc(128 * sizeof(SYM **));
 
-       // Allocate storage for list headers and partition all labels.  
-       // Throw away macros and macro arguments.
-//     sy = (SYM **)amem((LONG)(128 * sizeof(LONG)));
-       sy = (SYM **)malloc(128 * sizeof(LONG));
-
-       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)
                {
@@ -322,27 +431,27 @@ int symtable(void)
                        j = *p->sname;
                        r = NULL;
 
-                       if (p->stype != LABEL)
-                               continue;                   // Ignore non-labels
-
-                       if (p->sattre & UNDEF_EQUR)
+                       // Ignore non-labels
+                       if ((p->stype != LABEL) || (p->sattre & UNDEF_EQUR))
                                continue;
 
                        for(q=sy[j]; q!=NULL; q=q->snext)
                        {
                                if (strcmp(p->sname, q->sname) < 0)
                                        break;
-                               else
-                                       r = q;
+
+                               r = q;
                        }
 
                        if (r == NULL)
-                       {                               // Insert at front of list
+                       {
+                               // Insert at front of list
                                p->snext = sy[j];
                                sy[j] = p;
                        }
                        else
-                       {                               // Insert in middle or append to list
+                       {
+                               // Insert in middle or append to list
                                p->snext = r->snext;
                                r->snext = p;
                        }
@@ -374,11 +483,11 @@ int symtable(void)
 
        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;
@@ -387,14 +496,14 @@ int symtable(void)
                        }
                }
 
-               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;
@@ -412,7 +521,7 @@ int symtable(void)
 
                                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';
@@ -423,8 +532,8 @@ int symtable(void)
                                        strcpy(ln2, "external");
                                else
                                {
-                                       sprintf(ln2, "%08ux", 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);
@@ -439,3 +548,4 @@ int symtable(void)
 
        return 0;
 }
+