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 223 /* Lang hooks for LIPO. */ 224 225 struct lang_hooks_for_lipo 226 { 227 /* Add DECL to the list of predefined builtins. */ 228 void (*add_built_in_decl) (tree decl); 229 230 /* Save the tree (by making a copy) and binding values 231 for builtins before parsing start. */ 232 void (*save_built_in_decl_pre_parsing) (void); 233 234 /* Restore builtins and their bindings to their values 235 before parsing. */ 236 void (*restore_built_in_decl_pre_parsing) (void); 237 238 /* Save the tree (by making a copy) and binding values for 239 builtins after parsing of a file. */ 240 void (*save_built_in_decl_post_module_parsing) (void); 241 242 /* Restore builtins and their bindings to their post 243 parsing values. */ 244 void (*restore_built_in_decl_post_module_parsing) (void); 245 246 /* Clear symbol binding for name ID. */ 247 void (*clear_global_name_bindings) (tree id); 248 249 /* Return true if DECL in SCOPE is scoped in global/namespace scope, 250 otherwise return false. */ 251 bool (*has_global_name) (tree decl, void *scope); 252 253 /* Return the actual size of the lang_decl struct for 254 decl T. */ 255 int (*get_lang_decl_size) (tree t); 256 257 /* Duplicate language specific type information from SRC 258 to DEST. */ 259 void (*dup_lang_type) (tree src, tree dest); 260 261 /* Copy DEST into SRC. */ 262 void (*copy_lang_type) (tree src, tree dest); 263 264 /* Process decls after parsing of a source module. */ 265 void (*process_pending_decls) (unsigned); 266 267 /* Clear the list of deferred functions. */ 268 void (*clear_deferred_fns) (void); 269 270 /* Return true if T is compiler generated. */ 271 bool (*is_compiler_generated_type) (tree t); 272 273 /* Compare language specific types T1 and T2. 274 Return 1 if they are compatible. */ 275 int (*cmp_lang_type) (tree t1, tree t2); 276 }; 277 278 /* Language-specific hooks. See langhooks-def.h for defaults. */ 279 280 struct lang_hooks 281 { 282 /* String identifying the front end. e.g. "GNU C++". */ 283 const char *name; 284 285 /* sizeof (struct lang_identifier), so make_node () creates 286 identifier nodes long enough for the language-specific slots. */ 287 size_t identifier_size; 288 289 /* Determines the size of any language-specific tcc_constant or 290 tcc_exceptional nodes. Since it is called from make_node, the 291 only information available is the tree code. Expected to die 292 on unrecognized codes. */ 293 size_t (*tree_size) (enum tree_code); 294 295 /* The first callback made to the front end, for simple 296 initialization needed before any calls to handle_option. Return 297 the language mask to filter the switch array with. */ 298 unsigned int (*init_options) (unsigned int argc, const char **argv); 299 300 /* Callback used to perform language-specific initialization for the 301 global diagnostic context structure. */ 302 void (*initialize_diagnostics) (struct diagnostic_context *); 303 304 /* Handle the switch CODE, which has real type enum opt_code from 305 options.h. If the switch takes an argument, it is passed in ARG 306 which points to permanent storage. The handler is responsible for 307 checking whether ARG is NULL, which indicates that no argument 308 was in fact supplied. For -f and -W switches, VALUE is 1 or 0 309 for the positive and negative forms respectively. 310 311 Return 1 if the switch is valid, 0 if invalid, and -1 if it's 312 valid and should not be treated as language-independent too. */ 313 int (*handle_option) (size_t code, const char *arg, int value); 314 315 /* Return false to use the default complaint about a missing 316 argument, otherwise output a complaint and return true. */ 317 bool (*missing_argument) (const char *opt, size_t code); 318 319 /* Called when all command line options have been parsed to allow 320 further processing and initialization 321 322 Should return true to indicate that a compiler back-end is 323 not required, such as with the -E option. 324 325 If errorcount is nonzero after this call the compiler exits 326 immediately and the finish hook is not called. */ 327 bool (*post_options) (const char **); 328 329 /* Called after post_options to initialize the front end. Return 330 false to indicate that no further compilation be performed, in 331 which case the finish hook is called immediately. */ 332 bool (*init) (void); 333 334 /* Called at the end of compilation, as a finalizer. */ 335 void (*finish) (void); 336 337 /* Parses the entire file. The argument is nonzero to cause bison 338 parsers to dump debugging information during parsing. */ 339 void (*parse_file) (int); 340 341 /* Determines if it's ok for a function to have no noreturn attribute. */ 342 bool (*missing_noreturn_ok_p) (tree); 343 344 /* Called to obtain the alias set to be used for an expression or type. 345 Returns -1 if the language does nothing special for it. */ 346 alias_set_type (*get_alias_set) (tree); 347 348 /* Called by expand_expr for language-specific tree codes. 349 Fourth argument is actually an enum expand_modifier. */ 350 rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *); 351 352 /* Function to finish handling an incomplete decl at the end of 353 compilation. Default hook is does nothing. */ 354 void (*finish_incomplete_decl) (tree); 355 356 /* Mark EXP saying that we need to be able to take the address of 357 it; it should not be allocated in a register. Return true if 358 successful. */ 359 bool (*mark_addressable) (tree); 360 361 /* Hook called by staticp for language-specific tree codes. */ 362 tree (*staticp) (tree); 363 364 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the 365 DECL_NODE with a newly GC-allocated copy. */ 366 void (*dup_lang_specific_decl) (tree); 367 368 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of 369 thing that the assembler should talk about, set 370 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. 371 Otherwise, set it to the ERROR_MARK_NODE to ensure that the 372 assembler does not talk about it. */ 373 void (*set_decl_assembler_name) (tree); 374 375 /* The front end can add its own statistics to -fmem-report with 376 this hook. It should output to stderr. */ 377 void (*print_statistics) (void); 378 379 /* Called by print_tree when there is a tree of class tcc_exceptional 380 that it doesn't know how to display. */ 381 lang_print_tree_hook print_xnode; 382 383 /* Called to print language-dependent parts of tcc_decl, tcc_type, 384 and IDENTIFIER_NODE nodes. */ 385 lang_print_tree_hook print_decl; 386 lang_print_tree_hook print_type; 387 lang_print_tree_hook print_identifier; 388 389 /* Computes the name to use to print a declaration. DECL is the 390 non-NULL declaration in question. VERBOSITY determines what 391 information will be printed: 0: DECL_NAME, demangled as 392 necessary. 1: and scope information. 2: and any other 393 information that might be interesting, such as function parameter 394 types in C++. */ 395 const char *(*decl_printable_name) (tree decl, int verbosity); 396 397 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what 398 information will be printed: 0: DECL_NAME, demangled as 399 necessary. 1: and scope information. */ 400 const char *(*dwarf_name) (tree, int verbosity); 401 402 /* This compares two types for equivalence ("compatible" in C-based languages). 403 This routine should only return 1 if it is sure. It should not be used 404 in contexts where erroneously returning 0 causes problems. */ 405 int (*types_compatible_p) (tree x, tree y); 406 407 /* Called by report_error_function to print out function name. */ 408 void (*print_error_function) (struct diagnostic_context *, const char *, 409 struct diagnostic_info *); 410 411 /* Called from expr_size to calculate the size of the value of an 412 expression in a language-dependent way. Returns a tree for the size 413 in bytes. A frontend can call lhd_expr_size to get the default 414 semantics in cases that it doesn't want to handle specially. */ 415 tree (*expr_size) (const_tree); 416 417 /* Convert a character from the host's to the target's character 418 set. The character should be in what C calls the "basic source 419 character set" (roughly, the set of characters defined by plain 420 old ASCII). The default is to return the character unchanged, 421 which is correct in most circumstances. Note that both argument 422 and result should be sign-extended under -fsigned-char, 423 zero-extended under -fno-signed-char. */ 424 HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT); 425 426 /* Pointers to machine-independent attribute tables, for front ends 427 using attribs.c. If one is NULL, it is ignored. Respectively, a 428 table of attributes specific to the language, a table of 429 attributes common to two or more languages (to allow easy 430 sharing), and a table of attributes for checking formats. */ 431 const struct attribute_spec *attribute_table; 432 const struct attribute_spec *common_attribute_table; 433 const struct attribute_spec *format_attribute_table; 434 435 struct lang_hooks_for_tree_inlining tree_inlining; 436 437 struct lang_hooks_for_callgraph callgraph; 438 439 struct lang_hooks_for_tree_dump tree_dump; 440 441 struct lang_hooks_for_decls decls; 442 443 struct lang_hooks_for_types types; 444 445 struct lang_hooks_for_lipo l_ipo; 446 447 /* Perform language-specific gimplification on the argument. Returns an 448 enum gimplify_status, though we can't see that type here. */ 449 int (*gimplify_expr) (tree *, gimple_seq *, gimple_seq *); 450 451 /* Fold an OBJ_TYPE_REF expression to the address of a function. 452 KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */ 453 tree (*fold_obj_type_ref) (tree, tree); 454 455 /* Do language specific processing in the builtin function DECL */ 456 tree (*builtin_function) (tree decl); 457 458 /* Like builtin_function, but make sure the scope is the external scope. 459 This is used to delay putting in back end builtin functions until the ISA 460 that defines the builtin is declared via function specific target options, 461 which can save memory for machines like the x86_64 that have multiple 462 ISAs. If this points to the same function as builtin_function, the 463 backend must add all of the builtins at program initialization time. */ 464 tree (*builtin_function_ext_scope) (tree decl); 465 466 /* Returns true if DECL is a user defined conversion operator (C++). */ 467 bool (*user_conv_function_p) (tree decl); 468 469 /* Used to set up the tree_contains_structure array for a frontend. */ 470 void (*init_ts) (void); 471 472 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR 473 to a contained expression or DECL, possibly updating *TC or *SE 474 if in the process TREE_CONSTANT or TREE_SIDE_EFFECTS need updating. */ 475 tree (*expr_to_decl) (tree expr, bool *tc, bool *se); 476 477 /* Whenever you add entries here, make sure you adjust langhooks-def.h 478 and langhooks.c accordingly. */ 479 }; 480 481 /* Each front end provides its own. */ 482 extern const struct lang_hooks lang_hooks; 483 extern tree add_builtin_function (const char *name, tree type, 484 int function_code, enum built_in_class cl, 485 const char *library_name, 486 tree attrs); 487 488 extern tree add_builtin_function_ext_scope (const char *name, tree type, 489 int function_code, 490 enum built_in_class cl, 491 const char *library_name, 492 tree attrs); 493 494 #endif /* GCC_LANG_HOOKS_H */ 495
