Miscompilation.cpp revision ac53a0b272452013124bfc70480aea5e41b60f40
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" 25a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner#include "llvm/Support/Mangler.h" 26640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner#include "llvm/Transforms/Utils/Cloning.h" 27551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/CommandLine.h" 28551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/FileUtilities.h" 2959615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#include "llvm/Config/config.h" // for HAVE_LINK_R 30fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattnerusing namespace llvm; 314a10645c70199c8d8567fbc46312158c419720abChris Lattner 32a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnernamespace llvm { 3368ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar extern cl::opt<std::string> OutputPrefix; 34a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner extern cl::list<std::string> InputArgv; 35a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 36a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 37efdc0b505712d1ca4460def27e51c430f033d58dChris Lattnernamespace { 38dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer static llvm::cl::opt<bool> 39dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer DisableLoopExtraction("disable-loop-extraction", 40dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer cl::desc("Don't extract loops when searching for miscompilations"), 41dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer cl::init(false)); 42265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin static llvm::cl::opt<bool> 43265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin DisableBlockExtraction("disable-block-extraction", 44265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin cl::desc("Don't extract blocks when searching for miscompilations"), 45265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin cl::init(false)); 46dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer 47fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner class ReduceMiscompilingPasses : public ListReducer<const PassInfo*> { 48fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner BugDriver &BD; 49fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner public: 50fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner ReduceMiscompilingPasses(BugDriver &bd) : BD(bd) {} 513da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 52fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner virtual TestResult doTest(std::vector<const PassInfo*> &Prefix, 53fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner std::vector<const PassInfo*> &Suffix); 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, 6206943add8b2b764e131979cca064eda9f28826c9Chris Lattner std::vector<const PassInfo*> &Suffix) { 6306943add8b2b764e131979cca064eda9f28826c9Chris Lattner // First, run the program with just the Suffix passes. If it is still broken 64640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // with JUST the kept passes, discard the prefix passes. 65ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Suffix) 66ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "' compiles correctly: "; 67640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 688ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif std::string BitcodeResult; 698ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Suffix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 7065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 7165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 725ef681c19de9c675a265211f8fb0ae49cc3a3a66Chris Lattner BD.setPassesToRun(Suffix); 738ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 74025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 75640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 769adc0abad3c3ed40a268ccbcee0c74cb9e1359feOwen Anderson 77640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Check to see if the finished program matches the reference output... 788ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.diffProgram(BitcodeResult, "", true /*delete bitcode*/)) { 79ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 8059615f0f85e2ac99e012cb81934d002faebd405aChris Lattner if (Suffix.empty()) { 8165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": I'm confused: the test fails when " 8265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << "no passes are run, nondeterministic program?\n"; 8359615f0f85e2ac99e012cb81934d002faebd405aChris Lattner exit(1); 8459615f0f85e2ac99e012cb81934d002faebd405aChris Lattner } 85123f8fec94d1f22d876382897231868c62f8eabbMisha Brukman return KeepSuffix; // Miscompilation detected! 86640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 87ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 88640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 89640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner if (Prefix.empty()) return NoFailure; 90640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 9106943add8b2b764e131979cca064eda9f28826c9Chris Lattner // Next, see if the program is broken if we run the "prefix" passes first, 92bc0e998c497446f5448425b3cbd7f8f19a458764Misha Brukman // then separately run the "kept" passes. 93ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Prefix) 94ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "' compiles correctly: "; 95640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 96640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // If it is not broken with the kept passes, it's possible that the prefix 97640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // passes must be run before the kept passes to break it. If the program 98640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // WORKS after the prefix passes, but then fails if running the prefix AND 998ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // kept passes, we can update our bitcode file to include the result of the 100640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // prefix passes, then discard the prefix passes. 101640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // 1028ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Prefix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 10365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 10465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 1059c6cfe1bffd37f29a265457b7515839c445b3e6aChris Lattner BD.setPassesToRun(Prefix); 1068ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 107025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 108640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 109640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 110640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // If the prefix maintains the predicate by itself, only keep the prefix! 1118ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.diffProgram(BitcodeResult)) { 112ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 1138ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeResult).eraseFromDisk(); 114640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner return KeepPrefix; 115640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 116ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 117640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 118640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Ok, so now we know that the prefix passes work, try running the suffix 119640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // passes on the result of the prefix passes. 120640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // 1218b477ed579794ba6d76915d56b3f448a7dd20120Owen Anderson Module *PrefixOutput = ParseInputFile(BitcodeResult, BD.getContext()); 122640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner if (PrefixOutput == 0) { 12365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error reading bitcode file '" 12465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << BitcodeResult << "'!\n"; 125640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner exit(1); 126640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 1278ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeResult).eraseFromDisk(); // No longer need the file on disk 128f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner 129f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner // Don't check if there are no passes in the suffix. 130f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner if (Suffix.empty()) 131f4789e6d04c1fddb40092a1193c4a5eb67387accChris Lattner return NoFailure; 1323da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 133ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if '" << getPassesString(Suffix) 134640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner << "' passes compile correctly after the '" 135640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner << getPassesString(Prefix) << "' passes: "; 136640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 137efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner Module *OriginalInput = BD.swapProgramIn(PrefixOutput); 1388ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.runPasses(Suffix, BitcodeResult, false/*delete*/, true/*quiet*/)) { 13965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Error running this sequence of passes" 14065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " on the input program!\n"; 1415ef681c19de9c675a265211f8fb0ae49cc3a3a66Chris Lattner BD.setPassesToRun(Suffix); 1428ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BD.EmitProgressBitcode("pass-error", false); 143025262692a6710de29a48e2b3905672cd12d13d2Chris Lattner exit(BD.debugOptimizerCrash()); 144640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 145640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 146640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Run the result... 1478ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BD.diffProgram(BitcodeResult, "", true/*delete bitcode*/)) { 148ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " nope.\n"; 149640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner delete OriginalInput; // We pruned down the original input... 15006943add8b2b764e131979cca064eda9f28826c9Chris Lattner return KeepSuffix; 151640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner } 152640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 153640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Otherwise, we must not be running the bad pass anymore. 154ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " yup.\n"; // No miscompilation! 155efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner delete BD.swapProgramIn(OriginalInput); // Restore orig program & free test 156640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner return NoFailure; 157640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner} 158640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 159efdc0b505712d1ca4460def27e51c430f033d58dChris Lattnernamespace { 160fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner class ReduceMiscompilingFunctions : public ListReducer<Function*> { 161fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner BugDriver &BD; 162b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner bool (*TestFn)(BugDriver &, Module *, Module *); 163fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner public: 164b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ReduceMiscompilingFunctions(BugDriver &bd, 165b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner bool (*F)(BugDriver &, Module *, Module *)) 166b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner : BD(bd), TestFn(F) {} 1673da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 168fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner virtual TestResult doTest(std::vector<Function*> &Prefix, 169fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner std::vector<Function*> &Suffix) { 170be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner if (!Suffix.empty() && TestFuncs(Suffix)) 171fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner return KeepSuffix; 172be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner if (!Prefix.empty() && TestFuncs(Prefix)) 173fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner return KeepPrefix; 174fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner return NoFailure; 175fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner } 1763da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 177be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner bool TestFuncs(const std::vector<Function*> &Prefix); 178fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner }; 179fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 180640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 181efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner/// TestMergedProgram - Given two modules, link them together and run the 182efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner/// program, checking to see if the program matches the diff. If the diff 183a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// matches, return false, otherwise return true. If the DeleteInputs argument 184a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// is set to true then this function deletes both input modules before it 185a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// returns. 1868c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 187a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattnerstatic bool TestMergedProgram(BugDriver &BD, Module *M1, Module *M2, 188a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner bool DeleteInputs) { 189efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // Link the two portions of the program back to together. 190efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner std::string ErrorMsg; 19190c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner if (!DeleteInputs) { 19290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner M1 = CloneModule(M1); 19390c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner M2 = CloneModule(M2); 19490c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner } 195e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(M1, M2, &ErrorMsg)) { 19665f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 19765f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 198efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner exit(1); 199efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner } 20090c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete M2; // We are done with this module. 201efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 202efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner Module *OldProgram = BD.swapProgramIn(M1); 203efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 204efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // Execute the program. If it does not match the expected output, we must 205efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // return true. 206efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner bool Broken = BD.diffProgram(); 207efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 208efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner // Delete the linked module & restore the original 209a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner BD.swapProgramIn(OldProgram); 2105313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner delete M1; 211efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner return Broken; 212efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner} 213efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner 2148c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// TestFuncs - split functions in a Module into two groups: those that are 2158c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// under consideration for miscompilation vs. those that are not, and test 2168c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// accordingly. Each group of functions becomes a separate Module. 2178c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 218be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattnerbool ReduceMiscompilingFunctions::TestFuncs(const std::vector<Function*>&Funcs){ 219640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Test to see if the function is misoptimized if we ONLY run it on the 220640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // functions listed in Funcs. 221ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if the program is misoptimized when " 222ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (Funcs.size()==1 ? "this function is" : "these functions are") 223ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " run through the pass" 224ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (BD.getPassesToRun().size() == 1 ? "" : "es") << ":"; 225efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner PrintFunctionList(Funcs); 226ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 227640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 228be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner // Split the module into the two halves of the program we want. 229d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 230d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 231d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, Funcs, 232d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 233640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 2346fa98b13206583e6eb90b8304758b35548914944Nick Lewycky // Run the predicate, note that the predicate will delete both input modules. 235b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner return TestFn(BD, ToOptimize, ToNotOptimize); 236640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner} 237640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 2388c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// DisambiguateGlobalSymbols - Mangle symbols to guarantee uniqueness by 2398c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// modifying predominantly internal symbols rather than external ones. 2408c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 24136ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattnerstatic void DisambiguateGlobalSymbols(Module *M) { 24236ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // Try not to cause collisions by minimizing chances of renaming an 24336ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // already-external symbol, so take in external globals and functions as-is. 24436ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // The code should work correctly without disambiguation (assuming the same 24536ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // mangler is used by the two code generators), but having symbols with the 24636ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // same name causes warnings to be emitted by the code generator. 24736ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner Mangler Mang(*M); 2480fccc74103dee95d6baa885963b7337ae5daec7eAndrew Lenharth // Agree with the CBE on symbol naming 2490fccc74103dee95d6baa885963b7337ae5daec7eAndrew Lenharth Mang.markCharUnacceptable('.'); 25067ef9e43049c28c8fe2c9f70d2ad163045ee5876Chris Lattner for (Module::global_iterator I = M->global_begin(), E = M->global_end(); 2519d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner I != E; ++I) { 2529d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner // Don't mangle asm names. 2539d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner if (!I->hasName() || I->getName()[0] != 1) 2549d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner I->setName(Mang.getMangledName(I)); 2559d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner } 2569d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) { 2574285d15703d4282cccb1e311b798917abd06beafChris Lattner // Don't mangle asm names or intrinsics. 258e0d5c17921ddcdfce0fbfd7dd5dd993acb56304cChris Lattner if ((!I->hasName() || I->getName()[0] != 1) && 259e0d5c17921ddcdfce0fbfd7dd5dd993acb56304cChris Lattner I->getIntrinsicID() == 0) 2609d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner I->setName(Mang.getMangledName(I)); 2619d5511b7db2c42a2cea0ca00c0e123e64cceadaeChris Lattner } 26236ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner} 26336ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner 264a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// ExtractLoops - Given a reduced list of functions that still exposed the bug, 265a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// check to see if we can extract the loops in the region without obscuring the 266a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner/// bug. If so, it reduces the amount of code identified. 2678c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 268b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerstatic bool ExtractLoops(BugDriver &BD, 269b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner bool (*TestFn)(BugDriver &, Module *, Module *), 270a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner std::vector<Function*> &MiscompiledFunctions) { 271a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner bool MadeChange = false; 272a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner while (1) { 273aed98fa8861a28e5f7ba7c0659e106f2a441e9ffChris Lattner if (BugpointIsInterrupted) return MadeChange; 274aed98fa8861a28e5f7ba7c0659e106f2a441e9ffChris Lattner 275d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 276d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 277a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 278d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 279d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 280a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner Module *ToOptimizeLoopExtracted = BD.ExtractLoop(ToOptimize); 281a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner if (!ToOptimizeLoopExtracted) { 282a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // If the loop extractor crashed or if there were no extractible loops, 283a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // then this chapter of our odyssey is over with. 284a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToNotOptimize; 285a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToOptimize; 286a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 287a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 288a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 28965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Extracted a loop from the breaking portion of the program.\n"; 290a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 291a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Bugpoint is intentionally not very trusting of LLVM transformations. In 292a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // particular, we're not going to assume that the loop extractor works, so 293a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // we're going to test the newly loop extracted program to make sure nothing 294a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // has broken. If something broke, then we'll inform the user and stop 295a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extraction. 29670ef449741da8b1ef035e04a55958652a0200ba1Dan Gohman AbstractInterpreter *AI = BD.switchToSafeInterpreter(); 297a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner if (TestMergedProgram(BD, ToOptimizeLoopExtracted, ToNotOptimize, false)) { 298a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner BD.switchToInterpreter(AI); 299a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 300a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Merged program doesn't work anymore! 30165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " *** ERROR: Loop extraction broke the program. :(" 30265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " Please report a bug!\n"; 30365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << " Continuing on with un-loop-extracted version.\n"; 30456c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner 30568ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-tno.bc", 30668ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar ToNotOptimize); 30768ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to.bc", 30868ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar ToOptimize); 30968ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar BD.writeProgramToFile(OutputPrefix + "-loop-extract-fail-to-le.bc", 31056c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner ToOptimizeLoopExtracted); 31156c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner 31268ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar errs() << "Please submit the " 31368ccdaa84909108c42417a8091c771598e26456eDaniel Dunbar << OutputPrefix << "-loop-extract-fail-*.bc files.\n"; 31456c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner delete ToOptimize; 315a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToNotOptimize; 316a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner delete ToOptimizeLoopExtracted; 317a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 318a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 31956c418676a308034e5eecf10d3f96ced2d1fab24Chris Lattner delete ToOptimize; 320a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner BD.switchToInterpreter(AI); 3213da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 322ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Testing after loop extraction:\n"; 323b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Clone modules, the tester function will free them. 324b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *TOLEBackup = CloneModule(ToOptimizeLoopExtracted); 325b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *TNOBackup = CloneModule(ToNotOptimize); 326b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner if (!TestFn(BD, ToOptimizeLoopExtracted, ToNotOptimize)) { 327ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "*** Loop extraction masked the problem. Undoing.\n"; 328a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // If the program is not still broken, then loop extraction did something 329a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // that masked the error. Stop loop extraction now. 330b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete TOLEBackup; 331b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete TNOBackup; 332a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner return MadeChange; 333a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 334b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToOptimizeLoopExtracted = TOLEBackup; 335b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToNotOptimize = TNOBackup; 336b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 337ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "*** Loop extraction successful!\n"; 338a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 33990c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions; 34090c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (Module::iterator I = ToOptimizeLoopExtracted->begin(), 34190c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner E = ToOptimizeLoopExtracted->end(); I != E; ++I) 3425cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 343fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner MisCompFunctions.push_back(std::make_pair(I->getName(), 344fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner I->getFunctionType())); 34590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner 346a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Okay, great! Now we know that we extracted a loop and that loop 347a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extraction both didn't break the program, and didn't mask the problem. 348a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Replace the current program with the loop extracted version, and try to 349a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // extract another loop. 350a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner std::string ErrorMsg; 351e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(ToNotOptimize, ToOptimizeLoopExtracted, &ErrorMsg)){ 35265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 35365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 354a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner exit(1); 355a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 35690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete ToOptimizeLoopExtracted; 357d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner 358d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner // All of the Function*'s in the MiscompiledFunctions list are in the old 3595313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner // module. Update this list to include all of the functions in the 3605313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner // optimized and loop extracted module. 3615313f23b8c3d22a2028beb731c60fc1a25beb149Chris Lattner MiscompiledFunctions.clear(); 36290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) { 363ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer Function *NewF = ToNotOptimize->getFunction(MisCompFunctions[i].first); 364ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer 36590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner assert(NewF && "Function not found??"); 366ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer assert(NewF->getFunctionType() == MisCompFunctions[i].second && 367ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer "found wrong function type?"); 36890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner MiscompiledFunctions.push_back(NewF); 369d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner } 370d3a533d94dae1e57194001af08763eb3ba199c8fChris Lattner 371a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner BD.setNewProgram(ToNotOptimize); 372a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner MadeChange = true; 373a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 374a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner} 375a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 3765e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattnernamespace { 3775e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner class ReduceMiscompiledBlocks : public ListReducer<BasicBlock*> { 3785e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner BugDriver &BD; 3795e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner bool (*TestFn)(BugDriver &, Module *, Module *); 3805e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<Function*> FunctionsBeingTested; 3815e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner public: 3825e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner ReduceMiscompiledBlocks(BugDriver &bd, 3835e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner bool (*F)(BugDriver &, Module *, Module *), 3845e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner const std::vector<Function*> &Fns) 3855e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner : BD(bd), TestFn(F), FunctionsBeingTested(Fns) {} 3863da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 3875e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner virtual TestResult doTest(std::vector<BasicBlock*> &Prefix, 3885e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<BasicBlock*> &Suffix) { 3895e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner if (!Suffix.empty() && TestFuncs(Suffix)) 3905e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return KeepSuffix; 3915e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner if (TestFuncs(Prefix)) 3925e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return KeepPrefix; 3935e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return NoFailure; 3945e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 3953da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 3965e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner bool TestFuncs(const std::vector<BasicBlock*> &Prefix); 3975e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner }; 3985e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 3995e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4005e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// TestFuncs - Extract all blocks for the miscompiled functions except for the 4015e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// specified blocks. If the problem still exists, return true. 4025e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// 4035e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattnerbool ReduceMiscompiledBlocks::TestFuncs(const std::vector<BasicBlock*> &BBs) { 4045e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Test to see if the function is misoptimized if we ONLY run it on the 4055e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // functions listed in Funcs. 406ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Checking to see if the program is misoptimized when all "; 40768bee938e539d884ee89ce4dfebbad777896960eChris Lattner if (!BBs.empty()) { 408ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "but these " << BBs.size() << " blocks are extracted: "; 40968bee938e539d884ee89ce4dfebbad777896960eChris Lattner for (unsigned i = 0, e = BBs.size() < 10 ? BBs.size() : 10; i != e; ++i) 410ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << BBs[i]->getName() << " "; 411ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman if (BBs.size() > 10) outs() << "..."; 41268bee938e539d884ee89ce4dfebbad777896960eChris Lattner } else { 413ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "blocks are extracted."; 41468bee938e539d884ee89ce4dfebbad777896960eChris Lattner } 415ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 4165e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4175e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Split the module into the two halves of the program we want. 418d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 419d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(BD.getProgram(), ValueMap); 4205e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 421d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman FunctionsBeingTested, 422d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 4235e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4245e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Try the extraction. If it doesn't work, then the block extractor crashed 4255e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // or something, in which case bugpoint can't chase down this possibility. 4265e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner if (Module *New = BD.ExtractMappedBlocksFromModule(BBs, ToOptimize)) { 4275e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToOptimize; 4285e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Run the predicate, not that the predicate will delete both input modules. 4295e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return TestFn(BD, New, ToNotOptimize); 4305e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 4315e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToOptimize; 4325e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner delete ToNotOptimize; 4335e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner return false; 4345e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 4355e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4365e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4375e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// ExtractBlocks - Given a reduced list of functions that still expose the bug, 4385e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// extract as many basic blocks from the region as possible without obscuring 4395e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// the bug. 4405e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner/// 4415e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattnerstatic bool ExtractBlocks(BugDriver &BD, 4425e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner bool (*TestFn)(BugDriver &, Module *, Module *), 4435e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<Function*> &MiscompiledFunctions) { 444f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (BugpointIsInterrupted) return false; 445f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner 4465e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner std::vector<BasicBlock*> Blocks; 4475e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner for (unsigned i = 0, e = MiscompiledFunctions.size(); i != e; ++i) 4485e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner for (Function::iterator I = MiscompiledFunctions[i]->begin(), 4495e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner E = MiscompiledFunctions[i]->end(); I != E; ++I) 4505e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner Blocks.push_back(I); 4515e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4525e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Use the list reducer to identify blocks that can be extracted without 4535e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // obscuring the bug. The Blocks list will end up containing blocks that must 4545e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // be retained from the original program. 4555e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner unsigned OldSize = Blocks.size(); 45668bee938e539d884ee89ce4dfebbad777896960eChris Lattner 45768bee938e539d884ee89ce4dfebbad777896960eChris Lattner // Check to see if all blocks are extractible first. 45868bee938e539d884ee89ce4dfebbad777896960eChris Lattner if (ReduceMiscompiledBlocks(BD, TestFn, 45968bee938e539d884ee89ce4dfebbad777896960eChris Lattner MiscompiledFunctions).TestFuncs(std::vector<BasicBlock*>())) { 46068bee938e539d884ee89ce4dfebbad777896960eChris Lattner Blocks.clear(); 46168bee938e539d884ee89ce4dfebbad777896960eChris Lattner } else { 46268bee938e539d884ee89ce4dfebbad777896960eChris Lattner ReduceMiscompiledBlocks(BD, TestFn,MiscompiledFunctions).reduceList(Blocks); 46368bee938e539d884ee89ce4dfebbad777896960eChris Lattner if (Blocks.size() == OldSize) 46468bee938e539d884ee89ce4dfebbad777896960eChris Lattner return false; 46568bee938e539d884ee89ce4dfebbad777896960eChris Lattner } 4665e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 467d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 468d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ProgClone = CloneModule(BD.getProgram(), ValueMap); 4692290e754061f1393bb96b1808ac33dc03399c939Chris Lattner Module *ToExtract = SplitFunctionsOutOfModule(ProgClone, 470d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 471d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 4722290e754061f1393bb96b1808ac33dc03399c939Chris Lattner Module *Extracted = BD.ExtractMappedBlocksFromModule(Blocks, ToExtract); 4732290e754061f1393bb96b1808ac33dc03399c939Chris Lattner if (Extracted == 0) { 474da895d63377b421dc50117befb2bec80d2973526Chris Lattner // Weird, extraction should have worked. 47565f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Nondeterministic problem extracting blocks??\n"; 4762290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ProgClone; 4772290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ToExtract; 4782290e754061f1393bb96b1808ac33dc03399c939Chris Lattner return false; 4792290e754061f1393bb96b1808ac33dc03399c939Chris Lattner } 4805e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 4812290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Otherwise, block extraction succeeded. Link the two program fragments back 4822290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // together. 4832290e754061f1393bb96b1808ac33dc03399c939Chris Lattner delete ToExtract; 4845e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 48590c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner std::vector<std::pair<std::string, const FunctionType*> > MisCompFunctions; 48690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (Module::iterator I = Extracted->begin(), E = Extracted->end(); 48790c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner I != E; ++I) 4885cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 489fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner MisCompFunctions.push_back(std::make_pair(I->getName(), 490fa1af1344910ee975f50ffdddf605c26f80ef016Chris Lattner I->getFunctionType())); 49190c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner 4922290e754061f1393bb96b1808ac33dc03399c939Chris Lattner std::string ErrorMsg; 493e4874029c37c4b14d0646289f18e5f2a1b03fdc2Reid Spencer if (Linker::LinkModules(ProgClone, Extracted, &ErrorMsg)) { 49465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << ": Error linking modules together:" 49565f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrorMsg << '\n'; 4962290e754061f1393bb96b1808ac33dc03399c939Chris Lattner exit(1); 4972290e754061f1393bb96b1808ac33dc03399c939Chris Lattner } 49890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner delete Extracted; 4995e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5002290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Set the new program and delete the old one. 5012290e754061f1393bb96b1808ac33dc03399c939Chris Lattner BD.setNewProgram(ProgClone); 5025e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5032290e754061f1393bb96b1808ac33dc03399c939Chris Lattner // Update the list of miscompiled functions. 5042290e754061f1393bb96b1808ac33dc03399c939Chris Lattner MiscompiledFunctions.clear(); 5055e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 50690c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner for (unsigned i = 0, e = MisCompFunctions.size(); i != e; ++i) { 507ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer Function *NewF = ProgClone->getFunction(MisCompFunctions[i].first); 50890c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner assert(NewF && "Function not found??"); 509ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer assert(NewF->getFunctionType() == MisCompFunctions[i].second && 510ef9b9a793949469cdaa4ab6d0173136229dcab7bReid Spencer "Function has wrong type??"); 51190c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner MiscompiledFunctions.push_back(NewF); 51290c18c5c69d9c451e5fdca1e4b4b95e8ed13291aChris Lattner } 5132290e754061f1393bb96b1808ac33dc03399c939Chris Lattner 5142290e754061f1393bb96b1808ac33dc03399c939Chris Lattner return true; 5155e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner} 5165e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5175e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 518b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// DebugAMiscompilation - This is a generic driver to narrow down 519b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// miscompilations, either in an optimization or a code generator. 5208c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 521b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerstatic std::vector<Function*> 522b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris LattnerDebugAMiscompilation(BugDriver &BD, 523b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner bool (*TestFn)(BugDriver &, Module *, Module *)) { 524640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Okay, now that we have reduced the list of passes which are causing the 525640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // failure, see if we can pin down which functions are being 526640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // miscompiled... first build a list of all of the non-external functions in 527640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // the program. 528640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner std::vector<Function*> MiscompiledFunctions; 529b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *Prog = BD.getProgram(); 530b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner for (Module::iterator I = Prog->begin(), E = Prog->end(); I != E; ++I) 5315cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!I->isDeclaration()) 532640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner MiscompiledFunctions.push_back(I); 5334a10645c70199c8d8567fbc46312158c419720abChris Lattner 534640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner // Do the reduction... 535f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!BugpointIsInterrupted) 536f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions); 537640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner 538ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** The following function" 539ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 540ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " being miscompiled: "; 541640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner PrintFunctionList(MiscompiledFunctions); 542ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 5434a10645c70199c8d8567fbc46312158c419720abChris Lattner 544a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // See if we can rip any loops out of the miscompiled functions and still 545a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // trigger the problem. 546dc31a8a70cab3b4c180ac1a482855e31d3fe8e6bReid Spencer 5472803b4cc581af06bf99af5ddc3353836c63d1562Reid Spencer if (!BugpointIsInterrupted && !DisableLoopExtraction && 5482803b4cc581af06bf99af5ddc3353836c63d1562Reid Spencer ExtractLoops(BD, TestFn, MiscompiledFunctions)) { 549a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Okay, we extracted some loops and the problem still appears. See if we 550a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // can eliminate some of the created functions from being candidates. 551a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 55236ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // Loop extraction can introduce functions with the same name (foo_code). 55336ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // Make sure to disambiguate the symbols so that when the program is split 5545e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // apart that we can link it back together again. 5555e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner DisambiguateGlobalSymbols(BD.getProgram()); 5565e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5575e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Do the reduction... 558f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!BugpointIsInterrupted) 559f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions); 5603da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 561ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** The following function" 562ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 563ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " being miscompiled: "; 5645e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner PrintFunctionList(MiscompiledFunctions); 565ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 5665e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner } 5675e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 568265d82e4c68fa30b7ff1cb650456249f7068bdd6David Goodwin if (!BugpointIsInterrupted && !DisableBlockExtraction && 569aed98fa8861a28e5f7ba7c0659e106f2a441e9ffChris Lattner ExtractBlocks(BD, TestFn, MiscompiledFunctions)) { 5705e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Okay, we extracted some blocks and the problem still appears. See if we 5715e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // can eliminate some of the created functions from being candidates. 5725e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner 5735e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Block extraction can introduce functions with the same name (foo_code). 5745e783ab0b5fc3407ec59f1a598fdb9ef3b96b287Chris Lattner // Make sure to disambiguate the symbols so that when the program is split 57536ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner // apart that we can link it back together again. 57636ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner DisambiguateGlobalSymbols(BD.getProgram()); 57736ee07ff9d26a2c6ebf9faf9ba90923644db29c5Chris Lattner 578a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner // Do the reduction... 579b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ReduceMiscompilingFunctions(BD, TestFn).reduceList(MiscompiledFunctions); 5803da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 581ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** The following function" 582ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (MiscompiledFunctions.size() == 1 ? " is" : "s are") 583ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << " being miscompiled: "; 584a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner PrintFunctionList(MiscompiledFunctions); 585ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 586a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner } 587a1cf1c8c87f10f12343ff6ae75f332390e7205abChris Lattner 588b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner return MiscompiledFunctions; 589b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner} 590b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 591a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// TestOptimizer - This is the predicate function used to check to see if the 592a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// "Test" portion of the program is misoptimized. If so, return true. In any 593a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// case, both module arguments are deleted. 5948c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 595b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerstatic bool TestOptimizer(BugDriver &BD, Module *Test, Module *Safe) { 596b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Run the optimization passes on ToOptimize, producing a transformed version 597b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // of the functions being tested. 598ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Optimizing functions being tested: "; 599b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner Module *Optimized = BD.runPassesOn(Test, BD.getPassesToRun(), 600b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner /*AutoDebugCrashes*/true); 601ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "done.\n"; 602b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner delete Test; 603b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 604ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Checking to see if the merged program executes correctly: "; 6052423db0e8577e769ac5ad4e567808e43daf37945Chris Lattner bool Broken = TestMergedProgram(BD, Optimized, Safe, true); 606ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << (Broken ? " nope.\n" : " yup.\n"); 607b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner return Broken; 608b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner} 609b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 610b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 611b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// debugMiscompilation - This method is used when the passes selected are not 612b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// crashing, but the generated output is semantically different from the 613b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// input. 614b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner/// 615b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattnerbool BugDriver::debugMiscompilation() { 616b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner // Make sure something was miscompiled... 617f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!BugpointIsInterrupted) 618f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner if (!ReduceMiscompilingPasses(*this).reduceList(PassesToRun)) { 61965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "*** Optimized program matches reference output! No problem" 62065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << " detected...\nbugpoint can't help you with your problem!\n"; 621f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner return false; 622f9aaae06cd2109082cda2b09ef3f23e0e1cff47bChris Lattner } 623b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 624ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** Found miscompiling pass" 625ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << (getPassesToRun().size() == 1 ? "" : "es") << ": " 626ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << getPassesString(getPassesToRun()) << '\n'; 6278ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("passinput"); 628b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 629b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner std::vector<Function*> MiscompiledFunctions = 630b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner DebugAMiscompilation(*this, TestOptimizer); 631b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner 6328ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Output a bunch of bitcode files for the user... 633ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Outputting reduced bitcode files which expose the problem:\n"; 634d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 635d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotOptimize = CloneModule(getProgram(), ValueMap); 636efdc0b505712d1ca4460def27e51c430f033d58dChris Lattner Module *ToOptimize = SplitFunctionsOutOfModule(ToNotOptimize, 637d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman MiscompiledFunctions, 638d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman ValueMap); 639be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner 640ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Non-optimized portion: "; 641b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToNotOptimize = swapProgramIn(ToNotOptimize); 6428ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("tonotoptimize", true); 643be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner setNewProgram(ToNotOptimize); // Delete hacked module. 6443da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 645ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " Portion that is input to optimizer: "; 646b15825b0a29e527b361b63a6e41aff5fdb8fdd5aChris Lattner ToOptimize = swapProgramIn(ToOptimize); 6478ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif EmitProgressBitcode("tooptimize"); 648be21ca54e08339ede5dd4bbb882182d22e274988Chris Lattner setNewProgram(ToOptimize); // Delete hacked module. 6494a10645c70199c8d8567fbc46312158c419720abChris Lattner 6504a10645c70199c8d8567fbc46312158c419720abChris Lattner return false; 6514a10645c70199c8d8567fbc46312158c419720abChris Lattner} 652d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 653a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// CleanupAndPrepareModules - Get the specified modules ready for code 654a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// generator testing. 6558c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 656a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnerstatic void CleanupAndPrepareModules(BugDriver &BD, Module *&Test, 657a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Module *Safe) { 658a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Clean up the modules, removing extra cruft that we don't need anymore... 659a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Test = BD.performFinalCleanups(Test); 660a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 661a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // If we are executing the JIT, we have several nasty issues to take care of. 662a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (!BD.isExecutingJIT()) return; 663a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 664a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // First, if the main function is in the Safe module, we must add a stub to 665a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // the Test module to call into it. Thus, we create a new function `main' 666a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // which just calls the old one. 667688b0490e22eb67623f5aaa24406209be74efcb2Reid Spencer if (Function *oldMain = Safe->getFunction("main")) 6685cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (!oldMain->isDeclaration()) { 669a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Rename it 670a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner oldMain->setName("llvm_bugpoint_old_main"); 671a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Create a NEW `main' function with same type in the test module. 672051a950000e21935165db56695e35bade668193bGabor Greif Function *newMain = Function::Create(oldMain->getFunctionType(), 673051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::ExternalLinkage, 674051a950000e21935165db56695e35bade668193bGabor Greif "main", Test); 675a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Create an `oldmain' prototype in the test module, which will 676a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // corresponds to the real main function in the same module. 677051a950000e21935165db56695e35bade668193bGabor Greif Function *oldMainProto = Function::Create(oldMain->getFunctionType(), 678051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::ExternalLinkage, 679051a950000e21935165db56695e35bade668193bGabor Greif oldMain->getName(), Test); 680a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Set up and remember the argument list for the main function. 681a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner std::vector<Value*> args; 6825a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos for (Function::arg_iterator 6835a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos I = newMain->arg_begin(), E = newMain->arg_end(), 6845a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos OI = oldMain->arg_begin(); I != E; ++I, ++OI) { 6856bc41e8a74d1756da0003641bfebd02a3d6d9586Owen Anderson I->setName(OI->getName()); // Copy argument names from oldMain 686a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner args.push_back(I); 687a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 688a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 689a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Call the old main function and return its result 6901d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *BB = BasicBlock::Create(Safe->getContext(), "entry", newMain); 691051a950000e21935165db56695e35bade668193bGabor Greif CallInst *call = CallInst::Create(oldMainProto, args.begin(), args.end(), 692051a950000e21935165db56695e35bade668193bGabor Greif "", BB); 6933da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 694a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // If the type of old function wasn't void, return value of call 6951d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(Safe->getContext(), call, BB); 696a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 697a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 698a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // The second nasty issue we must deal with in the JIT is that the Safe 699a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // module cannot directly reference any functions defined in the test 700a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // module. Instead, we use a JIT API call to dynamically resolve the 701a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // symbol. 7023da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 703a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Add the resolver to the Safe module. 704a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Prototype: void *getPointerToNamedFunction(const char* Name) 7052db43c864e8372823d961d961ca520ed20edca82Chris Lattner Constant *resolverFunc = 706a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner Safe->getOrInsertFunction("getPointerToNamedFunction", 707ac53a0b272452013124bfc70480aea5e41b60f40Duncan Sands Type::getInt8PtrTy(Safe->getContext()), 708ac53a0b272452013124bfc70480aea5e41b60f40Duncan Sands Type::getInt8PtrTy(Safe->getContext()), 7091d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson (Type *)0); 7103da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 711a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Use the function we just added to get addresses of functions we need. 712dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman for (Module::iterator F = Safe->begin(), E = Safe->end(); F != E; ++F) { 7135cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (F->isDeclaration() && !F->use_empty() && &*F != resolverFunc && 714a3355ffb3d30d19d226bbb75707991c60f236e37Duncan Sands !F->isIntrinsic() /* ignore intrinsics */) { 715688b0490e22eb67623f5aaa24406209be74efcb2Reid Spencer Function *TestFn = Test->getFunction(F->getName()); 716a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 717a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Don't forward functions which are external in the test module too. 7185cbf985dcbc89fba3208e7baf8b6f488b06d3ec9Reid Spencer if (TestFn && !TestFn->isDeclaration()) { 719a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // 1. Add a string constant with its name to the global file 7201d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson Constant *InitArray = ConstantArray::get(F->getContext(), F->getName()); 721a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner GlobalVariable *funcName = 722e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson new GlobalVariable(*Safe, InitArray->getType(), true /*isConstant*/, 7233da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman GlobalValue::InternalLinkage, InitArray, 724e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson F->getName() + "_name"); 725a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 726a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // 2. Use `GetElementPtr *funcName, 0, 0' to convert the string to an 727a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // sbyte* so it matches the signature of the resolver function. 728a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 729a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // GetElementPtr *funcName, ulong 0, ulong 0 7301d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson std::vector<Constant*> GEPargs(2, 7311d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson Constant::getNullValue(Type::getInt32Ty(F->getContext()))); 7329adc0abad3c3ed40a268ccbcee0c74cb9e1359feOwen Anderson Value *GEP = 733baf3c404409d5e47b13984a7f95bfbd6d1f2e79eOwen Anderson ConstantExpr::getGetElementPtr(funcName, &GEPargs[0], 2); 734a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner std::vector<Value*> ResolverArgs; 735a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner ResolverArgs.push_back(GEP); 736a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 737de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Rewrite uses of F in global initializers, etc. to uses of a wrapper 738de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // function that dynamically resolves the calls to F via our JIT API 739a3efca16f2688981672deeb718909cf6acbe474eChris Lattner if (!F->use_empty()) { 740a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Create a new global to hold the cached function pointer. 7419e9a0d5fc26878e51a58a8b57900fcbf952c2691Owen Anderson Constant *NullPtr = ConstantPointerNull::get(F->getType()); 742a3efca16f2688981672deeb718909cf6acbe474eChris Lattner GlobalVariable *Cache = 743e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson new GlobalVariable(*F->getParent(), F->getType(), 744e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson false, GlobalValue::InternalLinkage, 745e9b11b431308f4766b73cda93e38ec930c912122Owen Anderson NullPtr,F->getName()+".fpcache"); 74600b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 747de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Construct a new stub function that will re-route calls to F 748dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman const FunctionType *FuncTy = F->getFunctionType(); 749051a950000e21935165db56695e35bade668193bGabor Greif Function *FuncWrapper = Function::Create(FuncTy, 750051a950000e21935165db56695e35bade668193bGabor Greif GlobalValue::InternalLinkage, 751051a950000e21935165db56695e35bade668193bGabor Greif F->getName() + "_wrapper", 752051a950000e21935165db56695e35bade668193bGabor Greif F->getParent()); 7531d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *EntryBB = BasicBlock::Create(F->getContext(), 7541d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "entry", FuncWrapper); 7551d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *DoCallBB = BasicBlock::Create(F->getContext(), 7561d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "usecache", FuncWrapper); 7571d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson BasicBlock *LookupBB = BasicBlock::Create(F->getContext(), 7581d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson "lookupfp", FuncWrapper); 75900b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 760a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Check to see if we already looked up the value. 761a3efca16f2688981672deeb718909cf6acbe474eChris Lattner Value *CachedVal = new LoadInst(Cache, "fpcache", EntryBB); 762333c40096561218bc3597cf153c0a3895274414cOwen Anderson Value *IsNull = new ICmpInst(*EntryBB, ICmpInst::ICMP_EQ, CachedVal, 763333c40096561218bc3597cf153c0a3895274414cOwen Anderson NullPtr, "isNull"); 764051a950000e21935165db56695e35bade668193bGabor Greif BranchInst::Create(LookupBB, DoCallBB, IsNull, EntryBB); 76500b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 766de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Resolve the call to function F via the JIT API: 767de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // 768de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // call resolver(GetElementPtr...) 769b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CallInst *Resolver = 770b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CallInst::Create(resolverFunc, ResolverArgs.begin(), 771b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif ResolverArgs.end(), "resolver", LookupBB); 772b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif 773b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif // Cast the result from the resolver to correctly-typed function. 774b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif CastInst *CastedResolver = 775b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif new BitCastInst(Resolver, 776debcb01b0f0a15f568ca69e8f288fade4bfc7297Owen Anderson PointerType::getUnqual(F->getFunctionType()), 777b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif "resolverCast", LookupBB); 7783da59db637a887474c1b1346c1f3ccf53b6c4663Reid Spencer 779a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Save the value in our cache. 780a3efca16f2688981672deeb718909cf6acbe474eChris Lattner new StoreInst(CastedResolver, Cache, LookupBB); 781051a950000e21935165db56695e35bade668193bGabor Greif BranchInst::Create(DoCallBB, LookupBB); 78200b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 783b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif PHINode *FuncPtr = PHINode::Create(NullPtr->getType(), 784b1dbcd886a4b5597a839f299054b78b33fb2d6dfGabor Greif "fp", DoCallBB); 785a3efca16f2688981672deeb718909cf6acbe474eChris Lattner FuncPtr->addIncoming(CastedResolver, LookupBB); 786a3efca16f2688981672deeb718909cf6acbe474eChris Lattner FuncPtr->addIncoming(CachedVal, EntryBB); 78700b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 788a3efca16f2688981672deeb718909cf6acbe474eChris Lattner // Save the argument list. 789dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman std::vector<Value*> Args; 7905a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos for (Function::arg_iterator i = FuncWrapper->arg_begin(), 7915a1c58d0094ff16dcd103f3752046d426ad5dd2cAlkis Evlogimenos e = FuncWrapper->arg_end(); i != e; ++i) 792dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman Args.push_back(i); 793dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman 794dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman // Pass on the arguments to the real function, return its result 7951d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson if (F->getReturnType() == Type::getVoidTy(F->getContext())) { 796051a950000e21935165db56695e35bade668193bGabor Greif CallInst::Create(FuncPtr, Args.begin(), Args.end(), "", DoCallBB); 7971d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(F->getContext(), DoCallBB); 798dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } else { 799051a950000e21935165db56695e35bade668193bGabor Greif CallInst *Call = CallInst::Create(FuncPtr, Args.begin(), Args.end(), 800051a950000e21935165db56695e35bade668193bGabor Greif "retval", DoCallBB); 8011d0be15f89cb5056e20e2d24faa8d6afb1573bcaOwen Anderson ReturnInst::Create(F->getContext(),Call, DoCallBB); 802dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } 80300b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen 804de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman // Use the wrapper function instead of the old function 805de4803d0af6824a2d5da41fa09b512084c73ce34Misha Brukman F->replaceAllUsesWith(FuncWrapper); 806dc7fef83dcab053f86119d00478e6b008166fcf5Misha Brukman } 807a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 808a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 809a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 810a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 811a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (verifyModule(*Test) || verifyModule(*Safe)) { 81265f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << "Bugpoint has a bug, which corrupted a module!!\n"; 813a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner abort(); 814a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 815a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 816a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 817a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 818a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 819a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// TestCodeGenerator - This is the predicate function used to check to see if 820a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// the "Test" portion of the program is miscompiled by the code generator under 821a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner/// test. If so, return true. In any case, both module arguments are deleted. 8228c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 823a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnerstatic bool TestCodeGenerator(BugDriver &BD, Module *Test, Module *Safe) { 824a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner CleanupAndPrepareModules(BD, Test, Safe); 825a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 82697182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path TestModuleBC("bugpoint.test.bc"); 82751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 82851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (TestModuleBC.makeUnique(true, &ErrMsg)) { 82965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << "Error making unique filename: " 83065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 83151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 83251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 83374382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (BD.writeProgramToFile(TestModuleBC.str(), Test)) { 83474382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << TestModuleBC.str() 83574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 836a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 837a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 838a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete Test; 839a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 840a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Make the shared library 84197182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path SafeModuleBC("bugpoint.safe.bc"); 84251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (SafeModuleBC.makeUnique(true, &ErrMsg)) { 84365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << BD.getToolName() << "Error making unique filename: " 84465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 84551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 84651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 847a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 84874382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (BD.writeProgramToFile(SafeModuleBC.str(), Safe)) { 84974382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << SafeModuleBC.str() 85074382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 851a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 852a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 85374382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner std::string SharedObject = BD.compileSharedObject(SafeModuleBC.str()); 854a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete Safe; 855a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 856a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Run the code generator on the `Test' code, loading the shared library. 857a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // The function returns whether or not the new output differs from reference. 85874382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner int Result = BD.diffProgram(TestModuleBC.str(), SharedObject, false); 859a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 860a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (Result) 86165f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << ": still failing!\n"; 862a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner else 86365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << ": didn't fail.\n"; 864a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer TestModuleBC.eraseFromDisk(); 865a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer SafeModuleBC.eraseFromDisk(); 866a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(SharedObject).eraseFromDisk(); 867a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 868a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return Result; 869a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 870a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 871a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 8728c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// debugCodeGenerator - debug errors in LLC, LLI, or CBE. 8738c194eaa0577a207bb1ea91bf2c2a5e664fce9eeMisha Brukman/// 874a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattnerbool BugDriver::debugCodeGenerator() { 87570ef449741da8b1ef035e04a55958652a0200ba1Dan Gohman if ((void*)SafeInterpreter == (void*)Interpreter) { 87670ef449741da8b1ef035e04a55958652a0200ba1Dan Gohman std::string Result = executeProgramSafely("bugpoint.safe.out"); 877ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** The \"safe\" i.e. 'known good' backend cannot match " 878ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "the reference diff. This may be due to a\n front-end " 879ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "bug or a bug in the original program, but this can also " 880ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "happen if bugpoint isn't running the program with the " 881ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "right flags or input.\n I left the result of executing " 882ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "the program with the \"safe\" backend in this file for " 883ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << "you: '" 884ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman << Result << "'.\n"; 885a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return true; 886a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 887a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 888a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner DisambiguateGlobalSymbols(Program); 889a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 890a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner std::vector<Function*> Funcs = DebugAMiscompilation(*this, TestCodeGenerator); 891a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 892a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Split the module into the two halves of the program we want. 893d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman DenseMap<const Value*, Value*> ValueMap; 894d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToNotCodeGen = CloneModule(getProgram(), ValueMap); 895d50330cd02b00c8e3de40e8544c45701b9891d87Dan Gohman Module *ToCodeGen = SplitFunctionsOutOfModule(ToNotCodeGen, Funcs, ValueMap); 896a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 897a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Condition the modules 898a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner CleanupAndPrepareModules(*this, ToCodeGen, ToNotCodeGen); 899a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 90097182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path TestModuleBC("bugpoint.test.bc"); 90151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 90251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (TestModuleBC.makeUnique(true, &ErrMsg)) { 90365f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << getToolName() << "Error making unique filename: " 90465f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 90551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 90651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 90797182985d530dbef488696c95a39c14fe56c995bReid Spencer 90874382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (writeProgramToFile(TestModuleBC.str(), ToCodeGen)) { 90974382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << TestModuleBC.str() 91074382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 911a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 912a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 913a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete ToCodeGen; 914a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 915a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner // Make the shared library 91697182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path SafeModuleBC("bugpoint.safe.bc"); 91751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (SafeModuleBC.makeUnique(true, &ErrMsg)) { 91865f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << getToolName() << "Error making unique filename: " 91965f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman << ErrMsg << "\n"; 92051c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 92151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 92297182985d530dbef488696c95a39c14fe56c995bReid Spencer 92374382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner if (writeProgramToFile(SafeModuleBC.str(), ToNotCodeGen)) { 92474382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner errs() << "Error writing bitcode to `" << SafeModuleBC.str() 92574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << "'\nExiting."; 926a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner exit(1); 927a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 92874382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner std::string SharedObject = compileSharedObject(SafeModuleBC.str()); 929a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner delete ToNotCodeGen; 930a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 931ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "You can reproduce the problem with the command line: \n"; 932a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner if (isExecutingJIT()) { 93374382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " lli -load " << SharedObject << " " << TestModuleBC.str(); 934a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } else { 93574382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " llc -f " << TestModuleBC.str() << " -o " << TestModuleBC.str() 93674382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << ".s\n"; 93774382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " gcc " << SharedObject << " " << TestModuleBC.str() 93874382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << ".s -o " << TestModuleBC.str() << ".exe"; 93959615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#if defined (HAVE_LINK_R) 940ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " -Wl,-R."; 94159615f0f85e2ac99e012cb81934d002faebd405aChris Lattner#endif 942ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n"; 94374382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner outs() << " " << TestModuleBC.str() << ".exe"; 944a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner } 945a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner for (unsigned i=0, e = InputArgv.size(); i != e; ++i) 946ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << " " << InputArgv[i]; 947ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 948ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "The shared object was created with:\n llc -march=c " 94974382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner << SafeModuleBC.str() << " -o temporary.c\n" 950ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar << " gcc -xc temporary.c -O2 -o " << SharedObject; 951ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar if (TargetTriple.getArch() == Triple::sparc) 952ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -G"; // Compile a shared library, `-G' for Sparc 953ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar else 954ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -fPIC -shared"; // `-shared' for Linux/X86, maybe others 955ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar 956ca7409664273fed4b473127295af3af0836b3077Daniel Dunbar outs() << " -fno-strict-aliasing\n"; 957a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner 958a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner return false; 959a57d86b436549503a7f96c5266444e022bdbaf55Chris Lattner} 960