X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7da60d7c18d4b7a9ed586208cc6174b87b55db91..d2b23b67301bd2d286366d4326a21da3132558fa:/src/msw/thread.cpp diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index 54279fb6b4..36fc19ef8e 100644 --- a/src/msw/thread.cpp +++ b/src/msw/thread.cpp @@ -10,10 +10,6 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "thread.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -25,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 @@ -144,6 +144,9 @@ static bool gs_waitingForThread = false; wxCriticalSection::wxCriticalSection() { + wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer), + wxCriticalSectionBufferTooSmall ); + ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer); } @@ -175,7 +178,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: @@ -193,7 +197,7 @@ wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(mutexType)) m_mutex = ::CreateMutex ( NULL, // default secutiry attributes - false, // not initially locked + FALSE, // not initially locked NULL // no name ); @@ -214,6 +218,14 @@ wxMutexInternal::~wxMutexInternal() } } +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); @@ -234,7 +246,7 @@ wxMutexError wxMutexInternal::LockTimeout(DWORD milliseconds) break; case WAIT_TIMEOUT: - return wxMUTEX_BUSY; + return wxMUTEX_TIMEOUT; case WAIT_ABANDONED: // checked for above default: @@ -352,14 +364,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(_T("ReleaseSemaphore")); + return wxSEMA_MISC_ERROR; + } } return wxSEMA_NO_ERROR; +#else + return wxSEMA_MISC_ERROR; +#endif } // ---------------------------------------------------------------------------- @@ -428,9 +448,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() ) @@ -472,49 +499,82 @@ 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 - bool isExited = (thread->m_internal->GetState() == STATE_EXITED); + THREAD_RETVAL rc = (THREAD_RETVAL)-1; - if ( isExited ) - { - 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_RETVAL)-1; } rc = (THREAD_RETVAL)thread->Entry(); } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) + + return rc; +} + +/* static */ +THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) +{ + THREAD_RETVAL rc = (THREAD_RETVAL)-1; + + 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_RETVAL)-1) - thread->OnExit(); // save IsDetached because thread object can be deleted by joinable // threads after state is changed to STATE_EXITED. - bool isDetached = thread->IsDetached(); - - if (!isExited) + 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 - if (isDetached) thread->m_internal->LetDie(); + if ( isDetached ) + thread->m_internal->LetDie(); return rc; } @@ -630,14 +690,11 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, wxThread::ExitCode rc = 0; - // Delete() is always safe to call, so consider all possible states + // we might need to resume the thread if it's currently stopped + bool shouldResume = false; - // we might need to resume the thread, but we might also not need to cancel - // it if it doesn't run yet - bool shouldResume = false, - isRunning = false; - - // check if the thread already started to run + // as Delete() (which calls us) is always safe to call we need to consider + // all possible states { wxCriticalSectionLocker lock(cs); @@ -650,20 +707,17 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, // to let it run m_state = STATE_EXITED; - Resume(); // it knows about STATE_EXITED special case - + // we must call Resume() as the thread hasn't been initially + // resumed yet (and as Resume() it knows about STATE_EXITED + // special case, it won't touch it and WinThreadStart() will + // just exit immediately) + shouldResume = true; shouldDelete = false; } - - isRunning = true; - - // shouldResume is correctly set to false here - } - else if ( m_state == STATE_EXITED ) - { - return wxTHREAD_NOT_RUNNING; + //else: shouldResume is correctly set to false here, wait until + // someone else runs the thread and it finishes } - else // running (but maybe paused or cancelled) + else // running, paused, cancelled or even exited { shouldResume = m_state == STATE_PAUSED; } @@ -673,104 +727,95 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, if ( shouldResume ) Resume(); - // is it still running? - if ( isRunning || m_state == STATE_RUNNING ) + // ask the thread to terminate + if ( shouldDelete ) + { + wxCriticalSectionLocker lock(cs); + + Cancel(); + } + + + // now wait for thread to finish + if ( wxThread::IsMain() ) + { + // set flag for wxIsWaitingForThread() + gs_waitingForThread = true; + } + + // we can't just wait for the thread to terminate because it might be + // calling some GUI functions and so it will never terminate before we + // process the Windows messages that result from these functions + // (note that even in console applications we might have to process + // messages if we use wxExecute() or timers or ...) + DWORD result wxDUMMY_INITIALIZE(0); + do { if ( wxThread::IsMain() ) { - // set flag for wxIsWaitingForThread() - gs_waitingForThread = true; + // give the thread we're waiting for chance to do the GUI call + // it might be in + if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) + { + wxMutexGuiLeave(); + } } - // ask the thread to terminate - if ( shouldDelete ) + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits ) { - wxCriticalSectionLocker lock(cs); - - Cancel(); + result = traits->WaitForThread(m_hThread); + } + else // can't wait for the thread + { + // so kill it below + result = 0xFFFFFFFF; } - // we can't just wait for the thread to terminate because it might be - // calling some GUI functions and so it will never terminate before we - // process the Windows messages that result from these functions - // (note that even in console applications we might have to process - // messages if we use wxExecute() or timers or ...) - DWORD result wxDUMMY_INITIALIZE(0); - do + switch ( result ) { - if ( wxThread::IsMain() ) - { - // give the thread we're waiting for chance to do the GUI call - // it might be in - if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) - { - wxMutexGuiLeave(); - } - } + case 0xFFFFFFFF: + // error + wxLogSysError(_("Can not wait for thread termination")); + Kill(); + return wxTHREAD_KILLED; + + case WAIT_OBJECT_0: + // thread we're waiting for terminated + break; - 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 | // return as soon as there are any events - QS_ALLPOSTMESSAGE - ); - - switch ( result ) - { - case 0xFFFFFFFF: - // error - wxLogSysError(_("Can not wait for thread termination")); - Kill(); - return wxTHREAD_KILLED; - - case WAIT_OBJECT_0: - // thread we're waiting for terminated - break; - - case WAIT_OBJECT_0 + 1: - // new message arrived, process it -- but only if we're the - // main thread as we don't support processing messages in - // the other ones - // - // NB: we still must include QS_ALLINPUT even when waiting - // in a secondary thread because if it had created some - // window somehow (possible not even using wxWidgets) - // the system might dead lock then - if ( wxThread::IsMain() ) + case WAIT_OBJECT_0 + 1: + // new message arrived, process it -- but only if we're the + // main thread as we don't support processing messages in + // the other ones + // + // NB: we still must include QS_ALLINPUT even when waiting + // in a secondary thread because if it had created some + // window somehow (possible not even using wxWidgets) + // the system might dead lock then + if ( wxThread::IsMain() ) + { + if ( traits && !traits->DoMessageFromThreadWait() ) { - // 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 - Kill(); - - return wxTHREAD_KILLED; - } - } - break; + // WM_QUIT received: kill the thread + Kill(); - default: - wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject")); - } - } while ( result != WAIT_OBJECT_0 ); + return wxTHREAD_KILLED; + } + } + break; - if ( wxThread::IsMain() ) - { - gs_waitingForThread = false; + default: + wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject")); } + } while ( result != WAIT_OBJECT_0 ); + + if ( wxThread::IsMain() ) + { + gs_waitingForThread = false; } + // although the thread might be already in the EXITED state it might not // have terminated yet and so we are not sure that it has actually // terminated if the "if" above hadn't been taken @@ -831,7 +876,7 @@ bool wxThreadInternal::Resume() // don't change the state from STATE_EXITED because it's special and means // we are going to terminate without running any user code - if we did it, - // the codei n Delete() wouldn't work + // the code in WaitForTerminate() wouldn't work if ( m_state != STATE_EXITED ) { m_state = STATE_RUNNING; @@ -888,10 +933,9 @@ unsigned long wxThread::GetCurrentId() return (unsigned long)::GetCurrentThreadId(); } -bool wxThread::SetConcurrency(size_t level) +bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) { #ifdef __WXWINCE__ - wxUnusedVar(level); return false; #else wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") ); @@ -930,7 +974,7 @@ bool wxThread::SetConcurrency(size_t level) dwProcMask |= bit; // another process added - if ( !--level ) + if ( --level == 0 ) { // and that's enough break; @@ -1350,4 +1394,3 @@ bool WXDLLIMPEXP_BASE wxIsWaitingForThread() #include "wx/thrimpl.cpp" #endif // wxUSE_THREADS -