bgirgis/cpp-thirdparty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upgrade macos

Browse Source
This commit is contained in:
Bassem Girgis
2025-03-19 08:52:56 -05:00
parent 53580cb51f
commit d29ef955f5
8041 changed files with 1936720 additions and 130842 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
macx64/mpi/mpich/share/man/man1/hydra_nameserver.1
View File

@@ -1,10 +1,19 @@
.TH hydra_nameserver 1 "6/5/2019" " " "HYDRA"
.TH hydra_nameserver 1 "2/3/2025" " " "HYDRA"
.SH NAME
hydra_nameserver \- Internal executable used by Hydra
hydra_nameserver \- program to support MPI
.I s name publishing features with hydra
.SH DESCRIPTION
This executable is designed to not be run directly by users, but to
support the Hydra process manager. As such, no documentation will be
provided here.
Hydra is the default name service for MPI\\
s name publishing features
(MPI_PUBLISH_NAME/MPI_LOOKUP_NAME). For programs launched by separate
hydra instances, a separate nameserver mechanism need be launched in
order for the name publishing to work across multiple process managers.
This can be achieved with hydra_nameserver. For example:
.nf
shell@myhost1$ hydra_nameserver &
shell@myhost1$ mpiexec -hosts myhost1,myhost2 -n 4 -nameserver myhost1 ./a.out
.fi
.SH LOCATION
/tmp/kS7n0Mi0xa/mpich-3.3.1/src/pm/hydra/tools/nameserver/hydra_nameserver.txt
/var/tmp/qbvJ6gPnF7/mpich-4.3.0/src/pm/hydra/mansrc/hydra_nameserver.txt

4
macx64/mpi/mpich/share/man/man1/hydra_persist.1
View File

@@ -1,4 +1,4 @@
.TH hydra_persist 1 "6/5/2019" " " "HYDRA"
.TH hydra_persist 1 "2/3/2025" " " "HYDRA"
.SH NAME
hydra_persist \- Internal executable used by Hydra
.SH DESCRIPTION
@@ -7,4 +7,4 @@ support the Hydra process manager. As such, no documentation will be
provided here.
.SH LOCATION
/tmp/kS7n0Mi0xa/mpich-3.3.1/src/pm/hydra/tools/bootstrap/persist/hydra_persist.txt
/var/tmp/qbvJ6gPnF7/mpich-4.3.0/src/pm/hydra/mansrc/hydra_persist.txt

6
macx64/mpi/mpich/share/man/man1/hydra_pmi_proxy.1
View File

@@ -1,10 +1,10 @@
.TH hydra_pmi_proxy 1 "6/5/2019" " " "HYDRA"
.TH hydra_pmi_proxy 1 "2/3/2025" " " "HYDRA"
.SH NAME
hydra_pmi_proxy \- Internal exectuable used by Hydra
hydra_pmi_proxy \- Internal executable used by Hydra
.SH DESCRIPTION
This executable is designed to not be run directly by users, but to
support the Hydra process manager. As such, no documentation will be
provided here.
.SH LOCATION
/tmp/kS7n0Mi0xa/mpich-3.3.1/src/pm/hydra/pm/pmiserv/hydra_pmi_proxy.txt
/var/tmp/qbvJ6gPnF7/mpich-4.3.0/src/pm/hydra/mansrc/hydra_pmi_proxy.txt

9
macx64/mpi/mpich/share/man/man1/mpicc.1
View File

@@ -1,4 +1,4 @@
.TH mpicc 1 "6/5/2019" " " "MPI"
.TH mpicc 1 "2/3/2025" " " "MPI"
.SH NAME
mpicc \- Compiles and links MPI programs written in C
.SH DESCRIPTION
@@ -73,6 +73,11 @@ for all of the other dependencies.
.PD 1
.PD 0
.TP
.B -mpi
- abi - Compile and link using the standard MPI ABI.
.PD 1
.PD 0
.TP
.B others
- are passed to the compiler or linker. For example,
.I \\-c
@@ -117,7 +122,7 @@ lengths for basic data objects (such as
.I long double
) and that
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
compilers are compatible and may be used interchangeably. There are
exceptions; if you use the
.I MPICH_CC
environment variable or the

9
macx64/mpi/mpich/share/man/man1/mpicxx.1
View File

@@ -1,4 +1,4 @@
.TH mpicxx 1 "6/5/2019" " " "MPI"
.TH mpicxx 1 "2/3/2025" " " "MPI"
.SH NAME
mpicxx \- Compiles and links MPI programs written in C++
.SH DESCRIPTION
@@ -73,6 +73,11 @@ for all of the other dependencies.
.PD 1
.PD 0
.TP
.B -mpi
- abi - Compile and link using the standard MPI ABI.
.PD 1
.PD 0
.TP
.B others
- are passed to the compiler or linker. For example,
.I \\-c
@@ -117,7 +122,7 @@ lengths for basic data objects (such as
.I long double
) and that
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
compilers are compatible and may be used interchangeably. There are
exceptions; if you use the
.I MPICH_CXX
environment variable or the

103
macx64/mpi/mpich/share/man/man1/mpiexec.1
View File

@@ -1,4 +1,4 @@
.TH mpiexec 1 "6/5/2019" " " "MPI"
.TH mpiexec 1 "2/3/2025" " " "HYDRA"
.SH NAME
mpiexec \- Run an MPI program
.SH SYNOPSIS
@@ -27,7 +27,7 @@ mpiexec -n 4 a.out
.fi
The MPI standard specifies the following arguments and their meanings:
The MPI standard suggests the following arguments and their meanings:
.PD 0
.TP
@@ -41,11 +41,6 @@ The MPI standard specifies the following arguments and their meanings:
.PD 1
.PD 0
.TP
.B -arch <architecture name>
- Pick hosts with this architecture type
.PD 1
.PD 0
.TP
.B -wdir <working directory>
- cd to this one
.B before
@@ -53,6 +48,23 @@ running executable
.PD 1
.PD 0
.TP
.B -configfile <name>
- file containing specifications of host/program,
one per line, with # as a comment indicator, e.g., the usual
mpiexec input. The lines excluding comments are concatenated with newlines
replaced with spaces, and are then parsed as command line options.
.PD 1
The following options are reserved by the MPI standard, but they are not
supported by MPICH (hydra):
.PD 0
.TP
.B -arch <architecture name>
- Pick hosts with this architecture type
.PD 1
.PD 0
.TP
.B -path <pathlist>
- use this to find the executable
.PD 1
@@ -67,30 +79,10 @@ of processes (see the MPI-2 specification for more details)
.B -file <name>
- implementation-defined specification file
.PD 1
.PD 0
.TP
.B -configfile <name>
- file containing specifications of host/program,
one per line, with # as a comment indicator, e.g., the usual
mpiexec input, but with ":" replaced with a newline. That is,
the configfile contains lines with -soft, -n etc.
.PD 1
Additional arguments that are specific to the MPICH implementation
are discussed below.
Note that not all of these parameters are meaningful for all
systems. For example, the
.I gforker
version of
.I mpiexec
creates all
processes on the same system on which it is running; in that case, the
.I \\-arch
and
.I \\-host
options are ignored.
The colon character (
.I :
) may be used to separate different executables
@@ -109,6 +101,15 @@ mpiexec -n 4 ocean : -n 8 air
.SH MPICH-SPECIFIC ARGUMENTS
MPICH implements a few process managers. Here we list a general set of
arguments that many of the implementations support. More detailed options
that are supported by a particular implementation, e.g. hydra, are
available via:
.nf
mpiexec -h
.fi
Many of the implementations of process managers in MPICH support the
following arguments to
.I mpiexec
@@ -168,7 +169,7 @@ corresponding
.I \\-env
version, except they apply to all executables, not just
the current executable (in the case that the colon syntax is used to specify
multiple execuables).
multiple executables).
.PD 1
.PD 0
.TP
@@ -266,50 +267,6 @@ is used if
.I MPIEXEC_PORT_RANGE
is not set.
.PD 1
.PD 0
.TP
.B MPIEXEC_PREFIX_DEFAULT
- If this environment variable is set, output
to standard output is prefixed by the rank in
.I MPI_COMM_WORLD
of the
process and output to standard error is prefixed by the rank and the
text
.I (err)
; both are followed by an angle bracket (
.I >
). If
this variable is not set, there is no prefix.
.PD 1
.PD 0
.TP
.B MPIEXEC_PREFIX_STDOUT
- Set the prefix used for lines sent to standard
output. A
.I %d
is replaced with the rank in
.I MPI_COMM_WORLD
; a
.I %w
is
replaced with an indication of which
.I MPI_COMM_WORLD
in MPI jobs that
involve multiple
.I MPI_COMM_WORLD
s (e.g., ones that use
.I MPI_Comm_spawn
or
.I MPI_Comm_connect
).
.PD 1
.PD 0
.TP
.B MPIEXEC_PREFIX_STDERR
- Like
.I MPIEXEC_PREFIX_STDOUT
, but for standard error.
.PD 1
.SH RETURN STATUS
.I mpiexec
@@ -319,3 +276,5 @@ processes created by
\&.
.SH LOCATION
/var/tmp/qbvJ6gPnF7/mpich-4.3.0/src/pm/hydra/mansrc/mpiexec.txt

203
macx64/mpi/mpich/share/man/man1/mpif77.1
View File

@@ -1,203 +0,0 @@
.TH mpif77 1 "6/5/2019" " " "MPI"
.SH NAME
mpif77 \- Compiles and links MPI programs written in Fortran 77
.SH DESCRIPTION
This command can be used to compile and link MPI programs written in
Fortran. It provides the options and any special libraries that are
needed to compile and link MPI programs.
It is important to use this command, particularly when linking programs,
as it provides the necessary libraries.
.SH COMMAND LINE ARGUMENTS
.PD 0
.TP
.B -show
- Show the commands that would be used without
running them
.PD 1
.PD 0
.TP
.B -help
- Give short help
.PD 1
.PD 0
.TP
.B -f77=name
- Use compiler
.I name
instead of the default choice. Use
this only if the compiler is compatible with the MPICH
library (see below)
.PD 1
.PD 0
.TP
.B -config=name
- Load a configuration file for a particular compiler.
This allows a single
.I mpif77
command to be used with
multiple compilers.
.PD 1
.PD 0
.TP
.B -compile_info
- Show the steps for compiling a program. This option
can be used to see what options and include paths are
used by mpif77.
.PD 1
.PD 0
.TP
.B -link_info
- Show the steps for linking a program. This option
can be used to see what options and libraries are used by
mpif77.
.PD 1
.PD 0
.TP
.B -profile=name
- Use the MPI profiling given by name. See below for
details
.PD 1
.PD 0
.TP
.B -echo
- Show exactly what this program is doing.
This option should normally not be used.
.PD 1
.PD 0
.TP
.B -static
- mpi - Use a statically compile MPI library, but shared libraries
for all of the other dependencies.
.PD 1
.PD 0
.TP
.B others
- are passed to the compiler or linker. For example,
.I \\-c
causes files to be compiled,
.I \\-g
selects compilation with
debugging on most systems, and
.I \\-o name
causes linking
with the output executable given the name
.I name
\&.
.PD 1
.SH ENVIRONMENT VARIABLES
The environment variables
.I MPICH_F77
may be used
to select different Fortran compiler and linker. Note that since
MPICH is built with a particular C and Fortran compiler, change the
compilers used can cause problems. Use this only if you could intermix
code compiled with the different compilers.
.SH COMPATIBLE COMPILERS
The MPI library may be used with any compiler that uses the same
lengths for basic data objects (such as
.I long double
) and that
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
exceptions; if you use the
.I MPICH_F77
environment variable or the
.I \\-f77=name
command-line argument to override the choice of compiler
and encounter problems, try reconfiguring MPICH with the new compiler
and installing MPICH in a separate location. See the installation manual
for more details.
.SH EXAMPLES
To compile a single file
.I foo.f
, use
.nf
mpif77 -c foo.f
.fi
To link the output and make an executable, use
.nf
mpif77 -o foo foo.o
.fi
Combining compilation and linking in a single command
.nf
mpif77 -o foo foo.f
.fi
is a convenient way to build simple programs.
.SH SELECTING A PROFILING LIBRARY
The
.I \\-profile=name
argument allows you to specify an MPI profiling
library to be used.
.I name
can have two forms:
.br
A library in the same directory as the MPI library
.br
The name of a profile configuration file
.br
If
.I name
is a library, then this library is included before the MPI
library. This allows the simple use of libraries that make use of the
MPI profiling interface and that are installed in the same directory as
the MPI library.
If
.I name.conf
is the name of a file in the sysconfdir directory, then this
is read and may define the following variables:
.PD 0
.TP
.B PROFILE_PRELIB
- Libraries (and paths) to include before the MPI library
.PD 1
.PD 0
.TP
.B PROFILE_POSTLIB
- Libraries to include after the MPI library
.PD 1
.PD 0
.TP
.B PROFILE_INCPATHS
- C preprocessor arguments for any include files
For example, to add
.I /usr/local/myprof/include
to the include path and
the library
.I libmyprof.a
in
.I /usr/local/myprof/lib
to the link step,
you could create the file
.I myprof.conf
with the lines
.PD 1
.nf
PROFILE_PRELIB="-L/usr/local/myprof/lib -lmyprof"
PROFILE_INCPATHS="-I/usr/local/myprof/include"
.fi
and place it in the sysconfdir directory (this directory is set at
configure time when MPICH is built). Then using the command-line
argument
.I \\-profile=myprof
will cause these
definitions to be added to the relevant compile commands.
.SH SEE ALSO
mpicc, mpicxx, mpifort, mpiexec
.br

4
macx64/mpi/mpich/share/man/man1/mpifort.1
View File

@@ -1,4 +1,4 @@
.TH mpifort 1 "6/5/2019" " " "MPI"
.TH mpifort 1 "2/3/2025" " " "MPI"
.SH NAME
mpifort \- Compiles and links MPI programs written in Fortran 90
.SH DESCRIPTION
@@ -103,7 +103,7 @@ lengths for basic data objects (such as
.I long double
) and that
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
compilers are compatible and may be used interchangeably. There are
exceptions; if you use the
.I MPICH_FC
environment variable or the

11
macx64/mpi/mpich/share/man/man3/MPIR_Type_commit.3
View File

@@ -1,11 +0,0 @@
.TH MPIR_Type_commit 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_commit \- nput Parameters: . datatype_p - pointer to MPI datatype
.SH SYNOPSIS
.nf
int MPIR_Type_commit(MPI_Datatype * datatype_p)
.fi
.SH OUTPUT PARAMETERS
.SH RETURN VALUE
0 on success, -1 on failure.

28
macx64/mpi/mpich/share/man/man3/MPIR_Type_contiguous.3
View File

@@ -1,28 +0,0 @@
.TH MPIR_Type_contiguous 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_contiguous \- create a contiguous datatype
.SH SYNOPSIS
.nf
int MPIR_Type_contiguous(int count, MPI_Datatype oldtype, MPI_Datatype * newtype)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of elements in the contiguous block
.PD 1
.PD 0
.TP
.B oldtype
- type (using handle) of datatype on which vector is based
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newtype
- handle of new contiguous datatype
.PD 1
.SH RETURN VALUE
MPI_SUCCESS on success, MPI error code on failure.

27
macx64/mpi/mpich/share/man/man3/MPIR_Type_dup.3
View File

@@ -1,27 +0,0 @@
.TH MPIR_Type_dup 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_dup \- create a copy of a datatype
.SH SYNOPSIS
.nf
#undef FUNCNAME
#define FUNCNAME MPIR_Type_dup
#undef FCNAME
#define FCNAME MPL_QUOTE(FUNCNAME)
int MPIR_Type_dup(MPI_Datatype oldtype, MPI_Datatype * newtype)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B oldtype
- handle of original datatype
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newtype
- handle of newly created copy of datatype
.PD 1
.SH RETURN VALUE
0 on success, MPI error code on failure.

51
macx64/mpi/mpich/share/man/man3/MPIR_Type_get_contents.3
View File

@@ -1,51 +0,0 @@
.TH MPIR_Type_get_contents 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_get_contents \- get content information from datatype
.SH SYNOPSIS
.nf
int MPIR_Type_get_contents(MPI_Datatype datatype,
int max_integers,
int max_addresses,
int max_datatypes,
int array_of_integers[],
MPI_Aint array_of_addresses[], MPI_Datatype array_of_datatypes[])
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B datatype
- MPI datatype
.PD 1
.PD 0
.TP
.B max_integers
- size of array_of_integers
.PD 1
.PD 0
.TP
.B max_addresses
- size of array_of_addresses
.PD 1
.PD 0
.TP
.B max_datatypes
- size of array_of_datatypes
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B array_of_integers
- integers used in creating type
.PD 1
.PD 0
.TP
.B array_of_addresses
- MPI_Aints used in creating type
.PD 1
.PD 0
.TP
.B array_of_datatypes
- MPI_Datatypes used in creating type
.PD 1

49
macx64/mpi/mpich/share/man/man3/MPIR_Type_indexed.3
View File

@@ -1,49 +0,0 @@
.TH MPIR_Type_indexed 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_indexed \- create an indexed datatype
.SH SYNOPSIS
.nf
int MPIR_Type_indexed(int count,
const int *blocklength_array,
const void *displacement_array,
int dispinbytes, MPI_Datatype oldtype, MPI_Datatype * newtype)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of blocks in type
.PD 1
.PD 0
.TP
.B blocklength_array
- number of elements in each block
.PD 1
.PD 0
.TP
.B displacement_array
- offsets of blocks from start of type (see next
parameter for units)
.PD 1
.PD 0
.TP
.B dispinbytes
- if nonzero, then displacements are in bytes (the
displacement_array is an array of ints), otherwise they in terms of
extent of oldtype (the displacement_array is an array of MPI_Aints)
.PD 1
.PD 0
.TP
.B oldtype
- type (using handle) of datatype on which new type is based
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newtype
- handle of new indexed datatype
.PD 1
.SH RETURN VALUE
0 on success, -1 on failure.

45
macx64/mpi/mpich/share/man/man3/MPIR_Type_struct.3
View File

@@ -1,45 +0,0 @@
.TH MPIR_Type_struct 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_struct \- create a struct datatype
.SH SYNOPSIS
.nf
#undef FUNCNAME
#define FUNCNAME MPIR_Type_struct
#undef FCNAME
#define FCNAME MPL_QUOTE(FUNCNAME)
int MPIR_Type_struct(int count,
const int *blocklength_array,
const MPI_Aint * displacement_array,
const MPI_Datatype * oldtype_array, MPI_Datatype * newtype)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of blocks in vector
.PD 1
.PD 0
.TP
.B blocklength_array
- number of elements in each block
.PD 1
.PD 0
.TP
.B displacement_array
- offsets of blocks from start of type in bytes
.PD 1
.PD 0
.TP
.B oldtype_array
- types (using handle) of datatypes on which vector is based
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newtype
- handle of new struct datatype
.PD 1
.SH RETURN VALUE
MPI_SUCCESS on success, MPI errno on failure.

48
macx64/mpi/mpich/share/man/man3/MPIR_Type_vector.3
View File

@@ -1,48 +0,0 @@
.TH MPIR_Type_vector 3 "6/5/2019" " " "MPI"
.SH NAME
MPIR_Type_vector \- create a vector datatype
.SH SYNOPSIS
.nf
int MPIR_Type_vector(int count,
int blocklength,
MPI_Aint stride,
int strideinbytes, MPI_Datatype oldtype, MPI_Datatype * newtype)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of blocks in vector
.PD 1
.PD 0
.TP
.B blocklength
- number of elements in each block
.PD 1
.PD 0
.TP
.B stride
- distance from beginning of one block to the next (see next
parameter for units)
.PD 1
.PD 0
.TP
.B strideinbytes
- if nonzero, then stride is in bytes, otherwise stride
is in terms of extent of oldtype
.PD 1
.PD 0
.TP
.B oldtype
- type (using handle) of datatype on which vector is based
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newtype
- handle of new vector datatype
.PD 1
.SH RETURN VALUE
0 on success, MPI error code on failure.

178
macx64/mpi/mpich/share/man/man3/MPIX_Allreduce_enqueue.3 Normal file
View File

@@ -0,0 +1,178 @@
.TH MPIX_Allreduce_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Allreduce_enqueue \- Enqueue an allreduce operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Allreduce_enqueue(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPI_Comm comm)
.fi
.nf
int MPIX_Allreduce_enqueue_c(const void *sendbuf, void *recvbuf,
MPI_Count count, MPI_Datatype datatype, MPI_Op op,
MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B sendbuf
- starting address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- data type of elements of send buffer (handle)
.PD 1
.PD 0
.TP
.B op
- operation (handle)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B recvbuf
- starting address of receive buffer (choice)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_OP
- Invalid operation. MPI operations (objects of type
.I MPI_Op
)
must either be one of the predefined operations (e.g.,
.I MPI_SUM
) or
created with
.I MPI_Op_create
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Allreduce_enqueue_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Allreduce_enqueue.3

93
macx64/mpi/mpich/share/man/man3/MPIX_Async_get_state.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Async_get_state 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Async_get_state \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
void * MPIX_Async_get_state(MPIX_Async_thing async_thing)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B async_thing
- opaque pointer for async thing (None)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

118
macx64/mpi/mpich/share/man/man3/MPIX_Async_spawn.3 Normal file
View File

@@ -0,0 +1,118 @@
.TH MPIX_Async_spawn 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Async_spawn \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Async_spawn(MPIX_Async_thing async_thing,
MPIX_Async_poll_function *poll_fn, void *extra_state,
MPIX_Stream stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B async_thing
- opaque pointer for async thing (None)
.PD 1
.PD 0
.TP
.B poll_fn
- user defined poll function for progressing async things (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state for callback function (None)
.PD 1
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

112
macx64/mpi/mpich/share/man/man3/MPIX_Async_start.3 Normal file
View File

@@ -0,0 +1,112 @@
.TH MPIX_Async_start 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Async_start \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Async_start(MPIX_Async_poll_function *poll_fn, void *extra_state,
MPIX_Stream stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B poll_fn
- user defined poll function for progressing async things (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state for callback function (None)
.PD 1
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

106
macx64/mpi/mpich/share/man/man3/MPIX_Comm_agree.3
View File

@@ -1,10 +1,14 @@
.TH MPIX_Comm_agree 3 "6/5/2019" " " "MPI"
.TH MPIX_Comm_agree 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_agree \- Performs agreement operation on comm
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_agree(MPI_Comm comm, int *flag)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -15,68 +19,78 @@ int MPIX_Comm_agree(MPI_Comm comm, int *flag)
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newcomm
- new communicator (handle)
.B flag
- new communicator (logical)
.PD 1
.SH NOTES
The purpose of this collective communication is to agree on the integer value flag and on the group of failed processes in comm.
On completion, all non-failed MPI processes have agreed to set the output integer value of flag to the result of a bitwise AND operation over the contributed input values of flag. If comm is an intercommunicator, the value of flagis a bitwise AND operation over the values contributed by the remote group.
When an MPI process fails before contributing to the operation, the flag is computed ignoring its contribution, and MPIX_Comm_agree raises an error of class MPI_ERR_PROC_FAILED. However, if all MPI processes have acknowledged this failure priorto the call to MPIX_Comm_agree, using MPIX_Comm_failure_ack, the error related to this failure is not raised. When an error of class MPI_ERR_PROC_FAILED is raised, it is consistently raised at allMPI processes, in both the local and remote groups (if applicable).
After MPIX_Comm_agree raised an error of class MPI_ERR_PROC_FAILED, a subse-quent call to MPIX_Comm_failure_ack on comm acknowledges the failure of every MPI process that didn
.I t contribute to the computation offlag.
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
malloc
.I or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
MPI_WTIME
.I and
MPI_WTICK
.I ) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
ierr
.I at the end of the argument list.
ierr
.I is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
call
.I statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
MPI_Datatype
.I ,
MPI_Comm
.I ) are of type
INTEGER
.I in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
MPI_Wtime
.I and
MPI_Wtick
.I ) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
MPI_Comm_set_errhandler
.I (for communicators),
MPI_File_set_errhandler
.I (for files), and
MPI_Win_set_errhandler
.I (for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
MPI_Errhandler_set
.I may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
MPI_ERRORS_RETURN
.I may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -87,10 +101,26 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
MPI_ERR_RANK
.I ).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
MPI_Comm_rank
.I ).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
MPI_Error_string
.I to get more information
about this error code.
.PD 1

121
macx64/mpi/mpich/share/man/man3/MPIX_Comm_create_errhandler_x.3 Normal file
View File

@@ -0,0 +1,121 @@
.TH MPIX_Comm_create_errhandler_x 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_create_errhandler_x \- Creates an MPI-style communicator errorhandler with an extra_state
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_create_errhandler_x(MPIX_Comm_errhandler_function_x *comm_errhandler_fn_x,
MPIX_Destructor_function *destructor_fn,
void *extra_state,
MPI_Errhandler *errhandler)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm_errhandler_fn_x
- user defined error handling procedure with extra_state (function)
.PD 1
.PD 0
.TP
.B destructor_fn
- callback when op is freed (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errhandler
- MPI error handler (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

26
macx64/mpi/mpich/share/man/man3/MPIX_Comm_failure_ack.3
View File

@@ -1,24 +1,23 @@
.TH MPIX_Comm_failure_ack 3 "6/5/2019" " " "MPI"
.TH MPIX_Comm_failure_ack 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_failure_ack \- Acknowledge the current group of failed processes
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_failure_ack(MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- Communicator (handle)
- communicator (handle)
.PD 1
.SH NOTES
Because MPI specifies that null objects (e.g.,
.I MPI_COMM_NULL
) are invalid
as input to MPI routines unless otherwise specified, using
.I MPI_COMM_NULL
as input to this routine is an error.
This local operation gives the users a way to acknowledge all locally notified failures on comm. After the call, unmatched MPI_ANY_SOURCE receive operations that would haveraised an error of class MPI_ERR_PROC_FAILED_PENDING due to MPI process failure proceed without further raising errors due to those acknowledged failures. Also after this call, MPIX_Comm_agree will not raise an error of class MPI_ERR_PROC_FAILED due to those acknowledged failures.
.SH THREAD AND INTERRUPT SAFETY
@@ -77,7 +76,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -94,3 +93,12 @@ communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

40
macx64/mpi/mpich/share/man/man3/MPIX_Comm_failure_get_acked.3
View File

@@ -1,31 +1,30 @@
.TH MPIX_Comm_failure_get_acked 3 "6/5/2019" " " "MPI"
.TH MPIX_Comm_failure_get_acked 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_failure_get_acked \- Get the group of acknowledged failures.
.SH SYNOPSIS
.nf
int MPIX_Comm_failure_get_acked(MPI_Comm comm, MPI_Group * failedgrp)
.fi
.nf
int MPIX_Comm_failure_get_acked(MPI_Comm comm, MPI_Group *failedgrp)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- Communicator (handle)
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B failed_group
- Group (handle)
.B failedgrp
- group of failed processes (handle)
.PD 1
.SH NOTES
Because MPI specifies that null objects (e.g.,
.I MPI_COMM_NULL
) are invalid
as input to MPI routines unless otherwise specified, using
.I MPI_COMM_NULL
as input to this routine is an error.
This local operation returns the group failedgrp of processes, from the communicatorcomm, that have been locally acknowledged as failed by preceding calls to MPIX_Comm_failure_ack. The failedgrp can be empty, that is, equal to MPI_GROUP_EMPTY.
.SH THREAD AND INTERRUPT SAFETY
@@ -84,7 +83,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -95,9 +94,26 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

121
macx64/mpi/mpich/share/man/man3/MPIX_Comm_get_failed.3 Normal file
View File

@@ -0,0 +1,121 @@
.TH MPIX_Comm_get_failed 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_get_failed \- This local operation returns the group of processes that are locally known to have failed.
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_get_failed(MPI_Comm comm, MPI_Group *failedgrp)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B failedgrp
- group of failed processes (handle)
.PD 1
.SH NOTES
The returned failedgrp can be empty, that is, equal to MPI_GROUP_EMPTY.
For any two groups obtained from calls to this routine at the same MPI process with the same comm, the smaller group is a prefix of the larger group, that is, the same failed process will have the same rank in the returned failedgrp.
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

121
macx64/mpi/mpich/share/man/man3/MPIX_Comm_get_stream.3 Normal file
View File

@@ -0,0 +1,121 @@
.TH MPIX_Comm_get_stream 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_get_stream \- Get the stream object that is attached to the communicator
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_get_stream(MPI_Comm comm, int idx, MPIX_Stream *stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B idx
- idx (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

72
macx64/mpi/mpich/share/man/man3/MPIX_Comm_revoke.3
View File

@@ -1,79 +1,19 @@
.TH MPIX_Comm_revoke 3 "6/5/2019" " " "MPI"
.TH MPIX_Comm_revoke 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_revoke \- Prevent a communicator from being used in the future
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_revoke(MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator to revoke
- communicator to revoke (handle)
.PD 1
.SH NOTES
Asynchronously notifies all MPI processes associated with the communicator
.I comm
\&.
This will be manifest by returning the MPIX_ERR_REVOKED during a subsequent MPI
call.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1

84
macx64/mpi/mpich/share/man/man3/MPIX_Comm_shrink.3
View File

@@ -1,10 +1,14 @@
.TH MPIX_Comm_shrink 3 "6/5/2019" " " "MPI"
.TH MPIX_Comm_shrink 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_shrink \- Creates a new communitor from an existing communicator while excluding failed processes
.SH SYNOPSIS
.nf
int MPIX_Comm_shrink(MPI_Comm comm, MPI_Comm * newcomm)
.fi
.nf
int MPIX_Comm_shrink(MPI_Comm comm, MPI_Comm *newcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -19,78 +23,4 @@ int MPIX_Comm_shrink(MPI_Comm comm, MPI_Comm * newcomm)
- new communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.SH NOTES

116
macx64/mpi/mpich/share/man/man3/MPIX_Comm_test_threadcomm.3 Normal file
View File

@@ -0,0 +1,116 @@
.TH MPIX_Comm_test_threadcomm 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Comm_test_threadcomm \- Tests to see if a comm is a threadcomm
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Comm_test_threadcomm(MPI_Comm comm, int *flag)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B flag
- true if comm is an inter-communicator (logical)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

121
macx64/mpi/mpich/share/man/man3/MPIX_File_create_errhandler_x.3 Normal file
View File

@@ -0,0 +1,121 @@
.TH MPIX_File_create_errhandler_x 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_File_create_errhandler_x \- Creates an MPI-style file errorhandler with an extra_state
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_File_create_errhandler_x(MPIX_File_errhandler_function_x *comm_errhandler_fn_x,
MPIX_Destructor_function *destructor_fn,
void *extra_state,
MPI_Errhandler *errhandler)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm_errhandler_fn_x
- user defined error handling procedure with extra_state (function)
.PD 1
.PD 0
.TP
.B destructor_fn
- callback when op is freed (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errhandler
- MPI error handler (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

108
macx64/mpi/mpich/share/man/man3/MPIX_GPU_query_support.3 Normal file
View File

@@ -0,0 +1,108 @@
.TH MPIX_GPU_query_support 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_GPU_query_support \- Returns whether the specific type of GPU is supported
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_GPU_query_support(int gpu_type, int *is_supported)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B gpu_type
- MPIX_GPU_SUPPORT_CUDA, MPIX_GPU_SUPPORT_ZE, or MPIX_GPU_SUPPORT_HIP (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B is_supported
- true if gpu of given type is supported, false otherwise. (logical)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

114
macx64/mpi/mpich/share/man/man3/MPIX_Grequest_class_allocate.3 Normal file
View File

@@ -0,0 +1,114 @@
.TH MPIX_Grequest_class_allocate 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Grequest_class_allocate \- Create and return a user-defined extended request based on a generalized request class
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Grequest_class_allocate(MPIX_Grequest_class greq_class,
void *extra_state, MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B greq_class
- generalized request class (None)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B request
- generalized request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

133
macx64/mpi/mpich/share/man/man3/MPIX_Grequest_class_create.3 Normal file
View File

@@ -0,0 +1,133 @@
.TH MPIX_Grequest_class_create 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Grequest_class_create \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Grequest_class_create(MPI_Grequest_query_function *query_fn,
MPI_Grequest_free_function *free_fn,
MPI_Grequest_cancel_function *cancel_fn,
MPIX_Grequest_poll_function *poll_fn,
MPIX_Grequest_wait_function *wait_fn,
MPIX_Grequest_class *greq_class)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B query_fn
- callback function invoked when request status is queried (function)
.PD 1
.PD 0
.TP
.B free_fn
- callback function invoked when request is freed (function)
.PD 1
.PD 0
.TP
.B cancel_fn
- callback function invoked when request is cancelled (function)
.PD 1
.PD 0
.TP
.B poll_fn
- callback function invoked when request completion is tested (function)
.PD 1
.PD 0
.TP
.B wait_fn
- callback function invoked when request is waited on (function)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B greq_class
- generalized request class (None)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

138
macx64/mpi/mpich/share/man/man3/MPIX_Grequest_start.3 Normal file
View File

@@ -0,0 +1,138 @@
.TH MPIX_Grequest_start 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Grequest_start \- Create and return a user-defined extended request
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Grequest_start(MPI_Grequest_query_function *query_fn,
MPI_Grequest_free_function *free_fn,
MPI_Grequest_cancel_function *cancel_fn,
MPIX_Grequest_poll_function *poll_fn,
MPIX_Grequest_wait_function *wait_fn, void *extra_state,
MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B query_fn
- callback function invoked when request status is queried (function)
.PD 1
.PD 0
.TP
.B free_fn
- callback function invoked when request is freed (function)
.PD 1
.PD 0
.TP
.B cancel_fn
- callback function invoked when request is cancelled (function)
.PD 1
.PD 0
.TP
.B poll_fn
- callback function invoked when request completion is tested (function)
.PD 1
.PD 0
.TP
.B wait_fn
- callback function invoked when request is waited on (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B request
- generalized request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

122
macx64/mpi/mpich/share/man/man3/MPIX_Info_set_hex.3 Normal file
View File

@@ -0,0 +1,122 @@
.TH MPIX_Info_set_hex 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Info_set_hex \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Info_set_hex(MPI_Info info, const char *key, const void *value,
int value_size)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B info
- info object (handle)
.PD 1
.PD 0
.TP
.B key
- key (string)
.PD 1
.PD 0
.TP
.B value
- value (choice)
.PD 1
.PD 0
.TP
.B value_size
- size of value (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_INFO
- Invalid Info
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

205
macx64/mpi/mpich/share/man/man3/MPIX_Irecv_enqueue.3 Normal file
View File

@@ -0,0 +1,205 @@
.TH MPIX_Irecv_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Irecv_enqueue \- Enqueue a nonblocking receive operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Irecv_enqueue(void *buf, int count, MPI_Datatype datatype, int source,
int tag, MPI_Comm comm, MPI_Request *request)
.fi
.nf
int MPIX_Irecv_enqueue_c(void *buf, MPI_Count count, MPI_Datatype datatype,
int source, int tag, MPI_Comm comm,
MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of elements in receive buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each receive buffer element (handle)
.PD 1
.PD 0
.TP
.B source
- rank of source or MPI_ANY_SOURCE (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag or MPI_ANY_TAG (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Irecv_enqueue_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Irecv_enqueue.3

205
macx64/mpi/mpich/share/man/man3/MPIX_Isend_enqueue.3 Normal file
View File

@@ -0,0 +1,205 @@
.TH MPIX_Isend_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Isend_enqueue \- Enqueue a nonblocking send operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Isend_enqueue(const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm, MPI_Request *request)
.fi
.nf
int MPIX_Isend_enqueue_c(const void *buf, MPI_Count count,
MPI_Datatype datatype, int dest, int tag,
MPI_Comm comm, MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each send buffer element (handle)
.PD 1
.PD 0
.TP
.B dest
- rank of destination (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Isend_enqueue_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Isend_enqueue.3

138
macx64/mpi/mpich/share/man/man3/MPIX_Op_create_x.3 Normal file
View File

@@ -0,0 +1,138 @@
.TH MPIX_Op_create_x 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Op_create_x \- Creates a user-defined reduction op with an extra_state
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Op_create_x(MPIX_User_function_x *user_fn_x,
MPIX_Destructor_function *destructor_fn, int commute,
void *extra_state, MPI_Op *op)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B user_fn_x
- user defined function with extra_state (function)
.PD 1
.PD 0
.TP
.B destructor_fn
- callback when op is freed (function)
.PD 1
.PD 0
.TP
.B commute
- true if commutative; false otherwise. (logical)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B op
- operation (handle)
.PD 1
.SH NOTES ON MPIX_USER_FUNCTION_X
The calling list for the user function type is
.nf
typedef void (MPIX_User_function_x) (void * a, void * b,
MPI_Count len, MPI_Datatype datatype,
void *extra_state);
.fi
There are a few differences from MPI_User_function used in MPI_Op_create.
1. It passes len and datatype as scalar input, rather than as addresses.
2. The len is of MPI_Count, rather than int.
3. It accepts a void *extra_state which is passed from users during MPIX_Op_create_x.
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

43
macx64/mpi/mpich/share/man/man3/MPIX_Query_cuda_support.3 Normal file
View File

@@ -0,0 +1,43 @@
.TH MPIX_Query_cuda_support 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Query_cuda_support \- Returns whether CUDA is supported
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Query_cuda_support(void)
.fi
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.

43
macx64/mpi/mpich/share/man/man3/MPIX_Query_hip_support.3 Normal file
View File

@@ -0,0 +1,43 @@
.TH MPIX_Query_hip_support 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Query_hip_support \- Returns whether HIP (AMD GPU) is supported
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Query_hip_support(void)
.fi
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.

43
macx64/mpi/mpich/share/man/man3/MPIX_Query_ze_support.3 Normal file
View File

@@ -0,0 +1,43 @@
.TH MPIX_Query_ze_support 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Query_ze_support \- Returns whether ZE (Intel GPU) is supported
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Query_ze_support(void)
.fi
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.

204
macx64/mpi/mpich/share/man/man3/MPIX_Recv_enqueue.3 Normal file
View File

@@ -0,0 +1,204 @@
.TH MPIX_Recv_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Recv_enqueue \- Enqueue a receive operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Recv_enqueue(void *buf, int count, MPI_Datatype datatype, int source,
int tag, MPI_Comm comm, MPI_Status *status)
.fi
.nf
int MPIX_Recv_enqueue_c(void *buf, MPI_Count count, MPI_Datatype datatype,
int source, int tag, MPI_Comm comm, MPI_Status *status)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of elements in receive buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each receive buffer element (handle)
.PD 1
.PD 0
.TP
.B source
- rank of source or MPI_ANY_SOURCE (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag or MPI_ANY_TAG (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B status
- status object (Status)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Recv_enqueue_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Recv_enqueue.3

93
macx64/mpi/mpich/share/man/man3/MPIX_Request_is_complete.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Request_is_complete 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Request_is_complete \- [short description]
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Request_is_complete(MPI_Request request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

189
macx64/mpi/mpich/share/man/man3/MPIX_Send_enqueue.3 Normal file
View File

@@ -0,0 +1,189 @@
.TH MPIX_Send_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Send_enqueue \- Enqueue a send operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Send_enqueue(const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm)
.fi
.nf
int MPIX_Send_enqueue_c(const void *buf, MPI_Count count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each send buffer element (handle)
.PD 1
.PD 0
.TP
.B dest
- rank of destination (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Send_enqueue_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Send_enqueue.3

121
macx64/mpi/mpich/share/man/man3/MPIX_Session_create_errhandler_x.3 Normal file
View File

@@ -0,0 +1,121 @@
.TH MPIX_Session_create_errhandler_x 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Session_create_errhandler_x \- Creates an MPI-style session errorhandler with an extra_state
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Session_create_errhandler_x(MPIX_Session_errhandler_function_x *comm_errhandler_fn_x,
MPIX_Destructor_function *destructor_fn,
void *extra_state,
MPI_Errhandler *errhandler)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm_errhandler_fn_x
- user defined error handling procedure with extra_state (function)
.PD 1
.PD 0
.TP
.B destructor_fn
- callback when op is freed (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errhandler
- MPI error handler (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

93
macx64/mpi/mpich/share/man/man3/MPIX_Start_progress_thread.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Start_progress_thread 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Start_progress_thread \- Start a progress thread that will poll progress on the given stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Start_progress_thread(MPIX_Stream stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

93
macx64/mpi/mpich/share/man/man3/MPIX_Stop_progress_thread.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Stop_progress_thread 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stop_progress_thread \- Stop the progress thread that polls progress on the given stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stop_progress_thread(MPIX_Stream stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

122
macx64/mpi/mpich/share/man/man3/MPIX_Stream_comm_create.3 Normal file
View File

@@ -0,0 +1,122 @@
.TH MPIX_Stream_comm_create 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_comm_create \- Create a new communicator with local stream attached
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_comm_create(MPI_Comm comm, MPIX_Stream stream,
MPI_Comm *newcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newcomm
- new stream-associated communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

134
macx64/mpi/mpich/share/man/man3/MPIX_Stream_comm_create_multiplex.3 Normal file
View File

@@ -0,0 +1,134 @@
.TH MPIX_Stream_comm_create_multiplex 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_comm_create_multiplex \- Create a new communicator with multiple local streams attached
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_comm_create_multiplex(MPI_Comm comm, int count,
MPIX_Stream array_of_streams[],
MPI_Comm *newcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B count
- list length (non-negative integer)
.PD 1
.PD 0
.TP
.B array_of_streams
- stream object array (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newcomm
- new stream-associated communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

113
macx64/mpi/mpich/share/man/man3/MPIX_Stream_create.3 Normal file
View File

@@ -0,0 +1,113 @@
.TH MPIX_Stream_create 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_create \- Create a new stream object
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_create(MPI_Info info, MPIX_Stream *stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B info
- info argument (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object created (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_INFO
- Invalid Info
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

93
macx64/mpi/mpich/share/man/man3/MPIX_Stream_free.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Stream_free 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_free \- Free a stream object
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_free(MPIX_Stream *stream)
.fi
.SH INPUT/OUTPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

217
macx64/mpi/mpich/share/man/man3/MPIX_Stream_irecv.3 Normal file
View File

@@ -0,0 +1,217 @@
.TH MPIX_Stream_irecv 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_irecv \- Start a nonblocking receive from a specific source stream to a specific local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_irecv(void *buf, int count, MPI_Datatype datatype, int source,
int tag, MPI_Comm comm, int source_stream_index,
int dest_stream_index, MPI_Request *request)
.fi
.nf
int MPIX_Stream_irecv_c(void *buf, MPI_Count count, MPI_Datatype datatype,
int source, int tag, MPI_Comm comm,
int source_stream_index, int dest_stream_index,
MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of elements in receive buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each receive buffer element (handle)
.PD 1
.PD 0
.TP
.B source
- rank of source or MPI_ANY_SOURCE (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag or MPI_ANY_TAG (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B source_stream_index
- source_stream_index (integer)
.PD 1
.PD 0
.TP
.B dest_stream_index
- dest_stream_index (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Stream_irecv_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Stream_irecv.3

217
macx64/mpi/mpich/share/man/man3/MPIX_Stream_isend.3 Normal file
View File

@@ -0,0 +1,217 @@
.TH MPIX_Stream_isend 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_isend \- Start a nonblocking send from a specific local stream to a specific remote stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_isend(const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm, int source_stream_index,
int dest_stream_index, MPI_Request *request)
.fi
.nf
int MPIX_Stream_isend_c(const void *buf, MPI_Count count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm,
int source_stream_index, int dest_stream_index,
MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each send buffer element (handle)
.PD 1
.PD 0
.TP
.B dest
- rank of destination (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B source_stream_index
- source_stream_index (integer)
.PD 1
.PD 0
.TP
.B dest_stream_index
- dest_stream_index (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Stream_isend_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Stream_isend.3

93
macx64/mpi/mpich/share/man/man3/MPIX_Stream_progress.3 Normal file
View File

@@ -0,0 +1,93 @@
.TH MPIX_Stream_progress 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_progress \- Invoke progress on the given stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_progress(MPIX_Stream stream)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B stream
- stream object (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

217
macx64/mpi/mpich/share/man/man3/MPIX_Stream_recv.3 Normal file
View File

@@ -0,0 +1,217 @@
.TH MPIX_Stream_recv 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_recv \- Receive a message from a specific source stream to a specific local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_recv(void *buf, int count, MPI_Datatype datatype, int source,
int tag, MPI_Comm comm, int source_stream_index,
int dest_stream_index, MPI_Status *status)
.fi
.nf
int MPIX_Stream_recv_c(void *buf, MPI_Count count, MPI_Datatype datatype,
int source, int tag, MPI_Comm comm,
int source_stream_index, int dest_stream_index,
MPI_Status *status)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- number of elements in receive buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each receive buffer element (handle)
.PD 1
.PD 0
.TP
.B source
- rank of source or MPI_ANY_SOURCE (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag or MPI_ANY_TAG (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B source_stream_index
- source_stream_index (integer)
.PD 1
.PD 0
.TP
.B dest_stream_index
- dest_stream_index (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B status
- status object (Status)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Stream_recv_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Stream_recv.3

209
macx64/mpi/mpich/share/man/man3/MPIX_Stream_send.3 Normal file
View File

@@ -0,0 +1,209 @@
.TH MPIX_Stream_send 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Stream_send \- Send message from a specific local stream to a specific destination stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Stream_send(const void *buf, int count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm, int source_stream_index,
int dest_stream_index)
.fi
.nf
int MPIX_Stream_send_c(const void *buf, MPI_Count count, MPI_Datatype datatype,
int dest, int tag, MPI_Comm comm,
int source_stream_index, int dest_stream_index)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each send buffer element (handle)
.PD 1
.PD 0
.TP
.B dest
- rank of destination (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B source_stream_index
- source_stream_index (integer)
.PD 1
.PD 0
.TP
.B dest_stream_index
- dest_stream_index (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
\&.
The largest tag value is available through the
the attribute
.I MPI_TAG_UB
\&.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPIX_Stream_send_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPIX_Stream_send.3

104
macx64/mpi/mpich/share/man/man3/MPIX_Threadcomm_finish.3 Normal file
View File

@@ -0,0 +1,104 @@
.TH MPIX_Threadcomm_finish 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Threadcomm_finish \- finish/deactiviate a thread communicator (inside thread parallel regions)
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Threadcomm_finish(MPI_Comm threadcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B threadcomm
- thread communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1
.SH SEE ALSO
MPIX_Threadcomm_init, MPIX_Threadcomm_start, MPIX_Threadcomm_free
.br

104
macx64/mpi/mpich/share/man/man3/MPIX_Threadcomm_free.3 Normal file
View File

@@ -0,0 +1,104 @@
.TH MPIX_Threadcomm_free 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Threadcomm_free \- free a thread communicator (outside thread parallel regions)
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Threadcomm_free(MPI_Comm *threadcomm)
.fi
.SH INPUT/OUTPUT PARAMETERS
.PD 0
.TP
.B threadcomm
- thread communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1
.SH SEE ALSO
MPIX_Threadcomm_init, MPIX_Threadcomm_start, MPIX_Threadcomm_finish
.br

125
macx64/mpi/mpich/share/man/man3/MPIX_Threadcomm_init.3 Normal file
View File

@@ -0,0 +1,125 @@
.TH MPIX_Threadcomm_init 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Threadcomm_init \- initialize a thread communicator (outside thread parallel regions)
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Threadcomm_init(MPI_Comm comm, int num_threads,
MPI_Comm *newthreadcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B num_threads
- number of participating threads (non-negative integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B newthreadcomm
- new thread communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1
.SH SEE ALSO
MPIX_Threadcomm_start, MPIX_Threadcomm_finish, MPIX_Threadcomm_free
.br

104
macx64/mpi/mpich/share/man/man3/MPIX_Threadcomm_start.3 Normal file
View File

@@ -0,0 +1,104 @@
.TH MPIX_Threadcomm_start 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Threadcomm_start \- start/activiate a thread communicator (inside thread parallel regions)
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Threadcomm_start(MPI_Comm threadcomm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B threadcomm
- thread communicator (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1
.SH SEE ALSO
MPIX_Threadcomm_init, MPIX_Threadcomm_finish, MPIX_Threadcomm_free
.br

133
macx64/mpi/mpich/share/man/man3/MPIX_Type_iov.3 Normal file
View File

@@ -0,0 +1,133 @@
.TH MPIX_Type_iov 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Type_iov \- Return contiguous segments starting from an iov offset
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Type_iov(MPI_Datatype datatype, MPI_Count iov_offset, MPIX_Iov *iov,
MPI_Count max_iov_len, MPI_Count *actual_iov_len)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B datatype
- datatype (handle)
.PD 1
.PD 0
.TP
.B iov_offset
- number of contiguous segments to skip (integer)
.PD 1
.PD 0
.TP
.B max_iov_len
- capacity for the segments array (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B iov
- contiguous segments array for output (None)
.PD 1
.PD 0
.TP
.B actual_iov_len
- actual number of segments in output (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

128
macx64/mpi/mpich/share/man/man3/MPIX_Type_iov_len.3 Normal file
View File

@@ -0,0 +1,128 @@
.TH MPIX_Type_iov_len 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Type_iov_len \- Return the number of contiguous segments within max_iov_bytes
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Type_iov_len(MPI_Datatype datatype, MPI_Count max_iov_bytes,
MPI_Count *iov_len, MPI_Count *actual_iov_bytes)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B datatype
- datatype (handle)
.PD 1
.PD 0
.TP
.B max_iov_bytes
- maximum number bytes in the iovs (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B iov_len
- number of iovs within max_iov_bytes (integer)
.PD 1
.PD 0
.TP
.B actual_iov_bytes
- actual number of bytes in the iovs (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

120
macx64/mpi/mpich/share/man/man3/MPIX_Wait_enqueue.3 Normal file
View File

@@ -0,0 +1,120 @@
.TH MPIX_Wait_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Wait_enqueue \- Enqueue a wait operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Wait_enqueue(MPI_Request *request, MPI_Status *status)
.fi
.SH INPUT/OUTPUT PARAMETERS
.PD 0
.TP
.B request
- request (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B status
- status object (Status)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_REQUEST
- Invalid
.I MPI_Request
\&.
Either null or, in the case of a
.I MPI_Start
or
.I MPI_Startall
, not a persistent request.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

126
macx64/mpi/mpich/share/man/man3/MPIX_Waitall_enqueue.3 Normal file
View File

@@ -0,0 +1,126 @@
.TH MPIX_Waitall_enqueue 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Waitall_enqueue \- Enqueue a waitall operation to a GPU stream that is associated with the local stream
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Waitall_enqueue(int count, MPI_Request array_of_requests[],
MPI_Status *array_of_statuses)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B count
- lists length (non-negative integer)
.PD 1
.SH INPUT/OUTPUT PARAMETERS
.PD 0
.TP
.B array_of_requests
- array of requests (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B array_of_statuses
- array of status objects (Status)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_REQUEST
- Invalid
.I MPI_Request
\&.
Either null or, in the case of a
.I MPI_Start
or
.I MPI_Startall
, not a persistent request.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

120
macx64/mpi/mpich/share/man/man3/MPIX_Win_create_errhandler_x.3 Normal file
View File

@@ -0,0 +1,120 @@
.TH MPIX_Win_create_errhandler_x 3 "2/3/2025" " " "MPI"
.SH NAME
MPIX_Win_create_errhandler_x \- Creates an MPI-style window errorhandler with an extra_state
.SH SYNOPSIS
.nf
.fi
.nf
int MPIX_Win_create_errhandler_x(MPIX_Win_errhandler_function_x *comm_errhandler_fn_x,
MPIX_Destructor_function *destructor_fn,
void *extra_state, MPI_Errhandler *errhandler)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm_errhandler_fn_x
- user defined error handling procedure with extra_state (function)
.PD 1
.PD 0
.TP
.B destructor_fn
- callback when op is freed (function)
.PD 1
.PD 0
.TP
.B extra_state
- extra state (None)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errhandler
- MPI error handler (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_2DOUBLE_PRECISION.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_2INT.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_2INTEGER.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_2REAL.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_ANY_SOURCE.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_ANY_TAG.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_APPNUM.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_ARGVS_NULL.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

1
macx64/mpi/mpich/share/man/man3/MPI_ARGV_NULL.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

29
macx64/mpi/mpich/share/man/man3/MPI_Abort.3
View File

@@ -1,20 +1,24 @@
.TH MPI_Abort 3 "6/5/2019" " " "MPI"
.TH MPI_Abort 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Abort \- Terminates MPI execution environment
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Abort(MPI_Comm comm, int errorcode)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B comm
- communicator of tasks to abort
- communicator of tasks to abort (handle)
.PD 1
.PD 0
.TP
.B errorcode
- error code to return to invoking environment
- error code to return to invoking environment (integer)
.PD 1
.SH NOTES
@@ -93,7 +97,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -102,3 +106,20 @@ possible.
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

65
macx64/mpi/mpich/share/man/man3/MPI_Accumulate.3
View File

@@ -1,13 +1,24 @@
.TH MPI_Accumulate 3 "6/5/2019" " " "MPI"
.TH MPI_Accumulate 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Accumulate \- Accumulate data into the target process using remote memory access
.SH SYNOPSIS
.nf
int MPI_Accumulate(const void *origin_addr, int origin_count, MPI_Datatype
origin_datatype, int target_rank, MPI_Aint
target_disp, int target_count, MPI_Datatype
target_datatype, MPI_Op op, MPI_Win win)
.fi
.nf
int MPI_Accumulate(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, int target_count,
MPI_Datatype target_datatype, MPI_Op op, MPI_Win win)
.fi
.nf
int MPI_Accumulate_c(const void *origin_addr, MPI_Count origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, MPI_Count target_count,
MPI_Datatype target_datatype, MPI_Op op, MPI_Win win)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -17,28 +28,27 @@ int MPI_Accumulate(const void *origin_addr, int origin_count, MPI_Datatype
.PD 0
.TP
.B origin_count
- number of entries in buffer (nonnegative integer)
- number of entries in buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B origin_datatype
- datatype of each buffer entry (handle)
- datatype of each entry (handle)
.PD 1
.PD 0
.TP
.B target_rank
- rank of target (nonnegative integer)
- rank of target (non-negative integer)
.PD 1
.PD 0
.TP
.B target_disp
- displacement from start of window to beginning of target
buffer (nonnegative integer)
- displacement from start of window to beginning of target buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B target_count
- number of entries in target buffer (nonnegative integer)
- number of entries in target buffer (non-negative integer)
.PD 1
.PD 0
.TP
@@ -48,7 +58,7 @@ buffer (nonnegative integer)
.PD 0
.TP
.B op
- predefined reduce operation (handle)
- reduce operation (handle)
.PD 1
.PD 0
.TP
@@ -56,14 +66,6 @@ buffer (nonnegative integer)
- window object (handle)
.PD 1
.SH NOTES
The basic components of both the origin and target datatype must be the same
predefined datatype (e.g., all
.I MPI_INT
or all
.I MPI_DOUBLE_PRECISION
).
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
@@ -112,7 +114,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -123,11 +125,9 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
@@ -137,6 +137,11 @@ non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_DISP
-
.PD 1
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
@@ -165,6 +170,14 @@ in a communication call.
.B MPI_ERR_WIN
- Invalid MPI window object
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1
.SH SEE ALSO
MPI_Raccumulate

1
macx64/mpi/mpich/share/man/man3/MPI_Accumulate_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPI_Accumulate.3

19
macx64/mpi/mpich/share/man/man3/MPI_Add_error_class.3
View File

@@ -1,15 +1,19 @@
.TH MPI_Add_error_class 3 "6/5/2019" " " "MPI"
.TH MPI_Add_error_class 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Add_error_class \- Add an MPI error class to the known classes
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Add_error_class(int *errorclass)
.fi
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errorclass
- New error class
- value for the new error class (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
@@ -69,7 +73,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -80,9 +84,18 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

21
macx64/mpi/mpich/share/man/man3/MPI_Add_error_code.3
View File

@@ -1,22 +1,26 @@
.TH MPI_Add_error_code 3 "6/5/2019" " " "MPI"
.TH MPI_Add_error_code 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Add_error_code \- Add an MPI error code to an MPI error class
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Add_error_code(int errorclass, int *errorcode)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B errorclass
- Error class to add an error code.
- error class (integer)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B errorcode
- New error code for this error class.
- new error code to be associated with errorclass (integer)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
@@ -76,7 +80,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -87,9 +91,18 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

25
macx64/mpi/mpich/share/man/man3/MPI_Add_error_string.3
View File

@@ -1,10 +1,14 @@
.TH MPI_Add_error_string 3 "6/5/2019" " " "MPI"
.TH MPI_Add_error_string 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Add_error_string \- Associates an error string with an MPI error code or class
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Add_error_string(int errorcode, const char *string)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -94,7 +98,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -103,3 +107,20 @@ possible.
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

53
macx64/mpi/mpich/share/man/man3/MPI_Address.3
View File

@@ -1,10 +1,14 @@
.TH MPI_Address 3 "6/5/2019" " " "MPI"
.TH MPI_Address 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Address \- Gets the address of a location in memory
.SH SYNOPSIS
.nf
int MPI_Address(void *location, MPI_Aint * address)
.fi
.nf
int MPI_Address(void *location, MPI_Aint *address)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -16,34 +20,26 @@ int MPI_Address(void *location, MPI_Aint * address)
.PD 0
.TP
.B address
- address of location (address integer)
- address of location (integer)
.PD 1
.SH NOTE
This routine is provided for both the Fortran and C programmers.
On many systems, the address returned by this routine will be the same
as produced by the C
.I &
operator, but this is not required in C and
may not be true of systems with word- rather than byte-oriented
instructions or systems with segmented address spaces.
.SH THREAD AND INTERRUPT SAFETY
This routine is both thread- and interrupt-safe.
This means that this routine may safely be used by multiple threads and
from within a signal handler.
.SH DEPRECATED FUNCTION
The MPI-2 standard deprecated a number of routines because MPI-2 provides
better versions. This routine is one of those that was deprecated. The
routine may continue to be used, but new code should use the replacement
routine.
.SH REMOVED FUNCTION
The current MPI standard defines this routine as removed. The user should use
the replacement routine.
The replacement for this routine is
.I MPI_Get_address
\&.
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
@@ -92,7 +88,7 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
@@ -103,9 +99,18 @@ possible.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_Aint.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/mpiconsts.3

11
macx64/mpi/mpich/share/man/man3/MPI_Aint_add.3
View File

@@ -1,10 +1,14 @@
.TH MPI_Aint_add 3 "6/5/2019" " " "MPI"
.TH MPI_Aint_add 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Aint_add \- Returns the sum of base and disp
.SH SYNOPSIS
.nf
.fi
.nf
MPI_Aint MPI_Aint_add(MPI_Aint base, MPI_Aint disp)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -17,9 +21,6 @@ MPI_Aint MPI_Aint_add(MPI_Aint base, MPI_Aint disp)
- displacement (integer)
.PD 1
.SH RETURN VALUE
Sum of the base and disp argument
.SH NOTES
MPI_Aint_Add produces a new MPI_Aint value that is equivalent to the sum of the
base and disp arguments, where base represents a base address returned by a call
@@ -27,7 +28,7 @@ to MPI_GET_ADDRESS and disp represents a signed integer displacement. The result
address is valid only at the process that generated base, and it must correspond
to a location in the same object referenced by base. The addition is performed in
a manner that results in the correct MPI_Aint representation of the output address,
as if the process that originally produced base had called:
as if the process that originally produced base had called
.nf
MPI_Get_address((char *) base + disp, &result)
.fi

9
macx64/mpi/mpich/share/man/man3/MPI_Aint_diff.3
View File

@@ -1,10 +1,14 @@
.TH MPI_Aint_diff 3 "6/5/2019" " " "MPI"
.TH MPI_Aint_diff 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Aint_diff \- Returns the difference between addr1 and addr2
.SH SYNOPSIS
.nf
.fi
.nf
MPI_Aint MPI_Aint_diff(MPI_Aint addr1, MPI_Aint addr2)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -17,9 +21,6 @@ MPI_Aint MPI_Aint_diff(MPI_Aint addr1, MPI_Aint addr2)
- subtrahend address (integer)
.PD 1
.SH RETURN VALUE
Difference between addr1 and addr2
.SH NOTES
MPI_Aint_diff produces a new MPI_Aint value that is equivalent to the difference
between addr1 and addr2 arguments, where addr1 and addr2 represent addresses

43
macx64/mpi/mpich/share/man/man3/MPI_Allgather.3
View File

@@ -1,11 +1,22 @@
.TH MPI_Allgather 3 "6/5/2019" " " "MPI"
.TH MPI_Allgather 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Allgather \- Gathers data from all tasks and distribute the combined data to all tasks
.SH SYNOPSIS
.nf
int MPI_Allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype, MPI_Comm comm)
.fi
.nf
int MPI_Allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, int recvcount, MPI_Datatype recvtype,
MPI_Comm comm)
.fi
.nf
int MPI_Allgather_c(const void *sendbuf, MPI_Count sendcount,
MPI_Datatype sendtype, void *recvbuf, MPI_Count recvcount,
MPI_Datatype recvtype, MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -15,7 +26,7 @@ int MPI_Allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
.PD 0
.TP
.B sendcount
- number of elements in send buffer (integer)
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
@@ -25,7 +36,7 @@ int MPI_Allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
.PD 0
.TP
.B recvcount
- number of elements received from any process (integer)
- number of elements received from any process (non-negative integer)
.PD 1
.PD 0
.TP
@@ -134,10 +145,21 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
@@ -163,7 +185,10 @@ in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_Allgather_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPI_Allgather.3

187
macx64/mpi/mpich/share/man/man3/MPI_Allgather_init.3 Normal file
View File

@@ -0,0 +1,187 @@
.TH MPI_Allgather_init 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Allgather_init \- Create a persistent request for allgather.
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Allgather_init(const void *sendbuf, int sendcount,
MPI_Datatype sendtype, void *recvbuf, int recvcount,
MPI_Datatype recvtype, MPI_Comm comm, MPI_Info info,
MPI_Request *request)
.fi
.nf
int MPI_Allgather_init_c(const void *sendbuf, MPI_Count sendcount,
MPI_Datatype sendtype, void *recvbuf,
MPI_Count recvcount, MPI_Datatype recvtype,
MPI_Comm comm, MPI_Info info, MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B sendbuf
- starting address of send buffer (choice)
.PD 1
.PD 0
.TP
.B sendcount
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B sendtype
- data type of send buffer elements (handle)
.PD 1
.PD 0
.TP
.B recvcount
- number of elements received from any process (non-negative integer)
.PD 1
.PD 0
.TP
.B recvtype
- data type of receive buffer elements (handle)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B info
- info argument (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B recvbuf
- address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_INFO
- Invalid Info
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_Allgather_init_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPI_Allgather_init.3

55
macx64/mpi/mpich/share/man/man3/MPI_Allgatherv.3
View File

@@ -1,12 +1,23 @@
.TH MPI_Allgatherv 3 "6/5/2019" " " "MPI"
.TH MPI_Allgatherv 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Allgatherv \- Gathers data from all tasks and deliver the combined data to all tasks
.SH SYNOPSIS
.nf
int MPI_Allgatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int *recvcounts, const int *displs,
MPI_Datatype recvtype, MPI_Comm comm)
.fi
.nf
int MPI_Allgatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
void *recvbuf, const int recvcounts[], const int displs[],
MPI_Datatype recvtype, MPI_Comm comm)
.fi
.nf
int MPI_Allgatherv_c(const void *sendbuf, MPI_Count sendcount,
MPI_Datatype sendtype, void *recvbuf,
const MPI_Count recvcounts[], const MPI_Aint displs[],
MPI_Datatype recvtype, MPI_Comm comm)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
@@ -16,7 +27,7 @@ int MPI_Allgatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
.PD 0
.TP
.B sendcount
- number of elements in send buffer (integer)
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
@@ -26,18 +37,12 @@ int MPI_Allgatherv(const void *sendbuf, int sendcount, MPI_Datatype sendtype,
.PD 0
.TP
.B recvcounts
- integer array (of length group size)
containing the number of elements that are to be received from each process
- non-negative integer array (of length group size) containing the number of elements that are received from each process (non-negative integer)
.PD 1
.PD 0
.TP
.B displs
- integer array (of length group size). Entry
.I i
specifies the displacement (relative to recvbuf) at
which to place the incoming data from process
.I i
- integer array (of length group size). Entry i specifies the displacement (relative to recvbuf) at which to place the incoming data from process i (integer)
.PD 1
.PD 0
.TP
@@ -147,10 +152,15 @@ its use is deprecated. The predefined error handler
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
@@ -159,6 +169,14 @@ one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
@@ -172,3 +190,12 @@ occur if an uncommitted MPI_Datatype (see
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_Allgatherv_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPI_Allgatherv.3

194
macx64/mpi/mpich/share/man/man3/MPI_Allgatherv_init.3 Normal file
View File

@@ -0,0 +1,194 @@
.TH MPI_Allgatherv_init 3 "2/3/2025" " " "MPI"
.SH NAME
MPI_Allgatherv_init \- Create a persistent request for allgatherv.
.SH SYNOPSIS
.nf
.fi
.nf
int MPI_Allgatherv_init(const void *sendbuf, int sendcount,
MPI_Datatype sendtype, void *recvbuf,
const int recvcounts[], const int displs[],
MPI_Datatype recvtype, MPI_Comm comm, MPI_Info info,
MPI_Request *request)
.fi
.nf
int MPI_Allgatherv_init_c(const void *sendbuf, MPI_Count sendcount,
MPI_Datatype sendtype, void *recvbuf,
const MPI_Count recvcounts[], const MPI_Aint displs[],
MPI_Datatype recvtype, MPI_Comm comm, MPI_Info info,
MPI_Request *request)
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B sendbuf
- starting address of send buffer (choice)
.PD 1
.PD 0
.TP
.B sendcount
- number of elements in send buffer (non-negative integer)
.PD 1
.PD 0
.TP
.B sendtype
- data type of send buffer elements (handle)
.PD 1
.PD 0
.TP
.B recvcounts
- non-negative integer array (of length group size) containing the number of elements that are received from each process (non-negative integer)
.PD 1
.PD 0
.TP
.B displs
- integer array (of length group size). Entry i specifies the displacement (relative to recvbuf) at which to place the incoming data from process i (integer)
.PD 1
.PD 0
.TP
.B recvtype
- data type of receive buffer elements (handle)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.PD 0
.TP
.B info
- info argument (handle)
.PD 1
.SH OUTPUT PARAMETERS
.PD 0
.TP
.B recvbuf
- address of receive buffer (choice)
.PD 1
.PD 0
.TP
.B request
- communication request (handle)
.PD 1
.SH THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as
.I malloc
or other non-MPICH runtime routines that are themselves not interrupt-safe.
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Comm_set_errhandler
(for communicators),
.I MPI_File_set_errhandler
(for files), and
.I MPI_Win_set_errhandler
(for
RMA windows). The MPI-1 routine
.I MPI_Errhandler_set
may be used but
its use is deprecated. The predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.PD 0
.TP
.B MPI_ERR_BUFFER
- Invalid buffer pointer. Usually a null buffer where
one is not valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_INFO
- Invalid Info
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. Additionally, this error can
occur if an uncommitted MPI_Datatype (see
.I MPI_Type_commit
) is used
in a communication call.
.PD 1
.PD 0
.TP
.B MPI_ERR_OTHER
- Other error; use
.I MPI_Error_string
to get more information
about this error code.
.PD 1

1
macx64/mpi/mpich/share/man/man3/MPI_Allgatherv_init_c.3 Normal file
View File

@@ -0,0 +1 @@
.so man3/MPI_Allgatherv_init.3

Some files were not shown because too many files have changed in this diff Show More