gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2019 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 Under Section 7 of GPL version 3, you are granted additional
  17 permissions described in the GCC Runtime Library Exception, version
  18 3.1, as published by the Free Software Foundation.
  19
  20 You should have received a copy of the GNU General Public License and
  21 a copy of the GCC Runtime Library Exception along with this program;
  22 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 <http://www.gnu.org/licenses/>.  */
  24
  25 /* Provide forward declarations of core types which are referred to by
  26    most of the compiler.  This allows header files to use these types
  27    (e.g. in function prototypes) without concern for whether the full
  28    definitions are visible.  Some other declarations that need to be
  29    universally visible are here, too.
  30
  31    In the context of tconfig.h, most of these have special definitions
  32    which prevent them from being used except in further type
  33    declarations.  This is a kludge; the right thing is to avoid
  34    including the "tm.h" header set in the context of tconfig.h, but
  35    we're not there yet.  */
  36
  37 #ifndef GCC_CORETYPES_H
  38 #define GCC_CORETYPES_H
  39
  40 #ifndef GTY
  41 #define GTY(x)  /* nothing - marker for gengtype */
  42 #endif
  43
  44 #ifndef USED_FOR_TARGET
  45
  46 typedef int64_t gcov_type;
  47 typedef uint64_t gcov_type_unsigned;
  48
  49 struct bitmap_obstack;
  50 class bitmap_head;
  51 typedef class bitmap_head *bitmap;
  52 typedef const class bitmap_head *const_bitmap;
  53 struct simple_bitmap_def;
  54 typedef struct simple_bitmap_def *sbitmap;
  55 typedef const struct simple_bitmap_def *const_sbitmap;
  56 struct rtx_def;
  57 typedef struct rtx_def *rtx;
  58 typedef const struct rtx_def *const_rtx;
  59 class scalar_mode;
  60 class scalar_int_mode;
  61 class scalar_float_mode;
  62 class complex_mode;
  63 class fixed_size_mode;
  64 template<typename> class opt_mode;
  65 typedef opt_mode<scalar_mode> opt_scalar_mode;
  66 typedef opt_mode<scalar_int_mode> opt_scalar_int_mode;
  67 typedef opt_mode<scalar_float_mode> opt_scalar_float_mode;
  68 template<typename> struct pod_mode;
  69 typedef pod_mode<scalar_mode> scalar_mode_pod;
  70 typedef pod_mode<scalar_int_mode> scalar_int_mode_pod;
  71 typedef pod_mode<fixed_size_mode> fixed_size_mode_pod;
  72
  73 /* Subclasses of rtx_def, using indentation to show the class
  74    hierarchy, along with the relevant invariant.
  75    Where possible, keep this list in the same order as in rtl.def.  */
  76 struct rtx_def;
  77   struct rtx_expr_list;           /* GET_CODE (X) == EXPR_LIST */
  78   struct rtx_insn_list;           /* GET_CODE (X) == INSN_LIST */
  79   struct rtx_sequence;            /* GET_CODE (X) == SEQUENCE */
  80   struct rtx_insn;
  81     struct rtx_debug_insn;      /* DEBUG_INSN_P (X) */
  82     struct rtx_nonjump_insn;    /* NONJUMP_INSN_P (X) */
  83     struct rtx_jump_insn;       /* JUMP_P (X) */
  84     struct rtx_call_insn;       /* CALL_P (X) */
  85     struct rtx_jump_table_data; /* JUMP_TABLE_DATA_P (X) */
  86     struct rtx_barrier;         /* BARRIER_P (X) */
  87     struct rtx_code_label;      /* LABEL_P (X) */
  88     struct rtx_note;            /* NOTE_P (X) */
  89
  90 struct rtvec_def;
  91 typedef struct rtvec_def *rtvec;
  92 typedef const struct rtvec_def *const_rtvec;
  93 struct hwivec_def;
  94 typedef struct hwivec_def *hwivec;
  95 typedef const struct hwivec_def *const_hwivec;
  96 union tree_node;
  97 typedef union tree_node *tree;
  98 typedef const union tree_node *const_tree;
  99 struct gimple;
 100 typedef gimple *gimple_seq;
 101 struct gimple_stmt_iterator;
 102
 103 /* Forward decls for leaf gimple subclasses (for individual gimple codes).
 104    Keep this in the same order as the corresponding codes in gimple.def.  */
 105
 106 struct gcond;
 107 struct gdebug;
 108 struct ggoto;
 109 struct glabel;
 110 struct gswitch;
 111 struct gassign;
 112 struct gasm;
 113 struct gcall;
 114 struct gtransaction;
 115 struct greturn;
 116 struct gbind;
 117 struct gcatch;
 118 struct geh_filter;
 119 struct geh_mnt;
 120 struct geh_else;
 121 struct gresx;
 122 struct geh_dispatch;
 123 struct gphi;
 124 struct gtry;
 125 struct gomp_atomic_load;
 126 struct gomp_atomic_store;
 127 struct gomp_continue;
 128 struct gomp_critical;
 129 struct gomp_ordered;
 130 struct gomp_for;
 131 struct gomp_parallel;
 132 struct gomp_task;
 133 struct gomp_sections;
 134 struct gomp_single;
 135 struct gomp_target;
 136 struct gomp_teams;
 137
 138 /* Subclasses of symtab_node, using indentation to show the class
 139    hierarchy.  */
 140
 141 struct symtab_node;
 142   struct cgraph_node;
 143   struct varpool_node;
 144 struct cgraph_edge;
 145
 146 union section;
 147 typedef union section section;
 148 struct gcc_options;
 149 struct cl_target_option;
 150 struct cl_optimization;
 151 struct cl_option;
 152 struct cl_decoded_option;
 153 struct cl_option_handlers;
 154 struct diagnostic_context;
 155 class pretty_printer;
 156
 157 template<typename T> struct array_traits;
 158
 159 /* Provides a read-only bitmap view of a single integer bitmask or an
 160    array of integer bitmasks, or of a wrapper around such bitmasks.  */
 161 template<typename T, typename Traits = array_traits<T>,
 162          bool has_constant_size = Traits::has_constant_size>
 163 class bitmap_view;
 164
 165 /* Address space number for named address space support.  */
 166 typedef unsigned char addr_space_t;
 167
 168 /* The value of addr_space_t that represents the generic address space.  */
 169 #define ADDR_SPACE_GENERIC 0
 170 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 171
 172 /* The major intermediate representations of GCC.  */
 173 enum ir_type {
 174   IR_GIMPLE,
 175   IR_RTL_CFGRTL,
 176   IR_RTL_CFGLAYOUT
 177 };
 178
 179 /* Provide forward struct declaration so that we don't have to include
 180    all of cpplib.h whenever a random prototype includes a pointer.
 181    Note that the cpp_reader and cpp_token typedefs remain part of
 182    cpplib.h.  */
 183
 184 struct cpp_reader;
 185 struct cpp_token;
 186
 187 /* The thread-local storage model associated with a given VAR_DECL
 188    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 189    to it, so it's here.  */
 190 enum tls_model {
 191   TLS_MODEL_NONE,
 192   TLS_MODEL_EMULATED,
 193   TLS_MODEL_REAL,
 194   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 195   TLS_MODEL_LOCAL_DYNAMIC,
 196   TLS_MODEL_INITIAL_EXEC,
 197   TLS_MODEL_LOCAL_EXEC
 198 };
 199
 200 /* Types of ABI for an offload compiler.  */
 201 enum offload_abi {
 202   OFFLOAD_ABI_UNSET,
 203   OFFLOAD_ABI_LP64,
 204   OFFLOAD_ABI_ILP32
 205 };
 206
 207 /* Types of profile update methods.  */
 208 enum profile_update {
 209   PROFILE_UPDATE_SINGLE,
 210   PROFILE_UPDATE_ATOMIC,
 211   PROFILE_UPDATE_PREFER_ATOMIC
 212 };
 213
 214 /* Types of unwind/exception handling info that can be generated.  */
 215
 216 enum unwind_info_type
 217 {
 218   UI_NONE,
 219   UI_SJLJ,
 220   UI_DWARF2,
 221   UI_TARGET,
 222   UI_SEH
 223 };
 224
 225 /* Callgraph node profile representation.  */
 226 enum node_frequency {
 227   /* This function most likely won't be executed at all.
 228      (set only when profile feedback is available or via function attribute). */
 229   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 230   /* For functions that are known to be executed once (i.e. constructors, destructors
 231      and main function.  */
 232   NODE_FREQUENCY_EXECUTED_ONCE,
 233   /* The default value.  */
 234   NODE_FREQUENCY_NORMAL,
 235   /* Optimize this function hard
 236      (set only when profile feedback is available or via function attribute). */
 237   NODE_FREQUENCY_HOT
 238 };
 239
 240 /* Ways of optimizing code.  */
 241 enum optimization_type {
 242   /* Prioritize speed over size.  */
 243   OPTIMIZE_FOR_SPEED,
 244
 245   /* Only do things that are good for both size and speed.  */
 246   OPTIMIZE_FOR_BOTH,
 247
 248   /* Prioritize size over speed.  */
 249   OPTIMIZE_FOR_SIZE
 250 };
 251
 252 /* Enumerates a padding direction.  */
 253 enum pad_direction {
 254   /* No padding is required.  */
 255   PAD_NONE,
 256
 257   /* Insert padding above the data, i.e. at higher memeory addresses
 258      when dealing with memory, and at the most significant end when
 259      dealing with registers.  */
 260   PAD_UPWARD,
 261
 262   /* Insert padding below the data, i.e. at lower memeory addresses
 263      when dealing with memory, and at the least significant end when
 264      dealing with registers.  */
 265   PAD_DOWNWARD
 266 };
 267
 268 /* Possible initialization status of a variable.   When requested
 269    by the user, this information is tracked and recorded in the DWARF
 270    debug information, along with the variable's location.  */
 271 enum var_init_status
 272 {
 273   VAR_INIT_STATUS_UNKNOWN,
 274   VAR_INIT_STATUS_UNINITIALIZED,
 275   VAR_INIT_STATUS_INITIALIZED
 276 };
 277
 278 /* Names for the different levels of -Wstrict-overflow=N.  The numeric
 279    values here correspond to N.  */
 280 enum warn_strict_overflow_code
 281 {
 282   /* Overflow warning that should be issued with -Wall: a questionable
 283      construct that is easy to avoid even when using macros.  Example:
 284      folding (x + CONSTANT > x) to 1.  */
 285   WARN_STRICT_OVERFLOW_ALL = 1,
 286   /* Overflow warning about folding a comparison to a constant because
 287      of undefined signed overflow, other than cases covered by
 288      WARN_STRICT_OVERFLOW_ALL.  Example: folding (abs (x) >= 0) to 1
 289      (this is false when x == INT_MIN).  */
 290   WARN_STRICT_OVERFLOW_CONDITIONAL = 2,
 291   /* Overflow warning about changes to comparisons other than folding
 292      them to a constant.  Example: folding (x + 1 > 1) to (x > 0).  */
 293   WARN_STRICT_OVERFLOW_COMPARISON = 3,
 294   /* Overflow warnings not covered by the above cases.  Example:
 295      folding ((x * 10) / 5) to (x * 2).  */
 296   WARN_STRICT_OVERFLOW_MISC = 4,
 297   /* Overflow warnings about reducing magnitude of constants in
 298      comparison.  Example: folding (x + 2 > y) to (x + 1 >= y).  */
 299   WARN_STRICT_OVERFLOW_MAGNITUDE = 5
 300 };
 301
 302 /* The type of an alias set.  Code currently assumes that variables of
 303    this type can take the values 0 (the alias set which aliases
 304    everything) and -1 (sometimes indicating that the alias set is
 305    unknown, sometimes indicating a memory barrier) and -2 (indicating
 306    that the alias set should be set to a unique value but has not been
 307    set yet).  */
 308 typedef int alias_set_type;
 309
 310 class edge_def;
 311 typedef class edge_def *edge;
 312 typedef const class edge_def *const_edge;
 313 struct basic_block_def;
 314 typedef struct basic_block_def *basic_block;
 315 typedef const struct basic_block_def *const_basic_block;
 316
 317 #if !defined (GENERATOR_FILE)
 318 # define OBSTACK_CHUNK_SIZE     memory_block_pool::block_size
 319 # define obstack_chunk_alloc    mempool_obstack_chunk_alloc
 320 # define obstack_chunk_free     mempool_obstack_chunk_free
 321 #else
 322 # define OBSTACK_CHUNK_SIZE     0
 323 # define obstack_chunk_alloc    xmalloc
 324 # define obstack_chunk_free     free
 325 #endif
 326
 327 #define gcc_obstack_init(OBSTACK)                               \
 328   obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
 329                               obstack_chunk_alloc,              \
 330                               obstack_chunk_free)
 331
 332 /* enum reg_class is target specific, so it should not appear in
 333    target-independent code or interfaces, like the target hook declarations
 334    in target.h.  */
 335 typedef int reg_class_t;
 336
 337 class rtl_opt_pass;
 338
 339 namespace gcc {
 340   class context;
 341 }
 342
 343 typedef std::pair <tree, tree> tree_pair;
 344 typedef std::pair <const char *, int> string_int_pair;
 345
 346 /* Define a name->value mapping.  */
 347 template <typename ValueType>
 348 struct kv_pair
 349 {
 350   const char *const name;       /* the name of the value */
 351   const ValueType value;        /* the value of the name */
 352 };
 353
 354 #else
 355
 356 struct _dont_use_rtx_here_;
 357 struct _dont_use_rtvec_here_;
 358 struct _dont_use_rtx_insn_here_;
 359 union _dont_use_tree_here_;
 360 #define rtx struct _dont_use_rtx_here_ *
 361 #define const_rtx struct _dont_use_rtx_here_ *
 362 #define rtvec struct _dont_use_rtvec_here *
 363 #define const_rtvec struct _dont_use_rtvec_here *
 364 #define rtx_insn struct _dont_use_rtx_insn_here_
 365 #define tree union _dont_use_tree_here_ *
 366 #define const_tree union _dont_use_tree_here_ *
 367
 368 typedef struct scalar_mode scalar_mode;
 369 typedef struct scalar_int_mode scalar_int_mode;
 370 typedef struct scalar_float_mode scalar_float_mode;
 371 typedef struct complex_mode complex_mode;
 372
 373 #endif
 374
 375 /* Classes of functions that compiler needs to check
 376    whether they are present at the runtime or not.  */
 377 enum function_class {
 378   function_c94,
 379   function_c99_misc,
 380   function_c99_math_complex,
 381   function_sincos,
 382   function_c11_misc,
 383   function_c2x_misc
 384 };
 385
 386 /* Enumerate visibility settings.  This is deliberately ordered from most
 387    to least visibility.  */
 388 enum symbol_visibility
 389 {
 390   VISIBILITY_DEFAULT,
 391   VISIBILITY_PROTECTED,
 392   VISIBILITY_HIDDEN,
 393   VISIBILITY_INTERNAL
 394 };
 395
 396 /* enums used by the targetm.excess_precision hook.  */
 397
 398 enum flt_eval_method
 399 {
 400   FLT_EVAL_METHOD_UNPREDICTABLE = -1,
 401   FLT_EVAL_METHOD_PROMOTE_TO_FLOAT = 0,
 402   FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE = 1,
 403   FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE = 2,
 404   FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16 = 16
 405 };
 406
 407 enum excess_precision_type
 408 {
 409   EXCESS_PRECISION_TYPE_IMPLICIT,
 410   EXCESS_PRECISION_TYPE_STANDARD,
 411   EXCESS_PRECISION_TYPE_FAST
 412 };
 413
 414 /* Support for user-provided GGC and PCH markers.  The first parameter
 415    is a pointer to a pointer, the second a cookie.  */
 416 typedef void (*gt_pointer_operator) (void *, void *);
 417
 418 #if !defined (HAVE_UCHAR)
 419 typedef unsigned char uchar;
 420 #endif
 421
 422 /* Most source files will require the following headers.  */
 423 #if !defined (USED_FOR_TARGET)
 424 #include "insn-modes.h"
 425 #include "signop.h"
 426 #include "wide-int.h"
 427 #include "wide-int-print.h"
 428
 429 /* On targets that don't need polynomial offsets, target-specific code
 430    should be able to treat poly_int like a normal constant, with a
 431    conversion operator going from the former to the latter.  We also
 432    allow this for gencondmd.c for all targets, so that we can treat
 433    machine_modes as enums without causing build failures.  */
 434 #if (defined (IN_TARGET_CODE) \
 435      && (defined (USE_ENUM_MODES) || NUM_POLY_INT_COEFFS == 1))
 436 #define POLY_INT_CONVERSION 1
 437 #else
 438 #define POLY_INT_CONVERSION 0
 439 #endif
 440
 441 #include "poly-int.h"
 442 #include "poly-int-types.h"
 443 #include "insn-modes-inline.h"
 444 #include "machmode.h"
 445 #include "double-int.h"
 446 #include "align.h"
 447 /* Most host source files will require the following headers.  */
 448 #if !defined (GENERATOR_FILE)
 449 #include "real.h"
 450 #include "fixed-value.h"
 451 #include "hash-table.h"
 452 #include "hash-set.h"
 453 #include "input.h"
 454 #include "is-a.h"
 455 #include "memory-block.h"
 456 #include "dumpfile.h"
 457 #endif
 458 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
 459
 460 #endif /* coretypes.h */