STAPL: stapl::directory< Key, Transmitter, Mapper, Registry, EnableMigration

Provides basic functionality to forward computation (via a generic functor) to a location determined by the distributed registration of key values. The class handles heterogeneous work requests and supports relaxed consistency, placing no synchronization requirements on the registration of key and functor forwarding requests employing that key. More...

Public Member Functions
	directory (bool b_enable_buffering)

	directory (typename base_t::mapper_t mapper, typename base_t::registry_t registry=typename base_t::registry_t())
	Constructor specifying custom mapper and registry. Used by container framework. More...

bool	has_perfect_mapper (void) const

mapper_t const &	key_mapper (void) const

mapper_t &	key_mapper (void)

bool	empty (void) const
	Returns `true` if there are no entries in directory's registry on this location.

void	reset (void)
	Clear all local registrations and pending messages in directory. Used by `clear()` methods of container distributions.

bool	try_register_key_local (Key const &key)
	Attempt registration from the managing location. Return true if successful (i.e., not already registered).

void	register_key (Key const &key)
	Associate `key` in directory's registry with the location invoking this method. More...

void	register_keys (std::pair< Key, Key > const &keys)

template<typename Functor >
void	register_apply (Key const &key, Functor &&f)
	Associate `key` in directory's registry with location invoking this method. Registration location is implicitly set to be caller of this method. More...

template<typename Functor >
void	register_apply (Key const &key, Functor &&f, location_type location)
	Associate `key` in directory's registry with location invoking this method. More...

void	unregister_key (Key const &key)
	Unregister `key` in directory's registry.

template<typename Functor >
void	unregister_apply (Key const &key, Functor &&f)
	Unregister `key` and apply a function object `f` at location where directory's registry manages `key`. More...

template<typename Functor >
void	invoke_where (Functor &&f, Key const &key)
	Invoke function object at the location where key is currently registered. More...

template<typename Functor >
void	try_invoke_where (Functor &&f, Key const &key)
	Invoke function object at the location where key is currently registered if the key is registered. More...

template<typename Functor >
void	unordered_invoke_where (Functor &&f, Key const &key)
	Invoke function object at the location where key is currently registered, disregarding RMI causal ordering. More...

locality_info	locality (Key const &key)
	Provide locality information about a key managed by the directory. More...

runtime::location_md const &	get_location_md (void) const noexcept
	Returns the location metadata of the location this object registered in.

runtime::location_md &	get_location_md (void) noexcept
	Returns the location metadata of the location this object registered in. noexcept More...

Distributed Object Management
rmi_handle::const_reference const &	get_rmi_handle (void) const noexcept
	Returns the associated rmi_handle.

rmi_handle::reference const &	get_rmi_handle (void) noexcept
	Returns the associated rmi_handle.

size_type	get_location_id (void) const noexcept
	Returns the location id of the local sub-object.

size_type	get_num_locations (void) const noexcept
	Returns the number of locations of the gang of this p_object.

void	advance_epoch (void)
	Advances the epoch of the object. More...

void	unlock (void)
	Used by `lock_guard` functionality in method of derived classes to request atomicity with respect to incoming RMIs. More...

void	lock (void)
	Used by `lock_guard` functionality in method of derived classes to request atomicity with respect to incoming RMIs. More...

bool	try_lock (void)
	Attempt to maintain atomicity with respect to incoming RMIs. More...

Public Types
using	manager_type = mapper_t

using	registry_type = registry_t

using	key_type = Key

using	size_type = rmi_handle::size_type

Protected Member Functions
template<typename Functor >
void	execute (Functor &&f)
	Internal method, target of RMI called via migrate_impl to invoke functor `f` at new registration location, post registry update. More...

template<typename Directory , typename... PMFArgs, typename... Args>
void	invoke_at_manager (Key const &key, void(Directory::*const pmf)(PMFArgs...), Args &&... args)
	Forwards functor and arguments to location managing `key`. The location managing the key will invoke the method with the supplied arguments. More...

template<typename Directory , typename... PMFArgs, typename... Args>
void	invoke_at_manager (Key const &key, void(Directory::*const pmf)(PMFArgs...) const, Args &&... args) const
	Forwards const functor and arguments to location managing `key`. The location managing the key will invoke the method with the supplied arguments. More...

template<typename Trans , typename Directory , typename... PMFArgs, typename... Args>
void	invoke_at_manager_impl (Key const &key, void(Directory::*const pmf)(PMFArgs...), Args &&... args)
	Implementation of. More...

template<typename Trans , typename Directory , typename... PMFArgs, typename... Args>
void	invoke_at_manager_impl (Key const &key, void(Directory::*const pmf)(PMFArgs...) const, Args &&... args) const
	Implementation of. More...

void	flush_pending (const location_type loc, Key const &key, queue_t &pending)
	Forward all buffered requests for `key` to location `loc.` More...

template<typename Functor , typename Trans = transmitter_type>
void	request_forward (Key const &key, Functor &&f)
	Internal method used to facilitate invocation of `f` on location where `key` is currently registered. Called via RMI on directory location where `key` is managed. More...

template<typename Functor >
void	try_request_forward (Key const &key, Functor &&f)
	Internal method used to facilitate invocation of `f` on location where `key` is currently registered. If `key` is not registered, the request is dropped; otherwise, it is called via RMI on directory location where `key` is managed. This is directed at situations where it is legal for a key to not exist, i.e. erasing non-existent keys in the unordered set container. More...

Protected Types
using	mapper_t = typename select_parameter< Mapper, detail::default_key_mapper< Key > >::type

using	registry_t = typename select_parameter< Registry, boost::unordered_map< Key, location_type, boost::hash< Key >, std::equal_to< Key >, pool_allocator< std::pair< Key const, location_type > > > >::type

using	transmitter_type = typename select_parameter< Transmitter, async_transmitter >::type

using	queue_t = request_queue< request_t >

using	queues_t = boost::unordered_map< Key, queue_t, stapl::hash< Key >, std::equal_to< Key >, pool_allocator< std::pair< Key const, queue_t > > >

Protected Attributes
registry_t	m_registry
	Stores key to locations mapping.

queues_t	m_pending
	Map of queues, indexed by `Key`. Entry for keys exists when messages arrive and must be buffered prior to registration, during migration, etc.

mapper_t	m_key_mapper
	Map a key to location that manages it (i.e., where it has entry in m_registry).

bool	m_b_perfect_mapper

Detailed Description

template<typename Key, typename Transmitter = use_default, typename Mapper = use_default, typename Registry = use_default, bool EnableMigration = false>
class stapl::directory< Key, Transmitter, Mapper, Registry, EnableMigration >

Template Parameters

Key	Key types tracked by this directory.
Transmitter	Type Encapsulting underlying ARMI primitives for communication.
Mapper	Functor type that maps keys to location that manages them.
Registry	Holds key to location mapping.

Primary template used for directories without internal migration support (i.e., containers where it is handled externally for now).

Constructor & Destructor Documentation

◆ directory()

template<typename Key, typename Transmitter = use_default, typename Mapper = use_default, typename Registry = use_default, bool EnableMigration = false>

stapl::directory< Key, Transmitter, Mapper, Registry, EnableMigration >::directory	(	typename base_t::mapper_t	mapper,
		typename base_t::registry_t	registry = `typename base_t::registry_t()`
	)

Constructor specifying custom mapper and registry. Used by container framework.

Parameters

mapper	Maps keys to location that manages them.
registry	Holds key to location mapping.

Member Function Documentation

◆ execute()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::execute ( Functor && f )

protectedinherited

Internal method, target of RMI called via migrate_impl to invoke functor f at new registration location, post registry update.

Parameters

f	Nullary functor to apply.

See also: migrate_impl()

◆ invoke_at_manager_impl() [1/2]

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Trans , typename Directory , typename... PMFArgs, typename... Args>

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::invoke_at_manager_impl	(	Key const &	key,
		void(Directory::*)(PMFArgs...)	pmf,
		Args &&...	args
	)

protectedinherited

Implementation of.

See also: invoke_at_manager with a given transmitter

Template Parameters

Trans The transmitter type

◆ invoke_at_manager_impl() [2/2]

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Trans , typename Directory , typename... PMFArgs, typename... Args>

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::invoke_at_manager_impl	(	Key const &	key,
		void(Directory::*)(PMFArgs...) const	pmf,
		Args &&...	args
	)		const

protectedinherited

Implementation of.

See also: invoke_at_manager with a given transmitter

Template Parameters

Trans The given transmitter type

◆ flush_pending()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::flush_pending	(	const location_type	loc,
		Key const &	key,
		queue_t &	pending
	)

protectedinherited

Forward all buffered requests for key to location loc.

Parameters

loc	Location to send buffered requests to.
key	Key value buffered requests are for.
pending	Pending queue associated with `Key`.

This is internal method only called on the directory location managing key.

◆ request_forward()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor , typename Trans = transmitter_type>

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::request_forward	(	Key const &	key,
		Functor &&	f
	)

protectedinherited

Internal method used to facilitate invocation of f on location where key is currently registered. Called via RMI on directory location where key is managed.

Parameters

key	Key whose registered location determines where `f` should be executed.
f	Functor to invoke (unary, `key` passed as parameter).

Called by invoke_where and execute (the latter when migration enabled).

◆ try_request_forward()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::try_request_forward	(	Key const &	key,
		Functor &&	f
	)

protectedinherited

Internal method used to facilitate invocation of f on location where key is currently registered. If key is not registered, the request is dropped; otherwise, it is called via RMI on directory location where key is managed. This is directed at situations where it is legal for a key to not exist, i.e. erasing non-existent keys in the unordered set container.

Parameters

key	Key whose registered location determines where `f` should be executed.
f	Functor to invoke (unary, `key` passed as parameter).

Called by invoke_where and execute (the latter when migration enabled).

◆ register_key()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::register_key ( Key const & key )

inherited

Associate key in directory's registry with the location invoking this method.

◆ register_apply() [1/2]

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::register_apply	(	Key const &	key,
		Functor &&	f
	)

inherited

Associate key in directory's registry with location invoking this method. Registration location is implicitly set to be caller of this method.

Parameters

key	Key to register.
f	Unary function object (receives `key`) as parameter to call after registration.

◆ register_apply() [2/2]

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::register_apply	(	Key const &	key,
		Functor &&	f,
		location_type	location
	)

inherited

Associate key in directory's registry with location invoking this method.

Parameters

key	Key to registered.
f	Unary function object (receives `key`) as parameter to call after registration.
location	Location this key should be mapped to in the registry.

◆ unregister_apply()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::unregister_apply	(	Key const &	key,
		Functor &&	f
	)

inherited

Unregister key and apply a function object f at location where directory's registry manages key.

Parameters

key	Key to unregister.
f	Unary function object (receives `key`) as parameter to call after unregistration.

◆ invoke_where()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::invoke_where	(	Functor &&	f,
		Key const &	key
	)

inherited

Invoke function object at the location where key is currently registered.

Parameters

f	Functor to apply. Unary operator, receives key as parameter.
key	Registered key

◆ try_invoke_where()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::try_invoke_where	(	Functor &&	f,
		Key const &	key
	)

inherited

Invoke function object at the location where key is currently registered if the key is registered.

Parameters

f	Functor to apply. Unary operator, receives key as parameter.
key	Key that may not be registered when method is invoked

◆ unordered_invoke_where()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

template<typename Functor >

void stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::unordered_invoke_where	(	Functor &&	f,
		Key const &	key
	)

inherited

Invoke function object at the location where key is currently registered, disregarding RMI causal ordering.

Parameters

f	Functor to apply. Unary operator, receives key as parameter.
key	Registered key

◆ locality()

template<typename Key, typename Transmitter, typename Mapper, typename Registry, bool EnableMigration>

locality_info stapl::detail::directory_base< Key, Transmitter, Mapper, Registry, EnableMigration >::locality ( Key const & key )

inherited

Provide locality information about a key managed by the directory.

Parameters

key	registered key

Note: Used by containers that inherit / customize directory behavior.

◆ get_location_md()

runtime::location_md& stapl::p_object::get_location_md ( void )

noexceptinherited

Returns the location metadata of the location this object registered in. noexcept

noexcept

◆ advance_epoch()

void stapl::p_object::advance_epoch ( void )

inherited

Advances the epoch of the object.

Advancing the epoch will flush any pending RMIs. It will also increase the epoch of the current gang if the object is not a named object.

◆ unlock()

void stapl::p_object::unlock ( void )

inherited

Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

◆ lock()

void stapl::p_object::lock ( void )

inherited

Used by lock_guard functionality in method of derived classes to request atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

◆ try_lock()

bool stapl::p_object::try_lock ( void )

inherited

Attempt to maintain atomicity with respect to incoming RMIs.

Mutates counter in the associated runqueue.

Returns: true if the lock was able to be acquired. false if it is already locked.

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

directory.hpp

Public Member Functions

Public Types

Protected Member Functions

Protected Types

Protected Attributes

Detailed Description

template<typename Key, typename Transmitter = use_default, typename Mapper = use_default, typename Registry = use_default, bool EnableMigration = false> class stapl::directory< Key, Transmitter, Mapper, Registry, EnableMigration >

Constructor & Destructor Documentation

◆ directory()

Member Function Documentation

◆ execute()

◆ invoke_at_manager_impl() [1/2]

◆ invoke_at_manager_impl() [2/2]

◆ flush_pending()

◆ request_forward()

◆ try_request_forward()

◆ register_key()

◆ register_apply() [1/2]

◆ register_apply() [2/2]

◆ unregister_apply()

◆ invoke_where()

◆ try_invoke_where()

◆ unordered_invoke_where()

◆ locality()

◆ get_location_md()

◆ advance_epoch()

◆ unlock()

◆ lock()

◆ try_lock()

template<typename Key, typename Transmitter = use_default, typename Mapper = use_default, typename Registry = use_default, bool EnableMigration = false>
class stapl::directory< Key, Transmitter, Mapper, Registry, EnableMigration >