[mlir][spirv] Add pattern matching for arith.index_cast index to i1 for ArithToSPIRV #156031

ianayl · 2025-08-29T14:20:55Z

Currently, arith.index_cast gets converted to OpSConvert:

llvm-project/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp

Line 1331 in 9bf5bf3

TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>,

OpSConvert requires its operands to be of integer type, which poses an issue for i1 since SPIRV distinguishes between booleans and integers. As a result, the following example doesn't get converted, leaving behind illegal ops:

%0 = arith.index_cast %arg0 : index to i1

This PR adds additional logic to convert arith.index_casts to SPIRV dialect when casting from index to i1. Converting index_casts from i1 to index is submitted as #155729.

github-actions · 2025-08-29T14:21:13Z

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

llvmbot · 2025-08-29T14:53:50Z

@llvm/pr-subscribers-mlir

Author: Ian Li (ianayl)

Changes

Currently, arith.index_cast gets converted to OpSConvert:

llvm-project/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp

Line 1331 in 9bf5bf3

TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>,

OpSConvert requires its operands to be of integer type, which poses an issue for i1 since SPIRV distinguishes between booleans and integers. As a result, the following example doesn't get converted, leaving behind illegal ops:

%0 = arith.index_cast %arg0 : index to i1

This PR adds additional logic to convert arith.index_casts to SPIRV dialect when casting from index to i1. Converting index_casts from i1 to index is submitted as #155729.

Full diff: https://github.com/llvm/llvm-project/pull/156031.diff

2 Files Affected:

(modified) mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp (+31-1)
(modified) mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir (+11)

diff --git a/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp b/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
index 265293b83f84c..de43b5e7fb176 100644
--- a/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
+++ b/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
@@ -607,6 +607,36 @@ struct UIToFPI1Pattern final : public OpConversionPattern<arith::UIToFPOp> {
   }
 };
 
+//===----------------------------------------------------------------------===//
+// IndexCastOp
+//===----------------------------------------------------------------------===//
+
+/// Converts arith.index_cast to spirv.Select if the type of source is index.
+struct IndexCastIndexI1Pattern final : public OpConversionPattern<arith::IndexCastOp> {
+  using OpConversionPattern::OpConversionPattern;
+
+  LogicalResult
+  matchAndRewrite(arith::IndexCastOp op, OpAdaptor adaptor,
+                  ConversionPatternRewriter &rewriter) const override {
+    Type srcType = adaptor.getOperands().front().getType();
+    // Indexes have already been converted to its respective spirv type:
+    Type indexType = getTypeConverter<SPIRVTypeConverter>()->getIndexType();
+    if (srcType != indexType || !op.getType().isInteger(1))
+      return failure();
+
+    Type dstType = rewriter.getI1Type();
+    Location loc = op.getLoc();
+    Value zero = spirv::ConstantOp::getZero(dstType, loc, rewriter);
+    Value one = spirv::ConstantOp::getOne(dstType, loc, rewriter);
+    Value zeroIdx = spirv::ConstantOp::getZero(srcType, loc, rewriter);
+    auto isZero = spirv::IEqualOp::create(
+        rewriter, loc, dstType, zeroIdx, adaptor.getOperands().front());
+    // spriv.IEqual outputs i32, spirv.Select is used to truncate to i1:
+    rewriter.replaceOpWithNewOp<spirv::SelectOp>(op, dstType, isZero, zero, one);
+    return success();
+  }
+};
+
 //===----------------------------------------------------------------------===//
 // ExtSIOp
 //===----------------------------------------------------------------------===//
@@ -1328,7 +1358,7 @@ void mlir::arith::populateArithToSPIRVPatterns(
     TypeCastingOpPattern<arith::SIToFPOp, spirv::ConvertSToFOp>,
     TypeCastingOpPattern<arith::FPToUIOp, spirv::ConvertFToUOp>,
     TypeCastingOpPattern<arith::FPToSIOp, spirv::ConvertFToSOp>,
-    TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>,
+    TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>, IndexCastIndexI1Pattern,
     TypeCastingOpPattern<arith::IndexCastUIOp, spirv::UConvertOp>,
     TypeCastingOpPattern<arith::BitcastOp, spirv::BitcastOp>,
     CmpIOpBooleanPattern, CmpIOpPattern,
diff --git a/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir b/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
index 6e2352e706acc..3109edf5d87d6 100644
--- a/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
+++ b/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
@@ -734,6 +734,17 @@ func.func @index_castui4(%arg0: index) {
   return
 }
 
+// CHECK-LABEL: index_castindexi1
+func.func @index_castindexi1(%arg0 : index) {
+  // CHECK: %[[FALSE:.+]] = spirv.Constant false
+  // CHECK: %[[TRUE:.+]] = spirv.Constant true
+  // CHECK: %[[ZERO:.+]] = spirv.Constant 0 : i32
+  // CHECK: %[[IS_ZERO:.+]] = spirv.IEqual %[[ZERO]], %{{.+}} : i32
+  // CHECK: spirv.Select %[[IS_ZERO]], %[[FALSE]], %[[TRUE]] : i1, i1
+  %0 = arith.index_cast %arg0 : index to i1
+  return
+}
+
 // CHECK-LABEL: @bit_cast
 func.func @bit_cast(%arg0: vector<2xf32>, %arg1: i64) {
   // CHECK: spirv.Bitcast %{{.+}} : vector<2xf32> to vector<2xi32>

llvmbot · 2025-08-29T14:53:51Z

@llvm/pr-subscribers-mlir-spirv

Author: Ian Li (ianayl)

Changes

Currently, arith.index_cast gets converted to OpSConvert:

llvm-project/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp

Line 1331 in 9bf5bf3

TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>,

OpSConvert requires its operands to be of integer type, which poses an issue for i1 since SPIRV distinguishes between booleans and integers. As a result, the following example doesn't get converted, leaving behind illegal ops:

%0 = arith.index_cast %arg0 : index to i1

This PR adds additional logic to convert arith.index_casts to SPIRV dialect when casting from index to i1. Converting index_casts from i1 to index is submitted as #155729.

Full diff: https://github.com/llvm/llvm-project/pull/156031.diff

2 Files Affected:

(modified) mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp (+31-1)
(modified) mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir (+11)

diff --git a/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp b/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
index 265293b83f84c..de43b5e7fb176 100644
--- a/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
+++ b/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp
@@ -607,6 +607,36 @@ struct UIToFPI1Pattern final : public OpConversionPattern<arith::UIToFPOp> {
   }
 };
 
+//===----------------------------------------------------------------------===//
+// IndexCastOp
+//===----------------------------------------------------------------------===//
+
+/// Converts arith.index_cast to spirv.Select if the type of source is index.
+struct IndexCastIndexI1Pattern final : public OpConversionPattern<arith::IndexCastOp> {
+  using OpConversionPattern::OpConversionPattern;
+
+  LogicalResult
+  matchAndRewrite(arith::IndexCastOp op, OpAdaptor adaptor,
+                  ConversionPatternRewriter &rewriter) const override {
+    Type srcType = adaptor.getOperands().front().getType();
+    // Indexes have already been converted to its respective spirv type:
+    Type indexType = getTypeConverter<SPIRVTypeConverter>()->getIndexType();
+    if (srcType != indexType || !op.getType().isInteger(1))
+      return failure();
+
+    Type dstType = rewriter.getI1Type();
+    Location loc = op.getLoc();
+    Value zero = spirv::ConstantOp::getZero(dstType, loc, rewriter);
+    Value one = spirv::ConstantOp::getOne(dstType, loc, rewriter);
+    Value zeroIdx = spirv::ConstantOp::getZero(srcType, loc, rewriter);
+    auto isZero = spirv::IEqualOp::create(
+        rewriter, loc, dstType, zeroIdx, adaptor.getOperands().front());
+    // spriv.IEqual outputs i32, spirv.Select is used to truncate to i1:
+    rewriter.replaceOpWithNewOp<spirv::SelectOp>(op, dstType, isZero, zero, one);
+    return success();
+  }
+};
+
 //===----------------------------------------------------------------------===//
 // ExtSIOp
 //===----------------------------------------------------------------------===//
@@ -1328,7 +1358,7 @@ void mlir::arith::populateArithToSPIRVPatterns(
     TypeCastingOpPattern<arith::SIToFPOp, spirv::ConvertSToFOp>,
     TypeCastingOpPattern<arith::FPToUIOp, spirv::ConvertFToUOp>,
     TypeCastingOpPattern<arith::FPToSIOp, spirv::ConvertFToSOp>,
-    TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>,
+    TypeCastingOpPattern<arith::IndexCastOp, spirv::SConvertOp>, IndexCastIndexI1Pattern,
     TypeCastingOpPattern<arith::IndexCastUIOp, spirv::UConvertOp>,
     TypeCastingOpPattern<arith::BitcastOp, spirv::BitcastOp>,
     CmpIOpBooleanPattern, CmpIOpPattern,
diff --git a/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir b/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
index 6e2352e706acc..3109edf5d87d6 100644
--- a/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
+++ b/mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir
@@ -734,6 +734,17 @@ func.func @index_castui4(%arg0: index) {
   return
 }
 
+// CHECK-LABEL: index_castindexi1
+func.func @index_castindexi1(%arg0 : index) {
+  // CHECK: %[[FALSE:.+]] = spirv.Constant false
+  // CHECK: %[[TRUE:.+]] = spirv.Constant true
+  // CHECK: %[[ZERO:.+]] = spirv.Constant 0 : i32
+  // CHECK: %[[IS_ZERO:.+]] = spirv.IEqual %[[ZERO]], %{{.+}} : i32
+  // CHECK: spirv.Select %[[IS_ZERO]], %[[FALSE]], %[[TRUE]] : i1, i1
+  %0 = arith.index_cast %arg0 : index to i1
+  return
+}
+
 // CHECK-LABEL: @bit_cast
 func.func @bit_cast(%arg0: vector<2xf32>, %arg1: i64) {
   // CHECK: spirv.Bitcast %{{.+}} : vector<2xf32> to vector<2xi32>

ianayl · 2025-08-29T14:56:36Z

@mshahneo Could I get a review from you as well please? It looks like I can't actually add reviewers to the PR

github-actions · 2025-08-29T15:09:12Z

✅ With the latest revision this PR passed the C/C++ code formatter.

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp

Co-authored-by: Md Abdullah Shahneous Bari <[email protected]>

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir

kuhar

LGTM % formatting nits

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir

Co-authored-by: Jakub Kuderski <[email protected]>

kuhar · 2025-09-03T16:17:33Z

@ianayl I'm going to merge this once the CI passes

github-actions · 2025-09-03T16:49:12Z

@ianayl Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

…or ArithToSPIRV (#155729) Currently, `arith.index_cast` gets converted to `OpSConvert`: https://github.com/llvm/llvm-project/blob/9bf5bf3baf3c7aec82cdd235c6a2fd57b4dd55ab/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp#L1331 [OpSConvert requires its operands to be of integer type](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#OpSConvert), which poses an issue for `i1` since SPIRV distinguishes between booleans and integers. As a result, the following example doesn't get converted, leaving behind illegal ops: ``` %0 = arith.index_cast %arg0 : i1 to index ``` This PR adds additional logic to convert `arith.index_casts` to SPIRV dialect when casting from `i1` to `index`. Converting `index_cast`s from `index` to `i1` is a part of #156031.

… to index for ArithToSPIRV (#155729) Currently, `arith.index_cast` gets converted to `OpSConvert`: https://github.com/llvm/llvm-project/blob/9bf5bf3baf3c7aec82cdd235c6a2fd57b4dd55ab/mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp#L1331 [OpSConvert requires its operands to be of integer type](https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#OpSConvert), which poses an issue for `i1` since SPIRV distinguishes between booleans and integers. As a result, the following example doesn't get converted, leaving behind illegal ops: ``` %0 = arith.index_cast %arg0 : i1 to index ``` This PR adds additional logic to convert `arith.index_casts` to SPIRV dialect when casting from `i1` to `index`. Converting `index_cast`s from `index` to `i1` is a part of llvm/llvm-project#156031.

Add conversion from arith.index_cast index->i1 to SPIRV

6e1a6ab

ianayl mentioned this pull request Aug 29, 2025

[mlir][spirv] Add pattern matching for arith.index_cast i1 to index for ArithToSPIRV #155729

Merged

ianayl marked this pull request as ready for review August 29, 2025 14:53

ianayl requested review from antiagainst and kuhar as code owners August 29, 2025 14:53

llvmbot added mlir:spirv mlir labels Aug 29, 2025

mshahneo self-requested a review August 29, 2025 15:05

clang-format

c03e924

mshahneo reviewed Aug 29, 2025

View reviewed changes

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

ianayl and others added 4 commits August 29, 2025 09:17

remove redundant truncate

fa8db0a

clang-format

ca2e36a

Fix comment

fa93f78

Co-authored-by: Md Abdullah Shahneous Bari <[email protected]>

Amend comment

1ae814c

kuhar reviewed Aug 30, 2025

View reviewed changes

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

Apply reviewer comments

b5583a0

kuhar reviewed Sep 2, 2025

View reviewed changes

mlir/lib/Conversion/ArithToSPIRV/ArithToSPIRV.cpp Outdated Show resolved Hide resolved

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir Show resolved Hide resolved

ianayl added 3 commits September 2, 2025 10:16

clang-format

2815dbd

Fix compat with vector<?xi1>

cf86eb6

clang-format

68e6fb4

kuhar reviewed Sep 2, 2025

View reviewed changes

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir Show resolved Hide resolved

ianayl added 2 commits September 2, 2025 20:56

add support for single element vectors

eababdc

clang-format

ffc00d9

kuhar approved these changes Sep 3, 2025

View reviewed changes

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir Outdated Show resolved Hide resolved

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir Outdated Show resolved Hide resolved

mlir/test/Conversion/ArithToSPIRV/arith-to-spirv.mlir Outdated Show resolved Hide resolved

Change arg spacing in mlir tests

5c2b72f

Co-authored-by: Jakub Kuderski <[email protected]>

kuhar merged commit c5a141b into llvm:main Sep 3, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[mlir][spirv] Add pattern matching for arith.index_cast index to i1 for ArithToSPIRV #156031

[mlir][spirv] Add pattern matching for arith.index_cast index to i1 for ArithToSPIRV #156031

ianayl commented Aug 29, 2025

Uh oh!

github-actions bot commented Aug 29, 2025

Uh oh!

llvmbot commented Aug 29, 2025

Uh oh!

llvmbot commented Aug 29, 2025

Uh oh!

ianayl commented Aug 29, 2025

Uh oh!

github-actions bot commented Aug 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuhar left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuhar commented Sep 3, 2025

Uh oh!

Uh oh!

github-actions bot commented Sep 3, 2025

Uh oh!

Uh oh!

[mlir][spirv] Add pattern matching for arith.index_cast index to i1 for ArithToSPIRV #156031

[mlir][spirv] Add pattern matching for arith.index_cast index to i1 for ArithToSPIRV #156031

Conversation

ianayl commented Aug 29, 2025

Uh oh!

github-actions bot commented Aug 29, 2025

Uh oh!

llvmbot commented Aug 29, 2025

Uh oh!

llvmbot commented Aug 29, 2025

Uh oh!

ianayl commented Aug 29, 2025

Uh oh!

github-actions bot commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuhar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuhar commented Sep 3, 2025

Uh oh!

Uh oh!

github-actions bot commented Sep 3, 2025

Uh oh!

Uh oh!

github-actions bot commented Aug 29, 2025 •

edited

Loading