ctrace initial development by thorstendb-ARM · Pull Request #2548 · Open-CMSIS-Pack/devtools

thorstendb-ARM · 2026-07-30T14:20:40Z

Implements

Adds the initial ctrace implementation for decoding SWO streams containing ITM and DWT data.
Provides CSV and CTF/Trace Compass output.
Includes unit and integration tests, documentation, and cross-platform build and release support.

Limitations

Trace Bus input, PMU events, event counters, and PC sampling are not supported in the initial release.

Checklist

🤖 This change is covered by unit tests (if applicable).
🤹 Manual testing has been performed (if necessary).
🛡️ Security impacts have been considered (if relevant).
📖 Documentation updates are complete (if required).
🧠 Third-party dependencies and TPIP updated (if required).

github-actions · 2026-07-30T14:26:11Z

Test Results

2 files - 39 14 suites - 111 11m 45s ⏱️ - 6m 46s
477 tests - 454 477 ✅ - 437 0 💤 - 17 0 ❌ ±0
954 runs - 1 047 954 ✅ - 996 0 💤 - 51 0 ❌ ±0

Results for commit 6fbf7f9. ± Comparison against base commit fba299a.

This pull request removes 454 tests.

AuxCmdTests ‑ MkdirCmdTest
AuxCmdTests ‑ RmdirCmdTest
AuxCmdTests ‑ TouchCmdTest
BuildSystemGeneratorTests ‑ GenAuditFile
BuildSystemGeneratorTests ‑ GenAuditFile_WithOut_Existing_Audit_File
BuildSystemGeneratorTests ‑ GenAuditFile_With_Existing_Audit_File
BuildSystemGeneratorTests ‑ GetString
BuildSystemGeneratorTests ‑ StrConv
BuildSystemGeneratorTests ‑ StrNorm
CBuildGCCTests ‑ Asm
…

♻️ This comment has been updated with latest results.

thorstendb-ARM

Added unit tests

jreineckearm

Just had a look at the first few files in this PR (the GH workflows). You may want to review those first. I think some of them will impact more than ctrace.
Also, why do you make workflows sensitive to changes in subfolders of external? I don't think GitHub actions are clever enough to detect changes in git submodules. But I might be wrong.

edriouk

all ctrace* project files must have Header File directory => changes in CMakeLists.txt files are required:

SET(PROJMGR_HEADER_FILES ...

edriouk

All classes and their public methods must have DOXYGEN-style comments

edriouk · 2026-08-03T14:06:44Z

test/data folders contain *.license files. They probably should be removed.

edriouk

LGTM
successfully compiled and run tests locally on Windows

edriouk

LGTM

Simplify diagnostics and trace metadata handling, remove stale APIs and schema entries, and align output selection behavior. Refresh platform test support, documentation, and release-facing validation.

jreineckearm

Light-weight review of all but the ctrace test subfolder. See comments.
Overall massive improvement since initial push. No more systematic flaws like the LCOV excludes or use of #pragma once.

jreineckearm · 2026-08-06T08:57:37Z


      - name: Archive unit tests results
+        # Keep the report available when test execution fails.
        if: always() && (matrix.arch != 'arm64')


Just learnt what always() is: makes a step execute even if previous ones failed.
I think both "run" and "archive" steps should have it or remove it. As is, "run" has it removed, "archive" has it and depends on "run" results.

jreineckearm · 2026-08-06T09:01:53Z

+  endif()
+
+  set_property(TARGET opencsd_options PROPERTY INTERFACE_COMPILE_OPTIONS)
+  target_compile_options(opencsd PRIVATE /EHsc /W0)


Maybe we want to show some warnings? /W0 hides them all. I think msvc has couple of /W levels/

jreineckearm · 2026-08-06T09:03:14Z

@@ -0,0 +1,288 @@
+# ctrace Architecture


maybe split internal engineering docs from later end user docs, i.e. introduce a folder internal-docs or developer-docs.

jreineckearm · 2026-08-06T09:11:04Z

+#include <stdexcept>
+
+/** @brief Provides checked saturating arithmetic for trace timestamps. */
+class SaturatingArithmetic final {


jreineckearm · 2026-08-06T09:23:59Z

@@ -0,0 +1,123 @@
+# ctrace


Good for now, consider split into README ("landing page" on GH) and developer docs.

jreineckearm · 2026-08-06T09:26:04Z

 apply_patch(${CMAKE_CURRENT_SOURCE_DIR}/external/xerces-c)
 apply_patch(${CMAKE_CURRENT_SOURCE_DIR}/external/yaml-cpp)

+# OpenCSD is a private build dependency of ctrace.


Would probably do just to call it a build dependency unless "private" has a special meaning here (which I didn't get if so).

jreineckearm · 2026-08-06T09:28:29Z

 |Google C++ Testing Framework|1.11.0|[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)|https://github.com/google/googletest.git| Testing |
-|cxxopts|2.2.1|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jarro2783/cxxopts.git| packgen |
-|yaml-cpp|0.7.0|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jbeder/yaml-cpp.git| packgen |
+|cxxopts|3.0.0|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jarro2783/cxxopts.git| packgen, ctrace (statically incorporated) |


We didn't have the parts in parenthesis before. Probably should keep it that way, i.e. remove them. Same for the next two entries.

jreineckearm · 2026-08-06T09:29:32Z


 <!-- markdownlint-restore -->
+
+Dependency modifications incorporated into ctrace are documented in its


I thought you removed dependency modifications for ctrace? Would remove the entire paragraph.

jreineckearm · 2026-08-07T08:21:53Z

@@ -0,0 +1,54 @@
+# Copyright (c) 2026 Arm Limited. All rights reserved.


Is cmake used to run tests? How do we do this for other tools in the repo?

jreineckearm · 2026-08-07T10:48:55Z

@@ -0,0 +1,10 @@
+# Repository Instructions


Adding an AGENTS.md should be discussed with the main repository maintainers. Was it already there when you reviewed this PR, @edriouk ?

jreineckearm · 2026-08-07T10:51:29Z

 |Google C++ Testing Framework|1.11.0|[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)|https://github.com/google/googletest.git| Testing |
-|cxxopts|2.2.1|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jarro2783/cxxopts.git| packgen |
-|yaml-cpp|0.7.0|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jbeder/yaml-cpp.git| packgen |
+|cxxopts|3.0.0|[MIT](https://opensource.org/licenses/MIT)|https://github.com/jarro2783/cxxopts.git| packgen, ctrace |


Existing dependencies seem to be updated to newer versions. One even a major version change. Does this also apply to the other libraries/tools? And have they been successfully tested?

codecov · 2026-08-07T12:32:00Z

Codecov Report

❌ Patch coverage is 96.48102% with 127 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.71%. Comparing base (fba299a) to head (6fbf7f9).

Files with missing lines	Patch %	Lines
...ls/ctrace/src/tracerun/YmlTraceRunConfigReader.cpp	66.55%	103 Missing ⚠️
tools/ctrace/src/cli/CliParser.cpp	80.16%	24 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2548      +/-   ##
==========================================
+ Coverage   68.34%   71.71%   +3.36%     
==========================================
  Files         141      185      +44     
  Lines       26511    30117    +3606     
  Branches    16022    17769    +1747     
==========================================
+ Hits        18119    21598    +3479     
- Misses       6090     6214     +124     
- Partials     2302     2305       +3

Flag	Coverage Δ
buildmgr-cov	`79.87% <ø> (ø)`
ctrace-cov	`96.48% <96.48%> (-3.52%)`	⬇️
packchk-cov	`69.81% <ø> (ø)`
packgen-cov	`82.02% <ø> (ø)`
projmgr-cov	`88.06% <ø> (ø)`
svdconv-cov	`46.82% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
tools/ctrace/src/CtraceMain.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/control/DecodeConsumers.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/control/FileDecodeJob.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/control/TraceDirectoryJob.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/CortexMPostDecoder.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/CortexMStreamDecoder.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/DecodePipeline.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/DecodePipeline.h	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/DwtPacketDecoder.cpp	`100.00% <100.00%> (ø)`
tools/ctrace/src/decode/OpenCsdErrorController.cpp	`100.00% <100.00%> (ø)`
... and 35 more

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

thorstendb-ARM added 2 commits July 30, 2026 13:13

[ctrace] Add trace decoder implementation and tests

772c791

[ctrace] Expand architecture documentation

f9f1928

thorstendb-ARM requested a review from jreineckearm July 30, 2026 14:20

Merge branch 'main' into ctrace-dev1

0b345b5

github-advanced-security AI found potential problems Jul 30, 2026

View reviewed changes

thorstendb-ARM added 3 commits July 30, 2026 17:42

[ctrace] Fix static analysis and Windows tests

84c724c

[ctrace] Keep CSV fixtures platform independent

6c5b4a4

[ctrace] Complete decoder test coverage

0f9359b

github-advanced-security AI found potential problems Jul 31, 2026

View reviewed changes

Comment thread tools/ctrace/test/unit/src/decode/OpenCsdPacketCollectorTests.cpp Fixed

thorstendb-ARM added 2 commits July 31, 2026 10:01

[ctrace] Fix CodeQL test sink warning

dd5ed3a

[ctrace] Consolidate test infrastructure

bb20f3d

thorstendb-ARM commented Jul 31, 2026

View reviewed changes

thorstendb-ARM added 3 commits July 31, 2026 15:38

[ctrace] Harden decoder and release packaging

b75f846

[ctrace] Complete branch coverage

393a5ee

[ctrace] Refresh cppcheck suppressions

0f6532a

jreineckearm reviewed Jul 31, 2026

View reviewed changes

thorstendb-ARM added 4 commits August 3, 2026 09:31

[ctrace] Scope build and workflow integration

fbb53dc

[ctrace] Refine diagnostics and test reset recovery

a012a3e

[ctrace] Align test documentation with build behavior

aac5e5d

[ctrace] Document OpenCSD issue without downstream patch

8f1287b

jreineckearm reviewed Aug 3, 2026

View reviewed changes

thorstendb-ARM changed the title ~~Ctrace dev1~~ Ctrace initial development Aug 3, 2026

thorstendb-ARM changed the title ~~Ctrace initial development~~ ctrace initial development Aug 3, 2026

edriouk requested changes Aug 3, 2026

View reviewed changes

thorstendb-ARM added 2 commits August 3, 2026 15:27

[ctrace] Simplify workflow and C++ structure

9347849

[ctrace] Generalize test fixture names

d76a0da

github-advanced-security AI found potential problems Aug 3, 2026

View reviewed changes

Comment thread tools/ctrace/src/cli/CliParser.cpp Fixed

github-advanced-security AI found potential problems Aug 3, 2026

View reviewed changes

Comment thread tools/ctrace/src/decode/OpenCsdItmSession.cpp Fixed

thorstendb-ARM added 3 commits August 4, 2026 10:20

[ctrace] Address review findings

1e68900

[ctrace] Cover metadata label fallback

9d4b83d

Merge branch 'main' into ctrace-dev1

b2691c7

edriouk previously approved these changes Aug 4, 2026

View reviewed changes

[ctrace] Align help output with specification

cc561c9

thorstendb-ARM dismissed edriouk’s stale review via cc561c9 August 4, 2026 09:47

thorstendb-ARM mentioned this pull request Aug 4, 2026

[ctrace] Trace decoder utility development #2554

Open

13 tasks

edriouk previously approved these changes Aug 4, 2026

View reviewed changes

[ctrace] Address final review findings

95cecaf

Simplify diagnostics and trace metadata handling, remove stale APIs and schema entries, and align output selection behavior. Refresh platform test support, documentation, and release-facing validation.

thorstendb-ARM dismissed edriouk’s stale review via 95cecaf August 5, 2026 13:40

[ctrace] Restore full line coverage

3a581db

github-advanced-security AI found potential problems Aug 5, 2026

View reviewed changes

Comment thread tools/ctrace/src/tracerun/CtraceRunMeta.cpp Fixed

[ctrace] Document processor identity resolution

f0541de

thorstendb-ARM requested a review from jreineckearm August 5, 2026 14:50

jreineckearm reviewed Aug 6, 2026

View reviewed changes

thorstendb-ARM added 5 commits August 6, 2026 13:20

[ctrace] Align tests, build, and documentation

ef29d01

[ctrace] Restore required trace-run test coverage

1dd247f

[ctrace] Align trace-run validation with schema

63b1117

fix(ctrace): leave CSV stream empty for unformatted trace

a50252a

fix(ctrace): scope workflow path triggers

de21c7b

jreineckearm reviewed Aug 7, 2026

View reviewed changes

Comment thread tools/ctrace/test/unit/src/control/DecodeConsumersTests.cpp Outdated

refactor(ctrace): use gtest integration suite

8d0ef63

jreineckearm reviewed Aug 7, 2026

View reviewed changes

thorstendb-ARM added 3 commits August 7, 2026 13:36

fix(ctrace): use stable coverage target

02c1b95

Merge branch 'main' into ctrace-dev1

aae3c79

[ctrace] Restore existing dependency versions in license

6fbf7f9


		<!-- markdownlint-restore -->

		Dependency modifications incorporated into ctrace are documented in its

		@@ -0,0 +1,54 @@
		# Copyright (c) 2026 Arm Limited. All rights reserved.

Uh oh!

Conversation

thorstendb-ARM commented Jul 30, 2026

Implements

Limitations

Checklist

Uh oh!

github-actions Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thorstendb-ARM left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jreineckearm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edriouk left a comment

Choose a reason for hiding this comment

Uh oh!

edriouk left a comment

Choose a reason for hiding this comment

Uh oh!

edriouk commented Aug 3, 2026

Uh oh!

Uh oh!

Uh oh!

edriouk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edriouk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jreineckearm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jreineckearm Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Jul 30, 2026 •

edited

Loading

thorstendb-ARM left a comment •

edited

Loading

edriouk left a comment •

edited

Loading

jreineckearm Aug 6, 2026 •

edited

Loading