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