5.17.7 Events and trace interface objects

Describes the following objects:

EventCounterMode

EventCounterMode members:

nonOverflowTrace

Type: Boolean

Optional. Iff present and True, call ec_FOO() callback for all non-overflow events. For example, this feature can be used to automatically trace the next 100 events. If nonOverflowTrace and overflowTrace are both set, all events are emitted similarly to normal non-counter event sources.

overflowDisableTrace

Type: Boolean

Optional. Iff present and True, disable event on overflow. The event stream is not destroyed. The client must call eventStream_destroy() to destroy the event stream.

overflowReload

Type: Boolean

Optional. Iff present and True, set internal counter value to startVal on overflow. If this is False or missing, the counter wraps from 0xffff ffff ffff ffff to 0.

overflowStopSim

Type: Boolean

Optional. Iff present and True, stop simulation on overflow.

overflowTrace

Type: Boolean

Optional. Iff present and True, call ec_FOO() callback on overflow. The fields argument has an additional implicit overflowTrace field (with value True) to clearly identify this callback as an overflow event.

EventSourceFieldInfo

EventSourceFieldInfo members:

description

Type: String

Optional. Description of the event source field. Can contain linefeeds.

enums

Type: EnumElementInfo[]

Optional. Array of EnumElementInfo objects which describe symbols for numeric event field values. Debuggers can display these symbols (and potentially their description) in addition to the numeric value.

name

Type: String

Name of the event source field. This name is used to uniquely identify the event source field within an event source. By convention, all field names are uppercase and can contain underscores. Field names must not start with a colon. Names starting with a colon are reserved.

size

Type: NumberU64

Size of the field value in bytes. Permissible sizes depend on the type, see type. 0 means variable size (for "type=string" only).

type

Type: String

Type of this event source field:

uint
Hint that a value must be interpreted as an unsigned int (size must be 1, 2, 4, or 8).
int
Hint that a value must be interpreted as a signed int (size must be 1, 2, 4, or 8).
bool
Hint that a value must be interpreted as a bool (size must be 1).
float
Hint that the byte pattern must be interpreted as an IEEE 754 floating-point value (size must be 4 or 8).
string
The value is (must be) a string of variable size (size must be 0). Hint that a value must be interpreted as text.
bytes
The value is (must be) a string of variable size (size must be 0). Hint that a value must be interpreted as a byte sequence (binary data).

There is no type enum. Use int or uint together with enums to model an enum type.

EventSourceInfo

EventSourceInfo members:

counter

Type: Boolean

Optional. If present and True, this event source supports the counter features, see arguments counter, startVal, and counterMode for eventStream_create(), and the counter argument for eventStream_create(), if present, can be True or False. If this is False or missing, the counter argument for eventStream_create() must be False or missing.

description

Type: String

Optional. Description of the event source. Can contain linefeeds.

evSrcId

Type: NumberU64

Opaque event source id. This id is used to identify the event source in other event functions.

fields

Type: EventSourceFieldInfo[]

Metadata for the fields of this event. Event sources that do not have any fields, which is rare, return an empty array.

format

Type: String

Optional. Iris-text-format. The format can refer to fields of this event source, to resources of this and other instances, and to the fields in other event sources of this and other instances.

name

Type: String

Name of the event source. This name is used to uniquely identify the event source within a target instance. By convention, all event source names are uppercase and can contain underscores. Event source names must be chosen so that wildcard matching is possible. In particular, generic parts of event source names like _START and _END must be suffixes. Alphabetic sorting of event source names must group related event sources together, if possible. Event source names must not start with a colon. Names starting with a colon are reserved.

ringBuffer

Type: Boolean

Optional. Iff present and True, this event source supports being buffered in a ring buffer.

EventState

EventState members:

esId

Type: NumberU64

Event stream id.

fields

Type: Object

Same semantics as ec_FOO(fields), except that the values of the fields represent the current state of the underlying resource and no actual event happened.

time

Type: NumberU64

Same semantics as ec_FOO(timestamp).

sInstId

Type: NumberU64

Same semantics as ec_FOO(sInstId).

TraceEventData

TraceEventData members:

esId

Type: NumberU64

Event stream id.

fields

Type: Object

Object that contains the names and values of all event source fields requested by the eventStream_create() call. See ec_FOO().

sInstId

Type: NumberU64

Source instId. The instance that generated and sent this event.

time

Type: NumberU64

Simulation time timestamp of the event. See ec_FOO().

Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.