BugDriver.h revision 866aa0d742b7bc9811fd1b45507af999c605205a
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/ValueMap.h" 20#include <vector> 21#include <string> 22 23namespace llvm { 24 25class Value; 26class PassInfo; 27class Module; 28class GlobalVariable; 29class Function; 30class BasicBlock; 31class AbstractInterpreter; 32class Instruction; 33class LLVMContext; 34 35class DebugCrashes; 36 37class GCC; 38 39extern bool DisableSimplifyCFG; 40 41/// BugpointIsInterrupted - Set to true when the user presses ctrl-c. 42/// 43extern bool BugpointIsInterrupted; 44 45class 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<std::string> PassesToRun; 51 AbstractInterpreter *Interpreter; // How to run the program 52 AbstractInterpreter *SafeInterpreter; // To generate reference output, etc. 53 GCC *gcc; 54 bool run_find_bugs; 55 unsigned Timeout; 56 unsigned MemoryLimit; 57 bool UseValgrind; 58 59 // FIXME: sort out public/private distinctions... 60 friend class ReducePassList; 61 friend class ReduceMisCodegenFunctions; 62 63public: 64 BugDriver(const char *toolname, bool find_bugs, 65 unsigned timeout, unsigned memlimit, bool use_valgrind, 66 LLVMContext& ctxt); 67 ~BugDriver(); 68 69 const char *getToolName() const { return ToolName; } 70 71 LLVMContext& getContext() const { 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 void addPass(std::string p) { PassesToRun.push_back(p); } 78 void setPassesToRun(const std::vector<std::string> &PTR) { 79 PassesToRun = PTR; 80 } 81 const std::vector<std::string> &getPassesToRun() const { 82 return PassesToRun; 83 } 84 85 /// run - The top level method that is invoked after all of the instance 86 /// variables are set up from command line arguments. The \p as_child argument 87 /// indicates whether the driver is to run in parent mode or child mode. 88 /// 89 bool run(std::string &ErrMsg); 90 91 /// debugOptimizerCrash - This method is called when some optimizer pass 92 /// crashes on input. It attempts to prune down the testcase to something 93 /// reasonable, and figure out exactly which pass is crashing. 94 /// 95 bool debugOptimizerCrash(const std::string &ID = "passes"); 96 97 /// debugCodeGeneratorCrash - This method is called when the code generator 98 /// crashes on an input. It attempts to reduce the input as much as possible 99 /// while still causing the code generator to crash. 100 bool debugCodeGeneratorCrash(std::string &Error); 101 102 /// debugMiscompilation - This method is used when the passes selected are not 103 /// crashing, but the generated output is semantically different from the 104 /// input. 105 void debugMiscompilation(std::string *Error); 106 107 /// debugPassMiscompilation - This method is called when the specified pass 108 /// miscompiles Program as input. It tries to reduce the testcase to 109 /// something that smaller that still miscompiles the program. 110 /// ReferenceOutput contains the filename of the file containing the output we 111 /// are to match. 112 /// 113 bool debugPassMiscompilation(const PassInfo *ThePass, 114 const std::string &ReferenceOutput); 115 116 /// compileSharedObject - This method creates a SharedObject from a given 117 /// BitcodeFile for debugging a code generator. 118 /// 119 std::string compileSharedObject(const std::string &BitcodeFile, 120 std::string &Error); 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(std::string *Error); 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) const { 134 return runPasses(M, PassesToRun); 135 } 136 137 Module *getProgram() const { return Program; } 138 139 /// swapProgramIn - Set the current module to the specified module, returning 140 /// the old one. 141 Module *swapProgramIn(Module *M) { 142 Module *OldProgram = Program; 143 Program = M; 144 return OldProgram; 145 } 146 147 AbstractInterpreter *switchToSafeInterpreter() { 148 AbstractInterpreter *Old = Interpreter; 149 Interpreter = (AbstractInterpreter*)SafeInterpreter; 150 return Old; 151 } 152 153 void switchToInterpreter(AbstractInterpreter *AI) { 154 Interpreter = AI; 155 } 156 157 /// setNewProgram - If we reduce or update the program somehow, call this 158 /// method to update bugdriver with it. This deletes the old module and sets 159 /// the specified one as the current program. 160 void setNewProgram(Module *M); 161 162 /// compileProgram - Try to compile the specified module, returning false and 163 /// setting Error if an error occurs. This is used for code generation 164 /// crash testing. 165 /// 166 void compileProgram(Module *M, std::string *Error) const; 167 168 /// executeProgram - This method runs "Program", capturing the output of the 169 /// program to a file. A recommended filename may be optionally specified. 170 /// 171 std::string executeProgram(const Module *Program, 172 std::string OutputFilename, 173 std::string Bitcode, 174 const std::string &SharedObjects, 175 AbstractInterpreter *AI, 176 std::string *Error) const; 177 178 /// executeProgramSafely - Used to create reference output with the "safe" 179 /// backend, if reference output is not provided. If there is a problem with 180 /// the code generator (e.g., llc crashes), this will return false and set 181 /// Error. 182 /// 183 std::string executeProgramSafely(const Module *Program, 184 std::string OutputFile, 185 std::string *Error) const; 186 187 /// createReferenceFile - calls compileProgram and then records the output 188 /// into ReferenceOutputFile. Returns true if reference file created, false 189 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 190 /// this function. 191 /// 192 bool createReferenceFile(Module *M, const std::string &Filename 193 = "bugpoint.reference.out"); 194 195 /// diffProgram - This method executes the specified module and diffs the 196 /// output against the file specified by ReferenceOutputFile. If the output 197 /// is different, 1 is returned. If there is a problem with the code 198 /// generator (e.g., llc crashes), this will return -1 and set Error. 199 /// 200 bool diffProgram(const Module *Program, 201 const std::string &BitcodeFile = "", 202 const std::string &SharedObj = "", 203 bool RemoveBitcode = false, 204 std::string *Error = 0) const; 205 206 /// EmitProgressBitcode - This function is used to output M to a file named 207 /// "bugpoint-ID.bc". 208 /// 209 void EmitProgressBitcode(const Module *M, const std::string &ID, 210 bool NoFlyer = false) const; 211 212 /// deleteInstructionFromProgram - This method clones the current Program and 213 /// deletes the specified instruction from the cloned module. It then runs a 214 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code 215 /// which depends on the value. The modified module is then returned. 216 /// 217 Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp); 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<std::string> &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(Module *Program, 258 const std::vector<std::string> &PassesToRun, 259 std::string &OutputFilename, bool DeleteOutput = false, 260 bool Quiet = false, unsigned NumExtraArgs = 0, 261 const char * const *ExtraArgs = NULL) const; 262 263 /// runManyPasses - Take the specified pass list and create different 264 /// combinations of passes to compile the program with. Compile the program with 265 /// each set and mark test to see if it compiled correctly. If the passes 266 /// compiled correctly output nothing and rearrange the passes into a new order. 267 /// If the passes did not compile correctly, output the command required to 268 /// recreate the failure. This returns true if a compiler error is found. 269 /// 270 bool runManyPasses(const std::vector<std::string> &AllPasses, 271 std::string &ErrMsg); 272 273 /// writeProgramToFile - This writes the current "Program" to the named 274 /// bitcode file. If an error occurs, true is returned. 275 /// 276 bool writeProgramToFile(const std::string &Filename, const Module *M) const; 277 278private: 279 /// runPasses - Just like the method above, but this just returns true or 280 /// false indicating whether or not the optimizer crashed on the specified 281 /// input (true = crashed). 282 /// 283 bool runPasses(Module *M, 284 const std::vector<std::string> &PassesToRun, 285 bool DeleteOutput = true) const { 286 std::string Filename; 287 return runPasses(M, PassesToRun, Filename, DeleteOutput); 288 } 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/// 299Module *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/// 306std::string getPassesString(const std::vector<std::string> &Passes); 307 308/// PrintFunctionList - prints out list of problematic functions 309/// 310void PrintFunctionList(const std::vector<Function*> &Funcs); 311 312/// PrintGlobalVariableList - prints out list of problematic global variables 313/// 314void 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// 319void 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. 324Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F, 325 ValueMap<const Value*, Value*> &VMap); 326 327} // End llvm namespace 328 329#endif 330