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 //===----------------------------------------------------------------------===//
15 #include "BugDriver.h"
16 #include "llvm/Support/ToolRunner.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/Debug.h"
19 #include "llvm/Support/FileUtilities.h"
20 #include "llvm/Support/SystemUtils.h"
25 // OutputType - Allow the user to specify the way code should be run, to test
26 // for miscompilation.
29 AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
33 InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
34 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
35 clEnumValN(RunLLI, "run-int",
36 "Execute with the interpreter"),
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 CheckProgramExitCode("check-exit-code",
45 cl::desc("Assume nonzero exit code is failure (default on)"),
49 InputFile("input", cl::init("/dev/null"),
50 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
53 AdditionalSOs("additional-so",
54 cl::desc("Additional shared objects to load "
55 "into executing programs"));
58 TimeoutValue("timeout", cl::init(300), cl::value_desc("seconds"),
59 cl::desc("Number of seconds program is allowed to run before it "
60 "is killed (default is 300s), 0 disables timeout"));
64 // Anything specified after the --args option are taken as arguments to the
65 // program being debugged.
67 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
68 cl::ZeroOrMore, cl::PositionalEatsArgs);
71 ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
72 cl::ZeroOrMore, cl::PositionalEatsArgs);
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
90 switch (InterpreterSel) {
92 InterpreterSel = RunCBE;
93 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
96 InterpreterSel = RunJIT;
97 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
101 InterpreterSel = RunLLC;
102 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
106 InterpreterSel = RunLLI;
107 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
111 InterpreterSel = AutoPick;
112 Message = "Sorry, I can't automatically select an interpreter!\n";
116 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
120 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
124 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
128 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
132 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
135 std::cerr << Message;
137 // Initialize auxiliary tools for debugging
139 cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
140 if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
142 gcc = GCC::create(getToolName(), Message);
143 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
145 // If there was an error creating the selected interpreter, quit with error.
146 return Interpreter == 0;
149 /// compileProgram - Try to compile the specified module, throwing an exception
150 /// if an error occurs, or returning normally if not. This is used for code
151 /// generation crash testing.
153 void BugDriver::compileProgram(Module *M) {
154 // Emit the program to a bytecode file...
155 std::string BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
156 if (writeProgramToFile(BytecodeFile, M)) {
157 std::cerr << ToolName << ": Error emitting bytecode to file '"
158 << BytecodeFile << "'!\n";
162 // Remove the temporary bytecode file when we are done.
163 FileRemover BytecodeFileRemover(BytecodeFile);
165 // Actually compile the program!
166 Interpreter->compileProgram(BytecodeFile);
170 /// executeProgram - This method runs "Program", capturing the output of the
171 /// program to a file, returning the filename of the file. A recommended
172 /// filename may be optionally specified.
174 std::string BugDriver::executeProgram(std::string OutputFile,
175 std::string BytecodeFile,
176 const std::string &SharedObj,
177 AbstractInterpreter *AI,
178 bool *ProgramExitedNonzero) {
179 if (AI == 0) AI = Interpreter;
180 assert(AI && "Interpreter should have been created already!");
181 bool CreatedBytecode = false;
182 if (BytecodeFile.empty()) {
183 // Emit the program to a bytecode file...
184 BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
186 if (writeProgramToFile(BytecodeFile, Program)) {
187 std::cerr << ToolName << ": Error emitting bytecode to file '"
188 << BytecodeFile << "'!\n";
191 CreatedBytecode = true;
194 // Remove the temporary bytecode file when we are done.
195 FileRemover BytecodeFileRemover(BytecodeFile, CreatedBytecode);
197 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
199 // Check to see if this is a valid output filename...
200 OutputFile = getUniqueFilename(OutputFile);
202 // Figure out which shared objects to run, if any.
203 std::vector<std::string> SharedObjs(AdditionalSOs);
204 if (!SharedObj.empty())
205 SharedObjs.push_back(SharedObj);
207 // Actually execute the program!
208 int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
209 OutputFile, SharedObjs, TimeoutValue);
212 std::cerr << "<timeout>";
213 static bool FirstTimeout = true;
216 "*** Program execution timed out! This mechanism is designed to handle\n"
217 " programs stuck in infinite loops gracefully. The -timeout option\n"
218 " can be used to change the timeout threshold or disable it completely\n"
219 " (with -timeout=0). This message is only displayed once.\n";
220 FirstTimeout = false;
224 if (ProgramExitedNonzero != 0)
225 *ProgramExitedNonzero = (RetVal != 0);
227 // Return the filename we captured the output to.
231 /// executeProgramWithCBE - Used to create reference output with the C
232 /// backend, if reference output is not provided.
234 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
235 bool ProgramExitedNonzero;
236 std::string outFN = executeProgram(OutputFile, "", "",
237 (AbstractInterpreter*)cbe,
238 &ProgramExitedNonzero);
239 if (ProgramExitedNonzero) {
241 << "Warning: While generating reference output, program exited with\n"
242 << "non-zero exit code. This will NOT be treated as a failure.\n";
243 CheckProgramExitCode = false;
248 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
249 assert(Interpreter && "Interpreter should have been created already!");
250 std::string OutputCFile;
253 cbe->OutputC(BytecodeFile, OutputCFile);
255 #if 0 /* This is an alternative, as yet unimplemented */
258 LLC *llc = createLLCtool(Message);
259 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
260 std::cerr << "Could not generate asm code with `llc', exiting.\n";
265 std::string SharedObjectFile;
266 if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
269 // Remove the intermediate C file
270 removeFile(OutputCFile);
272 return "./" + SharedObjectFile;
276 /// diffProgram - This method executes the specified module and diffs the output
277 /// against the file specified by ReferenceOutputFile. If the output is
278 /// different, true is returned.
280 bool BugDriver::diffProgram(const std::string &BytecodeFile,
281 const std::string &SharedObject,
282 bool RemoveBytecode) {
283 bool ProgramExitedNonzero;
285 // Execute the program, generating an output file...
286 std::string Output = executeProgram("", BytecodeFile, SharedObject, 0,
287 &ProgramExitedNonzero);
289 // If we're checking the program exit code, assume anything nonzero is bad.
290 if (CheckProgramExitCode && ProgramExitedNonzero) {
292 if (RemoveBytecode) removeFile(BytecodeFile);
297 bool FilesDifferent = false;
298 if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
299 if (!Error.empty()) {
300 std::cerr << "While diffing output: " << Error << '\n';
303 FilesDifferent = true;
306 // Remove the generated output.
309 // Remove the bytecode file if we are supposed to.
310 if (RemoveBytecode) removeFile(BytecodeFile);
311 return FilesDifferent;
314 bool BugDriver::isExecutingJIT() {
315 return InterpreterSel == RunJIT;