LLVM: llvm::orc::MachOPlatform Class Reference (original) (raw)

Mediates between MachO initialization and ExecutionSession state. More...

#include "[llvm/ExecutionEngine/Orc/MachOPlatform.h](MachOPlatform%5F8h%5Fsource.html)"

Mediates between MachO initialization and ExecutionSession state.

Definition at line 31 of file MachOPlatform.h.

◆ MachOHeaderMUBuilder

Initial value:

unique_function is a type-erasing functor similar to std::function.

Used by setupJITDylib to create MachO header MaterializationUnits for JITDylibs.

Definition at line 97 of file MachOPlatform.h.

◆ MachOJITDylibDepInfoMap

Initial value:

std::vector<std::pair<ExecutorAddr, MachOJITDylibDepInfo>>

Definition at line 40 of file MachOPlatform.h.

◆ MachOExecutorSymbolFlags

◆ buildSimpleMachOHeaderMU()

◆ Create() [1/2]

◆ Create() [2/2]

Try to create a MachOPlatform instance, adding the ORC runtime to the given JITDylib.

The ORC runtime requires access to a number of symbols in libc++, and requires access to symbols in libobjc, and libswiftCore to support Objective-C and Swift code. It is up to the caller to ensure that the required symbols can be referenced by code added to PlatformJD. The standard way to achieve this is to first attach dynamic library search generators for either the given process, or for the specific required libraries, to PlatformJD, then to create the platform instance:

::GetForTargetProcess(EPC)));

ExitOnErr(MachOPlatform::Create(ES, ObjLayer, EPC, PlatformJD,

"/path/to/orc/runtime")));

void setPlatform(std::unique_ptr< Platform > P)

Set the Platform for this ExecutionSession.

LLVM_ABI JITDylib & createBareJITDylib(std::string Name)

Add a new bare JITDylib to this ExecutionSession.

GeneratorT & addGenerator(std::unique_ptr< GeneratorT > DefGenerator)

Adds a definition generator to this JITDylib and returns a referenece to it.

static Expected< std::unique_ptr< MachOPlatform > > Create(ObjectLinkingLayer &ObjLinkingLayer, JITDylib &PlatformJD, std::unique_ptr< DefinitionGenerator > OrcRuntime, HeaderOptions PlatformJDOpts={}, MachOHeaderMUBuilder BuildMachOHeaderMU=buildSimpleMachOHeaderMU, std::optional< SymbolAliasMap > RuntimeAliases=std::nullopt)

Try to create a MachOPlatform instance, adding the ORC runtime to the given JITDylib.

Alternatively, these symbols could be added to another JITDylib that PlatformJD links against.

Clients are also responsible for ensuring that any JIT'd code that depends on runtime functions (including any code using TLV or static destructors) can reference the runtime symbols. This is usually achieved by linking any JITDylibs containing regular code against PlatformJD.

By default, MachOPlatform will add the set of aliases returned by the standardPlatformAliases function. This includes both required aliases (e.g. __cxa_atexit -> __orc_rt_macho_cxa_atexit for static destructor support), and optional aliases that provide JIT versions of common functions (e.g. dlopen -> __orc_rt_macho_jit_dlopen). Clients can override these defaults by passing a non-None value for the RuntimeAliases function, in which case the client is responsible for setting up all aliases (including the required ones).

Definition at line 280 of file MachOPlatform.cpp.

References llvm::orc::absoluteSymbols(), llvm::JITSymbolFlags::Exported, llvm::inconvertibleErrorCode(), llvm::make_error(), P, standardPlatformAliases(), llvm::Error::success(), and llvm::orc::symbolAliases().

Referenced by Create(), and llvm::orc::ExecutorNativePlatform::operator()().

◆ getExecutionSession()

◆ getMachOHeaderStartSymbol()

◆ getObjectLinkingLayer()

◆ notifyAdding()

◆ notifyRemoving()

◆ requiredCXXAliases()

◆ setupJITDylib() [1/2]

◆ setupJITDylib() [2/2]

◆ standardLazyCompilationAliases()

◆ standardPlatformAliases()

◆ standardRuntimeUtilityAliases()

◆ teardownJITDylib()

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

• include/llvm/ExecutionEngine/Orc/MachOPlatform.h
• lib/ExecutionEngine/Orc/MachOPlatform.cpp