path: root/include/llvm/Support/MachO.h

//===-- llvm/Support/MachO.h - The MachO file format ------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines manifest constants for the MachO object file format.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_SUPPORT_MACHO_H
#define LLVM_SUPPORT_MACHO_H

#include "llvm/Support/DataTypes.h"

// NOTE: The enums in this file are intentially named to be different than those
// in the headers in /usr/include/mach (on darwin systems) to avoid conflicts
// with those macros.
namespace llvm {
  namespace MachO {
    // Enums from <mach-o/loader.h>
    enum {
      // Constants for the "magic" field in llvm::MachO::mach_header and
      // llvm::MachO::mach_header_64
      HeaderMagic32         = 0xFEEDFACEu, // MH_MAGIC
      HeaderMagic32Swapped  = 0xCEFAEDFEu, // MH_CIGAM
      HeaderMagic64         = 0xFEEDFACFu, // MH_MAGIC_64
      HeaderMagic64Swapped  = 0xCFFAEDFEu, // MH_CIGAM_64
      UniversalMagic        = 0xCAFEBABEu, // FAT_MAGIC
      UniversalMagicSwapped = 0xBEBAFECAu, // FAT_CIGAM

      // Constants for the "filetype" field in llvm::MachO::mach_header and
      // llvm::MachO::mach_header_64
      HeaderFileTypeObject              = 0x1u, // MH_OBJECT
      HeaderFileTypeExecutable          = 0x2u, // MH_EXECUTE
      HeaderFileTypeFixedVMShlib        = 0x3u, // MH_FVMLIB
      HeaderFileTypeCore                = 0x4u, // MH_CORE
      HeaderFileTypePreloadedExecutable = 0x5u, // MH_PRELOAD
      HeaderFileTypeDynamicShlib        = 0x6u, // MH_DYLIB
      HeaderFileTypeDynamicLinkEditor   = 0x7u, // MH_DYLINKER
      HeaderFileTypeBundle              = 0x8u, // MH_BUNDLE
      HeaderFileTypeDynamicShlibStub    = 0x9u, // MH_DYLIB_STUB
      HeaderFileTypeDSYM                = 0xAu, // MH_DSYM
      HeaderFileTypeKextBundle          = 0xBu, // MH_KEXT_BUNDLE

      // Constant bits for the "flags" field in llvm::MachO::mach_header and
      // llvm::MachO::mach_header_64
      HeaderFlagBitNoUndefinedSymbols     = 0x00000001u, // MH_NOUNDEFS
      HeaderFlagBitIsIncrementalLinkObject= 0x00000002u, // MH_INCRLINK
      HeaderFlagBitIsDynamicLinkObject    = 0x00000004u, // MH_DYLDLINK
      HeaderFlagBitBindAtLoad             = 0x00000008u, // MH_BINDATLOAD
      HeaderFlagBitPrebound               = 0x00000010u, // MH_PREBOUND
      HeaderFlagBitSplitSegments          = 0x00000020u, // MH_SPLIT_SEGS
      HeaderFlagBitLazyInit               = 0x00000040u, // MH_LAZY_INIT
      HeaderFlagBitTwoLevelNamespace      = 0x00000080u, // MH_TWOLEVEL
      HeaderFlagBitForceFlatNamespace     = 0x00000100u, // MH_FORCE_FLAT
      HeaderFlagBitNoMultipleDefintions   = 0x00000200u, // MH_NOMULTIDEFS
      HeaderFlagBitNoFixPrebinding        = 0x00000400u, // MH_NOFIXPREBINDING
      HeaderFlagBitPrebindable            = 0x00000800u, // MH_PREBINDABLE
      HeaderFlagBitAllModulesBound        = 0x00001000u, // MH_ALLMODSBOUND
      HeaderFlagBitSubsectionsViaSymbols  = 0x00002000u, // MH_SUBSECTIONS_VIA_SYMBOLS
      HeaderFlagBitCanonical              = 0x00004000u, // MH_CANONICAL
      HeaderFlagBitWeakDefines            = 0x00008000u, // MH_WEAK_DEFINES
      HeaderFlagBitBindsToWeak            = 0x00010000u, // MH_BINDS_TO_WEAK
      HeaderFlagBitAllowStackExecution    = 0x00020000u, // MH_ALLOW_STACK_EXECUTION
      HeaderFlagBitRootSafe               = 0x00040000u, // MH_ROOT_SAFE
      HeaderFlagBitSetUIDSafe             = 0x00080000u, // MH_SETUID_SAFE
      HeaderFlagBitNoReexportedDylibs     = 0x00100000u, // MH_NO_REEXPORTED_DYLIBS
      HeaderFlagBitPIE                    = 0x00200000u, // MH_PIE
      HeaderFlagBitDeadStrippableDylib    = 0x00400000u, // MH_DEAD_STRIPPABLE_DYLIB

      // Constants for the "cmd" field in llvm::MachO::load_command
      LoadCommandDynamicLinkerRequired    = 0x80000000u, // LC_REQ_DYLD
      LoadCommandSegment32                = 0x00000001u, // LC_SEGMENT
      LoadCommandSymtab                   = 0x00000002u, // LC_SYMTAB
      LoadCommandSymSeg                   = 0x00000003u, // LC_SYMSEG
      LoadCommandThread                   = 0x00000004u, // LC_THREAD
      LoadCommandUnixThread               = 0x00000005u, // LC_UNIXTHREAD
      LoadCommandFixedVMShlibLoad         = 0x00000006u, // LC_LOADFVMLIB
      LoadCommandFixedVMShlibIdent        = 0x00000007u, // LC_IDFVMLIB
      LoadCommandIdent                    = 0x00000008u, // LC_IDENT
      LoadCommandFixedVMFileInclusion     = 0x00000009u, // LC_FVMFILE
      LoadCommandPrePage                  = 0x0000000Au, // LC_PREPAGE
      LoadCommandDynamicSymtabInfo        = 0x0000000Bu, // LC_DYSYMTAB
      LoadCommandDylibLoad                = 0x0000000Cu, // LC_LOAD_DYLIB
      LoadCommandDylibIdent               = 0x0000000Du, // LC_ID_DYLIB
      LoadCommandDynamicLinkerLoad        = 0x0000000Eu, // LC_LOAD_DYLINKER
      LoadCommandDynamicLinkerIdent       = 0x0000000Fu, // LC_ID_DYLINKER
      LoadCommandDylibPrebound            = 0x00000010u, // LC_PREBOUND_DYLIB
      LoadCommandRoutines32               = 0x00000011u, // LC_ROUTINES
      LoadCommandSubFramework             = 0x00000012u, // LC_SUB_FRAMEWORK
      LoadCommandSubUmbrella              = 0x00000013u, // LC_SUB_UMBRELLA
      LoadCommandSubClient                = 0x00000014u, // LC_SUB_CLIENT
      LoadCommandSubLibrary               = 0x00000015u, // LC_SUB_LIBRARY
      LoadCommandTwoLevelHints            = 0x00000016u, // LC_TWOLEVEL_HINTS
      LoadCommandPreBindChecksum          = 0x00000017u, // LC_PREBIND_CKSUM
      LoadCommandDylibLoadWeak            = 0x80000018u, // LC_LOAD_WEAK_DYLIB
      LoadCommandSegment64                = 0x00000019u, // LC_SEGMENT_64
      LoadCommandRoutines64               = 0x0000001Au, // LC_ROUTINES_64
      LoadCommandUUID                     = 0x0000001Bu, // LC_UUID
      LoadCommandRunpath                  = 0x8000001Cu, // LC_RPATH
      LoadCommandCodeSignature            = 0x0000001Du, // LC_CODE_SIGNATURE
      LoadCommandSegmentSplitInfo         = 0x0000001Eu, // LC_SEGMENT_SPLIT_INFO
      LoadCommandDylibReexport            = 0x8000001Fu, // LC_REEXPORT_DYLIB
      LoadCommandDylibLazyLoad            = 0x00000020u, // LC_LAZY_LOAD_DYLIB
      LoadCommandEncryptionInfo           = 0x00000021u, // LC_ENCRYPTION_INFO
      LoadCommandDynamicLinkerInfo        = 0x00000022u, // LC_DYLD_INFO
      LoadCommandDynamicLinkerInfoOnly    = 0x80000022u, // LC_DYLD_INFO_ONLY
      LoadCommandDylibLoadUpward          = 0x80000023u, // LC_LOAD_UPWARD_DYLIB
      LoadCommandVersionMinMacOSX         = 0x00000024u, // LC_VERSION_MIN_MACOSX
      LoadCommandVersionMinIPhoneOS       = 0x00000025u, // LC_VERSION_MIN_IPHONEOS
      LoadCommandFunctionStarts           = 0x00000026u, // LC_FUNCTION_STARTS
      LoadCommandDyldEnvironment          = 0x00000027u, // LC_DYLD_ENVIRONMENT
      LoadCommandMain                     = 0x80000028u, // LC_MAIN
      LoadCommandDataInCode               = 0x00000029u, // LC_DATA_IN_CODE
      LoadCommandSourceVersion            = 0x0000002Au, // LC_SOURCE_VERSION
      LoadCommandCodeSignDRs              = 0x0000002Bu, // LC_DYLIB_CODE_SIGN_DRS

      // Constant bits for the "flags" field in llvm::MachO::segment_command
      SegmentCommandFlagBitHighVM             = 0x1u, // SG_HIGHVM
      SegmentCommandFlagBitFixedVMLibrary     = 0x2u, // SG_FVMLIB
      SegmentCommandFlagBitNoRelocations      = 0x4u, // SG_NORELOC
      SegmentCommandFlagBitProtectedVersion1  = 0x8u, // SG_PROTECTED_VERSION_1


      // Constant masks for the "flags" field in llvm::MachO::section and
      // llvm::MachO::section_64
      SectionFlagMaskSectionType      = 0x000000ffu, // SECTION_TYPE
      SectionFlagMaskAllAttributes    = 0xffffff00u, // SECTION_ATTRIBUTES
      SectionFlagMaskUserAttributes   = 0xff000000u, // SECTION_ATTRIBUTES_USR
      SectionFlagMaskSystemAttributes = 0x00ffff00u, // SECTION_ATTRIBUTES_SYS

      // Constant masks for the "flags[7:0]" field in llvm::MachO::section and
      // llvm::MachO::section_64 (mask "flags" with SECTION_TYPE)
      SectionTypeRegular                    = 0x00u, // S_REGULAR
      SectionTypeZeroFill                   = 0x01u, // S_ZEROFILL
      SectionTypeCStringLiterals            = 0x02u, // S_CSTRING_LITERALS
      SectionType4ByteLiterals              = 0x03u, // S_4BYTE_LITERALS
      SectionType8ByteLiterals              = 0x04u, // S_8BYTE_LITERALS
      SectionTypeLiteralPointers            = 0x05u, // S_LITERAL_POINTERS
      SectionTypeNonLazySymbolPointers      = 0x06u, // S_NON_LAZY_SYMBOL_POINTERS
      SectionTypeLazySymbolPointers         = 0x07u, // S_LAZY_SYMBOL_POINTERS
      SectionTypeSymbolStubs                = 0x08u, // S_SYMBOL_STUBS
      SectionTypeModuleInitFunctionPointers = 0x09u, // S_MOD_INIT_FUNC_POINTERS
      SectionTypeModuleTermFunctionPointers = 0x0au, // S_MOD_TERM_FUNC_POINTERS
      SectionTypeCoalesced                  = 0x0bu, // S_COALESCED
      SectionTypeZeroFillLarge              = 0x0cu, // S_GB_ZEROFILL
      SectionTypeInterposing                = 0x0du, // S_INTERPOSING
      SectionType16ByteL