1 //===--- OpenMPKinds.cpp - Token Kinds Support ----------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 /// \file
10 /// \brief This file implements the OpenMP enum and support functions.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Basic/OpenMPKinds.h"
15 #include "clang/Basic/IdentifierTable.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/ADT/StringSwitch.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include <cassert>
20 
21 using namespace clang;
22 
23 OpenMPDirectiveKind clang::getOpenMPDirectiveKind(StringRef Str) {
24   return llvm::StringSwitch<OpenMPDirectiveKind>(Str)
25 #define OPENMP_DIRECTIVE(Name) .Case(#Name, OMPD_##Name)
26 #define OPENMP_DIRECTIVE_EXT(Name, Str) .Case(Str, OMPD_##Name)
27 #include "clang/Basic/OpenMPKinds.def"
28       .Default(OMPD_unknown);
29 }
30 
31 const char *clang::getOpenMPDirectiveName(OpenMPDirectiveKind Kind) {
32   assert(Kind <= OMPD_unknown);
33   switch (Kind) {
34   case OMPD_unknown:
35     return "unknown";
36 #define OPENMP_DIRECTIVE(Name)                                                 \
37   case OMPD_##Name:                                                            \
38     return #Name;
39 #define OPENMP_DIRECTIVE_EXT(Name, Str)                                        \
40   case OMPD_##Name:                                                            \
41     return Str;
42 #include "clang/Basic/OpenMPKinds.def"
43     break;
44   }
45   llvm_unreachable("Invalid OpenMP directive kind");
46 }
47 
48 OpenMPClauseKind clang::getOpenMPClauseKind(StringRef Str) {
49   // 'flush' clause cannot be specified explicitly, because this is an implicit
50   // clause for 'flush' directive. If the 'flush' clause is explicitly specified
51   // the Parser should generate a warning about extra tokens at the end of the
52   // directive.
53   if (Str == "flush")
54     return OMPC_unknown;
55   return llvm::StringSwitch<OpenMPClauseKind>(Str)
56 #define OPENMP_CLAUSE(Name, Class) .Case(#Name, OMPC_##Name)
57 #include "clang/Basic/OpenMPKinds.def"
58       .Default(OMPC_unknown);
59 }
60 
61 const char *clang::getOpenMPClauseName(OpenMPClauseKind Kind) {
62   assert(Kind <= OMPC_unknown);
63   switch (Kind) {
64   case OMPC_unknown:
65     return "unknown";
66 #define OPENMP_CLAUSE(Name, Class)                                             \
67   case OMPC_##Name:                                                            \
68     return #Name;
69 #include "clang/Basic/OpenMPKinds.def"
70   case OMPC_threadprivate:
71     return "threadprivate or thread local";
72   }
73   llvm_unreachable("Invalid OpenMP clause kind");
74 }
75 
76 unsigned clang::getOpenMPSimpleClauseType(OpenMPClauseKind Kind,
77                                           StringRef Str) {
78   switch (Kind) {
79   case OMPC_default:
80     return llvm::StringSwitch<OpenMPDefaultClauseKind>(Str)
81 #define OPENMP_DEFAULT_KIND(Name) .Case(#Name, OMPC_DEFAULT_##Name)
82 #include "clang/Basic/OpenMPKinds.def"
83         .Default(OMPC_DEFAULT_unknown);
84   case OMPC_proc_bind:
85     return llvm::StringSwitch<OpenMPProcBindClauseKind>(Str)
86 #define OPENMP_PROC_BIND_KIND(Name) .Case(#Name, OMPC_PROC_BIND_##Name)
87 #include "clang/Basic/OpenMPKinds.def"
88         .Default(OMPC_PROC_BIND_unknown);
89   case OMPC_schedule:
90     return llvm::StringSwitch<OpenMPScheduleClauseKind>(Str)
91 #define OPENMP_SCHEDULE_KIND(Name) .Case(#Name, OMPC_SCHEDULE_##Name)
92 #include "clang/Basic/OpenMPKinds.def"
93         .Default(OMPC_SCHEDULE_unknown);
94   case OMPC_depend:
95     return llvm::StringSwitch<OpenMPDependClauseKind>(Str)
96 #define OPENMP_DEPEND_KIND(Name) .Case(#Name, OMPC_DEPEND_##Name)
97 #include "clang/Basic/OpenMPKinds.def"
98         .Default(OMPC_DEPEND_unknown);
99   case OMPC_linear:
100     return llvm::StringSwitch<OpenMPLinearClauseKind>(Str)
101 #define OPENMP_LINEAR_KIND(Name) .Case(#Name, OMPC_LINEAR_##Name)
102 #include "clang/Basic/OpenMPKinds.def"
103         .Default(OMPC_LINEAR_unknown);
104   case OMPC_map:
105     return llvm::StringSwitch<OpenMPMapClauseKind>(Str)
106 #define OPENMP_MAP_KIND(Name) .Case(#Name, OMPC_MAP_##Name)
107 #include "clang/Basic/OpenMPKinds.def"
108         .Default(OMPC_MAP_unknown);
109   case OMPC_unknown:
110   case OMPC_threadprivate:
111   case OMPC_if:
112   case OMPC_final:
113   case OMPC_num_threads:
114   case OMPC_safelen:
115   case OMPC_simdlen:
116   case OMPC_collapse:
117   case OMPC_private:
118   case OMPC_firstprivate:
119   case OMPC_lastprivate:
120   case OMPC_shared:
121   case OMPC_reduction:
122   case OMPC_aligned:
123   case OMPC_copyin:
124   case OMPC_copyprivate:
125   case OMPC_ordered:
126   case OMPC_nowait:
127   case OMPC_untied:
128   case OMPC_mergeable:
129   case OMPC_flush:
130   case OMPC_read:
131   case OMPC_write:
132   case OMPC_update:
133   case OMPC_capture:
134   case OMPC_seq_cst:
135   case OMPC_device:
136   case OMPC_threads:
137   case OMPC_simd:
138   case OMPC_num_teams:
139     break;
140   }
141   llvm_unreachable("Invalid OpenMP simple clause kind");
142 }
143 
144 const char *clang::getOpenMPSimpleClauseTypeName(OpenMPClauseKind Kind,
145                                                  unsigned Type) {
146   switch (Kind) {
147   case OMPC_default:
148     switch (Type) {
149     case OMPC_DEFAULT_unknown:
150       return "unknown";
151 #define OPENMP_DEFAULT_KIND(Name)                                              \
152   case OMPC_DEFAULT_##Name:                                                    \
153     return #Name;
154 #include "clang/Basic/OpenMPKinds.def"
155     }
156     llvm_unreachable("Invalid OpenMP 'default' clause type");
157   case OMPC_proc_bind:
158     switch (Type) {
159     case OMPC_PROC_BIND_unknown:
160       return "unknown";
161 #define OPENMP_PROC_BIND_KIND(Name)                                            \
162   case OMPC_PROC_BIND_##Name:                                                  \
163     return #Name;
164 #include "clang/Basic/OpenMPKinds.def"
165     }
166     llvm_unreachable("Invalid OpenMP 'proc_bind' clause type");
167   case OMPC_schedule:
168     switch (Type) {
169     case OMPC_SCHEDULE_unknown:
170       return "unknown";
171 #define OPENMP_SCHEDULE_KIND(Name)                                             \
172   case OMPC_SCHEDULE_##Name:                                                   \
173     return #Name;
174 #include "clang/Basic/OpenMPKinds.def"
175     }
176   case OMPC_depend:
177     switch (Type) {
178     case OMPC_DEPEND_unknown:
179       return "unknown";
180 #define OPENMP_DEPEND_KIND(Name)                                             \
181   case OMPC_DEPEND_##Name:                                                   \
182     return #Name;
183 #include "clang/Basic/OpenMPKinds.def"
184     }
185     llvm_unreachable("Invalid OpenMP 'schedule' clause type");
186   case OMPC_linear:
187     switch (Type) {
188     case OMPC_LINEAR_unknown:
189       return "unknown";
190 #define OPENMP_LINEAR_KIND(Name)                                             \
191   case OMPC_LINEAR_##Name:                                                   \
192     return #Name;
193 #include "clang/Basic/OpenMPKinds.def"
194     }
195     llvm_unreachable("Invalid OpenMP 'linear' clause type");
196   case OMPC_map:
197     switch (Type) {
198     case OMPC_MAP_unknown:
199       return "unknown";
200 #define OPENMP_MAP_KIND(Name)                                                \
201   case OMPC_MAP_##Name:                                                      \
202     return #Name;
203 #include "clang/Basic/OpenMPKinds.def"
204     default:
205       break;
206     }
207     llvm_unreachable("Invalid OpenMP 'map' clause type");
208   case OMPC_unknown:
209   case OMPC_threadprivate:
210   case OMPC_if:
211   case OMPC_final:
212   case OMPC_num_threads:
213   case OMPC_safelen:
214   case OMPC_simdlen:
215   case OMPC_collapse:
216   case OMPC_private:
217   case OMPC_firstprivate:
218   case OMPC_lastprivate:
219   case OMPC_shared:
220   case OMPC_reduction:
221   case OMPC_aligned:
222   case OMPC_copyin:
223   case OMPC_copyprivate:
224   case OMPC_ordered:
225   case OMPC_nowait:
226   case OMPC_untied:
227   case OMPC_mergeable:
228   case OMPC_flush:
229   case OMPC_read:
230   case OMPC_write:
231   case OMPC_update:
232   case OMPC_capture:
233   case OMPC_seq_cst:
234   case OMPC_device:
235   case OMPC_threads:
236   case OMPC_simd:
237   case OMPC_num_teams:
238     break;
239   }
240   llvm_unreachable("Invalid OpenMP simple clause kind");
241 }
242 
243 bool clang::isAllowedClauseForDirective(OpenMPDirectiveKind DKind,
244                                         OpenMPClauseKind CKind) {
245   assert(DKind <= OMPD_unknown);
246   assert(CKind <= OMPC_unknown);
247   switch (DKind) {
248   case OMPD_parallel:
249     switch (CKind) {
250 #define OPENMP_PARALLEL_CLAUSE(Name)                                           \
251   case OMPC_##Name:                                                            \
252     return true;
253 #include "clang/Basic/OpenMPKinds.def"
254     default:
255       break;
256     }
257     break;
258   case OMPD_simd:
259     switch (CKind) {
260 #define OPENMP_SIMD_CLAUSE(Name)                                               \
261   case OMPC_##Name:                                                            \
262     return true;
263 #include "clang/Basic/OpenMPKinds.def"
264     default:
265       break;
266     }
267     break;
268   case OMPD_for:
269     switch (CKind) {
270 #define OPENMP_FOR_CLAUSE(Name)                                                \
271   case OMPC_##Name:                                                            \
272     return true;
273 #include "clang/Basic/OpenMPKinds.def"
274     default:
275       break;
276     }
277     break;
278   case OMPD_for_simd:
279     switch (CKind) {
280 #define OPENMP_FOR_SIMD_CLAUSE(Name)                                           \
281   case OMPC_##Name:                                                            \
282     return true;
283 #include "clang/Basic/OpenMPKinds.def"
284     default:
285       break;
286     }
287     break;
288   case OMPD_sections:
289     switch (CKind) {
290 #define OPENMP_SECTIONS_CLAUSE(Name)                                           \
291   case OMPC_##Name:                                                            \
292     return true;
293 #include "clang/Basic/OpenMPKinds.def"
294     default:
295       break;
296     }
297     break;
298   case OMPD_single:
299     switch (CKind) {
300 #define OPENMP_SINGLE_CLAUSE(Name)                                             \
301   case OMPC_##Name:                                                            \
302     return true;
303 #include "clang/Basic/OpenMPKinds.def"
304     default:
305       break;
306     }
307     break;
308   case OMPD_parallel_for:
309     switch (CKind) {
310 #define OPENMP_PARALLEL_FOR_CLAUSE(Name)                                       \
311   case OMPC_##Name:                                                            \
312     return true;
313 #include "clang/Basic/OpenMPKinds.def"
314     default:
315       break;
316     }
317     break;
318   case OMPD_parallel_for_simd:
319     switch (CKind) {
320 #define OPENMP_PARALLEL_FOR_SIMD_CLAUSE(Name)                                  \
321   case OMPC_##Name:                                                            \
322     return true;
323 #include "clang/Basic/OpenMPKinds.def"
324     default:
325       break;
326     }
327     break;
328   case OMPD_parallel_sections:
329     switch (CKind) {
330 #define OPENMP_PARALLEL_SECTIONS_CLAUSE(Name)                                  \
331   case OMPC_##Name:                                                            \
332     return true;
333 #include "clang/Basic/OpenMPKinds.def"
334     default:
335       break;
336     }
337     break;
338   case OMPD_task:
339     switch (CKind) {
340 #define OPENMP_TASK_CLAUSE(Name)                                               \
341   case OMPC_##Name:                                                            \
342     return true;
343 #include "clang/Basic/OpenMPKinds.def"
344     default:
345       break;
346     }
347     break;
348   case OMPD_flush:
349     return CKind == OMPC_flush;
350     break;
351   case OMPD_atomic:
352     switch (CKind) {
353 #define OPENMP_ATOMIC_CLAUSE(Name)                                             \
354   case OMPC_##Name:                                                            \
355     return true;
356 #include "clang/Basic/OpenMPKinds.def"
357     default:
358       break;
359     }
360     break;
361   case OMPD_target:
362     switch (CKind) {
363 #define OPENMP_TARGET_CLAUSE(Name)                                             \
364   case OMPC_##Name:                                                            \
365     return true;
366 #include "clang/Basic/OpenMPKinds.def"
367     default:
368       break;
369     }
370     break;
371   case OMPD_target_data:
372     switch (CKind) {
373 #define OPENMP_TARGET_DATA_CLAUSE(Name)                                        \
374   case OMPC_##Name:                                                            \
375     return true;
376 #include "clang/Basic/OpenMPKinds.def"
377     default:
378       break;
379     }
380     break;
381   case OMPD_teams:
382     switch (CKind) {
383 #define OPENMP_TEAMS_CLAUSE(Name)                                              \
384   case OMPC_##Name:                                                            \
385     return true;
386 #include "clang/Basic/OpenMPKinds.def"
387     default:
388       break;
389     }
390     break;
391   case OMPD_cancel:
392     switch (CKind) {
393 #define OPENMP_CANCEL_CLAUSE(Name)                                             \
394   case OMPC_##Name:                                                            \
395     return true;
396 #include "clang/Basic/OpenMPKinds.def"
397     default:
398       break;
399     }
400     break;
401   case OMPD_ordered:
402     switch (CKind) {
403 #define OPENMP_ORDERED_CLAUSE(Name)                                             \
404   case OMPC_##Name:                                                            \
405     return true;
406 #include "clang/Basic/OpenMPKinds.def"
407     default:
408       break;
409     }
410     break;
411   case OMPD_unknown:
412   case OMPD_threadprivate:
413   case OMPD_section:
414   case OMPD_master:
415   case OMPD_critical:
416   case OMPD_taskyield:
417   case OMPD_barrier:
418   case OMPD_taskwait:
419   case OMPD_taskgroup:
420   case OMPD_cancellation_point:
421     break;
422   }
423   return false;
424 }
425 
426 bool clang::isOpenMPLoopDirective(OpenMPDirectiveKind DKind) {
427   return DKind == OMPD_simd || DKind == OMPD_for || DKind == OMPD_for_simd ||
428          DKind == OMPD_parallel_for ||
429          DKind == OMPD_parallel_for_simd; // TODO add next directives.
430 }
431 
432 bool clang::isOpenMPWorksharingDirective(OpenMPDirectiveKind DKind) {
433   return DKind == OMPD_for || DKind == OMPD_for_simd ||
434          DKind == OMPD_sections || DKind == OMPD_section ||
435          DKind == OMPD_single || DKind == OMPD_parallel_for ||
436          DKind == OMPD_parallel_for_simd ||
437          DKind == OMPD_parallel_sections; // TODO add next directives.
438 }
439 
440 bool clang::isOpenMPParallelDirective(OpenMPDirectiveKind DKind) {
441   return DKind == OMPD_parallel || DKind == OMPD_parallel_for ||
442          DKind == OMPD_parallel_for_simd ||
443          DKind == OMPD_parallel_sections; // TODO add next directives.
444 }
445 
446 bool clang::isOpenMPTargetDirective(OpenMPDirectiveKind DKind) {
447   return DKind == OMPD_target; // TODO add next directives.
448 }
449 
450 bool clang::isOpenMPTeamsDirective(OpenMPDirectiveKind DKind) {
451   return DKind == OMPD_teams; // TODO add next directives.
452 }
453 
454 bool clang::isOpenMPSimdDirective(OpenMPDirectiveKind DKind) {
455   return DKind == OMPD_simd || DKind == OMPD_for_simd ||
456          DKind == OMPD_parallel_for_simd; // TODO add next directives.
457 }
458 
459 bool clang::isOpenMPPrivate(OpenMPClauseKind Kind) {
460   return Kind == OMPC_private || Kind == OMPC_firstprivate ||
461          Kind == OMPC_lastprivate || Kind == OMPC_linear ||
462          Kind == OMPC_reduction; // TODO add next clauses like 'reduction'.
463 }
464 
465 bool clang::isOpenMPThreadPrivate(OpenMPClauseKind Kind) {
466   return Kind == OMPC_threadprivate || Kind == OMPC_copyin;
467 }
468 
469