include/llvm/Object/MachOFormat.h

   1 //===- MachOFormat.h - Mach-O Format Structures And Constants ---*- 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 various structures and constants which are platform
  11 // independent and can be shared by any client which wishes to interact with
  12 // Mach object files.
  13 //
  14 // The definitions here are purposely chosen to match the LLVM style as opposed
  15 // to following the platform specific definition of the format.
  16 //
  17 // On a Mach system, see the <mach-o/...> includes for more information, in
  18 // particular <mach-o/loader.h>.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #ifndef LLVM_OBJECT_MACHOFORMAT_H
  23 #define LLVM_OBJECT_MACHOFORMAT_H
  24
  25 #include "llvm/System/DataTypes.h"
  26
  27 namespace llvm {
  28 namespace object {
  29
  30 /// General Mach platform information.
  31 namespace mach {
  32   /// @name CPU Type and Subtype Information
  33   /// {
  34
  35   /// \brief Capability bits used in CPU type encoding.
  36   enum CPUTypeFlagsMask {
  37     CTFM_ArchMask =  0xFF000000,
  38     CTFM_ArchABI64 = 0x01000000
  39   };
  40
  41   /// \brief Machine type IDs used in CPU type encoding.
  42   enum CPUTypeMachine {
  43     CTM_i386      = 7,
  44     CTM_x86_64    = CTM_i386 | CTFM_ArchABI64,
  45     CTM_ARM       = 12,
  46     CTM_SPARC     = 14,
  47     CTM_PowerPC   = 18,
  48     CTM_PowerPC64 = CTM_PowerPC | CTFM_ArchABI64
  49   };
  50
  51   /// \brief Capability bits used in CPU subtype encoding.
  52   enum CPUSubtypeFlagsMask {
  53     CSFM_SubtypeMask =  0xFF000000,
  54     CSFM_SubtypeLib64 = 0x80000000
  55   };
  56
  57   /// \brief ARM Machine Subtypes.
  58   enum CPUSubtypeARM {
  59     CSARM_ALL    = 0,
  60     CSARM_V4T    = 5,
  61     CSARM_V6     = 6,
  62     CSARM_V5TEJ  = 7,
  63     CSARM_XSCALE = 8,
  64     CSARM_V7     = 9
  65   };
  66
  67   /// \brief PowerPC Machine Subtypes.
  68   enum CPUSubtypePowerPC {
  69     CSPPC_ALL = 0
  70   };
  71
  72   /// \brief SPARC Machine Subtypes.
  73   enum CPUSubtypeSPARC {
  74     CSSPARC_ALL = 0
  75   };
  76
  77   /// \brief x86 Machine Subtypes.
  78   enum CPUSubtypeX86 {
  79     CSX86_ALL = 3
  80   };
  81
  82   /// @}
  83
  84 } // end namespace mach
  85
  86 /// Format information for Mach object files.
  87 namespace macho {
  88   /// \brief Constants for structure sizes.
  89   enum StructureSizes {
  90     Header32Size = 28,
  91     Header64Size = 32,
  92     SegmentLoadCommand32Size = 56,
  93     SegmentLoadCommand64Size = 72,
  94     Section32Size = 68,
  95     Section64Size = 80,
  96     SymtabLoadCommandSize = 24,
  97     DysymtabLoadCommandSize = 80,
  98     Nlist32Size = 12,
  99     Nlist64Size = 16,
 100     RelocationInfoSize = 8
 101   };
 102
 103   /// \brief Constants for header magic field.
 104   enum HeaderMagic {
 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
 108   };
 109
 110   /// \brief Header common to all Mach object files.
 111   struct Header {
 112     uint32_t Magic;
 113     uint32_t CPUType;
 114     uint32_t CPUSubtype;
 115     uint32_t FileType;
 116     uint32_t NumLoadCommands;
 117     uint32_t SizeOfLoadCommands;
 118     uint32_t Flags;
 119   };
 120
 121   /// \brief Extended header for 64-bit object files.
 122   struct Header64Ext {
 123     uint32_t Reserved;
 124   };
 125
 126   // See <mach-o/loader.h>.
 127   enum HeaderFileType {
 128     HFT_Object = 0x1
 129   };
 130
 131   enum HeaderFlags {
 132     HF_SubsectionsViaSymbols = 0x2000
 133   };
 134
 135   enum LoadCommandType {
 136     LCT_Segment = 0x1,
 137     LCT_Symtab = 0x2,
 138     LCT_Dysymtab = 0xb,
 139     LCT_Segment64 = 0x19,
 140     LCT_UUID = 0x1b
 141   };
 142
 143   /// \brief Load command structure.
 144   struct LoadCommand {
 145     uint32_t Type;
 146     uint32_t Size;
 147   };
 148
 149   // See <mach-o/nlist.h>.
 150   enum SymbolTypeType {
 151     STT_Undefined = 0x00,
 152     STT_Absolute  = 0x02,
 153     STT_Section   = 0x0e
 154   };
 155
 156   enum SymbolTypeFlags {
 157     // If any of these bits are set, then the entry is a stab entry number (see
 158     // <mach-o/stab.h>. Otherwise the other masks apply.
 159     STF_StabsEntryMask = 0xe0,
 160
 161     STF_TypeMask       = 0x0e,
 162     STF_External       = 0x01,
 163     STF_PrivateExtern  = 0x10
 164   };
 165
 166   /// IndirectSymbolFlags - Flags for encoding special values in the indirect
 167   /// symbol entry.
 168   enum IndirectSymbolFlags {
 169     ISF_Local    = 0x80000000,
 170     ISF_Absolute = 0x40000000
 171   };
 172
 173   /// RelocationFlags - Special flags for addresses.
 174   enum RelocationFlags {
 175     RF_Scattered = 0x80000000
 176   };
 177
 178   enum RelocationInfoType {
 179     RIT_Vanilla             = 0,
 180     RIT_Pair                = 1,
 181     RIT_Difference          = 2,
 182     RIT_PreboundLazyPointer = 3,
 183     RIT_LocalDifference     = 4,
 184     RIT_TLV                 = 5
 185   };
 186
 187   /// X86_64 uses its own relocation types.
 188   enum RelocationInfoTypeX86_64 {
 189     RIT_X86_64_Unsigned   = 0,
 190     RIT_X86_64_Signed     = 1,
 191     RIT_X86_64_Branch     = 2,
 192     RIT_X86_64_GOTLoad    = 3,
 193     RIT_X86_64_GOT        = 4,
 194     RIT_X86_64_Subtractor = 5,
 195     RIT_X86_64_Signed1    = 6,
 196     RIT_X86_64_Signed2    = 7,
 197     RIT_X86_64_Signed4    = 8,
 198     RIT_X86_64_TLV        = 9
 199   };
 200
 201 } // end namespace macho
 202
 203 } // end namespace object
 204 } // end namespace llvm
 205
 206 #endif