All reduction, which does a reduce and then broadcasts the data to all IO servers. More...

Data Types
type	allreduce_type

Functions/Subroutines
subroutine, public	init_allreduction_inter_io (io_configuration)
	Initialises the all reduction inter IO functionality. More...

subroutine, public	finalise_allreduction_inter_io (io_configuration)
	Finalises the all reduction inter IO functionality. More...

logical function, public	check_allreduction_inter_io_for_completion (io_configuration)
	Determines whether this all reduction inter IO functionality has completed or not. More...

subroutine, public	perform_inter_io_allreduction (io_configuration, field_values, field_size, field_name, reduction_op, root, timestep, completion_procedure)
	Performs the all reduction inter IO reduction. More...

subroutine	internal_reduction_completion_procedure (io_configuration, values, field_name, timestep)
	Internal completion, called after the reduce has completed (on root) and calls out to broadcast. More...

subroutine	add_allreduce_information_if_needed (field_name, timestep, root, completion_procedure)
	Adds an all reduce information to the status if it does not exist. More...

type(allreduce_type) function, pointer	find_allreduce_information (field_name, timestep, dolock)
	Finds an all reduce status information based on the field name and timestep, or returns null if none is found. More...

subroutine	remove_allreduce_information (field_name, timestep, dolock)
	Removes an all reduce status information based on the field name and timestep. More...

Variables
logical, volatile	initialised =.false.

integer, volatile	allreduce_rwlock

type(hashmap_type), volatile	allreduce_types

Detailed Description

All reduction, which does a reduce and then broadcasts the data to all IO servers.

Function/Subroutine Documentation

◆ add_allreduce_information_if_needed()

subroutine allreduction_inter_io_mod::add_allreduce_information_if_needed	(	character(len=*), intent(in)	field_name,
		integer, intent(in)	timestep,
		integer, intent(in)	root,
		procedure(handle_completion)	completion_procedure
	)

private

Adds an all reduce information to the status if it does not exist.

Parameters

field_name	The corresponding field name
timestep	The corresponding timestep
root	The root process
completion_procedure	Procedure to call on communication completion

Definition at line 125 of file allreduction-inter-io.F90.

     character(len=*), intent(in) :: field_name
     integer, intent(in) :: timestep, root
     procedure(handle_completion) :: completion_procedure
 
     type(allreduce_type), pointer :: allreduce_information
     class(*), pointer :: generic
 
     allreduce_information=>find_allreduce_information(field_name, timestep, .true.)
     if (.not. associated(allreduce_information)) then
       call check_thread_status(forthread_rwlock_wrlock(allreduce_rwlock))
       allreduce_information=>find_allreduce_information(field_name, timestep, .false.)
       if (.not. associated(allreduce_information)) then
         allocate(allreduce_information)
         allreduce_information%completion_procedure=>completion_procedure
         allreduce_information%root=root
         generic=>allreduce_information
         call c_put_generic(allreduce_types, trim(field_name)//"#"//conv_to_string(timestep), generic, .true.)
       end if
       call check_thread_status(forthread_rwlock_unlock(allreduce_rwlock))
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check_allreduction_inter_io_for_completion()

logical function, public allreduction_inter_io_mod::check_allreduction_inter_io_for_completion ( type(io_configuration_type), intent(inout) io_configuration )

Determines whether this all reduction inter IO functionality has completed or not.

Parameters

io_configuration The IO server configuration

Returns: Whether the inter IO communication has completed or not

Definition at line 64 of file allreduction-inter-io.F90.

     type(io_configuration_type), intent(inout) :: io_configuration
 
     call check_thread_status(forthread_rwlock_rdlock(allreduce_rwlock))
     check_allreduction_inter_io_for_completion=c_is_empty(allreduce_types)
     call check_thread_status(forthread_rwlock_unlock(allreduce_rwlock))

Here is the call graph for this function:

◆ finalise_allreduction_inter_io()

subroutine, public allreduction_inter_io_mod::finalise_allreduction_inter_io ( type(io_configuration_type), intent(inout) io_configuration )

Finalises the all reduction inter IO functionality.

Parameters

io_configuration The IO server configuration

Definition at line 50 of file allreduction-inter-io.F90.

     type(io_configuration_type), intent(inout) :: io_configuration
 
     if (initialised) then
       initialised=.false.
       call check_thread_status(forthread_rwlock_destroy(allreduce_rwlock))
     end if
     call finalise_reduction_inter_io(io_configuration)
     call finalise_broadcast_inter_io()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find_allreduce_information()

type(allreduce_type) function, pointer allreduction_inter_io_mod::find_allreduce_information	(	character(len=*), intent(in)	field_name,
		integer, intent(in)	timestep,
		logical, intent(in)	dolock
	)

private

Finds an all reduce status information based on the field name and timestep, or returns null if none is found.

Parameters

field_name	The corresponding field name
timestep	The corresponding timestep
dolock	Whether to issue a read lock or not

Returns: The corresponding all reduce status or null if none is found

Definition at line 153 of file allreduction-inter-io.F90.

     character(len=*), intent(in) :: field_name
     integer, intent(in) :: timestep
     logical, intent(in) :: dolock
     type(allreduce_type), pointer :: find_allreduce_information
 
     class(*), pointer :: generic
 
     if (dolock) call check_thread_status(forthread_rwlock_rdlock(allreduce_rwlock))
     generic=>c_get_generic(allreduce_types, trim(field_name)//"#"//conv_to_string(timestep))
     if (dolock) call check_thread_status(forthread_rwlock_unlock(allreduce_rwlock))
     
     if (associated(generic)) then
       select type(generic)
         type is (allreduce_type)
           find_allreduce_information=>generic
       end select      
     else
       find_allreduce_information=>null()
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_allreduction_inter_io()

subroutine, public allreduction_inter_io_mod::init_allreduction_inter_io ( type(io_configuration_type), intent(inout) io_configuration )

Initialises the all reduction inter IO functionality.

Parameters

io_configuration The IO server configuration

Definition at line 37 of file allreduction-inter-io.F90.

     type(io_configuration_type), intent(inout) :: io_configuration
 
     if (.not. initialised) then
       initialised=.true.
       call check_thread_status(forthread_rwlock_init(allreduce_rwlock, -1))
     end if
     call init_reduction_inter_io(io_configuration)
     call init_broadcast_inter_io(io_configuration)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internal_reduction_completion_procedure()

subroutine allreduction_inter_io_mod::internal_reduction_completion_procedure	(	type(io_configuration_type), intent(inout)	io_configuration,
		real(default_precision), dimension(:)	values,
		character(len=*)	field_name,
		integer	timestep
	)

private

Internal completion, called after the reduce has completed (on root) and calls out to broadcast.

Parameters

io_configuration	Configuration of the IO server
values	Array of values resulting from the communication
field_name	Corresponding field name
timestep	Corresponding timestep

Definition at line 106 of file allreduction-inter-io.F90.

     type(io_configuration_type), intent(inout) :: io_configuration
     real(DEFAULT_PRECISION), dimension(:) :: values
     character(len=*) :: field_name
     integer :: timestep
 
     type(allreduce_type), pointer :: allreduce_information
 
     allreduce_information=>find_allreduce_information(field_name, timestep, .true.)    
     call perform_inter_io_broadcast(io_configuration, values, size(values), field_name, &
          allreduce_information%root, timestep, allreduce_information%completion_procedure)
     call remove_allreduce_information(field_name, timestep, .true.)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ perform_inter_io_allreduction()

subroutine, public allreduction_inter_io_mod::perform_inter_io_allreduction	(	type(io_configuration_type), intent(inout)	io_configuration,
		real(kind=double_precision), dimension(:)	field_values,
		integer, intent(in)	field_size,
		character(len=*), intent(in)	field_name,
		integer, intent(in)	reduction_op,
		integer, intent(in)	root,
		integer, intent(in)	timestep,
		procedure(handle_completion)	completion_procedure
	)

Performs the all reduction inter IO reduction.

Parameters

io_configuration	Configuration of the IO server
field_values	The values to communicate
field_size	Number of elements to communicate
reduction_field_name	Field name that the reduction will be performed over
reduction_op	The reduction operator to use
root	The root IO server process
timestep	The timestep this is issued at
completion_procedure	Callback completion procedure

Definition at line 82 of file allreduction-inter-io.F90.

     type(io_configuration_type), intent(inout) :: io_configuration
     real(kind=DOUBLE_PRECISION), dimension(:) :: field_values
     integer, intent(in) :: field_size, reduction_op, root, timestep    
     character(len=*), intent(in) :: field_name
     procedure(handle_completion) :: completion_procedure
 
     if (io_configuration%my_io_rank .eq. root) then
       call add_allreduce_information_if_needed(field_name, timestep, root, completion_procedure)
     end if
     call perform_inter_io_reduction(io_configuration, field_values, field_size, field_name, reduction_op, &
        root, timestep, internal_reduction_completion_procedure)
     if (io_configuration%my_io_rank .ne. root) then
       ! None root processes issue a broadcast
       call perform_inter_io_broadcast(io_configuration, field_values, size(field_values), field_name, root, &
            timestep, completion_procedure)
     end if    

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove_allreduce_information()

subroutine allreduction_inter_io_mod::remove_allreduce_information	(	character(len=*), intent(in)	field_name,
		integer, intent(in)	timestep,
		logical, intent(in)	dolock
	)

private

Removes an all reduce status information based on the field name and timestep.

Parameters

field_name	The corresponding field name
timestep	The corresponding timestep
dolock	Whether to issue a write lock or not

Definition at line 179 of file allreduction-inter-io.F90.

     character(len=*), intent(in) :: field_name
     integer, intent(in) :: timestep
     logical, intent(in) :: dolock
 
     if (dolock) call check_thread_status(forthread_rwlock_wrlock(allreduce_rwlock))
     call c_remove(allreduce_types, trim(field_name)//"#"//conv_to_string(timestep))
     if (dolock) call check_thread_status(forthread_rwlock_unlock(allreduce_rwlock))

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ allreduce_rwlock

integer, volatile allreduction_inter_io_mod::allreduce_rwlock

private

Definition at line 27 of file allreduction-inter-io.F90.

27 integer, volatile :: allreduce_rwlock

◆ allreduce_types

type(hashmap_type), volatile allreduction_inter_io_mod::allreduce_types

private

Definition at line 28 of file allreduction-inter-io.F90.

28 type(hashmap_type), volatile :: allreduce_types

◆ initialised

logical, volatile allreduction_inter_io_mod::initialised =.false.

private

Definition at line 25 of file allreduction-inter-io.F90.

25 logical, volatile :: initialised=.false.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ add_allreduce_information_if_needed()

◆ check_allreduction_inter_io_for_completion()

◆ finalise_allreduction_inter_io()

◆ find_allreduce_information()

◆ init_allreduction_inter_io()

◆ internal_reduction_completion_procedure()

◆ perform_inter_io_allreduction()

◆ remove_allreduce_information()

Variable Documentation

◆ allreduce_rwlock

◆ allreduce_types

◆ initialised