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