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  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25  * THE SOFTWARE.
  26  */
  27
  28 #include "token.h"
  29 #include "target.h"
  30
  31 /*
  32  * An identifier with semantic meaning is a "symbol".
  33  *
  34  * There's a 1:n relationship: each symbol is always
  35  * associated with one identifier, while each identifier
  36  * can have one or more semantic meanings due to C scope
  37  * rules.
  38  *
  39  * The progression is symbol -> token -> identifier. The
  40  * token contains the information on where the symbol was
  41  * declared.
  42  */
  43 enum namespace {
  44         NS_NONE = 0,
  45         NS_MACRO = 1,
  46         NS_TYPEDEF = 2,
  47         NS_STRUCT = 4,  // Also used for unions and enums.
  48         NS_LABEL = 8,
  49         NS_SYMBOL = 16,
  50         NS_ITERATOR = 32,
  51         NS_PREPROCESSOR = 64,
  52         NS_UNDEF = 128,
  53         NS_KEYWORD = 256,
  54 };
  55
  56 enum type {
  57         SYM_UNINITIALIZED,
  58         SYM_PREPROCESSOR,
  59         SYM_BASETYPE,
  60         SYM_NODE,
  61         SYM_PTR,
  62         SYM_FN,
  63         SYM_ARRAY,
  64         SYM_STRUCT,
  65         SYM_UNION,
  66         SYM_ENUM,
  67         SYM_TYPEOF,
  68         SYM_BITFIELD,
  69         SYM_LABEL,
  70         SYM_RESTRICT,
  71         SYM_FOULED,
  72         SYM_KEYWORD,
  73         SYM_BAD,
  74 };
  75
  76 enum keyword {
  77         KW_SPECIFIER    = 1 << 0,
  78         KW_MODIFIER     = 1 << 1,
  79         KW_QUALIFIER    = 1 << 2,
  80         KW_ATTRIBUTE    = 1 << 3,
  81         KW_BUILTIN      = 1 << 4,
  82         KW_ASM          = 1 << 5,
  83         KW_MODE         = 1 << 6,
  84         KW_STATIC       = 1 << 7,
  85      // KW UNUSED       = 1 << 8,
  86         KW_EXACT        = 1 << 9,
  87 };
  88
  89 struct context {
  90         struct expression *context;
  91         unsigned int in, out;
  92 };
  93
  94 extern struct context *alloc_context(void);
  95
  96 DECLARE_PTR_LIST(context_list, struct context);
  97
  98 struct ctype {
  99         struct symbol *base_type;
 100         unsigned long modifiers;
 101         unsigned long alignment;
 102         struct context_list *contexts;
 103         struct ident *as;
 104 };
 105
 106 struct decl_state {
 107         struct ctype ctype;
 108         struct ident **ident;
 109         struct symbol_op *mode;
 110         unsigned long f_modifiers;              // function attributes
 111         unsigned long storage_class;
 112         unsigned char prefer_abstract;
 113         unsigned char autotype;
 114         unsigned char forced;
 115 };
 116
 117 struct pseudo;
 118 struct entrypoint;
 119 struct arg;
 120
 121 struct symbol_op {
 122         enum keyword type;
 123         int (*evaluate)(struct expression *);
 124         int (*expand)(struct expression *, int);
 125         int (*args)(struct expression *);
 126         struct pseudo *(*linearize)(struct entrypoint *, struct expression *);
 127
 128         /* keywords */
 129         struct token *(*declarator)(struct token *token, struct symbol *, struct decl_state *ctx);
 130         struct token *(*statement)(struct token *token, struct statement *stmt);
 131         struct token *(*toplevel)(struct token *token, struct symbol_list **list);
 132         struct token *(*attribute)(struct token *token, struct symbol *attr, struct decl_state *ctx);
 133         struct symbol *(*to_mode)(struct symbol *);
 134         void (*asm_modifier)(struct token *token, unsigned long *mods, unsigned long mod);
 135
 136         int test, set, class;
 137 };
 138
 139
 140 #define SYM_ATTR_WEAK           0
 141 #define SYM_ATTR_NORMAL         1
 142 #define SYM_ATTR_STRONG         2
 143
 144 struct symbol {
 145         enum type type:8;
 146         enum namespace namespace:9;
 147         unsigned char used:1, attr:2, enum_member:1, bound:1, parsed:1;
 148         struct position pos;            /* Where this symbol was declared */
 149         struct position endpos;         /* Where this symbol ends*/
 150         struct ident *ident;            /* What identifier this symbol is associated with */
 151         struct symbol *next_id;         /* Next semantic symbol that shares this identifier */
 152         struct symbol   *replace;       /* What is this symbol shadowed by in copy-expression */
 153         struct scope    *scope;
 154         union {
 155                 struct symbol   *same_symbol;
 156                 struct symbol   *next_subobject;
 157         };
 158
 159         struct symbol_op *op;
 160
 161         union {
 162                 struct /* NS_MACRO */ {
 163                         struct token *expansion;
 164                         struct token *arglist;
 165                         struct scope *used_in;
 166                         void (*expand_simple)(struct token *);
 167                         bool (*expand)(struct token *, struct arg *args);
 168                 };
 169                 struct /* NS_PREPROCESSOR */ {
 170                         int (*handler)(struct stream *, struct token **, struct token *);
 171                         int normal;
 172                 };
 173                 struct /* NS_LABEL */ {
 174                         struct scope *label_scope;
 175                         struct position label_pos;
 176                         unsigned long label_modifiers;
 177                 };
 178                 struct /* NS_SYMBOL */ {
 179                         unsigned long   offset;
 180                         int             bit_size;
 181                         unsigned int    bit_offset:8,
 182                                         bogus_linear:1,
 183                                         variadic:1,
 184                                         initialized:1,
 185                                         examined:1,
 186                                         expanding:1,
 187                                         evaluated:1,
 188                                         string:1,
 189                                         designated_init:1,
 190                                         forced_arg:1,
 191                                         accessed:1,
 192                                         builtin:1,
 193                                         torename:1,
 194                                         transparent_union:1;
 195                         int             rank:3; // arithmetic's rank
 196                         struct expression *array_size;
 197                         struct ctype ctype;
 198                         struct symbol_list *arguments;
 199                         struct statement *stmt;
 200                         struct symbol_list *symbol_list;
 201                         struct statement *inline_stmt;
 202                         struct symbol_list *inline_symbol_list;
 203                         struct expression *initializer;
 204                         struct entrypoint *ep;
 205                         struct symbol *definition;
 206                 };
 207         };
 208         union /* backend */ {
 209                 struct basic_block *bb_target;  /* label */
 210                 void *aux;                      /* Auxiliary info, e.g. backend information */
 211                 struct {
 212                         char kind;              /* used by ctags & dissect */
 213                         unsigned char visited:1;
 214                         unsigned char inspected:1;
 215                 };
 216         };
 217         pseudo_t pseudo;
 218 };
 219
 220 /* Modifiers */
 221 #define MOD_AUTO                0x00000001
 222 #define MOD_REGISTER            0x00000002
 223 #define MOD_STATIC              0x00000004
 224 #define MOD_EXTERN              0x00000008
 225 #define MOD_TOPLEVEL            0x00000010      // scoping..
 226 #define MOD_TLS                 0x00000020
 227 #define MOD_ASM_GOTO            MOD_TLS         // never used together
 228 #define MOD_INLINE              0x00000040
 229
 230 #define MOD_ASSIGNED            0x00000080
 231 #define MOD_ADDRESSABLE         0x00000100
 232
 233 #define MOD_CONST               0x00000200
 234 #define MOD_VOLATILE            0x00000400
 235 #define MOD_RESTRICT            0x00000800
 236 #define MOD_ATOMIC              0x00001000
 237
 238 #define MOD_SIGNED              0x00002000
 239 #define MOD_UNSIGNED            0x00004000
 240 #define MOD_EXPLICITLY_SIGNED   0x00008000
 241
 242 #define MOD_GNU_INLINE          0x00010000
 243 #define MOD_USERTYPE            0x00020000
 244      // MOD UNUSED              0x00040000
 245      // MOD UNUSED              0x00080000
 246      // MOD UNUSED              0x00100000
 247      // MOD UNUSED              0x00200000
 248
 249 #define MOD_UNUSED              0x00400000
 250 #define MOD_SAFE                0x00800000      // non-null/non-trapping pointer
 251 #define MOD_PURE                0x01000000
 252 #define MOD_BITWISE             0x02000000
 253 #define MOD_NOCAST              0x04000000
 254 #define MOD_NODEREF             0x08000000
 255 #define MOD_NORETURN            0x10000000
 256 #define MOD_EXT_VISIBLE         0x20000000
 257
 258
 259 #define MOD_ACCESS      (MOD_ASSIGNED | MOD_ADDRESSABLE)
 260 #define MOD_NONLOCAL    (MOD_EXTERN | MOD_TOPLEVEL)
 261 #define MOD_STORAGE     (MOD_AUTO | MOD_REGISTER | MOD_STATIC | MOD_EXTERN | MOD_INLINE | MOD_TOPLEVEL)
 262 #define MOD_ESIGNED     (MOD_SIGNED | MOD_EXPLICITLY_SIGNED)
 263 #define MOD_SIGNEDNESS  (MOD_SIGNED | MOD_UNSIGNED | MOD_EXPLICITLY_SIGNED)
 264 #define MOD_SPECIFIER   MOD_SIGNEDNESS
 265 #define MOD_IGNORE      (MOD_STORAGE | MOD_ACCESS | MOD_USERTYPE | MOD_EXPLICITLY_SIGNED | MOD_EXT_VISIBLE | MOD_UNUSED | MOD_GNU_INLINE)
 266 #define MOD_QUALIFIER   (MOD_CONST | MOD_VOLATILE | MOD_RESTRICT)
 267 #define MOD_PTRINHERIT  (MOD_QUALIFIER | MOD_ATOMIC | MOD_NODEREF | MOD_NORETURN | MOD_NOCAST)
 268 /* modifiers preserved by typeof() operator */
 269 #define MOD_TYPEOF      (MOD_QUALIFIER | MOD_ATOMIC | MOD_NOCAST | MOD_SPECIFIER)
 270 /* modifiers for function attributes */
 271 #define MOD_FUN_ATTR    (MOD_PURE|MOD_NORETURN)
 272 /* like cvr-qualifiers but 'reversed' (OK: source <= target) */
 273 #define MOD_REV_QUAL    (MOD_PURE|MOD_NORETURN)
 274 /* do not warn when these are duplicated */
 275 #define MOD_DUP_OK      (MOD_UNUSED|MOD_GNU_INLINE)
 276 /* must be part of the declared symbol, not its type */
 277 #define MOD_DECLARE     (MOD_STORAGE|MOD_INLINE|MOD_TLS|MOD_GNU_INLINE|MOD_UNUSED|MOD_PURE|MOD_NORETURN|MOD_EXT_VISIBLE)
 278
 279
 280
 281 /* Current parsing/evaluation function */
 282 extern struct symbol *current_fn;
 283
 284 /* Abstract types */
 285 extern struct symbol    int_type,
 286                         fp_type;
 287
 288 /* C types */
 289 extern struct symbol    bool_ctype, void_ctype, type_ctype,
 290                         char_ctype, schar_ctype, uchar_ctype,
 291                         short_ctype, sshort_ctype, ushort_ctype,
 292                         int_ctype, sint_ctype, uint_ctype,
 293                         long_ctype, slong_ctype, ulong_ctype,
 294                         llong_ctype, sllong_ctype, ullong_ctype,
 295                         int128_ctype, sint128_ctype, uint128_ctype,
 296                         float_ctype, double_ctype, ldouble_ctype,
 297                         string_ctype, ptr_ctype, lazy_ptr_ctype,
 298                         incomplete_ctype, label_ctype, bad_ctype,
 299                         null_ctype;
 300 extern struct symbol    autotype_ctype;
 301 extern struct symbol    int_ptr_ctype, uint_ptr_ctype;
 302 extern struct symbol    long_ptr_ctype, ulong_ptr_ctype;
 303 extern struct symbol    llong_ptr_ctype, ullong_ptr_ctype;
 304 extern struct symbol    float32_ctype, float32x_ctype;
 305 extern struct symbol    float64_ctype, float64x_ctype;
 306 extern struct symbol    float128_ctype;
 307 extern struct symbol    const_void_ctype, const_char_ctype;
 308 extern struct symbol    const_ptr_ctype, const_string_ctype;
 309
 310 /* Special internal symbols */
 311 extern struct symbol    zero_int;
 312
 313 #define __IDENT(n,str,res) \
 314         extern struct ident n
 315 #include "ident-list.h"
 316
 317
 318 extern struct symbol_list *translation_unit_used_list;
 319
 320 extern void access_symbol(struct symbol *);
 321
 322 extern const char * type_difference(struct ctype *c1, struct ctype *c2,
 323         unsigned long mod1, unsigned long mod2);
 324
 325 extern struct symbol *lookup_symbol(struct ident *, enum namespace);
 326 extern struct symbol *create_symbol(int stream, const char *name, int type, int namespace);
 327 extern void init_symbols(void);
 328 extern void init_builtins(int stream);
 329 extern void init_linearized_builtins(int stream);
 330 extern void init_ctype(void);
 331 extern struct symbol *alloc_symbol(struct position, int type);
 332 extern void show_type(struct symbol *);
 333 extern const char *modifier_name(unsigned long mod);
 334 extern const char *modifier_string(unsigned long mod);
 335 extern void show_symbol(struct symbol *);
 336 extern int show_symbol_expr_init(struct symbol *sym);
 337 extern void show_type_list(struct symbol *);
 338 extern void show_symbol_list(struct symbol_list *, const char *);
 339 extern void add_symbol(struct symbol_list **, struct symbol *);
 340 extern void bind_symbol(struct symbol *, struct ident *, enum namespace);
 341 extern void bind_symbol_with_scope(struct symbol *, struct ident *, enum namespace, struct scope *);
 342
 343 extern struct symbol *examine_symbol_type(struct symbol *);
 344 extern struct symbol *examine_pointer_target(struct symbol *);
 345 extern const char *show_as(struct ident *as);
 346 extern const char *show_typename(struct symbol *sym);
 347 extern const char *builtin_typename(struct symbol *sym);
 348 extern const char *builtin_type_suffix(struct symbol *sym);
 349 extern const char *builtin_ctypename(struct ctype *ctype);
 350 extern const char* get_type_name(enum type type);
 351
 352 extern void debug_symbol(struct symbol *);
 353 extern void merge_type(struct symbol *sym, struct symbol *base_type);
 354 extern void check_declaration(struct symbol *sym);
 355 extern void check_duplicates(struct symbol *sym);
 356
 357 static inline int valid_type(const struct symbol *ctype)
 358 {
 359         return ctype && ctype != &bad_ctype;
 360 }
 361
 362 static inline struct symbol *get_base_type(const struct symbol *sym)
 363 {
 364         return examine_symbol_type(sym->ctype.base_type);
 365 }
 366
 367 ///
 368 // test if type is an integer type
 369 //
 370 // @return: ``1`` for plain integer type, enums & bitfields
 371 //      but ``0`` for bitwise types!
 372 static inline int is_int_type(const struct symbol *type)
 373 {
 374         if (type->type == SYM_NODE)
 375                 type = type->ctype.base_type;
 376         if (type->type == SYM_ENUM)
 377                 type = type->ctype.base_type;
 378         return type->type == SYM_BITFIELD ||
 379                type->ctype.base_type == &int_type;
 380 }
 381
 382 static inline int is_enum_type(const struct symbol *type)
 383 {
 384         if (type->type == SYM_NODE)
 385                 type = type->ctype.base_type;
 386         return (type->type == SYM_ENUM);
 387 }
 388
 389 static inline int is_signed_type(struct symbol *sym)
 390 {
 391         if (sym->type == SYM_NODE)
 392                 sym = sym->ctype.base_type;
 393         if (sym->type == SYM_PTR)
 394                 return 0;
 395         return !(sym->ctype.modifiers & MOD_UNSIGNED);
 396 }
 397
 398 static inline int is_type_type(struct symbol *type)
 399 {
 400         return type == &type_ctype;
 401 }
 402
 403 static inline int is_ptr_type(struct symbol *type)
 404 {
 405         if (!type)
 406                 return 0;
 407         if (type->type == SYM_NODE)
 408                 type = type->ctype.base_type;
 409         return type->type == SYM_PTR || type->type == SYM_ARRAY || type->type == SYM_FN;
 410 }
 411
 412 static inline int is_func_type(struct symbol *type)
 413 {
 414         if (type->type == SYM_NODE)
 415                 type = type->ctype.base_type;
 416         return type->type == SYM_FN;
 417 }
 418
 419 static inline int is_array_type(struct symbol *type)
 420 {
 421         if (type->type == SYM_NODE)
 422                 type = type->ctype.base_type;
 423         return type->type == SYM_ARRAY;
 424 }
 425
 426 static inline int is_float_type(struct symbol *type)
 427 {
 428         if (type->type == SYM_NODE)
 429                 type = type->ctype.base_type;
 430         return type->ctype.base_type == &fp_type;
 431 }
 432
 433 static inline int is_byte_type(struct symbol *type)
 434 {
 435         return type->bit_size == bits_in_char && type->type != SYM_BITFIELD;
 436 }
 437
 438 static inline int is_wchar_type(struct symbol *type)
 439 {
 440         if (type->type == SYM_NODE)
 441                 type = type->ctype.base_type;
 442         return type == wchar_ctype;
 443 }
 444
 445 static inline int is_void_type(struct symbol *type)
 446 {
 447         if (type->type == SYM_NODE)
 448                 type = type->ctype.base_type;
 449         return type == &void_ctype;
 450 }
 451
 452 static inline int is_bool_type(struct symbol *type)
 453 {
 454         if (type->type == SYM_NODE)
 455                 type = type->ctype.base_type;
 456         return type == &bool_ctype;
 457 }
 458
 459 static inline int is_scalar_type(struct symbol *type)
 460 {
 461         if (type->type == SYM_NODE)
 462                 type = type->ctype.base_type;
 463         switch (type->type) {
 464         case SYM_ENUM:
 465         case SYM_BITFIELD:
 466         case SYM_PTR:
 467         case SYM_RESTRICT:      // OK, always integer types
 468         case SYM_FOULED:        // idem
 469                 return 1;
 470         default:
 471                 break;
 472         }
 473         if (type->ctype.base_type == &int_type)
 474                 return 1;
 475         if (type->ctype.base_type == &fp_type)
 476                 return 1;
 477         return 0;
 478 }
 479
 480 /// return true for integer & pointer types
 481 static inline bool is_integral_type(struct symbol *type)
 482 {
 483         if (type->type == SYM_NODE)
 484                 type = type->ctype.base_type;
 485         switch (type->type) {
 486         case SYM_ENUM:
 487         case SYM_PTR:
 488         case SYM_RESTRICT:      // OK, always integer types
 489         case SYM_FOULED:        // idem
 490                 return 1;
 491         default:
 492                 break;
 493         }
 494         if (type->ctype.base_type == &int_type)
 495                 return 1;
 496         return 0;
 497 }
 498
 499 static inline int is_function(struct symbol *type)
 500 {
 501         return type && type->type == SYM_FN;
 502 }
 503
 504 static inline int is_extern_inline(struct symbol *sym)
 505 {
 506         return (sym->ctype.modifiers & MOD_EXTERN) &&
 507                 (sym->ctype.modifiers & MOD_INLINE) &&
 508                 is_function(sym->ctype.base_type);
 509 }
 510
 511 static inline int get_sym_type(struct symbol *type)
 512 {
 513         if (type->type == SYM_NODE)
 514                 type = type->ctype.base_type;
 515         if (type->type == SYM_ENUM)
 516                 type = type->ctype.base_type;
 517         return type->type;
 518 }
 519
 520 static inline long long extend_value(long long val, struct symbol *ctype)
 521 {
 522         int is_signed = !(ctype->ctype.modifiers & MOD_UNSIGNED);
 523         unsigned size = ctype->bit_size;
 524
 525         return bits_extend(val, size, is_signed);
 526 }
 527
 528 static inline struct symbol *lookup_keyword(struct ident *ident, enum namespace ns)
 529 {
 530         if (!ident->keyword)
 531                 return NULL;
 532         return lookup_symbol(ident, ns);
 533 }
 534
 535 #define is_restricted_type(type) (get_sym_type(type) == SYM_RESTRICT)
 536 #define is_fouled_type(type) (get_sym_type(type) == SYM_FOULED)
 537 #define is_bitfield_type(type)   (get_sym_type(type) == SYM_BITFIELD)
 538
 539 void create_fouled(struct symbol *type);
 540 struct symbol *befoul(struct symbol *type);
 541
 542
 543 extern struct ident bad_address_space;
 544
 545 static inline bool valid_as(struct ident *as)
 546 {
 547         return as && as != &bad_address_space;
 548 }
 549
 550 static inline void combine_address_space(struct position pos,
 551         struct ident **tas, struct ident *sas)
 552 {
 553         struct ident *as;
 554         if (!sas)
 555                 return;
 556         as = *tas;
 557         if (!as)
 558                 *tas = sas;
 559         else if (as != sas) {
 560                 *tas = &bad_address_space;
 561                 sparse_error(pos, "multiple address spaces given");
 562         }
 563 }
 564
 565 #endif /* SYMBOL_H */