Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / OpenCSD / 85308cf51c81a80994ebeade22193c7ee8d8ffa0
commit85308cf51c81a80994ebeade22193c7ee8d8ffa0[log] [tgz]
authorMike Leach <mike.leach@linaro.org>Tue Jun 21 16:03:47 2016 +0100
committerMike Leach <mike.leach@linaro.org>Thu Aug 18 12:59:25 2016 +0100
tree8b93a74a7ea1769c0aa2c9cc0998a181add4aa24
parentf804a2a45413ca80feb7f05117b7a118d4445d8e [diff]
opencsd: Add .bash scripts - library testing in perf

Added bash scripts to setup build and test environment variables
required when testing the library with perf report and perf script.

Updated HOWTO.md to describe the use of these scripts.
        Adjust for latest opencsd-perf branch.

Signed-off-by: Mike Leach <mike.leach@linaro.org>
4 files changed
tree: 8b93a74a7ea1769c0aa2c9cc0998a181add4aa24
  1. decoder/
  2. .gitignore
  3. HOWTO.md
  4. LICENSE
  5. README.md
  6. TODO
README.md

OpenCSD - An open source CoreSight(tm) Trace Decode library {#mainpage}

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:-

  1. Frame Deformatting : Removal CoreSight frame formatting from individual trace streams.
  2. Packet Processing : Separate individual trace streams into discrete packets.
  3. Packet Decode : Convert the packets into fully decoded trace describing the program flow on a core.

The library is implemented in C++ with an optional "C" API.

CoreSight Trace Component Support.

Current Version 0.004

Current support:

  • ETMv4 instruction trace - packet processing and packet decode.
  • PTM instruction trace - packet processing and packet decode.
  • ETMv3 instruction trace - packet processing and packet decode.
  • ETMv3 data trace - packet processing.
  • STM software trace - packet processing.

Support to be added:

  • STM software trace - packet decode.
  • ITM software trace - packet processing and decode.
  • ETMv3 data trace - packet decode.
  • ETMv4 data trace - packet processing and decode.

Note: for ITM and STM, packet decode is combining Master+Channel+Marker+Payload packets into a single generic output packet.

Note on the Git Repository.

At present, the git repository for OpenCSD contains both branches for the OpenCSD library itself, and branches that have the perf updates that are not yet upstream in the main linux tree for using perf to record and decode trace.

These perf branches are snapshots of the kernel tree and are thus quite large. It is advised if only the OpenCSD library is required, clone only selected branches. Otherwise, downloading may take some time.

e.g.

git clone -b opencsd-0v003 --single-branch https://github.com/Linaro/OpenCSD

Documentation

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 ./docs directory..

doxygen ./doxygen_config.dox

This will produce the documentation in the ./docs/html directory. The doxygen configuration also includes the *.md files as part of the documentation.

Building the Library

See [build_libs.md](@ref build_lib) in the ./docs directory for build details.

How the Library is used in Linux perf

The library and additional infrastructure for programming CoreSight components has been integrated with the standard linux perfomance analysis tool perf.

See [HOWTO.md](@ref howto_perf) for details.

Version and Modification Information

  • 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.004: In development - decode tree api updates.

Licence Information

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.