[InstCombine] Fold umul.overflow(x, c1) | (x*c1 > c2) to x > c2/c1

The motivation of this pattern is to check whether the product of a
variable and a constant would be mathematically (i.e., as integer
numbers instead of bit vectors) greater than a given constant bound. The
pattern appears to occur when compiling several Rust projects (it seems
to originate from the `smallvec` crate but I have not checked this
further).

Unless `c1` is `0` (which should only occur in non-splat vectors because
it should have been folded away otherwise), we can transform this
pattern into `x > c2/c1` with all operations working on unsigned
integers. If `c1` is `0`, we can use `x > -1` instead.

Alive proofs: https://alive2.llvm.org/ce/z/HFVvsJ

Closes #142674

Author: mskamp

llvm/lib/Transforms/InstCombine/InstCombineAndOrXor.cpp

@@ -3659,6 +3659,37 @@ static std::optional<DecomposedBitMaskMul> matchBitmaskMul(Value *V) {
   return std::nullopt;
 }
 
+/// Fold Res, Overflow = (umul.with.overflow x c1); (or Overflow (ugt Res c2))
+/// --> (ugt x (c2/c1)). This code checks whether a multiplication of two
+/// unsigned numbers (one is a constant) is mathematically greater than a
+/// second constant.
+static Value *foldOrUnsignedUMulOverflowICmp(BinaryOperator &I,
+                                             InstCombiner::BuilderTy &Builder,
+                                             const DataLayout &DL) {
+  const WithOverflowInst *WO;
+  const Value *WOV;
+  Constant *C1, *C2;
+  if (match(&I, m_c_Or(m_OneUse(m_ExtractValue<1>(
+                           m_CombineAnd(m_WithOverflowInst(WO), m_Value(WOV)))),
+                       m_OneUse(m_SpecificCmp(
+                           ICmpInst::ICMP_UGT,
+                           m_OneUse(m_ExtractValue<0>(m_Deferred(WOV))),
+                           m_ImmConstant(C2))))) &&
+      WO->getIntrinsicID() == Intrinsic::umul_with_overflow &&
+      match(WO->getRHS(), m_ImmConstant(C1)) && WO->hasNUses(2)) {
+    Type *Ty = C1->getType();
+    // If C1 is 0 (which may occur in non-splat vectors), we use -1 as the new
+    // constant instead.
+    Constant *NewC = ConstantFoldSelectInstruction(
+        ConstantFoldCompareInstOperands(ICmpInst::ICMP_EQ, C1,
+                                        ConstantInt::getNullValue(Ty), DL),
+        ConstantInt::getAllOnesValue(Ty),
+        ConstantFoldBinaryOpOperands(Instruction::UDiv, C2, C1, DL));
+    return Builder.CreateICmp(ICmpInst::ICMP_UGT, WO->getLHS(), NewC);
+  }
+  return nullptr;
+}
+
 // FIXME: We use commutative matchers (m_c_*) for some, but not all, matches
 // here. We should standardize that construct where it is needed or choose some
 // other way to ensure that commutated variants of patterns are not missed.
@@ -4109,6 +4140,11 @@ Instruction *InstCombinerImpl::visitOr(BinaryOperator &I) {
     }
   }
 
+  // Try to fold the pattern "Overflow | icmp pred Res, C2" into a single
+  // comparison instruction for umul.with.overflow.
+  if (Value *R = foldOrUnsignedUMulOverflowICmp(I, Builder, DL))
+    return replaceInstUsesWith(I, R);
+
   // (~x) | y  -->  ~(x & (~y))  iff that gets rid of inversions
   if (sinkNotIntoOtherHandOfLogicalOp(I))
     return &I;

llvm/test/Transforms/InstCombine/icmp_or_umul_overflow.ll

@@ -8,11 +8,7 @@ declare void @use.i64i1({i64, i1} %x)
 define i1 @umul_greater_than_or_overflow_const(i64 %in) {
 ; CHECK-LABEL: define i1 @umul_greater_than_or_overflow_const(
 ; CHECK-SAME: i64 [[IN:%.*]]) {
-; CHECK-NEXT:    [[TMP2:%.*]] = call { i64, i1 } @llvm.umul.with.overflow.i64(i64 [[IN]], i64 168)
-; CHECK-NEXT:    [[TMP3:%.*]] = extractvalue { i64, i1 } [[TMP2]], 0
-; CHECK-NEXT:    [[TMP4:%.*]] = extractvalue { i64, i1 } [[TMP2]], 1
-; CHECK-NEXT:    [[TMP5:%.*]] = icmp ugt i64 [[TMP3]], -16
-; CHECK-NEXT:    [[TMP6:%.*]] = or i1 [[TMP4]], [[TMP5]]
+; CHECK-NEXT:    [[TMP6:%.*]] = icmp ugt i64 [[IN]], 109802048057794950
 ; CHECK-NEXT:    ret i1 [[TMP6]]
 ;
   %mwo = call { i64, i1 } @llvm.umul.with.overflow.i64(i64 %in, i64 168)
@@ -26,11 +22,7 @@ define i1 @umul_greater_than_or_overflow_const(i64 %in) {
 define i1 @umul_greater_than_or_overflow_const_i8(i8 %in) {
 ; CHECK-LABEL: define i1 @umul_greater_than_or_overflow_const_i8(
 ; CHECK-SAME: i8 [[IN:%.*]]) {
-; CHECK-NEXT:    [[TMP2:%.*]] = call { i8, i1 } @llvm.umul.with.overflow.i8(i8 [[IN]], i8 24)
-; CHECK-NEXT:    [[TMP3:%.*]] = extractvalue { i8, i1 } [[TMP2]], 0
-; CHECK-NEXT:    [[TMP4:%.*]] = extractvalue { i8, i1 } [[TMP2]], 1
-; CHECK-NEXT:    [[TMP5:%.*]] = icmp ugt i8 [[TMP3]], -16
-; CHECK-NEXT:    [[TMP6:%.*]] = or i1 [[TMP4]], [[TMP5]]
+; CHECK-NEXT:    [[TMP6:%.*]] = icmp ugt i8 [[IN]], 10
 ; CHECK-NEXT:    ret i1 [[TMP6]]
 ;
   %mwo = call { i8, i1 } @llvm.umul.with.overflow.i8(i8 %in, i8 24)
@@ -44,11 +36,7 @@ define i1 @umul_greater_than_or_overflow_const_i8(i8 %in) {
 define i1 @umul_greater_than_or_overflow_const_commuted(i64 %in) {
 ; CHECK-LABEL: define i1 @umul_greater_than_or_overflow_const_commuted(
 ; CHECK-SAME: i64 [[IN:%.*]]) {
-; CHECK-NEXT:    [[TMP2:%.*]] = tail call { i64, i1 } @llvm.umul.with.overflow.i64(i64 [[IN]], i64 48)
-; CHECK-NEXT:    [[TMP3:%.*]] = extractvalue { i64, i1 } [[TMP2]], 0
-; CHECK-NEXT:    [[TMP4:%.*]] = extractvalue { i64, i1 } [[TMP2]], 1
-; CHECK-NEXT:    [[TMP5:%.*]] = icmp ugt i64 [[TMP3]], 9223372036854775800
-; CHECK-NEXT:    [[TMP6:%.*]] = or i1 [[TMP5]], [[TMP4]]
+; CHECK-NEXT:    [[TMP6:%.*]] = icmp ugt i64 [[IN]], 192153584101141162
 ; CHECK-NEXT:    ret i1 [[TMP6]]
 ;
   %mwo = tail call { i64, i1 } @llvm.umul.with.overflow.i64(i64 %in, i64 48)
@@ -62,11 +50,7 @@ define i1 @umul_greater_than_or_overflow_const_commuted(i64 %in) {
 define i1 @umul_greater_than_or_overflow_const_disjoint(i64 %in) {
 ; CHECK-LABEL: define i1 @umul_greater_than_or_overflow_const_disjoint(
 ; CHECK-SAME: i64 [[IN:%.*]]) {
-; CHECK-NEXT:    [[TMP2:%.*]] = tail call { i64, i1 } @llvm.umul.with.overflow.i64(i64 [[IN]], i64 40)
-; CHECK-NEXT:    [[TMP3:%.*]] = extractvalue { i64, i1 } [[TMP2]], 0
-; CHECK-NEXT:    [[TMP4:%.*]] = extractvalue { i64, i1 } [[TMP2]], 1
-; CHECK-NEXT:    [[TMP5:%.*]] = icmp ugt i64 [[TMP3]], 9223372036854775800
-; CHECK-NEXT:    [[TMP6:%.*]] = or disjoint i1 [[TMP4]], [[TMP5]]
+; CHECK-NEXT:    [[TMP6:%.*]] = icmp ugt i64 [[IN]], 230584300921369395
 ; CHECK-NEXT:    ret i1 [[TMP6]]
 ;
   %mwo = tail call { i64, i1 } @llvm.umul.with.overflow.i64(i64 %in, i64 40)
@@ -80,11 +64,7 @@ define i1 @umul_greater_than_or_overflow_const_disjoint(i64 %in) {
 define <2 x i1> @umul_greater_than_or_overflow_const_vector_splat(<2 x i64> %in) {
 ; CHECK-LABEL: define <2 x i1> @umul_greater_than_or_overflow_const_vector_splat(
 ; CHECK-SAME: <2 x i64> [[IN:%.*]]) {
-; CHECK-NEXT:    [[TMP2:%.*]] = tail call { <2 x i64>, <2 x i1> } @llvm.umul.with.overflow.v2i64(<2 x i64> [[IN]], <2 x i64> splat (i64 1424))
-; CHECK-NEXT:    [[TMP3:%.*]] = extractvalue { <2 x i64>, <2 x i1> } [[TMP2]], 0
-; CHECK-NEXT:    [[TMP4:%.*]] = extractvalue { <2 x i64>, <2 x i1> } [[TMP2]], 1
-; CHECK-NEXT:    [[TMP5:%.*]] = icmp ugt <2 x i64> [[TMP3]], splat (i64 9223372036854775800)
-; CHECK-NEXT:    [[TMP6:%.*]] = or <2 x i1> [[TMP4]], [[TMP5]]
+; CHECK-NEXT:    [[TMP6:%.*]] = icmp ugt <2 x i64> [[IN]], splat (i64 6477087104532848)
 ; CHECK-NEXT:    ret <2 x i1> [[TMP6]]
 ;
   %mwo = tail call { <2 x i64>, <2 x i1> } @llvm.umul.with.overflow.v2i64(<2 x i64> %in, <2 x i64> <i64 1424, i64 1424>)
@@ -98,11 +78,7 @@ define <2 x i1> @umul_greater_than_or_overflow_const_vector_splat(<2 x i64> %in)
 define <4 x i1> @umul_greater_than_or_overflow_const_vector_non_splat(<4 x i64> %in) {
 ; CHECK-LABEL: define <4 x i1> @umul_greater_than_or_overflow_const_vector_non_splat(
 ; CHECK-SAME: <4 x i64> [[IN:%.*]]) {
-; CHECK-NEXT:    [[MWO:%.*]] = tail call { <4 x i64>, <4 x i1> } @llvm.umul.with.overflow.v4i64(<4 x i64> [[IN]], <4 x i64> <i64 24, i64 1424, i64 0, i64 -1>)
-; CHECK-NEXT:    [[MUL:%.*]] = extractvalue { <4 x i64>, <4 x i1> } [[MWO]], 0
-; CHECK-NEXT:    [[OVF:%.*]] = extractvalue { <4 x i64>, <4 x i1> } [[MWO]], 1
-; CHECK-NEXT:    [[CMP:%.*]] = icmp ugt <4 x i64> [[MUL]], <i64 9223372036854775000, i64 9223372036854775800, i64 -16, i64 -16>
-; CHECK-NEXT:    [[RET:%.*]] = or <4 x i1> [[OVF]], [[CMP]]
+; CHECK-NEXT:    [[RET:%.*]] = icmp ugt <4 x i64> [[IN]], <i64 384307168202282291, i64 6477087104532848, i64 -1, i64 0>
 ; CHECK-NEXT:    ret <4 x i1> [[RET]]
 ;
   %mwo = tail call { <4 x i64>, <4 x i1> } @llvm.umul.with.overflow.v2i64(<4 x i64> %in, <4 x i64> <i64 24, i64 1424, i64 0, i64 -1>)