lib/CodeGen/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/CodeGen/Passes.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 #include "llvm/Target/TargetSubtargetInfo.h"
  72 using namespace llvm;
  73
  74 #define DEBUG_TYPE "global-merge"
  75
  76 static cl::opt<bool>
  77 EnableGlobalMerge("enable-global-merge", cl::Hidden,
  78                   cl::desc("Enable global merge pass"),
  79                   cl::init(true));
  80
  81 static cl::opt<bool>
  82 EnableGlobalMergeOnConst("global-merge-on-const", cl::Hidden,
  83                          cl::desc("Enable global merge pass on constants"),
  84                          cl::init(false));
  85
  86 // FIXME: this could be a transitional option, and we probably need to remove
  87 // it if only we are sure this optimization could always benefit all targets.
  88 static cl::opt<bool>
  89 EnableGlobalMergeOnExternal("global-merge-on-external", cl::Hidden,
  90      cl::desc("Enable global merge pass on external linkage"),
  91      cl::init(false));
  92
  93 STATISTIC(NumMerged, "Number of globals merged");
  94 namespace {
  95   class GlobalMerge : public FunctionPass {
  96     const TargetMachine *TM;
  97     const DataLayout *DL;
  98     // FIXME: Infer the maximum possible offset depending on the actual users
  99     // (these max offsets are different for the users inside Thumb or ARM
 100     // functions), see the code that passes in the offset in the ARM backend
 101     // for more information.
 102     unsigned MaxOffset;
 103
 104     bool doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
 105                  Module &M, bool isConst, unsigned AddrSpace) const;
 106
 107     /// \brief Check if the given variable has been identified as must keep
 108     /// \pre setMustKeepGlobalVariables must have been called on the Module that
 109     ///      contains GV
 110     bool isMustKeepGlobalVariable(const GlobalVariable *GV) const {
 111       return MustKeepGlobalVariables.count(GV);
 112     }
 113
 114     /// Collect every variables marked as "used" or used in a landing pad
 115     /// instruction for this Module.
 116     void setMustKeepGlobalVariables(Module &M);
 117
 118     /// Collect every variables marked as "used"
 119     void collectUsedGlobalVariables(Module &M);
 120
 121     /// Keep track of the GlobalVariable that must not be merged away
 122     SmallPtrSet<const GlobalVariable *, 16> MustKeepGlobalVariables;
 123
 124   public:
 125     static char ID;             // Pass identification, replacement for typeid.
 126     explicit GlobalMerge(const TargetMachine *TM = nullptr,
 127                          unsigned MaximalOffset = 0)
 128         : FunctionPass(ID), TM(TM), DL(TM->getDataLayout()),
 129           MaxOffset(MaximalOffset) {
 130       initializeGlobalMergePass(*PassRegistry::getPassRegistry());
 131     }
 132
 133     bool doInitialization(Module &M) override;
 134     bool runOnFunction(Function &F) override;
 135     bool doFinalization(Module &M) override;
 136
 137     const char *getPassName() const override {
 138       return "Merge internal globals";
 139     }
 140
 141     void getAnalysisUsage(AnalysisUsage &AU) const override {
 142       AU.setPreservesCFG();
 143       FunctionPass::getAnalysisUsage(AU);
 144     }
 145   };
 146 } // end anonymous namespace
 147
 148 char GlobalMerge::ID = 0;
 149 INITIALIZE_PASS_BEGIN(GlobalMerge, "global-merge", "Merge global variables",
 150                       false, false)
 151 INITIALIZE_PASS_END(GlobalMerge, "global-merge", "Merge global variables",
 152                     false, false)
 153
 154 bool GlobalMerge::doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
 155                           Module &M, bool isConst, unsigned AddrSpace) const {
 156   // FIXME: Find better heuristics
 157   std::stable_sort(Globals.begin(), Globals.end(),
 158                    [this](const GlobalVariable *GV1, const GlobalVariable *GV2) {
 159     Type *Ty1 = cast<PointerType>(GV1->getType())->getElementType();
 160     Type *Ty2 = cast<PointerType>(GV2->getType())->getElementType();
 161
 162     return (DL->getTypeAllocSize(Ty1) < DL->getTypeAllocSize(Ty2));
 163   });
 164
 165   Type *Int32Ty = Type::getInt32Ty(M.getContext());
 166
 167   assert(Globals.size() > 1);
 168
 169   // FIXME: This simple solution merges globals all together as maximum as
 170   // possible. However, with this solution it would be hard to remove dead
 171   // global symbols at link-time. An alternative solution could be checking
 172   // global symbols references function by function, and make the symbols
 173   // being referred in the same function merged and we would probably need
 174   // to introduce heuristic algorithm to solve the merge conflict from
 175   // different functions.
 176   for (size_t i = 0, e = Globals.size(); i != e; ) {
 177     size_t j = 0;
 178     uint64_t MergedSize = 0;
 179     std::vector<Type*> Tys;
 180     std::vector<Constant*> Inits;
 181
 182     bool HasExternal = false;
 183     GlobalVariable *TheFirstExternal = 0;
 184     for (j = i; j != e; ++j) {
 185       Type *Ty = Globals[j]->getType()->getElementType();
 186       MergedSize += DL->getTypeAllocSize(Ty);
 187       if (MergedSize > MaxOffset) {
 188         break;
 189       }
 190       Tys.push_back(Ty);
 191       Inits.push_back(Globals[j]->getInitializer());
 192
 193       if (Globals[j]->hasExternalLinkage() && !HasExternal) {
 194         HasExternal = true;
 195         TheFirstExternal = Globals[j];
 196       }
 197     }
 198
 199     // If merged variables doesn't have external linkage, we needn't to expose
 200     // the symbol after merging.
 201     GlobalValue::LinkageTypes Linkage = HasExternal
 202                                             ? GlobalValue::ExternalLinkage
 203                                             : GlobalValue::InternalLinkage;
 204
 205     StructType *MergedTy = StructType::get(M.getContext(), Tys);
 206     Constant *MergedInit = ConstantStruct::get(MergedTy, Inits);
 207
 208     // If merged variables have external linkage, we use symbol name of the
 209     // first variable merged as the suffix of global symbol name. This would
 210     // be able to avoid the link-time naming conflict for globalm symbols.
 211     GlobalVariable *MergedGV = new GlobalVariable(
 212         M, MergedTy, isConst, Linkage, MergedInit,
 213         HasExternal ? "_MergedGlobals_" + TheFirstExternal->getName()
 214                     : "_MergedGlobals",
 215         nullptr, GlobalVariable::NotThreadLocal, AddrSpace);
 216
 217     for (size_t k = i; k < j; ++k) {
 218       GlobalValue::LinkageTypes Linkage = Globals[k]->getLinkage();
 219       std::string Name = Globals[k]->getName();
 220
 221       Constant *Idx[2] = {
 222         ConstantInt::get(Int32Ty, 0),
 223         ConstantInt::get(Int32Ty, k-i)
 224       };
 225       Constant *GEP =
 226           ConstantExpr::getInBoundsGetElementPtr(MergedTy, MergedGV, Idx);
 227       Globals[k]->replaceAllUsesWith(GEP);
 228       Globals[k]->eraseFromParent();
 229
 230       if (Linkage != GlobalValue::InternalLinkage) {
 231         // Generate a new alias...
 232         auto *PTy = cast<PointerType>(GEP->getType());
 233         GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(),
 234                             Linkage, Name, GEP, &M);
 235       }
 236
 237       NumMerged++;
 238     }
 239     i = j;
 240   }
 241
 242   return true;
 243 }
 244
 245 void GlobalMerge::collectUsedGlobalVariables(Module &M) {
 246   // Extract global variables from llvm.used array
 247   const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
 248   if (!GV || !GV->hasInitializer()) return;
 249
 250   // Should be an array of 'i8*'.
 251   const ConstantArray *InitList = cast<ConstantArray>(GV->getInitializer());
 252
 253   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 254     if (const GlobalVariable *G =
 255         dyn_cast<GlobalVariable>(InitList->getOperand(i)->stripPointerCasts()))
 256       MustKeepGlobalVariables.insert(G);
 257 }
 258
 259 void GlobalMerge::setMustKeepGlobalVariables(Module &M) {
 260   collectUsedGlobalVariables(M);
 261
 262   for (Module::iterator IFn = M.begin(), IEndFn = M.end(); IFn != IEndFn;
 263        ++IFn) {
 264     for (Function::iterator IBB = IFn->begin(), IEndBB = IFn->end();
 265          IBB != IEndBB; ++IBB) {
 266       // Follow the invoke link to find the landing pad instruction
 267       const InvokeInst *II = dyn_cast<InvokeInst>(IBB->getTerminator());
 268       if (!II) continue;
 269
 270       const LandingPadInst *LPInst = II->getUnwindDest()->getLandingPadInst();
 271       // Look for globals in the clauses of the landing pad instruction
 272       for (unsigned Idx = 0, NumClauses = LPInst->getNumClauses();
 273            Idx != NumClauses; ++Idx)
 274         if (const GlobalVariable *GV =
 275             dyn_cast<GlobalVariable>(LPInst->getClause(Idx)
 276                                      ->stripPointerCasts()))
 277           MustKeepGlobalVariables.insert(GV);
 278     }
 279   }
 280 }
 281
 282 bool GlobalMerge::doInitialization(Module &M) {
 283   if (!EnableGlobalMerge)
 284     return false;
 285
 286   DenseMap<unsigned, SmallVector<GlobalVariable*, 16> > Globals, ConstGlobals,
 287                                                         BSSGlobals;
 288   bool Changed = false;
 289   setMustKeepGlobalVariables(M);
 290
 291   // Grab all non-const globals.
 292   for (Module::global_iterator I = M.global_begin(),
 293          E = M.global_end(); I != E; ++I) {
 294     // Merge is safe for "normal" internal or external globals only
 295     if (I->isDeclaration() || I->isThreadLocal() || I->hasSection())
 296       continue;
 297
 298     if (!(EnableGlobalMergeOnExternal && I->hasExternalLinkage()) &&
 299         !I->hasInternalLinkage())
 300       continue;
 301
 302     PointerType *PT = dyn_cast<PointerType>(I->getType());
 303     assert(PT && "Global variable is not a pointer!");
 304
 305     unsigned AddressSpace = PT->getAddressSpace();
 306
 307     // Ignore fancy-aligned globals for now.
 308     unsigned Alignment = DL->getPreferredAlignment(I);
 309     Type *Ty = I->getType()->getElementType();
 310     if (Alignment > DL->getABITypeAlignment(Ty))
 311       continue;
 312
 313     // Ignore all 'special' globals.
 314     if (I->getName().startswith("llvm.") ||
 315         I->getName().startswith(".llvm."))
 316       continue;
 317
 318     // Ignore all "required" globals:
 319     if (isMustKeepGlobalVariable(I))
 320       continue;
 321
 322     if (DL->getTypeAllocSize(Ty) < MaxOffset) {
 323       if (TargetLoweringObjectFile::getKindForGlobal(I, *TM).isBSSLocal())
 324         BSSGlobals[AddressSpace].push_back(I);
 325       else if (I->isConstant())
 326         ConstGlobals[AddressSpace].push_back(I);
 327       else
 328         Globals[AddressSpace].push_back(I);
 329     }
 330   }
 331
 332   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 333        I = Globals.begin(), E = Globals.end(); I != E; ++I)
 334     if (I->second.size() > 1)
 335       Changed |= doMerge(I->second, M, false, I->first);
 336
 337   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 338        I = BSSGlobals.begin(), E = BSSGlobals.end(); I != E; ++I)
 339     if (I->second.size() > 1)
 340       Changed |= doMerge(I->second, M, false, I->first);
 341
 342   if (EnableGlobalMergeOnConst)
 343     for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
 344          I = ConstGlobals.begin(), E = ConstGlobals.end(); I != E; ++I)
 345       if (I->second.size() > 1)
 346         Changed |= doMerge(I->second, M, true, I->first);
 347
 348   return Changed;
 349 }
 350
 351 bool GlobalMerge::runOnFunction(Function &F) {
 352   return false;
 353 }
 354
 355 bool GlobalMerge::doFinalization(Module &M) {
 356   MustKeepGlobalVariables.clear();
 357   return false;
 358 }
 359
 360 Pass *llvm::createGlobalMergePass(const TargetMachine *TM, unsigned Offset) {
 361   return new GlobalMerge(TM, Offset);
 362 }