Symbols.c File Reference

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

Go to the source code of this file.

Functions
BOOLEAN	MachoSymbolIsDefined (IN OUT OC_MACHO_CONTEXT *Context, IN CONST MACH_NLIST_ANY *Symbol)
BOOLEAN	MachoSymbolIsLocalDefined (IN OUT OC_MACHO_CONTEXT *Context, IN CONST MACH_NLIST_ANY *Symbol)
MACH_NLIST_ANY *	MachoGetLocalDefinedSymbolByName (IN OUT OC_MACHO_CONTEXT *Context, IN CONST CHAR8 *Name)
MACH_NLIST_ANY *	MachoGetSymbolByIndex (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 *	MachoGetIndirectSymbolName (IN OUT OC_MACHO_CONTEXT *Context, IN CONST MACH_NLIST_ANY *Symbol)
BOOLEAN	MachoIsSymbolValueInRange (IN OUT OC_MACHO_CONTEXT *Context, IN CONST MACH_NLIST_ANY *Symbol)
BOOLEAN	MachoGetSymbolByExternRelocationOffset (IN OUT OC_MACHO_CONTEXT *Context, IN UINT64 Address, OUT MACH_NLIST_ANY **Symbol)
BOOLEAN	MachoRelocateSymbol (IN OUT OC_MACHO_CONTEXT *Context, IN UINT64 LinkAddress, IN OUT MACH_NLIST_ANY *Symbol)
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)

Detailed Description

Provides services for symbols.

Copyright (c) 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 in file Symbols.c.

Function Documentation

MachoGetIndirectSymbolName()

CONST CHAR8 * MachoGetIndirectSymbolName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol )

Retrieves a Symbol's name.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Symbol	Indirect symbol to retrieve the name of.

Return values

NULL	NULL is returned on failure.

Definition at line 93 of file Symbols.c.

MachoGetLocalDefinedSymbolByName()

MACH_NLIST_ANY * MachoGetLocalDefinedSymbolByName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST CHAR8 *	Name )

Retrieves a locally defined symbol by its name.

Parameters

[in]	Context	Context of the Mach-O.
[in]	Name	Name of the symbol to locate.

Definition at line 54 of file Symbols.c.

MachoGetSymbolByExternRelocationOffset()

BOOLEAN MachoGetSymbolByExternRelocationOffset	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT64	Address,
		OUT MACH_NLIST_ANY **	Symbol )

Retrieves the symbol referenced by the extern Relocation targeting Address.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Address	Address to search for.
[out]	Symbol	Buffer to output the symbol referenced by the Relocation into. The output is undefined when FALSE is returned. May be NULL.

Returns

Whether the Relocation exists.

Definition at line 119 of file Symbols.c.

MachoGetSymbolByIndex()

MACH_NLIST_ANY * MachoGetSymbolByIndex	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT32	Index )

Retrieves a symbol by its index.

Parameters

[in]	Context	Context of the Mach-O.
[in]	Index	Index of the symbol to locate.

Return values

NULL	NULL is returned on failure.

Definition at line 67 of file Symbols.c.

MachoGetSymbolName()

CONST CHAR8 * MachoGetSymbolName	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol )

Retrieves a Symbol's name.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Symbol	Symbol to retrieve the name of.

Return values

symbol

name.

Definition at line 80 of file Symbols.c.

MachoIsSymbolValueInRange()

BOOLEAN MachoIsSymbolValueInRange	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol )

Returns whether the symbol's value is a valid address within the Mach-O referenced to by Context.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Symbol	Symbol to verify the value of.

Definition at line 106 of file Symbols.c.

MachoRelocateSymbol()

BOOLEAN MachoRelocateSymbol	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT64	LinkAddress,
		IN OUT MACH_NLIST_ANY *	Symbol )

Relocate Symbol to be against LinkAddress.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	LinkAddress	The address to be linked against.
[in,out]	Symbol	The symbol to be relocated.

Returns

Whether the operation has been completed successfully.

Definition at line 136 of file Symbols.c.

MachoSymbolGetDirectFileOffset()

BOOLEAN MachoSymbolGetDirectFileOffset	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN UINT64	Address,
		OUT UINT32 *	FileOffset,
		OUT UINT32 *MaxSize	OPTIONAL )

Retrieves the Mach-O file offset of the address pointed to by a Symbol.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Address	Virtual address to retrieve the offset of.
[out]	FileOffset	Pointer the file offset is returned into. If FALSE is returned, the output is undefined.
[out]	MaxSize	Maximum data safely available from FileOffset.

Return values

0	0 is returned on failure.

Definition at line 168 of file Symbols.c.

MachoSymbolGetFileOffset()

BOOLEAN MachoSymbolGetFileOffset	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol,
		OUT UINT32 *	FileOffset,
		OUT UINT32 *MaxSize	OPTIONAL )

Retrieves the Mach-O file offset of the address pointed to by a Symbol.

Parameters

[in,out]	Context	Context of the Mach-O.
[in]	Symbol	Symbol to retrieve the offset of.
[out]	FileOffset	Pointer the file offset is returned into. If FALSE is returned, the output is undefined.
[out]	MaxSize	Maximum data safely available from FileOffset.

Return values

0	0 is returned on failure.

Definition at line 153 of file Symbols.c.

MachoSymbolIsDefined()

BOOLEAN MachoSymbolIsDefined	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol )

Returns whether Symbol is defined.

Parameters

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

Definition at line 28 of file Symbols.c.

MachoSymbolIsLocalDefined()

BOOLEAN MachoSymbolIsLocalDefined	(	IN OUT OC_MACHO_CONTEXT *	Context,
		IN CONST MACH_NLIST_ANY *	Symbol )

Returns whether Symbol is defined locally.

Parameters

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

Definition at line 41 of file Symbols.c.