[llvm] 276847a - [LangRef][IR] Add 3-way compare intrinsics llvm.scmp/llvm.ucmp (#83227)
via llvm-commits
llvm-commits at lists.llvm.org
Mon Mar 18 07:02:30 PDT 2024
Author: Miguel Raz Guzmán Macedo
Date: 2024-03-18T15:02:26+01:00
New Revision: 276847a65af67bdc4eb79989f196d1968cb50ae6
URL: https://github.com/llvm/llvm-project/commit/276847a65af67bdc4eb79989f196d1968cb50ae6
DIFF: https://github.com/llvm/llvm-project/commit/276847a65af67bdc4eb79989f196d1968cb50ae6.diff
LOG: [LangRef][IR] Add 3-way compare intrinsics llvm.scmp/llvm.ucmp (#83227)
This PR adds the `[us]cmp` intrinsics to the LangRef, `Intrinsics.td`
and some tests to the IRVerifier.
RFC: https://discourse.llvm.org/t/rfc-add-3-way-comparison-intrinsics/76685
Added:
llvm/test/Verifier/intrinsic-cmp.ll
Modified:
llvm/docs/LangRef.rst
llvm/include/llvm/IR/Intrinsics.td
llvm/lib/IR/Verifier.cpp
Removed:
################################################################################
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index ecedd3a32c7b36..e07b642285b3e6 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -14574,6 +14574,63 @@ The arguments (``%a`` and ``%b``) may be of any integer type or a vector with
integer element type. The argument types must match each other, and the return
type must match the argument type.
+.. _int_scmp:
+
+'``llvm.scmp.*``' Intrinsic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Syntax:
+"""""""
+
+This is an overloaded intrinsic. You can use ``@llvm.scmp`` on any
+integer bit width or any vector of integer elements.
+
+::
+
+ declare i2 @llvm.scmp.i2.i32(i32 %a, i32 %b)
+ declare <4 x i32> @llvm.scmp.v4i32.v4i32(<4 x i32> %a, <4 x i32> %b)
+
+Overview:
+"""""""""
+
+Return ``-1`` if ``%a`` is signed less than ``%b``, ``0`` if they are equal, and
+``1`` if ``%a`` is signed greater than ``%b``. Vector intrinsics operate on a per-element basis.
+
+Arguments:
+""""""""""
+
+The arguments (``%a`` and ``%b``) may be of any integer type or a vector with
+integer element type. The argument types must match each other, and the return
+type must be at least as wide as ``i2``, to hold the three possible return values.
+
+.. _int_ucmp:
+
+'``llvm.ucmp.*``' Intrinsic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Syntax:
+"""""""
+
+This is an overloaded intrinsic. You can use ``@llvm.ucmp`` on any
+integer bit width or any vector of integer elements.
+
+::
+
+ declare i2 @llvm.ucmp.i2.i32(i32 %a, i32 %b)
+ declare <4 x i32> @llvm.ucmp.v4i32.v4i32(<4 x i32> %a, <4 x i32> %b)
+
+Overview:
+"""""""""
+
+Return ``-1`` if ``%a`` is unsigned less than ``%b``, ``0`` if they are equal, and
+``1`` if ``%a`` is unsigned greater than ``%b``. Vector intrinsics operate on a per-element basis.
+
+Arguments:
+""""""""""
+
+The arguments (``%a`` and ``%b``) may be of any integer type or a vector with
+integer element type. The argument types must match each other, and the return
+type must be at least as wide as ``i2``, to hold the three possible return values.
.. _int_memcpy:
diff --git a/llvm/include/llvm/IR/Intrinsics.td b/llvm/include/llvm/IR/Intrinsics.td
index 144298fd7c0162..091f9b38107989 100644
--- a/llvm/include/llvm/IR/Intrinsics.td
+++ b/llvm/include/llvm/IR/Intrinsics.td
@@ -1528,6 +1528,12 @@ def int_umax : DefaultAttrsIntrinsic<
def int_umin : DefaultAttrsIntrinsic<
[llvm_anyint_ty], [LLVMMatchType<0>, LLVMMatchType<0>],
[IntrNoMem, IntrSpeculatable, IntrWillReturn]>;
+def int_scmp : DefaultAttrsIntrinsic<
+ [llvm_anyint_ty], [llvm_anyint_ty, LLVMMatchType<1>],
+ [IntrNoMem, IntrSpeculatable, IntrWillReturn]>;
+def int_ucmp : DefaultAttrsIntrinsic<
+ [llvm_anyint_ty], [llvm_anyint_ty, LLVMMatchType<1>],
+ [IntrNoMem, IntrSpeculatable, IntrWillReturn]>;
//===------------------------- Memory Use Markers -------------------------===//
//
diff --git a/llvm/lib/IR/Verifier.cpp b/llvm/lib/IR/Verifier.cpp
index 2b9dc745d7bfc5..62dde2e6ad4243 100644
--- a/llvm/lib/IR/Verifier.cpp
+++ b/llvm/lib/IR/Verifier.cpp
@@ -5265,6 +5265,29 @@ void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) {
}
break;
}
+ case Intrinsic::ucmp:
+ case Intrinsic::scmp: {
+ Type *SrcTy = Call.getOperand(0)->getType();
+ Type *DestTy = Call.getType();
+
+ Check(DestTy->getScalarSizeInBits() >= 2,
+ "result type must be at least 2 bits wide", Call);
+
+ bool IsDestTypeVector = DestTy->isVectorTy();
+ Check(SrcTy->isVectorTy() == IsDestTypeVector,
+ "ucmp/scmp argument and result types must both be either vector or "
+ "scalar types",
+ Call);
+ if (IsDestTypeVector) {
+ auto SrcVecLen = cast<VectorType>(SrcTy)->getElementCount();
+ auto DestVecLen = cast<VectorType>(DestTy)->getElementCount();
+ Check(SrcVecLen == DestVecLen,
+ "return type and arguments must have the same number of "
+ "elements",
+ Call);
+ }
+ break;
+ }
case Intrinsic::coro_id: {
auto *InfoArg = Call.getArgOperand(3)->stripPointerCasts();
if (isa<ConstantPointerNull>(InfoArg))
diff --git a/llvm/test/Verifier/intrinsic-cmp.ll b/llvm/test/Verifier/intrinsic-cmp.ll
new file mode 100644
index 00000000000000..2224a5c5eba385
--- /dev/null
+++ b/llvm/test/Verifier/intrinsic-cmp.ll
@@ -0,0 +1,22 @@
+; RUN: not opt -S -passes=verify 2>&1 < %s | FileCheck %s
+
+define void @matching_vector_lens(<4 x i32> %arg1, <4 x i32> %arg2) {
+ ; CHECK: return type and arguments must have the same number of elements
+ %res = call <8 x i32> @llvm.scmp.v8i32.v4i32(<4 x i32> %arg1, <4 x i32> %arg2)
+ ret void
+}
+
+define void @result_len_is_at_least_2bits_wide(i32 %arg1, i32 %arg2) {
+ ; CHECK: result type must be at least 2 bits wide
+ %res2 = call i1 @llvm.scmp.i1.i32(i32 %arg1, i32 %arg2)
+ ret void
+}
+
+define void @both_args_are_vecs_or_neither(<4 x i32> %arg1, i32 %arg2) {
+ ; CHECK: ucmp/scmp argument and result types must both be either vector or scalar types
+ %res3 = call i2 @llvm.scmp.i2.v4i32(<4 x i32> %arg1, <4 x i32> %arg1)
+ ; CHECK: ucmp/scmp argument and result types must both be either vector or scalar types
+ %res4 = call <4 x i32> @llvm.scmp.v4i32.i32(i32 %arg2, i32 %arg2)
+ ret void
+}
+
More information about the llvm-commits
mailing list