gcc/coretypes.h

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