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