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