1 //===- MachOUniversal.h - Mach-O universal binaries -------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file declares Mach-O fat/universal binaries.
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_OBJECT_MACHOUNIVERSAL_H
14 #define LLVM_OBJECT_MACHOUNIVERSAL_H
16 #include "llvm/ADT/iterator_range.h"
17 #include "llvm/BinaryFormat/MachO.h"
18 #include "llvm/Object/Binary.h"
19 #include "llvm/Object/MachO.h"
20 #include "llvm/TargetParser/Triple.h"
30 class MachOUniversalBinary : public Binary {
31 virtual void anchor();
34 uint32_t NumberOfObjects;
36 static constexpr uint32_t MaxSectionAlignment = 15; /* 2**15 or 0x8000 */
39 const MachOUniversalBinary *Parent;
40 /// Index of object in the universal binary.
42 /// Descriptor of the object.
43 MachO::fat_arch Header;
44 MachO::fat_arch_64 Header64;
47 ObjectForArch(const MachOUniversalBinary *Parent, uint32_t Index);
54 bool operator==(const ObjectForArch &Other) const {
55 return (Parent == Other.Parent) && (Index == Other.Index);
58 ObjectForArch getNext() const { return ObjectForArch(Parent, Index + 1); }
59 uint32_t getCPUType() const {
60 if (Parent->getMagic() == MachO::FAT_MAGIC)
61 return Header.cputype;
62 else // Parent->getMagic() == MachO::FAT_MAGIC_64
63 return Header64.cputype;
65 uint32_t getCPUSubType() const {
66 if (Parent->getMagic() == MachO::FAT_MAGIC)
67 return Header.cpusubtype;
68 else // Parent->getMagic() == MachO::FAT_MAGIC_64
69 return Header64.cpusubtype;
71 uint64_t getOffset() const {
72 if (Parent->getMagic() == MachO::FAT_MAGIC)
74 else // Parent->getMagic() == MachO::FAT_MAGIC_64
75 return Header64.offset;
77 uint64_t getSize() const {
78 if (Parent->getMagic() == MachO::FAT_MAGIC)
80 else // Parent->getMagic() == MachO::FAT_MAGIC_64
83 uint32_t getAlign() const {
84 if (Parent->getMagic() == MachO::FAT_MAGIC)
86 else // Parent->getMagic() == MachO::FAT_MAGIC_64
87 return Header64.align;
89 uint32_t getReserved() const {
90 if (Parent->getMagic() == MachO::FAT_MAGIC)
92 else // Parent->getMagic() == MachO::FAT_MAGIC_64
93 return Header64.reserved;
95 Triple getTriple() const {
96 return MachOObjectFile::getArchTriple(getCPUType(), getCPUSubType());
98 std::string getArchFlagName() const {
99 const char *McpuDefault, *ArchFlag;
100 MachOObjectFile::getArchTriple(getCPUType(), getCPUSubType(),
101 &McpuDefault, &ArchFlag);
102 return ArchFlag ? ArchFlag : std::string();
105 Expected<std::unique_ptr<MachOObjectFile>> getAsObjectFile() const;
106 Expected<std::unique_ptr<IRObjectFile>>
107 getAsIRObject(LLVMContext &Ctx) const;
109 Expected<std::unique_ptr<Archive>> getAsArchive() const;
112 class object_iterator {
115 object_iterator(const ObjectForArch &Obj) : Obj(Obj) {}
116 const ObjectForArch *operator->() const { return &Obj; }
117 const ObjectForArch &operator*() const { return Obj; }
119 bool operator==(const object_iterator &Other) const {
120 return Obj == Other.Obj;
122 bool operator!=(const object_iterator &Other) const {
123 return !(*this == Other);
126 object_iterator& operator++() { // Preincrement
132 MachOUniversalBinary(MemoryBufferRef Souce, Error &Err);
133 static Expected<std::unique_ptr<MachOUniversalBinary>>
134 create(MemoryBufferRef Source);
136 object_iterator begin_objects() const {
137 return ObjectForArch(this, 0);
139 object_iterator end_objects() const {
140 return ObjectForArch(nullptr, 0);
143 iterator_range<object_iterator> objects() const {
144 return make_range(begin_objects(), end_objects());
147 uint32_t getMagic() const { return Magic; }
148 uint32_t getNumberOfObjects() const { return NumberOfObjects; }
151 static bool classof(Binary const *V) {
152 return V->isMachOUniversalBinary();
155 Expected<ObjectForArch>
156 getObjectForArch(StringRef ArchName) const;
158 Expected<std::unique_ptr<MachOObjectFile>>
159 getMachOObjectForArch(StringRef ArchName) const;
161 Expected<std::unique_ptr<IRObjectFile>>
162 getIRObjectForArch(StringRef ArchName, LLVMContext &Ctx) const;
164 Expected<std::unique_ptr<Archive>>
165 getArchiveForArch(StringRef ArchName) const;