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/ADT/Triple.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/SystemUtils.h"
  24 #include "llvm/System/Path.h"
  25 #include <exception>
  26 #include <vector>
  27
  28 namespace llvm {
  29
  30 extern cl::opt<bool> SaveTemps;
  31 extern Triple TargetTriple;
  32
  33 class CBE;
  34 class LLC;
  35
  36 //===---------------------------------------------------------------------===//
  37 // GCC abstraction
  38 //
  39 class GCC {
  40   sys::Path GCCPath;                // The path to the gcc executable.
  41   sys::Path RemoteClientPath;       // The path to the rsh / ssh executable.
  42   std::vector<std::string> gccArgs; // GCC-specific arguments.
  43   GCC(const sys::Path &gccPath, const sys::Path &RemotePath,
  44       const std::vector<std::string> *GCCArgs)
  45     : GCCPath(gccPath), RemoteClientPath(RemotePath) {
  46     if (GCCArgs) gccArgs = *GCCArgs;
  47   }
  48 public:
  49   enum FileType { AsmFile, ObjectFile, CFile };
  50
  51   static GCC *create(std::string &Message,
  52                      const std::string &GCCBinary,
  53                      const std::vector<std::string> *Args);
  54
  55   /// ExecuteProgram - Execute the program specified by "ProgramFile" (which is
  56   /// either a .s file, or a .c file, specified by FileType), with the specified
  57   /// arguments.  Standard input is specified with InputFile, and standard
  58   /// Output is captured to the specified OutputFile location.  The SharedLibs
  59   /// option specifies optional native shared objects that can be loaded into
  60   /// the program for execution.
  61   ///
  62   int ExecuteProgram(const std::string &ProgramFile,
  63                      const std::vector<std::string> &Args,
  64                      FileType fileType,
  65                      const std::string &InputFile,
  66                      const std::string &OutputFile,
  67                      std::string *Error = 0,
  68                      const std::vector<std::string> &GCCArgs =
  69                          std::vector<std::string>(),
  70                      unsigned Timeout = 0,
  71                      unsigned MemoryLimit = 0);
  72
  73   /// MakeSharedObject - This compiles the specified file (which is either a .c
  74   /// file or a .s file) into a shared object.
  75   ///
  76   int MakeSharedObject(const std::string &InputFile, FileType fileType,
  77                        std::string &OutputFile,
  78                        const std::vector<std::string> &ArgsForGCC,
  79                        std::string &Error);
  80 };
  81
  82
  83 //===---------------------------------------------------------------------===//
  84 /// AbstractInterpreter Class - Subclasses of this class are used to execute
  85 /// LLVM bitcode in a variety of ways.  This abstract interface hides this
  86 /// complexity behind a simple interface.
  87 ///
  88 class AbstractInterpreter {
  89 public:
  90   static CBE *createCBE(const char *Argv0, std::string &Message,
  91                         const std::string              &GCCBinary,
  92                         const std::vector<std::string> *Args = 0,
  93                         const std::vector<std::string> *GCCArgs = 0);
  94   static LLC *createLLC(const char *Argv0, std::string &Message,
  95                         const std::string              &GCCBinary,
  96                         const std::vector<std::string> *Args = 0,
  97                         const std::vector<std::string> *GCCArgs = 0,
  98                         bool UseIntegratedAssembler = false);
  99
 100   static AbstractInterpreter* createLLI(const char *Argv0, std::string &Message,
 101                                         const std::vector<std::string> *Args=0);
 102
 103   static AbstractInterpreter* createJIT(const char *Argv0, std::string &Message,
 104                                         const std::vector<std::string> *Args=0);
 105
 106   static AbstractInterpreter* createCustom(std::string &Message,
 107                                            const std::string &ExecCommandLine);
 108
 109
 110   virtual ~AbstractInterpreter() {}
 111
 112   /// compileProgram - Compile the specified program from bitcode to executable
 113   /// code.  This does not produce any output, it is only used when debugging
 114   /// the code generator.  It returns false if the code generator fails.
 115   virtual void compileProgram(const std::string &Bitcode, std::string *Error) {}
 116
 117   /// OutputCode - Compile the specified program from bitcode to code
 118   /// understood by the GCC driver (either C or asm).  If the code generator
 119   /// fails, it sets Error, otherwise, this function returns the type of code
 120   /// emitted.
 121   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 122                                    sys::Path &OutFile, std::string &Error) {
 123     Error = "OutputCode not supported by this AbstractInterpreter!";
 124     return GCC::AsmFile;
 125   }
 126
 127   /// ExecuteProgram - Run the specified bitcode file, emitting output to the
 128   /// specified filename.  This sets RetVal to the exit code of the program or
 129   /// returns false if a problem was encountered that prevented execution of
 130   /// the program.
 131   ///
 132   virtual int ExecuteProgram(const std::string &Bitcode,
 133                              const std::vector<std::string> &Args,
 134                              const std::string &InputFile,
 135                              const std::string &OutputFile,
 136                              std::string *Error,
 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.  Returns false if the code generator fails.
 164   virtual void compileProgram(const std::string &Bitcode, std::string *Error);
 165
 166   virtual int ExecuteProgram(const std::string &Bitcode,
 167                              const std::vector<std::string> &Args,
 168                              const std::string &InputFile,
 169                              const std::string &OutputFile,
 170                              std::string *Error,
 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, it sets Error, otherwise, this function returns the type of code
 181   /// emitted.
 182   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 183                                    sys::Path &OutFile, std::string &Error);
 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   GCC *gcc;
 194   bool UseIntegratedAssembler;
 195 public:
 196   LLC(const std::string &llcPath, GCC *Gcc,
 197       const std::vector<std::string> *Args,
 198       bool useIntegratedAssembler)
 199     : LLCPath(llcPath), gcc(Gcc),
 200       UseIntegratedAssembler(useIntegratedAssembler) {
 201     ToolArgs.clear();
 202     if (Args) ToolArgs = *Args;
 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.  Returns false if the code generator fails.
 209   virtual void compileProgram(const std::string &Bitcode, std::string *Error);
 210
 211   virtual int ExecuteProgram(const std::string &Bitcode,
 212                              const std::vector<std::string> &Args,
 213                              const std::string &InputFile,
 214                              const std::string &OutputFile,
 215                              std::string *Error,
 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   /// OutputCode - Compile the specified program from bitcode to code
 224   /// understood by the GCC driver (either C or asm).  If the code generator
 225   /// fails, it sets Error, otherwise, this function returns the type of code
 226   /// emitted.
 227   virtual GCC::FileType OutputCode(const std::string &Bitcode,
 228                                    sys::Path &OutFile, std::string &Error);
 229 };
 230
 231 } // End llvm namespace
 232
 233 #endif