gcc/ada/gcc-interface/ada-tree.h

   1 /****************************************************************************
   2  *                                                                          *
   3  *                         GNAT COMPILER COMPONENTS                         *
   4  *                                                                          *
   5  *                             A D A - T R E E                              *
   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 along with GCC; see the 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 /* The resulting tree type.  */
  27 union GTY((desc ("0"),
  28            chain_next ("CODE_CONTAINS_STRUCT (TREE_CODE (&%h.generic), TS_COMMON) ? ((union lang_tree_node *) TREE_CHAIN (&%h.generic)) : NULL")))
  29   lang_tree_node
  30 {
  31   union tree_node GTY((tag ("0"),
  32                        desc ("tree_node_structure (&%h)"))) generic;
  33 };
  34
  35 /* Ada uses the lang_decl and lang_type fields to hold a tree.  */
  36 struct GTY(()) lang_type { tree t1; tree t2; };
  37 struct GTY(()) lang_decl { tree t; };
  38
  39 extern struct lang_type *get_lang_specific (tree node);
  40
  41 /* Macros to get and set the trees in TYPE_LANG_SPECIFIC.  */
  42 #define GET_TYPE_LANG_SPECIFIC(NODE) \
  43   (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t1 : NULL_TREE)
  44
  45 #define SET_TYPE_LANG_SPECIFIC(NODE, X) (get_lang_specific (NODE)->t1 = (X))
  46
  47 #define GET_TYPE_LANG_SPECIFIC2(NODE) \
  48   (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t2 : NULL_TREE)
  49
  50 #define SET_TYPE_LANG_SPECIFIC2(NODE, X) (get_lang_specific (NODE)->t2 = (X))
  51
  52 /* Macros to get and set the tree in DECL_LANG_SPECIFIC.  */
  53 #define GET_DECL_LANG_SPECIFIC(NODE) \
  54   (DECL_LANG_SPECIFIC (NODE) ? DECL_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  55
  56 #define SET_DECL_LANG_SPECIFIC(NODE, X)                  \
  57 do {                                                     \
  58   tree tmp = (X);                                        \
  59   if (!DECL_LANG_SPECIFIC (NODE))                        \
  60     DECL_LANG_SPECIFIC (NODE)                            \
  61       = ggc_alloc<struct lang_decl> (); \
  62   DECL_LANG_SPECIFIC (NODE)->t = tmp;                    \
  63 } while (0)
  64
  65
  66 /* Flags added to type nodes.  */
  67
  68 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a
  69    record being used as a fat pointer (only true for RECORD_TYPE).  */
  70 #define TYPE_FAT_POINTER_P(NODE) \
  71   TYPE_LANG_FLAG_0 (RECORD_OR_UNION_CHECK (NODE))
  72
  73 #define TYPE_IS_FAT_POINTER_P(NODE) \
  74   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_FAT_POINTER_P (NODE))
  75
  76 /* For integral types and array types, nonzero if this is a packed array type
  77    used for bit-packed types.  Such types should not be extended to a larger
  78    size or validated against a specified size.  */
  79 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) \
  80   TYPE_LANG_FLAG_0 (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
  81
  82 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \
  83   ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \
  84    && TYPE_PACKED_ARRAY_TYPE_P (NODE))
  85
  86 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
  87    is not equal to two to the power of its mode's size.  */
  88 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
  89
  90 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
  91    an Ada array other than the first.  */
  92 #define TYPE_MULTI_ARRAY_P(NODE) TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
  93
  94 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
  95    unconstrained array or record.  */
  96 #define TYPE_RETURN_UNCONSTRAINED_P(NODE) \
  97   TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
  98
  99 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
 100    a justified modular type (will only be true for RECORD_TYPE).  */
 101 #define TYPE_JUSTIFIED_MODULAR_P(NODE) \
 102   TYPE_LANG_FLAG_1 (RECORD_OR_UNION_CHECK (NODE))
 103
 104 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
 105    front-end.  */
 106 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (INTEGER_TYPE_CHECK (NODE))
 107
 108 /* Nonzero for an aggregate type if this is a by-reference type.  We also
 109    set this on an ENUMERAL_TYPE that is dummy.  */
 110 #define TYPE_BY_REFERENCE_P(NODE)                                      \
 111   TYPE_LANG_FLAG_2 (TREE_CHECK5 (NODE, RECORD_TYPE, UNION_TYPE,        \
 112                                  ARRAY_TYPE, UNCONSTRAINED_ARRAY_TYPE, \
 113                                  ENUMERAL_TYPE))
 114
 115 #define TYPE_IS_BY_REFERENCE_P(NODE)                \
 116   ((TREE_CODE (NODE) == RECORD_TYPE                 \
 117     || TREE_CODE (NODE) == UNION_TYPE               \
 118     || TREE_CODE (NODE) == ARRAY_TYPE               \
 119     || TREE_CODE (NODE) == UNCONSTRAINED_ARRAY_TYPE \
 120     || TREE_CODE (NODE) == ENUMERAL_TYPE)           \
 121    && TYPE_BY_REFERENCE_P (NODE))
 122
 123 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
 124    type for an object whose type includes its template in addition to
 125    its value (only true for RECORD_TYPE).  */
 126 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
 127   TYPE_LANG_FLAG_3 (RECORD_OR_UNION_CHECK (NODE))
 128
 129 /* For INTEGER_TYPE, nonzero if it implements a fixed-point type.  */
 130 #define TYPE_FIXED_POINT_P(NODE) \
 131   TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
 132
 133 #define TYPE_IS_FIXED_POINT_P(NODE) \
 134   (TREE_CODE (NODE) == INTEGER_TYPE && TYPE_FIXED_POINT_P (NODE))
 135
 136 /* True if NODE is a thin pointer.  */
 137 #define TYPE_IS_THIN_POINTER_P(NODE)                    \
 138   (POINTER_TYPE_P (NODE)                                \
 139    && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE       \
 140    && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
 141
 142 /* True if TYPE is either a fat or thin pointer to an unconstrained
 143    array.  */
 144 #define TYPE_IS_FAT_OR_THIN_POINTER_P(NODE) \
 145   (TYPE_IS_FAT_POINTER_P (NODE) || TYPE_IS_THIN_POINTER_P (NODE))
 146
 147 /* For INTEGER_TYPEs, nonzero if the type has a biased representation.  */
 148 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
 149   TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
 150
 151 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran.  */
 152 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
 153   TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
 154
 155 /* For FUNCTION_TYPEs, nonzero if the function returns by direct reference,
 156    i.e. the callee returns a pointer to a memory location it has allocated
 157    and the caller only needs to dereference the pointer.  */
 158 #define TYPE_RETURN_BY_DIRECT_REF_P(NODE) \
 159   TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
 160
 161 /* For RECORD_TYPE, UNION_TYPE and ENUMERAL_TYPE, nonzero if this is a dummy
 162    type, made to correspond to a private or incomplete type.  */
 163 #define TYPE_DUMMY_P(NODE) \
 164   TYPE_LANG_FLAG_4 (TREE_CHECK3 (NODE, RECORD_TYPE, UNION_TYPE, ENUMERAL_TYPE))
 165
 166 #define TYPE_IS_DUMMY_P(NODE)             \
 167   ((TREE_CODE (NODE) == RECORD_TYPE       \
 168     || TREE_CODE (NODE) == UNION_TYPE     \
 169     || TREE_CODE (NODE) == ENUMERAL_TYPE) \
 170    && TYPE_DUMMY_P (NODE))
 171
 172 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 173 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 174   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 175
 176 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 177    padding or alignment.  */
 178 #define TYPE_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 179
 180 #define TYPE_IS_PADDING_P(NODE) \
 181   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_PADDING_P (NODE))
 182
 183 /* True for a non-dummy type if TYPE can alias any other types.  */
 184 #define TYPE_UNIVERSAL_ALIASING_P(NODE) TYPE_LANG_FLAG_6 (NODE)
 185
 186 /* True for a dummy type if TYPE appears in a profile.  */
 187 #define TYPE_DUMMY_IN_PROFILE_P(NODE) TYPE_LANG_FLAG_6 (NODE)
 188
 189 /* True for types that implement a packed array and for original packed array
 190    types.  */
 191 #define TYPE_IMPL_PACKED_ARRAY_P(NODE) \
 192   ((TREE_CODE (NODE) == ARRAY_TYPE && TYPE_PACKED (NODE)) \
 193    || (TREE_CODE (NODE) == INTEGER_TYPE && TYPE_PACKED_ARRAY_TYPE_P (NODE)))
 194
 195 /* True for types that can hold a debug type.  */
 196 #define TYPE_CAN_HAVE_DEBUG_TYPE_P(NODE) (!TYPE_IMPL_PACKED_ARRAY_P (NODE))
 197
 198 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, this holds the maximum
 199    alignment value the type ought to have.  */
 200 #define TYPE_MAX_ALIGN(NODE) (TYPE_PRECISION (RECORD_OR_UNION_CHECK (NODE)))
 201
 202 /* For an UNCONSTRAINED_ARRAY_TYPE, this is the record containing both the
 203    template and the object.
 204
 205    ??? We also put this on an ENUMERAL_TYPE that is dummy.  Technically,
 206    this is a conflict on the minval field, but there doesn't seem to be
 207    simple fix, so we'll live with this kludge for now.  */
 208 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
 209   (TYPE_MINVAL (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)))
 210
 211 /* For numerical types, this is the GCC lower bound of the type.  The GCC
 212    type system is based on the invariant that an object X of a given type
 213    cannot hold at run time a value smaller than its lower bound; otherwise
 214    the behavior is undefined.  The optimizer takes advantage of this and
 215    considers that the assertion X >= LB is always true.  */
 216 #define TYPE_GCC_MIN_VALUE(NODE) (TYPE_MINVAL (NUMERICAL_TYPE_CHECK (NODE)))
 217
 218 /* For numerical types, this is the GCC upper bound of the type.  The GCC
 219    type system is based on the invariant that an object X of a given type
 220    cannot hold at run time a value larger than its upper bound; otherwise
 221    the behavior is undefined.  The optimizer takes advantage of this and
 222    considers that the assertion X <= UB is always true.  */
 223 #define TYPE_GCC_MAX_VALUE(NODE) (TYPE_MAXVAL (NUMERICAL_TYPE_CHECK (NODE)))
 224
 225 /* For a FUNCTION_TYPE, if the subprogram has parameters passed by copy in/
 226    copy out, this is the list of nodes used to specify the return values of
 227    the out (or in out) parameters that are passed by copy in/copy out.  For
 228    a full description of the copy in/copy out parameter passing mechanism
 229    refer to the routine gnat_to_gnu_entity.  */
 230 #define TYPE_CI_CO_LIST(NODE) TYPE_LANG_SLOT_1 (FUNCTION_TYPE_CHECK (NODE))
 231
 232 /* For a VECTOR_TYPE, this is the representative array type.  */
 233 #define TYPE_REPRESENTATIVE_ARRAY(NODE) \
 234   TYPE_LANG_SLOT_1 (VECTOR_TYPE_CHECK (NODE))
 235
 236 /* For numerical types, this holds various RM-defined values.  */
 237 #define TYPE_RM_VALUES(NODE) TYPE_LANG_SLOT_1 (NUMERICAL_TYPE_CHECK (NODE))
 238
 239 /* Macros to get and set the individual values in TYPE_RM_VALUES.  */
 240 #define TYPE_RM_VALUE(NODE, N)                              \
 241   (TYPE_RM_VALUES (NODE)                                    \
 242    ? TREE_VEC_ELT (TYPE_RM_VALUES (NODE), (N)) : NULL_TREE)
 243
 244 #define SET_TYPE_RM_VALUE(NODE, N, X)              \
 245 do {                                               \
 246   tree tmp = (X);                                  \
 247   if (!TYPE_RM_VALUES (NODE))                      \
 248     TYPE_RM_VALUES (NODE) = make_tree_vec (3);     \
 249   /* ??? The field is not visited by the generic   \
 250      code so we need to mark it manually.  */      \
 251   MARK_VISITED (tmp);                              \
 252   TREE_VEC_ELT (TYPE_RM_VALUES (NODE), (N)) = tmp; \
 253 } while (0)
 254
 255 /* For numerical types, this is the RM size of the type, aka its precision.
 256    There is a discrepancy between what is called precision here (and more
 257    generally throughout gigi) and what is called precision in the GCC type
 258    system: in the former case it's TYPE_RM_SIZE whereas it's TYPE_PRECISION
 259    in the latter case.  They are not identical because of the need to support
 260    invalid values.
 261
 262    These values can be outside the range of values allowed by the RM size
 263    but they must nevertheless be valid in the GCC type system, otherwise
 264    the optimizer can pretend that they simply don't exist.  Therefore they
 265    must be within the range of values allowed by the precision in the GCC
 266    sense, hence TYPE_PRECISION be set to the Esize, not the RM size.  */
 267 #define TYPE_RM_SIZE(NODE) TYPE_RM_VALUE ((NODE), 0)
 268 #define SET_TYPE_RM_SIZE(NODE, X) SET_TYPE_RM_VALUE ((NODE), 0, (X))
 269
 270 /* For numerical types, this is the RM lower bound of the type.  There is
 271    again a discrepancy between this lower bound and the GCC lower bound,
 272    again because of the need to support invalid values.
 273
 274    These values can be outside the range of values allowed by the RM lower
 275    bound but they must nevertheless be valid in the GCC type system, otherwise
 276    the optimizer can pretend that they simply don't exist.  Therefore they
 277    must be within the range of values allowed by the lower bound in the GCC
 278    sense, hence the GCC lower bound be set to that of the base type.
 279
 280    This lower bound is translated directly without the adjustments that may
 281    be required for type compatibility, so it will generally be necessary to
 282    convert it to the base type of the numerical type before using it.  */
 283 #define TYPE_RM_MIN_VALUE(NODE) TYPE_RM_VALUE ((NODE), 1)
 284 #define SET_TYPE_RM_MIN_VALUE(NODE, X) SET_TYPE_RM_VALUE ((NODE), 1, (X))
 285
 286 /* For numerical types, this is the RM upper bound of the type.  There is
 287    again a discrepancy between this upper bound and the GCC upper bound,
 288    again because of the need to support invalid values.
 289
 290    These values can be outside the range of values allowed by the RM upper
 291    bound but they must nevertheless be valid in the GCC type system, otherwise
 292    the optimizer can pretend that they simply don't exist.  Therefore they
 293    must be within the range of values allowed by the upper bound in the GCC
 294    sense, hence the GCC upper bound be set to that of the base type.
 295
 296    This upper bound is translated directly without the adjustments that may
 297    be required for type compatibility, so it will generally be necessary to
 298    convert it to the base type of the numerical type before using it.  */
 299 #define TYPE_RM_MAX_VALUE(NODE) TYPE_RM_VALUE ((NODE), 2)
 300 #define SET_TYPE_RM_MAX_VALUE(NODE, X) SET_TYPE_RM_VALUE ((NODE), 2, (X))
 301
 302 /* For numerical types, this is the lower bound of the type, i.e. the RM lower
 303    bound for language-defined types and the GCC lower bound for others.  */
 304 #undef TYPE_MIN_VALUE
 305 #define TYPE_MIN_VALUE(NODE) \
 306   (TYPE_RM_MIN_VALUE (NODE) \
 307    ? TYPE_RM_MIN_VALUE (NODE) : TYPE_GCC_MIN_VALUE (NODE))
 308
 309 /* For numerical types, this is the upper bound of the type, i.e. the RM upper
 310    bound for language-defined types and the GCC upper bound for others.  */
 311 #undef TYPE_MAX_VALUE
 312 #define TYPE_MAX_VALUE(NODE) \
 313   (TYPE_RM_MAX_VALUE (NODE) \
 314    ? TYPE_RM_MAX_VALUE (NODE) : TYPE_GCC_MAX_VALUE (NODE))
 315
 316 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 317    modulus. */
 318 #define TYPE_MODULUS(NODE) \
 319   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 320 #define SET_TYPE_MODULUS(NODE, X) \
 321   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 322
 323 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, this is
 324    the type corresponding to the Ada index type.  It is necessary to keep
 325    these 2 views for every array type because the TYPE_DOMAIN is subject
 326    to strong constraints in GENERIC: it must be a subtype of SIZETYPE and
 327    may not be superflat, i.e. the upper bound must always be larger or
 328    equal to the lower bound minus 1 (i.e. the canonical length formula
 329    must always yield a non-negative number), which means that at least
 330    one of the bounds may need to be a conditional expression.  There are
 331    no such constraints on the TYPE_INDEX_TYPE because gigi is prepared to
 332    deal with the superflat case; moreover the TYPE_INDEX_TYPE is used as
 333    the index type for the debug info and, therefore, needs to be as close
 334    as possible to the source index type.  */
 335 #define TYPE_INDEX_TYPE(NODE) \
 336   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 337 #define SET_TYPE_INDEX_TYPE(NODE, X) \
 338   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 339
 340 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 341    the index type that should be used when the actual bounds are required for
 342    a template.  This is used in the case of packed arrays.  */
 343 #define TYPE_ACTUAL_BOUNDS(NODE) \
 344   GET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
 345 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
 346   SET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE), X)
 347
 348 /* For a POINTER_TYPE that points to the template type of an unconstrained
 349    array type, this is the address to be used in a null fat pointer.  */
 350 #define TYPE_NULL_BOUNDS(NODE) \
 351   GET_TYPE_LANG_SPECIFIC (POINTER_TYPE_CHECK (NODE))
 352 #define SET_TYPE_NULL_BOUNDS(NODE, X) \
 353   SET_TYPE_LANG_SPECIFIC (POINTER_TYPE_CHECK (NODE), X)
 354
 355 /* For a RECORD_TYPE that is a fat pointer, this is the type for the
 356    unconstrained array.  Likewise for a RECORD_TYPE that is pointed
 357    to by a thin pointer, if it is made for the unconstrained array
 358    type itself; the field is NULL_TREE if the RECORD_TYPE is made
 359    for a constrained subtype of the array type.  */
 360 #define TYPE_UNCONSTRAINED_ARRAY(NODE) \
 361   GET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
 362 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X) \
 363   SET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE), X)
 364
 365 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, this is
 366    the Ada size of the object.  This differs from the GCC size in that it
 367    does not include any rounding up to the alignment of the type.  */
 368 #define TYPE_ADA_SIZE(NODE) \
 369   GET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE))
 370 #define SET_TYPE_ADA_SIZE(NODE, X) \
 371   SET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE), X)
 372
 373 /* For an INTEGER_TYPE with TYPE_IS_FIXED_POINT_P, this is the value of the
 374    scale factor.  Modular types, index types (sizetype subtypes) and
 375    fixed-point types are totally distinct types, so there is no problem with
 376    sharing type lang specific's first slot.  */
 377 #define TYPE_SCALE_FACTOR(NODE) \
 378   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 379 #define SET_TYPE_SCALE_FACTOR(NODE, X) \
 380   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 381
 382 /* For types with TYPE_CAN_HAVE_DEBUG_TYPE_P, this is the type to use in
 383    debugging information.  */
 384 #define TYPE_DEBUG_TYPE(NODE) \
 385   GET_TYPE_LANG_SPECIFIC2 (NODE)
 386 #define SET_TYPE_DEBUG_TYPE(NODE, X) \
 387   SET_TYPE_LANG_SPECIFIC2 (NODE, X)
 388
 389 /* For types with TYPE_IMPL_PACKED_ARRAY_P, this is the original packed
 390    array type.  Note that this predicate is true for original packed array
 391    types, so these cannot have a debug type.  */
 392 #define TYPE_ORIGINAL_PACKED_ARRAY(NODE) \
 393   GET_TYPE_LANG_SPECIFIC2 (NODE)
 394 #define SET_TYPE_ORIGINAL_PACKED_ARRAY(NODE, X) \
 395   SET_TYPE_LANG_SPECIFIC2 (NODE, X)
 396
 397
 398 /* Flags added to decl nodes.  */
 399
 400 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
 401    discriminant.  */
 402 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
 403
 404 /* Nonzero in a VAR_DECL if it is guaranteed to be constant after having
 405    been elaborated and TREE_READONLY is not set on it.  */
 406 #define DECL_READONLY_ONCE_ELAB(NODE) DECL_LANG_FLAG_0 (VAR_DECL_CHECK (NODE))
 407
 408 /* Nonzero in a CONST_DECL if its value is (essentially) the address of a
 409    constant CONSTRUCTOR.  */
 410 #define DECL_CONST_ADDRESS_P(NODE) DECL_LANG_FLAG_0 (CONST_DECL_CHECK (NODE))
 411
 412 /* Nonzero in a FIELD_DECL if it is declared as aliased.  */
 413 #define DECL_ALIASED_P(NODE) DECL_LANG_FLAG_0 (FIELD_DECL_CHECK (NODE))
 414
 415 /* Nonzero in a TYPE_DECL if this is the declaration of a Taft amendment type
 416    in the main unit, i.e. the full declaration is available.  */
 417 #define DECL_TAFT_TYPE_P(NODE) DECL_LANG_FLAG_0 (TYPE_DECL_CHECK (NODE))
 418
 419 /* Nonzero in a PARM_DECL passed by reference but for which only a restricted
 420    form of aliasing is allowed.  The first restriction comes explicitly from
 421    the RM 6.2(12) clause: there is no read-after-write dependency between a
 422    store based on such a PARM_DECL and a load not based on this PARM_DECL,
 423    so stores based on such PARM_DECLs can be sunk past all loads based on
 424    a distinct object.  The second restriction can be inferred from the same
 425    clause: there is no write-after-write dependency between a store based
 426    on such a PARM_DECL and a store based on a distinct such PARM_DECL, as
 427    the compiler would be allowed to pass the parameters by copy and the
 428    order of assignment to actual parameters after a call is arbitrary as
 429    per the RM 6.4.1(17) clause, so stores based on distinct such PARM_DECLs
 430    can be swapped.  */
 431 #define DECL_RESTRICTED_ALIASING_P(NODE) \
 432   DECL_LANG_FLAG_0 (PARM_DECL_CHECK (NODE))
 433
 434 /* Nonzero in a DECL if it is always used by reference, i.e. an INDIRECT_REF
 435    is needed to access the object.  */
 436 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
 437
 438 /* Nonzero in a DECL if it is made for a pointer that can never be null.  */
 439 #define DECL_CAN_NEVER_BE_NULL_P(NODE) DECL_LANG_FLAG_2 (NODE)
 440
 441 /* Nonzero in a VAR_DECL if it is made for a loop parameter.  */
 442 #define DECL_LOOP_PARM_P(NODE) DECL_LANG_FLAG_3 (VAR_DECL_CHECK (NODE))
 443
 444 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason.  */
 445 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
 446
 447 /* Nonzero in a PARM_DECL if it is made for an Ada array being passed to a
 448    foreign convention subprogram.  */
 449 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_3 (PARM_DECL_CHECK (NODE))
 450
 451 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 452 #define DECL_ELABORATION_PROC_P(NODE) \
 453   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 454
 455 /* Nonzero in a CONST_DECL, VAR_DECL or PARM_DECL if it is made for a pointer
 456    that points to something which is readonly.  */
 457 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 458
 459 /* Nonzero in a FIELD_DECL if it is invariant once set, for example if it is
 460    a discriminant of a discriminated type without default expression.  */
 461 #define DECL_INVARIANT_P(NODE) DECL_LANG_FLAG_4 (FIELD_DECL_CHECK (NODE))
 462
 463 /* Nonzero in a VAR_DECL if it is a temporary created to hold the return
 464    value of a function call or 'reference to a function call.  */
 465 #define DECL_RETURN_VALUE_P(NODE) DECL_LANG_FLAG_5 (VAR_DECL_CHECK (NODE))
 466
 467 /* In a FIELD_DECL corresponding to a discriminant, contains the
 468    discriminant number.  */
 469 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 470
 471 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 472    memory.  Used when a scalar constant is aliased or has its
 473    address taken.  */
 474 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 475   GET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
 476 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
 477   SET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE), X)
 478
 479 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 480    source of the decl.  */
 481 #define DECL_ORIGINAL_FIELD(NODE) \
 482   GET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
 483 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
 484   SET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE), X)
 485
 486 /* Set DECL_ORIGINAL_FIELD of FIELD1 to (that of) FIELD2.  */
 487 #define SET_DECL_ORIGINAL_FIELD_TO_FIELD(FIELD1, FIELD2)        \
 488   SET_DECL_ORIGINAL_FIELD ((FIELD1),                            \
 489                            DECL_ORIGINAL_FIELD (FIELD2)         \
 490                            ? DECL_ORIGINAL_FIELD (FIELD2) : (FIELD2))
 491
 492 /* Return true if FIELD1 and FIELD2 represent the same field.  */
 493 #define SAME_FIELD_P(FIELD1, FIELD2)                                    \
 494   ((FIELD1) == (FIELD2)                                                 \
 495    || DECL_ORIGINAL_FIELD (FIELD1) == (FIELD2)                          \
 496    || (FIELD1) == DECL_ORIGINAL_FIELD (FIELD2)                          \
 497    || (DECL_ORIGINAL_FIELD (FIELD1)                                     \
 498        && (DECL_ORIGINAL_FIELD (FIELD1) == DECL_ORIGINAL_FIELD (FIELD2))))
 499
 500 /* In a VAR_DECL with the DECL_LOOP_PARM_P flag set, points to the special
 501    induction variable that is built under certain circumstances, if any.  */
 502 #define DECL_INDUCTION_VAR(NODE) \
 503   GET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE))
 504 #define SET_DECL_INDUCTION_VAR(NODE, X) \
 505   SET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE), X)
 506
 507 /* In a VAR_DECL without the DECL_LOOP_PARM_P flag set and that is a renaming
 508    pointer, points to the object being renamed, if any.  */
 509 #define DECL_RENAMED_OBJECT(NODE) \
 510   GET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE))
 511 #define SET_DECL_RENAMED_OBJECT(NODE, X) \
 512   SET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE), X)
 513
 514 /* In a TYPE_DECL, points to the parallel type if any, otherwise 0.  */
 515 #define DECL_PARALLEL_TYPE(NODE) \
 516   GET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE))
 517 #define SET_DECL_PARALLEL_TYPE(NODE, X) \
 518   SET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE), X)
 519
 520
 521 /* Flags added to ref nodes.  */
 522
 523 /* Nonzero means this node will not trap.  */
 524 #undef TREE_THIS_NOTRAP
 525 #define TREE_THIS_NOTRAP(NODE) \
 526   (TREE_CHECK4 (NODE, INDIRECT_REF, ARRAY_REF, UNCONSTRAINED_ARRAY_REF, \
 527                 ARRAY_RANGE_REF)->base.nothrow_flag)
 528
 529
 530 /* Fields and macros for statements.  */
 531 #define IS_ADA_STMT(NODE) \
 532   (STATEMENT_CLASS_P (NODE) && TREE_CODE (NODE) >= STMT_STMT)
 533
 534 #define STMT_STMT_STMT(NODE)     TREE_OPERAND_CHECK_CODE (NODE, STMT_STMT, 0)
 535
 536 #define LOOP_STMT_COND(NODE)     TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 0)
 537 #define LOOP_STMT_UPDATE(NODE)   TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 1)
 538 #define LOOP_STMT_BODY(NODE)     TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 2)
 539 #define LOOP_STMT_LABEL(NODE)    TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 3)
 540
 541 /* A loop statement is conceptually made up of 6 sub-statements:
 542
 543     loop:
 544       TOP_CONDITION
 545       TOP_UPDATE
 546       BODY
 547       BOTTOM_CONDITION
 548       BOTTOM_UPDATE
 549       GOTO loop
 550
 551   However, only 4 of them can exist for a given loop, the pair of conditions
 552   and the pair of updates being mutually exclusive.  The default setting is
 553   TOP_CONDITION and BOTTOM_UPDATE and the following couple of flags are used
 554   to toggle the individual settings.  */
 555 #define LOOP_STMT_BOTTOM_COND_P(NODE) TREE_LANG_FLAG_0 (LOOP_STMT_CHECK (NODE))
 556 #define LOOP_STMT_TOP_UPDATE_P(NODE)  TREE_LANG_FLAG_1 (LOOP_STMT_CHECK (NODE))
 557
 558 /* Optimization hints on loops.  */
 559 #define LOOP_STMT_IVDEP(NODE)     TREE_LANG_FLAG_2 (LOOP_STMT_CHECK (NODE))
 560 #define LOOP_STMT_NO_UNROLL(NODE) TREE_LANG_FLAG_3 (LOOP_STMT_CHECK (NODE))
 561 #define LOOP_STMT_UNROLL(NODE)    TREE_LANG_FLAG_4 (LOOP_STMT_CHECK (NODE))
 562 #define LOOP_STMT_NO_VECTOR(NODE) TREE_LANG_FLAG_5 (LOOP_STMT_CHECK (NODE))
 563 #define LOOP_STMT_VECTOR(NODE)    TREE_LANG_FLAG_6 (LOOP_STMT_CHECK (NODE))
 564
 565 #define EXIT_STMT_COND(NODE)     TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 0)
 566 #define EXIT_STMT_LABEL(NODE)    TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 1)