contrib/llvm/lib/Transforms/Scalar/CorrelatedValuePropagation.cpp

   1 //===- CorrelatedValuePropagation.cpp - Propagate CFG-derived info --------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Correlated Value Propagation pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
  15 #include "llvm/ADT/Statistic.h"
  16 #include "llvm/Analysis/AssumptionCache.h"
  17 #include "llvm/Analysis/GlobalsModRef.h"
  18 #include "llvm/Analysis/InstructionSimplify.h"
  19 #include "llvm/Analysis/LazyValueInfo.h"
  20 #include "llvm/IR/CFG.h"
  21 #include "llvm/IR/ConstantRange.h"
  22 #include "llvm/IR/Constants.h"
  23 #include "llvm/IR/Function.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/Module.h"
  26 #include "llvm/Pass.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/Transforms/Scalar.h"
  30 #include "llvm/Transforms/Utils/Local.h"
  31 using namespace llvm;
  32
  33 #define DEBUG_TYPE "correlated-value-propagation"
  34
  35 STATISTIC(NumPhis,      "Number of phis propagated");
  36 STATISTIC(NumSelects,   "Number of selects propagated");
  37 STATISTIC(NumMemAccess, "Number of memory access targets propagated");
  38 STATISTIC(NumCmps,      "Number of comparisons propagated");
  39 STATISTIC(NumReturns,   "Number of return values propagated");
  40 STATISTIC(NumDeadCases, "Number of switch cases removed");
  41 STATISTIC(NumSDivs,     "Number of sdiv converted to udiv");
  42 STATISTIC(NumAShrs,     "Number of ashr converted to lshr");
  43 STATISTIC(NumSRems,     "Number of srem converted to urem");
  44
  45 static cl::opt<bool> DontProcessAdds("cvp-dont-process-adds", cl::init(true));
  46
  47 namespace {
  48   class CorrelatedValuePropagation : public FunctionPass {
  49   public:
  50     static char ID;
  51     CorrelatedValuePropagation(): FunctionPass(ID) {
  52      initializeCorrelatedValuePropagationPass(*PassRegistry::getPassRegistry());
  53     }
  54
  55     bool runOnFunction(Function &F) override;
  56
  57     void getAnalysisUsage(AnalysisUsage &AU) const override {
  58       AU.addRequired<LazyValueInfoWrapperPass>();
  59       AU.addPreserved<GlobalsAAWrapperPass>();
  60     }
  61   };
  62 }
  63
  64 char CorrelatedValuePropagation::ID = 0;
  65 INITIALIZE_PASS_BEGIN(CorrelatedValuePropagation, "correlated-propagation",
  66                 "Value Propagation", false, false)
  67 INITIALIZE_PASS_DEPENDENCY(LazyValueInfoWrapperPass)
  68 INITIALIZE_PASS_END(CorrelatedValuePropagation, "correlated-propagation",
  69                 "Value Propagation", false, false)
  70
  71 // Public interface to the Value Propagation pass
  72 Pass *llvm::createCorrelatedValuePropagationPass() {
  73   return new CorrelatedValuePropagation();
  74 }
  75
  76 static bool processSelect(SelectInst *S, LazyValueInfo *LVI) {
  77   if (S->getType()->isVectorTy()) return false;
  78   if (isa<Constant>(S->getOperand(0))) return false;
  79
  80   Constant *C = LVI->getConstant(S->getOperand(0), S->getParent(), S);
  81   if (!C) return false;
  82
  83   ConstantInt *CI = dyn_cast<ConstantInt>(C);
  84   if (!CI) return false;
  85
  86   Value *ReplaceWith = S->getOperand(1);
  87   Value *Other = S->getOperand(2);
  88   if (!CI->isOne()) std::swap(ReplaceWith, Other);
  89   if (ReplaceWith == S) ReplaceWith = UndefValue::get(S->getType());
  90
  91   S->replaceAllUsesWith(ReplaceWith);
  92   S->eraseFromParent();
  93
  94   ++NumSelects;
  95
  96   return true;
  97 }
  98
  99 static bool processPHI(PHINode *P, LazyValueInfo *LVI,
 100                        const SimplifyQuery &SQ) {
 101   bool Changed = false;
 102
 103   BasicBlock *BB = P->getParent();
 104   for (unsigned i = 0, e = P->getNumIncomingValues(); i < e; ++i) {
 105     Value *Incoming = P->getIncomingValue(i);
 106     if (isa<Constant>(Incoming)) continue;
 107
 108     Value *V = LVI->getConstantOnEdge(Incoming, P->getIncomingBlock(i), BB, P);
 109
 110     // Look if the incoming value is a select with a scalar condition for which
 111     // LVI can tells us the value. In that case replace the incoming value with
 112     // the appropriate value of the select. This often allows us to remove the
 113     // select later.
 114     if (!V) {
 115       SelectInst *SI = dyn_cast<SelectInst>(Incoming);
 116       if (!SI) continue;
 117
 118       Value *Condition = SI->getCondition();
 119       if (!Condition->getType()->isVectorTy()) {
 120         if (Constant *C = LVI->getConstantOnEdge(
 121                 Condition, P->getIncomingBlock(i), BB, P)) {
 122           if (C->isOneValue()) {
 123             V = SI->getTrueValue();
 124           } else if (C->isZeroValue()) {
 125             V = SI->getFalseValue();
 126           }
 127           // Once LVI learns to handle vector types, we could also add support
 128           // for vector type constants that are not all zeroes or all ones.
 129         }
 130       }
 131
 132       // Look if the select has a constant but LVI tells us that the incoming
 133       // value can never be that constant. In that case replace the incoming
 134       // value with the other value of the select. This often allows us to
 135       // remove the select later.
 136       if (!V) {
 137         Constant *C = dyn_cast<Constant>(SI->getFalseValue());
 138         if (!C) continue;
 139
 140         if (LVI->getPredicateOnEdge(ICmpInst::ICMP_EQ, SI, C,
 141               P->getIncomingBlock(i), BB, P) !=
 142             LazyValueInfo::False)
 143           continue;
 144         V = SI->getTrueValue();
 145       }
 146
 147       DEBUG(dbgs() << "CVP: Threading PHI over " << *SI << '\n');
 148     }
 149
 150     P->setIncomingValue(i, V);
 151     Changed = true;
 152   }
 153
 154   if (Value *V = SimplifyInstruction(P, SQ)) {
 155     P->replaceAllUsesWith(V);
 156     P->eraseFromParent();
 157     Changed = true;
 158   }
 159
 160   if (Changed)
 161     ++NumPhis;
 162
 163   return Changed;
 164 }
 165
 166 static bool processMemAccess(Instruction *I, LazyValueInfo *LVI) {
 167   Value *Pointer = nullptr;
 168   if (LoadInst *L = dyn_cast<LoadInst>(I))
 169     Pointer = L->getPointerOperand();
 170   else
 171     Pointer = cast<StoreInst>(I)->getPointerOperand();
 172
 173   if (isa<Constant>(Pointer)) return false;
 174
 175   Constant *C = LVI->getConstant(Pointer, I->getParent(), I);
 176   if (!C) return false;
 177
 178   ++NumMemAccess;
 179   I->replaceUsesOfWith(Pointer, C);
 180   return true;
 181 }
 182
 183 /// See if LazyValueInfo's ability to exploit edge conditions or range
 184 /// information is sufficient to prove this comparison. Even for local
 185 /// conditions, this can sometimes prove conditions instcombine can't by
 186 /// exploiting range information.
 187 static bool processCmp(CmpInst *C, LazyValueInfo *LVI) {
 188   Value *Op0 = C->getOperand(0);
 189   Constant *Op1 = dyn_cast<Constant>(C->getOperand(1));
 190   if (!Op1) return false;
 191
 192   // As a policy choice, we choose not to waste compile time on anything where
 193   // the comparison is testing local values.  While LVI can sometimes reason
 194   // about such cases, it's not its primary purpose.  We do make sure to do
 195   // the block local query for uses from terminator instructions, but that's
 196   // handled in the code for each terminator.
 197   auto *I = dyn_cast<Instruction>(Op0);
 198   if (I && I->getParent() == C->getParent())
 199     return false;
 200
 201   LazyValueInfo::Tristate Result =
 202     LVI->getPredicateAt(C->getPredicate(), Op0, Op1, C);
 203   if (Result == LazyValueInfo::Unknown) return false;
 204
 205   ++NumCmps;
 206   if (Result == LazyValueInfo::True)
 207     C->replaceAllUsesWith(ConstantInt::getTrue(C->getContext()));
 208   else
 209     C->replaceAllUsesWith(ConstantInt::getFalse(C->getContext()));
 210   C->eraseFromParent();
 211
 212   return true;
 213 }
 214
 215 /// Simplify a switch instruction by removing cases which can never fire. If the
 216 /// uselessness of a case could be determined locally then constant propagation
 217 /// would already have figured it out. Instead, walk the predecessors and
 218 /// statically evaluate cases based on information available on that edge. Cases
 219 /// that cannot fire no matter what the incoming edge can safely be removed. If
 220 /// a case fires on every incoming edge then the entire switch can be removed
 221 /// and replaced with a branch to the case destination.
 222 static bool processSwitch(SwitchInst *SI, LazyValueInfo *LVI) {
 223   Value *Cond = SI->getCondition();
 224   BasicBlock *BB = SI->getParent();
 225
 226   // If the condition was defined in same block as the switch then LazyValueInfo
 227   // currently won't say anything useful about it, though in theory it could.
 228   if (isa<Instruction>(Cond) && cast<Instruction>(Cond)->getParent() == BB)
 229     return false;
 230
 231   // If the switch is unreachable then trying to improve it is a waste of time.
 232   pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
 233   if (PB == PE) return false;
 234
 235   // Analyse each switch case in turn.
 236   bool Changed = false;
 237   for (auto CI = SI->case_begin(), CE = SI->case_end(); CI != CE;) {
 238     ConstantInt *Case = CI->getCaseValue();
 239
 240     // Check to see if the switch condition is equal to/not equal to the case
 241     // value on every incoming edge, equal/not equal being the same each time.
 242     LazyValueInfo::Tristate State = LazyValueInfo::Unknown;
 243     for (pred_iterator PI = PB; PI != PE; ++PI) {
 244       // Is the switch condition equal to the case value?
 245       LazyValueInfo::Tristate Value = LVI->getPredicateOnEdge(CmpInst::ICMP_EQ,
 246                                                               Cond, Case, *PI,
 247                                                               BB, SI);
 248       // Give up on this case if nothing is known.
 249       if (Value == LazyValueInfo::Unknown) {
 250         State = LazyValueInfo::Unknown;
 251         break;
 252       }
 253
 254       // If this was the first edge to be visited, record that all other edges
 255       // need to give the same result.
 256       if (PI == PB) {
 257         State = Value;
 258         continue;
 259       }
 260
 261       // If this case is known to fire for some edges and known not to fire for
 262       // others then there is nothing we can do - give up.
 263       if (Value != State) {
 264         State = LazyValueInfo::Unknown;
 265         break;
 266       }
 267     }
 268
 269     if (State == LazyValueInfo::False) {
 270       // This case never fires - remove it.
 271       CI->getCaseSuccessor()->removePredecessor(BB);
 272       CI = SI->removeCase(CI);
 273       CE = SI->case_end();
 274
 275       // The condition can be modified by removePredecessor's PHI simplification
 276       // logic.
 277       Cond = SI->getCondition();
 278
 279       ++NumDeadCases;
 280       Changed = true;
 281       continue;
 282     }
 283     if (State == LazyValueInfo::True) {
 284       // This case always fires.  Arrange for the switch to be turned into an
 285       // unconditional branch by replacing the switch condition with the case
 286       // value.
 287       SI->setCondition(Case);
 288       NumDeadCases += SI->getNumCases();
 289       Changed = true;
 290       break;
 291     }
 292
 293     // Increment the case iterator since we didn't delete it.
 294     ++CI;
 295   }
 296
 297   if (Changed)
 298     // If the switch has been simplified to the point where it can be replaced
 299     // by a branch then do so now.
 300     ConstantFoldTerminator(BB);
 301
 302   return Changed;
 303 }
 304
 305 /// Infer nonnull attributes for the arguments at the specified callsite.
 306 static bool processCallSite(CallSite CS, LazyValueInfo *LVI) {
 307   SmallVector<unsigned, 4> ArgNos;
 308   unsigned ArgNo = 0;
 309
 310   for (Value *V : CS.args()) {
 311     PointerType *Type = dyn_cast<PointerType>(V->getType());
 312     // Try to mark pointer typed parameters as non-null.  We skip the
 313     // relatively expensive analysis for constants which are obviously either
 314     // null or non-null to start with.
 315     if (Type && !CS.paramHasAttr(ArgNo, Attribute::NonNull) &&
 316         !isa<Constant>(V) &&
 317         LVI->getPredicateAt(ICmpInst::ICMP_EQ, V,
 318                             ConstantPointerNull::get(Type),
 319                             CS.getInstruction()) == LazyValueInfo::False)
 320       ArgNos.push_back(ArgNo);
 321     ArgNo++;
 322   }
 323
 324   assert(ArgNo == CS.arg_size() && "sanity check");
 325
 326   if (ArgNos.empty())
 327     return false;
 328
 329   AttributeList AS = CS.getAttributes();
 330   LLVMContext &Ctx = CS.getInstruction()->getContext();
 331   AS = AS.addParamAttribute(Ctx, ArgNos,
 332                             Attribute::get(Ctx, Attribute::NonNull));
 333   CS.setAttributes(AS);
 334
 335   return true;
 336 }
 337
 338 // Helper function to rewrite srem and sdiv. As a policy choice, we choose not
 339 // to waste compile time on anything where the operands are local defs.  While
 340 // LVI can sometimes reason about such cases, it's not its primary purpose.
 341 static bool hasLocalDefs(BinaryOperator *SDI) {
 342   for (Value *O : SDI->operands()) {
 343     auto *I = dyn_cast<Instruction>(O);
 344     if (I && I->getParent() == SDI->getParent())
 345       return true;
 346   }
 347   return false;
 348 }
 349
 350 static bool hasPositiveOperands(BinaryOperator *SDI, LazyValueInfo *LVI) {
 351   Constant *Zero = ConstantInt::get(SDI->getType(), 0);
 352   for (Value *O : SDI->operands()) {
 353     auto Result = LVI->getPredicateAt(ICmpInst::ICMP_SGE, O, Zero, SDI);
 354     if (Result != LazyValueInfo::True)
 355       return false;
 356   }
 357   return true;
 358 }
 359
 360 static bool processSRem(BinaryOperator *SDI, LazyValueInfo *LVI) {
 361   if (SDI->getType()->isVectorTy() || hasLocalDefs(SDI) ||
 362       !hasPositiveOperands(SDI, LVI))
 363     return false;
 364
 365   ++NumSRems;
 366   auto *BO = BinaryOperator::CreateURem(SDI->getOperand(0), SDI->getOperand(1),
 367                                         SDI->getName(), SDI);
 368   SDI->replaceAllUsesWith(BO);
 369   SDI->eraseFromParent();
 370   return true;
 371 }
 372
 373 /// See if LazyValueInfo's ability to exploit edge conditions or range
 374 /// information is sufficient to prove the both operands of this SDiv are
 375 /// positive.  If this is the case, replace the SDiv with a UDiv. Even for local
 376 /// conditions, this can sometimes prove conditions instcombine can't by
 377 /// exploiting range information.
 378 static bool processSDiv(BinaryOperator *SDI, LazyValueInfo *LVI) {
 379   if (SDI->getType()->isVectorTy() || hasLocalDefs(SDI) ||
 380       !hasPositiveOperands(SDI, LVI))
 381     return false;
 382
 383   ++NumSDivs;
 384   auto *BO = BinaryOperator::CreateUDiv(SDI->getOperand(0), SDI->getOperand(1),
 385                                         SDI->getName(), SDI);
 386   BO->setIsExact(SDI->isExact());
 387   SDI->replaceAllUsesWith(BO);
 388   SDI->eraseFromParent();
 389
 390   return true;
 391 }
 392
 393 static bool processAShr(BinaryOperator *SDI, LazyValueInfo *LVI) {
 394   if (SDI->getType()->isVectorTy() || hasLocalDefs(SDI))
 395     return false;
 396
 397   Constant *Zero = ConstantInt::get(SDI->getType(), 0);
 398   if (LVI->getPredicateAt(ICmpInst::ICMP_SGE, SDI->getOperand(0), Zero, SDI) !=
 399       LazyValueInfo::True)
 400     return false;
 401
 402   ++NumAShrs;
 403   auto *BO = BinaryOperator::CreateLShr(SDI->getOperand(0), SDI->getOperand(1),
 404                                         SDI->getName(), SDI);
 405   BO->setIsExact(SDI->isExact());
 406   SDI->replaceAllUsesWith(BO);
 407   SDI->eraseFromParent();
 408
 409   return true;
 410 }
 411
 412 static bool processAdd(BinaryOperator *AddOp, LazyValueInfo *LVI) {
 413   typedef OverflowingBinaryOperator OBO;
 414
 415   if (DontProcessAdds)
 416     return false;
 417
 418   if (AddOp->getType()->isVectorTy() || hasLocalDefs(AddOp))
 419     return false;
 420
 421   bool NSW = AddOp->hasNoSignedWrap();
 422   bool NUW = AddOp->hasNoUnsignedWrap();
 423   if (NSW && NUW)
 424     return false;
 425
 426   BasicBlock *BB = AddOp->getParent();
 427
 428   Value *LHS = AddOp->getOperand(0);
 429   Value *RHS = AddOp->getOperand(1);
 430
 431   ConstantRange LRange = LVI->getConstantRange(LHS, BB, AddOp);
 432
 433   // Initialize RRange only if we need it. If we know that guaranteed no wrap
 434   // range for the given LHS range is empty don't spend time calculating the
 435   // range for the RHS.
 436   Optional<ConstantRange> RRange;
 437   auto LazyRRange = [&] () {
 438       if (!RRange)
 439         RRange = LVI->getConstantRange(RHS, BB, AddOp);
 440       return RRange.getValue();
 441   };
 442
 443   bool Changed = false;
 444   if (!NUW) {
 445     ConstantRange NUWRange = ConstantRange::makeGuaranteedNoWrapRegion(
 446         BinaryOperator::Add, LRange, OBO::NoUnsignedWrap);
 447     if (!NUWRange.isEmptySet()) {
 448       bool NewNUW = NUWRange.contains(LazyRRange());
 449       AddOp->setHasNoUnsignedWrap(NewNUW);
 450       Changed |= NewNUW;
 451     }
 452   }
 453   if (!NSW) {
 454     ConstantRange NSWRange = ConstantRange::makeGuaranteedNoWrapRegion(
 455         BinaryOperator::Add, LRange, OBO::NoSignedWrap);
 456     if (!NSWRange.isEmptySet()) {
 457       bool NewNSW = NSWRange.contains(LazyRRange());
 458       AddOp->setHasNoSignedWrap(NewNSW);
 459       Changed |= NewNSW;
 460     }
 461   }
 462
 463   return Changed;
 464 }
 465
 466 static Constant *getConstantAt(Value *V, Instruction *At, LazyValueInfo *LVI) {
 467   if (Constant *C = LVI->getConstant(V, At->getParent(), At))
 468     return C;
 469
 470   // TODO: The following really should be sunk inside LVI's core algorithm, or
 471   // at least the outer shims around such.
 472   auto *C = dyn_cast<CmpInst>(V);
 473   if (!C) return nullptr;
 474
 475   Value *Op0 = C->getOperand(0);
 476   Constant *Op1 = dyn_cast<Constant>(C->getOperand(1));
 477   if (!Op1) return nullptr;
 478
 479   LazyValueInfo::Tristate Result =
 480     LVI->getPredicateAt(C->getPredicate(), Op0, Op1, At);
 481   if (Result == LazyValueInfo::Unknown)
 482     return nullptr;
 483
 484   return (Result == LazyValueInfo::True) ?
 485     ConstantInt::getTrue(C->getContext()) :
 486     ConstantInt::getFalse(C->getContext());
 487 }
 488
 489 static bool runImpl(Function &F, LazyValueInfo *LVI, const SimplifyQuery &SQ) {
 490   bool FnChanged = false;
 491   // Visiting in a pre-order depth-first traversal causes us to simplify early
 492   // blocks before querying later blocks (which require us to analyze early
 493   // blocks).  Eagerly simplifying shallow blocks means there is strictly less
 494   // work to do for deep blocks.  This also means we don't visit unreachable
 495   // blocks.
 496   for (BasicBlock *BB : depth_first(&F.getEntryBlock())) {
 497     bool BBChanged = false;
 498     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE;) {
 499       Instruction *II = &*BI++;
 500       switch (II->getOpcode()) {
 501       case Instruction::Select:
 502         BBChanged |= processSelect(cast<SelectInst>(II), LVI);
 503         break;
 504       case Instruction::PHI:
 505         BBChanged |= processPHI(cast<PHINode>(II), LVI, SQ);
 506         break;
 507       case Instruction::ICmp:
 508       case Instruction::FCmp:
 509         BBChanged |= processCmp(cast<CmpInst>(II), LVI);
 510         break;
 511       case Instruction::Load:
 512       case Instruction::Store:
 513         BBChanged |= processMemAccess(II, LVI);
 514         break;
 515       case Instruction::Call:
 516       case Instruction::Invoke:
 517         BBChanged |= processCallSite(CallSite(II), LVI);
 518         break;
 519       case Instruction::SRem:
 520         BBChanged |= processSRem(cast<BinaryOperator>(II), LVI);
 521         break;
 522       case Instruction::SDiv:
 523         BBChanged |= processSDiv(cast<BinaryOperator>(II), LVI);
 524         break;
 525       case Instruction::AShr:
 526         BBChanged |= processAShr(cast<BinaryOperator>(II), LVI);
 527         break;
 528       case Instruction::Add:
 529         BBChanged |= processAdd(cast<BinaryOperator>(II), LVI);
 530         break;
 531       }
 532     }
 533
 534     Instruction *Term = BB->getTerminator();
 535     switch (Term->getOpcode()) {
 536     case Instruction::Switch:
 537       BBChanged |= processSwitch(cast<SwitchInst>(Term), LVI);
 538       break;
 539     case Instruction::Ret: {
 540       auto *RI = cast<ReturnInst>(Term);
 541       // Try to determine the return value if we can.  This is mainly here to
 542       // simplify the writing of unit tests, but also helps to enable IPO by
 543       // constant folding the return values of callees.
 544       auto *RetVal = RI->getReturnValue();
 545       if (!RetVal) break; // handle "ret void"
 546       if (isa<Constant>(RetVal)) break; // nothing to do
 547       if (auto *C = getConstantAt(RetVal, RI, LVI)) {
 548         ++NumReturns;
 549         RI->replaceUsesOfWith(RetVal, C);
 550         BBChanged = true;
 551       }
 552     }
 553     }
 554
 555     FnChanged |= BBChanged;
 556   }
 557
 558   return FnChanged;
 559 }
 560
 561 bool CorrelatedValuePropagation::runOnFunction(Function &F) {
 562   if (skipFunction(F))
 563     return false;
 564
 565   LazyValueInfo *LVI = &getAnalysis<LazyValueInfoWrapperPass>().getLVI();
 566   return runImpl(F, LVI, getBestSimplifyQuery(*this, F));
 567 }
 568
 569 PreservedAnalyses
 570 CorrelatedValuePropagationPass::run(Function &F, FunctionAnalysisManager &AM) {
 571
 572   LazyValueInfo *LVI = &AM.getResult<LazyValueAnalysis>(F);
 573   bool Changed = runImpl(F, LVI, getBestSimplifyQuery(AM, F));
 574
 575   if (!Changed)
 576     return PreservedAnalyses::all();
 577   PreservedAnalyses PA;
 578   PA.preserve<GlobalsAA>();
 579   return PA;
 580 }