1HWLOC-GATHER-TOPOLOGY(1) hwloc HWLOC-GATHER-TOPOLOGY(1)
2
6 hwloc-gather-topology - Saves the relevant Linux topology files and the
7 lstopo textual and XML outputs for later (possibly offline) usage
8
10 hwloc-gather-topology [options] <path>
11
13 --io Also gather I/O related files. The gathering may be much
14 slower, and the generated archive may be much bigger. --dmi
15 Also gather DMI/SMBIOS related files. The gathering requires
16 root access, and the dmi-sysfs kernel module should be loaded.
17 -h --help
19 Display help message and exit
20
22 hwloc-gather-topology saves all the relevant topology files into an ar‐
23 chive (<path>.tar.bz2), the lstopo output (<path>.output), and the
24 lstopo XML (<path>.xml). The utility for example stores the
25 /proc/cpuinfo file and the entire /sys/devices/system/node/ directory
26 tree.
27 These files can be used later to explore the machine topology offline.
29 Once the tarball has been extracted, it may for instance be given to
30 some hwloc command-line utilities through their --input option. It is
31 also possible to override the default topology that the hwloc library
32 will read by setting the extracted path in the HWLOC_FSROOT environment
33 variable.
34 The archive and the lstopo textual and XML outputs may also be submit‐
36 ted to hwloc developers to debug issues remotely.
37 hwloc-gather-topology is a Linux specific tool, it is not installed on
39 other operating systems.
40 NOTE: hwloc-gather-topology gathers many hardware details about the
42 platform. The outputs and tarball should not be posted on public lists
43 or websites unless it is clear that they contain no sensitive informa‐
44 tion.
45 NOTE: It is highly recommended that you read the hwloc(7) overview page
47 before reading this man page.
48
50 To store topology information to be used later (possibly on a different
51 host) please run:
52 hwloc-gather-topology /tmp/myhost
54 It will store all relevant topology files in the /tmp/myhost.tar.bz2
56 archive, the lstopo output in the /tmp/myhost.output file, and the
57 lstopo XML in the /tmp/myhost.xml file. These files can be transferred
58 on another host for later/offline analysis and/or as the input to vari‐
59 ous hwloc utilities.
60 To use these data with hwloc utilities you have to unpack
62 myhost.tar.bz2 archive first:
63 tar jxvf /tmp/myhost.tar.bz2
65 A new directory named myhost now contains all topology files. Then you
67 ask various hwloc utilities to use this topology instead of the one of
68 the real machine by passing --input myhost. To display the topology
69 just run:
70 lstopo --input ./myhost
72 It is not necessary that the topology is extracted in the current
74 directory, absolute or relative paths are also supported:
75 lstopo --input /path/to/remote/host/extracted/topology/
77 To see how hwloc would distribute 8 parallel jobs on the original host:
79 hwloc-distrib --input myhost --single 8
81 To get the corresponding physical indexes in the previous command:
83 hwloc-calc --input myhost --po --li --proclist $(hwloc-distrib
85 --input myhost --single 8)
86 Any program may actually override the default topology with a given
88 archived one even if it does not have a --input option. The
89 HWLOC_FSROOT environment variable should be used to do so:
90 HWLOC_FSROOT=myhost hwloc-calc --po --li --proclist $(hwloc-dis‐
92 trib --single 8)
93 All these commands will produce the same output as if executed directly
95 on the host on which the topology information was originally gathered
96 by the hwloc-gather-topology script.
97
99 Upon successful execution, hwloc-gather-topology will exit with the
100 code 0.
101 hwloc-gather-topology will return nonzero exit status if any kind of
103 error occurs, such as (but not limited to) failure to create the ar‐
104 chive or output files.
105
107 hwloc(7), lstopo(1), hwloc-calc(1), hwloc-distrib(1)
1081.11.9 Jan 18, 2018 HWLOC-GATHER-TOPOLOGY(1)