1 /****************************************************************************
3 * GNAT COMPILER COMPONENTS *
9 * Copyright (C) 1992-2013, 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 /* Start a new statement group chained to the previous group. */
55 extern void start_stmt_group (void);
57 /* Add GNU_STMT to the current statement group. If it is an expression with
58 no effects, it is ignored. */
59 extern void add_stmt (tree gnu_stmt
);
61 /* Similar, but the statement is always added, regardless of side-effects. */
62 extern void add_stmt_force (tree gnu_stmt
);
64 /* Like add_stmt, but set the location of GNU_STMT to that of GNAT_NODE. */
65 extern void add_stmt_with_node (tree gnu_stmt
, Node_Id gnat_node
);
67 /* Similar, but the statement is always added, regardless of side-effects. */
68 extern void add_stmt_with_node_force (tree gnu_stmt
, Node_Id gnat_node
);
70 /* Return code corresponding to the current code group. It is normally
71 a STATEMENT_LIST, but may also be a BIND_EXPR or TRY_FINALLY_EXPR if
72 BLOCK or cleanups were set. */
73 extern tree
end_stmt_group (void);
75 /* Set the BLOCK node corresponding to the current code group to GNU_BLOCK. */
76 extern void set_block_for_group (tree
);
78 /* Add a declaration statement for GNU_DECL to the current BLOCK_STMT node.
79 Get SLOC from GNAT_ENTITY. */
80 extern void add_decl_expr (tree gnu_decl
, Entity_Id gnat_entity
);
82 /* Mark nodes rooted at T with TREE_VISITED and types as having their
83 sized gimplified. We use this to indicate all variable sizes and
84 positions in global types may not be shared by any subprogram. */
85 extern void mark_visited (tree t
);
87 /* This macro calls the above function but short-circuits the common
88 case of a constant to save time and also checks for NULL. */
90 #define MARK_VISITED(EXP) \
92 if((EXP) && !CONSTANT_CLASS_P (EXP)) \
96 /* Finalize the processing of From_With_Type incomplete types. */
97 extern void finalize_from_with_types (void);
99 /* Return the equivalent type to be used for GNAT_ENTITY, if it's a
100 kind of type (such E_Task_Type) that has a different type which Gigi
101 uses for its representation. If the type does not have a special type
102 for its representation, return GNAT_ENTITY. If a type is supposed to
103 exist, but does not, abort unless annotating types, in which case
104 return Empty. If GNAT_ENTITY is Empty, return Empty. */
105 extern Entity_Id
Gigi_Equivalent_Type (Entity_Id gnat_entity
);
107 /* Given GNAT_ENTITY, elaborate all expressions that are required to
108 be elaborated at the point of its definition, but do nothing else. */
109 extern void elaborate_entity (Entity_Id gnat_entity
);
111 /* Get the unpadded version of a GNAT type. */
112 extern tree
get_unpadded_type (Entity_Id gnat_entity
);
114 /* Return the DECL associated with the public subprogram GNAT_ENTITY but whose
115 type has been changed to that of the parameterless procedure, except if an
116 alias is already present, in which case it is returned instead. */
117 extern tree
get_minimal_subprog_decl (Entity_Id gnat_entity
);
119 /* Return whether the E_Subprogram_Type/E_Function/E_Procedure GNAT_ENTITY is
120 a C++ imported method or equivalent. */
121 extern bool is_cplusplus_method (Entity_Id gnat_entity
);
123 /* Create a record type that contains a SIZE bytes long field of TYPE with a
124 starting bit position so that it is aligned to ALIGN bits, and leaving at
125 least ROOM bytes free before the field. BASE_ALIGN is the alignment the
126 record is guaranteed to get. */
127 extern tree
make_aligning_type (tree type
, unsigned int align
, tree size
,
128 unsigned int base_align
, int room
);
130 /* TYPE is a RECORD_TYPE, UNION_TYPE or QUAL_UNION_TYPE that is being used
131 as the field type of a packed record if IN_RECORD is true, or as the
132 component type of a packed array if IN_RECORD is false. See if we can
133 rewrite it either as a type that has a non-BLKmode, which we can pack
134 tighter in the packed record case, or as a smaller type. If so, return
135 the new type. If not, return the original type. */
136 extern tree
make_packable_type (tree type
, bool in_record
);
138 /* Given a type TYPE, return a new type whose size is appropriate for SIZE.
139 If TYPE is the best type, return it. Otherwise, make a new type. We
140 only support new integral and pointer types. FOR_BIASED is true if
141 we are making a biased type. */
142 extern tree
make_type_from_size (tree type
, tree size_tree
, bool for_biased
);
144 /* Ensure that TYPE has SIZE and ALIGN. Make and return a new padded type
145 if needed. We have already verified that SIZE and TYPE are large enough.
146 GNAT_ENTITY is used to name the resulting record and to issue a warning.
147 IS_COMPONENT_TYPE is true if this is being done for the component type of
148 an array. IS_USER_TYPE is true if the original type needs to be completed.
149 DEFINITION is true if this type is being defined. SET_RM_SIZE is true if
150 the RM size of the resulting type is to be set to SIZE too. */
151 extern tree
maybe_pad_type (tree type
, tree size
, unsigned int align
,
152 Entity_Id gnat_entity
, bool is_component_type
,
153 bool is_user_type
, bool definition
,
163 /* Relate the alias sets of GNU_NEW_TYPE and GNU_OLD_TYPE according to OP.
164 If this is a multi-dimensional array type, do this recursively.
167 - ALIAS_SET_COPY: the new set is made a copy of the old one.
168 - ALIAS_SET_SUPERSET: the new set is made a superset of the old one.
169 - ALIAS_SET_SUBSET: the new set is made a subset of the old one. */
170 extern void relate_alias_sets (tree gnu_new_type
, tree gnu_old_type
,
171 enum alias_set_op op
);
173 /* Given a GNU tree and a GNAT list of choices, generate an expression to test
174 the value passed against the list of choices. */
175 extern tree
choices_to_gnu (tree operand
, Node_Id choices
);
177 /* Given GNAT_ENTITY, an object (constant, variable, parameter, exception)
178 and GNU_TYPE, its corresponding GCC type, set Esize and Alignment to the
179 size and alignment used by Gigi. Prefer SIZE over TYPE_SIZE if non-null.
180 BY_REF is true if the object is used by reference. */
181 extern void annotate_object (Entity_Id gnat_entity
, tree gnu_type
, tree size
,
184 /* Return the variant part of RECORD_TYPE, if any. Otherwise return NULL. */
185 extern tree
get_variant_part (tree record_type
);
187 /* Given a type T, a FIELD_DECL F, and a replacement value R, return a new
188 type with all size expressions that contain F updated by replacing F
189 with R. If F is NULL_TREE, always make a new RECORD_TYPE, even if
190 nothing has changed. */
191 extern tree
substitute_in_type (tree t
, tree f
, tree r
);
193 /* Return the RM size of GNU_TYPE. This is the actual number of bits
194 needed to represent the object. */
195 extern tree
rm_size (tree gnu_type
);
197 /* Return the name to be used for GNAT_ENTITY. If a type, create a
198 fully-qualified name, possibly with type information encoding.
199 Otherwise, return the name. */
200 extern tree
get_entity_name (Entity_Id gnat_entity
);
202 /* Return an identifier representing the external name to be used for
203 GNAT_ENTITY. If SUFFIX is specified, the name is followed by "___"
204 and the specified suffix. */
205 extern tree
create_concat_name (Entity_Id gnat_entity
, const char *suffix
);
207 /* Given GNU_NAME, an IDENTIFIER_NODE containing a name and SUFFIX, a
208 string, return a new IDENTIFIER_NODE that is the concatenation of
209 the name followed by "___" and the specified suffix. */
210 extern tree
concat_name (tree gnu_name
, const char *suffix
);
212 /* Highest number in the front-end node table. */
213 extern int max_gnat_nodes
;
215 /* Current node being treated, in case abort called. */
216 extern Node_Id error_gnat_node
;
218 /* True when gigi is being called on an analyzed but unexpanded
219 tree, and the only purpose of the call is to properly annotate
220 types with representation information. */
221 extern bool type_annotate_only
;
223 /* Current file name without path. */
224 extern const char *ref_filename
;
226 /* This structure must be kept synchronized with Call_Back_End. */
227 struct File_Info_Type
229 File_Name_Type File_Name
;
230 Instance_Id Instance
;
231 Nat Num_Source_Lines
;
238 /* This is the main program of the back-end. It sets up all the table
239 structures and then generates code. */
240 extern void gigi (Node_Id gnat_root
, int max_gnat_node
,
241 int number_name ATTRIBUTE_UNUSED
,
242 struct Node
*nodes_ptr
, Node_Id
*next_node_ptr
,
243 Node_Id
*prev_node_ptr
, struct Elist_Header
*elists_ptr
,
244 struct Elmt_Item
*elmts_ptr
,
245 struct String_Entry
*strings_ptr
,
246 Char_Code
*strings_chars_ptr
,
247 struct List_Header
*list_headers_ptr
,
249 struct File_Info_Type
*file_info_ptr
,
250 Entity_Id standard_boolean
,
251 Entity_Id standard_integer
,
252 Entity_Id standard_character
,
253 Entity_Id standard_long_long_float
,
254 Entity_Id standard_exception_type
,
255 Int gigi_operating_mode
);
261 /* GNAT_NODE is the root of some GNAT tree. Return the root of the
262 GCC tree corresponding to that GNAT tree. Normally, no code is generated;
263 we just return an equivalent tree which is used elsewhere to generate
265 extern tree
gnat_to_gnu (Node_Id gnat_node
);
267 /* GNU_STMT is a statement. We generate code for that statement. */
268 extern void gnat_expand_stmt (tree gnu_stmt
);
270 /* Generate GIMPLE in place for the expression at *EXPR_P. */
271 extern int gnat_gimplify_expr (tree
*expr_p
, gimple_seq
*pre_p
,
272 gimple_seq
*post_p ATTRIBUTE_UNUSED
);
274 /* Do the processing for the declaration of a GNAT_ENTITY, a type. If
275 a separate Freeze node exists, delay the bulk of the processing. Otherwise
276 make a GCC type for GNAT_ENTITY and set up the correspondence. */
277 extern void process_type (Entity_Id gnat_entity
);
279 /* Convert SLOC into LOCUS. Return true if SLOC corresponds to a source code
280 location and false if it doesn't. In the former case, set the Gigi global
281 variable REF_FILENAME to the simple debug file name as given by sinput. */
282 extern bool Sloc_to_locus (Source_Ptr Sloc
, location_t
*locus
);
284 /* Post an error message. MSG is the error message, properly annotated.
285 NODE is the node at which to post the error and the node to use for the
287 extern void post_error (const char *msg
, Node_Id node
);
289 /* Similar to post_error, but NODE is the node at which to post the error and
290 ENT is the node to use for the '&' substitution. */
291 extern void post_error_ne (const char *msg
, Node_Id node
, Entity_Id ent
);
293 /* Similar to post_error_ne, but NUM is the number to use for the '^'. */
294 extern void post_error_ne_num (const char *msg
, Node_Id node
, Entity_Id ent
,
297 /* Similar to post_error_ne, but T is a GCC tree representing the number to
298 write. If T represents a constant, the text inside curly brackets in
299 MSG will be output (presumably including a '^'). Otherwise it will not
300 be output and the text inside square brackets will be output instead. */
301 extern void post_error_ne_tree (const char *msg
, Node_Id node
, Entity_Id ent
,
304 /* Similar to post_error_ne_tree, but NUM is a second integer to write. */
305 extern void post_error_ne_tree_2 (const char *msg
, Node_Id node
, Entity_Id ent
,
308 /* Return a label to branch to for the exception type in KIND or NULL_TREE
310 extern tree
get_exception_label (char kind
);
312 /* Return the decl for the current elaboration procedure. */
313 extern tree
get_elaboration_procedure (void);
315 /* If nonzero, pretend we are allocating at global level. */
316 extern int force_global
;
318 /* The default alignment of "double" floating-point types, i.e. floating
319 point types whose size is equal to 64 bits, or 0 if this alignment is
320 not specifically capped. */
321 extern int double_float_alignment
;
323 /* The default alignment of "double" or larger scalar types, i.e. scalar
324 types whose size is greater or equal to 64 bits, or 0 if this alignment
325 is not specifically capped. */
326 extern int double_scalar_alignment
;
328 /* Data structures used to represent attributes. */
332 ATTR_MACHINE_ATTRIBUTE
,
335 ATTR_LINK_CONSTRUCTOR
,
336 ATTR_LINK_DESTRUCTOR
,
337 ATTR_THREAD_LOCAL_STORAGE
,
350 /* Table of machine-independent internal attributes. */
351 extern const struct attribute_spec gnat_internal_attribute_table
[];
353 /* Define the entries in the standard data array. */
354 enum standard_datatypes
356 /* The longest floating-point type. */
357 ADT_longest_float_type
,
359 /* The type of an exception. */
362 /* Type declaration node <==> typedef void *T */
365 /* Function type declaration -- void T() */
368 /* Type declaration node <==> typedef void *T() */
371 /* Type declaration node <==> typedef virtual void *T() */
374 /* Null pointer for above type. */
377 /* Value 1 in signed bitsizetype. */
378 ADT_sbitsize_one_node
,
380 /* Value BITS_PER_UNIT in signed bitsizetype. */
381 ADT_sbitsize_unit_node
,
383 /* Function declaration nodes for run-time functions for allocating memory.
384 Ada allocators cause calls to these functions to be generated. Malloc32
385 is used only on 64bit systems needing to allocate 32bit memory. */
389 /* Likewise for freeing memory. */
392 /* Function decl node for 64-bit multiplication with overflow checking. */
395 /* Identifier for the name of the _Parent field in tagged record types. */
398 /* Identifier for the name of the Exception_Data type. */
399 ADT_exception_data_name_id
,
401 /* Types and decls used by our temporary exception mechanism. See
402 init_gigi_decls for details. */
410 ADT_update_setjmp_buf_decl
,
411 ADT_raise_nodefer_decl
,
412 ADT_reraise_zcx_decl
,
413 ADT_begin_handler_decl
,
414 ADT_end_handler_decl
,
415 ADT_unhandled_except_decl
,
418 ADT_unhandled_others_decl
,
421 /* Define kind of exception information associated with raise statements. */
422 enum exception_info_kind
424 /* Simple exception information: file:line. */
426 /* Range exception information: file:line + index, first, last. */
428 /* Column exception information: file:line:column. */
432 extern GTY(()) tree gnat_std_decls
[(int) ADT_LAST
];
433 extern GTY(()) tree gnat_raise_decls
[(int) LAST_REASON_CODE
+ 1];
434 extern GTY(()) tree gnat_raise_decls_ext
[(int) LAST_REASON_CODE
+ 1];
436 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
437 #define except_type_node gnat_std_decls[(int) ADT_except_type]
438 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
439 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
440 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
441 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
442 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
443 #define sbitsize_one_node gnat_std_decls[(int) ADT_sbitsize_one_node]
444 #define sbitsize_unit_node gnat_std_decls[(int) ADT_sbitsize_unit_node]
445 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
446 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
447 #define free_decl gnat_std_decls[(int) ADT_free_decl]
448 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
449 #define parent_name_id gnat_std_decls[(int) ADT_parent_name_id]
450 #define exception_data_name_id gnat_std_decls[(int) ADT_exception_data_name_id]
451 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
452 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
453 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
454 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
455 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
456 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
457 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
458 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
459 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
460 #define reraise_zcx_decl gnat_std_decls[(int) ADT_reraise_zcx_decl]
461 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
462 #define others_decl gnat_std_decls[(int) ADT_others_decl]
463 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
464 #define unhandled_others_decl gnat_std_decls[(int) ADT_unhandled_others_decl]
465 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
466 #define unhandled_except_decl gnat_std_decls[(int) ADT_unhandled_except_decl]
468 /* Routines expected by the gcc back-end. They must have exactly the same
469 prototype and names as below. */
471 /* Return true if we are in the global binding level. */
472 extern bool global_bindings_p (void);
474 /* Enter and exit a new binding level. */
475 extern void gnat_pushlevel (void);
476 extern void gnat_poplevel (void);
477 extern void gnat_zaplevel (void);
479 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
480 and point FNDECL to this BLOCK. */
481 extern void set_current_block_context (tree fndecl
);
483 /* Set the jmpbuf_decl for the current binding level to DECL. */
484 extern void set_block_jmpbuf_decl (tree decl
);
486 /* Get the setjmp_decl, if any, for the current binding level. */
487 extern tree
get_block_jmpbuf_decl (void);
489 /* Record DECL as belonging to the current lexical scope and use GNAT_NODE
490 for location information and flag propagation. */
491 extern void gnat_pushdecl (tree decl
, Node_Id gnat_node
);
493 extern void gnat_init_gcc_eh (void);
494 extern void gnat_install_builtins (void);
496 /* Return an integer type with the number of bits of precision given by
497 PRECISION. UNSIGNEDP is nonzero if the type is unsigned; otherwise
498 it is a signed type. */
499 extern tree
gnat_type_for_size (unsigned precision
, int unsignedp
);
501 /* Return a data type that has machine mode MODE. UNSIGNEDP selects
502 an unsigned type; otherwise a signed type is returned. */
503 extern tree
gnat_type_for_mode (enum machine_mode mode
, int unsignedp
);
505 /* Emit debug info for all global variable declarations. */
506 extern void gnat_write_global_declarations (void);
508 /* Return the unsigned version of a TYPE_NODE, a scalar type. */
509 extern tree
gnat_unsigned_type (tree type_node
);
511 /* Return the signed version of a TYPE_NODE, a scalar type. */
512 extern tree
gnat_signed_type (tree type_node
);
514 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
515 transparently converted to each other. */
516 extern int gnat_types_compatible_p (tree t1
, tree t2
);
518 /* Return true if EXPR is a useless type conversion. */
519 extern bool gnat_useless_type_conversion (tree expr
);
521 /* Return true if T, a FUNCTION_TYPE, has the specified list of flags. */
522 extern bool fntype_same_flags_p (const_tree
, tree
, bool, bool, bool);
524 /* Create an expression whose value is that of EXPR,
525 converted to type TYPE. The TREE_TYPE of the value
526 is always TYPE. This function implements all reasonable
527 conversions; callers should filter out those that are
528 not permitted by the language being compiled. */
529 extern tree
convert (tree type
, tree expr
);
531 /* Create an expression whose value is that of EXPR converted to the common
532 index type, which is sizetype. */
533 extern tree
convert_to_index_type (tree expr
);
535 /* Routines created solely for the tree translator's sake. Their prototypes
536 can be changed as desired. */
538 /* Initialize data structures of the utils.c module. */
539 extern void init_gnat_utils (void);
541 /* Destroy data structures of the utils.c module. */
542 extern void destroy_gnat_utils (void);
544 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
545 GNU_DECL is the GCC tree which is to be associated with
546 GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
547 If NO_CHECK is nonzero, the latter check is suppressed.
548 If GNU_DECL is zero, a previous association is to be reset. */
549 extern void save_gnu_tree (Entity_Id gnat_entity
, tree gnu_decl
,
552 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
553 Return the ..._DECL node that was associated with it. If there is no tree
554 node associated with GNAT_ENTITY, abort. */
555 extern tree
get_gnu_tree (Entity_Id gnat_entity
);
557 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY. */
558 extern bool present_gnu_tree (Entity_Id gnat_entity
);
560 /* Make a dummy type corresponding to GNAT_TYPE. */
561 extern tree
make_dummy_type (Entity_Id gnat_type
);
563 /* Return the dummy type that was made for GNAT_TYPE, if any. */
564 extern tree
get_dummy_type (Entity_Id gnat_type
);
566 /* Build dummy fat and thin pointer types whose designated type is specified
567 by GNAT_DESIG_TYPE/GNU_DESIG_TYPE and attach them to the latter. */
568 extern void build_dummy_unc_pointer_types (Entity_Id gnat_desig_type
,
569 tree gnu_desig_type
);
571 /* Record TYPE as a builtin type for Ada. NAME is the name of the type.
572 ARTIFICIAL_P is true if it's a type that was generated by the compiler. */
573 extern void record_builtin_type (const char *name
, tree type
,
576 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
577 finish constructing the record type as a fat pointer type. */
578 extern void finish_fat_pointer_type (tree record_type
, tree field_list
);
580 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
581 finish constructing the record or union type. If REP_LEVEL is zero, this
582 record has no representation clause and so will be entirely laid out here.
583 If REP_LEVEL is one, this record has a representation clause and has been
584 laid out already; only set the sizes and alignment. If REP_LEVEL is two,
585 this record is derived from a parent record and thus inherits its layout;
586 only make a pass on the fields to finalize them. DEBUG_INFO_P is true if
587 we need to write debug information about this type. */
588 extern void finish_record_type (tree record_type
, tree field_list
,
589 int rep_level
, bool debug_info_p
);
591 /* Wrap up compilation of RECORD_TYPE, i.e. output all the debug information
592 associated with it. It need not be invoked directly in most cases since
593 finish_record_type takes care of doing so, but this can be necessary if
594 a parallel type is to be attached to the record type. */
595 extern void rest_of_record_type_compilation (tree record_type
);
597 /* Append PARALLEL_TYPE on the chain of parallel types for TYPE. */
598 extern void add_parallel_type (tree type
, tree parallel_type
);
600 /* Return a FUNCTION_TYPE node. RETURN_TYPE is the type returned by the
601 subprogram. If it is VOID_TYPE, then we are dealing with a procedure,
602 otherwise we are dealing with a function. PARAM_DECL_LIST is a list of
603 PARM_DECL nodes that are the subprogram parameters. CICO_LIST is the
604 copy-in/copy-out list to be stored into the TYPE_CICO_LIST field.
605 RETURN_UNCONSTRAINED_P is true if the function returns an unconstrained
606 object. RETURN_BY_DIRECT_REF_P is true if the function returns by direct
607 reference. RETURN_BY_INVISI_REF_P is true if the function returns by
608 invisible reference. */
609 extern tree
create_subprog_type (tree return_type
, tree param_decl_list
,
610 tree cico_list
, bool return_unconstrained_p
,
611 bool return_by_direct_ref_p
,
612 bool return_by_invisi_ref_p
);
614 /* Return a copy of TYPE, but safe to modify in any way. */
615 extern tree
copy_type (tree type
);
617 /* Return a subtype of sizetype with range MIN to MAX and whose
618 TYPE_INDEX_TYPE is INDEX. GNAT_NODE is used for the position
619 of the associated TYPE_DECL. */
620 extern tree
create_index_type (tree min
, tree max
, tree index
,
623 /* Return a subtype of TYPE with range MIN to MAX. If TYPE is NULL,
625 extern tree
create_range_type (tree type
, tree min
, tree max
);
627 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
628 TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
630 extern tree
create_type_stub_decl (tree type_name
, tree type
);
632 /* Return a TYPE_DECL node. TYPE_NAME gives the name of the type and TYPE
633 is a ..._TYPE node giving its data type. ARTIFICIAL_P is true if this
634 is a declaration that was generated by the compiler. DEBUG_INFO_P is
635 true if we need to write debug information about this type. GNAT_NODE
636 is used for the position of the decl. */
637 extern tree
create_type_decl (tree type_name
, tree type
,
638 struct attrib
*attr_list
,
639 bool artificial_p
, bool debug_info_p
,
642 /* Return a VAR_DECL or CONST_DECL node.
644 VAR_NAME gives the name of the variable. ASM_NAME is its assembler name
645 (if provided). TYPE is its data type (a GCC ..._TYPE node). VAR_INIT is
646 the GCC tree for an optional initial expression; NULL_TREE if none.
648 CONST_FLAG is true if this variable is constant, in which case we might
649 return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
651 PUBLIC_FLAG is true if this definition is to be made visible outside of
652 the current compilation unit. This flag should be set when processing the
653 variable definitions in a package specification.
655 EXTERN_FLAG is nonzero when processing an external variable declaration (as
656 opposed to a definition: no storage is to be allocated for the variable).
658 STATIC_FLAG is only relevant when not at top level. In that case
659 it indicates whether to always allocate storage to the variable.
661 GNAT_NODE is used for the position of the decl. */
663 create_var_decl_1 (tree var_name
, tree asm_name
, tree type
, tree var_init
,
664 bool const_flag
, bool public_flag
, bool extern_flag
,
665 bool static_flag
, bool const_decl_allowed_p
,
666 struct attrib
*attr_list
, Node_Id gnat_node
);
668 /* Wrapper around create_var_decl_1 for cases where we don't care whether
669 a VAR or a CONST decl node is created. */
670 #define create_var_decl(var_name, asm_name, type, var_init, \
671 const_flag, public_flag, extern_flag, \
672 static_flag, attr_list, gnat_node) \
673 create_var_decl_1 (var_name, asm_name, type, var_init, \
674 const_flag, public_flag, extern_flag, \
675 static_flag, true, attr_list, gnat_node)
677 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
678 required. The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
679 must be VAR_DECLs and on which we want TREE_READONLY set to have them
680 possibly assigned to a readonly data section. */
681 #define create_true_var_decl(var_name, asm_name, type, var_init, \
682 const_flag, public_flag, extern_flag, \
683 static_flag, attr_list, gnat_node) \
684 create_var_decl_1 (var_name, asm_name, type, var_init, \
685 const_flag, public_flag, extern_flag, \
686 static_flag, false, attr_list, gnat_node)
688 /* Record DECL as a global renaming pointer. */
689 extern void record_global_renaming_pointer (tree decl
);
691 /* Invalidate the global renaming pointers. */
692 extern void invalidate_global_renaming_pointers (void);
694 /* Return a FIELD_DECL node. FIELD_NAME is the field's name, FIELD_TYPE is
695 its type and RECORD_TYPE is the type of the enclosing record. If SIZE is
696 nonzero, it is the specified size of the field. If POS is nonzero, it is
697 the bit position. PACKED is 1 if the enclosing record is packed, -1 if it
698 has Component_Alignment of Storage_Unit. If ADDRESSABLE is nonzero, it
699 means we are allowed to take the address of the field; if it is negative,
700 we should not make a bitfield, which is used by make_aligning_type. */
701 extern tree
create_field_decl (tree field_name
, tree field_type
,
702 tree record_type
, tree size
, tree pos
,
703 int packed
, int addressable
);
705 /* Return a PARM_DECL node. PARAM_NAME is the name of the parameter and
706 PARAM_TYPE is its type. READONLY is true if the parameter is readonly
707 (either an In parameter or an address of a pass-by-ref parameter). */
708 extern tree
create_param_decl (tree param_name
, tree param_type
,
711 /* Return a LABEL_DECL with LABEL_NAME. GNAT_NODE is used for the position
713 extern tree
create_label_decl (tree
, Node_Id
);
715 /* Return a FUNCTION_DECL node. SUBPROG_NAME is the name of the subprogram,
716 ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
717 node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
718 PARM_DECL nodes chained through the DECL_CHAIN field).
720 INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, ARTIFICIAL_FLAG and ATTR_LIST are
721 used to set the appropriate fields in the FUNCTION_DECL. GNAT_NODE is
722 used for the position of the decl. */
723 extern tree
create_subprog_decl (tree subprog_name
, tree asm_name
,
724 tree subprog_type
, tree param_decl_list
,
725 bool inline_flag
, bool public_flag
,
726 bool extern_flag
, bool artificial_flag
,
727 struct attrib
*attr_list
, Node_Id gnat_node
);
729 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
730 body. This routine needs to be invoked before processing the declarations
731 appearing in the subprogram. */
732 extern void begin_subprog_body (tree subprog_decl
);
734 /* Finish translating the current subprogram and set its BODY. */
735 extern void end_subprog_body (tree body
);
737 /* Wrap up compilation of SUBPROG_DECL, a subprogram body. */
738 extern void rest_of_subprog_body_compilation (tree subprog_decl
);
740 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
741 EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
742 Return a constructor for the template. */
743 extern tree
build_template (tree template_type
, tree array_type
, tree expr
);
745 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
746 a descriptor type, and the GCC type of an object. Each FIELD_DECL
747 in the type contains in its DECL_INITIAL the expression to use when
748 a constructor is made for the type. GNAT_ENTITY is a gnat node used
749 to print out an error message if the mechanism cannot be applied to
750 an object of that type and also for the name. */
751 extern tree
build_vms_descriptor (tree type
, Mechanism_Type mech
,
752 Entity_Id gnat_entity
);
754 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above. */
755 extern tree
build_vms_descriptor32 (tree type
, Mechanism_Type mech
,
756 Entity_Id gnat_entity
);
758 /* Build a type to be used to represent an aliased object whose nominal type
759 is an unconstrained array. This consists of a RECORD_TYPE containing a
760 field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an ARRAY_TYPE.
761 If ARRAY_TYPE is that of an unconstrained array, this is used to represent
762 an arbitrary unconstrained object. Use NAME as the name of the record.
763 DEBUG_INFO_P is true if we need to write debug information for the type. */
764 extern tree
build_unc_object_type (tree template_type
, tree object_type
,
765 tree name
, bool debug_info_p
);
767 /* Same as build_unc_object_type, but taking a thin or fat pointer type
768 instead of the template type. */
769 extern tree
build_unc_object_type_from_ptr (tree thin_fat_ptr_type
,
770 tree object_type
, tree name
,
773 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE. In
774 the normal case this is just two adjustments, but we have more to do
775 if NEW is an UNCONSTRAINED_ARRAY_TYPE. */
776 extern void update_pointer_to (tree old_type
, tree new_type
);
778 /* EXP is an expression for the size of an object. If this size contains
779 discriminant references, replace them with the maximum (if MAX_P) or
780 minimum (if !MAX_P) possible value of the discriminant. */
781 extern tree
max_size (tree exp
, bool max_p
);
783 /* Remove all conversions that are done in EXP. This includes converting
784 from a padded type or to a left-justified modular type. If TRUE_ADDRESS
785 is true, always return the address of the containing object even if
786 the address is not bit-aligned. */
787 extern tree
remove_conversions (tree exp
, bool true_address
);
789 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
790 refers to the underlying array. If its type has TYPE_CONTAINS_TEMPLATE_P,
791 likewise return an expression pointing to the underlying array. */
792 extern tree
maybe_unconstrained_array (tree exp
);
794 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
795 If NOTRUNC_P is true, truncation operations should be suppressed. */
796 extern tree
unchecked_convert (tree type
, tree expr
, bool notrunc_p
);
798 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
799 the latter being a record type as predicated by Is_Record_Type. */
800 extern enum tree_code
tree_code_for_record_type (Entity_Id gnat_type
);
802 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
803 size is equal to 64 bits, or an array of such a type. Set ALIGN_CLAUSE
804 according to the presence of an alignment clause on the type or, if it
805 is an array, on the component type. */
806 extern bool is_double_float_or_array (Entity_Id gnat_type
,
809 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
810 size is greater or equal to 64 bits, or an array of such a type. Set
811 ALIGN_CLAUSE according to the presence of an alignment clause on the
812 type or, if it is an array, on the component type. */
813 extern bool is_double_scalar_or_array (Entity_Id gnat_type
,
816 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
817 component of an aggregate type. */
818 extern bool type_for_nonaliased_component_p (tree gnu_type
);
820 /* Return true if TYPE is a smaller form of ORIG_TYPE. */
821 extern bool smaller_form_type_p (tree type
, tree orig_type
);
823 /* Return the base type of TYPE. */
824 extern tree
get_base_type (tree type
);
826 /* EXP is a GCC tree representing an address. See if we can find how
827 strictly the object at that address is aligned. Return that alignment
828 strictly the object at that address is aligned. Return that alignment
829 in bits. If we don't know anything about the alignment, return 0. */
830 extern unsigned int known_alignment (tree exp
);
832 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
834 extern bool value_factor_p (tree value
, HOST_WIDE_INT factor
);
836 /* Build an atomic load for the underlying atomic object in SRC. */
837 extern tree
build_atomic_load (tree src
);
839 /* Build an atomic store from SRC to the underlying atomic object in DEST. */
840 extern tree
build_atomic_store (tree dest
, tree src
);
842 /* Make a binary operation of kind OP_CODE. RESULT_TYPE is the type
843 desired for the result. Usually the operation is to be performed
844 in that type. For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
845 in which case the type to be used will be derived from the operands. */
846 extern tree
build_binary_op (enum tree_code op_code
, tree result_type
,
847 tree left_operand
, tree right_operand
);
849 /* Similar, but make unary operation. */
850 extern tree
build_unary_op (enum tree_code op_code
, tree result_type
,
853 /* Similar, but for COND_EXPR. */
854 extern tree
build_cond_expr (tree result_type
, tree condition_operand
,
855 tree true_operand
, tree false_operand
);
857 /* Similar, but for COMPOUND_EXPR. */
858 extern tree
build_compound_expr (tree result_type
, tree stmt_operand
,
861 /* Conveniently construct a function call expression. FNDECL names the
862 function to be called, N is the number of arguments, and the "..."
863 parameters are the argument expressions. Unlike build_call_expr
864 this doesn't fold the call, hence it will always return a CALL_EXPR. */
865 extern tree
build_call_n_expr (tree fndecl
, int n
, ...);
867 /* Call a function that raises an exception and pass the line number and file
868 name, if requested. MSG says which exception function to call.
870 GNAT_NODE is the gnat node conveying the source location for which the
871 error should be signaled, or Empty in which case the error is signaled on
872 the current ref_file_name/input_line.
874 KIND says which kind of exception this is for
875 (N_Raise_{Constraint,Storage,Program}_Error). */
876 extern tree
build_call_raise (int msg
, Node_Id gnat_node
, char kind
);
878 /* Similar to build_call_raise, for an index or range check exception as
879 determined by MSG, with extra information generated of the form
880 "INDEX out of range FIRST..LAST". */
881 extern tree
build_call_raise_range (int msg
, Node_Id gnat_node
,
882 tree index
, tree first
, tree last
);
884 /* Similar to build_call_raise, with extra information about the column
885 where the check failed. */
886 extern tree
build_call_raise_column (int msg
, Node_Id gnat_node
);
888 /* Return a CONSTRUCTOR of TYPE whose elements are V. This is not the
889 same as build_constructor in the language-independent tree.c. */
890 extern tree
gnat_build_constructor (tree type
, vec
<constructor_elt
, va_gc
> *v
);
892 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
893 an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
894 for the field, or both. Don't fold the result if NO_FOLD_P. */
895 extern tree
build_component_ref (tree record_variable
, tree component
,
896 tree field
, bool no_fold_p
);
898 /* Build a GCC tree to call an allocation or deallocation function.
899 If GNU_OBJ is nonzero, it is an object to deallocate. Otherwise,
900 generate an allocator.
902 GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
903 object type, used to determine the to-be-honored address alignment.
904 GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
905 pool to use. If not present, malloc and free are used. GNAT_NODE is used
906 to provide an error location for restriction violation messages. */
907 extern tree
build_call_alloc_dealloc (tree gnu_obj
, tree gnu_size
,
908 tree gnu_type
, Entity_Id gnat_proc
,
909 Entity_Id gnat_pool
, Node_Id gnat_node
);
911 /* Build a GCC tree to correspond to allocating an object of TYPE whose
912 initial value if INIT, if INIT is nonzero. Convert the expression to
913 RESULT_TYPE, which must be some type of pointer. Return the tree.
915 GNAT_PROC and GNAT_POOL optionally give the procedure to call and
916 the storage pool to use. GNAT_NODE is used to provide an error
917 location for restriction violation messages. If IGNORE_INIT_TYPE is
918 true, ignore the type of INIT for the purpose of determining the size;
919 this will cause the maximum size to be allocated if TYPE is of
920 self-referential size. */
921 extern tree
build_allocator (tree type
, tree init
, tree result_type
,
922 Entity_Id gnat_proc
, Entity_Id gnat_pool
,
923 Node_Id gnat_node
, bool);
925 /* Fill in a VMS descriptor of GNU_TYPE for GNU_EXPR and return the result.
926 GNAT_ACTUAL is the actual parameter for which the descriptor is built. */
927 extern tree
fill_vms_descriptor (tree gnu_type
, tree gnu_expr
,
928 Node_Id gnat_actual
);
930 /* Convert GNU_EXPR, a pointer to a VMS descriptor, to GNU_TYPE, a regular
931 pointer or fat pointer type. GNU_EXPR_ALT_TYPE is the alternate (32-bit)
932 pointer type of GNU_EXPR. GNAT_SUBPROG is the subprogram to which the
933 descriptor is passed. */
934 extern tree
convert_vms_descriptor (tree gnu_type
, tree gnu_expr
,
935 tree gnu_expr_alt_type
,
936 Entity_Id gnat_subprog
);
938 /* Indicate that we need to take the address of T and that it therefore
939 should not be allocated in a register. Returns true if successful. */
940 extern bool gnat_mark_addressable (tree t
);
942 /* Save EXP for later use or reuse. This is equivalent to save_expr in tree.c
943 but we know how to handle our own nodes. */
944 extern tree
gnat_save_expr (tree exp
);
946 /* Protect EXP for immediate reuse. This is a variant of gnat_save_expr that
947 is optimized under the assumption that EXP's value doesn't change before
948 its subsequent reuse(s) except through its potential reevaluation. */
949 extern tree
gnat_protect_expr (tree exp
);
951 /* This is equivalent to stabilize_reference in tree.c but we know how to
952 handle our own nodes and we take extra arguments. FORCE says whether to
953 force evaluation of everything. We set SUCCESS to true unless we walk
954 through something we don't know how to stabilize. */
955 extern tree
gnat_stabilize_reference (tree ref
, bool force
, bool *success
);
957 /* If EXPR is an expression that is invariant in the current function, in the
958 sense that it can be evaluated anywhere in the function and any number of
959 times, return EXPR or an equivalent expression. Otherwise return NULL. */
960 extern tree
gnat_invariant_expr (tree expr
);
962 /* Implementation of the builtin_function langhook. */
963 extern tree
gnat_builtin_function (tree decl
);
965 /* Search the chain of currently reachable declarations for a builtin
966 FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
967 Return the first node found, if any, or NULL_TREE otherwise. */
968 extern tree
builtin_decl_for (tree name
);
970 /* GNU_TYPE is a type. Determine if it should be passed by reference by
972 extern bool default_pass_by_ref (tree gnu_type
);
974 /* GNU_TYPE is the type of a subprogram parameter. Determine from the type
975 if it should be passed by reference. */
976 extern bool must_pass_by_ref (tree gnu_type
);
978 /* Return the size of the FP mode with precision PREC. */
979 extern int fp_prec_to_size (int prec
);
981 /* Return the precision of the FP mode with size SIZE. */
982 extern int fp_size_to_prec (int size
);
988 /* These functions return the basic data type sizes and related parameters
989 about the target machine. */
990 extern Pos
get_target_bits_per_unit (void);
991 extern Pos
get_target_bits_per_word (void);
992 extern Pos
get_target_char_size (void);
993 extern Pos
get_target_wchar_t_size (void);
994 extern Pos
get_target_short_size (void);
995 extern Pos
get_target_int_size (void);
996 extern Pos
get_target_long_size (void);
997 extern Pos
get_target_long_long_size (void);
998 extern Pos
get_target_float_size (void);
999 extern Pos
get_target_double_size (void);
1000 extern Pos
get_target_long_double_size (void);
1001 extern Pos
get_target_pointer_size (void);
1002 extern Pos
get_target_maximum_default_alignment (void);
1003 extern Pos
get_target_system_allocator_alignment (void);
1004 extern Pos
get_target_maximum_allowed_alignment (void);
1005 extern Pos
get_target_maximum_alignment (void);
1006 extern Nat
get_float_words_be (void);
1007 extern Nat
get_words_be (void);
1008 extern Nat
get_bytes_be (void);
1009 extern Nat
get_bits_be (void);
1010 extern Nat
get_target_strict_alignment (void);
1011 extern Nat
get_target_double_float_alignment (void);
1012 extern Nat
get_target_double_scalar_alignment (void);
1014 /* This function is called by the front-end to enumerate all the supported
1015 modes for the machine, as well as some predefined C types. */
1016 extern void enumerate_modes (void (*f
) (const char *, int, int, int, int, int,
1023 /* Let code know whether we are targetting VMS without need of
1024 intrusive preprocessor directives. */
1025 #ifndef TARGET_ABI_OPEN_VMS
1026 #define TARGET_ABI_OPEN_VMS 0
1029 /* VMS option set by default, when clear forces 32bit mallocs and 32bit
1030 Descriptors. Always used in combination with TARGET_ABI_OPEN_VMS
1031 so no effect on non-VMS systems. */
1032 #if TARGET_ABI_OPEN_VMS == 0
1033 #define flag_vms_malloc64 0
1036 /* Convenient shortcuts. */
1037 #define VECTOR_TYPE_P(TYPE) (TREE_CODE (TYPE) == VECTOR_TYPE)
1039 /* If EXP's type is a VECTOR_TYPE, return EXP converted to the associated
1040 TYPE_REPRESENTATIVE_ARRAY. */
1043 maybe_vector_array (tree exp
)
1045 tree etype
= TREE_TYPE (exp
);
1047 if (VECTOR_TYPE_P (etype
))
1048 exp
= convert (TYPE_REPRESENTATIVE_ARRAY (etype
), exp
);
1053 static inline unsigned HOST_WIDE_INT
1054 ceil_pow2 (unsigned HOST_WIDE_INT x
)
1056 return (unsigned HOST_WIDE_INT
) 1 << (floor_log2 (x
- 1) + 1);