1 /* GCC core type declarations.
2 Copyright (C) 2002-2019 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
;
49 struct bitmap_obstack
;
51 typedef class bitmap_head
*bitmap
;
52 typedef const class bitmap_head
*const_bitmap
;
53 struct simple_bitmap_def
;
54 typedef struct simple_bitmap_def
*sbitmap
;
55 typedef const struct simple_bitmap_def
*const_sbitmap
;
57 typedef struct rtx_def
*rtx
;
58 typedef const struct rtx_def
*const_rtx
;
60 class scalar_int_mode
;
61 class scalar_float_mode
;
63 class fixed_size_mode
;
64 template<typename
> class opt_mode
;
65 typedef opt_mode
<scalar_mode
> opt_scalar_mode
;
66 typedef opt_mode
<scalar_int_mode
> opt_scalar_int_mode
;
67 typedef opt_mode
<scalar_float_mode
> opt_scalar_float_mode
;
68 template<typename
> struct pod_mode
;
69 typedef pod_mode
<scalar_mode
> scalar_mode_pod
;
70 typedef pod_mode
<scalar_int_mode
> scalar_int_mode_pod
;
71 typedef pod_mode
<fixed_size_mode
> fixed_size_mode_pod
;
73 /* Subclasses of rtx_def, using indentation to show the class
74 hierarchy, along with the relevant invariant.
75 Where possible, keep this list in the same order as in rtl.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 */
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) */
91 typedef struct rtvec_def
*rtvec
;
92 typedef const struct rtvec_def
*const_rtvec
;
94 typedef struct hwivec_def
*hwivec
;
95 typedef const struct hwivec_def
*const_hwivec
;
97 typedef union tree_node
*tree
;
98 typedef const union tree_node
*const_tree
;
100 typedef gimple
*gimple_seq
;
101 struct gimple_stmt_iterator
;
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. */
125 struct gomp_atomic_load
;
126 struct gomp_atomic_store
;
127 struct gomp_continue
;
128 struct gomp_critical
;
131 struct gomp_parallel
;
133 struct gomp_sections
;
138 /* Subclasses of symtab_node, using indentation to show the class
146 typedef union section section
;
148 struct cl_target_option
;
149 struct cl_optimization
;
151 struct cl_decoded_option
;
152 struct cl_option_handlers
;
153 struct diagnostic_context
;
154 class pretty_printer
;
156 template<typename T
> struct array_traits
;
158 /* Provides a read-only bitmap view of a single integer bitmask or an
159 array of integer bitmasks, or of a wrapper around such bitmasks. */
160 template<typename T
, typename Traits
= array_traits
<T
>,
161 bool has_constant_size
= Traits::has_constant_size
>
164 /* Address space number for named address space support. */
165 typedef unsigned char addr_space_t
;
167 /* The value of addr_space_t that represents the generic address space. */
168 #define ADDR_SPACE_GENERIC 0
169 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
171 /* The major intermediate representations of GCC. */
178 /* Provide forward struct declaration so that we don't have to include
179 all of cpplib.h whenever a random prototype includes a pointer.
180 Note that the cpp_reader and cpp_token typedefs remain part of
186 /* The thread-local storage model associated with a given VAR_DECL
187 or SYMBOL_REF. This isn't used much, but both trees and RTL refer
188 to it, so it's here. */
193 TLS_MODEL_GLOBAL_DYNAMIC
= TLS_MODEL_REAL
,
194 TLS_MODEL_LOCAL_DYNAMIC
,
195 TLS_MODEL_INITIAL_EXEC
,
199 /* Types of ABI for an offload compiler. */
206 /* Types of profile update methods. */
207 enum profile_update
{
208 PROFILE_UPDATE_SINGLE
,
209 PROFILE_UPDATE_ATOMIC
,
210 PROFILE_UPDATE_PREFER_ATOMIC
213 /* Types of unwind/exception handling info that can be generated. */
215 enum unwind_info_type
224 /* Callgraph node profile representation. */
225 enum node_frequency
{
226 /* This function most likely won't be executed at all.
227 (set only when profile feedback is available or via function attribute). */
228 NODE_FREQUENCY_UNLIKELY_EXECUTED
,
229 /* For functions that are known to be executed once (i.e. constructors, destructors
230 and main function. */
231 NODE_FREQUENCY_EXECUTED_ONCE
,
232 /* The default value. */
233 NODE_FREQUENCY_NORMAL
,
234 /* Optimize this function hard
235 (set only when profile feedback is available or via function attribute). */
239 /* Ways of optimizing code. */
240 enum optimization_type
{
241 /* Prioritize speed over size. */
244 /* Only do things that are good for both size and speed. */
247 /* Prioritize size over speed. */
251 /* Enumerates a padding direction. */
253 /* No padding is required. */
256 /* Insert padding above the data, i.e. at higher memeory addresses
257 when dealing with memory, and at the most significant end when
258 dealing with registers. */
261 /* Insert padding below the data, i.e. at lower memeory addresses
262 when dealing with memory, and at the least significant end when
263 dealing with registers. */
267 /* Possible initialization status of a variable. When requested
268 by the user, this information is tracked and recorded in the DWARF
269 debug information, along with the variable's location. */
272 VAR_INIT_STATUS_UNKNOWN
,
273 VAR_INIT_STATUS_UNINITIALIZED
,
274 VAR_INIT_STATUS_INITIALIZED
277 /* Names for the different levels of -Wstrict-overflow=N. The numeric
278 values here correspond to N. */
279 enum warn_strict_overflow_code
281 /* Overflow warning that should be issued with -Wall: a questionable
282 construct that is easy to avoid even when using macros. Example:
283 folding (x + CONSTANT > x) to 1. */
284 WARN_STRICT_OVERFLOW_ALL
= 1,
285 /* Overflow warning about folding a comparison to a constant because
286 of undefined signed overflow, other than cases covered by
287 WARN_STRICT_OVERFLOW_ALL. Example: folding (abs (x) >= 0) to 1
288 (this is false when x == INT_MIN). */
289 WARN_STRICT_OVERFLOW_CONDITIONAL
= 2,
290 /* Overflow warning about changes to comparisons other than folding
291 them to a constant. Example: folding (x + 1 > 1) to (x > 0). */
292 WARN_STRICT_OVERFLOW_COMPARISON
= 3,
293 /* Overflow warnings not covered by the above cases. Example:
294 folding ((x * 10) / 5) to (x * 2). */
295 WARN_STRICT_OVERFLOW_MISC
= 4,
296 /* Overflow warnings about reducing magnitude of constants in
297 comparison. Example: folding (x + 2 > y) to (x + 1 >= y). */
298 WARN_STRICT_OVERFLOW_MAGNITUDE
= 5
301 /* The type of an alias set. Code currently assumes that variables of
302 this type can take the values 0 (the alias set which aliases
303 everything) and -1 (sometimes indicating that the alias set is
304 unknown, sometimes indicating a memory barrier) and -2 (indicating
305 that the alias set should be set to a unique value but has not been
307 typedef int alias_set_type
;
310 typedef class edge_def
*edge
;
311 typedef const class edge_def
*const_edge
;
312 struct basic_block_def
;
313 typedef struct basic_block_def
*basic_block
;
314 typedef const struct basic_block_def
*const_basic_block
;
316 #if !defined (GENERATOR_FILE)
317 # define OBSTACK_CHUNK_SIZE memory_block_pool::block_size
318 # define obstack_chunk_alloc mempool_obstack_chunk_alloc
319 # define obstack_chunk_free mempool_obstack_chunk_free
321 # define OBSTACK_CHUNK_SIZE 0
322 # define obstack_chunk_alloc xmalloc
323 # define obstack_chunk_free free
326 #define gcc_obstack_init(OBSTACK) \
327 obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0, \
328 obstack_chunk_alloc, \
331 /* enum reg_class is target specific, so it should not appear in
332 target-independent code or interfaces, like the target hook declarations
334 typedef int reg_class_t
;
342 typedef std::pair
<tree
, tree
> tree_pair
;
344 /* Define a name->value mapping. */
345 template <typename ValueType
>
348 const char *const name
; /* the name of the value */
349 const ValueType value
; /* the value of the name */
354 struct _dont_use_rtx_here_
;
355 struct _dont_use_rtvec_here_
;
356 struct _dont_use_rtx_insn_here_
;
357 union _dont_use_tree_here_
;
358 #define rtx struct _dont_use_rtx_here_ *
359 #define const_rtx struct _dont_use_rtx_here_ *
360 #define rtvec struct _dont_use_rtvec_here *
361 #define const_rtvec struct _dont_use_rtvec_here *
362 #define rtx_insn struct _dont_use_rtx_insn_here_
363 #define tree union _dont_use_tree_here_ *
364 #define const_tree union _dont_use_tree_here_ *
366 typedef struct scalar_mode scalar_mode
;
367 typedef struct scalar_int_mode scalar_int_mode
;
368 typedef struct scalar_float_mode scalar_float_mode
;
369 typedef struct complex_mode complex_mode
;
373 /* Classes of functions that compiler needs to check
374 whether they are present at the runtime or not. */
375 enum function_class
{
378 function_c99_math_complex
,
383 /* Enumerate visibility settings. This is deliberately ordered from most
384 to least visibility. */
385 enum symbol_visibility
388 VISIBILITY_PROTECTED
,
393 /* enums used by the targetm.excess_precision hook. */
397 FLT_EVAL_METHOD_UNPREDICTABLE
= -1,
398 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT
= 0,
399 FLT_EVAL_METHOD_PROMOTE_TO_DOUBLE
= 1,
400 FLT_EVAL_METHOD_PROMOTE_TO_LONG_DOUBLE
= 2,
401 FLT_EVAL_METHOD_PROMOTE_TO_FLOAT16
= 16
404 enum excess_precision_type
406 EXCESS_PRECISION_TYPE_IMPLICIT
,
407 EXCESS_PRECISION_TYPE_STANDARD
,
408 EXCESS_PRECISION_TYPE_FAST
411 /* Support for user-provided GGC and PCH markers. The first parameter
412 is a pointer to a pointer, the second a cookie. */
413 typedef void (*gt_pointer_operator
) (void *, void *);
415 #if !defined (HAVE_UCHAR)
416 typedef unsigned char uchar
;
419 /* Most source files will require the following headers. */
420 #if !defined (USED_FOR_TARGET)
421 #include "insn-modes.h"
423 #include "wide-int.h"
424 #include "wide-int-print.h"
426 /* On targets that don't need polynomial offsets, target-specific code
427 should be able to treat poly_int like a normal constant, with a
428 conversion operator going from the former to the latter. We also
429 allow this for gencondmd.c for all targets, so that we can treat
430 machine_modes as enums without causing build failures. */
431 #if (defined (IN_TARGET_CODE) \
432 && (defined (USE_ENUM_MODES) || NUM_POLY_INT_COEFFS == 1))
433 #define POLY_INT_CONVERSION 1
435 #define POLY_INT_CONVERSION 0
438 #include "poly-int.h"
439 #include "poly-int-types.h"
440 #include "insn-modes-inline.h"
441 #include "machmode.h"
442 #include "double-int.h"
444 /* Most host source files will require the following headers. */
445 #if !defined (GENERATOR_FILE)
447 #include "fixed-value.h"
448 #include "hash-table.h"
449 #include "hash-set.h"
452 #include "memory-block.h"
453 #include "dumpfile.h"
455 #endif /* GENERATOR_FILE && !USED_FOR_TARGET */
457 #endif /* coretypes.h */