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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 codeseg.c                                 */
   4 /*                                                                           */
   5 /*                          Code segment structure                           */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001     Ullrich von Bassewitz                                        */
  10 /*              Wacholderweg 14                                              */
  11 /*              D-70597 Stuttgart                                            */
  12 /* EMail:       uz@musoftware.de                                             */
  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 <string.h>
  37 #include <ctype.h>
  38
  39 /* common */
  40 #include "chartype.h"
  41 #include "check.h"
  42 #include "hashstr.h"
  43 #include "strutil.h"
  44 #include "xmalloc.h"
  45 #include "xsprintf.h"
  46
  47 /* cc65 */
  48 #include "error.h"
  49
  50 /* b6502 */
  51 #include "codeent.h"
  52 #include "codeinfo.h"
  53 #include "codeseg.h"
  54
  55
  56
  57 /*****************************************************************************/
  58 /*                                   Data                                    */
  59 /*****************************************************************************/
  60
  61
  62
  63 /* Pointer to current code segment */
  64 CodeSeg* CS = 0;
  65
  66
  67
  68 /*****************************************************************************/
  69 /*                    Functions for parsing instructions                     */
  70 /*****************************************************************************/
  71
  72
  73
  74 static CodeLabel* NewCodeSegLabel (CodeSeg* S, const char* Name, unsigned Hash)
  75 /* Create a new label and insert it into the label hash table */
  76 {
  77     /* Not found - create a new one */
  78     CodeLabel* L = NewCodeLabel (Name, Hash);
  79
  80     /* Enter the label into the hash table */
  81     L->Next = S->LabelHash[L->Hash];
  82     S->LabelHash[L->Hash] = L;
  83
  84     /* Return the new label */
  85     return L;
  86 }
  87
  88
  89
  90 static const char* SkipSpace (const char* S)
  91 /* Skip white space and return an updated pointer */
  92 {
  93     while (IsSpace (*S)) {
  94         ++S;
  95     }
  96     return S;
  97 }
  98
  99
 100
 101 static const char* ReadToken (const char* L, const char* Term,
 102                               char* Buf, unsigned BufSize)
 103 /* Read the next token into Buf, return the updated line pointer. The
 104  * token is terminated by one of the characters given in term.
 105  */
 106 {
 107     /* Read/copy the token */
 108     unsigned I = 0;
 109     unsigned ParenCount = 0;
 110     while (*L && (ParenCount > 0 || strchr (Term, *L) == 0)) {
 111         if (I < BufSize-1) {
 112             Buf[I++] = *L;
 113         }
 114         if (*L == ')') {
 115             --ParenCount;
 116         } else if (*L == '(') {
 117             ++ParenCount;
 118         }
 119         ++L;
 120     }
 121
 122     /* Terminate the buffer contents */
 123     Buf[I] = '\0';
 124
 125     /* Return the updated line pointer */
 126     return L;
 127 }
 128
 129
 130
 131 static CodeEntry* ParseInsn (CodeSeg* S, const char* L)
 132 /* Parse an instruction nnd generate a code entry from it. If the line contains
 133  * errors, output an error message and return NULL.
 134  * For simplicity, we don't accept the broad range of input a "real" assembler
 135  * does. The instruction and the argument are expected to be separated by
 136  * white space, for example.
 137  */
 138 {
 139     char                Mnemo[16];
 140     const OPCDesc*      OPC;
 141     am_t                AM = 0;         /* Initialize to keep gcc silent */
 142     char                Expr[64];
 143     char                Reg;
 144     CodeEntry*          E;
 145     CodeLabel*          Label;
 146
 147     /* Mnemonic */
 148     L = ReadToken (L, " \t", Mnemo, sizeof (Mnemo));
 149
 150     /* Try to find the opcode description for the mnemonic */
 151     OPC = FindOpcode (Mnemo);
 152
 153     /* If we didn't find the opcode, print an error and bail out */
 154     if (OPC == 0) {
 155         Error ("ASM code error: %s is not a valid mnemonic", Mnemo);
 156         return 0;
 157     }
 158
 159     /* Skip separator white space */
 160     L = SkipSpace (L);
 161
 162     /* Get the addressing mode */
 163     Expr[0] = '\0';
 164     switch (*L) {
 165
 166         case '\0':
 167             /* Implicit */
 168             AM = AM_IMP;
 169             break;
 170
 171         case '#':
 172             /* Immidiate */
 173             StrCopy (Expr, sizeof (Expr), L+1);
 174             AM = AM_IMM;
 175             break;
 176
 177         case '(':
 178             /* Indirect */
 179             L = ReadToken (L+1, ",)", Expr, sizeof (Expr));
 180
 181             /* Check for errors */
 182             if (*L == '\0') {
 183                 Error ("ASM code error: syntax error");
 184                 return 0;
 185             }
 186
 187             /* Check the different indirect modes */
 188             if (*L == ',') {
 189                 /* Expect zp x indirect */
 190                 L = SkipSpace (L+1);
 191                 if (toupper (*L) != 'X') {
 192                     Error ("ASM code error: `X' expected");
 193                     return 0;
 194                 }
 195                 L = SkipSpace (L+1);
 196                 if (*L != ')') {
 197                     Error ("ASM code error: `)' expected");
 198                     return 0;
 199                 }
 200                 L = SkipSpace (L+1);
 201                 if (*L != '\0') {
 202                     Error ("ASM code error: syntax error");
 203                     return 0;
 204                 }
 205                 AM = AM_ZPX_IND;
 206             } else if (*L == ')') {
 207                 /* zp indirect or zp indirect, y */
 208                 L = SkipSpace (L+1);
 209                 if (*L == ',') {
 210                     L = SkipSpace (L+1);
 211                     if (toupper (*L) != 'Y') {
 212                         Error ("ASM code error: `Y' expected");
 213                         return 0;
 214                     }
 215                     L = SkipSpace (L+1);
 216                     if (*L != '\0') {
 217                         Error ("ASM code error: syntax error");
 218                         return 0;
 219                     }
 220                     AM = AM_ZP_INDY;
 221                 } else if (*L == '\0') {
 222                     AM = AM_ZP_IND;
 223                 } else {
 224                     Error ("ASM code error: syntax error");
 225                     return 0;
 226                 }
 227             }
 228             break;
 229
 230         case 'a':
 231         case 'A':
 232             /* Accumulator? */
 233             if (L[1] == '\0') {
 234                 AM = AM_ACC;
 235                 break;
 236             }
 237             /* FALLTHROUGH */
 238
 239         default:
 240             /* Absolute, maybe indexed */
 241             L = ReadToken (L, ",", Expr, sizeof (Expr));
 242             if (*L == '\0') {
 243                 /* Assume absolute */
 244                 AM = AM_ABS;
 245             } else if (*L == ',') {
 246                 /* Indexed */
 247                 L = SkipSpace (L+1);
 248                 if (*L == '\0') {
 249                     Error ("ASM code error: syntax error");
 250                     return 0;
 251                 } else {
 252                     Reg = toupper (*L);
 253                     L = SkipSpace (L+1);
 254                     if (Reg == 'X') {
 255                         AM = AM_ABSX;
 256                     } else if (Reg == 'Y') {
 257                         AM = AM_ABSY;
 258                     } else {
 259                         Error ("ASM code error: syntax error");
 260                         return 0;
 261                     }
 262                     if (*L != '\0') {
 263                         Error ("ASM code error: syntax error");
 264                         return 0;
 265                     }
 266                 }
 267             }
 268             break;
 269
 270     }
 271
 272     /* If the instruction is a branch, check for the label and generate it
 273      * if it does not exist.
 274      */
 275     Label = 0;
 276     if ((OPC->Info & CI_MASK_BRA) == CI_BRA) {
 277
 278         unsigned Hash;
 279
 280         /* ### Check for local labels here */
 281         CHECK (AM == AM_ABS);
 282         AM = AM_BRA;
 283         Hash = HashStr (Expr) % CS_LABEL_HASH_SIZE;
 284         Label = FindCodeLabel (S, Expr, Hash);
 285         if (Label == 0) {
 286             /* Generate a new label */
 287             Label = NewCodeSegLabel (S, Expr, Hash);
 288         }
 289     }
 290
 291     /* We do now have the addressing mode in AM. Allocate a new CodeEntry
 292      * structure and initialize it.
 293      */
 294     E = NewCodeEntry (OPC, AM, Label);
 295     if (Expr[0] != '\0') {
 296         /* We have an additional expression */
 297         E->Arg.Expr = xstrdup (Expr);
 298     }
 299
 300     /* Return the new code entry */
 301     return E;
 302 }
 303
 304
 305
 306 /*****************************************************************************/
 307 /*                                   Code                                    */
 308 /*****************************************************************************/
 309
 310
 311
 312 CodeSeg* NewCodeSeg (const char* SegName, const char* FuncName)
 313 /* Create a new code segment, initialize and return it */
 314 {
 315     unsigned I;
 316
 317     /* Allocate memory */
 318     CodeSeg* S = xmalloc (sizeof (CodeSeg));
 319
 320     /* Initialize the fields */
 321     S->Next     = 0;
 322     S->SegName  = xstrdup (SegName);
 323     S->FuncName = xstrdup (FuncName);
 324     InitCollection (&S->Entries);
 325     InitCollection (&S->Labels);
 326     for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
 327         S->LabelHash[I] = 0;
 328     }
 329
 330     /* Return the new struct */
 331     return S;
 332 }
 333
 334
 335
 336 void FreeCodeSeg (CodeSeg* S)
 337 /* Free a code segment including all code entries */
 338 {
 339     unsigned I, Count;
 340
 341     /* Free the names */
 342     xfree (S->SegName);
 343     xfree (S->FuncName);
 344
 345     /* Free the entries */
 346     Count = CollCount (&S->Entries);
 347     for (I = 0; I < Count; ++I) {
 348         FreeCodeEntry (CollAt (&S->Entries, I));
 349     }
 350
 351     /* Free the collections */
 352     DoneCollection (&S->Entries);
 353     DoneCollection (&S->Labels);
 354
 355     /* Free all labels */
 356     for (I = 0; I < sizeof(S->LabelHash) / sizeof(S->LabelHash[0]); ++I) {
 357         CodeLabel* L = S->LabelHash[I];
 358         while (L) {
 359             CodeLabel* Tmp = L;
 360             L = L->Next;
 361             FreeCodeLabel (Tmp);
 362         }
 363     }
 364
 365     /* Free the struct */
 366     xfree (S);
 367 }
 368
 369
 370
 371 void PushCodeSeg (CodeSeg* S)
 372 /* Push the given code segment onto the stack */
 373 {
 374     S->Next = CS;
 375     CS      = S;
 376 }
 377
 378
 379
 380 CodeSeg* PopCodeSeg (void)
 381 /* Remove the current code segment from the stack and return it */
 382 {
 383     /* Remember the current code segment */
 384     CodeSeg* S = CS;
 385
 386     /* Cannot pop on empty stack */
 387     PRECONDITION (S != 0);
 388
 389     /* Pop */
 390     CS = S->Next;
 391
 392     /* Return the popped code segment */
 393     return S;
 394 }
 395
 396
 397
 398 void AddCodeSegLine (CodeSeg* S, const char* Format, ...)
 399 /* Add a line to the given code segment */
 400 {
 401     const char* L;
 402     CodeEntry*  E;
 403     char        Token[64];
 404
 405     /* Format the line */
 406     va_list ap;
 407     char Buf [256];
 408     va_start (ap, Format);
 409     xvsprintf (Buf, sizeof (Buf), Format, ap);
 410     va_end (ap);
 411
 412     /* Skip whitespace */
 413     L = SkipSpace (Buf);
 414
 415     /* Check which type of instruction we have */
 416     E = 0;      /* Assume no insn created */
 417     switch (*L) {
 418
 419         case '\0':
 420             /* Empty line, just ignore it */
 421             break;
 422
 423         case ';':
 424             /* Comment or hint, ignore it for now */
 425             break;
 426
 427         case '.':
 428             /* Control instruction */
 429             ReadToken (L, " \t", Token, sizeof (Token));
 430             Error ("ASM code error: Pseudo instruction `%s' not supported", Token);
 431             break;
 432
 433         default:
 434             E = ParseInsn (S, L);
 435             break;
 436     }
 437
 438     /* If we have a code entry, transfer the labels and insert it */
 439     if (E) {
 440
 441         /* Transfer the labels if we have any */
 442         unsigned I;
 443         unsigned LabelCount = CollCount (&S->Labels);
 444         for (I = 0; I < LabelCount; ++I) {
 445             /* Get the label */
 446             CodeLabel* L = CollAt (&S->Labels, I);
 447             /* Mark it as defined */
 448             L->Flags |= LF_DEF;
 449             /* Move it to the code entry */
 450             CollAppend (&E->Labels, L);
 451         }
 452
 453         /* Delete the transfered labels */
 454         CollDeleteAll (&S->Labels);
 455
 456         /* Add the entry to the list of code entries in this segment */
 457         CollAppend (&S->Entries, E);
 458
 459     }
 460 }
 461
 462
 463
 464 CodeLabel* AddCodeLabel (CodeSeg* S, const char* Name)
 465 /* Add a code label for the next instruction to follow */
 466 {
 467     /* Calculate the hash from the name */
 468     unsigned Hash = HashStr (Name) % CS_LABEL_HASH_SIZE;
 469
 470     /* Try to find the code label if it does already exist */
 471     CodeLabel* L = FindCodeLabel (S, Name, Hash);
 472
 473     /* Did we find it? */
 474     if (L) {
 475         /* We found it - be sure it does not already have an owner */
 476         CHECK (L->Owner == 0);
 477     } else {
 478         /* Not found - create a new one */
 479         L = NewCodeSegLabel (S, Name, Hash);
 480     }
 481
 482     /* We do now have a valid label. Remember it for later */
 483     CollAppend (&S->Labels, L);
 484
 485     /* Return the label */
 486     return L;
 487 }
 488
 489
 490
 491 void AddExtCodeLabel (CodeSeg* S, const char* Name)
 492 /* Add an external code label for the next instruction to follow */
 493 {
 494     /* Add the code label */
 495     CodeLabel* L = AddCodeLabel (S, Name);
 496
 497     /* Mark it as external label */
 498     L->Flags |= LF_EXT;
 499 }
 500
 501
 502
 503 void AddLocCodeLabel (CodeSeg* S, const char* Name)
 504 /* Add a local code label for the next instruction to follow */
 505 {
 506     /* Add the code label */
 507     AddCodeLabel (S, Name);
 508 }
 509
 510
 511
 512 void AddCodeSegHint (CodeSeg* S, unsigned Hint)
 513 /* Add a hint for the preceeding instruction */
 514 {
 515     CodeEntry* E;
 516
 517     /* Get the number of entries in this segment */
 518     unsigned EntryCount = CollCount (&S->Entries);
 519
 520     /* Must have at least one entry */
 521     CHECK (EntryCount > 0);
 522
 523     /* Get the last entry */
 524     E = CollAt (&S->Entries, EntryCount-1);
 525
 526     /* Add the hint */
 527     E->Hints |= Hint;
 528 }
 529
 530
 531
 532 void DelCodeSegAfter (CodeSeg* S, unsigned Last)
 533 /* Delete all entries including the given one */
 534 {
 535     /* Get the number of entries in this segment */
 536     unsigned Count = CollCount (&S->Entries);
 537
 538     /* Remove all entries after the given one */
 539     while (Last < Count) {
 540
 541         /* Get the next entry */
 542         CodeEntry* E = CollAt (&S->Entries, Count-1);
 543
 544         /* We have to transfer all labels to the code segment label pool */
 545         unsigned LabelCount = CollCount (&E->Labels);
 546         while (LabelCount--) {
 547             CodeLabel* L = CollAt (&E->Labels, LabelCount);
 548             L->Flags &= ~LF_DEF;
 549             CollAppend (&S->Labels, L);
 550         }
 551         CollDeleteAll (&E->Labels);
 552
 553         /* Remove the code entry */
 554         FreeCodeEntry (CollAt (&S->Entries, Count-1));
 555         CollDelete (&S->Entries, Count-1);
 556         --Count;
 557     }
 558 }
 559
 560
 561
 562 void OutputCodeSeg (FILE* F, const CodeSeg* S)
 563 /* Output the code segment data to a file */
 564 {
 565     unsigned I;
 566
 567     /* Get the number of entries in this segment */
 568     unsigned Count = CollCount (&S->Entries);
 569
 570     /* Output the segment directive */
 571     fprintf (F, ".segment\t\"%s\"\n\n", S->SegName);
 572
 573     /* If this is a segment for a function, enter a function */
 574     if (S->FuncName[0] != '\0') {
 575         fprintf (F, ".proc\t_%s\n\n", S->FuncName);
 576     }
 577
 578     /* Output all entries */
 579     for (I = 0; I < Count; ++I) {
 580         OutputCodeEntry (F, CollConstAt (&S->Entries, I));
 581     }
 582
 583     /* If this is a segment for a function, leave the function */
 584     if (S->FuncName[0] != '\0') {
 585         fprintf (F, "\n.endproc\n\n");
 586     }
 587 }
 588
 589
 590
 591 CodeLabel* FindCodeLabel (CodeSeg* S, const char* Name, unsigned Hash)
 592 /* Find the label with the given name. Return the label or NULL if not found */
 593 {
 594     /* Get the first hash chain entry */
 595     CodeLabel* L = S->LabelHash[Hash];
 596
 597     /* Search the list */
 598     while (L) {
 599         if (strcmp (Name, L->Name) == 0) {
 600             /* Found */
 601             break;
 602         }
 603         L = L->Next;
 604     }
 605     return L;
 606 }
 607
 608
 609
 610 void MergeCodeLabels (CodeSeg* S)
 611 /* Merge code labels. That means: For each instruction, remove all labels but
 612  * one and adjust the code entries accordingly.
 613  */
 614 {
 615     unsigned I;
 616
 617     /* Walk over all code entries */
 618     unsigned EntryCount = CollCount (&S->Entries);
 619     for (I = 0; I < EntryCount; ++I) {
 620
 621         CodeLabel* RefLab;
 622         unsigned   J;
 623
 624         /* Get a pointer to the next entry */
 625         CodeEntry* E = CollAt (&S->Entries, I);
 626
 627         /* If this entry has zero labels, continue with the next one */
 628         unsigned LabelCount = CollCount (&E->Labels);
 629         if (LabelCount == 0) {
 630             continue;
 631         }
 632
 633         /* We have at least one label. Use the first one as reference label.
 634          * We don't have a notification for global labels for now, and using
 635          * the first one will also keep the global function labels, since these
 636          * are inserted at position 0.
 637          */
 638         RefLab = CollAt (&E->Labels, 0);
 639
 640         /* Walk through the remaining labels and change references to these
 641          * labels to a reference to the one and only label. Delete the labels
 642          * that are no longer used. To increase performance, walk backwards
 643          * through the list.
 644          */
 645         for (J = LabelCount-1; J >= 1; --J) {
 646
 647             unsigned K;
 648
 649             /* Get the next label */
 650             CodeLabel* L = CollAt (&E->Labels, J);
 651
 652             /* Walk through all instructions referencing this label */
 653             unsigned RefCount = CollCount (&L->JumpFrom);
 654             for (K = 0; K < RefCount; ++K) {
 655
 656                 /* Get the next instrcuction that references this label */
 657                 CodeEntry* E = CollAt (&L->JumpFrom, K);
 658
 659                 /* Change the reference */
 660                 CHECK (E->JumpTo == L);
 661                 E->JumpTo = RefLab;
 662                 CollAppend (&RefLab->JumpFrom, E);
 663
 664             }
 665
 666             /* If the label is not an external label, we may remove the
 667              * label completely.
 668              */
 669 #if 0
 670             if ((L->Flags & LF_EXT) == 0) {
 671                 FreeCodeLabel (L);
 672                 CollDelete (&E->Labels, J);
 673             }
 674 #endif
 675         }
 676
 677         /* The reference label is the only remaining label. If it is not an
 678          * external label, check if there are any references to this label,
 679          * and delete it if this is not the case.
 680          */
 681 #if 0
 682         if ((RefLab->Flags & LF_EXT) == 0 && CollCount (&RefLab->JumpFrom) == 0) {
 683             /* Delete the label */
 684             FreeCodeLabel (RefLab);
 685             /* Remove it from the list */
 686             CollDelete (&E->Labels, 0);
 687         }
 688 #endif
 689     }
 690 }
 691
 692
 693
 694 unsigned GetCodeSegEntries (const CodeSeg* S)
 695 /* Return the number of entries for the given code segment */
 696 {
 697     return CollCount (&S->Entries);
 698 }
 699
 700
 701
 702