opensystemtrace_types.h File Reference

Typedef TGroupId

typedef TUint8 TGroupId

Every trace point must be statically assigned a group ID. This is essentially a label that allows identification of the intended use of the trace packets generated by the trace point. The Group ID will either reflect a system wide Tracing use cases, such as identifying why a panic occurred, or is assigned a meaning specific to a component, such as the heap trace output from the kernel. In essence the Group ID is a way of indicating that trace points / packets are related in some way. TGroupIdRange for more information.

const TGroupId KMaxGroupId

const TGroupId KMaxGroupId

The maximum possible value for TGroupId

Typedef TClassification

typedef TUint8 TClassification

Use TGroupId instead TGroupId

const TClassification KMaxClassification

const TClassification KMaxClassification

Use KMaxGroupId instead KMaxGroupId

Typedef TComponentId

typedef TUint32 TComponentId

Each trace point must be statically assigned a ComponentId to indicate the module in which the trace point is defined. It should always be the UID3 of the binary containing the trace point associated with the component ID.

The ComponentId and Group ID attributes of a trace point are independent.

const TComponentId KMaxComponentId

const TComponentId KMaxComponentId

The maximum possible value for TComponentId

Typedef TTraceId

typedef TUint16 TTraceId

Trace IDs have two functions in a trace packet:

1. They identify the individual trace point that created the trace packet. 2. They specify the format of the trace packet payload.

This only works if the Trace ID value is unique for a given Group ID and Component ID, if present, and should be statically assigned during development when a trace point is created.

The meaning of a TraceId is specific to the ComponentId and Group ID of the associated trace point.

const TTraceId KMaxTraceId

const TTraceId KMaxTraceId

The maximum possible value for TTraceId

const TTraceId KFormatPrintf

const TTraceId KFormatPrintf

Used in packets produced by the Print and Printf functions.

Note that this format should not be used on the device by clients of OST. This symbol is only marked as published to partners to give host side tools access to it.

No replacement is provided as this symbol is no longer needed as a result of the alignment of trace attributes in OSTv2. TTraceId

const TTraceId KFormatPrintfUnicode

const TTraceId KFormatPrintfUnicode

Used in packets produced by the Print and Printf functions for unicode descriptors.

Note that this format should not be used on the device by clients of OST. This symbol is only marked as published to partners to give host side tools access to it.

No replacement is provided as this symbol is no longer needed as a result of the alignment of trace attributes in OSTv2. TTraceId

const TTraceId KInitialClientFormat

const TTraceId KInitialClientFormat

This value was used by UTFv2 clients to specify the start of the range of enums used to define their format ids. This is no longer necessary as in OSTv2 clients are allowed to use the whole range without exception.

No replacement is provided as this symbol is no longer needed as a result of the alignment of trace attributes in OSTv2. TTraceId