OSDN Git Service

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