1 //===- StripSymbols.cpp - Strip symbols and debug info from a module ------===//
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 // The StripSymbols transformation implements code stripping. Specifically, it
13 // * names for virtual registers
14 // * symbols for internal globals and functions
15 // * debug information
17 // Note that this transformation makes code much less readable, so it should
18 // only be used in situations where the 'strip' utility would be used, such as
19 // reducing code size or making it harder to reverse engineer code.
21 //===----------------------------------------------------------------------===//
23 #include "llvm/Transforms/IPO.h"
24 #include "llvm/Constants.h"
25 #include "llvm/DerivedTypes.h"
26 #include "llvm/Instructions.h"
27 #include "llvm/LLVMContext.h"
28 #include "llvm/Module.h"
29 #include "llvm/Pass.h"
30 #include "llvm/Analysis/DebugInfo.h"
31 #include "llvm/ValueSymbolTable.h"
32 #include "llvm/TypeSymbolTable.h"
33 #include "llvm/Transforms/Utils/Local.h"
34 #include "llvm/Support/Compiler.h"
35 #include "llvm/ADT/SmallPtrSet.h"
39 class VISIBILITY_HIDDEN StripSymbols : public ModulePass {
42 static char ID; // Pass identification, replacement for typeid
43 explicit StripSymbols(bool ODI = false)
44 : ModulePass(&ID), OnlyDebugInfo(ODI) {}
46 virtual bool runOnModule(Module &M);
48 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
53 class VISIBILITY_HIDDEN StripNonDebugSymbols : public ModulePass {
55 static char ID; // Pass identification, replacement for typeid
56 explicit StripNonDebugSymbols()
59 virtual bool runOnModule(Module &M);
61 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
66 class VISIBILITY_HIDDEN StripDebugDeclare : public ModulePass {
68 static char ID; // Pass identification, replacement for typeid
69 explicit StripDebugDeclare()
72 virtual bool runOnModule(Module &M);
74 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
80 char StripSymbols::ID = 0;
81 static RegisterPass<StripSymbols>
82 X("strip", "Strip all symbols from a module");
84 ModulePass *llvm::createStripSymbolsPass(bool OnlyDebugInfo) {
85 return new StripSymbols(OnlyDebugInfo);
88 char StripNonDebugSymbols::ID = 0;
89 static RegisterPass<StripNonDebugSymbols>
90 Y("strip-nondebug", "Strip all symbols, except dbg symbols, from a module");
92 ModulePass *llvm::createStripNonDebugSymbolsPass() {
93 return new StripNonDebugSymbols();
96 char StripDebugDeclare::ID = 0;
97 static RegisterPass<StripDebugDeclare>
98 Z("strip-debug-declare", "Strip all llvm.dbg.declare intrinsics");
100 ModulePass *llvm::createStripDebugDeclarePass() {
101 return new StripDebugDeclare();
104 /// OnlyUsedBy - Return true if V is only used by Usr.
105 static bool OnlyUsedBy(Value *V, Value *Usr) {
106 for(Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
114 static void RemoveDeadConstant(Constant *C) {
115 assert(C->use_empty() && "Constant is not dead!");
116 SmallPtrSet<Constant *, 4> Operands;
117 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
118 if (isa<DerivedType>(C->getOperand(i)->getType()) &&
119 OnlyUsedBy(C->getOperand(i), C))
120 Operands.insert(C->getOperand(i));
121 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
122 if (!GV->hasLocalLinkage()) return; // Don't delete non static globals.
123 GV->eraseFromParent();
125 else if (!isa<Function>(C))
126 if (isa<CompositeType>(C->getType()))
127 C->destroyConstant();
129 // If the constant referenced anything, see if we can delete it as well.
130 for (SmallPtrSet<Constant *, 4>::iterator OI = Operands.begin(),
131 OE = Operands.end(); OI != OE; ++OI)
132 RemoveDeadConstant(*OI);
135 // Strip the symbol table of its names.
137 static void StripSymtab(ValueSymbolTable &ST, bool PreserveDbgInfo) {
138 for (ValueSymbolTable::iterator VI = ST.begin(), VE = ST.end(); VI != VE; ) {
139 Value *V = VI->getValue();
141 if (!isa<GlobalValue>(V) || cast<GlobalValue>(V)->hasLocalLinkage()) {
142 if (!PreserveDbgInfo || !V->getName().startswith("llvm.dbg"))
143 // Set name to "", removing from symbol table!
149 // Strip the symbol table of its names.
150 static void StripTypeSymtab(TypeSymbolTable &ST, bool PreserveDbgInfo) {
151 for (TypeSymbolTable::iterator TI = ST.begin(), E = ST.end(); TI != E; ) {
152 if (PreserveDbgInfo && strncmp(TI->first.c_str(), "llvm.dbg", 8) == 0)
159 /// Find values that are marked as llvm.used.
160 static void findUsedValues(GlobalVariable *LLVMUsed,
161 SmallPtrSet<const GlobalValue*, 8> &UsedValues) {
162 if (LLVMUsed == 0) return;
163 UsedValues.insert(LLVMUsed);
165 ConstantArray *Inits = dyn_cast<ConstantArray>(LLVMUsed->getInitializer());
166 if (Inits == 0) return;
168 for (unsigned i = 0, e = Inits->getNumOperands(); i != e; ++i)
169 if (GlobalValue *GV =
170 dyn_cast<GlobalValue>(Inits->getOperand(i)->stripPointerCasts()))
171 UsedValues.insert(GV);
174 /// StripSymbolNames - Strip symbol names.
175 static bool StripSymbolNames(Module &M, bool PreserveDbgInfo) {
177 SmallPtrSet<const GlobalValue*, 8> llvmUsedValues;
178 findUsedValues(M.getGlobalVariable("llvm.used"), llvmUsedValues);
179 findUsedValues(M.getGlobalVariable("llvm.compiler.used"), llvmUsedValues);
181 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
183 if (I->hasLocalLinkage() && llvmUsedValues.count(I) == 0)
184 if (!PreserveDbgInfo || !I->getName().startswith("llvm.dbg"))
185 I->setName(""); // Internal symbols can't participate in linkage
188 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
189 if (I->hasLocalLinkage() && llvmUsedValues.count(I) == 0)
190 if (!PreserveDbgInfo || !I->getName().startswith("llvm.dbg"))
191 I->setName(""); // Internal symbols can't participate in linkage
192 StripSymtab(I->getValueSymbolTable(), PreserveDbgInfo);
195 // Remove all names from types.
196 StripTypeSymtab(M.getTypeSymbolTable(), PreserveDbgInfo);
201 // StripDebugInfo - Strip debug info in the module if it exists.
202 // To do this, we remove llvm.dbg.func.start, llvm.dbg.stoppoint, and
203 // llvm.dbg.region.end calls, and any globals they point to if now dead.
204 static bool StripDebugInfo(Module &M) {
206 SmallPtrSet<const GlobalValue*, 8> llvmUsedValues;
207 findUsedValues(M.getGlobalVariable("llvm.used"), llvmUsedValues);
208 findUsedValues(M.getGlobalVariable("llvm.compiler.used"), llvmUsedValues);
210 DebugInfoFinder DbgFinder;
211 DbgFinder.processModule(M);
213 // These anchors use LinkOnce linkage so that the optimizer does not
214 // remove them accidently. Set InternalLinkage for all these debug
216 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
217 E = DbgFinder.compile_unit_end(); I != E; ++I)
218 (*I)->setLinkage(GlobalValue::InternalLinkage);
219 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
220 E = DbgFinder.global_variable_end(); I != E; ++I)
221 (*I)->setLinkage(GlobalValue::InternalLinkage);
222 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
223 E = DbgFinder.subprogram_end(); I != E; ++I)
224 (*I)->setLinkage(GlobalValue::InternalLinkage);
227 // Delete all dbg variables.
228 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
230 GlobalVariable *GV = dyn_cast<GlobalVariable>(I);
232 if (!GV->use_empty() && llvmUsedValues.count(I) == 0) {
233 if (GV->getName().startswith("llvm.dbg")) {
234 GV->replaceAllUsesWith(UndefValue::get(GV->getType()));
239 Function *FuncStart = M.getFunction("llvm.dbg.func.start");
240 Function *StopPoint = M.getFunction("llvm.dbg.stoppoint");
241 Function *RegionStart = M.getFunction("llvm.dbg.region.start");
242 Function *RegionEnd = M.getFunction("llvm.dbg.region.end");
243 Function *Declare = M.getFunction("llvm.dbg.declare");
245 std::vector<Constant*> DeadConstants;
247 // Remove all of the calls to the debugger intrinsics, and remove them from
250 while (!FuncStart->use_empty()) {
251 CallInst *CI = cast<CallInst>(FuncStart->use_back());
252 Value *Arg = CI->getOperand(1);
253 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
254 CI->eraseFromParent();
255 if (Arg->use_empty())
256 if (Constant *C = dyn_cast<Constant>(Arg))
257 DeadConstants.push_back(C);
259 FuncStart->eraseFromParent();
262 while (!StopPoint->use_empty()) {
263 CallInst *CI = cast<CallInst>(StopPoint->use_back());
264 Value *Arg = CI->getOperand(3);
265 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
266 CI->eraseFromParent();
267 if (Arg->use_empty())
268 if (Constant *C = dyn_cast<Constant>(Arg))
269 DeadConstants.push_back(C);
271 StopPoint->eraseFromParent();
274 while (!RegionStart->use_empty()) {
275 CallInst *CI = cast<CallInst>(RegionStart->use_back());
276 Value *Arg = CI->getOperand(1);
277 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
278 CI->eraseFromParent();
279 if (Arg->use_empty())
280 if (Constant *C = dyn_cast<Constant>(Arg))
281 DeadConstants.push_back(C);
283 RegionStart->eraseFromParent();
286 while (!RegionEnd->use_empty()) {
287 CallInst *CI = cast<CallInst>(RegionEnd->use_back());
288 Value *Arg = CI->getOperand(1);
289 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
290 CI->eraseFromParent();
291 if (Arg->use_empty())
292 if (Constant *C = dyn_cast<Constant>(Arg))
293 DeadConstants.push_back(C);
295 RegionEnd->eraseFromParent();
298 while (!Declare->use_empty()) {
299 CallInst *CI = cast<CallInst>(Declare->use_back());
300 Value *Arg1 = CI->getOperand(1);
301 Value *Arg2 = CI->getOperand(2);
302 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
303 CI->eraseFromParent();
304 if (Arg1->use_empty()) {
305 if (Constant *C = dyn_cast<Constant>(Arg1))
306 DeadConstants.push_back(C);
308 RecursivelyDeleteTriviallyDeadInstructions(Arg1);
310 if (Arg2->use_empty())
311 if (Constant *C = dyn_cast<Constant>(Arg2))
312 DeadConstants.push_back(C);
314 Declare->eraseFromParent();
317 // llvm.dbg.compile_units and llvm.dbg.subprograms are marked as linkonce
318 // but since we are removing all debug information, make them internal now.
319 // FIXME: Use private linkage maybe?
320 if (Constant *C = M.getNamedGlobal("llvm.dbg.compile_units"))
321 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
322 GV->setLinkage(GlobalValue::InternalLinkage);
324 if (Constant *C = M.getNamedGlobal("llvm.dbg.subprograms"))
325 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
326 GV->setLinkage(GlobalValue::InternalLinkage);
328 if (Constant *C = M.getNamedGlobal("llvm.dbg.global_variables"))
329 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
330 GV->setLinkage(GlobalValue::InternalLinkage);
332 // Delete all dbg variables.
333 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
335 GlobalVariable *GV = dyn_cast<GlobalVariable>(I);
337 if (GV->use_empty() && llvmUsedValues.count(I) == 0
338 && (!GV->hasSection()
339 || strcmp(GV->getSection().c_str(), "llvm.metadata") == 0))
340 DeadConstants.push_back(GV);
343 if (DeadConstants.empty())
346 // Delete any internal globals that were only used by the debugger intrinsics.
347 while (!DeadConstants.empty()) {
348 Constant *C = DeadConstants.back();
349 DeadConstants.pop_back();
350 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
351 if (GV->hasLocalLinkage())
352 RemoveDeadConstant(GV);
355 RemoveDeadConstant(C);
358 // Remove all llvm.dbg types.
359 TypeSymbolTable &ST = M.getTypeSymbolTable();
360 for (TypeSymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ) {
361 if (!strncmp(TI->first.c_str(), "llvm.dbg.", 9))
370 bool StripSymbols::runOnModule(Module &M) {
371 bool Changed = false;
372 Changed |= StripDebugInfo(M);
374 Changed |= StripSymbolNames(M, false);
378 bool StripNonDebugSymbols::runOnModule(Module &M) {
379 return StripSymbolNames(M, true);
382 bool StripDebugDeclare::runOnModule(Module &M) {
384 Function *Declare = M.getFunction("llvm.dbg.declare");
385 std::vector<Constant*> DeadConstants;
388 while (!Declare->use_empty()) {
389 CallInst *CI = cast<CallInst>(Declare->use_back());
390 Value *Arg1 = CI->getOperand(1);
391 Value *Arg2 = CI->getOperand(2);
392 assert(CI->use_empty() && "llvm.dbg intrinsic should have void result");
393 CI->eraseFromParent();
394 if (Arg1->use_empty()) {
395 if (Constant *C = dyn_cast<Constant>(Arg1))
396 DeadConstants.push_back(C);
398 RecursivelyDeleteTriviallyDeadInstructions(Arg1);
400 if (Arg2->use_empty())
401 if (Constant *C = dyn_cast<Constant>(Arg2))
402 DeadConstants.push_back(C);
404 Declare->eraseFromParent();
407 // Delete all llvm.dbg.global_variables.
408 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
410 GlobalVariable *GV = dyn_cast<GlobalVariable>(I);
412 if (GV->use_empty() && GV->getName().startswith("llvm.dbg.global_variable"))
413 DeadConstants.push_back(GV);
416 while (!DeadConstants.empty()) {
417 Constant *C = DeadConstants.back();
418 DeadConstants.pop_back();
419 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
420 if (GV->hasLocalLinkage())
421 RemoveDeadConstant(GV);
424 RemoveDeadConstant(C);