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