fuchsia.perfmon.cpu

PROTOCOLS

Controller

Defined in fuchsia.perfmon.cpu/perfmon.fidl

GetAllocation

Return the trace allocation configuration, if there is one.

Request

<EMPTY>

Response

Name	Type
`allocation`	`Allocation?`

GetBufferHandle

Return a handle of a trace buffer, if it exists, and if descriptor is valid. descriptor is (0, 1, 2, ..., num_buffers-1)

Request

Name	Type
`descriptor`	`uint32`

Response

Name	Type
`vmo`	`handle<vmo>?`

GetConfig

Fetch performance monitor specification for a cpu, if it exists. Must be called with data collection off and after StageConfig().

Request

<EMPTY>

Response

Name	Type
`config`	`Config?`

GetProperties

Fetch the performance monitor properties of the system.

Request

<EMPTY>

Response

Name	Type
`properties`	`Properties`

Initialize

Create a trace, allocating the needed trace buffers and other resources. "other resources" is basically a catch-all for other things that will be needed. This does not include reserving the events, that is done later by StageConfig().

Request

Name	Type
`allocation`	`Allocation`

Response

Name	Type
`result`	`Controller_Initialize_Result`

StageConfig

Stage performance monitor specification for a cpu. Must be called with data collection off and after Initialize(). Note: This doesn't actually configure the h/w, this just stages the values for subsequent use by Start().

Request

Name	Type
`config`	`Config`

Response

Name	Type
`result`	`Controller_StageConfig_Result`

Start

Turn on data collection. Must be called after Initialize() + StageConfig() and with data collection off.

Request

<EMPTY>

Response

Name	Type
`result`	`Controller_Start_Result`

Stop

Turn off data collection. May be called any time after Initialize() has been called and before Terminate(). If called at other times the call is ignored. May be called multiple times.

Request

<EMPTY>

Response

<EMPTY>

Terminate

Free all trace buffers and any other resources allocated for the trace. This is also done when the connection is closed. Tracing is first stopped if not already stopped. May be called multiple times.

Request

<EMPTY>

Response

<EMPTY>

STRUCTS

Allocation

Defined in fuchsia.perfmon.cpu/perfmon.fidl

The allocation configuration for a data collection run. This is generally the first call to allocate resources for a trace, "trace" is used generically here: == "data collection run".

Field	Type	Description	Default
`num_buffers`	`uint32`	The number of buffers to allocate for trace data. This must be #cpus for now.	No default
`buffer_size_in_pages`	`uint32`	The size of each buffer in 4K pages. Each cpu gets same buffer size.	No default

Config

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Passed to StageConfig() to select the data to be collected.

Field	Type	Description	Default
`events`	`[32]`	Events to collect data for.	No default

Controller_Initialize_Response

Defined in fuchsia.perfmon.cpu/perfmon.fidl

<EMPTY>

Controller_StageConfig_Response

Defined in fuchsia.perfmon.cpu/perfmon.fidl

<EMPTY>

Controller_Start_Response

Defined in fuchsia.perfmon.cpu/perfmon.fidl

<EMPTY>

EventConfig

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Field Type Description Default

Field	Type	Description	Default
`event`	`EventId`	Event to collect data for. The values are architecture specific ids. Each event may appear at most once.	No default
`rate`	`EventRate`	Sampling rate. If rate is non-zero then when the event gets this many hits data is collected (e.g., pc, time). The rate can be non-zero for counting based events only. If rate is zero then: If there is a timebase event then data for this event is collected when data for the timebase event is collected. Otherwise data for the event is collected once, when tracing stops.	No default
`flags`	`EventConfigFlags`	Flags for the event.	No default

event

EventId

Event to collect data for. The values are architecture specific ids. Each event may appear at most once.

No default

rate

EventRate

Sampling rate.

If rate is non-zero then when the event gets this many hits data is collected (e.g., pc, time). The rate can be non-zero for counting based events only.
If rate is zero then: If there is a timebase event then data for this event is collected when data for the timebase event is collected. Otherwise data for the event is collected once, when tracing stops.

No default

flags

EventConfigFlags

Flags for the event.

No default

Properties

Defined in fuchsia.perfmon.cpu/perfmon.fidl

The properties of this system.

Field	Type	Description	Default
`api_version`	`uint16`	S/W API version = `API_VERSION`.	No default
`pm_version`	`uint16`	The H/W Performance Monitor version. This is the version defined by the architecture.	No default
`max_num_events`	`uint16`	The maximum number of events that can be simultaneously supported. The combination of events that can be simultaneously supported is architecture/model specific.	No default
`max_num_fixed_events`	`uint16`	The maximum number of fixed events that can be simultaneously supported, and their maximum width. These values are for informational/display purposes.	No default
`max_fixed_counter_width`	`uint16`		No default
`max_num_programmable_events`	`uint16`	The maximum number of programmable events that can be simultaneously supported, and their maximum width. These values are for informational/display purposes.	No default
`max_programmable_counter_width`	`uint16`		No default
`max_num_misc_events`	`uint16`	The maximum number of misc events that can be simultaneously supported, and their maximum width. These values are for informational/display purposes.	No default
`max_misc_counter_width`	`uint16`		No default
`flags`	`PropertyFlags`	Various flags.	No default

UNIONS

Controller_Initialize_Result strict

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Ordinal
Variant	Type	Description
1	`response`	`Controller_Initialize_Response`
2	`err`	`zx/status`

Controller_StageConfig_Result strict

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Ordinal
Variant	Type	Description
1	`response`	`Controller_StageConfig_Response`
2	`err`	`zx/status`

Controller_Start_Result strict

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Ordinal
Variant	Type	Description
1	`response`	`Controller_Start_Response`
2	`err`	`zx/status`

BITS

EventConfigFlags strict

Type: uint32

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Bits for EventConfig.flags field.

Name	Value	Description
COLLECT_OS	1	Collect data when running in kernel mode.
COLLECT_USER	2	Collect data when running in userspace mode.
COLLECT_PC	4	Collect aspace+pc values.
IS_TIMEBASE	8	If set for an event then the event is used as the "timebase": data for events with a zero rate is collected when data for the timebase event is collected. It is an error to have this set and have the event's rate be zero. At most one event may be the timebase event.
COLLECT_LAST_BRANCH	16	Collect the available set of last branches. Branch data is emitted as LastBranch records. This is only available when the underlying system supports it.

PropertyFlags strict

Type: uint64

Defined in fuchsia.perfmon.cpu/perfmon.fidl

Bits for Properties.flags field.

Name	Value	Description
HAS_LAST_BRANCH	1	The architecture supports LBR records (Last Branch Records).

CONSTANTS

Name	Value	Type	Description
API_VERSION	`0`	`uint16`
MAX_NUM_EVENTS	`32`	`uint16`	The maximum number of events we support simultaneously. Typically the h/w supports less than this, e.g., 7 or so.

TYPE ALIASES

Name	Value	Description
EventId	`uint16`
EventRate	`uint32`