1 //===- SymbolicFile.h - Interface that only provides symbols ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SymbolicFile interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_SYMBOLICFILE_H
15 #define LLVM_OBJECT_SYMBOLICFILE_H
17 #include "llvm/Object/Binary.h"
23 // This entire union should probably be a
24 // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
29 DataRefImpl() { std::memset(this, 0, sizeof(DataRefImpl
)); }
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;
38 inline bool operator!=(const DataRefImpl
&a
, const DataRefImpl
&b
) {
39 return !operator==(a
, b
);
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;
48 template <class content_type
> class content_iterator
{
52 content_iterator(content_type symb
) : Current(symb
) {}
54 const content_type
*operator->() const { return &Current
; }
56 const content_type
&operator*() const { return Current
; }
58 bool operator==(const content_iterator
&other
) const {
59 return Current
== other
.Current
;
62 bool operator!=(const content_iterator
&other
) const {
63 return !(*this == other
);
66 content_iterator
&operator++() { // preincrement
74 /// This is a value type class that represents a single symbol in the list of
75 /// symbols in the object file.
76 class BasicSymbolRef
{
77 DataRefImpl SymbolPimpl
;
78 const SymbolicFile
*OwningObject
;
81 // FIXME: should we add a SF_Text?
82 enum Flags
: unsigned {
84 SF_Undefined
= 1U << 0, // Symbol is defined in another object file
85 SF_Global
= 1U << 1, // Global symbol
86 SF_Weak
= 1U << 2, // Weak symbol
87 SF_Absolute
= 1U << 3, // Absolute symbol
88 SF_Common
= 1U << 4, // Symbol has common linkage
89 SF_Indirect
= 1U << 5, // Symbol is an alias to another symbol
90 SF_FormatSpecific
= 1U << 6, // Specific to the object file format
91 // (e.g. section symbols)
92 SF_Thumb
= 1U << 7 // Thumb symbol in a 32-bit ARM binary
95 BasicSymbolRef() : OwningObject(nullptr) { }
96 BasicSymbolRef(DataRefImpl SymbolP
, const SymbolicFile
*Owner
);
98 bool operator==(const BasicSymbolRef
&Other
) const;
99 bool operator<(const BasicSymbolRef
&Other
) const;
103 std::error_code
printName(raw_ostream
&OS
) const;
105 /// Get symbol flags (bitwise OR of SymbolRef::Flags)
106 uint32_t getFlags() const;
108 DataRefImpl
getRawDataRefImpl() const;
109 const SymbolicFile
*getObject() const;
112 typedef content_iterator
<BasicSymbolRef
> basic_symbol_iterator
;
114 const uint64_t UnknownAddressOrSize
= ~0ULL;
116 class SymbolicFile
: public Binary
{
118 virtual ~SymbolicFile();
119 SymbolicFile(unsigned int Type
, MemoryBufferRef Source
);
121 // virtual interface.
122 virtual void moveSymbolNext(DataRefImpl
&Symb
) const = 0;
124 virtual std::error_code
printSymbolName(raw_ostream
&OS
,
125 DataRefImpl Symb
) const = 0;
127 virtual uint32_t getSymbolFlags(DataRefImpl Symb
) const = 0;
129 virtual basic_symbol_iterator
symbol_begin_impl() const = 0;
131 virtual basic_symbol_iterator
symbol_end_impl() const = 0;
133 // convenience wrappers.
134 basic_symbol_iterator
symbol_begin() const {
135 return symbol_begin_impl();
137 basic_symbol_iterator
symbol_end() const {
138 return symbol_end_impl();
140 typedef iterator_range
<basic_symbol_iterator
> basic_symbol_iterator_range
;
141 basic_symbol_iterator_range
symbols() const {
142 return basic_symbol_iterator_range(symbol_begin(), symbol_end());
146 static ErrorOr
<std::unique_ptr
<SymbolicFile
>>
147 createSymbolicFile(MemoryBufferRef Object
, sys::fs::file_magic Type
,
148 LLVMContext
*Context
);
150 static ErrorOr
<std::unique_ptr
<SymbolicFile
>>
151 createSymbolicFile(MemoryBufferRef Object
) {
152 return createSymbolicFile(Object
, sys::fs::file_magic::unknown
, nullptr);
154 static ErrorOr
<OwningBinary
<SymbolicFile
>>
155 createSymbolicFile(StringRef ObjectPath
);
157 static inline bool classof(const Binary
*v
) {
158 return v
->isSymbolic();
162 inline BasicSymbolRef::BasicSymbolRef(DataRefImpl SymbolP
,
163 const SymbolicFile
*Owner
)
164 : SymbolPimpl(SymbolP
), OwningObject(Owner
) {}
166 inline bool BasicSymbolRef::operator==(const BasicSymbolRef
&Other
) const {
167 return SymbolPimpl
== Other
.SymbolPimpl
;
170 inline bool BasicSymbolRef::operator<(const BasicSymbolRef
&Other
) const {
171 return SymbolPimpl
< Other
.SymbolPimpl
;
174 inline void BasicSymbolRef::moveNext() {
175 return OwningObject
->moveSymbolNext(SymbolPimpl
);
178 inline std::error_code
BasicSymbolRef::printName(raw_ostream
&OS
) const {
179 return OwningObject
->printSymbolName(OS
, SymbolPimpl
);
182 inline uint32_t BasicSymbolRef::getFlags() const {
183 return OwningObject
->getSymbolFlags(SymbolPimpl
);
186 inline DataRefImpl
BasicSymbolRef::getRawDataRefImpl() const {
190 inline const SymbolicFile
*BasicSymbolRef::getObject() const {