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/ADT/DenseMap.h"
  23 #include "llvm/ADT/SmallVector.h"
  24 #include "llvm/ADT/Statistic.h"
  25 #include "llvm/ADT/StringExtras.h"
  26 #include "llvm/DIBuilder.h"
  27 #include "llvm/DebugInfo.h"
  28 #include "llvm/IR/CallingConv.h"
  29 #include "llvm/IR/Constant.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/CallSite.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/raw_ostream.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   for (Value::use_iterator I = Fn.use_begin(), E = Fn.use_end(); I != E; ) {
 267     CallSite CS(*I++);
 268     if (!CS)
 269       continue;
 270     Instruction *Call = CS.getInstruction();
 271
 272     // Pass all the same arguments.
 273     Args.assign(CS.arg_begin(), CS.arg_begin() + NumArgs);
 274
 275     // Drop any attributes that were on the vararg arguments.
 276     AttributeSet PAL = CS.getAttributes();
 277     if (!PAL.isEmpty() && PAL.getSlotIndex(PAL.getNumSlots() - 1) > NumArgs) {
 278       SmallVector<AttributeSet, 8> AttributesVec;
 279       for (unsigned i = 0; PAL.getSlotIndex(i) <= NumArgs; ++i)
 280         AttributesVec.push_back(PAL.getSlotAttributes(i));
 281       if (PAL.hasAttributes(AttributeSet::FunctionIndex))
 282         AttributesVec.push_back(AttributeSet::get(Fn.getContext(),
 283                                                   PAL.getFnAttributes()));
 284       PAL = AttributeSet::get(Fn.getContext(), AttributesVec);
 285     }
 286
 287     Instruction *New;
 288     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 289       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
 290                                Args, "", Call);
 291       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
 292       cast<InvokeInst>(New)->setAttributes(PAL);
 293     } else {
 294       New = CallInst::Create(NF, Args, "", Call);
 295       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
 296       cast<CallInst>(New)->setAttributes(PAL);
 297       if (cast<CallInst>(Call)->isTailCall())
 298         cast<CallInst>(New)->setTailCall();
 299     }
 300     New->setDebugLoc(Call->getDebugLoc());
 301
 302     Args.clear();
 303
 304     if (!Call->use_empty())
 305       Call->replaceAllUsesWith(New);
 306
 307     New->takeName(Call);
 308
 309     // Finally, remove the old call from the program, reducing the use-count of
 310     // F.
 311     Call->eraseFromParent();
 312   }
 313
 314   // Since we have now created the new function, splice the body of the old
 315   // function right into the new function, leaving the old rotting hulk of the
 316   // function empty.
 317   NF->getBasicBlockList().splice(NF->begin(), Fn.getBasicBlockList());
 318
 319   // Loop over the argument list, transferring uses of the old arguments over to
 320   // the new arguments, also transferring over the names as well.  While we're at
 321   // it, remove the dead arguments from the DeadArguments list.
 322   //
 323   for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end(),
 324        I2 = NF->arg_begin(); I != E; ++I, ++I2) {
 325     // Move the name and users over to the new version.
 326     I->replaceAllUsesWith(I2);
 327     I2->takeName(I);
 328   }
 329
 330   // Patch the pointer to LLVM function in debug info descriptor.
 331   FunctionDIMap::iterator DI = FunctionDIs.find(&Fn);
 332   if (DI != FunctionDIs.end())
 333     DI->second.replaceFunction(NF);
 334
 335   // Fix up any BlockAddresses that refer to the function.
 336   Fn.replaceAllUsesWith(ConstantExpr::getBitCast(NF, Fn.getType()));
 337   // Delete the bitcast that we just created, so that NF does not
 338   // appear to be address-taken.
 339   NF->removeDeadConstantUsers();
 340   // Finally, nuke the old function.
 341   Fn.eraseFromParent();
 342   return true;
 343 }
 344
 345 /// RemoveDeadArgumentsFromCallers - Checks if the given function has any
 346 /// arguments that are unused, and changes the caller parameters to be undefined
 347 /// instead.
 348 bool DAE::RemoveDeadArgumentsFromCallers(Function &Fn)
 349 {
 350   if (Fn.isDeclaration() || Fn.mayBeOverridden())
 351     return false;
 352
 353   // Functions with local linkage should already have been handled, except the
 354   // fragile (variadic) ones which we can improve here.
 355   if (Fn.hasLocalLinkage() && !Fn.getFunctionType()->isVarArg())
 356     return false;
 357
 358   if (Fn.use_empty())
 359     return false;
 360
 361   SmallVector<unsigned, 8> UnusedArgs;
 362   for (Function::arg_iterator I = Fn.arg_begin(), E = Fn.arg_end();
 363        I != E; ++I) {
 364     Argument *Arg = I;
 365
 366     if (Arg->use_empty() && !Arg->hasByValAttr())
 367       UnusedArgs.push_back(Arg->getArgNo());
 368   }
 369
 370   if (UnusedArgs.empty())
 371     return false;
 372
 373   bool Changed = false;
 374
 375   for (Function::use_iterator I = Fn.use_begin(), E = Fn.use_end();
 376        I != E; ++I) {
 377     CallSite CS(*I);
 378     if (!CS || !CS.isCallee(I))
 379       continue;
 380
 381     // Now go through all unused args and replace them with "undef".
 382     for (unsigned I = 0, E = UnusedArgs.size(); I != E; ++I) {
 383       unsigned ArgNo = UnusedArgs[I];
 384
 385       Value *Arg = CS.getArgument(ArgNo);
 386       CS.setArgument(ArgNo, UndefValue::get(Arg->getType()));
 387       ++NumArgumentsReplacedWithUndef;
 388       Changed = true;
 389     }
 390   }
 391
 392   return Changed;
 393 }
 394
 395 /// Convenience function that returns the number of return values. It returns 0
 396 /// for void functions and 1 for functions not returning a struct. It returns
 397 /// the number of struct elements for functions returning a struct.
 398 static unsigned NumRetVals(const Function *F) {
 399   if (F->getReturnType()->isVoidTy())
 400     return 0;
 401   else if (StructType *STy = dyn_cast<StructType>(F->getReturnType()))
 402     return STy->getNumElements();
 403   else
 404     return 1;
 405 }
 406
 407 /// MarkIfNotLive - This checks Use for liveness in LiveValues. If Use is not
 408 /// live, it adds Use to the MaybeLiveUses argument. Returns the determined
 409 /// liveness of Use.
 410 DAE::Liveness DAE::MarkIfNotLive(RetOrArg Use, UseVector &MaybeLiveUses) {
 411   // We're live if our use or its Function is already marked as live.
 412   if (LiveFunctions.count(Use.F) || LiveValues.count(Use))
 413     return Live;
 414
 415   // We're maybe live otherwise, but remember that we must become live if
 416   // Use becomes live.
 417   MaybeLiveUses.push_back(Use);
 418   return MaybeLive;
 419 }
 420
 421
 422 /// SurveyUse - This looks at a single use of an argument or return value
 423 /// and determines if it should be alive or not. Adds this use to MaybeLiveUses
 424 /// if it causes the used value to become MaybeLive.
 425 ///
 426 /// RetValNum is the return value number to use when this use is used in a
 427 /// return instruction. This is used in the recursion, you should always leave
 428 /// it at 0.
 429 DAE::Liveness DAE::SurveyUse(Value::const_use_iterator U,
 430                              UseVector &MaybeLiveUses, unsigned RetValNum) {
 431     const User *V = *U;
 432     if (const ReturnInst *RI = dyn_cast<ReturnInst>(V)) {
 433       // The value is returned from a function. It's only live when the
 434       // function's return value is live. We use RetValNum here, for the case
 435       // that U is really a use of an insertvalue instruction that uses the
 436       // original Use.
 437       RetOrArg Use = CreateRet(RI->getParent()->getParent(), RetValNum);
 438       // We might be live, depending on the liveness of Use.
 439       return MarkIfNotLive(Use, MaybeLiveUses);
 440     }
 441     if (const InsertValueInst *IV = dyn_cast<InsertValueInst>(V)) {
 442       if (U.getOperandNo() != InsertValueInst::getAggregateOperandIndex()
 443           && IV->hasIndices())
 444         // The use we are examining is inserted into an aggregate. Our liveness
 445         // depends on all uses of that aggregate, but if it is used as a return
 446         // value, only index at which we were inserted counts.
 447         RetValNum = *IV->idx_begin();
 448
 449       // Note that if we are used as the aggregate operand to the insertvalue,
 450       // we don't change RetValNum, but do survey all our uses.
 451
 452       Liveness Result = MaybeLive;
 453       for (Value::const_use_iterator I = IV->use_begin(),
 454            E = V->use_end(); I != E; ++I) {
 455         Result = SurveyUse(I, MaybeLiveUses, RetValNum);
 456         if (Result == Live)
 457           break;
 458       }
 459       return Result;
 460     }
 461
 462     if (ImmutableCallSite CS = V) {
 463       const Function *F = CS.getCalledFunction();
 464       if (F) {
 465         // Used in a direct call.
 466
 467         // Find the argument number. We know for sure that this use is an
 468         // argument, since if it was the function argument this would be an
 469         // indirect call and the we know can't be looking at a value of the
 470         // label type (for the invoke instruction).
 471         unsigned ArgNo = CS.getArgumentNo(U);
 472
 473         if (ArgNo >= F->getFunctionType()->getNumParams())
 474           // The value is passed in through a vararg! Must be live.
 475           return Live;
 476
 477         assert(CS.getArgument(ArgNo)
 478                == CS->getOperand(U.getOperandNo())
 479                && "Argument is not where we expected it");
 480
 481         // Value passed to a normal call. It's only live when the corresponding
 482         // argument to the called function turns out live.
 483         RetOrArg Use = CreateArg(F, ArgNo);
 484         return MarkIfNotLive(Use, MaybeLiveUses);
 485       }
 486     }
 487     // Used in any other way? Value must be live.
 488     return Live;
 489 }
 490
 491 /// SurveyUses - This looks at all the uses of the given value
 492 /// Returns the Liveness deduced from the uses of this value.
 493 ///
 494 /// Adds all uses that cause the result to be MaybeLive to MaybeLiveRetUses. If
 495 /// the result is Live, MaybeLiveUses might be modified but its content should
 496 /// be ignored (since it might not be complete).
 497 DAE::Liveness DAE::SurveyUses(const Value *V, UseVector &MaybeLiveUses) {
 498   // Assume it's dead (which will only hold if there are no uses at all..).
 499   Liveness Result = MaybeLive;
 500   // Check each use.
 501   for (Value::const_use_iterator I = V->use_begin(),
 502        E = V->use_end(); I != E; ++I) {
 503     Result = SurveyUse(I, MaybeLiveUses);
 504     if (Result == Live)
 505       break;
 506   }
 507   return Result;
 508 }
 509
 510 // SurveyFunction - This performs the initial survey of the specified function,
 511 // checking out whether or not it uses any of its incoming arguments or whether
 512 // any callers use the return value.  This fills in the LiveValues set and Uses
 513 // map.
 514 //
 515 // We consider arguments of non-internal functions to be intrinsically alive as
 516 // well as arguments to functions which have their "address taken".
 517 //
 518 void DAE::SurveyFunction(const Function &F) {
 519   unsigned RetCount = NumRetVals(&F);
 520   // Assume all return values are dead
 521   typedef SmallVector<Liveness, 5> RetVals;
 522   RetVals RetValLiveness(RetCount, MaybeLive);
 523
 524   typedef SmallVector<UseVector, 5> RetUses;
 525   // These vectors map each return value to the uses that make it MaybeLive, so
 526   // we can add those to the Uses map if the return value really turns out to be
 527   // MaybeLive. Initialized to a list of RetCount empty lists.
 528   RetUses MaybeLiveRetUses(RetCount);
 529
 530   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 531     if (const ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator()))
 532       if (RI->getNumOperands() != 0 && RI->getOperand(0)->getType()
 533           != F.getFunctionType()->getReturnType()) {
 534         // We don't support old style multiple return values.
 535         MarkLive(F);
 536         return;
 537       }
 538
 539   if (!F.hasLocalLinkage() && (!ShouldHackArguments() || F.isIntrinsic())) {
 540     MarkLive(F);
 541     return;
 542   }
 543
 544   DEBUG(dbgs() << "DAE - Inspecting callers for fn: " << F.getName() << "\n");
 545   // Keep track of the number of live retvals, so we can skip checks once all
 546   // of them turn out to be live.
 547   unsigned NumLiveRetVals = 0;
 548   Type *STy = dyn_cast<StructType>(F.getReturnType());
 549   // Loop all uses of the function.
 550   for (Value::const_use_iterator I = F.use_begin(), E = F.use_end();
 551        I != E; ++I) {
 552     // If the function is PASSED IN as an argument, its address has been
 553     // taken.
 554     ImmutableCallSite CS(*I);
 555     if (!CS || !CS.isCallee(I)) {
 556       MarkLive(F);
 557       return;
 558     }
 559
 560     // If this use is anything other than a call site, the function is alive.
 561     const Instruction *TheCall = CS.getInstruction();
 562     if (!TheCall) {   // Not a direct call site?
 563       MarkLive(F);
 564       return;
 565     }
 566
 567     // If we end up here, we are looking at a direct call to our function.
 568
 569     // Now, check how our return value(s) is/are used in this caller. Don't
 570     // bother checking return values if all of them are live already.
 571     if (NumLiveRetVals != RetCount) {
 572       if (STy) {
 573         // Check all uses of the return value.
 574         for (Value::const_use_iterator I = TheCall->use_begin(),
 575              E = TheCall->use_end(); I != E; ++I) {
 576           const ExtractValueInst *Ext = dyn_cast<ExtractValueInst>(*I);
 577           if (Ext && Ext->hasIndices()) {
 578             // This use uses a part of our return value, survey the uses of
 579             // that part and store the results for this index only.
 580             unsigned Idx = *Ext->idx_begin();
 581             if (RetValLiveness[Idx] != Live) {
 582               RetValLiveness[Idx] = SurveyUses(Ext, MaybeLiveRetUses[Idx]);
 583               if (RetValLiveness[Idx] == Live)
 584                 NumLiveRetVals++;
 585             }
 586           } else {
 587             // Used by something else than extractvalue. Mark all return
 588             // values as live.
 589             for (unsigned i = 0; i != RetCount; ++i )
 590               RetValLiveness[i] = Live;
 591             NumLiveRetVals = RetCount;
 592             break;
 593           }
 594         }
 595       } else {
 596         // Single return value
 597         RetValLiveness[0] = SurveyUses(TheCall, MaybeLiveRetUses[0]);
 598         if (RetValLiveness[0] == Live)
 599           NumLiveRetVals = RetCount;
 600       }
 601     }
 602   }
 603
 604   // Now we've inspected all callers, record the liveness of our return values.
 605   for (unsigned i = 0; i != RetCount; ++i)
 606     MarkValue(CreateRet(&F, i), RetValLiveness[i], MaybeLiveRetUses[i]);
 607
 608   DEBUG(dbgs() << "DAE - Inspecting args for fn: " << F.getName() << "\n");
 609
 610   // Now, check all of our arguments.
 611   unsigned i = 0;
 612   UseVector MaybeLiveArgUses;
 613   for (Function::const_arg_iterator AI = F.arg_begin(),
 614        E = F.arg_end(); AI != E; ++AI, ++i) {
 615     Liveness Result;
 616     if (F.getFunctionType()->isVarArg()) {
 617       // Variadic functions will already have a va_arg function expanded inside
 618       // them, making them potentially very sensitive to ABI changes resulting
 619       // from removing arguments entirely, so don't. For example AArch64 handles
 620       // register and stack HFAs very differently, and this is reflected in the
 621       // IR which has already been generated.
 622       Result = Live;
 623     } else {
 624       // See what the effect of this use is (recording any uses that cause
 625       // MaybeLive in MaybeLiveArgUses).
 626       Result = SurveyUses(AI, MaybeLiveArgUses);
 627     }
 628
 629     // Mark the result.
 630     MarkValue(CreateArg(&F, i), Result, MaybeLiveArgUses);
 631     // Clear the vector again for the next iteration.
 632     MaybeLiveArgUses.clear();
 633   }
 634 }
 635
 636 /// MarkValue - This function marks the liveness of RA depending on L. If L is
 637 /// MaybeLive, it also takes all uses in MaybeLiveUses and records them in Uses,
 638 /// such that RA will be marked live if any use in MaybeLiveUses gets marked
 639 /// live later on.
 640 void DAE::MarkValue(const RetOrArg &RA, Liveness L,
 641                     const UseVector &MaybeLiveUses) {
 642   switch (L) {
 643     case Live: MarkLive(RA); break;
 644     case MaybeLive:
 645     {
 646       // Note any uses of this value, so this return value can be
 647       // marked live whenever one of the uses becomes live.
 648       for (UseVector::const_iterator UI = MaybeLiveUses.begin(),
 649            UE = MaybeLiveUses.end(); UI != UE; ++UI)
 650         Uses.insert(std::make_pair(*UI, RA));
 651       break;
 652     }
 653   }
 654 }
 655
 656 /// MarkLive - Mark the given Function as alive, meaning that it cannot be
 657 /// changed in any way. Additionally,
 658 /// mark any values that are used as this function's parameters or by its return
 659 /// values (according to Uses) live as well.
 660 void DAE::MarkLive(const Function &F) {
 661   DEBUG(dbgs() << "DAE - Intrinsically live fn: " << F.getName() << "\n");
 662   // Mark the function as live.
 663   LiveFunctions.insert(&F);
 664   // Mark all arguments as live.
 665   for (unsigned i = 0, e = F.arg_size(); i != e; ++i)
 666     PropagateLiveness(CreateArg(&F, i));
 667   // Mark all return values as live.
 668   for (unsigned i = 0, e = NumRetVals(&F); i != e; ++i)
 669     PropagateLiveness(CreateRet(&F, i));
 670 }
 671
 672 /// MarkLive - Mark the given return value or argument as live. Additionally,
 673 /// mark any values that are used by this value (according to Uses) live as
 674 /// well.
 675 void DAE::MarkLive(const RetOrArg &RA) {
 676   if (LiveFunctions.count(RA.F))
 677     return; // Function was already marked Live.
 678
 679   if (!LiveValues.insert(RA).second)
 680     return; // We were already marked Live.
 681
 682   DEBUG(dbgs() << "DAE - Marking " << RA.getDescription() << " live\n");
 683   PropagateLiveness(RA);
 684 }
 685
 686 /// PropagateLiveness - Given that RA is a live value, propagate it's liveness
 687 /// to any other values it uses (according to Uses).
 688 void DAE::PropagateLiveness(const RetOrArg &RA) {
 689   // We don't use upper_bound (or equal_range) here, because our recursive call
 690   // to ourselves is likely to cause the upper_bound (which is the first value
 691   // not belonging to RA) to become erased and the iterator invalidated.
 692   UseMap::iterator Begin = Uses.lower_bound(RA);
 693   UseMap::iterator E = Uses.end();
 694   UseMap::iterator I;
 695   for (I = Begin; I != E && I->first == RA; ++I)
 696     MarkLive(I->second);
 697
 698   // Erase RA from the Uses map (from the lower bound to wherever we ended up
 699   // after the loop).
 700   Uses.erase(Begin, I);
 701 }
 702
 703 // RemoveDeadStuffFromFunction - Remove any arguments and return values from F
 704 // that are not in LiveValues. Transform the function and all of the callees of
 705 // the function to not have these arguments and return values.
 706 //
 707 bool DAE::RemoveDeadStuffFromFunction(Function *F) {
 708   // Don't modify fully live functions
 709   if (LiveFunctions.count(F))
 710     return false;
 711
 712   // Start by computing a new prototype for the function, which is the same as
 713   // the old function, but has fewer arguments and a different return type.
 714   FunctionType *FTy = F->getFunctionType();
 715   std::vector<Type*> Params;
 716
 717   // Set up to build a new list of parameter attributes.
 718   SmallVector<AttributeSet, 8> AttributesVec;
 719   const AttributeSet &PAL = F->getAttributes();
 720
 721   // Find out the new return value.
 722   Type *RetTy = FTy->getReturnType();
 723   Type *NRetTy = NULL;
 724   unsigned RetCount = NumRetVals(F);
 725
 726   // -1 means unused, other numbers are the new index
 727   SmallVector<int, 5> NewRetIdxs(RetCount, -1);
 728   std::vector<Type*> RetTypes;
 729   if (RetTy->isVoidTy()) {
 730     NRetTy = RetTy;
 731   } else {
 732     StructType *STy = dyn_cast<StructType>(RetTy);
 733     if (STy)
 734       // Look at each of the original return values individually.
 735       for (unsigned i = 0; i != RetCount; ++i) {
 736         RetOrArg Ret = CreateRet(F, i);
 737         if (LiveValues.erase(Ret)) {
 738           RetTypes.push_back(STy->getElementType(i));
 739           NewRetIdxs[i] = RetTypes.size() - 1;
 740         } else {
 741           ++NumRetValsEliminated;
 742           DEBUG(dbgs() << "DAE - Removing return value " << i << " from "
 743                 << F->getName() << "\n");
 744         }
 745       }
 746     else
 747       // We used to return a single value.
 748       if (LiveValues.erase(CreateRet(F, 0))) {
 749         RetTypes.push_back(RetTy);
 750         NewRetIdxs[0] = 0;
 751       } else {
 752         DEBUG(dbgs() << "DAE - Removing return value from " << F->getName()
 753               << "\n");
 754         ++NumRetValsEliminated;
 755       }
 756     if (RetTypes.size() > 1)
 757       // More than one return type? Return a struct with them. Also, if we used
 758       // to return a struct and didn't change the number of return values,
 759       // return a struct again. This prevents changing {something} into
 760       // something and {} into void.
 761       // Make the new struct packed if we used to return a packed struct
 762       // already.
 763       NRetTy = StructType::get(STy->getContext(), RetTypes, STy->isPacked());
 764     else if (RetTypes.size() == 1)
 765       // One return type? Just a simple value then, but only if we didn't use to
 766       // return a struct with that simple value before.
 767       NRetTy = RetTypes.front();
 768     else if (RetTypes.size() == 0)
 769       // No return types? Make it void, but only if we didn't use to return {}.
 770       NRetTy = Type::getVoidTy(F->getContext());
 771   }
 772
 773   assert(NRetTy && "No new return type found?");
 774
 775   // The existing function return attributes.
 776   AttributeSet RAttrs = PAL.getRetAttributes();
 777
 778   // Remove any incompatible attributes, but only if we removed all return
 779   // values. Otherwise, ensure that we don't have any conflicting attributes
 780   // here. Currently, this should not be possible, but special handling might be
 781   // required when new return value attributes are added.
 782   if (NRetTy->isVoidTy())
 783     RAttrs =
 784       AttributeSet::get(NRetTy->getContext(), AttributeSet::ReturnIndex,
 785                         AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
 786          removeAttributes(AttributeFuncs::
 787                           typeIncompatible(NRetTy, AttributeSet::ReturnIndex),
 788                           AttributeSet::ReturnIndex));
 789   else
 790     assert(!AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
 791              hasAttributes(AttributeFuncs::
 792                            typeIncompatible(NRetTy, AttributeSet::ReturnIndex),
 793                            AttributeSet::ReturnIndex) &&
 794            "Return attributes no longer compatible?");
 795
 796   if (RAttrs.hasAttributes(AttributeSet::ReturnIndex))
 797     AttributesVec.push_back(AttributeSet::get(NRetTy->getContext(), RAttrs));
 798
 799   // Remember which arguments are still alive.
 800   SmallVector<bool, 10> ArgAlive(FTy->getNumParams(), false);
 801   // Construct the new parameter list from non-dead arguments. Also construct
 802   // a new set of parameter attributes to correspond. Skip the first parameter
 803   // attribute, since that belongs to the return value.
 804   unsigned i = 0;
 805   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 806        I != E; ++I, ++i) {
 807     RetOrArg Arg = CreateArg(F, i);
 808     if (LiveValues.erase(Arg)) {
 809       Params.push_back(I->getType());
 810       ArgAlive[i] = true;
 811
 812       // Get the original parameter attributes (skipping the first one, that is
 813       // for the return value.
 814       if (PAL.hasAttributes(i + 1)) {
 815         AttrBuilder B(PAL, i + 1);
 816         AttributesVec.
 817           push_back(AttributeSet::get(F->getContext(), Params.size(), B));
 818       }
 819     } else {
 820       ++NumArgumentsEliminated;
 821       DEBUG(dbgs() << "DAE - Removing argument " << i << " (" << I->getName()
 822             << ") from " << F->getName() << "\n");
 823     }
 824   }
 825
 826   if (PAL.hasAttributes(AttributeSet::FunctionIndex))
 827     AttributesVec.push_back(AttributeSet::get(F->getContext(),
 828                                               PAL.getFnAttributes()));
 829
 830   // Reconstruct the AttributesList based on the vector we constructed.
 831   AttributeSet NewPAL = AttributeSet::get(F->getContext(), AttributesVec);
 832
 833   // Create the new function type based on the recomputed parameters.
 834   FunctionType *NFTy = FunctionType::get(NRetTy, Params, FTy->isVarArg());
 835
 836   // No change?
 837   if (NFTy == FTy)
 838     return false;
 839
 840   // Create the new function body and insert it into the module...
 841   Function *NF = Function::Create(NFTy, F->getLinkage());
 842   NF->copyAttributesFrom(F);
 843   NF->setAttributes(NewPAL);
 844   // Insert the new function before the old function, so we won't be processing
 845   // it again.
 846   F->getParent()->getFunctionList().insert(F, NF);
 847   NF->takeName(F);
 848
 849   // Loop over all of the callers of the function, transforming the call sites
 850   // to pass in a smaller number of arguments into the new function.
 851   //
 852   std::vector<Value*> Args;
 853   while (!F->use_empty()) {
 854     CallSite CS(F->use_back());
 855     Instruction *Call = CS.getInstruction();
 856
 857     AttributesVec.clear();
 858     const AttributeSet &CallPAL = CS.getAttributes();
 859
 860     // The call return attributes.
 861     AttributeSet RAttrs = CallPAL.getRetAttributes();
 862
 863     // Adjust in case the function was changed to return void.
 864     RAttrs =
 865       AttributeSet::get(NF->getContext(), AttributeSet::ReturnIndex,
 866                         AttrBuilder(RAttrs, AttributeSet::ReturnIndex).
 867         removeAttributes(AttributeFuncs::
 868                          typeIncompatible(NF->getReturnType(),
 869                                           AttributeSet::ReturnIndex),
 870                          AttributeSet::ReturnIndex));
 871     if (RAttrs.hasAttributes(AttributeSet::ReturnIndex))
 872       AttributesVec.push_back(AttributeSet::get(NF->getContext(), RAttrs));
 873
 874     // Declare these outside of the loops, so we can reuse them for the second
 875     // loop, which loops the varargs.
 876     CallSite::arg_iterator I = CS.arg_begin();
 877     unsigned i = 0;
 878     // Loop over those operands, corresponding to the normal arguments to the
 879     // original function, and add those that are still alive.
 880     for (unsigned e = FTy->getNumParams(); i != e; ++I, ++i)
 881       if (ArgAlive[i]) {
 882         Args.push_back(*I);
 883         // Get original parameter attributes, but skip return attributes.
 884         if (CallPAL.hasAttributes(i + 1)) {
 885           AttrBuilder B(CallPAL, i + 1);
 886           AttributesVec.
 887             push_back(AttributeSet::get(F->getContext(), Args.size(), B));
 888         }
 889       }
 890
 891     // Push any varargs arguments on the list. Don't forget their attributes.
 892     for (CallSite::arg_iterator E = CS.arg_end(); I != E; ++I, ++i) {
 893       Args.push_back(*I);
 894       if (CallPAL.hasAttributes(i + 1)) {
 895         AttrBuilder B(CallPAL, i + 1);
 896         AttributesVec.
 897           push_back(AttributeSet::get(F->getContext(), Args.size(), B));
 898       }
 899     }
 900
 901     if (CallPAL.hasAttributes(AttributeSet::FunctionIndex))
 902       AttributesVec.push_back(AttributeSet::get(Call->getContext(),
 903                                                 CallPAL.getFnAttributes()));
 904
 905     // Reconstruct the AttributesList based on the vector we constructed.
 906     AttributeSet NewCallPAL = AttributeSet::get(F->getContext(), AttributesVec);
 907
 908     Instruction *New;
 909     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 910       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
 911                                Args, "", Call);
 912       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
 913       cast<InvokeInst>(New)->setAttributes(NewCallPAL);
 914     } else {
 915       New = CallInst::Create(NF, Args, "", Call);
 916       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
 917       cast<CallInst>(New)->setAttributes(NewCallPAL);
 918       if (cast<CallInst>(Call)->isTailCall())
 919         cast<CallInst>(New)->setTailCall();
 920     }
 921     New->setDebugLoc(Call->getDebugLoc());
 922
 923     Args.clear();
 924
 925     if (!Call->use_empty()) {
 926       if (New->getType() == Call->getType()) {
 927         // Return type not changed? Just replace users then.
 928         Call->replaceAllUsesWith(New);
 929         New->takeName(Call);
 930       } else if (New->getType()->isVoidTy()) {
 931         // Our return value has uses, but they will get removed later on.
 932         // Replace by null for now.
 933         if (!Call->getType()->isX86_MMXTy())
 934           Call->replaceAllUsesWith(Constant::getNullValue(Call->getType()));
 935       } else {
 936         assert(RetTy->isStructTy() &&
 937                "Return type changed, but not into a void. The old return type"
 938                " must have been a struct!");
 939         Instruction *InsertPt = Call;
 940         if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 941           BasicBlock::iterator IP = II->getNormalDest()->begin();
 942           while (isa<PHINode>(IP)) ++IP;
 943           InsertPt = IP;
 944         }
 945
 946         // We used to return a struct. Instead of doing smart stuff with all the
 947         // uses of this struct, we will just rebuild it using
 948         // extract/insertvalue chaining and let instcombine clean that up.
 949         //
 950         // Start out building up our return value from undef
 951         Value *RetVal = UndefValue::get(RetTy);
 952         for (unsigned i = 0; i != RetCount; ++i)
 953           if (NewRetIdxs[i] != -1) {
 954             Value *V;
 955             if (RetTypes.size() > 1)
 956               // We are still returning a struct, so extract the value from our
 957               // return value
 958               V = ExtractValueInst::Create(New, NewRetIdxs[i], "newret",
 959                                            InsertPt);
 960             else
 961               // We are now returning a single element, so just insert that
 962               V = New;
 963             // Insert the value at the old position
 964             RetVal = InsertValueInst::Create(RetVal, V, i, "oldret", InsertPt);
 965           }
 966         // Now, replace all uses of the old call instruction with the return
 967         // struct we built
 968         Call->replaceAllUsesWith(RetVal);
 969         New->takeName(Call);
 970       }
 971     }
 972
 973     // Finally, remove the old call from the program, reducing the use-count of
 974     // F.
 975     Call->eraseFromParent();
 976   }
 977
 978   // Since we have now created the new function, splice the body of the old
 979   // function right into the new function, leaving the old rotting hulk of the
 980   // function empty.
 981   NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
 982
 983   // Loop over the argument list, transferring uses of the old arguments over to
 984   // the new arguments, also transferring over the names as well.
 985   i = 0;
 986   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(),
 987        I2 = NF->arg_begin(); I != E; ++I, ++i)
 988     if (ArgAlive[i]) {
 989       // If this is a live argument, move the name and users over to the new
 990       // version.
 991       I->replaceAllUsesWith(I2);
 992       I2->takeName(I);
 993       ++I2;
 994     } else {
 995       // If this argument is dead, replace any uses of it with null constants
 996       // (these are guaranteed to become unused later on).
 997       if (!I->getType()->isX86_MMXTy())
 998         I->replaceAllUsesWith(Constant::getNullValue(I->getType()));
 999     }
1000
1001   // If we change the return value of the function we must rewrite any return
1002   // instructions.  Check this now.
1003   if (F->getReturnType() != NF->getReturnType())
1004     for (Function::iterator BB = NF->begin(), E = NF->end(); BB != E; ++BB)
1005       if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1006         Value *RetVal;
1007
1008         if (NFTy->getReturnType()->isVoidTy()) {
1009           RetVal = 0;
1010         } else {
1011           assert (RetTy->isStructTy());
1012           // The original return value was a struct, insert
1013           // extractvalue/insertvalue chains to extract only the values we need
1014           // to return and insert them into our new result.
1015           // This does generate messy code, but we'll let it to instcombine to
1016           // clean that up.
1017           Value *OldRet = RI->getOperand(0);
1018           // Start out building up our return value from undef
1019           RetVal = UndefValue::get(NRetTy);
1020           for (unsigned i = 0; i != RetCount; ++i)
1021             if (NewRetIdxs[i] != -1) {
1022               ExtractValueInst *EV = ExtractValueInst::Create(OldRet, i,
1023                                                               "oldret", RI);
1024               if (RetTypes.size() > 1) {
1025                 // We're still returning a struct, so reinsert the value into
1026                 // our new return value at the new index
1027
1028                 RetVal = InsertValueInst::Create(RetVal, EV, NewRetIdxs[i],
1029                                                  "newret", RI);
1030               } else {
1031                 // We are now only returning a simple value, so just return the
1032                 // extracted value.
1033                 RetVal = EV;
1034               }
1035             }
1036         }
1037         // Replace the return instruction with one returning the new return
1038         // value (possibly 0 if we became void).
1039         ReturnInst::Create(F->getContext(), RetVal, RI);
1040         BB->getInstList().erase(RI);
1041       }
1042
1043   // Patch the pointer to LLVM function in debug info descriptor.
1044   FunctionDIMap::iterator DI = FunctionDIs.find(F);
1045   if (DI != FunctionDIs.end())
1046     DI->second.replaceFunction(NF);
1047
1048   // Now that the old function is dead, delete it.
1049   F->eraseFromParent();
1050
1051   return true;
1052 }
1053
1054 bool DAE::runOnModule(Module &M) {
1055   bool Changed = false;
1056
1057   // Collect debug info descriptors for functions.
1058   CollectFunctionDIs(M);
1059
1060   // First pass: Do a simple check to see if any functions can have their "..."
1061   // removed.  We can do this if they never call va_start.  This loop cannot be
1062   // fused with the next loop, because deleting a function invalidates
1063   // information computed while surveying other functions.
1064   DEBUG(dbgs() << "DAE - Deleting dead varargs\n");
1065   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1066     Function &F = *I++;
1067     if (F.getFunctionType()->isVarArg())
1068       Changed |= DeleteDeadVarargs(F);
1069   }
1070
1071   // Second phase:loop through the module, determining which arguments are live.
1072   // We assume all arguments are dead unless proven otherwise (allowing us to
1073   // determine that dead arguments passed into recursive functions are dead).
1074   //
1075   DEBUG(dbgs() << "DAE - Determining liveness\n");
1076   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
1077     SurveyFunction(*I);
1078
1079   // Now, remove all dead arguments and return values from each function in
1080   // turn.
1081   for (Module::iterator I = M.begin(), E = M.end(); I != E; ) {
1082     // Increment now, because the function will probably get removed (ie.
1083     // replaced by a new one).
1084     Function *F = I++;
1085     Changed |= RemoveDeadStuffFromFunction(F);
1086   }
1087
1088   // Finally, look for any unused parameters in functions with non-local
1089   // linkage and replace the passed in parameters with undef.
1090   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
1091     Function& F = *I;
1092
1093     Changed |= RemoveDeadArgumentsFromCallers(F);
1094   }
1095
1096   return Changed;
1097 }