Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

//===- MachO.h - MachO object file implementation ---------------*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

//

// This file declares the MachOObjectFile class, which implement the ObjectFile

// interface for MachO files.

//

//===----------------------------------------------------------------------===//

#ifndef LLVM_OBJECT_MACHO_H

#define LLVM_OBJECT_MACHO_H

#include "llvm/ADT/ArrayRef.h"

#include "llvm/ADT/SmallString.h"

#include "llvm/ADT/SmallVector.h"

#include "llvm/ADT/StringExtras.h"

#include "llvm/ADT/StringRef.h"

#include "llvm/ADT/Triple.h"

#include "llvm/ADT/iterator_range.h"

#include "llvm/BinaryFormat/MachO.h"

#include "llvm/BinaryFormat/Swift.h"

#include "llvm/MC/SubtargetFeature.h"

#include "llvm/Object/Binary.h"

#include "llvm/Object/ObjectFile.h"

#include "llvm/Object/SymbolicFile.h"

#include "llvm/Support/Error.h"

#include "llvm/Support/Format.h"

#include "llvm/Support/MemoryBuffer.h"

#include "llvm/Support/raw_ostream.h"

#include <cstdint>

#include <memory>

#include <string>

#include <system_error>

namespace llvm {

namespace object {

/// DiceRef - This is a value type class that represents a single

/// data in code entry in the table in a Mach-O object file.

class DiceRef {

  DataRefImpl DicePimpl;

  const ObjectFile *OwningObject = nullptr;

public:

  DiceRef() = default;

  DiceRef(DataRefImpl DiceP, const ObjectFile *Owner);

  bool operator==(const DiceRef &Other) const;

  bool operator<(const DiceRef &Other) const;

  void moveNext();

  std::error_code getOffset(uint32_t &Result) const;

  std::error_code getLength(uint16_t &Result) const;

  std::error_code getKind(uint16_t &Result) const;

  DataRefImpl getRawDataRefImpl() const;

  const ObjectFile *getObjectFile() const;

};

using dice_iterator = content_iterator<DiceRef>;

/// ExportEntry encapsulates the current-state-of-the-walk used when doing a

/// non-recursive walk of the trie data structure.  This allows you to iterate

/// across all exported symbols using:

///      Error Err = Error::success();

///      for (const llvm::object::ExportEntry &AnExport : Obj->exports(&Err)) {

///      }

///      if (Err) { report error ...

class ExportEntry {

public:

  ExportEntry(Error *Err, const MachOObjectFile *O, ArrayRef<uint8_t> Trie);

  StringRef name() const;

  uint64_t flags() const;

  uint64_t address() const;

  uint64_t other() const;

  StringRef otherName() const;

  uint32_t nodeOffset() const;

  bool operator==(const ExportEntry &) const;

  void moveNext();

private:

  friend class MachOObjectFile;

  void moveToFirst();

  void moveToEnd();

  uint64_t readULEB128(const uint8_t *&p, const char **error);

  void pushDownUntilBottom();

  void pushNode(uint64_t Offset);

  // Represents a node in the mach-o exports trie.

  struct NodeState {

    NodeState(const uint8_t *Ptr);

    const uint8_t *Start;

    const uint8_t *Current;

    uint64_t Flags = 0;

    uint64_t Address = 0;

    uint64_t Other = 0;

    const char *ImportName = nullptr;

    unsigned ChildCount = 0;

    unsigned NextChildIndex = 0;

    unsigned ParentStringLength = 0;

    bool IsExportNode = false;

  };

  using NodeList = SmallVector<NodeState, 16>;

  using node_iterator = NodeList::const_iterator;

  Error *E;

  const MachOObjectFile *O;

  ArrayRef<uint8_t> Trie;

  SmallString<256> CumulativeString;

  NodeList Stack;

  bool Done = false;

  iterator_range<node_iterator> nodes() const {

    return make_range(Stack.begin(), Stack.end());

  }

};

using export_iterator = content_iterator<ExportEntry>;

// Segment info so SegIndex/SegOffset pairs in a Mach-O Bind or Rebase entry

// can be checked and translated.  Only the SegIndex/SegOffset pairs from

// checked entries are to be used with the segmentName(), sectionName() and

// address() methods below.

class BindRebaseSegInfo {

public:

  BindRebaseSegInfo(const MachOObjectFile *Obj);

  // Used to check a Mach-O Bind or Rebase entry for errors when iterating.

  const char* checkSegAndOffsets(int32_t SegIndex, uint64_t SegOffset,

                                 uint8_t PointerSize, uint32_t Count=1,

                                 uint32_t Skip=0);

  // Used with valid SegIndex/SegOffset values from checked entries.

  StringRef segmentName(int32_t SegIndex);

  StringRef sectionName(int32_t SegIndex, uint64_t SegOffset);

  uint64_t address(uint32_t SegIndex, uint64_t SegOffset);

private:

  struct SectionInfo {

    uint64_t Address;

    uint64_t Size;

    StringRef SectionName;

    StringRef SegmentName;

    uint64_t OffsetInSegment;

    uint64_t SegmentStartAddress;

    int32_t SegmentIndex;

  };

  const SectionInfo &findSection(int32_t SegIndex, uint64_t SegOffset);

  SmallVector<SectionInfo, 32> Sections;

  int32_t MaxSegIndex;

};

/// MachORebaseEntry encapsulates the current state in the decompression of

/// rebasing opcodes. This allows you to iterate through the compressed table of

/// rebasing using:

///    Error Err = Error::success();

///    for (const llvm::object::MachORebaseEntry &Entry : Obj->rebaseTable(&Err)) {

///    }

///    if (Err) { report error ...

class MachORebaseEntry {

public:

  MachORebaseEntry(Error *Err, const MachOObjectFile *O,

                   ArrayRef<uint8_t> opcodes, bool is64Bit);

  int32_t segmentIndex() const;

  uint64_t segmentOffset() const;

  StringRef typeName() const;

  StringRef segmentName() const;

  StringRef sectionName() const;

  uint64_t address() const;

  bool operator==(const MachORebaseEntry &) const;

  void moveNext();

private:

  friend class MachOObjectFile;

  void moveToFirst();

  void moveToEnd();

  uint64_t readULEB128(const char **error);

  Error *E;

  const MachOObjectFile *O;

  ArrayRef<uint8_t> Opcodes;

  const uint8_t *Ptr;

  uint64_t SegmentOffset = 0;

  int32_t SegmentIndex = -1;

  uint64_t RemainingLoopCount = 0;

  uint64_t AdvanceAmount = 0;

  uint8_t  RebaseType = 0;

  uint8_t  PointerSize;

  bool     Done = false;

};

using rebase_iterator = content_iterator<MachORebaseEntry>;

/// MachOBindEntry encapsulates the current state in the decompression of

/// binding opcodes. This allows you to iterate through the compressed table of

/// bindings using:

///    Error Err = Error::success();

///    for (const llvm::object::MachOBindEntry &Entry : Obj->bindTable(&Err)) {

///    }

///    if (Err) { report error ...

class MachOBindEntry {

public:

  enum class Kind { Regular, Lazy, Weak };

  MachOBindEntry(Error *Err, const MachOObjectFile *O,

                 ArrayRef<uint8_t> Opcodes, bool is64Bit, MachOBindEntry::Kind);

  int32_t segmentIndex() const;

  uint64_t segmentOffset() const;

  StringRef typeName() const;

  StringRef symbolName() const;

  uint32_t flags() const;

  int64_t addend() const;

  int ordinal() const;

  StringRef segmentName() const;

  StringRef sectionName() const;

  uint64_t address() const;

  bool operator==(const MachOBindEntry &) const;

  void moveNext();

private:

  friend class MachOObjectFile;

  void moveToFirst();

  void moveToEnd();

  uint64_t readULEB128(const char **error);

  int64_t readSLEB128(const char **error);

  Error *E;

  const MachOObjectFile *O;

  ArrayRef<uint8_t> Opcodes;

  const uint8_t *Ptr;

  uint64_t SegmentOffset = 0;

  int32_t  SegmentIndex = -1;

  StringRef SymbolName;

  bool     LibraryOrdinalSet = false;

  int      Ordinal = 0;

  uint32_t Flags = 0;

  int64_t  Addend = 0;

  uint64_t RemainingLoopCount = 0;

  uint64_t AdvanceAmount = 0;

  uint8_t  BindType = 0;

  uint8_t  PointerSize;

  Kind     TableKind;

  bool     Done = false;

};

using bind_iterator = content_iterator<MachOBindEntry>;

/// ChainedFixupTarget holds all the information about an external symbol

/// necessary to bind this binary to that symbol. These values are referenced

/// indirectly by chained fixup binds. This structure captures values from all

/// import and symbol formats.

///

/// Be aware there are two notions of weak here:

///   WeakImport == true

///     The associated bind may be set to 0 if this symbol is missing from its

///     parent library. This is called a "weak import."

///   LibOrdinal == BIND_SPECIAL_DYLIB_WEAK_LOOKUP

///     This symbol may be coalesced with other libraries vending the same

///     symbol. E.g., C++'s "operator new". This is called a "weak bind."

struct ChainedFixupTarget {

public:

  ChainedFixupTarget(int LibOrdinal, uint32_t NameOffset, StringRef Symbol,

                     uint64_t Addend, bool WeakImport)

      : LibOrdinal(LibOrdinal), NameOffset(NameOffset), SymbolName(Symbol),

        Addend(Addend), WeakImport(WeakImport) {}

  int libOrdinal() { return LibOrdinal; }

  uint32_t nameOffset() { return NameOffset; }

  StringRef symbolName() { return SymbolName; }

  uint64_t addend() { return Addend; }

  bool weakImport() { return WeakImport; }

  bool weakBind() {

    return LibOrdinal == MachO::BIND_SPECIAL_DYLIB_WEAK_LOOKUP;

  }

private:

  int LibOrdinal;

  uint32_t NameOffset;

  StringRef SymbolName;

  uint64_t Addend;

  bool WeakImport;

};

struct ChainedFixupsSegment {

  ChainedFixupsSegment(uint8_t SegIdx, uint32_t Offset,

                       const MachO::dyld_chained_starts_in_segment &Header,

                       std::vector<uint16_t> &&PageStarts)

      : SegIdx(SegIdx), Offset(Offset), Header(Header),

        PageStarts(PageStarts){};

  uint32_t SegIdx;

  uint32_t Offset; // dyld_chained_starts_in_image::seg_info_offset[SegIdx]

  MachO::dyld_chained_starts_in_segment Header;

  std::vector<uint16_t> PageStarts; // page_start[] entries, host endianness

};

/// MachOAbstractFixupEntry is an abstract class representing a fixup in a

/// MH_DYLDLINK file. Fixups generally represent rebases and binds. Binds also

/// subdivide into additional subtypes (weak, lazy, reexport).

///

/// The two concrete subclasses of MachOAbstractFixupEntry are:

///

///   MachORebaseBindEntry   - for dyld opcode-based tables, including threaded-

///                            rebase, where rebases are mixed in with other

///                            bind opcodes.

///   MachOChainedFixupEntry - for pointer chains embedded in data pages.

class MachOAbstractFixupEntry {

public:

  MachOAbstractFixupEntry(Error *Err, const MachOObjectFile *O);

  int32_t segmentIndex() const;

  uint64_t segmentOffset() const;

  uint64_t segmentAddress() const;

  StringRef segmentName() const;

  StringRef sectionName() const;

  StringRef typeName() const;

  StringRef symbolName() const;

  uint32_t flags() const;

  int64_t addend() const;

  int ordinal() const;

  /// \return the location of this fixup as a VM Address. For the VM

  /// Address this fixup is pointing to, use pointerValue().

  uint64_t address() const;

  /// \return the VM Address pointed to by this fixup. Use

  /// pointerValue() to compare against other VM Addresses, such as

  /// section addresses or segment vmaddrs.

  uint64_t pointerValue() const { return PointerValue; }

  /// \return the raw "on-disk" representation of the fixup. For

  /// Threaded rebases and Chained pointers these values are generally

  /// encoded into various different pointer formats. This value is

  /// exposed in API for tools that want to display and annotate the

  /// raw bits.

  uint64_t rawValue() const { return RawValue; }

  void moveNext();

protected:

  Error *E;

  const MachOObjectFile *O;

  uint64_t SegmentOffset = 0;

  int32_t SegmentIndex = -1;

  StringRef SymbolName;

  int32_t Ordinal = 0;

  uint32_t Flags = 0;

  int64_t Addend = 0;

  uint64_t PointerValue = 0;

  uint64_t RawValue = 0;

  bool Done = false;

  void moveToFirst();

  void moveToEnd();

  /// \return the vm address of the start of __TEXT segment.

  uint64_t textAddress() const { return TextAddress; }

private:

  uint64_t TextAddress;

};

class MachOChainedFixupEntry : public MachOAbstractFixupEntry {

public:

  enum class FixupKind { Bind, Rebase };

  MachOChainedFixupEntry(Error *Err, const MachOObjectFile *O, bool Parse);

  bool operator==(const MachOChainedFixupEntry &) const;

  bool isBind() const { return Kind == FixupKind::Bind; }

  bool isRebase() const { return Kind == FixupKind::Rebase; }

  void moveNext();

  void moveToFirst();

  void moveToEnd();

private:

  void findNextPageWithFixups();

  std::vector<ChainedFixupTarget> FixupTargets;

  std::vector<ChainedFixupsSegment> Segments;

  ArrayRef<uint8_t> SegmentData;

  FixupKind Kind;

  uint32_t InfoSegIndex = 0; // Index into Segments

  uint32_t PageIndex = 0;    // Index into Segments[InfoSegIdx].PageStarts

  uint32_t PageOffset = 0;   // Page offset of the current fixup

};

using fixup_iterator = content_iterator<MachOChainedFixupEntry>;

class MachOObjectFile : public ObjectFile {

public:

  struct LoadCommandInfo {

    const char *Ptr;      // Where in memory the load command is.

    MachO::load_command C; // The command itself.

  };

  using LoadCommandList = SmallVector<LoadCommandInfo, 4>;

  using load_command_iterator = LoadCommandList::const_iterator;

  static Expected<std::unique_ptr<MachOObjectFile>>

  create(MemoryBufferRef Object, bool IsLittleEndian, bool Is64Bits,

         uint32_t UniversalCputype = 0, uint32_t UniversalIndex = 0);

  static bool isMachOPairedReloc(uint64_t RelocType, uint64_t Arch);

  void moveSymbolNext(DataRefImpl &Symb) const override;

  uint64_t getNValue(DataRefImpl Sym) const;

  Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;

  // MachO specific.

  Error checkSymbolTable() const;

  std::error_code getIndirectName(DataRefImpl Symb, StringRef &Res) const;

  unsigned getSectionType(SectionRef Sec) const;

  Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;

  uint32_t getSymbolAlignment(DataRefImpl Symb) const override;

  uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;

  Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override;

  Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override;

  Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;

  unsigned getSymbolSectionID(SymbolRef Symb) const;

  unsigned getSectionID(SectionRef Sec) const;

  void moveSectionNext(DataRefImpl &Sec) const override;

  Expected<StringRef> getSectionName(DataRefImpl Sec) const override;

  uint64_t getSectionAddress(DataRefImpl Sec) const override;

  uint64_t getSectionIndex(DataRefImpl Sec) const override;

  uint64_t getSectionSize(DataRefImpl Sec) const override;

  ArrayRef<uint8_t> getSectionContents(uint32_t Offset, uint64_t Size) const;

  Expected<ArrayRef<uint8_t>>

  getSectionContents(DataRefImpl Sec) const override;

  uint64_t getSectionAlignment(DataRefImpl Sec) const override;

  Expected<SectionRef> getSection(unsigned SectionIndex) const;

  Expected<SectionRef> getSection(StringRef SectionName) const;

  bool isSectionCompressed(DataRefImpl Sec) const override;

  bool isSectionText(DataRefImpl Sec) const override;

  bool isSectionData(DataRefImpl Sec) const override;

  bool isSectionBSS(DataRefImpl Sec) const override;

  bool isSectionVirtual(DataRefImpl Sec) const override;

  bool isSectionBitcode(DataRefImpl Sec) const override;

  bool isDebugSection(DataRefImpl Sec) const override;

  /// Return the raw contents of an entire segment.

  ArrayRef<uint8_t> getSegmentContents(StringRef SegmentName) const;

  ArrayRef<uint8_t> getSegmentContents(size_t SegmentIndex) const;

  /// When dsymutil generates the companion file, it strips all unnecessary

  /// sections (e.g. everything in the _TEXT segment) by omitting their body

  /// and setting the offset in their corresponding load command to zero.

  ///

  /// While the load command itself is valid, reading the section corresponds

  /// to reading the number of bytes specified in the load command, starting

  /// from offset 0 (i.e. the Mach-O header at the beginning of the file).

  bool isSectionStripped(DataRefImpl Sec) const override;

  relocation_iterator section_rel_begin(DataRefImpl Sec) const override;

  relocation_iterator section_rel_end(DataRefImpl Sec) const override;

  relocation_iterator extrel_begin() const;

  relocation_iterator extrel_end() const;

  iterator_range<relocation_iterator> external_relocations() const {

    return make_range(extrel_begin(), extrel_end());

  }

  relocation_iterator locrel_begin() const;

  relocation_iterator locrel_end() const;

  void moveRelocationNext(DataRefImpl &Rel) const override;

  uint64_t getRelocationOffset(DataRefImpl Rel) const override;

  symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;

  section_iterator getRelocationSection(DataRefImpl Rel) const;

  uint64_t getRelocationType(DataRefImpl Rel) const override;

  void getRelocationTypeName(DataRefImpl Rel,

                             SmallVectorImpl<char> &Result) const override;

  uint8_t getRelocationLength(DataRefImpl Rel) const;

  // MachO specific.

  std::error_code getLibraryShortNameByIndex(unsigned Index, StringRef &) const;

  uint32_t getLibraryCount() const;

  section_iterator getRelocationRelocatedSection(relocation_iterator Rel) const;

  // TODO: Would be useful to have an iterator based version

  // of the load command interface too.

  basic_symbol_iterator symbol_begin() const override;

  basic_symbol_iterator symbol_end() const override;

  // MachO specific.

  symbol_iterator getSymbolByIndex(unsigned Index) const;

  uint64_t getSymbolIndex(DataRefImpl Symb) const;

  section_iterator section_begin() const override;

  section_iterator section_end() const override;

  uint8_t getBytesInAddress() const override;

  StringRef getFileFormatName() const override;

  Triple::ArchType getArch() const override;

  Expected<SubtargetFeatures> getFeatures() const override {

    return SubtargetFeatures();

  }

  Triple getArchTriple(const char **McpuDefault = nullptr) const;

  relocation_iterator section_rel_begin(unsigned Index) const;

  relocation_iterator section_rel_end(unsigned Index) const;

  dice_iterator begin_dices() const;

  dice_iterator end_dices() const;

  load_command_iterator begin_load_commands() const;

  load_command_iterator end_load_commands() const;

  iterator_range<load_command_iterator> load_commands() const;

  /// For use iterating over all exported symbols.

  iterator_range<export_iterator> exports(Error &Err) const;

  /// For use examining a trie not in a MachOObjectFile.

  static iterator_range<export_iterator> exports(Error &Err,

                                                 ArrayRef<uint8_t> Trie,

                                                 const MachOObjectFile *O =

                                                                      nullptr);

  /// For use iterating over all rebase table entries.

  iterator_range<rebase_iterator> rebaseTable(Error &Err);

  /// For use examining rebase opcodes in a MachOObjectFile.

  static iterator_range<rebase_iterator> rebaseTable(Error &Err,

                                                     MachOObjectFile *O,

                                                     ArrayRef<uint8_t> Opcodes,

                                                     bool is64);

  /// For use iterating over all bind table entries.

  iterator_range<bind_iterator> bindTable(Error &Err);

  /// For iterating over all chained fixups.

  iterator_range<fixup_iterator> fixupTable(Error &Err);

  /// For use iterating over all lazy bind table entries.

  iterator_range<bind_iterator> lazyBindTable(Error &Err);

  /// For use iterating over all weak bind table entries.

  iterator_range<bind_iterator> weakBindTable(Error &Err);

  /// For use examining bind opcodes in a MachOObjectFile.

  static iterator_range<bind_iterator> bindTable(Error &Err,

                                                 MachOObjectFile *O,

                                                 ArrayRef<uint8_t> Opcodes,

                                                 bool is64,

                                                 MachOBindEntry::Kind);

  // Given a SegIndex, SegOffset, and PointerSize, verify a valid section exists

  // that fully contains a pointer at that location. Multiple fixups in a bind

  // (such as with the BIND_OPCODE_DO_BIND_ULEB_TIMES_SKIPPING_ULEB opcode) can

  // be tested via the Count and Skip parameters.

  //

  // This is used by MachOBindEntry::moveNext() to validate a MachOBindEntry.

  const char *BindEntryCheckSegAndOffsets(int32_t SegIndex, uint64_t SegOffset,

                                         uint8_t PointerSize, uint32_t Count=1,

                                          uint32_t Skip=0) const {

    return BindRebaseSectionTable->checkSegAndOffsets(SegIndex, SegOffset,

                                                     PointerSize, Count, Skip);

  }

  // Given a SegIndex, SegOffset, and PointerSize, verify a valid section exists

  // that fully contains a pointer at that location. Multiple fixups in a rebase

  // (such as with the REBASE_OPCODE_DO_*_TIMES* opcodes) can be tested via the

  // Count and Skip parameters.

  //

  // This is used by MachORebaseEntry::moveNext() to validate a MachORebaseEntry

  const char *RebaseEntryCheckSegAndOffsets(int32_t SegIndex,

                                            uint64_t SegOffset,

                                            uint8_t PointerSize,

                                            uint32_t Count=1,

                                            uint32_t Skip=0) const {

    return BindRebaseSectionTable->checkSegAndOffsets(SegIndex, SegOffset,

                                                      PointerSize, Count, Skip);

  }

  /// For use with the SegIndex of a checked Mach-O Bind or Rebase entry to

  /// get the segment name.

  StringRef BindRebaseSegmentName(int32_t SegIndex) const {

    return BindRebaseSectionTable->segmentName(SegIndex);

  }

  /// For use with a SegIndex,SegOffset pair from a checked Mach-O Bind or

  /// Rebase entry to get the section name.

  StringRef BindRebaseSectionName(uint32_t SegIndex, uint64_t SegOffset) const {

    return BindRebaseSectionTable->sectionName(SegIndex, SegOffset);

  }

  /// For use with a SegIndex,SegOffset pair from a checked Mach-O Bind or

  /// Rebase entry to get the address.

  uint64_t BindRebaseAddress(uint32_t SegIndex, uint64_t SegOffset) const {

    return BindRebaseSectionTable->address(SegIndex, SegOffset);

  }

  // In a MachO file, sections have a segment name. This is used in the .o

  // files. They have a single segment, but this field specifies which segment

  // a section should be put in the final object.

  StringRef getSectionFinalSegmentName(DataRefImpl Sec) const;

  // Names are stored as 16 bytes. These returns the raw 16 bytes without

  // interpreting them as a C string.

  ArrayRef<char> getSectionRawName(DataRefImpl Sec) const;

  ArrayRef<char> getSectionRawFinalSegmentName(DataRefImpl Sec) const;

  // MachO specific Info about relocations.

  bool isRelocationScattered(const MachO::any_relocation_info &RE) const;

  unsigned getPlainRelocationSymbolNum(

                                    const MachO::any_relocation_info &RE) const;

  bool getPlainRelocationExternal(const MachO::any_relocation_info &RE) const;

  bool getScatteredRelocationScattered(

                                    const MachO::any_relocation_info &RE) const;

  uint32_t getScatteredRelocationValue(

                                    const MachO::any_relocation_info &RE) const;

  uint32_t getScatteredRelocationType(

                                    const MachO::any_relocation_info &RE) const;

  unsigned getAnyRelocationAddress(const MachO::any_relocation_info &RE) const;

  unsigned getAnyRelocationPCRel(const MachO::any_relocation_info &RE) const;

  unsigned getAnyRelocationLength(const MachO::any_relocation_info &RE) const;

  unsigned getAnyRelocationType(const MachO::any_relocation_info &RE) const;

  SectionRef getAnyRelocationSection(const MachO::any_relocation_info &RE) const;

  // MachO specific structures.

  MachO::section getSection(DataRefImpl DRI) const;

  MachO::section_64 getSection64(DataRefImpl DRI) const;

  MachO::section getSection(const LoadCommandInfo &L, unsigned Index) const;

  MachO::section_64 getSection64(const LoadCommandInfo &L,unsigned Index) const;

  MachO::nlist getSymbolTableEntry(DataRefImpl DRI) const;

  MachO::nlist_64 getSymbol64TableEntry(DataRefImpl DRI) const;

  MachO::linkedit_data_command

  getLinkeditDataLoadCommand(const LoadCommandInfo &L) const;

  MachO::segment_command

  getSegmentLoadCommand(const LoadCommandInfo &L) const;

  MachO::segment_command_64

  getSegment64LoadCommand(const LoadCommandInfo &L) const;

  MachO::linker_option_command

  getLinkerOptionLoadCommand(const LoadCommandInfo &L) const;

  MachO::version_min_command

  getVersionMinLoadCommand(const LoadCommandInfo &L) const;

  MachO::note_command

  getNoteLoadCommand(const LoadCommandInfo &L) const;

  MachO::build_version_command

  getBuildVersionLoadCommand(const LoadCommandInfo &L) const;

  MachO::build_tool_version

  getBuildToolVersion(unsigned index) const;

  MachO::dylib_command

  getDylibIDLoadCommand(const LoadCommandInfo &L) const;

  MachO::dyld_info_command

  getDyldInfoLoadCommand(const LoadCommandInfo &L) const;

  MachO::dylinker_command

  getDylinkerCommand(const LoadCommandInfo &L) const;

  MachO::uuid_command

  getUuidCommand(const LoadCommandInfo &L) const;

  MachO::rpath_command

  getRpathCommand(const LoadCommandInfo &L) const;

  MachO::source_version_command

  getSourceVersionCommand(const LoadCommandInfo &L) const;

  MachO::entry_point_command

  getEntryPointCommand(const LoadCommandInfo &L) const;

  MachO::encryption_info_command

  getEncryptionInfoCommand(const LoadCommandInfo &L) const;

  MachO::encryption_info_command_64

  getEncryptionInfoCommand64(const LoadCommandInfo &L) const;

  MachO::sub_framework_command

  getSubFrameworkCommand(const LoadCommandInfo &L) const;

  MachO::sub_umbrella_command

  getSubUmbrellaCommand(const LoadCommandInfo &L) const;

  MachO::sub_library_command

  getSubLibraryCommand(const LoadCommandInfo &L) const;

  MachO::sub_client_command

  getSubClientCommand(const LoadCommandInfo &L) const;

  MachO::routines_command

  getRoutinesCommand(const LoadCommandInfo &L) const;

  MachO::routines_command_64

  getRoutinesCommand64(const LoadCommandInfo &L) const;

  MachO::thread_command

  getThreadCommand(const LoadCommandInfo &L) const;

  MachO::any_relocation_info getRelocation(DataRefImpl Rel) const;

  MachO::data_in_code_entry getDice(DataRefImpl Rel) const;

  const MachO::mach_header &getHeader() const;

  const MachO::mach_header_64 &getHeader64() const;

  uint32_t

  getIndirectSymbolTableEntry(const MachO::dysymtab_command &DLC,

                              unsigned Index) const;

  MachO::data_in_code_entry getDataInCodeTableEntry(uint32_t DataOffset,

                                                    unsigned Index) const;

  MachO::symtab_command getSymtabLoadCommand() const;

  MachO::dysymtab_command getDysymtabLoadCommand() const;

  MachO::linkedit_data_command getDataInCodeLoadCommand() const;

  MachO::linkedit_data_command getLinkOptHintsLoadCommand() const;

  ArrayRef<uint8_t> getDyldInfoRebaseOpcodes() const;

  ArrayRef<uint8_t> getDyldInfoBindOpcodes() const;

  ArrayRef<uint8_t> getDyldInfoWeakBindOpcodes() const;

  ArrayRef<uint8_t> getDyldInfoLazyBindOpcodes() const;

  ArrayRef<uint8_t> getDyldInfoExportsTrie() const;

  /// If the optional is None, no header was found, but the object was

  /// well-formed.

  Expected<std::optional<MachO::dyld_chained_fixups_header>>

  getChainedFixupsHeader() const;

  Expected<std::vector<ChainedFixupTarget>> getDyldChainedFixupTargets() const;

  // Note: This is a limited, temporary API, which will be removed when Apple

  // upstreams their implementation. Please do not rely on this.

  Expected<std::optional<MachO::linkedit_data_command>>

  getChainedFixupsLoadCommand() const;

  // Returns the number of sections listed in dyld_chained_starts_in_image, and

  // a ChainedFixupsSegment for each segment that has fixups.

  Expected<std::pair<size_t, std::vector<ChainedFixupsSegment>>>

  getChainedFixupsSegments() const;

  ArrayRef<uint8_t> getDyldExportsTrie() const;

  SmallVector<uint64_t> getFunctionStarts() const;

  ArrayRef<uint8_t> getUuid() const;

  StringRef getStringTableData() const;

  bool is64Bit() const;

  void ReadULEB128s(uint64_t Index, SmallVectorImpl<uint64_t> &Out) const;

  static StringRef guessLibraryShortName(StringRef Name, bool &isFramework,

                                         StringRef &Suffix);

  static Triple::ArchType getArch(uint32_t CPUType, uint32_t CPUSubType);

  static Triple getArchTriple(uint32_t CPUType, uint32_t CPUSubType,

                              const char **McpuDefault = nullptr,

                              const char **ArchFlag = nullptr);

  static bool isValidArch(StringRef ArchFlag);

  static ArrayRef<StringRef> getValidArchs();

  static Triple getHostArch();

  bool isRelocatableObject() const override;

  StringRef mapDebugSectionName(StringRef Name) const override;

  llvm::binaryformat::Swift5ReflectionSectionKind

  mapReflectionSectionNameToEnumValue(StringRef SectionName) const override;

  bool hasPageZeroSegment() const { return HasPageZeroSegment; }

  static bool classof(const Binary *v) {

    return v->isMachO();

  }

  static uint32_t

  getVersionMinMajor(MachO::version_min_command &C, bool SDK) {

    uint32_t VersionOrSDK = (SDK) ? C.sdk : C.version;

    return (VersionOrSDK >> 16) & 0xffff;

  }

  static uint32_t

  getVersionMinMinor(MachO::version_min_command &C, bool SDK) {

    uint32_t VersionOrSDK = (SDK) ? C.sdk : C.version;

    return (VersionOrSDK >> 8) & 0xff;

  }