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 struct rtvec_def;
  59 typedef struct rtvec_def *rtvec;
  60 typedef const struct rtvec_def *const_rtvec;
  61 struct hwivec_def;
  62 typedef struct hwivec_def *hwivec;
  63 typedef const struct hwivec_def *const_hwivec;
  64 union tree_node;
  65 typedef union tree_node *tree;
  66 typedef const union tree_node *const_tree;
  67 typedef struct gimple_statement_base *gimple;
  68 typedef const struct gimple_statement_base *const_gimple;
  69 typedef gimple gimple_seq;
  70 struct gimple_stmt_iterator;
  71 union section;
  72 typedef union section section;
  73 struct gcc_options;
  74 struct cl_target_option;
  75 struct cl_optimization;
  76 struct cl_option;
  77 struct cl_decoded_option;
  78 struct cl_option_handlers;
  79 struct diagnostic_context;
  80 struct pretty_printer;
  81
  82 /* Address space number for named address space support.  */
  83 typedef unsigned char addr_space_t;
  84
  85 /* The value of addr_space_t that represents the generic address space.  */
  86 #define ADDR_SPACE_GENERIC 0
  87 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
  88
  89 /* The major intermediate representations of GCC.  */
  90 enum ir_type {
  91   IR_GIMPLE,
  92   IR_RTL_CFGRTL,
  93   IR_RTL_CFGLAYOUT
  94 };
  95
  96 /* Provide forward struct declaration so that we don't have to include
  97    all of cpplib.h whenever a random prototype includes a pointer.
  98    Note that the cpp_reader and cpp_token typedefs remain part of
  99    cpplib.h.  */
 100
 101 struct cpp_reader;
 102 struct cpp_token;
 103
 104 /* The thread-local storage model associated with a given VAR_DECL
 105    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 106    to it, so it's here.  */
 107 enum tls_model {
 108   TLS_MODEL_NONE,
 109   TLS_MODEL_EMULATED,
 110   TLS_MODEL_REAL,
 111   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 112   TLS_MODEL_LOCAL_DYNAMIC,
 113   TLS_MODEL_INITIAL_EXEC,
 114   TLS_MODEL_LOCAL_EXEC
 115 };
 116
 117 /* Types of unwind/exception handling info that can be generated.  */
 118
 119 enum unwind_info_type
 120 {
 121   UI_NONE,
 122   UI_SJLJ,
 123   UI_DWARF2,
 124   UI_TARGET,
 125   UI_SEH
 126 };
 127
 128 /* Callgraph node profile representation.  */
 129 enum node_frequency {
 130   /* This function most likely won't be executed at all.
 131      (set only when profile feedback is available or via function attribute). */
 132   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 133   /* For functions that are known to be executed once (i.e. constructors, destructors
 134      and main function.  */
 135   NODE_FREQUENCY_EXECUTED_ONCE,
 136   /* The default value.  */
 137   NODE_FREQUENCY_NORMAL,
 138   /* Optimize this function hard
 139      (set only when profile feedback is available or via function attribute). */
 140   NODE_FREQUENCY_HOT
 141 };
 142
 143 /* Possible initialization status of a variable.   When requested
 144    by the user, this information is tracked and recorded in the DWARF
 145    debug information, along with the variable's location.  */
 146 enum var_init_status
 147 {
 148   VAR_INIT_STATUS_UNKNOWN,
 149   VAR_INIT_STATUS_UNINITIALIZED,
 150   VAR_INIT_STATUS_INITIALIZED
 151 };
 152
 153
 154 struct edge_def;
 155 typedef struct edge_def *edge;
 156 typedef const struct edge_def *const_edge;
 157 struct basic_block_def;
 158 typedef struct basic_block_def *basic_block;
 159 typedef const struct basic_block_def *const_basic_block;
 160
 161 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 162 #define obstack_chunk_free      ((void (*) (void *)) free)
 163 #define OBSTACK_CHUNK_SIZE      0
 164 #define gcc_obstack_init(OBSTACK)                       \
 165   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 166                   obstack_chunk_alloc,                  \
 167                   obstack_chunk_free)
 168
 169 /* enum reg_class is target specific, so it should not appear in
 170    target-independent code or interfaces, like the target hook declarations
 171    in target.h.  */
 172 typedef int reg_class_t;
 173
 174 class rtl_opt_pass;
 175
 176 namespace gcc {
 177   class context;
 178 }
 179
 180 #else
 181
 182 struct _dont_use_rtx_here_;
 183 struct _dont_use_rtvec_here_;
 184 union _dont_use_tree_here_;
 185 #define rtx struct _dont_use_rtx_here_ *
 186 #define const_rtx struct _dont_use_rtx_here_ *
 187 #define rtvec struct _dont_use_rtvec_here *
 188 #define const_rtvec struct _dont_use_rtvec_here *
 189 #define tree union _dont_use_tree_here_ *
 190 #define const_tree union _dont_use_tree_here_ *
 191
 192 #endif
 193
 194 /* Classes of functions that compiler needs to check
 195    whether they are present at the runtime or not.  */
 196 enum function_class {
 197   function_c94,
 198   function_c99_misc,
 199   function_c99_math_complex,
 200   function_sincos,
 201   function_c11_misc
 202 };
 203
 204 /* Memory model types for the __atomic* builtins.
 205    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 206 enum memmodel
 207 {
 208   MEMMODEL_RELAXED = 0,
 209   MEMMODEL_CONSUME = 1,
 210   MEMMODEL_ACQUIRE = 2,
 211   MEMMODEL_RELEASE = 3,
 212   MEMMODEL_ACQ_REL = 4,
 213   MEMMODEL_SEQ_CST = 5,
 214   MEMMODEL_LAST = 6
 215 };
 216
 217 /* Suppose that higher bits are target dependent. */
 218 #define MEMMODEL_MASK ((1<<16)-1)
 219
 220 /* Support for user-provided GGC and PCH markers.  The first parameter
 221    is a pointer to a pointer, the second a cookie.  */
 222 typedef void (*gt_pointer_operator) (void *, void *);
 223
 224 #if !defined (HAVE_UCHAR)
 225 typedef unsigned char uchar;
 226 #endif
 227
 228 #endif /* coretypes.h */