update openmpi linux
This commit is contained in:
Bassem Girgis
1
linx64/mpi/openmpi/share/man/man1/mpiCC.1
Symbolic link
1
linx64/mpi/openmpi/share/man/man1/mpiCC.1
Symbolic link
@@ -0,0 +1 @@
|
||||
mpic++.1
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH mpic++ 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH mpic++ 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpic++ -- Open MPI C++ wrapper compiler
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH mpicc 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH mpicc 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpicc -- Open MPI C wrapper compiler
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH mpicxx 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH mpicxx 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpicxx -- Open MPI C++ wrapper compiler
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
.\" Man page for ORTE's orterun command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH MPIRUN 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPIRUN 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
@@ -341,7 +341,10 @@ MPI_COMM_WORLD ranks in a round-robin, "by node" manner.
|
||||
.
|
||||
.TP
|
||||
.B -cpu-list\fR,\fP --cpu-list \fR<cpus>\fP
|
||||
List of processor IDs to bind processes to [default=NULL].
|
||||
Comma-delimited list of processor IDs to which to bind processes
|
||||
[default=NULL]. Processor IDs are interpreted as hwloc logical core
|
||||
IDs. Run the hwloc \fIlstopo(1)\fR command to see a list of available
|
||||
cores and their logical IDs.
|
||||
.
|
||||
.
|
||||
.
|
||||
@@ -366,7 +369,7 @@ For process binding:
|
||||
.TP
|
||||
.B --bind-to \fR<foo>\fP
|
||||
Bind processes to the specified object, defaults to \fIcore\fP. Supported options
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, and none.
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, cpu-list, and none.
|
||||
.
|
||||
.TP
|
||||
.B -cpus-per-proc\fR,\fP --cpus-per-proc \fR<#perproc>\fP
|
||||
@@ -642,7 +645,10 @@ Allow
|
||||
.I mpirun
|
||||
to run when executed by the root user
|
||||
.RI ( mpirun
|
||||
defaults to aborting when launched as the root user).
|
||||
defaults to aborting when launched as the root user). Be sure to see
|
||||
the
|
||||
.I Running as root
|
||||
section, below, for more detail.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
@@ -1149,6 +1155,17 @@ cause the process to be bound to the processors that share a single L3
|
||||
cache within that socket.
|
||||
.
|
||||
.PP
|
||||
Alternatively, processes can be assigned to processors based on their
|
||||
local rank on a node using the \fI--bind-to cpu-list:ordered\fP option
|
||||
with an associated \fI--cpu-list "0,2,5"\fP. In this example, the
|
||||
first process on a node will be bound to cpu 0, the second process on
|
||||
the node will be bound to cpu 2, and the third process on the node
|
||||
will be bound to cpu 5. \fI--bind-to\fP will also accept
|
||||
\fIcpulist:ortered\fP as a synonym to \fIcpu-list:ordered\fP. Note
|
||||
that an error will result if more processes are assigned to a node
|
||||
than cpus are provided.
|
||||
.
|
||||
.PP
|
||||
To help balance loads, the binding directive uses a round-robin method when binding to
|
||||
levels lower than used in the mapper. For example, consider the case where a job is
|
||||
mapped to the socket level, and then bound to core. Each socket will have multiple cores,
|
||||
@@ -1614,7 +1631,26 @@ To override this default, you can add the
|
||||
.I --allow-run-as-root
|
||||
option to the
|
||||
.I mpirun
|
||||
command line.
|
||||
command line, or you can set the environmental parameters
|
||||
.I OMPI_ALLOW_RUN_AS_ROOT=1
|
||||
and
|
||||
.IR OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1 .
|
||||
Note that it takes setting
|
||||
.I two
|
||||
environment variables to effect the same behavior as
|
||||
.I --allow-run-as-root
|
||||
in order to stress the Open MPI team's strong advice against running
|
||||
as the root user. After extended discussions with communities who use
|
||||
containers (where running as the root user is the default), there was
|
||||
a persistent desire to be able to enable root execution of
|
||||
.I mpirun
|
||||
via an environmental control (vs. the existing
|
||||
.I --allow-run-as-root
|
||||
command line parameter). The compromise of using
|
||||
.I two
|
||||
environment variables was reached: it allows root execution via an
|
||||
environmental control, but it conveys the Open MPI team's strong
|
||||
recomendation against this behavior.
|
||||
.
|
||||
.SS Exit status
|
||||
.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH "mpif77,mpif90" 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH "mpif77,mpif90" 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpif77, mpif90 -- Deprecated Open MPI Fortran wrapper compilers
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH "mpif77,mpif90" 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH "mpif77,mpif90" 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpif77, mpif90 -- Deprecated Open MPI Fortran wrapper compilers
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH mpifort 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH mpifort 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
mpifort -- Open MPI Fortran wrapper compiler
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
.\" Man page for ORTE's orterun command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH MPIRUN 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPIRUN 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
@@ -341,7 +341,10 @@ MPI_COMM_WORLD ranks in a round-robin, "by node" manner.
|
||||
.
|
||||
.TP
|
||||
.B -cpu-list\fR,\fP --cpu-list \fR<cpus>\fP
|
||||
List of processor IDs to bind processes to [default=NULL].
|
||||
Comma-delimited list of processor IDs to which to bind processes
|
||||
[default=NULL]. Processor IDs are interpreted as hwloc logical core
|
||||
IDs. Run the hwloc \fIlstopo(1)\fR command to see a list of available
|
||||
cores and their logical IDs.
|
||||
.
|
||||
.
|
||||
.
|
||||
@@ -366,7 +369,7 @@ For process binding:
|
||||
.TP
|
||||
.B --bind-to \fR<foo>\fP
|
||||
Bind processes to the specified object, defaults to \fIcore\fP. Supported options
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, and none.
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, cpu-list, and none.
|
||||
.
|
||||
.TP
|
||||
.B -cpus-per-proc\fR,\fP --cpus-per-proc \fR<#perproc>\fP
|
||||
@@ -642,7 +645,10 @@ Allow
|
||||
.I mpirun
|
||||
to run when executed by the root user
|
||||
.RI ( mpirun
|
||||
defaults to aborting when launched as the root user).
|
||||
defaults to aborting when launched as the root user). Be sure to see
|
||||
the
|
||||
.I Running as root
|
||||
section, below, for more detail.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
@@ -1149,6 +1155,17 @@ cause the process to be bound to the processors that share a single L3
|
||||
cache within that socket.
|
||||
.
|
||||
.PP
|
||||
Alternatively, processes can be assigned to processors based on their
|
||||
local rank on a node using the \fI--bind-to cpu-list:ordered\fP option
|
||||
with an associated \fI--cpu-list "0,2,5"\fP. In this example, the
|
||||
first process on a node will be bound to cpu 0, the second process on
|
||||
the node will be bound to cpu 2, and the third process on the node
|
||||
will be bound to cpu 5. \fI--bind-to\fP will also accept
|
||||
\fIcpulist:ortered\fP as a synonym to \fIcpu-list:ordered\fP. Note
|
||||
that an error will result if more processes are assigned to a node
|
||||
than cpus are provided.
|
||||
.
|
||||
.PP
|
||||
To help balance loads, the binding directive uses a round-robin method when binding to
|
||||
levels lower than used in the mapper. For example, consider the case where a job is
|
||||
mapped to the socket level, and then bound to core. Each socket will have multiple cores,
|
||||
@@ -1614,7 +1631,26 @@ To override this default, you can add the
|
||||
.I --allow-run-as-root
|
||||
option to the
|
||||
.I mpirun
|
||||
command line.
|
||||
command line, or you can set the environmental parameters
|
||||
.I OMPI_ALLOW_RUN_AS_ROOT=1
|
||||
and
|
||||
.IR OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1 .
|
||||
Note that it takes setting
|
||||
.I two
|
||||
environment variables to effect the same behavior as
|
||||
.I --allow-run-as-root
|
||||
in order to stress the Open MPI team's strong advice against running
|
||||
as the root user. After extended discussions with communities who use
|
||||
containers (where running as the root user is the default), there was
|
||||
a persistent desire to be able to enable root execution of
|
||||
.I mpirun
|
||||
via an environmental control (vs. the existing
|
||||
.I --allow-run-as-root
|
||||
command line parameter). The compromise of using
|
||||
.I two
|
||||
environment variables was reached: it allows root execution via an
|
||||
environmental control, but it conveys the Open MPI team's strong
|
||||
recomendation against this behavior.
|
||||
.
|
||||
.SS Exit status
|
||||
.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Corporation. All rights reserved.
|
||||
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
||||
.\"
|
||||
.TH orte-clean 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH orte-clean 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBorte-clean\fP - Cleans up any stale processes and files leftover
|
||||
from Open MPI jobs.
|
||||
|
||||
@@ -1,101 +0,0 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
|
||||
.\" University Research and Technology
|
||||
.\" Corporation. All rights reserved.
|
||||
.\" Copyright (c) 2008-2009 Sun Microsystems, Inc. All rights reserved.
|
||||
.\"
|
||||
.\" Man page for OMPI's ompi-ps command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-PS 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
.SH NAME
|
||||
.
|
||||
ompi-ps, orte-ps \- Displays information about the active jobs and processes
|
||||
in Open MPI.
|
||||
.
|
||||
.PP
|
||||
.
|
||||
\fBNOTE:\fP \fIompi-ps\fP, and \fIorte-ps\fP are exact
|
||||
synonyms for each other. Using any of the names will result in exactly
|
||||
identical behavior.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.
|
||||
.B ompi-ps
|
||||
.B [ options ]
|
||||
.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH Options
|
||||
.
|
||||
\fIompi-ps\fR will display information about running job(s) in the current
|
||||
universe.
|
||||
.
|
||||
.TP 10
|
||||
.B -h | --help
|
||||
Display help for this command
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -v | --verbose
|
||||
Enable verbose output for debugging
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B --daemons
|
||||
Display daemon job information.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -j | --jobid
|
||||
Display the state of a specific job in the universe. By default all jobs will
|
||||
be displayed.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -p | --vpid
|
||||
Display the state of a specific vpid (process) in the universe. By default all
|
||||
vpids cooresponding to processes will be displayed. Must be used in conjunction
|
||||
with the \fB--jobid\fP option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -n | --nodes
|
||||
Display all of the allocated nodes, and their cooresponding states. By default
|
||||
this is disabled.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -gmca | --gmca \fR<key> <value>\fP
|
||||
Pass global MCA parameters that are applicable to all contexts. \fI<key>\fP is
|
||||
the parameter name; \fI<value>\fP is the parameter value.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -mca | --mca <key> <value>
|
||||
Send arguments to various MCA modules.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.
|
||||
.PP
|
||||
\fIompi-ps\fR displays the state of jobs running inside an Open RTE universe.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" See Also Section
|
||||
.\" **************************
|
||||
.
|
||||
.SH SEE ALSO
|
||||
orterun(1), orte-clean(1)
|
||||
.
|
||||
@@ -6,7 +6,7 @@
|
||||
.\" Man page for OMPI's ompi-server command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-SERVER 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH OMPI-SERVER 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
|
||||
@@ -1,106 +0,0 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2007 Los Alamos National Security, LLC
|
||||
.\" All rights reserved.
|
||||
.\" Copyright (c) 2008-2009 Sun Microsystems, Inc. All rights reserved.
|
||||
.\"
|
||||
.\" Man page for OMPI's ompi-server command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-TOP 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
.SH NAME
|
||||
.
|
||||
ompi-top, orte-top \- Diagnostic to provide process info similar to the popular "top" program.
|
||||
.
|
||||
.PP
|
||||
.
|
||||
\fBNOTE:\fP \fIompi-top\fP, and \fIorte-top\fP are exact
|
||||
synonyms for each other. Using any of the names will result in exactly
|
||||
identical behavior.
|
||||
.
|
||||
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.
|
||||
.BR ompi-top " [ options ]"
|
||||
.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH Options
|
||||
.
|
||||
\fIompi-top\fR collects and displays process information in a manner similar
|
||||
to that of the popular "top" program.
|
||||
.
|
||||
.TP 10
|
||||
.B -h | --help
|
||||
Display help for this command
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -pid | --pid \fR<value>\fP
|
||||
The pid of the mpirun whose processes you want information about, or the name
|
||||
of the file (specified as file:filename) that contains that info. Note that
|
||||
the ompi-top command must be executed on the same node as mpirun to use this option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -uri | --uri \fR<value>\fP
|
||||
Specify the URI of the mpirun whose processes you want information about, or the name
|
||||
of the file (specified as file:filename) that contains that info. Note that
|
||||
the ompi-top command does not have to be executed on the same node as mpirun to use this option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -rank | --rank \fR<value>\fP
|
||||
The rank of the processes to be monitored. This can consist of a single rank, or
|
||||
a comma-separated list of ranks. These can include rank ranges separated by a '-'.
|
||||
If this option is not provided, or a value of -1 is given, ompi-top will default
|
||||
to displaying information on all ranks.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -bynode | --bynode
|
||||
Display the results grouped by node, with each node's processes reported in rank
|
||||
order. If this option is not provided, ompi-top will default to displaying all
|
||||
results in rank order.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -update-rate | --update-rate \fR<value>\fP
|
||||
The time (in seconds) between updates of the displayed information. If this option
|
||||
is not provided, ompi-top will default to executing only once.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -timestamp | --timestamp
|
||||
Provide an approximate time when each sample was taken. This time is approximate as it
|
||||
only shows the time when the sample command was issued.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -log-file | --log-file \fR<value>\fP
|
||||
Log the results to the specified file instead of displaying them to stdout.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.
|
||||
.PP
|
||||
\fIompi-top\fR collects and displays process information in a manner similar
|
||||
to that of the popular "top" program. It doesn't do the fancy screen display, but
|
||||
does allow you to monitor available process information (to the limits of the underlying
|
||||
operating system) of processes irrespective of their location.
|
||||
.
|
||||
.\" **************************
|
||||
.\" See Also Section
|
||||
.\" **************************
|
||||
.
|
||||
.SH SEE ALSO
|
||||
.
|
||||
@@ -2,7 +2,7 @@
|
||||
.\" and released under the BSD license
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2014 Cisco Systems, Inc. All rights reserved.
|
||||
.TH OMPI_INFO 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH OMPI_INFO 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
ompi_info - Display information about the Open MPI installation
|
||||
.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||
.\" and released under the BSD license
|
||||
.TH OPAL_WRAPPER 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH OPAL_WRAPPER 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
opal_wrapper - Back-end Open MPI wrapper command
|
||||
.SH SYNOPSIS
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Corporation. All rights reserved.
|
||||
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
||||
.\"
|
||||
.TH orte-clean 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH orte-clean 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBorte-clean\fP - Cleans up any stale processes and files leftover
|
||||
from Open MPI jobs.
|
||||
|
||||
@@ -1,193 +0,0 @@
|
||||
.\” -*- nroff -*-
|
||||
.\" Copyright (c) 2009-2014 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2008-2009 Sun Microsystems, Inc. All rights reserved.
|
||||
.\” Copyright (c) 2015 Intel, Inc. All rights reserved
|
||||
.\" $COPYRIGHT$
|
||||
.\"
|
||||
.\" Man page for ORTE's orte-dvm command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH ORTE-DVM 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
.SH NAME
|
||||
.
|
||||
orte-dvm, ompi_dvm \- Establish a Distributed Virtual Machine (DVM).
|
||||
|
||||
.B Note:
|
||||
\fIorte-dvm\fP and \fIompi-dvm\fP are synonyms for each
|
||||
other. Using either of the names will produce the same behavior.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.
|
||||
.PP
|
||||
.B orte-dvm
|
||||
[ options ]
|
||||
.P
|
||||
|
||||
Invoking \fIorte-dvm\fP via an absolute path
|
||||
name is equivalent to specifying the \fI--prefix\fP option with a
|
||||
\fI<dir>\fR value equivalent to the directory where \fIorte-dvm\fR
|
||||
resides, minus its last subdirectory. For example:
|
||||
|
||||
\fB%\fP /usr/local/bin/orte-dvm ...
|
||||
|
||||
is equivalent to
|
||||
|
||||
\fB%\fP orte-dvm --prefix /usr/local
|
||||
|
||||
.
|
||||
.\" **************************
|
||||
.\" Quick Summary Section
|
||||
.\" **************************
|
||||
.SH QUICK SUMMARY
|
||||
.
|
||||
\fIorte-dvm\fP will establish a DVM that can be used to execute subsequent
|
||||
applications. Use of \fIorte-dvm\fP can be advantageous, for example, when you want to
|
||||
execute a number of short-lived tasks. In such cases, the time required to start
|
||||
the ORTE DVM can be a significant fraction of the time to execute the
|
||||
overall application. Thus, creating a persistent DVM can speed the overall
|
||||
execution. In addition, a persistent DVM will support executing multiple parallel
|
||||
applications while maintaining separation between their respective cores.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH OPTIONS
|
||||
.
|
||||
.\"
|
||||
.\" Start options listing
|
||||
.\" Indent 10 characters from start of first column to start of second column
|
||||
.
|
||||
.TP
|
||||
.B -h\fR,\fP --help
|
||||
Display help for this command
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -V\fR,\fP --version
|
||||
Print version number. If no other arguments are given, this will also
|
||||
cause orte-dvm to exit.
|
||||
.
|
||||
.
|
||||
.P
|
||||
Use one of the following options to specify which hosts (nodes) of the cluster to use
|
||||
for the DVM.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -H\fR,\fP -host\fR,\fP --host \fR<host1,host2,...,hostN>\fP
|
||||
List of hosts for the DVM.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B
|
||||
-hostfile\fR,\fP --hostfile \fR<hostfile>\fP
|
||||
Provide a hostfile to use.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -machinefile\fR,\fP --machinefile \fR<machinefile>\fP
|
||||
Synonym for \fI-hostfile\fP.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B --prefix \fR<dir>\fP
|
||||
Prefix directory that will be used to set the \fIPATH\fR and
|
||||
\fILD_LIBRARY_PATH\fR on the remote node before invoking the ORTE daemon.
|
||||
.
|
||||
.
|
||||
..P
|
||||
Setting MCA parameters:
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -gmca\fR,\fP --gmca \fR<key> <value>\fP
|
||||
Pass global MCA parameters that are applicable to all contexts. \fI<key>\fP is
|
||||
the parameter name; \fI<value>\fP is the parameter value.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -mca\fR,\fP --mca <key> <value>
|
||||
Send arguments to various MCA modules. See the "MCA" section, below.
|
||||
.
|
||||
.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -report-uri\fR,\fP --report-uri <channel>
|
||||
Print out orte-dvm's URI during startup. The channel must be either a '-' to indicate that
|
||||
the URI is to be output to stdout, a '+' to indicate that the URI is to be output to stderr,
|
||||
or a filename to which the URI is to be written.
|
||||
.
|
||||
.
|
||||
.P
|
||||
The following options are useful for developers; they are not generally
|
||||
useful to most ORTE and/or MPI users:
|
||||
.
|
||||
.TP
|
||||
.B -d\fR,\fP --debug-devel
|
||||
Enable debugging of the ORTE layer.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B --debug-daemons-file
|
||||
Enable debugging of the ORTE daemons in the DVM, storing
|
||||
output in files.
|
||||
.
|
||||
.
|
||||
.P
|
||||
There may be other options listed with \fIorte-dvm --help\fP.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.
|
||||
\fIorte-dvm\fP starts a Distributed Virtual Machine (DVM) by launching
|
||||
a daemon on each node of the allocation, as modified or specified by
|
||||
the \fI-host\fP and \fI-hostfile\fP options. Applications can subsequently
|
||||
be executed using the \fIorte-submit\fP command.
|
||||
.
|
||||
The DVM remains in operation until receiving the \fIorte-submit -terminate\fP
|
||||
command.
|
||||
.
|
||||
.
|
||||
.
|
||||
.SS Specifying Host Nodes
|
||||
.
|
||||
Host nodes can be identified on the \fIorte-dvm\fP command line with the \fI-host\fP
|
||||
option or in a hostfile.
|
||||
.
|
||||
.PP
|
||||
For example,
|
||||
.
|
||||
.TP 4
|
||||
orte-dvm -H aa,aa,bb ./a.out
|
||||
launches two processes on node aa and one on bb.
|
||||
.
|
||||
.PP
|
||||
Or, consider the hostfile
|
||||
.
|
||||
|
||||
\fB%\fP cat myhostfile
|
||||
aa slots=2
|
||||
bb slots=2
|
||||
cc slots=2
|
||||
|
||||
.
|
||||
.PP
|
||||
Here, we list both the host names (aa, bb, and cc) but also how many "slots"
|
||||
there are for each. Slots indicate how many processes can potentially execute
|
||||
on a node. For best performance, the number of slots may be chosen to be the
|
||||
number of cores on the node or the number of processor sockets. If the hostfile
|
||||
does not provide slots information, a default of 1 is assumed.
|
||||
When running under resource managers (e.g., SLURM, Torque, etc.),
|
||||
Open MPI will obtain both the hostnames and the number of slots directly
|
||||
from the resource manger.
|
||||
.
|
||||
.
|
||||
@@ -1,7 +1,7 @@
|
||||
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||
.\" and released under the BSD license
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.TH orte-info 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH orte-info 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
orte-info - Display information about the ORTE installation
|
||||
.
|
||||
|
||||
@@ -1,101 +0,0 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
|
||||
.\" University Research and Technology
|
||||
.\" Corporation. All rights reserved.
|
||||
.\" Copyright (c) 2008-2009 Sun Microsystems, Inc. All rights reserved.
|
||||
.\"
|
||||
.\" Man page for OMPI's ompi-ps command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-PS 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
.SH NAME
|
||||
.
|
||||
ompi-ps, orte-ps \- Displays information about the active jobs and processes
|
||||
in Open MPI.
|
||||
.
|
||||
.PP
|
||||
.
|
||||
\fBNOTE:\fP \fIompi-ps\fP, and \fIorte-ps\fP are exact
|
||||
synonyms for each other. Using any of the names will result in exactly
|
||||
identical behavior.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.
|
||||
.B ompi-ps
|
||||
.B [ options ]
|
||||
.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH Options
|
||||
.
|
||||
\fIompi-ps\fR will display information about running job(s) in the current
|
||||
universe.
|
||||
.
|
||||
.TP 10
|
||||
.B -h | --help
|
||||
Display help for this command
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -v | --verbose
|
||||
Enable verbose output for debugging
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B --daemons
|
||||
Display daemon job information.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -j | --jobid
|
||||
Display the state of a specific job in the universe. By default all jobs will
|
||||
be displayed.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -p | --vpid
|
||||
Display the state of a specific vpid (process) in the universe. By default all
|
||||
vpids cooresponding to processes will be displayed. Must be used in conjunction
|
||||
with the \fB--jobid\fP option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -n | --nodes
|
||||
Display all of the allocated nodes, and their cooresponding states. By default
|
||||
this is disabled.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -gmca | --gmca \fR<key> <value>\fP
|
||||
Pass global MCA parameters that are applicable to all contexts. \fI<key>\fP is
|
||||
the parameter name; \fI<value>\fP is the parameter value.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -mca | --mca <key> <value>
|
||||
Send arguments to various MCA modules.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.
|
||||
.PP
|
||||
\fIompi-ps\fR displays the state of jobs running inside an Open RTE universe.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" See Also Section
|
||||
.\" **************************
|
||||
.
|
||||
.SH SEE ALSO
|
||||
orterun(1), orte-clean(1)
|
||||
.
|
||||
@@ -6,7 +6,7 @@
|
||||
.\" Man page for OMPI's ompi-server command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-SERVER 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH OMPI-SERVER 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
|
||||
@@ -1,106 +0,0 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2007 Los Alamos National Security, LLC
|
||||
.\" All rights reserved.
|
||||
.\" Copyright (c) 2008-2009 Sun Microsystems, Inc. All rights reserved.
|
||||
.\"
|
||||
.\" Man page for OMPI's ompi-server command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH OMPI-TOP 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
.SH NAME
|
||||
.
|
||||
ompi-top, orte-top \- Diagnostic to provide process info similar to the popular "top" program.
|
||||
.
|
||||
.PP
|
||||
.
|
||||
\fBNOTE:\fP \fIompi-top\fP, and \fIorte-top\fP are exact
|
||||
synonyms for each other. Using any of the names will result in exactly
|
||||
identical behavior.
|
||||
.
|
||||
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.
|
||||
.BR ompi-top " [ options ]"
|
||||
.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH Options
|
||||
.
|
||||
\fIompi-top\fR collects and displays process information in a manner similar
|
||||
to that of the popular "top" program.
|
||||
.
|
||||
.TP 10
|
||||
.B -h | --help
|
||||
Display help for this command
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -pid | --pid \fR<value>\fP
|
||||
The pid of the mpirun whose processes you want information about, or the name
|
||||
of the file (specified as file:filename) that contains that info. Note that
|
||||
the ompi-top command must be executed on the same node as mpirun to use this option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -uri | --uri \fR<value>\fP
|
||||
Specify the URI of the mpirun whose processes you want information about, or the name
|
||||
of the file (specified as file:filename) that contains that info. Note that
|
||||
the ompi-top command does not have to be executed on the same node as mpirun to use this option.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -rank | --rank \fR<value>\fP
|
||||
The rank of the processes to be monitored. This can consist of a single rank, or
|
||||
a comma-separated list of ranks. These can include rank ranges separated by a '-'.
|
||||
If this option is not provided, or a value of -1 is given, ompi-top will default
|
||||
to displaying information on all ranks.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -bynode | --bynode
|
||||
Display the results grouped by node, with each node's processes reported in rank
|
||||
order. If this option is not provided, ompi-top will default to displaying all
|
||||
results in rank order.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -update-rate | --update-rate \fR<value>\fP
|
||||
The time (in seconds) between updates of the displayed information. If this option
|
||||
is not provided, ompi-top will default to executing only once.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -timestamp | --timestamp
|
||||
Provide an approximate time when each sample was taken. This time is approximate as it
|
||||
only shows the time when the sample command was issued.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
.B -log-file | --log-file \fR<value>\fP
|
||||
Log the results to the specified file instead of displaying them to stdout.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.
|
||||
.PP
|
||||
\fIompi-top\fR collects and displays process information in a manner similar
|
||||
to that of the popular "top" program. It doesn't do the fancy screen display, but
|
||||
does allow you to monitor available process information (to the limits of the underlying
|
||||
operating system) of processes irrespective of their location.
|
||||
.
|
||||
.\" **************************
|
||||
.\" See Also Section
|
||||
.\" **************************
|
||||
.
|
||||
.SH SEE ALSO
|
||||
.
|
||||
@@ -1,7 +1,7 @@
|
||||
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||
.\" and released under the BSD license.
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.TH ORTED 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH ORTED 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
orted - Start an Open RTE User-Level Daemon
|
||||
.SH SYNOPSIS
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
.\" Man page for ORTE's orterun command
|
||||
.\"
|
||||
.\" .TH name section center-footer left-footer center-header
|
||||
.TH MPIRUN 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPIRUN 1 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.\" **************************
|
||||
.\" Name Section
|
||||
.\" **************************
|
||||
@@ -341,7 +341,10 @@ MPI_COMM_WORLD ranks in a round-robin, "by node" manner.
|
||||
.
|
||||
.TP
|
||||
.B -cpu-list\fR,\fP --cpu-list \fR<cpus>\fP
|
||||
List of processor IDs to bind processes to [default=NULL].
|
||||
Comma-delimited list of processor IDs to which to bind processes
|
||||
[default=NULL]. Processor IDs are interpreted as hwloc logical core
|
||||
IDs. Run the hwloc \fIlstopo(1)\fR command to see a list of available
|
||||
cores and their logical IDs.
|
||||
.
|
||||
.
|
||||
.
|
||||
@@ -366,7 +369,7 @@ For process binding:
|
||||
.TP
|
||||
.B --bind-to \fR<foo>\fP
|
||||
Bind processes to the specified object, defaults to \fIcore\fP. Supported options
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, and none.
|
||||
include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, cpu-list, and none.
|
||||
.
|
||||
.TP
|
||||
.B -cpus-per-proc\fR,\fP --cpus-per-proc \fR<#perproc>\fP
|
||||
@@ -642,7 +645,10 @@ Allow
|
||||
.I mpirun
|
||||
to run when executed by the root user
|
||||
.RI ( mpirun
|
||||
defaults to aborting when launched as the root user).
|
||||
defaults to aborting when launched as the root user). Be sure to see
|
||||
the
|
||||
.I Running as root
|
||||
section, below, for more detail.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
@@ -1149,6 +1155,17 @@ cause the process to be bound to the processors that share a single L3
|
||||
cache within that socket.
|
||||
.
|
||||
.PP
|
||||
Alternatively, processes can be assigned to processors based on their
|
||||
local rank on a node using the \fI--bind-to cpu-list:ordered\fP option
|
||||
with an associated \fI--cpu-list "0,2,5"\fP. In this example, the
|
||||
first process on a node will be bound to cpu 0, the second process on
|
||||
the node will be bound to cpu 2, and the third process on the node
|
||||
will be bound to cpu 5. \fI--bind-to\fP will also accept
|
||||
\fIcpulist:ortered\fP as a synonym to \fIcpu-list:ordered\fP. Note
|
||||
that an error will result if more processes are assigned to a node
|
||||
than cpus are provided.
|
||||
.
|
||||
.PP
|
||||
To help balance loads, the binding directive uses a round-robin method when binding to
|
||||
levels lower than used in the mapper. For example, consider the case where a job is
|
||||
mapped to the socket level, and then bound to core. Each socket will have multiple cores,
|
||||
@@ -1614,7 +1631,26 @@ To override this default, you can add the
|
||||
.I --allow-run-as-root
|
||||
option to the
|
||||
.I mpirun
|
||||
command line.
|
||||
command line, or you can set the environmental parameters
|
||||
.I OMPI_ALLOW_RUN_AS_ROOT=1
|
||||
and
|
||||
.IR OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1 .
|
||||
Note that it takes setting
|
||||
.I two
|
||||
environment variables to effect the same behavior as
|
||||
.I --allow-run-as-root
|
||||
in order to stress the Open MPI team's strong advice against running
|
||||
as the root user. After extended discussions with communities who use
|
||||
containers (where running as the root user is the default), there was
|
||||
a persistent desire to be able to enable root execution of
|
||||
.I mpirun
|
||||
via an environmental control (vs. the existing
|
||||
.I --allow-run-as-root
|
||||
command line parameter). The compromise of using
|
||||
.I two
|
||||
environment variables was reached: it allows root execution via an
|
||||
environmental control, but it conveys the Open MPI team's strong
|
||||
recomendation against this behavior.
|
||||
.
|
||||
.SS Exit status
|
||||
.
|
||||
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH oshc++ 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
oshc++ -- Open SHMEM C++ wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
oshc++ [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "oshc++ --showme" and
|
||||
"oshc++ --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "oshc++ --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C++ compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C++ compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C++ compiler for other
|
||||
options that can be passed through oshc++.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIoshc++\fR is a convenience wrappers for the underlying
|
||||
C++ compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIoshc++\fR passes its arguments to the underlying C++
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIoshc++\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/oshc++-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH oshcc 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
oshcc -- Open SHMEM C wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
oshcc [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "oshcc --showme" and
|
||||
"oshcc --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "oshcc --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C compiler for other
|
||||
options that can be passed through oshcc.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIoshcc\fR is a convenience wrappers for the underlying
|
||||
C compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIoshcc\fR passes its arguments to the underlying C
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIoshcc\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/oshcc-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH oshcxx 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
oshcxx -- Open SHMEM C++ wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
oshcxx [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "oshcxx --showme" and
|
||||
"oshcxx --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "oshcxx --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C++ compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C++ compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C++ compiler for other
|
||||
options that can be passed through oshcxx.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIoshcxx\fR is a convenience wrappers for the underlying
|
||||
C++ compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIoshcxx\fR passes its arguments to the underlying C++
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIoshcxx\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/oshcxx-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH oshfort 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
oshfort -- Open SHMEM Fortran wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
oshfort [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "oshfort --showme" and
|
||||
"oshfort --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "oshfort --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
Fortran compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
Fortran compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying Fortran compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying Fortran compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying Fortran compiler for other
|
||||
options that can be passed through oshfort.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIoshfort\fR is a convenience wrappers for the underlying
|
||||
Fortran compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIoshfort\fR passes its arguments to the underlying Fortran
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIoshfort\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/oshfort-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,205 +0,0 @@
|
||||
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||
.\" and released under the BSD license
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.TH OSHMEM_INFO 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.SH NAME
|
||||
oshmem_info - Display information about the Open MPI installation
|
||||
.
|
||||
.\" **************************
|
||||
.\" Synopsis Section
|
||||
.\" **************************
|
||||
.SH SYNOPSIS
|
||||
.B oshmem_info [options]
|
||||
.
|
||||
.\" **************************
|
||||
.\" Description Section
|
||||
.\" **************************
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
.B oshmem_info
|
||||
provides detailed information about the Open MPI/SHMEM installation. It can
|
||||
be useful for at least three common scenarios:
|
||||
.PP
|
||||
1. Checking local configuration and seeing how Open MPI/SHMEM was installed.
|
||||
.PP
|
||||
2. Submitting bug reports / help requests to the Open MPI/SHMEM community
|
||||
(see
|
||||
.IR http://www.open-mpi.org/community/help/ )
|
||||
.PP
|
||||
3. Seeing a list of installed Open MPI/SHMEM plugins and querying what
|
||||
MCA parameters they support.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Options Section
|
||||
.\" **************************
|
||||
.SH OPTIONS
|
||||
.B oshmem_info
|
||||
accepts the following options:
|
||||
.TP 8
|
||||
.I \-a|\-\-all
|
||||
Show all configuration options and MCA parameters
|
||||
.TP 8
|
||||
.I \-\-arch
|
||||
Show architecture Open MPI/SHMEM was compiled on
|
||||
.TP 8
|
||||
.I \-c|\-\-config
|
||||
Show configuration options
|
||||
.TP 8
|
||||
.I \-gmca|\-\-gmca <param> <value>
|
||||
Pass global MCA parameters that are applicable to all contexts.
|
||||
.TP 8
|
||||
.I \-h|\-\-help
|
||||
Shows help / usage message
|
||||
.TP 8
|
||||
.I \-\-hostname
|
||||
Show the hostname that Open MPI/SHMEM was configured and built on
|
||||
.TP 8
|
||||
.I \-\-internal
|
||||
Show internal MCA parameters (not meant to be modified by users)
|
||||
.TP 8
|
||||
.I \-\-level
|
||||
Show only variables with at most this level (1-9). The default is 1 unless
|
||||
\-\-all is specified without \-\-level in which case the default is 9. See
|
||||
the LEVEL section for more information.
|
||||
.TP 8
|
||||
.I \-mca|\-\-mca <param> <value>
|
||||
Pass context-specific MCA parameters; they are considered global if --gmca is
|
||||
not used and only one context is specified.
|
||||
.TP 8
|
||||
.I \-\-param <type> <component>
|
||||
Show MCA parameters. The first parameter is the type of the component
|
||||
to display; the second parameter is the specific component to display
|
||||
(or the keyword "all", meaning "display all components of this type").
|
||||
.TP 8
|
||||
.I \-\-parsable
|
||||
When used in conjunction with other parameters, the output is
|
||||
displayed in a machine-parsable format
|
||||
.I \-\-parseable
|
||||
Synonym for --parsable
|
||||
.TP 8
|
||||
.I \-\-path <type>
|
||||
Show paths that Open MPI/SHMEM was configured with. Accepts the following
|
||||
parameters: prefix, bindir, libdir, incdir, pkglibdir, sysconfdir.
|
||||
.TP 8
|
||||
.I \-\-pretty
|
||||
When used in conjunction with other parameters, the output is
|
||||
displayed in 'prettyprint' format (default)
|
||||
.TP 8
|
||||
.I \-\-selected-only
|
||||
Show only variables from selected components.
|
||||
.TP 8
|
||||
.I \-V|\-\-version
|
||||
Show version of Open MPI/SHMEM.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Levels Section
|
||||
.\" **************************
|
||||
.SH LEVELS
|
||||
.TP 4
|
||||
1
|
||||
Basic information of interest to users
|
||||
.
|
||||
.TP
|
||||
2
|
||||
Detailed information of interest to users
|
||||
.
|
||||
.TP
|
||||
3
|
||||
All remaining information of interest to users
|
||||
.
|
||||
.TP
|
||||
4
|
||||
Basic information required for tuning
|
||||
.
|
||||
.TP
|
||||
5
|
||||
Detailed information required for tuning
|
||||
.
|
||||
.TP
|
||||
6
|
||||
All remaining information required for tuning
|
||||
.
|
||||
.TP
|
||||
7
|
||||
Basic information for MPI implementors
|
||||
.
|
||||
.TP
|
||||
8
|
||||
Detailed information for MPI implementors
|
||||
.
|
||||
.TP
|
||||
9
|
||||
All remaining information for MPI implementors
|
||||
.
|
||||
.\" **************************
|
||||
.\" Examples Section
|
||||
.\" **************************
|
||||
.SH EXAMPLES
|
||||
.TP 4
|
||||
oshmem_info
|
||||
Show the default output of options and listing of installed
|
||||
components in a human-readable / prettyprint format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --parsable
|
||||
Show the default output of options and listing of installed
|
||||
components in a machine-parsable format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --param btl openib
|
||||
Show the MCA parameters of the "openib" BTL component in a
|
||||
human-readable / prettyprint format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --param btl openib --parsable
|
||||
Show the MCA parameters of the "openib" BTL component in a
|
||||
machine-parsable format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --path bindir
|
||||
Show the "bindir" that Open MPI was configured with.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --version ompi full --parsable
|
||||
Show the full version numbers of Open MPI/SHMEM (including the ORTE and OPAL
|
||||
version numbers) in a machine-readable format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --version btl major
|
||||
Show the major version number of all BTL components in a prettyprint
|
||||
format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --version btl:tcp minor
|
||||
Show the minor version number of the TCP BTL component in a
|
||||
prettyprint format.
|
||||
.
|
||||
.
|
||||
.TP
|
||||
oshmem_info --all
|
||||
Show
|
||||
.I all
|
||||
information about the Open MPI/SHMEM installation, including all components
|
||||
that can be found, the MCA parameters that they support, versions of
|
||||
Open MPI/SHMEM and the components, etc.
|
||||
.
|
||||
.
|
||||
.\" **************************
|
||||
.\" Authors Section
|
||||
.\" **************************
|
||||
.SH AUTHORS
|
||||
The Open MPI/SHMEM maintainers -- see
|
||||
.I http://www.openmpi.org/
|
||||
or the file
|
||||
.IR AUTHORS .
|
||||
.PP
|
||||
This manual page was originally contributed by Dirk Eddelbuettel
|
||||
<edd@debian.org>, one of the Debian GNU/Linux maintainers for Open
|
||||
MPI, and may be used by others.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH shmemc++ 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
shmemc++ -- Open SHMEM C++ wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
shmemc++ [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "shmemc++ --showme" and
|
||||
"shmemc++ --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "shmemc++ --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C++ compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C++ compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C++ compiler for other
|
||||
options that can be passed through shmemc++.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIshmemc++\fR is a convenience wrappers for the underlying
|
||||
C++ compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIshmemc++\fR passes its arguments to the underlying C++
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIshmemc++\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/shmemc++-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH shmemcc 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
shmemcc -- Open SHMEM C wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
shmemcc [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "shmemcc --showme" and
|
||||
"shmemcc --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "shmemcc --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C compiler for other
|
||||
options that can be passed through shmemcc.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIshmemcc\fR is a convenience wrappers for the underlying
|
||||
C compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIshmemcc\fR passes its arguments to the underlying C
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIshmemcc\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/shmemcc-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH shmemcxx 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
shmemcxx -- Open SHMEM C++ wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
shmemcxx [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "shmemcxx --showme" and
|
||||
"shmemcxx --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "shmemcxx --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
C++ compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying C++ compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying C++ compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying C++ compiler for other
|
||||
options that can be passed through shmemcxx.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIshmemcxx\fR is a convenience wrappers for the underlying
|
||||
C++ compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIshmemcxx\fR passes its arguments to the underlying C++
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIshmemcxx\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/shmemcxx-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
@@ -1,265 +0,0 @@
|
||||
.\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2011-2012 Cisco Systems, Inc. All rights reserved.
|
||||
.TH shmemfort 1 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.
|
||||
.SH NAME
|
||||
shmemfort -- Open SHMEM Fortran wrapper compiler
|
||||
.
|
||||
.SH SYNTAX
|
||||
shmemfort [-showme|-showme:compile|-showme:link] ...
|
||||
.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
--showme
|
||||
This option comes in several different variants (see below). None of
|
||||
the variants invokes the underlying compiler; they all provide
|
||||
information on how the underlying compiler would have been invoked had
|
||||
.I --showme
|
||||
not been used.
|
||||
The basic
|
||||
.I --showme
|
||||
option outputs the command line that would be executed to compile the
|
||||
program. \fBNOTE:\fR If a non-filename argument is passed on the
|
||||
command line, the \fI-showme\fR option will \fInot\fR display any
|
||||
additional flags. For example, both "shmemfort --showme" and
|
||||
"shmemfort --showme my_source.c" will show all the wrapper-supplied
|
||||
flags. But "shmemfort --showme -v" will only show the underlying
|
||||
compiler name and "-v".
|
||||
.TP
|
||||
--showme:compile
|
||||
Output the compiler flags that would have been supplied to the
|
||||
Fortran compiler.
|
||||
.TP
|
||||
--showme:link
|
||||
Output the linker flags that would have been supplied to the
|
||||
Fortran compiler.
|
||||
.TP
|
||||
--showme:command
|
||||
Outputs the underlying Fortran compiler command (which may be one
|
||||
or more tokens).
|
||||
.TP
|
||||
--showme:incdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying Fortran compiler to indicate where relevant header files
|
||||
are located.
|
||||
.TP
|
||||
--showme:libdirs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of
|
||||
directories that the wrapper compiler would have provided to the
|
||||
underlying linker to indicate where relevant libraries are located.
|
||||
.TP
|
||||
--showme:libs
|
||||
Outputs a space-delimited (but otherwise undecorated) list of library
|
||||
names that the wrapper compiler would have used to link an
|
||||
application. For example: "mpi open-rte open-pal util".
|
||||
.TP
|
||||
--showme:version
|
||||
Outputs the version number of Open MPI.
|
||||
.TP
|
||||
--showme:help
|
||||
Output a brief usage help message.
|
||||
.PP
|
||||
See the man page for your underlying Fortran compiler for other
|
||||
options that can be passed through shmemfort.
|
||||
.
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Conceptually, the role of these commands is quite simple:
|
||||
transparently add relevant compiler and linker flags to the user's
|
||||
command line that are necessary to compile / link Open SHMEM
|
||||
programs, and then invoke the underlying compiler to actually perform
|
||||
the command.
|
||||
.
|
||||
.PP
|
||||
As such, these commands are frequently referred to as "wrapper"
|
||||
compilers because they do not actually compile or link applications
|
||||
themselves; they only add in command line flags and invoke the
|
||||
back-end compiler.
|
||||
.
|
||||
.
|
||||
.SS Background
|
||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||
There are wrapper compilers for each layer; each layer's wrapper only
|
||||
links in the libraries relevant for that layer. Specifically, each
|
||||
layer provides the following wrapper compilers:
|
||||
.
|
||||
.TP 4
|
||||
OPAL
|
||||
\fIopalcc\fR and \fIopalc++\fR
|
||||
.
|
||||
.TP
|
||||
ORTE
|
||||
\fIortecc\fR and \fIortec++\fR
|
||||
.
|
||||
.TP
|
||||
OMPI
|
||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||
case-senstive file systems), and \fImpifort\fR (and its legacy/deprecated
|
||||
names \fImpif77\fR and \fImpif90\fR). Note
|
||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||
underlying C++ compiler with the same options. All are provided as
|
||||
compatibility with other MPI implementations.
|
||||
.
|
||||
.
|
||||
.SS Fortran Notes
|
||||
.PP
|
||||
The Fortran wrapper compiler for MPI (\fImpifort\fR, and its
|
||||
legacy/deprecated names \fImpif77\fR and \fImpif90\fR) can compile and
|
||||
link MPI applications that use any/all of the MPI Fortran bindings:
|
||||
.IR mpif.h ,
|
||||
the
|
||||
.I mpi
|
||||
module, and the
|
||||
.I mpi_f08
|
||||
module (assuming Open MPI was installed with support for each of these
|
||||
Fortran bindings). Specifically: it is no longer necessary to use
|
||||
different wrapper compilers for applications that use
|
||||
.I mpif.h
|
||||
vs. applications that use the
|
||||
.I mpi
|
||||
module -- just use
|
||||
.I mpifort
|
||||
for all Fortran MPI applications.
|
||||
.
|
||||
.PP
|
||||
Note, however, that the Fortran compiler may require additional
|
||||
command-line options to enforce a specific Fortran dialect. For
|
||||
example, in some versions of the IBM XLF compiler, if xlf90 is the
|
||||
underlying Fortran compiler,
|
||||
.IR -qfixed
|
||||
may be necessary to compile fixed-format Fortran source files.
|
||||
.
|
||||
.PP
|
||||
Finally, note that
|
||||
.I mpifort
|
||||
will be inoperative and will return an error on use if Fortran support
|
||||
was not built into the MP Ilayer.
|
||||
.
|
||||
.
|
||||
.SS Overview
|
||||
\fIshmemfort\fR is a convenience wrappers for the underlying
|
||||
Fortran compiler. Translation of an Open SHMEM program requires the
|
||||
linkage of the Open SHMEM-specific libraries which may not reside in
|
||||
one of the standard search directories of ld(1). It also often
|
||||
requires the inclusion of header files what may also not be found in a
|
||||
standard location.
|
||||
.
|
||||
.PP
|
||||
\fIshmemfort\fR passes its arguments to the underlying Fortran
|
||||
compiler along with the -I, -L and -l options required by Open SHMEM
|
||||
programs.
|
||||
.
|
||||
.PP
|
||||
The Open SHMEM Team \fIstrongly\fR encourages using the wrapper
|
||||
compilers instead of attempting to link to the Open SHMEM libraries
|
||||
manually. This allows the specific implementation of Open SHMEM to
|
||||
change without forcing changes to linker directives in users'
|
||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||
the wrapper compilers depends on how Open SHMEM was configured and
|
||||
built; the values can change between different installations of the
|
||||
same version of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
Indeed, since the wrappers are simply thin shells on top of an
|
||||
underlying compiler, there are very, very few compelling reasons
|
||||
\fInot\fR to use \fIshmemfort\fR. When it is not possible to use the
|
||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||
options should be used to determine what flags the wrappers would have
|
||||
used. For example:
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||
.
|
||||
.PP
|
||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||
.
|
||||
.
|
||||
.SH NOTES
|
||||
.PP
|
||||
It is possible to make the wrapper compilers multi-lib aware. That
|
||||
is, the libraries and includes specified may differ based on the
|
||||
compiler flags specified (for example, with the GNU compilers on
|
||||
Linux, a different library path may be used if -m32 is seen versus
|
||||
-m64 being seen). This is not the default behavior in a standard
|
||||
build, but can be activated (for example, in a binary package
|
||||
providing both 32 and 64 bit support). More information can be found
|
||||
at:
|
||||
.PP
|
||||
https://github.com/open-mpi/ompi/wiki/compilerwrapper3264
|
||||
.
|
||||
.
|
||||
.SH FILES
|
||||
.PP
|
||||
The string that the wrapper compilers insert into the command line
|
||||
before invoking the underlying compiler are stored in a text file
|
||||
created by Open SHMEM and installed to
|
||||
\fI$pkgdata/shmemfort-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||
installation directory of Open SHMEM.
|
||||
.
|
||||
.PP
|
||||
It is rarely necessary to edit this file, but it can be examined to
|
||||
gain insight into what flags the wrappers are placing on the command
|
||||
line.
|
||||
.
|
||||
.
|
||||
.SH ENVIRONMENT VARIABLES
|
||||
.PP
|
||||
By default, the wrappers use the compilers that were selected when
|
||||
Open SHMEM was configured. These compilers were either found
|
||||
automatically by Open MPI's "configure" script, or were selected by
|
||||
the user in the CC, CXX, F77, and/or FC environment variables
|
||||
before "configure" was invoked. Additionally, other arguments
|
||||
specific to the compiler may have been selected by configure.
|
||||
.
|
||||
.PP
|
||||
These values can be selectively overridden by either editing the text
|
||||
files containing this configuration information (see the \fBFILES\fR
|
||||
section), or by setting selected environment variables of the
|
||||
form "OSHMEM_value".
|
||||
.
|
||||
.PP
|
||||
Valid value names are:
|
||||
.
|
||||
.TP
|
||||
CPPFLAGS
|
||||
Flags added when invoking the preprocessor (C or C++)
|
||||
.
|
||||
.TP
|
||||
LDFLAGS
|
||||
Flags added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
LIBS
|
||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||
.
|
||||
.TP
|
||||
CC
|
||||
C compiler
|
||||
.
|
||||
.TP
|
||||
CFLAGS
|
||||
C compiler flags
|
||||
.
|
||||
.TP
|
||||
CXX
|
||||
C++ compiler
|
||||
.
|
||||
.TP
|
||||
CXXFLAGS
|
||||
C++ compiler flags
|
||||
.
|
||||
.
|
||||
.TP
|
||||
FC
|
||||
Fortran compiler
|
||||
.
|
||||
.TP
|
||||
FCFLAGS
|
||||
Fortran compiler flags
|
||||
File diff suppressed because it is too large
Load Diff
@@ -2,9 +2,9 @@
|
||||
.\" Copyright 2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
MPI \- General information Open MPI 3.1.2.
|
||||
MPI \- General information Open MPI 4.0.1.
|
||||
|
||||
.SH MPI
|
||||
.ft R
|
||||
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allgather_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allgather_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allgatherv_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allgatherv_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allreduce_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Allreduce_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoall_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoall_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoallv_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoallv_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoallw_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Alltoallw_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
156
linx64/mpi/openmpi/share/man/man3/MPIX_Barrier_init.3
Normal file
156
linx64/mpi/openmpi/share/man/man3/MPIX_Barrier_init.3
Normal file
@@ -0,0 +1,156 @@
|
||||
.\" -*- nroff -*-
|
||||
.\" Copyright (c) 2018 FUJITSU LIMITED. All rights reserved.
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPIX_Barrier_init 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPIX_Allgather_init, MPIX_Allgatherv_init, MPIX_Allreduce_init, MPIX_Alltoall_init, MPIX_Alltoallv_init, MPIX_Alltoallw_init, MPIX_Barrier_init, MPIX_Bcast_init, MPIX_Exscan_init, MPIX_Gather_init, MPIX_Gatherv_init, MPIX_Reduce_init, MPIX_Reduce_scatter_init, MPIX_Reduce_scatter_block_init, MPIX_Scan_init, MPIX_Scatter_init, MPIX_Scatterv_init, MPIX_Neighbor_allgather_init, MPIX_Neighbor_allgatherv_init, MPIX_Neighbor_alltoall_init, MPIX_Neighbor_alltoallv_init, MPIX_Neighbor_alltoallw_init\fP \- Builds a handle for a collective communication or neighborhood collective communication
|
||||
|
||||
.SH SYNTAX
|
||||
.ft R
|
||||
.SH C Syntax
|
||||
.nf
|
||||
#include <mpi.h>
|
||||
#include <mpi-ext.h>
|
||||
int MPIX_Allgather_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Allgatherv_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, const int \fIrecvcounts\fP[],
|
||||
const int \fIdispls\fP[], MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Allreduce_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP, int \fIcount\fP,
|
||||
MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Alltoall_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Alltoallv_init(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
|
||||
const int \fIsdispls\fP[], MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP,
|
||||
const int \fIrecvcounts\fP[], const int \fIrdispls\fP[], MPI_Datatype \fIrecvtype\fP,
|
||||
MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Alltoallw_init(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
|
||||
const int \fIsdispls\fP[], const MPI_Datatype \fIsendtypes\fP[], void *\fIrecvbuf\fP,
|
||||
const int \fIrecvcounts\fP[], const int \fIrdispls\fP[],
|
||||
const MPI_Datatype \fIrecvtypes\fP[], MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Barrier_init(MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Bcast_init(void *\fIbuffer\fP, int \fIcount\fP, MPI_Datatype \fIdatatype\fP,
|
||||
int \fIroot\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Exscan_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP, int \fIcount\fP,
|
||||
MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Gather_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Gatherv_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, const int \fIrecvcounts\fP[],
|
||||
const int \fIdispls\fP[], MPI_Datatype \fIrecvtype\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Reduce_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP, int \fIcount\fP,
|
||||
MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Reduce_scatter_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP,
|
||||
const int \fIrecvcounts\fP[], MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP,
|
||||
MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Reduce_scatter_block_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP,
|
||||
int \fIrecvcount\fP, MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Scan_init(const void *\fIsendbuf\fP, void *\fIrecvbuf\fP, int \fIcount\fP,
|
||||
MPI_Datatype \fIdatatype\fP, MPI_Op \fIop\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Scatter_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Scatterv_init(const void *\fIsendbuf\fP, const int \fIsendcounts\fP[],
|
||||
const int \fIdispls\fP[], MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP,
|
||||
int \fIrecvcount\fP, MPI_Datatype \fIrecvtype\fP, int \fIroot\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Neighbor_allgather_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Neighbor_allgatherv_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, const int \fIrecvcounts\fP[],
|
||||
const int \fIdispls\fP[], MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP,
|
||||
MPI_Info \fIinfo\fP, MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Neighbor_alltoall_init(const void *\fIsendbuf\fP, int \fIsendcount\fP,
|
||||
MPI_Datatype \fIsendtype\fP, void *\fIrecvbuf\fP, int \fIrecvcount\fP,
|
||||
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Neighbor_alltoallv_init(const void *\fIsendbuf\fP,
|
||||
const int \fIsendcounts\fP[], const int \fIsdispls\fP[], MPI_Datatype \fIsendtype\fP,
|
||||
void *\fIrecvbuf\fP, const int \fIrecvcounts\fP[], const int \fIrdispls\fP[],
|
||||
MPI_Datatype \fIrecvtype\fP, MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
int MPIX_Neighbor_alltoallw_init(const void *\fIsendbuf\fP,
|
||||
const int \fIsendcounts\fP[], const MPI_Aint \fIsdispls\fP[],
|
||||
const MPI_Datatype \fIsendtypes\fP[], void *\fIrecvbuf\fP,
|
||||
const int \fIrecvcounts\fP[], const MPI_Aint \fIrdispls\fP[],
|
||||
const MPI_Datatype \fIrecvtypes\fP[], MPI_Comm \fIcomm\fP, MPI_Info \fIinfo\fP,
|
||||
MPI_Request *\fIrequest\fP)
|
||||
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.ft R
|
||||
Creates a persistent communication request for a collective operation or neighborhood collective operation.
|
||||
|
||||
As of Nov. 2018, the feature of persistent collective communication operations and persistent collective neighborhood communication operations is planned to be included in the next MPI Standard after MPI-3.1.
|
||||
.nf
|
||||
|
||||
https://github.com/mpi-forum/mpi-issues/issues/25
|
||||
.fi
|
||||
|
||||
Open MPI implements 2018 Draft Specification of the MPI standard shown in the following URL.
|
||||
.nf
|
||||
|
||||
https://www.mpi-forum.org/docs/drafts/mpi-2018-draft-report.pdf
|
||||
.fi
|
||||
|
||||
The interface may still change in the standard. Therefore the prefix \fIMPIX_\fP is used instead of \fIMPI_\fP for these request creation routines. To start, complete, and free the created request, usual MPI routines (\fIMPI_Start\fP etc.) can be used.
|
||||
|
||||
Future versions of Open MPI will switch to the \fIMPI_\fP prefix and will not require the C header file \fImpi-ext.h\fP, the Fortran modules \fImpi_ext\fP and \fImpi_f08_ext\fP, and the Fortran header file \fImpif-ext.h\fP once the MPI Standard which includes this feature is published.
|
||||
|
||||
.SH EXAMPLE
|
||||
.nf
|
||||
|
||||
MPI_Request req;
|
||||
MPIX_Barrier_init(MPI_COMM_WORLD, MPI_INFO_NULL, &req);
|
||||
MPI_Start(&req);
|
||||
MPI_Wait(&req, MPI_STATUS_IGNORE);
|
||||
MPI_Request_free(&req);
|
||||
.fi
|
||||
|
||||
.SH SEE ALSO
|
||||
.ft R
|
||||
.sp
|
||||
MPI_Start
|
||||
.br
|
||||
MPI_Startall
|
||||
.br
|
||||
MPI_Request_free
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Bcast_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Bcast_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Exscan_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Exscan_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Gather_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Gather_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Gatherv_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Gatherv_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -2,7 +2,7 @@
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
|
||||
.\" Copyright (c) 2015 NVIDIA, Inc. All rights reserved.
|
||||
.TH MPIx_CUDA_SUPPORT 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPIx_CUDA_SUPPORT 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPIX_Query_cuda_support\fP \- Returns 1 if there is CUDA aware support and 0 if there is not.
|
||||
|
||||
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Reduce_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Reduce_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scan_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scan_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scatter_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scatter_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scatterv_init.3
Normal file
1
linx64/mpi/openmpi/share/man/man3/MPIX_Scatterv_init.3
Normal file
@@ -0,0 +1 @@
|
||||
.so man3/MPIX_Barrier_init.3
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Abort 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Abort 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Abort\fP \- Terminates MPI execution environment.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Accumulate 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Accumulate 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Accumulate\fP, \fBMPI_Raccumulate\fP \- Combines the contents of the origin buffer with that of a target buffer.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Add_error_class 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Add_error_class 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
.nf
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Add_error_code 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Add_error_code 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
\fBMPI_Add_error_code\fP \- Creates a new error code associated
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Add_error_string 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Add_error_string 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
.nf
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Address 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Address 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Address\fP \- Gets the address of a location in memory -- use of this routine is deprecated.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Aint_add 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Aint_add 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Aint_add\fP, \fBMPI_Aint_diff\fP \- Portable functions for
|
||||
arithmetic on MPI_Aint values.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Allgather 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Allgather 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Allgather, MPI_Iallgather\fP \- Gathers data from all processes and distributes it to all processes
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Allgatherv 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Allgatherv 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Allgatherv, MPI_Iallgatherv\fP \- Gathers data from all processes and delivers it to all. Each process may contribute a different amount of data.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Alloc_mem 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Alloc_mem 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Alloc_mem \fP \- Allocates a specified memory segment.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Allreduce 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Allreduce 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Allreduce, MPI_Iallreduce\fP \- Combines values from all processes and distributes the result back to all processes.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Alltoall 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Alltoall 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
\fBMPI_Alltoall, MPI_Ialltoall\fP \- All processes send data to all processes
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Alltoallv 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Alltoallv 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
\fBMPI_Alltoallv, MPI_Ialltoallv\fP \- All processes send different amount of data to, and receive different amount of data from, all processes
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Alltoallw 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Alltoallw 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
|
||||
.SH NAME
|
||||
\fBMPI_Alltoallw, MPI_Ialltoallw\fP \- All processes send data of different types to, and receive data of different types from, all processes
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Attr_delete 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Attr_delete 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Attr_delete\fP \- Deletes attribute value associated with a key -- use of this routine is deprecated.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Attr_get 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Attr_get 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Attr_get\fP \- Retrieves attribute value by key -- use of this routine is deprecated.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Attr_put 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Attr_put 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Attr_put\fP \- Stores attribute value associated with a key -- use of this routine is deprecated.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Barrier 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Barrier 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Barrier, MPI_Ibarrier\fP \- Synchronization between MPI processes in a group
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Bcast 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Bcast 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Bcast, MPI_Ibcast\fP \- Broadcasts a message from the process with rank \fIroot\fP to all other processes of the group.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Bsend 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Bsend 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Bsend\fP \- Basic send with user-specified buffering.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Bsend_init 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Bsend_init 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Bsend_init\fP \- Builds a handle for a buffered send.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Buffer_attach 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Buffer_attach 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Buffer_attach\fP \- Attaches a user-defined buffer for sending.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Buffer_detach 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Buffer_detach 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Buffer_detach\fP \- Removes an existing buffer (for use in MPI_Bsend, etc.)
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cancel 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cancel 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cancel\fP \- Cancels a communication request.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_coords 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_coords 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_coords\fP \- Determines process coords in Cartesian topology given rank in group.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_create 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_create 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_create\fP \- Makes a new communicator to which Cartesian topology information has been attached.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_get 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_get 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_get\fP \- Retrieves Cartesian topology information associated with a communicator.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_map 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_map 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_map \fP \- Maps process to Cartesian topology information.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_rank 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_rank 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_rank \fP \- Determines process rank in communicator given Cartesian location.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_shift 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_shift 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_shift \fP \- Returns the shifted source and destination ranks, given a shift direction and amount.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cart_sub 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cart_sub 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cart_sub \fP \- Partitions a communicator into subgroups, which form lower-dimensional Cartesian subgrids.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Cartdim_get 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Cartdim_get 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Cartdim_get \fP \- Retrieves Cartesian topology information associated with a communicator.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Close_port 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Close_port 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Close_port \fP \- Releases the specified network address.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2007, Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_accept 3OpenMPI "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_accept 3OpenMPI "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_accept \fP \- Establishes communication with a client.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_call_errhandler 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_call_errhandler 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
|
||||
\fBMPI_Comm_call_errhandler\fP \- Passes the supplied error code to the
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_compare 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_compare 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_compare \fP \- Compares two communicators.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2007-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_connect 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_connect 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_connect \fP \- Establishes communication with a server.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_create 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_create 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_create\fP \- Creates a new communicator.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_create_errhandler 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_create_errhandler 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_create_errhandler \fP \- Creates an error handler that can be attached to communicators.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines Corporation
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_create_group 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_create_group 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_create_group\fP \- Creates a new communicator.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
||||
.\" Copyright (c) 1996 Thinking Machines
|
||||
.\" $COPYRIGHT$
|
||||
.TH MPI_Comm_create_keyval 3 "Aug 22, 2018" "3.1.2" "Open MPI"
|
||||
.TH MPI_Comm_create_keyval 3 "Mar 26, 2019" "4.0.1" "Open MPI"
|
||||
.SH NAME
|
||||
\fBMPI_Comm_create_keyval\fP \- Generates a new attribute key.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user