blob: 1b677fbc2bcacccc394c43a72fdd971055d602fc [file] [log] [blame]
Chris Lattnerca398dc2003-05-29 15:11:31 +00001//===- InlineFunction.cpp - Code to perform function inlining -------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerca398dc2003-05-29 15:11:31 +00009//
10// This file implements inlining of a function into a call site, resolving
11// parameters and the return value as appropriate.
12//
Chris Lattnerca398dc2003-05-29 15:11:31 +000013//===----------------------------------------------------------------------===//
14
15#include "llvm/Transforms/Utils/Cloning.h"
Chris Lattner3787e762004-10-17 23:21:07 +000016#include "llvm/Constants.h"
Chris Lattner7152c232003-08-24 04:06:56 +000017#include "llvm/DerivedTypes.h"
Chris Lattnerca398dc2003-05-29 15:11:31 +000018#include "llvm/Module.h"
Chris Lattner80a38d22003-08-24 06:59:16 +000019#include "llvm/Instructions.h"
20#include "llvm/Intrinsics.h"
Devang Pateleaf42ab2008-09-23 23:03:40 +000021#include "llvm/Attributes.h"
Chris Lattner468fb1d2006-01-14 20:07:50 +000022#include "llvm/Analysis/CallGraph.h"
Chris Lattnerc93adca2008-01-11 06:09:30 +000023#include "llvm/Target/TargetData.h"
Chris Lattner93e985f2007-02-13 02:10:56 +000024#include "llvm/ADT/SmallVector.h"
Devang Patel641ca932008-03-10 18:22:16 +000025#include "llvm/ADT/StringExtras.h"
Chris Lattner80a38d22003-08-24 06:59:16 +000026#include "llvm/Support/CallSite.h"
Chris Lattnerf7703df2004-01-09 06:12:26 +000027using namespace llvm;
Chris Lattnerca398dc2003-05-29 15:11:31 +000028
Chris Lattner1dfdf822007-01-30 23:22:39 +000029bool llvm::InlineFunction(CallInst *CI, CallGraph *CG, const TargetData *TD) {
30 return InlineFunction(CallSite(CI), CG, TD);
Chris Lattner468fb1d2006-01-14 20:07:50 +000031}
Chris Lattner1dfdf822007-01-30 23:22:39 +000032bool llvm::InlineFunction(InvokeInst *II, CallGraph *CG, const TargetData *TD) {
33 return InlineFunction(CallSite(II), CG, TD);
Chris Lattner468fb1d2006-01-14 20:07:50 +000034}
Chris Lattner80a38d22003-08-24 06:59:16 +000035
Chris Lattnercd4d3392006-01-13 19:05:59 +000036/// HandleInlinedInvoke - If we inlined an invoke site, we need to convert calls
37/// in the body of the inlined function into invokes and turn unwind
38/// instructions into branches to the invoke unwind dest.
39///
Nick Lewyckydac5c4b2009-02-03 04:34:40 +000040/// II is the invoke instruction being inlined. FirstNewBlock is the first
Chris Lattnercd4d3392006-01-13 19:05:59 +000041/// block of the inlined code (the last block is the end of the function),
42/// and InlineCodeInfo is information about the code that got inlined.
43static void HandleInlinedInvoke(InvokeInst *II, BasicBlock *FirstNewBlock,
Devang Patel28c531c2009-03-31 17:36:12 +000044 ClonedCodeInfo &InlinedCodeInfo,
45 CallGraph *CG) {
Chris Lattnercd4d3392006-01-13 19:05:59 +000046 BasicBlock *InvokeDest = II->getUnwindDest();
47 std::vector<Value*> InvokeDestPHIValues;
48
49 // If there are PHI nodes in the unwind destination block, we need to
50 // keep track of which values came into them from this invoke, then remove
51 // the entry for this block.
52 BasicBlock *InvokeBlock = II->getParent();
53 for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
54 PHINode *PN = cast<PHINode>(I);
55 // Save the value to use for this edge.
56 InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
57 }
58
59 Function *Caller = FirstNewBlock->getParent();
Duncan Sandsa7212e52008-09-05 12:37:12 +000060
Chris Lattnercd4d3392006-01-13 19:05:59 +000061 // The inlined code is currently at the end of the function, scan from the
62 // start of the inlined code to its end, checking for stuff we need to
63 // rewrite.
Chris Lattner727d1dd2006-01-13 19:15:15 +000064 if (InlinedCodeInfo.ContainsCalls || InlinedCodeInfo.ContainsUnwinds) {
65 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
66 BB != E; ++BB) {
67 if (InlinedCodeInfo.ContainsCalls) {
68 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ){
69 Instruction *I = BBI++;
Duncan Sandsa7212e52008-09-05 12:37:12 +000070
Chris Lattner727d1dd2006-01-13 19:15:15 +000071 // We only need to check for function calls: inlined invoke
72 // instructions require no special handling.
73 if (!isa<CallInst>(I)) continue;
74 CallInst *CI = cast<CallInst>(I);
Chris Lattnercd4d3392006-01-13 19:05:59 +000075
Duncan Sandsfd7b3262007-12-17 18:08:19 +000076 // If this call cannot unwind, don't convert it to an invoke.
Duncan Sands2b0e8992007-12-18 09:59:50 +000077 if (CI->doesNotThrow())
Chris Lattner727d1dd2006-01-13 19:15:15 +000078 continue;
Duncan Sandsa3355ff2007-12-03 20:06:50 +000079
Chris Lattner727d1dd2006-01-13 19:15:15 +000080 // Convert this function call into an invoke instruction.
81 // First, split the basic block.
82 BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
Duncan Sandsa7212e52008-09-05 12:37:12 +000083
Chris Lattner727d1dd2006-01-13 19:15:15 +000084 // Next, create the new invoke instruction, inserting it at the end
85 // of the old basic block.
Chris Lattner93e985f2007-02-13 02:10:56 +000086 SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
Chris Lattner727d1dd2006-01-13 19:15:15 +000087 InvokeInst *II =
Gabor Greif051a9502008-04-06 20:25:17 +000088 InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
89 InvokeArgs.begin(), InvokeArgs.end(),
90 CI->getName(), BB->getTerminator());
Chris Lattner727d1dd2006-01-13 19:15:15 +000091 II->setCallingConv(CI->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +000092 II->setAttributes(CI->getAttributes());
Duncan Sandsa7212e52008-09-05 12:37:12 +000093
Chris Lattner727d1dd2006-01-13 19:15:15 +000094 // Make sure that anything using the call now uses the invoke!
95 CI->replaceAllUsesWith(II);
Duncan Sandsa7212e52008-09-05 12:37:12 +000096
Devang Patel28c531c2009-03-31 17:36:12 +000097 // Update the callgraph.
98 if (CG) {
99 // We should be able to do this:
100 // (*CG)[Caller]->replaceCallSite(CI, II);
101 // but that fails if the old call site isn't in the call graph,
102 // which, because of LLVM bug 3601, it sometimes isn't.
103 CallGraphNode *CGN = (*CG)[Caller];
104 for (CallGraphNode::iterator NI = CGN->begin(), NE = CGN->end();
105 NI != NE; ++NI) {
106 if (NI->first == CI) {
107 NI->first = II;
108 break;
109 }
110 }
111 }
112
Chris Lattner727d1dd2006-01-13 19:15:15 +0000113 // Delete the unconditional branch inserted by splitBasicBlock
114 BB->getInstList().pop_back();
115 Split->getInstList().pop_front(); // Delete the original call
Duncan Sandsa7212e52008-09-05 12:37:12 +0000116
Chris Lattner727d1dd2006-01-13 19:15:15 +0000117 // Update any PHI nodes in the exceptional block to indicate that
118 // there is now a new entry in them.
119 unsigned i = 0;
120 for (BasicBlock::iterator I = InvokeDest->begin();
121 isa<PHINode>(I); ++I, ++i) {
122 PHINode *PN = cast<PHINode>(I);
123 PN->addIncoming(InvokeDestPHIValues[i], BB);
124 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000125
Chris Lattner727d1dd2006-01-13 19:15:15 +0000126 // This basic block is now complete, start scanning the next one.
127 break;
128 }
Chris Lattnercd4d3392006-01-13 19:05:59 +0000129 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000130
Chris Lattner727d1dd2006-01-13 19:15:15 +0000131 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
132 // An UnwindInst requires special handling when it gets inlined into an
133 // invoke site. Once this happens, we know that the unwind would cause
134 // a control transfer to the invoke exception destination, so we can
135 // transform it into a direct branch to the exception destination.
Gabor Greif051a9502008-04-06 20:25:17 +0000136 BranchInst::Create(InvokeDest, UI);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000137
Chris Lattner727d1dd2006-01-13 19:15:15 +0000138 // Delete the unwind instruction!
Dan Gohman1adec832008-06-21 22:08:46 +0000139 UI->eraseFromParent();
Duncan Sandsa7212e52008-09-05 12:37:12 +0000140
Chris Lattner727d1dd2006-01-13 19:15:15 +0000141 // Update any PHI nodes in the exceptional block to indicate that
142 // there is now a new entry in them.
143 unsigned i = 0;
144 for (BasicBlock::iterator I = InvokeDest->begin();
145 isa<PHINode>(I); ++I, ++i) {
146 PHINode *PN = cast<PHINode>(I);
147 PN->addIncoming(InvokeDestPHIValues[i], BB);
148 }
Chris Lattnercd4d3392006-01-13 19:05:59 +0000149 }
150 }
151 }
152
153 // Now that everything is happy, we have one final detail. The PHI nodes in
154 // the exception destination block still have entries due to the original
155 // invoke instruction. Eliminate these entries (which might even delete the
156 // PHI node) now.
157 InvokeDest->removePredecessor(II->getParent());
158}
159
Chris Lattnerd85340f2006-07-12 18:29:36 +0000160/// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
161/// into the caller, update the specified callgraph to reflect the changes we
162/// made. Note that it's possible that not all code was copied over, so only
Duncan Sandsd7b98512008-09-08 11:05:51 +0000163/// some edges of the callgraph may remain.
164static void UpdateCallGraphAfterInlining(CallSite CS,
Chris Lattnerd85340f2006-07-12 18:29:36 +0000165 Function::iterator FirstNewBlock,
Chris Lattner5e665f52007-02-03 00:08:31 +0000166 DenseMap<const Value*, Value*> &ValueMap,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000167 CallGraph &CG) {
Duncan Sandsd7b98512008-09-08 11:05:51 +0000168 const Function *Caller = CS.getInstruction()->getParent()->getParent();
169 const Function *Callee = CS.getCalledFunction();
Chris Lattner468fb1d2006-01-14 20:07:50 +0000170 CallGraphNode *CalleeNode = CG[Callee];
171 CallGraphNode *CallerNode = CG[Caller];
Duncan Sandsa7212e52008-09-05 12:37:12 +0000172
Chris Lattnerd85340f2006-07-12 18:29:36 +0000173 // Since we inlined some uninlined call sites in the callee into the caller,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000174 // add edges from the caller to all of the callees of the callee.
Gabor Greifc478e522009-01-15 18:40:09 +0000175 CallGraphNode::iterator I = CalleeNode->begin(), E = CalleeNode->end();
176
177 // Consider the case where CalleeNode == CallerNode.
Gabor Greif12532982009-01-17 00:09:08 +0000178 CallGraphNode::CalledFunctionsVector CallCache;
Gabor Greifc478e522009-01-15 18:40:09 +0000179 if (CalleeNode == CallerNode) {
180 CallCache.assign(I, E);
181 I = CallCache.begin();
182 E = CallCache.end();
183 }
184
185 for (; I != E; ++I) {
Chris Lattnerd85340f2006-07-12 18:29:36 +0000186 const Instruction *OrigCall = I->first.getInstruction();
Duncan Sandsa7212e52008-09-05 12:37:12 +0000187
Chris Lattner5e665f52007-02-03 00:08:31 +0000188 DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
Chris Lattner981418b2006-07-12 21:37:11 +0000189 // Only copy the edge if the call was inlined!
190 if (VMI != ValueMap.end() && VMI->second) {
Chris Lattner1bb3a402006-07-12 18:37:18 +0000191 // If the call was inlined, but then constant folded, there is no edge to
192 // add. Check for this case.
193 if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
194 CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000195 }
196 }
Dale Johannesen39fa3242009-01-13 22:43:37 +0000197 // Update the call graph by deleting the edge from Callee to Caller. We must
198 // do this after the loop above in case Caller and Callee are the same.
199 CallerNode->removeCallEdgeFor(CS);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000200}
201
Chris Lattnercd4d3392006-01-13 19:05:59 +0000202
Chris Lattnerca398dc2003-05-29 15:11:31 +0000203// InlineFunction - This function inlines the called function into the basic
204// block of the caller. This returns false if it is not possible to inline this
205// call. The program is still in a well defined state if this occurs though.
206//
Misha Brukmanfd939082005-04-21 23:48:37 +0000207// Note that this only does one level of inlining. For example, if the
208// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
Chris Lattnerca398dc2003-05-29 15:11:31 +0000209// exists in the instruction stream. Similiarly this will inline a recursive
210// function by one level.
211//
Chris Lattner1dfdf822007-01-30 23:22:39 +0000212bool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD) {
Chris Lattner80a38d22003-08-24 06:59:16 +0000213 Instruction *TheCall = CS.getInstruction();
214 assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
215 "Instruction not in function!");
Chris Lattnerca398dc2003-05-29 15:11:31 +0000216
Chris Lattner80a38d22003-08-24 06:59:16 +0000217 const Function *CalledFunc = CS.getCalledFunction();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000218 if (CalledFunc == 0 || // Can't inline external function or indirect
Reid Spencer5cbf9852007-01-30 20:08:39 +0000219 CalledFunc->isDeclaration() || // call, or call to a vararg function!
Chris Lattnerca398dc2003-05-29 15:11:31 +0000220 CalledFunc->getFunctionType()->isVarArg()) return false;
221
Chris Lattner1b491412005-05-06 06:47:52 +0000222
Chris Lattneraf9985c2009-02-12 07:06:42 +0000223 // If the call to the callee is not a tail call, we must clear the 'tail'
Chris Lattner1b491412005-05-06 06:47:52 +0000224 // flags on any calls that we inline.
225 bool MustClearTailCallFlags =
Chris Lattneraf9985c2009-02-12 07:06:42 +0000226 !(isa<CallInst>(TheCall) && cast<CallInst>(TheCall)->isTailCall());
Chris Lattner1b491412005-05-06 06:47:52 +0000227
Duncan Sandsf0c33542007-12-19 21:13:37 +0000228 // If the call to the callee cannot throw, set the 'nounwind' flag on any
229 // calls that we inline.
230 bool MarkNoUnwind = CS.doesNotThrow();
231
Chris Lattner80a38d22003-08-24 06:59:16 +0000232 BasicBlock *OrigBB = TheCall->getParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000233 Function *Caller = OrigBB->getParent();
234
Gordon Henriksen0e138212007-12-25 03:10:07 +0000235 // GC poses two hazards to inlining, which only occur when the callee has GC:
236 // 1. If the caller has no GC, then the callee's GC must be propagated to the
237 // caller.
238 // 2. If the caller has a differing GC, it is invalid to inline.
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000239 if (CalledFunc->hasGC()) {
240 if (!Caller->hasGC())
241 Caller->setGC(CalledFunc->getGC());
242 else if (CalledFunc->getGC() != Caller->getGC())
Gordon Henriksen0e138212007-12-25 03:10:07 +0000243 return false;
244 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000245
Chris Lattner5052c912004-02-04 01:41:09 +0000246 // Get an iterator to the last basic block in the function, which will have
247 // the new function inlined after it.
248 //
249 Function::iterator LastBlock = &Caller->back();
250
Chris Lattner5e923de2004-02-04 02:51:48 +0000251 // Make sure to capture all of the return instructions from the cloned
Chris Lattnerca398dc2003-05-29 15:11:31 +0000252 // function.
Chris Lattner5e923de2004-02-04 02:51:48 +0000253 std::vector<ReturnInst*> Returns;
Chris Lattnercd4d3392006-01-13 19:05:59 +0000254 ClonedCodeInfo InlinedFunctionInfo;
Dale Johannesen0744f092009-03-04 02:09:48 +0000255 Function::iterator FirstNewBlock;
Duncan Sandsf0c33542007-12-19 21:13:37 +0000256
Chris Lattner5e923de2004-02-04 02:51:48 +0000257 { // Scope to destroy ValueMap after cloning.
Chris Lattner5e665f52007-02-03 00:08:31 +0000258 DenseMap<const Value*, Value*> ValueMap;
Chris Lattner5b5bc302006-05-27 01:28:04 +0000259
Dan Gohman9614fcc2008-06-20 17:11:32 +0000260 assert(CalledFunc->arg_size() == CS.arg_size() &&
Chris Lattner5e923de2004-02-04 02:51:48 +0000261 "No varargs calls can be inlined!");
Duncan Sandsa7212e52008-09-05 12:37:12 +0000262
Chris Lattnerc93adca2008-01-11 06:09:30 +0000263 // Calculate the vector of arguments to pass into the function cloner, which
264 // matches up the formal to the actual argument values.
Chris Lattner5e923de2004-02-04 02:51:48 +0000265 CallSite::arg_iterator AI = CS.arg_begin();
Chris Lattnerc93adca2008-01-11 06:09:30 +0000266 unsigned ArgNo = 0;
Chris Lattnere4d5c442005-03-15 04:54:21 +0000267 for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
Chris Lattnerc93adca2008-01-11 06:09:30 +0000268 E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
269 Value *ActualArg = *AI;
Duncan Sandsa7212e52008-09-05 12:37:12 +0000270
Duncan Sandsd82375c2008-01-27 18:12:58 +0000271 // When byval arguments actually inlined, we need to make the copy implied
272 // by them explicit. However, we don't do this if the callee is readonly
273 // or readnone, because the copy would be unneeded: the callee doesn't
274 // modify the struct.
Devang Patel05988662008-09-25 21:00:45 +0000275 if (CalledFunc->paramHasAttr(ArgNo+1, Attribute::ByVal) &&
Duncan Sandsd82375c2008-01-27 18:12:58 +0000276 !CalledFunc->onlyReadsMemory()) {
Chris Lattnerc93adca2008-01-11 06:09:30 +0000277 const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
278 const Type *VoidPtrTy = PointerType::getUnqual(Type::Int8Ty);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000279
Chris Lattnerc93adca2008-01-11 06:09:30 +0000280 // Create the alloca. If we have TargetData, use nice alignment.
281 unsigned Align = 1;
282 if (TD) Align = TD->getPrefTypeAlignment(AggTy);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000283 Value *NewAlloca = new AllocaInst(AggTy, 0, Align, I->getName(),
Chris Lattnerc93adca2008-01-11 06:09:30 +0000284 Caller->begin()->begin());
285 // Emit a memcpy.
Chris Lattner824b9582008-11-21 16:42:48 +0000286 const Type *Tys[] = { Type::Int64Ty };
Chris Lattnerc93adca2008-01-11 06:09:30 +0000287 Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
Chris Lattner824b9582008-11-21 16:42:48 +0000288 Intrinsic::memcpy,
289 Tys, 1);
Chris Lattnerc93adca2008-01-11 06:09:30 +0000290 Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
291 Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000292
Chris Lattnerc93adca2008-01-11 06:09:30 +0000293 Value *Size;
294 if (TD == 0)
295 Size = ConstantExpr::getSizeOf(AggTy);
296 else
297 Size = ConstantInt::get(Type::Int64Ty, TD->getTypeStoreSize(AggTy));
Duncan Sandsa7212e52008-09-05 12:37:12 +0000298
Chris Lattnerc93adca2008-01-11 06:09:30 +0000299 // Always generate a memcpy of alignment 1 here because we don't know
300 // the alignment of the src pointer. Other optimizations can infer
301 // better alignment.
302 Value *CallArgs[] = {
303 DestCast, SrcCast, Size, ConstantInt::get(Type::Int32Ty, 1)
304 };
305 CallInst *TheMemCpy =
Gabor Greif051a9502008-04-06 20:25:17 +0000306 CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000307
Chris Lattnerc93adca2008-01-11 06:09:30 +0000308 // If we have a call graph, update it.
309 if (CG) {
310 CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
311 CallGraphNode *CallerNode = (*CG)[Caller];
312 CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
313 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000314
Chris Lattnerc93adca2008-01-11 06:09:30 +0000315 // Uses of the argument in the function should use our new alloca
316 // instead.
317 ActualArg = NewAlloca;
318 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000319
Chris Lattnerc93adca2008-01-11 06:09:30 +0000320 ValueMap[I] = ActualArg;
321 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000322
Chris Lattner5b5bc302006-05-27 01:28:04 +0000323 // We want the inliner to prune the code as it copies. We would LOVE to
324 // have no dead or constant instructions leftover after inlining occurs
325 // (which can happen, e.g., because an argument was constant), but we'll be
326 // happy with whatever the cloner can do.
327 CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
Chris Lattner1dfdf822007-01-30 23:22:39 +0000328 &InlinedFunctionInfo, TD);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000329
Chris Lattnerd85340f2006-07-12 18:29:36 +0000330 // Remember the first block that is newly cloned over.
331 FirstNewBlock = LastBlock; ++FirstNewBlock;
Duncan Sandsa7212e52008-09-05 12:37:12 +0000332
Chris Lattnerd85340f2006-07-12 18:29:36 +0000333 // Update the callgraph if requested.
334 if (CG)
Duncan Sandsd7b98512008-09-08 11:05:51 +0000335 UpdateCallGraphAfterInlining(CS, FirstNewBlock, ValueMap, *CG);
Misha Brukmanfd939082005-04-21 23:48:37 +0000336 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000337
Chris Lattnerca398dc2003-05-29 15:11:31 +0000338 // If there are any alloca instructions in the block that used to be the entry
339 // block for the callee, move them to the entry block of the caller. First
340 // calculate which instruction they should be inserted before. We insert the
341 // instructions at the end of the current alloca list.
342 //
Chris Lattner21f20552006-01-13 18:16:48 +0000343 {
Chris Lattner80a38d22003-08-24 06:59:16 +0000344 BasicBlock::iterator InsertPoint = Caller->begin()->begin();
Chris Lattner5e923de2004-02-04 02:51:48 +0000345 for (BasicBlock::iterator I = FirstNewBlock->begin(),
346 E = FirstNewBlock->end(); I != E; )
Chris Lattner33bb3c82006-09-13 19:23:57 +0000347 if (AllocaInst *AI = dyn_cast<AllocaInst>(I++)) {
348 // If the alloca is now dead, remove it. This often occurs due to code
349 // specialization.
350 if (AI->use_empty()) {
351 AI->eraseFromParent();
352 continue;
353 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000354
Chris Lattnerf775f952003-10-14 01:11:07 +0000355 if (isa<Constant>(AI->getArraySize())) {
Chris Lattner21f20552006-01-13 18:16:48 +0000356 // Scan for the block of allocas that we can move over, and move them
357 // all at once.
Chris Lattnerc1df7e12004-02-04 21:33:42 +0000358 while (isa<AllocaInst>(I) &&
359 isa<Constant>(cast<AllocaInst>(I)->getArraySize()))
360 ++I;
361
362 // Transfer all of the allocas over in a block. Using splice means
Dan Gohmane26bff22007-02-20 20:52:03 +0000363 // that the instructions aren't removed from the symbol table, then
Chris Lattnerc1df7e12004-02-04 21:33:42 +0000364 // reinserted.
Dan Gohmanecb7a772007-03-22 16:38:57 +0000365 Caller->getEntryBlock().getInstList().splice(
366 InsertPoint,
367 FirstNewBlock->getInstList(),
368 AI, I);
Chris Lattnerf775f952003-10-14 01:11:07 +0000369 }
Chris Lattner33bb3c82006-09-13 19:23:57 +0000370 }
Chris Lattner80a38d22003-08-24 06:59:16 +0000371 }
Chris Lattnerca398dc2003-05-29 15:11:31 +0000372
Chris Lattnerbf229f42006-01-13 19:34:14 +0000373 // If the inlined code contained dynamic alloca instructions, wrap the inlined
374 // code with llvm.stacksave/llvm.stackrestore intrinsics.
375 if (InlinedFunctionInfo.ContainsDynamicAllocas) {
376 Module *M = Caller->getParent();
Chris Lattnerbf229f42006-01-13 19:34:14 +0000377 // Get the two intrinsics we care about.
Chris Lattnera121fdd2007-01-07 07:54:34 +0000378 Constant *StackSave, *StackRestore;
Duncan Sands3d292ac2008-04-07 13:43:58 +0000379 StackSave = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
380 StackRestore = Intrinsic::getDeclaration(M, Intrinsic::stackrestore);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000381
382 // If we are preserving the callgraph, add edges to the stacksave/restore
383 // functions for the calls we insert.
Chris Lattner21ba23d2006-07-18 21:48:57 +0000384 CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
Chris Lattnerd85340f2006-07-12 18:29:36 +0000385 if (CG) {
Chris Lattnera121fdd2007-01-07 07:54:34 +0000386 // We know that StackSave/StackRestore are Function*'s, because they are
387 // intrinsics which must have the right types.
388 StackSaveCGN = CG->getOrInsertFunction(cast<Function>(StackSave));
389 StackRestoreCGN = CG->getOrInsertFunction(cast<Function>(StackRestore));
Chris Lattnerd85340f2006-07-12 18:29:36 +0000390 CallerNode = (*CG)[Caller];
391 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000392
Chris Lattnerbf229f42006-01-13 19:34:14 +0000393 // Insert the llvm.stacksave.
Duncan Sandsa7212e52008-09-05 12:37:12 +0000394 CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
Gabor Greif051a9502008-04-06 20:25:17 +0000395 FirstNewBlock->begin());
Chris Lattnerd85340f2006-07-12 18:29:36 +0000396 if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000397
Chris Lattnerbf229f42006-01-13 19:34:14 +0000398 // Insert a call to llvm.stackrestore before any return instructions in the
399 // inlined function.
Chris Lattnerd85340f2006-07-12 18:29:36 +0000400 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000401 CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000402 if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
403 }
Chris Lattner468fb1d2006-01-14 20:07:50 +0000404
405 // Count the number of StackRestore calls we insert.
406 unsigned NumStackRestores = Returns.size();
Duncan Sandsa7212e52008-09-05 12:37:12 +0000407
Chris Lattnerbf229f42006-01-13 19:34:14 +0000408 // If we are inlining an invoke instruction, insert restores before each
409 // unwind. These unwinds will be rewritten into branches later.
410 if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
411 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
412 BB != E; ++BB)
Chris Lattner468fb1d2006-01-14 20:07:50 +0000413 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Duncan Sands3d292ac2008-04-07 13:43:58 +0000414 CallInst::Create(StackRestore, SavedPtr, "", UI);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000415 ++NumStackRestores;
416 }
417 }
Chris Lattnerbf229f42006-01-13 19:34:14 +0000418 }
419
Duncan Sandsa7212e52008-09-05 12:37:12 +0000420 // If we are inlining tail call instruction through a call site that isn't
Chris Lattner1fdf4a82006-01-13 19:18:11 +0000421 // marked 'tail', we must remove the tail marker for any calls in the inlined
Duncan Sandsf0c33542007-12-19 21:13:37 +0000422 // code. Also, calls inlined through a 'nounwind' call site should be marked
423 // 'nounwind'.
424 if (InlinedFunctionInfo.ContainsCalls &&
425 (MustClearTailCallFlags || MarkNoUnwind)) {
Chris Lattner1b491412005-05-06 06:47:52 +0000426 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
427 BB != E; ++BB)
428 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sandsf0c33542007-12-19 21:13:37 +0000429 if (CallInst *CI = dyn_cast<CallInst>(I)) {
430 if (MustClearTailCallFlags)
431 CI->setTailCall(false);
432 if (MarkNoUnwind)
433 CI->setDoesNotThrow();
434 }
Chris Lattner1b491412005-05-06 06:47:52 +0000435 }
436
Duncan Sandsf0c33542007-12-19 21:13:37 +0000437 // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
438 // instructions are unreachable.
439 if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
440 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
441 BB != E; ++BB) {
442 TerminatorInst *Term = BB->getTerminator();
443 if (isa<UnwindInst>(Term)) {
444 new UnreachableInst(Term);
445 BB->getInstList().erase(Term);
446 }
447 }
448
Chris Lattner5e923de2004-02-04 02:51:48 +0000449 // If we are inlining for an invoke instruction, we must make sure to rewrite
450 // any inlined 'unwind' instructions into branches to the invoke exception
451 // destination, and call instructions into invoke instructions.
Chris Lattnercd4d3392006-01-13 19:05:59 +0000452 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Devang Patel28c531c2009-03-31 17:36:12 +0000453 HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo, CG);
Chris Lattner5e923de2004-02-04 02:51:48 +0000454
Chris Lattner44a68072004-02-04 04:17:06 +0000455 // If we cloned in _exactly one_ basic block, and if that block ends in a
456 // return instruction, we splice the body of the inlined callee directly into
457 // the calling basic block.
458 if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
459 // Move all of the instructions right before the call.
460 OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
461 FirstNewBlock->begin(), FirstNewBlock->end());
462 // Remove the cloned basic block.
463 Caller->getBasicBlockList().pop_back();
Misha Brukmanfd939082005-04-21 23:48:37 +0000464
Chris Lattner44a68072004-02-04 04:17:06 +0000465 // If the call site was an invoke instruction, add a branch to the normal
466 // destination.
467 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Gabor Greif051a9502008-04-06 20:25:17 +0000468 BranchInst::Create(II->getNormalDest(), TheCall);
Chris Lattner44a68072004-02-04 04:17:06 +0000469
470 // If the return instruction returned a value, replace uses of the call with
471 // uses of the returned value.
Devang Pateldc00d422008-03-04 21:15:15 +0000472 if (!TheCall->use_empty()) {
473 ReturnInst *R = Returns[0];
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000474 TheCall->replaceAllUsesWith(R->getReturnValue());
Devang Pateldc00d422008-03-04 21:15:15 +0000475 }
Chris Lattner44a68072004-02-04 04:17:06 +0000476 // Since we are now done with the Call/Invoke, we can delete it.
Dan Gohman1adec832008-06-21 22:08:46 +0000477 TheCall->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000478
479 // Since we are now done with the return instruction, delete it also.
Dan Gohman1adec832008-06-21 22:08:46 +0000480 Returns[0]->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000481
482 // We are now done with the inlining.
483 return true;
484 }
485
486 // Otherwise, we have the normal case, of more than one block to inline or
487 // multiple return sites.
488
Chris Lattner5e923de2004-02-04 02:51:48 +0000489 // We want to clone the entire callee function into the hole between the
490 // "starter" and "ender" blocks. How we accomplish this depends on whether
491 // this is an invoke instruction or a call instruction.
492 BasicBlock *AfterCallBB;
493 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
Misha Brukmanfd939082005-04-21 23:48:37 +0000494
Chris Lattner5e923de2004-02-04 02:51:48 +0000495 // Add an unconditional branch to make this look like the CallInst case...
Gabor Greif051a9502008-04-06 20:25:17 +0000496 BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000497
Chris Lattner5e923de2004-02-04 02:51:48 +0000498 // Split the basic block. This guarantees that no PHI nodes will have to be
499 // updated due to new incoming edges, and make the invoke case more
500 // symmetric to the call case.
501 AfterCallBB = OrigBB->splitBasicBlock(NewBr,
Chris Lattner284d1b82004-12-11 16:59:54 +0000502 CalledFunc->getName()+".exit");
Misha Brukmanfd939082005-04-21 23:48:37 +0000503
Chris Lattner5e923de2004-02-04 02:51:48 +0000504 } else { // It's a call
Chris Lattner44a68072004-02-04 04:17:06 +0000505 // If this is a call instruction, we need to split the basic block that
506 // the call lives in.
Chris Lattner5e923de2004-02-04 02:51:48 +0000507 //
508 AfterCallBB = OrigBB->splitBasicBlock(TheCall,
Chris Lattner284d1b82004-12-11 16:59:54 +0000509 CalledFunc->getName()+".exit");
Chris Lattner5e923de2004-02-04 02:51:48 +0000510 }
511
Chris Lattner44a68072004-02-04 04:17:06 +0000512 // Change the branch that used to go to AfterCallBB to branch to the first
513 // basic block of the inlined function.
514 //
515 TerminatorInst *Br = OrigBB->getTerminator();
Misha Brukmanfd939082005-04-21 23:48:37 +0000516 assert(Br && Br->getOpcode() == Instruction::Br &&
Chris Lattner44a68072004-02-04 04:17:06 +0000517 "splitBasicBlock broken!");
518 Br->setOperand(0, FirstNewBlock);
519
520
521 // Now that the function is correct, make it a little bit nicer. In
522 // particular, move the basic blocks inserted from the end of the function
523 // into the space made by splitting the source basic block.
Chris Lattner44a68072004-02-04 04:17:06 +0000524 Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
525 FirstNewBlock, Caller->end());
526
Chris Lattner5e923de2004-02-04 02:51:48 +0000527 // Handle all of the return instructions that we just cloned in, and eliminate
528 // any users of the original call/invoke instruction.
Devang Patelb8f198a2008-03-10 18:34:00 +0000529 const Type *RTy = CalledFunc->getReturnType();
Dan Gohman2c317502008-06-20 01:03:44 +0000530
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000531 if (Returns.size() > 1) {
Chris Lattner5e923de2004-02-04 02:51:48 +0000532 // The PHI node should go at the front of the new basic block to merge all
533 // possible incoming values.
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000534 PHINode *PHI = 0;
Chris Lattner5e923de2004-02-04 02:51:48 +0000535 if (!TheCall->use_empty()) {
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000536 PHI = PHINode::Create(RTy, TheCall->getName(),
537 AfterCallBB->begin());
538 // Anything that used the result of the function call should now use the
539 // PHI node as their operand.
Duncan Sandsa7212e52008-09-05 12:37:12 +0000540 TheCall->replaceAllUsesWith(PHI);
Chris Lattner5e923de2004-02-04 02:51:48 +0000541 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000542
Gabor Greifc478e522009-01-15 18:40:09 +0000543 // Loop over all of the return instructions adding entries to the PHI node
544 // as appropriate.
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000545 if (PHI) {
546 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
547 ReturnInst *RI = Returns[i];
548 assert(RI->getReturnValue()->getType() == PHI->getType() &&
549 "Ret value not consistent in function!");
550 PHI->addIncoming(RI->getReturnValue(), RI->getParent());
Devang Patel12a466b2008-03-07 20:06:16 +0000551 }
552 }
553
Gabor Greifde62aea2009-01-16 23:08:50 +0000554 // Add a branch to the merge points and remove return instructions.
Chris Lattner5e923de2004-02-04 02:51:48 +0000555 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
556 ReturnInst *RI = Returns[i];
Dale Johannesen0744f092009-03-04 02:09:48 +0000557 BranchInst::Create(AfterCallBB, RI);
Devang Patelb8f198a2008-03-10 18:34:00 +0000558 RI->eraseFromParent();
Chris Lattner5e923de2004-02-04 02:51:48 +0000559 }
Devang Patelb8f198a2008-03-10 18:34:00 +0000560 } else if (!Returns.empty()) {
561 // Otherwise, if there is exactly one return value, just replace anything
562 // using the return value of the call with the computed value.
563 if (!TheCall->use_empty())
564 TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
Duncan Sandsa7212e52008-09-05 12:37:12 +0000565
Devang Patelb8f198a2008-03-10 18:34:00 +0000566 // Splice the code from the return block into the block that it will return
567 // to, which contains the code that was after the call.
568 BasicBlock *ReturnBB = Returns[0]->getParent();
569 AfterCallBB->getInstList().splice(AfterCallBB->begin(),
570 ReturnBB->getInstList());
Duncan Sandsa7212e52008-09-05 12:37:12 +0000571
Devang Patelb8f198a2008-03-10 18:34:00 +0000572 // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
573 ReturnBB->replaceAllUsesWith(AfterCallBB);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000574
Devang Patelb8f198a2008-03-10 18:34:00 +0000575 // Delete the return instruction now and empty ReturnBB now.
576 Returns[0]->eraseFromParent();
577 ReturnBB->eraseFromParent();
Chris Lattner3787e762004-10-17 23:21:07 +0000578 } else if (!TheCall->use_empty()) {
579 // No returns, but something is using the return value of the call. Just
580 // nuke the result.
581 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
Chris Lattner5e923de2004-02-04 02:51:48 +0000582 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000583
Chris Lattner5e923de2004-02-04 02:51:48 +0000584 // Since we are now done with the Call/Invoke, we can delete it.
Chris Lattner3787e762004-10-17 23:21:07 +0000585 TheCall->eraseFromParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000586
Chris Lattner7152c232003-08-24 04:06:56 +0000587 // We should always be able to fold the entry block of the function into the
588 // single predecessor of the block...
Chris Lattnercd01ae52004-04-16 05:17:59 +0000589 assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
Chris Lattner7152c232003-08-24 04:06:56 +0000590 BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
Chris Lattner44a68072004-02-04 04:17:06 +0000591
Chris Lattnercd01ae52004-04-16 05:17:59 +0000592 // Splice the code entry block into calling block, right before the
593 // unconditional branch.
594 OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
595 CalleeEntry->replaceAllUsesWith(OrigBB); // Update PHI nodes
596
597 // Remove the unconditional branch.
598 OrigBB->getInstList().erase(Br);
599
600 // Now we can remove the CalleeEntry block, which is now empty.
601 Caller->getBasicBlockList().erase(CalleeEntry);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000602
Chris Lattnerca398dc2003-05-29 15:11:31 +0000603 return true;
604}