ExecutionDriver.cpp revision ad6996d74f60340d6139af8f345d93735661fbba
14a10645c70199c8d8567fbc46312158c419720abChris Lattner//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===// 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// 104a10645c70199c8d8567fbc46312158c419720abChris Lattner// This file contains code used to execute the program utilizing one of the 118ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif// various ways of running LLVM bitcode. 124a10645c70199c8d8567fbc46312158c419720abChris Lattner// 134a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 144a10645c70199c8d8567fbc46312158c419720abChris Lattner 154a10645c70199c8d8567fbc46312158c419720abChris Lattner#include "BugDriver.h" 16f1b20d8620b05abaa52f40ac6d21f839b265fb00Chris Lattner#include "ToolRunner.h" 17551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/CommandLine.h" 18551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/Debug.h" 19551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/FileUtilities.h" 20551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/SystemUtils.h" 214a10645c70199c8d8567fbc46312158c419720abChris Lattner#include <fstream> 22e31a9ccb9c7568e6f185f667b53c274c0be9e603Chris Lattner#include <iostream> 2351ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer 24d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekeusing namespace llvm; 25d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 264a10645c70199c8d8567fbc46312158c419720abChris Lattnernamespace { 274a10645c70199c8d8567fbc46312158c419720abChris Lattner // OutputType - Allow the user to specify the way code should be run, to test 284a10645c70199c8d8567fbc46312158c419720abChris Lattner // for miscompilation. 294a10645c70199c8d8567fbc46312158c419720abChris Lattner // 304a10645c70199c8d8567fbc46312158c419720abChris Lattner enum OutputType { 319ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov AutoPick, RunLLI, RunJIT, RunLLC, RunCBE, CBE_bug, LLC_Safe, Custom 324a10645c70199c8d8567fbc46312158c419720abChris Lattner }; 334148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman 34a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner cl::opt<double> 35a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"), 36a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner cl::init(0.0)); 37a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner cl::opt<double> 38a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"), 39a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner cl::init(0.0)); 40a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner 414a10645c70199c8d8567fbc46312158c419720abChris Lattner cl::opt<OutputType> 424a10645c70199c8d8567fbc46312158c419720abChris Lattner InterpreterSel(cl::desc("Specify how LLVM code should be executed:"), 43b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke cl::values(clEnumValN(AutoPick, "auto", "Use best guess"), 44b687d82b029ba448b978e2c9ed424ee5d1f9f093Misha Brukman clEnumValN(RunLLI, "run-int", 45b687d82b029ba448b978e2c9ed424ee5d1f9f093Misha Brukman "Execute with the interpreter"), 465073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunJIT, "run-jit", "Execute with JIT"), 475073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunLLC, "run-llc", "Compile with LLC"), 485073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunCBE, "run-cbe", "Compile with CBE"), 49c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner clEnumValN(CBE_bug,"cbe-bug", "Find CBE bugs"), 50cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"), 519ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov clEnumValN(Custom, "run-custom", 529ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov "Use -exec-command to define a command to execute " 539ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov "the bitcode. Useful for cross-compilation."), 544d143ee01988e1b52e106ffccbb313937ca5e886Chris Lattner clEnumValEnd), 55b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke cl::init(AutoPick)); 563c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner 57c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::opt<bool> 58c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode("check-exit-code", 59eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman cl::desc("Assume nonzero exit code is failure (default on)"), 60c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::init(true)); 61c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 625e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::opt<bool> 635e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer AppendProgramExitCode("append-exit-code", 645e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::desc("Append the exit code to the output so it gets diff'd too"), 655e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::init(false)); 665e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer 673c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::opt<std::string> 683c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner InputFile("input", cl::init("/dev/null"), 693c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::desc("Filename to pipe in as stdin (default: /dev/null)")); 707dac658792425c10274594782d6fcf10208a16f0Chris Lattner 717dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::list<std::string> 727dac658792425c10274594782d6fcf10208a16f0Chris Lattner AdditionalSOs("additional-so", 737dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::desc("Additional shared objects to load " 747dac658792425c10274594782d6fcf10208a16f0Chris Lattner "into executing programs")); 757d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 7651ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::list<std::string> 779ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov AdditionalLinkerArgs("Xlinker", 7851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::desc("Additional arguments to pass to the linker")); 799ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov 809ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov cl::opt<std::string> 819ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov CustomExecCommand("exec-command", cl::init("simulate"), 829ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov cl::desc("Command to execute the bitcode (use with -run-custom) " 839ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov "(default: simulate)")); 844a10645c70199c8d8567fbc46312158c419720abChris Lattner} 854a10645c70199c8d8567fbc46312158c419720abChris Lattner 86d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 87fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // Anything specified after the --args option are taken as arguments to the 88fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // program being debugged. 89fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner cl::list<std::string> 90fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner InputArgv("args", cl::Positional, cl::desc("<program arguments>..."), 9160083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 92636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 93636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cl::list<std::string> 94636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."), 9560083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 96fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 979d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman 984a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 994a10645c70199c8d8567fbc46312158c419720abChris Lattner// BugDriver method implementation 1004a10645c70199c8d8567fbc46312158c419720abChris Lattner// 1014a10645c70199c8d8567fbc46312158c419720abChris Lattner 1024a10645c70199c8d8567fbc46312158c419720abChris Lattner/// initializeExecutionEnvironment - This method is used to set up the 1034a10645c70199c8d8567fbc46312158c419720abChris Lattner/// environment for executing LLVM programs. 1044a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 1054a10645c70199c8d8567fbc46312158c419720abChris Lattnerbool BugDriver::initializeExecutionEnvironment() { 1064a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cout << "Initializing execution environment: "; 1074a10645c70199c8d8567fbc46312158c419720abChris Lattner 1084148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // Create an instance of the AbstractInterpreter interface as specified on 1094148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // the command line 1107bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner cbe = 0; 1114a10645c70199c8d8567fbc46312158c419720abChris Lattner std::string Message; 112636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 113cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner switch (InterpreterSel) { 114b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke case AutoPick: 115b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunCBE; 116636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message, 117636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 118b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 119b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunJIT; 120636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 121636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 122b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 123b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 124b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLC; 125636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 126636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 127b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 128b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 129b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLI; 130636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 131636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 132b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 133b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 134b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = AutoPick; 135b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke Message = "Sorry, I can't automatically select an interpreter!\n"; 136b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 137b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke break; 138769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLI: 139636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 140636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 141769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 142769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLC: 143636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 144636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 145769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 146769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunJIT: 147636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 148636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 149769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 150cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner case LLC_Safe: 151cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 152cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner &ToolArgv); 153cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner break; 154769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunCBE: 155c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner case CBE_bug: 156c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner Interpreter = AbstractInterpreter::createCBE(getToolName(), Message, 157c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner &ToolArgv); 158769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 1599ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov case Custom: 1609ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov Interpreter = AbstractInterpreter::createCustom(getToolName(), Message, 1619ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov CustomExecCommand); 1629ef7425a4d44ff129495da2357c98c67162fbeffAnton Korobeynikov break; 163cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner default: 1644148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; 165cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner break; 1664a10645c70199c8d8567fbc46312158c419720abChris Lattner } 167ad6996d74f60340d6139af8f345d93735661fbbaMatthijs Kooijman if (!Interpreter) 168ad6996d74f60340d6139af8f345d93735661fbbaMatthijs Kooijman std::cerr << Message; 169ad6996d74f60340d6139af8f345d93735661fbbaMatthijs Kooijman else // Display informational messages on stdout instead of stderr 170ad6996d74f60340d6139af8f345d93735661fbbaMatthijs Kooijman std::cout << Message; 1714a10645c70199c8d8567fbc46312158c419720abChris Lattner 172a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman // Initialize auxiliary tools for debugging 173c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunCBE) { 174c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner // We already created a CBE, reuse it. 175c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = Interpreter; 176cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner } else if (InterpreterSel == CBE_bug || InterpreterSel == LLC_Safe) { 177cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner // We want to debug the CBE itself or LLC is known-good. Use LLC as the 178cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner // 'known-good' compiler. 179c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::vector<std::string> ToolArgs; 180c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner ToolArgs.push_back("--relocation-model=pic"); 181c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = AbstractInterpreter::createLLC(getToolName(), Message, &ToolArgs); 182c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner } else { 183636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv); 1847bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner } 185c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } 186c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner 187769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner gcc = GCC::create(getToolName(), Message); 188a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); } 189a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman 1904a10645c70199c8d8567fbc46312158c419720abChris Lattner // If there was an error creating the selected interpreter, quit with error. 1914a10645c70199c8d8567fbc46312158c419720abChris Lattner return Interpreter == 0; 1924a10645c70199c8d8567fbc46312158c419720abChris Lattner} 1934a10645c70199c8d8567fbc46312158c419720abChris Lattner 194ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// compileProgram - Try to compile the specified module, throwing an exception 195ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// if an error occurs, or returning normally if not. This is used for code 196ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// generation crash testing. 197ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// 198ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattnervoid BugDriver::compileProgram(Module *M) { 1998ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Emit the program to a bitcode file... 2008ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path BitcodeFile ("bugpoint-test-program.bc"); 20151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 2028ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BitcodeFile.makeUnique(true,&ErrMsg)) { 20351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " << ErrMsg 20451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << "\n"; 20551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 20651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 2078ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (writeProgramToFile(BitcodeFile.toString(), M)) { 2088ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif std::cerr << ToolName << ": Error emitting bitcode to file '" 2098ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif << BitcodeFile << "'!\n"; 210ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner exit(1); 211ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner } 212ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 2138ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Remove the temporary bitcode file when we are done. 2148ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif FileRemover BitcodeFileRemover(BitcodeFile); 215ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 216ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Actually compile the program! 2178ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif Interpreter->compileProgram(BitcodeFile.toString()); 218ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner} 219ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 2204a10645c70199c8d8567fbc46312158c419720abChris Lattner 2214a10645c70199c8d8567fbc46312158c419720abChris Lattner/// executeProgram - This method runs "Program", capturing the output of the 2224a10645c70199c8d8567fbc46312158c419720abChris Lattner/// program to a file, returning the filename of the file. A recommended 2234a10645c70199c8d8567fbc46312158c419720abChris Lattner/// filename may be optionally specified. 2244a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 2254a10645c70199c8d8567fbc46312158c419720abChris Lattnerstd::string BugDriver::executeProgram(std::string OutputFile, 2268ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif std::string BitcodeFile, 227769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner const std::string &SharedObj, 228c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke AbstractInterpreter *AI, 229c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool *ProgramExitedNonzero) { 230769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (AI == 0) AI = Interpreter; 231769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner assert(AI && "Interpreter should have been created already!"); 2328ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif bool CreatedBitcode = false; 23351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 2348ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (BitcodeFile.empty()) { 2358ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Emit the program to a bitcode file... 23697182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFilename("bugpoint-test-program.bc"); 23751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFilename.makeUnique(true, &ErrMsg)) { 23851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 23951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "!\n"; 24051c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 24151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 2428ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif BitcodeFile = uniqueFilename.toString(); 2434a10645c70199c8d8567fbc46312158c419720abChris Lattner 2448ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (writeProgramToFile(BitcodeFile, Program)) { 2458ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif std::cerr << ToolName << ": Error emitting bitcode to file '" 2468ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif << BitcodeFile << "'!\n"; 2474a10645c70199c8d8567fbc46312158c419720abChris Lattner exit(1); 2484a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2498ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif CreatedBitcode = true; 2504a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2514a10645c70199c8d8567fbc46312158c419720abChris Lattner 2528ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Remove the temporary bitcode file when we are done. 2538ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path BitcodePath (BitcodeFile); 2548ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif FileRemover BitcodeFileRemover(BitcodePath, CreatedBitcode); 2559709272675feaca030cce14d0f5eb7f342b3fc1dChris Lattner 2564a10645c70199c8d8567fbc46312158c419720abChris Lattner if (OutputFile.empty()) OutputFile = "bugpoint-execution-output"; 2575073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 2584a10645c70199c8d8567fbc46312158c419720abChris Lattner // Check to see if this is a valid output filename... 25997182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFile(OutputFile); 26051c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFile.makeUnique(true, &ErrMsg)) { 26151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 26251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "\n"; 26351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 26451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 26597182985d530dbef488696c95a39c14fe56c995bReid Spencer OutputFile = uniqueFile.toString(); 2664a10645c70199c8d8567fbc46312158c419720abChris Lattner 267769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner // Figure out which shared objects to run, if any. 2687dac658792425c10274594782d6fcf10208a16f0Chris Lattner std::vector<std::string> SharedObjs(AdditionalSOs); 269769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (!SharedObj.empty()) 270769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner SharedObjs.push_back(SharedObj); 271769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 27251ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer 27351ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // If this is an LLC or CBE run, then the GCC compiler might get run to 27451ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // compile the program. If so, we should pass the user's -Xlinker options 27551ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // as the GCCArgs. 27651ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer int RetVal = 0; 277c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunLLC || InterpreterSel == RunCBE || 278497391ad8d35fd8dcf6b48f459c179e3db3d3c5cLauro Ramos Venancio InterpreterSel == CBE_bug || InterpreterSel == LLC_Safe) 2798ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile, 28051ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, AdditionalLinkerArgs, SharedObjs, 2819ba8a76f8baaa1092d60ccfbc04e7efdc207c98fAnton Korobeynikov Timeout, MemoryLimit); 28251ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer else 2838ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile, 28451ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, std::vector<std::string>(), 2859ba8a76f8baaa1092d60ccfbc04e7efdc207c98fAnton Korobeynikov SharedObjs, Timeout, MemoryLimit); 2867d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 2877d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (RetVal == -1) { 2887d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cerr << "<timeout>"; 2897d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner static bool FirstTimeout = true; 2907d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (FirstTimeout) { 2917d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cout << "\n" 2927d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner "*** Program execution timed out! This mechanism is designed to handle\n" 2937d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " programs stuck in infinite loops gracefully. The -timeout option\n" 2947d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " can be used to change the timeout threshold or disable it completely\n" 2957d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " (with -timeout=0). This message is only displayed once.\n"; 2967d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner FirstTimeout = false; 2977d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 2987d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 299769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 3005e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer if (AppendProgramExitCode) { 3015e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer std::ofstream outFile(OutputFile.c_str(), std::ios_base::app); 3025e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer outFile << "exit " << RetVal << '\n'; 3035e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer outFile.close(); 3045e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer } 3055e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer 306c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero != 0) 307c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke *ProgramExitedNonzero = (RetVal != 0); 3084a10645c70199c8d8567fbc46312158c419720abChris Lattner 3094a10645c70199c8d8567fbc46312158c419720abChris Lattner // Return the filename we captured the output to. 3104a10645c70199c8d8567fbc46312158c419720abChris Lattner return OutputFile; 3114a10645c70199c8d8567fbc46312158c419720abChris Lattner} 3124a10645c70199c8d8567fbc46312158c419720abChris Lattner 313c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// executeProgramWithCBE - Used to create reference output with the C 314c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// backend, if reference output is not provided. 315c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// 316c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaekestd::string BugDriver::executeProgramWithCBE(std::string OutputFile) { 317c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 318c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::string outFN = executeProgram(OutputFile, "", "", cbe, 319c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke &ProgramExitedNonzero); 320c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero) { 321c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke std::cerr 322c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "Warning: While generating reference output, program exited with\n" 323c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "non-zero exit code. This will NOT be treated as a failure.\n"; 324c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode = false; 325c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke } 326c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return outFN; 327c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke} 3285073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3298ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greifstd::string BugDriver::compileSharedObject(const std::string &BitcodeFile) { 3305073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman assert(Interpreter && "Interpreter should have been created already!"); 331c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner sys::Path OutputFile; 3325073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3335073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Using CBE 3348ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif GCC::FileType FT = cbe->OutputCode(BitcodeFile, OutputFile); 3355073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 336a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string SharedObjectFile; 337c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (gcc->MakeSharedObject(OutputFile.toString(), FT, 338130e2a361147a31ae631d3648afdd95a5c0d40f2Chris Lattner SharedObjectFile, AdditionalLinkerArgs)) 339a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner exit(1); 3405073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3415073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Remove the intermediate C file 342c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner OutputFile.eraseFromDisk(); 3435073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3446ebe44d22f6dd1ab9f7aa1f3cfd02be52145d535Chris Lattner return "./" + SharedObjectFile; 3455073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman} 3465073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3476a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// createReferenceFile - calls compileProgram and then records the output 3486a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// into ReferenceOutputFile. Returns true if reference file created, false 3496a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 3506a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// this function. 3516a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// 352c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattnerbool BugDriver::createReferenceFile(Module *M, const std::string &Filename) { 3536a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3546a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins compileProgram(Program); 355d41b30def3181bce4bf87e8bde664d15663165d0Jeff Cohen } catch (ToolExecutionError &) { 3566a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3576a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3586a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3596a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins ReferenceOutputFile = executeProgramWithCBE(Filename); 3606a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cout << "Reference output is: " << ReferenceOutputFile << "\n\n"; 3616a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } catch (ToolExecutionError &TEE) { 3626a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << TEE.what(); 3636a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins if (Interpreter != cbe) { 3646a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << "*** There is a bug running the C backend. Either debug" 3656a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " it (use the -run-cbe bugpoint option), or fix the error" 3666a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " some other way.\n"; 3676a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3686a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3696a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3706a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return true; 3716a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins} 3725073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3736a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// diffProgram - This method executes the specified module and diffs the 3746a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// output against the file specified by ReferenceOutputFile. If the output 3756a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// is different, true is returned. If there is a problem with the code 3766a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// generator (e.g., llc crashes), this will throw an exception. 3774a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 3788ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greifbool BugDriver::diffProgram(const std::string &BitcodeFile, 3795073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman const std::string &SharedObject, 3808ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif bool RemoveBitcode) { 381c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 382c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 3834a10645c70199c8d8567fbc46312158c419720abChris Lattner // Execute the program, generating an output file... 3848ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path Output(executeProgram("", BitcodeFile, SharedObject, 0, 3855f76760c880e6d61c229d2058c5699b033caeae1Reid Spencer &ProgramExitedNonzero)); 386c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 387c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke // If we're checking the program exit code, assume anything nonzero is bad. 38858d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner if (CheckProgramExitCode && ProgramExitedNonzero) { 389a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 3908ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (RemoveBitcode) 3918ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeFile).eraseFromDisk(); 392c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return true; 39358d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner } 3944a10645c70199c8d8567fbc46312158c419720abChris Lattner 39565f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner std::string Error; 3964a10645c70199c8d8567fbc46312158c419720abChris Lattner bool FilesDifferent = false; 397a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile), 398a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner sys::Path(Output.toString()), 399a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner AbsTolerance, RelTolerance, &Error)) { 400a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (Diff == 2) { 401eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman std::cerr << "While diffing output: " << Error << '\n'; 40265f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner exit(1); 40365f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 40465f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner FilesDifferent = true; 40565f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 4063da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 4071a28a2b76d16913fe38f47032d31620a55dcce2eChris Lattner // Remove the generated output. 408a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 4094a10645c70199c8d8567fbc46312158c419720abChris Lattner 4108ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif // Remove the bitcode file if we are supposed to. 4118ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif if (RemoveBitcode) 4128ff70c2635bfd4e02c0140a5dc9ca909fffba35aGabor Greif sys::Path(BitcodeFile).eraseFromDisk(); 4134a10645c70199c8d8567fbc46312158c419720abChris Lattner return FilesDifferent; 4144a10645c70199c8d8567fbc46312158c419720abChris Lattner} 41591eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman 41691eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukmanbool BugDriver::isExecutingJIT() { 41791eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman return InterpreterSel == RunJIT; 41891eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman} 419d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 420