#include <Uefi.h>
#include <IndustryStandard/AppleMachoImage.h>
#include <IndustryStandard/AppleFatBinaryImage.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/BaseOverflowLib.h>
#include <Library/DebugLib.h>
#include <Library/OcMachoLib.h>
#include "OcMachoLibInternal.h"

Functions
BOOLEAN	MachoInitializeContext (OUT OC_MACHO_CONTEXT Context, IN VOID FileData, IN UINT32 FileSize, IN UINT32 HeaderOffset, IN UINT32 InnerSize, IN BOOLEAN Is32Bit)

MACH_HEADER_ANY *	MachoGetMachHeader (IN OUT OC_MACHO_CONTEXT *Context)

UINT32	MachoGetInnerSize (IN OUT OC_MACHO_CONTEXT *Context)

VOID *	MachoGetFileData (IN OUT OC_MACHO_CONTEXT *Context)

UINT32	MachoGetFileSize (IN OUT OC_MACHO_CONTEXT *Context)

UINT32	MachoGetVmSize (IN OUT OC_MACHO_CONTEXT *Context)

UINT64	MachoGetLastAddress (IN OUT OC_MACHO_CONTEXT *Context)

MACH_LOAD_COMMAND *	MachoGetNextCommand (IN OUT OC_MACHO_CONTEXT Context, IN MACH_LOAD_COMMAND_TYPE LoadCommandType, IN CONST MACH_LOAD_COMMAND LoadCommand OPTIONAL)

MACH_UUID_COMMAND *	MachoGetUuid (IN OUT OC_MACHO_CONTEXT *Context)

MACH_SEGMENT_COMMAND_ANY *	MachoGetNextSegment (IN OUT OC_MACHO_CONTEXT Context, IN CONST MACH_SEGMENT_COMMAND_ANY Segment OPTIONAL)

MACH_SECTION_ANY *	MachoGetNextSection (IN OUT OC_MACHO_CONTEXT Context, IN MACH_SEGMENT_COMMAND_ANY Segment, IN MACH_SECTION_ANY *Section OPTIONAL)

MACH_SECTION_ANY *	MachoGetSectionByIndex (IN OUT OC_MACHO_CONTEXT *Context, IN UINT32 Index)

MACH_SEGMENT_COMMAND_ANY *	MachoGetSegmentByName (IN OUT OC_MACHO_CONTEXT Context, IN CONST CHAR8 SegmentName)

MACH_SECTION_ANY *	MachoGetSectionByName (IN OUT OC_MACHO_CONTEXT Context, IN MACH_SEGMENT_COMMAND_ANY Segment, IN CONST CHAR8 *SectionName)

MACH_SECTION_ANY *	MachoGetSegmentSectionByName (IN OUT OC_MACHO_CONTEXT Context, IN CONST CHAR8 SegmentName, IN CONST CHAR8 *SectionName)

STATIC BOOLEAN	InternalInitialiseSymtabs (IN OUT OC_MACHO_CONTEXT Context, IN MACH_SYMTAB_COMMAND Symtab, IN MACH_DYSYMTAB_COMMAND *DySymtab)

BOOLEAN	MachoInitialiseSymtabsExternal (IN OUT OC_MACHO_CONTEXT Context, IN OC_MACHO_CONTEXT SymsContext)

BOOLEAN	InternalRetrieveSymtabs (IN OUT OC_MACHO_CONTEXT *Context)

UINT32	MachoGetSymbolTable (IN OUT OC_MACHO_CONTEXT Context, OUT CONST MACH_NLIST_ANY SymbolTable, OUT CONST CHAR8 StringTable OPTIONAL, OUT CONST MACH_NLIST_ANY LocalSymbols OPTIONAL, OUT UINT32 NumLocalSymbols OPTIONAL, OUT CONST MACH_NLIST_ANY *ExternalSymbols OPTIONAL, OUT UINT32 NumExternalSymbols OPTIONAL, OUT CONST MACH_NLIST_ANY *UndefinedSymbols OPTIONAL, OUT UINT32 NumUndefinedSymbols OPTIONAL)

UINT32	MachoGetIndirectSymbolTable (IN OUT OC_MACHO_CONTEXT Context, OUT CONST MACH_NLIST_ANY *SymbolTable)

UINT64	MachoRuntimeGetEntryAddress (IN VOID *Image)

VOID *	MachoGetFilePointerByAddress (IN OUT OC_MACHO_CONTEXT Context, IN UINT64 Address, OUT UINT32 MaxSize OPTIONAL)

UINT32	MachoExpandImage (IN OC_MACHO_CONTEXT Context, OUT UINT8 Destination, IN UINT32 DestinationSize, IN BOOLEAN Strip, OUT UINT64 *FileOffset OPTIONAL)

UINT32	MachoGetExpandedImageSize (IN OC_MACHO_CONTEXT *Context)

BOOLEAN	MachoMergeSegments (IN OUT OC_MACHO_CONTEXT Context, IN CONST CHAR8 Prefix)

Function Documentation

◆ InternalInitialiseSymtabs()

STATIC BOOLEAN InternalInitialiseSymtabs	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN MACH_SYMTAB_COMMAND *	Symtab,
		IN MACH_DYSYMTAB_COMMAND *	DySymtab )

Initialises the symbol information of Context.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Symtab	The SYMTAB command to initialise with.
[in]	DySymtab	The DYSYMTAB command to initialise with.

Returns: Whether the operation was successful.

Definition at line 253 of file Header.c.

◆ InternalRetrieveSymtabs()

BOOLEAN InternalRetrieveSymtabs ( IN OUT OC_MACHO_CONTEXT * Context )

Retrieves the SYMTAB command.

Parameters

[in] Context Context of the Mach-O.

Return values

NULL	NULL is returned on failure.

Definition at line 508 of file Header.c.

◆ MachoExpandImage()

UINT32 MachoExpandImage	(	IN OC_MACHO_CONTEXT *	Context,
		OUT UINT8 *	Destination,
		IN UINT32	DestinationSize,
		IN BOOLEAN	Strip,
		OUT UINT64 *FileOffset	OPTIONAL )

Expand Mach-O image to Destination (make segment file sizes equal to vm sizes).

Parameters

[in]	Context	Context of the Mach-O.
[out]	Destination	Output buffer.
[in]	DestinationSize	Output buffer maximum size.
[in]	Strip	Output with stripped prelink commands.
[in]	FileOffset	Pointer to the file offset of the first segment.

Returns: New image size or 0 on failure.

Definition at line 645 of file Header.c.

◆ MachoGetExpandedImageSize()

UINT32 MachoGetExpandedImageSize ( IN OC_MACHO_CONTEXT * Context )

Calculates size required for expanded Mach-O image using MachoExpandImage().

Parameters

[in] Context Context of the Mach-O.

Returns: New image size or 0 on failure.

Definition at line 661 of file Header.c.

◆ MachoGetFileData()

VOID * MachoGetFileData ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the file data of the Mach-O.

Parameters

[in,out] Context Context of the Mach-O.

Definition at line 66 of file Header.c.

◆ MachoGetFilePointerByAddress()

VOID * MachoGetFilePointerByAddress	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT64	Address,
		OUT UINT32 *MaxSize	OPTIONAL )

Returns a pointer to the Mach-O file at the specified virtual address.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Address	Virtual address to look up.
[out]	MaxSize	Maximum data safely available from FileOffset. If NULL is returned, the output is undefined.

Definition at line 627 of file Header.c.

◆ MachoGetFileSize()

UINT32 MachoGetFileSize ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the Mach-O's file size.

Parameters

[in,out] Context Context of the Mach-O.

Definition at line 77 of file Header.c.

◆ MachoGetIndirectSymbolTable()

UINT32 MachoGetIndirectSymbolTable	(	IN OUT OC_MACHO_CONTEXT *	Context,
		OUT CONST MACH_NLIST_ANY **	SymbolTable )

Obtain indirect symbol table.

Parameters

[in]	Context	Context of the Mach-O.
[in,out]	SymbolTable	Indirect symbol table.

Returns: number of symbols in indirect symbol table or 0.

Definition at line 559 of file Header.c.

◆ MachoGetInnerSize()

UINT32 MachoGetInnerSize ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the size of the inner Mach-O file (otherwise, the file size).

Parameters

[in,out] Context Context of the Mach-O.

Definition at line 55 of file Header.c.

◆ MachoGetLastAddress()

UINT64 MachoGetLastAddress ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the last virtual address of a Mach-O.

Parameters

[in] Context Context of the Mach-O.

Return values

0	The binary is malformed.

Definition at line 99 of file Header.c.

◆ MachoGetMachHeader()

MACH_HEADER_ANY * MachoGetMachHeader ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the universal Mach-O Header structure.

Parameters

[in,out] Context Context of the Mach-O.

Definition at line 44 of file Header.c.

◆ MachoGetNextCommand()

MACH_LOAD_COMMAND * MachoGetNextCommand	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN MACH_LOAD_COMMAND_TYPE	LoadCommandType,
		IN CONST MACH_LOAD_COMMAND *LoadCommand	OPTIONAL )

Retrieves the next Load Command of type LoadCommandType.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	LoadCommandType	Type of the Load Command to retrieve.
[in]	LoadCommand	Previous Load Command. If NULL, the first match is returned.

Return values

NULL	NULL is returned on failure.

Definition at line 110 of file Header.c.

◆ MachoGetNextSection()

MACH_SECTION_ANY * MachoGetNextSection	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN MACH_SEGMENT_COMMAND_ANY *	Segment,
		IN MACH_SECTION_ANY *Section	OPTIONAL )

Retrieves the next section of a segment.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Segment	The segment to get the section of.
[in]	Section	The section to get the successor of.

Return values

NULL	NULL is returned on failure.

Definition at line 173 of file Header.c.

◆ MachoGetNextSegment()

MACH_SEGMENT_COMMAND_ANY * MachoGetNextSegment	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_SEGMENT_COMMAND_ANY *Segment	OPTIONAL )

Retrieves the next segment.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Segment	Segment to retrieve the successor of. if NULL, the first segment is returned.

Return values

NULL	NULL is returned on failure.

Definition at line 160 of file Header.c.

◆ MachoGetSectionByIndex()

MACH_SECTION_ANY * MachoGetSectionByIndex	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT32	Index )

Retrieves a section by its index.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Index	Index of the section to retrieve.

Return values

NULL	NULL is returned on failure.

Definition at line 188 of file Header.c.

◆ MachoGetSectionByName()

MACH_SECTION_ANY * MachoGetSectionByName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN MACH_SEGMENT_COMMAND_ANY *	Segment,
		IN CONST CHAR8 *	SectionName )

Retrieves the first section by the name of SectionName.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Segment	Segment to search in.
[in]	SectionName	Section name to search for.

Return values

NULL	NULL is returned on failure.

Definition at line 214 of file Header.c.

◆ MachoGetSegmentByName()

MACH_SEGMENT_COMMAND_ANY * MachoGetSegmentByName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST CHAR8 *	SegmentName )

Retrieves the first segment by the name of SegmentName.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	SegmentName	Segment name to search for.

Return values

NULL	NULL is returned on failure.

Definition at line 201 of file Header.c.

◆ MachoGetSegmentSectionByName()

MACH_SECTION_ANY * MachoGetSegmentSectionByName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST CHAR8 *	SegmentName,
		IN CONST CHAR8 *	SectionName )

Retrieves a section within a segment by the name of SegmentName.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	SegmentName	The name of the segment to search in.
[in]	SectionName	The name of the section to search for.

Return values

NULL	NULL is returned on failure.

Definition at line 228 of file Header.c.

◆ MachoGetSymbolTable()

UINT32 MachoGetSymbolTable	(	IN OUT OC_MACHO_CONTEXT *	Context,
		OUT CONST MACH_NLIST_ANY **	SymbolTable,
		OUT CONST CHAR8 **StringTable	OPTIONAL,
		OUT CONST MACH_NLIST_ANY **LocalSymbols	OPTIONAL,
		OUT UINT32 *NumLocalSymbols	OPTIONAL,
		OUT CONST MACH_NLIST_ANY **ExternalSymbols	OPTIONAL,
		OUT UINT32 *NumExternalSymbols	OPTIONAL,
		OUT CONST MACH_NLIST_ANY **UndefinedSymbols	OPTIONAL,
		OUT UINT32 *NumUndefinedSymbols	OPTIONAL )

Obtain symbol tables.

Parameters

[in]	Context	Context of the Mach-O.
[out]	SymbolTable	Symbol table.
[out]	StringTable	String table for that symbol table.
[out]	LocalSymbols	Local symbol table.
[out]	NumLocalSymbols	Number of symbols in local symbol table.
[out]	ExternalSymbols	External symbol table.
[out]	NumExternalSymbols	Number of symbols in external symbol table.
[out]	UndefinedSymbols	Undefined symbol table.
[out]	NumUndefinedSymbols	Number of symbols in undefined symbol table.

Returns: number of symbols in symbol table or 0.

Definition at line 519 of file Header.c.

◆ MachoGetUuid()

MACH_UUID_COMMAND * MachoGetUuid ( IN OUT OC_MACHO_CONTEXT * Context )

Retrieves the first UUID Load Command.

Parameters

[in,out] Context Context of the Mach-O.

Return values

NULL	NULL is returned on failure.

Definition at line 124 of file Header.c.

◆ MachoGetVmSize()

UINT32 MachoGetVmSize ( IN OUT OC_MACHO_CONTEXT * Context )

Returns the Mach-O's virtual address space size.

Parameters

[out] Context Context of the Mach-O.

Definition at line 88 of file Header.c.

◆ MachoInitialiseSymtabsExternal()

BOOLEAN MachoInitialiseSymtabsExternal	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN OC_MACHO_CONTEXT *	SymsContext )

Definition at line 423 of file Header.c.

◆ MachoInitializeContext()

BOOLEAN MachoInitializeContext	(	OUT OC_MACHO_CONTEXT *	Context,
		IN VOID *	FileData,
		IN UINT32	FileSize,
		IN UINT32	HeaderOffset,
		IN UINT32	InnerSize,
		IN BOOLEAN	Is32Bit )

Provides services for Mach-O headers.

Copyright (C) 2016 - 2018, Download-Fritz. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition at line 29 of file Header.c.

◆ MachoMergeSegments()

BOOLEAN MachoMergeSegments	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST CHAR8 *	Prefix )

Merge Mach-O segments into one with lowest protection.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Prefix	Segment prefix to merge.

Return values

TRUE	on success

Definition at line 673 of file Header.c.

◆ MachoRuntimeGetEntryAddress()

UINT64 MachoRuntimeGetEntryAddress ( IN VOID * Image )

Find Mach-O entry point from LC_UNIXTHREAD loader command. This command does not verify Mach-O and assumes it is valid.

Parameters

[in] Image Loaded Mach-O image.

Returns: Entry point or 0.

Definition at line 572 of file Header.c.

	OpenCore 1.0.4 OpenCore Bootloader
1.0.4

Functions

Function Documentation

◆ InternalInitialiseSymtabs()

◆ InternalRetrieveSymtabs()

◆ MachoExpandImage()

◆ MachoGetExpandedImageSize()

◆ MachoGetFileData()

◆ MachoGetFilePointerByAddress()

◆ MachoGetFileSize()

◆ MachoGetIndirectSymbolTable()

◆ MachoGetInnerSize()

◆ MachoGetLastAddress()

◆ MachoGetMachHeader()

◆ MachoGetNextCommand()

◆ MachoGetNextSection()

◆ MachoGetNextSegment()

◆ MachoGetSectionByIndex()

◆ MachoGetSectionByName()

◆ MachoGetSegmentByName()

◆ MachoGetSegmentSectionByName()

◆ MachoGetSymbolTable()

◆ MachoGetUuid()

◆ MachoGetVmSize()

◆ MachoInitialiseSymtabsExternal()

◆ MachoInitializeContext()

◆ MachoMergeSegments()

◆ MachoRuntimeGetEntryAddress()