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