-//===- ConstantMerge.cpp - Merge duplicate global constants -----------------=//
+//===- ConstantMerge.cpp - Merge duplicate global constants ---------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file defines the interface to a pass that merges duplicate global
// constants together into a single constant that is shared. This is useful
//
//===----------------------------------------------------------------------===//
+#define DEBUG_TYPE "constmerge"
#include "llvm/Transforms/IPO.h"
-#include "llvm/Module.h"
-#include "llvm/Constants.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/PointerIntPair.h"
+#include "llvm/ADT/SmallPtrSet.h"
+#include "llvm/ADT/Statistic.h"
+#include "llvm/IR/Constants.h"
+#include "llvm/IR/DataLayout.h"
+#include "llvm/IR/DerivedTypes.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IR/Operator.h"
#include "llvm/Pass.h"
-#include "Support/StatisticReporter.h"
+using namespace llvm;
+
+STATISTIC(NumMerged, "Number of global constants merged");
namespace {
- struct ConstantMerge : public Pass {
- // run - For this pass, process all of the globals in the module,
- // eliminating duplicate constants.
- //
- bool run(Module &M);
-
- private:
- void replaceUsesOfWith(GlobalVariable *Old, GlobalVariable *New);
- void replaceConstantWith(Constant *Old, Constant *New);
+ struct ConstantMerge : public ModulePass {
+ static char ID; // Pass identification, replacement for typeid
+ ConstantMerge() : ModulePass(ID) {
+ initializeConstantMergePass(*PassRegistry::getPassRegistry());
+ }
+
+ // For this pass, process all of the globals in the module, eliminating
+ // duplicate constants.
+ bool runOnModule(Module &M);
+
+ // Return true iff we can determine the alignment of this global variable.
+ bool hasKnownAlignment(GlobalVariable *GV) const;
+
+ // Return the alignment of the global, including converting the default
+ // alignment to a concrete value.
+ unsigned getAlignment(GlobalVariable *GV) const;
+
+ const DataLayout *TD;
};
+}
- Statistic<> NumMerged("constmerge\t\t- Number of global constants merged");
- RegisterOpt<ConstantMerge> X("constmerge","Merge Duplicate Global Constants");
+char ConstantMerge::ID = 0;
+INITIALIZE_PASS(ConstantMerge, "constmerge",
+ "Merge Duplicate Global Constants", false, false)
+
+ModulePass *llvm::createConstantMergePass() { return new ConstantMerge(); }
+
+
+
+/// Find values that are marked as llvm.used.
+static void FindUsedValues(GlobalVariable *LLVMUsed,
+ SmallPtrSet<const GlobalValue*, 8> &UsedValues) {
+ if (LLVMUsed == 0) return;
+ ConstantArray *Inits = cast<ConstantArray>(LLVMUsed->getInitializer());
+
+ for (unsigned i = 0, e = Inits->getNumOperands(); i != e; ++i) {
+ Value *Operand = Inits->getOperand(i)->stripPointerCastsNoFollowAliases();
+ GlobalValue *GV = cast<GlobalValue>(Operand);
+ UsedValues.insert(GV);
+ }
}
-Pass *createConstantMergePass() { return new ConstantMerge(); }
+// True if A is better than B.
+static bool IsBetterCannonical(const GlobalVariable &A,
+ const GlobalVariable &B) {
+ if (!A.hasLocalLinkage() && B.hasLocalLinkage())
+ return true;
+ if (A.hasLocalLinkage() && !B.hasLocalLinkage())
+ return false;
-bool ConstantMerge::run(Module &M) {
- std::map<Constant*, GlobalVariable*> CMap;
- bool MadeChanges = false;
-
- for (Module::giterator GV = M.gbegin(), E = M.gend(); GV != E; ++GV)
- if (GV->isConstant()) { // Only process constants
- assert(GV->hasInitializer() && "Globals constants must have inits!");
- Constant *Init = GV->getInitializer();
+ return A.hasUnnamedAddr();
+}
- // Check to see if the initializer is already known...
- std::map<Constant*, GlobalVariable*>::iterator I = CMap.find(Init);
+bool ConstantMerge::hasKnownAlignment(GlobalVariable *GV) const {
+ return TD || GV->getAlignment() != 0;
+}
- if (I == CMap.end()) { // Nope, add it to the map
- CMap.insert(I, std::make_pair(Init, GV));
- } else { // Yup, this is a duplicate!
- // Make all uses of the duplicate constant use the cannonical version...
- replaceUsesOfWith(GV, I->second);
+unsigned ConstantMerge::getAlignment(GlobalVariable *GV) const {
+ if (TD)
+ return TD->getPreferredAlignment(GV);
+ return GV->getAlignment();
+}
- // Delete the global value from the module... and back up iterator to
- // not skip the next global...
- GV = --M.getGlobalList().erase(GV);
+bool ConstantMerge::runOnModule(Module &M) {
+ TD = getAnalysisIfAvailable<DataLayout>();
- ++NumMerged;
- MadeChanges = true;
+ // Find all the globals that are marked "used". These cannot be merged.
+ SmallPtrSet<const GlobalValue*, 8> UsedGlobals;
+ FindUsedValues(M.getGlobalVariable("llvm.used"), UsedGlobals);
+ FindUsedValues(M.getGlobalVariable("llvm.compiler.used"), UsedGlobals);
+
+ // Map unique <constants, has-unknown-alignment> pairs to globals. We don't
+ // want to merge globals of unknown alignment with those of explicit
+ // alignment. If we have DataLayout, we always know the alignment.
+ DenseMap<PointerIntPair<Constant*, 1, bool>, GlobalVariable*> CMap;
+
+ // Replacements - This vector contains a list of replacements to perform.
+ SmallVector<std::pair<GlobalVariable*, GlobalVariable*>, 32> Replacements;
+
+ bool MadeChange = false;
+
+ // Iterate constant merging while we are still making progress. Merging two
+ // constants together may allow us to merge other constants together if the
+ // second level constants have initializers which point to the globals that
+ // were just merged.
+ while (1) {
+
+ // First: Find the canonical constants others will be merged with.
+ for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
+ GVI != E; ) {
+ GlobalVariable *GV = GVI++;
+
+ // If this GV is dead, remove it.
+ GV->removeDeadConstantUsers();
+ if (GV->use_empty() && GV->hasLocalLinkage()) {
+ GV->eraseFromParent();
+ continue;
}
+
+ // Only process constants with initializers in the default address space.
+ if (!GV->isConstant() || !GV->hasDefinitiveInitializer() ||
+ GV->getType()->getAddressSpace() != 0 || GV->hasSection() ||
+ // Don't touch values marked with attribute(used).
+ UsedGlobals.count(GV))
+ continue;
+
+ // This transformation is legal for weak ODR globals in the sense it
+ // doesn't change semantics, but we really don't want to perform it
+ // anyway; it's likely to pessimize code generation, and some tools
+ // (like the Darwin linker in cases involving CFString) don't expect it.
+ if (GV->isWeakForLinker())
+ continue;
+
+ Constant *Init = GV->getInitializer();
+
+ // Check to see if the initializer is already known.
+ PointerIntPair<Constant*, 1, bool> Pair(Init, hasKnownAlignment(GV));
+ GlobalVariable *&Slot = CMap[Pair];
+
+ // If this is the first constant we find or if the old one is local,
+ // replace with the current one. If the current is externally visible
+ // it cannot be replace, but can be the canonical constant we merge with.
+ if (Slot == 0 || IsBetterCannonical(*GV, *Slot))
+ Slot = GV;
}
- return MadeChanges;
-}
+ // Second: identify all globals that can be merged together, filling in
+ // the Replacements vector. We cannot do the replacement in this pass
+ // because doing so may cause initializers of other globals to be rewritten,
+ // invalidating the Constant* pointers in CMap.
+ for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
+ GVI != E; ) {
+ GlobalVariable *GV = GVI++;
+
+ // Only process constants with initializers in the default address space.
+ if (!GV->isConstant() || !GV->hasDefinitiveInitializer() ||
+ GV->getType()->getAddressSpace() != 0 || GV->hasSection() ||
+ // Don't touch values marked with attribute(used).
+ UsedGlobals.count(GV))
+ continue;
+
+ // We can only replace constant with local linkage.
+ if (!GV->hasLocalLinkage())
+ continue;
-/// replaceUsesOfWith - Replace all uses of Old with New. For instructions,
-/// this is a really simple matter of replacing the reference to Old with a
-/// reference to New. For constants references, however, we must carefully
-/// build replacement constants to substitute in.
-///
-void ConstantMerge::replaceUsesOfWith(GlobalVariable *Old, GlobalVariable *New){
- while (!Old->use_empty()) {
- User *U = Old->use_back();
- if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(U))
- replaceConstantWith(CPR, ConstantPointerRef::get(New));
- else
- U->replaceUsesOfWith(Old, New);
- }
-}
+ Constant *Init = GV->getInitializer();
+
+ // Check to see if the initializer is already known.
+ PointerIntPair<Constant*, 1, bool> Pair(Init, hasKnownAlignment(GV));
+ GlobalVariable *Slot = CMap[Pair];
+
+ if (!Slot || Slot == GV)
+ continue;
+
+ if (!Slot->hasUnnamedAddr() && !GV->hasUnnamedAddr())
+ continue;
-/// replaceWith - Ok, so we have a constant 'Old' and we want to replace it with
-/// 'New'. To do this, we have to recursively go through the uses of Old,
-/// replacing them with new things. The problem is that if a constant uses Old,
-/// then we need to replace the uses of the constant with uses of the equivalent
-/// constant that uses New instead.
-///
-void ConstantMerge::replaceConstantWith(Constant *Old, Constant *New) {
- while (!Old->use_empty()) {
- User *U = Old->use_back();
-
- if (Constant *C = dyn_cast<Constant>(U)) {
- Constant *Replacement = 0;
-
- // Depending on the type of constant, build a suitable replacement...
- if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
- if (CE->getOpcode() == Instruction::GetElementPtr) {
- std::vector<Constant*> Indices;
- Constant *Pointer = cast<Constant>(CE->getOperand(0));
- Indices.reserve(CE->getNumOperands()-1);
- if (Pointer == Old) Pointer = New;
-
- for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i) {
- Constant *Val = cast<Constant>(CE->getOperand(i));
- if (Val == Old) Val = New;
- Indices.push_back(Val);
- }
- Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices);
- } else if (CE->getOpcode() == Instruction::Cast) {
- assert(CE->getOperand(0) == Old && "Cast only has one use!");
- Replacement = ConstantExpr::getCast(New, CE->getType());
- } else if (CE->getNumOperands() == 2) {
- Constant *C1 = cast<Constant>(CE->getOperand(0));
- Constant *C2 = cast<Constant>(CE->getOperand(1));
- if (C1 == Old) C1 = New;
- if (C2 == Old) C2 = New;
- Replacement = ConstantExpr::get(CE->getOpcode(), C1, C2);
- } else {
- assert(0 && "Unknown ConstantExpr type!");
- }
-
-
- } else if (ConstantArray *CA = dyn_cast<ConstantArray>(C)) {
- std::vector<Constant*> Values;
- Values.reserve(CA->getValues().size());
- for (unsigned i = 0, e = CA->getValues().size(); i != e; ++i) {
- Constant *Val = cast<Constant>(CA->getValues()[i]);
- if (Val == Old) Val = New;
- Values.push_back(Val);
- }
-
- Replacement = ConstantArray::get(CA->getType(), Values);
- } else if (ConstantStruct *CS = dyn_cast<ConstantStruct>(C)) {
- std::vector<Constant*> Values;
- Values.reserve(CS->getValues().size());
-
- for (unsigned i = 0, e = CS->getValues().size(); i != e; ++i) {
- Constant *Val = cast<Constant>(CS->getValues()[i]);
- if (Val == Old) Val = New;
- Values.push_back(Val);
- }
-
- Replacement = ConstantStruct::get(CS->getType(), Values);
- } else {
- assert(0 && "Unexpected/unknown constant type!");
+ if (!GV->hasUnnamedAddr())
+ Slot->setUnnamedAddr(false);
+
+ // Make all uses of the duplicate constant use the canonical version.
+ Replacements.push_back(std::make_pair(GV, Slot));
+ }
+
+ if (Replacements.empty())
+ return MadeChange;
+ CMap.clear();
+
+ // Now that we have figured out which replacements must be made, do them all
+ // now. This avoid invalidating the pointers in CMap, which are unneeded
+ // now.
+ for (unsigned i = 0, e = Replacements.size(); i != e; ++i) {
+ // Bump the alignment if necessary.
+ if (Replacements[i].first->getAlignment() ||
+ Replacements[i].second->getAlignment()) {
+ Replacements[i].second->setAlignment(std::max(
+ Replacements[i].first->getAlignment(),
+ Replacements[i].second->getAlignment()));
}
-
- // Now that we have a suitable replacement, recursively eliminate C.
- replaceConstantWith(C, Replacement);
- } else {
- // If it is not a constant, we can simply replace uses of Old with New.
- U->replaceUsesOfWith(Old, New);
+ // Eliminate any uses of the dead global.
+ Replacements[i].first->replaceAllUsesWith(Replacements[i].second);
+
+ // Delete the global value from the module.
+ assert(Replacements[i].first->hasLocalLinkage() &&
+ "Refusing to delete an externally visible global variable.");
+ Replacements[i].first->eraseFromParent();
}
+ NumMerged += Replacements.size();
+ Replacements.clear();
}
-
- // No-one refers to this old dead constant now, destroy it!
- Old->destroyConstant();
}
projects / oota-llvm.git / blobdiff