Miscompilation.cpp revision 6865f29fe71559a18d7f2ff0bc4f67c5fc1d000e
14a10645c70199c8d8567fbc46312158c419720abChris Lattner//===- Miscompilation.cpp - Debug program miscompilations -----------------===// 23da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman// 37c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// The LLVM Compiler Infrastructure 47c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// 521c62da287237d39d0d95004881ea4baae3be6daChris Lattner// This file is distributed under the University of Illinois Open Source 621c62da287237d39d0d95004881ea4baae3be6daChris Lattner// License. See LICENSE.TXT for details. 73da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman// 87c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell//===----------------------------------------------------------------------===// 94a10645c70199c8d8567fbc46312158c419720abChris Lattner// 10a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner// This file implements optimizer and code generation miscompilation debugging 11a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner// support. 124a10645c70199c8d8567fbc46312158c419720abChris Lattner// 134a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 144a10645c70199c8d8567fbc46312158c419720abChris Lattner 154a10645c70199c8d8567fbc46312158c419720abChris Lattner#include "BugDriver.h" 16126840f49e8d49156a342e836d4b2adca46dc3baChris Lattner#include "ListReducer.h" 17ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar#include "ToolRunner.h" 18a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner#include "llvm/Constants.h" 19a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner#include "llvm/DerivedTypes.h" 20a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner#include "llvm/Instructions.h" 21605b9e2c5bd1b0c151a0b15d01e6df3aba93d52fReid Spencer#include "llvm/Linker.h" 224a10645c70199c8d8567fbc46312158c419720abChris Lattner#include "llvm/Module.h" 23e49603d79d220a795bd50684c8b1f503ee40f97fMisha Brukman#include "llvm/Pass.h" 24a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner#include "llvm/Analysis/Verifier.h" 25640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner#include "llvm/Transforms/Utils/Cloning.h" 26551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/CommandLine.h" 27551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/FileUtilities.h" 2859615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#include "llvm/Config/config.h" // for HAVE_LINK_R 29fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattnerusing namespace llvm; 304a10645c70199c8d8567fbc46312158c419720abChris Lattner 31a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnernamespace llvm { 3268ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar extern cl::opt<std::string> OutputPrefix; 33a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner extern cl::list<std::string> InputArgv; 34a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 35a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 36efdc0b505712d1ca4460def27e51c430f033d58dChris Lattnernamespace { 37dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer static llvm::cl::opt<bool> 38dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer DisableLoopExtraction("disable-loop-extraction", 39dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer cl::desc("Don't extract loops when searching for miscompilations"), 40dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer cl::init(false)); 41265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin static llvm::cl::opt<bool> 42265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin DisableBlockExtraction("disable-block-extraction", 43265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin cl::desc("Don't extract blocks when searching for miscompilations"), 44265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin cl::init(false)); 45dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer 46fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner class ReduceMiscompilingPasses : public ListReducer<const PassInfo*> { 47fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner BugDriver &BD; 48fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner public: 49fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner ReduceMiscompilingPasses(BugDriver &bd) : BD(bd) {} 503da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 51fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner virtual TestResult doTest(std::vector<const PassInfo*> &Prefix, 5222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<const PassInfo*> &Suffix, 5322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error); 54fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner }; 55fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 56640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 578c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// TestResult - After passes have been split into a test group and a control 588c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// group, see if they still break the program. 598c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 60640f22e66d90439857a97a83896ee68c4f7128c9Chris LattnerReduceMiscompilingPasses::TestResult 6139aebca3a2d1dd389a6d9cdfb51a53f625e244f0Chris LattnerReduceMiscompilingPasses::doTest(std::vector<const PassInfo*> &Prefix, 6222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<const PassInfo*> &Suffix, 6322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 6406943add8b2b764e131979cca064eda9f28826c9Chris Lattner // First, run the program with just the Suffix passes. If it is still broken 65640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // with JUST the kept passes, discard the prefix passes. 66ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Suffix) 67ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "' compiles correctly: "; 68640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 698ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif std::string BitcodeResult; 708ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Suffix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 7165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 7265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 735ef681c19de9c675a265211f8fb0ae49cc3a3a66Chris Lattner BD.setPassesToRun(Suffix); 748ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 75025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 76640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 779adc0abad3c3ed40a268ccbcee0c74cb9e1359feOwen Anderson 78640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Check to see if the finished program matches the reference output... 7922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Diff = BD.diffProgram(BitcodeResult, "", true /*delete bitcode*/, 8022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky &Error); 8122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 8222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 8322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Diff) { 84ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 8559615f0f85e2ac99e012cb81934d002faebd405aChris Lattner if (Suffix.empty()) { 8665f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": I'm confused: the test fails when " 8765f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << "no passes are run, nondeterministic program?\n"; 8859615f0f85e2ac99e012cb81934d002faebd405aChris Lattner exit(1); 8959615f0f85e2ac99e012cb81934d002faebd405aChris Lattner } 90123f8fec94d1f22d876382897231868c62f8eabbMisha Brukman return KeepSuffix; // Miscompilation detected! 91640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 92ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 93640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 94640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner if (Prefix.empty()) return NoFailure; 95640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 9606943add8b2b764e131979cca064eda9f28826c9Chris Lattner // Next, see if the program is broken if we run the "prefix" passes first, 97bc0e998c497446f5448425b3cbd7f8f19a458764Misha Brukman // then separately run the "kept" passes. 98ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Prefix) 99ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "' compiles correctly: "; 100640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 101640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // If it is not broken with the kept passes, it's possible that the prefix 102640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // passes must be run before the kept passes to break it. If the program 103640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // WORKS after the prefix passes, but then fails if running the prefix AND 1048ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // kept passes, we can update our bitcode file to include the result of the 105640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // prefix passes, then discard the prefix passes. 106640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // 1078ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Prefix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 10865f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 10965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 1109c6cfe1bffd37f29a265457b7515839c445b3e6aChris Lattner BD.setPassesToRun(Prefix); 1118ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 112025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 113640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 114640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 115640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // If the prefix maintains the predicate by itself, only keep the prefix! 11622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Diff = BD.diffProgram(BitcodeResult, "", false, &Error); 11722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 11822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 11922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Diff) { 120ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 1218ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeResult).eraseFromDisk(); 122640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner return KeepPrefix; 123640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 124ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 125640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 126640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Ok, so now we know that the prefix passes work, try running the suffix 127640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // passes on the result of the prefix passes. 128640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // 1296865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin OwningPtr<Module> PrefixOutput(ParseInputFile(BitcodeResult, 1306865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin BD.getContext())); 131640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner if (PrefixOutput == 0) { 13265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error reading bitcode file '" 13365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << BitcodeResult << "'!\n"; 134640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner exit(1); 135640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 1368ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeResult).eraseFromDisk(); // No longer need the file on disk 137f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner 138f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner // Don't check if there are no passes in the suffix. 139f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner if (Suffix.empty()) 140f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner return NoFailure; 1413da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 142ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Suffix) 143640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner << "' passes compile correctly after the '" 144640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner << getPassesString(Prefix) << "' passes: "; 145640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 1466865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin OwningPtr<Module> OriginalInput(BD.swapProgramIn(PrefixOutput.take())); 1478ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Suffix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 14865f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 14965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 1505ef681c19de9c675a265211f8fb0ae49cc3a3a66Chris Lattner BD.setPassesToRun(Suffix); 1518ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 152025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 153640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 154640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 155640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Run the result... 15622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Diff = BD.diffProgram(BitcodeResult, "", true /*delete bitcode*/, &Error); 15722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 15822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 15922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Diff) { 160ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 16106943add8b2b764e131979cca064eda9f28826c9Chris Lattner return KeepSuffix; 162640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 163640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 164640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Otherwise, we must not be running the bad pass anymore. 165ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 1666865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin // Restore orig program & free test. 1676865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin delete BD.swapProgramIn(OriginalInput.take()); 168640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner return NoFailure; 169640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner} 170640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 171efdc0b505712d1ca4460def27e51c430f033d58dChris Lattnernamespace { 172fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner class ReduceMiscompilingFunctions : public ListReducer<Function*> { 173fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner BugDriver &BD; 17422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*TestFn)(BugDriver &, Module *, Module *, std::string &); 175fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner public: 176b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ReduceMiscompilingFunctions(BugDriver &bd, 17722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*F)(BugDriver &, Module *, Module *, 17822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &)) 179b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner : BD(bd), TestFn(F) {} 1803da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 181fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner virtual TestResult doTest(std::vector<Function*> &Prefix, 18222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<Function*> &Suffix, 18322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 18422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Suffix.empty()) { 18522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = TestFuncs(Suffix, Error); 18622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 18722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 18822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) 18922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return KeepSuffix; 19022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 19122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Prefix.empty()) { 19222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = TestFuncs(Prefix, Error); 19322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 19422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 19522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) 19622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return KeepPrefix; 19722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 198fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner return NoFailure; 199fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner } 2003da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 20122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky int TestFuncs(const std::vector<Function*> &Prefix, std::string &Error); 202fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner }; 203fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 204640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 205efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner/// TestMergedProgram - Given two modules, link them together and run the 206efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner/// program, checking to see if the program matches the diff. If the diff 207a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// matches, return false, otherwise return true. If the DeleteInputs argument 208a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// is set to true then this function deletes both input modules before it 209a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// returns. 2108c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 211a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattnerstatic bool TestMergedProgram(BugDriver &BD, Module *M1, Module *M2, 21222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool DeleteInputs, std::string &Error) { 213efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // Link the two portions of the program back to together. 214efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner std::string ErrorMsg; 21590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner if (!DeleteInputs) { 21690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner M1 = CloneModule(M1); 21790c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner M2 = CloneModule(M2); 21890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner } 219e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(M1, M2, &ErrorMsg)) { 22065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 22165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 222efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner exit(1); 223efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner } 22490c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete M2; // We are done with this module. 225efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 2266865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin OwningPtr<Module> OldProgram(BD.swapProgramIn(M1)); 227efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 228efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // Execute the program. If it does not match the expected output, we must 229efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // return true. 23022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Broken = BD.diffProgram("", "", false, &Error); 23122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) { 23222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // Delete the linked module & restore the original 2336865f29fe71559a18d7f2ff0bc4f67c5fc1d000eJeffrey Yasskin delete BD.swapProgramIn(OldProgram.take()); 23422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 235efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner return Broken; 236efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner} 237efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 2388c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// TestFuncs - split functions in a Module into two groups: those that are 2398c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// under consideration for miscompilation vs. those that are not, and test 2408c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// accordingly. Each group of functions becomes a separate Module. 2418c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 24222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckyint ReduceMiscompilingFunctions::TestFuncs(const std::vector<Function*> &Funcs, 24322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 244640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Test to see if the function is misoptimized if we ONLY run it on the 245640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // functions listed in Funcs. 246ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if the program is misoptimized when " 247ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (Funcs.size()==1 ? "this function is" : "these functions are") 248ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " run through the pass" 249ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (BD.getPassesToRun().size() == 1 ? "" : "es") << ":"; 250efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner PrintFunctionList(Funcs); 251ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 252640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 253be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner // Split the module into the two halves of the program we want. 254d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 255d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 256d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, Funcs, 257d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 258640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 2596fa98b13206583e6eb90b8304758b35548914944Nick Lewycky // Run the predicate, note that the predicate will delete both input modules. 26022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return TestFn(BD, ToOptimize, ToNotOptimize, Error); 261640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner} 262640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 2638abfb8adb2f383cab46a5e8b9fca4301effd8140Chris Lattner/// DisambiguateGlobalSymbols - Give anonymous global values names. 2648c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 26536ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattnerstatic void DisambiguateGlobalSymbols(Module *M) { 26667ef9e43049c28c8fe2c9f70d2ad163045ee5876Chris Lattner for (Module::global_iterator I = M->global_begin(), E = M->global_end(); 2671ffb33d033d3593ded0adb08b05eb455cce59ea8Chris Lattner I != E; ++I) 2688abfb8adb2f383cab46a5e8b9fca4301effd8140Chris Lattner if (!I->hasName()) 2698abfb8adb2f383cab46a5e8b9fca4301effd8140Chris Lattner I->setName("anon_global"); 2701ffb33d033d3593ded0adb08b05eb455cce59ea8Chris Lattner for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) 2718abfb8adb2f383cab46a5e8b9fca4301effd8140Chris Lattner if (!I->hasName()) 2728abfb8adb2f383cab46a5e8b9fca4301effd8140Chris Lattner I->setName("anon_fn"); 27336ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner} 27436ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner 275a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// ExtractLoops - Given a reduced list of functions that still exposed the bug, 276a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// check to see if we can extract the loops in the region without obscuring the 277a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// bug. If so, it reduces the amount of code identified. 2788c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 279b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerstatic bool ExtractLoops(BugDriver &BD, 28022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*TestFn)(BugDriver &, Module *, Module *, 28122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &), 28222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<Function*> &MiscompiledFunctions, 28322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 284a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner bool MadeChange = false; 285a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner while (1) { 286aed98fa8861a28e5f7ba7c0659e106f2a441e9ffChris Lattner if (BugpointIsInterrupted) return MadeChange; 287aed98fa8861a28e5f7ba7c0659e106f2a441e9ffChris Lattner 288d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 289d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 290a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 291d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 292d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 293a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner Module *ToOptimizeLoopExtracted = BD.ExtractLoop(ToOptimize); 294a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner if (!ToOptimizeLoopExtracted) { 295a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // If the loop extractor crashed or if there were no extractible loops, 296a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // then this chapter of our odyssey is over with. 297a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToNotOptimize; 298a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToOptimize; 299a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 300a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 301a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 30265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Extracted a loop from the breaking portion of the program.\n"; 303a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 304a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Bugpoint is intentionally not very trusting of LLVM transformations. In 305a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // particular, we're not going to assume that the loop extractor works, so 306a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // we're going to test the newly loop extracted program to make sure nothing 307a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // has broken. If something broke, then we'll inform the user and stop 308a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extraction. 30970ef449741da8b1ef035e04a55958652a0200ba1Dan Gohman AbstractInterpreter *AI = BD.switchToSafeInterpreter(); 31022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Failure = TestMergedProgram(BD, ToOptimizeLoopExtracted, ToNotOptimize, 31122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky false, Error); 31222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 31322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return false; 31422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Failure) { 315a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner BD.switchToInterpreter(AI); 316a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 317a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Merged program doesn't work anymore! 31865f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " *** ERROR: Loop extraction broke the program. :(" 31965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " Please report a bug!\n"; 32065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Continuing on with un-loop-extracted version.\n"; 32156c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner 32268ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-tno.bc", 32368ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar ToNotOptimize); 32468ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to.bc", 32568ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar ToOptimize); 32668ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to-le.bc", 32756c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner ToOptimizeLoopExtracted); 32856c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner 32968ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar errs() << "Please submit the " 33068ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar << OutputPrefix << "-loop-extract-fail-*.bc files.\n"; 33156c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner delete ToOptimize; 332a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToNotOptimize; 333a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToOptimizeLoopExtracted; 334a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 335a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 33656c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner delete ToOptimize; 337a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner BD.switchToInterpreter(AI); 3383da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 339ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Testing after loop extraction:\n"; 340b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Clone modules, the tester function will free them. 341b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *TOLEBackup = CloneModule(ToOptimizeLoopExtracted); 342b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *TNOBackup = CloneModule(ToNotOptimize); 34322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Failure = TestFn(BD, ToOptimizeLoopExtracted, ToNotOptimize, Error); 34422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 34522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return false; 34622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Failure) { 347ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "*** Loop extraction masked the problem. Undoing.\n"; 348a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // If the program is not still broken, then loop extraction did something 349a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // that masked the error. Stop loop extraction now. 350b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete TOLEBackup; 351b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete TNOBackup; 352a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 353a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 354b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToOptimizeLoopExtracted = TOLEBackup; 355b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToNotOptimize = TNOBackup; 356b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 357ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "*** Loop extraction successful!\n"; 358a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 35990c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions; 36090c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (Module::iterator I = ToOptimizeLoopExtracted->begin(), 36190c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner E = ToOptimizeLoopExtracted->end(); I != E; ++I) 3625cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 363fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner MisCompFunctions.push_back(std::make_pair(I->getName(), 364fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner I->getFunctionType())); 36590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner 366a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Okay, great! Now we know that we extracted a loop and that loop 367a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extraction both didn't break the program, and didn't mask the problem. 368a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Replace the current program with the loop extracted version, and try to 369a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extract another loop. 370a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner std::string ErrorMsg; 371e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(ToNotOptimize, ToOptimizeLoopExtracted, &ErrorMsg)){ 37265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 37365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 374a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner exit(1); 375a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 37690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete ToOptimizeLoopExtracted; 377d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner 378d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner // All of the Function*'s in the MiscompiledFunctions list are in the old 3795313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner // module. Update this list to include all of the functions in the 3805313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner // optimized and loop extracted module. 3815313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner MiscompiledFunctions.clear(); 38290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) { 383ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first); 384ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer 38590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner assert(NewF && "Function not found??"); 386ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer assert(NewF->getFunctionType() == MisCompFunctions[i].second && 387ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer "found wrong function type?"); 38890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner MiscompiledFunctions.push_back(NewF); 389d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner } 390d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner 391a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner BD.setNewProgram(ToNotOptimize); 392a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner MadeChange = true; 393a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 394a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner} 395a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 3965e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattnernamespace { 3975e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner class ReduceMiscompiledBlocks : public ListReducer<BasicBlock*> { 3985e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner BugDriver &BD; 39922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*TestFn)(BugDriver &, Module *, Module *, std::string &); 4005e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<Function*> FunctionsBeingTested; 4015e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner public: 4025e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner ReduceMiscompiledBlocks(BugDriver &bd, 40322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*F)(BugDriver &, Module *, Module *, 40422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &), 4055e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner const std::vector<Function*> &Fns) 4065e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner : BD(bd), TestFn(F), FunctionsBeingTested(Fns) {} 4073da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 4085e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner virtual TestResult doTest(std::vector<BasicBlock*> &Prefix, 40922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<BasicBlock*> &Suffix, 41022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 41122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Suffix.empty()) { 41222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = TestFuncs(Suffix, Error); 41322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 41422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 41522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) 41622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return KeepSuffix; 41722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 41822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Prefix.empty()) { 41922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = TestFuncs(Prefix, Error); 42022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 42122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return InternalError; 42222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) 42322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return KeepPrefix; 42422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 4255e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return NoFailure; 4265e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 4273da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 42822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool TestFuncs(const std::vector<BasicBlock*> &BBs, std::string &Error); 4295e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner }; 4305e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 4315e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4325e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// TestFuncs - Extract all blocks for the miscompiled functions except for the 4335e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// specified blocks. If the problem still exists, return true. 4345e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// 43522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckybool ReduceMiscompiledBlocks::TestFuncs(const std::vector<BasicBlock*> &BBs, 43622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 4375e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Test to see if the function is misoptimized if we ONLY run it on the 4385e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // functions listed in Funcs. 439ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if the program is misoptimized when all "; 44068bee938e539d884ee89ce4dfebbad777896960eChris Lattner if (!BBs.empty()) { 441ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "but these " << BBs.size() << " blocks are extracted: "; 44268bee938e539d884ee89ce4dfebbad777896960eChris Lattner for (unsigned i = 0, e = BBs.size() < 10 ? BBs.size() : 10; i != e; ++i) 443ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << BBs[i]->getName() << " "; 444ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman if (BBs.size() > 10) outs() << "..."; 44568bee938e539d884ee89ce4dfebbad777896960eChris Lattner } else { 446ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "blocks are extracted."; 44768bee938e539d884ee89ce4dfebbad777896960eChris Lattner } 448ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 4495e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4505e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Split the module into the two halves of the program we want. 451d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 452d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 4535e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 454d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman FunctionsBeingTested, 455d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 4565e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4575e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Try the extraction. If it doesn't work, then the block extractor crashed 4585e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // or something, in which case bugpoint can't chase down this possibility. 4595e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner if (Module *New = BD.ExtractMappedBlocksFromModule(BBs, ToOptimize)) { 4605e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToOptimize; 4615e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Run the predicate, not that the predicate will delete both input modules. 46222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return TestFn(BD, New, ToNotOptimize, Error); 4635e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 4645e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToOptimize; 4655e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToNotOptimize; 4665e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return false; 4675e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 4685e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4695e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4705e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// ExtractBlocks - Given a reduced list of functions that still expose the bug, 4715e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// extract as many basic blocks from the region as possible without obscuring 4725e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// the bug. 4735e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// 4745e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattnerstatic bool ExtractBlocks(BugDriver &BD, 47522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*TestFn)(BugDriver &, Module *, Module *, 47622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &), 47722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<Function*> &MiscompiledFunctions, 47822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 479f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (BugpointIsInterrupted) return false; 480f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner 4815e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<BasicBlock*> Blocks; 4825e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i) 4835e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner for (Function::iterator I = MiscompiledFunctions[i]->begin(), 4845e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner E = MiscompiledFunctions[i]->end(); I != E; ++I) 4855e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner Blocks.push_back(I); 4865e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4875e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Use the list reducer to identify blocks that can be extracted without 4885e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // obscuring the bug. The Blocks list will end up containing blocks that must 4895e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // be retained from the original program. 4905e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner unsigned OldSize = Blocks.size(); 49168bee938e539d884ee89ce4dfebbad777896960eChris Lattner 49268bee938e539d884ee89ce4dfebbad777896960eChris Lattner // Check to see if all blocks are extractible first. 49322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = ReduceMiscompiledBlocks(BD, TestFn, MiscompiledFunctions) 49422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky .TestFuncs(std::vector<BasicBlock*>(), Error); 49522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 49622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return false; 49722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) { 49868bee938e539d884ee89ce4dfebbad777896960eChris Lattner Blocks.clear(); 49968bee938e539d884ee89ce4dfebbad777896960eChris Lattner } else { 50022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky ReduceMiscompiledBlocks(BD, TestFn, 50122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky MiscompiledFunctions).reduceList(Blocks, Error); 50222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 50322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return false; 50468bee938e539d884ee89ce4dfebbad777896960eChris Lattner if (Blocks.size() == OldSize) 50568bee938e539d884ee89ce4dfebbad777896960eChris Lattner return false; 50668bee938e539d884ee89ce4dfebbad777896960eChris Lattner } 5075e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 508d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 509d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ProgClone = CloneModule(BD.getProgram(), ValueMap); 5102290e754061f1393bb96b1808ac33dc03399c939Chris Lattner Module *ToExtract = SplitFunctionsOutOfModule(ProgClone, 511d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 512d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 5132290e754061f1393bb96b1808ac33dc03399c939Chris Lattner Module *Extracted = BD.ExtractMappedBlocksFromModule(Blocks, ToExtract); 5142290e754061f1393bb96b1808ac33dc03399c939Chris Lattner if (Extracted == 0) { 515da895d63377b421dc50117befb2bec80d2973526Chris Lattner // Weird, extraction should have worked. 51665f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Nondeterministic problem extracting blocks??\n"; 5172290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ProgClone; 5182290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ToExtract; 5192290e754061f1393bb96b1808ac33dc03399c939Chris Lattner return false; 5202290e754061f1393bb96b1808ac33dc03399c939Chris Lattner } 5215e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5222290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Otherwise, block extraction succeeded. Link the two program fragments back 5232290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // together. 5242290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ToExtract; 5255e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 52690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions; 52790c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (Module::iterator I = Extracted->begin(), E = Extracted->end(); 52890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner I != E; ++I) 5295cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 530fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner MisCompFunctions.push_back(std::make_pair(I->getName(), 531fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner I->getFunctionType())); 53290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner 5332290e754061f1393bb96b1808ac33dc03399c939Chris Lattner std::string ErrorMsg; 534e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(ProgClone, Extracted, &ErrorMsg)) { 53565f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 53665f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 5372290e754061f1393bb96b1808ac33dc03399c939Chris Lattner exit(1); 5382290e754061f1393bb96b1808ac33dc03399c939Chris Lattner } 53990c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete Extracted; 5405e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5412290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Set the new program and delete the old one. 5422290e754061f1393bb96b1808ac33dc03399c939Chris Lattner BD.setNewProgram(ProgClone); 5435e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5442290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Update the list of miscompiled functions. 5452290e754061f1393bb96b1808ac33dc03399c939Chris Lattner MiscompiledFunctions.clear(); 5465e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 54790c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) { 548ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer Function *NewF = ProgClone->getFunction(MisCompFunctions[i].first); 54990c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner assert(NewF && "Function not found??"); 550ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer assert(NewF->getFunctionType() == MisCompFunctions[i].second && 551ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer "Function has wrong type??"); 55290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner MiscompiledFunctions.push_back(NewF); 55390c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner } 5542290e754061f1393bb96b1808ac33dc03399c939Chris Lattner 5552290e754061f1393bb96b1808ac33dc03399c939Chris Lattner return true; 5565e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 5575e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5585e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 559b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// DebugAMiscompilation - This is a generic driver to narrow down 560b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// miscompilations, either in an optimization or a code generator. 5618c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 562b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerstatic std::vector<Function*> 563b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris LattnerDebugAMiscompilation(BugDriver &BD, 56422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool (*TestFn)(BugDriver &, Module *, Module *, 56522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &), 56622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 567640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Okay, now that we have reduced the list of passes which are causing the 568640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // failure, see if we can pin down which functions are being 569640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // miscompiled... first build a list of all of the non-external functions in 570640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // the program. 571640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner std::vector<Function*> MiscompiledFunctions; 572b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *Prog = BD.getProgram(); 573b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner for (Module::iterator I = Prog->begin(), E = Prog->end(); I != E; ++I) 5745cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 575640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner MiscompiledFunctions.push_back(I); 5764a10645c70199c8d8567fbc46312158c419720abChris Lattner 577640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Do the reduction... 578f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!BugpointIsInterrupted) 57922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions, 58022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Error); 58122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 58222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return MiscompiledFunctions; 583640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 584ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** The following function" 585ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 586ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " being miscompiled: "; 587640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner PrintFunctionList(MiscompiledFunctions); 588ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 5894a10645c70199c8d8567fbc46312158c419720abChris Lattner 590a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // See if we can rip any loops out of the miscompiled functions and still 591a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // trigger the problem. 592dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer 59322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!BugpointIsInterrupted && !DisableLoopExtraction) { 59422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = ExtractLoops(BD, TestFn, MiscompiledFunctions, Error); 59522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 59622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return MiscompiledFunctions; 59722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) { 59822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // Okay, we extracted some loops and the problem still appears. See if 59922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // we can eliminate some of the created functions from being candidates. 60022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky DisambiguateGlobalSymbols(BD.getProgram()); 60122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky 60222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // Do the reduction... 60322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!BugpointIsInterrupted) 60422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions, 60522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Error); 60622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 60722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return MiscompiledFunctions; 60822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky 60922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky outs() << "\n*** The following function" 61022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 61122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << " being miscompiled: "; 61222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky PrintFunctionList(MiscompiledFunctions); 61322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky outs() << '\n'; 61422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 6155e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 6165e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 61722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!BugpointIsInterrupted && !DisableBlockExtraction) { 61822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Ret = ExtractBlocks(BD, TestFn, MiscompiledFunctions, Error); 61922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 62022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return MiscompiledFunctions; 62122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Ret) { 62222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // Okay, we extracted some blocks and the problem still appears. See if 62322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // we can eliminate some of the created functions from being candidates. 62422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky DisambiguateGlobalSymbols(BD.getProgram()); 62522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky 62622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky // Do the reduction... 62722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions, 62822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky Error); 62922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 63022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return MiscompiledFunctions; 63122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky 63222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky outs() << "\n*** The following function" 63322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 63422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << " being miscompiled: "; 63522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky PrintFunctionList(MiscompiledFunctions); 63622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky outs() << '\n'; 63722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 638a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 639a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 640b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner return MiscompiledFunctions; 641b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner} 642b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 643a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// TestOptimizer - This is the predicate function used to check to see if the 644a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// "Test" portion of the program is misoptimized. If so, return true. In any 645a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// case, both module arguments are deleted. 6468c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 64722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckystatic bool TestOptimizer(BugDriver &BD, Module *Test, Module *Safe, 64822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 649b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Run the optimization passes on ToOptimize, producing a transformed version 650b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // of the functions being tested. 651ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Optimizing functions being tested: "; 652b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *Optimized = BD.runPassesOn(Test, BD.getPassesToRun(), 653b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner /*AutoDebugCrashes*/true); 654ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "done.\n"; 655b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete Test; 656b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 657ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Checking to see if the merged program executes correctly: "; 65822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Broken = TestMergedProgram(BD, Optimized, Safe, true, Error); 65922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Error.empty()) outs() << (Broken ? " nope.\n" : " yup.\n"); 660b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner return Broken; 661b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner} 662b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 663b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 664b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// debugMiscompilation - This method is used when the passes selected are not 665b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// crashing, but the generated output is semantically different from the 666b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// input. 667b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// 66822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckyvoid BugDriver::debugMiscompilation(std::string *Error) { 669b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Make sure something was miscompiled... 670f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!BugpointIsInterrupted) 67122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!ReduceMiscompilingPasses(*this).reduceList(PassesToRun, *Error)) { 67222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Error->empty()) 67322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky errs() << "*** Optimized program matches reference output! No problem" 67422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << " detected...\nbugpoint can't help you with your problem!\n"; 67522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return; 676f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner } 677b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 678ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** Found miscompiling pass" 679ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (getPassesToRun().size() == 1 ? "" : "es") << ": " 680ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << getPassesString(getPassesToRun()) << '\n'; 6818ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("passinput"); 682b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 68322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<Function *> MiscompiledFunctions = 68422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky DebugAMiscompilation(*this, TestOptimizer, *Error); 68522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error->empty()) 68622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return; 687b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 6888ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Output a bunch of bitcode files for the user... 689ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Outputting reduced bitcode files which expose the problem:\n"; 690d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 691d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(getProgram(), ValueMap); 692efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 693d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 694d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 695be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner 696ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Non-optimized portion: "; 697b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToNotOptimize = swapProgramIn(ToNotOptimize); 6988ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("tonotoptimize", true); 699be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner setNewProgram(ToNotOptimize); // Delete hacked module. 7003da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 701ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Portion that is input to optimizer: "; 702b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToOptimize = swapProgramIn(ToOptimize); 7038ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("tooptimize"); 704be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner setNewProgram(ToOptimize); // Delete hacked module. 7054a10645c70199c8d8567fbc46312158c419720abChris Lattner 70622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return; 7074a10645c70199c8d8567fbc46312158c419720abChris Lattner} 708d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 709a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// CleanupAndPrepareModules - Get the specified modules ready for code 710a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// generator testing. 7118c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 712a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnerstatic void CleanupAndPrepareModules(BugDriver &BD, Module *&Test, 713a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Module *Safe) { 714a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Clean up the modules, removing extra cruft that we don't need anymore... 715a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Test = BD.performFinalCleanups(Test); 716a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 717a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // If we are executing the JIT, we have several nasty issues to take care of. 718a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (!BD.isExecutingJIT()) return; 719a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 720a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // First, if the main function is in the Safe module, we must add a stub to 721a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // the Test module to call into it. Thus, we create a new function `main' 722a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // which just calls the old one. 723688b0490e22eb67623f5aaa24406209be74efcb2Reid Spencer if (Function *oldMain = Safe->getFunction("main")) 7245cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!oldMain->isDeclaration()) { 725a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Rename it 726a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner oldMain->setName("llvm_bugpoint_old_main"); 727a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Create a NEW `main' function with same type in the test module. 728051a950000e21935165db56695e35bade668193bGabor Greif Function *newMain = Function::Create(oldMain->getFunctionType(), 729051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::ExternalLinkage, 730051a950000e21935165db56695e35bade668193bGabor Greif "main", Test); 731a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Create an `oldmain' prototype in the test module, which will 732a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // corresponds to the real main function in the same module. 733051a950000e21935165db56695e35bade668193bGabor Greif Function *oldMainProto = Function::Create(oldMain->getFunctionType(), 734051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::ExternalLinkage, 735051a950000e21935165db56695e35bade668193bGabor Greif oldMain->getName(), Test); 736a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Set up and remember the argument list for the main function. 737a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner std::vector<Value*> args; 7385a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos for (Function::arg_iterator 7395a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos I = newMain->arg_begin(), E = newMain->arg_end(), 7405a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos OI = oldMain->arg_begin(); I != E; ++I, ++OI) { 7416bc41e8a74d1756da0003641bfebd02a3d6d9586Owen Anderson I->setName(OI->getName()); // Copy argument names from oldMain 742a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner args.push_back(I); 743a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 744a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 745a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Call the old main function and return its result 7461d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *BB = BasicBlock::Create(Safe->getContext(), "entry", newMain); 747051a950000e21935165db56695e35bade668193bGabor Greif CallInst *call = CallInst::Create(oldMainProto, args.begin(), args.end(), 748051a950000e21935165db56695e35bade668193bGabor Greif "", BB); 7493da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 750a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // If the type of old function wasn't void, return value of call 7511d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(Safe->getContext(), call, BB); 752a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 753a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 754a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // The second nasty issue we must deal with in the JIT is that the Safe 755a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // module cannot directly reference any functions defined in the test 756a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // module. Instead, we use a JIT API call to dynamically resolve the 757a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // symbol. 7583da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 759a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Add the resolver to the Safe module. 760a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Prototype: void *getPointerToNamedFunction(const char* Name) 7612db43c864e8372823d961d961ca520ed20edca82Chris Lattner Constant *resolverFunc = 762a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Safe->getOrInsertFunction("getPointerToNamedFunction", 763ac53a0b272452013124bfc70480aea5e41b60f40Duncan Sands Type::getInt8PtrTy(Safe->getContext()), 764ac53a0b272452013124bfc70480aea5e41b60f40Duncan Sands Type::getInt8PtrTy(Safe->getContext()), 7651d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson (Type *)0); 7663da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 767a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Use the function we just added to get addresses of functions we need. 768dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman for (Module::iterator F = Safe->begin(), E = Safe->end(); F != E; ++F) { 7695cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (F->isDeclaration() && !F->use_empty() && &*F != resolverFunc && 770a3355ffb3d30d19d226bbb75707991c60f236e37Duncan Sands !F->isIntrinsic() /* ignore intrinsics */) { 771688b0490e22eb67623f5aaa24406209be74efcb2Reid Spencer Function *TestFn = Test->getFunction(F->getName()); 772a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 773a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Don't forward functions which are external in the test module too. 7745cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (TestFn && !TestFn->isDeclaration()) { 775a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // 1. Add a string constant with its name to the global file 7761d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson Constant *InitArray = ConstantArray::get(F->getContext(), F->getName()); 777a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner GlobalVariable *funcName = 778e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson new GlobalVariable(*Safe, InitArray->getType(), true /*isConstant*/, 7793da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman GlobalValue::InternalLinkage, InitArray, 780e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson F->getName() + "_name"); 781a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 782a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an 783a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // sbyte* so it matches the signature of the resolver function. 784a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 785a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // GetElementPtr *funcName, ulong 0, ulong 0 7861d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson std::vector<Constant*> GEPargs(2, 7871d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson Constant::getNullValue(Type::getInt32Ty(F->getContext()))); 7889adc0abad3c3ed40a268ccbcee0c74cb9e1359feOwen Anderson Value *GEP = 789baf3c404409d5e47b13984a7f95bfbd6d1f2e79eOwen Anderson ConstantExpr::getGetElementPtr(funcName, &GEPargs[0], 2); 790a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner std::vector<Value*> ResolverArgs; 791a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner ResolverArgs.push_back(GEP); 792a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 793de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Rewrite uses of F in global initializers, etc. to uses of a wrapper 794de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // function that dynamically resolves the calls to F via our JIT API 795a3efca16f2688981672deeb718909cf6acbe474eChris Lattner if (!F->use_empty()) { 796a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Create a new global to hold the cached function pointer. 7979e9a0d5fc26878e51a58a8b57900fcbf952c2691Owen Anderson Constant *NullPtr = ConstantPointerNull::get(F->getType()); 798a3efca16f2688981672deeb718909cf6acbe474eChris Lattner GlobalVariable *Cache = 799e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson new GlobalVariable(*F->getParent(), F->getType(), 800e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson false, GlobalValue::InternalLinkage, 801e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson NullPtr,F->getName()+".fpcache"); 80200b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 803de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Construct a new stub function that will re-route calls to F 804dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman const FunctionType *FuncTy = F->getFunctionType(); 805051a950000e21935165db56695e35bade668193bGabor Greif Function *FuncWrapper = Function::Create(FuncTy, 806051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::InternalLinkage, 807051a950000e21935165db56695e35bade668193bGabor Greif F->getName() + "_wrapper", 808051a950000e21935165db56695e35bade668193bGabor Greif F->getParent()); 8091d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *EntryBB = BasicBlock::Create(F->getContext(), 8101d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "entry", FuncWrapper); 8111d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *DoCallBB = BasicBlock::Create(F->getContext(), 8121d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "usecache", FuncWrapper); 8131d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *LookupBB = BasicBlock::Create(F->getContext(), 8141d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "lookupfp", FuncWrapper); 81500b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 816a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Check to see if we already looked up the value. 817a3efca16f2688981672deeb718909cf6acbe474eChris Lattner Value *CachedVal = new LoadInst(Cache, "fpcache", EntryBB); 818333c40096561218bc3597cf153c0a3895274414cOwen Anderson Value *IsNull = new ICmpInst(*EntryBB, ICmpInst::ICMP_EQ, CachedVal, 819333c40096561218bc3597cf153c0a3895274414cOwen Anderson NullPtr, "isNull"); 820051a950000e21935165db56695e35bade668193bGabor Greif BranchInst::Create(LookupBB, DoCallBB, IsNull, EntryBB); 82100b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 822de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Resolve the call to function F via the JIT API: 823de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // 824de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // call resolver(GetElementPtr...) 825b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CallInst *Resolver = 826b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CallInst::Create(resolverFunc, ResolverArgs.begin(), 827b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif ResolverArgs.end(), "resolver", LookupBB); 828b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif 829b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif // Cast the result from the resolver to correctly-typed function. 830b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CastInst *CastedResolver = 831b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif new BitCastInst(Resolver, 832debcb01b0f0a15f568ca69e8f288fade4bfc7297Owen Anderson PointerType::getUnqual(F->getFunctionType()), 833b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif "resolverCast", LookupBB); 8343da59db637a887474c1b1346c1f3ccf53b6c4663Reid Spencer 835a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Save the value in our cache. 836a3efca16f2688981672deeb718909cf6acbe474eChris Lattner new StoreInst(CastedResolver, Cache, LookupBB); 837051a950000e21935165db56695e35bade668193bGabor Greif BranchInst::Create(DoCallBB, LookupBB); 83800b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 839b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif PHINode *FuncPtr = PHINode::Create(NullPtr->getType(), 840b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif "fp", DoCallBB); 841a3efca16f2688981672deeb718909cf6acbe474eChris Lattner FuncPtr->addIncoming(CastedResolver, LookupBB); 842a3efca16f2688981672deeb718909cf6acbe474eChris Lattner FuncPtr->addIncoming(CachedVal, EntryBB); 84300b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 844a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Save the argument list. 845dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman std::vector<Value*> Args; 8465a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos for (Function::arg_iterator i = FuncWrapper->arg_begin(), 8475a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos e = FuncWrapper->arg_end(); i != e; ++i) 848dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman Args.push_back(i); 849dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman 850dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman // Pass on the arguments to the real function, return its result 8511d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson if (F->getReturnType() == Type::getVoidTy(F->getContext())) { 852051a950000e21935165db56695e35bade668193bGabor Greif CallInst::Create(FuncPtr, Args.begin(), Args.end(), "", DoCallBB); 8531d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(F->getContext(), DoCallBB); 854dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } else { 855051a950000e21935165db56695e35bade668193bGabor Greif CallInst *Call = CallInst::Create(FuncPtr, Args.begin(), Args.end(), 856051a950000e21935165db56695e35bade668193bGabor Greif "retval", DoCallBB); 8571d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(F->getContext(),Call, DoCallBB); 858dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } 85900b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 860de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Use the wrapper function instead of the old function 861de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman F->replaceAllUsesWith(FuncWrapper); 862dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } 863a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 864a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 865a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 866a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 867a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (verifyModule(*Test) || verifyModule(*Safe)) { 86865f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Bugpoint has a bug, which corrupted a module!!\n"; 869a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner abort(); 870a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 871a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 872a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 873a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 874a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 875a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// TestCodeGenerator - This is the predicate function used to check to see if 876a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// the "Test" portion of the program is miscompiled by the code generator under 877a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// test. If so, return true. In any case, both module arguments are deleted. 8788c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 87922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckystatic bool TestCodeGenerator(BugDriver &BD, Module *Test, Module *Safe, 88022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string &Error) { 881a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner CleanupAndPrepareModules(BD, Test, Safe); 882a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 88397182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path TestModuleBC("bugpoint.test.bc"); 88451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 88551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (TestModuleBC.makeUnique(true, &ErrMsg)) { 88665f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << "Error making unique filename: " 88765f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 88851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 88951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 89074382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (BD.writeProgramToFile(TestModuleBC.str(), Test)) { 89174382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << TestModuleBC.str() 89274382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 893a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 894a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 895a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete Test; 896a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 897a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Make the shared library 89897182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path SafeModuleBC("bugpoint.safe.bc"); 89951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (SafeModuleBC.makeUnique(true, &ErrMsg)) { 90065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << "Error making unique filename: " 90165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 90251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 90351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 904a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 90574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (BD.writeProgramToFile(SafeModuleBC.str(), Safe)) { 90674382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << SafeModuleBC.str() 90774382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 908a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 909a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 91022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string SharedObject = BD.compileSharedObject(SafeModuleBC.str(), Error); 91122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 9122706387d37b30fc191c5b74987dc139e1835c52dBenjamin Kramer return false; 913a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete Safe; 914a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 915a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Run the code generator on the `Test' code, loading the shared library. 916a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // The function returns whether or not the new output differs from reference. 91722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky bool Result = BD.diffProgram(TestModuleBC.str(), SharedObject, false, &Error); 91822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error.empty()) 91922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return false; 920a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 921a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (Result) 92265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << ": still failing!\n"; 923a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner else 92465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << ": didn't fail.\n"; 925a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer TestModuleBC.eraseFromDisk(); 926a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer SafeModuleBC.eraseFromDisk(); 927a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(SharedObject).eraseFromDisk(); 928a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 929a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return Result; 930a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 931a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 932a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 9338c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// debugCodeGenerator - debug errors in LLC, LLI, or CBE. 9348c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 93522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewyckybool BugDriver::debugCodeGenerator(std::string *Error) { 93670ef449741da8b1ef035e04a55958652a0200ba1Dan Gohman if ((void*)SafeInterpreter == (void*)Interpreter) { 93722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string Result = executeProgramSafely("bugpoint.safe.out", Error); 93822ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (Error->empty()) { 93922ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky outs() << "\n*** The \"safe\" i.e. 'known good' backend cannot match " 94022ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "the reference diff. This may be due to a\n front-end " 94122ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "bug or a bug in the original program, but this can also " 94222ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "happen if bugpoint isn't running the program with the " 94322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "right flags or input.\n I left the result of executing " 94422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "the program with the \"safe\" backend in this file for " 94522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << "you: '" 94622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky << Result << "'.\n"; 94722ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky } 948a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return true; 949a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 950a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 951a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner DisambiguateGlobalSymbols(Program); 952a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 95322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::vector<Function*> Funcs = DebugAMiscompilation(*this, TestCodeGenerator, 95422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky *Error); 95522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error->empty()) 95622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return true; 957a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 958a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Split the module into the two halves of the program we want. 959d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 960d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotCodeGen = CloneModule(getProgram(), ValueMap); 961d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToCodeGen = SplitFunctionsOutOfModule(ToNotCodeGen, Funcs, ValueMap); 962a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 963a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Condition the modules 964a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner CleanupAndPrepareModules(*this, ToCodeGen, ToNotCodeGen); 965a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 96697182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path TestModuleBC("bugpoint.test.bc"); 96751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 96851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (TestModuleBC.makeUnique(true, &ErrMsg)) { 96965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << getToolName() << "Error making unique filename: " 97065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 97151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 97251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 97397182985d530dbef488696c95a39c14fe56c995bReid Spencer 97474382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (writeProgramToFile(TestModuleBC.str(), ToCodeGen)) { 97574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << TestModuleBC.str() 97674382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 977a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 978a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 979a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete ToCodeGen; 980a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 981a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Make the shared library 98297182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path SafeModuleBC("bugpoint.safe.bc"); 98351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (SafeModuleBC.makeUnique(true, &ErrMsg)) { 98465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << getToolName() << "Error making unique filename: " 98565f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 98651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 98751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 98897182985d530dbef488696c95a39c14fe56c995bReid Spencer 98974382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (writeProgramToFile(SafeModuleBC.str(), ToNotCodeGen)) { 99074382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << SafeModuleBC.str() 99174382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 992a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 993a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 99422ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky std::string SharedObject = compileSharedObject(SafeModuleBC.str(), *Error); 99522ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky if (!Error->empty()) 99622ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky return true; 997a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete ToNotCodeGen; 998a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 999ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "You can reproduce the problem with the command line: \n"; 1000a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (isExecutingJIT()) { 100174382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " lli -load " << SharedObject << " " << TestModuleBC.str(); 1002a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } else { 10038d0e1bcc921c942e979b0925051c663590bd618fNick Lewycky outs() << " llc " << TestModuleBC.str() << " -o " << TestModuleBC.str() 100474382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << ".s\n"; 100574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " gcc " << SharedObject << " " << TestModuleBC.str() 100674382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << ".s -o " << TestModuleBC.str() << ".exe"; 100759615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#if defined (HAVE_LINK_R) 1008ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " -Wl,-R."; 100959615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#endif 1010ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n"; 101174382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " " << TestModuleBC.str() << ".exe"; 1012a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 101322ff748712b348300e51248339b6e8cf9b59e2c6Nick Lewycky for (unsigned i = 0, e = InputArgv.size(); i != e; ++i) 1014ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " " << InputArgv[i]; 1015ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 1016ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "The shared object was created with:\n llc -march=c " 101774382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << SafeModuleBC.str() << " -o temporary.c\n" 1018ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar << " gcc -xc temporary.c -O2 -o " << SharedObject; 1019ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar if (TargetTriple.getArch() == Triple::sparc) 1020ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -G"; // Compile a shared library, `-G' for Sparc 1021ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar else 1022ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -fPIC -shared"; // `-shared' for Linux/X86, maybe others 1023ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar 1024ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -fno-strict-aliasing\n"; 1025a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 1026a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return false; 1027a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 1028