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