include/llvm/ExecutionEngine/ObjectBuffer.h

   1 //===---- ObjectBuffer.h - Utility class to wrap object image memory -----===//
   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 declares a wrapper class to hold the memory into which an
  11 // object will be generated.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_EXECUTIONENGINE_OBJECTBUFFER_H
  16 #define LLVM_EXECUTIONENGINE_OBJECTBUFFER_H
  17
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/Support/MemoryBuffer.h"
  20 #include "llvm/Support/raw_ostream.h"
  21
  22 namespace llvm {
  23
  24 /// This class acts as a container for the memory buffer used during generation
  25 /// and loading of executable objects using MCJIT and RuntimeDyld. The
  26 /// underlying memory for the object will be owned by the ObjectBuffer instance
  27 /// throughout its lifetime.
  28 class ObjectBuffer {
  29   virtual void anchor();
  30 public:
  31   ObjectBuffer() {}
  32   ObjectBuffer(std::unique_ptr<MemoryBuffer> Buf) : Buffer(std::move(Buf)) {}
  33   virtual ~ObjectBuffer() {}
  34
  35   MemoryBufferRef getMemBuffer() const { return Buffer->getMemBufferRef(); }
  36
  37   const char *getBufferStart() const { return Buffer->getBufferStart(); }
  38   size_t getBufferSize() const { return Buffer->getBufferSize(); }
  39   StringRef getBuffer() const { return Buffer->getBuffer(); }
  40   StringRef getBufferIdentifier() const {
  41     return Buffer->getBufferIdentifier();
  42   }
  43
  44 protected:
  45   // The memory contained in an ObjectBuffer
  46   std::unique_ptr<MemoryBuffer> Buffer;
  47 };
  48
  49 /// This class encapsulates the SmallVector and raw_svector_ostream needed to
  50 /// generate an object using MC code emission while providing a common
  51 /// ObjectBuffer interface for access to the memory once the object has been
  52 /// generated.
  53 class ObjectBufferStream : public ObjectBuffer {
  54   void anchor() override;
  55 public:
  56   ObjectBufferStream() : OS(SV) {}
  57   virtual ~ObjectBufferStream() {}
  58
  59   raw_ostream &getOStream() { return OS; }
  60   void flush()
  61   {
  62     OS.flush();
  63
  64     // Make the data accessible via the ObjectBuffer::Buffer
  65     Buffer =
  66         MemoryBuffer::getMemBuffer(StringRef(SV.data(), SV.size()), "", false);
  67   }
  68
  69 protected:
  70   SmallVector<char, 4096> SV; // Working buffer into which we JIT.
  71   raw_svector_ostream     OS; // streaming wrapper
  72 };
  73
  74 } // namespace llvm
  75
  76 #endif