Set names to runtime internal threads (#75113)

HJLeee · jkotas · web-flow · commit e013f9dfc31c · 2022-09-21T20:16:12.000-07:00
* Set names to runtime internal threads

* Fix MAC build

* Shorten ThreadPool thread names

* Fix not to return SetThreadDescription()

* Change SetThreadDescription to SetThreadName

* Set thread names inside thread functions

* Add missing name for MAC

* Move name change info thread function

Co-authored-by: Jan Kotas &lt;jkotas@microsoft.com&gt;
diff --git a/src/coreclr/debug/ee/rcthread.cpp b/src/coreclr/debug/ee/rcthread.cpp
@@ -1311,6 +1311,11 @@ void DebuggerRCThread::TemporaryHelperThreadMainLoop()
 
     DebuggerRCThread* t = (DebuggerRCThread*)g_pRCThread;
 
+    if (FAILED(SetThreadName(t->m_thread, W(".NET Debugger"))))
+    {
+        LOG((LF_CORDB, LL_INFO10000, "DebuggerRCThread name set failed\n"));
+    }
+
     t->ThreadProc(); // this thread is local, go and become the helper
 
     return 0;
@@ -1366,7 +1371,6 @@ HRESULT DebuggerRCThread::Start(void)
         {
             LOG((LF_CORDB, LL_EVERYTHING, "DebuggerRCThread failed, err=%d\n", GetLastError()));
             hr = HRESULT_FROM_GetLastError();
-
         }
         else
         {
diff --git a/src/coreclr/debug/shared/dbgtransportsession.cpp b/src/coreclr/debug/shared/dbgtransportsession.cpp
@@ -1227,6 +1227,8 @@ void DbgTransportSession::InitSessionState()
 // instance method version defined below for convenience in the implementation.
 DWORD WINAPI DbgTransportSession::TransportWorkerStatic(LPVOID pvContext)
 {
+    SetThreadName(GetCurrentThread(), W(".NET DebugPipe"));
+
     ((DbgTransportSession*)pvContext)->TransportWorker();
 
     // Nobody looks at this result, the choice of 0 is arbitrary.
diff --git a/src/coreclr/pal/src/synchmgr/synchmanager.cpp b/src/coreclr/pal/src/synchmgr/synchmanager.cpp
@@ -1707,6 +1707,10 @@ namespace CorUnix
             reinterpret_cast<CPalSynchronizationManager*>(pArg);
         CPalThread * pthrWorker = InternalGetCurrentThread();
 
+        InternalSetThreadDescription(pthrWorker,
+                                     PAL_GetCurrentThread(),
+                                     W(".NET SynchManager"));
+
         while (!fWorkerIsDone)
         {
             LONG lProcessCount;
diff --git a/src/coreclr/vm/eventing/eventpipe/ep-rt-coreclr.h b/src/coreclr/vm/eventing/eventpipe/ep-rt-coreclr.h
@@ -2047,6 +2047,14 @@ ep_rt_thread_create (
 	return result;
 }
 
+static
+inline
+void
+ep_rt_set_server_name()
+{
+	::SetThreadName(GetCurrentThread(), W(".NET EventPipe"));
+}
+
 static
 inline
 void
diff --git a/src/libraries/System.Private.CoreLib/src/System/Threading/PortableThreadPool.GateThread.cs b/src/libraries/System.Private.CoreLib/src/System/Threading/PortableThreadPool.GateThread.cs
@@ -239,7 +239,7 @@ private static void CreateGateThread(PortableThreadPool threadPoolInstance)
                     {
                         IsThreadPoolThread = true,
                         IsBackground = true,
-                        Name = ".NET ThreadPool Gate"
+                        Name = ".NET TP Gate"
                     };
                     gateThread.UnsafeStart();
                 }
diff --git a/src/libraries/System.Private.CoreLib/src/System/Threading/PortableThreadPool.WaitThread.cs b/src/libraries/System.Private.CoreLib/src/System/Threading/PortableThreadPool.WaitThread.cs
@@ -187,7 +187,7 @@ public WaitThread()
                 {
                     IsThreadPoolThread = true,
                     IsBackground = true,
-                    Name = ".NET ThreadPool Wait"
+                    Name = ".NET TP Wait"
                 };
                 waitThread.UnsafeStart();
             }
diff --git a/src/libraries/System.Private.CoreLib/src/System/Threading/ThreadPoolWorkQueue.cs b/src/libraries/System.Private.CoreLib/src/System/Threading/ThreadPoolWorkQueue.cs
@@ -1355,7 +1355,7 @@ internal static void PerformWaitOrTimerCallback(_ThreadPoolWaitOrTimerCallback h
 
     public static partial class ThreadPool
     {
-        internal const string WorkerThreadName = ".NET ThreadPool Worker";
+        internal const string WorkerThreadName = ".NET TP Worker";
 
         internal static readonly ThreadPoolWorkQueue s_workQueue = new ThreadPoolWorkQueue();
 
diff --git a/src/mono/mono/eventpipe/ep-rt-mono.h b/src/mono/mono/eventpipe/ep-rt-mono.h
@@ -1359,6 +1359,14 @@ ep_rt_thread_create (
 	return false;
 }
 
+static
+inline
+void
+ep_rt_set_server_name()
+{
+	mono_native_thread_set_name(mono_native_thread_id_get(), ".NET EventPipe");
+}
+
 static
 inline
 void
diff --git a/src/native/eventpipe/ds-server.c b/src/native/eventpipe/ds-server.c
@@ -116,6 +116,8 @@ EP_RT_DEFINE_THREAD_FUNC (server_thread)
 {
 	EP_ASSERT (server_volatile_load_shutting_down_state () || ds_ipc_stream_factory_has_active_ports ());
 
+	ep_rt_set_server_name();
+
 	if (!ds_ipc_stream_factory_has_active_ports ()) {
 #ifndef DS_IPC_DISABLE_LISTEN_PORTS
 		DS_LOG_ERROR_0 ("Diagnostics IPC listener was undefined");
@@ -256,7 +258,7 @@ ds_server_shutdown (void)
 void
 ds_server_pause_for_diagnostics_monitor (void)
 {
-    _is_paused_for_startup = true;
+	_is_paused_for_startup = true;
 
 	if (ds_ipc_stream_factory_any_suspended_ports ()) {
 		EP_ASSERT (ep_rt_wait_event_is_valid (&_server_resume_runtime_startup_event));
@@ -278,7 +280,7 @@ ds_server_resume_runtime_startup (void)
 	ds_ipc_stream_factory_resume_current_port ();
 	if (!ds_ipc_stream_factory_any_suspended_ports () && ep_rt_wait_event_is_valid (&_server_resume_runtime_startup_event)) {
 		ep_rt_wait_event_set (&_server_resume_runtime_startup_event);
-        _is_paused_for_startup = false;
+		_is_paused_for_startup = false;
 	}
 }
 
diff --git a/src/native/eventpipe/ep-rt.h b/src/native/eventpipe/ep-rt.h
@@ -566,6 +566,10 @@ ep_rt_thread_create (
 	EventPipeThreadType thread_type,
 	void *id);
 
+static
+void
+ep_rt_set_server_name (void);
+
 static
 void
 ep_rt_thread_sleep (uint64_t ns);
diff --git a/src/native/libs/System.Native/pal_signal.c b/src/native/libs/System.Native/pal_signal.c
@@ -313,6 +313,14 @@ static void* SignalHandlerLoop(void* arg)
     free(arg);
     assert(pipeFd >= 0);
 
+    char* threadName = ".NET SigHandler";
+#if defined(__linux__) || defined(__FreeBSD__)
+    pthread_setname_np(pthread_self(), threadName);
+#endif
+#if defined(__APPLE__)
+    pthread_setname_np(threadName);
+#endif
+
     // Continually read a signal code from the signal pipe and process it,
     // until the pipe is closed.
     while (true)

Original file line number	Diff line number	Diff line change
`@@ -1311,6 +1311,11 @@ void DebuggerRCThread::TemporaryHelperThreadMainLoop()`
`1311`	`1311`
`1312`	`1312`	`DebuggerRCThread* t = (DebuggerRCThread*)g_pRCThread;`
`1313`	`1313`
	`1314`	`+ if (FAILED(SetThreadName(t->m_thread, W(".NET Debugger"))))`
	`1315`	`+ {`
	`1316`	`+ LOG((LF_CORDB, LL_INFO10000, "DebuggerRCThread name set failed\n"));`
	`1317`	`+ }`
	`1318`	`+`
`1314`	`1319`	`t->ThreadProc(); // this thread is local, go and become the helper`
`1315`	`1320`
`1316`	`1321`	`return 0;`
`@@ -1366,7 +1371,6 @@ HRESULT DebuggerRCThread::Start(void)`
`1366`	`1371`	`{`
`1367`	`1372`	`LOG((LF_CORDB, LL_EVERYTHING, "DebuggerRCThread failed, err=%d\n", GetLastError()));`
`1368`	`1373`	`hr = HRESULT_FROM_GetLastError();`
`1369`		`-`
`1370`	`1374`	`}`
`1371`	`1375`	`else`
`1372`	`1376`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1227,6 +1227,8 @@ void DbgTransportSession::InitSessionState()`
`1227`	`1227`	`// instance method version defined below for convenience in the implementation.`
`1228`	`1228`	`DWORD WINAPI DbgTransportSession::TransportWorkerStatic(LPVOID pvContext)`
`1229`	`1229`	`{`
	`1230`	`+ SetThreadName(GetCurrentThread(), W(".NET DebugPipe"));`
	`1231`	`+`
`1230`	`1232`	`((DbgTransportSession*)pvContext)->TransportWorker();`
`1231`	`1233`
`1232`	`1234`	`// Nobody looks at this result, the choice of 0 is arbitrary.`
Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ private static void CreateGateThread(PortableThreadPool threadPoolInstance)`
`239`	`239`	`{`
`240`	`240`	`IsThreadPoolThread = true,`
`241`	`241`	`IsBackground = true,`
`242`		`- Name = ".NET ThreadPool Gate"`
	`242`	`+ Name = ".NET TP Gate"`
`243`	`243`	`};`
`244`	`244`	`gateThread.UnsafeStart();`
`245`	`245`	`}`
Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,7 @@ public WaitThread()`
`187`	`187`	`{`
`188`	`188`	`IsThreadPoolThread = true,`
`189`	`189`	`IsBackground = true,`
`190`		`- Name = ".NET ThreadPool Wait"`
	`190`	`+ Name = ".NET TP Wait"`
`191`	`191`	`};`
`192`	`192`	`waitThread.UnsafeStart();`
`193`	`193`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1355,7 +1355,7 @@ internal static void PerformWaitOrTimerCallback(_ThreadPoolWaitOrTimerCallback h`
`1355`	`1355`
`1356`	`1356`	`public static partial class ThreadPool`
`1357`	`1357`	`{`
`1358`		`- internal const string WorkerThreadName = ".NET ThreadPool Worker";`
	`1358`	`+ internal const string WorkerThreadName = ".NET TP Worker";`
`1359`	`1359`
`1360`	`1360`	`internal static readonly ThreadPoolWorkQueue s_workQueue = new ThreadPoolWorkQueue();`
`1361`	`1361`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,8 @@ EP_RT_DEFINE_THREAD_FUNC (server_thread)`
`116`	`116`	`{`
`117`	`117`	`EP_ASSERT (server_volatile_load_shutting_down_state () \|\| ds_ipc_stream_factory_has_active_ports ());`
`118`	`118`
	`119`	`+ ep_rt_set_server_name();`
	`120`	`+`
`119`	`121`	`if (!ds_ipc_stream_factory_has_active_ports ()) {`
`120`	`122`	`#ifndef DS_IPC_DISABLE_LISTEN_PORTS`
`121`	`123`	`DS_LOG_ERROR_0 ("Diagnostics IPC listener was undefined");`
`@@ -256,7 +258,7 @@ ds_server_shutdown (void)`
`256`	`258`	`void`
`257`	`259`	`ds_server_pause_for_diagnostics_monitor (void)`
`258`	`260`	`{`
`259`		`- _is_paused_for_startup = true;`
	`261`	`+ _is_paused_for_startup = true;`
`260`	`262`
`261`	`263`	`if (ds_ipc_stream_factory_any_suspended_ports ()) {`
`262`	`264`	`EP_ASSERT (ep_rt_wait_event_is_valid (&_server_resume_runtime_startup_event));`
`@@ -278,7 +280,7 @@ ds_server_resume_runtime_startup (void)`
`278`	`280`	`ds_ipc_stream_factory_resume_current_port ();`
`279`	`281`	`if (!ds_ipc_stream_factory_any_suspended_ports () && ep_rt_wait_event_is_valid (&_server_resume_runtime_startup_event)) {`
`280`	`282`	`ep_rt_wait_event_set (&_server_resume_runtime_startup_event);`
`281`		`- _is_paused_for_startup = false;`
	`283`	`+ _is_paused_for_startup = false;`
`282`	`284`	`}`
`283`	`285`	`}`
`284`	`286`