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