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