OSDN Git Service

* gcc-interface/gigi.h (maybe_variable): Delete.
[pf3gnuchains/gcc-fork.git] / gcc / ada / gcc-interface / gigi.h
1 /****************************************************************************
2  *                                                                          *
3  *                         GNAT COMPILER COMPONENTS                         *
4  *                                                                          *
5  *                                 G I G I                                  *
6  *                                                                          *
7  *                              C Header File                               *
8  *                                                                          *
9  *          Copyright (C) 1992-2010, Free Software Foundation, Inc.         *
10  *                                                                          *
11  * GNAT is free software;  you can  redistribute it  and/or modify it under *
12  * terms of the  GNU General Public License as published  by the Free Soft- *
13  * ware  Foundation;  either version 3,  or (at your option) any later ver- *
14  * sion.  GNAT is distributed in the hope that it will be useful, but WITH- *
15  * OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY *
16  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License *
17  * for  more details.  You should have  received  a copy of the GNU General *
18  * Public License  distributed  with GNAT;  see file  COPYING3.  If not see *
19  * <http://www.gnu.org/licenses/>.                                          *
20  *                                                                          *
21  * GNAT was originally developed  by the GNAT team at  New York University. *
22  * Extensive contributions were provided by Ada Core Technologies Inc.      *
23  *                                                                          *
24  ****************************************************************************/
25
26 /* Declare all functions and types used by gigi.  */
27
28 /* Given GNAT_ENTITY, a GNAT defining identifier node, which denotes some Ada
29    entity, this routine returns the equivalent GCC tree for that entity
30    (an ..._DECL node) and associates the ..._DECL node with the input GNAT
31    defining identifier.
32
33    If GNAT_ENTITY is a variable or a constant declaration, GNU_EXPR gives its
34    initial value (in GCC tree form). This is optional for variables.
35    For renamed entities, GNU_EXPR gives the object being renamed.
36
37    DEFINITION is nonzero if this call is intended for a definition.  This is
38    used for separate compilation where it necessary to know whether an
39    external declaration or a definition should be created if the GCC equivalent
40    was not created previously.  The value of 1 is normally used for a nonzero
41    DEFINITION, but a value of 2 is used in special circumstances, defined in
42    the code.  */
43 extern tree gnat_to_gnu_entity (Entity_Id gnat_entity, tree gnu_expr,
44                                 int definition);
45
46 /* Similar, but if the returned value is a COMPONENT_REF, return the
47    FIELD_DECL.  */
48 extern tree gnat_to_gnu_field_decl (Entity_Id gnat_entity);
49
50 /* Similar, but GNAT_ENTITY is assumed to refer to a GNAT type.  Return
51    the GCC type corresponding to that entity.  */
52 extern tree gnat_to_gnu_type (Entity_Id gnat_entity);
53
54 /* Wrap up compilation of T, a TYPE_DECL, possibly deferring it.  */
55 extern void rest_of_type_decl_compilation (tree t);
56
57 /* Start a new statement group chained to the previous group.  */
58 extern void start_stmt_group (void);
59
60 /* Add GNU_STMT to the current BLOCK_STMT node.  */
61 extern void add_stmt (tree gnu_stmt);
62
63 /* Similar, but set the location of GNU_STMT to that of GNAT_NODE.  */
64 extern void add_stmt_with_node (tree gnu_stmt, Node_Id gnat_node);
65
66 /* Return code corresponding to the current code group.  It is normally
67    a STATEMENT_LIST, but may also be a BIND_EXPR or TRY_FINALLY_EXPR if
68    BLOCK or cleanups were set.  */
69 extern tree end_stmt_group (void);
70
71 /* Set the BLOCK node corresponding to the current code group to GNU_BLOCK.  */
72 extern void set_block_for_group (tree);
73
74 /* Add a declaration statement for GNU_DECL to the current BLOCK_STMT node.
75    Get SLOC from GNAT_ENTITY.  */
76 extern void add_decl_expr (tree gnu_decl, Entity_Id gnat_entity);
77
78 /* Mark nodes rooted at T with TREE_VISITED and types as having their
79    sized gimplified.  We use this to indicate all variable sizes and
80    positions in global types may not be shared by any subprogram.  */
81 extern void mark_visited (tree t);
82
83 /* This macro calls the above function but short-circuits the common
84    case of a constant to save time and also checks for NULL.  */
85
86 #define MARK_VISITED(EXP)               \
87 do {                                    \
88   if((EXP) && !CONSTANT_CLASS_P (EXP))  \
89     mark_visited (EXP);                 \
90 } while (0)
91
92 /* Finalize any From_With_Type incomplete types.  We do this after processing
93    our compilation unit and after processing its spec, if this is a body.  */
94 extern void finalize_from_with_types (void);
95
96 /* Return the equivalent type to be used for GNAT_ENTITY, if it's a
97    kind of type (such E_Task_Type) that has a different type which Gigi
98    uses for its representation.  If the type does not have a special type
99    for its representation, return GNAT_ENTITY.  If a type is supposed to
100    exist, but does not, abort unless annotating types, in which case
101    return Empty.   If GNAT_ENTITY is Empty, return Empty.  */
102 extern Entity_Id Gigi_Equivalent_Type (Entity_Id gnat_entity);
103
104 /* Given GNAT_ENTITY, elaborate all expressions that are required to
105    be elaborated at the point of its definition, but do nothing else.  */
106 extern void elaborate_entity (Entity_Id gnat_entity);
107
108 /* Mark GNAT_ENTITY as going out of scope at this point.  Recursively mark
109    any entities on its entity chain similarly.  */
110 extern void mark_out_of_scope (Entity_Id gnat_entity);
111
112 /* Get the unpadded version of a GNAT type.  */
113 extern tree get_unpadded_type (Entity_Id gnat_entity);
114
115 /* Create a record type that contains a SIZE bytes long field of TYPE with a
116     starting bit position so that it is aligned to ALIGN bits, and leaving at
117     least ROOM bytes free before the field.  BASE_ALIGN is the alignment the
118     record is guaranteed to get.  */
119 extern tree make_aligning_type (tree type, unsigned int align, tree size,
120                                 unsigned int base_align, int room);
121
122 /* Ensure that TYPE has SIZE and ALIGN.  Make and return a new padded type
123    if needed.  We have already verified that SIZE and TYPE are large enough.
124    GNAT_ENTITY is used to name the resulting record and to issue a warning.
125    IS_COMPONENT_TYPE is true if this is being done for the component type
126    of an array.  IS_USER_TYPE is true if we must complete the original type.
127    DEFINITION is true if this type is being defined.  SAME_RM_SIZE is true
128    if the RM size of the resulting type is to be set to SIZE too; otherwise,
129    it's set to the RM size of the original type.  */
130 extern tree maybe_pad_type (tree type, tree size, unsigned int align,
131                             Entity_Id gnat_entity, bool is_component_type,
132                             bool is_user_type, bool definition,
133                             bool same_rm_size);
134
135 /* Given a GNU tree and a GNAT list of choices, generate an expression to test
136    the value passed against the list of choices.  */
137 extern tree choices_to_gnu (tree operand, Node_Id choices);
138
139 /* Given GNAT_ENTITY, an object (constant, variable, parameter, exception)
140    and GNU_TYPE, its corresponding GCC type, set Esize and Alignment to the
141    size and alignment used by Gigi.  Prefer SIZE over TYPE_SIZE if non-null.
142    BY_REF is true if the object is used by reference.  */
143 extern void annotate_object (Entity_Id gnat_entity, tree gnu_type, tree size,
144                              bool by_ref);
145
146 /* Given a type T, a FIELD_DECL F, and a replacement value R, return a new
147    type with all size expressions that contain F updated by replacing F
148    with R.  If F is NULL_TREE, always make a new RECORD_TYPE, even if
149    nothing has changed.  */
150 extern tree substitute_in_type (tree t, tree f, tree r);
151
152 /* Return the RM size of GNU_TYPE.  This is the actual number of bits
153    needed to represent the object.  */
154 extern tree rm_size (tree gnu_type);
155
156 /* Return the name to be used for GNAT_ENTITY.  If a type, create a
157    fully-qualified name, possibly with type information encoding.
158    Otherwise, return the name.  */
159 extern tree get_entity_name (Entity_Id gnat_entity);
160
161 /* Return an identifier representing the external name to be used for
162    GNAT_ENTITY.  If SUFFIX is specified, the name is followed by "___"
163    and the specified suffix.  */
164 extern tree create_concat_name (Entity_Id gnat_entity, const char *suffix);
165
166 /* Given GNU_NAME, an IDENTIFIER_NODE containing a name and SUFFIX, a
167    string, return a new IDENTIFIER_NODE that is the concatenation of
168    the name followed by "___" and the specified suffix.  */
169 extern tree concat_name (tree gnu_name, const char *suffix);
170
171 /* Highest number in the front-end node table.  */
172 extern int max_gnat_nodes;
173
174 /* Current node being treated, in case abort called.  */
175 extern Node_Id error_gnat_node;
176
177 /* True when gigi is being called on an analyzed but unexpanded
178    tree, and the only purpose of the call is to properly annotate
179    types with representation information.  */
180 extern bool type_annotate_only;
181
182 /* Current file name without path.  */
183 extern const char *ref_filename;
184
185 /* This structure must be kept synchronized with Call_Back_End.  */
186 struct File_Info_Type
187 {
188   File_Name_Type File_Name;
189   Nat Num_Source_Lines;
190 };
191
192 /* This is the main program of the back-end.  It sets up all the table
193    structures and then generates code.  */
194 extern void gigi (Node_Id gnat_root, int max_gnat_node,
195                   int number_name ATTRIBUTE_UNUSED,
196                   struct Node *nodes_ptr, Node_Id *next_node_ptr,
197                   Node_Id *prev_node_ptr, struct Elist_Header *elists_ptr,
198                   struct Elmt_Item *elmts_ptr,
199                   struct String_Entry *strings_ptr,
200                   Char_Code *strings_chars_ptr,
201                   struct List_Header *list_headers_ptr,
202                   Nat number_file,
203                   struct File_Info_Type *file_info_ptr,
204                   Entity_Id standard_boolean,
205                   Entity_Id standard_integer,
206                   Entity_Id standard_character,
207                   Entity_Id standard_long_long_float,
208                   Entity_Id standard_exception_type,
209                   Int gigi_operating_mode);
210
211 /* GNAT_NODE is the root of some GNAT tree.  Return the root of the
212    GCC tree corresponding to that GNAT tree.  Normally, no code is generated;
213    we just return an equivalent tree which is used elsewhere to generate
214    code.  */
215 extern tree gnat_to_gnu (Node_Id gnat_node);
216
217 /* GNU_STMT is a statement.  We generate code for that statement.  */
218 extern void gnat_expand_stmt (tree gnu_stmt);
219
220 /* Generate GIMPLE in place for the expression at *EXPR_P.  */
221 extern int gnat_gimplify_expr (tree *expr_p, gimple_seq *pre_p,
222                                gimple_seq *post_p ATTRIBUTE_UNUSED);
223
224 /* Do the processing for the declaration of a GNAT_ENTITY, a type.  If
225    a separate Freeze node exists, delay the bulk of the processing.  Otherwise
226    make a GCC type for GNAT_ENTITY and set up the correspondence.  */
227 extern void process_type (Entity_Id gnat_entity);
228
229 /* Convert SLOC into LOCUS.  Return true if SLOC corresponds to a source code
230    location and false if it doesn't.  In the former case, set the Gigi global
231    variable REF_FILENAME to the simple debug file name as given by sinput.  */
232 extern bool Sloc_to_locus (Source_Ptr Sloc, location_t *locus);
233
234 /* Post an error message.  MSG is the error message, properly annotated.
235    NODE is the node at which to post the error and the node to use for the
236    '&' substitution.  */
237 extern void post_error (const char *msg, Node_Id node);
238
239 /* Similar to post_error, but NODE is the node at which to post the error and
240    ENT is the node to use for the '&' substitution.  */
241 extern void post_error_ne (const char *msg, Node_Id node, Entity_Id ent);
242
243 /* Similar to post_error_ne, but NUM is the number to use for the '^'.  */
244 extern void post_error_ne_num (const char *msg, Node_Id node, Entity_Id ent,
245                                int num);
246
247 /* Similar to post_error_ne, but T is a GCC tree representing the number to
248    write.  If T represents a constant, the text inside curly brackets in
249    MSG will be output (presumably including a '^').  Otherwise it will not
250    be output and the text inside square brackets will be output instead.  */
251 extern void post_error_ne_tree (const char *msg, Node_Id node, Entity_Id ent,
252                                 tree t);
253
254 /* Similar to post_error_ne_tree, but NUM is a second integer to write.  */
255 extern void post_error_ne_tree_2 (const char *msg, Node_Id node, Entity_Id ent,
256                                   tree t, int num);
257
258 /* Return a label to branch to for the exception type in KIND or NULL_TREE
259    if none.  */
260 extern tree get_exception_label (char kind);
261
262 /* Current node being treated, in case gigi_abort or Check_Elaboration_Code
263    called.  */
264 extern Node_Id error_gnat_node;
265
266 /* Highest number in the front-end node table.  */
267 extern int max_gnat_nodes;
268
269 /* If nonzero, pretend we are allocating at global level.  */
270 extern int force_global;
271
272 /* The default alignment of "double" floating-point types, i.e. floating
273    point types whose size is equal to 64 bits, or 0 if this alignment is
274    not specifically capped.  */
275 extern int double_float_alignment;
276
277 /* The default alignment of "double" or larger scalar types, i.e. scalar
278    types whose size is greater or equal to 64 bits, or 0 if this alignment
279    is not specifically capped.  */
280 extern int double_scalar_alignment;
281 \f
282 /* Data structures used to represent attributes.  */
283
284 enum attr_type
285 {
286   ATTR_MACHINE_ATTRIBUTE,
287   ATTR_LINK_ALIAS,
288   ATTR_LINK_SECTION,
289   ATTR_LINK_CONSTRUCTOR,
290   ATTR_LINK_DESTRUCTOR,
291   ATTR_THREAD_LOCAL_STORAGE,
292   ATTR_WEAK_EXTERNAL
293 };
294
295 struct attrib
296 {
297   struct attrib *next;
298   enum attr_type type;
299   tree name;
300   tree args;
301   Node_Id error_point;
302 };
303
304 /* Table of machine-independent internal attributes.  */
305 extern const struct attribute_spec gnat_internal_attribute_table[];
306
307 /* Define the entries in the standard data array.  */
308 enum standard_datatypes
309 {
310   /* The longest floating-point type.  */
311   ADT_longest_float_type,
312
313   /* The type of an exception.  */
314   ADT_except_type,
315
316   /* Type declaration node  <==> typedef void *T */
317   ADT_ptr_void_type,
318
319   /* Function type declaration -- void T() */
320   ADT_void_ftype,
321
322   /* Type declaration node  <==> typedef void *T() */
323   ADT_ptr_void_ftype,
324
325   /* Type declaration node  <==> typedef virtual void *T() */
326   ADT_fdesc_type,
327
328   /* Null pointer for above type.  */
329   ADT_null_fdesc,
330
331   /* Value 1 in signed bitsizetype.  */
332   ADT_sbitsize_one_node,
333
334   /* Value BITS_PER_UNIT in signed bitsizetype.  */
335   ADT_sbitsize_unit_node,
336
337   /* Function declaration nodes for run-time functions for allocating memory.
338      Ada allocators cause calls to these functions to be generated.  Malloc32
339      is used only on 64bit systems needing to allocate 32bit memory.  */
340   ADT_malloc_decl,
341   ADT_malloc32_decl,
342
343   /* Likewise for freeing memory.  */
344   ADT_free_decl,
345
346   /* Function decl node for 64-bit multiplication with overflow checking.  */
347   ADT_mulv64_decl,
348
349   /* Identifier for the name of the _Parent field in tagged record types.  */
350   ADT_parent_name_id,
351
352   /* Identifier for the name of the Exception_Data type.  */
353   ADT_exception_data_name_id,
354
355   /* Types and decls used by our temporary exception mechanism.  See
356      init_gigi_decls for details.  */
357   ADT_jmpbuf_type,
358   ADT_jmpbuf_ptr_type,
359   ADT_get_jmpbuf_decl,
360   ADT_set_jmpbuf_decl,
361   ADT_get_excptr_decl,
362   ADT_setjmp_decl,
363   ADT_longjmp_decl,
364   ADT_update_setjmp_buf_decl,
365   ADT_raise_nodefer_decl,
366   ADT_begin_handler_decl,
367   ADT_end_handler_decl,
368   ADT_others_decl,
369   ADT_all_others_decl,
370   ADT_LAST};
371
372 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
373 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
374
375 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
376 #define except_type_node gnat_std_decls[(int) ADT_except_type]
377 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
378 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
379 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
380 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
381 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
382 #define sbitsize_one_node gnat_std_decls[(int) ADT_sbitsize_one_node]
383 #define sbitsize_unit_node gnat_std_decls[(int) ADT_sbitsize_unit_node]
384 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
385 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
386 #define free_decl gnat_std_decls[(int) ADT_free_decl]
387 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
388 #define parent_name_id gnat_std_decls[(int) ADT_parent_name_id]
389 #define exception_data_name_id gnat_std_decls[(int) ADT_exception_data_name_id]
390 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
391 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
392 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
393 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
394 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
395 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
396 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
397 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
398 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
399 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
400 #define others_decl gnat_std_decls[(int) ADT_others_decl]
401 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
402 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
403
404 /* Routines expected by the gcc back-end. They must have exactly the same
405    prototype and names as below.  */
406
407 /* Returns nonzero if we are currently in the global binding level.  */
408 extern int global_bindings_p (void);
409
410 /* Enter and exit a new binding level.  */
411 extern void gnat_pushlevel (void);
412 extern void gnat_poplevel (void);
413
414 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
415    and point FNDECL to this BLOCK.  */
416 extern void set_current_block_context (tree fndecl);
417
418 /* Set the jmpbuf_decl for the current binding level to DECL.  */
419 extern void set_block_jmpbuf_decl (tree decl);
420
421 /* Get the setjmp_decl, if any, for the current binding level.  */
422 extern tree get_block_jmpbuf_decl (void);
423
424 /* Records a ..._DECL node DECL as belonging to the current lexical scope
425    and uses GNAT_NODE for location information.  */
426 extern void gnat_pushdecl (tree decl, Node_Id gnat_node);
427
428 extern void gnat_init_gcc_eh (void);
429 extern void gnat_install_builtins (void);
430
431 /* Return an integer type with the number of bits of precision given by
432    PRECISION.  UNSIGNEDP is nonzero if the type is unsigned; otherwise
433    it is a signed type.  */
434 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
435
436 /* Return a data type that has machine mode MODE.  UNSIGNEDP selects
437    an unsigned type; otherwise a signed type is returned.  */
438 extern tree gnat_type_for_mode (enum machine_mode mode, int unsignedp);
439
440 /* Emit debug info for all global variable declarations.  */
441 extern void gnat_write_global_declarations (void);
442
443 /* Return the unsigned version of a TYPE_NODE, a scalar type.  */
444 extern tree gnat_unsigned_type (tree type_node);
445
446 /* Return the signed version of a TYPE_NODE, a scalar type.  */
447 extern tree gnat_signed_type (tree type_node);
448
449 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
450    transparently converted to each other.  */
451 extern int gnat_types_compatible_p (tree t1, tree t2);
452
453 /* Create an expression whose value is that of EXPR,
454    converted to type TYPE.  The TREE_TYPE of the value
455    is always TYPE.  This function implements all reasonable
456    conversions; callers should filter out those that are
457    not permitted by the language being compiled.  */
458 extern tree convert (tree type, tree expr);
459
460 /* Routines created solely for the tree translator's sake. Their prototypes
461    can be changed as desired.  */
462
463 /* Initialize the association of GNAT nodes to GCC trees.  */
464 extern void init_gnat_to_gnu (void);
465
466 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
467    GNU_DECL is the GCC tree which is to be associated with
468    GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
469    If NO_CHECK is nonzero, the latter check is suppressed.
470    If GNU_DECL is zero, a previous association is to be reset.  */
471 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
472                            bool no_check);
473
474 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
475    Return the ..._DECL node that was associated with it.  If there is no tree
476    node associated with GNAT_ENTITY, abort.  */
477 extern tree get_gnu_tree (Entity_Id gnat_entity);
478
479 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY.  */
480 extern bool present_gnu_tree (Entity_Id gnat_entity);
481
482 /* Initialize the association of GNAT nodes to GCC trees as dummies.  */
483 extern void init_dummy_type (void);
484
485 /* Make a dummy type corresponding to GNAT_TYPE.  */
486 extern tree make_dummy_type (Entity_Id gnat_type);
487
488 /* Record TYPE as a builtin type for Ada.  NAME is the name of the type.  */
489 extern void record_builtin_type (const char *name, tree type);
490
491 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
492    finish constructing the record or union type.  If REP_LEVEL is zero, this
493    record has no representation clause and so will be entirely laid out here.
494    If REP_LEVEL is one, this record has a representation clause and has been
495    laid out already; only set the sizes and alignment.  If REP_LEVEL is two,
496    this record is derived from a parent record and thus inherits its layout;
497    only make a pass on the fields to finalize them.  DEBUG_INFO_P is true if
498    we need to write debug information about this type.  */
499 extern void finish_record_type (tree record_type, tree field_list,
500                                 int rep_level, bool debug_info_p);
501
502 /* Wrap up compilation of RECORD_TYPE, i.e. output all the debug information
503    associated with it.  It need not be invoked directly in most cases since
504    finish_record_type takes care of doing so, but this can be necessary if
505    a parallel type is to be attached to the record type.  */
506 extern void rest_of_record_type_compilation (tree record_type);
507
508 /* Append PARALLEL_TYPE on the chain of parallel types for decl.  */
509 extern void add_parallel_type (tree decl, tree parallel_type);
510
511 /* Return the parallel type associated to a type, if any.  */
512 extern tree get_parallel_type (tree type);
513
514 /* Return a FUNCTION_TYPE node.  RETURN_TYPE is the type returned by the
515    subprogram.  If it is VOID_TYPE, then we are dealing with a procedure,
516    otherwise we are dealing with a function.  PARAM_DECL_LIST is a list of
517    PARM_DECL nodes that are the subprogram parameters.  CICO_LIST is the
518    copy-in/copy-out list to be stored into the TYPE_CICO_LIST field.
519    RETURN_UNCONSTRAINED_P is true if the function returns an unconstrained
520    object.  RETURN_BY_DIRECT_REF_P is true if the function returns by direct
521    reference.  RETURN_BY_INVISI_REF_P is true if the function returns by
522    invisible reference.  */
523 extern tree create_subprog_type (tree return_type, tree param_decl_list,
524                                  tree cico_list, bool return_unconstrained_p,
525                                  bool return_by_direct_ref_p,
526                                  bool return_by_invisi_ref_p);
527
528 /* Return a copy of TYPE, but safe to modify in any way.  */
529 extern tree copy_type (tree type);
530
531 /* Return a subtype of sizetype with range MIN to MAX and whose
532    TYPE_INDEX_TYPE is INDEX.  GNAT_NODE is used for the position
533    of the associated TYPE_DECL.  */
534 extern tree create_index_type (tree min, tree max, tree index,
535                                Node_Id gnat_node);
536
537 /* Return a subtype of TYPE with range MIN to MAX.  If TYPE is NULL,
538    sizetype is used.  */
539 extern tree create_range_type (tree type, tree min, tree max);
540
541 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
542    TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
543    its data type.  */
544 extern tree create_type_stub_decl (tree type_name, tree type);
545
546 /* Return a TYPE_DECL node.  TYPE_NAME gives the name of the type and TYPE
547    is a ..._TYPE node giving its data type.  ARTIFICIAL_P is true if this
548    is a declaration that was generated by the compiler.  DEBUG_INFO_P is
549    true if we need to write debug information about this type.  GNAT_NODE
550    is used for the position of the decl.  */
551 extern tree create_type_decl (tree type_name, tree type,
552                               struct attrib *attr_list,
553                               bool artificial_p, bool debug_info_p,
554                               Node_Id gnat_node);
555
556 /* Return a VAR_DECL or CONST_DECL node.
557
558    VAR_NAME gives the name of the variable.  ASM_NAME is its assembler name
559    (if provided).  TYPE is its data type (a GCC ..._TYPE node).  VAR_INIT is
560    the GCC tree for an optional initial expression; NULL_TREE if none.
561
562    CONST_FLAG is true if this variable is constant, in which case we might
563    return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
564
565    PUBLIC_FLAG is true if this definition is to be made visible outside of
566    the current compilation unit. This flag should be set when processing the
567    variable definitions in a package specification.
568
569    EXTERN_FLAG is nonzero when processing an external variable declaration (as
570    opposed to a definition: no storage is to be allocated for the variable).
571
572    STATIC_FLAG is only relevant when not at top level.  In that case
573    it indicates whether to always allocate storage to the variable.
574
575    GNAT_NODE is used for the position of the decl.  */
576 extern tree
577 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
578                    bool const_flag, bool public_flag, bool extern_flag,
579                    bool static_flag, bool const_decl_allowed_p,
580                    struct attrib *attr_list, Node_Id gnat_node);
581
582 /* Wrapper around create_var_decl_1 for cases where we don't care whether
583    a VAR or a CONST decl node is created.  */
584 #define create_var_decl(var_name, asm_name, type, var_init,     \
585                         const_flag, public_flag, extern_flag,   \
586                         static_flag, attr_list, gnat_node)      \
587   create_var_decl_1 (var_name, asm_name, type, var_init,        \
588                      const_flag, public_flag, extern_flag,      \
589                      static_flag, true, attr_list, gnat_node)
590
591 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
592    required.  The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
593    must be VAR_DECLs and on which we want TREE_READONLY set to have them
594    possibly assigned to a readonly data section.  */
595 #define create_true_var_decl(var_name, asm_name, type, var_init,        \
596                              const_flag, public_flag, extern_flag,      \
597                              static_flag, attr_list, gnat_node)         \
598   create_var_decl_1 (var_name, asm_name, type, var_init,                \
599                      const_flag, public_flag, extern_flag,              \
600                      static_flag, false, attr_list, gnat_node)
601
602 /* Record DECL as a global renaming pointer.  */
603 extern void record_global_renaming_pointer (tree decl);
604
605 /* Invalidate the global renaming pointers.  */
606 extern void invalidate_global_renaming_pointers (void);
607
608 /* Return a FIELD_DECL node.  FIELD_NAME is the field's name, FIELD_TYPE is
609    its type and RECORD_TYPE is the type of the enclosing record.  If SIZE is
610    nonzero, it is the specified size of the field.  If POS is nonzero, it is
611    the bit position.  PACKED is 1 if the enclosing record is packed, -1 if it
612    has Component_Alignment of Storage_Unit.  If ADDRESSABLE is nonzero, it
613    means we are allowed to take the address of the field; if it is negative,
614    we should not make a bitfield, which is used by make_aligning_type.  */
615 extern tree create_field_decl (tree field_name, tree field_type,
616                                tree record_type, tree size, tree pos,
617                                int packed, int addressable);
618
619 /* Returns a PARM_DECL node. PARAM_NAME is the name of the parameter,
620    PARAM_TYPE is its type.  READONLY is true if the parameter is
621    readonly (either an In parameter or an address of a pass-by-ref
622    parameter).  */
623 extern tree create_param_decl (tree param_name, tree param_type,
624                                bool readonly);
625
626 /* Returns a FUNCTION_DECL node.  SUBPROG_NAME is the name of the subprogram,
627    ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
628    node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
629    PARM_DECL nodes chained through the TREE_CHAIN field).
630
631    INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, and ATTR_LIST are used to set the
632    appropriate fields in the FUNCTION_DECL.  GNAT_NODE gives the location.  */
633 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
634                                  tree subprog_type, tree param_decl_list,
635                                  bool inlinee_flag, bool public_flag,
636                                  bool extern_flag,
637                                  struct attrib *attr_list, Node_Id gnat_node);
638
639 /* Returns a LABEL_DECL node for LABEL_NAME.  */
640 extern tree create_label_decl (tree label_name);
641
642 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
643    body. This routine needs to be invoked before processing the declarations
644    appearing in the subprogram.  */
645 extern void begin_subprog_body (tree subprog_decl);
646
647 /* Finish the definition of the current subprogram BODY and finalize it.  */
648 extern void end_subprog_body (tree body);
649
650 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
651    EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
652    Return a constructor for the template.  */
653 extern tree build_template (tree template_type, tree array_type, tree expr);
654
655 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
656    a descriptor type, and the GCC type of an object.  Each FIELD_DECL
657    in the type contains in its DECL_INITIAL the expression to use when
658    a constructor is made for the type.  GNAT_ENTITY is a gnat node used
659    to print out an error message if the mechanism cannot be applied to
660    an object of that type and also for the name.  */
661 extern tree build_vms_descriptor (tree type, Mechanism_Type mech,
662                                   Entity_Id gnat_entity);
663
664 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above.  */
665 extern tree build_vms_descriptor32 (tree type, Mechanism_Type mech,
666                                   Entity_Id gnat_entity);
667
668 /* Build a stub for the subprogram specified by the GCC tree GNU_SUBPROG
669    and the GNAT node GNAT_SUBPROG.  */
670 extern void build_function_stub (tree gnu_subprog, Entity_Id gnat_subprog);
671
672 /* Build a type to be used to represent an aliased object whose nominal type
673    is an unconstrained array.  This consists of a RECORD_TYPE containing a
674    field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an ARRAY_TYPE.
675    If ARRAY_TYPE is that of an unconstrained array, this is used to represent
676    an arbitrary unconstrained object.  Use NAME as the name of the record.
677    DEBUG_INFO_P is true if we need to write debug information for the type.  */
678 extern tree build_unc_object_type (tree template_type, tree object_type,
679                                    tree name, bool debug_info_p);
680
681 /* Same as build_unc_object_type, but taking a thin or fat pointer type
682    instead of the template type.  */
683 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
684                                             tree object_type, tree name,
685                                             bool debug_info_p);
686
687 /* Shift the component offsets within an unconstrained object TYPE to make it
688    suitable for use as a designated type for thin pointers.  */
689 extern void shift_unc_components_for_thin_pointers (tree type);
690
691 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE.  In
692    the normal case this is just two adjustments, but we have more to do
693    if NEW is an UNCONSTRAINED_ARRAY_TYPE.  */
694 extern void update_pointer_to (tree old_type, tree new_type);
695
696 /* EXP is an expression for the size of an object.  If this size contains
697    discriminant references, replace them with the maximum (if MAX_P) or
698    minimum (if !MAX_P) possible value of the discriminant.  */
699 extern tree max_size (tree exp, bool max_p);
700
701 /* Remove all conversions that are done in EXP.  This includes converting
702    from a padded type or to a left-justified modular type.  If TRUE_ADDRESS
703    is true, always return the address of the containing object even if
704    the address is not bit-aligned.  */
705 extern tree remove_conversions (tree exp, bool true_address);
706
707 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
708    refers to the underlying array.  If its type has TYPE_CONTAINS_TEMPLATE_P,
709    likewise return an expression pointing to the underlying array.  */
710 extern tree maybe_unconstrained_array (tree exp);
711
712 /* If EXP's type is a VECTOR_TYPE, return EXP converted to the associated
713    TYPE_REPRESENTATIVE_ARRAY.  */
714 extern tree maybe_vector_array (tree exp);
715
716 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
717    If NOTRUNC_P is true, truncation operations should be suppressed.  */
718 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
719
720 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
721    the latter being a record type as predicated by Is_Record_Type.  */
722 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
723
724 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
725    size is equal to 64 bits, or an array of such a type.  Set ALIGN_CLAUSE
726    according to the presence of an alignment clause on the type or, if it
727    is an array, on the component type.  */
728 extern bool is_double_float_or_array (Entity_Id gnat_type,
729                                       bool *align_clause);
730
731 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
732    size is greater or equal to 64 bits, or an array of such a type.  Set
733    ALIGN_CLAUSE according to the presence of an alignment clause on the
734    type or, if it is an array, on the component type.  */
735 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
736                                        bool *align_clause);
737
738 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
739    component of an aggregate type.  */
740 extern bool type_for_nonaliased_component_p (tree gnu_type);
741
742 /* Return the base type of TYPE.  */
743 extern tree get_base_type (tree type);
744
745 /* EXP is a GCC tree representing an address.  See if we can find how
746    strictly the object at that address is aligned.   Return that alignment
747    strictly the object at that address is aligned.   Return that alignment
748    in bits.  If we don't know anything about the alignment, return 0.  */
749 extern unsigned int known_alignment (tree exp);
750
751 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
752    of 2.  */
753 extern bool value_factor_p (tree value, HOST_WIDE_INT factor);
754
755 /* Make a binary operation of kind OP_CODE.  RESULT_TYPE is the type
756    desired for the result.  Usually the operation is to be performed
757    in that type.  For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
758    in which case the type to be used will be derived from the operands.  */
759 extern tree build_binary_op (enum tree_code op_code, tree result_type,
760                              tree left_operand, tree right_operand);
761
762 /* Similar, but make unary operation.  */
763 extern tree build_unary_op (enum tree_code op_code, tree result_type,
764                             tree operand);
765
766 /* Similar, but for COND_EXPR.  */
767 extern tree build_cond_expr (tree result_type, tree condition_operand,
768                              tree true_operand, tree false_operand);
769
770 /* Similar, but for RETURN_EXPR.  */
771 extern tree build_return_expr (tree ret_obj, tree ret_val);
772
773 /* Build a CALL_EXPR to call FUNDECL with one argument, ARG.  Return
774    the CALL_EXPR.  */
775 extern tree build_call_1_expr (tree fundecl, tree arg);
776
777 /* Build a CALL_EXPR to call FUNDECL with two argument, ARG1 & ARG2.  Return
778    the CALL_EXPR.  */
779 extern tree build_call_2_expr (tree fundecl, tree arg1, tree arg2);
780
781 /* Likewise to call FUNDECL with no arguments.  */
782 extern tree build_call_0_expr (tree fundecl);
783
784 /* Call a function that raises an exception and pass the line number and file
785    name, if requested.  MSG says which exception function to call.
786
787    GNAT_NODE is the gnat node conveying the source location for which the
788    error should be signaled, or Empty in which case the error is signaled on
789    the current ref_file_name/input_line.
790
791    KIND says which kind of exception this is for
792     (N_Raise_{Constraint,Storage,Program}_Error).  */
793 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
794
795 /* Return a CONSTRUCTOR of TYPE whose list is LIST.  This is not the
796    same as build_constructor in the language-independent tree.c.  */
797 extern tree gnat_build_constructor (tree type, tree list);
798
799 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
800    an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
801    for the field, or both.  Don't fold the result if NO_FOLD_P.  */
802 extern tree build_component_ref (tree record_variable, tree component,
803                                  tree field, bool no_fold_p);
804
805 /* Build a GCC tree to call an allocation or deallocation function.
806    If GNU_OBJ is nonzero, it is an object to deallocate.  Otherwise,
807    generate an allocator.
808
809    GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
810    object type, used to determine the to-be-honored address alignment.
811    GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
812    pool to use.  If not present, malloc and free are used.  GNAT_NODE is used
813    to provide an error location for restriction violation messages.  */
814 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
815                                       tree gnu_type, Entity_Id gnat_proc,
816                                       Entity_Id gnat_pool, Node_Id gnat_node);
817
818 /* Build a GCC tree to correspond to allocating an object of TYPE whose
819    initial value if INIT, if INIT is nonzero.  Convert the expression to
820    RESULT_TYPE, which must be some type of pointer.  Return the tree.
821
822    GNAT_PROC and GNAT_POOL optionally give the procedure to call and
823    the storage pool to use.  GNAT_NODE is used to provide an error
824    location for restriction violation messages.  If IGNORE_INIT_TYPE is
825    true, ignore the type of INIT for the purpose of determining the size;
826    this will cause the maximum size to be allocated if TYPE is of
827    self-referential size.  */
828 extern tree build_allocator (tree type, tree init, tree result_type,
829                              Entity_Id gnat_proc, Entity_Id gnat_pool,
830                              Node_Id gnat_node, bool);
831
832 /* Fill in a VMS descriptor for EXPR and return a constructor for it.
833    GNAT_FORMAL is how we find the descriptor record. GNAT_ACTUAL is how
834    we derive the source location on a C_E */
835 extern tree fill_vms_descriptor (tree expr, Entity_Id gnat_formal,
836                                  Node_Id gnat_actual);
837
838 /* Indicate that we need to take the address of T and that it therefore
839    should not be allocated in a register.  Returns true if successful.  */
840 extern bool gnat_mark_addressable (tree t);
841
842 /* Save EXP for later use or reuse.  This is equivalent to save_expr in tree.c
843    but we know how to handle our own nodes.  */
844 extern tree gnat_save_expr (tree exp);
845
846 /* Protect EXP for immediate reuse.  This is a variant of gnat_save_expr that
847    is optimized under the assumption that EXP's value doesn't change before
848    its subsequent reuse(s) except through its potential reevaluation.  */
849 extern tree gnat_protect_expr (tree exp);
850
851 /* This is equivalent to stabilize_reference in tree.c but we know how to
852    handle our own nodes and we take extra arguments.  FORCE says whether to
853    force evaluation of everything.  We set SUCCESS to true unless we walk
854    through something we don't know how to stabilize.  */
855 extern tree gnat_stabilize_reference (tree ref, bool force, bool *success);
856
857 /* Implementation of the builtin_function langhook.  */
858 extern tree gnat_builtin_function (tree decl);
859
860 /* Search the chain of currently reachable declarations for a builtin
861    FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
862    Return the first node found, if any, or NULL_TREE otherwise.  */
863 extern tree builtin_decl_for (tree name);
864
865 /* GNU_TYPE is a type. Determine if it should be passed by reference by
866    default.  */
867 extern bool default_pass_by_ref (tree gnu_type);
868
869 /* GNU_TYPE is the type of a subprogram parameter.  Determine from the type
870    if it should be passed by reference.  */
871 extern bool must_pass_by_ref (tree gnu_type);
872
873 /* This function is called by the front end to enumerate all the supported
874    modes for the machine.  We pass a function which is called back with
875    the following integer parameters:
876
877    FLOAT_P      nonzero if this represents a floating-point mode
878    COMPLEX_P    nonzero is this represents a complex mode
879    COUNT        count of number of items, nonzero for vector mode
880    PRECISION    number of bits in data representation
881    MANTISSA     number of bits in mantissa, if FP and known, else zero.
882    SIZE         number of bits used to store data
883    ALIGN        number of bits to which mode is aligned.  */
884 extern void enumerate_modes (void (*f) (int, int, int, int, int, int,
885                                         unsigned int));
886
887 /* Return the size of the FP mode with precision PREC.  */
888 extern int fp_prec_to_size (int prec);
889
890 /* Return the precision of the FP mode with size SIZE.  */
891 extern int fp_size_to_prec (int size);
892
893 /* These functions return the basic data type sizes and related parameters
894    about the target machine.  */
895
896 extern Pos get_target_bits_per_unit (void);
897 extern Pos get_target_bits_per_word (void);
898 extern Pos get_target_char_size (void);
899 extern Pos get_target_wchar_t_size (void);
900 extern Pos get_target_short_size (void);
901 extern Pos get_target_int_size (void);
902 extern Pos get_target_long_size (void);
903 extern Pos get_target_long_long_size (void);
904 extern Pos get_target_float_size (void);
905 extern Pos get_target_double_size (void);
906 extern Pos get_target_long_double_size (void);
907 extern Pos get_target_pointer_size (void);
908 extern Pos get_target_maximum_default_alignment (void);
909 extern Pos get_target_default_allocator_alignment (void);
910 extern Pos get_target_maximum_allowed_alignment (void);
911 extern Pos get_target_maximum_alignment (void);
912 extern Nat get_float_words_be (void);
913 extern Nat get_words_be (void);
914 extern Nat get_bytes_be (void);
915 extern Nat get_bits_be (void);
916 extern Nat get_target_strict_alignment (void);
917 extern Nat get_target_double_float_alignment (void);
918 extern Nat get_target_double_scalar_alignment (void);
919
920 /* Let code know whether we are targetting VMS without need of
921    intrusive preprocessor directives.  */
922 #ifndef TARGET_ABI_OPEN_VMS
923 #define TARGET_ABI_OPEN_VMS 0
924 #endif
925
926 /* VMS macro set by default, when clear forces 32bit mallocs and 32bit
927    Descriptors. Always used in combination with TARGET_ABI_OPEN_VMS
928    so no effect on non-VMS systems.  */
929 #ifndef TARGET_MALLOC64
930 #define TARGET_MALLOC64 0
931 #endif
932
933 /* Convenient shortcuts.  */
934 #define VECTOR_TYPE_P(TYPE) (TREE_CODE (TYPE) == VECTOR_TYPE)