X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FExecutionDriver.cpp;h=3b93a1a3224b0f51d6e88e290999d49774fdcbcd;hb=16350f8d00fc3a4a8d2da8a746a29979505af9a8;hp=acc363bf9790c3d853001b5f7765608e6d823a7e;hpb=640f22e66d90439857a97a83896ee68c4f7128c9;p=oota-llvm.git diff --git a/tools/bugpoint/ExecutionDriver.cpp b/tools/bugpoint/ExecutionDriver.cpp index acc363bf979..3b93a1a3224 100644 --- a/tools/bugpoint/ExecutionDriver.cpp +++ b/tools/bugpoint/ExecutionDriver.cpp @@ -1,98 +1,128 @@ //===- 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 -#include + +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, RunCBE, CBE_bug, LLC_Safe,Custom }; + + cl::opt + AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"), + cl::init(0.0)); + cl::opt + RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"), + cl::init(0.0)); + cl::opt - 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)); + 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(RunCBE, "run-cbe", "Compile with CBE"), + clEnumValN(CBE_bug,"cbe-bug", "Find CBE bugs"), + clEnumValN(LLC_Safe, "llc-safe", "Use LLC for all"), + clEnumValN(Custom, "run-custom", + "Use -exec-command to define a command to execute " + "the bitcode. Useful for cross-compilation."), + clEnumValEnd), + cl::init(AutoPick)); + + cl::opt + 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(RunCBE, "safe-run-cbe", "Compile with CBE"), + clEnumValN(Custom, "safe-run-custom", + "Use -exec-command to define a command to execute " + "the bitcode. Useful for cross-compilation."), + clEnumValEnd), + cl::init(AutoPick)); cl::opt - InputFile("input", cl::init("/dev/null"), - cl::desc("Filename to pipe in as stdin (default: /dev/null)")); -} + SafeInterpreterPath("safe-path", + cl::desc("Specify the path to the \"safe\" backend program"), + cl::init("")); -/// 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 + AppendProgramExitCode("append-exit-code", + cl::desc("Append the exit code to the output so it gets diff'd too"), + cl::init(false)); - virtual ~AbstractInterpreter() {} + cl::opt + InputFile("input", cl::init("/dev/null"), + cl::desc("Filename to pipe in as stdin (default: /dev/null)")); - /// 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 + AdditionalSOs("additional-so", + cl::desc("Additional shared objects to load " + "into executing programs")); -}; + cl::list + AdditionalLinkerArgs("Xlinker", + cl::desc("Additional arguments to pass to the linker")); + cl::opt + CustomExecCommand("exec-command", cl::init("simulate"), + cl::desc("Command to execute the bitcode (use with -run-custom) " + "(default: simulate)")); +} -//===----------------------------------------------------------------------===// -// 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); - } +namespace llvm { + // Anything specified after the --args option are taken as arguments to the + // program being debugged. + cl::list + InputArgv("args", cl::Positional, cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); - 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[] = { - "-abort-on-exception", - "-quiet", - Bytecode.c_str(), - 0 - }; - - return RunProgramWithTimeout(LLIPath, Args, - InputFile, OutputFile, OutputFile); + cl::opt + OutputPrefix("output-prefix", cl::init("bugpoint"), + cl::desc("Prefix to use for outputs (default: 'bugpoint')")); } +namespace { + cl::list + ToolArgv("tool-args", cl::Positional, cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); + + cl::list + SafeToolArgv("safe-tool-args", cl::Positional, + cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); + + cl::list + GCCToolArgv("gcc-tool-args", cl::Positional, + cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); +} //===----------------------------------------------------------------------===// // BugDriver method implementation @@ -102,97 +132,343 @@ int LLI::ExecuteProgram(const std::string &Bytecode, /// environment for executing LLVM programs. /// bool BugDriver::initializeExecutionEnvironment() { - std::cout << "Initializing execution environment: "; + outs() << "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 + SafeInterpreter = 0; std::string Message; - if (InterpreterSel == RunLLI) { - Interpreter = LLI::create(this, Message); - } else { - Message = " Sorry, only LLI is supported right now!"; + + switch (InterpreterSel) { + case AutoPick: + InterpreterSel = RunCBE; + Interpreter = + AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv, + &GCCToolArgv); + if (!Interpreter) { + InterpreterSel = RunJIT; + Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, + &ToolArgv); + } + if (!Interpreter) { + InterpreterSel = RunLLC; + Interpreter = AbstractInterpreter::createLLC(getToolName(), Message, + &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, + &ToolArgv, &GCCToolArgv, + InterpreterSel == RunLLCIA); + break; + case RunJIT: + Interpreter = AbstractInterpreter::createJIT(getToolName(), Message, + &ToolArgv); + break; + case RunCBE: + case CBE_bug: + Interpreter = AbstractInterpreter::createCBE(getToolName(), Message, + &ToolArgv, &GCCToolArgv); + break; + case Custom: + Interpreter = AbstractInterpreter::createCustom(Message, CustomExecCommand); + break; + default: + Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; + 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 SafeToolArgs = SafeToolArgv; + switch (SafeInterpreterSel) { + case AutoPick: + // In "cbe-bug" mode, default to using LLC as the "safe" backend. + if (!SafeInterpreter && + InterpreterSel == CBE_bug) { + SafeInterpreterSel = RunLLC; + SafeToolArgs.push_back("--relocation-model=pic"); + SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message, + &SafeToolArgs, + &GCCToolArgv); + } - std::cout << Message; + // 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, + &SafeToolArgs, + &GCCToolArgv); + } + + // Pick a backend that's different from the test backend. The JIT and + // LLC backends share a lot of code, so prefer to use the CBE as the + // safe back-end when testing them. + if (!SafeInterpreter && + InterpreterSel != RunCBE) { + SafeInterpreterSel = RunCBE; + SafeInterpreter = AbstractInterpreter::createCBE(Path.c_str(), Message, + &SafeToolArgs, + &GCCToolArgv); + } + if (!SafeInterpreter && + InterpreterSel != RunLLC && + InterpreterSel != RunJIT) { + SafeInterpreterSel = RunLLC; + SafeToolArgs.push_back("--relocation-model=pic"); + SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message, + &SafeToolArgs, + &GCCToolArgv); + } + if (!SafeInterpreter) { + SafeInterpreterSel = AutoPick; + Message = "Sorry, I can't automatically select an interpreter!\n"; + } + break; + case RunLLC: + case RunLLCIA: + SafeToolArgs.push_back("--relocation-model=pic"); + SafeInterpreter = AbstractInterpreter::createLLC(Path.c_str(), Message, + &SafeToolArgs, + &GCCToolArgv, + SafeInterpreterSel == RunLLCIA); + break; + case RunCBE: + SafeInterpreter = AbstractInterpreter::createCBE(Path.c_str(), Message, + &SafeToolArgs, + &GCCToolArgv); + break; + case Custom: + SafeInterpreter = AbstractInterpreter::createCustom(Message, + CustomExecCommand); + break; + default: + 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); } + + gcc = GCC::create(Message, &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, 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 bitcode file... + sys::Path BitcodeFile (OutputPrefix + "-test-program.bc"); + std::string ErrMsg; + if (BitcodeFile.makeUnique(true,&ErrMsg)) { + errs() << ToolName << ": Error making unique filename: " << ErrMsg + << "\n"; + exit(1); + } + if (writeProgramToFile(BitcodeFile.str(), M)) { + errs() << ToolName << ": Error emitting bitcode to file '" + << BitcodeFile.str() << "'!\n"; + exit(1); + } + + // Remove the temporary bitcode file when we are done. + FileRemover BitcodeFileRemover(BitcodeFile, !SaveTemps); + + // Actually compile the program! + Interpreter->compileProgram(BitcodeFile.str()); +} + /// 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 BitcodeFile, + const std::string &SharedObj, + AbstractInterpreter *AI) { + 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... + sys::Path uniqueFilename(OutputPrefix + "-test-program.bc"); + if (uniqueFilename.makeUnique(true, &ErrMsg)) { + errs() << ToolName << ": Error making unique filename: " + << ErrMsg << "!\n"; + exit(1); + } + BitcodeFile = uniqueFilename.str(); + + if (writeProgramToFile(BitcodeFile, Program)) { + errs() << ToolName << ": Error emitting bitcode to file '" + << BitcodeFile << "'!\n"; exit(1); } - CreatedBytecode = true; + 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. + sys::Path 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... + sys::Path uniqueFile(OutputFile); + if (uniqueFile.makeUnique(true, &ErrMsg)) { + errs() << ToolName << ": Error making unique filename: " + << ErrMsg << "\n"; + exit(1); + } + OutputFile = uniqueFile.str(); + + // Figure out which shared objects to run, if any. + std::vector SharedObjs(AdditionalSOs); + if (!SharedObj.empty()) + SharedObjs.push_back(SharedObj); + + int RetVal = AI->ExecuteProgram(BitcodeFile, InputArgv, InputFile, + OutputFile, AdditionalLinkerArgs, SharedObjs, + Timeout, MemoryLimit); + + if (RetVal == -1) { + errs() << ""; + 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(std::string OutputFile) { + std::string outFN = executeProgram(OutputFile, "", "", SafeInterpreter); + return outFN; +} - std::ifstream ReferenceFile(ReferenceOutputFile.c_str()); - if (!ReferenceFile) { - std::cerr << "Couldn't open reference output file '" - << ReferenceOutputFile << "'\n"; - exit(1); - } +std::string BugDriver::compileSharedObject(const std::string &BitcodeFile) { + assert(Interpreter && "Interpreter should have been created already!"); + sys::Path OutputFile; + + // Using the known-good backend. + GCC::FileType FT = SafeInterpreter->OutputCode(BitcodeFile, OutputFile); - std::ifstream OutputFile(Output.c_str()); - if (!OutputFile) { - std::cerr << "Couldn't open output file: " << Output << "'!\n"; + std::string SharedObjectFile; + if (gcc->MakeSharedObject(OutputFile.str(), 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 = executeProgramSafely(Filename); + outs() << "\nReference output is: " << ReferenceOutputFile << "\n\n"; + } catch (ToolExecutionError &TEE) { + errs() << TEE.what(); + if (Interpreter != SafeInterpreter) { + errs() << "*** There is a bug running the \"safe\" backend. Either" + << " debug it (for example with the -run-cbe bugpoint option," + << " if CBE is being used as the \"safe\" backend), or fix the" + << " error some other way.\n"; + } + return false; + } + 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, 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 &BitcodeFile, + const std::string &SharedObject, + bool RemoveBitcode) { + // Execute the program, generating an output file... + sys::Path Output(executeProgram("", BitcodeFile, SharedObject, 0)); - // 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(sys::Path(ReferenceOutputFile), + sys::Path(Output.str()), + 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. + Output.eraseFromDisk(); + } - removeFile(Output); - if (RemoveBytecode) removeFile(BytecodeFile); + // Remove the bitcode file if we are supposed to. + if (RemoveBitcode) + sys::Path(BitcodeFile).eraseFromDisk(); return FilesDifferent; } + +bool BugDriver::isExecutingJIT() { + return InterpreterSel == RunJIT; +} +