[mlir] Rename arith.addi_carry to arith.addui_carry

[kuhar]

Summary

The intention is to have this op lowered to
llvm.intr.uadd.with.overflow or spv.IAddCarry. LLVM has a second
intrinsic for signed add-with-overflow, llvm.intr.sadd.with.overflow,
with different semantics. Therefore we should have 2 ops with arith,
and be explicit about signed/unsigned semantics.

Rename arith.addi_carry to arith.addui_carry before we introduce a
signed version of this op: arith.addsi_carry.

mlir/include/mlir/Dialect/Arithmetic/IR/ArithmeticOps.td

let description = [{
     %x = arith.addi %y, %z : tensor<4x?xi8>
     ```
   }];
   let hasFolder = 1;
   let hasCanonicalizer = 1;
 }
 
 
-def Arith_AddICarryOp : Arith_Op<"addi_carry", [Commutative,
+def Arith_AddUICarryOp : Arith_Op<"addui_carry", [Commutative,
     AllTypesMatch<["lhs", "rhs", "sum"]>]> {
-  let summary = "integer addition operation returning both the sum and carry";
+  let summary = "unsigned integer addition operation returning sum and carry";
   let description = [{
-    The `addi_carry` operation takes two operands and returns two results: the
-    sum (same type as both operands), and the carry (boolean-like).
+    The `addui_carry` operation takes two operands and returns two results: the
+    sum (same type as both operands), and the carry (boolean-like). The carry
+    value `1` indicates unsigned addition overflow, while indicates `0` no
+    overflow.
 
     Example:
 
     ```mlir
     // Scalar addition.
-    %sum, %carry = arith.addi_carry %b, %c : i64, i1
+    %sum, %carry = arith.addui_carry %b, %c : i64, i1
 
     // Vector element-wise addition.
-    %b:2 = arith.addi_carry %g, %h : vector<4xi32>, vector<4xi1>
+    %b:2 = arith.addui_carry %g, %h : vector<4xi32>, vector<4xi1>
 
     // Tensor element-wise addition.
-    %c:2 = arith.addi_carry %y, %z : tensor<4x?xi8>, tensor<4x?xi1>
+    %c:2 = arith.addui_carry %y, %z : tensor<4x?xi8>, tensor<4x?xi1>
     ```
   }];
 
   let arguments = (ins SignlessIntegerLike:$lhs, SignlessIntegerLike:$rhs);
   let results = (outs SignlessIntegerLike:$sum, BoolLike:$carry);
   let assemblyFormat = [{
     $lhs `,` $rhs attr-dict `:` type($sum) `,` type($carry)
   }];

mlir/lib/Conversion/ArithmeticToSPIRV/ArithmeticToSPIRV.cpp

 public:
   using OpConversionPattern<arith::CmpFOp>::OpConversionPattern;
 
   LogicalResult
   matchAndRewrite(arith::CmpFOp op, OpAdaptor adaptor,
                   ConversionPatternRewriter &rewriter) const override;
 };
 
-/// Converts arith.addi_carry to spv.IAddCarry.
-class AddICarryOpPattern final : public OpConversionPattern<arith::AddICarryOp> {
+/// Converts arith.addui_carry to spv.IAddCarry.
+class AddICarryOpPattern final
+    : public OpConversionPattern<arith::AddUICarryOp> {
 public:
-  using OpConversionPattern<arith::AddICarryOp>::OpConversionPattern;
+  using OpConversionPattern<arith::AddUICarryOp>::OpConversionPattern;
   LogicalResult
-  matchAndRewrite(arith::AddICarryOp op, OpAdaptor adaptor,
+  matchAndRewrite(arith::AddUICarryOp op, OpAdaptor adaptor,
                   ConversionPatternRewriter &rewriter) const override;
 };
 
 /// Converts arith.select to spv.Select.
 class SelectOpPattern final : public OpConversionPattern<arith::SelectOp> {
 public:
   using OpConversionPattern<arith::SelectOp>::OpConversionPattern;
   LogicalResult
LogicalResult CmpFOpNanNonePattern::matchAndRewrite(
   return success();
 }
 
 //===----------------------------------------------------------------------===//
 // AddICarryOpPattern
 //===----------------------------------------------------------------------===//
 
 LogicalResult
-AddICarryOpPattern::matchAndRewrite(arith::AddICarryOp op, OpAdaptor adaptor,
+AddICarryOpPattern::matchAndRewrite(arith::AddUICarryOp op, OpAdaptor adaptor,
                                     ConversionPatternRewriter &rewriter) const {
   Type dstElemTy = adaptor.getLhs().getType();
   auto resultTy = spirv::StructType::get({dstElemTy, dstElemTy});
 
   Location loc = op->getLoc();
   Value result = rewriter.create<spirv::IAddCarryOp>(
       loc, resultTy, adaptor.getLhs(), adaptor.getRhs());
 
   Value sumResult = rewriter.create<spirv::CompositeExtractOp>(
       loc, result, llvm::makeArrayRef(0));
   Value carryValue = rewriter.create<spirv::CompositeExtractOp>(
       loc, result, llvm::makeArrayRef(1));
 
   // Convert the carry value to boolean.
   Value one = spirv::ConstantOp::getOne(dstElemTy, loc, rewriter);
-  Value carryResult =
-      rewriter.create<spirv::IEqualOp>(loc, carryValue, one);
+  Value carryResult = rewriter.create<spirv::IEqualOp>(loc, carryValue, one);
 
   rewriter.replaceOp(op, {sumResult, carryResult});
   return success();
 }
 
 //===----------------------------------------------------------------------===//
 // SelectOpPattern
 //===----------------------------------------------------------------------===//

mlir/lib/Dialect/Arithmetic/IR/ArithmeticOps.cpp

 
 void arith::AddIOp::getCanonicalizationPatterns(RewritePatternSet &patterns,
                                                 MLIRContext *context) {
   patterns.add<AddIAddConstant, AddISubConstantRHS, AddISubConstantLHS>(
       context);
 }
 
 //===----------------------------------------------------------------------===//
-// AddICarryOp
+// AddUICarryOp
 //===----------------------------------------------------------------------===//
 
-Optional<SmallVector<int64_t, 4>> arith::AddICarryOp::getShapeForUnroll() {
+Optional<SmallVector<int64_t, 4>> arith::AddUICarryOp::getShapeForUnroll() {
   if (auto vt = getType(0).dyn_cast<VectorType>())
     return llvm::to_vector<4>(vt.getShape());
   return None;
 }
 
 // Returns the carry bit, assuming that `sum` is the result of addition of
 // `operand` and another number.
 static APInt calculateCarry(const APInt &sum, const APInt &operand) {
   return sum.ult(operand) ? APInt::getAllOnes(1) : APInt::getZero(1);
 }
 
-LogicalResult arith::AddICarryOp::fold(ArrayRef<Attribute> operands,
-                                       SmallVectorImpl<OpFoldResult> &results) {
+LogicalResult
+arith::AddUICarryOp::fold(ArrayRef<Attribute> operands,
   auto carryTy = getCarry().getType();
-  // addi_carry(x, 0) -> x, false
+  // addui_carry(x, 0) -> x, false
   if (matchPattern(getRhs(), m_Zero())) {
     auto carryZero = APInt::getZero(1);
     Builder builder(getContext());
     auto falseValue = builder.getZeroAttr(carryTy);
 
     results.push_back(getLhs());
     results.push_back(falseValue);
     return success();
   }
 
-  // addi_carry(constant_a, constant_b) -> constant_sum, constant_carry
+  // addui_carry(constant_a, constant_b) -> constant_sum, constant_carry
   // Let the `constFoldBinaryOp` utility attempt to fold the sum of both
   // operands. If that succeeds, calculate the carry boolean based on the sum
   // and the first (constant) operand, `lhs`. Note that we cannot simply call
   // `constFoldBinaryOp` again to calculate the carry (bit) because the
   // constructed attribute is of the same element type as both operands.
   if (Attribute sumAttr = constFoldBinaryOp<IntegerAttr>(
           operands, [](APInt a, const APInt &b) { return std::move(a) + b; })) {
     Attribute carryAttr;

mlir/test/Conversion/ArithmeticToSPIRV/arithmetic-to-spirv.mlir

func.func @index_scalar_srem(%lhs: index, %rhs: index) {
   // CHECK:  %[[POS:.+]] = spv.IEqual %[[LHS]], %[[LABS]] : i32
   // CHECK:  %[[NEG:.+]] = spv.SNegate %[[ABS]] : i32
   // CHECK:      %{{.+}} = spv.Select %[[POS]], %[[ABS]], %[[NEG]] : i1, i32
   %0 = arith.remsi %lhs, %rhs: index
   return
 }
 
 // Check integer add-with-carry conversions.
-// CHECK-LABEL: @int32_scalar_addi_carry
+// CHECK-LABEL: @int32_scalar_addui_carry
 // CHECK-SAME: (%[[LHS:.+]]: i32, %[[RHS:.+]]: i32)
-func.func @int32_scalar_addi_carry(%lhs: i32, %rhs: i32) -> (i32, i1) {
+func.func @int32_scalar_addui_carry(%lhs: i32, %rhs: i32) -> (i32, i1) {
   // CHECK-NEXT: %[[IAC:.+]] = spv.IAddCarry %[[LHS]], %[[RHS]] : !spv.struct<(i32, i32)>
   // CHECK-DAG:  %[[SUM:.+]] = spv.CompositeExtract %[[IAC]][0 : i32] : !spv.struct<(i32, i32)>
   // CHECK-DAG:  %[[C0:.+]]  = spv.CompositeExtract %[[IAC]][1 : i32] : !spv.struct<(i32, i32)>
   // CHECK-DAG:  %[[ONE:.+]] = spv.Constant 1 : i32
   // CHECK-NEXT: %[[C1:.+]]  = spv.IEqual %[[C0]], %[[ONE]] : i32
   // CHECK-NEXT: return %[[SUM]], %[[C1]] : i32, i1
-  %sum, %carry = arith.addi_carry %lhs, %rhs: i32, i1
+  %sum, %carry = arith.addui_carry %lhs, %rhs: i32, i1
   return %sum, %carry : i32, i1
 }
 
-// CHECK-LABEL: @int32_vector_addi_carry
+// CHECK-LABEL: @int32_vector_addui_carry
 // CHECK-SAME: (%[[LHS:.+]]: vector<4xi32>, %[[RHS:.+]]: vector<4xi32>)
-func.func @int32_vector_addi_carry(%lhs: vector<4xi32>, %rhs: vector<4xi32>) -> (vector<4xi32>, vector<4xi1>) {
+func.func @int32_vector_addui_carry(%lhs: vector<4xi32>, %rhs: vector<4xi32>) -> (vector<4xi32>, vector<4xi1>) {
   // CHECK-NEXT: %[[IAC:.+]] = spv.IAddCarry %[[LHS]], %[[RHS]] : !spv.struct<(vector<4xi32>, vector<4xi32>)>
   // CHECK-DAG:  %[[SUM:.+]] = spv.CompositeExtract %[[IAC]][0 : i32] : !spv.struct<(vector<4xi32>, vector<4xi32>)>
   // CHECK-DAG:  %[[C0:.+]]  = spv.CompositeExtract %[[IAC]][1 : i32] : !spv.struct<(vector<4xi32>, vector<4xi32>)>
   // CHECK-DAG:  %[[ONE:.+]] = spv.Constant dense<1> : vector<4xi32>
   // CHECK-NEXT: %[[C1:.+]]  = spv.IEqual %[[C0]], %[[ONE]] : vector<4xi32>
   // CHECK-NEXT: return %[[SUM]], %[[C1]] : vector<4xi32>, vector<4xi1>
-  %sum, %carry = arith.addi_carry %lhs, %rhs: vector<4xi32>, vector<4xi1>
+  %sum, %carry = arith.addui_carry %lhs, %rhs: vector<4xi32>, vector<4xi1>
   return %sum, %carry : vector<4xi32>, vector<4xi1>
 }
 
 // Check float unary operation conversions.
 // CHECK-LABEL: @float32_unary_scalar
 func.func @float32_unary_scalar(%arg0: f32) {
   // CHECK: spv.FNegate %{{.*}}: f32
   %0 = arith.negf %arg0 : f32

mlir/test/Dialect/Arithmetic/canonicalize.mlir

func.func @doubleAddSub2(%arg0: index, %arg1 : index) -> index {
   return %add : index
 }
 
 // CHECK-LABEL: @addiCarryZeroRhs
 //  CHECK-NEXT:   %[[false:.+]] = arith.constant false
 //  CHECK-NEXT:   return %arg0, %[[false]]
 func.func @addiCarryZeroRhs(%arg0: i32) -> (i32, i1) {
   %zero = arith.constant 0 : i32
-  %sum, %carry = arith.addi_carry %arg0, %zero: i32, i1
+  %sum, %carry = arith.addui_carry %arg0, %zero: i32, i1
   return %sum, %carry : i32, i1
 }
 
 // CHECK-LABEL: @addiCarryZeroRhsSplat
 //  CHECK-NEXT:   %[[false:.+]] = arith.constant dense<false> : vector<4xi1>
 //  CHECK-NEXT:   return %arg0, %[[false]]
 func.func @addiCarryZeroRhsSplat(%arg0: vector<4xi32>) -> (vector<4xi32>, vector<4xi1>) {
   %zero = arith.constant dense<0> : vector<4xi32>
-  %sum, %carry = arith.addi_carry %arg0, %zero: vector<4xi32>, vector<4xi1>
+  %sum, %carry = arith.addui_carry %arg0, %zero: vector<4xi32>, vector<4xi1>
   return %sum, %carry : vector<4xi32>, vector<4xi1>
 }
 
 // CHECK-LABEL: @addiCarryZeroLhs
 //  CHECK-NEXT:   %[[false:.+]] = arith.constant false
 //  CHECK-NEXT:   return %arg0, %[[false]]
 func.func @addiCarryZeroLhs(%arg0: i32) -> (i32, i1) {
   %zero = arith.constant 0 : i32
-  %sum, %carry = arith.addi_carry %zero, %arg0: i32, i1
+  %sum, %carry = arith.addui_carry %zero, %arg0: i32, i1
   return %sum, %carry : i32, i1
 }
 
 // CHECK-LABEL: @addiCarryConstants
 //  CHECK-DAG:    %[[false:.+]] = arith.constant false
 //  CHECK-DAG:    %[[c50:.+]] = arith.constant 50 : i32
 //  CHECK-NEXT:   return %[[c50]], %[[false]]
 func.func @addiCarryConstants() -> (i32, i1) {
   %c13 = arith.constant 13 : i32
   %c37 = arith.constant 37 : i32
-  %sum, %carry = arith.addi_carry %c13, %c37: i32, i1
+  %sum, %carry = arith.addui_carry %c13, %c37: i32, i1
   return %sum, %carry : i32, i1
 }
 
 // CHECK-LABEL: @addiCarryConstantsOverflow1
 //  CHECK-DAG:    %[[true:.+]] = arith.constant true
 //  CHECK-DAG:    %[[c0:.+]] = arith.constant 0 : i32
 //  CHECK-NEXT:   return %[[c0]], %[[true]]
 func.func @addiCarryConstantsOverflow1() -> (i32, i1) {
   %max = arith.constant 4294967295 : i32
   %c1 = arith.constant 1 : i32
-  %sum, %carry = arith.addi_carry %max, %c1: i32, i1
+  %sum, %carry = arith.addui_carry %max, %c1: i32, i1
   return %sum, %carry : i32, i1
 }
 
 // CHECK-LABEL: @addiCarryConstantsOverflow2
 //  CHECK-DAG:    %[[true:.+]] = arith.constant true
 //  CHECK-DAG:    %[[c_2:.+]] = arith.constant -2 : i32
 // CHECK-NEXT:    return %[[c_2]], %[[true]]
 func.func @addiCarryConstantsOverflow2() -> (i32, i1) {
   %max = arith.constant 4294967295 : i32
-  %sum, %carry = arith.addi_carry %max, %max: i32, i1
+  %sum, %carry = arith.addui_carry %max, %max: i32, i1
   return %sum, %carry : i32, i1
 }
 
 // CHECK-LABEL: @addiCarryConstantsOverflowVector
 //  CHECK-DAG:    %[[sum:.+]] = arith.constant dense<[1, 6, 2, 14]> : vector<4xi32>
 //  CHECK-DAG:    %[[carry:.+]] = arith.constant dense<[false, false, true, false]> : vector<4xi1>
 // CHECK-NEXT:    return %[[sum]], %[[carry]]
 func.func @addiCarryConstantsOverflowVector() -> (vector<4xi32>, vector<4xi1>) {
   %v1 = arith.constant dense<[1, 3, 3, 7]> : vector<4xi32>
   %v2 = arith.constant dense<[0, 3, 4294967295, 7]> : vector<4xi32>
-  %sum, %carry = arith.addi_carry %v1, %v2 : vector<4xi32>, vector<4xi1>
+  %sum, %carry = arith.addui_carry %v1, %v2 : vector<4xi32>, vector<4xi1>
   return %sum, %carry : vector<4xi32>, vector<4xi1>
 }
 
 // CHECK-LABEL: @addiCarryConstantsSplatVector
 //   CHECK-DAG:   %[[sum:.+]] = arith.constant dense<3> : vector<4xi32>
 //   CHECK-DAG:   %[[carry:.+]] = arith.constant dense<false> : vector<4xi1>
 //  CHECK-NEXT:   return %[[sum]], %[[carry]]
 func.func @addiCarryConstantsSplatVector() -> (vector<4xi32>, vector<4xi1>) {
   %v1 = arith.constant dense<1> : vector<4xi32>
   %v2 = arith.constant dense<2> : vector<4xi32>
-  %sum, %carry = arith.addi_carry %v1, %v2 : vector<4xi32>, vector<4xi1>
+  %sum, %carry = arith.addui_carry %v1, %v2 : vector<4xi32>, vector<4xi1>
   return %sum, %carry : vector<4xi32>, vector<4xi1>
 }
 
 // CHECK-LABEL: @notCmpEQ
 //       CHECK:   %[[cres:.+]] = arith.cmpi ne, %arg0, %arg1 : i8
 //       CHECK:   return %[[cres]]
 func.func @notCmpEQ(%arg0: i8, %arg1: i8) -> i1 {
   %true = arith.constant true

mlir/test/Dialect/Arithmetic/invalid.mlir

 ^bb0(%a : f32):
   // expected-error@+1 {{'arith.addi' op operand #0 must be signless-integer-like}}
   %sf = arith.addi %a, %a : f32
 }
 
 // -----
 
 func.func @func_with_ops(%a: f32) {
-  // expected-error@+1 {{'arith.addi_carry' op operand #0 must be signless-integer-like}}
-  %r:2 = arith.addi_carry %a, %a : f32, i32
+  // expected-error@+1 {{'arith.addui_carry' op operand #0 must be signless-integer-like}}
+  %r:2 = arith.addui_carry %a, %a : f32, i32
   return
 }
 
 // -----
 
 func.func @func_with_ops(%a: i32) {
-  // expected-error@+1 {{'arith.addi_carry' op result #1 must be bool-like}}
-  %r:2 = arith.addi_carry %a, %a : i32, i32
+  // expected-error@+1 {{'arith.addui_carry' op result #1 must be bool-like}}
+  %r:2 = arith.addui_carry %a, %a : i32, i32
   return
 }
 
 // -----
 
 func.func @func_with_ops(%a: vector<8xi32>) {
-  // expected-error@+1 {{'arith.addi_carry' op if an operand is non-scalar, then all results must be non-scalar}}
-  %r:2 = arith.addi_carry %a, %a : vector<8xi32>, i1
+  // expected-error@+1 {{'arith.addui_carry' op if an operand is non-scalar, then all results must be non-scalar}}
+  %r:2 = arith.addui_carry %a, %a : vector<8xi32>, i1
   return
 }
 
 // -----
 
 func.func @func_with_ops(%a: vector<8xi32>) {
-  // expected-error@+1 {{'arith.addi_carry' op all non-scalar operands/results must have the same shape and base type}}
-  %r:2 = arith.addi_carry %a, %a : vector<8xi32>, tensor<8xi1>
+  // expected-error@+1 {{'arith.addui_carry' op all non-scalar operands/results must have the same shape and base type}}
+  %r:2 = arith.addui_carry %a, %a : vector<8xi32>, tensor<8xi1>
   return
 }
 
 // -----
 
 func.func @func_with_ops(i32) {
 ^bb0(%a : i32):
   %sf = arith.addf %a, %a : i32  // expected-error {{'arith.addf' op operand #0 must be floating-point-like}}

mlir/test/Dialect/Arithmetic/ops.mlir

 }
 
 // CHECK-LABEL: test_addi_scalable_vector
 func.func @test_addi_scalable_vector(%arg0 : vector<[8]xi64>, %arg1 : vector<[8]xi64>) -> vector<[8]xi64> {
   %0 = arith.addi %arg0, %arg1 : vector<[8]xi64>
   return %0 : vector<[8]xi64>
 }
 
-// CHECK-LABEL: test_addi_carry
-func.func @test_addi_carry(%arg0 : i64, %arg1 : i64) -> i64 {
-  %sum, %carry = arith.addi_carry %arg0, %arg1 : i64, i1
+// CHECK-LABEL: test_addui_carry
+func.func @test_addui_carry(%arg0 : i64, %arg1 : i64) -> i64 {
+  %sum, %carry = arith.addui_carry %arg0, %arg1 : i64, i1
   return %sum : i64
 }
 
-// CHECK-LABEL: test_addi_carry_tensor
-func.func @test_addi_carry_tensor(%arg0 : tensor<8x8xi64>, %arg1 : tensor<8x8xi64>) -> tensor<8x8xi64> {
-  %sum, %carry = arith.addi_carry %arg0, %arg1 : tensor<8x8xi64>, tensor<8x8xi1>
+// CHECK-LABEL: test_addui_carry_tensor
+func.func @test_addui_carry_tensor(%arg0 : tensor<8x8xi64>, %arg1 : tensor<8x8xi64>) -> tensor<8x8xi64> {
+  %sum, %carry = arith.addui_carry %arg0, %arg1 : tensor<8x8xi64>, tensor<8x8xi1>
   return %sum : tensor<8x8xi64>
 }
 
-// CHECK-LABEL: test_addi_carry_vector
-func.func @test_addi_carry_vector(%arg0 : vector<8xi64>, %arg1 : vector<8xi64>) -> vector<8xi64> {
-  %0:2 = arith.addi_carry %arg0, %arg1 : vector<8xi64>, vector<8xi1>
+// CHECK-LABEL: test_addui_carry_vector
+func.func @test_addui_carry_vector(%arg0 : vector<8xi64>, %arg1 : vector<8xi64>) -> vector<8xi64> {
+  %0:2 = arith.addui_carry %arg0, %arg1 : vector<8xi64>, vector<8xi1>
   return %0#0 : vector<8xi64>
 }
 
-// CHECK-LABEL: test_addi_carry_scalable_vector
-func.func @test_addi_carry_scalable_vector(%arg0 : vector<[8]xi64>, %arg1 : vector<[8]xi64>) -> vector<[8]xi64> {
-  %0:2 = arith.addi_carry %arg0, %arg1 : vector<[8]xi64>, vector<[8]xi1>
+// CHECK-LABEL: test_addui_carry_scalable_vector
+func.func @test_addui_carry_scalable_vector(%arg0 : vector<[8]xi64>, %arg1 : vector<[8]xi64>) -> vector<[8]xi64> {
+  %0:2 = arith.addui_carry %arg0, %arg1 : vector<[8]xi64>, vector<[8]xi1>
   return %0#0 : vector<[8]xi64>
 }
 
 // CHECK-LABEL: test_subi
 func.func @test_subi(%arg0 : i64, %arg1 : i64) -> i64 {
   %0 = arith.subi %arg0, %arg1 : i64
   return %0 : i64
 }