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

   1 /*-------------------------------------------------------------------------
   2   SDCCsymt.h - Header file for Symbols table related structures and MACRO's.
   3               Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
   4
   5    This program is free software; you can redistribute it and/or modify it
   6    under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; either version 2, or (at your option) any
   8    later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19    In other words, you are welcome to use, share and improve this program.
  20    You are forbidden to forbid anyone else to use, share and improve
  21    what you give them.   Help stamp out software-hoarding!
  22 -------------------------------------------------------------------------*/
  23
  24 #ifndef  SDCCSYMT_H
  25 #define  SDCCSYMT_H
  26
  27 #define MAX_NEST_LEVEL  256
  28 #define SDCC_NAME_MAX    64
  29 #include "SDCChasht.h"
  30
  31
  32 #define HASHTAB_SIZE 256
  33
  34 /* hash table bucket */
  35 typedef struct bucket
  36   {
  37     void *sym;                  /* pointer to the object   */
  38     char name[SDCC_NAME_MAX + 1];       /* name of this symbol          */
  39     int level;                  /* nest level for this symbol   */
  40     int block;                  /* belongs to which block */
  41     struct bucket *prev;        /* ptr 2 previous bucket   */
  42     struct bucket *next;        /* ptr 2 next bucket       */
  43   }
  44 bucket;
  45
  46 typedef struct structdef
  47   {
  48     char tag[SDCC_NAME_MAX + 1];        /* tag part of structure      */
  49     unsigned char level;        /* Nesting level         */
  50     struct symbol *fields;      /* pointer to fields     */
  51     unsigned size;              /* sizeof the table in bytes  */
  52   }
  53 structdef;
  54
  55 /* noun definitions */
  56 typedef enum
  57   {
  58     V_INT = 0,
  59     V_FLOAT,
  60     V_CHAR,
  61     V_VOID,
  62     V_STRUCT,
  63     V_LABEL,
  64     V_BIT,
  65     V_SBIT
  66   }
  67 NOUN;
  68
  69 /* storage class    */
  70 typedef enum
  71   {
  72     S_FIXED = 0,
  73     S_AUTO,
  74     S_REGISTER,
  75     S_CONSTANT,
  76     S_SFR,
  77     S_SBIT,
  78     S_CODE,
  79     S_XDATA,
  80     S_DATA,
  81     S_IDATA,
  82     S_PDATA,
  83     S_LITERAL,
  84     S_STACK,
  85     S_XSTACK,
  86     S_BIT,
  87     S_EEPROM
  88   }
  89 STORAGE_CLASS;
  90
  91 /* specifier is the last in the type-chain */
  92 typedef struct specifier
  93   {
  94     NOUN noun;                  /* CHAR INT STRUCTURE LABEL   */
  95     STORAGE_CLASS sclass;       /* REGISTER,AUTO,FIX,CONSTANT */
  96     struct memmap *oclass;      /* output storage class       */
  97     unsigned _long:1;           /* 1=long            */
  98     unsigned _short:1;          /* 1=short int    */
  99     unsigned _unsigned:1;       /* 1=unsigned, 0=signed       */
 100     unsigned _static:1;         /* 1=static keyword found     */
 101     unsigned _extern:1;         /* 1=extern found             */
 102     unsigned _absadr:1;         /* absolute address specfied  */
 103     unsigned _reent:1;          /* function is reentrant      */
 104     unsigned _intrtn:1;         /* this is an interrupt routin */
 105     unsigned _rbank:1;          /* seperate register bank     */
 106     unsigned _volatile:1;       /* is marked as volatile      */
 107     unsigned _const:1;          /* is a constant              */
 108     unsigned _critical:1;       /* critical function          */
 109     unsigned _typedef:1;        /* is typedefed               */
 110     unsigned _isregparm:1;      /* is the first parameter     */
 111     unsigned _isenum:1;         /* is an enumerated type      */
 112     unsigned nonbanked:1;       /* function has the nonbanked attribute */
 113     unsigned banked:1;          /* function has the banked attribute */
 114     unsigned _IntNo;            /* 1=Interrupt svc routine    */
 115     short _regbank;             /* register bank 2b used      */
 116     unsigned _addr;             /* address of symbol          */
 117     unsigned _stack;            /* stack offset for stacked v */
 118     unsigned _bitStart;         /* bit start position         */
 119     int _bitLength;             /* bit length                 */
 120
 121     union
 122       {                         /* Values if constant or enum */
 123         int v_int;              /* int and char values        */
 124         char *v_char;           /* character string           */
 125         unsigned v_uint;        /* unsigned int const value   */
 126         long v_long;            /* long constant value        */
 127         unsigned long v_ulong;  /* unsigned long constant val */
 128         double v_float;         /* floating point constant value */
 129         struct symbol *v_enum;  /* ptr 2 enum_list if enum==1 */
 130       }
 131     const_val;
 132     struct structdef *v_struct; /* structure pointer      */
 133   }
 134 specifier;
 135
 136 /* types of declarators */
 137 typedef enum
 138   {
 139     POINTER = 0,                /* pointer to near data */
 140     FPOINTER,                   /* pointer to far data  */
 141     CPOINTER,                   /* pointer to code space */
 142     GPOINTER,                   /* _generic pointer     */
 143     PPOINTER,                   /* paged area pointer   */
 144     IPOINTER,                   /* pointer to upper 128 bytes */
 145     UPOINTER,                   /* unknown pointer used only when parsing */
 146     EEPPOINTER,                 /* pointer to eeprom     */
 147     ARRAY,
 148     FUNCTION
 149   }
 150 DECLARATOR_TYPE;
 151
 152 typedef struct declarator
 153   {
 154     DECLARATOR_TYPE dcl_type;   /* POINTER,ARRAY or FUNCTION  */
 155     unsigned int num_elem;      /* # of elems if type==array  */
 156     short ptr_const:1;          /* pointer is constant        */
 157     short ptr_volatile:1;       /* pointer is volatile        */
 158     struct sym_link *tspec;     /* pointer type specifier      */
 159   }
 160 declarator;
 161
 162 #define DECLARATOR   0
 163 #define SPECIFIER    1
 164
 165 typedef struct sym_link
 166   {
 167     unsigned class:1;           /* DECLARATOR or SPECIFIER    */
 168     unsigned tdef:1;            /* current link created by    */
 169     /* typedef if this flag is set */
 170     union
 171       {
 172         specifier s;            /* if CLASS == SPECIFIER      */
 173         declarator d;           /* if CLASS == DECLARATOR     */
 174       }
 175     select;
 176
 177     struct sym_link *next;      /* next element on the chain  */
 178   }
 179 sym_link;
 180
 181 typedef struct symbol
 182   {
 183     char name[SDCC_NAME_MAX + 1];       /* Input Variable Name     */
 184     char rname[SDCC_NAME_MAX + 1];      /* internal name           */
 185
 186     short level;                /* declration lev,fld offset */
 187     short block;                /* sequential block # of defintion */
 188     int key;
 189     unsigned fbody:1;           /* function body defined             */
 190     unsigned implicit:1;        /* implicit flag                     */
 191     unsigned undefined:1;       /* undefined variable                */
 192     unsigned ret:1;             /* return statement for a function   */
 193     unsigned hasVargs:1;        /* has a variable argument list      */
 194     unsigned _isparm:1;         /* is a parameter          */
 195     unsigned ismyparm:1;        /* is parameter of the function being generated */
 196     unsigned isitmp:1;          /* is an intermediate temp */
 197     unsigned islbl:1;           /* is a temporary label */
 198     unsigned isref:1;           /* has been referenced  */
 199     unsigned isind:1;           /* is a induction variable */
 200     unsigned isinvariant:1;     /* is a loop invariant  */
 201     unsigned isstrlit:1;        /* is a string literal  */
 202     unsigned cdef:1;            /* compiler defined symbol */
 203     unsigned allocreq:1;        /* allocation is required for this variable */
 204     unsigned addrtaken:1;       /* address of the symbol was taken */
 205     unsigned isreqv:1;          /* is the register quivalent of a symbol */
 206     unsigned hasFcall:1;        /* for functions does it call other functions */
 207     unsigned calleeSave:1;      /* for functions uses callee save paradigm */
 208     unsigned udChked:1;         /* use def checking has been already done */
 209
 210     /* following flags are used by the backend
 211        for code generation and can be changed
 212        if a better scheme for backend is thought of */
 213     unsigned isLiveFcall:1;     /* is live at or across a function call */
 214     unsigned isspilt:1;         /* has to be spilt */
 215     unsigned remat:1;           /* can be remateriazed */
 216     unsigned isptr:1;           /* is a pointer */
 217     unsigned uptr:1;            /* used as a pointer */
 218     unsigned isFree:1;          /* used by register allocator */
 219     unsigned islocal:1;         /* is a local variable        */
 220     unsigned blockSpil:1;       /* spilt at block level       */
 221     unsigned remainSpil:1;      /* spilt because not used in remainder */
 222     unsigned stackSpil:1;       /* has been spilt on temp stack location */
 223     unsigned onStack:1;         /* this symbol allocated on the stack */
 224     unsigned iaccess:1;         /* indirect access      */
 225     unsigned ruonly:1;          /* used in return statement only */
 226     unsigned spildir:1;         /* spilt in direct space */
 227     unsigned ptrreg:1;          /* this symbol assigned to a ptr reg */
 228     unsigned accuse;            /* can be left in the accumulator
 229                                    On the Z80 accuse is devided into
 230                                    ACCUSE_A and ACCUSE_HL as the idea
 231                                    is quite similar.
 232                                  */
 233
 234     int stack;                  /* offset on stack      */
 235     int xstack;                 /* offset on xternal stack */
 236     short nRegs;                /* number of registers required */
 237     short regType;              /* type of register required    */
 238
 239     struct regs *regs[4];       /* can have at the most 4 registers */
 240     struct asmop *aop;          /* asmoperand for this symbol */
 241     struct iCode *fuse;         /* furthest use */
 242     struct iCode *rematiCode;   /* rematerialse with which instruction */
 243     struct operand *reqv;       /* register equivalent of a local variable */
 244     union
 245       {
 246         struct symbol *spillLoc;        /* register spil location */
 247         struct set *itmpStack;  /* symbols spilt @ this stack location */
 248       }
 249     usl;
 250     short bitVar;               /* this is a bit variable    */
 251     unsigned offset;            /* offset from top if struct */
 252
 253     int lineDef;                /* defined line number        */
 254     int lastLine;               /* for functions the last line */
 255     struct sym_link *type;      /* 1st link to declator chain */
 256     struct sym_link *etype;     /* last link to declarator chn */
 257     struct value *args;         /* arguments if function      */
 258     struct symbol *next;        /* crosslink to next symbol   */
 259     struct symbol *localof;     /* local variable of which function */
 260     struct initList *ival;      /* ptr to initializer if any  */
 261     struct bitVect *defs;       /* bit vector for definitions */
 262     struct bitVect *uses;       /* bit vector for uses        */
 263     struct bitVect *regsUsed;   /* for functions registers used */
 264     int liveFrom;               /* live from iCode sequence number */
 265     int liveTo;                 /* live to sequence number */
 266     int used;                   /* no. of times this was used */
 267     int recvSize;               /* size of first argument  */
 268     int argStack;               /* stacks used by parameters */
 269
 270   }
 271 symbol;
 272
 273 /* Easy Access Macros */
 274 #define DCL_TYPE(l)  l->select.d.dcl_type
 275 #define DCL_ELEM(l)  l->select.d.num_elem
 276 #define DCL_PTR_CONST(l) l->select.d.ptr_const
 277 #define DCL_PTR_VOLATILE(l) l->select.d.ptr_volatile
 278 #define DCL_TSPEC(l) l->select.d.tspec
 279 #define SPEC_NOUN(x) x->select.s.noun
 280 #define SPEC_LONG(x) x->select.s._long
 281 #define SPEC_SHORT(x) x->select.s._short
 282 #define SPEC_USIGN(x) x->select.s._unsigned
 283 #define SPEC_SCLS(x) x->select.s.sclass
 284 #define SPEC_ENUM(x) x->select.s._isenum
 285 #define SPEC_OCLS(x) x->select.s.oclass
 286 #define SPEC_STAT(x) x->select.s._static
 287 #define SPEC_EXTR(x) x->select.s._extern
 288 #define SPEC_CODE(x) x->select.s._codesg
 289 #define SPEC_RENT(x) x->select.s._reent
 290 #define SPEC_INTN(x) x->select.s._IntNo
 291 #define SPEC_ABSA(x) x->select.s._absadr
 292 #define SPEC_BANK(x) x->select.s._regbank
 293 #define SPEC_ADDR(x) x->select.s._addr
 294 #define SPEC_STAK(x) x->select.s._stack
 295 #define SPEC_CVAL(x) x->select.s.const_val
 296 #define SPEC_BSTR(x) x->select.s._bitStart
 297 #define SPEC_BLEN(x) x->select.s._bitLength
 298 #define SPEC_BNKF(x) x->select.s._rbank
 299 #define SPEC_INTRTN(x) x->select.s._intrtn
 300 #define SPEC_CRTCL(x) x->select.s._critical
 301 #define SPEC_VOLATILE(x) x->select.s._volatile
 302 #define SPEC_CONST(x) x->select.s._const
 303 #define SPEC_STRUCT(x) x->select.s.v_struct
 304 #define SPEC_TYPEDEF(x) x->select.s._typedef
 305 #define SPEC_REGPARM(x) x->select.s._isregparm
 306 #define SPEC_NONBANKED(x) x->select.s.nonbanked
 307 #define SPEC_BANKED(x) x->select.s.banked
 308
 309 /* type check macros */
 310 #define IS_DECL(x)   ( x && x->class == DECLARATOR      )
 311 #define IS_SPEC(x)   ( x && x->class == SPECIFIER  )
 312 #define IS_ARRAY(x)  (IS_DECL(x) && DCL_TYPE(x) == ARRAY)
 313 #define IS_DATA_PTR(x) (IS_DECL(x) && DCL_TYPE(x) == POINTER)
 314 #define IS_PTR(x)    (IS_DECL(x) && (DCL_TYPE(x) == POINTER    ||    \
 315                                      DCL_TYPE(x) == FPOINTER   ||    \
 316                                      DCL_TYPE(x) == GPOINTER   ||    \
 317                                      DCL_TYPE(x) == IPOINTER   ||    \
 318                                      DCL_TYPE(x) == PPOINTER   ||    \
 319                                      DCL_TYPE(x) == EEPPOINTER ||    \
 320                                      DCL_TYPE(x) == CPOINTER   ||    \
 321                                      DCL_TYPE(x) == UPOINTER  ))
 322 #define IS_PTR_CONST(x) (IS_PTR(x) && DCL_PTR_CONST(x))
 323 #define IS_FARPTR(x) (IS_DECL(x) && DCL_TYPE(x) == FPOINTER)
 324 #define IS_GENPTR(x) (IS_DECL(x) && DCL_TYPE(x) == GPOINTER)
 325 #define IS_FUNC(x)   (IS_DECL(x) && DCL_TYPE(x) == FUNCTION)
 326 #define IS_LONG(x)   (IS_SPEC(x) && x->select.s._long)
 327 #define IS_SHORT(x)   (IS_SPEC(x) && x->select.s._short)
 328 #define IS_TYPEDEF(x)(IS_SPEC(x) && x->select.s._typedef)
 329 #define IS_CONSTANT(x)  (IS_SPEC(x) && (x->select.s.sclass == S_CONSTANT ||\
 330                                         x->select.s._const == 1))
 331 #define IS_STRUCT(x) (IS_SPEC(x) && x->select.s.noun == V_STRUCT)
 332 #define IS_ABSOLUTE(x)  (IS_SPEC(x) && x->select.s._absadr )
 333 #define IS_REGISTER(x)  (IS_SPEC(x) && SPEC_SCLS(x) == S_REGISTER)
 334 #define IS_RENT(x)   (IS_SPEC(x) && x->select.s._reent )
 335 #define IS_STATIC(x) (IS_SPEC(x) && SPEC_STAT(x))
 336 #define IS_INT(x)    (IS_SPEC(x) && x->select.s.noun == V_INT)
 337 #define IS_VOID(x)   (IS_SPEC(x) && x->select.s.noun == V_VOID)
 338 #define IS_CHAR(x)   (IS_SPEC(x) && x->select.s.noun == V_CHAR)
 339 #define IS_EXTERN(x)    (IS_SPEC(x) && x->select.s._extern)
 340 #define IS_VOLATILE(x)  (IS_SPEC(x) && x->select.s._volatile )
 341 #define IS_INTEGRAL(x) (IS_SPEC(x) && (x->select.s.noun == V_INT ||  \
 342                                        x->select.s.noun == V_CHAR || \
 343                                        x->select.s.noun == V_BIT ||  \
 344                                        x->select.s.noun == V_SBIT ))
 345 #define IS_BITFIELD(x) (IS_SPEC(x) && (x->select.s.noun == V_BIT))
 346 #define IS_BITVAR(x) (IS_SPEC(x) && (x->select.s.noun  == V_BIT ||   \
 347                                      x->select.s.noun == V_SBIT ))
 348 #define IS_FLOAT(x)  (IS_SPEC(x) && x->select.s.noun == V_FLOAT)
 349 #define IS_ARITHMETIC(x) (IS_INTEGRAL(x) || IS_FLOAT(x))
 350 #define IS_AGGREGATE(x) (IS_ARRAY(x) || IS_STRUCT(x))
 351 #define IS_LITERAL(x)   (IS_SPEC(x)  && x->select.s.sclass == S_LITERAL)
 352 #define IS_ISR(x)       (IS_SPEC(x)  && SPEC_INTRTN(x))
 353 #define IS_REGPARM(x)   (IS_SPEC(x) && SPEC_REGPARM(x))
 354 #define IS_NONBANKED(x) (IS_SPEC(x) && SPEC_NONBANKED(x))
 355 #define IS_BANKED(x)    (IS_SPEC(x) && SPEC_BANKED(x))
 356 #define IS_BANKEDCALL(x) (IS_SPEC(x) && !SPEC_NONBANKED(x) && !SPEC_STAT(x) && (options.model == MODEL_LARGE || options.model == MODEL_MEDIUM || SPEC_BANKED(x)))
 357
 358 /* forward declaration for the global vars */
 359 extern bucket *SymbolTab[];
 360 extern bucket *StructTab[];
 361 extern bucket *TypedefTab[];
 362 extern bucket *LabelTab[];
 363 extern bucket *enumTab[];
 364 extern symbol *__fsadd;
 365 extern symbol *__fssub;
 366 extern symbol *__fsmul;
 367 extern symbol *__fsdiv;
 368 extern symbol *__fseq;
 369 extern symbol *__fsneq;
 370 extern symbol *__fslt;
 371 extern symbol *__fslteq;
 372 extern symbol *__fsgt;
 373 extern symbol *__fsgteq;
 374
 375 /* Dims: mul/div/mod, BYTE/WORD/DWORD, SIGNED/UNSIGNED */
 376 extern symbol *__muldiv[3][3][2];
 377 /* Dims: BYTE/WORD/DWORD SIGNED/UNSIGNED */
 378 extern sym_link *__multypes[3][2];
 379 /* Dims: to/from float, BYTE/WORD/DWORD, SIGNED/USIGNED */
 380 extern symbol *__conv[2][3][2];
 381
 382 #define CHARTYPE        __multypes[0][0]
 383 #define UCHARTYPE       __multypes[0][1]
 384 #define INTTYPE         __multypes[1][0]
 385 #define UINTTYPE        __multypes[1][1]
 386 #define LONGTYPE        __multypes[2][0]
 387 #define ULONGTYPE       __multypes[2][1]
 388
 389
 390 extern sym_link *floatType;
 391
 392 #include "SDCCval.h"
 393
 394 /* forward definitions for the symbol table related functions */
 395 void initSymt ();
 396 symbol *newSymbol (char *, int);
 397 sym_link *newLink ();
 398 sym_link *newFloatLink ();
 399 structdef *newStruct (char *);
 400 void addDecl (symbol *, int, sym_link *);
 401 sym_link *mergeSpec (sym_link *, sym_link *);
 402 sym_link *cloneSpec (sym_link *);
 403 symbol *reverseSyms (symbol *);
 404 sym_link *reverseLink (sym_link *);
 405 symbol *copySymbol (symbol *);
 406 symbol *copySymbolChain (symbol *);
 407 void printSymChain (symbol *, int);
 408 void printStruct (structdef *, int);
 409 char *genSymName (int);
 410 sym_link *getSpec (sym_link *);
 411 char *genSymName (int);
 412 int compStructSize (int, structdef *);
 413 sym_link *copyLinkChain (sym_link *);
 414 int checkDecl (symbol *);
 415 void checkBasic (sym_link *, sym_link *);
 416 value *checkPointerIval (sym_link *, value *);
 417 value *checkStructIval (symbol *, value *);
 418 value *checkArrayIval (sym_link *, value *);
 419 value *checkIval (sym_link *, value *);
 420 unsigned int getSize (sym_link *);
 421 unsigned int bitsForType (sym_link *);
 422 sym_link *newIntLink ();
 423 sym_link *newCharLink ();
 424 sym_link *newLongLink ();
 425 int checkType (sym_link *, sym_link *);
 426 int checkFunction (symbol *);
 427 void cleanUpLevel (bucket **, int);
 428 void cleanUpBlock (bucket **, int);
 429 int funcInChain (sym_link *);
 430 void addSymChain (symbol *);
 431 sym_link *structElemType (sym_link *, value *, value **);
 432 symbol *getStructElement (structdef *, symbol *);
 433 sym_link *computeType (sym_link *, sym_link *);
 434 void processFuncArgs (symbol *, int);
 435 int isSymbolEqual (symbol *, symbol *);
 436 int powof2 (unsigned long);
 437 void printTypeChain (sym_link *, FILE *);
 438 void initCSupport ();
 439 void pointerTypes (sym_link *, sym_link *);
 440 void cdbTypeInfo (sym_link *, FILE *);
 441 void cdbSymbol (symbol *, FILE *, int, int);
 442 void cdbStructBlock (int, FILE *);
 443 void initHashT ();
 444 bucket *newBucket ();
 445 void addSym (bucket **, void *, char *, int, int);
 446 void deleteSym (bucket **, void *, char *);
 447 void *findSym (bucket **, void *, const char *);
 448 void *findSymWithLevel (bucket **, struct symbol *);
 449 void *findSymWithBlock (bucket **, struct symbol *, int);
 450 #include "SDCCmem.h"
 451
 452 #endif