1 /* GCC core type declarations.
2 Copyright (C) 2002-2018 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
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
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
41 #define GTY(x) /* nothing - marker for gengtype */
44 #ifndef USED_FOR_TARGET
46 typedef int64_t gcov_type
;
47 typedef uint64_t gcov_type_unsigned
;
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
;
56 typedef struct rtx_def
*rtx
;
57 typedef const struct rtx_def
*const_rtx
;
59 class scalar_int_mode
;
60 class scalar_float_mode
;
62 class fixed_size_mode
;
63 template<typename
> class opt_mode
;
64 typedef opt_mode
<scalar_mode
> opt_scalar_mode
;
65 typedef opt_mode
<scalar_int_mode
> opt_scalar_int_mode
;
66 typedef opt_mode
<scalar_float_mode
> opt_scalar_float_mode
;
67 template<typename
> class pod_mode
;
68 typedef pod_mode
<scalar_mode
> scalar_mode_pod
;
69 typedef pod_mode
<scalar_int_mode
> scalar_int_mode_pod
;
70 typedef pod_mode
<fixed_size_mode
> fixed_size_mode_pod
;
72 /* Subclasses of rtx_def, using indentation to show the class
73 hierarchy, along with the relevant invariant.
74 Where possible, keep this list in the same order as in rtl.def. */
76 class rtx_expr_list
; /* GET_CODE (X) == EXPR_LIST */
77 class rtx_insn_list
; /* GET_CODE (X) == INSN_LIST */
78 class rtx_sequence
; /* GET_CODE (X) == SEQUENCE */
80 class rtx_debug_insn
; /* DEBUG_INSN_P (X) */
81 class rtx_nonjump_insn
; /* NONJUMP_INSN_P (X) */
82 class rtx_jump_insn
; /* JUMP_P (X) */
83 class rtx_call_insn
; /* CALL_P (X) */
84 class rtx_jump_table_data
; /* JUMP_TABLE_DATA_P (X) */
85 class rtx_barrier
; /* BARRIER_P (X) */
86 class rtx_code_label
; /* LABEL_P (X) */
87 class rtx_note
; /* NOTE_P (X) */
90 typedef struct rtvec_def
*rtvec
;
91 typedef const struct rtvec_def
*const_rtvec
;
93 typedef struct hwivec_def
*hwivec
;
94 typedef const struct hwivec_def
*const_hwivec
;
96 typedef union tree_node
*tree
;
97 typedef const union tree_node
*const_tree
;
99 typedef gimple
*gimple_seq
;
100 struct gimple_stmt_iterator
;
102 /* Forward decls for leaf gimple subclasses (for individual gimple codes).
103 Keep this in the same order as the corresponding codes in gimple.def. */
124 struct gomp_atomic_load
;
125 struct gomp_atomic_store
;
126 struct gomp_continue
;
127 struct gomp_critical
;
130 struct gomp_parallel
;
132 struct gomp_sections
;
137 /* Subclasses of symtab_node, using indentation to show the class
145 typedef union section section
;
147 struct cl_target_option
;
148 struct cl_optimization
;
150 struct cl_decoded_option
;
151 struct cl_option_handlers
;
152 struct diagnostic_context
;
153 struct pretty_printer
;
155 /* Address space number for named address space support. */
156 typedef unsigned char addr_space_t
;
158 /* The value of addr_space_t that represents the generic address space. */
159 #define ADDR_SPACE_GENERIC 0
160 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
162 /* The major intermediate representations of GCC. */
169 /* Provide forward struct declaration so that we don't have to include
170 all of cpplib.h whenever a random prototype includes a pointer.
171 Note that the cpp_reader and cpp_token typedefs remain part of
177 /* The thread-local storage model associated with a given VAR_DECL
178 or SYMBOL_REF. This isn't used much, but both trees and RTL refer
179 to it, so it's here. */
184 TLS_MODEL_GLOBAL_DYNAMIC
= TLS_MODEL_REAL
,
185 TLS_MODEL_LOCAL_DYNAMIC
,
186 TLS_MODEL_INITIAL_EXEC
,
190 /* Types of ABI for an offload compiler. */
197 /* Types of profile update methods. */
198 enum profile_update
{
199 PROFILE_UPDATE_SINGLE
,
200 PROFILE_UPDATE_ATOMIC
,
201 PROFILE_UPDATE_PREFER_ATOMIC
204 /* Types of unwind/exception handling info that can be generated. */
206 enum unwind_info_type
215 /* Callgraph node profile representation. */
216 enum node_frequency
{
217 /* This function most likely won't be executed at all.
218 (set only when profile feedback is available or via function attribute). */
219 NODE_FREQUENCY_UNLIKELY_EXECUTED
,
220 /* For functions that are known to be executed once (i.e. constructors, destructors
221 and main function. */
222 NODE_FREQUENCY_EXECUTED_ONCE
,
223 /* The default value. */
224 NODE_FREQUENCY_NORMAL
,
225 /* Optimize this function hard
226 (set only when profile feedback is available or via function attribute). */
230 /* Ways of optimizing code. */
231 enum optimization_type
{
232 /* Prioritize speed over size. */
235 /* Only do things that are good for both size and speed. */
238 /* Prioritize size over speed. */
242 /* Enumerates a padding direction. */
244 /* No padding is required. */
247 /* Insert padding above the data, i.e. at higher memeory addresses
248 when dealing with memory, and at the most significant end when
249 dealing with registers. */
252 /* Insert padding below the data, i.e. at lower memeory addresses
253 when dealing with memory, and at the least significant end when
254 dealing with registers. */
258 /* Possible initialization status of a variable. When requested
259 by the user, this information is tracked and recorded in the DWARF
260 debug information, along with the variable's location. */
263 VAR_INIT_STATUS_UNKNOWN
,
264 VAR_INIT_STATUS_UNINITIALIZED
,
265 VAR_INIT_STATUS_INITIALIZED
268 /* Names for the different levels of -Wstrict-overflow=N. The numeric
269 values here correspond to N. */
270 enum warn_strict_overflow_code
272 /* Overflow warning that should be issued with -Wall: a questionable
273 construct that is easy to avoid even when using macros. Example:
274 folding (x + CONSTANT > x) to 1. */
275 WARN_STRICT_OVERFLOW_ALL
= 1,
276 /* Overflow warning about folding a comparison to a constant because
277 of undefined signed overflow, other than cases covered by
278 WARN_STRICT_OVERFLOW_ALL. Example: folding (abs (x) >= 0) to 1
279 (this is false when x == INT_MIN). */
280 WARN_STRICT_OVERFLOW_CONDITIONAL
= 2,
281 /* Overflow warning about changes to comparisons other than folding
282 them to a constant. Example: folding (x + 1 > 1) to (x > 0). */
283 WARN_STRICT_OVERFLOW_COMPARISON
= 3,
284 /* Overflow warnings not covered by the above cases. Example:
285 folding ((x * 10) / 5) to (x * 2). */
286 WARN_STRICT_OVERFLOW_MISC
= 4,
287 /* Overflow warnings about reducing magnitude of constants in
288 comparison. Example: folding (x + 2 > y) to (x + 1 >= y). */
289 WARN_STRICT_OVERFLOW_MAGNITUDE
= 5
292 /* The type of an alias set. Code currently assumes that variables of
293 this type can take the values 0 (the alias set which aliases
294 everything) and -1 (sometimes indicating that the alias set is
295 unknown, sometimes indicating a memory barrier) and -2 (indicating
296 that the alias set should be set to a unique value but has not been
298 typedef int alias_set_type
;
301 typedef struct edge_def
*edge
;
302 typedef const struct edge_def
*const_edge
;
303 struct basic_block_def
;
304 typedef struct basic_block_def
*basic_block
;
305 typedef const struct basic_block_def
*const_basic_block
;
307 #if !defined (GENERATOR_FILE)
308 # define OBSTACK_CHUNK_SIZE memory_block_pool::block_size
309 # define obstack_chunk_alloc mempool_obstack_chunk_alloc
310 # define obstack_chunk_free mempool_obstack_chunk_free
312 # define OBSTACK_CHUNK_SIZE 0
313 # define obstack_chunk_alloc xmalloc
314 # define obstack_chunk_free free
317 #define gcc_obstack_init(OBSTACK) \
318 obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
319 obstack_chunk_alloc, \
322 /* enum reg_class is target specific, so it should not appear in
323 target-independent code or interfaces, like the target hook declarations
325 typedef int reg_class_t
;
333 typedef std::pair
<tree
, tree
> tree_pair
;
335 /* Define a name->value mapping. */
336 template <typename ValueType
>
339 const char *const name
; /* the name of the value */
340 const ValueType value
; /* the value of the name */
345 struct _dont_use_rtx_here_
;
346 struct _dont_use_rtvec_here_
;
347 struct _dont_use_rtx_insn_here_
;
348 union _dont_use_tree_here_
;
349 #define rtx struct _dont_use_rtx_here_ *
350 #define const_rtx struct _dont_use_rtx_here_ *
351 #define rtvec struct _dont_use_rtvec_here *
352 #define const_rtvec struct _dont_use_rtvec_here *
353 #define rtx_insn struct _dont_use_rtx_insn_here_
354 #define tree union _dont_use_tree_here_ *
355 #define const_tree union _dont_use_tree_here_ *
357 typedef struct scalar_mode scalar_mode
;
358 typedef struct scalar_int_mode scalar_int_mode
;
359 typedef struct scalar_float_mode scalar_float_mode
;
360 typedef struct complex_mode complex_mode
;
364 /* Classes of functions that compiler needs to check
365 whether they are present at the runtime or not. */
366 enum function_class
{
369 function_c99_math_complex
,
374 /* Enumerate visibility settings. This is deliberately ordered from most
375 to least visibility. */
376 enum symbol_visibility
379 VISIBILITY_PROTECTED
,
384 /* enums used by the targetm.excess_precision hook. */
388 FLT_EVAL_METHOD_UNPREDICTABLE
= -1,
389 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT
= 0,
390 FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE
= 1,
391 FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE
= 2,
392 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16
= 16
395 enum excess_precision_type
397 EXCESS_PRECISION_TYPE_IMPLICIT
,
398 EXCESS_PRECISION_TYPE_STANDARD
,
399 EXCESS_PRECISION_TYPE_FAST
402 /* Support for user-provided GGC and PCH markers. The first parameter
403 is a pointer to a pointer, the second a cookie. */
404 typedef void (*gt_pointer_operator
) (void *, void *);
406 #if !defined (HAVE_UCHAR)
407 typedef unsigned char uchar
;
410 /* Most source files will require the following headers. */
411 #if !defined (USED_FOR_TARGET)
412 #include "insn-modes.h"
414 #include "wide-int.h"
415 #include "wide-int-print.h"
417 /* On targets that don't need polynomial offsets, target-specific code
418 should be able to treat poly_int like a normal constant, with a
419 conversion operator going from the former to the latter. We also
420 allow this for gencondmd.c for all targets, so that we can treat
421 machine_modes as enums without causing build failures. */
422 #if (defined (IN_TARGET_CODE) \
423 && (defined (USE_ENUM_MODES) || NUM_POLY_INT_COEFFS == 1))
424 #define POLY_INT_CONVERSION 1
426 #define POLY_INT_CONVERSION 0
429 #include "poly-int.h"
430 #include "poly-int-types.h"
431 #include "insn-modes-inline.h"
432 #include "machmode.h"
433 #include "double-int.h"
435 /* Most host source files will require the following headers. */
436 #if !defined (GENERATOR_FILE)
438 #include "fixed-value.h"
439 #include "hash-table.h"
440 #include "hash-set.h"
443 #include "memory-block.h"
444 #include "dumpfile.h"
446 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
448 #endif /* coretypes.h */