]> git.sur5r.net Git - cc65/blobdiff - src/cc65/codeinfo.c
Adding functionality to StrBuf
[cc65] / src / cc65 / codeinfo.c
index 0dc89acb1baf92fe185b55fce8850d69fc0128bd..982ce4cec1c40544834e73fb68f4364d3df7b1d8 100644 (file)
 #include <stdlib.h>
 #include <string.h>
 
+/* common */
+#include "coll.h"
+
 /* cc65 */
+#include "codeent.h"
+#include "codeseg.h"
+#include "datatype.h"
+#include "error.h"
+#include "symtab.h"
 #include "codeinfo.h"
 
 
@@ -58,47 +66,113 @@ struct FuncInfo {
 };
 
 static const FuncInfo FuncInfoTable[] = {
-    { "booleq",                REG_NONE,       REG_AX  },
-    { "boolge",                REG_NONE,       REG_AX  },
-    { "boolgt",                REG_NONE,       REG_AX  },
-    { "boolle",                REG_NONE,       REG_AX  },
-    { "boollt",                REG_NONE,       REG_AX  },
-    { "boolne",                REG_NONE,       REG_AX  },
-    { "booluge",       REG_NONE,       REG_AX  },
-    { "boolugt",       REG_NONE,       REG_AX  },
-    { "boolule",       REG_NONE,       REG_AX  },
-    { "boolult",       REG_NONE,       REG_AX  },
-    { "decax1",        REG_AX,         REG_AX  },
-    { "decax2",        REG_AX,         REG_AX  },
-    { "decax3",        REG_AX,         REG_AX  },
-    { "decax4",        REG_AX,         REG_AX  },
-    { "decax5",        REG_AX,         REG_AX  },
-    { "decax6",        REG_AX,         REG_AX  },
-    { "decax7",        REG_AX,         REG_AX  },
-    { "decax8",        REG_AX,         REG_AX  },
-    { "decaxy",                REG_AXY,        REG_AX  },
-    { "decsp2",        REG_NONE,       REG_A   },
-    { "decsp3",        REG_NONE,       REG_A   },
-    { "decsp4",        REG_NONE,       REG_A   },
-    { "decsp5",        REG_NONE,       REG_A   },
-    { "decsp6",        REG_NONE,       REG_A   },
-    { "decsp7",        REG_NONE,       REG_A   },
-    { "decsp8",        REG_NONE,       REG_A   },
-    { "ldax0sp",       REG_Y,          REG_AX  },
-    { "ldaxysp",       REG_Y,          REG_AX  },
-    { "pusha",         REG_A,          REG_Y   },
-    { "pusha0",                REG_A,          REG_XY  },
-    { "pushax",                REG_AX,         REG_Y   },
-    { "pushw0sp",      REG_NONE,       REG_AXY },
-    { "pushwysp",      REG_Y,          REG_AXY },
-    { "tosicmp",       REG_AX,         REG_AXY },
+    { "addysp",                REG_Y,          REG_NONE        },
+    { "aslax1",         REG_AX,                REG_AX          },
+    { "aslax2",         REG_AX,                REG_AX          },
+    { "aslax3",         REG_AX,                REG_AX          },
+    { "aslax4",         REG_AX,                REG_AX          },
+    { "bnega",          REG_A,          REG_AX          },
+    { "bnegax",         REG_AX,         REG_AX          },
+    { "bnegeax",        REG_AX,         REG_AX          },
+    { "booleq",                REG_NONE,       REG_AX          },
+    { "boolge",                REG_NONE,       REG_AX          },
+    { "boolgt",                REG_NONE,       REG_AX          },
+    { "boolle",                REG_NONE,       REG_AX          },
+    { "boollt",                REG_NONE,       REG_AX          },
+    { "boolne",                REG_NONE,       REG_AX          },
+    { "booluge",       REG_NONE,       REG_AX          },
+    { "boolugt",       REG_NONE,       REG_AX          },
+    { "boolule",       REG_NONE,       REG_AX          },
+    { "boolult",       REG_NONE,       REG_AX          },
+    { "complax",        REG_AX,         REG_AX          },
+    { "decax1",        REG_AX,         REG_AX          },
+    { "decax2",        REG_AX,         REG_AX          },
+    { "decax3",        REG_AX,         REG_AX          },
+    { "decax4",        REG_AX,         REG_AX          },
+    { "decax5",        REG_AX,         REG_AX          },
+    { "decax6",        REG_AX,         REG_AX          },
+    { "decax7",        REG_AX,         REG_AX          },
+    { "decax8",        REG_AX,         REG_AX          },
+    { "decaxy",                REG_AXY,        REG_AX          },
+    { "decsp1",                REG_NONE,       REG_Y           },
+    { "decsp2",        REG_NONE,       REG_A           },
+    { "decsp3",        REG_NONE,       REG_A           },
+    { "decsp4",        REG_NONE,       REG_A           },
+    { "decsp5",        REG_NONE,       REG_A           },
+    { "decsp6",        REG_NONE,       REG_A           },
+    { "decsp7",        REG_NONE,       REG_A           },
+    { "decsp8",        REG_NONE,       REG_A           },
+    { "incax1",         REG_AX,         REG_AX          },
+    { "incax2",         REG_AX,         REG_AX          },
+    { "incsp1",                REG_NONE,       REG_NONE        },
+    { "incsp2",                REG_NONE,       REG_Y           },
+    { "incsp3",                REG_NONE,       REG_Y           },
+    { "incsp4",                REG_NONE,       REG_Y           },
+    { "incsp5",                REG_NONE,       REG_Y           },
+    { "incsp6",                REG_NONE,       REG_Y           },
+    { "incsp7",                REG_NONE,       REG_Y           },
+    { "incsp8",                REG_NONE,       REG_Y           },
+    { "ldaidx",         REG_AXY,        REG_AX          },
+    { "ldauidx",        REG_AXY,        REG_AX          },
+    { "ldax0sp",       REG_Y,          REG_AX          },
+    { "ldaxi",          REG_AX,         REG_AXY         },
+    { "ldaxidx",        REG_AXY,        REG_AX          },
+    { "ldaxysp",       REG_Y,          REG_AX          },
+    { "leaasp",         REG_A,          REG_AX          },
+    { "negax",          REG_AX,         REG_AX          },
+    { "pusha",         REG_A,          REG_Y           },
+    { "pusha0",                REG_A,          REG_XY          },
+    { "pushax",                REG_AX,         REG_Y           },
+    { "pusheax",        REG_AX,         REG_Y           },
+    { "pushw0sp",      REG_NONE,       REG_AXY         },
+    { "pushwysp",      REG_Y,          REG_AXY         },
+    { "shlax1",         REG_AX,                REG_AX          },
+    { "shlax2",         REG_AX,                REG_AX          },
+    { "shlax3",         REG_AX,                REG_AX          },
+    { "shlax4",         REG_AX,                REG_AX          },
+    { "shrax1",         REG_AX,         REG_AX          },
+    { "shrax2",         REG_AX,         REG_AX          },
+    { "shrax3",         REG_AX,         REG_AX          },
+    { "shrax4",         REG_AX,         REG_AX          },
+    { "shreax1",        REG_AX,         REG_AX          },
+    { "shreax2",        REG_AX,         REG_AX          },
+    { "shreax3",        REG_AX,         REG_AX          },
+    { "shreax4",        REG_AX,         REG_AX          },
+    { "staspidx",       REG_A | REG_Y,  REG_Y           },
+    { "stax0sp",        REG_AX,         REG_Y           },
+    { "tosicmp",       REG_AX,         REG_AXY         },
+    { "tosdiva0",       REG_AX,                REG_AXY         },
+    { "tosdivax",       REG_AX,                REG_AXY         },
+    { "tosdiveax",      REG_AX,                REG_AXY         },
+    { "tosmula0",       REG_AX,                REG_AXY         },
+    { "tosmulax",       REG_AX,                REG_AXY         },
+    { "tosmuleax",      REG_AX,                REG_AXY         },
+    { "tosshreax",      REG_AX,                REG_AXY         },
+    { "tosumula0",      REG_AX,                REG_AXY         },
+    { "tosumulax",      REG_AX,                REG_AXY         },
+    { "tosumuleax",     REG_AX,                REG_AXY         },
 };
 #define FuncInfoCount  (sizeof(FuncInfoTable) / sizeof(FuncInfoTable[0]))
 
+/* Table with names of zero page locations used by the compiler */
+typedef struct ZPInfo ZPInfo;
+struct ZPInfo {
+    unsigned char Len;         /* Length of the following string */
+    char          Name[11];     /* Name of zero page symbol */
+};
+static const ZPInfo ZPInfoTable[] = {
+    {          4,      "ptr1"          },
+    {   7,      "regbank"       },
+    {   7,      "regsave"       },
+    {   2,      "sp"            },
+    {   4,      "sreg"          },
+    {   4,      "tmp1"          },
+};
+#define ZPInfoCount            (sizeof(ZPInfoTable) / sizeof(ZPInfoTable[0]))
 
 
 /*****************************************************************************/
-/*                                          Code                                    */
+/*                                          Code                                    */
 /*****************************************************************************/
 
 
@@ -112,25 +186,305 @@ static int CompareFuncInfo (const void* Key, const void* Info)
 
 
 void GetFuncInfo (const char* Name, unsigned char* Use, unsigned char* Chg)
-/* For the given function, lookup register information and combine it with
- * the information already in place. If the function is unknown, assume it
- * will use all registers and load all registers.
- * See codeinfo.h for possible flags.
+/* For the given function, lookup register information and store it into
+ * the given variables. If the function is unknown, assume it will use and
+ * load all registers.
  */
 {
-    /* Search for the function */
-    const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
-                                   sizeof(FuncInfo), CompareFuncInfo);
-
-    /* Do we know the function? */
-    if (Info) {
-       /* Use the information we have */
-       *Use |= Info->Use;
-       *Chg |= Info->Chg;
+    /* If the function name starts with an underline, it is an external
+     * function. Search for it in the symbol table. If the function does
+     * not start with an underline, it may be a runtime support function.
+     * Search for it in the list of builtin functions.
+     */
+    if (Name[0] == '_') {
+
+       /* Search in the symbol table, skip the leading underscore */
+       SymEntry* E = FindGlobalSym (Name+1);
+
+       /* Did we find it in the top level table? */
+       if (E && IsTypeFunc (E->Type)) {
+
+           /* A function may use the A or A/X registers if it is a fastcall
+            * function. If it is not a fastcall function but a variadic one,
+            * it will use the Y register (the parameter size is passed here).
+            * In all other cases, no registers are used. However, we assume
+            * that any function will destroy all registers.
+            */
+           FuncDesc* D = E->V.F.Func;
+           if ((D->Flags & FD_FASTCALL) != 0 && D->ParamCount > 0) {
+               /* Will use registers depending on the last param */
+               SymEntry* LastParam = D->SymTab->SymTail;
+               if (SizeOf (LastParam->Type) == 1) {
+                   *Use = REG_A;
+               } else {
+                   *Use = REG_AX;
+               }
+           } else if ((D->Flags & FD_VARIADIC) != 0) {
+               *Use = REG_Y;
+           } else {
+               /* Will not use any registers */
+               *Use = REG_NONE;
+           }
+
+           /* Will destroy all registers */
+           *Chg = REG_AXY;
+
+           /* Done */
+           return;
+       }
+
     } else {
-       *Use |= REG_AXY;
-       *Chg |= REG_AXY;
+
+       /* Search for the function in the list of builtin functions */
+       const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
+                                       sizeof(FuncInfo), CompareFuncInfo);
+
+       /* Do we know the function? */
+       if (Info) {
+           /* Use the information we have */
+           *Use = Info->Use;
+           *Chg = Info->Chg;
+           return;
+       }
     }
+
+    /* Function not found - assume all registers used */
+    *Use = REG_AXY;
+    *Chg = REG_AXY;
+}
+
+
+
+int IsZPName (const char* Name)
+/* Return true if the given name is a zero page symbol */
+{
+    unsigned I;
+    const ZPInfo* Info;
+
+    /* Because of the low number of symbols, we do a linear search here */
+    for (I = 0, Info = ZPInfoTable; I < ZPInfoCount; ++I, ++Info) {
+               if (strncmp (Name, Info->Name, Info->Len) == 0 &&
+           (Name[Info->Len] == '\0' || Name[Info->Len] == '+')) {
+           /* Found */
+           return 1;
+       }
+    }
+
+    /* Not found */
+    return 0;
+}
+
+
+
+static unsigned char GetRegInfo2 (CodeSeg* S,
+                                 CodeEntry* E,
+                                 int Index,
+                                 Collection* Visited,
+                                 unsigned char Used,
+                                 unsigned char Unused)
+/* Recursively called subfunction for GetRegInfo. */
+{
+    /* Follow the instruction flow recording register usage. */
+    while (1) {
+
+       unsigned char R;
+
+       /* Check if we have already visited the current code entry. If so,
+        * bail out.
+        */
+       if (CE_HasMark (E)) {
+           break;
+       }
+
+       /* Mark this entry as already visited */
+       CE_SetMark (E);
+       CollAppend (Visited, E);
+
+       /* Evaluate the used registers */
+       R = E->Use;
+       if (E->OPC == OP65_RTS ||
+           ((E->Info & OF_BRA) != 0 && E->JumpTo == 0)) {
+           /* This instruction will leave the function */
+           R |= S->ExitRegs;
+       }
+               if (R != REG_NONE) {
+           /* We are not interested in the use of any register that has been
+            * used before.
+            */
+           R &= ~Unused;
+           /* Remember the remaining registers */
+           Used |= R;
+       }
+
+       /* Evaluate the changed registers */
+               if ((R = E->Chg) != REG_NONE) {
+           /* We are not interested in the use of any register that has been
+            * used before.
+            */
+           R &= ~Used;
+           /* Remember the remaining registers */
+           Unused |= R;
+       }
+
+               /* If we know about all registers now, bail out */
+               if ((Used | Unused) == REG_AXY) {
+           break;
+       }
+
+       /* If the instruction is an RTS or RTI, we're done */
+               if ((E->Info & OF_RET) != 0) {
+           break;
+       }
+
+       /* If we have an unconditional branch, follow this branch if possible,
+        * otherwise we're done.
+        */
+       if ((E->Info & OF_UBRA) != 0) {
+
+           /* Does this jump have a valid target? */
+           if (E->JumpTo) {
+
+               /* Unconditional jump */
+               E     = E->JumpTo->Owner;
+               Index = -1;             /* Invalidate */
+
+           } else {
+               /* Jump outside means we're done */
+               break;
+           }
+
+               /* In case of conditional branches, follow the branch if possible and
+        * follow the normal flow (branch not taken) afterwards. If we cannot
+        * follow the branch, we're done.
+        */
+       } else if ((E->Info & OF_CBRA) != 0) {
+
+           if (E->JumpTo) {
+
+               /* Recursively determine register usage at the branch target */
+               unsigned char U1;
+               unsigned char U2;
+
+               U1 = GetRegInfo2 (S, E->JumpTo->Owner, -1, Visited, Used, Unused);
+               if (U1 == REG_AXY) {
+                   /* All registers used, no need for second call */
+                   return REG_AXY;
+               }
+               if (Index < 0) {
+                   Index = CS_GetEntryIndex (S, E);
+               }
+                       if ((E = CS_GetEntry (S, ++Index)) == 0) {
+                   Internal ("GetRegInfo2: No next entry!");
+               }
+               U2 = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
+               return U1 | U2;         /* Used in any of the branches */
+
+           } else {
+               /* Jump to global symbol */
+               break;
+           }
+
+               } else {
+
+           /* Just go to the next instruction */
+           if (Index < 0) {
+               Index = CS_GetEntryIndex (S, E);
+           }
+           E = CS_GetEntry (S, ++Index);
+           if (E == 0) {
+               /* No next entry */
+               Internal ("GetRegInfo2: No next entry!");
+           }
+
+       }
+
+    }
+
+    /* Return to the caller the complement of all unused registers */
+    return Used;
+}
+
+
+
+static unsigned char GetRegInfo1 (CodeSeg* S,
+                                 CodeEntry* E,
+                                 int Index,
+                                 Collection* Visited,
+                                 unsigned char Used,
+                                 unsigned char Unused)
+/* Recursively called subfunction for GetRegInfo. */
+{
+    /* Remember the current count of the line collection */
+    unsigned Count = CollCount (Visited);
+
+    /* Call the worker routine */
+    unsigned char R = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
+
+    /* Restore the old count, unmarking all new entries */
+    unsigned NewCount = CollCount (Visited);
+    while (NewCount-- > Count) {
+       CodeEntry* E = CollAt (Visited, NewCount);
+       CE_ResetMark (E);
+       CollDelete (Visited, NewCount);
+    }
+
+    /* Return the registers used */
+    return R;
+}
+
+
+
+unsigned char GetRegInfo (struct CodeSeg* S, unsigned Index)
+/* Determine register usage information for the instructions starting at the
+ * given index.
+ */
+{
+    CodeEntry*     E;
+    Collection     Visited;    /* Visited entries */
+    unsigned char   R;
+
+    /* Get the code entry for the given index */
+    if (Index >= CS_GetEntryCount (S)) {
+       /* There is no such code entry */
+       return REG_NONE;
+    }
+    E = CS_GetEntry (S, Index);
+
+    /* Initialize the data structure used to collection information */
+    InitCollection (&Visited);
+
+    /* Call the recursive subfunction */
+    R = GetRegInfo1 (S, E, Index, &Visited, REG_NONE, REG_NONE);
+
+    /* Delete the line collection */
+    DoneCollection (&Visited);
+
+    /* Return the registers used */
+    return R;
+}
+
+
+
+int RegAUsed (struct CodeSeg* S, unsigned Index)
+/* Check if the value in A is used. */
+{
+    return (GetRegInfo (S, Index) & REG_A) != 0;
+}
+
+
+
+int RegXUsed (struct CodeSeg* S, unsigned Index)
+/* Check if the value in X is used. */
+{
+    return (GetRegInfo (S, Index) & REG_X) != 0;
+}
+
+
+
+int RegYUsed (struct CodeSeg* S, unsigned Index)
+/* Check if the value in Y is used. */
+{
+    return (GetRegInfo (S, Index) & REG_Y) != 0;
 }