OSDN Git Service

b57c95872935e528aabb10c45ee4a3e59157d240
[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 /* If nonzero, pretend we are allocating at global level.  */
263 extern int force_global;
264
265 /* The default alignment of "double" floating-point types, i.e. floating
266    point types whose size is equal to 64 bits, or 0 if this alignment is
267    not specifically capped.  */
268 extern int double_float_alignment;
269
270 /* The default alignment of "double" or larger scalar types, i.e. scalar
271    types whose size is greater or equal to 64 bits, or 0 if this alignment
272    is not specifically capped.  */
273 extern int double_scalar_alignment;
274 \f
275 /* Data structures used to represent attributes.  */
276
277 enum attr_type
278 {
279   ATTR_MACHINE_ATTRIBUTE,
280   ATTR_LINK_ALIAS,
281   ATTR_LINK_SECTION,
282   ATTR_LINK_CONSTRUCTOR,
283   ATTR_LINK_DESTRUCTOR,
284   ATTR_THREAD_LOCAL_STORAGE,
285   ATTR_WEAK_EXTERNAL
286 };
287
288 struct attrib
289 {
290   struct attrib *next;
291   enum attr_type type;
292   tree name;
293   tree args;
294   Node_Id error_point;
295 };
296
297 /* Table of machine-independent internal attributes.  */
298 extern const struct attribute_spec gnat_internal_attribute_table[];
299
300 /* Define the entries in the standard data array.  */
301 enum standard_datatypes
302 {
303   /* The longest floating-point type.  */
304   ADT_longest_float_type,
305
306   /* The type of an exception.  */
307   ADT_except_type,
308
309   /* Type declaration node  <==> typedef void *T */
310   ADT_ptr_void_type,
311
312   /* Function type declaration -- void T() */
313   ADT_void_ftype,
314
315   /* Type declaration node  <==> typedef void *T() */
316   ADT_ptr_void_ftype,
317
318   /* Type declaration node  <==> typedef virtual void *T() */
319   ADT_fdesc_type,
320
321   /* Null pointer for above type.  */
322   ADT_null_fdesc,
323
324   /* Value 1 in signed bitsizetype.  */
325   ADT_sbitsize_one_node,
326
327   /* Value BITS_PER_UNIT in signed bitsizetype.  */
328   ADT_sbitsize_unit_node,
329
330   /* Function declaration nodes for run-time functions for allocating memory.
331      Ada allocators cause calls to these functions to be generated.  Malloc32
332      is used only on 64bit systems needing to allocate 32bit memory.  */
333   ADT_malloc_decl,
334   ADT_malloc32_decl,
335
336   /* Likewise for freeing memory.  */
337   ADT_free_decl,
338
339   /* Function decl node for 64-bit multiplication with overflow checking.  */
340   ADT_mulv64_decl,
341
342   /* Identifier for the name of the _Parent field in tagged record types.  */
343   ADT_parent_name_id,
344
345   /* Identifier for the name of the Exception_Data type.  */
346   ADT_exception_data_name_id,
347
348   /* Types and decls used by our temporary exception mechanism.  See
349      init_gigi_decls for details.  */
350   ADT_jmpbuf_type,
351   ADT_jmpbuf_ptr_type,
352   ADT_get_jmpbuf_decl,
353   ADT_set_jmpbuf_decl,
354   ADT_get_excptr_decl,
355   ADT_setjmp_decl,
356   ADT_longjmp_decl,
357   ADT_update_setjmp_buf_decl,
358   ADT_raise_nodefer_decl,
359   ADT_begin_handler_decl,
360   ADT_end_handler_decl,
361   ADT_others_decl,
362   ADT_all_others_decl,
363   ADT_LAST};
364
365 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
366 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
367
368 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
369 #define except_type_node gnat_std_decls[(int) ADT_except_type]
370 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
371 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
372 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
373 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
374 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
375 #define sbitsize_one_node gnat_std_decls[(int) ADT_sbitsize_one_node]
376 #define sbitsize_unit_node gnat_std_decls[(int) ADT_sbitsize_unit_node]
377 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
378 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
379 #define free_decl gnat_std_decls[(int) ADT_free_decl]
380 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
381 #define parent_name_id gnat_std_decls[(int) ADT_parent_name_id]
382 #define exception_data_name_id gnat_std_decls[(int) ADT_exception_data_name_id]
383 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
384 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
385 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
386 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
387 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
388 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
389 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
390 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
391 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
392 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
393 #define others_decl gnat_std_decls[(int) ADT_others_decl]
394 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
395 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
396
397 /* Routines expected by the gcc back-end. They must have exactly the same
398    prototype and names as below.  */
399
400 /* Returns nonzero if we are currently in the global binding level.  */
401 extern int global_bindings_p (void);
402
403 /* Enter and exit a new binding level.  */
404 extern void gnat_pushlevel (void);
405 extern void gnat_poplevel (void);
406
407 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
408    and point FNDECL to this BLOCK.  */
409 extern void set_current_block_context (tree fndecl);
410
411 /* Set the jmpbuf_decl for the current binding level to DECL.  */
412 extern void set_block_jmpbuf_decl (tree decl);
413
414 /* Get the setjmp_decl, if any, for the current binding level.  */
415 extern tree get_block_jmpbuf_decl (void);
416
417 /* Records a ..._DECL node DECL as belonging to the current lexical scope
418    and uses GNAT_NODE for location information.  */
419 extern void gnat_pushdecl (tree decl, Node_Id gnat_node);
420
421 extern void gnat_init_gcc_eh (void);
422 extern void gnat_install_builtins (void);
423
424 /* Return an integer type with the number of bits of precision given by
425    PRECISION.  UNSIGNEDP is nonzero if the type is unsigned; otherwise
426    it is a signed type.  */
427 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
428
429 /* Return a data type that has machine mode MODE.  UNSIGNEDP selects
430    an unsigned type; otherwise a signed type is returned.  */
431 extern tree gnat_type_for_mode (enum machine_mode mode, int unsignedp);
432
433 /* Emit debug info for all global variable declarations.  */
434 extern void gnat_write_global_declarations (void);
435
436 /* Return the unsigned version of a TYPE_NODE, a scalar type.  */
437 extern tree gnat_unsigned_type (tree type_node);
438
439 /* Return the signed version of a TYPE_NODE, a scalar type.  */
440 extern tree gnat_signed_type (tree type_node);
441
442 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
443    transparently converted to each other.  */
444 extern int gnat_types_compatible_p (tree t1, tree t2);
445
446 /* Create an expression whose value is that of EXPR,
447    converted to type TYPE.  The TREE_TYPE of the value
448    is always TYPE.  This function implements all reasonable
449    conversions; callers should filter out those that are
450    not permitted by the language being compiled.  */
451 extern tree convert (tree type, tree expr);
452
453 /* Routines created solely for the tree translator's sake. Their prototypes
454    can be changed as desired.  */
455
456 /* Initialize the association of GNAT nodes to GCC trees.  */
457 extern void init_gnat_to_gnu (void);
458
459 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
460    GNU_DECL is the GCC tree which is to be associated with
461    GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
462    If NO_CHECK is nonzero, the latter check is suppressed.
463    If GNU_DECL is zero, a previous association is to be reset.  */
464 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
465                            bool no_check);
466
467 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
468    Return the ..._DECL node that was associated with it.  If there is no tree
469    node associated with GNAT_ENTITY, abort.  */
470 extern tree get_gnu_tree (Entity_Id gnat_entity);
471
472 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY.  */
473 extern bool present_gnu_tree (Entity_Id gnat_entity);
474
475 /* Initialize the association of GNAT nodes to GCC trees as dummies.  */
476 extern void init_dummy_type (void);
477
478 /* Make a dummy type corresponding to GNAT_TYPE.  */
479 extern tree make_dummy_type (Entity_Id gnat_type);
480
481 /* Record TYPE as a builtin type for Ada.  NAME is the name of the type.  */
482 extern void record_builtin_type (const char *name, tree type);
483
484 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
485    finish constructing the record or union type.  If REP_LEVEL is zero, this
486    record has no representation clause and so will be entirely laid out here.
487    If REP_LEVEL is one, this record has a representation clause and has been
488    laid out already; only set the sizes and alignment.  If REP_LEVEL is two,
489    this record is derived from a parent record and thus inherits its layout;
490    only make a pass on the fields to finalize them.  DEBUG_INFO_P is true if
491    we need to write debug information about this type.  */
492 extern void finish_record_type (tree record_type, tree field_list,
493                                 int rep_level, bool debug_info_p);
494
495 /* Wrap up compilation of RECORD_TYPE, i.e. output all the debug information
496    associated with it.  It need not be invoked directly in most cases since
497    finish_record_type takes care of doing so, but this can be necessary if
498    a parallel type is to be attached to the record type.  */
499 extern void rest_of_record_type_compilation (tree record_type);
500
501 /* Append PARALLEL_TYPE on the chain of parallel types for decl.  */
502 extern void add_parallel_type (tree decl, tree parallel_type);
503
504 /* Return the parallel type associated to a type, if any.  */
505 extern tree get_parallel_type (tree type);
506
507 /* Return a FUNCTION_TYPE node.  RETURN_TYPE is the type returned by the
508    subprogram.  If it is VOID_TYPE, then we are dealing with a procedure,
509    otherwise we are dealing with a function.  PARAM_DECL_LIST is a list of
510    PARM_DECL nodes that are the subprogram parameters.  CICO_LIST is the
511    copy-in/copy-out list to be stored into the TYPE_CICO_LIST field.
512    RETURN_UNCONSTRAINED_P is true if the function returns an unconstrained
513    object.  RETURN_BY_DIRECT_REF_P is true if the function returns by direct
514    reference.  RETURN_BY_INVISI_REF_P is true if the function returns by
515    invisible reference.  */
516 extern tree create_subprog_type (tree return_type, tree param_decl_list,
517                                  tree cico_list, bool return_unconstrained_p,
518                                  bool return_by_direct_ref_p,
519                                  bool return_by_invisi_ref_p);
520
521 /* Return a copy of TYPE, but safe to modify in any way.  */
522 extern tree copy_type (tree type);
523
524 /* Return a subtype of sizetype with range MIN to MAX and whose
525    TYPE_INDEX_TYPE is INDEX.  GNAT_NODE is used for the position
526    of the associated TYPE_DECL.  */
527 extern tree create_index_type (tree min, tree max, tree index,
528                                Node_Id gnat_node);
529
530 /* Return a subtype of TYPE with range MIN to MAX.  If TYPE is NULL,
531    sizetype is used.  */
532 extern tree create_range_type (tree type, tree min, tree max);
533
534 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
535    TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
536    its data type.  */
537 extern tree create_type_stub_decl (tree type_name, tree type);
538
539 /* Return a TYPE_DECL node.  TYPE_NAME gives the name of the type and TYPE
540    is a ..._TYPE node giving its data type.  ARTIFICIAL_P is true if this
541    is a declaration that was generated by the compiler.  DEBUG_INFO_P is
542    true if we need to write debug information about this type.  GNAT_NODE
543    is used for the position of the decl.  */
544 extern tree create_type_decl (tree type_name, tree type,
545                               struct attrib *attr_list,
546                               bool artificial_p, bool debug_info_p,
547                               Node_Id gnat_node);
548
549 /* Return a VAR_DECL or CONST_DECL node.
550
551    VAR_NAME gives the name of the variable.  ASM_NAME is its assembler name
552    (if provided).  TYPE is its data type (a GCC ..._TYPE node).  VAR_INIT is
553    the GCC tree for an optional initial expression; NULL_TREE if none.
554
555    CONST_FLAG is true if this variable is constant, in which case we might
556    return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
557
558    PUBLIC_FLAG is true if this definition is to be made visible outside of
559    the current compilation unit. This flag should be set when processing the
560    variable definitions in a package specification.
561
562    EXTERN_FLAG is nonzero when processing an external variable declaration (as
563    opposed to a definition: no storage is to be allocated for the variable).
564
565    STATIC_FLAG is only relevant when not at top level.  In that case
566    it indicates whether to always allocate storage to the variable.
567
568    GNAT_NODE is used for the position of the decl.  */
569 extern tree
570 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
571                    bool const_flag, bool public_flag, bool extern_flag,
572                    bool static_flag, bool const_decl_allowed_p,
573                    struct attrib *attr_list, Node_Id gnat_node);
574
575 /* Wrapper around create_var_decl_1 for cases where we don't care whether
576    a VAR or a CONST decl node is created.  */
577 #define create_var_decl(var_name, asm_name, type, var_init,     \
578                         const_flag, public_flag, extern_flag,   \
579                         static_flag, attr_list, gnat_node)      \
580   create_var_decl_1 (var_name, asm_name, type, var_init,        \
581                      const_flag, public_flag, extern_flag,      \
582                      static_flag, true, attr_list, gnat_node)
583
584 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
585    required.  The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
586    must be VAR_DECLs and on which we want TREE_READONLY set to have them
587    possibly assigned to a readonly data section.  */
588 #define create_true_var_decl(var_name, asm_name, type, var_init,        \
589                              const_flag, public_flag, extern_flag,      \
590                              static_flag, attr_list, gnat_node)         \
591   create_var_decl_1 (var_name, asm_name, type, var_init,                \
592                      const_flag, public_flag, extern_flag,              \
593                      static_flag, false, attr_list, gnat_node)
594
595 /* Record DECL as a global renaming pointer.  */
596 extern void record_global_renaming_pointer (tree decl);
597
598 /* Invalidate the global renaming pointers.  */
599 extern void invalidate_global_renaming_pointers (void);
600
601 /* Return a FIELD_DECL node.  FIELD_NAME is the field's name, FIELD_TYPE is
602    its type and RECORD_TYPE is the type of the enclosing record.  If SIZE is
603    nonzero, it is the specified size of the field.  If POS is nonzero, it is
604    the bit position.  PACKED is 1 if the enclosing record is packed, -1 if it
605    has Component_Alignment of Storage_Unit.  If ADDRESSABLE is nonzero, it
606    means we are allowed to take the address of the field; if it is negative,
607    we should not make a bitfield, which is used by make_aligning_type.  */
608 extern tree create_field_decl (tree field_name, tree field_type,
609                                tree record_type, tree size, tree pos,
610                                int packed, int addressable);
611
612 /* Returns a PARM_DECL node. PARAM_NAME is the name of the parameter,
613    PARAM_TYPE is its type.  READONLY is true if the parameter is
614    readonly (either an In parameter or an address of a pass-by-ref
615    parameter).  */
616 extern tree create_param_decl (tree param_name, tree param_type,
617                                bool readonly);
618
619 /* Returns a FUNCTION_DECL node.  SUBPROG_NAME is the name of the subprogram,
620    ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
621    node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
622    PARM_DECL nodes chained through the TREE_CHAIN field).
623
624    INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, and ATTR_LIST are used to set the
625    appropriate fields in the FUNCTION_DECL.  GNAT_NODE gives the location.  */
626 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
627                                  tree subprog_type, tree param_decl_list,
628                                  bool inlinee_flag, bool public_flag,
629                                  bool extern_flag,
630                                  struct attrib *attr_list, Node_Id gnat_node);
631
632 /* Returns a LABEL_DECL node for LABEL_NAME.  */
633 extern tree create_label_decl (tree label_name);
634
635 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
636    body. This routine needs to be invoked before processing the declarations
637    appearing in the subprogram.  */
638 extern void begin_subprog_body (tree subprog_decl);
639
640 /* Finish the definition of the current subprogram BODY and finalize it.  */
641 extern void end_subprog_body (tree body);
642
643 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
644    EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
645    Return a constructor for the template.  */
646 extern tree build_template (tree template_type, tree array_type, tree expr);
647
648 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
649    a descriptor type, and the GCC type of an object.  Each FIELD_DECL
650    in the type contains in its DECL_INITIAL the expression to use when
651    a constructor is made for the type.  GNAT_ENTITY is a gnat node used
652    to print out an error message if the mechanism cannot be applied to
653    an object of that type and also for the name.  */
654 extern tree build_vms_descriptor (tree type, Mechanism_Type mech,
655                                   Entity_Id gnat_entity);
656
657 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above.  */
658 extern tree build_vms_descriptor32 (tree type, Mechanism_Type mech,
659                                   Entity_Id gnat_entity);
660
661 /* Build a stub for the subprogram specified by the GCC tree GNU_SUBPROG
662    and the GNAT node GNAT_SUBPROG.  */
663 extern void build_function_stub (tree gnu_subprog, Entity_Id gnat_subprog);
664
665 /* Build a type to be used to represent an aliased object whose nominal type
666    is an unconstrained array.  This consists of a RECORD_TYPE containing a
667    field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an ARRAY_TYPE.
668    If ARRAY_TYPE is that of an unconstrained array, this is used to represent
669    an arbitrary unconstrained object.  Use NAME as the name of the record.
670    DEBUG_INFO_P is true if we need to write debug information for the type.  */
671 extern tree build_unc_object_type (tree template_type, tree object_type,
672                                    tree name, bool debug_info_p);
673
674 /* Same as build_unc_object_type, but taking a thin or fat pointer type
675    instead of the template type.  */
676 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
677                                             tree object_type, tree name,
678                                             bool debug_info_p);
679
680 /* Shift the component offsets within an unconstrained object TYPE to make it
681    suitable for use as a designated type for thin pointers.  */
682 extern void shift_unc_components_for_thin_pointers (tree type);
683
684 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE.  In
685    the normal case this is just two adjustments, but we have more to do
686    if NEW is an UNCONSTRAINED_ARRAY_TYPE.  */
687 extern void update_pointer_to (tree old_type, tree new_type);
688
689 /* EXP is an expression for the size of an object.  If this size contains
690    discriminant references, replace them with the maximum (if MAX_P) or
691    minimum (if !MAX_P) possible value of the discriminant.  */
692 extern tree max_size (tree exp, bool max_p);
693
694 /* Remove all conversions that are done in EXP.  This includes converting
695    from a padded type or to a left-justified modular type.  If TRUE_ADDRESS
696    is true, always return the address of the containing object even if
697    the address is not bit-aligned.  */
698 extern tree remove_conversions (tree exp, bool true_address);
699
700 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
701    refers to the underlying array.  If its type has TYPE_CONTAINS_TEMPLATE_P,
702    likewise return an expression pointing to the underlying array.  */
703 extern tree maybe_unconstrained_array (tree exp);
704
705 /* If EXP's type is a VECTOR_TYPE, return EXP converted to the associated
706    TYPE_REPRESENTATIVE_ARRAY.  */
707 extern tree maybe_vector_array (tree exp);
708
709 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
710    If NOTRUNC_P is true, truncation operations should be suppressed.  */
711 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
712
713 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
714    the latter being a record type as predicated by Is_Record_Type.  */
715 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
716
717 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
718    size is equal to 64 bits, or an array of such a type.  Set ALIGN_CLAUSE
719    according to the presence of an alignment clause on the type or, if it
720    is an array, on the component type.  */
721 extern bool is_double_float_or_array (Entity_Id gnat_type,
722                                       bool *align_clause);
723
724 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
725    size is greater or equal to 64 bits, or an array of such a type.  Set
726    ALIGN_CLAUSE according to the presence of an alignment clause on the
727    type or, if it is an array, on the component type.  */
728 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
729                                        bool *align_clause);
730
731 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
732    component of an aggregate type.  */
733 extern bool type_for_nonaliased_component_p (tree gnu_type);
734
735 /* Return the base type of TYPE.  */
736 extern tree get_base_type (tree type);
737
738 /* EXP is a GCC tree representing an address.  See if we can find how
739    strictly the object at that address is aligned.   Return that alignment
740    strictly the object at that address is aligned.   Return that alignment
741    in bits.  If we don't know anything about the alignment, return 0.  */
742 extern unsigned int known_alignment (tree exp);
743
744 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
745    of 2.  */
746 extern bool value_factor_p (tree value, HOST_WIDE_INT factor);
747
748 /* Make a binary operation of kind OP_CODE.  RESULT_TYPE is the type
749    desired for the result.  Usually the operation is to be performed
750    in that type.  For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
751    in which case the type to be used will be derived from the operands.  */
752 extern tree build_binary_op (enum tree_code op_code, tree result_type,
753                              tree left_operand, tree right_operand);
754
755 /* Similar, but make unary operation.  */
756 extern tree build_unary_op (enum tree_code op_code, tree result_type,
757                             tree operand);
758
759 /* Similar, but for COND_EXPR.  */
760 extern tree build_cond_expr (tree result_type, tree condition_operand,
761                              tree true_operand, tree false_operand);
762
763 /* Similar, but for RETURN_EXPR.  */
764 extern tree build_return_expr (tree ret_obj, tree ret_val);
765
766 /* Build a CALL_EXPR to call FUNDECL with one argument, ARG.  Return
767    the CALL_EXPR.  */
768 extern tree build_call_1_expr (tree fundecl, tree arg);
769
770 /* Build a CALL_EXPR to call FUNDECL with two argument, ARG1 & ARG2.  Return
771    the CALL_EXPR.  */
772 extern tree build_call_2_expr (tree fundecl, tree arg1, tree arg2);
773
774 /* Likewise to call FUNDECL with no arguments.  */
775 extern tree build_call_0_expr (tree fundecl);
776
777 /* Call a function that raises an exception and pass the line number and file
778    name, if requested.  MSG says which exception function to call.
779
780    GNAT_NODE is the gnat node conveying the source location for which the
781    error should be signaled, or Empty in which case the error is signaled on
782    the current ref_file_name/input_line.
783
784    KIND says which kind of exception this is for
785     (N_Raise_{Constraint,Storage,Program}_Error).  */
786 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
787
788 /* Return a CONSTRUCTOR of TYPE whose list is LIST.  This is not the
789    same as build_constructor in the language-independent tree.c.  */
790 extern tree gnat_build_constructor (tree type, tree list);
791
792 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
793    an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
794    for the field, or both.  Don't fold the result if NO_FOLD_P.  */
795 extern tree build_component_ref (tree record_variable, tree component,
796                                  tree field, bool no_fold_p);
797
798 /* Build a GCC tree to call an allocation or deallocation function.
799    If GNU_OBJ is nonzero, it is an object to deallocate.  Otherwise,
800    generate an allocator.
801
802    GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
803    object type, used to determine the to-be-honored address alignment.
804    GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
805    pool to use.  If not present, malloc and free are used.  GNAT_NODE is used
806    to provide an error location for restriction violation messages.  */
807 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
808                                       tree gnu_type, Entity_Id gnat_proc,
809                                       Entity_Id gnat_pool, Node_Id gnat_node);
810
811 /* Build a GCC tree to correspond to allocating an object of TYPE whose
812    initial value if INIT, if INIT is nonzero.  Convert the expression to
813    RESULT_TYPE, which must be some type of pointer.  Return the tree.
814
815    GNAT_PROC and GNAT_POOL optionally give the procedure to call and
816    the storage pool to use.  GNAT_NODE is used to provide an error
817    location for restriction violation messages.  If IGNORE_INIT_TYPE is
818    true, ignore the type of INIT for the purpose of determining the size;
819    this will cause the maximum size to be allocated if TYPE is of
820    self-referential size.  */
821 extern tree build_allocator (tree type, tree init, tree result_type,
822                              Entity_Id gnat_proc, Entity_Id gnat_pool,
823                              Node_Id gnat_node, bool);
824
825 /* Fill in a VMS descriptor for EXPR and return a constructor for it.
826    GNAT_FORMAL is how we find the descriptor record. GNAT_ACTUAL is how
827    we derive the source location on a C_E */
828 extern tree fill_vms_descriptor (tree expr, Entity_Id gnat_formal,
829                                  Node_Id gnat_actual);
830
831 /* Indicate that we need to take the address of T and that it therefore
832    should not be allocated in a register.  Returns true if successful.  */
833 extern bool gnat_mark_addressable (tree t);
834
835 /* Implementation of the builtin_function langhook.  */
836 extern tree gnat_builtin_function (tree decl);
837
838 /* Search the chain of currently reachable declarations for a builtin
839    FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
840    Return the first node found, if any, or NULL_TREE otherwise.  */
841 extern tree builtin_decl_for (tree name);
842
843 /* GNU_TYPE is a type. Determine if it should be passed by reference by
844    default.  */
845 extern bool default_pass_by_ref (tree gnu_type);
846
847 /* GNU_TYPE is the type of a subprogram parameter.  Determine from the type
848    if it should be passed by reference.  */
849 extern bool must_pass_by_ref (tree gnu_type);
850
851 /* This function is called by the front end to enumerate all the supported
852    modes for the machine.  We pass a function which is called back with
853    the following integer parameters:
854
855    FLOAT_P      nonzero if this represents a floating-point mode
856    COMPLEX_P    nonzero is this represents a complex mode
857    COUNT        count of number of items, nonzero for vector mode
858    PRECISION    number of bits in data representation
859    MANTISSA     number of bits in mantissa, if FP and known, else zero.
860    SIZE         number of bits used to store data
861    ALIGN        number of bits to which mode is aligned.  */
862 extern void enumerate_modes (void (*f) (int, int, int, int, int, int,
863                                         unsigned int));
864
865 /* Return the size of the FP mode with precision PREC.  */
866 extern int fp_prec_to_size (int prec);
867
868 /* Return the precision of the FP mode with size SIZE.  */
869 extern int fp_size_to_prec (int size);
870
871 /* These functions return the basic data type sizes and related parameters
872    about the target machine.  */
873
874 extern Pos get_target_bits_per_unit (void);
875 extern Pos get_target_bits_per_word (void);
876 extern Pos get_target_char_size (void);
877 extern Pos get_target_wchar_t_size (void);
878 extern Pos get_target_short_size (void);
879 extern Pos get_target_int_size (void);
880 extern Pos get_target_long_size (void);
881 extern Pos get_target_long_long_size (void);
882 extern Pos get_target_float_size (void);
883 extern Pos get_target_double_size (void);
884 extern Pos get_target_long_double_size (void);
885 extern Pos get_target_pointer_size (void);
886 extern Pos get_target_maximum_default_alignment (void);
887 extern Pos get_target_default_allocator_alignment (void);
888 extern Pos get_target_maximum_allowed_alignment (void);
889 extern Pos get_target_maximum_alignment (void);
890 extern Nat get_float_words_be (void);
891 extern Nat get_words_be (void);
892 extern Nat get_bytes_be (void);
893 extern Nat get_bits_be (void);
894 extern Nat get_target_strict_alignment (void);
895 extern Nat get_target_double_float_alignment (void);
896 extern Nat get_target_double_scalar_alignment (void);
897
898 /* Let code know whether we are targetting VMS without need of
899    intrusive preprocessor directives.  */
900 #ifndef TARGET_ABI_OPEN_VMS
901 #define TARGET_ABI_OPEN_VMS 0
902 #endif
903
904 /* VMS macro set by default, when clear forces 32bit mallocs and 32bit
905    Descriptors. Always used in combination with TARGET_ABI_OPEN_VMS
906    so no effect on non-VMS systems.  */
907 #ifndef TARGET_MALLOC64
908 #define TARGET_MALLOC64 0
909 #endif
910
911 /* Convenient shortcuts.  */
912 #define VECTOR_TYPE_P(TYPE) (TREE_CODE (TYPE) == VECTOR_TYPE)