gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2016 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 };
 182
 183 /* Types of unwind/exception handling info that can be generated.  */
 184
 185 enum unwind_info_type
 186 {
 187   UI_NONE,
 188   UI_SJLJ,
 189   UI_DWARF2,
 190   UI_TARGET,
 191   UI_SEH
 192 };
 193
 194 /* Callgraph node profile representation.  */
 195 enum node_frequency {
 196   /* This function most likely won't be executed at all.
 197      (set only when profile feedback is available or via function attribute). */
 198   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 199   /* For functions that are known to be executed once (i.e. constructors, destructors
 200      and main function.  */
 201   NODE_FREQUENCY_EXECUTED_ONCE,
 202   /* The default value.  */
 203   NODE_FREQUENCY_NORMAL,
 204   /* Optimize this function hard
 205      (set only when profile feedback is available or via function attribute). */
 206   NODE_FREQUENCY_HOT
 207 };
 208
 209 /* Ways of optimizing code.  */
 210 enum optimization_type {
 211   /* Prioritize speed over size.  */
 212   OPTIMIZE_FOR_SPEED,
 213
 214   /* Only do things that are good for both size and speed.  */
 215   OPTIMIZE_FOR_BOTH,
 216
 217   /* Prioritize size over speed.  */
 218   OPTIMIZE_FOR_SIZE
 219 };
 220
 221 /* Possible initialization status of a variable.   When requested
 222    by the user, this information is tracked and recorded in the DWARF
 223    debug information, along with the variable's location.  */
 224 enum var_init_status
 225 {
 226   VAR_INIT_STATUS_UNKNOWN,
 227   VAR_INIT_STATUS_UNINITIALIZED,
 228   VAR_INIT_STATUS_INITIALIZED
 229 };
 230
 231 /* Names for the different levels of -Wstrict-overflow=N.  The numeric
 232    values here correspond to N.  */
 233 enum warn_strict_overflow_code
 234 {
 235   /* Overflow warning that should be issued with -Wall: a questionable
 236      construct that is easy to avoid even when using macros.  Example:
 237      folding (x + CONSTANT > x) to 1.  */
 238   WARN_STRICT_OVERFLOW_ALL = 1,
 239   /* Overflow warning about folding a comparison to a constant because
 240      of undefined signed overflow, other than cases covered by
 241      WARN_STRICT_OVERFLOW_ALL.  Example: folding (abs (x) >= 0) to 1
 242      (this is false when x == INT_MIN).  */
 243   WARN_STRICT_OVERFLOW_CONDITIONAL = 2,
 244   /* Overflow warning about changes to comparisons other than folding
 245      them to a constant.  Example: folding (x + 1 > 1) to (x > 0).  */
 246   WARN_STRICT_OVERFLOW_COMPARISON = 3,
 247   /* Overflow warnings not covered by the above cases.  Example:
 248      folding ((x * 10) / 5) to (x * 2).  */
 249   WARN_STRICT_OVERFLOW_MISC = 4,
 250   /* Overflow warnings about reducing magnitude of constants in
 251      comparison.  Example: folding (x + 2 > y) to (x + 1 >= y).  */
 252   WARN_STRICT_OVERFLOW_MAGNITUDE = 5
 253 };
 254
 255 /* The type of an alias set.  Code currently assumes that variables of
 256    this type can take the values 0 (the alias set which aliases
 257    everything) and -1 (sometimes indicating that the alias set is
 258    unknown, sometimes indicating a memory barrier) and -2 (indicating
 259    that the alias set should be set to a unique value but has not been
 260    set yet).  */
 261 typedef int alias_set_type;
 262
 263 struct edge_def;
 264 typedef struct edge_def *edge;
 265 typedef const struct edge_def *const_edge;
 266 struct basic_block_def;
 267 typedef struct basic_block_def *basic_block;
 268 typedef const struct basic_block_def *const_basic_block;
 269
 270 #if !defined (GENERATOR_FILE)
 271 # define OBSTACK_CHUNK_SIZE     memory_block_pool::block_size
 272 # define obstack_chunk_alloc    mempool_obstack_chunk_alloc
 273 # define obstack_chunk_free     mempool_obstack_chunk_free
 274 #else
 275 # define OBSTACK_CHUNK_SIZE     0
 276 # define obstack_chunk_alloc    xmalloc
 277 # define obstack_chunk_free     free
 278 #endif
 279
 280 #define gcc_obstack_init(OBSTACK)                               \
 281   obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
 282                               obstack_chunk_alloc,              \
 283                               obstack_chunk_free)
 284
 285 /* enum reg_class is target specific, so it should not appear in
 286    target-independent code or interfaces, like the target hook declarations
 287    in target.h.  */
 288 typedef int reg_class_t;
 289
 290 class rtl_opt_pass;
 291
 292 namespace gcc {
 293   class context;
 294 }
 295
 296 typedef std::pair <tree, tree> tree_pair;
 297
 298 #else
 299
 300 struct _dont_use_rtx_here_;
 301 struct _dont_use_rtvec_here_;
 302 struct _dont_use_rtx_insn_here_;
 303 union _dont_use_tree_here_;
 304 #define rtx struct _dont_use_rtx_here_ *
 305 #define const_rtx struct _dont_use_rtx_here_ *
 306 #define rtvec struct _dont_use_rtvec_here *
 307 #define const_rtvec struct _dont_use_rtvec_here *
 308 #define rtx_insn struct _dont_use_rtx_insn_here_
 309 #define tree union _dont_use_tree_here_ *
 310 #define const_tree union _dont_use_tree_here_ *
 311
 312 #endif
 313
 314 /* Classes of functions that compiler needs to check
 315    whether they are present at the runtime or not.  */
 316 enum function_class {
 317   function_c94,
 318   function_c99_misc,
 319   function_c99_math_complex,
 320   function_sincos,
 321   function_c11_misc
 322 };
 323
 324 /* Enumerate visibility settings.  This is deliberately ordered from most
 325    to least visibility.  */
 326 enum symbol_visibility
 327 {
 328   VISIBILITY_DEFAULT,
 329   VISIBILITY_PROTECTED,
 330   VISIBILITY_HIDDEN,
 331   VISIBILITY_INTERNAL
 332 };
 333
 334 /* Suppose that higher bits are target dependent. */
 335 #define MEMMODEL_MASK ((1<<16)-1)
 336
 337 /* Legacy sync operations set this upper flag in the memory model.  This allows
 338    targets that need to do something stronger for sync operations to
 339    differentiate with their target patterns and issue a more appropriate insn
 340    sequence.  See bugzilla 65697 for background.  */
 341 #define MEMMODEL_SYNC (1<<15)
 342
 343 /* Memory model without SYNC bit for targets/operations that do not care.  */
 344 #define MEMMODEL_BASE_MASK (MEMMODEL_SYNC-1)
 345
 346 /* Memory model types for the __atomic* builtins.
 347    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 348 enum memmodel
 349 {
 350   MEMMODEL_RELAXED = 0,
 351   MEMMODEL_CONSUME = 1,
 352   MEMMODEL_ACQUIRE = 2,
 353   MEMMODEL_RELEASE = 3,
 354   MEMMODEL_ACQ_REL = 4,
 355   MEMMODEL_SEQ_CST = 5,
 356   MEMMODEL_LAST = 6,
 357   MEMMODEL_SYNC_ACQUIRE = MEMMODEL_ACQUIRE | MEMMODEL_SYNC,
 358   MEMMODEL_SYNC_RELEASE = MEMMODEL_RELEASE | MEMMODEL_SYNC,
 359   MEMMODEL_SYNC_SEQ_CST = MEMMODEL_SEQ_CST | MEMMODEL_SYNC
 360 };
 361
 362 /* Support for user-provided GGC and PCH markers.  The first parameter
 363    is a pointer to a pointer, the second a cookie.  */
 364 typedef void (*gt_pointer_operator) (void *, void *);
 365
 366 #if !defined (HAVE_UCHAR)
 367 typedef unsigned char uchar;
 368 #endif
 369
 370 /* C++11 adds the ability to add "override" after an implementation of a
 371    virtual function in a subclass, to:
 372      (A) document that this is an override of a virtual function
 373      (B) allow the compiler to issue a warning if it isn't (e.g. a mismatch
 374          of the type signature).
 375
 376    Similarly, it allows us to add a "final" to indicate that no subclass
 377    may subsequently override the vfunc.
 378
 379    Provide OVERRIDE and FINAL as macros, allowing us to get these benefits
 380    when compiling with C++11 support, but without requiring C++11.
 381
 382    For gcc, use "-std=c++11" to enable C++11 support; gcc 6 onwards enables
 383    this by default (actually GNU++14).  */
 384
 385 #if __cplusplus >= 201103
 386 /* C++11 claims to be available: use it: */
 387 #define OVERRIDE override
 388 #define FINAL final
 389 #else
 390 /* No C++11 support; leave the macros empty: */
 391 #define OVERRIDE
 392 #define FINAL
 393 #endif
 394
 395 /* Most host source files will require the following headers.  */
 396 #if !defined (GENERATOR_FILE) && !defined (USED_FOR_TARGET)
 397 #include "machmode.h"
 398 #include "signop.h"
 399 #include "wide-int.h"
 400 #include "double-int.h"
 401 #include "real.h"
 402 #include "fixed-value.h"
 403 #include "hash-table.h"
 404 #include "hash-set.h"
 405 #include "input.h"
 406 #include "is-a.h"
 407 #include "memory-block.h"
 408 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
 409
 410 #endif /* coretypes.h */