X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f7c44a6a163799b19c234b9b9362afa50bbf5bbf..e7300ec6d9ebbd1cfa2fcf12c0ce6e5aee85a152:/src/msw/thread.cpp diff --git a/src/msw/thread.cpp b/src/msw/thread.cpp index 3ee7c1149a..e2c76f9389 100644 --- a/src/msw/thread.cpp +++ b/src/msw/thread.cpp @@ -26,18 +26,67 @@ #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" +#ifdef Yield +# undef Yield +#endif + +// must have this symbol defined to get _beginthread/_endthread declarations +#ifndef _MT + #define _MT +#endif + +#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__) + + #undef wxUSE_BEGIN_THREAD + #define wxUSE_BEGIN_THREAD +#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 + +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + // the possible states of the thread ("=>" shows all possible transitions from // this state) enum wxThreadState @@ -50,32 +99,32 @@ enum wxThreadState }; // ---------------------------------------------------------------------------- -// static variables +// this module globals // ---------------------------------------------------------------------------- // TLS index of the slot where we store the pointer to the current thread -static DWORD s_tlsThisThread = 0xFFFFFFFF; +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 s_waitingForThread = FALSE; +static bool gs_waitingForThread = FALSE; // ============================================================================ // Windows implementation of thread classes @@ -84,36 +133,47 @@ static bool s_waitingForThread = FALSE; // ---------------------------------------------------------------------------- // 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: @@ -129,7 +189,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++; @@ -140,7 +200,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; @@ -153,7 +213,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")); @@ -163,123 +223,330 @@ wxMutexError wxMutex::Unlock() return wxMUTEX_NO_ERROR; } -// ---------------------------------------------------------------------------- -// wxCondition implementation -// ---------------------------------------------------------------------------- +// ========================================================================== +// wxSemaphore +// ========================================================================== -class wxConditionInternal +// -------------------------------------------------------------------------- +// wxSemaphoreInternal +// -------------------------------------------------------------------------- + +class wxSemaphoreInternal { public: - HANDLE event; - int waiters; + wxSemaphoreInternal( int initialcount = 0, int maxcount = 0 ); + ~wxSemaphoreInternal(); + + void Wait(); + bool TryWait(); + + bool Wait( unsigned long timeout_millis ); + + void Post(); + +private: + HANDLE m_semaphore; }; -wxCondition::wxCondition() +wxSemaphoreInternal::wxSemaphoreInternal( int initialcount, int maxcount ) { - p_internal = new wxConditionInternal; - p_internal->event = CreateEvent(NULL, FALSE, FALSE, NULL); - if ( !p_internal->event ) + if ( maxcount == 0 ) { - wxLogSysError(_("Can not create event object.")); + // make it practically infinite + maxcount = INT_MAX; } - p_internal->waiters = 0; + m_semaphore = ::CreateSemaphore( NULL, initialcount, maxcount, NULL ); + if ( !m_semaphore ) + { + wxLogLastError(_T("CreateSemaphore()")); + } } -wxCondition::~wxCondition() +wxSemaphoreInternal::~wxSemaphoreInternal() { - CloseHandle(p_internal->event); + CloseHandle( m_semaphore ); } -void wxCondition::Wait(wxMutex& mutex) +void wxSemaphoreInternal::Wait() { - mutex.Unlock(); - p_internal->waiters++; - WaitForSingleObject(p_internal->event, INFINITE); - p_internal->waiters--; - mutex.Lock(); + if ( ::WaitForSingleObject( m_semaphore, INFINITE ) != WAIT_OBJECT_0 ) + { + wxLogLastError(_T("WaitForSingleObject")); + } } -bool wxCondition::Wait(wxMutex& mutex, - unsigned long sec, - unsigned long nsec) +bool wxSemaphoreInternal::TryWait() { - DWORD ret; + return Wait(0); +} + +bool wxSemaphoreInternal::Wait( unsigned long timeout_millis ) +{ + DWORD result = ::WaitForSingleObject( m_semaphore, timeout_millis ); + + switch ( result ) + { + case WAIT_OBJECT_0: + return TRUE; - mutex.Unlock(); - p_internal->waiters++; - ret = WaitForSingleObject(p_internal->event, (sec*1000)+(nsec/1000000)); - p_internal->waiters--; - mutex.Lock(); + case WAIT_TIMEOUT: + break; - return (ret != WAIT_TIMEOUT); + default: + wxLogLastError(_T("WaitForSingleObject()")); + } + + return FALSE; } -void wxCondition::Signal() +void wxSemaphoreInternal::Post() { - SetEvent(p_internal->event); + if ( !::ReleaseSemaphore( m_semaphore, 1, NULL ) ) + { + wxLogLastError(_T("ReleaseSemaphore")); + } } -void wxCondition::Broadcast() +// -------------------------------------------------------------------------- +// wxSemaphore +// -------------------------------------------------------------------------- + +wxSemaphore::wxSemaphore( int initialcount, int maxcount ) +{ + m_internal = new wxSemaphoreInternal( initialcount, maxcount ); +} + +wxSemaphore::~wxSemaphore() +{ + delete m_internal; +} + +void wxSemaphore::Wait() +{ + m_internal->Wait(); +} + +bool wxSemaphore::TryWait() +{ + return m_internal->TryWait(); +} + +bool wxSemaphore::Wait( unsigned long timeout_millis ) { - int i; + return m_internal->Wait( timeout_millis ); +} + +void wxSemaphore::Post() +{ + m_internal->Post(); +} - for (i=0;iwaiters;i++) + +// ========================================================================== +// wxCondition +// ========================================================================== + +// -------------------------------------------------------------------------- +// wxConditionInternal +// -------------------------------------------------------------------------- + +class wxConditionInternal +{ +public: + wxConditionInternal(wxMutex& mutex); + + void Wait(); + + bool Wait( unsigned long timeout_millis ); + + void Signal(); + + void Broadcast(); + +private: + int m_numWaiters; + wxMutex m_mutexNumWaiters; + + wxMutex& m_mutex; + + wxSemaphore m_semaphore; + + DECLARE_NO_COPY_CLASS(wxConditionInternal) +}; + +wxConditionInternal::wxConditionInternal(wxMutex& mutex) + : m_mutex(mutex) +{ + + m_numWaiters = 0; +} + +void wxConditionInternal::Wait() +{ + // increment the number of waiters + m_mutexNumWaiters.Lock(); + m_numWaiters++; + m_mutexNumWaiters.Unlock(); + + 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 + m_semaphore.Wait(); + + m_mutex.Lock(); +} + +bool wxConditionInternal::Wait( unsigned long timeout_millis ) +{ + m_mutexNumWaiters.Lock(); + m_numWaiters++; + m_mutexNumWaiters.Unlock(); + + m_mutex.Unlock(); + + // a race condition can occur at this point in the code + // + // please see the comments in Wait(), for details + + bool success = TRUE; + + bool result = m_semaphore.Wait( timeout_millis ); + + if ( !result ) { - if ( SetEvent(p_internal->event) == 0 ) + // 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. + m_mutexNumWaiters.Lock(); + result = m_semaphore.Wait( 0 ); + + if ( !result ) { - wxLogSysError(_("Couldn't change the state of event object.")); + m_numWaiters--; + success = FALSE; } + + m_mutexNumWaiters.Unlock(); + } + + m_mutex.Lock(); + + return success; +} + +void wxConditionInternal::Signal() +{ + m_mutexNumWaiters.Lock(); + + if ( m_numWaiters > 0 ) + { + // increment the semaphore by 1 + m_semaphore.Post(); + + m_numWaiters--; + } + + m_mutexNumWaiters.Unlock(); +} + +void wxConditionInternal::Broadcast() +{ + m_mutexNumWaiters.Lock(); + + while ( m_numWaiters > 0 ) + { + m_semaphore.Post(); + m_numWaiters--; } + + m_mutexNumWaiters.Unlock(); } // ---------------------------------------------------------------------------- -// wxCriticalSection implementation +// wxCondition implementation // ---------------------------------------------------------------------------- -class wxCriticalSectionInternal +wxCondition::wxCondition(wxMutex& mutex) { -public: - // init the critical section object - wxCriticalSectionInternal() - { ::InitializeCriticalSection(&m_data); } + m_internal = new wxConditionInternal( mutex ); +} + +wxCondition::~wxCondition() +{ + delete m_internal; +} - // implicit cast to the associated data - operator CRITICAL_SECTION *() { return &m_data; } +void wxCondition::Wait() +{ + m_internal->Wait(); +} - // free the associated ressources - ~wxCriticalSectionInternal() - { ::DeleteCriticalSection(&m_data); } +bool wxCondition::Wait( unsigned long timeout_millis ) +{ + return m_internal->Wait(timeout_millis); +} -private: - CRITICAL_SECTION m_data; -}; +void wxCondition::Signal() +{ + m_internal->Signal(); +} + +void wxCondition::Broadcast() +{ + m_internal->Broadcast(); +} + +// ---------------------------------------------------------------------------- +// wxCriticalSection implementation +// ---------------------------------------------------------------------------- wxCriticalSection::wxCriticalSection() { - m_critsect = NULL; +#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() { - wxASSERT_MSG( !m_critsect, "Forgot to Leave() critical section" ); + ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer); } void wxCriticalSection::Enter() { - m_critsect = new wxCriticalSectionInternal; - - ::EnterCriticalSection(*m_critsect); + ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer); } void wxCriticalSection::Leave() { - wxCHECK_RET( m_critsect, "Leave() without matching Enter()" ); - - ::LeaveCriticalSection(*m_critsect); - - delete m_critsect; - m_critsect = NULL; + ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer); } // ---------------------------------------------------------------------------- @@ -299,8 +566,26 @@ public: 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); + bool Create(wxThread *thread, unsigned int stackSize); // suspend/resume/terminate bool Suspend(); @@ -312,7 +597,7 @@ public: wxThreadState GetState() const { return m_state; } // thread priority - void SetPriority(unsigned int priority) { m_priority = priority; } + void SetPriority(unsigned int priority); unsigned int GetPriority() const { return m_priority; } // thread handle and id @@ -320,7 +605,7 @@ public: DWORD GetId() const { return m_tid; } // thread function - static DWORD WinThreadStart(wxThread *thread); + static THREAD_RETVAL THREAD_CALLCONV WinThreadStart(void *thread); private: HANDLE m_hThread; // handle of the thread @@ -329,44 +614,55 @@ private: DWORD m_tid; // thread id }; -DWORD wxThreadInternal::WinThreadStart(wxThread *thread) +THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param) { - // store the thread object in the TLS - if ( !::TlsSetValue(s_tlsThisThread, thread) ) + THREAD_RETVAL rc; + bool wasCancelled; + + // 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 ) { - wxLogSysError(_("Can not start thread: error writing TLS.")); + rc = (THREAD_RETVAL)-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; + } - return (DWORD)-1; + rc = (THREAD_RETVAL)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(); } - DWORD ret = (DWORD)thread->Entry(); - thread->p_internal->SetState(STATE_EXITED); thread->OnExit(); - delete thread; + // 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 ret; + return rc; } -bool wxThreadInternal::Create(wxThread *thread) +void wxThreadInternal::SetPriority(unsigned int priority) { - 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 - ); - - if ( m_hThread == NULL ) - { - wxLogSysError(_("Can't create thread")); - - return FALSE; - } + m_priority = priority; // translate wxWindows priority to the Windows one int win_priority; @@ -382,14 +678,62 @@ bool wxThreadInternal::Create(wxThread *thread) win_priority = THREAD_PRIORITY_HIGHEST; else { - wxFAIL_MSG("invalid value of thread priority parameter"); + wxFAIL_MSG(wxT("invalid value of thread priority parameter")); win_priority = THREAD_PRIORITY_NORMAL; } - if ( ::SetThreadPriority(m_hThread, win_priority) == 0 ) + if ( !::SetThreadPriority(m_hThread, win_priority) ) { wxLogSysError(_("Can't set thread priority")); } +} + +bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize) +{ + // 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) +#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 + stackSize, // stack size + wxThreadInternal::WinThreadStart, // thread entry point + (LPVOID)thread, // parameter + CREATE_SUSPENDED, // flags + &m_tid // [out] thread id + ); +#endif // _beginthreadex/CreateThread + + if ( m_hThread == NULL ) + { + wxLogSysError(_("Can't create thread")); + + return FALSE; + } + + if ( m_priority != WXTHREAD_DEFAULT_PRIORITY ) + { + SetPriority(m_priority); + } return TRUE; } @@ -419,7 +763,13 @@ bool wxThreadInternal::Resume() 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 codei n Delete() wouldn't work + if ( m_state != STATE_EXITED ) + { + m_state = STATE_RUNNING; + } return TRUE; } @@ -429,7 +779,7 @@ bool wxThreadInternal::Resume() wxThread *wxThread::This() { - wxThread *thread = (wxThread *)::TlsGetValue(s_tlsThisThread); + wxThread *thread = (wxThread *)::TlsGetValue(gs_tlsThisThread); // be careful, 0 may be a valid return value as well if ( !thread && (::GetLastError() != NO_ERROR) ) @@ -444,12 +794,17 @@ wxThread *wxThread::This() bool wxThread::IsMain() { - return ::GetCurrentThreadId() == s_idMainThread; + return ::GetCurrentThreadId() == gs_idMainThread; } +#ifdef Yield +#undef Yield +#endif + void wxThread::Yield() { - // 0 argument to Sleep() is special + // 0 argument to Sleep() is special and means to just give away the rest of + // our timeslice ::Sleep(0); } @@ -458,12 +813,137 @@ void wxThread::Sleep(unsigned long milliseconds) ::Sleep(milliseconds); } +int wxThread::GetCPUCount() +{ + SYSTEM_INFO si; + GetSystemInfo(&si); + + return si.dwNumberOfProcessors; +} + +unsigned long wxThread::GetCurrentId() +{ + return (unsigned long)::GetCurrentThreadId(); +} + +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 ) + { + wxLogLastError(_T("SetProcessAffinityMask")); + + return FALSE; + } + + 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() +wxThreadError wxThread::Create(unsigned int stackSize) { - if ( !p_internal->Create(this) ) + wxCriticalSectionLocker lock(m_critsect); + + if ( !m_internal->Create(this, stackSize) ) return wxTHREAD_NO_RESOURCE; return wxTHREAD_NO_ERROR; @@ -473,12 +953,13 @@ wxThreadError wxThread::Run() { wxCriticalSectionLocker lock(m_critsect); - if ( p_internal->GetState() != STATE_NEW ) + 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(); } @@ -489,45 +970,99 @@ wxThreadError wxThread::Pause() { wxCriticalSectionLocker lock(m_critsect); - return p_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; + return m_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; } wxThreadError wxThread::Resume() { wxCriticalSectionLocker lock(m_critsect); - return p_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; + return m_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR; } // stopping thread // --------------- -wxThread::ExitCode wxThread::Delete() +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") ); + + ExitCode rc = (ExitCode)-1; + + (void)Delete(&rc); + + m_internal->Free(); + + return rc; +} + +wxThreadError wxThread::Delete(ExitCode *pRc) { ExitCode rc = 0; // Delete() is always safe to call, so consider all possible states - if ( IsPaused() ) + + // 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(); - if ( IsRunning() ) + HANDLE hThread = m_internal->GetHandle(); + + // does is still run? + if ( isRunning || IsRunning() ) { if ( IsMain() ) { // set flag for wxIsWaitingForThread() - s_waitingForThread = TRUE; + gs_waitingForThread = TRUE; +#if wxUSE_GUI wxBeginBusyCursor(); +#endif // wxUSE_GUI } - HANDLE hThread; + // ask the thread to terminate + if ( shouldCancel ) { wxCriticalSectionLocker lock(m_critsect); - p_internal->Cancel(); - hThread = p_internal->GetHandle(); + 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 @@ -549,7 +1084,7 @@ wxThread::ExitCode wxThread::Delete() // error wxLogSysError(_("Can not wait for thread termination")); Kill(); - return (ExitCode)-1; + return wxTHREAD_KILLED; case WAIT_OBJECT_0: // thread we're waiting for terminated @@ -562,14 +1097,14 @@ wxThread::ExitCode wxThread::Delete() // WM_QUIT received: kill the thread Kill(); - return (ExitCode)-1; + 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 ( (s_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) + if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() ) { wxMutexGuiLeave(); } @@ -578,31 +1113,56 @@ wxThread::ExitCode wxThread::Delete() break; default: - wxFAIL_MSG("unexpected result of MsgWaitForMultipleObject"); + 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() ) { - s_waitingForThread = FALSE; + gs_waitingForThread = FALSE; +#if wxUSE_GUI wxEndBusyCursor(); +#endif // wxUSE_GUI } + } + // 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 + { if ( !::GetExitCodeThread(hThread, (LPDWORD)&rc) ) { - wxLogLastError("GetExitCodeThread"); + wxLogLastError(wxT("GetExitCodeThread")); rc = (ExitCode)-1; } + } while ( (DWORD)rc == STILL_ACTIVE ); - wxASSERT_MSG( (LPVOID)rc != (LPVOID)STILL_ACTIVE, - "thread must be already terminated." ); - - ::CloseHandle(hThread); + 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; } - return rc; + if ( pRc ) + *pRc = rc; + + return rc == (ExitCode)-1 ? wxTHREAD_MISC_ERROR : wxTHREAD_NO_ERROR; } wxThreadError wxThread::Kill() @@ -610,78 +1170,92 @@ wxThreadError wxThread::Kill() if ( !IsRunning() ) return wxTHREAD_NOT_RUNNING; - if ( !::TerminateThread(p_internal->GetHandle(), (DWORD)-1) ) + if ( !::TerminateThread(m_internal->GetHandle(), (DWORD)-1) ) { wxLogSysError(_("Couldn't terminate thread")); return wxTHREAD_MISC_ERROR; } - delete this; + m_internal->Free(); + + if ( IsDetached() ) + { + delete this; + } return wxTHREAD_NO_ERROR; } -void wxThread::Exit(void *status) +void wxThread::Exit(ExitCode status) { - delete this; + m_internal->Free(); + + if ( IsDetached() ) + { + delete this; + } +#ifdef wxUSE_BEGIN_THREAD + _endthreadex((unsigned)status); +#else // !VC++ ::ExitThread((DWORD)status); +#endif // VC++/!VC++ - wxFAIL_MSG("Couldn't return from ExitThread()!"); + wxFAIL_MSG(wxT("Couldn't return from ExitThread()!")); } +// priority setting +// ---------------- + void wxThread::SetPriority(unsigned int prio) { wxCriticalSectionLocker lock(m_critsect); - p_internal->SetPriority(prio); + m_internal->SetPriority(prio); } unsigned int wxThread::GetPriority() const { - wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - return p_internal->GetPriority(); + return m_internal->GetPriority(); } -unsigned long wxThread::GetID() const +unsigned long wxThread::GetId() const { - wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - return (unsigned long)p_internal->GetId(); + return (unsigned long)m_internal->GetId(); } bool wxThread::IsRunning() const { - wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - return p_internal->GetState() == STATE_RUNNING; + return m_internal->GetState() == STATE_RUNNING; } bool wxThread::IsAlive() const { - wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - return (p_internal->GetState() == STATE_RUNNING) || - (p_internal->GetState() == STATE_PAUSED); + return (m_internal->GetState() == STATE_RUNNING) || + (m_internal->GetState() == STATE_PAUSED); } -bool wxThread::TestDestroy() +bool wxThread::IsPaused() const { - wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast - return p_internal->GetState() == STATE_CANCELED; + return m_internal->GetState() == STATE_PAUSED; } -wxThread::wxThread() +bool wxThread::TestDestroy() { - p_internal = new wxThreadInternal(); -} + wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast -wxThread::~wxThread() -{ - delete p_internal; + return m_internal->GetState() == STATE_CANCELED; } // ---------------------------------------------------------------------------- @@ -703,62 +1277,60 @@ IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule) bool wxThreadModule::OnInit() { // allocate TLS index for storing the pointer to the current thread - s_tlsThisThread = ::TlsAlloc(); - if ( s_tlsThisThread == 0xFFFFFFFF ) + 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")); + wxLogSysError(_("Thread module initialization failed: impossible to allocate index in thread local storage")); return FALSE; } // main thread doesn't have associated wxThread object, so store 0 in the // TLS instead - if ( !::TlsSetValue(s_tlsThisThread, (LPVOID)0) ) + if ( !::TlsSetValue(gs_tlsThisThread, (LPVOID)0) ) { - ::TlsFree(s_tlsThisThread); - s_tlsThisThread = 0xFFFFFFFF; + ::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; } - s_critsectWaitingForGui = new wxCriticalSection(); + gs_critsectWaitingForGui = new wxCriticalSection(); - s_critsectGui = new wxCriticalSection(); - s_critsectGui->Enter(); + gs_critsectGui = new wxCriticalSection(); + gs_critsectGui->Enter(); // no error return for GetCurrentThreadId() - s_idMainThread = ::GetCurrentThreadId(); + gs_idMainThread = ::GetCurrentThreadId(); return TRUE; } void wxThreadModule::OnExit() { - if ( !::TlsFree(s_tlsThisThread) ) + if ( !::TlsFree(gs_tlsThisThread) ) { - wxLogLastError("TlsFree failed."); + wxLogLastError(wxT("TlsFree failed.")); } - if ( s_critsectGui ) + if ( gs_critsectGui ) { - s_critsectGui->Leave(); - delete s_critsectGui; - s_critsectGui = NULL; + gs_critsectGui->Leave(); + delete gs_critsectGui; + gs_critsectGui = NULL; } - wxDELETE(s_critsectWaitingForGui); + 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 // ---------------------------------------------------------------------------- @@ -766,62 +1338,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 } @@ -838,23 +1410,25 @@ 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 s_waitingForThread; + return gs_waitingForThread; } #endif // wxUSE_THREADS + +// vi:sts=4:sw=4:et