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/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/Linker.h"
22 #include "llvm/Module.h"
23 #include "llvm/Pass.h"
24 #include "llvm/Analysis/Verifier.h"
25 #include "llvm/Transforms/Utils/Cloning.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/FileUtilities.h"
28 #include "llvm/Config/config.h" // for HAVE_LINK_R
32 extern cl::opt<std::string> OutputPrefix;
33 extern cl::list<std::string> InputArgv;
37 static llvm::cl::opt<bool>
38 DisableLoopExtraction("disable-loop-extraction",
39 cl::desc("Don't extract loops when searching for miscompilations"),
41 static llvm::cl::opt<bool>
42 DisableBlockExtraction("disable-block-extraction",
43 cl::desc("Don't extract blocks when searching for miscompilations"),
46 class ReduceMiscompilingPasses : public ListReducer<std::string> {
49 ReduceMiscompilingPasses(BugDriver &bd) : BD(bd) {}
51 virtual TestResult doTest(std::vector<std::string> &Prefix,
52 std::vector<std::string> &Suffix,
57 /// TestResult - After passes have been split into a test group and a control
58 /// group, see if they still break the program.
60 ReduceMiscompilingPasses::TestResult
61 ReduceMiscompilingPasses::doTest(std::vector<std::string> &Prefix,
62 std::vector<std::string> &Suffix,
64 // First, run the program with just the Suffix passes. If it is still broken
65 // with JUST the kept passes, discard the prefix passes.
66 outs() << "Checking to see if '" << getPassesString(Suffix)
67 << "' compiles correctly: ";
69 std::string BitcodeResult;
70 if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
72 errs() << " Error running this sequence of passes"
73 << " on the input program!\n";
74 BD.setPassesToRun(Suffix);
75 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
76 exit(BD.debugOptimizerCrash());
79 // Check to see if the finished program matches the reference output...
80 bool Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
81 true /*delete bitcode*/, &Error);
87 errs() << BD.getToolName() << ": I'm confused: the test fails when "
88 << "no passes are run, nondeterministic program?\n";
91 return KeepSuffix; // Miscompilation detected!
93 outs() << " yup.\n"; // No miscompilation!
95 if (Prefix.empty()) return NoFailure;
97 // Next, see if the program is broken if we run the "prefix" passes first,
98 // then separately run the "kept" passes.
99 outs() << "Checking to see if '" << getPassesString(Prefix)
100 << "' compiles correctly: ";
102 // If it is not broken with the kept passes, it's possible that the prefix
103 // passes must be run before the kept passes to break it. If the program
104 // WORKS after the prefix passes, but then fails if running the prefix AND
105 // kept passes, we can update our bitcode file to include the result of the
106 // prefix passes, then discard the prefix passes.
108 if (BD.runPasses(BD.getProgram(), Prefix, BitcodeResult, false/*delete*/,
110 errs() << " Error running this sequence of passes"
111 << " on the input program!\n";
112 BD.setPassesToRun(Prefix);
113 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
114 exit(BD.debugOptimizerCrash());
117 // If the prefix maintains the predicate by itself, only keep the prefix!
118 Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "", false, &Error);
120 return InternalError;
122 outs() << " nope.\n";
123 sys::Path(BitcodeResult).eraseFromDisk();
126 outs() << " yup.\n"; // No miscompilation!
128 // Ok, so now we know that the prefix passes work, try running the suffix
129 // passes on the result of the prefix passes.
131 OwningPtr<Module> PrefixOutput(ParseInputFile(BitcodeResult,
133 if (PrefixOutput == 0) {
134 errs() << BD.getToolName() << ": Error reading bitcode file '"
135 << BitcodeResult << "'!\n";
138 sys::Path(BitcodeResult).eraseFromDisk(); // No longer need the file on disk
140 // Don't check if there are no passes in the suffix.
144 outs() << "Checking to see if '" << getPassesString(Suffix)
145 << "' passes compile correctly after the '"
146 << getPassesString(Prefix) << "' passes: ";
148 OwningPtr<Module> OriginalInput(BD.swapProgramIn(PrefixOutput.take()));
149 if (BD.runPasses(BD.getProgram(), Suffix, BitcodeResult, false/*delete*/,
151 errs() << " Error running this sequence of passes"
152 << " on the input program!\n";
153 BD.setPassesToRun(Suffix);
154 BD.EmitProgressBitcode(BD.getProgram(), "pass-error", false);
155 exit(BD.debugOptimizerCrash());
159 Diff = BD.diffProgram(BD.getProgram(), BitcodeResult, "",
160 true /*delete bitcode*/, &Error);
162 return InternalError;
164 outs() << " nope.\n";
168 // Otherwise, we must not be running the bad pass anymore.
169 outs() << " yup.\n"; // No miscompilation!
170 // Restore orig program & free test.
171 delete BD.swapProgramIn(OriginalInput.take());
176 class ReduceMiscompilingFunctions : public ListReducer<Function*> {
178 bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
180 ReduceMiscompilingFunctions(BugDriver &bd,
181 bool (*F)(BugDriver &, Module *, Module *,
183 : BD(bd), TestFn(F) {}
185 virtual TestResult doTest(std::vector<Function*> &Prefix,
186 std::vector<Function*> &Suffix,
187 std::string &Error) {
188 if (!Suffix.empty()) {
189 bool Ret = TestFuncs(Suffix, Error);
191 return InternalError;
195 if (!Prefix.empty()) {
196 bool Ret = TestFuncs(Prefix, Error);
198 return InternalError;
205 bool TestFuncs(const std::vector<Function*> &Prefix, std::string &Error);
209 /// TestMergedProgram - Given two modules, link them together and run the
210 /// program, checking to see if the program matches the diff. If there is
211 /// an error, return NULL. If not, return the merged module. The Broken argument
212 /// will be set to true if the output is different. If the DeleteInputs
213 /// argument is set to true then this function deletes both input
214 /// modules before it returns.
216 static Module *TestMergedProgram(const BugDriver &BD, Module *M1, Module *M2,
217 bool DeleteInputs, std::string &Error,
219 // Link the two portions of the program back to together.
220 std::string ErrorMsg;
222 M1 = CloneModule(M1);
223 M2 = CloneModule(M2);
225 if (Linker::LinkModules(M1, M2, &ErrorMsg)) {
226 errs() << BD.getToolName() << ": Error linking modules together:"
230 delete M2; // We are done with this module.
232 // Execute the program.
233 Broken = BD.diffProgram(M1, "", "", false, &Error);
234 if (!Error.empty()) {
235 // Delete the linked module
242 /// TestFuncs - split functions in a Module into two groups: those that are
243 /// under consideration for miscompilation vs. those that are not, and test
244 /// accordingly. Each group of functions becomes a separate Module.
246 bool ReduceMiscompilingFunctions::TestFuncs(const std::vector<Function*> &Funcs,
247 std::string &Error) {
248 // Test to see if the function is misoptimized if we ONLY run it on the
249 // functions listed in Funcs.
250 outs() << "Checking to see if the program is misoptimized when "
251 << (Funcs.size()==1 ? "this function is" : "these functions are")
252 << " run through the pass"
253 << (BD.getPassesToRun().size() == 1 ? "" : "es") << ":";
254 PrintFunctionList(Funcs);
257 // Create a clone for two reasons:
258 // * If the optimization passes delete any function, the deleted function
259 // will be in the clone and Funcs will still point to valid memory
260 // * If the optimization passes use interprocedural information to break
261 // a function, we want to continue with the original function. Otherwise
262 // we can conclude that a function triggers the bug when in fact one
263 // needs a larger set of original functions to do so.
264 ValueMap<const Value*, Value*> VMap;
265 Module *Clone = CloneModule(BD.getProgram(), VMap);
266 Module *Orig = BD.swapProgramIn(Clone);
268 std::vector<Function*> FuncsOnClone;
269 for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
270 Function *F = cast<Function>(VMap[Funcs[i]]);
271 FuncsOnClone.push_back(F);
274 // Split the module into the two halves of the program we want.
276 Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap);
277 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, FuncsOnClone,
280 // Run the predicate, note that the predicate will delete both input modules.
281 bool Broken = TestFn(BD, ToOptimize, ToNotOptimize, Error);
283 delete BD.swapProgramIn(Orig);
288 /// DisambiguateGlobalSymbols - Give anonymous global values names.
290 static void DisambiguateGlobalSymbols(Module *M) {
291 for (Module::global_iterator I = M->global_begin(), E = M->global_end();
294 I->setName("anon_global");
295 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
297 I->setName("anon_fn");
300 /// ExtractLoops - Given a reduced list of functions that still exposed the bug,
301 /// check to see if we can extract the loops in the region without obscuring the
302 /// bug. If so, it reduces the amount of code identified.
304 static bool ExtractLoops(BugDriver &BD,
305 bool (*TestFn)(BugDriver &, Module *, Module *,
307 std::vector<Function*> &MiscompiledFunctions,
308 std::string &Error) {
309 bool MadeChange = false;
311 if (BugpointIsInterrupted) return MadeChange;
313 ValueMap<const Value*, Value*> VMap;
314 Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap);
315 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
316 MiscompiledFunctions,
318 Module *ToOptimizeLoopExtracted = BD.ExtractLoop(ToOptimize);
319 if (!ToOptimizeLoopExtracted) {
320 // If the loop extractor crashed or if there were no extractible loops,
321 // then this chapter of our odyssey is over with.
322 delete ToNotOptimize;
327 errs() << "Extracted a loop from the breaking portion of the program.\n";
329 // Bugpoint is intentionally not very trusting of LLVM transformations. In
330 // particular, we're not going to assume that the loop extractor works, so
331 // we're going to test the newly loop extracted program to make sure nothing
332 // has broken. If something broke, then we'll inform the user and stop
334 AbstractInterpreter *AI = BD.switchToSafeInterpreter();
336 Module *New = TestMergedProgram(BD, ToOptimizeLoopExtracted, ToNotOptimize,
337 false, Error, Failure);
340 // Delete the original and set the new program.
341 delete BD.swapProgramIn(New);
343 BD.switchToInterpreter(AI);
345 // Merged program doesn't work anymore!
346 errs() << " *** ERROR: Loop extraction broke the program. :("
347 << " Please report a bug!\n";
348 errs() << " Continuing on with un-loop-extracted version.\n";
350 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-tno.bc",
352 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to.bc",
354 BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to-le.bc",
355 ToOptimizeLoopExtracted);
357 errs() << "Please submit the "
358 << OutputPrefix << "-loop-extract-fail-*.bc files.\n";
360 delete ToNotOptimize;
361 delete ToOptimizeLoopExtracted;
365 BD.switchToInterpreter(AI);
367 outs() << " Testing after loop extraction:\n";
368 // Clone modules, the tester function will free them.
369 Module *TOLEBackup = CloneModule(ToOptimizeLoopExtracted);
370 Module *TNOBackup = CloneModule(ToNotOptimize);
371 Failure = TestFn(BD, ToOptimizeLoopExtracted, ToNotOptimize, Error);
375 outs() << "*** Loop extraction masked the problem. Undoing.\n";
376 // If the program is not still broken, then loop extraction did something
377 // that masked the error. Stop loop extraction now.
382 ToOptimizeLoopExtracted = TOLEBackup;
383 ToNotOptimize = TNOBackup;
385 outs() << "*** Loop extraction successful!\n";
387 std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions;
388 for (Module::iterator I = ToOptimizeLoopExtracted->begin(),
389 E = ToOptimizeLoopExtracted->end(); I != E; ++I)
390 if (!I->isDeclaration())
391 MisCompFunctions.push_back(std::make_pair(I->getName(),
392 I->getFunctionType()));
394 // Okay, great! Now we know that we extracted a loop and that loop
395 // extraction both didn't break the program, and didn't mask the problem.
396 // Replace the current program with the loop extracted version, and try to
397 // extract another loop.
398 std::string ErrorMsg;
399 if (Linker::LinkModules(ToNotOptimize, ToOptimizeLoopExtracted, &ErrorMsg)){
400 errs() << BD.getToolName() << ": Error linking modules together:"
404 delete ToOptimizeLoopExtracted;
406 // All of the Function*'s in the MiscompiledFunctions list are in the old
407 // module. Update this list to include all of the functions in the
408 // optimized and loop extracted module.
409 MiscompiledFunctions.clear();
410 for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
411 Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first);
413 assert(NewF && "Function not found??");
414 assert(NewF->getFunctionType() == MisCompFunctions[i].second &&
415 "found wrong function type?");
416 MiscompiledFunctions.push_back(NewF);
419 BD.setNewProgram(ToNotOptimize);
425 class ReduceMiscompiledBlocks : public ListReducer<BasicBlock*> {
427 bool (*TestFn)(BugDriver &, Module *, Module *, std::string &);
428 std::vector<Function*> FunctionsBeingTested;
430 ReduceMiscompiledBlocks(BugDriver &bd,
431 bool (*F)(BugDriver &, Module *, Module *,
433 const std::vector<Function*> &Fns)
434 : BD(bd), TestFn(F), FunctionsBeingTested(Fns) {}
436 virtual TestResult doTest(std::vector<BasicBlock*> &Prefix,
437 std::vector<BasicBlock*> &Suffix,
438 std::string &Error) {
439 if (!Suffix.empty()) {
440 bool Ret = TestFuncs(Suffix, Error);
442 return InternalError;
446 if (!Prefix.empty()) {
447 bool Ret = TestFuncs(Prefix, Error);
449 return InternalError;
456 bool TestFuncs(const std::vector<BasicBlock*> &BBs, std::string &Error);
460 /// TestFuncs - Extract all blocks for the miscompiled functions except for the
461 /// specified blocks. If the problem still exists, return true.
463 bool ReduceMiscompiledBlocks::TestFuncs(const std::vector<BasicBlock*> &BBs,
464 std::string &Error) {
465 // Test to see if the function is misoptimized if we ONLY run it on the
466 // functions listed in Funcs.
467 outs() << "Checking to see if the program is misoptimized when all ";
469 outs() << "but these " << BBs.size() << " blocks are extracted: ";
470 for (unsigned i = 0, e = BBs.size() < 10 ? BBs.size() : 10; i != e; ++i)
471 outs() << BBs[i]->getName() << " ";
472 if (BBs.size() > 10) outs() << "...";
474 outs() << "blocks are extracted.";
478 // Split the module into the two halves of the program we want.
479 ValueMap<const Value*, Value*> VMap;
480 Module *Clone = CloneModule(BD.getProgram(), VMap);
481 Module *Orig = BD.swapProgramIn(Clone);
482 std::vector<Function*> FuncsOnClone;
483 std::vector<BasicBlock*> BBsOnClone;
484 for (unsigned i = 0, e = FunctionsBeingTested.size(); i != e; ++i) {
485 Function *F = cast<Function>(VMap[FunctionsBeingTested[i]]);
486 FuncsOnClone.push_back(F);
488 for (unsigned i = 0, e = BBs.size(); i != e; ++i) {
489 BasicBlock *BB = cast<BasicBlock>(VMap[BBs[i]]);
490 BBsOnClone.push_back(BB);
494 Module *ToNotOptimize = CloneModule(BD.getProgram(), VMap);
495 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
499 // Try the extraction. If it doesn't work, then the block extractor crashed
500 // or something, in which case bugpoint can't chase down this possibility.
501 if (Module *New = BD.ExtractMappedBlocksFromModule(BBsOnClone, ToOptimize)) {
503 // Run the predicate,
504 // note that the predicate will delete both input modules.
505 bool Ret = TestFn(BD, New, ToNotOptimize, Error);
506 delete BD.swapProgramIn(Orig);
509 delete BD.swapProgramIn(Orig);
511 delete ToNotOptimize;
516 /// ExtractBlocks - Given a reduced list of functions that still expose the bug,
517 /// extract as many basic blocks from the region as possible without obscuring
520 static bool ExtractBlocks(BugDriver &BD,
521 bool (*TestFn)(BugDriver &, Module *, Module *,
523 std::vector<Function*> &MiscompiledFunctions,
524 std::string &Error) {
525 if (BugpointIsInterrupted) return false;
527 std::vector<BasicBlock*> Blocks;
528 for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i)
529 for (Function::iterator I = MiscompiledFunctions[i]->begin(),
530 E = MiscompiledFunctions[i]->end(); I != E; ++I)
533 // Use the list reducer to identify blocks that can be extracted without
534 // obscuring the bug. The Blocks list will end up containing blocks that must
535 // be retained from the original program.
536 unsigned OldSize = Blocks.size();
538 // Check to see if all blocks are extractible first.
539 bool Ret = ReduceMiscompiledBlocks(BD, TestFn, MiscompiledFunctions)
540 .TestFuncs(std::vector<BasicBlock*>(), Error);
546 ReduceMiscompiledBlocks(BD, TestFn,
547 MiscompiledFunctions).reduceList(Blocks, Error);
550 if (Blocks.size() == OldSize)
554 ValueMap<const Value*, Value*> VMap;
555 Module *ProgClone = CloneModule(BD.getProgram(), VMap);
556 Module *ToExtract = SplitFunctionsOutOfModule(ProgClone,
557 MiscompiledFunctions,
559 Module *Extracted = BD.ExtractMappedBlocksFromModule(Blocks, ToExtract);
560 if (Extracted == 0) {
561 // Weird, extraction should have worked.
562 errs() << "Nondeterministic problem extracting blocks??\n";
568 // Otherwise, block extraction succeeded. Link the two program fragments back
572 std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions;
573 for (Module::iterator I = Extracted->begin(), E = Extracted->end();
575 if (!I->isDeclaration())
576 MisCompFunctions.push_back(std::make_pair(I->getName(),
577 I->getFunctionType()));
579 std::string ErrorMsg;
580 if (Linker::LinkModules(ProgClone, Extracted, &ErrorMsg)) {
581 errs() << BD.getToolName() << ": Error linking modules together:"
587 // Set the new program and delete the old one.
588 BD.setNewProgram(ProgClone);
590 // Update the list of miscompiled functions.
591 MiscompiledFunctions.clear();
593 for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) {
594 Function *NewF = ProgClone->getFunction(MisCompFunctions[i].first);
595 assert(NewF && "Function not found??");
596 assert(NewF->getFunctionType() == MisCompFunctions[i].second &&
597 "Function has wrong type??");
598 MiscompiledFunctions.push_back(NewF);
605 /// DebugAMiscompilation - This is a generic driver to narrow down
606 /// miscompilations, either in an optimization or a code generator.
608 static std::vector<Function*>
609 DebugAMiscompilation(BugDriver &BD,
610 bool (*TestFn)(BugDriver &, Module *, Module *,
612 std::string &Error) {
613 // Okay, now that we have reduced the list of passes which are causing the
614 // failure, see if we can pin down which functions are being
615 // miscompiled... first build a list of all of the non-external functions in
617 std::vector<Function*> MiscompiledFunctions;
618 Module *Prog = BD.getProgram();
619 for (Module::iterator I = Prog->begin(), E = Prog->end(); I != E; ++I)
620 if (!I->isDeclaration())
621 MiscompiledFunctions.push_back(I);
623 // Do the reduction...
624 if (!BugpointIsInterrupted)
625 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
628 return MiscompiledFunctions;
630 outs() << "\n*** The following function"
631 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
632 << " being miscompiled: ";
633 PrintFunctionList(MiscompiledFunctions);
636 // See if we can rip any loops out of the miscompiled functions and still
637 // trigger the problem.
639 if (!BugpointIsInterrupted && !DisableLoopExtraction) {
640 bool Ret = ExtractLoops(BD, TestFn, MiscompiledFunctions, Error);
642 return MiscompiledFunctions;
644 // Okay, we extracted some loops and the problem still appears. See if
645 // we can eliminate some of the created functions from being candidates.
646 DisambiguateGlobalSymbols(BD.getProgram());
648 // Do the reduction...
649 if (!BugpointIsInterrupted)
650 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
653 return MiscompiledFunctions;
655 outs() << "\n*** The following function"
656 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
657 << " being miscompiled: ";
658 PrintFunctionList(MiscompiledFunctions);
663 if (!BugpointIsInterrupted && !DisableBlockExtraction) {
664 bool Ret = ExtractBlocks(BD, TestFn, MiscompiledFunctions, Error);
666 return MiscompiledFunctions;
668 // Okay, we extracted some blocks and the problem still appears. See if
669 // we can eliminate some of the created functions from being candidates.
670 DisambiguateGlobalSymbols(BD.getProgram());
672 // Do the reduction...
673 ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions,
676 return MiscompiledFunctions;
678 outs() << "\n*** The following function"
679 << (MiscompiledFunctions.size() == 1 ? " is" : "s are")
680 << " being miscompiled: ";
681 PrintFunctionList(MiscompiledFunctions);
686 return MiscompiledFunctions;
689 /// TestOptimizer - This is the predicate function used to check to see if the
690 /// "Test" portion of the program is misoptimized. If so, return true. In any
691 /// case, both module arguments are deleted.
693 static bool TestOptimizer(BugDriver &BD, Module *Test, Module *Safe,
694 std::string &Error) {
695 // Run the optimization passes on ToOptimize, producing a transformed version
696 // of the functions being tested.
697 outs() << " Optimizing functions being tested: ";
698 Module *Optimized = BD.runPassesOn(Test, BD.getPassesToRun(),
699 /*AutoDebugCrashes*/true);
703 outs() << " Checking to see if the merged program executes correctly: ";
705 Module *New = TestMergedProgram(BD, Optimized, Safe, true, Error, Broken);
707 outs() << (Broken ? " nope.\n" : " yup.\n");
708 // Delete the original and set the new program.
709 delete BD.swapProgramIn(New);
715 /// debugMiscompilation - This method is used when the passes selected are not
716 /// crashing, but the generated output is semantically different from the
719 void BugDriver::debugMiscompilation(std::string *Error) {
720 // Make sure something was miscompiled...
721 if (!BugpointIsInterrupted)
722 if (!ReduceMiscompilingPasses(*this).reduceList(PassesToRun, *Error)) {
724 errs() << "*** Optimized program matches reference output! No problem"
725 << " detected...\nbugpoint can't help you with your problem!\n";
729 outs() << "\n*** Found miscompiling pass"
730 << (getPassesToRun().size() == 1 ? "" : "es") << ": "
731 << getPassesString(getPassesToRun()) << '\n';
732 EmitProgressBitcode(Program, "passinput");
734 std::vector<Function *> MiscompiledFunctions =
735 DebugAMiscompilation(*this, TestOptimizer, *Error);
739 // Output a bunch of bitcode files for the user...
740 outs() << "Outputting reduced bitcode files which expose the problem:\n";
741 ValueMap<const Value*, Value*> VMap;
742 Module *ToNotOptimize = CloneModule(getProgram(), VMap);
743 Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize,
744 MiscompiledFunctions,
747 outs() << " Non-optimized portion: ";
748 EmitProgressBitcode(ToNotOptimize, "tonotoptimize", true);
749 delete ToNotOptimize; // Delete hacked module.
751 outs() << " Portion that is input to optimizer: ";
752 EmitProgressBitcode(ToOptimize, "tooptimize");
753 delete ToOptimize; // Delete hacked module.
758 /// CleanupAndPrepareModules - Get the specified modules ready for code
759 /// generator testing.
761 static void CleanupAndPrepareModules(BugDriver &BD, Module *&Test,
763 // Clean up the modules, removing extra cruft that we don't need anymore...
764 Test = BD.performFinalCleanups(Test);
766 // If we are executing the JIT, we have several nasty issues to take care of.
767 if (!BD.isExecutingJIT()) return;
769 // First, if the main function is in the Safe module, we must add a stub to
770 // the Test module to call into it. Thus, we create a new function `main'
771 // which just calls the old one.
772 if (Function *oldMain = Safe->getFunction("main"))
773 if (!oldMain->isDeclaration()) {
775 oldMain->setName("llvm_bugpoint_old_main");
776 // Create a NEW `main' function with same type in the test module.
777 Function *newMain = Function::Create(oldMain->getFunctionType(),
778 GlobalValue::ExternalLinkage,
780 // Create an `oldmain' prototype in the test module, which will
781 // corresponds to the real main function in the same module.
782 Function *oldMainProto = Function::Create(oldMain->getFunctionType(),
783 GlobalValue::ExternalLinkage,
784 oldMain->getName(), Test);
785 // Set up and remember the argument list for the main function.
786 std::vector<Value*> args;
787 for (Function::arg_iterator
788 I = newMain->arg_begin(), E = newMain->arg_end(),
789 OI = oldMain->arg_begin(); I != E; ++I, ++OI) {
790 I->setName(OI->getName()); // Copy argument names from oldMain
794 // Call the old main function and return its result
795 BasicBlock *BB = BasicBlock::Create(Safe->getContext(), "entry", newMain);
796 CallInst *call = CallInst::Create(oldMainProto, args.begin(), args.end(),
799 // If the type of old function wasn't void, return value of call
800 ReturnInst::Create(Safe->getContext(), call, BB);
803 // The second nasty issue we must deal with in the JIT is that the Safe
804 // module cannot directly reference any functions defined in the test
805 // module. Instead, we use a JIT API call to dynamically resolve the
808 // Add the resolver to the Safe module.
809 // Prototype: void *getPointerToNamedFunction(const char* Name)
810 Constant *resolverFunc =
811 Safe->getOrInsertFunction("getPointerToNamedFunction",
812 Type::getInt8PtrTy(Safe->getContext()),
813 Type::getInt8PtrTy(Safe->getContext()),
816 // Use the function we just added to get addresses of functions we need.
817 for (Module::iterator F = Safe->begin(), E = Safe->end(); F != E; ++F) {
818 if (F->isDeclaration() && !F->use_empty() && &*F != resolverFunc &&
819 !F->isIntrinsic() /* ignore intrinsics */) {
820 Function *TestFn = Test->getFunction(F->getName());
822 // Don't forward functions which are external in the test module too.
823 if (TestFn && !TestFn->isDeclaration()) {
824 // 1. Add a string constant with its name to the global file
825 Constant *InitArray = ConstantArray::get(F->getContext(), F->getName());
826 GlobalVariable *funcName =
827 new GlobalVariable(*Safe, InitArray->getType(), true /*isConstant*/,
828 GlobalValue::InternalLinkage, InitArray,
829 F->getName() + "_name");
831 // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an
832 // sbyte* so it matches the signature of the resolver function.
834 // GetElementPtr *funcName, ulong 0, ulong 0
835 std::vector<Constant*> GEPargs(2,
836 Constant::getNullValue(Type::getInt32Ty(F->getContext())));
838 ConstantExpr::getGetElementPtr(funcName, &GEPargs[0], 2);
839 std::vector<Value*> ResolverArgs;
840 ResolverArgs.push_back(GEP);
842 // Rewrite uses of F in global initializers, etc. to uses of a wrapper
843 // function that dynamically resolves the calls to F via our JIT API
844 if (!F->use_empty()) {
845 // Create a new global to hold the cached function pointer.
846 Constant *NullPtr = ConstantPointerNull::get(F->getType());
847 GlobalVariable *Cache =
848 new GlobalVariable(*F->getParent(), F->getType(),
849 false, GlobalValue::InternalLinkage,
850 NullPtr,F->getName()+".fpcache");
852 // Construct a new stub function that will re-route calls to F
853 const FunctionType *FuncTy = F->getFunctionType();
854 Function *FuncWrapper = Function::Create(FuncTy,
855 GlobalValue::InternalLinkage,
856 F->getName() + "_wrapper",
858 BasicBlock *EntryBB = BasicBlock::Create(F->getContext(),
859 "entry", FuncWrapper);
860 BasicBlock *DoCallBB = BasicBlock::Create(F->getContext(),
861 "usecache", FuncWrapper);
862 BasicBlock *LookupBB = BasicBlock::Create(F->getContext(),
863 "lookupfp", FuncWrapper);
865 // Check to see if we already looked up the value.
866 Value *CachedVal = new LoadInst(Cache, "fpcache", EntryBB);
867 Value *IsNull = new ICmpInst(*EntryBB, ICmpInst::ICMP_EQ, CachedVal,
869 BranchInst::Create(LookupBB, DoCallBB, IsNull, EntryBB);
871 // Resolve the call to function F via the JIT API:
873 // call resolver(GetElementPtr...)
875 CallInst::Create(resolverFunc, ResolverArgs.begin(),
876 ResolverArgs.end(), "resolver", LookupBB);
878 // Cast the result from the resolver to correctly-typed function.
879 CastInst *CastedResolver =
880 new BitCastInst(Resolver,
881 PointerType::getUnqual(F->getFunctionType()),
882 "resolverCast", LookupBB);
884 // Save the value in our cache.
885 new StoreInst(CastedResolver, Cache, LookupBB);
886 BranchInst::Create(DoCallBB, LookupBB);
888 PHINode *FuncPtr = PHINode::Create(NullPtr->getType(),
890 FuncPtr->addIncoming(CastedResolver, LookupBB);
891 FuncPtr->addIncoming(CachedVal, EntryBB);
893 // Save the argument list.
894 std::vector<Value*> Args;
895 for (Function::arg_iterator i = FuncWrapper->arg_begin(),
896 e = FuncWrapper->arg_end(); i != e; ++i)
899 // Pass on the arguments to the real function, return its result
900 if (F->getReturnType()->isVoidTy()) {
901 CallInst::Create(FuncPtr, Args.begin(), Args.end(), "", DoCallBB);
902 ReturnInst::Create(F->getContext(), DoCallBB);
904 CallInst *Call = CallInst::Create(FuncPtr, Args.begin(), Args.end(),
906 ReturnInst::Create(F->getContext(),Call, DoCallBB);
909 // Use the wrapper function instead of the old function
910 F->replaceAllUsesWith(FuncWrapper);
916 if (verifyModule(*Test) || verifyModule(*Safe)) {
917 errs() << "Bugpoint has a bug, which corrupted a module!!\n";
924 /// TestCodeGenerator - This is the predicate function used to check to see if
925 /// the "Test" portion of the program is miscompiled by the code generator under
926 /// test. If so, return true. In any case, both module arguments are deleted.
928 static bool TestCodeGenerator(BugDriver &BD, Module *Test, Module *Safe,
929 std::string &Error) {
930 CleanupAndPrepareModules(BD, Test, Safe);
932 sys::Path TestModuleBC("bugpoint.test.bc");
934 if (TestModuleBC.makeUnique(true, &ErrMsg)) {
935 errs() << BD.getToolName() << "Error making unique filename: "
939 if (BD.writeProgramToFile(TestModuleBC.str(), Test)) {
940 errs() << "Error writing bitcode to `" << TestModuleBC.str()
946 FileRemover TestModuleBCRemover(TestModuleBC, !SaveTemps);
948 // Make the shared library
949 sys::Path SafeModuleBC("bugpoint.safe.bc");
950 if (SafeModuleBC.makeUnique(true, &ErrMsg)) {
951 errs() << BD.getToolName() << "Error making unique filename: "
956 if (BD.writeProgramToFile(SafeModuleBC.str(), Safe)) {
957 errs() << "Error writing bitcode to `" << SafeModuleBC.str()
962 FileRemover SafeModuleBCRemover(SafeModuleBC, !SaveTemps);
964 std::string SharedObject = BD.compileSharedObject(SafeModuleBC.str(), Error);
969 FileRemover SharedObjectRemover(sys::Path(SharedObject), !SaveTemps);
971 // Run the code generator on the `Test' code, loading the shared library.
972 // The function returns whether or not the new output differs from reference.
973 bool Result = BD.diffProgram(BD.getProgram(), TestModuleBC.str(),
974 SharedObject, false, &Error);
979 errs() << ": still failing!\n";
981 errs() << ": didn't fail.\n";
987 /// debugCodeGenerator - debug errors in LLC, LLI, or CBE.
989 bool BugDriver::debugCodeGenerator(std::string *Error) {
990 if ((void*)SafeInterpreter == (void*)Interpreter) {
991 std::string Result = executeProgramSafely(Program, "bugpoint.safe.out",
993 if (Error->empty()) {
994 outs() << "\n*** The \"safe\" i.e. 'known good' backend cannot match "
995 << "the reference diff. This may be due to a\n front-end "
996 << "bug or a bug in the original program, but this can also "
997 << "happen if bugpoint isn't running the program with the "
998 << "right flags or input.\n I left the result of executing "
999 << "the program with the \"safe\" backend in this file for "
1001 << Result << "'.\n";
1006 DisambiguateGlobalSymbols(Program);
1008 std::vector<Function*> Funcs = DebugAMiscompilation(*this, TestCodeGenerator,
1010 if (!Error->empty())
1013 // Split the module into the two halves of the program we want.
1014 ValueMap<const Value*, Value*> VMap;
1015 Module *ToNotCodeGen = CloneModule(getProgram(), VMap);
1016 Module *ToCodeGen = SplitFunctionsOutOfModule(ToNotCodeGen, Funcs, VMap);
1018 // Condition the modules
1019 CleanupAndPrepareModules(*this, ToCodeGen, ToNotCodeGen);
1021 sys::Path TestModuleBC("bugpoint.test.bc");
1023 if (TestModuleBC.makeUnique(true, &ErrMsg)) {
1024 errs() << getToolName() << "Error making unique filename: "
1029 if (writeProgramToFile(TestModuleBC.str(), ToCodeGen)) {
1030 errs() << "Error writing bitcode to `" << TestModuleBC.str()
1036 // Make the shared library
1037 sys::Path SafeModuleBC("bugpoint.safe.bc");
1038 if (SafeModuleBC.makeUnique(true, &ErrMsg)) {
1039 errs() << getToolName() << "Error making unique filename: "
1044 if (writeProgramToFile(SafeModuleBC.str(), ToNotCodeGen)) {
1045 errs() << "Error writing bitcode to `" << SafeModuleBC.str()
1049 std::string SharedObject = compileSharedObject(SafeModuleBC.str(), *Error);
1050 if (!Error->empty())
1052 delete ToNotCodeGen;
1054 outs() << "You can reproduce the problem with the command line: \n";
1055 if (isExecutingJIT()) {
1056 outs() << " lli -load " << SharedObject << " " << TestModuleBC.str();
1058 outs() << " llc " << TestModuleBC.str() << " -o " << TestModuleBC.str()
1060 outs() << " gcc " << SharedObject << " " << TestModuleBC.str()
1061 << ".s -o " << TestModuleBC.str() << ".exe";
1062 #if defined (HAVE_LINK_R)
1063 outs() << " -Wl,-R.";
1066 outs() << " " << TestModuleBC.str() << ".exe";
1068 for (unsigned i = 0, e = InputArgv.size(); i != e; ++i)
1069 outs() << " " << InputArgv[i];
1071 outs() << "The shared object was created with:\n llc -march=c "
1072 << SafeModuleBC.str() << " -o temporary.c\n"
1073 << " gcc -xc temporary.c -O2 -o " << SharedObject;
1074 if (TargetTriple.getArch() == Triple::sparc)
1075 outs() << " -G"; // Compile a shared library, `-G' for Sparc
1077 outs() << " -fPIC -shared"; // `-shared' for Linux/X86, maybe others
1079 outs() << " -fno-strict-aliasing\n";