Lockless Inc. MPI_DUP

Lockless Inc
Purchase »
- Linux
- Windows
- Developers
Benchmarks
Installation
Articles
Technical
Downloads
Documentation
What's New
About Us
Help

NAME

MPI_DUP_FN - Helper function to duplicate an attribute

SYNOPSIS

#include <mpi.h> 
int MPI_DUP_FN(MPI_Comm comm , int keyval , void *extra_state , void *attr_in , void *attr_out ,
	 int *flag );

INPUT PARAMETERS

comm - communicator (handle)

keyval - key value (handle)

extra_state - extra user-controlled state (void pointer handle)

attr_in - original attribute (void pointer handle)

OUTPUT PARAMETERS

attr_out - new attribute (void pointer handle)

flag - set to 1 so that new attribute is used (boolean)

DESCRIPTION

The MPI_DUP_FN() function is used as a helper for the MPI_Keyval_create() function. If used as a copy function pointer parameter, it tells MPI_Keyval_create() that the attributes to this key should be copied whenever a communicator is duplicated.

This function copies the void pointer attr_in into the (void pointer to a pointer) attr_out . Note that even though the attr_out parameter's type is void *, it should be viewed as a void **. The other type is chosen to ease use of copy functions and avoid excess type casting.

Once the copy is complete, this function sets flag to one so that the new communicator uses the copied attribute.

extra_state , keyval , and comm are ignored by this function.

There is no profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;