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