gcc/
[official-gcc.git] / gcc / coretypes.h
blobe3cec01f4d8a246fc8b087b423241a07618350d1
1 /* GCC core type declarations.
2 Copyright (C) 2002-2015 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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.
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/>. */
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.
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. */
37 #ifndef GCC_CORETYPES_H
38 #define GCC_CORETYPES_H
40 #ifndef GTY
41 #define GTY(x) /* nothing - marker for gengtype */
42 #endif
44 #ifndef USED_FOR_TARGET
46 typedef int64_t gcov_type;
47 typedef uint64_t gcov_type_unsigned;
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;
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) */
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;
90 /* Forward decls for leaf gimple subclasses (for individual gimple codes).
91 Keep this in the same order as the corresponding codes in gimple.def. */
93 struct gcond;
94 struct gdebug;
95 struct ggoto;
96 struct glabel;
97 struct gswitch;
98 struct gassign;
99 struct gasm;
100 struct gcall;
101 struct gtransaction;
102 struct greturn;
103 struct gbind;
104 struct gcatch;
105 struct geh_filter;
106 struct geh_mnt;
107 struct geh_else;
108 struct gresx;
109 struct geh_dispatch;
110 struct gphi;
111 struct gtry;
112 struct gomp_atomic_load;
113 struct gomp_atomic_store;
114 struct gomp_continue;
115 struct gomp_critical;
116 struct gomp_for;
117 struct gomp_parallel;
118 struct gomp_task;
119 struct gomp_sections;
120 struct gomp_single;
121 struct gomp_target;
122 struct gomp_teams;
124 union section;
125 typedef union section section;
126 struct gcc_options;
127 struct cl_target_option;
128 struct cl_optimization;
129 struct cl_option;
130 struct cl_decoded_option;
131 struct cl_option_handlers;
132 struct diagnostic_context;
133 struct pretty_printer;
135 /* Address space number for named address space support. */
136 typedef unsigned char addr_space_t;
138 /* The value of addr_space_t that represents the generic address space. */
139 #define ADDR_SPACE_GENERIC 0
140 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
142 /* The major intermediate representations of GCC. */
143 enum ir_type {
144 IR_GIMPLE,
145 IR_RTL_CFGRTL,
146 IR_RTL_CFGLAYOUT
149 /* Provide forward struct declaration so that we don't have to include
150 all of cpplib.h whenever a random prototype includes a pointer.
151 Note that the cpp_reader and cpp_token typedefs remain part of
152 cpplib.h. */
154 struct cpp_reader;
155 struct cpp_token;
157 /* The thread-local storage model associated with a given VAR_DECL
158 or SYMBOL_REF. This isn't used much, but both trees and RTL refer
159 to it, so it's here. */
160 enum tls_model {
161 TLS_MODEL_NONE,
162 TLS_MODEL_EMULATED,
163 TLS_MODEL_REAL,
164 TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
165 TLS_MODEL_LOCAL_DYNAMIC,
166 TLS_MODEL_INITIAL_EXEC,
167 TLS_MODEL_LOCAL_EXEC
170 /* Types of ABI for an offload compiler. */
171 enum offload_abi {
172 OFFLOAD_ABI_UNSET,
173 OFFLOAD_ABI_LP64,
174 OFFLOAD_ABI_ILP32
177 /* Types of unwind/exception handling info that can be generated. */
179 enum unwind_info_type
181 UI_NONE,
182 UI_SJLJ,
183 UI_DWARF2,
184 UI_TARGET,
185 UI_SEH
188 /* Callgraph node profile representation. */
189 enum node_frequency {
190 /* This function most likely won't be executed at all.
191 (set only when profile feedback is available or via function attribute). */
192 NODE_FREQUENCY_UNLIKELY_EXECUTED,
193 /* For functions that are known to be executed once (i.e. constructors, destructors
194 and main function. */
195 NODE_FREQUENCY_EXECUTED_ONCE,
196 /* The default value. */
197 NODE_FREQUENCY_NORMAL,
198 /* Optimize this function hard
199 (set only when profile feedback is available or via function attribute). */
200 NODE_FREQUENCY_HOT
203 /* Possible initialization status of a variable. When requested
204 by the user, this information is tracked and recorded in the DWARF
205 debug information, along with the variable's location. */
206 enum var_init_status
208 VAR_INIT_STATUS_UNKNOWN,
209 VAR_INIT_STATUS_UNINITIALIZED,
210 VAR_INIT_STATUS_INITIALIZED
213 /* The type of an alias set. Code currently assumes that variables of
214 this type can take the values 0 (the alias set which aliases
215 everything) and -1 (sometimes indicating that the alias set is
216 unknown, sometimes indicating a memory barrier) and -2 (indicating
217 that the alias set should be set to a unique value but has not been
218 set yet). */
219 typedef int alias_set_type;
221 struct edge_def;
222 typedef struct edge_def *edge;
223 typedef const struct edge_def *const_edge;
224 struct basic_block_def;
225 typedef struct basic_block_def *basic_block;
226 typedef const struct basic_block_def *const_basic_block;
228 #define obstack_chunk_alloc xmalloc
229 #define obstack_chunk_free free
230 #define OBSTACK_CHUNK_SIZE 0
231 #define gcc_obstack_init(OBSTACK) \
232 obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
233 obstack_chunk_alloc, \
234 obstack_chunk_free)
236 /* enum reg_class is target specific, so it should not appear in
237 target-independent code or interfaces, like the target hook declarations
238 in target.h. */
239 typedef int reg_class_t;
241 class rtl_opt_pass;
243 namespace gcc {
244 class context;
247 #else
249 struct _dont_use_rtx_here_;
250 struct _dont_use_rtvec_here_;
251 struct _dont_use_rtx_insn_here_;
252 union _dont_use_tree_here_;
253 #define rtx struct _dont_use_rtx_here_ *
254 #define const_rtx struct _dont_use_rtx_here_ *
255 #define rtvec struct _dont_use_rtvec_here *
256 #define const_rtvec struct _dont_use_rtvec_here *
257 #define rtx_insn struct _dont_use_rtx_insn_here_
258 #define tree union _dont_use_tree_here_ *
259 #define const_tree union _dont_use_tree_here_ *
261 #endif
263 /* Classes of functions that compiler needs to check
264 whether they are present at the runtime or not. */
265 enum function_class {
266 function_c94,
267 function_c99_misc,
268 function_c99_math_complex,
269 function_sincos,
270 function_c11_misc
273 /* Suppose that higher bits are target dependent. */
274 #define MEMMODEL_MASK ((1<<16)-1)
276 /* Legacy sync operations set this upper flag in the memory model. This allows
277 targets that need to do something stronger for sync operations to
278 differentiate with their target patterns and issue a more appropriate insn
279 sequence. See bugzilla 65697 for background. */
280 #define MEMMODEL_SYNC (1<<15)
282 /* Memory model without SYNC bit for targets/operations that do not care. */
283 #define MEMMODEL_BASE_MASK (MEMMODEL_SYNC-1)
285 /* Memory model types for the __atomic* builtins.
286 This must match the order in libstdc++-v3/include/bits/atomic_base.h. */
287 enum memmodel
289 MEMMODEL_RELAXED = 0,
290 MEMMODEL_CONSUME = 1,
291 MEMMODEL_ACQUIRE = 2,
292 MEMMODEL_RELEASE = 3,
293 MEMMODEL_ACQ_REL = 4,
294 MEMMODEL_SEQ_CST = 5,
295 MEMMODEL_LAST = 6,
296 MEMMODEL_SYNC_ACQUIRE = MEMMODEL_ACQUIRE | MEMMODEL_SYNC,
297 MEMMODEL_SYNC_RELEASE = MEMMODEL_RELEASE | MEMMODEL_SYNC,
298 MEMMODEL_SYNC_SEQ_CST = MEMMODEL_SEQ_CST | MEMMODEL_SYNC
301 /* Support for user-provided GGC and PCH markers. The first parameter
302 is a pointer to a pointer, the second a cookie. */
303 typedef void (*gt_pointer_operator) (void *, void *);
305 #if !defined (HAVE_UCHAR)
306 typedef unsigned char uchar;
307 #endif
309 /* Most host source files will require the following headers. */
310 #if !defined (GENERATOR_FILE) && !defined (USED_FOR_TARGET)
311 #include "machmode.h"
312 #include "signop.h"
313 #include "wide-int.h"
314 #include "double-int.h"
315 #include "real.h"
316 #include "fixed-value.h"
317 #include "hash-table.h"
318 #include "hash-set.h"
319 #include "input.h"
320 #include "is-a.h"
321 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
323 #endif /* coretypes.h */