lib/Transforms/Utils/InlineFunction.cpp

   1 //===- InlineFunction.cpp - Code to perform function inlining -------------===//
   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 inlining of a function into a call site, resolving
  11 // parameters and the return value as appropriate.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Transforms/Utils/Cloning.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/LLVMContext.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/IntrinsicInst.h"
  22 #include "llvm/Intrinsics.h"
  23 #include "llvm/Attributes.h"
  24 #include "llvm/Analysis/CallGraph.h"
  25 #include "llvm/Analysis/DebugInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/ADT/SmallVector.h"
  28 #include "llvm/ADT/StringExtras.h"
  29 #include "llvm/Support/CallSite.h"
  30 using namespace llvm;
  31
  32 bool llvm::InlineFunction(CallInst *CI, CallGraph *CG, const TargetData *TD,
  33                           SmallVectorImpl<AllocaInst*> *StaticAllocas) {
  34   return InlineFunction(CallSite(CI), CG, TD, StaticAllocas);
  35 }
  36 bool llvm::InlineFunction(InvokeInst *II, CallGraph *CG, const TargetData *TD,
  37                           SmallVectorImpl<AllocaInst*> *StaticAllocas) {
  38   return InlineFunction(CallSite(II), CG, TD, StaticAllocas);
  39 }
  40
  41
  42 /// HandleCallsInBlockInlinedThroughInvoke - When we inline a basic block into
  43 /// an invoke, we have to turn all of the calls that can throw into
  44 /// invokes.  This function analyze BB to see if there are any calls, and if so,
  45 /// it rewrites them to be invokes that jump to InvokeDest and fills in the PHI
  46 /// nodes in that block with the values specified in InvokeDestPHIValues.
  47 ///
  48 static void HandleCallsInBlockInlinedThroughInvoke(BasicBlock *BB,
  49                                                    BasicBlock *InvokeDest,
  50                            const SmallVectorImpl<Value*> &InvokeDestPHIValues) {
  51   for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ) {
  52     Instruction *I = BBI++;
  53
  54     // We only need to check for function calls: inlined invoke
  55     // instructions require no special handling.
  56     CallInst *CI = dyn_cast<CallInst>(I);
  57     if (CI == 0) continue;
  58
  59     // If this call cannot unwind, don't convert it to an invoke.
  60     if (CI->doesNotThrow())
  61       continue;
  62
  63     // Convert this function call into an invoke instruction.
  64     // First, split the basic block.
  65     BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
  66
  67     // Next, create the new invoke instruction, inserting it at the end
  68     // of the old basic block.
  69     SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
  70     InvokeInst *II =
  71       InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
  72                          InvokeArgs.begin(), InvokeArgs.end(),
  73                          CI->getName(), BB->getTerminator());
  74     II->setCallingConv(CI->getCallingConv());
  75     II->setAttributes(CI->getAttributes());
  76
  77     // Make sure that anything using the call now uses the invoke!  This also
  78     // updates the CallGraph if present.
  79     CI->replaceAllUsesWith(II);
  80
  81     // Delete the unconditional branch inserted by splitBasicBlock
  82     BB->getInstList().pop_back();
  83     Split->getInstList().pop_front();  // Delete the original call
  84
  85     // Update any PHI nodes in the exceptional block to indicate that
  86     // there is now a new entry in them.
  87     unsigned i = 0;
  88     for (BasicBlock::iterator I = InvokeDest->begin();
  89          isa<PHINode>(I); ++I, ++i)
  90       cast<PHINode>(I)->addIncoming(InvokeDestPHIValues[i], BB);
  91
  92     // This basic block is now complete, the caller will continue scanning the
  93     // next one.
  94     return;
  95   }
  96 }
  97
  98
  99 /// HandleInlinedInvoke - If we inlined an invoke site, we need to convert calls
 100 /// in the body of the inlined function into invokes and turn unwind
 101 /// instructions into branches to the invoke unwind dest.
 102 ///
 103 /// II is the invoke instruction being inlined.  FirstNewBlock is the first
 104 /// block of the inlined code (the last block is the end of the function),
 105 /// and InlineCodeInfo is information about the code that got inlined.
 106 static void HandleInlinedInvoke(InvokeInst *II, BasicBlock *FirstNewBlock,
 107                                 ClonedCodeInfo &InlinedCodeInfo) {
 108   BasicBlock *InvokeDest = II->getUnwindDest();
 109   SmallVector<Value*, 8> InvokeDestPHIValues;
 110
 111   // If there are PHI nodes in the unwind destination block, we need to
 112   // keep track of which values came into them from this invoke, then remove
 113   // the entry for this block.
 114   BasicBlock *InvokeBlock = II->getParent();
 115   for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
 116     PHINode *PN = cast<PHINode>(I);
 117     // Save the value to use for this edge.
 118     InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
 119   }
 120
 121   Function *Caller = FirstNewBlock->getParent();
 122
 123   // The inlined code is currently at the end of the function, scan from the
 124   // start of the inlined code to its end, checking for stuff we need to
 125   // rewrite.  If the code doesn't have calls or unwinds, we know there is
 126   // nothing to rewrite.
 127   if (!InlinedCodeInfo.ContainsCalls && !InlinedCodeInfo.ContainsUnwinds) {
 128     // Now that everything is happy, we have one final detail.  The PHI nodes in
 129     // the exception destination block still have entries due to the original
 130     // invoke instruction.  Eliminate these entries (which might even delete the
 131     // PHI node) now.
 132     InvokeDest->removePredecessor(II->getParent());
 133     return;
 134   }
 135
 136   for (Function::iterator BB = FirstNewBlock, E = Caller->end(); BB != E; ++BB){
 137     if (InlinedCodeInfo.ContainsCalls)
 138       HandleCallsInBlockInlinedThroughInvoke(BB, InvokeDest,
 139                                              InvokeDestPHIValues);
 140
 141     if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 142       // An UnwindInst requires special handling when it gets inlined into an
 143       // invoke site.  Once this happens, we know that the unwind would cause
 144       // a control transfer to the invoke exception destination, so we can
 145       // transform it into a direct branch to the exception destination.
 146       BranchInst::Create(InvokeDest, UI);
 147
 148       // Delete the unwind instruction!
 149       UI->eraseFromParent();
 150
 151       // Update any PHI nodes in the exceptional block to indicate that
 152       // there is now a new entry in them.
 153       unsigned i = 0;
 154       for (BasicBlock::iterator I = InvokeDest->begin();
 155            isa<PHINode>(I); ++I, ++i) {
 156         PHINode *PN = cast<PHINode>(I);
 157         PN->addIncoming(InvokeDestPHIValues[i], BB);
 158       }
 159     }
 160   }
 161
 162   // Now that everything is happy, we have one final detail.  The PHI nodes in
 163   // the exception destination block still have entries due to the original
 164   // invoke instruction.  Eliminate these entries (which might even delete the
 165   // PHI node) now.
 166   InvokeDest->removePredecessor(II->getParent());
 167 }
 168
 169 /// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
 170 /// into the caller, update the specified callgraph to reflect the changes we
 171 /// made.  Note that it's possible that not all code was copied over, so only
 172 /// some edges of the callgraph may remain.
 173 static void UpdateCallGraphAfterInlining(CallSite CS,
 174                                          Function::iterator FirstNewBlock,
 175                                        DenseMap<const Value*, Value*> &ValueMap,
 176                                          CallGraph &CG) {
 177   const Function *Caller = CS.getInstruction()->getParent()->getParent();
 178   const Function *Callee = CS.getCalledFunction();
 179   CallGraphNode *CalleeNode = CG[Callee];
 180   CallGraphNode *CallerNode = CG[Caller];
 181
 182   // Since we inlined some uninlined call sites in the callee into the caller,
 183   // add edges from the caller to all of the callees of the callee.
 184   CallGraphNode::iterator I = CalleeNode->begin(), E = CalleeNode->end();
 185
 186   // Consider the case where CalleeNode == CallerNode.
 187   CallGraphNode::CalledFunctionsVector CallCache;
 188   if (CalleeNode == CallerNode) {
 189     CallCache.assign(I, E);
 190     I = CallCache.begin();
 191     E = CallCache.end();
 192   }
 193
 194   for (; I != E; ++I) {
 195     const Value *OrigCall = I->first;
 196
 197     DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
 198     // Only copy the edge if the call was inlined!
 199     if (VMI == ValueMap.end() || VMI->second == 0)
 200       continue;
 201
 202     // If the call was inlined, but then constant folded, there is no edge to
 203     // add.  Check for this case.
 204     if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
 205       CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
 206   }
 207
 208   // Update the call graph by deleting the edge from Callee to Caller.  We must
 209   // do this after the loop above in case Caller and Callee are the same.
 210   CallerNode->removeCallEdgeFor(CS);
 211 }
 212
 213 // InlineFunction - This function inlines the called function into the basic
 214 // block of the caller.  This returns false if it is not possible to inline this
 215 // call.  The program is still in a well defined state if this occurs though.
 216 //
 217 // Note that this only does one level of inlining.  For example, if the
 218 // instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
 219 // exists in the instruction stream.  Similiarly this will inline a recursive
 220 // function by one level.
 221 //
 222 bool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD,
 223                           SmallVectorImpl<AllocaInst*> *StaticAllocas) {
 224   Instruction *TheCall = CS.getInstruction();
 225   LLVMContext &Context = TheCall->getContext();
 226   assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
 227          "Instruction not in function!");
 228
 229   const Function *CalledFunc = CS.getCalledFunction();
 230   if (CalledFunc == 0 ||          // Can't inline external function or indirect
 231       CalledFunc->isDeclaration() || // call, or call to a vararg function!
 232       CalledFunc->getFunctionType()->isVarArg()) return false;
 233
 234
 235   // If the call to the callee is not a tail call, we must clear the 'tail'
 236   // flags on any calls that we inline.
 237   bool MustClearTailCallFlags =
 238     !(isa<CallInst>(TheCall) && cast<CallInst>(TheCall)->isTailCall());
 239
 240   // If the call to the callee cannot throw, set the 'nounwind' flag on any
 241   // calls that we inline.
 242   bool MarkNoUnwind = CS.doesNotThrow();
 243
 244   BasicBlock *OrigBB = TheCall->getParent();
 245   Function *Caller = OrigBB->getParent();
 246
 247   // GC poses two hazards to inlining, which only occur when the callee has GC:
 248   //  1. If the caller has no GC, then the callee's GC must be propagated to the
 249   //     caller.
 250   //  2. If the caller has a differing GC, it is invalid to inline.
 251   if (CalledFunc->hasGC()) {
 252     if (!Caller->hasGC())
 253       Caller->setGC(CalledFunc->getGC());
 254     else if (CalledFunc->getGC() != Caller->getGC())
 255       return false;
 256   }
 257
 258   // Get an iterator to the last basic block in the function, which will have
 259   // the new function inlined after it.
 260   //
 261   Function::iterator LastBlock = &Caller->back();
 262
 263   // Make sure to capture all of the return instructions from the cloned
 264   // function.
 265   SmallVector<ReturnInst*, 8> Returns;
 266   ClonedCodeInfo InlinedFunctionInfo;
 267   Function::iterator FirstNewBlock;
 268
 269   { // Scope to destroy ValueMap after cloning.
 270     DenseMap<const Value*, Value*> ValueMap;
 271
 272     assert(CalledFunc->arg_size() == CS.arg_size() &&
 273            "No varargs calls can be inlined!");
 274
 275     // Calculate the vector of arguments to pass into the function cloner, which
 276     // matches up the formal to the actual argument values.
 277     CallSite::arg_iterator AI = CS.arg_begin();
 278     unsigned ArgNo = 0;
 279     for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
 280          E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
 281       Value *ActualArg = *AI;
 282
 283       // When byval arguments actually inlined, we need to make the copy implied
 284       // by them explicit.  However, we don't do this if the callee is readonly
 285       // or readnone, because the copy would be unneeded: the callee doesn't
 286       // modify the struct.
 287       if (CalledFunc->paramHasAttr(ArgNo+1, Attribute::ByVal) &&
 288           !CalledFunc->onlyReadsMemory()) {
 289         const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
 290         const Type *VoidPtrTy =
 291             Type::getInt8PtrTy(Context);
 292
 293         // Create the alloca.  If we have TargetData, use nice alignment.
 294         unsigned Align = 1;
 295         if (TD) Align = TD->getPrefTypeAlignment(AggTy);
 296         Value *NewAlloca = new AllocaInst(AggTy, 0, Align,
 297                                           I->getName(),
 298                                           &*Caller->begin()->begin());
 299         // Emit a memcpy.
 300         const Type *Tys[] = { Type::getInt64Ty(Context) };
 301         Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
 302                                                        Intrinsic::memcpy,
 303                                                        Tys, 1);
 304         Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
 305         Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
 306
 307         Value *Size;
 308         if (TD == 0)
 309           Size = ConstantExpr::getSizeOf(AggTy);
 310         else
 311           Size = ConstantInt::get(Type::getInt64Ty(Context),
 312                                          TD->getTypeStoreSize(AggTy));
 313
 314         // Always generate a memcpy of alignment 1 here because we don't know
 315         // the alignment of the src pointer.  Other optimizations can infer
 316         // better alignment.
 317         Value *CallArgs[] = {
 318           DestCast, SrcCast, Size,
 319           ConstantInt::get(Type::getInt32Ty(Context), 1)
 320         };
 321         CallInst *TheMemCpy =
 322           CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
 323
 324         // If we have a call graph, update it.
 325         if (CG) {
 326           CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
 327           CallGraphNode *CallerNode = (*CG)[Caller];
 328           CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
 329         }
 330
 331         // Uses of the argument in the function should use our new alloca
 332         // instead.
 333         ActualArg = NewAlloca;
 334       }
 335
 336       ValueMap[I] = ActualArg;
 337     }
 338
 339     // We want the inliner to prune the code as it copies.  We would LOVE to
 340     // have no dead or constant instructions leftover after inlining occurs
 341     // (which can happen, e.g., because an argument was constant), but we'll be
 342     // happy with whatever the cloner can do.
 343     CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
 344                               &InlinedFunctionInfo, TD, TheCall);
 345
 346     // Remember the first block that is newly cloned over.
 347     FirstNewBlock = LastBlock; ++FirstNewBlock;
 348
 349     // Update the callgraph if requested.
 350     if (CG)
 351       UpdateCallGraphAfterInlining(CS, FirstNewBlock, ValueMap, *CG);
 352   }
 353
 354   // If there are any alloca instructions in the block that used to be the entry
 355   // block for the callee, move them to the entry block of the caller.  First
 356   // calculate which instruction they should be inserted before.  We insert the
 357   // instructions at the end of the current alloca list.
 358   //
 359   {
 360     BasicBlock::iterator InsertPoint = Caller->begin()->begin();
 361     for (BasicBlock::iterator I = FirstNewBlock->begin(),
 362          E = FirstNewBlock->end(); I != E; ) {
 363       AllocaInst *AI = dyn_cast<AllocaInst>(I++);
 364       if (AI == 0) continue;
 365
 366       // If the alloca is now dead, remove it.  This often occurs due to code
 367       // specialization.
 368       if (AI->use_empty()) {
 369         AI->eraseFromParent();
 370         continue;
 371       }
 372
 373       if (!isa<Constant>(AI->getArraySize()))
 374         continue;
 375
 376       // Keep track of the static allocas that we inline into the caller if the
 377       // StaticAllocas pointer is non-null.
 378       if (StaticAllocas) StaticAllocas->push_back(AI);
 379
 380       // Scan for the block of allocas that we can move over, and move them
 381       // all at once.
 382       while (isa<AllocaInst>(I) &&
 383              isa<Constant>(cast<AllocaInst>(I)->getArraySize())) {
 384         if (StaticAllocas) StaticAllocas->push_back(cast<AllocaInst>(I));
 385         ++I;
 386       }
 387
 388       // Transfer all of the allocas over in a block.  Using splice means
 389       // that the instructions aren't removed from the symbol table, then
 390       // reinserted.
 391       Caller->getEntryBlock().getInstList().splice(InsertPoint,
 392                                                    FirstNewBlock->getInstList(),
 393                                                    AI, I);
 394     }
 395   }
 396
 397   // If the inlined code contained dynamic alloca instructions, wrap the inlined
 398   // code with llvm.stacksave/llvm.stackrestore intrinsics.
 399   if (InlinedFunctionInfo.ContainsDynamicAllocas) {
 400     Module *M = Caller->getParent();
 401     // Get the two intrinsics we care about.
 402     Function *StackSave = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
 403     Function *StackRestore=Intrinsic::getDeclaration(M,Intrinsic::stackrestore);
 404
 405     // If we are preserving the callgraph, add edges to the stacksave/restore
 406     // functions for the calls we insert.
 407     CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
 408     if (CG) {
 409       StackSaveCGN    = CG->getOrInsertFunction(StackSave);
 410       StackRestoreCGN = CG->getOrInsertFunction(StackRestore);
 411       CallerNode = (*CG)[Caller];
 412     }
 413
 414     // Insert the llvm.stacksave.
 415     CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
 416                                           FirstNewBlock->begin());
 417     if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
 418
 419     // Insert a call to llvm.stackrestore before any return instructions in the
 420     // inlined function.
 421     for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
 422       CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
 423       if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
 424     }
 425
 426     // Count the number of StackRestore calls we insert.
 427     unsigned NumStackRestores = Returns.size();
 428
 429     // If we are inlining an invoke instruction, insert restores before each
 430     // unwind.  These unwinds will be rewritten into branches later.
 431     if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
 432       for (Function::iterator BB = FirstNewBlock, E = Caller->end();
 433            BB != E; ++BB)
 434         if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 435           CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", UI);
 436           if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
 437           ++NumStackRestores;
 438         }
 439     }
 440   }
 441
 442   // If we are inlining tail call instruction through a call site that isn't
 443   // marked 'tail', we must remove the tail marker for any calls in the inlined
 444   // code.  Also, calls inlined through a 'nounwind' call site should be marked
 445   // 'nounwind'.
 446   if (InlinedFunctionInfo.ContainsCalls &&
 447       (MustClearTailCallFlags || MarkNoUnwind)) {
 448     for (Function::iterator BB = FirstNewBlock, E = Caller->end();
 449          BB != E; ++BB)
 450       for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 451         if (CallInst *CI = dyn_cast<CallInst>(I)) {
 452           if (MustClearTailCallFlags)
 453             CI->setTailCall(false);
 454           if (MarkNoUnwind)
 455             CI->setDoesNotThrow();
 456         }
 457   }
 458
 459   // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
 460   // instructions are unreachable.
 461   if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
 462     for (Function::iterator BB = FirstNewBlock, E = Caller->end();
 463          BB != E; ++BB) {
 464       TerminatorInst *Term = BB->getTerminator();
 465       if (isa<UnwindInst>(Term)) {
 466         new UnreachableInst(Context, Term);
 467         BB->getInstList().erase(Term);
 468       }
 469     }
 470
 471   // If we are inlining for an invoke instruction, we must make sure to rewrite
 472   // any inlined 'unwind' instructions into branches to the invoke exception
 473   // destination, and call instructions into invoke instructions.
 474   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
 475     HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo);
 476
 477   // If we cloned in _exactly one_ basic block, and if that block ends in a
 478   // return instruction, we splice the body of the inlined callee directly into
 479   // the calling basic block.
 480   if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
 481     // Move all of the instructions right before the call.
 482     OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
 483                                  FirstNewBlock->begin(), FirstNewBlock->end());
 484     // Remove the cloned basic block.
 485     Caller->getBasicBlockList().pop_back();
 486
 487     // If the call site was an invoke instruction, add a branch to the normal
 488     // destination.
 489     if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
 490       BranchInst::Create(II->getNormalDest(), TheCall);
 491
 492     // If the return instruction returned a value, replace uses of the call with
 493     // uses of the returned value.
 494     if (!TheCall->use_empty()) {
 495       ReturnInst *R = Returns[0];
 496       if (TheCall == R->getReturnValue())
 497         TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
 498       else
 499         TheCall->replaceAllUsesWith(R->getReturnValue());
 500     }
 501     // Since we are now done with the Call/Invoke, we can delete it.
 502     TheCall->eraseFromParent();
 503
 504     // Since we are now done with the return instruction, delete it also.
 505     Returns[0]->eraseFromParent();
 506
 507     // We are now done with the inlining.
 508     return true;
 509   }
 510
 511   // Otherwise, we have the normal case, of more than one block to inline or
 512   // multiple return sites.
 513
 514   // We want to clone the entire callee function into the hole between the
 515   // "starter" and "ender" blocks.  How we accomplish this depends on whether
 516   // this is an invoke instruction or a call instruction.
 517   BasicBlock *AfterCallBB;
 518   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
 519
 520     // Add an unconditional branch to make this look like the CallInst case...
 521     BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
 522
 523     // Split the basic block.  This guarantees that no PHI nodes will have to be
 524     // updated due to new incoming edges, and make the invoke case more
 525     // symmetric to the call case.
 526     AfterCallBB = OrigBB->splitBasicBlock(NewBr,
 527                                           CalledFunc->getName()+".exit");
 528
 529   } else {  // It's a call
 530     // If this is a call instruction, we need to split the basic block that
 531     // the call lives in.
 532     //
 533     AfterCallBB = OrigBB->splitBasicBlock(TheCall,
 534                                           CalledFunc->getName()+".exit");
 535   }
 536
 537   // Change the branch that used to go to AfterCallBB to branch to the first
 538   // basic block of the inlined function.
 539   //
 540   TerminatorInst *Br = OrigBB->getTerminator();
 541   assert(Br && Br->getOpcode() == Instruction::Br &&
 542          "splitBasicBlock broken!");
 543   Br->setOperand(0, FirstNewBlock);
 544
 545
 546   // Now that the function is correct, make it a little bit nicer.  In
 547   // particular, move the basic blocks inserted from the end of the function
 548   // into the space made by splitting the source basic block.
 549   Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
 550                                      FirstNewBlock, Caller->end());
 551
 552   // Handle all of the return instructions that we just cloned in, and eliminate
 553   // any users of the original call/invoke instruction.
 554   const Type *RTy = CalledFunc->getReturnType();
 555
 556   if (Returns.size() > 1) {
 557     // The PHI node should go at the front of the new basic block to merge all
 558     // possible incoming values.
 559     PHINode *PHI = 0;
 560     if (!TheCall->use_empty()) {
 561       PHI = PHINode::Create(RTy, TheCall->getName(),
 562                             AfterCallBB->begin());
 563       // Anything that used the result of the function call should now use the
 564       // PHI node as their operand.
 565       TheCall->replaceAllUsesWith(PHI);
 566     }
 567
 568     // Loop over all of the return instructions adding entries to the PHI node
 569     // as appropriate.
 570     if (PHI) {
 571       for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
 572         ReturnInst *RI = Returns[i];
 573         assert(RI->getReturnValue()->getType() == PHI->getType() &&
 574                "Ret value not consistent in function!");
 575         PHI->addIncoming(RI->getReturnValue(), RI->getParent());
 576       }
 577
 578       // Now that we inserted the PHI, check to see if it has a single value
 579       // (e.g. all the entries are the same or undef).  If so, remove the PHI so
 580       // it doesn't block other optimizations.
 581       if (Value *V = PHI->hasConstantValue()) {
 582         PHI->replaceAllUsesWith(V);
 583         PHI->eraseFromParent();
 584       }
 585     }
 586
 587
 588     // Add a branch to the merge points and remove return instructions.
 589     for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
 590       ReturnInst *RI = Returns[i];
 591       BranchInst::Create(AfterCallBB, RI);
 592       RI->eraseFromParent();
 593     }
 594   } else if (!Returns.empty()) {
 595     // Otherwise, if there is exactly one return value, just replace anything
 596     // using the return value of the call with the computed value.
 597     if (!TheCall->use_empty()) {
 598       if (TheCall == Returns[0]->getReturnValue())
 599         TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
 600       else
 601         TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
 602     }
 603
 604     // Splice the code from the return block into the block that it will return
 605     // to, which contains the code that was after the call.
 606     BasicBlock *ReturnBB = Returns[0]->getParent();
 607     AfterCallBB->getInstList().splice(AfterCallBB->begin(),
 608                                       ReturnBB->getInstList());
 609
 610     // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
 611     ReturnBB->replaceAllUsesWith(AfterCallBB);
 612
 613     // Delete the return instruction now and empty ReturnBB now.
 614     Returns[0]->eraseFromParent();
 615     ReturnBB->eraseFromParent();
 616   } else if (!TheCall->use_empty()) {
 617     // No returns, but something is using the return value of the call.  Just
 618     // nuke the result.
 619     TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
 620   }
 621
 622   // Since we are now done with the Call/Invoke, we can delete it.
 623   TheCall->eraseFromParent();
 624
 625   // We should always be able to fold the entry block of the function into the
 626   // single predecessor of the block...
 627   assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
 628   BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
 629
 630   // Splice the code entry block into calling block, right before the
 631   // unconditional branch.
 632   OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
 633   CalleeEntry->replaceAllUsesWith(OrigBB);  // Update PHI nodes
 634
 635   // Remove the unconditional branch.
 636   OrigBB->getInstList().erase(Br);
 637
 638   // Now we can remove the CalleeEntry block, which is now empty.
 639   Caller->getBasicBlockList().erase(CalleeEntry);
 640
 641   return true;
 642 }