1/* The lang_hooks data structure. 2 Copyright 2001, 2002, 2003, 2004, 2005 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 28/* A print hook for print_tree (). */ 29typedef void (*lang_print_tree_hook) (FILE *, tree, int indent); 30 31/* The following hooks are documented in langhooks.c. Must not be 32 NULL. */ 33 34struct lang_hooks_for_tree_inlining 35{ 36 tree (*walk_subtrees) (tree *, int *, 37 tree (*) (tree *, int *, void *), 38 void *, struct pointer_set_t*); 39 int (*cannot_inline_tree_fn) (tree *); 40 int (*disregard_inline_limits) (tree); 41 tree (*add_pending_fn_decls) (void *, tree); 42 int (*auto_var_in_fn_p) (tree, tree); 43 int (*anon_aggr_type_p) (tree); 44 bool (*var_mod_type_p) (tree, tree); 45 int (*start_inlining) (tree); 46 void (*end_inlining) (tree); 47 tree (*convert_parm_for_inlining) (tree, tree, tree, int); 48}; 49 50struct lang_hooks_for_callgraph 51{ 52 /* The node passed is a language-specific tree node. If its contents 53 are relevant to use of other declarations, mark them. */ 54 tree (*analyze_expr) (tree *, int *, tree); 55 56 /* Produce RTL for function passed as argument. */ 57 void (*expand_function) (tree); 58}; 59 60/* Lang hooks for management of language-specific data or status 61 when entering / leaving functions etc. */ 62struct lang_hooks_for_functions 63{ 64 /* Called when entering a function. */ 65 void (*init) (struct function *); 66 67 /* Called when leaving a function. */ 68 void (*final) (struct function *); 69 70 /* Called when entering a nested function. */ 71 void (*enter_nested) (struct function *); 72 73 /* Called when leaving a nested function. */ 74 void (*leave_nested) (struct function *); 75 76 /* Determines if it's ok for a function to have no noreturn attribute. */ 77 bool (*missing_noreturn_ok_p) (tree); 78}; 79 80/* The following hooks are used by tree-dump.c. */ 81 82struct lang_hooks_for_tree_dump 83{ 84 /* Dump language-specific parts of tree nodes. Returns nonzero if it 85 does not want the usual dumping of the second argument. */ 86 bool (*dump_tree) (void *, tree); 87 88 /* Determine type qualifiers in a language-specific way. */ 89 int (*type_quals) (tree); 90}; 91 92/* Hooks related to types. */ 93 94struct lang_hooks_for_types 95{ 96 /* Return a new type (with the indicated CODE), doing whatever 97 language-specific processing is required. */ 98 tree (*make_type) (enum tree_code); 99 100 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that 101 mode. */ 102 tree (*type_for_mode) (enum machine_mode, int); 103 104 /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an 105 integer type with at least that precision. */ 106 tree (*type_for_size) (unsigned, int); 107 108 /* Given an integer type T, return a type like T but unsigned. 109 If T is unsigned, the value is T. */ 110 tree (*unsigned_type) (tree); 111 112 /* Given an integer type T, return a type like T but signed. 113 If T is signed, the value is T. */ 114 tree (*signed_type) (tree); 115 116 /* Return a type the same as TYPE except unsigned or signed 117 according to UNSIGNEDP. */ 118 tree (*signed_or_unsigned_type) (int, tree); 119 120 /* Given a type, apply default promotions to unnamed function 121 arguments and return the new type. Return the same type if no 122 change. Required by any language that supports variadic 123 arguments. The default hook dies. */ 124 tree (*type_promotes_to) (tree); 125 126 /* Register TYPE as a builtin type with the indicated NAME. The 127 TYPE is placed in the outermost lexical scope. The semantics 128 should be analogous to: 129 130 typedef TYPE NAME; 131 132 in C. The default hook ignores the declaration. */ 133 void (*register_builtin_type) (tree, const char *); 134 135 /* This routine is called in tree.c to print an error message for 136 invalid use of an incomplete type. VALUE is the expression that 137 was used (or 0 if that isn't known) and TYPE is the type that was 138 invalid. */ 139 void (*incomplete_type_error) (tree value, tree type); 140 141 /* Called from assign_temp to return the maximum size, if there is one, 142 for a type. */ 143 tree (*max_size) (tree); 144 145 /* Nonzero if types that are identical are to be hashed so that only 146 one copy is kept. If a language requires unique types for each 147 user-specified type, such as Ada, this should be set to TRUE. */ 148 bool hash_types; 149}; 150 151/* Language hooks related to decls and the symbol table. */ 152 153struct lang_hooks_for_decls 154{ 155 /* Returns nonzero if we are in the global binding level. Ada 156 returns -1 for an undocumented reason used in stor-layout.c. */ 157 int (*global_bindings_p) (void); 158 159 /* Insert BLOCK at the end of the list of subblocks of the 160 current binding level. This is used when a BIND_EXPR is expanded, 161 to handle the BLOCK node inside the BIND_EXPR. */ 162 void (*insert_block) (tree); 163 164 /* Function to add a decl to the current scope level. Takes one 165 argument, a decl to add. Returns that decl, or, if the same 166 symbol is already declared, may return a different decl for that 167 name. */ 168 tree (*pushdecl) (tree); 169 170 /* Returns the chain of decls so far in the current scope level. */ 171 tree (*getdecls) (void); 172 173/* Look up NAME in the current scope and its superiors 174 in the namespace of variables, functions and typedefs. 175 Return a ..._DECL node of some kind representing its definition, 176 or return 0 if it is undefined. */ 177 tree (*lookup_name) (tree); 178 179 /* Returns true when we should warn for an unused global DECL. 180 We will already have checked that it has static binding. */ 181 bool (*warn_unused_global) (tree); 182 183 /* Obtain a list of globals and do final output on them at end 184 of compilation */ 185 void (*final_write_globals) (void); 186 187 /* Do necessary preparations before assemble_variable can proceed. */ 188 void (*prepare_assemble_variable) (tree); 189 190 /* True if this decl may be called via a sibcall. */ 191 bool (*ok_for_sibcall) (tree); 192 193 /* Return the COMDAT group into which this DECL should be placed. 194 It is known that the DECL belongs in *some* COMDAT group when 195 this hook is called. The return value will be used immediately, 196 but not explicitly deallocated, so implementations should not use 197 xmalloc to allocate the string returned. (Typically, the return 198 value will be the string already stored in an 199 IDENTIFIER_NODE.) */ 200 const char * (*comdat_group) (tree); 201}; 202 203/* Language-specific hooks. See langhooks-def.h for defaults. */ 204 205struct lang_hooks 206{ 207 /* String identifying the front end. e.g. "GNU C++". */ 208 const char *name; 209 210 /* sizeof (struct lang_identifier), so make_node () creates 211 identifier nodes long enough for the language-specific slots. */ 212 size_t identifier_size; 213 214 /* Determines the size of any language-specific tcc_constant or 215 tcc_exceptional nodes. Since it is called from make_node, the 216 only information available is the tree code. Expected to die 217 on unrecognized codes. */ 218 size_t (*tree_size) (enum tree_code); 219 220 /* The first callback made to the front end, for simple 221 initialization needed before any calls to handle_option. Return 222 the language mask to filter the switch array with. */ 223 unsigned int (*init_options) (unsigned int argc, const char **argv); 224 225 /* Callback used to perform language-specific initialization for the 226 global diagnostic context structure. */ 227 void (*initialize_diagnostics) (struct diagnostic_context *); 228 229 /* Handle the switch CODE, which has real type enum opt_code from 230 options.h. If the switch takes an argument, it is passed in ARG 231 which points to permanent storage. The handler is responsible for 232 checking whether ARG is NULL, which indicates that no argument 233 was in fact supplied. For -f and -W switches, VALUE is 1 or 0 234 for the positive and negative forms respectively. 235 236 Return 1 if the switch is valid, 0 if invalid, and -1 if it's 237 valid and should not be treated as language-independent too. */ 238 int (*handle_option) (size_t code, const char *arg, int value); 239 240 /* Return false to use the default complaint about a missing 241 argument, otherwise output a complaint and return true. */ 242 bool (*missing_argument) (const char *opt, size_t code); 243 244 /* Called when all command line options have been parsed to allow 245 further processing and initialization 246 247 Should return true to indicate that a compiler back-end is 248 not required, such as with the -E option. 249 250 If errorcount is nonzero after this call the compiler exits 251 immediately and the finish hook is not called. */ 252 bool (*post_options) (const char **); 253 254 /* Called after post_options to initialize the front end. Return 255 false to indicate that no further compilation be performed, in 256 which case the finish hook is called immediately. */ 257 bool (*init) (void); 258 259 /* Called at the end of compilation, as a finalizer. */ 260 void (*finish) (void); 261 262 /* Parses the entire file. The argument is nonzero to cause bison 263 parsers to dump debugging information during parsing. */ 264 void (*parse_file) (int); 265 266 /* Called immediately after parsing to clear the binding stack. */ 267 void (*clear_binding_stack) (void); 268 269 /* Called to obtain the alias set to be used for an expression or type. 270 Returns -1 if the language does nothing special for it. */ 271 HOST_WIDE_INT (*get_alias_set) (tree); 272 273 /* Called with an expression that is to be processed as a constant. 274 Returns either the same expression or a language-independent 275 constant equivalent to its input. */ 276 tree (*expand_constant) (tree); 277 278 /* Called by expand_expr for language-specific tree codes. 279 Fourth argument is actually an enum expand_modifier. */ 280 rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *); 281 282 /* Called by expand_expr to generate the definition of a decl. Returns 283 1 if handled, 0 otherwise. */ 284 int (*expand_decl) (tree); 285 286 /* Hook called by safe_from_p for language-specific tree codes. It is 287 up to the language front-end to install a hook if it has any such 288 codes that safe_from_p needs to know about. Since same_from_p will 289 recursively explore the TREE_OPERANDs of an expression, this hook 290 should not reexamine those pieces. This routine may recursively 291 call safe_from_p; it should always pass `0' as the TOP_P 292 parameter. */ 293 int (*safe_from_p) (rtx, tree); 294 295 /* Function to finish handling an incomplete decl at the end of 296 compilation. Default hook is does nothing. */ 297 void (*finish_incomplete_decl) (tree); 298 299 /* Mark EXP saying that we need to be able to take the address of 300 it; it should not be allocated in a register. Return true if 301 successful. */ 302 bool (*mark_addressable) (tree); 303 304 /* Hook called by staticp for language-specific tree codes. */ 305 tree (*staticp) (tree); 306 307 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the 308 DECL_NODE with a newly GC-allocated copy. */ 309 void (*dup_lang_specific_decl) (tree); 310 311 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of 312 thing that the assembler should talk about, set 313 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE. 314 Otherwise, set it to the ERROR_MARK_NODE to ensure that the 315 assembler does not talk about it. */ 316 void (*set_decl_assembler_name) (tree); 317 318 /* Return nonzero if fold-const is free to use bit-field 319 optimizations, for instance in fold_truthop(). */ 320 bool (*can_use_bit_fields_p) (void); 321 322 /* Nonzero if operations on types narrower than their mode should 323 have their results reduced to the precision of the type. */ 324 bool reduce_bit_field_operations; 325 326 /* Nonzero if this front end does not generate a dummy BLOCK between 327 the outermost scope of the function and the FUNCTION_DECL. See 328 is_body_block in stmt.c, and its callers. */ 329 bool no_body_blocks; 330 331 /* The front end can add its own statistics to -fmem-report with 332 this hook. It should output to stderr. */ 333 void (*print_statistics) (void); 334 335 /* Called by print_tree when there is a tree of class tcc_exceptional 336 that it doesn't know how to display. */ 337 lang_print_tree_hook print_xnode; 338 339 /* Called to print language-dependent parts of tcc_decl, tcc_type, 340 and IDENTIFIER_NODE nodes. */ 341 lang_print_tree_hook print_decl; 342 lang_print_tree_hook print_type; 343 lang_print_tree_hook print_identifier; 344 345 /* Computes the name to use to print a declaration. DECL is the 346 non-NULL declaration in question. VERBOSITY determines what 347 information will be printed: 0: DECL_NAME, demangled as 348 necessary. 1: and scope information. 2: and any other 349 information that might be interesting, such as function parameter 350 types in C++. */ 351 const char *(*decl_printable_name) (tree decl, int verbosity); 352 353 /* This compares two types for equivalence ("compatible" in C-based languages). 354 This routine should only return 1 if it is sure. It should not be used 355 in contexts where erroneously returning 0 causes problems. */ 356 int (*types_compatible_p) (tree x, tree y); 357 358 /* Given a CALL_EXPR, return a function decl that is its target. */ 359 tree (*lang_get_callee_fndecl) (tree); 360 361 /* Called by report_error_function to print out function name. */ 362 void (*print_error_function) (struct diagnostic_context *, const char *); 363 364 /* Called from expr_size to calculate the size of the value of an 365 expression in a language-dependent way. Returns a tree for the size 366 in bytes. A frontend can call lhd_expr_size to get the default 367 semantics in cases that it doesn't want to handle specially. */ 368 tree (*expr_size) (tree); 369 370 /* Convert a character from the host's to the target's character 371 set. The character should be in what C calls the "basic source 372 character set" (roughly, the set of characters defined by plain 373 old ASCII). The default is to return the character unchanged, 374 which is correct in most circumstances. Note that both argument 375 and result should be sign-extended under -fsigned-char, 376 zero-extended under -fno-signed-char. */ 377 HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT); 378 379 /* Pointers to machine-independent attribute tables, for front ends 380 using attribs.c. If one is NULL, it is ignored. Respectively, a 381 table of attributes specific to the language, a table of 382 attributes common to two or more languages (to allow easy 383 sharing), and a table of attributes for checking formats. */ 384 const struct attribute_spec *attribute_table; 385 const struct attribute_spec *common_attribute_table; 386 const struct attribute_spec *format_attribute_table; 387 388 /* Function-related language hooks. */ 389 struct lang_hooks_for_functions function; 390 391 struct lang_hooks_for_tree_inlining tree_inlining; 392 393 struct lang_hooks_for_callgraph callgraph; 394 395 struct lang_hooks_for_tree_dump tree_dump; 396 397 struct lang_hooks_for_decls decls; 398 399 struct lang_hooks_for_types types; 400 401 /* Perform language-specific gimplification on the argument. Returns an 402 enum gimplify_status, though we can't see that type here. */ 403 int (*gimplify_expr) (tree *, tree *, tree *); 404 405 /* Fold an OBJ_TYPE_REF expression to the address of a function. 406 KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */ 407 tree (*fold_obj_type_ref) (tree, tree); 408 409 /* Return a definition for a builtin function named NAME and whose data type 410 is TYPE. TYPE should be a function type with argument types. 411 FUNCTION_CODE tells later passes how to compile calls to this function. 412 See tree.h for its possible values. 413 414 If LIBRARY_NAME is nonzero, use that for DECL_ASSEMBLER_NAME, 415 the name to be called if we can't opencode the function. If 416 ATTRS is nonzero, use that for the function's attribute list. */ 417 tree (*builtin_function) (const char *name, tree type, int function_code, 418 enum built_in_class bt_class, 419 const char *library_name, tree attrs); 420 421 /* Used to set up the tree_contains_structure array for a frontend. */ 422 void (*init_ts) (void); 423 424 /* Called by recompute_tree_invarant_for_addr_expr to go from EXPR 425 to a contained expression or DECL, possibly updating *TC, *TI or 426 *SE if in the process TREE_CONSTANT, TREE_INVARIANT or 427 TREE_SIDE_EFFECTS need updating. */ 428 tree (*expr_to_decl) (tree expr, bool *tc, bool *ti, bool *se); 429 430 /* Whenever you add entries here, make sure you adjust langhooks-def.h 431 and langhooks.c accordingly. */ 432}; 433 434/* Each front end provides its own. */ 435extern const struct lang_hooks lang_hooks; 436 437#endif /* GCC_LANG_HOOKS_H */ 438