Skip to content
Snippets Groups Projects
Commit 54ef6172 authored by Morris Jette's avatar Morris Jette
Browse files

Clarify documenation with respect to CPU binding

parent a6bfae71
No related branches found
No related tags found
No related merge requests found
...@@ -1257,6 +1257,12 @@ The reservation ID on Cray systems running ALPS/BASIL only. ...@@ -1257,6 +1257,12 @@ The reservation ID on Cray systems running ALPS/BASIL only.
\fBSLURM_CPU_BIND\fR \fBSLURM_CPU_BIND\fR
Set to value of the \-\-cpu_bind\fR option. Set to value of the \-\-cpu_bind\fR option.
.TP .TP
\fBSLURM_CPU_BIND_LIST\fR
\-\-cpu_bind map or mask list (list of SLURM CPU IDs or masks for this node,
CPU_ID = Board_ID x threads_per_board +
Socket_ID x threads_per_socket +
Core_ID x threads_per_core + Thread_ID).
.TP
\fBSLURM_JOB_ID\fR (and \fBSLURM_JOBID\fR for backwards compatibility) \fBSLURM_JOB_ID\fR (and \fBSLURM_JOBID\fR for backwards compatibility)
The ID of the job allocation. The ID of the job allocation.
.TP .TP
......
...@@ -1388,6 +1388,12 @@ The reservation ID on Cray systems running ALPS/BASIL only. ...@@ -1388,6 +1388,12 @@ The reservation ID on Cray systems running ALPS/BASIL only.
\fBSLURM_CPU_BIND\fR \fBSLURM_CPU_BIND\fR
Set to value of the \-\-cpu_bind\fR option. Set to value of the \-\-cpu_bind\fR option.
.TP .TP
\fBSLURM_CPU_BIND_LIST\fR
\-\-cpu_bind map or mask list (list of SLURM CPU IDs or masks for this node,
CPU_ID = Board_ID x threads_per_board +
Socket_ID x threads_per_socket +
Core_ID x threads_per_core + Thread_ID).
.TP
\fBSLURM_JOB_ID\fR (and \fBSLURM_JOBID\fR for backwards compatibility) \fBSLURM_JOB_ID\fR (and \fBSLURM_JOBID\fR for backwards compatibility)
The ID of the job allocation. The ID of the job allocation.
.TP .TP
......
...@@ -1878,7 +1878,10 @@ if specified on the execute line. ...@@ -1878,7 +1878,10 @@ if specified on the execute line.
\-\-cpu_bind type (none,rank,map_cpu:,mask_cpu:) \-\-cpu_bind type (none,rank,map_cpu:,mask_cpu:)
.TP .TP
\fBSLURM_CPU_BIND_LIST\fR \fBSLURM_CPU_BIND_LIST\fR
\-\-cpu_bind map or mask list (<list of IDs or masks for this node>) \-\-cpu_bind map or mask list (list of SLURM CPU IDs or masks for this node,
CPU_ID = Board_ID x threads_per_board +
Socket_ID x threads_per_socket +
Core_ID x threads_per_core + Thread_ID).
.TP .TP
\fBSLURM_CPU_FREQ_REQ\fR \fBSLURM_CPU_FREQ_REQ\fR
......
...@@ -30,7 +30,6 @@ otherwise the default value is one. A suffix of "K", "M" or "G" may be used ...@@ -30,7 +30,6 @@ otherwise the default value is one. A suffix of "K", "M" or "G" may be used
to mulitply the number by 1024, 1048576 or 1073741824 respectively. to mulitply the number by 1024, 1048576 or 1073741824 respectively.
Note that Count is a 32\-bit field and the maximum value is 4,294,967,295. Note that Count is a 32\-bit field and the maximum value is 4,294,967,295.
.TP .TP
\fBCPUs\fR \fBCPUs\fR
Specify the CPU index numbers for the specific CPUs which can Specify the CPU index numbers for the specific CPUs which can
...@@ -42,6 +41,12 @@ delimited list or a range may be specified using a "\-" separator ...@@ -42,6 +41,12 @@ delimited list or a range may be specified using a "\-" separator
If not specified, then any CPU can be used with the resources. If not specified, then any CPU can be used with the resources.
If any CPU can be used with the resources, then do not specify the If any CPU can be used with the resources, then do not specify the
\fBCPUs\fR option for improved speed in the SLURM scheduling logic. \fBCPUs\fR option for improved speed in the SLURM scheduling logic.
Since SLURM must be able to perform resource management on heterogeneous
clusters having various CPU ID numbering schemes, use the SLURM CPU index
numbers here
(CPU_ID = Board_ID x threads_per_board +
Socket_ID x threads_per_socket +
Core_ID x threads_per_core + Thread_ID).
.TP .TP
\fBFile\fR \fBFile\fR
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment