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