llvm::RuntimeDyldChecker Class Reference

RuntimeDyld invariant checker for verifying that RuntimeDyld has correctly applied relocations. More...

#include "llvm/ExecutionEngine/RuntimeDyldChecker.h"

Classes
class	MemoryRegionInfo

Public Types
using	IsSymbolValidFunction = std::function<bool(StringRef Symbol)>
using	GetSymbolInfoFunction
using	GetSectionInfoFunction
using	GetStubInfoFunction
using	GetGOTInfoFunction

Public Member Functions
LLVM_ABI	RuntimeDyldChecker (IsSymbolValidFunction IsSymbolValid, GetSymbolInfoFunction GetSymbolInfo, GetSectionInfoFunction GetSectionInfo, GetStubInfoFunction GetStubInfo, GetGOTInfoFunction GetGOTInfo, llvm::endianness Endianness, Triple TT, StringRef CPU, SubtargetFeatures TF, raw_ostream &ErrStream)
LLVM_ABI	~RuntimeDyldChecker ()
LLVM_ABI bool	check (StringRef CheckExpr) const
	Check a single expression against the attached RuntimeDyld instance.
LLVM_ABI bool	checkAllRulesInBuffer (StringRef RulePrefix, MemoryBuffer *MemBuf) const
	Scan the given memory buffer for lines beginning with the string in RulePrefix.
LLVM_ABI std::pair< uint64_t, std::string >	getSectionAddr (StringRef FileName, StringRef SectionName, bool LocalAddress)
	Returns the address of the requested section (or an error message in the second element of the pair if the address cannot be found).
LLVM_ABI std::optional< uint64_t >	getSectionLoadAddress (void *LocalAddress) const
	If there is a section at the given local address, return its load address, otherwise return std::nullopt.

Detailed Description

RuntimeDyld invariant checker for verifying that RuntimeDyld has correctly applied relocations.

The RuntimeDyldChecker class evaluates expressions against an attached RuntimeDyld instance to verify that relocations have been applied correctly.

The expression language supports basic pointer arithmetic and bit-masking, and has limited disassembler integration for accessing instruction operands and the next PC (program counter) address for each instruction.

The language syntax is:

check = expr '=' expr

expr = binary_expr | sliceable_expr

sliceable_expr = '*{' number '}' load_addr_expr [slice] | '(' expr ')' [slice] | ident_expr [slice] | number [slice]

slice = '[' high-bit-index ':' low-bit-index ']'

load_addr_expr = symbol | '(' symbol '+' number ')' | '(' symbol '-' number ')'

ident_expr = 'decode_operand' '(' symbol ',' operand-index ')' | 'next_pc' '(' symbol ')' | 'stub_addr' '(' stub-container-name ',' symbol ')' | 'got_addr' '(' stub-container-name ',' symbol ')' | 'section_addr' '(' stub-container-name ',' symbol ')' | symbol

binary_expr = expr '+' expr | expr '-' expr | expr '&' expr | expr '|' expr | expr '<<' expr | expr '>>' expr

Definition at line 81 of file RuntimeDyldChecker.h.

Member Typedef Documentation

GetGOTInfoFunction

using llvm::RuntimeDyldChecker::GetGOTInfoFunction

Initial value:

 std::function<Expected<MemoryRegionInfo>(
      StringRef GOTContainer, StringRef TargetName)>

Definition at line 160 of file RuntimeDyldChecker.h.

GetSectionInfoFunction

using llvm::RuntimeDyldChecker::GetSectionInfoFunction

Initial value:

 std::function<Expected<MemoryRegionInfo>(
      StringRef FileName, StringRef SectionName)>

Definition at line 156 of file RuntimeDyldChecker.h.

GetStubInfoFunction

using llvm::RuntimeDyldChecker::GetStubInfoFunction

Initial value:

 std::function<Expected<MemoryRegionInfo>(
      StringRef StubContainer, StringRef TargetName, StringRef StubKindFilter)>

Definition at line 158 of file RuntimeDyldChecker.h.

GetSymbolInfoFunction

using llvm::RuntimeDyldChecker::GetSymbolInfoFunction

Initial value:

 
      std::function<Expected<MemoryRegionInfo>(StringRef SymbolName)>

Definition at line 154 of file RuntimeDyldChecker.h.

IsSymbolValidFunction

using llvm::RuntimeDyldChecker::IsSymbolValidFunction = std::function<bool(StringRef Symbol)>

Definition at line 153 of file RuntimeDyldChecker.h.

Constructor & Destructor Documentation

RuntimeDyldChecker()

RuntimeDyldChecker::RuntimeDyldChecker	(	IsSymbolValidFunction	IsSymbolValid,
		GetSymbolInfoFunction	GetSymbolInfo,
		GetSectionInfoFunction	GetSectionInfo,
		GetStubInfoFunction	GetStubInfo,
		GetGOTInfoFunction	GetGOTInfo,
		llvm::endianness	Endianness,
		Triple	TT,
		StringRef	CPU,
		SubtargetFeatures	TF,
		raw_ostream &	ErrStream )

Definition at line 1031 of file RuntimeDyldChecker.cpp.

References llvm::move().

~RuntimeDyldChecker()

RuntimeDyldChecker::~RuntimeDyldChecker ( )

default

References LLVM_ABI.

Member Function Documentation

check()

bool RuntimeDyldChecker::check

(

StringRef

CheckExpr

)

const

Check a single expression against the attached RuntimeDyld instance.

Definition at line 1044 of file RuntimeDyldChecker.cpp.

checkAllRulesInBuffer()

bool RuntimeDyldChecker::checkAllRulesInBuffer	(	StringRef	RulePrefix,
		MemoryBuffer *	MemBuf ) const

Scan the given memory buffer for lines beginning with the string in RulePrefix.

The remainder of the line is passed to the check method to be evaluated as an expression.

Definition at line 1048 of file RuntimeDyldChecker.cpp.

getSectionAddr()

std::pair< uint64_t, std::string > RuntimeDyldChecker::getSectionAddr	(	StringRef	FileName,
		StringRef	SectionName,
		bool	LocalAddress )

Returns the address of the requested section (or an error message in the second element of the pair if the address cannot be found).

if 'LocalAddress' is true, this returns the address of the section within the linker's memory. If 'LocalAddress' is false it returns the address within the target process (i.e. the load address).

Definition at line 1054 of file RuntimeDyldChecker.cpp.

getSectionLoadAddress()

LLVM_ABI std::optional< uint64_t > llvm::RuntimeDyldChecker::getSectionLoadAddress

(

void *

LocalAddress

)

const

If there is a section at the given local address, return its load address, otherwise return std::nullopt.

---

The documentation for this class was generated from the following files:

• include/llvm/ExecutionEngine/RuntimeDyldChecker.h
• lib/ExecutionEngine/RuntimeDyld/RuntimeDyldChecker.cpp