OcMachoLib.h

Go to the documentation of this file.

 
#ifndef OC_MACHO_LIB_H
#define OC_MACHO_LIB_H
 
#include <IndustryStandard/AppleMachoImage.h>
 
#define MACHO_PAGE_SIZE  4096U
 
#define MACHO_ALIGN(x)  ALIGN_VALUE((x), MACHO_PAGE_SIZE)
 
typedef struct {
  VOID                     *FileData;
  UINT32                   FileSize;
 
  MACH_HEADER_ANY          *MachHeader;
  UINT32                   InnerSize;
  MACH_SYMTAB_COMMAND      *Symtab;
  MACH_NLIST_ANY           *SymbolTable;
  CHAR8                    *StringTable;
  MACH_DYSYMTAB_COMMAND    *DySymtab;
  MACH_RELOCATION_INFO     *LocalRelocations;
  MACH_RELOCATION_INFO     *ExternRelocations;
 
  BOOLEAN                  Is32Bit;
} OC_MACHO_CONTEXT;
 
BOOLEAN
MachoInitializeContext32 (
  OUT OC_MACHO_CONTEXT  *Context,
  IN  VOID              *FileData,
  IN  UINT32            FileSize,
  IN  UINT32            HeaderOffset,
  IN  UINT32            InnerSize
  );
 
BOOLEAN
MachoInitializeContext64 (
  OUT OC_MACHO_CONTEXT  *Context,
  IN  VOID              *FileData,
  IN  UINT32            FileSize,
  IN  UINT32            HeaderOffset,
  IN  UINT32            InnerSize
  );
 
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
  );
 
MACH_HEADER *
MachoGetMachHeader32 (
  IN OUT OC_MACHO_CONTEXT  *Context
  );
 
MACH_HEADER_64 *
MachoGetMachHeader64 (
  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_UUID_COMMAND *
MachoGetUuid (
  IN OUT OC_MACHO_CONTEXT  *Context
  );
 
MACH_SEGMENT_COMMAND_ANY *
MachoGetSegmentByName (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SegmentName
  );
 
MACH_SEGMENT_COMMAND *
MachoGetSegmentByName32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SegmentName
  );
 
MACH_SEGMENT_COMMAND_64 *
MachoGetSegmentByName64 (
  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 *
MachoGetSectionByName32 (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     MACH_SEGMENT_COMMAND  *Segment,
  IN     CONST CHAR8           *SectionName
  );
 
MACH_SECTION_64 *
MachoGetSectionByName64 (
  IN OUT OC_MACHO_CONTEXT         *Context,
  IN     MACH_SEGMENT_COMMAND_64  *Segment,
  IN     CONST CHAR8              *SectionName
  );
 
MACH_SECTION_ANY *
MachoGetSegmentSectionByName (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SegmentName,
  IN     CONST CHAR8       *SectionName
  );
 
MACH_SECTION *
MachoGetSegmentSectionByName32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SegmentName,
  IN     CONST CHAR8       *SectionName
  );
 
MACH_SECTION_64 *
MachoGetSegmentSectionByName64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SegmentName,
  IN     CONST CHAR8       *SectionName
  );
 
MACH_SEGMENT_COMMAND_ANY *
MachoGetNextSegment (
  IN OUT OC_MACHO_CONTEXT                *Context,
  IN     CONST MACH_SEGMENT_COMMAND_ANY  *Segment  OPTIONAL
  );
 
MACH_SEGMENT_COMMAND *
MachoGetNextSegment32 (
  IN OUT OC_MACHO_CONTEXT            *Context,
  IN     CONST MACH_SEGMENT_COMMAND  *Segment  OPTIONAL
  );
 
MACH_SEGMENT_COMMAND_64 *
MachoGetNextSegment64 (
  IN OUT OC_MACHO_CONTEXT               *Context,
  IN     CONST MACH_SEGMENT_COMMAND_64  *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 *
MachoGetNextSection32 (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     MACH_SEGMENT_COMMAND  *Segment,
  IN     MACH_SECTION          *Section  OPTIONAL
  );
 
MACH_SECTION_64 *
MachoGetNextSection64 (
  IN OUT OC_MACHO_CONTEXT         *Context,
  IN     MACH_SEGMENT_COMMAND_64  *Segment,
  IN     MACH_SECTION_64          *Section  OPTIONAL
  );
 
MACH_SECTION_ANY *
MachoGetSectionByIndex (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
MACH_SECTION *
MachoGetSectionByIndex32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
MACH_SECTION_64 *
MachoGetSectionByIndex64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
MACH_SECTION *
MachoGetSectionByAddress32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Address
  );
 
MACH_SECTION_64 *
MachoGetSectionByAddress64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            Address
  );
 
BOOLEAN
MachoMergeSegments (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *Prefix
  );
 
BOOLEAN
MachoSymbolIsSection32 (
  IN CONST MACH_NLIST  *Symbol
  );
 
BOOLEAN
MachoSymbolIsSection64 (
  IN CONST MACH_NLIST_64  *Symbol
  );
 
BOOLEAN
MachoSymbolIsDefined (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN CONST MACH_NLIST_ANY  *Symbol
  );
 
BOOLEAN
MachoSymbolIsDefined32 (
  IN CONST MACH_NLIST  *Symbol
  );
 
BOOLEAN
MachoSymbolIsDefined64 (
  IN CONST MACH_NLIST_64  *Symbol
  );
 
BOOLEAN
MachoSymbolIsLocalDefined (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST MACH_NLIST_ANY  *Symbol
  );
 
BOOLEAN
MachoSymbolIsLocalDefined32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST MACH_NLIST  *Symbol
  );
 
BOOLEAN
MachoSymbolIsLocalDefined64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST MACH_NLIST_64  *Symbol
  );
 
MACH_NLIST_ANY *
MachoGetLocalDefinedSymbolByName (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *Name
  );
 
MACH_NLIST *
MachoGetLocalDefinedSymbolByName32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *Name
  );
 
MACH_NLIST_64 *
MachoGetLocalDefinedSymbolByName64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *Name
  );
 
MACH_NLIST_ANY *
MachoGetSymbolByIndex (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
MACH_NLIST *
MachoGetSymbolByIndex32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
MACH_NLIST_64 *
MachoGetSymbolByIndex64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Index
  );
 
CONST CHAR8 *
MachoGetSymbolName (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST MACH_NLIST_ANY  *Symbol
  );
 
CONST CHAR8 *
MachoGetSymbolName32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST MACH_NLIST  *Symbol
  );
 
CONST CHAR8 *
MachoGetSymbolName64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST MACH_NLIST_64  *Symbol
  );
 
CONST CHAR8 *
MachoGetIndirectSymbolName (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST MACH_NLIST_ANY  *Symbol
  );
 
CONST CHAR8 *
MachoGetIndirectSymbolName32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST MACH_NLIST  *Symbol
  );
 
CONST CHAR8 *
MachoGetIndirectSymbolName64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST MACH_NLIST_64  *Symbol
  );
 
BOOLEAN
MachoIsSymbolValueInRange (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST MACH_NLIST_ANY  *Symbol
  );
 
BOOLEAN
MachoIsSymbolValueInRange32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST MACH_NLIST  *Symbol
  );
 
BOOLEAN
MachoIsSymbolValueInRange64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST MACH_NLIST_64  *Symbol
  );
 
BOOLEAN
MachoGetSymbolByRelocationOffset32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Address,
  OUT    MACH_NLIST        **Symbol
  );
 
BOOLEAN
MachoGetSymbolByRelocationOffset64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            Address,
  OUT    MACH_NLIST_64     **Symbol
  );
 
BOOLEAN
MachoGetSymbolByExternRelocationOffset (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            Address,
  OUT    MACH_NLIST_ANY    **Symbol
  );
 
BOOLEAN
MachoGetSymbolByExternRelocationOffset32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            Address,
  OUT    MACH_NLIST        **Symbol
  );
 
BOOLEAN
MachoGetSymbolByExternRelocationOffset64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            Address,
  OUT    MACH_NLIST_64     **Symbol
  );
 
BOOLEAN
MachoRelocateSymbol (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            LinkAddress,
  IN OUT MACH_NLIST_ANY    *Symbol
  );
 
BOOLEAN
MachoRelocateSymbol32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT32            LinkAddress,
  IN OUT MACH_NLIST        *Symbol
  );
 
BOOLEAN
MachoRelocateSymbol64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            LinkAddress,
  IN OUT MACH_NLIST_64     *Symbol
  );
 
BOOLEAN
MachoSymbolGetFileOffset32 (
  IN OUT OC_MACHO_CONTEXT   *Context,
  IN     CONST  MACH_NLIST  *Symbol,
  OUT    UINT32             *FileOffset,
  OUT    UINT32             *MaxSize OPTIONAL
  );
 
BOOLEAN
MachoSymbolGetFileOffset64 (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST  MACH_NLIST_64  *Symbol,
  OUT    UINT32                *FileOffset,
  OUT    UINT32                *MaxSize OPTIONAL
  );
 
BOOLEAN
MachoSymbolGetFileOffset (
  IN OUT OC_MACHO_CONTEXT       *Context,
  IN     CONST  MACH_NLIST_ANY  *Symbol,
  OUT    UINT32                 *FileOffset,
  OUT    UINT32                 *MaxSize OPTIONAL
  );
 
BOOLEAN
MachoSymbolGetDirectFileOffset (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     UINT64            Address,
  OUT    UINT32            *FileOffset,
  OUT    UINT32            *MaxSize OPTIONAL
  );
 
BOOLEAN
MachoSymbolNameIsPureVirtual (
  IN CONST CHAR8  *Name
  );
 
BOOLEAN
MachoSymbolNameIsPadslot (
  IN CONST CHAR8  *Name
  );
 
BOOLEAN
MachoSymbolNameIsSmcp (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SymbolName
  );
 
BOOLEAN
MachoSymbolNameIsMetaclassPointer (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SymbolName
  );
 
BOOLEAN
MachoGetClassNameFromSuperMetaClassPointer (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SmcpName,
  IN     UINTN             ClassNameSize,
  OUT    CHAR8             *ClassName
  );
 
CONST CHAR8 *
MachoGetClassNameFromVtableName (
  IN  CONST CHAR8  *VtableName
  );
 
BOOLEAN
MachoGetFunctionPrefixFromClassName (
  IN  CONST CHAR8  *ClassName,
  IN  UINTN        FunctionPrefixSize,
  OUT CHAR8        *FunctionPrefix
  );
 
BOOLEAN
MachoGetClassNameFromMetaClassPointer (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *MetaClassName,
  IN     UINTN             ClassNameSize,
  OUT    CHAR8             *ClassName
  );
 
BOOLEAN
MachoGetVtableNameFromClassName (
  IN  CONST CHAR8  *ClassName,
  IN  UINTN        VtableNameSize,
  OUT CHAR8        *VtableName
  );
 
BOOLEAN
MachoGetMetaVtableNameFromClassName (
  IN  CONST CHAR8  *ClassName,
  IN  UINTN        VtableNameSize,
  OUT CHAR8        *VtableName
  );
 
BOOLEAN
MachoGetFinalSymbolNameFromClassName (
  IN  CONST CHAR8  *ClassName,
  IN  UINTN        FinalSymbolNameSize,
  OUT CHAR8        *FinalSymbolName
  );
 
BOOLEAN
MachoSymbolNameIsVtable (
  IN CONST CHAR8  *SymbolName
  );
 
BOOLEAN
MachoSymbolNameIsCxx (
  IN CONST CHAR8  *Name
  );
 
MACH_NLIST_ANY *
MachoGetMetaclassSymbolFromSmcpSymbol (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST MACH_NLIST_ANY  *Smcp
  );
 
MACH_NLIST *
MachoGetMetaclassSymbolFromSmcpSymbol32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST MACH_NLIST  *Smcp
  );
 
MACH_NLIST_64 *
MachoGetMetaclassSymbolFromSmcpSymbol64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST MACH_NLIST_64  *Smcp
  );
 
BOOLEAN
MachoGetVtableSymbolsFromSmcp (
  IN OUT OC_MACHO_CONTEXT      *Context,
  IN     CONST CHAR8           *SmcpName,
  OUT    CONST MACH_NLIST_ANY  **Vtable,
  OUT    CONST MACH_NLIST_ANY  **MetaVtable
  );
 
BOOLEAN
MachoGetVtableSymbolsFromSmcp32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     CONST CHAR8       *SmcpName,
  OUT    CONST MACH_NLIST  **Vtable,
  OUT    CONST MACH_NLIST  **MetaVtable
  );
 
BOOLEAN
MachoGetVtableSymbolsFromSmcp64 (
  IN OUT OC_MACHO_CONTEXT     *Context,
  IN     CONST CHAR8          *SmcpName,
  OUT    CONST MACH_NLIST_64  **Vtable,
  OUT    CONST MACH_NLIST_64  **MetaVtable
  );
 
BOOLEAN
MachoRelocationIsPairIntel32 (
  IN UINT8  Type
  );
 
BOOLEAN
MachoRelocationIsPairIntel64 (
  IN UINT8  Type
  );
 
BOOLEAN
MachoIsRelocationPairTypeIntel64 (
  IN UINT8  Type
  );
 
BOOLEAN
MachoPreserveRelocationIntel64 (
  IN UINT8  Type
  );
 
/*
  Initialises Context with the symbol tables of SymsContext.
 
  @param[in,out] Context      The context to initialise the symbol info of.
  @param[in]     SymsContext  The context to retrieve the symbol tables from.
 
  @returns  Whether the operation was successful.
*/
BOOLEAN
MachoInitialiseSymtabsExternal (
  IN OUT OC_MACHO_CONTEXT  *Context,
  IN     OC_MACHO_CONTEXT  *SymsContext
  );
 
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
MachoGetSymbolTable32 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  OUT CONST MACH_NLIST     **SymbolTable,
  OUT CONST CHAR8          **StringTable OPTIONAL,
  OUT CONST MACH_NLIST     **LocalSymbols OPTIONAL,
  OUT UINT32               *NumLocalSymbols OPTIONAL,
  OUT CONST MACH_NLIST     **ExternalSymbols OPTIONAL,
  OUT UINT32               *NumExternalSymbols OPTIONAL,
  OUT CONST MACH_NLIST     **UndefinedSymbols OPTIONAL,
  OUT UINT32               *NumUndefinedSymbols OPTIONAL
  );
 
UINT32
MachoGetSymbolTable64 (
  IN OUT OC_MACHO_CONTEXT  *Context,
  OUT CONST MACH_NLIST_64  **SymbolTable,
  OUT CONST CHAR8          **StringTable OPTIONAL,
  OUT CONST MACH_NLIST_64  **LocalSymbols OPTIONAL,
  OUT UINT32               *NumLocalSymbols OPTIONAL,
  OUT CONST MACH_NLIST_64  **ExternalSymbols OPTIONAL,
  OUT UINT32               *NumExternalSymbols OPTIONAL,
  OUT CONST MACH_NLIST_64  **UndefinedSymbols OPTIONAL,
  OUT UINT32               *NumUndefinedSymbols OPTIONAL
  );
 
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
  );
 
UINT64
MachoRuntimeGetEntryAddress (
  IN VOID  *Image
  );
 
MACH_LOAD_COMMAND *
MachoGetNextCommand (
  IN OUT OC_MACHO_CONTEXT         *Context,
  IN     MACH_LOAD_COMMAND_TYPE   LoadCommandType,
  IN     CONST MACH_LOAD_COMMAND  *LoadCommand  OPTIONAL
  );
 
EFI_STATUS
FatGetArchitectureOffset (
  IN  CONST UINT8    *Buffer,
  IN  UINT32         BufferSize,
  IN  UINT32         FullSize,
  IN  MACH_CPU_TYPE  CpuType,
  OUT UINT32         *FatOffset,
  OUT UINT32         *FatSize
  );
 
EFI_STATUS
FatFilterArchitectureByType (
  IN OUT UINT8          **FileData,
  IN OUT UINT32         *FileSize,
  IN     MACH_CPU_TYPE  CpuType
  );
 
EFI_STATUS
FatFilterArchitecture32 (
  IN OUT UINT8   **FileData,
  IN OUT UINT32  *FileSize
  );
 
EFI_STATUS
FatFilterArchitecture64 (
  IN OUT UINT8   **FileData,
  IN OUT UINT32  *FileSize
  );
 
#endif // OC_MACHO_LIB_H