blob: a8cba6b9a75b8f1bfb961c607301810fd0547c40 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- InlineFunction.cpp - Code to perform function inlining -------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements inlining of a function into a call site, resolving
11// parameters and the return value as appropriate.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Transforms/Utils/Cloning.h"
16#include "llvm/Constants.h"
17#include "llvm/DerivedTypes.h"
18#include "llvm/Module.h"
19#include "llvm/Instructions.h"
Devang Patel41f60452009-04-15 00:17:06 +000020#include "llvm/IntrinsicInst.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000021#include "llvm/Intrinsics.h"
Devang Patele480dfa2008-09-23 23:03:40 +000022#include "llvm/Attributes.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000023#include "llvm/Analysis/CallGraph.h"
Devang Patel41f60452009-04-15 00:17:06 +000024#include "llvm/Analysis/DebugInfo.h"
Chris Lattner124993a2008-01-11 06:09:30 +000025#include "llvm/Target/TargetData.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026#include "llvm/ADT/SmallVector.h"
Devang Patel859ff0f2008-03-10 18:22:16 +000027#include "llvm/ADT/StringExtras.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000028#include "llvm/Support/CallSite.h"
29using namespace llvm;
30
31bool llvm::InlineFunction(CallInst *CI, CallGraph *CG, const TargetData *TD) {
32 return InlineFunction(CallSite(CI), CG, TD);
33}
34bool llvm::InlineFunction(InvokeInst *II, CallGraph *CG, const TargetData *TD) {
35 return InlineFunction(CallSite(II), CG, TD);
36}
37
38/// HandleInlinedInvoke - If we inlined an invoke site, we need to convert calls
39/// in the body of the inlined function into invokes and turn unwind
40/// instructions into branches to the invoke unwind dest.
41///
Nick Lewyckyd575c982009-02-03 04:34:40 +000042/// II is the invoke instruction being inlined. FirstNewBlock is the first
Dan Gohmanf17a25c2007-07-18 16:29:46 +000043/// block of the inlined code (the last block is the end of the function),
44/// and InlineCodeInfo is information about the code that got inlined.
45static void HandleInlinedInvoke(InvokeInst *II, BasicBlock *FirstNewBlock,
Devang Patel41f6b202009-03-31 17:36:12 +000046 ClonedCodeInfo &InlinedCodeInfo,
47 CallGraph *CG) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +000048 BasicBlock *InvokeDest = II->getUnwindDest();
49 std::vector<Value*> InvokeDestPHIValues;
50
51 // If there are PHI nodes in the unwind destination block, we need to
52 // keep track of which values came into them from this invoke, then remove
53 // the entry for this block.
54 BasicBlock *InvokeBlock = II->getParent();
55 for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
56 PHINode *PN = cast<PHINode>(I);
57 // Save the value to use for this edge.
58 InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
59 }
60
61 Function *Caller = FirstNewBlock->getParent();
Duncan Sandse4267052008-09-05 12:37:12 +000062
Dan Gohmanf17a25c2007-07-18 16:29:46 +000063 // The inlined code is currently at the end of the function, scan from the
64 // start of the inlined code to its end, checking for stuff we need to
65 // rewrite.
66 if (InlinedCodeInfo.ContainsCalls || InlinedCodeInfo.ContainsUnwinds) {
67 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
68 BB != E; ++BB) {
69 if (InlinedCodeInfo.ContainsCalls) {
70 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ){
71 Instruction *I = BBI++;
Duncan Sandse4267052008-09-05 12:37:12 +000072
Dan Gohmanf17a25c2007-07-18 16:29:46 +000073 // We only need to check for function calls: inlined invoke
74 // instructions require no special handling.
75 if (!isa<CallInst>(I)) continue;
76 CallInst *CI = cast<CallInst>(I);
77
Duncan Sands1c5526c2007-12-17 18:08:19 +000078 // If this call cannot unwind, don't convert it to an invoke.
Duncan Sands7dc19d42007-12-18 09:59:50 +000079 if (CI->doesNotThrow())
Dan Gohmanf17a25c2007-07-18 16:29:46 +000080 continue;
Duncan Sands79d28872007-12-03 20:06:50 +000081
Dan Gohmanf17a25c2007-07-18 16:29:46 +000082 // Convert this function call into an invoke instruction.
83 // First, split the basic block.
84 BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
Duncan Sandse4267052008-09-05 12:37:12 +000085
Dan Gohmanf17a25c2007-07-18 16:29:46 +000086 // Next, create the new invoke instruction, inserting it at the end
87 // of the old basic block.
88 SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
89 InvokeInst *II =
Gabor Greifd6da1d02008-04-06 20:25:17 +000090 InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
91 InvokeArgs.begin(), InvokeArgs.end(),
92 CI->getName(), BB->getTerminator());
Dan Gohmanf17a25c2007-07-18 16:29:46 +000093 II->setCallingConv(CI->getCallingConv());
Devang Pateld222f862008-09-25 21:00:45 +000094 II->setAttributes(CI->getAttributes());
Duncan Sandse4267052008-09-05 12:37:12 +000095
Dan Gohmanf17a25c2007-07-18 16:29:46 +000096 // Make sure that anything using the call now uses the invoke!
97 CI->replaceAllUsesWith(II);
Duncan Sandse4267052008-09-05 12:37:12 +000098
Devang Patel41f6b202009-03-31 17:36:12 +000099 // Update the callgraph.
100 if (CG) {
101 // We should be able to do this:
102 // (*CG)[Caller]->replaceCallSite(CI, II);
103 // but that fails if the old call site isn't in the call graph,
104 // which, because of LLVM bug 3601, it sometimes isn't.
105 CallGraphNode *CGN = (*CG)[Caller];
106 for (CallGraphNode::iterator NI = CGN->begin(), NE = CGN->end();
107 NI != NE; ++NI) {
108 if (NI->first == CI) {
109 NI->first = II;
110 break;
111 }
112 }
113 }
114
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000115 // Delete the unconditional branch inserted by splitBasicBlock
116 BB->getInstList().pop_back();
117 Split->getInstList().pop_front(); // Delete the original call
Duncan Sandse4267052008-09-05 12:37:12 +0000118
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000119 // Update any PHI nodes in the exceptional block to indicate that
120 // there is now a new entry in them.
121 unsigned i = 0;
122 for (BasicBlock::iterator I = InvokeDest->begin();
123 isa<PHINode>(I); ++I, ++i) {
124 PHINode *PN = cast<PHINode>(I);
125 PN->addIncoming(InvokeDestPHIValues[i], BB);
126 }
Duncan Sandse4267052008-09-05 12:37:12 +0000127
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000128 // This basic block is now complete, start scanning the next one.
129 break;
130 }
131 }
Duncan Sandse4267052008-09-05 12:37:12 +0000132
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000133 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
134 // An UnwindInst requires special handling when it gets inlined into an
135 // invoke site. Once this happens, we know that the unwind would cause
136 // a control transfer to the invoke exception destination, so we can
137 // transform it into a direct branch to the exception destination.
Gabor Greifd6da1d02008-04-06 20:25:17 +0000138 BranchInst::Create(InvokeDest, UI);
Duncan Sandse4267052008-09-05 12:37:12 +0000139
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000140 // Delete the unwind instruction!
Dan Gohmande087372008-06-21 22:08:46 +0000141 UI->eraseFromParent();
Duncan Sandse4267052008-09-05 12:37:12 +0000142
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000143 // Update any PHI nodes in the exceptional block to indicate that
144 // there is now a new entry in them.
145 unsigned i = 0;
146 for (BasicBlock::iterator I = InvokeDest->begin();
147 isa<PHINode>(I); ++I, ++i) {
148 PHINode *PN = cast<PHINode>(I);
149 PN->addIncoming(InvokeDestPHIValues[i], BB);
150 }
151 }
152 }
153 }
154
155 // Now that everything is happy, we have one final detail. The PHI nodes in
156 // the exception destination block still have entries due to the original
157 // invoke instruction. Eliminate these entries (which might even delete the
158 // PHI node) now.
159 InvokeDest->removePredecessor(II->getParent());
160}
161
162/// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
163/// into the caller, update the specified callgraph to reflect the changes we
164/// made. Note that it's possible that not all code was copied over, so only
Duncan Sands104431b2008-09-08 11:05:51 +0000165/// some edges of the callgraph may remain.
166static void UpdateCallGraphAfterInlining(CallSite CS,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000167 Function::iterator FirstNewBlock,
168 DenseMap<const Value*, Value*> &ValueMap,
169 CallGraph &CG) {
Duncan Sands104431b2008-09-08 11:05:51 +0000170 const Function *Caller = CS.getInstruction()->getParent()->getParent();
171 const Function *Callee = CS.getCalledFunction();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000172 CallGraphNode *CalleeNode = CG[Callee];
173 CallGraphNode *CallerNode = CG[Caller];
Duncan Sandse4267052008-09-05 12:37:12 +0000174
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000175 // Since we inlined some uninlined call sites in the callee into the caller,
176 // add edges from the caller to all of the callees of the callee.
Gabor Greif17bb9c02009-01-15 18:40:09 +0000177 CallGraphNode::iterator I = CalleeNode->begin(), E = CalleeNode->end();
178
179 // Consider the case where CalleeNode == CallerNode.
Gabor Greif17abaf22009-01-17 00:09:08 +0000180 CallGraphNode::CalledFunctionsVector CallCache;
Gabor Greif17bb9c02009-01-15 18:40:09 +0000181 if (CalleeNode == CallerNode) {
182 CallCache.assign(I, E);
183 I = CallCache.begin();
184 E = CallCache.end();
185 }
186
187 for (; I != E; ++I) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000188 const Instruction *OrigCall = I->first.getInstruction();
Duncan Sandse4267052008-09-05 12:37:12 +0000189
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000190 DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
191 // Only copy the edge if the call was inlined!
192 if (VMI != ValueMap.end() && VMI->second) {
193 // If the call was inlined, but then constant folded, there is no edge to
194 // add. Check for this case.
195 if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
196 CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
197 }
198 }
Dale Johannesenfa75abe2009-01-13 22:43:37 +0000199 // Update the call graph by deleting the edge from Callee to Caller. We must
200 // do this after the loop above in case Caller and Callee are the same.
201 CallerNode->removeCallEdgeFor(CS);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000202}
203
Devang Patel41f60452009-04-15 00:17:06 +0000204/// findFnRegionEndMarker - This is a utility routine that is used by
205/// InlineFunction. Return llvm.dbg.region.end intrinsic that corresponds
206/// to the llvm.dbg.func.start of the function F. Otherwise return NULL.
207static const DbgRegionEndInst *findFnRegionEndMarker(const Function *F) {
208
209 GlobalVariable *FnStart = NULL;
210 const DbgRegionEndInst *FnEnd = NULL;
211 for (Function::const_iterator FI = F->begin(), FE =F->end(); FI != FE; ++FI)
212 for (BasicBlock::const_iterator BI = FI->begin(), BE = FI->end(); BI != BE;
213 ++BI) {
214 if (FnStart == NULL) {
215 if (const DbgFuncStartInst *FSI = dyn_cast<DbgFuncStartInst>(BI)) {
216 DISubprogram SP(cast<GlobalVariable>(FSI->getSubprogram()));
217 assert (SP.isNull() == false && "Invalid llvm.dbg.func.start");
218 if (SP.describes(F))
219 FnStart = SP.getGV();
220 }
221 } else {
222 if (const DbgRegionEndInst *REI = dyn_cast<DbgRegionEndInst>(BI))
223 if (REI->getContext() == FnStart)
224 FnEnd = REI;
225 }
226 }
227 return FnEnd;
228}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000229
230// InlineFunction - This function inlines the called function into the basic
231// block of the caller. This returns false if it is not possible to inline this
232// call. The program is still in a well defined state if this occurs though.
233//
234// Note that this only does one level of inlining. For example, if the
235// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
236// exists in the instruction stream. Similiarly this will inline a recursive
237// function by one level.
238//
239bool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD) {
240 Instruction *TheCall = CS.getInstruction();
241 assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
242 "Instruction not in function!");
243
244 const Function *CalledFunc = CS.getCalledFunction();
245 if (CalledFunc == 0 || // Can't inline external function or indirect
246 CalledFunc->isDeclaration() || // call, or call to a vararg function!
247 CalledFunc->getFunctionType()->isVarArg()) return false;
248
249
Chris Lattnered050df2009-02-12 07:06:42 +0000250 // If the call to the callee is not a tail call, we must clear the 'tail'
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000251 // flags on any calls that we inline.
252 bool MustClearTailCallFlags =
Chris Lattnered050df2009-02-12 07:06:42 +0000253 !(isa<CallInst>(TheCall) && cast<CallInst>(TheCall)->isTailCall());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000254
Duncan Sands2937e352007-12-19 21:13:37 +0000255 // If the call to the callee cannot throw, set the 'nounwind' flag on any
256 // calls that we inline.
257 bool MarkNoUnwind = CS.doesNotThrow();
258
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000259 BasicBlock *OrigBB = TheCall->getParent();
260 Function *Caller = OrigBB->getParent();
261
Gordon Henriksena86e9192007-12-25 03:10:07 +0000262 // GC poses two hazards to inlining, which only occur when the callee has GC:
263 // 1. If the caller has no GC, then the callee's GC must be propagated to the
264 // caller.
265 // 2. If the caller has a differing GC, it is invalid to inline.
Gordon Henriksen1aed5992008-08-17 18:44:35 +0000266 if (CalledFunc->hasGC()) {
267 if (!Caller->hasGC())
268 Caller->setGC(CalledFunc->getGC());
269 else if (CalledFunc->getGC() != Caller->getGC())
Gordon Henriksena86e9192007-12-25 03:10:07 +0000270 return false;
271 }
Duncan Sandse4267052008-09-05 12:37:12 +0000272
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000273 // Get an iterator to the last basic block in the function, which will have
274 // the new function inlined after it.
275 //
276 Function::iterator LastBlock = &Caller->back();
277
278 // Make sure to capture all of the return instructions from the cloned
279 // function.
280 std::vector<ReturnInst*> Returns;
281 ClonedCodeInfo InlinedFunctionInfo;
Dale Johannesencceda7e2009-03-04 02:09:48 +0000282 Function::iterator FirstNewBlock;
Duncan Sands2937e352007-12-19 21:13:37 +0000283
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000284 { // Scope to destroy ValueMap after cloning.
285 DenseMap<const Value*, Value*> ValueMap;
286
Dan Gohman2e251372008-06-20 17:11:32 +0000287 assert(CalledFunc->arg_size() == CS.arg_size() &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000288 "No varargs calls can be inlined!");
Duncan Sandse4267052008-09-05 12:37:12 +0000289
Chris Lattner124993a2008-01-11 06:09:30 +0000290 // Calculate the vector of arguments to pass into the function cloner, which
291 // matches up the formal to the actual argument values.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000292 CallSite::arg_iterator AI = CS.arg_begin();
Chris Lattner124993a2008-01-11 06:09:30 +0000293 unsigned ArgNo = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000294 for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
Chris Lattner124993a2008-01-11 06:09:30 +0000295 E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
296 Value *ActualArg = *AI;
Duncan Sandse4267052008-09-05 12:37:12 +0000297
Duncan Sands96ad1262008-01-27 18:12:58 +0000298 // When byval arguments actually inlined, we need to make the copy implied
299 // by them explicit. However, we don't do this if the callee is readonly
300 // or readnone, because the copy would be unneeded: the callee doesn't
301 // modify the struct.
Devang Pateld222f862008-09-25 21:00:45 +0000302 if (CalledFunc->paramHasAttr(ArgNo+1, Attribute::ByVal) &&
Duncan Sands96ad1262008-01-27 18:12:58 +0000303 !CalledFunc->onlyReadsMemory()) {
Chris Lattner124993a2008-01-11 06:09:30 +0000304 const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
305 const Type *VoidPtrTy = PointerType::getUnqual(Type::Int8Ty);
Duncan Sandse4267052008-09-05 12:37:12 +0000306
Chris Lattner124993a2008-01-11 06:09:30 +0000307 // Create the alloca. If we have TargetData, use nice alignment.
308 unsigned Align = 1;
309 if (TD) Align = TD->getPrefTypeAlignment(AggTy);
Duncan Sandse4267052008-09-05 12:37:12 +0000310 Value *NewAlloca = new AllocaInst(AggTy, 0, Align, I->getName(),
Chris Lattner124993a2008-01-11 06:09:30 +0000311 Caller->begin()->begin());
312 // Emit a memcpy.
Chris Lattner82c2e432008-11-21 16:42:48 +0000313 const Type *Tys[] = { Type::Int64Ty };
Chris Lattner124993a2008-01-11 06:09:30 +0000314 Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
Chris Lattner82c2e432008-11-21 16:42:48 +0000315 Intrinsic::memcpy,
316 Tys, 1);
Chris Lattner124993a2008-01-11 06:09:30 +0000317 Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
318 Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
Duncan Sandse4267052008-09-05 12:37:12 +0000319
Chris Lattner124993a2008-01-11 06:09:30 +0000320 Value *Size;
321 if (TD == 0)
322 Size = ConstantExpr::getSizeOf(AggTy);
323 else
324 Size = ConstantInt::get(Type::Int64Ty, TD->getTypeStoreSize(AggTy));
Duncan Sandse4267052008-09-05 12:37:12 +0000325
Chris Lattner124993a2008-01-11 06:09:30 +0000326 // Always generate a memcpy of alignment 1 here because we don't know
327 // the alignment of the src pointer. Other optimizations can infer
328 // better alignment.
329 Value *CallArgs[] = {
330 DestCast, SrcCast, Size, ConstantInt::get(Type::Int32Ty, 1)
331 };
332 CallInst *TheMemCpy =
Gabor Greifd6da1d02008-04-06 20:25:17 +0000333 CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
Duncan Sandse4267052008-09-05 12:37:12 +0000334
Chris Lattner124993a2008-01-11 06:09:30 +0000335 // If we have a call graph, update it.
336 if (CG) {
337 CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
338 CallGraphNode *CallerNode = (*CG)[Caller];
339 CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
340 }
Duncan Sandse4267052008-09-05 12:37:12 +0000341
Chris Lattner124993a2008-01-11 06:09:30 +0000342 // Uses of the argument in the function should use our new alloca
343 // instead.
344 ActualArg = NewAlloca;
345 }
Duncan Sandse4267052008-09-05 12:37:12 +0000346
Chris Lattner124993a2008-01-11 06:09:30 +0000347 ValueMap[I] = ActualArg;
348 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000349
Devang Patel41f60452009-04-15 00:17:06 +0000350 // Adjust llvm.dbg.region.end. If the CalledFunc has region end
351 // marker then clone that marker after next stop point at the
352 // call site. The function body cloner does not clone original
353 // region end marker from the CalledFunc. This will ensure that
354 // inlined function's scope ends at the right place.
355 const DbgRegionEndInst *DREI = findFnRegionEndMarker(CalledFunc);
356 if (DREI) {
357 for (BasicBlock::iterator BI = TheCall,
358 BE = TheCall->getParent()->end(); BI != BE; ++BI) {
359 if (DbgStopPointInst *DSPI = dyn_cast<DbgStopPointInst>(BI)) {
360 if (DbgRegionEndInst *NewDREI =
361 dyn_cast<DbgRegionEndInst>(DREI->clone()))
362 NewDREI->insertAfter(DSPI);
363 break;
364 }
365 }
366 }
367
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000368 // We want the inliner to prune the code as it copies. We would LOVE to
369 // have no dead or constant instructions leftover after inlining occurs
370 // (which can happen, e.g., because an argument was constant), but we'll be
371 // happy with whatever the cloner can do.
372 CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
373 &InlinedFunctionInfo, TD);
Duncan Sandse4267052008-09-05 12:37:12 +0000374
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000375 // Remember the first block that is newly cloned over.
376 FirstNewBlock = LastBlock; ++FirstNewBlock;
Duncan Sandse4267052008-09-05 12:37:12 +0000377
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000378 // Update the callgraph if requested.
379 if (CG)
Duncan Sands104431b2008-09-08 11:05:51 +0000380 UpdateCallGraphAfterInlining(CS, FirstNewBlock, ValueMap, *CG);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000381 }
Duncan Sandse4267052008-09-05 12:37:12 +0000382
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000383 // If there are any alloca instructions in the block that used to be the entry
384 // block for the callee, move them to the entry block of the caller. First
385 // calculate which instruction they should be inserted before. We insert the
386 // instructions at the end of the current alloca list.
387 //
388 {
389 BasicBlock::iterator InsertPoint = Caller->begin()->begin();
390 for (BasicBlock::iterator I = FirstNewBlock->begin(),
391 E = FirstNewBlock->end(); I != E; )
392 if (AllocaInst *AI = dyn_cast<AllocaInst>(I++)) {
393 // If the alloca is now dead, remove it. This often occurs due to code
394 // specialization.
395 if (AI->use_empty()) {
396 AI->eraseFromParent();
397 continue;
398 }
Duncan Sandse4267052008-09-05 12:37:12 +0000399
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000400 if (isa<Constant>(AI->getArraySize())) {
401 // Scan for the block of allocas that we can move over, and move them
402 // all at once.
403 while (isa<AllocaInst>(I) &&
404 isa<Constant>(cast<AllocaInst>(I)->getArraySize()))
405 ++I;
406
407 // Transfer all of the allocas over in a block. Using splice means
408 // that the instructions aren't removed from the symbol table, then
409 // reinserted.
410 Caller->getEntryBlock().getInstList().splice(
411 InsertPoint,
412 FirstNewBlock->getInstList(),
413 AI, I);
414 }
415 }
416 }
417
418 // If the inlined code contained dynamic alloca instructions, wrap the inlined
419 // code with llvm.stacksave/llvm.stackrestore intrinsics.
420 if (InlinedFunctionInfo.ContainsDynamicAllocas) {
421 Module *M = Caller->getParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000422 // Get the two intrinsics we care about.
423 Constant *StackSave, *StackRestore;
Duncan Sands17836442008-04-07 13:43:58 +0000424 StackSave = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
425 StackRestore = Intrinsic::getDeclaration(M, Intrinsic::stackrestore);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000426
427 // If we are preserving the callgraph, add edges to the stacksave/restore
428 // functions for the calls we insert.
429 CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
430 if (CG) {
431 // We know that StackSave/StackRestore are Function*'s, because they are
432 // intrinsics which must have the right types.
433 StackSaveCGN = CG->getOrInsertFunction(cast<Function>(StackSave));
434 StackRestoreCGN = CG->getOrInsertFunction(cast<Function>(StackRestore));
435 CallerNode = (*CG)[Caller];
436 }
Duncan Sandse4267052008-09-05 12:37:12 +0000437
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000438 // Insert the llvm.stacksave.
Duncan Sandse4267052008-09-05 12:37:12 +0000439 CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
Gabor Greifd6da1d02008-04-06 20:25:17 +0000440 FirstNewBlock->begin());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000441 if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
Duncan Sandse4267052008-09-05 12:37:12 +0000442
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000443 // Insert a call to llvm.stackrestore before any return instructions in the
444 // inlined function.
445 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
Gabor Greifd6da1d02008-04-06 20:25:17 +0000446 CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000447 if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
448 }
449
450 // Count the number of StackRestore calls we insert.
451 unsigned NumStackRestores = Returns.size();
Duncan Sandse4267052008-09-05 12:37:12 +0000452
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000453 // If we are inlining an invoke instruction, insert restores before each
454 // unwind. These unwinds will be rewritten into branches later.
455 if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
456 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
457 BB != E; ++BB)
458 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Duncan Sands17836442008-04-07 13:43:58 +0000459 CallInst::Create(StackRestore, SavedPtr, "", UI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000460 ++NumStackRestores;
461 }
462 }
463 }
464
Duncan Sandse4267052008-09-05 12:37:12 +0000465 // If we are inlining tail call instruction through a call site that isn't
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000466 // marked 'tail', we must remove the tail marker for any calls in the inlined
Duncan Sands2937e352007-12-19 21:13:37 +0000467 // code. Also, calls inlined through a 'nounwind' call site should be marked
468 // 'nounwind'.
469 if (InlinedFunctionInfo.ContainsCalls &&
470 (MustClearTailCallFlags || MarkNoUnwind)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000471 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
472 BB != E; ++BB)
473 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sands2937e352007-12-19 21:13:37 +0000474 if (CallInst *CI = dyn_cast<CallInst>(I)) {
475 if (MustClearTailCallFlags)
476 CI->setTailCall(false);
477 if (MarkNoUnwind)
478 CI->setDoesNotThrow();
479 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000480 }
481
Duncan Sands2937e352007-12-19 21:13:37 +0000482 // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
483 // instructions are unreachable.
484 if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
485 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
486 BB != E; ++BB) {
487 TerminatorInst *Term = BB->getTerminator();
488 if (isa<UnwindInst>(Term)) {
489 new UnreachableInst(Term);
490 BB->getInstList().erase(Term);
491 }
492 }
493
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000494 // If we are inlining for an invoke instruction, we must make sure to rewrite
495 // any inlined 'unwind' instructions into branches to the invoke exception
496 // destination, and call instructions into invoke instructions.
497 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Devang Patel41f6b202009-03-31 17:36:12 +0000498 HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo, CG);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000499
500 // If we cloned in _exactly one_ basic block, and if that block ends in a
501 // return instruction, we splice the body of the inlined callee directly into
502 // the calling basic block.
503 if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
504 // Move all of the instructions right before the call.
505 OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
506 FirstNewBlock->begin(), FirstNewBlock->end());
507 // Remove the cloned basic block.
508 Caller->getBasicBlockList().pop_back();
509
510 // If the call site was an invoke instruction, add a branch to the normal
511 // destination.
512 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Gabor Greifd6da1d02008-04-06 20:25:17 +0000513 BranchInst::Create(II->getNormalDest(), TheCall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000514
515 // If the return instruction returned a value, replace uses of the call with
516 // uses of the returned value.
Devang Patelbd4e13d2008-03-04 21:15:15 +0000517 if (!TheCall->use_empty()) {
518 ReturnInst *R = Returns[0];
Dan Gohman29474e92008-07-23 00:34:11 +0000519 TheCall->replaceAllUsesWith(R->getReturnValue());
Devang Patelbd4e13d2008-03-04 21:15:15 +0000520 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000521 // Since we are now done with the Call/Invoke, we can delete it.
Dan Gohmande087372008-06-21 22:08:46 +0000522 TheCall->eraseFromParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000523
524 // Since we are now done with the return instruction, delete it also.
Dan Gohmande087372008-06-21 22:08:46 +0000525 Returns[0]->eraseFromParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000526
527 // We are now done with the inlining.
528 return true;
529 }
530
531 // Otherwise, we have the normal case, of more than one block to inline or
532 // multiple return sites.
533
534 // We want to clone the entire callee function into the hole between the
535 // "starter" and "ender" blocks. How we accomplish this depends on whether
536 // this is an invoke instruction or a call instruction.
537 BasicBlock *AfterCallBB;
538 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
539
540 // Add an unconditional branch to make this look like the CallInst case...
Gabor Greifd6da1d02008-04-06 20:25:17 +0000541 BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000542
543 // Split the basic block. This guarantees that no PHI nodes will have to be
544 // updated due to new incoming edges, and make the invoke case more
545 // symmetric to the call case.
546 AfterCallBB = OrigBB->splitBasicBlock(NewBr,
547 CalledFunc->getName()+".exit");
548
549 } else { // It's a call
550 // If this is a call instruction, we need to split the basic block that
551 // the call lives in.
552 //
553 AfterCallBB = OrigBB->splitBasicBlock(TheCall,
554 CalledFunc->getName()+".exit");
555 }
556
557 // Change the branch that used to go to AfterCallBB to branch to the first
558 // basic block of the inlined function.
559 //
560 TerminatorInst *Br = OrigBB->getTerminator();
561 assert(Br && Br->getOpcode() == Instruction::Br &&
562 "splitBasicBlock broken!");
563 Br->setOperand(0, FirstNewBlock);
564
565
566 // Now that the function is correct, make it a little bit nicer. In
567 // particular, move the basic blocks inserted from the end of the function
568 // into the space made by splitting the source basic block.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000569 Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
570 FirstNewBlock, Caller->end());
571
572 // Handle all of the return instructions that we just cloned in, and eliminate
573 // any users of the original call/invoke instruction.
Devang Patel59b4bc32008-03-10 18:34:00 +0000574 const Type *RTy = CalledFunc->getReturnType();
Dan Gohmanadf79782008-06-20 01:03:44 +0000575
Dan Gohman29474e92008-07-23 00:34:11 +0000576 if (Returns.size() > 1) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000577 // The PHI node should go at the front of the new basic block to merge all
578 // possible incoming values.
Dan Gohman29474e92008-07-23 00:34:11 +0000579 PHINode *PHI = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000580 if (!TheCall->use_empty()) {
Dan Gohman29474e92008-07-23 00:34:11 +0000581 PHI = PHINode::Create(RTy, TheCall->getName(),
582 AfterCallBB->begin());
583 // Anything that used the result of the function call should now use the
584 // PHI node as their operand.
Duncan Sandse4267052008-09-05 12:37:12 +0000585 TheCall->replaceAllUsesWith(PHI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000586 }
587
Gabor Greif17bb9c02009-01-15 18:40:09 +0000588 // Loop over all of the return instructions adding entries to the PHI node
589 // as appropriate.
Dan Gohman29474e92008-07-23 00:34:11 +0000590 if (PHI) {
591 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
592 ReturnInst *RI = Returns[i];
593 assert(RI->getReturnValue()->getType() == PHI->getType() &&
594 "Ret value not consistent in function!");
595 PHI->addIncoming(RI->getReturnValue(), RI->getParent());
Devang Patelfed04412008-03-07 20:06:16 +0000596 }
597 }
598
Gabor Greifdeb65942009-01-16 23:08:50 +0000599 // Add a branch to the merge points and remove return instructions.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000600 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
601 ReturnInst *RI = Returns[i];
Dale Johannesencceda7e2009-03-04 02:09:48 +0000602 BranchInst::Create(AfterCallBB, RI);
Devang Patel59b4bc32008-03-10 18:34:00 +0000603 RI->eraseFromParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000604 }
Devang Patel59b4bc32008-03-10 18:34:00 +0000605 } else if (!Returns.empty()) {
606 // Otherwise, if there is exactly one return value, just replace anything
607 // using the return value of the call with the computed value.
608 if (!TheCall->use_empty())
609 TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
Duncan Sandse4267052008-09-05 12:37:12 +0000610
Devang Patel59b4bc32008-03-10 18:34:00 +0000611 // Splice the code from the return block into the block that it will return
612 // to, which contains the code that was after the call.
613 BasicBlock *ReturnBB = Returns[0]->getParent();
614 AfterCallBB->getInstList().splice(AfterCallBB->begin(),
615 ReturnBB->getInstList());
Duncan Sandse4267052008-09-05 12:37:12 +0000616
Devang Patel59b4bc32008-03-10 18:34:00 +0000617 // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
618 ReturnBB->replaceAllUsesWith(AfterCallBB);
Duncan Sandse4267052008-09-05 12:37:12 +0000619
Devang Patel59b4bc32008-03-10 18:34:00 +0000620 // Delete the return instruction now and empty ReturnBB now.
621 Returns[0]->eraseFromParent();
622 ReturnBB->eraseFromParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000623 } else if (!TheCall->use_empty()) {
624 // No returns, but something is using the return value of the call. Just
625 // nuke the result.
626 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
627 }
628
629 // Since we are now done with the Call/Invoke, we can delete it.
630 TheCall->eraseFromParent();
631
632 // We should always be able to fold the entry block of the function into the
633 // single predecessor of the block...
634 assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
635 BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
636
637 // Splice the code entry block into calling block, right before the
638 // unconditional branch.
639 OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
640 CalleeEntry->replaceAllUsesWith(OrigBB); // Update PHI nodes
641
642 // Remove the unconditional branch.
643 OrigBB->getInstList().erase(Br);
644
645 // Now we can remove the CalleeEntry block, which is now empty.
646 Caller->getBasicBlockList().erase(CalleeEntry);
Duncan Sandse4267052008-09-05 12:37:12 +0000647
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000648 return true;
649}