blob: 599fe33aa03181fe64aa488df5037b1b48f90a8d [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"
Owen Anderson0a205a42009-07-05 22:41:43 +000018#include "llvm/LLVMContext.h"
Chris Lattnerca398dc2003-05-29 15:11:31 +000019#include "llvm/Module.h"
Chris Lattner80a38d22003-08-24 06:59:16 +000020#include "llvm/Instructions.h"
Devang Patel517576d2009-04-15 00:17:06 +000021#include "llvm/IntrinsicInst.h"
Chris Lattner80a38d22003-08-24 06:59:16 +000022#include "llvm/Intrinsics.h"
Devang Pateleaf42ab2008-09-23 23:03:40 +000023#include "llvm/Attributes.h"
Chris Lattner468fb1d2006-01-14 20:07:50 +000024#include "llvm/Analysis/CallGraph.h"
Devang Patel517576d2009-04-15 00:17:06 +000025#include "llvm/Analysis/DebugInfo.h"
Chris Lattnerc93adca2008-01-11 06:09:30 +000026#include "llvm/Target/TargetData.h"
Chris Lattner93e985f2007-02-13 02:10:56 +000027#include "llvm/ADT/SmallVector.h"
Devang Patel641ca932008-03-10 18:22:16 +000028#include "llvm/ADT/StringExtras.h"
Chris Lattner80a38d22003-08-24 06:59:16 +000029#include "llvm/Support/CallSite.h"
Chris Lattnerf7703df2004-01-09 06:12:26 +000030using namespace llvm;
Chris Lattnerca398dc2003-05-29 15:11:31 +000031
Chris Lattner8f2718f2009-08-27 04:20:52 +000032bool llvm::InlineFunction(CallInst *CI, CallGraph *CG, const TargetData *TD,
33 SmallVectorImpl<AllocaInst*> *StaticAllocas) {
34 return InlineFunction(CallSite(CI), CG, TD, StaticAllocas);
Chris Lattner468fb1d2006-01-14 20:07:50 +000035}
Chris Lattner8f2718f2009-08-27 04:20:52 +000036bool llvm::InlineFunction(InvokeInst *II, CallGraph *CG, const TargetData *TD,
37 SmallVectorImpl<AllocaInst*> *StaticAllocas) {
38 return InlineFunction(CallSite(II), CG, TD, StaticAllocas);
Chris Lattner468fb1d2006-01-14 20:07:50 +000039}
Chris Lattner80a38d22003-08-24 06:59:16 +000040
Chris Lattner135755d2009-08-27 03:51:50 +000041
42/// HandleCallsInBlockInlinedThroughInvoke - When we inline a basic block into
Eric Christopherf61f89a2009-09-06 22:20:54 +000043/// an invoke, we have to turn all of the calls that can throw into
Chris Lattner135755d2009-08-27 03:51:50 +000044/// invokes. This function analyze BB to see if there are any calls, and if so,
45/// it rewrites them to be invokes that jump to InvokeDest and fills in the PHI
Chris Lattner81dfb382009-09-01 18:44:06 +000046/// nodes in that block with the values specified in InvokeDestPHIValues.
Chris Lattner135755d2009-08-27 03:51:50 +000047///
48static void HandleCallsInBlockInlinedThroughInvoke(BasicBlock *BB,
49 BasicBlock *InvokeDest,
Chris Lattner81dfb382009-09-01 18:44:06 +000050 const SmallVectorImpl<Value*> &InvokeDestPHIValues) {
Chris Lattner135755d2009-08-27 03:51:50 +000051 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ) {
52 Instruction *I = BBI++;
53
54 // We only need to check for function calls: inlined invoke
55 // instructions require no special handling.
56 CallInst *CI = dyn_cast<CallInst>(I);
57 if (CI == 0) continue;
58
59 // If this call cannot unwind, don't convert it to an invoke.
60 if (CI->doesNotThrow())
61 continue;
62
63 // Convert this function call into an invoke instruction.
64 // First, split the basic block.
65 BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
66
67 // Next, create the new invoke instruction, inserting it at the end
68 // of the old basic block.
69 SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
70 InvokeInst *II =
71 InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
72 InvokeArgs.begin(), InvokeArgs.end(),
73 CI->getName(), BB->getTerminator());
74 II->setCallingConv(CI->getCallingConv());
75 II->setAttributes(CI->getAttributes());
76
Chris Lattner81dfb382009-09-01 18:44:06 +000077 // Make sure that anything using the call now uses the invoke! This also
78 // updates the CallGraph if present.
Chris Lattner135755d2009-08-27 03:51:50 +000079 CI->replaceAllUsesWith(II);
80
Chris Lattner135755d2009-08-27 03:51:50 +000081 // Delete the unconditional branch inserted by splitBasicBlock
82 BB->getInstList().pop_back();
83 Split->getInstList().pop_front(); // Delete the original call
84
85 // Update any PHI nodes in the exceptional block to indicate that
86 // there is now a new entry in them.
87 unsigned i = 0;
88 for (BasicBlock::iterator I = InvokeDest->begin();
89 isa<PHINode>(I); ++I, ++i)
90 cast<PHINode>(I)->addIncoming(InvokeDestPHIValues[i], BB);
91
92 // This basic block is now complete, the caller will continue scanning the
93 // next one.
94 return;
95 }
96}
97
98
Chris Lattnercd4d3392006-01-13 19:05:59 +000099/// HandleInlinedInvoke - If we inlined an invoke site, we need to convert calls
100/// in the body of the inlined function into invokes and turn unwind
101/// instructions into branches to the invoke unwind dest.
102///
Nick Lewyckydac5c4b2009-02-03 04:34:40 +0000103/// II is the invoke instruction being inlined. FirstNewBlock is the first
Chris Lattnercd4d3392006-01-13 19:05:59 +0000104/// block of the inlined code (the last block is the end of the function),
105/// and InlineCodeInfo is information about the code that got inlined.
106static void HandleInlinedInvoke(InvokeInst *II, BasicBlock *FirstNewBlock,
Chris Lattner81dfb382009-09-01 18:44:06 +0000107 ClonedCodeInfo &InlinedCodeInfo) {
Chris Lattnercd4d3392006-01-13 19:05:59 +0000108 BasicBlock *InvokeDest = II->getUnwindDest();
Chris Lattner135755d2009-08-27 03:51:50 +0000109 SmallVector<Value*, 8> InvokeDestPHIValues;
Chris Lattnercd4d3392006-01-13 19:05:59 +0000110
111 // If there are PHI nodes in the unwind destination block, we need to
112 // keep track of which values came into them from this invoke, then remove
113 // the entry for this block.
114 BasicBlock *InvokeBlock = II->getParent();
115 for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
116 PHINode *PN = cast<PHINode>(I);
117 // Save the value to use for this edge.
118 InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
119 }
120
121 Function *Caller = FirstNewBlock->getParent();
Duncan Sandsa7212e52008-09-05 12:37:12 +0000122
Chris Lattnercd4d3392006-01-13 19:05:59 +0000123 // The inlined code is currently at the end of the function, scan from the
124 // start of the inlined code to its end, checking for stuff we need to
Chris Lattner135755d2009-08-27 03:51:50 +0000125 // rewrite. If the code doesn't have calls or unwinds, we know there is
126 // nothing to rewrite.
127 if (!InlinedCodeInfo.ContainsCalls && !InlinedCodeInfo.ContainsUnwinds) {
128 // Now that everything is happy, we have one final detail. The PHI nodes in
129 // the exception destination block still have entries due to the original
130 // invoke instruction. Eliminate these entries (which might even delete the
131 // PHI node) now.
132 InvokeDest->removePredecessor(II->getParent());
133 return;
134 }
135
Chris Lattner135755d2009-08-27 03:51:50 +0000136 for (Function::iterator BB = FirstNewBlock, E = Caller->end(); BB != E; ++BB){
137 if (InlinedCodeInfo.ContainsCalls)
138 HandleCallsInBlockInlinedThroughInvoke(BB, InvokeDest,
Chris Lattner81dfb382009-09-01 18:44:06 +0000139 InvokeDestPHIValues);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000140
Chris Lattner135755d2009-08-27 03:51:50 +0000141 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
142 // An UnwindInst requires special handling when it gets inlined into an
143 // invoke site. Once this happens, we know that the unwind would cause
144 // a control transfer to the invoke exception destination, so we can
145 // transform it into a direct branch to the exception destination.
146 BranchInst::Create(InvokeDest, UI);
Chris Lattnercd4d3392006-01-13 19:05:59 +0000147
Chris Lattner135755d2009-08-27 03:51:50 +0000148 // Delete the unwind instruction!
149 UI->eraseFromParent();
Duncan Sandsa3355ff2007-12-03 20:06:50 +0000150
Chris Lattner135755d2009-08-27 03:51:50 +0000151 // Update any PHI nodes in the exceptional block to indicate that
152 // there is now a new entry in them.
153 unsigned i = 0;
154 for (BasicBlock::iterator I = InvokeDest->begin();
155 isa<PHINode>(I); ++I, ++i) {
156 PHINode *PN = cast<PHINode>(I);
157 PN->addIncoming(InvokeDestPHIValues[i], BB);
Chris Lattnercd4d3392006-01-13 19:05:59 +0000158 }
159 }
160 }
161
162 // Now that everything is happy, we have one final detail. The PHI nodes in
163 // the exception destination block still have entries due to the original
164 // invoke instruction. Eliminate these entries (which might even delete the
165 // PHI node) now.
166 InvokeDest->removePredecessor(II->getParent());
167}
168
Chris Lattnerd85340f2006-07-12 18:29:36 +0000169/// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
170/// into the caller, update the specified callgraph to reflect the changes we
171/// made. Note that it's possible that not all code was copied over, so only
Duncan Sandsd7b98512008-09-08 11:05:51 +0000172/// some edges of the callgraph may remain.
173static void UpdateCallGraphAfterInlining(CallSite CS,
Chris Lattnerd85340f2006-07-12 18:29:36 +0000174 Function::iterator FirstNewBlock,
Chris Lattner5e665f52007-02-03 00:08:31 +0000175 DenseMap<const Value*, Value*> &ValueMap,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000176 CallGraph &CG) {
Duncan Sandsd7b98512008-09-08 11:05:51 +0000177 const Function *Caller = CS.getInstruction()->getParent()->getParent();
178 const Function *Callee = CS.getCalledFunction();
Chris Lattner468fb1d2006-01-14 20:07:50 +0000179 CallGraphNode *CalleeNode = CG[Callee];
180 CallGraphNode *CallerNode = CG[Caller];
Duncan Sandsa7212e52008-09-05 12:37:12 +0000181
Chris Lattnerd85340f2006-07-12 18:29:36 +0000182 // Since we inlined some uninlined call sites in the callee into the caller,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000183 // add edges from the caller to all of the callees of the callee.
Gabor Greifc478e522009-01-15 18:40:09 +0000184 CallGraphNode::iterator I = CalleeNode->begin(), E = CalleeNode->end();
185
186 // Consider the case where CalleeNode == CallerNode.
Gabor Greif12532982009-01-17 00:09:08 +0000187 CallGraphNode::CalledFunctionsVector CallCache;
Gabor Greifc478e522009-01-15 18:40:09 +0000188 if (CalleeNode == CallerNode) {
189 CallCache.assign(I, E);
190 I = CallCache.begin();
191 E = CallCache.end();
192 }
193
194 for (; I != E; ++I) {
Chris Lattnera541b0f2009-09-01 06:31:31 +0000195 const Value *OrigCall = I->first;
Duncan Sandsa7212e52008-09-05 12:37:12 +0000196
Chris Lattner5e665f52007-02-03 00:08:31 +0000197 DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
Chris Lattner981418b2006-07-12 21:37:11 +0000198 // Only copy the edge if the call was inlined!
Chris Lattner135755d2009-08-27 03:51:50 +0000199 if (VMI == ValueMap.end() || VMI->second == 0)
200 continue;
201
202 // If the call was inlined, but then constant folded, there is no edge to
203 // add. Check for this case.
204 if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
205 CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000206 }
Chris Lattner135755d2009-08-27 03:51:50 +0000207
Dale Johannesen39fa3242009-01-13 22:43:37 +0000208 // Update the call graph by deleting the edge from Callee to Caller. We must
209 // do this after the loop above in case Caller and Callee are the same.
210 CallerNode->removeCallEdgeFor(CS);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000211}
212
Chris Lattnerca398dc2003-05-29 15:11:31 +0000213// InlineFunction - This function inlines the called function into the basic
214// block of the caller. This returns false if it is not possible to inline this
215// call. The program is still in a well defined state if this occurs though.
216//
Misha Brukmanfd939082005-04-21 23:48:37 +0000217// Note that this only does one level of inlining. For example, if the
218// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
Chris Lattnerca398dc2003-05-29 15:11:31 +0000219// exists in the instruction stream. Similiarly this will inline a recursive
220// function by one level.
221//
Chris Lattner8f2718f2009-08-27 04:20:52 +0000222bool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD,
223 SmallVectorImpl<AllocaInst*> *StaticAllocas) {
Chris Lattner80a38d22003-08-24 06:59:16 +0000224 Instruction *TheCall = CS.getInstruction();
Owen Andersone922c022009-07-22 00:24:57 +0000225 LLVMContext &Context = TheCall->getContext();
Chris Lattner80a38d22003-08-24 06:59:16 +0000226 assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
227 "Instruction not in function!");
Chris Lattnerca398dc2003-05-29 15:11:31 +0000228
Chris Lattner80a38d22003-08-24 06:59:16 +0000229 const Function *CalledFunc = CS.getCalledFunction();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000230 if (CalledFunc == 0 || // Can't inline external function or indirect
Reid Spencer5cbf9852007-01-30 20:08:39 +0000231 CalledFunc->isDeclaration() || // call, or call to a vararg function!
Chris Lattnera54934a2010-03-23 22:59:07 +0000232 CalledFunc->getFunctionType()->isVarArg() ||
233 CS.isNoInline()) // Call site is marked noinline.
234 return false;
Chris Lattnerca398dc2003-05-29 15:11:31 +0000235
Chris Lattner1b491412005-05-06 06:47:52 +0000236
Chris Lattneraf9985c2009-02-12 07:06:42 +0000237 // If the call to the callee is not a tail call, we must clear the 'tail'
Chris Lattner1b491412005-05-06 06:47:52 +0000238 // flags on any calls that we inline.
239 bool MustClearTailCallFlags =
Chris Lattneraf9985c2009-02-12 07:06:42 +0000240 !(isa<CallInst>(TheCall) && cast<CallInst>(TheCall)->isTailCall());
Chris Lattner1b491412005-05-06 06:47:52 +0000241
Duncan Sandsf0c33542007-12-19 21:13:37 +0000242 // If the call to the callee cannot throw, set the 'nounwind' flag on any
243 // calls that we inline.
244 bool MarkNoUnwind = CS.doesNotThrow();
245
Chris Lattner80a38d22003-08-24 06:59:16 +0000246 BasicBlock *OrigBB = TheCall->getParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000247 Function *Caller = OrigBB->getParent();
248
Gordon Henriksen0e138212007-12-25 03:10:07 +0000249 // GC poses two hazards to inlining, which only occur when the callee has GC:
250 // 1. If the caller has no GC, then the callee's GC must be propagated to the
251 // caller.
252 // 2. If the caller has a differing GC, it is invalid to inline.
Gordon Henriksen5eca0752008-08-17 18:44:35 +0000253 if (CalledFunc->hasGC()) {
254 if (!Caller->hasGC())
255 Caller->setGC(CalledFunc->getGC());
256 else if (CalledFunc->getGC() != Caller->getGC())
Gordon Henriksen0e138212007-12-25 03:10:07 +0000257 return false;
258 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000259
Chris Lattner5052c912004-02-04 01:41:09 +0000260 // Get an iterator to the last basic block in the function, which will have
261 // the new function inlined after it.
262 //
263 Function::iterator LastBlock = &Caller->back();
264
Chris Lattner5e923de2004-02-04 02:51:48 +0000265 // Make sure to capture all of the return instructions from the cloned
Chris Lattnerca398dc2003-05-29 15:11:31 +0000266 // function.
Chris Lattnerec1bea02009-08-27 04:02:30 +0000267 SmallVector<ReturnInst*, 8> Returns;
Chris Lattnercd4d3392006-01-13 19:05:59 +0000268 ClonedCodeInfo InlinedFunctionInfo;
Dale Johannesen0744f092009-03-04 02:09:48 +0000269 Function::iterator FirstNewBlock;
Duncan Sandsf0c33542007-12-19 21:13:37 +0000270
Chris Lattner5e923de2004-02-04 02:51:48 +0000271 { // Scope to destroy ValueMap after cloning.
Chris Lattner5e665f52007-02-03 00:08:31 +0000272 DenseMap<const Value*, Value*> ValueMap;
Chris Lattner5b5bc302006-05-27 01:28:04 +0000273
Dan Gohman9614fcc2008-06-20 17:11:32 +0000274 assert(CalledFunc->arg_size() == CS.arg_size() &&
Chris Lattner5e923de2004-02-04 02:51:48 +0000275 "No varargs calls can be inlined!");
Duncan Sandsa7212e52008-09-05 12:37:12 +0000276
Chris Lattnerc93adca2008-01-11 06:09:30 +0000277 // Calculate the vector of arguments to pass into the function cloner, which
278 // matches up the formal to the actual argument values.
Chris Lattner5e923de2004-02-04 02:51:48 +0000279 CallSite::arg_iterator AI = CS.arg_begin();
Chris Lattnerc93adca2008-01-11 06:09:30 +0000280 unsigned ArgNo = 0;
Chris Lattnere4d5c442005-03-15 04:54:21 +0000281 for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
Chris Lattnerc93adca2008-01-11 06:09:30 +0000282 E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
283 Value *ActualArg = *AI;
Duncan Sandsa7212e52008-09-05 12:37:12 +0000284
Duncan Sandsd82375c2008-01-27 18:12:58 +0000285 // When byval arguments actually inlined, we need to make the copy implied
286 // by them explicit. However, we don't do this if the callee is readonly
287 // or readnone, because the copy would be unneeded: the callee doesn't
288 // modify the struct.
Devang Patel05988662008-09-25 21:00:45 +0000289 if (CalledFunc->paramHasAttr(ArgNo+1, Attribute::ByVal) &&
Duncan Sandsd82375c2008-01-27 18:12:58 +0000290 !CalledFunc->onlyReadsMemory()) {
Chris Lattnerc93adca2008-01-11 06:09:30 +0000291 const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
Owen Anderson1d0be152009-08-13 21:58:54 +0000292 const Type *VoidPtrTy =
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000293 Type::getInt8PtrTy(Context);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000294
Chris Lattnerc93adca2008-01-11 06:09:30 +0000295 // Create the alloca. If we have TargetData, use nice alignment.
296 unsigned Align = 1;
297 if (TD) Align = TD->getPrefTypeAlignment(AggTy);
Owen Anderson50dead02009-07-15 23:53:25 +0000298 Value *NewAlloca = new AllocaInst(AggTy, 0, Align,
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000299 I->getName(),
300 &*Caller->begin()->begin());
Chris Lattnerc93adca2008-01-11 06:09:30 +0000301 // Emit a memcpy.
Owen Anderson1d0be152009-08-13 21:58:54 +0000302 const Type *Tys[] = { Type::getInt64Ty(Context) };
Chris Lattnerc93adca2008-01-11 06:09:30 +0000303 Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
Chris Lattner824b9582008-11-21 16:42:48 +0000304 Intrinsic::memcpy,
305 Tys, 1);
Chris Lattnerc93adca2008-01-11 06:09:30 +0000306 Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
307 Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000308
Chris Lattnerc93adca2008-01-11 06:09:30 +0000309 Value *Size;
310 if (TD == 0)
Owen Andersonbaf3c402009-07-29 18:55:55 +0000311 Size = ConstantExpr::getSizeOf(AggTy);
Chris Lattnerc93adca2008-01-11 06:09:30 +0000312 else
Owen Anderson1d0be152009-08-13 21:58:54 +0000313 Size = ConstantInt::get(Type::getInt64Ty(Context),
Owen Anderson0a205a42009-07-05 22:41:43 +0000314 TD->getTypeStoreSize(AggTy));
Duncan Sandsa7212e52008-09-05 12:37:12 +0000315
Chris Lattnerc93adca2008-01-11 06:09:30 +0000316 // Always generate a memcpy of alignment 1 here because we don't know
317 // the alignment of the src pointer. Other optimizations can infer
318 // better alignment.
319 Value *CallArgs[] = {
Owen Anderson1d0be152009-08-13 21:58:54 +0000320 DestCast, SrcCast, Size,
321 ConstantInt::get(Type::getInt32Ty(Context), 1)
Chris Lattnerc93adca2008-01-11 06:09:30 +0000322 };
323 CallInst *TheMemCpy =
Gabor Greif051a9502008-04-06 20:25:17 +0000324 CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000325
Chris Lattnerc93adca2008-01-11 06:09:30 +0000326 // If we have a call graph, update it.
327 if (CG) {
328 CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
329 CallGraphNode *CallerNode = (*CG)[Caller];
330 CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
331 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000332
Chris Lattnerc93adca2008-01-11 06:09:30 +0000333 // Uses of the argument in the function should use our new alloca
334 // instead.
335 ActualArg = NewAlloca;
336 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000337
Chris Lattnerc93adca2008-01-11 06:09:30 +0000338 ValueMap[I] = ActualArg;
339 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000340
Chris Lattner5b5bc302006-05-27 01:28:04 +0000341 // We want the inliner to prune the code as it copies. We would LOVE to
342 // have no dead or constant instructions leftover after inlining occurs
343 // (which can happen, e.g., because an argument was constant), but we'll be
344 // happy with whatever the cloner can do.
345 CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
Devang Patel53bb5c92009-11-10 23:06:00 +0000346 &InlinedFunctionInfo, TD, TheCall);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000347
Chris Lattnerd85340f2006-07-12 18:29:36 +0000348 // Remember the first block that is newly cloned over.
349 FirstNewBlock = LastBlock; ++FirstNewBlock;
Duncan Sandsa7212e52008-09-05 12:37:12 +0000350
Chris Lattnerd85340f2006-07-12 18:29:36 +0000351 // Update the callgraph if requested.
352 if (CG)
Duncan Sandsd7b98512008-09-08 11:05:51 +0000353 UpdateCallGraphAfterInlining(CS, FirstNewBlock, ValueMap, *CG);
Misha Brukmanfd939082005-04-21 23:48:37 +0000354 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000355
Chris Lattnerca398dc2003-05-29 15:11:31 +0000356 // If there are any alloca instructions in the block that used to be the entry
357 // block for the callee, move them to the entry block of the caller. First
358 // calculate which instruction they should be inserted before. We insert the
359 // instructions at the end of the current alloca list.
360 //
Chris Lattner21f20552006-01-13 18:16:48 +0000361 {
Chris Lattner80a38d22003-08-24 06:59:16 +0000362 BasicBlock::iterator InsertPoint = Caller->begin()->begin();
Chris Lattner5e923de2004-02-04 02:51:48 +0000363 for (BasicBlock::iterator I = FirstNewBlock->begin(),
Chris Lattner135755d2009-08-27 03:51:50 +0000364 E = FirstNewBlock->end(); I != E; ) {
365 AllocaInst *AI = dyn_cast<AllocaInst>(I++);
366 if (AI == 0) continue;
367
368 // If the alloca is now dead, remove it. This often occurs due to code
369 // specialization.
370 if (AI->use_empty()) {
371 AI->eraseFromParent();
372 continue;
Chris Lattner33bb3c82006-09-13 19:23:57 +0000373 }
Chris Lattner135755d2009-08-27 03:51:50 +0000374
375 if (!isa<Constant>(AI->getArraySize()))
376 continue;
377
Chris Lattner8f2718f2009-08-27 04:20:52 +0000378 // Keep track of the static allocas that we inline into the caller if the
379 // StaticAllocas pointer is non-null.
380 if (StaticAllocas) StaticAllocas->push_back(AI);
381
Chris Lattner135755d2009-08-27 03:51:50 +0000382 // Scan for the block of allocas that we can move over, and move them
383 // all at once.
384 while (isa<AllocaInst>(I) &&
Chris Lattner8f2718f2009-08-27 04:20:52 +0000385 isa<Constant>(cast<AllocaInst>(I)->getArraySize())) {
386 if (StaticAllocas) StaticAllocas->push_back(cast<AllocaInst>(I));
Chris Lattner135755d2009-08-27 03:51:50 +0000387 ++I;
Chris Lattner8f2718f2009-08-27 04:20:52 +0000388 }
Chris Lattner135755d2009-08-27 03:51:50 +0000389
390 // Transfer all of the allocas over in a block. Using splice means
391 // that the instructions aren't removed from the symbol table, then
392 // reinserted.
393 Caller->getEntryBlock().getInstList().splice(InsertPoint,
394 FirstNewBlock->getInstList(),
395 AI, I);
396 }
Chris Lattner80a38d22003-08-24 06:59:16 +0000397 }
Chris Lattnerca398dc2003-05-29 15:11:31 +0000398
Chris Lattnerbf229f42006-01-13 19:34:14 +0000399 // If the inlined code contained dynamic alloca instructions, wrap the inlined
400 // code with llvm.stacksave/llvm.stackrestore intrinsics.
401 if (InlinedFunctionInfo.ContainsDynamicAllocas) {
402 Module *M = Caller->getParent();
Chris Lattnerbf229f42006-01-13 19:34:14 +0000403 // Get the two intrinsics we care about.
Chris Lattner6128df52009-10-17 05:39:39 +0000404 Function *StackSave = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
405 Function *StackRestore=Intrinsic::getDeclaration(M,Intrinsic::stackrestore);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000406
407 // If we are preserving the callgraph, add edges to the stacksave/restore
408 // functions for the calls we insert.
Chris Lattner21ba23d2006-07-18 21:48:57 +0000409 CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
Chris Lattnerd85340f2006-07-12 18:29:36 +0000410 if (CG) {
Chris Lattner6128df52009-10-17 05:39:39 +0000411 StackSaveCGN = CG->getOrInsertFunction(StackSave);
412 StackRestoreCGN = CG->getOrInsertFunction(StackRestore);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000413 CallerNode = (*CG)[Caller];
414 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000415
Chris Lattnerbf229f42006-01-13 19:34:14 +0000416 // Insert the llvm.stacksave.
Duncan Sandsa7212e52008-09-05 12:37:12 +0000417 CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
Gabor Greif051a9502008-04-06 20:25:17 +0000418 FirstNewBlock->begin());
Chris Lattnerd85340f2006-07-12 18:29:36 +0000419 if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000420
Chris Lattnerbf229f42006-01-13 19:34:14 +0000421 // Insert a call to llvm.stackrestore before any return instructions in the
422 // inlined function.
Chris Lattnerd85340f2006-07-12 18:29:36 +0000423 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000424 CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000425 if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
426 }
Chris Lattner468fb1d2006-01-14 20:07:50 +0000427
428 // Count the number of StackRestore calls we insert.
429 unsigned NumStackRestores = Returns.size();
Duncan Sandsa7212e52008-09-05 12:37:12 +0000430
Chris Lattnerbf229f42006-01-13 19:34:14 +0000431 // If we are inlining an invoke instruction, insert restores before each
432 // unwind. These unwinds will be rewritten into branches later.
433 if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
434 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
435 BB != E; ++BB)
Chris Lattner468fb1d2006-01-14 20:07:50 +0000436 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Chris Lattner6128df52009-10-17 05:39:39 +0000437 CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", UI);
438 if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000439 ++NumStackRestores;
440 }
441 }
Chris Lattnerbf229f42006-01-13 19:34:14 +0000442 }
443
Duncan Sandsa7212e52008-09-05 12:37:12 +0000444 // If we are inlining tail call instruction through a call site that isn't
Chris Lattner1fdf4a82006-01-13 19:18:11 +0000445 // marked 'tail', we must remove the tail marker for any calls in the inlined
Duncan Sandsf0c33542007-12-19 21:13:37 +0000446 // code. Also, calls inlined through a 'nounwind' call site should be marked
447 // 'nounwind'.
448 if (InlinedFunctionInfo.ContainsCalls &&
449 (MustClearTailCallFlags || MarkNoUnwind)) {
Chris Lattner1b491412005-05-06 06:47:52 +0000450 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
451 BB != E; ++BB)
452 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sandsf0c33542007-12-19 21:13:37 +0000453 if (CallInst *CI = dyn_cast<CallInst>(I)) {
454 if (MustClearTailCallFlags)
455 CI->setTailCall(false);
456 if (MarkNoUnwind)
457 CI->setDoesNotThrow();
458 }
Chris Lattner1b491412005-05-06 06:47:52 +0000459 }
460
Duncan Sandsf0c33542007-12-19 21:13:37 +0000461 // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
462 // instructions are unreachable.
463 if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
464 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
465 BB != E; ++BB) {
466 TerminatorInst *Term = BB->getTerminator();
467 if (isa<UnwindInst>(Term)) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000468 new UnreachableInst(Context, Term);
Duncan Sandsf0c33542007-12-19 21:13:37 +0000469 BB->getInstList().erase(Term);
470 }
471 }
472
Chris Lattner5e923de2004-02-04 02:51:48 +0000473 // If we are inlining for an invoke instruction, we must make sure to rewrite
474 // any inlined 'unwind' instructions into branches to the invoke exception
475 // destination, and call instructions into invoke instructions.
Chris Lattnercd4d3392006-01-13 19:05:59 +0000476 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Chris Lattner81dfb382009-09-01 18:44:06 +0000477 HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo);
Chris Lattner5e923de2004-02-04 02:51:48 +0000478
Chris Lattner44a68072004-02-04 04:17:06 +0000479 // If we cloned in _exactly one_ basic block, and if that block ends in a
480 // return instruction, we splice the body of the inlined callee directly into
481 // the calling basic block.
482 if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
483 // Move all of the instructions right before the call.
484 OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
485 FirstNewBlock->begin(), FirstNewBlock->end());
486 // Remove the cloned basic block.
487 Caller->getBasicBlockList().pop_back();
Misha Brukmanfd939082005-04-21 23:48:37 +0000488
Chris Lattner44a68072004-02-04 04:17:06 +0000489 // If the call site was an invoke instruction, add a branch to the normal
490 // destination.
491 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Gabor Greif051a9502008-04-06 20:25:17 +0000492 BranchInst::Create(II->getNormalDest(), TheCall);
Chris Lattner44a68072004-02-04 04:17:06 +0000493
494 // If the return instruction returned a value, replace uses of the call with
495 // uses of the returned value.
Devang Pateldc00d422008-03-04 21:15:15 +0000496 if (!TheCall->use_empty()) {
497 ReturnInst *R = Returns[0];
Eli Friedman5877ad72009-05-08 00:22:04 +0000498 if (TheCall == R->getReturnValue())
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000499 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
Eli Friedman5877ad72009-05-08 00:22:04 +0000500 else
501 TheCall->replaceAllUsesWith(R->getReturnValue());
Devang Pateldc00d422008-03-04 21:15:15 +0000502 }
Chris Lattner44a68072004-02-04 04:17:06 +0000503 // Since we are now done with the Call/Invoke, we can delete it.
Dan Gohman1adec832008-06-21 22:08:46 +0000504 TheCall->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000505
506 // Since we are now done with the return instruction, delete it also.
Dan Gohman1adec832008-06-21 22:08:46 +0000507 Returns[0]->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000508
509 // We are now done with the inlining.
510 return true;
511 }
512
513 // Otherwise, we have the normal case, of more than one block to inline or
514 // multiple return sites.
515
Chris Lattner5e923de2004-02-04 02:51:48 +0000516 // We want to clone the entire callee function into the hole between the
517 // "starter" and "ender" blocks. How we accomplish this depends on whether
518 // this is an invoke instruction or a call instruction.
519 BasicBlock *AfterCallBB;
520 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
Misha Brukmanfd939082005-04-21 23:48:37 +0000521
Chris Lattner5e923de2004-02-04 02:51:48 +0000522 // Add an unconditional branch to make this look like the CallInst case...
Gabor Greif051a9502008-04-06 20:25:17 +0000523 BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000524
Chris Lattner5e923de2004-02-04 02:51:48 +0000525 // Split the basic block. This guarantees that no PHI nodes will have to be
526 // updated due to new incoming edges, and make the invoke case more
527 // symmetric to the call case.
528 AfterCallBB = OrigBB->splitBasicBlock(NewBr,
Chris Lattner284d1b82004-12-11 16:59:54 +0000529 CalledFunc->getName()+".exit");
Misha Brukmanfd939082005-04-21 23:48:37 +0000530
Chris Lattner5e923de2004-02-04 02:51:48 +0000531 } else { // It's a call
Chris Lattner44a68072004-02-04 04:17:06 +0000532 // If this is a call instruction, we need to split the basic block that
533 // the call lives in.
Chris Lattner5e923de2004-02-04 02:51:48 +0000534 //
535 AfterCallBB = OrigBB->splitBasicBlock(TheCall,
Chris Lattner284d1b82004-12-11 16:59:54 +0000536 CalledFunc->getName()+".exit");
Chris Lattner5e923de2004-02-04 02:51:48 +0000537 }
538
Chris Lattner44a68072004-02-04 04:17:06 +0000539 // Change the branch that used to go to AfterCallBB to branch to the first
540 // basic block of the inlined function.
541 //
542 TerminatorInst *Br = OrigBB->getTerminator();
Misha Brukmanfd939082005-04-21 23:48:37 +0000543 assert(Br && Br->getOpcode() == Instruction::Br &&
Chris Lattner44a68072004-02-04 04:17:06 +0000544 "splitBasicBlock broken!");
545 Br->setOperand(0, FirstNewBlock);
546
547
548 // Now that the function is correct, make it a little bit nicer. In
549 // particular, move the basic blocks inserted from the end of the function
550 // into the space made by splitting the source basic block.
Chris Lattner44a68072004-02-04 04:17:06 +0000551 Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
552 FirstNewBlock, Caller->end());
553
Chris Lattner5e923de2004-02-04 02:51:48 +0000554 // Handle all of the return instructions that we just cloned in, and eliminate
555 // any users of the original call/invoke instruction.
Devang Patelb8f198a2008-03-10 18:34:00 +0000556 const Type *RTy = CalledFunc->getReturnType();
Dan Gohman2c317502008-06-20 01:03:44 +0000557
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000558 if (Returns.size() > 1) {
Chris Lattner5e923de2004-02-04 02:51:48 +0000559 // The PHI node should go at the front of the new basic block to merge all
560 // possible incoming values.
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000561 PHINode *PHI = 0;
Chris Lattner5e923de2004-02-04 02:51:48 +0000562 if (!TheCall->use_empty()) {
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000563 PHI = PHINode::Create(RTy, TheCall->getName(),
564 AfterCallBB->begin());
565 // Anything that used the result of the function call should now use the
566 // PHI node as their operand.
Duncan Sandsa7212e52008-09-05 12:37:12 +0000567 TheCall->replaceAllUsesWith(PHI);
Chris Lattner5e923de2004-02-04 02:51:48 +0000568 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000569
Gabor Greifc478e522009-01-15 18:40:09 +0000570 // Loop over all of the return instructions adding entries to the PHI node
571 // as appropriate.
Dan Gohmanfc74abf2008-07-23 00:34:11 +0000572 if (PHI) {
573 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
574 ReturnInst *RI = Returns[i];
575 assert(RI->getReturnValue()->getType() == PHI->getType() &&
576 "Ret value not consistent in function!");
577 PHI->addIncoming(RI->getReturnValue(), RI->getParent());
Devang Patel12a466b2008-03-07 20:06:16 +0000578 }
Chris Lattnerc581acb2009-10-27 05:39:41 +0000579
580 // Now that we inserted the PHI, check to see if it has a single value
581 // (e.g. all the entries are the same or undef). If so, remove the PHI so
582 // it doesn't block other optimizations.
583 if (Value *V = PHI->hasConstantValue()) {
584 PHI->replaceAllUsesWith(V);
585 PHI->eraseFromParent();
586 }
Devang Patel12a466b2008-03-07 20:06:16 +0000587 }
588
Chris Lattnerc581acb2009-10-27 05:39:41 +0000589
Gabor Greifde62aea2009-01-16 23:08:50 +0000590 // Add a branch to the merge points and remove return instructions.
Chris Lattner5e923de2004-02-04 02:51:48 +0000591 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
592 ReturnInst *RI = Returns[i];
Dale Johannesen0744f092009-03-04 02:09:48 +0000593 BranchInst::Create(AfterCallBB, RI);
Devang Patelb8f198a2008-03-10 18:34:00 +0000594 RI->eraseFromParent();
Chris Lattner5e923de2004-02-04 02:51:48 +0000595 }
Devang Patelb8f198a2008-03-10 18:34:00 +0000596 } else if (!Returns.empty()) {
597 // Otherwise, if there is exactly one return value, just replace anything
598 // using the return value of the call with the computed value.
Eli Friedman5877ad72009-05-08 00:22:04 +0000599 if (!TheCall->use_empty()) {
600 if (TheCall == Returns[0]->getReturnValue())
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000601 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
Eli Friedman5877ad72009-05-08 00:22:04 +0000602 else
603 TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
604 }
Duncan Sandsa7212e52008-09-05 12:37:12 +0000605
Devang Patelb8f198a2008-03-10 18:34:00 +0000606 // Splice the code from the return block into the block that it will return
607 // to, which contains the code that was after the call.
608 BasicBlock *ReturnBB = Returns[0]->getParent();
609 AfterCallBB->getInstList().splice(AfterCallBB->begin(),
610 ReturnBB->getInstList());
Duncan Sandsa7212e52008-09-05 12:37:12 +0000611
Devang Patelb8f198a2008-03-10 18:34:00 +0000612 // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
613 ReturnBB->replaceAllUsesWith(AfterCallBB);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000614
Devang Patelb8f198a2008-03-10 18:34:00 +0000615 // Delete the return instruction now and empty ReturnBB now.
616 Returns[0]->eraseFromParent();
617 ReturnBB->eraseFromParent();
Chris Lattner3787e762004-10-17 23:21:07 +0000618 } else if (!TheCall->use_empty()) {
619 // No returns, but something is using the return value of the call. Just
620 // nuke the result.
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000621 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
Chris Lattner5e923de2004-02-04 02:51:48 +0000622 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000623
Chris Lattner5e923de2004-02-04 02:51:48 +0000624 // Since we are now done with the Call/Invoke, we can delete it.
Chris Lattner3787e762004-10-17 23:21:07 +0000625 TheCall->eraseFromParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000626
Chris Lattner7152c232003-08-24 04:06:56 +0000627 // We should always be able to fold the entry block of the function into the
628 // single predecessor of the block...
Chris Lattnercd01ae52004-04-16 05:17:59 +0000629 assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
Chris Lattner7152c232003-08-24 04:06:56 +0000630 BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
Chris Lattner44a68072004-02-04 04:17:06 +0000631
Chris Lattnercd01ae52004-04-16 05:17:59 +0000632 // Splice the code entry block into calling block, right before the
633 // unconditional branch.
634 OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
635 CalleeEntry->replaceAllUsesWith(OrigBB); // Update PHI nodes
636
637 // Remove the unconditional branch.
638 OrigBB->getInstList().erase(Br);
639
640 // Now we can remove the CalleeEntry block, which is now empty.
641 Caller->getBasicBlockList().erase(CalleeEntry);
Duncan Sandsa7212e52008-09-05 12:37:12 +0000642
Chris Lattnerca398dc2003-05-29 15:11:31 +0000643 return true;
644}