Use Windows 10 thread naming API, SetThreadDescription

base/threading/platform_thread_win.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/threading/platform_thread.h"
 
 #include <stddef.h>
 
 #include "base/debug/activity_tracker.h"
 #include "base/debug/alias.h"
 #include "base/debug/profiler.h"
 #include "base/logging.h"
+#include "base/strings/string_piece.h"
+#include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_id_name_manager.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/tracked_objects.h"
 #include "base/win/scoped_handle.h"
 
 namespace base {
 
 namespace {
 
 // The information on how to set the thread name comes from
 // a MSDN article: http://msdn2.microsoft.com/en-us/library/xcb2z8hs.aspx
 const DWORD kVCThreadNameException = 0x406D1388;
 
 typedef struct tagTHREADNAME_INFO {
   DWORD dwType;  // Must be 0x1000.
   LPCSTR szName;  // Pointer to name (in user addr space).
   DWORD dwThreadID;  // Thread ID (-1=caller thread).
   DWORD dwFlags;  // Reserved for future use, must be zero.
 } THREADNAME_INFO;
 
+// The SetThreadDescription API was brought in version 1607 of Windows 10.
+typedef HRESULT(WINAPI* SETTHREADDESCRIPTION)(HANDLE hThread,
+                                              PCWSTR lpThreadDescription);
+
 // This function has try handling, so it is separated out of its caller.
 void SetNameInternal(PlatformThreadId thread_id, const char* name) {
   THREADNAME_INFO info;
   info.dwType = 0x1000;
   info.szName = name;
   info.dwThreadID = thread_id;
   info.dwFlags = 0;
 
   __try {
     RaiseException(kVCThreadNameException, 0, sizeof(info)/sizeof(DWORD),
@@ skipping 122 matching lines @@
 
   // On Windows only, we don't need to tell the profiler about the "BrokerEvent"
   // thread, as it exists only in the chrome.exe image, and never spawns or runs
   // tasks (items which could be profiled).  This test avoids the notification,
   // which would also (as a side effect) initialize the profiler in this unused
   // context, including setting up thread local storage, etc.  The performance
   // impact is not terrible, but there is no reason to do initialize it.
   if (name != "BrokerEvent")
     tracked_objects::ThreadData::InitializeThreadContext(name);
 
+  // The SetThreadDescription API works even if no debugger is attached. Once
+  // tool support cataches up, e.g., the debugger in Visual Studio, the

[brucedawson, 2017/02/22 21:36:10]

We won't be retiring the RaiseException technique anytime soon because we still
want to be able to debug on older versions of Windows.

[chengx, 2017/02/22 23:20:28]

Done.

+  // SetNameInternal function below may be retired.
+  HMODULE kernel32dll = ::GetModuleHandle(L"Kernel32.dll");
+  if (kernel32dll) {

[brucedawson, 2017/02/22 21:36:10]

Note that this check can be omitted. It often is in Chrome, because kernel32.dll
will *always* be present.

+    auto set_thread_description_func = reinterpret_cast<SETTHREADDESCRIPTION>(
+        ::GetProcAddress(kernel32dll, "SetThreadDescription"));
+    if (set_thread_description_func) {
+      base::StringPiece name_string(name);
+      set_thread_description_func(GetCurrentThread(),
+                                  base::UTF8ToWide(name_string).c_str());
+    }
+  }
+
   // The debugger needs to be around to catch the name in the exception.  If
   // there isn't a debugger, we are just needlessly throwing an exception.
   // If this image file is instrumented, we raise the exception anyway
   // to provide the profiler with human-readable thread names.
   if (!::IsDebuggerPresent() && !base::debug::IsBinaryInstrumented())
     return;
 
   SetNameInternal(CurrentId(), name.c_str());
 }
 
@@ skipping 102 matching lines @@
       return ThreadPriority::REALTIME_AUDIO;
     case THREAD_PRIORITY_ERROR_RETURN:
       DPCHECK(false) << "GetThreadPriority error";  // Falls through.
     default:
       NOTREACHED() << "Unexpected priority: " << priority;
       return ThreadPriority::NORMAL;
   }
 }
 
 }  // namespace base