]> git.saurik.com Git - wxWidgets.git/blob - src/msw/thread.cpp
adding support for wxCB_SORT
[wxWidgets.git] / src / msw / thread.cpp
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 :-)
6 // Created: 04/22/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Wolfram Gloger (1996, 1997), Guilhem Lavaux (1998);
9 // Vadim Zeitlin (1999-2002)
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
14 #pragma implementation "thread.h"
15 #endif
16
17 // ----------------------------------------------------------------------------
18 // headers
19 // ----------------------------------------------------------------------------
20
21 // For compilers that support precompilation, includes "wx.h".
22 #include "wx/wxprec.h"
23
24 #if defined(__BORLANDC__)
25 #pragma hdrstop
26 #endif
27
28 #ifndef WX_PRECOMP
29 #include "wx/intl.h"
30 #include "wx/app.h"
31 #endif
32
33 #if wxUSE_THREADS
34
35 #include "wx/apptrait.h"
36
37 #include "wx/msw/private.h"
38 #include "wx/msw/missing.h"
39
40 #include "wx/module.h"
41 #include "wx/thread.h"
42
43 // must have this symbol defined to get _beginthread/_endthread declarations
44 #ifndef _MT
45 #define _MT
46 #endif
47
48 #if defined(__BORLANDC__)
49 #if !defined(__MT__)
50 // I can't set -tWM in the IDE (anyone?) so have to do this
51 #define __MT__
52 #endif
53
54 #if !defined(__MFC_COMPAT__)
55 // Needed to know about _beginthreadex etc..
56 #define __MFC_COMPAT__
57 #endif
58 #endif // BC++
59
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__)
66
67 #ifndef __WXWINCE__
68 #undef wxUSE_BEGIN_THREAD
69 #define wxUSE_BEGIN_THREAD
70 #endif
71
72 #endif
73
74 #ifdef wxUSE_BEGIN_THREAD
75 // this is where _beginthreadex() is declared
76 #include <process.h>
77
78 // the return type of the thread function entry point
79 typedef unsigned THREAD_RETVAL;
80
81 // the calling convention of the thread function entry point
82 #define THREAD_CALLCONV __stdcall
83 #else
84 // the settings for CreateThread()
85 typedef DWORD THREAD_RETVAL;
86 #define THREAD_CALLCONV WINAPI
87 #endif
88
89 // ----------------------------------------------------------------------------
90 // constants
91 // ----------------------------------------------------------------------------
92
93 // the possible states of the thread ("=>" shows all possible transitions from
94 // this state)
95 enum wxThreadState
96 {
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
102 };
103
104 // ----------------------------------------------------------------------------
105 // this module globals
106 // ----------------------------------------------------------------------------
107
108 // TLS index of the slot where we store the pointer to the current thread
109 static DWORD gs_tlsThisThread = 0xFFFFFFFF;
110
111 // id of the main thread - the one which can call GUI functions without first
112 // calling wxMutexGuiEnter()
113 static DWORD gs_idMainThread = 0;
114
115 // if it's false, some secondary thread is holding the GUI lock
116 static bool gs_bGuiOwnedByMainThread = true;
117
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
120 // any GUI calls
121 static wxCriticalSection *gs_critsectGui = NULL;
122
123 // critical section which protects gs_nWaitingForGui variable
124 static wxCriticalSection *gs_critsectWaitingForGui = NULL;
125
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;
130
131 // number of threads waiting for GUI in wxMutexGuiEnter()
132 static size_t gs_nWaitingForGui = 0;
133
134 // are we waiting for a thread termination?
135 static bool gs_waitingForThread = false;
136
137 // ============================================================================
138 // Windows implementation of thread and related classes
139 // ============================================================================
140
141 // ----------------------------------------------------------------------------
142 // wxCriticalSection
143 // ----------------------------------------------------------------------------
144
145 wxCriticalSection::wxCriticalSection()
146 {
147 wxCOMPILE_TIME_ASSERT( sizeof(CRITICAL_SECTION) <= sizeof(wxCritSectBuffer),
148 wxCriticalSectionBufferTooSmall );
149
150 ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer);
151 }
152
153 wxCriticalSection::~wxCriticalSection()
154 {
155 ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer);
156 }
157
158 void wxCriticalSection::Enter()
159 {
160 ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer);
161 }
162
163 void wxCriticalSection::Leave()
164 {
165 ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer);
166 }
167
168 // ----------------------------------------------------------------------------
169 // wxMutex
170 // ----------------------------------------------------------------------------
171
172 class wxMutexInternal
173 {
174 public:
175 wxMutexInternal(wxMutexType mutexType);
176 ~wxMutexInternal();
177
178 bool IsOk() const { return m_mutex != NULL; }
179
180 wxMutexError Lock() { return LockTimeout(INFINITE); }
181 wxMutexError TryLock() { return LockTimeout(0); }
182 wxMutexError Unlock();
183
184 private:
185 wxMutexError LockTimeout(DWORD milliseconds);
186
187 HANDLE m_mutex;
188
189 DECLARE_NO_COPY_CLASS(wxMutexInternal)
190 };
191
192 // all mutexes are recursive under Win32 so we don't use mutexType
193 wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(mutexType))
194 {
195 // create a nameless (hence intra process and always private) mutex
196 m_mutex = ::CreateMutex
197 (
198 NULL, // default secutiry attributes
199 false, // not initially locked
200 NULL // no name
201 );
202
203 if ( !m_mutex )
204 {
205 wxLogLastError(_T("CreateMutex()"));
206 }
207 }
208
209 wxMutexInternal::~wxMutexInternal()
210 {
211 if ( m_mutex )
212 {
213 if ( !::CloseHandle(m_mutex) )
214 {
215 wxLogLastError(_T("CloseHandle(mutex)"));
216 }
217 }
218 }
219
220 wxMutexError wxMutexInternal::LockTimeout(DWORD milliseconds)
221 {
222 DWORD rc = ::WaitForSingleObject(m_mutex, milliseconds);
223 if ( rc == WAIT_ABANDONED )
224 {
225 // the previous caller died without releasing the mutex, but now we can
226 // really lock it
227 wxLogDebug(_T("WaitForSingleObject() returned WAIT_ABANDONED"));
228
229 // use 0 timeout, normally we should always get it
230 rc = ::WaitForSingleObject(m_mutex, 0);
231 }
232
233 switch ( rc )
234 {
235 case WAIT_OBJECT_0:
236 // ok
237 break;
238
239 case WAIT_TIMEOUT:
240 return wxMUTEX_BUSY;
241
242 case WAIT_ABANDONED: // checked for above
243 default:
244 wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock"));
245 // fall through
246
247 case WAIT_FAILED:
248 wxLogLastError(_T("WaitForSingleObject(mutex)"));
249 return wxMUTEX_MISC_ERROR;
250 }
251
252 return wxMUTEX_NO_ERROR;
253 }
254
255 wxMutexError wxMutexInternal::Unlock()
256 {
257 if ( !::ReleaseMutex(m_mutex) )
258 {
259 wxLogLastError(_T("ReleaseMutex()"));
260
261 return wxMUTEX_MISC_ERROR;
262 }
263
264 return wxMUTEX_NO_ERROR;
265 }
266
267 // --------------------------------------------------------------------------
268 // wxSemaphore
269 // --------------------------------------------------------------------------
270
271 // a trivial wrapper around Win32 semaphore
272 class wxSemaphoreInternal
273 {
274 public:
275 wxSemaphoreInternal(int initialcount, int maxcount);
276 ~wxSemaphoreInternal();
277
278 bool IsOk() const { return m_semaphore != NULL; }
279
280 wxSemaError Wait() { return WaitTimeout(INFINITE); }
281
282 wxSemaError TryWait()
283 {
284 wxSemaError rc = WaitTimeout(0);
285 if ( rc == wxSEMA_TIMEOUT )
286 rc = wxSEMA_BUSY;
287
288 return rc;
289 }
290
291 wxSemaError WaitTimeout(unsigned long milliseconds);
292
293 wxSemaError Post();
294
295 private:
296 HANDLE m_semaphore;
297
298 DECLARE_NO_COPY_CLASS(wxSemaphoreInternal)
299 };
300
301 wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount)
302 {
303 #if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300)
304 if ( maxcount == 0 )
305 {
306 // make it practically infinite
307 maxcount = INT_MAX;
308 }
309
310 m_semaphore = ::CreateSemaphore
311 (
312 NULL, // default security attributes
313 initialcount,
314 maxcount,
315 NULL // no name
316 );
317 #endif
318 if ( !m_semaphore )
319 {
320 wxLogLastError(_T("CreateSemaphore()"));
321 }
322 }
323
324 wxSemaphoreInternal::~wxSemaphoreInternal()
325 {
326 if ( m_semaphore )
327 {
328 if ( !::CloseHandle(m_semaphore) )
329 {
330 wxLogLastError(_T("CloseHandle(semaphore)"));
331 }
332 }
333 }
334
335 wxSemaError wxSemaphoreInternal::WaitTimeout(unsigned long milliseconds)
336 {
337 DWORD rc = ::WaitForSingleObject( m_semaphore, milliseconds );
338
339 switch ( rc )
340 {
341 case WAIT_OBJECT_0:
342 return wxSEMA_NO_ERROR;
343
344 case WAIT_TIMEOUT:
345 return wxSEMA_TIMEOUT;
346
347 default:
348 wxLogLastError(_T("WaitForSingleObject(semaphore)"));
349 }
350
351 return wxSEMA_MISC_ERROR;
352 }
353
354 wxSemaError wxSemaphoreInternal::Post()
355 {
356 #if !defined(_WIN32_WCE) || (_WIN32_WCE >= 300)
357 if ( !::ReleaseSemaphore(m_semaphore, 1, NULL /* ptr to previous count */) )
358 #endif
359 {
360 wxLogLastError(_T("ReleaseSemaphore"));
361
362 return wxSEMA_MISC_ERROR;
363 }
364
365 return wxSEMA_NO_ERROR;
366 }
367
368 // ----------------------------------------------------------------------------
369 // wxThread implementation
370 // ----------------------------------------------------------------------------
371
372 // wxThreadInternal class
373 // ----------------------
374
375 class wxThreadInternal
376 {
377 public:
378 wxThreadInternal(wxThread *thread)
379 {
380 m_thread = thread;
381 m_hThread = 0;
382 m_state = STATE_NEW;
383 m_priority = WXTHREAD_DEFAULT_PRIORITY;
384 m_nRef = 1;
385 }
386
387 ~wxThreadInternal()
388 {
389 Free();
390 }
391
392 void Free()
393 {
394 if ( m_hThread )
395 {
396 if ( !::CloseHandle(m_hThread) )
397 {
398 wxLogLastError(wxT("CloseHandle(thread)"));
399 }
400
401 m_hThread = 0;
402 }
403 }
404
405 // create a new (suspended) thread (for the given thread object)
406 bool Create(wxThread *thread, unsigned int stackSize);
407
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);
413
414 // kill the thread unconditionally
415 wxThreadError Kill();
416
417 // suspend/resume/terminate
418 bool Suspend();
419 bool Resume();
420 void Cancel() { m_state = STATE_CANCELED; }
421
422 // thread state
423 void SetState(wxThreadState state) { m_state = state; }
424 wxThreadState GetState() const { return m_state; }
425
426 // thread priority
427 void SetPriority(unsigned int priority);
428 unsigned int GetPriority() const { return m_priority; }
429
430 // thread handle and id
431 HANDLE GetHandle() const { return m_hThread; }
432 DWORD GetId() const { return m_tid; }
433
434 // thread function
435 static THREAD_RETVAL THREAD_CALLCONV WinThreadStart(void *thread);
436
437 void KeepAlive()
438 {
439 if ( m_thread->IsDetached() )
440 ::InterlockedIncrement(&m_nRef);
441 }
442
443 void LetDie()
444 {
445 if ( m_thread->IsDetached() && !::InterlockedDecrement(&m_nRef) )
446 delete m_thread;
447 }
448
449 private:
450 // the thread we're associated with
451 wxThread *m_thread;
452
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
457
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
460 LONG m_nRef;
461
462 DECLARE_NO_COPY_CLASS(wxThreadInternal)
463 };
464
465 // small class which keeps a thread alive during its lifetime
466 class wxThreadKeepAlive
467 {
468 public:
469 wxThreadKeepAlive(wxThreadInternal& thrImpl) : m_thrImpl(thrImpl)
470 { m_thrImpl.KeepAlive(); }
471 ~wxThreadKeepAlive()
472 { m_thrImpl.LetDie(); }
473
474 private:
475 wxThreadInternal& m_thrImpl;
476 };
477
478
479 THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param)
480 {
481 THREAD_RETVAL rc;
482
483 wxThread * const thread = (wxThread *)param;
484
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;
488
489 if ( hasExited )
490 {
491 rc = (THREAD_RETVAL)-1;
492 }
493 else // do run thread
494 {
495 // store the thread object in the TLS
496 if ( !::TlsSetValue(gs_tlsThisThread, thread) )
497 {
498 wxLogSysError(_("Can not start thread: error writing TLS."));
499
500 return (DWORD)-1;
501 }
502
503 rc = (THREAD_RETVAL)thread->Entry();
504 }
505
506 thread->OnExit();
507
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();
511
512 if ( !hasExited )
513 {
514 // enter m_critsect before changing the thread state
515 wxCriticalSectionLocker lock(thread->m_critsect);
516 thread->m_internal->SetState(STATE_EXITED);
517 }
518
519 // the thread may delete itself now if it wants, we don't need it any more
520 if ( isDetached )
521 thread->m_internal->LetDie();
522
523 return rc;
524 }
525
526 void wxThreadInternal::SetPriority(unsigned int priority)
527 {
528 m_priority = priority;
529
530 // translate wxWidgets priority to the Windows one
531 int win_priority;
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;
542 else
543 {
544 wxFAIL_MSG(wxT("invalid value of thread priority parameter"));
545 win_priority = THREAD_PRIORITY_NORMAL;
546 }
547
548 if ( !::SetThreadPriority(m_hThread, win_priority) )
549 {
550 wxLogSysError(_("Can't set thread priority"));
551 }
552 }
553
554 bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize)
555 {
556 wxASSERT_MSG( m_state == STATE_NEW && !m_hThread,
557 _T("Create()ing thread twice?") );
558
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
563
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)
566 #ifdef __WATCOMC__
567 if ( !stackSize )
568 stackSize = 10240;
569 #endif // __WATCOMC__
570
571 m_hThread = (HANDLE)_beginthreadex
572 (
573 NULL, // default security
574 stackSize,
575 wxThreadInternal::WinThreadStart, // entry point
576 thread,
577 CREATE_SUSPENDED,
578 (unsigned int *)&m_tid
579 );
580 #else // compiler doesn't have _beginthreadex
581 m_hThread = ::CreateThread
582 (
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
589 );
590 #endif // _beginthreadex/CreateThread
591
592 if ( m_hThread == NULL )
593 {
594 wxLogSysError(_("Can't create thread"));
595
596 return false;
597 }
598
599 if ( m_priority != WXTHREAD_DEFAULT_PRIORITY )
600 {
601 SetPriority(m_priority);
602 }
603
604 return true;
605 }
606
607 wxThreadError wxThreadInternal::Kill()
608 {
609 if ( !::TerminateThread(m_hThread, (DWORD)-1) )
610 {
611 wxLogSysError(_("Couldn't terminate thread"));
612
613 return wxTHREAD_MISC_ERROR;
614 }
615
616 Free();
617
618 return wxTHREAD_NO_ERROR;
619 }
620
621 wxThreadError
622 wxThreadInternal::WaitForTerminate(wxCriticalSection& cs,
623 wxThread::ExitCode *pRc,
624 wxThread *threadToDelete)
625 {
626 // prevent the thread C++ object from disappearing as long as we are using
627 // it here
628 wxThreadKeepAlive keepAlive(*this);
629
630
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;
634
635 wxThread::ExitCode rc = 0;
636
637 // we might need to resume the thread if it's currently stopped
638 bool shouldResume = false;
639
640 // as Delete() (which calls us) is always safe to call we need to consider
641 // all possible states
642 {
643 wxCriticalSectionLocker lock(cs);
644
645 if ( m_state == STATE_NEW )
646 {
647 if ( shouldDelete )
648 {
649 // WinThreadStart() will see it and terminate immediately, no
650 // need to cancel the thread -- but we still need to resume it
651 // to let it run
652 m_state = STATE_EXITED;
653
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)
658 shouldResume = true;
659 shouldDelete = false;
660 }
661 //else: shouldResume is correctly set to false here, wait until
662 // someone else runs the thread and it finishes
663 }
664 else // running, paused, cancelled or even exited
665 {
666 shouldResume = m_state == STATE_PAUSED;
667 }
668 }
669
670 // resume the thread if it is paused
671 if ( shouldResume )
672 Resume();
673
674 // ask the thread to terminate
675 if ( shouldDelete )
676 {
677 wxCriticalSectionLocker lock(cs);
678
679 Cancel();
680 }
681
682
683 // now wait for thread to finish
684 if ( wxThread::IsMain() )
685 {
686 // set flag for wxIsWaitingForThread()
687 gs_waitingForThread = true;
688 }
689
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);
696 do
697 {
698 if ( wxThread::IsMain() )
699 {
700 // give the thread we're waiting for chance to do the GUI call
701 // it might be in
702 if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() )
703 {
704 wxMutexGuiLeave();
705 }
706 }
707
708 result = ::MsgWaitForMultipleObjects
709 (
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
715 QS_ALLPOSTMESSAGE
716 );
717
718 switch ( result )
719 {
720 case 0xFFFFFFFF:
721 // error
722 wxLogSysError(_("Can not wait for thread termination"));
723 Kill();
724 return wxTHREAD_KILLED;
725
726 case WAIT_OBJECT_0:
727 // thread we're waiting for terminated
728 break;
729
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
733 // the other ones
734 //
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() )
740 {
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);
746
747 wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits()
748 : NULL;
749
750 if ( traits && !traits->DoMessageFromThreadWait() )
751 {
752 // WM_QUIT received: kill the thread
753 Kill();
754
755 return wxTHREAD_KILLED;
756 }
757 }
758 break;
759
760 default:
761 wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject"));
762 }
763 } while ( result != WAIT_OBJECT_0 );
764
765 if ( wxThread::IsMain() )
766 {
767 gs_waitingForThread = false;
768 }
769
770
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
774 for ( ;; )
775 {
776 if ( !::GetExitCodeThread(m_hThread, (LPDWORD)&rc) )
777 {
778 wxLogLastError(wxT("GetExitCodeThread"));
779
780 rc = (wxThread::ExitCode)-1;
781
782 break;
783 }
784
785 if ( (DWORD)rc != STILL_ACTIVE )
786 break;
787
788 // give the other thread some time to terminate, otherwise we may be
789 // starving it
790 ::Sleep(1);
791 }
792
793 if ( pRc )
794 *pRc = rc;
795
796 // we don't need the thread handle any more in any case
797 Free();
798
799
800 return rc == (wxThread::ExitCode)-1 ? wxTHREAD_MISC_ERROR
801 : wxTHREAD_NO_ERROR;
802 }
803
804 bool wxThreadInternal::Suspend()
805 {
806 DWORD nSuspendCount = ::SuspendThread(m_hThread);
807 if ( nSuspendCount == (DWORD)-1 )
808 {
809 wxLogSysError(_("Can not suspend thread %x"), m_hThread);
810
811 return false;
812 }
813
814 m_state = STATE_PAUSED;
815
816 return true;
817 }
818
819 bool wxThreadInternal::Resume()
820 {
821 DWORD nSuspendCount = ::ResumeThread(m_hThread);
822 if ( nSuspendCount == (DWORD)-1 )
823 {
824 wxLogSysError(_("Can not resume thread %x"), m_hThread);
825
826 return false;
827 }
828
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 )
833 {
834 m_state = STATE_RUNNING;
835 }
836
837 return true;
838 }
839
840 // static functions
841 // ----------------
842
843 wxThread *wxThread::This()
844 {
845 wxThread *thread = (wxThread *)::TlsGetValue(gs_tlsThisThread);
846
847 // be careful, 0 may be a valid return value as well
848 if ( !thread && (::GetLastError() != NO_ERROR) )
849 {
850 wxLogSysError(_("Couldn't get the current thread pointer"));
851
852 // return NULL...
853 }
854
855 return thread;
856 }
857
858 bool wxThread::IsMain()
859 {
860 return ::GetCurrentThreadId() == gs_idMainThread || gs_idMainThread == 0;
861 }
862
863 void wxThread::Yield()
864 {
865 // 0 argument to Sleep() is special and means to just give away the rest of
866 // our timeslice
867 ::Sleep(0);
868 }
869
870 void wxThread::Sleep(unsigned long milliseconds)
871 {
872 ::Sleep(milliseconds);
873 }
874
875 int wxThread::GetCPUCount()
876 {
877 SYSTEM_INFO si;
878 GetSystemInfo(&si);
879
880 return si.dwNumberOfProcessors;
881 }
882
883 unsigned long wxThread::GetCurrentId()
884 {
885 return (unsigned long)::GetCurrentThreadId();
886 }
887
888 bool wxThread::SetConcurrency(size_t level)
889 {
890 #ifdef __WXWINCE__
891 wxUnusedVar(level);
892 return false;
893 #else
894 wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") );
895
896 // ok only for the default one
897 if ( level == 0 )
898 return 0;
899
900 // get system affinity mask first
901 HANDLE hProcess = ::GetCurrentProcess();
902 DWORD_PTR dwProcMask, dwSysMask;
903 if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 )
904 {
905 wxLogLastError(_T("GetProcessAffinityMask"));
906
907 return false;
908 }
909
910 // how many CPUs have we got?
911 if ( dwSysMask == 1 )
912 {
913 // don't bother with all this complicated stuff - on a single
914 // processor system it doesn't make much sense anyhow
915 return level == 1;
916 }
917
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
920 // CPUs
921 DWORD bit = 1;
922 while ( bit )
923 {
924 if ( dwSysMask & bit )
925 {
926 // ok, we can set this bit
927 dwProcMask |= bit;
928
929 // another process added
930 if ( !--level )
931 {
932 // and that's enough
933 break;
934 }
935 }
936
937 // next bit
938 bit <<= 1;
939 }
940
941 // could we set all bits?
942 if ( level != 0 )
943 {
944 wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level);
945
946 return false;
947 }
948
949 // set it: we can't link to SetProcessAffinityMask() because it doesn't
950 // exist in Win9x, use RT binding instead
951
952 typedef BOOL (*SETPROCESSAFFINITYMASK)(HANDLE, DWORD);
953
954 // can use static var because we're always in the main thread here
955 static SETPROCESSAFFINITYMASK pfnSetProcessAffinityMask = NULL;
956
957 if ( !pfnSetProcessAffinityMask )
958 {
959 HMODULE hModKernel = ::LoadLibrary(_T("kernel32"));
960 if ( hModKernel )
961 {
962 pfnSetProcessAffinityMask = (SETPROCESSAFFINITYMASK)
963 ::GetProcAddress(hModKernel, "SetProcessAffinityMask");
964 }
965
966 // we've discovered a MT version of Win9x!
967 wxASSERT_MSG( pfnSetProcessAffinityMask,
968 _T("this system has several CPUs but no SetProcessAffinityMask function?") );
969 }
970
971 if ( !pfnSetProcessAffinityMask )
972 {
973 // msg given above - do it only once
974 return false;
975 }
976
977 if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 )
978 {
979 wxLogLastError(_T("SetProcessAffinityMask"));
980
981 return false;
982 }
983
984 return true;
985 #endif // __WXWINCE__/!__WXWINCE__
986 }
987
988 // ctor and dtor
989 // -------------
990
991 wxThread::wxThread(wxThreadKind kind)
992 {
993 m_internal = new wxThreadInternal(this);
994
995 m_isDetached = kind == wxTHREAD_DETACHED;
996 }
997
998 wxThread::~wxThread()
999 {
1000 delete m_internal;
1001 }
1002
1003 // create/start thread
1004 // -------------------
1005
1006 wxThreadError wxThread::Create(unsigned int stackSize)
1007 {
1008 wxCriticalSectionLocker lock(m_critsect);
1009
1010 if ( !m_internal->Create(this, stackSize) )
1011 return wxTHREAD_NO_RESOURCE;
1012
1013 return wxTHREAD_NO_ERROR;
1014 }
1015
1016 wxThreadError wxThread::Run()
1017 {
1018 wxCriticalSectionLocker lock(m_critsect);
1019
1020 if ( m_internal->GetState() != STATE_NEW )
1021 {
1022 // actually, it may be almost any state at all, not only STATE_RUNNING
1023 return wxTHREAD_RUNNING;
1024 }
1025
1026 // the thread has just been created and is still suspended - let it run
1027 return Resume();
1028 }
1029
1030 // suspend/resume thread
1031 // ---------------------
1032
1033 wxThreadError wxThread::Pause()
1034 {
1035 wxCriticalSectionLocker lock(m_critsect);
1036
1037 return m_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
1038 }
1039
1040 wxThreadError wxThread::Resume()
1041 {
1042 wxCriticalSectionLocker lock(m_critsect);
1043
1044 return m_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
1045 }
1046
1047 // stopping thread
1048 // ---------------
1049
1050 wxThread::ExitCode wxThread::Wait()
1051 {
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") );
1056
1057 ExitCode rc = (ExitCode)-1;
1058
1059 (void)m_internal->WaitForTerminate(m_critsect, &rc);
1060
1061 return rc;
1062 }
1063
1064 wxThreadError wxThread::Delete(ExitCode *pRc)
1065 {
1066 return m_internal->WaitForTerminate(m_critsect, pRc, this);
1067 }
1068
1069 wxThreadError wxThread::Kill()
1070 {
1071 if ( !IsRunning() )
1072 return wxTHREAD_NOT_RUNNING;
1073
1074 wxThreadError rc = m_internal->Kill();
1075
1076 if ( IsDetached() )
1077 {
1078 delete this;
1079 }
1080 else // joinable
1081 {
1082 // update the status of the joinable thread
1083 wxCriticalSectionLocker lock(m_critsect);
1084 m_internal->SetState(STATE_EXITED);
1085 }
1086
1087 return rc;
1088 }
1089
1090 void wxThread::Exit(ExitCode status)
1091 {
1092 m_internal->Free();
1093
1094 if ( IsDetached() )
1095 {
1096 delete this;
1097 }
1098 else // joinable
1099 {
1100 // update the status of the joinable thread
1101 wxCriticalSectionLocker lock(m_critsect);
1102 m_internal->SetState(STATE_EXITED);
1103 }
1104
1105 #ifdef wxUSE_BEGIN_THREAD
1106 _endthreadex((unsigned)status);
1107 #else // !VC++
1108 ::ExitThread((DWORD)status);
1109 #endif // VC++/!VC++
1110
1111 wxFAIL_MSG(wxT("Couldn't return from ExitThread()!"));
1112 }
1113
1114 // priority setting
1115 // ----------------
1116
1117 void wxThread::SetPriority(unsigned int prio)
1118 {
1119 wxCriticalSectionLocker lock(m_critsect);
1120
1121 m_internal->SetPriority(prio);
1122 }
1123
1124 unsigned int wxThread::GetPriority() const
1125 {
1126 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1127
1128 return m_internal->GetPriority();
1129 }
1130
1131 unsigned long wxThread::GetId() const
1132 {
1133 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1134
1135 return (unsigned long)m_internal->GetId();
1136 }
1137
1138 bool wxThread::IsRunning() const
1139 {
1140 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1141
1142 return m_internal->GetState() == STATE_RUNNING;
1143 }
1144
1145 bool wxThread::IsAlive() const
1146 {
1147 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1148
1149 return (m_internal->GetState() == STATE_RUNNING) ||
1150 (m_internal->GetState() == STATE_PAUSED);
1151 }
1152
1153 bool wxThread::IsPaused() const
1154 {
1155 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1156
1157 return m_internal->GetState() == STATE_PAUSED;
1158 }
1159
1160 bool wxThread::TestDestroy()
1161 {
1162 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1163
1164 return m_internal->GetState() == STATE_CANCELED;
1165 }
1166
1167 // ----------------------------------------------------------------------------
1168 // Automatic initialization for thread module
1169 // ----------------------------------------------------------------------------
1170
1171 class wxThreadModule : public wxModule
1172 {
1173 public:
1174 virtual bool OnInit();
1175 virtual void OnExit();
1176
1177 private:
1178 DECLARE_DYNAMIC_CLASS(wxThreadModule)
1179 };
1180
1181 IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule)
1182
1183 bool wxThreadModule::OnInit()
1184 {
1185 // allocate TLS index for storing the pointer to the current thread
1186 gs_tlsThisThread = ::TlsAlloc();
1187 if ( gs_tlsThisThread == 0xFFFFFFFF )
1188 {
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"));
1193
1194 return false;
1195 }
1196
1197 // main thread doesn't have associated wxThread object, so store 0 in the
1198 // TLS instead
1199 if ( !::TlsSetValue(gs_tlsThisThread, (LPVOID)0) )
1200 {
1201 ::TlsFree(gs_tlsThisThread);
1202 gs_tlsThisThread = 0xFFFFFFFF;
1203
1204 wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage"));
1205
1206 return false;
1207 }
1208
1209 gs_critsectWaitingForGui = new wxCriticalSection();
1210
1211 gs_critsectGui = new wxCriticalSection();
1212 gs_critsectGui->Enter();
1213
1214 gs_critsectThreadDelete = new wxCriticalSection;
1215
1216 // no error return for GetCurrentThreadId()
1217 gs_idMainThread = ::GetCurrentThreadId();
1218
1219 return true;
1220 }
1221
1222 void wxThreadModule::OnExit()
1223 {
1224 if ( !::TlsFree(gs_tlsThisThread) )
1225 {
1226 wxLogLastError(wxT("TlsFree failed."));
1227 }
1228
1229 delete gs_critsectThreadDelete;
1230 gs_critsectThreadDelete = NULL;
1231
1232 if ( gs_critsectGui )
1233 {
1234 gs_critsectGui->Leave();
1235 delete gs_critsectGui;
1236 gs_critsectGui = NULL;
1237 }
1238
1239 delete gs_critsectWaitingForGui;
1240 gs_critsectWaitingForGui = NULL;
1241 }
1242
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 // ----------------------------------------------------------------------------
1247
1248 void WXDLLIMPEXP_BASE wxMutexGuiEnter()
1249 {
1250 // this would dead lock everything...
1251 wxASSERT_MSG( !wxThread::IsMain(),
1252 wxT("main thread doesn't want to block in wxMutexGuiEnter()!") );
1253
1254 // the order in which we enter the critical sections here is crucial!!
1255
1256 // set the flag telling to the main thread that we want to do some GUI
1257 {
1258 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1259
1260 gs_nWaitingForGui++;
1261 }
1262
1263 wxWakeUpMainThread();
1264
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();
1268 }
1269
1270 void WXDLLIMPEXP_BASE wxMutexGuiLeave()
1271 {
1272 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1273
1274 if ( wxThread::IsMain() )
1275 {
1276 gs_bGuiOwnedByMainThread = false;
1277 }
1278 else
1279 {
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?") );
1283
1284 gs_nWaitingForGui--;
1285
1286 wxWakeUpMainThread();
1287 }
1288
1289 gs_critsectGui->Leave();
1290 }
1291
1292 void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter()
1293 {
1294 wxASSERT_MSG( wxThread::IsMain(),
1295 wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") );
1296
1297 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1298
1299 if ( gs_nWaitingForGui == 0 )
1300 {
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() )
1304 {
1305 gs_critsectGui->Enter();
1306
1307 gs_bGuiOwnedByMainThread = true;
1308 }
1309 //else: already have it, nothing to do
1310 }
1311 else
1312 {
1313 // some threads are waiting, release the GUI lock if we have it
1314 if ( wxGuiOwnedByMainThread() )
1315 {
1316 wxMutexGuiLeave();
1317 }
1318 //else: some other worker thread is doing GUI
1319 }
1320 }
1321
1322 bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread()
1323 {
1324 return gs_bGuiOwnedByMainThread;
1325 }
1326
1327 // wake up the main thread if it's in ::GetMessage()
1328 void WXDLLIMPEXP_BASE wxWakeUpMainThread()
1329 {
1330 // sending any message would do - hopefully WM_NULL is harmless enough
1331 if ( !::PostThreadMessage(gs_idMainThread, WM_NULL, 0, 0) )
1332 {
1333 // should never happen
1334 wxLogLastError(wxT("PostThreadMessage(WM_NULL)"));
1335 }
1336 }
1337
1338 bool WXDLLIMPEXP_BASE wxIsWaitingForThread()
1339 {
1340 return gs_waitingForThread;
1341 }
1342
1343 // ----------------------------------------------------------------------------
1344 // include common implementation code
1345 // ----------------------------------------------------------------------------
1346
1347 #include "wx/thrimpl.cpp"
1348
1349 #endif // wxUSE_THREADS
1350