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