tools/bugpoint/BugDriver.cpp

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