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 #include "llvm/Transforms/IPO.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/Statistic.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/IR/CallSite.h"
26 #include "llvm/IR/CallingConv.h"
27 #include "llvm/IR/Constant.h"
28 #include "llvm/IR/DIBuilder.h"
29 #include "llvm/IR/DebugInfo.h"
30 #include "llvm/IR/DerivedTypes.h"
31 #include "llvm/IR/Instructions.h"
32 #include "llvm/IR/IntrinsicInst.h"
33 #include "llvm/IR/LLVMContext.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/Pass.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/raw_ostream.h"
43 #define DEBUG_TYPE "deadargelim"
45 STATISTIC(NumArgumentsEliminated, "Number of unread args removed");
46 STATISTIC(NumRetValsEliminated , "Number of unused return values removed");
47 STATISTIC(NumArgumentsReplacedWithUndef,
48 "Number of unread args replaced with undef");
50 /// DAE - The dead argument elimination pass.
52 class DAE : public ModulePass {
55 /// Struct that represents (part of) either a return value or a function
56 /// argument. Used so that arguments and return values can be used
59 RetOrArg(const Function *F, unsigned Idx, bool IsArg) : F(F), Idx(Idx),
65 /// Make RetOrArg comparable, so we can put it into a map.
66 bool operator<(const RetOrArg &O) const {
67 return std::tie(F, Idx, IsArg) < std::tie(O.F, O.Idx, O.IsArg);
70 /// Make RetOrArg comparable, so we can easily iterate the multimap.
71 bool operator==(const RetOrArg &O) const {
72 return F == O.F && Idx == O.Idx && IsArg == O.IsArg;
75 std::string getDescription() const {
76 return std::string((IsArg ? "Argument #" : "Return value #"))
77 + utostr(Idx) + " of function " + F->getName().str();
81 /// Liveness enum - During our initial pass over the program, we determine
82 /// that things are either alive or maybe alive. We don't mark anything
83 /// explicitly dead (even if we know they are), since anything not alive
84 /// with no registered uses (in Uses) will never be marked alive and will
85 /// thus become dead in the end.
86 enum Liveness { Live, MaybeLive };
88 /// Convenience wrapper
89 RetOrArg CreateRet(const Function *F, unsigned Idx) {
90 return RetOrArg(F, Idx, false);
92 /// Convenience wrapper
93 RetOrArg CreateArg(const Function *F, unsigned Idx) {
94 return RetOrArg(F, Idx, true);
97 typedef std::multimap<RetOrArg, RetOrArg> UseMap;
98 /// This maps a return value or argument to any MaybeLive return values or
99 /// arguments it uses. This allows the MaybeLive values to be marked live
100 /// when any of its users is marked live.
101 /// For example (indices are left out for clarity):
102 /// - Uses[ret F] = ret G
103 /// This means that F calls G, and F returns the value returned by G.
104 /// - Uses[arg F] = ret G
105 /// This means that some function calls G and passes its result as an
107 /// - Uses[ret F] = arg F
108 /// This means that F returns one of its own arguments.
109 /// - Uses[arg F] = arg G
110 /// This means that G calls F and passes one of its own (G's) arguments
114 typedef std::set<RetOrArg> LiveSet;
115 typedef std::set<const Function*> LiveFuncSet;
117 /// This set contains all values that have been determined to be live.
119 /// This set contains all values that are cannot be changed in any way.
120 LiveFuncSet LiveFunctions;
122 typedef SmallVector<RetOrArg, 5> UseVector;
124 // Map each LLVM function to corresponding metadata with debug info. If
125 // the function is replaced with another one, we should patch the pointer
126 // to LLVM function in metadata.
127 // As the code generation for module is finished (and DIBuilder is
128 // finalized) we assume that subprogram descriptors won't be changed, and
129 // they are stored in map for short duration anyway.
130 DenseMap<const Function *, DISubprogram> FunctionDIs;
133 // DAH uses this to specify a different ID.
134 explicit DAE(char &ID) : ModulePass(ID) {}
137 static char ID; // Pass identification, replacement for typeid
138 DAE() : ModulePass(ID) {
139 initializeDAEPass(*PassRegistry::getPassRegistry());
142 bool runOnModule(Module &M) override;
144 virtual bool ShouldHackArguments() const { return false; }
147 Liveness MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses);
148 Liveness SurveyUse(const Use *U, UseVector &MaybeLiveUses,
149 unsigned RetValNum = 0);
150 Liveness SurveyUses(const Value *V, UseVector &MaybeLiveUses);
152 void SurveyFunction(const Function &F);
153 void MarkValue(const RetOrArg &RA, Liveness L,
154 const UseVector &MaybeLiveUses);
155 void MarkLive(const RetOrArg &RA);
156 void MarkLive(const Function &F);
157 void PropagateLiveness(const RetOrArg &RA);
158 bool RemoveDeadStuffFromFunction(Function *F);
159 bool DeleteDeadVarargs(Function &Fn);
160 bool RemoveDeadArgumentsFromCallers(Function &Fn);
166 INITIALIZE_PASS(DAE, "deadargelim", "Dead Argument Elimination", false, false)
169 /// DAH - DeadArgumentHacking pass - Same as dead argument elimination, but
170 /// deletes arguments to functions which are external. This is only for use
172 struct DAH : public DAE {
176 bool ShouldHackArguments() const override { return true; }
181 INITIALIZE_PASS(DAH, "deadarghaX0r",
182 "Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)",
185 /// createDeadArgEliminationPass - This pass removes arguments from functions
186 /// which are not used by the body of the function.
188 ModulePass *llvm::createDeadArgEliminationPass() { return new DAE(); }
189 ModulePass *llvm::createDeadArgHackingPass() { return new DAH(); }
191 /// DeleteDeadVarargs - If this is an function that takes a ... list, and if
192 /// llvm.vastart is never called, the varargs list is dead for the function.
193 bool DAE::DeleteDeadVarargs(Function &Fn) {
194 assert(Fn.getFunctionType()->isVarArg() && "Function isn't varargs!");
195 if (Fn.isDeclaration() || !Fn.hasLocalLinkage()) return false;
197 // Ensure that the function is only directly called.
198 if (Fn.hasAddressTaken())
201 // Okay, we know we can transform this function if safe. Scan its body
202 // looking for calls marked musttail or calls to llvm.vastart.
203 for (Function::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
204 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
205 CallInst *CI = dyn_cast<CallInst>(I);
208 if (CI->isMustTailCall())
210 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI)) {
211 if (II->getIntrinsicID() == Intrinsic::vastart)
217 // If we get here, there are no calls to llvm.vastart in the function body,
218 // remove the "..." and adjust all the calls.
220 // Start by computing a new prototype for the function, which is the same as
221 // the old function, but doesn't have isVarArg set.
222 FunctionType *FTy = Fn.getFunctionType();
224 std::vector<Type*> Params(FTy->param_begin(), FTy->param_end());
225 FunctionType *NFTy = FunctionType::get(FTy->getReturnType(),
227 unsigned NumArgs = Params.size();
229 // Create the new function body and insert it into the module...
230 Function *NF = Function::Create(NFTy, Fn.getLinkage());
231 NF->copyAttributesFrom(&Fn);
232 Fn.getParent()->getFunctionList().insert(&Fn, NF);
235 // Loop over all of the callers of the function, transforming the call sites
236 // to pass in a smaller number of arguments into the new function.
238 std::vector<Value*> Args;
239 for (Value::user_iterator I = Fn.user_begin(), E = Fn.user_end(); I != E; ) {
243 Instruction *Call = CS.getInstruction();
245 // Pass all the same arguments.
246 Args.assign(CS.arg_begin(), CS.arg_begin() + NumArgs);
248 // Drop any attributes that were on the vararg arguments.
249 AttributeSet PAL = CS.getAttributes();
250 if (!PAL.isEmpty() && PAL.getSlotIndex(PAL.getNumSlots() - 1) > NumArgs) {
251 SmallVector<AttributeSet, 8> AttributesVec;
252 for (unsigned i = 0; PAL.getSlotIndex(i) <= NumArgs; ++i)
253 AttributesVec.push_back(PAL.getSlotAttributes(i));
254 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
255 AttributesVec.push_back(AttributeSet::get(Fn.getContext(),
256 PAL.getFnAttributes()));
257 PAL = AttributeSet::get(Fn.getContext(), AttributesVec);
261 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
262 New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
264 cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
265 cast<InvokeInst>(New)->setAttributes(PAL);
267 New = CallInst::Create(NF, Args, "", Call);
268 cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
269 cast<CallInst>(New)->setAttributes(PAL);
270 if (cast<CallInst>(Call)->isTailCall())
271 cast<CallInst>(New)->setTailCall();
273 New->setDebugLoc(Call->getDebugLoc());
277 if (!Call->use_empty())
278 Call->replaceAllUsesWith(New);
282 // Finally, remove the old call from the program, reducing the use-count of
284 Call->eraseFromParent();
287 // Since we have now created the new function, splice the body of the old
288 // function right into the new function, leaving the old rotting hulk of the
290 NF->getBasicBlockList().splice(NF->begin(), Fn.getBasicBlockList());
292 // Loop over the argument list, transferring uses of the old arguments over to
293 // the new arguments, also transferring over the names as well. While we're at
294 // it, remove the dead arguments from the DeadArguments list.
296 for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end(),
297 I2 = NF->arg_begin(); I != E; ++I, ++I2) {
298 // Move the name and users over to the new version.
299 I->replaceAllUsesWith(I2);
303 // Patch the pointer to LLVM function in debug info descriptor.
304 auto DI = FunctionDIs.find(&Fn);
305 if (DI != FunctionDIs.end()) {
306 DISubprogram SP = DI->second;
307 SP.replaceFunction(NF);
308 // Ensure the map is updated so it can be reused on non-varargs argument
309 // eliminations of the same function.
310 FunctionDIs.erase(DI);
311 FunctionDIs[NF] = SP;
314 // Fix up any BlockAddresses that refer to the function.
315 Fn.replaceAllUsesWith(ConstantExpr::getBitCast(NF, Fn.getType()));
316 // Delete the bitcast that we just created, so that NF does not
317 // appear to be address-taken.
318 NF->removeDeadConstantUsers();
319 // Finally, nuke the old function.
320 Fn.eraseFromParent();
324 /// RemoveDeadArgumentsFromCallers - Checks if the given function has any
325 /// arguments that are unused, and changes the caller parameters to be undefined
327 bool DAE::RemoveDeadArgumentsFromCallers(Function &Fn)
329 if (Fn.isDeclaration() || Fn.mayBeOverridden())
332 // Functions with local linkage should already have been handled, except the
333 // fragile (variadic) ones which we can improve here.
334 if (Fn.hasLocalLinkage() && !Fn.getFunctionType()->isVarArg())
337 // If a function seen at compile time is not necessarily the one linked to
338 // the binary being built, it is illegal to change the actual arguments
339 // passed to it. These functions can be captured by isWeakForLinker().
340 // *NOTE* that mayBeOverridden() is insufficient for this purpose as it
341 // doesn't include linkage types like AvailableExternallyLinkage and
342 // LinkOnceODRLinkage. Take link_odr* as an example, it indicates a set of
343 // *EQUIVALENT* globals that can be merged at link-time. However, the
344 // semantic of *EQUIVALENT*-functions includes parameters. Changing
345 // parameters breaks this assumption.
347 if (Fn.isWeakForLinker())
353 SmallVector<unsigned, 8> UnusedArgs;
354 for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end();
358 if (Arg->use_empty() && !Arg->hasByValOrInAllocaAttr())
359 UnusedArgs.push_back(Arg->getArgNo());
362 if (UnusedArgs.empty())
365 bool Changed = false;
367 for (Use &U : Fn.uses()) {
368 CallSite CS(U.getUser());
369 if (!CS || !CS.isCallee(&U))
372 // Now go through all unused args and replace them with "undef".
373 for (unsigned I = 0, E = UnusedArgs.size(); I != E; ++I) {
374 unsigned ArgNo = UnusedArgs[I];
376 Value *Arg = CS.getArgument(ArgNo);
377 CS.setArgument(ArgNo, UndefValue::get(Arg->getType()));
378 ++NumArgumentsReplacedWithUndef;
386 /// Convenience function that returns the number of return values. It returns 0
387 /// for void functions and 1 for functions not returning a struct. It returns
388 /// the number of struct elements for functions returning a struct.
389 static unsigned NumRetVals(const Function *F) {
390 if (F->getReturnType()->isVoidTy())
392 else if (StructType *STy = dyn_cast<StructType>(F->getReturnType()))
393 return STy->getNumElements();
398 /// MarkIfNotLive - This checks Use for liveness in LiveValues. If Use is not
399 /// live, it adds Use to the MaybeLiveUses argument. Returns the determined
401 DAE::Liveness DAE::MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses) {
402 // We're live if our use or its Function is already marked as live.
403 if (LiveFunctions.count(Use.F) || LiveValues.count(Use))
406 // We're maybe live otherwise, but remember that we must become live if
408 MaybeLiveUses.push_back(Use);
413 /// SurveyUse - This looks at a single use of an argument or return value
414 /// and determines if it should be alive or not. Adds this use to MaybeLiveUses
415 /// if it causes the used value to become MaybeLive.
417 /// RetValNum is the return value number to use when this use is used in a
418 /// return instruction. This is used in the recursion, you should always leave
420 DAE::Liveness DAE::SurveyUse(const Use *U,
421 UseVector &MaybeLiveUses, unsigned RetValNum) {
422 const User *V = U->getUser();
423 if (const ReturnInst *RI = dyn_cast<ReturnInst>(V)) {
424 // The value is returned from a function. It's only live when the
425 // function's return value is live. We use RetValNum here, for the case
426 // that U is really a use of an insertvalue instruction that uses the
428 RetOrArg Use = CreateRet(RI->getParent()->getParent(), RetValNum);
429 // We might be live, depending on the liveness of Use.
430 return MarkIfNotLive(Use, MaybeLiveUses);
432 if (const InsertValueInst *IV = dyn_cast<InsertValueInst>(V)) {
433 if (U->getOperandNo() != InsertValueInst::getAggregateOperandIndex()
435 // The use we are examining is inserted into an aggregate. Our liveness
436 // depends on all uses of that aggregate, but if it is used as a return
437 // value, only index at which we were inserted counts.
438 RetValNum = *IV->idx_begin();
440 // Note that if we are used as the aggregate operand to the insertvalue,
441 // we don't change RetValNum, but do survey all our uses.
443 Liveness Result = MaybeLive;
444 for (const Use &UU : IV->uses()) {
445 Result = SurveyUse(&UU, MaybeLiveUses, RetValNum);
452 if (ImmutableCallSite CS = V) {
453 const Function *F = CS.getCalledFunction();
455 // Used in a direct call.
457 // Find the argument number. We know for sure that this use is an
458 // argument, since if it was the function argument this would be an
459 // indirect call and the we know can't be looking at a value of the
460 // label type (for the invoke instruction).
461 unsigned ArgNo = CS.getArgumentNo(U);
463 if (ArgNo >= F->getFunctionType()->getNumParams())
464 // The value is passed in through a vararg! Must be live.
467 assert(CS.getArgument(ArgNo)
468 == CS->getOperand(U->getOperandNo())
469 && "Argument is not where we expected it");
471 // Value passed to a normal call. It's only live when the corresponding
472 // argument to the called function turns out live.
473 RetOrArg Use = CreateArg(F, ArgNo);
474 return MarkIfNotLive(Use, MaybeLiveUses);
477 // Used in any other way? Value must be live.
481 /// SurveyUses - This looks at all the uses of the given value
482 /// Returns the Liveness deduced from the uses of this value.
484 /// Adds all uses that cause the result to be MaybeLive to MaybeLiveRetUses. If
485 /// the result is Live, MaybeLiveUses might be modified but its content should
486 /// be ignored (since it might not be complete).
487 DAE::Liveness DAE::SurveyUses(const Value *V, UseVector &MaybeLiveUses) {
488 // Assume it's dead (which will only hold if there are no uses at all..).
489 Liveness Result = MaybeLive;
491 for (const Use &U : V->uses()) {
492 Result = SurveyUse(&U, MaybeLiveUses);
499 // SurveyFunction - This performs the initial survey of the specified function,
500 // checking out whether or not it uses any of its incoming arguments or whether
501 // any callers use the return value. This fills in the LiveValues set and Uses
504 // We consider arguments of non-internal functions to be intrinsically alive as
505 // well as arguments to functions which have their "address taken".
507 void DAE::SurveyFunction(const Function &F) {
508 // Functions with inalloca parameters are expecting args in a particular
509 // register and memory layout.
510 if (F.getAttributes().hasAttrSomewhere(Attribute::InAlloca)) {
515 unsigned RetCount = NumRetVals(&F);
516 // Assume all return values are dead
517 typedef SmallVector<Liveness, 5> RetVals;
518 RetVals RetValLiveness(RetCount, MaybeLive);
520 typedef SmallVector<UseVector, 5> RetUses;
521 // These vectors map each return value to the uses that make it MaybeLive, so
522 // we can add those to the Uses map if the return value really turns out to be
523 // MaybeLive. Initialized to a list of RetCount empty lists.
524 RetUses MaybeLiveRetUses(RetCount);
526 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
527 if (const ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
528 if (RI->getNumOperands() != 0 && RI->getOperand(0)->getType()
529 != F.getFunctionType()->getReturnType()) {
530 // We don't support old style multiple return values.
535 if (!F.hasLocalLinkage() && (!ShouldHackArguments() || F.isIntrinsic())) {
540 DEBUG(dbgs() << "DAE - Inspecting callers for fn: " << F.getName() << "\n");
541 // Keep track of the number of live retvals, so we can skip checks once all
542 // of them turn out to be live.
543 unsigned NumLiveRetVals = 0;
544 Type *STy = dyn_cast<StructType>(F.getReturnType());
545 // Loop all uses of the function.
546 for (const Use &U : F.uses()) {
547 // If the function is PASSED IN as an argument, its address has been
549 ImmutableCallSite CS(U.getUser());
550 if (!CS || !CS.isCallee(&U)) {
555 // If this use is anything other than a call site, the function is alive.
556 const Instruction *TheCall = CS.getInstruction();
557 if (!TheCall) { // Not a direct call site?
562 // If we end up here, we are looking at a direct call to our function.
564 // Now, check how our return value(s) is/are used in this caller. Don't
565 // bother checking return values if all of them are live already.
566 if (NumLiveRetVals != RetCount) {
568 // Check all uses of the return value.
569 for (const User *U : TheCall->users()) {
570 const ExtractValueInst *Ext = dyn_cast<ExtractValueInst>(U);
571 if (Ext && Ext->hasIndices()) {
572 // This use uses a part of our return value, survey the uses of
573 // that part and store the results for this index only.
574 unsigned Idx = *Ext->idx_begin();
575 if (RetValLiveness[Idx] != Live) {
576 RetValLiveness[Idx] = SurveyUses(Ext, MaybeLiveRetUses[Idx]);
577 if (RetValLiveness[Idx] == Live)
581 // Used by something else than extractvalue. Mark all return
583 for (unsigned i = 0; i != RetCount; ++i )
584 RetValLiveness[i] = Live;
585 NumLiveRetVals = RetCount;
590 // Single return value
591 RetValLiveness[0] = SurveyUses(TheCall, MaybeLiveRetUses[0]);
592 if (RetValLiveness[0] == Live)
593 NumLiveRetVals = RetCount;
598 // Now we've inspected all callers, record the liveness of our return values.
599 for (unsigned i = 0; i != RetCount; ++i)
600 MarkValue(CreateRet(&F, i), RetValLiveness[i], MaybeLiveRetUses[i]);
602 DEBUG(dbgs() << "DAE - Inspecting args for fn: " << F.getName() << "\n");
604 // Now, check all of our arguments.
606 UseVector MaybeLiveArgUses;
607 for (Function::const_arg_iterator AI = F.arg_begin(),
608 E = F.arg_end(); AI != E; ++AI, ++i) {
610 if (F.getFunctionType()->isVarArg()) {
611 // Variadic functions will already have a va_arg function expanded inside
612 // them, making them potentially very sensitive to ABI changes resulting
613 // from removing arguments entirely, so don't. For example AArch64 handles
614 // register and stack HFAs very differently, and this is reflected in the
615 // IR which has already been generated.
618 // See what the effect of this use is (recording any uses that cause
619 // MaybeLive in MaybeLiveArgUses).
620 Result = SurveyUses(AI, MaybeLiveArgUses);
624 MarkValue(CreateArg(&F, i), Result, MaybeLiveArgUses);
625 // Clear the vector again for the next iteration.
626 MaybeLiveArgUses.clear();
630 /// MarkValue - This function marks the liveness of RA depending on L. If L is
631 /// MaybeLive, it also takes all uses in MaybeLiveUses and records them in Uses,
632 /// such that RA will be marked live if any use in MaybeLiveUses gets marked
634 void DAE::MarkValue(const RetOrArg &RA, Liveness L,
635 const UseVector &MaybeLiveUses) {
637 case Live: MarkLive(RA); break;
640 // Note any uses of this value, so this return value can be
641 // marked live whenever one of the uses becomes live.
642 for (UseVector::const_iterator UI = MaybeLiveUses.begin(),
643 UE = MaybeLiveUses.end(); UI != UE; ++UI)
644 Uses.insert(std::make_pair(*UI, RA));
650 /// MarkLive - Mark the given Function as alive, meaning that it cannot be
651 /// changed in any way. Additionally,
652 /// mark any values that are used as this function's parameters or by its return
653 /// values (according to Uses) live as well.
654 void DAE::MarkLive(const Function &F) {
655 DEBUG(dbgs() << "DAE - Intrinsically live fn: " << F.getName() << "\n");
656 // Mark the function as live.
657 LiveFunctions.insert(&F);
658 // Mark all arguments as live.
659 for (unsigned i = 0, e = F.arg_size(); i != e; ++i)
660 PropagateLiveness(CreateArg(&F, i));
661 // Mark all return values as live.
662 for (unsigned i = 0, e = NumRetVals(&F); i != e; ++i)
663 PropagateLiveness(CreateRet(&F, i));
666 /// MarkLive - Mark the given return value or argument as live. Additionally,
667 /// mark any values that are used by this value (according to Uses) live as
669 void DAE::MarkLive(const RetOrArg &RA) {
670 if (LiveFunctions.count(RA.F))
671 return; // Function was already marked Live.
673 if (!LiveValues.insert(RA).second)
674 return; // We were already marked Live.
676 DEBUG(dbgs() << "DAE - Marking " << RA.getDescription() << " live\n");
677 PropagateLiveness(RA);
680 /// PropagateLiveness - Given that RA is a live value, propagate it's liveness
681 /// to any other values it uses (according to Uses).
682 void DAE::PropagateLiveness(const RetOrArg &RA) {
683 // We don't use upper_bound (or equal_range) here, because our recursive call
684 // to ourselves is likely to cause the upper_bound (which is the first value
685 // not belonging to RA) to become erased and the iterator invalidated.
686 UseMap::iterator Begin = Uses.lower_bound(RA);
687 UseMap::iterator E = Uses.end();
689 for (I = Begin; I != E && I->first == RA; ++I)
692 // Erase RA from the Uses map (from the lower bound to wherever we ended up
694 Uses.erase(Begin, I);
697 // RemoveDeadStuffFromFunction - Remove any arguments and return values from F
698 // that are not in LiveValues. Transform the function and all of the callees of
699 // the function to not have these arguments and return values.
701 bool DAE::RemoveDeadStuffFromFunction(Function *F) {
702 // Don't modify fully live functions
703 if (LiveFunctions.count(F))
706 // Start by computing a new prototype for the function, which is the same as
707 // the old function, but has fewer arguments and a different return type.
708 FunctionType *FTy = F->getFunctionType();
709 std::vector<Type*> Params;
711 // Keep track of if we have a live 'returned' argument
712 bool HasLiveReturnedArg = false;
714 // Set up to build a new list of parameter attributes.
715 SmallVector<AttributeSet, 8> AttributesVec;
716 const AttributeSet &PAL = F->getAttributes();
718 // Remember which arguments are still alive.
719 SmallVector<bool, 10> ArgAlive(FTy->getNumParams(), false);
720 // Construct the new parameter list from non-dead arguments. Also construct
721 // a new set of parameter attributes to correspond. Skip the first parameter
722 // attribute, since that belongs to the return value.
724 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
726 RetOrArg Arg = CreateArg(F, i);
727 if (LiveValues.erase(Arg)) {
728 Params.push_back(I->getType());
731 // Get the original parameter attributes (skipping the first one, that is
732 // for the return value.
733 if (PAL.hasAttributes(i + 1)) {
734 AttrBuilder B(PAL, i + 1);
735 if (B.contains(Attribute::Returned))
736 HasLiveReturnedArg = true;
738 push_back(AttributeSet::get(F->getContext(), Params.size(), B));
741 ++NumArgumentsEliminated;
742 DEBUG(dbgs() << "DAE - Removing argument " << i << " (" << I->getName()
743 << ") from " << F->getName() << "\n");
747 // Find out the new return value.
748 Type *RetTy = FTy->getReturnType();
749 Type *NRetTy = nullptr;
750 unsigned RetCount = NumRetVals(F);
752 // -1 means unused, other numbers are the new index
753 SmallVector<int, 5> NewRetIdxs(RetCount, -1);
754 std::vector<Type*> RetTypes;
756 // If there is a function with a live 'returned' argument but a dead return
757 // value, then there are two possible actions:
758 // 1) Eliminate the return value and take off the 'returned' attribute on the
760 // 2) Retain the 'returned' attribute and treat the return value (but not the
761 // entire function) as live so that it is not eliminated.
763 // It's not clear in the general case which option is more profitable because,
764 // even in the absence of explicit uses of the return value, code generation
765 // is free to use the 'returned' attribute to do things like eliding
766 // save/restores of registers across calls. Whether or not this happens is
767 // target and ABI-specific as well as depending on the amount of register
768 // pressure, so there's no good way for an IR-level pass to figure this out.
770 // Fortunately, the only places where 'returned' is currently generated by
771 // the FE are places where 'returned' is basically free and almost always a
772 // performance win, so the second option can just be used always for now.
774 // This should be revisited if 'returned' is ever applied more liberally.
775 if (RetTy->isVoidTy() || HasLiveReturnedArg) {
778 StructType *STy = dyn_cast<StructType>(RetTy);
780 // Look at each of the original return values individually.
781 for (unsigned i = 0; i != RetCount; ++i) {
782 RetOrArg Ret = CreateRet(F, i);
783 if (LiveValues.erase(Ret)) {
784 RetTypes.push_back(STy->getElementType(i));
785 NewRetIdxs[i] = RetTypes.size() - 1;
787 ++NumRetValsEliminated;
788 DEBUG(dbgs() << "DAE - Removing return value " << i << " from "
789 << F->getName() << "\n");
793 // We used to return a single value.
794 if (LiveValues.erase(CreateRet(F, 0))) {
795 RetTypes.push_back(RetTy);
798 DEBUG(dbgs() << "DAE - Removing return value from " << F->getName()
800 ++NumRetValsEliminated;
802 if (RetTypes.size() > 1)
803 // More than one return type? Return a struct with them. Also, if we used
804 // to return a struct and didn't change the number of return values,
805 // return a struct again. This prevents changing {something} into
806 // something and {} into void.
807 // Make the new struct packed if we used to return a packed struct
809 NRetTy = StructType::get(STy->getContext(), RetTypes, STy->isPacked());
810 else if (RetTypes.size() == 1)
811 // One return type? Just a simple value then, but only if we didn't use to
812 // return a struct with that simple value before.
813 NRetTy = RetTypes.front();
814 else if (RetTypes.size() == 0)
815 // No return types? Make it void, but only if we didn't use to return {}.
816 NRetTy = Type::getVoidTy(F->getContext());
819 assert(NRetTy && "No new return type found?");
821 // The existing function return attributes.
822 AttributeSet RAttrs = PAL.getRetAttributes();
824 // Remove any incompatible attributes, but only if we removed all return
825 // values. Otherwise, ensure that we don't have any conflicting attributes
826 // here. Currently, this should not be possible, but special handling might be
827 // required when new return value attributes are added.
828 if (NRetTy->isVoidTy())
830 AttributeSet::get(NRetTy->getContext(), AttributeSet::ReturnIndex,
831 AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
832 removeAttributes(AttributeFuncs::
833 typeIncompatible(NRetTy, AttributeSet::ReturnIndex),
834 AttributeSet::ReturnIndex));
836 assert(!AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
837 hasAttributes(AttributeFuncs::
838 typeIncompatible(NRetTy, AttributeSet::ReturnIndex),
839 AttributeSet::ReturnIndex) &&
840 "Return attributes no longer compatible?");
842 if (RAttrs.hasAttributes(AttributeSet::ReturnIndex))
843 AttributesVec.push_back(AttributeSet::get(NRetTy->getContext(), RAttrs));
845 if (PAL.hasAttributes(AttributeSet::FunctionIndex))
846 AttributesVec.push_back(AttributeSet::get(F->getContext(),
847 PAL.getFnAttributes()));
849 // Reconstruct the AttributesList based on the vector we constructed.
850 AttributeSet NewPAL = AttributeSet::get(F->getContext(), AttributesVec);
852 // Create the new function type based on the recomputed parameters.
853 FunctionType *NFTy = FunctionType::get(NRetTy, Params, FTy->isVarArg());
859 // Create the new function body and insert it into the module...
860 Function *NF = Function::Create(NFTy, F->getLinkage());
861 NF->copyAttributesFrom(F);
862 NF->setAttributes(NewPAL);
863 // Insert the new function before the old function, so we won't be processing
865 F->getParent()->getFunctionList().insert(F, NF);
868 // Loop over all of the callers of the function, transforming the call sites
869 // to pass in a smaller number of arguments into the new function.
871 std::vector<Value*> Args;
872 while (!F->use_empty()) {
873 CallSite CS(F->user_back());
874 Instruction *Call = CS.getInstruction();
876 AttributesVec.clear();
877 const AttributeSet &CallPAL = CS.getAttributes();
879 // The call return attributes.
880 AttributeSet RAttrs = CallPAL.getRetAttributes();
882 // Adjust in case the function was changed to return void.
884 AttributeSet::get(NF->getContext(), AttributeSet::ReturnIndex,
885 AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
886 removeAttributes(AttributeFuncs::
887 typeIncompatible(NF->getReturnType(),
888 AttributeSet::ReturnIndex),
889 AttributeSet::ReturnIndex));
890 if (RAttrs.hasAttributes(AttributeSet::ReturnIndex))
891 AttributesVec.push_back(AttributeSet::get(NF->getContext(), RAttrs));
893 // Declare these outside of the loops, so we can reuse them for the second
894 // loop, which loops the varargs.
895 CallSite::arg_iterator I = CS.arg_begin();
897 // Loop over those operands, corresponding to the normal arguments to the
898 // original function, and add those that are still alive.
899 for (unsigned e = FTy->getNumParams(); i != e; ++I, ++i)
902 // Get original parameter attributes, but skip return attributes.
903 if (CallPAL.hasAttributes(i + 1)) {
904 AttrBuilder B(CallPAL, i + 1);
905 // If the return type has changed, then get rid of 'returned' on the
906 // call site. The alternative is to make all 'returned' attributes on
907 // call sites keep the return value alive just like 'returned'
908 // attributes on function declaration but it's less clearly a win
909 // and this is not an expected case anyway
910 if (NRetTy != RetTy && B.contains(Attribute::Returned))
911 B.removeAttribute(Attribute::Returned);
913 push_back(AttributeSet::get(F->getContext(), Args.size(), B));
917 // Push any varargs arguments on the list. Don't forget their attributes.
918 for (CallSite::arg_iterator E = CS.arg_end(); I != E; ++I, ++i) {
920 if (CallPAL.hasAttributes(i + 1)) {
921 AttrBuilder B(CallPAL, i + 1);
923 push_back(AttributeSet::get(F->getContext(), Args.size(), B));
927 if (CallPAL.hasAttributes(AttributeSet::FunctionIndex))
928 AttributesVec.push_back(AttributeSet::get(Call->getContext(),
929 CallPAL.getFnAttributes()));
931 // Reconstruct the AttributesList based on the vector we constructed.
932 AttributeSet NewCallPAL = AttributeSet::get(F->getContext(), AttributesVec);
935 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
936 New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
938 cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
939 cast<InvokeInst>(New)->setAttributes(NewCallPAL);
941 New = CallInst::Create(NF, Args, "", Call);
942 cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
943 cast<CallInst>(New)->setAttributes(NewCallPAL);
944 if (cast<CallInst>(Call)->isTailCall())
945 cast<CallInst>(New)->setTailCall();
947 New->setDebugLoc(Call->getDebugLoc());
951 if (!Call->use_empty()) {
952 if (New->getType() == Call->getType()) {
953 // Return type not changed? Just replace users then.
954 Call->replaceAllUsesWith(New);
956 } else if (New->getType()->isVoidTy()) {
957 // Our return value has uses, but they will get removed later on.
958 // Replace by null for now.
959 if (!Call->getType()->isX86_MMXTy())
960 Call->replaceAllUsesWith(Constant::getNullValue(Call->getType()));
962 assert(RetTy->isStructTy() &&
963 "Return type changed, but not into a void. The old return type"
964 " must have been a struct!");
965 Instruction *InsertPt = Call;
966 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
967 BasicBlock::iterator IP = II->getNormalDest()->begin();
968 while (isa<PHINode>(IP)) ++IP;
972 // We used to return a struct. Instead of doing smart stuff with all the
973 // uses of this struct, we will just rebuild it using
974 // extract/insertvalue chaining and let instcombine clean that up.
976 // Start out building up our return value from undef
977 Value *RetVal = UndefValue::get(RetTy);
978 for (unsigned i = 0; i != RetCount; ++i)
979 if (NewRetIdxs[i] != -1) {
981 if (RetTypes.size() > 1)
982 // We are still returning a struct, so extract the value from our
984 V = ExtractValueInst::Create(New, NewRetIdxs[i], "newret",
987 // We are now returning a single element, so just insert that
989 // Insert the value at the old position
990 RetVal = InsertValueInst::Create(RetVal, V, i, "oldret", InsertPt);
992 // Now, replace all uses of the old call instruction with the return
994 Call->replaceAllUsesWith(RetVal);
999 // Finally, remove the old call from the program, reducing the use-count of
1001 Call->eraseFromParent();
1004 // Since we have now created the new function, splice the body of the old
1005 // function right into the new function, leaving the old rotting hulk of the
1007 NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
1009 // Loop over the argument list, transferring uses of the old arguments over to
1010 // the new arguments, also transferring over the names as well.
1012 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(),
1013 I2 = NF->arg_begin(); I != E; ++I, ++i)
1015 // If this is a live argument, move the name and users over to the new
1017 I->replaceAllUsesWith(I2);
1021 // If this argument is dead, replace any uses of it with null constants
1022 // (these are guaranteed to become unused later on).
1023 if (!I->getType()->isX86_MMXTy())
1024 I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
1027 // If we change the return value of the function we must rewrite any return
1028 // instructions. Check this now.
1029 if (F->getReturnType() != NF->getReturnType())
1030 for (Function::iterator BB = NF->begin(), E = NF->end(); BB != E; ++BB)
1031 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1034 if (NFTy->getReturnType()->isVoidTy()) {
1037 assert (RetTy->isStructTy());
1038 // The original return value was a struct, insert
1039 // extractvalue/insertvalue chains to extract only the values we need
1040 // to return and insert them into our new result.
1041 // This does generate messy code, but we'll let it to instcombine to
1043 Value *OldRet = RI->getOperand(0);
1044 // Start out building up our return value from undef
1045 RetVal = UndefValue::get(NRetTy);
1046 for (unsigned i = 0; i != RetCount; ++i)
1047 if (NewRetIdxs[i] != -1) {
1048 ExtractValueInst *EV = ExtractValueInst::Create(OldRet, i,
1050 if (RetTypes.size() > 1) {
1051 // We're still returning a struct, so reinsert the value into
1052 // our new return value at the new index
1054 RetVal = InsertValueInst::Create(RetVal, EV, NewRetIdxs[i],
1057 // We are now only returning a simple value, so just return the
1063 // Replace the return instruction with one returning the new return
1064 // value (possibly 0 if we became void).
1065 ReturnInst::Create(F->getContext(), RetVal, RI);
1066 BB->getInstList().erase(RI);
1069 // Patch the pointer to LLVM function in debug info descriptor.
1070 auto DI = FunctionDIs.find(F);
1071 if (DI != FunctionDIs.end())
1072 DI->second.replaceFunction(NF);
1074 // Now that the old function is dead, delete it.
1075 F->eraseFromParent();
1080 bool DAE::runOnModule(Module &M) {
1081 bool Changed = false;
1083 // Collect debug info descriptors for functions.
1084 FunctionDIs = makeSubprogramMap(M);
1086 // First pass: Do a simple check to see if any functions can have their "..."
1087 // removed. We can do this if they never call va_start. This loop cannot be
1088 // fused with the next loop, because deleting a function invalidates
1089 // information computed while surveying other functions.
1090 DEBUG(dbgs() << "DAE - Deleting dead varargs\n");
1091 for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1093 if (F.getFunctionType()->isVarArg())
1094 Changed |= DeleteDeadVarargs(F);
1097 // Second phase:loop through the module, determining which arguments are live.
1098 // We assume all arguments are dead unless proven otherwise (allowing us to
1099 // determine that dead arguments passed into recursive functions are dead).
1101 DEBUG(dbgs() << "DAE - Determining liveness\n");
1105 // Now, remove all dead arguments and return values from each function in
1107 for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1108 // Increment now, because the function will probably get removed (ie.
1109 // replaced by a new one).
1111 Changed |= RemoveDeadStuffFromFunction(F);
1114 // Finally, look for any unused parameters in functions with non-local
1115 // linkage and replace the passed in parameters with undef.
1117 Changed |= RemoveDeadArgumentsFromCallers(F);