]> git.saurik.com Git - wxWidgets.git/blobdiff - src/unix/threadpsx.cpp
More asserts (well, checks) without _T()
[wxWidgets.git] / src / unix / threadpsx.cpp
index bb105415ce6f38685255b2231b3f8a7135fc5ded..a6f79d8db1ca920b157e2feb86a430ac7bf6e685 100644 (file)
     #pragma implementation "thread.h"
 #endif
 
-#include "wx/thread.h"
+// With simple makefiles, we must ignore the file body if not using
+// threads.
+#include "wx/setup.h"
 
-#if !wxUSE_THREADS
-    #error This file needs wxUSE_THREADS
-#endif
+#if wxUSE_THREADS
 
+#include "wx/thread.h"
 #include "wx/module.h"
 #include "wx/utils.h"
 #include "wx/log.h"
@@ -42,7 +43,7 @@
 #include <errno.h>
 #include <time.h>
 
-#ifdef HAVE_SCHED_H
+#if HAVE_SCHED_H
     #include <sched.h>
 #endif
 
@@ -107,7 +108,7 @@ wxMutex::wxMutex()
 wxMutex::~wxMutex()
 {
     if (m_locked > 0)
-        wxLogDebug("Freeing a locked mutex (%d locks)", m_locked);
+        wxLogDebug(_T("Freeing a locked mutex (%d locks)"), m_locked);
 
     pthread_mutex_destroy( &(p_internal->p_mutex) );
     delete p_internal;
@@ -118,7 +119,7 @@ wxMutexError wxMutex::Lock()
     int err = pthread_mutex_lock( &(p_internal->p_mutex) );
     if (err == EDEADLK)
     {
-        wxLogDebug("Locking this mutex would lead to deadlock!");
+        wxLogDebug(_T("Locking this mutex would lead to deadlock!"));
 
         return wxMUTEX_DEAD_LOCK;
     }
@@ -154,7 +155,7 @@ wxMutexError wxMutex::Unlock()
     }
     else
     {
-        wxLogDebug("Unlocking not locked mutex.");
+        wxLogDebug(_T("Unlocking not locked mutex."));
 
         return wxMUTEX_UNLOCKED;
     }
@@ -224,6 +225,11 @@ public:
     // thread entry function
     static void *PthreadStart(void *ptr);
 
+#if HAVE_THREAD_CLEANUP_FUNCTIONS
+    // thread exit function
+    static void PthreadCleanup(void *ptr);
+#endif
+
     // thread actions
         // start the thread
     wxThreadError Run();
@@ -265,7 +271,9 @@ private:
     //     state
     //  2. The Delete() function blocks until the condition is signaled when the
     //     thread exits.
-    wxMutex     m_mutex;
+    // GL: On Linux, this may fail because we can have a deadlock in either
+    //     SignalExit() or Wait(): so we add m_end_mutex for the finalization.
+    wxMutex     m_mutex, m_end_mutex;
     wxCondition m_cond;
 
     // another (mutex, cond) pair for Pause()/Resume() usage
@@ -282,32 +290,62 @@ void *wxThreadInternal::PthreadStart(void *ptr)
 {
     wxThread *thread = (wxThread *)ptr;
     wxThreadInternal *pthread = thread->p_internal;
+    void *status;
 
     int rc = pthread_setspecific(gs_keySelf, thread);
     if ( rc != 0 )
     {
-        wxLogSysError(rc, _("Can not start thread: error writing TLS."));
+        wxLogSysError(rc, _("Cannot start thread: error writing TLS"));
 
         return (void *)-1;
     }
+#if HAVE_THREAD_CLEANUP_FUNCTIONS
+    // Install the cleanup handler.
+    pthread_cleanup_push(wxThreadInternal::PthreadCleanup, ptr);
+#endif
 
     // wait for the condition to be signaled from Run()
     // mutex state: currently locked by the thread which created us
     pthread->m_cond.Wait(pthread->m_mutex);
-
     // mutex state: locked again on exit of Wait()
 
     // call the main entry
-    void* status = thread->Entry();
+    status = thread->Entry();
+
+#if HAVE_THREAD_CLEANUP_FUNCTIONS
+    pthread_cleanup_pop(FALSE);
+#endif
 
     // terminate the thread
     thread->Exit(status);
 
-    wxFAIL_MSG("wxThread::Exit() can't return.");
+    wxFAIL_MSG(_T("wxThread::Exit() can't return."));
 
     return NULL;
 }
 
+#if HAVE_THREAD_CLEANUP_FUNCTIONS
+// Only called when the thread is explicitely killed.
+
+void wxThreadInternal::PthreadCleanup(void *ptr)
+{
+    wxThread *thread = (wxThread *) ptr;
+
+    // The thread is already considered as finished.
+    if (thread->p_internal->GetState() == STATE_EXITED)
+      return;
+
+    // first call user-level clean up code
+    thread->OnExit();
+
+    // next wake up the threads waiting for us (OTOH, this function won't retur
+    // until someone waited for us!)
+    thread->p_internal->SetState(STATE_EXITED);
+
+    thread->p_internal->SignalExit();
+}
+#endif
+
 wxThreadInternal::wxThreadInternal()
 {
     m_state = STATE_NEW;
@@ -316,6 +354,11 @@ wxThreadInternal::wxThreadInternal()
     // this mutex is locked during almost all thread lifetime - it will only be
     // unlocked in the very end
     m_mutex.Lock();
+    // this mutex is used by wxThreadInternal::Wait() and by
+    // wxThreadInternal::SignalExit(). We don't use m_mutex because of a
+    // possible deadlock in either Wait() or SignalExit().
+    m_end_mutex.Lock();
 
     // this mutex is used in Pause()/Resume() and is also locked all the time
     // unless the thread is paused
@@ -324,16 +367,28 @@ wxThreadInternal::wxThreadInternal()
 
 wxThreadInternal::~wxThreadInternal()
 {
-    m_mutexSuspend.Unlock();
+    // GL: moved to SignalExit
+    // m_mutexSuspend.Unlock();
 
     // note that m_mutex will be unlocked by the thread which waits for our
     // termination
+
+    // In the case, we didn't start the thread, all these mutex are locked:
+    // we must unlock them.
+    if (m_mutex.IsLocked())
+      m_mutex.Unlock();
+
+    if (m_end_mutex.IsLocked())
+      m_end_mutex.Unlock();
+
+    if (m_mutexSuspend.IsLocked())
+      m_mutexSuspend.Unlock();
 }
 
 wxThreadError wxThreadInternal::Run()
 {
     wxCHECK_MSG( GetState() == STATE_NEW, wxTHREAD_RUNNING,
-                 "thread may only be started once after successful Create()" );
+                 _T("thread may only be started once after successful Create()") );
 
     // the mutex was locked on Create(), so we will be able to lock it again
     // only when the thread really starts executing and enters the wait -
@@ -352,7 +407,7 @@ wxThreadError wxThreadInternal::Run()
 
 void wxThreadInternal::Wait()
 {
-    wxCHECK_RET( WasCancelled(), "thread should have been cancelled first" );
+    wxCHECK_RET( WasCancelled(), _T("thread should have been cancelled first") );
 
     // if the thread we're waiting for is waiting for the GUI mutex, we will
     // deadlock so make sure we release it temporarily
@@ -361,11 +416,14 @@ void wxThreadInternal::Wait()
 
     // entering Wait() releases the mutex thus allowing SignalExit() to acquire
     // it and to signal us its termination
-    m_cond.Wait(m_mutex);
+    m_cond.Wait(m_end_mutex);
 
     // mutex is still in the locked state - relocked on exit from Wait(), so
     // unlock it - we don't need it any more, the thread has already terminated
-    m_mutex.Unlock();
+    m_end_mutex.Unlock();
+
+    // After that, we wait for the real end of the other thread.
+    pthread_join(GetId(), NULL);
 
     // reacquire GUI mutex
     if ( wxThread::IsMain() )
@@ -374,15 +432,18 @@ void wxThreadInternal::Wait()
 
 void wxThreadInternal::SignalExit()
 {
+    // GL: Unlock mutexSuspend here.
+    m_mutexSuspend.Unlock();
+
     // as mutex is currently locked, this will block until some other thread
     // (normally the same which created this one) unlocks it by entering Wait()
-    m_mutex.Lock();
+    m_end_mutex.Lock();
 
     // wake up all the threads waiting for our termination
     m_cond.Broadcast();
 
     // after this call mutex will be finally unlocked
-    m_mutex.Unlock();
+    m_end_mutex.Unlock();
 }
 
 void wxThreadInternal::Pause()
@@ -390,7 +451,7 @@ void wxThreadInternal::Pause()
     // the state is set from the thread which pauses us first, this function
     // is called later so the state should have been already set
     wxCHECK_RET( m_state == STATE_PAUSED,
-                 "thread must first be paused with wxThread::Pause()." );
+                 _T("thread must first be paused with wxThread::Pause().") );
 
     // don't pause the thread which is being terminated - this would lead to
     // deadlock if the thread is paused after Delete() had called Resume() but
@@ -405,7 +466,7 @@ void wxThreadInternal::Pause()
 void wxThreadInternal::Resume()
 {
     wxCHECK_RET( m_state == STATE_PAUSED,
-                 "can't resume thread which is not suspended." );
+                 _T("can't resume thread which is not suspended.") );
 
     // we will be able to lock this mutex only when Pause() starts waiting
     wxMutexLocker lock(m_mutexSuspend);
@@ -463,7 +524,7 @@ wxThreadError wxThread::Create()
     int prio;
     if ( pthread_attr_getschedpolicy(&attr, &prio) != 0 )
     {
-        wxLogError(_("Can not retrieve thread scheduling policy."));
+        wxLogError(_("Cannot retrieve thread scheduling policy."));
     }
 
     int min_prio = sched_get_priority_min(prio),
@@ -471,7 +532,7 @@ wxThreadError wxThread::Create()
 
     if ( min_prio == -1 || max_prio == -1 )
     {
-        wxLogError(_("Can not get priority range for scheduling policy %d."),
+        wxLogError(_("Cannot get priority range for scheduling policy %d."),
                    prio);
     }
     else
@@ -484,6 +545,11 @@ wxThreadError wxThread::Create()
     }
 #endif // HAVE_THREAD_PRIORITY_FUNCTIONS
 
+#ifdef HAVE_PTHREAD_ATTR_SETSCOPE
+    // this will make the threads created by this process really concurrent
+    pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
+#endif // HAVE_PTHREAD_ATTR_SETSCOPE
+
     // create the new OS thread object
     int rc = pthread_create(p_internal->GetIdPtr(), &attr,
                             wxThreadInternal::PthreadStart, (void *)this);
@@ -511,7 +577,7 @@ void wxThread::SetPriority(unsigned int prio)
 {
     wxCHECK_RET( ((int)WXTHREAD_MIN_PRIORITY <= (int)prio) &&
                  ((int)prio <= (int)WXTHREAD_MAX_PRIORITY),
-                 "invalid thread priority" );
+                 _T("invalid thread priority") );
 
     wxCriticalSectionLocker lock(m_critsect);
 
@@ -540,7 +606,7 @@ void wxThread::SetPriority(unsigned int prio)
 
         case STATE_EXITED:
         default:
-            wxFAIL_MSG("impossible to set thread priority in this state");
+            wxFAIL_MSG(_T("impossible to set thread priority in this state"));
     }
 }
 
@@ -566,7 +632,7 @@ wxThreadError wxThread::Pause()
 
     if ( p_internal->GetState() != STATE_RUNNING )
     {
-        wxLogDebug("Can't pause thread which is not running.");
+        wxLogDebug(_T("Can't pause thread which is not running."));
 
         return wxTHREAD_NOT_RUNNING;
     }
@@ -582,13 +648,15 @@ wxThreadError wxThread::Resume()
 
     if ( p_internal->GetState() == STATE_PAUSED )
     {
+        m_critsect.Leave();
         p_internal->Resume();
+        m_critsect.Enter();
 
         return wxTHREAD_NO_ERROR;
     }
     else
     {
-        wxLogDebug("Attempt to resume a thread which is not paused.");
+        wxLogDebug(_T("Attempt to resume a thread which is not paused."));
 
         return wxTHREAD_MISC_ERROR;
     }
@@ -600,13 +668,17 @@ wxThreadError wxThread::Resume()
 
 wxThread::ExitCode wxThread::Delete()
 {
+    if (IsPaused())
+      Resume();
+
     m_critsect.Enter();
     wxThreadState state = p_internal->GetState();
-    m_critsect.Leave();
 
     // ask the thread to stop
     p_internal->SetCancelFlag();
 
+    m_critsect.Leave();
+
     switch ( state )
     {
         case STATE_NEW:
@@ -662,7 +734,8 @@ void wxThread::Exit(void *status)
     p_internal->SetState(STATE_EXITED);
 
     // delete both C++ thread object and terminate the OS thread object
-    delete this;
+    // GL: This is very ugly and buggy ...
+//    delete this;
     pthread_exit(status);
 }
 
@@ -688,6 +761,14 @@ bool wxThread::TestDestroy()
 
 wxThread::~wxThread()
 {
+    m_critsect.Enter();
+    if (p_internal->GetState() != STATE_EXITED &&
+        p_internal->GetState() != STATE_NEW)
+      wxLogDebug(_T("The thread is being destroyed althought it is still running ! The application may crash."));
+
+    m_critsect.Leave();
+
+    delete p_internal;
     // remove this thread from the global array
     gs_allThreads.Remove(this);
 }
@@ -718,6 +799,13 @@ bool wxThread::IsAlive() const
     }
 }
 
+bool wxThread::IsPaused() const
+{
+    wxCriticalSectionLocker lock((wxCriticalSection&)m_critsect);
+
+    return (p_internal->GetState() == STATE_PAUSED);
+}
+
 //--------------------------------------------------------------------
 // wxThreadModule
 //--------------------------------------------------------------------
@@ -736,19 +824,19 @@ IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule)
 
 bool wxThreadModule::OnInit()
 {
-    if ( pthread_key_create(&gs_keySelf, NULL /* dtor function */) != 0 )
+    int rc = pthread_key_create(&gs_keySelf, NULL /* dtor function */);
+    if ( rc != 0 )
     {
-        wxLogError(_("Thread module initialization failed: "
-                     "failed to create pthread key."));
+        wxLogSysError(rc, _("Thread module initialization failed: "
+                            "failed to create thread key"));
 
         return FALSE;
     }
 
     gs_mutexGui = new wxMutex();
 
-    //wxThreadGuiInit();
-
     gs_tidMain = pthread_self();
+
     gs_mutexGui->Lock();
 
     return TRUE;
@@ -756,12 +844,12 @@ bool wxThreadModule::OnInit()
 
 void wxThreadModule::OnExit()
 {
-    wxASSERT_MSG( wxThread::IsMain(), "only main thread can be here" );
+    wxASSERT_MSG( wxThread::IsMain(), _T("only main thread can be here") );
 
     // terminate any threads left
     size_t count = gs_allThreads.GetCount();
     if ( count != 0u )
-        wxLogDebug("Some threads were not terminated by the application.");
+        wxLogDebug(_T("Some threads were not terminated by the application."));
 
     for ( size_t n = 0u; n < count; n++ )
     {
@@ -771,8 +859,6 @@ void wxThreadModule::OnExit()
     // destroy GUI mutex
     gs_mutexGui->Unlock();
 
-    //wxThreadGuiExit();
-
     delete gs_mutexGui;
 
     // and free TLD slot
@@ -793,3 +879,5 @@ void wxMutexGuiLeave()
   gs_mutexGui->Unlock();
 }
 
+#endif
+  // wxUSE_THREADS