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/Program.h"
21 #include "llvm/Support/SystemUtils.h"
22 #include "llvm/Support/raw_ostream.h"
28 // OutputType - Allow the user to specify the way code should be run, to test
29 // for miscompilation.
42 cl::opt<double> AbsTolerance("abs-tolerance",
43 cl::desc("Absolute error tolerated"),
45 cl::opt<double> RelTolerance("rel-tolerance",
46 cl::desc("Relative error tolerated"),
49 cl::opt<OutputType> InterpreterSel(
50 cl::desc("Specify the \"test\" i.e. suspect back-end:"),
51 cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
52 clEnumValN(RunLLI, "run-int", "Execute with the interpreter"),
53 clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
54 clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
55 clEnumValN(RunLLCIA, "run-llc-ia",
56 "Compile with LLC with integrated assembler"),
57 clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"),
58 clEnumValN(CompileCustom, "compile-custom",
59 "Use -compile-command to define a command to "
60 "compile the bitcode. Useful to avoid linking."),
61 clEnumValN(Custom, "run-custom",
62 "Use -exec-command to define a command to execute "
63 "the bitcode. Useful for cross-compilation.")),
66 cl::opt<OutputType> SafeInterpreterSel(
67 cl::desc("Specify \"safe\" i.e. known-good backend:"),
68 cl::values(clEnumValN(AutoPick, "safe-auto", "Use best guess"),
69 clEnumValN(RunLLC, "safe-run-llc", "Compile with LLC"),
70 clEnumValN(Custom, "safe-run-custom",
71 "Use -exec-command to define a command to execute "
72 "the bitcode. Useful for cross-compilation.")),
75 cl::opt<std::string> SafeInterpreterPath(
76 "safe-path", cl::desc("Specify the path to the \"safe\" backend program"),
79 cl::opt<bool> AppendProgramExitCode(
81 cl::desc("Append the exit code to the output so it gets diff'd too"),
85 InputFile("input", cl::init("/dev/null"),
86 cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
89 AdditionalSOs("additional-so", cl::desc("Additional shared objects to load "
90 "into executing programs"));
92 cl::list<std::string> AdditionalLinkerArgs(
93 "Xlinker", cl::desc("Additional arguments to pass to the linker"));
95 cl::opt<std::string> CustomCompileCommand(
96 "compile-command", cl::init("llc"),
97 cl::desc("Command to compile the bitcode (use with -compile-custom) "
100 cl::opt<std::string> CustomExecCommand(
101 "exec-command", cl::init("simulate"),
102 cl::desc("Command to execute the bitcode (use with -run-custom) "
103 "(default: simulate)"));
107 // Anything specified after the --args option are taken as arguments to the
108 // program being debugged.
109 cl::list<std::string> InputArgv("args", cl::Positional,
110 cl::desc("<program arguments>..."),
111 cl::ZeroOrMore, cl::PositionalEatsArgs);
114 OutputPrefix("output-prefix", cl::init("bugpoint"),
115 cl::desc("Prefix to use for outputs (default: 'bugpoint')"));
119 cl::list<std::string> ToolArgv("tool-args", cl::Positional,
120 cl::desc("<tool arguments>..."), cl::ZeroOrMore,
121 cl::PositionalEatsArgs);
123 cl::list<std::string> SafeToolArgv("safe-tool-args", cl::Positional,
124 cl::desc("<safe-tool arguments>..."),
125 cl::ZeroOrMore, cl::PositionalEatsArgs);
127 cl::opt<std::string> CCBinary("gcc", cl::init(""),
128 cl::desc("The gcc binary to use."));
130 cl::list<std::string> CCToolArgv("gcc-tool-args", cl::Positional,
131 cl::desc("<gcc-tool arguments>..."),
132 cl::ZeroOrMore, cl::PositionalEatsArgs);
135 //===----------------------------------------------------------------------===//
136 // BugDriver method implementation
139 /// initializeExecutionEnvironment - This method is used to set up the
140 /// environment for executing LLVM programs.
142 Error BugDriver::initializeExecutionEnvironment() {
143 outs() << "Initializing execution environment: ";
145 // Create an instance of the AbstractInterpreter interface as specified on
147 SafeInterpreter = nullptr;
150 if (CCBinary.empty()) {
151 if (sys::findProgramByName("clang"))
157 switch (InterpreterSel) {
160 InterpreterSel = RunJIT;
162 AbstractInterpreter::createJIT(getToolName(), Message, &ToolArgv);
165 InterpreterSel = RunLLC;
166 Interpreter = AbstractInterpreter::createLLC(
167 getToolName(), Message, CCBinary, &ToolArgv, &CCToolArgv);
170 InterpreterSel = RunLLI;
172 AbstractInterpreter::createLLI(getToolName(), Message, &ToolArgv);
175 InterpreterSel = AutoPick;
176 Message = "Sorry, I can't automatically select an interpreter!\n";
181 AbstractInterpreter::createLLI(getToolName(), Message, &ToolArgv);
186 Interpreter = AbstractInterpreter::createLLC(
187 getToolName(), Message, CCBinary, &ToolArgv, &CCToolArgv,
188 InterpreterSel == RunLLCIA);
192 AbstractInterpreter::createJIT(getToolName(), Message, &ToolArgv);
195 Interpreter = AbstractInterpreter::createCustomCompiler(
196 Message, CustomCompileCommand);
200 AbstractInterpreter::createCustomExecutor(Message, CustomExecCommand);
205 else // Display informational messages on stdout instead of stderr
208 std::string Path = SafeInterpreterPath;
210 Path = getToolName();
211 std::vector<std::string> SafeToolArgs = SafeToolArgv;
212 switch (SafeInterpreterSel) {
214 // In "llc-safe" mode, default to using LLC as the "safe" backend.
215 if (!SafeInterpreter && InterpreterSel == LLC_Safe) {
216 SafeInterpreterSel = RunLLC;
217 SafeToolArgs.push_back("--relocation-model=pic");
218 SafeInterpreter = AbstractInterpreter::createLLC(
219 Path.c_str(), Message, CCBinary, &SafeToolArgs, &CCToolArgv);
222 if (!SafeInterpreter && InterpreterSel != RunLLC &&
223 InterpreterSel != RunJIT) {
224 SafeInterpreterSel = RunLLC;
225 SafeToolArgs.push_back("--relocation-model=pic");
226 SafeInterpreter = AbstractInterpreter::createLLC(
227 Path.c_str(), Message, CCBinary, &SafeToolArgs, &CCToolArgv);
229 if (!SafeInterpreter) {
230 SafeInterpreterSel = AutoPick;
231 Message = "Sorry, I can't automatically select a safe interpreter!\n";
236 SafeToolArgs.push_back("--relocation-model=pic");
237 SafeInterpreter = AbstractInterpreter::createLLC(
238 Path.c_str(), Message, CCBinary, &SafeToolArgs, &CCToolArgv,
239 SafeInterpreterSel == RunLLCIA);
243 AbstractInterpreter::createCustomExecutor(Message, CustomExecCommand);
246 Message = "Sorry, this back-end is not supported by bugpoint as the "
247 "\"safe\" backend right now!\n";
250 if (!SafeInterpreter) {
251 outs() << Message << "\nExiting.\n";
255 cc = CC::create(Message, CCBinary, &CCToolArgv);
257 outs() << Message << "\nExiting.\n";
261 // If there was an error creating the selected interpreter, quit with error.
262 if (Interpreter == nullptr)
263 return make_error<StringError>("Failed to init execution environment",
264 inconvertibleErrorCode());
265 return Error::success();
268 /// compileProgram - Try to compile the specified module, returning false and
269 /// setting Error if an error occurs. This is used for code generation
272 Error BugDriver::compileProgram(Module *M) const {
273 // Emit the program to a bitcode file...
275 sys::fs::TempFile::create(OutputPrefix + "-test-program-%%%%%%%.bc");
278 << ": Error making unique filename: " << toString(Temp.takeError())
282 DiscardTemp Discard{*Temp};
283 if (writeProgramToFile(Temp->FD, M)) {
284 errs() << ToolName << ": Error emitting bitcode to file '" << Temp->TmpName
289 // Actually compile the program!
290 return Interpreter->compileProgram(Temp->TmpName, Timeout, MemoryLimit);
293 /// executeProgram - This method runs "Program", capturing the output of the
294 /// program to a file, returning the filename of the file. A recommended
295 /// filename may be optionally specified.
297 Expected<std::string> BugDriver::executeProgram(const Module *Program,
298 std::string OutputFile,
299 std::string BitcodeFile,
300 const std::string &SharedObj,
301 AbstractInterpreter *AI) const {
304 assert(AI && "Interpreter should have been created already!");
305 if (BitcodeFile.empty()) {
306 // Emit the program to a bitcode file...
308 sys::fs::TempFile::create(OutputPrefix + "-test-program-%%%%%%%.bc");
311 << ": Error making unique filename: " << toString(File.takeError())
315 DiscardTemp Discard{*File};
316 BitcodeFile = File->TmpName;
318 if (writeProgramToFile(File->FD, Program)) {
319 errs() << ToolName << ": Error emitting bitcode to file '" << BitcodeFile
325 if (OutputFile.empty())
326 OutputFile = OutputPrefix + "-execution-output-%%%%%%%";
328 // Check to see if this is a valid output filename...
329 SmallString<128> UniqueFile;
330 std::error_code EC = sys::fs::createUniqueFile(OutputFile, UniqueFile);
332 errs() << ToolName << ": Error making unique filename: " << EC.message()
336 OutputFile = UniqueFile.str();
338 // Figure out which shared objects to run, if any.
339 std::vector<std::string> SharedObjs(AdditionalSOs);
340 if (!SharedObj.empty())
341 SharedObjs.push_back(SharedObj);
343 Expected<int> RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile,
344 OutputFile, AdditionalLinkerArgs,
345 SharedObjs, Timeout, MemoryLimit);
346 if (Error E = RetVal.takeError())
350 errs() << "<timeout>";
351 static bool FirstTimeout = true;
355 "*** Program execution timed out! This mechanism is designed to "
357 " programs stuck in infinite loops gracefully. The -timeout "
359 " can be used to change the timeout threshold or disable it "
361 " (with -timeout=0). This message is only displayed once.\n";
362 FirstTimeout = false;
366 if (AppendProgramExitCode) {
367 std::ofstream outFile(OutputFile.c_str(), std::ios_base::app);
368 outFile << "exit " << *RetVal << '\n';
372 // Return the filename we captured the output to.
376 /// executeProgramSafely - Used to create reference output with the "safe"
377 /// backend, if reference output is not provided.
379 Expected<std::string>
380 BugDriver::executeProgramSafely(const Module *Program,
381 const std::string &OutputFile) const {
382 return executeProgram(Program, OutputFile, "", "", SafeInterpreter);
385 Expected<std::string>
386 BugDriver::compileSharedObject(const std::string &BitcodeFile) {
387 assert(Interpreter && "Interpreter should have been created already!");
388 std::string OutputFile;
390 // Using the known-good backend.
391 Expected<CC::FileType> FT =
392 SafeInterpreter->OutputCode(BitcodeFile, OutputFile);
393 if (Error E = FT.takeError())
396 std::string SharedObjectFile;
397 if (Error E = cc->MakeSharedObject(OutputFile, *FT, SharedObjectFile,
398 AdditionalLinkerArgs))
401 // Remove the intermediate C file
402 sys::fs::remove(OutputFile);
404 return SharedObjectFile;
407 /// createReferenceFile - calls compileProgram and then records the output
408 /// into ReferenceOutputFile. Returns true if reference file created, false
409 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
412 Error BugDriver::createReferenceFile(Module *M, const std::string &Filename) {
413 if (Error E = compileProgram(Program))
416 Expected<std::string> Result = executeProgramSafely(Program, Filename);
417 if (Error E = Result.takeError()) {
418 if (Interpreter != SafeInterpreter) {
421 make_error<StringError>(
422 "*** There is a bug running the \"safe\" backend. Either"
423 " debug it (for example with the -run-jit bugpoint option,"
424 " if JIT is being used as the \"safe\" backend), or fix the"
425 " error some other way.\n",
426 inconvertibleErrorCode()));
430 ReferenceOutputFile = *Result;
431 outs() << "\nReference output is: " << ReferenceOutputFile << "\n\n";
432 return Error::success();
435 /// diffProgram - This method executes the specified module and diffs the
436 /// output against the file specified by ReferenceOutputFile. If the output
437 /// is different, 1 is returned. If there is a problem with the code
438 /// generator (e.g., llc crashes), this will set ErrMsg.
440 Expected<bool> BugDriver::diffProgram(const Module *Program,
441 const std::string &BitcodeFile,
442 const std::string &SharedObject,
443 bool RemoveBitcode) const {
444 // Execute the program, generating an output file...
445 Expected<std::string> Output =
446 executeProgram(Program, "", BitcodeFile, SharedObject, nullptr);
447 if (Error E = Output.takeError())
451 bool FilesDifferent = false;
452 if (int Diff = DiffFilesWithTolerance(ReferenceOutputFile, *Output,
453 AbsTolerance, RelTolerance, &Error)) {
455 errs() << "While diffing output: " << Error << '\n';
458 FilesDifferent = true;
460 // Remove the generated output if there are no differences.
461 sys::fs::remove(*Output);
464 // Remove the bitcode file if we are supposed to.
466 sys::fs::remove(BitcodeFile);
467 return FilesDifferent;
470 bool BugDriver::isExecutingJIT() { return InterpreterSel == RunJIT; }