BugDriver.h revision c1dc0679706f7538cd17169b920967c54661e5b6
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/DenseMap.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_as_child; 55 bool run_find_bugs; 56 unsigned Timeout; 57 unsigned MemoryLimit; 58 bool UseValgrind; 59 60 // FIXME: sort out public/private distinctions... 61 friend class ReducePassList; 62 friend class ReduceMisCodegenFunctions; 63 64public: 65 BugDriver(const char *toolname, bool as_child, bool find_bugs, 66 unsigned timeout, unsigned memlimit, bool use_valgrind, 67 LLVMContext& ctxt); 68 ~BugDriver(); 69 70 const char *getToolName() const { return ToolName; } 71 72 LLVMContext& getContext() { return Context; } 73 74 // Set up methods... these methods are used to copy information about the 75 // command line arguments into instance variables of BugDriver. 76 // 77 bool addSources(const std::vector<std::string> &FileNames); 78 template<class It> 79 void addPasses(It I, It E) { PassesToRun.insert(PassesToRun.end(), I, E); } 80 void setPassesToRun(const std::vector<const PassInfo*> &PTR) { 81 PassesToRun = PTR; 82 } 83 const std::vector<const PassInfo*> &getPassesToRun() const { 84 return PassesToRun; 85 } 86 87 /// run - The top level method that is invoked after all of the instance 88 /// variables are set up from command line arguments. The \p as_child argument 89 /// indicates whether the driver is to run in parent mode or child mode. 90 /// 91 bool run(); 92 93 /// debugOptimizerCrash - This method is called when some optimizer pass 94 /// crashes on input. It attempts to prune down the testcase to something 95 /// reasonable, and figure out exactly which pass is crashing. 96 /// 97 bool debugOptimizerCrash(const std::string &ID = "passes"); 98 99 /// debugCodeGeneratorCrash - This method is called when the code generator 100 /// crashes on an input. It attempts to reduce the input as much as possible 101 /// while still causing the code generator to crash. 102 bool debugCodeGeneratorCrash(); 103 104 /// debugMiscompilation - This method is used when the passes selected are not 105 /// crashing, but the generated output is semantically different from the 106 /// input. 107 bool debugMiscompilation(); 108 109 /// debugPassMiscompilation - This method is called when the specified pass 110 /// miscompiles Program as input. It tries to reduce the testcase to 111 /// something that smaller that still miscompiles the program. 112 /// ReferenceOutput contains the filename of the file containing the output we 113 /// are to match. 114 /// 115 bool debugPassMiscompilation(const PassInfo *ThePass, 116 const std::string &ReferenceOutput); 117 118 /// compileSharedObject - This method creates a SharedObject from a given 119 /// BitcodeFile for debugging a code generator. 120 /// 121 std::string compileSharedObject(const std::string &BitcodeFile); 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(); 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 = 0) { 135 if (M == 0) M = Program; 136 std::swap(M, Program); 137 bool Result = runPasses(PassesToRun); 138 std::swap(M, Program); 139 return Result; 140 } 141 142 Module *getProgram() const { return Program; } 143 144 /// swapProgramIn - Set the current module to the specified module, returning 145 /// the old one. 146 Module *swapProgramIn(Module *M) { 147 Module *OldProgram = Program; 148 Program = M; 149 return OldProgram; 150 } 151 152 AbstractInterpreter *switchToSafeInterpreter() { 153 AbstractInterpreter *Old = Interpreter; 154 Interpreter = (AbstractInterpreter*)SafeInterpreter; 155 return Old; 156 } 157 158 void switchToInterpreter(AbstractInterpreter *AI) { 159 Interpreter = AI; 160 } 161 162 /// setNewProgram - If we reduce or update the program somehow, call this 163 /// method to update bugdriver with it. This deletes the old module and sets 164 /// the specified one as the current program. 165 void setNewProgram(Module *M); 166 167 /// compileProgram - Try to compile the specified module, throwing an 168 /// exception if an error occurs, or returning normally if not. This is used 169 /// for code generation crash testing. 170 /// 171 void compileProgram(Module *M); 172 173 /// executeProgram - This method runs "Program", capturing the output of the 174 /// program to a file, returning the filename of the file. A recommended 175 /// filename may be optionally specified. If there is a problem with the code 176 /// generator (e.g., llc crashes), this will throw an exception. 177 /// 178 std::string executeProgram(std::string RequestedOutputFilename = "", 179 std::string Bitcode = "", 180 const std::string &SharedObjects = "", 181 AbstractInterpreter *AI = 0, 182 bool *ProgramExitedNonzero = 0); 183 184 /// executeProgramSafely - Used to create reference output with the "safe" 185 /// backend, if reference output is not provided. If there is a problem with 186 /// the code generator (e.g., llc crashes), this will throw an exception. 187 /// 188 std::string executeProgramSafely(std::string OutputFile = ""); 189 190 /// createReferenceFile - calls compileProgram and then records the output 191 /// into ReferenceOutputFile. Returns true if reference file created, false 192 /// otherwise. Note: initializeExecutionEnvironment should be called BEFORE 193 /// this function. 194 /// 195 bool createReferenceFile(Module *M, const std::string &Filename 196 = "bugpoint.reference.out"); 197 198 /// diffProgram - This method executes the specified module and diffs the 199 /// output against the file specified by ReferenceOutputFile. If the output 200 /// is different, true is returned. If there is a problem with the code 201 /// generator (e.g., llc crashes), this will throw an exception. 202 /// 203 bool diffProgram(const std::string &BitcodeFile = "", 204 const std::string &SharedObj = "", 205 bool RemoveBitcode = false); 206 207 /// EmitProgressBitcode - This function is used to output the current Program 208 /// to a file named "bugpoint-ID.bc". 209 /// 210 void EmitProgressBitcode(const std::string &ID, bool NoFlyer = false); 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 const; 219 220 /// performFinalCleanups - This method clones the current Program and performs 221 /// a series of cleanups intended to get rid of extra cruft on the module. If 222 /// the MayModifySemantics argument is true, then the cleanups is allowed to 223 /// modify how the code behaves. 224 /// 225 Module *performFinalCleanups(Module *M, bool MayModifySemantics = false); 226 227 /// ExtractLoop - Given a module, extract up to one loop from it into a new 228 /// function. This returns null if there are no extractable loops in the 229 /// program or if the loop extractor crashes. 230 Module *ExtractLoop(Module *M); 231 232 /// ExtractMappedBlocksFromModule - Extract all but the specified basic blocks 233 /// into their own functions. The only detail is that M is actually a module 234 /// cloned from the one the BBs are in, so some mapping needs to be performed. 235 /// If this operation fails for some reason (ie the implementation is buggy), 236 /// this function should return null, otherwise it returns a new Module. 237 Module *ExtractMappedBlocksFromModule(const std::vector<BasicBlock*> &BBs, 238 Module *M); 239 240 /// runPassesOn - Carefully run the specified set of pass on the specified 241 /// module, returning the transformed module on success, or a null pointer on 242 /// failure. If AutoDebugCrashes is set to true, then bugpoint will 243 /// automatically attempt to track down a crashing pass if one exists, and 244 /// this method will never return null. 245 Module *runPassesOn(Module *M, const std::vector<const PassInfo*> &Passes, 246 bool AutoDebugCrashes = false, unsigned NumExtraArgs = 0, 247 const char * const *ExtraArgs = NULL); 248 249 /// runPasses - Run the specified passes on Program, outputting a bitcode 250 /// file and writting the filename into OutputFile if successful. If the 251 /// optimizations fail for some reason (optimizer crashes), return true, 252 /// otherwise return false. If DeleteOutput is set to true, the bitcode is 253 /// deleted on success, and the filename string is undefined. This prints to 254 /// outs() a single line message indicating whether compilation was successful 255 /// or failed, unless Quiet is set. ExtraArgs specifies additional arguments 256 /// to pass to the child bugpoint instance. 257 /// 258 bool runPasses(const std::vector<const PassInfo*> &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<const PassInfo*> &AllPasses); 271 272 /// writeProgramToFile - This writes the current "Program" to the named 273 /// bitcode file. If an error occurs, true is returned. 274 /// 275 bool writeProgramToFile(const std::string &Filename, Module *M = 0) const; 276 277private: 278 /// runPasses - Just like the method above, but this just returns true or 279 /// false indicating whether or not the optimizer crashed on the specified 280 /// input (true = crashed). 281 /// 282 bool runPasses(const std::vector<const PassInfo*> &PassesToRun, 283 bool DeleteOutput = true) const { 284 std::string Filename; 285 return runPasses(PassesToRun, Filename, DeleteOutput); 286 } 287 288 /// runAsChild - The actual "runPasses" guts that runs in a child process. 289 int runPassesAsChild(const std::vector<const PassInfo*> &PassesToRun); 290 291 /// initializeExecutionEnvironment - This method is used to set up the 292 /// environment for executing LLVM programs. 293 /// 294 bool initializeExecutionEnvironment(); 295}; 296 297/// ParseInputFile - Given a bitcode or assembly input filename, parse and 298/// return it, or return null if not possible. 299/// 300Module *ParseInputFile(const std::string &InputFilename, 301 LLVMContext& ctxt); 302 303 304/// getPassesString - Turn a list of passes into a string which indicates the 305/// command line options that must be passed to add the passes. 306/// 307std::string getPassesString(const std::vector<const PassInfo*> &Passes); 308 309/// PrintFunctionList - prints out list of problematic functions 310/// 311void PrintFunctionList(const std::vector<Function*> &Funcs); 312 313/// PrintGlobalVariableList - prints out list of problematic global variables 314/// 315void PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs); 316 317// DeleteFunctionBody - "Remove" the function by deleting all of it's basic 318// blocks, making it external. 319// 320void DeleteFunctionBody(Function *F); 321 322/// SplitFunctionsOutOfModule - Given a module and a list of functions in the 323/// module, split the functions OUT of the specified module, and place them in 324/// the new module. 325Module *SplitFunctionsOutOfModule(Module *M, const std::vector<Function*> &F, 326 DenseMap<const Value*, Value*> &ValueMap); 327 328} // End llvm namespace 329 330#endif 331