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 14m 54s ⏱️ - 2m 22s
477 tests - 454 477 ✅ - 437 0 💤 - 17 0 ❌ ±0
954 runs - 1 047 954 ✅ - 996 0 💤 - 51 0 ❌ ±0

Results for commit 52e772f. ± Comparison against base commit 37a8a8e.

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.

jreineckearm · 2026-08-03T07:42:09Z

      - '.github/matrix_includes_ctrace.json'
      - 'cmake/**'
      - 'CMakeLists.txt'
+      - 'external/OpenCSD'


I still don't think that making the workflow sensitive to changes in external makes sense. AFAIK, GitHub doesn't check if a git submodule changed.

jreineckearm · 2026-08-03T07:42:33Z

      - '!**/*.md'
+      - 'LICENSE'
+      - 'tools/ctrace/docs/OpenCSD-NOTICE.txt'
+      - 'tools/ctrace/docs/RUNTIME_COMPONENTS.md'


Do you need to rebuild if your internal documentation changed?

jreineckearm · 2026-08-03T07:45:30Z

+      - name: Verify Windows Arm64 binary architecture
+        if: (matrix.target == 'windows' && matrix.arch == 'arm64')
+        shell: pwsh
+        run: |


Should this rather be a script that one can run easily on their local machine?

jreineckearm · 2026-08-03T07:53:39Z

+      - name: Smoke-test release binary
+        if: |
+          github.event_name == 'release' &&
+          (matrix.target != 'windows' || matrix.arch != 'arm64')


So, it's Linux amd64? Should we probably rather exactly write which platform this runs on. Same for other steps

jreineckearm · 2026-08-03T07:55:44Z


      - name: Archive unit tests results
-        if: always() && (matrix.arch != 'arm64')
+        if: always() && (matrix.target != 'windows' || matrix.arch != 'arm64')


what's always()?

jreineckearm · 2026-08-03T08:38:12Z

+    return;
+  }
+
+  // LCOV_EXCL_BR_START: generated aggregate-initializer exception edges


Why do you exclude diagnostics from coverage? Are they not active in production?

jreineckearm · 2026-08-03T08:40:15Z

+
+namespace {
+
+class RawFileReader final {


Same (or at least very similar) code in DecodeConsumers. Refactor.

jreineckearm · 2026-08-03T08:46:17Z

+
+namespace {
+
+std::uint64_t saturatingMultiply(std::uint64_t value, std::uint32_t factor)


Also seen saturating add somewhere, perfect candidate for a utils module.

jreineckearm · 2026-08-03T08:47:45Z

+
+  // The individual short-circuit permutations are an implementation detail;
+  // repeated and complementary fragments are covered as complete behaviors.
+  // LCOV_EXCL_BR_START


jreineckearm · 2026-08-03T08:49:04Z

+
+#if defined(__GNUC__) && !defined(__clang__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wignored-qualifiers"


Which qualifiers is that?

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.

codecov · 2026-08-03T15:15:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.14%. Comparing base (37a8a8e) to head (52e772f).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2548      +/-   ##
==========================================
+ Coverage   68.34%   72.14%   +3.79%     
==========================================
  Files         141      185      +44     
  Lines       26511    30127    +3616     
  Branches    16022    17791    +1769     
==========================================
+ Hits        18118    21734    +3616     
+ Misses       6090     6087       -3     
- Partials     2303     2306       +3

Flag	Coverage Δ
buildmgr-cov	`79.87% <ø> (ø)`
ctrace-cov	`100.00% <100.00%> (ø)`
packchk-cov	`69.81% <ø> (ø)`
packgen-cov	`82.02% <ø> (ø)`
projmgr-cov	`88.05% <ø> (ø)`
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/cli/CliParser.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%> (ø)`
... 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.

+
+void OpenCsdItmSession::createDecoder(OpenCsdPacketCollector& collector, OpenCsdErrorController& errorController)
+{
+  auto* registry = OcsdLibDcdRegister::getDecoderRegister();


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

thorstendb-ARM added 4 commits August 3, 2026 16:39

[ctrace] Resolve CI findings and improve coverage

ac7d37f

[ctrace] Fix GCC custom deleter initialization

41e3e2a

[ctrace] Remove stale runtime inventory link

546ebd7

[ctrace] Bound reset recovery fixture runtime

52e772f

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

View reviewed changes

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

void OpenCsdItmSession::createDecoder(OpenCsdPacketCollector& collector, OpenCsdErrorController& errorController)

{

auto* registry = OcsdLibDcdRegister::getDecoderRegister();


		namespace {

		std::uint64_t saturatingMultiply(std::uint64_t value, std::uint32_t factor)

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!

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!

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!

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!

codecov Bot commented Aug 3, 2026

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Jul 30, 2026 •

edited

Loading

thorstendb-ARM left a comment •

edited

Loading