1 //===-- DeadArgumentElimination.cpp - Eliminate dead arguments ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass deletes dead arguments from internal functions. Dead argument
11 // elimination removes arguments which are directly dead, as well as arguments
12 // only passed into function calls as dead arguments of other functions. This
13 // pass also deletes dead return values in a similar way.
15 // This pass is often useful as a cleanup pass to run after aggressive
16 // interprocedural passes, which add possibly-dead arguments or return values.
18 //===----------------------------------------------------------------------===//
20 #define DEBUG_TYPE "deadargelim"
21 #include "llvm/Transforms/IPO.h"
22 #include "llvm/CallingConv.h"
23 #include "llvm/Constant.h"
24 #include "llvm/DerivedTypes.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/IntrinsicInst.h"
27 #include "llvm/Module.h"
28 #include "llvm/Pass.h"
29 #include "llvm/Support/CallSite.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/ADT/SmallVector.h"
32 #include "llvm/ADT/Statistic.h"
33 #include "llvm/ADT/StringExtras.h"
34 #include "llvm/Support/Compiler.h"
39 STATISTIC(NumArgumentsEliminated, "Number of unread args removed");
40 STATISTIC(NumRetValsEliminated , "Number of unused return values removed");
43 /// DAE - The dead argument elimination pass.
45 class VISIBILITY_HIDDEN DAE : public ModulePass {
48 /// Struct that represents (part of) either a return value or a function
49 /// argument. Used so that arguments and return values can be used
52 RetOrArg(const Function* F, unsigned Idx, bool IsArg) : F(F), Idx(Idx),
58 /// Make RetOrArg comparable, so we can put it into a map.
59 bool operator<(const RetOrArg &O) const {
62 else if (Idx != O.Idx)
65 return IsArg < O.IsArg;
68 /// Make RetOrArg comparable, so we can easily iterate the multimap.
69 bool operator==(const RetOrArg &O) const {
70 return F == O.F && Idx == O.Idx && IsArg == O.IsArg;
73 std::string getDescription() {
74 return std::string((IsArg ? "Argument #" : "Return value #"))
75 + utostr(Idx) + " of function " + F->getName();
79 /// Liveness enum - During our initial pass over the program, we determine
80 /// that things are either alive or maybe alive. We don't mark anything
81 /// explicitly dead (even if we know they are), since anything not alive
82 /// with no registered uses (in Uses) will never be marked alive and will
83 /// thus become dead in the end.
84 enum Liveness { Live, MaybeLive };
86 /// Convenience wrapper
87 RetOrArg CreateRet(const Function *F, unsigned Idx) {
88 return RetOrArg(F, Idx, false);
90 /// Convenience wrapper
91 RetOrArg CreateArg(const Function *F, unsigned Idx) {
92 return RetOrArg(F, Idx, true);
95 typedef std::multimap<RetOrArg, RetOrArg> UseMap;
96 /// This maps a return value or argument to any MaybeLive return values or
97 /// arguments it uses. This allows the MaybeLive values to be marked live
98 /// when any of its users is marked live.
99 /// For example (indices are left out for clarity):
100 /// - Uses[ret F] = ret G
101 /// This means that F calls G, and F returns the value returned by G.
102 /// - Uses[arg F] = ret G
103 /// This means that some function calls G and passes its result as an
105 /// - Uses[ret F] = arg F
106 /// This means that F returns one of its own arguments.
107 /// - Uses[arg F] = arg G
108 /// This means that G calls F and passes one of its own (G's) arguments
112 typedef std::set<RetOrArg> LiveSet;
114 /// This set contains all values that have been determined to be live.
117 typedef SmallVector<RetOrArg, 5> UseVector;
120 static char ID; // Pass identification, replacement for typeid
121 DAE() : ModulePass((intptr_t)&ID) {}
122 bool runOnModule(Module &M);
124 virtual bool ShouldHackArguments() const { return false; }
127 Liveness MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses);
128 Liveness SurveyUse(Value::use_iterator U, UseVector &MaybeLiveUses,
129 unsigned RetValNum = 0);
130 Liveness SurveyUses(Value *V, UseVector &MaybeLiveUses);
132 void SurveyFunction(Function &F);
133 void MarkValue(const RetOrArg &RA, Liveness L,
134 const UseVector &MaybeLiveUses);
135 void MarkLive(RetOrArg RA);
136 bool RemoveDeadStuffFromFunction(Function *F);
137 bool DeleteDeadVarargs(Function &Fn);
143 static RegisterPass<DAE>
144 X("deadargelim", "Dead Argument Elimination");
147 /// DAH - DeadArgumentHacking pass - Same as dead argument elimination, but
148 /// deletes arguments to functions which are external. This is only for use
150 struct DAH : public DAE {
152 virtual bool ShouldHackArguments() const { return true; }
157 static RegisterPass<DAH>
158 Y("deadarghaX0r", "Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)");
160 /// createDeadArgEliminationPass - This pass removes arguments from functions
161 /// which are not used by the body of the function.
163 ModulePass *llvm::createDeadArgEliminationPass() { return new DAE(); }
164 ModulePass *llvm::createDeadArgHackingPass() { return new DAH(); }
166 /// DeleteDeadVarargs - If this is an function that takes a ... list, and if
167 /// llvm.vastart is never called, the varargs list is dead for the function.
168 bool DAE::DeleteDeadVarargs(Function &Fn) {
169 assert(Fn.getFunctionType()->isVarArg() && "Function isn't varargs!");
170 if (Fn.isDeclaration() || !Fn.hasInternalLinkage()) return false;
172 // Ensure that the function is only directly called.
173 for (Value::use_iterator I = Fn.use_begin(), E = Fn.use_end(); I != E; ++I) {
174 // If this use is anything other than a call site, give up.
175 CallSite CS = CallSite::get(*I);
176 Instruction *TheCall = CS.getInstruction();
177 if (!TheCall) return false; // Not a direct call site?
179 // The addr of this function is passed to the call.
180 if (I.getOperandNo() != 0) return false;
183 // Okay, we know we can transform this function if safe. Scan its body
184 // looking for calls to llvm.vastart.
185 for (Function::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
186 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
187 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
188 if (II->getIntrinsicID() == Intrinsic::vastart)
194 // If we get here, there are no calls to llvm.vastart in the function body,
195 // remove the "..." and adjust all the calls.
197 // Start by computing a new prototype for the function, which is the same as
198 // the old function, but doesn't have isVarArg set.
199 const FunctionType *FTy = Fn.getFunctionType();
200 std::vector<const Type*> Params(FTy->param_begin(), FTy->param_end());
201 FunctionType *NFTy = FunctionType::get(FTy->getReturnType(), Params, false);
202 unsigned NumArgs = Params.size();
204 // Create the new function body and insert it into the module...
205 Function *NF = Function::Create(NFTy, Fn.getLinkage());
206 NF->copyAttributesFrom(&Fn);
207 Fn.getParent()->getFunctionList().insert(&Fn, NF);
210 // Loop over all of the callers of the function, transforming the call sites
211 // to pass in a smaller number of arguments into the new function.
213 std::vector<Value*> Args;
214 while (!Fn.use_empty()) {
215 CallSite CS = CallSite::get(Fn.use_back());
216 Instruction *Call = CS.getInstruction();
218 // Pass all the same arguments.
219 Args.assign(CS.arg_begin(), CS.arg_begin()+NumArgs);
221 // Drop any attributes that were on the vararg arguments.
222 PAListPtr PAL = CS.getParamAttrs();
223 if (!PAL.isEmpty() && PAL.getSlot(PAL.getNumSlots() - 1).Index > NumArgs) {
224 SmallVector<ParamAttrsWithIndex, 8> ParamAttrsVec;
225 for (unsigned i = 0; PAL.getSlot(i).Index <= NumArgs; ++i)
226 ParamAttrsVec.push_back(PAL.getSlot(i));
227 PAL = PAListPtr::get(ParamAttrsVec.begin(), ParamAttrsVec.end());
231 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
232 New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
233 Args.begin(), Args.end(), "", Call);
234 cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
235 cast<InvokeInst>(New)->setParamAttrs(PAL);
237 New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
238 cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
239 cast<CallInst>(New)->setParamAttrs(PAL);
240 if (cast<CallInst>(Call)->isTailCall())
241 cast<CallInst>(New)->setTailCall();
245 if (!Call->use_empty())
246 Call->replaceAllUsesWith(New);
250 // Finally, remove the old call from the program, reducing the use-count of
252 Call->eraseFromParent();
255 // Since we have now created the new function, splice the body of the old
256 // function right into the new function, leaving the old rotting hulk of the
258 NF->getBasicBlockList().splice(NF->begin(), Fn.getBasicBlockList());
260 // Loop over the argument list, transfering uses of the old arguments over to
261 // the new arguments, also transfering over the names as well. While we're at
262 // it, remove the dead arguments from the DeadArguments list.
264 for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end(),
265 I2 = NF->arg_begin(); I != E; ++I, ++I2) {
266 // Move the name and users over to the new version.
267 I->replaceAllUsesWith(I2);
271 // Finally, nuke the old function.
272 Fn.eraseFromParent();
276 /// Convenience function that returns the number of return values. It returns 0
277 /// for void functions and 1 for functions not returning a struct. It returns
278 /// the number of struct elements for functions returning a struct.
279 static unsigned NumRetVals(const Function *F) {
280 if (F->getReturnType() == Type::VoidTy)
282 else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType()))
283 return STy->getNumElements();
288 /// MarkIfNotLive - This checks Use for liveness in LiveValues. If Use is not
289 /// live, it adds Use to the MaybeLiveUses argument. Returns the determined
291 DAE::Liveness DAE::MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses) {
292 // We're live if our use is already marked as live.
293 if (LiveValues.count(Use))
296 // We're maybe live otherwise, but remember that we must become live if
298 MaybeLiveUses.push_back(Use);
303 /// SurveyUse - This looks at a single use of an argument or return value
304 /// and determines if it should be alive or not. Adds this use to MaybeLiveUses
305 /// if it causes the used value to become MaybeAlive.
307 /// RetValNum is the return value number to use when this use is used in a
308 /// return instruction. This is used in the recursion, you should always leave
310 DAE::Liveness DAE::SurveyUse(Value::use_iterator U, UseVector &MaybeLiveUses,
311 unsigned RetValNum) {
313 if (ReturnInst *RI = dyn_cast<ReturnInst>(V)) {
314 // The value is returned from a function. It's only live when the
315 // function's return value is live. We use RetValNum here, for the case
316 // that U is really a use of an insertvalue instruction that uses the
318 RetOrArg Use = CreateRet(RI->getParent()->getParent(), RetValNum);
319 // We might be live, depending on the liveness of Use.
320 return MarkIfNotLive(Use, MaybeLiveUses);
322 if (InsertValueInst *IV = dyn_cast<InsertValueInst>(V)) {
323 if (U.getOperandNo() != InsertValueInst::getAggregateOperandIndex()
325 // The use we are examining is inserted into an aggregate. Our liveness
326 // depends on all uses of that aggregate, but if it is used as a return
327 // value, only index at which we were inserted counts.
328 RetValNum = *IV->idx_begin();
330 // Note that if we are used as the aggregate operand to the insertvalue,
331 // we don't change RetValNum, but do survey all our uses.
333 Liveness Result = MaybeLive;
334 for (Value::use_iterator I = IV->use_begin(),
335 E = V->use_end(); I != E; ++I) {
336 Result = SurveyUse(I, MaybeLiveUses, RetValNum);
342 CallSite CS = CallSite::get(V);
343 if (CS.getInstruction()) {
344 Function *F = CS.getCalledFunction();
346 // Used in a direct call.
348 // Find the argument number. We know for sure that this use is an
349 // argument, since if it was the function argument this would be an
350 // indirect call and the we know can't be looking at a value of the
351 // label type (for the invoke instruction).
352 unsigned ArgNo = CS.getArgumentNo(U.getOperandNo());
354 if (ArgNo >= F->getFunctionType()->getNumParams())
355 // The value is passed in through a vararg! Must be live.
358 assert(CS.getArgument(ArgNo)
359 == CS.getInstruction()->getOperand(U.getOperandNo())
360 && "Argument is not where we expected it");
362 // Value passed to a normal call. It's only live when the corresponding
363 // argument to the called function turns out live.
364 RetOrArg Use = CreateArg(F, ArgNo);
365 return MarkIfNotLive(Use, MaybeLiveUses);
368 // Used in any other way? Value must be live.
372 /// SurveyUses - This looks at all the uses of the given value
373 /// Returns the Liveness deduced from the uses of this value.
375 /// Adds all uses that cause the result to be MaybeLive to MaybeLiveRetUses. If
376 /// the result is Live, MaybeLiveUses might be modified but its content should
377 /// be ignored (since it might not be complete).
378 DAE::Liveness DAE::SurveyUses(Value *V, UseVector &MaybeLiveUses) {
379 // Assume it's dead (which will only hold if there are no uses at all..).
380 Liveness Result = MaybeLive;
382 for (Value::use_iterator I = V->use_begin(),
383 E = V->use_end(); I != E; ++I) {
384 Result = SurveyUse(I, MaybeLiveUses);
391 // SurveyFunction - This performs the initial survey of the specified function,
392 // checking out whether or not it uses any of its incoming arguments or whether
393 // any callers use the return value. This fills in the LiveValues set and Uses
396 // We consider arguments of non-internal functions to be intrinsically alive as
397 // well as arguments to functions which have their "address taken".
399 void DAE::SurveyFunction(Function &F) {
400 bool FunctionIntrinsicallyLive = false;
401 unsigned RetCount = NumRetVals(&F);
402 // Assume all return values are dead
403 typedef SmallVector<Liveness, 5> RetVals;
404 RetVals RetValLiveness(RetCount, MaybeLive);
406 typedef SmallVector<UseVector, 5> RetUses;
407 // These vectors map each return value to the uses that make it MaybeLive, so
408 // we can add those to the Uses map if the return value really turns out to be
409 // MaybeLive. Initialized to a list of RetCount empty lists.
410 RetUses MaybeLiveRetUses(RetCount);
412 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
413 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
414 if (RI->getNumOperands() != 0 && RI->getOperand(0)->getType()
415 != F.getFunctionType()->getReturnType()) {
416 // We don't support old style multiple return values.
417 FunctionIntrinsicallyLive = true;
421 if (!F.hasInternalLinkage() && (!ShouldHackArguments() || F.isIntrinsic()))
422 FunctionIntrinsicallyLive = true;
424 if (!FunctionIntrinsicallyLive) {
425 DOUT << "DAE - Inspecting callers for fn: " << F.getName() << "\n";
426 // Keep track of the number of live retvals, so we can skip checks once all
427 // of them turn out to be live.
428 unsigned NumLiveRetVals = 0;
429 const Type *STy = dyn_cast<StructType>(F.getReturnType());
430 // Loop all uses of the function.
431 for (Value::use_iterator I = F.use_begin(), E = F.use_end(); I != E; ++I) {
432 // If the function is PASSED IN as an argument, its address has been
434 if (I.getOperandNo() != 0) {
435 FunctionIntrinsicallyLive = true;
439 // If this use is anything other than a call site, the function is alive.
440 CallSite CS = CallSite::get(*I);
441 Instruction *TheCall = CS.getInstruction();
442 if (!TheCall) { // Not a direct call site?
443 FunctionIntrinsicallyLive = true;
447 // If we end up here, we are looking at a direct call to our function.
449 // Now, check how our return value(s) is/are used in this caller. Don't
450 // bother checking return values if all of them are live already.
451 if (NumLiveRetVals != RetCount) {
453 // Check all uses of the return value.
454 for (Value::use_iterator I = TheCall->use_begin(),
455 E = TheCall->use_end(); I != E; ++I) {
456 ExtractValueInst *Ext = dyn_cast<ExtractValueInst>(*I);
457 if (Ext && Ext->hasIndices()) {
458 // This use uses a part of our return value, survey the uses of
459 // that part and store the results for this index only.
460 unsigned Idx = *Ext->idx_begin();
461 if (RetValLiveness[Idx] != Live) {
462 RetValLiveness[Idx] = SurveyUses(Ext, MaybeLiveRetUses[Idx]);
463 if (RetValLiveness[Idx] == Live)
467 // Used by something else than extractvalue. Mark all return
469 for (unsigned i = 0; i != RetCount; ++i )
470 RetValLiveness[i] = Live;
471 NumLiveRetVals = RetCount;
476 // Single return value
477 RetValLiveness[0] = SurveyUses(TheCall, MaybeLiveRetUses[0]);
478 if (RetValLiveness[0] == Live)
479 NumLiveRetVals = RetCount;
484 if (FunctionIntrinsicallyLive) {
485 DOUT << "DAE - Intrinsically live fn: " << F.getName() << "\n";
486 // Mark all arguments as live.
488 for (unsigned i = 0, e = F.arg_size(); i != e; ++i)
489 MarkLive(CreateArg(&F, i));
490 // Mark all return values as live.
492 for (unsigned i = 0; i != RetCount; ++i)
493 MarkLive(CreateRet(&F, i));
497 // Now we've inspected all callers, record the liveness of our return values.
498 for (unsigned i = 0; i != RetCount; ++i)
499 MarkValue(CreateRet(&F, i), RetValLiveness[i], MaybeLiveRetUses[i]);
501 DOUT << "DAE - Inspecting args for fn: " << F.getName() << "\n";
503 // Now, check all of our arguments.
505 UseVector MaybeLiveArgUses;
506 for (Function::arg_iterator AI = F.arg_begin(),
507 E = F.arg_end(); AI != E; ++AI, ++i) {
508 // See what the effect of this use is (recording any uses that cause
509 // MaybeLive in MaybeLiveArgUses).
510 Liveness Result = SurveyUses(AI, MaybeLiveArgUses);
512 MarkValue(CreateArg(&F, i), Result, MaybeLiveArgUses);
513 // Clear the vector again for the next iteration.
514 MaybeLiveArgUses.clear();
518 /// MarkValue - This function marks the liveness of RA depending on L. If L is
519 /// MaybeLive, it also takes all uses in MaybeLiveUses and records them in Uses,
520 /// such that RA will be marked live if any use in MaybeLiveUses gets marked
522 void DAE::MarkValue(const RetOrArg &RA, Liveness L,
523 const UseVector &MaybeLiveUses) {
525 case Live: MarkLive(RA); break;
528 // Note any uses of this value, so this return value can be
529 // marked live whenever one of the uses becomes live.
530 for (UseVector::const_iterator UI = MaybeLiveUses.begin(),
531 UE = MaybeLiveUses.end(); UI != UE; ++UI)
532 Uses.insert(std::make_pair(*UI, RA));
538 /// MarkLive - Mark the given return value or argument as live. Additionally,
539 /// mark any values that are used by this value (according to Uses) live as
541 void DAE::MarkLive(RetOrArg RA) {
542 if (!LiveValues.insert(RA).second)
543 return; // We were already marked Live.
546 DOUT << "DAE - Marking argument " << RA.Idx << " to function "
547 << RA.F->getNameStart() << " live\n";
549 DOUT << "DAE - Marking return value " << RA.Idx << " of function "
550 << RA.F->getNameStart() << " live\n";
552 // We don't use upper_bound (or equal_range) here, because our recursive call
553 // to ourselves is likely to cause the upper_bound (which is the first value
554 // not belonging to RA) to become erased and the iterator invalidated.
555 UseMap::iterator Begin = Uses.lower_bound(RA);
556 UseMap::iterator E = Uses.end();
558 for (I = Begin; I != E && I->first == RA; ++I)
561 // Erase RA from the Uses map (from the lower bound to wherever we ended up
563 Uses.erase(Begin, I);
566 // RemoveDeadStuffFromFunction - Remove any arguments and return values from F
567 // that are not in LiveValues. Transform the function and all of the callees of
568 // the function to not have these arguments and return values.
570 bool DAE::RemoveDeadStuffFromFunction(Function *F) {
571 // Quick exit path for external functions
572 if (!F->hasInternalLinkage() && (!ShouldHackArguments() || F->isIntrinsic()))
575 // Start by computing a new prototype for the function, which is the same as
576 // the old function, but has fewer arguments and a different return type.
577 const FunctionType *FTy = F->getFunctionType();
578 std::vector<const Type*> Params;
580 // Set up to build a new list of parameter attributes.
581 SmallVector<ParamAttrsWithIndex, 8> ParamAttrsVec;
582 const PAListPtr &PAL = F->getParamAttrs();
584 // The existing function return attributes.
585 ParameterAttributes RAttrs = PAL.getParamAttrs(0);
588 // Find out the new return value.
590 const Type *RetTy = FTy->getReturnType();
591 const Type *NRetTy = NULL;
592 unsigned RetCount = NumRetVals(F);
593 // Explicitly track if anything changed, for debugging.
594 bool Changed = false;
595 // -1 means unused, other numbers are the new index
596 SmallVector<int, 5> NewRetIdxs(RetCount, -1);
597 std::vector<const Type*> RetTypes;
598 if (RetTy == Type::VoidTy) {
599 NRetTy = Type::VoidTy;
601 const StructType *STy = dyn_cast<StructType>(RetTy);
603 // Look at each of the original return values individually.
604 for (unsigned i = 0; i != RetCount; ++i) {
605 RetOrArg Ret = CreateRet(F, i);
606 if (LiveValues.erase(Ret)) {
607 RetTypes.push_back(STy->getElementType(i));
608 NewRetIdxs[i] = RetTypes.size() - 1;
610 ++NumRetValsEliminated;
611 DOUT << "DAE - Removing return value " << i << " from "
612 << F->getNameStart() << "\n";
617 // We used to return a single value.
618 if (LiveValues.erase(CreateRet(F, 0))) {
619 RetTypes.push_back(RetTy);
622 DOUT << "DAE - Removing return value from " << F->getNameStart()
624 ++NumRetValsEliminated;
627 if (RetTypes.size() > 1 || (STy && STy->getNumElements()==RetTypes.size()))
628 // More than one return type? Return a struct with them. Also, if we used
629 // to return a struct and didn't change the number of return values,
630 // return a struct again. This prevents changing {something} into
631 // something and {} into void.
632 // Make the new struct packed if we used to return a packed struct
634 NRetTy = StructType::get(RetTypes, STy->isPacked());
635 else if (RetTypes.size() == 1)
636 // One return type? Just a simple value then, but only if we didn't use to
637 // return a struct with that simple value before.
638 NRetTy = RetTypes.front();
639 else if (RetTypes.size() == 0)
640 // No return types? Make it void, but only if we didn't use to return {}.
641 NRetTy = Type::VoidTy;
644 assert(NRetTy && "No new return type found?");
646 // Remove any incompatible attributes, but only if we removed all return
647 // values. Otherwise, ensure that we don't have any conflicting attributes
648 // here. Currently, this should not be possible, but special handling might be
649 // required when new return value attributes are added.
650 if (NRetTy == Type::VoidTy)
651 RAttrs &= ~ParamAttr::typeIncompatible(NRetTy);
653 assert((RAttrs & ParamAttr::typeIncompatible(NRetTy)) == 0
654 && "Return attributes no longer compatible?");
657 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(0, RAttrs));
659 // Remember which arguments are still alive.
660 SmallVector<bool, 10> ArgAlive(FTy->getNumParams(), false);
661 // Construct the new parameter list from non-dead arguments. Also construct
662 // a new set of parameter attributes to correspond. Skip the first parameter
663 // attribute, since that belongs to the return value.
665 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
667 RetOrArg Arg = CreateArg(F, i);
668 if (LiveValues.erase(Arg)) {
669 Params.push_back(I->getType());
672 // Get the original parameter attributes (skipping the first one, that is
673 // for the return value.
674 if (ParameterAttributes Attrs = PAL.getParamAttrs(i + 1))
675 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Params.size(), Attrs));
677 ++NumArgumentsEliminated;
678 DOUT << "DAE - Removing argument " << i << " (" << I->getNameStart()
679 << ") from " << F->getNameStart() << "\n";
684 // Reconstruct the ParamAttrsList based on the vector we constructed.
685 PAListPtr NewPAL = PAListPtr::get(ParamAttrsVec.begin(), ParamAttrsVec.end());
687 // Work around LLVM bug PR56: the CWriter cannot emit varargs functions which
688 // have zero fixed arguments.
690 // Note that we apply this hack for a vararg fuction that does not have any
691 // arguments anymore, but did have them before (so don't bother fixing
692 // functions that were already broken wrt CWriter).
693 bool ExtraArgHack = false;
694 if (Params.empty() && FTy->isVarArg() && FTy->getNumParams() != 0) {
696 Params.push_back(Type::Int32Ty);
699 // Create the new function type based on the recomputed parameters.
700 FunctionType *NFTy = FunctionType::get(NRetTy, Params, FTy->isVarArg());
706 // The function type is only allowed to be different if we actually left out
707 // an argument or return value.
708 assert(Changed && "Function type changed while no arguments or return values"
711 // Create the new function body and insert it into the module...
712 Function *NF = Function::Create(NFTy, F->getLinkage());
713 NF->copyAttributesFrom(F);
714 NF->setParamAttrs(NewPAL);
715 // Insert the new function before the old function, so we won't be processing
717 F->getParent()->getFunctionList().insert(F, NF);
720 // Loop over all of the callers of the function, transforming the call sites
721 // to pass in a smaller number of arguments into the new function.
723 std::vector<Value*> Args;
724 while (!F->use_empty()) {
725 CallSite CS = CallSite::get(F->use_back());
726 Instruction *Call = CS.getInstruction();
728 ParamAttrsVec.clear();
729 const PAListPtr &CallPAL = CS.getParamAttrs();
731 // The call return attributes.
732 ParameterAttributes RAttrs = CallPAL.getParamAttrs(0);
733 // Adjust in case the function was changed to return void.
734 RAttrs &= ~ParamAttr::typeIncompatible(NF->getReturnType());
736 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(0, RAttrs));
738 // Declare these outside of the loops, so we can reuse them for the second
739 // loop, which loops the varargs.
740 CallSite::arg_iterator I = CS.arg_begin();
742 // Loop over those operands, corresponding to the normal arguments to the
743 // original function, and add those that are still alive.
744 for (unsigned e = FTy->getNumParams(); i != e; ++I, ++i)
747 // Get original parameter attributes, but skip return attributes.
748 if (ParameterAttributes Attrs = CallPAL.getParamAttrs(i + 1))
749 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Args.size(), Attrs));
753 Args.push_back(UndefValue::get(Type::Int32Ty));
755 // Push any varargs arguments on the list. Don't forget their attributes.
756 for (CallSite::arg_iterator E = CS.arg_end(); I != E; ++I, ++i) {
758 if (ParameterAttributes Attrs = CallPAL.getParamAttrs(i + 1))
759 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Args.size(), Attrs));
762 // Reconstruct the ParamAttrsList based on the vector we constructed.
763 PAListPtr NewCallPAL = PAListPtr::get(ParamAttrsVec.begin(),
764 ParamAttrsVec.end());
767 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
768 New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
769 Args.begin(), Args.end(), "", Call);
770 cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
771 cast<InvokeInst>(New)->setParamAttrs(NewCallPAL);
773 New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
774 cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
775 cast<CallInst>(New)->setParamAttrs(NewCallPAL);
776 if (cast<CallInst>(Call)->isTailCall())
777 cast<CallInst>(New)->setTailCall();
781 if (!Call->use_empty()) {
782 if (New->getType() == Call->getType()) {
783 // Return type not changed? Just replace users then.
784 Call->replaceAllUsesWith(New);
786 } else if (New->getType() == Type::VoidTy) {
787 // Our return value has uses, but they will get removed later on.
788 // Replace by null for now.
789 Call->replaceAllUsesWith(Constant::getNullValue(Call->getType()));
791 assert(isa<StructType>(RetTy) && "Return type changed, but not into a"
792 "void. The old return type must have"
794 // The original return value was a struct, update all uses (which are
795 // all extractvalue instructions).
796 for (Value::use_iterator I = Call->use_begin(), E = Call->use_end();
798 assert(isa<ExtractValueInst>(*I) && "Return value not only used by"
800 ExtractValueInst *EV = cast<ExtractValueInst>(*I);
801 // Increment now, since we're about to throw away this use.
803 assert(EV->hasIndices() && "Return value used by extractvalue without"
805 unsigned Idx = *EV->idx_begin();
806 if (NewRetIdxs[Idx] != -1) {
807 if (RetTypes.size() > 1) {
808 // We're still returning a struct, create a new extractvalue
809 // instruction with the first index updated
810 std::vector<unsigned> NewIdxs(EV->idx_begin(), EV->idx_end());
811 NewIdxs[0] = NewRetIdxs[Idx];
812 Value *NEV = ExtractValueInst::Create(New, NewIdxs.begin(),
813 NewIdxs.end(), "retval",
815 EV->replaceAllUsesWith(NEV);
816 EV->eraseFromParent();
818 // We are now only returning a simple value, remove the
820 EV->replaceAllUsesWith(New);
821 EV->eraseFromParent();
824 // Value unused, replace uses by null for now, they will get removed
826 EV->replaceAllUsesWith(Constant::getNullValue(EV->getType()));
827 EV->eraseFromParent();
834 // Finally, remove the old call from the program, reducing the use-count of
836 Call->eraseFromParent();
839 // Since we have now created the new function, splice the body of the old
840 // function right into the new function, leaving the old rotting hulk of the
842 NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
844 // Loop over the argument list, transfering uses of the old arguments over to
845 // the new arguments, also transfering over the names as well.
847 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(),
848 I2 = NF->arg_begin(); I != E; ++I, ++i)
850 // If this is a live argument, move the name and users over to the new
852 I->replaceAllUsesWith(I2);
856 // If this argument is dead, replace any uses of it with null constants
857 // (these are guaranteed to become unused later on).
858 I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
861 // If we change the return value of the function we must rewrite any return
862 // instructions. Check this now.
863 if (F->getReturnType() != NF->getReturnType())
864 for (Function::iterator BB = NF->begin(), E = NF->end(); BB != E; ++BB)
865 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
868 if (NFTy->getReturnType() == Type::VoidTy) {
871 assert (isa<StructType>(RetTy));
872 // The original return value was a struct, insert
873 // extractvalue/insertvalue chains to extract only the values we need
874 // to return and insert them into our new result.
875 // This does generate messy code, but we'll let it to instcombine to
877 Value *OldRet = RI->getOperand(0);
878 // Start out building up our return value from undef
879 RetVal = llvm::UndefValue::get(NRetTy);
880 for (unsigned i = 0; i != RetCount; ++i)
881 if (NewRetIdxs[i] != -1) {
882 ExtractValueInst *EV = ExtractValueInst::Create(OldRet, i,
884 if (RetTypes.size() > 1) {
885 // We're still returning a struct, so reinsert the value into
886 // our new return value at the new index
888 RetVal = InsertValueInst::Create(RetVal, EV, NewRetIdxs[i],
891 // We are now only returning a simple value, so just return the
897 // Replace the return instruction with one returning the new return
898 // value (possibly 0 if we became void).
899 ReturnInst::Create(RetVal, RI);
900 BB->getInstList().erase(RI);
903 // Now that the old function is dead, delete it.
904 F->eraseFromParent();
909 bool DAE::runOnModule(Module &M) {
910 bool Changed = false;
912 // First pass: Do a simple check to see if any functions can have their "..."
913 // removed. We can do this if they never call va_start. This loop cannot be
914 // fused with the next loop, because deleting a function invalidates
915 // information computed while surveying other functions.
916 DOUT << "DAE - Deleting dead varargs\n";
917 for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
919 if (F.getFunctionType()->isVarArg())
920 Changed |= DeleteDeadVarargs(F);
923 // Second phase:loop through the module, determining which arguments are live.
924 // We assume all arguments are dead unless proven otherwise (allowing us to
925 // determine that dead arguments passed into recursive functions are dead).
927 DOUT << "DAE - Determining liveness\n";
928 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
931 // Now, remove all dead arguments and return values from each function in
933 for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
934 // Increment now, because the function will probably get removed (ie
935 // replaced by a new one).
937 Changed |= RemoveDeadStuffFromFunction(F);