X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bee503b05f2e67035e1f45bd33e94451daeceb31..b6c8bd695963b52cec60cf2247bf4b1651d889d8:/src/msw/thread.cpp diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index eb0f663724..f76f9a4c7b 100644 --- a/src/msw/thread.cpp +++ b/src/msw/thread.cpp @@ -26,48 +26,84 @@ #endif #ifndef WX_PRECOMP - #include "wx/wx.h" +# include "wx/wx.h" #endif #if wxUSE_THREADS -#include - -#include +#include "wx/msw/private.h" #include "wx/module.h" #include "wx/thread.h" -enum thread_state +#ifdef Yield +# undef Yield +#endif + +// must have this symbol defined to get _beginthread/_endthread declarations +#ifndef _MT + #define _MT +#endif + +#if defined(__VISUALC__) || \ + (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) || \ + (defined(__GNUG__) && defined(__MSVCRT__)) + +#if defined(__BORLANDC__) && !defined(__MT__) +// I can't set -tWM in the IDE (anyone?) so have to do this +#define __MT__ +#endif + +#if defined(__BORLANDC__) && !defined(__MFC_COMPAT__) +// Needed to know about _beginthreadex etc.. +#define __MFC_COMPAT__ +#endif + + #include +#endif + +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + +// the possible states of the thread ("=>" shows all possible transitions from +// this state) +enum wxThreadState { - STATE_IDLE = 0, - STATE_RUNNING, - STATE_PAUSED, - STATE_CANCELED, - STATE_EXITED + STATE_NEW, // didn't start execution yet (=> RUNNING) + STATE_RUNNING, // thread is running (=> PAUSED, CANCELED) + STATE_PAUSED, // thread is temporarily suspended (=> RUNNING) + STATE_CANCELED, // thread should terminate a.s.a.p. (=> EXITED) + STATE_EXITED // thread is terminating }; // ---------------------------------------------------------------------------- -// static variables +// this module globals // ---------------------------------------------------------------------------- +// TLS index of the slot where we store the pointer to the current thread +static DWORD gs_tlsThisThread = 0xFFFFFFFF; + // id of the main thread - the one which can call GUI functions without first // calling wxMutexGuiEnter() -static DWORD s_idMainThread = 0; +static DWORD gs_idMainThread = 0; // if it's FALSE, some secondary thread is holding the GUI lock -static bool s_bGuiOwnedByMainThread = TRUE; +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 // any GUI calls -static wxCriticalSection *s_critsectGui = NULL; +static wxCriticalSection *gs_critsectGui = NULL; -// critical section which protects s_nWaitingForGui variable -static wxCriticalSection *s_critsectWaitingForGui = NULL; +// critical section which protects gs_nWaitingForGui variable +static wxCriticalSection *gs_critsectWaitingForGui = NULL; // number of threads waiting for GUI in wxMutexGuiEnter() -static size_t s_nWaitingForGui = 0; +static size_t gs_nWaitingForGui = 0; + +// are we waiting for a thread termination? +static bool gs_waitingForThread = FALSE; // ============================================================================ // Windows implementation of thread classes @@ -76,36 +112,47 @@ static size_t s_nWaitingForGui = 0; // ---------------------------------------------------------------------------- // wxMutex implementation // ---------------------------------------------------------------------------- + class wxMutexInternal { public: - HANDLE p_mutex; + wxMutexInternal() + { + m_mutex = ::CreateMutex(NULL, FALSE, NULL); + if ( !m_mutex ) + { + wxLogSysError(_("Can not create mutex")); + } + } + + ~wxMutexInternal() { if ( m_mutex ) CloseHandle(m_mutex); } + +public: + HANDLE m_mutex; }; wxMutex::wxMutex() { - p_internal = new wxMutexInternal; - p_internal->p_mutex = CreateMutex(NULL, FALSE, NULL); - if ( !p_internal->p_mutex ) - { - wxLogSysError(_("Can not create mutex.")); - } + m_internal = new wxMutexInternal; m_locked = 0; } wxMutex::~wxMutex() { - if (m_locked > 0) - wxLogDebug("Warning: freeing a locked mutex (%d locks).", m_locked); - CloseHandle(p_internal->p_mutex); + if ( m_locked > 0 ) + { + wxLogDebug(_T("Warning: freeing a locked mutex (%d locks)."), m_locked); + } + + delete m_internal; } wxMutexError wxMutex::Lock() { DWORD ret; - ret = WaitForSingleObject(p_internal->p_mutex, INFINITE); + ret = WaitForSingleObject(m_internal->m_mutex, INFINITE); switch ( ret ) { case WAIT_ABANDONED: @@ -121,7 +168,7 @@ wxMutexError wxMutex::Lock() case WAIT_TIMEOUT: default: - wxFAIL_MSG("impossible return value in wxMutex::Lock"); + wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock")); } m_locked++; @@ -132,7 +179,7 @@ wxMutexError wxMutex::TryLock() { DWORD ret; - ret = WaitForSingleObject(p_internal->p_mutex, 0); + ret = WaitForSingleObject(m_internal->m_mutex, 0); if (ret == WAIT_TIMEOUT || ret == WAIT_ABANDONED) return wxMUTEX_BUSY; @@ -145,7 +192,7 @@ wxMutexError wxMutex::Unlock() if (m_locked > 0) m_locked--; - BOOL ret = ReleaseMutex(p_internal->p_mutex); + BOOL ret = ReleaseMutex(m_internal->m_mutex); if ( ret == 0 ) { wxLogSysError(_("Couldn't release a mutex")); @@ -162,319 +209,844 @@ wxMutexError wxMutex::Unlock() class wxConditionInternal { public: - HANDLE event; - int waiters; -}; + wxConditionInternal() + { + m_hEvent = ::CreateEvent( + NULL, // default secutiry + FALSE, // not manual reset + FALSE, // nonsignaled initially + NULL // nameless event + ); + if ( !m_hEvent ) + { + wxLogSysError(_("Can not create event object.")); + } -wxCondition::wxCondition() -{ - p_internal = new wxConditionInternal; - p_internal->event = CreateEvent(NULL, FALSE, FALSE, NULL); - if ( !p_internal->event ) + // nobody waits for us yet + m_nWaiters = 0; + } + + bool Wait(DWORD timeout) + { + // as m_nWaiters variable is accessed from multiple waiting threads + // (and possibly from the broadcasting thread), we need to change its + // value atomically + ::InterlockedIncrement(&m_nWaiters); + + // FIXME this should be MsgWaitForMultipleObjects() as we want to keep + // processing Windows messages while waiting (or don't we?) + DWORD rc = ::WaitForSingleObject(m_hEvent, timeout); + + ::InterlockedDecrement(&m_nWaiters); + + return rc != WAIT_TIMEOUT; + } + + void Signal() + { + // 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_hEvent) ) + { + wxLogLastError(wxT("SetEvent")); + } + } + + void Broadcast() { - wxLogSysError(_("Can not create event object.")); + // we need to save the original value as m_nWaiters is goign to be + // decreased by the signalled thread resulting in the loop being + // executed less times than needed + LONG nWaiters = m_nWaiters; + + // 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 ( LONG n = 0; n < nWaiters; n++ ) + { + Signal(); + } + } + + ~wxConditionInternal() + { + if ( m_hEvent ) + { + if ( !::CloseHandle(m_hEvent) ) + { + wxLogLastError(wxT("CloseHandle(event)")); + } + } } - p_internal->waiters = 0; +private: + // the Win32 synchronization object corresponding to this event + HANDLE m_hEvent; + + // number of threads waiting for this condition + LONG m_nWaiters; +}; + +wxCondition::wxCondition() +{ + m_internal = new wxConditionInternal; } wxCondition::~wxCondition() { - CloseHandle(p_internal->event); + delete m_internal; } -void wxCondition::Wait(wxMutex& mutex) +void wxCondition::Wait() { - mutex.Unlock(); - p_internal->waiters++; - WaitForSingleObject(p_internal->event, INFINITE); - p_internal->waiters--; - mutex.Lock(); + (void)m_internal->Wait(INFINITE); } -bool wxCondition::Wait(wxMutex& mutex, - unsigned long sec, +bool wxCondition::Wait(unsigned long sec, unsigned long nsec) { - DWORD ret; - - mutex.Unlock(); - p_internal->waiters++; - ret = WaitForSingleObject(p_internal->event, (sec*1000)+(nsec/1000000)); - p_internal->waiters--; - mutex.Lock(); - - return (ret != WAIT_TIMEOUT); + return m_internal->Wait(sec*1000 + nsec/1000000); } void wxCondition::Signal() { - SetEvent(p_internal->event); + m_internal->Signal(); } void wxCondition::Broadcast() { - int i; - - for (i=0;iwaiters;i++) - { - if ( SetEvent(p_internal->event) == 0 ) - { - wxLogSysError(_("Couldn't change the state of event object.")); - } - } + m_internal->Broadcast(); } // ---------------------------------------------------------------------------- // wxCriticalSection implementation // ---------------------------------------------------------------------------- -class wxCriticalSectionInternal -{ -public: - // init the critical section object - wxCriticalSectionInternal() - { ::InitializeCriticalSection(&m_data); } - - // implicit cast to the associated data - operator CRITICAL_SECTION *() { return &m_data; } - - // free the associated ressources - ~wxCriticalSectionInternal() - { ::DeleteCriticalSection(&m_data); } - -private: - CRITICAL_SECTION m_data; -}; - wxCriticalSection::wxCriticalSection() { - m_critsect = new wxCriticalSectionInternal; +#ifdef __WXDEBUG__ + // Done this way to stop warnings during compilation about statement + // always being false + int csSize = sizeof(CRITICAL_SECTION); + int bSize = sizeof(m_buffer); + wxASSERT_MSG( csSize <= bSize, + _T("must increase buffer size in wx/thread.h") ); +#endif + + ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer); } wxCriticalSection::~wxCriticalSection() { - delete m_critsect; + ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer); } void wxCriticalSection::Enter() { - ::EnterCriticalSection(*m_critsect); + ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer); } void wxCriticalSection::Leave() { - ::LeaveCriticalSection(*m_critsect); + ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer); } // ---------------------------------------------------------------------------- // wxThread implementation // ---------------------------------------------------------------------------- +// wxThreadInternal class +// ---------------------- + class wxThreadInternal { public: + wxThreadInternal() + { + m_hThread = 0; + m_state = STATE_NEW; + m_priority = WXTHREAD_DEFAULT_PRIORITY; + } + + ~wxThreadInternal() + { + Free(); + } + + void Free() + { + if ( m_hThread ) + { + if ( !::CloseHandle(m_hThread) ) + { + wxLogLastError(wxT("CloseHandle(thread)")); + } + + m_hThread = 0; + } + } + + // create a new (suspended) thread (for the given thread object) + bool Create(wxThread *thread); + + // suspend/resume/terminate + bool Suspend(); + bool Resume(); + void Cancel() { m_state = STATE_CANCELED; } + + // thread state + void SetState(wxThreadState state) { m_state = state; } + wxThreadState GetState() const { return m_state; } + + // thread priority + void SetPriority(unsigned int priority); + unsigned int GetPriority() const { return m_priority; } + + // thread handle and id + HANDLE GetHandle() const { return m_hThread; } + DWORD GetId() const { return m_tid; } + + // thread function static DWORD WinThreadStart(wxThread *thread); - HANDLE hThread; - thread_state state; - int prio, defer; - DWORD tid; +private: + 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 }; DWORD wxThreadInternal::WinThreadStart(wxThread *thread) { - DWORD ret = (DWORD)thread->Entry(); - thread->p_internal->state = STATE_EXITED; + DWORD rc; + bool wasCancelled; + + // 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 = (DWORD)-1; + wasCancelled = TRUE; + } + else // do run thread + { + // store the thread object in the TLS + if ( !::TlsSetValue(gs_tlsThisThread, thread) ) + { + wxLogSysError(_("Can not start thread: error writing TLS.")); + + return (DWORD)-1; + } + + rc = (DWORD)thread->Entry(); + + // 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(); + } + thread->OnExit(); - return ret; + // if the thread was cancelled (from Delete()), then its handle is still + // needed there + if ( thread->IsDetached() && !wasCancelled ) + { + // auto delete + delete thread; + } + //else: the joinable threads handle will be closed when Wait() is done + + return rc; } -wxThreadError wxThread::Create() +void wxThreadInternal::SetPriority(unsigned int priority) { - p_internal->hThread = ::CreateThread - ( - NULL, // default security - 0, // default stack size - (LPTHREAD_START_ROUTINE) - wxThreadInternal::WinThreadStart, // entry point - (void *)this, // parameter - CREATE_SUSPENDED, // flags - &p_internal->tid // [out] thread id - ); + m_priority = priority; + + // translate wxWindows priority to the Windows one + int win_priority; + if (m_priority <= 20) + win_priority = THREAD_PRIORITY_LOWEST; + else if (m_priority <= 40) + win_priority = THREAD_PRIORITY_BELOW_NORMAL; + else if (m_priority <= 60) + win_priority = THREAD_PRIORITY_NORMAL; + else if (m_priority <= 80) + win_priority = THREAD_PRIORITY_ABOVE_NORMAL; + else if (m_priority <= 100) + win_priority = THREAD_PRIORITY_HIGHEST; + else + { + wxFAIL_MSG(wxT("invalid value of thread priority parameter")); + win_priority = THREAD_PRIORITY_NORMAL; + } - if ( p_internal->hThread == NULL ) + if ( !::SetThreadPriority(m_hThread, win_priority) ) { - wxLogSysError(_("Can't create thread")); - return wxTHREAD_NO_RESOURCE; + wxLogSysError(_("Can't set thread priority")); } +} - int win_prio, prio = p_internal->prio; - if (prio <= 20) - win_prio = THREAD_PRIORITY_LOWEST; - else if (prio <= 40) - win_prio = THREAD_PRIORITY_BELOW_NORMAL; - else if (prio <= 60) - win_prio = THREAD_PRIORITY_NORMAL; - else if (prio <= 80) - win_prio = THREAD_PRIORITY_ABOVE_NORMAL; - else if (prio <= 100) - win_prio = THREAD_PRIORITY_HIGHEST; - else +bool wxThreadInternal::Create(wxThread *thread) +{ + // 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)) || \ + (defined(__GNUG__) && defined(__MSVCRT__)) + typedef unsigned (__stdcall *RtlThreadStart)(void *); + + m_hThread = (HANDLE)_beginthreadex(NULL, 0, + (RtlThreadStart) + wxThreadInternal::WinThreadStart, + 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, // + (LPVOID)thread, // parameter + CREATE_SUSPENDED, // flags + &m_tid // [out] thread id + ); +#endif // _beginthreadex/CreateThread + + if ( m_hThread == NULL ) { - wxFAIL_MSG("invalid value of thread priority parameter"); - win_prio = THREAD_PRIORITY_NORMAL; + wxLogSysError(_("Can't create thread")); + + return FALSE; } - if ( SetThreadPriority(p_internal->hThread, win_prio) == 0 ) + if ( m_priority != WXTHREAD_DEFAULT_PRIORITY ) { - wxLogSysError(_("Can't set thread priority")); + SetPriority(m_priority); } - return Resume(); + return TRUE; } -wxThreadError wxThread::Destroy() +bool wxThreadInternal::Suspend() { - if ( p_internal->state != STATE_RUNNING ) - return wxTHREAD_NOT_RUNNING; + DWORD nSuspendCount = ::SuspendThread(m_hThread); + if ( nSuspendCount == (DWORD)-1 ) + { + wxLogSysError(_("Can not suspend thread %x"), m_hThread); + + return FALSE; + } + + m_state = STATE_PAUSED; - if ( p_internal->defer ) + return TRUE; +} + +bool wxThreadInternal::Resume() +{ + DWORD nSuspendCount = ::ResumeThread(m_hThread); + if ( nSuspendCount == (DWORD)-1 ) { - // soft termination: just set the flag and wait until the thread - // auto terminates - p_internal->state = STATE_CANCELED; + wxLogSysError(_("Can not resume thread %x"), m_hThread); + + return FALSE; } - else + + // 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 + if ( m_state != STATE_EXITED ) { - // kill the thread - OnExit(); - if ( ::TerminateThread(p_internal->hThread, 0) == 0 ) - { - wxLogLastError("TerminateThread"); - } + m_state = STATE_RUNNING; } - return wxTHREAD_NO_ERROR; + return TRUE; } -wxThreadError wxThread::Pause() +// static functions +// ---------------- + +wxThread *wxThread::This() { - DWORD nSuspendCount = ::SuspendThread(p_internal->hThread); - if ( nSuspendCount == (DWORD)-1 ) + wxThread *thread = (wxThread *)::TlsGetValue(gs_tlsThisThread); + + // be careful, 0 may be a valid return value as well + if ( !thread && (::GetLastError() != NO_ERROR) ) { - wxLogSysError(_("Can not suspend thread %x"), p_internal->hThread); + wxLogSysError(_("Couldn't get the current thread pointer")); - return wxTHREAD_MISC_ERROR; // no idea what might provoke this error... + // return NULL... } - p_internal->state = STATE_PAUSED; + return thread; +} - return wxTHREAD_NO_ERROR; +bool wxThread::IsMain() +{ + return ::GetCurrentThreadId() == gs_idMainThread; } -wxThreadError wxThread::Resume() +#ifdef Yield +#undef Yield +#endif + +void wxThread::Yield() { - DWORD nSuspendCount = ::ResumeThread(p_internal->hThread); - if ( nSuspendCount == (DWORD)-1 ) + // 0 argument to Sleep() is special and means to just give away the rest of + // our timeslice + ::Sleep(0); +} + +void wxThread::Sleep(unsigned long milliseconds) +{ + ::Sleep(milliseconds); +} + +int wxThread::GetCPUCount() +{ + SYSTEM_INFO si; + GetSystemInfo(&si); + + return si.dwNumberOfProcessors; +} + +bool wxThread::SetConcurrency(size_t level) +{ + wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") ); + + // ok only for the default one + if ( level == 0 ) + return 0; + + // get system affinity mask first + HANDLE hProcess = ::GetCurrentProcess(); + DWORD dwProcMask, dwSysMask; + if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 ) + { + wxLogLastError(_T("GetProcessAffinityMask")); + + return FALSE; + } + + // how many CPUs have we got? + if ( dwSysMask == 1 ) + { + // don't bother with all this complicated stuff - on a single + // processor system it doesn't make much sense anyhow + return level == 1; + } + + // calculate the process mask: it's a bit vector with one bit per + // processor; we want to schedule the process to run on first level + // CPUs + DWORD bit = 1; + while ( bit ) + { + if ( dwSysMask & bit ) + { + // ok, we can set this bit + dwProcMask |= bit; + + // another process added + if ( !--level ) + { + // and that's enough + break; + } + } + + // next bit + bit <<= 1; + } + + // could we set all bits? + if ( level != 0 ) + { + wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level); + + 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); + + // can use static var because we're always in the main thread here + static SETPROCESSAFFINITYMASK pfnSetProcessAffinityMask = NULL; + + if ( !pfnSetProcessAffinityMask ) + { + HMODULE hModKernel = ::LoadLibrary(_T("kernel32")); + if ( hModKernel ) + { + pfnSetProcessAffinityMask = (SETPROCESSAFFINITYMASK) + ::GetProcAddress(hModKernel, "SetProcessAffinityMask"); + } + + // we've discovered a MT version of Win9x! + wxASSERT_MSG( pfnSetProcessAffinityMask, + _T("this system has several CPUs but no SetProcessAffinityMask function?") ); + } + + if ( !pfnSetProcessAffinityMask ) + { + // msg given above - do it only once + return FALSE; + } + + if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 ) { - wxLogSysError(_("Can not resume thread %x"), p_internal->hThread); + wxLogLastError(_T("SetProcessAffinityMask")); - return wxTHREAD_MISC_ERROR; // no idea what might provoke this error... + return FALSE; } - p_internal->state = STATE_RUNNING; + return TRUE; +} + +// ctor and dtor +// ------------- + +wxThread::wxThread(wxThreadKind kind) +{ + m_internal = new wxThreadInternal(); + + m_isDetached = kind == wxTHREAD_DETACHED; +} + +wxThread::~wxThread() +{ + delete m_internal; +} + +// create/start thread +// ------------------- + +wxThreadError wxThread::Create() +{ + wxCriticalSectionLocker lock(m_critsect); + + if ( !m_internal->Create(this) ) + return wxTHREAD_NO_RESOURCE; return wxTHREAD_NO_ERROR; } -void wxThread::Exit(void *status) +wxThreadError wxThread::Run() { - p_internal->state = STATE_EXITED; - ExitThread((DWORD)status); + 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; + } + + // the thread has just been created and is still suspended - let it run + return Resume(); } -void wxThread::SetPriority(int prio) +// suspend/resume thread +// --------------------- + +wxThreadError wxThread::Pause() { - p_internal->prio = prio; + wxCriticalSectionLocker lock(m_critsect); + + return m_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; } -int wxThread::GetPriority() const +wxThreadError wxThread::Resume() { - return p_internal->prio; + wxCriticalSectionLocker lock(m_critsect); + + return m_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; } -void wxThread::DeferDestroy(bool on) +// stopping thread +// --------------- + +wxThread::ExitCode wxThread::Wait() { - p_internal->defer = on; + // 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") ); + + ExitCode rc = (ExitCode)-1; + + (void)Delete(&rc); + + m_internal->Free(); + + return rc; } -bool wxThread::TestDestroy() +wxThreadError wxThread::Delete(ExitCode *pRc) { - return p_internal->state == STATE_CANCELED; + ExitCode rc = 0; + + // Delete() is always safe to call, so consider all possible states + + // 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, + shouldCancel = TRUE, + isRunning = FALSE; + + // check if the thread already started to run + { + wxCriticalSectionLocker lock(m_critsect); + + if ( m_internal->GetState() == STATE_NEW ) + { + // 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_internal->SetState(STATE_EXITED); + + Resume(); // it knows about STATE_EXITED special case + + shouldCancel = FALSE; + isRunning = TRUE; + + // shouldResume is correctly set to FALSE here + } + else + { + shouldResume = IsPaused(); + } + } + + // resume the thread if it is paused + if ( shouldResume ) + Resume(); + + HANDLE hThread = m_internal->GetHandle(); + + // does is still run? + if ( isRunning || IsRunning() ) + { + if ( IsMain() ) + { + // set flag for wxIsWaitingForThread() + gs_waitingForThread = TRUE; + +#if wxUSE_GUI + wxBeginBusyCursor(); +#endif // wxUSE_GUI + } + + // ask the thread to terminate + if ( shouldCancel ) + { + 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(wxT("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 thread 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; } -void *wxThread::Join() +wxThreadError wxThread::Kill() { - DWORD exit_code; + if ( !IsRunning() ) + return wxTHREAD_NOT_RUNNING; - if (p_internal->state == STATE_IDLE) - return NULL; + if ( !::TerminateThread(m_internal->GetHandle(), (DWORD)-1) ) + { + wxLogSysError(_("Couldn't terminate thread")); - // FIXME this dead locks... wxThread class design must be changed -#if 0 - WaitForSingleObject(p_internal->hThread, INFINITE); -#else - ::TerminateThread(p_internal->hThread, 0); -#endif // 0 + return wxTHREAD_MISC_ERROR; + } - GetExitCodeThread(p_internal->hThread, &exit_code); - CloseHandle(p_internal->hThread); + m_internal->Free(); - p_internal->state = STATE_IDLE; + if ( IsDetached() ) + { + delete this; + } - return (void *)exit_code; + return wxTHREAD_NO_ERROR; } -unsigned long wxThread::GetID() const +void wxThread::Exit(ExitCode status) { - return (unsigned long)p_internal->tid; + m_internal->Free(); + + if ( IsDetached() ) + { + delete this; + } + +#if defined(__VISUALC__) || \ + (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) || \ + (defined(__GNUG__) && defined(__MSVCRT__)) + _endthreadex((unsigned)status); +#else // !VC++ + ::ExitThread((DWORD)status); +#endif // VC++/!VC++ + + wxFAIL_MSG(wxT("Couldn't return from ExitThread()!")); } -bool wxThread::IsRunning() const +// priority setting +// ---------------- + +void wxThread::SetPriority(unsigned int prio) { - return (p_internal->state == STATE_RUNNING); + wxCriticalSectionLocker lock(m_critsect); + + m_internal->SetPriority(prio); } -bool wxThread::IsAlive() const +unsigned int wxThread::GetPriority() const { - return (p_internal->state == STATE_RUNNING); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast + + return m_internal->GetPriority(); } -bool wxThread::IsMain() +unsigned long wxThread::GetId() const { - return ::GetCurrentThreadId() == s_idMainThread; + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast + + return (unsigned long)m_internal->GetId(); } -wxThread::wxThread() +bool wxThread::IsRunning() const { - p_internal = new wxThreadInternal(); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - p_internal->defer = FALSE; - p_internal->prio = WXTHREAD_DEFAULT_PRIORITY; - p_internal->state = STATE_IDLE; + return m_internal->GetState() == STATE_RUNNING; } -wxThread::~wxThread() +bool wxThread::IsAlive() const { - Destroy(); - Join(); - delete p_internal; + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast + + return (m_internal->GetState() == STATE_RUNNING) || + (m_internal->GetState() == STATE_PAUSED); } -void wxThread::OnExit() +bool wxThread::IsPaused() const { + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast + + return m_internal->GetState() == STATE_PAUSED; +} + +bool wxThread::TestDestroy() +{ + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast + + return m_internal->GetState() == STATE_CANCELED; } // ---------------------------------------------------------------------------- @@ -495,30 +1067,61 @@ IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule) bool wxThreadModule::OnInit() { - s_critsectWaitingForGui = new wxCriticalSection(); + // allocate TLS index for storing the pointer to the current thread + gs_tlsThisThread = ::TlsAlloc(); + if ( gs_tlsThisThread == 0xFFFFFFFF ) + { + // 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")); - s_critsectGui = new wxCriticalSection(); - s_critsectGui->Enter(); + return FALSE; + } + + // main thread doesn't have associated wxThread object, so store 0 in the + // TLS instead + if ( !::TlsSetValue(gs_tlsThisThread, (LPVOID)0) ) + { + ::TlsFree(gs_tlsThisThread); + gs_tlsThisThread = 0xFFFFFFFF; - s_idMainThread = ::GetCurrentThreadId(); + wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage")); + + return FALSE; + } + + gs_critsectWaitingForGui = new wxCriticalSection(); + + gs_critsectGui = new wxCriticalSection(); + gs_critsectGui->Enter(); + + // no error return for GetCurrentThreadId() + gs_idMainThread = ::GetCurrentThreadId(); return TRUE; } void wxThreadModule::OnExit() { - if ( s_critsectGui ) + if ( !::TlsFree(gs_tlsThisThread) ) { - s_critsectGui->Leave(); - delete s_critsectGui; - s_critsectGui = NULL; + wxLogLastError(wxT("TlsFree failed.")); } - wxDELETE(s_critsectWaitingForGui); + if ( gs_critsectGui ) + { + gs_critsectGui->Leave(); + delete gs_critsectGui; + gs_critsectGui = NULL; + } + + delete gs_critsectWaitingForGui; + gs_critsectWaitingForGui = NULL; } // ---------------------------------------------------------------------------- -// under Windows, these functions are implemented usign a critical section and +// under Windows, these functions are implemented using a critical section and // not a mutex, so the names are a bit confusing // ---------------------------------------------------------------------------- @@ -526,62 +1129,62 @@ void WXDLLEXPORT wxMutexGuiEnter() { // this would dead lock everything... wxASSERT_MSG( !wxThread::IsMain(), - "main thread doesn't want to block in wxMutexGuiEnter()!" ); + wxT("main thread doesn't want to block in wxMutexGuiEnter()!") ); // the order in which we enter the critical sections here is crucial!! // set the flag telling to the main thread that we want to do some GUI { - wxCriticalSectionLocker enter(*s_critsectWaitingForGui); + wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); - s_nWaitingForGui++; + gs_nWaitingForGui++; } wxWakeUpMainThread(); // now we may block here because the main thread will soon let us in // (during the next iteration of OnIdle()) - s_critsectGui->Enter(); + gs_critsectGui->Enter(); } void WXDLLEXPORT wxMutexGuiLeave() { - wxCriticalSectionLocker enter(*s_critsectWaitingForGui); + wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); if ( wxThread::IsMain() ) { - s_bGuiOwnedByMainThread = FALSE; + gs_bGuiOwnedByMainThread = FALSE; } else { - // decrement the number of waiters now - wxASSERT_MSG( s_nWaitingForGui > 0, - "calling wxMutexGuiLeave() without entering it first?" ); + // decrement the number of threads waiting for GUI access now + wxASSERT_MSG( gs_nWaitingForGui > 0, + wxT("calling wxMutexGuiLeave() without entering it first?") ); - s_nWaitingForGui--; + gs_nWaitingForGui--; wxWakeUpMainThread(); } - s_critsectGui->Leave(); + gs_critsectGui->Leave(); } void WXDLLEXPORT wxMutexGuiLeaveOrEnter() { wxASSERT_MSG( wxThread::IsMain(), - "only main thread may call wxMutexGuiLeaveOrEnter()!" ); + wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") ); - wxCriticalSectionLocker enter(*s_critsectWaitingForGui); + wxCriticalSectionLocker enter(*gs_critsectWaitingForGui); - if ( s_nWaitingForGui == 0 ) + if ( gs_nWaitingForGui == 0 ) { // no threads are waiting for GUI - so we may acquire the lock without // any danger (but only if we don't already have it) if ( !wxGuiOwnedByMainThread() ) { - s_critsectGui->Enter(); + gs_critsectGui->Enter(); - s_bGuiOwnedByMainThread = TRUE; + gs_bGuiOwnedByMainThread = TRUE; } //else: already have it, nothing to do } @@ -598,18 +1201,23 @@ void WXDLLEXPORT wxMutexGuiLeaveOrEnter() bool WXDLLEXPORT wxGuiOwnedByMainThread() { - return s_bGuiOwnedByMainThread; + return gs_bGuiOwnedByMainThread; } // wake up the main thread if it's in ::GetMessage() void WXDLLEXPORT wxWakeUpMainThread() { // sending any message would do - hopefully WM_NULL is harmless enough - if ( !::PostThreadMessage(s_idMainThread, WM_NULL, 0, 0) ) + if ( !::PostThreadMessage(gs_idMainThread, WM_NULL, 0, 0) ) { // should never happen - wxLogLastError("PostThreadMessage(WM_NULL)"); + wxLogLastError(wxT("PostThreadMessage(WM_NULL)")); } } +bool WXDLLEXPORT wxIsWaitingForThread() +{ + return gs_waitingForThread; +} + #endif // wxUSE_THREADS