Gather-scatter communication using one-sided uTofu puts. More...

Inheritance diagram for gs_utofu::gs_utofu_t:

Collaboration diagram for gs_utofu::gs_utofu_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, send_pe, recv_pe)
	Initialise the uTofu communication method. See gs_comm.f90 for details.

procedure, pass(this)	free (this)
	Deallocate the uTofu communication method.

procedure, pass(this)	nbsend (this, u, n, tag, deps, strm)
	Pack the send slabs and fire all one-sided puts (non-blocking).

procedure, pass(this)	nbrecv (this, tag)
	No-op: the one-sided receive buffer is registered once at init, so there is nothing to post per round.

procedure, pass(this)	nbwait (this, u, n, op, strm)
	Poll for incoming puts, reducing each slab into u as it lands, then wait for our own sends to drain and flip the double-buffer parity.

procedure, pass(this)	nbsend_vec (this, u, n, nc, tag, deps, strm)
	Pack the fused nc-component send slabs and fire the puts (non-blocking).

procedure, pass(this)	nbrecv_vec (this, tag, nc)
	No-op: the vector receive buffer is registered once at init, so there is nothing to post per round.

procedure, pass(this)	nbwait_vec (this, u, n, nc, op, strm)
	Poll for incoming vector puts, reducing each nc-component slab into u as it lands, then flip the vector double-buffer parity. Same protocol as gs_nbwait_utofu, on the vector context and parity.

procedure(gs_comm_init), deferred, pass	init gs_comm_init

procedure(gs_comm_free), deferred, pass	free gs_comm_free

procedure(gs_nbsend), deferred, pass	nbsend gs_nbsend

procedure(gs_nbrecv), deferred, pass	nbrecv gs_nbrecv

procedure(gs_nbwait), deferred, pass	nbwait gs_nbwait

procedure, pass(this)	init_dofs (this)

procedure, pass(this)	free_dofs (this)

procedure, pass(this)	init_order (this, send_pe, recv_pe)
	Obtains which ranks to send and receive data from.

procedure, pass(this)	free_order (this)

procedure, pass(this)	take_schedule (this, src)
	Take over the gather-scatter schedule (dof lists and peer order) of src, avoiding a second (expensive) pass over the connectivity. The data is moved rather than copied, so src is left without a schedule and must not be used for communication afterwards (it can still be freed). No communication resources are set up here; complete the handover with init_schedule once src has been freed, so that the two backends never hold their resources at the same time.

procedure, pass(this)	init_schedule (this)
	Set up this communication method for the schedule taken over by take_schedule. Collective, as init is.

procedure, pass(this)	nbsend_vec (this, u, n, nc, tag, deps, strm)
	Fused vector halo exchange. Default implementations abort; backends that set vec_supported = .true. override them.

procedure, pass(this)	nbrecv_vec (this, tag, nc)
	Default fused vector receive. Abort unless a backend overrides it.

procedure, pass(this)	nbwait_vec (this, u, n, nc, op, strm)
	Default fused vector wait/reduce. Abort unless a backend overrides it.

Public Attributes
real(kind=rp), dimension(:), pointer	send_buf => null()
	Concatenated send slabs, one per peer (the put sources). Registered with uTofu; a pointer (not allocatable) so c_loc can take its address – the standard forbids the target attribute on a type component.

real(kind=rp), dimension(:), pointer	recv_buf => null()
	Double-buffered receive slabs: two halves of buf_size elements each, selected by parity. Registered with uTofu; pointer for the same reason as send_buf.

integer, dimension(:), allocatable	send_len
	Per-peer slab lengths and 0-based offsets into send_buf / recv_buf.

integer, dimension(:), allocatable	recv_len

integer, dimension(:), allocatable	send_offset

integer, dimension(:), allocatable	recv_offset

integer(c_int64_t), dimension(:), allocatable	send_off64
	Int64 views of the send layout, passed to the C transport.

integer(c_int64_t), dimension(:), allocatable	send_len64

integer(c_int64_t), dimension(:), allocatable	rmt_vcq_id
	Per send-peer remote put targets, learned from each receiver at init: its receive VCQ id, buffer STADD, the byte-offsets of our slab in its two parity halves, and the edata tag it wants us to stamp.

integer(c_int64_t), dimension(:), allocatable	rmt_stadd

integer(c_int64_t), dimension(:), allocatable	dst_off0

integer(c_int64_t), dimension(:), allocatable	dst_off1

integer(c_int), dimension(:), allocatable	dst_tag

integer(c_int), dimension(:), allocatable	recv_indices
	Scratch for the unpack-as-ready loop: receive-peer indices completed by the latest poll and how many (c_int to match the C transport).

integer(c_int)	ncompleted = 0

integer	buf_size = 0
	Size in elements of one receive half (= total receive count).

integer	send_size = 0
	Size in elements of one send half (= total send count); send_buf is double-buffered (2 * send_size) so a round can pack while the previous round's puts are still draining.

integer	elem_size = 0
	Storage size of one element in bytes.

integer	parity = 0
	Active double-buffer half for the next round.

type(c_ptr)	ctx = c_null_ptr
	Opaque per-instance uTofu context (registrations + notice stash).

real(kind=rp), dimension(:), pointer	send_buf_v => null()
	Fused vector (multi-component) path: double-buffered send/recv slabs sized for GS_VEC_NC components. Each peer slab holds nc consecutive component blocks, so the scalar layout is reused scaled by nc. The path has its OWN uTofu context (registrations, receive VCQ and thus private MRQ, completion counters) and its own parity: a neighbour racing from a vector round into a scalar round (or vice versa) must not land notices in the other path's queue.

real(kind=rp), dimension(:), pointer	recv_buf_v => null()

integer(c_int64_t), dimension(:), allocatable	rmt_vcq_id_v
	Per send-peer vector-path put targets: the receiver's vector recv VCQ id and buffer STADD, our slab's scalar element offset within one of its halves, and its scalar half size (both unscaled; the sender scales by nc and folds the parity in at round time).

integer(c_int64_t), dimension(:), allocatable	rmt_stadd_v

integer(c_int64_t), dimension(:), allocatable	rmt_off_v

integer(c_int64_t), dimension(:), allocatable	rmt_bufsz_v

integer(c_int64_t), dimension(:), allocatable	send_off64_v
	Per-round scratch, computed by the master each nbsend_vec: the send layout scaled by nc and the absolute destination element offsets (vector parity already folded in).

integer(c_int64_t), dimension(:), allocatable	send_len64_v

integer(c_int64_t), dimension(:), allocatable	dst_off_v

integer	parity_v = 0
	Active vector double-buffer half for the next vector round.

type(c_ptr)	ctx_v = c_null_ptr
	Opaque uTofu context of the vector path.

type(stack_i4_t), dimension(:), allocatable	send_dof
	A list of stacks of dof indices local to this process to send to rank_i.

type(stack_i4_t), dimension(:), allocatable	recv_dof
	recv_dof(rank_i) is a stack of dof indices local to this process to receive from rank_i. size(recv_dof) == pe_size

integer, dimension(:), allocatable	send_pe
	Array of ranks that this process should send to.

integer, dimension(:), allocatable	recv_pe
	array of ranks that this process will receive messages from

logical	vec_supported = .false.
	Whether this backend implements the fused vector (multi-component) halo exchange (nbsend_vec/nbrecv_vec/nbwait_vec). When .false., the gs_op_r3 caller falls back to nc independent scalar exchanges.

Detailed Description

Definition at line 76 of file gs_utofu.F90.

Member Function/Subroutine Documentation

◆ free() [1/2]

procedure, pass(this) gs_utofu::gs_utofu_t::free ( class(gs_utofu_t), intent(inout) this )

Definition at line 138 of file gs_utofu.F90.

◆ free() [2/2]

procedure(gs_comm_free), deferred, pass gs_comm::gs_comm_t::free

pure virtualinherited

Definition at line 70 of file gs_comm.f90.

◆ free_dofs()

procedure, pass(this) gs_comm::gs_comm_t::free_dofs ( class(gs_comm_t), intent(inout) this )

inherited

Definition at line 75 of file gs_comm.f90.

◆ free_order()

procedure, pass(this) gs_comm::gs_comm_t::free_order ( class(gs_comm_t), intent(inout) this )

inherited

Definition at line 77 of file gs_comm.f90.

◆ init() [1/2]

procedure, pass(this) gs_utofu::gs_utofu_t::init	(	class(gs_utofu_t), intent(inout)	this,
		type(stack_i4_t), intent(inout)	send_pe,
		type(stack_i4_t), intent(inout)	recv_pe
	)

Definition at line 137 of file gs_utofu.F90.

◆ init() [2/2]

procedure(gs_comm_init), deferred, pass gs_comm::gs_comm_t::init

pure virtualinherited

Definition at line 69 of file gs_comm.f90.

◆ init_dofs()

procedure, pass(this) gs_comm::gs_comm_t::init_dofs ( class(gs_comm_t), intent(inout) this )

inherited

Definition at line 74 of file gs_comm.f90.

◆ init_order()

procedure, pass(this) gs_comm::gs_comm_t::init_order	(	class(gs_comm_t), intent(inout)	this,
		type(stack_i4_t), intent(inout)	send_pe,
		type(stack_i4_t), intent(inout)	recv_pe
	)

inherited

Parameters

send_pe,only	contains rank ids this porcesss should send to
recv_pe,only	the ranks this process should receive from

Definition at line 76 of file gs_comm.f90.

◆ init_schedule()

procedure, pass(this) gs_comm::gs_comm_t::init_schedule ( class(gs_comm_t), intent(inout) this )

inherited

Definition at line 79 of file gs_comm.f90.

◆ nbrecv() [1/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbrecv	(	class(gs_utofu_t), intent(inout)	this,
		integer, intent(in)	tag
	)

Definition at line 140 of file gs_utofu.F90.

◆ nbrecv() [2/2]

procedure(gs_nbrecv), deferred, pass gs_comm::gs_comm_t::nbrecv

pure virtualinherited

Definition at line 72 of file gs_comm.f90.

◆ nbrecv_vec() [1/2]

procedure, pass(this) gs_comm::gs_comm_t::nbrecv_vec	(	class(gs_comm_t), intent(inout)	this,
		integer, intent(in)	tag,
		integer, intent(in)	nc
	)

inherited

Definition at line 83 of file gs_comm.f90.

◆ nbrecv_vec() [2/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbrecv_vec	(	class(gs_utofu_t), intent(inout)	this,
		integer, intent(in)	tag,
		integer, intent(in)	nc
	)

Definition at line 143 of file gs_utofu.F90.

◆ nbsend() [1/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbsend	(	class(gs_utofu_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	u,
		integer, intent(in)	n,
		integer, intent(in)	tag,
		type(c_ptr), intent(inout)	deps,
		type(c_ptr), intent(inout)	strm
	)

Definition at line 139 of file gs_utofu.F90.

◆ nbsend() [2/2]

procedure(gs_nbsend), deferred, pass gs_comm::gs_comm_t::nbsend

pure virtualinherited

Definition at line 71 of file gs_comm.f90.

◆ nbsend_vec() [1/2]

procedure, pass(this) gs_comm::gs_comm_t::nbsend_vec	(	class(gs_comm_t), intent(inout)	this,
		real(kind=rp), dimension(nc*n), intent(inout)	u,
		integer, intent(in)	n,
		integer, intent(in)	nc,
		integer, intent(in)	tag,
		type(c_ptr), intent(inout)	deps,
		type(c_ptr), intent(inout)	strm
	)

inherited

Parameters

u	compact shared buffer, component-outer: u((c-1)*n + idx)
n	number of shared dofs (per component)
nc	number of components

Definition at line 82 of file gs_comm.f90.

◆ nbsend_vec() [2/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbsend_vec	(	class(gs_utofu_t), intent(inout)	this,
		real(kind=rp), dimension(nc*n), intent(inout)	u,
		integer, intent(in)	n,
		integer, intent(in)	nc,
		integer, intent(in)	tag,
		type(c_ptr), intent(inout)	deps,
		type(c_ptr), intent(inout)	strm
	)

Parameters

u	compact shared buffer, component-outer: u((c-1)*n + idx). Peer i's slab holds nc consecutive blocks of send_len(i) values, so the scalar layout is reused scaled by nc. Same protocol as gs_nbsend_utofu, on the vector context and parity.

Definition at line 142 of file gs_utofu.F90.

◆ nbwait() [1/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbwait	(	class(gs_utofu_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	u,
		integer, intent(in)	n,
		integer	op,
		type(c_ptr), intent(inout)	strm
	)

Definition at line 141 of file gs_utofu.F90.

◆ nbwait() [2/2]

procedure(gs_nbwait), deferred, pass gs_comm::gs_comm_t::nbwait

pure virtualinherited

Definition at line 73 of file gs_comm.f90.

◆ nbwait_vec() [1/2]

procedure, pass(this) gs_comm::gs_comm_t::nbwait_vec	(	class(gs_comm_t), intent(inout)	this,
		real(kind=rp), dimension(nc*n), intent(inout)	u,
		integer, intent(in)	n,
		integer, intent(in)	nc,
		integer	op,
		type(c_ptr), intent(inout)	strm
	)

inherited

Definition at line 84 of file gs_comm.f90.

◆ nbwait_vec() [2/2]

procedure, pass(this) gs_utofu::gs_utofu_t::nbwait_vec	(	class(gs_utofu_t), intent(inout)	this,
		real(kind=rp), dimension(nc*n), intent(inout)	u,
		integer, intent(in)	n,
		integer, intent(in)	nc,
		integer	op,
		type(c_ptr), intent(inout)	strm
	)

Definition at line 144 of file gs_utofu.F90.

◆ take_schedule()

procedure, pass(this) gs_comm::gs_comm_t::take_schedule	(	class(gs_comm_t), intent(inout)	this,
		class(gs_comm_t), intent(inout)	src
	)

inherited

Parameters

src	the backend to take the schedule from, left without one

Definition at line 78 of file gs_comm.f90.

Member Data Documentation

◆ buf_size

integer gs_utofu::gs_utofu_t::buf_size = 0

Definition at line 101 of file gs_utofu.F90.

◆ ctx

type(c_ptr) gs_utofu::gs_utofu_t::ctx = c_null_ptr

Definition at line 111 of file gs_utofu.F90.

◆ ctx_v

type(c_ptr) gs_utofu::gs_utofu_t::ctx_v = c_null_ptr

Definition at line 135 of file gs_utofu.F90.

◆ dst_off0

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::dst_off0

Definition at line 94 of file gs_utofu.F90.

◆ dst_off1

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::dst_off1

Definition at line 94 of file gs_utofu.F90.

◆ dst_off_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::dst_off_v

Definition at line 131 of file gs_utofu.F90.

◆ dst_tag

integer(c_int), dimension(:), allocatable gs_utofu::gs_utofu_t::dst_tag

Definition at line 95 of file gs_utofu.F90.

◆ elem_size

integer gs_utofu::gs_utofu_t::elem_size = 0

Definition at line 107 of file gs_utofu.F90.

◆ ncompleted

integer(c_int) gs_utofu::gs_utofu_t::ncompleted = 0

Definition at line 99 of file gs_utofu.F90.

◆ parity

integer gs_utofu::gs_utofu_t::parity = 0

Definition at line 109 of file gs_utofu.F90.

◆ parity_v

integer gs_utofu::gs_utofu_t::parity_v = 0

Definition at line 133 of file gs_utofu.F90.

◆ recv_buf

real(kind=rp), dimension(:), pointer gs_utofu::gs_utofu_t::recv_buf => null()

Definition at line 84 of file gs_utofu.F90.

◆ recv_buf_v

real(kind=rp), dimension(:), pointer gs_utofu::gs_utofu_t::recv_buf_v => null()

Definition at line 120 of file gs_utofu.F90.

◆ recv_dof

type(stack_i4_t), dimension(:), allocatable gs_comm::gs_comm_t::recv_dof

inherited

Definition at line 57 of file gs_comm.f90.

◆ recv_indices

integer(c_int), dimension(:), allocatable gs_utofu::gs_utofu_t::recv_indices

Definition at line 98 of file gs_utofu.F90.

◆ recv_len

integer, dimension(:), allocatable gs_utofu::gs_utofu_t::recv_len

Definition at line 86 of file gs_utofu.F90.

◆ recv_offset

integer, dimension(:), allocatable gs_utofu::gs_utofu_t::recv_offset

Definition at line 87 of file gs_utofu.F90.

◆ recv_pe

integer, dimension(:), allocatable gs_comm::gs_comm_t::recv_pe

inherited

Definition at line 63 of file gs_comm.f90.

◆ rmt_bufsz_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_bufsz_v

Definition at line 126 of file gs_utofu.F90.

◆ rmt_off_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_off_v

Definition at line 126 of file gs_utofu.F90.

◆ rmt_stadd

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_stadd

Definition at line 93 of file gs_utofu.F90.

◆ rmt_stadd_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_stadd_v

Definition at line 125 of file gs_utofu.F90.

◆ rmt_vcq_id

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_vcq_id

Definition at line 93 of file gs_utofu.F90.

◆ rmt_vcq_id_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::rmt_vcq_id_v

Definition at line 125 of file gs_utofu.F90.

◆ send_buf

real(kind=rp), dimension(:), pointer gs_utofu::gs_utofu_t::send_buf => null()

Definition at line 80 of file gs_utofu.F90.

◆ send_buf_v

real(kind=rp), dimension(:), pointer gs_utofu::gs_utofu_t::send_buf_v => null()

Definition at line 119 of file gs_utofu.F90.

◆ send_dof

type(stack_i4_t), dimension(:), allocatable gs_comm::gs_comm_t::send_dof

inherited

Definition at line 54 of file gs_comm.f90.

◆ send_len

integer, dimension(:), allocatable gs_utofu::gs_utofu_t::send_len

Definition at line 86 of file gs_utofu.F90.

◆ send_len64

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::send_len64

Definition at line 89 of file gs_utofu.F90.

◆ send_len64_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::send_len64_v

Definition at line 130 of file gs_utofu.F90.

◆ send_off64

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::send_off64

Definition at line 89 of file gs_utofu.F90.

◆ send_off64_v

integer(c_int64_t), dimension(:), allocatable gs_utofu::gs_utofu_t::send_off64_v

Definition at line 130 of file gs_utofu.F90.

◆ send_offset

integer, dimension(:), allocatable gs_utofu::gs_utofu_t::send_offset

Definition at line 87 of file gs_utofu.F90.

◆ send_pe

integer, dimension(:), allocatable gs_comm::gs_comm_t::send_pe

inherited

Note: : this will usually be fewer than the total number of ranks size(send_pe) <= pe_size

Definition at line 61 of file gs_comm.f90.

◆ send_size

integer gs_utofu::gs_utofu_t::send_size = 0

Definition at line 105 of file gs_utofu.F90.

◆ vec_supported

logical gs_comm::gs_comm_t::vec_supported = .false.

inherited

Definition at line 67 of file gs_comm.f90.

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

/home/runner/work/neko/neko/src/gs/gs_utofu.F90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ free() [1/2]

◆ free() [2/2]

◆ free_dofs()

◆ free_order()

◆ init() [1/2]

◆ init() [2/2]

◆ init_dofs()

◆ init_order()

◆ init_schedule()

◆ nbrecv() [1/2]

◆ nbrecv() [2/2]

◆ nbrecv_vec() [1/2]

◆ nbrecv_vec() [2/2]

◆ nbsend() [1/2]

◆ nbsend() [2/2]

◆ nbsend_vec() [1/2]

◆ nbsend_vec() [2/2]

◆ nbwait() [1/2]

◆ nbwait() [2/2]

◆ nbwait_vec() [1/2]

◆ nbwait_vec() [2/2]

◆ take_schedule()

Member Data Documentation

◆ buf_size

◆ ctx

◆ ctx_v

◆ dst_off0

◆ dst_off1

◆ dst_off_v

◆ dst_tag

◆ elem_size

◆ ncompleted

◆ parity

◆ parity_v

◆ recv_buf

◆ recv_buf_v

◆ recv_dof

◆ recv_indices

◆ recv_len

◆ recv_offset

◆ recv_pe

◆ rmt_bufsz_v

◆ rmt_off_v

◆ rmt_stadd

◆ rmt_stadd_v

◆ rmt_vcq_id

◆ rmt_vcq_id_v

◆ send_buf

◆ send_buf_v

◆ send_dof

◆ send_len

◆ send_len64

◆ send_len64_v

◆ send_off64

◆ send_off64_v

◆ send_offset

◆ send_pe

◆ send_size

◆ vec_supported