1 /* The lang_hooks data structure.
2 Copyright 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GCC is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING. If not, write to
18 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA. */
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;
28 struct gimplify_omp_ctx;
30 /* A print hook for print_tree (). */
31 typedef void (*lang_print_tree_hook) (FILE *, tree, int indent);
33 /* The following hooks are documented in langhooks.c. Must not be
36 struct lang_hooks_for_tree_inlining
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);
52 struct lang_hooks_for_callgraph
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);
58 /* Produce RTL for function passed as argument. */
59 void (*expand_function) (tree);
62 /* Lang hooks for management of language-specific data or status
63 when entering / leaving functions etc. */
64 struct lang_hooks_for_functions
66 /* Called when entering a function. */
67 void (*init) (struct function *);
69 /* Called when leaving a function. */
70 void (*final) (struct function *);
72 /* Called when entering a nested function. */
73 void (*enter_nested) (struct function *);
75 /* Called when leaving a nested function. */
76 void (*leave_nested) (struct function *);
78 /* Determines if it's ok for a function to have no noreturn attribute. */
79 bool (*missing_noreturn_ok_p) (tree);
82 /* The following hooks are used by tree-dump.c. */
84 struct lang_hooks_for_tree_dump
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);
90 /* Determine type qualifiers in a language-specific way. */
91 int (*type_quals) (tree);
94 /* Hooks related to types. */
96 struct lang_hooks_for_types
98 /* Return a new type (with the indicated CODE), doing whatever
99 language-specific processing is required. */
100 tree (*make_type) (enum tree_code);
102 /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
104 tree (*type_for_mode) (enum machine_mode, int);
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);
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);
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);
118 /* Return a type the same as TYPE except unsigned or signed
119 according to UNSIGNEDP. */
120 tree (*signed_or_unsigned_type) (int, tree);
122 /* True if the type is an instantiation of a generic type,
123 e.g. C++ template implicit specializations. */
124 bool (*generic_p) (tree);
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);
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:
138 in C. The default hook ignores the declaration. */
139 void (*register_builtin_type) (tree, const char *);
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
145 void (*incomplete_type_error) (tree value, tree type);
147 /* Called from assign_temp to return the maximum size, if there is one,
149 tree (*max_size) (tree);
151 /* Register language specific type size variables as potentially OpenMP
152 firstprivate variables. */
153 void (*omp_firstprivatize_type_sizes) (struct gimplify_omp_ctx *, tree);
155 /* Nonzero if types that are identical are to be hashed so that only
156 one copy is kept. If a language requires unique types for each
157 user-specified type, such as Ada, this should be set to TRUE. */
161 /* Language hooks related to decls and the symbol table. */
163 struct lang_hooks_for_decls
165 /* Returns nonzero if we are in the global binding level. Ada
166 returns -1 for an undocumented reason used in stor-layout.c. */
167 int (*global_bindings_p) (void);
169 /* Insert BLOCK at the end of the list of subblocks of the
170 current binding level. This is used when a BIND_EXPR is expanded,
171 to handle the BLOCK node inside the BIND_EXPR. */
172 void (*insert_block) (tree);
174 /* Function to add a decl to the current scope level. Takes one
175 argument, a decl to add. Returns that decl, or, if the same
176 symbol is already declared, may return a different decl for that
178 tree (*pushdecl) (tree);
180 /* Returns the chain of decls so far in the current scope level. */
181 tree (*getdecls) (void);
183 /* Returns true when we should warn for an unused global DECL.
184 We will already have checked that it has static binding. */
185 bool (*warn_unused_global) (tree);
187 /* Obtain a list of globals and do final output on them at end
189 void (*final_write_globals) (void);
191 /* Do necessary preparations before assemble_variable can proceed. */
192 void (*prepare_assemble_variable) (tree);
194 /* True if this decl may be called via a sibcall. */
195 bool (*ok_for_sibcall) (tree);
197 /* Return the COMDAT group into which this DECL should be placed.
198 It is known that the DECL belongs in *some* COMDAT group when
199 this hook is called. The return value will be used immediately,
200 but not explicitly deallocated, so implementations should not use
201 xmalloc to allocate the string returned. (Typically, the return
202 value will be the string already stored in an
204 const char * (*comdat_group) (tree);
206 /* True if OpenMP should privatize what this DECL points to rather
207 than the DECL itself. */
208 bool (*omp_privatize_by_reference) (tree);
210 /* Return sharing kind if OpenMP sharing attribute of DECL is
211 predetermined, OMP_CLAUSE_DEFAULT_UNSPECIFIED otherwise. */
212 enum omp_clause_default_kind (*omp_predetermined_sharing) (tree);
214 /* Return true if DECL's DECL_VALUE_EXPR (if any) should be
215 disregarded in OpenMP construct, because it is going to be
216 remapped during OpenMP lowering. SHARED is true if DECL
217 is going to be shared, false if it is going to be privatized. */
218 bool (*omp_disregard_value_expr) (tree, bool);
220 /* Return true if DECL that is shared iff SHARED is true should
221 be put into OMP_CLAUSE_PRIVATE_DEBUG. */
222 bool (*omp_private_debug_clause) (tree, bool);
224 /* Build and return code for a default constructor for DECL in
225 response to CLAUSE. Return NULL if nothing to be done. */
226 tree (*omp_clause_default_ctor) (tree clause, tree decl);
228 /* Build and return code for a copy constructor from SRC to DST. */
229 tree (*omp_clause_copy_ctor) (tree clause, tree dst, tree src);
231 /* Similarly, except use an assignment operator instead. */
232 tree (*omp_clause_assign_op) (tree clause, tree dst, tree src);
234 /* Build and return code destructing DECL. Return NULL if nothing
236 tree (*omp_clause_dtor) (tree clause, tree decl);
239 /* Language-specific hooks. See langhooks-def.h for defaults. */
243 /* String identifying the front end. e.g. "GNU C++". */
246 /* sizeof (struct lang_identifier), so make_node () creates
247 identifier nodes long enough for the language-specific slots. */
248 size_t identifier_size;
250 /* Determines the size of any language-specific tcc_constant or
251 tcc_exceptional nodes. Since it is called from make_node, the
252 only information available is the tree code. Expected to die
253 on unrecognized codes. */
254 size_t (*tree_size) (enum tree_code);
256 /* The first callback made to the front end, for simple
257 initialization needed before any calls to handle_option. Return
258 the language mask to filter the switch array with. */
259 unsigned int (*init_options) (unsigned int argc, const char **argv);
261 /* Callback used to perform language-specific initialization for the
262 global diagnostic context structure. */
263 void (*initialize_diagnostics) (struct diagnostic_context *);
265 /* Handle the switch CODE, which has real type enum opt_code from
266 options.h. If the switch takes an argument, it is passed in ARG
267 which points to permanent storage. The handler is responsible for
268 checking whether ARG is NULL, which indicates that no argument
269 was in fact supplied. For -f and -W switches, VALUE is 1 or 0
270 for the positive and negative forms respectively.
272 Return 1 if the switch is valid, 0 if invalid, and -1 if it's
273 valid and should not be treated as language-independent too. */
274 int (*handle_option) (size_t code, const char *arg, int value);
276 /* Return false to use the default complaint about a missing
277 argument, otherwise output a complaint and return true. */
278 bool (*missing_argument) (const char *opt, size_t code);
280 /* Called when all command line options have been parsed to allow
281 further processing and initialization
283 Should return true to indicate that a compiler back-end is
284 not required, such as with the -E option.
286 If errorcount is nonzero after this call the compiler exits
287 immediately and the finish hook is not called. */
288 bool (*post_options) (const char **);
290 /* Called after post_options to initialize the front end. Return
291 false to indicate that no further compilation be performed, in
292 which case the finish hook is called immediately. */
295 /* Called at the end of compilation, as a finalizer. */
296 void (*finish) (void);
298 /* Parses the entire file. The argument is nonzero to cause bison
299 parsers to dump debugging information during parsing. */
300 void (*parse_file) (int);
302 /* Called immediately after parsing to clear the binding stack. */
303 void (*clear_binding_stack) (void);
305 /* Called to obtain the alias set to be used for an expression or type.
306 Returns -1 if the language does nothing special for it. */
307 HOST_WIDE_INT (*get_alias_set) (tree);
309 /* Called with an expression that is to be processed as a constant.
310 Returns either the same expression or a language-independent
311 constant equivalent to its input. */
312 tree (*expand_constant) (tree);
314 /* Called by expand_expr for language-specific tree codes.
315 Fourth argument is actually an enum expand_modifier. */
316 rtx (*expand_expr) (tree, rtx, enum machine_mode, int, rtx *);
318 /* Called by expand_expr to generate the definition of a decl. Returns
319 1 if handled, 0 otherwise. */
320 int (*expand_decl) (tree);
322 /* Hook called by safe_from_p for language-specific tree codes. It is
323 up to the language front-end to install a hook if it has any such
324 codes that safe_from_p needs to know about. Since same_from_p will
325 recursively explore the TREE_OPERANDs of an expression, this hook
326 should not reexamine those pieces. This routine may recursively
327 call safe_from_p; it should always pass `0' as the TOP_P
329 int (*safe_from_p) (rtx, tree);
331 /* Function to finish handling an incomplete decl at the end of
332 compilation. Default hook is does nothing. */
333 void (*finish_incomplete_decl) (tree);
335 /* Mark EXP saying that we need to be able to take the address of
336 it; it should not be allocated in a register. Return true if
338 bool (*mark_addressable) (tree);
340 /* Hook called by staticp for language-specific tree codes. */
341 tree (*staticp) (tree);
343 /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
344 DECL_NODE with a newly GC-allocated copy. */
345 void (*dup_lang_specific_decl) (tree);
347 /* Set the DECL_ASSEMBLER_NAME for a node. If it is the sort of
348 thing that the assembler should talk about, set
349 DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
350 Otherwise, set it to the ERROR_MARK_NODE to ensure that the
351 assembler does not talk about it. */
352 void (*set_decl_assembler_name) (tree);
354 /* Return nonzero if fold-const is free to use bit-field
355 optimizations, for instance in fold_truthop(). */
356 bool (*can_use_bit_fields_p) (void);
358 /* Nonzero if operations on types narrower than their mode should
359 have their results reduced to the precision of the type. */
360 bool reduce_bit_field_operations;
362 /* Nonzero if this front end does not generate a dummy BLOCK between
363 the outermost scope of the function and the FUNCTION_DECL. See
364 is_body_block in stmt.c, and its callers. */
367 /* The front end can add its own statistics to -fmem-report with
368 this hook. It should output to stderr. */
369 void (*print_statistics) (void);
371 /* Called by print_tree when there is a tree of class tcc_exceptional
372 that it doesn't know how to display. */
373 lang_print_tree_hook print_xnode;
375 /* Called to print language-dependent parts of tcc_decl, tcc_type,
376 and IDENTIFIER_NODE nodes. */
377 lang_print_tree_hook print_decl;
378 lang_print_tree_hook print_type;
379 lang_print_tree_hook print_identifier;
381 /* Computes the name to use to print a declaration. DECL is the
382 non-NULL declaration in question. VERBOSITY determines what
383 information will be printed: 0: DECL_NAME, demangled as
384 necessary. 1: and scope information. 2: and any other
385 information that might be interesting, such as function parameter
387 const char *(*decl_printable_name) (tree decl, int verbosity);
389 /* Computes the dwarf-2/3 name for a tree. VERBOSITY determines what
390 information will be printed: 0: DECL_NAME, demangled as
391 necessary. 1: and scope information. */
392 const char *(*dwarf_name) (tree, int verbosity);
394 /* This compares two types for equivalence ("compatible" in C-based languages).
395 This routine should only return 1 if it is sure. It should not be used
396 in contexts where erroneously returning 0 causes problems. */
397 int (*types_compatible_p) (tree x, tree y);
399 /* Given a CALL_EXPR, return a function decl that is its target. */
400 tree (*lang_get_callee_fndecl) (tree);
402 /* Called by report_error_function to print out function name. */
403 void (*print_error_function) (struct diagnostic_context *, const char *);
405 /* Called from expr_size to calculate the size of the value of an
406 expression in a language-dependent way. Returns a tree for the size
407 in bytes. A frontend can call lhd_expr_size to get the default
408 semantics in cases that it doesn't want to handle specially. */
409 tree (*expr_size) (tree);
411 /* Convert a character from the host's to the target's character
412 set. The character should be in what C calls the "basic source
413 character set" (roughly, the set of characters defined by plain
414 old ASCII). The default is to return the character unchanged,
415 which is correct in most circumstances. Note that both argument
416 and result should be sign-extended under -fsigned-char,
417 zero-extended under -fno-signed-char. */
418 HOST_WIDE_INT (*to_target_charset) (HOST_WIDE_INT);
420 /* Pointers to machine-independent attribute tables, for front ends
421 using attribs.c. If one is NULL, it is ignored. Respectively, a
422 table of attributes specific to the language, a table of
423 attributes common to two or more languages (to allow easy
424 sharing), and a table of attributes for checking formats. */
425 const struct attribute_spec *attribute_table;
426 const struct attribute_spec *common_attribute_table;
427 const struct attribute_spec *format_attribute_table;
429 /* Function-related language hooks. */
430 struct lang_hooks_for_functions function;
432 struct lang_hooks_for_tree_inlining tree_inlining;
434 struct lang_hooks_for_callgraph callgraph;
436 struct lang_hooks_for_tree_dump tree_dump;
438 struct lang_hooks_for_decls decls;
440 struct lang_hooks_for_types types;
442 /* Perform language-specific gimplification on the argument. Returns an
443 enum gimplify_status, though we can't see that type here. */
444 int (*gimplify_expr) (tree *, tree *, tree *);
446 /* Fold an OBJ_TYPE_REF expression to the address of a function.
447 KNOWN_TYPE carries the true type of the OBJ_TYPE_REF_OBJECT. */
448 tree (*fold_obj_type_ref) (tree, tree);
450 /* Return a definition for a builtin function named NAME and whose data type
451 is TYPE. TYPE should be a function type with argument types.
452 FUNCTION_CODE tells later passes how to compile calls to this function.
453 See tree.h for its possible values.
455 If LIBRARY_NAME is nonzero, use that for DECL_ASSEMBLER_NAME,
456 the name to be called if we can't opencode the function. If
457 ATTRS is nonzero, use that for the function's attribute list. */
458 tree (*builtin_function) (const char *name, tree type, int function_code,
459 enum built_in_class bt_class,
460 const char *library_name, tree attrs);
462 /* Used to set up the tree_contains_structure array for a frontend. */
463 void (*init_ts) (void);
465 /* Called by recompute_tree_invariant_for_addr_expr to go from EXPR
466 to a contained expression or DECL, possibly updating *TC, *TI or
467 *SE if in the process TREE_CONSTANT, TREE_INVARIANT or
468 TREE_SIDE_EFFECTS need updating. */
469 tree (*expr_to_decl) (tree expr, bool *tc, bool *ti, bool *se);
471 /* Whenever you add entries here, make sure you adjust langhooks-def.h
472 and langhooks.c accordingly. */
475 /* Each front end provides its own. */
476 extern const struct lang_hooks lang_hooks;
478 #endif /* GCC_LANG_HOOKS_H */