Added wxThread::GetCurrentId(), which returns an ID for the current
[wxWidgets.git] / src / msw / thread.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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)
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifdef __GNUG__
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/wx.h"
30 #endif
31
32 #if wxUSE_THREADS
33
34 #include "wx/msw/private.h"
35
36 #include "wx/module.h"
37 #include "wx/thread.h"
38
39 #ifdef Yield
40 # undef Yield
41 #endif
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__)
66
67 #undef wxUSE_BEGIN_THREAD
68 #define wxUSE_BEGIN_THREAD
69 #endif
70
71 #ifdef wxUSE_BEGIN_THREAD
72 // this is where _beginthreadex() is declared
73 #include <process.h>
74
75 // the return type of the thread function entry point
76 typedef unsigned THREAD_RETVAL;
77
78 // the calling convention of the thread function entry point
79 #define THREAD_CALLCONV __stdcall
80 #else
81 // the settings for CreateThread()
82 typedef DWORD THREAD_RETVAL;
83 #define THREAD_CALLCONV WINAPI
84 #endif
85
86 // ----------------------------------------------------------------------------
87 // constants
88 // ----------------------------------------------------------------------------
89
90 // the possible states of the thread ("=>" shows all possible transitions from
91 // this state)
92 enum wxThreadState
93 {
94 STATE_NEW, // didn't start execution yet (=> RUNNING)
95 STATE_RUNNING, // thread is running (=> PAUSED, CANCELED)
96 STATE_PAUSED, // thread is temporarily suspended (=> RUNNING)
97 STATE_CANCELED, // thread should terminate a.s.a.p. (=> EXITED)
98 STATE_EXITED // thread is terminating
99 };
100
101 // ----------------------------------------------------------------------------
102 // this module globals
103 // ----------------------------------------------------------------------------
104
105 // TLS index of the slot where we store the pointer to the current thread
106 static DWORD gs_tlsThisThread = 0xFFFFFFFF;
107
108 // id of the main thread - the one which can call GUI functions without first
109 // calling wxMutexGuiEnter()
110 static DWORD gs_idMainThread = 0;
111
112 // if it's FALSE, some secondary thread is holding the GUI lock
113 static bool gs_bGuiOwnedByMainThread = TRUE;
114
115 // critical section which controls access to all GUI functions: any secondary
116 // thread (i.e. except the main one) must enter this crit section before doing
117 // any GUI calls
118 static wxCriticalSection *gs_critsectGui = NULL;
119
120 // critical section which protects gs_nWaitingForGui variable
121 static wxCriticalSection *gs_critsectWaitingForGui = NULL;
122
123 // number of threads waiting for GUI in wxMutexGuiEnter()
124 static size_t gs_nWaitingForGui = 0;
125
126 // are we waiting for a thread termination?
127 static bool gs_waitingForThread = FALSE;
128
129 // ============================================================================
130 // Windows implementation of thread classes
131 // ============================================================================
132
133 // ----------------------------------------------------------------------------
134 // wxMutex implementation
135 // ----------------------------------------------------------------------------
136
137 class wxMutexInternal
138 {
139 public:
140 wxMutexInternal()
141 {
142 m_mutex = ::CreateMutex(NULL, FALSE, NULL);
143 if ( !m_mutex )
144 {
145 wxLogSysError(_("Can not create mutex"));
146 }
147 }
148
149 ~wxMutexInternal() { if ( m_mutex ) CloseHandle(m_mutex); }
150
151 public:
152 HANDLE m_mutex;
153 };
154
155 wxMutex::wxMutex()
156 {
157 m_internal = new wxMutexInternal;
158
159 m_locked = 0;
160 }
161
162 wxMutex::~wxMutex()
163 {
164 if ( m_locked > 0 )
165 {
166 wxLogDebug(_T("Warning: freeing a locked mutex (%d locks)."), m_locked);
167 }
168
169 delete m_internal;
170 }
171
172 wxMutexError wxMutex::Lock()
173 {
174 DWORD ret;
175
176 ret = WaitForSingleObject(m_internal->m_mutex, INFINITE);
177 switch ( ret )
178 {
179 case WAIT_ABANDONED:
180 return wxMUTEX_BUSY;
181
182 case WAIT_OBJECT_0:
183 // ok
184 break;
185
186 case WAIT_FAILED:
187 wxLogSysError(_("Couldn't acquire a mutex lock"));
188 return wxMUTEX_MISC_ERROR;
189
190 case WAIT_TIMEOUT:
191 default:
192 wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock"));
193 }
194
195 m_locked++;
196 return wxMUTEX_NO_ERROR;
197 }
198
199 wxMutexError wxMutex::TryLock()
200 {
201 DWORD ret;
202
203 ret = WaitForSingleObject(m_internal->m_mutex, 0);
204 if (ret == WAIT_TIMEOUT || ret == WAIT_ABANDONED)
205 return wxMUTEX_BUSY;
206
207 m_locked++;
208 return wxMUTEX_NO_ERROR;
209 }
210
211 wxMutexError wxMutex::Unlock()
212 {
213 if (m_locked > 0)
214 m_locked--;
215
216 BOOL ret = ReleaseMutex(m_internal->m_mutex);
217 if ( ret == 0 )
218 {
219 wxLogSysError(_("Couldn't release a mutex"));
220 return wxMUTEX_MISC_ERROR;
221 }
222
223 return wxMUTEX_NO_ERROR;
224 }
225
226 // ----------------------------------------------------------------------------
227 // wxCondition implementation
228 // ----------------------------------------------------------------------------
229
230 class wxConditionInternal
231 {
232 public:
233 wxConditionInternal()
234 {
235 m_hEvent = ::CreateEvent(
236 NULL, // default secutiry
237 FALSE, // not manual reset
238 FALSE, // nonsignaled initially
239 NULL // nameless event
240 );
241 if ( !m_hEvent )
242 {
243 wxLogSysError(_("Can not create event object."));
244 }
245
246 // nobody waits for us yet
247 m_nWaiters = 0;
248 }
249
250 bool Wait(DWORD timeout)
251 {
252 // as m_nWaiters variable is accessed from multiple waiting threads
253 // (and possibly from the broadcasting thread), we need to change its
254 // value atomically
255 ::InterlockedIncrement(&m_nWaiters);
256
257 // FIXME this should be MsgWaitForMultipleObjects() as we want to keep
258 // processing Windows messages while waiting (or don't we?)
259 DWORD rc = ::WaitForSingleObject(m_hEvent, timeout);
260
261 ::InterlockedDecrement(&m_nWaiters);
262
263 return rc != WAIT_TIMEOUT;
264 }
265
266 void Signal()
267 {
268 // set the event to signaled: if a thread is already waiting on it, it
269 // will be woken up, otherwise the event will remain in the signaled
270 // state until someone waits on it. In any case, the system will return
271 // it to a non signalled state afterwards. If multiple threads are
272 // waiting, only one will be woken up.
273 if ( !::SetEvent(m_hEvent) )
274 {
275 wxLogLastError(wxT("SetEvent"));
276 }
277 }
278
279 void Broadcast()
280 {
281 // we need to save the original value as m_nWaiters is goign to be
282 // decreased by the signalled thread resulting in the loop being
283 // executed less times than needed
284 LONG nWaiters = m_nWaiters;
285
286 // this works because all these threads are already waiting and so each
287 // SetEvent() inside Signal() is really a PulseEvent() because the
288 // event state is immediately returned to non-signaled
289 for ( LONG n = 0; n < nWaiters; n++ )
290 {
291 Signal();
292 }
293 }
294
295 ~wxConditionInternal()
296 {
297 if ( m_hEvent )
298 {
299 if ( !::CloseHandle(m_hEvent) )
300 {
301 wxLogLastError(wxT("CloseHandle(event)"));
302 }
303 }
304 }
305
306 private:
307 // the Win32 synchronization object corresponding to this event
308 HANDLE m_hEvent;
309
310 // number of threads waiting for this condition
311 LONG m_nWaiters;
312 };
313
314 wxCondition::wxCondition()
315 {
316 m_internal = new wxConditionInternal;
317 }
318
319 wxCondition::~wxCondition()
320 {
321 delete m_internal;
322 }
323
324 void wxCondition::Wait()
325 {
326 (void)m_internal->Wait(INFINITE);
327 }
328
329 bool wxCondition::Wait(unsigned long sec,
330 unsigned long nsec)
331 {
332 return m_internal->Wait(sec*1000 + nsec/1000000);
333 }
334
335 void wxCondition::Signal()
336 {
337 m_internal->Signal();
338 }
339
340 void wxCondition::Broadcast()
341 {
342 m_internal->Broadcast();
343 }
344
345 // ----------------------------------------------------------------------------
346 // wxCriticalSection implementation
347 // ----------------------------------------------------------------------------
348
349 wxCriticalSection::wxCriticalSection()
350 {
351 #ifdef __WXDEBUG__
352 // Done this way to stop warnings during compilation about statement
353 // always being false
354 int csSize = sizeof(CRITICAL_SECTION);
355 int bSize = sizeof(m_buffer);
356 wxASSERT_MSG( csSize <= bSize,
357 _T("must increase buffer size in wx/thread.h") );
358 #endif
359
360 ::InitializeCriticalSection((CRITICAL_SECTION *)m_buffer);
361 }
362
363 wxCriticalSection::~wxCriticalSection()
364 {
365 ::DeleteCriticalSection((CRITICAL_SECTION *)m_buffer);
366 }
367
368 void wxCriticalSection::Enter()
369 {
370 ::EnterCriticalSection((CRITICAL_SECTION *)m_buffer);
371 }
372
373 void wxCriticalSection::Leave()
374 {
375 ::LeaveCriticalSection((CRITICAL_SECTION *)m_buffer);
376 }
377
378 // ----------------------------------------------------------------------------
379 // wxThread implementation
380 // ----------------------------------------------------------------------------
381
382 // wxThreadInternal class
383 // ----------------------
384
385 class wxThreadInternal
386 {
387 public:
388 wxThreadInternal()
389 {
390 m_hThread = 0;
391 m_state = STATE_NEW;
392 m_priority = WXTHREAD_DEFAULT_PRIORITY;
393 }
394
395 ~wxThreadInternal()
396 {
397 Free();
398 }
399
400 void Free()
401 {
402 if ( m_hThread )
403 {
404 if ( !::CloseHandle(m_hThread) )
405 {
406 wxLogLastError(wxT("CloseHandle(thread)"));
407 }
408
409 m_hThread = 0;
410 }
411 }
412
413 // create a new (suspended) thread (for the given thread object)
414 bool Create(wxThread *thread, unsigned int stackSize);
415
416 // suspend/resume/terminate
417 bool Suspend();
418 bool Resume();
419 void Cancel() { m_state = STATE_CANCELED; }
420
421 // thread state
422 void SetState(wxThreadState state) { m_state = state; }
423 wxThreadState GetState() const { return m_state; }
424
425 // thread priority
426 void SetPriority(unsigned int priority);
427 unsigned int GetPriority() const { return m_priority; }
428
429 // thread handle and id
430 HANDLE GetHandle() const { return m_hThread; }
431 DWORD GetId() const { return m_tid; }
432
433 // thread function
434 static THREAD_RETVAL THREAD_CALLCONV WinThreadStart(void *thread);
435
436 private:
437 HANDLE m_hThread; // handle of the thread
438 wxThreadState m_state; // state, see wxThreadState enum
439 unsigned int m_priority; // thread priority in "wx" units
440 DWORD m_tid; // thread id
441 };
442
443 THREAD_RETVAL THREAD_CALLCONV wxThreadInternal::WinThreadStart(void *param)
444 {
445 THREAD_RETVAL rc;
446 bool wasCancelled;
447
448 // first of all, check whether we hadn't been cancelled already and don't
449 // start the user code at all then
450 wxThread *thread = (wxThread *)param;
451 if ( thread->m_internal->GetState() == STATE_EXITED )
452 {
453 rc = (THREAD_RETVAL)-1;
454 wasCancelled = TRUE;
455 }
456 else // do run thread
457 {
458 // store the thread object in the TLS
459 if ( !::TlsSetValue(gs_tlsThisThread, thread) )
460 {
461 wxLogSysError(_("Can not start thread: error writing TLS."));
462
463 return (DWORD)-1;
464 }
465
466 rc = (THREAD_RETVAL)thread->Entry();
467
468 // enter m_critsect before changing the thread state
469 thread->m_critsect.Enter();
470 wasCancelled = thread->m_internal->GetState() == STATE_CANCELED;
471 thread->m_internal->SetState(STATE_EXITED);
472 thread->m_critsect.Leave();
473 }
474
475 thread->OnExit();
476
477 // if the thread was cancelled (from Delete()), then its handle is still
478 // needed there
479 if ( thread->IsDetached() && !wasCancelled )
480 {
481 // auto delete
482 delete thread;
483 }
484 //else: the joinable threads handle will be closed when Wait() is done
485
486 return rc;
487 }
488
489 void wxThreadInternal::SetPriority(unsigned int priority)
490 {
491 m_priority = priority;
492
493 // translate wxWindows priority to the Windows one
494 int win_priority;
495 if (m_priority <= 20)
496 win_priority = THREAD_PRIORITY_LOWEST;
497 else if (m_priority <= 40)
498 win_priority = THREAD_PRIORITY_BELOW_NORMAL;
499 else if (m_priority <= 60)
500 win_priority = THREAD_PRIORITY_NORMAL;
501 else if (m_priority <= 80)
502 win_priority = THREAD_PRIORITY_ABOVE_NORMAL;
503 else if (m_priority <= 100)
504 win_priority = THREAD_PRIORITY_HIGHEST;
505 else
506 {
507 wxFAIL_MSG(wxT("invalid value of thread priority parameter"));
508 win_priority = THREAD_PRIORITY_NORMAL;
509 }
510
511 if ( !::SetThreadPriority(m_hThread, win_priority) )
512 {
513 wxLogSysError(_("Can't set thread priority"));
514 }
515 }
516
517 bool wxThreadInternal::Create(wxThread *thread, unsigned int stackSize)
518 {
519 // for compilers which have it, we should use C RTL function for thread
520 // creation instead of Win32 API one because otherwise we will have memory
521 // leaks if the thread uses C RTL (and most threads do)
522 #ifdef wxUSE_BEGIN_THREAD
523
524 // Watcom is reported to not like 0 stack size (which means "use default"
525 // for the other compilers and is also the default value for stackSize)
526 #ifdef __WATCOMC__
527 if ( !stackSize )
528 stackSize = 10240;
529 #endif // __WATCOMC__
530
531 m_hThread = (HANDLE)_beginthreadex
532 (
533 NULL, // default security
534 stackSize,
535 wxThreadInternal::WinThreadStart, // entry point
536 thread,
537 CREATE_SUSPENDED,
538 (unsigned int *)&m_tid
539 );
540 #else // compiler doesn't have _beginthreadex
541 m_hThread = ::CreateThread
542 (
543 NULL, // default security
544 stackSize, // stack size
545 wxThreadInternal::WinThreadStart, // thread entry point
546 (LPVOID)thread, // parameter
547 CREATE_SUSPENDED, // flags
548 &m_tid // [out] thread id
549 );
550 #endif // _beginthreadex/CreateThread
551
552 if ( m_hThread == NULL )
553 {
554 wxLogSysError(_("Can't create thread"));
555
556 return FALSE;
557 }
558
559 if ( m_priority != WXTHREAD_DEFAULT_PRIORITY )
560 {
561 SetPriority(m_priority);
562 }
563
564 return TRUE;
565 }
566
567 bool wxThreadInternal::Suspend()
568 {
569 DWORD nSuspendCount = ::SuspendThread(m_hThread);
570 if ( nSuspendCount == (DWORD)-1 )
571 {
572 wxLogSysError(_("Can not suspend thread %x"), m_hThread);
573
574 return FALSE;
575 }
576
577 m_state = STATE_PAUSED;
578
579 return TRUE;
580 }
581
582 bool wxThreadInternal::Resume()
583 {
584 DWORD nSuspendCount = ::ResumeThread(m_hThread);
585 if ( nSuspendCount == (DWORD)-1 )
586 {
587 wxLogSysError(_("Can not resume thread %x"), m_hThread);
588
589 return FALSE;
590 }
591
592 // don't change the state from STATE_EXITED because it's special and means
593 // we are going to terminate without running any user code - if we did it,
594 // the codei n Delete() wouldn't work
595 if ( m_state != STATE_EXITED )
596 {
597 m_state = STATE_RUNNING;
598 }
599
600 return TRUE;
601 }
602
603 // static functions
604 // ----------------
605
606 wxThread *wxThread::This()
607 {
608 wxThread *thread = (wxThread *)::TlsGetValue(gs_tlsThisThread);
609
610 // be careful, 0 may be a valid return value as well
611 if ( !thread && (::GetLastError() != NO_ERROR) )
612 {
613 wxLogSysError(_("Couldn't get the current thread pointer"));
614
615 // return NULL...
616 }
617
618 return thread;
619 }
620
621 bool wxThread::IsMain()
622 {
623 return ::GetCurrentThreadId() == gs_idMainThread;
624 }
625
626 #ifdef Yield
627 #undef Yield
628 #endif
629
630 void wxThread::Yield()
631 {
632 // 0 argument to Sleep() is special and means to just give away the rest of
633 // our timeslice
634 ::Sleep(0);
635 }
636
637 void wxThread::Sleep(unsigned long milliseconds)
638 {
639 ::Sleep(milliseconds);
640 }
641
642 int wxThread::GetCPUCount()
643 {
644 SYSTEM_INFO si;
645 GetSystemInfo(&si);
646
647 return si.dwNumberOfProcessors;
648 }
649
650 unsigned long wxThread::GetCurrentId()
651 {
652 return (unsigned long)::GetCurrentThreadId();
653 }
654
655 bool wxThread::SetConcurrency(size_t level)
656 {
657 wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") );
658
659 // ok only for the default one
660 if ( level == 0 )
661 return 0;
662
663 // get system affinity mask first
664 HANDLE hProcess = ::GetCurrentProcess();
665 DWORD dwProcMask, dwSysMask;
666 if ( ::GetProcessAffinityMask(hProcess, &dwProcMask, &dwSysMask) == 0 )
667 {
668 wxLogLastError(_T("GetProcessAffinityMask"));
669
670 return FALSE;
671 }
672
673 // how many CPUs have we got?
674 if ( dwSysMask == 1 )
675 {
676 // don't bother with all this complicated stuff - on a single
677 // processor system it doesn't make much sense anyhow
678 return level == 1;
679 }
680
681 // calculate the process mask: it's a bit vector with one bit per
682 // processor; we want to schedule the process to run on first level
683 // CPUs
684 DWORD bit = 1;
685 while ( bit )
686 {
687 if ( dwSysMask & bit )
688 {
689 // ok, we can set this bit
690 dwProcMask |= bit;
691
692 // another process added
693 if ( !--level )
694 {
695 // and that's enough
696 break;
697 }
698 }
699
700 // next bit
701 bit <<= 1;
702 }
703
704 // could we set all bits?
705 if ( level != 0 )
706 {
707 wxLogDebug(_T("bad level %u in wxThread::SetConcurrency()"), level);
708
709 return FALSE;
710 }
711
712 // set it: we can't link to SetProcessAffinityMask() because it doesn't
713 // exist in Win9x, use RT binding instead
714
715 typedef BOOL (*SETPROCESSAFFINITYMASK)(HANDLE, DWORD);
716
717 // can use static var because we're always in the main thread here
718 static SETPROCESSAFFINITYMASK pfnSetProcessAffinityMask = NULL;
719
720 if ( !pfnSetProcessAffinityMask )
721 {
722 HMODULE hModKernel = ::LoadLibrary(_T("kernel32"));
723 if ( hModKernel )
724 {
725 pfnSetProcessAffinityMask = (SETPROCESSAFFINITYMASK)
726 ::GetProcAddress(hModKernel, "SetProcessAffinityMask");
727 }
728
729 // we've discovered a MT version of Win9x!
730 wxASSERT_MSG( pfnSetProcessAffinityMask,
731 _T("this system has several CPUs but no SetProcessAffinityMask function?") );
732 }
733
734 if ( !pfnSetProcessAffinityMask )
735 {
736 // msg given above - do it only once
737 return FALSE;
738 }
739
740 if ( pfnSetProcessAffinityMask(hProcess, dwProcMask) == 0 )
741 {
742 wxLogLastError(_T("SetProcessAffinityMask"));
743
744 return FALSE;
745 }
746
747 return TRUE;
748 }
749
750 // ctor and dtor
751 // -------------
752
753 wxThread::wxThread(wxThreadKind kind)
754 {
755 m_internal = new wxThreadInternal();
756
757 m_isDetached = kind == wxTHREAD_DETACHED;
758 }
759
760 wxThread::~wxThread()
761 {
762 delete m_internal;
763 }
764
765 // create/start thread
766 // -------------------
767
768 wxThreadError wxThread::Create(unsigned int stackSize)
769 {
770 wxCriticalSectionLocker lock(m_critsect);
771
772 if ( !m_internal->Create(this, stackSize) )
773 return wxTHREAD_NO_RESOURCE;
774
775 return wxTHREAD_NO_ERROR;
776 }
777
778 wxThreadError wxThread::Run()
779 {
780 wxCriticalSectionLocker lock(m_critsect);
781
782 if ( m_internal->GetState() != STATE_NEW )
783 {
784 // actually, it may be almost any state at all, not only STATE_RUNNING
785 return wxTHREAD_RUNNING;
786 }
787
788 // the thread has just been created and is still suspended - let it run
789 return Resume();
790 }
791
792 // suspend/resume thread
793 // ---------------------
794
795 wxThreadError wxThread::Pause()
796 {
797 wxCriticalSectionLocker lock(m_critsect);
798
799 return m_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
800 }
801
802 wxThreadError wxThread::Resume()
803 {
804 wxCriticalSectionLocker lock(m_critsect);
805
806 return m_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
807 }
808
809 // stopping thread
810 // ---------------
811
812 wxThread::ExitCode wxThread::Wait()
813 {
814 // although under Windows we can wait for any thread, it's an error to
815 // wait for a detached one in wxWin API
816 wxCHECK_MSG( !IsDetached(), (ExitCode)-1,
817 _T("can't wait for detached thread") );
818
819 ExitCode rc = (ExitCode)-1;
820
821 (void)Delete(&rc);
822
823 m_internal->Free();
824
825 return rc;
826 }
827
828 wxThreadError wxThread::Delete(ExitCode *pRc)
829 {
830 ExitCode rc = 0;
831
832 // Delete() is always safe to call, so consider all possible states
833
834 // we might need to resume the thread, but we might also not need to cancel
835 // it if it doesn't run yet
836 bool shouldResume = FALSE,
837 shouldCancel = TRUE,
838 isRunning = FALSE;
839
840 // check if the thread already started to run
841 {
842 wxCriticalSectionLocker lock(m_critsect);
843
844 if ( m_internal->GetState() == STATE_NEW )
845 {
846 // WinThreadStart() will see it and terminate immediately, no need
847 // to cancel the thread - but we still need to resume it to let it
848 // run
849 m_internal->SetState(STATE_EXITED);
850
851 Resume(); // it knows about STATE_EXITED special case
852
853 shouldCancel = FALSE;
854 isRunning = TRUE;
855
856 // shouldResume is correctly set to FALSE here
857 }
858 else
859 {
860 shouldResume = IsPaused();
861 }
862 }
863
864 // resume the thread if it is paused
865 if ( shouldResume )
866 Resume();
867
868 HANDLE hThread = m_internal->GetHandle();
869
870 // does is still run?
871 if ( isRunning || IsRunning() )
872 {
873 if ( IsMain() )
874 {
875 // set flag for wxIsWaitingForThread()
876 gs_waitingForThread = TRUE;
877
878 #if wxUSE_GUI
879 wxBeginBusyCursor();
880 #endif // wxUSE_GUI
881 }
882
883 // ask the thread to terminate
884 if ( shouldCancel )
885 {
886 wxCriticalSectionLocker lock(m_critsect);
887
888 m_internal->Cancel();
889 }
890
891 #if wxUSE_GUI
892 // we can't just wait for the thread to terminate because it might be
893 // calling some GUI functions and so it will never terminate before we
894 // process the Windows messages that result from these functions
895 DWORD result;
896 do
897 {
898 result = ::MsgWaitForMultipleObjects
899 (
900 1, // number of objects to wait for
901 &hThread, // the objects
902 FALSE, // don't wait for all objects
903 INFINITE, // no timeout
904 QS_ALLEVENTS // return as soon as there are any events
905 );
906
907 switch ( result )
908 {
909 case 0xFFFFFFFF:
910 // error
911 wxLogSysError(_("Can not wait for thread termination"));
912 Kill();
913 return wxTHREAD_KILLED;
914
915 case WAIT_OBJECT_0:
916 // thread we're waiting for terminated
917 break;
918
919 case WAIT_OBJECT_0 + 1:
920 // new message arrived, process it
921 if ( !wxTheApp->DoMessage() )
922 {
923 // WM_QUIT received: kill the thread
924 Kill();
925
926 return wxTHREAD_KILLED;
927 }
928
929 if ( IsMain() )
930 {
931 // give the thread we're waiting for chance to exit
932 // from the GUI call it might have been in
933 if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() )
934 {
935 wxMutexGuiLeave();
936 }
937 }
938
939 break;
940
941 default:
942 wxFAIL_MSG(wxT("unexpected result of MsgWaitForMultipleObject"));
943 }
944 } while ( result != WAIT_OBJECT_0 );
945 #else // !wxUSE_GUI
946 // simply wait for the thread to terminate
947 //
948 // OTOH, even console apps create windows (in wxExecute, for WinSock
949 // &c), so may be use MsgWaitForMultipleObject() too here?
950 if ( WaitForSingleObject(hThread, INFINITE) != WAIT_OBJECT_0 )
951 {
952 wxFAIL_MSG(wxT("unexpected result of WaitForSingleObject"));
953 }
954 #endif // wxUSE_GUI/!wxUSE_GUI
955
956 if ( IsMain() )
957 {
958 gs_waitingForThread = FALSE;
959
960 #if wxUSE_GUI
961 wxEndBusyCursor();
962 #endif // wxUSE_GUI
963 }
964 }
965
966 if ( !::GetExitCodeThread(hThread, (LPDWORD)&rc) )
967 {
968 wxLogLastError(wxT("GetExitCodeThread"));
969
970 rc = (ExitCode)-1;
971 }
972
973 if ( IsDetached() )
974 {
975 // if the thread exits normally, this is done in WinThreadStart, but in
976 // this case it would have been too early because
977 // MsgWaitForMultipleObject() would fail if the thread handle was
978 // closed while we were waiting on it, so we must do it here
979 delete this;
980 }
981
982 wxASSERT_MSG( (DWORD)rc != STILL_ACTIVE,
983 wxT("thread must be already terminated.") );
984
985 if ( pRc )
986 *pRc = rc;
987
988 return rc == (ExitCode)-1 ? wxTHREAD_MISC_ERROR : wxTHREAD_NO_ERROR;
989 }
990
991 wxThreadError wxThread::Kill()
992 {
993 if ( !IsRunning() )
994 return wxTHREAD_NOT_RUNNING;
995
996 if ( !::TerminateThread(m_internal->GetHandle(), (DWORD)-1) )
997 {
998 wxLogSysError(_("Couldn't terminate thread"));
999
1000 return wxTHREAD_MISC_ERROR;
1001 }
1002
1003 m_internal->Free();
1004
1005 if ( IsDetached() )
1006 {
1007 delete this;
1008 }
1009
1010 return wxTHREAD_NO_ERROR;
1011 }
1012
1013 void wxThread::Exit(ExitCode status)
1014 {
1015 m_internal->Free();
1016
1017 if ( IsDetached() )
1018 {
1019 delete this;
1020 }
1021
1022 #ifdef wxUSE_BEGIN_THREAD
1023 _endthreadex((unsigned)status);
1024 #else // !VC++
1025 ::ExitThread((DWORD)status);
1026 #endif // VC++/!VC++
1027
1028 wxFAIL_MSG(wxT("Couldn't return from ExitThread()!"));
1029 }
1030
1031 // priority setting
1032 // ----------------
1033
1034 void wxThread::SetPriority(unsigned int prio)
1035 {
1036 wxCriticalSectionLocker lock(m_critsect);
1037
1038 m_internal->SetPriority(prio);
1039 }
1040
1041 unsigned int wxThread::GetPriority() const
1042 {
1043 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1044
1045 return m_internal->GetPriority();
1046 }
1047
1048 unsigned long wxThread::GetId() const
1049 {
1050 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1051
1052 return (unsigned long)m_internal->GetId();
1053 }
1054
1055 bool wxThread::IsRunning() const
1056 {
1057 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1058
1059 return m_internal->GetState() == STATE_RUNNING;
1060 }
1061
1062 bool wxThread::IsAlive() const
1063 {
1064 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1065
1066 return (m_internal->GetState() == STATE_RUNNING) ||
1067 (m_internal->GetState() == STATE_PAUSED);
1068 }
1069
1070 bool wxThread::IsPaused() const
1071 {
1072 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1073
1074 return m_internal->GetState() == STATE_PAUSED;
1075 }
1076
1077 bool wxThread::TestDestroy()
1078 {
1079 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
1080
1081 return m_internal->GetState() == STATE_CANCELED;
1082 }
1083
1084 // ----------------------------------------------------------------------------
1085 // Automatic initialization for thread module
1086 // ----------------------------------------------------------------------------
1087
1088 class wxThreadModule : public wxModule
1089 {
1090 public:
1091 virtual bool OnInit();
1092 virtual void OnExit();
1093
1094 private:
1095 DECLARE_DYNAMIC_CLASS(wxThreadModule)
1096 };
1097
1098 IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule)
1099
1100 bool wxThreadModule::OnInit()
1101 {
1102 // allocate TLS index for storing the pointer to the current thread
1103 gs_tlsThisThread = ::TlsAlloc();
1104 if ( gs_tlsThisThread == 0xFFFFFFFF )
1105 {
1106 // in normal circumstances it will only happen if all other
1107 // TLS_MINIMUM_AVAILABLE (>= 64) indices are already taken - in other
1108 // words, this should never happen
1109 wxLogSysError(_("Thread module initialization failed: impossible to allocate index in thread local storage"));
1110
1111 return FALSE;
1112 }
1113
1114 // main thread doesn't have associated wxThread object, so store 0 in the
1115 // TLS instead
1116 if ( !::TlsSetValue(gs_tlsThisThread, (LPVOID)0) )
1117 {
1118 ::TlsFree(gs_tlsThisThread);
1119 gs_tlsThisThread = 0xFFFFFFFF;
1120
1121 wxLogSysError(_("Thread module initialization failed: can not store value in thread local storage"));
1122
1123 return FALSE;
1124 }
1125
1126 gs_critsectWaitingForGui = new wxCriticalSection();
1127
1128 gs_critsectGui = new wxCriticalSection();
1129 gs_critsectGui->Enter();
1130
1131 // no error return for GetCurrentThreadId()
1132 gs_idMainThread = ::GetCurrentThreadId();
1133
1134 return TRUE;
1135 }
1136
1137 void wxThreadModule::OnExit()
1138 {
1139 if ( !::TlsFree(gs_tlsThisThread) )
1140 {
1141 wxLogLastError(wxT("TlsFree failed."));
1142 }
1143
1144 if ( gs_critsectGui )
1145 {
1146 gs_critsectGui->Leave();
1147 delete gs_critsectGui;
1148 gs_critsectGui = NULL;
1149 }
1150
1151 delete gs_critsectWaitingForGui;
1152 gs_critsectWaitingForGui = NULL;
1153 }
1154
1155 // ----------------------------------------------------------------------------
1156 // under Windows, these functions are implemented using a critical section and
1157 // not a mutex, so the names are a bit confusing
1158 // ----------------------------------------------------------------------------
1159
1160 void WXDLLEXPORT wxMutexGuiEnter()
1161 {
1162 // this would dead lock everything...
1163 wxASSERT_MSG( !wxThread::IsMain(),
1164 wxT("main thread doesn't want to block in wxMutexGuiEnter()!") );
1165
1166 // the order in which we enter the critical sections here is crucial!!
1167
1168 // set the flag telling to the main thread that we want to do some GUI
1169 {
1170 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1171
1172 gs_nWaitingForGui++;
1173 }
1174
1175 wxWakeUpMainThread();
1176
1177 // now we may block here because the main thread will soon let us in
1178 // (during the next iteration of OnIdle())
1179 gs_critsectGui->Enter();
1180 }
1181
1182 void WXDLLEXPORT wxMutexGuiLeave()
1183 {
1184 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1185
1186 if ( wxThread::IsMain() )
1187 {
1188 gs_bGuiOwnedByMainThread = FALSE;
1189 }
1190 else
1191 {
1192 // decrement the number of threads waiting for GUI access now
1193 wxASSERT_MSG( gs_nWaitingForGui > 0,
1194 wxT("calling wxMutexGuiLeave() without entering it first?") );
1195
1196 gs_nWaitingForGui--;
1197
1198 wxWakeUpMainThread();
1199 }
1200
1201 gs_critsectGui->Leave();
1202 }
1203
1204 void WXDLLEXPORT wxMutexGuiLeaveOrEnter()
1205 {
1206 wxASSERT_MSG( wxThread::IsMain(),
1207 wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") );
1208
1209 wxCriticalSectionLocker enter(*gs_critsectWaitingForGui);
1210
1211 if ( gs_nWaitingForGui == 0 )
1212 {
1213 // no threads are waiting for GUI - so we may acquire the lock without
1214 // any danger (but only if we don't already have it)
1215 if ( !wxGuiOwnedByMainThread() )
1216 {
1217 gs_critsectGui->Enter();
1218
1219 gs_bGuiOwnedByMainThread = TRUE;
1220 }
1221 //else: already have it, nothing to do
1222 }
1223 else
1224 {
1225 // some threads are waiting, release the GUI lock if we have it
1226 if ( wxGuiOwnedByMainThread() )
1227 {
1228 wxMutexGuiLeave();
1229 }
1230 //else: some other worker thread is doing GUI
1231 }
1232 }
1233
1234 bool WXDLLEXPORT wxGuiOwnedByMainThread()
1235 {
1236 return gs_bGuiOwnedByMainThread;
1237 }
1238
1239 // wake up the main thread if it's in ::GetMessage()
1240 void WXDLLEXPORT wxWakeUpMainThread()
1241 {
1242 // sending any message would do - hopefully WM_NULL is harmless enough
1243 if ( !::PostThreadMessage(gs_idMainThread, WM_NULL, 0, 0) )
1244 {
1245 // should never happen
1246 wxLogLastError(wxT("PostThreadMessage(WM_NULL)"));
1247 }
1248 }
1249
1250 bool WXDLLEXPORT wxIsWaitingForThread()
1251 {
1252 return gs_waitingForThread;
1253 }
1254
1255 #endif // wxUSE_THREADS
1256
1257 // vi:sts=4:sw=4:et