Add Lock support for Tracy by ccp-chargeback · Pull Request #24 · carbonengine/core

ccp-chargeback · 2026-06-19T11:43:33Z

Change includes:

Adding support for Locks in the TracyTestClient (with help from Claude)
Gate access to Locks in Tracy based on telemetry config flag
Changing CcpMutex to inform Tracy of Locks
Add support of "lazy announce" of locks in Tracy, once telemetry is connected.

Contains: - Added support for Locks in the TracyTestClient. - Updates to CcpMutex - First draft of tests for low-level Tracy lock functions. - First draft of tests for tests on CcpMutex/CcpAutoMutex classes.

Review of classes TracyTestClient and test/CcpTelemetry

This tests the vanilla behavior of the raw underlying TracyCLockXXX() functions.

Following tests removed: - RawTracyLockCAnnounceAndTerminate - RawTracyUncontendedLock

This is needed because the CcpMutex objects may have been created long before Tracy on-demand telemetry session started.

…tclient # Conflicts: # tests/TracyTestClient.cpp # tests/TracyTestClient.h

Make use of types from the tracy header files: - tracy::ServerQueryString - tracy::ServerQuerySourceLocation - tracy::QueueType::StringData - tracy::QueueType::SingleStringData - tracy::QueueType::LockAnnounce - tracy::QueueType::LockTerminate - tracy::QueueType::LockWait - tracy::QueueType::LockObtain - tracy::QueueType::LockRelease - tracy::QueueType::LockName - tracy::QueueType::SourceLocation

CCP-Aporia · 2026-06-22T10:39:38Z

        LeaveCriticalSection( &m_mutex );
 #if CCP_TELEMETRY_ENABLED
-		if ( CcpTelemetryIsConnected() && m_tracyLockContext )
+		EnsureTracyLockState();


Why does this need to ensure the lock state?

Will change this to a regular ctx + LockTracking + connectivity check

CCP-Aporia · 2026-06-22T10:39:43Z

+			{
+				// Telemetry disconnected (or lock tracking disabled); drop the stale
+				// context quickly so that the next connect produces a fresh announce/name.
+				m_tracyLockContext = nullptr;


Isn't this leaking the old context? Also, what about the scenario where someone temporarily stops the integration and then restarts without creation a new profiler session - won't that now show wrong information for the lock?

Changed the way this (now renamed) function works.
No longer resetting the context if it was previously set but connection has been dropped.

CCP-Aporia · 2026-06-22T10:43:12Z

+	//   so that a future reconnect will produce a fresh, valid context.
+	// After this returns, all other Tracy calls in Acquire/Release can rely on a
+	// single, fast null-check of m_tracyLockContext.
+	void EnsureTracyLockState()


This is a good opportunity for cleaning up the usage of Tracy as part of the name whenever possibly as opposed to adding it in more places. 🙂

Changed to EnsureTelemetryLockAnnounced()
The file will now only reference Tracy as part of:

m_tracyLockContext

TracyCLockXXX() functions

CCP-Aporia · 2026-06-22T10:45:20Z

 private:
 #if CCP_TELEMETRY_ENABLED
+	// See the Windows variant above for documentation.
+	void EnsureTracyLockState()


Why does the helper function need to be duplicated per platform? Can't that be avoided?

Will tackle in the CcpMutex.h -> .h + .cpp refactor

CCP-Aporia · 2026-06-22T10:48:22Z

 	EXPECT_EQ( 2, m_tracyClient.GetZoneEndCount() );
 }
+
+TEST_F( CcpTelemetryTest, RawTracyLockCounters )


This is a strange test to have. The TracyTestClient is implicitly tested through a test case that covers our actual lock usage. And Tracy's own functionality is nothing that we should be testing.

Test removed

CCP-Aporia · 2026-06-22T10:48:48Z

+}
+
+// A locks, B waits, A unlocks, B locks, B unlocks.
+TEST_F( CcpTelemetryTest, RawTracyLockOneWaitingThread )


Same as above, there is no value in this test.

Test removed

CCP-Aporia · 2026-06-22T10:49:07Z

+}
+
+// A locks, B waits, C waits, A unlocks, B and C lock/unlock in turn.
+TEST_F( CcpTelemetryTest, RawTracyLockMultipleWaitingThreads )


And another test that doesn't add value.

Test removed

CCP-Aporia · 2026-06-22T10:52:15Z

 #define CCPMUTEX_H

-#include "CcpTelemetry.h"
+#include <string>


This include can be avoided by moving the implementation into a .cpp file. Which then also resolves the other issue that we observed during initial testing, e.g. that some compilers inline this header completely, defeating the purpose of this code living in a shared library.

This refactoring is in the pipeline...

There is currently no support for multiple Telemetry sessions at the same time.

- Renamed function to EnsureTelemetryLockAnnounced() - No longer resetting the context - Change conditional logic in Acquire/Release

- RawTracyLockCounters - RawTracyLockOneWaitingThread - RawTracyLockMultipleWaitingThreads

ccp-chargeback added 10 commits June 15, 2026 15:29

First draft of Tracy Lock implementation

029dead

Contains: - Added support for Locks in the TracyTestClient. - Updates to CcpMutex - First draft of tests for low-level Tracy lock functions. - First draft of tests for tests on CcpMutex/CcpAutoMutex classes.

Cleanup CcpMutex.h and Submodule update

3c0643b

First pass of cleanup of Lock test files.

78789af

Review of classes TracyTestClient and test/CcpTelemetry

Create a vanilla RawTracyLockCounters test

ee54828

This tests the vanilla behavior of the raw underlying TracyCLockXXX() functions.

Remove unnecessary Raw Tracy function tests

6332829

Following tests removed: - RawTracyLockCAnnounceAndTerminate - RawTracyUncontendedLock

Rename multi thread Raw TracyLock tests

bbe6d6e

Rename and cleanup CcpMutex/CcpAutoMutex tests

98870a0

Add support for Lazy Announce of mutexes in Tracy

84ed4bd

This is needed because the CcpMutex objects may have been created long before Tracy on-demand telemetry session started.

Add support for tracking locks in CcpTelemetryConfig

a9e9525

Remove unnecessary comment in tests/CcpTelemetry.cpp

984579b

ccp-chargeback requested a review from CCP-Aporia June 19, 2026 11:43

ccp-chargeback added 2 commits June 19, 2026 13:55

Merge remote-tracking branch 'carbonengine/main' into tracy_locks_tes…

36e95e9

…tclient # Conflicts: # tests/TracyTestClient.cpp # tests/TracyTestClient.h

CCP-Aporia requested changes Jun 22, 2026

View reviewed changes

ccp-chargeback added 4 commits June 22, 2026 12:14

Remove misleading comments from CcpRegisterMutex/Thread

9ed379b

There is currently no support for multiple Telemetry sessions at the same time.

Change the way EnsureTracyLockState works and is used.

5e14e6c

- Renamed function to EnsureTelemetryLockAnnounced() - No longer resetting the context - Change conditional logic in Acquire/Release

Remove unnecessary TracyTestClient tests

308eeb4

- RawTracyLockCounters - RawTracyLockOneWaitingThread - RawTracyLockMultipleWaitingThreads

Refactor CcpMutex.h file into both .h and .cpp

2d4f4ee

Uh oh!

Conversation

ccp-chargeback commented Jun 19, 2026

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants