1 /****************************************************************************
3 * GNAT COMPILER COMPONENTS *
9 * Copyright (C) 1992-2011, 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 statement group. If it is an expression with
61 no effects, it is ignored. */
62 extern void add_stmt (tree gnu_stmt);
64 /* Similar, but the statement is always added, regardless of side-effects. */
65 extern void add_stmt_force (tree gnu_stmt);
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);
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);
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);
78 /* Set the BLOCK node corresponding to the current code group to GNU_BLOCK. */
79 extern void set_block_for_group (tree);
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);
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);
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. */
93 #define MARK_VISITED(EXP) \
95 if((EXP) && !CONSTANT_CLASS_P (EXP)) \
99 /* Finalize the processing of From_With_Type incomplete types. */
100 extern void finalize_from_with_types (void);
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);
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);
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);
118 /* Get the unpadded version of a GNAT type. */
119 extern tree get_unpadded_type (Entity_Id gnat_entity);
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);
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,
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);
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);
153 /* Return the variant part of RECORD_TYPE, if any. Otherwise return NULL. */
154 extern tree get_variant_part (tree record_type);
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);
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);
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);
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);
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);
181 /* Highest number in the front-end node table. */
182 extern int max_gnat_nodes;
184 /* Current node being treated, in case abort called. */
185 extern Node_Id error_gnat_node;
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;
192 /* Current file name without path. */
193 extern const char *ref_filename;
195 /* This structure must be kept synchronized with Call_Back_End. */
196 struct File_Info_Type
198 File_Name_Type File_Name;
199 Nat Num_Source_Lines;
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,
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);
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
233 extern tree gnat_to_gnu (Node_Id gnat_node);
235 /* GNU_STMT is a statement. We generate code for that statement. */
236 extern void gnat_expand_stmt (tree gnu_stmt);
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);
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);
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);
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
255 extern void post_error (const char *msg, Node_Id node);
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);
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,
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,
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,
276 /* Return a label to branch to for the exception type in KIND or NULL_TREE
278 extern tree get_exception_label (char kind);
280 /* Return the decl for the current elaboration procedure. */
281 extern tree get_elaboration_procedure (void);
283 /* If nonzero, pretend we are allocating at global level. */
284 extern int force_global;
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;
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;
296 /* Data structures used to represent attributes. */
300 ATTR_MACHINE_ATTRIBUTE,
303 ATTR_LINK_CONSTRUCTOR,
304 ATTR_LINK_DESTRUCTOR,
305 ATTR_THREAD_LOCAL_STORAGE,
318 /* Table of machine-independent internal attributes. */
319 extern const struct attribute_spec gnat_internal_attribute_table[];
321 /* Define the entries in the standard data array. */
322 enum standard_datatypes
324 /* The longest floating-point type. */
325 ADT_longest_float_type,
327 /* The type of an exception. */
330 /* Type declaration node <==> typedef void *T */
333 /* Function type declaration -- void T() */
336 /* Type declaration node <==> typedef void *T() */
339 /* Type declaration node <==> typedef virtual void *T() */
342 /* Null pointer for above type. */
345 /* Value 1 in signed bitsizetype. */
346 ADT_sbitsize_one_node,
348 /* Value BITS_PER_UNIT in signed bitsizetype. */
349 ADT_sbitsize_unit_node,
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. */
357 /* Likewise for freeing memory. */
360 /* Function decl node for 64-bit multiplication with overflow checking. */
363 /* Identifier for the name of the _Parent field in tagged record types. */
366 /* Identifier for the name of the Exception_Data type. */
367 ADT_exception_data_name_id,
369 /* Types and decls used by our temporary exception mechanism. See
370 init_gigi_decls for details. */
378 ADT_update_setjmp_buf_decl,
379 ADT_raise_nodefer_decl,
380 ADT_reraise_zcx_decl,
381 ADT_begin_handler_decl,
382 ADT_end_handler_decl,
387 /* Define kind of exception information associated with raise statements. */
388 enum exception_info_kind
390 /* Simple exception information: file:line. */
392 /* Range exception information: file:line + index, first, last. */
394 /* Column exception information: file:line:column. */
398 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
399 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
400 extern GTY(()) tree gnat_raise_decls_ext[(int) LAST_REASON_CODE + 1];
402 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
403 #define except_type_node gnat_std_decls[(int) ADT_except_type]
404 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
405 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
406 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
407 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
408 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
409 #define sbitsize_one_node gnat_std_decls[(int) ADT_sbitsize_one_node]
410 #define sbitsize_unit_node gnat_std_decls[(int) ADT_sbitsize_unit_node]
411 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
412 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
413 #define free_decl gnat_std_decls[(int) ADT_free_decl]
414 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
415 #define parent_name_id gnat_std_decls[(int) ADT_parent_name_id]
416 #define exception_data_name_id gnat_std_decls[(int) ADT_exception_data_name_id]
417 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
418 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
419 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
420 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
421 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
422 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
423 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
424 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
425 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
426 #define reraise_zcx_decl gnat_std_decls[(int) ADT_reraise_zcx_decl]
427 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
428 #define others_decl gnat_std_decls[(int) ADT_others_decl]
429 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
430 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
432 /* Routines expected by the gcc back-end. They must have exactly the same
433 prototype and names as below. */
435 /* Return true if we are in the global binding level. */
436 extern bool global_bindings_p (void);
438 /* Enter and exit a new binding level. */
439 extern void gnat_pushlevel (void);
440 extern void gnat_poplevel (void);
441 extern void gnat_zaplevel (void);
443 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
444 and point FNDECL to this BLOCK. */
445 extern void set_current_block_context (tree fndecl);
447 /* Set the jmpbuf_decl for the current binding level to DECL. */
448 extern void set_block_jmpbuf_decl (tree decl);
450 /* Get the setjmp_decl, if any, for the current binding level. */
451 extern tree get_block_jmpbuf_decl (void);
453 /* Records a ..._DECL node DECL as belonging to the current lexical scope
454 and uses GNAT_NODE for location information. */
455 extern void gnat_pushdecl (tree decl, Node_Id gnat_node);
457 extern void gnat_init_gcc_eh (void);
458 extern void gnat_install_builtins (void);
460 /* Return an integer type with the number of bits of precision given by
461 PRECISION. UNSIGNEDP is nonzero if the type is unsigned; otherwise
462 it is a signed type. */
463 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
465 /* Return a data type that has machine mode MODE. UNSIGNEDP selects
466 an unsigned type; otherwise a signed type is returned. */
467 extern tree gnat_type_for_mode (enum machine_mode mode, int unsignedp);
469 /* Emit debug info for all global variable declarations. */
470 extern void gnat_write_global_declarations (void);
472 /* Return the unsigned version of a TYPE_NODE, a scalar type. */
473 extern tree gnat_unsigned_type (tree type_node);
475 /* Return the signed version of a TYPE_NODE, a scalar type. */
476 extern tree gnat_signed_type (tree type_node);
478 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
479 transparently converted to each other. */
480 extern int gnat_types_compatible_p (tree t1, tree t2);
482 /* Return true if T, a FUNCTION_TYPE, has the specified list of flags. */
483 extern bool fntype_same_flags_p (const_tree, tree, bool, bool, bool);
485 /* Create an expression whose value is that of EXPR,
486 converted to type TYPE. The TREE_TYPE of the value
487 is always TYPE. This function implements all reasonable
488 conversions; callers should filter out those that are
489 not permitted by the language being compiled. */
490 extern tree convert (tree type, tree expr);
492 /* Routines created solely for the tree translator's sake. Their prototypes
493 can be changed as desired. */
495 /* Initialize the association of GNAT nodes to GCC trees. */
496 extern void init_gnat_to_gnu (void);
498 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
499 GNU_DECL is the GCC tree which is to be associated with
500 GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
501 If NO_CHECK is nonzero, the latter check is suppressed.
502 If GNU_DECL is zero, a previous association is to be reset. */
503 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
506 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
507 Return the ..._DECL node that was associated with it. If there is no tree
508 node associated with GNAT_ENTITY, abort. */
509 extern tree get_gnu_tree (Entity_Id gnat_entity);
511 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY. */
512 extern bool present_gnu_tree (Entity_Id gnat_entity);
514 /* Initialize the association of GNAT nodes to GCC trees as dummies. */
515 extern void init_dummy_type (void);
517 /* Make a dummy type corresponding to GNAT_TYPE. */
518 extern tree make_dummy_type (Entity_Id gnat_type);
520 /* Return the dummy type that was made for GNAT_TYPE, if any. */
521 extern tree get_dummy_type (Entity_Id gnat_type);
523 /* Build dummy fat and thin pointer types whose designated type is specified
524 by GNAT_DESIG_TYPE/GNU_DESIG_TYPE and attach them to the latter. */
525 extern void build_dummy_unc_pointer_types (Entity_Id gnat_desig_type,
526 tree gnu_desig_type);
528 /* Record TYPE as a builtin type for Ada. NAME is the name of the type.
529 ARTIFICIAL_P is true if it's a type that was generated by the compiler. */
530 extern void record_builtin_type (const char *name, tree type,
533 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
534 finish constructing the record type as a fat pointer type. */
535 extern void finish_fat_pointer_type (tree record_type, tree field_list);
537 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
538 finish constructing the record or union type. If REP_LEVEL is zero, this
539 record has no representation clause and so will be entirely laid out here.
540 If REP_LEVEL is one, this record has a representation clause and has been
541 laid out already; only set the sizes and alignment. If REP_LEVEL is two,
542 this record is derived from a parent record and thus inherits its layout;
543 only make a pass on the fields to finalize them. DEBUG_INFO_P is true if
544 we need to write debug information about this type. */
545 extern void finish_record_type (tree record_type, tree field_list,
546 int rep_level, bool debug_info_p);
548 /* Wrap up compilation of RECORD_TYPE, i.e. output all the debug information
549 associated with it. It need not be invoked directly in most cases since
550 finish_record_type takes care of doing so, but this can be necessary if
551 a parallel type is to be attached to the record type. */
552 extern void rest_of_record_type_compilation (tree record_type);
554 /* Append PARALLEL_TYPE on the chain of parallel types for decl. */
555 extern void add_parallel_type (tree decl, tree parallel_type);
557 /* Return a FUNCTION_TYPE node. RETURN_TYPE is the type returned by the
558 subprogram. If it is VOID_TYPE, then we are dealing with a procedure,
559 otherwise we are dealing with a function. PARAM_DECL_LIST is a list of
560 PARM_DECL nodes that are the subprogram parameters. CICO_LIST is the
561 copy-in/copy-out list to be stored into the TYPE_CICO_LIST field.
562 RETURN_UNCONSTRAINED_P is true if the function returns an unconstrained
563 object. RETURN_BY_DIRECT_REF_P is true if the function returns by direct
564 reference. RETURN_BY_INVISI_REF_P is true if the function returns by
565 invisible reference. */
566 extern tree create_subprog_type (tree return_type, tree param_decl_list,
567 tree cico_list, bool return_unconstrained_p,
568 bool return_by_direct_ref_p,
569 bool return_by_invisi_ref_p);
571 /* Return a copy of TYPE, but safe to modify in any way. */
572 extern tree copy_type (tree type);
574 /* Return a subtype of sizetype with range MIN to MAX and whose
575 TYPE_INDEX_TYPE is INDEX. GNAT_NODE is used for the position
576 of the associated TYPE_DECL. */
577 extern tree create_index_type (tree min, tree max, tree index,
580 /* Return a subtype of TYPE with range MIN to MAX. If TYPE is NULL,
582 extern tree create_range_type (tree type, tree min, tree max);
584 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
585 TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
587 extern tree create_type_stub_decl (tree type_name, tree type);
589 /* Return a TYPE_DECL node. TYPE_NAME gives the name of the type and TYPE
590 is a ..._TYPE node giving its data type. ARTIFICIAL_P is true if this
591 is a declaration that was generated by the compiler. DEBUG_INFO_P is
592 true if we need to write debug information about this type. GNAT_NODE
593 is used for the position of the decl. */
594 extern tree create_type_decl (tree type_name, tree type,
595 struct attrib *attr_list,
596 bool artificial_p, bool debug_info_p,
599 /* Return a VAR_DECL or CONST_DECL node.
601 VAR_NAME gives the name of the variable. ASM_NAME is its assembler name
602 (if provided). TYPE is its data type (a GCC ..._TYPE node). VAR_INIT is
603 the GCC tree for an optional initial expression; NULL_TREE if none.
605 CONST_FLAG is true if this variable is constant, in which case we might
606 return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
608 PUBLIC_FLAG is true if this definition is to be made visible outside of
609 the current compilation unit. This flag should be set when processing the
610 variable definitions in a package specification.
612 EXTERN_FLAG is nonzero when processing an external variable declaration (as
613 opposed to a definition: no storage is to be allocated for the variable).
615 STATIC_FLAG is only relevant when not at top level. In that case
616 it indicates whether to always allocate storage to the variable.
618 GNAT_NODE is used for the position of the decl. */
620 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
621 bool const_flag, bool public_flag, bool extern_flag,
622 bool static_flag, bool const_decl_allowed_p,
623 struct attrib *attr_list, Node_Id gnat_node);
625 /* Wrapper around create_var_decl_1 for cases where we don't care whether
626 a VAR or a CONST decl node is created. */
627 #define create_var_decl(var_name, asm_name, type, var_init, \
628 const_flag, public_flag, extern_flag, \
629 static_flag, attr_list, gnat_node) \
630 create_var_decl_1 (var_name, asm_name, type, var_init, \
631 const_flag, public_flag, extern_flag, \
632 static_flag, true, attr_list, gnat_node)
634 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
635 required. The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
636 must be VAR_DECLs and on which we want TREE_READONLY set to have them
637 possibly assigned to a readonly data section. */
638 #define create_true_var_decl(var_name, asm_name, type, var_init, \
639 const_flag, public_flag, extern_flag, \
640 static_flag, attr_list, gnat_node) \
641 create_var_decl_1 (var_name, asm_name, type, var_init, \
642 const_flag, public_flag, extern_flag, \
643 static_flag, false, attr_list, gnat_node)
645 /* Record DECL as a global renaming pointer. */
646 extern void record_global_renaming_pointer (tree decl);
648 /* Invalidate the global renaming pointers. */
649 extern void invalidate_global_renaming_pointers (void);
651 /* Return a FIELD_DECL node. FIELD_NAME is the field's name, FIELD_TYPE is
652 its type and RECORD_TYPE is the type of the enclosing record. If SIZE is
653 nonzero, it is the specified size of the field. If POS is nonzero, it is
654 the bit position. PACKED is 1 if the enclosing record is packed, -1 if it
655 has Component_Alignment of Storage_Unit. If ADDRESSABLE is nonzero, it
656 means we are allowed to take the address of the field; if it is negative,
657 we should not make a bitfield, which is used by make_aligning_type. */
658 extern tree create_field_decl (tree field_name, tree field_type,
659 tree record_type, tree size, tree pos,
660 int packed, int addressable);
662 /* Return a PARM_DECL node. PARAM_NAME is the name of the parameter and
663 PARAM_TYPE is its type. READONLY is true if the parameter is readonly
664 (either an In parameter or an address of a pass-by-ref parameter). */
665 extern tree create_param_decl (tree param_name, tree param_type,
668 /* Return a LABEL_DECL node for LABEL_NAME. */
669 extern tree create_label_decl (tree label_name);
671 /* Return a FUNCTION_DECL node. SUBPROG_NAME is the name of the subprogram,
672 ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
673 node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
674 PARM_DECL nodes chained through the TREE_CHAIN field).
676 INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, ARTIFICIAL_FLAG and ATTR_LIST are
677 used to set the appropriate fields in the FUNCTION_DECL. GNAT_NODE is
678 used for the position of the decl. */
679 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
680 tree subprog_type, tree param_decl_list,
681 bool inline_flag, bool public_flag,
682 bool extern_flag, bool artificial_flag,
683 struct attrib *attr_list, Node_Id gnat_node);
685 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
686 body. This routine needs to be invoked before processing the declarations
687 appearing in the subprogram. */
688 extern void begin_subprog_body (tree subprog_decl);
690 /* Finish the definition of the current subprogram BODY and finalize it. */
691 extern void end_subprog_body (tree body);
693 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
694 EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
695 Return a constructor for the template. */
696 extern tree build_template (tree template_type, tree array_type, tree expr);
698 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
699 a descriptor type, and the GCC type of an object. Each FIELD_DECL
700 in the type contains in its DECL_INITIAL the expression to use when
701 a constructor is made for the type. GNAT_ENTITY is a gnat node used
702 to print out an error message if the mechanism cannot be applied to
703 an object of that type and also for the name. */
704 extern tree build_vms_descriptor (tree type, Mechanism_Type mech,
705 Entity_Id gnat_entity);
707 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above. */
708 extern tree build_vms_descriptor32 (tree type, Mechanism_Type mech,
709 Entity_Id gnat_entity);
711 /* Build a type to be used to represent an aliased object whose nominal type
712 is an unconstrained array. This consists of a RECORD_TYPE containing a
713 field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an ARRAY_TYPE.
714 If ARRAY_TYPE is that of an unconstrained array, this is used to represent
715 an arbitrary unconstrained object. Use NAME as the name of the record.
716 DEBUG_INFO_P is true if we need to write debug information for the type. */
717 extern tree build_unc_object_type (tree template_type, tree object_type,
718 tree name, bool debug_info_p);
720 /* Same as build_unc_object_type, but taking a thin or fat pointer type
721 instead of the template type. */
722 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
723 tree object_type, tree name,
726 /* Shift the component offsets within an unconstrained object TYPE to make it
727 suitable for use as a designated type for thin pointers. */
728 extern void shift_unc_components_for_thin_pointers (tree type);
730 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE. In
731 the normal case this is just two adjustments, but we have more to do
732 if NEW is an UNCONSTRAINED_ARRAY_TYPE. */
733 extern void update_pointer_to (tree old_type, tree new_type);
735 /* EXP is an expression for the size of an object. If this size contains
736 discriminant references, replace them with the maximum (if MAX_P) or
737 minimum (if !MAX_P) possible value of the discriminant. */
738 extern tree max_size (tree exp, bool max_p);
740 /* Remove all conversions that are done in EXP. This includes converting
741 from a padded type or to a left-justified modular type. If TRUE_ADDRESS
742 is true, always return the address of the containing object even if
743 the address is not bit-aligned. */
744 extern tree remove_conversions (tree exp, bool true_address);
746 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
747 refers to the underlying array. If its type has TYPE_CONTAINS_TEMPLATE_P,
748 likewise return an expression pointing to the underlying array. */
749 extern tree maybe_unconstrained_array (tree exp);
751 /* If EXP's type is a VECTOR_TYPE, return EXP converted to the associated
752 TYPE_REPRESENTATIVE_ARRAY. */
753 extern tree maybe_vector_array (tree exp);
755 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
756 If NOTRUNC_P is true, truncation operations should be suppressed. */
757 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
759 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
760 the latter being a record type as predicated by Is_Record_Type. */
761 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
763 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
764 size is equal to 64 bits, or an array of such a type. Set ALIGN_CLAUSE
765 according to the presence of an alignment clause on the type or, if it
766 is an array, on the component type. */
767 extern bool is_double_float_or_array (Entity_Id gnat_type,
770 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
771 size is greater or equal to 64 bits, or an array of such a type. Set
772 ALIGN_CLAUSE according to the presence of an alignment clause on the
773 type or, if it is an array, on the component type. */
774 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
777 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
778 component of an aggregate type. */
779 extern bool type_for_nonaliased_component_p (tree gnu_type);
781 /* Return true if TYPE is a smaller form of ORIG_TYPE. */
782 extern bool smaller_form_type_p (tree type, tree orig_type);
784 /* Return the base type of TYPE. */
785 extern tree get_base_type (tree type);
787 /* EXP is a GCC tree representing an address. See if we can find how
788 strictly the object at that address is aligned. Return that alignment
789 strictly the object at that address is aligned. Return that alignment
790 in bits. If we don't know anything about the alignment, return 0. */
791 extern unsigned int known_alignment (tree exp);
793 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
795 extern bool value_factor_p (tree value, HOST_WIDE_INT factor);
797 /* Make a binary operation of kind OP_CODE. RESULT_TYPE is the type
798 desired for the result. Usually the operation is to be performed
799 in that type. For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
800 in which case the type to be used will be derived from the operands. */
801 extern tree build_binary_op (enum tree_code op_code, tree result_type,
802 tree left_operand, tree right_operand);
804 /* Similar, but make unary operation. */
805 extern tree build_unary_op (enum tree_code op_code, tree result_type,
808 /* Similar, but for COND_EXPR. */
809 extern tree build_cond_expr (tree result_type, tree condition_operand,
810 tree true_operand, tree false_operand);
812 /* Similar, but for COMPOUND_EXPR. */
813 extern tree build_compound_expr (tree result_type, tree stmt_operand,
816 /* Build a CALL_EXPR to call FUNDECL with one argument, ARG. Return
818 extern tree build_call_1_expr (tree fundecl, tree arg);
820 /* Build a CALL_EXPR to call FUNDECL with two argument, ARG1 & ARG2. Return
822 extern tree build_call_2_expr (tree fundecl, tree arg1, tree arg2);
824 /* Likewise to call FUNDECL with no arguments. */
825 extern tree build_call_0_expr (tree fundecl);
827 /* Call a function that raises an exception and pass the line number and file
828 name, if requested. MSG says which exception function to call.
830 GNAT_NODE is the gnat node conveying the source location for which the
831 error should be signaled, or Empty in which case the error is signaled on
832 the current ref_file_name/input_line.
834 KIND says which kind of exception this is for
835 (N_Raise_{Constraint,Storage,Program}_Error). */
836 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
838 /* Similar to build_call_raise, for an index or range check exception as
839 determined by MSG, with extra information generated of the form
840 "INDEX out of range FIRST..LAST". */
841 extern tree build_call_raise_range (int msg, Node_Id gnat_node,
842 tree index, tree first, tree last);
844 /* Similar to build_call_raise, with extra information about the column
845 where the check failed. */
846 extern tree build_call_raise_column (int msg, Node_Id gnat_node);
848 /* Return a CONSTRUCTOR of TYPE whose elements are V. This is not the
849 same as build_constructor in the language-independent tree.c. */
850 extern tree gnat_build_constructor (tree type, VEC(constructor_elt,gc) *v);
852 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
853 an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
854 for the field, or both. Don't fold the result if NO_FOLD_P. */
855 extern tree build_component_ref (tree record_variable, tree component,
856 tree field, bool no_fold_p);
858 /* Build a GCC tree to call an allocation or deallocation function.
859 If GNU_OBJ is nonzero, it is an object to deallocate. Otherwise,
860 generate an allocator.
862 GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
863 object type, used to determine the to-be-honored address alignment.
864 GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
865 pool to use. If not present, malloc and free are used. GNAT_NODE is used
866 to provide an error location for restriction violation messages. */
867 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
868 tree gnu_type, Entity_Id gnat_proc,
869 Entity_Id gnat_pool, Node_Id gnat_node);
871 /* Build a GCC tree to correspond to allocating an object of TYPE whose
872 initial value if INIT, if INIT is nonzero. Convert the expression to
873 RESULT_TYPE, which must be some type of pointer. Return the tree.
875 GNAT_PROC and GNAT_POOL optionally give the procedure to call and
876 the storage pool to use. GNAT_NODE is used to provide an error
877 location for restriction violation messages. If IGNORE_INIT_TYPE is
878 true, ignore the type of INIT for the purpose of determining the size;
879 this will cause the maximum size to be allocated if TYPE is of
880 self-referential size. */
881 extern tree build_allocator (tree type, tree init, tree result_type,
882 Entity_Id gnat_proc, Entity_Id gnat_pool,
883 Node_Id gnat_node, bool);
885 /* Fill in a VMS descriptor of GNU_TYPE for GNU_EXPR and return the result.
886 GNAT_ACTUAL is the actual parameter for which the descriptor is built. */
887 extern tree fill_vms_descriptor (tree gnu_type, tree gnu_expr,
888 Node_Id gnat_actual);
890 /* Convert GNU_EXPR, a pointer to a VMS descriptor, to GNU_TYPE, a regular
891 pointer or fat pointer type. GNU_EXPR_ALT_TYPE is the alternate (32-bit)
892 pointer type of GNU_EXPR. BY_REF is true if the result is to be used by
893 reference. GNAT_SUBPROG is the subprogram to which the VMS descriptor is
895 extern tree convert_vms_descriptor (tree gnu_type, tree gnu_expr,
896 tree gnu_expr_alt_type, bool by_ref,
897 Entity_Id gnat_subprog);
899 /* Indicate that we need to take the address of T and that it therefore
900 should not be allocated in a register. Returns true if successful. */
901 extern bool gnat_mark_addressable (tree t);
903 /* Save EXP for later use or reuse. This is equivalent to save_expr in tree.c
904 but we know how to handle our own nodes. */
905 extern tree gnat_save_expr (tree exp);
907 /* Protect EXP for immediate reuse. This is a variant of gnat_save_expr that
908 is optimized under the assumption that EXP's value doesn't change before
909 its subsequent reuse(s) except through its potential reevaluation. */
910 extern tree gnat_protect_expr (tree exp);
912 /* This is equivalent to stabilize_reference in tree.c but we know how to
913 handle our own nodes and we take extra arguments. FORCE says whether to
914 force evaluation of everything. We set SUCCESS to true unless we walk
915 through something we don't know how to stabilize. */
916 extern tree gnat_stabilize_reference (tree ref, bool force, bool *success);
918 /* Implementation of the builtin_function langhook. */
919 extern tree gnat_builtin_function (tree decl);
921 /* Search the chain of currently reachable declarations for a builtin
922 FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
923 Return the first node found, if any, or NULL_TREE otherwise. */
924 extern tree builtin_decl_for (tree name);
926 /* GNU_TYPE is a type. Determine if it should be passed by reference by
928 extern bool default_pass_by_ref (tree gnu_type);
930 /* GNU_TYPE is the type of a subprogram parameter. Determine from the type
931 if it should be passed by reference. */
932 extern bool must_pass_by_ref (tree gnu_type);
934 /* Return the size of the FP mode with precision PREC. */
935 extern int fp_prec_to_size (int prec);
937 /* Return the precision of the FP mode with size SIZE. */
938 extern int fp_size_to_prec (int size);
944 /* These functions return the basic data type sizes and related parameters
945 about the target machine. */
946 extern Pos get_target_bits_per_unit (void);
947 extern Pos get_target_bits_per_word (void);
948 extern Pos get_target_char_size (void);
949 extern Pos get_target_wchar_t_size (void);
950 extern Pos get_target_short_size (void);
951 extern Pos get_target_int_size (void);
952 extern Pos get_target_long_size (void);
953 extern Pos get_target_long_long_size (void);
954 extern Pos get_target_float_size (void);
955 extern Pos get_target_double_size (void);
956 extern Pos get_target_long_double_size (void);
957 extern Pos get_target_pointer_size (void);
958 extern Pos get_target_maximum_default_alignment (void);
959 extern Pos get_target_system_allocator_alignment (void);
960 extern Pos get_target_maximum_allowed_alignment (void);
961 extern Pos get_target_maximum_alignment (void);
962 extern Nat get_float_words_be (void);
963 extern Nat get_words_be (void);
964 extern Nat get_bytes_be (void);
965 extern Nat get_bits_be (void);
966 extern Nat get_target_strict_alignment (void);
967 extern Nat get_target_double_float_alignment (void);
968 extern Nat get_target_double_scalar_alignment (void);
970 /* This function is called by the front-end to enumerate all the supported
971 modes for the machine, as well as some predefined C types. */
972 extern void enumerate_modes (void (*f) (const char *, int, int, int, int, int,
979 /* Let code know whether we are targetting VMS without need of
980 intrusive preprocessor directives. */
981 #ifndef TARGET_ABI_OPEN_VMS
982 #define TARGET_ABI_OPEN_VMS 0
985 /* VMS macro set by default, when clear forces 32bit mallocs and 32bit
986 Descriptors. Always used in combination with TARGET_ABI_OPEN_VMS
987 so no effect on non-VMS systems. */
988 #ifndef TARGET_MALLOC64
989 #define TARGET_MALLOC64 0
992 /* Convenient shortcuts. */
993 #define VECTOR_TYPE_P(TYPE) (TREE_CODE (TYPE) == VECTOR_TYPE)