gcc/coretypes.h

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