X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FExecutionDriver.cpp;h=453833eb8dff9a12b27537aa49857f28e60be809;hb=7e6e44139429d1b8003426b29f14126b89591262;hp=a30f83c96ae03e10f9c7a08de3e57da248a577d0;hpb=4148556a9c767fdf3047ae8e004a759356b893dd;p=oota-llvm.git diff --git a/tools/bugpoint/ExecutionDriver.cpp b/tools/bugpoint/ExecutionDriver.cpp index a30f83c96ae..453833eb8df 100644 --- a/tools/bugpoint/ExecutionDriver.cpp +++ b/tools/bugpoint/ExecutionDriver.cpp @@ -1,54 +1,84 @@ //===- 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, e.g. default to the first input filename. -*/ - #include "BugDriver.h" -#include "Support/ToolRunner.h" -#include "Support/CommandLine.h" -#include "Support/Debug.h" -#include "Support/FileUtilities.h" -#include "Support/SystemUtils.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 #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 + 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"), + 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)); + clEnumValEnd), + 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)")); + + 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")); } -// 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); +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); + + cl::list + ToolArgv("tool-args", cl::Positional, cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); +} //===----------------------------------------------------------------------===// // BugDriver method implementation @@ -60,17 +90,52 @@ InputArgv("args", cl::Positional, cl::desc("..."), 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 + cbe = 0; std::string Message; + switch (InterpreterSel) { - case RunLLI: Interpreter = createLLItool(getToolName(), Message); break; - case RunLLC: Interpreter = createLLCtool(getToolName(), Message); break; - case RunJIT: Interpreter = createJITtool(getToolName(), Message); break; - case RunCBE: Interpreter = createCBEtool(getToolName(), 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 RunCBE: + Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message, + &ToolArgv); + break; default: Message = "Sorry, this back-end is not supported by bugpoint right now!\n"; break; @@ -78,15 +143,38 @@ bool BugDriver::initializeExecutionEnvironment() { std::cerr << Message; // Initialize auxiliary tools for debugging - cbe = createCBEtool(getToolName(), Message); - if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); } - gcc = createGCCtool(getToolName(), Message); + if (!cbe) { + 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"); + BytecodeFile.makeUnique(); + 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 @@ -94,13 +182,17 @@ 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... - BytecodeFile = getUniqueFilename("bugpoint-test-program.bc"); + sys::Path uniqueFilename("bugpoint-test-program.bc"); + uniqueFilename.makeUnique(); + BytecodeFile = uniqueFilename.toString(); if (writeProgramToFile(BytecodeFile, Program)) { std::cerr << ToolName << ": Error emitting bytecode to file '" @@ -110,41 +202,83 @@ std::string BugDriver::executeProgram(std::string OutputFile, 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); - - // Actually execute the program! - int RetVal = (AI != 0) ? - AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, OutputFile, - SharedObject) : - Interpreter->ExecuteProgram(BytecodeFile, InputArgv, - InputFile, OutputFile, SharedObject); + sys::Path uniqueFile(OutputFile); + uniqueFile.makeUnique(); + OutputFile = uniqueFile.toString(); + + // Figure out which shared objects to run, if any. + std::vector SharedObjs(AdditionalSOs); + if (!SharedObj.empty()) + SharedObjs.push_back(SharedObj); + + + // 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) + RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, + OutputFile, AdditionalLinkerArgs, SharedObjs, + Timeout); + else + RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile, + OutputFile, std::vector(), + SharedObjs, Timeout); + + if (RetVal == -1) { + std::cerr << ""; + 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; + } + } - // Remove the temporary bytecode file. - if (CreatedBytecode) removeFile(BytecodeFile); + if (ProgramExitedNonzero != 0) + *ProgramExitedNonzero = (RetVal != 0); // Return the filename we captured the output to. 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; + sys::Path OutputCFile; // Using CBE cbe->OutputC(BytecodeFile, OutputCFile); #if 0 /* This is an alternative, as yet unimplemented */ // Using LLC + std::string Message; LLC *llc = createLLCtool(Message); if (llc->OutputAsm(BytecodeFile, OutputFile)) { std::cerr << "Could not generate asm code with `llc', exiting.\n"; @@ -152,12 +286,15 @@ int BugDriver::compileSharedObject(const std::string &BytecodeFile, } #endif - gcc->MakeSharedObject(OutputCFile, CFile, SharedObject); + std::string SharedObjectFile; + if (gcc->MakeSharedObject(OutputCFile.toString(), GCC::CFile, + SharedObjectFile, AdditionalLinkerArgs)) + exit(1); // Remove the intermediate C file - removeFile(OutputCFile); + OutputCFile.eraseFromDisk(); - return 0; + return "./" + SharedObjectFile; } @@ -168,23 +305,42 @@ 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); + 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 (DiffFiles(ReferenceOutputFile, Output, &Error)) { - if (!Error.empty()) { - std::cerr << "While diffing output: " << Error << "\n"; + 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; } - if (RemoveBytecode) removeFile(BytecodeFile); + // Remove the generated output. + Output.eraseFromDisk(); + + // Remove the bytecode file if we are supposed to. + if (RemoveBytecode) + sys::Path(BytecodeFile).eraseFromDisk(); return FilesDifferent; } bool BugDriver::isExecutingJIT() { return InterpreterSel == RunJIT; } +