278 lines
9.4 KiB
Groff
278 lines
9.4 KiB
Groff
.\" -*- nroff -*-
|
|
.\" Copyright © 2009-2022 Inria. All rights reserved.
|
|
.\" Copyright © 2009-2010 Université of Bordeaux
|
|
.\" Copyright © 2009-2010 Cisco Systems, Inc. All rights reserved.
|
|
.\" See COPYING in top-level directory.
|
|
.TH HWLOC-INFO "1" "Dec 14, 2022" "2.9.0" "hwloc"
|
|
.SH NAME
|
|
hwloc-info \- Show some information about some objects or about a topology or about support features
|
|
.
|
|
.\" **************************
|
|
.\" Synopsis Section
|
|
.\" **************************
|
|
.SH SYNOPSIS
|
|
.
|
|
.PP
|
|
.B hwloc-info
|
|
[ \fIoptions \fR]...
|
|
\fI<object>\fR...
|
|
.PP
|
|
.B hwloc-info
|
|
[ \fIoptions \fR]...
|
|
.
|
|
.PP
|
|
Note that hwloc(7) provides a detailed explanation of the hwloc system
|
|
and of valid <object> formats;
|
|
it should be read before reading this man page.
|
|
.\" **************************
|
|
.\" Options Section
|
|
.\" **************************
|
|
.SH OPTIONS
|
|
.
|
|
.TP
|
|
\fB\-\-objects\fR
|
|
Report information specific objects.
|
|
This is the default if some objects are given on the command-line.
|
|
.TP
|
|
\fB\-\-topology\fR
|
|
Report a summary of the topology instead of about some specific objects.
|
|
This is the default if no object is given on the command-line.
|
|
.TP
|
|
\fB\-\-support\fR
|
|
Report the features that are supported by hwloc on the topology.
|
|
The features are those available through the \fBhwloc_topology_get_support()\fR function.
|
|
This is useful for verifying which CPU or memory binding options are supported
|
|
by the current hwloc installation.
|
|
.TP
|
|
\fB\-i\fR <path>, \fB\-\-input\fR <path>
|
|
Read the topology from <path> instead of discovering the topology of the local machine.
|
|
|
|
If <path> is a file and XML support has been compiled in hwloc,
|
|
it may be a XML file exported by a previous hwloc program.
|
|
If <path> is "\-", the standard input may be used as a XML file.
|
|
|
|
On Linux, <path> may be a directory containing the topology files
|
|
gathered from another machine topology with hwloc-gather-topology.
|
|
|
|
On x86, <path> may be a directory containing a cpuid dump gathered
|
|
with hwloc-gather-cpuid.
|
|
|
|
When the archivemount program is available, <path> may also be a tarball
|
|
containing such Linux or x86 topology files.
|
|
.TP
|
|
\fB\-i\fR <specification>, \fB\-\-input\fR <specification>
|
|
Simulate a fake hierarchy (instead of discovering the topology on the
|
|
local machine). If <specification> is "node:2 pu:3", the topology will
|
|
contain two NUMA nodes with 3 processing units in each of them.
|
|
The <specification> string must end with a number of PUs.
|
|
.TP
|
|
\fB\-\-if\fR <format>, \fB\-\-input\-format\fR <format>
|
|
Enforce the input in the given format, among \fBxml\fR, \fBfsroot\fR,
|
|
\fBcpuid\fR and \fBsynthetic\fR.
|
|
.TP
|
|
\fB\-v\fR \fB\-\-verbose\fR
|
|
Include additional detail.
|
|
.TP
|
|
\fB\-s\fR \fB\-\-silent\fR
|
|
Reduce the amount of details to show.
|
|
A single summary line per object is displayed.
|
|
.TP
|
|
\fB\-\-ancestors\fR
|
|
Display information about the object as well as
|
|
about all its ancestors up to the root of the topology.
|
|
.TP
|
|
\fB\-\-ancestor\fR <type>
|
|
Only display the object ancestors that match the given type.
|
|
.TP
|
|
\fB\-\-children\fR
|
|
Display information about the object children.
|
|
.TP
|
|
\fB\-\-descendants\fR <type>
|
|
Display information about the object descendants that match the given type.
|
|
.TP
|
|
\fB\-\-local\-memory\fR
|
|
Display information about the NUMA nodes that are local to the given object.
|
|
.TP
|
|
\fB\-\-local\-memory\-flags\fR
|
|
Change the flags used to select local NUMA nodes.
|
|
Flags may be given as numeric values or as a comma-separated list of flag names
|
|
that are passed to \fIhwloc_get_local_numanode_objs()\fR.
|
|
Those names may be substrings of actual flag names as long as a single one matches.
|
|
The default is \fB3\fR (or \fBsmaller,larger\fR)
|
|
which means NUMA nodes are displayed
|
|
if their locality either contains or is contained
|
|
in the locality of the given object.
|
|
|
|
This option enables \fB\-\-local\-memory\fR.
|
|
.TP
|
|
\fB\-\-best\-memattr\fR <name>
|
|
Enable the listing local memory nodes with \fB\-\-local\-memory\fR,
|
|
but only display the local node that has the best value for the memory
|
|
attribute given by \fI<name>\fR (or as an index).
|
|
If the memory attribute values depend on the initiator, the object given
|
|
to hwloc-info is used as the initiator.
|
|
.TP
|
|
\fB\-n\fR
|
|
When outputting object information, prefix each line with the index
|
|
of the considered object within the input.
|
|
For instance, if three cores were given in input, the output
|
|
lines will be prefixed with "0: ", "1: " or "2: ".
|
|
If \fB\-\-ancestor\fR is also used, the prefix will be "X.Y: "
|
|
where X is the index of the considered object within the input,
|
|
and Y is the parent index (0 for the object itself, increasing
|
|
towards the root of the topology).
|
|
.TP
|
|
\fB\-\-disallowed\fR
|
|
Include objects disallowed by administrative limitations.
|
|
.TP
|
|
\fB\-\-restrict\fR <cpuset>
|
|
Restrict the topology to the given cpuset.
|
|
.TP
|
|
\fB\-\-restrict\fR nodeset=<nodeset>
|
|
Restrict the topology to the given nodeset, unless \fB\-\-restrict\-flags\fR specifies something different.
|
|
.TP
|
|
\fB\-\-restrict\fR binding
|
|
Restrict the topology to the current process binding.
|
|
This option requires the use of the actual current machine topology
|
|
(or any other topology with \fB\-\-thissystem\fR or with
|
|
HWLOC_THISSYSTEM set to 1 in the environment).
|
|
.TP
|
|
\fB\-\-restrict\-flags\fR <flags>
|
|
Enforce flags when restricting the topology.
|
|
Flags may be given as numeric values or as a comma-separated list of flag names
|
|
that are passed to \fIhwloc_topology_restrict()\fR.
|
|
Those names may be substrings of actual flag names as long as a single one matches,
|
|
for instance \fBbynodeset,memless\fR.
|
|
The default is \fB0\fR (or \fBnone\fR).
|
|
.TP
|
|
\fB\-\-filter\fR <type>:<kind>, \fB\-\-filter\fR <type>
|
|
Filter objects of type <type>, or of any type if <type> is "all".
|
|
"io", "cache" and "icache" are also supported.
|
|
|
|
<kind> specifies the filtering behavior.
|
|
If "none" or not specified, all objects of the given type are removed.
|
|
If "all", all objects are kept as usual.
|
|
If "structure", objects are kept when they bring structure to the topology.
|
|
If "important" (only applicable to I/O and Misc), only important objects are kept.
|
|
See hwloc_topology_set_type_filter() for more details.
|
|
.TP
|
|
\fB\-\-no\-icaches\fR
|
|
Do not show Instruction caches, only Data and Unified caches are considered.
|
|
This is identical to \fB-\-filter icache:none\fR.
|
|
.TP
|
|
\fB\-\-no\-io\fB
|
|
Do not show any I/O device or bridge.
|
|
This is identical to \fB\-\-filter io:none\fR.
|
|
By default, common devices (GPUs, NICs, block devices, ...) and
|
|
interesting bridges are shown.
|
|
.TP
|
|
\fB\-\-no\-bridges\fB
|
|
Do not show any I/O bridge except hostbridges.
|
|
This is identical to \fB\-\-filter bridge:none\fR.
|
|
By default, common devices (GPUs, NICs, block devices, ...) and
|
|
interesting bridges are shown.
|
|
.TP
|
|
\fB\-\-whole\-io\fB
|
|
Show all I/O devices and bridges.
|
|
This is identical to \fB\-\-filter io:all\fR.
|
|
By default, only common devices (GPUs, NICs, block devices, ...) and
|
|
interesting bridges are shown.
|
|
.TP
|
|
\fB\-\-thissystem\fR
|
|
Assume that the selected backend provides the topology for the
|
|
system on which we are running.
|
|
This is useful when using \fB\-\-restrict\fR binding and loading
|
|
a custom topology such as an XML file.
|
|
.TP
|
|
\fB\-\-pid\fR <pid>
|
|
Detect topology as seen by process <pid>, i.e. as if process <pid> did the
|
|
discovery itself.
|
|
Note that this can for instance change the set of allowed processors.
|
|
Also show this process current CPU binding by marking the corresponding
|
|
PUs (in Green in the graphical output, see the COLORS section below,
|
|
or by appending \fI(binding)\fR to the verbose text output).
|
|
If 0 is given as pid, the current binding for the lstopo process will be shown.
|
|
.TP
|
|
\fB\-p\fR \fB\-\-physical\fR
|
|
Use OS/physical indexes instead of logical indexes for input.
|
|
.TP
|
|
\fB\-l\fR \fB\-\-logical\fR
|
|
Use logical indexes instead of physical/OS indexes for input (default).
|
|
.TP
|
|
\fB\-\-version\fR
|
|
Report version and exit.
|
|
.TP
|
|
\fB\-h\fR \fB\-\-help\fR
|
|
Display help message and exit.
|
|
.
|
|
.\" **************************
|
|
.\" Description Section
|
|
.\" **************************
|
|
.SH DESCRIPTION
|
|
.
|
|
hwloc-info displays information about the specified object.
|
|
It is intended to be used with tools such as grep for filtering
|
|
certain attribute lines.
|
|
When no object is specified, or when \fB\-\-topology\fR is passed,
|
|
hwloc-info prints a summary of the topology.
|
|
When \fB\-\-support\fR is passed, hwloc-info lists the supported
|
|
features for the topology.
|
|
.
|
|
.PP
|
|
Objects may be specified as location tuples, as explained in hwloc(7).
|
|
However hexadecimal bitmasks are not accepted since they may correspond
|
|
to multiple objects.
|
|
.
|
|
.PP
|
|
.B NOTE:
|
|
It is highly recommended that you read the hwloc(7) overview page
|
|
before reading this man page. Most of the concepts described in
|
|
hwloc(7) directly apply to the hwloc-calc utility.
|
|
.
|
|
.\" **************************
|
|
.\" Examples Section
|
|
.\" **************************
|
|
.SH EXAMPLES
|
|
.PP
|
|
To display information about each package:
|
|
|
|
$ hwloc-info package:all
|
|
Package L#0
|
|
logical index = 0
|
|
...
|
|
|
|
To display information about the core whose physical index is 2:
|
|
|
|
$ hwloc-info -p core:2
|
|
Core L#1
|
|
logical index = 1
|
|
os index = 2
|
|
...
|
|
|
|
To list the NUMA nodes that are local a PU:
|
|
|
|
$ hwloc-info --local-memory pu:25
|
|
NUMANode L#6 = local memory #0 of PU L#25
|
|
type = NUMANode
|
|
...
|
|
NUMANode L#7 = local memory #1 of PU L#25
|
|
type = NUMANode
|
|
...
|
|
|
|
To show the best-bandwidth node among NUMA nodes local to a PU:
|
|
|
|
$ hwloc-info --local-memory --best-memattr bandwidth pu:25
|
|
NUMANode L#7 = local memory #1 of PU L#25
|
|
type = NUMANode
|
|
...
|
|
|
|
.
|
|
.\" **************************
|
|
.\" See also section
|
|
.\" **************************
|
|
.SH SEE ALSO
|
|
.
|
|
.ft R
|
|
hwloc(7), lstopo(1), hwloc-calc(1), hwloc-bind(1), hwloc-ps(1)
|
|
.sp
|