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 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 namespace llvm {
  42
  43 /// getPassesString - Turn a list of passes into a string which indicates the
  44 /// command line options that must be passed to add the passes.
  45 ///
  46 std::string getPassesString(const std::vector<const PassInfo*> &Passes) {
  47   std::string Result;
  48   for (unsigned i = 0, e = Passes.size(); i != e; ++i) {
  49     if (i) Result += " ";
  50     Result += "-";
  51     Result += Passes[i]->getPassArgument();
  52   }
  53   return Result;
  54 }
  55
  56 // DeleteFunctionBody - "Remove" the function by deleting all of its basic
  57 // blocks, making it external.
  58 //
  59 void DeleteFunctionBody(Function *F) {
  60   // delete the body of the function...
  61   F->deleteBody();
  62   assert(F->isExternal() && "This didn't make the function external!");
  63 }
  64
  65 BugDriver::BugDriver(const char *toolname)
  66   : ToolName(toolname), ReferenceOutputFile(OutputFile),
  67     Program(0), Interpreter(0), cbe(0), gcc(0) {}
  68
  69
  70 /// ParseInputFile - Given a bytecode or assembly input filename, parse and
  71 /// return it, or return null if not possible.
  72 ///
  73 Module *BugDriver::ParseInputFile(const std::string &InputFilename) const {
  74   Module *Result = 0;
  75   try {
  76     Result = ParseBytecodeFile(InputFilename);
  77     if (!Result && !(Result = ParseAssemblyFile(InputFilename))){
  78       std::cerr << ToolName << ": could not read input file '"
  79                 << InputFilename << "'!\n";
  80     }
  81   } catch (const ParseException &E) {
  82     std::cerr << ToolName << ": " << 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 //
  93 bool 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   std::cout << "Read input file      : '" << Filenames[0] << "'\n";
 101
 102   for (unsigned i = 1, e = Filenames.size(); i != e; ++i) {
 103     std::auto_ptr<Module> M(ParseInputFile(Filenames[i]));
 104     if (M.get() == 0) return true;
 105
 106     std::cout << "Linking in input file: '" << Filenames[i] << "'\n";
 107     std::string ErrorMessage;
 108     if (LinkModules(Program, M.get(), &ErrorMessage)) {
 109       std::cerr << ToolName << ": error linking in '" << Filenames[i] << "': "
 110                 << ErrorMessage << "\n";
 111       return true;
 112     }
 113   }
 114
 115   std::cout << "*** All input ok\n";
 116
 117   // All input files read successfully!
 118   return false;
 119 }
 120
 121
 122
 123 /// run - The top level method that is invoked after all of the instance
 124 /// variables are set up from command line arguments.
 125 ///
 126 bool BugDriver::run() {
 127   // The first thing that we must do is determine what the problem is.  Does the
 128   // optimization series crash the compiler, or does it produce illegal code? We
 129   // make the top-level decision by trying to run all of the passes on the the
 130   // input program, which should generate a bytecode file.  If it does generate
 131   // a bytecode file, then we know the compiler didn't crash, so try to diagnose
 132   // a miscompilation.
 133   //
 134   if (!PassesToRun.empty()) {
 135     std::cout << "Running selected passes on program to test for crash: ";
 136     if (runPasses(PassesToRun))
 137       return debugCrash();
 138   }
 139
 140   // Set up the execution environment, selecting a method to run LLVM bytecode.
 141   if (initializeExecutionEnvironment()) return true;
 142
 143   // Run the raw input to see where we are coming from.  If a reference output
 144   // was specified, make sure that the raw output matches it.  If not, it's a
 145   // problem in the front-end or the code generator.
 146   //
 147   bool CreatedOutput = false;
 148   if (ReferenceOutputFile.empty()) {
 149     std::cout << "Generating reference output from raw program...";
 150     ReferenceOutputFile = executeProgramWithCBE("bugpoint.reference.out");
 151     CreatedOutput = true;
 152     std::cout << "Reference output is: " << ReferenceOutputFile << "\n";
 153   }
 154
 155   // Make sure the reference output file gets deleted on exit from this
 156   // function, if appropriate.
 157   struct Remover {
 158     bool DeleteIt; const std::string &Filename;
 159     Remover(bool deleteIt, const std::string &filename)
 160       : DeleteIt(deleteIt), Filename(filename) {}
 161     ~Remover() {
 162       if (DeleteIt) removeFile(Filename);
 163     }
 164   } RemoverInstance(CreatedOutput, ReferenceOutputFile);
 165
 166   // Diff the output of the raw program against the reference output.  If it
 167   // matches, then we have a miscompilation bug.
 168   std::cout << "*** Checking the code generator...\n";
 169   if (!diffProgram()) {
 170     std::cout << "\n*** Debugging miscompilation!\n";
 171     return debugMiscompilation();
 172   }
 173
 174   std::cout << "\n*** Input program does not match reference diff!\n";
 175   std::cout << "Debugging code generator problem!\n";
 176   return debugCodeGenerator();
 177 }
 178
 179 void BugDriver::PrintFunctionList(const std::vector<Function*> &Funcs) {
 180   for (unsigned i = 0, e = Funcs.size(); i != e; ++i) {
 181     if (i) std::cout << ", ";
 182     std::cout << Funcs[i]->getName();
 183   }
 184   std::cout << std::flush;
 185 }
 186
 187 } // End llvm namespace