OSDN Git Service

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