1 /****************************************************************************
3 * GNAT COMPILER COMPONENTS *
9 * Copyright (C) 1992-2009, 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 *TP 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 *tp);
83 /* Finalize any From_With_Type incomplete types. We do this after processing
84 our compilation unit and after processing its spec, if this is a body. */
85 extern void finalize_from_with_types (void);
87 /* Return the equivalent type to be used for GNAT_ENTITY, if it's a
88 kind of type (such E_Task_Type) that has a different type which Gigi
89 uses for its representation. If the type does not have a special type
90 for its representation, return GNAT_ENTITY. If a type is supposed to
91 exist, but does not, abort unless annotating types, in which case
92 return Empty. If GNAT_ENTITY is Empty, return Empty. */
93 extern Entity_Id Gigi_Equivalent_Type (Entity_Id gnat_entity);
95 /* Given GNAT_ENTITY, elaborate all expressions that are required to
96 be elaborated at the point of its definition, but do nothing else. */
97 extern void elaborate_entity (Entity_Id gnat_entity);
99 /* Mark GNAT_ENTITY as going out of scope at this point. Recursively mark
100 any entities on its entity chain similarly. */
101 extern void mark_out_of_scope (Entity_Id gnat_entity);
103 /* Get the unpadded version of a GNAT type. */
104 extern tree get_unpadded_type (Entity_Id gnat_entity);
106 /* Called when we need to protect a variable object using a save_expr. */
107 extern tree maybe_variable (tree gnu_operand);
109 /* Create a record type that contains a SIZE bytes long field of TYPE with a
110 starting bit position so that it is aligned to ALIGN bits, and leaving at
111 least ROOM bytes free before the field. BASE_ALIGN is the alignment the
112 record is guaranteed to get. */
113 extern tree make_aligning_type (tree type, unsigned int align, tree size,
114 unsigned int base_align, int room);
116 /* Ensure that TYPE has SIZE and ALIGN. Make and return a new padded type
117 if needed. We have already verified that SIZE and TYPE are large enough.
119 GNAT_ENTITY and NAME_TRAILER are used to name the resulting record and
122 IS_USER_TYPE is true if we must be sure we complete the original type.
124 DEFINITION is true if this type is being defined.
126 SAME_RM_SIZE is true if the RM_Size of the resulting type is to be
127 set to its TYPE_SIZE; otherwise, it's set to the RM_Size of the original
129 extern tree maybe_pad_type (tree type, tree size, unsigned int align,
130 Entity_Id gnat_entity, const char *name_trailer,
131 bool is_user_type, bool definition,
134 /* Given a GNU tree and a GNAT list of choices, generate an expression to test
135 the value passed against the list of choices. */
136 extern tree choices_to_gnu (tree operand, Node_Id choices);
138 /* Given GNAT_ENTITY, an object (constant, variable, parameter, exception)
139 and GNU_TYPE, its corresponding GCC type, set Esize and Alignment to the
140 size and alignment used by Gigi. Prefer SIZE over TYPE_SIZE if non-null.
141 BY_REF is true if the object is used by reference. */
142 extern void annotate_object (Entity_Id gnat_entity, tree gnu_type, tree size,
145 /* Given a type T, a FIELD_DECL F, and a replacement value R, return a new
146 type with all size expressions that contain F updated by replacing F
147 with R. If F is NULL_TREE, always make a new RECORD_TYPE, even if
148 nothing has changed. */
149 extern tree substitute_in_type (tree t, tree f, tree r);
151 /* Return the RM size of GNU_TYPE. This is the actual number of bits
152 needed to represent the object. */
153 extern tree rm_size (tree gnu_type);
155 /* Return the name to be used for GNAT_ENTITY. If a type, create a
156 fully-qualified name, possibly with type information encoding.
157 Otherwise, return the name. */
158 extern tree get_entity_name (Entity_Id gnat_entity);
160 /* Return an identifier representing the external name to be used for
161 GNAT_ENTITY. If SUFFIX is specified, the name is followed by "___"
162 and the specified suffix. */
163 extern tree create_concat_name (Entity_Id gnat_entity, const char *suffix);
165 /* Given GNU_NAME, an IDENTIFIER_NODE containing a name and SUFFIX, a
166 string, return a new IDENTIFIER_NODE that is the concatenation of
167 the name followed by "___" and the specified suffix. */
168 extern tree concat_name (tree gnu_name, const char *suffix);
170 /* If true, then gigi is being called on an analyzed but unexpanded tree, and
171 the only purpose of the call is to properly annotate types with
172 representation information. */
173 extern bool type_annotate_only;
175 /* Current file name without path */
176 extern const char *ref_filename;
178 /* This structure must be kept synchronized with Call_Back_End. */
179 struct File_Info_Type
181 File_Name_Type File_Name;
182 Nat Num_Source_Lines;
185 /* This is the main program of the back-end. It sets up all the table
186 structures and then generates code.
188 ??? Needs parameter descriptions */
190 extern void gigi (Node_Id gnat_root, int max_gnat_node, int number_name,
191 struct Node *nodes_ptr, Node_Id *next_node_ptr,
192 Node_Id *prev_node_ptr, struct Elist_Header *elists_ptr,
193 struct Elmt_Item *elmts_ptr,
194 struct String_Entry *strings_ptr,
195 Char_Code *strings_chars_ptr,
196 struct List_Header *list_headers_ptr,
198 struct File_Info_Type *file_info_ptr,
199 Entity_Id standard_boolean,
200 Entity_Id standard_integer,
201 Entity_Id standard_long_long_float,
202 Entity_Id standard_exception_type,
203 Int gigi_operating_mode);
205 /* GNAT_NODE is the root of some GNAT tree. Return the root of the
206 GCC tree corresponding to that GNAT tree. Normally, no code is generated;
207 we just return an equivalent tree which is used elsewhere to generate
209 extern tree gnat_to_gnu (Node_Id gnat_node);
211 /* GNU_STMT is a statement. We generate code for that statement. */
212 extern void gnat_expand_stmt (tree gnu_stmt);
214 /* Generate GIMPLE in place for the expression at *EXPR_P. */
215 extern int gnat_gimplify_expr (tree *expr_p, gimple_seq *pre_p,
216 gimple_seq *post_p ATTRIBUTE_UNUSED);
218 /* Do the processing for the declaration of a GNAT_ENTITY, a type. If
219 a separate Freeze node exists, delay the bulk of the processing. Otherwise
220 make a GCC type for GNAT_ENTITY and set up the correspondence. */
221 extern void process_type (Entity_Id gnat_entity);
223 /* Convert SLOC into LOCUS. Return true if SLOC corresponds to a source code
224 location and false if it doesn't. In the former case, set the Gigi global
225 variable REF_FILENAME to the simple debug file name as given by sinput. */
226 extern bool Sloc_to_locus (Source_Ptr Sloc, location_t *locus);
228 /* Post an error message. MSG is the error message, properly annotated.
229 NODE is the node at which to post the error and the node to use for the
231 extern void post_error (const char *msg, Node_Id node);
233 /* Similar, but NODE is the node at which to post the error and ENT
234 is the node to use for the "&" substitution. */
235 extern void post_error_ne (const char *msg, Node_Id node, Entity_Id ent);
237 /* Similar, but NODE is the node at which to post the error, ENT is the node
238 to use for the "&" substitution, and N is the number to use for the ^. */
239 extern void post_error_ne_num (const char *msg, Node_Id node, Entity_Id ent,
242 /* Similar to post_error_ne_num, but T is a GCC tree representing the number
243 to write. If the tree represents a constant that fits within a
244 host integer, the text inside curly brackets in MSG will be output
245 (presumably including a '^'). Otherwise that text will not be output
246 and the text inside square brackets will be output instead. */
247 extern void post_error_ne_tree (const char *msg, Node_Id node, Entity_Id ent,
250 /* Similar to post_error_ne_tree, except that NUM is a second
251 integer to write in the message. */
252 extern void post_error_ne_tree_2 (const char *msg, Node_Id node, Entity_Id ent,
255 /* Protect EXP from multiple evaluation. This may make a SAVE_EXPR. */
256 extern tree protect_multiple_eval (tree exp);
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 /* This is equivalent to stabilize_reference in tree.c, but we know how to
267 handle our own nodes and we take extra arguments. FORCE says whether to
268 force evaluation of everything. We set SUCCESS to true unless we walk
269 through something we don't know how to stabilize. */
270 extern tree maybe_stabilize_reference (tree ref, bool force, bool *success);
272 /* Highest number in the front-end node table. */
273 extern int max_gnat_nodes;
275 /* If nonzero, pretend we are allocating at global level. */
276 extern int force_global;
278 /* The default alignment of "double" floating-point types, i.e. floating
279 point types whose size is equal to 64 bits, or 0 if this alignment is
280 not specifically capped. */
281 extern int double_float_alignment;
283 /* The default alignment of "double" or larger scalar types, i.e. scalar
284 types whose size is greater or equal to 64 bits, or 0 if this alignment
285 is not specifically capped. */
286 extern int double_scalar_alignment;
288 /* Standard data type sizes. Most of these are not used. */
290 #ifndef CHAR_TYPE_SIZE
291 #define CHAR_TYPE_SIZE BITS_PER_UNIT
294 #ifndef SHORT_TYPE_SIZE
295 #define SHORT_TYPE_SIZE (BITS_PER_UNIT * MIN ((UNITS_PER_WORD + 1) / 2, 2))
298 #ifndef INT_TYPE_SIZE
299 #define INT_TYPE_SIZE BITS_PER_WORD
302 #ifndef LONG_TYPE_SIZE
303 #define LONG_TYPE_SIZE BITS_PER_WORD
306 #ifndef LONG_LONG_TYPE_SIZE
307 #define LONG_LONG_TYPE_SIZE (BITS_PER_WORD * 2)
310 #ifndef FLOAT_TYPE_SIZE
311 #define FLOAT_TYPE_SIZE BITS_PER_WORD
314 #ifndef DOUBLE_TYPE_SIZE
315 #define DOUBLE_TYPE_SIZE (BITS_PER_WORD * 2)
318 #ifndef LONG_DOUBLE_TYPE_SIZE
319 #define LONG_DOUBLE_TYPE_SIZE (BITS_PER_WORD * 2)
322 /* The choice of SIZE_TYPE here is very problematic. We need a signed
323 type whose bit width is Pmode. Assume "long" is such a type here. */
325 #define SIZE_TYPE "long int"
327 /* Data structures used to represent attributes. */
331 ATTR_MACHINE_ATTRIBUTE,
334 ATTR_LINK_CONSTRUCTOR,
335 ATTR_LINK_DESTRUCTOR,
336 ATTR_THREAD_LOCAL_STORAGE,
349 /* Table of machine-independent internal attributes. */
350 extern const struct attribute_spec gnat_internal_attribute_table[];
352 /* Define the entries in the standard data array. */
353 enum standard_datatypes
355 /* The longest floating-point type. */
356 ADT_longest_float_type,
358 /* The type of an exception. */
361 /* Type declaration node <==> typedef void *T */
364 /* Function type declaration -- void T() */
367 /* Type declaration node <==> typedef void *T() */
370 /* Type declaration node <==> typedef virtual void *T() */
373 /* Null pointer for above type */
376 /* Function declaration nodes for run-time functions for allocating memory.
377 Ada allocators cause calls to these functions to be generated. Malloc32
378 is used only on 64bit systems needing to allocate 32bit memory. */
382 /* Likewise for freeing memory. */
385 /* Function decl node for 64-bit multiplication with overflow checking */
388 /* Types and decls used by our temporary exception mechanism. See
389 init_gigi_decls for details. */
397 ADT_update_setjmp_buf_decl,
398 ADT_raise_nodefer_decl,
399 ADT_begin_handler_decl,
400 ADT_end_handler_decl,
405 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
406 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
408 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
409 #define except_type_node gnat_std_decls[(int) ADT_except_type]
410 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
411 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
412 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
413 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
414 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
415 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
416 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
417 #define free_decl gnat_std_decls[(int) ADT_free_decl]
418 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
419 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
420 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
421 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
422 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
423 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
424 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
425 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
426 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
427 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
428 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
429 #define others_decl gnat_std_decls[(int) ADT_others_decl]
430 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
431 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
433 /* Routines expected by the gcc back-end. They must have exactly the same
434 prototype and names as below. */
436 /* Returns nonzero if we are currently in the global binding level. */
437 extern int global_bindings_p (void);
439 /* Enter and exit a new binding level. */
440 extern void gnat_pushlevel (void);
441 extern void gnat_poplevel (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_decl_processing (void);
458 extern void gnat_init_gcc_eh (void);
459 extern void gnat_install_builtins (void);
461 /* Return an integer type with the number of bits of precision given by
462 PRECISION. UNSIGNEDP is nonzero if the type is unsigned; otherwise
463 it is a signed type. */
464 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
466 /* Return a data type that has machine mode MODE. UNSIGNEDP selects
467 an unsigned type; otherwise a signed type is returned. */
468 extern tree gnat_type_for_mode (enum machine_mode mode, int unsignedp);
470 /* Emit debug info for all global variable declarations. */
471 extern void gnat_write_global_declarations (void);
473 /* Return the unsigned version of a TYPE_NODE, a scalar type. */
474 extern tree gnat_unsigned_type (tree type_node);
476 /* Return the signed version of a TYPE_NODE, a scalar type. */
477 extern tree gnat_signed_type (tree type_node);
479 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
480 transparently converted to each other. */
481 extern int gnat_types_compatible_p (tree t1, tree t2);
483 /* Create an expression whose value is that of EXPR,
484 converted to type TYPE. The TREE_TYPE of the value
485 is always TYPE. This function implements all reasonable
486 conversions; callers should filter out those that are
487 not permitted by the language being compiled. */
488 extern tree convert (tree type, tree expr);
490 /* Routines created solely for the tree translator's sake. Their prototypes
491 can be changed as desired. */
493 /* Initialize the association of GNAT nodes to GCC trees. */
494 extern void init_gnat_to_gnu (void);
496 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
497 GNU_DECL is the GCC tree which is to be associated with
498 GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
499 If NO_CHECK is nonzero, the latter check is suppressed.
500 If GNU_DECL is zero, a previous association is to be reset. */
501 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
504 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
505 Return the ..._DECL node that was associated with it. If there is no tree
506 node associated with GNAT_ENTITY, abort. */
507 extern tree get_gnu_tree (Entity_Id gnat_entity);
509 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY. */
510 extern bool present_gnu_tree (Entity_Id gnat_entity);
512 /* Initialize the association of GNAT nodes to GCC trees as dummies. */
513 extern void init_dummy_type (void);
515 /* Make a dummy type corresponding to GNAT_TYPE. */
516 extern tree make_dummy_type (Entity_Id gnat_type);
518 /* Record TYPE as a builtin type for Ada. NAME is the name of the type. */
519 extern void record_builtin_type (const char *name, tree type);
521 /* Given a record type RECORD_TYPE and a chain of FIELD_DECL nodes FIELDLIST,
522 finish constructing the record or union type. If REP_LEVEL is zero, this
523 record has no representation clause and so will be entirely laid out here.
524 If REP_LEVEL is one, this record has a representation clause and has been
525 laid out already; only set the sizes and alignment. If REP_LEVEL is two,
526 this record is derived from a parent record and thus inherits its layout;
527 only make a pass on the fields to finalize them. If DO_NOT_FINALIZE is
528 true, the record type is expected to be modified afterwards so it will
529 not be sent to the back-end for finalization. */
530 extern void finish_record_type (tree record_type, tree fieldlist,
531 int rep_level, bool do_not_finalize);
533 /* Wrap up compilation of RECORD_TYPE, i.e. most notably output all
534 the debug information associated with it. It need not be invoked
535 directly in most cases since finish_record_type takes care of doing
536 so, unless explicitly requested not to through DO_NOT_FINALIZE. */
537 extern void rest_of_record_type_compilation (tree record_type);
539 /* Append PARALLEL_TYPE on the chain of parallel types for decl. */
540 extern void add_parallel_type (tree decl, tree parallel_type);
542 /* Return the parallel type associated to a type, if any. */
543 extern tree get_parallel_type (tree type);
545 /* Returns a FUNCTION_TYPE node. RETURN_TYPE is the type returned by the
546 subprogram. If it is void_type_node, then we are dealing with a procedure,
547 otherwise we are dealing with a function. PARAM_DECL_LIST is a list of
548 PARM_DECL nodes that are the subprogram arguments. CICO_LIST is the
549 copy-in/copy-out list to be stored into TYPE_CI_CO_LIST.
550 RETURNS_UNCONSTRAINED is true if the function returns an unconstrained
551 object. RETURNS_BY_REF is true if the function returns by reference.
552 RETURNS_BY_TARGET_PTR is true if the function is to be passed (as its
553 first parameter) the address of the place to copy its result. */
554 extern tree create_subprog_type (tree return_type, tree param_decl_list,
555 tree cico_list, bool returns_unconstrained,
557 bool returns_by_target_ptr);
559 /* Return a copy of TYPE, but safe to modify in any way. */
560 extern tree copy_type (tree type);
562 /* Return a subtype of sizetype with range MIN to MAX and whose
563 TYPE_INDEX_TYPE is INDEX. GNAT_NODE is used for the position
564 of the associated TYPE_DECL. */
565 extern tree create_index_type (tree min, tree max, tree index,
568 /* Return a subtype of TYPE with range MIN to MAX. If TYPE is NULL,
570 extern tree create_range_type (tree type, tree min, tree max);
572 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
573 TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
575 extern tree create_type_stub_decl (tree type_name, tree type);
577 /* Return a TYPE_DECL node. TYPE_NAME gives the name of the type and TYPE
578 is a ..._TYPE node giving its data type. ARTIFICIAL_P is true if this
579 is a declaration that was generated by the compiler. DEBUG_INFO_P is
580 true if we need to write debug information about this type. GNAT_NODE
581 is used for the position of the decl. */
582 extern tree create_type_decl (tree type_name, tree type,
583 struct attrib *attr_list,
584 bool artificial_p, bool debug_info_p,
587 /* Return a VAR_DECL or CONST_DECL node.
589 VAR_NAME gives the name of the variable. ASM_NAME is its assembler name
590 (if provided). TYPE is its data type (a GCC ..._TYPE node). VAR_INIT is
591 the GCC tree for an optional initial expression; NULL_TREE if none.
593 CONST_FLAG is true if this variable is constant, in which case we might
594 return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
596 PUBLIC_FLAG is true if this definition is to be made visible outside of
597 the current compilation unit. This flag should be set when processing the
598 variable definitions in a package specification.
600 EXTERN_FLAG is nonzero when processing an external variable declaration (as
601 opposed to a definition: no storage is to be allocated for the variable).
603 STATIC_FLAG is only relevant when not at top level. In that case
604 it indicates whether to always allocate storage to the variable.
606 GNAT_NODE is used for the position of the decl. */
608 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
609 bool const_flag, bool public_flag, bool extern_flag,
610 bool static_flag, bool const_decl_allowed_p,
611 struct attrib *attr_list, Node_Id gnat_node);
613 /* Wrapper around create_var_decl_1 for cases where we don't care whether
614 a VAR or a CONST decl node is created. */
615 #define create_var_decl(var_name, asm_name, type, var_init, \
616 const_flag, public_flag, extern_flag, \
617 static_flag, attr_list, gnat_node) \
618 create_var_decl_1 (var_name, asm_name, type, var_init, \
619 const_flag, public_flag, extern_flag, \
620 static_flag, true, attr_list, gnat_node)
622 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
623 required. The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
624 must be VAR_DECLs and on which we want TREE_READONLY set to have them
625 possibly assigned to a readonly data section. */
626 #define create_true_var_decl(var_name, asm_name, type, var_init, \
627 const_flag, public_flag, extern_flag, \
628 static_flag, attr_list, gnat_node) \
629 create_var_decl_1 (var_name, asm_name, type, var_init, \
630 const_flag, public_flag, extern_flag, \
631 static_flag, false, attr_list, gnat_node)
633 /* Given a DECL and ATTR_LIST, apply the listed attributes. */
634 extern void process_attributes (tree decl, struct attrib *attr_list);
636 /* Record DECL as a global renaming pointer. */
637 extern void record_global_renaming_pointer (tree decl);
639 /* Invalidate the global renaming pointers. */
640 extern void invalidate_global_renaming_pointers (void);
642 /* Returns a FIELD_DECL node. FIELD_NAME the field name, FIELD_TYPE is its
643 type, and RECORD_TYPE is the type of the parent. PACKED is nonzero if
644 this field is in a record type with a "pragma pack". If SIZE is nonzero
645 it is the specified size for this field. If POS is nonzero, it is the bit
646 position. If ADDRESSABLE is nonzero, it means we are allowed to take
647 the address of this field for aliasing purposes. */
648 extern tree create_field_decl (tree field_name, tree field_type,
649 tree record_type, int packed, tree size,
650 tree pos, int addressable);
652 /* Returns a PARM_DECL node. PARAM_NAME is the name of the parameter,
653 PARAM_TYPE is its type. READONLY is true if the parameter is
654 readonly (either an In parameter or an address of a pass-by-ref
656 extern tree create_param_decl (tree param_name, tree param_type,
659 /* Returns a FUNCTION_DECL node. SUBPROG_NAME is the name of the subprogram,
660 ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
661 node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
662 PARM_DECL nodes chained through the TREE_CHAIN field).
664 INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, and ATTR_LIST are used to set the
665 appropriate fields in the FUNCTION_DECL. GNAT_NODE gives the location. */
666 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
667 tree subprog_type, tree param_decl_list,
668 bool inlinee_flag, bool public_flag,
670 struct attrib *attr_list, Node_Id gnat_node);
672 /* Returns a LABEL_DECL node for LABEL_NAME. */
673 extern tree create_label_decl (tree label_name);
675 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
676 body. This routine needs to be invoked before processing the declarations
677 appearing in the subprogram. */
678 extern void begin_subprog_body (tree subprog_decl);
680 /* Finish the definition of the current subprogram BODY and finalize it. */
681 extern void end_subprog_body (tree body);
683 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
684 EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
685 Return a constructor for the template. */
686 extern tree build_template (tree template_type, tree array_type, tree expr);
688 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
689 a descriptor type, and the GCC type of an object. Each FIELD_DECL
690 in the type contains in its DECL_INITIAL the expression to use when
691 a constructor is made for the type. GNAT_ENTITY is a gnat node used
692 to print out an error message if the mechanism cannot be applied to
693 an object of that type and also for the name. */
694 extern tree build_vms_descriptor (tree type, Mechanism_Type mech,
695 Entity_Id gnat_entity);
697 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above. */
698 extern tree build_vms_descriptor32 (tree type, Mechanism_Type mech,
699 Entity_Id gnat_entity);
701 /* Build a stub for the subprogram specified by the GCC tree GNU_SUBPROG
702 and the GNAT node GNAT_SUBPROG. */
703 extern void build_function_stub (tree gnu_subprog, Entity_Id gnat_subprog);
705 /* Build a type to be used to represent an aliased object whose nominal
706 type is an unconstrained array. This consists of a RECORD_TYPE containing
707 a field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an
708 ARRAY_TYPE. If ARRAY_TYPE is that of the unconstrained array, this
709 is used to represent an arbitrary unconstrained object. Use NAME
710 as the name of the record. */
711 extern tree build_unc_object_type (tree template_type, tree object_type,
714 /* Same as build_unc_object_type, but taking a thin or fat pointer type
715 instead of the template type. */
716 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
717 tree object_type, tree name);
719 /* Shift the component offsets within an unconstrained object TYPE to make it
720 suitable for use as a designated type for thin pointers. */
721 extern void shift_unc_components_for_thin_pointers (tree type);
723 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE. In
724 the normal case this is just two adjustments, but we have more to do
725 if NEW is an UNCONSTRAINED_ARRAY_TYPE. */
726 extern void update_pointer_to (tree old_type, tree new_type);
728 /* EXP is an expression for the size of an object. If this size contains
729 discriminant references, replace them with the maximum (if MAX_P) or
730 minimum (if !MAX_P) possible value of the discriminant. */
731 extern tree max_size (tree exp, bool max_p);
733 /* Remove all conversions that are done in EXP. This includes converting
734 from a padded type or to a left-justified modular type. If TRUE_ADDRESS
735 is true, always return the address of the containing object even if
736 the address is not bit-aligned. */
737 extern tree remove_conversions (tree exp, bool true_address);
739 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
740 refers to the underlying array. If its type has TYPE_CONTAINS_TEMPLATE_P,
741 likewise return an expression pointing to the underlying array. */
742 extern tree maybe_unconstrained_array (tree exp);
744 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
745 If NOTRUNC_P is true, truncation operations should be suppressed. */
746 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
748 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
749 the latter being a record type as predicated by Is_Record_Type. */
750 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
752 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
753 size is equal to 64 bits, or an array of such a type. Set ALIGN_CLAUSE
754 according to the presence of an alignment clause on the type or, if it
755 is an array, on the component type. */
756 extern bool is_double_float_or_array (Entity_Id gnat_type,
759 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
760 size is greater or equal to 64 bits, or an array of such a type. Set
761 ALIGN_CLAUSE according to the presence of an alignment clause on the
762 type or, if it is an array, on the component type. */
763 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
766 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
767 component of an aggregate type. */
768 extern bool type_for_nonaliased_component_p (tree gnu_type);
770 /* Prepare expr to be an argument of a TRUTH_NOT_EXPR or other logical
773 This preparation consists of taking the ordinary
774 representation of an expression EXPR and producing a valid tree
775 boolean expression describing whether EXPR is nonzero. We could
776 simply always do build_binary_op (NE_EXPR, expr, integer_zero_node, 1),
777 but we optimize comparisons, &&, ||, and !.
779 The resulting type should always be the same as the input type.
780 This function is simpler than the corresponding C version since
781 the only possible operands will be things of Boolean type. */
782 extern tree gnat_truthvalue_conversion (tree expr);
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 RETURN_EXPR. */
813 extern tree build_return_expr (tree result_decl, tree ret_val);
815 /* Build a CALL_EXPR to call FUNDECL with one argument, ARG. Return
817 extern tree build_call_1_expr (tree fundecl, tree arg);
819 /* Build a CALL_EXPR to call FUNDECL with two argument, ARG1 & ARG2. Return
821 extern tree build_call_2_expr (tree fundecl, tree arg1, tree arg2);
823 /* Likewise to call FUNDECL with no arguments. */
824 extern tree build_call_0_expr (tree fundecl);
826 /* Call a function that raises an exception and pass the line number and file
827 name, if requested. MSG says which exception function to call.
829 GNAT_NODE is the gnat node conveying the source location for which the
830 error should be signaled, or Empty in which case the error is signaled on
831 the current ref_file_name/input_line.
833 KIND says which kind of exception this is for
834 (N_Raise_{Constraint,Storage,Program}_Error). */
835 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
837 /* Return a CONSTRUCTOR of TYPE whose list is LIST. This is not the
838 same as build_constructor in the language-independent tree.c. */
839 extern tree gnat_build_constructor (tree type, tree list);
841 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
842 an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
843 for the field, or both. Don't fold the result if NO_FOLD_P. */
844 extern tree build_component_ref (tree record_variable, tree component,
845 tree field, bool no_fold_p);
847 /* Build a GCC tree to call an allocation or deallocation function.
848 If GNU_OBJ is nonzero, it is an object to deallocate. Otherwise,
849 generate an allocator.
851 GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
852 object type, used to determine the to-be-honored address alignment.
853 GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
854 pool to use. If not present, malloc and free are used. GNAT_NODE is used
855 to provide an error location for restriction violation messages. */
856 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
857 tree gnu_type, Entity_Id gnat_proc,
858 Entity_Id gnat_pool, Node_Id gnat_node);
860 /* Build a GCC tree to correspond to allocating an object of TYPE whose
861 initial value if INIT, if INIT is nonzero. Convert the expression to
862 RESULT_TYPE, which must be some type of pointer. Return the tree.
864 GNAT_PROC and GNAT_POOL optionally give the procedure to call and
865 the storage pool to use. GNAT_NODE is used to provide an error
866 location for restriction violation messages. If IGNORE_INIT_TYPE is
867 true, ignore the type of INIT for the purpose of determining the size;
868 this will cause the maximum size to be allocated if TYPE is of
869 self-referential size. */
870 extern tree build_allocator (tree type, tree init, tree result_type,
871 Entity_Id gnat_proc, Entity_Id gnat_pool,
872 Node_Id gnat_node, bool);
874 /* Fill in a VMS descriptor for EXPR and return a constructor for it.
875 GNAT_FORMAL is how we find the descriptor record. GNAT_ACTUAL is how
876 we derive the source location on a C_E */
877 extern tree fill_vms_descriptor (tree expr, Entity_Id gnat_formal,
878 Node_Id gnat_actual);
880 /* Indicate that we need to make the address of EXPR_NODE and it therefore
881 should not be allocated in a register. Return true if successful. */
882 extern bool gnat_mark_addressable (tree expr_node);
884 /* Implementation of the builtin_function langhook. */
885 extern tree gnat_builtin_function (tree decl);
887 /* Search the chain of currently reachable declarations for a builtin
888 FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
889 Return the first node found, if any, or NULL_TREE otherwise. */
890 extern tree builtin_decl_for (tree name);
892 /* GNU_TYPE is a type. Determine if it should be passed by reference by
894 extern bool default_pass_by_ref (tree gnu_type);
896 /* GNU_TYPE is the type of a subprogram parameter. Determine from the type
897 if it should be passed by reference. */
898 extern bool must_pass_by_ref (tree gnu_type);
900 /* This function is called by the front end to enumerate all the supported
901 modes for the machine. We pass a function which is called back with
902 the following integer parameters:
904 FLOAT_P nonzero if this represents a floating-point mode
905 COMPLEX_P nonzero is this represents a complex mode
906 COUNT count of number of items, nonzero for vector mode
907 PRECISION number of bits in data representation
908 MANTISSA number of bits in mantissa, if FP and known, else zero.
909 SIZE number of bits used to store data
910 ALIGN number of bits to which mode is aligned. */
911 extern void enumerate_modes (void (*f) (int, int, int, int, int, int,
914 /* Return the size of the FP mode with precision PREC. */
915 extern int fp_prec_to_size (int prec);
917 /* Return the precision of the FP mode with size SIZE. */
918 extern int fp_size_to_prec (int size);
920 /* These functions return the basic data type sizes and related parameters
921 about the target machine. */
923 extern Pos get_target_bits_per_unit (void);
924 extern Pos get_target_bits_per_word (void);
925 extern Pos get_target_char_size (void);
926 extern Pos get_target_wchar_t_size (void);
927 extern Pos get_target_short_size (void);
928 extern Pos get_target_int_size (void);
929 extern Pos get_target_long_size (void);
930 extern Pos get_target_long_long_size (void);
931 extern Pos get_target_float_size (void);
932 extern Pos get_target_double_size (void);
933 extern Pos get_target_long_double_size (void);
934 extern Pos get_target_pointer_size (void);
935 extern Pos get_target_maximum_default_alignment (void);
936 extern Pos get_target_default_allocator_alignment (void);
937 extern Pos get_target_maximum_allowed_alignment (void);
938 extern Pos get_target_maximum_alignment (void);
939 extern Nat get_float_words_be (void);
940 extern Nat get_words_be (void);
941 extern Nat get_bytes_be (void);
942 extern Nat get_bits_be (void);
943 extern Nat get_target_strict_alignment (void);
944 extern Nat get_target_double_float_alignment (void);
945 extern Nat get_target_double_scalar_alignment (void);
947 /* Let code know whether we are targetting VMS without need of
948 intrusive preprocessor directives. */
949 #ifndef TARGET_ABI_OPEN_VMS
950 #define TARGET_ABI_OPEN_VMS 0
953 /* VMS macro set by default, when clear forces 32bit mallocs and 32bit
954 Descriptors. Always used in combination with TARGET_ABI_OPEN_VMS
955 so no effect on non-VMS systems. */
956 #ifndef TARGET_MALLOC64
957 #define TARGET_MALLOC64 0
OSDN Git Service
