]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/coretypes.h
[Ada] Remove Determine_License
[thirdparty/gcc.git] / gcc / coretypes.h
CommitLineData
4977bab6 1/* GCC core type declarations.
8d9254fc 2 Copyright (C) 2002-2020 Free Software Foundation, Inc.
4977bab6
ZW
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
9dcd6f09 8Software Foundation; either version 3, or (at your option) any later
4977bab6
ZW
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
748086b7
JJ
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
9dcd6f09 23<http://www.gnu.org/licenses/>. */
4977bab6
ZW
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
d1b38208 40#ifndef GTY
4977bab6 41#define GTY(x) /* nothing - marker for gengtype */
d1b38208 42#endif
4977bab6
ZW
43
44#ifndef USED_FOR_TARGET
45
a9243bfc
RB
46typedef int64_t gcov_type;
47typedef uint64_t gcov_type_unsigned;
4484a35a 48
54994253 49struct bitmap_obstack;
99b1c316
MS
50class bitmap_head;
51typedef class bitmap_head *bitmap;
52typedef const class bitmap_head *const_bitmap;
7a8cba34
SB
53struct simple_bitmap_def;
54typedef struct simple_bitmap_def *sbitmap;
55typedef const struct simple_bitmap_def *const_sbitmap;
4977bab6
ZW
56struct rtx_def;
57typedef struct rtx_def *rtx;
a57193e8 58typedef const struct rtx_def *const_rtx;
d21cefc2 59class scalar_mode;
501623d4 60class scalar_int_mode;
e386a52f 61class scalar_float_mode;
a97390bf 62class complex_mode;
b660eccf 63class fixed_size_mode;
490d0f6c 64template<typename> class opt_mode;
16d22000 65typedef opt_mode<scalar_mode> opt_scalar_mode;
501623d4 66typedef opt_mode<scalar_int_mode> opt_scalar_int_mode;
857c7b46 67typedef opt_mode<scalar_float_mode> opt_scalar_float_mode;
99b1c316 68template<typename> struct pod_mode;
382615c6 69typedef pod_mode<scalar_mode> scalar_mode_pod;
bf862c53 70typedef pod_mode<scalar_int_mode> scalar_int_mode_pod;
b660eccf 71typedef pod_mode<fixed_size_mode> fixed_size_mode_pod;
15f8d3ab
DM
72
73/* Subclasses of rtx_def, using indentation to show the class
6f983e60 74 hierarchy, along with the relevant invariant.
15f8d3ab 75 Where possible, keep this list in the same order as in rtl.def. */
99b1c316
MS
76struct rtx_def;
77 struct rtx_expr_list; /* GET_CODE (X) == EXPR_LIST */
78 struct rtx_insn_list; /* GET_CODE (X) == INSN_LIST */
79 struct rtx_sequence; /* GET_CODE (X) == SEQUENCE */
80 struct rtx_insn;
81 struct rtx_debug_insn; /* DEBUG_INSN_P (X) */
82 struct rtx_nonjump_insn; /* NONJUMP_INSN_P (X) */
83 struct rtx_jump_insn; /* JUMP_P (X) */
84 struct rtx_call_insn; /* CALL_P (X) */
85 struct rtx_jump_table_data; /* JUMP_TABLE_DATA_P (X) */
86 struct rtx_barrier; /* BARRIER_P (X) */
87 struct rtx_code_label; /* LABEL_P (X) */
88 struct rtx_note; /* NOTE_P (X) */
15f8d3ab 89
4977bab6
ZW
90struct rtvec_def;
91typedef struct rtvec_def *rtvec;
a57193e8 92typedef const struct rtvec_def *const_rtvec;
807e902e
KZ
93struct hwivec_def;
94typedef struct hwivec_def *hwivec;
95typedef const struct hwivec_def *const_hwivec;
4977bab6
ZW
96union tree_node;
97typedef union tree_node *tree;
7eba871a 98typedef const union tree_node *const_tree;
355fe088
TS
99struct gimple;
100typedef gimple *gimple_seq;
84562394 101struct gimple_stmt_iterator;
538dd0b7
DM
102
103/* Forward decls for leaf gimple subclasses (for individual gimple codes).
104 Keep this in the same order as the corresponding codes in gimple.def. */
105
106struct gcond;
107struct gdebug;
108struct ggoto;
109struct glabel;
110struct gswitch;
111struct gassign;
112struct gasm;
113struct gcall;
114struct gtransaction;
115struct greturn;
116struct gbind;
117struct gcatch;
118struct geh_filter;
119struct geh_mnt;
120struct geh_else;
121struct gresx;
122struct geh_dispatch;
123struct gphi;
124struct gtry;
125struct gomp_atomic_load;
126struct gomp_atomic_store;
127struct gomp_continue;
128struct gomp_critical;
d9a6bd32 129struct gomp_ordered;
538dd0b7
DM
130struct gomp_for;
131struct gomp_parallel;
132struct gomp_task;
133struct gomp_sections;
134struct gomp_single;
135struct gomp_target;
136struct gomp_teams;
137
4df3629e
DM
138/* Subclasses of symtab_node, using indentation to show the class
139 hierarchy. */
140
99b1c316 141struct symtab_node;
4df3629e 142 struct cgraph_node;
99b1c316 143 struct varpool_node;
ff6686d2 144struct cgraph_edge;
4df3629e 145
d6b5193b
RS
146union section;
147typedef union section section;
46625112 148struct gcc_options;
ab442df7
MM
149struct cl_target_option;
150struct cl_optimization;
7a9bf9a4
JM
151struct cl_option;
152struct cl_decoded_option;
5f20c657 153struct cl_option_handlers;
1ebe4b4f 154struct diagnostic_context;
99b1c316 155class pretty_printer;
4bc1899b 156class diagnostic_event_id_t;
4977bab6 157
148909bc
RS
158template<typename T> struct array_traits;
159
160/* Provides a read-only bitmap view of a single integer bitmask or an
161 array of integer bitmasks, or of a wrapper around such bitmasks. */
162template<typename T, typename Traits = array_traits<T>,
163 bool has_constant_size = Traits::has_constant_size>
164class bitmap_view;
165
09e881c9
BE
166/* Address space number for named address space support. */
167typedef unsigned char addr_space_t;
168
169/* The value of addr_space_t that represents the generic address space. */
170#define ADDR_SPACE_GENERIC 0
171#define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
172
52bca999
SB
173/* The major intermediate representations of GCC. */
174enum ir_type {
175 IR_GIMPLE,
176 IR_RTL_CFGRTL,
177 IR_RTL_CFGLAYOUT
178};
179
e150159c
SS
180/* Provide forward struct declaration so that we don't have to include
181 all of cpplib.h whenever a random prototype includes a pointer.
5950c3c9
BE
182 Note that the cpp_reader and cpp_token typedefs remain part of
183 cpplib.h. */
e150159c
SS
184
185struct cpp_reader;
5950c3c9 186struct cpp_token;
e150159c 187
61b60ed0
ZW
188/* The thread-local storage model associated with a given VAR_DECL
189 or SYMBOL_REF. This isn't used much, but both trees and RTL refer
190 to it, so it's here. */
191enum tls_model {
c2f7fa15 192 TLS_MODEL_NONE,
feb60f03
NS
193 TLS_MODEL_EMULATED,
194 TLS_MODEL_REAL,
195 TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
61b60ed0
ZW
196 TLS_MODEL_LOCAL_DYNAMIC,
197 TLS_MODEL_INITIAL_EXEC,
198 TLS_MODEL_LOCAL_EXEC
199};
200
c713ddc0
BS
201/* Types of ABI for an offload compiler. */
202enum offload_abi {
203 OFFLOAD_ABI_UNSET,
204 OFFLOAD_ABI_LP64,
205 OFFLOAD_ABI_ILP32
206};
207
22063dbc
ML
208/* Types of profile update methods. */
209enum profile_update {
210 PROFILE_UPDATE_SINGLE,
4d209853
ML
211 PROFILE_UPDATE_ATOMIC,
212 PROFILE_UPDATE_PREFER_ATOMIC
22063dbc
ML
213};
214
ea0b1252
ML
215/* Type of profile reproducibility methods. */
216enum profile_reproducibility {
217 PROFILE_REPRODUCIBILITY_SERIAL,
218 PROFILE_REPRODUCIBILITY_PARALLEL_RUNS,
219 PROFILE_REPRODUCIBILITY_MULTITHREADED
220};
221
6ba74c2d
RH
222/* Types of unwind/exception handling info that can be generated. */
223
224enum unwind_info_type
225{
226 UI_NONE,
227 UI_SJLJ,
228 UI_DWARF2,
bf1431e3
TG
229 UI_TARGET,
230 UI_SEH
6ba74c2d
RH
231};
232
f16d3f39
JH
233/* Callgraph node profile representation. */
234enum node_frequency {
235 /* This function most likely won't be executed at all.
236 (set only when profile feedback is available or via function attribute). */
237 NODE_FREQUENCY_UNLIKELY_EXECUTED,
238 /* For functions that are known to be executed once (i.e. constructors, destructors
239 and main function. */
240 NODE_FREQUENCY_EXECUTED_ONCE,
241 /* The default value. */
242 NODE_FREQUENCY_NORMAL,
243 /* Optimize this function hard
244 (set only when profile feedback is available or via function attribute). */
245 NODE_FREQUENCY_HOT
246};
247
d95ab70a
RS
248/* Ways of optimizing code. */
249enum optimization_type {
250 /* Prioritize speed over size. */
251 OPTIMIZE_FOR_SPEED,
252
253 /* Only do things that are good for both size and speed. */
254 OPTIMIZE_FOR_BOTH,
255
256 /* Prioritize size over speed. */
257 OPTIMIZE_FOR_SIZE
258};
259
76b0cbf8
RS
260/* Enumerates a padding direction. */
261enum pad_direction {
262 /* No padding is required. */
263 PAD_NONE,
264
265 /* Insert padding above the data, i.e. at higher memeory addresses
266 when dealing with memory, and at the most significant end when
267 dealing with registers. */
268 PAD_UPWARD,
269
270 /* Insert padding below the data, i.e. at lower memeory addresses
271 when dealing with memory, and at the least significant end when
272 dealing with registers. */
273 PAD_DOWNWARD
274};
275
647a1567
RH
276/* Possible initialization status of a variable. When requested
277 by the user, this information is tracked and recorded in the DWARF
278 debug information, along with the variable's location. */
279enum var_init_status
280{
281 VAR_INIT_STATUS_UNKNOWN,
282 VAR_INIT_STATUS_UNINITIALIZED,
283 VAR_INIT_STATUS_INITIALIZED
284};
285
a8b85ce9
MG
286/* Names for the different levels of -Wstrict-overflow=N. The numeric
287 values here correspond to N. */
288enum warn_strict_overflow_code
289{
290 /* Overflow warning that should be issued with -Wall: a questionable
291 construct that is easy to avoid even when using macros. Example:
292 folding (x + CONSTANT > x) to 1. */
293 WARN_STRICT_OVERFLOW_ALL = 1,
294 /* Overflow warning about folding a comparison to a constant because
295 of undefined signed overflow, other than cases covered by
296 WARN_STRICT_OVERFLOW_ALL. Example: folding (abs (x) >= 0) to 1
297 (this is false when x == INT_MIN). */
298 WARN_STRICT_OVERFLOW_CONDITIONAL = 2,
299 /* Overflow warning about changes to comparisons other than folding
300 them to a constant. Example: folding (x + 1 > 1) to (x > 0). */
301 WARN_STRICT_OVERFLOW_COMPARISON = 3,
302 /* Overflow warnings not covered by the above cases. Example:
303 folding ((x * 10) / 5) to (x * 2). */
304 WARN_STRICT_OVERFLOW_MISC = 4,
305 /* Overflow warnings about reducing magnitude of constants in
306 comparison. Example: folding (x + 2 > y) to (x + 1 >= y). */
307 WARN_STRICT_OVERFLOW_MAGNITUDE = 5
308};
309
eee33510
AM
310/* The type of an alias set. Code currently assumes that variables of
311 this type can take the values 0 (the alias set which aliases
312 everything) and -1 (sometimes indicating that the alias set is
313 unknown, sometimes indicating a memory barrier) and -2 (indicating
314 that the alias set should be set to a unique value but has not been
315 set yet). */
316typedef int alias_set_type;
f16d3f39 317
99b1c316
MS
318class edge_def;
319typedef class edge_def *edge;
320typedef const class edge_def *const_edge;
a3710436
JH
321struct basic_block_def;
322typedef struct basic_block_def *basic_block;
323typedef const struct basic_block_def *const_basic_block;
10692477 324
fcb87c50
MM
325#if !defined (GENERATOR_FILE)
326# define OBSTACK_CHUNK_SIZE memory_block_pool::block_size
327# define obstack_chunk_alloc mempool_obstack_chunk_alloc
328# define obstack_chunk_free mempool_obstack_chunk_free
329#else
330# define OBSTACK_CHUNK_SIZE 0
331# define obstack_chunk_alloc xmalloc
332# define obstack_chunk_free free
333#endif
334
19a9ba64
AM
335#define gcc_obstack_init(OBSTACK) \
336 obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
337 obstack_chunk_alloc, \
338 obstack_chunk_free)
10692477 339
a87cf97e
JR
340/* enum reg_class is target specific, so it should not appear in
341 target-independent code or interfaces, like the target hook declarations
342 in target.h. */
343typedef int reg_class_t;
344
05555c4a
DM
345class rtl_opt_pass;
346
347namespace gcc {
348 class context;
349}
350
ab23f5d9 351typedef std::pair <tree, tree> tree_pair;
ac2cfa6c 352typedef std::pair <const char *, int> string_int_pair;
ab23f5d9 353
4a4412b9
DM
354/* Define a name->value mapping. */
355template <typename ValueType>
356struct kv_pair
357{
358 const char *const name; /* the name of the value */
359 const ValueType value; /* the value of the name */
360};
361
4977bab6
ZW
362#else
363
364struct _dont_use_rtx_here_;
365struct _dont_use_rtvec_here_;
f3955ea3 366struct _dont_use_rtx_insn_here_;
4977bab6
ZW
367union _dont_use_tree_here_;
368#define rtx struct _dont_use_rtx_here_ *
a57193e8 369#define const_rtx struct _dont_use_rtx_here_ *
4977bab6 370#define rtvec struct _dont_use_rtvec_here *
a57193e8 371#define const_rtvec struct _dont_use_rtvec_here *
f3955ea3 372#define rtx_insn struct _dont_use_rtx_insn_here_
4977bab6 373#define tree union _dont_use_tree_here_ *
a57193e8 374#define const_tree union _dont_use_tree_here_ *
4977bab6 375
d21cefc2 376typedef struct scalar_mode scalar_mode;
501623d4 377typedef struct scalar_int_mode scalar_int_mode;
e386a52f 378typedef struct scalar_float_mode scalar_float_mode;
a97390bf 379typedef struct complex_mode complex_mode;
e386a52f 380
4977bab6
ZW
381#endif
382
d33d9e47
AI
383/* Classes of functions that compiler needs to check
384 whether they are present at the runtime or not. */
385enum function_class {
386 function_c94,
387 function_c99_misc,
388 function_c99_math_complex,
22869a37 389 function_sincos,
0fa00483
JM
390 function_c11_misc,
391 function_c2x_misc
d33d9e47
AI
392};
393
2eff1470
AM
394/* Enumerate visibility settings. This is deliberately ordered from most
395 to least visibility. */
396enum symbol_visibility
397{
398 VISIBILITY_DEFAULT,
399 VISIBILITY_PROTECTED,
400 VISIBILITY_HIDDEN,
401 VISIBILITY_INTERNAL
402};
403
42e02b20
JG
404/* enums used by the targetm.excess_precision hook. */
405
406enum flt_eval_method
407{
408 FLT_EVAL_METHOD_UNPREDICTABLE = -1,
409 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT = 0,
410 FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE = 1,
411 FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE = 2,
412 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16 = 16
413};
414
415enum excess_precision_type
416{
417 EXCESS_PRECISION_TYPE_IMPLICIT,
418 EXCESS_PRECISION_TYPE_STANDARD,
419 EXCESS_PRECISION_TYPE_FAST
420};
421
0823efed
DN
422/* Support for user-provided GGC and PCH markers. The first parameter
423 is a pointer to a pointer, the second a cookie. */
424typedef void (*gt_pointer_operator) (void *, void *);
425
9771b263
DN
426#if !defined (HAVE_UCHAR)
427typedef unsigned char uchar;
428#endif
4977bab6 429
b0e84cf7
RS
430/* Most source files will require the following headers. */
431#if !defined (USED_FOR_TARGET)
432#include "insn-modes.h"
ecb9f223
AM
433#include "signop.h"
434#include "wide-int.h"
b0e84cf7 435#include "wide-int-print.h"
e535b963
RS
436
437/* On targets that don't need polynomial offsets, target-specific code
438 should be able to treat poly_int like a normal constant, with a
439 conversion operator going from the former to the latter. We also
440 allow this for gencondmd.c for all targets, so that we can treat
441 machine_modes as enums without causing build failures. */
442#if (defined (IN_TARGET_CODE) \
443 && (defined (USE_ENUM_MODES) || NUM_POLY_INT_COEFFS == 1))
444#define POLY_INT_CONVERSION 1
445#else
446#define POLY_INT_CONVERSION 0
447#endif
448
449#include "poly-int.h"
450#include "poly-int-types.h"
b0e84cf7
RS
451#include "insn-modes-inline.h"
452#include "machmode.h"
ecb9f223 453#include "double-int.h"
e6de5335 454#include "align.h"
b0e84cf7
RS
455/* Most host source files will require the following headers. */
456#if !defined (GENERATOR_FILE)
ecb9f223
AM
457#include "real.h"
458#include "fixed-value.h"
13fdf2e2
AM
459#include "hash-table.h"
460#include "hash-set.h"
abb226c9
AM
461#include "input.h"
462#include "is-a.h"
fcb87c50 463#include "memory-block.h"
1a817418 464#include "dumpfile.h"
b0e84cf7 465#endif
13fdf2e2 466#endif /* GENERATOR_FILE && !USED_FOR_TARGET */
ecb9f223 467
9771b263 468#endif /* coretypes.h */