Skip to content

Commit 6528f10

Browse files
skatrakskatrak
authored
[MLIR][OpenMP] Group clause operands into structures and use them to define simplified op builders (#86797)
This patch introduces a set of composable structures grouping the MLIR operands associated to each OpenMP clause. This makes it easier to keep the MLIR representation for the same clause consistent throughout all operations that accept it. The relevant clause operand structures are grouped into per-operation structures using a mixin pattern and used to define new operation constructors. These constructors can be used to avoid having to get the order of a possibly large list of operands right. Missing clauses are documented as TODOs, as well as operands which are part of the relevant operation's operand structure but cannot be attached to the associated operation yet, due to missing op arguments to its MLIR definition. A follow-up patch will update Flang lowering to make use of these structures, simplifying the passing of information from clause processing to operation-generating functions and also simplifying the creation of operations through the use of the new operation constructors.
1 parent 4657ab1 commit 6528f10

File tree

4 files changed

+595
-10
lines changed

4 files changed

+595
-10
lines changed

‎mlir/include/mlir/Dialect/OpenMP/OpenMPClauseOperands.h

Lines changed: 300 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,300 @@
1+
//===-- OpenMPClauseOperands.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+
// This file declares the structures defining MLIR operands associated with each
10+
// OpenMP clause, and structures grouping the appropriate operands for each
11+
// construct.
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
#ifndef MLIR_DIALECT_OPENMP_OPENMPCLAUSEOPERANDS_H_
16+
#define MLIR_DIALECT_OPENMP_OPENMPCLAUSEOPERANDS_H_
17+
18+
#include "mlir/IR/BuiltinAttributes.h"
19+
#include "llvm/ADT/SmallVector.h"
20+
21+
#include "mlir/Dialect/OpenMP/OpenMPOpsEnums.h.inc"
22+
23+
#define GET_ATTRDEF_CLASSES
24+
#include "mlir/Dialect/OpenMP/OpenMPOpsAttributes.h.inc"
25+
26+
namespace mlir {
27+
namespace omp {
28+
29+
//===----------------------------------------------------------------------===//
30+
// Mixin structures defining MLIR operands associated with each OpenMP clause.
31+
//===----------------------------------------------------------------------===//
32+
33+
struct AlignedClauseOps {
34+
llvm::SmallVector<Value> alignedVars;
35+
llvm::SmallVector<Attribute> alignmentAttrs;
36+
};
37+
38+
struct AllocateClauseOps {
39+
llvm::SmallVector<Value> allocatorVars, allocateVars;
40+
};
41+
42+
struct CollapseClauseOps {
43+
llvm::SmallVector<Value> loopLBVar, loopUBVar, loopStepVar;
44+
};
45+
46+
struct CopyprivateClauseOps {
47+
llvm::SmallVector<Value> copyprivateVars;
48+
llvm::SmallVector<Attribute> copyprivateFuncs;
49+
};
50+
51+
struct DependClauseOps {
52+
llvm::SmallVector<Attribute> dependTypeAttrs;
53+
llvm::SmallVector<Value> dependVars;
54+
};
55+
56+
struct DeviceClauseOps {
57+
Value deviceVar;
58+
};
59+
60+
struct DeviceTypeClauseOps {
61+
// The default capture type.
62+
DeclareTargetDeviceType deviceType = DeclareTargetDeviceType::any;
63+
};
64+
65+
struct DistScheduleClauseOps {
66+
UnitAttr distScheduleStaticAttr;
67+
Value distScheduleChunkSizeVar;
68+
};
69+
70+
struct DoacrossClauseOps {
71+
llvm::SmallVector<Value> doacrossVectorVars;
72+
ClauseDependAttr doacrossDependTypeAttr;
73+
IntegerAttr doacrossNumLoopsAttr;
74+
};
75+
76+
struct FinalClauseOps {
77+
Value finalVar;
78+
};
79+
80+
struct GrainsizeClauseOps {
81+
Value grainsizeVar;
82+
};
83+
84+
struct HintClauseOps {
85+
IntegerAttr hintAttr;
86+
};
87+
88+
struct IfClauseOps {
89+
Value ifVar;
90+
};
91+
92+
struct InReductionClauseOps {
93+
llvm::SmallVector<Value> inReductionVars;
94+
llvm::SmallVector<Attribute> inReductionDeclSymbols;
95+
};
96+
97+
struct LinearClauseOps {
98+
llvm::SmallVector<Value> linearVars, linearStepVars;
99+
};
100+
101+
struct LoopRelatedOps {
102+
UnitAttr loopInclusiveAttr;
103+
};
104+
105+
struct MapClauseOps {
106+
llvm::SmallVector<Value> mapVars;
107+
};
108+
109+
struct MergeableClauseOps {
110+
UnitAttr mergeableAttr;
111+
};
112+
113+
struct NameClauseOps {
114+
StringAttr nameAttr;
115+
};
116+
117+
struct NogroupClauseOps {
118+
UnitAttr nogroupAttr;
119+
};
120+
121+
struct NontemporalClauseOps {
122+
llvm::SmallVector<Value> nontemporalVars;
123+
};
124+
125+
struct NowaitClauseOps {
126+
UnitAttr nowaitAttr;
127+
};
128+
129+
struct NumTasksClauseOps {
130+
Value numTasksVar;
131+
};
132+
133+
struct NumTeamsClauseOps {
134+
Value numTeamsLowerVar, numTeamsUpperVar;
135+
};
136+
137+
struct NumThreadsClauseOps {
138+
Value numThreadsVar;
139+
};
140+
141+
struct OrderClauseOps {
142+
ClauseOrderKindAttr orderAttr;
143+
};
144+
145+
struct OrderedClauseOps {
146+
IntegerAttr orderedAttr;
147+
};
148+
149+
struct ParallelizationLevelClauseOps {
150+
UnitAttr parLevelSimdAttr;
151+
};
152+
153+
struct PriorityClauseOps {
154+
Value priorityVar;
155+
};
156+
157+
struct PrivateClauseOps {
158+
// SSA values that correspond to "original" values being privatized.
159+
// They refer to the SSA value outside the OpenMP region from which a clone is
160+
// created inside the region.
161+
llvm::SmallVector<Value> privateVars;
162+
// The list of symbols referring to delayed privatizer ops (i.e. `omp.private`
163+
// ops).
164+
llvm::SmallVector<Attribute> privatizers;
165+
};
166+
167+
struct ProcBindClauseOps {
168+
ClauseProcBindKindAttr procBindKindAttr;
169+
};
170+
171+
struct ReductionClauseOps {
172+
llvm::SmallVector<Value> reductionVars;
173+
llvm::SmallVector<Attribute> reductionDeclSymbols;
174+
UnitAttr reductionByRefAttr;
175+
};
176+
177+
struct SafelenClauseOps {
178+
IntegerAttr safelenAttr;
179+
};
180+
181+
struct ScheduleClauseOps {
182+
ClauseScheduleKindAttr scheduleValAttr;
183+
ScheduleModifierAttr scheduleModAttr;
184+
Value scheduleChunkVar;
185+
UnitAttr scheduleSimdAttr;
186+
};
187+
188+
struct SimdlenClauseOps {
189+
IntegerAttr simdlenAttr;
190+
};
191+
192+
struct TaskReductionClauseOps {
193+
llvm::SmallVector<Value> taskReductionVars;
194+
llvm::SmallVector<Attribute> taskReductionDeclSymbols;
195+
};
196+
197+
struct ThreadLimitClauseOps {
198+
Value threadLimitVar;
199+
};
200+
201+
struct UntiedClauseOps {
202+
UnitAttr untiedAttr;
203+
};
204+
205+
struct UseDeviceClauseOps {
206+
llvm::SmallVector<Value> useDevicePtrVars, useDeviceAddrVars;
207+
};
208+
209+
//===----------------------------------------------------------------------===//
210+
// Structures defining clause operands associated with each OpenMP leaf
211+
// construct.
212+
//
213+
// These mirror the arguments expected by the corresponding OpenMP MLIR ops.
214+
//===----------------------------------------------------------------------===//
215+
216+
namespace detail {
217+
template <typename... Mixins>
218+
struct Clauses : public Mixins... {};
219+
} // namespace detail
220+
221+
using CriticalClauseOps = detail::Clauses<HintClauseOps, NameClauseOps>;
222+
223+
// TODO `indirect` clause.
224+
using DeclareTargetClauseOps = detail::Clauses<DeviceTypeClauseOps>;
225+
226+
using DistributeClauseOps =
227+
detail::Clauses<AllocateClauseOps, DistScheduleClauseOps, OrderClauseOps,
228+
PrivateClauseOps>;
229+
230+
// TODO `filter` clause.
231+
using MaskedClauseOps = detail::Clauses<>;
232+
233+
using OrderedOpClauseOps = detail::Clauses<DoacrossClauseOps>;
234+
235+
using OrderedRegionClauseOps = detail::Clauses<ParallelizationLevelClauseOps>;
236+
237+
using ParallelClauseOps =
238+
detail::Clauses<AllocateClauseOps, IfClauseOps, NumThreadsClauseOps,
239+
PrivateClauseOps, ProcBindClauseOps, ReductionClauseOps>;
240+
241+
using SectionsClauseOps = detail::Clauses<AllocateClauseOps, NowaitClauseOps,
242+
PrivateClauseOps, ReductionClauseOps>;
243+
244+
// TODO `linear` clause.
245+
using SimdLoopClauseOps =
246+
detail::Clauses<AlignedClauseOps, CollapseClauseOps, IfClauseOps,
247+
LoopRelatedOps, NontemporalClauseOps, OrderClauseOps,
248+
PrivateClauseOps, ReductionClauseOps, SafelenClauseOps,
249+
SimdlenClauseOps>;
250+
251+
using SingleClauseOps = detail::Clauses<AllocateClauseOps, CopyprivateClauseOps,
252+
NowaitClauseOps, PrivateClauseOps>;
253+
254+
// TODO `defaultmap`, `has_device_addr`, `is_device_ptr`, `uses_allocators`
255+
// clauses.
256+
using TargetClauseOps =
257+
detail::Clauses<AllocateClauseOps, DependClauseOps, DeviceClauseOps,
258+
IfClauseOps, InReductionClauseOps, MapClauseOps,
259+
NowaitClauseOps, PrivateClauseOps, ReductionClauseOps,
260+
ThreadLimitClauseOps>;
261+
262+
using TargetDataClauseOps = detail::Clauses<DeviceClauseOps, IfClauseOps,
263+
MapClauseOps, UseDeviceClauseOps>;
264+
265+
using TargetEnterExitUpdateDataClauseOps =
266+
detail::Clauses<DependClauseOps, DeviceClauseOps, IfClauseOps, MapClauseOps,
267+
NowaitClauseOps>;
268+
269+
// TODO `affinity`, `detach` clauses.
270+
using TaskClauseOps =
271+
detail::Clauses<AllocateClauseOps, DependClauseOps, FinalClauseOps,
272+
IfClauseOps, InReductionClauseOps, MergeableClauseOps,
273+
PriorityClauseOps, PrivateClauseOps, UntiedClauseOps>;
274+
275+
using TaskgroupClauseOps =
276+
detail::Clauses<AllocateClauseOps, TaskReductionClauseOps>;
277+
278+
using TaskloopClauseOps =
279+
detail::Clauses<AllocateClauseOps, CollapseClauseOps, FinalClauseOps,
280+
GrainsizeClauseOps, IfClauseOps, InReductionClauseOps,
281+
LoopRelatedOps, MergeableClauseOps, NogroupClauseOps,
282+
NumTasksClauseOps, PriorityClauseOps, PrivateClauseOps,
283+
ReductionClauseOps, UntiedClauseOps>;
284+
285+
using TaskwaitClauseOps = detail::Clauses<DependClauseOps, NowaitClauseOps>;
286+
287+
using TeamsClauseOps =
288+
detail::Clauses<AllocateClauseOps, IfClauseOps, NumTeamsClauseOps,
289+
PrivateClauseOps, ReductionClauseOps, ThreadLimitClauseOps>;
290+
291+
using WsloopClauseOps =
292+
detail::Clauses<AllocateClauseOps, CollapseClauseOps, LinearClauseOps,
293+
LoopRelatedOps, NowaitClauseOps, OrderClauseOps,
294+
OrderedClauseOps, PrivateClauseOps, ReductionClauseOps,
295+
ScheduleClauseOps>;
296+
297+
} // namespace omp
298+
} // namespace mlir
299+
300+
#endif // MLIR_DIALECT_OPENMP_OPENMPCLAUSEOPERANDS_H_

‎mlir/include/mlir/Dialect/OpenMP/OpenMPDialect.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,10 @@
2626
#include "mlir/Dialect/OpenMP/OpenMPOpsTypes.h.inc"
2727

2828
#include "mlir/Dialect/OpenMP/OpenMPOpsDialect.h.inc"
29-
#include "mlir/Dialect/OpenMP/OpenMPOpsEnums.h.inc"
30-
#include "mlir/Dialect/OpenMP/OpenMPTypeInterfaces.h.inc"
3129

32-
#define GET_ATTRDEF_CLASSES
33-
#include "mlir/Dialect/OpenMP/OpenMPOpsAttributes.h.inc"
30+
#include "mlir/Dialect/OpenMP/OpenMPClauseOperands.h"
31+
32+
#include "mlir/Dialect/OpenMP/OpenMPTypeInterfaces.h.inc"
3433

3534
#include "mlir/Dialect/OpenMP/OpenMPInterfaces.h"
3635

0 commit comments

Comments
 (0)