1
1

Merge pull request #8154 from Fangcong-Yin/latest_pr

Convert MPI_File_write_ordered.3in - MPI_Free_mem.3in to md
Этот коммит содержится в:
Jeff Squyres 2020-10-30 10:44:23 -04:00 коммит произвёл GitHub
родитель 548f5dbe47 82081118d6
Коммит f813656d24
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
14 изменённых файлов: 560 добавлений и 472 удалений

81
ompi/mpi/man/man3/MPI_File_write_ordered.md Обычный файл
Просмотреть файл

@ -0,0 +1,81 @@
# Name
`MPI_File_write_ordered` - Writes a file at a location specified by a
shared file pointer (blocking, collective).
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_File_write_ordered(MPI_File fh, const void *buf,
int count, MPI_Datatype datatype,
MPI_Status *status)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_ORDERED(FH, BUF, COUNT, DATATYPE,
STATUS, IERROR)
<type> BUF(*)
INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_File_write_ordered(fh, buf, count, datatype, status, ierror)
TYPE(MPI_File), INTENT(IN) :: fh
TYPE(*), DIMENSION(..), INTENT(IN) :: buf
INTEGER, INTENT(IN) :: count
TYPE(MPI_Datatype), INTENT(IN) :: datatype
TYPE(MPI_Status) :: status
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Input Parameters
* `fh` : File handle (handle).
* `buf` : Initial address of buffer (choice).
* `count` : Number of elements in buffer (integer).
* `datatype` : Data type of each buffer element (handle).
# Output Parameters
* `status` : Status object (Status).
* `IERROR` : Fortran only: Error status (integer).
# Description
`MPI_File_write_ordered` is a collective routine. This routine must be
called by all processes in the communicator group associated with the
file handle `fh`. Each process may pass different argument values for
the `datatype` and `count` arguments. Each process attempts to write,
into the file associated with `fh`, a total number of `count` data items
having `datatype` type contained in the user's buffer `buf`. For each
process, the location in the file at which data is written is the
position at which the shared file pointer would be after all processes
whose ranks within the group are less than that of this process had
written their data. `MPI_File_write_ordered` returns the number of
`datatype` elements written in `status`. The shared file pointer is
updated by the amounts of data requested by all processes of the group.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
Before the error value is returned, the current MPI error handler is
called. For MPI I/O function errors, the default error handler is set to
`MPI_ERRORS_RETURN`. The error handler may be changed with
`MPI_File_set_errhandler`; the predefined error handler
`MPI_ERRORS_ARE_FATAL` may be used to make I/O errors fatal. Note that MPI
does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -1,104 +0,0 @@
.\" -*- nroff -*-
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright 2015-2016 Research Organization for Information Science
.\" and Technology (RIST). All rights reserved.
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
.\" $COPYRIGHT$
.TH MPI_File_write_ordered_begin 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_File_write_ordered_begin\fP \- Writes a file at a location specified by a shared file pointer; beginning part of a split collective routine (nonblocking).
.SH SYNTAX
.ft R
.nf
.SH C Syntax
.nf
#include <mpi.h>
int MPI_File_write_ordered_begin(MPI_File \fIfh\fP, const void \fI*buf\fP,
int \fIcount\fP, MPI_Datatype \fIdatatype\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_ORDERED_BEGIN(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fIIERROR\fP)
<type> \fIBUF(*)\fP
INTEGER \fIFH, COUNT, DATATYPE, IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_File_write_ordered_begin(\fIfh\fP, \fIbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIierror\fP)
TYPE(MPI_File), INTENT(IN) :: \fIfh\fP
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIbuf\fP
INTEGER, INTENT(IN) :: \fIcount\fP
TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
fh
File handle (handle).
.SH INPUT PARAMETERS
.ft R
.TP 1i
buf
Initial address of buffer (choice).
.ft R
.TP 1i
count
Number of elements in buffer (integer).
.ft R
.TP 1i
datatype
Data type of each buffer element (handle).
.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
MPI_File_write_ordered_begin is the beginning part of a split collective, nonblocking routine that must
be called by all processes in the communicator group associated with
the file handle
.I fh.
Each process may pass different argument values
for the
.I datatype
and
.I count
arguments. After all processes of the
group have issued their respective calls, each process attempts to
write, into the file associated with
.I fh,
a total number of
.I count
data items having datatype type contained in the user's buffer
.I buf.
For
each process, the location in the file at which data is written is the
position at which the shared file pointer would be after all processes
whose ranks within the group are less than that of this process had
written their data.
.SH NOTES
.ft R
All the nonblocking collective routines for data access are "split" into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard.
.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. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -0,0 +1,88 @@
# Name
`MPI_File_write_ordered_begin` - Writes a file at a location specified
by a shared file pointer; beginning part of a split collective routine
(nonblocking).
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_File_write_ordered_begin(MPI_File fh, const void *buf,
int count, MPI_Datatype datatype)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_ORDERED_BEGIN(FH, BUF, COUNT, DATATYPE, IERROR)
<type> BUF(*)
INTEGER FH, COUNT, DATATYPE, IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_File_write_ordered_begin(fh, buf, count, datatype, ierror)
TYPE(MPI_File), INTENT(IN) :: fh
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: buf
INTEGER, INTENT(IN) :: count
TYPE(MPI_Datatype), INTENT(IN) :: datatype
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Input/Output Parameter
* `fh` : File handle (handle).
# Input Parameters
* `buf` : Initial address of buffer (choice).
* `count` : Number of elements in buffer (integer).
* `datatype` : Data type of each buffer element (handle).
# Output Parameter
* `IERROR` : Fortran only: Error status (integer).
# Description
`MPI_File_write_ordered_begin` is the beginning part of a split
collective, nonblocking routine that must be called by all processes in
the communicator group associated with the file handle `fh`. Each
process may pass different argument values for the `datatype` and
`count` arguments. After all processes of the group have issued their
respective calls, each process attempts to write, into the file
associated with `fh`, a total number of `count` data items having
`datatype` type contained in the user's buffer `buf`. For each process,
the location in the file at which data is written is the position at
which the shared file pointer would be after all processes whose ranks
within the group are less than that of this process had written their
data.
# Notes
All the nonblocking collective routines for data access are "split"
into two routines, each with _begin or _end as a suffix. These split
collective routines are subject to the semantic rules described in
Section 9.4.5 of the MPI-2 standard.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
Before the error value is returned, the current MPI error handler is
called. For MPI I/O function errors, the default error handler is set to
`MPI_ERRORS_RETURN`. The error handler may be changed with
`MPI_File_set_errhandler`; the predefined error handler
`MPI_ERRORS_ARE_FATAL` may be used to make I/O errors fatal. Note that MPI
does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -1,84 +0,0 @@
.\" -*- nroff -*-
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright 2015-2016 Research Organization for Information Science
.\" and Technology (RIST). All rights reserved.
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
.\" $COPYRIGHT$
.TH MPI_File_write_ordered_end 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_File_write_ordered_end\fP \- Writes a file at a location specified by a shared file pointer; ending part of a split collective routine (blocking).
.SH SYNTAX
.ft R
.nf
.SH C Syntax
.nf
#include <mpi.h>
int MPI_File_write_ordered_end(MPI_File \fIfh\fP, const void \fI*buf\fP,
MPI_Status \fI*status\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_ORDERED_END(\fIFH\fP, \fIBUF\fP, \fISTATUS\fP, \fIIERROR\fP)
<type> \fIBUF(*)\fP
INTEGER \fIFH, STATUS(MPI_STATUS_SIZE), IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_File_write_ordered_end(\fIfh\fP, \fIbuf\fP, \fIstatus\fP, \fIierror\fP)
TYPE(MPI_File), INTENT(IN) :: \fIfh\fP
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIbuf\fP
TYPE(MPI_Status) :: \fIstatus\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
fh
File handle (handle).
.SH INPUT PARAMETER
.ft R
.TP 1i
buf
Initial address of buffer (choice).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
status
Status object (status).
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
MPI_File_write_ordered_end is the ending part of a split collective routine that must
be called by all processes in the communicator group associated with
the file handle
.I fh.
MPI_File_write_ordered_end returns the number of elements written into the file associated with
.I fh
in
.I status.
.SH NOTES
.ft R
All the nonblocking collective routines for data access are "split" into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard.
.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. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -0,0 +1,79 @@
# Name
`MPI_File_write_ordered_end` - Writes a file at a location specified
by a shared file pointer; ending part of a split collective routine
(blocking).
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_File_write_ordered_end(MPI_File fh, const void *buf,
MPI_Status *status)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_ORDERED_END(FH, BUF, STATUS, IERROR)
<type> BUF(*)
INTEGER FH, STATUS(MPI_STATUS_SIZE), IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_File_write_ordered_end(fh, buf, status, ierror)
TYPE(MPI_File), INTENT(IN) :: fh
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: buf
TYPE(MPI_Status) :: status
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Input/Output Parameter
* `fh` : File handle (handle).
# Input Parameter
* `buf` : Initial address of buffer (choice).
# Output Parameters
* `status` : Status object (status).
* `IERROR` : Fortran only: Error status (integer).
# Description
`MPI_File_write_ordered_end` is the ending part of a split collective
routine that must be called by all processes in the communicator group
associated with the file handle `fh`. `MPI_File_write_ordered_end` returns
the number of elements written into the file associated with `fh` in
`status`.
# Notes
All the nonblocking collective routines for data access are "split"
into two routines, each with _begin or _end as a suffix. These split
collective routines are subject to the semantic rules described in
Section 9.4.5 of the MPI-2 standard.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
Before the error value is returned, the current MPI error handler is
called. For MPI I/O function errors, the default error handler is set to
`MPI_ERRORS_RETURN`. The error handler may be changed with
`MPI_File_set_errhandler`; the predefined error handler
`MPI_ERRORS_ARE_FATAL` may be used to make I/O errors fatal. Note that MPI
does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -1,83 +0,0 @@
.\" -*- nroff -*-
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright 2015-2016 Research Organization for Information Science
.\" and Technology (RIST). All rights reserved.
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
.\" $COPYRIGHT$
.TH MPI_File_write_shared 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_File_write_shared\fP \- Writes a file using the shared file pointer (blocking, noncollective).
.SH SYNTAX
.ft R
.nf
.SH C Syntax
.nf
#include <mpi.h>
int MPI_File_write_shared(MPI_File \fIfh\fP, const void \fI*buf\fP, int \fIcount\fP,
MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_SHARED(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fISTATUS\fP, \fIIERROR\fP)
<type> \fIBUF(*)\fP
INTEGER \fIFH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_File_write_shared(\fIfh\fP, \fIbuf\fP, \fIcount\fP, \fIdatatype\fP, \fIstatus\fP, \fIierror\fP)
TYPE(MPI_File), INTENT(IN) :: \fIfh\fP
TYPE(*), DIMENSION(..), INTENT(IN) :: \fIbuf\fP
INTEGER, INTENT(IN) :: \fIcount\fP
TYPE(MPI_Datatype), INTENT(IN) :: \fIdatatype\fP
TYPE(MPI_Status) :: \fIstatus\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
fh
File handle (handle).
.SH INPUT PARAMETERS
.ft R
.TP 1i
buf
Initial address of buffer (choice).
.ft R
.TP 1i
count
Number of elements in buffer (integer).
.ft R
.TP 1i
datatype
Data type of each buffer element (handle).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
status
Status object (status).
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
MPI_File_write_shared is a blocking routine that uses the shared file pointer to write files. The order of serialization is not deterministic for this noncollective routine.
.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. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.

73
ompi/mpi/man/man3/MPI_File_write_shared.md Обычный файл
Просмотреть файл

@ -0,0 +1,73 @@
# Name
`MPI_File_write_shared` - Writes a file using the shared file pointer
(blocking, noncollective).
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_File_write_shared(MPI_File fh, const void *buf, int count,
MPI_Datatype datatype, MPI_Status *status)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_WRITE_SHARED(FH, BUF, COUNT, DATATYPE, STATUS, IERROR)
<type> BUF(*)
INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_File_write_shared(fh, buf, count, datatype, status, ierror)
TYPE(MPI_File), INTENT(IN) :: fh
TYPE(*), DIMENSION(..), INTENT(IN) :: buf
INTEGER, INTENT(IN) :: count
TYPE(MPI_Datatype), INTENT(IN) :: datatype
TYPE(MPI_Status) :: status
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Input/Output Parameter
* `fh` : File handle (handle).
# Input Parameters
* `buf` : Initial address of buffer (choice).
* `count` : Number of elements in buffer (integer).
* `datatype` : Data type of each buffer element (handle).
# Output Parameters
* `status` : Status object (status).
* `IERROR` : Fortran only: Error status (integer).
# Description
`MPI_File_write_shared` is a blocking routine that uses the shared file
pointer to write files. The order of serialization is not deterministic
for this noncollective routine.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
Before the error value is returned, the current MPI error handler is
called. For MPI I/O function errors, the default error handler is set to
`MPI_ERRORS_RETURN`. The error handler may be changed with
`MPI_File_set_errhandler`; the predefined error handler
`MPI_ERRORS_ARE_FATAL` may be used to make I/O errors fatal. Note that MPI
does not guarantee that an MPI program can continue past an error.

Просмотреть файл

@ -1,67 +0,0 @@
.\" -*- nroff -*-
.\" Copyright (c) 2010-2015 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_Finalize 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Finalize \fP \- Terminates MPI execution environment.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Finalize()
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FINALIZE(\fIIERROR\fP)
INTEGER \fIIERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Finalize(\fIierror\fP)
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
This routine cleans up all MPI states. Once this routine is called, no MPI routine (not even MPI_Init) may be called, except for MPI_Get_version, MPI_Initialized, and MPI_Finalized. Unless there has been a call to MPI_Abort, you must ensure that all pending communications involving a process are complete before the process calls MPI_Finalize. If the call returns, each process may either continue local computations or exit without participating in further communication with other processes. At the moment when the last process calls MPI_Finalize, all pending sends must be matched by a receive, and all pending receives must be matched by a send.
MPI_Finalize is collective over all connected processes. If no processes were spawned, accepted, or connected, then this means it is collective over MPI_COMM_WORLD. Otherwise, it is collective over the union of all processes that have been and continue to be connected.
.SH NOTES
.ft R
All processes must call this routine before exiting. All processes will still exist but may not make any further MPI calls. MPI_Finalize guarantees that all local actions required by communications the user has completed will, in fact, occur before it returns. However, MPI_Finalize guarantees nothing about pending communications that have \fInot\fP been completed; completion is ensured only by MPI_Wait, MPI_Test, or MPI_Request_free combined with some other verification of completion.
.sp
For example, a successful return from a blocking communication operation or from MPI_Wait or MPI_Test means that the communication is completed by the user and the buffer can be reused, but does not guarantee that the local process has no more work to do. Similarly, a successful return from MPI_Request_free with a request handle generated by an MPI_Isend nullifies the handle but does not guarantee that the operation has completed. The MPI_Isend is complete only when a matching receive has completed.
.sp
If you would like to cause actions to happen when a process finishes, attach an attribute to MPI_COMM_SELF with a callback function. Then, when MPI_Finalize is called, it will first execute the equivalent of an MPI_Comm_free on MPI_COMM_SELF. This will cause the delete callback function to be executed on all keys associated with MPI_COMM_SELF in an arbitrary order. If no key has been attached to MPI_COMM_SELF, then no callback is invoked. This freeing of MPI_COMM_SELF happens before any other parts of MPI are affected. Calling MPI_Finalized will thus return "false" in any of these callback functions. Once you have done this with MPI_COMM_SELF, the results of MPI_Finalize are not specified.
.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
.nf
MPI_Init
MPI_Init_thread
MPI_Initialized
MPI_Finalized

103
ompi/mpi/man/man3/MPI_Finalize.md Обычный файл
Просмотреть файл

@ -0,0 +1,103 @@
# Name
`MPI_Finalize` - Terminates MPI execution environment.
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_Finalize()
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FINALIZE(IERROR)
INTEGER IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_Finalize(ierror)
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Output Parameter
* `IERROR` : Fortran only: Error status (integer).
# Description
This routine cleans up all MPI states. Once this routine is called, no
MPI routine (not even `MPI_Init`) may be called, except for
`MPI_Get_version`, `MPI_Initialized`, and `MPI_Finalized`. Unless there has
been a call to `MPI_Abort`, you must ensure that all pending
communications involving a process are complete before the process calls
`MPI_Finalize`. If the call returns, each process may either continue
local computations or exit without participating in further
communication with other processes. At the moment when the last process
calls `MPI_Finalize`, all pending sends must be matched by a receive, and
all pending receives must be matched by a send.
`MPI_Finalize` is collective over all connected processes. If no processes
were spawned, accepted, or connected, then this means it is collective
over `MPI_COMM_WORLD`. Otherwise, it is collective over the union of all
processes that have been and continue to be connected.
# Notes
All processes must call this routine before exiting. All processes will
still exist but may not make any further MPI calls. `MPI_Finalize`
guarantees that all local actions required by communications the user
has completed will, in fact, occur before it returns. However,
`MPI_Finalize` guarantees nothing about pending communications that have
not been completed; completion is ensured only by `MPI_Wait`, `MPI_Test,`
or `MPI_Request_free` combined with some other verification of completion.
For example, a successful return from a blocking communication operation
or from `MPI_Wait` or `MPI_Test` means that the communication is completed
by the user and the buffer can be reused, but does not guarantee that
the local process has no more work to do. Similarly, a successful return
from `MPI_Request_free` with a request handle generated by an `MPI_Isend`
nullifies the handle but does not guarantee that the operation has
completed. The `MPI_Isend` is complete only when a matching receive has
completed.
If you would like to cause actions to happen when a process finishes,
attach an attribute to `MPI_COMM_SELF` with a callback function. Then,
when `MPI_Finalize` is called, it will first execute the equivalent of an
`MPI_Comm_free` on `MPI_COMM_SELF`. This will cause the delete callback
function to be executed on all keys associated with `MPI_COMM_SELF` in an
arbitrary order. If no key has been attached to `MPI_COMM_SELF`, then no
callback is invoked. This freeing of `MPI_COMM_SELF` happens before any
other parts of MPI are affected. Calling `MPI_Finalized` will thus return
"false" in any of these callback functions. Once you have done this
with `MPI_COMM_SELF`, the results of `MPI_Finalize` are not specified.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
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.
# See Also
[`MPI_Init`(3)](MPI_Init.html)
[`MPI_Init_thread`(3)](MPI_Init_thread.html)
[`MPI_Initialized`(3)](MPI_Initialized.html)
[`MPI_Finalized`(3)](MPI_Finalized.html)

Просмотреть файл

@ -1,65 +0,0 @@
.\" -*- nroff -*-
.\" Copyright (c) 2010-2015 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_Finalized 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Finalized \fP \- Checks whether MPI has been finalized
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Finalized(int \fI*flag\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FINALIZED(\fIFLAG\fP, \fIIERROR\fP)
LOGICAL \fIFLAG\fP
INTEGER \fIIERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Finalized(\fIflag\fP, \fIierror\fP)
LOGICAL, INTENT(OUT) :: \fIflag\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH OUTPUT PARAMETER
.ft R
.TP 1i
flag
True if MPI was finalized, and false otherwise (logical).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
This routine may be used to determine whether MPI has been finalized.
It is one of a small number of routines that may be called before MPI
is initialized and after MPI has been finalized (MPI_Initialized is
another).
.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
.nf
MPI_Init
MPI_Init_thread
MPI_Initialized
MPI_Finalize

64
ompi/mpi/man/man3/MPI_Finalized.md Обычный файл
Просмотреть файл

@ -0,0 +1,64 @@
# Name
`MPI_Finalized` - Checks whether MPI has been finalized
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_Finalized(int *flag)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FINALIZED(FLAG, IERROR)
LOGICAL FLAG
INTEGER IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_Finalized(flag, ierror)
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Output Parameter
* `flag` : True if MPI was finalized, and false otherwise (logical).
* `IERROR` : Fortran only: Error status (integer).
# Description
This routine may be used to determine whether MPI has been finalized. It
is one of a small number of routines that may be called before MPI is
initialized and after MPI has been finalized (`MPI_Initialized` is
another).
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
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.
# See Also
[`MPI_Init`(3)](MPI_Init.html)
[`MPI_Init_thread`(3)](MPI_Init_thread.html)
[`MPI_Initialized`(3)](MPI_Initialized.html)
[`MPI_Finalize`(3)](MPI_Finalize.html)

Просмотреть файл

@ -1,61 +0,0 @@
.\" -*- nroff -*-
.\" Copyright 2010 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_Free_mem 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Free_mem \fP \- Frees memory that has been allocated using MPI_Alloc_mem.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Free_mem(void *\fIbase\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FREE_MEM(\fIBASE, IERROR\fP)
<type> \fIBASE\fP(*)
INTEGER \fIIERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Free_mem(\fIbase\fP, \fIierror\fP)
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: \fIbase\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT PARAMETER
.ft R
.TP 1i
base
Initial address of memory segment allocated by MPI_Alloc_mem (choice).
.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
MPI_Free_mem frees memory that has been allocated by MPI_Alloc_mem.
.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
MPI_Alloc_mem

64
ompi/mpi/man/man3/MPI_Free_mem.md Обычный файл
Просмотреть файл

@ -0,0 +1,64 @@
# Name
`MPI_Free_mem` - Frees memory that has been allocated using
`MPI_Alloc_mem`.
# Syntax
## C Syntax
```c
#include <mpi.h>
int MPI_Free_mem(void *base)
```
## Fortran Syntax
```fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FREE_MEM(BASE, IERROR)
<type> BASE(*)
INTEGER IERROR
```
## Fortran 2008 Syntax
```fortran
USE mpi_f08
MPI_Free_mem(base, ierror)
TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: base
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```
# Input Parameter
* `base` : Initial address of memory segment allocated by `MPI_Alloc_mem`
(choice).
# Output Parameter
* `IERROR` : Fortran only: Error status (integer).
# Description
`MPI_Free_mem` frees memory that has been allocated by `MPI_Alloc_mem`.
# Errors
Almost all MPI routines return an error value; C routines as the value
of the function and Fortran routines in the last argument.
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.
# See Also
[`MPI_Alloc_mem`(3)](MPI_Alloc_mem.html)

Просмотреть файл

@ -33,7 +33,14 @@ MD_FILES = \
MPI_Status_f2c.3.md \
MPI_Status_f082c.3.md \
MPI_Status_f082f.3.md \
MPI_Bcast.md
MPI_Bcast.md \
MPI_File_write_ordered.md \
MPI_File_write_ordered_begin.md \
MPI_File_write_ordered_end.md \
MPI_File_write_shared.md \
MPI_Finalize.md \
MPI_Finalized.md \
MPI_Free_mem.md
TEMPLATE_FILES = \
MPI_Abort.3in \
@ -181,13 +188,6 @@ TEMPLATE_FILES = \
MPI_File_write_at_all.3in \
MPI_File_write_at_all_begin.3in \
MPI_File_write_at_all_end.3in \
MPI_File_write_ordered.3in \
MPI_File_write_ordered_begin.3in \
MPI_File_write_ordered_end.3in \
MPI_File_write_shared.3in \
MPI_Finalize.3in \
MPI_Finalized.3in \
MPI_Free_mem.3in \
MPI_Gather.3in \
MPI_Igather.3in \
MPI_Gatherv.3in \