dtfft_abstract_backend

This module describes Abstraction for all Backends: abstract_backend

Uses

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer(kind=int32),	public,	parameter	::	NCCL_REGISTER_PREALLOC_SIZE	=	8	Number of register elements to preallocate

Abstract Interfaces

abstract interface

private subroutine create_interface(self, helper, base_storage)

Creates overriding class

Arguments

Type	Intent		Name
class(abstract_backend),	intent(inout)	::	self	Abstract Backend
type(backend_helper),	intent(in)	::	helper	Backend helper
integer(kind=int64),	intent(in)	::	base_storage	Number of bytes to store single element

abstract interface

private subroutine execute_interface(self, in, out, stream, aux, error_code)

Executes Backend

Arguments

Type	Intent	Attributes		Name
class(abstract_backend),	intent(inout)		::	self	Abstract Backend
real(kind=real32),	intent(inout),	target	::	in(:)	Send pointer
real(kind=real32),	intent(inout),	target	::	out(:)	Recv pointer
type(dtfft_stream_t),	intent(in)		::	stream	Main execution CUDA stream
real(kind=real32),	intent(inout),	target	::	aux(:)	Aux pointer
integer(kind=int32),	intent(out)		::	error_code	Error code

abstract interface

private subroutine destroy_interface(self)

Destroys overriding class

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(inout)			::	self	Abstract Backend

Derived Types

type, public :: backend_helper

Helper with nccl, mpi and nvshmem communicators

Components

Type	Visibility	Attributes		Name		Initial
logical,	public		::	is_nccl_created	=	.false.	Flag is `nccl_comm` has been created
type(ncclComm),	public		::	nccl_comm			NCCL communicator
logical,	public		::	should_register			If NCCL buffer should be registered
type(c_ptr),	public,	allocatable	::	nccl_register(:,:)			NCCL register cache
integer(kind=int32),	public		::	nccl_register_size			Number of elements in `nccl_register`
type(MPI_Comm),	public,	allocatable	::	comms(:)			MPI communicators
integer(kind=int32),	public,	allocatable	::	comm_mappings(:,:)			Mapping of 1d comm ranks to global comm
type(dtfft_transpose_t),	public		::	tranpose_type			Type of transpose to create
type(pencil),	public,	pointer	::	pencils(:)			Pencils

Type-Bound Procedures

procedure, public, pass(self) :: create => create_helper	../../ Creates helper
procedure, public, pass(self) :: destroy => destroy_helper	../../ Destroys helper

type, public, abstract :: abstract_backend

The most Abstract Backend

Components

Type	Visibility	Attributes		Name
type(dtfft_backend_t),	public		::	backend	Backend type
type(dtfft_platform_t),	public		::	platform	Platform to use
logical,	public		::	is_selfcopy	If backend is self-copying
logical,	public		::	is_pipelined	If backend is pipelined
logical,	public		::	is_even	If all processes send/recv same amount of memory
integer(kind=int64),	public		::	aux_size	Number of bytes required by aux buffer
integer(kind=int64),	public		::	send_recv_buffer_size	Number of float elements used in `c_f_pointer`
type(MPI_Comm),	public		::	comm	MPI Communicator
integer(kind=int32),	public,	allocatable	::	comm_mapping(:)	Mapping of 1d comm ranks to global comm
integer(kind=int32),	public		::	comm_size	Size of MPI Comm
integer(kind=int32),	public		::	comm_rank	Rank in MPI Comm
integer(kind=int64),	public,	allocatable	::	send_displs(:)	Send data displacements, in float elements
integer(kind=int64),	public,	allocatable	::	send_floats(:)	Send data elements, in float elements
integer(kind=int64),	public,	allocatable	::	recv_displs(:)	Recv data displacements, in float elements
integer(kind=int64),	public,	allocatable	::	recv_floats(:)	Recv data elements, in float elements
type(cudaEvent),	public		::	execution_event	Event for main execution stream
type(cudaEvent),	public		::	copy_event	Event for copy stream
type(dtfft_stream_t),	public		::	copy_stream	Stream for copy operations
integer(kind=int64),	public		::	self_copy_bytes	Number of bytes to copy it itself
integer(kind=int64),	public		::	self_send_displ	Displacement for send buffer
integer(kind=int64),	public		::	self_recv_displ	Displacement for recv buffer
class(abstract_kernel),	public,	pointer	::	unpack_kernel	Kernel for unpacking data

Type-Bound Procedures

procedure, public, non_overridable, pass(self) :: create	../../ Creates Abstract Backend
procedure, public, non_overridable, pass(self) :: execute	../../ Executes Backend
procedure, public, non_overridable, pass(self) :: destroy	../../ Destroys Abstract Backend
procedure, public, non_overridable, pass(self) :: get_aux_size	../../ Returns number of bytes required by aux buffer
procedure, public, non_overridable, pass(self) :: set_unpack_kernel	../../ Sets unpack kernel for pipelined backend
procedure, public, pass(self) :: execute_end	../../ Ends execution of Backend
procedure, public, pass(self) :: execute_self_copy
procedure, public, pass(self) :: get_async_active	../../ Returns if async execution is active
procedure(create_interface), public, deferred, pass(self) :: create_private	../../ Creates overriding class
procedure(execute_interface), public, deferred, pass(self) :: execute_private	../../ Executes Backend
procedure(destroy_interface), public, deferred, pass(self) :: destroy_private	../../ Destroys overriding class

Functions

private elemental function get_async_active(self)

Returns if async execution is active

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(in)			::	self	Abstract backend

Return Value logical

private pure function get_aux_size(self)

Returns number of bytes required by aux buffer

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(in)			::	self	Abstract backend

Return Value integer(kind=int64)

Subroutines

private subroutine create(self, backend, helper, platform, comm_id, send_displs, send_counts, recv_displs, recv_counts, base_storage)

Creates Abstract Backend

Arguments

Type	Intent		Name
class(abstract_backend),	intent(inout)	::	self	Abstract Backend
type(dtfft_backend_t),	intent(in)	::	backend	Backend type
type(backend_helper),	intent(in)	::	helper	Backend helper
type(dtfft_platform_t),	intent(in)	::	platform	Platform to use
integer(kind=int8),	intent(in)	::	comm_id	Id of communicator to use
integer(kind=int32),	intent(in)	::	send_displs(:)	Send data displacements, in original elements
integer(kind=int32),	intent(in)	::	send_counts(:)	Send data elements, in float elements
integer(kind=int32),	intent(in)	::	recv_displs(:)	Recv data displacements, in float elements
integer(kind=int32),	intent(in)	::	recv_counts(:)	Recv data elements, in float elements
integer(kind=int64),	intent(in)	::	base_storage	Number of bytes to store single element

private subroutine execute(self, in, out, stream, aux, exec_type, error_code)

Executes Backend

Arguments

Type	Intent		Name
class(abstract_backend),	intent(inout)	::	self	Self-copying backend
real(kind=real32),	intent(inout)	::	in(:)	Send pointer
real(kind=real32),	intent(inout)	::	out(:)	Recv pointer
type(dtfft_stream_t),	intent(in)	::	stream	CUDA stream
real(kind=real32),	intent(inout)	::	aux(:)	Aux pointer
type(async_exec_t),	intent(in)	::	exec_type	Type of async execution
integer(kind=int32),	intent(out)	::	error_code	Error code

private subroutine execute_end(self, error_code)

Ends execution of Backend

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(inout)			::	self	Abstract backend
integer(kind=int32),	intent(out)			::	error_code	Error code

private subroutine execute_self_copy(self, in, out, stream)

Arguments

Type	Intent		Name
class(abstract_backend),	intent(in)	::	self	Abstract backend
real(kind=real32),	intent(in)	::	in(*)	Send pointer
real(kind=real32),	intent(inout)	::	out(*)	Recv pointer
type(dtfft_stream_t),	intent(in)	::	stream	CUDA stream

private subroutine destroy(self)

Destroys Abstract Backend

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(inout)			::	self	Abstract backend

private subroutine set_unpack_kernel(self, unpack_kernel)

Sets unpack kernel for pipelined backend

Arguments

Type	Intent	Optional	Attributes		Name
class(abstract_backend),	intent(inout)			::	self	Pipelined backend
class(abstract_kernel),	intent(in),		target	::	unpack_kernel	Kernel for unpacking data

private subroutine create_helper(self, platform, base_comm, comms, is_nccl_needed, pencils)

Creates helper

Arguments

Type	Intent	Attributes		Name
class(backend_helper),	intent(inout)		::	self	Backend helper
type(dtfft_platform_t),	intent(in)		::	platform	Platform to use
type(MPI_Comm),	intent(in)		::	base_comm	MPI communicator
type(MPI_Comm),	intent(in)		::	comms(:)	1D Communicators
logical,	intent(in)		::	is_nccl_needed	If nccl communicator will be needed
type(pencil),	intent(in),	target	::	pencils(:)	Pencils

private subroutine destroy_helper(self)

Destroys helper

Arguments

Type	Intent	Optional	Attributes		Name
class(backend_helper),	intent(inout)			::	self	Backend helper

dtfft_abstract_backend Module

Contents

Variables

Abstract Interfaces

Derived Types

Functions

Subroutines

Uses

Used by

Variables

Abstract Interfaces

abstract interface

private subroutine create_interface(self, helper, base_storage)

Arguments

abstract interface

private subroutine execute_interface(self, in, out, stream, aux, error_code)

Arguments

abstract interface

private subroutine destroy_interface(self)

Arguments

Derived Types

type, public :: backend_helper

Components

Type-Bound Procedures

type, public, abstract :: abstract_backend

Components

Type-Bound Procedures

Functions

private elemental function get_async_active(self)

Arguments

Return Value logical

private pure function get_aux_size(self)

Arguments

Return Value integer(kind=int64)

Subroutines

private subroutine create(self, backend, helper, platform, comm_id, send_displs, send_counts, recv_displs, recv_counts, base_storage)

Arguments

private subroutine execute(self, in, out, stream, aux, exec_type, error_code)

Arguments

private subroutine execute_end(self, error_code)

Arguments

private subroutine execute_self_copy(self, in, out, stream)

Arguments

private subroutine destroy(self)

Arguments

private subroutine set_unpack_kernel(self, unpack_kernel)

Arguments

private subroutine create_helper(self, platform, base_comm, comms, is_nccl_needed, pencils)

Arguments

private subroutine destroy_helper(self)

Arguments