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/Optimizer/Builder/Todo.h"
22#include "flang/Parser/dump-parse-tree.h"
23#include "flang/Parser/parse-tree.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 processDevice(lower::StatementContext &stmtCtx,
72 mlir::omp::DeviceClauseOps &result) const;
73 bool processDeviceType(mlir::omp::DeviceTypeClauseOps &result) const;
74 bool processDistSchedule(lower::StatementContext &stmtCtx,
75 mlir::omp::DistScheduleClauseOps &result) const;
76 bool processExclusive(mlir::Location currentLocation,
77 mlir::omp::ExclusiveClauseOps &result) const;
78 bool processFilter(lower::StatementContext &stmtCtx,
79 mlir::omp::FilterClauseOps &result) const;
80 bool processFinal(lower::StatementContext &stmtCtx,
81 mlir::omp::FinalClauseOps &result) const;
82 bool processGrainsize(lower::StatementContext &stmtCtx,
83 mlir::omp::GrainsizeClauseOps &result) const;
84 bool processHasDeviceAddr(
85 lower::StatementContext &stmtCtx,
86 mlir::omp::HasDeviceAddrClauseOps &result,
87 llvm::SmallVectorImpl<const semantics::Symbol *> &hasDeviceSyms) const;
88 bool processHint(mlir::omp::HintClauseOps &result) const;
89 bool processInclusive(mlir::Location currentLocation,
90 mlir::omp::InclusiveClauseOps &result) const;
91 bool processMergeable(mlir::omp::MergeableClauseOps &result) const;
92 bool processNogroup(mlir::omp::NogroupClauseOps &result) const;
93 bool processNowait(mlir::omp::NowaitClauseOps &result) const;
94 bool processNumTasks(lower::StatementContext &stmtCtx,
95 mlir::omp::NumTasksClauseOps &result) const;
96 bool processNumTeams(lower::StatementContext &stmtCtx,
97 mlir::omp::NumTeamsClauseOps &result) const;
98 bool processNumThreads(lower::StatementContext &stmtCtx,
99 mlir::omp::NumThreadsClauseOps &result) const;
100 bool processOrder(mlir::omp::OrderClauseOps &result) const;
101 bool processOrdered(mlir::omp::OrderedClauseOps &result) const;
102 bool processPriority(lower::StatementContext &stmtCtx,
103 mlir::omp::PriorityClauseOps &result) const;
104 bool processProcBind(mlir::omp::ProcBindClauseOps &result) const;
105 bool processTileSizes(lower::pft::Evaluation &eval,
106 mlir::omp::LoopNestOperands &result) const;
107 bool processSafelen(mlir::omp::SafelenClauseOps &result) const;
108 bool processSchedule(lower::StatementContext &stmtCtx,
109 mlir::omp::ScheduleClauseOps &result) const;
110 bool processSimdlen(mlir::omp::SimdlenClauseOps &result) const;
111 bool processThreadLimit(lower::StatementContext &stmtCtx,
112 mlir::omp::ThreadLimitClauseOps &result) const;
113 bool processUntied(mlir::omp::UntiedClauseOps &result) const;
114
115 bool processDetach(mlir::omp::DetachClauseOps &result) const;
116 // 'Repeatable' clauses: They can appear multiple times in the clause list.
117 bool processAligned(mlir::omp::AlignedClauseOps &result) const;
118 bool processAllocate(mlir::omp::AllocateClauseOps &result) const;
119 bool processCopyin() const;
120 bool processCopyprivate(mlir::Location currentLocation,
121 mlir::omp::CopyprivateClauseOps &result) const;
122 bool processDefaultMap(lower::StatementContext &stmtCtx,
123 DefaultMapsTy &result) const;
124 bool processDepend(lower::SymMap &symMap, lower::StatementContext &stmtCtx,
125 mlir::omp::DependClauseOps &result) const;
126 bool
127 processEnter(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
128 bool processIf(omp::clause::If::DirectiveNameModifier directiveName,
129 mlir::omp::IfClauseOps &result) const;
130 bool processInReduction(
131 mlir::Location currentLocation, mlir::omp::InReductionClauseOps &result,
132 llvm::SmallVectorImpl<const semantics::Symbol *> &outReductionSyms) const;
133 bool processIsDevicePtr(
134 mlir::omp::IsDevicePtrClauseOps &result,
135 llvm::SmallVectorImpl<const semantics::Symbol *> &isDeviceSyms) const;
136 bool processLinear(mlir::omp::LinearClauseOps &result) const;
137 bool
138 processLink(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
139
140 // This method is used to process a map clause.
141 // The optional parameter mapSyms is used to store the original Fortran symbol
142 // for the map operands. It may be used later on to create the block_arguments
143 // for some of the directives that require it.
144 bool processMap(mlir::Location currentLocation,
145 lower::StatementContext &stmtCtx,
146 mlir::omp::MapClauseOps &result,
147 llvm::omp::Directive directive = llvm::omp::OMPD_unknown,
148 llvm::SmallVectorImpl<const semantics::Symbol *> *mapSyms =
149 nullptr) const;
150 bool processMotionClauses(lower::StatementContext &stmtCtx,
151 mlir::omp::MapClauseOps &result);
152 bool processNontemporal(mlir::omp::NontemporalClauseOps &result) const;
153 bool processReduction(
154 mlir::Location currentLocation, mlir::omp::ReductionClauseOps &result,
155 llvm::SmallVectorImpl<const semantics::Symbol *> &reductionSyms) const;
156 bool processTaskReduction(
157 mlir::Location currentLocation, mlir::omp::TaskReductionClauseOps &result,
158 llvm::SmallVectorImpl<const semantics::Symbol *> &outReductionSyms) const;
159 bool processTo(llvm::SmallVectorImpl<DeclareTargetCaptureInfo> &result) const;
160 bool processUseDeviceAddr(
161 lower::StatementContext &stmtCtx,
162 mlir::omp::UseDeviceAddrClauseOps &result,
163 llvm::SmallVectorImpl<const semantics::Symbol *> &useDeviceSyms) const;
164 bool processUseDevicePtr(
165 lower::StatementContext &stmtCtx,
166 mlir::omp::UseDevicePtrClauseOps &result,
167 llvm::SmallVectorImpl<const semantics::Symbol *> &useDeviceSyms) const;
168
169 // Call this method for these clauses that should be supported but are not
170 // implemented yet. It triggers a compilation error if any of the given
171 // clauses is found.
172 template <typename... Ts>
173 void processTODO(mlir::Location currentLocation,
174 llvm::omp::Directive directive) const;
175
176private:
177 using ClauseIterator = List<Clause>::const_iterator;
178
182 template <typename T>
183 const T *findUniqueClause(const parser::CharBlock **source = nullptr) const;
184
187 template <typename T>
188 bool findRepeatableClause(
189 std::function<void(const T &, const parser::CharBlock &source)>
190 callbackFn) const;
191
193 template <typename T>
194 bool markClauseOccurrence(mlir::UnitAttr &result) const;
195
196 void processMapObjects(
197 lower::StatementContext &stmtCtx, mlir::Location clauseLocation,
198 const omp::ObjectList &objects, mlir::omp::ClauseMapFlags mapTypeBits,
199 std::map<Object, OmpMapParentAndMemberData> &parentMemberIndices,
200 llvm::SmallVectorImpl<mlir::Value> &mapVars,
201 llvm::SmallVectorImpl<const semantics::Symbol *> &mapSyms,
202 llvm::StringRef mapperIdNameRef = "") const;
203
204 lower::AbstractConverter &converter;
205 semantics::SemanticsContext &semaCtx;
206 List<Clause> clauses;
207};
208
209template <typename... Ts>
210void ClauseProcessor::processTODO(mlir::Location currentLocation,
211 llvm::omp::Directive directive) const {
212 auto checkUnhandledClause = [&](llvm::omp::Clause id, const auto *x) {
213 if (!x)
214 return;
215 unsigned version = semaCtx.langOptions().OpenMPVersion;
216 bool isSimdDirective = llvm::omp::getOpenMPDirectiveName(directive, version)
217 .upper()
218 .find("SIMD") != llvm::StringRef::npos;
219 if (!semaCtx.langOptions().OpenMPSimd || isSimdDirective)
220 TODO(currentLocation,
221 "Unhandled clause " + llvm::omp::getOpenMPClauseName(id).upper() +
222 " in " +
223 llvm::omp::getOpenMPDirectiveName(directive, version).upper() +
224 " construct");
225 };
226
227 for (ClauseIterator it = clauses.begin(); it != clauses.end(); ++it)
228 (checkUnhandledClause(it->id, std::get_if<Ts>(&it->u)), ...);
229}
230
231template <typename T>
232const T *
233ClauseProcessor::findUniqueClause(const parser::CharBlock **source) const {
234 return ClauseFinder::findUniqueClause<T>(clauses, source);
235}
236
237template <typename T>
238bool ClauseProcessor::findRepeatableClause(
239 std::function<void(const T &, const parser::CharBlock &source)> callbackFn)
240 const {
241 return ClauseFinder::findRepeatableClause<T>(clauses, callbackFn);
242}
243
244template <typename T>
245bool ClauseProcessor::markClauseOccurrence(mlir::UnitAttr &result) const {
246 if (findUniqueClause<T>()) {
247 result = converter.getFirOpBuilder().getUnitAttr();
248 return true;
249 }
250 return false;
251}
252
253} // namespace omp
254} // namespace lower
255} // namespace Fortran
256
257#endif // FORTRAN_LOWER_CLAUSEPROCESSOR_H
Fortran::lower::AbstractConverter
Definition AbstractConverter.h:85
Fortran::lower::StatementContext
Definition StatementContext.h:46
Fortran::lower::SymMap
Definition SymbolMap.h:146
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:55
Fortran::lower
Definition ParserActions.h:24
Fortran
Definition bit-population-count.h:20
fir
Definition AbstractConverter.h:34
Fortran::lower::pft::Evaluation
Definition PFTBuilder.h:221
Generated on for FLANG by doxygen 1.14.0