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.h"
  15 #include "llvm/ADT/Statistic.h"
  16 #include "llvm/Analysis/InstructionSimplify.h"
  17 #include "llvm/Analysis/LazyValueInfo.h"
  18 #include "llvm/IR/CFG.h"
  19 #include "llvm/IR/Constants.h"
  20 #include "llvm/IR/Function.h"
  21 #include "llvm/IR/Instructions.h"
  22 #include "llvm/Pass.h"
  23 #include "llvm/Support/Debug.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include "llvm/Transforms/Utils/Local.h"
  26 using namespace llvm;
  27
  28 #define DEBUG_TYPE "correlated-value-propagation"
  29
  30 STATISTIC(NumPhis,      "Number of phis propagated");
  31 STATISTIC(NumSelects,   "Number of selects propagated");
  32 STATISTIC(NumMemAccess, "Number of memory access targets propagated");
  33 STATISTIC(NumCmps,      "Number of comparisons propagated");
  34 STATISTIC(NumDeadCases, "Number of switch cases removed");
  35
  36 namespace {
  37   class CorrelatedValuePropagation : public FunctionPass {
  38     LazyValueInfo *LVI;
  39
  40     bool processSelect(SelectInst *SI);
  41     bool processPHI(PHINode *P);
  42     bool processMemAccess(Instruction *I);
  43     bool processCmp(CmpInst *C);
  44     bool processSwitch(SwitchInst *SI);
  45
  46   public:
  47     static char ID;
  48     CorrelatedValuePropagation(): FunctionPass(ID) {
  49      initializeCorrelatedValuePropagationPass(*PassRegistry::getPassRegistry());
  50     }
  51
  52     bool runOnFunction(Function &F) override;
  53
  54     void getAnalysisUsage(AnalysisUsage &AU) const override {
  55       AU.addRequired<LazyValueInfo>();
  56     }
  57   };
  58 }
  59
  60 char CorrelatedValuePropagation::ID = 0;
  61 INITIALIZE_PASS_BEGIN(CorrelatedValuePropagation, "correlated-propagation",
  62                 "Value Propagation", false, false)
  63 INITIALIZE_PASS_DEPENDENCY(LazyValueInfo)
  64 INITIALIZE_PASS_END(CorrelatedValuePropagation, "correlated-propagation",
  65                 "Value Propagation", false, false)
  66
  67 // Public interface to the Value Propagation pass
  68 Pass *llvm::createCorrelatedValuePropagationPass() {
  69   return new CorrelatedValuePropagation();
  70 }
  71
  72 bool CorrelatedValuePropagation::processSelect(SelectInst *S) {
  73   if (S->getType()->isVectorTy()) return false;
  74   if (isa<Constant>(S->getOperand(0))) return false;
  75
  76   Constant *C = LVI->getConstant(S->getOperand(0), S->getParent());
  77   if (!C) return false;
  78
  79   ConstantInt *CI = dyn_cast<ConstantInt>(C);
  80   if (!CI) return false;
  81
  82   Value *ReplaceWith = S->getOperand(1);
  83   Value *Other = S->getOperand(2);
  84   if (!CI->isOne()) std::swap(ReplaceWith, Other);
  85   if (ReplaceWith == S) ReplaceWith = UndefValue::get(S->getType());
  86
  87   S->replaceAllUsesWith(ReplaceWith);
  88   S->eraseFromParent();
  89
  90   ++NumSelects;
  91
  92   return true;
  93 }
  94
  95 bool CorrelatedValuePropagation::processPHI(PHINode *P) {
  96   bool Changed = false;
  97
  98   BasicBlock *BB = P->getParent();
  99   for (unsigned i = 0, e = P->getNumIncomingValues(); i < e; ++i) {
 100     Value *Incoming = P->getIncomingValue(i);
 101     if (isa<Constant>(Incoming)) continue;
 102
 103     Value *V = LVI->getConstantOnEdge(Incoming, P->getIncomingBlock(i), BB);
 104
 105     // Look if the incoming value is a select with a constant but LVI tells us
 106     // that the incoming value can never be that constant. In that case replace
 107     // the incoming value with the other value of the select. This often allows
 108     // us to remove the select later.
 109     if (!V) {
 110       SelectInst *SI = dyn_cast<SelectInst>(Incoming);
 111       if (!SI) continue;
 112
 113       Constant *C = dyn_cast<Constant>(SI->getFalseValue());
 114       if (!C) continue;
 115
 116       if (LVI->getPredicateOnEdge(ICmpInst::ICMP_EQ, SI, C,
 117                                   P->getIncomingBlock(i), BB) !=
 118           LazyValueInfo::False)
 119         continue;
 120
 121       DEBUG(dbgs() << "CVP: Threading PHI over " << *SI << '\n');
 122       V = SI->getTrueValue();
 123     }
 124
 125     P->setIncomingValue(i, V);
 126     Changed = true;
 127   }
 128
 129   // FIXME: Provide DL, TLI, DT, AT to SimplifyInstruction.
 130   if (Value *V = SimplifyInstruction(P)) {
 131     P->replaceAllUsesWith(V);
 132     P->eraseFromParent();
 133     Changed = true;
 134   }
 135
 136   if (Changed)
 137     ++NumPhis;
 138
 139   return Changed;
 140 }
 141
 142 bool CorrelatedValuePropagation::processMemAccess(Instruction *I) {
 143   Value *Pointer = nullptr;
 144   if (LoadInst *L = dyn_cast<LoadInst>(I))
 145     Pointer = L->getPointerOperand();
 146   else
 147     Pointer = cast<StoreInst>(I)->getPointerOperand();
 148
 149   if (isa<Constant>(Pointer)) return false;
 150
 151   Constant *C = LVI->getConstant(Pointer, I->getParent());
 152   if (!C) return false;
 153
 154   ++NumMemAccess;
 155   I->replaceUsesOfWith(Pointer, C);
 156   return true;
 157 }
 158
 159 /// processCmp - If the value of this comparison could be determined locally,
 160 /// constant propagation would already have figured it out.  Instead, walk
 161 /// the predecessors and statically evaluate the comparison based on information
 162 /// available on that edge.  If a given static evaluation is true on ALL
 163 /// incoming edges, then it's true universally and we can simplify the compare.
 164 bool CorrelatedValuePropagation::processCmp(CmpInst *C) {
 165   Value *Op0 = C->getOperand(0);
 166   if (isa<Instruction>(Op0) &&
 167       cast<Instruction>(Op0)->getParent() == C->getParent())
 168     return false;
 169
 170   Constant *Op1 = dyn_cast<Constant>(C->getOperand(1));
 171   if (!Op1) return false;
 172
 173   pred_iterator PI = pred_begin(C->getParent()), PE = pred_end(C->getParent());
 174   if (PI == PE) return false;
 175
 176   LazyValueInfo::Tristate Result = LVI->getPredicateOnEdge(C->getPredicate(),
 177                                     C->getOperand(0), Op1, *PI, C->getParent());
 178   if (Result == LazyValueInfo::Unknown) return false;
 179
 180   ++PI;
 181   while (PI != PE) {
 182     LazyValueInfo::Tristate Res = LVI->getPredicateOnEdge(C->getPredicate(),
 183                                     C->getOperand(0), Op1, *PI, C->getParent());
 184     if (Res != Result) return false;
 185     ++PI;
 186   }
 187
 188   ++NumCmps;
 189
 190   if (Result == LazyValueInfo::True)
 191     C->replaceAllUsesWith(ConstantInt::getTrue(C->getContext()));
 192   else
 193     C->replaceAllUsesWith(ConstantInt::getFalse(C->getContext()));
 194
 195   C->eraseFromParent();
 196
 197   return true;
 198 }
 199
 200 /// processSwitch - Simplify a switch instruction by removing cases which can
 201 /// never fire.  If the uselessness of a case could be determined locally then
 202 /// constant propagation would already have figured it out.  Instead, walk the
 203 /// predecessors and statically evaluate cases based on information available
 204 /// on that edge.  Cases that cannot fire no matter what the incoming edge can
 205 /// safely be removed.  If a case fires on every incoming edge then the entire
 206 /// switch can be removed and replaced with a branch to the case destination.
 207 bool CorrelatedValuePropagation::processSwitch(SwitchInst *SI) {
 208   Value *Cond = SI->getCondition();
 209   BasicBlock *BB = SI->getParent();
 210
 211   // If the condition was defined in same block as the switch then LazyValueInfo
 212   // currently won't say anything useful about it, though in theory it could.
 213   if (isa<Instruction>(Cond) && cast<Instruction>(Cond)->getParent() == BB)
 214     return false;
 215
 216   // If the switch is unreachable then trying to improve it is a waste of time.
 217   pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
 218   if (PB == PE) return false;
 219
 220   // Analyse each switch case in turn.  This is done in reverse order so that
 221   // removing a case doesn't cause trouble for the iteration.
 222   bool Changed = false;
 223   for (SwitchInst::CaseIt CI = SI->case_end(), CE = SI->case_begin(); CI-- != CE;
 224        ) {
 225     ConstantInt *Case = CI.getCaseValue();
 226
 227     // Check to see if the switch condition is equal to/not equal to the case
 228     // value on every incoming edge, equal/not equal being the same each time.
 229     LazyValueInfo::Tristate State = LazyValueInfo::Unknown;
 230     for (pred_iterator PI = PB; PI != PE; ++PI) {
 231       // Is the switch condition equal to the case value?
 232       LazyValueInfo::Tristate Value = LVI->getPredicateOnEdge(CmpInst::ICMP_EQ,
 233                                                               Cond, Case, *PI, BB);
 234       // Give up on this case if nothing is known.
 235       if (Value == LazyValueInfo::Unknown) {
 236         State = LazyValueInfo::Unknown;
 237         break;
 238       }
 239
 240       // If this was the first edge to be visited, record that all other edges
 241       // need to give the same result.
 242       if (PI == PB) {
 243         State = Value;
 244         continue;
 245       }
 246
 247       // If this case is known to fire for some edges and known not to fire for
 248       // others then there is nothing we can do - give up.
 249       if (Value != State) {
 250         State = LazyValueInfo::Unknown;
 251         break;
 252       }
 253     }
 254
 255     if (State == LazyValueInfo::False) {
 256       // This case never fires - remove it.
 257       CI.getCaseSuccessor()->removePredecessor(BB);
 258       SI->removeCase(CI); // Does not invalidate the iterator.
 259
 260       // The condition can be modified by removePredecessor's PHI simplification
 261       // logic.
 262       Cond = SI->getCondition();
 263
 264       ++NumDeadCases;
 265       Changed = true;
 266     } else if (State == LazyValueInfo::True) {
 267       // This case always fires.  Arrange for the switch to be turned into an
 268       // unconditional branch by replacing the switch condition with the case
 269       // value.
 270       SI->setCondition(Case);
 271       NumDeadCases += SI->getNumCases();
 272       Changed = true;
 273       break;
 274     }
 275   }
 276
 277   if (Changed)
 278     // If the switch has been simplified to the point where it can be replaced
 279     // by a branch then do so now.
 280     ConstantFoldTerminator(BB);
 281
 282   return Changed;
 283 }
 284
 285 bool CorrelatedValuePropagation::runOnFunction(Function &F) {
 286   if (skipOptnoneFunction(F))
 287     return false;
 288
 289   LVI = &getAnalysis<LazyValueInfo>();
 290
 291   bool FnChanged = false;
 292
 293   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ++FI) {
 294     bool BBChanged = false;
 295     for (BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE; ) {
 296       Instruction *II = BI++;
 297       switch (II->getOpcode()) {
 298       case Instruction::Select:
 299         BBChanged |= processSelect(cast<SelectInst>(II));
 300         break;
 301       case Instruction::PHI:
 302         BBChanged |= processPHI(cast<PHINode>(II));
 303         break;
 304       case Instruction::ICmp:
 305       case Instruction::FCmp:
 306         BBChanged |= processCmp(cast<CmpInst>(II));
 307         break;
 308       case Instruction::Load:
 309       case Instruction::Store:
 310         BBChanged |= processMemAccess(II);
 311         break;
 312       }
 313     }
 314
 315     Instruction *Term = FI->getTerminator();
 316     switch (Term->getOpcode()) {
 317     case Instruction::Switch:
 318       BBChanged |= processSwitch(cast<SwitchInst>(Term));
 319       break;
 320     }
 321
 322     FnChanged |= BBChanged;
 323   }
 324
 325   return FnChanged;
 326 }