tools/bugpoint/BugDriver.h

   1 //===- BugDriver.h - Top-Level BugPoint class -------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 GlobalVariable;
  27 class Function;
  28 class BasicBlock;
  29 class AbstractInterpreter;
  30 class Instruction;
  31
  32 class DebugCrashes;
  33
  34 class GCC;
  35
  36 extern bool DisableSimplifyCFG;
  37
  38 /// BugpointIsInterrupted - Set to true when the user presses ctrl-c.
  39 ///
  40 extern bool BugpointIsInterrupted;
  41
  42 class BugDriver {
  43   const std::string ToolName;  // Name of bugpoint
  44   std::string ReferenceOutputFile; // Name of `good' output file
  45   Module *Program;             // The raw program, linked together
  46   std::vector<const PassInfo*> PassesToRun;
  47   AbstractInterpreter *Interpreter;   // How to run the program
  48   AbstractInterpreter *SafeInterpreter;  // To generate reference output, etc.
  49   GCC *gcc;
  50   bool run_as_child;
  51   bool run_find_bugs;
  52   unsigned Timeout;
  53   unsigned MemoryLimit;
  54
  55   // FIXME: sort out public/private distinctions...
  56   friend class ReducePassList;
  57   friend class ReduceMisCodegenFunctions;
  58
  59 public:
  60   BugDriver(const char *toolname, bool as_child, bool find_bugs,
  61             unsigned timeout, unsigned memlimit);
  62
  63   const std::string &getToolName() const { return ToolName; }
  64
  65   // Set up methods... these methods are used to copy information about the
  66   // command line arguments into instance variables of BugDriver.
  67   //
  68   bool addSources(const std::vector<std::string> &FileNames);
  69   template<class It>
  70   void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); }
  71   void setPassesToRun(const std::vector<const PassInfo*> &PTR) {
  72     PassesToRun = PTR;
  73   }
  74   const std::vector<const PassInfo*> &getPassesToRun() const {
  75     return PassesToRun;
  76   }
  77
  78   /// run - The top level method that is invoked after all of the instance
  79   /// variables are set up from command line arguments. The \p as_child argument
  80   /// indicates whether the driver is to run in parent mode or child mode.
  81   ///
  82   bool run();
  83
  84   /// debugOptimizerCrash - This method is called when some optimizer pass
  85   /// crashes on input.  It attempts to prune down the testcase to something
  86   /// reasonable, and figure out exactly which pass is crashing.
  87   ///
  88   bool debugOptimizerCrash(const std::string &ID = "passes");
  89
  90   /// debugCodeGeneratorCrash - This method is called when the code generator
  91   /// crashes on an input.  It attempts to reduce the input as much as possible
  92   /// while still causing the code generator to crash.
  93   bool debugCodeGeneratorCrash();
  94
  95   /// debugMiscompilation - This method is used when the passes selected are not
  96   /// crashing, but the generated output is semantically different from the
  97   /// input.
  98   bool debugMiscompilation();
  99
 100   /// debugPassMiscompilation - This method is called when the specified pass
 101   /// miscompiles Program as input.  It tries to reduce the testcase to
 102   /// something that smaller that still miscompiles the program.
 103   /// ReferenceOutput contains the filename of the file containing the output we
 104   /// are to match.
 105   ///
 106   bool debugPassMiscompilation(const PassInfo *ThePass,
 107                                const std::string &ReferenceOutput);
 108
 109   /// compileSharedObject - This method creates a SharedObject from a given
 110   /// BitcodeFile for debugging a code generator.
 111   ///
 112   std::string compileSharedObject(const std::string &BitcodeFile);
 113
 114   /// debugCodeGenerator - This method narrows down a module to a function or
 115   /// set of functions, using the CBE as a ``safe'' code generator for other
 116   /// functions that are not under consideration.
 117   bool debugCodeGenerator();
 118
 119   /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT
 120   ///
 121   bool isExecutingJIT();
 122
 123   /// runPasses - Run all of the passes in the "PassesToRun" list, discard the
 124   /// output, and return true if any of the passes crashed.
 125   bool runPasses(Module *M = 0) {
 126     if (M == 0) M = Program;
 127     std::swap(M, Program);
 128     bool Result = runPasses(PassesToRun);
 129     std::swap(M, Program);
 130     return Result;
 131   }
 132
 133   Module *getProgram() const { return Program; }
 134
 135   /// swapProgramIn - Set the current module to the specified module, returning
 136   /// the old one.
 137   Module *swapProgramIn(Module *M) {
 138     Module *OldProgram = Program;
 139     Program = M;
 140     return OldProgram;
 141   }
 142
 143   AbstractInterpreter *switchToSafeInterpreter() {
 144     AbstractInterpreter *Old = Interpreter;
 145     Interpreter = (AbstractInterpreter*)SafeInterpreter;
 146     return Old;
 147   }
 148
 149   void switchToInterpreter(AbstractInterpreter *AI) {
 150     Interpreter = AI;
 151   }
 152
 153   /// setNewProgram - If we reduce or update the program somehow, call this
 154   /// method to update bugdriver with it.  This deletes the old module and sets
 155   /// the specified one as the current program.
 156   void setNewProgram(Module *M);
 157
 158   /// compileProgram - Try to compile the specified module, throwing an
 159   /// exception if an error occurs, or returning normally if not.  This is used
 160   /// for code generation crash testing.
 161   ///
 162   void compileProgram(Module *M);
 163
 164   /// executeProgram - This method runs "Program", capturing the output of the
 165   /// program to a file, returning the filename of the file.  A recommended
 166   /// filename may be optionally specified.  If there is a problem with the code
 167   /// generator (e.g., llc crashes), this will throw an exception.
 168   ///
 169   std::string executeProgram(std::string RequestedOutputFilename = "",
 170                              std::string Bitcode = "",
 171                              const std::string &SharedObjects = "",
 172                              AbstractInterpreter *AI = 0,
 173                              bool *ProgramExitedNonzero = 0);
 174
 175   /// executeProgramSafely - Used to create reference output with the "safe"
 176   /// backend, if reference output is not provided.  If there is a problem with
 177   /// the code generator (e.g., llc crashes), this will throw an exception.
 178   ///
 179   std::string executeProgramSafely(std::string OutputFile = "");
 180
 181   /// createReferenceFile - calls compileProgram and then records the output
 182   /// into ReferenceOutputFile. Returns true if reference file created, false
 183   /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE
 184   /// this function.
 185   ///
 186   bool createReferenceFile(Module *M, const std::string &Filename
 187                                             = "bugpoint.reference.out");
 188
 189   /// diffProgram - This method executes the specified module and diffs the
 190   /// output against the file specified by ReferenceOutputFile.  If the output
 191   /// is different, true is returned.  If there is a problem with the code
 192   /// generator (e.g., llc crashes), this will throw an exception.
 193   ///
 194   bool diffProgram(const std::string &BitcodeFile = "",
 195                    const std::string &SharedObj = "",
 196                    bool RemoveBitcode = false);
 197
 198   /// EmitProgressBitcode - This function is used to output the current Program
 199   /// to a file named "bugpoint-ID.bc".
 200   ///
 201   void EmitProgressBitcode(const std::string &ID, bool NoFlyer = false);
 202
 203   /// deleteInstructionFromProgram - This method clones the current Program and
 204   /// deletes the specified instruction from the cloned module.  It then runs a
 205   /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code
 206   /// which depends on the value.  The modified module is then returned.
 207   ///
 208   Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp)
 209     const;
 210
 211   /// performFinalCleanups - This method clones the current Program and performs
 212   /// a series of cleanups intended to get rid of extra cruft on the module.  If
 213   /// the MayModifySemantics argument is true, then the cleanups is allowed to
 214   /// modify how the code behaves.
 215   ///
 216   Module *performFinalCleanups(Module *M, bool MayModifySemantics = false);
 217
 218   /// ExtractLoop - Given a module, extract up to one loop from it into a new
 219   /// function.  This returns null if there are no extractable loops in the
 220   /// program or if the loop extractor crashes.
 221   Module *ExtractLoop(Module *M);
 222
 223   /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks
 224   /// into their own functions.  The only detail is that M is actually a module
 225   /// cloned from the one the BBs are in, so some mapping needs to be performed.
 226   /// If this operation fails for some reason (ie the implementation is buggy),
 227   /// this function should return null, otherwise it returns a new Module.
 228   Module *ExtractMappedBlocksFromModule(const std::vector<BasicBlock*> &BBs,
 229                                         Module *M);
 230
 231   /// runPassesOn - Carefully run the specified set of pass on the specified
 232   /// module, returning the transformed module on success, or a null pointer on
 233   /// failure.  If AutoDebugCrashes is set to true, then bugpoint will
 234   /// automatically attempt to track down a crashing pass if one exists, and
 235   /// this method will never return null.
 236   Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes,
 237                       bool AutoDebugCrashes = false, unsigned NumExtraArgs = 0,
 238                       const char * const *ExtraArgs = NULL);
 239
 240   /// runPasses - Run the specified passes on Program, outputting a bitcode
 241   /// file and writting the filename into OutputFile if successful.  If the
 242   /// optimizations fail for some reason (optimizer crashes), return true,
 243   /// otherwise return false.  If DeleteOutput is set to true, the bitcode is
 244   /// deleted on success, and the filename string is undefined.  This prints to
 245   /// cout a single line message indicating whether compilation was successful
 246   /// or failed, unless Quiet is set.  ExtraArgs specifies additional arguments
 247   /// to pass to the child bugpoint instance.
 248   ///
 249   bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
 250                  std::string &OutputFilename, bool DeleteOutput = false,
 251                  bool Quiet = false, unsigned NumExtraArgs = 0,
 252                  const char * const *ExtraArgs = NULL) const;
 253
 254   /// runManyPasses - Take the specified pass list and create different
 255   /// combinations of passes to compile the program with. Compile the program with
 256   /// each set and mark test to see if it compiled correctly. If the passes
 257   /// compiled correctly output nothing and rearrange the passes into a new order.
 258   /// If the passes did not compile correctly, output the command required to
 259   /// recreate the failure. This returns true if a compiler error is found.
 260   ///
 261   bool runManyPasses(const std::vector<const PassInfo*> &AllPasses);
 262
 263   /// writeProgramToFile - This writes the current "Program" to the named
 264   /// bitcode file.  If an error occurs, true is returned.
 265   ///
 266   bool writeProgramToFile(const std::string &Filename, Module *M = 0) const;
 267
 268 private:
 269   /// runPasses - Just like the method above, but this just returns true or
 270   /// false indicating whether or not the optimizer crashed on the specified
 271   /// input (true = crashed).
 272   ///
 273   bool runPasses(const std::vector<const PassInfo*> &PassesToRun,
 274                  bool DeleteOutput = true) const {
 275     std::string Filename;
 276     return runPasses(PassesToRun, Filename, DeleteOutput);
 277   }
 278
 279   /// runAsChild - The actual "runPasses" guts that runs in a child process.
 280   int runPassesAsChild(const std::vector<const PassInfo*> &PassesToRun);
 281
 282   /// initializeExecutionEnvironment - This method is used to set up the
 283   /// environment for executing LLVM programs.
 284   ///
 285   bool initializeExecutionEnvironment();
 286 };
 287
 288 /// ParseInputFile - Given a bitcode or assembly input filename, parse and
 289 /// return it, or return null if not possible.
 290 ///
 291 Module *ParseInputFile(const std::string &InputFilename);
 292
 293
 294 /// getPassesString - Turn a list of passes into a string which indicates the
 295 /// command line options that must be passed to add the passes.
 296 ///
 297 std::string getPassesString(const std::vector<const PassInfo*> &Passes);
 298
 299 /// PrintFunctionList - prints out list of problematic functions
 300 ///
 301 void PrintFunctionList(const std::vector<Function*> &Funcs);
 302
 303 /// PrintGlobalVariableList - prints out list of problematic global variables
 304 ///
 305 void PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs);
 306
 307 // DeleteFunctionBody - "Remove" the function by deleting all of it's basic
 308 // blocks, making it external.
 309 //
 310 void DeleteFunctionBody(Function *F);
 311
 312 /// SplitFunctionsOutOfModule - Given a module and a list of functions in the
 313 /// module, split the functions OUT of the specified module, and place them in
 314 /// the new module.
 315 Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F);
 316
 317 } // End llvm namespace
 318
 319 #endif