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