class JITSymbolFlags

Declaration

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

Description

Flags for symbols in the JIT.

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

Member Variables

private llvm::JITSymbolFlags::TargetFlagsType TargetFlags = 0

private llvm::JITSymbolFlags::FlagNames Flags = None

Method Overview

• public JITSymbolFlags(llvm::JITSymbolFlags::FlagNames Flags)
• public JITSymbolFlags(llvm::JITSymbolFlags::FlagNames Flags, llvm::JITSymbolFlags::TargetFlagsType TargetFlags)
• public JITSymbolFlags()
• public static llvm::JITSymbolFlags fromGlobalValue(const llvm::GlobalValue & GV)
• public static Expected<llvm::JITSymbolFlags> fromObjectSymbol(const object::SymbolRef & Symbol)
• public static llvm::JITSymbolFlags fromSummary(llvm::GlobalValueSummary * S)
• public llvm::JITSymbolFlags::UnderlyingType getRawFlagsValue() const
• public llvm::JITSymbolFlags::TargetFlagsType & getTargetFlags()
• public const llvm::JITSymbolFlags::TargetFlagsType & getTargetFlags() const
• public bool hasError() const
• public bool hasMaterializationSideEffectsOnly() const
• public bool isCallable() const
• public bool isCommon() const
• public bool isExported() const
• public bool isStrong() const
• public bool isWeak() const
• public bool operator bool() const

Methods

¶JITSymbolFlags(
    llvm::JITSymbolFlags::FlagNames Flags)

Description

Construct a JITSymbolFlags instance from the given flags.

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

Parameters

llvm::JITSymbolFlags::FlagNames Flags

¶JITSymbolFlags(
    llvm::JITSymbolFlags::FlagNames Flags,
    llvm::JITSymbolFlags::TargetFlagsType
        TargetFlags)

Description

Construct a JITSymbolFlags instance from the given flags and target flags.

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

Parameters

llvm::JITSymbolFlags::FlagNames Flags

llvm::JITSymbolFlags::TargetFlagsType TargetFlags

¶JITSymbolFlags()

Description

Default-construct a JITSymbolFlags instance.

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

¶static llvm::JITSymbolFlags fromGlobalValue(
    const llvm::GlobalValue& GV)

Description

Construct a JITSymbolFlags value based on the flags of the given global value.

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

Parameters

const llvm::GlobalValue& GV

¶static Expected<llvm::JITSymbolFlags>
fromObjectSymbol(const object::SymbolRef& Symbol)

Description

Construct a JITSymbolFlags value based on the flags of the given libobject symbol.

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

Parameters

const object::SymbolRef& Symbol

¶static llvm::JITSymbolFlags fromSummary(
    llvm::GlobalValueSummary* S)

Description

Construct a JITSymbolFlags value based on the flags of the given global value summary.

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

Parameters

llvm::GlobalValueSummary* S

¶llvm::JITSymbolFlags::UnderlyingType
getRawFlagsValue() const

Description

Get the underlying flags value as an integer.

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

¶llvm::JITSymbolFlags::TargetFlagsType&
getTargetFlags()

Description

Return a reference to the target-specific flags.

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

¶const llvm::JITSymbolFlags::TargetFlagsType&
getTargetFlags() const

Description

Return a reference to the target-specific flags.

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

¶bool hasError() const

Description

Return true if there was an error retrieving this symbol.

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

¶bool hasMaterializationSideEffectsOnly() const

Description

Returns true if this symbol is a materialization-side-effects-only symbol. Such symbols do not have a real address. They exist to trigger and support synchronization of materialization side effects, e.g. for collecting initialization information. These symbols will vanish from the symbol table immediately upon reaching the ready state, and will appear to queries as if they were never defined (except that query callback execution will be delayed until they reach the ready state). MaterializationSideEffectOnly symbols should only be queried using the SymbolLookupFlags::WeaklyReferencedSymbol flag (see llvm/include/llvm/ExecutionEngine/Orc/Core.h).

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

¶bool isCallable() const

Description

Returns true if the given symbol is known to be callable.

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

¶bool isCommon() const

Description

Returns true if the Common flag is set.

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

¶bool isExported() const

Description

Returns true if the Exported flag is set.

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

¶bool isStrong() const

Description

Returns true if the symbol isn't weak or common.

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

¶bool isWeak() const

Description

Returns true if the Weak flag is set.

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

¶bool operator bool() const

Description

Implicitly convert to bool. Returs true if any flag is set.

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