[#llvm-MachO]
= xref:llvm.adoc[llvm]::MachO
:relfileprefix: ../
:mrdocs:

Constants, structures, and helpers for the Mach‐O object‐file format.

== Namespaces

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/DylibReader.adoc[`DylibReader`] 
| Utilities for reading Mach‐O dynamic libraries and extracting TAPI attributes.
|===


== Types

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/ArchitectureSet.adoc[`ArchitectureSet`] 
| Bitmask of Mach‐O architecture slices.
| xref:llvm/MachO/CS_BlobIndex.adoc[`CS_BlobIndex`] 
| Index entry locating one blob inside a CS_SuperBlob.
| xref:llvm/MachO/CS_CodeDirectory.adoc[`CS_CodeDirectory`] 
| CodeDirectory blob describing hashes of signed code pages.
| xref:llvm/MachO/CS_SuperBlob.adoc[`CS_SuperBlob`] 
| Container blob that indexes subordinate code‐signing blobs.
| xref:llvm/MachO/GlobalRecord.adoc[`GlobalRecord`] 
| Non‐ObjC record representing a global variable or function.
| xref:llvm/MachO/InterfaceFile.adoc[`InterfaceFile`] 
| Defines the interface file.
| xref:llvm/MachO/InterfaceFileRef.adoc[`InterfaceFileRef`] 
| Reference to an interface file.
| xref:llvm/MachO/ObjCCategoryRecord.adoc[`ObjCCategoryRecord`] 
| Objective‐C category that extends a class with additional ivars.
| xref:llvm/MachO/ObjCContainerRecord.adoc[`ObjCContainerRecord`] 
| Objective‐C container with methods, properties, ivars, and protocols.
| xref:llvm/MachO/ObjCIVarRecord.adoc[`ObjCIVarRecord`] 
| Objective‐C instance variable record.
| xref:llvm/MachO/ObjCInterfaceRecord.adoc[`ObjCInterfaceRecord`] 
| Objective‐C interface (class) record.
| xref:llvm/MachO/PackedVersion.adoc[`PackedVersion`] 
| Mach‐O packed version number stored as a 32‐bit value.
| xref:llvm/MachO/Record.adoc[`Record`] 
| Define Record. They represent API's in binaries that could be linkable symbols.
| xref:llvm/MachO/RecordLoc.adoc[`RecordLoc`] 
| Lightweight source location for a record.
| xref:llvm/MachO/RecordVisitor.adoc[`RecordVisitor`] 
| Base class for any usage of traversing over collected Records.
| xref:llvm/MachO/RecordsSlice.adoc[`RecordsSlice`] 
| Collection of records for a library that are tied to a Darwin target triple.
| xref:llvm/MachO/SimpleSymbol.adoc[`SimpleSymbol`] 
| Lightweight struct for passing around symbol information.
| xref:llvm/MachO/SymLink.adoc[`SymLink`] 
| Simple storage for a symbolic link path and its target content.
| xref:llvm/MachO/Symbol.adoc[`Symbol`] 
| TextAPI symbol describing a named entry and its targets.
| xref:llvm/MachO/SymbolConverter.adoc[`SymbolConverter`] 
| Specialized RecordVisitor for collecting exported symbols and undefined symbols if RecordSlice being visited represents a flat‐namespaced library.
| xref:llvm/MachO/SymbolSet.adoc[`SymbolSet`] 
| Collection of TextAPI symbols keyed by encode kind and name.
| xref:llvm/MachO/Target.adoc[`Target`] 
| TextAPI target combining architecture, platform, and deployment version.
| xref:llvm/MachO/TextAPIError.adoc[`TextAPIError`] 
| ErrorInfo specialization for TextAPI‐specific failures.
| xref:llvm/MachO/TextAPIReader.adoc[`TextAPIReader`] 
| Reads TAPI text API files into InterfaceFile representations.
| xref:llvm/MachO/TextAPIWriter.adoc[`TextAPIWriter`] 
| Writes InterfaceFile attributes as TAPI text files.
| xref:llvm/MachO/any_relocation_info.adoc[`any_relocation_info`] 
| Untyped two‐word view of a relocation entry.
| xref:llvm/MachO/arm_state_hdr_t.adoc[`arm_state_hdr_t`] 
| Flavor/count header preceding an ARM thread‐state blob.
| xref:llvm/MachO/arm_thread_state32_t.adoc[`arm_thread_state32_t`] 
| 32‐bit ARM general‐purpose thread state.
| xref:llvm/MachO/arm_thread_state64_t.adoc[`arm_thread_state64_t`] 
| 64‐bit AArch64 general‐purpose thread state.
| xref:llvm/MachO/arm_thread_state_t.adoc[`arm_thread_state_t`] 
| Flavor‐tagged ARM thread state.
| xref:llvm/MachO/build_tool_version.adoc[`build_tool_version`] 
| One tool/version pair following a build_version_command.
| xref:llvm/MachO/build_version_command.adoc[`build_version_command`] 
| Load command recording platform, OS, SDK, and tool versions.
| xref:llvm/MachO/data_in_code_entry.adoc[`data_in_code_entry`] 
| One data‐in‐code range describing non‐instruction bytes in text.
| xref:llvm/MachO/dyld_chained_fixups_header.adoc[`dyld_chained_fixups_header`] 
| Header for dyld chained fixups (LC_DYLD_CHAINED_FIXUPS payload).
| xref:llvm/MachO/dyld_chained_import.adoc[`dyld_chained_import`] 
| Chained‐fixups import entry without an addend.
| xref:llvm/MachO/dyld_chained_import_addend.adoc[`dyld_chained_import_addend`] 
| Chained‐fixups import entry with a 32‐bit addend.
| xref:llvm/MachO/dyld_chained_import_addend64.adoc[`dyld_chained_import_addend64`] 
| Chained‐fixups import entry with a 64‐bit addend.
| xref:llvm/MachO/dyld_chained_ptr_64_bind.adoc[`dyld_chained_ptr_64_bind`] 
| 64‐bit chained pointer encoding a bind fixup.
| xref:llvm/MachO/dyld_chained_ptr_64_rebase.adoc[`dyld_chained_ptr_64_rebase`] 
| 64‐bit chained pointer encoding a rebase fixup.
| xref:llvm/MachO/dyld_chained_starts_in_image.adoc[`dyld_chained_starts_in_image`] 
| Image‐wide segment start offsets for dyld chained fixups.
| xref:llvm/MachO/dyld_chained_starts_in_segment.adoc[`dyld_chained_starts_in_segment`] 
| Per‐segment page‐start table for dyld chained fixups.
| xref:llvm/MachO/dyld_env_command.adoc[`dyld_env_command`] 
| Load command embedding an environment variable for dyld.
| xref:llvm/MachO/dyld_info_command.adoc[`dyld_info_command`] 
| Load command locating dyld rebase/bind/export info streams.
| xref:llvm/MachO/dylib.adoc[`dylib`] 
| Shared library identification used by dylib_command.
| xref:llvm/MachO/dylib_command.adoc[`dylib_command`] 
| Load command describing a dynamically linked shared library.
| xref:llvm/MachO/dylib_module.adoc[`dylib_module`] 
| 32‐bit module table entry for a dynamic shared library.
| xref:llvm/MachO/dylib_module_64.adoc[`dylib_module_64`] 
| 64‐bit module table entry for a dynamic shared library.
| xref:llvm/MachO/dylib_reference.adoc[`dylib_reference`] 
| External reference entry describing a symbol used by a module.
| xref:llvm/MachO/dylib_table_of_contents.adoc[`dylib_table_of_contents`] 
| Table‐of‐contents entry mapping a symbol to a module.
| xref:llvm/MachO/dylinker_command.adoc[`dylinker_command`] 
| Load command naming the dynamic linker to use.
| xref:llvm/MachO/dysymtab_command.adoc[`dysymtab_command`] 
| Load command describing the dynamic symbol table layout.
| xref:llvm/MachO/encryption_info_command.adoc[`encryption_info_command`] 
| 32‐bit load command describing an encrypted segment range.
| xref:llvm/MachO/encryption_info_command_64.adoc[`encryption_info_command_64`] 
| 64‐bit load command describing an encrypted segment range.
| xref:llvm/MachO/entry_point_command.adoc[`entry_point_command`] 
| Load command giving the main entry point and stack size.
| xref:llvm/MachO/fat_arch.adoc[`fat_arch`] 
| One architecture slice descriptor in a 32‐bit fat binary.
| xref:llvm/MachO/fat_arch_64.adoc[`fat_arch_64`] 
| One architecture slice descriptor in a 64‐bit fat binary.
| xref:llvm/MachO/fat_header.adoc[`fat_header`] 
| Header of a fat (universal) Mach‐O binary.
| xref:llvm/MachO/fileset_entry_command.adoc[`fileset_entry_command`] 
| Load command describing one entry in an MH_FILESET binary.
| xref:llvm/MachO/fp_control_t.adoc[`fp_control_t`] 
| x87 floating‐point control word bitfields.
| xref:llvm/MachO/fp_status_t.adoc[`fp_status_t`] 
| x87 floating‐point status word bitfields.
| xref:llvm/MachO/fvmfile_command.adoc[`fvmfile_command`] 
| Load command naming a file loaded at a fixed virtual address (obsolete).
| xref:llvm/MachO/fvmlib.adoc[`fvmlib`] 
| Fixed VM shared library identification (obsolete).
| xref:llvm/MachO/fvmlib_command.adoc[`fvmlib_command`] 
| Load command for a fixed VM shared library (obsolete).
| xref:llvm/MachO/ident_command.adoc[`ident_command`] 
| Load command holding free‐form identification strings (obsolete).
| xref:llvm/MachO/lc_str.adoc[`lc_str`] 
| Union embedding a load‐command string as a file offset.
| xref:llvm/MachO/linkedit_data_command.adoc[`linkedit_data_command`] 
| Load command pointing at a blob of data in __LINKEDIT.
| xref:llvm/MachO/linker_option_command.adoc[`linker_option_command`] 
| Load command carrying null‐terminated linker option strings.
| xref:llvm/MachO/load_command.adoc[`load_command`] 
| Base header shared by every Mach‐O load command.
| xref:llvm/MachO/mach_header.adoc[`mach_header`] 
| 32‐bit Mach‐O object file header.
| xref:llvm/MachO/mach_header_64.adoc[`mach_header_64`] 
| 64‐bit Mach‐O object file header.
| xref:llvm/MachO/macho_load_command.adoc[`macho_load_command`] 
| Discriminated union of every Mach‐O load‐command structure.
| xref:llvm/MachO/mmst_reg_t.adoc[`mmst_reg_t`] 
| x87 / MMX register image (10‐byte value plus padding).
| xref:llvm/MachO/nlist.adoc[`nlist`] 
| 32‐bit symbol table entry.
| xref:llvm/MachO/nlist_64.adoc[`nlist_64`] 
| 64‐bit symbol table entry.
| xref:llvm/MachO/nlist_base.adoc[`nlist_base`] 
| Shared prefix of 32‐ and 64‐bit nlist entries without the value field.
| xref:llvm/MachO/note_command.adoc[`note_command`] 
| Load command describing an arbitrary named note blob.
| xref:llvm/MachO/ppc_state_hdr_t.adoc[`ppc_state_hdr_t`] 
| Flavor/count header preceding a PowerPC thread‐state blob.
| xref:llvm/MachO/ppc_thread_state32_t.adoc[`ppc_thread_state32_t`] 
| 32‐bit PowerPC general‐purpose thread state.
| xref:llvm/MachO/ppc_thread_state_t.adoc[`ppc_thread_state_t`] 
| Flavor‐tagged PowerPC thread state.
| xref:llvm/MachO/prebind_cksum_command.adoc[`prebind_cksum_command`] 
| Load command holding the prebinding checksum (obsolete).
| xref:llvm/MachO/prebound_dylib_command.adoc[`prebound_dylib_command`] 
| Load command for a prebound dylib (obsolete).
| xref:llvm/MachO/relocation_info.adoc[`relocation_info`] 
| Standard Mach‐O relocation entry.
| xref:llvm/MachO/routines_command.adoc[`routines_command`] 
| 32‐bit load command describing module initialization routines.
| xref:llvm/MachO/routines_command_64.adoc[`routines_command_64`] 
| 64‐bit load command describing module initialization routines.
| xref:llvm/MachO/rpath_command.adoc[`rpath_command`] 
| Load command adding a runtime search path for dylibs.
| xref:llvm/MachO/scattered_relocation_info.adoc[`scattered_relocation_info`] 
| Scattered Mach‐O relocation entry (r_scattered bit set).
| xref:llvm/MachO/section.adoc[`section`] 
| 32‐bit section header within a segment_command.
| xref:llvm/MachO/section_64.adoc[`section_64`] 
| 64‐bit section header within a segment_command_64.
| xref:llvm/MachO/segment_command.adoc[`segment_command`] 
| 32‐bit segment load command (LC_SEGMENT).
| xref:llvm/MachO/segment_command_64.adoc[`segment_command_64`] 
| 64‐bit segment load command (LC_SEGMENT_64).
| xref:llvm/MachO/source_version_command.adoc[`source_version_command`] 
| Load command recording the source version used to build the binary.
| xref:llvm/MachO/sub_client_command.adoc[`sub_client_command`] 
| Load command naming an allowed client of a subframework.
| xref:llvm/MachO/sub_framework_command.adoc[`sub_framework_command`] 
| Load command naming the umbrella framework for a subframework.
| xref:llvm/MachO/sub_library_command.adoc[`sub_library_command`] 
| Load command naming a sub‐library within an umbrella library.
| xref:llvm/MachO/sub_umbrella_command.adoc[`sub_umbrella_command`] 
| Load command naming a sub‐umbrella within an umbrella framework.
| xref:llvm/MachO/symseg_command.adoc[`symseg_command`] 
| Load command locating a GNU‐style symbol segment (obsolete).
| xref:llvm/MachO/symtab_command.adoc[`symtab_command`] 
| Load command locating the symbol table and string table.
| xref:llvm/MachO/target_triple_command.adoc[`target_triple_command`] 
| Load command embedding a target triple string.
| xref:llvm/MachO/thread_command.adoc[`thread_command`] 
| Load command carrying thread state (LC_THREAD / LC_UNIXTHREAD).
| xref:llvm/MachO/tlv_descriptor.adoc[`tlv_descriptor`] 
| Thread‐local variable descriptor using pointer‐sized fields.
| xref:llvm/MachO/tlv_descriptor_32.adoc[`tlv_descriptor_32`] 
| 32‐bit thread‐local variable descriptor.
| xref:llvm/MachO/tlv_descriptor_64.adoc[`tlv_descriptor_64`] 
| 64‐bit thread‐local variable descriptor.
| xref:llvm/MachO/twolevel_hint.adoc[`twolevel_hint`] 
| Two‐level namespace hint for a single undefined symbol.
| xref:llvm/MachO/twolevel_hints_command.adoc[`twolevel_hints_command`] 
| Load command locating the two‐level namespace hints table.
| xref:llvm/MachO/uuid_command.adoc[`uuid_command`] 
| Load command embedding a 128‐bit UUID for the binary.
| xref:llvm/MachO/version_min_command.adoc[`version_min_command`] 
| Load command recording the minimum OS version and SDK.
| xref:llvm/MachO/x86_exception_state64_t.adoc[`x86_exception_state64_t`] 
| 64‐bit x86 exception state.
| xref:llvm/MachO/x86_exception_state_t.adoc[`x86_exception_state_t`] 
| Flavor‐tagged x86 exception state.
| xref:llvm/MachO/x86_float_state64_t.adoc[`x86_float_state64_t`] 
| 64‐bit x86 floating‐point and SSE register state.
| xref:llvm/MachO/x86_float_state_t.adoc[`x86_float_state_t`] 
| Flavor‐tagged x86 floating‐point state.
| xref:llvm/MachO/x86_state_hdr_t.adoc[`x86_state_hdr_t`] 
| Flavor/count header preceding an x86 thread‐state blob.
| xref:llvm/MachO/x86_thread_state32_t.adoc[`x86_thread_state32_t`] 
| 32‐bit x86 general‐purpose thread state.
| xref:llvm/MachO/x86_thread_state64_t.adoc[`x86_thread_state64_t`] 
| 64‐bit x86_64 general‐purpose thread state.
| xref:llvm/MachO/x86_thread_state_t.adoc[`x86_thread_state_t`] 
| Flavor‐tagged x86 thread state (32‐ or 64‐bit).
| xref:llvm/MachO/xmm_reg_t.adoc[`xmm_reg_t`] 
| SSE XMM register image (16 bytes).
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/AliasEntry.adoc[`AliasEntry`] 
| Pair of a symbol name and its encode kind.
| xref:llvm/MachO/AliasMap.adoc[`AliasMap`] 
| Map from an alias symbol to its base symbol.
| xref:llvm/MachO/PathSeq.adoc[`PathSeq`] 
| Sequence of filesystem paths.
| xref:llvm/MachO/PathToPlatform.adoc[`PathToPlatform`] 
| Pair of a filesystem path and an optional platform.
| xref:llvm/MachO/PathToPlatformSeq.adoc[`PathToPlatformSeq`] 
| Sequence of path‐to‐platform pairs.
| xref:llvm/MachO/PlatformSet.adoc[`PlatformSet`] 
| Set of Mach‐O platform types.
| xref:llvm/MachO/PlatformVersionSet.adoc[`PlatformVersionSet`] 
| Set of Mach‐O platform and minimum deployment version pairs.
| xref:llvm/MachO/RecordMap.adoc[`RecordMap`] 
| Map from keys to owned records of type `V.`
| xref:llvm/MachO/Records.adoc[`Records`] 
| Collection of shared record slices across targets.
| xref:llvm/MachO/TargetList.adoc[`TargetList`] 
| Small list of TextAPI targets associated with a symbol.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/_04enum-0d0.adoc[`Unnamed enum`] 
| Mach‐O and fat‐binary magic numbers for mach_header::magic.
| xref:llvm/MachO/_04enum-05b.adoc[`Unnamed enum`] 
| Flag bits for mach_header::flags and mach_header_64::flags.
| xref:llvm/MachO/_04enum-03b.adoc[`Unnamed enum`] 
| High bit of load_command::cmd requiring dyld to understand the command.
| xref:llvm/MachO/_04enum-087.adoc[`Unnamed enum`] 
| Segment and section flag masks for segment_command and section headers.
| xref:llvm/MachO/_04enum-084.adoc[`Unnamed enum`] 
| User and system section‐attribute flags for section::flags.
| xref:llvm/MachO/_04enum-0df.adoc[`Unnamed enum`] 
| Masks that split a rebase opcode byte into opcode and immediate fields.
| xref:llvm/MachO/_04enum-00.adoc[`Unnamed enum`] 
| Bind symbol flags and opcode/immediate masks for the dyld bind stream.
| xref:llvm/MachO/_04enum-088.adoc[`Unnamed enum`] 
| Flag bits encoded in dyld export‐trie symbol info.
| xref:llvm/MachO/_04enum-04.adoc[`Unnamed enum`] 
| Bit masks for the n_type field in nlist / nlist_64.
| xref:llvm/MachO/_04enum-07.adoc[`Unnamed enum`] 
| Reference‐type and flag bits for the n_desc field in nlist / nlist_64.
| xref:llvm/MachO/_04enum-030.adoc[`Unnamed enum`] 
| Special relocation_info::r_symbolnum and r_address flag values.
| xref:llvm/MachO/_04enum-0a.adoc[`Unnamed enum`] 
| Virtual‐memory protection bits for segment_command::initprot / maxprot.
| xref:llvm/MachO/_04enum-035.adoc[`Unnamed enum`] 
| Tool identifiers for build_tool_version::tool.
| xref:llvm/MachO/_04enum-06e.adoc[`Unnamed enum`] 
| Symbol‐string table compression formats for dyld chained fixups.
| xref:llvm/MachO/_04enum-0c.adoc[`Unnamed enum`] 
| Sentinel values for dyld_chained_starts_in_segment::page_start.
| xref:llvm/MachO/_04enum-056.adoc[`Unnamed enum`] 
| Chained pointer encoding formats for dyld_chained_starts_in_segment.
| xref:llvm/MachO/_04enum-0fb2.adoc[`Unnamed enum`] 
| Architecture capability bits OR‐ed into CPUType values.
| xref:llvm/MachO/_04enum-0fba.adoc[`Unnamed enum`] 
| Capability and special bits for mach_header::cpusubtype.
| xref:llvm/MachO/_04enum-06c.adoc[`Unnamed enum`] 
| Limits and sentinel values for Intel CPU subtype encoding.
| xref:llvm/MachO/ARMThreadFlavors.adoc[`ARMThreadFlavors`] 
| Flavor codes selecting an ARM thread/VFP/exception state layout.
| xref:llvm/MachO/Architecture.adoc[`Architecture`] 
| Defines the architecture slices that are supported by Text‐based Stub files.
| xref:llvm/MachO/BindOpcode.adoc[`BindOpcode`] 
| Opcode values for the dyld bind bytecode stream.
| xref:llvm/MachO/BindSpecialDylib.adoc[`BindSpecialDylib`] 
| Special dylib ordinals used in dyld bind opcodes.
| xref:llvm/MachO/BindType.adoc[`BindType`] 
| Bind fixup type encodings used in the dyld bind stream.
| xref:llvm/MachO/CPUSubTypeARM.adoc[`CPUSubTypeARM`] 
| 32‐bit ARM CPU subtype codes.
| xref:llvm/MachO/CPUSubTypeARM64.adoc[`CPUSubTypeARM64`] 
| ARM64 CPU subtype codes and ptrauth ABI capability masks.
| xref:llvm/MachO/CPUSubTypeARM64_32.adoc[`CPUSubTypeARM64_32`] 
| ARM64_32 CPU subtype codes.
| xref:llvm/MachO/CPUSubTypePowerPC.adoc[`CPUSubTypePowerPC`] 
| PowerPC CPU subtype codes.
| xref:llvm/MachO/CPUSubTypeRISCV.adoc[`CPUSubTypeRISCV`] 
| RISC‐V CPU subtype codes.
| xref:llvm/MachO/CPUSubTypeSPARC.adoc[`CPUSubTypeSPARC`] 
| SPARC CPU subtype codes.
| xref:llvm/MachO/CPUSubTypeX86.adoc[`CPUSubTypeX86`] 
| x86 / x86_64 CPU subtype codes.
| xref:llvm/MachO/CPUType.adoc[`CPUType`] 
| Mach‐O CPU type codes for mach_header::cputype.
| xref:llvm/MachO/ChainedImportFormat.adoc[`ChainedImportFormat`] 
| Import‐table entry formats for dyld chained fixups.
| xref:llvm/MachO/CodeSignAttrs.adoc[`CodeSignAttrs`] 
| Code‐signing attribute flags for a process or signature.
| xref:llvm/MachO/CodeSignExecSegFlags.adoc[`CodeSignExecSegFlags`] 
| Executable‐segment flags stored in CS_CodeDirectory::execSegFlags.
| xref:llvm/MachO/CodeSignMagic.adoc[`CodeSignMagic`] 
| Magic numbers, slot indices, and hash constants for code signing blobs.
| xref:llvm/MachO/DataRegionType.adoc[`DataRegionType`] 
| Kinds of data‐in‐code entries (data_in_code_entry::kind).
| xref:llvm/MachO/EncodeKind.adoc[`EncodeKind`] 
| Mapping of entry types in TextStubs.
| xref:llvm/MachO/ExportSymbolKind.adoc[`ExportSymbolKind`] 
| Export‐trie symbol kind values (kind field of export flags).
| xref:llvm/MachO/FileType.adoc[`FileType`] 
| Defines the file type TextAPI files can represent.
| xref:llvm/MachO/HeaderFileType.adoc[`HeaderFileType`] 
| Mach‐O header filetype values (mach_header::filetype).
| xref:llvm/MachO/LinkerOptimizationHintKind.adoc[`LinkerOptimizationHintKind`] 
| Linker optimization hint (LOH) kinds for ARM64.
| xref:llvm/MachO/LoadCommandType.adoc[`LoadCommandType`] 
| Mach‐O load command type codes (load_command::cmd).
| xref:llvm/MachO/NListType.adoc[`NListType`] 
| Symbol type codes for (n_type & N_TYPE) in nlist / nlist_64.
| xref:llvm/MachO/ObjCConstraintType.adoc[`ObjCConstraintType`] 
| Defines a list of Objective‐C constraints.
| xref:llvm/MachO/ObjCIFSymbolKind.adoc[`ObjCIFSymbolKind`] 
| ObjC Interface symbol mappings.
| xref:llvm/MachO/PPCThreadFlavors.adoc[`PPCThreadFlavors`] 
| Flavor codes selecting a PowerPC thread/float/exception state layout.
| xref:llvm/MachO/PlatformType.adoc[`PlatformType`] 
| Platform identifiers for build_version_command::platform.
| xref:llvm/MachO/RebaseOpcode.adoc[`RebaseOpcode`] 
| Opcode values for the dyld rebase bytecode stream.
| xref:llvm/MachO/RebaseType.adoc[`RebaseType`] 
| Rebase fixup type encodings used in the dyld rebase stream.
| xref:llvm/MachO/RecordLinkage.adoc[`RecordLinkage`] 
| Linkage of a TAPI record relative to the library interface.
| xref:llvm/MachO/RelocationInfoType.adoc[`RelocationInfoType`] 
| Relocation type codes for relocation_info::r_type by architecture.
| xref:llvm/MachO/SecCSDigestAlgorithm.adoc[`SecCSDigestAlgorithm`] 
| Digest algorithms used by code‐signing hashes.
| xref:llvm/MachO/SectionOrdinal.adoc[`SectionOrdinal`] 
| Special section ordinal values for nlist::n_sect.
| xref:llvm/MachO/SectionType.adoc[`SectionType`] 
| These are the section type and attributes fields. A MachO section can have only one Type, but can have any of the attributes specified.
| xref:llvm/MachO/StabType.adoc[`StabType`] 
| Stab debug symbol type codes when (n_type & N_STAB) != 0.
| xref:llvm/MachO/SymbolFlags.adoc[`SymbolFlags`] 
| Symbol flags.
| xref:llvm/MachO/TextAPIErrorCode.adoc[`TextAPIErrorCode`] 
| Error codes for failures while reading or writing TextAPI files.
| xref:llvm/MachO/X86ThreadFlavors.adoc[`X86ThreadFlavors`] 
| Flavor codes selecting an x86 thread/float/exception state layout.
| xref:llvm/MachO/x86_fp_control_precis.adoc[`x86_fp_control_precis`] 
| x87 floating‐point precision control encodings.
| xref:llvm/MachO/x86_fp_control_rc.adoc[`x86_fp_control_rc`] 
| x87 floating‐point rounding‐control encodings.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/CPU_SUBTYPE_ARM64E_IS_KERNEL_PTRAUTH_ABI.adoc[`CPU_SUBTYPE_ARM64E_IS_KERNEL_PTRAUTH_ABI`] 
| Return true if `ST` marks a kernel ptrauth ABI arm64e binary.
| xref:llvm/MachO/CPU_SUBTYPE_ARM64E_IS_VERSIONED_PTRAUTH_ABI.adoc[`CPU_SUBTYPE_ARM64E_IS_VERSIONED_PTRAUTH_ABI`] 
| Return true if `ST` marks a versioned ptrauth ABI arm64e binary.
| xref:llvm/MachO/CPU_SUBTYPE_ARM64E_PTRAUTH_VERSION.adoc[`CPU_SUBTYPE_ARM64E_PTRAUTH_VERSION`] 
| Extract the 4‐bit ptrauth ABI version from an arm64e CPU subtype.
| xref:llvm/MachO/CPU_SUBTYPE_ARM64E_WITH_PTRAUTH_VERSION.adoc[`CPU_SUBTYPE_ARM64E_WITH_PTRAUTH_VERSION`] 
| Build an arm64e CPU subtype with the given ptrauth ABI version.
| xref:llvm/MachO/CPU_SUBTYPE_INTEL.adoc[`CPU_SUBTYPE_INTEL`] 
| Encode an Intel CPU subtype from family and model numbers.
| xref:llvm/MachO/CPU_SUBTYPE_INTEL_FAMILY.adoc[`CPU_SUBTYPE_INTEL_FAMILY`] 
| Extract the Intel CPU family from a CPU subtype.
| xref:llvm/MachO/CPU_SUBTYPE_INTEL_MODEL.adoc[`CPU_SUBTYPE_INTEL_MODEL`] 
| Extract the Intel CPU model from a CPU subtype.
| xref:llvm/MachO/GET_COMM_ALIGN.adoc[`GET_COMM_ALIGN`] 
| Extract the common‐symbol alignment from an nlist n_desc value.
| xref:llvm/MachO/GET_LIBRARY_ORDINAL.adoc[`GET_LIBRARY_ORDINAL`] 
| Extract the library ordinal from an nlist n_desc value.
| xref:llvm/MachO/SET_COMM_ALIGN.adoc[`SET_COMM_ALIGN`] 
| Store `align` into the common‐symbol alignment bits of `n_desc.`
| xref:llvm/MachO/SET_LIBRARY_ORDINAL.adoc[`SET_LIBRARY_ORDINAL`] 
| Store `ordinal` into the library‐ordinal bits of `n_desc.`
| xref:llvm/MachO/addEntry-0a.adoc[`addEntry`] 
| `addEntry` overloads
| xref:llvm/MachO/convertToInterfaceFile.adoc[`convertToInterfaceFile`] 
| Convert a collection of record slices into an interface file.
| xref:llvm/MachO/createRegexFromGlob.adoc[`createRegexFromGlob`] 
| Create a regex rule from provided glob string.
| xref:llvm/MachO/getArchitectureFromCpuType.adoc[`getArchitectureFromCpuType`] 
| Convert a CPU Type and Subtype pair to an architecture slice.
| xref:llvm/MachO/getArchitectureFromName.adoc[`getArchitectureFromName`] 
| Convert a name to an architecture slice.
| xref:llvm/MachO/getArchitectureName.adoc[`getArchitectureName`] 
| Convert an architecture slice to a string.
| xref:llvm/MachO/getCPUSubType-09.adoc[`getCPUSubType`] 
| `getCPUSubType` overloads
| xref:llvm/MachO/getCPUType.adoc[`getCPUType`] 
| Map a target triple to a Mach‐O CPUType value.
| xref:llvm/MachO/getCPUTypeFromArchitecture.adoc[`getCPUTypeFromArchitecture`] 
| Convert an architecture slice to a CPU Type and Subtype pair.
| xref:llvm/MachO/getOSAndEnvironmentName.adoc[`getOSAndEnvironmentName`] 
| Build an OS and environment name string for a platform.
| xref:llvm/MachO/getPathsForPlatform.adoc[`getPathsForPlatform`] 
| Pickup active paths for a given platform.
| xref:llvm/MachO/getPlatformFromName.adoc[`getPlatformFromName`] 
| Convert a platform name to a platform type.
| xref:llvm/MachO/getPlatformName.adoc[`getPlatformName`] 
| Convert a platform type to its marketing name.
| xref:llvm/MachO/getTargetTripleName.adoc[`getTargetTripleName`] 
| Build a target triple name string for a TextAPI target.
| xref:llvm/MachO/is64Bit.adoc[`is64Bit`] 
| Check if architecture is 64 bit.
| xref:llvm/MachO/isPrivateLibrary.adoc[`isPrivateLibrary`] 
| Determine if library is private by parsing file path. It does not touch the file system.
| xref:llvm/MachO/isVirtualSection.adoc[`isVirtualSection`] 
| Return true if `type` is a zerofill section that has no file content.
| xref:llvm/MachO/make_relative.adoc[`make_relative`] 
| Turn absolute symlink into relative.
| xref:llvm/MachO/mapToArchitecture.adoc[`mapToArchitecture`] 
| Convert a target to an architecture slice.
| xref:llvm/MachO/mapToArchitectureSet.adoc[`mapToArchitectureSet`] 
| Map a list of targets to the set of architectures.
| xref:llvm/MachO/mapToPlatformSet-0d.adoc[`mapToPlatformSet`] 
| `mapToPlatformSet` overloads
| xref:llvm/MachO/mapToPlatformType-04.adoc[`mapToPlatformType`] 
| `mapToPlatformType` overloads
| xref:llvm/MachO/mapToPlatformVersionSet.adoc[`mapToPlatformVersionSet`] 
| Map a list of targets to the set of platform and version pairs.
| xref:llvm/MachO/mapToSupportedOSVersion.adoc[`mapToSupportedOSVersion`] 
| Map a triple to a supported OS version for TextAPI.
| xref:llvm/MachO/operator_bitor-0c.adoc[`operator|`] 
| Form the union of two single architectures as an ArchitectureSet.
| xref:llvm/MachO/parseAliasList.adoc[`parseAliasList`] 
| Parse input list and capture symbols and their alias.
| xref:llvm/MachO/parseSymbol.adoc[`parseSymbol`] 
| Get symbol classification by parsing the name of a symbol.
| xref:llvm/MachO/replace_extension.adoc[`replace_extension`] 
| Replace extension considering frameworks.
| xref:llvm/MachO/shouldSkipSymLink.adoc[`shouldSkipSymLink`] 
| Determine whether to skip over symlink due to either too many symlink levels or is cyclic.
| xref:llvm/MachO/swapStruct-0ce.adoc[`swapStruct`] 
| `swapStruct` overloads
| xref:llvm/MachO/operator_lshift-088.adoc[`operator<<`] 
| Stream insertion operators
| xref:llvm/MachO/operator_eq-03.adoc[`operator==`] 
| Equality operators
| xref:llvm/MachO/operator_not_eq-0b.adoc[`operator!=`] 
| Inequality operators
| xref:llvm/MachO/operator_lt.adoc[`operator<`] 
| Order two targets by architecture and platform.
|===


== Variables

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/ARM_THREAD_STATE64_COUNT.adoc[`ARM_THREAD_STATE64_COUNT`] 
| Count of uint32_t words in arm_thread_state64_t.
| xref:llvm/MachO/ARM_THREAD_STATE_COUNT.adoc[`ARM_THREAD_STATE_COUNT`] 
| Count of uint32_t words in arm_thread_state32_t.
| xref:llvm/MachO/ObjC1ClassNamePrefix.adoc[`ObjC1ClassNamePrefix`] 
| Prefix for Objective‐C 1 class name symbols.
| xref:llvm/MachO/ObjC2ClassNamePrefix.adoc[`ObjC2ClassNamePrefix`] 
| Prefix for Objective‐C 2 class name symbols.
| xref:llvm/MachO/ObjC2EHTypePrefix.adoc[`ObjC2EHTypePrefix`] 
| Prefix for Objective‐C 2 exception‐handling type symbols.
| xref:llvm/MachO/ObjC2IVarPrefix.adoc[`ObjC2IVarPrefix`] 
| Prefix for Objective‐C 2 instance variable symbols.
| xref:llvm/MachO/ObjC2MetaClassNamePrefix.adoc[`ObjC2MetaClassNamePrefix`] 
| Prefix for Objective‐C 2 metaclass name symbols.
| xref:llvm/MachO/PPC_THREAD_STATE_COUNT.adoc[`PPC_THREAD_STATE_COUNT`] 
| Count of uint32_t words in ppc_thread_state32_t.
| xref:llvm/MachO/x86_EXCEPTION_STATE64_COUNT.adoc[`x86_EXCEPTION_STATE64_COUNT`] 
| Count of uint32_t words in x86_exception_state64_t.
| xref:llvm/MachO/x86_EXCEPTION_STATE_COUNT.adoc[`x86_EXCEPTION_STATE_COUNT`] 
| Count of uint32_t words in x86_exception_state_t.
| xref:llvm/MachO/x86_FLOAT_STATE64_COUNT.adoc[`x86_FLOAT_STATE64_COUNT`] 
| Count of uint32_t words in x86_float_state64_t.
| xref:llvm/MachO/x86_FLOAT_STATE_COUNT.adoc[`x86_FLOAT_STATE_COUNT`] 
| Count of uint32_t words in x86_float_state_t.
| xref:llvm/MachO/x86_THREAD_STATE32_COUNT.adoc[`x86_THREAD_STATE32_COUNT`] 
| Count of uint32_t words in x86_thread_state32_t.
| xref:llvm/MachO/x86_THREAD_STATE64_COUNT.adoc[`x86_THREAD_STATE64_COUNT`] 
| Count of uint32_t words in x86_thread_state64_t.
| xref:llvm/MachO/x86_THREAD_STATE_COUNT.adoc[`x86_THREAD_STATE_COUNT`] 
| Count of uint32_t words in x86_thread_state_t.
|===


== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MachO/any.adoc[`any`] 
| Bring bitmask enum any‐bits‐set test into this namespace for ADL.
| xref:llvm/MachO/operator_not.adoc[`operator!`] 
| Bring bitmask enum logical‐not into this namespace for ADL.
| xref:llvm/MachO/operator_bitand.adoc[`operator&`] 
| Bring bitmask enum bitwise AND into this namespace for ADL.
| xref:llvm/MachO/operator_and_eq.adoc[`operator&=`] 
| Bring bitmask enum in‐place AND into this namespace for ADL.
| xref:llvm/MachO/operator_lshift-0e.adoc[`operator<<`] 
| Bring bitmask enum left‐shift into this namespace for ADL.
| xref:llvm/MachO/operator_lshift_eq.adoc[`operator<<=`] 
| Bring bitmask enum in‐place left‐shift into this namespace for ADL.
| xref:llvm/MachO/operator_rshift.adoc[`operator>>`] 
| Bring bitmask enum right‐shift into this namespace for ADL.
| xref:llvm/MachO/operator_rshift_eq.adoc[`operator>>=`] 
| Bring bitmask enum in‐place right‐shift into this namespace for ADL.
| xref:llvm/MachO/operator_xor.adoc[`operatorˆ`] 
| Bring bitmask enum bitwise XOR into this namespace for ADL.
| xref:llvm/MachO/operator_xor_eq.adoc[`operatorˆ=`] 
| Bring bitmask enum in‐place XOR into this namespace for ADL.
| xref:llvm/MachO/operator_bitor-0e.adoc[`operator|`] 
| Bring bitmask enum bitwise OR into this namespace for ADL.
| xref:llvm/MachO/operator_or_eq.adoc[`operator|=`] 
| Bring bitmask enum in‐place OR into this namespace for ADL.
| xref:llvm/MachO/operator_bitnot.adoc[`operator~`] 
| Bring bitmask enum bitwise NOT into this namespace for ADL.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#