gcc/coretypes.h

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