include/llvm/Support/ToolRunner.h

   1 //===-- Support/ToolRunner.h ------------------------------------*- C++ -*-===//
   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 file exposes an abstraction around a platform C compiler, used to
  11 // compile C and assembly code.  It also exposes an "AbstractIntepreter"
  12 // interface, which is used to execute code using one of the LLVM execution
  13 // engines.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef TOOLRUNNER_H
  18 #define TOOLRUNNER_H
  19
  20 #include "Support/SystemUtils.h"
  21 #include <exception>
  22 #include <vector>
  23
  24 namespace llvm {
  25
  26 class CBE;
  27 class LLC;
  28
  29
  30 /// ToolExecutionError - An instance of this class is thrown by the
  31 /// AbstractInterpreter instances if there is an error running a tool (e.g., LLC
  32 /// crashes) which prevents execution of the program.
  33 ///
  34 class ToolExecutionError : std::exception {
  35   std::string Message;
  36 public:
  37   explicit ToolExecutionError(const std::string &M) : Message(M) {}
  38   virtual ~ToolExecutionError() throw();
  39   virtual const char* what() const throw() { return Message.c_str(); }
  40 };
  41
  42
  43 //===---------------------------------------------------------------------===//
  44 // GCC abstraction
  45 //
  46 class GCC {
  47   std::string GCCPath;          // The path to the gcc executable
  48   GCC(const std::string &gccPath) : GCCPath(gccPath) { }
  49 public:
  50   enum FileType { AsmFile, CFile };
  51
  52   static GCC* create(const std::string &ProgramPath, std::string &Message);
  53
  54   /// ExecuteProgram - Execute the program specified by "ProgramFile" (which is
  55   /// either a .s file, or a .c file, specified by FileType), with the specified
  56   /// arguments.  Standard input is specified with InputFile, and standard
  57   /// Output is captured to the specified OutputFile location.  The SharedLibs
  58   /// option specifies optional native shared objects that can be loaded into
  59   /// the program for execution.
  60   ///
  61   int ExecuteProgram(const std::string &ProgramFile,
  62                      const std::vector<std::string> &Args,
  63                      FileType fileType,
  64                      const std::string &InputFile,
  65                      const std::string &OutputFile,
  66                      const std::vector<std::string> &SharedLibs =
  67                          std::vector<std::string>(), unsigned Timeout = 0);
  68
  69   /// MakeSharedObject - This compiles the specified file (which is either a .c
  70   /// file or a .s file) into a shared object.
  71   ///
  72   int MakeSharedObject(const std::string &InputFile, FileType fileType,
  73                        std::string &OutputFile);
  74 };
  75
  76
  77 //===---------------------------------------------------------------------===//
  78 /// AbstractInterpreter Class - Subclasses of this class are used to execute
  79 /// LLVM bytecode in a variety of ways.  This abstract interface hides this
  80 /// complexity behind a simple interface.
  81 ///
  82 struct AbstractInterpreter {
  83   static CBE *createCBE(const std::string &ProgramPath, std::string &Message,
  84                         const std::vector<std::string> *Args = 0);
  85   static LLC *createLLC(const std::string &ProgramPath, std::string &Message,
  86                         const std::vector<std::string> *Args = 0);
  87
  88   static AbstractInterpreter* createLLI(const std::string &ProgramPath,
  89                                         std::string &Message,
  90                                         const std::vector<std::string> *Args=0);
  91
  92   static AbstractInterpreter* createJIT(const std::string &ProgramPath,
  93                                         std::string &Message,
  94                                         const std::vector<std::string> *Args=0);
  95
  96
  97   virtual ~AbstractInterpreter() {}
  98
  99   /// compileProgram - Compile the specified program from bytecode to executable
 100   /// code.  This does not produce any output, it is only used when debugging
 101   /// the code generator.  If the code generator fails, an exception should be
 102   /// thrown, otherwise, this function will just return.
 103   virtual void compileProgram(const std::string &Bytecode) {}
 104
 105   /// ExecuteProgram - Run the specified bytecode file, emitting output to the
 106   /// specified filename.  This returns the exit code of the program.
 107   ///
 108   virtual int ExecuteProgram(const std::string &Bytecode,
 109                              const std::vector<std::string> &Args,
 110                              const std::string &InputFile,
 111                              const std::string &OutputFile,
 112                              const std::vector<std::string> &SharedLibs =
 113                                std::vector<std::string>(),
 114                              unsigned Timeout = 0) = 0;
 115 };
 116
 117 //===---------------------------------------------------------------------===//
 118 // CBE Implementation of AbstractIntepreter interface
 119 //
 120 class CBE : public AbstractInterpreter {
 121   std::string LLCPath;          // The path to the `llc' executable
 122   std::vector<std::string> ToolArgs; // Extra args to pass to LLC
 123   GCC *gcc;
 124 public:
 125   CBE(const std::string &llcPath, GCC *Gcc,
 126       const std::vector<std::string> *Args) : LLCPath(llcPath), gcc(Gcc) {
 127     ToolArgs.clear ();
 128     if (Args) { ToolArgs = *Args; }
 129   }
 130   ~CBE() { delete gcc; }
 131
 132   /// compileProgram - Compile the specified program from bytecode to executable
 133   /// code.  This does not produce any output, it is only used when debugging
 134   /// the code generator.  If the code generator fails, an exception should be
 135   /// thrown, otherwise, this function will just return.
 136   virtual void compileProgram(const std::string &Bytecode);
 137
 138   virtual int ExecuteProgram(const std::string &Bytecode,
 139                              const std::vector<std::string> &Args,
 140                              const std::string &InputFile,
 141                              const std::string &OutputFile,
 142                              const std::vector<std::string> &SharedLibs =
 143                                std::vector<std::string>(),
 144                              unsigned Timeout = 0);
 145
 146   // Sometimes we just want to go half-way and only generate the .c file, not
 147   // necessarily compile it with GCC and run the program.  This throws an
 148   // exception if LLC crashes.
 149   //
 150   virtual void OutputC(const std::string &Bytecode, std::string &OutputCFile);
 151 };
 152
 153
 154 //===---------------------------------------------------------------------===//
 155 // LLC Implementation of AbstractIntepreter interface
 156 //
 157 class LLC : public AbstractInterpreter {
 158   std::string LLCPath;          // The path to the LLC executable
 159   std::vector<std::string> ToolArgs; // Extra args to pass to LLC
 160   GCC *gcc;
 161 public:
 162   LLC(const std::string &llcPath, GCC *Gcc,
 163     const std::vector<std::string> *Args) : LLCPath(llcPath), gcc(Gcc) {
 164     ToolArgs.clear ();
 165     if (Args) { ToolArgs = *Args; }
 166   }
 167   ~LLC() { delete gcc; }
 168
 169   /// compileProgram - Compile the specified program from bytecode to executable
 170   /// code.  This does not produce any output, it is only used when debugging
 171   /// the code generator.  If the code generator fails, an exception should be
 172   /// thrown, otherwise, this function will just return.
 173   virtual void compileProgram(const std::string &Bytecode);
 174
 175   virtual int ExecuteProgram(const std::string &Bytecode,
 176                              const std::vector<std::string> &Args,
 177                              const std::string &InputFile,
 178                              const std::string &OutputFile,
 179                              const std::vector<std::string> &SharedLibs =
 180                                 std::vector<std::string>(),
 181                              unsigned Timeout = 0);
 182
 183   // Sometimes we just want to go half-way and only generate the .s file,
 184   // not necessarily compile it all the way and run the program.  This throws
 185   // an exception if execution of LLC fails.
 186   //
 187   void OutputAsm(const std::string &Bytecode, std::string &OutputAsmFile);
 188 };
 189
 190 } // End llvm namespace
 191
 192 #endif