1HWLOC-GATHER-CPUID(1)                hwloc               HWLOC-GATHER-CPUID(1)
2
3
4

NAME

6       hwloc-gather-cpuid  -  Dumps  the  relevant  x86 cpuid values for later
7       (possibly offline) usage
8

SYNOPSIS

10       hwloc-gather-cpuid [options] [<outdir>]
11

OPTIONS

13       -c <idx>
14              Only gather cpuid values for logical processor whose OS/physical
15              index is <idx>.
16
17       -s --silent
18              Do not show verbose messages.
19
20       --version
21              Report version and exit.
22
23       -h --help
24              Display help message and exit.
25

DESCRIPTION

27       hwloc-gather-cpuid  dumps all the relevant x86 cpuid values into subdi‐
28       rectory cpuid of current directory, or in <outdir> if specified.
29
30       These files can be used later to explore the machine topology  offline,
31       for  instance  by  setting the environment variable HWLOC_CPUID_PATH to
32       the directory containing all output files, and by forcing the x86 back‐
33       end with HWLOC_COMPONENTS=x86,stop.
34
35       The directory contents may also be submitted to hwloc developers to de‐
36       bug issues remotely.
37
38       If - is used as <outdir>, the output is dumped to the standard  output,
39       but a unique logical processor must have been given with -c.
40
41       hwloc-gather-cpuid  is  a x86 specific tool, it cannot be used on other
42       platforms.
43
44       NOTE: hwloc-gather-cpuid gathers many hardware details about the  plat‐
45       form.   Output  files  should not be posted on public lists or websites
46       unless it is clear that they contain no sensitive information.
47
48       NOTE: The output of hwloc-gather-cpuid is included in the tarball saved
49       by hwloc-gather-topology on Linux/x86.
50
51       NOTE: It is highly recommended that you read the hwloc(7) overview page
52       before reading this man page.
53

EXAMPLES

55       To store cpuid information of all logical processors of the current ma‐
56       chine:
57
58               $ hwloc-gather-cpuid
59               Gathering in directory ./cpuid ...
60               Gathering CPUID of PU P#0 in path ./hwloc-x86-cpuid/pu0 ...
61               Gathering CPUID of PU P#1 in path ./hwloc-x86-cpuid/pu1 ...
62               Gathering CPUID of PU P#2 in path ./hwloc-x86-cpuid/pu2 ...
63               Gathering CPUID of PU P#3 in path ./hwloc-x86-cpuid/pu3 ...
64               Summary written to ./cpuid/hwloc-cpuid-info
65

RETURN VALUE

67       Upon  successful  execution, hwloc-gather-cpuid will exit with the code
68       0.
69
70       hwloc-gather-cpuid will return nonzero exit status if any kind of error
71       occurs,  such  as  (but  not  limited  to) failure to create the output
72       files.
73

SEE ALSO

75       hwloc(7), hwloc-gather-topology(1), lstopo(1)
76
77
78
79
802.5.0                            Jun 14, 2021            HWLOC-GATHER-CPUID(1)
Impressum