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