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-2009, 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 *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);
  82
  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);
  86
  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);
  94
  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);
  98
  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);
 102
 103 /* Get the unpadded version of a GNAT type.  */
 104 extern tree get_unpadded_type (Entity_Id gnat_entity);
 105
 106 /* Called when we need to protect a variable object using a save_expr.  */
 107 extern tree maybe_variable (tree gnu_operand);
 108
 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);
 115
 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.
 118
 119    GNAT_ENTITY and NAME_TRAILER are used to name the resulting record and
 120    to issue a warning.
 121
 122    IS_USER_TYPE is true if we must be sure we complete the original type.
 123
 124    DEFINITION is true if this type is being defined.
 125
 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
 128    type.  */
 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,
 132                             bool same_rm_size);
 133
 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);
 137
 138 /* Given a type T, a FIELD_DECL F, and a replacement value R, return a new
 139    type with all size expressions that contain F updated by replacing F
 140    with R.  If F is NULL_TREE, always make a new RECORD_TYPE, even if
 141    nothing has changed.  */
 142 extern tree substitute_in_type (tree t, tree f, tree r);
 143
 144 /* Return the RM size of GNU_TYPE.  This is the actual number of bits
 145    needed to represent the object.  */
 146 extern tree rm_size (tree gnu_type);
 147
 148 /* Return the name to be used for GNAT_ENTITY.  If a type, create a
 149    fully-qualified name, possibly with type information encoding.
 150    Otherwise, return the name.  */
 151 extern tree get_entity_name (Entity_Id gnat_entity);
 152
 153 /* Return an identifier representing the external name to be used for
 154    GNAT_ENTITY.  If SUFFIX is specified, the name is followed by "___"
 155    and the specified suffix.  */
 156 extern tree create_concat_name (Entity_Id gnat_entity, const char *suffix);
 157
 158 /* Given GNU_NAME, an IDENTIFIER_NODE containing a name and SUFFIX, a
 159    string, return a new IDENTIFIER_NODE that is the concatenation of
 160    the name followed by "___" and the specified suffix.  */
 161 extern tree concat_name (tree gnu_name, const char *suffix);
 162
 163 /* If true, then gigi is being called on an analyzed but unexpanded tree, and
 164    the only purpose of the call is to properly annotate types with
 165    representation information.  */
 166 extern bool type_annotate_only;
 167
 168 /* Current file name without path */
 169 extern const char *ref_filename;
 170
 171 /* This structure must be kept synchronized with Call_Back_End.  */
 172 struct File_Info_Type
 173 {
 174   File_Name_Type File_Name;
 175   Nat Num_Source_Lines;
 176 };
 177
 178 /* This is the main program of the back-end.  It sets up all the table
 179    structures and then generates code.
 180
 181    ??? Needs parameter descriptions  */
 182
 183 extern void gigi (Node_Id gnat_root, int max_gnat_node, int number_name,
 184                   struct Node *nodes_ptr, Node_Id *next_node_ptr,
 185                   Node_Id *prev_node_ptr, struct Elist_Header *elists_ptr,
 186                   struct Elmt_Item *elmts_ptr,
 187                   struct String_Entry *strings_ptr,
 188                   Char_Code *strings_chars_ptr,
 189                   struct List_Header *list_headers_ptr,
 190                   Nat number_file,
 191                   struct File_Info_Type *file_info_ptr,
 192                   Entity_Id standard_boolean,
 193                   Entity_Id standard_integer,
 194                   Entity_Id standard_long_long_float,
 195                   Entity_Id standard_exception_type,
 196                   Int gigi_operating_mode);
 197
 198 /* GNAT_NODE is the root of some GNAT tree.  Return the root of the
 199    GCC tree corresponding to that GNAT tree.  Normally, no code is generated;
 200    we just return an equivalent tree which is used elsewhere to generate
 201    code.  */
 202 extern tree gnat_to_gnu (Node_Id gnat_node);
 203
 204 /* GNU_STMT is a statement.  We generate code for that statement.  */
 205 extern void gnat_expand_stmt (tree gnu_stmt);
 206
 207 /* Generate GIMPLE in place for the expression at *EXPR_P.  */
 208 extern int gnat_gimplify_expr (tree *expr_p, gimple_seq *pre_p,
 209                                gimple_seq *post_p ATTRIBUTE_UNUSED);
 210
 211 /* Do the processing for the declaration of a GNAT_ENTITY, a type.  If
 212    a separate Freeze node exists, delay the bulk of the processing.  Otherwise
 213    make a GCC type for GNAT_ENTITY and set up the correspondence.  */
 214 extern void process_type (Entity_Id gnat_entity);
 215
 216 /* Convert SLOC into LOCUS.  Return true if SLOC corresponds to a source code
 217    location and false if it doesn't.  In the former case, set the Gigi global
 218    variable REF_FILENAME to the simple debug file name as given by sinput.  */
 219 extern bool Sloc_to_locus (Source_Ptr Sloc, location_t *locus);
 220
 221 /* Post an error message.  MSG is the error message, properly annotated.
 222    NODE is the node at which to post the error and the node to use for the
 223    "&" substitution.  */
 224 extern void post_error (const char *msg, Node_Id node);
 225
 226 /* Similar, but NODE is the node at which to post the error and ENT
 227    is the node to use for the "&" substitution.  */
 228 extern void post_error_ne (const char *msg, Node_Id node, Entity_Id ent);
 229
 230 /* Similar, but NODE is the node at which to post the error, ENT is the node
 231    to use for the "&" substitution, and N is the number to use for the ^.  */
 232 extern void post_error_ne_num (const char *msg, Node_Id node, Entity_Id ent,
 233                                int n);
 234
 235 /* Similar to post_error_ne_num, but T is a GCC tree representing the number
 236    to write.  If the tree represents a constant that fits within a
 237    host integer, the text inside curly brackets in MSG will be output
 238    (presumably including a '^').  Otherwise that text will not be output
 239    and the text inside square brackets will be output instead.  */
 240 extern void post_error_ne_tree (const char *msg, Node_Id node, Entity_Id ent,
 241                                 tree t);
 242
 243 /* Similar to post_error_ne_tree, except that NUM is a second
 244    integer to write in the message.  */
 245 extern void post_error_ne_tree_2 (const char *msg, Node_Id node, Entity_Id ent,
 246                                   tree t, int num);
 247
 248 /* Protect EXP from multiple evaluation.  This may make a SAVE_EXPR.  */
 249 extern tree protect_multiple_eval (tree exp);
 250
 251 /* Return a label to branch to for the exception type in KIND or NULL_TREE
 252    if none.  */
 253 extern tree get_exception_label (char kind);
 254
 255 /* Current node being treated, in case gigi_abort or Check_Elaboration_Code
 256    called.  */
 257 extern Node_Id error_gnat_node;
 258
 259 /* This is equivalent to stabilize_reference in tree.c, but we know how to
 260    handle our own nodes and we take extra arguments.  FORCE says whether to
 261    force evaluation of everything.  We set SUCCESS to true unless we walk
 262    through something we don't know how to stabilize.  */
 263 extern tree maybe_stabilize_reference (tree ref, bool force, bool *success);
 264
 265 /* Highest number in the front-end node table.  */
 266 extern int max_gnat_nodes;
 267
 268 /* If nonzero, pretend we are allocating at global level.  */
 269 extern int force_global;
 270
 271 /* The default alignment of "double" floating-point types, i.e. floating
 272    point types whose size is equal to 64 bits, or 0 if this alignment is
 273    not specifically capped.  */
 274 extern int double_float_alignment;
 275
 276 /* The default alignment of "double" or larger scalar types, i.e. scalar
 277    types whose size is greater or equal to 64 bits, or 0 if this alignment
 278    is not specifically capped.  */
 279 extern int double_scalar_alignment;
 280
 281 /* Standard data type sizes.  Most of these are not used.  */
 282
 283 #ifndef CHAR_TYPE_SIZE
 284 #define CHAR_TYPE_SIZE BITS_PER_UNIT
 285 #endif
 286
 287 #ifndef SHORT_TYPE_SIZE
 288 #define SHORT_TYPE_SIZE (BITS_PER_UNIT * MIN ((UNITS_PER_WORD + 1) / 2, 2))
 289 #endif
 290
 291 #ifndef INT_TYPE_SIZE
 292 #define INT_TYPE_SIZE BITS_PER_WORD
 293 #endif
 294
 295 #ifndef LONG_TYPE_SIZE
 296 #define LONG_TYPE_SIZE BITS_PER_WORD
 297 #endif
 298
 299 #ifndef LONG_LONG_TYPE_SIZE
 300 #define LONG_LONG_TYPE_SIZE (BITS_PER_WORD * 2)
 301 #endif
 302
 303 #ifndef FLOAT_TYPE_SIZE
 304 #define FLOAT_TYPE_SIZE BITS_PER_WORD
 305 #endif
 306
 307 #ifndef DOUBLE_TYPE_SIZE
 308 #define DOUBLE_TYPE_SIZE (BITS_PER_WORD * 2)
 309 #endif
 310
 311 #ifndef LONG_DOUBLE_TYPE_SIZE
 312 #define LONG_DOUBLE_TYPE_SIZE (BITS_PER_WORD * 2)
 313 #endif
 314
 315 /* The choice of SIZE_TYPE here is very problematic.  We need a signed
 316    type whose bit width is Pmode.  Assume "long" is such a type here.  */
 317 #undef SIZE_TYPE
 318 #define SIZE_TYPE "long int"
 319 \f
 320 /* Data structures used to represent attributes.  */
 321
 322 enum attr_type
 323 {
 324   ATTR_MACHINE_ATTRIBUTE,
 325   ATTR_LINK_ALIAS,
 326   ATTR_LINK_SECTION,
 327   ATTR_LINK_CONSTRUCTOR,
 328   ATTR_LINK_DESTRUCTOR,
 329   ATTR_THREAD_LOCAL_STORAGE,
 330   ATTR_WEAK_EXTERNAL
 331 };
 332
 333 struct attrib
 334 {
 335   struct attrib *next;
 336   enum attr_type type;
 337   tree name;
 338   tree args;
 339   Node_Id error_point;
 340 };
 341
 342 /* Table of machine-independent internal attributes.  */
 343 extern const struct attribute_spec gnat_internal_attribute_table[];
 344
 345 /* Define the entries in the standard data array.  */
 346 enum standard_datatypes
 347 {
 348   /* The longest floating-point type.  */
 349   ADT_longest_float_type,
 350
 351   /* The type of an exception.  */
 352   ADT_except_type,
 353
 354   /* Type declaration node  <==> typedef void *T */
 355   ADT_ptr_void_type,
 356
 357   /* Function type declaration -- void T() */
 358   ADT_void_ftype,
 359
 360   /* Type declaration node  <==> typedef void *T() */
 361   ADT_ptr_void_ftype,
 362
 363   /* Type declaration node  <==> typedef virtual void *T() */
 364   ADT_fdesc_type,
 365
 366   /* Null pointer for above type */
 367   ADT_null_fdesc,
 368
 369   /* Function declaration nodes for run-time functions for allocating memory.
 370      Ada allocators cause calls to these functions to be generated.  Malloc32
 371      is used only on 64bit systems needing to allocate 32bit memory.  */
 372   ADT_malloc_decl,
 373   ADT_malloc32_decl,
 374
 375   /* Likewise for freeing memory.  */
 376   ADT_free_decl,
 377
 378   /* Function decl node for 64-bit multiplication with overflow checking */
 379   ADT_mulv64_decl,
 380
 381   /* Types and decls used by our temporary exception mechanism.  See
 382      init_gigi_decls for details.  */
 383   ADT_jmpbuf_type,
 384   ADT_jmpbuf_ptr_type,
 385   ADT_get_jmpbuf_decl,
 386   ADT_set_jmpbuf_decl,
 387   ADT_get_excptr_decl,
 388   ADT_setjmp_decl,
 389   ADT_longjmp_decl,
 390   ADT_update_setjmp_buf_decl,
 391   ADT_raise_nodefer_decl,
 392   ADT_begin_handler_decl,
 393   ADT_end_handler_decl,
 394   ADT_others_decl,
 395   ADT_all_others_decl,
 396   ADT_LAST};
 397
 398 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
 399 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
 400
 401 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
 402 #define except_type_node gnat_std_decls[(int) ADT_except_type]
 403 #define ptr_void_type_node gnat_std_decls[(int) ADT_ptr_void_type]
 404 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
 405 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
 406 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
 407 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
 408 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
 409 #define malloc32_decl gnat_std_decls[(int) ADT_malloc32_decl]
 410 #define free_decl gnat_std_decls[(int) ADT_free_decl]
 411 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
 412 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
 413 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
 414 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
 415 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
 416 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
 417 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
 418 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
 419 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
 420 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
 421 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
 422 #define others_decl gnat_std_decls[(int) ADT_others_decl]
 423 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
 424 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
 425
 426 /* Routines expected by the gcc back-end. They must have exactly the same
 427    prototype and names as below.  */
 428
 429 /* Returns nonzero if we are currently in the global binding level.  */
 430 extern int global_bindings_p (void);
 431
 432 /* Enter and exit a new binding level.  */
 433 extern void gnat_pushlevel (void);
 434 extern void gnat_poplevel (void);
 435
 436 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
 437    and point FNDECL to this BLOCK.  */
 438 extern void set_current_block_context (tree fndecl);
 439
 440 /* Set the jmpbuf_decl for the current binding level to DECL.  */
 441 extern void set_block_jmpbuf_decl (tree decl);
 442
 443 /* Get the setjmp_decl, if any, for the current binding level.  */
 444 extern tree get_block_jmpbuf_decl (void);
 445
 446 /* Records a ..._DECL node DECL as belonging to the current lexical scope
 447    and uses GNAT_NODE for location information.  */
 448 extern void gnat_pushdecl (tree decl, Node_Id gnat_node);
 449
 450 extern void gnat_init_decl_processing (void);
 451 extern void gnat_init_gcc_eh (void);
 452 extern void gnat_install_builtins (void);
 453
 454 /* Return an integer type with the number of bits of precision given by
 455    PRECISION.  UNSIGNEDP is nonzero if the type is unsigned; otherwise
 456    it is a signed type.  */
 457 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
 458
 459 /* Return a data type that has machine mode MODE.  UNSIGNEDP selects
 460    an unsigned type; otherwise a signed type is returned.  */
 461 extern tree gnat_type_for_mode (enum machine_mode mode, int unsignedp);
 462
 463 /* Emit debug info for all global variable declarations.  */
 464 extern void gnat_write_global_declarations (void);
 465
 466 /* Return the unsigned version of a TYPE_NODE, a scalar type.  */
 467 extern tree gnat_unsigned_type (tree type_node);
 468
 469 /* Return the signed version of a TYPE_NODE, a scalar type.  */
 470 extern tree gnat_signed_type (tree type_node);
 471
 472 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
 473    transparently converted to each other.  */
 474 extern int gnat_types_compatible_p (tree t1, tree t2);
 475
 476 /* Create an expression whose value is that of EXPR,
 477    converted to type TYPE.  The TREE_TYPE of the value
 478    is always TYPE.  This function implements all reasonable
 479    conversions; callers should filter out those that are
 480    not permitted by the language being compiled.  */
 481 extern tree convert (tree type, tree expr);
 482
 483 /* Routines created solely for the tree translator's sake. Their prototypes
 484    can be changed as desired.  */
 485
 486 /* Initialize the association of GNAT nodes to GCC trees.  */
 487 extern void init_gnat_to_gnu (void);
 488
 489 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
 490    GNU_DECL is the GCC tree which is to be associated with
 491    GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
 492    If NO_CHECK is nonzero, the latter check is suppressed.
 493    If GNU_DECL is zero, a previous association is to be reset.  */
 494 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
 495                            bool no_check);
 496
 497 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
 498    Return the ..._DECL node that was associated with it.  If there is no tree
 499    node associated with GNAT_ENTITY, abort.  */
 500 extern tree get_gnu_tree (Entity_Id gnat_entity);
 501
 502 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY.  */
 503 extern bool present_gnu_tree (Entity_Id gnat_entity);
 504
 505 /* Initialize the association of GNAT nodes to GCC trees as dummies.  */
 506 extern void init_dummy_type (void);
 507
 508 /* Make a dummy type corresponding to GNAT_TYPE.  */
 509 extern tree make_dummy_type (Entity_Id gnat_type);
 510
 511 /* Record TYPE as a builtin type for Ada.  NAME is the name of the type.  */
 512 extern void record_builtin_type (const char *name, tree type);
 513
 514 /* Given a record type RECORD_TYPE and a chain of FIELD_DECL nodes FIELDLIST,
 515    finish constructing the record or union type.  If REP_LEVEL is zero, this
 516    record has no representation clause and so will be entirely laid out here.
 517    If REP_LEVEL is one, this record has a representation clause and has been
 518    laid out already; only set the sizes and alignment.  If REP_LEVEL is two,
 519    this record is derived from a parent record and thus inherits its layout;
 520    only make a pass on the fields to finalize them.  If DO_NOT_FINALIZE is
 521    true, the record type is expected to be modified afterwards so it will
 522    not be sent to the back-end for finalization.  */
 523 extern void finish_record_type (tree record_type, tree fieldlist,
 524                                 int rep_level, bool do_not_finalize);
 525
 526 /* Wrap up compilation of RECORD_TYPE, i.e. most notably output all
 527    the debug information associated with it.  It need not be invoked
 528    directly in most cases since finish_record_type takes care of doing
 529    so, unless explicitly requested not to through DO_NOT_FINALIZE.  */
 530 extern void rest_of_record_type_compilation (tree record_type);
 531
 532 /* Append PARALLEL_TYPE on the chain of parallel types for decl.  */
 533 extern void add_parallel_type (tree decl, tree parallel_type);
 534
 535 /* Return the parallel type associated to a type, if any.  */
 536 extern tree get_parallel_type (tree type);
 537
 538 /* Returns a FUNCTION_TYPE node. RETURN_TYPE is the type returned by the
 539    subprogram. If it is void_type_node, then we are dealing with a procedure,
 540    otherwise we are dealing with a function. PARAM_DECL_LIST is a list of
 541    PARM_DECL nodes that are the subprogram arguments.  CICO_LIST is the
 542    copy-in/copy-out list to be stored into TYPE_CI_CO_LIST.
 543    RETURNS_UNCONSTRAINED is true if the function returns an unconstrained
 544    object.  RETURNS_BY_REF is true if the function returns by reference.
 545    RETURNS_BY_TARGET_PTR is true if the function is to be passed (as its
 546    first parameter) the address of the place to copy its result.  */
 547 extern tree create_subprog_type (tree return_type, tree param_decl_list,
 548                                  tree cico_list, bool returns_unconstrained,
 549                                  bool returns_by_ref,
 550                                  bool returns_by_target_ptr);
 551
 552 /* Return a copy of TYPE, but safe to modify in any way.  */
 553 extern tree copy_type (tree type);
 554
 555 /* Return a subtype of sizetype with range MIN to MAX and whose
 556    TYPE_INDEX_TYPE is INDEX.  GNAT_NODE is used for the position
 557    of the associated TYPE_DECL.  */
 558 extern tree create_index_type (tree min, tree max, tree index,
 559                                Node_Id gnat_node);
 560
 561 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
 562    TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
 563    its data type.  */
 564 extern tree create_type_stub_decl (tree type_name, tree type);
 565
 566 /* Return a TYPE_DECL node.  TYPE_NAME gives the name of the type and TYPE
 567    is a ..._TYPE node giving its data type.  ARTIFICIAL_P is true if this
 568    is a declaration that was generated by the compiler.  DEBUG_INFO_P is
 569    true if we need to write debug information about this type.  GNAT_NODE
 570    is used for the position of the decl.  */
 571 extern tree create_type_decl (tree type_name, tree type,
 572                               struct attrib *attr_list,
 573                               bool artificial_p, bool debug_info_p,
 574                               Node_Id gnat_node);
 575
 576 /* Return a VAR_DECL or CONST_DECL node.
 577
 578    VAR_NAME gives the name of the variable.  ASM_NAME is its assembler name
 579    (if provided).  TYPE is its data type (a GCC ..._TYPE node).  VAR_INIT is
 580    the GCC tree for an optional initial expression; NULL_TREE if none.
 581
 582    CONST_FLAG is true if this variable is constant, in which case we might
 583    return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
 584
 585    PUBLIC_FLAG is true if this definition is to be made visible outside of
 586    the current compilation unit. This flag should be set when processing the
 587    variable definitions in a package specification.
 588
 589    EXTERN_FLAG is nonzero when processing an external variable declaration (as
 590    opposed to a definition: no storage is to be allocated for the variable).
 591
 592    STATIC_FLAG is only relevant when not at top level.  In that case
 593    it indicates whether to always allocate storage to the variable.
 594
 595    GNAT_NODE is used for the position of the decl.  */
 596 extern tree
 597 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
 598                    bool const_flag, bool public_flag, bool extern_flag,
 599                    bool static_flag, bool const_decl_allowed_p,
 600                    struct attrib *attr_list, Node_Id gnat_node);
 601
 602 /* Wrapper around create_var_decl_1 for cases where we don't care whether
 603    a VAR or a CONST decl node is created.  */
 604 #define create_var_decl(var_name, asm_name, type, var_init,     \
 605                         const_flag, public_flag, extern_flag,   \
 606                         static_flag, attr_list, gnat_node)      \
 607   create_var_decl_1 (var_name, asm_name, type, var_init,        \
 608                      const_flag, public_flag, extern_flag,      \
 609                      static_flag, true, attr_list, gnat_node)
 610
 611 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
 612    required.  The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
 613    must be VAR_DECLs and on which we want TREE_READONLY set to have them
 614    possibly assigned to a readonly data section.  */
 615 #define create_true_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, false, attr_list, gnat_node)
 621
 622 /* Given a DECL and ATTR_LIST, apply the listed attributes.  */
 623 extern void process_attributes (tree decl, struct attrib *attr_list);
 624
 625 /* Record DECL as a global renaming pointer.  */
 626 extern void record_global_renaming_pointer (tree decl);
 627
 628 /* Invalidate the global renaming pointers.  */
 629 extern void invalidate_global_renaming_pointers (void);
 630
 631 /* Returns a FIELD_DECL node. FIELD_NAME the field name, FIELD_TYPE is its
 632    type, and RECORD_TYPE is the type of the parent.  PACKED is nonzero if
 633    this field is in a record type with a "pragma pack".  If SIZE is nonzero
 634    it is the specified size for this field.  If POS is nonzero, it is the bit
 635    position.  If ADDRESSABLE is nonzero, it means we are allowed to take
 636    the address of this field for aliasing purposes.  */
 637 extern tree create_field_decl (tree field_name, tree field_type,
 638                                tree record_type, int packed, tree size,
 639                                tree pos, int addressable);
 640
 641 /* Returns a PARM_DECL node. PARAM_NAME is the name of the parameter,
 642    PARAM_TYPE is its type.  READONLY is true if the parameter is
 643    readonly (either an In parameter or an address of a pass-by-ref
 644    parameter).  */
 645 extern tree create_param_decl (tree param_name, tree param_type,
 646                                bool readonly);
 647
 648 /* Returns a FUNCTION_DECL node.  SUBPROG_NAME is the name of the subprogram,
 649    ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
 650    node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
 651    PARM_DECL nodes chained through the TREE_CHAIN field).
 652
 653    INLINE_FLAG, PUBLIC_FLAG, EXTERN_FLAG, and ATTR_LIST are used to set the
 654    appropriate fields in the FUNCTION_DECL.  GNAT_NODE gives the location.  */
 655 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
 656                                  tree subprog_type, tree param_decl_list,
 657                                  bool inlinee_flag, bool public_flag,
 658                                  bool extern_flag,
 659                                  struct attrib *attr_list, Node_Id gnat_node);
 660
 661 /* Returns a LABEL_DECL node for LABEL_NAME.  */
 662 extern tree create_label_decl (tree label_name);
 663
 664 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
 665    body. This routine needs to be invoked before processing the declarations
 666    appearing in the subprogram.  */
 667 extern void begin_subprog_body (tree subprog_decl);
 668
 669 /* Finish the definition of the current subprogram BODY and compile it all the
 670    way to assembler language output.  ELAB_P tells if this is called for an
 671    elaboration routine, to be entirely discarded if empty.  */
 672 extern void end_subprog_body (tree body, bool elab_p);
 673
 674 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
 675    EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
 676    Return a constructor for the template.  */
 677 extern tree build_template (tree template_type, tree array_type, tree expr);
 678
 679 /* Build a 64bit VMS descriptor from a Mechanism_Type, which must specify
 680    a descriptor type, and the GCC type of an object.  Each FIELD_DECL
 681    in the type contains in its DECL_INITIAL the expression to use when
 682    a constructor is made for the type.  GNAT_ENTITY is a gnat node used
 683    to print out an error message if the mechanism cannot be applied to
 684    an object of that type and also for the name.  */
 685 extern tree build_vms_descriptor (tree type, Mechanism_Type mech,
 686                                   Entity_Id gnat_entity);
 687
 688 /* Build a 32bit VMS descriptor from a Mechanism_Type. See above.  */
 689 extern tree build_vms_descriptor32 (tree type, Mechanism_Type mech,
 690                                   Entity_Id gnat_entity);
 691
 692 /* Build a stub for the subprogram specified by the GCC tree GNU_SUBPROG
 693    and the GNAT node GNAT_SUBPROG.  */
 694 extern void build_function_stub (tree gnu_subprog, Entity_Id gnat_subprog);
 695
 696 /* Build a type to be used to represent an aliased object whose nominal
 697    type is an unconstrained array.  This consists of a RECORD_TYPE containing
 698    a field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an
 699    ARRAY_TYPE.  If ARRAY_TYPE is that of the unconstrained array, this
 700    is used to represent an arbitrary unconstrained object.  Use NAME
 701    as the name of the record.  */
 702 extern tree build_unc_object_type (tree template_type, tree object_type,
 703                                    tree name);
 704
 705 /* Same as build_unc_object_type, but taking a thin or fat pointer type
 706    instead of the template type.  */
 707 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
 708                                             tree object_type, tree name);
 709
 710 /* Shift the component offsets within an unconstrained object TYPE to make it
 711    suitable for use as a designated type for thin pointers.  */
 712 extern void shift_unc_components_for_thin_pointers (tree type);
 713
 714 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE.  In
 715    the normal case this is just two adjustments, but we have more to do
 716    if NEW is an UNCONSTRAINED_ARRAY_TYPE.  */
 717 extern void update_pointer_to (tree old_type, tree new_type);
 718
 719 /* EXP is an expression for the size of an object.  If this size contains
 720    discriminant references, replace them with the maximum (if MAX_P) or
 721    minimum (if !MAX_P) possible value of the discriminant.  */
 722 extern tree max_size (tree exp, bool max_p);
 723
 724 /* Remove all conversions that are done in EXP.  This includes converting
 725    from a padded type or to a left-justified modular type.  If TRUE_ADDRESS
 726    is true, always return the address of the containing object even if
 727    the address is not bit-aligned.  */
 728 extern tree remove_conversions (tree exp, bool true_address);
 729
 730 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
 731    refers to the underlying array.  If its type has TYPE_CONTAINS_TEMPLATE_P,
 732    likewise return an expression pointing to the underlying array.  */
 733 extern tree maybe_unconstrained_array (tree exp);
 734
 735 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
 736    If NOTRUNC_P is true, truncation operations should be suppressed.  */
 737 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
 738
 739 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
 740    the latter being a record type as predicated by Is_Record_Type.  */
 741 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
 742
 743 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
 744    size is equal to 64 bits, or an array of such a type.  Set ALIGN_CLAUSE
 745    according to the presence of an alignment clause on the type or, if it
 746    is an array, on the component type.  */
 747 extern bool is_double_float_or_array (Entity_Id gnat_type,
 748                                       bool *align_clause);
 749
 750 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
 751    size is greater or equal to 64 bits, or an array of such a type.  Set
 752    ALIGN_CLAUSE according to the presence of an alignment clause on the
 753    type or, if it is an array, on the component type.  */
 754 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
 755                                        bool *align_clause);
 756
 757 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
 758    component of an aggregate type.  */
 759 extern bool type_for_nonaliased_component_p (tree gnu_type);
 760
 761 /* Prepare expr to be an argument of a TRUTH_NOT_EXPR or other logical
 762    operation.
 763
 764    This preparation consists of taking the ordinary
 765    representation of an expression EXPR and producing a valid tree
 766    boolean expression describing whether EXPR is nonzero.  We could
 767    simply always do build_binary_op (NE_EXPR, expr, integer_zero_node, 1),
 768    but we optimize comparisons, &&, ||, and !.
 769
 770    The resulting type should always be the same as the input type.
 771    This function is simpler than the corresponding C version since
 772    the only possible operands will be things of Boolean type.  */
 773 extern tree gnat_truthvalue_conversion (tree expr);
 774
 775 /* Return the base type of TYPE.  */
 776 extern tree get_base_type (tree type);
 777
 778 /* EXP is a GCC tree representing an address.  See if we can find how
 779    strictly the object at that address is aligned.   Return that alignment
 780    strictly the object at that address is aligned.   Return that alignment
 781    in bits.  If we don't know anything about the alignment, return 0.  */
 782 extern unsigned int known_alignment (tree exp);
 783
 784 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
 785    of 2.  */
 786 extern bool value_factor_p (tree value, HOST_WIDE_INT factor);
 787
 788 /* Make a binary operation of kind OP_CODE.  RESULT_TYPE is the type
 789    desired for the result.  Usually the operation is to be performed
 790    in that type.  For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
 791    in which case the type to be used will be derived from the operands.  */
 792 extern tree build_binary_op (enum tree_code op_code, tree result_type,
 793                              tree left_operand, tree right_operand);
 794
 795 /* Similar, but make unary operation.  */
 796 extern tree build_unary_op (enum tree_code op_code, tree result_type,
 797                             tree operand);
 798
 799 /* Similar, but for COND_EXPR.  */
 800 extern tree build_cond_expr (tree result_type, tree condition_operand,
 801                              tree true_operand, tree false_operand);
 802
 803 /* Similar, but for RETURN_EXPR.  */
 804 extern tree build_return_expr (tree result_decl, tree ret_val);
 805
 806 /* Build a CALL_EXPR to call FUNDECL with one argument, ARG.  Return
 807    the CALL_EXPR.  */
 808 extern tree build_call_1_expr (tree fundecl, tree arg);
 809
 810 /* Build a CALL_EXPR to call FUNDECL with two argument, ARG1 & ARG2.  Return
 811    the CALL_EXPR.  */
 812 extern tree build_call_2_expr (tree fundecl, tree arg1, tree arg2);
 813
 814 /* Likewise to call FUNDECL with no arguments.  */
 815 extern tree build_call_0_expr (tree fundecl);
 816
 817 /* Call a function that raises an exception and pass the line number and file
 818    name, if requested.  MSG says which exception function to call.
 819
 820    GNAT_NODE is the gnat node conveying the source location for which the
 821    error should be signaled, or Empty in which case the error is signaled on
 822    the current ref_file_name/input_line.
 823
 824    KIND says which kind of exception this is for
 825     (N_Raise_{Constraint,Storage,Program}_Error).  */
 826 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
 827
 828 /* Return a CONSTRUCTOR of TYPE whose list is LIST.  This is not the
 829    same as build_constructor in the language-independent tree.c.  */
 830 extern tree gnat_build_constructor (tree type, tree list);
 831
 832 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
 833    an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
 834    for the field, or both.  Don't fold the result if NO_FOLD_P.  */
 835 extern tree build_component_ref (tree record_variable, tree component,
 836                                  tree field, bool no_fold_p);
 837
 838 /* Build a GCC tree to call an allocation or deallocation function.
 839    If GNU_OBJ is nonzero, it is an object to deallocate.  Otherwise,
 840    generate an allocator.
 841
 842    GNU_SIZE is the size of the object in bytes and ALIGN is the alignment
 843    in bits.  GNAT_PROC, if present, is a procedure to call and GNAT_POOL
 844    is the storage pool to use.  If not present, malloc and free are used.
 845    GNAT_NODE is used to provide an error location for restriction violation
 846    messages.  */
 847 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
 848                                       unsigned align, Entity_Id gnat_proc,
 849                                       Entity_Id gnat_pool, Node_Id gnat_node);
 850
 851 /* Build a GCC tree to correspond to allocating an object of TYPE whose
 852    initial value if INIT, if INIT is nonzero.  Convert the expression to
 853    RESULT_TYPE, which must be some type of pointer.  Return the tree.
 854
 855    GNAT_PROC and GNAT_POOL optionally give the procedure to call and
 856    the storage pool to use.  GNAT_NODE is used to provide an error
 857    location for restriction violation messages.  If IGNORE_INIT_TYPE is
 858    true, ignore the type of INIT for the purpose of determining the size;
 859    this will cause the maximum size to be allocated if TYPE is of
 860    self-referential size.  */
 861 extern tree build_allocator (tree type, tree init, tree result_type,
 862                              Entity_Id gnat_proc, Entity_Id gnat_pool,
 863                              Node_Id gnat_node, bool);
 864
 865 /* Fill in a VMS descriptor for EXPR and return a constructor for it.
 866    GNAT_FORMAL is how we find the descriptor record. GNAT_ACTUAL is how
 867    we derive the source location on a C_E */
 868 extern tree fill_vms_descriptor (tree expr, Entity_Id gnat_formal,
 869                                  Node_Id gnat_actual);
 870
 871 /* Indicate that we need to make the address of EXPR_NODE and it therefore
 872    should not be allocated in a register.  Return true if successful.  */
 873 extern bool gnat_mark_addressable (tree expr_node);
 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