//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and 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.
//
//===----------------------------------------------------------------------===//
-/*
-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 <fstream>
#include <iostream>
+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, RunCBE, CBE_bug, LLC_Safe
};
+
+ 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));
+
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::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(RunCBE, "run-cbe", "Compile with CBE"),
+ clEnumValN(CBE_bug,"cbe-bug", "Find CBE bugs"),
+ clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"),
+ clEnumValEnd),
+ cl::init(AutoPick));
+
+ cl::opt<bool>
+ CheckProgramExitCode("check-exit-code",
+ cl::desc("Assume nonzero exit code is failure (default on)"),
+ cl::init(true));
+
+ 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)"));
-}
-
-/// 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 {
-
- virtual ~AbstractInterpreter() {}
-
- /// 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::list<std::string>
+ AdditionalSOs("additional-so",
+ cl::desc("Additional shared objects to load "
+ "into executing programs"));
-//===----------------------------------------------------------------------===//
-// 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);
- }
-
- 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);
-}
-
-//===----------------------------------------------------------------------===//
-// 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);
- }
-
- 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::list<std::string>
+ AdditionalLinkerArgs("Xlinker",
+ cl::desc("Additional arguments to pass to the linker"));
}
-//===----------------------------------------------------------------------===//
-// 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;
- }
+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);
- 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;
- }
-
- // 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";
- }
-
- removeFile(ErrorFilename);
- exit(1); // Leave stuff around for the user to inspect or debug the CBE
- }
-
- const char *ProgramArgs[] = {
- OutputBinary.c_str(),
- 0
- };
-
- std::cout << "<program>";
-
- // 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>
+ ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
+ cl::ZeroOrMore, cl::PositionalEatsArgs);
}
//===----------------------------------------------------------------------===//
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.
-
- // 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
+ cbe = 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:
+ InterpreterSel = RunCBE;
+ Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
+ &ToolArgv);
+ if (!Interpreter) {
+ InterpreterSel = RunJIT;
+ Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
+ &ToolArgv);
+ }
+ if (!Interpreter) {
+ InterpreterSel = RunLLC;
+ Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
+ &ToolArgv);
+ }
+ 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:
+ Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
+ &ToolArgv);
+ break;
+ case RunJIT:
+ Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
+ &ToolArgv);
+ break;
+ case LLC_Safe:
+ Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
+ &ToolArgv);
+ break;
+ case RunCBE:
+ case CBE_bug:
+ Interpreter = AbstractInterpreter::createCBE(getToolName(), Message,
+ &ToolArgv);
+ 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 right now!\n";
break;
}
-
- std::cout << Message;
+ std::cerr << Message;
+
+ // Initialize auxiliary tools for debugging
+ if (InterpreterSel == RunCBE) {
+ // We already created a CBE, reuse it.
+ cbe = Interpreter;
+ } else if (InterpreterSel == CBE_bug || InterpreterSel == LLC_Safe) {
+ // We want to debug the CBE itself or LLC is known-good. Use LLC as the
+ // 'known-good' compiler.
+ std::vector<std::string> ToolArgs;
+ ToolArgs.push_back("--relocation-model=pic");
+ cbe = AbstractInterpreter::createLLC(getToolName(), Message, &ToolArgs);
+ } else {
+ cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
+ }
+ if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
+
+ gcc = GCC::create(getToolName(), Message);
+ if (!gcc) { std::cout << 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, throwing an exception
+/// if an error occurs, or returning normally if not. This is used for code
+/// generation crash testing.
+///
+void BugDriver::compileProgram(Module *M) {
+ // Emit the program to a bytecode file...
+ sys::Path BytecodeFile ("bugpoint-test-program.bc");
+ std::string ErrMsg;
+ if (BytecodeFile.makeUnique(true,&ErrMsg)) {
+ std::cerr << ToolName << ": Error making unique filename: " << ErrMsg
+ << "\n";
+ exit(1);
+ }
+ if (writeProgramToFile(BytecodeFile.toString(), M)) {
+ std::cerr << ToolName << ": Error emitting bytecode to file '"
+ << BytecodeFile << "'!\n";
+ exit(1);
+ }
+
+ // Remove the temporary bytecode file when we are done.
+ FileRemover BytecodeFileRemover(BytecodeFile);
+
+ // Actually compile the program!
+ Interpreter->compileProgram(BytecodeFile.toString());
+}
+
/// 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!");
+ std::string BytecodeFile,
+ const std::string &SharedObj,
+ AbstractInterpreter *AI,
+ bool *ProgramExitedNonzero) {
+ if (AI == 0) AI = Interpreter;
+ assert(AI && "Interpreter should have been created already!");
bool CreatedBytecode = false;
+ std::string ErrMsg;
if (BytecodeFile.empty()) {
// Emit the program to a bytecode file...
- BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
+ sys::Path uniqueFilename("bugpoint-test-program.bc");
+ if (uniqueFilename.makeUnique(true, &ErrMsg)) {
+ std::cerr << ToolName << ": Error making unique filename: "
+ << ErrMsg << "!\n";
+ exit(1);
+ }
+ BytecodeFile = uniqueFilename.toString();
if (writeProgramToFile(BytecodeFile, Program)) {
std::cerr << ToolName << ": Error emitting bytecode to file '"
- << BytecodeFile << "'!\n";
+ << BytecodeFile << "'!\n";
exit(1);
}
CreatedBytecode = true;
}
+ // Remove the temporary bytecode file when we are done.
+ sys::Path BytecodePath (BytecodeFile);
+ FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode);
+
if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
-
+
// Check to see if this is a valid output filename...
- OutputFile = getUniqueFilename(OutputFile);
+ sys::Path uniqueFile(OutputFile);
+ if (uniqueFile.makeUnique(true, &ErrMsg)) {
+ std::cerr << ToolName << ": Error making unique filename: "
+ << ErrMsg << "\n";
+ exit(1);
+ }
+ OutputFile = uniqueFile.toString();
- // Actually execute the program!
- int RetVal = Interpreter->ExecuteProgram(BytecodeFile, OutputFile);
+ // Figure out which shared objects to run, if any.
+ std::vector<std::string> SharedObjs(AdditionalSOs);
+ if (!SharedObj.empty())
+ SharedObjs.push_back(SharedObj);
- // Remove the temporary bytecode file.
- if (CreatedBytecode)
- removeFile(BytecodeFile);
+
+ // If this is an LLC or CBE run, then the GCC compiler might get run to
+ // compile the program. If so, we should pass the user's -Xlinker options
+ // as the GCCArgs.
+ int RetVal = 0;
+ if (InterpreterSel == RunLLC || InterpreterSel == RunCBE ||
+ InterpreterSel == CBE_bug)
+ RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
+ OutputFile, AdditionalLinkerArgs, SharedObjs,
+ Timeout);
+ else
+ RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
+ OutputFile, std::vector<std::string>(),
+ SharedObjs, Timeout);
+
+ if (RetVal == -1) {
+ std::cerr << "<timeout>";
+ static bool FirstTimeout = true;
+ if (FirstTimeout) {
+ std::cout << "\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();
+ }
+
+ if (ProgramExitedNonzero != 0)
+ *ProgramExitedNonzero = (RetVal != 0);
// 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.
+/// executeProgramWithCBE - Used to create reference output with the C
+/// 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::executeProgramWithCBE(std::string OutputFile) {
+ bool ProgramExitedNonzero;
+ std::string outFN = executeProgram(OutputFile, "", "", cbe,
+ &ProgramExitedNonzero);
+ if (ProgramExitedNonzero) {
+ std::cerr
+ << "Warning: While generating reference output, program exited with\n"
+ << "non-zero exit code. This will NOT be treated as a failure.\n";
+ CheckProgramExitCode = false;
+ }
+ return outFN;
+}
+
+std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
+ assert(Interpreter && "Interpreter should have been created already!");
+ sys::Path OutputFile;
+
+ // Using CBE
+ GCC::FileType FT = cbe->OutputCode(BytecodeFile, OutputFile);
- std::ifstream ReferenceFile(ReferenceOutputFile.c_str());
- if (!ReferenceFile) {
- std::cerr << "Couldn't open reference output file '"
- << ReferenceOutputFile << "'\n";
+ std::string SharedObjectFile;
+ if (gcc->MakeSharedObject(OutputFile.toString(), FT,
+ SharedObjectFile, AdditionalLinkerArgs))
exit(1);
+
+ // Remove the intermediate C file
+ OutputFile.eraseFromDisk();
+
+ 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) {
+ try {
+ compileProgram(Program);
+ } catch (ToolExecutionError &) {
+ return false;
}
+ try {
+ ReferenceOutputFile = executeProgramWithCBE(Filename);
+ std::cout << "Reference output is: " << ReferenceOutputFile << "\n\n";
+ } catch (ToolExecutionError &TEE) {
+ std::cerr << TEE.what();
+ if (Interpreter != cbe) {
+ std::cerr << "*** There is a bug running the C backend. Either debug"
+ << " it (use the -run-cbe bugpoint option), or fix the error"
+ << " some other way.\n";
+ }
+ return false;
+ }
+ return true;
+}
- std::ifstream OutputFile(Output.c_str());
- if (!OutputFile) {
- std::cerr << "Couldn't open output file: " << Output << "'!\n";
- exit(1);
+/// 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. If there is a problem with the code
+/// generator (e.g., llc crashes), this will throw an exception.
+///
+bool BugDriver::diffProgram(const std::string &BytecodeFile,
+ const std::string &SharedObject,
+ bool RemoveBytecode) {
+ bool ProgramExitedNonzero;
+
+ // Execute the program, generating an output file...
+ sys::Path Output(executeProgram("", BytecodeFile, SharedObject, 0,
+ &ProgramExitedNonzero));
+
+ // If we're checking the program exit code, assume anything nonzero is bad.
+ if (CheckProgramExitCode && ProgramExitedNonzero) {
+ Output.eraseFromDisk();
+ if (RemoveBytecode)
+ sys::Path(BytecodeFile).eraseFromDisk();
+ return true;
}
+ std::string Error;
bool FilesDifferent = false;
+ if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile),
+ sys::Path(Output.toString()),
+ AbsTolerance, RelTolerance, &Error)) {
+ if (Diff == 2) {
+ std::cerr << "While diffing output: " << Error << '\n';
+ exit(1);
+ }
+ FilesDifferent = true;
+ }
- // Compare the two files...
- int C1, C2;
- do {
- C1 = ReferenceFile.get();
- C2 = OutputFile.get();
- if (C1 != C2) { FilesDifferent = true; break; }
- } while (C1 != EOF);
+ // Remove the generated output.
+ Output.eraseFromDisk();
- removeFile(Output);
- if (RemoveBytecode) removeFile(BytecodeFile);
+ // Remove the bytecode file if we are supposed to.
+ if (RemoveBytecode)
+ sys::Path(BytecodeFile).eraseFromDisk();
return FilesDifferent;
}
+
+bool BugDriver::isExecutingJIT() {
+ return InterpreterSel == RunJIT;
+}
+
projects / oota-llvm.git / blobdiff