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/DebugInfo.h"
  25 #include "llvm/DerivedTypes.h"
  26 #include "llvm/DIBuilder.h"
  27 #include "llvm/Instructions.h"
  28 #include "llvm/IntrinsicInst.h"
  29 #include "llvm/LLVMContext.h"
  30 #include "llvm/Module.h"
  31 #include "llvm/Pass.h"
  32 #include "llvm/Support/CallSite.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/ADT/DenseMap.h"
  36 #include "llvm/ADT/SmallVector.h"
  37 #include "llvm/ADT/Statistic.h"
  38 #include "llvm/ADT/StringExtras.h"
  39 #include <map>
  40 #include <set>
  41 using namespace llvm;
  42
  43 STATISTIC(NumArgumentsEliminated, "Number of unread args removed");
  44 STATISTIC(NumRetValsEliminated  , "Number of unused return values removed");
  45 STATISTIC(NumArgumentsReplacedWithUndef,
  46           "Number of unread args replaced with undef");
  47 namespace {
  48   /// DAE - The dead argument elimination pass.
  49   ///
  50   class DAE : public ModulePass {
  51   public:
  52
  53     /// Struct that represents (part of) either a return value or a function
  54     /// argument.  Used so that arguments and return values can be used
  55     /// interchangeably.
  56     struct RetOrArg {
  57       RetOrArg(const Function *F, unsigned Idx, bool IsArg) : F(F), Idx(Idx),
  58                IsArg(IsArg) {}
  59       const Function *F;
  60       unsigned Idx;
  61       bool IsArg;
  62
  63       /// Make RetOrArg comparable, so we can put it into a map.
  64       bool operator<(const RetOrArg &O) const {
  65         if (F != O.F)
  66           return F < O.F;
  67         else if (Idx != O.Idx)
  68           return Idx < O.Idx;
  69         else
  70           return IsArg < O.IsArg;
  71       }
  72
  73       /// Make RetOrArg comparable, so we can easily iterate the multimap.
  74       bool operator==(const RetOrArg &O) const {
  75         return F == O.F && Idx == O.Idx && IsArg == O.IsArg;
  76       }
  77
  78       std::string getDescription() const {
  79         return std::string((IsArg ? "Argument #" : "Return value #"))
  80                + utostr(Idx) + " of function " + F->getName().str();
  81       }
  82     };
  83
  84     /// Liveness enum - During our initial pass over the program, we determine
  85     /// that things are either alive or maybe alive. We don't mark anything
  86     /// explicitly dead (even if we know they are), since anything not alive
  87     /// with no registered uses (in Uses) will never be marked alive and will
  88     /// thus become dead in the end.
  89     enum Liveness { Live, MaybeLive };
  90
  91     /// Convenience wrapper
  92     RetOrArg CreateRet(const Function *F, unsigned Idx) {
  93       return RetOrArg(F, Idx, false);
  94     }
  95     /// Convenience wrapper
  96     RetOrArg CreateArg(const Function *F, unsigned Idx) {
  97       return RetOrArg(F, Idx, true);
  98     }
  99
 100     typedef std::multimap<RetOrArg, RetOrArg> UseMap;
 101     /// This maps a return value or argument to any MaybeLive return values or
 102     /// arguments it uses. This allows the MaybeLive values to be marked live
 103     /// when any of its users is marked live.
 104     /// For example (indices are left out for clarity):
 105     ///  - Uses[ret F] = ret G
 106     ///    This means that F calls G, and F returns the value returned by G.
 107     ///  - Uses[arg F] = ret G
 108     ///    This means that some function calls G and passes its result as an
 109     ///    argument to F.
 110     ///  - Uses[ret F] = arg F
 111     ///    This means that F returns one of its own arguments.
 112     ///  - Uses[arg F] = arg G
 113     ///    This means that G calls F and passes one of its own (G's) arguments
 114     ///    directly to F.
 115     UseMap Uses;
 116
 117     typedef std::set<RetOrArg> LiveSet;
 118     typedef std::set<const Function*> LiveFuncSet;
 119
 120     /// This set contains all values that have been determined to be live.
 121     LiveSet LiveValues;
 122     /// This set contains all values that are cannot be changed in any way.
 123     LiveFuncSet LiveFunctions;
 124
 125     typedef SmallVector<RetOrArg, 5> UseVector;
 126
 127     // Map each LLVM function to corresponding metadata with debug info. If
 128     // the function is replaced with another one, we should patch the pointer
 129     // to LLVM function in metadata.
 130     // As the code generation for module is finished (and DIBuilder is
 131     // finalized) we assume that subprogram descriptors won't be changed, and
 132     // they are stored in map for short duration anyway.
 133     typedef DenseMap<Function*, DISubprogram> FunctionDIMap;
 134     FunctionDIMap FunctionDIs;
 135
 136   protected:
 137     // DAH uses this to specify a different ID.
 138     explicit DAE(char &ID) : ModulePass(ID) {}
 139
 140   public:
 141     static char ID; // Pass identification, replacement for typeid
 142     DAE() : ModulePass(ID) {
 143       initializeDAEPass(*PassRegistry::getPassRegistry());
 144     }
 145
 146     bool runOnModule(Module &M);
 147
 148     virtual bool ShouldHackArguments() const { return false; }
 149
 150   private:
 151     Liveness MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses);
 152     Liveness SurveyUse(Value::const_use_iterator U, UseVector &MaybeLiveUses,
 153                        unsigned RetValNum = 0);
 154     Liveness SurveyUses(const Value *V, UseVector &MaybeLiveUses);
 155
 156     void CollectFunctionDIs(Module &M);
 157     void SurveyFunction(const Function &F);
 158     void MarkValue(const RetOrArg &RA, Liveness L,
 159                    const UseVector &MaybeLiveUses);
 160     void MarkLive(const RetOrArg &RA);
 161     void MarkLive(const Function &F);
 162     void PropagateLiveness(const RetOrArg &RA);
 163     bool RemoveDeadStuffFromFunction(Function *F);
 164     bool DeleteDeadVarargs(Function &Fn);
 165     bool RemoveDeadArgumentsFromCallers(Function &Fn);
 166   };
 167 }
 168
 169
 170 char DAE::ID = 0;
 171 INITIALIZE_PASS(DAE, "deadargelim", "Dead Argument Elimination", false, false)
 172
 173 namespace {
 174   /// DAH - DeadArgumentHacking pass - Same as dead argument elimination, but
 175   /// deletes arguments to functions which are external.  This is only for use
 176   /// by bugpoint.
 177   struct DAH : public DAE {
 178     static char ID;
 179     DAH() : DAE(ID) {}
 180
 181     virtual bool ShouldHackArguments() const { return true; }
 182   };
 183 }
 184
 185 char DAH::ID = 0;
 186 INITIALIZE_PASS(DAH, "deadarghaX0r",
 187                 "Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)",
 188                 false, false)
 189
 190 /// createDeadArgEliminationPass - This pass removes arguments from functions
 191 /// which are not used by the body of the function.
 192 ///
 193 ModulePass *llvm::createDeadArgEliminationPass() { return new DAE(); }
 194 ModulePass *llvm::createDeadArgHackingPass() { return new DAH(); }
 195
 196 /// CollectFunctionDIs - Map each function in the module to its debug info
 197 /// descriptor.
 198 void DAE::CollectFunctionDIs(Module &M) {
 199   FunctionDIs.clear();
 200
 201   for (Module::named_metadata_iterator I = M.named_metadata_begin(),
 202        E = M.named_metadata_end(); I != E; ++I) {
 203     NamedMDNode &NMD = *I;
 204     for (unsigned MDIndex = 0, MDNum = NMD.getNumOperands();
 205          MDIndex < MDNum; ++MDIndex) {
 206       MDNode *Node = NMD.getOperand(MDIndex);
 207       if (!DIDescriptor(Node).isCompileUnit())
 208         continue;
 209       DICompileUnit CU(Node);
 210       const DIArray &SPs = CU.getSubprograms();
 211       for (unsigned SPIndex = 0, SPNum = SPs.getNumElements();
 212            SPIndex < SPNum; ++SPIndex) {
 213         DISubprogram SP(SPs.getElement(SPIndex));
 214         if (!SP.Verify())
 215           continue;
 216         if (Function *F = SP.getFunction())
 217           FunctionDIs[F] = SP;
 218       }
 219     }
 220   }
 221 }
 222
 223 /// DeleteDeadVarargs - If this is an function that takes a ... list, and if
 224 /// llvm.vastart is never called, the varargs list is dead for the function.
 225 bool DAE::DeleteDeadVarargs(Function &Fn) {
 226   assert(Fn.getFunctionType()->isVarArg() && "Function isn't varargs!");
 227   if (Fn.isDeclaration() || !Fn.hasLocalLinkage()) return false;
 228
 229   // Ensure that the function is only directly called.
 230   if (Fn.hasAddressTaken())
 231     return false;
 232
 233   // Okay, we know we can transform this function if safe.  Scan its body
 234   // looking for calls to llvm.vastart.
 235   for (Function::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
 236     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 237       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
 238         if (II->getIntrinsicID() == Intrinsic::vastart)
 239           return false;
 240       }
 241     }
 242   }
 243
 244   // If we get here, there are no calls to llvm.vastart in the function body,
 245   // remove the "..." and adjust all the calls.
 246
 247   // Start by computing a new prototype for the function, which is the same as
 248   // the old function, but doesn't have isVarArg set.
 249   FunctionType *FTy = Fn.getFunctionType();
 250
 251   std::vector<Type*> Params(FTy->param_begin(), FTy->param_end());
 252   FunctionType *NFTy = FunctionType::get(FTy->getReturnType(),
 253                                                 Params, false);
 254   unsigned NumArgs = Params.size();
 255
 256   // Create the new function body and insert it into the module...
 257   Function *NF = Function::Create(NFTy, Fn.getLinkage());
 258   NF->copyAttributesFrom(&Fn);
 259   Fn.getParent()->getFunctionList().insert(&Fn, NF);
 260   NF->takeName(&Fn);
 261
 262   // Loop over all of the callers of the function, transforming the call sites
 263   // to pass in a smaller number of arguments into the new function.
 264   //
 265   std::vector<Value*> Args;
 266   while (!Fn.use_empty()) {
 267     CallSite CS(Fn.use_back());
 268     Instruction *Call = CS.getInstruction();
 269
 270     // Pass all the same arguments.
 271     Args.assign(CS.arg_begin(), CS.arg_begin() + NumArgs);
 272
 273     // Drop any attributes that were on the vararg arguments.
 274     AttrListPtr PAL = CS.getAttributes();
 275     if (!PAL.isEmpty() && PAL.getSlot(PAL.getNumSlots() - 1).Index > NumArgs) {
 276       SmallVector<AttributeWithIndex, 8> AttributesVec;
 277       for (unsigned i = 0; PAL.getSlot(i).Index <= NumArgs; ++i)
 278         AttributesVec.push_back(PAL.getSlot(i));
 279       if (Attributes FnAttrs = PAL.getFnAttributes())
 280         AttributesVec.push_back(AttributeWithIndex::get(~0, FnAttrs));
 281       PAL = AttrListPtr::get(AttributesVec);
 282     }
 283
 284     Instruction *New;
 285     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 286       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
 287                                Args, "", Call);
 288       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
 289       cast<InvokeInst>(New)->setAttributes(PAL);
 290     } else {
 291       New = CallInst::Create(NF, Args, "", Call);
 292       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
 293       cast<CallInst>(New)->setAttributes(PAL);
 294       if (cast<CallInst>(Call)->isTailCall())
 295         cast<CallInst>(New)->setTailCall();
 296     }
 297     New->setDebugLoc(Call->getDebugLoc());
 298
 299     Args.clear();
 300
 301     if (!Call->use_empty())
 302       Call->replaceAllUsesWith(New);
 303
 304     New->takeName(Call);
 305
 306     // Finally, remove the old call from the program, reducing the use-count of
 307     // F.
 308     Call->eraseFromParent();
 309   }
 310
 311   // Since we have now created the new function, splice the body of the old
 312   // function right into the new function, leaving the old rotting hulk of the
 313   // function empty.
 314   NF->getBasicBlockList().splice(NF->begin(), Fn.getBasicBlockList());
 315
 316   // Loop over the argument list, transferring uses of the old arguments over to
 317   // the new arguments, also transferring over the names as well.  While we're at
 318   // it, remove the dead arguments from the DeadArguments list.
 319   //
 320   for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end(),
 321        I2 = NF->arg_begin(); I != E; ++I, ++I2) {
 322     // Move the name and users over to the new version.
 323     I->replaceAllUsesWith(I2);
 324     I2->takeName(I);
 325   }
 326
 327   // Patch the pointer to LLVM function in debug info descriptor.
 328   FunctionDIMap::iterator DI = FunctionDIs.find(&Fn);
 329   if (DI != FunctionDIs.end())
 330     DI->second.replaceFunction(NF);
 331
 332   // Finally, nuke the old function.
 333   Fn.eraseFromParent();
 334   return true;
 335 }
 336
 337 /// RemoveDeadArgumentsFromCallers - Checks if the given function has any
 338 /// arguments that are unused, and changes the caller parameters to be undefined
 339 /// instead.
 340 bool DAE::RemoveDeadArgumentsFromCallers(Function &Fn)
 341 {
 342   if (Fn.isDeclaration() || Fn.mayBeOverridden())
 343     return false;
 344
 345   // Functions with local linkage should already have been handled.
 346   if (Fn.hasLocalLinkage())
 347     return false;
 348
 349   if (Fn.use_empty())
 350     return false;
 351
 352   llvm::SmallVector<unsigned, 8> UnusedArgs;
 353   for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end();
 354        I != E; ++I) {
 355     Argument *Arg = I;
 356
 357     if (Arg->use_empty() && !Arg->hasByValAttr())
 358       UnusedArgs.push_back(Arg->getArgNo());
 359   }
 360
 361   if (UnusedArgs.empty())
 362     return false;
 363
 364   bool Changed = false;
 365
 366   for (Function::use_iterator I = Fn.use_begin(), E = Fn.use_end();
 367        I != E; ++I) {
 368     CallSite CS(*I);
 369     if (!CS || !CS.isCallee(I))
 370       continue;
 371
 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];
 375
 376       Value *Arg = CS.getArgument(ArgNo);
 377       CS.setArgument(ArgNo, UndefValue::get(Arg->getType()));
 378       ++NumArgumentsReplacedWithUndef;
 379       Changed = true;
 380     }
 381   }
 382
 383   return Changed;
 384 }
 385
 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())
 391     return 0;
 392   else if (StructType *STy = dyn_cast<StructType>(F->getReturnType()))
 393     return STy->getNumElements();
 394   else
 395     return 1;
 396 }
 397
 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
 400 /// liveness of Use.
 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))
 404     return Live;
 405
 406   // We're maybe live otherwise, but remember that we must become live if
 407   // Use becomes live.
 408   MaybeLiveUses.push_back(Use);
 409   return MaybeLive;
 410 }
 411
 412
 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.
 416 ///
 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
 419 /// it at 0.
 420 DAE::Liveness DAE::SurveyUse(Value::const_use_iterator U,
 421                              UseVector &MaybeLiveUses, unsigned RetValNum) {
 422     const User *V = *U;
 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
 427       // original Use.
 428       RetOrArg Use = CreateRet(RI->getParent()->getParent(), RetValNum);
 429       // We might be live, depending on the liveness of Use.
 430       return MarkIfNotLive(Use, MaybeLiveUses);
 431     }
 432     if (const InsertValueInst *IV = dyn_cast<InsertValueInst>(V)) {
 433       if (U.getOperandNo() != InsertValueInst::getAggregateOperandIndex()
 434           && IV->hasIndices())
 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();
 439
 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.
 442
 443       Liveness Result = MaybeLive;
 444       for (Value::const_use_iterator I = IV->use_begin(),
 445            E = V->use_end(); I != E; ++I) {
 446         Result = SurveyUse(I, MaybeLiveUses, RetValNum);
 447         if (Result == Live)
 448           break;
 449       }
 450       return Result;
 451     }
 452
 453     if (ImmutableCallSite CS = V) {
 454       const Function *F = CS.getCalledFunction();
 455       if (F) {
 456         // Used in a direct call.
 457
 458         // Find the argument number. We know for sure that this use is an
 459         // argument, since if it was the function argument this would be an
 460         // indirect call and the we know can't be looking at a value of the
 461         // label type (for the invoke instruction).
 462         unsigned ArgNo = CS.getArgumentNo(U);
 463
 464         if (ArgNo >= F->getFunctionType()->getNumParams())
 465           // The value is passed in through a vararg! Must be live.
 466           return Live;
 467
 468         assert(CS.getArgument(ArgNo)
 469                == CS->getOperand(U.getOperandNo())
 470                && "Argument is not where we expected it");
 471
 472         // Value passed to a normal call. It's only live when the corresponding
 473         // argument to the called function turns out live.
 474         RetOrArg Use = CreateArg(F, ArgNo);
 475         return MarkIfNotLive(Use, MaybeLiveUses);
 476       }
 477     }
 478     // Used in any other way? Value must be live.
 479     return Live;
 480 }
 481
 482 /// SurveyUses - This looks at all the uses of the given value
 483 /// Returns the Liveness deduced from the uses of this value.
 484 ///
 485 /// Adds all uses that cause the result to be MaybeLive to MaybeLiveRetUses. If
 486 /// the result is Live, MaybeLiveUses might be modified but its content should
 487 /// be ignored (since it might not be complete).
 488 DAE::Liveness DAE::SurveyUses(const Value *V, UseVector &MaybeLiveUses) {
 489   // Assume it's dead (which will only hold if there are no uses at all..).
 490   Liveness Result = MaybeLive;
 491   // Check each use.
 492   for (Value::const_use_iterator I = V->use_begin(),
 493        E = V->use_end(); I != E; ++I) {
 494     Result = SurveyUse(I, MaybeLiveUses);
 495     if (Result == Live)
 496       break;
 497   }
 498   return Result;
 499 }
 500
 501 // SurveyFunction - This performs the initial survey of the specified function,
 502 // checking out whether or not it uses any of its incoming arguments or whether
 503 // any callers use the return value.  This fills in the LiveValues set and Uses
 504 // map.
 505 //
 506 // We consider arguments of non-internal functions to be intrinsically alive as
 507 // well as arguments to functions which have their "address taken".
 508 //
 509 void DAE::SurveyFunction(const Function &F) {
 510   unsigned RetCount = NumRetVals(&F);
 511   // Assume all return values are dead
 512   typedef SmallVector<Liveness, 5> RetVals;
 513   RetVals RetValLiveness(RetCount, MaybeLive);
 514
 515   typedef SmallVector<UseVector, 5> RetUses;
 516   // These vectors map each return value to the uses that make it MaybeLive, so
 517   // we can add those to the Uses map if the return value really turns out to be
 518   // MaybeLive. Initialized to a list of RetCount empty lists.
 519   RetUses MaybeLiveRetUses(RetCount);
 520
 521   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 522     if (const ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
 523       if (RI->getNumOperands() != 0 && RI->getOperand(0)->getType()
 524           != F.getFunctionType()->getReturnType()) {
 525         // We don't support old style multiple return values.
 526         MarkLive(F);
 527         return;
 528       }
 529
 530   if (!F.hasLocalLinkage() && (!ShouldHackArguments() || F.isIntrinsic())) {
 531     MarkLive(F);
 532     return;
 533   }
 534
 535   DEBUG(dbgs() << "DAE - Inspecting callers for fn: " << F.getName() << "\n");
 536   // Keep track of the number of live retvals, so we can skip checks once all
 537   // of them turn out to be live.
 538   unsigned NumLiveRetVals = 0;
 539   Type *STy = dyn_cast<StructType>(F.getReturnType());
 540   // Loop all uses of the function.
 541   for (Value::const_use_iterator I = F.use_begin(), E = F.use_end();
 542        I != E; ++I) {
 543     // If the function is PASSED IN as an argument, its address has been
 544     // taken.
 545     ImmutableCallSite CS(*I);
 546     if (!CS || !CS.isCallee(I)) {
 547       MarkLive(F);
 548       return;
 549     }
 550
 551     // If this use is anything other than a call site, the function is alive.
 552     const Instruction *TheCall = CS.getInstruction();
 553     if (!TheCall) {   // Not a direct call site?
 554       MarkLive(F);
 555       return;
 556     }
 557
 558     // If we end up here, we are looking at a direct call to our function.
 559
 560     // Now, check how our return value(s) is/are used in this caller. Don't
 561     // bother checking return values if all of them are live already.
 562     if (NumLiveRetVals != RetCount) {
 563       if (STy) {
 564         // Check all uses of the return value.
 565         for (Value::const_use_iterator I = TheCall->use_begin(),
 566              E = TheCall->use_end(); I != E; ++I) {
 567           const ExtractValueInst *Ext = dyn_cast<ExtractValueInst>(*I);
 568           if (Ext && Ext->hasIndices()) {
 569             // This use uses a part of our return value, survey the uses of
 570             // that part and store the results for this index only.
 571             unsigned Idx = *Ext->idx_begin();
 572             if (RetValLiveness[Idx] != Live) {
 573               RetValLiveness[Idx] = SurveyUses(Ext, MaybeLiveRetUses[Idx]);
 574               if (RetValLiveness[Idx] == Live)
 575                 NumLiveRetVals++;
 576             }
 577           } else {
 578             // Used by something else than extractvalue. Mark all return
 579             // values as live.
 580             for (unsigned i = 0; i != RetCount; ++i )
 581               RetValLiveness[i] = Live;
 582             NumLiveRetVals = RetCount;
 583             break;
 584           }
 585         }
 586       } else {
 587         // Single return value
 588         RetValLiveness[0] = SurveyUses(TheCall, MaybeLiveRetUses[0]);
 589         if (RetValLiveness[0] == Live)
 590           NumLiveRetVals = RetCount;
 591       }
 592     }
 593   }
 594
 595   // Now we've inspected all callers, record the liveness of our return values.
 596   for (unsigned i = 0; i != RetCount; ++i)
 597     MarkValue(CreateRet(&F, i), RetValLiveness[i], MaybeLiveRetUses[i]);
 598
 599   DEBUG(dbgs() << "DAE - Inspecting args for fn: " << F.getName() << "\n");
 600
 601   // Now, check all of our arguments.
 602   unsigned i = 0;
 603   UseVector MaybeLiveArgUses;
 604   for (Function::const_arg_iterator AI = F.arg_begin(),
 605        E = F.arg_end(); AI != E; ++AI, ++i) {
 606     // See what the effect of this use is (recording any uses that cause
 607     // MaybeLive in MaybeLiveArgUses).
 608     Liveness Result = SurveyUses(AI, MaybeLiveArgUses);
 609     // Mark the result.
 610     MarkValue(CreateArg(&F, i), Result, MaybeLiveArgUses);
 611     // Clear the vector again for the next iteration.
 612     MaybeLiveArgUses.clear();
 613   }
 614 }
 615
 616 /// MarkValue - This function marks the liveness of RA depending on L. If L is
 617 /// MaybeLive, it also takes all uses in MaybeLiveUses and records them in Uses,
 618 /// such that RA will be marked live if any use in MaybeLiveUses gets marked
 619 /// live later on.
 620 void DAE::MarkValue(const RetOrArg &RA, Liveness L,
 621                     const UseVector &MaybeLiveUses) {
 622   switch (L) {
 623     case Live: MarkLive(RA); break;
 624     case MaybeLive:
 625     {
 626       // Note any uses of this value, so this return value can be
 627       // marked live whenever one of the uses becomes live.
 628       for (UseVector::const_iterator UI = MaybeLiveUses.begin(),
 629            UE = MaybeLiveUses.end(); UI != UE; ++UI)
 630         Uses.insert(std::make_pair(*UI, RA));
 631       break;
 632     }
 633   }
 634 }
 635
 636 /// MarkLive - Mark the given Function as alive, meaning that it cannot be
 637 /// changed in any way. Additionally,
 638 /// mark any values that are used as this function's parameters or by its return
 639 /// values (according to Uses) live as well.
 640 void DAE::MarkLive(const Function &F) {
 641   DEBUG(dbgs() << "DAE - Intrinsically live fn: " << F.getName() << "\n");
 642   // Mark the function as live.
 643   LiveFunctions.insert(&F);
 644   // Mark all arguments as live.
 645   for (unsigned i = 0, e = F.arg_size(); i != e; ++i)
 646     PropagateLiveness(CreateArg(&F, i));
 647   // Mark all return values as live.
 648   for (unsigned i = 0, e = NumRetVals(&F); i != e; ++i)
 649     PropagateLiveness(CreateRet(&F, i));
 650 }
 651
 652 /// MarkLive - Mark the given return value or argument as live. Additionally,
 653 /// mark any values that are used by this value (according to Uses) live as
 654 /// well.
 655 void DAE::MarkLive(const RetOrArg &RA) {
 656   if (LiveFunctions.count(RA.F))
 657     return; // Function was already marked Live.
 658
 659   if (!LiveValues.insert(RA).second)
 660     return; // We were already marked Live.
 661
 662   DEBUG(dbgs() << "DAE - Marking " << RA.getDescription() << " live\n");
 663   PropagateLiveness(RA);
 664 }
 665
 666 /// PropagateLiveness - Given that RA is a live value, propagate it's liveness
 667 /// to any other values it uses (according to Uses).
 668 void DAE::PropagateLiveness(const RetOrArg &RA) {
 669   // We don't use upper_bound (or equal_range) here, because our recursive call
 670   // to ourselves is likely to cause the upper_bound (which is the first value
 671   // not belonging to RA) to become erased and the iterator invalidated.
 672   UseMap::iterator Begin = Uses.lower_bound(RA);
 673   UseMap::iterator E = Uses.end();
 674   UseMap::iterator I;
 675   for (I = Begin; I != E && I->first == RA; ++I)
 676     MarkLive(I->second);
 677
 678   // Erase RA from the Uses map (from the lower bound to wherever we ended up
 679   // after the loop).
 680   Uses.erase(Begin, I);
 681 }
 682
 683 // RemoveDeadStuffFromFunction - Remove any arguments and return values from F
 684 // that are not in LiveValues. Transform the function and all of the callees of
 685 // the function to not have these arguments and return values.
 686 //
 687 bool DAE::RemoveDeadStuffFromFunction(Function *F) {
 688   // Don't modify fully live functions
 689   if (LiveFunctions.count(F))
 690     return false;
 691
 692   // Start by computing a new prototype for the function, which is the same as
 693   // the old function, but has fewer arguments and a different return type.
 694   FunctionType *FTy = F->getFunctionType();
 695   std::vector<Type*> Params;
 696
 697   // Set up to build a new list of parameter attributes.
 698   SmallVector<AttributeWithIndex, 8> AttributesVec;
 699   const AttrListPtr &PAL = F->getAttributes();
 700
 701   // The existing function return attributes.
 702   Attributes RAttrs = PAL.getRetAttributes();
 703   Attributes FnAttrs = PAL.getFnAttributes();
 704
 705   // Find out the new return value.
 706
 707   Type *RetTy = FTy->getReturnType();
 708   Type *NRetTy = NULL;
 709   unsigned RetCount = NumRetVals(F);
 710
 711   // -1 means unused, other numbers are the new index
 712   SmallVector<int, 5> NewRetIdxs(RetCount, -1);
 713   std::vector<Type*> RetTypes;
 714   if (RetTy->isVoidTy()) {
 715     NRetTy = RetTy;
 716   } else {
 717     StructType *STy = dyn_cast<StructType>(RetTy);
 718     if (STy)
 719       // Look at each of the original return values individually.
 720       for (unsigned i = 0; i != RetCount; ++i) {
 721         RetOrArg Ret = CreateRet(F, i);
 722         if (LiveValues.erase(Ret)) {
 723           RetTypes.push_back(STy->getElementType(i));
 724           NewRetIdxs[i] = RetTypes.size() - 1;
 725         } else {
 726           ++NumRetValsEliminated;
 727           DEBUG(dbgs() << "DAE - Removing return value " << i << " from "
 728                 << F->getName() << "\n");
 729         }
 730       }
 731     else
 732       // We used to return a single value.
 733       if (LiveValues.erase(CreateRet(F, 0))) {
 734         RetTypes.push_back(RetTy);
 735         NewRetIdxs[0] = 0;
 736       } else {
 737         DEBUG(dbgs() << "DAE - Removing return value from " << F->getName()
 738               << "\n");
 739         ++NumRetValsEliminated;
 740       }
 741     if (RetTypes.size() > 1)
 742       // More than one return type? Return a struct with them. Also, if we used
 743       // to return a struct and didn't change the number of return values,
 744       // return a struct again. This prevents changing {something} into
 745       // something and {} into void.
 746       // Make the new struct packed if we used to return a packed struct
 747       // already.
 748       NRetTy = StructType::get(STy->getContext(), RetTypes, STy->isPacked());
 749     else if (RetTypes.size() == 1)
 750       // One return type? Just a simple value then, but only if we didn't use to
 751       // return a struct with that simple value before.
 752       NRetTy = RetTypes.front();
 753     else if (RetTypes.size() == 0)
 754       // No return types? Make it void, but only if we didn't use to return {}.
 755       NRetTy = Type::getVoidTy(F->getContext());
 756   }
 757
 758   assert(NRetTy && "No new return type found?");
 759
 760   // Remove any incompatible attributes, but only if we removed all return
 761   // values. Otherwise, ensure that we don't have any conflicting attributes
 762   // here. Currently, this should not be possible, but special handling might be
 763   // required when new return value attributes are added.
 764   if (NRetTy->isVoidTy())
 765     RAttrs &= ~Attributes::typeIncompatible(NRetTy);
 766   else
 767     assert((RAttrs & Attributes::typeIncompatible(NRetTy)) == 0
 768            && "Return attributes no longer compatible?");
 769
 770   if (RAttrs)
 771     AttributesVec.push_back(AttributeWithIndex::get(0, RAttrs));
 772
 773   // Remember which arguments are still alive.
 774   SmallVector<bool, 10> ArgAlive(FTy->getNumParams(), false);
 775   // Construct the new parameter list from non-dead arguments. Also construct
 776   // a new set of parameter attributes to correspond. Skip the first parameter
 777   // attribute, since that belongs to the return value.
 778   unsigned i = 0;
 779   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 780        I != E; ++I, ++i) {
 781     RetOrArg Arg = CreateArg(F, i);
 782     if (LiveValues.erase(Arg)) {
 783       Params.push_back(I->getType());
 784       ArgAlive[i] = true;
 785
 786       // Get the original parameter attributes (skipping the first one, that is
 787       // for the return value.
 788       if (Attributes Attrs = PAL.getParamAttributes(i + 1))
 789         AttributesVec.push_back(AttributeWithIndex::get(Params.size(), Attrs));
 790     } else {
 791       ++NumArgumentsEliminated;
 792       DEBUG(dbgs() << "DAE - Removing argument " << i << " (" << I->getName()
 793             << ") from " << F->getName() << "\n");
 794     }
 795   }
 796
 797   if (FnAttrs.hasAttributes())
 798     AttributesVec.push_back(AttributeWithIndex::get(~0, FnAttrs));
 799
 800   // Reconstruct the AttributesList based on the vector we constructed.
 801   AttrListPtr NewPAL = AttrListPtr::get(AttributesVec);
 802
 803   // Create the new function type based on the recomputed parameters.
 804   FunctionType *NFTy = FunctionType::get(NRetTy, Params, FTy->isVarArg());
 805
 806   // No change?
 807   if (NFTy == FTy)
 808     return false;
 809
 810   // Create the new function body and insert it into the module...
 811   Function *NF = Function::Create(NFTy, F->getLinkage());
 812   NF->copyAttributesFrom(F);
 813   NF->setAttributes(NewPAL);
 814   // Insert the new function before the old function, so we won't be processing
 815   // it again.
 816   F->getParent()->getFunctionList().insert(F, NF);
 817   NF->takeName(F);
 818
 819   // Loop over all of the callers of the function, transforming the call sites
 820   // to pass in a smaller number of arguments into the new function.
 821   //
 822   std::vector<Value*> Args;
 823   while (!F->use_empty()) {
 824     CallSite CS(F->use_back());
 825     Instruction *Call = CS.getInstruction();
 826
 827     AttributesVec.clear();
 828     const AttrListPtr &CallPAL = CS.getAttributes();
 829
 830     // The call return attributes.
 831     Attributes RAttrs = CallPAL.getRetAttributes();
 832     Attributes FnAttrs = CallPAL.getFnAttributes();
 833     // Adjust in case the function was changed to return void.
 834     RAttrs &= ~Attributes::typeIncompatible(NF->getReturnType());
 835     if (RAttrs)
 836       AttributesVec.push_back(AttributeWithIndex::get(0, RAttrs));
 837
 838     // Declare these outside of the loops, so we can reuse them for the second
 839     // loop, which loops the varargs.
 840     CallSite::arg_iterator I = CS.arg_begin();
 841     unsigned i = 0;
 842     // Loop over those operands, corresponding to the normal arguments to the
 843     // original function, and add those that are still alive.
 844     for (unsigned e = FTy->getNumParams(); i != e; ++I, ++i)
 845       if (ArgAlive[i]) {
 846         Args.push_back(*I);
 847         // Get original parameter attributes, but skip return attributes.
 848         if (Attributes Attrs = CallPAL.getParamAttributes(i + 1))
 849           AttributesVec.push_back(AttributeWithIndex::get(Args.size(), Attrs));
 850       }
 851
 852     // Push any varargs arguments on the list. Don't forget their attributes.
 853     for (CallSite::arg_iterator E = CS.arg_end(); I != E; ++I, ++i) {
 854       Args.push_back(*I);
 855       if (Attributes Attrs = CallPAL.getParamAttributes(i + 1))
 856         AttributesVec.push_back(AttributeWithIndex::get(Args.size(), Attrs));
 857     }
 858
 859     if (FnAttrs.hasAttributes())
 860       AttributesVec.push_back(AttributeWithIndex::get(~0, FnAttrs));
 861
 862     // Reconstruct the AttributesList based on the vector we constructed.
 863     AttrListPtr NewCallPAL = AttrListPtr::get(AttributesVec);
 864
 865     Instruction *New;
 866     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 867       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
 868                                Args, "", Call);
 869       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
 870       cast<InvokeInst>(New)->setAttributes(NewCallPAL);
 871     } else {
 872       New = CallInst::Create(NF, Args, "", Call);
 873       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
 874       cast<CallInst>(New)->setAttributes(NewCallPAL);
 875       if (cast<CallInst>(Call)->isTailCall())
 876         cast<CallInst>(New)->setTailCall();
 877     }
 878     New->setDebugLoc(Call->getDebugLoc());
 879
 880     Args.clear();
 881
 882     if (!Call->use_empty()) {
 883       if (New->getType() == Call->getType()) {
 884         // Return type not changed? Just replace users then.
 885         Call->replaceAllUsesWith(New);
 886         New->takeName(Call);
 887       } else if (New->getType()->isVoidTy()) {
 888         // Our return value has uses, but they will get removed later on.
 889         // Replace by null for now.
 890         if (!Call->getType()->isX86_MMXTy())
 891           Call->replaceAllUsesWith(Constant::getNullValue(Call->getType()));
 892       } else {
 893         assert(RetTy->isStructTy() &&
 894                "Return type changed, but not into a void. The old return type"
 895                " must have been a struct!");
 896         Instruction *InsertPt = Call;
 897         if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 898           BasicBlock::iterator IP = II->getNormalDest()->begin();
 899           while (isa<PHINode>(IP)) ++IP;
 900           InsertPt = IP;
 901         }
 902
 903         // We used to return a struct. Instead of doing smart stuff with all the
 904         // uses of this struct, we will just rebuild it using
 905         // extract/insertvalue chaining and let instcombine clean that up.
 906         //
 907         // Start out building up our return value from undef
 908         Value *RetVal = UndefValue::get(RetTy);
 909         for (unsigned i = 0; i != RetCount; ++i)
 910           if (NewRetIdxs[i] != -1) {
 911             Value *V;
 912             if (RetTypes.size() > 1)
 913               // We are still returning a struct, so extract the value from our
 914               // return value
 915               V = ExtractValueInst::Create(New, NewRetIdxs[i], "newret",
 916                                            InsertPt);
 917             else
 918               // We are now returning a single element, so just insert that
 919               V = New;
 920             // Insert the value at the old position
 921             RetVal = InsertValueInst::Create(RetVal, V, i, "oldret", InsertPt);
 922           }
 923         // Now, replace all uses of the old call instruction with the return
 924         // struct we built
 925         Call->replaceAllUsesWith(RetVal);
 926         New->takeName(Call);
 927       }
 928     }
 929
 930     // Finally, remove the old call from the program, reducing the use-count of
 931     // F.
 932     Call->eraseFromParent();
 933   }
 934
 935   // Since we have now created the new function, splice the body of the old
 936   // function right into the new function, leaving the old rotting hulk of the
 937   // function empty.
 938   NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
 939
 940   // Loop over the argument list, transferring uses of the old arguments over to
 941   // the new arguments, also transferring over the names as well.
 942   i = 0;
 943   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(),
 944        I2 = NF->arg_begin(); I != E; ++I, ++i)
 945     if (ArgAlive[i]) {
 946       // If this is a live argument, move the name and users over to the new
 947       // version.
 948       I->replaceAllUsesWith(I2);
 949       I2->takeName(I);
 950       ++I2;
 951     } else {
 952       // If this argument is dead, replace any uses of it with null constants
 953       // (these are guaranteed to become unused later on).
 954       if (!I->getType()->isX86_MMXTy())
 955         I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
 956     }
 957
 958   // If we change the return value of the function we must rewrite any return
 959   // instructions.  Check this now.
 960   if (F->getReturnType() != NF->getReturnType())
 961     for (Function::iterator BB = NF->begin(), E = NF->end(); BB != E; ++BB)
 962       if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
 963         Value *RetVal;
 964
 965         if (NFTy->getReturnType()->isVoidTy()) {
 966           RetVal = 0;
 967         } else {
 968           assert (RetTy->isStructTy());
 969           // The original return value was a struct, insert
 970           // extractvalue/insertvalue chains to extract only the values we need
 971           // to return and insert them into our new result.
 972           // This does generate messy code, but we'll let it to instcombine to
 973           // clean that up.
 974           Value *OldRet = RI->getOperand(0);
 975           // Start out building up our return value from undef
 976           RetVal = UndefValue::get(NRetTy);
 977           for (unsigned i = 0; i != RetCount; ++i)
 978             if (NewRetIdxs[i] != -1) {
 979               ExtractValueInst *EV = ExtractValueInst::Create(OldRet, i,
 980                                                               "oldret", RI);
 981               if (RetTypes.size() > 1) {
 982                 // We're still returning a struct, so reinsert the value into
 983                 // our new return value at the new index
 984
 985                 RetVal = InsertValueInst::Create(RetVal, EV, NewRetIdxs[i],
 986                                                  "newret", RI);
 987               } else {
 988                 // We are now only returning a simple value, so just return the
 989                 // extracted value.
 990                 RetVal = EV;
 991               }
 992             }
 993         }
 994         // Replace the return instruction with one returning the new return
 995         // value (possibly 0 if we became void).
 996         ReturnInst::Create(F->getContext(), RetVal, RI);
 997         BB->getInstList().erase(RI);
 998       }
 999
1000   // Patch the pointer to LLVM function in debug info descriptor.
1001   FunctionDIMap::iterator DI = FunctionDIs.find(F);
1002   if (DI != FunctionDIs.end())
1003     DI->second.replaceFunction(NF);
1004
1005   // Now that the old function is dead, delete it.
1006   F->eraseFromParent();
1007
1008   return true;
1009 }
1010
1011 bool DAE::runOnModule(Module &M) {
1012   bool Changed = false;
1013
1014   // Collect debug info descriptors for functions.
1015   CollectFunctionDIs(M);
1016
1017   // First pass: Do a simple check to see if any functions can have their "..."
1018   // removed.  We can do this if they never call va_start.  This loop cannot be
1019   // fused with the next loop, because deleting a function invalidates
1020   // information computed while surveying other functions.
1021   DEBUG(dbgs() << "DAE - Deleting dead varargs\n");
1022   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1023     Function &F = *I++;
1024     if (F.getFunctionType()->isVarArg())
1025       Changed |= DeleteDeadVarargs(F);
1026   }
1027
1028   // Second phase:loop through the module, determining which arguments are live.
1029   // We assume all arguments are dead unless proven otherwise (allowing us to
1030   // determine that dead arguments passed into recursive functions are dead).
1031   //
1032   DEBUG(dbgs() << "DAE - Determining liveness\n");
1033   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1034     SurveyFunction(*I);
1035
1036   // Now, remove all dead arguments and return values from each function in
1037   // turn.
1038   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1039     // Increment now, because the function will probably get removed (ie.
1040     // replaced by a new one).
1041     Function *F = I++;
1042     Changed |= RemoveDeadStuffFromFunction(F);
1043   }
1044
1045   // Finally, look for any unused parameters in functions with non-local
1046   // linkage and replace the passed in parameters with undef.
1047   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
1048     Function& F = *I;
1049
1050     Changed |= RemoveDeadArgumentsFromCallers(F);
1051   }
1052
1053   return Changed;
1054 }