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 "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"
27 // OutputType - Allow the user to specify the way code should be run, to test
28 // for miscompilation.
31 AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
35 AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"),
38 RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"),
42 InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
43 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
44 clEnumValN(RunLLI, "run-int",
45 "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"));
67 AdditionalLinkerArgs("Xlinker",
68 cl::desc("Additional arguments to pass to the linker"));
72 // Anything specified after the --args option are taken as arguments to the
73 // program being debugged.
75 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
76 cl::ZeroOrMore, cl::PositionalEatsArgs);
79 ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
80 cl::ZeroOrMore, cl::PositionalEatsArgs);
83 //===----------------------------------------------------------------------===//
84 // BugDriver method implementation
87 /// initializeExecutionEnvironment - This method is used to set up the
88 /// environment for executing LLVM programs.
90 bool BugDriver::initializeExecutionEnvironment() {
91 std::cout << "Initializing execution environment: ";
93 // Create an instance of the AbstractInterpreter interface as specified on
98 switch (InterpreterSel) {
100 InterpreterSel = RunCBE;
101 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
104 InterpreterSel = RunJIT;
105 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
109 InterpreterSel = RunLLC;
110 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
114 InterpreterSel = RunLLI;
115 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
119 InterpreterSel = AutoPick;
120 Message = "Sorry, I can't automatically select an interpreter!\n";
124 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
128 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
132 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
136 Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
140 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
143 std::cerr << Message;
145 // Initialize auxiliary tools for debugging
147 cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
148 if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
150 gcc = GCC::create(getToolName(), Message);
151 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
153 // If there was an error creating the selected interpreter, quit with error.
154 return Interpreter == 0;
157 /// compileProgram - Try to compile the specified module, throwing an exception
158 /// if an error occurs, or returning normally if not. This is used for code
159 /// generation crash testing.
161 void BugDriver::compileProgram(Module *M) {
162 // Emit the program to a bytecode file...
163 sys::Path BytecodeFile ("bugpoint-test-program.bc");
164 BytecodeFile.makeUnique();
165 if (writeProgramToFile(BytecodeFile.toString(), M)) {
166 std::cerr << ToolName << ": Error emitting bytecode to file '"
167 << BytecodeFile << "'!\n";
171 // Remove the temporary bytecode file when we are done.
172 FileRemover BytecodeFileRemover(BytecodeFile);
174 // Actually compile the program!
175 Interpreter->compileProgram(BytecodeFile.toString());
179 /// executeProgram - This method runs "Program", capturing the output of the
180 /// program to a file, returning the filename of the file. A recommended
181 /// filename may be optionally specified.
183 std::string BugDriver::executeProgram(std::string OutputFile,
184 std::string BytecodeFile,
185 const std::string &SharedObj,
186 AbstractInterpreter *AI,
187 bool *ProgramExitedNonzero) {
188 if (AI == 0) AI = Interpreter;
189 assert(AI && "Interpreter should have been created already!");
190 bool CreatedBytecode = false;
191 if (BytecodeFile.empty()) {
192 // Emit the program to a bytecode file...
193 sys::Path uniqueFilename("bugpoint-test-program.bc");
194 uniqueFilename.makeUnique();
195 BytecodeFile = uniqueFilename.toString();
197 if (writeProgramToFile(BytecodeFile, Program)) {
198 std::cerr << ToolName << ": Error emitting bytecode to file '"
199 << BytecodeFile << "'!\n";
202 CreatedBytecode = true;
205 // Remove the temporary bytecode file when we are done.
206 sys::Path BytecodePath (BytecodeFile);
207 FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode);
209 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
211 // Check to see if this is a valid output filename...
212 sys::Path uniqueFile(OutputFile);
213 uniqueFile.makeUnique();
214 OutputFile = uniqueFile.toString();
216 // Figure out which shared objects to run, if any.
217 std::vector<std::string> SharedObjs(AdditionalSOs);
218 if (!SharedObj.empty())
219 SharedObjs.push_back(SharedObj);
222 // If this is an LLC or CBE run, then the GCC compiler might get run to
223 // compile the program. If so, we should pass the user's -Xlinker options
226 if (InterpreterSel == RunLLC || InterpreterSel == RunCBE)
227 RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
228 OutputFile, AdditionalLinkerArgs, SharedObjs,
231 RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
232 OutputFile, std::vector<std::string>(),
233 SharedObjs, Timeout);
236 std::cerr << "<timeout>";
237 static bool FirstTimeout = true;
240 "*** Program execution timed out! This mechanism is designed to handle\n"
241 " programs stuck in infinite loops gracefully. The -timeout option\n"
242 " can be used to change the timeout threshold or disable it completely\n"
243 " (with -timeout=0). This message is only displayed once.\n";
244 FirstTimeout = false;
248 if (ProgramExitedNonzero != 0)
249 *ProgramExitedNonzero = (RetVal != 0);
251 // Return the filename we captured the output to.
255 /// executeProgramWithCBE - Used to create reference output with the C
256 /// backend, if reference output is not provided.
258 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
259 bool ProgramExitedNonzero;
260 std::string outFN = executeProgram(OutputFile, "", "",
261 (AbstractInterpreter*)cbe,
262 &ProgramExitedNonzero);
263 if (ProgramExitedNonzero) {
265 << "Warning: While generating reference output, program exited with\n"
266 << "non-zero exit code. This will NOT be treated as a failure.\n";
267 CheckProgramExitCode = false;
272 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
273 assert(Interpreter && "Interpreter should have been created already!");
274 sys::Path OutputCFile;
277 cbe->OutputC(BytecodeFile, OutputCFile);
279 #if 0 /* This is an alternative, as yet unimplemented */
282 LLC *llc = createLLCtool(Message);
283 if (llc->OutputAsm(BytecodeFile, OutputFile)) {
284 std::cerr << "Could not generate asm code with `llc', exiting.\n";
289 std::string SharedObjectFile;
290 if (gcc->MakeSharedObject(OutputCFile.toString(), GCC::CFile,
294 // Remove the intermediate C file
295 OutputCFile.eraseFromDisk();
297 return "./" + SharedObjectFile;
301 /// diffProgram - This method executes the specified module and diffs the output
302 /// against the file specified by ReferenceOutputFile. If the output is
303 /// different, true is returned.
305 bool BugDriver::diffProgram(const std::string &BytecodeFile,
306 const std::string &SharedObject,
307 bool RemoveBytecode) {
308 bool ProgramExitedNonzero;
310 // Execute the program, generating an output file...
311 sys::Path Output (executeProgram("", BytecodeFile, SharedObject, 0,
312 &ProgramExitedNonzero));
314 // If we're checking the program exit code, assume anything nonzero is bad.
315 if (CheckProgramExitCode && ProgramExitedNonzero) {
316 Output.eraseFromDisk();
318 sys::Path(BytecodeFile).eraseFromDisk();
323 bool FilesDifferent = false;
324 if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile),
325 sys::Path(Output.toString()),
326 AbsTolerance, RelTolerance, &Error)) {
328 std::cerr << "While diffing output: " << Error << '\n';
331 FilesDifferent = true;
334 // Remove the generated output.
335 Output.eraseFromDisk();
337 // Remove the bytecode file if we are supposed to.
339 sys::Path(BytecodeFile).eraseFromDisk();
340 return FilesDifferent;
343 bool BugDriver::isExecutingJIT() {
344 return InterpreterSel == RunJIT;