80 column and trailing whitespace fixes.
[oota-llvm.git] / lib / Transforms / IPO / DeadArgumentElimination.cpp
1 //===-- DeadArgumentElimination.cpp - Eliminate dead arguments ------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.
14 //
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.
17 //
18 //===----------------------------------------------------------------------===//
19
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/Support/Compiler.h"
34 #include <map>
35 #include <set>
36 using namespace llvm;
37
38 STATISTIC(NumArgumentsEliminated, "Number of unread args removed");
39 STATISTIC(NumRetValsEliminated  , "Number of unused return values removed");
40
41 namespace {
42   /// DAE - The dead argument elimination pass.
43   ///
44   class VISIBILITY_HIDDEN DAE : public ModulePass {
45   public:
46
47     /// Struct that represent either a (part of a) return value or a function
48     /// argument.  Used so that arguments and return values can be used
49     /// interchangably.
50     struct RetOrArg {
51       RetOrArg(const Function* F, unsigned Idx, bool IsArg) : F(F), Idx(Idx),
52                IsArg(IsArg) {}
53       const Function *F;
54       unsigned Idx;
55       bool IsArg;
56
57       /// Make RetOrArg comparable, so we can put it into a map
58       bool operator<(const RetOrArg &O) const {
59         if (F != O.F)
60           return F < O.F;
61         else if (Idx != O.Idx)
62           return Idx < O.Idx;
63         else
64           return IsArg < O.IsArg;
65       }
66
67       /// Make RetOrArg comparable, so we can easily iterate the multimap
68       bool operator==(const RetOrArg &O) const {
69         return F == O.F && Idx == O.Idx && IsArg == O.IsArg;
70       }
71     };
72
73     /// Liveness enum - During our initial pass over the program, we determine
74     /// that things are either definately alive, definately dead, or in need of
75     /// interprocedural analysis (MaybeLive).
76     ///
77     enum Liveness { Live, MaybeLive, Dead };
78
79     /// Convenience wrapper
80     RetOrArg CreateRet(const Function *F, unsigned Idx) {
81       return RetOrArg(F, Idx, false);
82     }
83     /// Convenience wrapper
84     RetOrArg CreateArg(const Function *F, unsigned Idx) {
85       return RetOrArg(F, Idx, true);
86     }
87
88     typedef std::multimap<RetOrArg, RetOrArg> UseMap;
89     /// This map maps a return value or argument to all return values or
90     /// arguments it uses.
91     /// For example (indices are left out for clarity):
92     ///  - Uses[ret F] = ret G
93     ///    This means that F calls G, and F returns the value returned by G.
94     ///  - Uses[arg F] = ret G
95     ///    This means that some function calls G and passes its result as an
96     ///    argument to F.
97     ///  - Uses[ret F] = arg F
98     ///    This means that F returns one of its own arguments.
99     ///  - Uses[arg F] = arg G
100     ///    This means that G calls F and passes one of its own (G's) arguments
101     ///    directly to F.
102     UseMap Uses;
103
104     typedef std::set<RetOrArg> LiveSet;
105
106     /// This set contains all values that have been determined to be live
107     LiveSet LiveValues;
108
109     typedef SmallVector<RetOrArg, 5> UseVector;
110
111   public:
112     static char ID; // Pass identification, replacement for typeid
113     DAE() : ModulePass((intptr_t)&ID) {}
114     bool runOnModule(Module &M);
115
116     virtual bool ShouldHackArguments() const { return false; }
117
118   private:
119     Liveness IsMaybeLive(RetOrArg Use, UseVector &MaybeLiveUses);
120     Liveness SurveyUse(Value::use_iterator U, UseVector &MaybeLiveUses,
121                        unsigned RetValNum = 0);
122     Liveness SurveyUses(Value *V, UseVector &MaybeLiveUses);
123
124     void SurveyFunction(Function &F);
125     void MarkValue(const RetOrArg &RA, Liveness L,
126                    const UseVector &MaybeLiveUses);
127     void MarkLive(RetOrArg RA);
128     bool RemoveDeadStuffFromFunction(Function *F);
129     bool DeleteDeadVarargs(Function &Fn);
130   };
131 }
132
133
134 char DAE::ID = 0;
135 static RegisterPass<DAE>
136 X("deadargelim", "Dead Argument Elimination");
137
138 namespace {
139   /// DAH - DeadArgumentHacking pass - Same as dead argument elimination, but
140   /// deletes arguments to functions which are external.  This is only for use
141   /// by bugpoint.
142   struct DAH : public DAE {
143     static char ID;
144     virtual bool ShouldHackArguments() const { return true; }
145   };
146 }
147
148 char DAH::ID = 0;
149 static RegisterPass<DAH>
150 Y("deadarghaX0r", "Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)");
151
152 /// createDeadArgEliminationPass - This pass removes arguments from functions
153 /// which are not used by the body of the function.
154 ///
155 ModulePass *llvm::createDeadArgEliminationPass() { return new DAE(); }
156 ModulePass *llvm::createDeadArgHackingPass() { return new DAH(); }
157
158 /// DeleteDeadVarargs - If this is an function that takes a ... list, and if
159 /// llvm.vastart is never called, the varargs list is dead for the function.
160 bool DAE::DeleteDeadVarargs(Function &Fn) {
161   assert(Fn.getFunctionType()->isVarArg() && "Function isn't varargs!");
162   if (Fn.isDeclaration() || !Fn.hasInternalLinkage()) return false;
163
164   // Ensure that the function is only directly called.
165   for (Value::use_iterator I = Fn.use_begin(), E = Fn.use_end(); I != E; ++I) {
166     // If this use is anything other than a call site, give up.
167     CallSite CS = CallSite::get(*I);
168     Instruction *TheCall = CS.getInstruction();
169     if (!TheCall) return false;   // Not a direct call site?
170
171     // The addr of this function is passed to the call.
172     if (I.getOperandNo() != 0) return false;
173   }
174
175   // Okay, we know we can transform this function if safe.  Scan its body
176   // looking for calls to llvm.vastart.
177   for (Function::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
178     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
179       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
180         if (II->getIntrinsicID() == Intrinsic::vastart)
181           return false;
182       }
183     }
184   }
185
186   // If we get here, there are no calls to llvm.vastart in the function body,
187   // remove the "..." and adjust all the calls.
188
189   // Start by computing a new prototype for the function, which is the same as
190   // the old function, but doesn't have isVarArg set.
191   const FunctionType *FTy = Fn.getFunctionType();
192   std::vector<const Type*> Params(FTy->param_begin(), FTy->param_end());
193   FunctionType *NFTy = FunctionType::get(FTy->getReturnType(), Params, false);
194   unsigned NumArgs = Params.size();
195
196   // Create the new function body and insert it into the module...
197   Function *NF = Function::Create(NFTy, Fn.getLinkage());
198   NF->copyAttributesFrom(&Fn);
199   Fn.getParent()->getFunctionList().insert(&Fn, NF);
200   NF->takeName(&Fn);
201
202   // Loop over all of the callers of the function, transforming the call sites
203   // to pass in a smaller number of arguments into the new function.
204   //
205   std::vector<Value*> Args;
206   while (!Fn.use_empty()) {
207     CallSite CS = CallSite::get(Fn.use_back());
208     Instruction *Call = CS.getInstruction();
209
210     // Pass all the same arguments.
211     Args.assign(CS.arg_begin(), CS.arg_begin()+NumArgs);
212
213     // Drop any attributes that were on the vararg arguments.
214     PAListPtr PAL = CS.getParamAttrs();
215     if (!PAL.isEmpty() && PAL.getSlot(PAL.getNumSlots() - 1).Index > NumArgs) {
216       SmallVector<ParamAttrsWithIndex, 8> ParamAttrsVec;
217       for (unsigned i = 0; PAL.getSlot(i).Index <= NumArgs; ++i)
218         ParamAttrsVec.push_back(PAL.getSlot(i));
219       PAL = PAListPtr::get(ParamAttrsVec.begin(), ParamAttrsVec.end());
220     }
221
222     Instruction *New;
223     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
224       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
225                                Args.begin(), Args.end(), "", Call);
226       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
227       cast<InvokeInst>(New)->setParamAttrs(PAL);
228     } else {
229       New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
230       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
231       cast<CallInst>(New)->setParamAttrs(PAL);
232       if (cast<CallInst>(Call)->isTailCall())
233         cast<CallInst>(New)->setTailCall();
234     }
235     Args.clear();
236
237     if (!Call->use_empty())
238       Call->replaceAllUsesWith(New);
239
240     New->takeName(Call);
241
242     // Finally, remove the old call from the program, reducing the use-count of
243     // F.
244     Call->eraseFromParent();
245   }
246
247   // Since we have now created the new function, splice the body of the old
248   // function right into the new function, leaving the old rotting hulk of the
249   // function empty.
250   NF->getBasicBlockList().splice(NF->begin(), Fn.getBasicBlockList());
251
252   // Loop over the argument list, transfering uses of the old arguments over to
253   // the new arguments, also transfering over the names as well.  While we're at
254   // it, remove the dead arguments from the DeadArguments list.
255   //
256   for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end(),
257        I2 = NF->arg_begin(); I != E; ++I, ++I2) {
258     // Move the name and users over to the new version.
259     I->replaceAllUsesWith(I2);
260     I2->takeName(I);
261   }
262
263   // Finally, nuke the old function.
264   Fn.eraseFromParent();
265   return true;
266 }
267
268 /// Convenience function that returns the number of return values. It returns 0
269 /// for void functions and 1 for functions not returning a struct. It returns
270 /// the number of struct elements for functions returning a struct.
271 static unsigned NumRetVals(const Function *F) {
272   if (F->getReturnType() == Type::VoidTy)
273     return 0;
274   else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType()))
275     return STy->getNumElements();
276   else
277     return 1;
278 }
279
280 /// IsMaybeAlive - This checks Use for liveness. If Use is live, returns Live,
281 /// else returns MaybeLive. Also, adds Use to MaybeLiveUses in the latter case.
282 DAE::Liveness DAE::IsMaybeLive(RetOrArg Use, UseVector &MaybeLiveUses) {
283   // We're live if our use is already marked as live
284   if (LiveValues.count(Use))
285     return Live;
286
287   // We're maybe live otherwise, but remember that we must become live if
288   // Use becomes live.
289   MaybeLiveUses.push_back(Use);
290   return MaybeLive;
291 }
292
293
294 /// SurveyUse - This looks at a single use of an argument or return value
295 /// and determines if it should be alive or not. Adds this use to MaybeLiveUses
296 /// if it causes the used value to become MaybeAlive.
297 ///
298 /// RetValNum is the return value number to use when this use is used in a
299 /// return instruction. This is used in the recursion, you should always leave
300 /// it at 0.
301 DAE::Liveness DAE::SurveyUse(Value::use_iterator U, UseVector &MaybeLiveUses,
302                              unsigned RetValNum) {
303     Value *V = *U;
304     if (ReturnInst *RI = dyn_cast<ReturnInst>(V)) {
305       // The value is returned from another function. It's only live when the
306       // caller's return value is live
307       RetOrArg Use = CreateRet(RI->getParent()->getParent(), RetValNum);
308       // We might be live, depending on the liveness of Use
309       return IsMaybeLive(Use, MaybeLiveUses);
310     }
311     if (InsertValueInst *IV = dyn_cast<InsertValueInst>(V)) {
312       if (U.getOperandNo() != InsertValueInst::getAggregateOperandIndex()
313           && IV->hasIndices())
314         // The use we are examining is inserted into an aggregate. Our liveness
315         // depends on all uses of that aggregate, but if it is used as a return
316         // value, only index at which we were inserted counts.
317         RetValNum = *IV->idx_begin();
318
319       // Note that if we are used as the aggregate operand to the insertvalue,
320       // we don't change RetValNum, but do survey all our uses.
321
322       Liveness Result = Dead;
323       for (Value::use_iterator I = IV->use_begin(),
324            E = V->use_end(); I != E; ++I) {
325         Result = SurveyUse(I, MaybeLiveUses, RetValNum);
326         if (Result == Live)
327           break;
328       }
329       return Result;
330     }
331     CallSite CS = CallSite::get(V);
332     if (CS.getInstruction()) {
333       Function *F = CS.getCalledFunction();
334       if (F) {
335         // Used in a direct call
336
337         // Check for vararg. Do - 1 to skip the first operand to call (the
338         // function itself).
339         if (U.getOperandNo() - 1 >= F->getFunctionType()->getNumParams())
340           // The value is passed in through a vararg! Must be live.
341           return Live;
342
343         // Value passed to a normal call. It's only live when the corresponding
344         // argument (operand number - 1 to skip the function pointer operand) to
345         // the called function turns out live
346         RetOrArg Use = CreateArg(F, U.getOperandNo() - 1);
347         return IsMaybeLive(Use, MaybeLiveUses);
348       } else {
349         // Used in any other way? Value must be live.
350         return Live;
351       }
352     }
353     // Used in any other way? Value must be live.
354     return Live;
355 }
356
357 /// SurveyUses - This looks at all the uses of the given return value
358 /// (possibly a partial return value from a function returning a struct).
359 /// Returns the Liveness deduced from the uses of this value.
360 ///
361 /// Adds all uses that cause the result to be MaybeLive to MaybeLiveRetUses.
362 DAE::Liveness DAE::SurveyUses(Value *V, UseVector &MaybeLiveUses) {
363   // Assume it's dead (which will only hold if there are no uses at all..)
364   Liveness Result = Dead;
365   // Check each use
366   for (Value::use_iterator I = V->use_begin(),
367        E = V->use_end(); I != E; ++I) {
368     Result = SurveyUse(I, MaybeLiveUses);
369     if (Result == Live)
370       break;
371   }
372   return Result;
373 }
374
375 // SurveyFunction - This performs the initial survey of the specified function,
376 // checking out whether or not it uses any of its incoming arguments or whether
377 // any callers use the return value.  This fills in the
378 // (Dead|MaybeLive|Live)(Arguments|RetVal) sets.
379 //
380 // We consider arguments of non-internal functions to be intrinsically alive as
381 // well as arguments to functions which have their "address taken".
382 //
383 void DAE::SurveyFunction(Function &F) {
384   bool FunctionIntrinsicallyLive = false;
385   unsigned RetCount = NumRetVals(&F);
386   // Assume all return values are dead
387   typedef SmallVector<Liveness, 5> RetVals;
388   RetVals RetValLiveness(RetCount, Dead);
389
390   // These vectors maps each return value to the uses that make it MaybeLive, so
391   // we can add those to the MaybeLiveRetVals list if the return value
392   // really turns out to be MaybeLive. Initializes to RetCount empty vectors
393   typedef SmallVector<UseVector, 5> RetUses;
394   // Intialized to a list of RetCount empty lists
395   RetUses MaybeLiveRetUses(RetCount);
396
397   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
398     if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
399       if (RI->getNumOperands() != 0 && RI->getOperand(0)->getType()
400           != F.getFunctionType()->getReturnType()) {
401         // We don't support old style multiple return values
402         FunctionIntrinsicallyLive = true;
403         break;
404       }
405
406   if (!F.hasInternalLinkage() && (!ShouldHackArguments() || F.isIntrinsic()))
407     FunctionIntrinsicallyLive = true;
408
409   if (!FunctionIntrinsicallyLive) {
410     DOUT << "DAE - Inspecting callers for fn: " << F.getName() << "\n";
411     // Keep track of the number of live retvals, so we can skip checks once all
412     // of them turn out to be live.
413     unsigned NumLiveRetVals = 0;
414     const Type *STy = dyn_cast<StructType>(F.getReturnType());
415     // Loop all uses of the function
416     for (Value::use_iterator I = F.use_begin(), E = F.use_end(); I != E; ++I) {
417       // If the function is PASSED IN as an argument, its address has been taken
418       if (I.getOperandNo() != 0) {
419         FunctionIntrinsicallyLive = true;
420         break;
421       }
422
423       // If this use is anything other than a call site, the function is alive.
424       CallSite CS = CallSite::get(*I);
425       Instruction *TheCall = CS.getInstruction();
426       if (!TheCall) {   // Not a direct call site?
427         FunctionIntrinsicallyLive = true;
428         break;
429       }
430
431       // If we end up here, we are looking at a direct call to our function.
432
433       // Now, check how our return value(s) is/are used in this caller. Don't
434       // bother checking return values if all of them are live already
435       if (NumLiveRetVals != RetCount) {
436         if (STy) {
437           // Check all uses of the return value
438           for (Value::use_iterator I = TheCall->use_begin(),
439                E = TheCall->use_end(); I != E; ++I) {
440             ExtractValueInst *Ext = dyn_cast<ExtractValueInst>(*I);
441             if (Ext && Ext->hasIndices()) {
442               // This use uses a part of our return value, survey the uses of
443               // that part and store the results for this index only.
444               unsigned Idx = *Ext->idx_begin();
445               if (RetValLiveness[Idx] != Live) {
446                 RetValLiveness[Idx] = SurveyUses(Ext, MaybeLiveRetUses[Idx]);
447                 if (RetValLiveness[Idx] == Live)
448                   NumLiveRetVals++;
449               }
450             } else {
451               // Used by something else than extractvalue. Mark all
452               // return values as live.
453               for (unsigned i = 0; i != RetCount; ++i )
454                 RetValLiveness[i] = Live;
455               NumLiveRetVals = RetCount;
456               break;
457             }
458           }
459         } else {
460           // Single return value
461           RetValLiveness[0] = SurveyUses(TheCall, MaybeLiveRetUses[0]);
462           if (RetValLiveness[0] == Live)
463             NumLiveRetVals = RetCount;
464         }
465       }
466     }
467   }
468   if (FunctionIntrinsicallyLive) {
469     DOUT << "DAE - Intrinsically live fn: " << F.getName() << "\n";
470     // Mark all arguments as live
471     unsigned i = 0;
472     for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end();
473          AI != E; ++AI, ++i)
474       MarkLive(CreateArg(&F, i));
475     // Mark all return values as live
476     i = 0;
477     for (unsigned i = 0, e = RetValLiveness.size(); i != e; ++i)
478       MarkLive(CreateRet(&F, i));
479     return;
480   }
481
482   // Now we've inspected all callers, record the liveness of our return values.
483   for (unsigned i = 0, e = RetValLiveness.size(); i != e; ++i) {
484     RetOrArg Ret = CreateRet(&F, i);
485     // Mark the result down
486     MarkValue(Ret, RetValLiveness[i], MaybeLiveRetUses[i]);
487   }
488   DOUT << "DAE - Inspecting args for fn: " << F.getName() << "\n";
489
490   // Now, check all of our arguments
491   unsigned i = 0;
492   UseVector MaybeLiveArgUses;
493   for (Function::arg_iterator AI = F.arg_begin(),
494        E = F.arg_end(); AI != E; ++AI, ++i) {
495     // See what the effect of this use is (recording any uses that cause
496     // MaybeLive in MaybeLiveArgUses)
497     Liveness Result = SurveyUses(AI, MaybeLiveArgUses);
498     RetOrArg Arg = CreateArg(&F, i);
499     // Mark the result down
500     MarkValue(Arg, Result, MaybeLiveArgUses);
501     // Clear the vector again for the next iteration
502     MaybeLiveArgUses.clear();
503   }
504 }
505
506 /// MarkValue - This function marks the liveness of RA depending on L. If L is
507 /// MaybeLive, it also records any uses in MaybeLiveUses such that RA will be
508 /// marked live if any use in MaybeLiveUses gets marked live later on.
509 void DAE::MarkValue(const RetOrArg &RA, Liveness L,
510                     const UseVector &MaybeLiveUses) {
511   switch (L) {
512     case Live: MarkLive(RA); break;
513     case MaybeLive:
514     {
515       // Note any uses of this value, so this return value can be
516       // marked live whenever one of the uses becomes live.
517       UseMap::iterator Where = Uses.begin();
518       for (UseVector::const_iterator UI = MaybeLiveUses.begin(),
519            UE = MaybeLiveUses.end(); UI != UE; ++UI)
520         Where = Uses.insert(Where, UseMap::value_type(*UI, RA));
521       break;
522     }
523     case Dead: break;
524   }
525 }
526
527 /// MarkLive - Mark the given return value or argument as live. Additionally,
528 /// mark any values that are used by this value (according to Uses) live as
529 /// well.
530 void DAE::MarkLive(RetOrArg RA) {
531   if (!LiveValues.insert(RA).second)
532     return; // We were already marked Live
533
534   if (RA.IsArg)
535     DOUT << "DAE - Marking argument " << RA.Idx << " to function "
536          << RA.F->getNameStart() << " live\n";
537   else
538     DOUT << "DAE - Marking return value " << RA.Idx << " of function "
539          << RA.F->getNameStart() << " live\n";
540
541   // We don't use upper_bound (or equal_range) here, because our recursive call
542   // to ourselves is likely to mark the upper_bound (which is the first value
543   // not belonging to RA) to become erased and the iterator invalidated.
544   UseMap::iterator Begin = Uses.lower_bound(RA);
545   UseMap::iterator E = Uses.end();
546   UseMap::iterator I;
547   for (I = Begin; I != E && I->first == RA; ++I)
548     MarkLive(I->second);
549
550   // Erase RA from the Uses map (from the lower bound to wherever we ended up
551   // after the loop).
552   Uses.erase(Begin, I);
553 }
554
555 // RemoveDeadStuffFromFunction - Remove any arguments and return values from F
556 // that are not in LiveValues. This function is a noop for any Function created
557 // by this function before, or any function that was not inspected for liveness.
558 // specified by the DeadArguments list.  Transform the function and all of the
559 // callees of the function to not have these arguments.
560 //
561 bool DAE::RemoveDeadStuffFromFunction(Function *F) {
562   // Quick exit path for external functions
563   if (!F->hasInternalLinkage() && (!ShouldHackArguments() || F->isIntrinsic()))
564     return false;
565
566   // Start by computing a new prototype for the function, which is the same as
567   // the old function, but has fewer arguments and a different return type.
568   const FunctionType *FTy = F->getFunctionType();
569   std::vector<const Type*> Params;
570
571   // Set up to build a new list of parameter attributes
572   SmallVector<ParamAttrsWithIndex, 8> ParamAttrsVec;
573   const PAListPtr &PAL = F->getParamAttrs();
574
575   // The existing function return attributes.
576   ParameterAttributes RAttrs = PAL.getParamAttrs(0);
577
578
579   // Find out the new return value
580
581   const Type *RetTy = FTy->getReturnType();
582   const Type *NRetTy;
583   unsigned RetCount = NumRetVals(F);
584   // Explicitely track if anything changed, for debugging
585   bool Changed = false;
586   // -1 means unused, other numbers are the new index
587   SmallVector<int, 5> NewRetIdxs(RetCount, -1);
588   std::vector<const Type*> RetTypes;
589   if (RetTy != Type::VoidTy) {
590     const StructType *STy = dyn_cast<StructType>(RetTy);
591     if (STy)
592       // Look at each of the original return values individually
593       for (unsigned i = 0; i != RetCount; ++i) {
594         RetOrArg Ret = CreateRet(F, i);
595         if (LiveValues.erase(Ret)) {
596           RetTypes.push_back(STy->getElementType(i));
597           NewRetIdxs[i] = RetTypes.size() - 1;
598         } else {
599           ++NumRetValsEliminated;
600           DOUT << "DAE - Removing return value " << i << " from "
601                << F->getNameStart() << "\n";
602           Changed = true;
603         }
604       }
605     else
606       // We used to return a single value
607       if (LiveValues.erase(CreateRet(F, 0))) {
608         RetTypes.push_back(RetTy);
609         NewRetIdxs[0] = 0;
610       } else {
611         DOUT << "DAE - Removing return value from " << F->getNameStart()
612              << "\n";
613         ++NumRetValsEliminated;
614         Changed = true;
615       }
616     if (RetTypes.size() > 1 || STy && STy->getNumElements() == RetTypes.size())
617       // More than one return type? Return a struct with them. Also, if we used
618       // to return a struct and didn't change the number of return values,
619       // return a struct again. This prevents chaning {something} into something
620       // and {} into void.
621       // Make the new struct packed if we used to return a packed struct
622       // already.
623       NRetTy = StructType::get(RetTypes, STy->isPacked());
624     else if (RetTypes.size() == 1)
625       // One return type? Just a simple value then, but only if we didn't use to
626       // return a struct with that simple value before.
627       NRetTy = RetTypes.front();
628     else if (RetTypes.size() == 0)
629       // No return types? Make it void, but only if we didn't use to return {}
630       NRetTy = Type::VoidTy;
631   } else {
632     NRetTy = Type::VoidTy;
633   }
634
635   // Remove any incompatible attributes
636   RAttrs &= ~ParamAttr::typeIncompatible(NRetTy);
637   if (RAttrs)
638     ParamAttrsVec.push_back(ParamAttrsWithIndex::get(0, RAttrs));
639
640   // Remember which arguments are still alive
641   SmallVector<bool, 10> ArgAlive(FTy->getNumParams(), false);
642   // Construct the new parameter list from non-dead arguments. Also construct
643   // a new set of parameter attributes to correspond. Skip the first parameter
644   // attribute, since that belongs to the return value.
645   unsigned i = 0;
646   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
647        I != E; ++I, ++i) {
648     RetOrArg Arg = CreateArg(F, i);
649     if (LiveValues.erase(Arg)) {
650       Params.push_back(I->getType());
651       ArgAlive[i] = true;
652
653       // Get the original parameter attributes (skipping the first one, that is
654       // for the return value
655       if (ParameterAttributes Attrs = PAL.getParamAttrs(i + 1))
656         ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Params.size(), Attrs));
657     } else {
658       ++NumArgumentsEliminated;
659       DOUT << "DAE - Removing argument " << i << " (" << I->getNameStart()
660            << ") from " << F->getNameStart() << "\n";
661       Changed = true;
662     }
663   }
664
665   // Reconstruct the ParamAttrsList based on the vector we constructed.
666   PAListPtr NewPAL = PAListPtr::get(ParamAttrsVec.begin(), ParamAttrsVec.end());
667
668   // Work around LLVM bug PR56: the CWriter cannot emit varargs functions which
669   // have zero fixed arguments.
670   //
671   // Not that we apply this hack for a vararg fuction that does not have any
672   // arguments anymore, but did have them before (so don't bother fixing
673   // functions that were already broken wrt CWriter).
674   bool ExtraArgHack = false;
675   if (Params.empty() && FTy->isVarArg() && FTy->getNumParams() != 0) {
676     ExtraArgHack = true;
677     Params.push_back(Type::Int32Ty);
678   }
679
680   // Create the new function type based on the recomputed parameters.
681   FunctionType *NFTy = FunctionType::get(NRetTy, Params, FTy->isVarArg());
682
683   // No change?
684   if (NFTy == FTy)
685     return false;
686
687   // The function type is only allowed to be different if we actually left out
688   // an argument or return value
689   assert(Changed && "Function type changed while no arguments or retrurn values"
690                     "were removed!");
691
692   // Create the new function body and insert it into the module...
693   Function *NF = Function::Create(NFTy, F->getLinkage());
694   NF->copyAttributesFrom(F);
695   NF->setParamAttrs(NewPAL);
696   // Insert the new function before the old function, so we won't be processing
697   // it again
698   F->getParent()->getFunctionList().insert(F, NF);
699   NF->takeName(F);
700
701   // Loop over all of the callers of the function, transforming the call sites
702   // to pass in a smaller number of arguments into the new function.
703   //
704   std::vector<Value*> Args;
705   while (!F->use_empty()) {
706     CallSite CS = CallSite::get(F->use_back());
707     Instruction *Call = CS.getInstruction();
708
709     ParamAttrsVec.clear();
710     const PAListPtr &CallPAL = CS.getParamAttrs();
711
712     // The call return attributes.
713     ParameterAttributes RAttrs = CallPAL.getParamAttrs(0);
714     // Adjust in case the function was changed to return void.
715     RAttrs &= ~ParamAttr::typeIncompatible(NF->getReturnType());
716     if (RAttrs)
717       ParamAttrsVec.push_back(ParamAttrsWithIndex::get(0, RAttrs));
718
719     // Declare these outside of the loops, so we can reuse them for the second
720     // loop, which loops the varargs
721     CallSite::arg_iterator I = CS.arg_begin();
722     unsigned i = 0;
723     // Loop over those operands, corresponding to the normal arguments to the
724     // original function, and add those that are still alive.
725     for (unsigned e = FTy->getNumParams(); i != e; ++I, ++i)
726       if (ArgAlive[i]) {
727         Args.push_back(*I);
728         // Get original parameter attributes, but skip return attributes
729         if (ParameterAttributes Attrs = CallPAL.getParamAttrs(i + 1))
730           ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Args.size(), Attrs));
731       }
732
733     if (ExtraArgHack)
734       Args.push_back(UndefValue::get(Type::Int32Ty));
735
736     // Push any varargs arguments on the list. Don't forget their attributes.
737     for (CallSite::arg_iterator E = CS.arg_end(); I != E; ++I, ++i) {
738       Args.push_back(*I);
739       if (ParameterAttributes Attrs = CallPAL.getParamAttrs(i + 1))
740         ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Args.size(), Attrs));
741     }
742
743     // Reconstruct the ParamAttrsList based on the vector we constructed.
744     PAListPtr NewCallPAL = PAListPtr::get(ParamAttrsVec.begin(),
745                                           ParamAttrsVec.end());
746
747     Instruction *New;
748     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
749       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
750                                Args.begin(), Args.end(), "", Call);
751       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
752       cast<InvokeInst>(New)->setParamAttrs(NewCallPAL);
753     } else {
754       New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
755       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
756       cast<CallInst>(New)->setParamAttrs(NewCallPAL);
757       if (cast<CallInst>(Call)->isTailCall())
758         cast<CallInst>(New)->setTailCall();
759     }
760     Args.clear();
761
762     if (!Call->use_empty()) {
763       if (New->getType() == Call->getType()) {
764         // Return type not changed? Just replace users then
765         Call->replaceAllUsesWith(New);
766         New->takeName(Call);
767       } else if (New->getType() == Type::VoidTy) {
768         // Our return value has uses, but they will get removed later on.
769         // Replace by null for now.
770         Call->replaceAllUsesWith(Constant::getNullValue(Call->getType()));
771       } else {
772         assert(isa<StructType>(RetTy) && "Return type changed, but not into a"
773                                          "void. The old return type must have"
774                                          "been a struct!");
775         // The original return value was a struct, update all uses (which are
776         // all extractvalue instructions).
777         for (Value::use_iterator I = Call->use_begin(), E = Call->use_end();
778              I != E;) {
779           assert(isa<ExtractValueInst>(*I) && "Return value not only used by"
780                                               "extractvalue?");
781           ExtractValueInst *EV = cast<ExtractValueInst>(*I);
782           // Increment now, since we're about to throw away this use.
783           ++I;
784           assert(EV->hasIndices() && "Return value used by extractvalue without"
785                                      "indices?");
786           unsigned Idx = *EV->idx_begin();
787           if (NewRetIdxs[Idx] != -1) {
788             if (RetTypes.size() > 1) {
789               // We're still returning a struct, create a new extractvalue
790               // instruction with the first index updated
791               std::vector<unsigned> NewIdxs(EV->idx_begin(), EV->idx_end());
792               NewIdxs[0] = NewRetIdxs[Idx];
793               Value *NEV = ExtractValueInst::Create(New, NewIdxs.begin(),
794                                                     NewIdxs.end(), "retval",
795                                                     EV);
796               EV->replaceAllUsesWith(NEV);
797               EV->eraseFromParent();
798             } else {
799               // We are now only returning a simple value, remove the
800               // extractvalue
801               EV->replaceAllUsesWith(New);
802               EV->eraseFromParent();
803             }
804           } else {
805             // Value unused, replace uses by null for now, they will get removed
806             // later on
807             EV->replaceAllUsesWith(Constant::getNullValue(EV->getType()));
808             EV->eraseFromParent();
809           }
810         }
811         New->takeName(Call);
812       }
813     }
814
815     // Finally, remove the old call from the program, reducing the use-count of
816     // F.
817     Call->eraseFromParent();
818   }
819
820   // Since we have now created the new function, splice the body of the old
821   // function right into the new function, leaving the old rotting hulk of the
822   // function empty.
823   NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
824
825   // Loop over the argument list, transfering uses of the old arguments over to
826   // the new arguments, also transfering over the names as well.
827   i = 0;
828   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(),
829        I2 = NF->arg_begin(); I != E; ++I, ++i)
830     if (ArgAlive[i]) {
831       // If this is a live argument, move the name and users over to the new
832       // version.
833       I->replaceAllUsesWith(I2);
834       I2->takeName(I);
835       ++I2;
836     } else {
837       // If this argument is dead, replace any uses of it with null constants
838       // (these are guaranteed to become unused later on)
839       I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
840     }
841
842   // If we change the return value of the function we must rewrite any return
843   // instructions.  Check this now.
844   if (F->getReturnType() != NF->getReturnType())
845     for (Function::iterator BB = NF->begin(), E = NF->end(); BB != E; ++BB)
846       if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
847         Value *RetVal;
848
849         if (NFTy->getReturnType() == Type::VoidTy) {
850           RetVal = 0;
851         } else {
852           assert (isa<StructType>(RetTy));
853           // The original return value was a struct, insert
854           // extractvalue/insertvalue chains to extract only the values we need
855           // to return and insert them into our new result.
856           // This does generate messy code, but we'll let it to instcombine to
857           // clean that up
858           Value *OldRet = RI->getOperand(0);
859           // Start out building up our return value from undef
860           RetVal = llvm::UndefValue::get(NRetTy);
861           for (unsigned i = 0; i != RetCount; ++i)
862             if (NewRetIdxs[i] != -1) {
863               ExtractValueInst *EV = ExtractValueInst::Create(OldRet, i,
864                                                               "newret", RI);
865               if (RetTypes.size() > 1) {
866                 // We're still returning a struct, so reinsert the value into
867                 // our new return value at the new index
868
869                 RetVal = InsertValueInst::Create(RetVal, EV, NewRetIdxs[i],
870                                                  "oldret");
871               } else {
872                 // We are now only returning a simple value, so just return the
873                 // extracted value
874                 RetVal = EV;
875               }
876             }
877         }
878         // Replace the return instruction with one returning the new return
879         // value (possibly 0 if we became void).
880         ReturnInst::Create(RetVal, RI);
881         BB->getInstList().erase(RI);
882       }
883
884   // Now that the old function is dead, delete it.
885   F->eraseFromParent();
886
887   return true;
888 }
889
890 bool DAE::runOnModule(Module &M) {
891   bool Changed = false;
892   // First pass: Do a simple check to see if any functions can have their "..."
893   // removed.  We can do this if they never call va_start.  This loop cannot be
894   // fused with the next loop, because deleting a function invalidates
895   // information computed while surveying other functions.
896   DOUT << "DAE - Deleting dead varargs\n";
897   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
898     Function &F = *I++;
899     if (F.getFunctionType()->isVarArg())
900       Changed |= DeleteDeadVarargs(F);
901   }
902
903   // Second phase:loop through the module, determining which arguments are live.
904   // We assume all arguments are dead unless proven otherwise (allowing us to
905   // determine that dead arguments passed into recursive functions are dead).
906   //
907   DOUT << "DAE - Determining liveness\n";
908   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
909     SurveyFunction(*I);
910
911   // Now, remove all dead arguments and return values from each function in
912   // turn
913   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
914     // Increment now, because the function will probably get removed (ie
915     // replaced by a new one)
916     Function *F = I++;
917     Changed |= RemoveDeadStuffFromFunction(F);
918   }
919
920   return Changed;
921 }