/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
/*
* (C) 2001 by Argonne National Laboratory.
* See COPYRIGHT in top-level directory.
*
* Portions of this code were written by Microsoft. Those portions are
* Copyright (c) 2007 Microsoft Corporation. Microsoft grants
* permission to use, reproduce, prepare derivative works, and to
* redistribute to others. The code is licensed "as is." The User
* bears the risk of using it. Microsoft gives no express warranties,
* guarantees or conditions. To the extent permitted by law, Microsoft
* excludes the implied warranties of merchantability, fitness for a
* particular purpose and non-infringement.
*/
#ifndef MPIIMPL_H_INCLUDED
#define MPIIMPL_H_INCLUDED
/* style: define:vsnprintf:1 sig:0 */
/* style: allow:printf:3 sig:0 */
#include "mpichconfconst.h"
#include "mpichconf.h"
#include <stdio.h>
#ifdef STDC_HEADERS
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#else
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifdef HAVE_STDARG_H
#include <stdarg.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#endif
#ifdef HAVE_LIMITS_H
#include <limits.h>
#endif
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
/* for MAXHOSTNAMELEN under Linux and OSX */
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#if defined (HAVE_USLEEP)
#include <unistd.h>
#if defined (NEEDS_USLEEP_DECL)
int usleep(useconds_t usec);
#endif
#endif
/* if we are defining this, we must define it before including mpl.h */
#if defined(MPICH_DEBUG_MEMINIT)
#define MPL_VG_ENABLED 1
#endif
#include "mpl.h"
#include "opa_primitives.h"
#include "mpi.h"
#include "mpiutil.h"
#include "mpidpre.h"
#if defined(HAVE_LONG_LONG_INT)
/* tt#1776: some platforms have "long long" but not a LLONG_MAX/ULLONG_MAX,
* usually because some feature test macro has turned them off in glibc's
* features.h header b/c we are not in a >=C99 mode. Use well-defined unsigned
* integer overflow to determine ULLONG_MAX, and assume two's complement for
* determining LLONG_MAX (already assumed elsewhere in MPICH). */
#ifndef ULLONG_MIN
#define ULLONG_MIN (0) /* trivial */
#endif
#ifndef ULLONG_MAX
#define ULLONG_MAX ((unsigned long long)0 - 1)
#endif
#ifndef LLONG_MAX
/* slightly tricky (values in binary):
* - put a 1 in the second-to-msb digit (0100...0000)
* - sub 1, giving all 1s starting at third-to-msb digit (0011...1111)
* - shift left 1 (0111...1110)
* - add 1, yielding all 1s in positive space (0111...1111) */
#define LLONG_MAX (((((long long) 1 << (sizeof(long long) * CHAR_BIT - 2)) - 1 ) << 1) + 1)
#endif
#ifndef LLONG_MIN
/* (1000...0000) is the most negative value in a twos-complement representation,
* which is the bitwise complement of the most positive value */
#define LLONG_MIN (~LLONG_MAX)
#endif
#endif /* defined(HAVE_LONG_LONG_INT) */
#if (!defined MAXHOSTNAMELEN) && (!defined MAX_HOSTNAME_LEN)
#define MAX_HOSTNAME_LEN 256
#elif !defined MAX_HOSTNAME_LEN
#define MAX_HOSTNAME_LEN MAXHOSTNAMELEN
#endif
/* This allows us to keep names local to a single file when we can use
weak symbols */
#ifdef USE_WEAK_SYMBOLS
#define PMPI_LOCAL static
#else
#define PMPI_LOCAL
#endif
/* Fix for universal endianess added in autoconf 2.62 */
#ifdef WORDS_UNIVERSAL_ENDIAN
#if defined(__BIG_ENDIAN__)
#elif defined(__LITTLE_ENDIAN__)
#define WORDS_LITTLEENDIAN
#else
#error 'Universal endianess defined without __BIG_ENDIAN__ or __LITTLE_ENDIAN__'
#endif
#endif
#include "mpir_type_defs.h"
/* Overriding memcpy:
This is a utility function for memory copy. The device might use
this directly or override it with a different device-specific
mechanism to provide an MPID_Memcpy function. However, we
currently do not provide such an ADI function.
*/
#ifndef MPIU_Memcpy
#define MPIU_Memcpy(dst, src, len) \
do { \
MPIU_MEM_CHECK_MEMCPY((dst),(src),(len)); \
memcpy((dst), (src), (len)); \
} while (0)
#endif
/* ------------------------------------------------------------------------- */
/* mpidebug.h */
/* ------------------------------------------------------------------------- */
/* Debugging and printf control */
/* Use these *only* for debugging output intended for the implementors
and maintainers of MPICH. Do *not* use these for any output that
general users may normally see. Use either the error code creation
routines for error messages or MPIU_msg_printf etc. for general messages
(MPIU_msg_printf will go through gettext).
FIXME: Document all of these macros
NOTE: These macros and values are deprecated. See
www.mcs.anl.gov/mpi/mpich/developer/design/debugmsg.htm for
the new design (only partially implemented at this time).
The implementation is in mpidbg.h
*/
#include "mpidbg.h"
#if defined(MPICH_DBG_OUTPUT)
#define MPIU_DBG_PRINTF(e) \
{ \
if (MPIU_dbg_state != MPIU_DBG_STATE_NONE) \
{ \
MPIU_dbg_printf e; \
} \
}
/* The first argument is a place holder to allow the selection of a subset
of debugging events. The second is a placeholder to allow a numeric
level of debugging within that class. The third is the debugging text */
#define MPIU_DBG_PRINTF_CLASS(_c,_l,_e) MPIU_DBG_PRINTF(_e)
#else
#define MPIU_DBG_PRINTF(e)
#define MPIU_DBG_PRINTF_CLASS(_c,_l,_e)
#endif
/* The follow is temporarily provided for backward compatibility. Any code
using dbg_printf should be updated to use MPIU_DBG_PRINTF. */
#define dbg_printf MPIU_dbg_printf
/* ------------------------------------------------------------------------- */
/* end of mpidebug.h */
/* ------------------------------------------------------------------------- */
/* Routines for memory management */
#include "mpimem.h"
#if defined HAVE_LIBHCOLL
#include "../mpid/common/hcoll/hcollpre.h"
#endif
/*
* Use MPIU_SYSCALL to wrap system calls; this provides a convenient point
* for timing the calls and keeping track of the use of system calls.
* This macro simply invokes the system call and does not even handle
* EINTR.
* To use,
* MPIU_SYSCALL( return-value, name-of-call, args-in-parenthesis )
* e.g., change "n = read(fd,buf,maxn);" into
* MPIU_SYSCALL( n,read,(fd,buf,maxn) );
* An example that prints each syscall to stdout is shown below.
*/
#ifdef USE_LOG_SYSCALLS
#define MPIU_SYSCALL(a_,b_,c_) { \
printf( "[%d]about to call %s\n", MPIR_Process.comm_world->rank,#b_);\
fflush(stdout); errno = 0;\
a_ = b_ c_; \
if ((a_)>=0 || errno==0) {\
printf( "[%d]%s returned %d\n", \
MPIR_Process.comm_world->rank, #b_, a_ );\
} \
else { \
printf( "[%d]%s returned %d (errno = %d,%s)\n", \
MPIR_Process.comm_world->rank, \
#b_, a_, errno, MPIU_Strerror(errno));\
}; fflush(stdout);}
#else
#define MPIU_SYSCALL(a_,b_,c_) a_ = b_ c_
#endif
/*TDSOverview.tex
MPI has a number of data structures, most of which are represented by
an opaque handle in an MPI program. In the MPICH implementation of MPI,
these handles are represented
as integers; this makes implementation of the C/Fortran handle transfer
calls (part of MPI-2) easy.
MPID objects (again with the possible exception of 'MPI_Request's)
are allocated by a common set of object allocation functions.
These are
.vb
void *MPIU_Handle_obj_create( MPIU_Object_alloc_t *objmem )
void MPIU_Handle_obj_destroy( MPIU_Object_alloc_t *objmem, void *object )
.ve
where 'objmem' is a pointer to a memory allocation object that knows
enough to allocate objects, including the
size of the object and the location of preallocated memory, as well
as the type of memory allocator. By providing the routines to allocate and
free the memory, we make it easy to use the same interface to allocate both
local and shared memory for objects (always using the same kind for each
type of object).
The names create/destroy were chosen because they are different from
new/delete (C++ operations) and malloc/free.
Any name choice will have some conflicts with other uses, of course.
Reference Counts:
Many MPI objects have reference count semantics.
The semantics of MPI require that many objects that have been freed by the
user
(e.g., with 'MPI_Type_free' or 'MPI_Comm_free') remain valid until all
pending
references to that object (e.g., by an 'MPI_Irecv') are complete. There
are several ways to implement this; MPICH uses `reference counts` in the
objects. To support the 'MPI_THREAD_MULTIPLE' level of thread-safety, these
reference counts must be accessed and updated atomically.
A reference count for
`any` object can be incremented (atomically)
with 'MPIU_Object_add_ref(objptr)'
and decremented with 'MPIU_Object_release_ref(objptr,newval_ptr)'.
These have been designed so that then can be implemented as inlined
macros rather than function calls, even in the multithreaded case, and
can use special processor instructions that guarantee atomicity to
avoid thread locks.
The decrement routine sets the value pointed at by 'inuse_ptr' to 0 if
the postdecrement value of the reference counter is zero, and to a non-zero
value otherwise. If this value is zero, then the routine that decremented
the
reference count should free the object. This may be as simple as
calling 'MPIU_Handle_obj_destroy' (for simple objects with no other allocated
storage) or may require calling a separate routine to destroy the object.
Because MPI uses 'MPI_xxx_free' to both decrement the reference count and
free the object if the reference count is zero, we avoid the use of 'free'
in the MPID routines.
The 'inuse_ptr' approach is used rather than requiring the post-decrement
value because, for reference-count semantics, all that is necessary is
to know when the reference count reaches zero, and this can sometimes
be implemented more cheaply that requiring the post-decrement value (e.g.,
on IA32, there is an instruction for this operation).
Question:
Should we state that this is a macro so that we can use a register for
the output value? That avoids a store. Alternately, have the macro
return the value as if it was a function?
Structure Definitions:
The structure definitions in this document define `only` that part of
a structure that may be used by code that is making use of the ADI.
Thus, some structures, such as 'MPID_Comm', have many defined fields;
these are used to support MPI routines such as 'MPI_Comm_size' and
'MPI_Comm_remote_group'. Other structures may have few or no defined
members; these structures have no fields used outside of the ADI.
In C++ terms, all members of these structures are 'private'.
For the initial implementation, we expect that the structure definitions
will be designed for the multimethod device. However, all items that are
specific to a particular device (including the multi-method device)
will be placed at the end of the structure;
the document will clearly identify the members that all implementations
will provide. This simplifies much of the code in both the ADI and the
implementation of the MPI routines because structure member can be directly
accessed rather than using some macro or C++ style method interface.
T*/
/* mpi_lang.h - Prototypes for language specific routines. Currently used to
* set keyval attribute callbacks
*/
#include "mpi_lang.h"
/* Known language bindings */
/*E
MPID_Lang_t - Known language bindings for MPI
A few operations in MPI need to know what language they were called from
or created by. This type enumerates the possible languages so that
the MPI implementation can choose the correct behavior. An example of this
are the keyval attribute copy and delete functions.
Module:
Attribute-DS
E*/
typedef enum MPID_Lang_t { MPID_LANG_C
#ifdef HAVE_FORTRAN_BINDING
, MPID_LANG_FORTRAN
, MPID_LANG_FORTRAN90
#endif
#ifdef HAVE_CXX_BINDING
, MPID_LANG_CXX
#endif
} MPID_Lang_t;
/* Macros for the MPI handles (e.g., the object that encodes an
MPI_Datatype) */
#include "mpihandlemem.h"
/* This routine is used to install an attribute free routine for datatypes
at finalize-time */
void MPIR_DatatypeAttrFinalize( void );
/* ------------------------------------------------------------------------- */
/* Should the following be moved into mpihandlemem.h ?*/
/* ------------------------------------------------------------------------- */
/* Routines to initialize handle allocations */
/* These are now internal to the handlemem package
void *MPIU_Handle_direct_init( void *, int, int, int );
void *MPIU_Handle_indirect_init( void *(**)[], int *, int, int, int, int );
int MPIU_Handle_free( void *((*)[]), int );
*/
/* Convert Handles to objects for MPI types that have predefined objects */
/* TODO examine generated assembly for this construct, it's probably suboptimal
* on Blue Gene. An if/else if/else might help the compiler out. It also lets
* us hint that one case is likely(), usually the BUILTIN case. */
#define MPID_Getb_ptr(kind,a,bmsk,ptr) \
{ \
switch (HANDLE_GET_KIND(a)) { \
case HANDLE_KIND_BUILTIN: \
ptr=MPID_##kind##_builtin+((a)&(bmsk)); \
break; \
case HANDLE_KIND_DIRECT: \
ptr=MPID_##kind##_direct+HANDLE_INDEX(a); \
break; \
case HANDLE_KIND_INDIRECT: \
ptr=((MPID_##kind*) \
MPIU_Handle_get_ptr_indirect(a,&MPID_##kind##_mem)); \
break; \
case HANDLE_KIND_INVALID: \
default: \
ptr=0; \
break; \
} \
}
/* Convert handles to objects for MPI types that do _not_ have any predefined
objects */
#define MPID_Get_ptr(kind,a,ptr) \
{ \
switch (HANDLE_GET_KIND(a)) { \
case HANDLE_KIND_DIRECT: \
ptr=MPID_##kind##_direct+HANDLE_INDEX(a); \
break; \
case HANDLE_KIND_INDIRECT: \
ptr=((MPID_##kind*) \
MPIU_Handle_get_ptr_indirect(a,&MPID_##kind##_mem)); \
break; \
case HANDLE_KIND_INVALID: \
case HANDLE_KIND_BUILTIN: \
default: \
ptr=0; \
break; \
} \
}
/* FIXME: the masks should be defined with the handle definitions instead
of inserted here as literals */
#define MPID_Comm_get_ptr(a,ptr) MPID_Getb_ptr(Comm,a,0x03ffffff,ptr)
#define MPID_Group_get_ptr(a,ptr) MPID_Getb_ptr(Group,a,0x03ffffff,ptr)
#define MPID_File_get_ptr(a,ptr) MPID_Get_ptr(File,a,ptr)
#define MPID_Errhandler_get_ptr(a,ptr) MPID_Getb_ptr(Errhandler,a,0x3,ptr)
#define MPID_Op_get_ptr(a,ptr) MPID_Getb_ptr(Op,a,0x000000ff,ptr)
#define MPID_Info_get_ptr(a,ptr) MPID_Getb_ptr(Info,a,0x03ffffff,ptr)
#define MPID_Win_get_ptr(a,ptr) MPID_Get_ptr(Win,a,ptr)
#define MPID_Request_get_ptr(a,ptr) MPID_Get_ptr(Request,a,ptr)
#define MPID_Grequest_class_get_ptr(a,ptr) MPID_Get_ptr(Grequest_class,a,ptr)
/* Keyvals have a special format. This is roughly MPID_Get_ptrb, but
the handle index is in a smaller bit field. In addition,
there is no storage for the builtin keyvals.
For the indirect case, we mask off the part of the keyval that is
in the bits normally used for the indirect block index.
*/
#define MPID_Keyval_get_ptr(a,ptr) \
{ \
switch (HANDLE_GET_KIND(a)) { \
case HANDLE_KIND_BUILTIN: \
ptr=0; \
break; \
case HANDLE_KIND_DIRECT: \
ptr=MPID_Keyval_direct+((a)&0x3fffff); \
break; \
case HANDLE_KIND_INDIRECT: \
ptr=((MPID_Keyval*) \
MPIU_Handle_get_ptr_indirect((a)&0xfc3fffff,&MPID_Keyval_mem)); \
break; \
case HANDLE_KIND_INVALID: \
default: \
ptr=0; \
break; \
} \
}
/* Valid pointer checks */
/* This test is lame. Should eventually include cookie test
and in-range addresses */
#define MPID_Valid_ptr(kind,ptr,err) \
{if (!(ptr)) { err = MPIR_Err_create_code( MPI_SUCCESS, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER, \
"**nullptrtype", "**nullptrtype %s", #kind ); } }
#define MPID_Valid_ptr_class(kind,ptr,errclass,err) \
{if (!(ptr)) { err = MPIR_Err_create_code( MPI_SUCCESS, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, errclass, \
"**nullptrtype", "**nullptrtype %s", #kind ); } }
#define MPID_Info_valid_ptr(ptr,err) MPID_Valid_ptr_class(Info,ptr,MPI_ERR_INFO,err)
/* Check not only for a null pointer but for an invalid communicator,
such as one that has been freed. Let's try the ref_count as the test
for now */
/* ticket #1441: check (refcount<=0) to cover the case of 0, an "over-free" of
* -1 or similar, and the 0xecec... case when --enable-g=mem is used */
#define MPID_Comm_valid_ptr(ptr,err,ignore_rev) { \
MPID_Valid_ptr_class(Comm,ptr,MPI_ERR_COMM,err); \
if ((ptr) && MPIU_Object_get_ref(ptr) <= 0) { \
MPIR_ERR_SET(err,MPI_ERR_COMM,"**comm"); \
ptr = 0; \
} else if ((ptr) && (ptr)->revoked && !(ignore_rev)) { \
MPIR_ERR_SET(err,MPIX_ERR_REVOKED,"**comm"); \
} \
}
#define MPID_Group_valid_ptr(ptr,err) MPID_Valid_ptr_class(Group,ptr,MPI_ERR_GROUP,err)
#define MPID_Win_valid_ptr(ptr,err) MPID_Valid_ptr_class(Win,ptr,MPI_ERR_WIN,err)
#define MPID_Op_valid_ptr(ptr,err) MPID_Valid_ptr_class(Op,ptr,MPI_ERR_OP,err)
#define MPID_Errhandler_valid_ptr(ptr,err) MPID_Valid_ptr_class(Errhandler,ptr,MPI_ERR_ARG,err)
#define MPID_File_valid_ptr(ptr,err) MPID_Valid_ptr_class(File,ptr,MPI_ERR_FILE,err)
#define MPID_Request_valid_ptr(ptr,err) MPID_Valid_ptr_class(Request,ptr,MPI_ERR_REQUEST,err)
#define MPID_Keyval_valid_ptr(ptr,err) MPID_Valid_ptr_class(Keyval,ptr,MPI_ERR_KEYVAL,err)
#define MPIR_DATATYPE_IS_PREDEFINED(type) \
((HANDLE_GET_KIND(type) == HANDLE_KIND_BUILTIN) || \
(type == MPI_FLOAT_INT) || (type == MPI_DOUBLE_INT) || \
(type == MPI_LONG_INT) || (type == MPI_SHORT_INT) || \
(type == MPI_LONG_DOUBLE_INT))
/* FIXME:
Generic pointer test. This is applied to any address, not just one from
an MPI object.
Currently unimplemented (returns success except for null pointers.
With a little work, could check that the pointer is properly aligned,
using something like
((p) == 0 || ((char *)(p) & MPID_Alignbits[alignment] != 0)
where MPID_Alignbits is set with a mask whose bits must be zero in a
properly aligned quantity. For systems with no alignment rules,
all of these masks are zero, and this part of test can be eliminated.
*/
#define MPID_Pointer_is_invalid(p,alignment) ((p) == 0)
/* Fixme: The following MPID_ALIGNED_xxx values are temporary. They
need to be computed by configure and included in the mpichconf.h file.
Note that they cannot be set conservatively (i.e., as sizeof(object)),
since the runtime system may generate objects with lesser alignment
rules if the processor allows them.
*/
#define MPID_ALIGNED_PTR_INT 1
#define MPID_ALIGNED_PTR_LONG 1
#define MPID_ALIGNED_PTR_VOIDP 1
/* ------------------------------------------------------------------------- */
/* end of code that should the following be moved into mpihandlemem.h ?*/
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* Info */
/*TInfoOverview.tex
'MPI_Info' provides a way to create a list of '(key,value)' pairs
where the 'key' and 'value' are both strings. Because many routines, both
in the MPI implementation and in related APIs such as the PMI process
management interface, require 'MPI_Info' arguments, we define a simple
structure for each 'MPI_Info' element. Elements are allocated by the
generic object allocator; the head element is always empty (no 'key'
or 'value' is defined on the head element).
For simplicity, we have not abstracted the info data structures;
routines that want to work with the linked list may do so directly.
Because the 'MPI_Info' type is a handle and not a pointer, an MPIU
(utility) routine is provided to handle the
deallocation of 'MPID_Info' elements. See the implementation of
'MPI_Info_create' for how an Info type is allocated.
Thread Safety:
The info interface itself is not thread-robust. In particular, the routines
'MPI_INFO_GET_NKEYS' and 'MPI_INFO_GET_NTHKEY' assume that no other
thread modifies the info key. (If the info routines had the concept
of a next value, they would not be thread safe. As it stands, a user
must be careful if several threads have access to the same info object.)
Further, 'MPI_INFO_DUP', while not
explicitly advising implementers to be careful of one thread modifying the
'MPI_Info' structure while 'MPI_INFO_DUP' is copying it, requires that the
operation take place in a thread-safe manner.
There isn'' much that we can do about these cases. There are other cases
that must be handled. In particular, multiple threads are allowed to
update the same info value. Thus, all of the update routines must be thread
safe; the simple implementation used in the MPICH implementation uses locks.
Note that the 'MPI_Info_delete' call does not need a lock; the defintion of
thread-safety means that any order of the calls functions correctly; since
it invalid either to delete the same 'MPI_Info' twice or to modify an
'MPI_Info' that has been deleted, only one thread at a time can call
'MPI_Info_free' on any particular 'MPI_Info' value.
T*/
/*S
MPID_Info - Structure of an MPID info
Notes:
There is no reference count because 'MPI_Info' values, unlike other MPI
objects, may be changed after they are passed to a routine without
changing the routine''s behavior. In other words, any routine that uses
an 'MPI_Info' object must make a copy or otherwise act on any info value
that it needs.
A linked list is used because the typical 'MPI_Info' list will be short
and a simple linked list is easy to implement and to maintain. Similarly,
a single structure rather than separate header and element structures are
defined for simplicity. No separate thread lock is provided because
info routines are not performance critical; they may use the single
critical section lock in the 'MPIR_Process' structure when they need a
thread lock.
This particular form of linked list (in particular, with this particular
choice of the first two members) is used because it allows us to use
the same routines to manage this list as are used to manage the
list of free objects (in the file 'src/util/mem/handlemem.c'). In
particular, if lock-free routines for updating a linked list are
provided, they can be used for managing the 'MPID_Info' structure as well.
The MPI standard requires that keys can be no less that 32 characters and
no more than 255 characters. There is no mandated limit on the size
of values.
Module:
Info-DS
S*/
typedef struct MPID_Info {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
struct MPID_Info *next;
char *key;
char *value;
} MPID_Info;
extern MPIU_Object_alloc_t MPID_Info_mem;
/* Preallocated info objects */
#define MPID_INFO_N_BUILTIN 2
extern MPID_Info MPID_Info_builtin[MPID_INFO_N_BUILTIN];
extern MPID_Info MPID_Info_direct[];
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* Error Handlers */
/*E
MPID_Errhandler_fn - MPID Structure to hold an error handler function
Notes:
The MPI-1 Standard declared only the C version of this, implicitly
assuming that 'int' and 'MPI_Fint' were the same.
Since Fortran does not have a C-style variable number of arguments
interface, the Fortran interface simply accepts two arguments. Some
calling conventions for Fortran (particularly under Windows) require
this.
Module:
ErrHand-DS
Questions:
What do we want to do about C++? Do we want a hook for a routine that can
be called to throw an exception in C++, particularly if we give C++ access
to this structure? Does the C++ handler need to be different (not part
of the union)?
E*/
typedef union MPID_Errhandler_fn {
void (*C_Comm_Handler_function) ( MPI_Comm *, int *, ... );
void (*F77_Handler_function) ( MPI_Fint *, MPI_Fint * );
void (*C_Win_Handler_function) ( MPI_Win *, int *, ... );
void (*C_File_Handler_function) ( MPI_File *, int *, ... );
} MPID_Errhandler_fn;
/*S
MPID_Errhandler - Description of the error handler structure
Notes:
Device-specific information may indicate whether the error handler is active;
this can help prevent infinite recursion in error handlers caused by
user-error without requiring the user to be as careful. We might want to
make this part of the interface so that the 'MPI_xxx_call_errhandler'
routines would check.
It is useful to have a way to indicate that the errhandler is no longer
valid, to help catch the case where the user has freed the errhandler but
is still using a copy of the 'MPI_Errhandler' value. We may want to
define the 'id' value for deleted errhandlers.
Module:
ErrHand-DS
S*/
typedef struct MPID_Errhandler {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Lang_t language;
MPID_Object_kind kind;
MPID_Errhandler_fn errfn;
/* Other, device-specific information */
#ifdef MPID_DEV_ERRHANDLER_DECL
MPID_DEV_ERRHANDLER_DECL
#endif
} MPID_Errhandler;
extern MPIU_Object_alloc_t MPID_Errhandler_mem;
/* Preallocated errhandler objects */
extern MPID_Errhandler MPID_Errhandler_builtin[];
extern MPID_Errhandler MPID_Errhandler_direct[];
/* We never reference count the builtin error handler objects, regardless of how
* we decide to reference count the other predefined objects. If we get to the
* point where we never reference count *any* of the builtin objects then we
* should probably remove these checks and let them fall through to the checks
* for BUILTIN down in the MPIU_Object_* routines. */
#define MPIR_Errhandler_add_ref( _errhand ) \
do { \
if (HANDLE_GET_KIND((_errhand)->handle) != HANDLE_KIND_BUILTIN) { \
MPIU_Object_add_ref( _errhand ); \
} \
} while (0)
#define MPIR_Errhandler_release_ref( _errhand, _inuse ) \
do { \
if (HANDLE_GET_KIND((_errhand)->handle) != HANDLE_KIND_BUILTIN) { \
MPIU_Object_release_ref( (_errhand), (_inuse) ); \
} \
else { \
*(_inuse) = 1; \
} \
} while (0)
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* Keyvals and attributes */
/*TKyOverview.tex
Keyvals are MPI objects that, unlike most MPI objects, are defined to be
integers rather than a handle (e.g., 'MPI_Comm'). However, they really
`are` MPI opaque objects and are handled by the MPICH implementation in
the same way as all other MPI opaque objects. The only difference is that
there is no 'typedef int MPI_Keyval;' in 'mpi.h'. In particular, keyvals
are encoded (for direct and indirect references) in the same way that
other MPI opaque objects are
Each keyval has a copy and a delete function associated with it.
Unfortunately, these have a slightly different calling sequence for
each language, particularly when the size of a pointer is
different from the size of a Fortran integer. The unions
'MPID_Copy_function' and 'MPID_Delete_function' capture the differences
in a single union type.
The above comment is out of date but has never been updated as it should
have to match the introduction of a different interface. Beware!
Notes:
In the original design, retrieving a attribute from a different
language that set it was thought to be an error. The MPI Forum
decided that this should be allowed, and after much discussion, the
behavior was defined. Thus, we need to record what sort of
attribute was provided, and be able to properly return the correct
value in each case. See MPI 2.2, Section 16.3.7 (Attributes) for
specific requirements. One consequence of this is that the value
that is returned may have a different length that how it was set.
On little-endian platforms (e.g., x86), this doesn't cause much of a
problem, because the address is that of the least significant byte,
and the lower bytes have the data that is needed in the case that
the desired attribute type is shorter than the stored attribute.
However, on a big-endian platform (e.g., IBM POWER), since the most
significant bytes are stored first, depending on the length of the
result type, the address of the result may not be the beginning of
the memory area. For example, assume that an MPI_Fint is 4 bytes
and a void * (and a Fortran INTEGER of kind MPI_ADDRESS_KIND) is 8
bytes, and let the attribute store the value in an 8 byte integer in
a field named "value". On a little-endian platform, the address of
the value is always the beginning of the field "value". On a
big-endian platform, the address of the value is the beginning of
the field if the return type is a pointer (e.g., from C) or Fortran
(KIND=MPI_ADDRESS_KIND), and the address of the beginning of the
field + 4 if the return type is a Fortran 77 integer (and, as
specified above, an MPI_Fint is 4 bytes shorter than a void *).
For the big-endian case, it is possible to manage these shifts (using
WORDS_LITTLEENDIAN to detect the big-endian case). Alternatively,
at a small cost in space, copies in variables of the correct length
can be maintained. At this writing, the code in src/mpi/attr makes
use of WORDS_LITTLEENDIAN to provide the appropriate code for the most
common cases.
T*/
/*TAttrOverview.tex
*
* The MPI standard allows `attributes`, essentially an '(integer,pointer)'
* pair, to be attached to communicators, windows, and datatypes.
* The integer is a `keyval`, which is allocated by a call (at the MPI level)
* to 'MPI_Comm/Type/Win_create_keyval'. The pointer is the value of
* the attribute.
* Attributes are primarily intended for use by the user, for example, to save
* information on a communicator, but can also be used to pass data to the
* MPI implementation. For example, an attribute may be used to pass
* Quality of Service information to an implementation to be used with
* communication on a particular communicator.
* To provide the most general access by the ADI to all attributes, the
* ADI defines a collection of routines that are used by the implementation
* of the MPI attribute routines (such as 'MPI_Comm_get_attr').
* In addition, the MPI routines involving attributes will invoke the
* corresponding 'hook' functions (e.g., 'MPID_Dev_comm_attr_set_hook')
* should the device define them.
*
* Attributes on windows and datatypes are defined by MPI but not of
* interest (as yet) to the device.
*
* In addition, there are seven predefined attributes that the device must
* supply to the implementation. This is accomplished through
* data values that are part of the 'MPIR_Process' data block.
* The predefined keyvals on 'MPI_COMM_WORLD' are\:
*.vb
* Keyval Related Module
* MPI_APPNUM Dynamic
* MPI_HOST Core
* MPI_IO Core
* MPI_LASTUSEDCODE Error
* MPI_TAG_UB Communication
* MPI_UNIVERSE_SIZE Dynamic
* MPI_WTIME_IS_GLOBAL Timer
*.ve
* The values stored in the 'MPIR_Process' block are the actual values. For
* example, the value of 'MPI_TAG_UB' is the integer value of the largest tag.
* The
* value of 'MPI_WTIME_IS_GLOBAL' is a '1' for true and '0' for false. Likely
* values for 'MPI_IO' and 'MPI_HOST' are 'MPI_ANY_SOURCE' and 'MPI_PROC_NULL'
* respectively.
*
T*/
/* Include the attribute access routines that permit access to the
attribute or its pointer, needed for cross-language access to attributes */
#include "mpi_attr.h"
/* Because Comm, Datatype, and File handles are all ints, and because
attributes are otherwise identical between the three types, we
only store generic copy and delete functions. This allows us to use
common code for the attribute set, delete, and dup functions */
/*E
MPID_Copy_function - MPID Structure to hold an attribute copy function
Notes:
The appropriate element of this union is selected by using the language
field of the 'keyval'.
Because 'MPI_Comm', 'MPI_Win', and 'MPI_Datatype' are all 'int's in
MPICH, we use a single C copy function rather than have separate
ones for the Communicator, Window, and Datatype attributes.
There are no corresponding typedefs for the Fortran functions. The
F77 function corresponds to the Fortran 77 binding used in MPI-1 and the
F90 function corresponds to the Fortran 90 binding used in MPI-2.
Module:
Attribute-DS
E*/
int
MPIR_Attr_copy_c_proxy(
MPI_Comm_copy_attr_function* user_function,
int handle,
int keyval,
void* extra_state,
MPIR_AttrType attrib_type,
void* attrib,
void** attrib_copy,
int* flag
);
typedef struct MPID_Copy_function {
int (*C_CopyFunction)( int, int, void *, void *, void *, int * );
void (*F77_CopyFunction) ( MPI_Fint *, MPI_Fint *, MPI_Fint *, MPI_Fint *,
MPI_Fint *, MPI_Fint *, MPI_Fint * );
void (*F90_CopyFunction) ( MPI_Fint *, MPI_Fint *, MPI_Aint *, MPI_Aint *,
MPI_Aint *, MPI_Fint *, MPI_Fint * );
/* The generic lang-independent user_function and proxy will
* replace the lang dependent copy funcs above
* Currently the lang-indpendent funcs are used only for keyvals
*/
MPI_Comm_copy_attr_function *user_function;
MPID_Attr_copy_proxy *proxy;
/* The C++ function is the same as the C function */
} MPID_Copy_function;
/*E
MPID_Delete_function - MPID Structure to hold an attribute delete function
Notes:
The appropriate element of this union is selected by using the language
field of the 'keyval'.
Because 'MPI_Comm', 'MPI_Win', and 'MPI_Datatype' are all 'int's in
MPICH, we use a single C delete function rather than have separate
ones for the Communicator, Window, and Datatype attributes.
There are no corresponding typedefs for the Fortran functions. The
F77 function corresponds to the Fortran 77 binding used in MPI-1 and the
F90 function corresponds to the Fortran 90 binding used in MPI-2.
Module:
Attribute-DS
E*/
int
MPIR_Attr_delete_c_proxy(
MPI_Comm_delete_attr_function* user_function,
int handle,
int keyval,
MPIR_AttrType attrib_type,
void* attrib,
void* extra_state
);
typedef struct MPID_Delete_function {
int (*C_DeleteFunction) ( int, int, void *, void * );
void (*F77_DeleteFunction)( MPI_Fint *, MPI_Fint *, MPI_Fint *, MPI_Fint *,
MPI_Fint * );
void (*F90_DeleteFunction)( MPI_Fint *, MPI_Fint *, MPI_Aint *, MPI_Aint *,
MPI_Fint * );
/* The generic lang-independent user_function and proxy will
* replace the lang dependent copy funcs above
* Currently the lang-indpendent funcs are used only for keyvals
*/
MPI_Comm_delete_attr_function *user_function;
MPID_Attr_delete_proxy *proxy;
} MPID_Delete_function;
/*S
MPID_Keyval - Structure of an MPID keyval
Module:
Attribute-DS
S*/
typedef struct MPID_Keyval {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Object_kind kind;
int was_freed;
void *extra_state;
MPID_Copy_function copyfn;
MPID_Delete_function delfn;
/* other, device-specific information */
#ifdef MPID_DEV_KEYVAL_DECL
MPID_DEV_KEYVAL_DECL
#endif
} MPID_Keyval;
#define MPIR_Keyval_add_ref( _keyval ) \
do { \
MPIU_Object_add_ref( _keyval ); \
} while(0)
#define MPIR_Keyval_release_ref( _keyval, _inuse ) \
do { \
MPIU_Object_release_ref( _keyval, _inuse ); \
} while(0)
/* Attribute values in C/C++ are void * and in Fortran are ADDRESS_SIZED
integers. Normally, these are the same size, but in at least one
case, the address-sized integers was selected as longer than void *
to work with the datatype code used in the I/O library. While this
is really a limitation in the current Datatype implementation. */
#ifdef USE_AINT_FOR_ATTRVAL
typedef MPI_Aint MPID_AttrVal_t;
#else
typedef void * MPID_AttrVal_t;
#endif
/* Attributes need no ref count or handle, but since we want to use the
common block allocator for them, we must provide those elements
*/
/*S
MPID_Attribute - Structure of an MPID attribute
Notes:
Attributes don''t have 'ref_count's because they don''t have reference
count semantics. That is, there are no shallow copies or duplicates
of an attibute. An attribute is copied when the communicator that
it is attached to is duplicated. Subsequent operations, such as
'MPI_Comm_attr_free', can change the attribute list for one of the
communicators but not the other, making it impractical to keep the
same list. (We could defer making the copy until the list is changed,
but even then, there would be no reference count on the individual
attributes.)
A pointer to the keyval, rather than the (integer) keyval itself is
used since there is no need within the attribute structure to make
it any harder to find the keyval structure.
The attribute value is a 'void *'. If 'sizeof(MPI_Fint)' > 'sizeof(void*)',
then this must be changed (no such system has been encountered yet).
For the Fortran 77 routines in the case where 'sizeof(MPI_Fint)' <
'sizeof(void*)', the high end of the 'void *' value is used. That is,
we cast it to 'MPI_Fint *' and use that value.
MPI defines three kinds of attributes (see MPI 2.1, Section 16.3, pages
487-488 (the standard says two, but there are really three, as discussed
below). These are pointer-valued attributes and two types of integer-valued
attributes.
Pointer-valued attributes are used in C.
Integer-valued attributes are used in Fortran. These are of type either
INTEGER or INTEGER(KIND=MPI_ADDRESS_KIND).
The predefined attributes are a combination of INTEGER and pointers.
Module:
Attribute-DS
S*/
typedef struct MPID_Attribute {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Keyval *keyval; /* Keyval structure for this attribute */
struct MPID_Attribute *next; /* Pointer to next in the list */
MPIR_AttrType attrType; /* Type of the attribute */
long pre_sentinal; /* Used to detect user errors in accessing
the value */
MPID_AttrVal_t value; /* Stored value. An Aint must be at least
as large as an address - some builds
may make an Aint larger than a void * */
long post_sentinal; /* Like pre_sentinal */
/* other, device-specific information */
#ifdef MPID_DEV_ATTR_DECL
MPID_DEV_ATTR_DECL
#endif
} MPID_Attribute;
/* ------------------------------------------------------------------------- */
/*---------------------------------------------------------------------------
* Groups are *not* a major data structure in MPICH-2. They are provided
* only because they are required for the group operations (e.g.,
* MPI_Group_intersection) and for the scalable RMA synchronization
*---------------------------------------------------------------------------*/
/* This structure is used to implement the group operations such as
MPI_Group_translate_ranks */
typedef struct MPID_Group_pmap_t {
int lpid; /* local process id, from VCONN */
int next_lpid; /* Index of next lpid (in lpid order) */
int flag; /* marker, used to implement group operations */
} MPID_Group_pmap_t;
/* Any changes in the MPID_Group structure must be made to the
predefined value in MPID_Group_builtin for MPI_GROUP_EMPTY in
src/mpi/group/grouputil.c */
/*S
MPID_Group - Description of the Group data structure
The processes in the group of 'MPI_COMM_WORLD' have lpid values 0 to 'size'-1,
where 'size' is the size of 'MPI_COMM_WORLD'. Processes created by
'MPI_Comm_spawn' or 'MPI_Comm_spawn_multiple' or added by 'MPI_Comm_attach'
or
'MPI_Comm_connect'
are numbered greater than 'size - 1' (on the calling process). See the
discussion of LocalPID values.
Note that when dynamic process creation is used, the pids are `not` unique
across the universe of connected MPI processes. This is ok, as long as
pids are interpreted `only` on the process that owns them.
Only for MPI-1 are the lpid''s equal to the `global` pids. The local pids
can be thought of as a reference not to the remote process itself, but
how the remote process can be reached from this process. We may want to
have a structure 'MPID_Lpid_t' that contains information on the remote
process, such as (for TCP) the hostname, ip address (it may be different if
multiple interfaces are supported; we may even want plural ip addresses for
stripping communication), and port (or ports). For shared memory connected
processes, it might have the address of a remote queue. The lpid number
is an index into a table of 'MPID_Lpid_t'''s that contain this (device- and
method-specific) information.
Module:
Group-DS
S*/
typedef struct MPID_Group {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
int size; /* Size of a group */
int rank; /* rank of this process relative to this
group */
int idx_of_first_lpid;
MPID_Group_pmap_t *lrank_to_lpid; /* Array mapping a local rank to local
process number */
int is_local_dense_monotonic; /* see NOTE-G1 */
/* We may want some additional data for the RMA syncrhonization calls */
/* Other, device-specific information */
#ifdef MPID_DEV_GROUP_DECL
MPID_DEV_GROUP_DECL
#endif
} MPID_Group;
/* NOTE-G1: is_local_dense_monotonic will be true iff the group meets the
* following criteria:
* 1) the lpids are all in the range [0,size-1], i.e. a subset of comm world
* 2) the pids are sequentially numbered in increasing order, without any gaps,
* stride, or repetitions
*
* This additional information allows us to handle the common case (insofar as
* group ops are common) for MPI_Group_translate_ranks where group2 is
* group_of(MPI_COMM_WORLD), or some simple subset. This is an important use
* case for many MPI tool libraries, such as Scalasca.
*/
extern MPIU_Object_alloc_t MPID_Group_mem;
/* Preallocated group objects */
#define MPID_GROUP_N_BUILTIN 1
extern MPID_Group MPID_Group_builtin[MPID_GROUP_N_BUILTIN];
extern MPID_Group MPID_Group_direct[];
/* Object for empty group */
extern MPID_Group * const MPID_Group_empty;
#define MPIR_Group_add_ref( _group ) \
do { MPIU_Object_add_ref( _group ); } while (0)
#define MPIR_Group_release_ref( _group, _inuse ) \
do { MPIU_Object_release_ref( _group, _inuse ); } while (0)
void MPIR_Group_setup_lpid_list( MPID_Group * );
/* ------------------------------------------------------------------------- */
/*E
MPID_Comm_kind_t - Name the two types of communicators
E*/
typedef enum MPID_Comm_kind_t {
MPID_INTRACOMM = 0,
MPID_INTERCOMM = 1 } MPID_Comm_kind_t;
/* ideally we could add these to MPID_Comm_kind_t, but there's too much existing
* code that assumes that the only valid values are INTRACOMM or INTERCOMM */
typedef enum MPID_Comm_hierarchy_kind_t {
MPID_HIERARCHY_FLAT = 0, /* no hierarchy */
MPID_HIERARCHY_PARENT = 1, /* has subcommunicators */
MPID_HIERARCHY_NODE_ROOTS = 2, /* is the subcomm for node roots */
MPID_HIERARCHY_NODE = 3, /* is the subcomm for a node */
MPID_HIERARCHY_SIZE /* cardinality of this enum */
} MPID_Comm_hierarchy_kind_t;
/* Communicators */
typedef enum {
MPIR_COMM_MAP_DUP,
MPIR_COMM_MAP_IRREGULAR
} MPIR_Comm_map_type_t;
/* direction of mapping: local to local, local to remote, remote to
* local, remote to remote */
typedef enum {
MPIR_COMM_MAP_DIR_L2L,
MPIR_COMM_MAP_DIR_L2R,
MPIR_COMM_MAP_DIR_R2L,
MPIR_COMM_MAP_DIR_R2R
} MPIR_Comm_map_dir_t;
typedef struct MPIR_Comm_map {
MPIR_Comm_map_type_t type;
struct MPID_Comm *src_comm;
/* mapping direction for intercomms, which contain local and
* remote groups */
MPIR_Comm_map_dir_t dir;
/* only valid for irregular map type */
int src_mapping_size;
int *src_mapping;
int free_mapping; /* we allocated the mapping */
struct MPIR_Comm_map *next;
} MPIR_Comm_map_t;
int MPIR_Comm_map_irregular(struct MPID_Comm *newcomm, struct MPID_Comm *src_comm,
int *src_mapping, int src_mapping_size,
MPIR_Comm_map_dir_t dir,
MPIR_Comm_map_t **map);
int MPIR_Comm_map_dup(struct MPID_Comm *newcomm, struct MPID_Comm *src_comm,
MPIR_Comm_map_dir_t dir);
int MPIR_Comm_map_free(struct MPID_Comm *comm);
/*S
MPID_Comm - Description of the Communicator data structure
Notes:
Note that the size and rank duplicate data in the groups that
make up this communicator. These are used often enough that this
optimization is valuable.
This definition provides only a 16-bit integer for context id''s .
This should be sufficient for most applications. However, extending
this to a 32-bit (or longer) integer should be easy.
There are two context ids. One is used for sending and one for
receiving. In the case of an Intracommunicator, they are the same
context id. They differ in the case of intercommunicators, where
they may come from processes in different comm worlds (in the
case of MPI-2 dynamic process intercomms).
The virtual connection table is an explicit member of this structure.
This contains the information used to contact a particular process,
indexed by the rank relative to this communicator.
Groups are allocated lazily. That is, the group pointers may be
null, created only when needed by a routine such as 'MPI_Comm_group'.
The local process ids needed to form the group are available within
the virtual connection table.
For intercommunicators, we may want to always have the groups. If not,
we either need the 'local_group' or we need a virtual connection table
corresponding to the 'local_group' (we may want this anyway to simplify
the implementation of the intercommunicator collective routines).
The pointer to the structure 'MPID_Collops' containing pointers to the
collective
routines allows an implementation to replace each routine on a
routine-by-routine basis. By default, this pointer is null, as are the
pointers within the structure. If either pointer is null, the implementation
uses the generic provided implementation. This choice, rather than
initializing the table with pointers to all of the collective routines,
is made to reduce the space used in the communicators and to eliminate the
need to include the implementation of all collective routines in all MPI
executables, even if the routines are not used.
The macro 'MPID_HAS_HETERO' may be defined by a device to indicate that
the device supports MPI programs that must communicate between processes with
different data representations (e.g., different sized integers or different
byte orderings). If the device does need to define this value, it should
be defined in the file 'mpidpre.h'.
Please note that the local_size and remote_size fields can be confusing. For
intracommunicators both fields are always equal to the size of the
communicator. For intercommunicators local_size is equal to the size of
local_group while remote_size is equal to the size of remote_group.
Module:
Communicator-DS
Question:
For fault tolerance, do we want to have a standard field for communicator
health? For example, ok, failure detected, all (live) members of failed
communicator have acked.
S*/
typedef struct MPID_Comm {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Thread_mutex_t mutex;
MPIU_Context_id_t context_id; /* Send context id. See notes */
MPIU_Context_id_t recvcontext_id; /* Send context id. See notes */
int remote_size; /* Value of MPI_Comm_(remote)_size */
int rank; /* Value of MPI_Comm_rank */
MPID_Attribute *attributes; /* List of attributes */
int local_size; /* Value of MPI_Comm_size for local group */
MPID_Group *local_group, /* Groups in communicator. */
*remote_group; /* The local and remote groups are the
same for intra communicators */
MPID_Comm_kind_t comm_kind; /* MPID_INTRACOMM or MPID_INTERCOMM */
char name[MPI_MAX_OBJECT_NAME]; /* Required for MPI-2 */
MPID_Errhandler *errhandler; /* Pointer to the error handler structure */
struct MPID_Comm *local_comm; /* Defined only for intercomms, holds
an intracomm for the local group */
MPID_Comm_hierarchy_kind_t hierarchy_kind; /* flat, parent, node, or node_roots */
struct MPID_Comm *node_comm; /* Comm of processes in this comm that are on
the same node as this process. */
struct MPID_Comm *node_roots_comm; /* Comm of root processes for other nodes. */
int *intranode_table; /* intranode_table[i] gives the rank in
node_comm of rank i in this comm or -1 if i
is not in this process' node_comm.
It is of size 'local_size'. */
int *internode_table; /* internode_table[i] gives the rank in
node_roots_comm of rank i in this comm.
It is of size 'local_size'. */
int is_low_group; /* For intercomms only, this boolean is
set for all members of one of the
two groups of processes and clear for
the other. It enables certain
intercommunicator collective operations
that wish to use half-duplex operations
to implement a full-duplex operation */
struct MPID_Comm *comm_next;/* Provides a chain through all active
communicators */
struct MPID_Collops *coll_fns; /* Pointer to a table of functions
implementing the collective
routines */
struct MPID_TopoOps *topo_fns; /* Pointer to a table of functions
implementting the topology routines */
int next_sched_tag; /* used by the NBC schedule code to allocate tags */
int revoked; /* Flag to track whether the communicator
* has been revoked */
MPID_Info *info; /* Hints to the communicator */
#ifdef MPID_HAS_HETERO
int is_hetero;
#endif
#if defined HAVE_LIBHCOLL
hcoll_comm_priv_t hcoll_priv;
#endif /* HAVE_LIBHCOLL */
/* the mapper is temporarily filled out in order to allow the
* device to setup its network addresses. it will be freed after
* the device has initialized the comm. */
MPIR_Comm_map_t *mapper_head;
MPIR_Comm_map_t *mapper_tail;
/* Other, device-specific information */
#ifdef MPID_DEV_COMM_DECL
MPID_DEV_COMM_DECL
#endif
} MPID_Comm;
extern MPIU_Object_alloc_t MPID_Comm_mem;
typedef struct MPID_Gpid {
#ifdef MPID_DEV_GPID_DECL
MPID_DEV_GPID_DECL
#else
int dummy; /* don't create an empty structure */
#endif
}MPID_Gpid;
/* this function should not be called by normal code! */
int MPIR_Comm_delete_internal(MPID_Comm * comm_ptr);
#define MPIR_Comm_add_ref(_comm) \
do { MPIU_Object_add_ref((_comm)); } while (0)
#define MPIR_Comm_release_ref( _comm, _inuse ) \
do { MPIU_Object_release_ref( _comm, _inuse ); } while (0)
/* Release a reference to a communicator. If there are no pending
references, delete the communicator and recover all storage and
context ids.
This routine has been inlined because keeping it as a separate routine
results in a >5% performance hit for the SQMR benchmark.
*/
#undef FUNCNAME
#define FUNCNAME MPIR_Comm_release
#undef FCNAME
#define FCNAME MPL_QUOTE(FUNCNAME)
static inline int MPIR_Comm_release(MPID_Comm * comm_ptr)
{
int mpi_errno = MPI_SUCCESS;
int in_use;
MPIR_Comm_release_ref(comm_ptr, &in_use);
if (unlikely(!in_use)) {
/* the following routine should only be called by this function and its
* "_always" variant. */
mpi_errno = MPIR_Comm_delete_internal(comm_ptr);
/* not ERR_POPing here to permit simpler inlining. Our caller will
* still report the error from the comm_delete level. */
}
return mpi_errno;
}
#undef FUNCNAME
#undef FCNAME
/* MPIR_Comm_release_always is the same as MPIR_Comm_release except it uses
MPIR_Comm_release_ref_always instead.
*/
int MPIR_Comm_release_always(MPID_Comm *comm_ptr);
/* applies the specified info chain to the specified communicator */
int MPIR_Comm_apply_hints(MPID_Comm *comm_ptr, MPID_Info *info_ptr);
/* Preallocated comm objects. There are 3: comm_world, comm_self, and
a private (non-user accessible) dup of comm world that is provided
if needed in MPI_Finalize. Having a separate version of comm_world
avoids possible interference with User code */
#define MPID_COMM_N_BUILTIN 3
extern MPID_Comm MPID_Comm_builtin[MPID_COMM_N_BUILTIN];
extern MPID_Comm MPID_Comm_direct[];
/* This is the handle for the internal MPI_COMM_WORLD . The "2" at the end
of the handle is 3-1 (e.g., the index in the builtin array) */
#define MPIR_ICOMM_WORLD ((MPI_Comm)0x44000002)
/* The following preprocessor macros provide bitfield access information for
* context ID values. They follow a uniform naming pattern:
*
* MPID_CONTEXT_foo_WIDTH - the width in bits of the field
* MPID_CONTEXT_foo_MASK - A valid bit mask for bit-wise AND and OR operations
* with exactly all of the bits in the field set.
* MPID_CONTEXT_foo_SHIFT - The number of bits that the field should be shifted
* rightwards to place it in the least significant bits
* of the ID. There may still be higher order bits
* from other fields, so the _MASK should be used first
* if you want to reliably retrieve the exact value of
* the field.
*/
/* yields an rvalue that is the value of the field_name_ in the least significant bits */
#define MPID_CONTEXT_READ_FIELD(field_name_,id_) \
(((id_) & MPID_CONTEXT_##field_name_##_MASK) >> MPID_CONTEXT_##field_name_##_SHIFT)
/* yields an rvalue that is the old_id_ with field_name_ set to field_val_ */
#define MPID_CONTEXT_SET_FIELD(field_name_,old_id_,field_val_) \
((old_id_ & ~MPID_CONTEXT_##field_name_##_MASK) | ((field_val_) << MPID_CONTEXT_##field_name_##_SHIFT))
/* Context suffixes for separating pt2pt and collective communication */
#define MPID_CONTEXT_SUFFIX_WIDTH (1)
#define MPID_CONTEXT_SUFFIX_SHIFT (0)
#define MPID_CONTEXT_SUFFIX_MASK ((1 << MPID_CONTEXT_SUFFIX_WIDTH) - 1)
#define MPID_CONTEXT_INTRA_PT2PT (0)
#define MPID_CONTEXT_INTRA_COLL (1)
#define MPID_CONTEXT_INTER_PT2PT (0)
#define MPID_CONTEXT_INTER_COLL (1)
/* Used to derive context IDs for sub-communicators from a parent communicator's
context ID value. This field comes after the one bit suffix.
values are shifted left by 1. */
#define MPID_CONTEXT_SUBCOMM_WIDTH (2)
#define MPID_CONTEXT_SUBCOMM_SHIFT (MPID_CONTEXT_SUFFIX_WIDTH + MPID_CONTEXT_SUFFIX_SHIFT)
#define MPID_CONTEXT_SUBCOMM_MASK (((1 << MPID_CONTEXT_SUBCOMM_WIDTH) - 1) << MPID_CONTEXT_SUBCOMM_SHIFT)
/* these values may be added/subtracted directly to/from an existing context ID
* in order to determine the context ID of the child/parent */
#define MPID_CONTEXT_PARENT_OFFSET (0 << MPID_CONTEXT_SUBCOMM_SHIFT)
#define MPID_CONTEXT_INTRANODE_OFFSET (1 << MPID_CONTEXT_SUBCOMM_SHIFT)
#define MPID_CONTEXT_INTERNODE_OFFSET (2 << MPID_CONTEXT_SUBCOMM_SHIFT)
/* this field (IS_LOCALCOM) is used to derive a context ID for local
* communicators of intercommunicators without communication */
#define MPID_CONTEXT_IS_LOCALCOMM_WIDTH (1)
#define MPID_CONTEXT_IS_LOCALCOMM_SHIFT (MPID_CONTEXT_SUBCOMM_SHIFT + MPID_CONTEXT_SUBCOMM_WIDTH)
#define MPID_CONTEXT_IS_LOCALCOMM_MASK (((1 << MPID_CONTEXT_IS_LOCALCOMM_WIDTH) - 1) << MPID_CONTEXT_IS_LOCALCOMM_SHIFT)
/* MPIR_MAX_CONTEXT_MASK is the number of ints that make up the bit vector that
* describes the context ID prefix space.
*
* The following must hold:
* (num_bits_in_vector) <= (maximum_context_id_prefix)
* which is the following in concrete terms:
* MPIR_MAX_CONTEXT_MASK*MPIR_CONTEXT_INT_BITS <= 2**(MPIR_CONTEXT_ID_BITS - (MPID_CONTEXT_PREFIX_SHIFT + MPID_CONTEXT_DYNAMIC_PROC_WIDTH))
*
* We currently always assume MPIR_CONTEXT_INT_BITS is 32, regardless of the
* value of sizeof(int)*CHAR_BITS. We also make the assumption that CHAR_BITS==8.
*
* For a 16-bit context id field and CHAR_BITS==8, this implies MPIR_MAX_CONTEXT_MASK <= 256
*/
/* number of bits to shift right by in order to obtain the context ID prefix */
#define MPID_CONTEXT_PREFIX_SHIFT (MPID_CONTEXT_IS_LOCALCOMM_SHIFT + MPID_CONTEXT_IS_LOCALCOMM_WIDTH)
#define MPID_CONTEXT_PREFIX_WIDTH (MPIR_CONTEXT_ID_BITS - (MPID_CONTEXT_PREFIX_SHIFT + MPID_CONTEXT_DYNAMIC_PROC_WIDTH))
#define MPID_CONTEXT_PREFIX_MASK (((1 << MPID_CONTEXT_PREFIX_WIDTH) - 1) << MPID_CONTEXT_PREFIX_SHIFT)
#define MPID_CONTEXT_DYNAMIC_PROC_WIDTH (1) /* the upper half is reserved for dynamic procs */
#define MPID_CONTEXT_DYNAMIC_PROC_SHIFT (MPIR_CONTEXT_ID_BITS - MPID_CONTEXT_DYNAMIC_PROC_WIDTH) /* the upper half is reserved for dynamic procs */
#define MPID_CONTEXT_DYNAMIC_PROC_MASK (((1 << MPID_CONTEXT_DYNAMIC_PROC_WIDTH) - 1) << MPID_CONTEXT_DYNAMIC_PROC_SHIFT)
/* should probably be (sizeof(int)*CHAR_BITS) once we make the code CHAR_BITS-clean */
#define MPIR_CONTEXT_INT_BITS (32)
#define MPIR_CONTEXT_ID_BITS (sizeof(MPIU_Context_id_t)*8) /* 8 --> CHAR_BITS eventually */
#define MPIR_MAX_CONTEXT_MASK \
((1 << (MPIR_CONTEXT_ID_BITS - (MPID_CONTEXT_PREFIX_SHIFT + MPID_CONTEXT_DYNAMIC_PROC_WIDTH))) / MPIR_CONTEXT_INT_BITS)
/* Utility routines. Where possible, these are kept in the source directory
with the other comm routines (src/mpi/comm, in mpicomm.h). However,
to create a new communicator after a spawn or connect-accept operation,
the device may need to create a new contextid */
int MPIR_Get_contextid_sparse(MPID_Comm *comm_ptr, MPIU_Context_id_t *context_id, int ignore_id);
int MPIR_Get_contextid_sparse_group(MPID_Comm *comm_ptr, MPID_Group *group_ptr, int tag, MPIU_Context_id_t *context_id, int ignore_id);
void MPIR_Free_contextid( MPIU_Context_id_t );
/* ------------------------------------------------------------------------- */
/* Requests */
/* This currently defines a single structure type for all requests.
Eventually, we may want a union type, as used in MPICH-1 */
/* NOTE-R1: MPID_REQUEST_MPROBE signifies that this is a request created by
* MPI_Mprobe or MPI_Improbe. Since we use MPI_Request objects as our
* MPI_Message objects, we use this separate kind in order to provide stronger
* error checking. Once a message (backed by a request) is promoted to a real
* request by calling MPI_Mrecv/MPI_Imrecv, we actually modify the kind to be
* MPID_REQUEST_RECV in order to keep completion logic as simple as possible. */
/*E
MPID_Request_kind - Kinds of MPI Requests
Module:
Request-DS
E*/
typedef enum MPID_Request_kind_t {
MPID_REQUEST_UNDEFINED,
MPID_REQUEST_SEND,
MPID_REQUEST_RECV,
MPID_PREQUEST_SEND,
MPID_PREQUEST_RECV,
MPID_UREQUEST,
MPID_COLL_REQUEST,
MPID_REQUEST_MPROBE, /* see NOTE-R1 */
MPID_WIN_REQUEST,
MPID_LAST_REQUEST_KIND
#ifdef MPID_DEV_REQUEST_KIND_DECL
, MPID_DEV_REQUEST_KIND_DECL
#endif
} MPID_Request_kind_t;
/* Typedefs for Fortran generalized requests */
typedef void (MPIR_Grequest_f77_cancel_function)(void *, MPI_Fint*, MPI_Fint *);
typedef void (MPIR_Grequest_f77_free_function)(void *, MPI_Fint *);
typedef void (MPIR_Grequest_f77_query_function)(void *, MPI_Fint *, MPI_Fint *);
/* vtable-ish structure holding generalized request function pointers and other
* state. Saves ~48 bytes in pt2pt requests on many platforms. */
struct MPID_Grequest_fns {
MPI_Grequest_cancel_function *cancel_fn;
MPI_Grequest_free_function *free_fn;
MPI_Grequest_query_function *query_fn;
MPIX_Grequest_poll_function *poll_fn;
MPIX_Grequest_wait_function *wait_fn;
void *grequest_extra_state;
MPIX_Grequest_class greq_class;
MPID_Lang_t greq_lang; /* language that defined
the generalize req */
};
#define MPID_Request_is_complete(req_) (MPID_cc_is_complete((req_)->cc_ptr))
/*S
MPID_Request - Description of the Request data structure
Module:
Request-DS
Notes:
If it is necessary to remember the MPI datatype, this information is
saved within the device-specific fields provided by 'MPID_DEV_REQUEST_DECL'.
Requests come in many flavors, as stored in the 'kind' field. It is
expected that each kind of request will have its own structure type
(e.g., 'MPID_Request_send_t') that extends the 'MPID_Request'.
S*/
typedef struct MPID_Request {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Request_kind_t kind;
/* pointer to the completion counter */
/* This is necessary for the case when an operation is described by a
list of requests */
MPID_cc_t *cc_ptr;
/* A comm is needed to find the proper error handler */
MPID_Comm *comm;
/* completion counter. Ensure cc and status are in the same cache
line, assuming the cache line size is a multiple of 32 bytes
and 32-bit integers */
MPID_cc_t cc;
/* Status is needed for wait/test/recv */
MPI_Status status;
/* Persistent requests have their own "real" requests. Receive requests
have partnering send requests when src=dest. etc. */
struct MPID_Request *partner_request;
/* User-defined request support via a "vtable". Saves space in the already
* bloated request for regular pt2pt and NBC requests. */
struct MPID_Grequest_fns *greq_fns;
struct MPIR_Sendq *dbg_next;
/* Errflag for NBC requests. Not used by other requests. */
MPIR_Errflag_t errflag;
/* Notes about request_completed_cb:
*
* 1. The callback function is triggered when this requests
* completion count reaches 0.
*
* 2. The callback function should be nonblocking.
*
* 3. The callback function should not poke the progress engine,
* or call any function that pokes the progress engine.
*
* 4. The callback function can complete other requests, thus
* calling those requests' callback functions. However, the
* recursion depth of request completion function is limited.
* If we ever need deeper recurisve calls, we need to change
* to an iterative design instead of a recursive design for
* request completion.
*
* 5. In multithreaded programs, since the callback function is
* nonblocking and never calls the progress engine, it would
* never yield the lock to other threads. So the recursion
* should be multithreading-safe.
*/
int (*request_completed_cb)(struct MPID_Request *);
/* Other, device-specific information */
#ifdef MPID_DEV_REQUEST_DECL
MPID_DEV_REQUEST_DECL
#endif
} MPID_Request;
extern MPIU_Object_alloc_t MPID_Request_mem;
/* Preallocated request objects */
extern MPID_Request MPID_Request_direct[];
#define MPIR_Request_add_ref( _req ) \
do { MPIU_Object_add_ref( _req ); } while (0)
#define MPIR_Request_release_ref( _req, _inuse ) \
do { MPIU_Object_release_ref( _req, _inuse ); } while (0)
/* These macros allow us to implement a sendq when debugger support is
selected. As there is extra overhead for this, we only do this
when specifically requested
*/
#ifdef HAVE_DEBUGGER_SUPPORT
void MPIR_WaitForDebugger( void );
void MPIR_DebuggerSetAborting( const char * );
void MPIR_Sendq_remember(MPID_Request *, int, int, int );
void MPIR_Sendq_forget(MPID_Request *);
void MPIR_CommL_remember( MPID_Comm * );
void MPIR_CommL_forget( MPID_Comm * );
#define MPIR_SENDQ_REMEMBER(_a,_b,_c,_d) MPIR_Sendq_remember(_a,_b,_c,_d)
#define MPIR_SENDQ_FORGET(_a) MPIR_Sendq_forget(_a)
#define MPIR_COMML_REMEMBER(_a) MPIR_CommL_remember( _a )
#define MPIR_COMML_FORGET(_a) MPIR_CommL_forget( _a )
#else
#define MPIR_SENDQ_REMEMBER(a,b,c,d)
#define MPIR_SENDQ_FORGET(a)
#define MPIR_COMML_REMEMBER(_a)
#define MPIR_COMML_FORGET(_a)
#endif
/* must come after MPID_Comm is declared/defined */
int MPIR_Get_contextid_nonblock(MPID_Comm *comm_ptr, MPID_Comm *newcommp, MPID_Request **req);
int MPIR_Get_intercomm_contextid_nonblock(MPID_Comm *comm_ptr, MPID_Comm *newcommp, MPID_Request **req);
/* ------------------------------------------------------------------------- */
/* Prototypes and definitions for the node ID code. This is used to support
hierarchical collectives in a (mostly) device-independent way. */
#if defined(MPID_USE_NODE_IDS)
/* MPID_Node_id_t is a signed integer type defined by the device in mpidpre.h. */
int MPID_Get_node_id(MPID_Comm *comm, int rank, MPID_Node_id_t *id_p);
int MPID_Get_max_node_id(MPID_Comm *comm, MPID_Node_id_t *max_id_p);
#endif
/* ------------------------------------------------------------------------- */
/*S
MPID_Progress_state - object to hold progress state when using the blocking
progress routines.
Module:
Misc
Notes:
The device must define MPID_PROGRESS_STATE_DECL. It should include any state
that needs to be maintained between calls to MPID_Progress_{start,wait,end}.
S*/
typedef struct MPID_Progress_state
{
MPID_PROGRESS_STATE_DECL
}
MPID_Progress_state;
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* end of mpirma.h (in src/mpi/rma?) */
/* ------------------------------------------------------------------------- */
/*S
MPID_Win - Description of the Window Object data structure.
Module:
Win-DS
Notes:
The following 3 keyvals are defined for attributes on all MPI
Window objects\:
.vb
MPI_WIN_SIZE
MPI_WIN_BASE
MPI_WIN_DISP_UNIT
.ve
These correspond to the values in 'length', 'start_address', and
'disp_unit'.
The communicator in the window is the same communicator that the user
provided to 'MPI_Win_create' (not a dup). However, each intracommunicator
has a special context id that may be used if MPI communication is used
by the implementation to implement the RMA operations.
There is no separate window group; the group of the communicator should be
used.
Question:
Should a 'MPID_Win' be defined after 'MPID_Segment' in case the device
wants to
store a queue of pending put/get operations, described with 'MPID_Segment'
(or 'MPID_Request')s?
S*/
typedef struct MPID_Win {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Thread_mutex_t mutex;
MPID_Errhandler *errhandler; /* Pointer to the error handler structure */
void *base;
MPI_Aint size;
int disp_unit; /* Displacement unit of *local* window */
MPID_Attribute *attributes;
MPID_Comm *comm_ptr; /* Pointer to comm of window (dup) */
#ifdef USE_THREADED_WINDOW_CODE
/* These were causing compilation errors. We need to figure out how to
integrate threads into MPICH before including these fields. */
/* FIXME: The test here should be within a test for threaded support */
#ifdef HAVE_PTHREAD_H
pthread_t wait_thread_id; /* id of thread handling MPI_Win_wait */
pthread_t passive_target_thread_id; /* thread for passive target RMA */
#elif defined(HAVE_WINTHREADS)
HANDLE wait_thread_id;
HANDLE passive_target_thread_id;
#endif
#endif
/* These are COPIES of the values so that addresses to them
can be returned as attributes. They are initialized by the
MPI_Win_get_attr function.
These values are constant for the lifetime of the window, so
this is thread-safe.
*/
int copyDispUnit;
MPI_Aint copySize;
char name[MPI_MAX_OBJECT_NAME];
MPIR_Win_flavor_t create_flavor;
MPIR_Win_model_t model;
MPIR_Win_flavor_t copyCreateFlavor;
MPIR_Win_model_t copyModel;
/* Other, device-specific information */
#ifdef MPID_DEV_WIN_DECL
MPID_DEV_WIN_DECL
#endif
} MPID_Win;
extern MPIU_Object_alloc_t MPID_Win_mem;
/* Preallocated win objects */
extern MPID_Win MPID_Win_direct[];
/* ------------------------------------------------------------------------- */
/* also in mpirma.h ?*/
/* ------------------------------------------------------------------------- */
/*
* Good Memory (may be required for passive target operations on MPI_Win)
*/
/*@
MPID_Alloc_mem - Allocate memory suitable for passive target RMA operations
Input Parameter:
+ size - Number of types to allocate.
- info - Info object
Return value:
Pointer to the allocated memory. If the memory is not available,
returns null.
Notes:
This routine is used to implement 'MPI_Alloc_mem'. It is for that reason
that there is no communicator argument.
This memory may `only` be freed with 'MPID_Free_mem'.
This is a `local`, not a collective operation. It functions more like a
good form of 'malloc' than collective shared-memory allocators such as
the 'shmalloc' found on SGI systems.
Implementations of this routine may wish to use 'MPID_Memory_register'.
However, this routine has slighly different requirements, so a separate
entry point is provided.
Question:
Since this takes an info object, should there be an error routine in the
case that the info object contains an error?
Module:
Win
@*/
void *MPID_Alloc_mem( size_t size, MPID_Info *info );
/*@
MPID_Free_mem - Frees memory allocated with 'MPID_Alloc_mem'
Input Parameter:
. ptr - Pointer to memory allocated by 'MPID_Alloc_mem'.
Return value:
'MPI_SUCCESS' if memory was successfully freed; an MPI error code otherwise.
Notes:
The return value is provided because it may not be easy to validate the
value of 'ptr' without attempting to free the memory.
Module:
Win
@*/
int MPID_Free_mem( void *ptr );
/*@
MPID_Mem_was_alloced - Return true if this memory was allocated with
'MPID_Alloc_mem'
Input Parameters:
+ ptr - Address of memory
- size - Size of reqion in bytes.
Return value:
True if the memory was allocated with 'MPID_Alloc_mem', false otherwise.
Notes:
This routine may be needed by 'MPI_Win_create' to ensure that the memory
for passive target RMA operations was allocated with 'MPI_Mem_alloc'.
This may be used, for example, for ensuring that memory used with
passive target operations was allocated with 'MPID_Alloc_mem'.
Module:
Win
@*/
int MPID_Mem_was_alloced( void *ptr ); /* brad : this isn't used or implemented anywhere */
/* ------------------------------------------------------------------------- */
/* end of also in mpirma.h ? */
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* Reduction and accumulate operations */
/*E
MPID_Op_kind - Enumerates types of MPI_Op types
Notes:
These are needed for implementing 'MPI_Accumulate', since only predefined
operations are allowed for that operation.
A gap in the enum values was made allow additional predefined operations
to be inserted. This might include future additions to MPI or experimental
extensions (such as a Read-Modify-Write operation).
Module:
Collective-DS
E*/
typedef enum MPID_Op_kind { MPID_OP_NULL=0, MPID_OP_MAX=1, MPID_OP_MIN=2,
MPID_OP_SUM=3, MPID_OP_PROD=4,
MPID_OP_LAND=5, MPID_OP_BAND=6, MPID_OP_LOR=7, MPID_OP_BOR=8,
MPID_OP_LXOR=9, MPID_OP_BXOR=10, MPID_OP_MAXLOC=11,
MPID_OP_MINLOC=12, MPID_OP_REPLACE=13,
MPID_OP_NO_OP=14,
MPID_OP_USER_NONCOMMUTE=32, MPID_OP_USER=33 }
MPID_Op_kind;
/*S
MPID_User_function - Definition of a user function for MPI_Op types.
Notes:
This includes a 'const' to make clear which is the 'in' argument and
which the 'inout' argument, and to indicate that the 'count' and 'datatype'
arguments are unchanged (they are addresses in an attempt to allow
interoperation with Fortran). It includes 'restrict' to emphasize that
no overlapping operations are allowed.
We need to include a Fortran version, since those arguments will
have type 'MPI_Fint *' instead. We also need to add a test to the
test suite for this case; in fact, we need tests for each of the handle
types to ensure that the transfered handle works correctly.
This is part of the collective module because user-defined operations
are valid only for the collective computation routines and not for
RMA accumulate.
Yes, the 'restrict' is in the correct location. C compilers that
support 'restrict' should be able to generate code that is as good as a
Fortran compiler would for these functions.
We should note on the manual pages for user-defined operations that
'restrict' should be used when available, and that a cast may be
required when passing such a function to 'MPI_Op_create'.
Question:
Should each of these function types have an associated typedef?
Should there be a C++ function here?
Module:
Collective-DS
S*/
typedef union MPID_User_function {
void (*c_function) ( const void *, void *,
const int *, const MPI_Datatype * );
void (*f77_function) ( const void *, void *,
const MPI_Fint *, const MPI_Fint * );
} MPID_User_function;
/* FIXME: Should there be "restrict" in the definitions above, e.g.,
(*c_function)( const void restrict * , void restrict *, ... )? */
/*S
MPID_Op - MPI_Op structure
Notes:
All of the predefined functions are commutative. Only user functions may
be noncummutative, so there are two separate op types for commutative and
non-commutative user-defined operations.
Operations do not require reference counts because there are no nonblocking
operations that accept user-defined operations. Thus, there is no way that
a valid program can free an 'MPI_Op' while it is in use.
Module:
Collective-DS
S*/
typedef struct MPID_Op {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPID_Op_kind kind;
MPID_Lang_t language;
MPID_User_function function;
} MPID_Op;
#define MPID_OP_N_BUILTIN 15
extern MPID_Op MPID_Op_builtin[MPID_OP_N_BUILTIN];
extern MPID_Op MPID_Op_direct[];
extern MPIU_Object_alloc_t MPID_Op_mem;
#define MPIR_Op_add_ref(_op) \
do { MPIU_Object_add_ref(_op); } while (0)
#define MPIR_Op_release_ref( _op, _inuse ) \
do { MPIU_Object_release_ref( _op, _inuse ); } while (0)
/* release and free-if-not-in-use helper */
#define MPIR_Op_release(op_p_) \
do { \
int in_use_; \
MPIR_Op_release_ref((op_p_), &in_use_); \
if (!in_use_) { \
MPIU_Handle_obj_free(&MPID_Op_mem, (op_p_)); \
} \
} while (0)
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* mpicoll.h (in src/mpi/coll?) */
/* ------------------------------------------------------------------------- */
/* Collective operations */
typedef struct MPID_Collops {
int ref_count; /* Supports lazy copies */
/* Contains pointers to the functions for the MPI collectives */
int (*Barrier) (MPID_Comm *, MPIR_Errflag_t *);
int (*Bcast) (void*, int, MPI_Datatype, int, MPID_Comm *, MPIR_Errflag_t *);
int (*Gather) (const void*, int, MPI_Datatype, void*, int, MPI_Datatype,
int, MPID_Comm *, MPIR_Errflag_t *);
int (*Gatherv) (const void*, int, MPI_Datatype, void*, const int *, const int *,
MPI_Datatype, int, MPID_Comm *, MPIR_Errflag_t *);
int (*Scatter) (const void*, int, MPI_Datatype, void*, int, MPI_Datatype,
int, MPID_Comm *, MPIR_Errflag_t *);
int (*Scatterv) (const void*, const int *, const int *, MPI_Datatype,
void*, int, MPI_Datatype, int, MPID_Comm *, MPIR_Errflag_t *);
int (*Allgather) (const void*, int, MPI_Datatype, void*, int,
MPI_Datatype, MPID_Comm *, MPIR_Errflag_t *);
int (*Allgatherv) (const void*, int, MPI_Datatype, void*, const int *,
const int *, MPI_Datatype, MPID_Comm *, MPIR_Errflag_t *);
int (*Alltoall) (const void*, int, MPI_Datatype, void*, int, MPI_Datatype,
MPID_Comm *, MPIR_Errflag_t *);
int (*Alltoallv) (const void*, const int *, const int *, MPI_Datatype,
void*, const int *, const int *, MPI_Datatype, MPID_Comm *,
MPIR_Errflag_t *);
int (*Alltoallw) (const void*, const int *, const int *, const MPI_Datatype *, void*,
const int *, const int *, const MPI_Datatype *, MPID_Comm *, MPIR_Errflag_t *);
int (*Reduce) (const void*, void*, int, MPI_Datatype, MPI_Op, int,
MPID_Comm *, MPIR_Errflag_t *);
int (*Allreduce) (const void*, void*, int, MPI_Datatype, MPI_Op,
MPID_Comm *, MPIR_Errflag_t *);
int (*Reduce_scatter) (const void*, void*, const int *, MPI_Datatype, MPI_Op,
MPID_Comm *, MPIR_Errflag_t *);
int (*Scan) (const void*, void*, int, MPI_Datatype, MPI_Op, MPID_Comm *, MPIR_Errflag_t * );
int (*Exscan) (const void*, void*, int, MPI_Datatype, MPI_Op, MPID_Comm *, MPIR_Errflag_t * );
int (*Reduce_scatter_block) (const void*, void*, int, MPI_Datatype, MPI_Op,
MPID_Comm *, MPIR_Errflag_t *);
/* MPI-3 nonblocking collectives */
int (*Ibarrier_sched)(MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ibarrier_req)(MPID_Comm *comm_ptr, MPID_Request **request);
int (*Ibcast_sched)(void *buffer, int count, MPI_Datatype datatype, int root,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ibcast_req)(void *buffer, int count, MPI_Datatype datatype, int root,
MPID_Comm *comm_ptr, MPID_Request **request);
int (*Igather_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Igather_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Igatherv_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
const int *recvcounts, const int *displs, MPI_Datatype recvtype, int root,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Igatherv_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
const int *recvcounts, const int *displs, MPI_Datatype recvtype, int root,
MPID_Comm *comm_ptr, MPID_Request **request);
int (*Iscatter_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Iscatter_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Iscatterv_sched)(const void *sendbuf, const int *sendcounts, const int *displs,
MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Iscatterv_req)(const void *sendbuf, const int *sendcounts, const int *displs,
MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPID_Request **request);
int (*Iallgather_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Iallgather_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Iallgatherv_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
const int *recvcounts, const int *displs, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Iallgatherv_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
const int *recvcounts, const int *displs, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPID_Request ** request);
int (*Ialltoall_sched)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Ialltoall_req)(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,
int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Ialltoallv_sched)(const void *sendbuf, const int *sendcounts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcounts,
const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Ialltoallv_req)(const void *sendbuf, const int *sendcounts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcounts,
const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Ialltoallw_sched)(const void *sendbuf, const int *sendcounts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcounts,
const int *rdispls, const MPI_Datatype *recvtypes,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ialltoallw_req)(const void *sendbuf, const int *sendcounts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcounts,
const int *rdispls, const MPI_Datatype *recvtypes,
MPID_Comm *comm_ptr, MPID_Request **request);
int (*Ireduce_sched)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ireduce_req)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
int root, MPID_Comm *comm_ptr, MPID_Request **request);
int (*Iallreduce_sched)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Iallreduce_req)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPID_Request **request);
int (*Ireduce_scatter_sched)(const void *sendbuf, void *recvbuf, const int *recvcounts,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ireduce_scatter_req)(const void *sendbuf, void *recvbuf, const int *recvcounts,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Request **request);
int (*Ireduce_scatter_block_sched)(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Ireduce_scatter_block_req)(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr,
MPID_Request **request);
int (*Iscan_sched)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Iscan_req)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
MPID_Comm *comm_ptr, MPID_Request **request);
int (*Iexscan_sched)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Iexscan_req)(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op,
MPID_Comm *comm_ptr, MPID_Request **request);
struct MPID_Collops *prev_coll_fns; /* when overriding this table, set this to point to the old table */
/* MPI-3 neighborhood collectives (blocking & nonblocking) */
int (*Neighbor_allgather)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr);
int (*Neighbor_allgatherv)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int recvcounts[], const int displs[],
MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int (*Neighbor_alltoall)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr);
int (*Neighbor_alltoallv)(const void *sendbuf, const int sendcounts[], const int sdispls[],
MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int (*Neighbor_alltoallw)(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[],
const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[],
const MPI_Aint rdispls[], const MPI_Datatype recvtypes[],
MPID_Comm *comm_ptr);
int (*Ineighbor_allgather)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ineighbor_allgatherv)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int recvcounts[], const int displs[],
MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ineighbor_alltoall)(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPID_Sched_t s);
int (*Ineighbor_alltoallv)(const void *sendbuf, const int sendcounts[], const int sdispls[],
MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPID_Sched_t s);
int (*Ineighbor_alltoallw)(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[],
const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[],
const MPI_Aint rdispls[], const MPI_Datatype recvtypes[],
MPID_Comm *comm_ptr, MPID_Sched_t s);
} MPID_Collops;
#define MPIR_BARRIER_TAG 1
/* ------------------------------------------------------------------------- */
/* end of mpicoll.h (in src/mpi/coll? */
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
/* mpitopo.h (in src/mpi/topo? */
/*
* The following struture allows the device detailed control over the
* functions that are used to implement the topology routines. If either
* the pointer to this structure is null or any individual entry is null,
* the default function is used (this follows exactly the same rules as the
* collective operations, provided in the MPID_Collops structure).
*/
/* ------------------------------------------------------------------------- */
typedef struct MPID_TopoOps {
int (*cartCreate)( const MPID_Comm *, int, const int[], const int [],
int, MPI_Comm * );
int (*cartMap) ( const MPID_Comm *, int, const int[], const int [],
int * );
int (*graphCreate)( const MPID_Comm *, int, const int[], const int [],
int, MPI_Comm * );
int (*graphMap) ( const MPID_Comm *, int, const int[], const int[],
int * );
} MPID_TopoOps;
/* ------------------------------------------------------------------------- */
/* end of mpitopo.h (in src/mpi/topo? */
/* ------------------------------------------------------------------------- */
typedef struct MPID_CommOps {
int (*split_type)(MPID_Comm *, int, int, MPID_Info *, MPID_Comm **);
} MPID_CommOps;
extern struct MPID_CommOps *MPID_Comm_fns; /* Communicator creation functions */
/* Per process data */
typedef enum MPIR_MPI_State_t {
MPICH_PRE_INIT=0,
MPICH_IN_INIT,
MPICH_POST_INIT,
MPICH_POST_FINALIZED
} MPIR_MPI_State_t;
typedef struct PreDefined_attrs {
int appnum; /* Application number provided by mpiexec (MPI-2) */
int host; /* host */
int io; /* standard io allowed */
int lastusedcode; /* last used error code (MPI-2) */
int tag_ub; /* Maximum message tag */
int universe; /* Universe size from mpiexec (MPI-2) */
int wtime_is_global; /* Wtime is global over processes in COMM_WORLD */
} PreDefined_attrs;
struct MPID_Datatype;
typedef struct MPICH_PerProcess_t {
OPA_int_t mpich_state; /* State of MPICH. Use OPA_int_t to make MPI_Initialized() etc.
thread-safe per MPI-3.1. See MPI-Forum ticket 357 */
int do_error_checks; /* runtime error check control */
struct MPID_Comm *comm_world; /* Easy access to comm_world for
error handler */
struct MPID_Comm *comm_self; /* Easy access to comm_self */
struct MPID_Comm *comm_parent; /* Easy access to comm_parent */
struct MPID_Comm *icomm_world; /* An internal version of comm_world
that is separate from user's
versions */
PreDefined_attrs attrs; /* Predefined attribute values */
int tagged_coll_mask; /* Tag space mask for tagged collectives */
/* The topology routines dimsCreate is independent of any communicator.
If this pointer is null, the default routine is used */
int (*dimsCreate)( int, int, int *);
/* Attribute dup functions. Here for lazy initialization */
int (*attr_dup)( int, MPID_Attribute *, MPID_Attribute ** );
int (*attr_free)( int, MPID_Attribute ** );
/* There is no win_attr_dup function because there can be no MPI_Win_dup
function */
/* Routine to get the messages corresponding to dynamically created
error messages */
const char *(*errcode_to_string)( int );
#ifdef HAVE_CXX_BINDING
/* Routines to call C++ functions from the C implementation of the
MPI reduction and attribute routines */
void (*cxx_call_op_fn)(const void *, void *, int, MPI_Datatype,
MPI_User_function * );
/* Error handling functions. As for the attribute functions,
we pass the integer file/comm/win, the address of the error code,
and the C function to call (itself a function defined by the
C++ interface and exported to C). The first argument is used
to specify the kind (comm,file,win) */
void (*cxx_call_errfn) ( int, int *, int *, void (*)(void) );
#endif /* HAVE_CXX_BINDING */
} MPICH_PerProcess_t;
extern MPICH_PerProcess_t MPIR_Process;
/* ------------------------------------------------------------------------- */
/* In MPICH, each function has an "enter" and "exit" macro. These can be
* used to add various features to each function at compile time, or they
* can be set to empty to provide the fastest possible production version.
*
* There are at this time three choices of features (beyond the empty choice)
* 1. timing (controlled by macros in mpitimerimpl.h)
* These collect data on when each function began and finished; the
* resulting data can be displayed using special programs
* 2. Debug logging (selected with --enable-g=log)
* Invokes MPIU_DBG_MSG at the entry and exit for each routine
* 3. Additional memory validation of the memory arena (--enable-g=memarena)
*/
/* ------------------------------------------------------------------------- */
/* allow the timing module the opportunity to define the macros */
#include "mpifunc.h"
#if !defined(NEEDS_FUNC_ENTER_EXIT_DEFS)
/* If no timing choice is selected, this sets the entry/exit macros
to empty */
# include "mpitimerimpl.h"
#endif
#ifdef NEEDS_FUNC_ENTER_EXIT_DEFS
/* mpich layer definitions */
#define MPID_MPI_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_PT2PT_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_PT2PT_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_PT2PT_FUNC_ENTER_FRONT(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_PT2PT_FUNC_EXIT_FRONT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_PT2PT_FUNC_ENTER_BACK(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_PT2PT_FUNC_ENTER_BOTH(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_PT2PT_FUNC_EXIT_BACK(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_PT2PT_FUNC_EXIT_BOTH(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_COLL_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_COLL_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_RMA_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_RMA_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_INIT_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_INIT_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPID_MPI_FINALIZE_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPID_MPI_FINALIZE_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
/* device layer definitions */
#define MPIDI_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_PT2PT_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_PT2PT_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_PT2PT_FUNC_ENTER_FRONT(a) MPIR_FUNC_ENTER(a)
#define MPIDI_PT2PT_FUNC_EXIT_FRONT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_PT2PT_FUNC_ENTER_BACK(a) MPIR_FUNC_ENTER(a)
#define MPIDI_PT2PT_FUNC_ENTER_BOTH(a) MPIR_FUNC_ENTER(a)
#define MPIDI_PT2PT_FUNC_EXIT_BACK(a) MPIR_FUNC_EXIT(a)
#define MPIDI_PT2PT_FUNC_EXIT_BOTH(a) MPIR_FUNC_EXIT(a)
#define MPIDI_COLL_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_COLL_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_RMA_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_RMA_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_INIT_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_INIT_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
#define MPIDI_FINALIZE_FUNC_ENTER(a) MPIR_FUNC_ENTER(a)
#define MPIDI_FINALIZE_FUNC_EXIT(a) MPIR_FUNC_EXIT(a)
/* evaporate the timing macros since timing is not selected */
#define MPIU_Timer_init(rank, size)
#define MPIU_Timer_finalize()
#endif /* NEEDS_FUNC_ENTER_EXIT_DEFS */
/* Definitions for error handling and reporting */
#include "mpierror.h"
#include "mpierrs.h"
/* FIXME: This routine is only used within mpi/src/err/errutil.c. We
* may not want to export it. */
void MPIR_Err_print_stack(FILE *, int);
/* ------------------------------------------------------------------------- */
/* FIXME: Move these to the communicator block; make sure that all
objects have such hooks */
#ifndef HAVE_DEV_COMM_HOOK
#define MPID_Dev_comm_create_hook( a ) MPI_SUCCESS
#define MPID_Dev_comm_destroy_hook( a ) MPI_SUCCESS
#endif
/* ------------------------------------------------------------------------- */
/* FIXME: What is the scope of these functions? Can they be moved into
src/mpi/pt2pt? */
/* ------------------------------------------------------------------------- */
/* MPI_Status manipulation macros */
#define MPIR_BITS_IN_INT (8 * SIZEOF_INT)
/* We use bits from the "count_lo" and "count_hi_and_cancelled" fields
* to represent the 'count' and 'cancelled' objects. The LSB of the
* "count_hi_and_cancelled" field represents the 'cancelled' object.
* The 'count' object is split between the "count_lo" and
* "count_hi_and_cancelled" fields, with the lower order bits going
* into the "count_lo" field, and the higher order bits goin into the
* "count_hi_and_cancelled" field. This gives us 2N-1 bits for the
* 'count' object, where N is the size of int. However, the value
* returned to the user is bounded by the definition on MPI_Count. */
/* NOTE: The below code assumes that the count value is never
* negative. For negative values, right-shifting can have weird
* implementation specific consequences. */
#define MPIR_STATUS_SET_COUNT(status_, count_) \
{ \
(status_).count_lo = ((int) count_); \
(status_).count_hi_and_cancelled &= 1; \
(status_).count_hi_and_cancelled |= (int) ((MPIR_Ucount) count_ >> MPIR_BITS_IN_INT << 1); \
}
#define MPIR_STATUS_GET_COUNT(status_) \
((MPI_Count) ((((MPIR_Ucount) (((unsigned int) (status_).count_hi_and_cancelled) >> 1)) << MPIR_BITS_IN_INT) + (unsigned int) (status_).count_lo))
#define MPIR_STATUS_SET_CANCEL_BIT(status_, cancelled_) \
{ \
(status_).count_hi_and_cancelled &= ~1; \
(status_).count_hi_and_cancelled |= cancelled_; \
}
#define MPIR_STATUS_GET_CANCEL_BIT(status_) ((status_).count_hi_and_cancelled & 1)
/* Do not set MPI_ERROR (only set if ERR_IN_STATUS is returned */
#define MPIR_Status_set_empty(status_) \
{ \
if ((status_) != MPI_STATUS_IGNORE) \
{ \
(status_)->MPI_SOURCE = MPI_ANY_SOURCE; \
(status_)->MPI_TAG = MPI_ANY_TAG; \
MPIR_STATUS_SET_COUNT(*(status_), 0); \
MPIR_STATUS_SET_CANCEL_BIT(*(status_), FALSE); \
} \
}
/* See MPI 1.1, section 3.11, Null Processes */
/* Do not set MPI_ERROR (only set if ERR_IN_STATUS is returned */
#define MPIR_Status_set_procnull(status_) \
{ \
if ((status_) != MPI_STATUS_IGNORE) \
{ \
(status_)->MPI_SOURCE = MPI_PROC_NULL; \
(status_)->MPI_TAG = MPI_ANY_TAG; \
MPIR_STATUS_SET_COUNT(*(status_), 0); \
MPIR_STATUS_SET_CANCEL_BIT(*(status_), FALSE); \
} \
}
#define MPIR_Request_extract_status(request_ptr_, status_) \
{ \
if ((status_) != MPI_STATUS_IGNORE) \
{ \
int error__; \
\
/* According to the MPI 1.1 standard page 22 lines 9-12, the MPI_ERROR field may not be modified except by the \
functions in section 3.7.5 which return MPI_ERR_IN_STATUSES (MPI_Wait{all,some} and MPI_Test{all,some}). */ \
error__ = (status_)->MPI_ERROR; \
*(status_) = (request_ptr_)->status; \
(status_)->MPI_ERROR = error__; \
} \
}
/* ------------------------------------------------------------------------- */
/* FIXME: The bindings should be divided into three groups:
1. ADI3 routines. These should have structure comment documentation, e.g.,
the text from doc/adi3/adi3.c
2. General utility routines. These should have a short description
3. Local utility routines, e.g., routines used within a single subdirectory.
These should be moved into an include file in that subdirectory
*/
/* Bindings for internal routines */
/*@ MPIR_Add_finalize - Add a routine to be called when MPI_Finalize is invoked
+ routine - Routine to call
. extra - Void pointer to data to pass to the routine
- priority - Indicates the priority of this callback and controls the order
in which callbacks are executed. Use a priority of zero for most handlers;
higher priorities will be executed first.
Notes:
The routine 'MPID_Finalize' is executed with priority
'MPIR_FINALIZE_CALLBACK_PRIO' (currently defined as 5). Handlers with
a higher priority execute before 'MPID_Finalize' is called; those with
a lower priority after 'MPID_Finalize' is called.
@*/
void MPIR_Add_finalize( int (*routine)( void * ), void *extra, int priority );
#define MPIR_FINALIZE_CALLBACK_PRIO 5
#define MPIR_FINALIZE_CALLBACK_HANDLE_CHECK_PRIO 1
#define MPIR_FINALIZE_CALLBACK_DEFAULT_PRIO 0
#define MPIR_FINALIZE_CALLBACK_MAX_PRIO 10
/*int MPIR_Comm_attr_dup(MPID_Comm *, MPID_Attribute **);
int MPIR_Comm_attr_delete(MPID_Comm *, MPID_Attribute *);*/
int MPIR_Comm_copy( MPID_Comm *, int, MPID_Comm ** );
int MPIR_Comm_copy_data(MPID_Comm *comm_ptr, MPID_Comm **outcomm_ptr);
/* Fortran keyvals are set with functions in mpi_f77interface.h */
#ifdef HAVE_CXX_BINDING
extern void MPIR_Keyval_set_cxx( int, void (*)(void), void (*)(void) );
extern void MPIR_Op_set_cxx( MPI_Op, void (*)(void) );
extern void MPIR_Errhandler_set_cxx( MPI_Errhandler, void (*)(void) );
#endif
int MPIR_Group_create( int, MPID_Group ** );
int MPIR_Group_release(MPID_Group *group_ptr);
int MPIR_dup_fn ( MPI_Comm, int, void *, void *, void *, int * );
/* marks a request as complete, extracting the status */
int MPIR_Request_complete(MPI_Request *, MPID_Request *, MPI_Status *, int *);
int MPIR_Request_get_error(MPID_Request *);
/* run the progress engine until the given request is complete */
int MPIR_Progress_wait_request(MPID_Request *req);
/* The following routines perform the callouts to the user routines registered
as part of a generalized request. They handle any language binding issues
that are necessary. They are used when completing, freeing, cancelling or
extracting the status from a generalized request. */
int MPIR_Grequest_cancel(MPID_Request * request_ptr, int complete);
int MPIR_Grequest_query(MPID_Request * request_ptr);
int MPIR_Grequest_free(MPID_Request * request_ptr);
/* this routine was added to support our extension relaxing the progress rules
* for generalized requests */
int MPIR_Grequest_progress_poke(int count, MPID_Request **request_ptrs,
MPI_Status array_of_statuses[] );
int MPIR_Grequest_waitall(int count, MPID_Request * const * request_ptrs);
/* ------------------------------------------------------------------------- */
/* Prototypes for language-specific routines, such as routines to set
Fortran keyval attributes */
#ifdef HAVE_FORTRAN_BINDING
#include "mpi_f77interface.h"
#endif
/* ADI Bindings */
/*@
MPID_Init - Initialize the device
Input Parameters:
+ argc_p - Pointer to the argument count
. argv_p - Pointer to the argument list
- requested - Requested level of thread support. Values are the same as
for the 'required' argument to 'MPI_Init_thread', except that we define
an enum for these values.
Output Parameters:
+ provided - Provided level of thread support. May be less than the
requested level of support.
. has_args - Set to true if 'argc_p' and 'argv_p' contain the command
line arguments. See below.
- has_env - Set to true if the environment of the process has been
set as the user expects. See below.
Return value:
Returns 'MPI_SUCCESS' on success and an MPI error code on failure. Failure
can happen when, for example, the device is unable to start or contact the
number of processes specified by the 'mpiexec' command.
Notes:
Null arguments for 'argc_p' and 'argv_p' `must` be valid (see MPI-2, section
4.2)
Multi-method devices should initialize each method within this call.
They can use environment variables and/or command-line arguments
to decide which methods to initialize (but note that they must not
`depend` on using command-line arguments).
This call also initializes all MPID data needed by the device. This
includes the 'MPID_Request's and any other data structures used by
the device.
The arguments 'has_args' and 'has_env' indicate whether the process was
started with command-line arguments or environment variables. In some
cases, only the root process is started with these values; in others,
the startup environment ensures that each process receives the
command-line arguments and environment variables that the user expects.
While the MPI standard makes no requirements that command line arguments or
environment variables are provided to all processes, most users expect a
common environment. These variables allow an MPI implementation (that is
based on ADI-3) to provide both of these by making use of MPI communication
after 'MPID_Init' is called but before 'MPI_Init' returns to the user, if
the process management environment does not provide this service.
This routine is used to implement both 'MPI_Init' and 'MPI_Init_thread'.
Setting the environment requires a 'setenv' function. Some
systems may not have this. In that case, the documentation must make
clear that the environment may not be propagated to the generated processes.
Module:
MPID_CORE
Questions:
The values for 'has_args' and 'has_env' are boolean.
They could be more specific. For
example, the value could indicate the rank in 'MPI_COMM_WORLD' of a
process that has the values; the value 'MPI_ANY_SOURCE' (or a '-1') could
indicate that the value is available on all processes (including this one).
We may want this since otherwise the processes may need to determine whether
any process needs the command line. Another option would be to use positive
values in the same way that the 'color' argument is used in 'MPI_Comm_split';
a negative value indicates the member of the processes with that color that
has the values of the command line arguments (or environment). This allows
for non-SPMD programs.
Do we require that the startup environment (e.g., whatever 'mpiexec' is
using to start processes) is responsible for delivering
the command line arguments and environment variables that the user expects?
That is, if the user is running an SPMD program, and expects each process
to get the same command line argument, who is responsible for this?
The 'has_args' and 'has_env' values are intended to allow the ADI to
handle this while taking advantage of any support that the process
manager framework may provide.
Alternately, how do we find out from the process management environment
whether it took care of the environment or the command line arguments?
Do we need a 'PMI_Env_query' function that can answer these questions
dynamically (in case a different process manager is used through the same
interface)?
Can we fix the Fortran command-line arguments? That is, can we arrange for
'iargc' and 'getarg' (and the POSIX equivalents) to return the correct
values? See, for example, the Absoft implementations of 'getarg'.
We could also contact PGI about the Portland Group compilers, and of
course the 'g77' source code is available.
Does each process have the same values for the environment variables
when this routine returns?
If we don''t require that all processes get the same argument list,
we need to find out if they did anyway so that 'MPI_Init_thread' can
fixup the list for the user. This argues for another return value that
flags how much of the environment the 'MPID_Init' routine set up
so that the 'MPI_Init_thread' call can provide the rest. The reason
for this is that, even though the MPI standard does not require it,
a user-friendly implementation should, in the SPMD mode, give each
process the same environment and argument lists unless the user
explicitly directed otherwise.
How does this interface to PMI? Do we need to know anything? Should
this call have an info argument to support PMI?
The following questions involve how environment variables and command
line arguments are used to control the behavior of the implementation.
Many of these values must be determined at the time that 'MPID_Init'
is called. These all should be considered in the context of the
parameter routines described in the MPICH Design Document.
Are there recommended environment variable names? For example, in ADI-2,
there are many debugging options that are part of the common device.
In MPI-2, we can''t require command line arguments, so any such options
must also have environment variables. E.g., 'MPICH_ADI_DEBUG' or
'MPICH_ADI_DB'.
Names that are explicitly prohibited? For example, do we want to
reserve any names that 'MPI_Init_thread' (as opposed to 'MPID_Init')
might use?
How does information on command-line arguments and environment variables
recognized by the device get added to the documentation?
What about control for other impact on the environment? For example,
what signals should the device catch (e.g., 'SIGFPE'? 'SIGTRAP'?)?
Which of these should be optional (e.g., ignore or leave signal alone)
or selectable (e.g., port to listen on)? For example, catching 'SIGTRAP'
causes problems for 'gdb', so we''d like to be able to leave 'SIGTRAP'
unchanged in some cases.
Another environment variable should control whether fault-tolerance is
desired. If fault-tolerance is selected, then some collective operations
will need to use different algorithms and most fatal errors detected by the
MPI implementation should abort only the affected process, not all processes.
@*/
int MPID_Init( int *argc_p, char ***argv_p, int requested,
int *provided, int *has_args, int *has_env );
/* was:
int MPID_Init( int *argc_p, char ***argv_p,
int requested, int *provided,
MPID_Comm **parent_comm, int *has_args, int *has_env ); */
/*@
MPID_InitCompleted - Notify the device that the MPI_Init or MPI_Initthread
call has completed setting up MPI
Notes:
This call allows the device to complete any setup that it wishes to perform
and for which it needs to access any of the structures (such as 'MPIR_Process')
that are initialized after 'MPID_Init' is called. If the device does not need
any extra operations, then it may provide either an empty function or even
define this as a macro with the value 'MPI_SUCCESS'.
@*/
int MPID_InitCompleted( void );
/*@
MPID_Finalize - Perform the device-specific termination of an MPI job
Return Value:
'MPI_SUCCESS' or a valid MPI error code. Normally, this routine will
return 'MPI_SUCCESS'. Only in extrordinary circumstances can this
routine fail; for example, if some process stops responding during the
finalize step. In this case, 'MPID_Finalize' should return an MPI
error code indicating the reason that it failed.
Notes:
Module:
MPID_CORE
Questions:
Need to check the MPI-2 requirements on 'MPI_Finalize' with respect to
things like which process must remain after 'MPID_Finalize' is called.
@*/
int MPID_Finalize(void);
/*@
MPID_Abort - Abort at least the processes in the specified communicator.
Input Parameters:
+ comm - Communicator of processes to abort
. mpi_errno - MPI error code containing the reason for the abort
. exit_code - Exit code to return to the calling environment. See notes.
- error_msg - Optional error message
Return value:
'MPI_SUCCESS' or an MPI error code. Normally, this routine should not
return, since the calling process must be a member of the communicator.
However, under some circumstances, the 'MPID_Abort' might fail; in this
case, returning an error indication is appropriate.
Notes:
In a fault-tolerant MPI implementation, this operation should abort `only`
the processes in the specified communicator. Any communicator that shares
processes with the aborted communicator becomes invalid. For more
details, see (paper not yet written on fault-tolerant MPI).
In particular, if the communicator is 'MPI_COMM_SELF', only the calling
process should be aborted.
The 'exit_code' is the exit code that this particular process will
attempt to provide to the 'mpiexec' or other program invocation
environment. See 'mpiexec' for a discussion of how exit codes from
many processes may be combined.
If the error_msg field is non-NULL this string will be used as the message
with the abort output. Otherwise, the output message will be base on the
error message associated with the mpi_errno.
An external agent that is aborting processes can invoke this with either
'MPI_COMM_WORLD' or 'MPI_COMM_SELF'. For example, if the process manager
wishes to abort a group of processes, it should cause 'MPID_Abort' to
be invoked with 'MPI_COMM_SELF' on each process in the group.
Question:
An alternative design is to provide an 'MPID_Group' instead of a
communicator. This would allow a process manager to ask the ADI
to kill an entire group of processes without needing a communicator.
However, the implementation of 'MPID_Abort' will either do this by
communicating with other processes or by requesting the process manager
to kill the processes. That brings up this question: should
'MPID_Abort' use 'PMI' to kill processes? Should it be required to
notify the process manager? What about persistent resources (such
as SYSV segments or forked processes)?
This suggests that for any persistent resource, an exit handler be
defined. These would be executed by 'MPID_Abort' or 'MPID_Finalize'.
See the implementation of 'MPI_Finalize' for an example of exit callbacks.
In addition, code that registered persistent resources could use persistent
storage (i.e., a file) to record that information, allowing cleanup
utilities (such as 'mpiexec') to remove any resources left after the
process exits.
'MPI_Finalize' requires that attributes on 'MPI_COMM_SELF' be deleted
before anything else happens; this allows libraries to attach end-of-job
actions to 'MPI_Finalize'. It is valuable to have a similar
capability on 'MPI_Abort', with the caveat that 'MPI_Abort' may not
guarantee that the run-on-abort routines were called. This provides a
consistent way for the MPICH implementation to handle freeing any
persistent resources. However, such callbacks must be limited since
communication may not be possible once 'MPI_Abort' is called. Further,
any callbacks must guarantee that they have finite termination.
One possible extension would be to allow `users` to add actions to be
run when 'MPI_Abort' is called, perhaps through a special attribute value
applied to 'MPI_COMM_SELF'. Note that is is incorrect to call the delete
functions for the normal attributes on 'MPI_COMM_SELF' because MPI
only specifies that those are run on 'MPI_Finalize' (i.e., normal
termination).
Module:
MPID_CORE
@*/
int MPID_Abort( MPID_Comm *comm, int mpi_errno, int exit_code, const char *error_msg );
int MPID_Open_port(MPID_Info *, char *);
int MPID_Close_port(const char *);
/*@
MPID_Comm_accept - MPID entry point for MPI_Comm_accept
Input Parameters:
+ port_name - port name
. info - info
. root - root
- comm - communicator
Output Parameters:
. MPI_Comm *newcomm - new communicator
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_accept(const char *, MPID_Info *, int, MPID_Comm *, MPID_Comm **);
/*@
MPID_Comm_connect - MPID entry point for MPI_Comm_connect
Input Parameters:
+ port_name - port name
. info - info
. root - root
- comm - communicator
Output Parameters:
. newcomm_ptr - new intercommunicator
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_connect(const char *, MPID_Info *, int, MPID_Comm *, MPID_Comm **);
int MPID_Comm_disconnect(MPID_Comm *);
int MPID_Comm_spawn_multiple(int, char *[], char **[], const int [], MPID_Info* [],
int, MPID_Comm *, MPID_Comm **, int []);
/*@
MPID_Comm_failure_ack - MPID entry point for MPI_Comm_failure_ack
Input Parameters:
. comm - communicator
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_failure_ack(MPID_Comm *comm);
/*@
MPID_Comm_failure_get_acked - MPID entry point for MPI_Comm_failure_get_acked
Input Parameters:
. comm - communicator
Output Parameters
. failed_group_ptr - group of failed processes
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_failure_get_acked(MPID_Comm *comm, MPID_Group **failed_group_ptr);
/*@
MPID_Comm_get_all_failed_procs - Constructs a group of failed processes that it uniform over a communicator
Input Parameters:
. comm - communicator
. tag - Tag used to do communciation
Output Parameters:
. failed_grp - group of all failed processes
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_get_all_failed_procs(MPID_Comm *comm_ptr, MPID_Group **failed_group, int tag);
/*@
MPID_Comm_revoke - MPID entry point for MPI_Comm_revoke
Input Parameters:
comm - communicator
remote - True if we received the revoke message from a remote process
Return Value:
'MPI_SUCCESS' or a valid MPI error code.
@*/
int MPID_Comm_revoke(MPID_Comm *comm, int is_remote);
/*@
MPID_Send - MPID entry point for MPI_Send
Notes:
The only difference between this and 'MPI_Send' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, a context id offset is provided in addition to the
communicator, and a request may be returned. The context offset is
added to the context of the communicator
to get the context it used by the message.
A request is returned only if the ADI implementation was unable to
complete the send of the message. In that case, the usual 'MPI_Wait'
logic should be used to complete the request. This approach is used to
allow a simple implementation of the ADI. The ADI is free to always
complete the message and never return a request.
Module:
Communication
@*/
int MPID_Send( const void *buf, MPI_Aint count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Rsend - MPID entry point for MPI_Rsend
Notes:
The only difference between this and 'MPI_Rsend' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, a context id offset is provided in addition to the
communicator, and a request may be returned. The context offset is
added to the context of the communicator
to get the context it used by the message.
A request is returned only if the ADI implementation was unable to
complete the send of the message. In that case, the usual 'MPI_Wait'
logic should be used to complete the request. This approach is used to
allow a simple implementation of the ADI. The ADI is free to always
complete the message and never return a request.
Module:
Communication
@*/
int MPID_Rsend( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Ssend - MPID entry point for MPI_Ssend
Notes:
The only difference between this and 'MPI_Ssend' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, a context id offset is provided in addition to the
communicator, and a request may be returned. The context offset is
added to the context of the communicator
to get the context it used by the message.
A request is returned only if the ADI implementation was unable to
complete the send of the message. In that case, the usual 'MPI_Wait'
logic should be used to complete the request. This approach is used to
allow a simple implementation of the ADI. The ADI is free to always
complete the message and never return a request.
Module:
Communication
@*/
int MPID_Ssend( const void *buf, MPI_Aint count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_tBsend - Attempt a send and return if it would block
Notes:
This has the semantics of 'MPI_Bsend', except that it returns the internal
error code 'MPID_WOULD_BLOCK' if the message can''t be sent immediately
(t is for "try").
The reason that this interface is chosen over a query to check whether
a message `can` be sent is that the query approach is not
thread-safe. Since the decision on whether a message can be sent
without blocking depends (among other things) on the state of flow
control managed by the device, this approach also gives the device
the greatest freedom in implementing flow control. In particular,
if another MPI process can change the flow control parameters, then
even in a single-threaded implementation, it would not be safe to
return, for example, a message size that could be sent with 'MPI_Bsend'.
This routine allows an MPI implementation to optimize 'MPI_Bsend'
for the case when the message can be delivered without blocking the
calling process. An ADI implementation is free to have this routine
always return 'MPID_WOULD_BLOCK', but is encouraged not to.
To allow the MPI implementation to avoid trying this routine when it
is not implemented by the ADI, the C preprocessor constant 'MPID_HAS_TBSEND'
should be defined if this routine has a nontrivial implementation.
This is an optional routine. The MPI code for 'MPI_Bsend' will attempt
to call this routine only if the device defines 'MPID_HAS_TBSEND'.
Module:
Communication
@*/
int MPID_tBsend( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset );
/*@
MPID_Isend - MPID entry point for MPI_Isend
Notes:
The only difference between this and 'MPI_Isend' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Isend( const void *buf, MPI_Aint count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Irsend - MPID entry point for MPI_Irsend
Notes:
The only difference between this and 'MPI_Irsend' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Irsend( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Issend - MPID entry point for MPI_Issend
Notes:
The only difference between this and 'MPI_Issend' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Issend( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Recv - MPID entry point for MPI_Recv
Notes:
The only difference between this and 'MPI_Recv' is that the basic
error checks (e.g., valid communicator, datatype, source, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, a context id offset is provided in addition to the
communicator, and a request may be returned. The context offset is added
to the context of the communicator to get the context it used by the message.
As in 'MPID_Send', the request is returned only if the operation did not
complete. Conversely, the status object is populated with valid information
only if the operation completed.
Module:
Communication
@*/
int MPID_Recv( void *buf, MPI_Aint count, MPI_Datatype datatype,
int source, int tag, MPID_Comm *comm, int context_offset,
MPI_Status *status, MPID_Request **request );
/*@
MPID_Irecv - MPID entry point for MPI_Irecv
Notes:
The only difference between this and 'MPI_Irecv' is that the basic
error checks (e.g., valid communicator, datatype, source, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Irecv( void *buf, MPI_Aint count, MPI_Datatype datatype,
int source, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Send_init - MPID entry point for MPI_Send_init
Notes:
The only difference between this and 'MPI_Send_init' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Send_init( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
int MPID_Bsend_init(const void *, int, MPI_Datatype, int, int, MPID_Comm *,
int, MPID_Request **);
/*@
MPID_Rsend_init - MPID entry point for MPI_Rsend_init
Notes:
The only difference between this and 'MPI_Rsend_init' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Rsend_init( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Ssend_init - MPID entry point for MPI_Ssend_init
Notes:
The only difference between this and 'MPI_Ssend_init' is that the basic
error checks (e.g., valid communicator, datatype, dest, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Ssend_init( const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Recv_init - MPID entry point for MPI_Recv_init
Notes:
The only difference between this and 'MPI_Recv_init' is that the basic
error checks (e.g., valid communicator, datatype, source, and tag)
have been made, the MPI opaque objects have been replaced by
MPID objects, and a context id offset is provided in addition to the
communicator. This offset is added to the context of the communicator
to get the context it used by the message.
Module:
Communication
@*/
int MPID_Recv_init( void *buf, int count, MPI_Datatype datatype,
int source, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **request );
/*@
MPID_Startall - MPID entry point for MPI_Startall
Notes:
The only difference between this and 'MPI_Startall' is that the basic
error checks (e.g., count) have been made, and the MPI opaque objects
have been replaced by pointers to MPID objects.
Rationale:
This allows the device to schedule communication involving multiple requests,
whereas an implementation built on just 'MPID_Start' would force the
ADI to initiate the communication in the order encountered.
@*/
int MPID_Startall(int count, MPID_Request *requests[]);
/*@
MPID_Probe - Block until a matching request is found and return information
about it
Input Parameters:
+ source - rank to match (or 'MPI_ANY_SOURCE')
. tag - Tag to match (or 'MPI_ANY_TAG')
. comm - communicator to match.
- context_offset - context id offset of communicator to match
Output Parameter:
. status - 'MPI_Status' set as defined by 'MPI_Probe'
Return Value:
Error code.
Notes:
Note that the values returned in 'status' will be valid for a subsequent
MPI receive operation only if no other thread attempts to receive the same
message.
(See the
discussion of probe in Section 8.7.2 Clarifications of the MPI-2 standard.)
Providing the 'context_offset' is necessary at this level to support the
way in which the MPICH implementation uses context ids in the implementation
of other operations. The communicator is present to allow the device
to use message-queues attached to particular communicators or connections
between processes.
Module:
Request
@*/
int MPID_Probe(int, int, MPID_Comm *, int, MPI_Status *);
/*@
MPID_Iprobe - Look for a matching request in the receive queue
but do not remove or return it
Input Parameters:
+ source - rank to match (or 'MPI_ANY_SOURCE')
. tag - Tag to match (or 'MPI_ANY_TAG')
. comm - communicator to match.
- context_offset - context id offset of communicator to match
Output Parameter:
+ flag - true if a matching request was found, false otherwise.
- status - 'MPI_Status' set as defined by 'MPI_Iprobe' (only valid when return
flag is true).
Return Value:
Error Code.
Notes:
Note that the values returned in 'status' will be valid for a subsequent
MPI receive operation only if no other thread attempts to receive the same
message.
(See the
discussion of probe in Section 8.7.2 (Clarifications) of the MPI-2 standard.)
Providing the 'context_offset' is necessary at this level to support the
way in which the MPICH implementation uses context ids in the implementation
of other operations. The communicator is present to allow the device
to use message-queues attached to particular communicators or connections
between processes.
Devices that rely solely on polling to make progress should call
MPID_Progress_poke() (or some equivalent function) if a matching request
could not be found. This insures that progress continues to be made even if
the application is calling MPI_Iprobe() from within a loop not containing
calls to any other MPI functions.
Module:
Request
@*/
int MPID_Iprobe(int, int, MPID_Comm *, int, int *, MPI_Status *);
/*@
MPID_Mprobe - Block until a matching request is found and return information
about it, including a message handle for later reception.
Input Parameters:
+ source - rank to match (or 'MPI_ANY_SOURCE')
. tag - Tag to match (or 'MPI_ANY_TAG')
. comm - communicator to match.
- context_offset - context id offset of communicator to match
Output Parameter:
+ message - 'MPID_Request' (logically a message) set as defined by 'MPI_Mprobe'
- status - 'MPI_Status' set as defined by 'MPI_Mprobe'
Return Value:
Error code.
Providing the 'context_offset' is necessary at this level to support the
way in which the MPICH implementation uses context ids in the implementation
of other operations. The communicator is present to allow the device
to use message-queues attached to particular communicators or connections
between processes.
Module:
Request
@*/
int MPID_Mprobe(int source, int tag, MPID_Comm *comm, int context_offset,
MPID_Request **message, MPI_Status *status);
/*@
MPID_Improbe - Look for a matching request in the receive queue and return
information about it, including a message handle for later reception.
Input Parameters:
+ source - rank to match (or 'MPI_ANY_SOURCE')
. tag - Tag to match (or 'MPI_ANY_TAG')
. comm - communicator to match.
- context_offset - context id offset of communicator to match
Output Parameter:
+ flag - 'flag' set as defined by 'MPI_Improbe'
. message - 'MPID_Request' (logically a message) set as defined by 'MPI_Improbe'
- status - 'MPI_Status' set as defined by 'MPI_Improbe'
Return Value:
Error code.
Providing the 'context_offset' is necessary at this level to support the
way in which the MPICH implementation uses context ids in the implementation
of other operations. The communicator is present to allow the device
to use message-queues attached to particular communicators or connections
between processes.
Module:
Request
@*/
int MPID_Improbe(int source, int tag, MPID_Comm *comm, int context_offset,
int *flag, MPID_Request **message, MPI_Status *status);
/*@
MPID_Imrecv - Begin receiving the message indicated by the given message
handle and return a request object for later completion.
Input Parameters:
+ count - number of elements to receive
. datatype - datatype of each recv buffer element
- message - 'MPID_Request' (logically a message) set as defined by 'MPI_Mprobe'
Output Parameter:
+ buf - receive buffer
- request - request object for completing the recv
Return Value:
Error code.
Module:
Request
NOTE: under most implementations the request object returned will
probably be some modified version of the "message" object passed in.
@*/
int MPID_Imrecv(void *buf, int count, MPI_Datatype datatype,
MPID_Request *message, MPID_Request **rreqp);
/*@
MPID_Mrecv - Receive the message indicated by the given message handle.
Input Parameters:
+ count - number of elements to receive
. datatype - datatype of each recv buffer element
- message - 'MPID_Request' (logically a message) set as defined by 'MPI_Mprobe'
Output Parameter:
+ buf - receive buffer
- status - 'MPI_Status' set as defined by 'MPI_Mrecv'
Return Value:
Error code.
Module:
Request
NOTE: under most implementations the request object returned will
probably be some modified version of the "message" object passed in.
@*/
int MPID_Mrecv(void *buf, int count, MPI_Datatype datatype,
MPID_Request *message, MPI_Status *status);
/*@
MPID_Cancel_send - Cancel the indicated send request
Input Parameter:
. request - Send request to cancel
Return Value:
MPI error code.
Notes:
Cancel is a tricky operation, particularly for sends. Read the
discussion in the MPI-1 and MPI-2 documents carefully. This call
only requests that the request be cancelled; a subsequent wait
or test must first succeed (i.e., the request completion counter must be
zeroed).
Module:
Request
@*/
int MPID_Cancel_send(MPID_Request *);
/*@
MPID_Cancel_recv - Cancel the indicated recv request
Input Parameter:
. request - Receive request to cancel
Return Value:
MPI error code.
Notes:
This cancels a pending receive request. In many cases, this is implemented
by simply removing the request from a pending receive request queue.
However, some ADI implementations may maintain these queues in special
places, such as within a NIC (Network Interface Card).
This call only requests that the request be cancelled; a subsequent wait
or test must first succeed (i.e., the request completion counter must be
zeroed).
Module:
Request
@*/
int MPID_Cancel_recv(MPID_Request *);
/*@
MPID_Comm_AS_enabled - Query whether anysource operations are enabled for a communicator
Input Parameter:
communicator - Communicator being queried
Return Value:
0 - The communicator will not currently permit anysource operations
1 - The communicator will currently permit anysource operations
@*/
int MPID_Comm_AS_enabled(MPID_Comm *);
/*@
MPID_Request_is_anysource - Query whether the request is an anysource receive
Input Parameter:
request - Receive request being queried
Return Value:
0 - The request is not anysource
1 - The request is anysource
@*/
int MPID_Request_is_anysource(MPID_Request *);
/*@
MPID_Aint_add - Returns the sum of base and disp
Input Parameters:
+ base - base address (integer)
- disp - displacement (integer)
Return value:
Sum of the base and disp argument
@*/
MPI_Aint MPID_Aint_add(MPI_Aint base, MPI_Aint disp);
/*@
MPID_Aint_diff - Returns the difference between addr1 and addr2
Input Parameters:
+ addr1 - minuend address (integer)
- addr2 - subtrahend address (integer)
Return value:
Difference between addr1 and addr2
@*/
MPI_Aint MPID_Aint_diff(MPI_Aint addr1, MPI_Aint addr2);
/* MPI-2 RMA Routines */
int MPID_Win_create(void *, MPI_Aint, int, MPID_Info *, MPID_Comm *,
MPID_Win **);
int MPID_Win_free(MPID_Win **);
int MPID_Put(const void *, int, MPI_Datatype, int, MPI_Aint, int,
MPI_Datatype, MPID_Win *);
int MPID_Get(void *, int, MPI_Datatype, int, MPI_Aint, int,
MPI_Datatype, MPID_Win *);
int MPID_Accumulate(const void *, int, MPI_Datatype, int, MPI_Aint, int,
MPI_Datatype, MPI_Op, MPID_Win *);
int MPID_Win_fence(int, MPID_Win *);
int MPID_Win_post(MPID_Group *group_ptr, int assert, MPID_Win *win_ptr);
int MPID_Win_start(MPID_Group *group_ptr, int assert, MPID_Win *win_ptr);
int MPID_Win_test(MPID_Win *win_ptr, int *flag);
int MPID_Win_wait(MPID_Win *win_ptr);
int MPID_Win_complete(MPID_Win *win_ptr);
int MPID_Win_lock(int lock_type, int dest, int assert, MPID_Win *win_ptr);
int MPID_Win_unlock(int dest, MPID_Win *win_ptr);
/* MPI-3 RMA Routines */
int MPID_Win_allocate(MPI_Aint size, int disp_unit, MPID_Info *info,
MPID_Comm *comm, void *baseptr, MPID_Win **win);
int MPID_Win_allocate_shared(MPI_Aint size, int disp_unit, MPID_Info *info_ptr, MPID_Comm *comm_ptr,
void *base_ptr, MPID_Win **win_ptr);
int MPID_Win_shared_query(MPID_Win *win, int rank, MPI_Aint *size, int *disp_unit,
void *baseptr);
int MPID_Win_create_dynamic(MPID_Info *info, MPID_Comm *comm, MPID_Win **win);
int MPID_Win_attach(MPID_Win *win, void *base, MPI_Aint size);
int MPID_Win_detach(MPID_Win *win, const void *base);
int MPID_Win_get_info(MPID_Win *win, MPID_Info **info_used);
int MPID_Win_set_info(MPID_Win *win, MPID_Info *info);
int MPID_Get_accumulate(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, void *result_addr, int result_count,
MPI_Datatype result_datatype, int target_rank, MPI_Aint target_disp,
int target_count, MPI_Datatype target_datatype, MPI_Op op, MPID_Win *win);
int MPID_Fetch_and_op(const void *origin_addr, void *result_addr,
MPI_Datatype datatype, int target_rank, MPI_Aint target_disp,
MPI_Op op, MPID_Win *win);
int MPID_Compare_and_swap(const void *origin_addr, const void *compare_addr,
void *result_addr, MPI_Datatype datatype, int target_rank,
MPI_Aint target_disp, MPID_Win *win);
int MPID_Rput(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank, MPI_Aint target_disp,
int target_count, MPI_Datatype target_datatype, MPID_Win *win,
MPID_Request **request);
int MPID_Rget(void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank, MPI_Aint target_disp,
int target_count, MPI_Datatype target_datatype, MPID_Win *win,
MPID_Request **request);
int MPID_Raccumulate(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank, MPI_Aint target_disp,
int target_count, MPI_Datatype target_datatype, MPI_Op op, MPID_Win *win,
MPID_Request **request);
int MPID_Rget_accumulate(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, void *result_addr, int result_count,
MPI_Datatype result_datatype, int target_rank, MPI_Aint target_disp,
int target_count, MPI_Datatype target_datatype, MPI_Op op, MPID_Win *win,
MPID_Request **request);
int MPID_Win_lock_all(int assert, MPID_Win *win);
int MPID_Win_unlock_all(MPID_Win *win);
int MPID_Win_flush(int rank, MPID_Win *win);
int MPID_Win_flush_all(MPID_Win *win);
int MPID_Win_flush_local(int rank, MPID_Win *win);
int MPID_Win_flush_local_all(MPID_Win *win);
int MPID_Win_sync(MPID_Win *win);
/*@
MPID_Progress_start - Begin a block of operations that check the completion
counters in requests.
Input parameters:
. state - pointer to a progress state variable
Notes:
This routine is informs the progress engine that a block of code follows that
will examine the completion counter of some 'MPID_Request' objects and then
call 'MPID_Progress_wait' zero or more times followed by a call to
'MPID_Progress_end'.
The progress state variable must be specific to the thread calling it. If at
all possible, the state should be declared as an auto variable and thus
allocated on the stack of the current thread. Thread specific storage could
be used instead, but doing such would incur additional (and typically
unnecessary) overhead.
This routine is needed to properly implement blocking tests when
multithreaded progress engines are used. In a single-threaded implementation
of the ADI, this may be defined as an empty macro.
Module:
Communication
@*/
void MPID_Progress_start(MPID_Progress_state * state);
/*@
MPID_Progress_wait - Wait for some communication since 'MPID_Progress_start'
Input parameters:
. state - pointer to the progress state initialized by MPID_Progress_start
Return value:
An mpi error code.
Notes:
This instructs the progress engine to wait until some communication event
happens since 'MPID_Progress_start' was called. This call blocks the
calling thread (only, not the process).
Module:
Communication
@*/
int MPID_Progress_wait(MPID_Progress_state * state);
/*@
MPID_Progress_end - End a block of operations begun with 'MPID_Progress_start'
Input parameters:
. state - pointer to the progress state variable passed to
'MPID_Progress_start'
Notes:
This routine instructs the progress engine to end the block begun with
'MPID_Progress_start'. The progress engine is not required to check for any
pending communication.
The purpose of this call is to release any locks initiated by
'MPID_Progess_start' or 'MPID_Progess_wait'. In a single threaded ADI
implementation, this may be defined as an empty macro.
Module:
Communication
@*/
void MPID_Progress_end(MPID_Progress_state * stae);
/*@
MPID_Progress_test - Check for communication
Return value:
An mpi error code.
Notes:
Unlike 'MPID_Progress_wait', this routine is nonblocking. Therefore, it
does not require the use of 'MPID_Progress_start' and 'MPID_Progress_end'.
Module:
Communication
@*/
int MPID_Progress_test(void);
/*@
MPID_Progress_poke - Allow a progress engine to check for pending
communication
Return value:
An mpi error code.
Notes:
This routine provides a way to invoke the progress engine in a polling
implementation of the ADI. This routine must be nonblocking.
A multithreaded implementation is free to define this as an empty macro.
Module:
Communication
@*/
int MPID_Progress_poke(void);
/*@
MPID_Request_create - Create and return a bare request
Return value:
A pointer to a new request object.
Notes:
This routine is intended for use by 'MPI_Grequest_start' only. Note that
once a request is created with this routine, any progress engine must assume
that an outside function can complete a request with
'MPID_Request_complete'.
The request object returned by this routine should be initialized such that
ref_count is one and handle contains a valid handle referring to the object.
@*/
MPID_Request * MPID_Request_create(void);
/*@
MPID_Request_release - Release a request
Input Parameter:
. request - request to release
Notes:
This routine is called to release a reference to request object. If
the reference count of the request object has reached zero, the object will
be deallocated.
Module:
Request
@*/
void MPID_Request_release(MPID_Request *);
/*@
MPID_Request_complete - Complete a request
Input Parameter:
. request - request to complete
Notes:
This routine is called to decrement the completion count of a
request object. If the completion count of the request object has
reached zero, the reference count for the object will be
decremented.
Module:
Request
@*/
int MPID_Request_complete(MPID_Request *);
typedef struct MPID_Grequest_class {
MPIU_OBJECT_HEADER; /* adds handle and ref_count fields */
MPI_Grequest_query_function *query_fn;
MPI_Grequest_free_function *free_fn;
MPI_Grequest_cancel_function *cancel_fn;
MPIX_Grequest_poll_function *poll_fn;
MPIX_Grequest_wait_function *wait_fn;
struct MPID_Grequest_class *next;
} MPID_Grequest_class;
/* Interfaces exposed by MPI_T */
#include "mpit.h"
/*TTopoOverview.tex
*
* The MPI collective and topology routines can benefit from information
* about the topology of the underlying interconnect. Unfortunately, there
* is no best form for the representation (the MPI-1 Forum tried to define
* such a representation, but was unable to). One useful decomposition
* that has been used in cluster enviroments is a hierarchical decomposition.
*
* The other obviously useful topology information would match the needs of
* 'MPI_Cart_create'. However, it may be simpler to for the device to
* implement this routine directly.
*
* Other useful information could be the topology information that matches
* the needs of the collective operation, such as spanning trees and rings.
* These may be added to ADI3 later.
*
* Question: Should we define a cart create function? Dims create?
*
* Usage:
* This routine has nothing to do with the choice of communication method
* that a implementation of the ADI may make. It is intended only to
* communicate information on the heirarchy of processes, if any, to
* the implementation of the collective communication routines. This routine
* may also be useful for the MPI Graph topology functions.
*
T*/
/*@
MPID_Topo_cluster_info - Return information on the hierarchy of
interconnections
Input Parameter:
. comm - Communicator to study. May be 'NULL', in which case 'MPI_COMM_WORLD'
is the effective communicator.
Output Parameters:
+ levels - The number of levels in the hierarchy.
To simplify the use of this routine, the maximum value is
'MPID_TOPO_CLUSTER_MAX_LEVELS' (typically 8 or less).
. my_cluster - For each level, the id of the cluster that the calling process
belongs to.
- my_rank - For each level, the rank of the calling process in its cluster
Notes:
This routine returns a description of the system in terms of nested
clusters of processes. Levels are numbered from zero. At each level,
each process may belong to no more than cluster; if a process is in any
cluster at level i, it must be in some cluster at level i-1.
The communicator argument allows this routine to be used in the dynamic
process case (i.e., with communicators that are created after 'MPI_Init'
and that involve processes that are not part of 'MPI_COMM_WORLD').
For non-hierarchical systems, this routine simply returns a single
level containing all processes.
Sample Outputs:
For a single, switch-connected cluster or a uniform-memory-access (UMA)
symmetric multiprocessor (SMP), the return values could be
.vb
level my_cluster my_rank
0 0 rank in comm_world
.ve
This is also a valid response for `any` device.
For a switch-connected cluster of 2 processor SMPs
.vb
level my_cluster my_rank
0 0 rank in comm_world
1 0 to p/2 0 or 1
.ve
where the value each process on the same SMP has the same value for
'my_cluster[1]' and a different value for 'my_rank[1]'.
For two SMPs connected by a network,
.vb
level my_cluster my_rank
0 0 rank in comm_world
1 0 or 1 0 to # on SMP
.ve
An example with more than 2 levels is a collection of clusters, each with
SMP nodes.
Limitations:
This approach does not provide a representations for topologies that
are not hierarchical. For example, a mesh interconnect is a single-level
cluster in this view.
Module:
Topology
@*/
int MPID_Topo_cluster_info( MPID_Comm *comm,
int *levels, int my_cluster[], int my_rank[] );
/*@
MPID_Get_processor_name - Return the name of the current processor
Input Parameter:
. namelen - Length of name
Output Parameters:
+ name - A unique specifier for the actual (as opposed to virtual) node. This
must be an array of size at least 'MPI_MAX_PROCESSOR_NAME'.
- resultlen - Length (in characters) of the name. If this pointer is null,
this value is not set.
Notes:
The name returned should identify a particular piece of hardware;
the exact format is implementation defined. This name may or may not
be the same as might be returned by 'gethostname', 'uname', or 'sysinfo'.
This routine is essentially an MPID version of 'MPI_Get_processor_name' .
It must be part of the device because not all environments support calls
to return the processor name. The additional argument (input name
length) is used to provide better error checking and to ensure that
the input buffer is large enough (rather than assuming that it is
'MPI_MAX_PROCESSOR_NAME' long).
@*/
int MPID_Get_processor_name( char *name, int namelen, int *resultlen);
void MPID_Errhandler_free(MPID_Errhandler *errhan_ptr);
/*@
MPID_Get_universe_size - Return the number of processes that the current
process management environment can handle
Output Parameters:
. universe_size - the universe size; MPIR_UNIVERSE_SIZE_NOT_AVAILABLE if the
size cannot be determined
Return value:
A MPI error code.
@*/
int MPID_Get_universe_size(int * universe_size);
#define MPIR_UNIVERSE_SIZE_NOT_SET -1
#define MPIR_UNIVERSE_SIZE_NOT_AVAILABLE -2
/*@
MPID_Comm_get_lpid - Get the local process id that corresponds to a
comm rank.
Notes:
The local process ids are described elsewhere. Basically, they are
a nonnegative number by which this process can refer to other processes
to which it is connected. These are local process ids because different
processes may use different ids to identify the same target process
@*/
int MPID_Comm_get_lpid(MPID_Comm *comm_ptr, int idx, int * lpid_ptr, MPIU_BOOL is_remote);
/* prototypes and declarations for the MPID_Sched interface for nonblocking
* collectives */
#include "mpir_nbc.h"
/* Include definitions from the device which require items defined by this
file (mpiimpl.h). */
#include "mpidpost.h"
/* tunable cvar values */
#include "mpich_cvars.h"
/* Tags for point to point operations which implement collective and other
internal operations */
#define MPIR_BARRIER_TAG 1
#define MPIR_BCAST_TAG 2
#define MPIR_GATHER_TAG 3
#define MPIR_GATHERV_TAG 4
#define MPIR_SCATTER_TAG 5
#define MPIR_SCATTERV_TAG 6
#define MPIR_ALLGATHER_TAG 7
#define MPIR_ALLGATHERV_TAG 8
#define MPIR_ALLTOALL_TAG 9
#define MPIR_ALLTOALLV_TAG 10
#define MPIR_REDUCE_TAG 11
#define MPIR_USER_REDUCE_TAG 12
#define MPIR_USER_REDUCEA_TAG 13
#define MPIR_ALLREDUCE_TAG 14
#define MPIR_USER_ALLREDUCE_TAG 15
#define MPIR_USER_ALLREDUCEA_TAG 16
#define MPIR_REDUCE_SCATTER_TAG 17
#define MPIR_USER_REDUCE_SCATTER_TAG 18
#define MPIR_USER_REDUCE_SCATTERA_TAG 19
#define MPIR_SCAN_TAG 20
#define MPIR_USER_SCAN_TAG 21
#define MPIR_USER_SCANA_TAG 22
#define MPIR_LOCALCOPY_TAG 23
#define MPIR_EXSCAN_TAG 24
#define MPIR_ALLTOALLW_TAG 25
#define MPIR_TOPO_A_TAG 26
#define MPIR_TOPO_B_TAG 27
#define MPIR_REDUCE_SCATTER_BLOCK_TAG 28
#define MPIR_SHRINK_TAG 29
#define MPIR_AGREE_TAG 30
#define MPIR_FIRST_NBC_TAG 31
/* These macros must be used carefully. These macros will not work with
* negative tags. By definition, users are not to use negative tags and the
* only negative tag in MPICH is MPI_ANY_TAG which is checked seperately, but
* if there is a time where negative tags become more common, this setup won't
* work anymore. */
/* This bitmask can be used to manually mask the tag space wherever it might
* be necessary to do so (for instance in the receive queue */
#define MPIR_TAG_ERROR_BIT (1 << 30)
/* This bitmask is used to differentiate between a process failure
* (MPIX_ERR_PROC_FAILED) and any other kind of failure (MPI_ERR_OTHER). */
#define MPIR_TAG_PROC_FAILURE_BIT (1 << 29)
/* This macro checks the value of the error bit in the MPI tag and returns 1
* if the tag is set and 0 if it is not. */
#define MPIR_TAG_CHECK_ERROR_BIT(tag) ((MPIR_TAG_ERROR_BIT & (tag)) == MPIR_TAG_ERROR_BIT ? 1 : 0)
/* This macro checks the value of the process failure bit in the MPI tag and
* returns 1 if the tag is set and 0 if it is not. */
#define MPIR_TAG_CHECK_PROC_FAILURE_BIT(tag) ((MPIR_TAG_PROC_FAILURE_BIT & (tag)) == MPIR_TAG_PROC_FAILURE_BIT ? 1 : 0)
/* This macro sets the value of the error bit in the MPI tag to 1 */
#define MPIR_TAG_SET_ERROR_BIT(tag) ((tag) |= MPIR_TAG_ERROR_BIT)
/* This macro sets the value of the process failure bit in the MPI tag to 1 */
#define MPIR_TAG_SET_PROC_FAILURE_BIT(tag) ((tag) |= (MPIR_TAG_ERROR_BIT | MPIR_TAG_PROC_FAILURE_BIT))
/* This macro clears the value of the error bits in the MPI tag */
#define MPIR_TAG_CLEAR_ERROR_BITS(tag) ((tag) &= ~(MPIR_TAG_ERROR_BIT ^ MPIR_TAG_PROC_FAILURE_BIT))
/* This macro masks the value of the error bits in the MPI tag */
#define MPIR_TAG_MASK_ERROR_BITS(tag) ((tag) & ~(MPIR_TAG_ERROR_BIT ^ MPIR_TAG_PROC_FAILURE_BIT))
/* These functions are used in the implementation of collective and
other internal operations. They are wrappers around MPID send/recv
functions. They do sends/receives by setting the context offset to
MPID_CONTEXT_INTRA(INTER)_COLL. */
int MPIR_Localcopy(const void *sendbuf, MPI_Aint sendcount, MPI_Datatype sendtype,
void *recvbuf, MPI_Aint recvcount, MPI_Datatype recvtype);
int MPIC_Wait(MPID_Request * request_ptr, MPIR_Errflag_t *errflag);
int MPIC_Probe(int source, int tag, MPI_Comm comm, MPI_Status *status);
/* FT versions of te MPIC_ functions */
int MPIC_Send(const void *buf, MPI_Aint count, MPI_Datatype datatype, int dest, int tag,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIC_Recv(void *buf, MPI_Aint count, MPI_Datatype datatype, int source, int tag,
MPID_Comm *comm_ptr, MPI_Status *status, MPIR_Errflag_t *errflag);
int MPIC_Ssend(const void *buf, MPI_Aint count, MPI_Datatype datatype, int dest, int tag,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIC_Sendrecv(const void *sendbuf, MPI_Aint sendcount, MPI_Datatype sendtype,
int dest, int sendtag, void *recvbuf, MPI_Aint recvcount,
MPI_Datatype recvtype, int source, int recvtag,
MPID_Comm *comm_ptr, MPI_Status *status, MPIR_Errflag_t *errflag);
int MPIC_Sendrecv_replace(void *buf, int count, MPI_Datatype datatype,
int dest, int sendtag,
int source, int recvtag,
MPID_Comm *comm_ptr, MPI_Status *status, MPIR_Errflag_t *errflag);
int MPIC_Isend(const void *buf, MPI_Aint count, MPI_Datatype datatype, int dest, int tag,
MPID_Comm *comm_ptr, MPID_Request **request, MPIR_Errflag_t *errflag);
int MPIC_Issend(const void *buf, MPI_Aint count, MPI_Datatype datatype, int dest, int tag,
MPID_Comm *comm_ptr, MPID_Request **request, MPIR_Errflag_t *errflag);
int MPIC_Irecv(void *buf, MPI_Aint count, MPI_Datatype datatype, int source,
int tag, MPID_Comm *comm_ptr, MPID_Request **request);
int MPIC_Waitall(int numreq, MPID_Request *requests[], MPI_Status statuses[], MPIR_Errflag_t *errflag);
void MPIR_MAXF ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_MINF ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_SUM ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_PROD ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_LAND ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_BAND ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_LOR ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_BOR ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_LXOR ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_BXOR ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_MAXLOC ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_MINLOC ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_REPLACE ( void *, void *, int *, MPI_Datatype * ) ;
void MPIR_NO_OP ( void *, void *, int *, MPI_Datatype * ) ;
int MPIR_MAXF_check_dtype ( MPI_Datatype ) ;
int MPIR_MINF_check_dtype ( MPI_Datatype ) ;
int MPIR_SUM_check_dtype ( MPI_Datatype ) ;
int MPIR_PROD_check_dtype ( MPI_Datatype ) ;
int MPIR_LAND_check_dtype ( MPI_Datatype ) ;
int MPIR_BAND_check_dtype ( MPI_Datatype ) ;
int MPIR_LOR_check_dtype ( MPI_Datatype ) ;
int MPIR_BOR_check_dtype ( MPI_Datatype ) ;
int MPIR_LXOR_check_dtype ( MPI_Datatype ) ;
int MPIR_BXOR_check_dtype ( MPI_Datatype ) ;
int MPIR_MAXLOC_check_dtype ( MPI_Datatype ) ;
int MPIR_MINLOC_check_dtype ( MPI_Datatype ) ;
int MPIR_REPLACE_check_dtype ( MPI_Datatype ) ;
int MPIR_NO_OP_check_dtype ( MPI_Datatype ) ;
#define MPIR_PREDEF_OP_COUNT 14
extern MPI_User_function *MPIR_Op_table[];
typedef int (MPIR_Op_check_dtype_fn) ( MPI_Datatype );
extern MPIR_Op_check_dtype_fn *MPIR_Op_check_dtype_table[];
#define MPIR_OP_HDL_TO_FN(op) MPIR_Op_table[((op)&0xf) - 1]
#define MPIR_OP_HDL_TO_DTYPE_FN(op) MPIR_Op_check_dtype_table[((op)&0xf) - 1]
#if !defined MPIR_MIN
#define MPIR_MIN(a,b) (((a)>(b))?(b):(a))
#endif /* MPIR_MIN */
#if !defined MPIR_MAX
#define MPIR_MAX(a,b) (((b)>(a))?(b):(a))
#endif /* MPIR_MAX */
int MPIR_Type_is_rma_atomic(MPI_Datatype type);
int MPIR_Compare_equal(const void *a, const void *b, MPI_Datatype type);
int MPIR_Allgather_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgather_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgather_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgatherv_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int *recvcounts, const int *displs,
MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int *recvcounts, const int *displs,
MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allgatherv_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int *recvcounts, const int *displs,
MPI_Datatype recvtype, MPID_Comm *comm_pt, MPIR_Errflag_t *errflag );
int MPIR_Allgatherv_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int *recvcounts, const int *displs,
MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Allreduce_impl(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Allreduce(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Allreduce_intra(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Allreduce_inter(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoall_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoall(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoall_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoall_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoallv_impl(const void *sendbuf, const int *sendcnts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcnts,
const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPIR_Errflag_t *errflag);
int MPIR_Alltoallv(const void *sendbuf, const int *sendcnts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcnts,
const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoallv_intra(const void *sendbuf, const int *sendcnts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcnts,
const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr,
MPIR_Errflag_t *errflag);
int MPIR_Alltoallv_inter(const void *sendbuf, const int *sendcnts, const int *sdispls,
MPI_Datatype sendtype, void *recvbuf, const int *recvcnts,
const int *rdispls, MPI_Datatype recvtype,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Alltoallw_impl(const void *sendbuf, const int *sendcnts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcnts,
const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr,
MPIR_Errflag_t *errflag);
int MPIR_Alltoallw(const void *sendbuf, const int *sendcnts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcnts,
const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr,
MPIR_Errflag_t *errflag);
int MPIR_Alltoallw_intra(const void *sendbuf, const int *sendcnts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcnts,
const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr,
MPIR_Errflag_t *errflag);
int MPIR_Alltoallw_inter(const void *sendbuf, const int *sendcnts, const int *sdispls,
const MPI_Datatype *sendtypes, void *recvbuf,
const int *recvcnts, const int *rdispls, const MPI_Datatype *recvtypes,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Bcast_inter(void *buffer, int count, MPI_Datatype datatype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Bcast_intra (void *buffer, int count, MPI_Datatype datatype, int
root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Bcast (void *buffer, int count, MPI_Datatype datatype, int
root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Bcast_impl (void *buffer, int count, MPI_Datatype datatype, int
root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Exscan(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Exscan_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Gather_impl (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Gather (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Gather_intra (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Gather_inter (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Gatherv (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, const int *recvcnts, const int *displs,
MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Gatherv_impl (const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, const int *recvcnts, const int *displs,
MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_scatter_impl(const void *sendbuf, void *recvbuf, const int *recvcnts,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_scatter(const void *sendbuf, void *recvbuf, const int *recvcnts,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_scatter_intra(const void *sendbuf, void *recvbuf, const int *recvcnts,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_scatter_inter(const void *sendbuf, void *recvbuf, const int *recvcnts,
MPI_Datatype datatype, MPI_Op op,
MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_scatter_block_impl(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce_scatter_block_intra(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce_scatter_block_inter(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce_intra(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Reduce_inter (const void *sendbuf, void *recvbuf, int count, MPI_Datatype
datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Scan_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Scan(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype,
MPI_Op op, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Scatter_impl(const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Scatter(const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Scatter_intra(const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Scatter_inter(const void *sendbuf, int sendcnt, MPI_Datatype sendtype,
void *recvbuf, int recvcnt, MPI_Datatype recvtype,
int root, MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag );
int MPIR_Scatterv_impl (const void *sendbuf, const int *sendcnts, const int *displs,
MPI_Datatype sendtype, void *recvbuf, int recvcnt,
MPI_Datatype recvtype, int root, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Scatterv (const void *sendbuf, const int *sendcnts, const int *displs,
MPI_Datatype sendtype, void *recvbuf, int recvcnt,
MPI_Datatype recvtype, int root, MPID_Comm
*comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Barrier_impl( MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Barrier( MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Barrier_intra( MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Barrier_inter( MPID_Comm *comm_ptr, MPIR_Errflag_t *errflag);
int MPIR_Reduce_local_impl(const void *inbuf, void *inoutbuf, int count, MPI_Datatype datatype, MPI_Op op);
int MPIR_Setup_intercomm_localcomm( MPID_Comm * );
int MPIR_Comm_create( MPID_Comm ** );
int MPIR_Comm_create_group(MPID_Comm * comm_ptr, MPID_Group * group_ptr, int tag,
MPID_Comm ** newcomm);
/* comm_create helper functions, used by both comm_create and comm_create_group */
int MPIR_Comm_create_calculate_mapping(MPID_Group *group_ptr,
MPID_Comm *comm_ptr,
int **mapping_out,
MPID_Comm **mapping_comm);
int MPIR_Comm_create_map(int local_n,
int remote_n,
int *local_mapping,
int *remote_mapping,
MPID_Comm *mapping_comm,
MPID_Comm *newcomm);
/* implements the logic for MPI_Comm_create for intracommunicators only */
int MPIR_Comm_create_intra(MPID_Comm *comm_ptr, MPID_Group *group_ptr,
MPID_Comm **newcomm_ptr);
int MPIR_Comm_commit( MPID_Comm * );
int MPIR_Comm_is_node_aware( MPID_Comm * );
int MPIR_Comm_is_node_consecutive( MPID_Comm *);
void MPIR_Free_err_dyncodes( void );
int MPIR_Comm_idup_impl(MPID_Comm *comm_ptr, MPID_Comm **newcomm, MPID_Request **reqp);
int MPIR_Comm_shrink(MPID_Comm *comm_ptr, MPID_Comm **newcomm_ptr);
int MPIR_Comm_agree(MPID_Comm *comm_ptr, int *flag);
int MPIR_Allreduce_group(void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr,
MPID_Group *group_ptr, int tag, MPIR_Errflag_t *errflag);
int MPIR_Allreduce_group_intra(void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr,
MPID_Group *group_ptr, int tag, MPIR_Errflag_t *errflag);
int MPIR_Barrier_group(MPID_Comm *comm_ptr, MPID_Group *group_ptr, int tag, MPIR_Errflag_t *errflag);
/* topology impl functions */
int MPIR_Dist_graph_neighbors_count_impl(MPID_Comm *comm_ptr, int *indegree, int *outdegree, int *weighted);
int MPIR_Dist_graph_neighbors_impl(MPID_Comm *comm_ptr,
int maxindegree, int sources[], int sourceweights[],
int maxoutdegree, int destinations[], int destweights[]);
int MPIR_Graph_neighbors_count_impl(MPID_Comm *comm_ptr, int rank, int *nneighbors);
int MPIR_Graph_neighbors_impl(MPID_Comm *comm_ptr, int rank, int maxneighbors, int *neighbors);
int MPIR_Cart_shift_impl(MPID_Comm *comm_ptr, int direction, int displ, int *source, int *dest);
/* begin impl functions for NBC */
int MPIR_Ibarrier_impl(MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ibcast_impl(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Igather_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Igatherv_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iscatter_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iscatterv_impl(const void *sendbuf, const int *sendcounts, const int *displs, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iallgather_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iallgatherv_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ialltoall_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ialltoallv_impl(const void *sendbuf, const int *sendcounts, const int *sdispls, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ialltoallw_impl(const void *sendbuf, const int *sendcounts, const int *sdispls, const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcounts, const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ireduce_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iallreduce_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ireduce_scatter_impl(const void *sendbuf, void *recvbuf, const int *recvcounts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ireduce_scatter_block_impl(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iscan_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Iexscan_impl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPI_Request *request);
/* end impl functions for NBC */
/* begin impl functions for neighborhood collectives */
int MPIR_Ineighbor_allgather_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ineighbor_allgatherv_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int displs[], MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ineighbor_alltoall_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ineighbor_alltoallv_impl(const void *sendbuf, const int sendcounts[], const int sdispls[], MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Ineighbor_alltoallw_impl(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[], const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[], const MPI_Aint rdispls[], const MPI_Datatype recvtypes[], MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Neighbor_allgather_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_allgatherv_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int displs[], MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoall_impl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoallv_impl(const void *sendbuf, const int sendcounts[], const int sdispls[], MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoallw_impl(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[], const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[], const MPI_Aint rdispls[], const MPI_Datatype recvtypes[], MPID_Comm *comm_ptr);
/* end impl functions for neighborhood collectives */
/* neighborhood collective default algorithms */
int MPIR_Neighbor_allgather_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_allgatherv_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int displs[], MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoall_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoallv_default(const void *sendbuf, const int sendcounts[], const int sdispls[], MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr);
int MPIR_Neighbor_alltoallw_default(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[], const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[], const MPI_Aint rdispls[], const MPI_Datatype recvtypes[], MPID_Comm *comm_ptr);
int MPIR_Ineighbor_allgather_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ineighbor_allgatherv_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int displs[], MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ineighbor_alltoall_default(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ineighbor_alltoallv_default(const void *sendbuf, const int sendcounts[], const int sdispls[], MPI_Datatype sendtype, void *recvbuf, const int recvcounts[], const int rdispls[], MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ineighbor_alltoallw_default(const void *sendbuf, const int sendcounts[], const MPI_Aint sdispls[], const MPI_Datatype sendtypes[], void *recvbuf, const int recvcounts[], const MPI_Aint rdispls[], const MPI_Datatype recvtypes[], MPID_Comm *comm_ptr, MPID_Sched_t s);
/* nonblocking collective default algorithms */
int MPIR_Ibcast_intra(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibcast_inter(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibcast_binomial(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibcast_SMP(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscatter_for_bcast(void *tmp_buf, int root, MPID_Comm *comm_ptr, int nbytes, MPID_Sched_t s);
int MPIR_Ibcast_scatter_rec_dbl_allgather(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibcast_scatter_ring_allgather(void *buffer, int count, MPI_Datatype datatype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibarrier_intra(MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ibarrier_inter(MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_intra(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_inter(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_binomial(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_redscat_gather(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_SMP(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoallv_intra(const void *sendbuf, const int *sendcounts, const int *sdispls, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoallv_inter(const void *sendbuf, const int *sendcounts, const int *sdispls, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *rdispls, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_intra(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_inter(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_naive(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_SMP(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_redscat_allgather(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallreduce_rec_dbl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Igather_binomial(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Igather_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Igather_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscatter_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscatter_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscatterv(const void *sendbuf, const int *sendcounts, const int *displs, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_intra(const void *sendbuf, void *recvbuf, const int *recvcnts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_inter(const void *sendbuf, void *recvbuf, const int *recvcnts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_rec_dbl(const void *sendbuf, void *recvbuf, const int *recvcnts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_rec_hlv(const void *sendbuf, void *recvbuf, const int *recvcnts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_pairwise(const void *sendbuf, void *recvbuf, const int *recvcnts, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Igatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, int root, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_intra(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_inter(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_rec_hlv(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_pairwise(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_rec_dbl(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ireduce_scatter_block_noncomm(const void *sendbuf, void *recvbuf, int recvcount, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_inplace(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_bruck(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_perm_sr(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoall_pairwise(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgather_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgather_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgather_rec_dbl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgather_bruck(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgather_ring(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, int recvcount, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgatherv_rec_dbl(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgatherv_bruck(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgatherv_ring(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgatherv_intra(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iallgatherv_inter(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf, const int *recvcounts, const int *displs, MPI_Datatype recvtype, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscan_rec_dbl(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iscan_SMP(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Iexscan(const void *sendbuf, void *recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoallw_intra(const void *sendbuf, const int *sendcounts, const int *sdispls, const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcounts, const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr, MPID_Sched_t s);
int MPIR_Ialltoallw_inter(const void *sendbuf, const int *sendcounts, const int *sdispls, const MPI_Datatype *sendtypes, void *recvbuf, const int *recvcounts, const int *rdispls, const MPI_Datatype *recvtypes, MPID_Comm *comm_ptr, MPID_Sched_t s);
/* group functionality */
int MPIR_Group_check_subset(MPID_Group * group_ptr, MPID_Comm * comm_ptr);
/* begin impl functions for MPI_T (MPI_T_ right now) */
int MPIR_T_cvar_handle_alloc_impl(int cvar_index, void *obj_handle, MPI_T_cvar_handle *handle, int *count);
int MPIR_T_cvar_read_impl(MPI_T_cvar_handle handle, void *buf);
int MPIR_T_cvar_write_impl(MPI_T_cvar_handle handle, const void *buf);
int MPIR_T_pvar_session_create_impl(MPI_T_pvar_session *session);
int MPIR_T_pvar_session_free_impl(MPI_T_pvar_session *session);
int MPIR_T_pvar_handle_alloc_impl(MPI_T_pvar_session session, int pvar_index, void *obj_handle, MPI_T_pvar_handle *handle, int *count);
int MPIR_T_pvar_handle_free_impl(MPI_T_pvar_session session, MPI_T_pvar_handle *handle);
int MPIR_T_pvar_start_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle);
int MPIR_T_pvar_stop_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle);
int MPIR_T_pvar_read_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle, void *buf);
int MPIR_T_pvar_write_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle, const void *buf);
int MPIR_T_pvar_reset_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle);
int MPIR_T_pvar_readreset_impl(MPI_T_pvar_session session, MPI_T_pvar_handle handle, void *buf);
int MPIR_T_category_get_cvars_impl(int cat_index, int len, int indices[]);
int MPIR_T_category_get_pvars_impl(int cat_index, int len, int indices[]);
int MPIR_T_category_get_categories_impl(int cat_index, int len, int indices[]);
/* end impl functions for MPI_T (MPI_T_ right now) */
/* MPI-3 "large count" impl routines */
int MPIR_Get_elements_x_impl(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *elements);
int MPIR_Status_set_elements_x_impl(MPI_Status *status, MPI_Datatype datatype, MPI_Count count);
void MPIR_Type_get_extent_x_impl(MPI_Datatype datatype, MPI_Count *lb, MPI_Count *extent);
void MPIR_Type_get_true_extent_x_impl(MPI_Datatype datatype, MPI_Count *true_lb, MPI_Count *true_extent);
int MPIR_Type_size_x_impl(MPI_Datatype datatype, MPI_Count *size);
/* random initializers */
int MPIR_Group_init(void);
int MPIR_Comm_init(MPID_Comm *);
/* Collective functions cannot be called from multiple threads. These
are stubs used in the collective communication calls to check for
user error. Currently they are just being macroed out. */
#define MPIDU_ERR_CHECK_MULTIPLE_THREADS_ENTER(comm_ptr)
#define MPIDU_ERR_CHECK_MULTIPLE_THREADS_EXIT(comm_ptr)
/* Miscellaneous */
void MPIU_SetTimeout( int );
/* Communicator info hint functions */
typedef int (*MPIR_Comm_hint_fn_t)(MPID_Comm *, MPID_Info *, void *);
int MPIR_Comm_register_hint(const char *hint_key, MPIR_Comm_hint_fn_t fn, void *state);
#if defined(HAVE_VSNPRINTF) && defined(NEEDS_VSNPRINTF_DECL) && !defined(vsnprintf)
int vsnprintf(char *str, size_t size, const char *format, va_list ap);
# endif
/* Routines for determining local and remote processes */
int MPIU_Find_local_and_external(struct MPID_Comm *comm, int *local_size_p, int *local_rank_p, int **local_ranks_p,
int *external_size_p, int *external_rank_p, int **external_ranks_p,
int **intranode_table, int **internode_table_p);
int MPIU_Get_internode_rank(MPID_Comm *comm_ptr, int r);
int MPIU_Get_intranode_rank(MPID_Comm *comm_ptr, int r);
/* Trivial accessor macros */
#define MPIR_Comm_rank(comm_ptr) ((comm_ptr)->rank)
#define MPIR_Comm_size(comm_ptr) ((comm_ptr)->local_size)
#define MPIR_Type_extent_impl(datatype, extent_ptr) MPID_Datatype_get_extent_macro(datatype, *(extent_ptr))
#define MPIR_Type_size_impl(datatype, size) MPID_Datatype_get_size_macro(datatype, *(size))
#define MPIR_Test_cancelled_impl(status, flag) *(flag) = MPIR_STATUS_GET_CANCEL_BIT(*(status))
/* MPIR_ functions. These are versions of MPI_ functions appropriate for calling within MPI */
int MPIR_Cancel_impl(MPID_Request *request_ptr);
struct MPIR_Topology;
void MPIR_Cart_rank_impl(struct MPIR_Topology *cart_ptr, const int *coords, int *rank);
int MPIR_Cart_create_impl(MPID_Comm *comm_ptr, int ndims, const int dims[],
const int periods[], int reorder, MPI_Comm *comm_cart);
int MPIR_Cart_map_impl(const MPID_Comm *comm_ptr, int ndims, const int dims[],
const int periodic[], int *newrank);
int MPIR_Close_port_impl(const char *port_name);
int MPIR_Open_port_impl(MPID_Info *info_ptr, char *port_name);
int MPIR_Info_get_impl(MPID_Info *info_ptr, const char *key, int valuelen, char *value, int *flag);
void MPIR_Info_get_nkeys_impl(MPID_Info *info_ptr, int *nkeys);
int MPIR_Info_get_nthkey_impl(MPID_Info *info, int n, char *key);
void MPIR_Info_get_valuelen_impl(MPID_Info *info_ptr, const char *key, int *valuelen, int *flag);
int MPIR_Info_set_impl(MPID_Info *info_ptr, const char *key, const char *value);
int MPIR_Info_dup_impl(MPID_Info *info_ptr, MPID_Info **new_info_ptr);
int MPIR_Comm_delete_attr_impl(MPID_Comm *comm_ptr, MPID_Keyval *keyval_ptr);
int MPIR_Comm_create_keyval_impl(MPI_Comm_copy_attr_function *comm_copy_attr_fn,
MPI_Comm_delete_attr_function *comm_delete_attr_fn,
int *comm_keyval, void *extra_state);
int MPIR_Comm_accept_impl(const char * port_name, MPID_Info * info_ptr, int root,
MPID_Comm * comm_ptr, MPID_Comm ** newcomm_ptr);
int MPIR_Comm_connect_impl(const char * port_name, MPID_Info * info_ptr, int root,
MPID_Comm * comm_ptr, MPID_Comm ** newcomm_ptr);
int MPIR_Comm_create_errhandler_impl(MPI_Comm_errhandler_function *function,
MPI_Errhandler *errhandler);
int MPIR_Comm_dup_impl(MPID_Comm *comm_ptr, MPID_Comm **newcomm_ptr);
int MPIR_Comm_dup_with_info_impl(MPID_Comm *comm_ptr, MPID_Info *info_ptr, MPID_Comm **newcomm_ptr);
int MPIR_Comm_get_info_impl(MPID_Comm *comm_ptr, MPID_Info **info_ptr);
int MPIR_Comm_set_info_impl(MPID_Comm *comm_ptr, MPID_Info *info_ptr);
int MPIR_Comm_free_impl(MPID_Comm * comm_ptr);
void MPIR_Comm_free_keyval_impl(int keyval);
void MPIR_Comm_get_errhandler_impl(MPID_Comm *comm_ptr, MPID_Errhandler **errhandler_ptr);
void MPIR_Comm_set_errhandler_impl(MPID_Comm *comm_ptr, MPID_Errhandler *errhandler_ptr);
void MPIR_Comm_get_name_impl(MPID_Comm *comm, char *comm_name, int *resultlen);
int MPIR_Intercomm_merge_impl(MPID_Comm *comm_ptr, int high, MPID_Comm **new_intracomm_ptr);
int MPIR_Intercomm_create_impl(MPID_Comm *local_comm_ptr, int local_leader,
MPID_Comm *peer_comm_ptr, int remote_leader, int tag,
MPID_Comm **new_intercomm_ptr);
int MPIR_Comm_group_impl(MPID_Comm *comm_ptr, MPID_Group **group_ptr);
int MPIR_Comm_remote_group_impl(MPID_Comm *comm_ptr, MPID_Group **group_ptr);
int MPIR_Comm_group_failed_impl(MPID_Comm *comm, MPID_Group **failed_group_ptr);
int MPIR_Comm_remote_group_failed_impl(MPID_Comm *comm, MPID_Group **failed_group_ptr);
int MPIR_Comm_split_impl(MPID_Comm *comm_ptr, int color, int key, MPID_Comm **newcomm_ptr);
int MPIR_Comm_split_type_impl(MPID_Comm *comm_ptr, int split_type, int key, MPID_Info *info_ptr,
MPID_Comm **newcomm_ptr);
int MPIR_Group_compare_impl(MPID_Group *group_ptr1, MPID_Group *group_ptr2, int *result);
int MPIR_Group_difference_impl(MPID_Group *group_ptr1, MPID_Group *group_ptr2, MPID_Group **new_group_ptr);
int MPIR_Group_excl_impl(MPID_Group *group_ptr, int n, const int *ranks, MPID_Group **new_group_ptr);
int MPIR_Group_free_impl(MPID_Group *group_ptr);
int MPIR_Group_incl_impl(MPID_Group *group_ptr, int n, const int *ranks, MPID_Group **new_group_ptr);
int MPIR_Group_intersection_impl(MPID_Group *group_ptr1, MPID_Group *group_ptr2, MPID_Group **new_group_ptr);
int MPIR_Group_range_excl_impl(MPID_Group *group_ptr, int n, int ranges[][3], MPID_Group **new_group_ptr);
int MPIR_Group_range_incl_impl(MPID_Group *group_ptr, int n, int ranges[][3], MPID_Group **new_group_ptr);
int MPIR_Group_translate_ranks_impl(MPID_Group *group_ptr1, int n, const int *ranks1,
MPID_Group *group_ptr2, int *ranks2);
int MPIR_Group_union_impl(MPID_Group *group_ptr1, MPID_Group *group_ptr2, MPID_Group **new_group_ptr);
void MPIR_Get_count_impl(const MPI_Status *status, MPI_Datatype datatype, int *count);
void MPIR_Grequest_complete_impl(MPID_Request *request_ptr);
int MPIR_Grequest_start_impl(MPI_Grequest_query_function *query_fn,
MPI_Grequest_free_function *free_fn,
MPI_Grequest_cancel_function *cancel_fn,
void *extra_state, MPID_Request **request_ptr);
int MPIX_Grequest_start_impl(MPI_Grequest_query_function *,
MPI_Grequest_free_function *,
MPI_Grequest_cancel_function *,
MPIX_Grequest_poll_function *,
MPIX_Grequest_wait_function *, void *,
MPID_Request **);
int MPIR_Graph_map_impl(const MPID_Comm *comm_ptr, int nnodes,
const int indx[], const int edges[], int *newrank);
int MPIR_Type_commit_impl(MPI_Datatype *datatype);
int MPIR_Type_create_struct_impl(int count,
const int array_of_blocklengths[],
const MPI_Aint array_of_displacements[],
const MPI_Datatype array_of_types[],
MPI_Datatype *newtype);
int MPIR_Type_create_indexed_block_impl(int count,
int blocklength,
const int array_of_displacements[],
MPI_Datatype oldtype,
MPI_Datatype *newtype);
int MPIR_Type_create_hindexed_block_impl(int count, int blocklength,
const MPI_Aint array_of_displacements[],
MPI_Datatype oldtype, MPI_Datatype *newtype);
int MPIR_Type_contiguous_impl(int count,
MPI_Datatype old_type,
MPI_Datatype *new_type_p);
int MPIR_Type_contiguous_x_impl(MPI_Count count,
MPI_Datatype old_type,
MPI_Datatype *new_type_p);
void MPIR_Type_get_extent_impl(MPI_Datatype datatype, MPI_Aint *lb, MPI_Aint *extent);
void MPIR_Type_get_true_extent_impl(MPI_Datatype datatype, MPI_Aint *true_lb, MPI_Aint *true_extent);
void MPIR_Type_get_envelope_impl(MPI_Datatype datatype, int *num_integers, int *num_addresses,
int *num_datatypes, int *combiner);
int MPIR_Type_hvector_impl(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype *newtype_p);
int MPIR_Type_indexed_impl(int count, const int blocklens[], const int indices[],
MPI_Datatype old_type, MPI_Datatype *newtype);
void MPIR_Type_free_impl(MPI_Datatype *datatype);
int MPIR_Type_vector_impl(int count, int blocklength, int stride, MPI_Datatype old_type, MPI_Datatype *newtype_p);
int MPIR_Type_struct_impl(int count, const int blocklens[], const MPI_Aint indices[], const MPI_Datatype old_types[], MPI_Datatype *newtype);
int MPIR_Pack_impl(const void *inbuf, MPI_Aint incount, MPI_Datatype datatype, void *outbuf, MPI_Aint outcount, MPI_Aint *position);
void MPIR_Pack_size_impl(int incount, MPI_Datatype datatype, MPI_Aint *size);
int MPIR_Unpack_impl(const void *inbuf, MPI_Aint insize, MPI_Aint *position,
void *outbuf, int outcount, MPI_Datatype datatype);
void MPIR_Type_lb_impl(MPI_Datatype datatype, MPI_Aint *displacement);
int MPIR_Ibsend_impl(const void *buf, int count, MPI_Datatype datatype, int dest, int tag,
MPID_Comm *comm_ptr, MPI_Request *request);
int MPIR_Test_impl(MPI_Request *request, int *flag, MPI_Status *status);
int MPIR_Testall_impl(int count, MPI_Request array_of_requests[], int *flag,
MPI_Status array_of_statuses[]);
int MPIR_Wait_impl(MPI_Request *request, MPI_Status *status);
int MPIR_Waitall_impl(int count, MPI_Request array_of_requests[],
MPI_Status array_of_statuses[]);
int MPIR_Comm_set_attr_impl(MPID_Comm *comm_ptr, int comm_keyval, void *attribute_val,
MPIR_AttrType attrType);
/* Pull the error status out of the tag space and put it into an errflag. */
#undef FUNCNAME
#define FUNCNAME MPIR_process_status
#undef FCNAME
#define FCNAME MPL_QUOTE(FUNCNAME)
static inline void MPIR_Process_status(MPI_Status *status, MPIR_Errflag_t *errflag)
{
if (MPI_PROC_NULL != status->MPI_SOURCE &&
(MPIX_ERR_REVOKED == MPIR_ERR_GET_CLASS(status->MPI_ERROR) ||
MPIX_ERR_PROC_FAILED == MPIR_ERR_GET_CLASS(status->MPI_ERROR) ||
MPIR_TAG_CHECK_ERROR_BIT(status->MPI_TAG)) && !*errflag) {
/* If the receive was completed within the MPID_Recv, handle the
* errflag here. */
if (MPIR_TAG_CHECK_PROC_FAILURE_BIT(status->MPI_TAG) ||
MPIX_ERR_PROC_FAILED == MPIR_ERR_GET_CLASS(status->MPI_ERROR)) {
*errflag = MPIR_ERR_PROC_FAILED;
MPIR_TAG_CLEAR_ERROR_BITS(status->MPI_TAG);
} else {
*errflag = MPIR_ERR_OTHER;
MPIR_TAG_CLEAR_ERROR_BITS(status->MPI_TAG);
}
}
}
extern const char MPIR_Version_string[];
extern const char MPIR_Version_date[];
extern const char MPIR_Version_configure[];
extern const char MPIR_Version_device[];
extern const char MPIR_Version_CC[];
extern const char MPIR_Version_CXX[];
extern const char MPIR_Version_F77[];
extern const char MPIR_Version_FC[];
/* avoid conflicts in source files with old-style "char FCNAME[]" vars */
#undef FUNCNAME
#undef FCNAME
#endif /* MPIIMPL_INCLUDED */