A pre-fabricated ORC JIT stack that can serve as an alternative to MCJIT. More...

#include "llvm/ExecutionEngine/Orc/LLJIT.h"

Inheritance diagram for llvm::orc::LLJIT:

Collaboration diagram for llvm::orc::LLJIT:

[legend]

Classes
class	PlatformSupport
	Initializer support for LLJIT. More...

Public Member Functions
virtual	~LLJIT ()
	Destruct this instance. More...

ExecutionSession &	getExecutionSession ()
	Returns the ExecutionSession for this instance. More...

const Triple &	getTargetTriple () const
	Returns a reference to the triple for this instance. More...

const DataLayout &	getDataLayout () const
	Returns a reference to the DataLayout for this instance. More...

JITDylib &	getMainJITDylib ()
	Returns a reference to the JITDylib representing the JIT'd main program. More...

JITDylib *	getJITDylibByName (StringRef Name)
	Returns the JITDylib with the given name, or nullptr if no JITDylib with that name exists. More...

Expected< JITDylib & >	createJITDylib (std::string Name)
	Create a new JITDylib with the given name and return a reference to it. More...

Error	addIRModule (ResourceTrackerSP RT, ThreadSafeModule TSM)
	Adds an IR module with the given ResourceTracker. More...

Error	addIRModule (JITDylib &JD, ThreadSafeModule TSM)
	Adds an IR module to the given JITDylib. More...

Error	addIRModule (ThreadSafeModule TSM)
	Adds an IR module to the Main JITDylib. More...

Error	addObjectFile (ResourceTrackerSP RT, std::unique_ptr< MemoryBuffer > Obj)
	Adds an object file to the given JITDylib. More...

Error	addObjectFile (JITDylib &JD, std::unique_ptr< MemoryBuffer > Obj)
	Adds an object file to the given JITDylib. More...

Error	addObjectFile (std::unique_ptr< MemoryBuffer > Obj)
	Adds an object file to the given JITDylib. More...

Expected< ExecutorAddr >	lookupLinkerMangled (JITDylib &JD, SymbolStringPtr Name)
	Look up a symbol in JITDylib JD by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead). More...

Expected< ExecutorAddr >	lookupLinkerMangled (JITDylib &JD, StringRef Name)
	Look up a symbol in JITDylib JD by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead). More...

Expected< ExecutorAddr >	lookupLinkerMangled (StringRef Name)
	Look up a symbol in the main JITDylib by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead). More...

Expected< ExecutorAddr >	lookup (JITDylib &JD, StringRef UnmangledName)
	Look up a symbol in JITDylib JD based on its IR symbol name. More...

Expected< ExecutorAddr >	lookup (StringRef UnmangledName)
	Look up a symbol in the main JITDylib based on its IR symbol name. More...

void	setPlatformSupport (std::unique_ptr< PlatformSupport > PS)
	Set the PlatformSupport instance. More...

PlatformSupport *	getPlatformSupport ()
	Get the PlatformSupport instance. More...

Error	initialize (JITDylib &JD)
	Run the initializers for the given JITDylib. More...

Error	deinitialize (JITDylib &JD)
	Run the deinitializers for the given JITDylib. More...

ObjectLayer &	getObjLinkingLayer ()
	Returns a reference to the ObjLinkingLayer. More...

ObjectTransformLayer &	getObjTransformLayer ()
	Returns a reference to the object transform layer. More...

IRTransformLayer &	getIRTransformLayer ()
	Returns a reference to the IR transform layer. More...

IRCompileLayer &	getIRCompileLayer ()
	Returns a reference to the IR compile layer. More...

std::string	mangle (StringRef UnmangledName) const
	Returns a linker-mangled version of UnmangledName. More...

SymbolStringPtr	mangleAndIntern (StringRef UnmangledName) const
	Returns an interned, linker-mangled version of UnmangledName. More...

Protected Member Functions
	LLJIT (LLJITBuilderState &S, Error &Err)
	Create an LLJIT instance with a single compile thread. More...

Error	applyDataLayout (Module &M)

void	recordCtorDtors (Module &M)

Static Protected Member Functions
static Expected< std::unique_ptr< ObjectLayer > >	createObjectLinkingLayer (LLJITBuilderState &S, ExecutionSession &ES)

static Expected< std::unique_ptr< IRCompileLayer::IRCompiler > >	createCompileFunction (LLJITBuilderState &S, JITTargetMachineBuilder JTMB)

Protected Attributes
std::unique_ptr< ExecutionSession >	ES

std::unique_ptr< PlatformSupport >	PS

JITDylib *	Main = nullptr

DataLayout	DL

Triple	TT

std::unique_ptr< ThreadPool >	CompileThreads

std::unique_ptr< ObjectLayer >	ObjLinkingLayer

std::unique_ptr< ObjectTransformLayer >	ObjTransformLayer

std::unique_ptr< IRCompileLayer >	CompileLayer

std::unique_ptr< IRTransformLayer >	TransformLayer

std::unique_ptr< IRTransformLayer >	InitHelperTransformLayer

Friends
template<typename , typename , typename >
class	LLJITBuilderSetters

void	setUpGenericLLVMIRPlatform (LLJIT &J)
	Configure the LLJIT instance to scrape modules for llvm.global_ctors and llvm.global_dtors variables and (if present) build initialization and deinitialization functions. More...

Detailed Description

A pre-fabricated ORC JIT stack that can serve as an alternative to MCJIT.

Create instances using LLJITBuilder.

Definition at line 37 of file LLJIT.h.

Constructor & Destructor Documentation

◆ ~LLJIT()

llvm::orc::LLJIT::~LLJIT ( )

virtual

Destruct this instance.

If a multi-threaded instance, waits for all compile threads to complete.

Definition at line 743 of file LLJIT.cpp.

References CompileThreads.

◆ LLJIT()

llvm::orc::LLJIT::LLJIT	(	LLJITBuilderState &	S,
		Error &	Err
	)

protected

Create an LLJIT instance with a single compile thread.

Definition at line 834 of file LLJIT.cpp.

Member Function Documentation

◆ addIRModule() [1/3]

Error llvm::orc::LLJIT::addIRModule	(	JITDylib &	JD,
		ThreadSafeModule	TSM
	)

Adds an IR module to the given JITDylib.

Definition at line 760 of file LLJIT.cpp.

References addIRModule(), llvm::orc::JITDylib::getDefaultResourceTracker(), and move.

◆ addIRModule() [2/3]

Error llvm::orc::LLJIT::addIRModule	(	ResourceTrackerSP	RT,
		ThreadSafeModule	TSM
	)

Adds an IR module with the given ResourceTracker.

Definition at line 750 of file LLJIT.cpp.

References assert().

Referenced by addIRModule().

◆ addIRModule() [3/3]

Error llvm::orc::LLJIT::addIRModule ( ThreadSafeModule TSM )

inline

Adds an IR module to the Main JITDylib.

Definition at line 96 of file LLJIT.h.

References addIRModule(), Main, and move.

◆ addObjectFile() [1/3]

Error llvm::orc::LLJIT::addObjectFile	(	JITDylib &	JD,
		std::unique_ptr< MemoryBuffer >	Obj
	)

Adds an object file to the given JITDylib.

Definition at line 771 of file LLJIT.cpp.

References addObjectFile(), llvm::orc::JITDylib::getDefaultResourceTracker(), and move.

◆ addObjectFile() [2/3]

Error llvm::orc::LLJIT::addObjectFile	(	ResourceTrackerSP	RT,
		std::unique_ptr< MemoryBuffer >	Obj
	)

Adds an object file to the given JITDylib.

Definition at line 764 of file LLJIT.cpp.

References assert(), move, and ObjTransformLayer.

Referenced by addObjectFile().

◆ addObjectFile() [3/3]

Error llvm::orc::LLJIT::addObjectFile ( std::unique_ptr< MemoryBuffer > Obj )

inline

Adds an object file to the given JITDylib.

Definition at line 107 of file LLJIT.h.

References addObjectFile(), Main, and move.

◆ applyDataLayout()

Error llvm::orc::LLJIT::applyDataLayout ( Module & M )

protected

Definition at line 923 of file LLJIT.cpp.

References DL, llvm::DataLayout::getStringRepresentation(), llvm::inconvertibleErrorCode(), M, and llvm::Error::success().

◆ createCompileFunction()

Expected< std::unique_ptr< IRCompileLayer::IRCompiler > > llvm::orc::LLJIT::createCompileFunction	(	LLJITBuilderState &	S,
		JITTargetMachineBuilder	JTMB
	)

staticprotected

If there is a custom compile function creator set then use it.

Definition at line 815 of file LLJIT.cpp.

References llvm::orc::JITTargetMachineBuilder::createTargetMachine(), move, S, and TM.

◆ createJITDylib()

Expected<JITDylib &> llvm::orc::LLJIT::createJITDylib ( std::string Name )

inline

Create a new JITDylib with the given name and return a reference to it.

JITDylib names must be unique. If the given name is derived from user input or elsewhere in the environment then the client should check (e.g. by calling getJITDylibByName) that the given name is not already in use.

Definition at line 85 of file LLJIT.h.

References ES, and move.

◆ createObjectLinkingLayer()

Expected< std::unique_ptr< ObjectLayer > > llvm::orc::LLJIT::createObjectLinkingLayer	(	LLJITBuilderState &	S,
		ExecutionSession &	ES
	)

staticprotected

Definition at line 786 of file LLJIT.cpp.

References ES, move, and S.

◆ deinitialize()

Error llvm::orc::LLJIT::deinitialize ( JITDylib & JD )

inline

Run the deinitializers for the given JITDylib.

Definition at line 159 of file LLJIT.h.

References assert(), llvm::dbgs(), DEBUG_WITH_TYPE, llvm::jitlink::JITLinkDylib::getName(), and PS.

◆ getDataLayout()

const DataLayout& llvm::orc::LLJIT::getDataLayout ( ) const

inline

Returns a reference to the DataLayout for this instance.

Definition at line 68 of file LLJIT.h.

References DL.

◆ getExecutionSession()

ExecutionSession& llvm::orc::LLJIT::getExecutionSession ( )

inline

Returns the ExecutionSession for this instance.

Definition at line 62 of file LLJIT.h.

References ES.

◆ getIRCompileLayer()

IRCompileLayer& llvm::orc::LLJIT::getIRCompileLayer ( )

inline

Returns a reference to the IR compile layer.

Definition at line 178 of file LLJIT.h.

References CompileLayer.

◆ getIRTransformLayer()

IRTransformLayer& llvm::orc::LLJIT::getIRTransformLayer ( )

inline

Returns a reference to the IR transform layer.

Definition at line 175 of file LLJIT.h.

References TransformLayer.

◆ getJITDylibByName()

JITDylib* llvm::orc::LLJIT::getJITDylibByName ( StringRef Name )

inline

Returns the JITDylib with the given name, or nullptr if no JITDylib with that name exists.

Definition at line 75 of file LLJIT.h.

References ES.

◆ getMainJITDylib()

JITDylib& llvm::orc::LLJIT::getMainJITDylib ( )

inline

Returns a reference to the JITDylib representing the JIT'd main program.

Definition at line 71 of file LLJIT.h.

References Main.

◆ getObjLinkingLayer()

ObjectLayer& llvm::orc::LLJIT::getObjLinkingLayer ( )

inline

Returns a reference to the ObjLinkingLayer.

Definition at line 169 of file LLJIT.h.

References ObjLinkingLayer.

◆ getObjTransformLayer()

ObjectTransformLayer& llvm::orc::LLJIT::getObjTransformLayer ( )

inline

Returns a reference to the object transform layer.

Definition at line 172 of file LLJIT.h.

References ObjTransformLayer.

◆ getPlatformSupport()

PlatformSupport* llvm::orc::LLJIT::getPlatformSupport ( )

inline

Get the PlatformSupport instance.

Definition at line 146 of file LLJIT.h.

References PS.

◆ getTargetTriple()

const Triple& llvm::orc::LLJIT::getTargetTriple ( ) const

inline

Returns a reference to the triple for this instance.

Definition at line 65 of file LLJIT.h.

References TT.

◆ initialize()

Error llvm::orc::LLJIT::initialize ( JITDylib & JD )

inline

Run the initializers for the given JITDylib.

Definition at line 149 of file LLJIT.h.

References assert(), llvm::dbgs(), DEBUG_WITH_TYPE, llvm::jitlink::JITLinkDylib::getName(), and PS.

◆ lookup() [1/2]

Expected<ExecutorAddr> llvm::orc::LLJIT::lookup	(	JITDylib &	JD,
		StringRef	UnmangledName
	)

inline

Look up a symbol in JITDylib JD based on its IR symbol name.

Definition at line 131 of file LLJIT.h.

References lookupLinkerMangled(), and mangle().

Referenced by lookup().

◆ lookup() [2/2]

Expected<ExecutorAddr> llvm::orc::LLJIT::lookup ( StringRef UnmangledName )

inline

Look up a symbol in the main JITDylib based on its IR symbol name.

Definition at line 136 of file LLJIT.h.

References lookup(), and Main.

◆ lookupLinkerMangled() [1/3]

Expected<ExecutorAddr> llvm::orc::LLJIT::lookupLinkerMangled	(	JITDylib &	JD,
		StringRef	Name
	)

inline

Look up a symbol in JITDylib JD by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead).

Definition at line 118 of file LLJIT.h.

References ES, and lookupLinkerMangled().

◆ lookupLinkerMangled() [2/3]

Expected< ExecutorAddr > llvm::orc::LLJIT::lookupLinkerMangled	(	JITDylib &	JD,
		SymbolStringPtr	Name
	)

Look up a symbol in JITDylib JD by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead).

Definition at line 775 of file LLJIT.cpp.

References ES, llvm::orc::makeJITDylibSearchOrder(), and llvm::orc::MatchAllSymbols.

Referenced by lookup(), and lookupLinkerMangled().

◆ lookupLinkerMangled() [3/3]

Expected<ExecutorAddr> llvm::orc::LLJIT::lookupLinkerMangled ( StringRef Name )

inline

Look up a symbol in the main JITDylib by the symbol's linker-mangled name (to look up symbols based on their IR name use the lookup function instead).

Definition at line 126 of file LLJIT.h.

References lookupLinkerMangled(), and Main.

◆ mangle()

std::string llvm::orc::LLJIT::mangle ( StringRef UnmangledName ) const

Returns a linker-mangled version of UnmangledName.

Definition at line 914 of file LLJIT.cpp.

References DL, and llvm::Mangler::getNameWithPrefix().

Referenced by lookup(), and mangleAndIntern().

◆ mangleAndIntern()

SymbolStringPtr llvm::orc::LLJIT::mangleAndIntern ( StringRef UnmangledName ) const

inline

Returns an interned, linker-mangled version of UnmangledName.

Definition at line 184 of file LLJIT.h.

References ES, and mangle().

◆ recordCtorDtors()

void llvm::orc::LLJIT::recordCtorDtors ( Module & M )

protected

◆ setPlatformSupport()

void llvm::orc::LLJIT::setPlatformSupport ( std::unique_ptr< PlatformSupport > PS )

inline

Set the PlatformSupport instance.

Definition at line 141 of file LLJIT.h.

References move, and PS.

Referenced by llvm::orc::setUpGenericLLVMIRPlatform(), llvm::orc::setUpInactivePlatform(), and llvm::orc::setUpOrcPlatform().

Friends And Related Function Documentation

◆ LLJITBuilderSetters

template<typename , typename , typename >

friend class LLJITBuilderSetters

friend

Definition at line 38 of file LLJIT.h.

◆ setUpGenericLLVMIRPlatform

void setUpGenericLLVMIRPlatform ( LLJIT & J )

friend

Configure the LLJIT instance to scrape modules for llvm.global_ctors and llvm.global_dtors variables and (if present) build initialization and deinitialization functions.

Platform specific initialization configurations should be preferred where available.

Definition at line 944 of file LLJIT.cpp.

Member Data Documentation

◆ CompileLayer

std::unique_ptr<IRCompileLayer> llvm::orc::LLJIT::CompileLayer

protected

Definition at line 213 of file LLJIT.h.

Referenced by getIRCompileLayer().

◆ CompileThreads

std::unique_ptr<ThreadPool> llvm::orc::LLJIT::CompileThreads

protected

Definition at line 209 of file LLJIT.h.

Referenced by ~LLJIT().

◆ DL

DataLayout llvm::orc::LLJIT::DL

protected

Definition at line 207 of file LLJIT.h.

Referenced by applyDataLayout(), getDataLayout(), mangle(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

◆ ES

std::unique_ptr<ExecutionSession> llvm::orc::LLJIT::ES

protected

Definition at line 202 of file LLJIT.h.

Referenced by createJITDylib(), createObjectLinkingLayer(), getExecutionSession(), getJITDylibByName(), lookupLinkerMangled(), mangleAndIntern(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

◆ InitHelperTransformLayer

std::unique_ptr<IRTransformLayer> llvm::orc::LLJIT::InitHelperTransformLayer

protected

Definition at line 215 of file LLJIT.h.

Referenced by llvm::orc::LLJIT::PlatformSupport::setInitTransform().

◆ Main

JITDylib* llvm::orc::LLJIT::Main = nullptr

protected

Definition at line 205 of file LLJIT.h.

Referenced by addIRModule(), llvm::orc::LLLazyJIT::addLazyIRModule(), addObjectFile(), getMainJITDylib(), lookup(), and lookupLinkerMangled().

◆ ObjLinkingLayer

std::unique_ptr<ObjectLayer> llvm::orc::LLJIT::ObjLinkingLayer

protected

Definition at line 211 of file LLJIT.h.

Referenced by getObjLinkingLayer(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

◆ ObjTransformLayer

std::unique_ptr<ObjectTransformLayer> llvm::orc::LLJIT::ObjTransformLayer

protected

Definition at line 212 of file LLJIT.h.

Referenced by addObjectFile(), and getObjTransformLayer().

◆ PS

std::unique_ptr<PlatformSupport> llvm::orc::LLJIT::PS

protected

Definition at line 203 of file LLJIT.h.

Referenced by deinitialize(), getPlatformSupport(), initialize(), and setPlatformSupport().

◆ TransformLayer

std::unique_ptr<IRTransformLayer> llvm::orc::LLJIT::TransformLayer

protected

Definition at line 214 of file LLJIT.h.

Referenced by getIRTransformLayer().

◆ TT

Triple llvm::orc::LLJIT::TT

protected

Definition at line 208 of file LLJIT.h.

Referenced by getTargetTriple(), and llvm::orc::LLJITBuilderState::prepareForConstruction().

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

include/llvm/ExecutionEngine/Orc/LLJIT.h
lib/ExecutionEngine/Orc/LLJIT.cpp

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~LLJIT()

◆ LLJIT()

Member Function Documentation

◆ addIRModule() [1/3]

◆ addIRModule() [2/3]

◆ addIRModule() [3/3]

◆ addObjectFile() [1/3]

◆ addObjectFile() [2/3]

◆ addObjectFile() [3/3]

◆ applyDataLayout()

◆ createCompileFunction()

◆ createJITDylib()

◆ createObjectLinkingLayer()

◆ deinitialize()

◆ getDataLayout()

◆ getExecutionSession()

◆ getIRCompileLayer()

◆ getIRTransformLayer()

◆ getJITDylibByName()

◆ getMainJITDylib()

◆ getObjLinkingLayer()

◆ getObjTransformLayer()

◆ getPlatformSupport()

◆ getTargetTriple()

◆ initialize()

◆ lookup() [1/2]

◆ lookup() [2/2]

◆ lookupLinkerMangled() [1/3]

◆ lookupLinkerMangled() [2/3]

◆ lookupLinkerMangled() [3/3]

◆ mangle()

◆ mangleAndIntern()

◆ recordCtorDtors()

◆ setPlatformSupport()

Friends And Related Function Documentation

◆ LLJITBuilderSetters

◆ setUpGenericLLVMIRPlatform

Member Data Documentation

◆ CompileLayer

◆ CompileThreads

◆ DL

◆ ES

◆ InitHelperTransformLayer

◆ Main

◆ ObjLinkingLayer

◆ ObjTransformLayer

◆ PS

◆ TransformLayer

◆ TT