1/* GCC core type declarations.
2   Copyright (C) 2002-2015 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;
58
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.  */
62class 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) */
75
76struct rtvec_def;
77typedef struct rtvec_def *rtvec;
78typedef const struct rtvec_def *const_rtvec;
79struct hwivec_def;
80typedef struct hwivec_def *hwivec;
81typedef const struct hwivec_def *const_hwivec;
82union tree_node;
83typedef union tree_node *tree;
84typedef const union tree_node *const_tree;
85typedef struct gimple_statement_base *gimple;
86typedef const struct gimple_statement_base *const_gimple;
87typedef gimple gimple_seq;
88struct gimple_stmt_iterator;
89
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.  */
92
93struct gcond;
94struct gdebug;
95struct ggoto;
96struct glabel;
97struct gswitch;
98struct gassign;
99struct gasm;
100struct gcall;
101struct gtransaction;
102struct greturn;
103struct gbind;
104struct gcatch;
105struct geh_filter;
106struct geh_mnt;
107struct geh_else;
108struct gresx;
109struct geh_dispatch;
110struct gphi;
111struct gtry;
112struct gomp_atomic_load;
113struct gomp_atomic_store;
114struct gomp_continue;
115struct gomp_critical;
116struct gomp_for;
117struct gomp_parallel;
118struct gomp_task;
119struct gomp_sections;
120struct gomp_single;
121struct gomp_target;
122struct gomp_teams;
123
124union section;
125typedef union section section;
126struct gcc_options;
127struct cl_target_option;
128struct cl_optimization;
129struct cl_option;
130struct cl_decoded_option;
131struct cl_option_handlers;
132struct diagnostic_context;
133struct pretty_printer;
134
135/* Address space number for named address space support.  */
136typedef unsigned char addr_space_t;
137
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)
141
142/* The major intermediate representations of GCC.  */
143enum ir_type {
144  IR_GIMPLE,
145  IR_RTL_CFGRTL,
146  IR_RTL_CFGLAYOUT
147};
148
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.  */
153
154struct cpp_reader;
155struct cpp_token;
156
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.  */
160enum 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
168};
169
170/* Types of ABI for an offload compiler.  */
171enum offload_abi {
172  OFFLOAD_ABI_UNSET,
173  OFFLOAD_ABI_LP64,
174  OFFLOAD_ABI_ILP32
175};
176
177/* Types of unwind/exception handling info that can be generated.  */
178
179enum unwind_info_type
180{
181  UI_NONE,
182  UI_SJLJ,
183  UI_DWARF2,
184  UI_TARGET,
185  UI_SEH
186};
187
188/* Callgraph node profile representation.  */
189enum 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
201};
202
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.  */
206enum var_init_status
207{
208  VAR_INIT_STATUS_UNKNOWN,
209  VAR_INIT_STATUS_UNINITIALIZED,
210  VAR_INIT_STATUS_INITIALIZED
211};
212
213
214struct edge_def;
215typedef struct edge_def *edge;
216typedef const struct edge_def *const_edge;
217struct basic_block_def;
218typedef struct basic_block_def *basic_block;
219typedef const struct basic_block_def *const_basic_block;
220
221#define obstack_chunk_alloc	xmalloc
222#define obstack_chunk_free	free
223#define OBSTACK_CHUNK_SIZE	0
224#define gcc_obstack_init(OBSTACK)				\
225  obstack_specify_allocation ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,	\
226			      obstack_chunk_alloc,		\
227			      obstack_chunk_free)
228
229/* enum reg_class is target specific, so it should not appear in
230   target-independent code or interfaces, like the target hook declarations
231   in target.h.  */
232typedef int reg_class_t;
233
234class rtl_opt_pass;
235
236namespace gcc {
237  class context;
238}
239
240#else
241
242struct _dont_use_rtx_here_;
243struct _dont_use_rtvec_here_;
244struct _dont_use_rtx_insn_here_;
245union _dont_use_tree_here_;
246#define rtx struct _dont_use_rtx_here_ *
247#define const_rtx struct _dont_use_rtx_here_ *
248#define rtvec struct _dont_use_rtvec_here *
249#define const_rtvec struct _dont_use_rtvec_here *
250#define rtx_insn struct _dont_use_rtx_insn_here_
251#define tree union _dont_use_tree_here_ *
252#define const_tree union _dont_use_tree_here_ *
253
254#endif
255
256/* Classes of functions that compiler needs to check
257   whether they are present at the runtime or not.  */
258enum function_class {
259  function_c94,
260  function_c99_misc,
261  function_c99_math_complex,
262  function_sincos,
263  function_c11_misc
264};
265
266/* Suppose that higher bits are target dependent. */
267#define MEMMODEL_MASK ((1<<16)-1)
268
269/* Legacy sync operations set this upper flag in the memory model.  This allows
270   targets that need to do something stronger for sync operations to
271   differentiate with their target patterns and issue a more appropriate insn
272   sequence.  See bugzilla 65697 for background.  */
273#define MEMMODEL_SYNC (1<<15)
274
275/* Memory model without SYNC bit for targets/operations that do not care.  */
276#define MEMMODEL_BASE_MASK (MEMMODEL_SYNC-1)
277
278/* Memory model types for the __atomic* builtins.
279   This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
280enum memmodel
281{
282  MEMMODEL_RELAXED = 0,
283  MEMMODEL_CONSUME = 1,
284  MEMMODEL_ACQUIRE = 2,
285  MEMMODEL_RELEASE = 3,
286  MEMMODEL_ACQ_REL = 4,
287  MEMMODEL_SEQ_CST = 5,
288  MEMMODEL_LAST = 6,
289  MEMMODEL_SYNC_ACQUIRE = MEMMODEL_ACQUIRE | MEMMODEL_SYNC,
290  MEMMODEL_SYNC_RELEASE = MEMMODEL_RELEASE | MEMMODEL_SYNC,
291  MEMMODEL_SYNC_SEQ_CST = MEMMODEL_SEQ_CST | MEMMODEL_SYNC
292};
293
294/* Support for user-provided GGC and PCH markers.  The first parameter
295   is a pointer to a pointer, the second a cookie.  */
296typedef void (*gt_pointer_operator) (void *, void *);
297
298#if !defined (HAVE_UCHAR)
299typedef unsigned char uchar;
300#endif
301
302#endif /* coretypes.h */
303