From 13fd64848950da8e8055170a043ad61d33d48e41 Mon Sep 17 00:00:00 2001 From: Morris Jette <jette@schedmd.com> Date: Mon, 16 Jul 2012 09:00:24 -0700 Subject: [PATCH] switch/nrt: Minor updates to documentation --- doc/html/poe.shtml | 22 +++++++++++++++------- doc/man/man1/salloc.1 | 22 +++++++++++++++------- doc/man/man1/sbatch.1 | 26 +++++++++++++++++--------- doc/man/man1/srun.1 | 30 +++++++++++++++++++++--------- 4 files changed, 68 insertions(+), 32 deletions(-) diff --git a/doc/html/poe.shtml b/doc/html/poe.shtml index a45752af508..c232eeaffd1 100644 --- a/doc/html/poe.shtml +++ b/doc/html/poe.shtml @@ -49,7 +49,7 @@ SLURM_NETWORK environment variable. Supported network options include:</p> <li><b>ipv6</b> Internet protocol, version 6</li> <li><b>us</b> User Space protocol, may be combined with ibv4 or ipv6</li> </ul> -<li>Task communication interface</li> +<li>Programming interface</li> <ul> <li><b>lapi</b> Low-level Application Programming Interface</li> <li><b>mpi</b> Message Passing Interface (default)</li> @@ -62,11 +62,15 @@ SLURM_NETWORK environment variable. Supported network options include:</p> Enable bulk transfer of data using Remote Direct-Memory Access (RDMA). The optional <i>resources</i> specification is a numeric value which can have a suffix of "k", "K", "m", "M", "g" or "G" for kilobytes, megabytes or - gigabytes.</li> + gigabytes. + <b>NOTE:</b> The <i>resources</i> specification is not supported by the + underlying IBM infrastructure as of Parallel Environment version 2.2 and no + value should be specified at this time.</li> <li><b>cau=<i>count</i></b> - Specify the count of Collective Acceleration Units (CAU) required per adapter. + Specify the count of Collective Acceleration Units (CAU) required per + programming interface. Default value is zero. - Applies only to IBM Power7 processors. + Applies only to IBM Power7-IH processors. <li><b>devname=<i>name</i></b> Specify the name of an network adapter to use. For example: "eth0" or "mlx4_0".</li> @@ -75,11 +79,15 @@ SLURM_NETWORK environment variable. Supported network options include:</p> The supported values of <i>type</i> are: "IB" (InfiniBand), "HFI" (P7 Host Fabric Interface), "IPONLY" (IP-Only interfaces), "HPCE" (HPC Ethernet), and - "KMUX" (Kernel Emulation of HPCE).</li> + "KMUX" (Kernel Emulation of HPCE). + The devices allocated to a job must all be of the same type. + The default value depends upon depends upon what hardware is available and in + order of preferences is IPONLY (which is not considered in User Space mode), + HFI, IB, HPCE, and KMUX.</li> <li><b>immed=<i>count</i></b> Specify the count of immediate send slots per adapter window. Default value is zero. - Applies only to IBM Power7 processors. + Applies only to IBM Power7-IH processors. <li><b>instances=<i>count</i></b> Specify number of network connections for each task on each network connection. The default instance count is 1.</li> @@ -210,6 +218,6 @@ MP_POOL=slurm <p class="footer"><a href="#top">top</a></p> -<p style="text-align:center;">Last modified 12 July 2012</p></td> +<p style="text-align:center;">Last modified 16 July 2012</p></td> <!--#include virtual="footer.txt"--> diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1 index 8f421529665..f8eb63fdba1 100644 --- a/doc/man/man1/salloc.1 +++ b/doc/man/man1/salloc.1 @@ -752,11 +752,15 @@ Enable bulk transfer of data using Remote Direct-Memory Access (RDMA). The optional \fIresources\fR specification is a numeric value which can have a suffix of "k", "K", "m", "M", "g" or "G" for kilobytes, megabytes or gigabytes. +NOTE: The \fIresources\fR specification is not supported by the underlying +IBM infrastructure as of Parallel Environment version 2.2 and no value should +be specified at this time. .TP \fBCAU\fR=<\fIcount\fR> Number of Collecitve Accelleration Units (CAU) required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. +Independent CAU will be allocated for each programming interface (MPI, LAPI, etc.) .TP \fBDEVNAME\fR=<\fIname\fR> Specify the device name to use for communications (e.g. "eth0" or "mlx4_0"). @@ -767,10 +771,14 @@ The supported values of \fItype\fR are: "IB" (InfiniBand), "HFI" (P7 Host Fabric Interface), "IPONLY" (IP-Only interfaces), "HPCE" (HPC Ethernet), and "KMUX" (Kernel Emulation of HPCE). +The devices allocated to a job must all be of the same type. +The default value depends upon depends upon what hardware is available and in +order of preferences is IPONLY (which is not considered in User Space mode), +HFI, IB, HPCE, and KMUX. .TP \fBIMMED\fR =<\fIcount\fR> Number of immediate send slots per window required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. .TP \fBINSTANCES\fR =<\fIcount\fR> @@ -784,14 +792,14 @@ Use Internet Protocol (IP) version 4 communications (default). Use Internet Protocol (IP) version 6 communications. .TP \fBLAPI\fR -Use the LAPI protocol. +Use the LAPI programming interface. .TP \fBMPI\fR -Use the MPI protocol. -MPI is the default protocol. +Use the MPI programming interface. +MPI is the default interface. .TP \fBPAMI\fR -Use the PAMI protocol. +Use the PAMI programming interface. .TP \fBSN_ALL\fR Use all available switch networks (default). @@ -800,7 +808,7 @@ Use all available switch networks (default). Use one available switch network. .TP \fBUPC\fR -Use the UPC protocol. +Use the UPC programming interface. .TP \fBUS\fR Use User Space communications. diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 6cb363827e2..1c7c8ad5275 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -815,11 +815,15 @@ Enable bulk transfer of data using Remote Direct-Memory Access (RDMA). The optional \fIresources\fR specification is a numeric value which can have a suffix of "k", "K", "m", "M", "g" or "G" for kilobytes, megabytes or gigabytes. +NOTE: The \fIresources\fR specification is not supported by the underlying +IBM infrastructure as of Parallel Environment version 2.2 and no value should +be specified at this time. .TP \fBCAU\fR=<\fIcount\fR> Number of Collecitve Accelleration Units (CAU) required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. +Independent CAU will be allocated for each programming interface (MPI, LAPI, etc.) .TP \fBDEVNAME\fR=<\fIname\fR> Specify the device name to use for communications (e.g. "eth0" or "mlx4_0"). @@ -830,13 +834,17 @@ The supported values of \fItype\fR are: "IB" (InfiniBand), "HFI" (P7 Host Fabric Interface), "IPONLY" (IP-Only interfaces), "HPCE" (HPC Ethernet), and "KMUX" (Kernel Emulation of HPCE). +The devices allocated to a job must all be of the same type. +The default value depends upon depends upon what hardware is available and in +order of preferences is IPONLY (which is not considered in User Space mode), +HFI, IB, HPCE, and KMUX. .TP -\fBIMMED\fR=<\fIcount\fR> +\fBIMMED\fR =<\fIcount\fR> Number of immediate send slots per window required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. .TP -\fBINSTANCES\fR=<\fIcount\fR> +\fBINSTANCES\fR =<\fIcount\fR> Specify number of network connections for each task on each network connection. The default instance count is 1. .TP @@ -847,14 +855,14 @@ Use Internet Protocol (IP) version 4 communications (default). Use Internet Protocol (IP) version 6 communications. .TP \fBLAPI\fR -Use the LAPI protocol. +Use the LAPI programming interface. .TP \fBMPI\fR -Use the MPI protocol. -MPI is the default protocol. +Use the MPI programming interface. +MPI is the default interface. .TP \fBPAMI\fR -Use the PAMI protocol. +Use the PAMI programming interface. .TP \fBSN_ALL\fR Use all available switch networks (default). @@ -863,7 +871,7 @@ Use all available switch networks (default). Use one available switch network. .TP \fBUPC\fR -Use the UPC protocol. +Use the UPC programming interface. .TP \fBUS\fR Use User Space communications. diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index 59fa01e89bb..2053013432e 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -854,11 +854,19 @@ Enable bulk transfer of data using Remote Direct-Memory Access (RDMA). The optional \fIresources\fR specification is a numeric value which can have a suffix of "k", "K", "m", "M", "g" or "G" for kilobytes, megabytes or gigabytes. +NOTE: The \fIresources\fR specification is not supported by the underlying +IBM infrastructure as of Parallel Environment version 2.2 and no value should +be specified at this time. +The devices allocated to a job must all be of the same type. +The default value depends upon depends upon what hardware is available and in +order of preferences is IPONLY (which is not considered in User Space mode), +HFI, IB, HPCE, and KMUX. .TP \fBCAU\fR=<\fIcount\fR> Number of Collecitve Accelleration Units (CAU) required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. +Independent CAU will be allocated for each programming interface (MPI, LAPI, etc.) .TP \fBDEVNAME\fR=<\fIname\fR> Specify the device name to use for communications (e.g. "eth0" or "mlx4_0"). @@ -869,13 +877,17 @@ The supported values of \fItype\fR are: "IB" (InfiniBand), "HFI" (P7 Host Fabric Interface), "IPONLY" (IP-Only interfaces), "HPCE" (HPC Ethernet), and "KMUX" (Kernel Emulation of HPCE). +The devices allocated to a job must all be of the same type. +The default value depends upon depends upon what hardware is available and in +order of preferences is IPONLY (which is not considered in User Space mode), +HFI, IB, HPCE, and KMUX. .TP -\fBIMMED\fR=<\fIcount\fR> +\fBIMMED\fR =<\fIcount\fR> Number of immediate send slots per window required. -Applies only to IBM Power7 processors. +Applies only to IBM Power7-IH processors. Default value is zero. .TP -\fBINSTANCES\fR=<\fIcount\fR> +\fBINSTANCES\fR =<\fIcount\fR> Specify number of network connections for each task on each network connection. The default instance count is 1. .TP @@ -886,14 +898,14 @@ Use Internet Protocol (IP) version 4 communications (default). Use Internet Protocol (IP) version 6 communications. .TP \fBLAPI\fR -Use the LAPI protocol. +Use the LAPI programming interface. .TP \fBMPI\fR -Use the MPI protocol. -MPI is the default protocol. +Use the MPI programming interface. +MPI is the default interface. .TP \fBPAMI\fR -Use the PAMI protocol. +Use the PAMI programming interface. .TP \fBSN_ALL\fR Use all available switch networks (default). @@ -902,7 +914,7 @@ Use all available switch networks (default). Use one available switch network. .TP \fBUPC\fR -Use the UPC protocol. +Use the UPC programming interface. .TP \fBUS\fR Use User Space communications. -- GitLab