pepc-power - Man Page

-h

Show a short help message and exit.

-q

Be quiet.

-d

Print debugging information.

--version

Print version and exit.

-H HOSTNAME, --host HOSTNAME

Name of the host to run the command on.

-U USERNAME, --username USERNAME

Name of the user to use for logging into the remote host over SSH. The default user name is 'root'.

-K PRIVKEY, --priv-key PRIVKEY

Path to the private SSH key that should be used for logging into the remote host. By default the key is automatically found from standard paths like '$HOME/.ssh'.

-T TIMEOUT, --timeout TIMEOUT

SSH connection timeout in seconds, default is 8.

-D DATASET, --dataset DATASET

This option is for debugging and testing purposes only, it defines the dataset that will be used to emulate a host for running the command on. This option is typically used when running 'pepc' from the source code directory, which includes datasets for many different systems.

The argument can be the dataset path, 'all' to specify all available dataset or name in which case the following locations will be searched for.

1. './tests/data', in the directory of the running program
2. '$PEPC_DATA_PATH/tests/data'
3. '$HOME/.local/share/pepc/tests/data'
4. '/usr/local/share/pepc/tests/data'
5. '/usr/share/pepc/tests/data'

--force-color

Force coloring of the text output.

Get information about power on specified CPUs. By default, prints all information for all CPUs.

--cpus CPUS

List of CPUs to get information about. The list can include individual CPU numbers and CPU number ranges. For example,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to 12. Use the special keyword 'all' to specify all CPUs.

--cores CORES

List of cores to get information about. The list can include individual core numbers and core number ranges. For example, '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and 10 to 1. Use the special keyword 'all' to specify all cores. This option has to be accompanied by '--package' option, because core numbers are per-package

--packages PACKAGES

List of packages to get information about. The list can include individual package numbers and package number ranges. For example, '0,2-4' would mean package 0 and packages 2 to 4. Use the special keyword 'all' to specify all packages.

--core-siblings CORE_SIBLINGS

List of core sibling indices to get information about. The list can include individual core sibling indices or index ranges. For example, core x includes CPUs 3 and 4, '0' would mean CPU 3 and '1' would mean CPU 4. This option can only be used to reference online CPUs, because Linux does not provide topology information for offline CPUs. In the previous example if CPU 3 was offline, then '0' would mean CPU 4.

--yaml

Print information in YAML format.

--tdp

Get CPU package thermal design power (details in 'tdp')

--ppl1

Get RAPL package power limit #1 value via MSR (details in 'ppl1').

--ppl1-enable

Get RAPL package power limit #1 enable status via MSR (details in 'ppl1_enable').

--ppl1-clamp

Get RAPL package power limit #1 clamping enable status via MSR (details in 'ppl1_clamp')

--ppl1-window

Get RAPL package power limit #1 window size via MSR (details in 'ppl1_window').

--ppl2

Get RAPL package power limit #2 value via MSR (details in 'ppl2').

--ppl2-enable

Get RAPL package power limit #2 enable status via MSR (details in 'ppl2_enable').

--ppl2-clamp

Get RAPL package power limit #2 clamping enable status via MSR (details in 'ppl2_clamp')

--ppl2-window

Get RAPL package power limit #2 window size via MSR (details in 'ppl2_window').

Configure power on specified CPUs. All options can be used without a parameter, in which case the currently configured value(s) will be printed.

--cpus CPUS

List of CPUs to configure power on. The list can include individual CPU numbers and CPU number ranges. For example,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to 12. Use the special keyword 'all' to specify all CPUs.

--cores CORES

List of cores to configure power on. The list can include individual core numbers and core number ranges. For example, '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and 10 to 12. Use the special keyword 'all' to specify all cores. This option has to be accompanied by '--package' option, because core numbers are per-package

--packages PACKAGES

List of packages to configure power on. The list can include individual package numbers and package number ranges. For example, '0,2-4' would mean package 0 and packages 2 to 4. Use the special keyword 'all' to specify all packages.

--core-siblings CORE_SIBLINGS

List of core sibling indices to configure power on. The list can include individual core sibling indices or index ranges. For example, core x includes CPUs 3 and 4, '0' would mean CPU 3 and '1' would mean CPU 4. This option can only be used to reference online CPUs, because Linux does not provide topology information for offline CPUs. In the previous example if CPU 3 was offline, then '0' would mean CPU 4.

--ppl1

Set RAPL package power limit #1 value via MSR (details in 'ppl1').

--ppl1-enable

Enable or disable RAPL package power limit #1 via MSR (details in 'ppl1_enable').

--ppl1-clamp

Enable or disable RAPL package power limit #1 clamping via MSR (details in 'ppl1_clamp')

--ppl2

Set RAPL package power limit #2 value via MSR (details in 'ppl2').

--ppl2-enable

Enable or disable RAPL package power limit #2 via MSR (details in 'ppl2_enable').

--ppl2-clamp

Enable or disable RAPL package power limit #2 clamping via MSR (details in 'ppl2_clamp')

Save all the modifiable power settings into a file. This file can later be used for restoring power settings with the 'pepc power restore' command.

--cpus CPUS

List of CPUs to save power information about. The list can include individual CPU numbers and CPU number ranges. For example,'1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to 12. Use the special keyword 'all' to specify all CPUs.

--cores CORES

List of cores to save power information about. The list can include individual core numbers and core number ranges. For example, '1-4,7,8,10-12' would mean cores 1 to 4, cores 7, 8, and 10 to 12. Use the special keyword 'all' to specify all cores. This option has to be accompanied by '--package' option, because core numbers are per-package

--packages PACKAGES

List of packages to save power information about. The list can include individual package numbers and package number ranges. For example, '0,2-4' would mean package 0 and packages 2 to 4. Use the special keyword 'all' to specify all packages.

--core-siblings CORE_SIBLINGS

List of core sibling indices to save power information about. The list can include individual core sibling indices or index ranges. For example, core x includes CPUs 3 and 4, '0' would mean CPU 3 and '1' would mean CPU 4. This option can only be used to reference online CPUs, because Linux does not provide topology information for offline CPUs. In the previous example if CPU 3 was offline, then '0' would mean CPU 4.

-o OUTFILE, --outfile OUTFILE

Name of the file to save the settings to.

Restore power settings from a file previously created with the 'pepc power save' command.

-f INFILE, --from INFILE

Name of the file restore the settings from (use "-" to read from the standard output.

  *   *   *   *   *

tdp - CPU package thermal design power

pepc power info [--tdp]

CPU package thermal design power in Watts.

MSR_PKG_POWER_INFO (0x614), bits 14:0.

This option has package scope.

  *   *   *   *   *

ppl1 - RAPL package power limit #1 value in Watts

pepc power info [--ppl1]

pepc power config [--ppl1=<value>]

Average power usage limit of the package domain corresponding to time window #1.

MSR_PKG_POWER_LIMIT (0x610), bits 14:0.

This option has package scope.

  *   *   *   *   *

ppl1_enable - Enable or disable RAPL package power limit #1

pepc power info [--ppl1-enable]

pepc power config [--ppl1-enable=<value>]

Enable or disable RAPL package power limit #1.

MSR_PKG_POWER_LIMIT (0x610), bit 15.

This option has package scope.

  *   *   *   *   *

ppl1_clamp - Enable or disable package power clamping for limit #1

pepc power info [--ppl1-clamp]

pepc power config [--ppl1-clamp=<value>]

Enable or disable package power clamping for limit #1.

MSR_PKG_POWER_LIMIT (0x610), bit 16.

This option has package scope.

  *   *   *   *   *

ppl1_window - RAPL package power limit #1 window size in seconds

pepc power info [--ppl1-window]

RAPL package power limit #1 window size in seconds.

MSR_PKG_POWER_LIMIT (0x610), bit 23:17.

This option has package scope.

  *   *   *   *   *

ppl2 - RAPL package power limit #2 value in Watts

pepc power info [--ppl2]

pepc power config [--ppl2=<value>]

Average power usage limit of the package domain corresponding to time window #2.

MSR_PKG_POWER_LIMIT (0x610), bits 46:32.

This option has package scope.

  *   *   *   *   *

ppl2_enable - Enable or disable RAPL package power limit #2

pepc power info [--ppl2-enable]

pepc power config [--ppl2-enable=<value>]

Enable or disable RAPL package power limit #2.

MSR_PKG_POWER_LIMIT (0x610), bit 47.

This option has package scope.

  *   *   *   *   *

ppl2_clamp - Enable or disable package power clamping for limit #2

pepc power info [--ppl2-clamp]

pepc power config [--ppl2-clamp=<value>]

Enable or disable package power clamping for limit #2.

MSR_PKG_POWER_LIMIT (0x610), bit 48.

This option has package scope.

  *   *   *   *   *

ppl2_window - RAPL package power limit #2 window size in seconds

pepc power info [--ppl2-window]

RAPL package power limit #2 window size in seconds.

MSR_PKG_POWER_LIMIT (0x610), bit 55:49.

This option has package scope.