1 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
3 // This file contains code used to execute the program utilizing one of the
4 // various ways of running LLVM bytecode.
6 //===----------------------------------------------------------------------===//
11 1. Bugpoint should not leave any files behind if the program works properly
12 2. There should be an option to specify the program name, which specifies a
13 unique string to put into output files. This allows operation in the
14 SingleSource directory, e.g. default to the first input filename.
17 #include "BugDriver.h"
18 #include "Support/CommandLine.h"
19 #include "Support/Debug.h"
20 #include "Support/FileUtilities.h"
21 #include "Support/SystemUtils.h"
22 #include "llvm/Support/ToolRunner.h"
27 // OutputType - Allow the user to specify the way code should be run, to test
28 // for miscompilation.
31 RunLLI, RunJIT, RunLLC, RunCBE
35 InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
36 cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"),
37 clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
38 clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
39 clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
44 InputFile("input", cl::init("/dev/null"),
45 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
48 AdditionalSOs("additional-so",
49 cl::desc("Additional shared objects to load "
50 "into executing programs"));
53 // Anything specified after the --args option are taken as arguments to the
54 // program being debugged.
56 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
59 //===----------------------------------------------------------------------===//
60 // BugDriver method implementation
63 /// initializeExecutionEnvironment - This method is used to set up the
64 /// environment for executing LLVM programs.
66 bool BugDriver::initializeExecutionEnvironment() {
67 std::cout << "Initializing execution environment: ";
69 // FIXME: This should default to searching for the best interpreter to use on
70 // this platform, which would be JIT, then LLC, then CBE, then LLI.
72 // Create an instance of the AbstractInterpreter interface as specified on
75 switch (InterpreterSel) {
77 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
80 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
83 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
86 Interpreter = AbstractInterpreter::createCBE(getToolName(), Message);
89 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
94 // Initialize auxiliary tools for debugging
95 cbe = AbstractInterpreter::createCBE(getToolName(), Message);
96 if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
97 gcc = GCC::create(getToolName(), Message);
98 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
100 // If there was an error creating the selected interpreter, quit with error.
101 return Interpreter == 0;
105 /// executeProgram - This method runs "Program", capturing the output of the
106 /// program to a file, returning the filename of the file. A recommended
107 /// filename may be optionally specified.
109 std::string BugDriver::executeProgram(std::string OutputFile,
110 std::string BytecodeFile,
111 const std::string &SharedObj,
112 AbstractInterpreter *AI) {
113 if (AI == 0) AI = Interpreter;
114 assert(AI && "Interpreter should have been created already!");
115 bool CreatedBytecode = false;
116 if (BytecodeFile.empty()) {
117 // Emit the program to a bytecode file...
118 BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
120 if (writeProgramToFile(BytecodeFile, Program)) {
121 std::cerr << ToolName << ": Error emitting bytecode to file '"
122 << BytecodeFile << "'!\n";
125 CreatedBytecode = true;
128 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
130 // Check to see if this is a valid output filename...
131 OutputFile = getUniqueFilename(OutputFile);
133 // Figure out which shared objects to run, if any.
134 std::vector<std::string> SharedObjs(AdditionalSOs);
135 if (!SharedObj.empty())
136 SharedObjs.push_back(SharedObj);
138 // Actually execute the program!
139 int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
140 OutputFile, SharedObjs);
143 // Remove the temporary bytecode file.
144 if (CreatedBytecode) removeFile(BytecodeFile);
146 // Return the filename we captured the output to.
151 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
152 assert(Interpreter && "Interpreter should have been created already!");
153 std::string OutputCFile;
156 cbe->OutputC(BytecodeFile, OutputCFile);
158 #if 0 /* This is an alternative, as yet unimplemented */
161 LLC *llc = createLLCtool(Message);
162 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
163 std::cerr << "Could not generate asm code with `llc', exiting.\n";
168 std::string SharedObjectFile;
169 if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
172 // Remove the intermediate C file
173 removeFile(OutputCFile);
175 return SharedObjectFile;
179 /// diffProgram - This method executes the specified module and diffs the output
180 /// against the file specified by ReferenceOutputFile. If the output is
181 /// different, true is returned.
183 bool BugDriver::diffProgram(const std::string &BytecodeFile,
184 const std::string &SharedObject,
185 bool RemoveBytecode) {
186 // Execute the program, generating an output file...
187 std::string Output = executeProgram("", BytecodeFile, SharedObject);
190 bool FilesDifferent = false;
191 if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
192 if (!Error.empty()) {
193 std::cerr << "While diffing output: " << Error << "\n";
196 FilesDifferent = true;
199 if (RemoveBytecode) removeFile(BytecodeFile);
200 return FilesDifferent;
203 bool BugDriver::isExecutingJIT() {
204 return InterpreterSel == RunJIT;