lib/Transforms/Scalar/GlobalMerge.cpp

   1 //===-- GlobalMerge.cpp - Internal globals merging  -----------------------===//
   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 // This pass merges globals with internal linkage into one. This way all the
  10 // globals which were merged into a biggest one can be addressed using offsets
  11 // from the same base pointer (no need for separate base pointer for each of the
  12 // global). Such a transformation can significantly reduce the register pressure
  13 // when many globals are involved.
  14 //
  15 // For example, consider the code which touches several global variables at
  16 // once:
  17 //
  18 // static int foo[N], bar[N], baz[N];
  19 //
  20 // for (i = 0; i < N; ++i) {
  21 //    foo[i] = bar[i] * baz[i];
  22 // }
  23 //
  24 //  On ARM the addresses of 3 arrays should be kept in the registers, thus
  25 //  this code has quite large register pressure (loop body):
  26 //
  27 //  ldr     r1, [r5], #4
  28 //  ldr     r2, [r6], #4
  29 //  mul     r1, r2, r1
  30 //  str     r1, [r0], #4
  31 //
  32 //  Pass converts the code to something like:
  33 //
  34 //  static struct {
  35 //    int foo[N];
  36 //    int bar[N];
  37 //    int baz[N];
  38 //  } merged;
  39 //
  40 //  for (i = 0; i < N; ++i) {
  41 //    merged.foo[i] = merged.bar[i] * merged.baz[i];
  42 //  }
  43 //
  44 //  and in ARM code this becomes:
  45 //
  46 //  ldr     r0, [r5, #40]
  47 //  ldr     r1, [r5, #80]
  48 //  mul     r0, r1, r0
  49 //  str     r0, [r5], #4
  50 //
  51 //  note that we saved 2 registers here almostly "for free".
  52 // ===---------------------------------------------------------------------===//
  53
  54 #define DEBUG_TYPE "global-merge"
  55 #include "llvm/Transforms/Scalar.h"
  56 #include "llvm/ADT/SmallPtrSet.h"
  57 #include "llvm/ADT/Statistic.h"
  58 #include "llvm/IR/Attributes.h"
  59 #include "llvm/IR/Constants.h"
  60 #include "llvm/IR/DataLayout.h"
  61 #include "llvm/IR/DerivedTypes.h"
  62 #include "llvm/IR/Function.h"
  63 #include "llvm/IR/GlobalVariable.h"
  64 #include "llvm/IR/Instructions.h"
  65 #include "llvm/IR/Intrinsics.h"
  66 #include "llvm/IR/Module.h"
  67 #include "llvm/Pass.h"
  68 #include "llvm/Support/CommandLine.h"
  69 #include "llvm/Target/TargetLowering.h"
  70 #include "llvm/Target/TargetLoweringObjectFile.h"
  71 using namespace llvm;
  72
  73 static cl::opt<bool>
  74 EnableGlobalMerge("global-merge", cl::Hidden,
  75                   cl::desc("Enable global merge pass"),
  76                   cl::init(true));
  77
  78 static cl::opt<bool>
  79 EnableGlobalMergeOnConst("global-merge-on-const", cl::Hidden,
  80                          cl::desc("Enable global merge pass on constants"),
  81                          cl::init(false));
  82
  83 STATISTIC(NumMerged      , "Number of globals merged");
  84 namespace {
  85   class GlobalMerge : public FunctionPass {
  86     const TargetMachine *TM;
  87
  88     bool doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
  89                  Module &M, bool isConst, unsigned AddrSpace) const;
  90
  91     /// \brief Check if the given variable has been identified as must keep
  92     /// \pre setMustKeepGlobalVariables must have been called on the Module that
  93     ///      contains GV
  94     bool isMustKeepGlobalVariable(const GlobalVariable *GV) const {
  95       return MustKeepGlobalVariables.count(GV);
  96     }
  97
  98     /// Collect every variables marked as "used" or used in a landing pad
  99     /// instruction for this Module.
 100     void setMustKeepGlobalVariables(Module &M);
 101
 102     /// Collect every variables marked as "used"
 103     void collectUsedGlobalVariables(Module &M);
 104
 105     /// Keep track of the GlobalVariable that must not be merged away
 106     SmallPtrSet<const GlobalVariable *, 16> MustKeepGlobalVariables;
 107
 108   public:
 109     static char ID;             // Pass identification, replacement for typeid.
 110     explicit GlobalMerge(const TargetMachine *TM = 0)
 111       : FunctionPass(ID), TM(TM) {
 112       initializeGlobalMergePass(*PassRegistry::getPassRegistry());
 113     }
 114
 115     virtual bool doInitialization(Module &M);
 116     virtual bool runOnFunction(Function &F);
 117     virtual bool doFinalization(Module &M);
 118
 119     const char *getPassName() const {
 120       return "Merge internal globals";
 121     }
 122
 123     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 124       AU.setPreservesCFG();
 125       FunctionPass::getAnalysisUsage(AU);
 126     }
 127
 128     struct GlobalCmp {
 129       const DataLayout *DL;
 130
 131       GlobalCmp(const DataLayout *DL) : DL(DL) { }
 132
 133       bool operator()(const GlobalVariable *GV1, const GlobalVariable *GV2) {
 134         Type *Ty1 = cast<PointerType>(GV1->getType())->getElementType();
 135         Type *Ty2 = cast<PointerType>(GV2->getType())->getElementType();
 136
 137         return (DL->getTypeAllocSize(Ty1) < DL->getTypeAllocSize(Ty2));
 138       }
 139     };
 140   };
 141 } // end anonymous namespace
 142
 143 char GlobalMerge::ID = 0;
 144 INITIALIZE_PASS(GlobalMerge, "global-merge",
 145                 "Global Merge", false, false)
 146
 147
 148 bool GlobalMerge::doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
 149                           Module &M, bool isConst, unsigned AddrSpace) const {
 150   const TargetLowering *TLI = TM->getTargetLowering();
 151   const DataLayout *DL = TLI->getDataLayout();
 152
 153   // FIXME: Infer the maximum possible offset depending on the actual users
 154   // (these max offsets are different for the users inside Thumb or ARM
 155   // functions)
 156   unsigned MaxOffset = TLI->getMaximalGlobalOffset();
 157
 158   // FIXME: Find better heuristics
 159   std::stable_sort(Globals.begin(), Globals.end(), GlobalCmp(DL));
 160
 161   Type *Int32Ty = Type::getInt32Ty(M.getContext());
 162
 163   for (size_t i = 0, e = Globals.size(); i != e; ) {
 164     size_t j = 0;
 165     uint64_t MergedSize = 0;
 166     std::vector<Type*> Tys;
 167     std::vector<Constant*> Inits;
 168     for (j = i; j != e; ++j) {
 169       Type *Ty = Globals[j]->getType()->getElementType();
 170       MergedSize += DL->getTypeAllocSize(Ty);
 171       if (MergedSize > MaxOffset) {
 172         break;
 173       }
 174       Tys.push_back(Ty);
 175       Inits.push_back(Globals[j]->getInitializer());
 176     }
 177
 178     StructType *MergedTy = StructType::get(M.getContext(), Tys);
 179     Constant *MergedInit = ConstantStruct::get(MergedTy, Inits);
 180     GlobalVariable *MergedGV = new GlobalVariable(M, MergedTy, isConst,
 181                                                   GlobalValue::InternalLinkage,
 182                                                   MergedInit, "_MergedGlobals",
 183                                                   0, GlobalVariable::NotThreadLocal,
 184                                                   AddrSpace);
 185     for (size_t k = i; k < j; ++k) {
 186       Constant *Idx[2] = {
 187         ConstantInt::get(Int32Ty, 0),
 188         ConstantInt::get(Int32Ty, k-i)
 189       };
 190       Constant *GEP = ConstantExpr::getInBoundsGetElementPtr(MergedGV, Idx);
 191       Globals[k]->replaceAllUsesWith(GEP);
 192       Globals[k]->eraseFromParent();
 193       NumMerged++;
 194     }
 195     i = j;
 196   }
 197
 198   return true;
 199 }
 200
 201 void GlobalMerge::collectUsedGlobalVariables(Module &M) {
 202   // Extract global variables from llvm.used array
 203   const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
 204   if (!GV || !GV->hasInitializer()) return;
 205
 206   // Should be an array of 'i8*'.
 207   const ConstantArray *InitList = cast<ConstantArray>(GV->getInitializer());
 208
 209   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 210     if (const GlobalVariable *G =
 211         dyn_cast<GlobalVariable>(InitList->getOperand(i)->stripPointerCasts()))
 212       MustKeepGlobalVariables.insert(G);
 213 }
 214
 215 void GlobalMerge::setMustKeepGlobalVariables(Module &M) {
 216   collectUsedGlobalVariables(M);
 217
 218   for (Module::iterator IFn = M.begin(), IEndFn = M.end(); IFn != IEndFn;
 219        ++IFn) {
 220     for (Function::iterator IBB = IFn->begin(), IEndBB = IFn->end();
 221          IBB != IEndBB; ++IBB) {
 222       // Follow the inwoke link to find the landing pad instruction
 223       const InvokeInst *II = dyn_cast<InvokeInst>(IBB->getTerminator());
 224       if (!II) continue;
 225
 226       const LandingPadInst *LPInst = II->getUnwindDest()->getLandingPadInst();
 227       // Look for globals in the clauses of the landing pad instruction
 228       for (unsigned Idx = 0, NumClauses = LPInst->getNumClauses();
 229            Idx != NumClauses; ++Idx)
 230         if (const GlobalVariable *GV =
 231             dyn_cast<GlobalVariable>(LPInst->getClause(Idx)
 232                                      ->stripPointerCasts()))
 233           MustKeepGlobalVariables.insert(GV);
 234     }
 235   }
 236 }
 237
 238 bool GlobalMerge::doInitialization(Module &M) {
 239   if (!EnableGlobalMerge)
 240     return false;
 241
 242   DenseMap<unsigned, SmallVector<GlobalVariable*, 16> > Globals, ConstGlobals,
 243                                                         BSSGlobals;
 244   const TargetLowering *TLI = TM->getTargetLowering();
 245   const DataLayout *DL = TLI->getDataLayout();
 246   unsigned MaxOffset = TLI->getMaximalGlobalOffset();
 247   bool Changed = false;
 248   setMustKeepGlobalVariables(M);
 249
 250   // Grab all non-const globals.
 251   for (Module::global_iterator I = M.global_begin(),
 252          E = M.global_end(); I != E; ++I) {
 253     // Merge is safe for "normal" internal globals only
 254     if (!I->hasLocalLinkage() || I->isThreadLocal() || I->hasSection())
 255       continue;
 256
 257     PointerType *PT = dyn_cast<PointerType>(I->getType());
 258     assert(PT && "Global variable is not a pointer!");
 259
 260     unsigned AddressSpace = PT->getAddressSpace();
 261
 262     // Ignore fancy-aligned globals for now.
 263     unsigned Alignment = DL->getPreferredAlignment(I);
 264     Type *Ty = I->getType()->getElementType();
 265     if (Alignment > DL->getABITypeAlignment(Ty))
 266       continue;
 267
 268     // Ignore all 'special' globals.
 269     if (I->getName().startswith("llvm.") ||
 270         I->getName().startswith(".llvm."))
 271       continue;
 272
 273     // Ignore all "required" globals:
 274     if (isMustKeepGlobalVariable(I))
 275       continue;
 276
 277     if (DL->getTypeAllocSize(Ty) < MaxOffset) {
 278       if (TargetLoweringObjectFile::getKindForGlobal(I, TLI->getTargetMachine())
 279           .isBSSLocal())
 280         BSSGlobals[AddressSpace].push_back(I);
 281       else if (I->isConstant())
 282         ConstGlobals[AddressSpace].push_back(I);
 283       else
 284         Globals[AddressSpace].push_back(I);
 285     }
 286   }
 287
 288   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 289        I = Globals.begin(), E = Globals.end(); I != E; ++I)
 290     if (I->second.size() > 1)
 291       Changed |= doMerge(I->second, M, false, I->first);
 292
 293   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 294        I = BSSGlobals.begin(), E = BSSGlobals.end(); I != E; ++I)
 295     if (I->second.size() > 1)
 296       Changed |= doMerge(I->second, M, false, I->first);
 297
 298   if (EnableGlobalMergeOnConst)
 299     for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 300          I = ConstGlobals.begin(), E = ConstGlobals.end(); I != E; ++I)
 301       if (I->second.size() > 1)
 302         Changed |= doMerge(I->second, M, true, I->first);
 303
 304   return Changed;
 305 }
 306
 307 bool GlobalMerge::runOnFunction(Function &F) {
 308   return false;
 309 }
 310
 311 bool GlobalMerge::doFinalization(Module &M) {
 312   MustKeepGlobalVariables.clear();
 313   return false;
 314 }
 315
 316 Pass *llvm::createGlobalMergePass(const TargetMachine *TM) {
 317   return new GlobalMerge(TM);
 318 }