blob: 22dab6984654906228a828e2c374c90632e6c2e1 [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"
Chris Lattnerc93adca2008-01-11 06:09:30 +000021#include "llvm/ParameterAttributes.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///
40/// II is the invoke instruction begin inlined. FirstNewBlock is the first
41/// 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,
44 ClonedCodeInfo &InlinedCodeInfo) {
45 BasicBlock *InvokeDest = II->getUnwindDest();
46 std::vector<Value*> InvokeDestPHIValues;
47
48 // If there are PHI nodes in the unwind destination block, we need to
49 // keep track of which values came into them from this invoke, then remove
50 // the entry for this block.
51 BasicBlock *InvokeBlock = II->getParent();
52 for (BasicBlock::iterator I = InvokeDest->begin(); isa<PHINode>(I); ++I) {
53 PHINode *PN = cast<PHINode>(I);
54 // Save the value to use for this edge.
55 InvokeDestPHIValues.push_back(PN->getIncomingValueForBlock(InvokeBlock));
56 }
57
58 Function *Caller = FirstNewBlock->getParent();
59
60 // The inlined code is currently at the end of the function, scan from the
61 // start of the inlined code to its end, checking for stuff we need to
62 // rewrite.
Chris Lattner727d1dd2006-01-13 19:15:15 +000063 if (InlinedCodeInfo.ContainsCalls || InlinedCodeInfo.ContainsUnwinds) {
64 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
65 BB != E; ++BB) {
66 if (InlinedCodeInfo.ContainsCalls) {
67 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E; ){
68 Instruction *I = BBI++;
69
70 // We only need to check for function calls: inlined invoke
71 // instructions require no special handling.
72 if (!isa<CallInst>(I)) continue;
73 CallInst *CI = cast<CallInst>(I);
Chris Lattnercd4d3392006-01-13 19:05:59 +000074
Duncan Sandsfd7b3262007-12-17 18:08:19 +000075 // If this call cannot unwind, don't convert it to an invoke.
Duncan Sands2b0e8992007-12-18 09:59:50 +000076 if (CI->doesNotThrow())
Chris Lattner727d1dd2006-01-13 19:15:15 +000077 continue;
Duncan Sandsa3355ff2007-12-03 20:06:50 +000078
Chris Lattner727d1dd2006-01-13 19:15:15 +000079 // Convert this function call into an invoke instruction.
80 // First, split the basic block.
81 BasicBlock *Split = BB->splitBasicBlock(CI, CI->getName()+".noexc");
82
83 // Next, create the new invoke instruction, inserting it at the end
84 // of the old basic block.
Chris Lattner93e985f2007-02-13 02:10:56 +000085 SmallVector<Value*, 8> InvokeArgs(CI->op_begin()+1, CI->op_end());
Chris Lattner727d1dd2006-01-13 19:15:15 +000086 InvokeInst *II =
Gabor Greif051a9502008-04-06 20:25:17 +000087 InvokeInst::Create(CI->getCalledValue(), Split, InvokeDest,
88 InvokeArgs.begin(), InvokeArgs.end(),
89 CI->getName(), BB->getTerminator());
Chris Lattner727d1dd2006-01-13 19:15:15 +000090 II->setCallingConv(CI->getCallingConv());
Duncan Sandsdc024672007-11-27 13:23:08 +000091 II->setParamAttrs(CI->getParamAttrs());
Chris Lattner727d1dd2006-01-13 19:15:15 +000092
93 // Make sure that anything using the call now uses the invoke!
94 CI->replaceAllUsesWith(II);
95
96 // Delete the unconditional branch inserted by splitBasicBlock
97 BB->getInstList().pop_back();
98 Split->getInstList().pop_front(); // Delete the original call
99
100 // Update any PHI nodes in the exceptional block to indicate that
101 // there is now a new entry in them.
102 unsigned i = 0;
103 for (BasicBlock::iterator I = InvokeDest->begin();
104 isa<PHINode>(I); ++I, ++i) {
105 PHINode *PN = cast<PHINode>(I);
106 PN->addIncoming(InvokeDestPHIValues[i], BB);
107 }
108
109 // This basic block is now complete, start scanning the next one.
110 break;
111 }
Chris Lattnercd4d3392006-01-13 19:05:59 +0000112 }
Chris Lattner727d1dd2006-01-13 19:15:15 +0000113
114 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
115 // An UnwindInst requires special handling when it gets inlined into an
116 // invoke site. Once this happens, we know that the unwind would cause
117 // a control transfer to the invoke exception destination, so we can
118 // transform it into a direct branch to the exception destination.
Gabor Greif051a9502008-04-06 20:25:17 +0000119 BranchInst::Create(InvokeDest, UI);
Chris Lattnercd4d3392006-01-13 19:05:59 +0000120
Chris Lattner727d1dd2006-01-13 19:15:15 +0000121 // Delete the unwind instruction!
Dan Gohman1adec832008-06-21 22:08:46 +0000122 UI->eraseFromParent();
Chris Lattner727d1dd2006-01-13 19:15:15 +0000123
124 // Update any PHI nodes in the exceptional block to indicate that
125 // there is now a new entry in them.
126 unsigned i = 0;
127 for (BasicBlock::iterator I = InvokeDest->begin();
128 isa<PHINode>(I); ++I, ++i) {
129 PHINode *PN = cast<PHINode>(I);
130 PN->addIncoming(InvokeDestPHIValues[i], BB);
131 }
Chris Lattnercd4d3392006-01-13 19:05:59 +0000132 }
133 }
134 }
135
136 // Now that everything is happy, we have one final detail. The PHI nodes in
137 // the exception destination block still have entries due to the original
138 // invoke instruction. Eliminate these entries (which might even delete the
139 // PHI node) now.
140 InvokeDest->removePredecessor(II->getParent());
141}
142
Chris Lattnerd85340f2006-07-12 18:29:36 +0000143/// UpdateCallGraphAfterInlining - Once we have cloned code over from a callee
144/// into the caller, update the specified callgraph to reflect the changes we
145/// made. Note that it's possible that not all code was copied over, so only
146/// some edges of the callgraph will be remain.
147static void UpdateCallGraphAfterInlining(const Function *Caller,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000148 const Function *Callee,
Chris Lattnerd85340f2006-07-12 18:29:36 +0000149 Function::iterator FirstNewBlock,
Chris Lattner5e665f52007-02-03 00:08:31 +0000150 DenseMap<const Value*, Value*> &ValueMap,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000151 CallGraph &CG) {
152 // Update the call graph by deleting the edge from Callee to Caller
153 CallGraphNode *CalleeNode = CG[Callee];
154 CallGraphNode *CallerNode = CG[Caller];
155 CallerNode->removeCallEdgeTo(CalleeNode);
156
Chris Lattnerd85340f2006-07-12 18:29:36 +0000157 // Since we inlined some uninlined call sites in the callee into the caller,
Chris Lattner468fb1d2006-01-14 20:07:50 +0000158 // add edges from the caller to all of the callees of the callee.
159 for (CallGraphNode::iterator I = CalleeNode->begin(),
Chris Lattnerd85340f2006-07-12 18:29:36 +0000160 E = CalleeNode->end(); I != E; ++I) {
161 const Instruction *OrigCall = I->first.getInstruction();
162
Chris Lattner5e665f52007-02-03 00:08:31 +0000163 DenseMap<const Value*, Value*>::iterator VMI = ValueMap.find(OrigCall);
Chris Lattner981418b2006-07-12 21:37:11 +0000164 // Only copy the edge if the call was inlined!
165 if (VMI != ValueMap.end() && VMI->second) {
Chris Lattner1bb3a402006-07-12 18:37:18 +0000166 // If the call was inlined, but then constant folded, there is no edge to
167 // add. Check for this case.
168 if (Instruction *NewCall = dyn_cast<Instruction>(VMI->second))
169 CallerNode->addCalledFunction(CallSite::get(NewCall), I->second);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000170 }
171 }
Chris Lattner468fb1d2006-01-14 20:07:50 +0000172}
173
Chris Lattnercd4d3392006-01-13 19:05:59 +0000174
Chris Lattnerca398dc2003-05-29 15:11:31 +0000175// InlineFunction - This function inlines the called function into the basic
176// block of the caller. This returns false if it is not possible to inline this
177// call. The program is still in a well defined state if this occurs though.
178//
Misha Brukmanfd939082005-04-21 23:48:37 +0000179// Note that this only does one level of inlining. For example, if the
180// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
Chris Lattnerca398dc2003-05-29 15:11:31 +0000181// exists in the instruction stream. Similiarly this will inline a recursive
182// function by one level.
183//
Chris Lattner1dfdf822007-01-30 23:22:39 +0000184bool llvm::InlineFunction(CallSite CS, CallGraph *CG, const TargetData *TD) {
Chris Lattner80a38d22003-08-24 06:59:16 +0000185 Instruction *TheCall = CS.getInstruction();
186 assert(TheCall->getParent() && TheCall->getParent()->getParent() &&
187 "Instruction not in function!");
Chris Lattnerca398dc2003-05-29 15:11:31 +0000188
Chris Lattner80a38d22003-08-24 06:59:16 +0000189 const Function *CalledFunc = CS.getCalledFunction();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000190 if (CalledFunc == 0 || // Can't inline external function or indirect
Reid Spencer5cbf9852007-01-30 20:08:39 +0000191 CalledFunc->isDeclaration() || // call, or call to a vararg function!
Chris Lattnerca398dc2003-05-29 15:11:31 +0000192 CalledFunc->getFunctionType()->isVarArg()) return false;
193
Chris Lattner1b491412005-05-06 06:47:52 +0000194
195 // If the call to the callee is a non-tail call, we must clear the 'tail'
196 // flags on any calls that we inline.
197 bool MustClearTailCallFlags =
Chris Lattner3799ed82005-05-06 17:13:16 +0000198 isa<CallInst>(TheCall) && !cast<CallInst>(TheCall)->isTailCall();
Chris Lattner1b491412005-05-06 06:47:52 +0000199
Duncan Sandsf0c33542007-12-19 21:13:37 +0000200 // If the call to the callee cannot throw, set the 'nounwind' flag on any
201 // calls that we inline.
202 bool MarkNoUnwind = CS.doesNotThrow();
203
Chris Lattner80a38d22003-08-24 06:59:16 +0000204 BasicBlock *OrigBB = TheCall->getParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000205 Function *Caller = OrigBB->getParent();
206
Gordon Henriksen0e138212007-12-25 03:10:07 +0000207 // GC poses two hazards to inlining, which only occur when the callee has GC:
208 // 1. If the caller has no GC, then the callee's GC must be propagated to the
209 // caller.
210 // 2. If the caller has a differing GC, it is invalid to inline.
211 if (CalledFunc->hasCollector()) {
212 if (!Caller->hasCollector())
213 Caller->setCollector(CalledFunc->getCollector());
214 else if (CalledFunc->getCollector() != Caller->getCollector())
215 return false;
216 }
217
Chris Lattner5052c912004-02-04 01:41:09 +0000218 // Get an iterator to the last basic block in the function, which will have
219 // the new function inlined after it.
220 //
221 Function::iterator LastBlock = &Caller->back();
222
Chris Lattner5e923de2004-02-04 02:51:48 +0000223 // Make sure to capture all of the return instructions from the cloned
Chris Lattnerca398dc2003-05-29 15:11:31 +0000224 // function.
Chris Lattner5e923de2004-02-04 02:51:48 +0000225 std::vector<ReturnInst*> Returns;
Chris Lattnercd4d3392006-01-13 19:05:59 +0000226 ClonedCodeInfo InlinedFunctionInfo;
Chris Lattnerd85340f2006-07-12 18:29:36 +0000227 Function::iterator FirstNewBlock;
Duncan Sandsf0c33542007-12-19 21:13:37 +0000228
Chris Lattner5e923de2004-02-04 02:51:48 +0000229 { // Scope to destroy ValueMap after cloning.
Chris Lattner5e665f52007-02-03 00:08:31 +0000230 DenseMap<const Value*, Value*> ValueMap;
Chris Lattner5b5bc302006-05-27 01:28:04 +0000231
Dan Gohman9614fcc2008-06-20 17:11:32 +0000232 assert(CalledFunc->arg_size() == CS.arg_size() &&
Chris Lattner5e923de2004-02-04 02:51:48 +0000233 "No varargs calls can be inlined!");
Chris Lattnerc93adca2008-01-11 06:09:30 +0000234
235 // Calculate the vector of arguments to pass into the function cloner, which
236 // matches up the formal to the actual argument values.
Chris Lattner5e923de2004-02-04 02:51:48 +0000237 CallSite::arg_iterator AI = CS.arg_begin();
Chris Lattnerc93adca2008-01-11 06:09:30 +0000238 unsigned ArgNo = 0;
Chris Lattnere4d5c442005-03-15 04:54:21 +0000239 for (Function::const_arg_iterator I = CalledFunc->arg_begin(),
Chris Lattnerc93adca2008-01-11 06:09:30 +0000240 E = CalledFunc->arg_end(); I != E; ++I, ++AI, ++ArgNo) {
241 Value *ActualArg = *AI;
242
Duncan Sandsd82375c2008-01-27 18:12:58 +0000243 // When byval arguments actually inlined, we need to make the copy implied
244 // by them explicit. However, we don't do this if the callee is readonly
245 // or readnone, because the copy would be unneeded: the callee doesn't
246 // modify the struct.
247 if (CalledFunc->paramHasAttr(ArgNo+1, ParamAttr::ByVal) &&
248 !CalledFunc->onlyReadsMemory()) {
Chris Lattnerc93adca2008-01-11 06:09:30 +0000249 const Type *AggTy = cast<PointerType>(I->getType())->getElementType();
250 const Type *VoidPtrTy = PointerType::getUnqual(Type::Int8Ty);
251
252 // Create the alloca. If we have TargetData, use nice alignment.
253 unsigned Align = 1;
254 if (TD) Align = TD->getPrefTypeAlignment(AggTy);
255 Value *NewAlloca = new AllocaInst(AggTy, 0, Align, I->getName(),
256 Caller->begin()->begin());
257 // Emit a memcpy.
258 Function *MemCpyFn = Intrinsic::getDeclaration(Caller->getParent(),
259 Intrinsic::memcpy_i64);
260 Value *DestCast = new BitCastInst(NewAlloca, VoidPtrTy, "tmp", TheCall);
261 Value *SrcCast = new BitCastInst(*AI, VoidPtrTy, "tmp", TheCall);
262
263 Value *Size;
264 if (TD == 0)
265 Size = ConstantExpr::getSizeOf(AggTy);
266 else
267 Size = ConstantInt::get(Type::Int64Ty, TD->getTypeStoreSize(AggTy));
268
269 // Always generate a memcpy of alignment 1 here because we don't know
270 // the alignment of the src pointer. Other optimizations can infer
271 // better alignment.
272 Value *CallArgs[] = {
273 DestCast, SrcCast, Size, ConstantInt::get(Type::Int32Ty, 1)
274 };
275 CallInst *TheMemCpy =
Gabor Greif051a9502008-04-06 20:25:17 +0000276 CallInst::Create(MemCpyFn, CallArgs, CallArgs+4, "", TheCall);
Chris Lattnerc93adca2008-01-11 06:09:30 +0000277
278 // If we have a call graph, update it.
279 if (CG) {
280 CallGraphNode *MemCpyCGN = CG->getOrInsertFunction(MemCpyFn);
281 CallGraphNode *CallerNode = (*CG)[Caller];
282 CallerNode->addCalledFunction(TheMemCpy, MemCpyCGN);
283 }
284
285 // Uses of the argument in the function should use our new alloca
286 // instead.
287 ActualArg = NewAlloca;
288 }
289
290 ValueMap[I] = ActualArg;
291 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000292
Chris Lattner5b5bc302006-05-27 01:28:04 +0000293 // We want the inliner to prune the code as it copies. We would LOVE to
294 // have no dead or constant instructions leftover after inlining occurs
295 // (which can happen, e.g., because an argument was constant), but we'll be
296 // happy with whatever the cloner can do.
297 CloneAndPruneFunctionInto(Caller, CalledFunc, ValueMap, Returns, ".i",
Chris Lattner1dfdf822007-01-30 23:22:39 +0000298 &InlinedFunctionInfo, TD);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000299
300 // Remember the first block that is newly cloned over.
301 FirstNewBlock = LastBlock; ++FirstNewBlock;
302
303 // Update the callgraph if requested.
304 if (CG)
305 UpdateCallGraphAfterInlining(Caller, CalledFunc, FirstNewBlock, ValueMap,
306 *CG);
Misha Brukmanfd939082005-04-21 23:48:37 +0000307 }
Chris Lattnerd85340f2006-07-12 18:29:36 +0000308
Chris Lattnerca398dc2003-05-29 15:11:31 +0000309 // If there are any alloca instructions in the block that used to be the entry
310 // block for the callee, move them to the entry block of the caller. First
311 // calculate which instruction they should be inserted before. We insert the
312 // instructions at the end of the current alloca list.
313 //
Chris Lattner21f20552006-01-13 18:16:48 +0000314 {
Chris Lattner80a38d22003-08-24 06:59:16 +0000315 BasicBlock::iterator InsertPoint = Caller->begin()->begin();
Chris Lattner5e923de2004-02-04 02:51:48 +0000316 for (BasicBlock::iterator I = FirstNewBlock->begin(),
317 E = FirstNewBlock->end(); I != E; )
Chris Lattner33bb3c82006-09-13 19:23:57 +0000318 if (AllocaInst *AI = dyn_cast<AllocaInst>(I++)) {
319 // If the alloca is now dead, remove it. This often occurs due to code
320 // specialization.
321 if (AI->use_empty()) {
322 AI->eraseFromParent();
323 continue;
324 }
325
Chris Lattnerf775f952003-10-14 01:11:07 +0000326 if (isa<Constant>(AI->getArraySize())) {
Chris Lattner21f20552006-01-13 18:16:48 +0000327 // Scan for the block of allocas that we can move over, and move them
328 // all at once.
Chris Lattnerc1df7e12004-02-04 21:33:42 +0000329 while (isa<AllocaInst>(I) &&
330 isa<Constant>(cast<AllocaInst>(I)->getArraySize()))
331 ++I;
332
333 // Transfer all of the allocas over in a block. Using splice means
Dan Gohmane26bff22007-02-20 20:52:03 +0000334 // that the instructions aren't removed from the symbol table, then
Chris Lattnerc1df7e12004-02-04 21:33:42 +0000335 // reinserted.
Dan Gohmanecb7a772007-03-22 16:38:57 +0000336 Caller->getEntryBlock().getInstList().splice(
337 InsertPoint,
338 FirstNewBlock->getInstList(),
339 AI, I);
Chris Lattnerf775f952003-10-14 01:11:07 +0000340 }
Chris Lattner33bb3c82006-09-13 19:23:57 +0000341 }
Chris Lattner80a38d22003-08-24 06:59:16 +0000342 }
Chris Lattnerca398dc2003-05-29 15:11:31 +0000343
Chris Lattnerbf229f42006-01-13 19:34:14 +0000344 // If the inlined code contained dynamic alloca instructions, wrap the inlined
345 // code with llvm.stacksave/llvm.stackrestore intrinsics.
346 if (InlinedFunctionInfo.ContainsDynamicAllocas) {
347 Module *M = Caller->getParent();
Chris Lattnerbf229f42006-01-13 19:34:14 +0000348 // Get the two intrinsics we care about.
Chris Lattnera121fdd2007-01-07 07:54:34 +0000349 Constant *StackSave, *StackRestore;
Duncan Sands3d292ac2008-04-07 13:43:58 +0000350 StackSave = Intrinsic::getDeclaration(M, Intrinsic::stacksave);
351 StackRestore = Intrinsic::getDeclaration(M, Intrinsic::stackrestore);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000352
353 // If we are preserving the callgraph, add edges to the stacksave/restore
354 // functions for the calls we insert.
Chris Lattner21ba23d2006-07-18 21:48:57 +0000355 CallGraphNode *StackSaveCGN = 0, *StackRestoreCGN = 0, *CallerNode = 0;
Chris Lattnerd85340f2006-07-12 18:29:36 +0000356 if (CG) {
Chris Lattnera121fdd2007-01-07 07:54:34 +0000357 // We know that StackSave/StackRestore are Function*'s, because they are
358 // intrinsics which must have the right types.
359 StackSaveCGN = CG->getOrInsertFunction(cast<Function>(StackSave));
360 StackRestoreCGN = CG->getOrInsertFunction(cast<Function>(StackRestore));
Chris Lattnerd85340f2006-07-12 18:29:36 +0000361 CallerNode = (*CG)[Caller];
362 }
363
Chris Lattnerbf229f42006-01-13 19:34:14 +0000364 // Insert the llvm.stacksave.
Gabor Greif051a9502008-04-06 20:25:17 +0000365 CallInst *SavedPtr = CallInst::Create(StackSave, "savedstack",
366 FirstNewBlock->begin());
Chris Lattnerd85340f2006-07-12 18:29:36 +0000367 if (CG) CallerNode->addCalledFunction(SavedPtr, StackSaveCGN);
368
Chris Lattnerbf229f42006-01-13 19:34:14 +0000369 // Insert a call to llvm.stackrestore before any return instructions in the
370 // inlined function.
Chris Lattnerd85340f2006-07-12 18:29:36 +0000371 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000372 CallInst *CI = CallInst::Create(StackRestore, SavedPtr, "", Returns[i]);
Chris Lattnerd85340f2006-07-12 18:29:36 +0000373 if (CG) CallerNode->addCalledFunction(CI, StackRestoreCGN);
374 }
Chris Lattner468fb1d2006-01-14 20:07:50 +0000375
376 // Count the number of StackRestore calls we insert.
377 unsigned NumStackRestores = Returns.size();
Chris Lattnerbf229f42006-01-13 19:34:14 +0000378
379 // If we are inlining an invoke instruction, insert restores before each
380 // unwind. These unwinds will be rewritten into branches later.
381 if (InlinedFunctionInfo.ContainsUnwinds && isa<InvokeInst>(TheCall)) {
382 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
383 BB != E; ++BB)
Chris Lattner468fb1d2006-01-14 20:07:50 +0000384 if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Duncan Sands3d292ac2008-04-07 13:43:58 +0000385 CallInst::Create(StackRestore, SavedPtr, "", UI);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000386 ++NumStackRestores;
387 }
388 }
Chris Lattnerbf229f42006-01-13 19:34:14 +0000389 }
390
Chris Lattner1fdf4a82006-01-13 19:18:11 +0000391 // If we are inlining tail call instruction through a call site that isn't
392 // marked 'tail', we must remove the tail marker for any calls in the inlined
Duncan Sandsf0c33542007-12-19 21:13:37 +0000393 // code. Also, calls inlined through a 'nounwind' call site should be marked
394 // 'nounwind'.
395 if (InlinedFunctionInfo.ContainsCalls &&
396 (MustClearTailCallFlags || MarkNoUnwind)) {
Chris Lattner1b491412005-05-06 06:47:52 +0000397 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
398 BB != E; ++BB)
399 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sandsf0c33542007-12-19 21:13:37 +0000400 if (CallInst *CI = dyn_cast<CallInst>(I)) {
401 if (MustClearTailCallFlags)
402 CI->setTailCall(false);
403 if (MarkNoUnwind)
404 CI->setDoesNotThrow();
405 }
Chris Lattner1b491412005-05-06 06:47:52 +0000406 }
407
Duncan Sandsf0c33542007-12-19 21:13:37 +0000408 // If we are inlining through a 'nounwind' call site then any inlined 'unwind'
409 // instructions are unreachable.
410 if (InlinedFunctionInfo.ContainsUnwinds && MarkNoUnwind)
411 for (Function::iterator BB = FirstNewBlock, E = Caller->end();
412 BB != E; ++BB) {
413 TerminatorInst *Term = BB->getTerminator();
414 if (isa<UnwindInst>(Term)) {
415 new UnreachableInst(Term);
416 BB->getInstList().erase(Term);
417 }
418 }
419
Chris Lattner5e923de2004-02-04 02:51:48 +0000420 // If we are inlining for an invoke instruction, we must make sure to rewrite
421 // any inlined 'unwind' instructions into branches to the invoke exception
422 // destination, and call instructions into invoke instructions.
Chris Lattnercd4d3392006-01-13 19:05:59 +0000423 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
424 HandleInlinedInvoke(II, FirstNewBlock, InlinedFunctionInfo);
Chris Lattner5e923de2004-02-04 02:51:48 +0000425
Chris Lattner44a68072004-02-04 04:17:06 +0000426 // If we cloned in _exactly one_ basic block, and if that block ends in a
427 // return instruction, we splice the body of the inlined callee directly into
428 // the calling basic block.
429 if (Returns.size() == 1 && std::distance(FirstNewBlock, Caller->end()) == 1) {
430 // Move all of the instructions right before the call.
431 OrigBB->getInstList().splice(TheCall, FirstNewBlock->getInstList(),
432 FirstNewBlock->begin(), FirstNewBlock->end());
433 // Remove the cloned basic block.
434 Caller->getBasicBlockList().pop_back();
Misha Brukmanfd939082005-04-21 23:48:37 +0000435
Chris Lattner44a68072004-02-04 04:17:06 +0000436 // If the call site was an invoke instruction, add a branch to the normal
437 // destination.
438 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall))
Gabor Greif051a9502008-04-06 20:25:17 +0000439 BranchInst::Create(II->getNormalDest(), TheCall);
Chris Lattner44a68072004-02-04 04:17:06 +0000440
441 // If the return instruction returned a value, replace uses of the call with
442 // uses of the returned value.
Devang Pateldc00d422008-03-04 21:15:15 +0000443 if (!TheCall->use_empty()) {
444 ReturnInst *R = Returns[0];
Dan Gohman2c317502008-06-20 01:03:44 +0000445 if (isa<StructType>(TheCall->getType()) &&
446 TheCall->getType() != R->getOperand(0)->getType()) {
447 // Multiple-value return statements.
Devang Patelac3746f2008-03-04 21:59:49 +0000448 while (!TheCall->use_empty()) {
449 GetResultInst *GR = cast<GetResultInst>(TheCall->use_back());
Devang Pateldc00d422008-03-04 21:15:15 +0000450 Value *RV = R->getOperand(GR->getIndex());
451 GR->replaceAllUsesWith(RV);
452 GR->eraseFromParent();
453 }
454 } else
455 TheCall->replaceAllUsesWith(R->getReturnValue());
456 }
Chris Lattner44a68072004-02-04 04:17:06 +0000457 // Since we are now done with the Call/Invoke, we can delete it.
Dan Gohman1adec832008-06-21 22:08:46 +0000458 TheCall->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000459
460 // Since we are now done with the return instruction, delete it also.
Dan Gohman1adec832008-06-21 22:08:46 +0000461 Returns[0]->eraseFromParent();
Chris Lattner44a68072004-02-04 04:17:06 +0000462
463 // We are now done with the inlining.
464 return true;
465 }
466
467 // Otherwise, we have the normal case, of more than one block to inline or
468 // multiple return sites.
469
Chris Lattner5e923de2004-02-04 02:51:48 +0000470 // We want to clone the entire callee function into the hole between the
471 // "starter" and "ender" blocks. How we accomplish this depends on whether
472 // this is an invoke instruction or a call instruction.
473 BasicBlock *AfterCallBB;
474 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
Misha Brukmanfd939082005-04-21 23:48:37 +0000475
Chris Lattner5e923de2004-02-04 02:51:48 +0000476 // Add an unconditional branch to make this look like the CallInst case...
Gabor Greif051a9502008-04-06 20:25:17 +0000477 BranchInst *NewBr = BranchInst::Create(II->getNormalDest(), TheCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000478
Chris Lattner5e923de2004-02-04 02:51:48 +0000479 // Split the basic block. This guarantees that no PHI nodes will have to be
480 // updated due to new incoming edges, and make the invoke case more
481 // symmetric to the call case.
482 AfterCallBB = OrigBB->splitBasicBlock(NewBr,
Chris Lattner284d1b82004-12-11 16:59:54 +0000483 CalledFunc->getName()+".exit");
Misha Brukmanfd939082005-04-21 23:48:37 +0000484
Chris Lattner5e923de2004-02-04 02:51:48 +0000485 } else { // It's a call
Chris Lattner44a68072004-02-04 04:17:06 +0000486 // If this is a call instruction, we need to split the basic block that
487 // the call lives in.
Chris Lattner5e923de2004-02-04 02:51:48 +0000488 //
489 AfterCallBB = OrigBB->splitBasicBlock(TheCall,
Chris Lattner284d1b82004-12-11 16:59:54 +0000490 CalledFunc->getName()+".exit");
Chris Lattner5e923de2004-02-04 02:51:48 +0000491 }
492
Chris Lattner44a68072004-02-04 04:17:06 +0000493 // Change the branch that used to go to AfterCallBB to branch to the first
494 // basic block of the inlined function.
495 //
496 TerminatorInst *Br = OrigBB->getTerminator();
Misha Brukmanfd939082005-04-21 23:48:37 +0000497 assert(Br && Br->getOpcode() == Instruction::Br &&
Chris Lattner44a68072004-02-04 04:17:06 +0000498 "splitBasicBlock broken!");
499 Br->setOperand(0, FirstNewBlock);
500
501
502 // Now that the function is correct, make it a little bit nicer. In
503 // particular, move the basic blocks inserted from the end of the function
504 // into the space made by splitting the source basic block.
Chris Lattner44a68072004-02-04 04:17:06 +0000505 Caller->getBasicBlockList().splice(AfterCallBB, Caller->getBasicBlockList(),
506 FirstNewBlock, Caller->end());
507
Chris Lattner5e923de2004-02-04 02:51:48 +0000508 // Handle all of the return instructions that we just cloned in, and eliminate
509 // any users of the original call/invoke instruction.
Devang Patelb8f198a2008-03-10 18:34:00 +0000510 const Type *RTy = CalledFunc->getReturnType();
511 const StructType *STy = dyn_cast<StructType>(RTy);
Dan Gohman2c317502008-06-20 01:03:44 +0000512
513 // We do special handling for multiple-value return statements. If this is
514 // a plain aggregate return, don't do the special handling.
515 if (!Returns.empty() && Returns[0]->getNumOperands() != 0 &&
516 Returns[0]->getOperand(0)->getType() == STy)
517 STy = 0;
518
Devang Patelb8f198a2008-03-10 18:34:00 +0000519 if (Returns.size() > 1 || STy) {
Chris Lattner5e923de2004-02-04 02:51:48 +0000520 // The PHI node should go at the front of the new basic block to merge all
521 // possible incoming values.
Devang Patel12a466b2008-03-07 20:06:16 +0000522 SmallVector<PHINode *, 4> PHIs;
Chris Lattner5e923de2004-02-04 02:51:48 +0000523 if (!TheCall->use_empty()) {
Devang Patelb8f198a2008-03-10 18:34:00 +0000524 if (STy) {
Devang Patel12a466b2008-03-07 20:06:16 +0000525 unsigned NumRetVals = STy->getNumElements();
526 // Create new phi nodes such that phi node number in the PHIs vector
527 // match corresponding return value operand number.
Devang Patel641ca932008-03-10 18:22:16 +0000528 Instruction *InsertPt = AfterCallBB->begin();
Devang Patel12a466b2008-03-07 20:06:16 +0000529 for (unsigned i = 0; i < NumRetVals; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000530 PHINode *PHI = PHINode::Create(STy->getElementType(i),
531 TheCall->getName() + "." + utostr(i),
532 InsertPt);
Devang Patel12a466b2008-03-07 20:06:16 +0000533 PHIs.push_back(PHI);
534 }
535 // TheCall results are used by GetResult instructions.
536 while (!TheCall->use_empty()) {
537 GetResultInst *GR = cast<GetResultInst>(TheCall->use_back());
538 GR->replaceAllUsesWith(PHIs[GR->getIndex()]);
539 GR->eraseFromParent();
540 }
541 } else {
Gabor Greifb1dbcd82008-05-15 10:04:30 +0000542 PHINode *PHI = PHINode::Create(RTy, TheCall->getName(),
543 AfterCallBB->begin());
Devang Patel12a466b2008-03-07 20:06:16 +0000544 PHIs.push_back(PHI);
545 // Anything that used the result of the function call should now use the
546 // PHI node as their operand.
547 TheCall->replaceAllUsesWith(PHI);
548 }
Chris Lattner5e923de2004-02-04 02:51:48 +0000549 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000550
Devang Patel12a466b2008-03-07 20:06:16 +0000551 // Loop over all of the return instructions adding entries to the PHI node as
Chris Lattner5e923de2004-02-04 02:51:48 +0000552 // appropriate.
Devang Patel12a466b2008-03-07 20:06:16 +0000553 if (!PHIs.empty()) {
Devang Patel641ca932008-03-10 18:22:16 +0000554 // There is atleast one return value.
555 unsigned NumRetVals = 1;
Devang Patelb8f198a2008-03-10 18:34:00 +0000556 if (STy)
Devang Patel641ca932008-03-10 18:22:16 +0000557 NumRetVals = STy->getNumElements();
558 for (unsigned j = 0; j < NumRetVals; ++j) {
559 PHINode *PHI = PHIs[j];
560 // Each PHI node will receive one value from each return instruction.
561 for(unsigned i = 0, e = Returns.size(); i != e; ++i) {
Devang Patel12a466b2008-03-07 20:06:16 +0000562 ReturnInst *RI = Returns[i];
Devang Patel641ca932008-03-10 18:22:16 +0000563 assert(RI->getReturnValue(j)->getType() == PHI->getType() &&
Devang Patel12a466b2008-03-07 20:06:16 +0000564 "Ret value not consistent in function!");
Devang Patel641ca932008-03-10 18:22:16 +0000565 PHI->addIncoming(RI->getReturnValue(j /*PHI number matches operand number*/),
566 RI->getParent());
Devang Patel12a466b2008-03-07 20:06:16 +0000567 }
568 }
569 }
570
571 // Add a branch to the merge points and remove retrun instructions.
Chris Lattner5e923de2004-02-04 02:51:48 +0000572 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
573 ReturnInst *RI = Returns[i];
Gabor Greif051a9502008-04-06 20:25:17 +0000574 BranchInst::Create(AfterCallBB, RI);
Devang Patelb8f198a2008-03-10 18:34:00 +0000575 RI->eraseFromParent();
Chris Lattner5e923de2004-02-04 02:51:48 +0000576 }
Devang Patelb8f198a2008-03-10 18:34:00 +0000577 } else if (!Returns.empty()) {
578 // Otherwise, if there is exactly one return value, just replace anything
579 // using the return value of the call with the computed value.
580 if (!TheCall->use_empty())
581 TheCall->replaceAllUsesWith(Returns[0]->getReturnValue());
582
583 // Splice the code from the return block into the block that it will return
584 // to, which contains the code that was after the call.
585 BasicBlock *ReturnBB = Returns[0]->getParent();
586 AfterCallBB->getInstList().splice(AfterCallBB->begin(),
587 ReturnBB->getInstList());
588
589 // Update PHI nodes that use the ReturnBB to use the AfterCallBB.
590 ReturnBB->replaceAllUsesWith(AfterCallBB);
591
592 // Delete the return instruction now and empty ReturnBB now.
593 Returns[0]->eraseFromParent();
594 ReturnBB->eraseFromParent();
Chris Lattner3787e762004-10-17 23:21:07 +0000595 } else if (!TheCall->use_empty()) {
596 // No returns, but something is using the return value of the call. Just
597 // nuke the result.
598 TheCall->replaceAllUsesWith(UndefValue::get(TheCall->getType()));
Chris Lattner5e923de2004-02-04 02:51:48 +0000599 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000600
Chris Lattner5e923de2004-02-04 02:51:48 +0000601 // Since we are now done with the Call/Invoke, we can delete it.
Chris Lattner3787e762004-10-17 23:21:07 +0000602 TheCall->eraseFromParent();
Chris Lattnerca398dc2003-05-29 15:11:31 +0000603
Chris Lattner7152c232003-08-24 04:06:56 +0000604 // We should always be able to fold the entry block of the function into the
605 // single predecessor of the block...
Chris Lattnercd01ae52004-04-16 05:17:59 +0000606 assert(cast<BranchInst>(Br)->isUnconditional() && "splitBasicBlock broken!");
Chris Lattner7152c232003-08-24 04:06:56 +0000607 BasicBlock *CalleeEntry = cast<BranchInst>(Br)->getSuccessor(0);
Chris Lattner44a68072004-02-04 04:17:06 +0000608
Chris Lattnercd01ae52004-04-16 05:17:59 +0000609 // Splice the code entry block into calling block, right before the
610 // unconditional branch.
611 OrigBB->getInstList().splice(Br, CalleeEntry->getInstList());
612 CalleeEntry->replaceAllUsesWith(OrigBB); // Update PHI nodes
613
614 // Remove the unconditional branch.
615 OrigBB->getInstList().erase(Br);
616
617 // Now we can remove the CalleeEntry block, which is now empty.
618 Caller->getBasicBlockList().erase(CalleeEntry);
Chris Lattner468fb1d2006-01-14 20:07:50 +0000619
Chris Lattnerca398dc2003-05-29 15:11:31 +0000620 return true;
621}