tools/bugpoint/ExecutionDriver.cpp - platform/external/llvm - Git at Google

 //===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // This file contains code used to execute the program utilizing one of the
 // various ways of running LLVM bytecode.
 //
 //===----------------------------------------------------------------------===//

 #include "BugDriver.h"
 #include "llvm/Support/ToolRunner.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/FileUtilities.h"
 #include "llvm/Support/SystemUtils.h"
 #include <fstream>
 using namespace llvm;

 namespace {
   // OutputType - Allow the user to specify the way code should be run, to test
   // for miscompilation.
   //
   enum OutputType {
     AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
   };

   cl::opt<double>
   AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"),
                cl::init(0.0));
   cl::opt<double>
   RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"),
                cl::init(0.0));

   cl::opt<OutputType>
   InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
                  cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
                             clEnumValN(RunLLI, "run-int",
                                        "Execute with the interpreter"),
                             clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
                             clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
                             clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
                             clEnumValEnd),
                  cl::init(AutoPick));

   cl::opt<bool>
   CheckProgramExitCode("check-exit-code",
                    cl::desc("Assume nonzero exit code is failure (default on)"),
                        cl::init(true));

   cl::opt<std::string>
   InputFile("input", cl::init("/dev/null"),
             cl::desc("Filename to pipe in as stdin (default: /dev/null)"));

   cl::list<std::string>
   AdditionalSOs("additional-so",
                 cl::desc("Additional shared objects to load "
                          "into executing programs"));

   cl::opt<unsigned>
   TimeoutValue("timeout", cl::init(300), cl::value_desc("seconds"),
                cl::desc("Number of seconds program is allowed to run before it "
                         "is killed (default is 300s), 0 disables timeout"));
 }

 namespace llvm {
   // Anything specified after the --args option are taken as arguments to the
   // program being debugged.
   cl::list<std::string>
   InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
             cl::ZeroOrMore, cl::PositionalEatsArgs);

   cl::list<std::string>
   ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
            cl::ZeroOrMore, cl::PositionalEatsArgs);
 }

 //===----------------------------------------------------------------------===//
 // BugDriver method implementation
 //

 /// initializeExecutionEnvironment - This method is used to set up the
 /// environment for executing LLVM programs.
 ///
 bool BugDriver::initializeExecutionEnvironment() {
   std::cout << "Initializing execution environment: ";

   // Create an instance of the AbstractInterpreter interface as specified on
   // the command line
   cbe = 0;
   std::string Message;

   switch (InterpreterSel) {
   case AutoPick:
     InterpreterSel = RunCBE;
     Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
                                                        &ToolArgv);
     if (!Interpreter) {
       InterpreterSel = RunJIT;
       Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
                                                    &ToolArgv);
     }
     if (!Interpreter) {
       InterpreterSel = RunLLC;
       Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
                                                    &ToolArgv);
     }
     if (!Interpreter) {
       InterpreterSel = RunLLI;
       Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
                                                    &ToolArgv);
     }
     if (!Interpreter) {
       InterpreterSel = AutoPick;
       Message = "Sorry, I can't automatically select an interpreter!\n";
     }
     break;
   case RunLLI:
     Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
                                                  &ToolArgv);
     break;
   case RunLLC:
     Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
                                                  &ToolArgv);
     break;
   case RunJIT:
     Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
                                                  &ToolArgv);
     break;
   case RunCBE:
     Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
                                                        &ToolArgv);
     break;
   default:
     Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
     break;
   }
   std::cerr << Message;

   // Initialize auxiliary tools for debugging
   if (!cbe) {
     cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
     if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
   }
   gcc = GCC::create(getToolName(), Message);
   if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }

   // If there was an error creating the selected interpreter, quit with error.
   return Interpreter == 0;
 }

 /// compileProgram - Try to compile the specified module, throwing an exception
 /// if an error occurs, or returning normally if not.  This is used for code
 /// generation crash testing.
 ///
 void BugDriver::compileProgram(Module *M) {
   // Emit the program to a bytecode file...
   sys::Path BytecodeFile ("bugpoint-test-program.bc");
   BytecodeFile.makeUnique();
   if (writeProgramToFile(BytecodeFile.toString(), M)) {
     std::cerr << ToolName << ": Error emitting bytecode to file '"
               << BytecodeFile << "'!\n";
     exit(1);
   }

     // Remove the temporary bytecode file when we are done.
   FileRemover BytecodeFileRemover(BytecodeFile);

   // Actually compile the program!
   Interpreter->compileProgram(BytecodeFile.toString());
 }


 /// executeProgram - This method runs "Program", capturing the output of the
 /// program to a file, returning the filename of the file.  A recommended
 /// filename may be optionally specified.
 ///
 std::string BugDriver::executeProgram(std::string OutputFile,
                                       std::string BytecodeFile,
                                       const std::string &SharedObj,
                                       AbstractInterpreter *AI,
                                       bool *ProgramExitedNonzero) {
   if (AI == 0) AI = Interpreter;
   assert(AI && "Interpreter should have been created already!");
   bool CreatedBytecode = false;
   if (BytecodeFile.empty()) {
     // Emit the program to a bytecode file...
     sys::Path uniqueFilename("bugpoint-test-program.bc");
     uniqueFilename.makeUnique();
     BytecodeFile = uniqueFilename.toString();

     if (writeProgramToFile(BytecodeFile, Program)) {
       std::cerr << ToolName << ": Error emitting bytecode to file '"
                 << BytecodeFile << "'!\n";
       exit(1);
     }
     CreatedBytecode = true;
   }

   // Remove the temporary bytecode file when we are done.
   sys::Path BytecodePath (BytecodeFile);
   FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode);

   if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";

   // Check to see if this is a valid output filename...
   sys::Path uniqueFile(OutputFile);
   uniqueFile.makeUnique();
   OutputFile = uniqueFile.toString();

   // Figure out which shared objects to run, if any.
   std::vector<std::string> SharedObjs(AdditionalSOs);
   if (!SharedObj.empty())
     SharedObjs.push_back(SharedObj);

   // Actually execute the program!
   int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
                                   OutputFile, SharedObjs, TimeoutValue);

   if (RetVal == -1) {
     std::cerr << "<timeout>";
     static bool FirstTimeout = true;
     if (FirstTimeout) {
       std::cout << "\n"
  "*** Program execution timed out!  This mechanism is designed to handle\n"
  "    programs stuck in infinite loops gracefully.  The -timeout option\n"
  "    can be used to change the timeout threshold or disable it completely\n"
  "    (with -timeout=0).  This message is only displayed once.\n";
       FirstTimeout = false;
     }
   }

   if (ProgramExitedNonzero != 0)
     *ProgramExitedNonzero = (RetVal != 0);

   // Return the filename we captured the output to.
   return OutputFile;
 }

 /// executeProgramWithCBE - Used to create reference output with the C
 /// backend, if reference output is not provided.
 ///
 std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
   bool ProgramExitedNonzero;
   std::string outFN = executeProgram(OutputFile, "", "",
                                      (AbstractInterpreter*)cbe,
                                      &ProgramExitedNonzero);
   if (ProgramExitedNonzero) {
     std::cerr
       << "Warning: While generating reference output, program exited with\n"
       << "non-zero exit code. This will NOT be treated as a failure.\n";
     CheckProgramExitCode = false;
   }
   return outFN;
 }

 std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
   assert(Interpreter && "Interpreter should have been created already!");
   sys::Path OutputCFile;

   // Using CBE
   cbe->OutputC(BytecodeFile, OutputCFile);

 #if 0 /* This is an alternative, as yet unimplemented */
   // Using LLC
   std::string Message;
   LLC *llc = createLLCtool(Message);
   if (llc->OutputAsm(BytecodeFile, OutputFile)) {
     std::cerr << "Could not generate asm code with `llc', exiting.\n";
     exit(1);
   }
 #endif

   std::string SharedObjectFile;
   if (gcc->MakeSharedObject(OutputCFile.toString(), GCC::CFile,
                             SharedObjectFile))
     exit(1);

   // Remove the intermediate C file
   OutputCFile.eraseFromDisk();

   return "./" + SharedObjectFile;
 }


 /// diffProgram - This method executes the specified module and diffs the output
 /// against the file specified by ReferenceOutputFile.  If the output is
 /// different, true is returned.
 ///
 bool BugDriver::diffProgram(const std::string &BytecodeFile,
                             const std::string &SharedObject,
                             bool RemoveBytecode) {
   bool ProgramExitedNonzero;

   // Execute the program, generating an output file...
   sys::Path Output (executeProgram("", BytecodeFile, SharedObject, 0,
                                       &ProgramExitedNonzero));

   // If we're checking the program exit code, assume anything nonzero is bad.
   if (CheckProgramExitCode && ProgramExitedNonzero) {
     Output.eraseFromDisk();
     if (RemoveBytecode)
       sys::Path(BytecodeFile).eraseFromDisk();
     return true;
   }

   std::string Error;
   bool FilesDifferent = false;
   if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile),
                                         sys::Path(Output.toString()),
                                         AbsTolerance, RelTolerance, &Error)) {
     if (Diff == 2) {
       std::cerr << "While diffing output: " << Error << '\n';
       exit(1);
     }
     FilesDifferent = true;
   }

   // Remove the generated output.
   Output.eraseFromDisk();

   // Remove the bytecode file if we are supposed to.
   if (RemoveBytecode)
     sys::Path(BytecodeFile).eraseFromDisk();
   return FilesDifferent;
 }

 bool BugDriver::isExecutingJIT() {
   return InterpreterSel == RunJIT;
 }
	//===- ExecutionDriver.cpp - Allow execution of LLVM program --------------===//
	//
	// The LLVM Compiler Infrastructure
	//
	// This file was developed by the LLVM research group and is distributed under
	// the University of Illinois Open Source License. See LICENSE.TXT for details.
	//
	//===----------------------------------------------------------------------===//
	//
	// This file contains code used to execute the program utilizing one of the
	// various ways of running LLVM bytecode.
	//
	//===----------------------------------------------------------------------===//

	#include "BugDriver.h"
	#include "llvm/Support/ToolRunner.h"
	#include "llvm/Support/CommandLine.h"
	#include "llvm/Support/Debug.h"
	#include "llvm/Support/FileUtilities.h"
	#include "llvm/Support/SystemUtils.h"
	#include <fstream>
	using namespace llvm;

	namespace {
	// OutputType - Allow the user to specify the way code should be run, to test
	// for miscompilation.
	//
	enum OutputType {
	AutoPick, RunLLI, RunJIT, RunLLC, RunCBE
	};

	cl::opt<double>
	AbsTolerance("abs-tolerance", cl::desc("Absolute error tolerated"),
	cl::init(0.0));
	cl::opt<double>
	RelTolerance("rel-tolerance", cl::desc("Relative error tolerated"),
	cl::init(0.0));

	cl::opt<OutputType>
	InterpreterSel(cl::desc("Specify how LLVM code should be executed:"),
	cl::values(clEnumValN(AutoPick, "auto", "Use best guess"),
	clEnumValN(RunLLI, "run-int",
	"Execute with the interpreter"),
	clEnumValN(RunJIT, "run-jit", "Execute with JIT"),
	clEnumValN(RunLLC, "run-llc", "Compile with LLC"),
	clEnumValN(RunCBE, "run-cbe", "Compile with CBE"),
	clEnumValEnd),
	cl::init(AutoPick));

	cl::opt<bool>
	CheckProgramExitCode("check-exit-code",
	cl::desc("Assume nonzero exit code is failure (default on)"),
	cl::init(true));

	cl::opt<std::string>
	InputFile("input", cl::init("/dev/null"),
	cl::desc("Filename to pipe in as stdin (default: /dev/null)"));

	cl::list<std::string>
	AdditionalSOs("additional-so",
	cl::desc("Additional shared objects to load "
	"into executing programs"));

	cl::opt<unsigned>
	TimeoutValue("timeout", cl::init(300), cl::value_desc("seconds"),
	cl::desc("Number of seconds program is allowed to run before it "
	"is killed (default is 300s), 0 disables timeout"));
	}

	namespace llvm {
	// Anything specified after the --args option are taken as arguments to the
	// program being debugged.
	cl::list<std::string>
	InputArgv("args", cl::Positional, cl::desc("<program arguments>..."),
	cl::ZeroOrMore, cl::PositionalEatsArgs);

	cl::list<std::string>
	ToolArgv("tool-args", cl::Positional, cl::desc("<tool arguments>..."),
	cl::ZeroOrMore, cl::PositionalEatsArgs);
	}

	//===----------------------------------------------------------------------===//
	// BugDriver method implementation
	//

	/// initializeExecutionEnvironment - This method is used to set up the
	/// environment for executing LLVM programs.
	///
	bool BugDriver::initializeExecutionEnvironment() {
	std::cout << "Initializing execution environment: ";

	// Create an instance of the AbstractInterpreter interface as specified on
	// the command line
	cbe = 0;
	std::string Message;

	switch (InterpreterSel) {
	case AutoPick:
	InterpreterSel = RunCBE;
	Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
	&ToolArgv);
	if (!Interpreter) {
	InterpreterSel = RunJIT;
	Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
	&ToolArgv);
	}
	if (!Interpreter) {
	InterpreterSel = RunLLC;
	Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
	&ToolArgv);
	}
	if (!Interpreter) {
	InterpreterSel = RunLLI;
	Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
	&ToolArgv);
	}
	if (!Interpreter) {
	InterpreterSel = AutoPick;
	Message = "Sorry, I can't automatically select an interpreter!\n";
	}
	break;
	case RunLLI:
	Interpreter = AbstractInterpreter::createLLI(getToolName(), Message,
	&ToolArgv);
	break;
	case RunLLC:
	Interpreter = AbstractInterpreter::createLLC(getToolName(), Message,
	&ToolArgv);
	break;
	case RunJIT:
	Interpreter = AbstractInterpreter::createJIT(getToolName(), Message,
	&ToolArgv);
	break;
	case RunCBE:
	Interpreter = cbe = AbstractInterpreter::createCBE(getToolName(), Message,
	&ToolArgv);
	break;
	default:
	Message = "Sorry, this back-end is not supported by bugpoint right now!\n";
	break;
	}
	std::cerr << Message;

	// Initialize auxiliary tools for debugging
	if (!cbe) {
	cbe = AbstractInterpreter::createCBE(getToolName(), Message, &ToolArgv);
	if (!cbe) { std::cout << Message << "\nExiting.\n"; exit(1); }
	}
	gcc = GCC::create(getToolName(), Message);
	if (!gcc) { std::cout << Message << "\nExiting.\n"; exit(1); }

	// If there was an error creating the selected interpreter, quit with error.
	return Interpreter == 0;
	}

	/// compileProgram - Try to compile the specified module, throwing an exception
	/// if an error occurs, or returning normally if not. This is used for code
	/// generation crash testing.
	///
	void BugDriver::compileProgram(Module *M) {
	// Emit the program to a bytecode file...
	sys::Path BytecodeFile ("bugpoint-test-program.bc");
	BytecodeFile.makeUnique();
	if (writeProgramToFile(BytecodeFile.toString(), M)) {
	std::cerr << ToolName << ": Error emitting bytecode to file '"
	<< BytecodeFile << "'!\n";
	exit(1);
	}

	// Remove the temporary bytecode file when we are done.
	FileRemover BytecodeFileRemover(BytecodeFile);

	// Actually compile the program!
	Interpreter->compileProgram(BytecodeFile.toString());
	}


	/// executeProgram - This method runs "Program", capturing the output of the
	/// program to a file, returning the filename of the file. A recommended
	/// filename may be optionally specified.
	///
	std::string BugDriver::executeProgram(std::string OutputFile,
	std::string BytecodeFile,
	const std::string &SharedObj,
	AbstractInterpreter *AI,
	bool *ProgramExitedNonzero) {
	if (AI == 0) AI = Interpreter;
	assert(AI && "Interpreter should have been created already!");
	bool CreatedBytecode = false;
	if (BytecodeFile.empty()) {
	// Emit the program to a bytecode file...
	sys::Path uniqueFilename("bugpoint-test-program.bc");
	uniqueFilename.makeUnique();
	BytecodeFile = uniqueFilename.toString();

	if (writeProgramToFile(BytecodeFile, Program)) {
	std::cerr << ToolName << ": Error emitting bytecode to file '"
	<< BytecodeFile << "'!\n";
	exit(1);
	}
	CreatedBytecode = true;
	}

	// Remove the temporary bytecode file when we are done.
	sys::Path BytecodePath (BytecodeFile);
	FileRemover BytecodeFileRemover(BytecodePath, CreatedBytecode);

	if (OutputFile.empty()) OutputFile = "bugpoint-execution-output";

	// Check to see if this is a valid output filename...
	sys::Path uniqueFile(OutputFile);
	uniqueFile.makeUnique();
	OutputFile = uniqueFile.toString();

	// Figure out which shared objects to run, if any.
	std::vector<std::string> SharedObjs(AdditionalSOs);
	if (!SharedObj.empty())
	SharedObjs.push_back(SharedObj);

	// Actually execute the program!
	int RetVal = AI->ExecuteProgram(BytecodeFile, InputArgv, InputFile,
	OutputFile, SharedObjs, TimeoutValue);

	if (RetVal == -1) {
	std::cerr << "<timeout>";
	static bool FirstTimeout = true;
	if (FirstTimeout) {
	std::cout << "\n"
	"*** Program execution timed out! This mechanism is designed to handle\n"
	" programs stuck in infinite loops gracefully. The -timeout option\n"
	" can be used to change the timeout threshold or disable it completely\n"
	" (with -timeout=0). This message is only displayed once.\n";
	FirstTimeout = false;
	}
	}

	if (ProgramExitedNonzero != 0)
	*ProgramExitedNonzero = (RetVal != 0);

	// Return the filename we captured the output to.
	return OutputFile;
	}

	/// executeProgramWithCBE - Used to create reference output with the C
	/// backend, if reference output is not provided.
	///
	std::string BugDriver::executeProgramWithCBE(std::string OutputFile) {
	bool ProgramExitedNonzero;
	std::string outFN = executeProgram(OutputFile, "", "",
	(AbstractInterpreter*)cbe,
	&ProgramExitedNonzero);
	if (ProgramExitedNonzero) {
	std::cerr
	<< "Warning: While generating reference output, program exited with\n"
	<< "non-zero exit code. This will NOT be treated as a failure.\n";
	CheckProgramExitCode = false;
	}
	return outFN;
	}

	std::string BugDriver::compileSharedObject(const std::string &BytecodeFile) {
	assert(Interpreter && "Interpreter should have been created already!");
	sys::Path OutputCFile;

	// Using CBE
	cbe->OutputC(BytecodeFile, OutputCFile);

	#if 0 /* This is an alternative, as yet unimplemented */
	// Using LLC
	std::string Message;
	LLC *llc = createLLCtool(Message);
	if (llc->OutputAsm(BytecodeFile, OutputFile)) {
	std::cerr << "Could not generate asm code with `llc', exiting.\n";
	exit(1);
	}
	#endif

	std::string SharedObjectFile;
	if (gcc->MakeSharedObject(OutputCFile.toString(), GCC::CFile,
	SharedObjectFile))
	exit(1);

	// Remove the intermediate C file
	OutputCFile.eraseFromDisk();

	return "./" + SharedObjectFile;
	}


	/// diffProgram - This method executes the specified module and diffs the output
	/// against the file specified by ReferenceOutputFile. If the output is
	/// different, true is returned.
	///
	bool BugDriver::diffProgram(const std::string &BytecodeFile,
	const std::string &SharedObject,
	bool RemoveBytecode) {
	bool ProgramExitedNonzero;

	// Execute the program, generating an output file...
	sys::Path Output (executeProgram("", BytecodeFile, SharedObject, 0,
	&ProgramExitedNonzero));

	// If we're checking the program exit code, assume anything nonzero is bad.
	if (CheckProgramExitCode && ProgramExitedNonzero) {
	Output.eraseFromDisk();
	if (RemoveBytecode)
	sys::Path(BytecodeFile).eraseFromDisk();
	return true;
	}

	std::string Error;
	bool FilesDifferent = false;
	if (int Diff = DiffFilesWithTolerance(sys::Path(ReferenceOutputFile),
	sys::Path(Output.toString()),
	AbsTolerance, RelTolerance, &Error)) {
	if (Diff == 2) {
	std::cerr << "While diffing output: " << Error << '\n';
	exit(1);
	}
	FilesDifferent = true;
	}

	// Remove the generated output.
	Output.eraseFromDisk();

	// Remove the bytecode file if we are supposed to.
	if (RemoveBytecode)
	sys::Path(BytecodeFile).eraseFromDisk();
	return FilesDifferent;
	}

	bool BugDriver::isExecutingJIT() {
	return InterpreterSel == RunJIT;
	}