class JITSymbol

Declaration

class JITSymbol { /* full declaration omitted */ };

Description

Represents a symbol in the JIT.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:265

Member Variables

private llvm::JITSymbol::GetAddressFtor GetAddress

private anonymous struct / union

private llvm::JITSymbolFlags Flags

Method Overview

• public JITSymbol(std::nullptr_t)
• public JITSymbol(llvm::Error Err)
• public JITSymbol(llvm::JITTargetAddress Addr, llvm::JITSymbolFlags Flags)
• public JITSymbol(llvm::JITEvaluatedSymbol Sym)
• public JITSymbol(llvm::JITSymbol::GetAddressFtor GetAddress, llvm::JITSymbolFlags Flags)
• public JITSymbol(const llvm::JITSymbol &)
• public JITSymbol(llvm::JITSymbol && Other)
• public Expected<llvm::JITTargetAddress> getAddress()
• public llvm::JITSymbolFlags getFlags() const
• public bool operator bool() const
• public llvm::Error takeError()
• public ~JITSymbol()

Methods

¶JITSymbol(std::nullptr_t)

Description

Create a 'null' symbol, used to represent a "symbol not found" result from a successful (non-erroneous) lookup.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:271

Parameters

std::nullptr_t

¶JITSymbol(llvm::Error Err)

Description

Create a JITSymbol representing an error in the symbol lookup process (e.g. a network failure during a remote lookup).

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:276

Parameters

llvm::Error Err

¶JITSymbol(llvm::JITTargetAddress Addr,
          llvm::JITSymbolFlags Flags)

Description

Create a symbol for a definition with a known address.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:280

Parameters

llvm::JITTargetAddress Addr

llvm::JITSymbolFlags Flags

¶JITSymbol(llvm::JITEvaluatedSymbol Sym)

Description

Construct a JITSymbol from a JITEvaluatedSymbol.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:284

Parameters

llvm::JITEvaluatedSymbol Sym

¶JITSymbol(
    llvm::JITSymbol::GetAddressFtor GetAddress,
    llvm::JITSymbolFlags Flags)

Description

Create a symbol for a definition that doesn't have a known address yet. This constructor allows a JIT layer to provide a reference to a symbol definition without actually materializing the definition up front. The user can materialize the definition at any time by calling the getAddress method.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:296

Parameters

llvm::JITSymbol::GetAddressFtor GetAddress

A functor to materialize a definition (fixing the address) on demand.

llvm::JITSymbolFlags Flags

¶JITSymbol(const llvm::JITSymbol&)

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:299

Parameters

const llvm::JITSymbol&

¶JITSymbol(llvm::JITSymbol&& Other)

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:302

Parameters

llvm::JITSymbol&& Other

¶Expected<llvm::JITTargetAddress> getAddress()

Description

Get the address of the symbol in the target address space. Returns '0' if the symbol does not exist.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:341

¶llvm::JITSymbolFlags getFlags() const

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:354

¶bool operator bool() const

Description

Returns true if the symbol exists, false otherwise.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:328

¶llvm::Error takeError()

Description

Move the error field value out of this JITSymbol.

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:333

¶~JITSymbol()

Declared at: llvm/include/llvm/ExecutionEngine/JITSymbol.h:320