add MutexGuiEnter/Leave to wxAppTraits, integrate native GTK+ GUI locking
[wxWidgets.git] / src / unix / threadpsx.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/unix/threadpsx.cpp
3 // Purpose: wxThread (Posix) Implementation
4 // Author: Original from Wolfram Gloger/Guilhem Lavaux
5 // Modified by: K. S. Sreeram (2002): POSIXified wxCondition, added wxSemaphore
6 // Created: 04/22/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Wolfram Gloger (1996, 1997)
9 // Guilhem Lavaux (1998)
10 // Vadim Zeitlin (1999-2002)
11 // Robert Roebling (1999)
12 // K. S. Sreeram (2002)
13 // Licence: wxWindows licence
14 /////////////////////////////////////////////////////////////////////////////
15
16 // ============================================================================
17 // declaration
18 // ============================================================================
19
20 // ----------------------------------------------------------------------------
21 // headers
22 // ----------------------------------------------------------------------------
23
24 // for compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #if wxUSE_THREADS
28
29 #include "wx/thread.h"
30 #include "wx/except.h"
31
32 #ifndef WX_PRECOMP
33 #include "wx/app.h"
34 #include "wx/dynarray.h"
35 #include "wx/intl.h"
36 #include "wx/log.h"
37 #include "wx/utils.h"
38 #include "wx/timer.h"
39 #include "wx/stopwatch.h"
40 #include "wx/module.h"
41 #endif
42
43 #include <stdio.h>
44 #include <unistd.h>
45 #include <pthread.h>
46 #include <errno.h>
47 #include <time.h>
48 #ifdef HAVE_SCHED_H
49 #include <sched.h>
50 #endif
51
52 #ifdef HAVE_THR_SETCONCURRENCY
53 #include <thread.h>
54 #endif
55
56 // we use wxFFile under Linux in GetCPUCount()
57 #ifdef __LINUX__
58 #include "wx/ffile.h"
59 // For setpriority.
60 #include <sys/time.h>
61 #include <sys/resource.h>
62 #endif
63
64 #ifdef __VMS
65 #define THR_ID(thr) ((long long)(thr)->GetId())
66 #else
67 #define THR_ID(thr) ((long)(thr)->GetId())
68 #endif
69
70 // ----------------------------------------------------------------------------
71 // constants
72 // ----------------------------------------------------------------------------
73
74 // the possible states of the thread and transitions from them
75 enum wxThreadState
76 {
77 STATE_NEW, // didn't start execution yet (=> RUNNING)
78 STATE_RUNNING, // running (=> PAUSED or EXITED)
79 STATE_PAUSED, // suspended (=> RUNNING or EXITED)
80 STATE_EXITED // thread doesn't exist any more
81 };
82
83 // the exit value of a thread which has been cancelled
84 static const wxThread::ExitCode EXITCODE_CANCELLED = (wxThread::ExitCode)-1;
85
86 // trace mask for wxThread operations
87 #define TRACE_THREADS _T("thread")
88
89 // you can get additional debugging messages for the semaphore operations
90 #define TRACE_SEMA _T("semaphore")
91
92 // ----------------------------------------------------------------------------
93 // private functions
94 // ----------------------------------------------------------------------------
95
96 static void ScheduleThreadForDeletion();
97 static void DeleteThread(wxThread *This);
98
99 // ----------------------------------------------------------------------------
100 // private classes
101 // ----------------------------------------------------------------------------
102
103 // an (non owning) array of pointers to threads
104 WX_DEFINE_ARRAY_PTR(wxThread *, wxArrayThread);
105
106 // an entry for a thread we can wait for
107
108 // -----------------------------------------------------------------------------
109 // global data
110 // -----------------------------------------------------------------------------
111
112 // we keep the list of all threads created by the application to be able to
113 // terminate them on exit if there are some left - otherwise the process would
114 // be left in memory
115 static wxArrayThread gs_allThreads;
116
117 // a mutex to protect gs_allThreads
118 static wxMutex *gs_mutexAllThreads = NULL;
119
120 // the id of the main thread
121 static pthread_t gs_tidMain = (pthread_t)-1;
122
123 // the key for the pointer to the associated wxThread object
124 static pthread_key_t gs_keySelf;
125
126 // the number of threads which are being deleted - the program won't exit
127 // until there are any left
128 static size_t gs_nThreadsBeingDeleted = 0;
129
130 // a mutex to protect gs_nThreadsBeingDeleted
131 static wxMutex *gs_mutexDeleteThread = (wxMutex *)NULL;
132
133 // and a condition variable which will be signaled when all
134 // gs_nThreadsBeingDeleted will have been deleted
135 static wxCondition *gs_condAllDeleted = (wxCondition *)NULL;
136
137 // this mutex must be acquired before any call to a GUI function
138 // (it's not inside #if wxUSE_GUI because this file is compiled as part
139 // of wxBase)
140 static wxMutex *gs_mutexGui = NULL;
141
142 // when we wait for a thread to exit, we're blocking on a condition which the
143 // thread signals in its SignalExit() method -- but this condition can't be a
144 // member of the thread itself as a detached thread may delete itself at any
145 // moment and accessing the condition member of the thread after this would
146 // result in a disaster
147 //
148 // so instead we maintain a global list of the structs below for the threads
149 // we're interested in waiting on
150
151 // ============================================================================
152 // wxMutex implementation
153 // ============================================================================
154
155 // ----------------------------------------------------------------------------
156 // wxMutexInternal
157 // ----------------------------------------------------------------------------
158
159 // this is a simple wrapper around pthread_mutex_t which provides error
160 // checking
161 class wxMutexInternal
162 {
163 public:
164 wxMutexInternal(wxMutexType mutexType);
165 ~wxMutexInternal();
166
167 wxMutexError Lock();
168 wxMutexError Lock(unsigned long ms);
169 wxMutexError TryLock();
170 wxMutexError Unlock();
171
172 bool IsOk() const { return m_isOk; }
173
174 private:
175 // convert the result of pthread_mutex_[timed]lock() call to wx return code
176 wxMutexError HandleLockResult(int err);
177
178 private:
179 pthread_mutex_t m_mutex;
180 bool m_isOk;
181
182 // wxConditionInternal uses our m_mutex
183 friend class wxConditionInternal;
184 };
185
186 #if defined(HAVE_PTHREAD_MUTEXATTR_T) && \
187 wxUSE_UNIX && !defined(HAVE_PTHREAD_MUTEXATTR_SETTYPE_DECL)
188 // on some systems pthread_mutexattr_settype() is not in the headers (but it is
189 // in the library, otherwise we wouldn't compile this code at all)
190 extern "C" int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
191 #endif
192
193 wxMutexInternal::wxMutexInternal(wxMutexType mutexType)
194 {
195 int err;
196 switch ( mutexType )
197 {
198 case wxMUTEX_RECURSIVE:
199 // support recursive locks like Win32, i.e. a thread can lock a
200 // mutex which it had itself already locked
201 //
202 // unfortunately initialization of recursive mutexes is non
203 // portable, so try several methods
204 #ifdef HAVE_PTHREAD_MUTEXATTR_T
205 {
206 pthread_mutexattr_t attr;
207 pthread_mutexattr_init(&attr);
208 pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
209
210 err = pthread_mutex_init(&m_mutex, &attr);
211 }
212 #elif defined(HAVE_PTHREAD_RECURSIVE_MUTEX_INITIALIZER)
213 // we can use this only as initializer so we have to assign it
214 // first to a temp var - assigning directly to m_mutex wouldn't
215 // even compile
216 {
217 pthread_mutex_t mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
218 m_mutex = mutex;
219 }
220 #else // no recursive mutexes
221 err = EINVAL;
222 #endif // HAVE_PTHREAD_MUTEXATTR_T/...
223 break;
224
225 default:
226 wxFAIL_MSG( _T("unknown mutex type") );
227 // fall through
228
229 case wxMUTEX_DEFAULT:
230 err = pthread_mutex_init(&m_mutex, NULL);
231 break;
232 }
233
234 m_isOk = err == 0;
235 if ( !m_isOk )
236 {
237 wxLogApiError( wxT("pthread_mutex_init()"), err);
238 }
239 }
240
241 wxMutexInternal::~wxMutexInternal()
242 {
243 if ( m_isOk )
244 {
245 int err = pthread_mutex_destroy(&m_mutex);
246 if ( err != 0 )
247 {
248 wxLogApiError( wxT("pthread_mutex_destroy()"), err);
249 }
250 }
251 }
252
253 wxMutexError wxMutexInternal::Lock()
254 {
255 return HandleLockResult(pthread_mutex_lock(&m_mutex));
256 }
257
258 wxMutexError wxMutexInternal::Lock(unsigned long ms)
259 {
260 #ifdef HAVE_PTHREAD_MUTEX_TIMEDLOCK
261 static const long MSEC_IN_SEC = 1000;
262 static const long NSEC_IN_MSEC = 1000000;
263 static const long NSEC_IN_USEC = 1000;
264 static const long NSEC_IN_SEC = MSEC_IN_SEC * NSEC_IN_MSEC;
265
266 time_t seconds = ms/MSEC_IN_SEC;
267 long nanoseconds = (ms % MSEC_IN_SEC) * NSEC_IN_MSEC;
268 timespec ts = { 0, 0 };
269
270 // normally we should use clock_gettime(CLOCK_REALTIME) here but this
271 // function is in librt and we don't link with it currently, so use
272 // gettimeofday() instead -- if it turns out that this is really too
273 // imprecise, we should modify configure to check if clock_gettime() is
274 // available and whether it requires -lrt and use it instead
275 #if 0
276 if ( clock_gettime(CLOCK_REALTIME, &ts) == 0 )
277 {
278 }
279 #else
280 struct timeval tv;
281 if ( wxGetTimeOfDay(&tv) != -1 )
282 {
283 ts.tv_sec = tv.tv_sec;
284 ts.tv_nsec = tv.tv_usec*NSEC_IN_USEC;
285 }
286 #endif
287 else // fall back on system timer
288 {
289 ts.tv_sec = time(NULL);
290 }
291
292 ts.tv_sec += seconds;
293 ts.tv_nsec += nanoseconds;
294 if ( ts.tv_nsec > NSEC_IN_SEC )
295 {
296 ts.tv_sec += 1;
297 ts.tv_nsec -= NSEC_IN_SEC;
298 }
299
300 return HandleLockResult(pthread_mutex_timedlock(&m_mutex, &ts));
301 #else // !HAVE_PTHREAD_MUTEX_TIMEDLOCK
302 wxUnusedVar(ms);
303
304 return wxMUTEX_MISC_ERROR;
305 #endif // HAVE_PTHREAD_MUTEX_TIMEDLOCK/!HAVE_PTHREAD_MUTEX_TIMEDLOCK
306 }
307
308 wxMutexError wxMutexInternal::HandleLockResult(int err)
309 {
310 switch ( err )
311 {
312 case EDEADLK:
313 // only error checking mutexes return this value and so it's an
314 // unexpected situation -- hence use assert, not wxLogDebug
315 wxFAIL_MSG( _T("mutex deadlock prevented") );
316 return wxMUTEX_DEAD_LOCK;
317
318 case EINVAL:
319 wxLogDebug(_T("pthread_mutex_[timed]lock(): mutex not initialized"));
320 break;
321
322 case ETIMEDOUT:
323 return wxMUTEX_TIMEOUT;
324
325 case 0:
326 return wxMUTEX_NO_ERROR;
327
328 default:
329 wxLogApiError(_T("pthread_mutex_[timed]lock()"), err);
330 }
331
332 return wxMUTEX_MISC_ERROR;
333 }
334
335
336 wxMutexError wxMutexInternal::TryLock()
337 {
338 int err = pthread_mutex_trylock(&m_mutex);
339 switch ( err )
340 {
341 case EBUSY:
342 // not an error: mutex is already locked, but we're prepared for
343 // this
344 return wxMUTEX_BUSY;
345
346 case EINVAL:
347 wxLogDebug(_T("pthread_mutex_trylock(): mutex not initialized."));
348 break;
349
350 case 0:
351 return wxMUTEX_NO_ERROR;
352
353 default:
354 wxLogApiError(_T("pthread_mutex_trylock()"), err);
355 }
356
357 return wxMUTEX_MISC_ERROR;
358 }
359
360 wxMutexError wxMutexInternal::Unlock()
361 {
362 int err = pthread_mutex_unlock(&m_mutex);
363 switch ( err )
364 {
365 case EPERM:
366 // we don't own the mutex
367 return wxMUTEX_UNLOCKED;
368
369 case EINVAL:
370 wxLogDebug(_T("pthread_mutex_unlock(): mutex not initialized."));
371 break;
372
373 case 0:
374 return wxMUTEX_NO_ERROR;
375
376 default:
377 wxLogApiError(_T("pthread_mutex_unlock()"), err);
378 }
379
380 return wxMUTEX_MISC_ERROR;
381 }
382
383 // ===========================================================================
384 // wxCondition implementation
385 // ===========================================================================
386
387 // ---------------------------------------------------------------------------
388 // wxConditionInternal
389 // ---------------------------------------------------------------------------
390
391 // this is a wrapper around pthread_cond_t associated with a wxMutex (and hence
392 // with a pthread_mutex_t)
393 class wxConditionInternal
394 {
395 public:
396 wxConditionInternal(wxMutex& mutex);
397 ~wxConditionInternal();
398
399 bool IsOk() const { return m_isOk && m_mutex.IsOk(); }
400
401 wxCondError Wait();
402 wxCondError WaitTimeout(unsigned long milliseconds);
403
404 wxCondError Signal();
405 wxCondError Broadcast();
406
407 private:
408 // get the POSIX mutex associated with us
409 pthread_mutex_t *GetPMutex() const { return &m_mutex.m_internal->m_mutex; }
410
411 wxMutex& m_mutex;
412 pthread_cond_t m_cond;
413
414 bool m_isOk;
415 };
416
417 wxConditionInternal::wxConditionInternal(wxMutex& mutex)
418 : m_mutex(mutex)
419 {
420 int err = pthread_cond_init(&m_cond, NULL /* default attributes */);
421
422 m_isOk = err == 0;
423
424 if ( !m_isOk )
425 {
426 wxLogApiError(_T("pthread_cond_init()"), err);
427 }
428 }
429
430 wxConditionInternal::~wxConditionInternal()
431 {
432 if ( m_isOk )
433 {
434 int err = pthread_cond_destroy(&m_cond);
435 if ( err != 0 )
436 {
437 wxLogApiError(_T("pthread_cond_destroy()"), err);
438 }
439 }
440 }
441
442 wxCondError wxConditionInternal::Wait()
443 {
444 int err = pthread_cond_wait(&m_cond, GetPMutex());
445 if ( err != 0 )
446 {
447 wxLogApiError(_T("pthread_cond_wait()"), err);
448
449 return wxCOND_MISC_ERROR;
450 }
451
452 return wxCOND_NO_ERROR;
453 }
454
455 wxCondError wxConditionInternal::WaitTimeout(unsigned long milliseconds)
456 {
457 wxLongLong curtime = wxGetLocalTimeMillis();
458 curtime += milliseconds;
459 wxLongLong temp = curtime / 1000;
460 int sec = temp.GetLo();
461 temp *= 1000;
462 temp = curtime - temp;
463 int millis = temp.GetLo();
464
465 timespec tspec;
466
467 tspec.tv_sec = sec;
468 tspec.tv_nsec = millis * 1000L * 1000L;
469
470 int err = pthread_cond_timedwait( &m_cond, GetPMutex(), &tspec );
471 switch ( err )
472 {
473 case ETIMEDOUT:
474 return wxCOND_TIMEOUT;
475
476 case 0:
477 return wxCOND_NO_ERROR;
478
479 default:
480 wxLogApiError(_T("pthread_cond_timedwait()"), err);
481 }
482
483 return wxCOND_MISC_ERROR;
484 }
485
486 wxCondError wxConditionInternal::Signal()
487 {
488 int err = pthread_cond_signal(&m_cond);
489 if ( err != 0 )
490 {
491 wxLogApiError(_T("pthread_cond_signal()"), err);
492
493 return wxCOND_MISC_ERROR;
494 }
495
496 return wxCOND_NO_ERROR;
497 }
498
499 wxCondError wxConditionInternal::Broadcast()
500 {
501 int err = pthread_cond_broadcast(&m_cond);
502 if ( err != 0 )
503 {
504 wxLogApiError(_T("pthread_cond_broadcast()"), err);
505
506 return wxCOND_MISC_ERROR;
507 }
508
509 return wxCOND_NO_ERROR;
510 }
511
512 // ===========================================================================
513 // wxSemaphore implementation
514 // ===========================================================================
515
516 // ---------------------------------------------------------------------------
517 // wxSemaphoreInternal
518 // ---------------------------------------------------------------------------
519
520 // we implement the semaphores using mutexes and conditions instead of using
521 // the sem_xxx() POSIX functions because they're not widely available and also
522 // because it's impossible to implement WaitTimeout() using them
523 class wxSemaphoreInternal
524 {
525 public:
526 wxSemaphoreInternal(int initialcount, int maxcount);
527
528 bool IsOk() const { return m_isOk; }
529
530 wxSemaError Wait();
531 wxSemaError TryWait();
532 wxSemaError WaitTimeout(unsigned long milliseconds);
533
534 wxSemaError Post();
535
536 private:
537 wxMutex m_mutex;
538 wxCondition m_cond;
539
540 size_t m_count,
541 m_maxcount;
542
543 bool m_isOk;
544 };
545
546 wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount)
547 : m_cond(m_mutex)
548 {
549
550 if ( (initialcount < 0 || maxcount < 0) ||
551 ((maxcount > 0) && (initialcount > maxcount)) )
552 {
553 wxFAIL_MSG( _T("wxSemaphore: invalid initial or maximal count") );
554
555 m_isOk = false;
556 }
557 else
558 {
559 m_maxcount = (size_t)maxcount;
560 m_count = (size_t)initialcount;
561 }
562
563 m_isOk = m_mutex.IsOk() && m_cond.IsOk();
564 }
565
566 wxSemaError wxSemaphoreInternal::Wait()
567 {
568 wxMutexLocker locker(m_mutex);
569
570 while ( m_count == 0 )
571 {
572 wxLogTrace(TRACE_SEMA,
573 _T("Thread %ld waiting for semaphore to become signalled"),
574 wxThread::GetCurrentId());
575
576 if ( m_cond.Wait() != wxCOND_NO_ERROR )
577 return wxSEMA_MISC_ERROR;
578
579 wxLogTrace(TRACE_SEMA,
580 _T("Thread %ld finished waiting for semaphore, count = %lu"),
581 wxThread::GetCurrentId(), (unsigned long)m_count);
582 }
583
584 m_count--;
585
586 return wxSEMA_NO_ERROR;
587 }
588
589 wxSemaError wxSemaphoreInternal::TryWait()
590 {
591 wxMutexLocker locker(m_mutex);
592
593 if ( m_count == 0 )
594 return wxSEMA_BUSY;
595
596 m_count--;
597
598 return wxSEMA_NO_ERROR;
599 }
600
601 wxSemaError wxSemaphoreInternal::WaitTimeout(unsigned long milliseconds)
602 {
603 wxMutexLocker locker(m_mutex);
604
605 wxLongLong startTime = wxGetLocalTimeMillis();
606
607 while ( m_count == 0 )
608 {
609 wxLongLong elapsed = wxGetLocalTimeMillis() - startTime;
610 long remainingTime = (long)milliseconds - (long)elapsed.GetLo();
611 if ( remainingTime <= 0 )
612 {
613 // timeout
614 return wxSEMA_TIMEOUT;
615 }
616
617 switch ( m_cond.WaitTimeout(remainingTime) )
618 {
619 case wxCOND_TIMEOUT:
620 return wxSEMA_TIMEOUT;
621
622 default:
623 return wxSEMA_MISC_ERROR;
624
625 case wxCOND_NO_ERROR:
626 ;
627 }
628 }
629
630 m_count--;
631
632 return wxSEMA_NO_ERROR;
633 }
634
635 wxSemaError wxSemaphoreInternal::Post()
636 {
637 wxMutexLocker locker(m_mutex);
638
639 if ( m_maxcount > 0 && m_count == m_maxcount )
640 {
641 return wxSEMA_OVERFLOW;
642 }
643
644 m_count++;
645
646 wxLogTrace(TRACE_SEMA,
647 _T("Thread %ld about to signal semaphore, count = %lu"),
648 wxThread::GetCurrentId(), (unsigned long)m_count);
649
650 return m_cond.Signal() == wxCOND_NO_ERROR ? wxSEMA_NO_ERROR
651 : wxSEMA_MISC_ERROR;
652 }
653
654 // ===========================================================================
655 // wxThread implementation
656 // ===========================================================================
657
658 // the thread callback functions must have the C linkage
659 extern "C"
660 {
661
662 #ifdef wxHAVE_PTHREAD_CLEANUP
663 // thread exit function
664 void wxPthreadCleanup(void *ptr);
665 #endif // wxHAVE_PTHREAD_CLEANUP
666
667 void *wxPthreadStart(void *ptr);
668
669 } // extern "C"
670
671 // ----------------------------------------------------------------------------
672 // wxThreadInternal
673 // ----------------------------------------------------------------------------
674
675 class wxThreadInternal
676 {
677 public:
678 wxThreadInternal();
679 ~wxThreadInternal();
680
681 // thread entry function
682 static void *PthreadStart(wxThread *thread);
683
684 // thread actions
685 // start the thread
686 wxThreadError Run();
687 // unblock the thread allowing it to run
688 void SignalRun() { m_semRun.Post(); }
689 // ask the thread to terminate
690 void Wait();
691 // go to sleep until Resume() is called
692 void Pause();
693 // resume the thread
694 void Resume();
695
696 // accessors
697 // priority
698 int GetPriority() const { return m_prio; }
699 void SetPriority(int prio) { m_prio = prio; }
700 // state
701 wxThreadState GetState() const { return m_state; }
702 void SetState(wxThreadState state)
703 {
704 #ifdef __WXDEBUG__
705 static const wxChar *stateNames[] =
706 {
707 _T("NEW"),
708 _T("RUNNING"),
709 _T("PAUSED"),
710 _T("EXITED"),
711 };
712
713 wxLogTrace(TRACE_THREADS, _T("Thread %ld: %s => %s."),
714 (long)GetId(), stateNames[m_state], stateNames[state]);
715 #endif // __WXDEBUG__
716
717 m_state = state;
718 }
719 // id
720 pthread_t GetId() const { return m_threadId; }
721 pthread_t *GetIdPtr() { return &m_threadId; }
722 // "cancelled" flag
723 void SetCancelFlag() { m_cancelled = true; }
724 bool WasCancelled() const { return m_cancelled; }
725 // exit code
726 void SetExitCode(wxThread::ExitCode exitcode) { m_exitcode = exitcode; }
727 wxThread::ExitCode GetExitCode() const { return m_exitcode; }
728
729 // the pause flag
730 void SetReallyPaused(bool paused) { m_isPaused = paused; }
731 bool IsReallyPaused() const { return m_isPaused; }
732
733 // tell the thread that it is a detached one
734 void Detach()
735 {
736 wxCriticalSectionLocker lock(m_csJoinFlag);
737
738 m_shouldBeJoined = false;
739 m_isDetached = true;
740 }
741
742 #ifdef wxHAVE_PTHREAD_CLEANUP
743 // this is used by wxPthreadCleanup() only
744 static void Cleanup(wxThread *thread);
745 #endif // wxHAVE_PTHREAD_CLEANUP
746
747 private:
748 pthread_t m_threadId; // id of the thread
749 wxThreadState m_state; // see wxThreadState enum
750 int m_prio; // in wxWidgets units: from 0 to 100
751
752 // this flag is set when the thread should terminate
753 bool m_cancelled;
754
755 // this flag is set when the thread is blocking on m_semSuspend
756 bool m_isPaused;
757
758 // the thread exit code - only used for joinable (!detached) threads and
759 // is only valid after the thread termination
760 wxThread::ExitCode m_exitcode;
761
762 // many threads may call Wait(), but only one of them should call
763 // pthread_join(), so we have to keep track of this
764 wxCriticalSection m_csJoinFlag;
765 bool m_shouldBeJoined;
766 bool m_isDetached;
767
768 // this semaphore is posted by Run() and the threads Entry() is not
769 // called before it is done
770 wxSemaphore m_semRun;
771
772 // this one is signaled when the thread should resume after having been
773 // Pause()d
774 wxSemaphore m_semSuspend;
775 };
776
777 // ----------------------------------------------------------------------------
778 // thread startup and exit functions
779 // ----------------------------------------------------------------------------
780
781 void *wxPthreadStart(void *ptr)
782 {
783 return wxThreadInternal::PthreadStart((wxThread *)ptr);
784 }
785
786 void *wxThreadInternal::PthreadStart(wxThread *thread)
787 {
788 wxThreadInternal *pthread = thread->m_internal;
789
790 wxLogTrace(TRACE_THREADS, _T("Thread %ld started."), THR_ID(pthread));
791
792 // associate the thread pointer with the newly created thread so that
793 // wxThread::This() will work
794 int rc = pthread_setspecific(gs_keySelf, thread);
795 if ( rc != 0 )
796 {
797 wxLogSysError(rc, _("Cannot start thread: error writing TLS"));
798
799 return (void *)-1;
800 }
801
802 // have to declare this before pthread_cleanup_push() which defines a
803 // block!
804 bool dontRunAtAll;
805
806 #ifdef wxHAVE_PTHREAD_CLEANUP
807 // install the cleanup handler which will be called if the thread is
808 // cancelled
809 pthread_cleanup_push(wxPthreadCleanup, thread);
810 #endif // wxHAVE_PTHREAD_CLEANUP
811
812 // wait for the semaphore to be posted from Run()
813 pthread->m_semRun.Wait();
814
815 // test whether we should run the run at all - may be it was deleted
816 // before it started to Run()?
817 {
818 wxCriticalSectionLocker lock(thread->m_critsect);
819
820 dontRunAtAll = pthread->GetState() == STATE_NEW &&
821 pthread->WasCancelled();
822 }
823
824 if ( !dontRunAtAll )
825 {
826 // call the main entry
827 wxLogTrace(TRACE_THREADS,
828 _T("Thread %ld about to enter its Entry()."),
829 THR_ID(pthread));
830
831 wxTRY
832 {
833 pthread->m_exitcode = thread->Entry();
834
835 wxLogTrace(TRACE_THREADS,
836 _T("Thread %ld Entry() returned %lu."),
837 THR_ID(pthread), wxPtrToUInt(pthread->m_exitcode));
838 }
839 wxCATCH_ALL( wxTheApp->OnUnhandledException(); )
840
841 {
842 wxCriticalSectionLocker lock(thread->m_critsect);
843
844 // change the state of the thread to "exited" so that
845 // wxPthreadCleanup handler won't do anything from now (if it's
846 // called before we do pthread_cleanup_pop below)
847 pthread->SetState(STATE_EXITED);
848 }
849 }
850
851 // NB: pthread_cleanup_push/pop() are macros and pop contains the matching
852 // '}' for the '{' in push, so they must be used in the same block!
853 #ifdef wxHAVE_PTHREAD_CLEANUP
854 #ifdef __DECCXX
855 // under Tru64 we get a warning from macro expansion
856 #pragma message save
857 #pragma message disable(declbutnotref)
858 #endif
859
860 // remove the cleanup handler without executing it
861 pthread_cleanup_pop(FALSE);
862
863 #ifdef __DECCXX
864 #pragma message restore
865 #endif
866 #endif // wxHAVE_PTHREAD_CLEANUP
867
868 if ( dontRunAtAll )
869 {
870 // FIXME: deleting a possibly joinable thread here???
871 delete thread;
872
873 return EXITCODE_CANCELLED;
874 }
875 else
876 {
877 // terminate the thread
878 thread->Exit(pthread->m_exitcode);
879
880 wxFAIL_MSG(wxT("wxThread::Exit() can't return."));
881
882 return NULL;
883 }
884 }
885
886 #ifdef wxHAVE_PTHREAD_CLEANUP
887
888 // this handler is called when the thread is cancelled
889 extern "C" void wxPthreadCleanup(void *ptr)
890 {
891 wxThreadInternal::Cleanup((wxThread *)ptr);
892 }
893
894 void wxThreadInternal::Cleanup(wxThread *thread)
895 {
896 if (pthread_getspecific(gs_keySelf) == 0) return;
897 {
898 wxCriticalSectionLocker lock(thread->m_critsect);
899 if ( thread->m_internal->GetState() == STATE_EXITED )
900 {
901 // thread is already considered as finished.
902 return;
903 }
904 }
905
906 // exit the thread gracefully
907 thread->Exit(EXITCODE_CANCELLED);
908 }
909
910 #endif // wxHAVE_PTHREAD_CLEANUP
911
912 // ----------------------------------------------------------------------------
913 // wxThreadInternal
914 // ----------------------------------------------------------------------------
915
916 wxThreadInternal::wxThreadInternal()
917 {
918 m_state = STATE_NEW;
919 m_cancelled = false;
920 m_prio = WXTHREAD_DEFAULT_PRIORITY;
921 m_threadId = 0;
922 m_exitcode = 0;
923
924 // set to true only when the thread starts waiting on m_semSuspend
925 m_isPaused = false;
926
927 // defaults for joinable threads
928 m_shouldBeJoined = true;
929 m_isDetached = false;
930 }
931
932 wxThreadInternal::~wxThreadInternal()
933 {
934 }
935
936 wxThreadError wxThreadInternal::Run()
937 {
938 wxCHECK_MSG( GetState() == STATE_NEW, wxTHREAD_RUNNING,
939 wxT("thread may only be started once after Create()") );
940
941 SetState(STATE_RUNNING);
942
943 // wake up threads waiting for our start
944 SignalRun();
945
946 return wxTHREAD_NO_ERROR;
947 }
948
949 void wxThreadInternal::Wait()
950 {
951 wxCHECK_RET( !m_isDetached, _T("can't wait for a detached thread") );
952
953 // if the thread we're waiting for is waiting for the GUI mutex, we will
954 // deadlock so make sure we release it temporarily
955 if ( wxThread::IsMain() )
956 wxMutexGuiLeave();
957
958 wxLogTrace(TRACE_THREADS,
959 _T("Starting to wait for thread %ld to exit."),
960 THR_ID(this));
961
962 // to avoid memory leaks we should call pthread_join(), but it must only be
963 // done once so use a critical section to serialize the code below
964 {
965 wxCriticalSectionLocker lock(m_csJoinFlag);
966
967 if ( m_shouldBeJoined )
968 {
969 // FIXME shouldn't we set cancellation type to DISABLED here? If
970 // we're cancelled inside pthread_join(), things will almost
971 // certainly break - but if we disable the cancellation, we
972 // might deadlock
973 if ( pthread_join(GetId(), &m_exitcode) != 0 )
974 {
975 // this is a serious problem, so use wxLogError and not
976 // wxLogDebug: it is possible to bring the system to its knees
977 // by creating too many threads and not joining them quite
978 // easily
979 wxLogError(_("Failed to join a thread, potential memory leak detected - please restart the program"));
980 }
981
982 m_shouldBeJoined = false;
983 }
984 }
985
986 // reacquire GUI mutex
987 if ( wxThread::IsMain() )
988 wxMutexGuiEnter();
989 }
990
991 void wxThreadInternal::Pause()
992 {
993 // the state is set from the thread which pauses us first, this function
994 // is called later so the state should have been already set
995 wxCHECK_RET( m_state == STATE_PAUSED,
996 wxT("thread must first be paused with wxThread::Pause().") );
997
998 wxLogTrace(TRACE_THREADS,
999 _T("Thread %ld goes to sleep."), THR_ID(this));
1000
1001 // wait until the semaphore is Post()ed from Resume()
1002 m_semSuspend.Wait();
1003 }
1004
1005 void wxThreadInternal::Resume()
1006 {
1007 wxCHECK_RET( m_state == STATE_PAUSED,
1008 wxT("can't resume thread which is not suspended.") );
1009
1010 // the thread might be not actually paused yet - if there were no call to
1011 // TestDestroy() since the last call to Pause() for example
1012 if ( IsReallyPaused() )
1013 {
1014 wxLogTrace(TRACE_THREADS,
1015 _T("Waking up thread %ld"), THR_ID(this));
1016
1017 // wake up Pause()
1018 m_semSuspend.Post();
1019
1020 // reset the flag
1021 SetReallyPaused(false);
1022 }
1023 else
1024 {
1025 wxLogTrace(TRACE_THREADS,
1026 _T("Thread %ld is not yet really paused"), THR_ID(this));
1027 }
1028
1029 SetState(STATE_RUNNING);
1030 }
1031
1032 // -----------------------------------------------------------------------------
1033 // wxThread static functions
1034 // -----------------------------------------------------------------------------
1035
1036 wxThread *wxThread::This()
1037 {
1038 return (wxThread *)pthread_getspecific(gs_keySelf);
1039 }
1040
1041 bool wxThread::IsMain()
1042 {
1043 return (bool)pthread_equal(pthread_self(), gs_tidMain) || gs_tidMain == (pthread_t)-1;
1044 }
1045
1046 void wxThread::Yield()
1047 {
1048 #ifdef HAVE_SCHED_YIELD
1049 sched_yield();
1050 #endif
1051 }
1052
1053 void wxThread::Sleep(unsigned long milliseconds)
1054 {
1055 wxMilliSleep(milliseconds);
1056 }
1057
1058 int wxThread::GetCPUCount()
1059 {
1060 #if defined(_SC_NPROCESSORS_ONLN)
1061 // this works for Solaris and Linux 2.6
1062 int rc = sysconf(_SC_NPROCESSORS_ONLN);
1063 if ( rc != -1 )
1064 {
1065 return rc;
1066 }
1067 #elif defined(__LINUX__) && wxUSE_FFILE
1068 // read from proc (can't use wxTextFile here because it's a special file:
1069 // it has 0 size but still can be read from)
1070 wxLogNull nolog;
1071
1072 wxFFile file(_T("/proc/cpuinfo"));
1073 if ( file.IsOpened() )
1074 {
1075 // slurp the whole file
1076 wxString s;
1077 if ( file.ReadAll(&s) )
1078 {
1079 // (ab)use Replace() to find the number of "processor: num" strings
1080 size_t count = s.Replace(_T("processor\t:"), _T(""));
1081 if ( count > 0 )
1082 {
1083 return count;
1084 }
1085
1086 wxLogDebug(_T("failed to parse /proc/cpuinfo"));
1087 }
1088 else
1089 {
1090 wxLogDebug(_T("failed to read /proc/cpuinfo"));
1091 }
1092 }
1093 #endif // different ways to get number of CPUs
1094
1095 // unknown
1096 return -1;
1097 }
1098
1099 // VMS is a 64 bit system and threads have 64 bit pointers.
1100 // FIXME: also needed for other systems????
1101 #ifdef __VMS
1102 unsigned long long wxThread::GetCurrentId()
1103 {
1104 return (unsigned long long)pthread_self();
1105 }
1106
1107 #else // !__VMS
1108
1109 unsigned long wxThread::GetCurrentId()
1110 {
1111 return (unsigned long)pthread_self();
1112 }
1113
1114 #endif // __VMS/!__VMS
1115
1116
1117 bool wxThread::SetConcurrency(size_t level)
1118 {
1119 #ifdef HAVE_THR_SETCONCURRENCY
1120 int rc = thr_setconcurrency(level);
1121 if ( rc != 0 )
1122 {
1123 wxLogSysError(rc, _T("thr_setconcurrency() failed"));
1124 }
1125
1126 return rc == 0;
1127 #else // !HAVE_THR_SETCONCURRENCY
1128 // ok only for the default value
1129 return level == 0;
1130 #endif // HAVE_THR_SETCONCURRENCY/!HAVE_THR_SETCONCURRENCY
1131 }
1132
1133 // -----------------------------------------------------------------------------
1134 // creating thread
1135 // -----------------------------------------------------------------------------
1136
1137 wxThread::wxThread(wxThreadKind kind)
1138 {
1139 // add this thread to the global list of all threads
1140 {
1141 wxMutexLocker lock(*gs_mutexAllThreads);
1142
1143 gs_allThreads.Add(this);
1144 }
1145
1146 m_internal = new wxThreadInternal();
1147
1148 m_isDetached = kind == wxTHREAD_DETACHED;
1149 }
1150
1151 #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
1152 #define WXUNUSED_STACKSIZE(identifier) identifier
1153 #else
1154 #define WXUNUSED_STACKSIZE(identifier) WXUNUSED(identifier)
1155 #endif
1156
1157 wxThreadError wxThread::Create(unsigned int WXUNUSED_STACKSIZE(stackSize))
1158 {
1159 if ( m_internal->GetState() != STATE_NEW )
1160 {
1161 // don't recreate thread
1162 return wxTHREAD_RUNNING;
1163 }
1164
1165 // set up the thread attribute: right now, we only set thread priority
1166 pthread_attr_t attr;
1167 pthread_attr_init(&attr);
1168
1169 #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
1170 if (stackSize)
1171 pthread_attr_setstacksize(&attr, stackSize);
1172 #endif
1173
1174 #ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
1175 int policy;
1176 if ( pthread_attr_getschedpolicy(&attr, &policy) != 0 )
1177 {
1178 wxLogError(_("Cannot retrieve thread scheduling policy."));
1179 }
1180
1181 #ifdef __VMS__
1182 /* the pthread.h contains too many spaces. This is a work-around */
1183 # undef sched_get_priority_max
1184 #undef sched_get_priority_min
1185 #define sched_get_priority_max(_pol_) \
1186 (_pol_ == SCHED_OTHER ? PRI_FG_MAX_NP : PRI_FIFO_MAX)
1187 #define sched_get_priority_min(_pol_) \
1188 (_pol_ == SCHED_OTHER ? PRI_FG_MIN_NP : PRI_FIFO_MIN)
1189 #endif
1190
1191 int max_prio = sched_get_priority_max(policy),
1192 min_prio = sched_get_priority_min(policy),
1193 prio = m_internal->GetPriority();
1194
1195 if ( min_prio == -1 || max_prio == -1 )
1196 {
1197 wxLogError(_("Cannot get priority range for scheduling policy %d."),
1198 policy);
1199 }
1200 else if ( max_prio == min_prio )
1201 {
1202 if ( prio != WXTHREAD_DEFAULT_PRIORITY )
1203 {
1204 // notify the programmer that this doesn't work here
1205 wxLogWarning(_("Thread priority setting is ignored."));
1206 }
1207 //else: we have default priority, so don't complain
1208
1209 // anyhow, don't do anything because priority is just ignored
1210 }
1211 else
1212 {
1213 struct sched_param sp;
1214 if ( pthread_attr_getschedparam(&attr, &sp) != 0 )
1215 {
1216 wxFAIL_MSG(_T("pthread_attr_getschedparam() failed"));
1217 }
1218
1219 sp.sched_priority = min_prio + (prio*(max_prio - min_prio))/100;
1220
1221 if ( pthread_attr_setschedparam(&attr, &sp) != 0 )
1222 {
1223 wxFAIL_MSG(_T("pthread_attr_setschedparam(priority) failed"));
1224 }
1225 }
1226 #endif // HAVE_THREAD_PRIORITY_FUNCTIONS
1227
1228 #ifdef HAVE_PTHREAD_ATTR_SETSCOPE
1229 // this will make the threads created by this process really concurrent
1230 if ( pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM) != 0 )
1231 {
1232 wxFAIL_MSG(_T("pthread_attr_setscope(PTHREAD_SCOPE_SYSTEM) failed"));
1233 }
1234 #endif // HAVE_PTHREAD_ATTR_SETSCOPE
1235
1236 // VZ: assume that this one is always available (it's rather fundamental),
1237 // if this function is ever missing we should try to use
1238 // pthread_detach() instead (after thread creation)
1239 if ( m_isDetached )
1240 {
1241 if ( pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED) != 0 )
1242 {
1243 wxFAIL_MSG(_T("pthread_attr_setdetachstate(DETACHED) failed"));
1244 }
1245
1246 // never try to join detached threads
1247 m_internal->Detach();
1248 }
1249 //else: threads are created joinable by default, it's ok
1250
1251 // create the new OS thread object
1252 int rc = pthread_create
1253 (
1254 m_internal->GetIdPtr(),
1255 &attr,
1256 wxPthreadStart,
1257 (void *)this
1258 );
1259
1260 if ( pthread_attr_destroy(&attr) != 0 )
1261 {
1262 wxFAIL_MSG(_T("pthread_attr_destroy() failed"));
1263 }
1264
1265 if ( rc != 0 )
1266 {
1267 m_internal->SetState(STATE_EXITED);
1268
1269 return wxTHREAD_NO_RESOURCE;
1270 }
1271
1272 return wxTHREAD_NO_ERROR;
1273 }
1274
1275 wxThreadError wxThread::Run()
1276 {
1277 wxCriticalSectionLocker lock(m_critsect);
1278
1279 wxCHECK_MSG( m_internal->GetId(), wxTHREAD_MISC_ERROR,
1280 wxT("must call wxThread::Create() first") );
1281
1282 return m_internal->Run();
1283 }
1284
1285 // -----------------------------------------------------------------------------
1286 // misc accessors
1287 // -----------------------------------------------------------------------------
1288
1289 void wxThread::SetPriority(unsigned int prio)
1290 {
1291 wxCHECK_RET( ((int)WXTHREAD_MIN_PRIORITY <= (int)prio) &&
1292 ((int)prio <= (int)WXTHREAD_MAX_PRIORITY),
1293 wxT("invalid thread priority") );
1294
1295 wxCriticalSectionLocker lock(m_critsect);
1296
1297 switch ( m_internal->GetState() )
1298 {
1299 case STATE_NEW:
1300 // thread not yet started, priority will be set when it is
1301 m_internal->SetPriority(prio);
1302 break;
1303
1304 case STATE_RUNNING:
1305 case STATE_PAUSED:
1306 #ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
1307 #if defined(__LINUX__)
1308 // On Linux, pthread_setschedparam with SCHED_OTHER does not allow
1309 // a priority other than 0. Instead, we use the BSD setpriority
1310 // which alllows us to set a 'nice' value between 20 to -20. Only
1311 // super user can set a value less than zero (more negative yields
1312 // higher priority). setpriority set the static priority of a
1313 // process, but this is OK since Linux is configured as a thread
1314 // per process.
1315 //
1316 // FIXME this is not true for 2.6!!
1317
1318 // map wx priorites WXTHREAD_MIN_PRIORITY..WXTHREAD_MAX_PRIORITY
1319 // to Unix priorities 20..-20
1320 if ( setpriority(PRIO_PROCESS, 0, -(2*(int)prio)/5 + 20) == -1 )
1321 {
1322 wxLogError(_("Failed to set thread priority %d."), prio);
1323 }
1324 #else // __LINUX__
1325 {
1326 struct sched_param sparam;
1327 sparam.sched_priority = prio;
1328
1329 if ( pthread_setschedparam(m_internal->GetId(),
1330 SCHED_OTHER, &sparam) != 0 )
1331 {
1332 wxLogError(_("Failed to set thread priority %d."), prio);
1333 }
1334 }
1335 #endif // __LINUX__
1336 #endif // HAVE_THREAD_PRIORITY_FUNCTIONS
1337 break;
1338
1339 case STATE_EXITED:
1340 default:
1341 wxFAIL_MSG(wxT("impossible to set thread priority in this state"));
1342 }
1343 }
1344
1345 unsigned int wxThread::GetPriority() const
1346 {
1347 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
1348
1349 return m_internal->GetPriority();
1350 }
1351
1352 wxThreadIdType wxThread::GetId() const
1353 {
1354 return (wxThreadIdType) m_internal->GetId();
1355 }
1356
1357 // -----------------------------------------------------------------------------
1358 // pause/resume
1359 // -----------------------------------------------------------------------------
1360
1361 wxThreadError wxThread::Pause()
1362 {
1363 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
1364 _T("a thread can't pause itself") );
1365
1366 wxCriticalSectionLocker lock(m_critsect);
1367
1368 if ( m_internal->GetState() != STATE_RUNNING )
1369 {
1370 wxLogDebug(wxT("Can't pause thread which is not running."));
1371
1372 return wxTHREAD_NOT_RUNNING;
1373 }
1374
1375 // just set a flag, the thread will be really paused only during the next
1376 // call to TestDestroy()
1377 m_internal->SetState(STATE_PAUSED);
1378
1379 return wxTHREAD_NO_ERROR;
1380 }
1381
1382 wxThreadError wxThread::Resume()
1383 {
1384 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
1385 _T("a thread can't resume itself") );
1386
1387 wxCriticalSectionLocker lock(m_critsect);
1388
1389 wxThreadState state = m_internal->GetState();
1390
1391 switch ( state )
1392 {
1393 case STATE_PAUSED:
1394 wxLogTrace(TRACE_THREADS, _T("Thread %ld suspended, resuming."),
1395 GetId());
1396
1397 m_internal->Resume();
1398
1399 return wxTHREAD_NO_ERROR;
1400
1401 case STATE_EXITED:
1402 wxLogTrace(TRACE_THREADS, _T("Thread %ld exited, won't resume."),
1403 GetId());
1404 return wxTHREAD_NO_ERROR;
1405
1406 default:
1407 wxLogDebug(_T("Attempt to resume a thread which is not paused."));
1408
1409 return wxTHREAD_MISC_ERROR;
1410 }
1411 }
1412
1413 // -----------------------------------------------------------------------------
1414 // exiting thread
1415 // -----------------------------------------------------------------------------
1416
1417 wxThread::ExitCode wxThread::Wait()
1418 {
1419 wxCHECK_MSG( This() != this, (ExitCode)-1,
1420 _T("a thread can't wait for itself") );
1421
1422 wxCHECK_MSG( !m_isDetached, (ExitCode)-1,
1423 _T("can't wait for detached thread") );
1424
1425 m_internal->Wait();
1426
1427 return m_internal->GetExitCode();
1428 }
1429
1430 wxThreadError wxThread::Delete(ExitCode *rc)
1431 {
1432 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
1433 _T("a thread can't delete itself") );
1434
1435 bool isDetached = m_isDetached;
1436
1437 m_critsect.Enter();
1438 wxThreadState state = m_internal->GetState();
1439
1440 // ask the thread to stop
1441 m_internal->SetCancelFlag();
1442
1443 m_critsect.Leave();
1444
1445 switch ( state )
1446 {
1447 case STATE_NEW:
1448 // we need to wake up the thread so that PthreadStart() will
1449 // terminate - right now it's blocking on run semaphore in
1450 // PthreadStart()
1451 m_internal->SignalRun();
1452
1453 // fall through
1454
1455 case STATE_EXITED:
1456 // nothing to do
1457 break;
1458
1459 case STATE_PAUSED:
1460 // resume the thread first
1461 m_internal->Resume();
1462
1463 // fall through
1464
1465 default:
1466 if ( !isDetached )
1467 {
1468 // wait until the thread stops
1469 m_internal->Wait();
1470
1471 if ( rc )
1472 {
1473 // return the exit code of the thread
1474 *rc = m_internal->GetExitCode();
1475 }
1476 }
1477 //else: can't wait for detached threads
1478 }
1479
1480 return wxTHREAD_NO_ERROR;
1481 }
1482
1483 wxThreadError wxThread::Kill()
1484 {
1485 wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
1486 _T("a thread can't kill itself") );
1487
1488 switch ( m_internal->GetState() )
1489 {
1490 case STATE_NEW:
1491 case STATE_EXITED:
1492 return wxTHREAD_NOT_RUNNING;
1493
1494 case STATE_PAUSED:
1495 // resume the thread first
1496 Resume();
1497
1498 // fall through
1499
1500 default:
1501 #ifdef HAVE_PTHREAD_CANCEL
1502 if ( pthread_cancel(m_internal->GetId()) != 0 )
1503 #endif // HAVE_PTHREAD_CANCEL
1504 {
1505 wxLogError(_("Failed to terminate a thread."));
1506
1507 return wxTHREAD_MISC_ERROR;
1508 }
1509
1510 #ifdef HAVE_PTHREAD_CANCEL
1511 if ( m_isDetached )
1512 {
1513 // if we use cleanup function, this will be done from
1514 // wxPthreadCleanup()
1515 #ifndef wxHAVE_PTHREAD_CLEANUP
1516 ScheduleThreadForDeletion();
1517
1518 // don't call OnExit() here, it can only be called in the
1519 // threads context and we're in the context of another thread
1520
1521 DeleteThread(this);
1522 #endif // wxHAVE_PTHREAD_CLEANUP
1523 }
1524 else
1525 {
1526 m_internal->SetExitCode(EXITCODE_CANCELLED);
1527 }
1528
1529 return wxTHREAD_NO_ERROR;
1530 #endif // HAVE_PTHREAD_CANCEL
1531 }
1532 }
1533
1534 void wxThread::Exit(ExitCode status)
1535 {
1536 wxASSERT_MSG( This() == this,
1537 _T("wxThread::Exit() can only be called in the context of the same thread") );
1538
1539 if ( m_isDetached )
1540 {
1541 // from the moment we call OnExit(), the main program may terminate at
1542 // any moment, so mark this thread as being already in process of being
1543 // deleted or wxThreadModule::OnExit() will try to delete it again
1544 ScheduleThreadForDeletion();
1545 }
1546
1547 // don't enter m_critsect before calling OnExit() because the user code
1548 // might deadlock if, for example, it signals a condition in OnExit() (a
1549 // common case) while the main thread calls any of functions entering
1550 // m_critsect on us (almost all of them do)
1551 wxTRY
1552 {
1553 OnExit();
1554 }
1555 wxCATCH_ALL( wxTheApp->OnUnhandledException(); )
1556
1557 // delete C++ thread object if this is a detached thread - user is
1558 // responsible for doing this for joinable ones
1559 if ( m_isDetached )
1560 {
1561 // FIXME I'm feeling bad about it - what if another thread function is
1562 // called (in another thread context) now? It will try to access
1563 // half destroyed object which will probably result in something
1564 // very bad - but we can't protect this by a crit section unless
1565 // we make it a global object, but this would mean that we can
1566 // only call one thread function at a time :-(
1567 DeleteThread(this);
1568 pthread_setspecific(gs_keySelf, 0);
1569 }
1570 else
1571 {
1572 m_critsect.Enter();
1573 m_internal->SetState(STATE_EXITED);
1574 m_critsect.Leave();
1575 }
1576
1577 // terminate the thread (pthread_exit() never returns)
1578 pthread_exit(status);
1579
1580 wxFAIL_MSG(_T("pthread_exit() failed"));
1581 }
1582
1583 // also test whether we were paused
1584 bool wxThread::TestDestroy()
1585 {
1586 wxASSERT_MSG( This() == this,
1587 _T("wxThread::TestDestroy() can only be called in the context of the same thread") );
1588
1589 m_critsect.Enter();
1590
1591 if ( m_internal->GetState() == STATE_PAUSED )
1592 {
1593 m_internal->SetReallyPaused(true);
1594
1595 // leave the crit section or the other threads will stop too if they
1596 // try to call any of (seemingly harmless) IsXXX() functions while we
1597 // sleep
1598 m_critsect.Leave();
1599
1600 m_internal->Pause();
1601 }
1602 else
1603 {
1604 // thread wasn't requested to pause, nothing to do
1605 m_critsect.Leave();
1606 }
1607
1608 return m_internal->WasCancelled();
1609 }
1610
1611 wxThread::~wxThread()
1612 {
1613 #ifdef __WXDEBUG__
1614 m_critsect.Enter();
1615
1616 // check that the thread either exited or couldn't be created
1617 if ( m_internal->GetState() != STATE_EXITED &&
1618 m_internal->GetState() != STATE_NEW )
1619 {
1620 wxLogDebug(_T("The thread %ld is being destroyed although it is still running! The application may crash."),
1621 (long)GetId());
1622 }
1623
1624 m_critsect.Leave();
1625 #endif // __WXDEBUG__
1626
1627 delete m_internal;
1628
1629 // remove this thread from the global array
1630 {
1631 wxMutexLocker lock(*gs_mutexAllThreads);
1632
1633 gs_allThreads.Remove(this);
1634 }
1635 }
1636
1637 // -----------------------------------------------------------------------------
1638 // state tests
1639 // -----------------------------------------------------------------------------
1640
1641 bool wxThread::IsRunning() const
1642 {
1643 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
1644
1645 return m_internal->GetState() == STATE_RUNNING;
1646 }
1647
1648 bool wxThread::IsAlive() const
1649 {
1650 wxCriticalSectionLocker lock((wxCriticalSection&)m_critsect);
1651
1652 switch ( m_internal->GetState() )
1653 {
1654 case STATE_RUNNING:
1655 case STATE_PAUSED:
1656 return true;
1657
1658 default:
1659 return false;
1660 }
1661 }
1662
1663 bool wxThread::IsPaused() const
1664 {
1665 wxCriticalSectionLocker lock((wxCriticalSection&)m_critsect);
1666
1667 return (m_internal->GetState() == STATE_PAUSED);
1668 }
1669
1670 //--------------------------------------------------------------------
1671 // wxThreadModule
1672 //--------------------------------------------------------------------
1673
1674 class wxThreadModule : public wxModule
1675 {
1676 public:
1677 virtual bool OnInit();
1678 virtual void OnExit();
1679
1680 private:
1681 DECLARE_DYNAMIC_CLASS(wxThreadModule)
1682 };
1683
1684 IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule)
1685
1686 bool wxThreadModule::OnInit()
1687 {
1688 int rc = pthread_key_create(&gs_keySelf, NULL /* dtor function */);
1689 if ( rc != 0 )
1690 {
1691 wxLogSysError(rc, _("Thread module initialization failed: failed to create thread key"));
1692
1693 return false;
1694 }
1695
1696 gs_tidMain = pthread_self();
1697
1698 gs_mutexAllThreads = new wxMutex();
1699
1700 gs_mutexGui = new wxMutex();
1701 gs_mutexGui->Lock();
1702
1703 gs_mutexDeleteThread = new wxMutex();
1704 gs_condAllDeleted = new wxCondition(*gs_mutexDeleteThread);
1705
1706 return true;
1707 }
1708
1709 void wxThreadModule::OnExit()
1710 {
1711 wxASSERT_MSG( wxThread::IsMain(), wxT("only main thread can be here") );
1712
1713 // are there any threads left which are being deleted right now?
1714 size_t nThreadsBeingDeleted;
1715
1716 {
1717 wxMutexLocker lock( *gs_mutexDeleteThread );
1718 nThreadsBeingDeleted = gs_nThreadsBeingDeleted;
1719
1720 if ( nThreadsBeingDeleted > 0 )
1721 {
1722 wxLogTrace(TRACE_THREADS,
1723 _T("Waiting for %lu threads to disappear"),
1724 (unsigned long)nThreadsBeingDeleted);
1725
1726 // have to wait until all of them disappear
1727 gs_condAllDeleted->Wait();
1728 }
1729 }
1730
1731 size_t count;
1732
1733 {
1734 wxMutexLocker lock(*gs_mutexAllThreads);
1735
1736 // terminate any threads left
1737 count = gs_allThreads.GetCount();
1738 if ( count != 0u )
1739 {
1740 wxLogDebug(wxT("%lu threads were not terminated by the application."),
1741 (unsigned long)count);
1742 }
1743 } // unlock mutex before deleting the threads as they lock it in their dtor
1744
1745 for ( size_t n = 0u; n < count; n++ )
1746 {
1747 // Delete calls the destructor which removes the current entry. We
1748 // should only delete the first one each time.
1749 gs_allThreads[0]->Delete();
1750 }
1751
1752 delete gs_mutexAllThreads;
1753
1754 // destroy GUI mutex
1755 gs_mutexGui->Unlock();
1756 delete gs_mutexGui;
1757
1758 // and free TLD slot
1759 (void)pthread_key_delete(gs_keySelf);
1760
1761 delete gs_condAllDeleted;
1762 delete gs_mutexDeleteThread;
1763 }
1764
1765 // ----------------------------------------------------------------------------
1766 // global functions
1767 // ----------------------------------------------------------------------------
1768
1769 static void ScheduleThreadForDeletion()
1770 {
1771 wxMutexLocker lock( *gs_mutexDeleteThread );
1772
1773 gs_nThreadsBeingDeleted++;
1774
1775 wxLogTrace(TRACE_THREADS, _T("%lu thread%s waiting to be deleted"),
1776 (unsigned long)gs_nThreadsBeingDeleted,
1777 gs_nThreadsBeingDeleted == 1 ? _T("") : _T("s"));
1778 }
1779
1780 static void DeleteThread(wxThread *This)
1781 {
1782 // gs_mutexDeleteThread should be unlocked before signalling the condition
1783 // or wxThreadModule::OnExit() would deadlock
1784 wxMutexLocker locker( *gs_mutexDeleteThread );
1785
1786 wxLogTrace(TRACE_THREADS, _T("Thread %ld auto deletes."), This->GetId());
1787
1788 delete This;
1789
1790 wxCHECK_RET( gs_nThreadsBeingDeleted > 0,
1791 _T("no threads scheduled for deletion, yet we delete one?") );
1792
1793 wxLogTrace(TRACE_THREADS, _T("%lu scheduled for deletion threads left."),
1794 (unsigned long)gs_nThreadsBeingDeleted - 1);
1795
1796 if ( !--gs_nThreadsBeingDeleted )
1797 {
1798 // no more threads left, signal it
1799 gs_condAllDeleted->Signal();
1800 }
1801 }
1802
1803 void wxMutexGuiEnterImpl()
1804 {
1805 gs_mutexGui->Lock();
1806 }
1807
1808 void wxMutexGuiLeaveImpl()
1809 {
1810 gs_mutexGui->Unlock();
1811 }
1812
1813 // ----------------------------------------------------------------------------
1814 // include common implementation code
1815 // ----------------------------------------------------------------------------
1816
1817 #include "wx/thrimpl.cpp"
1818
1819 #endif // wxUSE_THREADS