1 | /* Pragma related interfaces. |
2 | Copyright (C) 1995-2023 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 | You should have received a copy of the GNU General Public License |
17 | along with GCC; see the file COPYING3. If not see |
18 | <http://www.gnu.org/licenses/>. */ |
19 | |
20 | #ifndef GCC_C_PRAGMA_H |
21 | #define GCC_C_PRAGMA_H |
22 | |
23 | #include "cpplib.h" /* For enum cpp_ttype. */ |
24 | |
25 | /* Pragma identifiers built in to the front end parsers. Identifiers |
26 | for ancillary handlers will follow these. */ |
27 | enum pragma_kind { |
28 | PRAGMA_NONE = 0, |
29 | |
30 | PRAGMA_OACC_ATOMIC, |
31 | PRAGMA_OACC_CACHE, |
32 | PRAGMA_OACC_DATA, |
33 | PRAGMA_OACC_DECLARE, |
34 | PRAGMA_OACC_ENTER_DATA, |
35 | PRAGMA_OACC_EXIT_DATA, |
36 | PRAGMA_OACC_HOST_DATA, |
37 | PRAGMA_OACC_KERNELS, |
38 | PRAGMA_OACC_LOOP, |
39 | PRAGMA_OACC_PARALLEL, |
40 | PRAGMA_OACC_ROUTINE, |
41 | PRAGMA_OACC_SERIAL, |
42 | PRAGMA_OACC_UPDATE, |
43 | PRAGMA_OACC_WAIT, |
44 | |
45 | /* PRAGMA_OMP__START_ should be equal to the first PRAGMA_OMP_* code. */ |
46 | PRAGMA_OMP_ALLOCATE, |
47 | PRAGMA_OMP__START_ = PRAGMA_OMP_ALLOCATE, |
48 | PRAGMA_OMP_ASSUME, |
49 | PRAGMA_OMP_ASSUMES, |
50 | PRAGMA_OMP_ATOMIC, |
51 | PRAGMA_OMP_BARRIER, |
52 | PRAGMA_OMP_BEGIN, |
53 | PRAGMA_OMP_CANCEL, |
54 | PRAGMA_OMP_CANCELLATION_POINT, |
55 | PRAGMA_OMP_CRITICAL, |
56 | PRAGMA_OMP_DECLARE, |
57 | PRAGMA_OMP_DEPOBJ, |
58 | PRAGMA_OMP_DISTRIBUTE, |
59 | PRAGMA_OMP_ERROR, |
60 | PRAGMA_OMP_END, |
61 | PRAGMA_OMP_FLUSH, |
62 | PRAGMA_OMP_FOR, |
63 | PRAGMA_OMP_LOOP, |
64 | PRAGMA_OMP_NOTHING, |
65 | PRAGMA_OMP_MASKED, |
66 | PRAGMA_OMP_MASTER, |
67 | PRAGMA_OMP_ORDERED, |
68 | PRAGMA_OMP_PARALLEL, |
69 | PRAGMA_OMP_REQUIRES, |
70 | PRAGMA_OMP_SCAN, |
71 | PRAGMA_OMP_SCOPE, |
72 | PRAGMA_OMP_SECTION, |
73 | PRAGMA_OMP_SECTIONS, |
74 | PRAGMA_OMP_SIMD, |
75 | PRAGMA_OMP_SINGLE, |
76 | PRAGMA_OMP_TARGET, |
77 | PRAGMA_OMP_TASK, |
78 | PRAGMA_OMP_TASKGROUP, |
79 | PRAGMA_OMP_TASKLOOP, |
80 | PRAGMA_OMP_TASKWAIT, |
81 | PRAGMA_OMP_TASKYIELD, |
82 | PRAGMA_OMP_THREADPRIVATE, |
83 | PRAGMA_OMP_TEAMS, |
84 | /* PRAGMA_OMP__LAST_ should be equal to the last PRAGMA_OMP_* code. */ |
85 | PRAGMA_OMP__LAST_ = PRAGMA_OMP_TEAMS, |
86 | |
87 | PRAGMA_GCC_PCH_PREPROCESS, |
88 | PRAGMA_IVDEP, |
89 | PRAGMA_UNROLL, |
90 | PRAGMA_NOVECTOR, |
91 | |
92 | PRAGMA_FIRST_EXTERNAL |
93 | }; |
94 | |
95 | |
96 | /* All clauses defined by OpenACC 2.0, and OpenMP 2.5, 3.0, 3.1, 4.0, 4.5, 5.0, |
97 | 5.1 and 5.2. Used internally by both C and C++ parsers. */ |
98 | enum pragma_omp_clause { |
99 | PRAGMA_OMP_CLAUSE_NONE = 0, |
100 | |
101 | PRAGMA_OMP_CLAUSE_AFFINITY, |
102 | PRAGMA_OMP_CLAUSE_ALIGNED, |
103 | PRAGMA_OMP_CLAUSE_ALLOCATE, |
104 | PRAGMA_OMP_CLAUSE_BIND, |
105 | PRAGMA_OMP_CLAUSE_COLLAPSE, |
106 | PRAGMA_OMP_CLAUSE_COPYIN, |
107 | PRAGMA_OMP_CLAUSE_COPYPRIVATE, |
108 | PRAGMA_OMP_CLAUSE_DEFAULT, |
109 | PRAGMA_OMP_CLAUSE_DEFAULTMAP, |
110 | PRAGMA_OMP_CLAUSE_DEPEND, |
111 | PRAGMA_OMP_CLAUSE_DETACH, |
112 | PRAGMA_OMP_CLAUSE_DEVICE, |
113 | PRAGMA_OMP_CLAUSE_DEVICE_TYPE, |
114 | PRAGMA_OMP_CLAUSE_DIST_SCHEDULE, |
115 | PRAGMA_OMP_CLAUSE_DOACROSS, |
116 | PRAGMA_OMP_CLAUSE_ENTER, |
117 | PRAGMA_OMP_CLAUSE_FILTER, |
118 | PRAGMA_OMP_CLAUSE_FINAL, |
119 | PRAGMA_OMP_CLAUSE_FIRSTPRIVATE, |
120 | PRAGMA_OMP_CLAUSE_FOR, |
121 | PRAGMA_OMP_CLAUSE_FROM, |
122 | PRAGMA_OMP_CLAUSE_GRAINSIZE, |
123 | PRAGMA_OMP_CLAUSE_HAS_DEVICE_ADDR, |
124 | PRAGMA_OMP_CLAUSE_HINT, |
125 | PRAGMA_OMP_CLAUSE_IF, |
126 | PRAGMA_OMP_CLAUSE_IN_REDUCTION, |
127 | PRAGMA_OMP_CLAUSE_INBRANCH, |
128 | PRAGMA_OMP_CLAUSE_INDIRECT, |
129 | PRAGMA_OMP_CLAUSE_IS_DEVICE_PTR, |
130 | PRAGMA_OMP_CLAUSE_LASTPRIVATE, |
131 | PRAGMA_OMP_CLAUSE_LINEAR, |
132 | PRAGMA_OMP_CLAUSE_LINK, |
133 | PRAGMA_OMP_CLAUSE_MAP, |
134 | PRAGMA_OMP_CLAUSE_MERGEABLE, |
135 | PRAGMA_OMP_CLAUSE_NOGROUP, |
136 | PRAGMA_OMP_CLAUSE_NONTEMPORAL, |
137 | PRAGMA_OMP_CLAUSE_NOTINBRANCH, |
138 | PRAGMA_OMP_CLAUSE_NOWAIT, |
139 | PRAGMA_OMP_CLAUSE_NUM_TASKS, |
140 | PRAGMA_OMP_CLAUSE_NUM_TEAMS, |
141 | PRAGMA_OMP_CLAUSE_NUM_THREADS, |
142 | PRAGMA_OMP_CLAUSE_ORDER, |
143 | PRAGMA_OMP_CLAUSE_ORDERED, |
144 | PRAGMA_OMP_CLAUSE_PARALLEL, |
145 | PRAGMA_OMP_CLAUSE_PRIORITY, |
146 | PRAGMA_OMP_CLAUSE_PRIVATE, |
147 | PRAGMA_OMP_CLAUSE_PROC_BIND, |
148 | PRAGMA_OMP_CLAUSE_REDUCTION, |
149 | PRAGMA_OMP_CLAUSE_SAFELEN, |
150 | PRAGMA_OMP_CLAUSE_SCHEDULE, |
151 | PRAGMA_OMP_CLAUSE_SECTIONS, |
152 | PRAGMA_OMP_CLAUSE_SHARED, |
153 | PRAGMA_OMP_CLAUSE_SIMD, |
154 | PRAGMA_OMP_CLAUSE_SIMDLEN, |
155 | PRAGMA_OMP_CLAUSE_TASK_REDUCTION, |
156 | PRAGMA_OMP_CLAUSE_TASKGROUP, |
157 | PRAGMA_OMP_CLAUSE_THREAD_LIMIT, |
158 | PRAGMA_OMP_CLAUSE_THREADS, |
159 | PRAGMA_OMP_CLAUSE_TO, |
160 | PRAGMA_OMP_CLAUSE_UNIFORM, |
161 | PRAGMA_OMP_CLAUSE_UNTIED, |
162 | PRAGMA_OMP_CLAUSE_USE_DEVICE_PTR, |
163 | PRAGMA_OMP_CLAUSE_USE_DEVICE_ADDR, |
164 | |
165 | /* Clauses for OpenACC. */ |
166 | PRAGMA_OACC_CLAUSE_ASYNC, |
167 | PRAGMA_OACC_CLAUSE_ATTACH, |
168 | PRAGMA_OACC_CLAUSE_AUTO, |
169 | PRAGMA_OACC_CLAUSE_COPY, |
170 | PRAGMA_OACC_CLAUSE_COPYOUT, |
171 | PRAGMA_OACC_CLAUSE_CREATE, |
172 | PRAGMA_OACC_CLAUSE_DELETE, |
173 | PRAGMA_OACC_CLAUSE_DEVICEPTR, |
174 | PRAGMA_OACC_CLAUSE_DEVICE_RESIDENT, |
175 | PRAGMA_OACC_CLAUSE_FINALIZE, |
176 | PRAGMA_OACC_CLAUSE_GANG, |
177 | PRAGMA_OACC_CLAUSE_HOST, |
178 | PRAGMA_OACC_CLAUSE_INDEPENDENT, |
179 | PRAGMA_OACC_CLAUSE_NO_CREATE, |
180 | PRAGMA_OACC_CLAUSE_NOHOST, |
181 | PRAGMA_OACC_CLAUSE_NUM_GANGS, |
182 | PRAGMA_OACC_CLAUSE_NUM_WORKERS, |
183 | PRAGMA_OACC_CLAUSE_PRESENT, |
184 | PRAGMA_OACC_CLAUSE_SELF, |
185 | PRAGMA_OACC_CLAUSE_SEQ, |
186 | PRAGMA_OACC_CLAUSE_TILE, |
187 | PRAGMA_OACC_CLAUSE_VECTOR, |
188 | PRAGMA_OACC_CLAUSE_VECTOR_LENGTH, |
189 | PRAGMA_OACC_CLAUSE_WAIT, |
190 | PRAGMA_OACC_CLAUSE_WORKER, |
191 | PRAGMA_OACC_CLAUSE_IF_PRESENT, |
192 | PRAGMA_OACC_CLAUSE_COLLAPSE = PRAGMA_OMP_CLAUSE_COLLAPSE, |
193 | PRAGMA_OACC_CLAUSE_COPYIN = PRAGMA_OMP_CLAUSE_COPYIN, |
194 | PRAGMA_OACC_CLAUSE_DEVICE = PRAGMA_OMP_CLAUSE_DEVICE, |
195 | PRAGMA_OACC_CLAUSE_DEFAULT = PRAGMA_OMP_CLAUSE_DEFAULT, |
196 | PRAGMA_OACC_CLAUSE_DETACH = PRAGMA_OMP_CLAUSE_DETACH, |
197 | PRAGMA_OACC_CLAUSE_FIRSTPRIVATE = PRAGMA_OMP_CLAUSE_FIRSTPRIVATE, |
198 | PRAGMA_OACC_CLAUSE_IF = PRAGMA_OMP_CLAUSE_IF, |
199 | PRAGMA_OACC_CLAUSE_PRIVATE = PRAGMA_OMP_CLAUSE_PRIVATE, |
200 | PRAGMA_OACC_CLAUSE_REDUCTION = PRAGMA_OMP_CLAUSE_REDUCTION, |
201 | PRAGMA_OACC_CLAUSE_LINK = PRAGMA_OMP_CLAUSE_LINK, |
202 | PRAGMA_OACC_CLAUSE_USE_DEVICE = PRAGMA_OMP_CLAUSE_USE_DEVICE_PTR |
203 | }; |
204 | |
205 | extern struct cpp_reader* parse_in; |
206 | |
207 | /* It's safe to always leave visibility pragma enabled as if |
208 | visibility is not supported on the host OS platform the |
209 | statements are ignored. */ |
210 | extern void push_visibility (const char *, int); |
211 | extern bool pop_visibility (int); |
212 | |
213 | extern void init_pragma (void); |
214 | |
215 | /* Front-end wrappers for pragma registration. */ |
216 | typedef void (*pragma_handler_1arg)(struct cpp_reader *); |
217 | /* A second pragma handler, which adds a void * argument allowing to pass extra |
218 | data to the handler. */ |
219 | typedef void (*pragma_handler_2arg)(struct cpp_reader *, void *); |
220 | |
221 | /* This union allows to abstract the different handlers. */ |
222 | union gen_pragma_handler { |
223 | pragma_handler_1arg handler_1arg; |
224 | pragma_handler_2arg handler_2arg; |
225 | }; |
226 | /* Internally used to keep the data of the handler. */ |
227 | struct internal_pragma_handler { |
228 | union gen_pragma_handler handler, early_handler; |
229 | /* Permits to know if handler is a pragma_handler_1arg (extra_data is false) |
230 | or a pragma_handler_2arg (extra_data is true). */ |
231 | bool extra_data; |
232 | /* A data field which can be used when extra_data is true. */ |
233 | void * data; |
234 | }; |
235 | |
236 | extern void c_register_pragma (const char *space, const char *name, |
237 | pragma_handler_1arg handler); |
238 | extern void c_register_pragma_with_data (const char *space, const char *name, |
239 | pragma_handler_2arg handler, |
240 | void *data); |
241 | |
242 | extern void c_register_pragma_with_expansion (const char *space, |
243 | const char *name, |
244 | pragma_handler_1arg handler); |
245 | extern void c_register_pragma_with_expansion_and_data (const char *space, |
246 | const char *name, |
247 | pragma_handler_2arg handler, |
248 | void *data); |
249 | extern void c_invoke_pragma_handler (unsigned int); |
250 | |
251 | /* Early pragma handlers run in addition to the normal ones. They can be used |
252 | by frontends such as C++ that may want to process some pragmas during lexing |
253 | before they start processing them. */ |
254 | extern void |
255 | c_register_pragma_with_early_handler (const char *space, const char *name, |
256 | pragma_handler_1arg handler, |
257 | pragma_handler_1arg early_handler); |
258 | extern void c_invoke_early_pragma_handler (unsigned int); |
259 | extern void c_pp_invoke_early_pragma_handler (unsigned int); |
260 | extern void c_reset_target_pragmas (); |
261 | |
262 | extern void maybe_apply_pragma_weak (tree); |
263 | extern void maybe_apply_pending_pragma_weaks (void); |
264 | extern tree maybe_apply_renaming_pragma (tree, tree); |
265 | extern void maybe_apply_pragma_scalar_storage_order (tree); |
266 | extern void add_to_renaming_pragma_list (tree, tree); |
267 | |
268 | /* These are to be implemented in each frontend that needs them. */ |
269 | extern enum cpp_ttype pragma_lex (tree *, location_t *loc = NULL); |
270 | extern void pragma_lex_discard_to_eol (); |
271 | |
272 | /* Flags for use with c_lex_with_flags. The values here were picked |
273 | so that 0 means to translate and join strings. */ |
274 | #define C_LEX_STRING_NO_TRANSLATE 1 /* Do not lex strings into |
275 | execution character set. */ |
276 | #define C_LEX_STRING_NO_JOIN 2 /* Do not concatenate strings |
277 | nor translate them into execution |
278 | character set. */ |
279 | |
280 | /* This is not actually available to pragma parsers. It's merely a |
281 | convenient location to declare this function for c-lex, after |
282 | having enum cpp_ttype declared. */ |
283 | extern enum cpp_ttype c_lex_with_flags (tree *, location_t *, unsigned char *, |
284 | int); |
285 | |
286 | extern void c_pp_lookup_pragma (unsigned int, const char **, const char **); |
287 | |
288 | extern GTY(()) tree pragma_extern_prefix; |
289 | |
290 | #endif /* GCC_C_PRAGMA_H */ |
291 | |