1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/thread.cpp
3 // Purpose: wxThread Implementation
4 // Author: Original from Wolfram Gloger/Guilhem Lavaux
5 // Modified by: Vadim Zeitlin to make it work :-)
8 // Copyright: (c) Wolfram Gloger (1996, 1997), Guilhem Lavaux (1998);
9 // Vadim Zeitlin (1999-2002)
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
14 #pragma implementation "thread.h"
17 // ----------------------------------------------------------------------------
19 // ----------------------------------------------------------------------------
21 // For compilers that support precompilation, includes "wx.h".
22 #include "wx/wxprec.h"
24 #if defined(__BORLANDC__)
35 #include "wx/apptrait.h"
37 #include "wx/msw/private.h"
38 #include "wx/msw/missing.h"
40 #include "wx/module.h"
41 #include "wx/thread.h"
43 // must have this symbol defined to get _beginthread/_endthread declarations
48 #if defined(__BORLANDC__)
50 // I can't set -tWM in the IDE (anyone?) so have to do this
54 #if !defined(__MFC_COMPAT__)
55 // Needed to know about _beginthreadex etc..
56 #define __MFC_COMPAT__
60 // define wxUSE_BEGIN_THREAD if the compiler has _beginthreadex() function
61 // which should be used instead of Win32 ::CreateThread() if possible
62 #if defined(__VISUALC__) || \
63 (defined(__BORLANDC__) && (__BORLANDC__ >= 0x500)) || \
64 (defined(__GNUG__) && defined(__MSVCRT__)) || \
65 defined(__WATCOMC__) || defined(__MWERKS__)
68 #undef wxUSE_BEGIN_THREAD
69 #define wxUSE_BEGIN_THREAD
74 #ifdef wxUSE_BEGIN_THREAD
75 // this is where _beginthreadex() is declared
78 // the return type of the thread function entry point
79 typedef unsigned THREAD_RETVAL
;
81 // the calling convention of the thread function entry point
82 #define THREAD_CALLCONV __stdcall
84 // the settings for CreateThread()
85 typedef DWORD THREAD_RETVAL
;
86 #define THREAD_CALLCONV WINAPI
89 // ----------------------------------------------------------------------------
91 // ----------------------------------------------------------------------------
93 // the possible states of the thread ("=>" shows all possible transitions from
97 STATE_NEW
, // didn't start execution yet (=> RUNNING)
98 STATE_RUNNING
, // thread is running (=> PAUSED, CANCELED)
99 STATE_PAUSED
, // thread is temporarily suspended (=> RUNNING)
100 STATE_CANCELED
, // thread should terminate a.s.a.p. (=> EXITED)
101 STATE_EXITED
// thread is terminating
104 // ----------------------------------------------------------------------------
105 // this module globals
106 // ----------------------------------------------------------------------------
108 // TLS index of the slot where we store the pointer to the current thread
109 static DWORD gs_tlsThisThread
= 0xFFFFFFFF;
111 // id of the main thread - the one which can call GUI functions without first
112 // calling wxMutexGuiEnter()
113 static DWORD gs_idMainThread
= 0;
115 // if it's false, some secondary thread is holding the GUI lock
116 static bool gs_bGuiOwnedByMainThread
= true;
118 // critical section which controls access to all GUI functions: any secondary
119 // thread (i.e. except the main one) must enter this crit section before doing
121 static wxCriticalSection
*gs_critsectGui
= NULL
;
123 // critical section which protects gs_nWaitingForGui variable
124 static wxCriticalSection
*gs_critsectWaitingForGui
= NULL
;
126 // critical section which serializes WinThreadStart() and WaitForTerminate()
127 // (this is a potential bottleneck, we use a single crit sect for all threads
128 // in the system, but normally time spent inside it should be quite short)
129 static wxCriticalSection
*gs_critsectThreadDelete
= NULL
;
131 // number of threads waiting for GUI in wxMutexGuiEnter()
132 static size_t gs_nWaitingForGui
= 0;
134 // are we waiting for a thread termination?
135 static bool gs_waitingForThread
= false;
137 // ============================================================================
138 // Windows implementation of thread and related classes
139 // ============================================================================
141 // ----------------------------------------------------------------------------
143 // ----------------------------------------------------------------------------
145 wxCriticalSection::wxCriticalSection()
147 wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION
) <= sizeof(wxCritSectBuffer
),
148 wxCriticalSectionBufferTooSmall
);
150 ::InitializeCriticalSection((CRITICAL_SECTION
*)m_buffer
);
153 wxCriticalSection::~wxCriticalSection()
155 ::DeleteCriticalSection((CRITICAL_SECTION
*)m_buffer
);
158 void wxCriticalSection::Enter()
160 ::EnterCriticalSection((CRITICAL_SECTION
*)m_buffer
);
163 void wxCriticalSection::Leave()
165 ::LeaveCriticalSection((CRITICAL_SECTION
*)m_buffer
);
168 // ----------------------------------------------------------------------------
170 // ----------------------------------------------------------------------------
172 class wxMutexInternal
175 wxMutexInternal(wxMutexType mutexType
);
178 bool IsOk() const { return m_mutex
!= NULL
; }
180 wxMutexError
Lock() { return LockTimeout(INFINITE
); }
181 wxMutexError
TryLock() { return LockTimeout(0); }
182 wxMutexError
Unlock();
185 wxMutexError
LockTimeout(DWORD milliseconds
);
189 DECLARE_NO_COPY_CLASS(wxMutexInternal
)
192 // all mutexes are recursive under Win32 so we don't use mutexType
193 wxMutexInternal::wxMutexInternal(wxMutexType
WXUNUSED(mutexType
))
195 // create a nameless (hence intra process and always private) mutex
196 m_mutex
= ::CreateMutex
198 NULL
, // default secutiry attributes
199 false, // not initially locked
205 wxLogLastError(_T("CreateMutex()"));
209 wxMutexInternal::~wxMutexInternal()
213 if ( !::CloseHandle(m_mutex
) )
215 wxLogLastError(_T("CloseHandle(mutex)"));
220 wxMutexError
wxMutexInternal::LockTimeout(DWORD milliseconds
)
222 DWORD rc
= ::WaitForSingleObject(m_mutex
, milliseconds
);
223 if ( rc
== WAIT_ABANDONED
)
225 // the previous caller died without releasing the mutex, but now we can
227 wxLogDebug(_T("WaitForSingleObject() returned WAIT_ABANDONED"));
229 // use 0 timeout, normally we should always get it
230 rc
= ::WaitForSingleObject(m_mutex
, 0);
242 case WAIT_ABANDONED
: // checked for above
244 wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock"));
248 wxLogLastError(_T("WaitForSingleObject(mutex)"));
249 return wxMUTEX_MISC_ERROR
;
252 return wxMUTEX_NO_ERROR
;
255 wxMutexError
wxMutexInternal::Unlock()
257 if ( !::ReleaseMutex(m_mutex
) )
259 wxLogLastError(_T("ReleaseMutex()"));
261 return wxMUTEX_MISC_ERROR
;
264 return wxMUTEX_NO_ERROR
;
267 // --------------------------------------------------------------------------
269 // --------------------------------------------------------------------------
271 // a trivial wrapper around Win32 semaphore
272 class wxSemaphoreInternal
275 wxSemaphoreInternal(int initialcount
, int maxcount
);
276 ~wxSemaphoreInternal();
278 bool IsOk() const { return m_semaphore
!= NULL
; }
280 wxSemaError
Wait() { return WaitTimeout(INFINITE
); }
282 wxSemaError
TryWait()
284 wxSemaError rc
= WaitTimeout(0);
285 if ( rc
== wxSEMA_TIMEOUT
)
291 wxSemaError
WaitTimeout(unsigned long milliseconds
);
298 DECLARE_NO_COPY_CLASS(wxSemaphoreInternal
)
301 wxSemaphoreInternal::wxSemaphoreInternal(int initialcount
, int maxcount
)
303 #if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300)
306 // make it practically infinite
310 m_semaphore
= ::CreateSemaphore
312 NULL
, // default security attributes
320 wxLogLastError(_T("CreateSemaphore()"));
324 wxSemaphoreInternal::~wxSemaphoreInternal()
328 if ( !::CloseHandle(m_semaphore
) )
330 wxLogLastError(_T("CloseHandle(semaphore)"));
335 wxSemaError
wxSemaphoreInternal::WaitTimeout(unsigned long milliseconds
)
337 DWORD rc
= ::WaitForSingleObject( m_semaphore
, milliseconds
);
342 return wxSEMA_NO_ERROR
;
345 return wxSEMA_TIMEOUT
;
348 wxLogLastError(_T("WaitForSingleObject(semaphore)"));
351 return wxSEMA_MISC_ERROR
;
354 wxSemaError
wxSemaphoreInternal::Post()
356 #if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300)
357 if ( !::ReleaseSemaphore(m_semaphore
, 1, NULL
/* ptr to previous count */) )
360 wxLogLastError(_T("ReleaseSemaphore"));
362 return wxSEMA_MISC_ERROR
;
365 return wxSEMA_NO_ERROR
;
368 // ----------------------------------------------------------------------------
369 // wxThread implementation
370 // ----------------------------------------------------------------------------
372 // wxThreadInternal class
373 // ----------------------
375 class wxThreadInternal
378 wxThreadInternal(wxThread
*thread
)
383 m_priority
= WXTHREAD_DEFAULT_PRIORITY
;
396 if ( !::CloseHandle(m_hThread
) )
398 wxLogLastError(wxT("CloseHandle(thread)"));
405 // create a new (suspended) thread (for the given thread object)
406 bool Create(wxThread
*thread
, unsigned int stackSize
);
408 // wait for the thread to terminate, either by itself, or by asking it
409 // (politely, this is not Kill()!) to do it
410 wxThreadError
WaitForTerminate(wxCriticalSection
& cs
,
411 wxThread::ExitCode
*pRc
,
412 wxThread
*threadToDelete
= NULL
);
414 // kill the thread unconditionally
415 wxThreadError
Kill();
417 // suspend/resume/terminate
420 void Cancel() { m_state
= STATE_CANCELED
; }
423 void SetState(wxThreadState state
) { m_state
= state
; }
424 wxThreadState
GetState() const { return m_state
; }
427 void SetPriority(unsigned int priority
);
428 unsigned int GetPriority() const { return m_priority
; }
430 // thread handle and id
431 HANDLE
GetHandle() const { return m_hThread
; }
432 DWORD
GetId() const { return m_tid
; }
435 static THREAD_RETVAL THREAD_CALLCONV
WinThreadStart(void *thread
);
439 if ( m_thread
->IsDetached() )
440 ::InterlockedIncrement(&m_nRef
);
445 if ( m_thread
->IsDetached() && !::InterlockedDecrement(&m_nRef
) )
450 // the thread we're associated with
453 HANDLE m_hThread
; // handle of the thread
454 wxThreadState m_state
; // state, see wxThreadState enum
455 unsigned int m_priority
; // thread priority in "wx" units
456 DWORD m_tid
; // thread id
458 // number of threads which need this thread to remain alive, when the count
459 // reaches 0 we kill the owning wxThread -- and die ourselves with it
462 DECLARE_NO_COPY_CLASS(wxThreadInternal
)
465 // small class which keeps a thread alive during its lifetime
466 class wxThreadKeepAlive
469 wxThreadKeepAlive(wxThreadInternal
& thrImpl
) : m_thrImpl(thrImpl
)
470 { m_thrImpl
.KeepAlive(); }
472 { m_thrImpl
.LetDie(); }
475 wxThreadInternal
& m_thrImpl
;
479 THREAD_RETVAL THREAD_CALLCONV
wxThreadInternal::WinThreadStart(void *param
)
483 wxThread
* const thread
= (wxThread
*)param
;
485 // first of all, check whether we hadn't been cancelled already and don't
486 // start the user code at all then
487 const bool hasExited
= thread
->m_internal
->GetState() == STATE_EXITED
;
491 rc
= (THREAD_RETVAL
)-1;
493 else // do run thread
495 // store the thread object in the TLS
496 if ( !::TlsSetValue(gs_tlsThisThread
, thread
) )
498 wxLogSysError(_("Can not start thread: error writing TLS."));
503 rc
= (THREAD_RETVAL
)thread
->Entry();
508 // save IsDetached because thread object can be deleted by joinable
509 // threads after state is changed to STATE_EXITED.
510 bool isDetached
= thread
->IsDetached();
514 // enter m_critsect before changing the thread state
515 wxCriticalSectionLocker
lock(thread
->m_critsect
);
516 thread
->m_internal
->SetState(STATE_EXITED
);
519 // the thread may delete itself now if it wants, we don't need it any more
521 thread
->m_internal
->LetDie();
526 void wxThreadInternal::SetPriority(unsigned int priority
)
528 m_priority
= priority
;
530 // translate wxWidgets priority to the Windows one
532 if (m_priority
<= 20)
533 win_priority
= THREAD_PRIORITY_LOWEST
;
534 else if (m_priority
<= 40)
535 win_priority
= THREAD_PRIORITY_BELOW_NORMAL
;
536 else if (m_priority
<= 60)
537 win_priority
= THREAD_PRIORITY_NORMAL
;
538 else if (m_priority
<= 80)
539 win_priority
= THREAD_PRIORITY_ABOVE_NORMAL
;
540 else if (m_priority
<= 100)
541 win_priority
= THREAD_PRIORITY_HIGHEST
;
544 wxFAIL_MSG(wxT("invalid value of thread priority parameter"));
545 win_priority
= THREAD_PRIORITY_NORMAL
;
548 if ( !::SetThreadPriority(m_hThread
, win_priority
) )
550 wxLogSysError(_("Can't set thread priority"));
554 bool wxThreadInternal::Create(wxThread
*thread
, unsigned int stackSize
)
556 wxASSERT_MSG( m_state
== STATE_NEW
&& !m_hThread
,
557 _T("Create()ing thread twice?") );
559 // for compilers which have it, we should use C RTL function for thread
560 // creation instead of Win32 API one because otherwise we will have memory
561 // leaks if the thread uses C RTL (and most threads do)
562 #ifdef wxUSE_BEGIN_THREAD
564 // Watcom is reported to not like 0 stack size (which means "use default"
565 // for the other compilers and is also the default value for stackSize)
569 #endif // __WATCOMC__
571 m_hThread
= (HANDLE
)_beginthreadex
573 NULL
, // default security
575 wxThreadInternal::WinThreadStart
, // entry point
578 (unsigned int *)&m_tid
580 #else // compiler doesn't have _beginthreadex
581 m_hThread
= ::CreateThread
583 NULL
, // default security
584 stackSize
, // stack size
585 wxThreadInternal::WinThreadStart
, // thread entry point
586 (LPVOID
)thread
, // parameter
587 CREATE_SUSPENDED
, // flags
588 &m_tid
// [out] thread id
590 #endif // _beginthreadex/CreateThread
592 if ( m_hThread
== NULL
)
594 wxLogSysError(_("Can't create thread"));
599 if ( m_priority
!= WXTHREAD_DEFAULT_PRIORITY
)
601 SetPriority(m_priority
);
607 wxThreadError
wxThreadInternal::Kill()
609 if ( !::TerminateThread(m_hThread
, (DWORD
)-1) )
611 wxLogSysError(_("Couldn't terminate thread"));
613 return wxTHREAD_MISC_ERROR
;
618 return wxTHREAD_NO_ERROR
;
622 wxThreadInternal::WaitForTerminate(wxCriticalSection
& cs
,
623 wxThread::ExitCode
*pRc
,
624 wxThread
*threadToDelete
)
626 // prevent the thread C++ object from disappearing as long as we are using
628 wxThreadKeepAlive
keepAlive(*this);
631 // we may either wait passively for the thread to terminate (when called
632 // from Wait()) or ask it to terminate (when called from Delete())
633 bool shouldDelete
= threadToDelete
!= NULL
;
635 wxThread::ExitCode rc
= 0;
637 // we might need to resume the thread if it's currently stopped
638 bool shouldResume
= false;
640 // as Delete() (which calls us) is always safe to call we need to consider
641 // all possible states
643 wxCriticalSectionLocker
lock(cs
);
645 if ( m_state
== STATE_NEW
)
649 // WinThreadStart() will see it and terminate immediately, no
650 // need to cancel the thread -- but we still need to resume it
652 m_state
= STATE_EXITED
;
654 // we must call Resume() as the thread hasn't been initially
655 // resumed yet (and as Resume() it knows about STATE_EXITED
656 // special case, it won't touch it and WinThreadStart() will
657 // just exit immediately)
659 shouldDelete
= false;
661 //else: shouldResume is correctly set to false here, wait until
662 // someone else runs the thread and it finishes
664 else // running, paused, cancelled or even exited
666 shouldResume
= m_state
== STATE_PAUSED
;
670 // resume the thread if it is paused
674 // ask the thread to terminate
677 wxCriticalSectionLocker
lock(cs
);
683 // now wait for thread to finish
684 if ( wxThread::IsMain() )
686 // set flag for wxIsWaitingForThread()
687 gs_waitingForThread
= true;
690 // we can't just wait for the thread to terminate because it might be
691 // calling some GUI functions and so it will never terminate before we
692 // process the Windows messages that result from these functions
693 // (note that even in console applications we might have to process
694 // messages if we use wxExecute() or timers or ...)
695 DWORD result
wxDUMMY_INITIALIZE(0);
698 if ( wxThread::IsMain() )
700 // give the thread we're waiting for chance to do the GUI call
702 if ( (gs_nWaitingForGui
> 0) && wxGuiOwnedByMainThread() )
708 result
= ::MsgWaitForMultipleObjects
710 1, // number of objects to wait for
711 &m_hThread
, // the objects
712 false, // don't wait for all objects
713 INFINITE
, // no timeout
714 QS_ALLINPUT
| // return as soon as there are any events
722 wxLogSysError(_("Can not wait for thread termination"));
724 return wxTHREAD_KILLED
;
727 // thread we're waiting for terminated
730 case WAIT_OBJECT_0
+ 1:
731 // new message arrived, process it -- but only if we're the
732 // main thread as we don't support processing messages in
735 // NB: we still must include QS_ALLINPUT even when waiting
736 // in a secondary thread because if it had created some
737 // window somehow (possible not even using wxWidgets)
738 // the system might dead lock then
739 if ( wxThread::IsMain() )
741 // it looks that sometimes WAIT_OBJECT_0 + 1 is
742 // returned but there are no messages in the thread
743 // queue -- prevent DoMessageFromThreadWait() from
744 // blocking inside ::GetMessage() forever in this case
745 ::PostMessage(NULL
, WM_NULL
, 0, 0);
747 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits()
750 if ( traits
&& !traits
->DoMessageFromThreadWait() )
752 // WM_QUIT received: kill the thread
755 return wxTHREAD_KILLED
;
761 wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject"));
763 } while ( result
!= WAIT_OBJECT_0
);
765 if ( wxThread::IsMain() )
767 gs_waitingForThread
= false;
771 // although the thread might be already in the EXITED state it might not
772 // have terminated yet and so we are not sure that it has actually
773 // terminated if the "if" above hadn't been taken
776 if ( !::GetExitCodeThread(m_hThread
, (LPDWORD
)&rc
) )
778 wxLogLastError(wxT("GetExitCodeThread"));
780 rc
= (wxThread::ExitCode
)-1;
785 if ( (DWORD
)rc
!= STILL_ACTIVE
)
788 // give the other thread some time to terminate, otherwise we may be
796 // we don't need the thread handle any more in any case
800 return rc
== (wxThread::ExitCode
)-1 ? wxTHREAD_MISC_ERROR
804 bool wxThreadInternal::Suspend()
806 DWORD nSuspendCount
= ::SuspendThread(m_hThread
);
807 if ( nSuspendCount
== (DWORD
)-1 )
809 wxLogSysError(_("Can not suspend thread %x"), m_hThread
);
814 m_state
= STATE_PAUSED
;
819 bool wxThreadInternal::Resume()
821 DWORD nSuspendCount
= ::ResumeThread(m_hThread
);
822 if ( nSuspendCount
== (DWORD
)-1 )
824 wxLogSysError(_("Can not resume thread %x"), m_hThread
);
829 // don't change the state from STATE_EXITED because it's special and means
830 // we are going to terminate without running any user code - if we did it,
831 // the code in WaitForTerminate() wouldn't work
832 if ( m_state
!= STATE_EXITED
)
834 m_state
= STATE_RUNNING
;
843 wxThread
*wxThread::This()
845 wxThread
*thread
= (wxThread
*)::TlsGetValue(gs_tlsThisThread
);
847 // be careful, 0 may be a valid return value as well
848 if ( !thread
&& (::GetLastError() != NO_ERROR
) )
850 wxLogSysError(_("Couldn't get the current thread pointer"));
858 bool wxThread::IsMain()
860 return ::GetCurrentThreadId() == gs_idMainThread
|| gs_idMainThread
== 0;
863 void wxThread::Yield()
865 // 0 argument to Sleep() is special and means to just give away the rest of
870 void wxThread::Sleep(unsigned long milliseconds
)
872 ::Sleep(milliseconds
);
875 int wxThread::GetCPUCount()
880 return si
.dwNumberOfProcessors
;
883 unsigned long wxThread::GetCurrentId()
885 return (unsigned long)::GetCurrentThreadId();
888 bool wxThread::SetConcurrency(size_t level
)
894 wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") );
896 // ok only for the default one
900 // get system affinity mask first
901 HANDLE hProcess
= ::GetCurrentProcess();
902 DWORD_PTR dwProcMask
, dwSysMask
;
903 if ( ::GetProcessAffinityMask(hProcess
, &dwProcMask
, &dwSysMask
) == 0 )
905 wxLogLastError(_T("GetProcessAffinityMask"));
910 // how many CPUs have we got?
911 if ( dwSysMask
== 1 )
913 // don't bother with all this complicated stuff - on a single
914 // processor system it doesn't make much sense anyhow
918 // calculate the process mask: it's a bit vector with one bit per
919 // processor; we want to schedule the process to run on first level
924 if ( dwSysMask
& bit
)
926 // ok, we can set this bit
929 // another process added
941 // could we set all bits?
944 wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level
);
949 // set it: we can't link to SetProcessAffinityMask() because it doesn't
950 // exist in Win9x, use RT binding instead
952 typedef BOOL (*SETPROCESSAFFINITYMASK
)(HANDLE
, DWORD
);
954 // can use static var because we're always in the main thread here
955 static SETPROCESSAFFINITYMASK pfnSetProcessAffinityMask
= NULL
;
957 if ( !pfnSetProcessAffinityMask
)
959 HMODULE hModKernel
= ::LoadLibrary(_T("kernel32"));
962 pfnSetProcessAffinityMask
= (SETPROCESSAFFINITYMASK
)
963 ::GetProcAddress(hModKernel
, "SetProcessAffinityMask");
966 // we've discovered a MT version of Win9x!
967 wxASSERT_MSG( pfnSetProcessAffinityMask
,
968 _T("this system has several CPUs but no SetProcessAffinityMask function?") );
971 if ( !pfnSetProcessAffinityMask
)
973 // msg given above - do it only once
977 if ( pfnSetProcessAffinityMask(hProcess
, dwProcMask
) == 0 )
979 wxLogLastError(_T("SetProcessAffinityMask"));
985 #endif // __WXWINCE__/!__WXWINCE__
991 wxThread::wxThread(wxThreadKind kind
)
993 m_internal
= new wxThreadInternal(this);
995 m_isDetached
= kind
== wxTHREAD_DETACHED
;
998 wxThread::~wxThread()
1003 // create/start thread
1004 // -------------------
1006 wxThreadError
wxThread::Create(unsigned int stackSize
)
1008 wxCriticalSectionLocker
lock(m_critsect
);
1010 if ( !m_internal
->Create(this, stackSize
) )
1011 return wxTHREAD_NO_RESOURCE
;
1013 return wxTHREAD_NO_ERROR
;
1016 wxThreadError
wxThread::Run()
1018 wxCriticalSectionLocker
lock(m_critsect
);
1020 if ( m_internal
->GetState() != STATE_NEW
)
1022 // actually, it may be almost any state at all, not only STATE_RUNNING
1023 return wxTHREAD_RUNNING
;
1026 // the thread has just been created and is still suspended - let it run
1030 // suspend/resume thread
1031 // ---------------------
1033 wxThreadError
wxThread::Pause()
1035 wxCriticalSectionLocker
lock(m_critsect
);
1037 return m_internal
->Suspend() ? wxTHREAD_NO_ERROR
: wxTHREAD_MISC_ERROR
;
1040 wxThreadError
wxThread::Resume()
1042 wxCriticalSectionLocker
lock(m_critsect
);
1044 return m_internal
->Resume() ? wxTHREAD_NO_ERROR
: wxTHREAD_MISC_ERROR
;
1050 wxThread::ExitCode
wxThread::Wait()
1052 // although under Windows we can wait for any thread, it's an error to
1053 // wait for a detached one in wxWin API
1054 wxCHECK_MSG( !IsDetached(), (ExitCode
)-1,
1055 _T("wxThread::Wait(): can't wait for detached thread") );
1057 ExitCode rc
= (ExitCode
)-1;
1059 (void)m_internal
->WaitForTerminate(m_critsect
, &rc
);
1064 wxThreadError
wxThread::Delete(ExitCode
*pRc
)
1066 return m_internal
->WaitForTerminate(m_critsect
, pRc
, this);
1069 wxThreadError
wxThread::Kill()
1072 return wxTHREAD_NOT_RUNNING
;
1074 wxThreadError rc
= m_internal
->Kill();
1082 // update the status of the joinable thread
1083 wxCriticalSectionLocker
lock(m_critsect
);
1084 m_internal
->SetState(STATE_EXITED
);
1090 void wxThread::Exit(ExitCode status
)
1100 // update the status of the joinable thread
1101 wxCriticalSectionLocker
lock(m_critsect
);
1102 m_internal
->SetState(STATE_EXITED
);
1105 #ifdef wxUSE_BEGIN_THREAD
1106 _endthreadex((unsigned)status
);
1108 ::ExitThread((DWORD
)status
);
1109 #endif // VC++/!VC++
1111 wxFAIL_MSG(wxT("Couldn't return from ExitThread()!"));
1117 void wxThread::SetPriority(unsigned int prio
)
1119 wxCriticalSectionLocker
lock(m_critsect
);
1121 m_internal
->SetPriority(prio
);
1124 unsigned int wxThread::GetPriority() const
1126 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1128 return m_internal
->GetPriority();
1131 unsigned long wxThread::GetId() const
1133 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1135 return (unsigned long)m_internal
->GetId();
1138 bool wxThread::IsRunning() const
1140 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1142 return m_internal
->GetState() == STATE_RUNNING
;
1145 bool wxThread::IsAlive() const
1147 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1149 return (m_internal
->GetState() == STATE_RUNNING
) ||
1150 (m_internal
->GetState() == STATE_PAUSED
);
1153 bool wxThread::IsPaused() const
1155 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1157 return m_internal
->GetState() == STATE_PAUSED
;
1160 bool wxThread::TestDestroy()
1162 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
); // const_cast
1164 return m_internal
->GetState() == STATE_CANCELED
;
1167 // ----------------------------------------------------------------------------
1168 // Automatic initialization for thread module
1169 // ----------------------------------------------------------------------------
1171 class wxThreadModule
: public wxModule
1174 virtual bool OnInit();
1175 virtual void OnExit();
1178 DECLARE_DYNAMIC_CLASS(wxThreadModule
)
1181 IMPLEMENT_DYNAMIC_CLASS(wxThreadModule
, wxModule
)
1183 bool wxThreadModule::OnInit()
1185 // allocate TLS index for storing the pointer to the current thread
1186 gs_tlsThisThread
= ::TlsAlloc();
1187 if ( gs_tlsThisThread
== 0xFFFFFFFF )
1189 // in normal circumstances it will only happen if all other
1190 // TLS_MINIMUM_AVAILABLE (>= 64) indices are already taken - in other
1191 // words, this should never happen
1192 wxLogSysError(_("Thread module initialization failed: impossible to allocate index in thread local storage"));
1197 // main thread doesn't have associated wxThread object, so store 0 in the
1199 if ( !::TlsSetValue(gs_tlsThisThread
, (LPVOID
)0) )
1201 ::TlsFree(gs_tlsThisThread
);
1202 gs_tlsThisThread
= 0xFFFFFFFF;
1204 wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage"));
1209 gs_critsectWaitingForGui
= new wxCriticalSection();
1211 gs_critsectGui
= new wxCriticalSection();
1212 gs_critsectGui
->Enter();
1214 gs_critsectThreadDelete
= new wxCriticalSection
;
1216 // no error return for GetCurrentThreadId()
1217 gs_idMainThread
= ::GetCurrentThreadId();
1222 void wxThreadModule::OnExit()
1224 if ( !::TlsFree(gs_tlsThisThread
) )
1226 wxLogLastError(wxT("TlsFree failed."));
1229 delete gs_critsectThreadDelete
;
1230 gs_critsectThreadDelete
= NULL
;
1232 if ( gs_critsectGui
)
1234 gs_critsectGui
->Leave();
1235 delete gs_critsectGui
;
1236 gs_critsectGui
= NULL
;
1239 delete gs_critsectWaitingForGui
;
1240 gs_critsectWaitingForGui
= NULL
;
1243 // ----------------------------------------------------------------------------
1244 // under Windows, these functions are implemented using a critical section and
1245 // not a mutex, so the names are a bit confusing
1246 // ----------------------------------------------------------------------------
1248 void WXDLLIMPEXP_BASE
wxMutexGuiEnter()
1250 // this would dead lock everything...
1251 wxASSERT_MSG( !wxThread::IsMain(),
1252 wxT("main thread doesn't want to block in wxMutexGuiEnter()!") );
1254 // the order in which we enter the critical sections here is crucial!!
1256 // set the flag telling to the main thread that we want to do some GUI
1258 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1260 gs_nWaitingForGui
++;
1263 wxWakeUpMainThread();
1265 // now we may block here because the main thread will soon let us in
1266 // (during the next iteration of OnIdle())
1267 gs_critsectGui
->Enter();
1270 void WXDLLIMPEXP_BASE
wxMutexGuiLeave()
1272 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1274 if ( wxThread::IsMain() )
1276 gs_bGuiOwnedByMainThread
= false;
1280 // decrement the number of threads waiting for GUI access now
1281 wxASSERT_MSG( gs_nWaitingForGui
> 0,
1282 wxT("calling wxMutexGuiLeave() without entering it first?") );
1284 gs_nWaitingForGui
--;
1286 wxWakeUpMainThread();
1289 gs_critsectGui
->Leave();
1292 void WXDLLIMPEXP_BASE
wxMutexGuiLeaveOrEnter()
1294 wxASSERT_MSG( wxThread::IsMain(),
1295 wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") );
1297 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1299 if ( gs_nWaitingForGui
== 0 )
1301 // no threads are waiting for GUI - so we may acquire the lock without
1302 // any danger (but only if we don't already have it)
1303 if ( !wxGuiOwnedByMainThread() )
1305 gs_critsectGui
->Enter();
1307 gs_bGuiOwnedByMainThread
= true;
1309 //else: already have it, nothing to do
1313 // some threads are waiting, release the GUI lock if we have it
1314 if ( wxGuiOwnedByMainThread() )
1318 //else: some other worker thread is doing GUI
1322 bool WXDLLIMPEXP_BASE
wxGuiOwnedByMainThread()
1324 return gs_bGuiOwnedByMainThread
;
1327 // wake up the main thread if it's in ::GetMessage()
1328 void WXDLLIMPEXP_BASE
wxWakeUpMainThread()
1330 // sending any message would do - hopefully WM_NULL is harmless enough
1331 if ( !::PostThreadMessage(gs_idMainThread
, WM_NULL
, 0, 0) )
1333 // should never happen
1334 wxLogLastError(wxT("PostThreadMessage(WM_NULL)"));
1338 bool WXDLLIMPEXP_BASE
wxIsWaitingForThread()
1340 return gs_waitingForThread
;
1343 // ----------------------------------------------------------------------------
1344 // include common implementation code
1345 // ----------------------------------------------------------------------------
1347 #include "wx/thrimpl.cpp"
1349 #endif // wxUSE_THREADS