CorrelatedValuePropagation.cpp

Go to the documentation of this file.

//===- CorrelatedValuePropagation.cpp - Propagate CFG-derived info --------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file implements the Correlated Value Propagation pass.
//
//===----------------------------------------------------------------------===//
 
#include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
#include "llvm/ADT/DepthFirstIterator.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/DomTreeUpdater.h"
#include "llvm/Analysis/GlobalsModRef.h"
#include "llvm/Analysis/InstructionSimplify.h"
#include "llvm/Analysis/LazyValueInfo.h"
#include "llvm/Analysis/ValueTracking.h"
#include "llvm/IR/Attributes.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/ConstantRange.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/Operator.h"
#include "llvm/IR/PassManager.h"
#include "llvm/IR/PatternMatch.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"
#include "llvm/Support/Casting.h"
#include "llvm/Transforms/Utils/Local.h"
#include <cassert>
#include <optional>
#include <utility>
 
using namespace llvm;
 
#define DEBUG_TYPE "correlated-value-propagation"
 
STATISTIC(NumPhis,      "Number of phis propagated");
STATISTIC(NumPhiCommon, "Number of phis deleted via common incoming value");
STATISTIC(NumSelects,   "Number of selects propagated");
STATISTIC(NumCmps,      "Number of comparisons propagated");
STATISTIC(NumReturns,   "Number of return values propagated");
STATISTIC(NumDeadCases, "Number of switch cases removed");
STATISTIC(NumSDivSRemsNarrowed,
          "Number of sdivs/srems whose width was decreased");
STATISTIC(NumSDivs,     "Number of sdiv converted to udiv");
STATISTIC(NumUDivURemsNarrowed,
          "Number of udivs/urems whose width was decreased");
STATISTIC(NumAShrsConverted, "Number of ashr converted to lshr");
STATISTIC(NumAShrsRemoved, "Number of ashr removed");
STATISTIC(NumSRems,     "Number of srem converted to urem");
STATISTIC(NumSExt,      "Number of sext converted to zext");
STATISTIC(NumSIToFP,    "Number of sitofp converted to uitofp");
STATISTIC(NumSICmps,    "Number of signed icmp preds simplified to unsigned");
STATISTIC(NumAnd,       "Number of ands removed");
STATISTIC(NumNW,        "Number of no-wrap deductions");
STATISTIC(NumNSW,       "Number of no-signed-wrap deductions");
STATISTIC(NumNUW,       "Number of no-unsigned-wrap deductions");
STATISTIC(NumAddNW,     "Number of no-wrap deductions for add");
STATISTIC(NumAddNSW,    "Number of no-signed-wrap deductions for add");
STATISTIC(NumAddNUW,    "Number of no-unsigned-wrap deductions for add");
STATISTIC(NumSubNW,     "Number of no-wrap deductions for sub");
STATISTIC(NumSubNSW,    "Number of no-signed-wrap deductions for sub");
STATISTIC(NumSubNUW,    "Number of no-unsigned-wrap deductions for sub");
STATISTIC(NumMulNW,     "Number of no-wrap deductions for mul");
STATISTIC(NumMulNSW,    "Number of no-signed-wrap deductions for mul");
STATISTIC(NumMulNUW,    "Number of no-unsigned-wrap deductions for mul");
STATISTIC(NumShlNW,     "Number of no-wrap deductions for shl");
STATISTIC(NumShlNSW,    "Number of no-signed-wrap deductions for shl");
STATISTIC(NumShlNUW,    "Number of no-unsigned-wrap deductions for shl");
STATISTIC(NumAbs,       "Number of llvm.abs intrinsics removed");
STATISTIC(NumOverflows, "Number of overflow checks removed");
STATISTIC(NumSaturating,
    "Number of saturating arithmetics converted to normal arithmetics");
STATISTIC(NumNonNull, "Number of function pointer arguments marked non-null");
STATISTIC(NumCmpIntr, "Number of llvm.[us]cmp intrinsics removed");
STATISTIC(NumMinMax, "Number of llvm.[us]{min,max} intrinsics removed");
STATISTIC(NumSMinMax,
          "Number of llvm.s{min,max} intrinsics simplified to unsigned");
STATISTIC(NumUDivURemsNarrowedExpanded,
          "Number of bound udiv's/urem's expanded");
STATISTIC(NumNNeg, "Number of zext/uitofp non-negative deductions");
 
namespace {
struct NoWrapFlags;
 
class CVPImpl {
  Function &F;
  LazyValueInfo *LVI;
  DominatorTree *DT;
  const SimplifyQuery SQ;
  std::optional<ConstantRange> RetRange;
 
public:
  CVPImpl(Function &F, LazyValueInfo *LVI, DominatorTree *DT,
          const SimplifyQuery &SQ)
      : F(F), LVI(LVI), DT(DT), SQ(SQ) {}
 
  bool run();
 
private:
  // Driver methods.
  bool processInstruction(Instruction &I);
  bool inferReturnRangeAttr();
 
  // Process instructions.
  bool processSelect(SelectInst *S);
  bool processPHI(PHINode *P);
  bool processICmp(ICmpInst *Cmp);
  bool processCmp(CmpInst *Cmp);
  bool processSwitch(SwitchInst *I);
  bool processBinOp(BinaryOperator *BinOp);
  bool processAbsIntrinsic(IntrinsicInst *II);
  bool processCmpIntrinsic(CmpIntrinsic *CI);
  bool processMinMaxIntrinsic(MinMaxIntrinsic *MM);
  bool processOverflowIntrinsic(WithOverflowInst *WO);
  bool processSaturatingInst(SaturatingInst *SI);
  bool processCallSite(CallBase &CB);
  bool processUDivOrURem(BinaryOperator *Instr);
  bool processSRem(BinaryOperator *SDI, const ConstantRange &LCR,
                   const ConstantRange &RCR);
  bool processSDiv(BinaryOperator *SDI, const ConstantRange &LCR,
                   const ConstantRange &RCR);
  bool processSDivOrSRem(BinaryOperator *Instr);
  bool processAShr(BinaryOperator *SDI);
  bool processSExt(SExtInst *SDI);
  bool processPossibleNonNeg(PossiblyNonNegInst *I);
  bool processSIToFP(SIToFPInst *SIToFP);
  bool processAnd(BinaryOperator *BinOp);
  bool processTrunc(TruncInst *TI);
  bool processReturn(ReturnInst *RI);
 
  // Helpers.
  Constant *getConstantAt(Value *V, Instruction *At);
  bool simplifyCommonValuePhi(PHINode *P);
  bool constantFoldCmp(CmpInst *Cmp);
  bool willNotOverflow(BinaryOpIntrinsic *BO);
  Value *getValueOnEdge(Value *Incoming, BasicBlock *From, BasicBlock *To,
                        Instruction *CtxI);
  NoWrapFlags inferNoWrapFromUses(BinaryOperator *BinOp, bool WantNSW,
                                  bool WantNUW);
};
} // end anonymous namespace
 
Constant *CVPImpl::getConstantAt(Value *V, Instruction *At) {
  if (Constant *C = LVI->getConstant(V, At))
    return C;
 
  // TODO: The following really should be sunk inside LVI's core algorithm, or
  // at least the outer shims around such.
  auto *C = dyn_cast<CmpInst>(V);
  if (!C)
    return nullptr;
 
  Value *Op0 = C->getOperand(0);
  Constant *Op1 = dyn_cast<Constant>(C->getOperand(1));
  if (!Op1)
    return nullptr;
 
  return LVI->getPredicateAt(C->getPredicate(), Op0, Op1, At,
                             /*UseBlockValue=*/false);
}
 
bool CVPImpl::processSelect(SelectInst *S) {
  if (S->getType()->isVectorTy() || isa<Constant>(S->getCondition()))
    return false;
 
  bool Changed = false;
  for (Use &U : make_early_inc_range(S->uses())) {
    auto *I = cast<Instruction>(U.getUser());
    Constant *C;
    if (auto *PN = dyn_cast<PHINode>(I))
      C = LVI->getConstantOnEdge(S->getCondition(), PN->getIncomingBlock(U),
                                 I->getParent(), I);
    else
      C = getConstantAt(S->getCondition(), I);
 
    auto *CI = dyn_cast_or_null<ConstantInt>(C);
    if (!CI)
      continue;
 
    U.set(CI->isOne() ? S->getTrueValue() : S->getFalseValue());
    Changed = true;
    ++NumSelects;
  }
 
  if (Changed && S->use_empty())
    S->eraseFromParent();
 
  return Changed;
}
 
/// Try to simplify a phi with constant incoming values that match the edge
/// values of a non-constant value on all other edges:
/// bb0:
///   %isnull = icmp eq i8* %x, null
///   br i1 %isnull, label %bb2, label %bb1
/// bb1:
///   br label %bb2
/// bb2:
///   %r = phi i8* [ %x, %bb1 ], [ null, %bb0 ]
/// -->
///   %r = %x
bool CVPImpl::simplifyCommonValuePhi(PHINode *P) {
  // Collect incoming constants and initialize possible common value.
  SmallVector<std::pair<Constant *, unsigned>, 4> IncomingConstants;
  Value *CommonValue = nullptr;
  for (unsigned I = 0, E = P->getNumIncomingValues(); I != E; ++I) {
    Value *Incoming = P->getIncomingValue(I);
    if (auto *IncomingConstant = dyn_cast<Constant>(Incoming)) {
      IncomingConstants.push_back(std::make_pair(IncomingConstant, I));
    } else if (!CommonValue) {
      // The potential common value is initialized to the first non-constant.
      CommonValue = Incoming;
    } else if (Incoming != CommonValue) {
      // There can be only one non-constant common value.
      return false;
    }
  }
 
  if (!CommonValue || IncomingConstants.empty())
    return false;
 
  // The common value must be valid in all incoming blocks.
  BasicBlock *ToBB = P->getParent();
  if (auto *CommonInst = dyn_cast<Instruction>(CommonValue))
    if (!DT->dominates(CommonInst, ToBB))
      return false;
 
  // We have a phi with exactly 1 variable incoming value and 1 or more constant
  // incoming values. See if all constant incoming values can be mapped back to
  // the same incoming variable value.
  for (auto &IncomingConstant : IncomingConstants) {
    Constant *C = IncomingConstant.first;
    BasicBlock *IncomingBB = P->getIncomingBlock(IncomingConstant.second);
    if (C != LVI->getConstantOnEdge(CommonValue, IncomingBB, ToBB, P))
      return false;
  }
 
  // LVI only guarantees that the value matches a certain constant if the value
  // is not poison. Make sure we don't replace a well-defined value with poison.
  // This is usually satisfied due to a prior branch on the value.
  if (!isGuaranteedNotToBePoison(CommonValue, nullptr, P, DT))
    return false;
 
  // All constant incoming values map to the same variable along the incoming
  // edges of the phi. The phi is unnecessary.
  P->replaceAllUsesWith(CommonValue);
  P->eraseFromParent();
  ++NumPhiCommon;
  return true;
}
 
Value *CVPImpl::getValueOnEdge(Value *Incoming, BasicBlock *From,
                               BasicBlock *To, Instruction *CtxI) {
  if (Constant *C = LVI->getConstantOnEdge(Incoming, From, To, CtxI))
    return C;
 
  // Look if the incoming value is a select with a scalar condition for which
  // LVI can tells us the value. In that case replace the incoming value with
  // the appropriate value of the select. This often allows us to remove the
  // select later.
  auto *SI = dyn_cast<SelectInst>(Incoming);
  if (!SI)
    return nullptr;
 
  // Once LVI learns to handle vector types, we could also add support
  // for vector type constants that are not all zeroes or all ones.
  Value *Condition = SI->getCondition();
  if (!Condition->getType()->isVectorTy()) {
    if (Constant *C = LVI->getConstantOnEdge(Condition, From, To, CtxI)) {
      if (C->isOneValue())
        return SI->getTrueValue();
      if (C->isNullValue())
        return SI->getFalseValue();
    }
  }
 
  // Look if the select has a constant but LVI tells us that the incoming
  // value can never be that constant. In that case replace the incoming
  // value with the other value of the select. This often allows us to
  // remove the select later.
 
  // The "false" case
  if (auto *C = dyn_cast<Constant>(SI->getFalseValue()))
    if (auto *Res = dyn_cast_or_null<ConstantInt>(
            LVI->getPredicateOnEdge(ICmpInst::ICMP_EQ, SI, C, From, To, CtxI));
        Res && Res->isZero())
      return SI->getTrueValue();
 
  // The "true" case,
  // similar to the select "false" case, but try the select "true" value
  if (auto *C = dyn_cast<Constant>(SI->getTrueValue()))
    if (auto *Res = dyn_cast_or_null<ConstantInt>(
            LVI->getPredicateOnEdge(ICmpInst::ICMP_EQ, SI, C, From, To, CtxI));
        Res && Res->isZero())
      return SI->getFalseValue();
 
  return nullptr;
}
 
bool CVPImpl::processPHI(PHINode *P) {
  bool Changed = false;
 
  BasicBlock *BB = P->getParent();
  for (unsigned I = 0, E = P->getNumIncomingValues(); I < E; ++I) {
    Value *Incoming = P->getIncomingValue(I);
    if (isa<Constant>(Incoming))
      continue;
 
    Value *V = getValueOnEdge(Incoming, P->getIncomingBlock(I), BB, P);
    if (V) {
      P->setIncomingValue(I, V);
      Changed = true;
    }
  }
 
  if (Value *V = simplifyInstruction(P, SQ)) {
    P->replaceAllUsesWith(V);
    P->eraseFromParent();
    Changed = true;
  }
 
  if (!Changed)
    Changed = simplifyCommonValuePhi(P);
 
  if (Changed)
    ++NumPhis;
 
  return Changed;
}
 
bool CVPImpl::processICmp(ICmpInst *Cmp) {
  // Only for signed relational comparisons of integers.
  if (!Cmp->getOperand(0)->getType()->isIntOrIntVectorTy())
    return false;
 
  if (!Cmp->isSigned() && (!Cmp->isUnsigned() || Cmp->hasSameSign()))
    return false;
 
  bool Changed = false;
 
  ConstantRange CR1 = LVI->getConstantRangeAtUse(Cmp->getOperandUse(0),
                                                 /*UndefAllowed=*/false),
                CR2 = LVI->getConstantRangeAtUse(Cmp->getOperandUse(1),
                                                 /*UndefAllowed=*/false);
 
  if (Cmp->isSigned()) {
    ICmpInst::Predicate UnsignedPred =
        ConstantRange::getEquivalentPredWithFlippedSignedness(
            Cmp->getPredicate(), CR1, CR2);
 
    if (UnsignedPred == ICmpInst::Predicate::BAD_ICMP_PREDICATE)
      return false;
 
    ++NumSICmps;
    Cmp->setPredicate(UnsignedPred);
    Changed = true;
  }
 
  if (ConstantRange::areInsensitiveToSignednessOfICmpPredicate(CR1, CR2)) {
    Cmp->setSameSign();
    Changed = true;
  }
 
  return Changed;
}
 
/// See if LazyValueInfo's ability to exploit edge conditions or range
/// information is sufficient to prove this comparison. Even for local
/// conditions, this can sometimes prove conditions instcombine can't by
/// exploiting range information.
bool CVPImpl::constantFoldCmp(CmpInst *Cmp) {
  Value *Op0 = Cmp->getOperand(0);
  Value *Op1 = Cmp->getOperand(1);
  Constant *Res = LVI->getPredicateAt(Cmp->getPredicate(), Op0, Op1, Cmp,
                                      /*UseBlockValue=*/true);
  if (!Res)
    return false;
 
  bool Changed = Cmp->replaceUsesWithIf(
      Res, [](Use &U) { return !isa<AssumeInst>(U.getUser()); });
  if (Cmp->use_empty()) {
    Cmp->eraseFromParent();
    Changed = true;
  }
 
  if (Changed)
    ++NumCmps;
 
  return Changed;
}
 
bool CVPImpl::processCmp(CmpInst *Cmp) {
  if (constantFoldCmp(Cmp))
    return true;
 
  if (auto *ICmp = dyn_cast<ICmpInst>(Cmp))
    if (processICmp(ICmp))
      return true;
 
  return false;
}
 
/// Simplify a switch instruction by removing cases which can never fire. If the
/// uselessness of a case could be determined locally then constant propagation
/// would already have figured it out. Instead, walk the predecessors and
/// statically evaluate cases based on information available on that edge. Cases
/// that cannot fire no matter what the incoming edge can safely be removed. If
/// a case fires on every incoming edge then the entire switch can be removed
/// and replaced with a branch to the case destination.
bool CVPImpl::processSwitch(SwitchInst *I) {
  DomTreeUpdater DTU(*DT, DomTreeUpdater::UpdateStrategy::Lazy);
  Value *Cond = I->getCondition();
  BasicBlock *BB = I->getParent();
 
  // Analyse each switch case in turn.
  bool Changed = false;
  DenseMap<BasicBlock*, int> SuccessorsCount;
  for (auto *Succ : successors(BB))
    SuccessorsCount[Succ]++;
 
  { // Scope for SwitchInstProfUpdateWrapper. It must not live during
    // ConstantFoldTerminator() as the underlying SwitchInst can be changed.
    SwitchInstProfUpdateWrapper SI(*I);
    ConstantRange CR =
        LVI->getConstantRangeAtUse(I->getOperandUse(0), /*UndefAllowed=*/false);
    unsigned ReachableCaseCount = 0;
 
    for (auto CI = SI->case_begin(), CE = SI->case_end(); CI != CE;) {
      ConstantInt *Case = CI->getCaseValue();
      std::optional<bool> Predicate = std::nullopt;
      if (!CR.contains(Case->getValue()))
        Predicate = false;
      else if (CR.isSingleElement() &&
               *CR.getSingleElement() == Case->getValue())
        Predicate = true;
      if (!Predicate) {
        // Handle missing cases, e.g., the range has a hole.
        auto *Res = dyn_cast_or_null<ConstantInt>(
            LVI->getPredicateAt(CmpInst::ICMP_EQ, Cond, Case, I,
                                /* UseBlockValue=*/true));
        if (Res && Res->isZero())
          Predicate = false;
        else if (Res && Res->isOne())
          Predicate = true;
      }
 
      if (Predicate && !*Predicate) {
        // This case never fires - remove it.
        BasicBlock *Succ = CI->getCaseSuccessor();
        Succ->removePredecessor(BB);
        CI = SI.removeCase(CI);
        CE = SI->case_end();
 
        // The condition can be modified by removePredecessor's PHI simplification
        // logic.
        Cond = SI->getCondition();
 
        ++NumDeadCases;
        Changed = true;
        if (--SuccessorsCount[Succ] == 0)
          DTU.applyUpdatesPermissive({{DominatorTree::Delete, BB, Succ}});
        continue;
      }
      if (Predicate && *Predicate) {
        // This case always fires.  Arrange for the switch to be turned into an
        // unconditional branch by replacing the switch condition with the case
        // value.
        SI->setCondition(Case);
        NumDeadCases += SI->getNumCases();
        Changed = true;
        break;
      }
 
      // Increment the case iterator since we didn't delete it.
      ++CI;
      ++ReachableCaseCount;
    }
 
    // The default dest is unreachable if all cases are covered.
    if (!SI->defaultDestUnreachable() &&
        !CR.isSizeLargerThan(ReachableCaseCount)) {
      BasicBlock *DefaultDest = SI->getDefaultDest();
      BasicBlock *NewUnreachableBB =
          BasicBlock::Create(BB->getContext(), "default.unreachable",
                             BB->getParent(), DefaultDest);
      auto *UI = new UnreachableInst(BB->getContext(), NewUnreachableBB);
      UI->setDebugLoc(DebugLoc::getTemporary());
 
      DefaultDest->removePredecessor(BB);
      SI->setDefaultDest(NewUnreachableBB);
 
      if (SuccessorsCount[DefaultDest] == 1)
        DTU.applyUpdates({{DominatorTree::Delete, BB, DefaultDest}});
      DTU.applyUpdates({{DominatorTree::Insert, BB, NewUnreachableBB}});
 
      ++NumDeadCases;
      Changed = true;
    }
  }
 
  if (Changed)
    // If the switch has been simplified to the point where it can be replaced
    // by a branch then do so now.
    ConstantFoldTerminator(BB, /*DeleteDeadConditions = */ false,
                           /*TLI = */ nullptr, &DTU);
  return Changed;
}
 
// See if we can prove that the given binary op intrinsic will not overflow.
bool CVPImpl::willNotOverflow(BinaryOpIntrinsic *BO) {
  ConstantRange LRange =
      LVI->getConstantRangeAtUse(BO->getOperandUse(0), /*UndefAllowed*/ false);
  ConstantRange RRange =
      LVI->getConstantRangeAtUse(BO->getOperandUse(1), /*UndefAllowed*/ false);
  ConstantRange NWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
      BO->getBinaryOp(), RRange, BO->getNoWrapKind());
  return NWRegion.contains(LRange);
}
 
static void setDeducedOverflowingFlags(Value *V, Instruction::BinaryOps Opcode,
                                       bool NewNSW, bool NewNUW) {
  Statistic *OpcNW, *OpcNSW, *OpcNUW;
  switch (Opcode) {
  case Instruction::Add:
    OpcNW = &NumAddNW;
    OpcNSW = &NumAddNSW;
    OpcNUW = &NumAddNUW;
    break;
  case Instruction::Sub:
    OpcNW = &NumSubNW;
    OpcNSW = &NumSubNSW;
    OpcNUW = &NumSubNUW;
    break;
  case Instruction::Mul:
    OpcNW = &NumMulNW;
    OpcNSW = &NumMulNSW;
    OpcNUW = &NumMulNUW;
    break;
  case Instruction::Shl:
    OpcNW = &NumShlNW;
    OpcNSW = &NumShlNSW;
    OpcNUW = &NumShlNUW;
    break;
  default:
    llvm_unreachable("Will not be called with other binops");
  }
 
  auto *Inst = dyn_cast<Instruction>(V);
  if (NewNSW) {
    ++NumNW;
    ++*OpcNW;
    ++NumNSW;
    ++*OpcNSW;
    if (Inst)
      Inst->setHasNoSignedWrap();
  }
  if (NewNUW) {
    ++NumNW;
    ++*OpcNW;
    ++NumNUW;
    ++*OpcNUW;
    if (Inst)
      Inst->setHasNoUnsignedWrap();
  }
}
 
// See if @llvm.abs argument is alays positive/negative, and simplify.
// Notably, INT_MIN can belong to either range, regardless of the NSW,
// because it is negation-invariant.
bool CVPImpl::processAbsIntrinsic(IntrinsicInst *II) {
  Value *X = II->getArgOperand(0);
  bool IsIntMinPoison = cast<ConstantInt>(II->getArgOperand(1))->isOne();
  APInt IntMin = APInt::getSignedMinValue(X->getType()->getScalarSizeInBits());
  ConstantRange Range = LVI->getConstantRangeAtUse(
      II->getOperandUse(0), /*UndefAllowed*/ IsIntMinPoison);
 
  // Is X in [0, IntMin]?  NOTE: INT_MIN is fine!
  if (Range.icmp(CmpInst::ICMP_ULE, IntMin)) {
    ++NumAbs;
    II->replaceAllUsesWith(X);
    II->eraseFromParent();
    return true;
  }
 
  // Is X in [IntMin, 0]?  NOTE: INT_MIN is fine!
  if (Range.getSignedMax().isNonPositive()) {
    IRBuilder<> B(II);
    Value *NegX = B.CreateNeg(X, II->getName(),
                              /*HasNSW=*/IsIntMinPoison);
    ++NumAbs;
    II->replaceAllUsesWith(NegX);
    II->eraseFromParent();
 
    // See if we can infer some no-wrap flags.
    if (auto *BO = dyn_cast<BinaryOperator>(NegX))
      processBinOp(BO);
 
    return true;
  }
 
  // Argument's range crosses zero.
  // Can we at least tell that the argument is never INT_MIN?
  if (!IsIntMinPoison && !Range.contains(IntMin)) {
    ++NumNSW;
    ++NumSubNSW;
    II->setArgOperand(1, ConstantInt::getTrue(II->getContext()));
    return true;
  }
  return false;
}
 
bool CVPImpl::processCmpIntrinsic(CmpIntrinsic *CI) {
  ConstantRange LRange =
      LVI->getConstantRangeAtUse(CI->getOperandUse(0), /*UndefAllowed*/ false);
  ConstantRange RRange =
      LVI->getConstantRangeAtUse(CI->getOperandUse(1), /*UndefAllowed*/ false);
 
  if (LRange.icmp(CI->getGTPredicate(), RRange)) {
    ++NumCmpIntr;
    CI->replaceAllUsesWith(ConstantInt::get(CI->getType(), 1));
    CI->eraseFromParent();
    return true;
  }
  if (LRange.icmp(CI->getLTPredicate(), RRange)) {
    ++NumCmpIntr;
    CI->replaceAllUsesWith(ConstantInt::getSigned(CI->getType(), -1));
    CI->eraseFromParent();
    return true;
  }
  if (LRange.icmp(ICmpInst::ICMP_EQ, RRange)) {
    ++NumCmpIntr;
    CI->replaceAllUsesWith(ConstantInt::get(CI->getType(), 0));
    CI->eraseFromParent();
    return true;
  }
 
  return false;
}
 
// See if this min/max intrinsic always picks it's one specific operand.
// If not, check whether we can canonicalize signed minmax into unsigned version
bool CVPImpl::processMinMaxIntrinsic(MinMaxIntrinsic *MM) {
  CmpInst::Predicate Pred = CmpInst::getNonStrictPredicate(MM->getPredicate());
  ConstantRange LRange = LVI->getConstantRangeAtUse(MM->getOperandUse(0),
                                                    /*UndefAllowed*/ false);
  ConstantRange RRange = LVI->getConstantRangeAtUse(MM->getOperandUse(1),
                                                    /*UndefAllowed*/ false);
  if (LRange.icmp(Pred, RRange)) {
    ++NumMinMax;
    MM->replaceAllUsesWith(MM->getLHS());
    MM->eraseFromParent();
    return true;
  }
  if (RRange.icmp(Pred, LRange)) {
    ++NumMinMax;
    MM->replaceAllUsesWith(MM->getRHS());
    MM->eraseFromParent();
    return true;
  }
 
  if (MM->isSigned() &&
      ConstantRange::areInsensitiveToSignednessOfICmpPredicate(LRange,
                                                               RRange)) {
    ++NumSMinMax;
    IRBuilder<> B(MM);
    salvageDebugInfo(*MM);
    MM->replaceAllUsesWith(B.CreateBinaryIntrinsic(
        MM->getIntrinsicID() == Intrinsic::smin ? Intrinsic::umin
                                                : Intrinsic::umax,
        MM->getLHS(), MM->getRHS()));
    MM->eraseFromParent();
    return true;
  }
 
  return false;
}
 
// Rewrite this with.overflow intrinsic as non-overflowing.
bool CVPImpl::processOverflowIntrinsic(WithOverflowInst *WO) {
  IRBuilder<> B(WO);
  Instruction::BinaryOps Opcode = WO->getBinaryOp();
  bool NSW = WO->isSigned();
  bool NUW = !WO->isSigned();
 
  Value *NewOp =
      B.CreateBinOp(Opcode, WO->getLHS(), WO->getRHS(), WO->getName());
  setDeducedOverflowingFlags(NewOp, Opcode, NSW, NUW);
 
  StructType *ST = cast<StructType>(WO->getType());
  Constant *Struct = ConstantStruct::get(ST,
      { PoisonValue::get(ST->getElementType(0)),
        ConstantInt::getFalse(ST->getElementType(1)) });
  Value *NewI = B.CreateInsertValue(Struct, NewOp, 0);
  WO->replaceAllUsesWith(NewI);
  WO->eraseFromParent();
  ++NumOverflows;
 
  // See if we can infer the other no-wrap too.
  if (auto *BO = dyn_cast<BinaryOperator>(NewOp))
    processBinOp(BO);
 
  return true;
}
 
bool CVPImpl::processSaturatingInst(SaturatingInst *SI) {
  Instruction::BinaryOps Opcode = SI->getBinaryOp();
  bool NSW = SI->isSigned();
  bool NUW = !SI->isSigned();
  BinaryOperator *BinOp = BinaryOperator::Create(
      Opcode, SI->getLHS(), SI->getRHS(), SI->getName(), SI->getIterator());
  BinOp->setDebugLoc(SI->getDebugLoc());
  setDeducedOverflowingFlags(BinOp, Opcode, NSW, NUW);
 
  SI->replaceAllUsesWith(BinOp);
  SI->eraseFromParent();
  ++NumSaturating;
 
  // See if we can infer the other no-wrap too.
  processBinOp(BinOp);
 
  return true;
}
 
/// Infer nonnull attributes for the arguments at the specified callsite.
bool CVPImpl::processCallSite(CallBase &CB) {
 
  if (CB.getIntrinsicID() == Intrinsic::abs) {
    return processAbsIntrinsic(&cast<IntrinsicInst>(CB));
  }
 
  if (auto *CI = dyn_cast<CmpIntrinsic>(&CB)) {
    return processCmpIntrinsic(CI);
  }
 
  if (auto *MM = dyn_cast<MinMaxIntrinsic>(&CB)) {
    return processMinMaxIntrinsic(MM);
  }
 
  if (auto *WO = dyn_cast<WithOverflowInst>(&CB)) {
    if (willNotOverflow(WO))
      return processOverflowIntrinsic(WO);
  }
 
  if (auto *SI = dyn_cast<SaturatingInst>(&CB)) {
    if (willNotOverflow(SI))
      return processSaturatingInst(SI);
  }
 
  bool Changed = false;
 
  // Deopt bundle operands are intended to capture state with minimal
  // perturbance of the code otherwise.  If we can find a constant value for
  // any such operand and remove a use of the original value, that's
  // desireable since it may allow further optimization of that value (e.g. via
  // single use rules in instcombine).  Since deopt uses tend to,
  // idiomatically, appear along rare conditional paths, it's reasonable likely
  // we may have a conditional fact with which LVI can fold.
  if (auto DeoptBundle = CB.getOperandBundle(LLVMContext::OB_deopt)) {
    for (const Use &ConstU : DeoptBundle->Inputs) {
      Use &U = const_cast<Use&>(ConstU);
      Value *V = U.get();
      if (V->getType()->isVectorTy()) continue;
      if (isa<Constant>(V)) continue;
 
      Constant *C = LVI->getConstant(V, &CB);
      if (!C) continue;
      U.set(C);
      Changed = true;
    }
  }
 
  SmallVector<unsigned, 4> ArgNos;
  unsigned ArgNo = 0;
 
  for (Value *V : CB.args()) {
    PointerType *Type = dyn_cast<PointerType>(V->getType());
    // Try to mark pointer typed parameters as non-null.  We skip the
    // relatively expensive analysis for constants which are obviously either
    // null or non-null to start with.
    if (Type && !CB.paramHasAttr(ArgNo, Attribute::NonNull) &&
        !isa<Constant>(V))
      if (auto *Res = dyn_cast_or_null<ConstantInt>(LVI->getPredicateAt(
              ICmpInst::ICMP_EQ, V, ConstantPointerNull::get(Type), &CB,
              /*UseBlockValue=*/false));
          Res && Res->isZero())
        ArgNos.push_back(ArgNo);
    ArgNo++;
  }
 
  assert(ArgNo == CB.arg_size() && "Call arguments not processed correctly.");
 
  if (ArgNos.empty())
    return Changed;
 
  NumNonNull += ArgNos.size();
  AttributeList AS = CB.getAttributes();
  LLVMContext &Ctx = CB.getContext();
  AS = AS.addParamAttribute(Ctx, ArgNos,
                            Attribute::get(Ctx, Attribute::NonNull));
  CB.setAttributes(AS);
 
  return true;
}
 
enum class Domain { NonNegative, NonPositive, Unknown };
 
static Domain getDomain(const ConstantRange &CR) {
  if (CR.isAllNonNegative())
    return Domain::NonNegative;
  if (CR.icmp(ICmpInst::ICMP_SLE, APInt::getZero(CR.getBitWidth())))
    return Domain::NonPositive;
  return Domain::Unknown;
}
 
/// Try to shrink a sdiv/srem's width down to the smallest power of two that's
/// sufficient to contain its operands.
static bool narrowSDivOrSRem(BinaryOperator *Instr, const ConstantRange &LCR,
                             const ConstantRange &RCR) {
  assert(Instr->getOpcode() == Instruction::SDiv ||
         Instr->getOpcode() == Instruction::SRem);
 
  // Find the smallest power of two bitwidth that's sufficient to hold Instr's
  // operands.
  unsigned OrigWidth = Instr->getType()->getScalarSizeInBits();
 
  // What is the smallest bit width that can accommodate the entire value ranges
  // of both of the operands?
  unsigned MinSignedBits =
      std::max(LCR.getMinSignedBits(), RCR.getMinSignedBits());
 
  // sdiv/srem is UB if divisor is -1 and divident is INT_MIN, so unless we can
  // prove that such a combination is impossible, we need to bump the bitwidth.
  if (RCR.contains(APInt::getAllOnes(OrigWidth)) &&
      LCR.contains(APInt::getSignedMinValue(MinSignedBits).sext(OrigWidth)))
    ++MinSignedBits;
 
  // Don't shrink below 8 bits wide.
  unsigned NewWidth = std::max<unsigned>(PowerOf2Ceil(MinSignedBits), 8);
 
  // NewWidth might be greater than OrigWidth if OrigWidth is not a power of
  // two.
  if (NewWidth >= OrigWidth)
    return false;
 
  ++NumSDivSRemsNarrowed;
  IRBuilder<> B{Instr};
  auto *TruncTy = Instr->getType()->getWithNewBitWidth(NewWidth);
  auto *LHS = B.CreateTruncOrBitCast(Instr->getOperand(0), TruncTy,
                                     Instr->getName() + ".lhs.trunc");
  auto *RHS = B.CreateTruncOrBitCast(Instr->getOperand(1), TruncTy,
                                     Instr->getName() + ".rhs.trunc");
  auto *BO = B.CreateBinOp(Instr->getOpcode(), LHS, RHS, Instr->getName());
  auto *Sext = B.CreateSExt(BO, Instr->getType(), Instr->getName() + ".sext");
  if (auto *BinOp = dyn_cast<BinaryOperator>(BO))
    if (BinOp->getOpcode() == Instruction::SDiv)
      BinOp->setIsExact(Instr->isExact());
 
  Instr->replaceAllUsesWith(Sext);
  Instr->eraseFromParent();
  return true;
}
 
static bool expandUDivOrURem(BinaryOperator *Instr, const ConstantRange &XCR,
                             const ConstantRange &YCR) {
  Type *Ty = Instr->getType();
  assert(Instr->getOpcode() == Instruction::UDiv ||
         Instr->getOpcode() == Instruction::URem);
  bool IsRem = Instr->getOpcode() == Instruction::URem;
 
  Value *X = Instr->getOperand(0);
  Value *Y = Instr->getOperand(1);
 
  // X u/ Y -> 0  iff X u< Y
  // X u% Y -> X  iff X u< Y
  if (XCR.icmp(ICmpInst::ICMP_ULT, YCR)) {
    salvageDebugInfo(*Instr);
    Instr->replaceAllUsesWith(IsRem ? X : Constant::getNullValue(Ty));
    Instr->eraseFromParent();
    ++NumUDivURemsNarrowedExpanded;
    return true;
  }
 
  // Given
  //   R  = X u% Y
  // We can represent the modulo operation as a loop/self-recursion:
  //   urem_rec(X, Y):
  //     Z = X - Y
  //     if X u< Y
  //       ret X
  //     else
  //       ret urem_rec(Z, Y)
  // which isn't better, but if we only need a single iteration
  // to compute the answer, this becomes quite good:
  //   R  = X < Y ? X : X - Y    iff X u< 2*Y (w/ unsigned saturation)
  // Now, we do not care about all full multiples of Y in X, they do not change
  // the answer, thus we could rewrite the expression as:
  //   X* = X - (Y * |_ X / Y _|)
  //   R  = X* % Y
  // so we don't need the *first* iteration to return, we just need to
  // know *which* iteration will always return, so we could also rewrite it as:
  //   X* = X - (Y * |_ X / Y _|)
  //   R  = X* % Y                 iff X* u< 2*Y (w/ unsigned saturation)
  // but that does not seem profitable here.
 
  // Even if we don't know X's range, the divisor may be so large, X can't ever
  // be 2x larger than that. I.e. if divisor is always negative.
  if (!XCR.icmp(ICmpInst::ICMP_ULT, YCR.uadd_sat(YCR)) && !YCR.isAllNegative())
    return false;
 
  IRBuilder<> B(Instr);
  Value *ExpandedOp;
  if (XCR.icmp(ICmpInst::ICMP_UGE, YCR)) {
    // If X is between Y and 2*Y the result is known.
    if (IsRem)
      ExpandedOp = B.CreateNUWSub(X, Y);
    else
      ExpandedOp = ConstantInt::get(Instr->getType(), 1);
  } else if (IsRem) {
    // NOTE: this transformation introduces two uses of X,
    //       but it may be undef so we must freeze it first.
    Value *FrozenX = X;
    if (!isGuaranteedNotToBeUndef(X))
      FrozenX = B.CreateFreeze(X, X->getName() + ".frozen");
    Value *FrozenY = Y;
    if (!isGuaranteedNotToBeUndef(Y))
      FrozenY = B.CreateFreeze(Y, Y->getName() + ".frozen");
    auto *AdjX = B.CreateNUWSub(FrozenX, FrozenY, Instr->getName() + ".urem");
    auto *Cmp = B.CreateICmp(ICmpInst::ICMP_ULT, FrozenX, FrozenY,
                             Instr->getName() + ".cmp");
    ExpandedOp =
        B.CreateSelectWithUnknownProfile(Cmp, FrozenX, AdjX, DEBUG_TYPE);
  } else {
    auto *Cmp =
        B.CreateICmp(ICmpInst::ICMP_UGE, X, Y, Instr->getName() + ".cmp");
    ExpandedOp = B.CreateZExt(Cmp, Ty, Instr->getName() + ".udiv");
  }
  ExpandedOp->takeName(Instr);
  Instr->replaceAllUsesWith(ExpandedOp);
  Instr->eraseFromParent();
  ++NumUDivURemsNarrowedExpanded;
  return true;
}
 
/// Try to shrink a udiv/urem's width down to the smallest power of two that's
/// sufficient to contain its operands.
static bool narrowUDivOrURem(BinaryOperator *Instr, const ConstantRange &XCR,
                             const ConstantRange &YCR) {
  assert(Instr->getOpcode() == Instruction::UDiv ||
         Instr->getOpcode() == Instruction::URem);
 
  // Find the smallest power of two bitwidth that's sufficient to hold Instr's
  // operands.
 
  // What is the smallest bit width that can accommodate the entire value ranges
  // of both of the operands?
  unsigned MaxActiveBits = std::max(XCR.getActiveBits(), YCR.getActiveBits());
  // Don't shrink below 8 bits wide.
  unsigned NewWidth = std::max<unsigned>(PowerOf2Ceil(MaxActiveBits), 8);
 
  // NewWidth might be greater than OrigWidth if OrigWidth is not a power of
  // two.
  if (NewWidth >= Instr->getType()->getScalarSizeInBits())
    return false;
 
  ++NumUDivURemsNarrowed;
  IRBuilder<> B{Instr};
  auto *TruncTy = Instr->getType()->getWithNewBitWidth(NewWidth);
  auto *LHS = B.CreateTruncOrBitCast(Instr->getOperand(0), TruncTy,
                                     Instr->getName() + ".lhs.trunc");
  auto *RHS = B.CreateTruncOrBitCast(Instr->getOperand(1), TruncTy,
                                     Instr->getName() + ".rhs.trunc");
  auto *BO = B.CreateBinOp(Instr->getOpcode(), LHS, RHS, Instr->getName());
  auto *Zext = B.CreateZExt(BO, Instr->getType(), Instr->getName() + ".zext");
  if (auto *BinOp = dyn_cast<BinaryOperator>(BO))
    if (BinOp->getOpcode() == Instruction::UDiv)
      BinOp->setIsExact(Instr->isExact());
 
  Instr->replaceAllUsesWith(Zext);
  Instr->eraseFromParent();
  return true;
}
 
bool CVPImpl::processUDivOrURem(BinaryOperator *Instr) {
  assert(Instr->getOpcode() == Instruction::UDiv ||
         Instr->getOpcode() == Instruction::URem);
  ConstantRange XCR = LVI->getConstantRangeAtUse(Instr->getOperandUse(0),
                                                 /*UndefAllowed*/ false);
  // Allow undef for RHS, as we can assume it is division by zero UB.
  ConstantRange YCR = LVI->getConstantRangeAtUse(Instr->getOperandUse(1),
                                                 /*UndefAllowed*/ true);
  if (expandUDivOrURem(Instr, XCR, YCR))
    return true;
 
  return narrowUDivOrURem(Instr, XCR, YCR);
}
 
bool CVPImpl::processSRem(BinaryOperator *SDI, const ConstantRange &LCR,
                          const ConstantRange &RCR) {
  assert(SDI->getOpcode() == Instruction::SRem);
 
  if (LCR.abs().icmp(CmpInst::ICMP_ULT, RCR.abs())) {
    salvageDebugInfo(*SDI);
    SDI->replaceAllUsesWith(SDI->getOperand(0));
    SDI->eraseFromParent();
    return true;
  }
 
  struct Operand {
    Value *V;
    Domain D;
  };
  std::array<Operand, 2> Ops = {{{SDI->getOperand(0), getDomain(LCR)},
                                 {SDI->getOperand(1), getDomain(RCR)}}};
  if (Ops[0].D == Domain::Unknown || Ops[1].D == Domain::Unknown)
    return false;
 
  // We know domains of both of the operands!
  ++NumSRems;
 
  // We need operands to be non-negative, so negate each one that isn't.
  for (Operand &Op : Ops) {
    if (Op.D == Domain::NonNegative)
      continue;
    auto *BO = BinaryOperator::CreateNeg(Op.V, Op.V->getName() + ".nonneg",
                                         SDI->getIterator());
    BO->setDebugLoc(SDI->getDebugLoc());
    Op.V = BO;
  }
 
  auto *URem = BinaryOperator::CreateURem(Ops[0].V, Ops[1].V, SDI->getName(),
                                          SDI->getIterator());
  URem->setDebugLoc(SDI->getDebugLoc());
 
  auto *Res = URem;
 
  // If the divident was non-positive, we need to negate the result.
  if (Ops[0].D == Domain::NonPositive) {
    Res = BinaryOperator::CreateNeg(Res, Res->getName() + ".neg",
                                    SDI->getIterator());
    Res->setDebugLoc(SDI->getDebugLoc());
  }
 
  salvageDebugInfo(*SDI);
  SDI->replaceAllUsesWith(Res);
  SDI->eraseFromParent();
 
  // Try to simplify our new urem.
  processUDivOrURem(URem);
 
  return true;
}
 
/// See if LazyValueInfo's ability to exploit edge conditions or range
/// information is sufficient to prove the signs of both operands of this SDiv.
/// If this is the case, replace the SDiv with a UDiv. Even for local
/// conditions, this can sometimes prove conditions instcombine can't by
/// exploiting range information.
bool CVPImpl::processSDiv(BinaryOperator *SDI, const ConstantRange &LCR,
                          const ConstantRange &RCR) {
  assert(SDI->getOpcode() == Instruction::SDiv);
 
  // Check whether the division folds to a constant.
  ConstantRange DivCR = LCR.sdiv(RCR);
  if (const APInt *Elem = DivCR.getSingleElement()) {
    salvageDebugInfo(*SDI);
    SDI->replaceAllUsesWith(ConstantInt::get(SDI->getType(), *Elem));
    SDI->eraseFromParent();
    return true;
  }
 
  struct Operand {
    Value *V;
    Domain D;
  };
  std::array<Operand, 2> Ops = {{{SDI->getOperand(0), getDomain(LCR)},
                                 {SDI->getOperand(1), getDomain(RCR)}}};
  if (Ops[0].D == Domain::Unknown || Ops[1].D == Domain::Unknown)
    return false;
 
  // We know domains of both of the operands!
  ++NumSDivs;
 
  // We need operands to be non-negative, so negate each one that isn't.
  for (Operand &Op : Ops) {
    if (Op.D == Domain::NonNegative)
      continue;
    auto *BO = BinaryOperator::CreateNeg(Op.V, Op.V->getName() + ".nonneg",
                                         SDI->getIterator());
    BO->setDebugLoc(SDI->getDebugLoc());
    Op.V = BO;
  }
 
  auto *UDiv = BinaryOperator::CreateUDiv(Ops[0].V, Ops[1].V, SDI->getName(),
                                          SDI->getIterator());
  UDiv->setDebugLoc(SDI->getDebugLoc());
  UDiv->setIsExact(SDI->isExact());
 
  auto *Res = UDiv;
 
  // If the operands had two different domains, we need to negate the result.
  if (Ops[0].D != Ops[1].D) {
    Res = BinaryOperator::CreateNeg(Res, Res->getName() + ".neg",
                                    SDI->getIterator());
    Res->setDebugLoc(SDI->getDebugLoc());
  }
 
  salvageDebugInfo(*SDI);
  SDI->replaceAllUsesWith(Res);
  SDI->eraseFromParent();
 
  // Try to simplify our new udiv.
  processUDivOrURem(UDiv);
 
  return true;
}
 
bool CVPImpl::processSDivOrSRem(BinaryOperator *Instr) {
  assert(Instr->getOpcode() == Instruction::SDiv ||
         Instr->getOpcode() == Instruction::SRem);
  ConstantRange LCR =
      LVI->getConstantRangeAtUse(Instr->getOperandUse(0), /*AllowUndef*/ false);
  // Allow undef for RHS, as we can assume it is division by zero UB.
  ConstantRange RCR =
      LVI->getConstantRangeAtUse(Instr->getOperandUse(1), /*AlloweUndef*/ true);
  if (Instr->getOpcode() == Instruction::SDiv)
    if (processSDiv(Instr, LCR, RCR))
      return true;
 
  if (Instr->getOpcode() == Instruction::SRem) {
    if (processSRem(Instr, LCR, RCR))
      return true;
  }
 
  return narrowSDivOrSRem(Instr, LCR, RCR);
}
 
bool CVPImpl::processAShr(BinaryOperator *SDI) {
  ConstantRange LRange =
      LVI->getConstantRangeAtUse(SDI->getOperandUse(0), /*UndefAllowed*/ false);
  unsigned OrigWidth = SDI->getType()->getScalarSizeInBits();
  ConstantRange NegOneOrZero =
      ConstantRange(APInt(OrigWidth, (uint64_t)-1, true), APInt(OrigWidth, 1));
  if (NegOneOrZero.contains(LRange)) {
    // ashr of -1 or 0 never changes the value, so drop the whole instruction
    ++NumAShrsRemoved;
    salvageDebugInfo(*SDI);
    SDI->replaceAllUsesWith(SDI->getOperand(0));
    SDI->eraseFromParent();
    return true;
  }
 
  if (!LRange.isAllNonNegative())
    return false;
 
  ++NumAShrsConverted;
  auto *BO = BinaryOperator::CreateLShr(SDI->getOperand(0), SDI->getOperand(1),
                                        "", SDI->getIterator());
  BO->takeName(SDI);
  BO->setDebugLoc(SDI->getDebugLoc());
  BO->setIsExact(SDI->isExact());
  salvageDebugInfo(*SDI);
  SDI->replaceAllUsesWith(BO);
  SDI->eraseFromParent();
 
  return true;
}
 
bool CVPImpl::processSExt(SExtInst *SDI) {
  const Use &Base = SDI->getOperandUse(0);
  if (!LVI->getConstantRangeAtUse(Base, /*UndefAllowed*/ false)
           .isAllNonNegative())
    return false;
 
  ++NumSExt;
  auto *ZExt = CastInst::CreateZExtOrBitCast(Base, SDI->getType(), "",
                                             SDI->getIterator());
  ZExt->takeName(SDI);
  ZExt->setDebugLoc(SDI->getDebugLoc());
  ZExt->setNonNeg();
  salvageDebugInfo(*SDI);
  SDI->replaceAllUsesWith(ZExt);
  SDI->eraseFromParent();
 
  return true;
}
 
bool CVPImpl::processPossibleNonNeg(PossiblyNonNegInst *I) {
  if (I->hasNonNeg())
    return false;
 
  const Use &Base = I->getOperandUse(0);
  if (!LVI->getConstantRangeAtUse(Base, /*UndefAllowed*/ false)
           .isAllNonNegative())
    return false;
 
  ++NumNNeg;
  I->setNonNeg();
 
  return true;
}
 
bool CVPImpl::processSIToFP(SIToFPInst *SIToFP) {
  const Use &Base = SIToFP->getOperandUse(0);
  if (!LVI->getConstantRangeAtUse(Base, /*UndefAllowed*/ false)
           .isAllNonNegative())
    return false;
 
  ++NumSIToFP;
  auto *UIToFP = CastInst::Create(Instruction::UIToFP, Base, SIToFP->getType(),
                                  "", SIToFP->getIterator());
  UIToFP->takeName(SIToFP);
  UIToFP->setDebugLoc(SIToFP->getDebugLoc());
  UIToFP->setNonNeg();
  salvageDebugInfo(*SIToFP);
  SIToFP->replaceAllUsesWith(UIToFP);
  SIToFP->eraseFromParent();
 
  return true;
}
 
namespace {
struct NoWrapFlags {
  bool NSW = false;
  bool NUW = false;
};
} // namespace
 
// Check if the requested no-wrap flags are valid for \p Opcode on \p LRange and
// \p RRange.
static NoWrapFlags computeNoWrapFlags(Instruction::BinaryOps Opcode,
                                      const ConstantRange &LRange,
                                      const ConstantRange &RRange,
                                      bool CheckNSW, bool CheckNUW) {
  using OBO = OverflowingBinaryOperator;
  NoWrapFlags Flags;
  if (CheckNUW)
    Flags.NUW = ConstantRange::makeGuaranteedNoWrapRegion(Opcode, RRange,
                                                          OBO::NoUnsignedWrap)
                    .contains(LRange);
  if (CheckNSW)
    Flags.NSW = ConstantRange::makeGuaranteedNoWrapRegion(Opcode, RRange,
                                                          OBO::NoSignedWrap)
                    .contains(LRange);
  return Flags;
}
 
// Try to prove that \p BinOp does not wrap by looking at the operand ranges
// constrained at each of its use sites, rather than at the definition. This
// improves results, e.g. when all uses are constrained by a runtime check.
NoWrapFlags CVPImpl::inferNoWrapFromUses(BinaryOperator *BinOp, bool WantNSW,
                                         bool WantNUW) {
  // Skip analysis, when there are too many uses to check or any use is in the
  // same block.
  const unsigned MaxUsesToInspect = 4;
  BasicBlock *DefBB = BinOp->getParent();
  unsigned NumUses = 0;
  for (Use &U : BinOp->uses()) {
    if (++NumUses > MaxUsesToInspect)
      return {};
    auto *UserI = cast<Instruction>(U.getUser());
    if (isa<PHINode>(UserI) || UserI->getParent() == DefBB)
      return {};
  }
  if (NumUses == 0)
    return {};
 
  Instruction::BinaryOps Opcode = BinOp->getOpcode();
  NoWrapFlags Flags;
  Flags.NSW = WantNSW;
  Flags.NUW = WantNUW;
  for (Use &U : BinOp->uses()) {
    auto *UserI = cast<Instruction>(U.getUser());
    // Constrain both operands at this use site and see which flags still hold.
    ConstantRange LRange = LVI->getConstantRange(BinOp->getOperand(0), UserI,
                                                 /*UndefAllowed=*/false);
    ConstantRange RRange = LVI->getConstantRange(BinOp->getOperand(1), UserI,
                                                 /*UndefAllowed=*/false);
    Flags = computeNoWrapFlags(Opcode, LRange, RRange, Flags.NSW, Flags.NUW);
    if (!Flags.NSW && !Flags.NUW)
      return {};
  }
 
  return Flags;
}
 
bool CVPImpl::processBinOp(BinaryOperator *BinOp) {
  bool NSW = BinOp->hasNoSignedWrap();
  bool NUW = BinOp->hasNoUnsignedWrap();
  if (NSW && NUW)
    return false;
 
  Instruction::BinaryOps Opcode = BinOp->getOpcode();
  ConstantRange LRange = LVI->getConstantRangeAtUse(BinOp->getOperandUse(0),
                                                    /*UndefAllowed=*/false);
  ConstantRange RRange = LVI->getConstantRangeAtUse(BinOp->getOperandUse(1),
                                                    /*UndefAllowed=*/false);
 
  NoWrapFlags New =
      computeNoWrapFlags(Opcode, LRange, RRange, /*CheckNSW=*/!NSW,
                         /*CheckNUW=*/!NUW);
 
  // If a still-wanted flag could not be proven at the definition, retry using
  // the operand ranges constrained at the use sites. This is the more
  // expensive path, so it only runs when the cheap query above came up short.
  bool WantNSW = !NSW && !New.NSW;
  bool WantNUW = !NUW && !New.NUW;
  if (WantNSW || WantNUW) {
    NoWrapFlags FromUses = inferNoWrapFromUses(BinOp, WantNSW, WantNUW);
    New.NSW |= FromUses.NSW;
    New.NUW |= FromUses.NUW;
  }
 
  setDeducedOverflowingFlags(BinOp, Opcode, New.NSW, New.NUW);
 
  return New.NSW || New.NUW;
}
 
bool CVPImpl::processAnd(BinaryOperator *BinOp) {
  using namespace llvm::PatternMatch;
 
  // Pattern match (and lhs, C) where C includes a superset of bits which might
  // be set in lhs.  This is a common truncation idiom created by instcombine.
  const Use &LHS = BinOp->getOperandUse(0);
  const APInt *RHS;
  if (!match(BinOp->getOperand(1), m_LowBitMask(RHS)))
    return false;
 
  // We can only replace the AND with LHS based on range info if the range does
  // not include undef.
  ConstantRange LRange =
      LVI->getConstantRangeAtUse(LHS, /*UndefAllowed=*/false);
  if (!LRange.getUnsignedMax().ule(*RHS))
    return false;
 
  salvageDebugInfo(*BinOp);
  BinOp->replaceAllUsesWith(LHS);
  BinOp->eraseFromParent();
  NumAnd++;
  return true;
}
 
bool CVPImpl::processTrunc(TruncInst *TI) {
  if (TI->hasNoSignedWrap() && TI->hasNoUnsignedWrap())
    return false;
 
  ConstantRange Range =
      LVI->getConstantRangeAtUse(TI->getOperandUse(0), /*UndefAllowed=*/false);
  uint64_t DestWidth = TI->getDestTy()->getScalarSizeInBits();
  bool Changed = false;
 
  if (!TI->hasNoUnsignedWrap()) {
    if (Range.getActiveBits() <= DestWidth) {
      TI->setHasNoUnsignedWrap(true);
      ++NumNUW;
      Changed = true;
    }
  }
 
  if (!TI->hasNoSignedWrap()) {
    if (Range.getMinSignedBits() <= DestWidth) {
      TI->setHasNoSignedWrap(true);
      ++NumNSW;
      Changed = true;
    }
  }
 
  return Changed;
}
 
bool CVPImpl::processReturn(ReturnInst *RI) {
  // Try to determine the return value if we can.  This is mainly here to
  // simplify the writing of unit tests, but also helps to enable IPO by
  // constant folding the return values of callees.
  Value *RetVal = RI->getReturnValue();
  if (!RetVal)
    return false; // handle "ret void"
  if (RetRange && !RetRange->isFullSet())
    RetRange = RetRange->unionWith(
        LVI->getConstantRange(RetVal, RI, /*UndefAllowed=*/false));
 
  if (isa<Constant>(RetVal))
    return false; // nothing to do
  if (Constant *C = getConstantAt(RetVal, RI)) {
    ++NumReturns;
    RI->replaceUsesOfWith(RetVal, C);
    return true;
  }
  return false;
}
 
bool CVPImpl::processInstruction(Instruction &I) {
  switch (I.getOpcode()) {
  case Instruction::Select:
    return processSelect(cast<SelectInst>(&I));
  case Instruction::PHI:
    return processPHI(cast<PHINode>(&I));
  case Instruction::ICmp:
  case Instruction::FCmp:
    return processCmp(cast<CmpInst>(&I));
  case Instruction::Call:
  case Instruction::Invoke:
    return processCallSite(cast<CallBase>(I));
  case Instruction::SRem:
  case Instruction::SDiv:
    return processSDivOrSRem(cast<BinaryOperator>(&I));
  case Instruction::UDiv:
  case Instruction::URem:
    return processUDivOrURem(cast<BinaryOperator>(&I));
  case Instruction::AShr:
    return processAShr(cast<BinaryOperator>(&I));
  case Instruction::SExt:
    return processSExt(cast<SExtInst>(&I));
  case Instruction::ZExt:
  case Instruction::UIToFP:
    return processPossibleNonNeg(cast<PossiblyNonNegInst>(&I));
  case Instruction::SIToFP:
    return processSIToFP(cast<SIToFPInst>(&I));
  case Instruction::Add:
  case Instruction::Sub:
  case Instruction::Mul:
  case Instruction::Shl:
    return processBinOp(cast<BinaryOperator>(&I));
  case Instruction::And:
    return processAnd(cast<BinaryOperator>(&I));
  case Instruction::Trunc:
    return processTrunc(cast<TruncInst>(&I));
  case Instruction::Switch:
    return processSwitch(cast<SwitchInst>(&I));
  case Instruction::Ret:
    return processReturn(cast<ReturnInst>(&I));
  default:
    return false;
  }
}
 
bool CVPImpl::inferReturnRangeAttr() {
  // Infer range attribute on return value.
  if (!RetRange || RetRange->isFullSet())
    return false;
  Attribute RangeAttr = F.getRetAttribute(Attribute::Range);
  if (RangeAttr.isValid())
    RetRange = RetRange->intersectWith(RangeAttr.getRange());
  // Don't add attribute for constant integer returns to reduce noise. These
  // are propagated across functions by IPSCCP.
  if (RetRange->isEmptySet() || RetRange->isSingleElement())
    return false;
  F.addRangeRetAttr(*RetRange);
  return true;
}
 
bool CVPImpl::run() {
  if (F.hasExactDefinition() && F.getReturnType()->isIntOrIntVectorTy())
    RetRange =
        ConstantRange::getEmpty(F.getReturnType()->getScalarSizeInBits());
 
  bool Changed = false;
  // Visiting in a pre-order depth-first traversal causes us to simplify early
  // blocks before querying later blocks (which require us to analyze early
  // blocks).  Eagerly simplifying shallow blocks means there is strictly less
  // work to do for deep blocks.  This also means we don't visit unreachable
  // blocks.
  for (BasicBlock *BB : depth_first(&F.getEntryBlock()))
    for (Instruction &I : llvm::make_early_inc_range(*BB))
      Changed |= processInstruction(I);
 
  Changed |= inferReturnRangeAttr();
  return Changed;
}
 
PreservedAnalyses
CorrelatedValuePropagationPass::run(Function &F, FunctionAnalysisManager &AM) {
  LazyValueInfo *LVI = &AM.getResult<LazyValueAnalysis>(F);
  DominatorTree *DT = &AM.getResult<DominatorTreeAnalysis>(F);
 
  CVPImpl Impl(F, LVI, DT, getBestSimplifyQuery(AM, F));
  bool Changed = Impl.run();
 
  PreservedAnalyses PA;
  if (!Changed) {
    PA = PreservedAnalyses::all();
  } else {
#if defined(EXPENSIVE_CHECKS)
    assert(DT->verify(DominatorTree::VerificationLevel::Full));
#else
    assert(DT->verify(DominatorTree::VerificationLevel::Fast));
#endif // EXPENSIVE_CHECKS
 
    PA.preserve<DominatorTreeAnalysis>();
    PA.preserve<LazyValueAnalysis>();
  }
 
  // Keeping LVI alive is expensive, both because it uses a lot of memory, and
  // because invalidating values in LVI is expensive. While CVP does preserve
  // LVI, we know that passes after JumpThreading+CVP will not need the result
  // of this analysis, so we forcefully discard it early.
  PA.abandon<LazyValueAnalysis>();
  return PA;
}