Add memory tracking telemetry support for Tracy

CCPMemory.cpp

@@ -290,10 +290,7 @@ static inline void* CcpPlatformMalloc( size_t size )
 	void* p = HeapAlloc( s_heap, 0, size );
 	UpdateCount( size );
 #if ENABLE_TELEMETRY_MEMORY_TRACKING
-	if ( p && CcpTelemetryIsConnected() )
-	{
-//		TracySecureAlloc( p, size );
-	}
+	CcpTelemetryTrackAllocation( p, size );
 #endif
 	return p;
 }
@@ -308,16 +305,16 @@ static inline void* CcpPlatformCalloc( size_t items, size_t size )
 	void* p = HeapAlloc( s_heap, HEAP_ZERO_MEMORY, bytes );
 	UpdateCount( bytes );
 #if ENABLE_TELEMETRY_MEMORY_TRACKING
-	if ( p && CcpTelemetryIsConnected() )
-	{
-//		TracySecureAlloc( p, size );
-	}
+	CcpTelemetryTrackAllocation( p, bytes );
 #endif
 	return p;
 }
 
 static inline void CcpPlatformFree( void* p )
 {
+#if ENABLE_TELEMETRY_MEMORY_TRACKING
+	CcpTelemetryTrackDeallocation( p );
+#endif
 	UpdateCount( p, false );
 	HeapFree( s_heap, 0, p );
 }
@@ -339,9 +336,7 @@ static inline void* CcpPlatformMalloc( size_t size )
         s_memuse += realSize;
 
 #if ENABLE_TELEMETRY_MEMORY_TRACKING
-		if ( CcpTelemetryIsConnected() ) {
-//			TracySecureAlloc( p, realSize );
-		}
+    	CcpTelemetryTrackAllocation( p, realSize );
 #endif
     }
 #if defined(__ANDROID__)
@@ -363,10 +358,7 @@ static inline void* CcpPlatformCalloc( size_t items, size_t size )
 		s_memuse += realSize;
 
 #if ENABLE_TELEMETRY_MEMORY_TRACKING
-		if ( CcpTelemetryIsConnected() )
-		{
-//			TracySecureAlloc( p, realSize );
-		}
+		CcpTelemetryTrackAllocation( p, realSize );
 #endif
 	}
 	return p;
@@ -376,6 +368,9 @@ static inline void CcpPlatformFree( void* p )
 {
 #if defined(__ANDROID__)
 	p = reinterpret_cast<size_t*>( p ) - 1;
+#endif
+#if ENABLE_TELEMETRY_MEMORY_TRACKING
+	CcpTelemetryTrackDeallocation( p );
 #endif
     s_memuse -= CCPMSize( p );
 	free( p );
@@ -542,13 +537,6 @@ void CCPFree( void* p )
 {
 	if( p )
 	{
-#if ENABLE_TELEMETRY_MEMORY_TRACKING
-		if ( CcpTelemetryIsConnected() )
-		{
-//			TracySecureFree( p );
-		}
-#endif
-
 		if( s_guardAllocations )
 		{
 			CCPFreeWithGuard( p );

CMakeLists.txt

@@ -105,6 +105,14 @@ if(WITH_TELEMETRY)
     find_package(Tracy CONFIG REQUIRED)
     target_compile_definitions(CcpCore PUBLIC CCP_TELEMETRY_ENABLED=1)
     target_link_libraries(CcpCore PUBLIC Tracy::TracyClient)
+    # Tracy's vcpkg package is always built as Release (with NDEBUG). CcpTelemetry.cpp
+    # must also be compiled with NDEBUG to match Tracy's struct layout: in 0.13.1 the
+    # Profiler class has a debug-only member (std::atomic_bool m_inUse, #ifndef NDEBUG)
+    # that shifts m_programNameLock and other trailing fields by 8 bytes, causing
+    # SetProgramName() — inlined from TracyProfiler.hpp — to lock the wrong memory
+    # address and fail with EINVAL. CCP_ASSERT_ENABLED is set explicitly via CMake so
+    # CCP_ASSERT macros are unaffected by this NDEBUG definition.
+    set_source_files_properties(CcpTelemetry.cpp PROPERTIES COMPILE_DEFINITIONS NDEBUG)
 else()
     target_compile_definitions(CcpCore PUBLIC CCP_TELEMETRY_ENABLED=0)
 endif()

CcpTelemetry.cpp

@@ -22,7 +22,7 @@ std::atomic<ProfilerState> s_profilerState{ProfilerState::Stopped};
 
 FiberNameStore s_fiberNameStore; // Persisted fiber name string store, including the empty "root" fiber name
 
-thread_local FiberNameStore::const_iterator t_activeFiber{ s_fiberNameStore.begin() }; // default to having no fiber
+thread_local FiberNameStore::const_iterator t_activeFiber{ s_fiberNameStore.end() }; // default to having no fiber
 
 template<>
 struct std::less<FiberNameStore::const_iterator>
@@ -35,7 +35,7 @@ struct std::less<FiberNameStore::const_iterator>
 
 typedef std::map<FiberNameStore::const_iterator, std::stack<TelemetryZone>> TaskletZoneStore;
 thread_local TaskletZoneStore t_taskletZoneStore; // Per-thread record of zones instrumented from python
-thread_local TaskletZoneStore::iterator t_activeTaskletZoneStore{ t_taskletZoneStore.begin() };
+thread_local TaskletZoneStore::iterator t_activeTaskletZoneStore{ t_taskletZoneStore.end() };
 thread_local std::set<void*> t_manuallyTrackedZones; // Keep track of zones created through `CcpTelemetryEnterZone` to ensure that we only pop off the zone store's stack when leaving a manually created zone
 
 constexpr std::chrono::milliseconds s_cleanupDelay{5000};
@@ -85,6 +85,11 @@ bool CcpTelemetryIsStarted()
 	return s_profilerState.load( std::memory_order_acquire ) == ProfilerState::Started;
 }
 
+bool CcpMemoryProfilingIsEnabled()
+{
+	return s_config.trackMemoryAllocations;
+}
+
 void CcpRegisterMutex( class CcpMutex& m, const char* owner, const char* name )
 {
 	// Store the name for future Telemetry sessions, even if we're already connected.
@@ -214,6 +219,7 @@ void CcpTelemetryTick()
 		{
 			( *handler.first )( CCP_TELEMETRY_STOPPED, handler.second );
 		}
+		break;
 	}
 	case ProfilerState::Stopped:
 		// Nothing to do
@@ -224,6 +230,21 @@ void CcpTelemetryTick()
 	}
 }
 
+void CcpTelemetryTrackAllocation( void* p, size_t size )
+{
+	if ( CcpMemoryProfilingIsEnabled() && CcpTelemetryIsConnected() ) {
+		TracySecureAlloc( p, size );
+	}
+}
+
+void CcpTelemetryTrackDeallocation( void* p )
+{
+	if ( p && CcpMemoryProfilingIsEnabled() && CcpTelemetryIsConnected() )
+	{
+		TracySecureFree( p );
+	}
+}
+
 uint32_t CcpTelemetryGetTickCount()
 {
 	return s_telemetryTick;
@@ -274,7 +295,9 @@ void CcpTelemetrySetActiveFiber( FiberNameStore::const_iterator elem )
 	if ( existing != t_taskletZoneStore.end() && ! ( t_taskletZoneStore.key_comp()( t_activeFiber, existing->first ) ) )
 	{
 		t_activeTaskletZoneStore = existing;
-	} else {
+	}
+	else
+	{
 		t_activeTaskletZoneStore = t_taskletZoneStore.emplace_hint( existing, t_activeFiber, std::stack<TelemetryZone>() );
 	}
 //	CCP_LOG_CH( s_ch, "[Fiber %p] [Store %p] Setting active tasklet zone store", t_activeFiber, t_activeTaskletZoneStore );
@@ -383,7 +406,9 @@ void CcpTelemetryLeaveZone( void* key )
 		{
 			t_activeTaskletZoneStore->second.pop();
 		}
-		t_manuallyTrackedZones.erase( key );
+		if ( t_activeTaskletZoneStore->second.empty() ) {
+			t_manuallyTrackedZones.erase( key );
+		}
 	}
 }
 
@@ -415,6 +440,11 @@ bool CcpTelemetryIsStarted()
 	return false;
 }
 
+bool CcpMemoryProfilingIsEnabled()
+{
+	return false;
+}
+
 void CcpRegisterThread( CcpThreadId_t threadId, const char* name )
 {
 }

include/CCPLog.h

@@ -187,7 +187,7 @@ CARBON_CORE_API const char* GetLastErrorMessage();
 // Throws a std exception with string 'message' and logs out the 'message'
 inline void Throw( const char* message )
 {
-	CCP_LOGERR( message );
+	CCP_LOGERR( "%s", message );
 	CCP_LOGWARN( "Exception thrown" );
 	throw std::runtime_error( message );
 }

include/CcpTelemetry.h

@@ -44,6 +44,7 @@ struct CcpTelemetryConfig
 {
 	std::string applicationName;
 	std::chrono::milliseconds captureDuration{};
+	bool trackMemoryAllocations{false};
 };
 
 [[deprecated( "Use `CcpStartTelemetry( const CcpTelemetryConfig& config ) instead" )]] CARBON_CORE_API bool CcpStartTelemetry( const char* server, int connectionType, uint32_t maxThreadCount );
@@ -66,6 +67,7 @@ CARBON_CORE_API void CcpUnregisterTelemetryEventHandler( CcpOnTelemetryEventHand
 CARBON_CORE_API bool CcpTelemetryIsConnectionRequested();
 CARBON_CORE_API bool CcpTelemetryIsConnected();
 CARBON_CORE_API bool CcpTelemetryIsStarted();
+CARBON_CORE_API bool CcpMemoryProfilingIsEnabled();
 
 CARBON_CORE_API void CcpTelemetrySetActiveFiber( const std::string& name );
 CARBON_CORE_API const std::string& CcpTelemetryGetActiveFiber();
@@ -95,4 +97,6 @@ CARBON_CORE_API void CcpTelemetryEnterZone( void* key, const char* name, const c
 CARBON_CORE_API void CcpTelemetryLeaveZone( void* key );
 CARBON_CORE_API void CcpTelemetryZoneAddText( void* key, const char* text );
 
+void CcpTelemetryTrackAllocation( void*, size_t );
+void CcpTelemetryTrackDeallocation( void* );
 #endif

tests/CCPLog.cpp

@@ -42,7 +42,7 @@ class CCPLog : public ::testing::Test
 TEST_F ( CCPLog, TestCanLogSingleLine )
 {
 	CCP::RegisterLogEcho( LogTracker, CCP::LOGTYPE_INFO, true );
-	const char *s = "One line";
+	constexpr const char *s = "One line";
 	CCP_LOG(s);
 
 	EXPECT_EQ( 1, logstack.size() );
@@ -52,7 +52,7 @@ TEST_F ( CCPLog, TestCanLogSingleLine )
 TEST_F ( CCPLog, TestDefaultLogLevelIsInfo )
 {
 	CCP::RegisterLogEcho( LogTracker, CCP::LOGTYPE_INFO, true );
-	const char *s = "One line";
+	constexpr const char *s = "One line";
 	CCP_LOG(s);
 
 	EXPECT_EQ( 1, logstack.size() );
@@ -116,15 +116,15 @@ TEST_F ( CCPLog, CanUnregisterCallbackHandler )
 
 TEST_F ( CCPLog, GetLastErrorMessageReturnsLastError )
 {
-	const char* expected = "Something has gone horribly wrong.";
-	CCP_LOGERR(expected);
+	constexpr const char* expected = "Something has gone horribly wrong.";
+	CCP_LOGERR( expected );
 	const char* actual = CCP::GetLastErrorMessage();
 	EXPECT_STREQ( expected, actual );
 }
 
 TEST_F ( CCPLog, ThrowLastErrorThrowsAnError )
 {
-	const char* error_str = "Something has gone horribly wrong.";
+	constexpr const char* error_str = "Something has gone horribly wrong.";
 	CCP_LOGERR( error_str );
 	EXPECT_ANY_THROW( {CCP::ThrowLastError();} );	
 }
@@ -133,7 +133,7 @@ TEST_F ( CCPLog, LogEnormousLine )
 {
 	CCP::RegisterLogEcho( LogTracker, CCP::LOGTYPE_INFO, true );
 	CCP::SetLogMainThreadId();
-	const char* enormous_line = 
+	constexpr const char* enormous_line =
 		"Testing a really long log line. The log server can't handle log lines\n"
 		"that are longer than 253 characters, so we need a test case for it.\n"
 		"Somewhere along the line we need to split the log message into several\n"

tests/CMakeLists.txt

@@ -3,6 +3,7 @@
 enable_testing()
 
 find_package(GTest CONFIG REQUIRED)
+find_package(lz4 CONFIG REQUIRED)
 add_executable(CcpCoreTest
     CcpAtomic.cpp
     CCPCallstack.cpp
@@ -19,8 +20,12 @@ add_executable(CcpCoreTest
     StringConversions.cpp
     TempFile.cpp
     CCPLog.cpp
+    TracyTestClient.cpp
 )
-target_link_libraries(CcpCoreTest PRIVATE CcpCore GTest::gtest GTest::gtest_main)
+target_link_libraries(CcpCoreTest PRIVATE CcpCore GTest::gtest GTest::gtest_main lz4::lz4)
+if(WIN32)
+    target_link_libraries(CcpCoreTest PRIVATE ws2_32)
+endif()
 if(APPLE)
     target_link_libraries(CcpCoreTest PRIVATE "-framework CoreFoundation")
 endif()