Changeset 35419 in webkit for trunk/JavaScriptCore/wtf/ThreadingWin.cpp

Timestamp:

Jul 29, 2008, 9:11:00 AM (17 years ago)

Author:

Adam Roben

Message:

Add support for setting thread names on Windows

JavaScriptCore:

Add support for setting thread names on Windows

These thread names make it much easier to identify particular threads
in Visual Studio's Threads panel.

WTF::createThread now takes a const char* representing the thread's
name. On Windows, we throw a special exception to set this string as
the thread's name. Other platforms do nothing with this name for now.

Reviewed by Anders Carlsson.

• JavaScriptCore.exp: Export the new version of createThread that takes 3 arguments (the old one continues to be exported for backward compatibility).
• wtf/Threading.h: Add a threadName argument to createThread.

• wtf/ThreadingGtk.cpp: (WTF::createThread):
• wtf/ThreadingNone.cpp: (WTF::createThread): Updated for function signature change.

• wtf/ThreadingPthreads.cpp: (WTF::createThread): Updated for function signature change. We keep around the old 2-argument version of createThread for backward compatibility.

• wtf/ThreadingWin.cpp: (WTF::setThreadName): Added. This function's implementation came from MSDN. (WTF::initializeThreading): Set the name of the main thread. (WTF::createThread): Call setThreadName. We keep around the old 2-argument version of createThread for backward compatibility.

WebCore:

Add names for WebCore's threads

Reviewed by Anders Carlsson.

• loader/icon/IconDatabase.cpp: (WebCore::IconDatabase::open):
• storage/DatabaseThread.cpp: (WebCore::DatabaseThread::start):
• storage/LocalStorageThread.cpp: (WebCore::LocalStorageThread::start): Pass in names to createThread.

• platform/network/cf/ResourceHandleCFNet.cpp: (WebCore::runLoaderThread): (WebCore::ResourceHandle::loaderRunLoop): Changed to use WTF::createThread.

WebKit/win:

Export the new version of createThread

Reviewed by Anders Carlsson.

• WebKit.vcproj/WebKit.def:
• WebKit.vcproj/WebKit_debug.def: Also moved the old version of createThread into the deprecated section.

File:

• trunk/JavaScriptCore/wtf/ThreadingWin.cpp (modified) (4 diffs)

trunk/JavaScriptCore/wtf/ThreadingWin.cpp

@@ -78 +78 @@
 namespace WTF {
 
+// MS_VC_EXCEPTION, THREADNAME_INFO, and setThreadName all come from <http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx>.
+static const DWORD MS_VC_EXCEPTION = 0x406D1388;
+
+#pragma pack(push, 8)
+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;
+#pragma pack(pop)
+
+static void setThreadName(DWORD dwThreadID, LPCSTR szThreadName)
+{
+    THREADNAME_INFO info;
+    info.dwType = 0x1000;
+    info.szName = szThreadName;
+    info.dwThreadID = dwThreadID;
+    info.dwFlags = 0;
+
+    __try {
+        RaiseException(MS_VC_EXCEPTION, 0, sizeof(info)/sizeof(ULONG_PTR), reinterpret_cast<ULONG_PTR*>(&info));
+    } __except (EXCEPTION_CONTINUE_EXECUTION) {
+    }
+}
+
 Mutex* atomicallyInitializedStaticMutex;
 
@@ -96 +122 @@
         initializeMainThread();
         mainThreadIdentifier = currentThread();
+        setThreadName(mainThreadIdentifier, "Main Thread");
     }
 }
@@ -146 +173 @@
 }
 
-ThreadIdentifier createThread(ThreadFunction entryPoint, void* data)
-{
+ThreadIdentifier createThread(ThreadFunction entryPoint, void* data, const char* threadName)
+{
+    // Visual Studio has a 31-character limit on thread names. Longer names will
+    // be truncated silently, but we'd like callers to know about the limit.
+    ASSERT_ARG(szThreadName, strlen(szThreadName) <= 31);
+
     unsigned threadIdentifier = 0;
     ThreadIdentifier threadID = 0;
@@ -157 +188 @@
     }
 
+    if (threadName)
+        setThreadName(threadIdentifier, threadName);
+
     threadID = static_cast<ThreadIdentifier>(threadIdentifier);
     storeThreadHandleByIdentifier(threadIdentifier, threadHandle);
 
     return threadID;
+}
+
+// This function is deprecated but needs to be kept around for backward
+// compatibility. Use the 3-argument version of createThread above.
+ThreadIdentifier createThread(ThreadFunction entryPoint, void* data)
+{
+    return createThread(entryPoint, data, 0);
 }