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