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