ExecutionDriver.cpp revision a0f5b15e1eb8642d92b3141a6b88a5729ea979dc
14a10645c70199c8d8567fbc46312158c419720abChris Lattner//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===// 24a10645c70199c8d8567fbc46312158c419720abChris Lattner// 34a10645c70199c8d8567fbc46312158c419720abChris Lattner// This file contains code used to execute the program utilizing one of the 44a10645c70199c8d8567fbc46312158c419720abChris Lattner// various ways of running LLVM bytecode. 54a10645c70199c8d8567fbc46312158c419720abChris Lattner// 64a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 74a10645c70199c8d8567fbc46312158c419720abChris Lattner 84a10645c70199c8d8567fbc46312158c419720abChris Lattner/* 94a10645c70199c8d8567fbc46312158c419720abChris LattnerBUGPOINT NOTES: 104a10645c70199c8d8567fbc46312158c419720abChris Lattner 114a10645c70199c8d8567fbc46312158c419720abChris Lattner1. Bugpoint should not leave any files behind if the program works properly 124a10645c70199c8d8567fbc46312158c419720abChris Lattner2. There should be an option to specify the program name, which specifies a 134a10645c70199c8d8567fbc46312158c419720abChris Lattner unique string to put into output files. This allows operation in the 145073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman SingleSource directory, e.g. default to the first input filename. 154a10645c70199c8d8567fbc46312158c419720abChris Lattner*/ 164a10645c70199c8d8567fbc46312158c419720abChris Lattner 174a10645c70199c8d8567fbc46312158c419720abChris Lattner#include "BugDriver.h" 184a10645c70199c8d8567fbc46312158c419720abChris Lattner#include "Support/CommandLine.h" 19c648dabf65c67d20c208ed0b39b9622387e636c7Chris Lattner#include "Support/Debug.h" 2065f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner#include "Support/FileUtilities.h" 21e49603d79d220a795bd50684c8b1f503ee40f97fMisha Brukman#include "Support/SystemUtils.h" 225de0bac111fc9d4e290b9a743a02b866154c12e5Chris Lattner#include "llvm/Support/ToolRunner.h" 234a10645c70199c8d8567fbc46312158c419720abChris Lattner#include <fstream> 24e1b52b765675015eee5ce9efdb1b81c6c3eaefb1Chris Lattner#include <iostream> 254a10645c70199c8d8567fbc46312158c419720abChris Lattner 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 { 314a10645c70199c8d8567fbc46312158c419720abChris Lattner RunLLI, RunJIT, RunLLC, RunCBE 324a10645c70199c8d8567fbc46312158c419720abChris Lattner }; 334148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman 344a10645c70199c8d8567fbc46312158c419720abChris Lattner cl::opt<OutputType> 354a10645c70199c8d8567fbc46312158c419720abChris Lattner InterpreterSel(cl::desc("Specify how LLVM code should be executed:"), 365073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"), 375073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunJIT, "run-jit", "Execute with JIT"), 385073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunLLC, "run-llc", "Compile with LLC"), 395073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman clEnumValN(RunCBE, "run-cbe", "Compile with CBE"), 405073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 0)); 413c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner 423c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::opt<std::string> 433c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner InputFile("input", cl::init("/dev/null"), 443c053a0a98e19f5ac8905011ad4c8238b08d6aeaChris Lattner cl::desc("Filename to pipe in as stdin (default: /dev/null)")); 454a10645c70199c8d8567fbc46312158c419720abChris Lattner} 464a10645c70199c8d8567fbc46312158c419720abChris Lattner 479d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman// Anything specified after the --args option are taken as arguments to the 489d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman// program being debugged. 499d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukmancl::list<std::string> 509d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha BrukmanInputArgv("args", cl::Positional, cl::desc("<program arguments>..."), 519d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman cl::ZeroOrMore); 529d679cbc6cb5c7dc8cca87a1e1548c480fb056b8Misha Brukman 534a10645c70199c8d8567fbc46312158c419720abChris Lattner//===----------------------------------------------------------------------===// 544a10645c70199c8d8567fbc46312158c419720abChris Lattner// BugDriver method implementation 554a10645c70199c8d8567fbc46312158c419720abChris Lattner// 564a10645c70199c8d8567fbc46312158c419720abChris Lattner 574a10645c70199c8d8567fbc46312158c419720abChris Lattner/// initializeExecutionEnvironment - This method is used to set up the 584a10645c70199c8d8567fbc46312158c419720abChris Lattner/// environment for executing LLVM programs. 594a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 604a10645c70199c8d8567fbc46312158c419720abChris Lattnerbool BugDriver::initializeExecutionEnvironment() { 614a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cout << "Initializing execution environment: "; 624a10645c70199c8d8567fbc46312158c419720abChris Lattner 634a10645c70199c8d8567fbc46312158c419720abChris Lattner // FIXME: This should default to searching for the best interpreter to use on 644a10645c70199c8d8567fbc46312158c419720abChris Lattner // this platform, which would be JIT, then LLC, then CBE, then LLI. 654a10645c70199c8d8567fbc46312158c419720abChris Lattner 664148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // Create an instance of the AbstractInterpreter interface as specified on 674148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman // the command line 684a10645c70199c8d8567fbc46312158c419720abChris Lattner std::string Message; 69cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner switch (InterpreterSel) { 704148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman case RunLLI: Interpreter = createLLItool(getToolName(), Message); break; 714148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman case RunLLC: Interpreter = createLLCtool(getToolName(), Message); break; 724148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman case RunJIT: Interpreter = createJITtool(getToolName(), Message); break; 734148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman case RunCBE: Interpreter = createCBEtool(getToolName(), Message); break; 74cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner default: 754148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; 76cc876a7421f6dbcca98446058d5f0637092c6e1aChris Lattner break; 774a10645c70199c8d8567fbc46312158c419720abChris Lattner } 784148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman std::cerr << Message; 794a10645c70199c8d8567fbc46312158c419720abChris Lattner 80a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman // Initialize auxiliary tools for debugging 814148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman cbe = createCBEtool(getToolName(), Message); 82a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } 834148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman gcc = createGCCtool(getToolName(), Message); 84a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); } 85a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman 864a10645c70199c8d8567fbc46312158c419720abChris Lattner // If there was an error creating the selected interpreter, quit with error. 874a10645c70199c8d8567fbc46312158c419720abChris Lattner return Interpreter == 0; 884a10645c70199c8d8567fbc46312158c419720abChris Lattner} 894a10645c70199c8d8567fbc46312158c419720abChris Lattner 904a10645c70199c8d8567fbc46312158c419720abChris Lattner 914a10645c70199c8d8567fbc46312158c419720abChris Lattner/// executeProgram - This method runs "Program", capturing the output of the 924a10645c70199c8d8567fbc46312158c419720abChris Lattner/// program to a file, returning the filename of the file. A recommended 934a10645c70199c8d8567fbc46312158c419720abChris Lattner/// filename may be optionally specified. 944a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 954a10645c70199c8d8567fbc46312158c419720abChris Lattnerstd::string BugDriver::executeProgram(std::string OutputFile, 965073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string BytecodeFile, 975073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string SharedObject, 985073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman AbstractInterpreter *AI) { 994148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman assert((Interpreter||AI) && "Interpreter should have been created already!"); 1004a10645c70199c8d8567fbc46312158c419720abChris Lattner bool CreatedBytecode = false; 1014a10645c70199c8d8567fbc46312158c419720abChris Lattner if (BytecodeFile.empty()) { 1024a10645c70199c8d8567fbc46312158c419720abChris Lattner // Emit the program to a bytecode file... 1034a10645c70199c8d8567fbc46312158c419720abChris Lattner BytecodeFile = getUniqueFilename("bugpoint-test-program.bc"); 1044a10645c70199c8d8567fbc46312158c419720abChris Lattner 1054a10645c70199c8d8567fbc46312158c419720abChris Lattner if (writeProgramToFile(BytecodeFile, Program)) { 1064a10645c70199c8d8567fbc46312158c419720abChris Lattner std::cerr << ToolName << ": Error emitting bytecode to file '" 1075073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman << BytecodeFile << "'!\n"; 1084a10645c70199c8d8567fbc46312158c419720abChris Lattner exit(1); 1094a10645c70199c8d8567fbc46312158c419720abChris Lattner } 1104a10645c70199c8d8567fbc46312158c419720abChris Lattner CreatedBytecode = true; 1114a10645c70199c8d8567fbc46312158c419720abChris Lattner } 1124a10645c70199c8d8567fbc46312158c419720abChris Lattner 1134a10645c70199c8d8567fbc46312158c419720abChris Lattner if (OutputFile.empty()) OutputFile = "bugpoint-execution-output"; 1145073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1154a10645c70199c8d8567fbc46312158c419720abChris Lattner // Check to see if this is a valid output filename... 1164a10645c70199c8d8567fbc46312158c419720abChris Lattner OutputFile = getUniqueFilename(OutputFile); 1174a10645c70199c8d8567fbc46312158c419720abChris Lattner 1184a10645c70199c8d8567fbc46312158c419720abChris Lattner // Actually execute the program! 1195073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman int RetVal = (AI != 0) ? 1204148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, OutputFile, 1214148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman SharedObject) : 1224148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman Interpreter->ExecuteProgram(BytecodeFile, InputArgv, 1234148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman InputFile, OutputFile, SharedObject); 1244a10645c70199c8d8567fbc46312158c419720abChris Lattner 1254a10645c70199c8d8567fbc46312158c419720abChris Lattner // Remove the temporary bytecode file. 1265073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman if (CreatedBytecode) removeFile(BytecodeFile); 1274a10645c70199c8d8567fbc46312158c419720abChris Lattner 1284a10645c70199c8d8567fbc46312158c419720abChris Lattner // Return the filename we captured the output to. 1294a10645c70199c8d8567fbc46312158c419720abChris Lattner return OutputFile; 1304a10645c70199c8d8567fbc46312158c419720abChris Lattner} 1314a10645c70199c8d8567fbc46312158c419720abChris Lattner 1325073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukmanstd::string BugDriver::executeProgramWithCBE(std::string OutputFile, 1335073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string BytecodeFile, 1345073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string SharedObject) { 135a259c9be2acc9528ec7feb3cfd51dcde36d87bb3Misha Brukman return executeProgram(OutputFile, BytecodeFile, SharedObject, cbe); 1365073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman} 1375073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 138a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattnerstd::string BugDriver::compileSharedObject(const std::string &BytecodeFile) { 1395073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman assert(Interpreter && "Interpreter should have been created already!"); 140a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string OutputCFile; 1415073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1425073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Using CBE 1435073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman cbe->OutputC(BytecodeFile, OutputCFile); 1445073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1455073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman#if 0 /* This is an alternative, as yet unimplemented */ 1465073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Using LLC 147a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string Message; 1484148556a9c767fdf3047ae8e004a759356b893ddMisha Brukman LLC *llc = createLLCtool(Message); 1495073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman if (llc->OutputAsm(BytecodeFile, OutputFile)) { 1505073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::cerr << "Could not generate asm code with `llc', exiting.\n"; 1515073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman exit(1); 1525073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman } 1535073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman#endif 1545073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 155a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner std::string SharedObjectFile; 156a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner if (gcc->MakeSharedObject(OutputCFile, CFile, SharedObject)) 157a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner exit(1); 1585073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1595073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman // Remove the intermediate C file 1605073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman removeFile(OutputCFile); 1615073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 162a0f5b15e1eb8642d92b3141a6b88a5729ea979dcChris Lattner return SharedObjectFile; 1635073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman} 1645073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1655073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman 1664a10645c70199c8d8567fbc46312158c419720abChris Lattner/// diffProgram - This method executes the specified module and diffs the output 1674a10645c70199c8d8567fbc46312158c419720abChris Lattner/// against the file specified by ReferenceOutputFile. If the output is 1684a10645c70199c8d8567fbc46312158c419720abChris Lattner/// different, true is returned. 1694a10645c70199c8d8567fbc46312158c419720abChris Lattner/// 1705073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukmanbool BugDriver::diffProgram(const std::string &BytecodeFile, 1715073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman const std::string &SharedObject, 172640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner bool RemoveBytecode) { 1734a10645c70199c8d8567fbc46312158c419720abChris Lattner // Execute the program, generating an output file... 1745073336cd4da5df4ae13a167582d1dc90f32e4e0Misha Brukman std::string Output = executeProgram("", BytecodeFile, SharedObject); 1754a10645c70199c8d8567fbc46312158c419720abChris Lattner 17665f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner std::string Error; 1774a10645c70199c8d8567fbc46312158c419720abChris Lattner bool FilesDifferent = false; 17865f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner if (DiffFiles(ReferenceOutputFile, Output, &Error)) { 17965f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner if (!Error.empty()) { 18065f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner std::cerr << "While diffing output: " << Error << "\n"; 18165f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner exit(1); 18265f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 18365f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner FilesDifferent = true; 18465f62790d6e3e7f7ceb9cd12a7a51a66d95a3b03Chris Lattner } 1854a10645c70199c8d8567fbc46312158c419720abChris Lattner 186640f22e66d90439857a97a83896ee68c4f7128c9Chris Lattner if (RemoveBytecode) removeFile(BytecodeFile); 1874a10645c70199c8d8567fbc46312158c419720abChris Lattner return FilesDifferent; 1884a10645c70199c8d8567fbc46312158c419720abChris Lattner} 18991eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman 19091eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukmanbool BugDriver::isExecutingJIT() { 19191eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman return InterpreterSel == RunJIT; 19291eabc13d3a456cc4b387d3d7fdb041d976732c7Misha Brukman} 193