X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FBugDriver.cpp;h=acea37e1feef5daa9f1256cce1a38ed855d6ba7b;hb=befc9c16fae1719cafe9f54ab2b67219db44dc11;hp=a1bb2d426364ba441666e510f796f2c5a5cae283;hpb=3d9cafa003a114bf9974bc80d5b69b0ed1d29290;p=oota-llvm.git diff --git a/tools/bugpoint/BugDriver.cpp b/tools/bugpoint/BugDriver.cpp index a1bb2d42636..acea37e1fee 100644 --- a/tools/bugpoint/BugDriver.cpp +++ b/tools/bugpoint/BugDriver.cpp @@ -1,5 +1,12 @@ //===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===// // +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// // This class contains all of the shared state and information that is used by // the BugPoint tool to track down errors in optimizations. This class is the // main driver class that invokes all sub-functionality. @@ -7,14 +14,18 @@ //===----------------------------------------------------------------------===// #include "BugDriver.h" +#include "ToolRunner.h" +#include "llvm/Linker.h" #include "llvm/Module.h" #include "llvm/Pass.h" #include "llvm/Assembly/Parser.h" -#include "llvm/Bytecode/Reader.h" -#include "llvm/Transforms/Utils/Linker.h" -#include "Support/CommandLine.h" -#include "Support/FileUtilities.h" +#include "llvm/Bitcode/ReaderWriter.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/FileUtilities.h" +#include "llvm/Support/MemoryBuffer.h" +#include #include +using namespace llvm; // Anonymous namespace to define command line options for debugging. // @@ -24,23 +35,24 @@ namespace { // otherwise the raw input run through an interpreter is used as the reference // source. // - cl::opt + cl::opt OutputFile("output", cl::desc("Specify a reference program output " "(for miscompilation detection)")); +} - enum DebugType { DebugCompile, DebugCodegen }; - cl::opt - DebugMode("mode", cl::desc("Debug mode for bugpoint:"), cl::Prefix, - cl::values(clEnumValN(DebugCompile, "compile", " Compilation"), - clEnumValN(DebugCodegen, "codegen", " Code generation"), - 0), - cl::init(DebugCompile)); +/// setNewProgram - If we reduce or update the program somehow, call this method +/// to update bugdriver with it. This deletes the old module and sets the +/// specified one as the current program. +void BugDriver::setNewProgram(Module *M) { + delete Program; + Program = M; } + /// getPassesString - Turn a list of passes into a string which indicates the /// command line options that must be passed to add the passes. /// -std::string getPassesString(const std::vector &Passes) { +std::string llvm::getPassesString(const std::vector &Passes) { std::string Result; for (unsigned i = 0, e = Passes.size(); i != e; ++i) { if (i) Result += " "; @@ -50,71 +62,68 @@ std::string getPassesString(const std::vector &Passes) { return Result; } -// DeleteFunctionBody - "Remove" the function by deleting all of its basic -// blocks, making it external. -// -void DeleteFunctionBody(Function *F) { - // First, break circular use/def chain references... - for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) - I->dropAllReferences(); - - // Next, delete all of the basic blocks. - F->getBasicBlockList().clear(); - F->setLinkage(GlobalValue::ExternalLinkage); - assert(F->isExternal() && "This didn't make the function external!"); -} - -BugDriver::BugDriver(const char *toolname) +BugDriver::BugDriver(const char *toolname, bool as_child, bool find_bugs, + unsigned timeout, unsigned memlimit) : ToolName(toolname), ReferenceOutputFile(OutputFile), - Program(0), Interpreter(0), cbe(0), gcc(0) {} + Program(0), Interpreter(0), cbe(0), gcc(0), run_as_child(as_child), + run_find_bugs(find_bugs), Timeout(timeout), MemoryLimit(memlimit) {} -/// ParseInputFile - Given a bytecode or assembly input filename, parse and +/// ParseInputFile - Given a bitcode or assembly input filename, parse and /// return it, or return null if not possible. /// -Module *BugDriver::ParseInputFile(const std::string &InputFilename) const { +Module *llvm::ParseInputFile(const std::string &Filename) { + std::auto_ptr Buffer(MemoryBuffer::getFileOrSTDIN(Filename)); Module *Result = 0; - try { - Result = ParseBytecodeFile(InputFilename); - if (!Result && !(Result = ParseAssemblyFile(InputFilename))){ - std::cerr << ToolName << ": could not read input file '" - << InputFilename << "'!\n"; - } - } catch (const ParseException &E) { - std::cerr << ToolName << ": " << E.getMessage() << "\n"; + if (Buffer.get()) + Result = ParseBitcodeFile(Buffer.get()); + + ParseError Err; + if (!Result && !(Result = ParseAssemblyFile(Filename, &Err))) { + std::cerr << "bugpoint: " << Err.getMessage() << "\n"; Result = 0; } + return Result; } // This method takes the specified list of LLVM input files, attempts to load -// them, either as assembly or bytecode, then link them together. It returns -// true on failure (if, for example, an input bytecode file could not be +// them, either as assembly or bitcode, then link them together. It returns +// true on failure (if, for example, an input bitcode file could not be // parsed), and false on success. // bool BugDriver::addSources(const std::vector &Filenames) { assert(Program == 0 && "Cannot call addSources multiple times!"); assert(!Filenames.empty() && "Must specify at least on input filename!"); - // Load the first input file... - Program = ParseInputFile(Filenames[0]); - if (Program == 0) return true; - std::cout << "Read input file : '" << Filenames[0] << "'\n"; - - for (unsigned i = 1, e = Filenames.size(); i != e; ++i) { - std::auto_ptr M(ParseInputFile(Filenames[i])); - if (M.get() == 0) return true; - - std::cout << "Linking in input file: '" << Filenames[i] << "'\n"; - std::string ErrorMessage; - if (LinkModules(Program, M.get(), &ErrorMessage)) { - std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': " - << ErrorMessage << "\n"; - return true; + try { + // Load the first input file. + Program = ParseInputFile(Filenames[0]); + if (Program == 0) return true; + + if (!run_as_child) + std::cout << "Read input file : '" << Filenames[0] << "'\n"; + + for (unsigned i = 1, e = Filenames.size(); i != e; ++i) { + std::auto_ptr M(ParseInputFile(Filenames[i])); + if (M.get() == 0) return true; + + if (!run_as_child) + std::cout << "Linking in input file: '" << Filenames[i] << "'\n"; + std::string ErrorMessage; + if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) { + std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': " + << ErrorMessage << '\n'; + return true; + } } + } catch (const std::string &Error) { + std::cerr << ToolName << ": error reading input '" << Error << "'\n"; + return true; } - std::cout << "*** All input ok\n"; + if (!run_as_child) + std::cout << "*** All input ok\n"; // All input files read successfully! return false; @@ -126,54 +135,105 @@ bool BugDriver::addSources(const std::vector &Filenames) { /// variables are set up from command line arguments. /// bool BugDriver::run() { - // The first thing that we must do is determine what the problem is. Does the - // optimization series crash the compiler, or does it produce illegal code? We - // make the top-level decision by trying to run all of the passes on the the - // input program, which should generate a bytecode file. If it does generate - // a bytecode file, then we know the compiler didn't crash, so try to diagnose - // a miscompilation. - // - std::cout << "Running selected passes on program to test for crash: "; - if (runPasses(PassesToRun)) - return debugCrash(); + // The first thing to do is determine if we're running as a child. If we are, + // then what to do is very narrow. This form of invocation is only called + // from the runPasses method to actually run those passes in a child process. + if (run_as_child) { + // Execute the passes + return runPassesAsChild(PassesToRun); + } + + if (run_find_bugs) { + // Rearrange the passes and apply them to the program. Repeat this process + // until the user kills the program or we find a bug. + return runManyPasses(PassesToRun); + } - std::cout << "Checking for a miscompilation...\n"; + // If we're not running as a child, the first thing that we must do is + // determine what the problem is. Does the optimization series crash the + // compiler, or does it produce illegal code? We make the top-level + // decision by trying to run all of the passes on the the input program, + // which should generate a bitcode file. If it does generate a bitcode + // file, then we know the compiler didn't crash, so try to diagnose a + // miscompilation. + if (!PassesToRun.empty()) { + std::cout << "Running selected passes on program to test for crash: "; + if (runPasses(PassesToRun)) + return debugOptimizerCrash(); + } - // Set up the execution environment, selecting a method to run LLVM bytecode. + // Set up the execution environment, selecting a method to run LLVM bitcode. if (initializeExecutionEnvironment()) return true; + // Test to see if we have a code generator crash. + std::cout << "Running the code generator to test for a crash: "; + try { + compileProgram(Program); + std::cout << '\n'; + } catch (ToolExecutionError &TEE) { + std::cout << TEE.what(); + return debugCodeGeneratorCrash(); + } + + // Run the raw input to see where we are coming from. If a reference output // was specified, make sure that the raw output matches it. If not, it's a // problem in the front-end or the code generator. // - bool CreatedOutput = false, Result; + bool CreatedOutput = false; if (ReferenceOutputFile.empty()) { - std::cout << "Generating reference output from raw program..."; - if (DebugCodegen) { - ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out"); - } else { - ReferenceOutputFile = executeProgram("bugpoint.reference.out"); + std::cout << "Generating reference output from raw program: "; + if(!createReferenceFile(Program)){ + return debugCodeGeneratorCrash(); } CreatedOutput = true; - std::cout << "Reference output is: " << ReferenceOutputFile << "\n"; - } - - if (DebugMode == DebugCompile) { - std::cout << "\n*** Debugging miscompilation!\n"; - Result = debugMiscompilation(); - } else if (DebugMode == DebugCodegen) { - std::cout << "Debugging code generator problem!\n"; - Result = debugCodeGenerator(); } - if (CreatedOutput) removeFile(ReferenceOutputFile); - return Result; -} + // Make sure the reference output file gets deleted on exit from this + // function, if appropriate. + sys::Path ROF(ReferenceOutputFile); + FileRemover RemoverInstance(ROF, CreatedOutput); -void BugDriver::PrintFunctionList(const std::vector &Funcs) -{ - for (unsigned i = 0, e = Funcs.size(); i != e; ++i) { - if (i) std::cout << ", "; - std::cout << Funcs[i]->getName(); + // Diff the output of the raw program against the reference output. If it + // matches, then we assume there is a miscompilation bug and try to + // diagnose it. + std::cout << "*** Checking the code generator...\n"; + try { + if (!diffProgram()) { + std::cout << "\n*** Debugging miscompilation!\n"; + return debugMiscompilation(); + } + } catch (ToolExecutionError &TEE) { + std::cerr << TEE.what(); + return debugCodeGeneratorCrash(); } + + std::cout << "\n*** Input program does not match reference diff!\n"; + std::cout << "Debugging code generator problem!\n"; + try { + return debugCodeGenerator(); + } catch (ToolExecutionError &TEE) { + std::cerr << TEE.what(); + return debugCodeGeneratorCrash(); + } +} + +void llvm::PrintFunctionList(const std::vector &Funcs) { + unsigned NumPrint = Funcs.size(); + if (NumPrint > 10) NumPrint = 10; + for (unsigned i = 0; i != NumPrint; ++i) + std::cout << " " << Funcs[i]->getName(); + if (NumPrint < Funcs.size()) + std::cout << "... <" << Funcs.size() << " total>"; + std::cout << std::flush; +} + +void llvm::PrintGlobalVariableList(const std::vector &GVs) { + unsigned NumPrint = GVs.size(); + if (NumPrint > 10) NumPrint = 10; + for (unsigned i = 0; i != NumPrint; ++i) + std::cout << " " << GVs[i]->getName(); + if (NumPrint < GVs.size()) + std::cout << "... <" << GVs.size() << " total>"; + std::cout << std::flush; }