1 //===- MachOFormat.h - Mach-O Format Structures And Constants ---*- 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 various structures and constants which are platform
11 // independent and can be shared by any client which wishes to interact with
14 // The definitions here are purposely chosen to match the LLVM style as opposed
15 // to following the platform specific definition of the format.
17 // On a Mach system, see the <mach-o/...> includes for more information, in
18 // particular <mach-o/loader.h>.
20 //===----------------------------------------------------------------------===//
22 #ifndef LLVM_OBJECT_MACHOFORMAT_H
23 #define LLVM_OBJECT_MACHOFORMAT_H
25 #include "llvm/Support/DataTypes.h"
30 /// General Mach platform information.
32 /// @name CPU Type and Subtype Information
35 /// \brief Capability bits used in CPU type encoding.
36 enum CPUTypeFlagsMask {
37 CTFM_ArchMask = 0xFF000000,
38 CTFM_ArchABI64 = 0x01000000
41 /// \brief Machine type IDs used in CPU type encoding.
44 CTM_x86_64 = CTM_i386 | CTFM_ArchABI64,
48 CTM_PowerPC64 = CTM_PowerPC | CTFM_ArchABI64
51 /// \brief Capability bits used in CPU subtype encoding.
52 enum CPUSubtypeFlagsMask {
53 CSFM_SubtypeMask = 0xFF000000,
54 CSFM_SubtypeLib64 = 0x80000000
57 /// \brief ARM Machine Subtypes.
67 /// \brief PowerPC Machine Subtypes.
68 enum CPUSubtypePowerPC {
72 /// \brief SPARC Machine Subtypes.
73 enum CPUSubtypeSPARC {
77 /// \brief x86 Machine Subtypes.
84 } // end namespace mach
86 /// Format information for Mach object files.
88 /// \brief Constants for structure sizes.
92 SegmentLoadCommand32Size = 56,
93 SegmentLoadCommand64Size = 72,
96 SymtabLoadCommandSize = 24,
97 DysymtabLoadCommandSize = 80,
100 RelocationInfoSize = 8
103 /// \brief Constants for header magic field.
105 HM_Object32 = 0xFEEDFACE, ///< 32-bit mach object file
106 HM_Object64 = 0xFEEDFACF, ///< 64-bit mach object file
107 HM_Universal = 0xCAFEBABE ///< Universal object file
110 /// \brief Header common to all Mach object files.
116 uint32_t NumLoadCommands;
117 uint32_t SizeOfLoadCommands;
121 /// \brief Extended header for 64-bit object files.
126 // See <mach-o/loader.h>.
127 enum HeaderFileType {
132 HF_SubsectionsViaSymbols = 0x2000
135 enum LoadCommandType {
139 LCT_Segment64 = 0x19,
141 LCT_CodeSignature = 0x1d,
142 LCT_SegmentSplitInfo = 0x1e,
143 LCT_FunctionStarts = 0x26
146 /// \brief Load command structure.
152 /// @name Load Command Structures
155 struct SegmentLoadCommand {
163 uint32_t MaxVMProtection;
164 uint32_t InitialVMProtection;
165 uint32_t NumSections;
169 struct Segment64LoadCommand {
177 uint32_t MaxVMProtection;
178 uint32_t InitialVMProtection;
179 uint32_t NumSections;
183 struct SymtabLoadCommand {
186 uint32_t SymbolTableOffset;
187 uint32_t NumSymbolTableEntries;
188 uint32_t StringTableOffset;
189 uint32_t StringTableSize;
192 struct DysymtabLoadCommand {
196 uint32_t LocalSymbolsIndex;
197 uint32_t NumLocalSymbols;
199 uint32_t ExternalSymbolsIndex;
200 uint32_t NumExternalSymbols;
202 uint32_t UndefinedSymbolsIndex;
203 uint32_t NumUndefinedSymbols;
206 uint32_t NumTOCEntries;
208 uint32_t ModuleTableOffset;
209 uint32_t NumModuleTableEntries;
211 uint32_t ReferenceSymbolTableOffset;
212 uint32_t NumReferencedSymbolTableEntries;
214 uint32_t IndirectSymbolTableOffset;
215 uint32_t NumIndirectSymbolTableEntries;
217 uint32_t ExternalRelocationTableOffset;
218 uint32_t NumExternalRelocationTableEntries;
220 uint32_t LocalRelocationTableOffset;
221 uint32_t NumLocalRelocationTableEntries;
224 struct LinkeditDataLoadCommand {
232 /// @name Section Data
237 char SegmentName[16];
242 uint32_t RelocationTableOffset;
243 uint32_t NumRelocationTableEntries;
250 char SegmentName[16];
255 uint32_t RelocationTableOffset;
256 uint32_t NumRelocationTableEntries;
264 /// @name Symbol Table Entries
267 struct SymbolTableEntry {
268 uint32_t StringIndex;
270 uint8_t SectionIndex;
274 struct Symbol64TableEntry {
275 uint32_t StringIndex;
277 uint8_t SectionIndex;
283 /// @name Indirect Symbol Table
286 struct IndirectSymbolTableEntry {
291 /// @name Relocation Data
294 struct RelocationEntry {
301 // See <mach-o/nlist.h>.
302 enum SymbolTypeType {
303 STT_Undefined = 0x00,
308 enum SymbolTypeFlags {
309 // If any of these bits are set, then the entry is a stab entry number (see
310 // <mach-o/stab.h>. Otherwise the other masks apply.
311 STF_StabsEntryMask = 0xe0,
315 STF_PrivateExtern = 0x10
318 /// IndirectSymbolFlags - Flags for encoding special values in the indirect
320 enum IndirectSymbolFlags {
321 ISF_Local = 0x80000000,
322 ISF_Absolute = 0x40000000
325 /// RelocationFlags - Special flags for addresses.
326 enum RelocationFlags {
327 RF_Scattered = 0x80000000
330 /// Common relocation info types.
331 enum RelocationInfoType {
337 /// Generic relocation info types, which are shared by some (but not all)
339 enum RelocationInfoType_Generic {
340 RIT_Generic_PreboundLazyPointer = 3,
341 RIT_Generic_LocalDifference = 4,
345 /// X86_64 uses its own relocation types.
346 enum RelocationInfoTypeX86_64 {
347 // Note that x86_64 doesn't even share the common relocation types.
348 RIT_X86_64_Unsigned = 0,
349 RIT_X86_64_Signed = 1,
350 RIT_X86_64_Branch = 2,
351 RIT_X86_64_GOTLoad = 3,
353 RIT_X86_64_Subtractor = 5,
354 RIT_X86_64_Signed1 = 6,
355 RIT_X86_64_Signed2 = 7,
356 RIT_X86_64_Signed4 = 8,
360 /// ARM uses its own relocation types.
361 enum RelocationInfoTypeARM {
362 RIT_ARM_LocalDifference = 3,
363 RIT_ARM_PreboundLazyPointer = 4,
364 RIT_ARM_Branch24Bit = 5,
365 RIT_ARM_ThumbBranch22Bit = 6,
366 RIT_ARM_ThumbBranch32Bit = 7,
368 RIT_ARM_HalfDifference = 9
372 } // end namespace macho
374 } // end namespace object
375 } // end namespace llvm