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         struct expression *cleanup;
 111         unsigned long f_modifiers;              // function attributes
 112         unsigned long storage_class;
 113         unsigned char prefer_abstract;
 114         unsigned char autotype;
 115         unsigned char forced;
 116         unsigned char packed;
 117 };
 118
 119 struct pseudo;
 120 struct entrypoint;
 121 struct arg;
 122
 123 struct symbol_op {
 124         enum keyword type;
 125         int (*evaluate)(struct expression *);
 126         int (*expand)(struct expression *, int);
 127         int (*args)(struct expression *);
 128         struct pseudo *(*linearize)(struct entrypoint *, struct expression *);
 129
 130         /* keywords */
 131         struct token *(*declarator)(struct token *token, struct symbol *, struct decl_state *ctx);
 132         struct token *(*statement)(struct token *token, struct statement *stmt);
 133         struct token *(*toplevel)(struct token *token, struct symbol_list **list);
 134         struct token *(*attribute)(struct token *token, struct symbol *attr, struct decl_state *ctx);
 135         struct symbol *(*to_mode)(struct symbol *);
 136         void (*asm_modifier)(struct token *token, unsigned long *mods, unsigned long mod);
 137
 138         int test, set, class;
 139 };
 140
 141
 142 #define SYM_ATTR_WEAK           0
 143 #define SYM_ATTR_NORMAL         1
 144 #define SYM_ATTR_STRONG         2
 145
 146 struct symbol {
 147         enum type type:8;
 148         enum namespace namespace:9;
 149         unsigned char used:1, attr:2, enum_member:1, bound:1, parsed:1;
 150         struct position pos;            /* Where this symbol was declared */
 151         struct position endpos;         /* Where this symbol ends*/
 152         struct ident *ident;            /* What identifier this symbol is associated with */
 153         struct symbol *next_id;         /* Next semantic symbol that shares this identifier */
 154         struct symbol   *replace;       /* What is this symbol shadowed by in copy-expression */
 155         struct scope    *scope;
 156         union {
 157                 struct symbol   *same_symbol;
 158                 struct symbol   *next_subobject;
 159         };
 160
 161         struct symbol_op *op;
 162
 163         union {
 164                 struct /* NS_MACRO */ {
 165                         struct token *expansion;
 166                         struct token *arglist;
 167                         struct scope *used_in;
 168                         void (*expand_simple)(struct token *);
 169                         bool (*expand)(struct token *, struct arg *args);
 170                 };
 171                 struct /* NS_PREPROCESSOR */ {
 172                         int (*handler)(struct stream *, struct token **, struct token *);
 173                         int normal;
 174                 };
 175                 struct /* NS_LABEL */ {
 176                         struct scope *label_scope;
 177                         struct position label_pos;
 178                         unsigned long label_modifiers;
 179                 };
 180                 struct /* NS_SYMBOL */ {
 181                         unsigned long   offset;
 182                         int             bit_size;
 183                         unsigned int    bit_offset:8,
 184                                         bogus_linear:1,
 185                                         variadic:1,
 186                                         initialized:1,
 187                                         examined:1,
 188                                         expanding:1,
 189                                         evaluated:1,
 190                                         has_flex_array:1,
 191                                         string:1,
 192                                         designated_init:1,
 193                                         forced_arg:1,
 194                                         accessed:1,
 195                                         builtin:1,
 196                                         torename:1,
 197                                         packed:1,
 198                                         transparent_union:1;
 199                         int             rank:3; // arithmetic's rank
 200                         struct expression *array_size;
 201                         struct ctype ctype;
 202                         struct symbol_list *arguments;
 203                         struct statement *stmt;
 204                         struct symbol_list *symbol_list;
 205                         struct statement *inline_stmt;
 206                         struct symbol_list *inline_symbol_list;
 207                         struct expression *initializer;
 208                         struct expression *cleanup;
 209                         struct entrypoint *ep;
 210                         struct symbol *definition;
 211                 };
 212         };
 213         union /* backend */ {
 214                 struct basic_block *bb_target;  /* label */
 215                 void *aux;                      /* Auxiliary info, e.g. backend information */
 216                 struct {
 217                         char kind;              /* used by ctags & dissect */
 218                         unsigned char visited:1;
 219                         unsigned char inspected:1;
 220                 };
 221         };
 222         pseudo_t pseudo;
 223 };
 224
 225 /* Modifiers */
 226 #define MOD_AUTO                0x00000001
 227 #define MOD_REGISTER            0x00000002
 228 #define MOD_STATIC              0x00000004
 229 #define MOD_EXTERN              0x00000008
 230 #define MOD_TOPLEVEL            0x00000010      // scoping..
 231 #define MOD_TLS                 0x00000020
 232 #define MOD_ASM_GOTO            MOD_TLS         // never used together
 233 #define MOD_INLINE              0x00000040
 234
 235 #define MOD_ASSIGNED            0x00000080
 236 #define MOD_ADDRESSABLE         0x00000100
 237
 238 #define MOD_CONST               0x00000200
 239 #define MOD_VOLATILE            0x00000400
 240 #define MOD_RESTRICT            0x00000800
 241 #define MOD_ATOMIC              0x00001000
 242
 243 #define MOD_SIGNED              0x00002000
 244 #define MOD_UNSIGNED            0x00004000
 245 #define MOD_EXPLICITLY_SIGNED   0x00008000
 246
 247 #define MOD_GNU_INLINE          0x00010000
 248 #define MOD_USERTYPE            0x00020000
 249      // MOD UNUSED              0x00040000
 250      // MOD UNUSED              0x00080000
 251      // MOD UNUSED              0x00100000
 252      // MOD UNUSED              0x00200000
 253
 254 #define MOD_UNUSED              0x00400000
 255 #define MOD_SAFE                0x00800000      // non-null/non-trapping pointer
 256 #define MOD_PURE                0x01000000
 257 #define MOD_BITWISE             0x02000000
 258 #define MOD_NOCAST              0x04000000
 259 #define MOD_NODEREF             0x08000000
 260 #define MOD_NORETURN            0x10000000
 261 #define MOD_EXT_VISIBLE         0x20000000
 262
 263
 264 #define MOD_ACCESS      (MOD_ASSIGNED | MOD_ADDRESSABLE)
 265 #define MOD_NONLOCAL    (MOD_EXTERN | MOD_TOPLEVEL)
 266 #define MOD_STORAGE     (MOD_AUTO | MOD_REGISTER | MOD_STATIC | MOD_EXTERN | MOD_INLINE | MOD_TOPLEVEL)
 267 #define MOD_ESIGNED     (MOD_SIGNED | MOD_EXPLICITLY_SIGNED)
 268 #define MOD_SIGNEDNESS  (MOD_SIGNED | MOD_UNSIGNED | MOD_EXPLICITLY_SIGNED)
 269 #define MOD_SPECIFIER   MOD_SIGNEDNESS
 270 #define MOD_IGNORE      (MOD_STORAGE | MOD_ACCESS | MOD_USERTYPE | MOD_EXPLICITLY_SIGNED | MOD_EXT_VISIBLE | MOD_UNUSED | MOD_GNU_INLINE)
 271 #define MOD_QUALIFIER   (MOD_CONST | MOD_VOLATILE | MOD_RESTRICT)
 272 #define MOD_PTRINHERIT  (MOD_QUALIFIER | MOD_ATOMIC | MOD_NODEREF | MOD_NORETURN | MOD_NOCAST)
 273 /* modifiers preserved by typeof() operator */
 274 #define MOD_TYPEOF      (MOD_QUALIFIER | MOD_ATOMIC | MOD_NOCAST | MOD_SPECIFIER)
 275 /* modifiers for function attributes */
 276 #define MOD_FUN_ATTR    (MOD_PURE|MOD_NORETURN)
 277 /* like cvr-qualifiers but 'reversed' (OK: source <= target) */
 278 #define MOD_REV_QUAL    (MOD_PURE|MOD_NORETURN)
 279 /* do not warn when these are duplicated */
 280 #define MOD_DUP_OK      (MOD_UNUSED|MOD_GNU_INLINE)
 281 /* must be part of the declared symbol, not its type */
 282 #define MOD_DECLARE     (MOD_STORAGE|MOD_INLINE|MOD_TLS|MOD_GNU_INLINE|MOD_UNUSED|MOD_PURE|MOD_NORETURN|MOD_EXT_VISIBLE)
 283
 284
 285
 286 /* Current parsing/evaluation function */
 287 extern struct symbol *current_fn;
 288
 289 /* Abstract types */
 290 extern struct symbol    int_type,
 291                         fp_type;
 292
 293 /* C types */
 294 extern struct symbol    bool_ctype, void_ctype, type_ctype,
 295                         char_ctype, schar_ctype, uchar_ctype,
 296                         short_ctype, sshort_ctype, ushort_ctype,
 297                         int_ctype, sint_ctype, uint_ctype,
 298                         long_ctype, slong_ctype, ulong_ctype,
 299                         llong_ctype, sllong_ctype, ullong_ctype,
 300                         int128_ctype, sint128_ctype, uint128_ctype,
 301                         float_ctype, double_ctype, ldouble_ctype,
 302                         string_ctype, ptr_ctype, lazy_ptr_ctype,
 303                         incomplete_ctype, label_ctype, bad_ctype,
 304                         null_ctype;
 305 extern struct symbol    autotype_ctype;
 306 extern struct symbol    schar_ptr_ctype, short_ptr_ctype;
 307 extern struct symbol    int_ptr_ctype, uint_ptr_ctype;
 308 extern struct symbol    long_ptr_ctype, ulong_ptr_ctype;
 309 extern struct symbol    llong_ptr_ctype, ullong_ptr_ctype;
 310 extern struct symbol    size_t_ptr_ctype, intmax_ptr_ctype, ptrdiff_ptr_ctype;
 311 extern struct symbol    float32_ctype, float32x_ctype;
 312 extern struct symbol    float64_ctype, float64x_ctype;
 313 extern struct symbol    float128_ctype;
 314 extern struct symbol    const_void_ctype, const_char_ctype;
 315 extern struct symbol    const_ptr_ctype, const_string_ctype;
 316 extern struct symbol    const_wchar_ctype, const_wstring_ctype;
 317 extern struct symbol    volatile_void_ctype, volatile_ptr_ctype;
 318 extern struct symbol    volatile_bool_ctype, volatile_bool_ptr_ctype;
 319
 320 /* Special internal symbols */
 321 extern struct symbol    zero_int;
 322
 323 #define __IDENT(n,str,res) \
 324         extern struct ident n
 325 #include "ident-list.h"
 326
 327
 328 extern struct symbol_list *translation_unit_used_list;
 329
 330 extern void access_symbol(struct symbol *);
 331
 332 extern const char * type_difference(struct ctype *c1, struct ctype *c2,
 333         unsigned long mod1, unsigned long mod2);
 334
 335 extern struct symbol *lookup_symbol(struct ident *, enum namespace);
 336 struct symbol *lookup_macro_symbol(const char *macro);
 337 extern struct symbol *create_symbol(int stream, const char *name, int type, int namespace);
 338 extern void init_symbols(void);
 339 extern void init_builtins(int stream);
 340 extern void init_linearized_builtins(int stream);
 341 extern void init_ctype(void);
 342 extern struct symbol *alloc_symbol(struct position, int type);
 343 extern void show_type(struct symbol *);
 344 extern const char *modifier_name(unsigned long mod);
 345 extern const char *modifier_string(unsigned long mod);
 346 extern void show_symbol(struct symbol *);
 347 extern int show_symbol_expr_init(struct symbol *sym);
 348 extern void show_type_list(struct symbol *);
 349 extern void show_symbol_list(struct symbol_list *);
 350 extern void add_symbol(struct symbol_list **, struct symbol *);
 351 extern void bind_symbol(struct symbol *, struct ident *, enum namespace);
 352 extern void bind_symbol_with_scope(struct symbol *, struct ident *, enum namespace, struct scope *);
 353
 354 extern struct symbol *examine_symbol_type(struct symbol *);
 355 extern struct symbol *examine_pointer_target(struct symbol *);
 356 extern const char *show_as(struct ident *as);
 357 extern const char *show_typename(struct symbol *sym);
 358 extern const char *builtin_typename(struct symbol *sym);
 359 extern const char *builtin_type_suffix(struct symbol *sym);
 360 extern const char *builtin_ctypename(struct ctype *ctype);
 361 extern const char* get_type_name(enum type type);
 362
 363 extern void debug_symbol(struct symbol *);
 364 extern void merge_type(struct symbol *sym, struct symbol *base_type);
 365 extern void check_declaration(struct symbol *sym);
 366 extern void check_duplicates(struct symbol *sym);
 367
 368 static inline int valid_type(const struct symbol *ctype)
 369 {
 370         return ctype && ctype != &bad_ctype;
 371 }
 372
 373 static inline struct symbol *get_base_type(const struct symbol *sym)
 374 {
 375         return examine_symbol_type(sym->ctype.base_type);
 376 }
 377
 378 ///
 379 // test if type is an integer type
 380 //
 381 // @return: ``1`` for plain integer type, enums & bitfields
 382 //      but ``0`` for bitwise types!
 383 static inline int is_int_type(const struct symbol *type)
 384 {
 385         if (type->type == SYM_NODE)
 386                 type = type->ctype.base_type;
 387         if (type->type == SYM_ENUM)
 388                 type = type->ctype.base_type;
 389         return type->type == SYM_BITFIELD ||
 390                type->ctype.base_type == &int_type;
 391 }
 392
 393 static inline int is_enum_type(const struct symbol *type)
 394 {
 395         if (type->type == SYM_NODE)
 396                 type = type->ctype.base_type;
 397         return (type->type == SYM_ENUM);
 398 }
 399
 400 static inline int is_signed_type(struct symbol *sym)
 401 {
 402         if (sym->type == SYM_NODE)
 403                 sym = sym->ctype.base_type;
 404         if (sym->type == SYM_PTR)
 405                 return 0;
 406         return !(sym->ctype.modifiers & MOD_UNSIGNED);
 407 }
 408
 409 static inline int is_type_type(struct symbol *type)
 410 {
 411         return type == &type_ctype;
 412 }
 413
 414 static inline int is_ptr_type(struct symbol *type)
 415 {
 416         if (!type)
 417                 return 0;
 418         if (type->type == SYM_NODE)
 419                 type = type->ctype.base_type;
 420         return type->type == SYM_PTR || type->type == SYM_ARRAY || type->type == SYM_FN;
 421 }
 422
 423 static inline int is_func_type(struct symbol *type)
 424 {
 425         if (type->type == SYM_NODE)
 426                 type = type->ctype.base_type;
 427         return type->type == SYM_FN;
 428 }
 429
 430 static inline int is_array_type(struct symbol *type)
 431 {
 432         if (type->type == SYM_NODE)
 433                 type = type->ctype.base_type;
 434         return type->type == SYM_ARRAY;
 435 }
 436
 437 static inline int is_struct_type(struct symbol *type)
 438 {
 439         if (type->type == SYM_NODE)
 440                 type = type->ctype.base_type;
 441         return type->type == SYM_STRUCT;
 442 }
 443
 444 static inline int is_union_type(struct symbol *type)
 445 {
 446         if (type->type == SYM_NODE)
 447                 type = type->ctype.base_type;
 448         return type->type == SYM_UNION;
 449 }
 450
 451 static inline int is_float_type(struct symbol *type)
 452 {
 453         if (type->type == SYM_NODE)
 454                 type = type->ctype.base_type;
 455         return type->ctype.base_type == &fp_type;
 456 }
 457
 458 static inline int is_byte_type(struct symbol *type)
 459 {
 460         return type->bit_size == bits_in_char && type->type != SYM_BITFIELD;
 461 }
 462
 463 static inline int is_wchar_type(struct symbol *type)
 464 {
 465         if (type->type == SYM_NODE)
 466                 type = type->ctype.base_type;
 467         return type == wchar_ctype;
 468 }
 469
 470 static inline int is_void_type(struct symbol *type)
 471 {
 472         if (type->type == SYM_NODE)
 473                 type = type->ctype.base_type;
 474         return type == &void_ctype;
 475 }
 476
 477 static inline int is_bool_type(struct symbol *type)
 478 {
 479         if (type->type == SYM_NODE)
 480                 type = type->ctype.base_type;
 481         return type == &bool_ctype;
 482 }
 483
 484 static inline int is_scalar_type(struct symbol *type)
 485 {
 486         if (type->type == SYM_NODE)
 487                 type = type->ctype.base_type;
 488         switch (type->type) {
 489         case SYM_ENUM:
 490         case SYM_BITFIELD:
 491         case SYM_PTR:
 492         case SYM_RESTRICT:      // OK, always integer types
 493         case SYM_FOULED:        // idem
 494                 return 1;
 495         default:
 496                 break;
 497         }
 498         if (type->ctype.base_type == &int_type)
 499                 return 1;
 500         if (type->ctype.base_type == &fp_type)
 501                 return 1;
 502         return 0;
 503 }
 504
 505 /// return true for integer & pointer types
 506 static inline bool is_integral_type(struct symbol *type)
 507 {
 508         if (type->type == SYM_NODE)
 509                 type = type->ctype.base_type;
 510         switch (type->type) {
 511         case SYM_ENUM:
 512         case SYM_PTR:
 513         case SYM_RESTRICT:      // OK, always integer types
 514         case SYM_FOULED:        // idem
 515                 return 1;
 516         default:
 517                 break;
 518         }
 519         if (type->ctype.base_type == &int_type)
 520                 return 1;
 521         return 0;
 522 }
 523
 524 static inline int is_function(struct symbol *type)
 525 {
 526         return type && type->type == SYM_FN;
 527 }
 528
 529 static inline int is_extern_inline(struct symbol *sym)
 530 {
 531         return (sym->ctype.modifiers & MOD_EXTERN) &&
 532                 (sym->ctype.modifiers & MOD_INLINE) &&
 533                 is_function(sym->ctype.base_type);
 534 }
 535
 536 static inline int has_flexible_array(struct symbol *type)
 537 {
 538         if (type->type == SYM_NODE)
 539                 type = type->ctype.base_type;
 540         return type->has_flex_array;
 541 }
 542
 543 static inline int get_sym_type(struct symbol *type)
 544 {
 545         if (type->type == SYM_NODE)
 546                 type = type->ctype.base_type;
 547         if (type->type == SYM_ENUM)
 548                 type = type->ctype.base_type;
 549         return type->type;
 550 }
 551
 552 static inline long long extend_value(long long val, struct symbol *ctype)
 553 {
 554         int is_signed = !(ctype->ctype.modifiers & MOD_UNSIGNED);
 555         unsigned size = ctype->bit_size;
 556
 557         return bits_extend(val, size, is_signed);
 558 }
 559
 560 static inline struct symbol *lookup_keyword(struct ident *ident, enum namespace ns)
 561 {
 562         if (!ident->keyword)
 563                 return NULL;
 564         return lookup_symbol(ident, ns);
 565 }
 566
 567 #define is_restricted_type(type) (get_sym_type(type) == SYM_RESTRICT)
 568 #define is_fouled_type(type) (get_sym_type(type) == SYM_FOULED)
 569 #define is_bitfield_type(type)   (get_sym_type(type) == SYM_BITFIELD)
 570
 571 void create_fouled(struct symbol *type);
 572 struct symbol *befoul(struct symbol *type);
 573
 574
 575 extern struct ident bad_address_space;
 576
 577 static inline bool valid_as(struct ident *as)
 578 {
 579         return as && as != &bad_address_space;
 580 }
 581
 582 static inline void combine_address_space(struct position pos,
 583         struct ident **tas, struct ident *sas)
 584 {
 585         struct ident *as;
 586         if (!sas)
 587                 return;
 588         as = *tas;
 589         if (!as)
 590                 *tas = sas;
 591         else if (as != sas) {
 592                 *tas = &bad_address_space;
 593                 sparse_error(pos, "multiple address spaces given");
 594         }
 595 }
 596
 597 #endif /* SYMBOL_H */