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