231 lines
9.8 KiB
C++
231 lines
9.8 KiB
C++
//===-- tools/bugpoint/ToolRunner.h -----------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file exposes an abstraction around a platform C compiler, used to
|
|
// compile C and assembly code. It also exposes an "AbstractIntepreter"
|
|
// interface, which is used to execute code using one of the LLVM execution
|
|
// engines.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef BUGPOINT_TOOLRUNNER_H
|
|
#define BUGPOINT_TOOLRUNNER_H
|
|
|
|
#include "llvm/Support/SystemUtils.h"
|
|
#include <exception>
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
|
|
class CBE;
|
|
class LLC;
|
|
|
|
/// ToolExecutionError - An instance of this class is thrown by the
|
|
/// AbstractInterpreter instances if there is an error running a tool (e.g., LLC
|
|
/// crashes) which prevents execution of the program.
|
|
///
|
|
class ToolExecutionError : std::exception {
|
|
std::string Message;
|
|
public:
|
|
explicit ToolExecutionError(const std::string &M) : Message(M) {}
|
|
virtual ~ToolExecutionError() throw();
|
|
virtual const char* what() const throw() { return Message.c_str(); }
|
|
};
|
|
|
|
|
|
//===---------------------------------------------------------------------===//
|
|
// GCC abstraction
|
|
//
|
|
class GCC {
|
|
sys::Path GCCPath; // The path to the gcc executable.
|
|
sys::Path RemoteClientPath; // The path to the rsh / ssh executable.
|
|
std::vector<std::string> gccArgs; // GCC-specific arguments.
|
|
GCC(const sys::Path &gccPath, const sys::Path &RemotePath,
|
|
const std::vector<std::string> *GCCArgs)
|
|
: GCCPath(gccPath), RemoteClientPath(RemotePath) {
|
|
if (GCCArgs) gccArgs = *GCCArgs;
|
|
}
|
|
public:
|
|
enum FileType { AsmFile, CFile };
|
|
|
|
static GCC *create(const std::string &ProgramPath, std::string &Message,
|
|
const std::vector<std::string> *Args);
|
|
|
|
/// ExecuteProgram - Execute the program specified by "ProgramFile" (which is
|
|
/// either a .s file, or a .c file, specified by FileType), with the specified
|
|
/// arguments. Standard input is specified with InputFile, and standard
|
|
/// Output is captured to the specified OutputFile location. The SharedLibs
|
|
/// option specifies optional native shared objects that can be loaded into
|
|
/// the program for execution.
|
|
///
|
|
int ExecuteProgram(const std::string &ProgramFile,
|
|
const std::vector<std::string> &Args,
|
|
FileType fileType,
|
|
const std::string &InputFile,
|
|
const std::string &OutputFile,
|
|
const std::vector<std::string> &GCCArgs =
|
|
std::vector<std::string>(),
|
|
unsigned Timeout = 0,
|
|
unsigned MemoryLimit = 0);
|
|
|
|
/// MakeSharedObject - This compiles the specified file (which is either a .c
|
|
/// file or a .s file) into a shared object.
|
|
///
|
|
int MakeSharedObject(const std::string &InputFile, FileType fileType,
|
|
std::string &OutputFile,
|
|
const std::vector<std::string> &ArgsForGCC);
|
|
};
|
|
|
|
|
|
//===---------------------------------------------------------------------===//
|
|
/// AbstractInterpreter Class - Subclasses of this class are used to execute
|
|
/// LLVM bitcode in a variety of ways. This abstract interface hides this
|
|
/// complexity behind a simple interface.
|
|
///
|
|
class AbstractInterpreter {
|
|
public:
|
|
static CBE *createCBE(const std::string &ProgramPath, std::string &Message,
|
|
const std::vector<std::string> *Args = 0,
|
|
const std::vector<std::string> *GCCArgs = 0);
|
|
static LLC *createLLC(const std::string &ProgramPath, std::string &Message,
|
|
const std::vector<std::string> *Args = 0,
|
|
const std::vector<std::string> *GCCArgs = 0);
|
|
|
|
static AbstractInterpreter* createLLI(const std::string &ProgramPath,
|
|
std::string &Message,
|
|
const std::vector<std::string> *Args=0);
|
|
|
|
static AbstractInterpreter* createJIT(const std::string &ProgramPath,
|
|
std::string &Message,
|
|
const std::vector<std::string> *Args=0);
|
|
|
|
static AbstractInterpreter* createCustom(const std::string &ProgramPath,
|
|
std::string &Message,
|
|
const std::string &ExecCommandLine);
|
|
|
|
|
|
virtual ~AbstractInterpreter() {}
|
|
|
|
/// compileProgram - Compile the specified program from bitcode to executable
|
|
/// code. This does not produce any output, it is only used when debugging
|
|
/// the code generator. If the code generator fails, an exception should be
|
|
/// thrown, otherwise, this function will just return.
|
|
virtual void compileProgram(const std::string &Bitcode) {}
|
|
|
|
/// OutputCode - Compile the specified program from bitcode to code
|
|
/// understood by the GCC driver (either C or asm). If the code generator
|
|
/// fails, an exception should be thrown, otherwise, this function returns the
|
|
/// type of code emitted.
|
|
virtual GCC::FileType OutputCode(const std::string &Bitcode,
|
|
sys::Path &OutFile) {
|
|
throw std::string("OutputCode not supported by this AbstractInterpreter!");
|
|
}
|
|
|
|
/// ExecuteProgram - Run the specified bitcode file, emitting output to the
|
|
/// specified filename. This returns the exit code of the program.
|
|
///
|
|
virtual int ExecuteProgram(const std::string &Bitcode,
|
|
const std::vector<std::string> &Args,
|
|
const std::string &InputFile,
|
|
const std::string &OutputFile,
|
|
const std::vector<std::string> &GCCArgs =
|
|
std::vector<std::string>(),
|
|
const std::vector<std::string> &SharedLibs =
|
|
std::vector<std::string>(),
|
|
unsigned Timeout = 0,
|
|
unsigned MemoryLimit = 0) = 0;
|
|
};
|
|
|
|
//===---------------------------------------------------------------------===//
|
|
// CBE Implementation of AbstractIntepreter interface
|
|
//
|
|
class CBE : public AbstractInterpreter {
|
|
sys::Path LLCPath; // The path to the `llc' executable.
|
|
std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
|
|
GCC *gcc;
|
|
public:
|
|
CBE(const sys::Path &llcPath, GCC *Gcc,
|
|
const std::vector<std::string> *Args)
|
|
: LLCPath(llcPath), gcc(Gcc) {
|
|
ToolArgs.clear ();
|
|
if (Args) ToolArgs = *Args;
|
|
}
|
|
~CBE() { delete gcc; }
|
|
|
|
/// compileProgram - Compile the specified program from bitcode to executable
|
|
/// code. This does not produce any output, it is only used when debugging
|
|
/// the code generator. If the code generator fails, an exception should be
|
|
/// thrown, otherwise, this function will just return.
|
|
virtual void compileProgram(const std::string &Bitcode);
|
|
|
|
virtual int ExecuteProgram(const std::string &Bitcode,
|
|
const std::vector<std::string> &Args,
|
|
const std::string &InputFile,
|
|
const std::string &OutputFile,
|
|
const std::vector<std::string> &GCCArgs =
|
|
std::vector<std::string>(),
|
|
const std::vector<std::string> &SharedLibs =
|
|
std::vector<std::string>(),
|
|
unsigned Timeout = 0,
|
|
unsigned MemoryLimit = 0);
|
|
|
|
/// OutputCode - Compile the specified program from bitcode to code
|
|
/// understood by the GCC driver (either C or asm). If the code generator
|
|
/// fails, an exception should be thrown, otherwise, this function returns the
|
|
/// type of code emitted.
|
|
virtual GCC::FileType OutputCode(const std::string &Bitcode,
|
|
sys::Path &OutFile);
|
|
};
|
|
|
|
|
|
//===---------------------------------------------------------------------===//
|
|
// LLC Implementation of AbstractIntepreter interface
|
|
//
|
|
class LLC : public AbstractInterpreter {
|
|
std::string LLCPath; // The path to the LLC executable.
|
|
std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
|
|
std::vector<std::string> gccArgs; // Extra args to pass to GCC.
|
|
GCC *gcc;
|
|
public:
|
|
LLC(const std::string &llcPath, GCC *Gcc,
|
|
const std::vector<std::string> *Args,
|
|
const std::vector<std::string> *GCCArgs)
|
|
: LLCPath(llcPath), gcc(Gcc) {
|
|
ToolArgs.clear();
|
|
if (Args) ToolArgs = *Args;
|
|
if (GCCArgs) gccArgs = *GCCArgs;
|
|
}
|
|
~LLC() { delete gcc; }
|
|
|
|
/// compileProgram - Compile the specified program from bitcode to executable
|
|
/// code. This does not produce any output, it is only used when debugging
|
|
/// the code generator. If the code generator fails, an exception should be
|
|
/// thrown, otherwise, this function will just return.
|
|
virtual void compileProgram(const std::string &Bitcode);
|
|
|
|
virtual int ExecuteProgram(const std::string &Bitcode,
|
|
const std::vector<std::string> &Args,
|
|
const std::string &InputFile,
|
|
const std::string &OutputFile,
|
|
const std::vector<std::string> &GCCArgs =
|
|
std::vector<std::string>(),
|
|
const std::vector<std::string> &SharedLibs =
|
|
std::vector<std::string>(),
|
|
unsigned Timeout = 0,
|
|
unsigned MemoryLimit = 0);
|
|
|
|
virtual GCC::FileType OutputCode(const std::string &Bitcode,
|
|
sys::Path &OutFile);
|
|
|
|
};
|
|
|
|
} // End llvm namespace
|
|
|
|
#endif
|