Single process communicator class that implements the Communicator interface. More...

#include <single.hpp>

Inheritance diagram for rapidsmpf::Single:

Classes
class	Future
	Represents the future result of an operation. More...

Public Member Functions
	Single (config::Options options, std::shared_ptr< ProgressThread > progress_thread)
	Construct a single process communicator. More...

constexpr Rank	rank () const override
	Retrieves the rank of the current node. More...

constexpr Rank	nranks () const override
	Retrieves the total number of ranks. More...

std::unique_ptr< Communicator::Future >	send (std::unique_ptr< std::vector< std::uint8_t >> msg, Rank rank, Tag tag) override
	Sends a host message to a specific rank. More...

std::unique_ptr< Communicator::Future >	send (std::unique_ptr< Buffer > msg, Rank rank, Tag tag) override
	Sends a message (device or host) to a specific rank. Use `release_data` to obtain the data buffer again once the future is completed. More...

std::unique_ptr< Communicator::Future >	recv (Rank rank, Tag tag, std::unique_ptr< Buffer > recv_buffer) override
	Receives a message from a specific rank to a buffer. Use `release_data` to extract the data out of the buffer once the future is completed. More...

std::unique_ptr< Communicator::Future >	recv_sync_host_data (Rank rank, Tag tag, std::unique_ptr< std::vector< std::uint8_t >> synced_buffer) override
	Receives a message from a specific rank to an allocated (synchronized) host buffer. Use `release_sync_host_data` to extract the data out of the buffer once the future is completed. More...

std::pair< std::unique_ptr< std::vector< std::uint8_t > >, Rank >	recv_any (Tag tag) override
	Receives a message from any rank (blocking). More...

std::unique_ptr< std::vector< std::uint8_t > >	recv_from (Rank src, Tag tag) override
	Receives a message from a specific rank (blocking). More...

std::pair< std::vector< std::unique_ptr< Communicator::Future > >, std::vector< std::size_t > >	test_some (std::vector< std::unique_ptr< Communicator::Future >> &future_vector) override
	Tests for completion of multiple futures. More...

std::vector< std::size_t >	test_some (std::unordered_map< std::size_t, std::unique_ptr< Communicator::Future >> const &future_map) override
	Tests for completion of multiple futures in a map. More...

bool	test (std::unique_ptr< Communicator::Future > &future) override
	Test for completion of a single future. More...

std::vector< std::unique_ptr< Buffer > >	wait_all (std::vector< std::unique_ptr< Communicator::Future >> &&futures) override
	Wait for completion of all futures and return their data buffers. More...

std::unique_ptr< Buffer >	wait (std::unique_ptr< Communicator::Future > future) override
	Wait for a future to complete and return the data buffer. More...

std::unique_ptr< Buffer >	release_data (std::unique_ptr< Communicator::Future > future) override
	Retrieves data associated with a completed future. More...

std::unique_ptr< std::vector< std::uint8_t > >	release_sync_host_data (std::unique_ptr< Communicator::Future > future) override
	Retrieves synchronized host data associated with a completed future. When the future is completed, the the host data is valid, and ready, but not stream-ordered. More...

std::shared_ptr< Communicator::Logger > const &	logger () override
	Retrieves the logger associated with this communicator. More...

std::shared_ptr< ProgressThread > const &	progress_thread () const override
	Retrieves the progress thread associated with this communicator. More...

std::string	str () const override
	Provides a string representation of the communicator. More...

Public Member Functions inherited from rapidsmpf::Communicator
virtual std::pair< std::vector< std::unique_ptr< Future > >, std::vector< std::size_t > >	test_some (std::vector< std::unique_ptr< Future >> &future_vector)=0
	Tests for completion of multiple futures. More...

virtual std::vector< std::size_t >	test_some (std::unordered_map< std::size_t, std::unique_ptr< Communicator::Future >> const &future_map)=0
	Tests for completion of multiple futures in a map. More...

virtual bool	test (std::unique_ptr< Communicator::Future > &future)=0
	Test for completion of a single future. More...

virtual std::vector< std::unique_ptr< Buffer > >	wait_all (std::vector< std::unique_ptr< Communicator::Future >> &&futures)=0
	Wait for completion of all futures and return their data buffers. More...

virtual std::unique_ptr< Buffer >	wait (std::unique_ptr< Future > future)=0
	Wait for a future to complete and return the data buffer. More...

virtual std::unique_ptr< Buffer >	release_data (std::unique_ptr< Communicator::Future > future)=0
	Retrieves data associated with a completed future. More...

virtual std::unique_ptr< std::vector< std::uint8_t > >	release_sync_host_data (std::unique_ptr< Communicator::Future > future)=0
	Retrieves synchronized host data associated with a completed future. When the future is completed, the the host data is valid, and ready, but not stream-ordered. More...

Detailed Description

Single process communicator class that implements the Communicator interface.

This class stubs out the Communicator interface with functions that throw. When sending to/receiving from self the internal logic should move buffers through the shuffler, rather than invoking send/recv.

Definition at line 28 of file single.hpp.

Constructor & Destructor Documentation

◆ Single()

rapidsmpf::Single::Single	(	config::Options	options,
		std::shared_ptr< ProgressThread >	progress_thread
	)

Construct a single process communicator.

Parameters

options	Configuration options.
progress_thread	Progress thread for this communicator.

Member Function Documentation

◆ logger()

std::shared_ptr<Communicator::Logger> const& rapidsmpf::Single::logger ( )

inlineoverridevirtual

Retrieves the logger associated with this communicator.

Returns: Shared pointer to the logger.

Implements rapidsmpf::Communicator.

Definition at line 190 of file single.hpp.

◆ nranks()

constexpr Rank rapidsmpf::Single::nranks ( ) const

inlineconstexproverridevirtual

Retrieves the total number of ranks.

Returns: The total number of ranks.

Implements rapidsmpf::Communicator.

Definition at line 63 of file single.hpp.

◆ progress_thread()

std::shared_ptr<ProgressThread> const& rapidsmpf::Single::progress_thread ( ) const

inlineoverridevirtual

Retrieves the progress thread associated with this communicator.

Returns: Shared pointer to the progress thread.

Implements rapidsmpf::Communicator.

Definition at line 198 of file single.hpp.

◆ rank()

constexpr Rank rapidsmpf::Single::rank ( ) const

inlineconstexproverridevirtual

Retrieves the rank of the current node.

Returns: The rank of the node.

Implements rapidsmpf::Communicator.

Definition at line 56 of file single.hpp.

◆ recv()

std::unique_ptr<Communicator::Future> rapidsmpf::Single::recv	(	Rank	rank,
		Tag	tag,
		std::unique_ptr< Buffer >	recv_buffer
	)

overridevirtual

Receives a message from a specific rank to a buffer. Use release_data to extract the data out of the buffer once the future is completed.

Parameters

rank	The source rank.
tag	Message tag for identification.
recv_buffer	The receive buffer.

Returns: A unique pointer to a Future representing the asynchronous operation.

Exceptions

std::invalid_argument	If `recv_buffer` is `nullptr`.
std::logic_error	If `recv_buffer` is not ready (see warning for more details).

Warning: The caller is responsible to ensure the underlying Buffer allocation is already valid before calling, for example, when a CUDA allocation and/or copy are done asynchronously. Specifically, the caller should ensure Buffer::is_ready() returns true before calling this function. Providing a non-ready buffer leads to an irrecoverable condition.

Exceptions

std::runtime_error if called (single-process communicators should never send messages).

Implements rapidsmpf::Communicator.

◆ recv_any()

std::pair<std::unique_ptr<std::vector<std::uint8_t> >, Rank> rapidsmpf::Single::recv_any ( Tag tag )

overridevirtual

Receives a message from any rank (blocking).

Parameters

tag	Message tag for identification.

Returns: A pair containing the message data (host memory) and the rank of the sender.

Note: If no message is available this is indicated by returning a nullptr in the first slot of the pair.; Always returns a nullptr for the received message, indicating that no message is available.

Implements rapidsmpf::Communicator.

◆ recv_from()

std::unique_ptr<std::vector<std::uint8_t> > rapidsmpf::Single::recv_from	(	Rank	src,
		Tag	tag
	)

overridevirtual

Receives a message from a specific rank (blocking).

Parameters

src	The source rank from which to receive the message.
tag	Message tag for identification.

Returns: A unique pointer to a vector containing the received message data (host memory).

Note: If no message is available, this function returns a nullptr.; Always returns a nullptr for the received message, indicating that no message is available.

Implements rapidsmpf::Communicator.

◆ recv_sync_host_data()

std::unique_ptr<Communicator::Future> rapidsmpf::Single::recv_sync_host_data	(	Rank	rank,
		Tag	tag,
		std::unique_ptr< std::vector< std::uint8_t >>	synced_buffer
	)

overridevirtual

Receives a message from a specific rank to an allocated (synchronized) host buffer. Use release_sync_host_data to extract the data out of the buffer once the future is completed.

Parameters

rank	The source rank.
tag	Message tag for identification.
synced_buffer	The receive buffer.

Returns: A unique pointer to a Future representing the asynchronous operation.

Exceptions

std::invalid_argument	If `synced_buffer` is `nullptr`.
std::runtime_error	if called (single-process communicators should never send messages).

Implements rapidsmpf::Communicator.

◆ release_data()

std::unique_ptr<Buffer> rapidsmpf::Single::release_data ( std::unique_ptr< Communicator::Future > future )

override

Retrieves data associated with a completed future.

Parameters

future The completed future.

Returns: A unique pointer to the data buffer.

Exceptions

std::runtime_error	if the future has no data.
std::runtime_error	if called (single-process communicators should never send messages).

◆ release_sync_host_data()

std::unique_ptr<std::vector<std::uint8_t> > rapidsmpf::Single::release_sync_host_data ( std::unique_ptr< Communicator::Future > future )

override

Retrieves synchronized host data associated with a completed future. When the future is completed, the the host data is valid, and ready, but not stream-ordered.

Parameters

future The completed future.

Returns: A unique pointer to the synchronized host data.

Exceptions

std::runtime_error	if the future has no data.
std::runtime_error	if called (single-process communicators should never send messages).

◆ send() [1/2]

std::unique_ptr<Communicator::Future> rapidsmpf::Single::send	(	std::unique_ptr< Buffer >	msg,
		Rank	rank,
		Tag	tag
	)

overridevirtual

Sends a message (device or host) to a specific rank. Use release_data to obtain the data buffer again once the future is completed.

Parameters

msg	Unique pointer to the message data (Buffer).
rank	The destination rank.
tag	Message tag for identification.

Returns: A unique pointer to a Future representing the asynchronous operation.

Exceptions

std::invalid_argument	If `msg` is `nullptr`.
std::logic_error	If `msg` is not ready (see warning for more details).

Warning: The caller is responsible to ensure the underlying Buffer allocation and data are already valid before calling, for example, when a CUDA allocation and/or copy are done asynchronously. Specifically, the caller should ensure Buffer::is_ready() returns true before calling this function. Providing a non-ready buffer leads to an irrecoverable condition.

Exceptions

std::runtime_error if called (single-process communicators should never send messages).

Implements rapidsmpf::Communicator.

◆ send() [2/2]

std::unique_ptr<Communicator::Future> rapidsmpf::Single::send	(	std::unique_ptr< std::vector< std::uint8_t >>	msg,
		Rank	rank,
		Tag	tag
	)

overridevirtual

Sends a host message to a specific rank.

This is used to send data that resides in host memory and is guaranteed to be valid at the time of the call.

Use release_sync_host_data to obtain the data buffer again once the future is completed.

Parameters

msg	Unique pointer to the message data (host memory).
rank	The destination rank.
tag	Message tag for identification.

Returns: A unique pointer to a Future representing the asynchronous operation.

Exceptions

std::invalid_argument If msg is nullptr.

Implements rapidsmpf::Communicator.

◆ str()

std::string rapidsmpf::Single::str ( ) const

overridevirtual

Provides a string representation of the communicator.

Returns: A string describing the communicator.

Implements rapidsmpf::Communicator.

◆ test()

bool rapidsmpf::Single::test ( std::unique_ptr< Communicator::Future > & future )

override

Test for completion of a single future.

Parameters

future Future to test

Returns: True if the future is completed. After test returns true, it is safe to call release_data().

◆ test_some() [1/2]

std::vector<std::size_t> rapidsmpf::Single::test_some ( std::unordered_map< std::size_t, std::unique_ptr< Communicator::Future >> const & future_map )

override

Tests for completion of multiple futures in a map.

Parameters

future_map Map of futures identified by keys.

Returns: Keys of completed futures.

Exceptions

std::runtime_error if called (single-process communicators should never send messages).

◆ test_some() [2/2]

std::pair< std::vector<std::unique_ptr<Communicator::Future> >, std::vector<std::size_t> > rapidsmpf::Single::test_some ( std::vector< std::unique_ptr< Communicator::Future >> & future_vector )

override

Tests for completion of multiple futures.

Parameters

[in,out] future_vector Vector of Future objects. Completed futures are erased from the vector.

Returns: Pair of completed futures and indices of input vector that were completed.

Exceptions

std::runtime_error if called (single-process communicators should never send messages).

◆ wait()

std::unique_ptr<Buffer> rapidsmpf::Single::wait ( std::unique_ptr< Communicator::Future > future )

override

Wait for a future to complete and return the data buffer.

Parameters

future The future to wait for completion of.

Returns: A unique pointer to the GPU data buffer (or nullptr if the future had no data).

Exceptions

std::runtime_error if called (single-process communicators should never send messages)

◆ wait_all()

std::vector<std::unique_ptr<Buffer> > rapidsmpf::Single::wait_all ( std::vector< std::unique_ptr< Communicator::Future >> && futures )

override

Wait for completion of all futures and return their data buffers.

Parameters

futures Futures to wait for completion of, consumed.

Returns: A vector of the contained data buffers.

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

/__w/rapidsmpf/rapidsmpf/cpp/include/rapidsmpf/communicator/single.hpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Single()

Member Function Documentation

◆ logger()

◆ nranks()

◆ progress_thread()

◆ rank()

◆ recv()

◆ recv_any()

◆ recv_from()

◆ recv_sync_host_data()

◆ release_data()

◆ release_sync_host_data()

◆ send() [1/2]

◆ send() [2/2]

◆ str()

◆ test()

◆ test_some() [1/2]

◆ test_some() [2/2]

◆ wait()

◆ wait_all()