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