tools/bugpoint/BugDriver.cpp

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