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