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

#include "llvm/ExecutionEngine/Orc/SymbolLookupSet.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 (std::initializer_list< value_type > Elems)
	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 ValT>
static SymbolLookupSet	fromMapKeys (const DenseMap< SymbolStringPtr, ValT > &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 46 of file SymbolLookupSet.h.

Member Typedef Documentation

◆ const_iterator

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

Definition at line 51 of file SymbolLookupSet.h.

◆ iterator

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

Definition at line 50 of file SymbolLookupSet.h.

◆ UnderlyingVector

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

Definition at line 49 of file SymbolLookupSet.h.

◆ value_type

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

Definition at line 48 of file SymbolLookupSet.h.

Constructor & Destructor Documentation

◆ SymbolLookupSet() [1/6]

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

default

Referenced by append(), and fromMapKeys().

◆ SymbolLookupSet() [2/6]

llvm::orc::SymbolLookupSet::SymbolLookupSet ( std::initializer_list< value_type > Elems )

inline

Definition at line 55 of file SymbolLookupSet.h.

References E().

◆ SymbolLookupSet() [3/6]

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

inlineexplicit

Definition at line 60 of file SymbolLookupSet.h.

References add(), and llvm::orc::RequiredSymbol.

◆ SymbolLookupSet() [4/6]

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 67 of file SymbolLookupSet.h.

References add(), and llvm::orc::RequiredSymbol.

◆ SymbolLookupSet() [5/6]

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 77 of file SymbolLookupSet.h.

References add(), llvm::orc::RequiredSymbol, and llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::size().

◆ SymbolLookupSet() [6/6]

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 89 of file SymbolLookupSet.h.

References add(), llvm::orc::RequiredSymbol, and llvm::ArrayRef< T >::size().

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 112 of file SymbolLookupSet.h.

References llvm::orc::RequiredSymbol.

Referenced by LLVMOrcExecutionSessionLookup(), llvm::orc::LinkGraphLinkingLayer::JITLinkCtx::lookup(), llvm::orc::CtorDtorRunner::run(), SymbolLookupSet(), SymbolLookupSet(), SymbolLookupSet(), SymbolLookupSet(), llvm::orc::DLLImportDefinitionGenerator::tryToGenerate(), and llvm::orc::EPCDynamicLibrarySearchGenerator::tryToGenerate().

◆ append()

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

inline

Quickly append one lookup set to another.

Definition at line 119 of file SymbolLookupSet.h.

References llvm::Other, and SymbolLookupSet().

◆ begin() [1/2]

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

inline

Definition at line 128 of file SymbolLookupSet.h.

Referenced by remove().

◆ begin() [2/2]

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

inline

Definition at line 130 of file SymbolLookupSet.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 239 of file SymbolLookupSet.h.

References I, and sortByAddress().

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

◆ empty()

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

inline

Definition at line 126 of file SymbolLookupSet.h.

Referenced by llvm::orc::ExecutorResolutionGenerator::tryToGenerate().

◆ end() [1/2]

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

inline

Definition at line 129 of file SymbolLookupSet.h.

◆ end() [2/2]

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

inline

Definition at line 131 of file SymbolLookupSet.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 163 of file SymbolLookupSet.h.

References I, 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 185 of file SymbolLookupSet.h.

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

◆ fromMapKeys()

template<typename ValT>

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

inlinestatic

Construct a SymbolLookupSet from DenseMap keys.

Definition at line 100 of file SymbolLookupSet.h.

References llvm::orc::RequiredSymbol, llvm::orc::Result, and SymbolLookupSet().

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 207 of file SymbolLookupSet.h.

◆ 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 141 of file SymbolLookupSet.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 134 of file SymbolLookupSet.h.

References I, and std::swap().

Referenced by forEachWithRemoval(), 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 145 of file SymbolLookupSet.h.

References I, 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 230 of file SymbolLookupSet.h.

References sortByAddress(), and llvm::unique().

◆ size()

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

inline

Definition at line 127 of file SymbolLookupSet.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 218 of file SymbolLookupSet.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 222 of file SymbolLookupSet.h.

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

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

include/llvm/ExecutionEngine/Orc/SymbolLookupSet.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/6]

◆ SymbolLookupSet() [2/6]

◆ SymbolLookupSet() [3/6]

◆ SymbolLookupSet() [4/6]

◆ SymbolLookupSet() [5/6]

◆ SymbolLookupSet() [6/6]

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()