lib/Transforms/IPO/ConstantMerge.cpp

   1 //===- ConstantMerge.cpp - Merge duplicate global constants -----------------=//
   2 //
   3 // This file defines the interface to a pass that merges duplicate global
   4 // constants together into a single constant that is shared.  This is useful
   5 // because some passes (ie TraceValues) insert a lot of string constants into
   6 // the program, regardless of whether or not they duplicate an existing string.
   7 //
   8 // Algorithm: ConstantMerge is designed to build up a map of available constants
   9 // and elminate duplicates when it is initialized.
  10 //
  11 // The DynamicConstantMerge method is a superset of the ConstantMerge algorithm
  12 // that checks for each function to see if constants have been added to the
  13 // constant pool since it was last run... if so, it processes them.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Transforms/ConstantMerge.h"
  18 #include "llvm/GlobalVariable.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/Pass.h"
  22
  23 // mergeDuplicateConstants - Workhorse for the pass.  This eliminates duplicate
  24 // constants, starting at global ConstantNo, and adds vars to the map if they
  25 // are new and unique.
  26 //
  27 static inline
  28 bool mergeDuplicateConstants(Module *M, unsigned &ConstantNo,
  29                              std::map<Constant*, GlobalVariable*> &CMap) {
  30   Module::GlobalListType &GList = M->getGlobalList();
  31   if (GList.size() <= ConstantNo) return false;   // No new constants
  32   bool MadeChanges = false;
  33
  34   for (; ConstantNo < GList.size(); ++ConstantNo) {
  35     GlobalVariable *GV = GList[ConstantNo];
  36     if (GV->isConstant()) {  // Only process constants
  37       assert(GV->hasInitializer() && "Globals constants must have inits!");
  38       Constant *Init = GV->getInitializer();
  39
  40       // Check to see if the initializer is already known...
  41       std::map<Constant*, GlobalVariable*>::iterator I = CMap.find(Init);
  42
  43       if (I == CMap.end()) {    // Nope, add it to the map
  44         CMap.insert(std::make_pair(Init, GV));
  45       } else {                  // Yup, this is a duplicate!
  46         // Make all uses of the duplicate constant use the cannonical version...
  47         GV->replaceAllUsesWith(I->second);
  48
  49         // Remove and delete the global value from the module...
  50         delete GList.remove(GList.begin()+ConstantNo);
  51
  52         --ConstantNo;  // Don't skip the next constant.
  53         MadeChanges = true;
  54       }
  55     }
  56   }
  57   return MadeChanges;
  58 }
  59
  60 namespace {
  61   // FIXME: ConstantMerge should not be a FunctionPass!!!
  62   class ConstantMerge : public FunctionPass {
  63   protected:
  64     std::map<Constant*, GlobalVariable*> Constants;
  65     unsigned LastConstantSeen;
  66   public:
  67     inline ConstantMerge() : LastConstantSeen(0) {}
  68
  69     const char *getPassName() const {return "Merge Duplicate Global Constants";}
  70
  71     // doInitialization - For this pass, process all of the globals in the
  72     // module, eliminating duplicate constants.
  73     //
  74     bool doInitialization(Module *M) {
  75       return ::mergeDuplicateConstants(M, LastConstantSeen, Constants);
  76     }
  77
  78     bool runOnFunction(Function *) { return false; }
  79
  80     // doFinalization - Clean up internal state for this module
  81     //
  82     bool doFinalization(Module *M) {
  83       LastConstantSeen = 0;
  84       Constants.clear();
  85       return false;
  86     }
  87
  88     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  89       AU.setPreservesAll();
  90     }
  91   };
  92
  93   struct DynamicConstantMerge : public ConstantMerge {
  94     const char *getPassName() const { return "Dynamic Constant Merge"; }
  95
  96     // runOnFunction - Check to see if any globals have been added to the
  97     // global list for the module.  If so, eliminate them.
  98     //
  99     bool runOnFunction(Function *F) {
 100       return ::mergeDuplicateConstants(F->getParent(), LastConstantSeen,
 101                                        Constants);
 102     }
 103   };
 104 }
 105
 106 Pass *createConstantMergePass() { return new ConstantMerge(); }
 107 Pass *createDynamicConstantMergePass() { return new DynamicConstantMerge(); }