platform_thread_win.cc revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/platform_thread.h" 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/debug/alias.h" 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/debug/profiler.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/threading/thread_id_name_manager.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/thread_restrictions.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/tracked_objects.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/win/windows_version.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The information on how to set the thread name comes from 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a MSDN article: http://msdn2.microsoft.com/en-us/library/xcb2z8hs.aspx 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const DWORD kVCThreadNameException = 0x406D1388; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct tagTHREADNAME_INFO { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DWORD dwType; // Must be 0x1000. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LPCSTR szName; // Pointer to name (in user addr space). 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DWORD dwThreadID; // Thread ID (-1=caller thread). 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DWORD dwFlags; // Reserved for future use, must be zero. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} THREADNAME_INFO; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This function has try handling, so it is separated out of its caller. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SetNameInternal(PlatformThreadId thread_id, const char* name) { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) THREADNAME_INFO info; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) info.dwType = 0x1000; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) info.szName = name; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) info.dwThreadID = thread_id; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) info.dwFlags = 0; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) __try { 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RaiseException(kVCThreadNameException, 0, sizeof(info)/sizeof(DWORD), 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reinterpret_cast<DWORD_PTR*>(&info)); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } __except(EXCEPTION_CONTINUE_EXECUTION) { 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct ThreadParams { 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThread::Delegate* delegate; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool joinable; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)DWORD __stdcall ThreadFunc(void* params) { 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ThreadParams* thread_params = static_cast<ThreadParams*>(params); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThread::Delegate* delegate = thread_params->delegate; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!thread_params->joinable) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ThreadRestrictions::SetSingletonAllowed(false); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delete thread_params; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delegate->ThreadMain(); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// CreateThreadInternal() matches PlatformThread::Create(), except that 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |out_thread_handle| may be NULL, in which case a non-joinable thread is 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// created. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool CreateThreadInternal(size_t stack_size, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThread::Delegate* delegate, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThreadHandle* out_thread_handle) { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThreadHandle thread_handle; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int flags = 0; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (stack_size > 0 && base::win::GetVersion() >= base::win::VERSION_XP) { 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) flags = STACK_SIZE_PARAM_IS_A_RESERVATION; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) stack_size = 0; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ThreadParams* params = new ThreadParams; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) params->delegate = delegate; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) params->joinable = out_thread_handle != NULL; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Using CreateThread here vs _beginthreadex makes thread creation a bit 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // faster and doesn't require the loader lock to be available. Our code will 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have to work running on CreateThread() threads anyway, since we run code 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // on the Windows thread pool, etc. For some background on the difference: 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // http://www.microsoft.com/msj/1099/win32/win321099.aspx 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) thread_handle = CreateThread( 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NULL, stack_size, ThreadFunc, params, flags, NULL); 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!thread_handle) { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delete params; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return false; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (out_thread_handle) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) *out_thread_handle = thread_handle; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CloseHandle(thread_handle); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PlatformThreadId PlatformThread::CurrentId() { 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return GetCurrentThreadId(); 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PlatformThread::YieldCurrentThread() { 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ::Sleep(0); 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PlatformThread::Sleep(TimeDelta duration) { 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ::Sleep(duration.InMillisecondsRoundedUp()); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PlatformThread::SetName(const char* name) { 1172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ThreadIdNameManager::GetInstance()->SetName(CurrentId(), name); 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // On Windows only, we don't need to tell the profiler about the "BrokerEvent" 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // thread, as it exists only in the chrome.exe image, and never spawns or runs 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // tasks (items which could be profiled). This test avoids the notification, 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which would also (as a side effect) initialize the profiler in this unused 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // context, including setting up thread local storage, etc. The performance 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // impact is not terrible, but there is no reason to do initialize it. 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (0 != strcmp(name, "BrokerEvent")) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) tracked_objects::ThreadData::InitializeThreadContext(name); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The debugger needs to be around to catch the name in the exception. If 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // there isn't a debugger, we are just needlessly throwing an exception. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this image file is instrumented, we raise the exception anyway 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to provide the profiler with human-readable thread names. 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!::IsDebuggerPresent() && !base::debug::IsBinaryInstrumented()) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SetNameInternal(CurrentId(), name); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const char* PlatformThread::GetName() { 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return ThreadIdNameManager::GetInstance()->GetName(CurrentId()); 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PlatformThread::Create(size_t stack_size, Delegate* delegate, 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThreadHandle* thread_handle) { 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(thread_handle); 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return CreateThreadInternal(stack_size, delegate, thread_handle); 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PlatformThread::CreateWithPriority(size_t stack_size, Delegate* delegate, 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformThreadHandle* thread_handle, 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ThreadPriority priority) { 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool result = Create(stack_size, delegate, thread_handle); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (result) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SetThreadPriority(*thread_handle, priority); 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return result; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PlatformThread::CreateNonJoinable(size_t stack_size, Delegate* delegate) { 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return CreateThreadInternal(stack_size, delegate, NULL); 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PlatformThread::Join(PlatformThreadHandle thread_handle) { 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(thread_handle); 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(willchan): Enable this check once I can get it to work for Windows 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // shutdown. 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Joining another thread may block the current thread for a long time, since 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the thread referred to by |thread_handle| may still be running long-lived / 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // blocking tasks. 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if 0 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ThreadRestrictions::AssertIOAllowed(); 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Wait for the thread to exit. It should already have terminated but make 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sure this assumption is valid. 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DWORD result = WaitForSingleObject(thread_handle, INFINITE); 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (result != WAIT_OBJECT_0) { 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Debug info for bug 127931. 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DWORD error = GetLastError(); 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) debug::Alias(&error); 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) debug::Alias(&result); 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) debug::Alias(&thread_handle); 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CHECK(false); 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CloseHandle(thread_handle); 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PlatformThread::SetThreadPriority(PlatformThreadHandle handle, 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ThreadPriority priority) { 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) switch (priority) { 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case kThreadPriority_Normal: 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ::SetThreadPriority(handle, THREAD_PRIORITY_NORMAL); 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case kThreadPriority_RealtimeAudio: 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ::SetThreadPriority(handle, THREAD_PRIORITY_TIME_CRITICAL); 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 206