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(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 char *Argv0, std::string &Message,
  97                         const std::vector<std::string> *Args = 0,
  98                         const std::vector<std::string> *GCCArgs = 0);
  99   static LLC *createLLC(const char *Argv0, 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 char *Argv0, std::string &Message,
 104                                         const std::vector<std::string> *Args=0);
 105
 106   static AbstractInterpreter* createJIT(const char *Argv0, std::string &Message,
 107                                         const std::vector<std::string> *Args=0);
 108
 109   static AbstractInterpreter* createCustom(std::string &Message,
 110                                            const std::string &ExecCommandLine);
 111
 112
 113   virtual ~AbstractInterpreter() {}
 114
 115   /// compileProgram - Compile the specified program from bitcode to executable
 116   /// code.  This does not produce any output, it is only used when debugging
 117   /// the code generator.  If the code generator fails, an exception should be
 118   /// thrown, otherwise, this function will just return.
 119   virtual void compileProgram(const std::string &Bitcode) {}
 120
 121   /// OutputCode - Compile the specified program from bitcode to code
 122   /// understood by the GCC driver (either C or asm).  If the code generator
 123   /// fails, an exception should be thrown, otherwise, this function returns the
 124   /// type of code emitted.
 125   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 126                                    sys::Path &OutFile) {
 127     throw std::string("OutputCode not supported by this AbstractInterpreter!");
 128   }
 129
 130   /// ExecuteProgram - Run the specified bitcode file, emitting output to the
 131   /// specified filename.  This returns the exit code of the program.
 132   ///
 133   virtual int ExecuteProgram(const std::string &Bitcode,
 134                              const std::vector<std::string> &Args,
 135                              const std::string &InputFile,
 136                              const std::string &OutputFile,
 137                              const std::vector<std::string> &GCCArgs =
 138                                std::vector<std::string>(),
 139                              const std::vector<std::string> &SharedLibs =
 140                                std::vector<std::string>(),
 141                              unsigned Timeout = 0,
 142                              unsigned MemoryLimit = 0) = 0;
 143 };
 144
 145 //===---------------------------------------------------------------------===//
 146 // CBE Implementation of AbstractIntepreter interface
 147 //
 148 class CBE : public AbstractInterpreter {
 149   sys::Path LLCPath;                 // The path to the `llc' executable.
 150   std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
 151   GCC *gcc;
 152 public:
 153   CBE(const sys::Path &llcPath, GCC *Gcc,
 154       const std::vector<std::string> *Args)
 155     : LLCPath(llcPath), gcc(Gcc) {
 156     ToolArgs.clear ();
 157     if (Args) ToolArgs = *Args;
 158   }
 159   ~CBE() { delete gcc; }
 160
 161   /// compileProgram - Compile the specified program from bitcode to executable
 162   /// code.  This does not produce any output, it is only used when debugging
 163   /// the code generator.  If the code generator fails, an exception should be
 164   /// thrown, otherwise, this function will just return.
 165   virtual void compileProgram(const std::string &Bitcode);
 166
 167   virtual int ExecuteProgram(const std::string &Bitcode,
 168                              const std::vector<std::string> &Args,
 169                              const std::string &InputFile,
 170                              const std::string &OutputFile,
 171                              const std::vector<std::string> &GCCArgs =
 172                                std::vector<std::string>(),
 173                              const std::vector<std::string> &SharedLibs =
 174                                std::vector<std::string>(),
 175                              unsigned Timeout = 0,
 176                              unsigned MemoryLimit = 0);
 177
 178   /// OutputCode - Compile the specified program from bitcode to code
 179   /// understood by the GCC driver (either C or asm).  If the code generator
 180   /// fails, an exception should be thrown, otherwise, this function returns the
 181   /// type of code emitted.
 182   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 183                                    sys::Path &OutFile);
 184 };
 185
 186
 187 //===---------------------------------------------------------------------===//
 188 // LLC Implementation of AbstractIntepreter interface
 189 //
 190 class LLC : public AbstractInterpreter {
 191   std::string LLCPath;               // The path to the LLC executable.
 192   std::vector<std::string> ToolArgs; // Extra args to pass to LLC.
 193   std::vector<std::string> gccArgs;  // Extra args to pass to GCC.
 194   GCC *gcc;
 195 public:
 196   LLC(const std::string &llcPath, GCC *Gcc,
 197       const std::vector<std::string> *Args,
 198       const std::vector<std::string> *GCCArgs)
 199     : LLCPath(llcPath), gcc(Gcc) {
 200     ToolArgs.clear();
 201     if (Args) ToolArgs = *Args;
 202     if (GCCArgs) gccArgs = *GCCArgs;
 203   }
 204   ~LLC() { delete gcc; }
 205
 206   /// compileProgram - Compile the specified program from bitcode to executable
 207   /// code.  This does not produce any output, it is only used when debugging
 208   /// the code generator.  If the code generator fails, an exception should be
 209   /// thrown, otherwise, this function will just return.
 210   virtual void compileProgram(const std::string &Bitcode);
 211
 212   virtual int ExecuteProgram(const std::string &Bitcode,
 213                              const std::vector<std::string> &Args,
 214                              const std::string &InputFile,
 215                              const std::string &OutputFile,
 216                              const std::vector<std::string> &GCCArgs =
 217                                std::vector<std::string>(),
 218                              const std::vector<std::string> &SharedLibs =
 219                                 std::vector<std::string>(),
 220                              unsigned Timeout = 0,
 221                              unsigned MemoryLimit = 0);
 222
 223   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 224                                    sys::Path &OutFile);
 225
 226 };
 227
 228 } // End llvm namespace
 229
 230 #endif