git.gag.com Git - fw/sdcc/blob - src/pic16/pcode.h

   1 /*-------------------------------------------------------------------------
   2
   3    pcode.h - post code generation
   4    Written By -  Scott Dattalo scott@dattalo.com
   5    Ported to PIC16 By -  Martin Dubuc m.dubuc@rogers.com
   6
   7    This program is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by the
   9    Free Software Foundation; either version 2, or (at your option) any
  10    later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20
  21 -------------------------------------------------------------------------*/
  22
  23 //#include "ralloc.h"
  24 struct regs;
  25
  26 /*
  27    Post code generation
  28
  29    The post code generation is an assembler optimizer. The assembly code
  30    produced by all of the previous steps is fully functional. This step
  31    will attempt to analyze the flow of the assembly code and agressively
  32    optimize it. The peep hole optimizer attempts to do the same thing.
  33    As you may recall, the peep hole optimizer replaces blocks of assembly
  34    with more optimal blocks (e.g. removing redundant register loads).
  35    However, the peep hole optimizer has to be somewhat conservative since
  36    an assembly program has implicit state information that's unavailable
  37    when only a few instructions are examined.
  38      Consider this example:
  39
  40    example1:
  41      movwf  t1
  42      movf   t1,w
  43
  44    The movf seems redundant since we know that the W register already
  45    contains the same value of t1. So a peep hole optimizer is tempted to
  46    remove the "movf". However, this is dangerous since the movf affects
  47    the flags in the status register (specifically the Z flag) and subsequent
  48    code may depend upon this. Look at these two examples:
  49
  50    example2:
  51      movwf  t1
  52      movf   t1,w     ; Can't remove this movf
  53      skpz
  54       return
  55
  56    example3:
  57      movwf  t1
  58      movf   t1,w     ; This  movf can be removed
  59      xorwf  t2,w     ; since xorwf will over write Z
  60      skpz
  61       return
  62
  63 */
  64
  65
  66 #ifndef __PCODE_H__
  67 #define __PCODE_H__
  68
  69 /***********************************************************************
  70  * debug stuff
  71  *
  72  * The DFPRINTF macro will call fprintf if PCODE_DEBUG is defined.
  73  * The macro is used like:
  74  *
  75  * DPRINTF(("%s #%d\n","test", 1));
  76  *
  77  * The double parenthesis (()) are necessary
  78  *
  79  ***********************************************************************/
  80 //#define PCODE_DEBUG
  81
  82 #ifdef PCODE_DEBUG
  83 #define DFPRINTF(args) (fprintf args)
  84 #else
  85 #define DFPRINTF(args) ;
  86 #endif
  87
  88
  89 /***********************************************************************
  90  *  PIC status bits - this will move into device dependent headers
  91  ***********************************************************************/
  92 #define PIC_C_BIT    0
  93 #define PIC_DC_BIT   1
  94 #define PIC_Z_BIT    2
  95 #define PIC_OV_BIT   3
  96 #define PIC_N_BIT    4
  97 #define PIC_IRP_BIT  7   /* Indirect register page select */
  98
  99 /***********************************************************************
 100  *  PIC INTCON bits - this will move into device dependent headers
 101  ***********************************************************************/
 102 #define PIC_RBIF_BIT 0   /* Port B level has changed flag */
 103 #define PIC_INTF_BIT 1   /* Port B bit 0 interrupt on edge flag */
 104 #define PIC_T0IF_BIT 2   /* TMR0 has overflowed flag */
 105 #define PIC_RBIE_BIT 3   /* Port B level has changed - Interrupt Enable */
 106 #define PIC_INTE_BIT 4   /* Port B bit 0 interrupt on edge - Int Enable */
 107 #define PIC_T0IE_BIT 5   /* TMR0 overflow Interrupt Enable */
 108 #define PIC_PIE_BIT  6   /* Peripheral Interrupt Enable */
 109 #define PIC_GIE_BIT  7   /* Global Interrupt Enable */
 110
 111 /***********************************************************************
 112  *  PIC bank definitions
 113  ***********************************************************************/
 114 #define PIC_BANK_FIRST 0
 115 #define PIC_BANK_LAST  0xf
 116
 117
 118 /***********************************************************************
 119  *  Operand types
 120  ***********************************************************************/
 121 #define POT_RESULT  0
 122 #define POT_LEFT    1
 123 #define POT_RIGHT   2
 124
 125
 126 /***********************************************************************
 127  *
 128  *  PIC_OPTYPE - Operand types that are specific to the PIC architecture
 129  *
 130  *  If a PIC assembly instruction has an operand then here is where we
 131  *  associate a type to it. For example,
 132  *
 133  *     movf    reg,W
 134  *
 135  *  The movf has two operands: 'reg' and the W register. 'reg' is some
 136  *  arbitrary general purpose register, hence it has the type PO_GPR_REGISTER.
 137  *  The W register, which is the PIC's accumulator, has the type PO_W.
 138  *
 139  ***********************************************************************/
 140
 141
 142
 143 typedef enum
 144 {
 145   PO_NONE=0,         // No operand e.g. NOP
 146   PO_W,              // The working register (as a destination)
 147   PO_WREG,           // The working register (as a file register)
 148   PO_STATUS,         // The 'STATUS' register
 149   PO_BSR,            // The 'BSR' register
 150   PO_FSR0,           // The "file select register" (in PIC18 family it's one
 151                      // of three)
 152   PO_INDF0,          // The Indirect register
 153   PO_INTCON,         // Interrupt Control register
 154   PO_GPR_REGISTER,   // A general purpose register
 155   PO_GPR_BIT,        // A bit of a general purpose register
 156   PO_GPR_TEMP,       // A general purpose temporary register
 157   PO_SFR_REGISTER,   // A special function register (e.g. PORTA)
 158   PO_PCL,            // Program counter Low register
 159   PO_PCLATH,         // Program counter Latch high register
 160   PO_PCLATU,         // Program counter Latch upper register
 161   PO_PRODL,          // Product Register Low
 162   PO_PRODH,          // Product Register High
 163   PO_LITERAL,        // A constant
 164   PO_REL_ADDR,       // A relative address
 165   PO_IMMEDIATE,      //  (8051 legacy)
 166   PO_DIR,            // Direct memory (8051 legacy)
 167   PO_CRY,            // bit memory (8051 legacy)
 168   PO_BIT,            // bit operand.
 169   PO_STR,            //  (8051 legacy)
 170   PO_LABEL,
 171   PO_WILD            // Wild card operand in peep optimizer
 172 } PIC_OPTYPE;
 173
 174
 175 /***********************************************************************
 176  *
 177  *  PIC_OPCODE
 178  *
 179  *  This is not a list of the PIC's opcodes per se, but instead
 180  *  an enumeration of all of the different types of pic opcodes.
 181  *
 182  ***********************************************************************/
 183
 184 typedef enum
 185 {
 186   POC_WILD=-1,   /* Wild card - used in the pCode peep hole optimizer
 187                   * to represent ANY pic opcode */
 188   POC_ADDLW=0,
 189   POC_ADDWF,
 190   POC_ADDFW,
 191   POC_ADDFWC,
 192   POC_ADDWFC,
 193   POC_ANDLW,
 194   POC_ANDWF,
 195   POC_ANDFW,
 196   POC_BC,
 197   POC_BCF,
 198   POC_BN,
 199   POC_BNC,
 200   POC_BNN,
 201   POC_BNOV,
 202   POC_BNZ,
 203   POC_BOV,
 204   POC_BRA,
 205   POC_BSF,
 206   POC_BTFSC,
 207   POC_BTFSS,
 208   POC_BTG,
 209   POC_BZ,
 210   POC_CALL,
 211   POC_CLRF,
 212   POC_CLRWDT,
 213   POC_COMF,
 214   POC_COMFW,
 215   POC_CPFSEQ,
 216   POC_CPFSGT,
 217   POC_CPFSLT,
 218   POC_DAW,
 219   POC_DCFSNZ,
 220   POC_DCFSNZW,
 221   POC_DECF,
 222   POC_DECFW,
 223   POC_DECFSZ,
 224   POC_DECFSZW,
 225   POC_GOTO,
 226   POC_INCF,
 227   POC_INCFW,
 228   POC_INCFSZ,
 229   POC_INCFSZW,
 230   POC_INFSNZ,
 231   POC_IORWF,
 232   POC_IORFW,
 233   POC_IORLW,
 234   POC_LFSR,
 235   POC_MOVF,
 236   POC_MOVFW,
 237   POC_MOVFF,
 238   POC_MOVLB,
 239   POC_MOVLW,
 240   POC_MOVWF,
 241   POC_MULLW,
 242   POC_MULWF,
 243   POC_NEGF,
 244   POC_NOP,
 245   POC_POP,
 246   POC_PUSH,
 247   POC_RCALL,
 248   POC_RETFIE,
 249   POC_RETLW,
 250   POC_RETURN,
 251   POC_RLCF,
 252   POC_RLCFW,
 253   POC_RLNCF,
 254   POC_RLNCFW,
 255   POC_RRCF,
 256   POC_RRCFW,
 257   POC_RRNCF,
 258   POC_RRNCFW,
 259   POC_SETF,
 260   POC_SUBLW,
 261   POC_SUBFWB,
 262   POC_SUBWF,
 263   POC_SUBFW,
 264   POC_SUBWFB_D0,
 265   POC_SUBWFB_D1,
 266   POC_SUBFWB_D0,
 267   POC_SUBFWB_D1,
 268   POC_SWAPF,
 269   POC_SWAPFW,
 270 //  POC_TRIS , // To be removed
 271   POC_TBLRD,            // patch 15
 272   POC_TBLRD_POSTINC,    //
 273   POC_TBLRD_POSTDEC,    //
 274   POC_TBLRD_PREINC,     //
 275   POC_TBLWT,            //
 276   POC_TBLWT_POSTINC,    //
 277   POC_TBLWT_POSTDEC,    //
 278   POC_TBLWT_PREINC,     // patch 15
 279   POC_TSTFSZ,
 280   POC_XORLW,
 281   POC_XORWF,
 282   POC_XORFW
 283 } PIC_OPCODE;
 284
 285
 286 /***********************************************************************
 287  *  PC_TYPE  - pCode Types
 288  ***********************************************************************/
 289
 290 typedef enum
 291 {
 292   PC_COMMENT=0,   /* pCode is a comment     */
 293   PC_INLINE,      /* user's inline code     */
 294   PC_OPCODE,      /* PORT dependent opcode  */
 295   PC_LABEL,       /* assembly label         */
 296   PC_FLOW,        /* flow analysis          */
 297   PC_FUNCTION,    /* Function start or end  */
 298   PC_WILD,        /* wildcard - an opcode place holder used
 299                    * in the pCode peep hole optimizer */
 300   PC_CSOURCE,     /* C-Source Line  */
 301   PC_ASMDIR,      /* Assembler directive */
 302   PC_BAD          /* Mark the pCode object as being bad */
 303 } PC_TYPE;
 304
 305 /************************************************/
 306 /***************  Structures ********************/
 307 /************************************************/
 308 /* These are here as forward references - the
 309  * full definition of these are below           */
 310 struct pCode;
 311 struct pCodeWildBlock;
 312 struct pCodeRegLives;
 313
 314 /*************************************************
 315   pBranch
 316
 317   The first step in optimizing pCode is determining
 318  the program flow. This information is stored in
 319  single-linked lists in the for of 'from' and 'to'
 320  objects with in a pcode. For example, most instructions
 321  don't involve any branching. So their from branch
 322  points to the pCode immediately preceding them and
 323  their 'to' branch points to the pcode immediately
 324  following them. A skip instruction is an example of
 325  a pcode that has multiple (in this case two) elements
 326  in the 'to' branch. A 'label' pcode is an where there
 327  may be multiple 'from' branches.
 328  *************************************************/
 329
 330 typedef struct pBranch
 331 {
 332   struct pCode   *pc;    // Next pCode in a branch
 333   struct pBranch *next;  /* If more than one branch
 334                           * the next one is here */
 335
 336 } pBranch;
 337
 338 /*************************************************
 339   pCodeOp
 340
 341   pCode Operand structure.
 342   For those assembly instructions that have arguments,
 343   the pCode will have a pCodeOp in which the argument
 344   can be stored. For example
 345
 346     movf   some_register,w
 347
 348   'some_register' will be stored/referenced in a pCodeOp
 349
 350  *************************************************/
 351
 352 typedef struct pCodeOp
 353 {
 354   PIC_OPTYPE type;
 355   char *name;
 356
 357 } pCodeOp;
 358
 359 #if 0
 360 typedef struct pCodeOpBit
 361 {
 362   pCodeOp pcop;
 363   int bit;
 364   unsigned int inBitSpace: 1; /* True if in bit space, else
 365                                  just a bit of a register */
 366 } pCodeOpBit;
 367 #endif
 368 typedef struct pCodeOpLit
 369 {
 370   pCodeOp pcop;
 371   int lit;
 372 } pCodeOpLit;
 373
 374 typedef struct pCodeOpLit2
 375 {
 376   pCodeOp pcop;
 377   int lit;
 378   pCodeOp *arg2;
 379 } pCodeOpLit2;
 380
 381
 382 typedef struct pCodeOpImmd
 383 {
 384   pCodeOp pcop;
 385   int offset;           /* low,high or upper byte of immediate value */
 386   int index;            /* add this to the immediate value */
 387   unsigned _const:1;    /* is in code space    */
 388
 389   int rIdx;             /* If this immd points to a register */
 390   struct regs *r;       /* then this is the reg. */
 391
 392 } pCodeOpImmd;
 393
 394 typedef struct pCodeOpLabel
 395 {
 396   pCodeOp pcop;
 397   int key;
 398 } pCodeOpLabel;
 399
 400 typedef struct pCodeOpReg
 401 {
 402   pCodeOp pcop;    // Can be either GPR or SFR
 403   int rIdx;        // Index into the register table
 404   struct regs *r;
 405   int instance;    // byte # of Multi-byte registers
 406   struct pBlock *pb;
 407 } pCodeOpReg;
 408
 409 typedef struct pCodeOpReg2
 410 {
 411   pCodeOp pcop;         // used by default to all references
 412   int rIdx;
 413   struct regs *r;
 414   int instance;         // assume same instance for both operands
 415   struct pBlock *pb;
 416
 417   pCodeOp *pcop2;       // second memory operand
 418 } pCodeOpReg2;
 419
 420 typedef struct pCodeOpRegBit
 421 {
 422   pCodeOpReg  pcor;       // The Register containing this bit
 423   int bit;                // 0-7 bit number.
 424   PIC_OPTYPE subtype;     // The type of this register.
 425   unsigned int inBitSpace: 1; /* True if in bit space, else
 426                                  just a bit of a register */
 427 } pCodeOpRegBit;
 428
 429
 430 typedef struct pCodeOpWild
 431 {
 432   pCodeOp pcop;
 433
 434   struct pCodeWildBlock *pcwb;
 435
 436   int id;                 /* index into an array of char *'s that will match
 437                            * the wild card. The array is in *pcp. */
 438   pCodeOp *subtype;       /* Pointer to the Operand type into which this wild
 439                            * card will be expanded */
 440   pCodeOp *matched;       /* When a wild matches, we'll store a pointer to the
 441                            * opcode we matched */
 442
 443 } pCodeOpWild;
 444
 445
 446 /*************************************************
 447     pCode
 448
 449     Here is the basic build block of a PIC instruction.
 450     Each pic instruction will get allocated a pCode.
 451     A linked list of pCodes makes a program.
 452
 453 **************************************************/
 454
 455 typedef struct pCode
 456 {
 457   PC_TYPE    type;
 458
 459   struct pCode *prev;  // The pCode objects are linked together
 460   struct pCode *next;  // in doubly linked lists.
 461
 462   int seq;             // sequence number
 463
 464   struct pBlock *pb;   // The pBlock that contains this pCode.
 465
 466   /* "virtual functions"
 467    *  The pCode structure is like a base class
 468    * in C++. The subsequent structures that "inherit"
 469    * the pCode structure will initialize these function
 470    * pointers to something useful */
 471   //  void (*analyze) (struct pCode *_this);
 472   void (*destruct)(struct pCode *_this);
 473   void (*print)  (FILE *of,struct pCode *_this);
 474
 475 } pCode;
 476
 477
 478 /*************************************************
 479     pCodeComment
 480 **************************************************/
 481
 482 typedef struct pCodeComment
 483 {
 484
 485   pCode  pc;
 486
 487   char *comment;
 488
 489 } pCodeComment;
 490
 491
 492 /*************************************************
 493     pCodeCSource
 494 **************************************************/
 495
 496 typedef struct pCodeCSource
 497 {
 498
 499   pCode  pc;
 500
 501   int  line_number;
 502   char *line;
 503   char *file_name;
 504
 505 } pCodeCSource;
 506
 507
 508 /*************************************************
 509     pCodeAsmDir
 510 **************************************************/
 511
 512 /*************************************************
 513     pCodeFlow
 514
 515   The Flow object is used as marker to separate
 516  the assembly code into contiguous chunks. In other
 517  words, everytime an instruction cause or potentially
 518  causes a branch, a Flow object will be inserted into
 519  the pCode chain to mark the beginning of the next
 520  contiguous chunk.
 521
 522 **************************************************/
 523
 524 typedef struct pCodeFlow
 525 {
 526
 527   pCode  pc;
 528
 529   pCode *end;   /* Last pCode in this flow. Note that
 530                    the first pCode is pc.next */
 531
 532   /*  set **uses;   * map the pCode instruction inCond and outCond conditions
 533                  * in this array of set's. The reason we allocate an
 534                  * array of pointers instead of declaring each type of
 535                  * usage is because there are port dependent usage definitions */
 536   //int nuses;    /* number of uses sets */
 537
 538   set *from;    /* flow blocks that can send control to this flow block */
 539   set *to;      /* flow blocks to which this one can send control */
 540   struct pCodeFlow *ancestor; /* The most immediate "single" pCodeFlow object that
 541                                * executes prior to this one. In many cases, this
 542                                * will be just the previous */
 543
 544   int inCond;   /* Input conditions - stuff assumed defined at entry */
 545   int outCond;  /* Output conditions - stuff modified by flow block */
 546
 547   int firstBank; /* The first and last bank flags are the first and last */
 548   int lastBank;  /* register banks used within one flow object */
 549
 550   int FromConflicts;
 551   int ToConflicts;
 552
 553   set *registers;/* Registers used in this flow */
 554
 555 } pCodeFlow;
 556
 557 /*************************************************
 558   pCodeFlowLink
 559
 560   The Flow Link object is used to record information
 561  about how consecutive excutive Flow objects are related.
 562  The pCodeFlow objects demarcate the pCodeInstructions
 563  into contiguous chunks. The FlowLink records conflicts
 564  in the discontinuities. For example, if one Flow object
 565  references a register in bank 0 and the next Flow object
 566  references a register in bank 1, then there is a discontinuity
 567  in the banking registers.
 568
 569 */
 570 typedef struct pCodeFlowLink
 571 {
 572   pCodeFlow  *pcflow;   /* pointer to linked pCodeFlow object */
 573
 574   int bank_conflict;    /* records bank conflicts */
 575
 576 } pCodeFlowLink;
 577
 578 /*************************************************
 579     pCodeInstruction
 580
 581     Here we describe all the facets of a PIC instruction
 582     (expansion for the 18cxxx is also provided).
 583
 584 **************************************************/
 585
 586 typedef struct pCodeInstruction
 587 {
 588
 589   pCode  pc;
 590
 591   PIC_OPCODE op;        // The opcode of the instruction.
 592
 593   char const * const mnemonic;       // Pointer to mnemonic string
 594
 595   pBranch *from;       // pCodes that execute before this one
 596   pBranch *to;         // pCodes that execute after
 597   pBranch *label;      // pCode instructions that have labels
 598
 599   pCodeOp *pcop;               /* Operand, if this instruction has one */
 600   pCodeFlow *pcflow;           /* flow block to which this instruction belongs */
 601   pCodeCSource *cline;         /* C Source from which this instruction was derived */
 602
 603   unsigned int num_ops;        /* Number of operands (0,1,2 for mid range pics) */
 604   unsigned int isModReg:  1;   /* If destination is W or F, then 1==F */
 605   unsigned int isBitInst: 1;   /* e.g. BCF */
 606   unsigned int isBranch:  1;   /* True if this is a branching instruction */
 607   unsigned int isSkip:    1;   /* True if this is a skip instruction */
 608   unsigned int isLit:     1;   /* True if this instruction has an literal operand */
 609   unsigned int isAccess:   1;   /* True if this instruction has an access RAM operand */
 610   unsigned int isFastCall: 1;   /* True if this instruction has a fast call/return mode select operand */
 611   unsigned int is2MemOp: 1;     /* True is second operand is a memory operand VR - support for MOVFF */
 612   unsigned int is2LitOp: 1;     /* True if instruction takes 2 literal operands VR - support for LFSR */
 613
 614   PIC_OPCODE inverted_op;      /* Opcode of instruction that's the opposite of this one */
 615   unsigned int inCond;   // Input conditions for this instruction
 616   unsigned int outCond;  // Output conditions for this instruction
 617
 618 #define PCI_MAGIC       0x6e12
 619   unsigned int pci_magic;       // sanity check for pci initialization
 620 } pCodeInstruction;
 621
 622
 623
 624 /*************************************************
 625     pCodeAsmDir
 626 **************************************************/
 627
 628 typedef struct pCodeAsmDir
 629 {
 630   pCodeInstruction pci;
 631
 632   char *directive;
 633   char *arg;
 634 } pCodeAsmDir;
 635
 636
 637 /*************************************************
 638     pCodeLabel
 639 **************************************************/
 640
 641 typedef struct pCodeLabel
 642 {
 643
 644   pCode  pc;
 645
 646   char *label;
 647   int key;
 648
 649 } pCodeLabel;
 650
 651 /*************************************************
 652     pCodeFunction
 653 **************************************************/
 654
 655 typedef struct pCodeFunction
 656 {
 657
 658   pCode  pc;
 659
 660   char *modname;
 661   char *fname;     /* If NULL, then this is the end of
 662                       a function. Otherwise, it's the
 663                       start and the name is contained
 664                       here */
 665
 666   pBranch *from;       // pCodes that execute before this one
 667   pBranch *to;         // pCodes that execute after
 668   pBranch *label;      // pCode instructions that have labels
 669
 670   int  ncalled;    /* Number of times function is called */
 671
 672 } pCodeFunction;
 673
 674
 675 /*************************************************
 676     pCodeWild
 677 **************************************************/
 678
 679 typedef struct pCodeWild
 680 {
 681
 682   pCodeInstruction  pci;
 683
 684   int    id;     /* Index into the wild card array of a peepBlock
 685                   * - this wild card will get expanded into that pCode
 686                   *   that is stored at this index */
 687
 688   /* Conditions on wild pcode instruction */
 689   int    mustBeBitSkipInst:1;
 690   int    mustNotBeBitSkipInst:1;
 691   int    invertBitSkipInst:1;
 692
 693   pCodeOp *operand;  // Optional operand
 694   pCodeOp *label;    // Optional label
 695
 696 } pCodeWild;
 697
 698 /*************************************************
 699     pBlock
 700
 701     Here are PIC program snippets. There's a strong
 702     correlation between the eBBlocks and pBlocks.
 703     SDCC subdivides a C program into managable chunks.
 704     Each chunk becomes a eBBlock and ultimately in the
 705     PIC port a pBlock.
 706
 707 **************************************************/
 708
 709 typedef struct pBlock
 710 {
 711   memmap *cmemmap;   /* The snippet is from this memmap */
 712   char   dbName;     /* if cmemmap is NULL, then dbName will identify the block */
 713   pCode *pcHead;     /* A pointer to the first pCode in a link list of pCodes */
 714   pCode *pcTail;     /* A pointer to the last pCode in a link list of pCodes */
 715
 716   struct pBlock *next;      /* The pBlocks will form a doubly linked list */
 717   struct pBlock *prev;
 718
 719   set *function_entries;    /* dll of functions in this pblock */
 720   set *function_exits;
 721   set *function_calls;
 722   set *tregisters;
 723
 724   set *FlowTree;
 725   unsigned visited:1;       /* set true if traversed in call tree */
 726
 727   unsigned seq;             /* sequence number of this pBlock */
 728
 729 } pBlock;
 730
 731 /*************************************************
 732     pFile
 733
 734     The collection of pBlock program snippets are
 735     placed into a linked list that is implemented
 736     in the pFile structure.
 737
 738     The pcode optimizer will parse the pFile.
 739
 740 **************************************************/
 741
 742 typedef struct pFile
 743 {
 744   pBlock *pbHead;     /* A pointer to the first pBlock */
 745   pBlock *pbTail;     /* A pointer to the last pBlock */
 746
 747   pBranch *functions; /* A SLL of functions in this pFile */
 748
 749 } pFile;
 750
 751
 752
 753 /*************************************************
 754   pCodeWildBlock
 755
 756   The pCodeWildBlock object keeps track of the wild
 757   variables, operands, and opcodes that exist in
 758   a pBlock.
 759 **************************************************/
 760 typedef struct pCodeWildBlock {
 761   pBlock    *pb;
 762   struct pCodePeep *pcp;    // pointer back to ... I don't like this...
 763
 764   int       nvars;          // Number of wildcard registers in target.
 765   char    **vars;           // array of pointers to them
 766
 767   int       nops;           // Number of wildcard operands in target.
 768   pCodeOp **wildpCodeOps;   // array of pointers to the pCodeOp's.
 769
 770   int       nwildpCodes;    // Number of wildcard pCodes in target/replace
 771   pCode   **wildpCodes;     // array of pointers to the pCode's.
 772
 773 } pCodeWildBlock;
 774
 775 /*************************************************
 776   pCodePeep
 777
 778   The pCodePeep object mimics the peep hole optimizer
 779   in the main SDCC src (e.g. SDCCpeeph.c). Essentially
 780   there is a target pCode chain and a replacement
 781   pCode chain. The target chain is compared to the
 782   pCode that is generated by gen.c. If a match is
 783   found then the pCode is replaced by the replacement
 784   pCode chain.
 785 **************************************************/
 786 typedef struct pCodePeep {
 787   pCodeWildBlock target;     // code we'd like to optimize
 788   pCodeWildBlock replace;    // and this is what we'll optimize it with.
 789
 790   //pBlock *target;
 791   //pBlock replace;            // and this is what we'll optimize it with.
 792
 793
 794
 795   /* (Note: a wildcard register is a place holder. Any register
 796    * can be replaced by the wildcard when the pcode is being
 797    * compared to the target. */
 798
 799   /* Post Conditions. A post condition is a condition that
 800    * must be either true or false before the peep rule is
 801    * accepted. For example, a certain rule may be accepted
 802    * if and only if the Z-bit is not used as an input to
 803    * the subsequent instructions in a pCode chain.
 804    */
 805   unsigned int postFalseCond;
 806   unsigned int postTrueCond;
 807
 808 } pCodePeep;
 809
 810 /*************************************************
 811
 812   pCode peep command definitions
 813
 814  Here are some special commands that control the
 815 way the peep hole optimizer behaves
 816
 817 **************************************************/
 818
 819 enum peepCommandTypes{
 820   NOTBITSKIP = 0,
 821   BITSKIP,
 822   INVERTBITSKIP,
 823   _LAST_PEEP_COMMAND_
 824 };
 825
 826 /*************************************************
 827     peepCommand structure stores the peep commands.
 828
 829 **************************************************/
 830
 831 typedef struct peepCommand {
 832   int id;
 833   char *cmd;
 834 } peepCommand;
 835
 836 /*************************************************
 837     pCode Macros
 838
 839 **************************************************/
 840 #define PCODE(x)  ((pCode *)(x))
 841 #define PCI(x)    ((pCodeInstruction *)(x))
 842 #define PCL(x)    ((pCodeLabel *)(x))
 843 #define PCF(x)    ((pCodeFunction *)(x))
 844 #define PCFL(x)   ((pCodeFlow *)(x))
 845 #define PCFLINK(x)((pCodeFlowLink *)(x))
 846 #define PCW(x)    ((pCodeWild *)(x))
 847 #define PCCS(x)   ((pCodeCSource *)(x))
 848 #define PCAD(x)   ((pCodeAsmDir *)(x))
 849
 850 #define PCOP(x)   ((pCodeOp *)(x))
 851 //#define PCOB(x)   ((pCodeOpBit *)(x))
 852 #define PCOL(x)   ((pCodeOpLit *)(x))
 853 #define PCOI(x)   ((pCodeOpImmd *)(x))
 854 #define PCOLAB(x) ((pCodeOpLabel *)(x))
 855 #define PCOR(x)   ((pCodeOpReg *)(x))
 856 #define PCOR2(x)  ((pCodeOpReg2 *)(x))
 857 #define PCORB(x)  ((pCodeOpRegBit *)(x))
 858 #define PCOW(x)   ((pCodeOpWild *)(x))
 859
 860 #define PBR(x)    ((pBranch *)(x))
 861
 862 #define PCWB(x)   ((pCodeWildBlock *)(x))
 863
 864
 865 /*
 866   macros for checking pCode types
 867 */
 868 #define isPCI(x)        ((PCODE(x)->type == PC_OPCODE))
 869 #define isPCI_BRANCH(x) ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isBranch)
 870 #define isPCI_SKIP(x)   ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip)
 871 #define isPCI_LIT(x)    ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isLit)
 872 #define isPCI_BITSKIP(x)((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip && PCI(x)->isBitInst)
 873 #define isPCFL(x)       ((PCODE(x)->type == PC_FLOW))
 874 #define isPCF(x)        ((PCODE(x)->type == PC_FUNCTION))
 875 #define isPCL(x)        ((PCODE(x)->type == PC_LABEL))
 876 #define isPCW(x)        ((PCODE(x)->type == PC_WILD))
 877 #define isPCCS(x)       ((PCODE(x)->type == PC_CSOURCE))
 878 #define isASMDIR(x)     ((PCODE(x)->type == PC_ASMDIR))
 879
 880 #define isCALL(x)       ((isPCI(x)) && (PCI(x)->op == POC_CALL))
 881 #define isSTATUS_REG(r) ((r)->pc_type == PO_STATUS)
 882 #define isBSR_REG(r)    ((r)->pc_type == PO_BSR)
 883 #define isACCESS_BANK(r)        (r->accessBank)
 884
 885
 886
 887 #define isPCOLAB(x)     ((PCOP(x)->type) == PO_LABEL)
 888
 889 /*-----------------------------------------------------------------*
 890  * pCode functions.
 891  *-----------------------------------------------------------------*/
 892
 893 pCode *pic16_newpCode (PIC_OPCODE op, pCodeOp *pcop); // Create a new pCode given an operand
 894 pCode *pic16_newpCodeCharP(char *cP);              // Create a new pCode given a char *
 895 pCode *pic16_newpCodeInlineP(char *cP);            // Create a new pCode given a char *
 896 pCode *pic16_newpCodeFunction(char *g, char *f);   // Create a new function
 897 pCode *pic16_newpCodeLabel(char *name,int key);    // Create a new label given a key
 898 pCode *pic16_newpCodeCSource(int ln, char *f, char *l); // Create a new symbol line
 899 pBlock *pic16_newpCodeChain(memmap *cm,char c, pCode *pc); // Create a new pBlock
 900 void pic16_printpBlock(FILE *of, pBlock *pb);      // Write a pBlock to a file
 901 void pic16_addpCode2pBlock(pBlock *pb, pCode *pc); // Add a pCode to a pBlock
 902 void pic16_addpBlock(pBlock *pb);                  // Add a pBlock to a pFile
 903 void pic16_copypCode(FILE *of, char dbName);       // Write all pBlocks with dbName to *of
 904 void pic16_movepBlock2Head(char dbName);           // move pBlocks around
 905 void pic16_AnalyzepCode(char dbName);
 906 void pic16_AssignRegBanks(void);
 907 void pic16_printCallTree(FILE *of);
 908 void pCodePeepInit(void);
 909 void pic16_pBlockConvert2ISR(pBlock *pb);
 910 void pic16_pBlockConvert2Absolute(pBlock *pb);
 911 void pic16_emitDB(pBlock *pb, char c);            // Add DB directives to a pBlock
 912 void pic16_flushDB(pBlock *pb);                   // Add pending DB data to a pBlock
 913
 914 pCode *pic16_newpCodeAsmDir(char *asdir, char *argfmt, ...);
 915
 916 pCodeOp *pic16_newpCodeOpLabel(char *name, int key);
 917 pCodeOp *pic16_newpCodeOpImmd(char *name, int offset, int index, int code_space);
 918 pCodeOp *pic16_newpCodeOpLit(int lit);
 919 pCodeOp *pic16_newpCodeOpLit2(int lit, pCodeOp *arg2);
 920 pCodeOp *pic16_newpCodeOpBit(char *name, int bit,int inBitSpace);
 921 pCodeOp *pic16_newpCodeOpRegFromStr(char *name);
 922 pCodeOp *pic16_newpCodeOp(char *name, PIC_OPTYPE p);
 923 pCodeOp *pic16_pCodeOpCopy(pCodeOp *pcop);
 924
 925 pCode * pic16_findNextInstruction(pCode *pci);
 926 pCode * pic16_findNextpCode(pCode *pc, PC_TYPE pct);
 927 int pic16_isPCinFlow(pCode *pc, pCode *pcflow);
 928 struct regs * pic16_getRegFromInstruction(pCode *pc);
 929 struct regs * pic16_getRegFromInstruction2(pCode *pc);
 930
 931 extern void pic16_pcode_test(void);
 932 extern int pic16_debug_verbose;
 933 extern int pic16_pcode_verbose;
 934
 935 /*-----------------------------------------------------------------*
 936  * pCode objects.
 937  *-----------------------------------------------------------------*/
 938
 939 extern pCodeOpReg pic16_pc_status;
 940 extern pCodeOpReg pic16_pc_intcon;
 941 extern pCodeOpReg pic16_pc_pcl;
 942 extern pCodeOpReg pic16_pc_pclath;
 943 extern pCodeOpReg pic16_pc_pclatu; // patch 14
 944 extern pCodeOpReg pic16_pc_wreg;
 945 extern pCodeOpReg pic16_pc_tosl; // patch 14
 946 extern pCodeOpReg pic16_pc_tosh; // patch 14
 947 extern pCodeOpReg pic16_pc_tosu; // patch 14
 948 extern pCodeOpReg pic16_pc_tblptrl; // patch 15
 949 extern pCodeOpReg pic16_pc_tblptrh; //
 950 extern pCodeOpReg pic16_pc_tblptru; //
 951 extern pCodeOpReg pic16_pc_tablat;  // patch 15
 952 extern pCodeOpReg pic16_pc_bsr;
 953 extern pCodeOpReg pic16_pc_fsr0;
 954 extern pCodeOpReg pic16_pc_fsr0l;
 955 extern pCodeOpReg pic16_pc_fsr0h;
 956 extern pCodeOpReg pic16_pc_fsr1l;
 957 extern pCodeOpReg pic16_pc_fsr1h;
 958 extern pCodeOpReg pic16_pc_fsr2l;
 959 extern pCodeOpReg pic16_pc_fsr2h;
 960 extern pCodeOpReg pic16_pc_indf0;
 961 extern pCodeOpReg pic16_pc_postinc0;
 962 extern pCodeOpReg pic16_pc_postdec0;
 963 extern pCodeOpReg pic16_pc_preinc0;
 964 extern pCodeOpReg pic16_pc_plusw0;
 965 extern pCodeOpReg pic16_pc_indf1;
 966 extern pCodeOpReg pic16_pc_postinc1;
 967 extern pCodeOpReg pic16_pc_postdec1;
 968 extern pCodeOpReg pic16_pc_preinc1;
 969 extern pCodeOpReg pic16_pc_plusw1;
 970 extern pCodeOpReg pic16_pc_indf2;
 971 extern pCodeOpReg pic16_pc_postinc2;
 972 extern pCodeOpReg pic16_pc_postdec2;
 973 extern pCodeOpReg pic16_pc_preinc2;
 974 extern pCodeOpReg pic16_pc_plusw2;
 975 extern pCodeOpReg pic16_pc_prodl;
 976 extern pCodeOpReg pic16_pc_prodh;
 977
 978 extern pCodeOpReg pic16_pc_kzero;
 979 extern pCodeOpReg pic16_pc_wsave;     /* wsave and ssave are used to save W and the Status */
 980 extern pCodeOpReg pic16_pc_ssave;     /* registers during an interrupt */
 981
 982
 983 #endif // __PCODE_H__