1 //===- Miscompilation.cpp - Debug program miscompilations -----------------===//
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 implements optimizer and code generation miscompilation debugging
13 //===----------------------------------------------------------------------===//
15 #include "BugDriver.h"
16 #include "ListReducer.h"
17 #include "ToolRunner.h"
18 #include "llvm/Config/config.h" // for HAVE_LINK_R
19 #include "llvm/IR/Constants.h"
20 #include "llvm/IR/DerivedTypes.h"
21 #include "llvm/IR/DiagnosticPrinter.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/Module.h"
24 #include "llvm/IR/Verifier.h"
25 #include "llvm/Linker/Linker.h"
26 #include "llvm/Pass.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/FileUtilities.h"
29 #include "llvm/Transforms/Utils/Cloning.h"
33 extern cl::opt<std::string> OutputPrefix;
34 extern cl::list<std::string> InputArgv;
38 static llvm::cl::opt<bool>
39 DisableLoopExtraction("disable-loop-extraction",
40 cl::desc("Don't extract loops when searching for miscompilations"),
42 static llvm::cl::opt<bool>
43 DisableBlockExtraction("disable-block-extraction",
44 cl::desc("Don't extract blocks when searching for miscompilations"),
47 class ReduceMiscompilingPasses : public ListReducer<std::string> {
50 ReduceMiscompilingPasses(BugDriver &bd) : BD(bd) {}
52 TestResult doTest(std::vector<std::string> &Prefix,
53 std::vector<std::string> &Suffix,
54 std::string &Error) override;
58 /// TestResult - After passes have been split into a test group and a control
59 /// group, see if they still break the program.
61 ReduceMiscompilingPasses::TestResult
62 ReduceMiscompilingPasses::doTest(std::vector<std::string> &Prefix,
63 std::vector<std::string> &Suffix,
65 // First, run the program with just the Suffix passes. If it is still broken
66 // with JUST the kept passes, discard the prefix passes.
67 outs() << "Checking to see if '" << getPassesString(Suffix)
68 << "' compiles correctly: ";
70 std::string BitcodeResult;
71 if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
73 errs() << " Error running this sequence of passes"
74 << " on the input program!\n";
75 BD.setPassesToRun(Suffix);
76 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
77 exit(BD.debugOptimizerCrash());
80 // Check to see if the finished program matches the reference output...
81 bool Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
82 true /*delete bitcode*/, &Error);
88 errs() << BD.getToolName() << ": I'm confused: the test fails when "
89 << "no passes are run, nondeterministic program?\n";
92 return KeepSuffix; // Miscompilation detected!
94 outs() << " yup.\n"; // No miscompilation!
96 if (Prefix.empty()) return NoFailure;
98 // Next, see if the program is broken if we run the "prefix" passes first,
99 // then separately run the "kept" passes.
100 outs() << "Checking to see if '" << getPassesString(Prefix)
101 << "' compiles correctly: ";
103 // If it is not broken with the kept passes, it's possible that the prefix
104 // passes must be run before the kept passes to break it. If the program
105 // WORKS after the prefix passes, but then fails if running the prefix AND
106 // kept passes, we can update our bitcode file to include the result of the
107 // prefix passes, then discard the prefix passes.
109 if (BD.runPasses(BD.getProgram(), Prefix, BitcodeResult, false/*delete*/,
111 errs() << " Error running this sequence of passes"
112 << " on the input program!\n";
113 BD.setPassesToRun(Prefix);
114 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
115 exit(BD.debugOptimizerCrash());
118 // If the prefix maintains the predicate by itself, only keep the prefix!
119 Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "", false, &Error);
121 return InternalError;
123 outs() << " nope.\n";
124 sys::fs::remove(BitcodeResult);
127 outs() << " yup.\n"; // No miscompilation!
129 // Ok, so now we know that the prefix passes work, try running the suffix
130 // passes on the result of the prefix passes.
132 std::unique_ptr<Module> PrefixOutput =
133 parseInputFile(BitcodeResult, BD.getContext());
135 errs() << BD.getToolName() << ": Error reading bitcode file '"
136 << BitcodeResult << "'!\n";
139 sys::fs::remove(BitcodeResult);
141 // Don't check if there are no passes in the suffix.
145 outs() << "Checking to see if '" << getPassesString(Suffix)
146 << "' passes compile correctly after the '"
147 << getPassesString(Prefix) << "' passes: ";
149 std::unique_ptr<Module> OriginalInput(
150 BD.swapProgramIn(PrefixOutput.release()));
151 if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
153 errs() << " Error running this sequence of passes"
154 << " on the input program!\n";
155 BD.setPassesToRun(Suffix);
156 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
157 exit(BD.debugOptimizerCrash());
161 Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
162 true /*delete bitcode*/, &Error);
164 return InternalError;
166 outs() << " nope.\n";
170 // Otherwise, we must not be running the bad pass anymore.
171 outs() << " yup.\n"; // No miscompilation!
172 // Restore orig program & free test.
173 delete BD.swapProgramIn(OriginalInput.release());
178 class ReduceMiscompilingFunctions : public ListReducer<Function*> {
180 bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
182 ReduceMiscompilingFunctions(BugDriver &bd,
183 bool (*F)(BugDriver &, Module *, Module *,
185 : BD(bd), TestFn(F) {}
187 TestResult doTest(std::vector<Function*> &Prefix,
188 std::vector<Function*> &Suffix,
189 std::string &Error) override {
190 if (!Suffix.empty()) {
191 bool Ret = TestFuncs(Suffix, Error);
193 return InternalError;
197 if (!Prefix.empty()) {
198 bool Ret = TestFuncs(Prefix, Error);
200 return InternalError;
207 bool TestFuncs(const std::vector<Function*> &Prefix, std::string &Error);
211 static void diagnosticHandler(const DiagnosticInfo &DI) {
212 DiagnosticPrinterRawOStream DP(errs());
215 if (DI.getSeverity() == DS_Error)
219 /// TestMergedProgram - Given two modules, link them together and run the
220 /// program, checking to see if the program matches the diff. If there is
221 /// an error, return NULL. If not, return the merged module. The Broken argument
222 /// will be set to true if the output is different. If the DeleteInputs
223 /// argument is set to true then this function deletes both input
224 /// modules before it returns.
226 static Module *TestMergedProgram(const BugDriver &BD, Module *M1, Module *M2,
227 bool DeleteInputs, std::string &Error,
229 // Link the two portions of the program back to together.
231 M1 = CloneModule(M1).release();
232 M2 = CloneModule(M2).release();
234 if (Linker::linkModules(*M1, *M2, diagnosticHandler))
236 delete M2; // We are done with this module.
238 // Execute the program.
239 Broken = BD.diffProgram(M1, "", "", false, &Error);
240 if (!Error.empty()) {
241 // Delete the linked module
248 /// TestFuncs - split functions in a Module into two groups: those that are
249 /// under consideration for miscompilation vs. those that are not, and test
250 /// accordingly. Each group of functions becomes a separate Module.
252 bool ReduceMiscompilingFunctions::TestFuncs(const std::vector<Function*> &Funcs,
253 std::string &Error) {
254 // Test to see if the function is misoptimized if we ONLY run it on the
255 // functions listed in Funcs.
256 outs() << "Checking to see if the program is misoptimized when "
257 << (Funcs.size()==1 ? "this function is" : "these functions are")
258 << " run through the pass"
259 << (BD.getPassesToRun().size() == 1 ? "" : "es") << ":";
260 PrintFunctionList(Funcs);
263 // Create a clone for two reasons:
264 // * If the optimization passes delete any function, the deleted function
265 // will be in the clone and Funcs will still point to valid memory
266 // * If the optimization passes use interprocedural information to break
267 // a function, we want to continue with the original function. Otherwise
268 // we can conclude that a function triggers the bug when in fact one
269 // needs a larger set of original functions to do so.
270 ValueToValueMapTy VMap;
271 Module *Clone = CloneModule(BD.getProgram(), VMap).release();
272 Module *Orig = BD.swapProgramIn(Clone);
274 std::vector<Function*> FuncsOnClone;
275 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
276 Function *F = cast<Function>(VMap[Funcs[i]]);
277 FuncsOnClone.push_back(F);
280 // Split the module into the two halves of the program we want.
282 Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap).release();
283 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, FuncsOnClone,
286 // Run the predicate, note that the predicate will delete both input modules.
287 bool Broken = TestFn(BD, ToOptimize, ToNotOptimize, Error);
289 delete BD.swapProgramIn(Orig);
294 /// DisambiguateGlobalSymbols - Give anonymous global values names.
296 static void DisambiguateGlobalSymbols(Module *M) {
297 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
300 I->setName("anon_global");
301 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
303 I->setName("anon_fn");
306 /// ExtractLoops - Given a reduced list of functions that still exposed the bug,
307 /// check to see if we can extract the loops in the region without obscuring the
308 /// bug. If so, it reduces the amount of code identified.
310 static bool ExtractLoops(BugDriver &BD,
311 bool (*TestFn)(BugDriver &, Module *, Module *,
313 std::vector<Function*> &MiscompiledFunctions,
314 std::string &Error) {
315 bool MadeChange = false;
317 if (BugpointIsInterrupted) return MadeChange;
319 ValueToValueMapTy VMap;
320 std::unique_ptr<Module> ToNotOptimize = CloneModule(BD.getProgram(), VMap);
321 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize.get(),
322 MiscompiledFunctions,
324 std::unique_ptr<Module> ToOptimizeLoopExtracted =
325 BD.extractLoop(ToOptimize);
326 if (!ToOptimizeLoopExtracted) {
327 // If the loop extractor crashed or if there were no extractible loops,
328 // then this chapter of our odyssey is over with.
333 errs() << "Extracted a loop from the breaking portion of the program.\n";
335 // Bugpoint is intentionally not very trusting of LLVM transformations. In
336 // particular, we're not going to assume that the loop extractor works, so
337 // we're going to test the newly loop extracted program to make sure nothing
338 // has broken. If something broke, then we'll inform the user and stop
340 AbstractInterpreter *AI = BD.switchToSafeInterpreter();
342 Module *New = TestMergedProgram(BD, ToOptimizeLoopExtracted.get(),
343 ToNotOptimize.get(), false, Error, Failure);
347 // Delete the original and set the new program.
348 Module *Old = BD.swapProgramIn(New);
349 for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
350 MiscompiledFunctions[i] = cast<Function>(VMap[MiscompiledFunctions[i]]);
354 BD.switchToInterpreter(AI);
356 // Merged program doesn't work anymore!
357 errs() << " *** ERROR: Loop extraction broke the program. :("
358 << " Please report a bug!\n";
359 errs() << " Continuing on with un-loop-extracted version.\n";
361 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-tno.bc",
362 ToNotOptimize.get());
363 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to.bc",
365 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to-le.bc",
366 ToOptimizeLoopExtracted.get());
368 errs() << "Please submit the "
369 << OutputPrefix << "-loop-extract-fail-*.bc files.\n";
374 BD.switchToInterpreter(AI);
376 outs() << " Testing after loop extraction:\n";
377 // Clone modules, the tester function will free them.
378 std::unique_ptr<Module> TOLEBackup =
379 CloneModule(ToOptimizeLoopExtracted.get(), VMap);
380 std::unique_ptr<Module> TNOBackup = CloneModule(ToNotOptimize.get(), VMap);
382 for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
383 MiscompiledFunctions[i] = cast<Function>(VMap[MiscompiledFunctions[i]]);
386 TestFn(BD, ToOptimizeLoopExtracted.get(), ToNotOptimize.get(), Error);
390 ToOptimizeLoopExtracted = std::move(TOLEBackup);
391 ToNotOptimize = std::move(TNOBackup);
394 outs() << "*** Loop extraction masked the problem. Undoing.\n";
395 // If the program is not still broken, then loop extraction did something
396 // that masked the error. Stop loop extraction now.
398 std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
399 for (Function *F : MiscompiledFunctions) {
400 MisCompFunctions.emplace_back(F->getName(), F->getFunctionType());
403 if (Linker::linkModules(*ToNotOptimize, *ToOptimizeLoopExtracted,
407 MiscompiledFunctions.clear();
408 for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
409 Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first);
411 assert(NewF && "Function not found??");
412 MiscompiledFunctions.push_back(NewF);
415 BD.setNewProgram(ToNotOptimize.release());
419 outs() << "*** Loop extraction successful!\n";
421 std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
422 for (Module::iterator I = ToOptimizeLoopExtracted->begin(),
423 E = ToOptimizeLoopExtracted->end(); I != E; ++I)
424 if (!I->isDeclaration())
425 MisCompFunctions.emplace_back(I->getName(), I->getFunctionType());
427 // Okay, great! Now we know that we extracted a loop and that loop
428 // extraction both didn't break the program, and didn't mask the problem.
429 // Replace the current program with the loop extracted version, and try to
430 // extract another loop.
431 if (Linker::linkModules(*ToNotOptimize, *ToOptimizeLoopExtracted,
435 // All of the Function*'s in the MiscompiledFunctions list are in the old
436 // module. Update this list to include all of the functions in the
437 // optimized and loop extracted module.
438 MiscompiledFunctions.clear();
439 for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
440 Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first);
442 assert(NewF && "Function not found??");
443 MiscompiledFunctions.push_back(NewF);
446 BD.setNewProgram(ToNotOptimize.release());
452 class ReduceMiscompiledBlocks : public ListReducer<BasicBlock*> {
454 bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
455 std::vector<Function*> FunctionsBeingTested;
457 ReduceMiscompiledBlocks(BugDriver &bd,
458 bool (*F)(BugDriver &, Module *, Module *,
460 const std::vector<Function*> &Fns)
461 : BD(bd), TestFn(F), FunctionsBeingTested(Fns) {}
463 TestResult doTest(std::vector<BasicBlock*> &Prefix,
464 std::vector<BasicBlock*> &Suffix,
465 std::string &Error) override {
466 if (!Suffix.empty()) {
467 bool Ret = TestFuncs(Suffix, Error);
469 return InternalError;
473 if (!Prefix.empty()) {
474 bool Ret = TestFuncs(Prefix, Error);
476 return InternalError;
483 bool TestFuncs(const std::vector<BasicBlock*> &BBs, std::string &Error);
487 /// TestFuncs - Extract all blocks for the miscompiled functions except for the
488 /// specified blocks. If the problem still exists, return true.
490 bool ReduceMiscompiledBlocks::TestFuncs(const std::vector<BasicBlock*> &BBs,
491 std::string &Error) {
492 // Test to see if the function is misoptimized if we ONLY run it on the
493 // functions listed in Funcs.
494 outs() << "Checking to see if the program is misoptimized when all ";
496 outs() << "but these " << BBs.size() << " blocks are extracted: ";
497 for (unsigned i = 0, e = BBs.size() < 10 ? BBs.size() : 10; i != e; ++i)
498 outs() << BBs[i]->getName() << " ";
499 if (BBs.size() > 10) outs() << "...";
501 outs() << "blocks are extracted.";
505 // Split the module into the two halves of the program we want.
506 ValueToValueMapTy VMap;
507 Module *Clone = CloneModule(BD.getProgram(), VMap).release();
508 Module *Orig = BD.swapProgramIn(Clone);
509 std::vector<Function*> FuncsOnClone;
510 std::vector<BasicBlock*> BBsOnClone;
511 for (unsigned i = 0, e = FunctionsBeingTested.size(); i != e; ++i) {
512 Function *F = cast<Function>(VMap[FunctionsBeingTested[i]]);
513 FuncsOnClone.push_back(F);
515 for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
516 BasicBlock *BB = cast<BasicBlock>(VMap[BBs[i]]);
517 BBsOnClone.push_back(BB);
521 Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap).release();
522 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
526 // Try the extraction. If it doesn't work, then the block extractor crashed
527 // or something, in which case bugpoint can't chase down this possibility.
528 if (std::unique_ptr<Module> New =
529 BD.extractMappedBlocksFromModule(BBsOnClone, ToOptimize)) {
531 // Run the predicate,
532 // note that the predicate will delete both input modules.
533 bool Ret = TestFn(BD, New.get(), ToNotOptimize, Error);
534 delete BD.swapProgramIn(Orig);
537 delete BD.swapProgramIn(Orig);
539 delete ToNotOptimize;
544 /// ExtractBlocks - Given a reduced list of functions that still expose the bug,
545 /// extract as many basic blocks from the region as possible without obscuring
548 static bool ExtractBlocks(BugDriver &BD,
549 bool (*TestFn)(BugDriver &, Module *, Module *,
551 std::vector<Function*> &MiscompiledFunctions,
552 std::string &Error) {
553 if (BugpointIsInterrupted) return false;
555 std::vector<BasicBlock*> Blocks;
556 for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
557 for (BasicBlock &BB : *MiscompiledFunctions[i])
558 Blocks.push_back(&BB);
560 // Use the list reducer to identify blocks that can be extracted without
561 // obscuring the bug. The Blocks list will end up containing blocks that must
562 // be retained from the original program.
563 unsigned OldSize = Blocks.size();
565 // Check to see if all blocks are extractible first.
566 bool Ret = ReduceMiscompiledBlocks(BD, TestFn, MiscompiledFunctions)
567 .TestFuncs(std::vector<BasicBlock*>(), Error);
573 ReduceMiscompiledBlocks(BD, TestFn,
574 MiscompiledFunctions).reduceList(Blocks, Error);
577 if (Blocks.size() == OldSize)
581 ValueToValueMapTy VMap;
582 Module *ProgClone = CloneModule(BD.getProgram(), VMap).release();
583 Module *ToExtract = SplitFunctionsOutOfModule(ProgClone,
584 MiscompiledFunctions,
586 std::unique_ptr<Module> Extracted =
587 BD.extractMappedBlocksFromModule(Blocks, ToExtract);
589 // Weird, extraction should have worked.
590 errs() << "Nondeterministic problem extracting blocks??\n";
596 // Otherwise, block extraction succeeded. Link the two program fragments back
600 std::vector<std::pair<std::string, FunctionType*> > MisCompFunctions;
601 for (Module::iterator I = Extracted->begin(), E = Extracted->end();
603 if (!I->isDeclaration())
604 MisCompFunctions.emplace_back(I->getName(), I->getFunctionType());
606 if (Linker::linkModules(*ProgClone, *Extracted, diagnosticHandler))
609 // Set the new program and delete the old one.
610 BD.setNewProgram(ProgClone);
612 // Update the list of miscompiled functions.
613 MiscompiledFunctions.clear();
615 for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
616 Function *NewF = ProgClone->getFunction(MisCompFunctions[i].first);
617 assert(NewF && "Function not found??");
618 MiscompiledFunctions.push_back(NewF);
625 /// DebugAMiscompilation - This is a generic driver to narrow down
626 /// miscompilations, either in an optimization or a code generator.
628 static std::vector<Function*>
629 DebugAMiscompilation(BugDriver &BD,
630 bool (*TestFn)(BugDriver &, Module *, Module *,
632 std::string &Error) {
633 // Okay, now that we have reduced the list of passes which are causing the
634 // failure, see if we can pin down which functions are being
635 // miscompiled... first build a list of all of the non-external functions in
637 std::vector<Function*> MiscompiledFunctions;
638 Module *Prog = BD.getProgram();
639 for (Function &F : *Prog)
640 if (!F.isDeclaration())
641 MiscompiledFunctions.push_back(&F);
643 // Do the reduction...
644 if (!BugpointIsInterrupted)
645 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
647 if (!Error.empty()) {
648 errs() << "\n***Cannot reduce functions: ";
649 return MiscompiledFunctions;
651 outs() << "\n*** The following function"
652 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
653 << " being miscompiled: ";
654 PrintFunctionList(MiscompiledFunctions);
657 // See if we can rip any loops out of the miscompiled functions and still
658 // trigger the problem.
660 if (!BugpointIsInterrupted && !DisableLoopExtraction) {
661 bool Ret = ExtractLoops(BD, TestFn, MiscompiledFunctions, Error);
663 return MiscompiledFunctions;
665 // Okay, we extracted some loops and the problem still appears. See if
666 // we can eliminate some of the created functions from being candidates.
667 DisambiguateGlobalSymbols(BD.getProgram());
669 // Do the reduction...
670 if (!BugpointIsInterrupted)
671 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
674 return MiscompiledFunctions;
676 outs() << "\n*** The following function"
677 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
678 << " being miscompiled: ";
679 PrintFunctionList(MiscompiledFunctions);
684 if (!BugpointIsInterrupted && !DisableBlockExtraction) {
685 bool Ret = ExtractBlocks(BD, TestFn, MiscompiledFunctions, Error);
687 return MiscompiledFunctions;
689 // Okay, we extracted some blocks and the problem still appears. See if
690 // we can eliminate some of the created functions from being candidates.
691 DisambiguateGlobalSymbols(BD.getProgram());
693 // Do the reduction...
694 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
697 return MiscompiledFunctions;
699 outs() << "\n*** The following function"
700 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
701 << " being miscompiled: ";
702 PrintFunctionList(MiscompiledFunctions);
707 return MiscompiledFunctions;
710 /// TestOptimizer - This is the predicate function used to check to see if the
711 /// "Test" portion of the program is misoptimized. If so, return true. In any
712 /// case, both module arguments are deleted.
714 static bool TestOptimizer(BugDriver &BD, Module *Test, Module *Safe,
715 std::string &Error) {
716 // Run the optimization passes on ToOptimize, producing a transformed version
717 // of the functions being tested.
718 outs() << " Optimizing functions being tested: ";
719 std::unique_ptr<Module> Optimized = BD.runPassesOn(Test, BD.getPassesToRun(),
720 /*AutoDebugCrashes*/ true);
724 outs() << " Checking to see if the merged program executes correctly: ";
727 TestMergedProgram(BD, Optimized.get(), Safe, true, Error, Broken);
729 outs() << (Broken ? " nope.\n" : " yup.\n");
730 // Delete the original and set the new program.
731 delete BD.swapProgramIn(New);
737 /// debugMiscompilation - This method is used when the passes selected are not
738 /// crashing, but the generated output is semantically different from the
741 void BugDriver::debugMiscompilation(std::string *Error) {
742 // Make sure something was miscompiled...
743 if (!BugpointIsInterrupted)
744 if (!ReduceMiscompilingPasses(*this).reduceList(PassesToRun, *Error)) {
746 errs() << "*** Optimized program matches reference output! No problem"
747 << " detected...\nbugpoint can't help you with your problem!\n";
751 outs() << "\n*** Found miscompiling pass"
752 << (getPassesToRun().size() == 1 ? "" : "es") << ": "
753 << getPassesString(getPassesToRun()) << '\n';
754 EmitProgressBitcode(Program, "passinput");
756 std::vector<Function *> MiscompiledFunctions =
757 DebugAMiscompilation(*this, TestOptimizer, *Error);
761 // Output a bunch of bitcode files for the user...
762 outs() << "Outputting reduced bitcode files which expose the problem:\n";
763 ValueToValueMapTy VMap;
764 Module *ToNotOptimize = CloneModule(getProgram(), VMap).release();
765 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
766 MiscompiledFunctions,
769 outs() << " Non-optimized portion: ";
770 EmitProgressBitcode(ToNotOptimize, "tonotoptimize", true);
771 delete ToNotOptimize; // Delete hacked module.
773 outs() << " Portion that is input to optimizer: ";
774 EmitProgressBitcode(ToOptimize, "tooptimize");
775 delete ToOptimize; // Delete hacked module.
780 /// CleanupAndPrepareModules - Get the specified modules ready for code
781 /// generator testing.
783 static void CleanupAndPrepareModules(BugDriver &BD, Module *&Test,
785 // Clean up the modules, removing extra cruft that we don't need anymore...
786 Test = BD.performFinalCleanups(Test).release();
788 // If we are executing the JIT, we have several nasty issues to take care of.
789 if (!BD.isExecutingJIT()) return;
791 // First, if the main function is in the Safe module, we must add a stub to
792 // the Test module to call into it. Thus, we create a new function `main'
793 // which just calls the old one.
794 if (Function *oldMain = Safe->getFunction("main"))
795 if (!oldMain->isDeclaration()) {
797 oldMain->setName("llvm_bugpoint_old_main");
798 // Create a NEW `main' function with same type in the test module.
799 Function *newMain = Function::Create(oldMain->getFunctionType(),
800 GlobalValue::ExternalLinkage,
802 // Create an `oldmain' prototype in the test module, which will
803 // corresponds to the real main function in the same module.
804 Function *oldMainProto = Function::Create(oldMain->getFunctionType(),
805 GlobalValue::ExternalLinkage,
806 oldMain->getName(), Test);
807 // Set up and remember the argument list for the main function.
808 std::vector<Value*> args;
809 for (Function::arg_iterator
810 I = newMain->arg_begin(), E = newMain->arg_end(),
811 OI = oldMain->arg_begin(); I != E; ++I, ++OI) {
812 I->setName(OI->getName()); // Copy argument names from oldMain
816 // Call the old main function and return its result
817 BasicBlock *BB = BasicBlock::Create(Safe->getContext(), "entry", newMain);
818 CallInst *call = CallInst::Create(oldMainProto, args, "", BB);
820 // If the type of old function wasn't void, return value of call
821 ReturnInst::Create(Safe->getContext(), call, BB);
824 // The second nasty issue we must deal with in the JIT is that the Safe
825 // module cannot directly reference any functions defined in the test
826 // module. Instead, we use a JIT API call to dynamically resolve the
829 // Add the resolver to the Safe module.
830 // Prototype: void *getPointerToNamedFunction(const char* Name)
831 Constant *resolverFunc =
832 Safe->getOrInsertFunction("getPointerToNamedFunction",
833 Type::getInt8PtrTy(Safe->getContext()),
834 Type::getInt8PtrTy(Safe->getContext()),
837 // Use the function we just added to get addresses of functions we need.
838 for (Module::iterator F = Safe->begin(), E = Safe->end(); F != E; ++F) {
839 if (F->isDeclaration() && !F->use_empty() && &*F != resolverFunc &&
840 !F->isIntrinsic() /* ignore intrinsics */) {
841 Function *TestFn = Test->getFunction(F->getName());
843 // Don't forward functions which are external in the test module too.
844 if (TestFn && !TestFn->isDeclaration()) {
845 // 1. Add a string constant with its name to the global file
846 Constant *InitArray =
847 ConstantDataArray::getString(F->getContext(), F->getName());
848 GlobalVariable *funcName =
849 new GlobalVariable(*Safe, InitArray->getType(), true /*isConstant*/,
850 GlobalValue::InternalLinkage, InitArray,
851 F->getName() + "_name");
853 // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an
854 // sbyte* so it matches the signature of the resolver function.
856 // GetElementPtr *funcName, ulong 0, ulong 0
857 std::vector<Constant*> GEPargs(2,
858 Constant::getNullValue(Type::getInt32Ty(F->getContext())));
859 Value *GEP = ConstantExpr::getGetElementPtr(InitArray->getType(),
861 std::vector<Value*> ResolverArgs;
862 ResolverArgs.push_back(GEP);
864 // Rewrite uses of F in global initializers, etc. to uses of a wrapper
865 // function that dynamically resolves the calls to F via our JIT API
866 if (!F->use_empty()) {
867 // Create a new global to hold the cached function pointer.
868 Constant *NullPtr = ConstantPointerNull::get(F->getType());
869 GlobalVariable *Cache =
870 new GlobalVariable(*F->getParent(), F->getType(),
871 false, GlobalValue::InternalLinkage,
872 NullPtr,F->getName()+".fpcache");
874 // Construct a new stub function that will re-route calls to F
875 FunctionType *FuncTy = F->getFunctionType();
876 Function *FuncWrapper = Function::Create(FuncTy,
877 GlobalValue::InternalLinkage,
878 F->getName() + "_wrapper",
880 BasicBlock *EntryBB = BasicBlock::Create(F->getContext(),
881 "entry", FuncWrapper);
882 BasicBlock *DoCallBB = BasicBlock::Create(F->getContext(),
883 "usecache", FuncWrapper);
884 BasicBlock *LookupBB = BasicBlock::Create(F->getContext(),
885 "lookupfp", FuncWrapper);
887 // Check to see if we already looked up the value.
888 Value *CachedVal = new LoadInst(Cache, "fpcache", EntryBB);
889 Value *IsNull = new ICmpInst(*EntryBB, ICmpInst::ICMP_EQ, CachedVal,
891 BranchInst::Create(LookupBB, DoCallBB, IsNull, EntryBB);
893 // Resolve the call to function F via the JIT API:
895 // call resolver(GetElementPtr...)
897 CallInst::Create(resolverFunc, ResolverArgs, "resolver", LookupBB);
899 // Cast the result from the resolver to correctly-typed function.
900 CastInst *CastedResolver =
901 new BitCastInst(Resolver,
902 PointerType::getUnqual(F->getFunctionType()),
903 "resolverCast", LookupBB);
905 // Save the value in our cache.
906 new StoreInst(CastedResolver, Cache, LookupBB);
907 BranchInst::Create(DoCallBB, LookupBB);
909 PHINode *FuncPtr = PHINode::Create(NullPtr->getType(), 2,
911 FuncPtr->addIncoming(CastedResolver, LookupBB);
912 FuncPtr->addIncoming(CachedVal, EntryBB);
914 // Save the argument list.
915 std::vector<Value*> Args;
916 for (Argument &A : FuncWrapper->args())
919 // Pass on the arguments to the real function, return its result
920 if (F->getReturnType()->isVoidTy()) {
921 CallInst::Create(FuncPtr, Args, "", DoCallBB);
922 ReturnInst::Create(F->getContext(), DoCallBB);
924 CallInst *Call = CallInst::Create(FuncPtr, Args,
926 ReturnInst::Create(F->getContext(),Call, DoCallBB);
929 // Use the wrapper function instead of the old function
930 F->replaceAllUsesWith(FuncWrapper);
936 if (verifyModule(*Test) || verifyModule(*Safe)) {
937 errs() << "Bugpoint has a bug, which corrupted a module!!\n";
944 /// TestCodeGenerator - This is the predicate function used to check to see if
945 /// the "Test" portion of the program is miscompiled by the code generator under
946 /// test. If so, return true. In any case, both module arguments are deleted.
948 static bool TestCodeGenerator(BugDriver &BD, Module *Test, Module *Safe,
949 std::string &Error) {
950 CleanupAndPrepareModules(BD, Test, Safe);
952 SmallString<128> TestModuleBC;
954 std::error_code EC = sys::fs::createTemporaryFile("bugpoint.test", "bc",
955 TestModuleFD, TestModuleBC);
957 errs() << BD.getToolName() << "Error making unique filename: "
958 << EC.message() << "\n";
961 if (BD.writeProgramToFile(TestModuleBC.str(), TestModuleFD, Test)) {
962 errs() << "Error writing bitcode to `" << TestModuleBC.str()
968 FileRemover TestModuleBCRemover(TestModuleBC.str(), !SaveTemps);
970 // Make the shared library
971 SmallString<128> SafeModuleBC;
973 EC = sys::fs::createTemporaryFile("bugpoint.safe", "bc", SafeModuleFD,
976 errs() << BD.getToolName() << "Error making unique filename: "
977 << EC.message() << "\n";
981 if (BD.writeProgramToFile(SafeModuleBC.str(), SafeModuleFD, Safe)) {
982 errs() << "Error writing bitcode to `" << SafeModuleBC
987 FileRemover SafeModuleBCRemover(SafeModuleBC.str(), !SaveTemps);
989 std::string SharedObject = BD.compileSharedObject(SafeModuleBC.str(), Error);
994 FileRemover SharedObjectRemover(SharedObject, !SaveTemps);
996 // Run the code generator on the `Test' code, loading the shared library.
997 // The function returns whether or not the new output differs from reference.
998 bool Result = BD.diffProgram(BD.getProgram(), TestModuleBC.str(),
999 SharedObject, false, &Error);
1004 errs() << ": still failing!\n";
1006 errs() << ": didn't fail.\n";
1012 /// debugCodeGenerator - debug errors in LLC, LLI, or CBE.
1014 bool BugDriver::debugCodeGenerator(std::string *Error) {
1015 if ((void*)SafeInterpreter == (void*)Interpreter) {
1016 std::string Result = executeProgramSafely(Program, "bugpoint.safe.out",
1018 if (Error->empty()) {
1019 outs() << "\n*** The \"safe\" i.e. 'known good' backend cannot match "
1020 << "the reference diff. This may be due to a\n front-end "
1021 << "bug or a bug in the original program, but this can also "
1022 << "happen if bugpoint isn't running the program with the "
1023 << "right flags or input.\n I left the result of executing "
1024 << "the program with the \"safe\" backend in this file for "
1026 << Result << "'.\n";
1031 DisambiguateGlobalSymbols(Program);
1033 std::vector<Function*> Funcs = DebugAMiscompilation(*this, TestCodeGenerator,
1035 if (!Error->empty())
1038 // Split the module into the two halves of the program we want.
1039 ValueToValueMapTy VMap;
1040 Module *ToNotCodeGen = CloneModule(getProgram(), VMap).release();
1041 Module *ToCodeGen = SplitFunctionsOutOfModule(ToNotCodeGen, Funcs, VMap);
1043 // Condition the modules
1044 CleanupAndPrepareModules(*this, ToCodeGen, ToNotCodeGen);
1046 SmallString<128> TestModuleBC;
1048 std::error_code EC = sys::fs::createTemporaryFile("bugpoint.test", "bc",
1049 TestModuleFD, TestModuleBC);
1051 errs() << getToolName() << "Error making unique filename: "
1052 << EC.message() << "\n";
1056 if (writeProgramToFile(TestModuleBC.str(), TestModuleFD, ToCodeGen)) {
1057 errs() << "Error writing bitcode to `" << TestModuleBC
1063 // Make the shared library
1064 SmallString<128> SafeModuleBC;
1066 EC = sys::fs::createTemporaryFile("bugpoint.safe", "bc", SafeModuleFD,
1069 errs() << getToolName() << "Error making unique filename: "
1070 << EC.message() << "\n";
1074 if (writeProgramToFile(SafeModuleBC.str(), SafeModuleFD, ToNotCodeGen)) {
1075 errs() << "Error writing bitcode to `" << SafeModuleBC
1079 std::string SharedObject = compileSharedObject(SafeModuleBC.str(), *Error);
1080 if (!Error->empty())
1082 delete ToNotCodeGen;
1084 outs() << "You can reproduce the problem with the command line: \n";
1085 if (isExecutingJIT()) {
1086 outs() << " lli -load " << SharedObject << " " << TestModuleBC;
1088 outs() << " llc " << TestModuleBC << " -o " << TestModuleBC
1090 outs() << " cc " << SharedObject << " " << TestModuleBC.str()
1091 << ".s -o " << TestModuleBC << ".exe";
1092 #if defined (HAVE_LINK_R)
1093 outs() << " -Wl,-R.";
1096 outs() << " " << TestModuleBC << ".exe";
1098 for (unsigned i = 0, e = InputArgv.size(); i != e; ++i)
1099 outs() << " " << InputArgv[i];
1101 outs() << "The shared object was created with:\n llc -march=c "
1102 << SafeModuleBC.str() << " -o temporary.c\n"
1103 << " cc -xc temporary.c -O2 -o " << SharedObject;
1104 if (TargetTriple.getArch() == Triple::sparc)
1105 outs() << " -G"; // Compile a shared library, `-G' for Sparc
1107 outs() << " -fPIC -shared"; // `-shared' for Linux/X86, maybe others
1109 outs() << " -fno-strict-aliasing\n";