X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FOptimizerDriver.cpp;h=3ded5e866b3e025baaea3eee40a49dcd3df6ff2d;hb=73b43b9b549a75fb0015c825df68abd95705a67c;hp=fe9112e34cb27b76e4f901e9cb2b293a4548bbc8;hpb=3d9cafa003a114bf9974bc80d5b69b0ed1d29290;p=oota-llvm.git diff --git a/tools/bugpoint/OptimizerDriver.cpp b/tools/bugpoint/OptimizerDriver.cpp index fe9112e34cb..3ded5e866b3 100644 --- a/tools/bugpoint/OptimizerDriver.cpp +++ b/tools/bugpoint/OptimizerDriver.cpp @@ -1,155 +1,266 @@ //===- OptimizerDriver.cpp - Allow BugPoint to run passes safely ----------===// // +// The LLVM Compiler Infrastructure +// +// 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 -// without the threat of a buggy pass corrupting bugpoint (of course bugpoint -// may have it's own bugs, but that's another story...). It acheives this by +// without the threat of a buggy pass corrupting bugpoint (of course, bugpoint +// may have its own bugs, but that's another story...). It achieves this by // forking a copy of itself and having the child process do the optimizations. // If this client dies, we can always fork a new one. :) // //===----------------------------------------------------------------------===// +// 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. + #include "BugDriver.h" +#include "llvm/Module.h" #include "llvm/PassManager.h" #include "llvm/Analysis/Verifier.h" -#include "llvm/Bytecode/WriteBytecodePass.h" +#include "llvm/Bitcode/ReaderWriter.h" #include "llvm/Target/TargetData.h" -#include "Support/FileUtilities.h" +#include "llvm/Support/FileUtilities.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/Streams.h" +#include "llvm/System/Path.h" +#include "llvm/System/Program.h" +#include "llvm/Config/alloca.h" + +#define DONT_GET_PLUGIN_LOADER_OPTION +#include "llvm/Support/PluginLoader.h" + #include -#include -#include -#include -#include +using namespace llvm; + + +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 UseValgrind("enable-valgrind", + cl::desc("Run optimizations through valgrind")); +} -/// writeProgramToFile - This writes the current "Program" to the named bytecode +/// writeProgramToFile - This writes the current "Program" to the named bitcode /// file. If an error occurs, true is returned. /// bool BugDriver::writeProgramToFile(const std::string &Filename, - Module *M) const { - std::ofstream Out(Filename.c_str()); + 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); + + WriteBitcodeToFile(M ? M : Program, Out); return false; } -/// 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 std::string &ID, bool NoFlyer) { + // 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"; + cerr << "Error opening file '" << Filename << "' for writing!\n"; return; } - std::cout << "Emitted bytecode to '" << Filename << "'\n"; - if (NoFlyer) 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"; + cout << "Emitted bitcode to '" << Filename << "'\n"; + if (NoFlyer || PassesToRun.empty()) return; + cout << "\n*** You can reproduce the problem with: "; + cout << "opt " << Filename << " "; + cout << getPassesString(PassesToRun) << "\n"; } -static void RunChild(Module *Program,const std::vector &Passes, - const std::string &OutFilename) { - std::ofstream OutFile(OutFilename.c_str()); +int BugDriver::runPassesAsChild(const std::vector &Passes) { + + std::ios::openmode io_mode = std::ios::out | std::ios::trunc | + std::ios::binary; + std::ofstream OutFile(ChildOutput.c_str(), io_mode); if (!OutFile.good()) { - std::cerr << "Error opening bytecode file: " << OutFilename << "\n"; - exit(1); + cerr << "Error opening bitcode file: " << ChildOutput << "\n"; + return 1; } PassManager PM; // Make sure that the appropriate target data is always used... - PM.add(new TargetData("bugpoint", Program)); + PM.add(new TargetData(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"; + cerr << "Cannot create pass yet: " << Passes[i]->getPassName() << "\n"; } // Check that the module is well formed on completion of optimization PM.add(createVerifierPass()); - // Write bytecode out to disk as the last step... - PM.add(new WriteBytecodePass(&OutFile)); + // Write bitcode out to disk as the last step... + PM.add(CreateBitcodeWriterPass(OutFile)); // Run all queued passes. PM.run(*Program); + + return 0; } -/// runPasses - Run the specified passes on Program, outputting a bytecode file -/// and writting the filename into OutputFile if successful. If the +cl::opt SilencePasses("silence-passes", cl::desc("Suppress output of running passes (both stdout and stderr)")); + +/// 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. /// bool BugDriver::runPasses(const std::vector &Passes, std::string &OutputFilename, bool DeleteOutput, - bool Quiet) const{ - std::cout << std::flush; - OutputFilename = getUniqueFilename("bugpoint-output.bc"); - - 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 + cout << std::flush; + sys::Path uniqueFilename("bugpoint-output.bc"); + std::string ErrMsg; + if (uniqueFilename.makeUnique(true, &ErrMsg)) { + cerr << getToolName() << ": Error making unique filename: " + << ErrMsg << "\n"; + return(1); } + OutputFilename = uniqueFilename.toString(); - // 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 + sys::Path inputFilename("bugpoint-input.bc"); + if (inputFilename.makeUnique(true, &ErrMsg)) { + cerr << getToolName() << ": Error making unique filename: " + << ErrMsg << "\n"; + return(1); + } + std::ios::openmode io_mode = std::ios::out | std::ios::trunc | + std::ios::binary; + std::ofstream InFile(inputFilename.c_str(), io_mode); + if (!InFile.good()) { + cerr << "Error opening bitcode file: " << inputFilename << "\n"; + return(1); } + WriteBitcodeToFile(Program, InFile); + InFile.close(); - // If we are supposed to delete the bytecode file, remove it now - // unconditionally... this may fail if the file was never created, but that's - // ok. - if (DeleteOutput) - removeFile(OutputFilename); + // setup the child process' arguments + const char** args = (const char**) + alloca(sizeof(const char*) * + (Passes.size()+13+2*PluginLoader::getNumPlugins()+NumExtraArgs)); + int n = 0; + sys::Path tool = sys::Program::FindProgramByName(ToolName); + if (UseValgrind) { + args[n++] = "valgrind"; + args[n++] = "--error-exitcode=1"; + args[n++] = "-q"; + args[n++] = tool.c_str(); + } else + args[n++] = ToolName.c_str(); - bool ExitedOK = WIFEXITED(Status) && WEXITSTATUS(Status) == 0; + args[n++] = "-as-child"; + args[n++] = "-child-output"; + args[n++] = OutputFilename.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)->getPassArgument() ); + for (std::vector::const_iterator I = pass_args.begin(), + E = pass_args.end(); I != E; ++I ) + args[n++] = I->c_str(); + args[n++] = inputFilename.c_str(); + for (unsigned i = 0; i < NumExtraArgs; ++i) + args[n++] = *ExtraArgs; + args[n++] = 0; + + sys::Path prog; + if (UseValgrind) + prog = sys::Program::FindProgramByName("valgrind"); + else + prog = tool; + // Redirect stdout and stderr to nowhere if SilencePasses is given + sys::Path Nowhere; + const sys::Path *Redirects[3] = {0, &Nowhere, &Nowhere}; + + int result = sys::Program::ExecuteAndWait(prog, args, 0, (SilencePasses ? Redirects : 0), + 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 || result != 0) + sys::Path(OutputFilename).eraseFromDisk(); + + // Remove the temporary input file as well + inputFilename.eraseFromDisk(); + 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) + cout << "Success!\n"; + else if (result > 0) + cout << "Exited with error code '" << result << "'\n"; + else if (result < 0) { + if (result == -1) + cout << "Execute failed: " << ErrMsg << "\n"; + else + cout << "Crashed with signal #" << abs(result) << "\n"; + } + if (result & 0x01000000) + cout << "Dumped core\n"; } // 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, unsigned NumExtraArgs, + const char * const *ExtraArgs) { + Module *OldProgram = swapProgramIn(M); + std::string BitcodeResult; + if (runPasses(Passes, BitcodeResult, false/*delete*/, true/*quiet*/, + NumExtraArgs, ExtraArgs)) { + if (AutoDebugCrashes) { + cerr << " Error running this sequence of passes" + << " on the input program!\n"; + delete OldProgram; + EmitProgressBitcode("pass-error", false); + exit(debugOptimizerCrash()); + } + swapProgramIn(OldProgram); + return 0; + } + + // Restore the current program. + swapProgramIn(OldProgram); + + Module *Ret = ParseInputFile(BitcodeResult); + if (Ret == 0) { + cerr << getToolName() << ": Error reading bitcode file '" + << BitcodeResult << "'!\n"; + exit(1); + } + sys::Path(BitcodeResult).eraseFromDisk(); // No longer need the file on disk + return Ret; }