InlineFunction.cpp revision 28c531cdbb403c59f492d3361ec9e8581f2a7ab2
1ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//===- InlineFunction.cpp - Code to perform function inlining -------------===//
2fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman//
3b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell//                     The LLVM Compiler Infrastructure
4b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell//
54ee451de366474b9c228b4e5fa573795a715216dChris Lattner// This file is distributed under the University of Illinois Open Source
64ee451de366474b9c228b4e5fa573795a715216dChris Lattner// License. See LICENSE.TXT for details.
7fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman//
8b576c94c15af9a440f69d9d03c2afead7971118cJohn Criswell//===----------------------------------------------------------------------===//
9ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//
10ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// This file implements inlining of a function into a call site, resolving
11ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// parameters and the return value as appropriate.
12ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//
13ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//===----------------------------------------------------------------------===//
14ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
15ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner#include "llvm/Transforms/Utils/Cloning.h"
163787e765facfad5ea62753922d940bcdd52afd57Chris Lattner#include "llvm/Constants.h"
177152c237b46a920b29d5605af934766b8f9a07a1Chris Lattner#include "llvm/DerivedTypes.h"
18ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner#include "llvm/Module.h"
1980a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner#include "llvm/Instructions.h"
2080a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner#include "llvm/Intrinsics.h"
21eaf42abab6d465c38891345d999255871cf03943Devang Patel#include "llvm/Attributes.h"
22468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner#include "llvm/Analysis/CallGraph.h"
23c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner#include "llvm/Target/TargetData.h"
2493e985f1b17aef62d58e3198a4604f9f6cfe8d19Chris Lattner#include "llvm/ADT/SmallVector.h"
25641ca93cff0f957fc5fb9dfb05d2a4a340aa8af7Devang Patel#include "llvm/ADT/StringExtras.h"
2680a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner#include "llvm/Support/CallSite.h"
27f7703df4968084c18c248c1feea9961c19a32e6aChris Lattnerusing namespace llvm;
28ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
291dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattnerbool llvm::InlineFunction(CallInst *CI, CallGraph *CG, const TargetData *TD) {
301dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattner  return InlineFunction(CallSite(CI), CG, TD);
31468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner}
321dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattnerbool llvm::InlineFunction(InvokeInst *II, CallGraph *CG, const TargetData *TD) {
331dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattner  return InlineFunction(CallSite(II), CG, TD);
34468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner}
3580a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner
36cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner/// HandleInlinedInvoke - If we inlined an invoke site, we need to convert calls
37cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner/// in the body of the inlined function into invokes and turn unwind
38cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner/// instructions into branches to the invoke unwind dest.
39cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner///
40dac5c4b10b387b55c2394cd98a64f3f1394df2e8Nick Lewycky/// II is the invoke instruction being inlined.  FirstNewBlock is the first
41cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner/// block of the inlined code (the last block is the end of the function),
42cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner/// and InlineCodeInfo is information about the code that got inlined.
43cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattnerstatic void HandleInlinedInvoke(InvokeInst *II, BasicBlock *FirstNewBlock,
4428c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel                                ClonedCodeInfo &InlinedCodeInfo,
4528c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel                                CallGraph *CG) {
46cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  BasicBlock *InvokeDest = II->getUnwindDest();
47cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  std::vector<Value*> InvokeDestPHIValues;
48cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
49cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // If there are PHI nodes in the unwind destination block, we need to
50cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // keep track of which values came into them from this invoke, then remove
51cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // the entry for this block.
52cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  BasicBlock *InvokeBlock = II->getParent();
53cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
54cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner    PHINode *PN = cast<PHINode>(I);
55cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner    // Save the value to use for this edge.
56cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner    InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
57cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  }
58cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
59cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  Function *Caller = FirstNewBlock->getParent();
60a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
61cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // The inlined code is currently at the end of the function, scan from the
62cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // start of the inlined code to its end, checking for stuff we need to
63cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // rewrite.
64727d1dd58793447e83ade712f0e58172f156edcfChris Lattner  if (InlinedCodeInfo.ContainsCalls || InlinedCodeInfo.ContainsUnwinds) {
65727d1dd58793447e83ade712f0e58172f156edcfChris Lattner    for (Function::iterator BB = FirstNewBlock, E = Caller->end();
66727d1dd58793447e83ade712f0e58172f156edcfChris Lattner         BB != E; ++BB) {
67727d1dd58793447e83ade712f0e58172f156edcfChris Lattner      if (InlinedCodeInfo.ContainsCalls) {
68727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ){
69727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          Instruction *I = BBI++;
70a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
71727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // We only need to check for function calls: inlined invoke
72727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // instructions require no special handling.
73727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          if (!isa<CallInst>(I)) continue;
74727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          CallInst *CI = cast<CallInst>(I);
75cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
76fd7b326bea39c077eea8d378156bcf09051cc4ecDuncan Sands          // If this call cannot unwind, don't convert it to an invoke.
772b0e8990ab33ec2dad21286d3ce01dbb4bbe63c1Duncan Sands          if (CI->doesNotThrow())
78727d1dd58793447e83ade712f0e58172f156edcfChris Lattner            continue;
79a3355ffb3d30d19d226bbb75707991c60f236e37Duncan Sands
80727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // Convert this function call into an invoke instruction.
81727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // First, split the basic block.
82727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
83a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
84727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // Next, create the new invoke instruction, inserting it at the end
85727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // of the old basic block.
8693e985f1b17aef62d58e3198a4604f9f6cfe8d19Chris Lattner          SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
87727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          InvokeInst *II =
88051a950000e21935165db56695e35bade668193bGabor Greif            InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
89051a950000e21935165db56695e35bade668193bGabor Greif                               InvokeArgs.begin(), InvokeArgs.end(),
90051a950000e21935165db56695e35bade668193bGabor Greif                               CI->getName(), BB->getTerminator());
91727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          II->setCallingConv(CI->getCallingConv());
920598866c052147c31b808391f58434ce3dbfb838Devang Patel          II->setAttributes(CI->getAttributes());
93a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
94727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // Make sure that anything using the call now uses the invoke!
95727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          CI->replaceAllUsesWith(II);
96a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
9728c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel          // Update the callgraph.
9828c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel          if (CG) {
9928c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            // We should be able to do this:
10028c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            //   (*CG)[Caller]->replaceCallSite(CI, II);
10128c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            // but that fails if the old call site isn't in the call graph,
10228c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            // which, because of LLVM bug 3601, it sometimes isn't.
10328c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            CallGraphNode *CGN = (*CG)[Caller];
10428c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            for (CallGraphNode::iterator NI = CGN->begin(), NE = CGN->end();
10528c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel                 NI != NE; ++NI) {
10628c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel              if (NI->first == CI) {
10728c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel                NI->first = II;
10828c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel                break;
10928c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel              }
11028c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel            }
11128c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel          }
11228c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel
113727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // Delete the unconditional branch inserted by splitBasicBlock
114727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          BB->getInstList().pop_back();
115727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          Split->getInstList().pop_front();  // Delete the original call
116a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
117727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // Update any PHI nodes in the exceptional block to indicate that
118727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // there is now a new entry in them.
119727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          unsigned i = 0;
120727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          for (BasicBlock::iterator I = InvokeDest->begin();
121727d1dd58793447e83ade712f0e58172f156edcfChris Lattner               isa<PHINode>(I); ++I, ++i) {
122727d1dd58793447e83ade712f0e58172f156edcfChris Lattner            PHINode *PN = cast<PHINode>(I);
123727d1dd58793447e83ade712f0e58172f156edcfChris Lattner            PN->addIncoming(InvokeDestPHIValues[i], BB);
124727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          }
125a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
126727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          // This basic block is now complete, start scanning the next one.
127727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          break;
128727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        }
129cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner      }
130a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
131727d1dd58793447e83ade712f0e58172f156edcfChris Lattner      if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
132727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // An UnwindInst requires special handling when it gets inlined into an
133727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // invoke site.  Once this happens, we know that the unwind would cause
134727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // a control transfer to the invoke exception destination, so we can
135727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // transform it into a direct branch to the exception destination.
136051a950000e21935165db56695e35bade668193bGabor Greif        BranchInst::Create(InvokeDest, UI);
137a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
138727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // Delete the unwind instruction!
1391adec83ae84031bfa9f0bf209c5ee6c64906a1ffDan Gohman        UI->eraseFromParent();
140a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
141727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // Update any PHI nodes in the exceptional block to indicate that
142727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        // there is now a new entry in them.
143727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        unsigned i = 0;
144727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        for (BasicBlock::iterator I = InvokeDest->begin();
145727d1dd58793447e83ade712f0e58172f156edcfChris Lattner             isa<PHINode>(I); ++I, ++i) {
146727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          PHINode *PN = cast<PHINode>(I);
147727d1dd58793447e83ade712f0e58172f156edcfChris Lattner          PN->addIncoming(InvokeDestPHIValues[i], BB);
148727d1dd58793447e83ade712f0e58172f156edcfChris Lattner        }
149cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner      }
150cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner    }
151cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  }
152cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
153cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // Now that everything is happy, we have one final detail.  The PHI nodes in
154cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // the exception destination block still have entries due to the original
155cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // invoke instruction.  Eliminate these entries (which might even delete the
156cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  // PHI node) now.
157cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  InvokeDest->removePredecessor(II->getParent());
158cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner}
159cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
160d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner/// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
161d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner/// into the caller, update the specified callgraph to reflect the changes we
162d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner/// made.  Note that it's possible that not all code was copied over, so only
163d7b9851c4e634ed3599b1a4c70b1c76c90a11686Duncan Sands/// some edges of the callgraph may remain.
164d7b9851c4e634ed3599b1a4c70b1c76c90a11686Duncan Sandsstatic void UpdateCallGraphAfterInlining(CallSite CS,
165d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner                                         Function::iterator FirstNewBlock,
1665e665f559419c7f58a4fd9360cd488f065505c44Chris Lattner                                       DenseMap<const Value*, Value*> &ValueMap,
167468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner                                         CallGraph &CG) {
168d7b9851c4e634ed3599b1a4c70b1c76c90a11686Duncan Sands  const Function *Caller = CS.getInstruction()->getParent()->getParent();
169d7b9851c4e634ed3599b1a4c70b1c76c90a11686Duncan Sands  const Function *Callee = CS.getCalledFunction();
170468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner  CallGraphNode *CalleeNode = CG[Callee];
171468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner  CallGraphNode *CallerNode = CG[Caller];
172a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
173d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner  // Since we inlined some uninlined call sites in the callee into the caller,
174468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner  // add edges from the caller to all of the callees of the callee.
175c478e52bf4c12691037856ee103c66946afeab6cGabor Greif  CallGraphNode::iterator I = CalleeNode->begin(), E = CalleeNode->end();
176c478e52bf4c12691037856ee103c66946afeab6cGabor Greif
177c478e52bf4c12691037856ee103c66946afeab6cGabor Greif  // Consider the case where CalleeNode == CallerNode.
178125329891f97baedef21e4b464ba70182c3fb45eGabor Greif  CallGraphNode::CalledFunctionsVector CallCache;
179c478e52bf4c12691037856ee103c66946afeab6cGabor Greif  if (CalleeNode == CallerNode) {
180c478e52bf4c12691037856ee103c66946afeab6cGabor Greif    CallCache.assign(I, E);
181c478e52bf4c12691037856ee103c66946afeab6cGabor Greif    I = CallCache.begin();
182c478e52bf4c12691037856ee103c66946afeab6cGabor Greif    E = CallCache.end();
183c478e52bf4c12691037856ee103c66946afeab6cGabor Greif  }
184c478e52bf4c12691037856ee103c66946afeab6cGabor Greif
185c478e52bf4c12691037856ee103c66946afeab6cGabor Greif  for (; I != E; ++I) {
186d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    const Instruction *OrigCall = I->first.getInstruction();
187a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
1885e665f559419c7f58a4fd9360cd488f065505c44Chris Lattner    DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
189981418bf1562d0b5b470ddc7d0034c9f3297b893Chris Lattner    // Only copy the edge if the call was inlined!
190981418bf1562d0b5b470ddc7d0034c9f3297b893Chris Lattner    if (VMI != ValueMap.end() && VMI->second) {
1911bb3a402574557cb228f8a96030776c229e282e5Chris Lattner      // If the call was inlined, but then constant folded, there is no edge to
1921bb3a402574557cb228f8a96030776c229e282e5Chris Lattner      // add.  Check for this case.
1931bb3a402574557cb228f8a96030776c229e282e5Chris Lattner      if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
1941bb3a402574557cb228f8a96030776c229e282e5Chris Lattner        CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
195d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    }
196d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner  }
19739fa32403e0b5e163f4f05566d6cde65e6c11095Dale Johannesen  // Update the call graph by deleting the edge from Callee to Caller.  We must
19839fa32403e0b5e163f4f05566d6cde65e6c11095Dale Johannesen  // do this after the loop above in case Caller and Callee are the same.
19939fa32403e0b5e163f4f05566d6cde65e6c11095Dale Johannesen  CallerNode->removeCallEdgeFor(CS);
200468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner}
201468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner
202cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner
203ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// InlineFunction - This function inlines the called function into the basic
204ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// block of the caller.  This returns false if it is not possible to inline this
205ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// call.  The program is still in a well defined state if this occurs though.
206ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//
207fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman// Note that this only does one level of inlining.  For example, if the
208fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
209ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// exists in the instruction stream.  Similiarly this will inline a recursive
210ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner// function by one level.
211ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner//
2121dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattnerbool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD) {
21380a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner  Instruction *TheCall = CS.getInstruction();
21480a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner  assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
21580a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner         "Instruction not in function!");
216ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
21780a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner  const Function *CalledFunc = CS.getCalledFunction();
218ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  if (CalledFunc == 0 ||          // Can't inline external function or indirect
2195cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer      CalledFunc->isDeclaration() || // call, or call to a vararg function!
220ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner      CalledFunc->getFunctionType()->isVarArg()) return false;
221ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
2221b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner
223af9985c6b9d066cb70a0363fed699022d0ec196cChris Lattner  // If the call to the callee is not a tail call, we must clear the 'tail'
2241b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner  // flags on any calls that we inline.
2251b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner  bool MustClearTailCallFlags =
226af9985c6b9d066cb70a0363fed699022d0ec196cChris Lattner    !(isa<CallInst>(TheCall) && cast<CallInst>(TheCall)->isTailCall());
2271b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner
228f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // If the call to the callee cannot throw, set the 'nounwind' flag on any
229f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // calls that we inline.
230f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  bool MarkNoUnwind = CS.doesNotThrow();
231f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands
23280a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner  BasicBlock *OrigBB = TheCall->getParent();
233ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  Function *Caller = OrigBB->getParent();
234ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
2350e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen  // GC poses two hazards to inlining, which only occur when the callee has GC:
2360e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen  //  1. If the caller has no GC, then the callee's GC must be propagated to the
2370e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen  //     caller.
2380e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen  //  2. If the caller has a differing GC, it is invalid to inline.
2395eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen  if (CalledFunc->hasGC()) {
2405eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen    if (!Caller->hasGC())
2415eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen      Caller->setGC(CalledFunc->getGC());
2425eca075b74d62c621b160aa216b4cd50829a2cc7Gordon Henriksen    else if (CalledFunc->getGC() != Caller->getGC())
2430e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen      return false;
2440e13821c96937830ec817f08095c3cef1fdcac8dGordon Henriksen  }
245a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
2465052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner  // Get an iterator to the last basic block in the function, which will have
2475052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner  // the new function inlined after it.
2485052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner  //
2495052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner  Function::iterator LastBlock = &Caller->back();
2505052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner
2515e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // Make sure to capture all of the return instructions from the cloned
2525e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // function.
2535052c911ec1be51ecb36e7f025c26412e9f1bfacChris Lattner  std::vector<ReturnInst*> Returns;
254cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  ClonedCodeInfo InlinedFunctionInfo;
2550744f09efc53d3352ac1caffc61f6e8239201c3bDale Johannesen  Function::iterator FirstNewBlock;
256f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands
2575e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  { // Scope to destroy ValueMap after cloning.
2585e665f559419c7f58a4fd9360cd488f065505c44Chris Lattner    DenseMap<const Value*, Value*> ValueMap;
2595b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner
2609614fcc640eb628cc5dfddb277ebae9f6cb61014Dan Gohman    assert(CalledFunc->arg_size() == CS.arg_size() &&
2615e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner           "No varargs calls can be inlined!");
262a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
263c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner    // Calculate the vector of arguments to pass into the function cloner, which
264c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner    // matches up the formal to the actual argument values.
2655e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    CallSite::arg_iterator AI = CS.arg_begin();
266c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner    unsigned ArgNo = 0;
267e4d5c441e04bdc00ccf1804744af670655123b07Chris Lattner    for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
268c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner         E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
269c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner      Value *ActualArg = *AI;
270a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
271d82375c1c43db7f823dd4660d3495e76566699e3Duncan Sands      // When byval arguments actually inlined, we need to make the copy implied
272d82375c1c43db7f823dd4660d3495e76566699e3Duncan Sands      // by them explicit.  However, we don't do this if the callee is readonly
273d82375c1c43db7f823dd4660d3495e76566699e3Duncan Sands      // or readnone, because the copy would be unneeded: the callee doesn't
274d82375c1c43db7f823dd4660d3495e76566699e3Duncan Sands      // modify the struct.
2750598866c052147c31b808391f58434ce3dbfb838Devang Patel      if (CalledFunc->paramHasAttr(ArgNo+1, Attribute::ByVal) &&
276d82375c1c43db7f823dd4660d3495e76566699e3Duncan Sands          !CalledFunc->onlyReadsMemory()) {
277c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
278c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        const Type *VoidPtrTy = PointerType::getUnqual(Type::Int8Ty);
279a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
280c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // Create the alloca.  If we have TargetData, use nice alignment.
281c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        unsigned Align = 1;
282c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        if (TD) Align = TD->getPrefTypeAlignment(AggTy);
283a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands        Value *NewAlloca = new AllocaInst(AggTy, 0, Align, I->getName(),
284c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner                                          Caller->begin()->begin());
285c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // Emit a memcpy.
286824b958e6fb1236e92e4d07f3acf18fca107cdc0Chris Lattner        const Type *Tys[] = { Type::Int64Ty };
287c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
288824b958e6fb1236e92e4d07f3acf18fca107cdc0Chris Lattner                                                       Intrinsic::memcpy,
289824b958e6fb1236e92e4d07f3acf18fca107cdc0Chris Lattner                                                       Tys, 1);
290c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
291c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
292a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
293c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        Value *Size;
294c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        if (TD == 0)
295c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          Size = ConstantExpr::getSizeOf(AggTy);
296c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        else
297c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          Size = ConstantInt::get(Type::Int64Ty, TD->getTypeStoreSize(AggTy));
298a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
299c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // Always generate a memcpy of alignment 1 here because we don't know
300c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // the alignment of the src pointer.  Other optimizations can infer
301c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // better alignment.
302c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        Value *CallArgs[] = {
303c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          DestCast, SrcCast, Size, ConstantInt::get(Type::Int32Ty, 1)
304c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        };
305c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        CallInst *TheMemCpy =
306051a950000e21935165db56695e35bade668193bGabor Greif          CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
307a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
308c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // If we have a call graph, update it.
309c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        if (CG) {
310c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
311c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          CallGraphNode *CallerNode = (*CG)[Caller];
312c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner          CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
313c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        }
314a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
315c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // Uses of the argument in the function should use our new alloca
316c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        // instead.
317c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner        ActualArg = NewAlloca;
318c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner      }
319a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
320c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner      ValueMap[I] = ActualArg;
321c93adca35856d0eaae088e52ba30cfefbd7ad910Chris Lattner    }
322fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
3235b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner    // We want the inliner to prune the code as it copies.  We would LOVE to
3245b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner    // have no dead or constant instructions leftover after inlining occurs
3255b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner    // (which can happen, e.g., because an argument was constant), but we'll be
3265b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner    // happy with whatever the cloner can do.
3275b5bc3032f97cfa7bfa3e22282d3a9c1ed05eec6Chris Lattner    CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
3281dfdf8255e803d6376f5fe94a113f892e796ae6cChris Lattner                              &InlinedFunctionInfo, TD);
329a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
330d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    // Remember the first block that is newly cloned over.
331d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    FirstNewBlock = LastBlock; ++FirstNewBlock;
332a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
333d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    // Update the callgraph if requested.
334d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    if (CG)
335d7b9851c4e634ed3599b1a4c70b1c76c90a11686Duncan Sands      UpdateCallGraphAfterInlining(CS, FirstNewBlock, ValueMap, *CG);
336fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman  }
337a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
338ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  // If there are any alloca instructions in the block that used to be the entry
339ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  // block for the callee, move them to the entry block of the caller.  First
340ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  // calculate which instruction they should be inserted before.  We insert the
341ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  // instructions at the end of the current alloca list.
342ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  //
34321f20558d629f7ff8f64c20746d890d29328a544Chris Lattner  {
34480a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner    BasicBlock::iterator InsertPoint = Caller->begin()->begin();
3455e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    for (BasicBlock::iterator I = FirstNewBlock->begin(),
3465e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner           E = FirstNewBlock->end(); I != E; )
34733bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner      if (AllocaInst *AI = dyn_cast<AllocaInst>(I++)) {
34833bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner        // If the alloca is now dead, remove it.  This often occurs due to code
34933bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner        // specialization.
35033bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner        if (AI->use_empty()) {
35133bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner          AI->eraseFromParent();
35233bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner          continue;
35333bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner        }
354a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
355f775f95369ba7d88a5cb8b6f1900241699d79351Chris Lattner        if (isa<Constant>(AI->getArraySize())) {
35621f20558d629f7ff8f64c20746d890d29328a544Chris Lattner          // Scan for the block of allocas that we can move over, and move them
35721f20558d629f7ff8f64c20746d890d29328a544Chris Lattner          // all at once.
358c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner          while (isa<AllocaInst>(I) &&
359c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner                 isa<Constant>(cast<AllocaInst>(I)->getArraySize()))
360c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner            ++I;
361c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner
362c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner          // Transfer all of the allocas over in a block.  Using splice means
363e26bff22dbcfec2074a7502dd56683fc7f55912aDan Gohman          // that the instructions aren't removed from the symbol table, then
364c1df7e1799a7a97602bdedec818f7ab1dc514b4eChris Lattner          // reinserted.
365ecb7a77885b174cf4d001a9b48533b3979e7810dDan Gohman          Caller->getEntryBlock().getInstList().splice(
366ecb7a77885b174cf4d001a9b48533b3979e7810dDan Gohman              InsertPoint,
367ecb7a77885b174cf4d001a9b48533b3979e7810dDan Gohman              FirstNewBlock->getInstList(),
368ecb7a77885b174cf4d001a9b48533b3979e7810dDan Gohman              AI, I);
369f775f95369ba7d88a5cb8b6f1900241699d79351Chris Lattner        }
37033bb3c8be355d179ece8e751f6e0f0978d0dd038Chris Lattner      }
37180a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner  }
37280a38d245359cb0a3be8f78f5d7d911232886b9aChris Lattner
373bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner  // If the inlined code contained dynamic alloca instructions, wrap the inlined
374bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner  // code with llvm.stacksave/llvm.stackrestore intrinsics.
375bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner  if (InlinedFunctionInfo.ContainsDynamicAllocas) {
376bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    Module *M = Caller->getParent();
377bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // Get the two intrinsics we care about.
378a121fddf3c34938d866ac4bb67247a479dedcd1bChris Lattner    Constant *StackSave, *StackRestore;
3793d292aca0306fbb65da4622c80df01432ab6559bDuncan Sands    StackSave    = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
3803d292aca0306fbb65da4622c80df01432ab6559bDuncan Sands    StackRestore = Intrinsic::getDeclaration(M, Intrinsic::stackrestore);
381d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner
382d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    // If we are preserving the callgraph, add edges to the stacksave/restore
383d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    // functions for the calls we insert.
38421ba23d0d88cff57dcdf104cd6914dabcbc68131Chris Lattner    CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
385d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    if (CG) {
386a121fddf3c34938d866ac4bb67247a479dedcd1bChris Lattner      // We know that StackSave/StackRestore are Function*'s, because they are
387a121fddf3c34938d866ac4bb67247a479dedcd1bChris Lattner      // intrinsics which must have the right types.
388a121fddf3c34938d866ac4bb67247a479dedcd1bChris Lattner      StackSaveCGN    = CG->getOrInsertFunction(cast<Function>(StackSave));
389a121fddf3c34938d866ac4bb67247a479dedcd1bChris Lattner      StackRestoreCGN = CG->getOrInsertFunction(cast<Function>(StackRestore));
390d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner      CallerNode = (*CG)[Caller];
391d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    }
392a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
393bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // Insert the llvm.stacksave.
394a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands    CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
395051a950000e21935165db56695e35bade668193bGabor Greif                                          FirstNewBlock->begin());
396d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
397a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
398bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // Insert a call to llvm.stackrestore before any return instructions in the
399bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // inlined function.
400d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
401051a950000e21935165db56695e35bade668193bGabor Greif      CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
402d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner      if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
403d85340f4ec587e22b0239617f3b747a6df113894Chris Lattner    }
404468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner
405468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner    // Count the number of StackRestore calls we insert.
406468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner    unsigned NumStackRestores = Returns.size();
407a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
408bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // If we are inlining an invoke instruction, insert restores before each
409bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    // unwind.  These unwinds will be rewritten into branches later.
410bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner    if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
411bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner      for (Function::iterator BB = FirstNewBlock, E = Caller->end();
412bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner           BB != E; ++BB)
413468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner        if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
4143d292aca0306fbb65da4622c80df01432ab6559bDuncan Sands          CallInst::Create(StackRestore, SavedPtr, "", UI);
415468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner          ++NumStackRestores;
416468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner        }
417468fb1df7db466e5682ee44341c3990b599e8d6aChris Lattner    }
418bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner  }
419bf229f488a7541abd979cc3fbe9c3ce1c100e5c0Chris Lattner
420a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands  // If we are inlining tail call instruction through a call site that isn't
4211fdf4a859f03ce5aa4ce9acba29ce321c847388eChris Lattner  // marked 'tail', we must remove the tail marker for any calls in the inlined
422f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // code.  Also, calls inlined through a 'nounwind' call site should be marked
423f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // 'nounwind'.
424f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  if (InlinedFunctionInfo.ContainsCalls &&
425f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands      (MustClearTailCallFlags || MarkNoUnwind)) {
4261b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner    for (Function::iterator BB = FirstNewBlock, E = Caller->end();
4271b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner         BB != E; ++BB)
4281b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner      for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
429f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands        if (CallInst *CI = dyn_cast<CallInst>(I)) {
430f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands          if (MustClearTailCallFlags)
431f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands            CI->setTailCall(false);
432f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands          if (MarkNoUnwind)
433f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands            CI->setDoesNotThrow();
434f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands        }
4351b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner  }
4361b49141821e98e4321bfe6234c7001c836b2a289Chris Lattner
437f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
438f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  // instructions are unreachable.
439f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands  if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
440f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands    for (Function::iterator BB = FirstNewBlock, E = Caller->end();
441f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands         BB != E; ++BB) {
442f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands      TerminatorInst *Term = BB->getTerminator();
443f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands      if (isa<UnwindInst>(Term)) {
444f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands        new UnreachableInst(Term);
445f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands        BB->getInstList().erase(Term);
446f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands      }
447f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands    }
448f0c3354d998507515ab39e26b5292ea0ceb06aefDuncan Sands
4495e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // If we are inlining for an invoke instruction, we must make sure to rewrite
4505e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // any inlined 'unwind' instructions into branches to the invoke exception
4515e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // destination, and call instructions into invoke instructions.
452cd4d339ec187182c9abc22b80560349f8ba5010fChris Lattner  if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
45328c531cdbb403c59f492d3361ec9e8581f2a7ab2Devang Patel    HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo, CG);
4545e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner
45544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // If we cloned in _exactly one_ basic block, and if that block ends in a
45644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // return instruction, we splice the body of the inlined callee directly into
45744a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // the calling basic block.
45844a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
45944a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // Move all of the instructions right before the call.
46044a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
46144a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner                                 FirstNewBlock->begin(), FirstNewBlock->end());
46244a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // Remove the cloned basic block.
46344a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    Caller->getBasicBlockList().pop_back();
464fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
46544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // If the call site was an invoke instruction, add a branch to the normal
46644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // destination.
46744a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
468051a950000e21935165db56695e35bade668193bGabor Greif      BranchInst::Create(II->getNormalDest(), TheCall);
46944a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
47044a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // If the return instruction returned a value, replace uses of the call with
47144a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // uses of the returned value.
472dc00d42bb18a6748f43c365d9bd30c1ed0e800acDevang Patel    if (!TheCall->use_empty()) {
473dc00d42bb18a6748f43c365d9bd30c1ed0e800acDevang Patel      ReturnInst *R = Returns[0];
474fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman      TheCall->replaceAllUsesWith(R->getReturnValue());
475dc00d42bb18a6748f43c365d9bd30c1ed0e800acDevang Patel    }
47644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // Since we are now done with the Call/Invoke, we can delete it.
4771adec83ae84031bfa9f0bf209c5ee6c64906a1ffDan Gohman    TheCall->eraseFromParent();
47844a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
47944a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // Since we are now done with the return instruction, delete it also.
4801adec83ae84031bfa9f0bf209c5ee6c64906a1ffDan Gohman    Returns[0]->eraseFromParent();
48144a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
48244a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // We are now done with the inlining.
48344a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    return true;
48444a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  }
48544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
48644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // Otherwise, we have the normal case, of more than one block to inline or
48744a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // multiple return sites.
48844a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
4895e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // We want to clone the entire callee function into the hole between the
4905e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // "starter" and "ender" blocks.  How we accomplish this depends on whether
4915e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // this is an invoke instruction or a call instruction.
4925e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  BasicBlock *AfterCallBB;
4935e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
494fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
4955e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // Add an unconditional branch to make this look like the CallInst case...
496051a950000e21935165db56695e35bade668193bGabor Greif    BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
497fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
4985e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // Split the basic block.  This guarantees that no PHI nodes will have to be
4995e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // updated due to new incoming edges, and make the invoke case more
5005e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // symmetric to the call case.
5015e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    AfterCallBB = OrigBB->splitBasicBlock(NewBr,
502284d1b88273eb1967c8faef407f1167791c760e0Chris Lattner                                          CalledFunc->getName()+".exit");
503fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
5045e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  } else {  // It's a call
50544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // If this is a call instruction, we need to split the basic block that
50644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner    // the call lives in.
5075e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    //
5085e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    AfterCallBB = OrigBB->splitBasicBlock(TheCall,
509284d1b88273eb1967c8faef407f1167791c760e0Chris Lattner                                          CalledFunc->getName()+".exit");
5105e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  }
5115e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner
51244a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // Change the branch that used to go to AfterCallBB to branch to the first
51344a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // basic block of the inlined function.
51444a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  //
51544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  TerminatorInst *Br = OrigBB->getTerminator();
516fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman  assert(Br && Br->getOpcode() == Instruction::Br &&
51744a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner         "splitBasicBlock broken!");
51844a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  Br->setOperand(0, FirstNewBlock);
51944a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
52044a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
52144a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // Now that the function is correct, make it a little bit nicer.  In
52244a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // particular, move the basic blocks inserted from the end of the function
52344a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  // into the space made by splitting the source basic block.
52444a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner  Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
52544a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner                                     FirstNewBlock, Caller->end());
52644a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
5275e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // Handle all of the return instructions that we just cloned in, and eliminate
5285e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // any users of the original call/invoke instruction.
529b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel  const Type *RTy = CalledFunc->getReturnType();
5302c31750cd0ebdc83a890ace97dbb6249b3abe44eDan Gohman
531fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman  if (Returns.size() > 1) {
5325e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // The PHI node should go at the front of the new basic block to merge all
5335e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    // possible incoming values.
534fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman    PHINode *PHI = 0;
5355e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    if (!TheCall->use_empty()) {
536fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman      PHI = PHINode::Create(RTy, TheCall->getName(),
537fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman                            AfterCallBB->begin());
538fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman      // Anything that used the result of the function call should now use the
539fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman      // PHI node as their operand.
540a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands      TheCall->replaceAllUsesWith(PHI);
5415e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    }
542fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
543c478e52bf4c12691037856ee103c66946afeab6cGabor Greif    // Loop over all of the return instructions adding entries to the PHI node
544c478e52bf4c12691037856ee103c66946afeab6cGabor Greif    // as appropriate.
545fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman    if (PHI) {
546fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman      for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
547fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman        ReturnInst *RI = Returns[i];
548fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman        assert(RI->getReturnValue()->getType() == PHI->getType() &&
549fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman               "Ret value not consistent in function!");
550fc74abfba5128544a750fce22fdf13eb0403e3ceDan Gohman        PHI->addIncoming(RI->getReturnValue(), RI->getParent());
5515e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner      }
55212a466b9d0e27be453cfa05cff18acc9d7c1cfbaDevang Patel    }
553fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
554de62aeaec49ddcf4a4c61fbbb3a22d3a4dd448f0Gabor Greif    // Add a branch to the merge points and remove return instructions.
55512a466b9d0e27be453cfa05cff18acc9d7c1cfbaDevang Patel    for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
55612a466b9d0e27be453cfa05cff18acc9d7c1cfbaDevang Patel      ReturnInst *RI = Returns[i];
5570744f09efc53d3352ac1caffc61f6e8239201c3bDale Johannesen      BranchInst::Create(AfterCallBB, RI);
558b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel      RI->eraseFromParent();
5595e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner    }
560b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel  } else if (!Returns.empty()) {
561b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // Otherwise, if there is exactly one return value, just replace anything
562b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // using the return value of the call with the computed value.
563b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    if (!TheCall->use_empty())
564b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel      TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
565a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
566b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // Splice the code from the return block into the block that it will return
567b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // to, which contains the code that was after the call.
568b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    BasicBlock *ReturnBB = Returns[0]->getParent();
569b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    AfterCallBB->getInstList().splice(AfterCallBB->begin(),
570b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel                                      ReturnBB->getInstList());
571a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
572b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
573b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    ReturnBB->replaceAllUsesWith(AfterCallBB);
574a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
575b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    // Delete the return instruction now and empty ReturnBB now.
576b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    Returns[0]->eraseFromParent();
577b8f198af1b62f2ed48dcb914973a9d211dcba38bDevang Patel    ReturnBB->eraseFromParent();
5783787e765facfad5ea62753922d940bcdd52afd57Chris Lattner  } else if (!TheCall->use_empty()) {
5793787e765facfad5ea62753922d940bcdd52afd57Chris Lattner    // No returns, but something is using the return value of the call.  Just
5803787e765facfad5ea62753922d940bcdd52afd57Chris Lattner    // nuke the result.
5813787e765facfad5ea62753922d940bcdd52afd57Chris Lattner    TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
5825e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  }
583fd93908ae8b9684fe71c239e3c6cfe13ff6a2663Misha Brukman
5845e923dee6024248f58fa83a7c7299437f44f0d1aChris Lattner  // Since we are now done with the Call/Invoke, we can delete it.
5853787e765facfad5ea62753922d940bcdd52afd57Chris Lattner  TheCall->eraseFromParent();
586ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner
5877152c237b46a920b29d5605af934766b8f9a07a1Chris Lattner  // We should always be able to fold the entry block of the function into the
5887152c237b46a920b29d5605af934766b8f9a07a1Chris Lattner  // single predecessor of the block...
589cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
5907152c237b46a920b29d5605af934766b8f9a07a1Chris Lattner  BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
59144a6807f4f785ecdd96b3aa67dad056677131b98Chris Lattner
592cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  // Splice the code entry block into calling block, right before the
593cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  // unconditional branch.
594cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
595cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  CalleeEntry->replaceAllUsesWith(OrigBB);  // Update PHI nodes
596cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner
597cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  // Remove the unconditional branch.
598cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  OrigBB->getInstList().erase(Br);
599cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner
600cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  // Now we can remove the CalleeEntry block, which is now empty.
601cd01ae5c7071fb99a665b2bbea7428d769792ab8Chris Lattner  Caller->getBasicBlockList().erase(CalleeEntry);
602a7212e58260f6d1ead0c4eec7af400cf6c0d289eDuncan Sands
603ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner  return true;
604ca398dc3989d35e8516489fd163e012133bd41cbChris Lattner}
605