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