gcc/ada/gcc-interface/gigi.h

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