BugDriver.cpp revision 584c3bf6504ec0e56c54bbf02fce2d2bd1e6c0e1
1//===- BugDriver.cpp - Top-Level BugPoint class implementation ------------===// 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#include "BugDriver.h" 17#include "ToolRunner.h" 18#include "llvm/Linker.h" 19#include "llvm/Module.h" 20#include "llvm/Pass.h" 21#include "llvm/Assembly/Parser.h" 22#include "llvm/Bitcode/ReaderWriter.h" 23#include "llvm/Support/CommandLine.h" 24#include "llvm/Support/FileUtilities.h" 25#include "llvm/Support/MemoryBuffer.h" 26#include <iostream> 27#include <memory> 28using namespace llvm; 29 30// Anonymous namespace to define command line options for debugging. 31// 32namespace { 33 // Output - The user can specify a file containing the expected output of the 34 // program. If this filename is set, it is used as the reference diff source, 35 // otherwise the raw input run through an interpreter is used as the reference 36 // source. 37 // 38 cl::opt<std::string> 39 OutputFile("output", cl::desc("Specify a reference program output " 40 "(for miscompilation detection)")); 41} 42 43/// setNewProgram - If we reduce or update the program somehow, call this method 44/// to update bugdriver with it. This deletes the old module and sets the 45/// specified one as the current program. 46void BugDriver::setNewProgram(Module *M) { 47 delete Program; 48 Program = M; 49} 50 51 52/// getPassesString - Turn a list of passes into a string which indicates the 53/// command line options that must be passed to add the passes. 54/// 55std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) { 56 std::string Result; 57 for (unsigned i = 0, e = Passes.size(); i != e; ++i) { 58 if (i) Result += " "; 59 Result += "-"; 60 Result += Passes[i]->getPassArgument(); 61 } 62 return Result; 63} 64 65BugDriver::BugDriver(const char *toolname, bool as_child, bool find_bugs, 66 unsigned timeout, unsigned memlimit) 67 : ToolName(toolname), ReferenceOutputFile(OutputFile), 68 Program(0), Interpreter(0), cbe(0), gcc(0), run_as_child(as_child), 69 run_find_bugs(find_bugs), Timeout(timeout), MemoryLimit(memlimit) {} 70 71 72/// ParseInputFile - Given a bitcode or assembly input filename, parse and 73/// return it, or return null if not possible. 74/// 75Module *llvm::ParseInputFile(const std::string &Filename) { 76 std::auto_ptr<MemoryBuffer> Buffer(MemoryBuffer::getFileOrSTDIN(Filename)); 77 Module *Result = 0; 78 if (Buffer.get()) 79 Result = ParseBitcodeFile(Buffer.get()); 80 81 ParseError Err; 82 if (!Result && !(Result = ParseAssemblyFile(Filename, &Err))) { 83 std::cerr << "bugpoint: " << Err.getMessage() << "\n"; 84 Result = 0; 85 } 86 87 return Result; 88} 89 90// This method takes the specified list of LLVM input files, attempts to load 91// them, either as assembly or bitcode, then link them together. It returns 92// true on failure (if, for example, an input bitcode file could not be 93// parsed), and false on success. 94// 95bool BugDriver::addSources(const std::vector<std::string> &Filenames) { 96 assert(Program == 0 && "Cannot call addSources multiple times!"); 97 assert(!Filenames.empty() && "Must specify at least on input filename!"); 98 99 try { 100 // Load the first input file. 101 Program = ParseInputFile(Filenames[0]); 102 if (Program == 0) return true; 103 104 if (!run_as_child) 105 std::cout << "Read input file : '" << Filenames[0] << "'\n"; 106 107 for (unsigned i = 1, e = Filenames.size(); i != e; ++i) { 108 std::auto_ptr<Module> M(ParseInputFile(Filenames[i])); 109 if (M.get() == 0) return true; 110 111 if (!run_as_child) 112 std::cout << "Linking in input file: '" << Filenames[i] << "'\n"; 113 std::string ErrorMessage; 114 if (Linker::LinkModules(Program, M.get(), &ErrorMessage)) { 115 std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': " 116 << ErrorMessage << '\n'; 117 return true; 118 } 119 } 120 } catch (const std::string &Error) { 121 std::cerr << ToolName << ": error reading input '" << Error << "'\n"; 122 return true; 123 } 124 125 if (!run_as_child) 126 std::cout << "*** All input ok\n"; 127 128 // All input files read successfully! 129 return false; 130} 131 132 133 134/// run - The top level method that is invoked after all of the instance 135/// variables are set up from command line arguments. 136/// 137bool BugDriver::run() { 138 // The first thing to do is determine if we're running as a child. If we are, 139 // then what to do is very narrow. This form of invocation is only called 140 // from the runPasses method to actually run those passes in a child process. 141 if (run_as_child) { 142 // Execute the passes 143 return runPassesAsChild(PassesToRun); 144 } 145 146 if (run_find_bugs) { 147 // Rearrange the passes and apply them to the program. Repeat this process 148 // until the user kills the program or we find a bug. 149 return runManyPasses(PassesToRun); 150 } 151 152 // If we're not running as a child, the first thing that we must do is 153 // determine what the problem is. Does the optimization series crash the 154 // compiler, or does it produce illegal code? We make the top-level 155 // decision by trying to run all of the passes on the the input program, 156 // which should generate a bitcode file. If it does generate a bitcode 157 // file, then we know the compiler didn't crash, so try to diagnose a 158 // miscompilation. 159 if (!PassesToRun.empty()) { 160 std::cout << "Running selected passes on program to test for crash: "; 161 if (runPasses(PassesToRun)) 162 return debugOptimizerCrash(); 163 } 164 165 // Set up the execution environment, selecting a method to run LLVM bitcode. 166 if (initializeExecutionEnvironment()) return true; 167 168 // Test to see if we have a code generator crash. 169 std::cout << "Running the code generator to test for a crash: "; 170 try { 171 compileProgram(Program); 172 std::cout << '\n'; 173 } catch (ToolExecutionError &TEE) { 174 std::cout << TEE.what(); 175 return debugCodeGeneratorCrash(); 176 } 177 178 179 // Run the raw input to see where we are coming from. If a reference output 180 // was specified, make sure that the raw output matches it. If not, it's a 181 // problem in the front-end or the code generator. 182 // 183 bool CreatedOutput = false; 184 if (ReferenceOutputFile.empty()) { 185 std::cout << "Generating reference output from raw program: "; 186 if(!createReferenceFile(Program)){ 187 return debugCodeGeneratorCrash(); 188 } 189 CreatedOutput = true; 190 } 191 192 // Make sure the reference output file gets deleted on exit from this 193 // function, if appropriate. 194 sys::Path ROF(ReferenceOutputFile); 195 FileRemover RemoverInstance(ROF, CreatedOutput); 196 197 // Diff the output of the raw program against the reference output. If it 198 // matches, then we assume there is a miscompilation bug and try to 199 // diagnose it. 200 std::cout << "*** Checking the code generator...\n"; 201 try { 202 if (!diffProgram()) { 203 std::cout << "\n*** Debugging miscompilation!\n"; 204 return debugMiscompilation(); 205 } 206 } catch (ToolExecutionError &TEE) { 207 std::cerr << TEE.what(); 208 return debugCodeGeneratorCrash(); 209 } 210 211 std::cout << "\n*** Input program does not match reference diff!\n"; 212 std::cout << "Debugging code generator problem!\n"; 213 try { 214 return debugCodeGenerator(); 215 } catch (ToolExecutionError &TEE) { 216 std::cerr << TEE.what(); 217 return debugCodeGeneratorCrash(); 218 } 219} 220 221void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) { 222 unsigned NumPrint = Funcs.size(); 223 if (NumPrint > 10) NumPrint = 10; 224 for (unsigned i = 0; i != NumPrint; ++i) 225 std::cout << " " << Funcs[i]->getName(); 226 if (NumPrint < Funcs.size()) 227 std::cout << "... <" << Funcs.size() << " total>"; 228 std::cout << std::flush; 229} 230 231void llvm::PrintGlobalVariableList(const std::vector<GlobalVariable*> &GVs) { 232 unsigned NumPrint = GVs.size(); 233 if (NumPrint > 10) NumPrint = 10; 234 for (unsigned i = 0; i != NumPrint; ++i) 235 std::cout << " " << GVs[i]->getName(); 236 if (NumPrint < GVs.size()) 237 std::cout << "... <" << GVs.size() << " total>"; 238 std::cout << std::flush; 239} 240