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>
109 строки
3.0 KiB
Plaintext
109 строки
3.0 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright (c) 2010-2014 Cisco Systems, Inc. All rights reserved.
|
|
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Alloc_mem 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Alloc_mem \fP \- Allocates a specified memory segment.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_Alloc_mem(MPI_Aint \fIsize\fP, MPI_Info \fIinfo\fP, void *\fIbaseptr\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax (see FORTRAN NOTES)
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_ALLOC_MEM(\fISIZE, INFO, BASEPTR, IERROR\fP)
|
|
INTEGER \fIINFO, IERROR\fP
|
|
INTEGER(KIND=MPI_ADDRESS_KIND) \fISIZE, BASEPTR\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_Alloc_mem(\fIsize\fP, \fIinfo\fP, \fIbaseptr\fP, \fIierror\fP)
|
|
USE, INTRINSIC :: \fIISO_C_BINDING\fP, \fIONLY \fP
|
|
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: \fIsize\fP
|
|
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
|
|
TYPE(C_PTR), INTENT(OUT) :: \fIbaseptr\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
size
|
|
Size of memory segment in bytes (nonnegative integer).
|
|
.ft R
|
|
.TP 1i
|
|
info
|
|
Info argument (handle).
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
baseptr
|
|
Pointer to beginning of memory segment allocated.
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
MPI_Alloc_mem allocates \fIsize\fP bytes of memory. The starting address
|
|
of this memory is returned in the variable \fIbase\fP.
|
|
.sp
|
|
|
|
.SH FORTRAN NOTES
|
|
.ft R
|
|
There is no portable FORTRAN 77 syntax for using MPI_Alloc_mem.
|
|
There is no portable Fortran syntax for using pointers returned
|
|
from MPI_Alloc_mem. However, MPI_Alloc_mem can be used with Sun
|
|
Fortran compilers.
|
|
.sp
|
|
From FORTRAN 77, you can use the following non-standard
|
|
declarations for the SIZE and BASEPTR arguments:
|
|
.nf
|
|
INCLUDE "mpif.h"
|
|
INTEGER*MPI_ADDRESS_KIND SIZE, BASEPTR
|
|
.fi
|
|
.sp
|
|
From either FORTRAN 77 or Fortran 90, you can use "Cray pointers"
|
|
for the BASEPTR argument. Cray pointers are described further in
|
|
the Fortran User's Guide and are supported by many Fortran compilers.
|
|
For example,
|
|
.sp
|
|
.nf
|
|
INCLUDE "mpif.h"
|
|
REAL*4 A(100,100)
|
|
POINTER (BASEPTR, A)
|
|
INTEGER*MPI_ADDRESS_KIND SIZE
|
|
|
|
SIZE = 4 * 100 * 100
|
|
CALL MPI_ALLOC_MEM(SIZE,MPI_INFO_NULL,BASEPTR,IERR)
|
|
|
|
! use A
|
|
|
|
CALL MPI_FREE_MEM(A, IERR)
|
|
.fi
|
|
.ft R
|
|
|
|
.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_Free_mem
|