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;
 
+typedef HRESULT(WINAPI* SETTHREADDESCRIPTION)(HANDLE hThread,

[brucedawson, 2017/02/21 22:12:40]

Somewhere you need a comment saying which version of Windows 10 brought in this
feature.

[chengx, 2017/02/22 21:24:34]

Done.

+                                              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 127 matching lines @@
   // 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 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;

[brucedawson, 2017/02/21 22:12:40]

Oops! This will return early in those cases where SetThreadDescription would be
helpful!

You might want to update the comment, or mention elsewhere that
SetThreadDescription works even if no debugger is attached.

[chengx, 2017/02/22 21:24:34]

Done.

 
+  HMODULE kernal32dll = ::GetModuleHandle(L"Kernel32.dll");

[brucedawson, 2017/02/21 22:12:40]

Spelling - should be kernel32dll. Or "kernel32". Or, can call GetModuleHandle()
inline and avoid the temporary entirely.

[chengx, 2017/02/22 21:24:34]

Done.

+  if (kernal32dll) {
+    SETTHREADDESCRIPTION set_thread_description_ptr =

[brucedawson, 2017/02/21 22:12:40]

Consider using 'auto' for the type - no need to specify the type on the left and
right of the equals sign. I'd also ditch "_ptr" - it doesn't add value, IMHO.
Other uses of GetProcAddress use a _func suffix or no suffix.

[chengx, 2017/02/22 21:24:34]

Done.

+        reinterpret_cast<SETTHREADDESCRIPTION>(
+            ::GetProcAddress(kernal32dll, "SetThreadDescription"));
+    base::StringPiece name_string(name);
+    std::wstring name_wstring = base::UTF8ToWide(name_string);

[brucedawson, 2017/02/21 22:12:40]

The initialization of name_wstring should be inside the final pointer check so
it doesn't happen unless necessary. Also, is the name_string temporary needed?

[chengx, 2017/02/22 21:24:34]

Done.

+    if (set_thread_description_ptr) {
+      set_thread_description_ptr(GetCurrentThread(), name_wstring.c_str());
+      return;
+    }
+  }
+
   SetNameInternal(CurrentId(), name.c_str());
 }
 
 // static
 const char* PlatformThread::GetName() {
   return ThreadIdNameManager::GetInstance()->GetName(CurrentId());
 }
 
 // static
 bool PlatformThread::CreateWithPriority(size_t stack_size, Delegate* delegate,
@@ skipping 95 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