symbol.h

   1 #ifndef SYMBOL_H
   2 #define SYMBOL_H
   3 /*
   4  * Basic symbol and namespace definitions.
   5  *
   6  * Copyright (C) 2003 Transmeta Corp.
   7  *               2003 Linus Torvalds
   8  *
   9  *  Licensed under the Open Software License version 1.1
  10  */
  11
  12 #include "token.h"
  13
  14 /*
  15  * An identifier with semantic meaning is a "symbol".
  16  *
  17  * There's a 1:n relationship: each symbol is always
  18  * associated with one identifier, while each identifier
  19  * can have one or more semantic meanings due to C scope
  20  * rules.
  21  *
  22  * The progression is symbol -> token -> identifier. The
  23  * token contains the information on where the symbol was
  24  * declared.
  25  */
  26 enum namespace {
  27         NS_NONE = 0,
  28         NS_MACRO = 1,
  29         NS_TYPEDEF = 2,
  30         NS_STRUCT = 4,  // Also used for unions and enums.
  31         NS_LABEL = 8,
  32         NS_SYMBOL = 16,
  33         NS_ITERATOR = 32,
  34         NS_PREPROCESSOR = 64,
  35         NS_UNDEF = 128,
  36         NS_KEYWORD = 256,
  37 };
  38
  39 enum type {
  40         SYM_UNINITIALIZED,
  41         SYM_PREPROCESSOR,
  42         SYM_BASETYPE,
  43         SYM_NODE,
  44         SYM_PTR,
  45         SYM_FN,
  46         SYM_ARRAY,
  47         SYM_STRUCT,
  48         SYM_UNION,
  49         SYM_ENUM,
  50         SYM_TYPEDEF,
  51         SYM_TYPEOF,
  52         SYM_MEMBER,
  53         SYM_BITFIELD,
  54         SYM_LABEL,
  55         SYM_RESTRICT,
  56         SYM_FOULED,
  57         SYM_KEYWORD,
  58         SYM_BAD,
  59 };
  60
  61 enum keyword {
  62         KW_SPECIFIER    = 1 << 0,
  63         KW_MODIFIER     = 1 << 1,
  64         KW_QUALIFIER    = 1 << 2,
  65         KW_ATTRIBUTE    = 1 << 3,
  66         KW_TYPEOF       = 1 << 4,
  67         KW_STATEMENT    = 1 << 5,
  68         KW_ASM          = 1 << 6,
  69         KW_MODE         = 1 << 7,
  70 };
  71
  72 struct context {
  73         struct expression *context;
  74         unsigned int in, out, out_false;
  75         int exact;
  76 };
  77
  78 extern struct context *alloc_context(void);
  79
  80 DECLARE_PTR_LIST(context_list, struct context);
  81
  82 struct ctype {
  83         unsigned long modifiers;
  84         unsigned long alignment;
  85         struct context_list *contexts;
  86         unsigned int as;
  87         struct symbol *base_type;
  88 };
  89
  90 struct symbol_op {
  91         enum keyword type;
  92         int (*evaluate)(struct expression *);
  93         int (*expand)(struct expression *, int);
  94         int (*args)(struct expression *);
  95
  96         /* keywords */
  97         struct token *(*declarator)(struct token *token, struct ctype *ctype);
  98         struct token *(*statement)(struct token *token, struct statement *stmt);
  99         struct token *(*toplevel)(struct token *token, struct symbol_list **list);
 100         struct token *(*attribute)(struct token *token, struct symbol *attr, struct ctype *ctype);
 101 };
 102
 103 extern int expand_safe_p(struct expression *expr, int cost);
 104 extern int expand_constant_p(struct expression *expr, int cost);
 105
 106 #define SYM_ATTR_WEAK           0
 107 #define SYM_ATTR_NORMAL         1
 108 #define SYM_ATTR_STRONG         2
 109
 110 struct symbol {
 111         enum type type:8;
 112         enum namespace namespace:9;
 113         unsigned char used:1, attr:2, enum_member:1, bound:1;
 114         struct position pos;            /* Where this symbol was declared */
 115         struct position endpos;         /* Where this symbol ends*/
 116         struct ident *ident;            /* What identifier this symbol is associated with */
 117         struct symbol *next_id;         /* Next semantic symbol that shares this identifier */
 118         struct symbol   *replace;       /* What is this symbol shadowed by in copy-expression */
 119         struct scope    *scope;
 120         union {
 121                 struct symbol   *same_symbol;
 122                 struct symbol   *next_subobject;
 123         };
 124
 125         struct symbol_op *op;
 126
 127         union {
 128                 struct /* NS_MACRO */ {
 129                         struct token *expansion;
 130                         struct token *arglist;
 131                         struct scope *used_in;
 132                 };
 133                 struct /* NS_PREPROCESSOR */ {
 134                         int (*handler)(struct stream *, struct token **, struct token *);
 135                         int normal;
 136                 };
 137                 struct /* NS_SYMBOL */ {
 138                         unsigned long   offset;
 139                         int             bit_size;
 140                         unsigned int    bit_offset:8,
 141                                         arg_count:10,
 142                                         variadic:1,
 143                                         initialized:1,
 144                                         examined:1,
 145                                         expanding:1,
 146                                         evaluated:1,
 147                                         string:1;
 148                         struct expression *array_size;
 149                         struct ctype ctype;
 150                         struct symbol_list *arguments;
 151                         struct statement *stmt;
 152                         struct symbol_list *symbol_list;
 153                         struct statement *inline_stmt;
 154                         struct symbol_list *inline_symbol_list;
 155                         struct expression *initializer;
 156                         struct entrypoint *ep;
 157                         long long value;                /* Initial value */
 158                 };
 159         };
 160         union /* backend */ {
 161                 struct basic_block *bb_target;  /* label */
 162                 void *aux;                      /* Auxiliary info, e.g. backend information */
 163                 struct {                        /* sparse ctags */
 164                         char kind;
 165                         unsigned char visited:1;
 166                 };
 167         };
 168         pseudo_t pseudo;
 169 };
 170
 171 /* Modifiers */
 172 #define MOD_AUTO        0x0001
 173 #define MOD_REGISTER    0x0002
 174 #define MOD_STATIC      0x0004
 175 #define MOD_EXTERN      0x0008
 176
 177 #define MOD_CONST       0x0010
 178 #define MOD_VOLATILE    0x0020
 179 #define MOD_SIGNED      0x0040
 180 #define MOD_UNSIGNED    0x0080
 181
 182 #define MOD_CHAR        0x0100
 183 #define MOD_SHORT       0x0200
 184 #define MOD_LONG        0x0400
 185 #define MOD_LONGLONG    0x0800
 186
 187 #define MOD_TYPEDEF     0x1000
 188
 189 #define MOD_INLINE      0x40000
 190 #define MOD_ADDRESSABLE 0x80000
 191
 192 #define MOD_NOCAST      0x100000
 193 #define MOD_NODEREF     0x200000
 194 #define MOD_ACCESSED    0x400000
 195 #define MOD_TOPLEVEL    0x800000        // scoping..
 196
 197 #define MOD_LABEL       0x1000000
 198 #define MOD_ASSIGNED    0x2000000
 199 #define MOD_TYPE        0x4000000
 200 #define MOD_SAFE        0x8000000       // non-null/non-trapping pointer
 201
 202 #define MOD_USERTYPE    0x10000000
 203 #define MOD_FORCE       0x20000000
 204 #define MOD_EXPLICITLY_SIGNED   0x40000000
 205 #define MOD_BITWISE     0x80000000
 206
 207 #define MOD_NONLOCAL    (MOD_EXTERN | MOD_TOPLEVEL)
 208 #define MOD_STORAGE     (MOD_AUTO | MOD_REGISTER | MOD_STATIC | MOD_EXTERN | MOD_INLINE | MOD_TOPLEVEL | MOD_FORCE)
 209 #define MOD_SIGNEDNESS  (MOD_SIGNED | MOD_UNSIGNED | MOD_EXPLICITLY_SIGNED)
 210 #define MOD_SPECIFIER   (MOD_CHAR | MOD_SHORT | MOD_LONG | MOD_LONGLONG | MOD_SIGNEDNESS)
 211 #define MOD_SIZE        (MOD_CHAR | MOD_SHORT | MOD_LONG | MOD_LONGLONG)
 212 #define MOD_IGNORE (MOD_TOPLEVEL | MOD_STORAGE | MOD_ADDRESSABLE |      \
 213         MOD_ASSIGNED | MOD_USERTYPE | MOD_ACCESSED | MOD_EXPLICITLY_SIGNED)
 214 #define MOD_PTRINHERIT (MOD_VOLATILE | MOD_CONST | MOD_NODEREF | MOD_STORAGE)
 215
 216
 217 /* Current parsing/evaluation function */
 218 extern struct symbol *current_fn;
 219
 220 /* Abstract types */
 221 extern struct symbol    int_type,
 222                         fp_type;
 223
 224 /* C types */
 225 extern struct symbol    bool_ctype, void_ctype, type_ctype,
 226                         char_ctype, schar_ctype, uchar_ctype,
 227                         short_ctype, sshort_ctype, ushort_ctype,
 228                         int_ctype, sint_ctype, uint_ctype,
 229                         long_ctype, slong_ctype, ulong_ctype,
 230                         llong_ctype, sllong_ctype, ullong_ctype,
 231                         float_ctype, double_ctype, ldouble_ctype,
 232                         string_ctype, ptr_ctype, lazy_ptr_ctype,
 233                         incomplete_ctype, label_ctype, bad_ctype,
 234                         null_ctype;
 235
 236 /* Special internal symbols */
 237 extern struct symbol    zero_int;
 238
 239 #define __IDENT(n,str,res) \
 240         extern struct ident n
 241 #include "ident-list.h"
 242
 243 #define symbol_is_typename(sym) ((sym)->type == SYM_TYPE)
 244
 245 extern struct symbol_list *translation_unit_used_list;
 246
 247 extern void access_symbol(struct symbol *);
 248
 249 extern const char * type_difference(struct ctype *c1, struct ctype *c2,
 250         unsigned long mod1, unsigned long mod2);
 251
 252 extern struct symbol *lookup_symbol(struct ident *, enum namespace);
 253 extern struct symbol *create_symbol(int stream, const char *name, int type, int namespace);
 254 extern void init_symbols(void);
 255 extern void init_ctype(void);
 256 extern struct symbol *alloc_symbol(struct position, int type);
 257 extern void show_type(struct symbol *);
 258 extern const char *modifier_string(unsigned long mod);
 259 extern void show_symbol(struct symbol *);
 260 extern int show_symbol_expr_init(struct symbol *sym);
 261 extern void show_type_list(struct symbol *);
 262 extern void show_symbol_list(struct symbol_list *, const char *);
 263 extern void add_symbol(struct symbol_list **, struct symbol *);
 264 extern void bind_symbol(struct symbol *, struct ident *, enum namespace);
 265
 266 extern struct symbol *examine_symbol_type(struct symbol *);
 267 extern struct symbol *examine_pointer_target(struct symbol *);
 268 extern void examine_simple_symbol_type(struct symbol *);
 269 extern const char *show_typename(struct symbol *sym);
 270 extern const char *builtin_typename(struct symbol *sym);
 271 extern const char *builtin_ctypename(struct ctype *ctype);
 272 extern const char* get_type_name(enum type type);
 273
 274 extern void debug_symbol(struct symbol *);
 275 extern void merge_type(struct symbol *sym, struct symbol *base_type);
 276 extern void check_declaration(struct symbol *sym);
 277
 278 static inline struct symbol *get_base_type(const struct symbol *sym)
 279 {
 280         return examine_symbol_type(sym->ctype.base_type);
 281 }
 282
 283 static inline int is_int_type(const struct symbol *type)
 284 {
 285         if (type->type == SYM_NODE)
 286                 type = type->ctype.base_type;
 287         if (type->type == SYM_ENUM)
 288                 type = type->ctype.base_type;
 289         return type->type == SYM_BITFIELD ||
 290                type->ctype.base_type == &int_type;
 291 }
 292
 293 static inline int is_enum_type(const struct symbol *type)
 294 {
 295         if (type->type == SYM_NODE)
 296                 type = type->ctype.base_type;
 297         return (type->type == SYM_ENUM);
 298 }
 299
 300 static inline int get_sym_type(struct symbol *type)
 301 {
 302         if (type->type == SYM_NODE)
 303                 type = type->ctype.base_type;
 304         if (type->type == SYM_ENUM)
 305                 type = type->ctype.base_type;
 306         return type->type;
 307 }
 308
 309 static inline struct symbol *lookup_keyword(struct ident *ident, enum namespace ns)
 310 {
 311         if (!ident->keyword)
 312                 return NULL;
 313         return lookup_symbol(ident, ns);
 314 }
 315
 316 #define is_restricted_type(type) (get_sym_type(type) == SYM_RESTRICT)
 317 #define is_fouled_type(type) (get_sym_type(type) == SYM_FOULED)
 318 #define is_bitfield_type(type)   (get_sym_type(type) == SYM_BITFIELD)
 319 extern int is_ptr_type(struct symbol *);
 320
 321 void create_fouled(struct symbol *type);
 322 struct symbol *befoul(struct symbol *type);
 323
 324 #endif /* SYMBOL_H */