lib/Transforms/Scalar/LowerExpectIntrinsic.cpp

   1 //===- LowerExpectIntrinsic.cpp - Lower expect intrinsic ------------------===//
   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 pass lowers the 'expect' intrinsic to LLVM metadata.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Transforms/Scalar.h"
  15 #include "llvm/ADT/SmallVector.h"
  16 #include "llvm/ADT/Statistic.h"
  17 #include "llvm/IR/BasicBlock.h"
  18 #include "llvm/IR/Constants.h"
  19 #include "llvm/IR/Function.h"
  20 #include "llvm/IR/Instructions.h"
  21 #include "llvm/IR/Intrinsics.h"
  22 #include "llvm/IR/LLVMContext.h"
  23 #include "llvm/IR/MDBuilder.h"
  24 #include "llvm/IR/Metadata.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Debug.h"
  28
  29 using namespace llvm;
  30
  31 #define DEBUG_TYPE "lower-expect-intrinsic"
  32
  33 STATISTIC(IfHandled, "Number of 'expect' intrinsic instructions handled");
  34
  35 static cl::opt<uint32_t>
  36 LikelyBranchWeight("likely-branch-weight", cl::Hidden, cl::init(64),
  37                    cl::desc("Weight of the branch likely to be taken (default = 64)"));
  38 static cl::opt<uint32_t>
  39 UnlikelyBranchWeight("unlikely-branch-weight", cl::Hidden, cl::init(4),
  40                    cl::desc("Weight of the branch unlikely to be taken (default = 4)"));
  41
  42 namespace {
  43 /// \brief Legacy pass for lowering expect intrinsics out of the IR.
  44 ///
  45 /// When this pass is run over a function it uses expect intrinsics which feed
  46 /// branches and switches to provide branch weight metadata for those
  47 /// terminators. It then removes the expect intrinsics from the IR so the rest
  48 /// of the optimizer can ignore them.
  49 class LowerExpectIntrinsic : public FunctionPass {
  50 public:
  51   static char ID;
  52   LowerExpectIntrinsic() : FunctionPass(ID) {
  53     initializeLowerExpectIntrinsicPass(*PassRegistry::getPassRegistry());
  54   }
  55
  56   bool runOnFunction(Function &F) override;
  57 };
  58 }
  59
  60 static bool handleSwitchExpect(SwitchInst &SI) {
  61   CallInst *CI = dyn_cast<CallInst>(SI.getCondition());
  62   if (!CI)
  63     return false;
  64
  65   Function *Fn = CI->getCalledFunction();
  66   if (!Fn || Fn->getIntrinsicID() != Intrinsic::expect)
  67     return false;
  68
  69   Value *ArgValue = CI->getArgOperand(0);
  70   ConstantInt *ExpectedValue = dyn_cast<ConstantInt>(CI->getArgOperand(1));
  71   if (!ExpectedValue)
  72     return false;
  73
  74   SwitchInst::CaseIt Case = SI.findCaseValue(ExpectedValue);
  75   unsigned n = SI.getNumCases(); // +1 for default case.
  76   SmallVector<uint32_t, 16> Weights(n + 1, UnlikelyBranchWeight);
  77
  78   if (Case == SI.case_default())
  79     Weights[0] = LikelyBranchWeight;
  80   else
  81     Weights[Case.getCaseIndex() + 1] = LikelyBranchWeight;
  82
  83   SI.setMetadata(LLVMContext::MD_prof,
  84                  MDBuilder(CI->getContext()).createBranchWeights(Weights));
  85
  86   SI.setCondition(ArgValue);
  87   return true;
  88 }
  89
  90 static bool handleBranchExpect(BranchInst &BI) {
  91   if (BI.isUnconditional())
  92     return false;
  93
  94   // Handle non-optimized IR code like:
  95   //   %expval = call i64 @llvm.expect.i64(i64 %conv1, i64 1)
  96   //   %tobool = icmp ne i64 %expval, 0
  97   //   br i1 %tobool, label %if.then, label %if.end
  98   //
  99   // Or the following simpler case:
 100   //   %expval = call i1 @llvm.expect.i1(i1 %cmp, i1 1)
 101   //   br i1 %expval, label %if.then, label %if.end
 102
 103   CallInst *CI;
 104
 105   ICmpInst *CmpI = dyn_cast<ICmpInst>(BI.getCondition());
 106   if (!CmpI) {
 107     CI = dyn_cast<CallInst>(BI.getCondition());
 108   } else {
 109     if (CmpI->getPredicate() != CmpInst::ICMP_NE)
 110       return false;
 111     CI = dyn_cast<CallInst>(CmpI->getOperand(0));
 112   }
 113
 114   if (!CI)
 115     return false;
 116
 117   Function *Fn = CI->getCalledFunction();
 118   if (!Fn || Fn->getIntrinsicID() != Intrinsic::expect)
 119     return false;
 120
 121   Value *ArgValue = CI->getArgOperand(0);
 122   ConstantInt *ExpectedValue = dyn_cast<ConstantInt>(CI->getArgOperand(1));
 123   if (!ExpectedValue)
 124     return false;
 125
 126   MDBuilder MDB(CI->getContext());
 127   MDNode *Node;
 128
 129   // If expect value is equal to 1 it means that we are more likely to take
 130   // branch 0, in other case more likely is branch 1.
 131   if (ExpectedValue->isOne())
 132     Node = MDB.createBranchWeights(LikelyBranchWeight, UnlikelyBranchWeight);
 133   else
 134     Node = MDB.createBranchWeights(UnlikelyBranchWeight, LikelyBranchWeight);
 135
 136   BI.setMetadata(LLVMContext::MD_prof, Node);
 137
 138   if (CmpI)
 139     CmpI->setOperand(0, ArgValue);
 140   else
 141     BI.setCondition(ArgValue);
 142   return true;
 143 }
 144
 145 bool LowerExpectIntrinsic::runOnFunction(Function &F) {
 146   for (Function::iterator I = F.begin(), E = F.end(); I != E;) {
 147     BasicBlock *BB = I++;
 148
 149     // Create "block_weights" metadata.
 150     if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
 151       if (handleBranchExpect(*BI))
 152         IfHandled++;
 153     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
 154       if (handleSwitchExpect(*SI))
 155         IfHandled++;
 156     }
 157
 158     // remove llvm.expect intrinsics.
 159     for (BasicBlock::iterator BI = BB->begin(), BE = BB->end(); BI != BE;) {
 160       CallInst *CI = dyn_cast<CallInst>(BI++);
 161       if (!CI)
 162         continue;
 163
 164       Function *Fn = CI->getCalledFunction();
 165       if (Fn && Fn->getIntrinsicID() == Intrinsic::expect) {
 166         Value *Exp = CI->getArgOperand(0);
 167         CI->replaceAllUsesWith(Exp);
 168         CI->eraseFromParent();
 169       }
 170     }
 171   }
 172
 173   return false;
 174 }
 175
 176 char LowerExpectIntrinsic::ID = 0;
 177 INITIALIZE_PASS(LowerExpectIntrinsic, "lower-expect",
 178                 "Lower 'expect' Intrinsics", false, false)
 179
 180 FunctionPass *llvm::createLowerExpectIntrinsicPass() {
 181   return new LowerExpectIntrinsic();
 182 }