reshape_plan_base Derived Type

type, public :: reshape_plan_base

Base class for reshape/transpose plans


Inherits

type~~reshape_plan_base~~InheritsGraph type~reshape_plan_base reshape_plan_base type~backend_helper backend_helper type~reshape_plan_base->type~backend_helper helper type~dtfft_backend_t dtfft_backend_t type~reshape_plan_base->type~dtfft_backend_t backend type~dtfft_platform_t dtfft_platform_t type~reshape_plan_base->type~dtfft_platform_t platform type~dtfft_stream_t dtfft_stream_t type~reshape_plan_base->type~dtfft_stream_t stream type~reshape_container reshape_container type~reshape_plan_base->type~reshape_container plans type~string string type~reshape_plan_base->type~string names MPI_Comm MPI_Comm type~backend_helper->MPI_Comm comms c_ptr c_ptr type~backend_helper->c_ptr nccl_register type~dtfft_reshape_t dtfft_reshape_t type~backend_helper->type~dtfft_reshape_t reshape_type type~dtfft_transpose_t dtfft_transpose_t type~backend_helper->type~dtfft_transpose_t transpose_type type~ncclcomm ncclComm type~backend_helper->type~ncclcomm nccl_comm type~pencil pencil type~backend_helper->type~pencil pencils type~dtfft_stream_t->c_ptr stream type~abstract_reshape_handle abstract_reshape_handle type~reshape_container->type~abstract_reshape_handle p type~ncclcomm->c_ptr member

Inherited by

type~~reshape_plan_base~~InheritedByGraph type~reshape_plan_base reshape_plan_base type~reshape_plan reshape_plan type~reshape_plan->type~reshape_plan_base type~transpose_plan transpose_plan type~transpose_plan->type~reshape_plan_base type~dtfft_plan_t dtfft_plan_t type~dtfft_plan_t->type~reshape_plan rplan type~dtfft_plan_t->type~transpose_plan plan type~dtfft_core_c2c dtfft_core_c2c type~dtfft_core_c2c->type~dtfft_plan_t type~dtfft_plan_r2r_t dtfft_plan_r2r_t type~dtfft_plan_r2r_t->type~dtfft_plan_t type~plan_c plan_c type~plan_c->type~dtfft_plan_t p type~dtfft_plan_c2c_t dtfft_plan_c2c_t type~dtfft_plan_c2c_t->type~dtfft_core_c2c type~dtfft_plan_r2c_t dtfft_plan_r2c_t type~dtfft_plan_r2c_t->type~dtfft_core_c2c

Components

Type Visibility Attributes Name Initial
type(dtfft_backend_t), public :: backend

Backend
type(backend_helper), public :: helper

Backend helper
integer(kind=int64), public :: min_buffer_size

Minimal buffer size for transposition
type(dtfft_platform_t), public :: platform

Platform used for transposition
type(dtfft_stream_t), public :: stream

CUDA stream
type(reshape_container), public, allocatable :: plans(:)

Plans for each reshape operation
type(string), public, allocatable :: names(:)

Names of each reshape operation
integer(kind=int32), public, allocatable :: colors(:)

Type-Bound Procedures

procedure, public, pass(self), non_overridable :: init

Initializes reshape plan base

  • private function init(self, platform, effort, backend, autotune_effort, compression_config, base_dtype, base_storage) result(error_code)

    Initializes reshape plan base

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Reshape class
    type(dtfft_platform_t), intent(in) :: platform

    Execution platform
    type(dtfft_effort_t), intent(in) :: effort

    Effort level
    type(dtfft_backend_t), intent(in) :: backend
    type(dtfft_effort_t), intent(in) :: autotune_effort
    type(dtfft_compression_config_t), intent(in) :: compression_config

    Compression configuration
    type(MPI_Datatype), intent(in) :: base_dtype

    Base datatype
    integer(kind=int64), intent(in) :: base_storage

    Number of bytes to store single element of base datatype

    Return Value integer(kind=int32)

    Error code

procedure, public, pass(self), non_overridable :: get_async_active

Returns .true. if any of the plans is running asynchronously

  • private function get_async_active(self)

    Returns .true. if any of the plans is running asynchronously

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class

    Return Value logical

procedure, public, pass(self), non_overridable :: get_aux_bytes

Returns auxiliary buffer size

  • private pure function get_aux_bytes(self)

    Returns maximum auxiliary memory size needed by reshape plan

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class

    Return Value integer(kind=int64)

procedure, public, pass(self), non_overridable :: is_aux_needed

Returns .true. if aux buffer is needed

  • private pure function is_aux_needed(self)

    Returns true if aux is needed. false otherwise

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class

    Return Value logical

procedure, public, pass(self), non_overridable :: get_backend

Returns backend id

procedure, public, pass(self), non_overridable :: report_backends

Reports backends used by each plan. Should be used only for adaptive backend

  • private subroutine report_backends(self)

    Reports backends used by each plan. Should be used only for adaptive backend

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class

procedure, public, pass(self), non_overridable :: is_nvshmem

  • private pure function is_nvshmem(self)

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class

    Return Value logical

procedure, public, pass(self), non_overridable :: execute

Executes reshape

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

    Executes reshape plan

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Transposition class
    type(c_ptr), intent(in) :: in

    Incoming buffer
    type(c_ptr), intent(in) :: out

    Resulting buffer
    integer(kind=int32), intent(in) :: reshape_type

    Type of reshape to execute
    type(async_exec_t), intent(in) :: exec_type

    Type of execution (sync/async)
    type(c_ptr), intent(in) :: aux

    Optional auxiliary buffer
    integer(kind=int32), intent(out), optional :: error_code

    Error code

procedure, public, pass(self), non_overridable :: execute_end

Finishes asynchronous reshape

  • private subroutine execute_end(self, in, out, reshape_type, aux, error_code)

    Finishes asynchronous reshape

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Reshape class
    type(c_ptr), intent(in) :: in

    Incoming buffer
    type(c_ptr), intent(in) :: out

    Resulting buffer
    integer(kind=int32), intent(in) :: reshape_type

    Type of reshape to execute
    type(c_ptr), intent(in) :: aux

    Optional auxiliary buffer
    integer(kind=int32), intent(out) :: error_code

    Error code

procedure, public, pass(self), non_overridable :: mem_alloc

Allocates memory

  • private subroutine mem_alloc(self, comm, alloc_bytes, ptr, error_code)

    Allocates memory based on selected backend

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Reshape class
    type(MPI_Comm), intent(in) :: comm

    MPI communicator
    integer(kind=int64), intent(in) :: alloc_bytes

    Number of bytes to allocate
    type(c_ptr), intent(out) :: ptr

    Pointer to the allocated memory
    integer(kind=int32), intent(out) :: error_code

    Error code

procedure, public, pass(self), non_overridable :: mem_free

Frees memory

  • private subroutine mem_free(self, ptr, error_code)

    Frees memory allocated with mem_alloc

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Reshape class
    type(c_ptr), intent(in) :: ptr

    Pointer to the memory to free
    integer(kind=int32), intent(out) :: error_code

    Error code

procedure, public, pass(self) :: destroy

Destroys reshape plan

  • private subroutine destroy(self)

    Destroys reshape plan

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(inout) :: self

    Reshape class

procedure, public, pass(self) :: report_compression

Reports compression statistics

  • private subroutine report_compression(self)

    Reports compression statistics

    Arguments

    Type IntentOptional Attributes Name
    class(reshape_plan_base), intent(in) :: self

    Reshape class