pepc-power(1)

1POWER()                                                                POWER()
2
3
4

Command 'power'

6   General options
7       -h     Show a short help message and exit.
8
9       -q     Be quiet.
10
11       -d     Print debugging information.
12
13       --version
14              Print version and exit.
15
16       -H HOSTNAME, --host HOSTNAME
17              Name of the host to run the command on.
18
19       -U USERNAME, --username USERNAME
20              Name  of  the  user to use for logging into the remote host over
21              SSH.  The default user name is 'root'.
22
23       -K PRIVKEY, --priv-key PRIVKEY
24              Path to the private SSH key that should be used for logging into
25              the remote host.  By default the key is automatically found from
26              standard paths like '$HOME/.ssh'.
27
28       -T TIMEOUT, --timeout TIMEOUT
29              SSH connection timeout in seconds, default is 8.
30
31       -D DATASET, --dataset DATASET
32              This option is for debugging and testing purposes only,  it  de‐
33              fines  the  dataset that will be used to emulate a host for run‐
34              ning the command on.  This option is typically used when running
35              'pepc'  from  the  source directory, which includes datasets for
36              many different systems.
37
38              The argument can be the  dataset  path,  'all'  to  specify  all
39              available  dataset or name in which case the following locations
40              will be searched for.
41
42              1. './tests/data', in the directory of the running program
43
44              2. '$PEPC_DATA_PATH/tests/data'
45
46              3. '$HOME/.local/share/pepc/tests/data'
47
48              4. '/usr/local/share/pepc/tests/data'
49
50              5. '/usr/share/pepc/tests/data'
51
52       --force-color
53              Force coloring of the text output.
54
55   Subcommand 'info'
56       Get information about power on specified CPUs.  By default, prints  all
57       information for all CPUs.
58
59       --cpus CPUS
60              List of CPUs to get information about.  The list can include in‐
61              dividual  CPU  numbers  and  CPU  number  ranges.    For   exam‐
62              ple,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to
63              12.  Use the special keyword 'all' to specify all CPUs.
64
65       --cores CORES
66              List of cores to get information about.  The  list  can  include
67              individual  core  numbers  and core number ranges.  For example,
68              '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and  10  to
69              1.   Use  the  special keyword 'all' to specify all cores.  This
70              option has to be accompanied by '--package' option, because core
71              numbers are per-package
72
73       --packages PACKAGES
74              List of packages to get information about.  The list can include
75              individual package numbers and package number ranges.  For exam‐
76              ple,  '0,2-4' would mean package 0 and packages 2 to 4.  Use the
77              special keyword 'all' to specify all packages.
78
79       --core-siblings CORE_SIBLINGS
80              List of core sibling indices to get information about.  The list
81              can  include  individual  core  sibling indices or index ranges.
82              For example, core x includes CPUs 3 and 4, '0' would mean CPU  3
83              and  '1' would mean CPU 4.  This option can only be used to ref‐
84              erence online CPUs, because Linux does not provide topology  in‐
85              formation  for  offline  CPUs.  In the previous example if CPU 3
86              was offline, then '0' would mean CPU 4.
87
88       --yaml Print information in YAML format.
89
90       --tdp  Get CPU package thermal design power (details in 'tdp')
91
92       --ppl1 Get RAPL package power  limit  #1  value  via  MSR  (details  in
93              'ppl1').
94
95       --ppl1-enable
96              Get  RAPL  package power limit #1 enable status via MSR (details
97              in 'ppl1_enable').
98
99       --ppl1-clamp
100              Get RAPL package power limit #1 clamping enable status  via  MSR
101              (details in 'ppl1_clamp')
102
103       --ppl1-window
104              Get  RAPL package power limit #1 window size via MSR (details in
105              'ppl1_window').
106
107       --ppl2 Get RAPL package power  limit  #2  value  via  MSR  (details  in
108              'ppl2').
109
110       --ppl2-enable
111              Get  RAPL  package power limit #2 enable status via MSR (details
112              in 'ppl2_enable').
113
114       --ppl2-clamp
115              Get RAPL package power limit #2 clamping enable status  via  MSR
116              (details in 'ppl2_clamp')
117
118       --ppl2-window
119              Get  RAPL package power limit #2 window size via MSR (details in
120              'ppl2_window').
121
122   Subcommand 'config'
123       Configure power on specified CPUs.  All options can be used  without  a
124       parameter,  in  which  case  the  currently configured value(s) will be
125       printed.
126
127       --cpus CPUS
128              List of CPUs to configure power on.  The list can include  indi‐
129              vidual   CPU   numbers   and   CPU  number  ranges.   For  exam‐
130              ple,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to
131              12.  Use the special keyword 'all' to specify all CPUs.
132
133       --cores CORES
134              List of cores to configure power on.  The list can include indi‐
135              vidual core  numbers  and  core  number  ranges.   For  example,
136              '1-4,7,8,10-12'  would  mean cores 1 to 4, cores 7, 8, and 10 to
137              12.  Use the special keyword 'all' to specify all  cores.   This
138              option has to be accompanied by '--package' option, because core
139              numbers are per-package
140
141       --packages PACKAGES
142              List of packages to configure power on.  The  list  can  include
143              individual package numbers and package number ranges.  For exam‐
144              ple, '0,2-4' would mean package 0 and packages 2 to 4.  Use  the
145              special keyword 'all' to specify all packages.
146
147       --core-siblings CORE_SIBLINGS
148              List  of  core  sibling indices to configure power on.  The list
149              can include individual core sibling  indices  or  index  ranges.
150              For  example, core x includes CPUs 3 and 4, '0' would mean CPU 3
151              and '1' would mean CPU 4.  This option can only be used to  ref‐
152              erence  online CPUs, because Linux does not provide topology in‐
153              formation for offline CPUs.  In the previous example  if  CPU  3
154              was offline, then '0' would mean CPU 4.
155
156       --ppl1 Set  RAPL  package  power  limit  #1  value  via MSR (details in
157              'ppl1').
158
159       --ppl1-enable
160              Enable or disable RAPL package power limit #1 via  MSR  (details
161              in 'ppl1_enable').
162
163       --ppl1-clamp
164              Enable  or  disable RAPL package power limit #1 clamping via MSR
165              (details in 'ppl1_clamp')
166
167       --ppl2 Set RAPL package power  limit  #2  value  via  MSR  (details  in
168              'ppl2').
169
170       --ppl2-enable
171              Enable  or  disable RAPL package power limit #2 via MSR (details
172              in 'ppl2_enable').
173
174       --ppl2-clamp
175              Enable or disable RAPL package power limit #2 clamping  via  MSR
176              (details in 'ppl2_clamp')
177
178   Subcommand 'save'
179       Save all the modifiable power settings into a file.  This file can lat‐
180       er be used for restoring power settings with the 'pepc  power  restore'
181       command.
182
183       --cpus CPUS
184              List  of CPUs to save power information about.  The list can in‐
185              clude individual CPU numbers and CPU number ranges.   For  exam‐
186              ple,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to
187              12.  Use the special keyword 'all' to specify all CPUs.
188
189       --cores CORES
190              List of cores to save power information about.  The list can in‐
191              clude individual core numbers and core number ranges.  For exam‐
192              ple, '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and 10
193              to  12.   Use  the  special  keyword 'all' to specify all cores.
194              This option has to be accompanied by '--package' option, because
195              core numbers are per-package
196
197       --packages PACKAGES
198              List  of packages to save power information about.  The list can
199              include individual package numbers and  package  number  ranges.
200              For  example,  '0,2-4' would mean package 0 and packages 2 to 4.
201              Use the special keyword 'all' to specify all packages.
202
203       --core-siblings CORE_SIBLINGS
204              List of core sibling indices to save  power  information  about.
205              The  list  can  include individual core sibling indices or index
206              ranges.  For example, core x includes CPUs 3 and  4,  '0'  would
207              mean  CPU  3  and '1' would mean CPU 4.  This option can only be
208              used to reference online CPUs, because Linux  does  not  provide
209              topology  information for offline CPUs.  In the previous example
210              if CPU 3 was offline, then '0' would mean CPU 4.
211
212       -o OUTFILE, --outfile OUTFILE
213              Name of the file to save the settings to.
214
215   Subcommand 'restore'
216       Restore power settings from a file previously created  with  the  'pepc
217       power save' command.
218
219       -f INFILE, --from INFILE
220              Name of the file restore the settings from (use "-" to read from
221              the standard output.
222
223          *   *   *   *   *
224

Properties

226   tdp
227       tdp - CPU package thermal design power
228
229   Synopsis
230       pepc power info [--tdp]
231
232   Description
233       CPU package thermal design power in Watts.
234
235   Source
236       MSR_PKG_POWER_INFO (0x614), bits 14:0.
237
238   Scope
239       This option has package scope.
240
241          *   *   *   *   *
242
243   ppl1
244       ppl1 - RAPL package power limit #1 value in Watts
245
246   Synopsis
247       pepc power info [--ppl1]
248       pepc power config [--ppl1=<value>]
249
250   Description
251       Average power usage limit of the package domain corresponding  to  time
252       window #1.
253
254   Source
255       MSR_PKG_POWER_LIMIT (0x610), bits 14:0.
256
257   Scope
258       This option has package scope.
259
260          *   *   *   *   *
261
262   ppl1_enable
263       ppl1_enable - Enable or disable RAPL package power limit #1
264
265   Synopsis
266       pepc power info [--ppl1-enable]
267       pepc power config [--ppl1-enable=<value>]
268
269   Description
270       Enable or disable RAPL package power limit #1.
271
272   Source
273       MSR_PKG_POWER_LIMIT (0x610), bit 15.
274
275   Scope
276       This option has package scope.
277
278          *   *   *   *   *
279
280   ppl1_clamp
281       ppl1_clamp - Enable or disable package power clamping for limit #1
282
283   Synopsis
284       pepc power info [--ppl1-clamp]
285       pepc power config [--ppl1-clamp=<value>]
286
287   Description
288       Enable or disable package power clamping for limit #1.
289
290   Source
291       MSR_PKG_POWER_LIMIT (0x610), bit 16.
292
293   Scope
294       This option has package scope.
295
296          *   *   *   *   *
297
298   ppl1_window
299       ppl1_window - RAPL package power limit #1 window size in seconds
300
301   Synopsis
302       pepc power info [--ppl1-window]
303
304   Description
305       RAPL package power limit #1 window size in seconds.
306
307   Source
308       MSR_PKG_POWER_LIMIT (0x610), bit 23:17.
309
310   Scope
311       This option has package scope.
312
313          *   *   *   *   *
314
315   ppl2
316       ppl2 - RAPL package power limit #2 value in Watts
317
318   Synopsis
319       pepc power info [--ppl2]
320       pepc power config [--ppl2=<value>]
321
322   Description
323       Average  power  usage limit of the package domain corresponding to time
324       window #2.
325
326   Source
327       MSR_PKG_POWER_LIMIT (0x610), bits 46:32.
328
329   Scope
330       This option has package scope.
331
332          *   *   *   *   *
333
334   ppl2_enable
335       ppl2_enable - Enable or disable RAPL package power limit #2
336
337   Synopsis
338       pepc power info [--ppl2-enable]
339       pepc power config [--ppl2-enable=<value>]
340
341   Description
342       Enable or disable RAPL package power limit #2.
343
344   Source
345       MSR_PKG_POWER_LIMIT (0x610), bit 47.
346
347   Scope
348       This option has package scope.
349
350          *   *   *   *   *
351
352   ppl2_clamp
353       ppl2_clamp - Enable or disable package power clamping for limit #2
354
355   Synopsis
356       pepc power info [--ppl2-clamp]
357       pepc power config [--ppl2-clamp=<value>]
358
359   Description
360       Enable or disable package power clamping for limit #2.
361
362   Source
363       MSR_PKG_POWER_LIMIT (0x610), bit 48.
364
365   Scope
366       This option has package scope.
367
368          *   *   *   *   *
369
370   ppl2_window
371       ppl2_window - RAPL package power limit #2 window size in seconds
372
373   Synopsis
374       pepc power info [--ppl2-window]
375
376   Description
377       RAPL package power limit #2 window size in seconds.
378
379   Source
380       MSR_PKG_POWER_LIMIT (0x610), bit 55:49.
381
382   Scope
383       This option has package scope.
384
385
386
387                                  02-05-2023                           POWER()