BugDriver.cpp revision c4bb052ecccfafa0ffa928d0b061db35734ee2ee
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 "llvm/Linker.h" 18#include "llvm/Module.h" 19#include "llvm/Pass.h" 20#include "llvm/Assembly/Parser.h" 21#include "llvm/Bytecode/Reader.h" 22#include "llvm/Support/ToolRunner.h" 23#include "llvm/Support/CommandLine.h" 24#include "llvm/Support/FileUtilities.h" 25#include <iostream> 26#include <memory> 27 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) 66 : ToolName(toolname), ReferenceOutputFile(OutputFile), 67 Program(0), Interpreter(0), cbe(0), gcc(0), run_as_child(as_child) {} 68 69 70/// ParseInputFile - Given a bytecode or assembly input filename, parse and 71/// return it, or return null if not possible. 72/// 73Module *llvm::ParseInputFile(const std::string &InputFilename) { 74 Module *Result = 0; 75 try { 76 Result = ParseBytecodeFile(InputFilename); 77 if (!Result && !(Result = ParseAssemblyFile(InputFilename))){ 78 std::cerr << "bugpoint: could not read input file '" 79 << InputFilename << "'!\n"; 80 } 81 } catch (const ParseException &E) { 82 std::cerr << "bugpoint: " << E.getMessage() << '\n'; 83 Result = 0; 84 } 85 return Result; 86} 87 88// This method takes the specified list of LLVM input files, attempts to load 89// them, either as assembly or bytecode, then link them together. It returns 90// true on failure (if, for example, an input bytecode file could not be 91// parsed), and false on success. 92// 93bool BugDriver::addSources(const std::vector<std::string> &Filenames) { 94 assert(Program == 0 && "Cannot call addSources multiple times!"); 95 assert(!Filenames.empty() && "Must specify at least on input filename!"); 96 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 117 if (!run_as_child) 118 std::cout << "*** All input ok\n"; 119 120 // All input files read successfully! 121 return false; 122} 123 124 125 126/// run - The top level method that is invoked after all of the instance 127/// variables are set up from command line arguments. 128/// 129bool BugDriver::run() { 130 // The first thing to do is determine if we're running as a child. If we are, 131 // then what to do is very narrow. This form of invocation is only called 132 // from the runPasses method to actually run those passes in a child process. 133 if (run_as_child) { 134 // Execute the passes 135 return runPassesAsChild(PassesToRun); 136 } 137 138 // If we're not running as a child, the first thing that we must do is 139 // determine what the problem is. Does the optimization series crash the 140 // compiler, or does it produce illegal code? We make the top-level 141 // decision by trying to run all of the passes on the the input program, 142 // which should generate a bytecode file. If it does generate a bytecode 143 // file, then we know the compiler didn't crash, so try to diagnose a 144 // miscompilation. 145 if (!PassesToRun.empty()) { 146 std::cout << "Running selected passes on program to test for crash: "; 147 if (runPasses(PassesToRun)) 148 return debugOptimizerCrash(); 149 } 150 151 // Set up the execution environment, selecting a method to run LLVM bytecode. 152 if (initializeExecutionEnvironment()) return true; 153 154 // Test to see if we have a code generator crash. 155 std::cout << "Running the code generator to test for a crash: "; 156 try { 157 compileProgram(Program); 158 std::cout << '\n'; 159 } catch (ToolExecutionError &TEE) { 160 std::cout << TEE.what(); 161 return debugCodeGeneratorCrash(); 162 } 163 164 165 // Run the raw input to see where we are coming from. If a reference output 166 // was specified, make sure that the raw output matches it. If not, it's a 167 // problem in the front-end or the code generator. 168 // 169 bool CreatedOutput = false; 170 if (ReferenceOutputFile.empty()) { 171 std::cout << "Generating reference output from raw program: "; 172 try { 173 ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out"); 174 CreatedOutput = true; 175 std::cout << "Reference output is: " << ReferenceOutputFile << '\n'; 176 } catch (ToolExecutionError &TEE) { 177 std::cerr << TEE.what(); 178 if (Interpreter != cbe) { 179 std::cerr << "*** There is a bug running the C backend. Either debug" 180 << " it (use the -run-cbe bugpoint option), or fix the error" 181 << " some other way.\n"; 182 return 1; 183 } 184 return debugCodeGeneratorCrash(); 185 } 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 have a miscompilation bug. 195 std::cout << "*** Checking the code generator...\n"; 196 try { 197 if (!diffProgram()) { 198 std::cout << "\n*** Debugging miscompilation!\n"; 199 return debugMiscompilation(); 200 } 201 } catch (ToolExecutionError &TEE) { 202 std::cerr << TEE.what(); 203 return debugCodeGeneratorCrash(); 204 } 205 206 std::cout << "\n*** Input program does not match reference diff!\n"; 207 std::cout << "Debugging code generator problem!\n"; 208 try { 209 return debugCodeGenerator(); 210 } catch (ToolExecutionError &TEE) { 211 std::cerr << TEE.what(); 212 return debugCodeGeneratorCrash(); 213 } 214} 215 216void llvm::PrintFunctionList(const std::vector<Function*> &Funcs) { 217 unsigned NumPrint = Funcs.size(); 218 if (NumPrint > 10) NumPrint = 10; 219 for (unsigned i = 0; i != NumPrint; ++i) 220 std::cout << " " << Funcs[i]->getName(); 221 if (NumPrint < Funcs.size()) 222 std::cout << "... <" << Funcs.size() << " total>"; 223 std::cout << std::flush; 224} 225