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_TSTFSZ,
 272   POC_XORLW,
 273   POC_XORWF,
 274   POC_XORFW
 275 } PIC_OPCODE;
 276
 277
 278 /***********************************************************************
 279  *  PC_TYPE  - pCode Types
 280  ***********************************************************************/
 281
 282 typedef enum
 283 {
 284   PC_COMMENT=0,   /* pCode is a comment     */
 285   PC_INLINE,      /* user's inline code     */
 286   PC_OPCODE,      /* PORT dependent opcode  */
 287   PC_LABEL,       /* assembly label         */
 288   PC_FLOW,        /* flow analysis          */
 289   PC_FUNCTION,    /* Function start or end  */
 290   PC_WILD,        /* wildcard - an opcode place holder used
 291                    * in the pCode peep hole optimizer */
 292   PC_CSOURCE,     /* C-Source Line  */
 293   PC_ASMDIR,      /* Assembler directive */
 294   PC_BAD          /* Mark the pCode object as being bad */
 295 } PC_TYPE;
 296
 297 /************************************************/
 298 /***************  Structures ********************/
 299 /************************************************/
 300 /* These are here as forward references - the
 301  * full definition of these are below           */
 302 struct pCode;
 303 struct pCodeWildBlock;
 304 struct pCodeRegLives;
 305
 306 /*************************************************
 307   pBranch
 308
 309   The first step in optimizing pCode is determining
 310  the program flow. This information is stored in
 311  single-linked lists in the for of 'from' and 'to'
 312  objects with in a pcode. For example, most instructions
 313  don't involve any branching. So their from branch
 314  points to the pCode immediately preceding them and
 315  their 'to' branch points to the pcode immediately
 316  following them. A skip instruction is an example of
 317  a pcode that has multiple (in this case two) elements
 318  in the 'to' branch. A 'label' pcode is an where there
 319  may be multiple 'from' branches.
 320  *************************************************/
 321
 322 typedef struct pBranch
 323 {
 324   struct pCode   *pc;    // Next pCode in a branch
 325   struct pBranch *next;  /* If more than one branch
 326                           * the next one is here */
 327
 328 } pBranch;
 329
 330 /*************************************************
 331   pCodeOp
 332
 333   pCode Operand structure.
 334   For those assembly instructions that have arguments,
 335   the pCode will have a pCodeOp in which the argument
 336   can be stored. For example
 337
 338     movf   some_register,w
 339
 340   'some_register' will be stored/referenced in a pCodeOp
 341
 342  *************************************************/
 343
 344 typedef struct pCodeOp
 345 {
 346   PIC_OPTYPE type;
 347   char *name;
 348
 349 } pCodeOp;
 350
 351 #if 0
 352 typedef struct pCodeOpBit
 353 {
 354   pCodeOp pcop;
 355   int bit;
 356   unsigned int inBitSpace: 1; /* True if in bit space, else
 357                                  just a bit of a register */
 358 } pCodeOpBit;
 359 #endif
 360 typedef struct pCodeOpLit
 361 {
 362   pCodeOp pcop;
 363   int lit;
 364 } pCodeOpLit;
 365
 366 typedef struct pCodeOpLit2
 367 {
 368   pCodeOp pcop;
 369   int lit;
 370   pCodeOp *arg2;
 371 } pCodeOpLit2;
 372
 373
 374 typedef struct pCodeOpImmd
 375 {
 376   pCodeOp pcop;
 377   int offset;           /* low,high or upper byte of immediate value */
 378   int index;            /* add this to the immediate value */
 379   unsigned _const:1;    /* is in code space    */
 380
 381   int rIdx;             /* If this immd points to a register */
 382   struct regs *r;       /* then this is the reg. */
 383
 384 } pCodeOpImmd;
 385
 386 typedef struct pCodeOpLabel
 387 {
 388   pCodeOp pcop;
 389   int key;
 390 } pCodeOpLabel;
 391
 392 typedef struct pCodeOpReg
 393 {
 394   pCodeOp pcop;    // Can be either GPR or SFR
 395   int rIdx;        // Index into the register table
 396   struct regs *r;
 397   int instance;    // byte # of Multi-byte registers
 398   struct pBlock *pb;
 399 } pCodeOpReg;
 400
 401 typedef struct pCodeOpReg2
 402 {
 403   pCodeOp pcop;         // used by default to all references
 404   int rIdx;
 405   struct regs *r;
 406   int instance;         // assume same instance for both operands
 407   struct pBlock *pb;
 408
 409   pCodeOp *pcop2;       // second memory operand
 410 } pCodeOpReg2;
 411
 412 typedef struct pCodeOpRegBit
 413 {
 414   pCodeOpReg  pcor;       // The Register containing this bit
 415   int bit;                // 0-7 bit number.
 416   PIC_OPTYPE subtype;     // The type of this register.
 417   unsigned int inBitSpace: 1; /* True if in bit space, else
 418                                  just a bit of a register */
 419 } pCodeOpRegBit;
 420
 421
 422 typedef struct pCodeOpWild
 423 {
 424   pCodeOp pcop;
 425
 426   struct pCodeWildBlock *pcwb;
 427
 428   int id;                 /* index into an array of char *'s that will match
 429                            * the wild card. The array is in *pcp. */
 430   pCodeOp *subtype;       /* Pointer to the Operand type into which this wild
 431                            * card will be expanded */
 432   pCodeOp *matched;       /* When a wild matches, we'll store a pointer to the
 433                            * opcode we matched */
 434
 435 } pCodeOpWild;
 436
 437
 438 /*************************************************
 439     pCode
 440
 441     Here is the basic build block of a PIC instruction.
 442     Each pic instruction will get allocated a pCode.
 443     A linked list of pCodes makes a program.
 444
 445 **************************************************/
 446
 447 typedef struct pCode
 448 {
 449   PC_TYPE    type;
 450
 451   struct pCode *prev;  // The pCode objects are linked together
 452   struct pCode *next;  // in doubly linked lists.
 453
 454   int seq;             // sequence number
 455
 456   struct pBlock *pb;   // The pBlock that contains this pCode.
 457
 458   /* "virtual functions"
 459    *  The pCode structure is like a base class
 460    * in C++. The subsequent structures that "inherit"
 461    * the pCode structure will initialize these function
 462    * pointers to something useful */
 463   //  void (*analyze) (struct pCode *_this);
 464   void (*destruct)(struct pCode *_this);
 465   void (*print)  (FILE *of,struct pCode *_this);
 466
 467 } pCode;
 468
 469
 470 /*************************************************
 471     pCodeComment
 472 **************************************************/
 473
 474 typedef struct pCodeComment
 475 {
 476
 477   pCode  pc;
 478
 479   char *comment;
 480
 481 } pCodeComment;
 482
 483
 484 /*************************************************
 485     pCodeCSource
 486 **************************************************/
 487
 488 typedef struct pCodeCSource
 489 {
 490
 491   pCode  pc;
 492
 493   int  line_number;
 494   char *line;
 495   char *file_name;
 496
 497 } pCodeCSource;
 498
 499
 500 /*************************************************
 501     pCodeAsmDir
 502 **************************************************/
 503
 504 typedef struct pCodeAsmDir
 505 {
 506   pCode pc;
 507
 508   char *directive;
 509   char *arg;
 510
 511   pBranch *label;
 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     pCodeLabel
 628 **************************************************/
 629
 630 typedef struct pCodeLabel
 631 {
 632
 633   pCode  pc;
 634
 635   char *label;
 636   int key;
 637
 638 } pCodeLabel;
 639
 640 /*************************************************
 641     pCodeFunction
 642 **************************************************/
 643
 644 typedef struct pCodeFunction
 645 {
 646
 647   pCode  pc;
 648
 649   char *modname;
 650   char *fname;     /* If NULL, then this is the end of
 651                       a function. Otherwise, it's the
 652                       start and the name is contained
 653                       here */
 654
 655   pBranch *from;       // pCodes that execute before this one
 656   pBranch *to;         // pCodes that execute after
 657   pBranch *label;      // pCode instructions that have labels
 658
 659   int  ncalled;    /* Number of times function is called */
 660
 661 } pCodeFunction;
 662
 663
 664 /*************************************************
 665     pCodeWild
 666 **************************************************/
 667
 668 typedef struct pCodeWild
 669 {
 670
 671   pCodeInstruction  pci;
 672
 673   int    id;     /* Index into the wild card array of a peepBlock
 674                   * - this wild card will get expanded into that pCode
 675                   *   that is stored at this index */
 676
 677   /* Conditions on wild pcode instruction */
 678   int    mustBeBitSkipInst:1;
 679   int    mustNotBeBitSkipInst:1;
 680   int    invertBitSkipInst:1;
 681
 682   pCodeOp *operand;  // Optional operand
 683   pCodeOp *label;    // Optional label
 684
 685 } pCodeWild;
 686
 687 /*************************************************
 688     pBlock
 689
 690     Here are PIC program snippets. There's a strong
 691     correlation between the eBBlocks and pBlocks.
 692     SDCC subdivides a C program into managable chunks.
 693     Each chunk becomes a eBBlock and ultimately in the
 694     PIC port a pBlock.
 695
 696 **************************************************/
 697
 698 typedef struct pBlock
 699 {
 700   memmap *cmemmap;   /* The snippet is from this memmap */
 701   char   dbName;     /* if cmemmap is NULL, then dbName will identify the block */
 702   pCode *pcHead;     /* A pointer to the first pCode in a link list of pCodes */
 703   pCode *pcTail;     /* A pointer to the last pCode in a link list of pCodes */
 704
 705   struct pBlock *next;      /* The pBlocks will form a doubly linked list */
 706   struct pBlock *prev;
 707
 708   set *function_entries;    /* dll of functions in this pblock */
 709   set *function_exits;
 710   set *function_calls;
 711   set *tregisters;
 712
 713   set *FlowTree;
 714   unsigned visited:1;       /* set true if traversed in call tree */
 715
 716   unsigned seq;             /* sequence number of this pBlock */
 717
 718 } pBlock;
 719
 720 /*************************************************
 721     pFile
 722
 723     The collection of pBlock program snippets are
 724     placed into a linked list that is implemented
 725     in the pFile structure.
 726
 727     The pcode optimizer will parse the pFile.
 728
 729 **************************************************/
 730
 731 typedef struct pFile
 732 {
 733   pBlock *pbHead;     /* A pointer to the first pBlock */
 734   pBlock *pbTail;     /* A pointer to the last pBlock */
 735
 736   pBranch *functions; /* A SLL of functions in this pFile */
 737
 738 } pFile;
 739
 740
 741
 742 /*************************************************
 743   pCodeWildBlock
 744
 745   The pCodeWildBlock object keeps track of the wild
 746   variables, operands, and opcodes that exist in
 747   a pBlock.
 748 **************************************************/
 749 typedef struct pCodeWildBlock {
 750   pBlock    *pb;
 751   struct pCodePeep *pcp;    // pointer back to ... I don't like this...
 752
 753   int       nvars;          // Number of wildcard registers in target.
 754   char    **vars;           // array of pointers to them
 755
 756   int       nops;           // Number of wildcard operands in target.
 757   pCodeOp **wildpCodeOps;   // array of pointers to the pCodeOp's.
 758
 759   int       nwildpCodes;    // Number of wildcard pCodes in target/replace
 760   pCode   **wildpCodes;     // array of pointers to the pCode's.
 761
 762 } pCodeWildBlock;
 763
 764 /*************************************************
 765   pCodePeep
 766
 767   The pCodePeep object mimics the peep hole optimizer
 768   in the main SDCC src (e.g. SDCCpeeph.c). Essentially
 769   there is a target pCode chain and a replacement
 770   pCode chain. The target chain is compared to the
 771   pCode that is generated by gen.c. If a match is
 772   found then the pCode is replaced by the replacement
 773   pCode chain.
 774 **************************************************/
 775 typedef struct pCodePeep {
 776   pCodeWildBlock target;     // code we'd like to optimize
 777   pCodeWildBlock replace;    // and this is what we'll optimize it with.
 778
 779   //pBlock *target;
 780   //pBlock replace;            // and this is what we'll optimize it with.
 781
 782
 783
 784   /* (Note: a wildcard register is a place holder. Any register
 785    * can be replaced by the wildcard when the pcode is being
 786    * compared to the target. */
 787
 788   /* Post Conditions. A post condition is a condition that
 789    * must be either true or false before the peep rule is
 790    * accepted. For example, a certain rule may be accepted
 791    * if and only if the Z-bit is not used as an input to
 792    * the subsequent instructions in a pCode chain.
 793    */
 794   unsigned int postFalseCond;
 795   unsigned int postTrueCond;
 796
 797 } pCodePeep;
 798
 799 /*************************************************
 800
 801   pCode peep command definitions
 802
 803  Here are some special commands that control the
 804 way the peep hole optimizer behaves
 805
 806 **************************************************/
 807
 808 enum peepCommandTypes{
 809   NOTBITSKIP = 0,
 810   BITSKIP,
 811   INVERTBITSKIP,
 812   _LAST_PEEP_COMMAND_
 813 };
 814
 815 /*************************************************
 816     peepCommand structure stores the peep commands.
 817
 818 **************************************************/
 819
 820 typedef struct peepCommand {
 821   int id;
 822   char *cmd;
 823 } peepCommand;
 824
 825 /*************************************************
 826     pCode Macros
 827
 828 **************************************************/
 829 #define PCODE(x)  ((pCode *)(x))
 830 #define PCI(x)    ((pCodeInstruction *)(x))
 831 #define PCL(x)    ((pCodeLabel *)(x))
 832 #define PCF(x)    ((pCodeFunction *)(x))
 833 #define PCFL(x)   ((pCodeFlow *)(x))
 834 #define PCFLINK(x)((pCodeFlowLink *)(x))
 835 #define PCW(x)    ((pCodeWild *)(x))
 836 #define PCCS(x)   ((pCodeCSource *)(x))
 837 #define PCAD(x)   ((pCodeAsmDir *)(x))
 838
 839 #define PCOP(x)   ((pCodeOp *)(x))
 840 //#define PCOB(x)   ((pCodeOpBit *)(x))
 841 #define PCOL(x)   ((pCodeOpLit *)(x))
 842 #define PCOI(x)   ((pCodeOpImmd *)(x))
 843 #define PCOLAB(x) ((pCodeOpLabel *)(x))
 844 #define PCOR(x)   ((pCodeOpReg *)(x))
 845 #define PCOR2(x)  ((pCodeOpReg2 *)(x))
 846 #define PCORB(x)  ((pCodeOpRegBit *)(x))
 847 #define PCOW(x)   ((pCodeOpWild *)(x))
 848
 849 #define PBR(x)    ((pBranch *)(x))
 850
 851 #define PCWB(x)   ((pCodeWildBlock *)(x))
 852
 853
 854 /*
 855   macros for checking pCode types
 856 */
 857 #define isPCI(x)        ((PCODE(x)->type == PC_OPCODE))
 858 #define isPCI_BRANCH(x) ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isBranch)
 859 #define isPCI_SKIP(x)   ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip)
 860 #define isPCI_LIT(x)    ((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isLit)
 861 #define isPCI_BITSKIP(x)((PCODE(x)->type == PC_OPCODE) &&  PCI(x)->isSkip && PCI(x)->isBitInst)
 862 #define isPCFL(x)       ((PCODE(x)->type == PC_FLOW))
 863 #define isPCF(x)        ((PCODE(x)->type == PC_FUNCTION))
 864 #define isPCL(x)        ((PCODE(x)->type == PC_LABEL))
 865 #define isPCW(x)        ((PCODE(x)->type == PC_WILD))
 866 #define isPCCS(x)       ((PCODE(x)->type == PC_CSOURCE))
 867 #define isASMDIR(x)     ((PCODE(x)->type == PC_ASMDIR))
 868
 869 #define isCALL(x)       ((isPCI(x)) && (PCI(x)->op == POC_CALL))
 870 #define isSTATUS_REG(r) ((r)->pc_type == PO_STATUS)
 871 #define isBSR_REG(r)    ((r)->pc_type == PO_BSR)
 872 #define isACCESS_BANK(r)        (r->accessBank)
 873
 874
 875
 876 #define isPCOLAB(x)     ((PCOP(x)->type) == PO_LABEL)
 877
 878 /*-----------------------------------------------------------------*
 879  * pCode functions.
 880  *-----------------------------------------------------------------*/
 881
 882 pCode *pic16_newpCode (PIC_OPCODE op, pCodeOp *pcop); // Create a new pCode given an operand
 883 pCode *pic16_newpCodeCharP(char *cP);              // Create a new pCode given a char *
 884 pCode *pic16_newpCodeInlineP(char *cP);            // Create a new pCode given a char *
 885 pCode *pic16_newpCodeFunction(char *g, char *f);   // Create a new function
 886 pCode *pic16_newpCodeLabel(char *name,int key);    // Create a new label given a key
 887 pCode *pic16_newpCodeCSource(int ln, char *f, char *l); // Create a new symbol line
 888 pBlock *pic16_newpCodeChain(memmap *cm,char c, pCode *pc); // Create a new pBlock
 889 void pic16_printpBlock(FILE *of, pBlock *pb);      // Write a pBlock to a file
 890 void pic16_addpCode2pBlock(pBlock *pb, pCode *pc); // Add a pCode to a pBlock
 891 void pic16_addpBlock(pBlock *pb);                  // Add a pBlock to a pFile
 892 void pic16_copypCode(FILE *of, char dbName);       // Write all pBlocks with dbName to *of
 893 void pic16_movepBlock2Head(char dbName);           // move pBlocks around
 894 void pic16_AnalyzepCode(char dbName);
 895 void pic16_AssignRegBanks(void);
 896 void pic16_printCallTree(FILE *of);
 897 void pCodePeepInit(void);
 898 void pic16_pBlockConvert2ISR(pBlock *pb);
 899 void pic16_pBlockConvert2Absolute(pBlock *pb);
 900
 901 pCodeOp *pic16_newpCodeOpLabel(char *name, int key);
 902 pCodeOp *pic16_newpCodeOpImmd(char *name, int offset, int index, int code_space);
 903 pCodeOp *pic16_newpCodeOpLit(int lit);
 904 pCodeOp *pic16_newpCodeOpLit2(int lit, pCodeOp *arg2);
 905 pCodeOp *pic16_newpCodeOpBit(char *name, int bit,int inBitSpace);
 906 pCodeOp *pic16_newpCodeOpRegFromStr(char *name);
 907 pCodeOp *pic16_newpCodeOp(char *name, PIC_OPTYPE p);
 908 pCodeOp *pic16_pCodeOpCopy(pCodeOp *pcop);
 909
 910 pCode * pic16_findNextInstruction(pCode *pci);
 911 pCode * pic16_findNextpCode(pCode *pc, PC_TYPE pct);
 912 int pic16_isPCinFlow(pCode *pc, pCode *pcflow);
 913 struct regs * pic16_getRegFromInstruction(pCode *pc);
 914 struct regs * pic16_getRegFromInstruction2(pCode *pc);
 915
 916 extern void pic16_pcode_test(void);
 917 extern int pic16_debug_verbose;
 918 /*-----------------------------------------------------------------*
 919  * pCode objects.
 920  *-----------------------------------------------------------------*/
 921
 922 extern pCodeOpReg pic16_pc_status;
 923 extern pCodeOpReg pic16_pc_intcon;
 924 extern pCodeOpReg pic16_pc_pcl;
 925 extern pCodeOpReg pic16_pc_pclath;
 926 extern pCodeOpReg pic16_pc_wreg;
 927 extern pCodeOpReg pic16_pc_bsr;
 928 extern pCodeOpReg pic16_pc_fsr0;
 929 extern pCodeOpReg pic16_pc_fsr0l;
 930 extern pCodeOpReg pic16_pc_fsr0h;
 931 extern pCodeOpReg pic16_pc_fsr1l;
 932 extern pCodeOpReg pic16_pc_fsr1h;
 933 extern pCodeOpReg pic16_pc_fsr2l;
 934 extern pCodeOpReg pic16_pc_fsr2h;
 935 extern pCodeOpReg pic16_pc_indf0;
 936 extern pCodeOpReg pic16_pc_postinc0;
 937 extern pCodeOpReg pic16_pc_postdec0;
 938 extern pCodeOpReg pic16_pc_preinc0;
 939 extern pCodeOpReg pic16_pc_plusw0;
 940 extern pCodeOpReg pic16_pc_indf1;
 941 extern pCodeOpReg pic16_pc_postinc1;
 942 extern pCodeOpReg pic16_pc_postdec1;
 943 extern pCodeOpReg pic16_pc_preinc1;
 944 extern pCodeOpReg pic16_pc_plusw1;
 945 extern pCodeOpReg pic16_pc_indf2;
 946 extern pCodeOpReg pic16_pc_postinc2;
 947 extern pCodeOpReg pic16_pc_postdec2;
 948 extern pCodeOpReg pic16_pc_preinc2;
 949 extern pCodeOpReg pic16_pc_plusw2;
 950 extern pCodeOpReg pic16_pc_prodl;
 951 extern pCodeOpReg pic16_pc_prodh;
 952
 953 extern pCodeOpReg pic16_pc_kzero;
 954 extern pCodeOpReg pic16_pc_wsave;     /* wsave and ssave are used to save W and the Status */
 955 extern pCodeOpReg pic16_pc_ssave;     /* registers during an interrupt */
 956
 957
 958 #endif // __PCODE_H__