Inheritance diagram for Arcane::MessagePassing::HybridMachineShMemWinBaseInternal:

Collaboration diagram for Arcane::MessagePassing::HybridMachineShMemWinBaseInternal:

Public Member Functions
	HybridMachineShMemWinBaseInternal (Int32 my_rank_mpi, Int32 my_rank_local_proc, Int32 nb_rank_local_proc, ConstArrayView< Int32 > ranks, Int32 sizeof_type, Ref< Mpi::MpiMultiMachineShMemWinBaseInternal > mpi_windows, IThreadBarrier *barrier)
Int32	sizeofOneElem () const override
	Method to get the size of an element in the window.
ConstArrayView< Int32 >	machineRanks () const override
	Method to get the ranks that possess a segment in the window.
void	barrier () const override
	Method to wait until all processes/threads of the node call this method to continue execution.
Span< std::byte >	segmentView () override
	Method to get a view of our segment.
Span< std::byte >	segmentView (Int32 rank) override
	Method to get a view of the segment of another subdomain of the node.
Span< const std::byte >	segmentConstView () const override
	Method to get a view of our segment.
Span< const std::byte >	segmentConstView (Int32 rank) const override
	Method to get a view of the segment of another subdomain of the node.
void	add (Span< const std::byte > elem) override
	Method to add elements into our segment.
void	add () override
void	addToAnotherSegment (Int32 rank, Span< const std::byte > elem) override
	Method to add elements into the segment of another subdomain.
void	addToAnotherSegment () override
void	reserve (Int64 new_capacity) override
	Method to reserve memory space in our segment.
void	reserve () override
void	resize (Int64 new_size) override
	Method to resize our segment.
void	resize () override
void	shrink () override
	Method to reduce the reserved memory space for the segments to the minimum necessary.

Private Attributes
Int32	m_my_rank_local_proc = 0
Int32	m_nb_rank_local_proc = 0
Int32	m_my_rank_mpi = 0
ConstArrayView< Int32 >	m_machine_ranks
Int32	m_sizeof_type = 0
Ref< Mpi::MpiMultiMachineShMemWinBaseInternal >	m_mpi_windows
IThreadBarrier *	m_thread_barrier = nullptr

Detailed Description

Definition at line 39 of file HybridMachineShMemWinBaseInternal.h.

Constructor & Destructor Documentation

◆ HybridMachineShMemWinBaseInternal()

Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::HybridMachineShMemWinBaseInternal	(	Int32	my_rank_mpi,
		Int32	my_rank_local_proc,
		Int32	nb_rank_local_proc,
		ConstArrayView< Int32 >	ranks,
		Int32	sizeof_type,
		Ref< Mpi::MpiMultiMachineShMemWinBaseInternal >	mpi_windows,
		IThreadBarrier *	barrier )

Definition at line 34 of file HybridMachineShMemWinBaseInternal.cc.

Member Function Documentation

◆ add() [1/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::add ( )

overridevirtual

See add(Span<const std::byte> elem).

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 136 of file HybridMachineShMemWinBaseInternal.cc.

◆ add() [2/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::add ( Span< const std::byte > elem )

overridevirtual

Method to add elements into our segment.

Collective call.

Note: Do not mix calls to this method with calls to addToAnotherSegment().

If the segment is too small, it will be resized.

Subdomains that do not wish to add elements can call the add() method without parameters or this method with an empty view.

Parameters

elem	The elements to add.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 122 of file HybridMachineShMemWinBaseInternal.cc.

◆ addToAnotherSegment() [1/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::addToAnotherSegment ( )

overridevirtual

See addToAnotherSegment(Int32 rank, Span<const std::byte> elem).

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 168 of file HybridMachineShMemWinBaseInternal.cc.

◆ addToAnotherSegment() [2/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::addToAnotherSegment	(	Int32	rank,
		Span< const std::byte >	elem )

overridevirtual

Method to add elements into the segment of another subdomain.

Collective call.

Note: Do not mix calls to this method with calls to add().

Two subdomains must not add elements to the same subdomain segment.

If the targeted segment is too small, it will be resized.

Subdomains that do not wish to add elements can call the addToAnotherSegment() method without parameters.

Parameters

rank	The subdomain into which to add elements.
elem	The elements to add.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 149 of file HybridMachineShMemWinBaseInternal.cc.

◆ barrier()

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::barrier ( ) const

overridevirtual

Method to wait until all processes/threads of the node call this method to continue execution.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 66 of file HybridMachineShMemWinBaseInternal.cc.

◆ machineRanks()

ConstArrayView< Int32 > Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::machineRanks ( ) const

overridevirtual

Method to get the ranks that possess a segment in the window.

Non-collective call.

Returns: A view containing the rank IDs.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 57 of file HybridMachineShMemWinBaseInternal.cc.

◆ reserve() [1/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::reserve ( )

overridevirtual

See reserve(Int64 new_capacity)

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 196 of file HybridMachineShMemWinBaseInternal.cc.

◆ reserve() [2/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::reserve ( Int64 new_capacity )

overridevirtual

Method to reserve memory space in our segment.

Collective call.

This method does nothing if new_capacity is less than the memory space already allocated for the segment. For processes that do not wish to increase the available memory space for their segment, it is possible to set the new_capacity parameter to 0 or use the reserve() method (without arguments).

MPI will reserve a space with a size greater than or equal to new_capacity.

This method does not resize the segment; you must always use the add() method to add elements.

To resize the segment, the resize(Int64 new_size) method is available.

Parameters

new_capacity The requested new capacity.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 182 of file HybridMachineShMemWinBaseInternal.cc.

◆ resize() [1/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::resize ( )

overridevirtual

See resize(Int64 new_size)

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 223 of file HybridMachineShMemWinBaseInternal.cc.

◆ resize() [2/2]

void Arcane::MessagePassing::HybridMachineShMemWinBaseInternal::resize ( Int64 new_size )

overridevirtual

Method to resize our segment.

Collective call.

If the provided size is less than the current size of the segment, elements located after the provided size will be deleted.

For processes that do not wish to resize their segment, it is possible to set the new_size argument to -1 or call the resize() method (without arguments).

Parameters

new_size The new size.

Implements Arcane::MessagePassing::IMachineShMemWinBaseInternal.

Definition at line 209 of file HybridMachineShMemWinBaseInternal.cc.