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