include/llvm/ExecutionEngine/ExecutionEngine.h

   1 //===- ExecutionEngine.h - Abstract Execution Engine Interface --*- 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 defines the abstract interface that implements execution support
  11 // for LLVM.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_EXECUTION_ENGINE_H
  16 #define LLVM_EXECUTION_ENGINE_H
  17
  18 #include <vector>
  19 #include <map>
  20 #include <string>
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/ADT/ValueMap.h"
  23 #include "llvm/Support/ValueHandle.h"
  24 #include "llvm/System/Mutex.h"
  25 #include "llvm/Target/TargetMachine.h"
  26
  27 namespace llvm {
  28
  29 struct GenericValue;
  30 class Constant;
  31 class ExecutionEngine;
  32 class Function;
  33 class GlobalVariable;
  34 class GlobalValue;
  35 class JITEventListener;
  36 class JITMemoryManager;
  37 class MachineCodeInfo;
  38 class Module;
  39 class ModuleProvider;
  40 class MutexGuard;
  41 class TargetData;
  42 class Type;
  43
  44 class ExecutionEngineState {
  45 public:
  46   struct AddressMapConfig : public ValueMapConfig<const GlobalValue*> {
  47     typedef ExecutionEngineState *ExtraData;
  48     static sys::Mutex *getMutex(ExecutionEngineState *EES);
  49     static void onDelete(ExecutionEngineState *EES, const GlobalValue *Old);
  50     static void onRAUW(ExecutionEngineState *, const GlobalValue *,
  51                        const GlobalValue *);
  52   };
  53
  54   typedef ValueMap<const GlobalValue *, void *, AddressMapConfig>
  55       GlobalAddressMapTy;
  56
  57 private:
  58   ExecutionEngine &EE;
  59
  60   /// GlobalAddressMap - A mapping between LLVM global values and their
  61   /// actualized version...
  62   GlobalAddressMapTy GlobalAddressMap;
  63
  64   /// GlobalAddressReverseMap - This is the reverse mapping of GlobalAddressMap,
  65   /// used to convert raw addresses into the LLVM global value that is emitted
  66   /// at the address.  This map is not computed unless getGlobalValueAtAddress
  67   /// is called at some point.
  68   std::map<void *, AssertingVH<const GlobalValue> > GlobalAddressReverseMap;
  69
  70 public:
  71   ExecutionEngineState(ExecutionEngine &EE);
  72
  73   GlobalAddressMapTy &
  74   getGlobalAddressMap(const MutexGuard &) {
  75     return GlobalAddressMap;
  76   }
  77
  78   std::map<void*, AssertingVH<const GlobalValue> > &
  79   getGlobalAddressReverseMap(const MutexGuard &) {
  80     return GlobalAddressReverseMap;
  81   }
  82
  83   // Returns the address ToUnmap was mapped to.
  84   void *RemoveMapping(const MutexGuard &, const GlobalValue *ToUnmap);
  85 };
  86
  87
  88 class ExecutionEngine {
  89   const TargetData *TD;
  90   ExecutionEngineState EEState;
  91   bool LazyCompilationDisabled;
  92   bool GVCompilationDisabled;
  93   bool SymbolSearchingDisabled;
  94   bool DlsymStubsEnabled;
  95
  96   friend class EngineBuilder;  // To allow access to JITCtor and InterpCtor.
  97
  98 protected:
  99   /// Modules - This is a list of ModuleProvider's that we are JIT'ing from.  We
 100   /// use a smallvector to optimize for the case where there is only one module.
 101   SmallVector<ModuleProvider*, 1> Modules;
 102
 103   void setTargetData(const TargetData *td) {
 104     TD = td;
 105   }
 106
 107   /// getMemoryforGV - Allocate memory for a global variable.
 108   virtual char* getMemoryForGV(const GlobalVariable* GV);
 109
 110   // To avoid having libexecutionengine depend on the JIT and interpreter
 111   // libraries, the JIT and Interpreter set these functions to ctor pointers
 112   // at startup time if they are linked in.
 113   static ExecutionEngine *(*JITCtor)(ModuleProvider *MP,
 114                                      std::string *ErrorStr,
 115                                      JITMemoryManager *JMM,
 116                                      CodeGenOpt::Level OptLevel,
 117                                      bool GVsWithCode);
 118   static ExecutionEngine *(*InterpCtor)(ModuleProvider *MP,
 119                                         std::string *ErrorStr);
 120
 121   /// LazyFunctionCreator - If an unknown function is needed, this function
 122   /// pointer is invoked to create it. If this returns null, the JIT will abort.
 123   void* (*LazyFunctionCreator)(const std::string &);
 124
 125   /// ExceptionTableRegister - If Exception Handling is set, the JIT will
 126   /// register dwarf tables with this function
 127   typedef void (*EERegisterFn)(void*);
 128   static EERegisterFn ExceptionTableRegister;
 129
 130 public:
 131   /// lock - This lock is protects the ExecutionEngine, JIT, JITResolver and
 132   /// JITEmitter classes.  It must be held while changing the internal state of
 133   /// any of those classes.
 134   sys::Mutex lock; // Used to make this class and subclasses thread-safe
 135
 136   //===--------------------------------------------------------------------===//
 137   //  ExecutionEngine Startup
 138   //===--------------------------------------------------------------------===//
 139
 140   virtual ~ExecutionEngine();
 141
 142   /// create - This is the factory method for creating an execution engine which
 143   /// is appropriate for the current machine.  This takes ownership of the
 144   /// module provider.
 145   static ExecutionEngine *create(ModuleProvider *MP,
 146                                  bool ForceInterpreter = false,
 147                                  std::string *ErrorStr = 0,
 148                                  CodeGenOpt::Level OptLevel =
 149                                    CodeGenOpt::Default,
 150                                  // Allocating globals with code breaks
 151                                  // freeMachineCodeForFunction and is probably
 152                                  // unsafe and bad for performance.  However,
 153                                  // we have clients who depend on this
 154                                  // behavior, so we must support it.
 155                                  // Eventually, when we're willing to break
 156                                  // some backwards compatability, this flag
 157                                  // should be flipped to false, so that by
 158                                  // default freeMachineCodeForFunction works.
 159                                  bool GVsWithCode = true);
 160
 161   /// create - This is the factory method for creating an execution engine which
 162   /// is appropriate for the current machine.  This takes ownership of the
 163   /// module.
 164   static ExecutionEngine *create(Module *M);
 165
 166   /// createJIT - This is the factory method for creating a JIT for the current
 167   /// machine, it does not fall back to the interpreter.  This takes ownership
 168   /// of the ModuleProvider and JITMemoryManager if successful.
 169   ///
 170   /// Clients should make sure to initialize targets prior to calling this
 171   /// function.
 172   static ExecutionEngine *createJIT(ModuleProvider *MP,
 173                                     std::string *ErrorStr = 0,
 174                                     JITMemoryManager *JMM = 0,
 175                                     CodeGenOpt::Level OptLevel =
 176                                       CodeGenOpt::Default,
 177                                     bool GVsWithCode = true);
 178
 179   /// addModuleProvider - Add a ModuleProvider to the list of modules that we
 180   /// can JIT from.  Note that this takes ownership of the ModuleProvider: when
 181   /// the ExecutionEngine is destroyed, it destroys the MP as well.
 182   virtual void addModuleProvider(ModuleProvider *P) {
 183     Modules.push_back(P);
 184   }
 185
 186   //===----------------------------------------------------------------------===//
 187
 188   const TargetData *getTargetData() const { return TD; }
 189
 190
 191   /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
 192   /// Relases the Module from the ModuleProvider, materializing it in the
 193   /// process, and returns the materialized Module.
 194   virtual Module* removeModuleProvider(ModuleProvider *P,
 195                                        std::string *ErrInfo = 0);
 196
 197   /// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
 198   /// and deletes the ModuleProvider and owned Module.  Avoids materializing
 199   /// the underlying module.
 200   virtual void deleteModuleProvider(ModuleProvider *P,std::string *ErrInfo = 0);
 201
 202   /// FindFunctionNamed - Search all of the active modules to find the one that
 203   /// defines FnName.  This is very slow operation and shouldn't be used for
 204   /// general code.
 205   Function *FindFunctionNamed(const char *FnName);
 206
 207   /// runFunction - Execute the specified function with the specified arguments,
 208   /// and return the result.
 209   ///
 210   virtual GenericValue runFunction(Function *F,
 211                                 const std::vector<GenericValue> &ArgValues) = 0;
 212
 213   /// runStaticConstructorsDestructors - This method is used to execute all of
 214   /// the static constructors or destructors for a program, depending on the
 215   /// value of isDtors.
 216   void runStaticConstructorsDestructors(bool isDtors);
 217   /// runStaticConstructorsDestructors - This method is used to execute all of
 218   /// the static constructors or destructors for a module, depending on the
 219   /// value of isDtors.
 220   void runStaticConstructorsDestructors(Module *module, bool isDtors);
 221
 222
 223   /// runFunctionAsMain - This is a helper function which wraps runFunction to
 224   /// handle the common task of starting up main with the specified argc, argv,
 225   /// and envp parameters.
 226   int runFunctionAsMain(Function *Fn, const std::vector<std::string> &argv,
 227                         const char * const * envp);
 228
 229
 230   /// addGlobalMapping - Tell the execution engine that the specified global is
 231   /// at the specified location.  This is used internally as functions are JIT'd
 232   /// and as global variables are laid out in memory.  It can and should also be
 233   /// used by clients of the EE that want to have an LLVM global overlay
 234   /// existing data in memory.  Mappings are automatically removed when their
 235   /// GlobalValue is destroyed.
 236   void addGlobalMapping(const GlobalValue *GV, void *Addr);
 237
 238   /// clearAllGlobalMappings - Clear all global mappings and start over again
 239   /// use in dynamic compilation scenarios when you want to move globals
 240   void clearAllGlobalMappings();
 241
 242   /// clearGlobalMappingsFromModule - Clear all global mappings that came from a
 243   /// particular module, because it has been removed from the JIT.
 244   void clearGlobalMappingsFromModule(Module *M);
 245
 246   /// updateGlobalMapping - Replace an existing mapping for GV with a new
 247   /// address.  This updates both maps as required.  If "Addr" is null, the
 248   /// entry for the global is removed from the mappings.  This returns the old
 249   /// value of the pointer, or null if it was not in the map.
 250   void *updateGlobalMapping(const GlobalValue *GV, void *Addr);
 251
 252   /// getPointerToGlobalIfAvailable - This returns the address of the specified
 253   /// global value if it is has already been codegen'd, otherwise it returns
 254   /// null.
 255   ///
 256   void *getPointerToGlobalIfAvailable(const GlobalValue *GV);
 257
 258   /// getPointerToGlobal - This returns the address of the specified global
 259   /// value.  This may involve code generation if it's a function.
 260   ///
 261   void *getPointerToGlobal(const GlobalValue *GV);
 262
 263   /// getPointerToFunction - The different EE's represent function bodies in
 264   /// different ways.  They should each implement this to say what a function
 265   /// pointer should look like.  When F is destroyed, the ExecutionEngine will
 266   /// remove its global mapping and free any machine code.  Be sure no threads
 267   /// are running inside F when that happens.
 268   ///
 269   virtual void *getPointerToFunction(Function *F) = 0;
 270
 271   /// getPointerToFunctionOrStub - If the specified function has been
 272   /// code-gen'd, return a pointer to the function.  If not, compile it, or use
 273   /// a stub to implement lazy compilation if available.  See
 274   /// getPointerToFunction for the requirements on destroying F.
 275   ///
 276   virtual void *getPointerToFunctionOrStub(Function *F) {
 277     // Default implementation, just codegen the function.
 278     return getPointerToFunction(F);
 279   }
 280
 281   // The JIT overrides a version that actually does this.
 282   virtual void runJITOnFunction(Function *, MachineCodeInfo * = 0) { }
 283
 284   /// getGlobalValueAtAddress - Return the LLVM global value object that starts
 285   /// at the specified address.
 286   ///
 287   const GlobalValue *getGlobalValueAtAddress(void *Addr);
 288
 289
 290   void StoreValueToMemory(const GenericValue &Val, GenericValue *Ptr,
 291                           const Type *Ty);
 292   void InitializeMemory(const Constant *Init, void *Addr);
 293
 294   /// recompileAndRelinkFunction - This method is used to force a function
 295   /// which has already been compiled to be compiled again, possibly
 296   /// after it has been modified. Then the entry to the old copy is overwritten
 297   /// with a branch to the new copy. If there was no old copy, this acts
 298   /// just like VM::getPointerToFunction().
 299   ///
 300   virtual void *recompileAndRelinkFunction(Function *F) = 0;
 301
 302   /// freeMachineCodeForFunction - Release memory in the ExecutionEngine
 303   /// corresponding to the machine code emitted to execute this function, useful
 304   /// for garbage-collecting generated code.
 305   ///
 306   virtual void freeMachineCodeForFunction(Function *F) = 0;
 307
 308   /// getOrEmitGlobalVariable - Return the address of the specified global
 309   /// variable, possibly emitting it to memory if needed.  This is used by the
 310   /// Emitter.
 311   virtual void *getOrEmitGlobalVariable(const GlobalVariable *GV) {
 312     return getPointerToGlobal((GlobalValue*)GV);
 313   }
 314
 315   /// Registers a listener to be called back on various events within
 316   /// the JIT.  See JITEventListener.h for more details.  Does not
 317   /// take ownership of the argument.  The argument may be NULL, in
 318   /// which case these functions do nothing.
 319   virtual void RegisterJITEventListener(JITEventListener *) {}
 320   virtual void UnregisterJITEventListener(JITEventListener *) {}
 321
 322   /// DisableLazyCompilation - If called, the JIT will abort if lazy compilation
 323   /// is ever attempted.
 324   void DisableLazyCompilation(bool Disabled = true) {
 325     LazyCompilationDisabled = Disabled;
 326   }
 327   bool isLazyCompilationDisabled() const {
 328     return LazyCompilationDisabled;
 329   }
 330
 331   /// DisableGVCompilation - If called, the JIT will abort if it's asked to
 332   /// allocate space and populate a GlobalVariable that is not internal to
 333   /// the module.
 334   void DisableGVCompilation(bool Disabled = true) {
 335     GVCompilationDisabled = Disabled;
 336   }
 337   bool isGVCompilationDisabled() const {
 338     return GVCompilationDisabled;
 339   }
 340
 341   /// DisableSymbolSearching - If called, the JIT will not try to lookup unknown
 342   /// symbols with dlsym.  A client can still use InstallLazyFunctionCreator to
 343   /// resolve symbols in a custom way.
 344   void DisableSymbolSearching(bool Disabled = true) {
 345     SymbolSearchingDisabled = Disabled;
 346   }
 347   bool isSymbolSearchingDisabled() const {
 348     return SymbolSearchingDisabled;
 349   }
 350
 351   /// EnableDlsymStubs -
 352   void EnableDlsymStubs(bool Enabled = true) {
 353     DlsymStubsEnabled = Enabled;
 354   }
 355   bool areDlsymStubsEnabled() const {
 356     return DlsymStubsEnabled;
 357   }
 358
 359   /// InstallLazyFunctionCreator - If an unknown function is needed, the
 360   /// specified function pointer is invoked to create it.  If it returns null,
 361   /// the JIT will abort.
 362   void InstallLazyFunctionCreator(void* (*P)(const std::string &)) {
 363     LazyFunctionCreator = P;
 364   }
 365
 366   /// InstallExceptionTableRegister - The JIT will use the given function
 367   /// to register the exception tables it generates.
 368   static void InstallExceptionTableRegister(void (*F)(void*)) {
 369     ExceptionTableRegister = F;
 370   }
 371
 372   /// RegisterTable - Registers the given pointer as an exception table. It uses
 373   /// the ExceptionTableRegister function.
 374   static void RegisterTable(void* res) {
 375     if (ExceptionTableRegister)
 376       ExceptionTableRegister(res);
 377   }
 378
 379 protected:
 380   explicit ExecutionEngine(ModuleProvider *P);
 381
 382   void emitGlobals();
 383
 384   // EmitGlobalVariable - This method emits the specified global variable to the
 385   // address specified in GlobalAddresses, or allocates new memory if it's not
 386   // already in the map.
 387   void EmitGlobalVariable(const GlobalVariable *GV);
 388
 389   GenericValue getConstantValue(const Constant *C);
 390   void LoadValueFromMemory(GenericValue &Result, GenericValue *Ptr,
 391                            const Type *Ty);
 392 };
 393
 394 namespace EngineKind {
 395   // These are actually bitmasks that get or-ed together.
 396   enum Kind {
 397     JIT         = 0x1,
 398     Interpreter = 0x2
 399   };
 400   const static Kind Either = (Kind)(JIT | Interpreter);
 401 }
 402
 403 /// EngineBuilder - Builder class for ExecutionEngines.  Use this by
 404 /// stack-allocating a builder, chaining the various set* methods, and
 405 /// terminating it with a .create() call.
 406 class EngineBuilder {
 407
 408  private:
 409   ModuleProvider *MP;
 410   EngineKind::Kind WhichEngine;
 411   std::string *ErrorStr;
 412   CodeGenOpt::Level OptLevel;
 413   JITMemoryManager *JMM;
 414   bool AllocateGVsWithCode;
 415
 416   /// InitEngine - Does the common initialization of default options.
 417   ///
 418   void InitEngine() {
 419     WhichEngine = EngineKind::Either;
 420     ErrorStr = NULL;
 421     OptLevel = CodeGenOpt::Default;
 422     JMM = NULL;
 423     AllocateGVsWithCode = false;
 424   }
 425
 426  public:
 427   /// EngineBuilder - Constructor for EngineBuilder.  If create() is called and
 428   /// is successful, the created engine takes ownership of the module
 429   /// provider.
 430   EngineBuilder(ModuleProvider *mp) : MP(mp) {
 431     InitEngine();
 432   }
 433
 434   /// EngineBuilder - Overloaded constructor that automatically creates an
 435   /// ExistingModuleProvider for an existing module.
 436   EngineBuilder(Module *m);
 437
 438   /// setEngineKind - Controls whether the user wants the interpreter, the JIT,
 439   /// or whichever engine works.  This option defaults to EngineKind::Either.
 440   EngineBuilder &setEngineKind(EngineKind::Kind w) {
 441     WhichEngine = w;
 442     return *this;
 443   }
 444
 445   /// setJITMemoryManager - Sets the memory manager to use.  This allows
 446   /// clients to customize their memory allocation policies.  If create() is
 447   /// called and is successful, the created engine takes ownership of the
 448   /// memory manager.  This option defaults to NULL.
 449   EngineBuilder &setJITMemoryManager(JITMemoryManager *jmm) {
 450     JMM = jmm;
 451     return *this;
 452   }
 453
 454   /// setErrorStr - Set the error string to write to on error.  This option
 455   /// defaults to NULL.
 456   EngineBuilder &setErrorStr(std::string *e) {
 457     ErrorStr = e;
 458     return *this;
 459   }
 460
 461   /// setOptLevel - Set the optimization level for the JIT.  This option
 462   /// defaults to CodeGenOpt::Default.
 463   EngineBuilder &setOptLevel(CodeGenOpt::Level l) {
 464     OptLevel = l;
 465     return *this;
 466   }
 467
 468   /// setAllocateGVsWithCode - Sets whether global values should be allocated
 469   /// into the same buffer as code.  For most applications this should be set
 470   /// to false.  Allocating globals with code breaks freeMachineCodeForFunction
 471   /// and is probably unsafe and bad for performance.  However, we have clients
 472   /// who depend on this behavior, so we must support it.  This option defaults
 473   /// to false so that users of the new API can safely use the new memory
 474   /// manager and free machine code.
 475   EngineBuilder &setAllocateGVsWithCode(bool a) {
 476     AllocateGVsWithCode = a;
 477     return *this;
 478   }
 479
 480   ExecutionEngine *create();
 481 };
 482
 483 } // End llvm namespace
 484
 485 #endif