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