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