MPI_Win_get_attr function

Article
09/14/2018

Get attribute cached on an MPI window object.

Syntax

int MPIAPI MPI_Win_get_attr(
        MPI_Win win,
        int     win_keyval,
  _Out_ void    *attribute_val,
  _Out_ int     *flag
);

Parameters

win
Window to which the attribute is attached.
win_keyval
Key value.
attribute_val [out]
Attribute value, unless flag is false.
flag [out]
False if no attribute is associated with the key.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_WIN_GET_ATTR(WIN, WIN_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)
        INTEGER WIN, WIN_KEYVAL, IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL
        LOGICAL FLAG

Remarks

The following attributes are predefined for all MPI Window objects:

MPI_WIN_BASE - window base address.
MPI_WIN_SIZE - window size, in bytes.
MPI_WIN_DISP_UNIT - displacement unit associated with the window.
MPI_WIN_CREATE_FLAVOR - how the window was created.
MPI_WIN_MODEL - memory model for the window.

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll