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 "llvm/Module.h"
  18 #include "llvm/Pass.h"
  19 #include "llvm/Assembly/Parser.h"
  20 #include "llvm/Bytecode/Reader.h"
  21 #include "llvm/Transforms/Utils/Linker.h"
  22 #include "llvm/Support/ToolRunner.h"
  23 #include "Support/CommandLine.h"
  24 #include "Support/FileUtilities.h"
  25 #include <memory>
  26 using namespace llvm;
  27
  28 // Anonymous namespace to define command line options for debugging.
  29 //
  30 namespace {
  31   // Output - The user can specify a file containing the expected output of the
  32   // program.  If this filename is set, it is used as the reference diff source,
  33   // otherwise the raw input run through an interpreter is used as the reference
  34   // source.
  35   //
  36   cl::opt<std::string>
  37   OutputFile("output", cl::desc("Specify a reference program output "
  38                                 "(for miscompilation detection)"));
  39 }
  40
  41 /// getPassesString - Turn a list of passes into a string which indicates the
  42 /// command line options that must be passed to add the passes.
  43 ///
  44 std::string llvm::getPassesString(const std::vector<const PassInfo*> &Passes) {
  45   std::string Result;
  46   for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
  47     if (i) Result += " ";
  48     Result += "-";
  49     Result += Passes[i]->getPassArgument();
  50   }
  51   return Result;
  52 }
  53
  54 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
  55 // blocks, making it external.
  56 //
  57 void llvm::DeleteFunctionBody(Function *F) {
  58   // delete the body of the function...
  59   F->deleteBody();
  60   assert(F->isExternal() && "This didn't make the function external!");
  61 }
  62
  63 BugDriver::BugDriver(const char *toolname)
  64   : ToolName(toolname), ReferenceOutputFile(OutputFile),
  65     Program(0), Interpreter(0), cbe(0), gcc(0) {}
  66
  67
  68 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
  69 /// return it, or return null if not possible.
  70 ///
  71 Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
  72   Module *Result = 0;
  73   try {
  74     Result = ParseBytecodeFile(InputFilename);
  75     if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
  76       std::cerr << ToolName << ": could not read input file '"
  77                 << InputFilename << "'!\n";
  78     }
  79   } catch (const ParseException &E) {
  80     std::cerr << ToolName << ": " << E.getMessage() << "\n";
  81     Result = 0;
  82   }
  83   return Result;
  84 }
  85
  86 // This method takes the specified list of LLVM input files, attempts to load
  87 // them, either as assembly or bytecode, then link them together. It returns
  88 // true on failure (if, for example, an input bytecode file could not be
  89 // parsed), and false on success.
  90 //
  91 bool BugDriver::addSources(const std::vector<std::string> &Filenames) {
  92   assert(Program == 0 && "Cannot call addSources multiple times!");
  93   assert(!Filenames.empty() && "Must specify at least on input filename!");
  94
  95   // Load the first input file...
  96   Program = ParseInputFile(Filenames[0]);
  97   if (Program == 0) return true;
  98   std::cout << "Read input file      : '" << Filenames[0] << "'\n";
  99
 100   for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
 101     std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
 102     if (M.get() == 0) return true;
 103
 104     std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
 105     std::string ErrorMessage;
 106     if (LinkModules(Program, M.get(), &ErrorMessage)) {
 107       std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
 108                 << ErrorMessage << "\n";
 109       return true;
 110     }
 111   }
 112
 113   std::cout << "*** All input ok\n";
 114
 115   // All input files read successfully!
 116   return false;
 117 }
 118
 119
 120
 121 /// run - The top level method that is invoked after all of the instance
 122 /// variables are set up from command line arguments.
 123 ///
 124 bool BugDriver::run() {
 125   // The first thing that we must do is determine what the problem is.  Does the
 126   // optimization series crash the compiler, or does it produce illegal code? We
 127   // make the top-level decision by trying to run all of the passes on the the
 128   // input program, which should generate a bytecode file.  If it does generate
 129   // a bytecode file, then we know the compiler didn't crash, so try to diagnose
 130   // a miscompilation.
 131   //
 132   if (!PassesToRun.empty()) {
 133     std::cout << "Running selected passes on program to test for crash: ";
 134     if (runPasses(PassesToRun))
 135       return debugOptimizerCrash();
 136   }
 137
 138   // Set up the execution environment, selecting a method to run LLVM bytecode.
 139   if (initializeExecutionEnvironment()) return true;
 140
 141   // Run the raw input to see where we are coming from.  If a reference output
 142   // was specified, make sure that the raw output matches it.  If not, it's a
 143   // problem in the front-end or the code generator.
 144   //
 145   bool CreatedOutput = false;
 146   if (ReferenceOutputFile.empty()) {
 147     std::cout << "Generating reference output from raw program...";
 148     try {
 149       ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
 150       CreatedOutput = true;
 151       std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
 152     } catch (ToolExecutionError &TEE) {
 153       std::cerr << TEE.getMessage();
 154       if (Interpreter != cbe) {
 155         std::cerr << "*** There is a bug running the C backend.  Either debug"
 156                   << " it (use the -run-cbe bugpoint option), or fix the error"
 157                   << " some other way.\n";
 158         return 1;
 159       }
 160       return debugCodeGeneratorCrash();
 161     }
 162   }
 163
 164   // Make sure the reference output file gets deleted on exit from this
 165   // function, if appropriate.
 166   FileRemover RemoverInstance(ReferenceOutputFile, CreatedOutput);
 167
 168   // Diff the output of the raw program against the reference output.  If it
 169   // matches, then we have a miscompilation bug.
 170   std::cout << "*** Checking the code generator...\n";
 171   try {
 172     if (!diffProgram()) {
 173       std::cout << "\n*** Debugging miscompilation!\n";
 174       return debugMiscompilation();
 175     }
 176   } catch (ToolExecutionError &TEE) {
 177     std::cerr << TEE.getMessage() << "*** Debugging code generator crash!\n";
 178     return debugCodeGeneratorCrash();
 179   }
 180
 181   std::cout << "\n*** Input program does not match reference diff!\n";
 182   std::cout << "Debugging code generator problem!\n";
 183   return debugCodeGenerator();
 184 }
 185
 186 void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs) {
 187   for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
 188     if (i) std::cout << ", ";
 189     std::cout << Funcs[i]->getName();
 190   }
 191   std::cout << std::flush;
 192 }
 193