clang  6.0.0svn
OpenMPKinds.h
Go to the documentation of this file.
1 //===--- OpenMPKinds.h - OpenMP enums ---------------------------*- C++ -*-===//
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 ///
10 /// \file
11 /// \brief Defines some OpenMP-specific enums and functions.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_BASIC_OPENMPKINDS_H
16 #define LLVM_CLANG_BASIC_OPENMPKINDS_H
17 
18 #include "llvm/ADT/StringRef.h"
19 
20 namespace clang {
21 
22 /// \brief OpenMP directives.
24 #define OPENMP_DIRECTIVE(Name) \
25  OMPD_##Name,
26 #define OPENMP_DIRECTIVE_EXT(Name, Str) \
27  OMPD_##Name,
28 #include "clang/Basic/OpenMPKinds.def"
30 };
31 
32 /// \brief OpenMP clauses.
34 #define OPENMP_CLAUSE(Name, Class) \
35  OMPC_##Name,
36 #include "clang/Basic/OpenMPKinds.def"
40 };
41 
42 /// \brief OpenMP attributes for 'default' clause.
44 #define OPENMP_DEFAULT_KIND(Name) \
45  OMPC_DEFAULT_##Name,
46 #include "clang/Basic/OpenMPKinds.def"
48 };
49 
50 /// \brief OpenMP attributes for 'proc_bind' clause.
52 #define OPENMP_PROC_BIND_KIND(Name) \
53  OMPC_PROC_BIND_##Name,
54 #include "clang/Basic/OpenMPKinds.def"
56 };
57 
58 /// \brief OpenMP attributes for 'schedule' clause.
60 #define OPENMP_SCHEDULE_KIND(Name) \
61  OMPC_SCHEDULE_##Name,
62 #include "clang/Basic/OpenMPKinds.def"
64 };
65 
66 /// \brief OpenMP modifiers for 'schedule' clause.
69 #define OPENMP_SCHEDULE_MODIFIER(Name) \
70  OMPC_SCHEDULE_MODIFIER_##Name,
71 #include "clang/Basic/OpenMPKinds.def"
73 };
74 
75 /// \brief OpenMP attributes for 'depend' clause.
77 #define OPENMP_DEPEND_KIND(Name) \
78  OMPC_DEPEND_##Name,
79 #include "clang/Basic/OpenMPKinds.def"
81 };
82 
83 /// \brief OpenMP attributes for 'linear' clause.
85 #define OPENMP_LINEAR_KIND(Name) \
86  OMPC_LINEAR_##Name,
87 #include "clang/Basic/OpenMPKinds.def"
89 };
90 
91 /// \brief OpenMP mapping kind for 'map' clause.
93 #define OPENMP_MAP_KIND(Name) \
94  OMPC_MAP_##Name,
95 #include "clang/Basic/OpenMPKinds.def"
97 };
98 
99 /// \brief OpenMP attributes for 'dist_schedule' clause.
101 #define OPENMP_DIST_SCHEDULE_KIND(Name) OMPC_DIST_SCHEDULE_##Name,
102 #include "clang/Basic/OpenMPKinds.def"
104 };
105 
106 /// \brief OpenMP attributes for 'defaultmap' clause.
108 #define OPENMP_DEFAULTMAP_KIND(Name) \
109  OMPC_DEFAULTMAP_##Name,
110 #include "clang/Basic/OpenMPKinds.def"
112 };
113 
114 /// \brief OpenMP modifiers for 'defaultmap' clause.
117 #define OPENMP_DEFAULTMAP_MODIFIER(Name) \
118  OMPC_DEFAULTMAP_MODIFIER_##Name,
119 #include "clang/Basic/OpenMPKinds.def"
121 };
122 
123 /// Scheduling data for loop-based OpenMP directives.
124 struct OpenMPScheduleTy final {
128 };
129 
130 OpenMPDirectiveKind getOpenMPDirectiveKind(llvm::StringRef Str);
132 
133 OpenMPClauseKind getOpenMPClauseKind(llvm::StringRef Str);
135 
136 unsigned getOpenMPSimpleClauseType(OpenMPClauseKind Kind, llvm::StringRef Str);
138 
140  OpenMPClauseKind CKind);
141 
142 /// \brief Checks if the specified directive is a directive with an associated
143 /// loop construct.
144 /// \param DKind Specified directive.
145 /// \return true - the directive is a loop-associated directive like 'omp simd'
146 /// or 'omp for' directive, otherwise - false.
148 
149 /// \brief Checks if the specified directive is a worksharing directive.
150 /// \param DKind Specified directive.
151 /// \return true - the directive is a worksharing directive like 'omp for',
152 /// otherwise - false.
154 
155 /// \brief Checks if the specified directive is a taskloop directive.
156 /// \param DKind Specified directive.
157 /// \return true - the directive is a worksharing directive like 'omp taskloop',
158 /// otherwise - false.
160 
161 /// \brief Checks if the specified directive is a parallel-kind directive.
162 /// \param DKind Specified directive.
163 /// \return true - the directive is a parallel-like directive like 'omp
164 /// parallel', otherwise - false.
166 
167 /// \brief Checks if the specified directive is a target code offload directive.
168 /// \param DKind Specified directive.
169 /// \return true - the directive is a target code offload directive like
170 /// 'omp target', 'omp target parallel', 'omp target xxx'
171 /// otherwise - false.
173 
174 /// \brief Checks if the specified directive is a target data offload directive.
175 /// \param DKind Specified directive.
176 /// \return true - the directive is a target data offload directive like
177 /// 'omp target data', 'omp target update', 'omp target enter data',
178 /// 'omp target exit data'
179 /// otherwise - false.
181 
182 /// Checks if the specified composite/combined directive constitutes a teams
183 /// directive in the outermost nest. For example
184 /// 'omp teams distribute' or 'omp teams distribute parallel for'.
185 /// \param DKind Specified directive.
186 /// \return true - the directive has teams on the outermost nest, otherwise -
187 /// false.
189 
190 /// Checks if the specified directive is a teams-kind directive. For example,
191 /// 'omp teams distribute' or 'omp target teams'.
192 /// \param DKind Specified directive.
193 /// \return true - the directive is a teams-like directive, otherwise - false.
195 
196 /// \brief Checks if the specified directive is a simd directive.
197 /// \param DKind Specified directive.
198 /// \return true - the directive is a simd directive like 'omp simd',
199 /// otherwise - false.
201 
202 /// \brief Checks if the specified directive is a distribute directive.
203 /// \param DKind Specified directive.
204 /// \return true - the directive is a distribute-directive like 'omp
205 /// distribute',
206 /// otherwise - false.
208 
209 /// Checks if the specified composite/combined directive constitutes a
210 /// distribute directive in the outermost nest. For example,
211 /// 'omp distribute parallel for' or 'omp distribute'.
212 /// \param DKind Specified directive.
213 /// \return true - the directive has distribute on the outermost nest.
214 /// otherwise - false.
216 
217 /// \brief Checks if the specified clause is one of private clauses like
218 /// 'private', 'firstprivate', 'reduction' etc..
219 /// \param Kind Clause kind.
220 /// \return true - the clause is a private clause, otherwise - false.
222 
223 /// \brief Checks if the specified clause is one of threadprivate clauses like
224 /// 'threadprivate', 'copyin' or 'copyprivate'.
225 /// \param Kind Clause kind.
226 /// \return true - the clause is a threadprivate clause, otherwise - false.
228 
229 /// Checks if the specified directive kind is one of tasking directives - task,
230 /// taskloop or taksloop simd.
232 
233 /// Checks if the specified directive kind is one of the composite or combined
234 /// directives that need loop bound sharing across loops outlined in nested
235 /// functions
237 
238 /// Return the captured regions of an OpenMP directive.
241  OpenMPDirectiveKind DKind);
242 }
243 
244 #endif
245 
Scheduling data for loop-based OpenMP directives.
Definition: OpenMPKinds.h:124
OpenMPDefaultmapClauseKind
OpenMP attributes for 'defaultmap' clause.
Definition: OpenMPKinds.h:107
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:1300
const char * getOpenMPSimpleClauseTypeName(OpenMPClauseKind Kind, unsigned Type)
bool isAllowedClauseForDirective(OpenMPDirectiveKind DKind, OpenMPClauseKind CKind)
OpenMPDefaultmapClauseModifier
OpenMP modifiers for 'defaultmap' clause.
Definition: OpenMPKinds.h:115
const char * getOpenMPClauseName(OpenMPClauseKind Kind)
Definition: OpenMPKinds.cpp:62
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:84
OpenMPDistScheduleClauseKind
OpenMP attributes for 'dist_schedule' clause.
Definition: OpenMPKinds.h:100
OpenMPScheduleClauseKind Schedule
Definition: OpenMPKinds.h:125
bool isOpenMPTeamsDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a teams-kind directive.
OpenMPScheduleClauseModifier M2
Definition: OpenMPKinds.h:127
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:33
bool isOpenMPTaskLoopDirective(OpenMPDirectiveKind DKind)
Checks if the specified directive is a taskloop directive.
OpenMPProcBindClauseKind
OpenMP attributes for 'proc_bind' clause.
Definition: OpenMPKinds.h:51
Kind
OpenMPDependClauseKind
OpenMP attributes for 'depend' clause.
Definition: OpenMPKinds.h:76
OpenMPDirectiveKind
OpenMP directives.
Definition: OpenMPKinds.h:23
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:67
Dataflow Directional Tag Classes.
OpenMPScheduleClauseModifier M1
Definition: OpenMPKinds.h:126
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'.
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:59
OpenMPDefaultClauseKind
OpenMP attributes for &#39;default&#39; clause.
Definition: OpenMPKinds.h:43
OpenMPDirectiveKind getOpenMPDirectiveKind(llvm::StringRef Str)
const char * getOpenMPDirectiveName(OpenMPDirectiveKind Kind)
Definition: OpenMPKinds.cpp:31
OpenMPMapClauseKind
OpenMP mapping kind for &#39;map&#39; clause.
Definition: OpenMPKinds.h:92
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...