lib/Transforms/IPO/InlineSimple.cpp

   1 //===- FunctionInlining.cpp - Code to perform function inlining -----------===//
   2 //
   3 // This file implements inlining of functions.
   4 //
   5 // Specifically, this:
   6 //   * Exports functionality to inline any function call
   7 //   * Inlines functions that consist of a single basic block
   8 //   * Is able to inline ANY function call
   9 //   . Has a smart heuristic for when to inline a function
  10 //
  11 // Notice that:
  12 //   * This pass opens up a lot of opportunities for constant propogation.  It
  13 //     is a good idea to to run a constant propogation pass, then a DCE pass
  14 //     sometime after running this pass.
  15 //
  16 // FIXME: This pass should transform alloca instructions in the called function
  17 //        into malloc/free pairs!
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #include "llvm/Transforms/FunctionInlining.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/Pass.h"
  24 #include "llvm/iTerminators.h"
  25 #include "llvm/iPHINode.h"
  26 #include "llvm/iOther.h"
  27 #include "llvm/Type.h"
  28 #include "Support/Statistic.h"
  29 #include <algorithm>
  30
  31 static Statistic<> NumInlined("inline", "Number of functions inlined");
  32 using std::cerr;
  33
  34 // RemapInstruction - Convert the instruction operands from referencing the
  35 // current values into those specified by ValueMap.
  36 //
  37 static inline void RemapInstruction(Instruction *I,
  38                                     std::map<const Value *, Value*> &ValueMap) {
  39
  40   for (unsigned op = 0, E = I->getNumOperands(); op != E; ++op) {
  41     const Value *Op = I->getOperand(op);
  42     Value *V = ValueMap[Op];
  43     if (!V && (isa<GlobalValue>(Op) || isa<Constant>(Op)))
  44       continue;  // Globals and constants don't get relocated
  45
  46     if (!V) {
  47       cerr << "Val = \n" << Op << "Addr = " << (void*)Op;
  48       cerr << "\nInst = " << I;
  49     }
  50     assert(V && "Referenced value not in value map!");
  51     I->setOperand(op, V);
  52   }
  53 }
  54
  55 // InlineFunction - This function forcibly inlines the called function into the
  56 // basic block of the caller.  This returns false if it is not possible to
  57 // inline this call.  The program is still in a well defined state if this
  58 // occurs though.
  59 //
  60 // Note that this only does one level of inlining.  For example, if the
  61 // instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
  62 // exists in the instruction stream.  Similiarly this will inline a recursive
  63 // function by one level.
  64 //
  65 bool InlineFunction(CallInst *CI) {
  66   assert(isa<CallInst>(CI) && "InlineFunction only works on CallInst nodes");
  67   assert(CI->getParent() && "Instruction not embedded in basic block!");
  68   assert(CI->getParent()->getParent() && "Instruction not in function!");
  69
  70   const Function *CalledFunc = CI->getCalledFunction();
  71   if (CalledFunc == 0 ||   // Can't inline external function or indirect call!
  72       CalledFunc->isExternal()) return false;
  73
  74   //cerr << "Inlining " << CalledFunc->getName() << " into "
  75   //     << CurrentMeth->getName() << "\n";
  76
  77   BasicBlock *OrigBB = CI->getParent();
  78
  79   // Call splitBasicBlock - The original basic block now ends at the instruction
  80   // immediately before the call.  The original basic block now ends with an
  81   // unconditional branch to NewBB, and NewBB starts with the call instruction.
  82   //
  83   BasicBlock *NewBB = OrigBB->splitBasicBlock(CI);
  84   NewBB->setName("InlinedFunctionReturnNode");
  85
  86   // Remove (unlink) the CallInst from the start of the new basic block.
  87   NewBB->getInstList().remove(CI);
  88
  89   // If we have a return value generated by this call, convert it into a PHI
  90   // node that gets values from each of the old RET instructions in the original
  91   // function.
  92   //
  93   PHINode *PHI = 0;
  94   if (CalledFunc->getReturnType() != Type::VoidTy) {
  95     // The PHI node should go at the front of the new basic block to merge all
  96     // possible incoming values.
  97     //
  98     PHI = new PHINode(CalledFunc->getReturnType(), CI->getName(),
  99                       NewBB->begin());
 100
 101     // Anything that used the result of the function call should now use the PHI
 102     // node as their operand.
 103     //
 104     CI->replaceAllUsesWith(PHI);
 105   }
 106
 107   // Keep a mapping between the original function's values and the new
 108   // duplicated code's values.  This includes all of: Function arguments,
 109   // instruction values, constant pool entries, and basic blocks.
 110   //
 111   std::map<const Value *, Value*> ValueMap;
 112
 113   // Add the function arguments to the mapping: (start counting at 1 to skip the
 114   // function reference itself)
 115   //
 116   Function::const_aiterator PTI = CalledFunc->abegin();
 117   for (unsigned a = 1, E = CI->getNumOperands(); a != E; ++a, ++PTI)
 118     ValueMap[PTI] = CI->getOperand(a);
 119
 120   ValueMap[NewBB] = NewBB;  // Returns get converted to reference NewBB
 121
 122   // Loop over all of the basic blocks in the function, inlining them as
 123   // appropriate.  Keep track of the first basic block of the function...
 124   //
 125   for (Function::const_iterator BB = CalledFunc->begin();
 126        BB != CalledFunc->end(); ++BB) {
 127     assert(BB->getTerminator() && "BasicBlock doesn't have terminator!?!?");
 128
 129     // Create a new basic block to copy instructions into!
 130     BasicBlock *IBB = new BasicBlock("", NewBB->getParent());
 131     if (BB->hasName()) IBB->setName(BB->getName()+".i");  // .i = inlined once
 132
 133     ValueMap[BB] = IBB;                       // Add basic block mapping.
 134
 135     // Make sure to capture the mapping that a return will use...
 136     // TODO: This assumes that the RET is returning a value computed in the same
 137     //       basic block as the return was issued from!
 138     //
 139     const TerminatorInst *TI = BB->getTerminator();
 140
 141     // Loop over all instructions copying them over...
 142     Instruction *NewInst;
 143     for (BasicBlock::const_iterator II = BB->begin();
 144          II != --BB->end(); ++II) {
 145       IBB->getInstList().push_back((NewInst = II->clone()));
 146       ValueMap[II] = NewInst;                  // Add instruction map to value.
 147       if (II->hasName())
 148         NewInst->setName(II->getName()+".i");  // .i = inlined once
 149     }
 150
 151     // Copy over the terminator now...
 152     switch (TI->getOpcode()) {
 153     case Instruction::Ret: {
 154       const ReturnInst *RI = cast<ReturnInst>(TI);
 155
 156       if (PHI) {   // The PHI node should include this value!
 157         assert(RI->getReturnValue() && "Ret should have value!");
 158         assert(RI->getReturnValue()->getType() == PHI->getType() &&
 159                "Ret value not consistent in function!");
 160         PHI->addIncoming((Value*)RI->getReturnValue(),
 161                          (BasicBlock*)cast<BasicBlock>(&*BB));
 162       }
 163
 164       // Add a branch to the code that was after the original Call.
 165       IBB->getInstList().push_back(new BranchInst(NewBB));
 166       break;
 167     }
 168     case Instruction::Br:
 169       IBB->getInstList().push_back(TI->clone());
 170       break;
 171
 172     default:
 173       cerr << "FunctionInlining: Don't know how to handle terminator: " << TI;
 174       abort();
 175     }
 176   }
 177
 178
 179   // Loop over all of the instructions in the function, fixing up operand
 180   // references as we go.  This uses ValueMap to do all the hard work.
 181   //
 182   for (Function::const_iterator BB = CalledFunc->begin();
 183        BB != CalledFunc->end(); ++BB) {
 184     BasicBlock *NBB = (BasicBlock*)ValueMap[BB];
 185
 186     // Loop over all instructions, fixing each one as we find it...
 187     //
 188     for (BasicBlock::iterator II = NBB->begin(); II != NBB->end(); ++II)
 189       RemapInstruction(II, ValueMap);
 190   }
 191
 192   if (PHI) {
 193     RemapInstruction(PHI, ValueMap);  // Fix the PHI node also...
 194
 195     // Check to see if the PHI node only has one argument.  This is a common
 196     // case resulting from there only being a single return instruction in the
 197     // function call.  Because this is so common, eliminate the PHI node.
 198     //
 199     if (PHI->getNumIncomingValues() == 1) {
 200       PHI->replaceAllUsesWith(PHI->getIncomingValue(0));
 201       PHI->getParent()->getInstList().erase(PHI);
 202     }
 203   }
 204
 205   // Change the branch that used to go to NewBB to branch to the first basic
 206   // block of the inlined function.
 207   //
 208   TerminatorInst *Br = OrigBB->getTerminator();
 209   assert(Br && Br->getOpcode() == Instruction::Br &&
 210          "splitBasicBlock broken!");
 211   Br->setOperand(0, ValueMap[&CalledFunc->front()]);
 212
 213   // Since we are now done with the CallInst, we can finally delete it.
 214   delete CI;
 215   return true;
 216 }
 217
 218 static inline bool ShouldInlineFunction(const CallInst *CI, const Function *F) {
 219   assert(CI->getParent() && CI->getParent()->getParent() &&
 220          "Call not embedded into a function!");
 221
 222   // Don't inline a recursive call.
 223   if (CI->getParent()->getParent() == F) return false;
 224
 225   // Don't inline something too big.  This is a really crappy heuristic
 226   if (F->size() > 3) return false;
 227
 228   // Don't inline into something too big. This is a **really** crappy heuristic
 229   if (CI->getParent()->getParent()->size() > 10) return false;
 230
 231   // Go ahead and try just about anything else.
 232   return true;
 233 }
 234
 235
 236 static inline bool DoFunctionInlining(BasicBlock *BB) {
 237   for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
 238     if (CallInst *CI = dyn_cast<CallInst>(&*I)) {
 239       // Check to see if we should inline this function
 240       Function *F = CI->getCalledFunction();
 241       if (F && ShouldInlineFunction(CI, F)) {
 242         return InlineFunction(CI);
 243       }
 244     }
 245   }
 246   return false;
 247 }
 248
 249 // doFunctionInlining - Use a heuristic based approach to inline functions that
 250 // seem to look good.
 251 //
 252 static bool doFunctionInlining(Function &F) {
 253   bool Changed = false;
 254
 255   // Loop through now and inline instructions a basic block at a time...
 256   for (Function::iterator I = F.begin(); I != F.end(); )
 257     if (DoFunctionInlining(I)) {
 258       ++NumInlined;
 259       Changed = true;
 260     } else {
 261       ++I;
 262     }
 263
 264   return Changed;
 265 }
 266
 267 namespace {
 268   struct FunctionInlining : public FunctionPass {
 269     virtual bool runOnFunction(Function &F) {
 270       return doFunctionInlining(F);
 271     }
 272   };
 273   RegisterOpt<FunctionInlining> X("inline", "Function Integration/Inlining");
 274 }
 275
 276 Pass *createFunctionInliningPass() { return new FunctionInlining(); }