gcc/coretypes.h

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