OpenCSD - CoreSight Trace Decode Library  0.12.1
/build/libopencsd-jipIx2/libopencsd-0.12.1/README.md
Go to the documentation of this file.
1 OpenCSD - An open source CoreSight(tm) Trace Decode library {#mainpage}
2 ===========================================================
3 
4 This library provides an API suitable for the decode of ARM(r) CoreSight(tm) trace streams.
5 
6 The library will decode formatted trace in three stages:
7 
8 1. *Frame Deformatting* : Removal CoreSight frame formatting from individual trace streams.
9 2. *Packet Processing* : Separate individual trace streams into discrete packets.
10 3. *Packet Decode* : Convert the packets into fully decoded trace describing the program flow on a core.
11 
12 The library is implemented in C++ with an optional "C" API.
13 
14 Library Versioning
15 ------------------
16 
17 From version 0.4, library versioning will use a semantic versioning format
18 (per http://semver.org) of the form _Major.minor.patch_ (M.m.p).
19 
20 Internal library version calls, documentation and git repository will use this format moving forwards.
21 Where a patch version is not quoted, or quoted as .x then comments will apply to the entire release.
22 
23 Releases will be at M.m.0, with patch version incremented for bugfixes or documentation updates.
24 
25 Releases will appear on the master branch in the git repository with an appropriate version tag.
26 
27 CoreSight Trace Component Support.
28 ----------------------------------
29 
30 _Current Version 0.12.1_
31 
32 ### Current support:
33 
34 - ETMv4 (v4.4) instruction trace - packet processing and packet decode.
35 - PTM (v1.1) instruction trace - packet processing and packet decode.
36 - ETMv3 (v3.5) instruction trace - packet processing and packet decode.
37 - ETMv3 (v3.5) data trace - packet processing.
38 - STM (v1.1) software trace - packet processing and packet decode.
39 
40 - External Decoders - support for addition of external / custom decoders into the library.
41 
42 ### Support to be added:
43 
44 - ITM software trace - packet processing and decode.
45 - ETMv3 data trace - packet decode.
46 - ETMv4 data trace - packet processing and decode.
47 
48 Note: for ITM and STM, packet decode is combining Master+Channel+Marker+Payload packets into a single generic
49 output packet.
50 
51 
52 Note on the Git Repository.
53 ---------------------------
54 
55 This git repository for OpenCSD contains only source for the OpenCSD decoder library.
56 From version 0.4, releases appear as versioned tags on the master branch.
57 
58 From version 0.7.4, the required updates to CoreSight drivers and perf, that are not
59 currently upstream in the linux kernel tree, are now contained in a separate
60 repository to be found at:
61 
62 https://github.com/Linaro/perf-opencsd
63 
64 
65 Documentation
66 -------------
67 
68 API Documentation is provided inline in the source header files, which use the __doxygen__ standard mark-up.
69 Run `doxygen` on the `./doxygen_config.dox` file located in the `./docs` directory..
70 
71  doxygen ./doxygen_config.dox
72 
73 This will produce the documentation in the `./docs/html` directory. The doxygen configuration also includes
74 the `*.md` files as part of the documentation.
75 
76 Application Programming using the Library
77 -----------------------------------------
78 
79 See the [programmers guide](@ref prog_guide) for details on usage of the library in custom applications.
80 (`./docs/prog_guide/prog_guide_main.md`).
81 
82 
83 Building and Installing the Library
84 -----------------------------------
85 
86 See [build_libs.md](@ref build_lib) in the `./docs` directory for build details.
87 
88 The linux build makefile now contains options to install the library for a linux environment.
89 
90 
91 How the Library is used in Linux `perf`
92 ---------------------------------------
93 The library and additional infrastructure for programming CoreSight components has been integrated
94 with the standard linux perfomance analysis tool `perf`.
95 
96 
97 See [HOWTO.md](@ref howto_perf) for details.
98 
99 How to use the Library, perf and Trace for AutoFDO
100 --------------------------------------------------
101 Capturing trace using perf and decoding using the library can
102 generate profiles for AutoFDO.
103 
104 See [autofdo.md](@ref AutoFDO) for details and scripts.
105 
106 (`./tests/auto-fdo/autofdo.md`).
107 
108 
109 Version and Modification Information
110 ====================================
111 
112 - _Version 0.001_: Library development - tested with `perf` tools integration - BKK16, 8th March 2016
113 - _Version 0.002_: Library development - added in PTM decoder support. Restructure header dir, replaced ARM rctdl prefix with opencsd/ocsd.
114 - _Version 0.003_: Library development - added in ETMv3 instruction decoder support.
115 - _Version 0.4_ : Library development - updated decode tree and C-API for generic decoder handling. Switch to semantic versioning.
116 - _Version 0.4.1_: Minor Update & Bugfixes - fix to PTM decoder, ID checking on test program, adds NULL_TS support in STM packet processor.
117 - _Version 0.4.2_: Minor Update - Update to documentation for perf usage in 4.8 kernel branch.
118 - _Version 0.5.0_: Library Development - external decoder support. STM full decode.
119 - _Version 0.5.1_: Minor Update & Bugfixes - Update HOWTO for kernel 4.9. Build fixes for parallel builds
120 - _Version 0.5.2_: Minor Update & Bugfixes - Update trace info packet string o/p + Cycle count packet bugfixes.
121 - _Version 0.5.3_: Doc update for using AutoFDO with ETM and additional timestamp and cycle count options.
122 - _Version 0.5.4_: Updates: X-compile for arm/arm64. Remove deprecated VS2010 builds. Bugfix: GCC inline semantics in debug build.
123 - _Version 0.6.0_: Packet printers moved from tests into the main library. C++ and C APIs updated to allow clients to use them.
124  Update to allow perf to insert barrier packets (4xFSYNC) which the decoder can be made to use to reset the decode state.
125 - _Version 0.6.1_: Bugfix: instruction follower bug on A32 branch to T32.
126 - _Version 0.7.0_: Add handling for trace return stack feature to ETMv4 and PTM trace.
127 - _Version 0.7.1_: Bugfix: ETMv3 packet processor.
128 - _Version 0.7.2_: Bugfix: ETMv4 decoder - fix exact match packet address follower.
129 - _Version 0.7.3_: Bugfix: PTM decoder - issues with initialisation and ASYNC detection.
130 - _Version 0.7.4_: Notification of change of repository for perf extensions. gcc 6.x build fixes.
131 - _Version 0.7.5_: Bugfix: ETMv4 decoder memory leak. Linux build update - header dependencies force rebuild.
132 - _Version 0.8.0_: Header restructure and build update to enable linux version to install library and C-API headers in standard locations.
133  Library output naming changed from 'cstraced' to 'opencsd'.
134 - _Version 0.8.1_: Minor updates: Use install tool to copy headers. Changes to HOWTO for perf usage.
135 - _Version 0.8.2_: Bugfix: C++ init errors fixed for CLANG build process.
136 - _Version 0.8.3_: Bugfix: ETMv4 decoder issues fixed.
137 - _Version 0.8.4_: build: makefile updates and improvements to get build process compatible with Debian packaging.
138 - _Version 0.9.0_: Performance improvements for perf: Additional info in instruction range output packet. Caching memory accesses.
139  Added Programmers guide to documentation.
140 - _Version 0.9.1_: Bugfix: Crash during decode when first memory access is to address where no image provided.
141 - _Version 0.9.2_: Bugfix: ETMv4: Incorrect Exception number output for Genric exception packets.
142  AutoFDO: update documentation for AutoFDO usage and add in "record.sh" script
143 - _Version 0.9.3_: Bugfix: Test snapshot library not handling 'offset' parameters in dump file sections.
144  Install: ocsd_if_version.h moved to opencsd/include to allow installation on OS & use in compiling client apps.
145 - _Version 0.10.0_: __Updates__: Add additional information about the last instruction to the generic output packet.
146  __Docs__: update docs for updated output packet.
147  __Bugfix__: typecast removed from OCSD_VER_NUM in ocsd_if_version.h to allow use in C pre-processor.
148  __Bugfix__: ETMV4: Interworking ISA change between A32-T32 occasionally missed during instruction decode.
149 - _Version 0.10.1_: __Updates__: Build update - allow multi-thread make (make -j<N>).
150  __Docs__: Minor update to AutoFDO documentation.
151 - _Version 0.11.0_: __Update__: ETM v4 decoder updated to support ETM version up to v4.4
152  __Update__: Memory access callback function - added new callback signature to provide TraceID to client when requesting memory.
153  __Update__: Created new example program to demonstrate using memory buffer in APIs.
154  __Bugfix__: Typos in docs and source.
155  __Bugfix__: Memory accessor - validate callback return values.
156 - _Version 0.11.1_: __Update__: build:- change -fpic to -fPIC to allow Debian build on sparc.
157  __Bugfix__: build:- remove unused variable
158 - _Version 0.11.2_: __Update__: docs:- HOWTO.md update to match new perf build requirements.
159  __Bugfix__: Minor spelling typos fixed.
160 - _Version 0.12.0_: __Update__: Frame deformatter - TPIU FSYNC and HSYNC support added.
161  __Update__: ETM v4: Bugfix & clarification on Exception trace handling. Where exception occurs at a branch target before any instructions
162  have been executed, the preferred return address is also the target address of the branch instruction. This case now includes as specific flag in
163  the packet. Additionally any context change associated with this target address was being applied incorrectly.
164  __Update__: Core / Architecture mapping to core names as used by test programs / snapshots updated to include additional recent ARM cores.
165  __Update__: Docs: Update to reflect new exception flag. Update test program example to reflect latest output.
166  __Bugfix__: ETM v4: Valid trace info packet was not handled correctly (0x01, 0x00).
167  __Bugfix__: ETM v4: Error messaging on commit stack overflow.
168 - _Version 0.12.1_: __Update__: build: remove -g option from release build.
169  __Update__: tests: Snapshots can now use generic arch+profile names rather than core names, e.g. ARMv8-A
170  __Bugfix__: Instruction decode - v8.3 B[L]A{A|B}[Z] instructions mis-identified.
171  __Bugfix__: Transition from A64 to A32 can be mis-decoded if the trace implementation represents the transition
172  as an individual address packet followed by a context packet.
173 
174 
175 Licence Information
176 ===================
177 
178 This library is licensed under the [BSD three clause licence.](http://directory.fsf.org/wiki/License:BSD_3Clause)
179 
180 A copy of this license is in the `LICENCE` file included with the source code.
181 
182 Contact
183 =======
184 
185 Using the github site: https://github.com/Linaro/OpenCSD
186 
187 Mailing list: coresight@lists.linaro.org