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