Skip to content

[mlir][Vector] add vector.insert canonicalization pattern for vectors created from ub.poison #142944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 136 additions & 7 deletions mlir/lib/Dialect/Vector/IR/VectorOps.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3149,6 +3149,18 @@ LogicalResult InsertOp::verify() {
return success();
}

// Calculate the linearized position of the continuous chunk of elements to
// insert, based on the shape of the value to insert and the positions to insert
// at.
static int64_t calculateInsertPosition(VectorType destTy,
ArrayRef<int64_t> positions) {
llvm::SmallVector<int64_t> completePositions(destTy.getRank(), 0);
assert(positions.size() <= completePositions.size() &&
"positions size must be less than or equal to destTy rank");
copy(positions, completePositions.begin());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably assert we are not copying past the end of the buffer.

return linearize(completePositions, computeStrides(destTy.getShape()));
}

namespace {

// If insertOp is only inserting unit dimensions it can be transformed to a
Expand Down Expand Up @@ -3191,6 +3203,126 @@ class InsertSplatToSplat final : public OpRewritePattern<InsertOp> {
}
};

/// Pattern to optimize a chain of insertions.
///
/// This pattern identifies chains of vector.insert operations that:
/// 1. Only insert values at static positions.
/// 2. Completely initialize all elements in the resulting vector.
/// 3. All intermediate insert operations have only one use.
///
/// When these conditions are met, the entire chain can be replaced with a
/// single vector.from_elements operation.
///
/// Example transformation:
/// %poison = ub.poison : vector<2xi32>
/// %0 = vector.insert %c1, %poison[0] : i32 into vector<2xi32>
/// %1 = vector.insert %c2, %0[1] : i32 into vector<2xi32>
/// ->
/// %result = vector.from_elements %c1, %c2 : vector<2xi32>
class InsertChainFullyInitialized final : public OpRewritePattern<InsertOp> {
public:
using OpRewritePattern::OpRewritePattern;
LogicalResult matchAndRewrite(InsertOp op,
PatternRewriter &rewriter) const override {

VectorType destTy = op.getDestVectorType();
if (destTy.isScalable())
return failure();
// Check if the result is used as the dest operand of another vector.insert
// Only care about the last op in a chain of insertions.
for (Operation *user : op.getResult().getUsers())
if (auto insertOp = dyn_cast<InsertOp>(user))
if (insertOp.getDest() == op.getResult())
return failure();

InsertOp currentOp = op;
SmallVector<InsertOp> chainInsertOps;
while (currentOp) {
// Dynamic position is not supported.
if (currentOp.hasDynamicPosition())
return failure();

chainInsertOps.push_back(currentOp);
currentOp = currentOp.getDest().getDefiningOp<InsertOp>();
// Check that intermediate inserts have only one use to avoid an explosion
// of vectors.
if (currentOp && !currentOp->hasOneUse())
return failure();
}

int64_t vectorSize = destTy.getNumElements();
int64_t initializedCount = 0;
SmallVector<bool> initialized(vectorSize, false);
SmallVector<int64_t> pendingInsertPos;
SmallVector<int64_t> pendingInsertSize;
SmallVector<Value> pendingInsertValues;

for (auto insertOp : chainInsertOps) {
// The insert op folder will fold an insert at poison index into a
// ub.poison, which truncates the insert chain's backward traversal.
if (is_contained(insertOp.getStaticPosition(), InsertOp::kPoisonIndex))
return failure();

// Calculate the linearized position for inserting elements.
int64_t insertBeginPosition =
calculateInsertPosition(destTy, insertOp.getStaticPosition());

// The valueToStore operand may be a vector or a scalar. Need to handle
// both cases.
int64_t insertSize = 1;
if (auto srcVectorType =
llvm::dyn_cast<VectorType>(insertOp.getValueToStoreType()))
insertSize = srcVectorType.getNumElements();

assert(insertBeginPosition + insertSize <= vectorSize &&
"insert would overflow the vector");

for (auto index : llvm::seq<int64_t>(insertBeginPosition,
insertBeginPosition + insertSize)) {
if (initialized[index])
continue;
initialized[index] = true;
++initializedCount;
}

// Defer the creation of ops before we can make sure the pattern can
// succeed.
pendingInsertPos.push_back(insertBeginPosition);
pendingInsertSize.push_back(insertSize);
pendingInsertValues.push_back(insertOp.getValueToStore());

if (initializedCount == vectorSize)
break;
}

// Final check: all positions must be initialized
if (initializedCount != vectorSize)
return failure();

SmallVector<Value> elements(vectorSize);
for (auto [insertBeginPosition, insertSize, valueToStore] :
llvm::reverse(llvm::zip(pendingInsertPos, pendingInsertSize,
pendingInsertValues))) {
if (auto srcVectorType =
llvm::dyn_cast<VectorType>(valueToStore.getType())) {
SmallVector<int64_t> strides = computeStrides(srcVectorType.getShape());
// Get all elements from the vector in row-major order.
for (int64_t linearIdx = 0; linearIdx < insertSize; linearIdx++) {
SmallVector<int64_t> position = delinearize(linearIdx, strides);
Value extractedElement = rewriter.create<vector::ExtractOp>(
op.getLoc(), valueToStore, position);
elements[insertBeginPosition + linearIdx] = extractedElement;
}
} else {
elements[insertBeginPosition] = valueToStore;
}
}

rewriter.replaceOpWithNewOp<vector::FromElementsOp>(op, destTy, elements);
return success();
}
};

} // namespace

static Attribute
Expand All @@ -3217,13 +3349,9 @@ foldDenseElementsAttrDestInsertOp(InsertOp insertOp, Attribute srcAttr,
!insertOp->hasOneUse())
return {};

// Calculate the linearized position of the continuous chunk of elements to
// insert.
llvm::SmallVector<int64_t> completePositions(destTy.getRank(), 0);
copy(insertOp.getStaticPosition(), completePositions.begin());
// Calculate the linearized position for inserting elements.
int64_t insertBeginPosition =
linearize(completePositions, computeStrides(destTy.getShape()));

calculateInsertPosition(destTy, insertOp.getStaticPosition());
SmallVector<Attribute> insertedValues;
Type destEltType = destTy.getElementType();

Expand Down Expand Up @@ -3256,7 +3384,8 @@ foldDenseElementsAttrDestInsertOp(InsertOp insertOp, Attribute srcAttr,

void InsertOp::getCanonicalizationPatterns(RewritePatternSet &results,
MLIRContext *context) {
results.add<InsertToBroadcast, BroadcastFolder, InsertSplatToSplat>(context);
results.add<InsertToBroadcast, BroadcastFolder, InsertSplatToSplat,
InsertChainFullyInitialized>(context);
}

OpFoldResult vector::InsertOp::fold(FoldAdaptor adaptor) {
Expand Down
12 changes: 4 additions & 8 deletions mlir/test/Conversion/ConvertToSPIRV/vector-unroll.mlir
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,16 @@ func.func @vaddi_reduction(%arg0 : vector<8xi32>, %arg1 : vector<8xi32>) -> (i32
// CHECK-LABEL: @transpose
// CHECK-SAME: (%[[ARG0:.+]]: vector<3xi32>, %[[ARG1:.+]]: vector<3xi32>)
func.func @transpose(%arg0 : vector<2x3xi32>) -> (vector<3x2xi32>) {
// CHECK: %[[UB:.*]] = ub.poison : vector<2xi32>
// CHECK: %[[EXTRACT0:.*]] = vector.extract %[[ARG0]][0] : i32 from vector<3xi32>
// CHECK: %[[INSERT0:.*]]= vector.insert %[[EXTRACT0]], %[[UB]] [0] : i32 into vector<2xi32>
// CHECK: %[[EXTRACT1:.*]] = vector.extract %[[ARG1]][0] : i32 from vector<3xi32>
// CHECK: %[[INSERT1:.*]] = vector.insert %[[EXTRACT1]], %[[INSERT0]][1] : i32 into vector<2xi32>
// CHECK: %[[FROM_ELEMENTS0:.*]] = vector.from_elements %[[EXTRACT0]], %[[EXTRACT1]] : vector<2xi32>
// CHECK: %[[EXTRACT2:.*]] = vector.extract %[[ARG0]][1] : i32 from vector<3xi32>
// CHECK: %[[INSERT2:.*]] = vector.insert %[[EXTRACT2]], %[[UB]] [0] : i32 into vector<2xi32>
// CHECK: %[[EXTRACT3:.*]] = vector.extract %[[ARG1]][1] : i32 from vector<3xi32>
// CHECK: %[[INSERT3:.*]] = vector.insert %[[EXTRACT3]], %[[INSERT2]] [1] : i32 into vector<2xi32>
// CHECK: %[[FROM_ELEMENTS1:.*]] = vector.from_elements %[[EXTRACT2]], %[[EXTRACT3]] : vector<2xi32>
// CHECK: %[[EXTRACT4:.*]] = vector.extract %[[ARG0]][2] : i32 from vector<3xi32>
// CHECK: %[[INSERT4:.*]] = vector.insert %[[EXTRACT4]], %[[UB]] [0] : i32 into vector<2xi32>
// CHECK: %[[EXTRACT5:.*]] = vector.extract %[[ARG1]][2] : i32 from vector<3xi32>
// CHECK: %[[INSERT5:.*]] = vector.insert %[[EXTRACT5]], %[[INSERT4]] [1] : i32 into vector<2xi32>
// CHECK: return %[[INSERT1]], %[[INSERT3]], %[[INSERT5]] : vector<2xi32>, vector<2xi32>, vector<2xi32>
// CHECK: %[[FROM_ELEMENTS2:.*]] = vector.from_elements %[[EXTRACT4]], %[[EXTRACT5]] : vector<2xi32>
// CHECK: return %[[FROM_ELEMENTS0]], %[[FROM_ELEMENTS1]], %[[FROM_ELEMENTS2]] : vector<2xi32>, vector<2xi32>, vector<2xi32>
%0 = vector.transpose %arg0, [1, 0] : vector<2x3xi32> to vector<3x2xi32>
return %0 : vector<3x2xi32>
}
Loading
Loading