tools/bugpoint/ExecutionDriver.cpp

   1 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
   2 //
   3 // This file contains code used to execute the program utilizing one of the
   4 // various ways of running LLVM bytecode.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 /*
   9 BUGPOINT NOTES:
  10
  11 1. Bugpoint should not leave any files behind if the program works properly
  12 2. There should be an option to specify the program name, which specifies a
  13    unique string to put into output files.  This allows operation in the
  14    SingleSource directory, e.g. default to the first input filename.
  15 */
  16
  17 #include "BugDriver.h"
  18 #include "Support/CommandLine.h"
  19 #include "Support/Debug.h"
  20 #include "Support/FileUtilities.h"
  21 #include "Support/SystemUtils.h"
  22 #include "llvm/Support/ToolRunner.h"
  23 #include <fstream>
  24 #include <iostream>
  25
  26 namespace {
  27   // OutputType - Allow the user to specify the way code should be run, to test
  28   // for miscompilation.
  29   //
  30   enum OutputType {
  31     RunLLI, RunJIT, RunLLC, RunCBE
  32   };
  33
  34   cl::opt<OutputType>
  35   InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
  36                  cl::values(clEnumValN(RunLLI, "run-lli", "Execute with LLI"),
  37                             clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
  38                             clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
  39                             clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
  40                             0));
  41
  42   cl::opt<std::string>
  43   InputFile("input", cl::init("/dev/null"),
  44             cl::desc("Filename to pipe in as stdin (default: /dev/null)"));
  45
  46   cl::list<std::string>
  47   AdditionalSOs("additional-so",
  48                 cl::desc("Additional shared objects to load "
  49                          "into executing programs"));
  50 }
  51
  52 // Anything specified after the --args option are taken as arguments to the
  53 // program being debugged.
  54 cl::list<std::string>
  55 InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
  56           cl::ZeroOrMore);
  57
  58 //===----------------------------------------------------------------------===//
  59 // BugDriver method implementation
  60 //
  61
  62 /// initializeExecutionEnvironment - This method is used to set up the
  63 /// environment for executing LLVM programs.
  64 ///
  65 bool BugDriver::initializeExecutionEnvironment() {
  66   std::cout << "Initializing execution environment: ";
  67
  68   // FIXME: This should default to searching for the best interpreter to use on
  69   // this platform, which would be JIT, then LLC, then CBE, then LLI.
  70
  71   // Create an instance of the AbstractInterpreter interface as specified on
  72   // the command line
  73   std::string Message;
  74   switch (InterpreterSel) {
  75   case RunLLI:
  76     Interpreter = AbstractInterpreter::createLLI(getToolName(), Message);
  77     break;
  78   case RunLLC:
  79     Interpreter = AbstractInterpreter::createLLC(getToolName(), Message);
  80     break;
  81   case RunJIT:
  82     Interpreter = AbstractInterpreter::createJIT(getToolName(), Message);
  83     break;
  84   case RunCBE:
  85     Interpreter = AbstractInterpreter::createCBE(getToolName(), Message);
  86     break;
  87   default:
  88     Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
  89     break;
  90   }
  91   std::cerr << Message;
  92
  93   // Initialize auxiliary tools for debugging
  94   cbe = AbstractInterpreter::createCBE(getToolName(), Message);
  95   if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
  96   gcc = GCC::create(getToolName(), Message);
  97   if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }
  98
  99   // If there was an error creating the selected interpreter, quit with error.
 100   return Interpreter == 0;
 101 }
 102
 103
 104 /// executeProgram - This method runs "Program", capturing the output of the
 105 /// program to a file, returning the filename of the file.  A recommended
 106 /// filename may be optionally specified.
 107 ///
 108 std::string BugDriver::executeProgram(std::string OutputFile,
 109                                       std::string BytecodeFile,
 110                                       const std::string &SharedObj,
 111                                       AbstractInterpreter *AI) {
 112   if (AI == 0) AI = Interpreter;
 113   assert(AI && "Interpreter should have been created already!");
 114   bool CreatedBytecode = false;
 115   if (BytecodeFile.empty()) {
 116     // Emit the program to a bytecode file...
 117     BytecodeFile = getUniqueFilename("bugpoint-test-program.bc");
 118
 119     if (writeProgramToFile(BytecodeFile, Program)) {
 120       std::cerr << ToolName << ": Error emitting bytecode to file '"
 121                 << BytecodeFile << "'!\n";
 122       exit(1);
 123     }
 124     CreatedBytecode = true;
 125   }
 126
 127   if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";
 128
 129   // Check to see if this is a valid output filename...
 130   OutputFile = getUniqueFilename(OutputFile);
 131
 132   // Figure out which shared objects to run, if any.
 133   std::vector<std::string> SharedObjs(AdditionalSOs);
 134   if (!SharedObj.empty())
 135     SharedObjs.push_back(SharedObj);
 136
 137   // Actually execute the program!
 138   int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
 139                                   OutputFile, SharedObjs);
 140
 141
 142   // Remove the temporary bytecode file.
 143   if (CreatedBytecode) removeFile(BytecodeFile);
 144
 145   // Return the filename we captured the output to.
 146   return OutputFile;
 147 }
 148
 149
 150 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
 151   assert(Interpreter && "Interpreter should have been created already!");
 152   std::string OutputCFile;
 153
 154   // Using CBE
 155   cbe->OutputC(BytecodeFile, OutputCFile);
 156
 157 #if 0 /* This is an alternative, as yet unimplemented */
 158   // Using LLC
 159   std::string Message;
 160   LLC *llc = createLLCtool(Message);
 161   if (llc->OutputAsm(BytecodeFile, OutputFile)) {
 162     std::cerr << "Could not generate asm code with `llc', exiting.\n";
 163     exit(1);
 164   }
 165 #endif
 166
 167   std::string SharedObjectFile;
 168   if (gcc->MakeSharedObject(OutputCFile, GCC::CFile, SharedObjectFile))
 169     exit(1);
 170
 171   // Remove the intermediate C file
 172   removeFile(OutputCFile);
 173
 174   return SharedObjectFile;
 175 }
 176
 177
 178 /// diffProgram - This method executes the specified module and diffs the output
 179 /// against the file specified by ReferenceOutputFile.  If the output is
 180 /// different, true is returned.
 181 ///
 182 bool BugDriver::diffProgram(const std::string &BytecodeFile,
 183                             const std::string &SharedObject,
 184                             bool RemoveBytecode) {
 185   // Execute the program, generating an output file...
 186   std::string Output = executeProgram("", BytecodeFile, SharedObject);
 187
 188   std::string Error;
 189   bool FilesDifferent = false;
 190   if (DiffFiles(ReferenceOutputFile, Output, &Error)) {
 191     if (!Error.empty()) {
 192       std::cerr << "While diffing output: " << Error << "\n";
 193       exit(1);
 194     }
 195     FilesDifferent = true;
 196   }
 197
 198   if (RemoveBytecode) removeFile(BytecodeFile);
 199   return FilesDifferent;
 200 }
 201
 202 bool BugDriver::isExecutingJIT() {
 203   return InterpreterSel == RunJIT;
 204 }