Use std::unique_ptr to make the ownership explicit.
[oota-llvm.git] / include / llvm / Object / ObjectFile.h
1 //===- ObjectFile.h - File format independent object file -------*- 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 a file format independent ObjectFile class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_OBJECT_OBJECTFILE_H
15 #define LLVM_OBJECT_OBJECTFILE_H
16
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Object/SymbolicFile.h"
19 #include "llvm/Support/DataTypes.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include <cstring>
24 #include <vector>
25
26 namespace llvm {
27 namespace object {
28
29 class ObjectFile;
30 class COFFObjectFile;
31 class MachOObjectFile;
32
33 class SymbolRef;
34 class symbol_iterator;
35
36 /// RelocationRef - This is a value type class that represents a single
37 /// relocation in the list of relocations in the object file.
38 class RelocationRef {
39   DataRefImpl RelocationPimpl;
40   const ObjectFile *OwningObject;
41
42 public:
43   RelocationRef() : OwningObject(nullptr) { }
44
45   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
46
47   bool operator==(const RelocationRef &Other) const;
48
49   void moveNext();
50
51   std::error_code getAddress(uint64_t &Result) const;
52   std::error_code getOffset(uint64_t &Result) const;
53   symbol_iterator getSymbol() const;
54   std::error_code getType(uint64_t &Result) const;
55
56   /// @brief Indicates whether this relocation should hidden when listing
57   /// relocations, usually because it is the trailing part of a multipart
58   /// relocation that will be printed as part of the leading relocation.
59   std::error_code getHidden(bool &Result) const;
60
61   /// @brief Get a string that represents the type of this relocation.
62   ///
63   /// This is for display purposes only.
64   std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
65
66   /// @brief Get a string that represents the calculation of the value of this
67   ///        relocation.
68   ///
69   /// This is for display purposes only.
70   std::error_code getValueString(SmallVectorImpl<char> &Result) const;
71
72   DataRefImpl getRawDataRefImpl() const;
73   const ObjectFile *getObjectFile() const;
74 };
75 typedef content_iterator<RelocationRef> relocation_iterator;
76
77 /// SectionRef - This is a value type class that represents a single section in
78 /// the list of sections in the object file.
79 class SectionRef;
80 typedef content_iterator<SectionRef> section_iterator;
81 class SectionRef {
82   friend class SymbolRef;
83   DataRefImpl SectionPimpl;
84   const ObjectFile *OwningObject;
85
86 public:
87   SectionRef() : OwningObject(nullptr) { }
88
89   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
90
91   bool operator==(const SectionRef &Other) const;
92   bool operator!=(const SectionRef &Other) const;
93   bool operator<(const SectionRef &Other) const;
94
95   void moveNext();
96
97   std::error_code getName(StringRef &Result) const;
98   std::error_code getAddress(uint64_t &Result) const;
99   std::error_code getSize(uint64_t &Result) const;
100   std::error_code getContents(StringRef &Result) const;
101
102   /// @brief Get the alignment of this section as the actual value (not log 2).
103   std::error_code getAlignment(uint64_t &Result) const;
104
105   // FIXME: Move to the normalization layer when it's created.
106   std::error_code isText(bool &Result) const;
107   std::error_code isData(bool &Result) const;
108   std::error_code isBSS(bool &Result) const;
109   std::error_code isRequiredForExecution(bool &Result) const;
110   std::error_code isVirtual(bool &Result) const;
111   std::error_code isZeroInit(bool &Result) const;
112   std::error_code isReadOnlyData(bool &Result) const;
113
114   std::error_code containsSymbol(SymbolRef S, bool &Result) const;
115
116   relocation_iterator relocation_begin() const;
117   relocation_iterator relocation_end() const;
118   iterator_range<relocation_iterator> relocations() const {
119     return iterator_range<relocation_iterator>(relocation_begin(),
120                                                relocation_end());
121   }
122   section_iterator getRelocatedSection() const;
123
124   DataRefImpl getRawDataRefImpl() const;
125 };
126
127 /// SymbolRef - This is a value type class that represents a single symbol in
128 /// the list of symbols in the object file.
129 class SymbolRef : public BasicSymbolRef {
130   friend class SectionRef;
131
132 public:
133   SymbolRef() : BasicSymbolRef() {}
134
135   enum Type {
136     ST_Unknown, // Type not specified
137     ST_Data,
138     ST_Debug,
139     ST_File,
140     ST_Function,
141     ST_Other
142   };
143
144   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
145
146   std::error_code getName(StringRef &Result) const;
147   /// Returns the symbol virtual address (i.e. address at which it will be
148   /// mapped).
149   std::error_code getAddress(uint64_t &Result) const;
150   /// @brief Get the alignment of this symbol as the actual value (not log 2).
151   std::error_code getAlignment(uint32_t &Result) const;
152   std::error_code getSize(uint64_t &Result) const;
153   std::error_code getType(SymbolRef::Type &Result) const;
154   std::error_code getOther(uint8_t &Result) const;
155
156   /// @brief Get section this symbol is defined in reference to. Result is
157   /// end_sections() if it is undefined or is an absolute symbol.
158   std::error_code getSection(section_iterator &Result) const;
159
160   const ObjectFile *getObject() const;
161 };
162
163 class symbol_iterator : public basic_symbol_iterator {
164 public:
165   symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
166   symbol_iterator(const basic_symbol_iterator &B)
167       : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
168                                         cast<ObjectFile>(B->getObject()))) {}
169
170   const SymbolRef *operator->() const {
171     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
172     return static_cast<const SymbolRef*>(&P);
173   }
174
175   const SymbolRef &operator*() const {
176     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
177     return static_cast<const SymbolRef&>(P);
178   }
179 };
180
181 /// LibraryRef - This is a value type class that represents a single library in
182 /// the list of libraries needed by a shared or dynamic object.
183 class LibraryRef {
184   friend class SectionRef;
185   DataRefImpl LibraryPimpl;
186   const ObjectFile *OwningObject;
187
188 public:
189   LibraryRef() : OwningObject(nullptr) { }
190
191   LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
192
193   bool operator==(const LibraryRef &Other) const;
194   bool operator<(const LibraryRef &Other) const;
195
196   std::error_code getNext(LibraryRef &Result) const;
197
198   // Get the path to this library, as stored in the object file.
199   std::error_code getPath(StringRef &Result) const;
200
201   DataRefImpl getRawDataRefImpl() const;
202 };
203 typedef content_iterator<LibraryRef> library_iterator;
204
205 /// ObjectFile - This class is the base class for all object file types.
206 /// Concrete instances of this object are created by createObjectFile, which
207 /// figures out which type to create.
208 class ObjectFile : public SymbolicFile {
209   virtual void anchor();
210   ObjectFile() LLVM_DELETED_FUNCTION;
211   ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
212
213 protected:
214   ObjectFile(unsigned int Type, std::unique_ptr<MemoryBuffer> Source);
215
216   const uint8_t *base() const {
217     return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
218   }
219
220   // These functions are for SymbolRef to call internally. The main goal of
221   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
222   // entry in the memory mapped object file. SymbolPimpl cannot contain any
223   // virtual functions because then it could not point into the memory mapped
224   // file.
225   //
226   // Implementations assume that the DataRefImpl is valid and has not been
227   // modified externally. It's UB otherwise.
228   friend class SymbolRef;
229   virtual std::error_code getSymbolName(DataRefImpl Symb,
230                                         StringRef &Res) const = 0;
231   std::error_code printSymbolName(raw_ostream &OS,
232                                   DataRefImpl Symb) const override;
233   virtual std::error_code getSymbolAddress(DataRefImpl Symb,
234                                            uint64_t &Res) const = 0;
235   virtual std::error_code getSymbolAlignment(DataRefImpl Symb,
236                                              uint32_t &Res) const;
237   virtual std::error_code getSymbolSize(DataRefImpl Symb,
238                                         uint64_t &Res) const = 0;
239   virtual std::error_code getSymbolType(DataRefImpl Symb,
240                                         SymbolRef::Type &Res) const = 0;
241   virtual std::error_code getSymbolSection(DataRefImpl Symb,
242                                            section_iterator &Res) const = 0;
243   virtual std::error_code getSymbolOther(DataRefImpl Symb,
244                                          uint8_t &Res) const {
245     return object_error::invalid_file_type;
246   }
247
248   // Same as above for SectionRef.
249   friend class SectionRef;
250   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
251   virtual std::error_code getSectionName(DataRefImpl Sec,
252                                          StringRef &Res) const = 0;
253   virtual std::error_code getSectionAddress(DataRefImpl Sec,
254                                             uint64_t &Res) const = 0;
255   virtual std::error_code getSectionSize(DataRefImpl Sec,
256                                          uint64_t &Res) const = 0;
257   virtual std::error_code getSectionContents(DataRefImpl Sec,
258                                              StringRef &Res) const = 0;
259   virtual std::error_code getSectionAlignment(DataRefImpl Sec,
260                                               uint64_t &Res) const = 0;
261   virtual std::error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
262   virtual std::error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
263   virtual std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
264   virtual std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
265                                                         bool &Res) const = 0;
266   // A section is 'virtual' if its contents aren't present in the object image.
267   virtual std::error_code isSectionVirtual(DataRefImpl Sec,
268                                            bool &Res) const = 0;
269   virtual std::error_code isSectionZeroInit(DataRefImpl Sec,
270                                             bool &Res) const = 0;
271   virtual std::error_code isSectionReadOnlyData(DataRefImpl Sec,
272                                                 bool &Res) const = 0;
273   virtual std::error_code sectionContainsSymbol(DataRefImpl Sec,
274                                                 DataRefImpl Symb,
275                                                 bool &Result) const = 0;
276   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
277   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
278   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
279
280   // Same as above for RelocationRef.
281   friend class RelocationRef;
282   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
283   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
284                                                uint64_t &Res) const = 0;
285   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
286                                               uint64_t &Res) const = 0;
287   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
288   virtual std::error_code getRelocationType(DataRefImpl Rel,
289                                             uint64_t &Res) const = 0;
290   virtual std::error_code
291   getRelocationTypeName(DataRefImpl Rel,
292                         SmallVectorImpl<char> &Result) const = 0;
293   virtual std::error_code
294   getRelocationValueString(DataRefImpl Rel,
295                            SmallVectorImpl<char> &Result) const = 0;
296   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
297                                               bool &Result) const {
298     Result = false;
299     return object_error::success;
300   }
301
302   // Same for LibraryRef
303   friend class LibraryRef;
304   virtual std::error_code getLibraryNext(DataRefImpl Lib,
305                                          LibraryRef &Res) const = 0;
306   virtual std::error_code getLibraryPath(DataRefImpl Lib,
307                                          StringRef &Res) const = 0;
308
309 public:
310   typedef iterator_range<symbol_iterator> symbol_iterator_range;
311   symbol_iterator_range symbols() const {
312     return symbol_iterator_range(symbol_begin(), symbol_end());
313   }
314
315   virtual section_iterator section_begin() const = 0;
316   virtual section_iterator section_end() const = 0;
317
318   typedef iterator_range<section_iterator> section_iterator_range;
319   section_iterator_range sections() const {
320     return section_iterator_range(section_begin(), section_end());
321   }
322
323   virtual library_iterator needed_library_begin() const = 0;
324   virtual library_iterator needed_library_end() const = 0;
325
326   /// @brief The number of bytes used to represent an address in this object
327   ///        file format.
328   virtual uint8_t getBytesInAddress() const = 0;
329
330   virtual StringRef getFileFormatName() const = 0;
331   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
332
333   /// For shared objects, returns the name which this object should be
334   /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
335   /// LC_ID_DYLIB (install name) on MachO.
336   virtual StringRef getLoadName() const = 0;
337
338   /// Returns platform-specific object flags, if any.
339   virtual std::error_code getPlatformFlags(unsigned &Result) const {
340     Result = 0;
341     return object_error::invalid_file_type;
342   }
343
344   /// @returns Pointer to ObjectFile subclass to handle this type of object.
345   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
346   ///        return true.
347   /// @brief Create ObjectFile from path.
348   static ErrorOr<std::unique_ptr<ObjectFile>>
349   createObjectFile(StringRef ObjectPath);
350
351   static ErrorOr<std::unique_ptr<ObjectFile>>
352   createObjectFile(std::unique_ptr<MemoryBuffer> &Object,
353                    sys::fs::file_magic Type);
354   static ErrorOr<std::unique_ptr<ObjectFile>>
355   createObjectFile(std::unique_ptr<MemoryBuffer> &Object) {
356     return createObjectFile(Object, sys::fs::file_magic::unknown);
357   }
358
359
360   static inline bool classof(const Binary *v) {
361     return v->isObject();
362   }
363
364 public:
365   static ErrorOr<std::unique_ptr<COFFObjectFile>>
366   createCOFFObjectFile(std::unique_ptr<MemoryBuffer> Object);
367
368   static ErrorOr<std::unique_ptr<ObjectFile>>
369   createELFObjectFile(std::unique_ptr<MemoryBuffer> &Object);
370
371   static ErrorOr<std::unique_ptr<MachOObjectFile>>
372   createMachOObjectFile(std::unique_ptr<MemoryBuffer> &Object);
373 };
374
375 // Inline function definitions.
376 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
377     : BasicSymbolRef(SymbolP, Owner) {}
378
379 inline std::error_code SymbolRef::getName(StringRef &Result) const {
380   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
381 }
382
383 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
384   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
385 }
386
387 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
388   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
389 }
390
391 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
392   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
393 }
394
395 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
396   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
397 }
398
399 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
400   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
401 }
402
403 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
404   return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
405 }
406
407 inline const ObjectFile *SymbolRef::getObject() const {
408   const SymbolicFile *O = BasicSymbolRef::getObject();
409   return cast<ObjectFile>(O);
410 }
411
412
413 /// SectionRef
414 inline SectionRef::SectionRef(DataRefImpl SectionP,
415                               const ObjectFile *Owner)
416   : SectionPimpl(SectionP)
417   , OwningObject(Owner) {}
418
419 inline bool SectionRef::operator==(const SectionRef &Other) const {
420   return SectionPimpl == Other.SectionPimpl;
421 }
422
423 inline bool SectionRef::operator!=(const SectionRef &Other) const {
424   return SectionPimpl != Other.SectionPimpl;
425 }
426
427 inline bool SectionRef::operator<(const SectionRef &Other) const {
428   return SectionPimpl < Other.SectionPimpl;
429 }
430
431 inline void SectionRef::moveNext() {
432   return OwningObject->moveSectionNext(SectionPimpl);
433 }
434
435 inline std::error_code SectionRef::getName(StringRef &Result) const {
436   return OwningObject->getSectionName(SectionPimpl, Result);
437 }
438
439 inline std::error_code SectionRef::getAddress(uint64_t &Result) const {
440   return OwningObject->getSectionAddress(SectionPimpl, Result);
441 }
442
443 inline std::error_code SectionRef::getSize(uint64_t &Result) const {
444   return OwningObject->getSectionSize(SectionPimpl, Result);
445 }
446
447 inline std::error_code SectionRef::getContents(StringRef &Result) const {
448   return OwningObject->getSectionContents(SectionPimpl, Result);
449 }
450
451 inline std::error_code SectionRef::getAlignment(uint64_t &Result) const {
452   return OwningObject->getSectionAlignment(SectionPimpl, Result);
453 }
454
455 inline std::error_code SectionRef::isText(bool &Result) const {
456   return OwningObject->isSectionText(SectionPimpl, Result);
457 }
458
459 inline std::error_code SectionRef::isData(bool &Result) const {
460   return OwningObject->isSectionData(SectionPimpl, Result);
461 }
462
463 inline std::error_code SectionRef::isBSS(bool &Result) const {
464   return OwningObject->isSectionBSS(SectionPimpl, Result);
465 }
466
467 inline std::error_code SectionRef::isRequiredForExecution(bool &Result) const {
468   return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
469 }
470
471 inline std::error_code SectionRef::isVirtual(bool &Result) const {
472   return OwningObject->isSectionVirtual(SectionPimpl, Result);
473 }
474
475 inline std::error_code SectionRef::isZeroInit(bool &Result) const {
476   return OwningObject->isSectionZeroInit(SectionPimpl, Result);
477 }
478
479 inline std::error_code SectionRef::isReadOnlyData(bool &Result) const {
480   return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
481 }
482
483 inline std::error_code SectionRef::containsSymbol(SymbolRef S,
484                                                   bool &Result) const {
485   return OwningObject->sectionContainsSymbol(SectionPimpl,
486                                              S.getRawDataRefImpl(), Result);
487 }
488
489 inline relocation_iterator SectionRef::relocation_begin() const {
490   return OwningObject->section_rel_begin(SectionPimpl);
491 }
492
493 inline relocation_iterator SectionRef::relocation_end() const {
494   return OwningObject->section_rel_end(SectionPimpl);
495 }
496
497 inline section_iterator SectionRef::getRelocatedSection() const {
498   return OwningObject->getRelocatedSection(SectionPimpl);
499 }
500
501 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
502   return SectionPimpl;
503 }
504
505 /// RelocationRef
506 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
507                               const ObjectFile *Owner)
508   : RelocationPimpl(RelocationP)
509   , OwningObject(Owner) {}
510
511 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
512   return RelocationPimpl == Other.RelocationPimpl;
513 }
514
515 inline void RelocationRef::moveNext() {
516   return OwningObject->moveRelocationNext(RelocationPimpl);
517 }
518
519 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
520   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
521 }
522
523 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
524   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
525 }
526
527 inline symbol_iterator RelocationRef::getSymbol() const {
528   return OwningObject->getRelocationSymbol(RelocationPimpl);
529 }
530
531 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
532   return OwningObject->getRelocationType(RelocationPimpl, Result);
533 }
534
535 inline std::error_code
536 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
537   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
538 }
539
540 inline std::error_code
541 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
542   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
543 }
544
545 inline std::error_code RelocationRef::getHidden(bool &Result) const {
546   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
547 }
548
549 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
550   return RelocationPimpl;
551 }
552
553 inline const ObjectFile *RelocationRef::getObjectFile() const {
554   return OwningObject;
555 }
556
557 // Inline function definitions.
558 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
559   : LibraryPimpl(LibraryP)
560   , OwningObject(Owner) {}
561
562 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
563   return LibraryPimpl == Other.LibraryPimpl;
564 }
565
566 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
567   return LibraryPimpl < Other.LibraryPimpl;
568 }
569
570 inline std::error_code LibraryRef::getNext(LibraryRef &Result) const {
571   return OwningObject->getLibraryNext(LibraryPimpl, Result);
572 }
573
574 inline std::error_code LibraryRef::getPath(StringRef &Result) const {
575   return OwningObject->getLibraryPath(LibraryPimpl, Result);
576 }
577
578 } // end namespace object
579 } // end namespace llvm
580
581 #endif