1HWLOC-INFO(1) hwloc HWLOC-INFO(1)
2
6 hwloc-info - Show some information about some objects or about a topol‐
7 ogy or about support features
8
10 hwloc-info [ options ]... <object>...
11 hwloc-info [ options ]...
13 Note that hwloc(7) provides a detailed explanation of the hwloc system
15 and of valid <object> formats; it should be read before reading this
16 man page.
17
19 --objects
20 Report information specific objects. This is the default if
21 some objects are given on the command-line.
22 --topology
24 Report a summary of the topology instead of about some specific
25 objects. This is the default if no object is given on the com‐
26 mand-line.
27 --support
29 Report the features that are supported by hwloc on the topology.
30 The features are those available through the hwloc_topol‐
31 ogy_get_support() function. This is useful for verifying which
32 CPU or memory binding options are supported by the current hwloc
33 installation.
34 -i <file>, --input <file>
36 Read topology from XML file <file> (instead of discovering the
37 topology on the local machine). If <file> is "-", the standard
38 input is used. XML support must have been compiled in to hwloc
39 for this option to be usable.
40 -i <directory>, --input <directory>
42 Read topology from <directory> instead of discovering the topol‐
43 ogy of the local machine. On Linux, the directory may contain
44 the topology files gathered from another machine topology with
45 hwloc-gather-topology. On x86, the directory may contain a
46 cpuid dump gathered with hwloc-gather-cpuid.
47 -i <specification>, --input <specification>
49 Simulate a fake hierarchy (instead of discovering the topology
50 on the local machine). If <specification> is "node:2 pu:3", the
51 topology will contain two NUMA nodes with 3 processing units in
52 each of them. The <specification> string must end with a number
53 of PUs.
54 --if <format>, --input-format <format>
56 Enforce the input in the given format, among xml, fsroot, cpuid
57 and synthetic.
58 -v --verbose
60 Include additional detail.
61 -s --silent
63 Reduce the amount of details to show. A single summary line per
64 object is displayed.
65 --ancestors
67 Display information about the object as well as about all its
68 ancestors up to the root of the topology.
69 --ancestor <type>
71 Only display the object ancestors that match the given type.
72 --children
74 Display information about the object children.
75 --descendants <type>
77 Display information about the object descendants that match the
78 given type.
79 -n When outputting object information, prefix each line with the
81 index of the considered object within the input. For instance,
82 if three cores were given in input, the output lines will be
83 prefixed with "0: ", "1: " or "2: ". If --ancestor is also
84 used, the prefix will be "X.Y: " where X is the index of the
85 considered object within the input, and Y is the parent index (0
86 for the object itself, increasing towards the root of the topol‐
87 ogy).
88 --disallowed
90 Include objects disallowed by administrative limitations.
91 --restrict <cpuset>
93 Restrict the topology to the given cpuset.
94 --restrict binding
96 Restrict the topology to the current process binding. This
97 option requires the use of the actual current machine topology
98 (or any other topology with --thissystem or with HWLOC_THISSYS‐
99 TEM set to 1 in the environment).
100 --filter <type>:<kind>, --filter <type>
102 Filter objects of type <type>, or of any type if <type> is
103 "all". "io", "cache" and "icache" are also supported.
104 <kind> specifies the filtering behavior. If "none" or not spec‐
106 ified, all objects of the given type are removed. If "all", all
107 objects are kept as usual. If "structure", objects are kept
108 when they bring structure to the topology. If "important" (only
109 applicable to I/O and Misc), only important objects are kept.
110 See hwloc_topology_set_type_filter() for more details.
111 --no-icaches
113 Do not show Instruction caches, only Data and Unified caches are
114 considered. This is identical to --filter icache:none.
115 --no-io
117 Do not show any I/O device or bridge. This is identical to
118 --filter io:none. By default, common devices (GPUs, NICs, block
119 devices, ...) and interesting bridges are shown.
120 --no-bridges
122 Do not show any I/O bridge except hostbridges. This is identi‐
123 cal to --filter bridge:none. By default, common devices (GPUs,
124 NICs, block devices, ...) and interesting bridges are shown.
125 --whole-io
127 Show all I/O devices and bridges. This is identical to --filter
128 io:all. By default, only common devices (GPUs, NICs, block
129 devices, ...) and interesting bridges are shown.
130 --thissystem
132 Assume that the selected backend provides the topology for the
133 system on which we are running. This is useful when using
134 --restrict binding and loading a custom topology such as an XML
135 file.
136 --pid <pid>
138 Detect topology as seen by process <pid>, i.e. as if process
139 <pid> did the discovery itself. Note that this can for instance
140 change the set of allowed processors. Also show this process
141 current CPU binding by marking the corresponding PUs (in Green
142 in the graphical output, see the COLORS section below, or by
143 appending (binding) to the verbose text output). If 0 is given
144 as pid, the current binding for the lstopo process will be
145 shown.
146 -p --physical
148 Use OS/physical indexes instead of logical indexes for input.
149 -l --logical
151 Use logical indexes instead of physical/OS indexes for input
152 (default).
153 --version
155 Report version and exit.
156 -h --help
158 Display help message and exit.
159
161 hwloc-info displays information about the specified object. It is
162 intended to be used with tools such as grep for filtering certain
163 attribute lines. When no object is specified, or when --topology is
164 passed, hwloc-info prints a summary of the topology. When --support is
165 passed, hwloc-info lists the supported features for the topology.
166 Objects may be specified as location tuples, as explained in hwloc(7).
168 However hexadecimal bitmasks are not accepted since they may correspond
169 to multiple objects.
170 NOTE: It is highly recommended that you read the hwloc(7) overview page
172 before reading this man page. Most of the concepts described in
173 hwloc(7) directly apply to the hwloc-calc utility.
174
176 To display information about each package:
177 $ hwloc-info package:all
179 Package L#0
180 logical index = 0
181 ...
182 To display information about the core whose physical index is 2:
184 $ utils/hwloc-info -p core:2
186 Core L#1
187 logical index = 1
188 os index = 2
189 ...
190
192 hwloc(7), lstopo(1), hwloc-calc(1), hwloc-bind(1), hwloc-ps(1)
1932.2.0 Mar 30, 2020 HWLOC-INFO(1)