1 //===- CrashDebugger.cpp - Debug compilation crashes ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/Constant.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/Analysis/Verifier.h"
25 #include "llvm/Support/CFG.h"
26 #include "llvm/Transforms/Scalar.h"
27 #include "llvm/Transforms/Utils/Cloning.h"
28 #include "llvm/Support/FileUtilities.h"
29 #include "llvm/Support/CommandLine.h"
37 cl::desc("Force function reduction to keep main"),
42 class ReducePassList : public ListReducer<const PassInfo*> {
45 ReducePassList(BugDriver &bd) : BD(bd) {}
47 // doTest - Return true iff running the "removed" passes succeeds, and
48 // running the "Kept" passes fail when run on the output of the "removed"
49 // passes. If we return true, we update the current module of bugpoint.
51 virtual TestResult doTest(std::vector<const PassInfo*> &Removed,
52 std::vector<const PassInfo*> &Kept);
56 ReducePassList::TestResult
57 ReducePassList::doTest(std::vector<const PassInfo*> &Prefix,
58 std::vector<const PassInfo*> &Suffix) {
59 sys::Path PrefixOutput;
60 Module *OrigProgram = 0;
61 if (!Prefix.empty()) {
62 std::cout << "Checking to see if these passes crash: "
63 << getPassesString(Prefix) << ": ";
64 std::string PfxOutput;
65 if (BD.runPasses(Prefix, PfxOutput))
68 PrefixOutput.set(PfxOutput);
69 OrigProgram = BD.Program;
71 BD.Program = ParseInputFile(PrefixOutput.toString());
72 if (BD.Program == 0) {
73 std::cerr << BD.getToolName() << ": Error reading bytecode file '"
74 << PrefixOutput << "'!\n";
77 PrefixOutput.eraseFromDisk();
80 std::cout << "Checking to see if these passes crash: "
81 << getPassesString(Suffix) << ": ";
83 if (BD.runPasses(Suffix)) {
84 delete OrigProgram; // The suffix crashes alone...
88 // Nothing failed, restore state...
91 BD.Program = OrigProgram;
97 /// ReduceCrashingGlobalVariables - This works by removing the global
98 /// variable's initializer and seeing if the program still crashes. If it
99 /// does, then we keep that program and try again.
101 class ReduceCrashingGlobalVariables : public ListReducer<GlobalVariable*> {
103 bool (*TestFn)(BugDriver &, Module *);
105 ReduceCrashingGlobalVariables(BugDriver &bd,
106 bool (*testFn)(BugDriver&, Module*))
107 : BD(bd), TestFn(testFn) {}
109 virtual TestResult doTest(std::vector<GlobalVariable*>& Prefix,
110 std::vector<GlobalVariable*>& Kept) {
111 if (!Kept.empty() && TestGlobalVariables(Kept))
114 if (!Prefix.empty() && TestGlobalVariables(Prefix))
120 bool TestGlobalVariables(std::vector<GlobalVariable*>& GVs);
125 ReduceCrashingGlobalVariables::TestGlobalVariables(
126 std::vector<GlobalVariable*>& GVs) {
127 // Clone the program to try hacking it apart...
128 Module *M = CloneModule(BD.getProgram());
130 // Convert list to set for fast lookup...
131 std::set<GlobalVariable*> GVSet;
133 for (unsigned i = 0, e = GVs.size(); i != e; ++i) {
134 GlobalVariable* CMGV = M->getNamedGlobal(GVs[i]->getName());
135 assert(CMGV && "Global Variable not in module?!");
139 std::cout << "Checking for crash with only these global variables: ";
140 PrintGlobalVariableList(GVs);
143 // Loop over and delete any global variables which we aren't supposed to be
145 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
147 if (I->hasInitializer()) {
148 I->setInitializer(0);
149 I->setLinkage(GlobalValue::ExternalLinkage);
152 // Try running the hacked up program...
154 BD.setNewProgram(M); // It crashed, keep the trimmed version...
156 // Make sure to use global variable pointers that point into the now-current
158 GVs.assign(GVSet.begin(), GVSet.end());
167 /// ReduceCrashingFunctions reducer - This works by removing functions and
168 /// seeing if the program still crashes. If it does, then keep the newer,
171 class ReduceCrashingFunctions : public ListReducer<Function*> {
173 bool (*TestFn)(BugDriver &, Module *);
175 ReduceCrashingFunctions(BugDriver &bd,
176 bool (*testFn)(BugDriver &, Module *))
177 : BD(bd), TestFn(testFn) {}
179 virtual TestResult doTest(std::vector<Function*> &Prefix,
180 std::vector<Function*> &Kept) {
181 if (!Kept.empty() && TestFuncs(Kept))
183 if (!Prefix.empty() && TestFuncs(Prefix))
188 bool TestFuncs(std::vector<Function*> &Prefix);
192 bool ReduceCrashingFunctions::TestFuncs(std::vector<Function*> &Funcs) {
194 //if main isn't present, claim there is no problem
195 if (KeepMain && find(Funcs.begin(), Funcs.end(),
196 BD.getProgram()->getFunction("main")) == Funcs.end())
199 // Clone the program to try hacking it apart...
200 Module *M = CloneModule(BD.getProgram());
202 // Convert list to set for fast lookup...
203 std::set<Function*> Functions;
204 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
205 // FIXME: bugpoint should add names to all stripped symbols.
206 assert(!Funcs[i]->getName().empty() &&
207 "Bugpoint doesn't work on stripped modules yet PR718!");
208 Function *CMF = M->getFunction(Funcs[i]->getName());
209 assert(CMF && "Function not in module?!");
210 assert(CMF->getFunctionType() == Funcs[i]->getFunctionType() && "wrong ty");
211 Functions.insert(CMF);
214 std::cout << "Checking for crash with only these functions: ";
215 PrintFunctionList(Funcs);
218 // Loop over and delete any functions which we aren't supposed to be playing
220 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
221 if (!I->isDeclaration() && !Functions.count(I))
222 DeleteFunctionBody(I);
224 // Try running the hacked up program...
226 BD.setNewProgram(M); // It crashed, keep the trimmed version...
228 // Make sure to use function pointers that point into the now-current
230 Funcs.assign(Functions.begin(), Functions.end());
239 /// ReduceCrashingBlocks reducer - This works by setting the terminators of
240 /// all terminators except the specified basic blocks to a 'ret' instruction,
241 /// then running the simplify-cfg pass. This has the effect of chopping up
242 /// the CFG really fast which can reduce large functions quickly.
244 class ReduceCrashingBlocks : public ListReducer<const BasicBlock*> {
246 bool (*TestFn)(BugDriver &, Module *);
248 ReduceCrashingBlocks(BugDriver &bd, bool (*testFn)(BugDriver &, Module *))
249 : BD(bd), TestFn(testFn) {}
251 virtual TestResult doTest(std::vector<const BasicBlock*> &Prefix,
252 std::vector<const BasicBlock*> &Kept) {
253 if (!Kept.empty() && TestBlocks(Kept))
255 if (!Prefix.empty() && TestBlocks(Prefix))
260 bool TestBlocks(std::vector<const BasicBlock*> &Prefix);
264 bool ReduceCrashingBlocks::TestBlocks(std::vector<const BasicBlock*> &BBs) {
265 // Clone the program to try hacking it apart...
266 Module *M = CloneModule(BD.getProgram());
268 // Convert list to set for fast lookup...
269 std::set<BasicBlock*> Blocks;
270 for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
271 // Convert the basic block from the original module to the new module...
272 const Function *F = BBs[i]->getParent();
273 Function *CMF = M->getFunction(F->getName());
274 assert(CMF && "Function not in module?!");
275 assert(CMF->getFunctionType() == F->getFunctionType() && "wrong type?");
277 // Get the mapped basic block...
278 Function::iterator CBI = CMF->begin();
279 std::advance(CBI, std::distance(F->begin(),
280 Function::const_iterator(BBs[i])));
284 std::cout << "Checking for crash with only these blocks:";
285 unsigned NumPrint = Blocks.size();
286 if (NumPrint > 10) NumPrint = 10;
287 for (unsigned i = 0, e = NumPrint; i != e; ++i)
288 std::cout << " " << BBs[i]->getName();
289 if (NumPrint < Blocks.size())
290 std::cout << "... <" << Blocks.size() << " total>";
293 // Loop over and delete any hack up any blocks that are not listed...
294 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
295 for (Function::iterator BB = I->begin(), E = I->end(); BB != E; ++BB)
296 if (!Blocks.count(BB) && BB->getTerminator()->getNumSuccessors()) {
297 // Loop over all of the successors of this block, deleting any PHI nodes
298 // that might include it.
299 for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
300 (*SI)->removePredecessor(BB);
302 if (BB->getTerminator()->getType() != Type::VoidTy)
303 BB->getTerminator()->replaceAllUsesWith(
304 Constant::getNullValue(BB->getTerminator()->getType()));
306 // Delete the old terminator instruction...
307 BB->getInstList().pop_back();
309 // Add a new return instruction of the appropriate type...
310 const Type *RetTy = BB->getParent()->getReturnType();
311 new ReturnInst(RetTy == Type::VoidTy ? 0 :
312 Constant::getNullValue(RetTy), BB);
315 // The CFG Simplifier pass may delete one of the basic blocks we are
316 // interested in. If it does we need to take the block out of the list. Make
317 // a "persistent mapping" by turning basic blocks into <function, name> pairs.
318 // This won't work well if blocks are unnamed, but that is just the risk we
320 std::vector<std::pair<Function*, std::string> > BlockInfo;
322 for (std::set<BasicBlock*>::iterator I = Blocks.begin(), E = Blocks.end();
324 BlockInfo.push_back(std::make_pair((*I)->getParent(), (*I)->getName()));
326 // Now run the CFG simplify pass on the function...
328 Passes.add(createCFGSimplificationPass());
329 Passes.add(createVerifierPass());
332 // Try running on the hacked up program...
334 BD.setNewProgram(M); // It crashed, keep the trimmed version...
336 // Make sure to use basic block pointers that point into the now-current
337 // module, and that they don't include any deleted blocks.
339 for (unsigned i = 0, e = BlockInfo.size(); i != e; ++i) {
340 ValueSymbolTable &ST = BlockInfo[i].first->getValueSymbolTable();
341 Value* V = ST.lookup(BlockInfo[i].second);
342 if (V && V->getType() == Type::LabelTy)
343 BBs.push_back(cast<BasicBlock>(V));
347 delete M; // It didn't crash, try something else.
351 /// DebugACrash - Given a predicate that determines whether a component crashes
352 /// on a program, try to destructively reduce the program while still keeping
353 /// the predicate true.
354 static bool DebugACrash(BugDriver &BD, bool (*TestFn)(BugDriver &, Module *)) {
355 // See if we can get away with nuking some of the global variable initializers
357 if (BD.getProgram()->global_begin() != BD.getProgram()->global_end()) {
358 // Now try to reduce the number of global variable initializers in the
359 // module to something small.
360 Module *M = CloneModule(BD.getProgram());
361 bool DeletedInit = false;
363 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
365 if (I->hasInitializer()) {
366 I->setInitializer(0);
367 I->setLinkage(GlobalValue::ExternalLinkage);
372 delete M; // No change made...
374 // See if the program still causes a crash...
375 std::cout << "\nChecking to see if we can delete global inits: ";
377 if (TestFn(BD, M)) { // Still crashes?
379 std::cout << "\n*** Able to remove all global initializers!\n";
380 } else { // No longer crashes?
381 std::cout << " - Removing all global inits hides problem!\n";
384 std::vector<GlobalVariable*> GVs;
386 for (Module::global_iterator I = BD.getProgram()->global_begin(),
387 E = BD.getProgram()->global_end(); I != E; ++I)
388 if (I->hasInitializer())
391 if (GVs.size() > 1 && !BugpointIsInterrupted) {
392 std::cout << "\n*** Attempting to reduce the number of global "
393 << "variables in the testcase\n";
395 unsigned OldSize = GVs.size();
396 ReduceCrashingGlobalVariables(BD, TestFn).reduceList(GVs);
398 if (GVs.size() < OldSize)
399 BD.EmitProgressBytecode("reduced-global-variables");
405 // Now try to reduce the number of functions in the module to something small.
406 std::vector<Function*> Functions;
407 for (Module::iterator I = BD.getProgram()->begin(),
408 E = BD.getProgram()->end(); I != E; ++I)
409 if (!I->isDeclaration())
410 Functions.push_back(I);
412 if (Functions.size() > 1 && !BugpointIsInterrupted) {
413 std::cout << "\n*** Attempting to reduce the number of functions "
416 unsigned OldSize = Functions.size();
417 ReduceCrashingFunctions(BD, TestFn).reduceList(Functions);
419 if (Functions.size() < OldSize)
420 BD.EmitProgressBytecode("reduced-function");
423 // Attempt to delete entire basic blocks at a time to speed up
424 // convergence... this actually works by setting the terminator of the blocks
425 // to a return instruction then running simplifycfg, which can potentially
426 // shrinks the code dramatically quickly
428 if (!DisableSimplifyCFG && !BugpointIsInterrupted) {
429 std::vector<const BasicBlock*> Blocks;
430 for (Module::const_iterator I = BD.getProgram()->begin(),
431 E = BD.getProgram()->end(); I != E; ++I)
432 for (Function::const_iterator FI = I->begin(), E = I->end(); FI !=E; ++FI)
433 Blocks.push_back(FI);
434 ReduceCrashingBlocks(BD, TestFn).reduceList(Blocks);
437 // FIXME: This should use the list reducer to converge faster by deleting
438 // larger chunks of instructions at a time!
439 unsigned Simplification = 2;
441 if (BugpointIsInterrupted) break;
443 std::cout << "\n*** Attempting to reduce testcase by deleting instruc"
444 << "tions: Simplification Level #" << Simplification << '\n';
446 // Now that we have deleted the functions that are unnecessary for the
447 // program, try to remove instructions that are not necessary to cause the
448 // crash. To do this, we loop through all of the instructions in the
449 // remaining functions, deleting them (replacing any values produced with
450 // nulls), and then running ADCE and SimplifyCFG. If the transformed input
451 // still triggers failure, keep deleting until we cannot trigger failure
454 unsigned InstructionsToSkipBeforeDeleting = 0;
457 // Loop over all of the (non-terminator) instructions remaining in the
458 // function, attempting to delete them.
459 unsigned CurInstructionNum = 0;
460 for (Module::const_iterator FI = BD.getProgram()->begin(),
461 E = BD.getProgram()->end(); FI != E; ++FI)
462 if (!FI->isDeclaration())
463 for (Function::const_iterator BI = FI->begin(), E = FI->end(); BI != E;
465 for (BasicBlock::const_iterator I = BI->begin(), E = --BI->end();
466 I != E; ++I, ++CurInstructionNum)
467 if (InstructionsToSkipBeforeDeleting) {
468 --InstructionsToSkipBeforeDeleting;
470 if (BugpointIsInterrupted) goto ExitLoops;
472 std::cout << "Checking instruction '" << I->getName() << "': ";
473 Module *M = BD.deleteInstructionFromProgram(I, Simplification);
475 // Find out if the pass still crashes on this pass...
477 // Yup, it does, we delete the old module, and continue trying
478 // to reduce the testcase...
480 InstructionsToSkipBeforeDeleting = CurInstructionNum;
481 goto TryAgain; // I wish I had a multi-level break here!
484 // This pass didn't crash without this instruction, try the next
489 if (InstructionsToSkipBeforeDeleting) {
490 InstructionsToSkipBeforeDeleting = 0;
494 } while (Simplification);
497 // Try to clean up the testcase by running funcresolve and globaldce...
498 if (!BugpointIsInterrupted) {
499 std::cout << "\n*** Attempting to perform final cleanups: ";
500 Module *M = CloneModule(BD.getProgram());
501 M = BD.performFinalCleanups(M, true);
503 // Find out if the pass still crashes on the cleaned up program...
505 BD.setNewProgram(M); // Yup, it does, keep the reduced version...
511 BD.EmitProgressBytecode("reduced-simplified");
516 static bool TestForOptimizerCrash(BugDriver &BD, Module *M) {
517 return BD.runPasses(M);
520 /// debugOptimizerCrash - This method is called when some pass crashes on input.
521 /// It attempts to prune down the testcase to something reasonable, and figure
522 /// out exactly which pass is crashing.
524 bool BugDriver::debugOptimizerCrash(const std::string &ID) {
525 std::cout << "\n*** Debugging optimizer crash!\n";
527 // Reduce the list of passes which causes the optimizer to crash...
528 if (!BugpointIsInterrupted)
529 ReducePassList(*this).reduceList(PassesToRun);
531 std::cout << "\n*** Found crashing pass"
532 << (PassesToRun.size() == 1 ? ": " : "es: ")
533 << getPassesString(PassesToRun) << '\n';
535 EmitProgressBytecode(ID);
537 return DebugACrash(*this, TestForOptimizerCrash);
540 static bool TestForCodeGenCrash(BugDriver &BD, Module *M) {
543 BD.compileProgram(M);
546 } catch (ToolExecutionError &) {
547 std::cerr << "<crash>\n";
548 return true; // Tool is still crashing.
552 /// debugCodeGeneratorCrash - This method is called when the code generator
553 /// crashes on an input. It attempts to reduce the input as much as possible
554 /// while still causing the code generator to crash.
555 bool BugDriver::debugCodeGeneratorCrash() {
556 std::cerr << "*** Debugging code generator crash!\n";
558 return DebugACrash(*this, TestForCodeGenCrash);