1 //===- OpenMPDialect.cpp - MLIR Dialect for OpenMP implementation ---------===//
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 implements the OpenMP dialect and its operations.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "mlir/Dialect/OpenMP/OpenMPDialect.h"
14 #include "mlir/Dialect/LLVMIR/LLVMTypes.h"
15 #include "mlir/IR/Attributes.h"
16 #include "mlir/IR/DialectImplementation.h"
17 #include "mlir/IR/OpImplementation.h"
18 #include "mlir/IR/OperationSupport.h"
19 
20 #include "llvm/ADT/BitVector.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/ADT/StringSwitch.h"
25 #include "llvm/ADT/TypeSwitch.h"
26 #include <cstddef>
27 
28 #include "mlir/Dialect/OpenMP/OpenMPOpsDialect.cpp.inc"
29 #include "mlir/Dialect/OpenMP/OpenMPOpsEnums.cpp.inc"
30 #include "mlir/Dialect/OpenMP/OpenMPOpsInterfaces.cpp.inc"
31 #include "mlir/Dialect/OpenMP/OpenMPTypeInterfaces.cpp.inc"
32 
33 using namespace mlir;
34 using namespace mlir::omp;
35 
36 namespace {
37 /// Model for pointer-like types that already provide a `getElementType` method.
38 template <typename T>
39 struct PointerLikeModel
40     : public PointerLikeType::ExternalModel<PointerLikeModel<T>, T> {
41   Type getElementType(Type pointer) const {
42     return pointer.cast<T>().getElementType();
43   }
44 };
45 } // namespace
46 
47 void OpenMPDialect::initialize() {
48   addOperations<
49 #define GET_OP_LIST
50 #include "mlir/Dialect/OpenMP/OpenMPOps.cpp.inc"
51       >();
52   addAttributes<
53 #define GET_ATTRDEF_LIST
54 #include "mlir/Dialect/OpenMP/OpenMPOpsAttributes.cpp.inc"
55       >();
56 
57   LLVM::LLVMPointerType::attachInterface<
58       PointerLikeModel<LLVM::LLVMPointerType>>(*getContext());
59   MemRefType::attachInterface<PointerLikeModel<MemRefType>>(*getContext());
60 }
61 
62 //===----------------------------------------------------------------------===//
63 // Parser and printer for Allocate Clause
64 //===----------------------------------------------------------------------===//
65 
66 /// Parse an allocate clause with allocators and a list of operands with types.
67 ///
68 /// allocate-operand-list :: = allocate-operand |
69 ///                            allocator-operand `,` allocate-operand-list
70 /// allocate-operand :: = ssa-id-and-type -> ssa-id-and-type
71 /// ssa-id-and-type ::= ssa-id `:` type
72 static ParseResult parseAllocateAndAllocator(
73     OpAsmParser &parser,
74     SmallVectorImpl<OpAsmParser::UnresolvedOperand> &operandsAllocate,
75     SmallVectorImpl<Type> &typesAllocate,
76     SmallVectorImpl<OpAsmParser::UnresolvedOperand> &operandsAllocator,
77     SmallVectorImpl<Type> &typesAllocator) {
78 
79   return parser.parseCommaSeparatedList([&]() -> ParseResult {
80     OpAsmParser::UnresolvedOperand operand;
81     Type type;
82     if (parser.parseOperand(operand) || parser.parseColonType(type))
83       return failure();
84     operandsAllocator.push_back(operand);
85     typesAllocator.push_back(type);
86     if (parser.parseArrow())
87       return failure();
88     if (parser.parseOperand(operand) || parser.parseColonType(type))
89       return failure();
90 
91     operandsAllocate.push_back(operand);
92     typesAllocate.push_back(type);
93     return success();
94   });
95 }
96 
97 /// Print allocate clause
98 static void printAllocateAndAllocator(OpAsmPrinter &p, Operation *op,
99                                       OperandRange varsAllocate,
100                                       TypeRange typesAllocate,
101                                       OperandRange varsAllocator,
102                                       TypeRange typesAllocator) {
103   for (unsigned i = 0; i < varsAllocate.size(); ++i) {
104     std::string separator = i == varsAllocate.size() - 1 ? "" : ", ";
105     p << varsAllocator[i] << " : " << typesAllocator[i] << " -> ";
106     p << varsAllocate[i] << " : " << typesAllocate[i] << separator;
107   }
108 }
109 
110 //===----------------------------------------------------------------------===//
111 // Parser and printer for a clause attribute (StringEnumAttr)
112 //===----------------------------------------------------------------------===//
113 
114 template <typename ClauseAttr>
115 static ParseResult parseClauseAttr(AsmParser &parser, ClauseAttr &attr) {
116   using ClauseT = decltype(std::declval<ClauseAttr>().getValue());
117   StringRef enumStr;
118   SMLoc loc = parser.getCurrentLocation();
119   if (parser.parseKeyword(&enumStr))
120     return failure();
121   if (Optional<ClauseT> enumValue = symbolizeEnum<ClauseT>(enumStr)) {
122     attr = ClauseAttr::get(parser.getContext(), *enumValue);
123     return success();
124   }
125   return parser.emitError(loc, "invalid clause value: '") << enumStr << "'";
126 }
127 
128 template <typename ClauseAttr>
129 void printClauseAttr(OpAsmPrinter &p, Operation *op, ClauseAttr attr) {
130   p << stringifyEnum(attr.getValue());
131 }
132 
133 //===----------------------------------------------------------------------===//
134 // Parser and printer for Linear Clause
135 //===----------------------------------------------------------------------===//
136 
137 /// linear ::= `linear` `(` linear-list `)`
138 /// linear-list := linear-val | linear-val linear-list
139 /// linear-val := ssa-id-and-type `=` ssa-id-and-type
140 static ParseResult
141 parseLinearClause(OpAsmParser &parser,
142                   SmallVectorImpl<OpAsmParser::UnresolvedOperand> &vars,
143                   SmallVectorImpl<Type> &types,
144                   SmallVectorImpl<OpAsmParser::UnresolvedOperand> &stepVars) {
145   do {
146     OpAsmParser::UnresolvedOperand var;
147     Type type;
148     OpAsmParser::UnresolvedOperand stepVar;
149     if (parser.parseOperand(var) || parser.parseEqual() ||
150         parser.parseOperand(stepVar) || parser.parseColonType(type))
151       return failure();
152 
153     vars.push_back(var);
154     types.push_back(type);
155     stepVars.push_back(stepVar);
156   } while (succeeded(parser.parseOptionalComma()));
157   return success();
158 }
159 
160 /// Print Linear Clause
161 static void printLinearClause(OpAsmPrinter &p, Operation *op,
162                               ValueRange linearVars, TypeRange linearVarTypes,
163                               ValueRange linearStepVars) {
164   size_t linearVarsSize = linearVars.size();
165   for (unsigned i = 0; i < linearVarsSize; ++i) {
166     std::string separator = i == linearVarsSize - 1 ? "" : ", ";
167     p << linearVars[i];
168     if (linearStepVars.size() > i)
169       p << " = " << linearStepVars[i];
170     p << " : " << linearVars[i].getType() << separator;
171   }
172 }
173 
174 //===----------------------------------------------------------------------===//
175 // Parser, printer and verifier for Schedule Clause
176 //===----------------------------------------------------------------------===//
177 
178 static ParseResult
179 verifyScheduleModifiers(OpAsmParser &parser,
180                         SmallVectorImpl<SmallString<12>> &modifiers) {
181   if (modifiers.size() > 2)
182     return parser.emitError(parser.getNameLoc()) << " unexpected modifier(s)";
183   for (const auto &mod : modifiers) {
184     // Translate the string. If it has no value, then it was not a valid
185     // modifier!
186     auto symbol = symbolizeScheduleModifier(mod);
187     if (!symbol.hasValue())
188       return parser.emitError(parser.getNameLoc())
189              << " unknown modifier type: " << mod;
190   }
191 
192   // If we have one modifier that is "simd", then stick a "none" modiifer in
193   // index 0.
194   if (modifiers.size() == 1) {
195     if (symbolizeScheduleModifier(modifiers[0]) == ScheduleModifier::simd) {
196       modifiers.push_back(modifiers[0]);
197       modifiers[0] = stringifyScheduleModifier(ScheduleModifier::none);
198     }
199   } else if (modifiers.size() == 2) {
200     // If there are two modifier:
201     // First modifier should not be simd, second one should be simd
202     if (symbolizeScheduleModifier(modifiers[0]) == ScheduleModifier::simd ||
203         symbolizeScheduleModifier(modifiers[1]) != ScheduleModifier::simd)
204       return parser.emitError(parser.getNameLoc())
205              << " incorrect modifier order";
206   }
207   return success();
208 }
209 
210 /// schedule ::= `schedule` `(` sched-list `)`
211 /// sched-list ::= sched-val | sched-val sched-list |
212 ///                sched-val `,` sched-modifier
213 /// sched-val ::= sched-with-chunk | sched-wo-chunk
214 /// sched-with-chunk ::= sched-with-chunk-types (`=` ssa-id-and-type)?
215 /// sched-with-chunk-types ::= `static` | `dynamic` | `guided`
216 /// sched-wo-chunk ::=  `auto` | `runtime`
217 /// sched-modifier ::=  sched-mod-val | sched-mod-val `,` sched-mod-val
218 /// sched-mod-val ::=  `monotonic` | `nonmonotonic` | `simd` | `none`
219 static ParseResult parseScheduleClause(
220     OpAsmParser &parser, ClauseScheduleKindAttr &scheduleAttr,
221     ScheduleModifierAttr &scheduleModifier, UnitAttr &simdModifier,
222     Optional<OpAsmParser::UnresolvedOperand> &chunkSize, Type &chunkType) {
223   StringRef keyword;
224   if (parser.parseKeyword(&keyword))
225     return failure();
226   llvm::Optional<mlir::omp::ClauseScheduleKind> schedule =
227       symbolizeClauseScheduleKind(keyword);
228   if (!schedule)
229     return parser.emitError(parser.getNameLoc()) << " expected schedule kind";
230 
231   scheduleAttr = ClauseScheduleKindAttr::get(parser.getContext(), *schedule);
232   switch (*schedule) {
233   case ClauseScheduleKind::Static:
234   case ClauseScheduleKind::Dynamic:
235   case ClauseScheduleKind::Guided:
236     if (succeeded(parser.parseOptionalEqual())) {
237       chunkSize = OpAsmParser::UnresolvedOperand{};
238       if (parser.parseOperand(*chunkSize) || parser.parseColonType(chunkType))
239         return failure();
240     } else {
241       chunkSize = llvm::NoneType::None;
242     }
243     break;
244   case ClauseScheduleKind::Auto:
245   case ClauseScheduleKind::Runtime:
246     chunkSize = llvm::NoneType::None;
247   }
248 
249   // If there is a comma, we have one or more modifiers..
250   SmallVector<SmallString<12>> modifiers;
251   while (succeeded(parser.parseOptionalComma())) {
252     StringRef mod;
253     if (parser.parseKeyword(&mod))
254       return failure();
255     modifiers.push_back(mod);
256   }
257 
258   if (verifyScheduleModifiers(parser, modifiers))
259     return failure();
260 
261   if (!modifiers.empty()) {
262     SMLoc loc = parser.getCurrentLocation();
263     if (Optional<ScheduleModifier> mod =
264             symbolizeScheduleModifier(modifiers[0])) {
265       scheduleModifier = ScheduleModifierAttr::get(parser.getContext(), *mod);
266     } else {
267       return parser.emitError(loc, "invalid schedule modifier");
268     }
269     // Only SIMD attribute is allowed here!
270     if (modifiers.size() > 1) {
271       assert(symbolizeScheduleModifier(modifiers[1]) == ScheduleModifier::simd);
272       simdModifier = UnitAttr::get(parser.getBuilder().getContext());
273     }
274   }
275 
276   return success();
277 }
278 
279 /// Print schedule clause
280 static void printScheduleClause(OpAsmPrinter &p, Operation *op,
281                                 ClauseScheduleKindAttr schedAttr,
282                                 ScheduleModifierAttr modifier, UnitAttr simd,
283                                 Value scheduleChunkVar,
284                                 Type scheduleChunkType) {
285   p << stringifyClauseScheduleKind(schedAttr.getValue());
286   if (scheduleChunkVar)
287     p << " = " << scheduleChunkVar << " : " << scheduleChunkVar.getType();
288   if (modifier)
289     p << ", " << stringifyScheduleModifier(modifier.getValue());
290   if (simd)
291     p << ", simd";
292 }
293 
294 //===----------------------------------------------------------------------===//
295 // Parser, printer and verifier for ReductionVarList
296 //===----------------------------------------------------------------------===//
297 
298 /// reduction-entry-list ::= reduction-entry
299 ///                        | reduction-entry-list `,` reduction-entry
300 /// reduction-entry ::= symbol-ref `->` ssa-id `:` type
301 static ParseResult
302 parseReductionVarList(OpAsmParser &parser,
303                       SmallVectorImpl<OpAsmParser::UnresolvedOperand> &operands,
304                       SmallVectorImpl<Type> &types,
305                       ArrayAttr &redcuctionSymbols) {
306   SmallVector<SymbolRefAttr> reductionVec;
307   do {
308     if (parser.parseAttribute(reductionVec.emplace_back()) ||
309         parser.parseArrow() || parser.parseOperand(operands.emplace_back()) ||
310         parser.parseColonType(types.emplace_back()))
311       return failure();
312   } while (succeeded(parser.parseOptionalComma()));
313   SmallVector<Attribute> reductions(reductionVec.begin(), reductionVec.end());
314   redcuctionSymbols = ArrayAttr::get(parser.getContext(), reductions);
315   return success();
316 }
317 
318 /// Print Reduction clause
319 static void printReductionVarList(OpAsmPrinter &p, Operation *op,
320                                   OperandRange reductionVars,
321                                   TypeRange reductionTypes,
322                                   Optional<ArrayAttr> reductions) {
323   for (unsigned i = 0, e = reductions->size(); i < e; ++i) {
324     if (i != 0)
325       p << ", ";
326     p << (*reductions)[i] << " -> " << reductionVars[i] << " : "
327       << reductionVars[i].getType();
328   }
329 }
330 
331 /// Verifies Reduction Clause
332 static LogicalResult verifyReductionVarList(Operation *op,
333                                             Optional<ArrayAttr> reductions,
334                                             OperandRange reductionVars) {
335   if (!reductionVars.empty()) {
336     if (!reductions || reductions->size() != reductionVars.size())
337       return op->emitOpError()
338              << "expected as many reduction symbol references "
339                 "as reduction variables";
340   } else {
341     if (reductions)
342       return op->emitOpError() << "unexpected reduction symbol references";
343     return success();
344   }
345 
346   // TODO: The followings should be done in
347   // SymbolUserOpInterface::verifySymbolUses.
348   DenseSet<Value> accumulators;
349   for (auto args : llvm::zip(reductionVars, *reductions)) {
350     Value accum = std::get<0>(args);
351 
352     if (!accumulators.insert(accum).second)
353       return op->emitOpError() << "accumulator variable used more than once";
354 
355     Type varType = accum.getType().cast<PointerLikeType>();
356     auto symbolRef = std::get<1>(args).cast<SymbolRefAttr>();
357     auto decl =
358         SymbolTable::lookupNearestSymbolFrom<ReductionDeclareOp>(op, symbolRef);
359     if (!decl)
360       return op->emitOpError() << "expected symbol reference " << symbolRef
361                                << " to point to a reduction declaration";
362 
363     if (decl.getAccumulatorType() && decl.getAccumulatorType() != varType)
364       return op->emitOpError()
365              << "expected accumulator (" << varType
366              << ") to be the same type as reduction declaration ("
367              << decl.getAccumulatorType() << ")";
368   }
369 
370   return success();
371 }
372 
373 //===----------------------------------------------------------------------===//
374 // Parser, printer and verifier for Synchronization Hint (2.17.12)
375 //===----------------------------------------------------------------------===//
376 
377 /// Parses a Synchronization Hint clause. The value of hint is an integer
378 /// which is a combination of different hints from `omp_sync_hint_t`.
379 ///
380 /// hint-clause = `hint` `(` hint-value `)`
381 static ParseResult parseSynchronizationHint(OpAsmParser &parser,
382                                             IntegerAttr &hintAttr) {
383   StringRef hintKeyword;
384   int64_t hint = 0;
385   if (succeeded(parser.parseOptionalKeyword("none"))) {
386     hintAttr = IntegerAttr::get(parser.getBuilder().getI64Type(), 0);
387     return success();
388   }
389   do {
390     if (failed(parser.parseKeyword(&hintKeyword)))
391       return failure();
392     if (hintKeyword == "uncontended")
393       hint |= 1;
394     else if (hintKeyword == "contended")
395       hint |= 2;
396     else if (hintKeyword == "nonspeculative")
397       hint |= 4;
398     else if (hintKeyword == "speculative")
399       hint |= 8;
400     else
401       return parser.emitError(parser.getCurrentLocation())
402              << hintKeyword << " is not a valid hint";
403   } while (succeeded(parser.parseOptionalComma()));
404   hintAttr = IntegerAttr::get(parser.getBuilder().getI64Type(), hint);
405   return success();
406 }
407 
408 /// Prints a Synchronization Hint clause
409 static void printSynchronizationHint(OpAsmPrinter &p, Operation *op,
410                                      IntegerAttr hintAttr) {
411   int64_t hint = hintAttr.getInt();
412 
413   if (hint == 0) {
414     p << "none";
415     return;
416   }
417 
418   // Helper function to get n-th bit from the right end of `value`
419   auto bitn = [](int value, int n) -> bool { return value & (1 << n); };
420 
421   bool uncontended = bitn(hint, 0);
422   bool contended = bitn(hint, 1);
423   bool nonspeculative = bitn(hint, 2);
424   bool speculative = bitn(hint, 3);
425 
426   SmallVector<StringRef> hints;
427   if (uncontended)
428     hints.push_back("uncontended");
429   if (contended)
430     hints.push_back("contended");
431   if (nonspeculative)
432     hints.push_back("nonspeculative");
433   if (speculative)
434     hints.push_back("speculative");
435 
436   llvm::interleaveComma(hints, p);
437 }
438 
439 /// Verifies a synchronization hint clause
440 static LogicalResult verifySynchronizationHint(Operation *op, uint64_t hint) {
441 
442   // Helper function to get n-th bit from the right end of `value`
443   auto bitn = [](int value, int n) -> bool { return value & (1 << n); };
444 
445   bool uncontended = bitn(hint, 0);
446   bool contended = bitn(hint, 1);
447   bool nonspeculative = bitn(hint, 2);
448   bool speculative = bitn(hint, 3);
449 
450   if (uncontended && contended)
451     return op->emitOpError() << "the hints omp_sync_hint_uncontended and "
452                                 "omp_sync_hint_contended cannot be combined";
453   if (nonspeculative && speculative)
454     return op->emitOpError() << "the hints omp_sync_hint_nonspeculative and "
455                                 "omp_sync_hint_speculative cannot be combined.";
456   return success();
457 }
458 
459 //===----------------------------------------------------------------------===//
460 // ParallelOp
461 //===----------------------------------------------------------------------===//
462 
463 void ParallelOp::build(OpBuilder &builder, OperationState &state,
464                        ArrayRef<NamedAttribute> attributes) {
465   ParallelOp::build(
466       builder, state, /*if_expr_var=*/nullptr, /*num_threads_var=*/nullptr,
467       /*allocate_vars=*/ValueRange(), /*allocators_vars=*/ValueRange(),
468       /*reduction_vars=*/ValueRange(), /*reductions=*/nullptr,
469       /*proc_bind_val=*/nullptr);
470   state.addAttributes(attributes);
471 }
472 
473 LogicalResult ParallelOp::verify() {
474   if (allocate_vars().size() != allocators_vars().size())
475     return emitError(
476         "expected equal sizes for allocate and allocator variables");
477   return verifyReductionVarList(*this, reductions(), reduction_vars());
478 }
479 
480 //===----------------------------------------------------------------------===//
481 // Verifier for SectionsOp
482 //===----------------------------------------------------------------------===//
483 
484 LogicalResult SectionsOp::verify() {
485   if (allocate_vars().size() != allocators_vars().size())
486     return emitError(
487         "expected equal sizes for allocate and allocator variables");
488 
489   return verifyReductionVarList(*this, reductions(), reduction_vars());
490 }
491 
492 LogicalResult SectionsOp::verifyRegions() {
493   for (auto &inst : *region().begin()) {
494     if (!(isa<SectionOp>(inst) || isa<TerminatorOp>(inst))) {
495       return emitOpError()
496              << "expected omp.section op or terminator op inside region";
497     }
498   }
499 
500   return success();
501 }
502 
503 LogicalResult SingleOp::verify() {
504   // Check for allocate clause restrictions
505   if (allocate_vars().size() != allocators_vars().size())
506     return emitError(
507         "expected equal sizes for allocate and allocator variables");
508 
509   return success();
510 }
511 
512 //===----------------------------------------------------------------------===//
513 // WsLoopOp
514 //===----------------------------------------------------------------------===//
515 
516 /// loop-control ::= `(` ssa-id-list `)` `:` type `=`  loop-bounds
517 /// loop-bounds := `(` ssa-id-list `)` to `(` ssa-id-list `)` inclusive? steps
518 /// steps := `step` `(`ssa-id-list`)`
519 ParseResult
520 parseWsLoopControl(OpAsmParser &parser, Region &region,
521                    SmallVectorImpl<OpAsmParser::UnresolvedOperand> &lowerBound,
522                    SmallVectorImpl<OpAsmParser::UnresolvedOperand> &upperBound,
523                    SmallVectorImpl<OpAsmParser::UnresolvedOperand> &steps,
524                    SmallVectorImpl<Type> &loopVarTypes, UnitAttr &inclusive) {
525   // Parse an opening `(` followed by induction variables followed by `)`
526   SmallVector<OpAsmParser::UnresolvedOperand> ivs;
527   if (parser.parseOperandList(ivs, OpAsmParser::Delimiter::Paren,
528                               /*allowResultNumber=*/false))
529     return failure();
530 
531   size_t numIVs = ivs.size();
532   Type loopVarType;
533   if (parser.parseColonType(loopVarType) ||
534       // Parse loop bounds.
535       parser.parseEqual() ||
536       parser.parseOperandList(lowerBound, numIVs,
537                               OpAsmParser::Delimiter::Paren) ||
538       parser.parseKeyword("to") ||
539       parser.parseOperandList(upperBound, numIVs,
540                               OpAsmParser::Delimiter::Paren))
541     return failure();
542 
543   if (succeeded(parser.parseOptionalKeyword("inclusive")))
544     inclusive = UnitAttr::get(parser.getBuilder().getContext());
545 
546   // Parse step values.
547   if (parser.parseKeyword("step") ||
548       parser.parseOperandList(steps, numIVs, OpAsmParser::Delimiter::Paren))
549     return failure();
550 
551   // Now parse the body.
552   loopVarTypes = SmallVector<Type>(numIVs, loopVarType);
553   SmallVector<OpAsmParser::UnresolvedOperand> blockArgs(ivs);
554   if (parser.parseRegion(region, blockArgs, loopVarTypes))
555     return failure();
556   return success();
557 }
558 
559 void printWsLoopControl(OpAsmPrinter &p, Operation *op, Region &region,
560                         ValueRange lowerBound, ValueRange upperBound,
561                         ValueRange steps, TypeRange loopVarTypes,
562                         UnitAttr inclusive) {
563   auto args = region.front().getArguments();
564   p << " (" << args << ") : " << args[0].getType() << " = (" << lowerBound
565     << ") to (" << upperBound << ") ";
566   if (inclusive)
567     p << "inclusive ";
568   p << "step (" << steps << ") ";
569   p.printRegion(region, /*printEntryBlockArgs=*/false);
570 }
571 
572 //===----------------------------------------------------------------------===//
573 // SimdLoopOp
574 //===----------------------------------------------------------------------===//
575 /// Parses an OpenMP Simd construct [2.9.3.1]
576 ///
577 /// simdloop ::= `omp.simdloop` loop-control clause-list
578 /// loop-control ::= `(` ssa-id-list `)` `:` type `=`  loop-bounds
579 /// loop-bounds := `(` ssa-id-list `)` to `(` ssa-id-list `)` steps
580 /// steps := `step` `(`ssa-id-list`)`
581 /// clause-list ::= clause clause-list | empty
582 /// clause ::= TODO
583 ParseResult SimdLoopOp::parse(OpAsmParser &parser, OperationState &result) {
584   // Parse an opening `(` followed by induction variables followed by `)`
585   SmallVector<OpAsmParser::UnresolvedOperand> ivs;
586   if (parser.parseOperandList(ivs, OpAsmParser::Delimiter::Paren,
587                               /*allowResultNumber=*/false))
588     return failure();
589   int numIVs = static_cast<int>(ivs.size());
590   Type loopVarType;
591   if (parser.parseColonType(loopVarType))
592     return failure();
593   // Parse loop bounds.
594   SmallVector<OpAsmParser::UnresolvedOperand> lower;
595   if (parser.parseEqual() ||
596       parser.parseOperandList(lower, numIVs, OpAsmParser::Delimiter::Paren) ||
597       parser.resolveOperands(lower, loopVarType, result.operands))
598     return failure();
599   SmallVector<OpAsmParser::UnresolvedOperand> upper;
600   if (parser.parseKeyword("to") ||
601       parser.parseOperandList(upper, numIVs, OpAsmParser::Delimiter::Paren) ||
602       parser.resolveOperands(upper, loopVarType, result.operands))
603     return failure();
604 
605   // Parse step values.
606   SmallVector<OpAsmParser::UnresolvedOperand> steps;
607   if (parser.parseKeyword("step") ||
608       parser.parseOperandList(steps, numIVs, OpAsmParser::Delimiter::Paren) ||
609       parser.resolveOperands(steps, loopVarType, result.operands))
610     return failure();
611 
612   SmallVector<int> segments{numIVs, numIVs, numIVs};
613   // TODO: Add parseClauses() when we support clauses
614   result.addAttribute("operand_segment_sizes",
615                       parser.getBuilder().getI32VectorAttr(segments));
616 
617   // Now parse the body.
618   Region *body = result.addRegion();
619   SmallVector<Type> ivTypes(numIVs, loopVarType);
620   SmallVector<OpAsmParser::UnresolvedOperand> blockArgs(ivs);
621   if (parser.parseRegion(*body, blockArgs, ivTypes))
622     return failure();
623   return success();
624 }
625 
626 void SimdLoopOp::print(OpAsmPrinter &p) {
627   auto args = getRegion().front().getArguments();
628   p << " (" << args << ") : " << args[0].getType() << " = (" << lowerBound()
629     << ") to (" << upperBound() << ") ";
630   p << "step (" << step() << ") ";
631 
632   p.printRegion(region(), /*printEntryBlockArgs=*/false);
633 }
634 
635 //===----------------------------------------------------------------------===//
636 // Verifier for Simd construct [2.9.3.1]
637 //===----------------------------------------------------------------------===//
638 
639 LogicalResult SimdLoopOp::verify() {
640   if (this->lowerBound().empty()) {
641     return emitOpError() << "empty lowerbound for simd loop operation";
642   }
643   return success();
644 }
645 
646 //===----------------------------------------------------------------------===//
647 // ReductionOp
648 //===----------------------------------------------------------------------===//
649 
650 static ParseResult parseAtomicReductionRegion(OpAsmParser &parser,
651                                               Region &region) {
652   if (parser.parseOptionalKeyword("atomic"))
653     return success();
654   return parser.parseRegion(region);
655 }
656 
657 static void printAtomicReductionRegion(OpAsmPrinter &printer,
658                                        ReductionDeclareOp op, Region &region) {
659   if (region.empty())
660     return;
661   printer << "atomic ";
662   printer.printRegion(region);
663 }
664 
665 LogicalResult ReductionDeclareOp::verifyRegions() {
666   if (initializerRegion().empty())
667     return emitOpError() << "expects non-empty initializer region";
668   Block &initializerEntryBlock = initializerRegion().front();
669   if (initializerEntryBlock.getNumArguments() != 1 ||
670       initializerEntryBlock.getArgument(0).getType() != type()) {
671     return emitOpError() << "expects initializer region with one argument "
672                             "of the reduction type";
673   }
674 
675   for (YieldOp yieldOp : initializerRegion().getOps<YieldOp>()) {
676     if (yieldOp.results().size() != 1 ||
677         yieldOp.results().getTypes()[0] != type())
678       return emitOpError() << "expects initializer region to yield a value "
679                               "of the reduction type";
680   }
681 
682   if (reductionRegion().empty())
683     return emitOpError() << "expects non-empty reduction region";
684   Block &reductionEntryBlock = reductionRegion().front();
685   if (reductionEntryBlock.getNumArguments() != 2 ||
686       reductionEntryBlock.getArgumentTypes()[0] !=
687           reductionEntryBlock.getArgumentTypes()[1] ||
688       reductionEntryBlock.getArgumentTypes()[0] != type())
689     return emitOpError() << "expects reduction region with two arguments of "
690                             "the reduction type";
691   for (YieldOp yieldOp : reductionRegion().getOps<YieldOp>()) {
692     if (yieldOp.results().size() != 1 ||
693         yieldOp.results().getTypes()[0] != type())
694       return emitOpError() << "expects reduction region to yield a value "
695                               "of the reduction type";
696   }
697 
698   if (atomicReductionRegion().empty())
699     return success();
700 
701   Block &atomicReductionEntryBlock = atomicReductionRegion().front();
702   if (atomicReductionEntryBlock.getNumArguments() != 2 ||
703       atomicReductionEntryBlock.getArgumentTypes()[0] !=
704           atomicReductionEntryBlock.getArgumentTypes()[1])
705     return emitOpError() << "expects atomic reduction region with two "
706                             "arguments of the same type";
707   auto ptrType = atomicReductionEntryBlock.getArgumentTypes()[0]
708                      .dyn_cast<PointerLikeType>();
709   if (!ptrType || ptrType.getElementType() != type())
710     return emitOpError() << "expects atomic reduction region arguments to "
711                             "be accumulators containing the reduction type";
712   return success();
713 }
714 
715 LogicalResult ReductionOp::verify() {
716   auto *op = (*this)->getParentWithTrait<ReductionClauseInterface::Trait>();
717   if (!op)
718     return emitOpError() << "must be used within an operation supporting "
719                             "reduction clause interface";
720   while (op) {
721     for (const auto &var :
722          cast<ReductionClauseInterface>(op).getReductionVars())
723       if (var == accumulator())
724         return success();
725     op = op->getParentWithTrait<ReductionClauseInterface::Trait>();
726   }
727   return emitOpError() << "the accumulator is not used by the parent";
728 }
729 
730 //===----------------------------------------------------------------------===//
731 // TaskOp
732 //===----------------------------------------------------------------------===//
733 LogicalResult TaskOp::verify() {
734   return verifyReductionVarList(*this, in_reductions(), in_reduction_vars());
735 }
736 
737 //===----------------------------------------------------------------------===//
738 // WsLoopOp
739 //===----------------------------------------------------------------------===//
740 
741 void WsLoopOp::build(OpBuilder &builder, OperationState &state,
742                      ValueRange lowerBound, ValueRange upperBound,
743                      ValueRange step, ArrayRef<NamedAttribute> attributes) {
744   build(builder, state, lowerBound, upperBound, step,
745         /*linear_vars=*/ValueRange(),
746         /*linear_step_vars=*/ValueRange(), /*reduction_vars=*/ValueRange(),
747         /*reductions=*/nullptr, /*schedule_val=*/nullptr,
748         /*schedule_chunk_var=*/nullptr, /*schedule_modifier=*/nullptr,
749         /*simd_modifier=*/false, /*collapse_val=*/nullptr, /*nowait=*/false,
750         /*ordered_val=*/nullptr, /*order_val=*/nullptr, /*inclusive=*/false);
751   state.addAttributes(attributes);
752 }
753 
754 LogicalResult WsLoopOp::verify() {
755   return verifyReductionVarList(*this, reductions(), reduction_vars());
756 }
757 
758 //===----------------------------------------------------------------------===//
759 // Verifier for critical construct (2.17.1)
760 //===----------------------------------------------------------------------===//
761 
762 LogicalResult CriticalDeclareOp::verify() {
763   return verifySynchronizationHint(*this, hint_val());
764 }
765 
766 LogicalResult CriticalOp::verifySymbolUses(SymbolTableCollection &symbolTable) {
767   if (nameAttr()) {
768     SymbolRefAttr symbolRef = nameAttr();
769     auto decl = symbolTable.lookupNearestSymbolFrom<CriticalDeclareOp>(
770         *this, symbolRef);
771     if (!decl) {
772       return emitOpError() << "expected symbol reference " << symbolRef
773                            << " to point to a critical declaration";
774     }
775   }
776 
777   return success();
778 }
779 
780 //===----------------------------------------------------------------------===//
781 // Verifier for ordered construct
782 //===----------------------------------------------------------------------===//
783 
784 LogicalResult OrderedOp::verify() {
785   auto container = (*this)->getParentOfType<WsLoopOp>();
786   if (!container || !container.ordered_valAttr() ||
787       container.ordered_valAttr().getInt() == 0)
788     return emitOpError() << "ordered depend directive must be closely "
789                          << "nested inside a worksharing-loop with ordered "
790                          << "clause with parameter present";
791 
792   if (container.ordered_valAttr().getInt() !=
793       (int64_t)num_loops_val().getValue())
794     return emitOpError() << "number of variables in depend clause does not "
795                          << "match number of iteration variables in the "
796                          << "doacross loop";
797 
798   return success();
799 }
800 
801 LogicalResult OrderedRegionOp::verify() {
802   // TODO: The code generation for ordered simd directive is not supported yet.
803   if (simd())
804     return failure();
805 
806   if (auto container = (*this)->getParentOfType<WsLoopOp>()) {
807     if (!container.ordered_valAttr() ||
808         container.ordered_valAttr().getInt() != 0)
809       return emitOpError() << "ordered region must be closely nested inside "
810                            << "a worksharing-loop region with an ordered "
811                            << "clause without parameter present";
812   }
813 
814   return success();
815 }
816 
817 //===----------------------------------------------------------------------===//
818 // Verifier for AtomicReadOp
819 //===----------------------------------------------------------------------===//
820 
821 LogicalResult AtomicReadOp::verify() {
822   if (auto mo = memory_order_val()) {
823     if (*mo == ClauseMemoryOrderKind::Acq_rel ||
824         *mo == ClauseMemoryOrderKind::Release) {
825       return emitError(
826           "memory-order must not be acq_rel or release for atomic reads");
827     }
828   }
829   if (x() == v())
830     return emitError(
831         "read and write must not be to the same location for atomic reads");
832   return verifySynchronizationHint(*this, hint_val());
833 }
834 
835 //===----------------------------------------------------------------------===//
836 // Verifier for AtomicWriteOp
837 //===----------------------------------------------------------------------===//
838 
839 LogicalResult AtomicWriteOp::verify() {
840   if (auto mo = memory_order_val()) {
841     if (*mo == ClauseMemoryOrderKind::Acq_rel ||
842         *mo == ClauseMemoryOrderKind::Acquire) {
843       return emitError(
844           "memory-order must not be acq_rel or acquire for atomic writes");
845     }
846   }
847   return verifySynchronizationHint(*this, hint_val());
848 }
849 
850 //===----------------------------------------------------------------------===//
851 // Verifier for AtomicUpdateOp
852 //===----------------------------------------------------------------------===//
853 
854 LogicalResult AtomicUpdateOp::verify() {
855   if (auto mo = memory_order_val()) {
856     if (*mo == ClauseMemoryOrderKind::Acq_rel ||
857         *mo == ClauseMemoryOrderKind::Acquire) {
858       return emitError(
859           "memory-order must not be acq_rel or acquire for atomic updates");
860     }
861   }
862 
863   if (x().getType().cast<PointerLikeType>().getElementType() !=
864       region().getArgument(0).getType()) {
865     return emitError("the type of the operand must be a pointer type whose "
866                      "element type is the same as that of the region argument");
867   }
868 
869   return verifySynchronizationHint(*this, hint_val());
870 }
871 
872 LogicalResult AtomicUpdateOp::verifyRegions() {
873   if (region().getNumArguments() != 1)
874     return emitError("the region must accept exactly one argument");
875 
876   if (region().front().getOperations().size() < 2)
877     return emitError() << "the update region must have at least two operations "
878                           "(binop and terminator)";
879 
880   YieldOp yieldOp = *region().getOps<YieldOp>().begin();
881 
882   if (yieldOp.results().size() != 1)
883     return emitError("only updated value must be returned");
884   if (yieldOp.results().front().getType() != region().getArgument(0).getType())
885     return emitError("input and yielded value must have the same type");
886   return success();
887 }
888 
889 //===----------------------------------------------------------------------===//
890 // Verifier for AtomicCaptureOp
891 //===----------------------------------------------------------------------===//
892 
893 Operation *AtomicCaptureOp::getFirstOp() {
894   return &getRegion().front().getOperations().front();
895 }
896 
897 Operation *AtomicCaptureOp::getSecondOp() {
898   auto &ops = getRegion().front().getOperations();
899   return ops.getNextNode(ops.front());
900 }
901 
902 AtomicReadOp AtomicCaptureOp::getAtomicReadOp() {
903   if (auto op = dyn_cast<AtomicReadOp>(getFirstOp()))
904     return op;
905   return dyn_cast<AtomicReadOp>(getSecondOp());
906 }
907 
908 AtomicWriteOp AtomicCaptureOp::getAtomicWriteOp() {
909   if (auto op = dyn_cast<AtomicWriteOp>(getFirstOp()))
910     return op;
911   return dyn_cast<AtomicWriteOp>(getSecondOp());
912 }
913 
914 AtomicUpdateOp AtomicCaptureOp::getAtomicUpdateOp() {
915   if (auto op = dyn_cast<AtomicUpdateOp>(getFirstOp()))
916     return op;
917   return dyn_cast<AtomicUpdateOp>(getSecondOp());
918 }
919 
920 LogicalResult AtomicCaptureOp::verify() {
921   return verifySynchronizationHint(*this, hint_val());
922 }
923 
924 LogicalResult AtomicCaptureOp::verifyRegions() {
925   Block::OpListType &ops = region().front().getOperations();
926   if (ops.size() != 3)
927     return emitError()
928            << "expected three operations in omp.atomic.capture region (one "
929               "terminator, and two atomic ops)";
930   auto &firstOp = ops.front();
931   auto &secondOp = *ops.getNextNode(firstOp);
932   auto firstReadStmt = dyn_cast<AtomicReadOp>(firstOp);
933   auto firstUpdateStmt = dyn_cast<AtomicUpdateOp>(firstOp);
934   auto secondReadStmt = dyn_cast<AtomicReadOp>(secondOp);
935   auto secondUpdateStmt = dyn_cast<AtomicUpdateOp>(secondOp);
936   auto secondWriteStmt = dyn_cast<AtomicWriteOp>(secondOp);
937 
938   if (!((firstUpdateStmt && secondReadStmt) ||
939         (firstReadStmt && secondUpdateStmt) ||
940         (firstReadStmt && secondWriteStmt)))
941     return ops.front().emitError()
942            << "invalid sequence of operations in the capture region";
943   if (firstUpdateStmt && secondReadStmt &&
944       firstUpdateStmt.x() != secondReadStmt.x())
945     return firstUpdateStmt.emitError()
946            << "updated variable in omp.atomic.update must be captured in "
947               "second operation";
948   if (firstReadStmt && secondUpdateStmt &&
949       firstReadStmt.x() != secondUpdateStmt.x())
950     return firstReadStmt.emitError()
951            << "captured variable in omp.atomic.read must be updated in second "
952               "operation";
953   if (firstReadStmt && secondWriteStmt &&
954       firstReadStmt.x() != secondWriteStmt.address())
955     return firstReadStmt.emitError()
956            << "captured variable in omp.atomic.read must be updated in "
957               "second operation";
958 
959   if (getFirstOp()->getAttr("hint_val") || getSecondOp()->getAttr("hint_val"))
960     return emitOpError(
961         "operations inside capture region must not have hint clause");
962   return success();
963 }
964 
965 #define GET_ATTRDEF_CLASSES
966 #include "mlir/Dialect/OpenMP/OpenMPOpsAttributes.cpp.inc"
967 
968 #define GET_OP_CLASSES
969 #include "mlir/Dialect/OpenMP/OpenMPOps.cpp.inc"
970