[mlir][arith] Overflow semantics in documentation for muli, subi, and addi #74346
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-mlir Author: Jacob Yu (pingshiyu) ChangesFollowing discussions from this RFC: https://discourse.llvm.org/t/rfc-integer-overflow-semantics Adding the overflow semantics into the muli, subi and addi arith operations. Full diff: https://github.com/llvm/llvm-project/pull/74346.diff 1 Files Affected:
diff --git a/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td b/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
index 38cce99679e99..3c2c48180a2a2 100644
--- a/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
+++ b/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
@@ -200,6 +200,12 @@ def Arith_AddIOp : Arith_TotalIntBinaryOp<"addi", [Commutative]> {
a vector whose element type is integer, or a tensor of integers. It has no
standard attributes.
+ The operands are interpreted as unsigned bitvectors. The result is represented by
+ a bitvector containing the mathematical value of the addition modulo 2^n, where
+ `n` is the bitwidth. Because `arith` integers use a two's complement
+ representation, this operation is applicable on both signed and unsigned
+ integer operands.
+
Example:
```mlir
@@ -276,6 +282,17 @@ def Arith_SubIOp : Arith_TotalIntBinaryOp<"subi"> {
let summary = [{
Integer subtraction operation.
}];
+ let description = [{
+ The `subi` operation takes two operands and returns one result, each of
+ these is required to be the same type. This type may be an integer scalar type,
+ a vector whose element type is integer, or a tensor of integers. It has no
+ standard attributes.
+
+ The operands are interpreted as unsigned bitvectors. The result is represented by a
+ bitvector containing the mathematical value of the subtraction modulo 2^n, where `n`
+ is the bitwidth. Because `arith` integers use a two's complement representation, this
+ operation is applicable on both signed and unsigned integer operands.
+ }];
let hasFolder = 1;
let hasCanonicalizer = 1;
}
@@ -288,6 +305,17 @@ def Arith_MulIOp : Arith_TotalIntBinaryOp<"muli", [Commutative]> {
let summary = [{
Integer multiplication operation.
}];
+ let description = [{
+ The `muli` operation takes two operands and returns one result, each of
+ these is required to be the same type. This type may be an integer scalar type,
+ a vector whose element type is integer, or a tensor of integers. It has no
+ standard attributes.
+
+ The operands are interpreted as unsigned bitvectors. The result is represented by a
+ bitvector containing the mathematical value of the multiplication modulo 2^n, where `n`
+ is the bitwidth. Because `arith` integers use a two's complement representation, this
+ operation is applicable on both signed and unsigned integer operands.
+ }];
let hasFolder = 1;
let hasCanonicalizer = 1;
}
|
|
@llvm/pr-subscribers-mlir-arith Author: Jacob Yu (pingshiyu) ChangesFollowing discussions from this RFC: https://discourse.llvm.org/t/rfc-integer-overflow-semantics Adding the overflow semantics into the muli, subi and addi arith operations. Full diff: https://github.com/llvm/llvm-project/pull/74346.diff 1 Files Affected:
diff --git a/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td b/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
index 38cce99679e99..3c2c48180a2a2 100644
--- a/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
+++ b/mlir/include/mlir/Dialect/Arith/IR/ArithOps.td
@@ -200,6 +200,12 @@ def Arith_AddIOp : Arith_TotalIntBinaryOp<"addi", [Commutative]> {
a vector whose element type is integer, or a tensor of integers. It has no
standard attributes.
+ The operands are interpreted as unsigned bitvectors. The result is represented by
+ a bitvector containing the mathematical value of the addition modulo 2^n, where
+ `n` is the bitwidth. Because `arith` integers use a two's complement
+ representation, this operation is applicable on both signed and unsigned
+ integer operands.
+
Example:
```mlir
@@ -276,6 +282,17 @@ def Arith_SubIOp : Arith_TotalIntBinaryOp<"subi"> {
let summary = [{
Integer subtraction operation.
}];
+ let description = [{
+ The `subi` operation takes two operands and returns one result, each of
+ these is required to be the same type. This type may be an integer scalar type,
+ a vector whose element type is integer, or a tensor of integers. It has no
+ standard attributes.
+
+ The operands are interpreted as unsigned bitvectors. The result is represented by a
+ bitvector containing the mathematical value of the subtraction modulo 2^n, where `n`
+ is the bitwidth. Because `arith` integers use a two's complement representation, this
+ operation is applicable on both signed and unsigned integer operands.
+ }];
let hasFolder = 1;
let hasCanonicalizer = 1;
}
@@ -288,6 +305,17 @@ def Arith_MulIOp : Arith_TotalIntBinaryOp<"muli", [Commutative]> {
let summary = [{
Integer multiplication operation.
}];
+ let description = [{
+ The `muli` operation takes two operands and returns one result, each of
+ these is required to be the same type. This type may be an integer scalar type,
+ a vector whose element type is integer, or a tensor of integers. It has no
+ standard attributes.
+
+ The operands are interpreted as unsigned bitvectors. The result is represented by a
+ bitvector containing the mathematical value of the multiplication modulo 2^n, where `n`
+ is the bitwidth. Because `arith` integers use a two's complement representation, this
+ operation is applicable on both signed and unsigned integer operands.
+ }];
let hasFolder = 1;
let hasCanonicalizer = 1;
}
|
kuhar
requested review from
Hardcode84,
joker-eph,
kuhar,
Mogball and
math-fehr
kuhar
reviewed
Dec 4, 2023
Mogball
approved these changes
Dec 5, 2023
Hardcode84
approved these changes
Dec 5, 2023
|
@joker-eph do you have any comments? |
|
No comments, thanks for checking! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following discussions from this RFC: https://discourse.llvm.org/t/rfc-integer-overflow-semantics
Adding the overflow semantics into the muli, subi and addi arith operations.