You copied the Doc URL to your clipboard.

Annotate overview

While ARM Streamline provides a large variety of target information, sometimes you might require extra context. Streamline Annotate lets you add color coded, timestamped annotations to your code.

The Streamline Annotate feature works in a similar way to printf(), but instead of console output, annotate statements populate the Log view and place framing overlays in the Streamline Timeline view.

Figure 9-1 Annotation overlays

Annotation overlays

When the user space application writes to the gator annotate socket, the gator driver integrates the recorded annotate-driven output into the Streamline sample and trace capture report. The annotated text is marked with a thread identifier, which keeps the data uncluttered and eliminates the need for user mutexes.

Annotation groups and channels

You can use the ANNOTATE_NAME_CHANNEL and ANNOTATE_NAME_GROUP macros defined in <DS-5_install_directory>/arm/gator/annotate/streamline_annotate.h to create channels and groups to better organize your annotations. A defined Annotation channel appears under the thread in the Processes section of the Timeline. Channels can be further sorted by groups, with multiple channels appearing under a group title, which you define using the ANNOTATE_NAME_GROUP macro.

Custom counters

You can dynamically define custom counters in user space code using the ANNOTATE_DELTA_COUNTER and ANNOTATE_ABSOLUTE_COUNTER macros. Assign a unique identifier to each custom counter and specify a chart title and a series name for the data. Then you can assign delta or absolute values to these counters using the ANNOTATE_COUNTER_VALUE macro. After you have run a capture session, the Timeline view displays a chart for each custom counter you have created.

Some examples showing how to use custom counters are provided in the <DS-5_install_directory>/arm/gator/example/ directory.

Related reference

Was this page helpful? Yes No