Skip to content

Commit

Permalink
utils/manpages: talk much more about HBM NUMA nodes
Browse files Browse the repository at this point in the history
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 <Brice.Goglin@inria.fr>
  • Loading branch information
bgoglin committed Oct 26, 2023
1 parent c3061d1 commit f15fea1
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 11 deletions.
15 changes: 11 additions & 4 deletions utils/hwloc/hwloc-bind.1in
Expand Up @@ -83,15 +83,17 @@ All existing attributes in the current topology may be listed with

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

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

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

To bind memory on the first high-bandwidth memory node on Intel Xeon Phi:
To bind memory on the first NUMA node marked with "HBM" subtype:

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

To bind memory on the first high-bandwidth memory node (MCDRAM) on Intel Xeon Phi:

$ hwloc-bind --membind numa[mcdram]:0 -- echo hello
$ hwloc-bind --hbm --membind numa:0 -- echo hello
Expand Down
10 changes: 6 additions & 4 deletions utils/hwloc/hwloc-calc.1in
Expand Up @@ -165,7 +165,8 @@ the nodeset is considered instead of the CPU set for finding matching objects.
This is useful when reporting the output as a number or set of NUMA nodes.

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

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

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

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

To find the number of NUMA nodes with subtype MCDRAM (on KNL):
To find the number of NUMA nodes with subtype "HBM":

$ hwloc-calc -N "numa[mcdram]" all
$ hwloc-calc -N "numa[hbm]" all
4

To find the NUMA node of subtype MCDRAM (on KNL) near a PU:
Expand Down
5 changes: 3 additions & 2 deletions utils/hwloc/hwloc.7in
Expand Up @@ -93,7 +93,7 @@ Some filters may be added after the type to further specify which
objects are wanted.
\fI<type>[subtype=<subtype>]\fR selects objects matching the given
type and also its subtype string attribute.
For instance \fINUMA[MCDRAM]\fR selects NUMA nodes of subtype MCDRAM on KNL.
For instance \fINUMA[HBM]\fR selects NUMA nodes of subtype "HBM".
The prefix \fIsubtype=\fR may be avoided if there is no ambiguity.
\fIOS[Net]\fR also selects OS devices whose OS-device-specific type is Network.
.br
Expand Down Expand Up @@ -212,7 +212,8 @@ A NUMA node; a set of processors around memory which the processors
can directly access.
.
If \fBnuma[hbm]\fR is used instead of \fBnumanode\fR in locations,
command-line tools only consider high-bandwidth memory nodes such as Intel Xeon Phi MCDRAM.
command-line tools only consider NUMA nodes marked as high-bandwidth memory
(subtype "HBM").
.
.TP
.B package
Expand Down
4 changes: 3 additions & 1 deletion utils/lstopo/lstopo-no-graphics.1in
Expand Up @@ -165,7 +165,9 @@ otherwise it will imply \fB\-\-cpuset\fR.
Only show objects of the given type in the textual output.

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

0 comments on commit f15fea1

Please sign in to comment.