1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
# PowerTOP
PowerTOP is a Linux* tool used to diagnose issues with power consumption and
power management. In addition to being a diagnostic tool, PowerTOP also has an
interactive mode you can use to experiment with various power management
settings, for cases where the Linux distribution has not enabled those
settings.
# Build dependencies
PowerTOP is coded in C++. It was written for Linux-based operating systems.
GNU* libc (`glibc`) and Linux `pthreads` are needed for PowerTOP to function
properly. The GNU build system (`autoconf`, `automake`, `make`, `libtool`), as
well as `gettext`, are required to build PowerTOP.
In addition, PowerTOP requires the following:
* kernel version => 2.6.38
* `ncurses-devel` (required)
* `libnl-devel` (required)
* `pciutils-devel` (is only required if you have PCI)
* `autoconf-archive` (for building)
Example packages to install in Ubuntu*:
sudo apt install libpci-dev libnl-3-dev libnl-genl-3-dev gettext \
libgettextpo-dev autopoint gettext libncurses5-dev libncursesw5-dev libtool-bin \
dh-autoreconf autoconf-archive pkg-config
## Building PowerTOP
The `autogen.sh` script needs to be run only once to generate `configure`.
You need to re-run it only if the build system configuration files
(e.g. `configure.ac`) are modified. The remaining steps are required whenever
source files are modified.
To build PowerTOP from the cloned source, use the following commands:
./autogen.sh
./configure
make
# Running PowerTOP
The following sections go over basic operation of PowerTOP. This includes
kernel configuration options (or kernel patches) needed for full functionality.
Run `powertop --help` to see all options.
## Kernel parameters and (optional) patches
PowerTOP needs some kernel config options enabled to function
properly. As of linux-3.3.0, these are (the list probably is incomplete):
CONFIG_NO_HZ
CONFIG_HIGH_RES_TIMERS
CONFIG_HPET_TIMER
CONFIG_CPU_FREQ_GOV_ONDEMAND
CONFIG_USB_SUSPEND
CONFIG_SND_AC97_POWER_SAVE
CONFIG_TIMER_STATS
CONFIG_PERF_EVENTS
CONFIG_PERF_COUNTERS
CONFIG_TRACEPOINTS
CONFIG_TRACING
CONFIG_EVENT_POWER_TRACING_DEPRECATED
CONFIG_X86_MSR
ACPI_PROCFS_POWER
CONFIG_DEBUG_FS
Use these configs from linux-3.13.rc1:
CONFIG_POWERCAP
CONFIG_INTEL_RAPL
The patches in the `patches/` sub-directory are optional but enable *full*
PowerTOP functionality.
## Outputting a report
When PowerTOP is executed as root and without arguments, it runs in
interactive mode. In this mode, PowerTOP most resembles `top`.
For generating reports, or for filing functional bug reports, there are two
output modes: CSV and HTML. You can set sample times, the number of iterations,
a workload over which to run PowerTOP, and whether to include
`debug`-level output.
For an HTML report, execute PowerTOP with this option:
powertop --html=report.html
This creates a static `report.html` file, suitable for sharing.
For a CSV report, execute PowerTOP with this option:
powertop --csv=report.csv
This creates a static `powertop.csv` file, also suitable for sharing.
If you wish to file a functional bug report, generate and share a
`debug`-mode HTML report and share it, using the following command:
powertop --debug --html=report.html
**Important Note:** As PowerTOP is intended for privileged (`root`) use, your
reports-- especially when run with `--debug`-- will contain verbose system
information. PowerTOP **does not** sanitize, scrub, or otherwise anonymize its
reports. Be mindful of this when sharing reports.
**Developers:** If you make changes to the HTML reporting code, validate HTML
output by using the W3C* Markup Validation Service and the W3C CSS Validation
Service:
* http://validator.w3.org/#validate_by_upload
* http://jigsaw.w3.org/css-validator/#validate_by_upload
## Calibrating and power numbers
PowerTOP, when running on battery, tracks power consumption and activity on
the system. Once there are sufficient measurements, PowerTOP can start to
report power estimates for various activities. You can help increase the
accuracy of the estimation by running a calibration cycle at least once:
powertop --calibrate
*Calibration* entails cycling through various display brightness levels
(including "off"), USB device activities, and other workloads.
## Extech Power Analyzer / Datalogger support
Our analysis teams use the Extech* Power Analyzer/Datalogger (model
number 380803). PowerTOP supports this device over the serial cable by passing
the device node on the command line using this command:
powertop --extech=/dev/ttyUSB0
(where ttyUSB0 is the devicenode of the serial-to-usb adapter on our system)
# Contributing to PowerTOP and getting support
There are numerous ways you and your friends can contribute to PowerTOP. See
the `CONTRIBUTE.md` document for more details. Elevator summary: "fork, and
send PRs!".
We have a mailing list: `powertop@lists.01.org`:
* Subscribe at:
* https://lists.01.org/postorius/lists/powertop.lists.01.org/
* Browse archives at:
* https://lists.01.org/hyperkitty/list/powertop@lists.01.org/
If you find bugs, you can file an issue-- see `CONTRIBUTE.md` for further
details:
* File bugs/wishes at:
* https://github.com/fenrus75/powertop/issues
# Code from other open source projects
PowerTOP contains some code from other open source projects; we'd like to thank
the authors of those projects for their work. Specifically, PowerTOP contains
code from
```
Parse Event Library - Copyright 2009, 2010 Red Hat Inc Steven Rostedt <srostedt@redhat.com>
nl80211 userspace tool - Copyright 2007, 2008 Johannes Berg <johannes@sipsolutions.net>
```
# Copyright and License
PowerTOP
Copyright (C) 2020 Intel Corporation
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
See `COPYING` file for a copy of the aforementioned (GPLv2) license.
## SPDX Tag
/* SPDX-License-Identifier: GPL-2.0-only */
From: https://spdx.org/licenses/GPL-2.0-only.html
|
