MIR Serialization: Serialize the pointer IR expression values in the machine
[oota-llvm.git] / 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 // However, merging globals can have tradeoffs:
54 // - it confuses debuggers, tools, and users
55 // - it makes linker optimizations less useful (order files, LOHs, ...)
56 // - it forces usage of indexed addressing (which isn't necessarily "free")
57 // - it can increase register pressure when the uses are disparate enough.
58 // 
59 // We use heuristics to discover the best global grouping we can (cf cl::opts).
60 // ===---------------------------------------------------------------------===//
61
62 #include "llvm/Transforms/Scalar.h"
63 #include "llvm/ADT/DenseMap.h"
64 #include "llvm/ADT/SmallBitVector.h"
65 #include "llvm/ADT/SmallPtrSet.h"
66 #include "llvm/ADT/Statistic.h"
67 #include "llvm/CodeGen/Passes.h"
68 #include "llvm/IR/Attributes.h"
69 #include "llvm/IR/Constants.h"
70 #include "llvm/IR/DataLayout.h"
71 #include "llvm/IR/DerivedTypes.h"
72 #include "llvm/IR/Function.h"
73 #include "llvm/IR/GlobalVariable.h"
74 #include "llvm/IR/Instructions.h"
75 #include "llvm/IR/Intrinsics.h"
76 #include "llvm/IR/Module.h"
77 #include "llvm/Pass.h"
78 #include "llvm/Support/CommandLine.h"
79 #include "llvm/Support/Debug.h"
80 #include "llvm/Support/raw_ostream.h"
81 #include "llvm/Target/TargetLowering.h"
82 #include "llvm/Target/TargetLoweringObjectFile.h"
83 #include "llvm/Target/TargetSubtargetInfo.h"
84 #include <algorithm>
85 using namespace llvm;
86
87 #define DEBUG_TYPE "global-merge"
88
89 // FIXME: This is only useful as a last-resort way to disable the pass.
90 static cl::opt<bool>
91 EnableGlobalMerge("enable-global-merge", cl::Hidden,
92                   cl::desc("Enable the global merge pass"),
93                   cl::init(true));
94
95 static cl::opt<bool> GlobalMergeGroupByUse(
96     "global-merge-group-by-use", cl::Hidden,
97     cl::desc("Improve global merge pass to look at uses"), cl::init(true));
98
99 static cl::opt<bool> GlobalMergeIgnoreSingleUse(
100     "global-merge-ignore-single-use", cl::Hidden,
101     cl::desc("Improve global merge pass to ignore globals only used alone"),
102     cl::init(true));
103
104 static cl::opt<bool>
105 EnableGlobalMergeOnConst("global-merge-on-const", cl::Hidden,
106                          cl::desc("Enable global merge pass on constants"),
107                          cl::init(false));
108
109 // FIXME: this could be a transitional option, and we probably need to remove
110 // it if only we are sure this optimization could always benefit all targets.
111 static cl::opt<cl::boolOrDefault>
112 EnableGlobalMergeOnExternal("global-merge-on-external", cl::Hidden,
113      cl::desc("Enable global merge pass on external linkage"));
114
115 STATISTIC(NumMerged, "Number of globals merged");
116 namespace {
117   class GlobalMerge : public FunctionPass {
118     const TargetMachine *TM;
119     // FIXME: Infer the maximum possible offset depending on the actual users
120     // (these max offsets are different for the users inside Thumb or ARM
121     // functions), see the code that passes in the offset in the ARM backend
122     // for more information.
123     unsigned MaxOffset;
124
125     /// Whether we should try to optimize for size only.
126     /// Currently, this applies a dead simple heuristic: only consider globals
127     /// used in minsize functions for merging.
128     /// FIXME: This could learn about optsize, and be used in the cost model.
129     bool OnlyOptimizeForSize;
130
131     /// Whether we should merge global variables that have external linkage.
132     bool MergeExternalGlobals;
133
134     bool doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
135                  Module &M, bool isConst, unsigned AddrSpace) const;
136     /// \brief Merge everything in \p Globals for which the corresponding bit
137     /// in \p GlobalSet is set.
138     bool doMerge(SmallVectorImpl<GlobalVariable *> &Globals,
139                  const BitVector &GlobalSet, Module &M, bool isConst,
140                  unsigned AddrSpace) const;
141
142     /// \brief Check if the given variable has been identified as must keep
143     /// \pre setMustKeepGlobalVariables must have been called on the Module that
144     ///      contains GV
145     bool isMustKeepGlobalVariable(const GlobalVariable *GV) const {
146       return MustKeepGlobalVariables.count(GV);
147     }
148
149     /// Collect every variables marked as "used" or used in a landing pad
150     /// instruction for this Module.
151     void setMustKeepGlobalVariables(Module &M);
152
153     /// Collect every variables marked as "used"
154     void collectUsedGlobalVariables(Module &M);
155
156     /// Keep track of the GlobalVariable that must not be merged away
157     SmallPtrSet<const GlobalVariable *, 16> MustKeepGlobalVariables;
158
159   public:
160     static char ID;             // Pass identification, replacement for typeid.
161     explicit GlobalMerge(const TargetMachine *TM = nullptr,
162                          unsigned MaximalOffset = 0,
163                          bool OnlyOptimizeForSize = false,
164                          bool MergeExternalGlobals = false)
165         : FunctionPass(ID), TM(TM), MaxOffset(MaximalOffset),
166           OnlyOptimizeForSize(OnlyOptimizeForSize),
167           MergeExternalGlobals(MergeExternalGlobals) {
168       initializeGlobalMergePass(*PassRegistry::getPassRegistry());
169     }
170
171     bool doInitialization(Module &M) override;
172     bool runOnFunction(Function &F) override;
173     bool doFinalization(Module &M) override;
174
175     const char *getPassName() const override {
176       return "Merge internal globals";
177     }
178
179     void getAnalysisUsage(AnalysisUsage &AU) const override {
180       AU.setPreservesCFG();
181       FunctionPass::getAnalysisUsage(AU);
182     }
183   };
184 } // end anonymous namespace
185
186 char GlobalMerge::ID = 0;
187 INITIALIZE_PASS_BEGIN(GlobalMerge, "global-merge", "Merge global variables",
188                       false, false)
189 INITIALIZE_PASS_END(GlobalMerge, "global-merge", "Merge global variables",
190                     false, false)
191
192 bool GlobalMerge::doMerge(SmallVectorImpl<GlobalVariable*> &Globals,
193                           Module &M, bool isConst, unsigned AddrSpace) const {
194   auto &DL = M.getDataLayout();
195   // FIXME: Find better heuristics
196   std::stable_sort(
197       Globals.begin(), Globals.end(),
198       [&DL](const GlobalVariable *GV1, const GlobalVariable *GV2) {
199         Type *Ty1 = cast<PointerType>(GV1->getType())->getElementType();
200         Type *Ty2 = cast<PointerType>(GV2->getType())->getElementType();
201
202         return (DL.getTypeAllocSize(Ty1) < DL.getTypeAllocSize(Ty2));
203       });
204
205   // If we want to just blindly group all globals together, do so.
206   if (!GlobalMergeGroupByUse) {
207     BitVector AllGlobals(Globals.size());
208     AllGlobals.set();
209     return doMerge(Globals, AllGlobals, M, isConst, AddrSpace);
210   }
211
212   // If we want to be smarter, look at all uses of each global, to try to
213   // discover all sets of globals used together, and how many times each of
214   // these sets occurred.
215   //
216   // Keep this reasonably efficient, by having an append-only list of all sets
217   // discovered so far (UsedGlobalSet), and mapping each "together-ness" unit of
218   // code (currently, a Function) to the set of globals seen so far that are
219   // used together in that unit (GlobalUsesByFunction).
220   //
221   // When we look at the Nth global, we now that any new set is either:
222   // - the singleton set {N}, containing this global only, or
223   // - the union of {N} and a previously-discovered set, containing some
224   //   combination of the previous N-1 globals.
225   // Using that knowledge, when looking at the Nth global, we can keep:
226   // - a reference to the singleton set {N} (CurGVOnlySetIdx)
227   // - a list mapping each previous set to its union with {N} (EncounteredUGS),
228   //   if it actually occurs.
229
230   // We keep track of the sets of globals used together "close enough".
231   struct UsedGlobalSet {
232     UsedGlobalSet(size_t Size) : Globals(Size), UsageCount(1) {}
233     BitVector Globals;
234     unsigned UsageCount;
235   };
236
237   // Each set is unique in UsedGlobalSets.
238   std::vector<UsedGlobalSet> UsedGlobalSets;
239
240   // Avoid repeating the create-global-set pattern.
241   auto CreateGlobalSet = [&]() -> UsedGlobalSet & {
242     UsedGlobalSets.emplace_back(Globals.size());
243     return UsedGlobalSets.back();
244   };
245
246   // The first set is the empty set.
247   CreateGlobalSet().UsageCount = 0;
248
249   // We define "close enough" to be "in the same function".
250   // FIXME: Grouping uses by function is way too aggressive, so we should have
251   // a better metric for distance between uses.
252   // The obvious alternative would be to group by BasicBlock, but that's in
253   // turn too conservative..
254   // Anything in between wouldn't be trivial to compute, so just stick with
255   // per-function grouping.
256
257   // The value type is an index into UsedGlobalSets.
258   // The default (0) conveniently points to the empty set.
259   DenseMap<Function *, size_t /*UsedGlobalSetIdx*/> GlobalUsesByFunction;
260
261   // Now, look at each merge-eligible global in turn.
262
263   // Keep track of the sets we already encountered to which we added the
264   // current global.
265   // Each element matches the same-index element in UsedGlobalSets.
266   // This lets us efficiently tell whether a set has already been expanded to
267   // include the current global.
268   std::vector<size_t> EncounteredUGS;
269
270   for (size_t GI = 0, GE = Globals.size(); GI != GE; ++GI) {
271     GlobalVariable *GV = Globals[GI];
272
273     // Reset the encountered sets for this global...
274     std::fill(EncounteredUGS.begin(), EncounteredUGS.end(), 0);
275     // ...and grow it in case we created new sets for the previous global.
276     EncounteredUGS.resize(UsedGlobalSets.size());
277
278     // We might need to create a set that only consists of the current global.
279     // Keep track of its index into UsedGlobalSets.
280     size_t CurGVOnlySetIdx = 0;
281
282     // For each global, look at all its Uses.
283     for (auto &U : GV->uses()) {
284       // This Use might be a ConstantExpr.  We're interested in Instruction
285       // users, so look through ConstantExpr...
286       Use *UI, *UE;
287       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U.getUser())) {
288         if (CE->use_empty())
289           continue;
290         UI = &*CE->use_begin();
291         UE = nullptr;
292       } else if (isa<Instruction>(U.getUser())) {
293         UI = &U;
294         UE = UI->getNext();
295       } else {
296         continue;
297       }
298
299       // ...to iterate on all the instruction users of the global.
300       // Note that we iterate on Uses and not on Users to be able to getNext().
301       for (; UI != UE; UI = UI->getNext()) {
302         Instruction *I = dyn_cast<Instruction>(UI->getUser());
303         if (!I)
304           continue;
305
306         Function *ParentFn = I->getParent()->getParent();
307
308         // If we're only optimizing for size, ignore non-minsize functions.
309         if (OnlyOptimizeForSize && !ParentFn->optForMinSize())
310           continue;
311
312         size_t UGSIdx = GlobalUsesByFunction[ParentFn];
313
314         // If this is the first global the basic block uses, map it to the set
315         // consisting of this global only.
316         if (!UGSIdx) {
317           // If that set doesn't exist yet, create it.
318           if (!CurGVOnlySetIdx) {
319             CurGVOnlySetIdx = UsedGlobalSets.size();
320             CreateGlobalSet().Globals.set(GI);
321           } else {
322             ++UsedGlobalSets[CurGVOnlySetIdx].UsageCount;
323           }
324
325           GlobalUsesByFunction[ParentFn] = CurGVOnlySetIdx;
326           continue;
327         }
328
329         // If we already encountered this BB, just increment the counter.
330         if (UsedGlobalSets[UGSIdx].Globals.test(GI)) {
331           ++UsedGlobalSets[UGSIdx].UsageCount;
332           continue;
333         }
334
335         // If not, the previous set wasn't actually used in this function.
336         --UsedGlobalSets[UGSIdx].UsageCount;
337
338         // If we already expanded the previous set to include this global, just
339         // reuse that expanded set.
340         if (size_t ExpandedIdx = EncounteredUGS[UGSIdx]) {
341           ++UsedGlobalSets[ExpandedIdx].UsageCount;
342           GlobalUsesByFunction[ParentFn] = ExpandedIdx;
343           continue;
344         }
345
346         // If not, create a new set consisting of the union of the previous set
347         // and this global.  Mark it as encountered, so we can reuse it later.
348         GlobalUsesByFunction[ParentFn] = EncounteredUGS[UGSIdx] =
349             UsedGlobalSets.size();
350
351         UsedGlobalSet &NewUGS = CreateGlobalSet();
352         NewUGS.Globals.set(GI);
353         NewUGS.Globals |= UsedGlobalSets[UGSIdx].Globals;
354       }
355     }
356   }
357
358   // Now we found a bunch of sets of globals used together.  We accumulated
359   // the number of times we encountered the sets (i.e., the number of blocks
360   // that use that exact set of globals).
361   //
362   // Multiply that by the size of the set to give us a crude profitability
363   // metric.
364   std::sort(UsedGlobalSets.begin(), UsedGlobalSets.end(),
365             [](const UsedGlobalSet &UGS1, const UsedGlobalSet &UGS2) {
366               return UGS1.Globals.count() * UGS1.UsageCount <
367                      UGS2.Globals.count() * UGS2.UsageCount;
368             });
369
370   // We can choose to merge all globals together, but ignore globals never used
371   // with another global.  This catches the obviously non-profitable cases of
372   // having a single global, but is aggressive enough for any other case.
373   if (GlobalMergeIgnoreSingleUse) {
374     BitVector AllGlobals(Globals.size());
375     for (size_t i = 0, e = UsedGlobalSets.size(); i != e; ++i) {
376       const UsedGlobalSet &UGS = UsedGlobalSets[e - i - 1];
377       if (UGS.UsageCount == 0)
378         continue;
379       if (UGS.Globals.count() > 1)
380         AllGlobals |= UGS.Globals;
381     }
382     return doMerge(Globals, AllGlobals, M, isConst, AddrSpace);
383   }
384
385   // Starting from the sets with the best (=biggest) profitability, find a
386   // good combination.
387   // The ideal (and expensive) solution can only be found by trying all
388   // combinations, looking for the one with the best profitability.
389   // Don't be smart about it, and just pick the first compatible combination,
390   // starting with the sets with the best profitability.
391   BitVector PickedGlobals(Globals.size());
392   bool Changed = false;
393
394   for (size_t i = 0, e = UsedGlobalSets.size(); i != e; ++i) {
395     const UsedGlobalSet &UGS = UsedGlobalSets[e - i - 1];
396     if (UGS.UsageCount == 0)
397       continue;
398     if (PickedGlobals.anyCommon(UGS.Globals))
399       continue;
400     PickedGlobals |= UGS.Globals;
401     // If the set only contains one global, there's no point in merging.
402     // Ignore the global for inclusion in other sets though, so keep it in
403     // PickedGlobals.
404     if (UGS.Globals.count() < 2)
405       continue;
406     Changed |= doMerge(Globals, UGS.Globals, M, isConst, AddrSpace);
407   }
408
409   return Changed;
410 }
411
412 bool GlobalMerge::doMerge(SmallVectorImpl<GlobalVariable *> &Globals,
413                           const BitVector &GlobalSet, Module &M, bool isConst,
414                           unsigned AddrSpace) const {
415
416   Type *Int32Ty = Type::getInt32Ty(M.getContext());
417   auto &DL = M.getDataLayout();
418
419   assert(Globals.size() > 1);
420
421   DEBUG(dbgs() << " Trying to merge set, starts with #"
422                << GlobalSet.find_first() << "\n");
423
424   ssize_t i = GlobalSet.find_first();
425   while (i != -1) {
426     ssize_t j = 0;
427     uint64_t MergedSize = 0;
428     std::vector<Type*> Tys;
429     std::vector<Constant*> Inits;
430
431     for (j = i; j != -1; j = GlobalSet.find_next(j)) {
432       Type *Ty = Globals[j]->getType()->getElementType();
433       MergedSize += DL.getTypeAllocSize(Ty);
434       if (MergedSize > MaxOffset) {
435         break;
436       }
437       Tys.push_back(Ty);
438       Inits.push_back(Globals[j]->getInitializer());
439     }
440
441     StructType *MergedTy = StructType::get(M.getContext(), Tys);
442     Constant *MergedInit = ConstantStruct::get(MergedTy, Inits);
443
444     GlobalVariable *MergedGV = new GlobalVariable(
445         M, MergedTy, isConst, GlobalValue::PrivateLinkage, MergedInit,
446         "_MergedGlobals", nullptr, GlobalVariable::NotThreadLocal, AddrSpace);
447
448     for (ssize_t k = i, idx = 0; k != j; k = GlobalSet.find_next(k)) {
449       GlobalValue::LinkageTypes Linkage = Globals[k]->getLinkage();
450       std::string Name = Globals[k]->getName();
451
452       Constant *Idx[2] = {
453         ConstantInt::get(Int32Ty, 0),
454         ConstantInt::get(Int32Ty, idx++)
455       };
456       Constant *GEP =
457           ConstantExpr::getInBoundsGetElementPtr(MergedTy, MergedGV, Idx);
458       Globals[k]->replaceAllUsesWith(GEP);
459       Globals[k]->eraseFromParent();
460
461       // When the linkage is not internal we must emit an alias for the original
462       // variable name as it may be accessed from another object. On non-Mach-O
463       // we can also emit an alias for internal linkage as it's safe to do so.
464       // It's not safe on Mach-O as the alias (and thus the portion of the
465       // MergedGlobals variable) may be dead stripped at link time.
466       if (Linkage != GlobalValue::InternalLinkage ||
467           !TM->getTargetTriple().isOSBinFormatMachO()) {
468         auto *PTy = cast<PointerType>(GEP->getType());
469         GlobalAlias::create(PTy, Linkage, Name, GEP, &M);
470       }
471
472       NumMerged++;
473     }
474     i = j;
475   }
476
477   return true;
478 }
479
480 void GlobalMerge::collectUsedGlobalVariables(Module &M) {
481   // Extract global variables from llvm.used array
482   const GlobalVariable *GV = M.getGlobalVariable("llvm.used");
483   if (!GV || !GV->hasInitializer()) return;
484
485   // Should be an array of 'i8*'.
486   const ConstantArray *InitList = cast<ConstantArray>(GV->getInitializer());
487
488   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
489     if (const GlobalVariable *G =
490         dyn_cast<GlobalVariable>(InitList->getOperand(i)->stripPointerCasts()))
491       MustKeepGlobalVariables.insert(G);
492 }
493
494 void GlobalMerge::setMustKeepGlobalVariables(Module &M) {
495   collectUsedGlobalVariables(M);
496
497   for (Module::iterator IFn = M.begin(), IEndFn = M.end(); IFn != IEndFn;
498        ++IFn) {
499     for (Function::iterator IBB = IFn->begin(), IEndBB = IFn->end();
500          IBB != IEndBB; ++IBB) {
501       // Follow the invoke link to find the landing pad instruction
502       const InvokeInst *II = dyn_cast<InvokeInst>(IBB->getTerminator());
503       if (!II) continue;
504
505       const LandingPadInst *LPInst = II->getUnwindDest()->getLandingPadInst();
506       // Look for globals in the clauses of the landing pad instruction
507       for (unsigned Idx = 0, NumClauses = LPInst->getNumClauses();
508            Idx != NumClauses; ++Idx)
509         if (const GlobalVariable *GV =
510             dyn_cast<GlobalVariable>(LPInst->getClause(Idx)
511                                      ->stripPointerCasts()))
512           MustKeepGlobalVariables.insert(GV);
513     }
514   }
515 }
516
517 bool GlobalMerge::doInitialization(Module &M) {
518   if (!EnableGlobalMerge)
519     return false;
520
521   auto &DL = M.getDataLayout();
522   DenseMap<unsigned, SmallVector<GlobalVariable*, 16> > Globals, ConstGlobals,
523                                                         BSSGlobals;
524   bool Changed = false;
525   setMustKeepGlobalVariables(M);
526
527   // Grab all non-const globals.
528   for (Module::global_iterator I = M.global_begin(),
529          E = M.global_end(); I != E; ++I) {
530     // Merge is safe for "normal" internal or external globals only
531     if (I->isDeclaration() || I->isThreadLocal() || I->hasSection())
532       continue;
533
534     if (!(MergeExternalGlobals && I->hasExternalLinkage()) &&
535         !I->hasInternalLinkage())
536       continue;
537
538     PointerType *PT = dyn_cast<PointerType>(I->getType());
539     assert(PT && "Global variable is not a pointer!");
540
541     unsigned AddressSpace = PT->getAddressSpace();
542
543     // Ignore fancy-aligned globals for now.
544     unsigned Alignment = DL.getPreferredAlignment(I);
545     Type *Ty = I->getType()->getElementType();
546     if (Alignment > DL.getABITypeAlignment(Ty))
547       continue;
548
549     // Ignore all 'special' globals.
550     if (I->getName().startswith("llvm.") ||
551         I->getName().startswith(".llvm."))
552       continue;
553
554     // Ignore all "required" globals:
555     if (isMustKeepGlobalVariable(I))
556       continue;
557
558     if (DL.getTypeAllocSize(Ty) < MaxOffset) {
559       if (TargetLoweringObjectFile::getKindForGlobal(I, *TM).isBSSLocal())
560         BSSGlobals[AddressSpace].push_back(I);
561       else if (I->isConstant())
562         ConstGlobals[AddressSpace].push_back(I);
563       else
564         Globals[AddressSpace].push_back(I);
565     }
566   }
567
568   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
569        I = Globals.begin(), E = Globals.end(); I != E; ++I)
570     if (I->second.size() > 1)
571       Changed |= doMerge(I->second, M, false, I->first);
572
573   for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
574        I = BSSGlobals.begin(), E = BSSGlobals.end(); I != E; ++I)
575     if (I->second.size() > 1)
576       Changed |= doMerge(I->second, M, false, I->first);
577
578   if (EnableGlobalMergeOnConst)
579     for (DenseMap<unsigned, SmallVector<GlobalVariable*, 16> >::iterator
580          I = ConstGlobals.begin(), E = ConstGlobals.end(); I != E; ++I)
581       if (I->second.size() > 1)
582         Changed |= doMerge(I->second, M, true, I->first);
583
584   return Changed;
585 }
586
587 bool GlobalMerge::runOnFunction(Function &F) {
588   return false;
589 }
590
591 bool GlobalMerge::doFinalization(Module &M) {
592   MustKeepGlobalVariables.clear();
593   return false;
594 }
595
596 Pass *llvm::createGlobalMergePass(const TargetMachine *TM, unsigned Offset,
597                                   bool OnlyOptimizeForSize,
598                                   bool MergeExternalByDefault) {
599   bool MergeExternal = (EnableGlobalMergeOnExternal == cl::BOU_UNSET) ?
600     MergeExternalByDefault : (EnableGlobalMergeOnExternal == cl::BOU_TRUE);
601   return new GlobalMerge(TM, Offset, OnlyOptimizeForSize, MergeExternal);
602 }