FLANG
ClauseProcessor.h
1//===-- Lower/OpenMP/ClauseProcessor.h --------------------------*- 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// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
10//
11//===----------------------------------------------------------------------===//
12#ifndef FORTRAN_LOWER_CLAUSEPROCESSOR_H
13#define FORTRAN_LOWER_CLAUSEPROCESSOR_H
14
15#include "ClauseFinder.h"
16#include "Utils.h"
17#include "flang/Lower/AbstractConverter.h"
18#include "flang/Lower/Bridge.h"
19#include "flang/Lower/DirectivesCommon.h"
20#include "flang/Lower/OpenMP/Clauses.h"
21#include "flang/Lower/Support/ReductionProcessor.h"
22#include "flang/Optimizer/Builder/Todo.h"
23#include "flang/Parser/char-block.h"
24#include "mlir/Dialect/OpenMP/OpenMPDialect.h"
25
26namespace fir {
27class FirOpBuilder;
28} // namespace fir
29
30namespace Fortran {
31namespace lower {
32namespace omp {
33
34// Container type for tracking user specified Defaultmaps for a target region
35using DefaultMapsTy = std::map<clause::Defaultmap::VariableCategory,
36 clause::Defaultmap::ImplicitBehavior>;
37
52class ClauseProcessor {
53public:
54 ClauseProcessor(lower::AbstractConverter &converter,
55 semantics::SemanticsContext &semaCtx,
56 const List<Clause> &clauses)
57 : converter(converter), semaCtx(semaCtx), clauses(clauses) {}
58
59 // 'Unique' clauses: They can appear at most once in the clause list.
60 bool processBare(mlir::omp::BareClauseOps &result) const;
61 bool processBind(mlir::omp::BindClauseOps &result) const;
62 bool processCancelDirectiveName(
63 mlir::omp::CancelDirectiveNameClauseOps &result) const;
64 bool
65 processCollapse(mlir::Location currentLocation, lower::pft::Evaluation &eval,
66 mlir::omp::LoopRelatedClauseOps &loopResult,
67 mlir::omp::CollapseClauseOps &collapseResult,
68 llvm::SmallVectorImpl<const semantics::Symbol *> &iv) const;
69 bool processSizes(StatementContext &stmtCtx,
70 mlir::omp::SizesClauseOps &result) const;
71 bool processLooprange(StatementContext &stmtCtx,
72 mlir::omp::LooprangeClauseOps &result,
73 int64_t &count) const;
74 bool processDevice(lower::StatementContext &stmtCtx,
75 mlir::omp::DeviceClauseOps &result) const;
76 bool processDeviceType(mlir::omp::DeviceTypeClauseOps &result) const;
77 bool processDistSchedule(lower::StatementContext &stmtCtx,
78 mlir::omp::DistScheduleClauseOps &result) const;
79 bool processExclusive(mlir::Location currentLocation,
80 mlir::omp::ExclusiveClauseOps &result) const;
81 bool processFilter(lower::StatementContext &stmtCtx,
82 mlir::omp::FilterClauseOps &result) const;
83 bool processFinal(lower::StatementContext &stmtCtx,
84 mlir::omp::FinalClauseOps &result) const;
85 bool processGrainsize(lower::StatementContext &stmtCtx,
86 mlir::omp::GrainsizeClauseOps &result) const;
87 bool processHasDeviceAddr(
88 lower::StatementContext &stmtCtx,
89 mlir::omp::HasDeviceAddrClauseOps &result,
90 llvm::SmallVectorImpl<const semantics::Symbol *> &hasDeviceSyms) const;
91 bool processHint(mlir::omp::HintClauseOps &result) const;
92 bool processInbranch(mlir::omp::InbranchClauseOps &result) const;
93 bool processInclusive(mlir::Location currentLocation,
94 mlir::omp::InclusiveClauseOps &result) const;
95 bool processInitializer(
96 lower::SymMap &symMap,
97 ReductionProcessor::GenInitValueCBTy &genInitValueCB) const;
98 bool processMergeable(mlir::omp::MergeableClauseOps &result) const;
99 bool processNogroup(mlir::omp::NogroupClauseOps &result) const;
100 bool processNotinbranch(mlir::omp::NotinbranchClauseOps &result) const;
101 bool processNowait(mlir::omp::NowaitClauseOps &result) const;
102 bool processNumTasks(lower::StatementContext &stmtCtx,
103 mlir::omp::NumTasksClauseOps &result) const;
104 bool processNumTeams(lower::StatementContext &stmtCtx,
105 mlir::omp::NumTeamsClauseOps &result) const;
106 bool processNumThreads(lower::StatementContext &stmtCtx,
107 mlir::omp::NumThreadsClauseOps &result) const;
108 bool processOrder(mlir::omp::OrderClauseOps &result) const;
109 bool processOrdered(mlir::omp::OrderedClauseOps &result) const;
110 bool processPriority(lower::StatementContext &stmtCtx,
111 mlir::omp::PriorityClauseOps &result) const;
112 bool processProcBind(mlir::omp::ProcBindClauseOps &result) const;
113 bool processTileSizes(lower::pft::Evaluation &eval,
114 mlir::omp::LoopNestOperands &result) const;
115 bool processSafelen(mlir::omp::SafelenClauseOps &result) const;
116 bool processSchedule(lower::StatementContext &stmtCtx,
117 mlir::omp::ScheduleClauseOps &result) const;
118 bool processSimdlen(mlir::omp::SimdlenClauseOps &result) const;
119 bool processSimd(mlir::omp::OrderedRegionOperands &result) const;
120 bool processThreadLimit(lower::StatementContext &stmtCtx,
121 mlir::omp::ThreadLimitClauseOps &result) const;
122 bool processUntied(mlir::omp::UntiedClauseOps &result) const;
123
124 bool processDetach(mlir::omp::DetachClauseOps &result) const;
125 // 'Repeatable' clauses: They can appear multiple times in the clause list.
126 bool processAffinity(mlir::omp::AffinityClauseOps &result) const;
127 bool processAligned(mlir::omp::AlignedClauseOps &result) const;
128 bool processAllocate(mlir::omp::AllocateClauseOps &result) const;
129 bool processCopyin() const;
130 bool processCopyprivate(mlir::Location currentLocation,
131 mlir::omp::CopyprivateClauseOps &result) const;
132 bool processDefaultMap(lower::StatementContext &stmtCtx,
133 DefaultMapsTy &result) const;
134 bool processDepend(lower::SymMap &symMap, lower::StatementContext &stmtCtx,
135 mlir::omp::DependClauseOps &result) const;
136 bool
137 processEnter(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
138 bool processIf(omp::clause::If::DirectiveNameModifier directiveName,
139 mlir::omp::IfClauseOps &result) const;
140 bool processInReduction(
141 mlir::Location currentLocation, mlir::omp::InReductionClauseOps &result,
142 llvm::SmallVectorImpl<const semantics::Symbol *> &outReductionSyms) const;
143 bool processIsDevicePtr(
144 lower::StatementContext &stmtCtx, mlir::omp::IsDevicePtrClauseOps &result,
145 llvm::SmallVectorImpl<const semantics::Symbol *> &isDeviceSyms) const;
146 bool processLinear(mlir::omp::LinearClauseOps &result,
147 bool isDeclareSimd = false) const;
148 bool
149 processLink(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
150
151 // This method is used to process a map clause.
152 // The optional parameter mapSyms is used to store the original Fortran symbol
153 // for the map operands. It may be used later on to create the block_arguments
154 // for some of the directives that require it.
155 bool processMap(mlir::Location currentLocation,
156 lower::StatementContext &stmtCtx,
157 mlir::omp::MapClauseOps &result,
158 llvm::omp::Directive directive = llvm::omp::OMPD_unknown,
159 llvm::SmallVectorImpl<const semantics::Symbol *> *mapSyms =
160 nullptr) const;
161 bool processMotionClauses(lower::StatementContext &stmtCtx,
162 mlir::omp::MapClauseOps &result);
163 bool processNontemporal(mlir::omp::NontemporalClauseOps &result) const;
164 bool processReduction(
165 mlir::Location currentLocation, mlir::omp::ReductionClauseOps &result,
166 llvm::SmallVectorImpl<const semantics::Symbol *> &reductionSyms) const;
167 bool processTaskReduction(
168 mlir::Location currentLocation, mlir::omp::TaskReductionClauseOps &result,
169 llvm::SmallVectorImpl<const semantics::Symbol *> &outReductionSyms) const;
170 bool processTo(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
171 bool processUseDeviceAddr(
172 lower::StatementContext &stmtCtx,
173 mlir::omp::UseDeviceAddrClauseOps &result,
174 llvm::SmallVectorImpl<const semantics::Symbol *> &useDeviceSyms) const;
175 bool processUseDevicePtr(
176 lower::StatementContext &stmtCtx,
177 mlir::omp::UseDevicePtrClauseOps &result,
178 llvm::SmallVectorImpl<const semantics::Symbol *> &useDeviceSyms) const;
179 bool processUniform(mlir::omp::UniformClauseOps &result) const;
180
181 // Call this method for these clauses that should be supported but are not
182 // implemented yet. It triggers a compilation error if any of the given
183 // clauses is found.
184 template <typename... Ts>
185 void processTODO(mlir::Location currentLocation,
186 llvm::omp::Directive directive) const;
187
188private:
189 using ClauseIterator = List<Clause>::const_iterator;
190
194 template <typename T>
195 const T *findUniqueClause(const parser::CharBlock **source = nullptr) const;
196
199 template <typename T>
200 bool findRepeatableClause(
201 std::function<void(const T &, const parser::CharBlock &source)>
202 callbackFn) const;
203
205 template <typename T>
206 bool markClauseOccurrence(mlir::UnitAttr &result) const;
207
208 void processMapObjects(
209 lower::StatementContext &stmtCtx, mlir::Location clauseLocation,
210 const omp::ObjectList &objects, mlir::omp::ClauseMapFlags mapTypeBits,
211 std::map<Object, OmpMapParentAndMemberData> &parentMemberIndices,
212 llvm::SmallVectorImpl<mlir::Value> &mapVars,
213 llvm::SmallVectorImpl<const semantics::Symbol *> &mapSyms,
214 llvm::StringRef mapperIdNameRef = "",
215 bool isMotionModifier = false) const;
216
217 lower::AbstractConverter &converter;
218 semantics::SemanticsContext &semaCtx;
219 List<Clause> clauses;
220};
221
222template <typename... Ts>
223void ClauseProcessor::processTODO(mlir::Location currentLocation,
224 llvm::omp::Directive directive) const {
225 auto checkUnhandledClause = [&](llvm::omp::Clause id, const auto *x) {
226 if (!x)
227 return;
228 unsigned version = semaCtx.langOptions().OpenMPVersion;
229 bool isSimdDirective = llvm::omp::getOpenMPDirectiveName(directive, version)
230 .upper()
231 .find("SIMD") != llvm::StringRef::npos;
232 if (!semaCtx.langOptions().OpenMPSimd || isSimdDirective)
233 TODO(currentLocation,
234 "Unhandled clause " + llvm::omp::getOpenMPClauseName(id).upper() +
235 " in " +
236 llvm::omp::getOpenMPDirectiveName(directive, version).upper() +
237 " construct");
238 };
239
240 for (ClauseIterator it = clauses.begin(); it != clauses.end(); ++it)
241 (checkUnhandledClause(it->id, std::get_if<Ts>(&it->u)), ...);
242}
243
244template <typename T>
245const T *
246ClauseProcessor::findUniqueClause(const parser::CharBlock **source) const {
247 return ClauseFinder::findUniqueClause<T>(clauses, source);
248}
249
250template <typename T>
251bool ClauseProcessor::findRepeatableClause(
252 std::function<void(const T &, const parser::CharBlock &source)> callbackFn)
253 const {
254 return ClauseFinder::findRepeatableClause<T>(clauses, callbackFn);
255}
256
257template <typename T>
258bool ClauseProcessor::markClauseOccurrence(mlir::UnitAttr &result) const {
259 if (findUniqueClause<T>()) {
260 result = converter.getFirOpBuilder().getUnitAttr();
261 return true;
262 }
263 return false;
264}
265
266} // namespace omp
267} // namespace lower
268} // namespace Fortran
269
270#endif // FORTRAN_LOWER_CLAUSEPROCESSOR_H
Fortran::lower::AbstractConverter
Definition AbstractConverter.h:87
Fortran::lower::StatementContext
Definition StatementContext.h:46
Fortran::lower::SymMap
Definition SymbolMap.h:182
Fortran::lower::omp::ClauseFinder::findRepeatableClause
static bool findRepeatableClause(const List< Clause > &clauses, std::function< void(const T &, const parser::CharBlock &source)> callbackFn)
Definition ClauseFinder.h:54
Fortran::lower::omp::ClauseFinder::findUniqueClause
static const T * findUniqueClause(const List< Clause > &clauses, const parser::CharBlock **source=nullptr)
Definition ClauseFinder.h:40
Fortran::parser::CharBlock
Definition char-block.h:28
Fortran::semantics::SemanticsContext
Definition semantics.h:67
fir::FirOpBuilder
Definition FIRBuilder.h:56
Fortran::lower
Definition ParserActions.h:24
Fortran
Definition bit-population-count.h:20
fir
Definition AbstractConverter.h:37
Fortran::lower::pft::Evaluation
Definition PFTBuilder.h:221
Generated on for FLANG by doxygen 1.14.0