ExecutionDriver.cpp revision 5e1452c856a8bcf39ab7a67a5af946c8162f942d
14a10645c70199c8d8567fbc46312158c419720abChris Lattner//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===// 23da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman// 37c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// The LLVM Compiler Infrastructure 47c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// 57c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// This file was developed by the LLVM research group and is distributed under 67c0e022c5c4be4b11e199a53f73bbdd84e34aa80John Criswell// the University of Illinois Open Source 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 114a10645c70199c8d8567fbc46312158c419720abChris Lattner// various ways of running LLVM bytecode. 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 { 31cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner AutoPick, RunLLI, RunJIT, RunLLC, RunCBE, CBE_bug, LLC_Safe 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"), 514d143ee01988e1b52e106ffccbb313937ca5e886Chris Lattner clEnumValEnd), 52b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke cl::init(AutoPick)); 533c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner 54c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::opt<bool> 55c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode("check-exit-code", 56eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman cl::desc("Assume nonzero exit code is failure (default on)"), 57c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::init(true)); 58c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 595e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::opt<bool> 605e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer AppendProgramExitCode("append-exit-code", 615e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::desc("Append the exit code to the output so it gets diff'd too"), 625e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer cl::init(false)); 635e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer 643c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::opt<std::string> 653c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner InputFile("input", cl::init("/dev/null"), 663c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::desc("Filename to pipe in as stdin (default: /dev/null)")); 677dac658792425c10274594782d6fcf10208a16f0Chris Lattner 687dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::list<std::string> 697dac658792425c10274594782d6fcf10208a16f0Chris Lattner AdditionalSOs("additional-so", 707dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::desc("Additional shared objects to load " 717dac658792425c10274594782d6fcf10208a16f0Chris Lattner "into executing programs")); 727d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 7351ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::list<std::string> 7451ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer AdditionalLinkerArgs("Xlinker", 7551ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::desc("Additional arguments to pass to the linker")); 764a10645c70199c8d8567fbc46312158c419720abChris Lattner} 774a10645c70199c8d8567fbc46312158c419720abChris Lattner 78d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 79fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // Anything specified after the --args option are taken as arguments to the 80fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // program being debugged. 81fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner cl::list<std::string> 82fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner InputArgv("args", cl::Positional, cl::desc("<program arguments>..."), 8360083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 84636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 85636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cl::list<std::string> 86636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."), 8760083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 88fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 899d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman 904a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 914a10645c70199c8d8567fbc46312158c419720abChris Lattner// BugDriver method implementation 924a10645c70199c8d8567fbc46312158c419720abChris Lattner// 934a10645c70199c8d8567fbc46312158c419720abChris Lattner 944a10645c70199c8d8567fbc46312158c419720abChris Lattner/// initializeExecutionEnvironment - This method is used to set up the 954a10645c70199c8d8567fbc46312158c419720abChris Lattner/// environment for executing LLVM programs. 964a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 974a10645c70199c8d8567fbc46312158c419720abChris Lattnerbool BugDriver::initializeExecutionEnvironment() { 984a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cout << "Initializing execution environment: "; 994a10645c70199c8d8567fbc46312158c419720abChris Lattner 1004148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // Create an instance of the AbstractInterpreter interface as specified on 1014148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // the command line 1027bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner cbe = 0; 1034a10645c70199c8d8567fbc46312158c419720abChris Lattner std::string Message; 104636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 105cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner switch (InterpreterSel) { 106b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke case AutoPick: 107b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunCBE; 108636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message, 109636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 110b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 111b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunJIT; 112636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 113636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 114b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 115b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 116b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLC; 117636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 118636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 119b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 120b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 121b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLI; 122636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 123636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 124b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 125b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 126b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = AutoPick; 127b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke Message = "Sorry, I can't automatically select an interpreter!\n"; 128b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 129b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke break; 130769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLI: 131636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 132636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 133769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 134769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLC: 135636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 136636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 137769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 138769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunJIT: 139636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 140636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 141769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 142cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner case LLC_Safe: 143cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 144cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner &ToolArgv); 145cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner break; 146769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunCBE: 147c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner case CBE_bug: 148c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner Interpreter = AbstractInterpreter::createCBE(getToolName(), Message, 149c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner &ToolArgv); 150769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 151cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner default: 1524148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; 153cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner break; 1544a10645c70199c8d8567fbc46312158c419720abChris Lattner } 1554148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman std::cerr << Message; 1564a10645c70199c8d8567fbc46312158c419720abChris Lattner 157a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman // Initialize auxiliary tools for debugging 158c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunCBE) { 159c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner // We already created a CBE, reuse it. 160c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = Interpreter; 161cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner } else if (InterpreterSel == CBE_bug || InterpreterSel == LLC_Safe) { 162cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner // We want to debug the CBE itself or LLC is known-good. Use LLC as the 163cd6f46e2ac4c1d64067237c0b28eccfae22bd9f4Chris Lattner // 'known-good' compiler. 164c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::vector<std::string> ToolArgs; 165c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner ToolArgs.push_back("--relocation-model=pic"); 166c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = AbstractInterpreter::createLLC(getToolName(), Message, &ToolArgs); 167c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner } else { 168636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv); 1697bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner } 170c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } 171c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner 172769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner gcc = GCC::create(getToolName(), Message); 173a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); } 174a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman 1754a10645c70199c8d8567fbc46312158c419720abChris Lattner // If there was an error creating the selected interpreter, quit with error. 1764a10645c70199c8d8567fbc46312158c419720abChris Lattner return Interpreter == 0; 1774a10645c70199c8d8567fbc46312158c419720abChris Lattner} 1784a10645c70199c8d8567fbc46312158c419720abChris Lattner 179ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// compileProgram - Try to compile the specified module, throwing an exception 180ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// if an error occurs, or returning normally if not. This is used for code 181ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// generation crash testing. 182ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// 183ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattnervoid BugDriver::compileProgram(Module *M) { 184ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Emit the program to a bytecode file... 18597182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path BytecodeFile ("bugpoint-test-program.bc"); 18651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 18751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (BytecodeFile.makeUnique(true,&ErrMsg)) { 18851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " << ErrMsg 18951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << "\n"; 19051c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 19151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 19297182985d530dbef488696c95a39c14fe56c995bReid Spencer if (writeProgramToFile(BytecodeFile.toString(), M)) { 193ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner std::cerr << ToolName << ": Error emitting bytecode to file '" 194ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner << BytecodeFile << "'!\n"; 195ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner exit(1); 196ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner } 197ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 198ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Remove the temporary bytecode file when we are done. 1995f76760c880e6d61c229d2058c5699b033caeae1Reid Spencer FileRemover BytecodeFileRemover(BytecodeFile); 200ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 201ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Actually compile the program! 20297182985d530dbef488696c95a39c14fe56c995bReid Spencer Interpreter->compileProgram(BytecodeFile.toString()); 203ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner} 204ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 2054a10645c70199c8d8567fbc46312158c419720abChris Lattner 2064a10645c70199c8d8567fbc46312158c419720abChris Lattner/// executeProgram - This method runs "Program", capturing the output of the 2074a10645c70199c8d8567fbc46312158c419720abChris Lattner/// program to a file, returning the filename of the file. A recommended 2084a10645c70199c8d8567fbc46312158c419720abChris Lattner/// filename may be optionally specified. 2094a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 2104a10645c70199c8d8567fbc46312158c419720abChris Lattnerstd::string BugDriver::executeProgram(std::string OutputFile, 2115073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string BytecodeFile, 212769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner const std::string &SharedObj, 213c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke AbstractInterpreter *AI, 214c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool *ProgramExitedNonzero) { 215769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (AI == 0) AI = Interpreter; 216769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner assert(AI && "Interpreter should have been created already!"); 2174a10645c70199c8d8567fbc46312158c419720abChris Lattner bool CreatedBytecode = false; 21851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 2194a10645c70199c8d8567fbc46312158c419720abChris Lattner if (BytecodeFile.empty()) { 2204a10645c70199c8d8567fbc46312158c419720abChris Lattner // Emit the program to a bytecode file... 22197182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFilename("bugpoint-test-program.bc"); 22251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFilename.makeUnique(true, &ErrMsg)) { 22351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 22451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "!\n"; 22551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 22651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 22797182985d530dbef488696c95a39c14fe56c995bReid Spencer BytecodeFile = uniqueFilename.toString(); 2284a10645c70199c8d8567fbc46312158c419720abChris Lattner 2294a10645c70199c8d8567fbc46312158c419720abChris Lattner if (writeProgramToFile(BytecodeFile, Program)) { 2304a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cerr << ToolName << ": Error emitting bytecode to file '" 2315073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman << BytecodeFile << "'!\n"; 2324a10645c70199c8d8567fbc46312158c419720abChris Lattner exit(1); 2334a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2344a10645c70199c8d8567fbc46312158c419720abChris Lattner CreatedBytecode = true; 2354a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2364a10645c70199c8d8567fbc46312158c419720abChris Lattner 2379709272675feaca030cce14d0f5eb7f342b3fc1dChris Lattner // Remove the temporary bytecode file when we are done. 23806c375bd1d402ddcf2ee8e34005a74a0addbd7ccBrian Gaeke sys::Path BytecodePath (BytecodeFile); 23906c375bd1d402ddcf2ee8e34005a74a0addbd7ccBrian Gaeke FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode); 2409709272675feaca030cce14d0f5eb7f342b3fc1dChris Lattner 2414a10645c70199c8d8567fbc46312158c419720abChris Lattner if (OutputFile.empty()) OutputFile = "bugpoint-execution-output"; 2425073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 2434a10645c70199c8d8567fbc46312158c419720abChris Lattner // Check to see if this is a valid output filename... 24497182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFile(OutputFile); 24551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFile.makeUnique(true, &ErrMsg)) { 24651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 24751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "\n"; 24851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 24951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 25097182985d530dbef488696c95a39c14fe56c995bReid Spencer OutputFile = uniqueFile.toString(); 2514a10645c70199c8d8567fbc46312158c419720abChris Lattner 252769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner // Figure out which shared objects to run, if any. 2537dac658792425c10274594782d6fcf10208a16f0Chris Lattner std::vector<std::string> SharedObjs(AdditionalSOs); 254769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (!SharedObj.empty()) 255769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner SharedObjs.push_back(SharedObj); 256769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 25751ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer 25851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // If this is an LLC or CBE run, then the GCC compiler might get run to 25951ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // compile the program. If so, we should pass the user's -Xlinker options 26051ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // as the GCCArgs. 26151ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer int RetVal = 0; 262c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunLLC || InterpreterSel == RunCBE || 263c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner InterpreterSel == CBE_bug) 26451ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, 26551ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, AdditionalLinkerArgs, SharedObjs, 2669686ae7f4ea5f19ce77e31e64e0916db41a82662Chris Lattner Timeout); 26751ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer else 26851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, 26951ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, std::vector<std::string>(), 2709686ae7f4ea5f19ce77e31e64e0916db41a82662Chris Lattner SharedObjs, Timeout); 2717d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 2727d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (RetVal == -1) { 2737d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cerr << "<timeout>"; 2747d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner static bool FirstTimeout = true; 2757d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (FirstTimeout) { 2767d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cout << "\n" 2777d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner "*** Program execution timed out! This mechanism is designed to handle\n" 2787d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " programs stuck in infinite loops gracefully. The -timeout option\n" 2797d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " can be used to change the timeout threshold or disable it completely\n" 2807d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " (with -timeout=0). This message is only displayed once.\n"; 2817d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner FirstTimeout = false; 2827d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 2837d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 284769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 2855e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer if (AppendProgramExitCode) { 2865e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer std::ofstream outFile(OutputFile.c_str(), std::ios_base::app); 2875e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer outFile << "exit " << RetVal << '\n'; 2885e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer outFile.close(); 2895e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer } 2905e1452c856a8bcf39ab7a67a5af946c8162f942dReid Spencer 291c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero != 0) 292c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke *ProgramExitedNonzero = (RetVal != 0); 2934a10645c70199c8d8567fbc46312158c419720abChris Lattner 2944a10645c70199c8d8567fbc46312158c419720abChris Lattner // Return the filename we captured the output to. 2954a10645c70199c8d8567fbc46312158c419720abChris Lattner return OutputFile; 2964a10645c70199c8d8567fbc46312158c419720abChris Lattner} 2974a10645c70199c8d8567fbc46312158c419720abChris Lattner 298c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// executeProgramWithCBE - Used to create reference output with the C 299c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// backend, if reference output is not provided. 300c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// 301c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaekestd::string BugDriver::executeProgramWithCBE(std::string OutputFile) { 302c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 303c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::string outFN = executeProgram(OutputFile, "", "", cbe, 304c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke &ProgramExitedNonzero); 305c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero) { 306c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke std::cerr 307c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "Warning: While generating reference output, program exited with\n" 308c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "non-zero exit code. This will NOT be treated as a failure.\n"; 309c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode = false; 310c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke } 311c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return outFN; 312c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke} 3135073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 314a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattnerstd::string BugDriver::compileSharedObject(const std::string &BytecodeFile) { 3155073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman assert(Interpreter && "Interpreter should have been created already!"); 316c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner sys::Path OutputFile; 3175073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3185073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Using CBE 319c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner GCC::FileType FT = cbe->OutputCode(BytecodeFile, OutputFile); 3205073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 321a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string SharedObjectFile; 322c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (gcc->MakeSharedObject(OutputFile.toString(), FT, 323130e2a361147a31ae631d3648afdd95a5c0d40f2Chris Lattner SharedObjectFile, AdditionalLinkerArgs)) 324a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner exit(1); 3255073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3265073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Remove the intermediate C file 327c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner OutputFile.eraseFromDisk(); 3285073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3296ebe44d22f6dd1ab9f7aa1f3cfd02be52145d535Chris Lattner return "./" + SharedObjectFile; 3305073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman} 3315073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3326a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// createReferenceFile - calls compileProgram and then records the output 3336a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// into ReferenceOutputFile. Returns true if reference file created, false 3346a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 3356a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// this function. 3366a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// 337c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattnerbool BugDriver::createReferenceFile(Module *M, const std::string &Filename) { 3386a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3396a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins compileProgram(Program); 340d41b30def3181bce4bf87e8bde664d15663165d0Jeff Cohen } catch (ToolExecutionError &) { 3416a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3426a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3436a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3446a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins ReferenceOutputFile = executeProgramWithCBE(Filename); 3456a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cout << "Reference output is: " << ReferenceOutputFile << "\n\n"; 3466a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } catch (ToolExecutionError &TEE) { 3476a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << TEE.what(); 3486a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins if (Interpreter != cbe) { 3496a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << "*** There is a bug running the C backend. Either debug" 3506a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " it (use the -run-cbe bugpoint option), or fix the error" 3516a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " some other way.\n"; 3526a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3536a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3546a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3556a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return true; 3566a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins} 3575073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3586a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// diffProgram - This method executes the specified module and diffs the 3596a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// output against the file specified by ReferenceOutputFile. If the output 3606a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// is different, true is returned. If there is a problem with the code 3616a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// generator (e.g., llc crashes), this will throw an exception. 3624a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 3635073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukmanbool BugDriver::diffProgram(const std::string &BytecodeFile, 3645073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman const std::string &SharedObject, 365640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner bool RemoveBytecode) { 366c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 367c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 3684a10645c70199c8d8567fbc46312158c419720abChris Lattner // Execute the program, generating an output file... 369130e2a361147a31ae631d3648afdd95a5c0d40f2Chris Lattner sys::Path Output(executeProgram("", BytecodeFile, SharedObject, 0, 3705f76760c880e6d61c229d2058c5699b033caeae1Reid Spencer &ProgramExitedNonzero)); 371c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 372c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke // If we're checking the program exit code, assume anything nonzero is bad. 37358d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner if (CheckProgramExitCode && ProgramExitedNonzero) { 374a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 3753da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman if (RemoveBytecode) 376a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(BytecodeFile).eraseFromDisk(); 377c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return true; 37858d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner } 3794a10645c70199c8d8567fbc46312158c419720abChris Lattner 38065f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner std::string Error; 3814a10645c70199c8d8567fbc46312158c419720abChris Lattner bool FilesDifferent = false; 382a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile), 383a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner sys::Path(Output.toString()), 384a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner AbsTolerance, RelTolerance, &Error)) { 385a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (Diff == 2) { 386eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman std::cerr << "While diffing output: " << Error << '\n'; 38765f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner exit(1); 38865f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 38965f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner FilesDifferent = true; 39065f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 3913da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 3921a28a2b76d16913fe38f47032d31620a55dcce2eChris Lattner // Remove the generated output. 393a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 3944a10645c70199c8d8567fbc46312158c419720abChris Lattner 3951a28a2b76d16913fe38f47032d31620a55dcce2eChris Lattner // Remove the bytecode file if we are supposed to. 39600b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen if (RemoveBytecode) 397a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(BytecodeFile).eraseFromDisk(); 3984a10645c70199c8d8567fbc46312158c419720abChris Lattner return FilesDifferent; 3994a10645c70199c8d8567fbc46312158c419720abChris Lattner} 40091eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman 40191eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukmanbool BugDriver::isExecutingJIT() { 40291eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman return InterpreterSel == RunJIT; 40391eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman} 404d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 405