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