A set of symbols to look up, each associated with a SymbolLookupFlags value. More...

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

Public Types
using	value_type = std::pair< SymbolStringPtr, SymbolLookupFlags >

using	UnderlyingVector = std::vector< value_type >

using	iterator = UnderlyingVector::iterator

using	const_iterator = UnderlyingVector::const_iterator

Public Member Functions
	SymbolLookupSet ()=default

	SymbolLookupSet (SymbolStringPtr Name, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)

	SymbolLookupSet (std::initializer_list< SymbolStringPtr > Names, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
	Construct a SymbolLookupSet from an initializer list of SymbolStringPtrs.

	SymbolLookupSet (const SymbolNameSet &Names, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
	Construct a SymbolLookupSet from a SymbolNameSet with the given Flags used for each value.

	SymbolLookupSet (ArrayRef< SymbolStringPtr > Names, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
	Construct a SymbolLookupSet from a vector of symbols with the given Flags used for each value.

SymbolLookupSet &	add (SymbolStringPtr Name, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
	Add an element to the set.

SymbolLookupSet &	append (SymbolLookupSet Other)
	Quickly append one lookup set to another.

bool	empty () const

UnderlyingVector::size_type	size () const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

void	remove (UnderlyingVector::size_type I)
	Removes the Ith element of the vector, replacing it with the last element.

void	remove (iterator I)
	Removes the element pointed to by the given iterator.

template<typename PredFn >
void	remove_if (PredFn &&Pred)
	Removes all elements matching the given predicate, which must be callable as bool(const SymbolStringPtr &, SymbolLookupFlags Flags).

template<typename BodyFn >
auto	forEachWithRemoval (BodyFn &&Body) -> std::enable_if_t< std::is_same< decltype(Body(std::declval< const SymbolStringPtr & >(), std::declval< SymbolLookupFlags >())), bool >::value >
	Loop over the elements of this SymbolLookupSet, applying the Body function to each one.

template<typename BodyFn >
auto	forEachWithRemoval (BodyFn &&Body) -> std::enable_if_t< std::is_same< decltype(Body(std::declval< const SymbolStringPtr & >(), std::declval< SymbolLookupFlags >())), Expected< bool > >::value, Error >
	Loop over the elements of this SymbolLookupSet, applying the Body function to each one.

SymbolNameVector	getSymbolNames () const
	Construct a SymbolNameVector from this instance by dropping the Flags values.

void	sortByAddress ()
	Sort the lookup set by pointer value.

void	sortByName ()
	Sort the lookup set lexicographically.

void	removeDuplicates ()
	Remove any duplicate elements.

bool	containsDuplicates ()
	Returns true if this set contains any duplicates.

Static Public Member Functions
template<typename KeyT >
static SymbolLookupSet	fromMapKeys (const DenseMap< SymbolStringPtr, KeyT > &M, SymbolLookupFlags Flags=SymbolLookupFlags::RequiredSymbol)
	Construct a SymbolLookupSet from DenseMap keys.

Detailed Description

A set of symbols to look up, each associated with a SymbolLookupFlags value.

This class is backed by a vector and optimized for fast insertion, deletion and iteration. It does not guarantee a stable order between operations, and will not automatically detect duplicate elements (they can be manually checked by calling the validate method).

Definition at line 182 of file Core.h.

Member Typedef Documentation

◆ const_iterator

using llvm::orc::SymbolLookupSet::const_iterator = UnderlyingVector::const_iterator

Definition at line 187 of file Core.h.

◆ iterator

using llvm::orc::SymbolLookupSet::iterator = UnderlyingVector::iterator

Definition at line 186 of file Core.h.

◆ UnderlyingVector

using llvm::orc::SymbolLookupSet::UnderlyingVector = std::vector<value_type>

Definition at line 185 of file Core.h.

◆ value_type

using llvm::orc::SymbolLookupSet::value_type = std::pair<SymbolStringPtr, SymbolLookupFlags>

Definition at line 184 of file Core.h.

Constructor & Destructor Documentation

◆ SymbolLookupSet() [1/5]

llvm::orc::SymbolLookupSet::SymbolLookupSet ( )

default

◆ SymbolLookupSet() [2/5]

llvm::orc::SymbolLookupSet::SymbolLookupSet	(	SymbolStringPtr	Name,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inlineexplicit

Definition at line 191 of file Core.h.

References add(), Flags, and Name.

◆ SymbolLookupSet() [3/5]

llvm::orc::SymbolLookupSet::SymbolLookupSet	(	std::initializer_list< SymbolStringPtr >	Names,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inlineexplicit

Construct a SymbolLookupSet from an initializer list of SymbolStringPtrs.

Definition at line 198 of file Core.h.

References add(), Flags, Name, and Names.

◆ SymbolLookupSet() [4/5]

llvm::orc::SymbolLookupSet::SymbolLookupSet	(	const SymbolNameSet &	Names,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inlineexplicit

Construct a SymbolLookupSet from a SymbolNameSet with the given Flags used for each value.

Definition at line 208 of file Core.h.

References add(), Flags, Name, and Names.

◆ SymbolLookupSet() [5/5]

llvm::orc::SymbolLookupSet::SymbolLookupSet	(	ArrayRef< SymbolStringPtr >	Names,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inlineexplicit

Construct a SymbolLookupSet from a vector of symbols with the given Flags used for each value.

If the ArrayRef contains duplicates it is up to the client to remove these before using this instance for lookup.

Definition at line 220 of file Core.h.

References add(), Flags, Name, and Names.

Member Function Documentation

◆ add()

SymbolLookupSet & llvm::orc::SymbolLookupSet::add	(	SymbolStringPtr	Name,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inline

Add an element to the set.

The client is responsible for checking that duplicates are not added.

Definition at line 243 of file Core.h.

References Flags, and Name.

Referenced by llvm::orc::EPCEHFrameRegistrar::Create(), llvm::orc::createJITLoaderGDBRegistrar(), LLVMOrcExecutionSessionLookup(), llvm::orc::ObjectLinkingLayerJITLinkContext::lookup(), llvm::orc::CtorDtorRunner::run(), SymbolLookupSet(), llvm::orc::EPCDynamicLibrarySearchGenerator::tryToGenerate(), and llvm::orc::DLLImportDefinitionGenerator::tryToGenerate().

◆ append()

SymbolLookupSet & llvm::orc::SymbolLookupSet::append ( SymbolLookupSet Other )

inline

Quickly append one lookup set to another.

Definition at line 250 of file Core.h.

References llvm::Other.

◆ begin() [1/2]

iterator llvm::orc::SymbolLookupSet::begin ( )

inline

Definition at line 259 of file Core.h.

Referenced by remove().

◆ begin() [2/2]

const_iterator llvm::orc::SymbolLookupSet::begin ( ) const

inline

Definition at line 261 of file Core.h.

◆ containsDuplicates()

bool llvm::orc::SymbolLookupSet::containsDuplicates ( )

inline

Returns true if this set contains any duplicates.

This should only be used in assertions.

Definition at line 370 of file Core.h.

References I, and sortByAddress().

Referenced by llvm::orc::CtorDtorRunner::run().

◆ empty()

bool llvm::orc::SymbolLookupSet::empty ( ) const

inline

Definition at line 257 of file Core.h.

◆ end() [1/2]

iterator llvm::orc::SymbolLookupSet::end ( )

inline

Definition at line 260 of file Core.h.

◆ end() [2/2]

const_iterator llvm::orc::SymbolLookupSet::end ( ) const

inline

Definition at line 262 of file Core.h.

◆ forEachWithRemoval() [1/2]

template<typename BodyFn >

auto llvm::orc::SymbolLookupSet::forEachWithRemoval ( BodyFn && Body ) -> std::enable_if_t< std::is_same<decltype(Body(std::declval<const SymbolStringPtr &>(), std::declval<SymbolLookupFlags>())), bool>::value>

inline

Loop over the elements of this SymbolLookupSet, applying the Body function to each one.

Body must be callable as bool(const SymbolStringPtr &, SymbolLookupFlags). If Body returns true then the element just passed in is removed from the set. If Body returns false then the element is retained.

Definition at line 294 of file Core.h.

References Flags, I, Name, and remove().

◆ forEachWithRemoval() [2/2]

template<typename BodyFn >

auto llvm::orc::SymbolLookupSet::forEachWithRemoval ( BodyFn && Body ) -> std::enable_if_t< std::is_same<decltype(Body(std::declval<const SymbolStringPtr &>(), std::declval<SymbolLookupFlags>())), Expected<bool>>::value, Error>

inline

Loop over the elements of this SymbolLookupSet, applying the Body function to each one.

Body must be callable as Expected<bool>(const SymbolStringPtr &, SymbolLookupFlags). If Body returns a failure value, the loop exits immediately. If Body returns true then the element just passed in is removed from the set. If Body returns false then the element is retained.

Definition at line 316 of file Core.h.

References Flags, I, Name, remove(), and llvm::Error::success().

◆ fromMapKeys()

template<typename KeyT >

static SymbolLookupSet llvm::orc::SymbolLookupSet::fromMapKeys	(	const DenseMap< SymbolStringPtr, KeyT > &	M,
		SymbolLookupFlags	Flags = `SymbolLookupFlags::RequiredSymbol`
	)

inlinestatic

Construct a SymbolLookupSet from DenseMap keys.

Definition at line 231 of file Core.h.

References Flags, and llvm::orc::Result.

Referenced by llvm::orc::ExecutionSession::registerJITDispatchHandlers().

◆ getSymbolNames()

SymbolNameVector llvm::orc::SymbolLookupSet::getSymbolNames ( ) const

inline

Construct a SymbolNameVector from this instance by dropping the Flags values.

Definition at line 338 of file Core.h.

References Names.

◆ remove() [1/2]

void llvm::orc::SymbolLookupSet::remove ( iterator I )

inline

Removes the element pointed to by the given iterator.

This iterator and all subsequent ones (including end()) are invalidated.

Definition at line 272 of file Core.h.

References begin(), I, and remove().

Referenced by remove().

◆ remove() [2/2]

void llvm::orc::SymbolLookupSet::remove ( UnderlyingVector::size_type I )

inline

Removes the Ith element of the vector, replacing it with the last element.

Definition at line 265 of file Core.h.

References I, and std::swap().

Referenced by forEachWithRemoval(), and remove_if().

◆ remove_if()

template<typename PredFn >

void llvm::orc::SymbolLookupSet::remove_if ( PredFn && Pred )

inline

Removes all elements matching the given predicate, which must be callable as bool(const SymbolStringPtr &, SymbolLookupFlags Flags).

Definition at line 276 of file Core.h.

References Flags, I, Name, and remove().

◆ removeDuplicates()

void llvm::orc::SymbolLookupSet::removeDuplicates ( )

inline

Remove any duplicate elements.

If a SymbolLookupSet is not duplicate-free by construction, this method can be used to turn it into a proper set.

Definition at line 361 of file Core.h.

References sortByAddress().

◆ size()

UnderlyingVector::size_type llvm::orc::SymbolLookupSet::size ( ) const

inline

Definition at line 258 of file Core.h.

Referenced by llvm::orc::CAPIDefinitionGenerator::tryToGenerate(), and llvm::orc::EPCDynamicLibrarySearchGenerator::tryToGenerate().

◆ sortByAddress()

void llvm::orc::SymbolLookupSet::sortByAddress ( )

inline

Sort the lookup set by pointer value.

This sort is fast but sensitive to allocation order and so should not be used where a consistent order is required.

Definition at line 349 of file Core.h.

References llvm::sort().

Referenced by containsDuplicates(), and removeDuplicates().

◆ sortByName()

void llvm::orc::SymbolLookupSet::sortByName ( )

inline

Sort the lookup set lexicographically.

This sort is slow but the order is unaffected by allocation order.

Definition at line 353 of file Core.h.

References LHS, RHS, and llvm::sort().

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

include/llvm/ExecutionEngine/Orc/Core.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ UnderlyingVector

◆ value_type

Constructor & Destructor Documentation

◆ SymbolLookupSet() [1/5]

◆ SymbolLookupSet() [2/5]

◆ SymbolLookupSet() [3/5]

◆ SymbolLookupSet() [4/5]

◆ SymbolLookupSet() [5/5]

Member Function Documentation

◆ add()

◆ append()

◆ begin() [1/2]

◆ begin() [2/2]

◆ containsDuplicates()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ forEachWithRemoval() [1/2]

◆ forEachWithRemoval() [2/2]

◆ fromMapKeys()

◆ getSymbolNames()

◆ remove() [1/2]

◆ remove() [2/2]

◆ remove_if()

◆ removeDuplicates()

◆ size()

◆ sortByAddress()

◆ sortByName()