1/* The lang_hooks data structure. 2 Copyright 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. 3 4This file is part of GCC. 5 6GCC is free software; you can redistribute it and/or modify 7it under the terms of the GNU General Public License as published by 8the Free Software Foundation; either version 2, or (at your option) 9any later version. 10 11GCC is distributed in the hope that it will be useful, 12but WITHOUT ANY WARRANTY; without even the implied warranty of 13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14GNU General Public License for more details. 15 16You should have received a copy of the GNU General Public License 17along with GCC; see the file COPYING. If not, write to 18the Free Software Foundation, 51 Franklin Street, Fifth Floor, 19Boston, MA 02110-1301, USA. */ 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 26struct diagnostic_context; 27 28struct gimplify_omp_ctx; 29 30/* A print hook for print_tree (). */ 31typedef void (*lang_print_tree_hook) (FILE *, tree, int indent); 32 33/* The following hooks are documented in langhooks.c. Must not be 34 NULL. */ 35 36struct lang_hooks_for_tree_inlining 37{ 38 tree (*walk_subtrees) (tree *, int *, 39 tree (*) (tree *, int *, void *), 40 void *, struct pointer_set_t*); 41 int (*cannot_inline_tree_fn) (tree *); 42 int (*disregard_inline_limits) (tree); 43 tree (*add_pending_fn_decls) (void *, tree); 44 int (*auto_var_in_fn_p) (tree, tree); 45 int (*anon_aggr_type_p) (tree); 46 bool (*var_mod_type_p) (tree, tree); 47 int (*start_inlining) (tree); 48 void (*end_inlining) (tree); 49 tree (*convert_parm_for_inlining) (tree, tree, tree, int); 50}; 51 52struct lang_hooks_for_callgraph 53{ 54 /* The node passed is a language-specific tree node. If its contents 55 are relevant to use of other declarations, mark them. */ 56 tree (*analyze_expr) (tree *, int *, tree); 57 58 /* Produce RTL for function passed as argument. */ 59 void (*expand_function) (tree); 60}; 61 62/* Lang hooks for management of language-specific data or status 63 when entering / leaving functions etc. */ 64struct lang_hooks_for_functions 65{ 66 /* Called when entering a function. */ 67 void (*init) (struct function *); 68 69 /* Called when leaving a function. */ 70 void (*final) (struct function *); 71 72 /* Called when entering a nested function. */ 73 void (*enter_nested) (struct function *); 74 75 /* Called when leaving a nested function. */ 76 void (*leave_nested) (struct function *); 77 78 /* Determines if it's ok for a function to have no noreturn attribute. */ 79 bool (*missing_noreturn_ok_p) (tree); 80}; 81 82/* The following hooks are used by tree-dump.c. */ 83 84struct lang_hooks_for_tree_dump 85{ 86 /* Dump language-specific parts of tree nodes. Returns nonzero if it 87 does not want the usual dumping of the second argument. */ 88 bool (*dump_tree) (void *, tree); 89 90 /* Determine type qualifiers in a language-specific way. */ 91 int (*type_quals) (tree); 92}; 93 94/* Hooks related to types. */ 95 96struct lang_hooks_for_types 97{ 98 /* Return a new type (with the indicated CODE), doing whatever 99 language-specific processing is required. */ 100 tree (*make_type) (enum tree_code); 101 102 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that 103 mode. */ 104 tree (*type_for_mode) (enum machine_mode, int); 105 106 /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an 107 integer type with at least that precision. */ 108 tree (*type_for_size) (unsigned, int); 109 110 /* Given an integer type T, return a type like T but unsigned. 111 If T is unsigned, the value is T. */ 112 tree (*unsigned_type) (tree); 113 114 /* Given an integer type T, return a type like T but signed. 115 If T is signed, the value is T. */ 116 tree (*signed_type) (tree); 117 118 /* Return a type the same as TYPE except unsigned or signed 119 according to UNSIGNEDP. */ 120 tree (*signed_or_unsigned_type) (int, tree); 121 122 /* True if the type is an instantiation of a generic type, 123 e.g. C++ template implicit specializations. */ 124 bool (*generic_p) (tree); 125 126 /* Given a type, apply default promotions to unnamed function 127 arguments and return the new type. Return the same type if no 128 change. Required by any language that supports variadic 129 arguments. The default hook dies. */ 130 tree (*type_promotes_to) (tree); 131 132 /* Register TYPE as a builtin type with the indicated NAME. The 133 TYPE is placed in the outermost lexical scope. The semantics 134 should be analogous to: 135 136 typedef TYPE NAME; 137 138 in C. The default hook ignores the declaration. */ 139 void (*register_builtin_type) (tree, const char *); 140 141 /* This routine is called in tree.c to print an error message for 142 invalid use of an incomplete type. VALUE is the expression that 143 was used (or 0 if that isn't known) and TYPE is the type that was 144 invalid. */ 145 void (*incomplete_type_error) (tree value, tree type); 146 147 /* Called from assign_temp to return the maximum size, if there is one, 148 for a type. */ 149 tree (*max_size) (tree); 150 151 /* Register language specific type size variables as potentially OpenMP 152 firstprivate variables. */ 153 void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree); 154 155 /* APPLE LOCAL begin radar 6386976 */ 156 /* Determine whether the type-tree passed in is specific to the 157 language/runtime definitions, e.g. is an Objective-C class... */ 158 bool (*is_runtime_specific_type) (tree); 159 /* APPLE LOCAL end radar 6386976 */ 160 161 /* Nonzero if types that are identical are to be hashed so that only 162 one copy is kept. If a language requires unique types for each 163 user-specified type, such as Ada, this should be set to TRUE. */ 164 bool hash_types; 165}; 166 167/* Language hooks related to decls and the symbol table. */ 168 169struct lang_hooks_for_decls 170{ 171 /* Returns nonzero if we are in the global binding level. Ada 172 returns -1 for an undocumented reason used in stor-layout.c. */ 173 int (*global_bindings_p) (void); 174 175 /* Insert BLOCK at the end of the list of subblocks of the 176 current binding level. This is used when a BIND_EXPR is expanded, 177 to handle the BLOCK node inside the BIND_EXPR. */ 178 void (*insert_block) (tree); 179 180 /* Function to add a decl to the current scope level. Takes one 181 argument, a decl to add. Returns that decl, or, if the same 182 symbol is already declared, may return a different decl for that 183 name. */ 184 tree (*pushdecl) (tree); 185 186 /* Returns the chain of decls so far in the current scope level. */ 187 tree (*getdecls) (void); 188 189 /* Returns true when we should warn for an unused global DECL. 190 We will already have checked that it has static binding. */ 191 bool (*warn_unused_global) (tree); 192 193 /* Obtain a list of globals and do final output on them at end 194 of compilation */ 195 void (*final_write_globals) (void); 196 197 /* Do necessary preparations before assemble_variable can proceed. */ 198 void (*prepare_assemble_variable) (tree); 199 200 /* True if this decl may be called via a sibcall. */ 201 bool (*ok_for_sibcall) (tree); 202 203 /* Return the COMDAT group into which this DECL should be placed. 204 It is known that the DECL belongs in *some* COMDAT group when 205 this hook is called. The return value will be used immediately, 206 but not explicitly deallocated, so implementations should not use 207 xmalloc to allocate the string returned. (Typically, the return 208 value will be the string already stored in an 209 IDENTIFIER_NODE.) */ 210 const char * (*comdat_group) (tree); 211 212 /* True if OpenMP should privatize what this DECL points to rather 213 than the DECL itself. */ 214 bool (*omp_privatize_by_reference) (tree); 215 216 /* Return sharing kind if OpenMP sharing attribute of DECL is 217 predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise. */ 218 enum omp_clause_default_kind (*omp_predetermined_sharing) (tree); 219 220 /* Return true if DECL's DECL_VALUE_EXPR (if any) should be 221 disregarded in OpenMP construct, because it is going to be 222 remapped during OpenMP lowering. SHARED is true if DECL 223 is going to be shared, false if it is going to be privatized. */ 224 bool (*omp_disregard_value_expr) (tree, bool); 225 226 /* Return true if DECL that is shared iff SHARED is true should 227 be put into OMP_CLAUSE_PRIVATE_DEBUG. */ 228 bool (*omp_private_debug_clause) (tree, bool); 229 230 /* Build and return code for a default constructor for DECL in 231 response to CLAUSE. Return NULL if nothing to be done. */ 232 tree (*omp_clause_default_ctor) (tree clause, tree decl); 233 234 /* Build and return code for a copy constructor from SRC to DST. */ 235 tree (*omp_clause_copy_ctor) (tree clause, tree dst, tree src); 236 237 /* Similarly, except use an assignment operator instead. */ 238 tree (*omp_clause_assign_op) (tree clause, tree dst, tree src); 239 240 /* Build and return code destructing DECL. Return NULL if nothing 241 to be done. */ 242 tree (*omp_clause_dtor) (tree clause, tree decl); 243}; 244 245/* Language-specific hooks. See langhooks-def.h for defaults. */ 246 247struct lang_hooks 248{ 249 /* String identifying the front end. e.g. "GNU C++". */ 250 const char *name; 251 252 /* sizeof (struct lang_identifier), so make_node () creates 253 identifier nodes long enough for the language-specific slots. */ 254 size_t identifier_size; 255 256 /* Determines the size of any language-specific tcc_constant or 257 tcc_exceptional nodes. Since it is called from make_node, the 258 only information available is the tree code. Expected to die 259 on unrecognized codes. */ 260 size_t (*tree_size) (enum tree_code); 261 262 /* The first callback made to the front end, for simple 263 initialization needed before any calls to handle_option. Return 264 the language mask to filter the switch array with. */ 265 unsigned int (*init_options) (unsigned int argc, const char **argv); 266 267 /* Callback used to perform language-specific initialization for the 268 global diagnostic context structure. */ 269 void (*initialize_diagnostics) (struct diagnostic_context *); 270 271 /* Handle the switch CODE, which has real type enum opt_code from 272 options.h. If the switch takes an argument, it is passed in ARG 273 which points to permanent storage. The handler is responsible for 274 checking whether ARG is NULL, which indicates that no argument 275 was in fact supplied. For -f and -W switches, VALUE is 1 or 0 276 for the positive and negative forms respectively. 277 278 Return 1 if the switch is valid, 0 if invalid, and -1 if it's 279 valid and should not be treated as language-independent too. */ 280 int (*handle_option) (size_t code, const char *arg, int value); 281 282 /* Return false to use the default complaint about a missing 283 argument, otherwise output a complaint and return true. */ 284 bool (*missing_argument) (const char *opt, size_t code); 285 286 /* Called when all command line options have been parsed to allow 287 further processing and initialization 288 289 Should return true to indicate that a compiler back-end is 290 not required, such as with the -E option. 291 292 If errorcount is nonzero after this call the compiler exits 293 immediately and the finish hook is not called. */ 294 bool (*post_options) (const char **); 295 296 /* Called after post_options to initialize the front end. Return 297 false to indicate that no further compilation be performed, in 298 which case the finish hook is called immediately. */ 299 bool (*init) (void); 300 301 /* Called at the end of compilation, as a finalizer. */ 302 void (*finish) (void); 303 304 /* Parses the entire file. The argument is nonzero to cause bison 305 parsers to dump debugging information during parsing. */ 306 void (*parse_file) (int); 307 308 /* Called immediately after parsing to clear the binding stack. */ 309 void (*clear_binding_stack) (void); 310 311 /* Called to obtain the alias set to be used for an expression or type. 312 Returns -1 if the language does nothing special for it. */ 313 HOST_WIDE_INT (*get_alias_set) (tree); 314 315 /* Called with an expression that is to be processed as a constant. 316 Returns either the same expression or a language-independent 317 constant equivalent to its input. */ 318 tree (*expand_constant) (tree); 319 320 /* Called by expand_expr for language-specific tree codes. 321 Fourth argument is actually an enum expand_modifier. */ 322 rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *); 323 324 /* Called by expand_expr to generate the definition of a decl. Returns 325 1 if handled, 0 otherwise. */ 326 int (*expand_decl) (tree); 327 328 /* Hook called by safe_from_p for language-specific tree codes. It is 329 up to the language front-end to install a hook if it has any such 330 codes that safe_from_p needs to know about. Since same_from_p will 331 recursively explore the TREE_OPERANDs of an expression, this hook 332 should not reexamine those pieces. This routine may recursively 333 call safe_from_p; it should always pass `0' as the TOP_P 334 parameter. */ 335 int (*safe_from_p) (rtx, tree); 336 337 /* Function to finish handling an incomplete decl at the end of 338 compilation. Default hook is does nothing. */ 339 void (*finish_incomplete_decl) (tree); 340 341 /* Mark EXP saying that we need to be able to take the address of 342 it; it should not be allocated in a register. Return true if 343 successful. */ 344 bool (*mark_addressable) (tree); 345 346 /* Hook called by staticp for language-specific tree codes. */ 347 tree (*staticp) (tree); 348 349 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the 350 DECL_NODE with a newly GC-allocated copy. */ 351 void (*dup_lang_specific_decl) (tree); 352 353 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of 354 thing that the assembler should talk about, set 355 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. 356 Otherwise, set it to the ERROR_MARK_NODE to ensure that the 357 assembler does not talk about it. */ 358 void (*set_decl_assembler_name) (tree); 359 360 /* Return nonzero if fold-const is free to use bit-field 361 optimizations, for instance in fold_truthop(). */ 362 bool (*can_use_bit_fields_p) (void); 363 364 /* Nonzero if operations on types narrower than their mode should 365 have their results reduced to the precision of the type. */ 366 bool reduce_bit_field_operations; 367 368 /* Nonzero if this front end does not generate a dummy BLOCK between 369 the outermost scope of the function and the FUNCTION_DECL. See 370 is_body_block in stmt.c, and its callers. */ 371 bool no_body_blocks; 372 373 /* The front end can add its own statistics to -fmem-report with 374 this hook. It should output to stderr. */ 375 void (*print_statistics) (void); 376 377 /* Called by print_tree when there is a tree of class tcc_exceptional 378 that it doesn't know how to display. */ 379 lang_print_tree_hook print_xnode; 380 381 /* Called to print language-dependent parts of tcc_decl, tcc_type, 382 and IDENTIFIER_NODE nodes. */ 383 lang_print_tree_hook print_decl; 384 lang_print_tree_hook print_type; 385 lang_print_tree_hook print_identifier; 386 387 /* Computes the name to use to print a declaration. DECL is the 388 non-NULL declaration in question. VERBOSITY determines what 389 information will be printed: 0: DECL_NAME, demangled as 390 necessary. 1: and scope information. 2: and any other 391 information that might be interesting, such as function parameter 392 types in C++. */ 393 const char *(*decl_printable_name) (tree decl, int verbosity); 394 395 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what 396 information will be printed: 0: DECL_NAME, demangled as 397 necessary. 1: and scope information. */ 398 const char *(*dwarf_name) (tree, int verbosity); 399 400 /* This compares two types for equivalence ("compatible" in C-based languages). 401 This routine should only return 1 if it is sure. It should not be used 402 in contexts where erroneously returning 0 causes problems. */ 403 int (*types_compatible_p) (tree x, tree y); 404 405 /* Given a CALL_EXPR, return a function decl that is its target. */ 406 tree (*lang_get_callee_fndecl) (tree); 407 408 /* Called by report_error_function to print out function name. */ 409 void (*print_error_function) (struct diagnostic_context *, const char *); 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) (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 /* Function-related language hooks. */ 436 struct lang_hooks_for_functions function; 437 438 struct lang_hooks_for_tree_inlining tree_inlining; 439 440 struct lang_hooks_for_callgraph callgraph; 441 442 struct lang_hooks_for_tree_dump tree_dump; 443 444 struct lang_hooks_for_decls decls; 445 446 struct lang_hooks_for_types types; 447 448 /* Perform language-specific gimplification on the argument. Returns an 449 enum gimplify_status, though we can't see that type here. */ 450 int (*gimplify_expr) (tree *, tree *, tree *); 451 452 /* Fold an OBJ_TYPE_REF expression to the address of a function. 453 KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */ 454 tree (*fold_obj_type_ref) (tree, tree); 455 456 /* Return a definition for a builtin function named NAME and whose data type 457 is TYPE. TYPE should be a function type with argument types. 458 FUNCTION_CODE tells later passes how to compile calls to this function. 459 See tree.h for its possible values. 460 461 If LIBRARY_NAME is nonzero, use that for DECL_ASSEMBLER_NAME, 462 the name to be called if we can't opencode the function. If 463 ATTRS is nonzero, use that for the function's attribute list. */ 464 tree (*builtin_function) (const char *name, tree type, int function_code, 465 enum built_in_class bt_class, 466 const char *library_name, tree attrs); 467 468 /* Used to set up the tree_contains_structure array for a frontend. */ 469 void (*init_ts) (void); 470 471 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR 472 to a contained expression or DECL, possibly updating *TC, *TI or 473 *SE if in the process TREE_CONSTANT, TREE_INVARIANT or 474 TREE_SIDE_EFFECTS need updating. */ 475 tree (*expr_to_decl) (tree expr, bool *tc, bool *ti, bool *se); 476 477 /* APPLE LOCAL begin radar 6353006 */ 478 /* For c-based languages, builds a generic type for Blocks pointers (for 479 emitting debug information. For other languages, returns NULL. */ 480 tree (*build_generic_block_struct_type) (void); 481 /* APPLE LOCAL end radar 6353006 */ 482 483 /* Whenever you add entries here, make sure you adjust langhooks-def.h 484 and langhooks.c accordingly. */ 485}; 486 487/* Each front end provides its own. */ 488extern const struct lang_hooks lang_hooks; 489 490#endif /* GCC_LANG_HOOKS_H */ 491