git.gag.com Git - fw/sdcc/blob - src/SDCCicode.h

   1 /*-------------------------------------------------------------------------
   2
   3   SDCCicode.h - intermediate code generation etc.
   4                 Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any
   9    later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20    In other words, you are welcome to use, share and improve this program.
  21    You are forbidden to forbid anyone else to use, share and improve
  22    what you give them.   Help stamp out software-hoarding!
  23 -------------------------------------------------------------------------*/
  24 #include "SDCCbitv.h"
  25 #include "SDCCset.h"
  26
  27 #ifndef SDCCICODE_H
  28 #define SDCCICODE_H 1
  29
  30 extern symbol *returnLabel;
  31 extern symbol *entryLabel;
  32 extern int iCodeKey;
  33 extern int operandKey;
  34
  35 enum
  36   {
  37     CONDITIONAL = 0,
  38     EXPRESSION,
  39     STATEMENT,
  40     LEAF
  41   };
  42
  43 typedef enum
  44   {
  45     SYMBOL = 1,
  46     VALUE,
  47     TYPE
  48   }
  49 OPTYPE;
  50
  51 #define IS_SYMOP(op) (op && op->type == SYMBOL)
  52 #define ADDTOCHAIN(x) addSetHead(&iCodeChain,x)
  53
  54 #define LRFTYPE       sym_link *ltype = operandType(left), \
  55                            *rtype = operandType(right) ;
  56 #define LRETYPE       sym_link *letype= getSpec(ltype)   , \
  57                            *retype= getSpec(rtype);
  58 #define LRTYPE        LRFTYPE LRETYPE
  59 #define IS_ITEMP(op)       (IS_SYMOP(op) && op->operand.symOperand->isitmp == 1)
  60 #define IS_PARM(op)        (IS_SYMOP(op) && op->operand.symOperand->_isparm)
  61 #define IS_ITEMPLBL(op)    (IS_ITEMP(op) && op->operand.symOperand->isilbl == 1);
  62 #define IS_OP_VOLATILE(op) (IS_SYMOP(op) && op->isvolatile)
  63 #define IS_OP_LITERAL(op)  (op && op->isLiteral)
  64 #define IS_OP_GLOBAL(op)   (IS_SYMOP(op) && op->isGlobal)
  65 #define IS_OP_POINTER(op)  (IS_SYMOP(op) && op->isPtr)
  66 #define IS_OP_PARM(op)     (IS_SYMOP(op) && op->isParm)
  67 #define OP_SYMBOL(op)      op->operand.symOperand
  68 #define OP_SYM_TYPE(op)    op->operand.symOperand->type
  69 #define OP_SYM_ETYPE(op)   op->operand.symOperand->etype
  70 #define SPIL_LOC(op)       op->operand.symOperand->usl.spillLoc
  71 #define OP_LIVEFROM(op)    op->operand.symOperand->liveFrom
  72 #define OP_LIVETO(op)      op->operand.symOperand->liveTo
  73 #define OP_REQV(op)        op->operand.symOperand->reqv
  74 #define OP_ISLIVE_FCALL(op) (IS_ITEMP(op) && OP_SYMBOL(op)->isLiveFcall)
  75
  76 /* typedef for operand */
  77 typedef struct operand
  78   {
  79     OPTYPE type;                /* type of operand */
  80     unsigned int isaddr:1;      /* is an address   */
  81     unsigned int isvolatile:1;  /* is a volatile operand */
  82     unsigned int isGlobal:1;    /* is a global operand */
  83     unsigned int isPtr:1;       /* is assigned a pointer */
  84     unsigned int isGptr:1;      /* is a generic pointer  */
  85     unsigned int isParm:1;      /* is a parameter        */
  86     unsigned int isLiteral:1;   /* operand is literal    */
  87     unsigned int noSpilLoc:1;   /* cannot be assigned a spil location */
  88
  89     unsigned key;
  90     int parmBytes;
  91     union
  92       {
  93         struct symbol *symOperand;      /* operand is of type symbol */
  94         struct value *valOperand;       /* operand is of type value  */
  95         struct sym_link *typeOperand;   /* operand is of type typechain */
  96       }
  97     operand;
  98
  99     bitVect *usesDefs;          /* which definitions are used by this */
 100     struct asmop *aop;          /* asm op for this operand */
 101   }
 102 operand;
 103
 104 /* definition for intermediate code */
 105 #define IC_RESULT(x) (x)->ulrrcnd.lrr.result
 106 #define IC_LEFT(x)   (x)->ulrrcnd.lrr.left
 107 #define IC_RIGHT(x)  (x)->ulrrcnd.lrr.right
 108 #define IC_COND(x)   (x)->ulrrcnd.cnd.condition
 109 #define IC_TRUE(x)   (x)->ulrrcnd.cnd.trueLabel
 110 #define IC_FALSE(x)  (x)->ulrrcnd.cnd.falseLabel
 111 #define IC_LABEL(x)  (x)->argLabel.label
 112 #define IC_ARGS(x)   (x)->argLabel.args
 113 #define IC_JTCOND(x) (x)->ulrrcnd.jmpTab.condition
 114 #define IC_JTLABELS(x) (x)->ulrrcnd.jmpTab.labels
 115 #define IC_INLINE(x) (x)->inlineAsm
 116
 117 typedef struct iCode
 118   {
 119     unsigned int op;            /* operation defined */
 120     int key;                    /* running key for this iCode */
 121     int seq;                    /* sequence number within routine */
 122     short depth;                /* loop depth of this iCode */
 123     short level;                /* scope level */
 124     short block;                /* sequential block number */
 125     unsigned nosupdate:1;       /* don't update spillocation with this */
 126     unsigned generated:1;       /* code generated for this one */
 127     unsigned parmPush:1;        /* parameter push Vs spill push */
 128     unsigned supportRtn:1;      /* will cause a call to a support routine */
 129     unsigned regsSaved:1;       /* registers have been saved */
 130     unsigned bankSaved:1;       /* register bank has been saved */
 131
 132     struct iCode *next;         /* next in chain */
 133     struct iCode *prev;         /* previous in chain */
 134     set *movedFrom;             /* if this iCode gets moved to another block */
 135     bitVect *rlive;             /* ranges that are live at this point */
 136     int defKey;                 /* key for the operand being defined  */
 137     bitVect *uses;              /* vector of key of used symbols      */
 138     bitVect *rUsed;             /* registers used by this instruction */
 139     bitVect *rMask;             /* registers in use during this instruction */
 140     union
 141       {
 142         struct
 143           {
 144             operand *left;      /* left if any   */
 145             operand *right;     /* right if any  */
 146             operand *result;    /* result of this op */
 147           }
 148         lrr;
 149
 150         struct
 151           {
 152             operand *condition; /* if this is a conditional */
 153             symbol *trueLabel;  /* true for conditional     */
 154             symbol *falseLabel; /* false for conditional    */
 155           }
 156         cnd;
 157
 158         struct
 159           {
 160             operand *condition; /* condition for the jump */
 161             set *labels;        /* ordered set of labels  */
 162           }
 163         jmpTab;
 164
 165       }
 166     ulrrcnd;
 167
 168     union
 169       {
 170         symbol *label;          /* for a goto statement     */
 171         value *args;
 172       }
 173     argLabel;
 174
 175     char *inlineAsm;            /* pointer to inline assembler code */
 176
 177     int lineno;                 /* file & lineno for debug information */
 178     char *filename;
 179   }
 180 iCode;
 181
 182 /* various functions associated to iCode */
 183 typedef struct icodeFuncTable
 184   {
 185     int icode;
 186     char *printName;
 187     void (*iCodePrint) (FILE *, iCode *, char *);
 188     iCode *(*iCodeCopy) (iCode *);
 189   }
 190 iCodeTable;
 191
 192 /* useful macros */
 193 #define SKIP_IC2(x)  (x->op == GOTO     ||     \
 194                       x->op == LABEL    ||     \
 195                       x->op == FUNCTION ||     \
 196                       x->op == INLINEASM ||    \
 197                       x->op == ENDFUNCTION   )
 198
 199 #define SKIP_IC1(x)  (x->op == CALL     ||     \
 200                       SKIP_IC2(x) )
 201
 202 #define SKIP_IC(x)   (x->op == PCALL    ||     \
 203                       x->op == IPUSH    ||     \
 204                       x->op == IPOP     ||     \
 205                       x->op == JUMPTABLE ||    \
 206                       x->op == RECEIVE  ||     \
 207                       SKIP_IC1(x)||  \
 208                       x->op == SEND         )
 209
 210 #define IS_CONDITIONAL(x) (x->op == EQ_OP || \
 211                            x->op == '<'   || \
 212                            x->op == '>'   || \
 213                            x->op == LE_OP || \
 214                            x->op == GE_OP || \
 215                            x->op == NE_OP )
 216
 217 #define IS_TRUE_SYMOP(op) (op && IS_SYMOP(op) && !IS_ITEMP(op))
 218
 219 #define POINTER_SET(ic) ( ic && ic->op == '='           \
 220                              && IS_ITEMP(IC_RESULT(ic)) \
 221                              && IC_RESULT(ic)->isaddr )
 222
 223 #define POINTER_GET(ic) ( ic && ic->op == GET_VALUE_AT_ADDRESS  \
 224                              &&  (IS_ITEMP(IC_LEFT(ic)) || IS_OP_LITERAL(IC_LEFT(ic)))\
 225                              &&  IC_LEFT(ic)->isaddr )
 226
 227 #define IS_ARITHMETIC_OP(x) (x && (x->op == '+' || \
 228                                    x->op == '-' || \
 229                                    x->op == '/' || \
 230                                    x->op == '*' || \
 231                                    x->op == '%'))
 232 #define IS_BITWISE_OP(x) (x && (x->op == BITWISEAND || \
 233                                 x->op == '|'        || \
 234                                 x->op == '^'))
 235
 236 #define ASSIGNMENT(ic) ( ic && ic->op == '=')
 237
 238 #define ASSIGN_SYM_TO_ITEMP(ic) (ic && ic->op == '=' && \
 239                              IS_TRUE_SYMOP(IC_RIGHT(ic)) && \
 240                              IS_ITEMP(IC_RESULT(ic)))
 241
 242 #define ASSIGN_ITEMP_TO_SYM(ic) (ic && ic->op == '=' && \
 243                              IS_TRUE_SYMOP(IC_RESULT(ic)) && \
 244                              IS_ITEMP(IC_RIGHT(ic)))
 245
 246 #define ASSIGN_ITEMP_TO_ITEMP(ic) (ic && ic->op == '=' &&\
 247                                    !POINTER_SET(ic)    &&\
 248                                    IS_ITEMP(IC_RIGHT(ic)) &&\
 249                                    IS_ITEMP(IC_RESULT(ic)))
 250
 251 #define ADD_SUBTRACT_ITEMP(ic) (ic && (ic->op == '+' || ic->op == '-') && \
 252                                 IS_ITEMP(IC_RESULT(ic)) && \
 253                                 ( ( IS_ITEMP(IC_LEFT(ic)) ) ||  ( IS_SYMOP(IC_LEFT(ic)) ) ) && \
 254                                   IS_OP_LITERAL(IC_RIGHT(ic)))
 255
 256 #define ASSIGNMENT_TO_SELF(ic) (!POINTER_SET(ic) && !POINTER_GET(ic) && \
 257                                 ic->op == '=' && IC_RESULT(ic)->key == IC_RIGHT(ic)->key )
 258
 259 #define SET_ISADDR(op,v) {op = operandFromOperand(op); op->isaddr = v;}
 260 #define SET_RESULT_RIGHT(ic) {SET_ISADDR(IC_RIGHT(ic),0); SET_ISADDR(IC_RESULT(ic),0);}
 261
 262 #define OP_DEFS(op) op->operand.symOperand->defs
 263 #define OP_USES(op) op->operand.symOperand->uses
 264 /*-----------------------------------------------------------------*/
 265 /* forward references for functions                                */
 266 /*-----------------------------------------------------------------*/
 267 iCode *reverseiCChain ();
 268 bool isOperandOnStack (operand *);
 269 int isOperandVolatile (operand *, bool);
 270 int isOperandGlobal (operand *);
 271 void printiCChain (iCode *, FILE *);
 272 operand *ast2iCode (ast *);
 273 operand *geniCodeCast (sym_link *, operand *, bool);
 274 operand *geniCodePtrPtrSubtract (operand *, operand *);
 275 void initiCode ();
 276 iCode *iCodeFromAst (ast *);
 277 int isiCodeEqual (iCode *, iCode *);
 278 int isOperandEqual (operand *, operand *);
 279 iCodeTable *getTableEntry (int);
 280 int isOperandLiteral (operand *);
 281 operand *operandOperation (operand *, operand *, int, sym_link *);
 282 double operandLitValue (operand *);
 283 operand *operandFromLit (float);
 284 operand *operandFromOperand (operand *);
 285 int isParameterToCall (value *, operand *);
 286 iCode *newiCodeLabelGoto (int, symbol *);
 287 symbol *newiTemp (char *);
 288 symbol *newiTempLabel (char *);
 289 symbol *newiTempPreheaderLabel ();
 290 iCode *newiCode (int, operand *, operand *);
 291 sym_link *operandType (operand *);
 292 operand *operandFromValue (value *);
 293 operand *operandFromSymbol (symbol *);
 294 sym_link *aggrToPtr (sym_link *, bool);
 295 int piCode (void *, FILE *);
 296 int printOperand (operand *, FILE *);
 297 void setOperandType (operand *, sym_link *);
 298 bool isOperandInFarSpace (operand *);
 299 operand *opFromOpWithDU (operand *, bitVect *, bitVect *);
 300 iCode *copyiCode (iCode *);
 301 operand *newiTempFromOp (operand *);
 302 /*-----------------------------------------------------------------*/
 303 /* declaration of exported variables                               */
 304 /*-----------------------------------------------------------------*/
 305 extern char *filename;
 306 extern int lineno;
 307 #endif