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_info
;
28 struct gimplify_omp_ctx
;
30 struct array_descr_info
;
32 /* A print hook for print_tree (). */
33 typedef void (*lang_print_tree_hook
) (FILE *, tree
, int indent
);
36 { RECORD_IS_STRUCT
, RECORD_IS_CLASS
, RECORD_IS_INTERFACE
};
38 /* The following hooks are documented in langhooks.c. Must not be
41 struct lang_hooks_for_tree_inlining
43 bool (*var_mod_type_p
) (tree
, tree
);
46 struct lang_hooks_for_callgraph
48 /* The node passed is a language-specific tree node. If its contents
49 are relevant to use of other declarations, mark them. */
50 tree (*analyze_expr
) (tree
*, int *);
53 /* The following hooks are used by tree-dump.c. */
55 struct lang_hooks_for_tree_dump
57 /* Dump language-specific parts of tree nodes. Returns nonzero if it
58 does not want the usual dumping of the second argument. */
59 bool (*dump_tree
) (void *, tree
);
61 /* Determine type qualifiers in a language-specific way. */
62 int (*type_quals
) (const_tree
);
65 /* Hooks related to types. */
67 struct lang_hooks_for_types
69 /* Return a new type (with the indicated CODE), doing whatever
70 language-specific processing is required. */
71 tree (*make_type
) (enum tree_code
);
73 /* Return what kind of RECORD_TYPE this is, mainly for purposes of
74 debug information. If not defined, record types are assumed to
76 enum classify_record (*classify_record
) (tree
);
78 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
80 tree (*type_for_mode
) (enum machine_mode
, int);
82 /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
83 integer type with at least that precision. */
84 tree (*type_for_size
) (unsigned, int);
86 /* True if the type is an instantiation of a generic type,
87 e.g. C++ template implicit specializations. */
88 bool (*generic_p
) (const_tree
);
90 /* Returns the TREE_VEC of elements of a given generic argument pack. */
91 tree (*get_argument_pack_elems
) (const_tree
);
93 /* Given a type, apply default promotions to unnamed function
94 arguments and return the new type. Return the same type if no
95 change. Required by any language that supports variadic
96 arguments. The default hook dies. */
97 tree (*type_promotes_to
) (tree
);
99 /* Register TYPE as a builtin type with the indicated NAME. The
100 TYPE is placed in the outermost lexical scope. The semantics
101 should be analogous to:
105 in C. The default hook ignores the declaration. */
106 void (*register_builtin_type
) (tree
, const char *);
108 /* This routine is called in tree.c to print an error message for
109 invalid use of an incomplete type. VALUE is the expression that
110 was used (or 0 if that isn't known) and TYPE is the type that was
112 void (*incomplete_type_error
) (const_tree value
, const_tree type
);
114 /* Called from assign_temp to return the maximum size, if there is one,
116 tree (*max_size
) (const_tree
);
118 /* Register language specific type size variables as potentially OpenMP
119 firstprivate variables. */
120 void (*omp_firstprivatize_type_sizes
) (struct gimplify_omp_ctx
*, tree
);
122 /* Return TRUE if TYPE1 and TYPE2 are identical for type hashing purposes.
123 Called only after doing all language independent checks.
124 At present, this function is only called when both TYPE1 and TYPE2 are
126 bool (*type_hash_eq
) (const_tree
, const_tree
);
128 /* Return TRUE if TYPE uses a hidden descriptor and fills in information
129 for the debugger about the array bounds, strides, etc. */
130 bool (*get_array_descr_info
) (const_tree
, struct array_descr_info
*);
132 /* Fill in information for the debugger about the bounds of TYPE. */
133 void (*get_subrange_bounds
) (const_tree
, tree
*, tree
*);
135 /* If we requested a pointer to a vector, build up the pointers that
136 we stripped off while looking for the inner type. Similarly for
137 return values from functions. The argument TYPE is the top of the
138 chain, and BOTTOM is the new type which we will point to. */
139 tree (*reconstruct_complex_type
) (tree
, tree
);
142 /* Language hooks related to decls and the symbol table. */
144 struct lang_hooks_for_decls
146 /* Returns nonzero if we are in the global binding level. Ada
147 returns -1 for an undocumented reason used in stor-layout.c. */
148 int (*global_bindings_p
) (void);
150 /* Function to add a decl to the current scope level. Takes one
151 argument, a decl to add. Returns that decl, or, if the same
152 symbol is already declared, may return a different decl for that
154 tree (*pushdecl
) (tree
);
156 /* Returns the chain of decls so far in the current scope level. */
157 tree (*getdecls
) (void);
159 /* Returns true if DECL is explicit member function. */
160 bool (*function_decl_explicit_p
) (tree
);
162 /* Returns True if the parameter is a generic parameter decl
163 of a generic type, e.g a template template parameter for the C++ FE. */
164 bool (*generic_generic_parameter_decl_p
) (const_tree
);
166 /* Determine if a function parameter got expanded from a
167 function parameter pack. */
168 bool (*function_parm_expanded_from_pack_p
) (tree
, tree
);
170 /* Returns the generic declaration of a generic function instantiations. */
171 tree (*get_generic_function_decl
) (const_tree
);
173 /* Returns true when we should warn for an unused global DECL.
174 We will already have checked that it has static binding. */
175 bool (*warn_unused_global
) (const_tree
);
177 /* Obtain a list of globals and do final output on them at end
179 void (*final_write_globals
) (void);
181 /* True if this decl may be called via a sibcall. */
182 bool (*ok_for_sibcall
) (const_tree
);
184 /* True if OpenMP should privatize what this DECL points to rather
185 than the DECL itself. */
186 bool (*omp_privatize_by_reference
) (const_tree
);
188 /* Return sharing kind if OpenMP sharing attribute of DECL is
189 predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise. */
190 enum omp_clause_default_kind (*omp_predetermined_sharing
) (tree
);
192 /* Return decl that should be reported for DEFAULT(NONE) failure
193 diagnostics. Usually the DECL passed in. */
194 tree (*omp_report_decl
) (tree
);
196 /* Return true if DECL's DECL_VALUE_EXPR (if any) should be
197 disregarded in OpenMP construct, because it is going to be
198 remapped during OpenMP lowering. SHARED is true if DECL
199 is going to be shared, false if it is going to be privatized. */
200 bool (*omp_disregard_value_expr
) (tree
, bool);
202 /* Return true if DECL that is shared iff SHARED is true should
203 be put into OMP_CLAUSE_PRIVATE_DEBUG. */
204 bool (*omp_private_debug_clause
) (tree
, bool);
206 /* Return true if DECL in private clause needs
207 OMP_CLAUSE_PRIVATE_OUTER_REF on the private clause. */
208 bool (*omp_private_outer_ref
) (tree
);
210 /* Build and return code for a default constructor for DECL in
211 response to CLAUSE. OUTER is corresponding outer region's
212 variable if needed. Return NULL if nothing to be done. */
213 tree (*omp_clause_default_ctor
) (tree clause
, tree decl
, tree outer
);
215 /* Build and return code for a copy constructor from SRC to DST. */
216 tree (*omp_clause_copy_ctor
) (tree clause
, tree dst
, tree src
);
218 /* Similarly, except use an assignment operator instead. */
219 tree (*omp_clause_assign_op
) (tree clause
, tree dst
, tree src
);
221 /* Build and return code destructing DECL. Return NULL if nothing
223 tree (*omp_clause_dtor
) (tree clause
, tree decl
);
225 /* Do language specific checking on an implicitly determined clause. */
226 void (*omp_finish_clause
) (tree clause
);
229 /* Language hooks related to LTO serialization. */
231 struct lang_hooks_for_lto
233 /* Begin a new LTO section named NAME. */
234 void (*begin_section
) (const char *name
);
236 /* Write DATA of length LEN to the currently open LTO section. BLOCK is a
237 pointer to the dynamically allocated memory containing DATA. The
238 append_data function is responsible for freeing it when it is no longer
240 void (*append_data
) (const void *data
, size_t len
, void *block
);
242 /* End the previously begun LTO section. */
243 void (*end_section
) (void);
246 /* Language-specific hooks. See langhooks-def.h for defaults. */
250 /* String identifying the front end. e.g. "GNU C++". */
253 /* sizeof (struct lang_identifier), so make_node () creates
254 identifier nodes long enough for the language-specific slots. */
255 size_t identifier_size
;
257 /* Remove any parts of the tree that are used only by the FE. */
258 void (*free_lang_data
) (tree
);
260 /* Determines the size of any language-specific tcc_constant or
261 tcc_exceptional nodes. Since it is called from make_node, the
262 only information available is the tree code. Expected to die
263 on unrecognized codes. */
264 size_t (*tree_size
) (enum tree_code
);
266 /* Return the language mask used for converting argv into a sequence
268 unsigned int (*option_lang_mask
) (void);
270 /* Initialize variables in an options structure. */
271 void (*init_options_struct
) (struct gcc_options
*opts
);
273 /* After the initialize_diagnostics hook is called, do any simple
274 initialization needed before any calls to handle_option, other
275 than that done by the init_options_struct hook. */
276 void (*init_options
) (unsigned int decoded_options_count
,
277 struct cl_decoded_option
*decoded_options
);
279 /* Callback used to perform language-specific initialization for the
280 global diagnostic context structure. */
281 void (*initialize_diagnostics
) (diagnostic_context
*);
283 /* Return true if a warning should be given about option OPTION,
284 which is for the wrong language, false if it should be quietly
286 bool (*complain_wrong_lang_p
) (const struct cl_option
*option
);
288 /* Handle the switch CODE, which has real type enum opt_code from
289 options.h. If the switch takes an argument, it is passed in ARG
290 which points to permanent storage. The handler is responsible for
291 checking whether ARG is NULL, which indicates that no argument
292 was in fact supplied. For -f and -W switches, VALUE is 1 or 0
293 for the positive and negative forms respectively. HANDLERS should
294 be passed to any recursive handle_option calls. LOC is the
295 location of the option.
297 Return true if the switch is valid, false if invalid. */
298 bool (*handle_option
) (size_t code
, const char *arg
, int value
, int kind
,
300 const struct cl_option_handlers
*handlers
);
302 /* Called when all command line options have been parsed to allow
303 further processing and initialization
305 Should return true to indicate that a compiler back-end is
306 not required, such as with the -E option.
308 If errorcount is nonzero after this call the compiler exits
309 immediately and the finish hook is not called. */
310 bool (*post_options
) (const char **);
312 /* Called after post_options to initialize the front end. Return
313 false to indicate that no further compilation be performed, in
314 which case the finish hook is called immediately. */
317 /* Called at the end of compilation, as a finalizer. */
318 void (*finish
) (void);
320 /* Parses the entire file. */
321 void (*parse_file
) (void);
323 /* Determines if it's ok for a function to have no noreturn attribute. */
324 bool (*missing_noreturn_ok_p
) (tree
);
326 /* Called to obtain the alias set to be used for an expression or type.
327 Returns -1 if the language does nothing special for it. */
328 alias_set_type (*get_alias_set
) (tree
);
330 /* Function to finish handling an incomplete decl at the end of
331 compilation. Default hook is does nothing. */
332 void (*finish_incomplete_decl
) (tree
);
334 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
335 DECL_NODE with a newly GC-allocated copy. */
336 void (*dup_lang_specific_decl
) (tree
);
338 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of
339 thing that the assembler should talk about, set
340 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
341 Otherwise, set it to the ERROR_MARK_NODE to ensure that the
342 assembler does not talk about it. */
343 void (*set_decl_assembler_name
) (tree
);
345 /* The front end can add its own statistics to -fmem-report with
346 this hook. It should output to stderr. */
347 void (*print_statistics
) (void);
349 /* Called by print_tree when there is a tree of class tcc_exceptional
350 that it doesn't know how to display. */
351 lang_print_tree_hook print_xnode
;
353 /* Called to print language-dependent parts of tcc_decl, tcc_type,
354 and IDENTIFIER_NODE nodes. */
355 lang_print_tree_hook print_decl
;
356 lang_print_tree_hook print_type
;
357 lang_print_tree_hook print_identifier
;
359 /* Computes the name to use to print a declaration. DECL is the
360 non-NULL declaration in question. VERBOSITY determines what
361 information will be printed: 0: DECL_NAME, demangled as
362 necessary. 1: and scope information. 2: and any other
363 information that might be interesting, such as function parameter
364 types in C++. The name is in the internal character set and
365 needs to be converted to the locale character set of diagnostics,
366 or to the execution character set for strings such as
367 __PRETTY_FUNCTION__. */
368 const char *(*decl_printable_name
) (tree decl
, int verbosity
);
370 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what
371 information will be printed: 0: DECL_NAME, demangled as
372 necessary. 1: and scope information. */
373 const char *(*dwarf_name
) (tree
, int verbosity
);
375 /* This compares two types for equivalence ("compatible" in C-based languages).
376 This routine should only return 1 if it is sure. It should not be used
377 in contexts where erroneously returning 0 causes problems. */
378 int (*types_compatible_p
) (tree x
, tree y
);
380 /* Called by report_error_function to print out function name. */
381 void (*print_error_function
) (diagnostic_context
*, const char *,
382 struct diagnostic_info
*);
384 /* Convert a character from the host's to the target's character
385 set. The character should be in what C calls the "basic source
386 character set" (roughly, the set of characters defined by plain
387 old ASCII). The default is to return the character unchanged,
388 which is correct in most circumstances. Note that both argument
389 and result should be sign-extended under -fsigned-char,
390 zero-extended under -fno-signed-char. */
391 HOST_WIDE_INT (*to_target_charset
) (HOST_WIDE_INT
);
393 /* Pointers to machine-independent attribute tables, for front ends
394 using attribs.c. If one is NULL, it is ignored. Respectively, a
395 table of attributes specific to the language, a table of
396 attributes common to two or more languages (to allow easy
397 sharing), and a table of attributes for checking formats. */
398 const struct attribute_spec
*attribute_table
;
399 const struct attribute_spec
*common_attribute_table
;
400 const struct attribute_spec
*format_attribute_table
;
402 struct lang_hooks_for_tree_inlining tree_inlining
;
404 struct lang_hooks_for_callgraph callgraph
;
406 struct lang_hooks_for_tree_dump tree_dump
;
408 struct lang_hooks_for_decls decls
;
410 struct lang_hooks_for_types types
;
412 struct lang_hooks_for_lto lto
;
414 /* Returns the generic parameters of an instantiation of
415 a generic type or decl, e.g. C++ template instantiation. */
416 tree (*get_innermost_generic_parms
) (const_tree
);
418 /* Returns the TREE_VEC of arguments of an instantiation
419 of a generic type of decl, e.g. C++ template instantiation. */
420 tree (*get_innermost_generic_args
) (const_tree
);
422 /* Determine if a tree is a function parameter pack. */
423 bool (*function_parameter_pack_p
) (const_tree
);
425 /* Perform language-specific gimplification on the argument. Returns an
426 enum gimplify_status, though we can't see that type here. */
427 int (*gimplify_expr
) (tree
*, gimple_seq
*, gimple_seq
*);
429 /* Do language specific processing in the builtin function DECL */
430 tree (*builtin_function
) (tree decl
);
432 /* Like builtin_function, but make sure the scope is the external scope.
433 This is used to delay putting in back end builtin functions until the ISA
434 that defines the builtin is declared via function specific target options,
435 which can save memory for machines like the x86_64 that have multiple
436 ISAs. If this points to the same function as builtin_function, the
437 backend must add all of the builtins at program initialization time. */
438 tree (*builtin_function_ext_scope
) (tree decl
);
440 /* Used to set up the tree_contains_structure array for a frontend. */
441 void (*init_ts
) (void);
443 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR
444 to a contained expression or DECL, possibly updating *TC or *SE
445 if in the process TREE_CONSTANT or TREE_SIDE_EFFECTS need updating. */
446 tree (*expr_to_decl
) (tree expr
, bool *tc
, bool *se
);
448 /* The EH personality function decl. */
449 tree (*eh_personality
) (void);
451 /* Map a type to a runtime object to match type. */
452 tree (*eh_runtime_type
) (tree
);
454 /* If non-NULL, this is a function that returns a function decl to be
455 executed if an unhandled exception is propagated out of a cleanup
456 region. For example, in C++, an exception thrown by a destructor
457 during stack unwinding is required to result in a call to
458 `std::terminate', so the C++ version of this function returns a
459 FUNCTION_DECL for `std::terminate'. */
460 tree (*eh_protect_cleanup_actions
) (void);
462 /* True if this language uses __cxa_end_cleanup when the ARM EABI
464 bool eh_use_cxa_end_cleanup
;
466 /* True if this language requires deep unsharing of tree nodes prior to
470 /* Used by pre-parsed header (PPH) to intercept certain tree nodes
471 created by make_node_stat during parsing. */
472 void (*pph_catch_tree
) (tree t
);
473 void (*pph_uncatch_tree
) (tree t
);
475 /* Whenever you add entries here, make sure you adjust langhooks-def.h
476 and langhooks.c accordingly. */
479 /* Each front end provides its own. */
480 extern struct lang_hooks lang_hooks
;
481 extern tree
add_builtin_function (const char *name
, tree type
,
482 int function_code
, enum built_in_class cl
,
483 const char *library_name
,
486 extern tree
add_builtin_function_ext_scope (const char *name
, tree type
,
488 enum built_in_class cl
,
489 const char *library_name
,
492 #endif /* GCC_LANG_HOOKS_H */