tools/bugpoint/BugDriver.h

   1 //===- BugDriver.h - Top-Level BugPoint class -------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This class contains all of the shared state and information that is used by
  11 // the BugPoint tool to track down errors in optimizations.  This class is the
  12 // main driver class that invokes all sub-functionality.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef BUGDRIVER_H
  17 #define BUGDRIVER_H
  18
  19 #include <vector>
  20 #include <string>
  21
  22 namespace llvm {
  23
  24 class PassInfo;
  25 class Module;
  26 class Function;
  27 class AbstractInterpreter;
  28 class Instruction;
  29
  30 class DebugCrashes;
  31 class ReduceMiscompilingPasses;
  32 class ReduceMiscompilingFunctions;
  33
  34 class CBE;
  35 class GCC;
  36
  37 extern bool DisableSimplifyCFG;
  38
  39 class BugDriver {
  40   const std::string ToolName;  // Name of bugpoint
  41   std::string ReferenceOutputFile; // Name of `good' output file
  42   Module *Program;             // The raw program, linked together
  43   std::vector<const PassInfo*> PassesToRun;
  44   AbstractInterpreter *Interpreter;   // How to run the program
  45   CBE *cbe;
  46   GCC *gcc;
  47
  48   // FIXME: sort out public/private distinctions...
  49   friend class ReducePassList;
  50   friend class ReduceMiscompilingPasses;
  51   friend class ReduceMiscompilingFunctions;
  52   friend class ReduceMisCodegenFunctions;
  53
  54 public:
  55   BugDriver(const char *toolname);
  56
  57   const std::string &getToolName() const { return ToolName; }
  58
  59   // Set up methods... these methods are used to copy information about the
  60   // command line arguments into instance variables of BugDriver.
  61   //
  62   bool addSources(const std::vector<std::string> &FileNames);
  63   template<class It>
  64   void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
  65   void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
  66     PassesToRun = PTR;
  67   }
  68
  69   /// run - The top level method that is invoked after all of the instance
  70   /// variables are set up from command line arguments.
  71   ///
  72   bool run();
  73
  74   /// debugOptimizerCrash - This method is called when some optimizer pass
  75   /// crashes on input.  It attempts to prune down the testcase to something
  76   /// reasonable, and figure out exactly which pass is crashing.
  77   ///
  78   bool debugOptimizerCrash();
  79
  80   /// debugCodeGeneratorCrash - This method is called when the code generator
  81   /// crashes on an input.  It attempts to reduce the input as much as possible
  82   /// while still causing the code generator to crash.
  83   bool debugCodeGeneratorCrash();
  84
  85   /// debugMiscompilation - This method is used when the passes selected are not
  86   /// crashing, but the generated output is semantically different from the
  87   /// input.
  88   bool debugMiscompilation();
  89
  90   /// debugPassMiscompilation - This method is called when the specified pass
  91   /// miscompiles Program as input.  It tries to reduce the testcase to
  92   /// something that smaller that still miscompiles the program.
  93   /// ReferenceOutput contains the filename of the file containing the output we
  94   /// are to match.
  95   ///
  96   bool debugPassMiscompilation(const PassInfo *ThePass,
  97                                const std::string &ReferenceOutput);
  98
  99   /// compileSharedObject - This method creates a SharedObject from a given
 100   /// BytecodeFile for debugging a code generator.
 101   ///
 102   std::string compileSharedObject(const std::string &BytecodeFile);
 103
 104   /// debugCodeGenerator - This method narrows down a module to a function or
 105   /// set of functions, using the CBE as a ``safe'' code generator for other
 106   /// functions that are not under consideration.
 107   bool debugCodeGenerator();
 108
 109   /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
 110   ///
 111   bool isExecutingJIT();
 112
 113   /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
 114   /// output, and return true if any of the passes crashed.
 115   bool runPasses(Module *M = 0) {
 116     if (M == 0) M = Program;
 117     std::swap(M, Program);
 118     bool Result = runPasses(PassesToRun);
 119     std::swap(M, Program);
 120     return Result;
 121   }
 122
 123   const Module *getProgram() const { return Program; }
 124
 125   /// setNewProgram - If we reduce or update the program somehow, call this
 126   /// method to update bugdriver with it.  This deletes the old module and sets
 127   /// the specified one as the current program.
 128   void setNewProgram(Module *M);
 129
 130   /// compileProgram - Try to compile the specified module, throwing an
 131   /// exception if an error occurs, or returning normally if not.  This is used
 132   /// for code generation crash testing.
 133   ///
 134   void compileProgram(Module *M);
 135
 136   /// executeProgram - This method runs "Program", capturing the output of the
 137   /// program to a file, returning the filename of the file.  A recommended
 138   /// filename may be optionally specified.  If there is a problem with the code
 139   /// generator (e.g., llc crashes), this will throw an exception.
 140   ///
 141   std::string executeProgram(std::string RequestedOutputFilename = "",
 142                              std::string Bytecode = "",
 143                              const std::string &SharedObjects = "",
 144                              AbstractInterpreter *AI = 0,
 145                              bool *ProgramExitedNonzero = 0);
 146
 147   /// executeProgramWithCBE - Used to create reference output with the C
 148   /// backend, if reference output is not provided.  If there is a problem with
 149   /// the code generator (e.g., llc crashes), this will throw an exception.
 150   ///
 151   std::string executeProgramWithCBE(std::string OutputFile = "");
 152
 153   /// diffProgram - This method executes the specified module and diffs the
 154   /// output against the file specified by ReferenceOutputFile.  If the output
 155   /// is different, true is returned.  If there is a problem with the code
 156   /// generator (e.g., llc crashes), this will throw an exception.
 157   ///
 158   bool diffProgram(const std::string &BytecodeFile = "",
 159                    const std::string &SharedObj = "",
 160                    bool RemoveBytecode = false);
 161   /// EmitProgressBytecode - This function is used to output the current Program
 162   /// to a file named "bugpoint-ID.bc".
 163   ///
 164   void EmitProgressBytecode(const std::string &ID, bool NoFlyer = false);
 165
 166   /// deleteInstructionFromProgram - This method clones the current Program and
 167   /// deletes the specified instruction from the cloned module.  It then runs a
 168   /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
 169   /// which depends on the value.  The modified module is then returned.
 170   ///
 171   Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp)
 172     const;
 173
 174   /// performFinalCleanups - This method clones the current Program and performs
 175   /// a series of cleanups intended to get rid of extra cruft on the module.  If
 176   /// the MayModifySemantics argument is true, then the cleanups is allowed to
 177   /// modify how the code behaves.
 178   ///
 179   Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
 180
 181   /// ExtractLoop - Given a module, extract up to one loop from it into a new
 182   /// function.  This returns null if there are no extractable loops in the
 183   /// program or if the loop extractor crashes.
 184   Module *ExtractLoop(Module *M);
 185
 186 private:
 187   /// ParseInputFile - Given a bytecode or assembly input filename, parse and
 188   /// return it, or return null if not possible.
 189   ///
 190   Module *ParseInputFile(const std::string &InputFilename) const;
 191
 192   /// writeProgramToFile - This writes the current "Program" to the named
 193   /// bytecode file.  If an error occurs, true is returned.
 194   ///
 195   bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
 196
 197   /// runPasses - Run the specified passes on Program, outputting a bytecode
 198   /// file and writting the filename into OutputFile if successful.  If the
 199   /// optimizations fail for some reason (optimizer crashes), return true,
 200   /// otherwise return false.  If DeleteOutput is set to true, the bytecode is
 201   /// deleted on success, and the filename string is undefined.  This prints to
 202   /// cout a single line message indicating whether compilation was successful
 203   /// or failed, unless Quiet is set.
 204   ///
 205   bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
 206                  std::string &OutputFilename, bool DeleteOutput = false,
 207                  bool Quiet = false) const;
 208
 209   /// runPasses - Just like the method above, but this just returns true or
 210   /// false indicating whether or not the optimizer crashed on the specified
 211   /// input (true = crashed).
 212   ///
 213   bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
 214                  bool DeleteOutput = true) const {
 215     std::string Filename;
 216     return runPasses(PassesToRun, Filename, DeleteOutput);
 217   }
 218
 219   /// PrintFunctionList - prints out list of problematic functions
 220   ///
 221   static void PrintFunctionList(const std::vector<Function*> &Funcs);
 222
 223   /// initializeExecutionEnvironment - This method is used to set up the
 224   /// environment for executing LLVM programs.
 225   ///
 226   bool initializeExecutionEnvironment();
 227 };
 228
 229 /// getPassesString - Turn a list of passes into a string which indicates the
 230 /// command line options that must be passed to add the passes.
 231 ///
 232 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
 233
 234 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
 235 // blocks, making it external.
 236 //
 237 void DeleteFunctionBody(Function *F);
 238
 239 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
 240 /// module, split the functions OUT of the specified module, and place them in
 241 /// the new module.
 242 Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F);
 243
 244 } // End llvm namespace
 245
 246 #endif