git.sur5r.net Git - cc65/blob - src/cc65/codeinfo.c

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                codeinfo.c                                 */
   4 /*                                                                           */
   5 /*                  Additional information about 6502 code                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001      Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #include <stdlib.h>
  37 #include <string.h>
  38
  39 /* common */
  40 #include "coll.h"
  41
  42 /* cc65 */
  43 #include "codeent.h"
  44 #include "codeseg.h"
  45 #include "datatype.h"
  46 #include "error.h"
  47 #include "symtab.h"
  48 #include "codeinfo.h"
  49
  50
  51
  52 /*****************************************************************************/
  53 /*                                   Data                                    */
  54 /*****************************************************************************/
  55
  56
  57
  58 /* Table listing the function names and code info values for known internally
  59  * used functions. This table should get auto-generated in the future.
  60  */
  61 typedef struct FuncInfo FuncInfo;
  62 struct FuncInfo {
  63     const char*     Name;       /* Function name */
  64     unsigned char   Use;        /* Register usage */
  65     unsigned char   Chg;        /* Changed/destroyed registers */
  66 };
  67
  68 static const FuncInfo FuncInfoTable[] = {
  69     { "addysp",         REG_Y,          REG_NONE        },
  70     { "bnega",          REG_A,          REG_AX          },
  71     { "bnegax",         REG_AX,         REG_AX          },
  72     { "bnegeax",        REG_AX,         REG_AX          },
  73     { "booleq",         REG_NONE,       REG_AX          },
  74     { "boolge",         REG_NONE,       REG_AX          },
  75     { "boolgt",         REG_NONE,       REG_AX          },
  76     { "boolle",         REG_NONE,       REG_AX          },
  77     { "boollt",         REG_NONE,       REG_AX          },
  78     { "boolne",         REG_NONE,       REG_AX          },
  79     { "booluge",        REG_NONE,       REG_AX          },
  80     { "boolugt",        REG_NONE,       REG_AX          },
  81     { "boolule",        REG_NONE,       REG_AX          },
  82     { "boolult",        REG_NONE,       REG_AX          },
  83     { "complax",        REG_AX,         REG_AX          },
  84     { "decax1",         REG_AX,         REG_AX          },
  85     { "decax2",         REG_AX,         REG_AX          },
  86     { "decax3",         REG_AX,         REG_AX          },
  87     { "decax4",         REG_AX,         REG_AX          },
  88     { "decax5",         REG_AX,         REG_AX          },
  89     { "decax6",         REG_AX,         REG_AX          },
  90     { "decax7",         REG_AX,         REG_AX          },
  91     { "decax8",         REG_AX,         REG_AX          },
  92     { "decaxy",         REG_AXY,        REG_AX          },
  93     { "decsp1",         REG_NONE,       REG_Y           },
  94     { "decsp2",         REG_NONE,       REG_A           },
  95     { "decsp3",         REG_NONE,       REG_A           },
  96     { "decsp4",         REG_NONE,       REG_A           },
  97     { "decsp5",         REG_NONE,       REG_A           },
  98     { "decsp6",         REG_NONE,       REG_A           },
  99     { "decsp7",         REG_NONE,       REG_A           },
 100     { "decsp8",         REG_NONE,       REG_A           },
 101     { "incax1",         REG_AX,         REG_AX          },
 102     { "incax2",         REG_AX,         REG_AX          },
 103     { "incsp1",         REG_NONE,       REG_NONE        },
 104     { "incsp2",         REG_NONE,       REG_Y           },
 105     { "incsp3",         REG_NONE,       REG_Y           },
 106     { "incsp4",         REG_NONE,       REG_Y           },
 107     { "incsp5",         REG_NONE,       REG_Y           },
 108     { "incsp6",         REG_NONE,       REG_Y           },
 109     { "incsp7",         REG_NONE,       REG_Y           },
 110     { "incsp8",         REG_NONE,       REG_Y           },
 111     { "ldaui",          REG_AX,         REG_AXY         },
 112     { "ldauidx",        REG_AXY,        REG_AX          },
 113     { "ldax0sp",        REG_Y,          REG_AX          },
 114     { "ldaxi",          REG_AX,         REG_AXY         },
 115     { "ldaxidx",        REG_AXY,        REG_AX          },
 116     { "ldaxysp",        REG_Y,          REG_AX          },
 117     { "leaasp",         REG_A,          REG_AX          },
 118     { "negax",          REG_AX,         REG_AX          },
 119     { "pusha",          REG_A,          REG_Y           },
 120     { "pusha0",         REG_A,          REG_XY          },
 121     { "pushax",         REG_AX,         REG_Y           },
 122     { "pusheax",        REG_AX,         REG_Y           },
 123     { "pushw0sp",       REG_NONE,       REG_AXY         },
 124     { "pushwysp",       REG_Y,          REG_AXY         },
 125     { "shrax1",         REG_AX,         REG_AX          },
 126     { "shrax2",         REG_AX,         REG_AX          },
 127     { "shrax3",         REG_AX,         REG_AX          },
 128     { "shreax1",        REG_AX,         REG_AX          },
 129     { "shreax2",        REG_AX,         REG_AX          },
 130     { "shreax3",        REG_AX,         REG_AX          },
 131     { "staspidx",       REG_A | REG_Y,  REG_Y           },
 132     { "tosicmp",        REG_AX,         REG_AXY         },
 133     { "tosshreax",      REG_AX,         REG_AXY         },
 134 };
 135 #define FuncInfoCount   (sizeof(FuncInfoTable) / sizeof(FuncInfoTable[0]))
 136
 137 /* Table with names of zero page locations used by the compiler */
 138 typedef struct ZPInfo ZPInfo;
 139 struct ZPInfo {
 140     unsigned char Len;          /* Length of the following string */
 141     char          Name[11];     /* Name of zero page symbol */
 142 };
 143 static const ZPInfo ZPInfoTable[] = {
 144     {   4,      "ptr1"          },
 145     {   7,      "regbank"       },
 146     {   7,      "regsave"       },
 147     {   2,      "sp"            },
 148     {   4,      "sreg"          },
 149     {   4,      "tmp1"          },
 150 };
 151 #define ZPInfoCount     (sizeof(ZPInfoTable) / sizeof(ZPInfoTable[0]))
 152
 153
 154 /*****************************************************************************/
 155 /*                                   Code                                    */
 156 /*****************************************************************************/
 157
 158
 159
 160 static int CompareFuncInfo (const void* Key, const void* Info)
 161 /* Compare function for bsearch */
 162 {
 163     return strcmp (Key, ((const FuncInfo*) Info)->Name);
 164 }
 165
 166
 167
 168 void GetFuncInfo (const char* Name, unsigned char* Use, unsigned char* Chg)
 169 /* For the given function, lookup register information and store it into
 170  * the given variables. If the function is unknown, assume it will use and
 171  * load all registers.
 172  */
 173 {
 174     /* If the function name starts with an underline, it is an external
 175      * function. Search for it in the symbol table. If the function does
 176      * not start with an underline, it may be a runtime support function.
 177      * Search for it in the list of builtin functions.
 178      */
 179     if (Name[0] == '_') {
 180
 181         /* Search in the symbol table, skip the leading underscore */
 182         SymEntry* E = FindGlobalSym (Name+1);
 183
 184         /* Did we find it in the top level table? */
 185         if (E && IsTypeFunc (E->Type)) {
 186
 187             /* A function may use the A or A/X registers if it is a fastcall
 188              * function. If it is not a fastcall function but a variadic one,
 189              * it will use the Y register (the parameter size is passed here).
 190              * In all other cases, no registers are used. However, we assume
 191              * that any function will destroy all registers.
 192              */
 193             FuncDesc* D = E->V.F.Func;
 194             if ((D->Flags & FD_FASTCALL) != 0 && D->ParamCount > 0) {
 195                 /* Will use registers depending on the last param */
 196                 SymEntry* LastParam = D->SymTab->SymTail;
 197                 if (SizeOf (LastParam->Type) == 1) {
 198                     *Use = REG_A;
 199                 } else {
 200                     *Use = REG_AX;
 201                 }
 202             } else if ((D->Flags & FD_VARIADIC) != 0) {
 203                 *Use = REG_Y;
 204             } else {
 205                 /* Will not use any registers */
 206                 *Use = REG_NONE;
 207             }
 208
 209             /* Will destroy all registers */
 210             *Chg = REG_AXY;
 211
 212             /* Done */
 213             return;
 214         }
 215
 216     } else {
 217
 218         /* Search for the function in the list of builtin functions */
 219         const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
 220                                         sizeof(FuncInfo), CompareFuncInfo);
 221
 222         /* Do we know the function? */
 223         if (Info) {
 224             /* Use the information we have */
 225             *Use = Info->Use;
 226             *Chg = Info->Chg;
 227             return;
 228         }
 229     }
 230
 231     /* Function not found - assume all registers used */
 232     *Use = REG_AXY;
 233     *Chg = REG_AXY;
 234 }
 235
 236
 237
 238 int IsZPName (const char* Name)
 239 /* Return true if the given name is a zero page symbol */
 240 {
 241     unsigned I;
 242     const ZPInfo* Info;
 243
 244     /* Because of the low number of symbols, we do a linear search here */
 245     for (I = 0, Info = ZPInfoTable; I < ZPInfoCount; ++I, ++Info) {
 246         if (strncmp (Name, Info->Name, Info->Len) == 0 &&
 247             (Name[Info->Len] == '\0' || Name[Info->Len] == '+')) {
 248             /* Found */
 249             return 1;
 250         }
 251     }
 252
 253     /* Not found */
 254     return 0;
 255 }
 256
 257
 258
 259 static unsigned char GetRegInfo2 (CodeSeg* S,
 260                                   CodeEntry* E,
 261                                   int Index,
 262                                   Collection* Visited,
 263                                   unsigned char Used,
 264                                   unsigned char Unused)
 265 /* Recursively called subfunction for GetRegInfo. */
 266 {
 267     /* Follow the instruction flow recording register usage. */
 268     while (1) {
 269
 270         unsigned char R;
 271
 272         /* Check if we have already visited the current code entry. If so,
 273          * bail out.
 274          */
 275         if (CE_HasMark (E)) {
 276             break;
 277         }
 278
 279         /* Mark this entry as already visited */
 280         CE_SetMark (E);
 281         CollAppend (Visited, E);
 282
 283         /* Evaluate the used registers */
 284         R = E->Use;
 285         if (E->OPC == OP65_RTS ||
 286             ((E->Info & OF_BRA) != 0 && E->JumpTo == 0)) {
 287             /* This instruction will leave the function */
 288             R |= S->ExitRegs;
 289         }
 290         if (R != REG_NONE) {
 291             /* We are not interested in the use of any register that has been
 292              * used before.
 293              */
 294             R &= ~Unused;
 295             /* Remember the remaining registers */
 296             Used |= R;
 297         }
 298
 299         /* Evaluate the changed registers */
 300         if ((R = E->Chg) != REG_NONE) {
 301             /* We are not interested in the use of any register that has been
 302              * used before.
 303              */
 304             R &= ~Used;
 305             /* Remember the remaining registers */
 306             Unused |= R;
 307         }
 308
 309         /* If we know about all registers now, bail out */
 310         if ((Used | Unused) == REG_AXY) {
 311             break;
 312         }
 313
 314         /* If the instruction is an RTS or RTI, we're done */
 315         if ((E->Info & OF_RET) != 0) {
 316             break;
 317         }
 318
 319         /* If we have an unconditional branch, follow this branch if possible,
 320          * otherwise we're done.
 321          */
 322         if ((E->Info & OF_UBRA) != 0) {
 323
 324             /* Does this jump have a valid target? */
 325             if (E->JumpTo) {
 326
 327                 /* Unconditional jump */
 328                 E     = E->JumpTo->Owner;
 329                 Index = -1;             /* Invalidate */
 330
 331             } else {
 332                 /* Jump outside means we're done */
 333                 break;
 334             }
 335
 336         /* In case of conditional branches, follow the branch if possible and
 337          * follow the normal flow (branch not taken) afterwards. If we cannot
 338          * follow the branch, we're done.
 339          */
 340         } else if ((E->Info & OF_CBRA) != 0) {
 341
 342             if (E->JumpTo) {
 343
 344                 /* Recursively determine register usage at the branch target */
 345                 unsigned char U1;
 346                 unsigned char U2;
 347
 348                 U1 = GetRegInfo2 (S, E->JumpTo->Owner, -1, Visited, Used, Unused);
 349                 if (U1 == REG_AXY) {
 350                     /* All registers used, no need for second call */
 351                     return REG_AXY;
 352                 }
 353                 if (Index < 0) {
 354                     Index = CS_GetEntryIndex (S, E);
 355                 }
 356                 if ((E = CS_GetEntry (S, ++Index)) == 0) {
 357                     Internal ("GetRegInfo2: No next entry!");
 358                 }
 359                 U2 = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 360                 return U1 | U2;         /* Used in any of the branches */
 361
 362             } else {
 363                 /* Jump to global symbol */
 364                 break;
 365             }
 366
 367         } else {
 368
 369             /* Just go to the next instruction */
 370             if (Index < 0) {
 371                 Index = CS_GetEntryIndex (S, E);
 372             }
 373             E = CS_GetEntry (S, ++Index);
 374             if (E == 0) {
 375                 /* No next entry */
 376                 Internal ("GetRegInfo2: No next entry!");
 377             }
 378
 379         }
 380
 381     }
 382
 383     /* Return to the caller the complement of all unused registers */
 384     return Used;
 385 }
 386
 387
 388
 389 static unsigned char GetRegInfo1 (CodeSeg* S,
 390                                   CodeEntry* E,
 391                                   int Index,
 392                                   Collection* Visited,
 393                                   unsigned char Used,
 394                                   unsigned char Unused)
 395 /* Recursively called subfunction for GetRegInfo. */
 396 {
 397     /* Remember the current count of the line collection */
 398     unsigned Count = CollCount (Visited);
 399
 400     /* Call the worker routine */
 401     unsigned char R = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 402
 403     /* Restore the old count, unmarking all new entries */
 404     unsigned NewCount = CollCount (Visited);
 405     while (NewCount-- > Count) {
 406         CodeEntry* E = CollAt (Visited, NewCount);
 407         CE_ResetMark (E);
 408         CollDelete (Visited, NewCount);
 409     }
 410
 411     /* Return the registers used */
 412     return R;
 413 }
 414
 415
 416
 417 unsigned char GetRegInfo (struct CodeSeg* S, unsigned Index)
 418 /* Determine register usage information for the instructions starting at the
 419  * given index.
 420  */
 421 {
 422     CodeEntry*      E;
 423     Collection      Visited;    /* Visited entries */
 424     unsigned char   R;
 425
 426     /* Get the code entry for the given index */
 427     if (Index >= CS_GetEntryCount (S)) {
 428         /* There is no such code entry */
 429         return REG_NONE;
 430     }
 431     E = CS_GetEntry (S, Index);
 432
 433     /* Initialize the data structure used to collection information */
 434     InitCollection (&Visited);
 435
 436     /* Call the recursive subfunction */
 437     R = GetRegInfo1 (S, E, Index, &Visited, REG_NONE, REG_NONE);
 438
 439     /* Delete the line collection */
 440     DoneCollection (&Visited);
 441
 442     /* Return the registers used */
 443     return R;
 444 }
 445
 446
 447
 448 int RegAUsed (struct CodeSeg* S, unsigned Index)
 449 /* Check if the value in A is used. */
 450 {
 451     return (GetRegInfo (S, Index) & REG_A) != 0;
 452 }
 453
 454
 455
 456 int RegXUsed (struct CodeSeg* S, unsigned Index)
 457 /* Check if the value in X is used. */
 458 {
 459     return (GetRegInfo (S, Index) & REG_X) != 0;
 460 }
 461
 462
 463
 464 int RegYUsed (struct CodeSeg* S, unsigned Index)
 465 /* Check if the value in Y is used. */
 466 {
 467     return (GetRegInfo (S, Index) & REG_Y) != 0;
 468 }
 469
 470
 471
 472