This library provides an API suitable for the decode of ARM(r) CoreSight(tm) trace streams.
The library will decode formatted trace in three stages:
The library is implemented in C++ with an optional “C” API.
From version 0.4, library versioning will use a semantic versioning format (per http://semver.org) of the form Major.minor.patch (M.m.p).
Internal library version calls, documentation and git repository will use this format moving forwards. Where a patch version is not quoted, or quoted as .x then comments will apply to the entire release.
Releases will be at M.m.0, with patch version incremented for bugfixes or documentation updates.
Releases will appear on the master branch in the git repository with an appropriate version tag.
Current Version 1.0.0
ETE (v1.1) instruction trace - packet processing and packet decode.
ETMv4 (v4.5 [A/R profile] v4.4 [M profile]) instruction trace - packet processing and packet decode.
PTM (v1.1) instruction trace - packet processing and packet decode.
ETMv3 (v3.5) instruction trace - packet processing and packet decode.
ETMv3 (v3.5) data trace - packet processing.
STM (v1.1) software trace - packet processing and packet decode.
External Decoders - support for addition of external / custom decoders into the library.
Note: for ITM and STM, packet decode is combining Master+Channel+Marker+Payload packets into a single generic output packet.
This git repository for OpenCSD contains only source for the OpenCSD decoder library. From version 0.4, releases appear as versioned tags on the master branch.
CoreSight kernel drivers and perf suport for CoreSight trace is maintained in the latest upstream kernel versions.
One exception is a minor patch required for autoFDO support. See [autofdo.md](@ref AutoFDO).
API Documentation is provided inline in the source header files, which use the doxygen standard mark-up. Run
doxygen on the
./doxygen_config.dox file located in the
This will produce the documentation in the
./docs/html directory. The doxygen configuration also includes the
*.md files as part of the documentation.
See the [programmers guide](@ref prog_guide) for details on usage of the library in custom applications. (
See [build_libs.md](@ref build_lib) in the
./docs directory for build details.
The linux build makefile now contains options to install the library for a linux environment.
The library and additional infrastructure for programming CoreSight components has been integrated with the standard linux perfomance analysis tool
See [HOWTO.md](@ref howto_perf) for details.
Capturing trace using perf and decoding using the library can generate profiles for AutoFDO.
See [autofdo.md](@ref AutoFDO) for details and scripts.
Version 0.001: Library development - tested with
perf tools integration - BKK16, 8th March 2016
Version 0.002: Library development - added in PTM decoder support. Restructure header dir, replaced ARM rctdl prefix with opencsd/ocsd.
Version 0.003: Library development - added in ETMv3 instruction decoder support.
Version 0.4 : Library development - updated decode tree and C-API for generic decoder handling. Switch to semantic versioning.
Version 0.4.1: Minor Update & Bugfixes - fix to PTM decoder, ID checking on test program, adds NULL_TS support in STM packet processor.
Version 0.4.2: Minor Update - Update to documentation for perf usage in 4.8 kernel branch.
Version 0.5.0: Library Development - external decoder support. STM full decode.
Version 0.5.1: Minor Update & Bugfixes - Update HOWTO for kernel 4.9. Build fixes for parallel builds
Version 0.5.2: Minor Update & Bugfixes - Update trace info packet string o/p + Cycle count packet bugfixes.
Version 0.5.3: Doc update for using AutoFDO with ETM and additional timestamp and cycle count options.
Version 0.5.4: Updates: X-compile for arm/arm64. Remove deprecated VS2010 builds. Bugfix: GCC inline semantics in debug build.
Version 0.6.0: Packet printers moved from tests into the main library. C++ and C APIs updated to allow clients to use them. Update to allow perf to insert barrier packets (4xFSYNC) which the decoder can be made to use to reset the decode state.
Version 0.6.1: Bugfix: instruction follower bug on A32 branch to T32.
Version 0.7.0: Add handling for trace return stack feature to ETMv4 and PTM trace.
Version 0.7.1: Bugfix: ETMv3 packet processor.
Version 0.7.2: Bugfix: ETMv4 decoder - fix exact match packet address follower.
Version 0.7.3: Bugfix: PTM decoder - issues with initialisation and ASYNC detection.
Version 0.7.4: Notification of change of repository for perf extensions. gcc 6.x build fixes.
Version 0.7.5: Bugfix: ETMv4 decoder memory leak. Linux build update - header dependencies force rebuild.
Version 0.8.0: Header restructure and build update to enable linux version to install library and C-API headers in standard locations. Library output naming changed from ‘cstraced’ to ‘opencsd’.
Version 0.8.1: Minor updates: Use install tool to copy headers. Changes to HOWTO for perf usage.
Version 0.8.2: Bugfix: C++ init errors fixed for CLANG build process.
Version 0.8.3: Bugfix: ETMv4 decoder issues fixed.
Version 0.8.4: build: makefile updates and improvements to get build process compatible with Debian packaging.
Version 0.9.0: Performance improvements for perf: Additional info in instruction range output packet. Caching memory accesses. Added Programmers guide to documentation.
Version 0.9.1: Bugfix: Crash during decode when first memory access is to address where no image provided.
Version 0.9.2: Bugfix: ETMv4: Incorrect Exception number output for Genric exception packets. AutoFDO: update documentation for AutoFDO usage and add in “record.sh” script
Version 0.9.3: Bugfix: Test snapshot library not handling ‘offset’ parameters in dump file sections. Install: ocsd_if_version.h moved to opencsd/include to allow installation on OS & use in compiling client apps.
Version 0.13.x : Intermediate development version.
This library is licensed under the BSD three clause licence.
A copy of this license is in the
LICENCE file included with the source code.
Using the github site: https://github.com/Linaro/OpenCSD
Mailing list: email@example.com