Skip to content

Commit f15fea1

Browse files
committed
utils/manpages: talk much more about HBM NUMA nodes
Keep references to KNL MCDRAM but make sure we have HBM nearby since it's going to be more common now. Signed-off-by: Brice Goglin <[email protected]>
1 parent c3061d1 commit f15fea1

File tree

4 files changed

+23
-11
lines changed

4 files changed

+23
-11
lines changed

utils/hwloc/hwloc-bind.1in

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,17 @@ All existing attributes in the current topology may be listed with
8383

8484
.TP
8585
\fB\-\-hbm\fR
86-
Only take high bandwidth memory nodes (Intel Xeon Phi MCDRAM)
86+
Only take high bandwidth memory nodes
87+
(marked with "HBM" subtype, or "MCDRAM" on Intel Xeon Phi)
8788
in account when looking for NUMA nodes in the input locations.
8889

8990
This option must be combined with NUMA node locations,
9091
such as \fI--hbm numa:1\fR for binding on the second HBM node.
91-
It may also be written as \fInuma[hbm]:1\fR.
92+
It may also be written as \fInuma[hbm]:1\fR or \fInuma[mcdram]:1\fR.
9293
.TP
9394
\fB\-\-no\-hbm\fR
94-
Ignore high bandwidth memory nodes (Intel Xeon Phi MCDRAM)
95+
Ignore high bandwidth memory nodes
96+
(marked with "HBM" subtype, or "MCDRAM" on Intel Xeon Phi MCDRAM)
9597
when looking for NUMA nodes in the input locations.
9698
.
9799
.SH OPTIONS
@@ -295,7 +297,12 @@ To bind on the memory node local to a PU with largest capacity:
295297

296298
$ hwloc-bind --best-memattr capacity --cpubind pu:23 --membind pu:23 -- echo hello
297299

298-
To bind memory on the first high-bandwidth memory node on Intel Xeon Phi:
300+
To bind memory on the first NUMA node marked with "HBM" subtype:
301+
302+
$ hwloc-bind --membind numa[hbm]:0 -- echo hello
303+
$ hwloc-bind --hbm --membind numa:0 -- echo hello
304+
305+
To bind memory on the first high-bandwidth memory node (MCDRAM) on Intel Xeon Phi:
299306

300307
$ hwloc-bind --membind numa[mcdram]:0 -- echo hello
301308
$ hwloc-bind --hbm --membind numa:0 -- echo hello

utils/hwloc/hwloc-calc.1in

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ the nodeset is considered instead of the CPU set for finding matching objects.
165165
This is useful when reporting the output as a number or set of NUMA nodes.
166166

167167
\fI<type\fR may contain a filter to select specific objects among
168-
the type. For instance \fB\-N "numa[mcdram]"\fR counts MCDRAM NUMA nodes on KNL.
168+
the type. For instance \fB\-N "numa[hbm]"\fR counts NUMA nodes marked with subtype "HBM",
169+
while \fB\-N "numa[mcdram]"\fR only counts MCDRAM NUMA nodes on KNL.
169170

170171
If an OS device subtype such as \fIgpu\fR is given instead of \fIosdev\fR,
171172
only the os devices of that subtype will be counted.
@@ -186,7 +187,8 @@ the nodeset is considered instead of the CPU set for finding matching objects.
186187
This is useful when reporting the output as a number or set of NUMA nodes.
187188

188189
\fI<type\fR may contain a filter to select specific objects among
189-
the type. For instance \fB\-I "numa[mcdram]"\fR lists MCDRAM NUMA nodes on KNL.
190+
the type. For instance \fB\-N "numa[hbm]"\fR lists NUMA nodes marked with subtype "HBM",
191+
while \fB\-N "numa[mcdram]"\fR only lists MCDRAM NUMA nodes on KNL.
190192

191193
If an OS device subtype such as \fIgpu\fR is given instead of \fIosdev\fR,
192194
only the os devices of that subtype will be returned.
@@ -397,9 +399,9 @@ whose locality is exactly equal to a Package:
397399
$ hwloc-calc --local-memory-flags 0 --best-memattr capacity --physical-output pack:1
398400
4
399401

400-
To find the number of NUMA nodes with subtype MCDRAM (on KNL):
402+
To find the number of NUMA nodes with subtype "HBM":
401403

402-
$ hwloc-calc -N "numa[mcdram]" all
404+
$ hwloc-calc -N "numa[hbm]" all
403405
4
404406

405407
To find the NUMA node of subtype MCDRAM (on KNL) near a PU:

utils/hwloc/hwloc.7in

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Some filters may be added after the type to further specify which
9393
objects are wanted.
9494
\fI<type>[subtype=<subtype>]\fR selects objects matching the given
9595
type and also its subtype string attribute.
96-
For instance \fINUMA[MCDRAM]\fR selects NUMA nodes of subtype MCDRAM on KNL.
96+
For instance \fINUMA[HBM]\fR selects NUMA nodes of subtype "HBM".
9797
The prefix \fIsubtype=\fR may be avoided if there is no ambiguity.
9898
\fIOS[Net]\fR also selects OS devices whose OS-device-specific type is Network.
9999
.br
@@ -212,7 +212,8 @@ A NUMA node; a set of processors around memory which the processors
212212
can directly access.
213213
.
214214
If \fBnuma[hbm]\fR is used instead of \fBnumanode\fR in locations,
215-
command-line tools only consider high-bandwidth memory nodes such as Intel Xeon Phi MCDRAM.
215+
command-line tools only consider NUMA nodes marked as high-bandwidth memory
216+
(subtype "HBM").
216217
.
217218
.TP
218219
.B package

utils/lstopo/lstopo-no-graphics.1in

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,9 @@ otherwise it will imply \fB\-\-cpuset\fR.
165165
Only show objects of the given type in the textual output.
166166

167167
\fI<type>\fR may contain a filter to select specific objects among
168-
the type. For instance \fB\-\-only "numa[mcdram]"\fR only shows MCDRAM NUMA nodes on KNL.
168+
the type. For instance \fB\-\-only NUMA[HBM]\fR only shows NUMA nodes
169+
marked with subtype "HBM", while \fB\-\-only "numa[mcdram]"\fR only
170+
shows MCDRAM NUMA nodes on KNL.
169171
.TP
170172
\fB\-\-filter\fR <type>:<kind>, \fB\-\-filter\fR <type>
171173
Filter objects of type <type>, or of any type if <type> is "all".

0 commit comments

Comments
 (0)