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