// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "thread.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#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
// this is where _beginthreadex() is declared
#include <process.h>
- // 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
#define THREAD_CALLCONV WINAPI
#endif
+static const THREAD_RETVAL THREAD_ERROR_EXIT = (THREAD_RETVAL)-1;
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
// wxCriticalSection
// ----------------------------------------------------------------------------
-wxCriticalSection::wxCriticalSection()
+wxCriticalSection::wxCriticalSection( wxCriticalSectionType WXUNUSED(critSecType) )
{
wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer),
wxCriticalSectionBufferTooSmall );
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:
HANDLE m_mutex;
+ unsigned long m_owningThread;
+ wxMutexType m_type;
+
DECLARE_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()"));
}
+
}
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);
- 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(_T("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
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()"));
{
#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
}
// ----------------------------------------------------------------------------
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() )
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_ERROR_EXIT;
- 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_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();
-
- 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;
}
{
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;
wxThreadError wxThreadInternal::Kill()
{
- if ( !::TerminateThread(m_hThread, (DWORD)-1) )
+ if ( !::TerminateThread(m_hThread, THREAD_ERROR_EXIT) )
{
wxLogSysError(_("Couldn't terminate thread"));
// from Wait()) or ask it to terminate (when called from Delete())
bool shouldDelete = threadToDelete != NULL;
- wxThread::ExitCode rc = 0;
+ DWORD 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);
// 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: shouldResume is correctly set to false here, wait until
+ // someone else runs the thread and it finishes
}
- else if ( m_state == STATE_EXITED )
- {
- return wxTHREAD_NOT_RUNNING;
- }
- else // running (but maybe paused or cancelled)
+ else // running, paused, cancelled or even exited
{
shouldResume = m_state == STATE_PAUSED;
}
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
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
}
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()
// 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;
::Sleep(0);
}
-void wxThread::Sleep(unsigned long milliseconds)
-{
- ::Sleep(milliseconds);
-}
-
int wxThread::GetCPUCount()
{
SYSTEM_INFO si;
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
dwProcMask |= bit;
// another process added
- if ( !--level )
+ if ( --level == 0 )
{
// and that's enough
break;
// 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;
return false;
}
-#endif // !__WXWINCE__
return true;
+#endif // __WXWINCE__/!__WXWINCE__
}
// ctor and dtor
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,
+ 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;
}
#ifdef wxUSE_BEGIN_THREAD
- _endthreadex((unsigned)status);
+ _endthreadex(wxPtrToUInt(status));
#else // !VC++
::ExitThread((DWORD)status);
#endif // VC++/!VC++
// 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(),
gs_critsectGui->Enter();
}
-void WXDLLIMPEXP_BASE wxMutexGuiLeave()
+void wxMutexGuiLeaveImpl()
{
wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
#include "wx/thrimpl.cpp"
#endif // wxUSE_THREADS
-
projects / wxWidgets.git / blobdiff