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-2015, 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 /* Start a new statement group chained to the previous group.  */
  55 extern void start_stmt_group (void);
  56
  57 /* Add GNU_STMT to the current statement group.  If it is an expression with
  58    no effects, it is ignored.  */
  59 extern void add_stmt (tree gnu_stmt);
  60
  61 /* Similar, but the statement is always added, regardless of side-effects.  */
  62 extern void add_stmt_force (tree gnu_stmt);
  63
  64 /* Like add_stmt, but set the location of GNU_STMT to that of GNAT_NODE.  */
  65 extern void add_stmt_with_node (tree gnu_stmt, Node_Id gnat_node);
  66
  67 /* Similar, but the statement is always added, regardless of side-effects.  */
  68 extern void add_stmt_with_node_force (tree gnu_stmt, Node_Id gnat_node);
  69
  70 /* Return code corresponding to the current code group.  It is normally
  71    a STATEMENT_LIST, but may also be a BIND_EXPR or TRY_FINALLY_EXPR if
  72    BLOCK or cleanups were set.  */
  73 extern tree end_stmt_group (void);
  74
  75 /* Set the BLOCK node corresponding to the current code group to GNU_BLOCK.  */
  76 extern void set_block_for_group (tree);
  77
  78 /* Add a declaration statement for GNU_DECL to the current BLOCK_STMT node.
  79    Get SLOC from GNAT_ENTITY.  */
  80 extern void add_decl_expr (tree gnu_decl, Entity_Id gnat_entity);
  81
  82 /* Mark nodes rooted at T with TREE_VISITED and types as having their
  83    sized gimplified.  We use this to indicate all variable sizes and
  84    positions in global types may not be shared by any subprogram.  */
  85 extern void mark_visited (tree t);
  86
  87 /* This macro calls the above function but short-circuits the common
  88    case of a constant to save time and also checks for NULL.  */
  89
  90 #define MARK_VISITED(EXP)               \
  91 do {                                    \
  92   if((EXP) && !CONSTANT_CLASS_P (EXP))  \
  93     mark_visited (EXP);                 \
  94 } while (0)
  95
  96 /* Finalize the processing of From_Limited_With incomplete types.  */
  97 extern void finalize_from_limited_with (void);
  98
  99 /* Return the equivalent type to be used for GNAT_ENTITY, if it's a
 100    kind of type (such E_Task_Type) that has a different type which Gigi
 101    uses for its representation.  If the type does not have a special type
 102    for its representation, return GNAT_ENTITY.  If a type is supposed to
 103    exist, but does not, abort unless annotating types, in which case
 104    return Empty.   If GNAT_ENTITY is Empty, return Empty.  */
 105 extern Entity_Id Gigi_Equivalent_Type (Entity_Id gnat_entity);
 106
 107 /* Given GNAT_ENTITY, elaborate all expressions that are required to
 108    be elaborated at the point of its definition, but do nothing else.  */
 109 extern void elaborate_entity (Entity_Id gnat_entity);
 110
 111 /* Get the unpadded version of a GNAT type.  */
 112 extern tree get_unpadded_type (Entity_Id gnat_entity);
 113
 114 /* Return the DECL associated with the public subprogram GNAT_ENTITY but whose
 115    type has been changed to that of the parameterless procedure, except if an
 116    alias is already present, in which case it is returned instead.  */
 117 extern tree get_minimal_subprog_decl (Entity_Id gnat_entity);
 118
 119 /* Return whether the E_Subprogram_Type/E_Function/E_Procedure GNAT_ENTITY is
 120    a C++ imported method or equivalent.  */
 121 extern bool is_cplusplus_method (Entity_Id gnat_entity);
 122
 123 /* Create a record type that contains a SIZE bytes long field of TYPE with a
 124     starting bit position so that it is aligned to ALIGN bits, and leaving at
 125     least ROOM bytes free before the field.  BASE_ALIGN is the alignment the
 126     record is guaranteed to get.  GNAT_NODE is used for the position of the
 127     associated TYPE_DECL.  */
 128 extern tree make_aligning_type (tree type, unsigned int align, tree size,
 129                                 unsigned int base_align, int room, Node_Id);
 130
 131 /* TYPE is a RECORD_TYPE, UNION_TYPE or QUAL_UNION_TYPE that is being used
 132    as the field type of a packed record if IN_RECORD is true, or as the
 133    component type of a packed array if IN_RECORD is false.  See if we can
 134    rewrite it either as a type that has a non-BLKmode, which we can pack
 135    tighter in the packed record case, or as a smaller type.  If so, return
 136    the new type.  If not, return the original type.  */
 137 extern tree make_packable_type (tree type, bool in_record);
 138
 139 /* Given a type TYPE, return a new type whose size is appropriate for SIZE.
 140    If TYPE is the best type, return it.  Otherwise, make a new type.  We
 141    only support new integral and pointer types.  FOR_BIASED is true if
 142    we are making a biased type.  */
 143 extern tree make_type_from_size (tree type, tree size_tree, bool for_biased);
 144
 145 /* Ensure that TYPE has SIZE and ALIGN.  Make and return a new padded type
 146    if needed.  We have already verified that SIZE and ALIGN are large enough.
 147    GNAT_ENTITY is used to name the resulting record and to issue a warning.
 148    IS_COMPONENT_TYPE is true if this is being done for the component type of
 149    an array.  IS_USER_TYPE is true if the original type needs to be completed.
 150    DEFINITION is true if this type is being defined.  SET_RM_SIZE is true if
 151    the RM size of the resulting type is to be set to SIZE too.  */
 152 extern tree maybe_pad_type (tree type, tree size, unsigned int align,
 153                             Entity_Id gnat_entity, bool is_component_type,
 154                             bool is_user_type, bool definition,
 155                             bool set_rm_size);
 156
 157 enum alias_set_op
 158 {
 159   ALIAS_SET_COPY,
 160   ALIAS_SET_SUBSET,
 161   ALIAS_SET_SUPERSET
 162 };
 163
 164 /* Relate the alias sets of GNU_NEW_TYPE and GNU_OLD_TYPE according to OP.
 165    If this is a multi-dimensional array type, do this recursively.
 166
 167    OP may be
 168    - ALIAS_SET_COPY:     the new set is made a copy of the old one.
 169    - ALIAS_SET_SUPERSET: the new set is made a superset of the old one.
 170    - ALIAS_SET_SUBSET:   the new set is made a subset of the old one.  */
 171 extern void relate_alias_sets (tree gnu_new_type, tree gnu_old_type,
 172                                enum alias_set_op op);
 173
 174 /* Given a GNU tree and a GNAT list of choices, generate an expression to test
 175    the value passed against the list of choices.  */
 176 extern tree choices_to_gnu (tree operand, Node_Id choices);
 177
 178 /* Given GNAT_ENTITY, an object (constant, variable, parameter, exception)
 179    and GNU_TYPE, its corresponding GCC type, set Esize and Alignment to the
 180    size and alignment used by Gigi.  Prefer SIZE over TYPE_SIZE if non-null.
 181    BY_REF is true if the object is used by reference.  */
 182 extern void annotate_object (Entity_Id gnat_entity, tree gnu_type, tree size,
 183                              bool by_ref);
 184
 185 /* Return the variant part of RECORD_TYPE, if any.  Otherwise return NULL.  */
 186 extern tree get_variant_part (tree record_type);
 187
 188 /* Given a type T, a FIELD_DECL F, and a replacement value R, return a new
 189    type with all size expressions that contain F updated by replacing F
 190    with R.  If F is NULL_TREE, always make a new RECORD_TYPE, even if
 191    nothing has changed.  */
 192 extern tree substitute_in_type (tree t, tree f, tree r);
 193
 194 /* Return the RM size of GNU_TYPE.  This is the actual number of bits
 195    needed to represent the object.  */
 196 extern tree rm_size (tree gnu_type);
 197
 198 /* Return the name to be used for GNAT_ENTITY.  If a type, create a
 199    fully-qualified name, possibly with type information encoding.
 200    Otherwise, return the name.  */
 201 extern tree get_entity_name (Entity_Id gnat_entity);
 202
 203 /* Return an identifier representing the external name to be used for
 204    GNAT_ENTITY.  If SUFFIX is specified, the name is followed by "___"
 205    and the specified suffix.  */
 206 extern tree create_concat_name (Entity_Id gnat_entity, const char *suffix);
 207
 208 /* Given GNU_NAME, an IDENTIFIER_NODE containing a name and SUFFIX, a
 209    string, return a new IDENTIFIER_NODE that is the concatenation of
 210    the name followed by "___" and the specified suffix.  */
 211 extern tree concat_name (tree gnu_name, const char *suffix);
 212
 213 /* Initialize data structures of the decl.c module.  */
 214 extern void init_gnat_decl (void);
 215
 216 /* Destroy data structures of the decl.c module.  */
 217 extern void destroy_gnat_decl (void);
 218
 219 /* Highest number in the front-end node table.  */
 220 extern int max_gnat_nodes;
 221
 222 /* Current node being treated, in case abort called.  */
 223 extern Node_Id error_gnat_node;
 224
 225 /* True when gigi is being called on an analyzed but unexpanded
 226    tree, and the only purpose of the call is to properly annotate
 227    types with representation information.  */
 228 extern bool type_annotate_only;
 229
 230 /* Current file name without path.  */
 231 extern const char *ref_filename;
 232
 233 /* This structure must be kept synchronized with Call_Back_End.  */
 234 struct File_Info_Type
 235 {
 236   File_Name_Type File_Name;
 237   Instance_Id    Instance;
 238   Nat            Num_Source_Lines;
 239 };
 240
 241 #ifdef __cplusplus
 242 extern "C" {
 243 #endif
 244
 245 /* This is the main program of the back-end.  It sets up all the table
 246    structures and then generates code.  */
 247 extern void gigi (Node_Id gnat_root,
 248                   int max_gnat_node,
 249                   int number_name ATTRIBUTE_UNUSED,
 250                   struct Node *nodes_ptr,
 251                   struct Flags *Flags_Ptr,
 252                   Node_Id *next_node_ptr,
 253                   Node_Id *prev_node_ptr,
 254                   struct Elist_Header *elists_ptr,
 255                   struct Elmt_Item *elmts_ptr,
 256                   struct String_Entry *strings_ptr,
 257                   Char_Code *strings_chars_ptr,
 258                   struct List_Header *list_headers_ptr,
 259                   Nat number_file,
 260                   struct File_Info_Type *file_info_ptr,
 261                   Entity_Id standard_boolean,
 262                   Entity_Id standard_integer,
 263                   Entity_Id standard_character,
 264                   Entity_Id standard_long_long_float,
 265                   Entity_Id standard_exception_type,
 266                   Int gigi_operating_mode);
 267
 268 #ifdef __cplusplus
 269 }
 270 #endif
 271
 272 /* GNAT_NODE is the root of some GNAT tree.  Return the root of the
 273    GCC tree corresponding to that GNAT tree.  Normally, no code is generated;
 274    we just return an equivalent tree which is used elsewhere to generate
 275    code.  */
 276 extern tree gnat_to_gnu (Node_Id gnat_node);
 277
 278 /* GNU_STMT is a statement.  We generate code for that statement.  */
 279 extern void gnat_expand_stmt (tree gnu_stmt);
 280
 281 /* Generate GIMPLE in place for the expression at *EXPR_P.  */
 282 extern int gnat_gimplify_expr (tree *expr_p, gimple_seq *pre_p,
 283                                gimple_seq *post_p ATTRIBUTE_UNUSED);
 284
 285 /* Do the processing for the declaration of a GNAT_ENTITY, a type.  If
 286    a separate Freeze node exists, delay the bulk of the processing.  Otherwise
 287    make a GCC type for GNAT_ENTITY and set up the correspondence.  */
 288 extern void process_type (Entity_Id gnat_entity);
 289
 290 /* Convert SLOC into LOCUS.  Return true if SLOC corresponds to a source code
 291    location and false if it doesn't.  In the former case, set the Gigi global
 292    variable REF_FILENAME to the simple debug file name as given by sinput.  */
 293 extern bool Sloc_to_locus (Source_Ptr Sloc, location_t *locus);
 294
 295 /* Post an error message.  MSG is the error message, properly annotated.
 296    NODE is the node at which to post the error and the node to use for the
 297    '&' substitution.  */
 298 extern void post_error (const char *msg, Node_Id node);
 299
 300 /* Similar to post_error, but NODE is the node at which to post the error and
 301    ENT is the node to use for the '&' substitution.  */
 302 extern void post_error_ne (const char *msg, Node_Id node, Entity_Id ent);
 303
 304 /* Similar to post_error_ne, but NUM is the number to use for the '^'.  */
 305 extern void post_error_ne_num (const char *msg, Node_Id node, Entity_Id ent,
 306                                int num);
 307
 308 /* Similar to post_error_ne, but T is a GCC tree representing the number to
 309    write.  If T represents a constant, the text inside curly brackets in
 310    MSG will be output (presumably including a '^').  Otherwise it will not
 311    be output and the text inside square brackets will be output instead.  */
 312 extern void post_error_ne_tree (const char *msg, Node_Id node, Entity_Id ent,
 313                                 tree t);
 314
 315 /* Similar to post_error_ne_tree, but NUM is a second integer to write.  */
 316 extern void post_error_ne_tree_2 (const char *msg, Node_Id node, Entity_Id ent,
 317                                   tree t, int num);
 318
 319 /* Return a label to branch to for the exception type in KIND or NULL_TREE
 320    if none.  */
 321 extern tree get_exception_label (char kind);
 322
 323 /* Return the decl for the current elaboration procedure.  */
 324 extern tree get_elaboration_procedure (void);
 325
 326 /* If nonzero, pretend we are allocating at global level.  */
 327 extern int force_global;
 328
 329 /* The default alignment of "double" floating-point types, i.e. floating
 330    point types whose size is equal to 64 bits, or 0 if this alignment is
 331    not specifically capped.  */
 332 extern int double_float_alignment;
 333
 334 /* The default alignment of "double" or larger scalar types, i.e. scalar
 335    types whose size is greater or equal to 64 bits, or 0 if this alignment
 336    is not specifically capped.  */
 337 extern int double_scalar_alignment;
 338
 339 /* True if floating-point arithmetics may use wider intermediate results.  */
 340 extern bool fp_arith_may_widen;
 341 \f
 342 /* Data structures used to represent attributes.  */
 343
 344 enum attr_type
 345 {
 346   ATTR_MACHINE_ATTRIBUTE,
 347   ATTR_LINK_ALIAS,
 348   ATTR_LINK_SECTION,
 349   ATTR_LINK_CONSTRUCTOR,
 350   ATTR_LINK_DESTRUCTOR,
 351   ATTR_THREAD_LOCAL_STORAGE,
 352   ATTR_WEAK_EXTERNAL
 353 };
 354
 355 struct attrib
 356 {
 357   struct attrib *next;
 358   enum attr_type type;
 359   tree name;
 360   tree args;
 361   Node_Id error_point;
 362 };
 363
 364 /* Table of machine-independent internal attributes.  */
 365 extern const struct attribute_spec gnat_internal_attribute_table[];
 366
 367 /* Define the entries in the standard data array.  */
 368 enum standard_datatypes
 369 {
 370   /* The longest floating-point type.  */
 371   ADT_longest_float_type,
 372
 373   /* The type of an exception.  */
 374   ADT_except_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   /* Value 1 in signed bitsizetype.  */
 389   ADT_sbitsize_one_node,
 390
 391   /* Value BITS_PER_UNIT in signed bitsizetype.  */
 392   ADT_sbitsize_unit_node,
 393
 394   /* Function declaration nodes for run-time functions for allocating memory.
 395      Ada allocators cause calls to this function to be generated.  */
 396   ADT_malloc_decl,
 397
 398   /* Likewise for freeing memory.  */
 399   ADT_free_decl,
 400
 401   /* Function decl node for 64-bit multiplication with overflow checking.  */
 402   ADT_mulv64_decl,
 403
 404   /* Identifier for the name of the _Parent field in tagged record types.  */
 405   ADT_parent_name_id,
 406
 407   /* Identifier for the name of the Exception_Data type.  */
 408   ADT_exception_data_name_id,
 409
 410   /* Types and decls used by our temporary exception mechanism.  See
 411      init_gigi_decls for details.  */
 412   ADT_jmpbuf_type,
 413   ADT_jmpbuf_ptr_type,
 414   ADT_get_jmpbuf_decl,
 415   ADT_set_jmpbuf_decl,
 416   ADT_get_excptr_decl,
 417   ADT_setjmp_decl,
 418   ADT_longjmp_decl,
 419   ADT_update_setjmp_buf_decl,
 420   ADT_raise_nodefer_decl,
 421   ADT_reraise_zcx_decl,
 422   ADT_set_exception_parameter_decl,
 423   ADT_begin_handler_decl,
 424   ADT_end_handler_decl,
 425   ADT_unhandled_except_decl,
 426   ADT_others_decl,
 427   ADT_all_others_decl,
 428   ADT_unhandled_others_decl,
 429   ADT_LAST};
 430
 431 /* Define kind of exception information associated with raise statements.  */
 432 enum exception_info_kind
 433 {
 434   /* Simple exception information: file:line.  */
 435   exception_simple,
 436   /* Range exception information: file:line + index, first, last.  */
 437   exception_range,
 438   /* Column exception information: file:line:column.  */
 439   exception_column
 440 };
 441
 442 /* Define the inline status of a subprogram.  */
 443 enum inline_status_t
 444 {
 445   /* Inlining is suppressed for the subprogram.  */
 446   is_suppressed,
 447   /* No inlining is requested for the subprogram.  */
 448   is_disabled,
 449   /* Inlining is requested for the subprogram.  */
 450   is_enabled,
 451   /* Inlining is required for the subprogram.  */
 452   is_required
 453 };
 454
 455 extern GTY(()) tree gnat_std_decls[(int) ADT_LAST];
 456 extern GTY(()) tree gnat_raise_decls[(int) LAST_REASON_CODE + 1];
 457 extern GTY(()) tree gnat_raise_decls_ext[(int) LAST_REASON_CODE + 1];
 458
 459 #define longest_float_type_node gnat_std_decls[(int) ADT_longest_float_type]
 460 #define except_type_node gnat_std_decls[(int) ADT_except_type]
 461 #define void_ftype gnat_std_decls[(int) ADT_void_ftype]
 462 #define ptr_void_ftype gnat_std_decls[(int) ADT_ptr_void_ftype]
 463 #define fdesc_type_node gnat_std_decls[(int) ADT_fdesc_type]
 464 #define null_fdesc_node gnat_std_decls[(int) ADT_null_fdesc]
 465 #define sbitsize_one_node gnat_std_decls[(int) ADT_sbitsize_one_node]
 466 #define sbitsize_unit_node gnat_std_decls[(int) ADT_sbitsize_unit_node]
 467 #define malloc_decl gnat_std_decls[(int) ADT_malloc_decl]
 468 #define free_decl gnat_std_decls[(int) ADT_free_decl]
 469 #define mulv64_decl gnat_std_decls[(int) ADT_mulv64_decl]
 470 #define parent_name_id gnat_std_decls[(int) ADT_parent_name_id]
 471 #define exception_data_name_id gnat_std_decls[(int) ADT_exception_data_name_id]
 472 #define jmpbuf_type gnat_std_decls[(int) ADT_jmpbuf_type]
 473 #define jmpbuf_ptr_type gnat_std_decls[(int) ADT_jmpbuf_ptr_type]
 474 #define get_jmpbuf_decl gnat_std_decls[(int) ADT_get_jmpbuf_decl]
 475 #define set_jmpbuf_decl gnat_std_decls[(int) ADT_set_jmpbuf_decl]
 476 #define get_excptr_decl gnat_std_decls[(int) ADT_get_excptr_decl]
 477 #define setjmp_decl gnat_std_decls[(int) ADT_setjmp_decl]
 478 #define longjmp_decl gnat_std_decls[(int) ADT_longjmp_decl]
 479 #define update_setjmp_buf_decl gnat_std_decls[(int) ADT_update_setjmp_buf_decl]
 480 #define raise_nodefer_decl gnat_std_decls[(int) ADT_raise_nodefer_decl]
 481 #define reraise_zcx_decl gnat_std_decls[(int) ADT_reraise_zcx_decl]
 482 #define set_exception_parameter_decl \
 483           gnat_std_decls[(int) ADT_set_exception_parameter_decl]
 484 #define begin_handler_decl gnat_std_decls[(int) ADT_begin_handler_decl]
 485 #define others_decl gnat_std_decls[(int) ADT_others_decl]
 486 #define all_others_decl gnat_std_decls[(int) ADT_all_others_decl]
 487 #define unhandled_others_decl gnat_std_decls[(int) ADT_unhandled_others_decl]
 488 #define end_handler_decl gnat_std_decls[(int) ADT_end_handler_decl]
 489 #define unhandled_except_decl gnat_std_decls[(int) ADT_unhandled_except_decl]
 490
 491 /* Routines expected by the gcc back-end. They must have exactly the same
 492    prototype and names as below.  */
 493
 494 /* Return true if we are in the global binding level.  */
 495 extern bool global_bindings_p (void);
 496
 497 /* Enter and exit a new binding level.  */
 498 extern void gnat_pushlevel (void);
 499 extern void gnat_poplevel (void);
 500 extern void gnat_zaplevel (void);
 501
 502 /* Set SUPERCONTEXT of the BLOCK for the current binding level to FNDECL
 503    and point FNDECL to this BLOCK.  */
 504 extern void set_current_block_context (tree fndecl);
 505
 506 /* Set the jmpbuf_decl for the current binding level to DECL.  */
 507 extern void set_block_jmpbuf_decl (tree decl);
 508
 509 /* Get the setjmp_decl, if any, for the current binding level.  */
 510 extern tree get_block_jmpbuf_decl (void);
 511
 512 /* Record DECL as belonging to the current lexical scope and use GNAT_NODE
 513    for location information and flag propagation.  */
 514 extern void gnat_pushdecl (tree decl, Node_Id gnat_node);
 515
 516 /* Initialize the GCC support for exception handling.  */
 517 extern void gnat_init_gcc_eh (void);
 518
 519 /* Initialize the GCC support for floating-point operations.  */
 520 extern void gnat_init_gcc_fp (void);
 521
 522 /* Install the builtin functions we might need.  */
 523 extern void gnat_install_builtins (void);
 524
 525 /* Return an integer type with the number of bits of precision given by
 526    PRECISION.  UNSIGNEDP is nonzero if the type is unsigned; otherwise
 527    it is a signed type.  */
 528 extern tree gnat_type_for_size (unsigned precision, int unsignedp);
 529
 530 /* Return a data type that has machine mode MODE.  UNSIGNEDP selects
 531    an unsigned type; otherwise a signed type is returned.  */
 532 extern tree gnat_type_for_mode (machine_mode mode, int unsignedp);
 533
 534 /* Emit debug info for all global variable declarations.  */
 535 extern void gnat_write_global_declarations (void);
 536
 537 /* Return the unsigned version of a TYPE_NODE, a scalar type.  */
 538 extern tree gnat_unsigned_type (tree type_node);
 539
 540 /* Return the signed version of a TYPE_NODE, a scalar type.  */
 541 extern tree gnat_signed_type (tree type_node);
 542
 543 /* Return 1 if the types T1 and T2 are compatible, i.e. if they can be
 544    transparently converted to each other.  */
 545 extern int gnat_types_compatible_p (tree t1, tree t2);
 546
 547 /* Return true if EXPR is a useless type conversion.  */
 548 extern bool gnat_useless_type_conversion (tree expr);
 549
 550 /* Return true if T, a FUNCTION_TYPE, has the specified list of flags.  */
 551 extern bool fntype_same_flags_p (const_tree, tree, bool, bool, bool);
 552
 553 /* Create an expression whose value is that of EXPR,
 554    converted to type TYPE.  The TREE_TYPE of the value
 555    is always TYPE.  This function implements all reasonable
 556    conversions; callers should filter out those that are
 557    not permitted by the language being compiled.  */
 558 extern tree convert (tree type, tree expr);
 559
 560 /* Create an expression whose value is that of EXPR converted to the common
 561    index type, which is sizetype.  */
 562 extern tree convert_to_index_type (tree expr);
 563
 564 /* Routines created solely for the tree translator's sake. Their prototypes
 565    can be changed as desired.  */
 566
 567 /* Initialize data structures of the utils.c module.  */
 568 extern void init_gnat_utils (void);
 569
 570 /* Destroy data structures of the utils.c module.  */
 571 extern void destroy_gnat_utils (void);
 572
 573 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
 574    GNU_DECL is the GCC tree which is to be associated with
 575    GNAT_ENTITY. Such gnu tree node is always an ..._DECL node.
 576    If NO_CHECK is nonzero, the latter check is suppressed.
 577    If GNU_DECL is zero, a previous association is to be reset.  */
 578 extern void save_gnu_tree (Entity_Id gnat_entity, tree gnu_decl,
 579                            bool no_check);
 580
 581 /* GNAT_ENTITY is a GNAT tree node for a defining identifier.
 582    Return the ..._DECL node that was associated with it.  If there is no tree
 583    node associated with GNAT_ENTITY, abort.  */
 584 extern tree get_gnu_tree (Entity_Id gnat_entity);
 585
 586 /* Return nonzero if a GCC tree has been associated with GNAT_ENTITY.  */
 587 extern bool present_gnu_tree (Entity_Id gnat_entity);
 588
 589 /* Make a dummy type corresponding to GNAT_TYPE.  */
 590 extern tree make_dummy_type (Entity_Id gnat_type);
 591
 592 /* Return the dummy type that was made for GNAT_TYPE, if any.  */
 593 extern tree get_dummy_type (Entity_Id gnat_type);
 594
 595 /* Build dummy fat and thin pointer types whose designated type is specified
 596    by GNAT_DESIG_TYPE/GNU_DESIG_TYPE and attach them to the latter.  */
 597 extern void build_dummy_unc_pointer_types (Entity_Id gnat_desig_type,
 598                                            tree gnu_desig_type);
 599
 600 /* Record TYPE as a builtin type for Ada.  NAME is the name of the type.
 601    ARTIFICIAL_P is true if it's a type that was generated by the compiler.  */
 602 extern void record_builtin_type (const char *name, tree type,
 603                                  bool artificial_p);
 604
 605 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
 606    finish constructing the record type as a fat pointer type.  */
 607 extern void finish_fat_pointer_type (tree record_type, tree field_list);
 608
 609 /* Given a record type RECORD_TYPE and a list of FIELD_DECL nodes FIELD_LIST,
 610    finish constructing the record or union type.  If REP_LEVEL is zero, this
 611    record has no representation clause and so will be entirely laid out here.
 612    If REP_LEVEL is one, this record has a representation clause and has been
 613    laid out already; only set the sizes and alignment.  If REP_LEVEL is two,
 614    this record is derived from a parent record and thus inherits its layout;
 615    only make a pass on the fields to finalize them.  DEBUG_INFO_P is true if
 616    we need to write debug information about this type.  */
 617 extern void finish_record_type (tree record_type, tree field_list,
 618                                 int rep_level, bool debug_info_p);
 619
 620 /* Wrap up compilation of RECORD_TYPE, i.e. output all the debug information
 621    associated with it.  It need not be invoked directly in most cases since
 622    finish_record_type takes care of doing so, but this can be necessary if
 623    a parallel type is to be attached to the record type.  */
 624 extern void rest_of_record_type_compilation (tree record_type);
 625
 626 /* Append PARALLEL_TYPE on the chain of parallel types for TYPE.  */
 627 extern void add_parallel_type (tree type, tree parallel_type);
 628
 629 /* Return a FUNCTION_TYPE node.  RETURN_TYPE is the type returned by the
 630    subprogram.  If it is VOID_TYPE, then we are dealing with a procedure,
 631    otherwise we are dealing with a function.  PARAM_DECL_LIST is a list of
 632    PARM_DECL nodes that are the subprogram parameters.  CICO_LIST is the
 633    copy-in/copy-out list to be stored into the TYPE_CICO_LIST field.
 634    RETURN_UNCONSTRAINED_P is true if the function returns an unconstrained
 635    object.  RETURN_BY_DIRECT_REF_P is true if the function returns by direct
 636    reference.  RETURN_BY_INVISI_REF_P is true if the function returns by
 637    invisible reference.  */
 638 extern tree create_subprog_type (tree return_type, tree param_decl_list,
 639                                  tree cico_list, bool return_unconstrained_p,
 640                                  bool return_by_direct_ref_p,
 641                                  bool return_by_invisi_ref_p);
 642
 643 /* Return a copy of TYPE, but safe to modify in any way.  */
 644 extern tree copy_type (tree type);
 645
 646 /* Return a subtype of sizetype with range MIN to MAX and whose
 647    TYPE_INDEX_TYPE is INDEX.  GNAT_NODE is used for the position
 648    of the associated TYPE_DECL.  */
 649 extern tree create_index_type (tree min, tree max, tree index,
 650                                Node_Id gnat_node);
 651
 652 /* Return a subtype of TYPE with range MIN to MAX.  If TYPE is NULL,
 653    sizetype is used.  */
 654 extern tree create_range_type (tree type, tree min, tree max);
 655
 656 /* Return a TYPE_DECL node suitable for the TYPE_STUB_DECL field of a type.
 657    TYPE_NAME gives the name of the type and TYPE is a ..._TYPE node giving
 658    its data type.  */
 659 extern tree create_type_stub_decl (tree type_name, tree type);
 660
 661 /* Return a TYPE_DECL node.  TYPE_NAME gives the name of the type and TYPE
 662    is a ..._TYPE node giving its data type.  ARTIFICIAL_P is true if this
 663    is a declaration that was generated by the compiler.  DEBUG_INFO_P is
 664    true if we need to write debug information about this type.  GNAT_NODE
 665    is used for the position of the decl.  */
 666 extern tree create_type_decl (tree type_name, tree type, bool artificial_p,
 667                               bool debug_info_p, Node_Id gnat_node);
 668
 669 /* Return a VAR_DECL or CONST_DECL node.
 670
 671    VAR_NAME gives the name of the variable.  ASM_NAME is its assembler name
 672    (if provided).  TYPE is its data type (a GCC ..._TYPE node).  VAR_INIT is
 673    the GCC tree for an optional initial expression; NULL_TREE if none.
 674
 675    CONST_FLAG is true if this variable is constant, in which case we might
 676    return a CONST_DECL node unless CONST_DECL_ALLOWED_P is false.
 677
 678    PUBLIC_FLAG is true if this definition is to be made visible outside of
 679    the current compilation unit. This flag should be set when processing the
 680    variable definitions in a package specification.
 681
 682    EXTERN_FLAG is nonzero when processing an external variable declaration (as
 683    opposed to a definition: no storage is to be allocated for the variable).
 684
 685    STATIC_FLAG is only relevant when not at top level.  In that case
 686    it indicates whether to always allocate storage to the variable.
 687
 688    GNAT_NODE is used for the position of the decl.  */
 689 extern tree
 690 create_var_decl_1 (tree var_name, tree asm_name, tree type, tree var_init,
 691                    bool const_flag, bool public_flag, bool extern_flag,
 692                    bool static_flag, bool const_decl_allowed_p,
 693                    struct attrib *attr_list, Node_Id gnat_node);
 694
 695 /* Wrapper around create_var_decl_1 for cases where we don't care whether
 696    a VAR or a CONST decl node is created.  */
 697 #define create_var_decl(var_name, asm_name, type, var_init,     \
 698                         const_flag, public_flag, extern_flag,   \
 699                         static_flag, attr_list, gnat_node)      \
 700   create_var_decl_1 (var_name, asm_name, type, var_init,        \
 701                      const_flag, public_flag, extern_flag,      \
 702                      static_flag, true, attr_list, gnat_node)
 703
 704 /* Wrapper around create_var_decl_1 for cases where a VAR_DECL node is
 705    required.  The primary intent is for DECL_CONST_CORRESPONDING_VARs, which
 706    must be VAR_DECLs and on which we want TREE_READONLY set to have them
 707    possibly assigned to a readonly data section.  */
 708 #define create_true_var_decl(var_name, asm_name, type, var_init,        \
 709                              const_flag, public_flag, extern_flag,      \
 710                              static_flag, attr_list, gnat_node)         \
 711   create_var_decl_1 (var_name, asm_name, type, var_init,                \
 712                      const_flag, public_flag, extern_flag,              \
 713                      static_flag, false, attr_list, gnat_node)
 714
 715 /* Record DECL as a global non-constant renaming.  */
 716 extern void record_global_nonconstant_renaming (tree decl);
 717
 718 /* Invalidate the global non-constant renamings.  */
 719 extern void invalidate_global_nonconstant_renamings (void);
 720
 721 /* Return a FIELD_DECL node.  FIELD_NAME is the field's name, FIELD_TYPE is
 722    its type and RECORD_TYPE is the type of the enclosing record.  If SIZE is
 723    nonzero, it is the specified size of the field.  If POS is nonzero, it is
 724    the bit position.  PACKED is 1 if the enclosing record is packed, -1 if it
 725    has Component_Alignment of Storage_Unit.  If ADDRESSABLE is nonzero, it
 726    means we are allowed to take the address of the field; if it is negative,
 727    we should not make a bitfield, which is used by make_aligning_type.  */
 728 extern tree create_field_decl (tree field_name, tree field_type,
 729                                tree record_type, tree size, tree pos,
 730                                int packed, int addressable);
 731
 732 /* Return a PARM_DECL node.  PARAM_NAME is the name of the parameter and
 733    PARAM_TYPE is its type.  READONLY is true if the parameter is readonly
 734    (either an In parameter or an address of a pass-by-ref parameter).  */
 735 extern tree create_param_decl (tree param_name, tree param_type,
 736                                bool readonly);
 737
 738 /* Return a LABEL_DECL with LABEL_NAME.  GNAT_NODE is used for the position
 739    of the decl.  */
 740 extern tree create_label_decl (tree label_name, Node_Id gnat_node);
 741
 742 /* Return a FUNCTION_DECL node.  SUBPROG_NAME is the name of the subprogram,
 743    ASM_NAME is its assembler name, SUBPROG_TYPE is its type (a FUNCTION_TYPE
 744    node), PARAM_DECL_LIST is the list of the subprogram arguments (a list of
 745    PARM_DECL nodes chained through the DECL_CHAIN field).
 746
 747    INLINE_STATUS, PUBLIC_FLAG, EXTERN_FLAG, ARTIFICIAL_FLAG and ATTR_LIST are
 748    used to set the appropriate fields in the FUNCTION_DECL.  GNAT_NODE is
 749    used for the position of the decl.  */
 750 extern tree create_subprog_decl (tree subprog_name, tree asm_name,
 751                                  tree subprog_type, tree param_decl_list,
 752                                  enum inline_status_t inline_status,
 753                                  bool public_flag, bool extern_flag,
 754                                  bool artificial_flag,
 755                                  struct attrib *attr_list, Node_Id gnat_node);
 756
 757 /* Process the attributes in ATTR_LIST for NODE, which is either a DECL or
 758    a TYPE.  If IN_PLACE is true, the tree pointed to by NODE should not be
 759    changed.  GNAT_NODE is used for the position of error messages.  */
 760 extern void process_attributes (tree *node, struct attrib **attr_list,
 761                                 bool in_place, Node_Id gnat_node);
 762
 763 /* Set up the framework for generating code for SUBPROG_DECL, a subprogram
 764    body. This routine needs to be invoked before processing the declarations
 765    appearing in the subprogram.  */
 766 extern void begin_subprog_body (tree subprog_decl);
 767
 768 /* Finish translating the current subprogram and set its BODY.  */
 769 extern void end_subprog_body (tree body);
 770
 771 /* Wrap up compilation of SUBPROG_DECL, a subprogram body.  */
 772 extern void rest_of_subprog_body_compilation (tree subprog_decl);
 773
 774 /* Build a template of type TEMPLATE_TYPE from the array bounds of ARRAY_TYPE.
 775    EXPR is an expression that we can use to locate any PLACEHOLDER_EXPRs.
 776    Return a constructor for the template.  */
 777 extern tree build_template (tree template_type, tree array_type, tree expr);
 778
 779 /* Build a type to be used to represent an aliased object whose nominal type
 780    is an unconstrained array.  This consists of a RECORD_TYPE containing a
 781    field of TEMPLATE_TYPE and a field of OBJECT_TYPE, which is an ARRAY_TYPE.
 782    If ARRAY_TYPE is that of an unconstrained array, this is used to represent
 783    an arbitrary unconstrained object.  Use NAME as the name of the record.
 784    DEBUG_INFO_P is true if we need to write debug information for the type.  */
 785 extern tree build_unc_object_type (tree template_type, tree object_type,
 786                                    tree name, bool debug_info_p);
 787
 788 /* Same as build_unc_object_type, but taking a thin or fat pointer type
 789    instead of the template type.  */
 790 extern tree build_unc_object_type_from_ptr (tree thin_fat_ptr_type,
 791                                             tree object_type, tree name,
 792                                             bool debug_info_p);
 793
 794 /* Update anything previously pointing to OLD_TYPE to point to NEW_TYPE.  In
 795    the normal case this is just two adjustments, but we have more to do
 796    if NEW is an UNCONSTRAINED_ARRAY_TYPE.  */
 797 extern void update_pointer_to (tree old_type, tree new_type);
 798
 799 /* EXP is an expression for the size of an object.  If this size contains
 800    discriminant references, replace them with the maximum (if MAX_P) or
 801    minimum (if !MAX_P) possible value of the discriminant.  */
 802 extern tree max_size (tree exp, bool max_p);
 803
 804 /* Remove all conversions that are done in EXP.  This includes converting
 805    from a padded type or to a left-justified modular type.  If TRUE_ADDRESS
 806    is true, always return the address of the containing object even if
 807    the address is not bit-aligned.  */
 808 extern tree remove_conversions (tree exp, bool true_address);
 809
 810 /* If EXP's type is an UNCONSTRAINED_ARRAY_TYPE, return an expression that
 811    refers to the underlying array.  If its type has TYPE_CONTAINS_TEMPLATE_P,
 812    likewise return an expression pointing to the underlying array.  */
 813 extern tree maybe_unconstrained_array (tree exp);
 814
 815 /* Return an expression that does an unchecked conversion of EXPR to TYPE.
 816    If NOTRUNC_P is true, truncation operations should be suppressed.  */
 817 extern tree unchecked_convert (tree type, tree expr, bool notrunc_p);
 818
 819 /* Return the appropriate GCC tree code for the specified GNAT_TYPE,
 820    the latter being a record type as predicated by Is_Record_Type.  */
 821 extern enum tree_code tree_code_for_record_type (Entity_Id gnat_type);
 822
 823 /* Return true if GNAT_TYPE is a "double" floating-point type, i.e. whose
 824    size is equal to 64 bits, or an array of such a type.  Set ALIGN_CLAUSE
 825    according to the presence of an alignment clause on the type or, if it
 826    is an array, on the component type.  */
 827 extern bool is_double_float_or_array (Entity_Id gnat_type,
 828                                       bool *align_clause);
 829
 830 /* Return true if GNAT_TYPE is a "double" or larger scalar type, i.e. whose
 831    size is greater or equal to 64 bits, or an array of such a type.  Set
 832    ALIGN_CLAUSE according to the presence of an alignment clause on the
 833    type or, if it is an array, on the component type.  */
 834 extern bool is_double_scalar_or_array (Entity_Id gnat_type,
 835                                        bool *align_clause);
 836
 837 /* Return true if GNU_TYPE is suitable as the type of a non-aliased
 838    component of an aggregate type.  */
 839 extern bool type_for_nonaliased_component_p (tree gnu_type);
 840
 841 /* Return true if TYPE is a smaller form of ORIG_TYPE.  */
 842 extern bool smaller_form_type_p (tree type, tree orig_type);
 843
 844 /* Return the base type of TYPE.  */
 845 extern tree get_base_type (tree type);
 846
 847 /* EXP is a GCC tree representing an address.  See if we can find how
 848    strictly the object at that address is aligned.   Return that alignment
 849    strictly the object at that address is aligned.   Return that alignment
 850    in bits.  If we don't know anything about the alignment, return 0.  */
 851 extern unsigned int known_alignment (tree exp);
 852
 853 /* Return true if VALUE is a multiple of FACTOR. FACTOR must be a power
 854    of 2.  */
 855 extern bool value_factor_p (tree value, HOST_WIDE_INT factor);
 856
 857 /* Build an atomic load for the underlying atomic object in SRC.  SYNC is
 858    true if the load requires synchronization.  */
 859 extern tree build_atomic_load (tree src, bool sync);
 860
 861 /* Build an atomic store from SRC to the underlying atomic object in DEST.
 862    SYNC is true if the store requires synchronization.  */
 863 extern tree build_atomic_store (tree dest, tree src, bool sync);
 864
 865 /* Build a load-modify-store sequence from SRC to DEST.  GNAT_NODE is used for
 866    the location of the sequence.  Note that, even if the load and the store are
 867    both atomic, the sequence itself is not atomic.  */
 868 extern tree build_load_modify_store (tree dest, tree src, Node_Id gnat_node);
 869
 870 /* Make a binary operation of kind OP_CODE.  RESULT_TYPE is the type
 871    desired for the result.  Usually the operation is to be performed
 872    in that type.  For MODIFY_EXPR and ARRAY_REF, RESULT_TYPE may be 0
 873    in which case the type to be used will be derived from the operands.  */
 874 extern tree build_binary_op (enum tree_code op_code, tree result_type,
 875                              tree left_operand, tree right_operand);
 876
 877 /* Similar, but make unary operation.  */
 878 extern tree build_unary_op (enum tree_code op_code, tree result_type,
 879                             tree operand);
 880
 881 /* Similar, but for COND_EXPR.  */
 882 extern tree build_cond_expr (tree result_type, tree condition_operand,
 883                              tree true_operand, tree false_operand);
 884
 885 /* Similar, but for COMPOUND_EXPR.  */
 886 extern tree build_compound_expr (tree result_type, tree stmt_operand,
 887                                  tree expr_operand);
 888
 889 /* Conveniently construct a function call expression.  FNDECL names the
 890    function to be called, N is the number of arguments, and the "..."
 891    parameters are the argument expressions.  Unlike build_call_expr
 892    this doesn't fold the call, hence it will always return a CALL_EXPR.  */
 893 extern tree build_call_n_expr (tree fndecl, int n, ...);
 894
 895 /* Call a function that raises an exception and pass the line number and file
 896    name, if requested.  MSG says which exception function to call.
 897
 898    GNAT_NODE is the gnat node conveying the source location for which the
 899    error should be signaled, or Empty in which case the error is signaled on
 900    the current ref_file_name/input_line.
 901
 902    KIND says which kind of exception this is for
 903     (N_Raise_{Constraint,Storage,Program}_Error).  */
 904 extern tree build_call_raise (int msg, Node_Id gnat_node, char kind);
 905
 906 /* Similar to build_call_raise, for an index or range check exception as
 907    determined by MSG, with extra information generated of the form
 908    "INDEX out of range FIRST..LAST".  */
 909 extern tree build_call_raise_range (int msg, Node_Id gnat_node,
 910                                     tree index, tree first, tree last);
 911
 912 /* Similar to build_call_raise, with extra information about the column
 913    where the check failed.  */
 914 extern tree build_call_raise_column (int msg, Node_Id gnat_node);
 915
 916 /* Return a CONSTRUCTOR of TYPE whose elements are V.  This is not the
 917    same as build_constructor in the language-independent tree.c.  */
 918 extern tree gnat_build_constructor (tree type, vec<constructor_elt, va_gc> *v);
 919
 920 /* Return a COMPONENT_REF to access a field that is given by COMPONENT,
 921    an IDENTIFIER_NODE giving the name of the field, FIELD, a FIELD_DECL,
 922    for the field, or both.  Don't fold the result if NO_FOLD_P.  */
 923 extern tree build_component_ref (tree record_variable, tree component,
 924                                  tree field, bool no_fold_p);
 925
 926 /* Build a GCC tree to call an allocation or deallocation function.
 927    If GNU_OBJ is nonzero, it is an object to deallocate.  Otherwise,
 928    generate an allocator.
 929
 930    GNU_SIZE is the number of bytes to allocate and GNU_TYPE is the contained
 931    object type, used to determine the to-be-honored address alignment.
 932    GNAT_PROC, if present, is a procedure to call and GNAT_POOL is the storage
 933    pool to use.  If not present, malloc and free are used.  GNAT_NODE is used
 934    to provide an error location for restriction violation messages.  */
 935 extern tree build_call_alloc_dealloc (tree gnu_obj, tree gnu_size,
 936                                       tree gnu_type, Entity_Id gnat_proc,
 937                                       Entity_Id gnat_pool, Node_Id gnat_node);
 938
 939 /* Build a GCC tree to correspond to allocating an object of TYPE whose
 940    initial value if INIT, if INIT is nonzero.  Convert the expression to
 941    RESULT_TYPE, which must be some type of pointer.  Return the tree.
 942
 943    GNAT_PROC and GNAT_POOL optionally give the procedure to call and
 944    the storage pool to use.  GNAT_NODE is used to provide an error
 945    location for restriction violation messages.  If IGNORE_INIT_TYPE is
 946    true, ignore the type of INIT for the purpose of determining the size;
 947    this will cause the maximum size to be allocated if TYPE is of
 948    self-referential size.  */
 949 extern tree build_allocator (tree type, tree init, tree result_type,
 950                              Entity_Id gnat_proc, Entity_Id gnat_pool,
 951                              Node_Id gnat_node, bool);
 952
 953 /* Indicate that we need to take the address of T and that it therefore
 954    should not be allocated in a register.  Returns true if successful.  */
 955 extern bool gnat_mark_addressable (tree t);
 956
 957 /* Save EXP for later use or reuse.  This is equivalent to save_expr in tree.c
 958    but we know how to handle our own nodes.  */
 959 extern tree gnat_save_expr (tree exp);
 960
 961 /* Protect EXP for immediate reuse.  This is a variant of gnat_save_expr that
 962    is optimized under the assumption that EXP's value doesn't change before
 963    its subsequent reuse(s) except through its potential reevaluation.  */
 964 extern tree gnat_protect_expr (tree exp);
 965
 966 /* This is equivalent to stabilize_reference in tree.c but we know how to
 967    handle our own nodes and we take extra arguments.  FORCE says whether to
 968    force evaluation of everything.  */
 969 extern tree gnat_stabilize_reference (tree ref, bool force);
 970
 971 /* This is equivalent to get_inner_reference in expr.c but it returns the
 972    ultimate containing object only if the reference (lvalue) is constant,
 973    i.e. if it doesn't depend on the context in which it is evaluated.  */
 974 extern tree get_inner_constant_reference (tree exp);
 975
 976 /* Return true if REF is a constant reference, i.e. a reference (lvalue) that
 977    doesn't depend on the context in which it is evaluated.  */
 978 extern bool gnat_constant_reference_p (tree ref);
 979
 980 /* If EXPR is an expression that is invariant in the current function, in the
 981    sense that it can be evaluated anywhere in the function and any number of
 982    times, return EXPR or an equivalent expression.  Otherwise return NULL.  */
 983 extern tree gnat_invariant_expr (tree expr);
 984
 985 /* Implementation of the builtin_function langhook.  */
 986 extern tree gnat_builtin_function (tree decl);
 987
 988 /* Search the chain of currently reachable declarations for a builtin
 989    FUNCTION_DECL node corresponding to function NAME (an IDENTIFIER_NODE).
 990    Return the first node found, if any, or NULL_TREE otherwise.  */
 991 extern tree builtin_decl_for (tree name);
 992
 993 /* GNU_TYPE is a type. Determine if it should be passed by reference by
 994    default.  */
 995 extern bool default_pass_by_ref (tree gnu_type);
 996
 997 /* GNU_TYPE is the type of a subprogram parameter.  Determine from the type
 998    if it should be passed by reference.  */
 999 extern bool must_pass_by_ref (tree gnu_type);
1000
1001 /* Return the size of the FP mode with precision PREC.  */
1002 extern int fp_prec_to_size (int prec);
1003
1004 /* Return the precision of the FP mode with size SIZE.  */
1005 extern int fp_size_to_prec (int size);
1006
1007 /* Return whether GNAT_NODE is a defining identifier for a renaming that comes
1008    from the parameter association for the instantiation of a generic.  We do
1009    not want to emit source location for them: the code generated for their
1010    initialization is likely to disturb debugging.  */
1011 extern bool renaming_from_generic_instantiation_p (Node_Id gnat_node);
1012
1013 /* Try to process all nodes in the deferred context queue.  Keep in the queue
1014    the ones that cannot be processed yet, remove the other ones.  If FORCE is
1015    true, force the processing for all nodes, use the global context when nodes
1016    don't have a GNU translation.  */
1017 extern void process_deferred_decl_context (bool force);
1018
1019 #ifdef __cplusplus
1020 extern "C" {
1021 #endif
1022
1023 /* These functions return the basic data type sizes and related parameters
1024    about the target machine.  */
1025 extern Pos get_target_bits_per_unit (void);
1026 extern Pos get_target_bits_per_word (void);
1027 extern Pos get_target_char_size (void);
1028 extern Pos get_target_wchar_t_size (void);
1029 extern Pos get_target_short_size (void);
1030 extern Pos get_target_int_size (void);
1031 extern Pos get_target_long_size (void);
1032 extern Pos get_target_long_long_size (void);
1033 extern Pos get_target_pointer_size (void);
1034 extern Pos get_target_maximum_default_alignment (void);
1035 extern Pos get_target_system_allocator_alignment (void);
1036 extern Pos get_target_maximum_allowed_alignment (void);
1037 extern Pos get_target_maximum_alignment (void);
1038 extern Nat get_target_float_words_be (void);
1039 extern Nat get_target_words_be (void);
1040 extern Nat get_target_bytes_be (void);
1041 extern Nat get_target_bits_be (void);
1042 extern Nat get_target_strict_alignment (void);
1043 extern Nat get_target_double_float_alignment (void);
1044 extern Nat get_target_double_scalar_alignment (void);
1045
1046 /* This function is called by the front-end to enumerate all the supported
1047    modes for the machine, as well as some predefined C types.  */
1048 extern void enumerate_modes (void (*f) (const char *, int, int, int, int, int,
1049                                         int, int));
1050
1051 #ifdef __cplusplus
1052 }
1053 #endif
1054
1055 /* If EXP's type is a VECTOR_TYPE, return EXP converted to the associated
1056    TYPE_REPRESENTATIVE_ARRAY.  */
1057
1058 static inline tree
1059 maybe_vector_array (tree exp)
1060 {
1061   tree etype = TREE_TYPE (exp);
1062
1063   if (VECTOR_TYPE_P (etype))
1064     exp = convert (TYPE_REPRESENTATIVE_ARRAY (etype), exp);
1065
1066   return exp;
1067 }
1068
1069 /* Return the smallest power of 2 larger than X.  */
1070
1071 static inline unsigned HOST_WIDE_INT
1072 ceil_pow2 (unsigned HOST_WIDE_INT x)
1073 {
1074   return (unsigned HOST_WIDE_INT) 1 << (floor_log2 (x - 1) + 1);
1075 }