0b8baa217d
This commit contains the following changes: The C++ bindings were removed from the standard in MPI-3.0. This commit removes the entirety of the C++ bindings as well as the support configury. Removes all references to C++ from the man pages. This includes the bindings themselves, all references to what C++ bindings return, all not-available comments, and differences between C++ and other language bindings. If the user passes --enable-mpi-cxx, --enable-mpi-cxx-seek, or --enable-cxx-exceptions, print a warning message an abort configure. Signed-off-by: Jeff Squyres <jsquyres@cisco.com> Signed-off-by: Nathan Hjelm <hjelmn@google.com>
137 строки
5.4 KiB
Plaintext
137 строки
5.4 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
|
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" Copyright 2014 Los Alamos National Security, LLC. All rights reserved.
|
|
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Get 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Get\fP, \fBMPI_Rget\fP \- Copies data from the target memory to the origin.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
MPI_Get(void *\fIorigin_addr\fP, int \fIorigin_count\fP, MPI_Datatype
|
|
\fIorigin_datatype\fP, int \fItarget_rank\fP, MPI_Aint \fItarget_disp\fP,
|
|
int \fItarget_count\fP, MPI_Datatype \fItarget_datatype\fP, MPI_Win \fIwin\fP)
|
|
|
|
MPI_Rget(void *\fIorigin_addr\fP, int \fIorigin_count\fP, MPI_Datatype
|
|
\fIorigin_datatype\fP, int \fItarget_rank\fP, MPI_Aint \fItarget_disp\fP,
|
|
int \fItarget_count\fP, MPI_Datatype \fItarget_datatype\fP, MPI_Win \fIwin\fP,
|
|
MPI_Request *\fIrequest\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax (see FORTRAN 77 NOTES)
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_GET(\fIORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
|
|
TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, WIN, IERROR\fP)
|
|
<type> \fIORIGIN_ADDR\fP(*)
|
|
INTEGER(KIND=MPI_ADDRESS_KIND) \fITARGET_DISP\fP
|
|
INTEGER \fIORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
|
|
TARGET_COUNT, TARGET_DATATYPE, WIN, IERROR\fP
|
|
|
|
MPI_RGET(\fIORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
|
|
TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERROR\fP)
|
|
<type> \fIORIGIN_ADDR\fP(*)
|
|
INTEGER(KIND=MPI_ADDRESS_KIND) \fITARGET_DISP\fP
|
|
INTEGER \fIORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
|
|
TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERROR\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_Get(\fIorigin_addr\fP, \fIorigin_count\fP, \fIorigin_datatype\fP, \fItarget_rank\fP,
|
|
\fItarget_disp\fP, \fItarget_count\fP, \fItarget_datatype\fP, \fIwin\fP, \fIierror\fP)
|
|
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIorigin_addr\fP
|
|
INTEGER, INTENT(IN) :: \fIorigin_count\fP, \fItarget_rank\fP, \fItarget_count\fP
|
|
TYPE(MPI_Datatype), INTENT(IN) :: \fIorigin_datatype\fP, \fItarget_datatype\fP
|
|
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: \fItarget_disp\fP
|
|
TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
MPI_Rget(\fIorigin_addr\fP, \fIorigin_count\fP, \fIorigin_datatype\fP, \fItarget_rank\fP,
|
|
\fItarget_disp\fP, \fItarget_count\fP, \fItarget_datatype\fP, \fIwin\fP, \fIrequest,\fP
|
|
\fIierror\fP)
|
|
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: \fIorigin_addr\fP
|
|
INTEGER, INTENT(IN) :: \fIorigin_count\fP, \fItarget_rank\fP, \fItarget_count\fP
|
|
TYPE(MPI_Datatype), INTENT(IN) :: \fIorigin_datatype\fP, \fItarget_datatype\fP
|
|
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: \fItarget_disp\fP
|
|
TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
|
|
TYPE(MPI_Request), INTENT(OUT) :: \fIrequest\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
origin_addr
|
|
Initial address of origin buffer (choice).
|
|
.TP 1i
|
|
origin_count
|
|
Number of entries in origin buffer (nonnegative integer).
|
|
.TP 1i
|
|
origin_datatype
|
|
Data type of each entry in origin buffer (handle).
|
|
.TP 1i
|
|
target_rank
|
|
Rank of target (nonnegative integer).
|
|
.TP 1i
|
|
target_disp
|
|
Displacement from window start to the beginning of the target buffer (nonnegative integer).
|
|
.TP 1i
|
|
target_count
|
|
Number of entries in target buffer (nonnegative integer).
|
|
.TP 1i
|
|
target datatype
|
|
datatype of each entry in target buffer (handle)
|
|
.TP 1i
|
|
win
|
|
window object used for communication (handle)
|
|
|
|
.SH OUTPUT PARAMETER
|
|
.ft R
|
|
.TP li
|
|
request
|
|
MPI_Rget: RMA request
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
\fBMPI_Get\fP copies data from the target memory to the origin, similar to MPI_Put, except that the direction of data transfer is reversed. The \fIorigin_datatype\fP may not specify overlapping entries in the origin buffer. The target buffer must be contained within the target window, and the copied data must fit, without truncation, in the origin buffer. Only processes within the same node can access the target window.
|
|
.sp
|
|
|
|
\fBMPI_Rget\fP is similar to \fBMPI_Get\fP, except that it allocates a communication request object and associates it with the request handle (the argument \fIrequest\fP) that can be used to wait or test for completion. The completion of an MPI_Rget operation indicates that the data is available in the origin buffer. If \fIorigin_addr\fP points to memory attached to a window, then the data becomes available in the private copy of this window.
|
|
|
|
.SH FORTRAN 77 NOTES
|
|
.ft R
|
|
The MPI standard prescribes portable Fortran syntax for
|
|
the \fITARGET_DISP\fP argument only for Fortran 90. FORTRAN 77
|
|
users may use the non-portable syntax
|
|
.sp
|
|
.nf
|
|
INTEGER*MPI_ADDRESS_KIND \fITARGET_DISP\fP
|
|
.fi
|
|
.sp
|
|
where MPI_ADDRESS_KIND is a constant defined in mpif.h
|
|
and gives the length of the declared integer in bytes.
|
|
|
|
.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_Put
|
|
|