1 .TH THERMOMETER 8 1 .TH THERMOMETER 8
2 # SPDX-License-Identifier: GPL-2.0 2 # SPDX-License-Identifier: GPL-2.0
3 .SH NAME 3 .SH NAME
4 \fBthermometer\fP - A thermal profiling tool 4 \fBthermometer\fP - A thermal profiling tool
5 5
6 .SH SYNOPSIS 6 .SH SYNOPSIS
7 .ft B 7 .ft B
8 .B thermometer 8 .B thermometer
9 .RB [ options ] 9 .RB [ options ]
10 .RB [ command ] 10 .RB [ command ]
11 .br 11 .br
12 .SH DESCRIPTION 12 .SH DESCRIPTION
13 \fBthermometer \fP captures the thermal zones 13 \fBthermometer \fP captures the thermal zones temperature at a
14 specified sampling period. It is optimized to 14 specified sampling period. It is optimized to reduce as much as
15 possible the overhead while doing the temperat 15 possible the overhead while doing the temperature acquisition in order
16 to prevent disrupting the running application 16 to prevent disrupting the running application we may want to profile.
17 17
18 This low overhead also allows a high rate samp 18 This low overhead also allows a high rate sampling for the temperature
19 which could be necessary to spot overshots and 19 which could be necessary to spot overshots and undershots.
20 20
21 If no configuration file is specified, then al 21 If no configuration file is specified, then all the thermal zones will
22 be monitored at 4Hz, so every 250ms. A configu 22 be monitored at 4Hz, so every 250ms. A configuration file specifies
23 the thermal zone names and the desired samplin 23 the thermal zone names and the desired sampling period. A thermal zone
24 name can be a regular expression to specify a 24 name can be a regular expression to specify a group of thermal zone.
25 25
26 The sampling of the different thermal zones wi 26 The sampling of the different thermal zones will be written into
27 separate files with the thermal zone name. It 27 separate files with the thermal zone name. It is possible to specify a
28 postfix to identify them for example for a spe 28 postfix to identify them for example for a specific scenario. The
29 output directory can be specified in addition. 29 output directory can be specified in addition.
30 30
31 Without any parameters, \fBthermometer \fP cap 31 Without any parameters, \fBthermometer \fP captures all the thermal
32 zone temperatures every 250ms and write to the 32 zone temperatures every 250ms and write to the current directory the
33 captured files postfixed with the current date 33 captured files postfixed with the current date.
34 34
35 If a running \fBduration\fP is specified or a 35 If a running \fBduration\fP is specified or a \fBcommand\fP, the
36 capture ends at the end of the duration if the 36 capture ends at the end of the duration if the command did not
37 finished before. The \fBduration\fP can be spe 37 finished before. The \fBduration\fP can be specified alone as well as
38 the \fBcommand\fP. If none is specified, the c 38 the \fBcommand\fP. If none is specified, the capture will continue
39 indefinitively until interrupted by \fBSIGINT\ 39 indefinitively until interrupted by \fBSIGINT\fP or \fBSIGQUIT\fP.
40 .PP 40 .PP
41 41
42 .SS Options 42 .SS Options
43 .PP 43 .PP
44 The \fB-h, --help\fP option shows a short usag 44 The \fB-h, --help\fP option shows a short usage help
45 .PP 45 .PP
46 The \fB-o <dir>, --output <dir>\fP option defi 46 The \fB-o <dir>, --output <dir>\fP option defines the output directory to put the
47 sampling files 47 sampling files
48 .PP 48 .PP
49 The \fB-c <config>, --config <config>\fP optio 49 The \fB-c <config>, --config <config>\fP option specifies the configuration file to use
50 .PP 50 .PP
51 The \fB-d <seconds>, --duration <seconds>\fP o 51 The \fB-d <seconds>, --duration <seconds>\fP option specifies the duration of the capture
52 .PP 52 .PP
53 The \fB-l <loglevel>, --loglevel <loglevel>\fP 53 The \fB-l <loglevel>, --loglevel <loglevel>\fP option sets the loglevel [DEBUG,INFO,NOTICE,WARN,ERROR]
54 .PP 54 .PP
55 The \fB-p <string>, --postfix <string>\fP opti 55 The \fB-p <string>, --postfix <string>\fP option appends \fBstring\fP at the end of the capture filenames
56 .PP 56 .PP
57 The \fB-s, --syslog\fP option sets the output 57 The \fB-s, --syslog\fP option sets the output to syslog, default is \fBstdout\fP
58 .PP 58 .PP
59 The \fB-w, --overwrite\fP overwrites the outpu 59 The \fB-w, --overwrite\fP overwrites the output files if they exist
60 .PP 60 .PP
61 61
62 .PP 62 .PP
63 63
64 .SS "Exit status:" 64 .SS "Exit status:"
65 .TP 65 .TP
66 0 66 0
67 if OK, 67 if OK,
68 .TP 68 .TP
69 1 69 1
70 Error with the options specified as parameters 70 Error with the options specified as parameters
71 .TP 71 .TP
72 2 72 2
73 Error when configuring the logging facility 73 Error when configuring the logging facility
74 .TP 74 .TP
75 3 75 3
76 Error when configuring the time 76 Error when configuring the time
77 .TP 77 .TP
78 4 78 4
79 Error in the initialization routine 79 Error in the initialization routine
80 .TP 80 .TP
81 5 81 5
82 Error during the runtime 82 Error during the runtime
83 83
84 .SH Capture file format 84 .SH Capture file format
85 85
86 Every file contains two columns. The first one 86 Every file contains two columns. The first one is the uptime timestamp
87 in order to find a point in time since the sys 87 in order to find a point in time since the system started up if there
88 is any thermal event. The second one is the te 88 is any thermal event. The second one is the temperature in milli
89 degree. The first line contains the label of e 89 degree. The first line contains the label of each column.
90 90
91 .SH AUTHOR 91 .SH AUTHOR
92 Daniel Lezcano <daniel.lezcano@kernel.org> 92 Daniel Lezcano <daniel.lezcano@kernel.org>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.