X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fbugpoint%2FBugDriver.h;h=db35c851d9a43322878e3921e0f654077ec3fbbd;hb=9e6d1d1f5034347d237941f1bf08fba5c1583cd3;hp=eb48eb7d9c31cbeca28da09aa355590a2fa0dfaf;hpb=7546c3884a400b72d10fc19f120c6798b294a39d;p=oota-llvm.git diff --git a/tools/bugpoint/BugDriver.h b/tools/bugpoint/BugDriver.h index eb48eb7d9c3..db35c851d9a 100644 --- a/tools/bugpoint/BugDriver.h +++ b/tools/bugpoint/BugDriver.h @@ -1,10 +1,10 @@ //===- BugDriver.h - Top-Level BugPoint class -------------------*- C++ -*-===// -// +// // 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 class contains all of the shared state and information that is used by @@ -16,45 +16,57 @@ #ifndef BUGDRIVER_H #define BUGDRIVER_H +#include "llvm/ADT/DenseMap.h" #include #include namespace llvm { +class Value; class PassInfo; class Module; +class GlobalVariable; class Function; +class BasicBlock; class AbstractInterpreter; class Instruction; +class LLVMContext; class DebugCrashes; -class ReduceMiscompilingPasses; -class ReduceMiscompilingFunctions; -class CBE; class GCC; extern bool DisableSimplifyCFG; +/// BugpointIsInterrupted - Set to true when the user presses ctrl-c. +/// +extern bool BugpointIsInterrupted; + class BugDriver { - const std::string ToolName; // Name of bugpoint + LLVMContext& Context; + const char *ToolName; // argv[0] of bugpoint std::string ReferenceOutputFile; // Name of `good' output file Module *Program; // The raw program, linked together std::vector PassesToRun; AbstractInterpreter *Interpreter; // How to run the program - CBE *cbe; + AbstractInterpreter *SafeInterpreter; // To generate reference output, etc. GCC *gcc; + bool run_as_child; + bool run_find_bugs; + unsigned Timeout; + unsigned MemoryLimit; // FIXME: sort out public/private distinctions... friend class ReducePassList; - friend class ReduceMiscompilingPasses; - friend class ReduceMiscompilingFunctions; friend class ReduceMisCodegenFunctions; public: - BugDriver(const char *toolname); + BugDriver(const char *toolname, bool as_child, bool find_bugs, + unsigned timeout, unsigned memlimit, LLVMContext& ctxt); + + const char *getToolName() const { return ToolName; } - const std::string &getToolName() const { return ToolName; } + LLVMContext& getContext() { return Context; } // Set up methods... these methods are used to copy information about the // command line arguments into instance variables of BugDriver. @@ -65,9 +77,13 @@ public: void setPassesToRun(const std::vector &PTR) { PassesToRun = PTR; } + const std::vector &getPassesToRun() const { + return PassesToRun; + } /// run - The top level method that is invoked after all of the instance - /// variables are set up from command line arguments. + /// variables are set up from command line arguments. The \p as_child argument + /// indicates whether the driver is to run in parent mode or child mode. /// bool run(); @@ -75,8 +91,8 @@ public: /// crashes on input. It attempts to prune down the testcase to something /// reasonable, and figure out exactly which pass is crashing. /// - bool debugOptimizerCrash(); - + bool debugOptimizerCrash(const std::string &ID = "passes"); + /// debugCodeGeneratorCrash - This method is called when the code generator /// crashes on an input. It attempts to reduce the input as much as possible /// while still causing the code generator to crash. @@ -94,12 +110,12 @@ public: /// are to match. /// bool debugPassMiscompilation(const PassInfo *ThePass, - const std::string &ReferenceOutput); + const std::string &ReferenceOutput); /// compileSharedObject - This method creates a SharedObject from a given - /// BytecodeFile for debugging a code generator. + /// BitcodeFile for debugging a code generator. /// - std::string compileSharedObject(const std::string &BytecodeFile); + std::string compileSharedObject(const std::string &BitcodeFile); /// debugCodeGenerator - This method narrows down a module to a function or /// set of functions, using the CBE as a ``safe'' code generator for other @@ -120,7 +136,25 @@ public: return Result; } - const Module *getProgram() const { return Program; } + Module *getProgram() const { return Program; } + + /// swapProgramIn - Set the current module to the specified module, returning + /// the old one. + Module *swapProgramIn(Module *M) { + Module *OldProgram = Program; + Program = M; + return OldProgram; + } + + AbstractInterpreter *switchToSafeInterpreter() { + AbstractInterpreter *Old = Interpreter; + Interpreter = (AbstractInterpreter*)SafeInterpreter; + return Old; + } + + void switchToInterpreter(AbstractInterpreter *AI) { + Interpreter = AI; + } /// setNewProgram - If we reduce or update the program somehow, call this /// method to update bugdriver with it. This deletes the old module and sets @@ -139,29 +173,38 @@ public: /// generator (e.g., llc crashes), this will throw an exception. /// std::string executeProgram(std::string RequestedOutputFilename = "", - std::string Bytecode = "", + std::string Bitcode = "", const std::string &SharedObjects = "", AbstractInterpreter *AI = 0, bool *ProgramExitedNonzero = 0); - /// executeProgramWithCBE - Used to create reference output with the C + /// executeProgramSafely - Used to create reference output with the "safe" /// backend, if reference output is not provided. If there is a problem with /// the code generator (e.g., llc crashes), this will throw an exception. /// - std::string executeProgramWithCBE(std::string OutputFile = ""); + std::string executeProgramSafely(std::string OutputFile = ""); + + /// createReferenceFile - calls compileProgram and then records the output + /// into ReferenceOutputFile. Returns true if reference file created, false + /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE + /// this function. + /// + bool createReferenceFile(Module *M, const std::string &Filename + = "bugpoint.reference.out"); /// diffProgram - This method executes the specified module and diffs the /// output against the file specified by ReferenceOutputFile. If the output /// is different, true is returned. If there is a problem with the code /// generator (e.g., llc crashes), this will throw an exception. /// - bool diffProgram(const std::string &BytecodeFile = "", + bool diffProgram(const std::string &BitcodeFile = "", const std::string &SharedObj = "", - bool RemoveBytecode = false); - /// EmitProgressBytecode - This function is used to output the current Program + bool RemoveBitcode = false); + + /// EmitProgressBitcode - This function is used to output the current Program /// to a file named "bugpoint-ID.bc". /// - void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false); + void EmitProgressBitcode(const std::string &ID, bool NoFlyer = false); /// deleteInstructionFromProgram - This method clones the current Program and /// deletes the specified instruction from the cloned module. It then runs a @@ -183,29 +226,52 @@ public: /// program or if the loop extractor crashes. Module *ExtractLoop(Module *M); -private: - /// ParseInputFile - Given a bytecode or assembly input filename, parse and - /// return it, or return null if not possible. - /// - Module *ParseInputFile(const std::string &InputFilename) const; - - /// writeProgramToFile - This writes the current "Program" to the named - /// bytecode file. If an error occurs, true is returned. - /// - bool writeProgramToFile(const std::string &Filename, Module *M = 0) const; - - /// runPasses - Run the specified passes on Program, outputting a bytecode + /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks + /// into their own functions. The only detail is that M is actually a module + /// cloned from the one the BBs are in, so some mapping needs to be performed. + /// If this operation fails for some reason (ie the implementation is buggy), + /// this function should return null, otherwise it returns a new Module. + Module *ExtractMappedBlocksFromModule(const std::vector &BBs, + Module *M); + + /// runPassesOn - Carefully run the specified set of pass on the specified + /// module, returning the transformed module on success, or a null pointer on + /// failure. If AutoDebugCrashes is set to true, then bugpoint will + /// automatically attempt to track down a crashing pass if one exists, and + /// this method will never return null. + Module *runPassesOn(Module *M, const std::vector &Passes, + bool AutoDebugCrashes = false, unsigned NumExtraArgs = 0, + const char * const *ExtraArgs = NULL); + + /// runPasses - Run the specified passes on Program, outputting a bitcode /// file and writting 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, unless Quiet is set. + /// outs() a single line message indicating whether compilation was successful + /// or failed, unless Quiet is set. ExtraArgs specifies additional arguments + /// to pass to the child bugpoint instance. /// bool runPasses(const std::vector &PassesToRun, std::string &OutputFilename, bool DeleteOutput = false, - bool Quiet = false) const; + bool Quiet = false, unsigned NumExtraArgs = 0, + const char * const *ExtraArgs = NULL) const; + + /// runManyPasses - Take the specified pass list and create different + /// combinations of passes to compile the program with. Compile the program with + /// each set and mark test to see if it compiled correctly. If the passes + /// compiled correctly output nothing and rearrange the passes into a new order. + /// If the passes did not compile correctly, output the command required to + /// recreate the failure. This returns true if a compiler error is found. + /// + bool runManyPasses(const std::vector &AllPasses); + + /// writeProgramToFile - This writes the current "Program" to the named + /// bitcode file. If an error occurs, true is returned. + /// + bool writeProgramToFile(const std::string &Filename, Module *M = 0) const; +private: /// runPasses - Just like the method above, but this just returns true or /// false indicating whether or not the optimizer crashed on the specified /// input (true = crashed). @@ -216,9 +282,8 @@ private: return runPasses(PassesToRun, Filename, DeleteOutput); } - /// PrintFunctionList - prints out list of problematic functions - /// - static void PrintFunctionList(const std::vector &Funcs); + /// runAsChild - The actual "runPasses" guts that runs in a child process. + int runPassesAsChild(const std::vector &PassesToRun); /// initializeExecutionEnvironment - This method is used to set up the /// environment for executing LLVM programs. @@ -226,11 +291,26 @@ private: bool initializeExecutionEnvironment(); }; +/// ParseInputFile - Given a bitcode or assembly input filename, parse and +/// return it, or return null if not possible. +/// +Module *ParseInputFile(const std::string &InputFilename, + LLVMContext& ctxt); + + /// 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); +/// PrintFunctionList - prints out list of problematic functions +/// +void PrintFunctionList(const std::vector &Funcs); + +/// PrintGlobalVariableList - prints out list of problematic global variables +/// +void PrintGlobalVariableList(const std::vector &GVs); + // DeleteFunctionBody - "Remove" the function by deleting all of it's basic // blocks, making it external. // @@ -239,7 +319,8 @@ void DeleteFunctionBody(Function *F); /// SplitFunctionsOutOfModule - Given a module and a list of functions in the /// module, split the functions OUT of the specified module, and place them in /// the new module. -Module *SplitFunctionsOutOfModule(Module *M, const std::vector &F); +Module *SplitFunctionsOutOfModule(Module *M, const std::vector &F, + DenseMap &ValueMap); } // End llvm namespace