blob: 038e7ba08acd8a009b4a80982f5f5498060a0e5e [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- CloneFunction.cpp - Clone a function into another function ---------===//
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 the CloneFunctionInto interface, which is used as the
11// low-level function cloner. This is used by the CloneFunction and function
12// inliner to do the dirty work of copying the body of a function around.
13//
14//===----------------------------------------------------------------------===//
15
16#include "llvm/Transforms/Utils/Cloning.h"
17#include "llvm/Constants.h"
18#include "llvm/DerivedTypes.h"
19#include "llvm/Instructions.h"
Devang Patel2d9d4282009-02-10 07:48:18 +000020#include "llvm/IntrinsicInst.h"
Nate Begemanc368b5b2008-04-25 06:37:06 +000021#include "llvm/GlobalVariable.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000022#include "llvm/Function.h"
Devang Patel90a0fe32009-11-10 23:06:00 +000023#include "llvm/LLVMContext.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000024#include "llvm/Support/CFG.h"
Anton Korobeynikovad7ea242007-11-09 12:27:04 +000025#include "llvm/Transforms/Utils/ValueMapper.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026#include "llvm/Analysis/ConstantFolding.h"
Devang Patel41f60452009-04-15 00:17:06 +000027#include "llvm/Analysis/DebugInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000028#include "llvm/ADT/SmallVector.h"
29#include <map>
30using namespace llvm;
31
32// CloneBasicBlock - See comments in Cloning.h
33BasicBlock *llvm::CloneBasicBlock(const BasicBlock *BB,
34 DenseMap<const Value*, Value*> &ValueMap,
35 const char *NameSuffix, Function *F,
36 ClonedCodeInfo *CodeInfo) {
Owen Anderson35b47072009-08-13 21:58:54 +000037 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "", F);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000038 if (BB->hasName()) NewBB->setName(BB->getName()+NameSuffix);
39
40 bool hasCalls = false, hasDynamicAllocas = false, hasStaticAllocas = false;
41
42 // Loop over all instructions, and copy them over.
43 for (BasicBlock::const_iterator II = BB->begin(), IE = BB->end();
44 II != IE; ++II) {
Nick Lewyckyc94270c2009-09-27 07:38:41 +000045 Instruction *NewInst = II->clone();
Dan Gohmanf17a25c2007-07-18 16:29:46 +000046 if (II->hasName())
47 NewInst->setName(II->getName()+NameSuffix);
48 NewBB->getInstList().push_back(NewInst);
49 ValueMap[II] = NewInst; // Add instruction map to value.
50
Dale Johannesenb15866e2009-03-10 22:20:02 +000051 hasCalls |= (isa<CallInst>(II) && !isa<DbgInfoIntrinsic>(II));
Dan Gohmanf17a25c2007-07-18 16:29:46 +000052 if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
53 if (isa<ConstantInt>(AI->getArraySize()))
54 hasStaticAllocas = true;
55 else
56 hasDynamicAllocas = true;
57 }
58 }
59
60 if (CodeInfo) {
61 CodeInfo->ContainsCalls |= hasCalls;
62 CodeInfo->ContainsUnwinds |= isa<UnwindInst>(BB->getTerminator());
63 CodeInfo->ContainsDynamicAllocas |= hasDynamicAllocas;
64 CodeInfo->ContainsDynamicAllocas |= hasStaticAllocas &&
65 BB != &BB->getParent()->getEntryBlock();
66 }
67 return NewBB;
68}
69
70// Clone OldFunc into NewFunc, transforming the old arguments into references to
71// ArgMap values.
72//
73void llvm::CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
74 DenseMap<const Value*, Value*> &ValueMap,
Chris Lattnereb875902009-08-27 04:02:30 +000075 SmallVectorImpl<ReturnInst*> &Returns,
Dan Gohmanf17a25c2007-07-18 16:29:46 +000076 const char *NameSuffix, ClonedCodeInfo *CodeInfo) {
77 assert(NameSuffix && "NameSuffix cannot be null!");
78
79#ifndef NDEBUG
80 for (Function::const_arg_iterator I = OldFunc->arg_begin(),
81 E = OldFunc->arg_end(); I != E; ++I)
82 assert(ValueMap.count(I) && "No mapping from source argument specified!");
83#endif
84
Duncan Sands0cc90582008-05-26 19:58:59 +000085 // Clone any attributes.
Andrew Lenharth1c864f62008-10-07 18:08:38 +000086 if (NewFunc->arg_size() == OldFunc->arg_size())
87 NewFunc->copyAttributesFrom(OldFunc);
88 else {
89 //Some arguments were deleted with the ValueMap. Copy arguments one by one
90 for (Function::const_arg_iterator I = OldFunc->arg_begin(),
91 E = OldFunc->arg_end(); I != E; ++I)
92 if (Argument* Anew = dyn_cast<Argument>(ValueMap[I]))
93 Anew->addAttr( OldFunc->getAttributes()
94 .getParamAttributes(I->getArgNo() + 1));
95 NewFunc->setAttributes(NewFunc->getAttributes()
96 .addAttr(0, OldFunc->getAttributes()
97 .getRetAttributes()));
98 NewFunc->setAttributes(NewFunc->getAttributes()
99 .addAttr(~0, OldFunc->getAttributes()
100 .getFnAttributes()));
101
102 }
Anton Korobeynikov649382f2008-03-23 16:03:00 +0000103
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000104 // Loop over all of the basic blocks in the function, cloning them as
105 // appropriate. Note that we save BE this way in order to handle cloning of
106 // recursive functions into themselves.
107 //
108 for (Function::const_iterator BI = OldFunc->begin(), BE = OldFunc->end();
109 BI != BE; ++BI) {
110 const BasicBlock &BB = *BI;
111
112 // Create a new basic block and copy instructions into it!
113 BasicBlock *CBB = CloneBasicBlock(&BB, ValueMap, NameSuffix, NewFunc,
114 CodeInfo);
115 ValueMap[&BB] = CBB; // Add basic block mapping.
116
117 if (ReturnInst *RI = dyn_cast<ReturnInst>(CBB->getTerminator()))
118 Returns.push_back(RI);
119 }
120
121 // Loop over all of the instructions in the function, fixing up operand
122 // references as we go. This uses ValueMap to do all the hard work.
123 //
124 for (Function::iterator BB = cast<BasicBlock>(ValueMap[OldFunc->begin()]),
Nick Lewyckyd8aa33a2008-04-25 16:53:59 +0000125 BE = NewFunc->end(); BB != BE; ++BB)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000126 // Loop over all instructions, fixing each one as we find it...
127 for (BasicBlock::iterator II = BB->begin(); II != BB->end(); ++II)
128 RemapInstruction(II, ValueMap);
129}
130
131/// CloneFunction - Return a copy of the specified function, but without
132/// embedding the function into another module. Also, any references specified
133/// in the ValueMap are changed to refer to their mapped value instead of the
134/// original one. If any of the arguments to the function are in the ValueMap,
135/// the arguments are deleted from the resultant function. The ValueMap is
136/// updated to include mappings from all of the instructions and basicblocks in
137/// the function from their old to new values.
138///
139Function *llvm::CloneFunction(const Function *F,
140 DenseMap<const Value*, Value*> &ValueMap,
141 ClonedCodeInfo *CodeInfo) {
142 std::vector<const Type*> ArgTypes;
143
144 // The user might be deleting arguments to the function by specifying them in
145 // the ValueMap. If so, we need to not add the arguments to the arg ty vector
146 //
147 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
148 I != E; ++I)
149 if (ValueMap.count(I) == 0) // Haven't mapped the argument to anything yet?
150 ArgTypes.push_back(I->getType());
151
152 // Create a new function type...
Owen Anderson6b6e2d92009-07-29 22:17:13 +0000153 FunctionType *FTy = FunctionType::get(F->getFunctionType()->getReturnType(),
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000154 ArgTypes, F->getFunctionType()->isVarArg());
155
156 // Create the new function...
Gabor Greifd6da1d02008-04-06 20:25:17 +0000157 Function *NewF = Function::Create(FTy, F->getLinkage(), F->getName());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000158
159 // Loop over the arguments, copying the names of the mapped arguments over...
160 Function::arg_iterator DestI = NewF->arg_begin();
161 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
162 I != E; ++I)
163 if (ValueMap.count(I) == 0) { // Is this argument preserved?
164 DestI->setName(I->getName()); // Copy the name over...
165 ValueMap[I] = DestI++; // Add mapping to ValueMap
166 }
167
Chris Lattnereb875902009-08-27 04:02:30 +0000168 SmallVector<ReturnInst*, 8> Returns; // Ignore returns cloned.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000169 CloneFunctionInto(NewF, F, ValueMap, Returns, "", CodeInfo);
170 return NewF;
171}
172
173
174
175namespace {
176 /// PruningFunctionCloner - This class is a private class used to implement
177 /// the CloneAndPruneFunctionInto method.
Nick Lewycky492d06e2009-10-25 06:33:48 +0000178 struct PruningFunctionCloner {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000179 Function *NewFunc;
180 const Function *OldFunc;
181 DenseMap<const Value*, Value*> &ValueMap;
Chris Lattnereb875902009-08-27 04:02:30 +0000182 SmallVectorImpl<ReturnInst*> &Returns;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000183 const char *NameSuffix;
184 ClonedCodeInfo *CodeInfo;
185 const TargetData *TD;
Devang Patel2d9d4282009-02-10 07:48:18 +0000186 Value *DbgFnStart;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000187 public:
188 PruningFunctionCloner(Function *newFunc, const Function *oldFunc,
189 DenseMap<const Value*, Value*> &valueMap,
Chris Lattnereb875902009-08-27 04:02:30 +0000190 SmallVectorImpl<ReturnInst*> &returns,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000191 const char *nameSuffix,
192 ClonedCodeInfo *codeInfo,
193 const TargetData *td)
194 : NewFunc(newFunc), OldFunc(oldFunc), ValueMap(valueMap), Returns(returns),
Devang Patel2d9d4282009-02-10 07:48:18 +0000195 NameSuffix(nameSuffix), CodeInfo(codeInfo), TD(td), DbgFnStart(NULL) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000196 }
197
198 /// CloneBlock - The specified block is found to be reachable, clone it and
199 /// anything that it can reach.
200 void CloneBlock(const BasicBlock *BB,
201 std::vector<const BasicBlock*> &ToClone);
202
203 public:
204 /// ConstantFoldMappedInstruction - Constant fold the specified instruction,
205 /// mapping its operands through ValueMap if they are available.
206 Constant *ConstantFoldMappedInstruction(const Instruction *I);
207 };
208}
209
210/// CloneBlock - The specified block is found to be reachable, clone it and
211/// anything that it can reach.
212void PruningFunctionCloner::CloneBlock(const BasicBlock *BB,
213 std::vector<const BasicBlock*> &ToClone){
214 Value *&BBEntry = ValueMap[BB];
215
216 // Have we already cloned this block?
217 if (BBEntry) return;
218
219 // Nope, clone it now.
220 BasicBlock *NewBB;
Owen Anderson35b47072009-08-13 21:58:54 +0000221 BBEntry = NewBB = BasicBlock::Create(BB->getContext());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000222 if (BB->hasName()) NewBB->setName(BB->getName()+NameSuffix);
223
224 bool hasCalls = false, hasDynamicAllocas = false, hasStaticAllocas = false;
225
226 // Loop over all instructions, and copy them over, DCE'ing as we go. This
227 // loop doesn't include the terminator.
228 for (BasicBlock::const_iterator II = BB->begin(), IE = --BB->end();
229 II != IE; ++II) {
230 // If this instruction constant folds, don't bother cloning the instruction,
231 // instead, just add the constant to the value map.
232 if (Constant *C = ConstantFoldMappedInstruction(II)) {
233 ValueMap[II] = C;
234 continue;
235 }
Devang Patel2d9d4282009-02-10 07:48:18 +0000236
Devang Patel41f60452009-04-15 00:17:06 +0000237 // Do not clone llvm.dbg.region.end. It will be adjusted by the inliner.
Devang Patel2d9d4282009-02-10 07:48:18 +0000238 if (const DbgFuncStartInst *DFSI = dyn_cast<DbgFuncStartInst>(II)) {
Devang Patel41f60452009-04-15 00:17:06 +0000239 if (DbgFnStart == NULL) {
Devang Patel15e723d2009-08-28 23:24:31 +0000240 DISubprogram SP(DFSI->getSubprogram());
Devang Patel41f60452009-04-15 00:17:06 +0000241 if (SP.describes(BB->getParent()))
242 DbgFnStart = DFSI->getSubprogram();
243 }
Devang Patel2d9d4282009-02-10 07:48:18 +0000244 }
245 if (const DbgRegionEndInst *DREIS = dyn_cast<DbgRegionEndInst>(II)) {
246 if (DREIS->getContext() == DbgFnStart)
247 continue;
248 }
249
Nick Lewyckyc94270c2009-09-27 07:38:41 +0000250 Instruction *NewInst = II->clone();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000251 if (II->hasName())
252 NewInst->setName(II->getName()+NameSuffix);
253 NewBB->getInstList().push_back(NewInst);
254 ValueMap[II] = NewInst; // Add instruction map to value.
255
Dale Johannesenb15866e2009-03-10 22:20:02 +0000256 hasCalls |= (isa<CallInst>(II) && !isa<DbgInfoIntrinsic>(II));
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000257 if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
258 if (isa<ConstantInt>(AI->getArraySize()))
259 hasStaticAllocas = true;
260 else
261 hasDynamicAllocas = true;
262 }
263 }
264
265 // Finally, clone over the terminator.
266 const TerminatorInst *OldTI = BB->getTerminator();
267 bool TerminatorDone = false;
268 if (const BranchInst *BI = dyn_cast<BranchInst>(OldTI)) {
269 if (BI->isConditional()) {
270 // If the condition was a known constant in the callee...
271 ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition());
272 // Or is a known constant in the caller...
273 if (Cond == 0)
274 Cond = dyn_cast_or_null<ConstantInt>(ValueMap[BI->getCondition()]);
275
276 // Constant fold to uncond branch!
277 if (Cond) {
278 BasicBlock *Dest = BI->getSuccessor(!Cond->getZExtValue());
Gabor Greifd6da1d02008-04-06 20:25:17 +0000279 ValueMap[OldTI] = BranchInst::Create(Dest, NewBB);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000280 ToClone.push_back(Dest);
281 TerminatorDone = true;
282 }
283 }
284 } else if (const SwitchInst *SI = dyn_cast<SwitchInst>(OldTI)) {
285 // If switching on a value known constant in the caller.
286 ConstantInt *Cond = dyn_cast<ConstantInt>(SI->getCondition());
287 if (Cond == 0) // Or known constant after constant prop in the callee...
288 Cond = dyn_cast_or_null<ConstantInt>(ValueMap[SI->getCondition()]);
289 if (Cond) { // Constant fold to uncond branch!
290 BasicBlock *Dest = SI->getSuccessor(SI->findCaseValue(Cond));
Gabor Greifd6da1d02008-04-06 20:25:17 +0000291 ValueMap[OldTI] = BranchInst::Create(Dest, NewBB);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000292 ToClone.push_back(Dest);
293 TerminatorDone = true;
294 }
295 }
296
297 if (!TerminatorDone) {
Nick Lewyckyc94270c2009-09-27 07:38:41 +0000298 Instruction *NewInst = OldTI->clone();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000299 if (OldTI->hasName())
300 NewInst->setName(OldTI->getName()+NameSuffix);
301 NewBB->getInstList().push_back(NewInst);
302 ValueMap[OldTI] = NewInst; // Add instruction map to value.
303
304 // Recursively clone any reachable successor blocks.
305 const TerminatorInst *TI = BB->getTerminator();
306 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
307 ToClone.push_back(TI->getSuccessor(i));
308 }
309
310 if (CodeInfo) {
311 CodeInfo->ContainsCalls |= hasCalls;
312 CodeInfo->ContainsUnwinds |= isa<UnwindInst>(OldTI);
313 CodeInfo->ContainsDynamicAllocas |= hasDynamicAllocas;
314 CodeInfo->ContainsDynamicAllocas |= hasStaticAllocas &&
315 BB != &BB->getParent()->front();
316 }
317
318 if (ReturnInst *RI = dyn_cast<ReturnInst>(NewBB->getTerminator()))
319 Returns.push_back(RI);
320}
321
322/// ConstantFoldMappedInstruction - Constant fold the specified instruction,
323/// mapping its operands through ValueMap if they are available.
324Constant *PruningFunctionCloner::
325ConstantFoldMappedInstruction(const Instruction *I) {
326 SmallVector<Constant*, 8> Ops;
327 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
328 if (Constant *Op = dyn_cast_or_null<Constant>(MapValue(I->getOperand(i),
Dan Gohmana5b5be12009-10-24 23:37:16 +0000329 ValueMap)))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000330 Ops.push_back(Op);
331 else
332 return 0; // All operands not constant!
333
Chris Lattnerd6e56912007-12-10 22:53:04 +0000334 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
Chris Lattner10381be2009-11-09 23:06:58 +0000335 return ConstantFoldCompareInstOperands(CI->getPredicate(), Ops[0], Ops[1],
336 TD);
Nate Begemanc368b5b2008-04-25 06:37:06 +0000337
Nate Begemanc6962632008-04-25 17:45:52 +0000338 if (const LoadInst *LI = dyn_cast<LoadInst>(I))
339 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Ops[0]))
Nate Begemanc368b5b2008-04-25 06:37:06 +0000340 if (!LI->isVolatile() && CE->getOpcode() == Instruction::GetElementPtr)
341 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(CE->getOperand(0)))
Duncan Sands54e70f62009-03-21 21:27:31 +0000342 if (GV->isConstant() && GV->hasDefinitiveInitializer())
Nate Begemanc368b5b2008-04-25 06:37:06 +0000343 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(),
Dan Gohmanf49f7b02009-10-05 16:36:26 +0000344 CE);
Nate Begemanc368b5b2008-04-25 06:37:06 +0000345
346 return ConstantFoldInstOperands(I->getOpcode(), I->getType(), &Ops[0],
Chris Lattner6070c012009-11-06 04:27:31 +0000347 Ops.size(), TD);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000348}
349
Chris Lattner2c342102009-12-29 08:03:58 +0000350static MDNode *UpdateInlinedAtInfo(MDNode *InsnMD, MDNode *TheCallMD) {
Devang Patel90a0fe32009-11-10 23:06:00 +0000351 DILocation ILoc(InsnMD);
352 if (ILoc.isNull()) return InsnMD;
353
354 DILocation CallLoc(TheCallMD);
355 if (CallLoc.isNull()) return InsnMD;
356
357 DILocation OrigLocation = ILoc.getOrigLocation();
358 MDNode *NewLoc = TheCallMD;
359 if (!OrigLocation.isNull())
Chris Lattner2c342102009-12-29 08:03:58 +0000360 NewLoc = UpdateInlinedAtInfo(OrigLocation.getNode(), TheCallMD);
Devang Patel90a0fe32009-11-10 23:06:00 +0000361
362 SmallVector<Value *, 4> MDVs;
363 MDVs.push_back(InsnMD->getElement(0)); // Line
364 MDVs.push_back(InsnMD->getElement(1)); // Col
365 MDVs.push_back(InsnMD->getElement(2)); // Scope
366 MDVs.push_back(NewLoc);
Chris Lattner2c342102009-12-29 08:03:58 +0000367 return MDNode::get(InsnMD->getContext(), MDVs.data(), MDVs.size());
Devang Patel90a0fe32009-11-10 23:06:00 +0000368}
369
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000370/// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto,
371/// except that it does some simple constant prop and DCE on the fly. The
372/// effect of this is to copy significantly less code in cases where (for
373/// example) a function call with constant arguments is inlined, and those
374/// constant arguments cause a significant amount of code in the callee to be
Duncan Sandsf5588dc2007-11-27 13:23:08 +0000375/// dead. Since this doesn't produce an exact copy of the input, it can't be
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000376/// used for things like CloneFunction or CloneModule.
377void llvm::CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc,
378 DenseMap<const Value*, Value*> &ValueMap,
Chris Lattnereb875902009-08-27 04:02:30 +0000379 SmallVectorImpl<ReturnInst*> &Returns,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000380 const char *NameSuffix,
381 ClonedCodeInfo *CodeInfo,
Devang Patel90a0fe32009-11-10 23:06:00 +0000382 const TargetData *TD,
383 Instruction *TheCall) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000384 assert(NameSuffix && "NameSuffix cannot be null!");
385
386#ifndef NDEBUG
387 for (Function::const_arg_iterator II = OldFunc->arg_begin(),
388 E = OldFunc->arg_end(); II != E; ++II)
389 assert(ValueMap.count(II) && "No mapping from source argument specified!");
390#endif
Duncan Sands0cc90582008-05-26 19:58:59 +0000391
392 PruningFunctionCloner PFC(NewFunc, OldFunc, ValueMap, Returns,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000393 NameSuffix, CodeInfo, TD);
394
395 // Clone the entry block, and anything recursively reachable from it.
396 std::vector<const BasicBlock*> CloneWorklist;
397 CloneWorklist.push_back(&OldFunc->getEntryBlock());
398 while (!CloneWorklist.empty()) {
399 const BasicBlock *BB = CloneWorklist.back();
400 CloneWorklist.pop_back();
401 PFC.CloneBlock(BB, CloneWorklist);
402 }
403
404 // Loop over all of the basic blocks in the old function. If the block was
405 // reachable, we have cloned it and the old block is now in the value map:
406 // insert it into the new function in the right order. If not, ignore it.
407 //
408 // Defer PHI resolution until rest of function is resolved.
Chris Lattnereb875902009-08-27 04:02:30 +0000409 SmallVector<const PHINode*, 16> PHIToResolve;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000410 for (Function::const_iterator BI = OldFunc->begin(), BE = OldFunc->end();
411 BI != BE; ++BI) {
412 BasicBlock *NewBB = cast_or_null<BasicBlock>(ValueMap[BI]);
413 if (NewBB == 0) continue; // Dead block.
414
415 // Add the new block to the new function.
416 NewFunc->getBasicBlockList().push_back(NewBB);
417
418 // Loop over all of the instructions in the block, fixing up operand
419 // references as we go. This uses ValueMap to do all the hard work.
420 //
421 BasicBlock::iterator I = NewBB->begin();
Devang Patel90a0fe32009-11-10 23:06:00 +0000422
Chris Lattnera0d451f2009-12-29 09:01:33 +0000423 unsigned DbgKind = OldFunc->getContext().getMDKindID("dbg");
Devang Patel90a0fe32009-11-10 23:06:00 +0000424 MDNode *TheCallMD = NULL;
425 SmallVector<Value *, 4> MDVs;
426 if (TheCall && TheCall->hasMetadata())
Chris Lattnerdcf06572009-12-28 23:41:32 +0000427 TheCallMD = TheCall->getMetadata(DbgKind);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000428
429 // Handle PHI nodes specially, as we have to remove references to dead
430 // blocks.
431 if (PHINode *PN = dyn_cast<PHINode>(I)) {
432 // Skip over all PHI nodes, remembering them for later.
433 BasicBlock::const_iterator OldI = BI->begin();
Devang Patel90a0fe32009-11-10 23:06:00 +0000434 for (; (PN = dyn_cast<PHINode>(I)); ++I, ++OldI) {
Daniel Dunbar1b692202009-11-12 02:52:56 +0000435 if (I->hasMetadata()) {
Devang Patel90a0fe32009-11-10 23:06:00 +0000436 if (TheCallMD) {
Chris Lattnerdcf06572009-12-28 23:41:32 +0000437 if (MDNode *IMD = I->getMetadata(DbgKind)) {
Chris Lattner2c342102009-12-29 08:03:58 +0000438 MDNode *NewMD = UpdateInlinedAtInfo(IMD, TheCallMD);
Chris Lattnerdcf06572009-12-28 23:41:32 +0000439 I->setMetadata(DbgKind, NewMD);
Devang Patel90a0fe32009-11-10 23:06:00 +0000440 }
Daniel Dunbar1b692202009-11-12 02:52:56 +0000441 } else {
Devang Patel90a0fe32009-11-10 23:06:00 +0000442 // The cloned instruction has dbg info but the call instruction
443 // does not have dbg info. Remove dbg info from cloned instruction.
Chris Lattnerdcf06572009-12-28 23:41:32 +0000444 I->setMetadata(DbgKind, 0);
Daniel Dunbar1b692202009-11-12 02:52:56 +0000445 }
446 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000447 PHIToResolve.push_back(cast<PHINode>(OldI));
Devang Patel90a0fe32009-11-10 23:06:00 +0000448 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000449 }
450
Chris Lattnerdcf06572009-12-28 23:41:32 +0000451 // FIXME:
452 // FIXME:
453 // FIXME: Unclone all this metadata stuff.
454 // FIXME:
455 // FIXME:
456
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000457 // Otherwise, remap the rest of the instructions normally.
Devang Patel90a0fe32009-11-10 23:06:00 +0000458 for (; I != NewBB->end(); ++I) {
Daniel Dunbar1b692202009-11-12 02:52:56 +0000459 if (I->hasMetadata()) {
Devang Patel90a0fe32009-11-10 23:06:00 +0000460 if (TheCallMD) {
Chris Lattnerdcf06572009-12-28 23:41:32 +0000461 if (MDNode *IMD = I->getMetadata(DbgKind)) {
Chris Lattner2c342102009-12-29 08:03:58 +0000462 MDNode *NewMD = UpdateInlinedAtInfo(IMD, TheCallMD);
Chris Lattnerdcf06572009-12-28 23:41:32 +0000463 I->setMetadata(DbgKind, NewMD);
Devang Patel90a0fe32009-11-10 23:06:00 +0000464 }
Daniel Dunbar1b692202009-11-12 02:52:56 +0000465 } else {
Devang Patel90a0fe32009-11-10 23:06:00 +0000466 // The cloned instruction has dbg info but the call instruction
467 // does not have dbg info. Remove dbg info from cloned instruction.
Chris Lattnerdcf06572009-12-28 23:41:32 +0000468 I->setMetadata(DbgKind, 0);
Daniel Dunbar1b692202009-11-12 02:52:56 +0000469 }
470 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000471 RemapInstruction(I, ValueMap);
Devang Patel90a0fe32009-11-10 23:06:00 +0000472 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000473 }
474
475 // Defer PHI resolution until rest of function is resolved, PHI resolution
476 // requires the CFG to be up-to-date.
477 for (unsigned phino = 0, e = PHIToResolve.size(); phino != e; ) {
478 const PHINode *OPN = PHIToResolve[phino];
479 unsigned NumPreds = OPN->getNumIncomingValues();
480 const BasicBlock *OldBB = OPN->getParent();
481 BasicBlock *NewBB = cast<BasicBlock>(ValueMap[OldBB]);
482
483 // Map operands for blocks that are live and remove operands for blocks
484 // that are dead.
485 for (; phino != PHIToResolve.size() &&
486 PHIToResolve[phino]->getParent() == OldBB; ++phino) {
487 OPN = PHIToResolve[phino];
488 PHINode *PN = cast<PHINode>(ValueMap[OPN]);
489 for (unsigned pred = 0, e = NumPreds; pred != e; ++pred) {
490 if (BasicBlock *MappedBlock =
491 cast_or_null<BasicBlock>(ValueMap[PN->getIncomingBlock(pred)])) {
Owen Andersona09d2342009-07-05 22:41:43 +0000492 Value *InVal = MapValue(PN->getIncomingValue(pred),
Dan Gohmana5b5be12009-10-24 23:37:16 +0000493 ValueMap);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000494 assert(InVal && "Unknown input value?");
495 PN->setIncomingValue(pred, InVal);
496 PN->setIncomingBlock(pred, MappedBlock);
497 } else {
498 PN->removeIncomingValue(pred, false);
499 --pred, --e; // Revisit the next entry.
500 }
501 }
502 }
503
504 // The loop above has removed PHI entries for those blocks that are dead
505 // and has updated others. However, if a block is live (i.e. copied over)
506 // but its terminator has been changed to not go to this block, then our
507 // phi nodes will have invalid entries. Update the PHI nodes in this
508 // case.
509 PHINode *PN = cast<PHINode>(NewBB->begin());
510 NumPreds = std::distance(pred_begin(NewBB), pred_end(NewBB));
511 if (NumPreds != PN->getNumIncomingValues()) {
512 assert(NumPreds < PN->getNumIncomingValues());
513 // Count how many times each predecessor comes to this block.
514 std::map<BasicBlock*, unsigned> PredCount;
515 for (pred_iterator PI = pred_begin(NewBB), E = pred_end(NewBB);
516 PI != E; ++PI)
517 --PredCount[*PI];
518
519 // Figure out how many entries to remove from each PHI.
520 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
521 ++PredCount[PN->getIncomingBlock(i)];
522
523 // At this point, the excess predecessor entries are positive in the
524 // map. Loop over all of the PHIs and remove excess predecessor
525 // entries.
526 BasicBlock::iterator I = NewBB->begin();
527 for (; (PN = dyn_cast<PHINode>(I)); ++I) {
528 for (std::map<BasicBlock*, unsigned>::iterator PCI =PredCount.begin(),
529 E = PredCount.end(); PCI != E; ++PCI) {
530 BasicBlock *Pred = PCI->first;
531 for (unsigned NumToRemove = PCI->second; NumToRemove; --NumToRemove)
532 PN->removeIncomingValue(Pred, false);
533 }
534 }
535 }
536
537 // If the loops above have made these phi nodes have 0 or 1 operand,
538 // replace them with undef or the input value. We must do this for
539 // correctness, because 0-operand phis are not valid.
540 PN = cast<PHINode>(NewBB->begin());
541 if (PN->getNumIncomingValues() == 0) {
542 BasicBlock::iterator I = NewBB->begin();
543 BasicBlock::const_iterator OldI = OldBB->begin();
544 while ((PN = dyn_cast<PHINode>(I++))) {
Owen Andersonb99ecca2009-07-30 23:03:37 +0000545 Value *NV = UndefValue::get(PN->getType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000546 PN->replaceAllUsesWith(NV);
547 assert(ValueMap[OldI] == PN && "ValueMap mismatch");
548 ValueMap[OldI] = NV;
549 PN->eraseFromParent();
550 ++OldI;
551 }
552 }
553 // NOTE: We cannot eliminate single entry phi nodes here, because of
554 // ValueMap. Single entry phi nodes can have multiple ValueMap entries
555 // pointing at them. Thus, deleting one would require scanning the ValueMap
556 // to update any entries in it that would require that. This would be
557 // really slow.
558 }
559
560 // Now that the inlined function body has been fully constructed, go through
561 // and zap unconditional fall-through branches. This happen all the time when
562 // specializing code: code specialization turns conditional branches into
563 // uncond branches, and this code folds them.
564 Function::iterator I = cast<BasicBlock>(ValueMap[&OldFunc->getEntryBlock()]);
565 while (I != NewFunc->end()) {
566 BranchInst *BI = dyn_cast<BranchInst>(I->getTerminator());
567 if (!BI || BI->isConditional()) { ++I; continue; }
568
569 // Note that we can't eliminate uncond branches if the destination has
570 // single-entry PHI nodes. Eliminating the single-entry phi nodes would
571 // require scanning the ValueMap to update any entries that point to the phi
572 // node.
573 BasicBlock *Dest = BI->getSuccessor(0);
574 if (!Dest->getSinglePredecessor() || isa<PHINode>(Dest->begin())) {
575 ++I; continue;
576 }
577
578 // We know all single-entry PHI nodes in the inlined function have been
579 // removed, so we just need to splice the blocks.
580 BI->eraseFromParent();
581
582 // Move all the instructions in the succ to the pred.
583 I->getInstList().splice(I->end(), Dest->getInstList());
584
585 // Make all PHI nodes that referred to Dest now refer to I as their source.
586 Dest->replaceAllUsesWith(I);
587
588 // Remove the dest block.
589 Dest->eraseFromParent();
590
591 // Do not increment I, iteratively merge all things this block branches to.
592 }
593}