include/llvm/Object/SymbolicFile.h

   1 //===- SymbolicFile.h - Interface that only provides symbols ----*- 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 declares the SymbolicFile interface.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_SYMBOLICFILE_H
  15 #define LLVM_OBJECT_SYMBOLICFILE_H
  16
  17 #include "llvm/Object/Binary.h"
  18
  19 namespace llvm {
  20 namespace object {
  21
  22 union DataRefImpl {
  23   // This entire union should probably be a
  24   // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
  25   struct {
  26     uint32_t a, b;
  27   } d;
  28   uintptr_t p;
  29   DataRefImpl() { std::memset(this, 0, sizeof(DataRefImpl)); }
  30 };
  31
  32 inline bool operator==(const DataRefImpl &a, const DataRefImpl &b) {
  33   // Check bitwise identical. This is the only legal way to compare a union w/o
  34   // knowing which member is in use.
  35   return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;
  36 }
  37
  38 inline bool operator!=(const DataRefImpl &a, const DataRefImpl &b) {
  39   return !operator==(a, b);
  40 }
  41
  42 inline bool operator<(const DataRefImpl &a, const DataRefImpl &b) {
  43   // Check bitwise identical. This is the only legal way to compare a union w/o
  44   // knowing which member is in use.
  45   return std::memcmp(&a, &b, sizeof(DataRefImpl)) < 0;
  46 }
  47
  48 template <class content_type>
  49 class content_iterator
  50     : public std::iterator<std::forward_iterator_tag, content_type> {
  51   content_type Current;
  52
  53 public:
  54   content_iterator(content_type symb) : Current(symb) {}
  55
  56   const content_type *operator->() const { return &Current; }
  57
  58   const content_type &operator*() const { return Current; }
  59
  60   bool operator==(const content_iterator &other) const {
  61     return Current == other.Current;
  62   }
  63
  64   bool operator!=(const content_iterator &other) const {
  65     return !(*this == other);
  66   }
  67
  68   content_iterator &operator++() { // preincrement
  69     Current.moveNext();
  70     return *this;
  71   }
  72 };
  73
  74 class SymbolicFile;
  75
  76 /// This is a value type class that represents a single symbol in the list of
  77 /// symbols in the object file.
  78 class BasicSymbolRef {
  79   DataRefImpl SymbolPimpl;
  80   const SymbolicFile *OwningObject;
  81
  82 public:
  83   // FIXME: should we add a SF_Text?
  84   enum Flags : unsigned {
  85     SF_None = 0,
  86     SF_Undefined = 1U << 0,      // Symbol is defined in another object file
  87     SF_Global = 1U << 1,         // Global symbol
  88     SF_Weak = 1U << 2,           // Weak symbol
  89     SF_Absolute = 1U << 3,       // Absolute symbol
  90     SF_Common = 1U << 4,         // Symbol has common linkage
  91     SF_Indirect = 1U << 5,       // Symbol is an alias to another symbol
  92     SF_Exported = 1U << 6,       // Symbol is visible to other DSOs
  93     SF_FormatSpecific = 1U << 7, // Specific to the object file format
  94                                  // (e.g. section symbols)
  95     SF_Thumb = 1U << 8,          // Thumb symbol in a 32-bit ARM binary
  96     SF_Hidden = 1U << 9,         // Symbol has hidden visibility
  97   };
  98
  99   BasicSymbolRef() : OwningObject(nullptr) { }
 100   BasicSymbolRef(DataRefImpl SymbolP, const SymbolicFile *Owner);
 101
 102   bool operator==(const BasicSymbolRef &Other) const;
 103   bool operator<(const BasicSymbolRef &Other) const;
 104
 105   void moveNext();
 106
 107   std::error_code printName(raw_ostream &OS) const;
 108
 109   /// Get symbol flags (bitwise OR of SymbolRef::Flags)
 110   uint32_t getFlags() const;
 111
 112   DataRefImpl getRawDataRefImpl() const;
 113   const SymbolicFile *getObject() const;
 114 };
 115
 116 typedef content_iterator<BasicSymbolRef> basic_symbol_iterator;
 117
 118 const uint64_t UnknownAddressOrSize = ~0ULL;
 119
 120 class SymbolicFile : public Binary {
 121 public:
 122   ~SymbolicFile() override;
 123   SymbolicFile(unsigned int Type, MemoryBufferRef Source);
 124
 125   // virtual interface.
 126   virtual void moveSymbolNext(DataRefImpl &Symb) const = 0;
 127
 128   virtual std::error_code printSymbolName(raw_ostream &OS,
 129                                           DataRefImpl Symb) const = 0;
 130
 131   virtual uint32_t getSymbolFlags(DataRefImpl Symb) const = 0;
 132
 133   virtual basic_symbol_iterator symbol_begin_impl() const = 0;
 134
 135   virtual basic_symbol_iterator symbol_end_impl() const = 0;
 136
 137   // convenience wrappers.
 138   basic_symbol_iterator symbol_begin() const {
 139     return symbol_begin_impl();
 140   }
 141   basic_symbol_iterator symbol_end() const {
 142     return symbol_end_impl();
 143   }
 144   typedef iterator_range<basic_symbol_iterator> basic_symbol_iterator_range;
 145   basic_symbol_iterator_range symbols() const {
 146     return basic_symbol_iterator_range(symbol_begin(), symbol_end());
 147   }
 148
 149   // construction aux.
 150   static ErrorOr<std::unique_ptr<SymbolicFile>>
 151   createSymbolicFile(MemoryBufferRef Object, sys::fs::file_magic Type,
 152                      LLVMContext *Context);
 153
 154   static ErrorOr<std::unique_ptr<SymbolicFile>>
 155   createSymbolicFile(MemoryBufferRef Object) {
 156     return createSymbolicFile(Object, sys::fs::file_magic::unknown, nullptr);
 157   }
 158   static ErrorOr<OwningBinary<SymbolicFile>>
 159   createSymbolicFile(StringRef ObjectPath);
 160
 161   static inline bool classof(const Binary *v) {
 162     return v->isSymbolic();
 163   }
 164 };
 165
 166 inline BasicSymbolRef::BasicSymbolRef(DataRefImpl SymbolP,
 167                                       const SymbolicFile *Owner)
 168     : SymbolPimpl(SymbolP), OwningObject(Owner) {}
 169
 170 inline bool BasicSymbolRef::operator==(const BasicSymbolRef &Other) const {
 171   return SymbolPimpl == Other.SymbolPimpl;
 172 }
 173
 174 inline bool BasicSymbolRef::operator<(const BasicSymbolRef &Other) const {
 175   return SymbolPimpl < Other.SymbolPimpl;
 176 }
 177
 178 inline void BasicSymbolRef::moveNext() {
 179   return OwningObject->moveSymbolNext(SymbolPimpl);
 180 }
 181
 182 inline std::error_code BasicSymbolRef::printName(raw_ostream &OS) const {
 183   return OwningObject->printSymbolName(OS, SymbolPimpl);
 184 }
 185
 186 inline uint32_t BasicSymbolRef::getFlags() const {
 187   return OwningObject->getSymbolFlags(SymbolPimpl);
 188 }
 189
 190 inline DataRefImpl BasicSymbolRef::getRawDataRefImpl() const {
 191   return SymbolPimpl;
 192 }
 193
 194 inline const SymbolicFile *BasicSymbolRef::getObject() const {
 195   return OwningObject;
 196 }
 197
 198 } // namespace object
 199 } // namespace llvm
 200
 201 #endif