1 /*-------------------------------------------------------------------------
2 SDCCsymt.h - Header file for Symbols table related structures and MACRO's.
3 Written By - Sandeep Dutta . sandeep.dutta@usa.net (1998)
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
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.
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.
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 -------------------------------------------------------------------------*/
27 #define MAX_NEST_LEVEL 256
28 #define SDCC_SYMNAME_MAX 64
29 #define SDCC_NAME_MAX 3*SDCC_SYMNAME_MAX // big enough for _<func>_<var>_etc
30 #include "SDCChasht.h"
31 #include "SDCCglobl.h"
55 // values for first byte of generic pointer.
59 #define GPTYPE_XSTACK 3
60 #define GPTYPE_GPTR 4 // Never used?
61 #define GPTYPE_IDATA 5
63 #define HASHTAB_SIZE 256
65 /* hash table bucket */
68 void *sym; /* pointer to the object */
69 char name[SDCC_NAME_MAX + 1]; /* name of this symbol */
70 int level; /* nest level for this symbol */
71 int block; /* belongs to which block */
72 struct bucket *prev; /* ptr 2 previous bucket */
73 struct bucket *next; /* ptr 2 next bucket */
77 typedef struct structdef
79 char tag[SDCC_NAME_MAX + 1]; /* tag part of structure */
80 unsigned char level; /* Nesting level */
81 struct symbol *fields; /* pointer to fields */
82 unsigned size; /* sizeof the table in bytes */
86 /* noun definitions */
122 /* specifier is the last in the type-chain */
123 typedef struct specifier
125 NOUN noun; /* CHAR INT STRUCTURE LABEL */
126 STORAGE_CLASS sclass; /* REGISTER,AUTO,FIX,CONSTANT */
127 struct memmap *oclass; /* output storage class */
128 unsigned _long:1; /* 1=long */
129 unsigned _short:1; /* 1=short int */
130 unsigned _unsigned:1; /* 1=unsigned, 0=signed */
131 unsigned _signed:1; /* just for sanity checks only*/
132 unsigned _static:1; /* 1=static keyword found */
133 unsigned _extern:1; /* 1=extern found */
134 unsigned _absadr:1; /* absolute address specfied */
135 unsigned _volatile:1; /* is marked as volatile */
136 unsigned _const:1; /* is a constant */
137 unsigned _typedef:1; /* is typedefed */
138 unsigned _isregparm:1; /* is the first parameter */
139 unsigned _isenum:1; /* is an enumerated type */
140 unsigned _addr; /* address of symbol */
141 unsigned _stack; /* stack offset for stacked v */
142 unsigned _bitStart; /* bit start position */
143 int _bitLength; /* bit length */
144 int argreg; /* reg no for regparm */
146 { /* Values if constant or enum */
147 TYPE_WORD v_int; /* 2 bytes: int and char values */
148 char *v_char; /* character string */
149 TYPE_UWORD v_uint; /* 2 bytes: unsigned int const value */
150 TYPE_DWORD v_long; /* 4 bytes: long constant value */
151 TYPE_UDWORD v_ulong; /* 4 bytes: unsigned long constant val */
152 double v_float; /* floating point constant value */
153 struct symbol *v_enum; /* ptr 2 enum_list if enum==1 */
156 struct structdef *v_struct; /* structure pointer */
160 /* types of declarators */
163 POINTER = 0, /* pointer to near data */
164 FPOINTER, /* pointer to far data */
165 CPOINTER, /* pointer to code space */
166 GPOINTER, /* _generic pointer */
167 PPOINTER, /* paged area pointer */
168 IPOINTER, /* pointer to upper 128 bytes */
169 UPOINTER, /* unknown pointer used only when parsing */
170 EEPPOINTER, /* pointer to eeprom */
176 typedef struct declarator
178 DECLARATOR_TYPE dcl_type; /* POINTER,ARRAY or FUNCTION */
179 unsigned int num_elem; /* # of elems if type==array */
180 short ptr_const:1; /* pointer is constant */
181 short ptr_volatile:1; /* pointer is volatile */
182 struct sym_link *tspec; /* pointer type specifier */
189 typedef struct sym_link
191 unsigned class:1; /* DECLARATOR or SPECIFIER */
192 unsigned tdef:1; /* current link created by */
193 /* typedef if this flag is set */
196 specifier s; /* if CLASS == SPECIFIER */
197 declarator d; /* if CLASS == DECLARATOR */
200 /* function attributes */
202 struct value *args; /* the defined arguments */
203 unsigned hasVargs:1; /* functions has varargs */
204 unsigned calleeSaves:1; /* functions uses callee save */
205 unsigned hasbody:1; /* function body defined */
206 //unsigned ret:1; /* return statement for a function */
207 unsigned hasFcall:1; /* does it call other functions */
208 unsigned reent:1; /* function is reentrant */
209 unsigned naked:1; /* naked function */
211 unsigned nonbanked:1; /* function has the nonbanked attribute */
212 unsigned banked:1; /* function has the banked attribute */
213 unsigned critical:1; /* critical function */
214 unsigned intrtn:1; /* this is an interrupt routin */
215 unsigned rbank:1; /* seperate register bank */
216 unsigned intno; /* 1=Interrupt svc routine */
217 unsigned regbank; /* register bank 2b used */
218 unsigned builtin; /* is a builtin function */
219 unsigned javaNative; /* is a JavaNative Function (TININative ONLY) */
220 unsigned overlay; /* force parameters & locals into overlay segment */
221 unsigned hasStackParms; /* function has parameters on stack */
224 struct sym_link *next; /* next element on the chain */
228 typedef struct symbol
230 char name[SDCC_SYMNAME_MAX + 1]; /* Input Variable Name */
231 char rname[SDCC_NAME_MAX + 1]; /* internal name */
233 short level; /* declration lev,fld offset */
234 short block; /* sequential block # of defintion */
236 unsigned implicit:1; /* implicit flag */
237 unsigned undefined:1; /* undefined variable */
238 unsigned _isparm:1; /* is a parameter */
239 unsigned ismyparm:1; /* is parameter of the function being generated */
240 unsigned isitmp:1; /* is an intermediate temp */
241 unsigned islbl:1; /* is a temporary label */
242 unsigned isref:1; /* has been referenced */
243 unsigned isind:1; /* is a induction variable */
244 unsigned isinvariant:1; /* is a loop invariant */
245 unsigned cdef:1; /* compiler defined symbol */
246 unsigned addrtaken:1; /* address of the symbol was taken */
247 unsigned isreqv:1; /* is the register quivalent of a symbol */
248 unsigned udChked:1; /* use def checking has been already done */
250 /* following flags are used by the backend
251 for code generation and can be changed
252 if a better scheme for backend is thought of */
253 unsigned isLiveFcall:1; /* is live at or across a function call */
254 unsigned isspilt:1; /* has to be spilt */
255 unsigned spillA:1; /* spilt be register allocator */
256 unsigned remat:1; /* can be remateriazed */
257 unsigned isptr:1; /* is a pointer */
258 unsigned uptr:1; /* used as a pointer */
259 unsigned isFree:1; /* used by register allocator */
260 unsigned islocal:1; /* is a local variable */
261 unsigned blockSpil:1; /* spilt at block level */
262 unsigned remainSpil:1; /* spilt because not used in remainder */
263 unsigned stackSpil:1; /* has been spilt on temp stack location */
264 unsigned onStack:1; /* this symbol allocated on the stack */
265 unsigned iaccess:1; /* indirect access */
266 unsigned ruonly:1; /* used in return statement only */
267 unsigned spildir:1; /* spilt in direct space */
268 unsigned ptrreg:1; /* this symbol assigned to a ptr reg */
269 unsigned noSpilLoc:1; /* cannot be assigned a spil location */
270 unsigned isstrlit; /* is a string literal and it's usage count */
271 unsigned accuse; /* can be left in the accumulator
272 On the Z80 accuse is devided into
273 ACCUSE_A and ACCUSE_HL as the idea
276 unsigned dptr; /* 8051 variants with multiple DPTRS
277 currently implemented in DS390 only
279 int allocreq ; /* allocation is required for this variable */
280 int stack; /* offset on stack */
281 int xstack; /* offset on xternal stack */
282 short nRegs; /* number of registers required */
283 short regType; /* type of register required */
285 struct regs *regs[4]; /* can have at the most 4 registers */
286 struct asmop *aop; /* asmoperand for this symbol */
287 struct iCode *fuse; /* furthest use */
288 struct iCode *rematiCode; /* rematerialse with which instruction */
289 struct operand *reqv; /* register equivalent of a local variable */
292 struct symbol *spillLoc; /* register spil location */
293 struct set *itmpStack; /* symbols spilt @ this stack location */
296 short bitVar; /* this is a bit variable */
297 unsigned offset; /* offset from top if struct */
299 int lineDef; /* defined line number */
300 int lastLine; /* for functions the last line */
301 struct sym_link *type; /* 1st link to declator chain */
302 struct sym_link *etype; /* last link to declarator chn */
303 struct symbol *next; /* crosslink to next symbol */
304 struct symbol *localof; /* local variable of which function */
305 struct initList *ival; /* ptr to initializer if any */
306 struct bitVect *defs; /* bit vector for definitions */
307 struct bitVect *uses; /* bit vector for uses */
308 struct bitVect *regsUsed; /* for functions registers used */
309 int liveFrom; /* live from iCode sequence number */
310 int liveTo; /* live to sequence number */
311 int used; /* no. of times this was used */
312 int recvSize; /* size of first argument */
313 struct bitVect *clashes; /* overlaps with what other symbols */
317 /* Easy Access Macros */
318 #define DCL_TYPE(l) l->select.d.dcl_type
319 #define DCL_ELEM(l) l->select.d.num_elem
320 #define DCL_PTR_CONST(l) l->select.d.ptr_const
321 #define DCL_PTR_VOLATILE(l) l->select.d.ptr_volatile
322 #define DCL_TSPEC(l) l->select.d.tspec
324 #define FUNC_DEBUG //assert(IS_FUNC(x));
325 #define FUNC_HASVARARGS(x) (x->funcAttrs.hasVargs)
326 #define IFFUNC_HASVARARGS(x) (IS_FUNC(x) && FUNC_HASVARARGS(x))
327 #define FUNC_ARGS(x) (x->funcAttrs.args)
328 #define IFFUNC_ARGS(x) (IS_FUNC(x) && FUNC_ARGS(x))
329 #define FUNC_HASFCALL(x) (x->funcAttrs.hasFcall)
330 #define IFFUNC_HASFCALL(x) (IS_FUNC(x) && FUNC_HASFCALL(x))
331 #define FUNC_HASBODY(x) (x->funcAttrs.hasbody)
332 #define IFFUNC_HASBODY(x) (IS_FUNC(x) && FUNC_HASBODY(x))
333 #define FUNC_CALLEESAVES(x) (x->funcAttrs.calleeSaves)
334 #define IFFUNC_CALLEESAVES(x) (IS_FUNC(x) && FUNC_CALLEESAVES(x))
335 #define FUNC_ISISR(x) (x->funcAttrs.intrtn)
336 #define IFFUNC_ISISR(x) (IS_FUNC(x) && FUNC_ISISR(x))
337 #define IFFUNC_RBANK(x) (IS_FUNC(x) && FUNC_RBANK(x))
338 #define FUNC_INTNO(x) (x->funcAttrs.intno)
339 #define FUNC_REGBANK(x) (x->funcAttrs.regbank)
340 #define FUNC_HASSTACKPARM(x) (x->funcAttrs.hasStackParms)
342 #define FUNC_ISREENT(x) (x->funcAttrs.reent)
343 #define IFFUNC_ISREENT(x) (IS_FUNC(x) && FUNC_ISREENT(x))
344 #define FUNC_ISNAKED(x) (x->funcAttrs.naked)
345 #define IFFUNC_ISNAKED(x) (IS_FUNC(x) && FUNC_ISNAKED(x))
346 #define FUNC_NONBANKED(x) (x->funcAttrs.nonbanked)
347 #define IFFUNC_NONBANKED(x) (IS_FUNC(x) && FUNC_NONBANKED(x))
348 #define FUNC_BANKED(x) (x->funcAttrs.banked)
349 #define IFFUNC_BANKED(x) (IS_FUNC(x) && FUNC_BANKED(x))
350 #define FUNC_ISCRITICAL(x) (x->funcAttrs.critical)
351 #define IFFUNC_ISCRITICAL(x) (IS_FUNC(x) && FUNC_ISCRITICAL(x))
352 #define FUNC_ISBUILTIN(x) (x->funcAttrs.builtin)
353 #define IFFUNC_ISBUILTIN(x) (IS_FUNC(x) && FUNC_ISBUILTIN(x))
354 #define FUNC_ISJAVANATIVE(x) (x->funcAttrs.javaNative)
355 #define IFFUNC_ISJAVANATIVE(x) (IS_FUNC(x) && FUNC_ISJAVANATIVE(x))
356 #define FUNC_ISOVERLAY(x) (x->funcAttrs.overlay)
357 #define IFFUNC_ISOVERLAY(x) (IS_FUNC(x) && FUNC_ISOVERLAY(x))
360 // jwk: I am not sure about this
361 #define IFFUNC_ISBANKEDCALL(x) (!IFFUNC_NONBANKED(x) && \
362 (options.model == MODEL_LARGE || \
363 options.model == MODEL_MEDIUM || \
366 #define SPEC_NOUN(x) x->select.s.noun
367 #define SPEC_LONG(x) x->select.s._long
368 #define SPEC_USIGN(x) x->select.s._unsigned
369 #define SPEC_SCLS(x) x->select.s.sclass
370 #define SPEC_ENUM(x) x->select.s._isenum
371 #define SPEC_OCLS(x) x->select.s.oclass
372 #define SPEC_STAT(x) x->select.s._static
373 #define SPEC_EXTR(x) x->select.s._extern
374 #define SPEC_CODE(x) x->select.s._codesg
375 #define SPEC_ABSA(x) x->select.s._absadr
376 #define SPEC_BANK(x) x->select.s._regbank
377 #define SPEC_ADDR(x) x->select.s._addr
378 #define SPEC_STAK(x) x->select.s._stack
379 #define SPEC_CVAL(x) x->select.s.const_val
380 #define SPEC_BSTR(x) x->select.s._bitStart
381 #define SPEC_BLEN(x) x->select.s._bitLength
383 /* Sleaze: SPEC_ISR_SAVED_BANKS is only used on
384 * function type symbols, which obviously cannot
385 * be of BIT type. Therefore, we recycle the
386 * _bitStart field instead of defining a new field.
388 #define SPEC_ISR_SAVED_BANKS(x) x->select.s._bitStart
389 #define SPEC_VOLATILE(x) x->select.s._volatile
390 #define SPEC_CONST(x) x->select.s._const
391 #define SPEC_STRUCT(x) x->select.s.v_struct
392 #define SPEC_TYPEDEF(x) x->select.s._typedef
393 #define SPEC_REGPARM(x) x->select.s._isregparm
394 #define SPEC_ARGREG(x) x->select.s.argreg
396 /* type check macros */
397 #define IS_DECL(x) ( x && x->class == DECLARATOR )
398 #define IS_SPEC(x) ( x && x->class == SPECIFIER )
399 #define IS_ARRAY(x) (IS_DECL(x) && DCL_TYPE(x) == ARRAY)
400 #define IS_DATA_PTR(x) (IS_DECL(x) && DCL_TYPE(x) == POINTER)
401 #define IS_PTR(x) (IS_DECL(x) && (DCL_TYPE(x) == POINTER || \
402 DCL_TYPE(x) == FPOINTER || \
403 DCL_TYPE(x) == GPOINTER || \
404 DCL_TYPE(x) == IPOINTER || \
405 DCL_TYPE(x) == PPOINTER || \
406 DCL_TYPE(x) == EEPPOINTER || \
407 DCL_TYPE(x) == CPOINTER || \
408 DCL_TYPE(x) == UPOINTER ))
409 #define IS_PTR_CONST(x) (IS_PTR(x) && DCL_PTR_CONST(x))
410 #define IS_FARPTR(x) (IS_DECL(x) && DCL_TYPE(x) == FPOINTER)
411 #define IS_CODEPTR(x) (IS_DECL(x) && DCL_TYPE(x) == CPOINTER)
412 #define IS_GENPTR(x) (IS_DECL(x) && DCL_TYPE(x) == GPOINTER)
413 #define IS_FUNC(x) (IS_DECL(x) && DCL_TYPE(x) == FUNCTION)
414 #define IS_LONG(x) (IS_SPEC(x) && x->select.s._long)
415 #define IS_UNSIGNED(x) (IS_SPEC(x) && x->select.s._unsigned)
416 #define IS_TYPEDEF(x)(IS_SPEC(x) && x->select.s._typedef)
417 #define IS_CONSTANT(x) (IS_SPEC(x) && ( x->select.s._const == 1))
418 #define IS_STRUCT(x) (IS_SPEC(x) && x->select.s.noun == V_STRUCT)
419 #define IS_ABSOLUTE(x) (IS_SPEC(x) && x->select.s._absadr )
420 #define IS_REGISTER(x) (IS_SPEC(x) && SPEC_SCLS(x) == S_REGISTER)
421 #define IS_RENT(x) (IS_SPEC(x) && x->select.s._reent )
422 #define IS_STATIC(x) (IS_SPEC(x) && SPEC_STAT(x))
423 #define IS_INT(x) (IS_SPEC(x) && x->select.s.noun == V_INT)
424 #define IS_VOID(x) (IS_SPEC(x) && x->select.s.noun == V_VOID)
425 #define IS_CHAR(x) (IS_SPEC(x) && x->select.s.noun == V_CHAR)
426 #define IS_EXTERN(x) (IS_SPEC(x) && x->select.s._extern)
427 #define IS_VOLATILE(x) (IS_SPEC(x) && x->select.s._volatile )
428 #define IS_INTEGRAL(x) (IS_SPEC(x) && (x->select.s.noun == V_INT || \
429 x->select.s.noun == V_CHAR || \
430 x->select.s.noun == V_BIT || \
431 x->select.s.noun == V_SBIT ))
432 #define IS_BITFIELD(x) (IS_SPEC(x) && (x->select.s.noun == V_BIT))
433 #define IS_BITVAR(x) (IS_SPEC(x) && (x->select.s.noun == V_BIT || \
434 x->select.s.noun == V_SBIT ))
435 #define IS_FLOAT(x) (IS_SPEC(x) && x->select.s.noun == V_FLOAT)
436 #define IS_ARITHMETIC(x) (IS_INTEGRAL(x) || IS_FLOAT(x))
437 #define IS_AGGREGATE(x) (IS_ARRAY(x) || IS_STRUCT(x))
438 #define IS_LITERAL(x) (IS_SPEC(x) && x->select.s.sclass == S_LITERAL)
439 #define IS_CODE(x) (IS_SPEC(x) && SPEC_SCLS(x) == S_CODE)
440 #define IS_REGPARM(x) (IS_SPEC(x) && SPEC_REGPARM(x))
442 /* forward declaration for the global vars */
443 extern bucket *SymbolTab[];
444 extern bucket *StructTab[];
445 extern bucket *TypedefTab[];
446 extern bucket *LabelTab[];
447 extern bucket *enumTab[];
448 extern symbol *__fsadd;
449 extern symbol *__fssub;
450 extern symbol *__fsmul;
451 extern symbol *__fsdiv;
452 extern symbol *__fseq;
453 extern symbol *__fsneq;
454 extern symbol *__fslt;
455 extern symbol *__fslteq;
456 extern symbol *__fsgt;
457 extern symbol *__fsgteq;
459 /* Dims: mul/div/mod, BYTE/WORD/DWORD, SIGNED/UNSIGNED */
460 extern symbol *__muldiv[3][3][2];
461 /* Dims: BYTE/WORD/DWORD SIGNED/UNSIGNED */
462 extern sym_link *__multypes[3][2];
463 /* Dims: to/from float, BYTE/WORD/DWORD, SIGNED/USIGNED */
464 extern symbol *__conv[2][3][2];
465 /* Dims: shift left/shift right, BYTE/WORD/DWORD, SIGNED/UNSIGNED */
466 extern symbol *__rlrr[2][3][2];
468 #define CHARTYPE __multypes[0][0]
469 #define UCHARTYPE __multypes[0][1]
470 #define INTTYPE __multypes[1][0]
471 #define UINTTYPE __multypes[1][1]
472 #define LONGTYPE __multypes[2][0]
473 #define ULONGTYPE __multypes[2][1]
476 extern sym_link *floatType;
480 /* forward definitions for the symbol table related functions */
482 symbol *newSymbol (char *, int);
483 sym_link *newLink ();
484 sym_link *newFloatLink ();
485 structdef *newStruct (char *);
486 void addDecl (symbol *, int, sym_link *);
487 sym_link *mergeSpec (sym_link *, sym_link *, char *name);
488 sym_link *cloneSpec (sym_link *);
489 symbol *reverseSyms (symbol *);
490 sym_link *reverseLink (sym_link *);
491 symbol *copySymbol (symbol *);
492 symbol *copySymbolChain (symbol *);
493 void printSymChain (symbol *, int);
494 void printStruct (structdef *, int);
495 char *genSymName (int);
496 sym_link *getSpec (sym_link *);
497 char *genSymName (int);
498 int compStructSize (int, structdef *);
499 sym_link *copyLinkChain (sym_link *);
500 int checkDecl (symbol *, int);
501 void checkBasic (sym_link *, sym_link *);
502 value *checkPointerIval (sym_link *, value *);
503 value *checkStructIval (symbol *, value *);
504 value *checkArrayIval (sym_link *, value *);
505 value *checkIval (sym_link *, value *);
506 unsigned int getSize (sym_link *);
507 unsigned int bitsForType (sym_link *);
508 sym_link *newIntLink ();
509 sym_link *newCharLink ();
510 sym_link *newLongLink ();
511 int compareType (sym_link *, sym_link *);
512 int checkFunction (symbol *, symbol *);
513 void cleanUpLevel (bucket **, int);
514 void cleanUpBlock (bucket **, int);
515 int funcInChain (sym_link *);
516 void addSymChain (symbol *);
517 sym_link *structElemType (sym_link *, value *);
518 symbol *getStructElement (structdef *, symbol *);
519 sym_link *computeType (sym_link *, sym_link *);
520 void processFuncArgs (symbol *);
521 int isSymbolEqual (symbol *, symbol *);
522 int powof2 (unsigned long);
523 void printTypeChain (sym_link *, FILE *);
524 void initCSupport ();
525 void initBuiltIns ();
526 void pointerTypes (sym_link *, sym_link *);
527 void cdbTypeInfo (sym_link *, FILE *);
528 void cdbSymbol (symbol *, FILE *, int, int);
529 void cdbStructBlock (int, FILE *);
531 bucket *newBucket ();
532 void addSym (bucket **, void *, char *, int, int, int checkType);
533 void deleteSym (bucket **, void *, char *);
534 void *findSym (bucket **, void *, const char *);
535 void *findSymWithLevel (bucket **, struct symbol *);
536 void *findSymWithBlock (bucket **, struct symbol *, int);
537 void changePointer (symbol * sym);
538 void checkTypeSanity(sym_link *etype, char *name);
539 sym_link *typeFromStr (char *) ;
542 extern char *nounName(sym_link *); /* noun strings */
543 extern void printFromToType (sym_link *, sym_link *);