1 //===- CrashDebugger.cpp - Debug compilation crashes ----------------------===//
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 bugpoint internals that narrow down compilation crashes
12 //===----------------------------------------------------------------------===//
14 #include "BugDriver.h"
15 #include "ToolRunner.h"
16 #include "ListReducer.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Module.h"
21 #include "llvm/Pass.h"
22 #include "llvm/PassManager.h"
23 #include "llvm/ValueSymbolTable.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/Analysis/Verifier.h"
26 #include "llvm/Support/CFG.h"
27 #include "llvm/Transforms/Scalar.h"
28 #include "llvm/Transforms/Utils/Cloning.h"
29 #include "llvm/Support/FileUtilities.h"
30 #include "llvm/Support/CommandLine.h"
38 cl::desc("Force function reduction to keep main"),
41 NoGlobalRM ("disable-global-remove",
42 cl::desc("Do not remove global variables"),
47 class ReducePassList : public ListReducer<const PassInfo*> {
50 ReducePassList(BugDriver &bd) : BD(bd) {}
52 // doTest - Return true iff running the "removed" passes succeeds, and
53 // running the "Kept" passes fail when run on the output of the "removed"
54 // passes. If we return true, we update the current module of bugpoint.
56 virtual TestResult doTest(std::vector<const PassInfo*> &Removed,
57 std::vector<const PassInfo*> &Kept);
61 ReducePassList::TestResult
62 ReducePassList::doTest(std::vector<const PassInfo*> &Prefix,
63 std::vector<const PassInfo*> &Suffix) {
64 sys::Path PrefixOutput;
65 Module *OrigProgram = 0;
66 if (!Prefix.empty()) {
67 std::cout << "Checking to see if these passes crash: "
68 << getPassesString(Prefix) << ": ";
69 std::string PfxOutput;
70 if (BD.runPasses(Prefix, PfxOutput))
73 PrefixOutput.set(PfxOutput);
74 OrigProgram = BD.Program;
76 BD.Program = ParseInputFile(PrefixOutput.toString(), BD.getContext());
77 if (BD.Program == 0) {
78 std::cerr << BD.getToolName() << ": Error reading bitcode file '"
79 << PrefixOutput << "'!\n";
82 PrefixOutput.eraseFromDisk();
85 std::cout << "Checking to see if these passes crash: "
86 << getPassesString(Suffix) << ": ";
88 if (BD.runPasses(Suffix)) {
89 delete OrigProgram; // The suffix crashes alone...
93 // Nothing failed, restore state...
96 BD.Program = OrigProgram;
102 /// ReduceCrashingGlobalVariables - This works by removing the global
103 /// variable's initializer and seeing if the program still crashes. If it
104 /// does, then we keep that program and try again.
106 class ReduceCrashingGlobalVariables : public ListReducer<GlobalVariable*> {
108 bool (*TestFn)(BugDriver &, Module *);
110 ReduceCrashingGlobalVariables(BugDriver &bd,
111 bool (*testFn)(BugDriver&, Module*))
112 : BD(bd), TestFn(testFn) {}
114 virtual TestResult doTest(std::vector<GlobalVariable*>& Prefix,
115 std::vector<GlobalVariable*>& Kept) {
116 if (!Kept.empty() && TestGlobalVariables(Kept))
119 if (!Prefix.empty() && TestGlobalVariables(Prefix))
125 bool TestGlobalVariables(std::vector<GlobalVariable*>& GVs);
130 ReduceCrashingGlobalVariables::TestGlobalVariables(
131 std::vector<GlobalVariable*>& GVs) {
132 // Clone the program to try hacking it apart...
133 DenseMap<const Value*, Value*> ValueMap;
134 Module *M = CloneModule(BD.getProgram(), ValueMap);
136 // Convert list to set for fast lookup...
137 std::set<GlobalVariable*> GVSet;
139 for (unsigned i = 0, e = GVs.size(); i != e; ++i) {
140 GlobalVariable* CMGV = cast<GlobalVariable>(ValueMap[GVs[i]]);
141 assert(CMGV && "Global Variable not in module?!");
145 std::cout << "Checking for crash with only these global variables: ";
146 PrintGlobalVariableList(GVs);
149 // Loop over and delete any global variables which we aren't supposed to be
151 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
153 if (I->hasInitializer() && !GVSet.count(I)) {
154 I->setInitializer(0);
155 I->setLinkage(GlobalValue::ExternalLinkage);
158 // Try running the hacked up program...
160 BD.setNewProgram(M); // It crashed, keep the trimmed version...
162 // Make sure to use global variable pointers that point into the now-current
164 GVs.assign(GVSet.begin(), GVSet.end());
173 /// ReduceCrashingFunctions reducer - This works by removing functions and
174 /// seeing if the program still crashes. If it does, then keep the newer,
177 class ReduceCrashingFunctions : public ListReducer<Function*> {
179 bool (*TestFn)(BugDriver &, Module *);
181 ReduceCrashingFunctions(BugDriver &bd,
182 bool (*testFn)(BugDriver &, Module *))
183 : BD(bd), TestFn(testFn) {}
185 virtual TestResult doTest(std::vector<Function*> &Prefix,
186 std::vector<Function*> &Kept) {
187 if (!Kept.empty() && TestFuncs(Kept))
189 if (!Prefix.empty() && TestFuncs(Prefix))
194 bool TestFuncs(std::vector<Function*> &Prefix);
198 bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
200 //if main isn't present, claim there is no problem
201 if (KeepMain && find(Funcs.begin(), Funcs.end(),
202 BD.getProgram()->getFunction("main")) == Funcs.end())
205 // Clone the program to try hacking it apart...
206 DenseMap<const Value*, Value*> ValueMap;
207 Module *M = CloneModule(BD.getProgram(), ValueMap);
209 // Convert list to set for fast lookup...
210 std::set<Function*> Functions;
211 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
212 Function *CMF = cast<Function>(ValueMap[Funcs[i]]);
213 assert(CMF && "Function not in module?!");
214 assert(CMF->getFunctionType() == Funcs[i]->getFunctionType() && "wrong ty");
215 assert(CMF->getName() == Funcs[i]->getName() && "wrong name");
216 Functions.insert(CMF);
219 std::cout << "Checking for crash with only these functions: ";
220 PrintFunctionList(Funcs);
223 // Loop over and delete any functions which we aren't supposed to be playing
225 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
226 if (!I->isDeclaration() && !Functions.count(I))
227 DeleteFunctionBody(I);
229 // Try running the hacked up program...
231 BD.setNewProgram(M); // It crashed, keep the trimmed version...
233 // Make sure to use function pointers that point into the now-current
235 Funcs.assign(Functions.begin(), Functions.end());
244 /// ReduceCrashingBlocks reducer - This works by setting the terminators of
245 /// all terminators except the specified basic blocks to a 'ret' instruction,
246 /// then running the simplify-cfg pass. This has the effect of chopping up
247 /// the CFG really fast which can reduce large functions quickly.
249 class ReduceCrashingBlocks : public ListReducer<const BasicBlock*> {
251 bool (*TestFn)(BugDriver &, Module *);
253 ReduceCrashingBlocks(BugDriver &bd, bool (*testFn)(BugDriver &, Module *))
254 : BD(bd), TestFn(testFn) {}
256 virtual TestResult doTest(std::vector<const BasicBlock*> &Prefix,
257 std::vector<const BasicBlock*> &Kept) {
258 if (!Kept.empty() && TestBlocks(Kept))
260 if (!Prefix.empty() && TestBlocks(Prefix))
265 bool TestBlocks(std::vector<const BasicBlock*> &Prefix);
269 bool ReduceCrashingBlocks::TestBlocks(std::vector<const BasicBlock*> &BBs) {
270 // Clone the program to try hacking it apart...
271 DenseMap<const Value*, Value*> ValueMap;
272 Module *M = CloneModule(BD.getProgram(), ValueMap);
274 // Convert list to set for fast lookup...
275 SmallPtrSet<BasicBlock*, 8> Blocks;
276 for (unsigned i = 0, e = BBs.size(); i != e; ++i)
277 Blocks.insert(cast<BasicBlock>(ValueMap[BBs[i]]));
279 std::cout << "Checking for crash with only these blocks:";
280 unsigned NumPrint = Blocks.size();
281 if (NumPrint > 10) NumPrint = 10;
282 for (unsigned i = 0, e = NumPrint; i != e; ++i)
283 std::cout << " " << BBs[i]->getName();
284 if (NumPrint < Blocks.size())
285 std::cout << "... <" << Blocks.size() << " total>";
288 // Loop over and delete any hack up any blocks that are not listed...
289 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
290 for (Function::iterator BB = I->begin(), E = I->end(); BB != E; ++BB)
291 if (!Blocks.count(BB) && BB->getTerminator()->getNumSuccessors()) {
292 // Loop over all of the successors of this block, deleting any PHI nodes
293 // that might include it.
294 for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
295 (*SI)->removePredecessor(BB);
297 TerminatorInst *BBTerm = BB->getTerminator();
299 if (isa<StructType>(BBTerm->getType()))
300 BBTerm->replaceAllUsesWith(UndefValue::get(BBTerm->getType()));
301 else if (BB->getTerminator()->getType() != Type::VoidTy)
302 BBTerm->replaceAllUsesWith(
303 BD.getContext().getNullValue(BBTerm->getType()));
305 // Replace the old terminator instruction.
306 BB->getInstList().pop_back();
307 new UnreachableInst(BB);
310 // The CFG Simplifier pass may delete one of the basic blocks we are
311 // interested in. If it does we need to take the block out of the list. Make
312 // a "persistent mapping" by turning basic blocks into <function, name> pairs.
313 // This won't work well if blocks are unnamed, but that is just the risk we
315 std::vector<std::pair<Function*, std::string> > BlockInfo;
317 for (SmallPtrSet<BasicBlock*, 8>::iterator I = Blocks.begin(),
318 E = Blocks.end(); I != E; ++I)
319 BlockInfo.push_back(std::make_pair((*I)->getParent(), (*I)->getName()));
321 // Now run the CFG simplify pass on the function...
323 Passes.add(createCFGSimplificationPass());
324 Passes.add(createVerifierPass());
327 // Try running on the hacked up program...
329 BD.setNewProgram(M); // It crashed, keep the trimmed version...
331 // Make sure to use basic block pointers that point into the now-current
332 // module, and that they don't include any deleted blocks.
334 for (unsigned i = 0, e = BlockInfo.size(); i != e; ++i) {
335 ValueSymbolTable &ST = BlockInfo[i].first->getValueSymbolTable();
336 Value* V = ST.lookup(BlockInfo[i].second);
337 if (V && V->getType() == Type::LabelTy)
338 BBs.push_back(cast<BasicBlock>(V));
342 delete M; // It didn't crash, try something else.
347 /// ReduceCrashingInstructions reducer - This works by removing the specified
348 /// non-terminator instructions and replacing them with undef.
350 class ReduceCrashingInstructions : public ListReducer<const Instruction*> {
352 bool (*TestFn)(BugDriver &, Module *);
354 ReduceCrashingInstructions(BugDriver &bd, bool (*testFn)(BugDriver &,
356 : BD(bd), TestFn(testFn) {}
358 virtual TestResult doTest(std::vector<const Instruction*> &Prefix,
359 std::vector<const Instruction*> &Kept) {
360 if (!Kept.empty() && TestInsts(Kept))
362 if (!Prefix.empty() && TestInsts(Prefix))
367 bool TestInsts(std::vector<const Instruction*> &Prefix);
371 bool ReduceCrashingInstructions::TestInsts(std::vector<const Instruction*>
373 // Clone the program to try hacking it apart...
374 DenseMap<const Value*, Value*> ValueMap;
375 Module *M = CloneModule(BD.getProgram(), ValueMap);
377 // Convert list to set for fast lookup...
378 SmallPtrSet<Instruction*, 64> Instructions;
379 for (unsigned i = 0, e = Insts.size(); i != e; ++i) {
380 assert(!isa<TerminatorInst>(Insts[i]));
381 Instructions.insert(cast<Instruction>(ValueMap[Insts[i]]));
384 std::cout << "Checking for crash with only " << Instructions.size();
385 if (Instructions.size() == 1)
386 std::cout << " instruction: ";
388 std::cout << " instructions: ";
390 for (Module::iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI)
391 for (Function::iterator FI = MI->begin(), FE = MI->end(); FI != FE; ++FI)
392 for (BasicBlock::iterator I = FI->begin(), E = FI->end(); I != E;) {
393 Instruction *Inst = I++;
394 if (!Instructions.count(Inst) && !isa<TerminatorInst>(Inst)) {
395 if (Inst->getType() != Type::VoidTy)
396 Inst->replaceAllUsesWith(UndefValue::get(Inst->getType()));
397 Inst->eraseFromParent();
401 // Verify that this is still valid.
403 Passes.add(createVerifierPass());
406 // Try running on the hacked up program...
408 BD.setNewProgram(M); // It crashed, keep the trimmed version...
410 // Make sure to use instruction pointers that point into the now-current
411 // module, and that they don't include any deleted blocks.
413 for (SmallPtrSet<Instruction*, 64>::const_iterator I = Instructions.begin(),
414 E = Instructions.end(); I != E; ++I)
418 delete M; // It didn't crash, try something else.
422 /// DebugACrash - Given a predicate that determines whether a component crashes
423 /// on a program, try to destructively reduce the program while still keeping
424 /// the predicate true.
425 static bool DebugACrash(BugDriver &BD, bool (*TestFn)(BugDriver &, Module *)) {
426 // See if we can get away with nuking some of the global variable initializers
429 BD.getProgram()->global_begin() != BD.getProgram()->global_end()) {
430 // Now try to reduce the number of global variable initializers in the
431 // module to something small.
432 Module *M = CloneModule(BD.getProgram());
433 bool DeletedInit = false;
435 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
437 if (I->hasInitializer()) {
438 I->setInitializer(0);
439 I->setLinkage(GlobalValue::ExternalLinkage);
444 delete M; // No change made...
446 // See if the program still causes a crash...
447 std::cout << "\nChecking to see if we can delete global inits: ";
449 if (TestFn(BD, M)) { // Still crashes?
451 std::cout << "\n*** Able to remove all global initializers!\n";
452 } else { // No longer crashes?
453 std::cout << " - Removing all global inits hides problem!\n";
456 std::vector<GlobalVariable*> GVs;
458 for (Module::global_iterator I = BD.getProgram()->global_begin(),
459 E = BD.getProgram()->global_end(); I != E; ++I)
460 if (I->hasInitializer())
463 if (GVs.size() > 1 && !BugpointIsInterrupted) {
464 std::cout << "\n*** Attempting to reduce the number of global "
465 << "variables in the testcase\n";
467 unsigned OldSize = GVs.size();
468 ReduceCrashingGlobalVariables(BD, TestFn).reduceList(GVs);
470 if (GVs.size() < OldSize)
471 BD.EmitProgressBitcode("reduced-global-variables");
477 // Now try to reduce the number of functions in the module to something small.
478 std::vector<Function*> Functions;
479 for (Module::iterator I = BD.getProgram()->begin(),
480 E = BD.getProgram()->end(); I != E; ++I)
481 if (!I->isDeclaration())
482 Functions.push_back(I);
484 if (Functions.size() > 1 && !BugpointIsInterrupted) {
485 std::cout << "\n*** Attempting to reduce the number of functions "
488 unsigned OldSize = Functions.size();
489 ReduceCrashingFunctions(BD, TestFn).reduceList(Functions);
491 if (Functions.size() < OldSize)
492 BD.EmitProgressBitcode("reduced-function");
495 // Attempt to delete entire basic blocks at a time to speed up
496 // convergence... this actually works by setting the terminator of the blocks
497 // to a return instruction then running simplifycfg, which can potentially
498 // shrinks the code dramatically quickly
500 if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
501 std::vector<const BasicBlock*> Blocks;
502 for (Module::const_iterator I = BD.getProgram()->begin(),
503 E = BD.getProgram()->end(); I != E; ++I)
504 for (Function::const_iterator FI = I->begin(), E = I->end(); FI !=E; ++FI)
505 Blocks.push_back(FI);
506 unsigned OldSize = Blocks.size();
507 ReduceCrashingBlocks(BD, TestFn).reduceList(Blocks);
508 if (Blocks.size() < OldSize)
509 BD.EmitProgressBitcode("reduced-blocks");
512 // Attempt to delete instructions using bisection. This should help out nasty
513 // cases with large basic blocks where the problem is at one end.
514 if (!BugpointIsInterrupted) {
515 std::vector<const Instruction*> Insts;
516 for (Module::const_iterator MI = BD.getProgram()->begin(),
517 ME = BD.getProgram()->end(); MI != ME; ++MI)
518 for (Function::const_iterator FI = MI->begin(), FE = MI->end(); FI != FE;
520 for (BasicBlock::const_iterator I = FI->begin(), E = FI->end();
522 if (!isa<TerminatorInst>(I))
525 ReduceCrashingInstructions(BD, TestFn).reduceList(Insts);
528 // FIXME: This should use the list reducer to converge faster by deleting
529 // larger chunks of instructions at a time!
530 unsigned Simplification = 2;
532 if (BugpointIsInterrupted) break;
534 std::cout << "\n*** Attempting to reduce testcase by deleting instruc"
535 << "tions: Simplification Level #" << Simplification << '\n';
537 // Now that we have deleted the functions that are unnecessary for the
538 // program, try to remove instructions that are not necessary to cause the
539 // crash. To do this, we loop through all of the instructions in the
540 // remaining functions, deleting them (replacing any values produced with
541 // nulls), and then running ADCE and SimplifyCFG. If the transformed input
542 // still triggers failure, keep deleting until we cannot trigger failure
545 unsigned InstructionsToSkipBeforeDeleting = 0;
548 // Loop over all of the (non-terminator) instructions remaining in the
549 // function, attempting to delete them.
550 unsigned CurInstructionNum = 0;
551 for (Module::const_iterator FI = BD.getProgram()->begin(),
552 E = BD.getProgram()->end(); FI != E; ++FI)
553 if (!FI->isDeclaration())
554 for (Function::const_iterator BI = FI->begin(), E = FI->end(); BI != E;
556 for (BasicBlock::const_iterator I = BI->begin(), E = --BI->end();
557 I != E; ++I, ++CurInstructionNum)
558 if (InstructionsToSkipBeforeDeleting) {
559 --InstructionsToSkipBeforeDeleting;
561 if (BugpointIsInterrupted) goto ExitLoops;
563 std::cout << "Checking instruction: " << *I;
564 Module *M = BD.deleteInstructionFromProgram(I, Simplification);
566 // Find out if the pass still crashes on this pass...
568 // Yup, it does, we delete the old module, and continue trying
569 // to reduce the testcase...
571 InstructionsToSkipBeforeDeleting = CurInstructionNum;
572 goto TryAgain; // I wish I had a multi-level break here!
575 // This pass didn't crash without this instruction, try the next
580 if (InstructionsToSkipBeforeDeleting) {
581 InstructionsToSkipBeforeDeleting = 0;
585 } while (Simplification);
588 // Try to clean up the testcase by running funcresolve and globaldce...
589 if (!BugpointIsInterrupted) {
590 std::cout << "\n*** Attempting to perform final cleanups: ";
591 Module *M = CloneModule(BD.getProgram());
592 M = BD.performFinalCleanups(M, true);
594 // Find out if the pass still crashes on the cleaned up program...
596 BD.setNewProgram(M); // Yup, it does, keep the reduced version...
602 BD.EmitProgressBitcode("reduced-simplified");
607 static bool TestForOptimizerCrash(BugDriver &BD, Module *M) {
608 return BD.runPasses(M);
611 /// debugOptimizerCrash - This method is called when some pass crashes on input.
612 /// It attempts to prune down the testcase to something reasonable, and figure
613 /// out exactly which pass is crashing.
615 bool BugDriver::debugOptimizerCrash(const std::string &ID) {
616 std::cout << "\n*** Debugging optimizer crash!\n";
618 // Reduce the list of passes which causes the optimizer to crash...
619 if (!BugpointIsInterrupted)
620 ReducePassList(*this).reduceList(PassesToRun);
622 std::cout << "\n*** Found crashing pass"
623 << (PassesToRun.size() == 1 ? ": " : "es: ")
624 << getPassesString(PassesToRun) << '\n';
626 EmitProgressBitcode(ID);
628 return DebugACrash(*this, TestForOptimizerCrash);
631 static bool TestForCodeGenCrash(BugDriver &BD, Module *M) {
633 BD.compileProgram(M);
636 } catch (ToolExecutionError &) {
637 std::cerr << "<crash>\n";
638 return true; // Tool is still crashing.
642 /// debugCodeGeneratorCrash - This method is called when the code generator
643 /// crashes on an input. It attempts to reduce the input as much as possible
644 /// while still causing the code generator to crash.
645 bool BugDriver::debugCodeGeneratorCrash() {
646 std::cerr << "*** Debugging code generator crash!\n";
648 return DebugACrash(*this, TestForCodeGenCrash);