gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2014 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 typedef struct gimple_statement_base *gimple;
  86 typedef const struct gimple_statement_base *const_gimple;
  87 typedef gimple gimple_seq;
  88 struct gimple_stmt_iterator;
  89
  90 /* Typedefs for leaf gimple subclasses (for individual gimple codes).
  91    Keep this in the same order as the corresponding codes in gimple.def.  */
  92
  93 struct gimple_statement_cond;
  94 typedef struct gimple_statement_cond *gimple_cond;
  95 typedef const struct gimple_statement_cond *const_gimple_cond;
  96
  97 struct gimple_statement_debug;
  98 typedef struct gimple_statement_debug *gimple_debug;
  99 typedef const struct gimple_statement_debug *const_gimple_debug;
 100
 101 struct gimple_statement_goto;
 102 typedef struct gimple_statement_goto *gimple_goto;
 103 typedef const struct gimple_statement_goto *const_gimple_goto;
 104
 105 struct gimple_statement_label;
 106 typedef struct gimple_statement_label *gimple_label;
 107 typedef const struct gimple_statement_label *const_gimple_label;
 108
 109 struct gimple_statement_switch;
 110 typedef struct gimple_statement_switch *gimple_switch;
 111 typedef const struct gimple_statement_switch *const_gimple_switch;
 112
 113 struct gimple_statement_assign;
 114 typedef struct gimple_statement_assign *gimple_assign;
 115 typedef const struct gimple_statement_assign *const_gimple_assign;
 116
 117 struct gimple_statement_asm;
 118 typedef struct gimple_statement_asm *gimple_asm;
 119 typedef const struct gimple_statement_asm *const_gimple_asm;
 120
 121 struct gimple_statement_call;
 122 typedef struct gimple_statement_call *gimple_call;
 123 typedef const struct gimple_statement_call *const_gimple_call;
 124
 125 struct gimple_statement_transaction;
 126 typedef struct gimple_statement_transaction *gimple_transaction;
 127 typedef const struct gimple_statement_transaction *const_gimple_transaction;
 128
 129 struct gimple_statement_return;
 130 typedef struct gimple_statement_return *gimple_return;
 131 typedef const struct gimple_statement_return *const_gimple_return;
 132
 133 struct gimple_statement_bind;
 134 typedef struct gimple_statement_bind *gimple_bind;
 135 typedef const struct gimple_statement_bind *const_gimple_bind;
 136
 137 struct gimple_statement_catch;
 138 typedef struct gimple_statement_catch *gimple_catch;
 139 typedef const struct gimple_statement_catch *const_gimple_catch;
 140
 141 struct gimple_statement_eh_filter;
 142 typedef struct gimple_statement_eh_filter *gimple_eh_filter;
 143 typedef const struct gimple_statement_eh_filter *const_gimple_eh_filter;
 144
 145 struct gimple_statement_eh_mnt;
 146 typedef struct gimple_statement_eh_mnt *gimple_eh_must_not_throw;
 147 typedef const struct gimple_statement_eh_mnt *const_gimple_eh_must_not_throw;
 148
 149 struct gimple_statement_eh_else;
 150 typedef struct gimple_statement_eh_else *gimple_eh_else;
 151 typedef const struct gimple_statement_eh_else *const_gimple_eh_else;
 152
 153 struct gimple_statement_resx;
 154 typedef struct gimple_statement_resx *gimple_resx;
 155 typedef const struct gimple_statement_resx *const_gimple_resx;
 156
 157 struct gimple_statement_eh_dispatch;
 158 typedef struct gimple_statement_eh_dispatch *gimple_eh_dispatch;
 159 typedef const struct gimple_statement_eh_dispatch *const_gimple_eh_dispatch;
 160
 161 struct gimple_statement_phi;
 162 typedef struct gimple_statement_phi *gimple_phi;
 163 typedef const struct gimple_statement_phi *const_gimple_phi;
 164
 165 struct gimple_statement_try;
 166 typedef struct gimple_statement_try *gimple_try;
 167 typedef const struct gimple_statement_try *const_gimple_try;
 168
 169 struct gimple_statement_omp_atomic_load;
 170 typedef struct gimple_statement_omp_atomic_load *gimple_omp_atomic_load;
 171 typedef const struct gimple_statement_omp_atomic_load *
 172   const_gimple_omp_atomic_load;
 173
 174 struct gimple_statement_omp_atomic_store;
 175 typedef struct gimple_statement_omp_atomic_store *gimple_omp_atomic_store;
 176 typedef const struct gimple_statement_omp_atomic_store *
 177   const_gimple_omp_atomic_store;
 178
 179 struct gimple_statement_omp_continue;
 180 typedef struct gimple_statement_omp_continue *gimple_omp_continue;
 181 typedef const struct gimple_statement_omp_continue *const_gimple_omp_continue;
 182
 183 union section;
 184 typedef union section section;
 185 struct gcc_options;
 186 struct cl_target_option;
 187 struct cl_optimization;
 188 struct cl_option;
 189 struct cl_decoded_option;
 190 struct cl_option_handlers;
 191 struct diagnostic_context;
 192 struct pretty_printer;
 193
 194 /* Address space number for named address space support.  */
 195 typedef unsigned char addr_space_t;
 196
 197 /* The value of addr_space_t that represents the generic address space.  */
 198 #define ADDR_SPACE_GENERIC 0
 199 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 200
 201 /* The major intermediate representations of GCC.  */
 202 enum ir_type {
 203   IR_GIMPLE,
 204   IR_RTL_CFGRTL,
 205   IR_RTL_CFGLAYOUT
 206 };
 207
 208 /* Provide forward struct declaration so that we don't have to include
 209    all of cpplib.h whenever a random prototype includes a pointer.
 210    Note that the cpp_reader and cpp_token typedefs remain part of
 211    cpplib.h.  */
 212
 213 struct cpp_reader;
 214 struct cpp_token;
 215
 216 /* The thread-local storage model associated with a given VAR_DECL
 217    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 218    to it, so it's here.  */
 219 enum tls_model {
 220   TLS_MODEL_NONE,
 221   TLS_MODEL_EMULATED,
 222   TLS_MODEL_REAL,
 223   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 224   TLS_MODEL_LOCAL_DYNAMIC,
 225   TLS_MODEL_INITIAL_EXEC,
 226   TLS_MODEL_LOCAL_EXEC
 227 };
 228
 229 /* Types of unwind/exception handling info that can be generated.  */
 230
 231 enum unwind_info_type
 232 {
 233   UI_NONE,
 234   UI_SJLJ,
 235   UI_DWARF2,
 236   UI_TARGET,
 237   UI_SEH
 238 };
 239
 240 /* Callgraph node profile representation.  */
 241 enum node_frequency {
 242   /* This function most likely won't be executed at all.
 243      (set only when profile feedback is available or via function attribute). */
 244   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 245   /* For functions that are known to be executed once (i.e. constructors, destructors
 246      and main function.  */
 247   NODE_FREQUENCY_EXECUTED_ONCE,
 248   /* The default value.  */
 249   NODE_FREQUENCY_NORMAL,
 250   /* Optimize this function hard
 251      (set only when profile feedback is available or via function attribute). */
 252   NODE_FREQUENCY_HOT
 253 };
 254
 255 /* Possible initialization status of a variable.   When requested
 256    by the user, this information is tracked and recorded in the DWARF
 257    debug information, along with the variable's location.  */
 258 enum var_init_status
 259 {
 260   VAR_INIT_STATUS_UNKNOWN,
 261   VAR_INIT_STATUS_UNINITIALIZED,
 262   VAR_INIT_STATUS_INITIALIZED
 263 };
 264
 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 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 274 #define obstack_chunk_free      ((void (*) (void *)) free)
 275 #define OBSTACK_CHUNK_SIZE      0
 276 #define gcc_obstack_init(OBSTACK)                       \
 277   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 278                   obstack_chunk_alloc,                  \
 279                   obstack_chunk_free)
 280
 281 /* enum reg_class is target specific, so it should not appear in
 282    target-independent code or interfaces, like the target hook declarations
 283    in target.h.  */
 284 typedef int reg_class_t;
 285
 286 class rtl_opt_pass;
 287
 288 namespace gcc {
 289   class context;
 290 }
 291
 292 #else
 293
 294 struct _dont_use_rtx_here_;
 295 struct _dont_use_rtvec_here_;
 296 struct _dont_use_rtx_insn_here_;
 297 union _dont_use_tree_here_;
 298 #define rtx struct _dont_use_rtx_here_ *
 299 #define const_rtx struct _dont_use_rtx_here_ *
 300 #define rtvec struct _dont_use_rtvec_here *
 301 #define const_rtvec struct _dont_use_rtvec_here *
 302 #define rtx_insn struct _dont_use_rtx_insn_here_
 303 #define tree union _dont_use_tree_here_ *
 304 #define const_tree union _dont_use_tree_here_ *
 305
 306 #endif
 307
 308 /* Classes of functions that compiler needs to check
 309    whether they are present at the runtime or not.  */
 310 enum function_class {
 311   function_c94,
 312   function_c99_misc,
 313   function_c99_math_complex,
 314   function_sincos,
 315   function_c11_misc
 316 };
 317
 318 /* Memory model types for the __atomic* builtins.
 319    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 320 enum memmodel
 321 {
 322   MEMMODEL_RELAXED = 0,
 323   MEMMODEL_CONSUME = 1,
 324   MEMMODEL_ACQUIRE = 2,
 325   MEMMODEL_RELEASE = 3,
 326   MEMMODEL_ACQ_REL = 4,
 327   MEMMODEL_SEQ_CST = 5,
 328   MEMMODEL_LAST = 6
 329 };
 330
 331 /* Suppose that higher bits are target dependent. */
 332 #define MEMMODEL_MASK ((1<<16)-1)
 333
 334 /* Support for user-provided GGC and PCH markers.  The first parameter
 335    is a pointer to a pointer, the second a cookie.  */
 336 typedef void (*gt_pointer_operator) (void *, void *);
 337
 338 #if !defined (HAVE_UCHAR)
 339 typedef unsigned char uchar;
 340 #endif
 341
 342 #endif /* coretypes.h */