//===- 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 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
#include <vector>
#include <string>
+
class PassInfo;
class Module;
class Function;
+class AbstractInterpreter;
+class Instruction;
+
+class DebugCrashes;
+class ReduceMiscompilingPasses;
+class ReduceMiscompilingFunctions;
+class ReduceCrashingFunctions;
+class ReduceCrashingBlocks;
+
+class CBE;
+class GCC;
+
+extern bool DisableSimplifyCFG;
class BugDriver {
const std::string ToolName; // Name of bugpoint
+ std::string ReferenceOutputFile; // Name of `good' output file
Module *Program; // The raw program, linked together
std::vector<const PassInfo*> PassesToRun;
+ AbstractInterpreter *Interpreter; // How to run the program
+ CBE *cbe;
+ GCC *gcc;
+
+ // FIXME: sort out public/private distinctions...
+ friend class DebugCrashes;
+ friend class ReduceMiscompilingPasses;
+ friend class ReduceMiscompilingFunctions;
+ friend class ReduceMisCodegenFunctions;
+ friend class ReduceCrashingFunctions;
+ friend class ReduceCrashingBlocks;
+
public:
- BugDriver(const char *toolname) : ToolName(toolname), Program(0) {}
+ BugDriver(const char *toolname);
+
+ const std::string &getToolName() const { return ToolName; }
// Set up methods... these methods are used to copy information about the
// command line arguments into instance variables of BugDriver.
bool addSources(const std::vector<std::string> &FileNames);
template<class It>
void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
+ void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
+ PassesToRun = PTR;
+ }
/// run - The top level method that is invoked after all of the instance
/// variables are set up from command line arguments.
///
bool debugCrash();
- /// debugPassCrash - This method is called when the specified pass crashes on
- /// Program as input. It tries to reduce the testcase to something that still
- /// crashes, but it smaller.
- ///
- bool debugPassCrash(const PassInfo *PI);
-
/// debugMiscompilation - This method is used when the passes selected are not
/// crashing, but the generated output is semantically different from the
/// input.
bool debugMiscompilation();
+ /// debugPassMiscompilation - This method is called when the specified pass
+ /// miscompiles Program as input. It tries to reduce the testcase to
+ /// something that smaller that still miscompiles the program.
+ /// ReferenceOutput contains the filename of the file containing the output we
+ /// are to match.
+ ///
+ bool debugPassMiscompilation(const PassInfo *ThePass,
+ const std::string &ReferenceOutput);
+
+ /// compileSharedObject - This method creates a SharedObject from a given
+ /// BytecodeFile for debugging a code generator.
+ ///
+ std::string compileSharedObject(const std::string &BytecodeFile);
+
+ /// debugCodeGenerator - This method narrows down a module to a function or
+ /// set of functions, using the CBE as a ``safe'' code generator for other
+ /// functions that are not under consideration.
+ bool debugCodeGenerator();
+
+ /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
+ ///
+ bool isExecutingJIT();
+
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;
- /// removeFile - Delete the specified file
- ///
- void removeFile(const std::string &Filename) 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) const;
+ bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
/// EmitProgressBytecode - This function is used to output the current Program
/// to a file named "bugpoing-ID.bc".
///
- void EmitProgressBytecode(const PassInfo *Pass, const std::string &ID);
+ void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false);
/// runPasses - Run the specified passes on Program, outputting a bytecode
/// file and writting the filename into OutputFile if successful. If the
/// otherwise return false. If DeleteOutput is set to true, the bytecode 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.
+ /// or failed, unless Quiet is set.
///
bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
- std::string &OutputFilename, bool DeleteOutput = false) const;
+ std::string &OutputFilename, bool DeleteOutput = false,
+ bool Quiet = false) const;
/// runPasses - Just like the method above, but this just returns true or
/// false indicating whether or not the optimizer crashed on the specified
return runPasses(PassesToRun, Filename, DeleteOutput);
}
- /// runPass - Run only the specified pass on the program.
- bool runPass(const PassInfo *P, bool DeleteOutput = true) const {
- return runPasses(std::vector<const PassInfo*>(1, P), DeleteOutput);
+ /// PrintFunctionList - prints out list of problematic functions
+ ///
+ static void PrintFunctionList(const std::vector<Function*> &Funcs);
+
+ /// deleteInstructionFromProgram - This method clones the current Program and
+ /// deletes the specified instruction from the cloned module. It then runs a
+ /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
+ /// which depends on the value. The modified module is then returned.
+ ///
+ Module *deleteInstructionFromProgram(Instruction *I, unsigned Simp) const;
+
+ /// performFinalCleanups - This method clones the current Program and performs
+ /// a series of cleanups intended to get rid of extra cruft on the module
+ /// before handing it to the user... if the module parameter is specified, it
+ /// operates directly on the specified Module, modifying it in place.
+ ///
+ Module *performFinalCleanups(Module *M = 0) const;
+
+ /// initializeExecutionEnvironment - This method is used to set up the
+ /// environment for executing LLVM programs.
+ ///
+ bool initializeExecutionEnvironment();
+
+ /// executeProgram - This method runs "Program", capturing the output of the
+ /// program to a file, returning the filename of the file. A recommended
+ /// filename may be optionally specified.
+ ///
+ std::string executeProgram(std::string RequestedOutputFilename = "",
+ std::string Bytecode = "",
+ const std::string &SharedObjects = "",
+ AbstractInterpreter *AI = 0);
+
+ /// executeProgramWithCBE - Used to create reference output with the C
+ /// backend, if reference output is not provided.
+ ///
+ std::string executeProgramWithCBE(std::string OutputFile = "",
+ std::string BytecodeFile = "",
+ const std::string &SharedObj = "") {
+ return executeProgram(OutputFile, BytecodeFile, SharedObj,
+ (AbstractInterpreter*)cbe);
}
-
- /// extractFunctionFromModule - This method is used to extract the specified
- /// (non-external) function from the current program, slim down the module,
- /// and then return it. This does not modify Program at all, it modifies a
- /// copy, which it returns.
- Module *extractFunctionFromModule(Function *F) const;
+ /// 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.
+ ///
+ bool diffProgram(const std::string &BytecodeFile = "",
+ const std::string &SharedObj = "",
+ bool RemoveBytecode = false);
};
+/// 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<const PassInfo*> &Passes);
+
+// DeleteFunctionBody - "Remove" the function by deleting all of it's basic
+// blocks, making it external.
+//
+void DeleteFunctionBody(Function *F);
+
#endif