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_phi;
 142 typedef struct gimple_statement_phi *gimple_phi;
 143 typedef const struct gimple_statement_phi *const_gimple_phi;
 144
 145 union section;
 146 typedef union section section;
 147 struct gcc_options;
 148 struct cl_target_option;
 149 struct cl_optimization;
 150 struct cl_option;
 151 struct cl_decoded_option;
 152 struct cl_option_handlers;
 153 struct diagnostic_context;
 154 struct pretty_printer;
 155
 156 /* Address space number for named address space support.  */
 157 typedef unsigned char addr_space_t;
 158
 159 /* The value of addr_space_t that represents the generic address space.  */
 160 #define ADDR_SPACE_GENERIC 0
 161 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 162
 163 /* The major intermediate representations of GCC.  */
 164 enum ir_type {
 165   IR_GIMPLE,
 166   IR_RTL_CFGRTL,
 167   IR_RTL_CFGLAYOUT
 168 };
 169
 170 /* Provide forward struct declaration so that we don't have to include
 171    all of cpplib.h whenever a random prototype includes a pointer.
 172    Note that the cpp_reader and cpp_token typedefs remain part of
 173    cpplib.h.  */
 174
 175 struct cpp_reader;
 176 struct cpp_token;
 177
 178 /* The thread-local storage model associated with a given VAR_DECL
 179    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 180    to it, so it's here.  */
 181 enum tls_model {
 182   TLS_MODEL_NONE,
 183   TLS_MODEL_EMULATED,
 184   TLS_MODEL_REAL,
 185   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 186   TLS_MODEL_LOCAL_DYNAMIC,
 187   TLS_MODEL_INITIAL_EXEC,
 188   TLS_MODEL_LOCAL_EXEC
 189 };
 190
 191 /* Types of unwind/exception handling info that can be generated.  */
 192
 193 enum unwind_info_type
 194 {
 195   UI_NONE,
 196   UI_SJLJ,
 197   UI_DWARF2,
 198   UI_TARGET,
 199   UI_SEH
 200 };
 201
 202 /* Callgraph node profile representation.  */
 203 enum node_frequency {
 204   /* This function most likely won't be executed at all.
 205      (set only when profile feedback is available or via function attribute). */
 206   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 207   /* For functions that are known to be executed once (i.e. constructors, destructors
 208      and main function.  */
 209   NODE_FREQUENCY_EXECUTED_ONCE,
 210   /* The default value.  */
 211   NODE_FREQUENCY_NORMAL,
 212   /* Optimize this function hard
 213      (set only when profile feedback is available or via function attribute). */
 214   NODE_FREQUENCY_HOT
 215 };
 216
 217 /* Possible initialization status of a variable.   When requested
 218    by the user, this information is tracked and recorded in the DWARF
 219    debug information, along with the variable's location.  */
 220 enum var_init_status
 221 {
 222   VAR_INIT_STATUS_UNKNOWN,
 223   VAR_INIT_STATUS_UNINITIALIZED,
 224   VAR_INIT_STATUS_INITIALIZED
 225 };
 226
 227
 228 struct edge_def;
 229 typedef struct edge_def *edge;
 230 typedef const struct edge_def *const_edge;
 231 struct basic_block_def;
 232 typedef struct basic_block_def *basic_block;
 233 typedef const struct basic_block_def *const_basic_block;
 234
 235 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 236 #define obstack_chunk_free      ((void (*) (void *)) free)
 237 #define OBSTACK_CHUNK_SIZE      0
 238 #define gcc_obstack_init(OBSTACK)                       \
 239   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 240                   obstack_chunk_alloc,                  \
 241                   obstack_chunk_free)
 242
 243 /* enum reg_class is target specific, so it should not appear in
 244    target-independent code or interfaces, like the target hook declarations
 245    in target.h.  */
 246 typedef int reg_class_t;
 247
 248 class rtl_opt_pass;
 249
 250 namespace gcc {
 251   class context;
 252 }
 253
 254 #else
 255
 256 struct _dont_use_rtx_here_;
 257 struct _dont_use_rtvec_here_;
 258 struct _dont_use_rtx_insn_here_;
 259 union _dont_use_tree_here_;
 260 #define rtx struct _dont_use_rtx_here_ *
 261 #define const_rtx struct _dont_use_rtx_here_ *
 262 #define rtvec struct _dont_use_rtvec_here *
 263 #define const_rtvec struct _dont_use_rtvec_here *
 264 #define rtx_insn struct _dont_use_rtx_insn_here_
 265 #define tree union _dont_use_tree_here_ *
 266 #define const_tree union _dont_use_tree_here_ *
 267
 268 #endif
 269
 270 /* Classes of functions that compiler needs to check
 271    whether they are present at the runtime or not.  */
 272 enum function_class {
 273   function_c94,
 274   function_c99_misc,
 275   function_c99_math_complex,
 276   function_sincos,
 277   function_c11_misc
 278 };
 279
 280 /* Memory model types for the __atomic* builtins.
 281    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 282 enum memmodel
 283 {
 284   MEMMODEL_RELAXED = 0,
 285   MEMMODEL_CONSUME = 1,
 286   MEMMODEL_ACQUIRE = 2,
 287   MEMMODEL_RELEASE = 3,
 288   MEMMODEL_ACQ_REL = 4,
 289   MEMMODEL_SEQ_CST = 5,
 290   MEMMODEL_LAST = 6
 291 };
 292
 293 /* Suppose that higher bits are target dependent. */
 294 #define MEMMODEL_MASK ((1<<16)-1)
 295
 296 /* Support for user-provided GGC and PCH markers.  The first parameter
 297    is a pointer to a pointer, the second a cookie.  */
 298 typedef void (*gt_pointer_operator) (void *, void *);
 299
 300 #if !defined (HAVE_UCHAR)
 301 typedef unsigned char uchar;
 302 #endif
 303
 304 #endif /* coretypes.h */