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     { "shrax4",         REG_AX,         REG_AX          },
 129     { "shreax1",        REG_AX,         REG_AX          },
 130     { "shreax2",        REG_AX,         REG_AX          },
 131     { "shreax3",        REG_AX,         REG_AX          },
 132     { "shreax4",        REG_AX,         REG_AX          },
 133     { "staspidx",       REG_A | REG_Y,  REG_Y           },
 134     { "tosicmp",        REG_AX,         REG_AXY         },
 135     { "tosdiva0",       REG_AX,         REG_AXY         },
 136     { "tosdivax",       REG_AX,         REG_AXY         },
 137     { "tosdiveax",      REG_AX,         REG_AXY         },
 138     { "tosmula0",       REG_AX,         REG_AXY         },
 139     { "tosmulax",       REG_AX,         REG_AXY         },
 140     { "tosmuleax",      REG_AX,         REG_AXY         },
 141     { "tosshreax",      REG_AX,         REG_AXY         },
 142     { "tosumula0",      REG_AX,         REG_AXY         },
 143     { "tosumulax",      REG_AX,         REG_AXY         },
 144     { "tosumuleax",     REG_AX,         REG_AXY         },
 145 };
 146 #define FuncInfoCount   (sizeof(FuncInfoTable) / sizeof(FuncInfoTable[0]))
 147
 148 /* Table with names of zero page locations used by the compiler */
 149 typedef struct ZPInfo ZPInfo;
 150 struct ZPInfo {
 151     unsigned char Len;          /* Length of the following string */
 152     char          Name[11];     /* Name of zero page symbol */
 153 };
 154 static const ZPInfo ZPInfoTable[] = {
 155     {   4,      "ptr1"          },
 156     {   7,      "regbank"       },
 157     {   7,      "regsave"       },
 158     {   2,      "sp"            },
 159     {   4,      "sreg"          },
 160     {   4,      "tmp1"          },
 161 };
 162 #define ZPInfoCount     (sizeof(ZPInfoTable) / sizeof(ZPInfoTable[0]))
 163
 164
 165 /*****************************************************************************/
 166 /*                                   Code                                    */
 167 /*****************************************************************************/
 168
 169
 170
 171 static int CompareFuncInfo (const void* Key, const void* Info)
 172 /* Compare function for bsearch */
 173 {
 174     return strcmp (Key, ((const FuncInfo*) Info)->Name);
 175 }
 176
 177
 178
 179 void GetFuncInfo (const char* Name, unsigned char* Use, unsigned char* Chg)
 180 /* For the given function, lookup register information and store it into
 181  * the given variables. If the function is unknown, assume it will use and
 182  * load all registers.
 183  */
 184 {
 185     /* If the function name starts with an underline, it is an external
 186      * function. Search for it in the symbol table. If the function does
 187      * not start with an underline, it may be a runtime support function.
 188      * Search for it in the list of builtin functions.
 189      */
 190     if (Name[0] == '_') {
 191
 192         /* Search in the symbol table, skip the leading underscore */
 193         SymEntry* E = FindGlobalSym (Name+1);
 194
 195         /* Did we find it in the top level table? */
 196         if (E && IsTypeFunc (E->Type)) {
 197
 198             /* A function may use the A or A/X registers if it is a fastcall
 199              * function. If it is not a fastcall function but a variadic one,
 200              * it will use the Y register (the parameter size is passed here).
 201              * In all other cases, no registers are used. However, we assume
 202              * that any function will destroy all registers.
 203              */
 204             FuncDesc* D = E->V.F.Func;
 205             if ((D->Flags & FD_FASTCALL) != 0 && D->ParamCount > 0) {
 206                 /* Will use registers depending on the last param */
 207                 SymEntry* LastParam = D->SymTab->SymTail;
 208                 if (SizeOf (LastParam->Type) == 1) {
 209                     *Use = REG_A;
 210                 } else {
 211                     *Use = REG_AX;
 212                 }
 213             } else if ((D->Flags & FD_VARIADIC) != 0) {
 214                 *Use = REG_Y;
 215             } else {
 216                 /* Will not use any registers */
 217                 *Use = REG_NONE;
 218             }
 219
 220             /* Will destroy all registers */
 221             *Chg = REG_AXY;
 222
 223             /* Done */
 224             return;
 225         }
 226
 227     } else {
 228
 229         /* Search for the function in the list of builtin functions */
 230         const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
 231                                         sizeof(FuncInfo), CompareFuncInfo);
 232
 233         /* Do we know the function? */
 234         if (Info) {
 235             /* Use the information we have */
 236             *Use = Info->Use;
 237             *Chg = Info->Chg;
 238             return;
 239         }
 240     }
 241
 242     /* Function not found - assume all registers used */
 243     *Use = REG_AXY;
 244     *Chg = REG_AXY;
 245 }
 246
 247
 248
 249 int IsZPName (const char* Name)
 250 /* Return true if the given name is a zero page symbol */
 251 {
 252     unsigned I;
 253     const ZPInfo* Info;
 254
 255     /* Because of the low number of symbols, we do a linear search here */
 256     for (I = 0, Info = ZPInfoTable; I < ZPInfoCount; ++I, ++Info) {
 257         if (strncmp (Name, Info->Name, Info->Len) == 0 &&
 258             (Name[Info->Len] == '\0' || Name[Info->Len] == '+')) {
 259             /* Found */
 260             return 1;
 261         }
 262     }
 263
 264     /* Not found */
 265     return 0;
 266 }
 267
 268
 269
 270 static unsigned char GetRegInfo2 (CodeSeg* S,
 271                                   CodeEntry* E,
 272                                   int Index,
 273                                   Collection* Visited,
 274                                   unsigned char Used,
 275                                   unsigned char Unused)
 276 /* Recursively called subfunction for GetRegInfo. */
 277 {
 278     /* Follow the instruction flow recording register usage. */
 279     while (1) {
 280
 281         unsigned char R;
 282
 283         /* Check if we have already visited the current code entry. If so,
 284          * bail out.
 285          */
 286         if (CE_HasMark (E)) {
 287             break;
 288         }
 289
 290         /* Mark this entry as already visited */
 291         CE_SetMark (E);
 292         CollAppend (Visited, E);
 293
 294         /* Evaluate the used registers */
 295         R = E->Use;
 296         if (E->OPC == OP65_RTS ||
 297             ((E->Info & OF_BRA) != 0 && E->JumpTo == 0)) {
 298             /* This instruction will leave the function */
 299             R |= S->ExitRegs;
 300         }
 301         if (R != REG_NONE) {
 302             /* We are not interested in the use of any register that has been
 303              * used before.
 304              */
 305             R &= ~Unused;
 306             /* Remember the remaining registers */
 307             Used |= R;
 308         }
 309
 310         /* Evaluate the changed registers */
 311         if ((R = E->Chg) != REG_NONE) {
 312             /* We are not interested in the use of any register that has been
 313              * used before.
 314              */
 315             R &= ~Used;
 316             /* Remember the remaining registers */
 317             Unused |= R;
 318         }
 319
 320         /* If we know about all registers now, bail out */
 321         if ((Used | Unused) == REG_AXY) {
 322             break;
 323         }
 324
 325         /* If the instruction is an RTS or RTI, we're done */
 326         if ((E->Info & OF_RET) != 0) {
 327             break;
 328         }
 329
 330         /* If we have an unconditional branch, follow this branch if possible,
 331          * otherwise we're done.
 332          */
 333         if ((E->Info & OF_UBRA) != 0) {
 334
 335             /* Does this jump have a valid target? */
 336             if (E->JumpTo) {
 337
 338                 /* Unconditional jump */
 339                 E     = E->JumpTo->Owner;
 340                 Index = -1;             /* Invalidate */
 341
 342             } else {
 343                 /* Jump outside means we're done */
 344                 break;
 345             }
 346
 347         /* In case of conditional branches, follow the branch if possible and
 348          * follow the normal flow (branch not taken) afterwards. If we cannot
 349          * follow the branch, we're done.
 350          */
 351         } else if ((E->Info & OF_CBRA) != 0) {
 352
 353             if (E->JumpTo) {
 354
 355                 /* Recursively determine register usage at the branch target */
 356                 unsigned char U1;
 357                 unsigned char U2;
 358
 359                 U1 = GetRegInfo2 (S, E->JumpTo->Owner, -1, Visited, Used, Unused);
 360                 if (U1 == REG_AXY) {
 361                     /* All registers used, no need for second call */
 362                     return REG_AXY;
 363                 }
 364                 if (Index < 0) {
 365                     Index = CS_GetEntryIndex (S, E);
 366                 }
 367                 if ((E = CS_GetEntry (S, ++Index)) == 0) {
 368                     Internal ("GetRegInfo2: No next entry!");
 369                 }
 370                 U2 = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 371                 return U1 | U2;         /* Used in any of the branches */
 372
 373             } else {
 374                 /* Jump to global symbol */
 375                 break;
 376             }
 377
 378         } else {
 379
 380             /* Just go to the next instruction */
 381             if (Index < 0) {
 382                 Index = CS_GetEntryIndex (S, E);
 383             }
 384             E = CS_GetEntry (S, ++Index);
 385             if (E == 0) {
 386                 /* No next entry */
 387                 Internal ("GetRegInfo2: No next entry!");
 388             }
 389
 390         }
 391
 392     }
 393
 394     /* Return to the caller the complement of all unused registers */
 395     return Used;
 396 }
 397
 398
 399
 400 static unsigned char GetRegInfo1 (CodeSeg* S,
 401                                   CodeEntry* E,
 402                                   int Index,
 403                                   Collection* Visited,
 404                                   unsigned char Used,
 405                                   unsigned char Unused)
 406 /* Recursively called subfunction for GetRegInfo. */
 407 {
 408     /* Remember the current count of the line collection */
 409     unsigned Count = CollCount (Visited);
 410
 411     /* Call the worker routine */
 412     unsigned char R = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 413
 414     /* Restore the old count, unmarking all new entries */
 415     unsigned NewCount = CollCount (Visited);
 416     while (NewCount-- > Count) {
 417         CodeEntry* E = CollAt (Visited, NewCount);
 418         CE_ResetMark (E);
 419         CollDelete (Visited, NewCount);
 420     }
 421
 422     /* Return the registers used */
 423     return R;
 424 }
 425
 426
 427
 428 unsigned char GetRegInfo (struct CodeSeg* S, unsigned Index)
 429 /* Determine register usage information for the instructions starting at the
 430  * given index.
 431  */
 432 {
 433     CodeEntry*      E;
 434     Collection      Visited;    /* Visited entries */
 435     unsigned char   R;
 436
 437     /* Get the code entry for the given index */
 438     if (Index >= CS_GetEntryCount (S)) {
 439         /* There is no such code entry */
 440         return REG_NONE;
 441     }
 442     E = CS_GetEntry (S, Index);
 443
 444     /* Initialize the data structure used to collection information */
 445     InitCollection (&Visited);
 446
 447     /* Call the recursive subfunction */
 448     R = GetRegInfo1 (S, E, Index, &Visited, REG_NONE, REG_NONE);
 449
 450     /* Delete the line collection */
 451     DoneCollection (&Visited);
 452
 453     /* Return the registers used */
 454     return R;
 455 }
 456
 457
 458
 459 int RegAUsed (struct CodeSeg* S, unsigned Index)
 460 /* Check if the value in A is used. */
 461 {
 462     return (GetRegInfo (S, Index) & REG_A) != 0;
 463 }
 464
 465
 466
 467 int RegXUsed (struct CodeSeg* S, unsigned Index)
 468 /* Check if the value in X is used. */
 469 {
 470     return (GetRegInfo (S, Index) & REG_X) != 0;
 471 }
 472
 473
 474
 475 int RegYUsed (struct CodeSeg* S, unsigned Index)
 476 /* Check if the value in Y is used. */
 477 {
 478     return (GetRegInfo (S, Index) & REG_Y) != 0;
 479 }
 480
 481
 482
 483