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;
140 /// compileProgram - Try to compile the specified module, throwing an exception
141 /// if an error occurs, or returning normally if not. This is used for code
142 /// generation crash testing.
144 void BugDriver::compileProgram(Module *M) {
145 // Emit the program to a bytecode file...
146 std::string BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
147 if (writeProgramToFile(BytecodeFile, M)) {
148 std::cerr << ToolName << ": Error emitting bytecode to file '"
149 << BytecodeFile << "'!\n";
153 // Remove the temporary bytecode file when we are done.
154 FileRemover BytecodeFileRemover(BytecodeFile);
156 // Actually compile the program!
157 Interpreter->compileProgram(BytecodeFile);
161 /// executeProgram - This method runs "Program", capturing the output of the
162 /// program to a file, returning the filename of the file. A recommended
163 /// filename may be optionally specified.
165 std::string BugDriver::executeProgram(std::string OutputFile,
166 std::string BytecodeFile,
167 const std::string &SharedObj,
168 AbstractInterpreter *AI,
169 bool *ProgramExitedNonzero) {
170 if (AI == 0) AI = Interpreter;
171 assert(AI && "Interpreter should have been created already!");
172 bool CreatedBytecode = false;
173 if (BytecodeFile.empty()) {
174 // Emit the program to a bytecode file...
175 BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
177 if (writeProgramToFile(BytecodeFile, Program)) {
178 std::cerr << ToolName << ": Error emitting bytecode to file '"
179 << BytecodeFile << "'!\n";
182 CreatedBytecode = true;
185 // Remove the temporary bytecode file when we are done.
186 FileRemover BytecodeFileRemover(BytecodeFile, CreatedBytecode);
188 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
190 // Check to see if this is a valid output filename...
191 OutputFile = getUniqueFilename(OutputFile);
193 // Figure out which shared objects to run, if any.
194 std::vector<std::string> SharedObjs(AdditionalSOs);
195 if (!SharedObj.empty())
196 SharedObjs.push_back(SharedObj);
198 // Actually execute the program!
199 int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
200 OutputFile, SharedObjs);
202 if (ProgramExitedNonzero != 0)
203 *ProgramExitedNonzero = (RetVal != 0);
205 // Return the filename we captured the output to.
209 /// executeProgramWithCBE - Used to create reference output with the C
210 /// backend, if reference output is not provided.
212 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
213 bool ProgramExitedNonzero;
214 std::string outFN = executeProgram(OutputFile, "", "",
215 (AbstractInterpreter*)cbe,
216 &ProgramExitedNonzero);
217 if (ProgramExitedNonzero) {
219 << "Warning: While generating reference output, program exited with\n"
220 << "non-zero exit code. This will NOT be treated as a failure.\n";
221 CheckProgramExitCode = false;
226 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
227 assert(Interpreter && "Interpreter should have been created already!");
228 std::string OutputCFile;
231 cbe->OutputC(BytecodeFile, OutputCFile);
233 #if 0 /* This is an alternative, as yet unimplemented */
236 LLC *llc = createLLCtool(Message);
237 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
238 std::cerr << "Could not generate asm code with `llc', exiting.\n";
243 std::string SharedObjectFile;
244 if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
247 // Remove the intermediate C file
248 removeFile(OutputCFile);
250 return "./" + SharedObjectFile;
254 /// diffProgram - This method executes the specified module and diffs the output
255 /// against the file specified by ReferenceOutputFile. If the output is
256 /// different, true is returned.
258 bool BugDriver::diffProgram(const std::string &BytecodeFile,
259 const std::string &SharedObject,
260 bool RemoveBytecode) {
261 bool ProgramExitedNonzero;
263 // Execute the program, generating an output file...
264 std::string Output = executeProgram("", BytecodeFile, SharedObject, 0,
265 &ProgramExitedNonzero);
267 // If we're checking the program exit code, assume anything nonzero is bad.
268 if (CheckProgramExitCode && ProgramExitedNonzero) {
270 if (RemoveBytecode) removeFile(BytecodeFile);
275 bool FilesDifferent = false;
276 if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
277 if (!Error.empty()) {
278 std::cerr << "While diffing output: " << Error << "\n";
281 FilesDifferent = true;
284 // Remove the generated output.
287 // Remove the bytecode file if we are supposed to.
288 if (RemoveBytecode) removeFile(BytecodeFile);
289 return FilesDifferent;
292 bool BugDriver::isExecutingJIT() {
293 return InterpreterSel == RunJIT;