xt_mpi.h File Reference

utility routines for MPI More...

#include <mpi.h>
#include "xt/xt_core.h"

Include dependency graph for xt_mpi.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	xt_mpi_call(call, comm)

Functions
void	xt_mpi_error (int error_code, MPI_Comm comm)
MPI_Datatype	xt_mpi_generate_datatype (int const *displacements, int count, MPI_Datatype old_type, MPI_Comm comm)
MPI_Datatype	xt_mpi_generate_datatype_block (const int *displacements, const int *blocklengths, int count, MPI_Datatype old_type, MPI_Comm comm)
MPI_Datatype	xt_mpi_generate_datatype_stripe (const struct Xt_offset_ext *v, int count, MPI_Datatype old_type, MPI_Comm comm)
MPI_Datatype	xt_mpi_generate_datatype_astripe (const struct Xt_aoffset_ext *v, int count, MPI_Datatype old_type, MPI_Comm comm)
void	xt_mpi_comm_mark_exclusive (MPI_Comm comm)

Detailed Description

utility routines for MPI

contains utility routines for handling MPI

Copyright

Copyright (C) 2016 Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Author

Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file xt_mpi.h.

Macro Definition Documentation

xt_mpi_call

#define xt_mpi_call	(		call,
			comm
	)

Value:

  do {                                          \
    int error_code = (call);                    \
    if (error_code != MPI_SUCCESS)              \
      xt_mpi_error(error_code, comm);           \
  } while(0)

check return code of MPI call and call abort function if needed

Examples

rrobin.c, test_ddt.c, test_exchanger_parallel.c, test_idxlist_collection.c, test_idxlist_utils.c, test_idxstripes.c, test_initialized_finalized.c, test_mpi_generate_datatype.c, test_mpi_smartdedup.c, test_redist_collection_parallel.c, test_redist_collection_static_parallel.c, test_redist_common.c, test_redist_p2p_parallel.c, test_redist_repeat_parallel.c, test_redist_single_array_base.c, test_redist_single_array_base_parallel.c, test_request_parallel.c, test_xmap_all2all_fail.c, test_xmap_common_parallel.c, and test_xmap_intersection_parallel.c.

Definition at line 68 of file xt_mpi.h.

Function Documentation

xt_mpi_comm_mark_exclusive()

void xt_mpi_comm_mark_exclusive

(

MPI_Comm

comm

)

Annotate communicator that is for exclusive use by YAXT.

YAXT will trust communicators marked this way to not have active communications other than those initiated by YAXT functions. This is useful to prevent unnecessary MPI_Comm_dup() calls.

Parameters

[in,out]

comm

communicator that will not be used by application code

Definition at line 403 of file xt_mpi.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_mpi_error()

void xt_mpi_error	(	int	error_code,
		MPI_Comm	comm
	)

report error return of MPI call

Parameters

[in]	error_code	return code of an MPI call
[in]	comm	communicator which was used for the respective MPI call

Definition at line 75 of file xt_mpi.c.

xt_mpi_generate_datatype()

MPI_Datatype xt_mpi_generate_datatype	(	int const *	displacements,
		int	count,
		MPI_Datatype	old_type,
		MPI_Comm	comm
	)

generates an MPI datatype

Parameters

[in]	displacements	array of displacements
[in]	count	number of elements
[in]	old_type	base MPI datatype of all elements
[in]	comm	MPI communicator

Returns

MPI datatype for the given data layout

Remarks

the returned datatype needs to be freed by the user (MPI_Type_free)

Examples

test_mpi_generate_datatype.c.

Definition at line 245 of file xt_mpi_ddt_gen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_mpi_generate_datatype_astripe()

MPI_Datatype xt_mpi_generate_datatype_astripe	(	const struct Xt_aoffset_ext *	v,
		int	count,
		MPI_Datatype	old_type,
		MPI_Comm	comm
	)

generates an MPI datatype

Parameters

[in]	v	array of byte displacement, stride and length of sub-vectors
[in]	count	number of sub-vectors
[in]	old_type	base MPI datatype of all elements
[in]	comm	MPI communicator

Returns

MPI datatype for the given data layout

Remarks

the returned datatype needs to be freed by the user (MPI_Type_free)

Here is the call graph for this function:

xt_mpi_generate_datatype_block()

MPI_Datatype xt_mpi_generate_datatype_block	(	const int *	displacements,
		const int *	blocklengths,
		int	count,
		MPI_Datatype	old_type,
		MPI_Comm	comm
	)

generates an MPI datatype

Parameters

[in]	displacements	array of displacements
[in]	blocklengths	array of block sizes
[in]	count	number of blocks
[in]	old_type	base MPI datatype of all elements
[in]	comm	MPI communicator

Returns

MPI datatype for the given data layout

Remarks

the returned datatype needs to be freed by the user (MPI_Type_free)

Examples

test_mpi_generate_datatype.c.

Definition at line 209 of file xt_mpi_ddt_gen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_mpi_generate_datatype_stripe()

MPI_Datatype xt_mpi_generate_datatype_stripe	(	const struct Xt_offset_ext *	v,
		int	count,
		MPI_Datatype	old_type,
		MPI_Comm	comm
	)

generates an MPI datatype

Parameters

[in]	v	array of displacement, stride and length of sub-vectors
[in]	count	number of sub-vectors
[in]	old_type	base MPI datatype of all elements
[in]	comm	MPI communicator

Returns

MPI datatype for the given data layout

Remarks

the returned datatype needs to be freed by the user (MPI_Type_free)