tools/bugpoint/ToolRunner.h

   1 //===-- tools/bugpoint/ToolRunner.h -----------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 BUGPOINT_TOOLRUNNER_H
  18 #define BUGPOINT_TOOLRUNNER_H
  19
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/SystemUtils.h"
  22 #include <exception>
  23 #include <vector>
  24
  25 namespace llvm {
  26
  27 extern cl::opt<bool> SaveTemps;
  28
  29 class CBE;
  30 class LLC;
  31
  32 /// ToolExecutionError - An instance of this class is thrown by the
  33 /// AbstractInterpreter instances if there is an error running a tool (e.g., LLC
  34 /// crashes) which prevents execution of the program.
  35 ///
  36 class ToolExecutionError : std::exception {
  37   std::string Message;
  38 public:
  39   explicit ToolExecutionError(const std::string &M) : Message(M) {}
  40   virtual ~ToolExecutionError() throw();
  41   virtual const char* what() const throw() { return Message.c_str(); }
  42 };
  43
  44
  45 //===---------------------------------------------------------------------===//
  46 // GCC abstraction
  47 //
  48 class GCC {
  49   sys::Path GCCPath;                // The path to the gcc executable.
  50   sys::Path RemoteClientPath;       // The path to the rsh / ssh executable.
  51   std::vector<std::string> gccArgs; // GCC-specific arguments.
  52   GCC(const sys::Path &gccPath, const sys::Path &RemotePath,
  53       const std::vector<std::string> *GCCArgs)
  54     : GCCPath(gccPath), RemoteClientPath(RemotePath) {
  55     if (GCCArgs) gccArgs = *GCCArgs;
  56   }
  57 public:
  58   enum FileType { AsmFile, CFile };
  59
  60   static GCC *create(const std::string &ProgramPath, std::string &Message,
  61                      const std::vector<std::string> *Args);
  62
  63   /// ExecuteProgram - Execute the program specified by "ProgramFile" (which is
  64   /// either a .s file, or a .c file, specified by FileType), with the specified
  65   /// arguments.  Standard input is specified with InputFile, and standard
  66   /// Output is captured to the specified OutputFile location.  The SharedLibs
  67   /// option specifies optional native shared objects that can be loaded into
  68   /// the program for execution.
  69   ///
  70   int ExecuteProgram(const std::string &ProgramFile,
  71                      const std::vector<std::string> &Args,
  72                      FileType fileType,
  73                      const std::string &InputFile,
  74                      const std::string &OutputFile,
  75                      const std::vector<std::string> &GCCArgs =
  76                          std::vector<std::string>(),
  77                      unsigned Timeout = 0,
  78                      unsigned MemoryLimit = 0);
  79
  80   /// MakeSharedObject - This compiles the specified file (which is either a .c
  81   /// file or a .s file) into a shared object.
  82   ///
  83   int MakeSharedObject(const std::string &InputFile, FileType fileType,
  84                        std::string &OutputFile,
  85                        const std::vector<std::string> &ArgsForGCC);
  86 };
  87
  88
  89 //===---------------------------------------------------------------------===//
  90 /// AbstractInterpreter Class - Subclasses of this class are used to execute
  91 /// LLVM bitcode in a variety of ways.  This abstract interface hides this
  92 /// complexity behind a simple interface.
  93 ///
  94 class AbstractInterpreter {
  95 public:
  96   static CBE *createCBE(const std::string &ProgramPath, std::string &Message,
  97                         const std::vector<std::string> *Args = 0,
  98                         const std::vector<std::string> *GCCArgs = 0);
  99   static LLC *createLLC(const std::string &ProgramPath, std::string &Message,
 100                         const std::vector<std::string> *Args = 0,
 101                         const std::vector<std::string> *GCCArgs = 0);
 102
 103   static AbstractInterpreter* createLLI(const std::string &ProgramPath,
 104                                         std::string &Message,
 105                                         const std::vector<std::string> *Args=0);
 106
 107   static AbstractInterpreter* createJIT(const std::string &ProgramPath,
 108                                         std::string &Message,
 109                                         const std::vector<std::string> *Args=0);
 110
 111   static AbstractInterpreter* createCustom(const std::string &ProgramPath,
 112                                            std::string &Message,
 113                                            const std::string &ExecCommandLine);
 114
 115
 116   virtual ~AbstractInterpreter() {}
 117
 118   /// compileProgram - Compile the specified program from bitcode to executable
 119   /// code.  This does not produce any output, it is only used when debugging
 120   /// the code generator.  If the code generator fails, an exception should be
 121   /// thrown, otherwise, this function will just return.
 122   virtual void compileProgram(const std::string &Bitcode) {}
 123
 124   /// OutputCode - Compile the specified program from bitcode to code
 125   /// understood by the GCC driver (either C or asm).  If the code generator
 126   /// fails, an exception should be thrown, otherwise, this function returns the
 127   /// type of code emitted.
 128   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 129                                    sys::Path &OutFile) {
 130     throw std::string("OutputCode not supported by this AbstractInterpreter!");
 131   }
 132
 133   /// ExecuteProgram - Run the specified bitcode file, emitting output to the
 134   /// specified filename.  This returns the exit code of the program.
 135   ///
 136   virtual int ExecuteProgram(const std::string &Bitcode,
 137                              const std::vector<std::string> &Args,
 138                              const std::string &InputFile,
 139                              const std::string &OutputFile,
 140                              const std::vector<std::string> &GCCArgs =
 141                                std::vector<std::string>(),
 142                              const std::vector<std::string> &SharedLibs =
 143                                std::vector<std::string>(),
 144                              unsigned Timeout = 0,
 145                              unsigned MemoryLimit = 0) = 0;
 146 };
 147
 148 //===---------------------------------------------------------------------===//
 149 // CBE Implementation of AbstractIntepreter interface
 150 //
 151 class CBE : public AbstractInterpreter {
 152   sys::Path LLCPath;                 // The path to the `llc' executable.
 153   std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
 154   GCC *gcc;
 155 public:
 156   CBE(const sys::Path &llcPath, GCC *Gcc,
 157       const std::vector<std::string> *Args)
 158     : LLCPath(llcPath), gcc(Gcc) {
 159     ToolArgs.clear ();
 160     if (Args) ToolArgs = *Args;
 161   }
 162   ~CBE() { delete gcc; }
 163
 164   /// compileProgram - Compile the specified program from bitcode to executable
 165   /// code.  This does not produce any output, it is only used when debugging
 166   /// the code generator.  If the code generator fails, an exception should be
 167   /// thrown, otherwise, this function will just return.
 168   virtual void compileProgram(const std::string &Bitcode);
 169
 170   virtual int ExecuteProgram(const std::string &Bitcode,
 171                              const std::vector<std::string> &Args,
 172                              const std::string &InputFile,
 173                              const std::string &OutputFile,
 174                              const std::vector<std::string> &GCCArgs =
 175                                std::vector<std::string>(),
 176                              const std::vector<std::string> &SharedLibs =
 177                                std::vector<std::string>(),
 178                              unsigned Timeout = 0,
 179                              unsigned MemoryLimit = 0);
 180
 181   /// OutputCode - Compile the specified program from bitcode to code
 182   /// understood by the GCC driver (either C or asm).  If the code generator
 183   /// fails, an exception should be thrown, otherwise, this function returns the
 184   /// type of code emitted.
 185   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 186                                    sys::Path &OutFile);
 187 };
 188
 189
 190 //===---------------------------------------------------------------------===//
 191 // LLC Implementation of AbstractIntepreter interface
 192 //
 193 class LLC : public AbstractInterpreter {
 194   std::string LLCPath;               // The path to the LLC executable.
 195   std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
 196   std::vector<std::string> gccArgs;  // Extra args to pass to GCC.
 197   GCC *gcc;
 198 public:
 199   LLC(const std::string &llcPath, GCC *Gcc,
 200       const std::vector<std::string> *Args,
 201       const std::vector<std::string> *GCCArgs)
 202     : LLCPath(llcPath), gcc(Gcc) {
 203     ToolArgs.clear();
 204     if (Args) ToolArgs = *Args;
 205     if (GCCArgs) gccArgs = *GCCArgs;
 206   }
 207   ~LLC() { delete gcc; }
 208
 209   /// compileProgram - Compile the specified program from bitcode to executable
 210   /// code.  This does not produce any output, it is only used when debugging
 211   /// the code generator.  If the code generator fails, an exception should be
 212   /// thrown, otherwise, this function will just return.
 213   virtual void compileProgram(const std::string &Bitcode);
 214
 215   virtual int ExecuteProgram(const std::string &Bitcode,
 216                              const std::vector<std::string> &Args,
 217                              const std::string &InputFile,
 218                              const std::string &OutputFile,
 219                              const std::vector<std::string> &GCCArgs =
 220                                std::vector<std::string>(),
 221                              const std::vector<std::string> &SharedLibs =
 222                                 std::vector<std::string>(),
 223                              unsigned Timeout = 0,
 224                              unsigned MemoryLimit = 0);
 225
 226   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 227                                    sys::Path &OutFile);
 228
 229 };
 230
 231 } // End llvm namespace
 232
 233 #endif