1 /* The lang_hooks data structure. 2 Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 3 Free Software Foundation, Inc. 4 5 This file is part of GCC. 6 7 GCC is free software; you can redistribute it and/or modify 8 it under the terms of the GNU General Public License as published by 9 the Free Software Foundation; either version 3, or (at your option) 10 any later version. 11 12 GCC is distributed in the hope that it will be useful, 13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 GNU General Public License for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with GCC; see the file COPYING3. If not see 19 <http://www.gnu.org/licenses/>. */ 20 21 #ifndef GCC_LANG_HOOKS_H 22 #define GCC_LANG_HOOKS_H 23 24 /* This file should be #include-d after tree.h. */ 25 26 struct diagnostic_context; 27 struct diagnostic_info; 28 29 struct gimplify_omp_ctx; 30 31 struct array_descr_info; 32 33 /* A print hook for print_tree (). */ 34 typedef void (*lang_print_tree_hook) (FILE *, tree, int indent); 35 36 enum classify_record 37 { RECORD_IS_STRUCT, RECORD_IS_CLASS, RECORD_IS_INTERFACE }; 38 39 /* The following hooks are documented in langhooks.c. Must not be 40 NULL. */ 41 42 struct lang_hooks_for_tree_inlining 43 { 44 bool (*var_mod_type_p) (tree, tree); 45 }; 46 47 struct lang_hooks_for_callgraph 48 { 49 /* The node passed is a language-specific tree node. If its contents 50 are relevant to use of other declarations, mark them. */ 51 tree (*analyze_expr) (tree *, int *); 52 53 /* Emit thunks associated to function. */ 54 void (*emit_associated_thunks) (tree); 55 }; 56 57 /* The following hooks are used by tree-dump.c. */ 58 59 struct lang_hooks_for_tree_dump 60 { 61 /* Dump language-specific parts of tree nodes. Returns nonzero if it 62 does not want the usual dumping of the second argument. */ 63 bool (*dump_tree) (void *, tree); 64 65 /* Determine type qualifiers in a language-specific way. */ 66 int (*type_quals) (const_tree); 67 }; 68 69 /* Hooks related to types. */ 70 71 struct lang_hooks_for_types 72 { 73 /* Return a new type (with the indicated CODE), doing whatever 74 language-specific processing is required. */ 75 tree (*make_type) (enum tree_code); 76 77 /* Return what kind of RECORD_TYPE this is, mainly for purposes of 78 debug information. If not defined, record types are assumed to 79 be structures. */ 80 enum classify_record (*classify_record) (tree); 81 82 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that 83 mode. */ 84 tree (*type_for_mode) (enum machine_mode, int); 85 86 /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an 87 integer type with at least that precision. */ 88 tree (*type_for_size) (unsigned, int); 89 90 /* True if the type is an instantiation of a generic type, 91 e.g. C++ template implicit specializations. */ 92 bool (*generic_p) (const_tree); 93 94 /* Given a type, apply default promotions to unnamed function 95 arguments and return the new type. Return the same type if no 96 change. Required by any language that supports variadic 97 arguments. The default hook dies. */ 98 tree (*type_promotes_to) (tree); 99 100 /* Register TYPE as a builtin type with the indicated NAME. The 101 TYPE is placed in the outermost lexical scope. The semantics 102 should be analogous to: 103 104 typedef TYPE NAME; 105 106 in C. The default hook ignores the declaration. */ 107 void (*register_builtin_type) (tree, const char *); 108 109 /* This routine is called in tree.c to print an error message for 110 invalid use of an incomplete type. VALUE is the expression that 111 was used (or 0 if that isn't known) and TYPE is the type that was 112 invalid. */ 113 void (*incomplete_type_error) (const_tree value, const_tree type); 114 115 /* Called from assign_temp to return the maximum size, if there is one, 116 for a type. */ 117 tree (*max_size) (const_tree); 118 119 /* Register language specific type size variables as potentially OpenMP 120 firstprivate variables. */ 121 void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree); 122 123 /* Return TRUE if TYPE1 and TYPE2 are identical for type hashing purposes. 124 Called only after doing all language independent checks. 125 At present, this function is only called when both TYPE1 and TYPE2 are 126 FUNCTION_TYPEs. */ 127 bool (*type_hash_eq) (const_tree, const_tree); 128 129 /* Return TRUE if TYPE uses a hidden descriptor and fills in information 130 for the debugger about the array bounds, strides, etc. */ 131 bool (*get_array_descr_info) (const_tree, struct array_descr_info *); 132 133 /* If we requested a pointer to a vector, build up the pointers that 134 we stripped off while looking for the inner type. Similarly for 135 return values from functions. The argument TYPE is the top of the 136 chain, and BOTTOM is the new type which we will point to. */ 137 tree (*reconstruct_complex_type) (tree, tree); 138 139 /* Nonzero if types that are identical are to be hashed so that only 140 one copy is kept. If a language requires unique types for each 141 user-specified type, such as Ada, this should be set to TRUE. */ 142 bool hash_types; 143 }; 144 145 /* Language hooks related to decls and the symbol table. */ 146 147 struct lang_hooks_for_decls 148 { 149 /* Returns nonzero if we are in the global binding level. Ada 150 returns -1 for an undocumented reason used in stor-layout.c. */ 151 int (*global_bindings_p) (void); 152 153 /* Function to add a decl to the current scope level. Takes one 154 argument, a decl to add. Returns that decl, or, if the same 155 symbol is already declared, may return a different decl for that 156 name. */ 157 tree (*pushdecl) (tree); 158 159 /* Returns the chain of decls so far in the current scope level. */ 160 tree (*getdecls) (void); 161 162 /* Returns true when we should warn for an unused global DECL. 163 We will already have checked that it has static binding. */ 164 bool (*warn_unused_global) (const_tree); 165 166 /* Obtain a list of globals and do final output on them at end 167 of compilation */ 168 void (*final_write_globals) (void); 169 170 /* True if this decl may be called via a sibcall. */ 171 bool (*ok_for_sibcall) (const_tree); 172 173 /* Return the COMDAT group into which this DECL should be placed. 174 It is known that the DECL belongs in *some* COMDAT group when 175 this hook is called. The return value will be used immediately, 176 but not explicitly deallocated, so implementations should not use 177 xmalloc to allocate the string returned. (Typically, the return 178 value will be the string already stored in an 179 IDENTIFIER_NODE.) */ 180 const char * (*comdat_group) (tree); 181 182 /* True if OpenMP should privatize what this DECL points to rather 183 than the DECL itself. */ 184 bool (*omp_privatize_by_reference) (const_tree); 185 186 /* Return sharing kind if OpenMP sharing attribute of DECL is 187 predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise. */ 188 enum omp_clause_default_kind (*omp_predetermined_sharing) (tree); 189 190 /* Return true if DECL's DECL_VALUE_EXPR (if any) should be 191 disregarded in OpenMP construct, because it is going to be 192 remapped during OpenMP lowering. SHARED is true if DECL 193 is going to be shared, false if it is going to be privatized. */ 194 bool (*omp_disregard_value_expr) (tree, bool); 195 196 /* Return true if DECL that is shared iff SHARED is true should 197 be put into OMP_CLAUSE_PRIVATE_DEBUG. */ 198 bool (*omp_private_debug_clause) (tree, bool); 199 200 /* Return true if DECL in private clause needs 201 OMP_CLAUSE_PRIVATE_OUTER_REF on the private clause. */ 202 bool (*omp_private_outer_ref) (tree); 203 204 /* Build and return code for a default constructor for DECL in 205 response to CLAUSE. OUTER is corresponding outer region's 206 variable if needed. Return NULL if nothing to be done. */ 207 tree (*omp_clause_default_ctor) (tree clause, tree decl, tree outer); 208 209 /* Build and return code for a copy constructor from SRC to DST. */ 210 tree (*omp_clause_copy_ctor) (tree clause, tree dst, tree src); 211 212 /* Similarly, except use an assignment operator instead. */ 213 tree (*omp_clause_assign_op) (tree clause, tree dst, tree src); 214 215 /* Build and return code destructing DECL. Return NULL if nothing 216 to be done. */ 217 tree (*omp_clause_dtor) (tree clause, tree decl); 218 219 /* Do language specific checking on an implicitly determined clause. */ 220 void (*omp_finish_clause) (tree clause); 221 222 /* Return true if DECL is a global destructor. */ 223 bool (*is_decl_dtor) (tree decl); 224 225 /* Return true if DECL is a vptr field. */ 226 bool (*is_vptr_field) (tree decl); 227 228 /* Return true if TYPE is a polymorphic type. */ 229 bool (*is_type_polymorphic) (tree type); 230 231 /* Return true if DECL is global delete. */ 232 bool (*is_global_delete_fndecl) (tree decl); 233 }; 234 235 /* Lang hooks for LIPO. */ 236 237 struct lang_hooks_for_lipo 238 { 239 /* Add DECL to the list of predefined builtins. */ 240 void (*add_built_in_decl) (tree decl); 241 242 /* Save the tree (by making a copy) and binding values 243 for builtins before parsing start. */ 244 void (*save_built_in_decl_pre_parsing) (void); 245 246 /* Restore builtins and their bindings to their values 247 before parsing. */ 248 void (*restore_built_in_decl_pre_parsing) (void); 249 250 /* Save the tree (by making a copy) and binding values for 251 builtins after parsing of a file. */ 252 void (*save_built_in_decl_post_module_parsing) (void); 253 254 /* Restore builtins and their bindings to their post 255 parsing values. */ 256 void (*restore_built_in_decl_post_module_parsing) (void); 257 258 /* Clear symbol binding for name ID. */ 259 void (*clear_global_name_bindings) (tree id); 260 261 /* Return true if DECL in SCOPE is scoped in global/namespace scope, 262 otherwise return false. */ 263 bool (*has_global_name) (tree decl, void *scope); 264 265 /* Return the actual size of the lang_decl struct for 266 decl T. */ 267 int (*get_lang_decl_size) (tree t); 268 269 /* Duplicate language specific type information from SRC 270 to DEST. */ 271 void (*dup_lang_type) (tree src, tree dest); 272 273 /* Copy DEST into SRC. */ 274 void (*copy_lang_type) (tree src, tree dest); 275 276 /* Process decls after parsing of a source module. */ 277 void (*process_pending_decls) (unsigned); 278 279 /* Clear the list of deferred functions. */ 280 void (*clear_deferred_fns) (void); 281 282 /* Return true if T is compiler generated. */ 283 bool (*is_compiler_generated_type) (tree t); 284 285 /* Compare language specific types T1 and T2. 286 Return 1 if they are compatible. */ 287 int (*cmp_lang_type) (tree t1, tree t2); 288 }; 289 290 /* Language-specific hooks. See langhooks-def.h for defaults. */ 291 292 struct lang_hooks 293 { 294 /* String identifying the front end. e.g. "GNU C++". */ 295 const char *name; 296 297 /* sizeof (struct lang_identifier), so make_node () creates 298 identifier nodes long enough for the language-specific slots. */ 299 size_t identifier_size; 300 301 /* Determines the size of any language-specific tcc_constant or 302 tcc_exceptional nodes. Since it is called from make_node, the 303 only information available is the tree code. Expected to die 304 on unrecognized codes. */ 305 size_t (*tree_size) (enum tree_code); 306 307 /* The first callback made to the front end, for simple 308 initialization needed before any calls to handle_option. Return 309 the language mask to filter the switch array with. */ 310 unsigned int (*init_options) (unsigned int argc, const char **argv); 311 312 /* Callback used to perform language-specific initialization for the 313 global diagnostic context structure. */ 314 void (*initialize_diagnostics) (struct diagnostic_context *); 315 316 /* Handle the switch CODE, which has real type enum opt_code from 317 options.h. If the switch takes an argument, it is passed in ARG 318 which points to permanent storage. The handler is responsible for 319 checking whether ARG is NULL, which indicates that no argument 320 was in fact supplied. For -f and -W switches, VALUE is 1 or 0 321 for the positive and negative forms respectively. 322 323 Return 1 if the switch is valid, 0 if invalid, and -1 if it's 324 valid and should not be treated as language-independent too. */ 325 int (*handle_option) (size_t code, const char *arg, int value); 326 327 /* Return false to use the default complaint about a missing 328 argument, otherwise output a complaint and return true. */ 329 bool (*missing_argument) (const char *opt, size_t code); 330 331 /* Called when all command line options have been parsed to allow 332 further processing and initialization 333 334 Should return true to indicate that a compiler back-end is 335 not required, such as with the -E option. 336 337 If errorcount is nonzero after this call the compiler exits 338 immediately and the finish hook is not called. */ 339 bool (*post_options) (const char **); 340 341 /* Called after post_options to initialize the front end. Return 342 false to indicate that no further compilation be performed, in 343 which case the finish hook is called immediately. */ 344 bool (*init) (void); 345 346 /* Called at the end of compilation, as a finalizer. */ 347 void (*finish) (void); 348 349 /* Parses the entire file. The argument is nonzero to cause bison 350 parsers to dump debugging information during parsing. */ 351 void (*parse_file) (int); 352 353 /* Determines if it's ok for a function to have no noreturn attribute. */ 354 bool (*missing_noreturn_ok_p) (tree); 355 356 /* Called to obtain the alias set to be used for an expression or type. 357 Returns -1 if the language does nothing special for it. */ 358 alias_set_type (*get_alias_set) (tree); 359 360 /* Called by expand_expr for language-specific tree codes. 361 Fourth argument is actually an enum expand_modifier. */ 362 rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *); 363 364 /* Function to finish handling an incomplete decl at the end of 365 compilation. Default hook is does nothing. */ 366 void (*finish_incomplete_decl) (tree); 367 368 /* Mark EXP saying that we need to be able to take the address of 369 it; it should not be allocated in a register. Return true if 370 successful. */ 371 bool (*mark_addressable) (tree); 372 373 /* Hook called by staticp for language-specific tree codes. */ 374 tree (*staticp) (tree); 375 376 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the 377 DECL_NODE with a newly GC-allocated copy. */ 378 void (*dup_lang_specific_decl) (tree); 379 380 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of 381 thing that the assembler should talk about, set 382 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. 383 Otherwise, set it to the ERROR_MARK_NODE to ensure that the 384 assembler does not talk about it. */ 385 void (*set_decl_assembler_name) (tree); 386 387 /* The front end can add its own statistics to -fmem-report with 388 this hook. It should output to stderr. */ 389 void (*print_statistics) (void); 390 391 /* Called by print_tree when there is a tree of class tcc_exceptional 392 that it doesn't know how to display. */ 393 lang_print_tree_hook print_xnode; 394 395 /* Called to print language-dependent parts of tcc_decl, tcc_type, 396 and IDENTIFIER_NODE nodes. */ 397 lang_print_tree_hook print_decl; 398 lang_print_tree_hook print_type; 399 lang_print_tree_hook print_identifier; 400 401 /* Computes the name to use to print a declaration. DECL is the 402 non-NULL declaration in question. VERBOSITY determines what 403 information will be printed: 0: DECL_NAME, demangled as 404 necessary. 1: and scope information. 2: and any other 405 information that might be interesting, such as function parameter 406 types in C++. */ 407 const char *(*decl_printable_name) (tree decl, int verbosity); 408 409 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what 410 information will be printed: 0: DECL_NAME, demangled as 411 necessary. 1: and scope information. */ 412 const char *(*dwarf_name) (tree, int verbosity); 413 414 /* This compares two types for equivalence ("compatible" in C-based languages). 415 This routine should only return 1 if it is sure. It should not be used 416 in contexts where erroneously returning 0 causes problems. */ 417 int (*types_compatible_p) (tree x, tree y); 418 419 /* Called by report_error_function to print out function name. */ 420 void (*print_error_function) (struct diagnostic_context *, const char *, 421 struct diagnostic_info *); 422 423 /* Called from expr_size to calculate the size of the value of an 424 expression in a language-dependent way. Returns a tree for the size 425 in bytes. A frontend can call lhd_expr_size to get the default 426 semantics in cases that it doesn't want to handle specially. */ 427 tree (*expr_size) (const_tree); 428 429 /* Convert a character from the host's to the target's character 430 set. The character should be in what C calls the "basic source 431 character set" (roughly, the set of characters defined by plain 432 old ASCII). The default is to return the character unchanged, 433 which is correct in most circumstances. Note that both argument 434 and result should be sign-extended under -fsigned-char, 435 zero-extended under -fno-signed-char. */ 436 HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT); 437 438 /* Pointers to machine-independent attribute tables, for front ends 439 using attribs.c. If one is NULL, it is ignored. Respectively, a 440 table of attributes specific to the language, a table of 441 attributes common to two or more languages (to allow easy 442 sharing), and a table of attributes for checking formats. */ 443 const struct attribute_spec *attribute_table; 444 const struct attribute_spec *common_attribute_table; 445 const struct attribute_spec *format_attribute_table; 446 447 struct lang_hooks_for_tree_inlining tree_inlining; 448 449 struct lang_hooks_for_callgraph callgraph; 450 451 struct lang_hooks_for_tree_dump tree_dump; 452 453 struct lang_hooks_for_decls decls; 454 455 struct lang_hooks_for_types types; 456 457 struct lang_hooks_for_lipo l_ipo; 458 459 /* Perform language-specific gimplification on the argument. Returns an 460 enum gimplify_status, though we can't see that type here. */ 461 int (*gimplify_expr) (tree *, gimple_seq *, gimple_seq *); 462 463 /* Return the virtual function decl for the given OBJ_TYPE_REF expression. */ 464 tree (*get_virtual_function_decl) (tree, tree); 465 466 /* Fold an OBJ_TYPE_REF expression to the address of a function. 467 KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */ 468 tree (*fold_obj_type_ref) (tree, tree); 469 470 /* Determine whether the given DECL is a compiler-generated base field 471 in a derived class. */ 472 bool (*decl_is_base_field) (tree); 473 474 /* Return true if DECL is a constructor. */ 475 bool (*decl_is_constructor) (tree); 476 477 /* Return true if DECL is a destructor. */ 478 bool (*decl_is_destructor) (tree); 479 480 /* Return 481 1 if decl is a const member function, 482 2 if decl is not a const member function but has a const overload that 483 has identical parameter list, 484 0 otherwise. */ 485 int (*decl_is_const_member_func) (tree); 486 487 /* Do language specific processing in the builtin function DECL */ 488 tree (*builtin_function) (tree decl); 489 490 /* Like builtin_function, but make sure the scope is the external scope. 491 This is used to delay putting in back end builtin functions until the ISA 492 that defines the builtin is declared via function specific target options, 493 which can save memory for machines like the x86_64 that have multiple 494 ISAs. If this points to the same function as builtin_function, the 495 backend must add all of the builtins at program initialization time. */ 496 tree (*builtin_function_ext_scope) (tree decl); 497 498 /* Returns true if DECL is a user defined conversion operator (C++). */ 499 bool (*user_conv_function_p) (tree decl); 500 501 /* Used to set up the tree_contains_structure array for a frontend. */ 502 void (*init_ts) (void); 503 504 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR 505 to a contained expression or DECL, possibly updating *TC or *SE 506 if in the process TREE_CONSTANT or TREE_SIDE_EFFECTS need updating. */ 507 tree (*expr_to_decl) (tree expr, bool *tc, bool *se); 508 509 /* Whenever you add entries here, make sure you adjust langhooks-def.h 510 and langhooks.c accordingly. */ 511 }; 512 513 /* Each front end provides its own. */ 514 extern const struct lang_hooks lang_hooks; 515 extern tree add_builtin_function (const char *name, tree type, 516 int function_code, enum built_in_class cl, 517 const char *library_name, 518 tree attrs); 519 520 extern tree add_builtin_function_ext_scope (const char *name, tree type, 521 int function_code, 522 enum built_in_class cl, 523 const char *library_name, 524 tree attrs); 525 526 #endif /* GCC_LANG_HOOKS_H */ 527
