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