// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
- #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"
+
+#include "wx/dynlib.h"
// must have this symbol defined to get _beginthread/_endthread declarations
#ifndef _MT
#if defined(__VISUALC__) || \
(defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) || \
(defined(__GNUG__) && defined(__MSVCRT__)) || \
- defined(__WATCOMC__) || defined(__MWERKS__)
+ defined(__WATCOMC__)
#ifndef __WXWINCE__
#undef wxUSE_BEGIN_THREAD
// 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
// ----------------------------------------------------------------------------
// 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;
+// 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
// 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 and related classes
// wxCriticalSection
// ----------------------------------------------------------------------------
-wxCriticalSection::wxCriticalSection()
+wxCriticalSection::wxCriticalSection( wxCriticalSectionType WXUNUSED(critSecType) )
{
wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer),
wxCriticalSectionBufferTooSmall );
::EnterCriticalSection((CRITICAL_SECTION *)m_buffer);
}
+bool wxCriticalSection::TryEnter()
+{
+#if wxUSE_DYNLIB_CLASS
+ typedef BOOL
+ (WINAPI *TryEnterCriticalSection_t)(LPCRITICAL_SECTION lpCriticalSection);
+
+ static TryEnterCriticalSection_t
+ pfnTryEnterCriticalSection = (TryEnterCriticalSection_t)
+ wxDynamicLibrary(wxT("kernel32.dll")).
+ GetSymbol(wxT("TryEnterCriticalSection"));
+
+ return pfnTryEnterCriticalSection
+ ? (*pfnTryEnterCriticalSection)((CRITICAL_SECTION *)m_buffer) != 0
+ : false;
+#else
+ return false;
+#endif
+}
+
void wxCriticalSection::Leave()
{
::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer);
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;
- 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 // no name
);
+ m_type = mutexType;
+ m_owningThread = 0;
+
if ( !m_mutex )
{
- wxLogLastError(_T("CreateMutex()"));
+ wxLogLastError(wxT("CreateMutex()"));
}
+
}
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;
}
private:
HANDLE m_semaphore;
- DECLARE_NO_COPY_CLASS(wxSemaphoreInternal)
+ wxDECLARE_NO_COPY_CLASS(wxSemaphoreInternal);
};
wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount)
{
-#ifndef __WXWINCE__
+#if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300)
if ( maxcount == 0 )
{
// make it practically infinite
#endif
if ( !m_semaphore )
{
- wxLogLastError(_T("CreateSemaphore()"));
+ wxLogLastError(wxT("CreateSemaphore()"));
}
}
{
if ( !::CloseHandle(m_semaphore) )
{
- wxLogLastError(_T("CloseHandle(semaphore)"));
+ wxLogLastError(wxT("CloseHandle(semaphore)"));
}
}
}
return wxSEMA_TIMEOUT;
default:
- wxLogLastError(_T("WaitForSingleObject(semaphore)"));
+ wxLogLastError(wxT("WaitForSingleObject(semaphore)"));
}
return wxSEMA_MISC_ERROR;
wxSemaError wxSemaphoreInternal::Post()
{
-#ifndef __WXWINCE__
+#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;
- }
-
- return wxSEMA_NO_ERROR;
-}
-
-// --------------------------------------------------------------------------
-// wxCondition
-// --------------------------------------------------------------------------
-
-// Win32 doesn't have explicit support for the POSIX condition variables and
-// the Win32 events have quite different semantics, so we reimplement the
-// conditions from scratch using the mutexes and semaphores
-class wxConditionInternal
-{
-public:
- wxConditionInternal(wxMutex& mutex);
-
- bool IsOk() const { return m_mutex.IsOk() && m_semaphore.IsOk(); }
-
- wxCondError Wait();
- wxCondError WaitTimeout(unsigned long milliseconds);
-
- wxCondError Signal();
- wxCondError Broadcast();
-
-private:
- // the number of threads currently waiting for this condition
- LONG m_numWaiters;
-
- // the critical section protecting m_numWaiters
- wxCriticalSection m_csWaiters;
-
- wxMutex& m_mutex;
- wxSemaphore m_semaphore;
-
- DECLARE_NO_COPY_CLASS(wxConditionInternal)
-};
-
-wxConditionInternal::wxConditionInternal(wxMutex& mutex)
- : m_mutex(mutex)
-{
- // another thread can't access it until we return from ctor, so no need to
- // protect access to m_numWaiters here
- m_numWaiters = 0;
-}
-
-wxCondError wxConditionInternal::Wait()
-{
- // increment the number of waiters
- ::InterlockedIncrement(&m_numWaiters);
-
- m_mutex.Unlock();
-
- // a potential race condition can occur here
- //
- // after a thread increments nwaiters, and unlocks the mutex and before the
- // semaphore.Wait() is called, if another thread can cause a signal to be
- // generated
- //
- // this race condition is handled by using a semaphore and incrementing the
- // semaphore only if 'nwaiters' is greater that zero since the semaphore,
- // can 'remember' signals the race condition will not occur
-
- // wait ( if necessary ) and decrement semaphore
- wxSemaError err = m_semaphore.Wait();
- m_mutex.Lock();
-
- return err == wxSEMA_NO_ERROR ? wxCOND_NO_ERROR : wxCOND_MISC_ERROR;
-}
-
-wxCondError wxConditionInternal::WaitTimeout(unsigned long milliseconds)
-{
- ::InterlockedIncrement(&m_numWaiters);
-
- m_mutex.Unlock();
-
- // a race condition can occur at this point in the code
- //
- // please see the comments in Wait(), for details
-
- wxSemaError err = m_semaphore.WaitTimeout(milliseconds);
-
- if ( err == wxSEMA_BUSY )
- {
- // another potential race condition exists here it is caused when a
- // 'waiting' thread timesout, and returns from WaitForSingleObject, but
- // has not yet decremented 'nwaiters'.
- //
- // at this point if another thread calls signal() then the semaphore
- // will be incremented, but the waiting thread will miss it.
- //
- // to handle this particular case, the waiting thread calls
- // WaitForSingleObject again with a timeout of 0, after locking
- // 'nwaiters_mutex'. this call does not block because of the zero
- // timeout, but will allow the waiting thread to catch the missed
- // signals.
- wxCriticalSectionLocker lock(m_csWaiters);
-
- err = m_semaphore.WaitTimeout(0);
-
- if ( err != wxSEMA_NO_ERROR )
+ if ( GetLastError() == ERROR_TOO_MANY_POSTS )
{
- m_numWaiters--;
+ return wxSEMA_OVERFLOW;
+ }
+ else
+ {
+ wxLogLastError(wxT("ReleaseSemaphore"));
+ return wxSEMA_MISC_ERROR;
}
}
- m_mutex.Lock();
-
- return err == wxSEMA_NO_ERROR ? wxCOND_NO_ERROR : wxCOND_MISC_ERROR;
-}
-
-wxCondError wxConditionInternal::Signal()
-{
- wxCriticalSectionLocker lock(m_csWaiters);
-
- if ( m_numWaiters > 0 )
- {
- // increment the semaphore by 1
- if ( m_semaphore.Post() != wxSEMA_NO_ERROR )
- return wxCOND_MISC_ERROR;
-
- m_numWaiters--;
- }
-
- return wxCOND_NO_ERROR;
-}
-
-wxCondError wxConditionInternal::Broadcast()
-{
- wxCriticalSectionLocker lock(m_csWaiters);
-
- while ( m_numWaiters > 0 )
- {
- if ( m_semaphore.Post() != wxSEMA_NO_ERROR )
- return wxCOND_MISC_ERROR;
-
- m_numWaiters--;
- }
-
- return wxCOND_NO_ERROR;
+ return wxSEMA_NO_ERROR;
+#else
+ return wxSEMA_MISC_ERROR;
+#endif
}
// ----------------------------------------------------------------------------
class wxThreadInternal
{
public:
- wxThreadInternal()
+ wxThreadInternal(wxThread *thread)
{
+ m_thread = thread;
m_hThread = 0;
m_state = STATE_NEW;
- m_priority = WXTHREAD_DEFAULT_PRIORITY;
+ m_priority = wxPRIORITY_DEFAULT;
+ m_nRef = 1;
}
~wxThreadInternal()
// wait for the thread to terminate, either by itself, or by asking it
// (politely, this is not Kill()!) to do it
- wxThreadError WaitForTerminate(bool shouldCancel,
- wxCriticalSection& cs,
- wxThread::ExitCode *pRc);
+ wxThreadError WaitForTerminate(wxCriticalSection& cs,
+ wxThread::ExitCode *pRc,
+ wxThreadWait waitMode,
+ wxThread *threadToDelete = NULL);
// kill the thread unconditionally
wxThreadError Kill();
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() )
+ ::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
- DECLARE_NO_COPY_CLASS(wxThreadInternal)
+ // 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;
+
+ wxDECLARE_NO_COPY_CLASS(wxThreadInternal);
};
-THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param)
+// small class which keeps a thread alive during its lifetime
+class wxThreadKeepAlive
{
- THREAD_RETVAL rc;
- bool wasCancelled;
+public:
+ wxThreadKeepAlive(wxThreadInternal& thrImpl) : m_thrImpl(thrImpl)
+ { m_thrImpl.KeepAlive(); }
+ ~wxThreadKeepAlive()
+ { m_thrImpl.LetDie(); }
- // first of all, check whether we hadn't been cancelled already and don't
- // start the user code at all then
- wxThread *thread = (wxThread *)param;
- if ( thread->m_internal->GetState() == STATE_EXITED )
+private:
+ wxThreadInternal& m_thrImpl;
+};
+
+/* static */
+void wxThreadInternal::DoThreadOnExit(wxThread *thread)
+{
+ wxTRY
{
- rc = (THREAD_RETVAL)-1;
- wasCancelled = TRUE;
+ thread->OnExit();
}
- else // do run thread
+ wxCATCH_ALL( wxTheApp->OnUnhandledException(); )
+}
+
+/* static */
+THREAD_RETVAL wxThreadInternal::DoThreadStart(wxThread *thread)
+{
+ wxON_BLOCK_EXIT1(DoThreadOnExit, thread);
+
+ THREAD_RETVAL rc = THREAD_ERROR_EXIT;
+
+ wxTRY
{
// store the thread object in the TLS
if ( !::TlsSetValue(gs_tlsThisThread, thread) )
{
- wxLogSysError(_("Can not start thread: error writing TLS."));
+ wxLogSysError(_("Cannot 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(); )
- // enter m_critsect before changing the thread state
- thread->m_critsect.Enter();
- wasCancelled = thread->m_internal->GetState() == STATE_CANCELED;
- thread->m_internal->SetState(STATE_EXITED);
- thread->m_critsect.Leave();
+ 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();
+
+ // NB: Notice that we can't use wxCriticalSectionLocker in this function as
+ // we use SEH and it's incompatible with C++ object dtors.
+
+ // first of all, check whether we hadn't been cancelled already and don't
+ // start the user code at all then
+ thread->m_critsect.Enter();
+ const bool hasExited = thread->m_internal->GetState() == STATE_EXITED;
+ thread->m_critsect.Leave();
+
+ // 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();
- // if the thread was cancelled (from Delete()), then its handle is still
- // needed there
- if ( thread->IsDetached() && !wasCancelled )
+ // 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 )
{
- // auto delete
- delete thread;
+ thread->m_critsect.Enter();
+ thread->m_internal->SetState(STATE_EXITED);
+ thread->m_critsect.Leave();
}
- //else: the joinable threads handle will be closed when Wait() is done
+
+ // the thread may delete itself now if it wants, we don't need it any more
+ 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;
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
{
wxLogSysError(_("Can't create thread"));
- return FALSE;
+ return false;
}
- if ( m_priority != WXTHREAD_DEFAULT_PRIORITY )
+ if ( m_priority != wxPRIORITY_DEFAULT )
{
SetPriority(m_priority);
}
- return TRUE;
+ return true;
}
wxThreadError wxThreadInternal::Kill()
{
- if ( !::TerminateThread(m_hThread, (DWORD)-1) )
+ m_thread->OnKill();
+
+ if ( !::TerminateThread(m_hThread, THREAD_ERROR_EXIT) )
{
wxLogSysError(_("Couldn't terminate thread"));
}
wxThreadError
-wxThreadInternal::WaitForTerminate(bool shouldCancel,
- wxCriticalSection& cs,
- wxThread::ExitCode *pRc)
+wxThreadInternal::WaitForTerminate(wxCriticalSection& cs,
+ wxThread::ExitCode *pRc,
+ wxThreadWait waitMode,
+ wxThread *threadToDelete)
{
- wxThread::ExitCode rc = 0;
+ // 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;
- // 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);
if ( m_state == STATE_NEW )
{
- if ( shouldCancel )
+ 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
+ // 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;
- Resume(); // it knows about STATE_EXITED special case
-
- shouldCancel = FALSE;
+ // 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
+ else // running, paused, cancelled or even exited
{
shouldResume = m_state == STATE_PAUSED;
}
if ( shouldResume )
Resume();
- // does is still run?
- if ( isRunning || m_state == STATE_RUNNING )
+ // ask the thread to terminate
+ if ( shouldDelete )
+ {
+ wxCriticalSectionLocker lock(cs);
+
+ Cancel();
+ }
+
+ if ( threadToDelete )
+ threadToDelete->OnDelete();
+
+ // 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 ( shouldCancel )
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits )
{
- wxCriticalSectionLocker lock(cs);
-
- Cancel();
+ result = traits->WaitForThread(m_hThread, waitMode);
+ }
+ 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 = 0; // suppress warnings from broken compilers
- 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(_("Cannot 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
+ 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()
DWORD nSuspendCount = ::SuspendThread(m_hThread);
if ( nSuspendCount == (DWORD)-1 )
{
- wxLogSysError(_("Can not suspend thread %x"), m_hThread);
+ wxLogSysError(_("Cannot suspend thread %lx"),
+ static_cast<unsigned long>(wxPtrToUInt(m_hThread)));
- return FALSE;
+ return false;
}
m_state = STATE_PAUSED;
- return TRUE;
+ return true;
}
bool wxThreadInternal::Resume()
DWORD nSuspendCount = ::ResumeThread(m_hThread);
if ( nSuspendCount == (DWORD)-1 )
{
- wxLogSysError(_("Can not resume thread %x"), m_hThread);
+ wxLogSysError(_("Cannot resume thread %lx"),
+ static_cast<unsigned long>(wxPtrToUInt(m_hThread)));
- return FALSE;
+ return false;
}
// 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;
}
- return TRUE;
+ return true;
}
// static functions
return thread;
}
-bool wxThread::IsMain()
-{
- return ::GetCurrentThreadId() == gs_idMainThread;
-}
-
-#ifdef Yield
-#undef Yield
-#endif
-
void wxThread::Yield()
{
// 0 argument to Sleep() is special and means to just give away the rest of
::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__
- wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") );
+#ifdef __WXWINCE__
+ return false;
+#else
+ wxASSERT_MSG( IsMain(), wxT("should only be called from the main thread") );
// ok only for the default one
if ( level == 0 )
// get system affinity mask first
HANDLE hProcess = ::GetCurrentProcess();
- DWORD dwProcMask, dwSysMask;
+ DWORD_PTR dwProcMask, dwSysMask;
if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 )
{
- wxLogLastError(_T("GetProcessAffinityMask"));
+ wxLogLastError(wxT("GetProcessAffinityMask"));
- return FALSE;
+ return false;
}
// how many CPUs have we got?
dwProcMask |= bit;
// another process added
- if ( !--level )
+ if ( --level == 0 )
{
// and that's enough
break;
// 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;
+ return false;
}
// 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)
// 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 )
{
// msg given above - do it only once
- return FALSE;
+ return false;
}
if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 )
{
- wxLogLastError(_T("SetProcessAffinityMask"));
+ wxLogLastError(wxT("SetProcessAffinityMask"));
- return FALSE;
+ return false;
}
-#endif
- return TRUE;
+
+ return true;
+#endif // __WXWINCE__/!__WXWINCE__
}
// ctor and dtor
wxThread::wxThread(wxThreadKind kind)
{
- m_internal = new wxThreadInternal();
+ m_internal = new wxThreadInternal(this);
m_isDetached = kind == wxTHREAD_DETACHED;
}
{
wxCriticalSectionLocker lock(m_critsect);
- if ( m_internal->GetState() != STATE_NEW )
- {
- // actually, it may be almost any state at all, not only STATE_RUNNING
- return wxTHREAD_RUNNING;
- }
+ wxCHECK_MSG( m_internal->GetState() == STATE_NEW, wxTHREAD_RUNNING,
+ wxT("thread may only be started once after Create()") );
// the thread has just been created and is still suspended - let it run
return Resume();
// stopping thread
// ---------------
-wxThread::ExitCode wxThread::Wait()
+wxThread::ExitCode wxThread::Wait(wxThreadWait waitMode)
{
+ 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(false, m_critsect, &rc);
-
- m_internal->Free();
-
- wxCriticalSectionLocker lock(m_critsect);
- m_internal->SetState(STATE_EXITED);
+ (void)m_internal->WaitForTerminate(m_critsect, &rc, waitMode);
return rc;
}
-wxThreadError wxThread::Delete(ExitCode *pRc)
+wxThreadError wxThread::Delete(ExitCode *pRc, wxThreadWait waitMode)
{
- wxThreadError rc = m_internal->WaitForTerminate(true, m_critsect, pRc);
-
- if ( IsDetached() )
- {
- delete this;
- }
- else // joinable
- {
- // update the status of the joinable thread
- wxCriticalSectionLocker lock(m_critsect);
- m_internal->SetState(STATE_EXITED);
- }
-
- return rc;
+ return m_internal->WaitForTerminate(m_critsect, pRc, waitMode, this);
}
wxThreadError wxThread::Kill()
void wxThread::Exit(ExitCode status)
{
+ wxThreadInternal::DoThreadOnExit(this);
+
m_internal->Free();
if ( IsDetached() )
}
#ifdef wxUSE_BEGIN_THREAD
- _endthreadex((unsigned)status);
+ _endthreadex(wxPtrToUInt(status));
#else // !VC++
::ExitThread((DWORD)status);
#endif // VC++/!VC++
unsigned int wxThread::GetPriority() const
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return m_internal->GetPriority();
}
unsigned long wxThread::GetId() const
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return (unsigned long)m_internal->GetId();
}
bool wxThread::IsRunning() const
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return m_internal->GetState() == STATE_RUNNING;
}
bool wxThread::IsAlive() const
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return (m_internal->GetState() == STATE_RUNNING) ||
(m_internal->GetState() == STATE_PAUSED);
bool wxThread::IsPaused() const
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return m_internal->GetState() == STATE_PAUSED;
}
bool wxThread::TestDestroy()
{
- wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
+ wxCriticalSectionLocker lock(const_cast<wxCriticalSection &>(m_critsect));
return m_internal->GetState() == STATE_CANCELED;
}
// words, this should never happen
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
::TlsFree(gs_tlsThisThread);
gs_tlsThisThread = 0xFFFFFFFF;
- wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage"));
+ wxLogSysError(_("Thread module initialization failed: cannot store value in thread local storage"));
- return FALSE;
+ return false;
}
gs_critsectWaitingForGui = new wxCriticalSection();
gs_critsectGui = new wxCriticalSection();
gs_critsectGui->Enter();
- // no error return for GetCurrentThreadId()
- gs_idMainThread = ::GetCurrentThreadId();
+ gs_critsectThreadDelete = new wxCriticalSection;
- return TRUE;
+ wxThread::ms_idMainThread = wxThread::GetCurrentId();
+
+ return true;
}
void wxThreadModule::OnExit()
wxLogLastError(wxT("TlsFree failed."));
}
+ wxDELETE(gs_critsectThreadDelete);
+
if ( gs_critsectGui )
{
gs_critsectGui->Leave();
- delete gs_critsectGui;
- gs_critsectGui = NULL;
+ wxDELETE(gs_critsectGui);
}
- delete gs_critsectWaitingForGui;
- gs_critsectWaitingForGui = NULL;
+ wxDELETE(gs_critsectWaitingForGui);
}
// ----------------------------------------------------------------------------
// 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);
if ( wxThread::IsMain() )
{
- gs_bGuiOwnedByMainThread = FALSE;
+ gs_bGuiOwnedByMainThread = false;
}
else
{
{
gs_critsectGui->Enter();
- gs_bGuiOwnedByMainThread = TRUE;
+ gs_bGuiOwnedByMainThread = true;
}
//else: already have it, nothing to do
}
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)"));
#include "wx/thrimpl.cpp"
#endif // wxUSE_THREADS
-
projects / wxWidgets.git / blobdiff