gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002, 2004, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 Under Section 7 of GPL version 3, you are granted additional
  18 permissions described in the GCC Runtime Library Exception, version
  19 3.1, as published by the Free Software Foundation.
  20
  21 You should have received a copy of the GNU General Public License and
  22 a copy of the GCC Runtime Library Exception along with this program;
  23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 <http://www.gnu.org/licenses/>.  */
  25
  26 /* Provide forward declarations of core types which are referred to by
  27    most of the compiler.  This allows header files to use these types
  28    (e.g. in function prototypes) without concern for whether the full
  29    definitions are visible.  Some other declarations that need to be
  30    universally visible are here, too.
  31
  32    In the context of tconfig.h, most of these have special definitions
  33    which prevent them from being used except in further type
  34    declarations.  This is a kludge; the right thing is to avoid
  35    including the "tm.h" header set in the context of tconfig.h, but
  36    we're not there yet.  */
  37
  38 #ifndef GCC_CORETYPES_H
  39 #define GCC_CORETYPES_H
  40
  41 #ifndef GTY
  42 #define GTY(x)  /* nothing - marker for gengtype */
  43 #endif
  44
  45 #ifndef USED_FOR_TARGET
  46
  47 struct bitmap_head_def;
  48 typedef struct bitmap_head_def *bitmap;
  49 typedef const struct bitmap_head_def *const_bitmap;
  50 struct simple_bitmap_def;
  51 typedef struct simple_bitmap_def *sbitmap;
  52 typedef const struct simple_bitmap_def *const_sbitmap;
  53 struct rtx_def;
  54 typedef struct rtx_def *rtx;
  55 typedef const struct rtx_def *const_rtx;
  56 struct rtvec_def;
  57 typedef struct rtvec_def *rtvec;
  58 typedef const struct rtvec_def *const_rtvec;
  59 union tree_node;
  60 typedef union tree_node *tree;
  61 union gimple_statement_d;
  62 typedef union gimple_statement_d *gimple;
  63 typedef const union tree_node *const_tree;
  64 typedef const union gimple_statement_d *const_gimple;
  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 typedef gimple gimple_seq;
  76
  77 /* Address space number for named address space support.  */
  78 typedef unsigned char addr_space_t;
  79
  80 /* The value of addr_space_t that represents the generic address space.  */
  81 #define ADDR_SPACE_GENERIC 0
  82 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
  83
  84 /* The major intermediate representations of GCC.  */
  85 enum ir_type {
  86   IR_GIMPLE,
  87   IR_RTL_CFGRTL,
  88   IR_RTL_CFGLAYOUT
  89 };
  90
  91 /* Provide forward struct declaration so that we don't have to include
  92    all of cpplib.h whenever a random prototype includes a pointer.
  93    Note that the cpp_reader and cpp_token typedefs remain part of
  94    cpplib.h.  */
  95
  96 struct cpp_reader;
  97 struct cpp_token;
  98
  99 /* The thread-local storage model associated with a given VAR_DECL
 100    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 101    to it, so it's here.  */
 102 enum tls_model {
 103   TLS_MODEL_NONE,
 104   TLS_MODEL_EMULATED,
 105   TLS_MODEL_REAL,
 106   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 107   TLS_MODEL_LOCAL_DYNAMIC,
 108   TLS_MODEL_INITIAL_EXEC,
 109   TLS_MODEL_LOCAL_EXEC
 110 };
 111
 112 /* Types of unwind/exception handling info that can be generated.  */
 113
 114 enum unwind_info_type
 115 {
 116   UI_NONE,
 117   UI_SJLJ,
 118   UI_DWARF2,
 119   UI_TARGET,
 120   UI_SEH
 121 };
 122
 123 /* Callgraph node profile representation.  */
 124 enum node_frequency {
 125   /* This function most likely won't be executed at all.
 126      (set only when profile feedback is available or via function attribute). */
 127   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 128   /* For functions that are known to be executed once (i.e. constructors, destructors
 129      and main function.  */
 130   NODE_FREQUENCY_EXECUTED_ONCE,
 131   /* The default value.  */
 132   NODE_FREQUENCY_NORMAL,
 133   /* Optimize this function hard
 134      (set only when profile feedback is available or via function attribute). */
 135   NODE_FREQUENCY_HOT
 136 };
 137
 138 /* Possible initialization status of a variable.   When requested
 139    by the user, this information is tracked and recorded in the DWARF
 140    debug information, along with the variable's location.  */
 141 enum var_init_status
 142 {
 143   VAR_INIT_STATUS_UNKNOWN,
 144   VAR_INIT_STATUS_UNINITIALIZED,
 145   VAR_INIT_STATUS_INITIALIZED
 146 };
 147
 148
 149 struct edge_def;
 150 typedef struct edge_def *edge;
 151 typedef const struct edge_def *const_edge;
 152 struct basic_block_def;
 153 typedef struct basic_block_def *basic_block;
 154 typedef const struct basic_block_def *const_basic_block;
 155
 156 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 157 #define obstack_chunk_free      ((void (*) (void *)) free)
 158 #define OBSTACK_CHUNK_SIZE      0
 159 #define gcc_obstack_init(OBSTACK)                       \
 160   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 161                   obstack_chunk_alloc,                  \
 162                   obstack_chunk_free)
 163
 164 /* enum reg_class is target specific, so it should not appear in
 165    target-independent code or interfaces, like the target hook declarations
 166    in target.h.  */
 167 typedef int reg_class_t;
 168
 169 #else
 170
 171 struct _dont_use_rtx_here_;
 172 struct _dont_use_rtvec_here_;
 173 union _dont_use_tree_here_;
 174 #define rtx struct _dont_use_rtx_here_ *
 175 #define const_rtx struct _dont_use_rtx_here_ *
 176 #define rtvec struct _dont_use_rtvec_here *
 177 #define const_rtvec struct _dont_use_rtvec_here *
 178 #define tree union _dont_use_tree_here_ *
 179 #define const_tree union _dont_use_tree_here_ *
 180
 181 #endif
 182
 183 /* Memory model types for the __atomic* builtins.
 184    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 185 enum memmodel
 186 {
 187   MEMMODEL_RELAXED = 0,
 188   MEMMODEL_CONSUME = 1,
 189   MEMMODEL_ACQUIRE = 2,
 190   MEMMODEL_RELEASE = 3,
 191   MEMMODEL_ACQ_REL = 4,
 192   MEMMODEL_SEQ_CST = 5,
 193   MEMMODEL_LAST = 6
 194 };
 195
 196 /* Suppose that higher bits are target dependant. */
 197 #define MEMMODEL_MASK ((1<<16)-1)
 198
 199 /* Support for user-provided GGC and PCH markers.  The first parameter
 200    is a pointer to a pointer, the second a cookie.  */
 201 typedef void (*gt_pointer_operator) (void *, void *);
 202
 203 #endif /* coretypes.h */
 204