lib/ExecutionEngine/RuntimeDyld/ObjectImageCommon.h

   1 //===-- ObjectImageCommon.h - Format independent executuable object image -===//
   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 file format independent ObjectImage class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_RUNTIMEDYLD_OBJECTIMAGECOMMON_H
  15 #define LLVM_RUNTIMEDYLD_OBJECTIMAGECOMMON_H
  16
  17 #include "llvm/ExecutionEngine/ObjectBuffer.h"
  18 #include "llvm/ExecutionEngine/ObjectImage.h"
  19 #include "llvm/Object/ObjectFile.h"
  20
  21 #include <memory>
  22
  23 namespace llvm {
  24
  25 namespace object {
  26   class ObjectFile;
  27 }
  28
  29 class ObjectImageCommon : public ObjectImage {
  30   ObjectImageCommon(); // = delete
  31   ObjectImageCommon(const ObjectImageCommon &other); // = delete
  32   void anchor() override;
  33
  34 protected:
  35   std::unique_ptr<object::ObjectFile> ObjFile;
  36
  37   // This form of the constructor allows subclasses to use
  38   // format-specific subclasses of ObjectFile directly
  39   ObjectImageCommon(ObjectBuffer *Input, std::unique_ptr<object::ObjectFile> Obj)
  40   : ObjectImage(Input), // saves Input as Buffer and takes ownership
  41     ObjFile(std::move(Obj))
  42   {
  43   }
  44
  45 public:
  46   ObjectImageCommon(ObjectBuffer* Input)
  47   : ObjectImage(Input) // saves Input as Buffer and takes ownership
  48   {
  49     // FIXME: error checking? createObjectFile returns an ErrorOr<ObjectFile*>
  50     // and should probably be checked for failure.
  51     ObjFile.reset(object::ObjectFile::createObjectFile(Buffer->getMemBuffer()).get());
  52   }
  53   ObjectImageCommon(std::unique_ptr<object::ObjectFile> Input)
  54   : ObjectImage(nullptr), ObjFile(std::move(Input))  {}
  55   virtual ~ObjectImageCommon() { }
  56
  57   object::symbol_iterator begin_symbols() const override
  58       { return ObjFile->symbol_begin(); }
  59   object::symbol_iterator end_symbols() const override
  60       { return ObjFile->symbol_end(); }
  61
  62   object::section_iterator begin_sections() const override
  63       { return ObjFile->section_begin(); }
  64   object::section_iterator end_sections() const override
  65       { return ObjFile->section_end(); }
  66
  67   /* Triple::ArchType */ unsigned getArch() const override
  68       { return ObjFile->getArch(); }
  69
  70   StringRef getData() const override { return ObjFile->getData(); }
  71
  72   object::ObjectFile* getObjectFile() const override { return ObjFile.get(); }
  73
  74   // Subclasses can override these methods to update the image with loaded
  75   // addresses for sections and common symbols
  76   void updateSectionAddress(const object::SectionRef &Sec,
  77                             uint64_t Addr) override {}
  78   void updateSymbolAddress(const object::SymbolRef &Sym,
  79                            uint64_t Addr) override {}
  80
  81   // Subclasses can override these methods to provide JIT debugging support
  82   void registerWithDebugger() override {}
  83   void deregisterWithDebugger() override {}
  84 };
  85
  86 } // end namespace llvm
  87
  88 #endif // LLVM_RUNTIMEDYLD_OBJECT_IMAGE_H