ExecutionDriver.cpp revision c600f3c337f18c62116ac58b701e4f7ae6d2fb1a
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 { 31c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner AutoPick, RunLLI, RunJIT, RunLLC, RunCBE, CBE_bug 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"), 504d143ee01988e1b52e106ffccbb313937ca5e886Chris Lattner clEnumValEnd), 51b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke cl::init(AutoPick)); 523c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner 53c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::opt<bool> 54c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode("check-exit-code", 55eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman cl::desc("Assume nonzero exit code is failure (default on)"), 56c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke cl::init(true)); 57c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 583c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::opt<std::string> 593c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner InputFile("input", cl::init("/dev/null"), 603c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::desc("Filename to pipe in as stdin (default: /dev/null)")); 617dac658792425c10274594782d6fcf10208a16f0Chris Lattner 627dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::list<std::string> 637dac658792425c10274594782d6fcf10208a16f0Chris Lattner AdditionalSOs("additional-so", 647dac658792425c10274594782d6fcf10208a16f0Chris Lattner cl::desc("Additional shared objects to load " 657dac658792425c10274594782d6fcf10208a16f0Chris Lattner "into executing programs")); 667d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 6751ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::list<std::string> 6851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer AdditionalLinkerArgs("Xlinker", 6951ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer cl::desc("Additional arguments to pass to the linker")); 704a10645c70199c8d8567fbc46312158c419720abChris Lattner} 714a10645c70199c8d8567fbc46312158c419720abChris Lattner 72d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 73fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // Anything specified after the --args option are taken as arguments to the 74fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner // program being debugged. 75fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner cl::list<std::string> 76fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner InputArgv("args", cl::Positional, cl::desc("<program arguments>..."), 7760083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 78636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 79636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cl::list<std::string> 80636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."), 8160083e2fc0f1165b7511757449f1ee3852b7229cChris Lattner cl::ZeroOrMore, cl::PositionalEatsArgs); 82fa76183e8e28985dfd17b1d6291c939dab4cbe1dChris Lattner} 839d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman 844a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 854a10645c70199c8d8567fbc46312158c419720abChris Lattner// BugDriver method implementation 864a10645c70199c8d8567fbc46312158c419720abChris Lattner// 874a10645c70199c8d8567fbc46312158c419720abChris Lattner 884a10645c70199c8d8567fbc46312158c419720abChris Lattner/// initializeExecutionEnvironment - This method is used to set up the 894a10645c70199c8d8567fbc46312158c419720abChris Lattner/// environment for executing LLVM programs. 904a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 914a10645c70199c8d8567fbc46312158c419720abChris Lattnerbool BugDriver::initializeExecutionEnvironment() { 924a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cout << "Initializing execution environment: "; 934a10645c70199c8d8567fbc46312158c419720abChris Lattner 944148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // Create an instance of the AbstractInterpreter interface as specified on 954148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // the command line 967bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner cbe = 0; 974a10645c70199c8d8567fbc46312158c419720abChris Lattner std::string Message; 98636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke 99cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner switch (InterpreterSel) { 100b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke case AutoPick: 101b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunCBE; 102636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message, 103636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 104b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 105b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunJIT; 106636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 107636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 108b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 109b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 110b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLC; 111636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 112636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 113b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 114b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 115b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = RunLLI; 116636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 117636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 118b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 119b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke if (!Interpreter) { 120b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke InterpreterSel = AutoPick; 121b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke Message = "Sorry, I can't automatically select an interpreter!\n"; 122b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke } 123b5ee509be2ce78badc11fd649dda90ec78394d1aBrian Gaeke break; 124769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLI: 125636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLI(getToolName(), Message, 126636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 127769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 128769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunLLC: 129636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, 130636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 131769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 132769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunJIT: 133636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, 134636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke &ToolArgv); 135769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 136769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner case RunCBE: 137c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner case CBE_bug: 138c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner Interpreter = AbstractInterpreter::createCBE(getToolName(), Message, 139c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner &ToolArgv); 140769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner break; 141cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner default: 1424148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; 143cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner break; 1444a10645c70199c8d8567fbc46312158c419720abChris Lattner } 1454148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman std::cerr << Message; 1464a10645c70199c8d8567fbc46312158c419720abChris Lattner 147a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman // Initialize auxiliary tools for debugging 148c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunCBE) { 149c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner // We already created a CBE, reuse it. 150c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = Interpreter; 151c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner } else if (InterpreterSel == CBE_bug) { 152c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner // We want to debug the CBE itself. Use LLC as the 'known-good' compiler. 153c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::vector<std::string> ToolArgs; 154c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner ToolArgs.push_back("--relocation-model=pic"); 155c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner cbe = AbstractInterpreter::createLLC(getToolName(), Message, &ToolArgs); 156c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner } else { 157636df3d7ec51a8c6fd759a98853ff709ae54d64eBrian Gaeke cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv); 1587bb11547e497d7b8fc87f61c1089eee808e3a1eeChris Lattner } 159c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } 160c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner 161769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner gcc = GCC::create(getToolName(), Message); 162a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); } 163a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman 1644a10645c70199c8d8567fbc46312158c419720abChris Lattner // If there was an error creating the selected interpreter, quit with error. 1654a10645c70199c8d8567fbc46312158c419720abChris Lattner return Interpreter == 0; 1664a10645c70199c8d8567fbc46312158c419720abChris Lattner} 1674a10645c70199c8d8567fbc46312158c419720abChris Lattner 168ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// compileProgram - Try to compile the specified module, throwing an exception 169ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// if an error occurs, or returning normally if not. This is used for code 170ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// generation crash testing. 171ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner/// 172ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattnervoid BugDriver::compileProgram(Module *M) { 173ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Emit the program to a bytecode file... 17497182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path BytecodeFile ("bugpoint-test-program.bc"); 17551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 17651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (BytecodeFile.makeUnique(true,&ErrMsg)) { 17751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " << ErrMsg 17851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << "\n"; 17951c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 18051c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 18197182985d530dbef488696c95a39c14fe56c995bReid Spencer if (writeProgramToFile(BytecodeFile.toString(), M)) { 182ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner std::cerr << ToolName << ": Error emitting bytecode to file '" 183ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner << BytecodeFile << "'!\n"; 184ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner exit(1); 185ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner } 186ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 187ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Remove the temporary bytecode file when we are done. 1885f76760c880e6d61c229d2058c5699b033caeae1Reid Spencer FileRemover BytecodeFileRemover(BytecodeFile); 189ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 190ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner // Actually compile the program! 19197182985d530dbef488696c95a39c14fe56c995bReid Spencer Interpreter->compileProgram(BytecodeFile.toString()); 192ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner} 193ea9212ca964ff6587227016f86a44160e586a4c8Chris Lattner 1944a10645c70199c8d8567fbc46312158c419720abChris Lattner 1954a10645c70199c8d8567fbc46312158c419720abChris Lattner/// executeProgram - This method runs "Program", capturing the output of the 1964a10645c70199c8d8567fbc46312158c419720abChris Lattner/// program to a file, returning the filename of the file. A recommended 1974a10645c70199c8d8567fbc46312158c419720abChris Lattner/// filename may be optionally specified. 1984a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 1994a10645c70199c8d8567fbc46312158c419720abChris Lattnerstd::string BugDriver::executeProgram(std::string OutputFile, 2005073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string BytecodeFile, 201769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner const std::string &SharedObj, 202c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke AbstractInterpreter *AI, 203c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool *ProgramExitedNonzero) { 204769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (AI == 0) AI = Interpreter; 205769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner assert(AI && "Interpreter should have been created already!"); 2064a10645c70199c8d8567fbc46312158c419720abChris Lattner bool CreatedBytecode = false; 20751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::string ErrMsg; 2084a10645c70199c8d8567fbc46312158c419720abChris Lattner if (BytecodeFile.empty()) { 2094a10645c70199c8d8567fbc46312158c419720abChris Lattner // Emit the program to a bytecode file... 21097182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFilename("bugpoint-test-program.bc"); 21151c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFilename.makeUnique(true, &ErrMsg)) { 21251c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 21351c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "!\n"; 21451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 21551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 21697182985d530dbef488696c95a39c14fe56c995bReid Spencer BytecodeFile = uniqueFilename.toString(); 2174a10645c70199c8d8567fbc46312158c419720abChris Lattner 2184a10645c70199c8d8567fbc46312158c419720abChris Lattner if (writeProgramToFile(BytecodeFile, Program)) { 2194a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cerr << ToolName << ": Error emitting bytecode to file '" 2205073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman << BytecodeFile << "'!\n"; 2214a10645c70199c8d8567fbc46312158c419720abChris Lattner exit(1); 2224a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2234a10645c70199c8d8567fbc46312158c419720abChris Lattner CreatedBytecode = true; 2244a10645c70199c8d8567fbc46312158c419720abChris Lattner } 2254a10645c70199c8d8567fbc46312158c419720abChris Lattner 2269709272675feaca030cce14d0f5eb7f342b3fc1dChris Lattner // Remove the temporary bytecode file when we are done. 22706c375bd1d402ddcf2ee8e34005a74a0addbd7ccBrian Gaeke sys::Path BytecodePath (BytecodeFile); 22806c375bd1d402ddcf2ee8e34005a74a0addbd7ccBrian Gaeke FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode); 2299709272675feaca030cce14d0f5eb7f342b3fc1dChris Lattner 2304a10645c70199c8d8567fbc46312158c419720abChris Lattner if (OutputFile.empty()) OutputFile = "bugpoint-execution-output"; 2315073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 2324a10645c70199c8d8567fbc46312158c419720abChris Lattner // Check to see if this is a valid output filename... 23397182985d530dbef488696c95a39c14fe56c995bReid Spencer sys::Path uniqueFile(OutputFile); 23451c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer if (uniqueFile.makeUnique(true, &ErrMsg)) { 23551c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer std::cerr << ToolName << ": Error making unique filename: " 23651c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer << ErrMsg << "\n"; 23751c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer exit(1); 23851c5a286bae5ad27ddc49602f44b7ea7253a4cc9Reid Spencer } 23997182985d530dbef488696c95a39c14fe56c995bReid Spencer OutputFile = uniqueFile.toString(); 2404a10645c70199c8d8567fbc46312158c419720abChris Lattner 241769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner // Figure out which shared objects to run, if any. 2427dac658792425c10274594782d6fcf10208a16f0Chris Lattner std::vector<std::string> SharedObjs(AdditionalSOs); 243769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner if (!SharedObj.empty()) 244769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner SharedObjs.push_back(SharedObj); 245769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 24651ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer 24751ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // If this is an LLC or CBE run, then the GCC compiler might get run to 24851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // compile the program. If so, we should pass the user's -Xlinker options 24951ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer // as the GCCArgs. 25051ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer int RetVal = 0; 251c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (InterpreterSel == RunLLC || InterpreterSel == RunCBE || 252c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner InterpreterSel == CBE_bug) 25351ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, 25451ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, AdditionalLinkerArgs, SharedObjs, 2559686ae7f4ea5f19ce77e31e64e0916db41a82662Chris Lattner Timeout); 25651ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer else 25751ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, 25851ab5c8862466bbddcd5c4369779c472978ed309Reid Spencer OutputFile, std::vector<std::string>(), 2599686ae7f4ea5f19ce77e31e64e0916db41a82662Chris Lattner SharedObjs, Timeout); 2607d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner 2617d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (RetVal == -1) { 2627d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cerr << "<timeout>"; 2637d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner static bool FirstTimeout = true; 2647d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner if (FirstTimeout) { 2657d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner std::cout << "\n" 2667d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner "*** Program execution timed out! This mechanism is designed to handle\n" 2677d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " programs stuck in infinite loops gracefully. The -timeout option\n" 2687d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " can be used to change the timeout threshold or disable it completely\n" 2697d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner " (with -timeout=0). This message is only displayed once.\n"; 2707d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner FirstTimeout = false; 2717d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 2727d91e49ff7bcc0fd10a54d45a6185bb05adf3d20Chris Lattner } 273769f1fe6728ffb5627ae0cedc392576d6e701a5aChris Lattner 274c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero != 0) 275c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke *ProgramExitedNonzero = (RetVal != 0); 2764a10645c70199c8d8567fbc46312158c419720abChris Lattner 2774a10645c70199c8d8567fbc46312158c419720abChris Lattner // Return the filename we captured the output to. 2784a10645c70199c8d8567fbc46312158c419720abChris Lattner return OutputFile; 2794a10645c70199c8d8567fbc46312158c419720abChris Lattner} 2804a10645c70199c8d8567fbc46312158c419720abChris Lattner 281c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// executeProgramWithCBE - Used to create reference output with the C 282c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// backend, if reference output is not provided. 283c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke/// 284c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaekestd::string BugDriver::executeProgramWithCBE(std::string OutputFile) { 285c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 286c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner std::string outFN = executeProgram(OutputFile, "", "", cbe, 287c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke &ProgramExitedNonzero); 288c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke if (ProgramExitedNonzero) { 289c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke std::cerr 290c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "Warning: While generating reference output, program exited with\n" 291c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke << "non-zero exit code. This will NOT be treated as a failure.\n"; 292c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke CheckProgramExitCode = false; 293c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke } 294c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return outFN; 295c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke} 2965073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 297a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattnerstd::string BugDriver::compileSharedObject(const std::string &BytecodeFile) { 2985073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman assert(Interpreter && "Interpreter should have been created already!"); 299c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner sys::Path OutputFile; 3005073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3015073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Using CBE 302c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner GCC::FileType FT = cbe->OutputCode(BytecodeFile, OutputFile); 3035073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 304a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string SharedObjectFile; 305c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner if (gcc->MakeSharedObject(OutputFile.toString(), FT, 306130e2a361147a31ae631d3648afdd95a5c0d40f2Chris Lattner SharedObjectFile, AdditionalLinkerArgs)) 307a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner exit(1); 3085073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3095073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Remove the intermediate C file 310c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattner OutputFile.eraseFromDisk(); 3115073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3126ebe44d22f6dd1ab9f7aa1f3cfd02be52145d535Chris Lattner return "./" + SharedObjectFile; 3135073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman} 3145073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3156a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// createReferenceFile - calls compileProgram and then records the output 3166a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// into ReferenceOutputFile. Returns true if reference file created, false 3176a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 3186a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// this function. 3196a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// 320c600f3c337f18c62116ac58b701e4f7ae6d2fb1aChris Lattnerbool BugDriver::createReferenceFile(Module *M, const std::string &Filename) { 3216a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3226a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins compileProgram(Program); 3236a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } catch (ToolExecutionError &TEE) { 3246a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3256a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3266a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins try { 3276a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins ReferenceOutputFile = executeProgramWithCBE(Filename); 3286a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cout << "Reference output is: " << ReferenceOutputFile << "\n\n"; 3296a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } catch (ToolExecutionError &TEE) { 3306a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << TEE.what(); 3316a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins if (Interpreter != cbe) { 3326a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins std::cerr << "*** There is a bug running the C backend. Either debug" 3336a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " it (use the -run-cbe bugpoint option), or fix the error" 3346a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins << " some other way.\n"; 3356a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3366a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return false; 3376a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins } 3386a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins return true; 3396a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins} 3405073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 3416a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// diffProgram - This method executes the specified module and diffs the 3426a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// output against the file specified by ReferenceOutputFile. If the output 3436a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// is different, true is returned. If there is a problem with the code 3446a3f31cb707972ebde1e45a61fa8f5bcff132ebaPatrick Jenkins/// generator (e.g., llc crashes), this will throw an exception. 3454a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 3465073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukmanbool BugDriver::diffProgram(const std::string &BytecodeFile, 3475073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman const std::string &SharedObject, 348640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner bool RemoveBytecode) { 349c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke bool ProgramExitedNonzero; 350c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 3514a10645c70199c8d8567fbc46312158c419720abChris Lattner // Execute the program, generating an output file... 352130e2a361147a31ae631d3648afdd95a5c0d40f2Chris Lattner sys::Path Output(executeProgram("", BytecodeFile, SharedObject, 0, 3535f76760c880e6d61c229d2058c5699b033caeae1Reid Spencer &ProgramExitedNonzero)); 354c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke 355c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke // If we're checking the program exit code, assume anything nonzero is bad. 35658d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner if (CheckProgramExitCode && ProgramExitedNonzero) { 357a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 3583da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman if (RemoveBytecode) 359a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(BytecodeFile).eraseFromDisk(); 360c5cad211d6ec50fe90a0a716dee701c6c4721385Brian Gaeke return true; 36158d84ced5f7367335e43ea54e5daf32a4fdaefb6Chris Lattner } 3624a10645c70199c8d8567fbc46312158c419720abChris Lattner 36365f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner std::string Error; 3644a10645c70199c8d8567fbc46312158c419720abChris Lattner bool FilesDifferent = false; 365a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile), 366a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner sys::Path(Output.toString()), 367a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner AbsTolerance, RelTolerance, &Error)) { 368a328c51bb99666ee0c045a57ea6d6ce2b0198f9bChris Lattner if (Diff == 2) { 369eed80e23751ecc50c1fa5604f67be4b826d5b417Misha Brukman std::cerr << "While diffing output: " << Error << '\n'; 37065f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner exit(1); 37165f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 37265f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner FilesDifferent = true; 37365f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 3743da94aec4d429b2ba0f65fa040c33650cade196bMisha Brukman 3751a28a2b76d16913fe38f47032d31620a55dcce2eChris Lattner // Remove the generated output. 376a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer Output.eraseFromDisk(); 3774a10645c70199c8d8567fbc46312158c419720abChris Lattner 3781a28a2b76d16913fe38f47032d31620a55dcce2eChris Lattner // Remove the bytecode file if we are supposed to. 37900b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohen if (RemoveBytecode) 380a229c5cce75209047db32c6039aa0b0fd481f049Reid Spencer sys::Path(BytecodeFile).eraseFromDisk(); 3814a10645c70199c8d8567fbc46312158c419720abChris Lattner return FilesDifferent; 3824a10645c70199c8d8567fbc46312158c419720abChris Lattner} 38391eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman 38491eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukmanbool BugDriver::isExecutingJIT() { 38591eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman return InterpreterSel == RunJIT; 38691eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman} 387d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 388