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     { "booleq",         REG_NONE,       REG_AX          },
  71     { "boolge",         REG_NONE,       REG_AX          },
  72     { "boolgt",         REG_NONE,       REG_AX          },
  73     { "boolle",         REG_NONE,       REG_AX          },
  74     { "boollt",         REG_NONE,       REG_AX          },
  75     { "boolne",         REG_NONE,       REG_AX          },
  76     { "booluge",        REG_NONE,       REG_AX          },
  77     { "boolugt",        REG_NONE,       REG_AX          },
  78     { "boolule",        REG_NONE,       REG_AX          },
  79     { "boolult",        REG_NONE,       REG_AX          },
  80     { "decax1",         REG_AX,         REG_AX          },
  81     { "decax2",         REG_AX,         REG_AX          },
  82     { "decax3",         REG_AX,         REG_AX          },
  83     { "decax4",         REG_AX,         REG_AX          },
  84     { "decax5",         REG_AX,         REG_AX          },
  85     { "decax6",         REG_AX,         REG_AX          },
  86     { "decax7",         REG_AX,         REG_AX          },
  87     { "decax8",         REG_AX,         REG_AX          },
  88     { "decaxy",         REG_AXY,        REG_AX          },
  89     { "decsp2",         REG_NONE,       REG_A           },
  90     { "decsp3",         REG_NONE,       REG_A           },
  91     { "decsp4",         REG_NONE,       REG_A           },
  92     { "decsp5",         REG_NONE,       REG_A           },
  93     { "decsp6",         REG_NONE,       REG_A           },
  94     { "decsp7",         REG_NONE,       REG_A           },
  95     { "decsp8",         REG_NONE,       REG_A           },
  96     { "incsp1",         REG_NONE,       REG_NONE        },
  97     { "incsp2",         REG_NONE,       REG_Y           },
  98     { "incsp3",         REG_NONE,       REG_Y           },
  99     { "incsp4",         REG_NONE,       REG_Y           },
 100     { "incsp5",         REG_NONE,       REG_Y           },
 101     { "incsp6",         REG_NONE,       REG_Y           },
 102     { "incsp7",         REG_NONE,       REG_Y           },
 103     { "incsp8",         REG_NONE,       REG_Y           },
 104     { "ldax0sp",        REG_Y,          REG_AX          },
 105     { "ldaxysp",        REG_Y,          REG_AX          },
 106     { "pusha",          REG_A,          REG_Y           },
 107     { "pusha0",         REG_A,          REG_XY          },
 108     { "pushax",         REG_AX,         REG_Y           },
 109     { "pushw0sp",       REG_NONE,       REG_AXY         },
 110     { "pushwysp",       REG_Y,          REG_AXY         },
 111     { "tosicmp",        REG_AX,         REG_AXY         },
 112 };
 113 #define FuncInfoCount   (sizeof(FuncInfoTable) / sizeof(FuncInfoTable[0]))
 114
 115
 116
 117 /*****************************************************************************/
 118 /*                                   Code                                    */
 119 /*****************************************************************************/
 120
 121
 122
 123 static int CompareFuncInfo (const void* Key, const void* Info)
 124 /* Compare function for bsearch */
 125 {
 126     return strcmp (Key, ((const FuncInfo*) Info)->Name);
 127 }
 128
 129
 130
 131 void GetFuncInfo (const char* Name, unsigned char* Use, unsigned char* Chg)
 132 /* For the given function, lookup register information and store it into
 133  * the given variables. If the function is unknown, assume it will use and
 134  * load all registers.
 135  */
 136 {
 137     /* If the function name starts with an underline, it is an external
 138      * function. Search for it in the symbol table. If the function does
 139      * not start with an underline, it may be a runtime support function.
 140      * Search for it in the list of builtin functions.
 141      */
 142     if (Name[0] == '_') {
 143
 144         /* Search in the symbol table, skip the leading underscore */
 145         SymEntry* E = FindSym (Name+1);
 146
 147         /* Did we find it in the top level table? */
 148         if (E && E->Owner->PrevTab == 0 && IsTypeFunc (E->Type)) {
 149
 150             /* A function may use the A or A/X registers if it is a fastcall
 151              * function. Otherwise it does not use any registers passed by
 152              * the caller. However, we assume that any function will destroy
 153              * all registers.
 154              */
 155             FuncDesc* D = E->V.F.Func;
 156             if ((D->Flags & FD_FASTCALL) != 0 && D->ParamCount > 0) {
 157                 /* Will use registers depending on the last param */
 158                 SymEntry* LastParam = D->SymTab->SymTail;
 159                 if (SizeOf (LastParam->Type) == 1) {
 160                     *Use = REG_A;
 161                 } else {
 162                     *Use = REG_AX;
 163                 }
 164             } else {
 165                 /* Will not use any registers */
 166                 *Use = REG_NONE;
 167             }
 168
 169             /* Will destroy all registers */
 170             *Chg = REG_AXY;
 171
 172             /* Done */
 173             return;
 174         }
 175
 176     } else {
 177
 178         /* Search for the function in the list of builtin functions */
 179         const FuncInfo* Info = bsearch (Name, FuncInfoTable, FuncInfoCount,
 180                                         sizeof(FuncInfo), CompareFuncInfo);
 181
 182         /* Do we know the function? */
 183         if (Info) {
 184             /* Use the information we have */
 185             *Use = Info->Use;
 186             *Chg = Info->Chg;
 187             return;
 188         }
 189     }
 190
 191     /* Function not found - assume all registers used */
 192     *Use = REG_AXY;
 193     *Chg = REG_AXY;
 194 }
 195
 196
 197
 198 static unsigned char GetRegInfo2 (CodeSeg* S,
 199                                   CodeEntry* E,
 200                                   int Index,
 201                                   Collection* Visited,
 202                                   unsigned char Used,
 203                                   unsigned char Unused)
 204 /* Recursively called subfunction for GetRegInfo. */
 205 {
 206     /* Follow the instruction flow recording register usage. */
 207     while (1) {
 208
 209         unsigned char R;
 210
 211         /* Check if we have already visited the current code entry. If so,
 212          * bail out.
 213          */
 214         if (CodeEntryHasMark (E)) {
 215             break;
 216         }
 217
 218         /* Mark this entry as already visited */
 219         CodeEntrySetMark (E);
 220         CollAppend (Visited, E);
 221
 222         /* Evaluate the used registers */
 223         R = E->Use;
 224         if (E->OPC == OPC_RTS ||
 225             ((E->Info & OF_BRA) != 0 && E->JumpTo == 0)) {
 226             /* This instruction will leave the function */
 227             R |= S->ExitRegs;
 228         }
 229         if (R != REG_NONE) {
 230             /* We are not interested in the use of any register that has been
 231              * used before.
 232              */
 233             R &= ~Unused;
 234             /* Remember the remaining registers */
 235             Used |= R;
 236         }
 237
 238         /* Evaluate the changed registers */
 239         if ((R = E->Chg) != REG_NONE) {
 240             /* We are not interested in the use of any register that has been
 241              * used before.
 242              */
 243             R &= ~Used;
 244             /* Remember the remaining registers */
 245             Unused |= R;
 246         }
 247
 248         /* If we know about all registers now, bail out */
 249         if ((Used | Unused) == REG_AXY) {
 250             break;
 251         }
 252
 253         /* If the instruction is an RTS or RTI, we're done */
 254         if (E->OPC == OPC_RTS || E->OPC == OPC_RTI) {
 255             break;
 256         }
 257
 258         /* If we have an unconditional branch, follow this branch if possible,
 259          * otherwise we're done.
 260          */
 261         if ((E->Info & OF_UBRA) != 0) {
 262
 263             /* Does this jump have a valid target? */
 264             if (E->JumpTo) {
 265
 266                 /* Unconditional jump */
 267                 E     = E->JumpTo->Owner;
 268                 Index = -1;             /* Invalidate */
 269
 270             } else {
 271                 /* Jump outside means we're done */
 272                 break;
 273             }
 274
 275         /* In case of conditional branches, follow the branch if possible and
 276          * follow the normal flow (branch not taken) afterwards. If we cannot
 277          * follow the branch, we're done.
 278          */
 279         } else if ((E->Info & OF_CBRA) != 0) {
 280
 281             if (E->JumpTo) {
 282
 283                 /* Recursively determine register usage at the branch target */
 284                 unsigned char U1;
 285                 unsigned char U2;
 286
 287                 U1 = GetRegInfo2 (S, E->JumpTo->Owner, -1, Visited, Used, Unused);
 288                 if (U1 == REG_AXY) {
 289                     /* All registers used, no need for second call */
 290                     return REG_AXY;
 291                 }
 292                 if (Index < 0) {
 293                     Index = GetCodeEntryIndex (S, E);
 294                 }
 295                 if ((E = GetCodeEntry (S, ++Index)) == 0) {
 296                     Internal ("GetRegInfo2: No next entry!");
 297                 }
 298                 U2 = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 299                 return U1 | U2;         /* Used in any of the branches */
 300
 301             } else {
 302                 /* Jump to global symbol */
 303                 break;
 304             }
 305
 306         } else {
 307
 308             /* Just go to the next instruction */
 309             if (Index < 0) {
 310                 Index = GetCodeEntryIndex (S, E);
 311             }
 312             E = GetCodeEntry (S, ++Index);
 313             if (E == 0) {
 314                 /* No next entry */
 315                 Internal ("GetRegInfo2: No next entry!");
 316             }
 317
 318         }
 319
 320     }
 321
 322     /* Return to the caller the complement of all unused registers */
 323     return Used;
 324 }
 325
 326
 327
 328 static unsigned char GetRegInfo1 (CodeSeg* S,
 329                                   CodeEntry* E,
 330                                   int Index,
 331                                   Collection* Visited,
 332                                   unsigned char Used,
 333                                   unsigned char Unused)
 334 /* Recursively called subfunction for GetRegInfo. */
 335 {
 336     /* Remember the current count of the line collection */
 337     unsigned Count = CollCount (Visited);
 338
 339     /* Call the worker routine */
 340     unsigned char R = GetRegInfo2 (S, E, Index, Visited, Used, Unused);
 341
 342     /* Restore the old count, unmarking all new entries */
 343     unsigned NewCount = CollCount (Visited);
 344     while (NewCount-- > Count) {
 345         CodeEntry* E = CollAt (Visited, NewCount);
 346         CodeEntryResetMark (E);
 347         CollDelete (Visited, NewCount);
 348     }
 349
 350     /* Return the registers used */
 351     return R;
 352 }
 353
 354
 355
 356 unsigned char GetRegInfo (struct CodeSeg* S, unsigned Index)
 357 /* Determine register usage information for the instructions starting at the
 358  * given index.
 359  */
 360 {
 361     CodeEntry*      E;
 362     Collection      Visited;    /* Visited entries */
 363     unsigned char   R;
 364
 365     /* Get the code entry for the given index */
 366     if (Index >= GetCodeEntryCount (S)) {
 367         /* There is no such code entry */
 368         return REG_NONE;
 369     }
 370     E = GetCodeEntry (S, Index);
 371
 372     /* Initialize the data structure used to collection information */
 373     InitCollection (&Visited);
 374
 375     /* Call the recursive subfunction */
 376     R = GetRegInfo1 (S, E, Index, &Visited, REG_NONE, REG_NONE);
 377
 378     /* Delete the line collection */
 379     DoneCollection (&Visited);
 380
 381     /* Return the registers used */
 382     return R;
 383 }
 384
 385
 386
 387 int RegAUsed (struct CodeSeg* S, unsigned Index)
 388 /* Check if the value in A is used. */
 389 {
 390     return (GetRegInfo (S, Index) & REG_A) != 0;
 391 }
 392
 393
 394
 395 int RegXUsed (struct CodeSeg* S, unsigned Index)
 396 /* Check if the value in X is used. */
 397 {
 398     return (GetRegInfo (S, Index) & REG_X) != 0;
 399 }
 400
 401
 402
 403 int RegYUsed (struct CodeSeg* S, unsigned Index)
 404 /* Check if the value in Y is used. */
 405 {
 406     return (GetRegInfo (S, Index) & REG_Y) != 0;
 407 }
 408
 409
 410