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