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