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