Changeset 86170 in vbox for trunk/src/VBox/Runtime/r3/win

Timestamp:

Sep 18, 2020 1:38:40 PM (4 years ago)

Author:

vboxsync

Message:

IPRT/win/thread: Use new SetThreadDescription to set thread names.

File:

• trunk/src/VBox/Runtime/r3/win/thread-win.cpp (modified) (6 diffs)

trunk/src/VBox/Runtime/r3/win/thread-win.cpp

@@ -50 +50 @@
 
 /*********************************************************************************************************************************
-*   Defined Constants And Macros                                                                                                 *
+*   Structures and Typedefs                                                                                                      *
+*********************************************************************************************************************************/
+/** SetThreadDescription */
+typedef HRESULT (WINAPI *PFNSETTHREADDESCRIPTION)(HANDLE hThread, WCHAR *pwszName); /* Since W10 1607 */
+
+
+/*********************************************************************************************************************************
+*   Global Variables                                                                                                             *
 *********************************************************************************************************************************/
 /** The TLS index allocated for storing the RTTHREADINT pointer. */
 static DWORD g_dwSelfTLS = TLS_OUT_OF_INDEXES;
+/** Pointer to SetThreadDescription (KERNEL32.DLL) if available. */
+static PFNSETTHREADDESCRIPTION g_pfnSetThreadDescription = NULL;
 
 
@@ -61 +70 @@
 static unsigned __stdcall rtThreadNativeMain(void *pvArgs) RT_NOTHROW_PROTO;
 static void rtThreadWinTellDebuggerThreadName(uint32_t idThread, const char *pszName);
+DECLINLINE(void) rtThreadWinSetThreadName(PRTTHREADINT pThread, DWORD idThread);
 
 
@@ -68 +78 @@
     if (g_dwSelfTLS == TLS_OUT_OF_INDEXES)
         return VERR_NO_TLS_FOR_SELF;
+
+    g_pfnSetThreadDescription = (PFNSETTHREADDESCRIPTION)GetProcAddress(g_hModKernel32, "SetThreadDescription");
     return VINF_SUCCESS;
 }
@@ -110 +122 @@
     if (!TlsSetValue(g_dwSelfTLS, pThread))
         return VERR_FAILED_TO_SET_SELF_TLS;
-    if (IsDebuggerPresent())
-        rtThreadWinTellDebuggerThreadName(GetCurrentThreadId(), pThread->szName);
+    rtThreadWinSetThreadName(pThread, GetCurrentThreadId());
     return VINF_SUCCESS;
 }
@@ -149 +160 @@
     {
 
+    }
+}
+
+
+/**
+ * Sets the thread name as best as we can.
+ */
+DECLINLINE(void) rtThreadWinSetThreadName(PRTTHREADINT pThread, DWORD idThread)
+{
+    if (IsDebuggerPresent())
+        rtThreadWinTellDebuggerThreadName(idThread, &pThread->szName[0]);
+
+    /* The SetThreadDescription API introduced in windows 10 1607 / server 2016
+       allows setting the thread name while the debugger isn't attached.  Works
+       with WinDbgX, VisualStudio 2017 v15.6+, and presumeably some recent windbg
+       version. */
+    if (g_pfnSetThreadDescription)
+    {
+        /* The name should be ASCII, so we just need to expand 'char' to 'WCHAR'. */
+        WCHAR wszName[RTTHREAD_NAME_LEN];
+        for (size_t i = 0; i < RTTHREAD_NAME_LEN; i++)
+            wszName[i] = pThread->szName[i];
+
+        HRESULT hrc = g_pfnSetThreadDescription(GetCurrentThread(), wszName);
+        Assert(SUCCEEDED(hrc)); RT_NOREF(hrc);
     }
 }
@@ -250 +286 @@
     if (!TlsSetValue(g_dwSelfTLS, pThread))
         AssertReleaseMsgFailed(("failed to set self TLS. lasterr=%d thread '%s'\n", GetLastError(), pThread->szName));
-    if (IsDebuggerPresent())
-        rtThreadWinTellDebuggerThreadName(dwThreadId, &pThread->szName[0]);
+    rtThreadWinSetThreadName(pThread, dwThreadId);
 
     int rc = rtThreadMain(pThread, dwThreadId, &pThread->szName[0]);