clang  9.0.0svn
OpenMPKinds.h
Go to the documentation of this file.
1 //===--- OpenMPKinds.h - OpenMP enums ---------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// Defines some OpenMP-specific enums and functions.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_BASIC_OPENMPKINDS_H
15 #define LLVM_CLANG_BASIC_OPENMPKINDS_H
16 
17 #include "llvm/ADT/StringRef.h"
18 
19 namespace clang {
20 
21 /// OpenMP directives.
23 #define OPENMP_DIRECTIVE(Name) \
24  OMPD_##Name,
25 #define OPENMP_DIRECTIVE_EXT(Name, Str) \
26  OMPD_##Name,
27 #include "clang/Basic/OpenMPKinds.def"
29 };
30 
31 /// OpenMP clauses.
33 #define OPENMP_CLAUSE(Name, Class) \
34  OMPC_##Name,
35 #include "clang/Basic/OpenMPKinds.def"
39 };
40 
41 /// OpenMP attributes for 'default' clause.
43 #define OPENMP_DEFAULT_KIND(Name) \
44  OMPC_DEFAULT_##Name,
45 #include "clang/Basic/OpenMPKinds.def"
47 };
48 
49 /// OpenMP attributes for 'proc_bind' clause.
51 #define OPENMP_PROC_BIND_KIND(Name) \
52  OMPC_PROC_BIND_##Name,
53 #include "clang/Basic/OpenMPKinds.def"
55 };
56 
57 /// OpenMP attributes for 'schedule' clause.
59 #define OPENMP_SCHEDULE_KIND(Name) \
60  OMPC_SCHEDULE_##Name,
61 #include "clang/Basic/OpenMPKinds.def"
63 };
64 
65 /// OpenMP modifiers for 'schedule' clause.
68 #define OPENMP_SCHEDULE_MODIFIER(Name) \
69  OMPC_SCHEDULE_MODIFIER_##Name,
70 #include "clang/Basic/OpenMPKinds.def"
72 };
73 
74 /// OpenMP attributes for 'depend' clause.
76 #define OPENMP_DEPEND_KIND(Name) \
77  OMPC_DEPEND_##Name,
78 #include "clang/Basic/OpenMPKinds.def"
80 };
81 
82 /// OpenMP attributes for 'linear' clause.
84 #define OPENMP_LINEAR_KIND(Name) \
85  OMPC_LINEAR_##Name,
86 #include "clang/Basic/OpenMPKinds.def"
88 };
89 
90 /// OpenMP mapping kind for 'map' clause.
92 #define OPENMP_MAP_KIND(Name) \
93  OMPC_MAP_##Name,
94 #include "clang/Basic/OpenMPKinds.def"
96 };
97 
98 /// OpenMP modifier kind for 'map' clause.
101 #define OPENMP_MAP_MODIFIER_KIND(Name) \
102  OMPC_MAP_MODIFIER_##Name,
103 #include "clang/Basic/OpenMPKinds.def"
105 };
106 
107 /// OpenMP modifier kind for 'to' clause.
109 #define OPENMP_TO_MODIFIER_KIND(Name) \
110  OMPC_TO_MODIFIER_##Name,
111 #include "clang/Basic/OpenMPKinds.def"
113 };
114 
115 /// OpenMP modifier kind for 'from' clause.
117 #define OPENMP_FROM_MODIFIER_KIND(Name) \
118  OMPC_FROM_MODIFIER_##Name,
119 #include "clang/Basic/OpenMPKinds.def"
121 };
122 
123 /// OpenMP attributes for 'dist_schedule' clause.
125 #define OPENMP_DIST_SCHEDULE_KIND(Name) OMPC_DIST_SCHEDULE_##Name,
126 #include "clang/Basic/OpenMPKinds.def"
128 };
129 
130 /// OpenMP attributes for 'defaultmap' clause.
132 #define OPENMP_DEFAULTMAP_KIND(Name) \
133  OMPC_DEFAULTMAP_##Name,
134 #include "clang/Basic/OpenMPKinds.def"
136 };
137 
138 /// OpenMP modifiers for 'defaultmap' clause.
141 #define OPENMP_DEFAULTMAP_MODIFIER(Name) \
142  OMPC_DEFAULTMAP_MODIFIER_##Name,
143 #include "clang/Basic/OpenMPKinds.def"
145 };
146 
147 /// OpenMP attributes for 'atomic_default_mem_order' clause.
149 #define OPENMP_ATOMIC_DEFAULT_MEM_ORDER_KIND(Name) \
150  OMPC_ATOMIC_DEFAULT_MEM_ORDER_##Name,
151 #include "clang/Basic/OpenMPKinds.def"
153 };
154 
155 /// Scheduling data for loop-based OpenMP directives.
156 struct OpenMPScheduleTy final {
160 };
161 
162 OpenMPDirectiveKind getOpenMPDirectiveKind(llvm::StringRef Str);
164 
165 OpenMPClauseKind getOpenMPClauseKind(llvm::StringRef Str);
167 
168 unsigned getOpenMPSimpleClauseType(OpenMPClauseKind Kind, llvm::StringRef Str);
170 
172  OpenMPClauseKind CKind);
173 
174 /// Checks if the specified directive is a directive with an associated
175 /// loop construct.
176 /// \param DKind Specified directive.
177 /// \return true - the directive is a loop-associated directive like 'omp simd'
178 /// or 'omp for' directive, otherwise - false.
180 
181 /// Checks if the specified directive is a worksharing directive.
182 /// \param DKind Specified directive.
183 /// \return true - the directive is a worksharing directive like 'omp for',
184 /// otherwise - false.
186 
187 /// Checks if the specified directive is a taskloop directive.
188 /// \param DKind Specified directive.
189 /// \return true - the directive is a worksharing directive like 'omp taskloop',
190 /// otherwise - false.
192 
193 /// Checks if the specified directive is a parallel-kind directive.
194 /// \param DKind Specified directive.
195 /// \return true - the directive is a parallel-like directive like 'omp
196 /// parallel', otherwise - false.
198 
199 /// Checks if the specified directive is a target code offload directive.
200 /// \param DKind Specified directive.
201 /// \return true - the directive is a target code offload directive like
202 /// 'omp target', 'omp target parallel', 'omp target xxx'
203 /// otherwise - false.
205 
206 /// Checks if the specified directive is a target data offload directive.
207 /// \param DKind Specified directive.
208 /// \return true - the directive is a target data offload directive like
209 /// 'omp target data', 'omp target update', 'omp target enter data',
210 /// 'omp target exit data'
211 /// otherwise - false.
213 
214 /// Checks if the specified composite/combined directive constitutes a teams
215 /// directive in the outermost nest. For example
216 /// 'omp teams distribute' or 'omp teams distribute parallel for'.
217 /// \param DKind Specified directive.
218 /// \return true - the directive has teams on the outermost nest, otherwise -
219 /// false.
221 
222 /// Checks if the specified directive is a teams-kind directive. For example,
223 /// 'omp teams distribute' or 'omp target teams'.
224 /// \param DKind Specified directive.
225 /// \return true - the directive is a teams-like directive, otherwise - false.
227 
228 /// Checks if the specified directive is a simd directive.
229 /// \param DKind Specified directive.
230 /// \return true - the directive is a simd directive like 'omp simd',
231 /// otherwise - false.
233 
234 /// Checks if the specified directive is a distribute directive.
235 /// \param DKind Specified directive.
236 /// \return true - the directive is a distribute-directive like 'omp
237 /// distribute',
238 /// otherwise - false.
240 
241 /// Checks if the specified composite/combined directive constitutes a
242 /// distribute directive in the outermost nest. For example,
243 /// 'omp distribute parallel for' or 'omp distribute'.
244 /// \param DKind Specified directive.
245 /// \return true - the directive has distribute on the outermost nest.
246 /// otherwise - false.
248 
249 /// Checks if the specified clause is one of private clauses like
250 /// 'private', 'firstprivate', 'reduction' etc..
251 /// \param Kind Clause kind.
252 /// \return true - the clause is a private clause, otherwise - false.
254 
255 /// Checks if the specified clause is one of threadprivate clauses like
256 /// 'threadprivate', 'copyin' or 'copyprivate'.
257 /// \param Kind Clause kind.
258 /// \return true - the clause is a threadprivate clause, otherwise - false.
260 
261 /// Checks if the specified directive kind is one of tasking directives - task,
262 /// taskloop or taksloop simd.
264 
265 /// Checks if the specified directive kind is one of the composite or combined
266 /// directives that need loop bound sharing across loops outlined in nested
267 /// functions
269 
270 /// Return the captured regions of an OpenMP directive.
273  OpenMPDirectiveKind DKind);
274 }
275 
276 #endif
277 
OpenMPFromModifierKind
OpenMP modifier kind for 'from' clause.
Definition: OpenMPKinds.h:116
Scheduling data for loop-based OpenMP directives.
Definition: OpenMPKinds.h:156
OpenMPDefaultmapClauseKind
OpenMP attributes for 'defaultmap' clause.
Definition: OpenMPKinds.h:131
bool isOpenMPNestingDistributeDirective(OpenMPDirectiveKind DKind)
Checks if the specified composite/combined directive constitutes a distribute directive in the outerm...
bool isOpenMPTargetDataManagementDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a target data offload directive.
The base class of the type hierarchy.
Definition: Type.h:1414
const char * getOpenMPSimpleClauseTypeName(OpenMPClauseKind Kind, unsigned Type)
bool isAllowedClauseForDirective(OpenMPDirectiveKind DKind, OpenMPClauseKind CKind)
OpenMPDefaultmapClauseModifier
OpenMP modifiers for 'defaultmap' clause.
Definition: OpenMPKinds.h:139
OpenMPMapModifierKind
OpenMP modifier kind for 'map' clause.
Definition: OpenMPKinds.h:99
const char * getOpenMPClauseName(OpenMPClauseKind Kind)
Definition: OpenMPKinds.cpp:61
bool isOpenMPTaskingDirective(OpenMPDirectiveKind Kind)
Checks if the specified directive kind is one of tasking directives - task, taskloop or taksloop simd...
OpenMPLinearClauseKind
OpenMP attributes for 'linear' clause.
Definition: OpenMPKinds.h:83
OpenMPDistScheduleClauseKind
OpenMP attributes for 'dist_schedule' clause.
Definition: OpenMPKinds.h:124
OpenMPScheduleClauseKind Schedule
Definition: OpenMPKinds.h:157
bool isOpenMPTeamsDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a teams-kind directive.
OpenMPScheduleClauseModifier M2
Definition: OpenMPKinds.h:159
OpenMPClauseKind getOpenMPClauseKind(llvm::StringRef Str)
bool isOpenMPTargetExecutionDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a target code offload directive.
bool isOpenMPWorksharingDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a worksharing directive.
bool isOpenMPPrivate(OpenMPClauseKind Kind)
Checks if the specified clause is one of private clauses like 'private', 'firstprivate', 'reduction' etc.
bool isOpenMPParallelDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a parallel-kind directive.
OpenMPClauseKind
OpenMP clauses.
Definition: OpenMPKinds.h:32
bool isOpenMPTaskLoopDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a taskloop directive.
OpenMPProcBindClauseKind
OpenMP attributes for 'proc_bind' clause.
Definition: OpenMPKinds.h:50
Kind
OpenMPDependClauseKind
OpenMP attributes for 'depend' clause.
Definition: OpenMPKinds.h:75
OpenMPDirectiveKind
OpenMP directives.
Definition: OpenMPKinds.h:22
bool isOpenMPLoopBoundSharingDirective(OpenMPDirectiveKind Kind)
Checks if the specified directive kind is one of the composite or combined directives that need loop ...
OpenMPScheduleClauseModifier
OpenMP modifiers for 'schedule' clause.
Definition: OpenMPKinds.h:66
Dataflow Directional Tag Classes.
OpenMPAtomicDefaultMemOrderClauseKind
OpenMP attributes for 'atomic_default_mem_order' clause.
Definition: OpenMPKinds.h:148
OpenMPScheduleClauseModifier M1
Definition: OpenMPKinds.h:158
bool isOpenMPSimdDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a simd directive.
bool isOpenMPThreadPrivate(OpenMPClauseKind Kind)
Checks if the specified clause is one of threadprivate clauses like 'threadprivate', 'copyin' or 'copyprivate'.
OpenMPToModifierKind
OpenMP modifier kind for 'to' clause.
Definition: OpenMPKinds.h:108
void getOpenMPCaptureRegions(llvm::SmallVectorImpl< OpenMPDirectiveKind > &CaptureRegions, OpenMPDirectiveKind DKind)
Return the captured regions of an OpenMP directive.
unsigned getOpenMPSimpleClauseType(OpenMPClauseKind Kind, llvm::StringRef Str)
bool isOpenMPDistributeDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a distribute directive.
OpenMPScheduleClauseKind
OpenMP attributes for &#39;schedule&#39; clause.
Definition: OpenMPKinds.h:58
OpenMPDefaultClauseKind
OpenMP attributes for &#39;default&#39; clause.
Definition: OpenMPKinds.h:42
OpenMPDirectiveKind getOpenMPDirectiveKind(llvm::StringRef Str)
const char * getOpenMPDirectiveName(OpenMPDirectiveKind Kind)
Definition: OpenMPKinds.cpp:30
OpenMPMapClauseKind
OpenMP mapping kind for &#39;map&#39; clause.
Definition: OpenMPKinds.h:91
bool isOpenMPLoopDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a directive with an associated loop construct.
bool isOpenMPNestingTeamsDirective(OpenMPDirectiveKind DKind)
Checks if the specified composite/combined directive constitutes a teams directive in the outermost n...