lib/Transforms/IPO/PartialSpecialization.cpp

   1 //===-- PartialSpecialization.cpp - Specialize for common constants--------===//
   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 finds function arguments that are often a common constant and
  11 // specializes a version of the called function for that constant.
  12 //
  13 // This pass simply does the cloning for functions it specializes.  It depends
  14 // on IPSCCP and DAE to clean up the results.
  15 //
  16 // The initial heuristic favors constant arguments that are used in control
  17 // flow.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #define DEBUG_TYPE "partialspecialization"
  22 #include "llvm/Transforms/IPO.h"
  23 #include "llvm/Constant.h"
  24 #include "llvm/Instructions.h"
  25 #include "llvm/Module.h"
  26 #include "llvm/Pass.h"
  27 #include "llvm/ADT/Statistic.h"
  28 #include "llvm/Transforms/Utils/Cloning.h"
  29 #include "llvm/Support/CallSite.h"
  30 #include "llvm/Support/Compiler.h"
  31 #include "llvm/ADT/DenseSet.h"
  32 #include <map>
  33 using namespace llvm;
  34
  35 STATISTIC(numSpecialized, "Number of specialized functions created");
  36
  37 // Call must be used at least occasionally
  38 static const int CallsMin = 5;
  39
  40 // Must have 10% of calls having the same constant to specialize on
  41 static const double ConstValPercent = .1;
  42
  43 namespace {
  44   class VISIBILITY_HIDDEN PartSpec : public ModulePass {
  45     void scanForInterest(Function&, SmallVector<int, 6>&);
  46     int scanDistribution(Function&, int, std::map<Constant*, int>&);
  47   public :
  48     static char ID; // Pass identification, replacement for typeid
  49     PartSpec() : ModulePass(&ID) {}
  50     bool runOnModule(Module &M);
  51   };
  52 }
  53
  54 char PartSpec::ID = 0;
  55 static RegisterPass<PartSpec>
  56 X("partialspecialization", "Partial Specialization");
  57
  58 // Specialize F by replacing the arguments (keys) in replacements with the
  59 // constants (values).  Replace all calls to F with those constants with
  60 // a call to the specialized function.  Returns the specialized function
  61 static Function*
  62 SpecializeFunction(Function* F,
  63                    DenseMap<const Value*, Value*>& replacements) {
  64   // arg numbers of deleted arguments
  65   DenseSet<unsigned> deleted;
  66   for (DenseMap<const Value*, Value*>::iterator
  67          repb = replacements.begin(), repe = replacements.end();
  68        repb != repe; ++ repb)
  69     deleted.insert(cast<Argument>(repb->first)->getArgNo());
  70
  71   Function* NF = CloneFunction(F, replacements);
  72   NF->setLinkage(GlobalValue::InternalLinkage);
  73   F->getParent()->getFunctionList().push_back(NF);
  74
  75   for (Value::use_iterator ii = F->use_begin(), ee = F->use_end();
  76        ii != ee; ) {
  77     Value::use_iterator i = ii;;
  78     ++ii;
  79     if (isa<CallInst>(i) || isa<InvokeInst>(i)) {
  80       CallSite CS(cast<Instruction>(i));
  81       if (CS.getCalledFunction() == F) {
  82
  83         SmallVector<Value*, 6> args;
  84         for (unsigned x = 0; x < CS.arg_size(); ++x)
  85           if (!deleted.count(x))
  86             args.push_back(CS.getArgument(x));
  87         Value* NCall;
  88         if (isa<CallInst>(i))
  89           NCall = CallInst::Create(NF, args.begin(), args.end(),
  90                                    CS.getInstruction()->getName(),
  91                                    CS.getInstruction());
  92         else
  93           NCall = InvokeInst::Create(NF, cast<InvokeInst>(i)->getNormalDest(),
  94                                      cast<InvokeInst>(i)->getUnwindDest(),
  95                                      args.begin(), args.end(),
  96                                      CS.getInstruction()->getName(),
  97                                      CS.getInstruction());
  98         CS.getInstruction()->replaceAllUsesWith(NCall);
  99         CS.getInstruction()->eraseFromParent();
 100       }
 101     }
 102   }
 103   return NF;
 104 }
 105
 106
 107 bool PartSpec::runOnModule(Module &M) {
 108   bool Changed = false;
 109   for (Module::iterator I = M.begin(); I != M.end(); ++I) {
 110     Function &F = *I;
 111     if (F.isDeclaration()) continue;
 112     SmallVector<int, 6> interestingArgs;
 113     scanForInterest(F, interestingArgs);
 114
 115     // Find the first interesting Argument that we can specialize on
 116     // If there are multiple interesting Arguments, then those will be found
 117     // when processing the cloned function.
 118     bool breakOuter = false;
 119     for (unsigned int x = 0; !breakOuter && x < interestingArgs.size(); ++x) {
 120       std::map<Constant*, int> distribution;
 121       int total = scanDistribution(F, interestingArgs[x], distribution);
 122       if (total > CallsMin)
 123         for (std::map<Constant*, int>::iterator ii = distribution.begin(),
 124                ee = distribution.end(); ii != ee; ++ii)
 125           if (total > ii->second && ii->first &&
 126                ii->second > total * ConstValPercent) {
 127             DenseMap<const Value*, Value*> m;
 128             Function::arg_iterator arg = F.arg_begin();
 129             for (int y = 0; y < interestingArgs[x]; ++y)
 130               ++arg;
 131             m[&*arg] = ii->first;
 132             SpecializeFunction(&F, m);
 133             ++numSpecialized;
 134             breakOuter = true;
 135             Changed = true;
 136           }
 137     }
 138   }
 139   return Changed;
 140 }
 141
 142 /// scanForInterest - This function decides which arguments would be worth
 143 /// specializing on.
 144 void PartSpec::scanForInterest(Function& F, SmallVector<int, 6>& args) {
 145   for(Function::arg_iterator ii = F.arg_begin(), ee = F.arg_end();
 146       ii != ee; ++ii) {
 147     for(Value::use_iterator ui = ii->use_begin(), ue = ii->use_end();
 148         ui != ue; ++ui) {
 149
 150       bool interesting = false;
 151
 152       if (isa<CmpInst>(ui)) interesting = true;
 153       else if (isa<CallInst>(ui))
 154         interesting = ui->getOperand(0) == ii;
 155       else if (isa<InvokeInst>(ui))
 156         interesting = ui->getOperand(0) == ii;
 157       else if (isa<SwitchInst>(ui)) interesting = true;
 158       else if (isa<BranchInst>(ui)) interesting = true;
 159
 160       if (interesting) {
 161         args.push_back(std::distance(F.arg_begin(), ii));
 162         break;
 163       }
 164     }
 165   }
 166 }
 167
 168 int PartSpec::scanDistribution(Function& F, int arg,
 169                                std::map<Constant*, int>& dist) {
 170   bool hasIndirect = false;
 171   int total = 0;
 172   for(Value::use_iterator ii = F.use_begin(), ee = F.use_end();
 173       ii != ee; ++ii)
 174     if (CallInst* CI = dyn_cast<CallInst>(ii)) {
 175       ++dist[dyn_cast<Constant>(CI->getOperand(arg + 1))];
 176       ++total;
 177     } else
 178       hasIndirect = true;
 179
 180   // Preserve the original address taken function even if all other uses
 181   // will be specialized.
 182   if (hasIndirect) ++total;
 183   return total;
 184 }
 185
 186 ModulePass* llvm::createPartialSpecializationPass() { return new PartSpec(); }