1 //===- Async.cpp - MLIR Async Operations ----------------------------------===//
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 #include "mlir/Dialect/Async/IR/Async.h"
10 
11 #include "mlir/IR/DialectImplementation.h"
12 #include "llvm/ADT/TypeSwitch.h"
13 
14 using namespace mlir;
15 using namespace mlir::async;
16 
17 #include "mlir/Dialect/Async/IR/AsyncOpsDialect.cpp.inc"
18 
19 constexpr StringRef AsyncDialect::kAllowedToBlockAttrName;
20 
21 void AsyncDialect::initialize() {
22   addOperations<
23 #define GET_OP_LIST
24 #include "mlir/Dialect/Async/IR/AsyncOps.cpp.inc"
25       >();
26   addTypes<
27 #define GET_TYPEDEF_LIST
28 #include "mlir/Dialect/Async/IR/AsyncOpsTypes.cpp.inc"
29       >();
30 }
31 
32 //===----------------------------------------------------------------------===//
33 // YieldOp
34 //===----------------------------------------------------------------------===//
35 
36 static LogicalResult verify(YieldOp op) {
37   // Get the underlying value types from async values returned from the
38   // parent `async.execute` operation.
39   auto executeOp = op->getParentOfType<ExecuteOp>();
40   auto types = llvm::map_range(executeOp.results(), [](const OpResult &result) {
41     return result.getType().cast<ValueType>().getValueType();
42   });
43 
44   if (op.getOperandTypes() != types)
45     return op.emitOpError("operand types do not match the types returned from "
46                           "the parent ExecuteOp");
47 
48   return success();
49 }
50 
51 MutableOperandRange
52 YieldOp::getMutableSuccessorOperands(Optional<unsigned> index) {
53   assert(!index.hasValue());
54   return operandsMutable();
55 }
56 
57 //===----------------------------------------------------------------------===//
58 /// ExecuteOp
59 //===----------------------------------------------------------------------===//
60 
61 constexpr char kOperandSegmentSizesAttr[] = "operand_segment_sizes";
62 
63 void ExecuteOp::getNumRegionInvocations(
64     ArrayRef<Attribute>, SmallVectorImpl<int64_t> &countPerRegion) {
65   assert(countPerRegion.empty());
66   countPerRegion.push_back(1);
67 }
68 
69 OperandRange ExecuteOp::getSuccessorEntryOperands(unsigned index) {
70   assert(index == 0 && "invalid region index");
71   return operands();
72 }
73 
74 void ExecuteOp::getSuccessorRegions(Optional<unsigned> index,
75                                     ArrayRef<Attribute>,
76                                     SmallVectorImpl<RegionSuccessor> &regions) {
77   // The `body` region branch back to the parent operation.
78   if (index.hasValue()) {
79     assert(*index == 0 && "invalid region index");
80     regions.push_back(RegionSuccessor(results()));
81     return;
82   }
83 
84   // Otherwise the successor is the body region.
85   regions.push_back(RegionSuccessor(&body(), body().getArguments()));
86 }
87 
88 void ExecuteOp::build(OpBuilder &builder, OperationState &result,
89                       TypeRange resultTypes, ValueRange dependencies,
90                       ValueRange operands, BodyBuilderFn bodyBuilder) {
91 
92   result.addOperands(dependencies);
93   result.addOperands(operands);
94 
95   // Add derived `operand_segment_sizes` attribute based on parsed operands.
96   int32_t numDependencies = dependencies.size();
97   int32_t numOperands = operands.size();
98   auto operandSegmentSizes = DenseIntElementsAttr::get(
99       VectorType::get({2}, builder.getIntegerType(32)),
100       {numDependencies, numOperands});
101   result.addAttribute(kOperandSegmentSizesAttr, operandSegmentSizes);
102 
103   // First result is always a token, and then `resultTypes` wrapped into
104   // `async.value`.
105   result.addTypes({TokenType::get(result.getContext())});
106   for (Type type : resultTypes)
107     result.addTypes(ValueType::get(type));
108 
109   // Add a body region with block arguments as unwrapped async value operands.
110   Region *bodyRegion = result.addRegion();
111   bodyRegion->push_back(new Block);
112   Block &bodyBlock = bodyRegion->front();
113   for (Value operand : operands) {
114     auto valueType = operand.getType().dyn_cast<ValueType>();
115     bodyBlock.addArgument(valueType ? valueType.getValueType()
116                                     : operand.getType());
117   }
118 
119   // Create the default terminator if the builder is not provided and if the
120   // expected result is empty. Otherwise, leave this to the caller
121   // because we don't know which values to return from the execute op.
122   if (resultTypes.empty() && !bodyBuilder) {
123     OpBuilder::InsertionGuard guard(builder);
124     builder.setInsertionPointToStart(&bodyBlock);
125     builder.create<async::YieldOp>(result.location, ValueRange());
126   } else if (bodyBuilder) {
127     OpBuilder::InsertionGuard guard(builder);
128     builder.setInsertionPointToStart(&bodyBlock);
129     bodyBuilder(builder, result.location, bodyBlock.getArguments());
130   }
131 }
132 
133 static void print(OpAsmPrinter &p, ExecuteOp op) {
134   // [%tokens,...]
135   if (!op.dependencies().empty())
136     p << " [" << op.dependencies() << "]";
137 
138   // (%value as %unwrapped: !async.value<!arg.type>, ...)
139   if (!op.operands().empty()) {
140     p << " (";
141     Block *entry = op.body().empty() ? nullptr : &op.body().front();
142     llvm::interleaveComma(op.operands(), p, [&, n = 0](Value operand) mutable {
143       Value argument = entry ? entry->getArgument(n++) : Value();
144       p << operand << " as " << argument << ": " << operand.getType();
145     });
146     p << ")";
147   }
148 
149   // -> (!async.value<!return.type>, ...)
150   p.printOptionalArrowTypeList(llvm::drop_begin(op.getResultTypes()));
151   p.printOptionalAttrDictWithKeyword(op->getAttrs(),
152                                      {kOperandSegmentSizesAttr});
153   p.printRegion(op.body(), /*printEntryBlockArgs=*/false);
154 }
155 
156 static ParseResult parseExecuteOp(OpAsmParser &parser, OperationState &result) {
157   MLIRContext *ctx = result.getContext();
158 
159   // Sizes of parsed variadic operands, will be updated below after parsing.
160   int32_t numDependencies = 0;
161 
162   auto tokenTy = TokenType::get(ctx);
163 
164   // Parse dependency tokens.
165   if (succeeded(parser.parseOptionalLSquare())) {
166     SmallVector<OpAsmParser::OperandType, 4> tokenArgs;
167     if (parser.parseOperandList(tokenArgs) ||
168         parser.resolveOperands(tokenArgs, tokenTy, result.operands) ||
169         parser.parseRSquare())
170       return failure();
171 
172     numDependencies = tokenArgs.size();
173   }
174 
175   // Parse async value operands (%value as %unwrapped : !async.value<!type>).
176   SmallVector<OpAsmParser::OperandType, 4> valueArgs;
177   SmallVector<OpAsmParser::OperandType, 4> unwrappedArgs;
178   SmallVector<Type, 4> valueTypes;
179   SmallVector<Type, 4> unwrappedTypes;
180 
181   // Parse a single instance of `%value as %unwrapped : !async.value<!type>`.
182   auto parseAsyncValueArg = [&]() -> ParseResult {
183     if (parser.parseOperand(valueArgs.emplace_back()) ||
184         parser.parseKeyword("as") ||
185         parser.parseOperand(unwrappedArgs.emplace_back()) ||
186         parser.parseColonType(valueTypes.emplace_back()))
187       return failure();
188 
189     auto valueTy = valueTypes.back().dyn_cast<ValueType>();
190     unwrappedTypes.emplace_back(valueTy ? valueTy.getValueType() : Type());
191 
192     return success();
193   };
194 
195   auto argsLoc = parser.getCurrentLocation();
196   if (parser.parseCommaSeparatedList(OpAsmParser::Delimiter::OptionalParen,
197                                      parseAsyncValueArg) ||
198       parser.resolveOperands(valueArgs, valueTypes, argsLoc, result.operands))
199     return failure();
200 
201   int32_t numOperands = valueArgs.size();
202 
203   // Add derived `operand_segment_sizes` attribute based on parsed operands.
204   auto operandSegmentSizes = DenseIntElementsAttr::get(
205       VectorType::get({2}, parser.getBuilder().getI32Type()),
206       {numDependencies, numOperands});
207   result.addAttribute(kOperandSegmentSizesAttr, operandSegmentSizes);
208 
209   // Parse the types of results returned from the async execute op.
210   SmallVector<Type, 4> resultTypes;
211   if (parser.parseOptionalArrowTypeList(resultTypes))
212     return failure();
213 
214   // Async execute first result is always a completion token.
215   parser.addTypeToList(tokenTy, result.types);
216   parser.addTypesToList(resultTypes, result.types);
217 
218   // Parse operation attributes.
219   NamedAttrList attrs;
220   if (parser.parseOptionalAttrDictWithKeyword(attrs))
221     return failure();
222   result.addAttributes(attrs);
223 
224   // Parse asynchronous region.
225   Region *body = result.addRegion();
226   if (parser.parseRegion(*body, /*arguments=*/{unwrappedArgs},
227                          /*argTypes=*/{unwrappedTypes},
228                          /*enableNameShadowing=*/false))
229     return failure();
230 
231   return success();
232 }
233 
234 static LogicalResult verify(ExecuteOp op) {
235   // Unwrap async.execute value operands types.
236   auto unwrappedTypes = llvm::map_range(op.operands(), [](Value operand) {
237     return operand.getType().cast<ValueType>().getValueType();
238   });
239 
240   // Verify that unwrapped argument types matches the body region arguments.
241   if (op.body().getArgumentTypes() != unwrappedTypes)
242     return op.emitOpError("async body region argument types do not match the "
243                           "execute operation arguments types");
244 
245   return success();
246 }
247 
248 //===----------------------------------------------------------------------===//
249 /// CreateGroupOp
250 //===----------------------------------------------------------------------===//
251 
252 LogicalResult CreateGroupOp::canonicalize(CreateGroupOp op,
253                                           PatternRewriter &rewriter) {
254   // Find all `await_all` users of the group.
255   llvm::SmallVector<AwaitAllOp> awaitAllUsers;
256 
257   auto isAwaitAll = [&](Operation *op) -> bool {
258     if (AwaitAllOp awaitAll = dyn_cast<AwaitAllOp>(op)) {
259       awaitAllUsers.push_back(awaitAll);
260       return true;
261     }
262     return false;
263   };
264 
265   // Check if all users of the group are `await_all` operations.
266   if (!llvm::all_of(op->getUsers(), isAwaitAll))
267     return failure();
268 
269   // If group is only awaited without adding anything to it, we can safely erase
270   // the create operation and all users.
271   for (AwaitAllOp awaitAll : awaitAllUsers)
272     rewriter.eraseOp(awaitAll);
273   rewriter.eraseOp(op);
274 
275   return success();
276 }
277 
278 //===----------------------------------------------------------------------===//
279 /// AwaitOp
280 //===----------------------------------------------------------------------===//
281 
282 void AwaitOp::build(OpBuilder &builder, OperationState &result, Value operand,
283                     ArrayRef<NamedAttribute> attrs) {
284   result.addOperands({operand});
285   result.attributes.append(attrs.begin(), attrs.end());
286 
287   // Add unwrapped async.value type to the returned values types.
288   if (auto valueType = operand.getType().dyn_cast<ValueType>())
289     result.addTypes(valueType.getValueType());
290 }
291 
292 static ParseResult parseAwaitResultType(OpAsmParser &parser, Type &operandType,
293                                         Type &resultType) {
294   if (parser.parseType(operandType))
295     return failure();
296 
297   // Add unwrapped async.value type to the returned values types.
298   if (auto valueType = operandType.dyn_cast<ValueType>())
299     resultType = valueType.getValueType();
300 
301   return success();
302 }
303 
304 static void printAwaitResultType(OpAsmPrinter &p, Operation *op,
305                                  Type operandType, Type resultType) {
306   p << operandType;
307 }
308 
309 static LogicalResult verify(AwaitOp op) {
310   Type argType = op.operand().getType();
311 
312   // Awaiting on a token does not have any results.
313   if (argType.isa<TokenType>() && !op.getResultTypes().empty())
314     return op.emitOpError("awaiting on a token must have empty result");
315 
316   // Awaiting on a value unwraps the async value type.
317   if (auto value = argType.dyn_cast<ValueType>()) {
318     if (*op.getResultType() != value.getValueType())
319       return op.emitOpError()
320              << "result type " << *op.getResultType()
321              << " does not match async value type " << value.getValueType();
322   }
323 
324   return success();
325 }
326 
327 //===----------------------------------------------------------------------===//
328 // TableGen'd op method definitions
329 //===----------------------------------------------------------------------===//
330 
331 #define GET_OP_CLASSES
332 #include "mlir/Dialect/Async/IR/AsyncOps.cpp.inc"
333 
334 //===----------------------------------------------------------------------===//
335 // TableGen'd type method definitions
336 //===----------------------------------------------------------------------===//
337 
338 #define GET_TYPEDEF_CLASSES
339 #include "mlir/Dialect/Async/IR/AsyncOpsTypes.cpp.inc"
340 
341 void ValueType::print(DialectAsmPrinter &printer) const {
342   printer << "<";
343   printer.printType(getValueType());
344   printer << '>';
345 }
346 
347 Type ValueType::parse(mlir::DialectAsmParser &parser) {
348   Type ty;
349   if (parser.parseLess() || parser.parseType(ty) || parser.parseGreater()) {
350     parser.emitError(parser.getNameLoc(), "failed to parse async value type");
351     return Type();
352   }
353   return ValueType::get(ty);
354 }
355 
356 /// Print a type registered to this dialect.
357 void AsyncDialect::printType(Type type, DialectAsmPrinter &os) const {
358   if (failed(generatedTypePrinter(type, os)))
359     llvm_unreachable("unexpected 'async' type kind");
360 }
361 
362 /// Parse a type registered to this dialect.
363 Type AsyncDialect::parseType(DialectAsmParser &parser) const {
364   StringRef typeTag;
365   if (parser.parseKeyword(&typeTag))
366     return Type();
367   Type genType;
368   auto parseResult = generatedTypeParser(parser, typeTag, genType);
369   if (parseResult.hasValue())
370     return genType;
371   parser.emitError(parser.getNameLoc(), "unknown async type: ") << typeTag;
372   return {};
373 }
374