implement thread naming for Windows

Author: hyperblast

cpp/server/deadbeef/player_misc.cpp

@@ -68,7 +68,7 @@ ColumnsQueryPtr PlayerImpl::createColumnsQuery(const std::vector<std::string>& c
 
 std::unique_ptr<WorkQueue> PlayerImpl::createWorkQueue()
 {
-    return std::make_unique<ThreadWorkQueue>(MSRV_PROJECT_ID "-control");
+    return std::make_unique<ThreadWorkQueue>(MSRV_THREAD_NAME(MSRV_PROJECT_ID "-control"));
 }
 
 void PlayerImpl::connect()

cpp/server/server_host.cpp

@@ -17,7 +17,7 @@
 namespace msrv {
 
 ServerHost::ServerHost(Player* player)
-    : player_(player), utilityQueue_(8, MSRV_PROJECT_ID "-io")
+    : player_(player), utilityQueue_(8, MSRV_THREAD_NAME(MSRV_PROJECT_ID "-io"))
 {
     playerWorkQueue_ = player_->createWorkQueue();
     player_->onEvents([this](PlayerEvents event) { handlePlayerEvents(event); });

cpp/server/server_thread.cpp

@@ -11,7 +11,7 @@ ServerThread::ServerThread(ServerReadyCallback readyCallback)
       readyCallback_(std::move(readyCallback))
 {
     thread_ = std::thread([this] {
-        setThreadName(MSRV_PROJECT_ID "-server");
+        setThreadName(MSRV_THREAD_NAME(MSRV_PROJECT_ID "-server"));
         run();
     });
 }

cpp/server/system.hpp

@@ -18,8 +18,6 @@
 namespace msrv
 {
 
-inline void setThreadName(const char* name);
-
 template<typename Traits>
 class Handle
 {
@@ -94,7 +92,11 @@ class Handle
 
 #if MSRV_OS_POSIX
 
-void setThreadName(const char* name)
+#define MSRV_THREAD_NAME(s) s
+
+typedef const char* ThreadName;
+
+inline void setThreadName(ThreadName name)
 {
 #if defined(HAVE_PTHREAD_SETNAME_NP)
     (void) pthread_setname_np(pthread_self(), name);
@@ -132,10 +134,12 @@ inline ErrorCode lastSystemError() noexcept
 
 #if MSRV_OS_WINDOWS
 
-void setThreadName(const char* name)
-{
-    (void)name;
-}
+#define MSRV_THREAD_NAME_(s) L ## s
+#define MSRV_THREAD_NAME(s) MSRV_THREAD_NAME_(s)
+
+typedef const wchar_t* ThreadName;
+
+void setThreadName(ThreadName name);
 
 struct WindowsHandleTraits
 {

cpp/server/system_windows.cpp

@@ -4,6 +4,17 @@
 
 namespace msrv {
 
+typedef HRESULT (WINAPI *SetThreadDescriptionFunc)(HANDLE thread, LPCWSTR name);
+
+void setThreadName(ThreadName name)
+{
+    static auto setName = reinterpret_cast<SetThreadDescriptionFunc>(
+        GetProcAddress(LoadLibraryA("kernelbase.dll"), "SetThreadDescription"));
+
+    if (setName)
+        setName(GetCurrentThread(), name);
+}
+
 const char* formatError(ErrorCode errorCode, char* buffer, size_t size) noexcept
 {
     auto ret = ::FormatMessageA(

cpp/server/work_queue.cpp

@@ -8,7 +8,7 @@ namespace msrv {
 
 WorkQueue::~WorkQueue() = default;
 
-ThreadWorkQueue::ThreadWorkQueue(const char* name)
+ThreadWorkQueue::ThreadWorkQueue(ThreadName name)
 {
     thread_ = std::thread([this, name] {
         if (name)
@@ -62,7 +62,7 @@ void ThreadWorkQueue::run()
     }
 }
 
-ThreadPoolWorkQueue::ThreadPoolWorkQueue(size_t workers, const char* name)
+ThreadPoolWorkQueue::ThreadPoolWorkQueue(size_t workers, ThreadName name)
 {
     assert(workers > 0);
 

cpp/server/work_queue.hpp

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "defines.hpp"
+#include "system.hpp"
 
 #include <thread>
 #include <mutex>
@@ -29,7 +30,7 @@ class WorkQueue
 class ThreadWorkQueue : public WorkQueue
 {
 public:
-    explicit ThreadWorkQueue(const char* name = nullptr);
+    explicit ThreadWorkQueue(ThreadName name = nullptr);
     ~ThreadWorkQueue();
 
     void enqueue(WorkCallback callback) override;
@@ -48,7 +49,7 @@ class ThreadWorkQueue : public WorkQueue
 class ThreadPoolWorkQueue : public WorkQueue
 {
 public:
-    explicit ThreadPoolWorkQueue(size_t workers, const char* name = nullptr);
+    explicit ThreadPoolWorkQueue(size_t workers, ThreadName name = nullptr);
     ~ThreadPoolWorkQueue();
 
     void enqueue(WorkCallback callback) override;