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