gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2015 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_for;
 116 struct gomp_parallel;
 117 struct gomp_task;
 118 struct gomp_sections;
 119 struct gomp_single;
 120 struct gomp_target;
 121 struct gomp_teams;
 122
 123 union section;
 124 typedef union section section;
 125 struct gcc_options;
 126 struct cl_target_option;
 127 struct cl_optimization;
 128 struct cl_option;
 129 struct cl_decoded_option;
 130 struct cl_option_handlers;
 131 struct diagnostic_context;
 132 struct pretty_printer;
 133
 134 /* Address space number for named address space support.  */
 135 typedef unsigned char addr_space_t;
 136
 137 /* The value of addr_space_t that represents the generic address space.  */
 138 #define ADDR_SPACE_GENERIC 0
 139 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 140
 141 /* The major intermediate representations of GCC.  */
 142 enum ir_type {
 143   IR_GIMPLE,
 144   IR_RTL_CFGRTL,
 145   IR_RTL_CFGLAYOUT
 146 };
 147
 148 /* Provide forward struct declaration so that we don't have to include
 149    all of cpplib.h whenever a random prototype includes a pointer.
 150    Note that the cpp_reader and cpp_token typedefs remain part of
 151    cpplib.h.  */
 152
 153 struct cpp_reader;
 154 struct cpp_token;
 155
 156 /* The thread-local storage model associated with a given VAR_DECL
 157    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 158    to it, so it's here.  */
 159 enum tls_model {
 160   TLS_MODEL_NONE,
 161   TLS_MODEL_EMULATED,
 162   TLS_MODEL_REAL,
 163   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 164   TLS_MODEL_LOCAL_DYNAMIC,
 165   TLS_MODEL_INITIAL_EXEC,
 166   TLS_MODEL_LOCAL_EXEC
 167 };
 168
 169 /* Types of ABI for an offload compiler.  */
 170 enum offload_abi {
 171   OFFLOAD_ABI_UNSET,
 172   OFFLOAD_ABI_LP64,
 173   OFFLOAD_ABI_ILP32
 174 };
 175
 176 /* Types of unwind/exception handling info that can be generated.  */
 177
 178 enum unwind_info_type
 179 {
 180   UI_NONE,
 181   UI_SJLJ,
 182   UI_DWARF2,
 183   UI_TARGET,
 184   UI_SEH
 185 };
 186
 187 /* Callgraph node profile representation.  */
 188 enum node_frequency {
 189   /* This function most likely won't be executed at all.
 190      (set only when profile feedback is available or via function attribute). */
 191   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 192   /* For functions that are known to be executed once (i.e. constructors, destructors
 193      and main function.  */
 194   NODE_FREQUENCY_EXECUTED_ONCE,
 195   /* The default value.  */
 196   NODE_FREQUENCY_NORMAL,
 197   /* Optimize this function hard
 198      (set only when profile feedback is available or via function attribute). */
 199   NODE_FREQUENCY_HOT
 200 };
 201
 202 /* Possible initialization status of a variable.   When requested
 203    by the user, this information is tracked and recorded in the DWARF
 204    debug information, along with the variable's location.  */
 205 enum var_init_status
 206 {
 207   VAR_INIT_STATUS_UNKNOWN,
 208   VAR_INIT_STATUS_UNINITIALIZED,
 209   VAR_INIT_STATUS_INITIALIZED
 210 };
 211
 212 /* The type of an alias set.  Code currently assumes that variables of
 213    this type can take the values 0 (the alias set which aliases
 214    everything) and -1 (sometimes indicating that the alias set is
 215    unknown, sometimes indicating a memory barrier) and -2 (indicating
 216    that the alias set should be set to a unique value but has not been
 217    set yet).  */
 218 typedef int alias_set_type;
 219
 220 struct edge_def;
 221 typedef struct edge_def *edge;
 222 typedef const struct edge_def *const_edge;
 223 struct basic_block_def;
 224 typedef struct basic_block_def *basic_block;
 225 typedef const struct basic_block_def *const_basic_block;
 226
 227 #if !defined (GENERATOR_FILE)
 228 # define OBSTACK_CHUNK_SIZE     memory_block_pool::block_size
 229 # define obstack_chunk_alloc    mempool_obstack_chunk_alloc
 230 # define obstack_chunk_free     mempool_obstack_chunk_free
 231 #else
 232 # define OBSTACK_CHUNK_SIZE     0
 233 # define obstack_chunk_alloc    xmalloc
 234 # define obstack_chunk_free     free
 235 #endif
 236
 237 #define gcc_obstack_init(OBSTACK)                               \
 238   obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
 239                               obstack_chunk_alloc,              \
 240                               obstack_chunk_free)
 241
 242 /* enum reg_class is target specific, so it should not appear in
 243    target-independent code or interfaces, like the target hook declarations
 244    in target.h.  */
 245 typedef int reg_class_t;
 246
 247 class rtl_opt_pass;
 248
 249 namespace gcc {
 250   class context;
 251 }
 252
 253 #else
 254
 255 struct _dont_use_rtx_here_;
 256 struct _dont_use_rtvec_here_;
 257 struct _dont_use_rtx_insn_here_;
 258 union _dont_use_tree_here_;
 259 #define rtx struct _dont_use_rtx_here_ *
 260 #define const_rtx struct _dont_use_rtx_here_ *
 261 #define rtvec struct _dont_use_rtvec_here *
 262 #define const_rtvec struct _dont_use_rtvec_here *
 263 #define rtx_insn struct _dont_use_rtx_insn_here_
 264 #define tree union _dont_use_tree_here_ *
 265 #define const_tree union _dont_use_tree_here_ *
 266
 267 #endif
 268
 269 /* Classes of functions that compiler needs to check
 270    whether they are present at the runtime or not.  */
 271 enum function_class {
 272   function_c94,
 273   function_c99_misc,
 274   function_c99_math_complex,
 275   function_sincos,
 276   function_c11_misc
 277 };
 278
 279 /* Enumerate visibility settings.  This is deliberately ordered from most
 280    to least visibility.  */
 281 enum symbol_visibility
 282 {
 283   VISIBILITY_DEFAULT,
 284   VISIBILITY_PROTECTED,
 285   VISIBILITY_HIDDEN,
 286   VISIBILITY_INTERNAL
 287 };
 288
 289 /* Suppose that higher bits are target dependent. */
 290 #define MEMMODEL_MASK ((1<<16)-1)
 291
 292 /* Legacy sync operations set this upper flag in the memory model.  This allows
 293    targets that need to do something stronger for sync operations to
 294    differentiate with their target patterns and issue a more appropriate insn
 295    sequence.  See bugzilla 65697 for background.  */
 296 #define MEMMODEL_SYNC (1<<15)
 297
 298 /* Memory model without SYNC bit for targets/operations that do not care.  */
 299 #define MEMMODEL_BASE_MASK (MEMMODEL_SYNC-1)
 300
 301 /* Memory model types for the __atomic* builtins.
 302    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 303 enum memmodel
 304 {
 305   MEMMODEL_RELAXED = 0,
 306   MEMMODEL_CONSUME = 1,
 307   MEMMODEL_ACQUIRE = 2,
 308   MEMMODEL_RELEASE = 3,
 309   MEMMODEL_ACQ_REL = 4,
 310   MEMMODEL_SEQ_CST = 5,
 311   MEMMODEL_LAST = 6,
 312   MEMMODEL_SYNC_ACQUIRE = MEMMODEL_ACQUIRE | MEMMODEL_SYNC,
 313   MEMMODEL_SYNC_RELEASE = MEMMODEL_RELEASE | MEMMODEL_SYNC,
 314   MEMMODEL_SYNC_SEQ_CST = MEMMODEL_SEQ_CST | MEMMODEL_SYNC
 315 };
 316
 317 /* Support for user-provided GGC and PCH markers.  The first parameter
 318    is a pointer to a pointer, the second a cookie.  */
 319 typedef void (*gt_pointer_operator) (void *, void *);
 320
 321 #if !defined (HAVE_UCHAR)
 322 typedef unsigned char uchar;
 323 #endif
 324
 325 /* Most host source files will require the following headers.  */
 326 #if !defined (GENERATOR_FILE) && !defined (USED_FOR_TARGET)
 327 #include "machmode.h"
 328 #include "signop.h"
 329 #include "wide-int.h"
 330 #include "double-int.h"
 331 #include "real.h"
 332 #include "fixed-value.h"
 333 #include "hash-table.h"
 334 #include "hash-set.h"
 335 #include "input.h"
 336 #include "is-a.h"
 337 #include "memory-block.h"
 338 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
 339
 340 #endif /* coretypes.h */