]> git.saurik.com Git - wxWidgets.git/blobdiff - src/unix/threadpsx.cpp
Took care of those missing frees from failure conditions in wxExecute.
[wxWidgets.git] / src / unix / threadpsx.cpp
index 0b513b2ef101ae7a53906b153628ed9ac242d8fd..d7dac9c864feb37215c1ece6295119bfe5f4a41a 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"
 #include <errno.h>
 #include <time.h>
 
-#ifdef HAVE_SCHED_H
+#if HAVE_SCHED_H
     #include <sched.h>
 #endif
 
+#ifdef __WXGTK12__
+#include "gtk/gtk.h"
+#endif
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
-enum thread_state
+// the possible states of the thread and transitions from them
+enum wxThreadState
 {
     STATE_NEW,          // didn't start execution yet (=> RUNNING)
-    STATE_RUNNING,
-    STATE_PAUSED,
-    STATE_CANCELED,
-    STATE_EXITED
+    STATE_RUNNING,      // running (=> PAUSED or EXITED)
+    STATE_PAUSED,       // suspended (=> RUNNING or EXITED)
+    STATE_EXITED        // thread doesn't exist any more
 };
 
+// ----------------------------------------------------------------------------
+// types
+// ----------------------------------------------------------------------------
+
 WX_DEFINE_ARRAY(wxThread *, wxArrayThread);
 
 // -----------------------------------------------------------------------------
@@ -76,8 +85,10 @@ static pthread_t gs_tidMain;
 // the key for the pointer to the associated wxThread object
 static pthread_key_t gs_keySelf;
 
+#ifndef __WXGTK12__
 // this mutex must be acquired before any call to a GUI function
 static wxMutex *gs_mutexGui;
+#endif
 
 // ============================================================================
 // implementation
@@ -103,7 +114,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;
@@ -114,7 +125,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;
     }
@@ -150,7 +161,7 @@ wxMutexError wxMutex::Unlock()
     }
     else
     {
-        wxLogDebug("Unlocking not locked mutex.");
+        wxLogDebug(_T("Unlocking not locked mutex."));
 
         return wxMUTEX_UNLOCKED;
     }
@@ -224,7 +235,7 @@ public:
         // start the thread
     wxThreadError Run();
         // ask the thread to terminate
-    void Cancel();
+    void Wait();
         // wake up threads waiting for our termination
     void SignalExit();
         // go to sleep until Resume() is called
@@ -237,19 +248,19 @@ public:
     int GetPriority() const { return m_prio; }
     void SetPriority(int prio) { m_prio = prio; }
         // state
-    thread_state GetState() const { return m_state; }
-    void SetState(thread_state state) { m_state = state; }
+    wxThreadState GetState() const { return m_state; }
+    void SetState(wxThreadState state) { m_state = state; }
         // id
-    pthread_t GetId() const { return thread_id; }
+    pthread_t GetId() const { return m_threadId; }
+    pthread_t *GetIdPtr() { return &m_threadId; }
         // "cancelled" flag
+    void SetCancelFlag() { m_cancelled = TRUE; }
     bool WasCancelled() const { return m_cancelled; }
 
-//private: -- should be!
-    pthread_t thread_id;
-
 private:
-    thread_state m_state;    // see thread_state enum
-    int          m_prio;     // in wxWindows units: from 0 to 100
+    pthread_t     m_threadId;   // id of the thread
+    wxThreadState m_state;      // see wxThreadState enum
+    int           m_prio;       // in wxWindows units: from 0 to 100
 
     // set when the thread should terminate
     bool m_cancelled;
@@ -257,7 +268,7 @@ private:
     // this (mutex, cond) pair is used to synchronize the main thread and this
     // thread in several situations:
     //  1. The thread function blocks until condition is signaled by Run() when
-    //     it's initially created - this allows create thread in "suspended"
+    //     it's initially created - this allows thread creation in "suspended"
     //     state
     //  2. The Delete() function blocks until the condition is signaled when the
     //     thread exits.
@@ -279,9 +290,10 @@ void *wxThreadInternal::PthreadStart(void *ptr)
     wxThread *thread = (wxThread *)ptr;
     wxThreadInternal *pthread = thread->p_internal;
 
-    if ( pthread_setspecific(gs_keySelf, thread) != 0 )
+    int rc = pthread_setspecific(gs_keySelf, thread);
+    if ( rc != 0 )
     {
-        wxLogError(_("Can not start thread: error writing TLS."));
+        wxLogSysError(rc, _("Cannot start thread: error writing TLS"));
 
         return (void *)-1;
     }
@@ -298,7 +310,7 @@ void *wxThreadInternal::PthreadStart(void *ptr)
     // terminate the thread
     thread->Exit(status);
 
-    wxFAIL_MSG("wxThread::Exit() can't return.");
+    wxFAIL_MSG(_T("wxThread::Exit() can't return."));
 
     return NULL;
 }
@@ -319,7 +331,8 @@ 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
@@ -328,7 +341,7 @@ wxThreadInternal::~wxThreadInternal()
 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 -
@@ -345,17 +358,15 @@ wxThreadError wxThreadInternal::Run()
     // starts executing and the mutex is still locked
 }
 
-void wxThreadInternal::Cancel()
+void wxThreadInternal::Wait()
 {
+    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
     if ( wxThread::IsMain() )
         wxMutexGuiLeave();
 
-    // nobody ever writes this variable so it's safe to not use any
-    // synchronization here
-    m_cancelled = TRUE;
-
     // entering Wait() releases the mutex thus allowing SignalExit() to acquire
     // it and to signal us its termination
     m_cond.Wait(m_mutex);
@@ -371,6 +382,9 @@ void wxThreadInternal::Cancel()
 
 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();
@@ -384,8 +398,16 @@ void wxThreadInternal::SignalExit()
 
 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
+    // before it had time to call Wait()
+    if ( WasCancelled() )
+        return;
 
     // wait until the condition is signaled from Resume()
     m_condSuspend.Wait(m_mutexSuspend);
@@ -394,7 +416,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);
@@ -448,19 +470,19 @@ wxThreadError wxThread::Create()
     pthread_attr_t attr;
     pthread_attr_init(&attr);
 
+#ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
     int prio;
     if ( pthread_attr_getschedpolicy(&attr, &prio) != 0 )
     {
-        wxLogError(_("Can not retrieve thread scheduling policy."));
+        wxLogError(_("Cannot retrieve thread scheduling policy."));
     }
 
-#ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
     int min_prio = sched_get_priority_min(prio),
         max_prio = sched_get_priority_max(prio);
 
     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
@@ -473,8 +495,13 @@ 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->thread_id, &attr,
+    int rc = pthread_create(p_internal->GetIdPtr(), &attr,
                             wxThreadInternal::PthreadStart, (void *)this);
     pthread_attr_destroy(&attr);
 
@@ -500,7 +527,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);
 
@@ -529,7 +556,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"));
     }
 }
 
@@ -542,7 +569,7 @@ unsigned int wxThread::GetPriority() const
 
 unsigned long wxThread::GetID() const
 {
-    return (unsigned long)p_internal->thread_id;
+    return (unsigned long)p_internal->GetId();
 }
 
 // -----------------------------------------------------------------------------
@@ -555,7 +582,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;
     }
@@ -571,13 +598,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;
     }
@@ -590,9 +619,12 @@ wxThreadError wxThread::Resume()
 wxThread::ExitCode wxThread::Delete()
 {
     m_critsect.Enter();
-    thread_state state = p_internal->GetState();
+    wxThreadState state = p_internal->GetState();
     m_critsect.Leave();
 
+    // ask the thread to stop
+    p_internal->SetCancelFlag();
+
     switch ( state )
     {
         case STATE_NEW:
@@ -607,8 +639,8 @@ wxThread::ExitCode wxThread::Delete()
             // fall through
 
         default:
-            // set the flag telling to the thread to stop and wait
-            p_internal->Cancel();
+            // wait until the thread stops
+            p_internal->Wait();
     }
 
     return NULL;
@@ -648,14 +680,15 @@ 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);
 }
 
 // also test whether we were paused
 bool wxThread::TestDestroy()
 {
-    wxCriticalSectionLocker lock((wxCriticalSection&)m_critsect);
+    wxCriticalSectionLocker lock(m_critsect);
 
     if ( p_internal->GetState() == STATE_PAUSED )
     {
@@ -704,6 +737,13 @@ bool wxThread::IsAlive() const
     }
 }
 
+bool wxThread::IsPaused() const
+{
+    wxCriticalSectionLocker lock((wxCriticalSection&)m_critsect);
+
+    return (p_internal->GetState() == STATE_PAUSED);
+}
+
 //--------------------------------------------------------------------
 // wxThreadModule
 //--------------------------------------------------------------------
@@ -722,44 +762,48 @@ 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;
     }
 
+#ifndef __WXGTK12__
     gs_mutexGui = new wxMutex();
-
-    //wxThreadGuiInit();
+#endif
 
     gs_tidMain = pthread_self();
+
+#ifndef __WXGTK12__
     gs_mutexGui->Lock();
+#endif
 
     return TRUE;
 }
 
 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++ )
     {
         gs_allThreads[n]->Delete();
     }
 
+#ifndef __WXGTK12__
     // destroy GUI mutex
     gs_mutexGui->Unlock();
 
-    //wxThreadGuiExit();
-
     delete gs_mutexGui;
+#endif
 
     // and free TLD slot
     (void)pthread_key_delete(gs_keySelf);
@@ -771,11 +815,21 @@ void wxThreadModule::OnExit()
 
 void wxMutexGuiEnter()
 {
+#ifdef __WXGTK12__
+  gdk_threads_enter();
+#else
   gs_mutexGui->Lock();
+#endif
 }
 
 void wxMutexGuiLeave()
 {
+#ifdef __WXGTK12__
+  gdk_threads_leave();
+#else
   gs_mutexGui->Unlock();
+#endif
 }
 
+#endif
+  // wxUSE_THREADS