e57ab611cd
These typos are found by running `grep -r '\\f[^IBRP]' ompi/mpi/man/`. Signed-off-by: KAWASHIMA Takahiro <t-kawashima@jp.fujitsu.com>
122 строки
4.0 KiB
Plaintext
122 строки
4.0 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright 2015 Los Alamos National Security, LLC. All rights reserved.
|
|
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
|
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Win_allocate 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Win_allocate\fP \- One-sided MPI call that allocates memory and
|
|
returns a window object for RMA operations.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_Win_allocate (MPI_Aint \fIsize\fP, int \fIdisp_unit\fP, MPI_Info \fIinfo\fP,
|
|
MPI_Comm \fIcomm\fP, void *\fIbaseptr\fP, MPI_Win *\fIwin\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_WIN_ALLOCATE(\fISIZE, DISP_UNIT, INFO, COMM, BASEPTR, WIN, IERROR\fP)
|
|
INTEGER(KIND=MPI_ADDRESS_KIND) \fISIZE, BASEPTR\fP
|
|
INTEGER \fIDISP_UNIT, INFO, COMM, WIN, IERROR\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_Win_allocate(\fIsize\fP, \fIdisp_unit\fP, \fIinfo\fP, \fIcomm\fP, \fIbaseptr\fP, \fIwin\fP, \fIierror\fP)
|
|
USE, INTRINSIC :: ISO_C_BINDING, ONLY : C_PTR
|
|
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: \fIsize\fP
|
|
INTEGER, INTENT(IN) :: \fIdisp_unit\fP
|
|
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
|
|
TYPE(MPI_Comm), INTENT(IN) :: \fIcomm\fP
|
|
TYPE(C_PTR), INTENT(OUT) :: \fIbaseptr\fP
|
|
TYPE(MPI_Win), INTENT(OUT) :: \fIwin\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
size
|
|
Size of window in bytes (nonnegative integer).
|
|
.TP 1i
|
|
disp_unit
|
|
Local unit size for displacements, in bytes (positive integer).
|
|
.TP 1i
|
|
info
|
|
Info argument (handle).
|
|
.TP 1i
|
|
comm
|
|
Communicator (handle).
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
baseptr
|
|
Initial address of window.
|
|
.TP 1i
|
|
win
|
|
Window object returned by the call (handle).
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
\fBMPI_Win_allocate\fP is a collective call executed by all processes
|
|
in the group of \fIcomm\fP. On each process, it allocates memory of at
|
|
least \fIsize\fP bytes, returns a pointer to it, and returns a window
|
|
object that can be used by all processes in \fIcomm\fP to perform RMA
|
|
operations. The returned memory consists of \fIsize\fP bytes local to
|
|
each process, starting at address \fIbaseptr\fP and is associated with
|
|
the window as if the user called \fBMPI_Win_create\fP on existing
|
|
memory. The \fIsize\fP argument may be different at each process and
|
|
\fIsize\fP = 0 is valid; however, a library might allocate and expose
|
|
more memory in order to create a fast, globally symmetric
|
|
allocation. The discussion of and rationales for \fBMPI_Alloc_mem\fP and
|
|
\fBMPI_Free_mem\fP in MPI-3.1 \[char167] 8.2 also apply to
|
|
\fBMPI_Win_allocate\fP; in particular, see the rationale in MPI-3.1
|
|
\[char167] 8.2 for an explanation of the type used for \fIbaseptr\fP.
|
|
.sp
|
|
The displacement unit argument is provided to facilitate address
|
|
arithmetic in RMA operations: the target displacement argument of an
|
|
RMA operation is scaled by the factor \fIdisp_unit\fP specified by the
|
|
target process, at window creation.
|
|
.sp
|
|
For supported info keys see \fBMPI_Win_create\fI.
|
|
.sp
|
|
|
|
.SH NOTES
|
|
Common choices for \fIdisp_unit\fP are 1 (no scaling), and (in C
|
|
syntax) \fIsizeof(type)\fP, for a window that consists of an array of
|
|
elements of type \fItype\fP. The later choice will allow one to use
|
|
array indices in RMA calls, and have those scaled correctly to byte
|
|
displacements, even in a heterogeneous environment.
|
|
.sp
|
|
|
|
.SH ERRORS
|
|
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
|
|
.sp
|
|
Before the error value is returned, the current MPI error handler is
|
|
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.
|
|
|
|
.SH SEE ALSO
|
|
.ft R
|
|
.sp
|
|
MPI_Alloc_mem
|
|
MPI_Free_mem
|
|
MPI_Win_create
|
|
MPI_Win_allocate_shared
|