1 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains code used to execute the program utilizing one of the
11 // various ways of running LLVM bytecode.
13 //===----------------------------------------------------------------------===//
18 1. Bugpoint should not leave any files behind if the program works properly
19 2. There should be an option to specify the program name, which specifies a
20 unique string to put into output files. This allows operation in the
21 SingleSource directory, e.g. default to the first input filename.
24 #include "BugDriver.h"
25 #include "Support/CommandLine.h"
26 #include "Support/Debug.h"
27 #include "Support/FileUtilities.h"
28 #include "Support/SystemUtils.h"
29 #include "llvm/Support/ToolRunner.h"
35 // OutputType - Allow the user to specify the way code should be run, to test
36 // for miscompilation.
39 AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
43 InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
44 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
45 clEnumValN(RunLLI, "run-int", "Execute with the interpreter"),
46 clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
47 clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
48 clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
53 CheckProgramExitCode("check-exit-code",
54 cl::desc("Assume nonzero exit code is failure (default on)"),
58 InputFile("input", cl::init("/dev/null"),
59 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
62 AdditionalSOs("additional-so",
63 cl::desc("Additional shared objects to load "
64 "into executing programs"));
68 // Anything specified after the --args option are taken as arguments to the
69 // program being debugged.
71 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
75 //===----------------------------------------------------------------------===//
76 // BugDriver method implementation
79 /// initializeExecutionEnvironment - This method is used to set up the
80 /// environment for executing LLVM programs.
82 bool BugDriver::initializeExecutionEnvironment() {
83 std::cout << "Initializing execution environment: ";
85 // Create an instance of the AbstractInterpreter interface as specified on
89 switch (InterpreterSel) {
91 InterpreterSel = RunCBE;
92 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message);
94 InterpreterSel = RunJIT;
95 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
98 InterpreterSel = RunLLC;
99 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
102 InterpreterSel = RunLLI;
103 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
106 InterpreterSel = AutoPick;
107 Message = "Sorry, I can't automatically select an interpreter!\n";
111 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
114 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
117 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
120 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message);
123 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
126 std::cerr << Message;
128 // Initialize auxiliary tools for debugging
130 cbe = AbstractInterpreter::createCBE(getToolName(), Message);
131 if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
133 gcc = GCC::create(getToolName(), Message);
134 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
136 // If there was an error creating the selected interpreter, quit with error.
137 return Interpreter == 0;
141 /// executeProgram - This method runs "Program", capturing the output of the
142 /// program to a file, returning the filename of the file. A recommended
143 /// filename may be optionally specified.
145 std::string BugDriver::executeProgram(std::string OutputFile,
146 std::string BytecodeFile,
147 const std::string &SharedObj,
148 AbstractInterpreter *AI,
149 bool *ProgramExitedNonzero) {
150 if (AI == 0) AI = Interpreter;
151 assert(AI && "Interpreter should have been created already!");
152 bool CreatedBytecode = false;
153 if (BytecodeFile.empty()) {
154 // Emit the program to a bytecode file...
155 BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
157 if (writeProgramToFile(BytecodeFile, Program)) {
158 std::cerr << ToolName << ": Error emitting bytecode to file '"
159 << BytecodeFile << "'!\n";
162 CreatedBytecode = true;
165 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
167 // Check to see if this is a valid output filename...
168 OutputFile = getUniqueFilename(OutputFile);
170 // Figure out which shared objects to run, if any.
171 std::vector<std::string> SharedObjs(AdditionalSOs);
172 if (!SharedObj.empty())
173 SharedObjs.push_back(SharedObj);
175 // Actually execute the program!
176 int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
177 OutputFile, SharedObjs);
179 if (ProgramExitedNonzero != 0)
180 *ProgramExitedNonzero = (RetVal != 0);
182 // Remove the temporary bytecode file.
183 if (CreatedBytecode) removeFile(BytecodeFile);
185 // Return the filename we captured the output to.
189 /// executeProgramWithCBE - Used to create reference output with the C
190 /// backend, if reference output is not provided.
192 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
193 bool ProgramExitedNonzero;
194 std::string outFN = executeProgram(OutputFile, "", "",
195 (AbstractInterpreter*)cbe,
196 &ProgramExitedNonzero);
197 if (ProgramExitedNonzero) {
199 << "Warning: While generating reference output, program exited with\n"
200 << "non-zero exit code. This will NOT be treated as a failure.\n";
201 CheckProgramExitCode = false;
206 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
207 assert(Interpreter && "Interpreter should have been created already!");
208 std::string OutputCFile;
211 cbe->OutputC(BytecodeFile, OutputCFile);
213 #if 0 /* This is an alternative, as yet unimplemented */
216 LLC *llc = createLLCtool(Message);
217 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
218 std::cerr << "Could not generate asm code with `llc', exiting.\n";
223 std::string SharedObjectFile;
224 if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
227 // Remove the intermediate C file
228 removeFile(OutputCFile);
230 return "./" + SharedObjectFile;
234 /// diffProgram - This method executes the specified module and diffs the output
235 /// against the file specified by ReferenceOutputFile. If the output is
236 /// different, true is returned.
238 bool BugDriver::diffProgram(const std::string &BytecodeFile,
239 const std::string &SharedObject,
240 bool RemoveBytecode) {
241 bool ProgramExitedNonzero;
243 // Execute the program, generating an output file...
244 std::string Output = executeProgram("", BytecodeFile, SharedObject, 0,
245 &ProgramExitedNonzero);
247 // If we're checking the program exit code, assume anything nonzero is bad.
248 if (CheckProgramExitCode && ProgramExitedNonzero)
252 bool FilesDifferent = false;
253 if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
254 if (!Error.empty()) {
255 std::cerr << "While diffing output: " << Error << "\n";
258 FilesDifferent = true;
261 // Remove the generated output.
264 // Remove the bytecode file if we are supposed to.
265 if (RemoveBytecode) removeFile(BytecodeFile);
266 return FilesDifferent;
269 bool BugDriver::isExecutingJIT() {
270 return InterpreterSel == RunJIT;