X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8907154c1a8a6882c6797d1f16393ddfb23e7f3a..b2edb8f3c524f302b727386bb0a694c44fb57e7d:/src/msw/thread.cpp diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index 602968aca6..75c4854bac 100644 --- a/src/msw/thread.cpp +++ b/src/msw/thread.cpp @@ -21,20 +21,24 @@ #pragma hdrstop #endif +#if wxUSE_THREADS + +#include "wx/thread.h" + #ifndef WX_PRECOMP #include "wx/intl.h" #include "wx/app.h" + #include "wx/module.h" #endif -#if wxUSE_THREADS - #include "wx/apptrait.h" +#include "wx/scopeguard.h" #include "wx/msw/private.h" #include "wx/msw/missing.h" +#include "wx/msw/seh.h" -#include "wx/module.h" -#include "wx/thread.h" +#include "wx/except.h" // must have this symbol defined to get _beginthread/_endthread declarations #ifndef _MT @@ -71,7 +75,8 @@ // this is where _beginthreadex() is declared #include - // the return type of the thread function entry point + // the return type of the thread function entry point: notice that this + // type can't hold a pointer under Win64 typedef unsigned THREAD_RETVAL; // the calling convention of the thread function entry point @@ -82,6 +87,8 @@ #define THREAD_CALLCONV WINAPI #endif +static const THREAD_RETVAL THREAD_ERROR_EXIT = (THREAD_RETVAL)-1; + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -106,7 +113,7 @@ static DWORD gs_tlsThisThread = 0xFFFFFFFF; // id of the main thread - the one which can call GUI functions without first // calling wxMutexGuiEnter() -static DWORD gs_idMainThread = 0; +wxThreadIdType wxThread::ms_idMainThread = 0; // if it's false, some secondary thread is holding the GUI lock static bool gs_bGuiOwnedByMainThread = true; @@ -138,7 +145,7 @@ static bool gs_waitingForThread = false; // wxCriticalSection // ---------------------------------------------------------------------------- -wxCriticalSection::wxCriticalSection() +wxCriticalSection::wxCriticalSection( wxCriticalSectionType WXUNUSED(critSecType) ) { wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer), wxCriticalSectionBufferTooSmall ); @@ -174,7 +181,8 @@ public: bool IsOk() const { return m_mutex != NULL; } wxMutexError Lock() { return LockTimeout(INFINITE); } - wxMutexError TryLock() { return LockTimeout(0); } + wxMutexError Lock(unsigned long ms) { return LockTimeout(ms); } + wxMutexError TryLock(); wxMutexError Unlock(); private: @@ -182,24 +190,31 @@ private: HANDLE m_mutex; - DECLARE_NO_COPY_CLASS(wxMutexInternal) + unsigned long m_owningThread; + wxMutexType m_type; + + wxDECLARE_NO_COPY_CLASS(wxMutexInternal); }; // all mutexes are recursive under Win32 so we don't use mutexType -wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(mutexType)) +wxMutexInternal::wxMutexInternal(wxMutexType mutexType) { // create a nameless (hence intra process and always private) mutex m_mutex = ::CreateMutex ( NULL, // default secutiry attributes - false, // not initially locked + FALSE, // not initially locked NULL // no name ); + m_type = mutexType; + m_owningThread = 0; + if ( !m_mutex ) { - wxLogLastError(_T("CreateMutex()")); + wxLogLastError(wxT("CreateMutex()")); } + } wxMutexInternal::~wxMutexInternal() @@ -208,51 +223,73 @@ wxMutexInternal::~wxMutexInternal() { if ( !::CloseHandle(m_mutex) ) { - wxLogLastError(_T("CloseHandle(mutex)")); + wxLogLastError(wxT("CloseHandle(mutex)")); } } } +wxMutexError wxMutexInternal::TryLock() +{ + const wxMutexError rc = LockTimeout(0); + + // we have a special return code for timeout in this case + return rc == wxMUTEX_TIMEOUT ? wxMUTEX_BUSY : rc; +} + wxMutexError wxMutexInternal::LockTimeout(DWORD milliseconds) { - DWORD rc = ::WaitForSingleObject(m_mutex, milliseconds); - if ( rc == WAIT_ABANDONED ) + if (m_type == wxMUTEX_DEFAULT) { - // the previous caller died without releasing the mutex, but now we can - // really lock it - wxLogDebug(_T("WaitForSingleObject() returned WAIT_ABANDONED")); - - // use 0 timeout, normally we should always get it - rc = ::WaitForSingleObject(m_mutex, 0); + // Don't allow recursive + if (m_owningThread != 0) + { + if (m_owningThread == wxThread::GetCurrentId()) + return wxMUTEX_DEAD_LOCK; + } } + DWORD rc = ::WaitForSingleObject(m_mutex, milliseconds); switch ( rc ) { + case WAIT_ABANDONED: + // the previous caller died without releasing the mutex, so even + // though we did get it, log a message about this + wxLogDebug(wxT("WaitForSingleObject() returned WAIT_ABANDONED")); + // fall through + case WAIT_OBJECT_0: // ok break; case WAIT_TIMEOUT: - return wxMUTEX_BUSY; + return wxMUTEX_TIMEOUT; - case WAIT_ABANDONED: // checked for above default: wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock")); // fall through case WAIT_FAILED: - wxLogLastError(_T("WaitForSingleObject(mutex)")); + wxLogLastError(wxT("WaitForSingleObject(mutex)")); return wxMUTEX_MISC_ERROR; } + if (m_type == wxMUTEX_DEFAULT) + { + // required for checking recursiveness + m_owningThread = wxThread::GetCurrentId(); + } + return wxMUTEX_NO_ERROR; } wxMutexError wxMutexInternal::Unlock() { + // required for checking recursiveness + m_owningThread = 0; + if ( !::ReleaseMutex(m_mutex) ) { - wxLogLastError(_T("ReleaseMutex()")); + wxLogLastError(wxT("ReleaseMutex()")); return wxMUTEX_MISC_ERROR; } @@ -291,7 +328,7 @@ public: private: HANDLE m_semaphore; - DECLARE_NO_COPY_CLASS(wxSemaphoreInternal) + wxDECLARE_NO_COPY_CLASS(wxSemaphoreInternal); }; wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount) @@ -313,7 +350,7 @@ wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount) #endif if ( !m_semaphore ) { - wxLogLastError(_T("CreateSemaphore()")); + wxLogLastError(wxT("CreateSemaphore()")); } } @@ -323,7 +360,7 @@ wxSemaphoreInternal::~wxSemaphoreInternal() { if ( !::CloseHandle(m_semaphore) ) { - wxLogLastError(_T("CloseHandle(semaphore)")); + wxLogLastError(wxT("CloseHandle(semaphore)")); } } } @@ -341,7 +378,7 @@ wxSemaError wxSemaphoreInternal::WaitTimeout(unsigned long milliseconds) return wxSEMA_TIMEOUT; default: - wxLogLastError(_T("WaitForSingleObject(semaphore)")); + wxLogLastError(wxT("WaitForSingleObject(semaphore)")); } return wxSEMA_MISC_ERROR; @@ -351,14 +388,22 @@ wxSemaError wxSemaphoreInternal::Post() { #if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300) if ( !::ReleaseSemaphore(m_semaphore, 1, NULL /* ptr to previous count */) ) -#endif { - wxLogLastError(_T("ReleaseSemaphore")); - - return wxSEMA_MISC_ERROR; + if ( GetLastError() == ERROR_TOO_MANY_POSTS ) + { + return wxSEMA_OVERFLOW; + } + else + { + wxLogLastError(wxT("ReleaseSemaphore")); + return wxSEMA_MISC_ERROR; + } } return wxSEMA_NO_ERROR; +#else + return wxSEMA_MISC_ERROR; +#endif } // ---------------------------------------------------------------------------- @@ -427,9 +472,16 @@ public: HANDLE GetHandle() const { return m_hThread; } DWORD GetId() const { return m_tid; } - // thread function + // the thread function forwarding to DoThreadStart static THREAD_RETVAL THREAD_CALLCONV WinThreadStart(void *thread); + // really start the thread (if it's not already dead) + static THREAD_RETVAL DoThreadStart(wxThread *thread); + + // call OnExit() on the thread + static void DoThreadOnExit(wxThread *thread); + + void KeepAlive() { if ( m_thread->IsDetached() ) @@ -455,7 +507,7 @@ private: // reaches 0 we kill the owning wxThread -- and die ourselves with it LONG m_nRef; - DECLARE_NO_COPY_CLASS(wxThreadInternal) + wxDECLARE_NO_COPY_CLASS(wxThreadInternal); }; // small class which keeps a thread alive during its lifetime @@ -471,45 +523,77 @@ private: wxThreadInternal& m_thrImpl; }; - -THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) +/* static */ +void wxThreadInternal::DoThreadOnExit(wxThread *thread) { - THREAD_RETVAL rc; + wxTRY + { + thread->OnExit(); + } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) +} - wxThread * const thread = (wxThread *)param; +/* static */ +THREAD_RETVAL wxThreadInternal::DoThreadStart(wxThread *thread) +{ + wxON_BLOCK_EXIT1(DoThreadOnExit, thread); - // first of all, check whether we hadn't been cancelled already and don't - // start the user code at all then - const bool hasExited = thread->m_internal->GetState() == STATE_EXITED; + THREAD_RETVAL rc = THREAD_ERROR_EXIT; - if ( hasExited ) - { - rc = (THREAD_RETVAL)-1; - } - else // do run thread + wxTRY { // store the thread object in the TLS if ( !::TlsSetValue(gs_tlsThisThread, thread) ) { wxLogSysError(_("Can not start thread: error writing TLS.")); - return (DWORD)-1; + return THREAD_ERROR_EXIT; } - rc = (THREAD_RETVAL)thread->Entry(); + rc = wxPtrToUInt(thread->Entry()); + } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) + + return rc; +} + +/* static */ +THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) +{ + THREAD_RETVAL rc = THREAD_ERROR_EXIT; + + wxThread * const thread = (wxThread *)param; + + // each thread has its own SEH translator so install our own a.s.a.p. + DisableAutomaticSETranslator(); + + // first of all, check whether we hadn't been cancelled already and don't + // start the user code at all then + const bool hasExited = thread->m_internal->GetState() == STATE_EXITED; + + // run the thread function itself inside a SEH try/except block + wxSEH_TRY + { + if ( hasExited ) + DoThreadOnExit(thread); + else + rc = DoThreadStart(thread); } + wxSEH_HANDLE(THREAD_ERROR_EXIT) - thread->OnExit(); // save IsDetached because thread object can be deleted by joinable // threads after state is changed to STATE_EXITED. - bool isDetached = thread->IsDetached(); - + const bool isDetached = thread->IsDetached(); if ( !hasExited ) { // enter m_critsect before changing the thread state - wxCriticalSectionLocker lock(thread->m_critsect); + // + // NB: can't use wxCriticalSectionLocker here as we use SEH and it's + // incompatible with C++ object dtors + thread->m_critsect.Enter(); thread->m_internal->SetState(STATE_EXITED); + thread->m_critsect.Leave(); } // the thread may delete itself now if it wants, we don't need it any more @@ -550,7 +634,7 @@ void wxThreadInternal::SetPriority(unsigned int priority) bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize) { wxASSERT_MSG( m_state == STATE_NEW && !m_hThread, - _T("Create()ing thread twice?") ); + wxT("Create()ing thread twice?") ); // for compilers which have it, we should use C RTL function for thread // creation instead of Win32 API one because otherwise we will have memory @@ -602,7 +686,7 @@ bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize) wxThreadError wxThreadInternal::Kill() { - if ( !::TerminateThread(m_hThread, (DWORD)-1) ) + if ( !::TerminateThread(m_hThread, THREAD_ERROR_EXIT) ) { wxLogSysError(_("Couldn't terminate thread")); @@ -628,7 +712,7 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, // from Wait()) or ask it to terminate (when called from Delete()) bool shouldDelete = threadToDelete != NULL; - wxThread::ExitCode rc = 0; + DWORD rc = 0; // we might need to resume the thread if it's currently stopped bool shouldResume = false; @@ -701,18 +785,16 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, } } -#if !defined(QS_ALLPOSTMESSAGE) -#define QS_ALLPOSTMESSAGE 0 -#endif - - result = ::MsgWaitForMultipleObjects - ( - 1, // number of objects to wait for - &m_hThread, // the objects - false, // don't wait for all objects - INFINITE, // no timeout - QS_ALLINPUT|QS_ALLPOSTMESSAGE // return as soon as there are any events - ); + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) + { + result = traits->WaitForThread(m_hThread); + } + else // can't wait for the thread + { + // so kill it below + result = 0xFFFFFFFF; + } switch ( result ) { @@ -737,15 +819,6 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, // the system might dead lock then if ( wxThread::IsMain() ) { - // it looks that sometimes WAIT_OBJECT_0 + 1 is - // returned but there are no messages in the thread - // queue -- prevent DoMessageFromThreadWait() from - // blocking inside ::GetMessage() forever in this case - ::PostMessage(NULL, WM_NULL, 0, 0); - - wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() - : NULL; - if ( traits && !traits->DoMessageFromThreadWait() ) { // WM_QUIT received: kill the thread @@ -772,16 +845,16 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, // terminated if the "if" above hadn't been taken for ( ;; ) { - if ( !::GetExitCodeThread(m_hThread, (LPDWORD)&rc) ) + if ( !::GetExitCodeThread(m_hThread, &rc) ) { wxLogLastError(wxT("GetExitCodeThread")); - rc = (wxThread::ExitCode)-1; + rc = THREAD_ERROR_EXIT; break; } - if ( (DWORD)rc != STILL_ACTIVE ) + if ( rc != STILL_ACTIVE ) break; // give the other thread some time to terminate, otherwise we may be @@ -790,14 +863,13 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, } if ( pRc ) - *pRc = rc; + *pRc = wxUIntToPtr(rc); // we don't need the thread handle any more in any case Free(); - return rc == (wxThread::ExitCode)-1 ? wxTHREAD_MISC_ERROR - : wxTHREAD_NO_ERROR; + return rc == THREAD_ERROR_EXIT ? wxTHREAD_MISC_ERROR : wxTHREAD_NO_ERROR; } bool wxThreadInternal::Suspend() @@ -854,11 +926,6 @@ wxThread *wxThread::This() return thread; } -bool wxThread::IsMain() -{ - return ::GetCurrentThreadId() == gs_idMainThread || gs_idMainThread == 0; -} - void wxThread::Yield() { // 0 argument to Sleep() is special and means to just give away the rest of @@ -866,11 +933,6 @@ void wxThread::Yield() ::Sleep(0); } -void wxThread::Sleep(unsigned long milliseconds) -{ - ::Sleep(milliseconds); -} - int wxThread::GetCPUCount() { SYSTEM_INFO si; @@ -889,7 +951,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) #ifdef __WXWINCE__ return false; #else - wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") ); + wxASSERT_MSG( IsMain(), wxT("should only be called from the main thread") ); // ok only for the default one if ( level == 0 ) @@ -900,7 +962,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) DWORD_PTR dwProcMask, dwSysMask; if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 ) { - wxLogLastError(_T("GetProcessAffinityMask")); + wxLogLastError(wxT("GetProcessAffinityMask")); return false; } @@ -925,7 +987,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) dwProcMask |= bit; // another process added - if ( !--level ) + if ( --level == 0 ) { // and that's enough break; @@ -939,7 +1001,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) // could we set all bits? if ( level != 0 ) { - wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level); + wxLogDebug(wxT("bad level %u in wxThread::SetConcurrency()"), level); return false; } @@ -947,14 +1009,14 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) // set it: we can't link to SetProcessAffinityMask() because it doesn't // exist in Win9x, use RT binding instead - typedef BOOL (*SETPROCESSAFFINITYMASK)(HANDLE, DWORD); + typedef BOOL (WINAPI *SETPROCESSAFFINITYMASK)(HANDLE, DWORD_PTR); // can use static var because we're always in the main thread here static SETPROCESSAFFINITYMASK pfnSetProcessAffinityMask = NULL; if ( !pfnSetProcessAffinityMask ) { - HMODULE hModKernel = ::LoadLibrary(_T("kernel32")); + HMODULE hModKernel = ::LoadLibrary(wxT("kernel32")); if ( hModKernel ) { pfnSetProcessAffinityMask = (SETPROCESSAFFINITYMASK) @@ -963,7 +1025,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) // we've discovered a MT version of Win9x! wxASSERT_MSG( pfnSetProcessAffinityMask, - _T("this system has several CPUs but no SetProcessAffinityMask function?") ); + wxT("this system has several CPUs but no SetProcessAffinityMask function?") ); } if ( !pfnSetProcessAffinityMask ) @@ -974,7 +1036,7 @@ bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 ) { - wxLogLastError(_T("SetProcessAffinityMask")); + wxLogLastError(wxT("SetProcessAffinityMask")); return false; } @@ -1047,12 +1109,12 @@ wxThreadError wxThread::Resume() wxThread::ExitCode wxThread::Wait() { + ExitCode rc = wxUIntToPtr(THREAD_ERROR_EXIT); + // although under Windows we can wait for any thread, it's an error to // wait for a detached one in wxWin API - wxCHECK_MSG( !IsDetached(), (ExitCode)-1, - _T("wxThread::Wait(): can't wait for detached thread") ); - - ExitCode rc = (ExitCode)-1; + wxCHECK_MSG( !IsDetached(), rc, + wxT("wxThread::Wait(): can't wait for detached thread") ); (void)m_internal->WaitForTerminate(m_critsect, &rc); @@ -1101,7 +1163,7 @@ void wxThread::Exit(ExitCode status) } #ifdef wxUSE_BEGIN_THREAD - _endthreadex((unsigned)status); + _endthreadex(wxPtrToUInt(status)); #else // !VC++ ::ExitThread((DWORD)status); #endif // VC++/!VC++ @@ -1211,8 +1273,7 @@ bool wxThreadModule::OnInit() gs_critsectThreadDelete = new wxCriticalSection; - // no error return for GetCurrentThreadId() - gs_idMainThread = ::GetCurrentThreadId(); + wxThread::ms_idMainThread = wxThread::GetCurrentId(); return true; } @@ -1243,7 +1304,7 @@ void wxThreadModule::OnExit() // not a mutex, so the names are a bit confusing // ---------------------------------------------------------------------------- -void WXDLLIMPEXP_BASE wxMutexGuiEnter() +void wxMutexGuiEnterImpl() { // this would dead lock everything... wxASSERT_MSG( !wxThread::IsMain(), @@ -1265,7 +1326,7 @@ void WXDLLIMPEXP_BASE wxMutexGuiEnter() gs_critsectGui->Enter(); } -void WXDLLIMPEXP_BASE wxMutexGuiLeave() +void wxMutexGuiLeaveImpl() { wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); @@ -1326,7 +1387,7 @@ bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread() void WXDLLIMPEXP_BASE wxWakeUpMainThread() { // sending any message would do - hopefully WM_NULL is harmless enough - if ( !::PostThreadMessage(gs_idMainThread, WM_NULL, 0, 0) ) + if ( !::PostThreadMessage(wxThread::GetMainId(), WM_NULL, 0, 0) ) { // should never happen wxLogLastError(wxT("PostThreadMessage(WM_NULL)")); @@ -1345,4 +1406,3 @@ bool WXDLLIMPEXP_BASE wxIsWaitingForThread() #include "wx/thrimpl.cpp" #endif // wxUSE_THREADS -