//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
// This file contains code used to execute the program utilizing one of the
-// various ways of running LLVM bytecode.
+// various ways of running LLVM bitcode.
//
//===----------------------------------------------------------------------===//
-/*
-BUGPOINT NOTES:
-
-1. Bugpoint should not leave any files behind if the program works properly
-2. There should be an option to specify the program name, which specifies a
- unique string to put into output files. This allows operation in the
- SingleSource directory f.e. Default to the first input filename.
-*/
-
#include "BugDriver.h"
-#include "SystemUtils.h"
-#include "Support/CommandLine.h"
+#include "ToolRunner.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/SystemUtils.h"
+#include "llvm/Support/raw_ostream.h"
#include <fstream>
-#include <iostream>
+
+#if !defined(_MSC_VER) && !defined(__MINGW32__)
+#include <unistd.h>
+#else
+#include <io.h>
+#endif
+
+using namespace llvm;
namespace {
// OutputType - Allow the user to specify the way code should be run, to test
// for miscompilation.
//
enum OutputType {
- RunLLI, RunJIT, RunLLC, RunCBE
+ AutoPick, RunLLI, RunJIT, RunLLC, RunLLCIA, LLC_Safe, CompileCustom, Custom
};
- cl::opt<OutputType>
- InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
- cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"),
- clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
- clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
- clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
- 0));
- cl::opt<std::string>
- InputFile("input", cl::init("/dev/null"),
- cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
-}
+ cl::opt<double>
+ AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"),
+ cl::init(0.0));
+ cl::opt<double>
+ RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"),
+ cl::init(0.0));
-/// AbstractInterpreter Class - Subclasses of this class are used to execute
-/// LLVM bytecode in a variety of ways. This abstract interface hides this
-/// complexity behind a simple interface.
-///
-struct AbstractInterpreter {
+ cl::opt<OutputType>
+ InterpreterSel(cl::desc("Specify the \"test\" i.e. suspect back-end:"),
+ cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
+ clEnumValN(RunLLI, "run-int",
+ "Execute with the interpreter"),
+ clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
+ clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
+ clEnumValN(RunLLCIA, "run-llc-ia",
+ "Compile with LLC with integrated assembler"),
+ clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"),
+ clEnumValN(CompileCustom, "compile-custom",
+ "Use -compile-command to define a command to "
+ "compile the bitcode. Useful to avoid linking."),
+ clEnumValN(Custom, "run-custom",
+ "Use -exec-command to define a command to execute "
+ "the bitcode. Useful for cross-compilation."),
+ clEnumValEnd),
+ cl::init(AutoPick));
- virtual ~AbstractInterpreter() {}
+ cl::opt<OutputType>
+ SafeInterpreterSel(cl::desc("Specify \"safe\" i.e. known-good backend:"),
+ cl::values(clEnumValN(AutoPick, "safe-auto", "Use best guess"),
+ clEnumValN(RunLLC, "safe-run-llc", "Compile with LLC"),
+ clEnumValN(Custom, "safe-run-custom",
+ "Use -exec-command to define a command to execute "
+ "the bitcode. Useful for cross-compilation."),
+ clEnumValEnd),
+ cl::init(AutoPick));
- /// ExecuteProgram - Run the specified bytecode file, emitting output to the
- /// specified filename. This returns the exit code of the program.
- ///
- virtual int ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile) = 0;
+ cl::opt<std::string>
+ SafeInterpreterPath("safe-path",
+ cl::desc("Specify the path to the \"safe\" backend program"),
+ cl::init(""));
-};
+ cl::opt<bool>
+ AppendProgramExitCode("append-exit-code",
+ cl::desc("Append the exit code to the output so it gets diff'd too"),
+ cl::init(false));
+ cl::opt<std::string>
+ InputFile("input", cl::init("/dev/null"),
+ cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
-//===----------------------------------------------------------------------===//
-// LLI Implementation of AbstractIntepreter interface
-//
-class LLI : public AbstractInterpreter {
- std::string LLIPath; // The path to the LLI executable
-public:
- LLI(const std::string &Path) : LLIPath(Path) { }
-
- // LLI create method - Try to find the LLI executable
- static LLI *create(BugDriver *BD, std::string &Message) {
- std::string LLIPath = FindExecutable("lli", BD->getToolName());
- if (!LLIPath.empty()) {
- Message = "Found lli: " + LLIPath + "\n";
- return new LLI(LLIPath);
- }
+ cl::list<std::string>
+ AdditionalSOs("additional-so",
+ cl::desc("Additional shared objects to load "
+ "into executing programs"));
- Message = "Cannot find 'lli' in bugpoint executable directory or PATH!\n";
- return 0;
- }
- virtual int ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile);
-};
-
-int LLI::ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile) {
- const char *Args[] = {
- "lli",
- "-abort-on-exception",
- "-quiet",
- "-force-interpreter=true",
- Bytecode.c_str(),
- 0
- };
-
- return RunProgramWithTimeout(LLIPath, Args,
- InputFile, OutputFile, OutputFile);
-}
+ cl::list<std::string>
+ AdditionalLinkerArgs("Xlinker",
+ cl::desc("Additional arguments to pass to the linker"));
-//===----------------------------------------------------------------------===//
-// JIT Implementation of AbstractIntepreter interface
-//
-class JIT : public AbstractInterpreter {
- std::string LLIPath; // The path to the LLI executable
-public:
- JIT(const std::string &Path) : LLIPath(Path) { }
-
- // JIT create method - Try to find the LLI executable
- static JIT *create(BugDriver *BD, std::string &Message) {
- std::string LLIPath = FindExecutable("lli", BD->getToolName());
- if (!LLIPath.empty()) {
- Message = "Found lli: " + LLIPath + "\n";
- return new JIT(LLIPath);
- }
+ cl::opt<std::string>
+ CustomCompileCommand("compile-command", cl::init("llc"),
+ cl::desc("Command to compile the bitcode (use with -compile-custom) "
+ "(default: llc)"));
- Message = "Cannot find 'lli' in bugpoint executable directory or PATH!\n";
- return 0;
- }
- virtual int ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile);
-};
-
-int JIT::ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile) {
- const char *Args[] = {
- "-lli",
- "-quiet",
- "-force-interpreter=false",
- Bytecode.c_str(),
- 0
- };
-
- return RunProgramWithTimeout(LLIPath, Args,
- InputFile, OutputFile, OutputFile);
+ cl::opt<std::string>
+ CustomExecCommand("exec-command", cl::init("simulate"),
+ cl::desc("Command to execute the bitcode (use with -run-custom) "
+ "(default: simulate)"));
}
-//===----------------------------------------------------------------------===//
-// CBE Implementation of AbstractIntepreter interface
-//
-class CBE : public AbstractInterpreter {
- std::string DISPath; // The path to the LLVM 'dis' executable
- std::string GCCPath; // The path to the gcc executable
-public:
- CBE(const std::string &disPath, const std::string &gccPath)
- : DISPath(disPath), GCCPath(gccPath) { }
-
- // CBE create method - Try to find the 'dis' executable
- static CBE *create(BugDriver *BD, std::string &Message) {
- std::string DISPath = FindExecutable("dis", BD->getToolName());
- if (DISPath.empty()) {
- Message = "Cannot find 'dis' in bugpoint executable directory or PATH!\n";
- return 0;
- }
-
- Message = "Found dis: " + DISPath + "\n";
-
- std::string GCCPath = FindExecutable("gcc", BD->getToolName());
- if (GCCPath.empty()) {
- Message = "Cannot find 'gcc' in bugpoint executable directory or PATH!\n";
- return 0;
- }
-
- Message += "Found gcc: " + GCCPath + "\n";
- return new CBE(DISPath, GCCPath);
- }
- virtual int ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile);
-};
-
-int CBE::ExecuteProgram(const std::string &Bytecode,
- const std::string &OutputFile) {
- std::string OutputCFile = getUniqueFilename("bugpoint.cbe.c");
- const char *DisArgs[] = {
- DISPath.c_str(),
- "-o", OutputCFile.c_str(), // Output to the C file
- "-c", // Output to C
- "-f", // Overwrite as necessary...
- Bytecode.c_str(), // This is the input bytecode
- 0
- };
-
- std::cout << "<cbe>";
- if (RunProgramWithTimeout(DISPath, DisArgs, "/dev/null", "/dev/null",
- "/dev/null")) {
- // If dis failed on the bytecode, print error...
- std::cerr << "bugpoint error: dis -c failed!?\n";
- removeFile(OutputCFile);
- return 1;
- }
+namespace llvm {
+ // Anything specified after the --args option are taken as arguments to the
+ // program being debugged.
+ cl::list<std::string>
+ InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
+ cl::ZeroOrMore, cl::PositionalEatsArgs);
- // Assuming the c backend worked, compile the result with GCC...
- std::string OutputBinary = getUniqueFilename("bugpoint.cbe.exe");
- const char *GCCArgs[] = {
- GCCPath.c_str(),
- "-x", "c", // Force recognition as a C file
- "-o", OutputBinary.c_str(), // Output to the right filename...
- OutputCFile.c_str(), // Specify the input filename...
- "-O2", // Optimize the program a bit...
- 0
- };
-
- // FIXME: Eventually the CC program and arguments for it should be settable on
- // the bugpoint command line!
-
- std::cout << "<gcc>";
-
- // Run the C compiler on the output of the C backend...
- if (RunProgramWithTimeout(GCCPath, GCCArgs, "/dev/null", "/dev/null",
- "/dev/null")) {
- std::cerr << "\n*** bugpoint error: invocation of the C compiler "
- "failed on CBE result!\n";
- for (const char **Arg = DisArgs; *Arg; ++Arg)
- std::cerr << " " << *Arg;
- std::cerr << "\n";
- for (const char **Arg = GCCArgs; *Arg; ++Arg)
- std::cerr << " " << *Arg;
- std::cerr << "\n";
-
- // Rerun the compiler, capturing any error messages to print them.
- std::string ErrorFilename = getUniqueFilename("bugpoint.cbe.errors");
- RunProgramWithTimeout(GCCPath, GCCArgs, "/dev/null", ErrorFilename.c_str(),
- ErrorFilename.c_str());
-
- // Print out the error messages generated by GCC if possible...
- std::ifstream ErrorFile(ErrorFilename.c_str());
- if (ErrorFile) {
- std::copy(std::istreambuf_iterator<char>(ErrorFile),
- std::istreambuf_iterator<char>(),
- std::ostreambuf_iterator<char>(std::cerr));
- ErrorFile.close();
- std::cerr << "\n";
- }
+ cl::opt<std::string>
+ OutputPrefix("output-prefix", cl::init("bugpoint"),
+ cl::desc("Prefix to use for outputs (default: 'bugpoint')"));
+}
- removeFile(ErrorFilename);
- exit(1); // Leave stuff around for the user to inspect or debug the CBE
- }
+namespace {
+ cl::list<std::string>
+ ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
+ cl::ZeroOrMore, cl::PositionalEatsArgs);
- const char *ProgramArgs[] = {
- OutputBinary.c_str(),
- 0
- };
+ cl::list<std::string>
+ SafeToolArgv("safe-tool-args", cl::Positional,
+ cl::desc("<safe-tool arguments>..."),
+ cl::ZeroOrMore, cl::PositionalEatsArgs);
- std::cout << "<program>";
+ cl::opt<std::string>
+ GCCBinary("gcc", cl::init("gcc"),
+ cl::desc("The gcc binary to use. (default 'gcc')"));
- // Now that we have a binary, run it!
- int Result = RunProgramWithTimeout(OutputBinary, ProgramArgs,
- InputFile, OutputFile, OutputFile);
- std::cout << " ";
- removeFile(OutputCFile);
- removeFile(OutputBinary);
- return Result;
+ cl::list<std::string>
+ GCCToolArgv("gcc-tool-args", cl::Positional,
+ cl::desc("<gcc-tool arguments>..."),
+ cl::ZeroOrMore, cl::PositionalEatsArgs);
}
//===----------------------------------------------------------------------===//
/// environment for executing LLVM programs.
///
bool BugDriver::initializeExecutionEnvironment() {
- std::cout << "Initializing execution environment: ";
-
- // FIXME: This should default to searching for the best interpreter to use on
- // this platform, which would be JIT, then LLC, then CBE, then LLI.
+ outs() << "Initializing execution environment: ";
- // Create an instance of the AbstractInterpreter interface as specified on the
- // command line
+ // Create an instance of the AbstractInterpreter interface as specified on
+ // the command line
+ SafeInterpreter = 0;
std::string Message;
+
switch (InterpreterSel) {
- case RunLLI: Interpreter = LLI::create(this, Message); break;
- case RunJIT: Interpreter = JIT::create(this, Message); break;
- case RunCBE: Interpreter = CBE::create(this, Message); break;
+ case AutoPick:
+ if (!Interpreter) {
+ InterpreterSel = RunJIT;
+ Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
+ &ToolArgv);
+ }
+ if (!Interpreter) {
+ InterpreterSel = RunLLC;
+ Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
+ GCCBinary, &ToolArgv,
+ &GCCToolArgv);
+ }
+ if (!Interpreter) {
+ InterpreterSel = RunLLI;
+ Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
+ &ToolArgv);
+ }
+ if (!Interpreter) {
+ InterpreterSel = AutoPick;
+ Message = "Sorry, I can't automatically select an interpreter!\n";
+ }
+ break;
+ case RunLLI:
+ Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
+ &ToolArgv);
+ break;
+ case RunLLC:
+ case RunLLCIA:
+ case LLC_Safe:
+ Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
+ GCCBinary, &ToolArgv,
+ &GCCToolArgv,
+ InterpreterSel == RunLLCIA);
+ break;
+ case RunJIT:
+ Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
+ &ToolArgv);
+ break;
+ case CompileCustom:
+ Interpreter =
+ AbstractInterpreter::createCustomCompiler(Message, CustomCompileCommand);
+ break;
+ case Custom:
+ Interpreter =
+ AbstractInterpreter::createCustomExecutor(Message, CustomExecCommand);
+ break;
+ }
+ if (!Interpreter)
+ errs() << Message;
+ else // Display informational messages on stdout instead of stderr
+ outs() << Message;
+
+ std::string Path = SafeInterpreterPath;
+ if (Path.empty())
+ Path = getToolName();
+ std::vector<std::string> SafeToolArgs = SafeToolArgv;
+ switch (SafeInterpreterSel) {
+ case AutoPick:
+ // In "llc-safe" mode, default to using LLC as the "safe" backend.
+ if (!SafeInterpreter &&
+ InterpreterSel == LLC_Safe) {
+ SafeInterpreterSel = RunLLC;
+ SafeToolArgs.push_back("--relocation-model=pic");
+ SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message,
+ GCCBinary,
+ &SafeToolArgs,
+ &GCCToolArgv);
+ }
+
+ if (!SafeInterpreter &&
+ InterpreterSel != RunLLC &&
+ InterpreterSel != RunJIT) {
+ SafeInterpreterSel = RunLLC;
+ SafeToolArgs.push_back("--relocation-model=pic");
+ SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message,
+ GCCBinary,
+ &SafeToolArgs,
+ &GCCToolArgv);
+ }
+ if (!SafeInterpreter) {
+ SafeInterpreterSel = AutoPick;
+ Message = "Sorry, I can't automatically select a safe interpreter!\n";
+ }
+ break;
+ case RunLLC:
+ case RunLLCIA:
+ SafeToolArgs.push_back("--relocation-model=pic");
+ SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message,
+ GCCBinary, &SafeToolArgs,
+ &GCCToolArgv,
+ SafeInterpreterSel == RunLLCIA);
+ break;
+ case Custom:
+ SafeInterpreter =
+ AbstractInterpreter::createCustomExecutor(Message, CustomExecCommand);
+ break;
default:
- Message = " Sorry, this back-end is not supported by bugpoint right now!\n";
+ Message = "Sorry, this back-end is not supported by bugpoint as the "
+ "\"safe\" backend right now!\n";
break;
}
+ if (!SafeInterpreter) { outs() << Message << "\nExiting.\n"; exit(1); }
- std::cout << Message;
+ gcc = GCC::create(Message, GCCBinary, &GCCToolArgv);
+ if (!gcc) { outs() << Message << "\nExiting.\n"; exit(1); }
// If there was an error creating the selected interpreter, quit with error.
return Interpreter == 0;
}
+/// compileProgram - Try to compile the specified module, returning false and
+/// setting Error if an error occurs. This is used for code generation
+/// crash testing.
+///
+void BugDriver::compileProgram(Module *M, std::string *Error) const {
+ // Emit the program to a bitcode file...
+ SmallString<128> BitcodeFile;
+ int BitcodeFD;
+ error_code EC = sys::fs::unique_file(
+ OutputPrefix + "-test-program-%%%%%%%.bc", BitcodeFD, BitcodeFile);
+ if (EC) {
+ errs() << ToolName << ": Error making unique filename: " << EC.message()
+ << "\n";
+ exit(1);
+ }
+ if (writeProgramToFile(BitcodeFile.str(), BitcodeFD, M)) {
+ errs() << ToolName << ": Error emitting bitcode to file '" << BitcodeFile
+ << "'!\n";
+ exit(1);
+ }
+
+ // Remove the temporary bitcode file when we are done.
+ FileRemover BitcodeFileRemover(BitcodeFile.str(), !SaveTemps);
+
+ // Actually compile the program!
+ Interpreter->compileProgram(BitcodeFile.str(), Error, Timeout, MemoryLimit);
+}
+
/// executeProgram - This method runs "Program", capturing the output of the
/// program to a file, returning the filename of the file. A recommended
/// filename may be optionally specified.
///
-std::string BugDriver::executeProgram(std::string OutputFile,
- std::string BytecodeFile) {
- assert(Interpreter && "Interpreter should have been created already!");
- bool CreatedBytecode = false;
- if (BytecodeFile.empty()) {
- // Emit the program to a bytecode file...
- BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
-
- if (writeProgramToFile(BytecodeFile, Program)) {
- std::cerr << ToolName << ": Error emitting bytecode to file '"
- << BytecodeFile << "'!\n";
+std::string BugDriver::executeProgram(const Module *Program,
+ std::string OutputFile,
+ std::string BitcodeFile,
+ const std::string &SharedObj,
+ AbstractInterpreter *AI,
+ std::string *Error) const {
+ if (AI == 0) AI = Interpreter;
+ assert(AI && "Interpreter should have been created already!");
+ bool CreatedBitcode = false;
+ std::string ErrMsg;
+ if (BitcodeFile.empty()) {
+ // Emit the program to a bitcode file...
+ SmallString<128> UniqueFilename;
+ int UniqueFD;
+ error_code EC = sys::fs::unique_file(
+ OutputPrefix + "-test-program-%%%%%%%.bc", UniqueFD, UniqueFilename);
+ if (EC) {
+ errs() << ToolName << ": Error making unique filename: "
+ << EC.message() << "!\n";
exit(1);
}
- CreatedBytecode = true;
+ BitcodeFile = UniqueFilename.str();
+
+ if (writeProgramToFile(BitcodeFile, UniqueFD, Program)) {
+ errs() << ToolName << ": Error emitting bitcode to file '"
+ << BitcodeFile << "'!\n";
+ exit(1);
+ }
+ CreatedBitcode = true;
}
- if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
-
- // Check to see if this is a valid output filename...
- OutputFile = getUniqueFilename(OutputFile);
+ // Remove the temporary bitcode file when we are done.
+ std::string BitcodePath(BitcodeFile);
+ FileRemover BitcodeFileRemover(BitcodePath,
+ CreatedBitcode && !SaveTemps);
- // Actually execute the program!
- int RetVal = Interpreter->ExecuteProgram(BytecodeFile, OutputFile);
+ if (OutputFile.empty()) OutputFile = OutputPrefix + "-execution-output";
- // Remove the temporary bytecode file.
- if (CreatedBytecode)
- removeFile(BytecodeFile);
+ // Check to see if this is a valid output filename...
+ SmallString<128> UniqueFile;
+ int UniqueFD;
+ error_code EC = sys::fs::unique_file(OutputFile, UniqueFD, UniqueFile);
+ if (EC) {
+ errs() << ToolName << ": Error making unique filename: "
+ << EC.message() << "\n";
+ exit(1);
+ }
+ OutputFile = UniqueFile.str();
+ close(UniqueFD);
+
+ // Figure out which shared objects to run, if any.
+ std::vector<std::string> SharedObjs(AdditionalSOs);
+ if (!SharedObj.empty())
+ SharedObjs.push_back(SharedObj);
+
+ int RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile, OutputFile,
+ Error, AdditionalLinkerArgs, SharedObjs,
+ Timeout, MemoryLimit);
+ if (!Error->empty())
+ return OutputFile;
+
+ if (RetVal == -1) {
+ errs() << "<timeout>";
+ static bool FirstTimeout = true;
+ if (FirstTimeout) {
+ outs() << "\n"
+ "*** Program execution timed out! This mechanism is designed to handle\n"
+ " programs stuck in infinite loops gracefully. The -timeout option\n"
+ " can be used to change the timeout threshold or disable it completely\n"
+ " (with -timeout=0). This message is only displayed once.\n";
+ FirstTimeout = false;
+ }
+ }
+
+ if (AppendProgramExitCode) {
+ std::ofstream outFile(OutputFile.c_str(), std::ios_base::app);
+ outFile << "exit " << RetVal << '\n';
+ outFile.close();
+ }
// Return the filename we captured the output to.
return OutputFile;
}
-/// diffProgram - This method executes the specified module and diffs the output
-/// against the file specified by ReferenceOutputFile. If the output is
-/// different, true is returned.
+/// executeProgramSafely - Used to create reference output with the "safe"
+/// backend, if reference output is not provided.
///
-bool BugDriver::diffProgram(const std::string &ReferenceOutputFile,
- const std::string &BytecodeFile,
- bool RemoveBytecode) {
- // Execute the program, generating an output file...
- std::string Output = executeProgram("", BytecodeFile);
+std::string BugDriver::executeProgramSafely(const Module *Program,
+ std::string OutputFile,
+ std::string *Error) const {
+ return executeProgram(Program, OutputFile, "", "", SafeInterpreter, Error);
+}
- std::ifstream ReferenceFile(ReferenceOutputFile.c_str());
- if (!ReferenceFile) {
- std::cerr << "Couldn't open reference output file '"
- << ReferenceOutputFile << "'\n";
+std::string BugDriver::compileSharedObject(const std::string &BitcodeFile,
+ std::string &Error) {
+ assert(Interpreter && "Interpreter should have been created already!");
+ std::string OutputFile;
+
+ // Using the known-good backend.
+ GCC::FileType FT = SafeInterpreter->OutputCode(BitcodeFile, OutputFile,
+ Error);
+ if (!Error.empty())
+ return "";
+
+ std::string SharedObjectFile;
+ bool Failure = gcc->MakeSharedObject(OutputFile, FT, SharedObjectFile,
+ AdditionalLinkerArgs, Error);
+ if (!Error.empty())
+ return "";
+ if (Failure)
exit(1);
- }
- std::ifstream OutputFile(Output.c_str());
- if (!OutputFile) {
- std::cerr << "Couldn't open output file: " << Output << "'!\n";
- exit(1);
+ // Remove the intermediate C file
+ sys::fs::remove(OutputFile);
+
+ return "./" + SharedObjectFile;
+}
+
+/// createReferenceFile - calls compileProgram and then records the output
+/// into ReferenceOutputFile. Returns true if reference file created, false
+/// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
+/// this function.
+///
+bool BugDriver::createReferenceFile(Module *M, const std::string &Filename) {
+ std::string Error;
+ compileProgram(Program, &Error);
+ if (!Error.empty())
+ return false;
+
+ ReferenceOutputFile = executeProgramSafely(Program, Filename, &Error);
+ if (!Error.empty()) {
+ errs() << Error;
+ if (Interpreter != SafeInterpreter) {
+ errs() << "*** There is a bug running the \"safe\" backend. Either"
+ << " debug it (for example with the -run-jit bugpoint option,"
+ << " if JIT is being used as the \"safe\" backend), or fix the"
+ << " error some other way.\n";
+ }
+ return false;
}
+ outs() << "\nReference output is: " << ReferenceOutputFile << "\n\n";
+ return true;
+}
- bool FilesDifferent = false;
+/// diffProgram - This method executes the specified module and diffs the
+/// output against the file specified by ReferenceOutputFile. If the output
+/// is different, 1 is returned. If there is a problem with the code
+/// generator (e.g., llc crashes), this will set ErrMsg.
+///
+bool BugDriver::diffProgram(const Module *Program,
+ const std::string &BitcodeFile,
+ const std::string &SharedObject,
+ bool RemoveBitcode,
+ std::string *ErrMsg) const {
+ // Execute the program, generating an output file...
+ std::string Output(
+ executeProgram(Program, "", BitcodeFile, SharedObject, 0, ErrMsg));
+ if (!ErrMsg->empty())
+ return false;
- // Compare the two files...
- int C1, C2;
- do {
- C1 = ReferenceFile.get();
- C2 = OutputFile.get();
- if (C1 != C2) { FilesDifferent = true; break; }
- } while (C1 != EOF);
+ std::string Error;
+ bool FilesDifferent = false;
+ if (int Diff = DiffFilesWithTolerance(ReferenceOutputFile,
+ Output,
+ AbsTolerance, RelTolerance, &Error)) {
+ if (Diff == 2) {
+ errs() << "While diffing output: " << Error << '\n';
+ exit(1);
+ }
+ FilesDifferent = true;
+ }
+ else {
+ // Remove the generated output if there are no differences.
+ sys::fs::remove(Output);
+ }
- removeFile(Output);
- if (RemoveBytecode) removeFile(BytecodeFile);
+ // Remove the bitcode file if we are supposed to.
+ if (RemoveBitcode)
+ sys::fs::remove(BitcodeFile);
return FilesDifferent;
}
+
+bool BugDriver::isExecutingJIT() {
+ return InterpreterSel == RunJIT;
+}
+
projects / oota-llvm.git / blobdiff