include/llvm/ExecutionEngine/JITMemoryManager.h

   1 //===-- JITMemoryManager.h - Interface JIT uses to Allocate Mem -*- 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 JITMemoryManagerInterface
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_EXECUTION_ENGINE_JIT_MEMMANAGER_H
  15 #define LLVM_EXECUTION_ENGINE_JIT_MEMMANAGER_H
  16
  17 #include "llvm/Support/DataTypes.h"
  18
  19 namespace llvm {
  20   class Function;
  21
  22 /// JITMemoryManager - This interface is used by the JIT to allocate and manage
  23 /// memory for the code generated by the JIT.  This can be reimplemented by
  24 /// clients that have a strong desire to control how the layout of JIT'd memory
  25 /// works.
  26 class JITMemoryManager {
  27 protected:
  28   bool HasGOT;
  29   bool SizeRequired;
  30 public:
  31   JITMemoryManager() : HasGOT(false), SizeRequired(false) {}
  32   virtual ~JITMemoryManager();
  33
  34   /// CreateDefaultMemManager - This is used to create the default
  35   /// JIT Memory Manager if the client does not provide one to the JIT.
  36   static JITMemoryManager *CreateDefaultMemManager();
  37
  38   /// setMemoryWritable - When code generation is in progress,
  39   /// the code pages may need permissions changed.
  40   virtual void setMemoryWritable(void) = 0;
  41
  42   /// setMemoryExecutable - When code generation is done and we're ready to
  43   /// start execution, the code pages may need permissions changed.
  44   virtual void setMemoryExecutable(void) = 0;
  45
  46   //===--------------------------------------------------------------------===//
  47   // Global Offset Table Management
  48   //===--------------------------------------------------------------------===//
  49
  50   /// AllocateGOT - If the current table requires a Global Offset Table, this
  51   /// method is invoked to allocate it.  This method is required to set HasGOT
  52   /// to true.
  53   virtual void AllocateGOT() = 0;
  54
  55   /// isManagingGOT - Return true if the AllocateGOT method is called.
  56   ///
  57   bool isManagingGOT() const {
  58     return HasGOT;
  59   }
  60
  61   /// getGOTBase - If this is managing a Global Offset Table, this method should
  62   /// return a pointer to its base.
  63   virtual unsigned char *getGOTBase() const = 0;
  64
  65   /// NeedsExactSize - If the memory manager requires to know the size of the
  66   /// objects to be emitted
  67   bool NeedsExactSize() const {
  68     return SizeRequired;
  69   }
  70
  71   //===--------------------------------------------------------------------===//
  72   // Main Allocation Functions
  73   //===--------------------------------------------------------------------===//
  74
  75   /// startFunctionBody - When we start JITing a function, the JIT calls this
  76   /// method to allocate a block of free RWX memory, which returns a pointer to
  77   /// it.  The JIT doesn't know ahead of time how much space it will need to
  78   /// emit the function, so it doesn't pass in the size.  Instead, this method
  79   /// is required to pass back a "valid size".  The JIT will be careful to not
  80   /// write more than the returned ActualSize bytes of memory.
  81   virtual unsigned char *startFunctionBody(const Function *F,
  82                                            uintptr_t &ActualSize) = 0;
  83
  84   /// allocateStub - This method is called by the JIT to allocate space for a
  85   /// function stub (used to handle limited branch displacements) while it is
  86   /// JIT compiling a function.  For example, if foo calls bar, and if bar
  87   /// either needs to be lazily compiled or is a native function that exists too
  88   /// far away from the call site to work, this method will be used to make a
  89   /// thunk for it.  The stub should be "close" to the current function body,
  90   /// but should not be included in the 'actualsize' returned by
  91   /// startFunctionBody.
  92   virtual unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
  93                                       unsigned Alignment) =0;
  94
  95
  96   /// endFunctionBody - This method is called when the JIT is done codegen'ing
  97   /// the specified function.  At this point we know the size of the JIT
  98   /// compiled function.  This passes in FunctionStart (which was returned by
  99   /// the startFunctionBody method) and FunctionEnd which is a pointer to the
 100   /// actual end of the function.  This method should mark the space allocated
 101   /// and remember where it is in case the client wants to deallocate it.
 102   virtual void endFunctionBody(const Function *F, unsigned char *FunctionStart,
 103                                unsigned char *FunctionEnd) = 0;
 104
 105   /// deallocateMemForFunction - Free JIT memory for the specified function.
 106   /// This is never called when the JIT is currently emitting a function.
 107   virtual void deallocateMemForFunction(const Function *F) = 0;
 108
 109   /// startExceptionTable - When we finished JITing the function, if exception
 110   /// handling is set, we emit the exception table.
 111   virtual unsigned char* startExceptionTable(const Function* F,
 112                                              uintptr_t &ActualSize) = 0;
 113
 114   /// endExceptionTable - This method is called when the JIT is done emitting
 115   /// the exception table.
 116   virtual void endExceptionTable(const Function *F, unsigned char *TableStart,
 117                                  unsigned char *TableEnd,
 118                                  unsigned char* FrameRegister) = 0;
 119 };
 120
 121 } // end namespace llvm.
 122
 123 #endif