gcc/coretypes.h

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