bionic (1) powercap-info.1.gz

NAME

       powercap-info - get information from the Linux power capping framework

SYNPOSIS

       powercap-info -p NAME [OPTION]...

DESCRIPTION

       Prints configurations for a powercap control type.

OPTIONS

       -h, --help
              Prints the help screen

       -v, --verbose
              Print errors when files are not available

       -p, --control-type=NAME
              [REQUIRED] The powercap control type name.  Must not be empty or contain a '.' or '/'.

       -z, --zone=ZONE(S)
              The  zone/subzone  numbers  in  the control type's powercap tree (control type's root by default).
              Separate zones/subzones with a colon.  E.g., for zone 0, subzone 2:
              -z 0:2
              Ending with a colon prevents output for subzones.  E.g., for zone 0, but not subzones:
              -z 0:

       -c, --constraint=CONSTRAINT
              The constraint number

       All remaining options below are mutually exclusive:

       -n, --nzones
              Print the number of zones (control type's root by default; within the -z/--zone level, if set)

       The following are zone-level arguments and require -z/--zone:

       -j, --z-energy
              Print zone energy counter

       -J, --z-max-energy-range
              Print zone maximum energy counter range

       -w, --z-power
              Print zone current power

       -W, --z-max-power-range
              Print zone maximum current power range

       -e, --z-enabled
              Print zone enable/disabled status

       -x, --z-name
              Print zone name

       The following are constraint-level arguments and require -z/--zone and -c/--constraint:

       -l, --c-power-limit
              Print constraint power limit

       -s, --c-time-window
              Print constraint time window

       -U, --c-max-power
              Print constraint maximum allowed power

       -u, --c-min-power
              Print constraint minimum allowed power

       -T, --c-max-time-window
              Print constraint maximum allowed time window

       -t, --c-min-time-window
              Print constraint minimum allowed time window

       -y, --c-name
              Print constraint name

EXAMPLES

       These examples use Intel RAPL, for which the control type is intel-rapl.

       powercap-info -p intel-rapl
              Print all RAPL zones.

       powercap-info -p intel-rapl -z 0
              Print only zone 0, which is usually named package-0.

       powercap-info -p intel-rapl -z 0:1
              Print zone 0, subzone 1, which is usually the uncore or dram subzone of  package-0,  depending  on
              the system.

       powercap-info -p intel-rapl -z 0 -c 1
              Print zone 0, constraint 1, which is usually the short_term constraint for package-0.

       powercap-info -p intel-rapl -z 0 -j
              Print the energy counter for zone 0, which is usually named package-0.

       powercap-info -p intel-rapl -z 1:0 -c 0 -l
              Print  the  power  limit  for  zone  1,  subzone  0,  constraint 0, which is usually the long_term
              constraint for the core subzone of package-1 (a multi-socket system).

REMARKS

       Some fields are optional and will only be printed if they are available unless -v/--verbose is set.
       If no subzone/constraint-specific outputs are requested, all available  zones  and  constraints  will  be
       shown.

       Energy units: microjoules (uJ)
       Power units: microwatts (uW)
       Time units: microseconds (us)

BUGS

       Report bugs upstream at <https://github.com/powercap/powercap>

FILES

       /sys/devices/virtual/powercap/*
       /sys/class/powercap/*

AUTHORS

       Connor Imes <connor.k.imes@gmail.com>

SEE ALSO

       powercap-set(1), rapl-info(1), rapl-set(1)