X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FOptimizerDriver.cpp;h=344e7b588fb864a9df18211128aaddcf24828a1d;hb=07b637e04d1e88688c2456da1bd02eef08682cf7;hp=c922f5ca6cce0c34a2fac2a887591f258a2bf67f;hpb=741c11823091f88a3cd880aa5abbd9c3caa854e3;p=oota-llvm.git diff --git a/tools/bugpoint/OptimizerDriver.cpp b/tools/bugpoint/OptimizerDriver.cpp index c922f5ca6cc..344e7b588fb 100644 --- a/tools/bugpoint/OptimizerDriver.cpp +++ b/tools/bugpoint/OptimizerDriver.cpp @@ -1,10 +1,10 @@ //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===// -// +// // 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 is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// //===----------------------------------------------------------------------===// // // This file defines an interface that allows bugpoint to run various passes @@ -15,203 +15,279 @@ // //===----------------------------------------------------------------------===// -// Note: as a short term hack, the old Unix-specific code and platform- -// independent code co-exist via conditional compilation until it is verified -// that the new code works correctly on Unix. - -//#define PLATFORMINDEPENDENT - #include "BugDriver.h" -#include "llvm/Module.h" -#include "llvm/PassManager.h" -#include "llvm/Analysis/Verifier.h" -#include "llvm/Bytecode/WriteBytecodePass.h" -#include "llvm/Target/TargetData.h" +#include "llvm/Bitcode/ReaderWriter.h" +#include "llvm/IR/DataLayout.h" +#include "llvm/IR/LegacyPassManager.h" +#include "llvm/IR/Module.h" +#include "llvm/IR/Verifier.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/Debug.h" #include "llvm/Support/FileUtilities.h" -#include "llvm/System/Path.h" +#include "llvm/Support/Path.h" +#include "llvm/Support/Program.h" +#include "llvm/Support/SystemUtils.h" +#include "llvm/Support/ToolOutputFile.h" + +#define DONT_GET_PLUGIN_LOADER_OPTION +#include "llvm/Support/PluginLoader.h" + #include -#ifndef PLATFORMINDEPENDENT -#include -#include -#include -#endif + using namespace llvm; -/// writeProgramToFile - This writes the current "Program" to the named bytecode +#define DEBUG_TYPE "bugpoint" + +namespace llvm { + extern cl::opt OutputPrefix; +} + +static cl::opt PreserveBitcodeUseListOrder( + "preserve-bc-uselistorder", + cl::desc("Preserve use-list order when writing LLVM bitcode."), + cl::init(true), cl::Hidden); + +namespace { + // ChildOutput - This option captures the name of the child output file that + // is set up by the parent bugpoint process + cl::opt ChildOutput("child-output", cl::ReallyHidden); + cl::opt OptCmd("opt-command", cl::init(""), + cl::desc("Path to opt. (default: search path " + "for 'opt'.)")); +} + +/// writeProgramToFile - This writes the current "Program" to the named bitcode /// file. If an error occurs, true is returned. /// +static bool writeProgramToFileAux(tool_output_file &Out, const Module *M) { + WriteBitcodeToFile(M, Out.os(), PreserveBitcodeUseListOrder); + Out.os().close(); + if (!Out.os().has_error()) { + Out.keep(); + return false; + } + return true; +} + +bool BugDriver::writeProgramToFile(const std::string &Filename, int FD, + const Module *M) const { + tool_output_file Out(Filename, FD); + return writeProgramToFileAux(Out, M); +} + bool BugDriver::writeProgramToFile(const std::string &Filename, - Module *M) const { - std::ios::openmode io_mode = std::ios::out | std::ios::trunc | - std::ios::binary; - std::ofstream Out(Filename.c_str(), io_mode); - if (!Out.good()) return true; - WriteBytecodeToFile(M ? M : Program, Out, /*compression=*/true); - return false; + const Module *M) const { + std::error_code EC; + tool_output_file Out(Filename, EC, sys::fs::F_None); + if (!EC) + return writeProgramToFileAux(Out, M); + return true; } -/// EmitProgressBytecode - This function is used to output the current Program +/// EmitProgressBitcode - This function is used to output the current Program /// to a file named "bugpoint-ID.bc". /// -void BugDriver::EmitProgressBytecode(const std::string &ID, bool NoFlyer) { - // Output the input to the current pass to a bytecode file, emit a message +void BugDriver::EmitProgressBitcode(const Module *M, + const std::string &ID, + bool NoFlyer) const { + // Output the input to the current pass to a bitcode file, emit a message // telling the user how to reproduce it: opt -foo blah.bc // - std::string Filename = "bugpoint-" + ID + ".bc"; - if (writeProgramToFile(Filename)) { - std::cerr << "Error opening file '" << Filename << "' for writing!\n"; + std::string Filename = OutputPrefix + "-" + ID + ".bc"; + if (writeProgramToFile(Filename, M)) { + errs() << "Error opening file '" << Filename << "' for writing!\n"; return; } - std::cout << "Emitted bytecode to '" << Filename << "'\n"; + outs() << "Emitted bitcode to '" << Filename << "'\n"; if (NoFlyer || PassesToRun.empty()) return; - std::cout << "\n*** You can reproduce the problem with: "; - - unsigned PassType = PassesToRun[0]->getPassType(); - for (unsigned i = 1, e = PassesToRun.size(); i != e; ++i) - PassType &= PassesToRun[i]->getPassType(); - - if (PassType & PassInfo::Analysis) - std::cout << "analyze"; - else if (PassType & PassInfo::Optimization) - std::cout << "opt"; - else if (PassType & PassInfo::LLC) - std::cout << "llc"; - else - std::cout << "bugpoint"; - std::cout << " " << Filename << " "; - std::cout << getPassesString(PassesToRun) << "\n"; -} - -static void RunChild(Module *Program,const std::vector &Passes, - const std::string &OutFilename) { - std::ios::openmode io_mode = std::ios::out | std::ios::trunc | - std::ios::binary; - std::ofstream OutFile(OutFilename.c_str(), io_mode); - if (!OutFile.good()) { - std::cerr << "Error opening bytecode file: " << OutFilename << "\n"; - exit(1); - } - - PassManager PM; - // Make sure that the appropriate target data is always used... - PM.add(new TargetData("bugpoint", Program)); - - for (unsigned i = 0, e = Passes.size(); i != e; ++i) { - if (Passes[i]->getNormalCtor()) - PM.add(Passes[i]->getNormalCtor()()); - else - std::cerr << "Cannot create pass yet: " << Passes[i]->getPassName() - << "\n"; + outs() << "\n*** You can reproduce the problem with: "; + if (UseValgrind) outs() << "valgrind "; + outs() << "opt " << Filename; + for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) { + outs() << " -load " << PluginLoader::getPlugin(i); } - // Check that the module is well formed on completion of optimization - PM.add(createVerifierPass()); + outs() << " " << getPassesString(PassesToRun) << "\n"; +} - // Write bytecode out to disk as the last step... - PM.add(new WriteBytecodePass(&OutFile)); +cl::opt SilencePasses("silence-passes", + cl::desc("Suppress output of running passes (both stdout and stderr)")); - // Run all queued passes. - PM.run(*Program); -} +static cl::list OptArgs("opt-args", cl::Positional, + cl::desc("..."), + cl::ZeroOrMore, cl::PositionalEatsArgs); -/// runPasses - Run the specified passes on Program, outputting a bytecode file +/// runPasses - Run the specified passes on Program, outputting a bitcode file /// and writing the filename into OutputFile if successful. If the /// optimizations fail for some reason (optimizer crashes), return true, -/// otherwise return false. If DeleteOutput is set to true, the bytecode is +/// otherwise return false. If DeleteOutput is set to true, the bitcode is /// deleted on success, and the filename string is undefined. This prints to -/// cout a single line message indicating whether compilation was successful or -/// failed. +/// outs() a single line message indicating whether compilation was successful +/// or failed. /// -bool BugDriver::runPasses(const std::vector &Passes, +bool BugDriver::runPasses(Module *Program, + const std::vector &Passes, std::string &OutputFilename, bool DeleteOutput, - bool Quiet) const{ - std::cout << std::flush; - sys::Path uniqueFilename("bugpoint-output.bc"); - uniqueFilename.makeUnique(); - OutputFilename = uniqueFilename.toString(); - -#ifndef PLATFORMINDEPENDENT - pid_t child_pid; - switch (child_pid = fork()) { - case -1: // Error occurred - std::cerr << ToolName << ": Error forking!\n"; - exit(1); - case 0: // Child process runs passes. - RunChild(Program, Passes, OutputFilename); - exit(0); // If we finish successfully, return 0! - default: // Parent continues... - break; + bool Quiet, unsigned NumExtraArgs, + const char * const *ExtraArgs) const { + // setup the output file name + outs().flush(); + SmallString<128> UniqueFilename; + std::error_code EC = sys::fs::createUniqueFile( + OutputPrefix + "-output-%%%%%%%.bc", UniqueFilename); + if (EC) { + errs() << getToolName() << ": Error making unique filename: " + << EC.message() << "\n"; + return 1; } + OutputFilename = UniqueFilename.str(); - // Wait for the child process to get done. - int Status; - if (wait(&Status) != child_pid) { - std::cerr << "Error waiting for child process!\n"; - exit(1); + // set up the input file name + SmallString<128> InputFilename; + int InputFD; + EC = sys::fs::createUniqueFile(OutputPrefix + "-input-%%%%%%%.bc", InputFD, + InputFilename); + if (EC) { + errs() << getToolName() << ": Error making unique filename: " + << EC.message() << "\n"; + return 1; + } + + tool_output_file InFile(InputFilename, InputFD); + + WriteBitcodeToFile(Program, InFile.os(), PreserveBitcodeUseListOrder); + InFile.os().close(); + if (InFile.os().has_error()) { + errs() << "Error writing bitcode file: " << InputFilename << "\n"; + InFile.os().clear_error(); + return 1; + } + + std::string tool = OptCmd; + if (OptCmd.empty()) { + if (ErrorOr Path = sys::findProgramByName("opt")) + tool = *Path; + else + errs() << Path.getError().message() << "\n"; + } + if (tool.empty()) { + errs() << "Cannot find `opt' in PATH!\n"; + return 1; + } + + std::string Prog; + if (UseValgrind) { + if (ErrorOr Path = sys::findProgramByName("valgrind")) + Prog = *Path; + else + errs() << Path.getError().message() << "\n"; + } else + Prog = tool; + if (Prog.empty()) { + errs() << "Cannot find `valgrind' in PATH!\n"; + return 1; + } + + // Ok, everything that could go wrong before running opt is done. + InFile.keep(); + + // setup the child process' arguments + SmallVector Args; + if (UseValgrind) { + Args.push_back("valgrind"); + Args.push_back("--error-exitcode=1"); + Args.push_back("-q"); + Args.push_back(tool.c_str()); + } else + Args.push_back(tool.c_str()); + + Args.push_back("-o"); + Args.push_back(OutputFilename.c_str()); + for (unsigned i = 0, e = OptArgs.size(); i != e; ++i) + Args.push_back(OptArgs[i].c_str()); + std::vector pass_args; + for (unsigned i = 0, e = PluginLoader::getNumPlugins(); i != e; ++i) { + pass_args.push_back( std::string("-load")); + pass_args.push_back( PluginLoader::getPlugin(i)); } + for (std::vector::const_iterator I = Passes.begin(), + E = Passes.end(); I != E; ++I ) + pass_args.push_back( std::string("-") + (*I) ); + for (std::vector::const_iterator I = pass_args.begin(), + E = pass_args.end(); I != E; ++I ) + Args.push_back(I->c_str()); + Args.push_back(InputFilename.c_str()); + for (unsigned i = 0; i < NumExtraArgs; ++i) + Args.push_back(*ExtraArgs); + Args.push_back(nullptr); - bool ExitedOK = WIFEXITED(Status) && WEXITSTATUS(Status) == 0; -#else - bool ExitedOK = false; -#endif + DEBUG(errs() << "\nAbout to run:\t"; + for (unsigned i = 0, e = Args.size()-1; i != e; ++i) + errs() << " " << Args[i]; + errs() << "\n"; + ); - // If we are supposed to delete the bytecode file or if the passes crashed, + // Redirect stdout and stderr to nowhere if SilencePasses is given + StringRef Nowhere; + const StringRef *Redirects[3] = {nullptr, &Nowhere, &Nowhere}; + + std::string ErrMsg; + int result = sys::ExecuteAndWait(Prog, Args.data(), nullptr, + (SilencePasses ? Redirects : nullptr), + Timeout, MemoryLimit, &ErrMsg); + + // If we are supposed to delete the bitcode file or if the passes crashed, // remove it now. This may fail if the file was never created, but that's ok. - if (DeleteOutput || !ExitedOK) - sys::Path(OutputFilename).destroyFile(); + if (DeleteOutput || result != 0) + sys::fs::remove(OutputFilename); + + // Remove the temporary input file as well + sys::fs::remove(InputFilename.c_str()); -#ifndef PLATFORMINDEPENDENT if (!Quiet) { - if (ExitedOK) - std::cout << "Success!\n"; - else if (WIFEXITED(Status)) - std::cout << "Exited with error code '" << WEXITSTATUS(Status) << "'\n"; - else if (WIFSIGNALED(Status)) - std::cout << "Crashed with signal #" << WTERMSIG(Status) << "\n"; -#ifdef WCOREDUMP - else if (WCOREDUMP(Status)) - std::cout << "Dumped core\n"; -#endif - else - std::cout << "Failed for unknown reason!\n"; + if (result == 0) + outs() << "Success!\n"; + else if (result > 0) + outs() << "Exited with error code '" << result << "'\n"; + else if (result < 0) { + if (result == -1) + outs() << "Execute failed: " << ErrMsg << "\n"; + else + outs() << "Crashed: " << ErrMsg << "\n"; + } + if (result & 0x01000000) + outs() << "Dumped core\n"; } -#endif // Was the child successful? - return !ExitedOK; + return result != 0; } -/// runPassesOn - Carefully run the specified set of pass on the specified -/// module, returning the transformed module on success, or a null pointer on -/// failure. -Module *BugDriver::runPassesOn(Module *M, - const std::vector &Passes, - bool AutoDebugCrashes) { - Module *OldProgram = swapProgramIn(M); - std::string BytecodeResult; - if (runPasses(Passes, BytecodeResult, false/*delete*/, true/*quiet*/)) { +std::unique_ptr +BugDriver::runPassesOn(Module *M, const std::vector &Passes, + bool AutoDebugCrashes, unsigned NumExtraArgs, + const char *const *ExtraArgs) { + std::string BitcodeResult; + if (runPasses(M, Passes, BitcodeResult, false/*delete*/, true/*quiet*/, + NumExtraArgs, ExtraArgs)) { if (AutoDebugCrashes) { - std::cerr << " Error running this sequence of passes" - << " on the input program!\n"; - delete OldProgram; - EmitProgressBytecode("pass-error", false); + errs() << " Error running this sequence of passes" + << " on the input program!\n"; + delete swapProgramIn(M); + EmitProgressBitcode(M, "pass-error", false); exit(debugOptimizerCrash()); } - swapProgramIn(OldProgram); - return 0; + return nullptr; } - // Restore the current program. - swapProgramIn(OldProgram); - - Module *Ret = ParseInputFile(BytecodeResult); - if (Ret == 0) { - std::cerr << getToolName() << ": Error reading bytecode file '" - << BytecodeResult << "'!\n"; + std::unique_ptr Ret = parseInputFile(BitcodeResult, Context); + if (!Ret) { + errs() << getToolName() << ": Error reading bitcode file '" + << BitcodeResult << "'!\n"; exit(1); } - sys::Path(BytecodeResult).destroyFile(); // No longer need the file on disk + sys::fs::remove(BitcodeResult); return Ret; }