1 //===- ConstantMerge.cpp - Merge duplicate global constants ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the interface to a pass that merges duplicate global
11 // constants together into a single constant that is shared. This is useful
12 // because some passes (ie TraceValues) insert a lot of string constants into
13 // the program, regardless of whether or not an existing string is available.
15 // Algorithm: ConstantMerge is designed to build up a map of available constants
16 // and eliminate duplicates when it is initialized.
18 //===----------------------------------------------------------------------===//
20 #define DEBUG_TYPE "constmerge"
21 #include "llvm/Transforms/IPO.h"
22 #include "llvm/Module.h"
23 #include "llvm/Pass.h"
24 #include "llvm/ADT/Statistic.h"
28 STATISTIC(NumMerged
, "Number of global constants merged");
31 struct ConstantMerge
: public ModulePass
{
32 static char ID
; // Pass identification, replacement for typeid
33 ConstantMerge() : ModulePass(&ID
) {}
35 // run - For this pass, process all of the globals in the module,
36 // eliminating duplicate constants.
38 bool runOnModule(Module
&M
);
42 char ConstantMerge::ID
= 0;
43 static RegisterPass
<ConstantMerge
>
44 X("constmerge", "Merge Duplicate Global Constants");
46 ModulePass
*llvm::createConstantMergePass() { return new ConstantMerge(); }
48 bool ConstantMerge::runOnModule(Module
&M
) {
49 // Map unique constant/section pairs to globals. We don't want to merge
50 // globals in different sections.
51 std::map
<std::pair
<Constant
*, std::string
>, GlobalVariable
*> CMap
;
53 // Replacements - This vector contains a list of replacements to perform.
54 std::vector
<std::pair
<GlobalVariable
*, GlobalVariable
*> > Replacements
;
56 bool MadeChange
= false;
58 // Iterate constant merging while we are still making progress. Merging two
59 // constants together may allow us to merge other constants together if the
60 // second level constants have initializers which point to the globals that
63 // First pass: identify all globals that can be merged together, filling in
64 // the Replacements vector. We cannot do the replacement in this pass
65 // because doing so may cause initializers of other globals to be rewritten,
66 // invalidating the Constant* pointers in CMap.
68 for (Module::global_iterator GVI
= M
.global_begin(), E
= M
.global_end();
70 GlobalVariable
*GV
= GVI
++;
72 // If this GV is dead, remove it.
73 GV
->removeDeadConstantUsers();
74 if (GV
->use_empty() && GV
->hasLocalLinkage()) {
75 GV
->eraseFromParent();
79 // Only process constants with initializers.
80 if (GV
->isConstant() && GV
->hasDefinitiveInitializer()) {
81 Constant
*Init
= GV
->getInitializer();
83 // Check to see if the initializer is already known.
84 GlobalVariable
*&Slot
= CMap
[std::make_pair(Init
, GV
->getSection())];
86 if (Slot
== 0) { // Nope, add it to the map.
88 } else if (GV
->hasLocalLinkage()) { // Yup, this is a duplicate!
89 // Make all uses of the duplicate constant use the canonical version.
90 Replacements
.push_back(std::make_pair(GV
, Slot
));
95 if (Replacements
.empty())
99 // Now that we have figured out which replacements must be made, do them all
100 // now. This avoid invalidating the pointers in CMap, which are unneeded
102 for (unsigned i
= 0, e
= Replacements
.size(); i
!= e
; ++i
) {
103 // Eliminate any uses of the dead global...
104 Replacements
[i
].first
->replaceAllUsesWith(Replacements
[i
].second
);
106 // Delete the global value from the module...
107 M
.getGlobalList().erase(Replacements
[i
].first
);
110 NumMerged
+= Replacements
.size();
111 Replacements
.clear();