X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FExecutionDriver.cpp;h=9dc9adf804e6c12e5c2131daebfd1a87f5cbbbf4;hb=df2cf418a8449d60512ab42e14c7a0b2608ce438;hp=adca572075e533adad9d06bf3ac4b6eed6efd99f;hpb=91eabc13d3a456cc4b387d3d7fdb041d976732c7;p=oota-llvm.git diff --git a/tools/bugpoint/ExecutionDriver.cpp b/tools/bugpoint/ExecutionDriver.cpp index adca572075e..9dc9adf804e 100644 --- a/tools/bugpoint/ExecutionDriver.cpp +++ b/tools/bugpoint/ExecutionDriver.cpp @@ -1,4 +1,11 @@ //===- 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. @@ -15,438 +22,56 @@ BUGPOINT NOTES: */ #include "BugDriver.h" -#include "SystemUtils.h" #include "Support/CommandLine.h" -#include "Support/Statistic.h" +#include "Support/Debug.h" +#include "Support/FileUtilities.h" +#include "Support/SystemUtils.h" +#include "llvm/Support/ToolRunner.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, RunCBE }; + cl::opt InterpreterSel(cl::desc("Specify how LLVM code should be executed:"), - cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"), + 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"), - 0)); + 0), + cl::init(AutoPick)); + + cl::opt + CheckProgramExitCode("check-exit-code", + cl::desc("Assume nonzero exit code is failure (default on)"), + cl::init(true)); cl::opt InputFile("input", cl::init("/dev/null"), cl::desc("Filename to pipe in as stdin (default: /dev/null)")); - enum FileType { AsmFile, CFile }; -} - -/// 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, - const std::string &SharedLib = "") = 0; -}; - - -//===----------------------------------------------------------------------===// -// 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, - const std::string &SharedLib = ""); -}; - -int LLI::ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib) { - if (!SharedLib.empty()) { - std::cerr << "LLI currently does not support loading shared libraries.\n" - << "Exiting.\n"; - exit(1); - } - - const char *Args[] = { - LLIPath.c_str(), - "-abort-on-exception", - "-quiet", - "-force-interpreter=true", - Bytecode.c_str(), - 0 - }; - - std::cout << ""; - return RunProgramWithTimeout(LLIPath, Args, - InputFile, OutputFile, OutputFile); -} - -//===----------------------------------------------------------------------===// -// GCC abstraction -// -// This is not a *real* AbstractInterpreter as it does not accept bytecode -// files, but only input acceptable to GCC, i.e. C, C++, and assembly files -// -class GCC { - std::string GCCPath; // The path to the gcc executable -public: - GCC(const std::string &gccPath) : GCCPath(gccPath) { } - virtual ~GCC() {} - - // GCC create method - Try to find the `gcc' executable - static GCC *create(BugDriver *BD, std::string &Message) { - 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 GCC(GCCPath); - } - - virtual int ExecuteProgram(const std::string &ProgramFile, - FileType fileType, - const std::string &OutputFile, - const std::string &SharedLib = ""); - - int MakeSharedObject(const std::string &InputFile, - FileType fileType, - std::string &OutputFile); - - void ProcessFailure(const char **Args); -}; - -int GCC::ExecuteProgram(const std::string &ProgramFile, - FileType fileType, - const std::string &OutputFile, - const std::string &SharedLib) { - std::string OutputBinary = getUniqueFilename("bugpoint.gcc.exe"); - const char **GCCArgs; - - const char *ArgsWithoutSO[] = { - GCCPath.c_str(), - "-x", (fileType == AsmFile) ? "assembler" : "c", - ProgramFile.c_str(), // Specify the input filename... - "-o", OutputBinary.c_str(), // Output to the right filename... - "-lm", // Hard-code the math library... - "-O2", // Optimize the program a bit... - 0 - }; - const char *ArgsWithSO[] = { - GCCPath.c_str(), - SharedLib.c_str(), // Specify the shared library to link in... - "-x", (fileType == AsmFile) ? "assembler" : "c", - ProgramFile.c_str(), // Specify the input filename... - "-o", OutputBinary.c_str(), // Output to the right filename... - "-lm", // Hard-code the math library... - "-O2", // Optimize the program a bit... - 0 - }; - - GCCArgs = (SharedLib.empty()) ? ArgsWithoutSO : ArgsWithSO; - std::cout << ""; - if (RunProgramWithTimeout(GCCPath, GCCArgs, "/dev/null", "/dev/null", - "/dev/null")) { - ProcessFailure(GCCArgs); - exit(1); - } - - const char *ProgramArgs[] = { - OutputBinary.c_str(), - 0 - }; - - // Now that we have a binary, run it! - std::cout << ""; - int ProgramResult = RunProgramWithTimeout(OutputBinary, ProgramArgs, - InputFile, OutputFile, OutputFile); - std::cout << "\n"; - removeFile(OutputBinary); - return ProgramResult; -} - -int GCC::MakeSharedObject(const std::string &InputFile, - FileType fileType, - std::string &OutputFile) { - OutputFile = getUniqueFilename("./bugpoint.so"); - // Compile the C/asm file into a shared object - const char* GCCArgs[] = { - GCCPath.c_str(), - "-x", (fileType == AsmFile) ? "assembler" : "c", - InputFile.c_str(), // Specify the input filename... -#if defined(sparc) || defined(__sparc__) || defined(__sparcv9) - "-G", // Compile a shared library, `-G' for Sparc -#else - "-shared", // `-shared' for Linux/X86, maybe others -#endif - "-o", OutputFile.c_str(), // Output to the right filename... - "-O2", // Optimize the program a bit... - 0 - }; - - std::cout << ""; - if(RunProgramWithTimeout(GCCPath, GCCArgs, "/dev/null", "/dev/null", - "/dev/null")) { - ProcessFailure(GCCArgs); - exit(1); - } - return 0; -} - -void GCC::ProcessFailure(const char** GCCArgs) { - std::cerr << "\n*** bugpoint error: invocation of the C compiler failed!\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.gcc.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(ErrorFile), - std::istreambuf_iterator(), - std::ostreambuf_iterator(std::cerr)); - ErrorFile.close(); - std::cerr << "\n"; - } - - removeFile(ErrorFilename); -} - -//===----------------------------------------------------------------------===// -// LLC Implementation of AbstractIntepreter interface -// -class LLC : public AbstractInterpreter { - std::string LLCPath; // The path to the LLC executable - GCC *gcc; -public: - LLC(const std::string &llcPath, GCC *Gcc) - : LLCPath(llcPath), gcc(Gcc) { } - ~LLC() { delete gcc; } - - // LLC create method - Try to find the LLC executable - static LLC *create(BugDriver *BD, std::string &Message) { - std::string LLCPath = FindExecutable("llc", BD->getToolName()); - if (LLCPath.empty()) { - Message = "Cannot find `llc' in bugpoint executable directory or PATH!\n"; - return 0; - } - - Message = "Found llc: " + LLCPath + "\n"; - GCC *gcc = GCC::create(BD, Message); - if (!gcc) { - std::cerr << Message << "\n"; - exit(1); - } - return new LLC(LLCPath, gcc); - } - - virtual int ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib = ""); - - int OutputAsm(const std::string &Bytecode, - std::string &OutputAsmFile); -}; - -int LLC::OutputAsm(const std::string &Bytecode, - std::string &OutputAsmFile) { - OutputAsmFile = "bugpoint.llc.s"; - const char *LLCArgs[] = { - LLCPath.c_str(), - "-o", OutputAsmFile.c_str(), // Output to the Asm file - "-f", // Overwrite as necessary... - Bytecode.c_str(), // This is the input bytecode - 0 - }; - - std::cout << ""; - if (RunProgramWithTimeout(LLCPath, LLCArgs, "/dev/null", "/dev/null", - "/dev/null")) { - // If LLC failed on the bytecode, print error... - std::cerr << "bugpoint error: `llc' failed!\n"; - removeFile(OutputAsmFile); - return 1; - } - - return 0; -} - -int LLC::ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib) { - - std::string OutputAsmFile; - if (OutputAsm(Bytecode, OutputAsmFile)) { - std::cerr << "Could not generate asm code with `llc', exiting.\n"; - exit(1); - } - - // Assuming LLC worked, compile the result with GCC and run it. - int Result = gcc->ExecuteProgram(OutputAsmFile,AsmFile,OutputFile,SharedLib); - removeFile(OutputAsmFile); - return Result; + cl::list + AdditionalSOs("additional-so", + cl::desc("Additional shared objects to load " + "into executing programs")); } - -//===----------------------------------------------------------------------===// -// 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, - const std::string &SharedLib = ""); -}; - -int JIT::ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib) { - const char* ArgsWithoutSO[] = { - LLIPath.c_str(), "-quiet", "-force-interpreter=false", - Bytecode.c_str(), - 0 - }; - - const char* ArgsWithSO[] = { - LLIPath.c_str(), "-quiet", "-force-interpreter=false", - "-load", SharedLib.c_str(), - Bytecode.c_str(), - 0 - }; - - const char** JITArgs = SharedLib.empty() ? ArgsWithoutSO : ArgsWithSO; - - std::cout << ""; - DEBUG(std::cerr << "\nSending output to " << OutputFile << "\n"); - return RunProgramWithTimeout(LLIPath, JITArgs, - InputFile, OutputFile, OutputFile); +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); } -//===----------------------------------------------------------------------===// -// CBE Implementation of AbstractIntepreter interface -// -class CBE : public AbstractInterpreter { - std::string DISPath; // The path to the LLVM 'dis' executable - GCC *gcc; -public: - CBE(const std::string &disPath, GCC *Gcc) : DISPath(disPath), gcc(Gcc) { } - ~CBE() { delete gcc; } - - // 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"; - - GCC *gcc = GCC::create(BD, Message); - if (!gcc) { - std::cerr << Message << "\n"; - exit(1); - } - return new CBE(DISPath, gcc); - } - - virtual int ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib = ""); - - // Sometimes we just want to go half-way and only generate the C file, - // not necessarily compile it with GCC and run the program - virtual int OutputC(const std::string &Bytecode, - std::string &OutputCFile); - -}; - -int CBE::OutputC(const std::string &Bytecode, - std::string &OutputCFile) { - OutputCFile = "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 << ""; - 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"; - return 1; - } - - return 0; -} - - -int CBE::ExecuteProgram(const std::string &Bytecode, - const std::string &OutputFile, - const std::string &SharedLib) { - std::string OutputCFile; - if (OutputC(Bytecode, OutputCFile)) { - std::cerr << "Could not generate C code with `dis', exiting.\n"; - exit(1); - } - - int Result = gcc->ExecuteProgram(OutputCFile, CFile, OutputFile, SharedLib); - removeFile(OutputCFile); - - return Result; -} - - //===----------------------------------------------------------------------===// // BugDriver method implementation // @@ -457,28 +82,52 @@ int CBE::ExecuteProgram(const std::string &Bytecode, 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 std::string Message; switch (InterpreterSel) { - case RunLLI: Interpreter = LLI::create(this, Message); break; - case RunLLC: Interpreter = LLC::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 = AbstractInterpreter::createCBE(getToolName(), Message); + if (!Interpreter) { + InterpreterSel = RunJIT; + Interpreter = AbstractInterpreter::createJIT(getToolName(), Message); + } + if (!Interpreter) { + InterpreterSel = RunLLC; + Interpreter = AbstractInterpreter::createLLC(getToolName(), Message); + } + if (!Interpreter) { + InterpreterSel = RunLLI; + Interpreter = AbstractInterpreter::createLLI(getToolName(), Message); + } + if (!Interpreter) { + InterpreterSel = AutoPick; + Message = "Sorry, I can't automatically select an interpreter!\n"; + } + break; + case RunLLI: + Interpreter = AbstractInterpreter::createLLI(getToolName(), Message); + break; + case RunLLC: + Interpreter = AbstractInterpreter::createLLC(getToolName(), Message); + break; + case RunJIT: + Interpreter = AbstractInterpreter::createJIT(getToolName(), Message); + break; + case RunCBE: + Interpreter = AbstractInterpreter::createCBE(getToolName(), Message); + 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 - cbe = CBE::create(this, Message); + cbe = AbstractInterpreter::createCBE(getToolName(), Message); if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } - gcc = GCC::create(this, Message); + 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. @@ -492,9 +141,11 @@ bool BugDriver::initializeExecutionEnvironment() { /// std::string BugDriver::executeProgram(std::string OutputFile, std::string BytecodeFile, - std::string SharedObject, - AbstractInterpreter *AI) { - assert((Interpreter || AI) &&"Interpreter should have been created already!"); + const std::string &SharedObj, + AbstractInterpreter *AI, + bool *ProgramExitedNonzero) { + if (AI == 0) AI = Interpreter; + assert(AI && "Interpreter should have been created already!"); bool CreatedBytecode = false; if (BytecodeFile.empty()) { // Emit the program to a bytecode file... @@ -513,10 +164,17 @@ std::string BugDriver::executeProgram(std::string OutputFile, // Check to see if this is a valid output filename... OutputFile = getUniqueFilename(OutputFile); + // Figure out which shared objects to run, if any. + std::vector SharedObjs(AdditionalSOs); + if (!SharedObj.empty()) + SharedObjs.push_back(SharedObj); + // Actually execute the program! - int RetVal = (AI != 0) ? - AI->ExecuteProgram(BytecodeFile, OutputFile, SharedObject) : - Interpreter->ExecuteProgram(BytecodeFile, OutputFile, SharedObject); + int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, + OutputFile, SharedObjs); + + if (ProgramExitedNonzero != 0) + *ProgramExitedNonzero = (RetVal != 0); // Remove the temporary bytecode file. if (CreatedBytecode) removeFile(BytecodeFile); @@ -525,35 +183,48 @@ std::string BugDriver::executeProgram(std::string OutputFile, return OutputFile; } -std::string BugDriver::executeProgramWithCBE(std::string OutputFile, - std::string BytecodeFile, - std::string SharedObject) { - return executeProgram(OutputFile, BytecodeFile, SharedObject, cbe); +/// executeProgramWithCBE - Used to create reference output with the C +/// backend, if reference output is not provided. +/// +std::string BugDriver::executeProgramWithCBE(std::string OutputFile) { + bool ProgramExitedNonzero; + std::string outFN = executeProgram(OutputFile, "", "", + (AbstractInterpreter*)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; } -int BugDriver::compileSharedObject(const std::string &BytecodeFile, - std::string &SharedObject) { +std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) { assert(Interpreter && "Interpreter should have been created already!"); - std::string Message, OutputCFile; + std::string OutputCFile; // Using CBE cbe->OutputC(BytecodeFile, OutputCFile); #if 0 /* This is an alternative, as yet unimplemented */ // Using LLC - LLC *llc = LLC::create(this, Message); + std::string Message; + LLC *llc = createLLCtool(Message); if (llc->OutputAsm(BytecodeFile, OutputFile)) { std::cerr << "Could not generate asm code with `llc', exiting.\n"; exit(1); } #endif - gcc->MakeSharedObject(OutputCFile, CFile, SharedObject); + std::string SharedObjectFile; + if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile)) + exit(1); // Remove the intermediate C file removeFile(OutputCFile); - return 0; + return "./" + SharedObjectFile; } @@ -564,33 +235,30 @@ int BugDriver::compileSharedObject(const std::string &BytecodeFile, bool BugDriver::diffProgram(const std::string &BytecodeFile, const std::string &SharedObject, bool RemoveBytecode) { + bool ProgramExitedNonzero; + // Execute the program, generating an output file... - std::string Output = executeProgram("", BytecodeFile, SharedObject); + std::string Output = executeProgram("", BytecodeFile, SharedObject, 0, + &ProgramExitedNonzero); - std::ifstream ReferenceFile(ReferenceOutputFile.c_str()); - if (!ReferenceFile) { - std::cerr << "Couldn't open reference output file '" - << ReferenceOutputFile << "'\n"; - exit(1); - } - - std::ifstream OutputFile(Output.c_str()); - if (!OutputFile) { - std::cerr << "Couldn't open output file: " << Output << "'!\n"; - exit(1); - } + // If we're checking the program exit code, assume anything nonzero is bad. + if (CheckProgramExitCode && ProgramExitedNonzero) + return true; + std::string Error; bool FilesDifferent = false; + if (DiffFiles(ReferenceOutputFile, Output, &Error)) { + if (!Error.empty()) { + std::cerr << "While diffing output: " << Error << "\n"; + exit(1); + } + FilesDifferent = true; + } + + // Remove the generated output. + removeFile(Output); - // Compare the two files... - int C1, C2; - do { - C1 = ReferenceFile.get(); - C2 = OutputFile.get(); - if (C1 != C2) { FilesDifferent = true; break; } - } while (C1 != EOF); - - //removeFile(Output); + // Remove the bytecode file if we are supposed to. if (RemoveBytecode) removeFile(BytecodeFile); return FilesDifferent; } @@ -598,3 +266,4 @@ bool BugDriver::diffProgram(const std::string &BytecodeFile, bool BugDriver::isExecutingJIT() { return InterpreterSel == RunJIT; } +