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