X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ccebc98a675824686374cf0fcf06677e6dc130d0..ce9685190eecd78ce64b7bb5321fdde960800456:/src/msw/thread.cpp diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index 21682d45a5..b48ed592cd 100644 --- a/src/msw/thread.cpp +++ b/src/msw/thread.cpp @@ -1,19 +1,15 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: thread.cpp +// Name: src/msw/thread.cpp // Purpose: wxThread Implementation // Author: Original from Wolfram Gloger/Guilhem Lavaux // Modified by: Vadim Zeitlin to make it work :-) // Created: 04/22/98 // RCS-ID: $Id$ -// Copyright: (c) Wolfram Gloger (1996, 1997); Guilhem Lavaux (1998), -// Vadim Zeitlin (1999) +// Copyright: (c) Wolfram Gloger (1996, 1997), Guilhem Lavaux (1998); +// Vadim Zeitlin (1999-2002) // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ - #pragma implementation "thread.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -25,30 +21,69 @@ #pragma hdrstop #endif +#if wxUSE_THREADS + +#include "wx/thread.h" + #ifndef WX_PRECOMP - #include "wx/wx.h" + #include "wx/msw/missing.h" + #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/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 #define _MT #endif -#if defined(__VISUALC__) || (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) +#if defined(__BORLANDC__) + #if !defined(__MT__) + // I can't set -tWM in the IDE (anyone?) so have to do this + #define __MT__ + #endif + + #if !defined(__MFC_COMPAT__) + // Needed to know about _beginthreadex etc.. + #define __MFC_COMPAT__ + #endif +#endif // BC++ + +// define wxUSE_BEGIN_THREAD if the compiler has _beginthreadex() function +// which should be used instead of Win32 ::CreateThread() if possible +#if defined(__VISUALC__) || \ + (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) || \ + (defined(__GNUG__) && defined(__MSVCRT__)) || \ + defined(__WATCOMC__) || defined(__MWERKS__) + +#ifndef __WXWINCE__ + #undef wxUSE_BEGIN_THREAD + #define wxUSE_BEGIN_THREAD +#endif -#if defined(__BORLANDC__) && !defined(__MT__) -// I can't set -tWM in the IDE (anyone?) so have to do this -#define __MT__ #endif +#ifdef wxUSE_BEGIN_THREAD + // this is where _beginthreadex() is declared #include + + // the return type of the thread function entry point + typedef unsigned THREAD_RETVAL; + + // the calling convention of the thread function entry point + #define THREAD_CALLCONV __stdcall +#else + // the settings for CreateThread() + typedef DWORD THREAD_RETVAL; + #define THREAD_CALLCONV WINAPI #endif // ---------------------------------------------------------------------------- @@ -77,8 +112,8 @@ static DWORD gs_tlsThisThread = 0xFFFFFFFF; // calling wxMutexGuiEnter() static DWORD gs_idMainThread = 0; -// if it's FALSE, some secondary thread is holding the GUI lock -static bool gs_bGuiOwnedByMainThread = TRUE; +// if it's false, some secondary thread is holding the GUI lock +static bool gs_bGuiOwnedByMainThread = true; // critical section which controls access to all GUI functions: any secondary // thread (i.e. except the main one) must enter this crit section before doing @@ -88,228 +123,246 @@ static wxCriticalSection *gs_critsectGui = NULL; // critical section which protects gs_nWaitingForGui variable static wxCriticalSection *gs_critsectWaitingForGui = NULL; +// critical section which serializes WinThreadStart() and WaitForTerminate() +// (this is a potential bottleneck, we use a single crit sect for all threads +// in the system, but normally time spent inside it should be quite short) +static wxCriticalSection *gs_critsectThreadDelete = NULL; + // number of threads waiting for GUI in wxMutexGuiEnter() static size_t gs_nWaitingForGui = 0; // are we waiting for a thread termination? -static bool gs_waitingForThread = FALSE; +static bool gs_waitingForThread = false; // ============================================================================ -// Windows implementation of thread classes +// Windows implementation of thread and related classes // ============================================================================ // ---------------------------------------------------------------------------- -// wxMutex implementation +// wxCriticalSection +// ---------------------------------------------------------------------------- + +wxCriticalSection::wxCriticalSection() +{ + wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer), + wxCriticalSectionBufferTooSmall ); + + ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer); +} + +wxCriticalSection::~wxCriticalSection() +{ + ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer); +} + +void wxCriticalSection::Enter() +{ + ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer); +} + +void wxCriticalSection::Leave() +{ + ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer); +} + +// ---------------------------------------------------------------------------- +// wxMutex // ---------------------------------------------------------------------------- class wxMutexInternal { public: - wxMutexInternal() - { - m_mutex = ::CreateMutex(NULL, FALSE, NULL); - if ( !m_mutex ) - { - wxLogSysError(_("Can not create mutex")); - } - } + wxMutexInternal(wxMutexType mutexType); + ~wxMutexInternal(); - ~wxMutexInternal() { if ( m_mutex ) CloseHandle(m_mutex); } + bool IsOk() const { return m_mutex != NULL; } + + wxMutexError Lock() { return LockTimeout(INFINITE); } + wxMutexError TryLock() { return LockTimeout(0); } + wxMutexError Unlock(); + +private: + wxMutexError LockTimeout(DWORD milliseconds); -public: HANDLE m_mutex; + + DECLARE_NO_COPY_CLASS(wxMutexInternal) }; -wxMutex::wxMutex() +// all mutexes are recursive under Win32 so we don't use mutexType +wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(mutexType)) { - m_internal = new wxMutexInternal; - - m_locked = 0; + // create a nameless (hence intra process and always private) mutex + m_mutex = ::CreateMutex + ( + NULL, // default secutiry attributes + false, // not initially locked + NULL // no name + ); + + if ( !m_mutex ) + { + wxLogLastError(_T("CreateMutex()")); + } } -wxMutex::~wxMutex() +wxMutexInternal::~wxMutexInternal() { - if ( m_locked > 0 ) + if ( m_mutex ) { - wxLogDebug(_T("Warning: freeing a locked mutex (%d locks)."), m_locked); + if ( !::CloseHandle(m_mutex) ) + { + wxLogLastError(_T("CloseHandle(mutex)")); + } } - - delete m_internal; } -wxMutexError wxMutex::Lock() +wxMutexError wxMutexInternal::LockTimeout(DWORD milliseconds) { - DWORD ret; - - ret = WaitForSingleObject(m_internal->m_mutex, INFINITE); - switch ( ret ) + DWORD rc = ::WaitForSingleObject(m_mutex, milliseconds); + if ( rc == WAIT_ABANDONED ) { - case WAIT_ABANDONED: - return wxMUTEX_BUSY; + // 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); + } + switch ( rc ) + { case WAIT_OBJECT_0: // ok break; - case WAIT_FAILED: - wxLogSysError(_("Couldn't acquire a mutex lock")); - return wxMUTEX_MISC_ERROR; - case WAIT_TIMEOUT: + return wxMUTEX_BUSY; + + case WAIT_ABANDONED: // checked for above default: wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock")); - } + // fall through - m_locked++; - return wxMUTEX_NO_ERROR; -} - -wxMutexError wxMutex::TryLock() -{ - DWORD ret; - - ret = WaitForSingleObject(m_internal->m_mutex, 0); - if (ret == WAIT_TIMEOUT || ret == WAIT_ABANDONED) - return wxMUTEX_BUSY; + case WAIT_FAILED: + wxLogLastError(_T("WaitForSingleObject(mutex)")); + return wxMUTEX_MISC_ERROR; + } - m_locked++; return wxMUTEX_NO_ERROR; } -wxMutexError wxMutex::Unlock() +wxMutexError wxMutexInternal::Unlock() { - if (m_locked > 0) - m_locked--; - - BOOL ret = ReleaseMutex(m_internal->m_mutex); - if ( ret == 0 ) + if ( !::ReleaseMutex(m_mutex) ) { - wxLogSysError(_("Couldn't release a mutex")); + wxLogLastError(_T("ReleaseMutex()")); + return wxMUTEX_MISC_ERROR; } return wxMUTEX_NO_ERROR; } -// ---------------------------------------------------------------------------- -// wxCondition implementation -// ---------------------------------------------------------------------------- +// -------------------------------------------------------------------------- +// wxSemaphore +// -------------------------------------------------------------------------- -class wxConditionInternal +// a trivial wrapper around Win32 semaphore +class wxSemaphoreInternal { public: - wxConditionInternal() - { - event = ::CreateEvent( - NULL, // default secutiry - FALSE, // not manual reset - FALSE, // nonsignaled initially - NULL // nameless event - ); - if ( !event ) - { - wxLogSysError(_("Can not create event object.")); - } - waiters = 0; - } + wxSemaphoreInternal(int initialcount, int maxcount); + ~wxSemaphoreInternal(); - bool Wait(DWORD timeout) - { - waiters++; + bool IsOk() const { return m_semaphore != NULL; } - // FIXME this should be MsgWaitForMultipleObjects() as well probably - DWORD rc = ::WaitForSingleObject(event, timeout); + wxSemaError Wait() { return WaitTimeout(INFINITE); } - waiters--; + wxSemaError TryWait() + { + wxSemaError rc = WaitTimeout(0); + if ( rc == wxSEMA_TIMEOUT ) + rc = wxSEMA_BUSY; - return rc != WAIT_TIMEOUT; + return rc; } - ~wxConditionInternal() - { - if ( event ) - { - if ( !::CloseHandle(event) ) - { - wxLogLastError("CloseHandle(event)"); - } - } - } + wxSemaError WaitTimeout(unsigned long milliseconds); - HANDLE event; - int waiters; -}; + wxSemaError Post(); -wxCondition::wxCondition() -{ - m_internal = new wxConditionInternal; -} +private: + HANDLE m_semaphore; -wxCondition::~wxCondition() -{ - delete m_internal; -} + DECLARE_NO_COPY_CLASS(wxSemaphoreInternal) +}; -void wxCondition::Wait() +wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount) { - (void)m_internal->Wait(INFINITE); -} +#if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300) + if ( maxcount == 0 ) + { + // make it practically infinite + maxcount = INT_MAX; + } -bool wxCondition::Wait(unsigned long sec, - unsigned long nsec) -{ - return m_internal->Wait(sec*1000 + nsec/1000000); + m_semaphore = ::CreateSemaphore + ( + NULL, // default security attributes + initialcount, + maxcount, + NULL // no name + ); +#endif + if ( !m_semaphore ) + { + wxLogLastError(_T("CreateSemaphore()")); + } } -void wxCondition::Signal() +wxSemaphoreInternal::~wxSemaphoreInternal() { - // set the event to signaled: if a thread is already waiting on it, it will - // be woken up, otherwise the event will remain in the signaled state until - // someone waits on it. In any case, the system will return it to a non - // signalled state afterwards. If multiple threads are waiting, only one - // will be woken up. - if ( !::SetEvent(m_internal->event) ) + if ( m_semaphore ) { - wxLogLastError("SetEvent"); + if ( !::CloseHandle(m_semaphore) ) + { + wxLogLastError(_T("CloseHandle(semaphore)")); + } } } -void wxCondition::Broadcast() +wxSemaError wxSemaphoreInternal::WaitTimeout(unsigned long milliseconds) { - // this works because all these threads are already waiting and so each - // SetEvent() inside Signal() is really a PulseEvent() because the event - // state is immediately returned to non-signaled - for ( int i = 0; i < m_internal->waiters; i++ ) + DWORD rc = ::WaitForSingleObject( m_semaphore, milliseconds ); + + switch ( rc ) { - Signal(); - } -} + case WAIT_OBJECT_0: + return wxSEMA_NO_ERROR; -// ---------------------------------------------------------------------------- -// wxCriticalSection implementation -// ---------------------------------------------------------------------------- + case WAIT_TIMEOUT: + return wxSEMA_TIMEOUT; -wxCriticalSection::wxCriticalSection() -{ - wxASSERT_MSG( sizeof(CRITICAL_SECTION) <= sizeof(m_buffer), - _T("must increase buffer size in wx/thread.h") ); + default: + wxLogLastError(_T("WaitForSingleObject(semaphore)")); + } - ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer); + return wxSEMA_MISC_ERROR; } -wxCriticalSection::~wxCriticalSection() +wxSemaError wxSemaphoreInternal::Post() { - ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer); -} +#if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300) + if ( !::ReleaseSemaphore(m_semaphore, 1, NULL /* ptr to previous count */) ) +#endif + { + wxLogLastError(_T("ReleaseSemaphore")); -void wxCriticalSection::Enter() -{ - ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer); -} + return wxSEMA_MISC_ERROR; + } -void wxCriticalSection::Leave() -{ - ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer); + return wxSEMA_NO_ERROR; } // ---------------------------------------------------------------------------- @@ -322,11 +375,13 @@ void wxCriticalSection::Leave() class wxThreadInternal { public: - wxThreadInternal() + wxThreadInternal(wxThread *thread) { + m_thread = thread; m_hThread = 0; m_state = STATE_NEW; m_priority = WXTHREAD_DEFAULT_PRIORITY; + m_nRef = 1; } ~wxThreadInternal() @@ -340,7 +395,7 @@ public: { if ( !::CloseHandle(m_hThread) ) { - wxLogLastError("CloseHandle(thread)"); + wxLogLastError(wxT("CloseHandle(thread)")); } m_hThread = 0; @@ -348,7 +403,16 @@ public: } // create a new (suspended) thread (for the given thread object) - bool Create(wxThread *thread); + bool Create(wxThread *thread, unsigned int stackSize); + + // wait for the thread to terminate, either by itself, or by asking it + // (politely, this is not Kill()!) to do it + wxThreadError WaitForTerminate(wxCriticalSection& cs, + wxThread::ExitCode *pRc, + wxThread *threadToDelete = NULL); + + // kill the thread unconditionally + wxThreadError Kill(); // suspend/resume/terminate bool Suspend(); @@ -367,50 +431,133 @@ public: HANDLE GetHandle() const { return m_hThread; } DWORD GetId() const { return m_tid; } - // thread function - static DWORD WinThreadStart(wxThread *thread); + // 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() ) + ::InterlockedIncrement(&m_nRef); + } + + void LetDie() + { + if ( m_thread->IsDetached() && !::InterlockedDecrement(&m_nRef) ) + delete m_thread; + } private: + // the thread we're associated with + wxThread *m_thread; + HANDLE m_hThread; // handle of the thread wxThreadState m_state; // state, see wxThreadState enum unsigned int m_priority; // thread priority in "wx" units DWORD m_tid; // thread id + + // number of threads which need this thread to remain alive, when the count + // reaches 0 we kill the owning wxThread -- and die ourselves with it + LONG m_nRef; + + DECLARE_NO_COPY_CLASS(wxThreadInternal) }; -DWORD wxThreadInternal::WinThreadStart(wxThread *thread) +// small class which keeps a thread alive during its lifetime +class wxThreadKeepAlive { - // first of all, check whether we hadn't been cancelled already - if ( thread->m_internal->GetState() == STATE_EXITED ) +public: + wxThreadKeepAlive(wxThreadInternal& thrImpl) : m_thrImpl(thrImpl) + { m_thrImpl.KeepAlive(); } + ~wxThreadKeepAlive() + { m_thrImpl.LetDie(); } + +private: + wxThreadInternal& m_thrImpl; +}; + +/* static */ +void wxThreadInternal::DoThreadOnExit(wxThread *thread) +{ + wxTRY { - return (DWORD)-1; + thread->OnExit(); } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); ) +} - // store the thread object in the TLS - if ( !::TlsSetValue(gs_tlsThisThread, thread) ) +/* static */ +THREAD_RETVAL wxThreadInternal::DoThreadStart(wxThread *thread) +{ + wxON_BLOCK_EXIT1(DoThreadOnExit, thread); + + THREAD_RETVAL rc = (THREAD_RETVAL)-1; + + wxTRY { - wxLogSysError(_("Can not start thread: error writing TLS.")); + // 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(); ) - DWORD rc = (DWORD)thread->Entry(); + return rc; +} + +/* static */ +THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) +{ + THREAD_RETVAL rc = (THREAD_RETVAL)-1; - // enter m_critsect before changing the thread state - thread->m_critsect.Enter(); - bool wasCancelled = thread->m_internal->GetState() == STATE_CANCELED; - thread->m_internal->SetState(STATE_EXITED); - thread->m_critsect.Leave(); + wxThread * const thread = (wxThread *)param; - thread->OnExit(); + // each thread has its own SEH translator so install our own a.s.a.p. + DisableAutomaticSETranslator(); - // if the thread was cancelled (from Delete()), then it the handle is still - // needed there - if ( thread->IsDetached() && !wasCancelled ) + // 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 { - // auto delete - delete thread; + if ( hasExited ) + DoThreadOnExit(thread); + else + rc = DoThreadStart(thread); } - //else: the joinable threads handle will be closed when Wait() is done + wxSEH_HANDLE((THREAD_RETVAL)-1) + + + // 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 + if ( isDetached ) + thread->m_internal->LetDie(); return rc; } @@ -419,7 +566,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; @@ -443,37 +590,49 @@ void wxThreadInternal::SetPriority(unsigned int priority) } } -bool wxThreadInternal::Create(wxThread *thread) +bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize) { + wxASSERT_MSG( m_state == STATE_NEW && !m_hThread, + _T("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 // leaks if the thread uses C RTL (and most threads do) -#if defined(__VISUALC__) || (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) - typedef unsigned (__stdcall *RtlThreadStart)(void *); - - m_hThread = (HANDLE)_beginthreadex(NULL, 0, - (RtlThreadStart) - wxThreadInternal::WinThreadStart, - thread, CREATE_SUSPENDED, - (unsigned int *)&m_tid); -#else // !VC++ +#ifdef wxUSE_BEGIN_THREAD + + // Watcom is reported to not like 0 stack size (which means "use default" + // for the other compilers and is also the default value for stackSize) +#ifdef __WATCOMC__ + if ( !stackSize ) + stackSize = 10240; +#endif // __WATCOMC__ + + m_hThread = (HANDLE)_beginthreadex + ( + NULL, // default security + stackSize, + wxThreadInternal::WinThreadStart, // entry point + thread, + CREATE_SUSPENDED, + (unsigned int *)&m_tid + ); +#else // compiler doesn't have _beginthreadex m_hThread = ::CreateThread ( NULL, // default security - 0, // default stack size - (LPTHREAD_START_ROUTINE) // thread entry point - wxThreadInternal::WinThreadStart, // + stackSize, // stack size + wxThreadInternal::WinThreadStart, // thread entry point (LPVOID)thread, // parameter CREATE_SUSPENDED, // flags &m_tid // [out] thread id ); -#endif // VC++/!VC++ +#endif // _beginthreadex/CreateThread if ( m_hThread == NULL ) { wxLogSysError(_("Can't create thread")); - return FALSE; + return false; } if ( m_priority != WXTHREAD_DEFAULT_PRIORITY ) @@ -481,7 +640,201 @@ bool wxThreadInternal::Create(wxThread *thread) SetPriority(m_priority); } - return TRUE; + return true; +} + +wxThreadError wxThreadInternal::Kill() +{ + if ( !::TerminateThread(m_hThread, (DWORD)-1) ) + { + wxLogSysError(_("Couldn't terminate thread")); + + return wxTHREAD_MISC_ERROR; + } + + Free(); + + return wxTHREAD_NO_ERROR; +} + +wxThreadError +wxThreadInternal::WaitForTerminate(wxCriticalSection& cs, + wxThread::ExitCode *pRc, + wxThread *threadToDelete) +{ + // prevent the thread C++ object from disappearing as long as we are using + // it here + wxThreadKeepAlive keepAlive(*this); + + + // we may either wait passively for the thread to terminate (when called + // from Wait()) or ask it to terminate (when called from Delete()) + bool shouldDelete = threadToDelete != NULL; + + wxThread::ExitCode rc = 0; + + // we might need to resume the thread if it's currently stopped + bool shouldResume = false; + + // as Delete() (which calls us) is always safe to call we need to consider + // all possible states + { + wxCriticalSectionLocker lock(cs); + + if ( m_state == STATE_NEW ) + { + if ( shouldDelete ) + { + // WinThreadStart() will see it and terminate immediately, no + // need to cancel the thread -- but we still need to resume it + // to let it run + m_state = STATE_EXITED; + + // 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; + } + //else: shouldResume is correctly set to false here, wait until + // someone else runs the thread and it finishes + } + else // running, paused, cancelled or even exited + { + shouldResume = m_state == STATE_PAUSED; + } + } + + // resume the thread if it is paused + if ( shouldResume ) + Resume(); + + // 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() ) + { + // give the thread we're waiting for chance to do the GUI call + // it might be in + if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) + { + wxMutexGuiLeave(); + } + } + +#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 + ); + + 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() ) + { + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() + : NULL; + + if ( traits && !traits->DoMessageFromThreadWait() ) + { + // WM_QUIT received: kill the thread + Kill(); + + return wxTHREAD_KILLED; + } + } + break; + + 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 + for ( ;; ) + { + if ( !::GetExitCodeThread(m_hThread, (LPDWORD)&rc) ) + { + wxLogLastError(wxT("GetExitCodeThread")); + + rc = (wxThread::ExitCode)-1; + + break; + } + + if ( (DWORD)rc != STILL_ACTIVE ) + break; + + // give the other thread some time to terminate, otherwise we may be + // starving it + ::Sleep(1); + } + + if ( pRc ) + *pRc = 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; } bool wxThreadInternal::Suspend() @@ -491,12 +844,12 @@ bool wxThreadInternal::Suspend() { wxLogSysError(_("Can not suspend thread %x"), m_hThread); - return FALSE; + return false; } m_state = STATE_PAUSED; - return TRUE; + return true; } bool wxThreadInternal::Resume() @@ -506,12 +859,18 @@ bool wxThreadInternal::Resume() { wxLogSysError(_("Can not resume thread %x"), m_hThread); - return FALSE; + return false; } - m_state = STATE_RUNNING; + // 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 code in WaitForTerminate() wouldn't work + if ( m_state != STATE_EXITED ) + { + m_state = STATE_RUNNING; + } - return TRUE; + return true; } // static functions @@ -534,13 +893,9 @@ wxThread *wxThread::This() bool wxThread::IsMain() { - return ::GetCurrentThreadId() == gs_idMainThread; + return ::GetCurrentThreadId() == gs_idMainThread || gs_idMainThread == 0; } -#ifdef Yield -#undef Yield -#endif - void wxThread::Yield() { // 0 argument to Sleep() is special and means to just give away the rest of @@ -561,8 +916,16 @@ int wxThread::GetCPUCount() return si.dwNumberOfProcessors; } -bool wxThread::SetConcurrency(size_t level) +unsigned long wxThread::GetCurrentId() { + return (unsigned long)::GetCurrentThreadId(); +} + +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") ); // ok only for the default one @@ -571,12 +934,12 @@ 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")); - return FALSE; + return false; } // how many CPUs have we got? @@ -599,7 +962,7 @@ bool wxThread::SetConcurrency(size_t level) dwProcMask |= bit; // another process added - if ( !--level ) + if ( --level == 0 ) { // and that's enough break; @@ -615,7 +978,7 @@ bool wxThread::SetConcurrency(size_t level) { wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level); - return FALSE; + return false; } // set it: we can't link to SetProcessAffinityMask() because it doesn't @@ -632,34 +995,29 @@ bool wxThread::SetConcurrency(size_t level) if ( hModKernel ) { pfnSetProcessAffinityMask = (SETPROCESSAFFINITYMASK) - ::GetProcAddress(hModKernel, -#if defined(__BORLANDC__) && (__BORLANDC__ <= 0x520) - "SetProcessAffinityMask"); -#else - _T("SetProcessAffinityMask")); -#endif + ::GetProcAddress(hModKernel, "SetProcessAffinityMask"); } // we've discovered a MT version of Win9x! wxASSERT_MSG( pfnSetProcessAffinityMask, - _T("this system has several CPUs but no " - "SetProcessAffinityMask function?") ); + _T("this system has several CPUs but no SetProcessAffinityMask function?") ); } if ( !pfnSetProcessAffinityMask ) { // msg given above - do it only once - return FALSE; + return false; } if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 ) { wxLogLastError(_T("SetProcessAffinityMask")); - return FALSE; + return false; } - return TRUE; + return true; +#endif // __WXWINCE__/!__WXWINCE__ } // ctor and dtor @@ -667,7 +1025,7 @@ bool wxThread::SetConcurrency(size_t level) wxThread::wxThread(wxThreadKind kind) { - m_internal = new wxThreadInternal(); + m_internal = new wxThreadInternal(this); m_isDetached = kind == wxTHREAD_DETACHED; } @@ -680,11 +1038,11 @@ wxThread::~wxThread() // create/start thread // ------------------- -wxThreadError wxThread::Create() +wxThreadError wxThread::Create(unsigned int stackSize) { wxCriticalSectionLocker lock(m_critsect); - if ( !m_internal->Create(this) ) + if ( !m_internal->Create(this, stackSize) ) return wxTHREAD_NO_RESOURCE; return wxTHREAD_NO_ERROR; @@ -729,162 +1087,18 @@ wxThread::ExitCode wxThread::Wait() // 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("can't wait for detached thread") ); + _T("wxThread::Wait(): can't wait for detached thread") ); ExitCode rc = (ExitCode)-1; - (void)Delete(&rc); - - m_internal->Free(); + (void)m_internal->WaitForTerminate(m_critsect, &rc); return rc; } wxThreadError wxThread::Delete(ExitCode *pRc) { - ExitCode rc = 0; - - // Delete() is always safe to call, so consider all possible states - - // has the thread started to run? - bool shouldResume = FALSE; - - { - wxCriticalSectionLocker lock(m_critsect); - - if ( m_internal->GetState() == STATE_NEW ) - { - // WinThreadStart() will see it and terminate immediately - m_internal->SetState(STATE_EXITED); - - shouldResume = TRUE; - } - } - - // is the thread paused? - if ( shouldResume || IsPaused() ) - Resume(); - - HANDLE hThread = m_internal->GetHandle(); - - // does is still run? - if ( IsRunning() ) - { - if ( IsMain() ) - { - // set flag for wxIsWaitingForThread() - gs_waitingForThread = TRUE; - -#if wxUSE_GUI - wxBeginBusyCursor(); -#endif // wxUSE_GUI - } - - // ask the thread to terminate - { - wxCriticalSectionLocker lock(m_critsect); - - m_internal->Cancel(); - } - -#if wxUSE_GUI - // 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 - DWORD result; - do - { - result = ::MsgWaitForMultipleObjects - ( - 1, // number of objects to wait for - &hThread, // the objects - FALSE, // don't wait for all objects - INFINITE, // no timeout - QS_ALLEVENTS // return as soon as there are any events - ); - - 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 - if ( !wxTheApp->DoMessage() ) - { - // WM_QUIT received: kill the thread - Kill(); - - return wxTHREAD_KILLED; - } - - if ( IsMain() ) - { - // give the thread we're waiting for chance to exit - // from the GUI call it might have been in - if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) - { - wxMutexGuiLeave(); - } - } - - break; - - default: - wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject")); - } - } while ( result != WAIT_OBJECT_0 ); -#else // !wxUSE_GUI - // simply wait for the thread to terminate - // - // OTOH, even console apps create windows (in wxExecute, for WinSock - // &c), so may be use MsgWaitForMultipleObject() too here? - if ( WaitForSingleObject(hThread, INFINITE) != WAIT_OBJECT_0 ) - { - wxFAIL_MSG(wxT("unexpected result of WaitForSingleObject")); - } -#endif // wxUSE_GUI/!wxUSE_GUI - - if ( IsMain() ) - { - gs_waitingForThread = FALSE; - -#if wxUSE_GUI - wxEndBusyCursor(); -#endif // wxUSE_GUI - } - } - - if ( !::GetExitCodeThread(hThread, (LPDWORD)&rc) ) - { - wxLogLastError("GetExitCodeThread"); - - rc = (ExitCode)-1; - } - - if ( IsDetached() ) - { - // if the thread exits normally, this is done in WinThreadStart, but in - // this case it would have been too early because - // MsgWaitForMultipleObject() would fail if the therad handle was - // closed while we were waiting on it, so we must do it here - delete this; - } - - wxASSERT_MSG( (DWORD)rc != STILL_ACTIVE, - wxT("thread must be already terminated.") ); - - if ( pRc ) - *pRc = rc; - - return rc == (ExitCode)-1 ? wxTHREAD_MISC_ERROR : wxTHREAD_NO_ERROR; + return m_internal->WaitForTerminate(m_critsect, pRc, this); } wxThreadError wxThread::Kill() @@ -892,21 +1106,20 @@ wxThreadError wxThread::Kill() if ( !IsRunning() ) return wxTHREAD_NOT_RUNNING; - if ( !::TerminateThread(m_internal->GetHandle(), (DWORD)-1) ) - { - wxLogSysError(_("Couldn't terminate thread")); - - return wxTHREAD_MISC_ERROR; - } - - m_internal->Free(); + wxThreadError rc = m_internal->Kill(); if ( IsDetached() ) { delete this; } + else // joinable + { + // update the status of the joinable thread + wxCriticalSectionLocker lock(m_critsect); + m_internal->SetState(STATE_EXITED); + } - return wxTHREAD_NO_ERROR; + return rc; } void wxThread::Exit(ExitCode status) @@ -917,8 +1130,14 @@ void wxThread::Exit(ExitCode status) { delete this; } + else // joinable + { + // update the status of the joinable thread + wxCriticalSectionLocker lock(m_critsect); + m_internal->SetState(STATE_EXITED); + } -#if defined(__VISUALC__) || (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) +#ifdef wxUSE_BEGIN_THREAD _endthreadex((unsigned)status); #else // !VC++ ::ExitThread((DWORD)status); @@ -1005,11 +1224,9 @@ bool wxThreadModule::OnInit() // in normal circumstances it will only happen if all other // TLS_MINIMUM_AVAILABLE (>= 64) indices are already taken - in other // words, this should never happen - wxLogSysError(_("Thread module initialization failed: " - "impossible to allocate index in thread " - "local storage")); + wxLogSysError(_("Thread module initialization failed: impossible to allocate index in thread local storage")); - return FALSE; + return false; } // main thread doesn't have associated wxThread object, so store 0 in the @@ -1019,10 +1236,9 @@ bool wxThreadModule::OnInit() ::TlsFree(gs_tlsThisThread); gs_tlsThisThread = 0xFFFFFFFF; - wxLogSysError(_("Thread module initialization failed: " - "can not store value in thread local storage")); + wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage")); - return FALSE; + return false; } gs_critsectWaitingForGui = new wxCriticalSection(); @@ -1030,19 +1246,24 @@ bool wxThreadModule::OnInit() gs_critsectGui = new wxCriticalSection(); gs_critsectGui->Enter(); + gs_critsectThreadDelete = new wxCriticalSection; + // no error return for GetCurrentThreadId() gs_idMainThread = ::GetCurrentThreadId(); - return TRUE; + return true; } void wxThreadModule::OnExit() { if ( !::TlsFree(gs_tlsThisThread) ) { - wxLogLastError("TlsFree failed."); + wxLogLastError(wxT("TlsFree failed.")); } + delete gs_critsectThreadDelete; + gs_critsectThreadDelete = NULL; + if ( gs_critsectGui ) { gs_critsectGui->Leave(); @@ -1059,7 +1280,7 @@ void wxThreadModule::OnExit() // not a mutex, so the names are a bit confusing // ---------------------------------------------------------------------------- -void WXDLLEXPORT wxMutexGuiEnter() +void WXDLLIMPEXP_BASE wxMutexGuiEnter() { // this would dead lock everything... wxASSERT_MSG( !wxThread::IsMain(), @@ -1081,17 +1302,17 @@ void WXDLLEXPORT wxMutexGuiEnter() gs_critsectGui->Enter(); } -void WXDLLEXPORT wxMutexGuiLeave() +void WXDLLIMPEXP_BASE wxMutexGuiLeave() { wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); if ( wxThread::IsMain() ) { - gs_bGuiOwnedByMainThread = FALSE; + gs_bGuiOwnedByMainThread = false; } else { - // decrement the number of waiters now + // decrement the number of threads waiting for GUI access now wxASSERT_MSG( gs_nWaitingForGui > 0, wxT("calling wxMutexGuiLeave() without entering it first?") ); @@ -1103,7 +1324,7 @@ void WXDLLEXPORT wxMutexGuiLeave() gs_critsectGui->Leave(); } -void WXDLLEXPORT wxMutexGuiLeaveOrEnter() +void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter() { wxASSERT_MSG( wxThread::IsMain(), wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") ); @@ -1118,7 +1339,7 @@ void WXDLLEXPORT wxMutexGuiLeaveOrEnter() { gs_critsectGui->Enter(); - gs_bGuiOwnedByMainThread = TRUE; + gs_bGuiOwnedByMainThread = true; } //else: already have it, nothing to do } @@ -1133,25 +1354,31 @@ void WXDLLEXPORT wxMutexGuiLeaveOrEnter() } } -bool WXDLLEXPORT wxGuiOwnedByMainThread() +bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread() { return gs_bGuiOwnedByMainThread; } // wake up the main thread if it's in ::GetMessage() -void WXDLLEXPORT wxWakeUpMainThread() +void WXDLLIMPEXP_BASE wxWakeUpMainThread() { // sending any message would do - hopefully WM_NULL is harmless enough if ( !::PostThreadMessage(gs_idMainThread, WM_NULL, 0, 0) ) { // should never happen - wxLogLastError("PostThreadMessage(WM_NULL)"); + wxLogLastError(wxT("PostThreadMessage(WM_NULL)")); } } -bool WXDLLEXPORT wxIsWaitingForThread() +bool WXDLLIMPEXP_BASE wxIsWaitingForThread() { return gs_waitingForThread; } +// ---------------------------------------------------------------------------- +// include common implementation code +// ---------------------------------------------------------------------------- + +#include "wx/thrimpl.cpp" + #endif // wxUSE_THREADS