1#ifndef LLVM_OpenACC_INC
2#define LLVM_OpenACC_INC
3
4#include "llvm/ADT/ArrayRef.h"
5#include "llvm/ADT/BitmaskEnum.h"
6#include "llvm/ADT/Sequence.h"
7#include "llvm/ADT/STLExtras.h"
8#include "llvm/ADT/StringRef.h"
9#include "llvm/Frontend/Directive/Spelling.h"
10#include "llvm/Frontend/Directive/Version.h"
11#include "llvm/Support/Compiler.h"
12#include <cstddef>
13#include <utility>
14
15namespace llvm {
16
17namespace acc {
18
19LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
20
21enum class Association {
22 Block,
23 First_ = Block,
24 Declaration,
25 Delimited,
26 Explicit,
27 LoopNest,
28 LoopSequence,
29 None,
30 Separating,
31 Last_ = Separating,
32};
33
34static constexpr std::size_t Association_enumSize = 8;
35
36enum class Category {
37 Declarative,
38 First_ = Declarative,
39 Executable,
40 Informational,
41 Meta,
42 Subsidiary,
43 Utility,
44 Last_ = Utility,
45};
46
47static constexpr std::size_t Category_enumSize = 6;
48
49enum class SourceLanguage : uint32_t {
50 C = 1U,
51 Fortran = 2U,
52 LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/Fortran)
53};
54
55static constexpr std::size_t SourceLanguage_enumSize = 2;
56
57enum class Directive {
58 ACCD_atomic,
59 First_ = ACCD_atomic,
60 ACCD_cache,
61 ACCD_data,
62 ACCD_declare,
63 ACCD_enter_data,
64 ACCD_exit_data,
65 ACCD_host_data,
66 ACCD_init,
67 ACCD_kernels,
68 ACCD_kernels_loop,
69 ACCD_loop,
70 ACCD_parallel,
71 ACCD_parallel_loop,
72 ACCD_routine,
73 ACCD_serial,
74 ACCD_serial_loop,
75 ACCD_set,
76 ACCD_shutdown,
77 ACCD_unknown,
78 ACCD_update,
79 ACCD_wait,
80 Last_ = ACCD_wait,
81};
82
83static constexpr std::size_t Directive_enumSize = 21;
84
85constexpr auto ACCD_atomic = Directive::ACCD_atomic;
86constexpr auto ACCD_cache = Directive::ACCD_cache;
87constexpr auto ACCD_data = Directive::ACCD_data;
88constexpr auto ACCD_declare = Directive::ACCD_declare;
89constexpr auto ACCD_enter_data = Directive::ACCD_enter_data;
90constexpr auto ACCD_exit_data = Directive::ACCD_exit_data;
91constexpr auto ACCD_host_data = Directive::ACCD_host_data;
92constexpr auto ACCD_init = Directive::ACCD_init;
93constexpr auto ACCD_kernels = Directive::ACCD_kernels;
94constexpr auto ACCD_kernels_loop = Directive::ACCD_kernels_loop;
95constexpr auto ACCD_loop = Directive::ACCD_loop;
96constexpr auto ACCD_parallel = Directive::ACCD_parallel;
97constexpr auto ACCD_parallel_loop = Directive::ACCD_parallel_loop;
98constexpr auto ACCD_routine = Directive::ACCD_routine;
99constexpr auto ACCD_serial = Directive::ACCD_serial;
100constexpr auto ACCD_serial_loop = Directive::ACCD_serial_loop;
101constexpr auto ACCD_set = Directive::ACCD_set;
102constexpr auto ACCD_shutdown = Directive::ACCD_shutdown;
103constexpr auto ACCD_unknown = Directive::ACCD_unknown;
104constexpr auto ACCD_update = Directive::ACCD_update;
105constexpr auto ACCD_wait = Directive::ACCD_wait;
106
107enum class Clause {
108 ACCC_async,
109 First_ = ACCC_async,
110 ACCC_attach,
111 ACCC_auto,
112 ACCC_bind,
113 ACCC_capture,
114 ACCC_collapse,
115 ACCC_copy,
116 ACCC_copyin,
117 ACCC_copyout,
118 ACCC_create,
119 ACCC_default,
120 ACCC_default_async,
121 ACCC_delete,
122 ACCC_detach,
123 ACCC_device,
124 ACCC_device_num,
125 ACCC_deviceptr,
126 ACCC_device_resident,
127 ACCC_device_type,
128 ACCC_finalize,
129 ACCC_firstprivate,
130 ACCC_gang,
131 ACCC_host,
132 ACCC_if,
133 ACCC_if_present,
134 ACCC_independent,
135 ACCC_link,
136 ACCC_no_create,
137 ACCC_nohost,
138 ACCC_num_gangs,
139 ACCC_num_workers,
140 ACCC_present,
141 ACCC_private,
142 ACCC_read,
143 ACCC_reduction,
144 ACCC_self,
145 ACCC_seq,
146 ACCC_shortloop,
147 ACCC_tile,
148 ACCC_unknown,
149 ACCC_use_device,
150 ACCC_vector,
151 ACCC_vector_length,
152 ACCC_wait,
153 ACCC_worker,
154 ACCC_write,
155 Last_ = ACCC_write,
156};
157
158static constexpr std::size_t Clause_enumSize = 46;
159
160constexpr auto ACCC_async = Clause::ACCC_async;
161constexpr auto ACCC_attach = Clause::ACCC_attach;
162constexpr auto ACCC_auto = Clause::ACCC_auto;
163constexpr auto ACCC_bind = Clause::ACCC_bind;
164constexpr auto ACCC_capture = Clause::ACCC_capture;
165constexpr auto ACCC_collapse = Clause::ACCC_collapse;
166constexpr auto ACCC_copy = Clause::ACCC_copy;
167constexpr auto ACCC_copyin = Clause::ACCC_copyin;
168constexpr auto ACCC_copyout = Clause::ACCC_copyout;
169constexpr auto ACCC_create = Clause::ACCC_create;
170constexpr auto ACCC_default = Clause::ACCC_default;
171constexpr auto ACCC_default_async = Clause::ACCC_default_async;
172constexpr auto ACCC_delete = Clause::ACCC_delete;
173constexpr auto ACCC_detach = Clause::ACCC_detach;
174constexpr auto ACCC_device = Clause::ACCC_device;
175constexpr auto ACCC_device_num = Clause::ACCC_device_num;
176constexpr auto ACCC_deviceptr = Clause::ACCC_deviceptr;
177constexpr auto ACCC_device_resident = Clause::ACCC_device_resident;
178constexpr auto ACCC_device_type = Clause::ACCC_device_type;
179constexpr auto ACCC_finalize = Clause::ACCC_finalize;
180constexpr auto ACCC_firstprivate = Clause::ACCC_firstprivate;
181constexpr auto ACCC_gang = Clause::ACCC_gang;
182constexpr auto ACCC_host = Clause::ACCC_host;
183constexpr auto ACCC_if = Clause::ACCC_if;
184constexpr auto ACCC_if_present = Clause::ACCC_if_present;
185constexpr auto ACCC_independent = Clause::ACCC_independent;
186constexpr auto ACCC_link = Clause::ACCC_link;
187constexpr auto ACCC_no_create = Clause::ACCC_no_create;
188constexpr auto ACCC_nohost = Clause::ACCC_nohost;
189constexpr auto ACCC_num_gangs = Clause::ACCC_num_gangs;
190constexpr auto ACCC_num_workers = Clause::ACCC_num_workers;
191constexpr auto ACCC_present = Clause::ACCC_present;
192constexpr auto ACCC_private = Clause::ACCC_private;
193constexpr auto ACCC_read = Clause::ACCC_read;
194constexpr auto ACCC_reduction = Clause::ACCC_reduction;
195constexpr auto ACCC_self = Clause::ACCC_self;
196constexpr auto ACCC_seq = Clause::ACCC_seq;
197constexpr auto ACCC_shortloop = Clause::ACCC_shortloop;
198constexpr auto ACCC_tile = Clause::ACCC_tile;
199constexpr auto ACCC_unknown = Clause::ACCC_unknown;
200constexpr auto ACCC_use_device = Clause::ACCC_use_device;
201constexpr auto ACCC_vector = Clause::ACCC_vector;
202constexpr auto ACCC_vector_length = Clause::ACCC_vector_length;
203constexpr auto ACCC_wait = Clause::ACCC_wait;
204constexpr auto ACCC_worker = Clause::ACCC_worker;
205constexpr auto ACCC_write = Clause::ACCC_write;
206
207enum class LoopModifier {
208 flattened,
209 First_ = flattened,
210 fused,
211 grid,
212 identity,
213 interchanged,
214 intratile,
215 offsets,
216 reversed,
217 split,
218 unrolled,
219 Last_ = unrolled,
220};
221
222static constexpr std::size_t LoopModifier_enumSize = 10;
223
224constexpr auto flattened = LoopModifier::flattened;
225constexpr auto fused = LoopModifier::fused;
226constexpr auto grid = LoopModifier::grid;
227constexpr auto identity = LoopModifier::identity;
228constexpr auto interchanged = LoopModifier::interchanged;
229constexpr auto intratile = LoopModifier::intratile;
230constexpr auto offsets = LoopModifier::offsets;
231constexpr auto reversed = LoopModifier::reversed;
232constexpr auto split = LoopModifier::split;
233constexpr auto unrolled = LoopModifier::unrolled;
234
235enum class DefaultValue {
236 ACC_Default_present=0,
237 ACC_Default_none=1,
238};
239
240constexpr auto ACC_Default_present = DefaultValue::ACC_Default_present;
241constexpr auto ACC_Default_none = DefaultValue::ACC_Default_none;
242
243// Constexpr functions.
244
245constexpr Association getDirectiveAssociation(Directive Dir) {
246 switch (Dir) {
247 case ACCD_atomic:
248 return Association::Block;
249 case ACCD_cache:
250 return Association::None;
251 case ACCD_data:
252 return Association::Block;
253 case ACCD_declare:
254 return Association::None;
255 case ACCD_enter_data:
256 return Association::None;
257 case ACCD_exit_data:
258 return Association::None;
259 case ACCD_host_data:
260 return Association::Block;
261 case ACCD_init:
262 return Association::None;
263 case ACCD_kernels:
264 return Association::Block;
265 case ACCD_kernels_loop:
266 return Association::LoopNest;
267 case ACCD_loop:
268 return Association::LoopNest;
269 case ACCD_parallel:
270 return Association::Block;
271 case ACCD_parallel_loop:
272 return Association::LoopNest;
273 case ACCD_routine:
274 return Association::Declaration;
275 case ACCD_serial:
276 return Association::Block;
277 case ACCD_serial_loop:
278 return Association::LoopNest;
279 case ACCD_set:
280 return Association::None;
281 case ACCD_shutdown:
282 return Association::None;
283 case ACCD_unknown:
284 return Association::None;
285 case ACCD_update:
286 return Association::None;
287 case ACCD_wait:
288 return Association::None;
289 } // switch (Dir)
290#if !defined(__clang__) && defined(__GNUC__) && __GNUC__ < 9
291 abort();
292#else
293 llvm_unreachable("Unexpected directive");
294#endif
295}
296
297constexpr Category getDirectiveCategory(Directive Dir) {
298 switch (Dir) {
299 case ACCD_atomic:
300 return Category::Executable;
301 case ACCD_cache:
302 return Category::Executable;
303 case ACCD_data:
304 return Category::Executable;
305 case ACCD_declare:
306 return Category::Declarative;
307 case ACCD_enter_data:
308 return Category::Executable;
309 case ACCD_exit_data:
310 return Category::Executable;
311 case ACCD_host_data:
312 return Category::Executable;
313 case ACCD_init:
314 return Category::Executable;
315 case ACCD_kernels:
316 return Category::Executable;
317 case ACCD_kernels_loop:
318 return Category::Executable;
319 case ACCD_loop:
320 return Category::Executable;
321 case ACCD_parallel:
322 return Category::Executable;
323 case ACCD_parallel_loop:
324 return Category::Executable;
325 case ACCD_routine:
326 return Category::Declarative;
327 case ACCD_serial:
328 return Category::Executable;
329 case ACCD_serial_loop:
330 return Category::Executable;
331 case ACCD_set:
332 return Category::Executable;
333 case ACCD_shutdown:
334 return Category::Executable;
335 case ACCD_unknown:
336 return Category::Utility;
337 case ACCD_update:
338 return Category::Executable;
339 case ACCD_wait:
340 return Category::Executable;
341 } // switch (Dir)
342#if !defined(__clang__) && defined(__GNUC__) && __GNUC__ < 9
343 abort();
344#else
345 llvm_unreachable("Unexpected directive");
346#endif
347}
348
349constexpr directive::Version getDirectivePureSince(Directive) {
350 return directive::Version(2147483647);
351}
352
353constexpr SourceLanguage getDirectiveLanguages(Directive D) {
354 switch (D) {
355 case ACCD_atomic:
356 return SourceLanguage::C | SourceLanguage::Fortran;
357 case ACCD_cache:
358 return SourceLanguage::C | SourceLanguage::Fortran;
359 case ACCD_data:
360 return SourceLanguage::C | SourceLanguage::Fortran;
361 case ACCD_declare:
362 return SourceLanguage::C | SourceLanguage::Fortran;
363 case ACCD_enter_data:
364 return SourceLanguage::C | SourceLanguage::Fortran;
365 case ACCD_exit_data:
366 return SourceLanguage::C | SourceLanguage::Fortran;
367 case ACCD_host_data:
368 return SourceLanguage::C | SourceLanguage::Fortran;
369 case ACCD_init:
370 return SourceLanguage::C | SourceLanguage::Fortran;
371 case ACCD_kernels:
372 return SourceLanguage::C | SourceLanguage::Fortran;
373 case ACCD_kernels_loop:
374 return SourceLanguage::C | SourceLanguage::Fortran;
375 case ACCD_loop:
376 return SourceLanguage::C | SourceLanguage::Fortran;
377 case ACCD_parallel:
378 return SourceLanguage::C | SourceLanguage::Fortran;
379 case ACCD_parallel_loop:
380 return SourceLanguage::C | SourceLanguage::Fortran;
381 case ACCD_routine:
382 return SourceLanguage::C | SourceLanguage::Fortran;
383 case ACCD_serial:
384 return SourceLanguage::C | SourceLanguage::Fortran;
385 case ACCD_serial_loop:
386 return SourceLanguage::C | SourceLanguage::Fortran;
387 case ACCD_set:
388 return SourceLanguage::C | SourceLanguage::Fortran;
389 case ACCD_shutdown:
390 return SourceLanguage::C | SourceLanguage::Fortran;
391 case ACCD_unknown:
392 return SourceLanguage::C | SourceLanguage::Fortran;
393 case ACCD_update:
394 return SourceLanguage::C | SourceLanguage::Fortran;
395 case ACCD_wait:
396 return SourceLanguage::C | SourceLanguage::Fortran;
397 } // switch(D)
398#if !defined(__clang__) && defined(__GNUC__) && __GNUC__ < 9
399 abort();
400#else
401 llvm_unreachable("Unexpected directive");
402#endif
403}
404
405// Enumeration helper functions
406LLVM_ABI std::pair<Directive, directive::VersionRange> getOpenACCDirectiveKindAndVersions(StringRef Str);
407inline Directive getOpenACCDirectiveKind(StringRef Str) {
408 return getOpenACCDirectiveKindAndVersions(Str).first;
409}
410
411LLVM_ABI StringRef getOpenACCDirectiveName(Directive D, directive::Version V = directive::Version(0));
412
413LLVM_ABI std::pair<Clause, directive::VersionRange> getOpenACCClauseKindAndVersions(StringRef Str);
414
415inline Clause getOpenACCClauseKind(StringRef Str) {
416 return getOpenACCClauseKindAndVersions(Str).first;
417}
418
419LLVM_ABI StringRef getOpenACCClauseName(Clause C, directive::Version V = directive::Version(0));
420
421/// Return true if \p C is a valid clause for \p D in version \p V.
422LLVM_ABI bool isAllowedClauseForDirective(Directive D, Clause C, directive::Version V);
423
424constexpr std::size_t getMaxLeafCount() { return 2; }
425LLVM_ABI bool isAllowedLoopModifier(Directive D, LoopModifier LM);
426LLVM_ABI StringRef getLoopModifierName(LoopModifier LM, directive::Version V = directive::Version(0));
427LLVM_ABI DefaultValue getDefaultValue(StringRef Str);
428LLVM_ABI StringRef getOpenACCDefaultValueName(DefaultValue x);
429
430} // namespace acc
431
432template <> struct enum_iteration_traits<acc::Association> {
433 static constexpr bool is_iterable = true;
434};
435
436template <> struct enum_iteration_traits<acc::Category> {
437 static constexpr bool is_iterable = true;
438};
439
440template <> struct enum_iteration_traits<acc::Directive> {
441 static constexpr bool is_iterable = true;
442};
443
444template <> struct enum_iteration_traits<acc::Clause> {
445 static constexpr bool is_iterable = true;
446};
447
448template <> struct enum_iteration_traits<acc::LoopModifier> {
449 static constexpr bool is_iterable = true;
450};
451
452} // namespace llvm
453
454#endif // LLVM_OpenACC_INC
455
456