BugDriver.h revision 7f99f74b7fc298dad4c61c15b064dc951d2b3cbb
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<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_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 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(std::string &ErrMsg); 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(std::string &Error); 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 void debugMiscompilation(std::string *Error); 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 std::string &Error); 122 123 /// debugCodeGenerator - This method narrows down a module to a function or 124 /// set of functions, using the CBE as a ``safe'' code generator for other 125 /// functions that are not under consideration. 126 bool debugCodeGenerator(std::string *Error); 127 128 /// isExecutingJIT - Returns true if bugpoint is currently testing the JIT 129 /// 130 bool isExecutingJIT(); 131 132 /// runPasses - Run all of the passes in the "PassesToRun" list, discard the 133 /// output, and return true if any of the passes crashed. 134 bool runPasses(Module *M) const { 135 return runPasses(M, PassesToRun); 136 } 137 138 Module *getProgram() const { return Program; } 139 140 /// swapProgramIn - Set the current module to the specified module, returning 141 /// the old one. 142 Module *swapProgramIn(Module *M) { 143 Module *OldProgram = Program; 144 Program = M; 145 return OldProgram; 146 } 147 148 AbstractInterpreter *switchToSafeInterpreter() { 149 AbstractInterpreter *Old = Interpreter; 150 Interpreter = (AbstractInterpreter*)SafeInterpreter; 151 return Old; 152 } 153 154 void switchToInterpreter(AbstractInterpreter *AI) { 155 Interpreter = AI; 156 } 157 158 /// setNewProgram - If we reduce or update the program somehow, call this 159 /// method to update bugdriver with it. This deletes the old module and sets 160 /// the specified one as the current program. 161 void setNewProgram(Module *M); 162 163 /// compileProgram - Try to compile the specified module, returning false and 164 /// setting Error if an error occurs. This is used for code generation 165 /// crash testing. 166 /// 167 void compileProgram(Module *M, std::string *Error) const; 168 169 /// executeProgram - This method runs "Program", capturing the output of the 170 /// program to a file. A recommended filename may be optionally specified. 171 /// 172 std::string executeProgram(const Module *Program, 173 std::string OutputFilename, 174 std::string Bitcode, 175 const std::string &SharedObjects, 176 AbstractInterpreter *AI, 177 std::string *Error) const; 178 179 /// executeProgramSafely - Used to create reference output with the "safe" 180 /// backend, if reference output is not provided. If there is a problem with 181 /// the code generator (e.g., llc crashes), this will return false and set 182 /// Error. 183 /// 184 std::string executeProgramSafely(const Module *Program, 185 std::string OutputFile, 186 std::string *Error) const; 187 188 /// createReferenceFile - calls compileProgram and then records the output 189 /// into ReferenceOutputFile. Returns true if reference file created, false 190 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 191 /// this function. 192 /// 193 bool createReferenceFile(Module *M, const std::string &Filename 194 = "bugpoint.reference.out"); 195 196 /// diffProgram - This method executes the specified module and diffs the 197 /// output against the file specified by ReferenceOutputFile. If the output 198 /// is different, 1 is returned. If there is a problem with the code 199 /// generator (e.g., llc crashes), this will return -1 and set Error. 200 /// 201 bool diffProgram(const Module *Program, 202 const std::string &BitcodeFile = "", 203 const std::string &SharedObj = "", 204 bool RemoveBitcode = false, 205 std::string *Error = 0) const; 206 207 /// EmitProgressBitcode - This function is used to output M to a file named 208 /// "bugpoint-ID.bc". 209 /// 210 void EmitProgressBitcode(const Module *M, const std::string &ID, 211 bool NoFlyer = false) const; 212 213 /// deleteInstructionFromProgram - This method clones the current Program and 214 /// deletes the specified instruction from the cloned module. It then runs a 215 /// series of cleanup passes (ADCE and SimplifyCFG) to eliminate any code 216 /// which depends on the value. The modified module is then returned. 217 /// 218 Module *deleteInstructionFromProgram(const Instruction *I, unsigned Simp) 219 const; 220 221 /// performFinalCleanups - This method clones the current Program and performs 222 /// a series of cleanups intended to get rid of extra cruft on the module. If 223 /// the MayModifySemantics argument is true, then the cleanups is allowed to 224 /// modify how the code behaves. 225 /// 226 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false); 227 228 /// ExtractLoop - Given a module, extract up to one loop from it into a new 229 /// function. This returns null if there are no extractable loops in the 230 /// program or if the loop extractor crashes. 231 Module *ExtractLoop(Module *M); 232 233 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks 234 /// into their own functions. The only detail is that M is actually a module 235 /// cloned from the one the BBs are in, so some mapping needs to be performed. 236 /// If this operation fails for some reason (ie the implementation is buggy), 237 /// this function should return null, otherwise it returns a new Module. 238 Module *ExtractMappedBlocksFromModule(const std::vector<BasicBlock*> &BBs, 239 Module *M); 240 241 /// runPassesOn - Carefully run the specified set of pass on the specified 242 /// module, returning the transformed module on success, or a null pointer on 243 /// failure. If AutoDebugCrashes is set to true, then bugpoint will 244 /// automatically attempt to track down a crashing pass if one exists, and 245 /// this method will never return null. 246 Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes, 247 bool AutoDebugCrashes = false, unsigned NumExtraArgs = 0, 248 const char * const *ExtraArgs = NULL); 249 250 /// runPasses - Run the specified passes on Program, outputting a bitcode 251 /// file and writting the filename into OutputFile if successful. If the 252 /// optimizations fail for some reason (optimizer crashes), return true, 253 /// otherwise return false. If DeleteOutput is set to true, the bitcode is 254 /// deleted on success, and the filename string is undefined. This prints to 255 /// outs() a single line message indicating whether compilation was successful 256 /// or failed, unless Quiet is set. ExtraArgs specifies additional arguments 257 /// to pass to the child bugpoint instance. 258 /// 259 bool runPasses(Module *Program, 260 const std::vector<const PassInfo*> &PassesToRun, 261 std::string &OutputFilename, bool DeleteOutput = false, 262 bool Quiet = false, unsigned NumExtraArgs = 0, 263 const char * const *ExtraArgs = NULL) const; 264 265 /// runManyPasses - Take the specified pass list and create different 266 /// combinations of passes to compile the program with. Compile the program with 267 /// each set and mark test to see if it compiled correctly. If the passes 268 /// compiled correctly output nothing and rearrange the passes into a new order. 269 /// If the passes did not compile correctly, output the command required to 270 /// recreate the failure. This returns true if a compiler error is found. 271 /// 272 bool runManyPasses(const std::vector<const PassInfo*> &AllPasses, 273 std::string &ErrMsg); 274 275 /// writeProgramToFile - This writes the current "Program" to the named 276 /// bitcode file. If an error occurs, true is returned. 277 /// 278 bool writeProgramToFile(const std::string &Filename, const Module *M) const; 279 280private: 281 /// runPasses - Just like the method above, but this just returns true or 282 /// false indicating whether or not the optimizer crashed on the specified 283 /// input (true = crashed). 284 /// 285 bool runPasses(Module *M, 286 const std::vector<const PassInfo*> &PassesToRun, 287 bool DeleteOutput = true) const { 288 std::string Filename; 289 return runPasses(M, PassesToRun, Filename, DeleteOutput); 290 } 291 292 /// initializeExecutionEnvironment - This method is used to set up the 293 /// environment for executing LLVM programs. 294 /// 295 bool initializeExecutionEnvironment(); 296}; 297 298/// ParseInputFile - Given a bitcode or assembly input filename, parse and 299/// return it, or return null if not possible. 300/// 301Module *ParseInputFile(const std::string &InputFilename, 302 LLVMContext& ctxt); 303 304 305/// getPassesString - Turn a list of passes into a string which indicates the 306/// command line options that must be passed to add the passes. 307/// 308std::string getPassesString(const std::vector<const PassInfo*> &Passes); 309 310/// PrintFunctionList - prints out list of problematic functions 311/// 312void PrintFunctionList(const std::vector<Function*> &Funcs); 313 314/// PrintGlobalVariableList - prints out list of problematic global variables 315/// 316void PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs); 317 318// DeleteFunctionBody - "Remove" the function by deleting all of it's basic 319// blocks, making it external. 320// 321void DeleteFunctionBody(Function *F); 322 323/// SplitFunctionsOutOfModule - Given a module and a list of functions in the 324/// module, split the functions OUT of the specified module, and place them in 325/// the new module. 326Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F, 327 ValueMap<const Value*, Value*> &VMap); 328 329} // End llvm namespace 330 331#endif 332