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