OSDN Git Service

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