CPU Operations

CPU performance monitoring, profiling, and testing commands.

CPULoad

Run a CPU-Load test on the DUT.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`cpuload`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`transport`	`TransportObject`	No		Additional transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`CPULoadOptions`	No	`parameters`	`cpuload` Options

CPULoad Options

Attribute	Type	Required	Description
`args`	`[]string`	Yes	Array of `strings` with arguments passed into the `cpuload` tool.
`cpus`	`[]integer`	Yes	Array of CPUs that should be put under load.
`duration`	`string`	Yes	Duration of the load. Format: `^((\\d+h)?(\\d+m)?(\\d+s)?)?$`
`expect`	`CPUExpectOptions`	Yes	Expected values

CPULoad Example

cmd: cpuload
name: Check cpu frequencies with load
transport: *transport
options:
  timeout: 2m
parameters:
  duration: 1m
  expect:
    individual:
      - cpus: [0, 1, 2, 3, 4, 5, 6, 7]
        option: AverageFrequency
        value: ">1500"
      - cpus: [8, 9, 10, 11, 12, 13, 14, 15]
        option: AverageFrequency
        value: ">1200"

CPUSet

Set cpu profiles on the DUT.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`cpuset`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`transport`	`TransportObject`	No		Additional transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`CPUSetOptions`	Yes		Options passed into the `cpuset` cmd

CPUSet Options

Attribute	Type	Required	Description
`command`	`string`	Yes	Command to run. Available options: `core`, or `profile`.
`cores`	`[]integer`	No	Array of Cores where the command should be applied to. If not set apply to all
`arg`	`string`	Yes	Value of the command option

CPUSet Example

cmd: cpuset
name: Set ACPI Platform Profile to low-power
transport: *transport
parameters:
  command: profile
  arg: low-power

CPUStats

Monitor and validate CPU statistics on the DUT.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`cpustats`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`transport`	`TransportObject`	No		Additional transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`CPUStatsOptions`	Yes	`parameters`	`cpustats` Options

CPUStats Options

Attribute	Type	Required	Default	Description
`interval`	`string`	No		Testing interval time
`expect`	`CPUExpectOptions`	Yes		Expected values

CPU Expect Options

Attribute	Type	Required	Default	Description
`general`	`[]GeneralObject`	No	`expect`	General Expected Values
`individual`	`[]IndividualObject`	No		Individual CPU Expected Values

General Object

Values that describe the machine as a whole.

Attribute	Type	Required	Default	Description
`option`	`string`	No	`general`	Name of the option
`value`	`string`	No	`general`	Value of the option

option must be one of:

Option	Unit	Description
`CPUsLogical`	count	Logical CPUs the machine reports
`CPUsPhysical`	count	Physical cores the machine reports
`Profile`		ACPI platform profile, for example `balanced`
`CurPowerConsumption`	watts	Package power drawn during the sample
`PowerLimit1`	watts	Sustained package power limit
`PowerLimit2`	watts	Short-term package power limit

Individual Object

Values measured per core. Cores that are switched off do not appear in the sample, and naming one fails the step rather than matching a different core.

Attribute	Type	Required	Default	Description
`cpus`	`[]integer`	Yes	`individual`	Array of CPUs where the option should be applied to
`option`	`string`	Yes	`individual`	Name of the option
`value`	`string`	Yes	`individual`	Value of the option

option must be one of:

Option	Unit	Description
`Busy`	percent	Share of the sample the core spent executing
`AverageFrequency`	MHz	Mean frequency over the whole sample, idle time included
`BusyFrequency`	MHz	Mean frequency while the core was executing
`CStates`	percent	Idle-state residency, written as `C1E,C6,C10:>95`

CStates takes one or more state names separated by commas, then a colon and the bound their residencies must add up to. Every other option compares a single number.

CPUStats Example

cmd: cpustats
name: Check cpu frequencies in idle
transport: *transport
parameters:
  interval: 10s
  expect:
    individual:
      - cpus: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
        option: AverageFrequency
        value: "<500"

SysBench

Run SysBench on the DUT.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`sysbench`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`transport`	`TransportObject`	Yes		Additional transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`SysBenchOptions`	Yes		Options passed into the `sysbench` cmd

SysBench Options

Attribute	Type	Required	Default	Description
`args`	`[]string`	No		Arguments to pass to `sysbench`.
`expect`	`[]ExpectOptions`	Yes		Expectations to check against the output of `sysbench`.

SysBench Expect Options

Attribute	Type	Required	Default	Description
`option`	`string`	Yes		Option to check
`value`	`string`	Yes		Expected value

SysBench Example

cmd: sysbench
name: Benchmark
transport: *transport
parameters:
  args: [cpu, --cpu-max-prime=20000, --threads=18, --time=60, run]
  expect:
    - option: EventsPerSecond
      value: <4500