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_TBLRD,
 271   POC_TBLRD_POSTINC,
 272   POC_TBLRD_POSTDEC,
 273   POC_TBLRD_PREINC,
 274   POC_TBLWT,
 275   POC_TBLWT_POSTINC,
 276   POC_TBLWT_POSTDEC,
 277   POC_TBLWT_PREINC,
 278   POC_TSTFSZ,
 279   POC_XORLW,
 280   POC_XORWF,
 281   POC_XORFW,
 282
 283   POC_BANKSEL
 284 } PIC_OPCODE;
 285
 286
 287 /***********************************************************************
 288  *  PC_TYPE  - pCode Types
 289  ***********************************************************************/
 290
 291 typedef enum
 292 {
 293   PC_COMMENT=0,   /* pCode is a comment     */
 294   PC_INLINE,      /* user's inline code     */
 295   PC_OPCODE,      /* PORT dependent opcode  */
 296   PC_LABEL,       /* assembly label         */
 297   PC_FLOW,        /* flow analysis          */
 298   PC_FUNCTION,    /* Function start or end  */
 299   PC_WILD,        /* wildcard - an opcode place holder used
 300                    * in the pCode peep hole optimizer */
 301   PC_CSOURCE,     /* C-Source Line  */
 302   PC_ASMDIR,      /* Assembler directive */
 303   PC_BAD          /* Mark the pCode object as being bad */
 304 } PC_TYPE;
 305
 306 /************************************************/
 307 /***************  Structures ********************/
 308 /************************************************/
 309 /* These are here as forward references - the
 310  * full definition of these are below           */
 311 struct pCode;
 312 struct pCodeWildBlock;
 313 struct pCodeRegLives;
 314
 315 /*************************************************
 316   pBranch
 317
 318   The first step in optimizing pCode is determining
 319  the program flow. This information is stored in
 320  single-linked lists in the for of 'from' and 'to'
 321  objects with in a pcode. For example, most instructions
 322  don't involve any branching. So their from branch
 323  points to the pCode immediately preceding them and
 324  their 'to' branch points to the pcode immediately
 325  following them. A skip instruction is an example of
 326  a pcode that has multiple (in this case two) elements
 327  in the 'to' branch. A 'label' pcode is an where there
 328  may be multiple 'from' branches.
 329  *************************************************/
 330
 331 typedef struct pBranch
 332 {
 333   struct pCode   *pc;    // Next pCode in a branch
 334   struct pBranch *next;  /* If more than one branch
 335                           * the next one is here */
 336
 337 } pBranch;
 338
 339 /*************************************************
 340   pCodeOp
 341
 342   pCode Operand structure.
 343   For those assembly instructions that have arguments,
 344   the pCode will have a pCodeOp in which the argument
 345   can be stored. For example
 346
 347     movf   some_register,w
 348
 349   'some_register' will be stored/referenced in a pCodeOp
 350
 351  *************************************************/
 352
 353 typedef struct pCodeOp
 354 {
 355   PIC_OPTYPE type;
 356   char *name;
 357
 358 } pCodeOp;
 359
 360 #if 0
 361 typedef struct pCodeOpBit
 362 {
 363   pCodeOp pcop;
 364   int bit;
 365   unsigned int inBitSpace: 1; /* True if in bit space, else
 366                                  just a bit of a register */
 367 } pCodeOpBit;
 368 #endif
 369 typedef struct pCodeOpLit
 370 {
 371   pCodeOp pcop;
 372   int lit;
 373 } pCodeOpLit;
 374
 375 typedef struct pCodeOpLit2
 376 {
 377   pCodeOp pcop;
 378   int lit;
 379   pCodeOp *arg2;
 380 } pCodeOpLit2;
 381
 382
 383 typedef struct pCodeOpImmd
 384 {
 385   pCodeOp pcop;
 386   int offset;           /* low,high or upper byte of immediate value */
 387   int index;            /* add this to the immediate value */
 388   unsigned _const:1;    /* is in code space    */
 389
 390   int rIdx;             /* If this immd points to a register */
 391   struct regs *r;       /* then this is the reg. */
 392
 393 } pCodeOpImmd;
 394
 395 typedef struct pCodeOpLabel
 396 {
 397   pCodeOp pcop;
 398   int key;
 399 } pCodeOpLabel;
 400
 401 typedef struct pCodeOpReg
 402 {
 403   pCodeOp pcop;    // Can be either GPR or SFR
 404   int rIdx;        // Index into the register table
 405   struct regs *r;
 406   int instance;    // byte # of Multi-byte registers
 407   struct pBlock *pb;
 408 } pCodeOpReg;
 409
 410 typedef struct pCodeOpReg2
 411 {
 412   pCodeOp pcop;         // used by default to all references
 413   int rIdx;
 414   struct regs *r;
 415   int instance;         // assume same instance for both operands
 416   struct pBlock *pb;
 417
 418   pCodeOp *pcop2;       // second memory operand
 419 } pCodeOpReg2;
 420
 421 typedef struct pCodeOpRegBit
 422 {
 423   pCodeOpReg  pcor;       // The Register containing this bit
 424   int bit;                // 0-7 bit number.
 425   PIC_OPTYPE subtype;     // The type of this register.
 426   unsigned int inBitSpace: 1; /* True if in bit space, else
 427                                  just a bit of a register */
 428 } pCodeOpRegBit;
 429
 430
 431 typedef struct pCodeOpWild
 432 {
 433   pCodeOp pcop;
 434
 435   struct pCodeWildBlock *pcwb;
 436
 437   int id;                 /* index into an array of char *'s that will match
 438                            * the wild card. The array is in *pcp. */
 439   pCodeOp *subtype;       /* Pointer to the Operand type into which this wild
 440                            * card will be expanded */
 441   pCodeOp *matched;       /* When a wild matches, we'll store a pointer to the
 442                            * opcode we matched */
 443
 444   pCodeOp *pcop2;         /* second operand if exists */
 445
 446 } pCodeOpWild;
 447
 448
 449 /*************************************************
 450     pCode
 451
 452     Here is the basic build block of a PIC instruction.
 453     Each pic instruction will get allocated a pCode.
 454     A linked list of pCodes makes a program.
 455
 456 **************************************************/
 457
 458 typedef struct pCode
 459 {
 460   PC_TYPE    type;
 461
 462   struct pCode *prev;  // The pCode objects are linked together
 463   struct pCode *next;  // in doubly linked lists.
 464
 465   int seq;             // sequence number
 466
 467   struct pBlock *pb;   // The pBlock that contains this pCode.
 468
 469   /* "virtual functions"
 470    *  The pCode structure is like a base class
 471    * in C++. The subsequent structures that "inherit"
 472    * the pCode structure will initialize these function
 473    * pointers to something useful */
 474   //  void (*analyze) (struct pCode *_this);
 475   void (*destruct)(struct pCode *_this);
 476   void (*print)  (FILE *of,struct pCode *_this);
 477
 478 } pCode;
 479
 480
 481 /*************************************************
 482     pCodeComment
 483 **************************************************/
 484
 485 typedef struct pCodeComment
 486 {
 487
 488   pCode  pc;
 489
 490   char *comment;
 491
 492 } pCodeComment;
 493
 494
 495 /*************************************************
 496     pCodeCSource
 497 **************************************************/
 498
 499 typedef struct pCodeCSource
 500 {
 501
 502   pCode  pc;
 503
 504   int  line_number;
 505   char *line;
 506   char *file_name;
 507
 508 } pCodeCSource;
 509
 510
 511 /*************************************************
 512     pCodeAsmDir
 513 **************************************************/
 514
 515 /*************************************************
 516     pCodeFlow
 517
 518   The Flow object is used as marker to separate
 519  the assembly code into contiguous chunks. In other
 520  words, everytime an instruction cause or potentially
 521  causes a branch, a Flow object will be inserted into
 522  the pCode chain to mark the beginning of the next
 523  contiguous chunk.
 524
 525 **************************************************/
 526
 527 typedef struct pCodeFlow
 528 {
 529
 530   pCode  pc;
 531
 532   pCode *end;   /* Last pCode in this flow. Note that
 533                    the first pCode is pc.next */
 534
 535   /*  set **uses;   * map the pCode instruction inCond and outCond conditions
 536                  * in this array of set's. The reason we allocate an
 537                  * array of pointers instead of declaring each type of
 538                  * usage is because there are port dependent usage definitions */
 539   //int nuses;    /* number of uses sets */
 540
 541   set *from;    /* flow blocks that can send control to this flow block */
 542   set *to;      /* flow blocks to which this one can send control */
 543   struct pCodeFlow *ancestor; /* The most immediate "single" pCodeFlow object that
 544                                * executes prior to this one. In many cases, this
 545                                * will be just the previous */
 546
 547   int inCond;   /* Input conditions - stuff assumed defined at entry */
 548   int outCond;  /* Output conditions - stuff modified by flow block */
 549
 550   int firstBank; /* The first and last bank flags are the first and last */
 551   int lastBank;  /* register banks used within one flow object */
 552
 553   int FromConflicts;
 554   int ToConflicts;
 555
 556   set *registers;/* Registers used in this flow */
 557
 558 } pCodeFlow;
 559
 560 /*************************************************
 561   pCodeFlowLink
 562
 563   The Flow Link object is used to record information
 564  about how consecutive excutive Flow objects are related.
 565  The pCodeFlow objects demarcate the pCodeInstructions
 566  into contiguous chunks. The FlowLink records conflicts
 567  in the discontinuities. For example, if one Flow object
 568  references a register in bank 0 and the next Flow object
 569  references a register in bank 1, then there is a discontinuity
 570  in the banking registers.
 571
 572 */
 573 typedef struct pCodeFlowLink
 574 {
 575   pCodeFlow  *pcflow;   /* pointer to linked pCodeFlow object */
 576
 577   int bank_conflict;    /* records bank conflicts */
 578
 579 } pCodeFlowLink;
 580
 581 /*************************************************
 582     pCodeInstruction
 583
 584     Here we describe all the facets of a PIC instruction
 585     (expansion for the 18cxxx is also provided).
 586
 587 **************************************************/
 588
 589 typedef struct pCodeInstruction
 590 {
 591
 592   pCode  pc;
 593
 594   PIC_OPCODE op;        // The opcode of the instruction.
 595
 596   char const * const mnemonic;       // Pointer to mnemonic string
 597
 598   pBranch *from;       // pCodes that execute before this one
 599   pBranch *to;         // pCodes that execute after
 600   pBranch *label;      // pCode instructions that have labels
 601
 602   pCodeOp *pcop;               /* Operand, if this instruction has one */
 603   pCodeFlow *pcflow;           /* flow block to which this instruction belongs */
 604   pCodeCSource *cline;         /* C Source from which this instruction was derived */
 605
 606   unsigned int num_ops;        /* Number of operands (0,1,2 for mid range pics) */
 607   unsigned int isModReg:  1;   /* If destination is W or F, then 1==F */
 608   unsigned int isBitInst: 1;   /* e.g. BCF */
 609   unsigned int isBranch:  1;   /* True if this is a branching instruction */
 610   unsigned int isSkip:    1;   /* True if this is a skip instruction */
 611   unsigned int isLit:     1;   /* True if this instruction has an literal operand */
 612   unsigned int isAccess:   1;   /* True if this instruction has an access RAM operand */
 613   unsigned int isFastCall: 1;   /* True if this instruction has a fast call/return mode select operand */
 614   unsigned int is2MemOp: 1;     /* True is second operand is a memory operand VR - support for MOVFF */
 615   unsigned int is2LitOp: 1;     /* True if instruction takes 2 literal operands VR - support for LFSR */
 616
 617   PIC_OPCODE inverted_op;      /* Opcode of instruction that's the opposite of this one */
 618   unsigned int inCond;   // Input conditions for this instruction
 619   unsigned int outCond;  // Output conditions for this instruction
 620
 621 #define PCI_MAGIC       0x6e12
 622   unsigned int pci_magic;       // sanity check for pci initialization
 623 } pCodeInstruction;
 624
 625
 626
 627 /*************************************************
 628     pCodeAsmDir
 629 **************************************************/
 630
 631 typedef struct pCodeAsmDir
 632 {
 633   pCodeInstruction pci;
 634
 635   char *directive;
 636   char *arg;
 637 } pCodeAsmDir;
 638
 639
 640 /*************************************************
 641     pCodeLabel
 642 **************************************************/
 643
 644 typedef struct pCodeLabel
 645 {
 646
 647   pCode  pc;
 648
 649   char *label;
 650   int key;
 651   int force;            /* label cannot be optimized out */
 652
 653 } pCodeLabel;
 654
 655 /*************************************************
 656     pCodeFunction
 657 **************************************************/
 658
 659 typedef struct pCodeFunction
 660 {
 661
 662   pCode  pc;
 663
 664   char *modname;
 665   char *fname;     /* If NULL, then this is the end of
 666                       a function. Otherwise, it's the
 667                       start and the name is contained
 668                       here */
 669
 670   pBranch *from;       // pCodes that execute before this one
 671   pBranch *to;         // pCodes that execute after
 672   pBranch *label;      // pCode instructions that have labels
 673
 674   int  ncalled;    /* Number of times function is called */
 675
 676   int absblock;    /* hack to emulate a block pCodes in absolute position
 677                       but not inside a function */
 678 } pCodeFunction;
 679
 680
 681 /*************************************************
 682     pCodeWild
 683 **************************************************/
 684
 685 typedef struct pCodeWild
 686 {
 687
 688   pCodeInstruction  pci;
 689
 690   int    id;     /* Index into the wild card array of a peepBlock
 691                   * - this wild card will get expanded into that pCode
 692                   *   that is stored at this index */
 693
 694   /* Conditions on wild pcode instruction */
 695   int    mustBeBitSkipInst:1;
 696   int    mustNotBeBitSkipInst:1;
 697   int    invertBitSkipInst:1;
 698
 699   pCodeOp *operand;  // Optional operand
 700   pCodeOp *label;    // Optional label
 701
 702 } pCodeWild;
 703
 704 /*************************************************
 705     pBlock
 706
 707     Here are PIC program snippets. There's a strong
 708     correlation between the eBBlocks and pBlocks.
 709     SDCC subdivides a C program into managable chunks.
 710     Each chunk becomes a eBBlock and ultimately in the
 711     PIC port a pBlock.
 712
 713 **************************************************/
 714
 715 typedef struct pBlock
 716 {
 717   memmap *cmemmap;   /* The snippet is from this memmap */
 718   char   dbName;     /* if cmemmap is NULL, then dbName will identify the block */
 719   pCode *pcHead;     /* A pointer to the first pCode in a link list of pCodes */
 720   pCode *pcTail;     /* A pointer to the last pCode in a link list of pCodes */
 721
 722   struct pBlock *next;      /* The pBlocks will form a doubly linked list */
 723   struct pBlock *prev;
 724
 725   set *function_entries;    /* dll of functions in this pblock */
 726   set *function_exits;
 727   set *function_calls;
 728   set *tregisters;
 729
 730   set *FlowTree;
 731   unsigned visited:1;       /* set true if traversed in call tree */
 732
 733   unsigned seq;             /* sequence number of this pBlock */
 734
 735 } pBlock;
 736
 737 /*************************************************
 738     pFile
 739
 740     The collection of pBlock program snippets are
 741     placed into a linked list that is implemented
 742     in the pFile structure.
 743
 744     The pcode optimizer will parse the pFile.
 745
 746 **************************************************/
 747
 748 typedef struct pFile
 749 {
 750   pBlock *pbHead;     /* A pointer to the first pBlock */
 751   pBlock *pbTail;     /* A pointer to the last pBlock */
 752
 753   pBranch *functions; /* A SLL of functions in this pFile */
 754
 755 } pFile;
 756
 757
 758
 759 /*************************************************
 760   pCodeWildBlock
 761
 762   The pCodeWildBlock object keeps track of the wild
 763   variables, operands, and opcodes that exist in
 764   a pBlock.
 765 **************************************************/
 766 typedef struct pCodeWildBlock {
 767   pBlock    *pb;
 768   struct pCodePeep *pcp;    // pointer back to ... I don't like this...
 769
 770   int       nvars;          // Number of wildcard registers in target.
 771   char    **vars;           // array of pointers to them
 772
 773   int       nops;           // Number of wildcard operands in target.
 774   pCodeOp **wildpCodeOps;   // array of pointers to the pCodeOp's.
 775
 776   int       nwildpCodes;    // Number of wildcard pCodes in target/replace
 777   pCode   **wildpCodes;     // array of pointers to the pCode's.
 778
 779 } pCodeWildBlock;
 780
 781 /*************************************************
 782   pCodePeep
 783
 784   The pCodePeep object mimics the peep hole optimizer
 785   in the main SDCC src (e.g. SDCCpeeph.c). Essentially
 786   there is a target pCode chain and a replacement
 787   pCode chain. The target chain is compared to the
 788   pCode that is generated by gen.c. If a match is
 789   found then the pCode is replaced by the replacement
 790   pCode chain.
 791 **************************************************/
 792 typedef struct pCodePeep {
 793   pCodeWildBlock target;     // code we'd like to optimize
 794   pCodeWildBlock replace;    // and this is what we'll optimize it with.
 795
 796   //pBlock *target;
 797   //pBlock replace;            // and this is what we'll optimize it with.
 798
 799
 800
 801   /* (Note: a wildcard register is a place holder. Any register
 802    * can be replaced by the wildcard when the pcode is being
 803    * compared to the target. */
 804
 805   /* Post Conditions. A post condition is a condition that
 806    * must be either true or false before the peep rule is
 807    * accepted. For example, a certain rule may be accepted
 808    * if and only if the Z-bit is not used as an input to
 809    * the subsequent instructions in a pCode chain.
 810    */
 811   unsigned int postFalseCond;
 812   unsigned int postTrueCond;
 813
 814 } pCodePeep;
 815
 816 /*************************************************
 817
 818   pCode peep command definitions
 819
 820  Here are some special commands that control the
 821 way the peep hole optimizer behaves
 822
 823 **************************************************/
 824
 825 enum peepCommandTypes{
 826   NOTBITSKIP = 0,
 827   BITSKIP,
 828   INVERTBITSKIP,
 829   _LAST_PEEP_COMMAND_
 830 };
 831
 832 /*************************************************
 833     peepCommand structure stores the peep commands.
 834
 835 **************************************************/
 836
 837 typedef struct peepCommand {
 838   int id;
 839   char *cmd;
 840 } peepCommand;
 841
 842 /*************************************************
 843     pCode Macros
 844
 845 **************************************************/
 846 #define PCODE(x)  ((pCode *)(x))
 847 #define PCI(x)    ((pCodeInstruction *)(x))
 848 #define PCL(x)    ((pCodeLabel *)(x))
 849 #define PCF(x)    ((pCodeFunction *)(x))
 850 #define PCFL(x)   ((pCodeFlow *)(x))
 851 #define PCFLINK(x)((pCodeFlowLink *)(x))
 852 #define PCW(x)    ((pCodeWild *)(x))
 853 #define PCCS(x)   ((pCodeCSource *)(x))
 854 #define PCAD(x)   ((pCodeAsmDir *)(x))
 855
 856 #define PCOP(x)   ((pCodeOp *)(x))
 857 //#define PCOB(x)   ((pCodeOpBit *)(x))
 858 #define PCOL(x)   ((pCodeOpLit *)(x))
 859 #define PCOI(x)   ((pCodeOpImmd *)(x))
 860 #define PCOLAB(x) ((pCodeOpLabel *)(x))
 861 #define PCOR(x)   ((pCodeOpReg *)(x))
 862 #define PCOR2(x)  ((pCodeOpReg2 *)(x))
 863 #define PCORB(x)  ((pCodeOpRegBit *)(x))
 864 #define PCOW(x)   ((pCodeOpWild *)(x))
 865 #define PCOW2(x)  (PCOW(PCOW(x)->pcop2))
 866 #define PBR(x)    ((pBranch *)(x))
 867
 868 #define PCWB(x)   ((pCodeWildBlock *)(x))
 869
 870
 871 /*
 872   macros for checking pCode types
 873 */
 874 #define isPCI(x)        ((PCODE(x)->type == PC_OPCODE))
 875 #define isPCI_BRANCH(x) ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isBranch)
 876 #define isPCI_SKIP(x)   ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip)
 877 #define isPCI_LIT(x)    ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isLit)
 878 #define isPCI_BITSKIP(x)((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip && PCI(x)->isBitInst)
 879 #define isPCFL(x)       ((PCODE(x)->type == PC_FLOW))
 880 #define isPCF(x)        ((PCODE(x)->type == PC_FUNCTION))
 881 #define isPCL(x)        ((PCODE(x)->type == PC_LABEL))
 882 #define isPCW(x)        ((PCODE(x)->type == PC_WILD))
 883 #define isPCCS(x)       ((PCODE(x)->type == PC_CSOURCE))
 884 #define isASMDIR(x)     ((PCODE(x)->type == PC_ASMDIR))
 885
 886 #define isCALL(x)       ((isPCI(x)) && (PCI(x)->op == POC_CALL))
 887 #define isSTATUS_REG(r) ((r)->pc_type == PO_STATUS)
 888 #define isBSR_REG(r)    ((r)->pc_type == PO_BSR)
 889 #define isACCESS_BANK(r)        (r->accessBank)
 890
 891
 892
 893 #define isPCOLAB(x)     ((PCOP(x)->type) == PO_LABEL)
 894
 895 /*-----------------------------------------------------------------*
 896  * pCode functions.
 897  *-----------------------------------------------------------------*/
 898
 899 pCode *pic16_newpCode (PIC_OPCODE op, pCodeOp *pcop); // Create a new pCode given an operand
 900 pCode *pic16_newpCodeCharP(char *cP);              // Create a new pCode given a char *
 901 pCode *pic16_newpCodeInlineP(char *cP);            // Create a new pCode given a char *
 902 pCode *pic16_newpCodeFunction(char *g, char *f);   // Create a new function
 903 pCode *pic16_newpCodeLabel(char *name,int key);    // Create a new label given a key
 904 pCode *pic16_newpCodeLabelFORCE(char *name, int key); // Same as newpCodeLabel but label cannot be optimized out
 905 pCode *pic16_newpCodeCSource(int ln, char *f, char *l); // Create a new symbol line
 906 pBlock *pic16_newpCodeChain(memmap *cm,char c, pCode *pc); // Create a new pBlock
 907 void pic16_printpBlock(FILE *of, pBlock *pb);      // Write a pBlock to a file
 908 void pic16_addpCode2pBlock(pBlock *pb, pCode *pc); // Add a pCode to a pBlock
 909 void pic16_addpBlock(pBlock *pb);                  // Add a pBlock to a pFile
 910 void pic16_copypCode(FILE *of, char dbName);       // Write all pBlocks with dbName to *of
 911 void pic16_movepBlock2Head(char dbName);           // move pBlocks around
 912 void pic16_AnalyzepCode(char dbName);
 913 void pic16_AssignRegBanks(void);
 914 void pic16_printCallTree(FILE *of);
 915 void pCodePeepInit(void);
 916 void pic16_pBlockConvert2ISR(pBlock *pb);
 917 void pic16_pBlockConvert2Absolute(pBlock *pb);
 918 void pic16_initDB(void);
 919 void pic16_emitDB(char c, char ptype, void *p);           // Add DB directives to a pBlock
 920 void pic16_emitDS(char *s, char ptype, void *p);
 921 void pic16_flushDB(char ptype, void *p);                          // Add pending DB data to a pBlock
 922
 923 pCode *pic16_newpCodeAsmDir(char *asdir, char *argfmt, ...);
 924
 925 pCodeOp *pic16_newpCodeOpLabel(char *name, int key);
 926 pCodeOp *pic16_newpCodeOpImmd(char *name, int offset, int index, int code_space);
 927 pCodeOp *pic16_newpCodeOpLit(int lit);
 928 pCodeOp *pic16_newpCodeOpLit2(int lit, pCodeOp *arg2);
 929 pCodeOp *pic16_newpCodeOpBit(char *name, int bit,int inBitSpace, PIC_OPTYPE subt);
 930 pCodeOp *pic16_newpCodeOpRegFromStr(char *name);
 931 pCodeOp *pic16_newpCodeOp(char *name, PIC_OPTYPE p);
 932 pCodeOp *pic16_pCodeOpCopy(pCodeOp *pcop);
 933
 934 pCode * pic16_findNextInstruction(pCode *pci);
 935 pCode * pic16_findNextpCode(pCode *pc, PC_TYPE pct);
 936 int pic16_isPCinFlow(pCode *pc, pCode *pcflow);
 937 struct regs * pic16_getRegFromInstruction(pCode *pc);
 938 struct regs * pic16_getRegFromInstruction2(pCode *pc);
 939
 940 extern void pic16_pcode_test(void);
 941 extern int pic16_debug_verbose;
 942 extern int pic16_pcode_verbose;
 943
 944 /*-----------------------------------------------------------------*
 945  * pCode objects.
 946  *-----------------------------------------------------------------*/
 947
 948 extern pCodeOpReg pic16_pc_status;
 949 extern pCodeOpReg pic16_pc_intcon;
 950 extern pCodeOpReg pic16_pc_pcl;
 951 extern pCodeOpReg pic16_pc_pclath;
 952 extern pCodeOpReg pic16_pc_pclatu; // patch 14
 953 extern pCodeOpReg pic16_pc_wreg;
 954 extern pCodeOpReg pic16_pc_tosl; // patch 14
 955 extern pCodeOpReg pic16_pc_tosh; // patch 14
 956 extern pCodeOpReg pic16_pc_tosu; // patch 14
 957 extern pCodeOpReg pic16_pc_tblptrl; // patch 15
 958 extern pCodeOpReg pic16_pc_tblptrh; //
 959 extern pCodeOpReg pic16_pc_tblptru; //
 960 extern pCodeOpReg pic16_pc_tablat;  // patch 15
 961 extern pCodeOpReg pic16_pc_bsr;
 962 extern pCodeOpReg pic16_pc_fsr0;
 963 extern pCodeOpReg pic16_pc_fsr0l;
 964 extern pCodeOpReg pic16_pc_fsr0h;
 965 extern pCodeOpReg pic16_pc_fsr1l;
 966 extern pCodeOpReg pic16_pc_fsr1h;
 967 extern pCodeOpReg pic16_pc_fsr2l;
 968 extern pCodeOpReg pic16_pc_fsr2h;
 969 extern pCodeOpReg pic16_pc_indf0;
 970 extern pCodeOpReg pic16_pc_postinc0;
 971 extern pCodeOpReg pic16_pc_postdec0;
 972 extern pCodeOpReg pic16_pc_preinc0;
 973 extern pCodeOpReg pic16_pc_plusw0;
 974 extern pCodeOpReg pic16_pc_indf1;
 975 extern pCodeOpReg pic16_pc_postinc1;
 976 extern pCodeOpReg pic16_pc_postdec1;
 977 extern pCodeOpReg pic16_pc_preinc1;
 978 extern pCodeOpReg pic16_pc_plusw1;
 979 extern pCodeOpReg pic16_pc_indf2;
 980 extern pCodeOpReg pic16_pc_postinc2;
 981 extern pCodeOpReg pic16_pc_postdec2;
 982 extern pCodeOpReg pic16_pc_preinc2;
 983 extern pCodeOpReg pic16_pc_plusw2;
 984 extern pCodeOpReg pic16_pc_prodl;
 985 extern pCodeOpReg pic16_pc_prodh;
 986
 987 extern pCodeOpReg pic16_pc_eecon1;
 988 extern pCodeOpReg pic16_pc_eecon2;
 989 extern pCodeOpReg pic16_pc_eedata;
 990 extern pCodeOpReg pic16_pc_eeadr;
 991
 992 extern pCodeOpReg pic16_pc_kzero;
 993 extern pCodeOpReg pic16_pc_wsave;     /* wsave and ssave are used to save W and the Status */
 994 extern pCodeOpReg pic16_pc_ssave;     /* registers during an interrupt */
 995
 996
 997 #endif // __PCODE_H__