Upgrade macos
This commit is contained in:
Bassem Girgis
@@ -1,71 +1,173 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" 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$
|
||||
.TH MPI_File_read 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_File_read\fP \- Reads a file starting at the location specified by the individual file pointer (blocking, noncollective).
|
||||
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "MPI_FILE_READ" "3" "Feb 14, 2025" "" "Open MPI"
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.sp
|
||||
\fI\%MPI_File_read\fP — Reads a file starting at the location specified by
|
||||
the individual file pointer (blocking, noncollective).
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.nf
|
||||
.SH C Syntax
|
||||
.SS C Syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#include <mpi.h>
|
||||
int MPI_File_read(MPI_File \fIfh\fP, void \fI*buf\fP,
|
||||
int \fIcount\fP, MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP)
|
||||
|
||||
int MPI_File_read(MPI_File fh, void *buf,
|
||||
int count, MPI_Datatype datatype, MPI_Status *status)
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Fortran Syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
USE MPI
|
||||
! or the older form: INCLUDE \(aqmpif.h\(aq
|
||||
MPI_FILE_READ(FH, BUF, COUNT,
|
||||
DATATYPE, STATUS, IERROR)
|
||||
<type> BUF(*)
|
||||
INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE),IERROR
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Fortran 2008 Syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
USE mpi_f08
|
||||
MPI_File_read(fh, buf, count, datatype, status, ierror)
|
||||
TYPE(MPI_File), INTENT(IN) :: fh
|
||||
TYPE(*), DIMENSION(..) :: buf
|
||||
INTEGER, INTENT(IN) :: count
|
||||
TYPE(MPI_Datatype), INTENT(IN) :: datatype
|
||||
TYPE(MPI_Status) :: status
|
||||
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH INPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
fh
|
||||
File handle (handle).
|
||||
.TP 1i
|
||||
count
|
||||
Number of elements in buffer (integer).
|
||||
.TP 1i
|
||||
datatype
|
||||
Data type of each buffer element (handle).
|
||||
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBfh\fP: File handle (handle).
|
||||
.IP \(bu 2
|
||||
\fBcount\fP: Number of elements in buffer (integer).
|
||||
.IP \(bu 2
|
||||
\fBdatatype\fP: Data type of each buffer element (handle).
|
||||
.UNINDENT
|
||||
.SH OUTPUT PARAMETERS
|
||||
.ft R
|
||||
.TP 1i
|
||||
buf
|
||||
Initial address of buffer (integer).
|
||||
.TP 1i
|
||||
status
|
||||
Status object (status).
|
||||
.TP 1i
|
||||
IERROR
|
||||
Fortran only: Error status (integer).
|
||||
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBbuf\fP: Initial address of buffer (integer).
|
||||
.IP \(bu 2
|
||||
\fBstatus\fP: Status object (status).
|
||||
.IP \(bu 2
|
||||
\fBierror\fP: Fortran only: Error status (integer).
|
||||
.UNINDENT
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
MPI_File_read attempts to read from the file associated with
|
||||
.I fh
|
||||
(at the current individual file pointer position maintained by the system) a total number of
|
||||
.I count
|
||||
data items having
|
||||
.I datatype
|
||||
type into the user's buffer
|
||||
.I buf.
|
||||
The data is taken out of those parts of the
|
||||
file specified by the current view. MPI_File_read stores the
|
||||
number of data-type elements actually read in
|
||||
.I status.
|
||||
All other fields of
|
||||
.I status
|
||||
are undefined.
|
||||
.sp
|
||||
It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened.
|
||||
|
||||
\fI\%MPI_File_read\fP attempts to read from the file associated with \fIfh\fP (at
|
||||
the current individual file pointer position maintained by the system) a
|
||||
total number of \fIcount\fP data items having \fIdatatype\fP type into the
|
||||
user’s buffer \fIbuf.\fP The data is taken out of those parts of the file
|
||||
specified by the current view. \fI\%MPI_File_read\fP stores the number of
|
||||
data\-type elements actually read in \fIstatus.\fP All other fields of
|
||||
\fIstatus\fP are undefined.
|
||||
.sp
|
||||
It is erroneous to call this function if \fBMPI_MODE_SEQUENTIAL\fP mode was
|
||||
specified when the file was opened.
|
||||
.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. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.
|
||||
.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.
|
||||
|
||||
Almost all MPI routines return an error value; C routines as the return result
|
||||
of the function and Fortran routines in the last argument.
|
||||
.sp
|
||||
Before the error value is returned, the current MPI error handler associated
|
||||
with the communication object (e.g., communicator, window, file) is called.
|
||||
If no communication object is associated with the MPI call, then the call is
|
||||
considered attached to MPI_COMM_SELF and will call the associated MPI error
|
||||
handler. When MPI_COMM_SELF is not initialized (i.e., before
|
||||
\fI\%MPI_Init\fP/\fI\%MPI_Init_thread\fP, after \fI\%MPI_Finalize\fP, or when using the Sessions
|
||||
Model exclusively) the error raises the initial error handler. The initial
|
||||
error handler can be changed by calling \fI\%MPI_Comm_set_errhandler\fP on
|
||||
MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI
|
||||
argument to mpiexec or info key to \fI\%MPI_Comm_spawn\fP/\fI\%MPI_Comm_spawn_multiple\fP\&.
|
||||
If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
|
||||
error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error
|
||||
handler is called for all other MPI functions.
|
||||
.sp
|
||||
Open MPI includes three predefined error handlers that can be used:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_ARE_FATAL\fP
|
||||
Causes the program to abort all connected MPI processes.
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_ABORT\fP
|
||||
An error handler that can be invoked on a communicator,
|
||||
window, file, or session. When called on a communicator, it
|
||||
acts as if \fI\%MPI_Abort\fP was called on that communicator. If
|
||||
called on a window or file, acts as if \fI\%MPI_Abort\fP was called
|
||||
on a communicator containing the group of processes in the
|
||||
corresponding window or file. If called on a session,
|
||||
aborts only the local process.
|
||||
.IP \(bu 2
|
||||
\fBMPI_ERRORS_RETURN\fP
|
||||
Returns an error code to the application.
|
||||
.UNINDENT
|
||||
.sp
|
||||
MPI applications can also implement their own error handlers by calling:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Comm_create_errhandler\fP then \fI\%MPI_Comm_set_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_File_create_errhandler\fP then \fI\%MPI_File_set_errhandler\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Session_create_errhandler\fP then \fI\%MPI_Session_set_errhandler\fP or at \fI\%MPI_Session_init\fP
|
||||
.IP \(bu 2
|
||||
\fI\%MPI_Win_create_errhandler\fP then \fI\%MPI_Win_set_errhandler\fP
|
||||
.UNINDENT
|
||||
.sp
|
||||
Note that MPI does not guarantee that an MPI program can continue past
|
||||
an error.
|
||||
.sp
|
||||
See the \fI\%MPI man page\fP for a full list of \fI\%MPI error codes\fP\&.
|
||||
.sp
|
||||
See the Error Handling section of the MPI\-3.1 standard for
|
||||
more information.
|
||||
.SH COPYRIGHT
|
||||
2003-2025, The Open MPI Community
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
|
||||
Reference in New Issue
Block a user