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