gcc/coretypes.h

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