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