1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/osx/carbon/thread.cpp
3 // Purpose: wxThread Implementation
4 // Author: Original from Wolfram Gloger/Guilhem Lavaux/Vadim Zeitlin
5 // Modified by: Aj Lavin, Stefan Csomor
8 // Copyright: (c) Wolfram Gloger (1996, 1997); Guilhem Lavaux (1998),
9 // Vadim Zeitlin (1999), Stefan Csomor (2000)
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 #include "wx/wxprec.h"
15 #if defined(__BORLANDC__)
21 #include "wx/module.h"
26 #include "wx/thread.h"
28 #if wxOSX_USE_COCOA_OR_CARBON
29 #include <CoreServices/CoreServices.h>
31 #include <Foundation/Foundation.h>
34 #include "wx/osx/uma.h"
36 // the possible states of the thread:
37 // ("=>" shows all possible transitions from this state)
40 STATE_NEW
, // didn't start execution yet (=> RUNNING)
41 STATE_RUNNING
, // thread is running (=> PAUSED, CANCELED)
42 STATE_PAUSED
, // thread is temporarily suspended (=> RUNNING)
43 STATE_CANCELED
, // thread should terminate a.s.a.p. (=> EXITED)
44 STATE_EXITED
// thread is terminating
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 // the task ID of the main thread
52 wxThreadIdType
wxThread::ms_idMainThread
= kInvalidID
;
54 // this is the Per-Task Storage for the pointer to the appropriate wxThread
55 TaskStorageIndex gs_tlsForWXThread
= 0;
57 // if it's false, some secondary thread is holding the GUI lock
58 static bool gs_bGuiOwnedByMainThread
= true;
60 // critical section which controls access to all GUI functions: any secondary
61 // thread (i.e. except the main one) must enter this crit section before doing
63 static wxCriticalSection
*gs_critsectGui
= NULL
;
65 // critical section which protects gs_nWaitingForGui variable
66 static wxCriticalSection
*gs_critsectWaitingForGui
= NULL
;
68 // number of threads waiting for GUI in wxMutexGuiEnter()
69 static size_t gs_nWaitingForGui
= 0;
71 // overall number of threads, needed for determining
72 // the sleep value of the main event loop
73 size_t g_numberOfThreads
= 0;
77 MPCriticalRegionID gs_guiCritical
= kInvalidID
;
80 // ============================================================================
81 // MacOS implementation of thread classes
82 // ============================================================================
87 The implementation is very close to the phtreads implementation, the reason for
88 using MPServices is the fact that these are also available under OS 9. Thus allowing
89 for one common API for all current builds.
91 As soon as wxThreads are on a 64 bit address space, the TLS must be extended
92 to use two indices one for each 32 bit part as the MP implementation is limited
95 I have three implementations for mutexes :
96 version A based on a binary semaphore, problem - not reentrant, version B based
97 on a critical region, allows for reentrancy, performance implications not
98 yet tested, and third a plain pthreads implementation
100 The same for condition internal, one implementation by Aj Lavin and the other one
101 copied from the thrimpl.cpp which I assume has been more broadly tested, I've just
102 replaced the interlock increment with the appropriate PPC calls
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
109 wxCriticalSection::wxCriticalSection( wxCriticalSectionType
WXUNUSED(critSecType
) )
111 MPCreateCriticalRegion( (MPCriticalRegionID
*) &m_critRegion
);
114 wxCriticalSection::~wxCriticalSection()
116 MPDeleteCriticalRegion( (MPCriticalRegionID
) m_critRegion
);
119 void wxCriticalSection::Enter()
121 MPEnterCriticalRegion( (MPCriticalRegionID
) m_critRegion
, kDurationForever
);
124 void wxCriticalSection::Leave()
126 MPExitCriticalRegion( (MPCriticalRegionID
) m_critRegion
);
129 // ----------------------------------------------------------------------------
130 // wxMutex implementation
131 // ----------------------------------------------------------------------------
133 #define wxUSE_MAC_SEMAPHORE_MUTEX 0
134 #define wxUSE_MAC_CRITICAL_REGION_MUTEX 1
135 #define wxUSE_MAC_PTHREADS_MUTEX 0
137 #if wxUSE_MAC_CRITICAL_REGION_MUTEX
139 class wxMutexInternal
142 wxMutexInternal( wxMutexType mutexType
);
143 virtual ~wxMutexInternal();
145 bool IsOk() const { return m_isOk
; }
147 wxMutexError
Lock() { return Lock(kDurationForever
); }
148 wxMutexError
Lock(unsigned long ms
);
149 wxMutexError
TryLock();
150 wxMutexError
Unlock();
153 MPCriticalRegionID m_critRegion
;
157 wxMutexInternal::wxMutexInternal( wxMutexType
WXUNUSED(mutexType
) )
160 m_critRegion
= kInvalidID
;
162 verify_noerr( MPCreateCriticalRegion( &m_critRegion
) );
163 m_isOk
= ( m_critRegion
!= kInvalidID
);
166 wxFAIL_MSG( wxT("Error when creating mutex") );
170 wxMutexInternal::~wxMutexInternal()
172 if ( m_critRegion
!= kInvalidID
)
173 MPDeleteCriticalRegion( m_critRegion
);
178 wxMutexError
wxMutexInternal::Lock(unsigned long ms
)
180 wxCHECK_MSG( m_isOk
, wxMUTEX_MISC_ERROR
, wxT("Invalid Mutex") );
182 OSStatus err
= MPEnterCriticalRegion( m_critRegion
, ms
);
189 wxASSERT_MSG( ms
!= kDurationForever
, wxT("unexpected timeout") );
190 return wxMUTEX_TIMEOUT
;
193 wxLogSysError(wxT("Could not lock mutex"));
194 return wxMUTEX_MISC_ERROR
;
197 return wxMUTEX_NO_ERROR
;
200 wxMutexError
wxMutexInternal::TryLock()
202 wxCHECK_MSG( m_isOk
, wxMUTEX_MISC_ERROR
, wxT("Invalid Mutex") ) ;
204 OSStatus err
= MPEnterCriticalRegion( m_critRegion
, kDurationImmediate
);
207 if ( err
== kMPTimeoutErr
)
210 wxLogSysError( wxT("Could not try lock mutex") );
211 return wxMUTEX_MISC_ERROR
;
214 return wxMUTEX_NO_ERROR
;
217 wxMutexError
wxMutexInternal::Unlock()
219 wxCHECK_MSG( m_isOk
, wxMUTEX_MISC_ERROR
, wxT("Invalid Mutex") ) ;
221 OSStatus err
= MPExitCriticalRegion( m_critRegion
);
226 wxLogSysError( wxT("Could not unlock mutex") );
228 return wxMUTEX_MISC_ERROR
;
231 return wxMUTEX_NO_ERROR
;
236 // --------------------------------------------------------------------------
238 // --------------------------------------------------------------------------
240 class wxSemaphoreInternal
243 wxSemaphoreInternal( int initialcount
, int maxcount
);
244 virtual ~wxSemaphoreInternal();
250 wxSemaError
WaitTimeout( unsigned long milliseconds
);
253 { return WaitTimeout( kDurationForever
); }
255 wxSemaError
TryWait()
257 wxSemaError err
= WaitTimeout( kDurationImmediate
);
258 if (err
== wxSEMA_TIMEOUT
)
265 MPSemaphoreID m_semaphore
;
269 wxSemaphoreInternal::wxSemaphoreInternal( int initialcount
, int maxcount
)
272 m_semaphore
= kInvalidID
;
274 // make it practically infinite
277 verify_noerr( MPCreateSemaphore( maxcount
, initialcount
, &m_semaphore
) );
278 m_isOk
= ( m_semaphore
!= kInvalidID
);
282 wxFAIL_MSG( wxT("Error when creating semaphore") );
286 wxSemaphoreInternal::~wxSemaphoreInternal()
288 if (m_semaphore
!= kInvalidID
)
289 MPDeleteSemaphore( m_semaphore
);
294 wxSemaError
wxSemaphoreInternal::WaitTimeout( unsigned long milliseconds
)
296 OSStatus err
= MPWaitOnSemaphore( m_semaphore
, milliseconds
);
299 if (err
== kMPTimeoutErr
)
300 return wxSEMA_TIMEOUT
;
302 return wxSEMA_MISC_ERROR
;
305 return wxSEMA_NO_ERROR
;
308 wxSemaError
wxSemaphoreInternal::Post()
310 OSStatus err
= MPSignalSemaphore( m_semaphore
);
313 return wxSEMA_MISC_ERROR
;
315 return wxSEMA_NO_ERROR
;
318 // ----------------------------------------------------------------------------
319 // wxCondition implementation
320 // ----------------------------------------------------------------------------
322 class wxConditionInternal
325 wxConditionInternal( wxMutex
& mutex
);
328 { return m_mutex
.IsOk() && m_semaphore
.IsOk(); }
331 wxCondError
WaitTimeout( unsigned long milliseconds
);
333 wxCondError
Signal();
334 wxCondError
Broadcast();
337 // the number of threads currently waiting for this condition
340 // the critical section protecting m_numWaiters
341 wxCriticalSection m_csWaiters
;
344 wxSemaphore m_semaphore
;
346 wxDECLARE_NO_COPY_CLASS(wxConditionInternal
);
349 wxConditionInternal::wxConditionInternal( wxMutex
& mutex
)
352 // another thread can't access it until we return from ctor, so no need to
353 // protect access to m_numWaiters here
357 wxCondError
wxConditionInternal::Wait()
359 // increment the number of waiters
360 IncrementAtomic( &m_numWaiters
);
364 // a potential race condition can occur here
366 // after a thread increments nwaiters, and unlocks the mutex and before the
367 // semaphore.Wait() is called, if another thread can cause a signal to be
370 // this race condition is handled by using a semaphore and incrementing the
371 // semaphore only if 'nwaiters' is greater that zero since the semaphore,
372 // can 'remember' signals the race condition will not occur
374 // wait ( if necessary ) and decrement semaphore
375 wxSemaError err
= m_semaphore
.Wait();
378 return err
== wxSEMA_NO_ERROR
? wxCOND_NO_ERROR
: wxCOND_MISC_ERROR
;
381 wxCondError
wxConditionInternal::WaitTimeout( unsigned long milliseconds
)
383 IncrementAtomic( &m_numWaiters
);
387 // a race condition can occur at this point in the code
389 // please see the comments in Wait(), for details
391 wxSemaError err
= m_semaphore
.WaitTimeout(milliseconds
);
393 if ( err
== wxSEMA_TIMEOUT
)
395 // another potential race condition exists here it is caused when a
396 // 'waiting' thread timesout, and returns from WaitForSingleObject, but
397 // has not yet decremented 'nwaiters'.
399 // at this point if another thread calls signal() then the semaphore
400 // will be incremented, but the waiting thread will miss it.
402 // to handle this particular case, the waiting thread calls
403 // WaitForSingleObject again with a timeout of 0, after locking
404 // 'nwaiters_mutex'. this call does not block because of the zero
405 // timeout, but will allow the waiting thread to catch the missed
407 wxCriticalSectionLocker
lock(m_csWaiters
);
409 err
= m_semaphore
.WaitTimeout(0);
411 if ( err
!= wxSEMA_NO_ERROR
)
419 return err
== wxSEMA_NO_ERROR
? wxCOND_NO_ERROR
: wxCOND_MISC_ERROR
;
422 wxCondError
wxConditionInternal::Signal()
424 wxCriticalSectionLocker
lock(m_csWaiters
);
426 if ( m_numWaiters
> 0 )
428 // increment the semaphore by 1
429 if ( m_semaphore
.Post() != wxSEMA_NO_ERROR
)
430 return wxCOND_MISC_ERROR
;
435 return wxCOND_NO_ERROR
;
438 wxCondError
wxConditionInternal::Broadcast()
440 wxCriticalSectionLocker
lock(m_csWaiters
);
442 while ( m_numWaiters
> 0 )
444 if ( m_semaphore
.Post() != wxSEMA_NO_ERROR
)
445 return wxCOND_MISC_ERROR
;
450 return wxCOND_NO_ERROR
;
453 // ----------------------------------------------------------------------------
454 // wxCriticalSection implementation
455 // ----------------------------------------------------------------------------
457 // XXX currently implemented as mutex in headers. Change to critical section.
459 // ----------------------------------------------------------------------------
460 // wxThread implementation
461 // ----------------------------------------------------------------------------
463 // wxThreadInternal class
464 // ----------------------
466 class wxThreadInternal
473 m_prio
= WXTHREAD_DEFAULT_PRIORITY
;
474 m_notifyQueueId
= kInvalidID
;
476 m_cancelled
= false ;
478 // set to true only when the thread starts waiting on m_semSuspend
481 // defaults for joinable threads
482 m_shouldBeJoined
= true;
483 m_isDetached
= false;
486 virtual ~wxThreadInternal()
488 if ( m_notifyQueueId
)
490 MPDeleteQueue( m_notifyQueueId
);
491 m_notifyQueueId
= kInvalidID
;
496 static OSStatus
MacThreadStart(void* arg
);
498 // create a new (suspended) thread (for the given thread object)
499 bool Create(wxThread
*thread
, unsigned int stackSize
);
506 // unblock the thread allowing it to run
507 void SignalRun() { m_semRun
.Post(); }
509 // ask the thread to terminate
512 // go to sleep until Resume() is called
520 int GetPriority() const
522 void SetPriority(int prio
);
525 wxThreadState
GetState() const
527 void SetState(wxThreadState state
)
530 // Get the ID of this thread's underlying MP Services task.
531 MPTaskID
GetId() const
535 { m_cancelled
= true; }
537 bool WasCancelled() const
538 { return m_cancelled
; }
541 void SetExitCode(wxThread::ExitCode exitcode
)
542 { m_exitcode
= exitcode
; }
543 wxThread::ExitCode
GetExitCode() const
544 { return m_exitcode
; }
547 void SetReallyPaused(bool paused
)
548 { m_isPaused
= paused
; }
549 bool IsReallyPaused() const
550 { return m_isPaused
; }
552 // tell the thread that it is a detached one
555 wxCriticalSectionLocker
lock(m_csJoinFlag
);
557 m_shouldBeJoined
= false;
562 // the thread we're associated with
565 MPTaskID m_tid
; // thread id
566 MPQueueID m_notifyQueueId
; // its notification queue
568 wxThreadState m_state
; // see wxThreadState enum
569 int m_prio
; // in wxWidgets units: from 0 to 100
571 // this flag is set when the thread should terminate
574 // this flag is set when the thread is blocking on m_semSuspend
577 // the thread exit code - only used for joinable (!detached) threads and
578 // is only valid after the thread termination
579 wxThread::ExitCode m_exitcode
;
581 // many threads may call Wait(), but only one of them should call
582 // pthread_join(), so we have to keep track of this
583 wxCriticalSection m_csJoinFlag
;
584 bool m_shouldBeJoined
;
587 // this semaphore is posted by Run() and the threads Entry() is not
588 // called before it is done
589 wxSemaphore m_semRun
;
591 // this one is signaled when the thread should resume after having been
593 wxSemaphore m_semSuspend
;
596 OSStatus
wxThreadInternal::MacThreadStart(void *parameter
)
598 wxThread
* thread
= (wxThread
*) parameter
;
599 wxThreadInternal
*pthread
= thread
->m_internal
;
601 // add to TLS so that This() will work
602 verify_noerr( MPSetTaskStorageValue( gs_tlsForWXThread
, (TaskStorageValue
) thread
) ) ;
604 // have to declare this before pthread_cleanup_push() which defines a
608 // wait for the semaphore to be posted from Run()
609 pthread
->m_semRun
.Wait();
611 // test whether we should run the run at all - may be it was deleted
612 // before it started to Run()?
614 wxCriticalSectionLocker
lock(thread
->m_critsect
);
616 dontRunAtAll
= pthread
->GetState() == STATE_NEW
&&
617 pthread
->WasCancelled();
622 pthread
->m_exitcode
= thread
->Entry();
625 wxCriticalSectionLocker
lock(thread
->m_critsect
);
626 pthread
->SetState( STATE_EXITED
);
632 if ( pthread
->m_isDetached
)
639 // on Mac for the running code,
640 // the correct thread termination is to return
642 // terminate the thread
643 thread
->Exit( pthread
->m_exitcode
);
645 return (OSStatus
) NULL
; // pthread->m_exitcode;
649 bool wxThreadInternal::Create( wxThread
*thread
, unsigned int stackSize
)
651 wxASSERT_MSG( m_state
== STATE_NEW
&& !m_tid
,
652 wxT("Create()ing thread twice?") );
654 OSStatus err
= noErr
;
657 if ( m_notifyQueueId
== kInvalidID
)
659 OSStatus err
= MPCreateQueue( &m_notifyQueueId
);
662 wxLogSysError( wxT("Cant create the thread event queue") );
671 MacThreadStart
, (void*)m_thread
, stackSize
,
672 m_notifyQueueId
, &m_exitcode
, 0, 0, &m_tid
);
676 wxLogSysError( wxT("Can't create thread") );
681 if ( m_prio
!= WXTHREAD_DEFAULT_PRIORITY
)
682 SetPriority( m_prio
);
687 void wxThreadInternal::SetPriority( int priority
)
693 // Mac priorities range from 1 to 10,000, with a default of 100.
694 // wxWidgets priorities range from 0 to 100 with a default of 50.
695 // We can map wxWidgets to Mac priorities easily by assuming
696 // the former uses a logarithmic scale.
697 const unsigned int macPriority
= (int)( exp( priority
/ 25.0 * log( 10.0)) + 0.5);
699 MPSetTaskWeight( m_tid
, macPriority
);
703 wxThreadError
wxThreadInternal::Run()
705 wxCHECK_MSG( GetState() == STATE_NEW
, wxTHREAD_RUNNING
,
706 wxT("thread may only be started once after Create()") );
708 SetState( STATE_RUNNING
);
710 // wake up threads waiting for our start
713 return wxTHREAD_NO_ERROR
;
716 void wxThreadInternal::Wait()
718 wxCHECK_RET( !m_isDetached
, wxT("can't wait for a detached thread") );
720 // if the thread we're waiting for is waiting for the GUI mutex, we will
721 // deadlock so make sure we release it temporarily
722 if ( wxThread::IsMain() )
724 // give the thread we're waiting for chance to do the GUI call
725 // it might be in, we don't do this conditionally as the to be waited on
726 // thread might have to acquire the mutex later but before terminating
727 if ( wxGuiOwnedByMainThread() )
732 wxCriticalSectionLocker
lock(m_csJoinFlag
);
734 if ( m_shouldBeJoined
)
736 void *param1
, *param2
, *rc
;
738 OSStatus err
= MPWaitOnQueue(
746 wxLogSysError( wxT( "Cannot wait for thread termination."));
750 // actually param1 would be the address of m_exitcode
751 // but we don't need this here
754 m_shouldBeJoined
= false;
759 void wxThreadInternal::Pause()
761 // the state is set from the thread which pauses us first, this function
762 // is called later so the state should have been already set
763 wxCHECK_RET( m_state
== STATE_PAUSED
,
764 wxT("thread must first be paused with wxThread::Pause().") );
766 // wait until the semaphore is Post()ed from Resume()
770 void wxThreadInternal::Resume()
772 wxCHECK_RET( m_state
== STATE_PAUSED
,
773 wxT("can't resume thread which is not suspended.") );
775 // the thread might be not actually paused yet - if there were no call to
776 // TestDestroy() since the last call to Pause() for example
777 if ( IsReallyPaused() )
783 SetReallyPaused( false );
786 SetState( STATE_RUNNING
);
792 wxThread
*wxThread::This()
794 wxThread
* thr
= (wxThread
*) MPGetTaskStorageValue( gs_tlsForWXThread
) ;
803 void wxThread::Yield()
805 CFRunLoopRunInMode( kCFRunLoopDefaultMode
, 0 , true ) ;
810 void wxThread::Sleep( unsigned long milliseconds
)
812 AbsoluteTime wakeup
= AddDurationToAbsolute( milliseconds
, UpTime() );
813 MPDelayUntil( &wakeup
);
816 int wxThread::GetCPUCount()
818 return MPProcessors();
821 unsigned long wxThread::GetCurrentId()
823 return (unsigned long)MPCurrentTaskID();
826 bool wxThread::SetConcurrency( size_t WXUNUSED(level
) )
828 // Cannot be set in MacOS.
832 wxThread::wxThread( wxThreadKind kind
)
835 m_internal
= new wxThreadInternal();
837 m_isDetached
= (kind
== wxTHREAD_DETACHED
);
840 wxThread::~wxThread()
842 wxASSERT_MSG( g_numberOfThreads
>0 , wxT("More threads deleted than created.") ) ;
848 // check that the thread either exited or couldn't be created
849 if ( m_internal
->GetState() != STATE_EXITED
&&
850 m_internal
->GetState() != STATE_NEW
)
853 wxT("The thread %ld is being destroyed although it is still running! The application may crash."),
859 wxDELETE( m_internal
) ;
862 wxThreadError
wxThread::Create( unsigned int stackSize
)
864 wxCriticalSectionLocker
lock(m_critsect
);
867 m_internal
->Detach() ;
869 if ( !m_internal
->Create(this, stackSize
) )
871 m_internal
->SetState( STATE_EXITED
);
873 return wxTHREAD_NO_RESOURCE
;
876 return wxTHREAD_NO_ERROR
;
879 wxThreadError
wxThread::Run()
881 wxCriticalSectionLocker
lock(m_critsect
);
883 wxCHECK_MSG( m_internal
->GetId(), wxTHREAD_MISC_ERROR
,
884 wxT("must call wxThread::Create() first") );
886 return m_internal
->Run();
889 // -----------------------------------------------------------------------------
891 // -----------------------------------------------------------------------------
893 wxThreadError
wxThread::Pause()
895 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR
,
896 wxT("a thread can't pause itself") );
898 wxCriticalSectionLocker
lock(m_critsect
);
900 if ( m_internal
->GetState() != STATE_RUNNING
)
902 wxLogDebug( wxT("Can't pause thread which is not running.") );
904 return wxTHREAD_NOT_RUNNING
;
907 // just set a flag, the thread will be really paused only during the next
908 // call to TestDestroy()
909 m_internal
->SetState( STATE_PAUSED
);
911 return wxTHREAD_NO_ERROR
;
914 wxThreadError
wxThread::Resume()
916 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR
,
917 wxT("a thread can't resume itself") );
919 wxCriticalSectionLocker
lock(m_critsect
);
921 wxThreadState state
= m_internal
->GetState();
926 m_internal
->Resume();
927 return wxTHREAD_NO_ERROR
;
930 return wxTHREAD_NO_ERROR
;
933 wxLogDebug( wxT("Attempt to resume a thread which is not paused.") );
935 return wxTHREAD_MISC_ERROR
;
939 // -----------------------------------------------------------------------------
941 // -----------------------------------------------------------------------------
943 wxThread::ExitCode
wxThread::Wait()
945 wxCHECK_MSG( This() != this, (ExitCode
)-1,
946 wxT("a thread can't wait for itself") );
948 wxCHECK_MSG( !m_isDetached
, (ExitCode
)-1,
949 wxT("can't wait for detached thread") );
953 return m_internal
->GetExitCode();
956 wxThreadError
wxThread::Delete(ExitCode
*rc
)
958 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR
,
959 wxT("a thread can't delete itself") );
961 bool isDetached
= m_isDetached
;
964 wxThreadState state
= m_internal
->GetState();
966 // ask the thread to stop
967 m_internal
->SetCancelFlag();
974 // we need to wake up the thread so that PthreadStart() will
975 // terminate - right now it's blocking on run semaphore in
977 m_internal
->SignalRun();
986 // resume the thread first
987 m_internal
->Resume();
994 // wait until the thread stops
999 // return the exit code of the thread
1000 *rc
= m_internal
->GetExitCode();
1005 return wxTHREAD_NO_ERROR
;
1008 wxThreadError
wxThread::Kill()
1010 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR
,
1011 wxT("a thread can't kill itself") );
1013 switch ( m_internal
->GetState() )
1017 return wxTHREAD_NOT_RUNNING
;
1020 // resume the thread first
1026 OSStatus err
= MPTerminateTask( m_internal
->GetId() , -1 ) ;
1029 wxLogError( wxT("Failed to terminate a thread.") );
1031 return wxTHREAD_MISC_ERROR
;
1040 // this should be retrieved by Wait actually
1041 m_internal
->SetExitCode( (void*)-1 );
1044 return wxTHREAD_NO_ERROR
;
1048 void wxThread::Exit( ExitCode status
)
1050 wxASSERT_MSG( This() == this,
1051 wxT("wxThread::Exit() can only be called in the context of the same thread") );
1053 // don't enter m_critsect before calling OnExit() because the user code
1054 // might deadlock if, for example, it signals a condition in OnExit() (a
1055 // common case) while the main thread calls any of functions entering
1056 // m_critsect on us (almost all of them do)
1059 MPTaskID threadid
= m_internal
->GetId();
1067 // update the status of the joinable thread
1068 wxCriticalSectionLocker
lock( m_critsect
);
1069 m_internal
->SetState( STATE_EXITED
);
1072 MPTerminateTask( threadid
, (long)status
);
1075 // also test whether we were paused
1076 bool wxThread::TestDestroy()
1078 wxASSERT_MSG( This() == this,
1079 wxT("wxThread::TestDestroy() can only be called in the context of the same thread") );
1083 if ( m_internal
->GetState() == STATE_PAUSED
)
1085 m_internal
->SetReallyPaused( true );
1087 // leave the crit section or the other threads will stop too if they attempt
1088 // to call any of (seemingly harmless) IsXXX() functions while we sleep
1091 m_internal
->Pause();
1095 // thread wasn't requested to pause, nothing to do
1099 return m_internal
->WasCancelled();
1102 // -----------------------------------------------------------------------------
1104 // -----------------------------------------------------------------------------
1106 void wxThread::SetPriority(unsigned int prio
)
1108 wxCHECK_RET( ((int)WXTHREAD_MIN_PRIORITY
<= (int)prio
) &&
1109 ((int)prio
<= (int)WXTHREAD_MAX_PRIORITY
),
1110 wxT("invalid thread priority") );
1112 wxCriticalSectionLocker
lock(m_critsect
);
1114 switch ( m_internal
->GetState() )
1119 // thread not yet started, priority will be set when it is
1120 m_internal
->SetPriority( prio
);
1125 wxFAIL_MSG( wxT("impossible to set thread priority in this state") );
1129 unsigned int wxThread::GetPriority() const
1131 wxCriticalSectionLocker
lock(const_cast<wxCriticalSection
&>(m_critsect
));
1133 return m_internal
->GetPriority();
1136 unsigned long wxThread::GetId() const
1138 wxCriticalSectionLocker
lock(const_cast<wxCriticalSection
&>(m_critsect
));
1140 return (unsigned long)m_internal
->GetId();
1143 // -----------------------------------------------------------------------------
1145 // -----------------------------------------------------------------------------
1147 bool wxThread::IsRunning() const
1149 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
);
1151 return m_internal
->GetState() == STATE_RUNNING
;
1154 bool wxThread::IsAlive() const
1156 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
);
1158 switch ( m_internal
->GetState() )
1169 bool wxThread::IsPaused() const
1171 wxCriticalSectionLocker
lock((wxCriticalSection
&)m_critsect
);
1173 return (m_internal
->GetState() == STATE_PAUSED
);
1176 // ----------------------------------------------------------------------------
1177 // Automatic initialization for thread module
1178 // ----------------------------------------------------------------------------
1180 class wxThreadModule
: public wxModule
1183 virtual bool OnInit();
1184 virtual void OnExit();
1187 DECLARE_DYNAMIC_CLASS(wxThreadModule
)
1190 IMPLEMENT_DYNAMIC_CLASS(wxThreadModule
, wxModule
)
1192 bool wxThreadModule::OnInit()
1194 bool hasThreadManager
=
1196 true ; // TODO VERIFY IN NEXT BUILD
1198 MPLibraryIsLoaded();
1201 if ( !hasThreadManager
)
1203 wxLogError( wxT("MP thread support is not available on this system" ) ) ;
1208 // main thread's This() is NULL
1209 verify_noerr( MPAllocateTaskStorageIndex( &gs_tlsForWXThread
) ) ;
1210 verify_noerr( MPSetTaskStorageValue( gs_tlsForWXThread
, 0 ) ) ;
1212 wxThread::ms_idMainThread
= wxThread::GetCurrentId();
1213 gs_critsectWaitingForGui
= new wxCriticalSection();
1215 gs_critsectGui
= new wxCriticalSection();
1216 gs_critsectGui
->Enter();
1221 void wxThreadModule::OnExit()
1223 if ( gs_critsectGui
)
1225 if ( !wxGuiOwnedByMainThread() )
1227 gs_critsectGui
->Enter();
1228 gs_bGuiOwnedByMainThread
= true;
1231 gs_critsectGui
->Leave();
1232 wxDELETE(gs_critsectGui
);
1235 wxDELETE(gs_critsectWaitingForGui
);
1238 // ----------------------------------------------------------------------------
1239 // GUI Serialization copied from MSW implementation
1240 // ----------------------------------------------------------------------------
1242 void wxMutexGuiEnterImpl()
1244 // this would dead lock everything...
1245 wxASSERT_MSG( !wxThread::IsMain(),
1246 wxT("main thread doesn't want to block in wxMutexGuiEnter()!") );
1248 // the order in which we enter the critical sections here is crucial!!
1250 // set the flag telling to the main thread that we want to do some GUI
1252 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1254 gs_nWaitingForGui
++;
1257 wxWakeUpMainThread();
1259 // now we may block here because the main thread will soon let us in
1260 // (during the next iteration of OnIdle())
1261 gs_critsectGui
->Enter();
1264 void wxMutexGuiLeaveImpl()
1266 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1268 if ( wxThread::IsMain() )
1270 gs_bGuiOwnedByMainThread
= false;
1274 // decrement the number of threads waiting for GUI access now
1275 wxASSERT_MSG( gs_nWaitingForGui
> 0,
1276 wxT("calling wxMutexGuiLeave() without entering it first?") );
1278 gs_nWaitingForGui
--;
1280 wxWakeUpMainThread();
1283 gs_critsectGui
->Leave();
1286 void WXDLLIMPEXP_BASE
wxMutexGuiLeaveOrEnter()
1288 wxASSERT_MSG( wxThread::IsMain(),
1289 wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") );
1291 if ( !gs_critsectWaitingForGui
)
1294 wxCriticalSectionLocker
enter(*gs_critsectWaitingForGui
);
1296 if ( gs_nWaitingForGui
== 0 )
1298 // no threads are waiting for GUI - so we may acquire the lock without
1299 // any danger (but only if we don't already have it)
1300 if ( !wxGuiOwnedByMainThread() )
1302 gs_critsectGui
->Enter();
1304 gs_bGuiOwnedByMainThread
= true;
1306 //else: already have it, nothing to do
1310 // some threads are waiting, release the GUI lock if we have it
1311 if ( wxGuiOwnedByMainThread() )
1313 //else: some other worker thread is doing GUI
1317 bool WXDLLIMPEXP_BASE
wxGuiOwnedByMainThread()
1319 return gs_bGuiOwnedByMainThread
;
1322 // wake up the main thread
1323 void WXDLLEXPORT
wxWakeUpMainThread()
1328 // ----------------------------------------------------------------------------
1329 // include common implementation code
1330 // ----------------------------------------------------------------------------
1332 #include "wx/thrimpl.cpp"
1334 #endif // wxUSE_THREADS