gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2020 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 class diagnostic_event_id_t;
 157
 158 template<typename T> struct array_traits;
 159
 160 /* Provides a read-only bitmap view of a single integer bitmask or an
 161    array of integer bitmasks, or of a wrapper around such bitmasks.  */
 162 template<typename T, typename Traits = array_traits<T>,
 163          bool has_constant_size = Traits::has_constant_size>
 164 class bitmap_view;
 165
 166 /* Address space number for named address space support.  */
 167 typedef unsigned char addr_space_t;
 168
 169 /* The value of addr_space_t that represents the generic address space.  */
 170 #define ADDR_SPACE_GENERIC 0
 171 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 172
 173 /* The major intermediate representations of GCC.  */
 174 enum ir_type {
 175   IR_GIMPLE,
 176   IR_RTL_CFGRTL,
 177   IR_RTL_CFGLAYOUT
 178 };
 179
 180 /* Provide forward struct declaration so that we don't have to include
 181    all of cpplib.h whenever a random prototype includes a pointer.
 182    Note that the cpp_reader and cpp_token typedefs remain part of
 183    cpplib.h.  */
 184
 185 struct cpp_reader;
 186 struct cpp_token;
 187
 188 /* The thread-local storage model associated with a given VAR_DECL
 189    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 190    to it, so it's here.  */
 191 enum tls_model {
 192   TLS_MODEL_NONE,
 193   TLS_MODEL_EMULATED,
 194   TLS_MODEL_REAL,
 195   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 196   TLS_MODEL_LOCAL_DYNAMIC,
 197   TLS_MODEL_INITIAL_EXEC,
 198   TLS_MODEL_LOCAL_EXEC
 199 };
 200
 201 /* Types of ABI for an offload compiler.  */
 202 enum offload_abi {
 203   OFFLOAD_ABI_UNSET,
 204   OFFLOAD_ABI_LP64,
 205   OFFLOAD_ABI_ILP32
 206 };
 207
 208 /* Types of profile update methods.  */
 209 enum profile_update {
 210   PROFILE_UPDATE_SINGLE,
 211   PROFILE_UPDATE_ATOMIC,
 212   PROFILE_UPDATE_PREFER_ATOMIC
 213 };
 214
 215 /* Type of profile reproducibility methods.  */
 216 enum profile_reproducibility {
 217     PROFILE_REPRODUCIBILITY_SERIAL,
 218     PROFILE_REPRODUCIBILITY_PARALLEL_RUNS,
 219     PROFILE_REPRODUCIBILITY_MULTITHREADED
 220 };
 221
 222 /* Types of unwind/exception handling info that can be generated.  */
 223
 224 enum unwind_info_type
 225 {
 226   UI_NONE,
 227   UI_SJLJ,
 228   UI_DWARF2,
 229   UI_TARGET,
 230   UI_SEH
 231 };
 232
 233 /* Callgraph node profile representation.  */
 234 enum node_frequency {
 235   /* This function most likely won't be executed at all.
 236      (set only when profile feedback is available or via function attribute). */
 237   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 238   /* For functions that are known to be executed once (i.e. constructors, destructors
 239      and main function.  */
 240   NODE_FREQUENCY_EXECUTED_ONCE,
 241   /* The default value.  */
 242   NODE_FREQUENCY_NORMAL,
 243   /* Optimize this function hard
 244      (set only when profile feedback is available or via function attribute). */
 245   NODE_FREQUENCY_HOT
 246 };
 247
 248 /* Ways of optimizing code.  */
 249 enum optimization_type {
 250   /* Prioritize speed over size.  */
 251   OPTIMIZE_FOR_SPEED,
 252
 253   /* Only do things that are good for both size and speed.  */
 254   OPTIMIZE_FOR_BOTH,
 255
 256   /* Prioritize size over speed.  */
 257   OPTIMIZE_FOR_SIZE
 258 };
 259
 260 /* Enumerates a padding direction.  */
 261 enum pad_direction {
 262   /* No padding is required.  */
 263   PAD_NONE,
 264
 265   /* Insert padding above the data, i.e. at higher memeory addresses
 266      when dealing with memory, and at the most significant end when
 267      dealing with registers.  */
 268   PAD_UPWARD,
 269
 270   /* Insert padding below the data, i.e. at lower memeory addresses
 271      when dealing with memory, and at the least significant end when
 272      dealing with registers.  */
 273   PAD_DOWNWARD
 274 };
 275
 276 /* Possible initialization status of a variable.   When requested
 277    by the user, this information is tracked and recorded in the DWARF
 278    debug information, along with the variable's location.  */
 279 enum var_init_status
 280 {
 281   VAR_INIT_STATUS_UNKNOWN,
 282   VAR_INIT_STATUS_UNINITIALIZED,
 283   VAR_INIT_STATUS_INITIALIZED
 284 };
 285
 286 /* Names for the different levels of -Wstrict-overflow=N.  The numeric
 287    values here correspond to N.  */
 288 enum warn_strict_overflow_code
 289 {
 290   /* Overflow warning that should be issued with -Wall: a questionable
 291      construct that is easy to avoid even when using macros.  Example:
 292      folding (x + CONSTANT > x) to 1.  */
 293   WARN_STRICT_OVERFLOW_ALL = 1,
 294   /* Overflow warning about folding a comparison to a constant because
 295      of undefined signed overflow, other than cases covered by
 296      WARN_STRICT_OVERFLOW_ALL.  Example: folding (abs (x) >= 0) to 1
 297      (this is false when x == INT_MIN).  */
 298   WARN_STRICT_OVERFLOW_CONDITIONAL = 2,
 299   /* Overflow warning about changes to comparisons other than folding
 300      them to a constant.  Example: folding (x + 1 > 1) to (x > 0).  */
 301   WARN_STRICT_OVERFLOW_COMPARISON = 3,
 302   /* Overflow warnings not covered by the above cases.  Example:
 303      folding ((x * 10) / 5) to (x * 2).  */
 304   WARN_STRICT_OVERFLOW_MISC = 4,
 305   /* Overflow warnings about reducing magnitude of constants in
 306      comparison.  Example: folding (x + 2 > y) to (x + 1 >= y).  */
 307   WARN_STRICT_OVERFLOW_MAGNITUDE = 5
 308 };
 309
 310 /* The type of an alias set.  Code currently assumes that variables of
 311    this type can take the values 0 (the alias set which aliases
 312    everything) and -1 (sometimes indicating that the alias set is
 313    unknown, sometimes indicating a memory barrier) and -2 (indicating
 314    that the alias set should be set to a unique value but has not been
 315    set yet).  */
 316 typedef int alias_set_type;
 317
 318 class edge_def;
 319 typedef class edge_def *edge;
 320 typedef const class edge_def *const_edge;
 321 struct basic_block_def;
 322 typedef struct basic_block_def *basic_block;
 323 typedef const struct basic_block_def *const_basic_block;
 324
 325 #if !defined (GENERATOR_FILE)
 326 # define OBSTACK_CHUNK_SIZE     memory_block_pool::block_size
 327 # define obstack_chunk_alloc    mempool_obstack_chunk_alloc
 328 # define obstack_chunk_free     mempool_obstack_chunk_free
 329 #else
 330 # define OBSTACK_CHUNK_SIZE     0
 331 # define obstack_chunk_alloc    xmalloc
 332 # define obstack_chunk_free     free
 333 #endif
 334
 335 #define gcc_obstack_init(OBSTACK)                               \
 336   obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
 337                               obstack_chunk_alloc,              \
 338                               obstack_chunk_free)
 339
 340 /* enum reg_class is target specific, so it should not appear in
 341    target-independent code or interfaces, like the target hook declarations
 342    in target.h.  */
 343 typedef int reg_class_t;
 344
 345 class rtl_opt_pass;
 346
 347 namespace gcc {
 348   class context;
 349 }
 350
 351 typedef std::pair <tree, tree> tree_pair;
 352 typedef std::pair <const char *, int> string_int_pair;
 353
 354 /* Define a name->value mapping.  */
 355 template <typename ValueType>
 356 struct kv_pair
 357 {
 358   const char *const name;       /* the name of the value */
 359   const ValueType value;        /* the value of the name */
 360 };
 361
 362 /* Iterator pair used for a collection iteration with range-based loops.  */
 363
 364 template<typename T>
 365 struct iterator_range
 366 {
 367 public:
 368   iterator_range (const T &begin, const T &end)
 369     : m_begin (begin), m_end (end) {}
 370
 371   T begin () const { return m_begin; }
 372   T end () const { return m_end; }
 373
 374 private:
 375   T m_begin;
 376   T m_end;
 377 };
 378
 379 #else
 380
 381 struct _dont_use_rtx_here_;
 382 struct _dont_use_rtvec_here_;
 383 struct _dont_use_rtx_insn_here_;
 384 union _dont_use_tree_here_;
 385 #define rtx struct _dont_use_rtx_here_ *
 386 #define const_rtx struct _dont_use_rtx_here_ *
 387 #define rtvec struct _dont_use_rtvec_here *
 388 #define const_rtvec struct _dont_use_rtvec_here *
 389 #define rtx_insn struct _dont_use_rtx_insn_here_
 390 #define tree union _dont_use_tree_here_ *
 391 #define const_tree union _dont_use_tree_here_ *
 392
 393 typedef struct scalar_mode scalar_mode;
 394 typedef struct scalar_int_mode scalar_int_mode;
 395 typedef struct scalar_float_mode scalar_float_mode;
 396 typedef struct complex_mode complex_mode;
 397
 398 #endif
 399
 400 /* Classes of functions that compiler needs to check
 401    whether they are present at the runtime or not.  */
 402 enum function_class {
 403   function_c94,
 404   function_c99_misc,
 405   function_c99_math_complex,
 406   function_sincos,
 407   function_c11_misc,
 408   function_c2x_misc
 409 };
 410
 411 /* Enumerate visibility settings.  This is deliberately ordered from most
 412    to least visibility.  */
 413 enum symbol_visibility
 414 {
 415   VISIBILITY_DEFAULT,
 416   VISIBILITY_PROTECTED,
 417   VISIBILITY_HIDDEN,
 418   VISIBILITY_INTERNAL
 419 };
 420
 421 /* enums used by the targetm.excess_precision hook.  */
 422
 423 enum flt_eval_method
 424 {
 425   FLT_EVAL_METHOD_UNPREDICTABLE = -1,
 426   FLT_EVAL_METHOD_PROMOTE_TO_FLOAT = 0,
 427   FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE = 1,
 428   FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE = 2,
 429   FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16 = 16
 430 };
 431
 432 enum excess_precision_type
 433 {
 434   EXCESS_PRECISION_TYPE_IMPLICIT,
 435   EXCESS_PRECISION_TYPE_STANDARD,
 436   EXCESS_PRECISION_TYPE_FAST
 437 };
 438
 439 /* Support for user-provided GGC and PCH markers.  The first parameter
 440    is a pointer to a pointer, the second a cookie.  */
 441 typedef void (*gt_pointer_operator) (void *, void *);
 442
 443 #if !defined (HAVE_UCHAR)
 444 typedef unsigned char uchar;
 445 #endif
 446
 447 /* Most source files will require the following headers.  */
 448 #if !defined (USED_FOR_TARGET)
 449 #include "insn-modes.h"
 450 #include "signop.h"
 451 #include "wide-int.h"
 452 #include "wide-int-print.h"
 453
 454 /* On targets that don't need polynomial offsets, target-specific code
 455    should be able to treat poly_int like a normal constant, with a
 456    conversion operator going from the former to the latter.  We also
 457    allow this for gencondmd.c for all targets, so that we can treat
 458    machine_modes as enums without causing build failures.  */
 459 #if (defined (IN_TARGET_CODE) \
 460      && (defined (USE_ENUM_MODES) || NUM_POLY_INT_COEFFS == 1))
 461 #define POLY_INT_CONVERSION 1
 462 #else
 463 #define POLY_INT_CONVERSION 0
 464 #endif
 465
 466 #include "poly-int.h"
 467 #include "poly-int-types.h"
 468 #include "insn-modes-inline.h"
 469 #include "machmode.h"
 470 #include "double-int.h"
 471 #include "align.h"
 472 /* Most host source files will require the following headers.  */
 473 #if !defined (GENERATOR_FILE)
 474 #include "real.h"
 475 #include "fixed-value.h"
 476 #include "hash-table.h"
 477 #include "hash-set.h"
 478 #include "input.h"
 479 #include "is-a.h"
 480 #include "memory-block.h"
 481 #include "dumpfile.h"
 482 #endif
 483 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
 484
 485 #endif /* coretypes.h */