[flang-commits] [flang] [mlir][Interfaces] `LoopLikeOpInterface`: Expose mutable inits/yielded values (PR #69137)
Matthias Springer via flang-commits
flang-commits at lists.llvm.org
Sun Oct 15 19:51:30 PDT 2023
https://github.com/matthias-springer created https://github.com/llvm/llvm-project/pull/69137
Expose a `MutableOperandRange` instead of `ValueRange`/`OperandRange`. This allows users of this interface to change the yielded values and the init values. The names of the interface methods are the same as the auto-generated op accessor names (`get...()` returns `OperandRange`, `get...Mutable()` returns `MutableOperandRange`).
>From 0dfeec73cd2960c9421f03b1f976e29673c1a73f Mon Sep 17 00:00:00 2001
From: Matthias Springer <springerm at google.com>
Date: Mon, 16 Oct 2023 11:45:59 +0900
Subject: [PATCH] [mlir][Interfaces] `LoopLikeOpInterface`: Expose mutable
inits/yielded values
Expose a `MutableOperandRange` instead of `ValueRange`/`OperandRange`. This allows users of this interface to change the yielded values and the init values. The names of the interface methods are the same as the auto-generated op accessor names (`get...()` returns `OperandRange`, `get...Mutable()` returns `MutableOperandRange`).
---
.../include/flang/Optimizer/Dialect/FIROps.td | 20 ++++++++----
flang/lib/Optimizer/Dialect/FIROps.cpp | 16 ++++++----
.../mlir/Dialect/Affine/IR/AffineOps.td | 2 +-
mlir/include/mlir/Dialect/SCF/IR/SCFOps.td | 11 +++----
.../mlir/Interfaces/LoopLikeInterface.td | 31 +++++++++++++------
mlir/lib/Dialect/Affine/IR/AffineOps.cpp | 4 +--
mlir/lib/Dialect/SCF/IR/SCF.cpp | 10 +++---
7 files changed, 59 insertions(+), 35 deletions(-)
diff --git a/flang/include/flang/Optimizer/Dialect/FIROps.td b/flang/include/flang/Optimizer/Dialect/FIROps.td
index 80d1635e50da24a..03c65d1bcc478bf 100644
--- a/flang/include/flang/Optimizer/Dialect/FIROps.td
+++ b/flang/include/flang/Optimizer/Dialect/FIROps.td
@@ -2063,7 +2063,8 @@ class region_Op<string mnemonic, list<Trait> traits = []> :
}
def fir_DoLoopOp : region_Op<"do_loop",
- [DeclareOpInterfaceMethods<LoopLikeOpInterface>]> {
+ [DeclareOpInterfaceMethods<LoopLikeOpInterface,
+ ["getYieldedValuesMutable"]>]> {
let summary = "generalized loop operation";
let description = [{
Generalized high-level looping construct. This operation is similar to
@@ -2119,8 +2120,11 @@ def fir_DoLoopOp : region_Op<"do_loop",
mlir::Operation::operand_range getIterOperands() {
return getOperands().drop_front(getNumControlOperands());
}
- mlir::OperandRange getInits() { return getIterOperands(); }
- mlir::ValueRange getYieldedValues();
+ mlir::MutableOperandRange getInitsMutable() {
+ return mlir::MutableOperandRange(
+ getOperation(), /*start=*/getNumControlOperands(),
+ /*length=*/getOperands().size() - getNumControlOperands());
+ }
void setLowerBound(mlir::Value bound) { (*this)->setOperand(0, bound); }
void setUpperBound(mlir::Value bound) { (*this)->setOperand(1, bound); }
@@ -2207,7 +2211,8 @@ def fir_IfOp : region_Op<"if", [DeclareOpInterfaceMethods<RegionBranchOpInterfac
}
def fir_IterWhileOp : region_Op<"iterate_while",
- [DeclareOpInterfaceMethods<LoopLikeOpInterface>]> {
+ [DeclareOpInterfaceMethods<LoopLikeOpInterface,
+ ["getYieldedValuesMutable"]>]> {
let summary = "DO loop with early exit condition";
let description = [{
This single-entry, single-exit looping construct is useful for lowering
@@ -2272,8 +2277,11 @@ def fir_IterWhileOp : region_Op<"iterate_while",
mlir::Operation::operand_range getIterOperands() {
return getOperands().drop_front(getNumControlOperands());
}
- mlir::OperandRange getInits() { return getIterOperands(); }
- mlir::ValueRange getYieldedValues();
+ mlir::MutableOperandRange getInitsMutable() {
+ return mlir::MutableOperandRange(
+ getOperation(), /*start=*/getNumControlOperands(),
+ /*length=*/getOperands().size() - getNumControlOperands());
+ }
void setLowerBound(mlir::Value bound) { (*this)->setOperand(0, bound); }
void setUpperBound(mlir::Value bound) { (*this)->setOperand(1, bound); }
diff --git a/flang/lib/Optimizer/Dialect/FIROps.cpp b/flang/lib/Optimizer/Dialect/FIROps.cpp
index 38311832f20dd26..7b15651c82c2d34 100644
--- a/flang/lib/Optimizer/Dialect/FIROps.cpp
+++ b/flang/lib/Optimizer/Dialect/FIROps.cpp
@@ -1933,10 +1933,12 @@ mlir::Value fir::IterWhileOp::blockArgToSourceOp(unsigned blockArgNum) {
return {};
}
-mlir::ValueRange fir::IterWhileOp::getYieldedValues() {
+mlir::MutableOperandRange fir::IterWhileOp::getYieldedValuesMutable() {
auto *term = getRegion().front().getTerminator();
- return getFinalValue() ? term->getOperands().drop_front()
- : term->getOperands();
+ return getFinalValue()
+ ? MutableOperandRange(term, /*start=*/1,
+ term->getNumOperands() - 1)
+ : MutableOperandRange(term, /*start=*/0, term->getNumOperands());
}
//===----------------------------------------------------------------------===//
@@ -2244,10 +2246,12 @@ mlir::Value fir::DoLoopOp::blockArgToSourceOp(unsigned blockArgNum) {
return {};
}
-mlir::ValueRange fir::DoLoopOp::getYieldedValues() {
+mlir::MutableOperandRange fir::DoLoopOp::getYieldedValuesMutable() {
auto *term = getRegion().front().getTerminator();
- return getFinalValue() ? term->getOperands().drop_front()
- : term->getOperands();
+ return getFinalValue()
+ ? MutableOperandRange(term, /*start=*/1,
+ term->getNumOperands() - 1)
+ : MutableOperandRange(term, /*start=*/0, term->getNumOperands());
}
//===----------------------------------------------------------------------===//
diff --git a/mlir/include/mlir/Dialect/Affine/IR/AffineOps.td b/mlir/include/mlir/Dialect/Affine/IR/AffineOps.td
index 36fdf390a761744..f9578cf37d5d768 100644
--- a/mlir/include/mlir/Dialect/Affine/IR/AffineOps.td
+++ b/mlir/include/mlir/Dialect/Affine/IR/AffineOps.td
@@ -121,7 +121,7 @@ def AffineForOp : Affine_Op<"for",
ImplicitAffineTerminator, ConditionallySpeculatable,
RecursiveMemoryEffects, DeclareOpInterfaceMethods<LoopLikeOpInterface,
["getSingleInductionVar", "getSingleLowerBound", "getSingleStep",
- "getSingleUpperBound", "getYieldedValues",
+ "getSingleUpperBound", "getYieldedValuesMutable",
"replaceWithAdditionalYields"]>,
DeclareOpInterfaceMethods<RegionBranchOpInterface,
["getEntrySuccessorOperands"]>]> {
diff --git a/mlir/include/mlir/Dialect/SCF/IR/SCFOps.td b/mlir/include/mlir/Dialect/SCF/IR/SCFOps.td
index f2ea7dd868a377d..64c7ffcb16ca733 100644
--- a/mlir/include/mlir/Dialect/SCF/IR/SCFOps.td
+++ b/mlir/include/mlir/Dialect/SCF/IR/SCFOps.td
@@ -121,8 +121,8 @@ def ExecuteRegionOp : SCF_Op<"execute_region", [
def ForOp : SCF_Op<"for",
[AutomaticAllocationScope, DeclareOpInterfaceMethods<LoopLikeOpInterface,
- ["getInits", "getSingleInductionVar", "getSingleLowerBound",
- "getSingleStep", "getSingleUpperBound", "getYieldedValues",
+ ["getInitsMutable", "getSingleInductionVar", "getSingleLowerBound",
+ "getSingleStep", "getSingleUpperBound", "getYieldedValuesMutable",
"promoteIfSingleIteration", "replaceWithAdditionalYields"]>,
AllTypesMatch<["lowerBound", "upperBound", "step"]>,
ConditionallySpeculatable,
@@ -956,7 +956,8 @@ def ReduceReturnOp :
def WhileOp : SCF_Op<"while",
[DeclareOpInterfaceMethods<RegionBranchOpInterface,
["getEntrySuccessorOperands"]>,
- DeclareOpInterfaceMethods<LoopLikeOpInterface, ["getRegionIterArgs"]>,
+ DeclareOpInterfaceMethods<LoopLikeOpInterface,
+ ["getRegionIterArgs", "getYieldedValuesMutable"]>,
RecursiveMemoryEffects, SingleBlock]> {
let summary = "a generic 'while' loop";
let description = [{
@@ -1089,10 +1090,6 @@ def WhileOp : SCF_Op<"while",
ConditionOp getConditionOp();
YieldOp getYieldOp();
- /// Return the values that are yielded from the "after" region (by the
- /// scf.yield op).
- ValueRange getYieldedValues();
-
Block::BlockArgListType getBeforeArguments();
Block::BlockArgListType getAfterArguments();
Block *getBeforeBody() { return &getBefore().front(); }
diff --git a/mlir/include/mlir/Interfaces/LoopLikeInterface.td b/mlir/include/mlir/Interfaces/LoopLikeInterface.td
index 4d2a66dd3143d28..d1aca26a644be22 100644
--- a/mlir/include/mlir/Interfaces/LoopLikeInterface.td
+++ b/mlir/include/mlir/Interfaces/LoopLikeInterface.td
@@ -130,15 +130,15 @@ def LoopLikeOpInterface : OpInterface<"LoopLikeOpInterface"> {
}]
>,
InterfaceMethod<[{
- Return the "init" operands that are used as initialization values for
- the region "iter_args" of this loop.
+ Return the mutable "init" operands that are used as initialization
+ values for the region "iter_args" of this loop.
}],
- /*retTy=*/"::mlir::OperandRange",
- /*methodName=*/"getInits",
+ /*retTy=*/"::mlir::MutableOperandRange",
+ /*methodName=*/"getInitsMutable",
/*args=*/(ins),
/*methodBody=*/"",
/*defaultImplementation=*/[{
- return ::mlir::OperandRange($_op->operand_end(), $_op->operand_end());
+ return ::mlir::MutableOperandRange(nullptr, /*start=*/0, /*length=*/0);
}]
>,
InterfaceMethod<[{
@@ -155,14 +155,15 @@ def LoopLikeOpInterface : OpInterface<"LoopLikeOpInterface"> {
}]
>,
InterfaceMethod<[{
- Return the values that are yielded to the next iteration.
+ Return the mutable operand range of values that are yielded to the next
+ iteration by the loop terminator.
}],
- /*retTy=*/"::mlir::ValueRange",
- /*methodName=*/"getYieldedValues",
+ /*retTy=*/"::mlir::MutableOperandRange",
+ /*methodName=*/"getYieldedValuesMutable",
/*args=*/(ins),
/*methodBody=*/"",
/*defaultImplementation=*/[{
- return ::mlir::ValueRange();
+ return ::mlir::MutableOperandRange(nullptr, /*start=*/0, /*length=*/0);
}]
>,
InterfaceMethod<[{
@@ -215,6 +216,18 @@ def LoopLikeOpInterface : OpInterface<"LoopLikeOpInterface"> {
return SmallVector<Value>(newBBArgs);
});
}
+
+ /// Return the values that are yielded to the next iteration.
+ ::mlir::ValueRange getYieldedValues() {
+ ::mlir::OperandRange range = $_op.getYieldedValuesMutable();
+ return range;
+ }
+
+ /// Return the "init" operands that are used as initialization values for
+ /// the region "iter_args" of this loop.
+ ::mlir::OperandRange getInits() {
+ return getInitsMutable();
+ }
}];
let verifyWithRegions = 1;
diff --git a/mlir/lib/Dialect/Affine/IR/AffineOps.cpp b/mlir/lib/Dialect/Affine/IR/AffineOps.cpp
index f2b3171c1ab837b..2606fecb038c1a7 100644
--- a/mlir/lib/Dialect/Affine/IR/AffineOps.cpp
+++ b/mlir/lib/Dialect/Affine/IR/AffineOps.cpp
@@ -2215,8 +2215,8 @@ unsigned AffineForOp::getNumIterOperands() {
return getNumOperands() - lbMap.getNumInputs() - ubMap.getNumInputs();
}
-ValueRange AffineForOp::getYieldedValues() {
- return cast<AffineYieldOp>(getBody()->getTerminator()).getOperands();
+MutableOperandRange AffineForOp::getYieldedValuesMutable() {
+ return cast<AffineYieldOp>(getBody()->getTerminator()).getOperandsMutable();
}
void AffineForOp::print(OpAsmPrinter &p) {
diff --git a/mlir/lib/Dialect/SCF/IR/SCF.cpp b/mlir/lib/Dialect/SCF/IR/SCF.cpp
index 508227d6e7ce4b0..c07923c24bbf0fc 100644
--- a/mlir/lib/Dialect/SCF/IR/SCF.cpp
+++ b/mlir/lib/Dialect/SCF/IR/SCF.cpp
@@ -527,7 +527,7 @@ ParseResult ForOp::parse(OpAsmParser &parser, OperationState &result) {
SmallVector<Region *> ForOp::getLoopRegions() { return {&getRegion()}; }
-OperandRange ForOp::getInits() { return getInitArgs(); }
+MutableOperandRange ForOp::getInitsMutable() { return getInitArgsMutable(); }
FailureOr<LoopLikeOpInterface>
ForOp::replaceWithAdditionalYields(RewriterBase &rewriter,
@@ -1221,8 +1221,8 @@ std::optional<APInt> ForOp::getConstantStep() {
return {};
}
-ValueRange ForOp::getYieldedValues() {
- return cast<scf::YieldOp>(getBody()->getTerminator()).getResults();
+MutableOperandRange ForOp::getYieldedValuesMutable() {
+ return cast<scf::YieldOp>(getBody()->getTerminator()).getResultsMutable();
}
Speculation::Speculatability ForOp::getSpeculatability() {
@@ -3206,7 +3206,9 @@ YieldOp WhileOp::getYieldOp() {
return cast<YieldOp>(getAfterBody()->getTerminator());
}
-ValueRange WhileOp::getYieldedValues() { return getYieldOp().getResults(); }
+MutableOperandRange WhileOp::getYieldedValuesMutable() {
+ return getYieldOp().getResultsMutable();
+}
Block::BlockArgListType WhileOp::getBeforeArguments() {
return getBeforeBody()->getArguments();
More information about the flang-commits
mailing list