1/* GCC core type declarations.
2 Copyright (C) 2002-2017 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16Under Section 7 of GPL version 3, you are granted additional
17permissions described in the GCC Runtime Library Exception, version
183.1, as published by the Free Software Foundation.
19
20You should have received a copy of the GNU General Public License and
21a copy of the GCC Runtime Library Exception along with this program;
22see 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
46typedef int64_t gcov_type;
47typedef uint64_t gcov_type_unsigned;
48
49struct bitmap_head;
50typedef struct bitmap_head *bitmap;
51typedef const struct bitmap_head *const_bitmap;
52struct simple_bitmap_def;
53typedef struct simple_bitmap_def *sbitmap;
54typedef const struct simple_bitmap_def *const_sbitmap;
55struct rtx_def;
56typedef struct rtx_def *rtx;
57typedef const struct rtx_def *const_rtx;
58class scalar_mode;
59class scalar_int_mode;
60class scalar_float_mode;
61class complex_mode;
62template<typename> class opt_mode;
63typedef opt_mode<scalar_mode> opt_scalar_mode;
64typedef opt_mode<scalar_int_mode> opt_scalar_int_mode;
65typedef opt_mode<scalar_float_mode> opt_scalar_float_mode;
66template<typename> class pod_mode;
67typedef pod_mode<scalar_mode> scalar_mode_pod;
68typedef pod_mode<scalar_int_mode> scalar_int_mode_pod;
69
70/* Subclasses of rtx_def, using indentation to show the class
71 hierarchy, along with the relevant invariant.
72 Where possible, keep this list in the same order as in rtl.def. */
73class rtx_def;
74 class rtx_expr_list; /* GET_CODE (X) == EXPR_LIST */
75 class rtx_insn_list; /* GET_CODE (X) == INSN_LIST */
76 class rtx_sequence; /* GET_CODE (X) == SEQUENCE */
77 class rtx_insn;
78 class rtx_debug_insn; /* DEBUG_INSN_P (X) */
79 class rtx_nonjump_insn; /* NONJUMP_INSN_P (X) */
80 class rtx_jump_insn; /* JUMP_P (X) */
81 class rtx_call_insn; /* CALL_P (X) */
82 class rtx_jump_table_data; /* JUMP_TABLE_DATA_P (X) */
83 class rtx_barrier; /* BARRIER_P (X) */
84 class rtx_code_label; /* LABEL_P (X) */
85 class rtx_note; /* NOTE_P (X) */
86
87struct rtvec_def;
88typedef struct rtvec_def *rtvec;
89typedef const struct rtvec_def *const_rtvec;
90struct hwivec_def;
91typedef struct hwivec_def *hwivec;
92typedef const struct hwivec_def *const_hwivec;
93union tree_node;
94typedef union tree_node *tree;
95typedef const union tree_node *const_tree;
96struct gimple;
97typedef gimple *gimple_seq;
98struct gimple_stmt_iterator;
99
100/* Forward decls for leaf gimple subclasses (for individual gimple codes).
101 Keep this in the same order as the corresponding codes in gimple.def. */
102
103struct gcond;
104struct gdebug;
105struct ggoto;
106struct glabel;
107struct gswitch;
108struct gassign;
109struct gasm;
110struct gcall;
111struct gtransaction;
112struct greturn;
113struct gbind;
114struct gcatch;
115struct geh_filter;
116struct geh_mnt;
117struct geh_else;
118struct gresx;
119struct geh_dispatch;
120struct gphi;
121struct gtry;
122struct gomp_atomic_load;
123struct gomp_atomic_store;
124struct gomp_continue;
125struct gomp_critical;
126struct gomp_ordered;
127struct gomp_for;
128struct gomp_parallel;
129struct gomp_task;
130struct gomp_sections;
131struct gomp_single;
132struct gomp_target;
133struct gomp_teams;
134
135union section;
136typedef union section section;
137struct gcc_options;
138struct cl_target_option;
139struct cl_optimization;
140struct cl_option;
141struct cl_decoded_option;
142struct cl_option_handlers;
143struct diagnostic_context;
144struct pretty_printer;
145
146/* Address space number for named address space support. */
147typedef unsigned char addr_space_t;
148
149/* The value of addr_space_t that represents the generic address space. */
150#define ADDR_SPACE_GENERIC 0
151#define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
152
153/* The major intermediate representations of GCC. */
154enum ir_type {
155 IR_GIMPLE,
156 IR_RTL_CFGRTL,
157 IR_RTL_CFGLAYOUT
158};
159
160/* Provide forward struct declaration so that we don't have to include
161 all of cpplib.h whenever a random prototype includes a pointer.
162 Note that the cpp_reader and cpp_token typedefs remain part of
163 cpplib.h. */
164
165struct cpp_reader;
166struct cpp_token;
167
168/* The thread-local storage model associated with a given VAR_DECL
169 or SYMBOL_REF. This isn't used much, but both trees and RTL refer
170 to it, so it's here. */
171enum tls_model {
172 TLS_MODEL_NONE,
173 TLS_MODEL_EMULATED,
174 TLS_MODEL_REAL,
175 TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
176 TLS_MODEL_LOCAL_DYNAMIC,
177 TLS_MODEL_INITIAL_EXEC,
178 TLS_MODEL_LOCAL_EXEC
179};
180
181/* Types of ABI for an offload compiler. */
182enum offload_abi {
183 OFFLOAD_ABI_UNSET,
184 OFFLOAD_ABI_LP64,
185 OFFLOAD_ABI_ILP32
186};
187
188/* Types of profile update methods. */
189enum profile_update {
190 PROFILE_UPDATE_SINGLE,
191 PROFILE_UPDATE_ATOMIC,
192 PROFILE_UPDATE_PREFER_ATOMIC
193};
194
195/* Types of unwind/exception handling info that can be generated. */
196
197enum unwind_info_type
198{
199 UI_NONE,
200 UI_SJLJ,
201 UI_DWARF2,
202 UI_TARGET,
203 UI_SEH
204};
205
206/* Callgraph node profile representation. */
207enum node_frequency {
208 /* This function most likely won't be executed at all.
209 (set only when profile feedback is available or via function attribute). */
210 NODE_FREQUENCY_UNLIKELY_EXECUTED,
211 /* For functions that are known to be executed once (i.e. constructors, destructors
212 and main function. */
213 NODE_FREQUENCY_EXECUTED_ONCE,
214 /* The default value. */
215 NODE_FREQUENCY_NORMAL,
216 /* Optimize this function hard
217 (set only when profile feedback is available or via function attribute). */
218 NODE_FREQUENCY_HOT
219};
220
221/* Ways of optimizing code. */
222enum optimization_type {
223 /* Prioritize speed over size. */
224 OPTIMIZE_FOR_SPEED,
225
226 /* Only do things that are good for both size and speed. */
227 OPTIMIZE_FOR_BOTH,
228
229 /* Prioritize size over speed. */
230 OPTIMIZE_FOR_SIZE
231};
232
233/* Enumerates a padding direction. */
234enum pad_direction {
235 /* No padding is required. */
236 PAD_NONE,
237
238 /* Insert padding above the data, i.e. at higher memeory addresses
239 when dealing with memory, and at the most significant end when
240 dealing with registers. */
241 PAD_UPWARD,
242
243 /* Insert padding below the data, i.e. at lower memeory addresses
244 when dealing with memory, and at the least significant end when
245 dealing with registers. */
246 PAD_DOWNWARD
247};
248
249/* Possible initialization status of a variable. When requested
250 by the user, this information is tracked and recorded in the DWARF
251 debug information, along with the variable's location. */
252enum var_init_status
253{
254 VAR_INIT_STATUS_UNKNOWN,
255 VAR_INIT_STATUS_UNINITIALIZED,
256 VAR_INIT_STATUS_INITIALIZED
257};
258
259/* Names for the different levels of -Wstrict-overflow=N. The numeric
260 values here correspond to N. */
261enum warn_strict_overflow_code
262{
263 /* Overflow warning that should be issued with -Wall: a questionable
264 construct that is easy to avoid even when using macros. Example:
265 folding (x + CONSTANT > x) to 1. */
266 WARN_STRICT_OVERFLOW_ALL = 1,
267 /* Overflow warning about folding a comparison to a constant because
268 of undefined signed overflow, other than cases covered by
269 WARN_STRICT_OVERFLOW_ALL. Example: folding (abs (x) >= 0) to 1
270 (this is false when x == INT_MIN). */
271 WARN_STRICT_OVERFLOW_CONDITIONAL = 2,
272 /* Overflow warning about changes to comparisons other than folding
273 them to a constant. Example: folding (x + 1 > 1) to (x > 0). */
274 WARN_STRICT_OVERFLOW_COMPARISON = 3,
275 /* Overflow warnings not covered by the above cases. Example:
276 folding ((x * 10) / 5) to (x * 2). */
277 WARN_STRICT_OVERFLOW_MISC = 4,
278 /* Overflow warnings about reducing magnitude of constants in
279 comparison. Example: folding (x + 2 > y) to (x + 1 >= y). */
280 WARN_STRICT_OVERFLOW_MAGNITUDE = 5
281};
282
283/* The type of an alias set. Code currently assumes that variables of
284 this type can take the values 0 (the alias set which aliases
285 everything) and -1 (sometimes indicating that the alias set is
286 unknown, sometimes indicating a memory barrier) and -2 (indicating
287 that the alias set should be set to a unique value but has not been
288 set yet). */
289typedef int alias_set_type;
290
291struct edge_def;
292typedef struct edge_def *edge;
293typedef const struct edge_def *const_edge;
294struct basic_block_def;
295typedef struct basic_block_def *basic_block;
296typedef const struct basic_block_def *const_basic_block;
297
298#if !defined (GENERATOR_FILE)
299# define OBSTACK_CHUNK_SIZE memory_block_pool::block_size
300# define obstack_chunk_alloc mempool_obstack_chunk_alloc
301# define obstack_chunk_free mempool_obstack_chunk_free
302#else
303# define OBSTACK_CHUNK_SIZE 0
304# define obstack_chunk_alloc xmalloc
305# define obstack_chunk_free free
306#endif
307
308#define gcc_obstack_init(OBSTACK) \
309 obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
310 obstack_chunk_alloc, \
311 obstack_chunk_free)
312
313/* enum reg_class is target specific, so it should not appear in
314 target-independent code or interfaces, like the target hook declarations
315 in target.h. */
316typedef int reg_class_t;
317
318class rtl_opt_pass;
319
320namespace gcc {
321 class context;
322}
323
324typedef std::pair <tree, tree> tree_pair;
325
326#else
327
328struct _dont_use_rtx_here_;
329struct _dont_use_rtvec_here_;
330struct _dont_use_rtx_insn_here_;
331union _dont_use_tree_here_;
332#define rtx struct _dont_use_rtx_here_ *
333#define const_rtx struct _dont_use_rtx_here_ *
334#define rtvec struct _dont_use_rtvec_here *
335#define const_rtvec struct _dont_use_rtvec_here *
336#define rtx_insn struct _dont_use_rtx_insn_here_
337#define tree union _dont_use_tree_here_ *
338#define const_tree union _dont_use_tree_here_ *
339
340typedef struct scalar_mode scalar_mode;
341typedef struct scalar_int_mode scalar_int_mode;
342typedef struct scalar_float_mode scalar_float_mode;
343typedef struct complex_mode complex_mode;
344
345#endif
346
347/* Classes of functions that compiler needs to check
348 whether they are present at the runtime or not. */
349enum function_class {
350 function_c94,
351 function_c99_misc,
352 function_c99_math_complex,
353 function_sincos,
354 function_c11_misc
355};
356
357/* Enumerate visibility settings. This is deliberately ordered from most
358 to least visibility. */
359enum symbol_visibility
360{
361 VISIBILITY_DEFAULT,
362 VISIBILITY_PROTECTED,
363 VISIBILITY_HIDDEN,
364 VISIBILITY_INTERNAL
365};
366
367/* enums used by the targetm.excess_precision hook. */
368
369enum flt_eval_method
370{
371 FLT_EVAL_METHOD_UNPREDICTABLE = -1,
372 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT = 0,
373 FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE = 1,
374 FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE = 2,
375 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16 = 16
376};
377
378enum excess_precision_type
379{
380 EXCESS_PRECISION_TYPE_IMPLICIT,
381 EXCESS_PRECISION_TYPE_STANDARD,
382 EXCESS_PRECISION_TYPE_FAST
383};
384
385/* Support for user-provided GGC and PCH markers. The first parameter
386 is a pointer to a pointer, the second a cookie. */
387typedef void (*gt_pointer_operator) (void *, void *);
388
389#if !defined (HAVE_UCHAR)
390typedef unsigned char uchar;
391#endif
392
393/* Most source files will require the following headers. */
394#if !defined (USED_FOR_TARGET)
395#include "insn-modes.h"
396#include "signop.h"
397#include "wide-int.h"
398#include "wide-int-print.h"
399#include "insn-modes-inline.h"
400#include "machmode.h"
401#include "double-int.h"
402/* Most host source files will require the following headers. */
403#if !defined (GENERATOR_FILE)
404#include "real.h"
405#include "fixed-value.h"
406#include "hash-table.h"
407#include "hash-set.h"
408#include "input.h"
409#include "is-a.h"
410#include "memory-block.h"
411#include "dumpfile.h"
412#endif
413#endif /* GENERATOR_FILE && !USED_FOR_TARGET */
414
415#endif /* coretypes.h */
416