1 /* GCC core type declarations.
2    Copyright (C) 2002-2014 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
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
9 version.
10 
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
14 for more details.
15 
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.
19 
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/>.  */
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 
46 typedef HOST_WIDEST_INT gcov_type;
47 typedef unsigned HOST_WIDEST_INT gcov_type_unsigned;
48 
49 struct bitmap_head;
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;
55 struct rtx_def;
56 typedef struct rtx_def *rtx;
57 typedef const struct rtx_def *const_rtx;
58 struct rtvec_def;
59 typedef struct rtvec_def *rtvec;
60 typedef const struct rtvec_def *const_rtvec;
61 union tree_node;
62 typedef union tree_node *tree;
63 typedef const union tree_node *const_tree;
64 typedef struct gimple_statement_base *gimple;
65 typedef const struct gimple_statement_base *const_gimple;
66 typedef gimple gimple_seq;
67 struct gimple_stmt_iterator;
68 union section;
69 typedef union section section;
70 struct gcc_options;
71 struct cl_target_option;
72 struct cl_optimization;
73 struct cl_option;
74 struct cl_decoded_option;
75 struct cl_option_handlers;
76 struct diagnostic_context;
77 struct pretty_printer;
78 
79 /* Address space number for named address space support.  */
80 typedef unsigned char addr_space_t;
81 
82 /* The value of addr_space_t that represents the generic address space.  */
83 #define ADDR_SPACE_GENERIC 0
84 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
85 
86 /* The major intermediate representations of GCC.  */
87 enum ir_type {
88   IR_GIMPLE,
89   IR_RTL_CFGRTL,
90   IR_RTL_CFGLAYOUT
91 };
92 
93 /* Provide forward struct declaration so that we don't have to include
94    all of cpplib.h whenever a random prototype includes a pointer.
95    Note that the cpp_reader and cpp_token typedefs remain part of
96    cpplib.h.  */
97 
98 struct cpp_reader;
99 struct cpp_token;
100 
101 /* The thread-local storage model associated with a given VAR_DECL
102    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
103    to it, so it's here.  */
104 enum tls_model {
105   TLS_MODEL_NONE,
106   TLS_MODEL_EMULATED,
107   TLS_MODEL_REAL,
108   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
109   TLS_MODEL_LOCAL_DYNAMIC,
110   TLS_MODEL_INITIAL_EXEC,
111   TLS_MODEL_LOCAL_EXEC
112 };
113 
114 /* Types of unwind/exception handling info that can be generated.  */
115 
116 enum unwind_info_type
117 {
118   UI_NONE,
119   UI_SJLJ,
120   UI_DWARF2,
121   UI_TARGET,
122   UI_SEH
123 };
124 
125 /* Callgraph node profile representation.  */
126 enum node_frequency {
127   /* This function most likely won't be executed at all.
128      (set only when profile feedback is available or via function attribute). */
129   NODE_FREQUENCY_UNLIKELY_EXECUTED,
130   /* For functions that are known to be executed once (i.e. constructors, destructors
131      and main function.  */
132   NODE_FREQUENCY_EXECUTED_ONCE,
133   /* The default value.  */
134   NODE_FREQUENCY_NORMAL,
135   /* Optimize this function hard
136      (set only when profile feedback is available or via function attribute). */
137   NODE_FREQUENCY_HOT
138 };
139 
140 /* Possible initialization status of a variable.   When requested
141    by the user, this information is tracked and recorded in the DWARF
142    debug information, along with the variable's location.  */
143 enum var_init_status
144 {
145   VAR_INIT_STATUS_UNKNOWN,
146   VAR_INIT_STATUS_UNINITIALIZED,
147   VAR_INIT_STATUS_INITIALIZED
148 };
149 
150 
151 struct edge_def;
152 typedef struct edge_def *edge;
153 typedef const struct edge_def *const_edge;
154 struct basic_block_def;
155 typedef struct basic_block_def *basic_block;
156 typedef const struct basic_block_def *const_basic_block;
157 
158 #define obstack_chunk_alloc	((void *(*) (long)) xmalloc)
159 #define obstack_chunk_free	((void (*) (void *)) free)
160 #define OBSTACK_CHUNK_SIZE	0
161 #define gcc_obstack_init(OBSTACK)			\
162   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,	\
163 		  obstack_chunk_alloc,			\
164 		  obstack_chunk_free)
165 
166 /* enum reg_class is target specific, so it should not appear in
167    target-independent code or interfaces, like the target hook declarations
168    in target.h.  */
169 typedef int reg_class_t;
170 
171 class rtl_opt_pass;
172 
173 namespace gcc {
174   class context;
175 }
176 
177 #else
178 
179 struct _dont_use_rtx_here_;
180 struct _dont_use_rtvec_here_;
181 union _dont_use_tree_here_;
182 #define rtx struct _dont_use_rtx_here_ *
183 #define const_rtx struct _dont_use_rtx_here_ *
184 #define rtvec struct _dont_use_rtvec_here *
185 #define const_rtvec struct _dont_use_rtvec_here *
186 #define tree union _dont_use_tree_here_ *
187 #define const_tree union _dont_use_tree_here_ *
188 
189 #endif
190 
191 /* Classes of functions that compiler needs to check
192    whether they are present at the runtime or not.  */
193 enum function_class {
194   function_c94,
195   function_c99_misc,
196   function_c99_math_complex,
197   function_sincos
198 };
199 
200 /* Memory model types for the __atomic* builtins.
201    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
202 enum memmodel
203 {
204   MEMMODEL_RELAXED = 0,
205   MEMMODEL_CONSUME = 1,
206   MEMMODEL_ACQUIRE = 2,
207   MEMMODEL_RELEASE = 3,
208   MEMMODEL_ACQ_REL = 4,
209   MEMMODEL_SEQ_CST = 5,
210   MEMMODEL_LAST = 6
211 };
212 
213 /* Suppose that higher bits are target dependent. */
214 #define MEMMODEL_MASK ((1<<16)-1)
215 
216 /* Support for user-provided GGC and PCH markers.  The first parameter
217    is a pointer to a pointer, the second a cookie.  */
218 typedef void (*gt_pointer_operator) (void *, void *);
219 
220 #if !defined (HAVE_UCHAR)
221 typedef unsigned char uchar;
222 #endif
223 
224 #endif /* coretypes.h */
225