|
| 1 | +.\" -*- nroff -*- |
| 2 | +.\" Copyright (c) 2015 Research Organization for Information Science |
| 3 | +.\" and Technology (RIST). All rights reserved. |
| 4 | +.\" $COPYRIGHT$ |
| 5 | +.TH MPI_Win_attach 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#" |
| 6 | +.SH NAME |
| 7 | +\fBMPI_Win_create, MPI_Win_detach\fP \- One-sided MPI call that attach / detach a window object for RMA operations. |
| 8 | + |
| 9 | +.SH SYNTAX |
| 10 | +.ft R |
| 11 | +.SH C Syntax |
| 12 | +.nf |
| 13 | +#include <mpi.h> |
| 14 | +MPI_Win_attach(MPI_Win *\fIwin\fP, void *\fIbase\fP, MPI_Aint \fIsize\fP) |
| 15 | + |
| 16 | +MPI_Win_detach(MPI_Win *\fIwin\fP, void *\fIbase\fP) |
| 17 | +.fi |
| 18 | +.SH Fortran Syntax |
| 19 | +.nf |
| 20 | +INCLUDE 'mpif.h' |
| 21 | +MPI_WIN_ATTACH(\fIWIN, BASE, SIZE, IERROR\fP) |
| 22 | + <type> \fIBASE\fP(*) |
| 23 | + INTEGER(KIND=MPI_ADDRESS_KIND) \fISIZE\fP |
| 24 | + INTEGER \fIWIN, IERROR\fP |
| 25 | + |
| 26 | +.fi |
| 27 | +.SH INPUT PARAMETERS |
| 28 | +.ft R |
| 29 | +.TP 1i |
| 30 | +win |
| 31 | +A window that was created with |
| 32 | +.I MPI_Win_create_dynamic |
| 33 | + |
| 34 | +.TP 1i |
| 35 | +base |
| 36 | +Initial address of window (choice). |
| 37 | +.TP 1i |
| 38 | +size |
| 39 | +Size of window in bytes (nonnegative integer). |
| 40 | + |
| 41 | +.SH OUTPUT PARAMETERS |
| 42 | +.ft R |
| 43 | +.TP 1i |
| 44 | +win |
| 45 | +Window object returned by the call (handle). |
| 46 | +.TP 1i |
| 47 | +IERROR |
| 48 | +Fortran only: Error status (integer). |
| 49 | + |
| 50 | +.SH DESCRIPTION |
| 51 | +.ft R |
| 52 | +MPI_Win_attach is a one-sided MPI communication collective call executed by all processes in the group of \fIcomm\fP. It returns a window object that can be used by these processes to perform RMA operations. Each process specifies a window of existing memory that it exposes to RMA accesses by the processes in the group of \fIcomm\fP. The window consists of \fIsize\fP bytes, starting at address \fIbase\fP. A process may elect to expose no memory by specifying \fIsize\fP = 0. |
| 53 | +.sp |
| 54 | +If the \fIbase\fP value used by MPI_Win_create was allocated by MPI_Alloc_mem, the size of the window can be no larger than the value set by the MPI_ALLOC_MEM function. |
| 55 | +.sp |
| 56 | + |
| 57 | +.SH NOTES |
| 58 | +Use memory allocated by MPI_Alloc_mem to guarantee properly aligned window boundaries (such as word, double-word, cache line, page frame, and so on). |
| 59 | +.sp |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +.SH ERRORS |
| 64 | +Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. |
| 65 | +.sp |
| 66 | +Before the error value is returned, the current MPI error handler is |
| 67 | +called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
| 68 | + |
| 69 | + |
| 70 | + |
0 commit comments