1 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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 bitcode.
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, CBE_bug, LLC_Safe, Custom
35 AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"),
38 RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"),
42 InterpreterSel(cl::desc("Specify the \"test\" i.e. suspect back-end:"),
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"),
49 clEnumValN(CBE_bug,"cbe-bug", "Find CBE bugs"),
50 clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"),
51 clEnumValN(Custom, "run-custom",
52 "Use -exec-command to define a command to execute "
53 "the bitcode. Useful for cross-compilation."),
58 SafeInterpreterSel(cl::desc("Specify \"safe\" i.e. known-good backend:"),
59 cl::values(clEnumValN(AutoPick, "safe-auto", "Use best guess"),
60 clEnumValN(RunLLC, "safe-run-llc", "Compile with LLC"),
61 clEnumValN(RunCBE, "safe-run-cbe", "Compile with CBE"),
62 clEnumValN(Custom, "safe-run-custom",
63 "Use -exec-command to define a command to execute "
64 "the bitcode. Useful for cross-compilation."),
69 SafeInterpreterPath("safe-path",
70 cl::desc("Specify the path to the \"safe\" backend program"),
74 AppendProgramExitCode("append-exit-code",
75 cl::desc("Append the exit code to the output so it gets diff'd too"),
79 InputFile("input", cl::init("/dev/null"),
80 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
83 AdditionalSOs("additional-so",
84 cl::desc("Additional shared objects to load "
85 "into executing programs"));
88 AdditionalLinkerArgs("Xlinker",
89 cl::desc("Additional arguments to pass to the linker"));
92 CustomExecCommand("exec-command", cl::init("simulate"),
93 cl::desc("Command to execute the bitcode (use with -run-custom) "
94 "(default: simulate)"));
98 // Anything specified after the --args option are taken as arguments to the
99 // program being debugged.
100 cl::list<std::string>
101 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
102 cl::ZeroOrMore, cl::PositionalEatsArgs);
106 cl::list<std::string>
107 ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
108 cl::ZeroOrMore, cl::PositionalEatsArgs);
110 cl::list<std::string>
111 SafeToolArgv("safe-tool-args", cl::Positional,
112 cl::desc("<safe-tool arguments>..."),
113 cl::ZeroOrMore, cl::PositionalEatsArgs);
116 //===----------------------------------------------------------------------===//
117 // BugDriver method implementation
120 /// initializeExecutionEnvironment - This method is used to set up the
121 /// environment for executing LLVM programs.
123 bool BugDriver::initializeExecutionEnvironment() {
124 std::cout << "Initializing execution environment: ";
126 // Create an instance of the AbstractInterpreter interface as specified on
131 switch (InterpreterSel) {
133 InterpreterSel = RunCBE;
135 AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
137 InterpreterSel = RunJIT;
138 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
142 InterpreterSel = RunLLC;
143 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
147 InterpreterSel = RunLLI;
148 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
152 InterpreterSel = AutoPick;
153 Message = "Sorry, I can't automatically select an interpreter!\n";
157 Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
162 Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
166 Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
171 Interpreter = AbstractInterpreter::createCBE(getToolName(), Message,
175 Interpreter = AbstractInterpreter::createCustom(getToolName(), Message,
179 Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
183 std::cerr << Message;
184 else // Display informational messages on stdout instead of stderr
185 std::cout << Message;
187 std::string Path = SafeInterpreterPath;
189 Path = getToolName();
190 std::vector<std::string> SafeToolArgs = SafeToolArgv;
191 switch (SafeInterpreterSel) {
193 // In "cbe-bug" mode, default to using LLC as the "safe" backend.
194 if (!SafeInterpreter &&
195 InterpreterSel == CBE_bug) {
196 SafeInterpreterSel = RunLLC;
197 SafeToolArgs.push_back("--relocation-model=pic");
198 SafeInterpreter = AbstractInterpreter::createLLC(Path, Message,
202 // In "llc-safe" mode, default to using LLC as the "safe" backend.
203 if (!SafeInterpreter &&
204 InterpreterSel == LLC_Safe) {
205 SafeInterpreterSel = RunLLC;
206 SafeToolArgs.push_back("--relocation-model=pic");
207 SafeInterpreter = AbstractInterpreter::createLLC(Path, Message,
211 // Pick a backend that's different from the test backend. The JIT and
212 // LLC backends share a lot of code, so prefer to use the CBE as the
213 // safe back-end when testing them.
214 if (!SafeInterpreter &&
215 InterpreterSel != RunCBE) {
216 SafeInterpreterSel = RunCBE;
217 SafeInterpreter = AbstractInterpreter::createCBE(Path, Message,
220 if (!SafeInterpreter &&
221 InterpreterSel != RunLLC &&
222 InterpreterSel != RunJIT) {
223 SafeInterpreterSel = RunLLC;
224 SafeToolArgs.push_back("--relocation-model=pic");
225 SafeInterpreter = AbstractInterpreter::createLLC(Path, Message,
228 if (!SafeInterpreter) {
229 SafeInterpreterSel = AutoPick;
230 Message = "Sorry, I can't automatically select an interpreter!\n";
234 SafeToolArgs.push_back("--relocation-model=pic");
235 SafeInterpreter = AbstractInterpreter::createLLC(Path, Message,
239 SafeInterpreter = AbstractInterpreter::createCBE(Path, Message,
243 SafeInterpreter = AbstractInterpreter::createCustom(Path, Message,
247 Message = "Sorry, this back-end is not supported by bugpoint as the "
248 "\"safe\" backend right now!\n";
251 if (!SafeInterpreter) { std::cout << Message << "\nExiting.\n"; exit(1); }
253 gcc = GCC::create(getToolName(), Message);
254 if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
256 // If there was an error creating the selected interpreter, quit with error.
257 return Interpreter == 0;
260 /// compileProgram - Try to compile the specified module, throwing an exception
261 /// if an error occurs, or returning normally if not. This is used for code
262 /// generation crash testing.
264 void BugDriver::compileProgram(Module *M) {
265 // Emit the program to a bitcode file...
266 sys::Path BitcodeFile ("bugpoint-test-program.bc");
268 if (BitcodeFile.makeUnique(true,&ErrMsg)) {
269 std::cerr << ToolName << ": Error making unique filename: " << ErrMsg
273 if (writeProgramToFile(BitcodeFile.toString(), M)) {
274 std::cerr << ToolName << ": Error emitting bitcode to file '"
275 << BitcodeFile << "'!\n";
279 // Remove the temporary bitcode file when we are done.
280 FileRemover BitcodeFileRemover(BitcodeFile);
282 // Actually compile the program!
283 Interpreter->compileProgram(BitcodeFile.toString());
287 /// executeProgram - This method runs "Program", capturing the output of the
288 /// program to a file, returning the filename of the file. A recommended
289 /// filename may be optionally specified.
291 std::string BugDriver::executeProgram(std::string OutputFile,
292 std::string BitcodeFile,
293 const std::string &SharedObj,
294 AbstractInterpreter *AI,
295 bool *ProgramExitedNonzero) {
296 if (AI == 0) AI = Interpreter;
297 assert(AI && "Interpreter should have been created already!");
298 bool CreatedBitcode = false;
300 if (BitcodeFile.empty()) {
301 // Emit the program to a bitcode file...
302 sys::Path uniqueFilename("bugpoint-test-program.bc");
303 if (uniqueFilename.makeUnique(true, &ErrMsg)) {
304 std::cerr << ToolName << ": Error making unique filename: "
308 BitcodeFile = uniqueFilename.toString();
310 if (writeProgramToFile(BitcodeFile, Program)) {
311 std::cerr << ToolName << ": Error emitting bitcode to file '"
312 << BitcodeFile << "'!\n";
315 CreatedBitcode = true;
318 // Remove the temporary bitcode file when we are done.
319 sys::Path BitcodePath (BitcodeFile);
320 FileRemover BitcodeFileRemover(BitcodePath, CreatedBitcode);
322 if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
324 // Check to see if this is a valid output filename...
325 sys::Path uniqueFile(OutputFile);
326 if (uniqueFile.makeUnique(true, &ErrMsg)) {
327 std::cerr << ToolName << ": Error making unique filename: "
331 OutputFile = uniqueFile.toString();
333 // Figure out which shared objects to run, if any.
334 std::vector<std::string> SharedObjs(AdditionalSOs);
335 if (!SharedObj.empty())
336 SharedObjs.push_back(SharedObj);
338 int RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile,
339 OutputFile, AdditionalLinkerArgs, SharedObjs,
340 Timeout, MemoryLimit);
343 std::cerr << "<timeout>";
344 static bool FirstTimeout = true;
347 "*** Program execution timed out! This mechanism is designed to handle\n"
348 " programs stuck in infinite loops gracefully. The -timeout option\n"
349 " can be used to change the timeout threshold or disable it completely\n"
350 " (with -timeout=0). This message is only displayed once.\n";
351 FirstTimeout = false;
355 if (AppendProgramExitCode) {
356 std::ofstream outFile(OutputFile.c_str(), std::ios_base::app);
357 outFile << "exit " << RetVal << '\n';
361 if (ProgramExitedNonzero != 0)
362 *ProgramExitedNonzero = (RetVal != 0);
364 // Return the filename we captured the output to.
368 /// executeProgramSafely - Used to create reference output with the "safe"
369 /// backend, if reference output is not provided.
371 std::string BugDriver::executeProgramSafely(std::string OutputFile) {
372 bool ProgramExitedNonzero;
373 std::string outFN = executeProgram(OutputFile, "", "", SafeInterpreter,
374 &ProgramExitedNonzero);
378 std::string BugDriver::compileSharedObject(const std::string &BitcodeFile) {
379 assert(Interpreter && "Interpreter should have been created already!");
380 sys::Path OutputFile;
382 // Using the known-good backend.
383 GCC::FileType FT = SafeInterpreter->OutputCode(BitcodeFile, OutputFile);
385 std::string SharedObjectFile;
386 if (gcc->MakeSharedObject(OutputFile.toString(), FT,
387 SharedObjectFile, AdditionalLinkerArgs))
390 // Remove the intermediate C file
391 OutputFile.eraseFromDisk();
393 return "./" + SharedObjectFile;
396 /// createReferenceFile - calls compileProgram and then records the output
397 /// into ReferenceOutputFile. Returns true if reference file created, false
398 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
401 bool BugDriver::createReferenceFile(Module *M, const std::string &Filename) {
403 compileProgram(Program);
404 } catch (ToolExecutionError &) {
408 ReferenceOutputFile = executeProgramSafely(Filename);
409 std::cout << "Reference output is: " << ReferenceOutputFile << "\n\n";
410 } catch (ToolExecutionError &TEE) {
411 std::cerr << TEE.what();
412 if (Interpreter != SafeInterpreter) {
413 std::cerr << "*** There is a bug running the \"safe\" backend. Either"
414 << " debug it (for example with the -run-cbe bugpoint option,"
415 << " if CBE is being used as the \"safe\" backend), or fix the"
416 << " error some other way.\n";
423 /// diffProgram - This method executes the specified module and diffs the
424 /// output against the file specified by ReferenceOutputFile. If the output
425 /// is different, true is returned. If there is a problem with the code
426 /// generator (e.g., llc crashes), this will throw an exception.
428 bool BugDriver::diffProgram(const std::string &BitcodeFile,
429 const std::string &SharedObject,
430 bool RemoveBitcode) {
431 bool ProgramExitedNonzero;
433 // Execute the program, generating an output file...
434 sys::Path Output(executeProgram("", BitcodeFile, SharedObject, 0,
435 &ProgramExitedNonzero));
438 bool FilesDifferent = false;
439 if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile),
440 sys::Path(Output.toString()),
441 AbsTolerance, RelTolerance, &Error)) {
443 std::cerr << "While diffing output: " << Error << '\n';
446 FilesDifferent = true;
449 // Remove the generated output.
450 Output.eraseFromDisk();
452 // Remove the bitcode file if we are supposed to.
454 sys::Path(BitcodeFile).eraseFromDisk();
455 return FilesDifferent;
458 bool BugDriver::isExecutingJIT() {
459 return InterpreterSel == RunJIT;