X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4a268913a84bb934c62bc7685d736678528848d9..dd9f8b6bb6935360a8271dc3e8749fb026b601a8:/src/msw/thread.cpp?ds=inline diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index cc035de03d..942a0379da 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 @@ -76,7 +76,7 @@ #include // the return type of the thread function entry point - typedef unsigned THREAD_RETVAL; + typedef wxUIntPtr THREAD_RETVAL; // the calling convention of the thread function entry point #define THREAD_CALLCONV __stdcall @@ -86,6 +86,8 @@ #define THREAD_CALLCONV WINAPI #endif +static const THREAD_RETVAL THREAD_ERROR_EXIT = (THREAD_RETVAL)-1; + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -178,7 +180,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: @@ -196,7 +199,7 @@ wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(mutexType)) m_mutex = ::CreateMutex ( NULL, // default secutiry attributes - false, // not initially locked + FALSE, // not initially locked NULL // no name ); @@ -217,6 +220,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); @@ -237,7 +248,7 @@ wxMutexError wxMutexInternal::LockTimeout(DWORD milliseconds) break; case WAIT_TIMEOUT: - return wxMUTEX_BUSY; + return wxMUTEX_TIMEOUT; case WAIT_ABANDONED: // checked for above default: @@ -355,14 +366,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 } // ---------------------------------------------------------------------------- @@ -431,9 +450,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() ) @@ -475,41 +501,82 @@ private: wxThreadInternal& m_thrImpl; }; +/* static */ +void wxThreadInternal::DoThreadOnExit(wxThread *thread) +{ + wxTRY + { + thread->OnExit(); + } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) +} -THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) +/* static */ +THREAD_RETVAL wxThreadInternal::DoThreadStart(wxThread *thread) { - THREAD_RETVAL rc; + wxON_BLOCK_EXIT1(DoThreadOnExit, thread); - wxThread * const thread = (wxThread *)param; + THREAD_RETVAL rc = THREAD_ERROR_EXIT; - // first of all, check whether we hadn't been cancelled already and don't - // start the user code at all then - if ( thread->m_internal->GetState() == STATE_EXITED ) - { - 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(); + } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) - // enter m_critsect before changing the thread state - wxCriticalSectionLocker lock(thread->m_critsect); + return rc; +} - thread->m_internal->SetState(STATE_EXITED); +/* 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. + const bool isDetached = thread->IsDetached(); + if ( !hasExited ) + { + // enter m_critsect before changing the thread state + // + // 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 - thread->m_internal->LetDie(); + if ( isDetached ) + thread->m_internal->LetDie(); return rc; } @@ -518,7 +585,7 @@ void wxThreadInternal::SetPriority(unsigned int priority) { m_priority = priority; - // translate wxWindows priority to the Windows one + // translate wxWidgets priority to the Windows one int win_priority; if (m_priority <= 20) win_priority = THREAD_PRIORITY_LOWEST; @@ -597,7 +664,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")); @@ -623,16 +690,13 @@ wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, // from Wait()) or ask it to terminate (when called from Delete()) bool shouldDelete = threadToDelete != NULL; - wxThread::ExitCode rc = 0; - - // Delete() is always safe to call, so consider all possible states + DWORD rc = 0; - // 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; + // we might need to resume the thread if it's currently stopped + bool shouldResume = 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); @@ -645,20 +709,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; } @@ -668,126 +729,125 @@ 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 wxWindows) - // 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 - do + for ( ;; ) { - if ( !::GetExitCodeThread(m_hThread, (LPDWORD)&rc) ) + if ( !::GetExitCodeThread(m_hThread, &rc) ) { wxLogLastError(wxT("GetExitCodeThread")); - rc = (wxThread::ExitCode)-1; + rc = THREAD_ERROR_EXIT; + + break; } - } while ( (DWORD)rc == STILL_ACTIVE ); + + if ( rc != STILL_ACTIVE ) + break; + + // give the other thread some time to terminate, otherwise we may be + // starving it + ::Sleep(1); + } 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() @@ -817,7 +877,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; @@ -846,7 +906,7 @@ wxThread *wxThread::This() bool wxThread::IsMain() { - return ::GetCurrentThreadId() == gs_idMainThread; + return ::GetCurrentThreadId() == gs_idMainThread || gs_idMainThread == 0; } void wxThread::Yield() @@ -874,9 +934,11 @@ unsigned long wxThread::GetCurrentId() return (unsigned long)::GetCurrentThreadId(); } -bool wxThread::SetConcurrency(size_t level) +bool wxThread::SetConcurrency(size_t WXUNUSED_IN_WINCE(level)) { -#ifndef __WXWINCE__ +#ifdef __WXWINCE__ + return false; +#else wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") ); // ok only for the default one @@ -885,7 +947,7 @@ bool wxThread::SetConcurrency(size_t level) // get system affinity mask first HANDLE hProcess = ::GetCurrentProcess(); - DWORD dwProcMask, dwSysMask; + DWORD_PTR dwProcMask, dwSysMask; if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 ) { wxLogLastError(_T("GetProcessAffinityMask")); @@ -913,7 +975,7 @@ bool wxThread::SetConcurrency(size_t level) dwProcMask |= bit; // another process added - if ( !--level ) + if ( --level == 0 ) { // and that's enough break; @@ -935,7 +997,7 @@ bool wxThread::SetConcurrency(size_t 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; @@ -966,8 +1028,9 @@ bool wxThread::SetConcurrency(size_t level) return false; } -#endif + return true; +#endif // __WXWINCE__/!__WXWINCE__ } // ctor and dtor @@ -1034,13 +1097,13 @@ wxThreadError wxThread::Resume() wxThread::ExitCode wxThread::Wait() { + ExitCode rc = (ExitCode)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, + wxCHECK_MSG( !IsDetached(), rc, _T("wxThread::Wait(): can't wait for detached thread") ); - ExitCode rc = (ExitCode)-1; - (void)m_internal->WaitForTerminate(m_critsect, &rc); return rc; @@ -1088,7 +1151,7 @@ void wxThread::Exit(ExitCode status) } #ifdef wxUSE_BEGIN_THREAD - _endthreadex((unsigned)status); + _endthreadex(wxPtrToUInt(status)); #else // !VC++ ::ExitThread((DWORD)status); #endif // VC++/!VC++ @@ -1230,7 +1293,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(), @@ -1252,7 +1315,7 @@ void WXDLLIMPEXP_BASE wxMutexGuiEnter() gs_critsectGui->Enter(); } -void WXDLLIMPEXP_BASE wxMutexGuiLeave() +void wxMutexGuiLeaveImpl() { wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); @@ -1332,4 +1395,3 @@ bool WXDLLIMPEXP_BASE wxIsWaitingForThread() #include "wx/thrimpl.cpp" #endif // wxUSE_THREADS -