1 /* The lang_hooks data structure.
2 Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
5 This file is part of GCC.
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)
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.
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/>. */
21 #ifndef GCC_LANG_HOOKS_H
22 #define GCC_LANG_HOOKS_H
24 /* This file should be #include-d after tree.h. */
26 struct diagnostic_context;
27 struct diagnostic_info;
29 struct gimplify_omp_ctx;
31 struct array_descr_info;
33 /* A print hook for print_tree (). */
34 typedef void (*lang_print_tree_hook) (FILE *, tree, int indent);
37 { RECORD_IS_STRUCT, RECORD_IS_CLASS, RECORD_IS_INTERFACE };
39 /* The following hooks are documented in langhooks.c. Must not be
42 struct lang_hooks_for_tree_inlining
44 bool (*var_mod_type_p) (tree, tree);
47 struct lang_hooks_for_callgraph
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 *);
54 /* The following hooks are used by tree-dump.c. */
56 struct lang_hooks_for_tree_dump
58 /* Dump language-specific parts of tree nodes. Returns nonzero if it
59 does not want the usual dumping of the second argument. */
60 bool (*dump_tree) (void *, tree);
62 /* Determine type qualifiers in a language-specific way. */
63 int (*type_quals) (const_tree);
66 /* Hooks related to types. */
68 struct lang_hooks_for_types
70 /* Return a new type (with the indicated CODE), doing whatever
71 language-specific processing is required. */
72 tree (*make_type) (enum tree_code);
74 /* Return what kind of RECORD_TYPE this is, mainly for purposes of
75 debug information. If not defined, record types are assumed to
77 enum classify_record (*classify_record) (tree);
79 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
81 tree (*type_for_mode) (enum machine_mode, int);
83 /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
84 integer type with at least that precision. */
85 tree (*type_for_size) (unsigned, int);
87 /* True if the type is an instantiation of a generic type,
88 e.g. C++ template implicit specializations. */
89 bool (*generic_p) (const_tree);
91 /* Returns the TREE_VEC of elements of a given generic argument pack. */
92 tree (*get_argument_pack_elems) (const_tree);
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);
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:
106 in C. The default hook ignores the declaration. */
107 void (*register_builtin_type) (tree, const char *);
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
113 void (*incomplete_type_error) (const_tree value, const_tree type);
115 /* Called from assign_temp to return the maximum size, if there is one,
117 tree (*max_size) (const_tree);
119 /* Register language specific type size variables as potentially OpenMP
120 firstprivate variables. */
121 void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree);
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
127 bool (*type_hash_eq) (const_tree, const_tree);
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 *);
133 /* Fill in information for the debugger about the bounds of TYPE. */
134 void (*get_subrange_bounds) (const_tree, tree *, tree *);
136 /* If we requested a pointer to a vector, build up the pointers that
137 we stripped off while looking for the inner type. Similarly for
138 return values from functions. The argument TYPE is the top of the
139 chain, and BOTTOM is the new type which we will point to. */
140 tree (*reconstruct_complex_type) (tree, tree);
143 /* Language hooks related to decls and the symbol table. */
145 struct lang_hooks_for_decls
147 /* Returns nonzero if we are in the global binding level. Ada
148 returns -1 for an undocumented reason used in stor-layout.c. */
149 int (*global_bindings_p) (void);
151 /* Function to add a decl to the current scope level. Takes one
152 argument, a decl to add. Returns that decl, or, if the same
153 symbol is already declared, may return a different decl for that
155 tree (*pushdecl) (tree);
157 /* Returns the chain of decls so far in the current scope level. */
158 tree (*getdecls) (void);
160 /* Returns true if DECL is explicit member function. */
161 bool (*function_decl_explicit_p) (tree);
163 /* Returns True if the parameter is a generic parameter decl
164 of a generic type, e.g a template template parameter for the C++ FE. */
165 bool (*generic_generic_parameter_decl_p) (const_tree);
167 /* Determine if a function parameter got expanded from a
168 function parameter pack. */
169 bool (*function_parm_expanded_from_pack_p) (tree, tree);
171 /* Returns the generic declaration of a generic function instantiations. */
172 tree (*get_generic_function_decl) (const_tree);
174 /* Returns true when we should warn for an unused global DECL.
175 We will already have checked that it has static binding. */
176 bool (*warn_unused_global) (const_tree);
178 /* Obtain a list of globals and do final output on them at end
180 void (*final_write_globals) (void);
182 /* True if this decl may be called via a sibcall. */
183 bool (*ok_for_sibcall) (const_tree);
185 /* True if OpenMP should privatize what this DECL points to rather
186 than the DECL itself. */
187 bool (*omp_privatize_by_reference) (const_tree);
189 /* Return sharing kind if OpenMP sharing attribute of DECL is
190 predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise. */
191 enum omp_clause_default_kind (*omp_predetermined_sharing) (tree);
193 /* Return decl that should be reported for DEFAULT(NONE) failure
194 diagnostics. Usually the DECL passed in. */
195 tree (*omp_report_decl) (tree);
197 /* Return true if DECL's DECL_VALUE_EXPR (if any) should be
198 disregarded in OpenMP construct, because it is going to be
199 remapped during OpenMP lowering. SHARED is true if DECL
200 is going to be shared, false if it is going to be privatized. */
201 bool (*omp_disregard_value_expr) (tree, bool);
203 /* Return true if DECL that is shared iff SHARED is true should
204 be put into OMP_CLAUSE_PRIVATE_DEBUG. */
205 bool (*omp_private_debug_clause) (tree, bool);
207 /* Return true if DECL in private clause needs
208 OMP_CLAUSE_PRIVATE_OUTER_REF on the private clause. */
209 bool (*omp_private_outer_ref) (tree);
211 /* Build and return code for a default constructor for DECL in
212 response to CLAUSE. OUTER is corresponding outer region's
213 variable if needed. Return NULL if nothing to be done. */
214 tree (*omp_clause_default_ctor) (tree clause, tree decl, tree outer);
216 /* Build and return code for a copy constructor from SRC to DST. */
217 tree (*omp_clause_copy_ctor) (tree clause, tree dst, tree src);
219 /* Similarly, except use an assignment operator instead. */
220 tree (*omp_clause_assign_op) (tree clause, tree dst, tree src);
222 /* Build and return code destructing DECL. Return NULL if nothing
224 tree (*omp_clause_dtor) (tree clause, tree decl);
226 /* Do language specific checking on an implicitly determined clause. */
227 void (*omp_finish_clause) (tree clause);
230 /* Language hooks related to LTO serialization. */
232 struct lang_hooks_for_lto
234 /* Begin a new LTO section named NAME. */
235 void (*begin_section) (const char *name);
237 /* Write DATA of length LEN to the currently open LTO section. BLOCK is a
238 pointer to the dynamically allocated memory containing DATA. The
239 append_data function is responsible for freeing it when it is no longer
241 void (*append_data) (const void *data, size_t len, void *block);
243 /* End the previously begun LTO section. */
244 void (*end_section) (void);
247 /* Language-specific hooks. See langhooks-def.h for defaults. */
251 /* String identifying the front end. e.g. "GNU C++". */
254 /* sizeof (struct lang_identifier), so make_node () creates
255 identifier nodes long enough for the language-specific slots. */
256 size_t identifier_size;
258 /* Remove any parts of the tree that are used only by the FE. */
259 void (*free_lang_data) (tree);
261 /* Determines the size of any language-specific tcc_constant or
262 tcc_exceptional nodes. Since it is called from make_node, the
263 only information available is the tree code. Expected to die
264 on unrecognized codes. */
265 size_t (*tree_size) (enum tree_code);
267 /* Return the language mask used for converting argv into a sequence
269 unsigned int (*option_lang_mask) (void);
271 /* After the initialize_diagnostics hook is called, do any simple
272 initialization needed before any calls to handle_option. */
273 void (*init_options) (unsigned int decoded_options_count,
274 struct cl_decoded_option *decoded_options);
276 /* Callback used to perform language-specific initialization for the
277 global diagnostic context structure. */
278 void (*initialize_diagnostics) (struct diagnostic_context *);
280 /* Return true if a warning should be given about option OPTION,
281 which is for the wrong language, false if it should be quietly
283 bool (*complain_wrong_lang_p) (const struct cl_option *option);
285 /* Handle the switch CODE, which has real type enum opt_code from
286 options.h. If the switch takes an argument, it is passed in ARG
287 which points to permanent storage. The handler is responsible for
288 checking whether ARG is NULL, which indicates that no argument
289 was in fact supplied. For -f and -W switches, VALUE is 1 or 0
290 for the positive and negative forms respectively. HANDLERS should
291 be passed to any recursive handle_option calls.
293 Return true if the switch is valid, false if invalid. */
294 bool (*handle_option) (size_t code, const char *arg, int value, int kind,
295 const struct cl_option_handlers *handlers);
297 /* Called when all command line options have been parsed to allow
298 further processing and initialization
300 Should return true to indicate that a compiler back-end is
301 not required, such as with the -E option.
303 If errorcount is nonzero after this call the compiler exits
304 immediately and the finish hook is not called. */
305 bool (*post_options) (const char **);
307 /* Called after post_options to initialize the front end. Return
308 false to indicate that no further compilation be performed, in
309 which case the finish hook is called immediately. */
312 /* Called at the end of compilation, as a finalizer. */
313 void (*finish) (void);
315 /* Parses the entire file. The argument is nonzero to cause bison
316 parsers to dump debugging information during parsing. */
317 void (*parse_file) (int);
319 /* Determines if it's ok for a function to have no noreturn attribute. */
320 bool (*missing_noreturn_ok_p) (tree);
322 /* Called to obtain the alias set to be used for an expression or type.
323 Returns -1 if the language does nothing special for it. */
324 alias_set_type (*get_alias_set) (tree);
326 /* Function to finish handling an incomplete decl at the end of
327 compilation. Default hook is does nothing. */
328 void (*finish_incomplete_decl) (tree);
330 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
331 DECL_NODE with a newly GC-allocated copy. */
332 void (*dup_lang_specific_decl) (tree);
334 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of
335 thing that the assembler should talk about, set
336 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
337 Otherwise, set it to the ERROR_MARK_NODE to ensure that the
338 assembler does not talk about it. */
339 void (*set_decl_assembler_name) (tree);
341 /* The front end can add its own statistics to -fmem-report with
342 this hook. It should output to stderr. */
343 void (*print_statistics) (void);
345 /* Called by print_tree when there is a tree of class tcc_exceptional
346 that it doesn't know how to display. */
347 lang_print_tree_hook print_xnode;
349 /* Called to print language-dependent parts of tcc_decl, tcc_type,
350 and IDENTIFIER_NODE nodes. */
351 lang_print_tree_hook print_decl;
352 lang_print_tree_hook print_type;
353 lang_print_tree_hook print_identifier;
355 /* Computes the name to use to print a declaration. DECL is the
356 non-NULL declaration in question. VERBOSITY determines what
357 information will be printed: 0: DECL_NAME, demangled as
358 necessary. 1: and scope information. 2: and any other
359 information that might be interesting, such as function parameter
360 types in C++. The name is in the internal character set and
361 needs to be converted to the locale character set of diagnostics,
362 or to the execution character set for strings such as
363 __PRETTY_FUNCTION__. */
364 const char *(*decl_printable_name) (tree decl, int verbosity);
366 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what
367 information will be printed: 0: DECL_NAME, demangled as
368 necessary. 1: and scope information. */
369 const char *(*dwarf_name) (tree, int verbosity);
371 /* This compares two types for equivalence ("compatible" in C-based languages).
372 This routine should only return 1 if it is sure. It should not be used
373 in contexts where erroneously returning 0 causes problems. */
374 int (*types_compatible_p) (tree x, tree y);
376 /* Called by report_error_function to print out function name. */
377 void (*print_error_function) (struct diagnostic_context *, const char *,
378 struct diagnostic_info *);
380 /* Convert a character from the host's to the target's character
381 set. The character should be in what C calls the "basic source
382 character set" (roughly, the set of characters defined by plain
383 old ASCII). The default is to return the character unchanged,
384 which is correct in most circumstances. Note that both argument
385 and result should be sign-extended under -fsigned-char,
386 zero-extended under -fno-signed-char. */
387 HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT);
389 /* Pointers to machine-independent attribute tables, for front ends
390 using attribs.c. If one is NULL, it is ignored. Respectively, a
391 table of attributes specific to the language, a table of
392 attributes common to two or more languages (to allow easy
393 sharing), and a table of attributes for checking formats. */
394 const struct attribute_spec *attribute_table;
395 const struct attribute_spec *common_attribute_table;
396 const struct attribute_spec *format_attribute_table;
398 struct lang_hooks_for_tree_inlining tree_inlining;
400 struct lang_hooks_for_callgraph callgraph;
402 struct lang_hooks_for_tree_dump tree_dump;
404 struct lang_hooks_for_decls decls;
406 struct lang_hooks_for_types types;
408 struct lang_hooks_for_lto lto;
410 /* Returns the generic parameters of an instantiation of
411 a generic type or decl, e.g. C++ template instantiation. */
412 tree (*get_innermost_generic_parms) (const_tree);
414 /* Returns the TREE_VEC of arguments of an instantiation
415 of a generic type of decl, e.g. C++ template instantiation. */
416 tree (*get_innermost_generic_args) (const_tree);
418 /* Determine if a tree is a function parameter pack. */
419 bool (*function_parameter_pack_p) (const_tree);
421 /* Perform language-specific gimplification on the argument. Returns an
422 enum gimplify_status, though we can't see that type here. */
423 int (*gimplify_expr) (tree *, gimple_seq *, gimple_seq *);
425 /* Do language specific processing in the builtin function DECL */
426 tree (*builtin_function) (tree decl);
428 /* Like builtin_function, but make sure the scope is the external scope.
429 This is used to delay putting in back end builtin functions until the ISA
430 that defines the builtin is declared via function specific target options,
431 which can save memory for machines like the x86_64 that have multiple
432 ISAs. If this points to the same function as builtin_function, the
433 backend must add all of the builtins at program initialization time. */
434 tree (*builtin_function_ext_scope) (tree decl);
436 /* Used to set up the tree_contains_structure array for a frontend. */
437 void (*init_ts) (void);
439 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR
440 to a contained expression or DECL, possibly updating *TC or *SE
441 if in the process TREE_CONSTANT or TREE_SIDE_EFFECTS need updating. */
442 tree (*expr_to_decl) (tree expr, bool *tc, bool *se);
444 /* The EH personality function decl. */
445 tree (*eh_personality) (void);
447 /* Map a type to a runtime object to match type. */
448 tree (*eh_runtime_type) (tree);
450 /* If non-NULL, this is a function that returns a function decl to be
451 executed if an unhandled exception is propagated out of a cleanup
452 region. For example, in C++, an exception thrown by a destructor
453 during stack unwinding is required to result in a call to
454 `std::terminate', so the C++ version of this function returns a
455 FUNCTION_DECL for `std::terminate'. */
456 tree (*eh_protect_cleanup_actions) (void);
458 /* True if this language uses __cxa_end_cleanup when the ARM EABI
460 bool eh_use_cxa_end_cleanup;
462 /* True if this language requires deep unsharing of tree nodes prior to
466 /* Whenever you add entries here, make sure you adjust langhooks-def.h
467 and langhooks.c accordingly. */
470 /* Each front end provides its own. */
471 extern struct lang_hooks lang_hooks;
472 extern tree add_builtin_function (const char *name, tree type,
473 int function_code, enum built_in_class cl,
474 const char *library_name,
477 extern tree add_builtin_function_ext_scope (const char *name, tree type,
479 enum built_in_class cl,
480 const char *library_name,
483 #endif /* GCC_LANG_HOOKS_H */