Category and event parameters for custom counters in events.xml
In addition to adding gator functions to your code so that
gator can collect data for your custom counters, you also must provide descriptions of your counters in the events.xml file.
NoteAdditional details are available in the
gatorprotocol documentation, located in DS-5/arm/gator/protocol.
The category node has the following attributes:
|name||A name for this category of counters. This names the header the counter appears under in the Counter Configuration dialog box.|
|Defines the counter set to be used.|
|Defines whether or not Streamline™ collects data on a per cpu basis. Set this value to yes and Streamline collects data from each cpu separately for these counters.|
Use yes or no to define whether or not the counters in this category can be used for event-based sampling. The default value is no.
For example: <category name="Cortex-A9" counter_set="ARM_Cortex-A9_cnt" per_cpu="yes" supports_event_based_sampling="yes">
Use the option_set node when the same event applies to multiple devices. It has the following attributes:
The hex integer offset to add to the applicable event to get the event number.
The name of the device. The value of name is appended to the event name.
A description of the device option. This description is appended to the event description.
Use the following attributes in the event elements:
|counter||Every event element must have either the counter or event attribute defined. Use the counter attribute for fixed counter types, like cycle count. Use the event attribute for all other events.|
|Architecture specific or implementation-specific event number, in hexadecimal, determined from either the architecture specification document or the Technical Reference Manual of the processor. This attribute is required if the element does not have a counter attribute.|
|option_set||Defines the option_set to use.|
|The title of the chart that Streamline displays. Counters with matching titles stack in the charts.|
|name||The name that Streamline displays after the title.|
|per_cpu||Defines whether or not Streamline collects data on a per cpu basis. Set this value to yes and Streamline collects data from each cpu separately for this event.|
|supports_event_based_sampling||Use yes or no to define whether or not the event can be used for event based sampling. This value defaults to the category value if the attribute is not present in the event.|
|class||Use either delta, absolute, or activity as the value for the class attribute. Use delta for values that increment or are accumulated over time such as hardware performance counters. Use absolute for singular or impulse values such as system memory used. Use activity in conjunction with scheduler trace data such as CPU activity. The default value is delta. The class attribute is optional.|
|display||Use one of the following values with the display attribute: average, maximum, minimum, hertz, or accumulate. This is the same as adding .avg, .max, .min or .hz to the counter name in the chart configuration Expression field of Streamline. The default value is accumulate.|
|units||Defines the unit type to display in Streamline.|
|modifier||Gives the number to divide read numbers by for fixed point math. This attribute is optional.|
|derived||Defines whether or not the data is derived from the data of another chart.|
|series_composition||Defines how to arrange the data in the Timeline view. Enter either overlay, stacked, or logarithmic as the value for this attribute. This attribute is optional and the default value is stacked.|
|rendering_type||The type of chart to render for the Timeline view in Streamline. This attribute is optional and can be set to either bar, fill, or line. The default value is fill.|
|average_selection||Enter yes to have the values of the Cross Section Marker in the Timeline view display as average. Enter no to have them display as a total.|
|average_cores||Sets whether or not Streamline averages the values of multiple cores when viewing the aggregate data of a per-cpu chart. Enter yes or no as the value for this attribute. The average_cores attribute is optional.|
|percentage||Sets whether or not the Timeline view displays data as a percentage of the maximum value in the chart. Enter yes or no as the value for this attribute. The percentage attribute is optional.|
|description||Use this attribute to define a description to show in Streamline. The value of this attribute is used as the tooltip for the counter.|