// Author: Original from Wolfram Gloger/Guilhem Lavaux
// Modified by: K. S. Sreeram (2002): POSIXified wxCondition, added wxSemaphore
// Created: 04/22/98
-// RCS-ID: $Id$
// Copyright: (c) Wolfram Gloger (1996, 1997)
// Guilhem Lavaux (1998)
// Vadim Zeitlin (1999-2002)
#include <pthread.h>
#include <errno.h>
#include <time.h>
+#include <sys/time.h> // needed for at least __QNX__
#ifdef HAVE_SCHED_H
#include <sched.h>
#endif
#include <thread.h>
#endif
+#ifdef HAVE_ABI_FORCEDUNWIND
+ #include <cxxabi.h>
+#endif
+
+#ifdef HAVE_SETPRIORITY
+ #include <sys/resource.h> // for setpriority()
+#endif
+
// we use wxFFile under Linux in GetCPUCount()
#ifdef __LINUX__
#include "wx/ffile.h"
- // For setpriority.
- #include <sys/time.h>
- #include <sys/resource.h>
#endif
-#ifdef __VMS
- #define THR_ID(thr) ((long long)(thr)->GetId())
-#else
- #define THR_ID(thr) ((long)(thr)->GetId())
-#endif
+#define THR_ID_CAST(id) (reinterpret_cast<void*>(id))
+#define THR_ID(thr) THR_ID_CAST((thr)->GetId())
// ----------------------------------------------------------------------------
// constants
// gs_nThreadsBeingDeleted will have been deleted
static wxCondition *gs_condAllDeleted = NULL;
+#ifndef __WXOSX__
// this mutex must be acquired before any call to a GUI function
// (it's not inside #if wxUSE_GUI because this file is compiled as part
// of wxBase)
static wxMutex *gs_mutexGui = NULL;
+#endif
// when we wait for a thread to exit, we're blocking on a condition which the
// thread signals in its SignalExit() method -- but this condition can't be a
wxCondError wxConditionInternal::WaitTimeout(unsigned long milliseconds)
{
- wxLongLong curtime = wxGetLocalTimeMillis();
+ wxLongLong curtime = wxGetUTCTimeMillis();
curtime += milliseconds;
wxLongLong temp = curtime / 1000;
int sec = temp.GetLo();
{
wxLogTrace(TRACE_SEMA,
wxT("Thread %p waiting for semaphore to become signalled"),
- wxThread::GetCurrentId());
+ THR_ID_CAST(wxThread::GetCurrentId()));
if ( m_cond.Wait() != wxCOND_NO_ERROR )
return wxSEMA_MISC_ERROR;
wxLogTrace(TRACE_SEMA,
wxT("Thread %p finished waiting for semaphore, count = %lu"),
- wxThread::GetCurrentId(), (unsigned long)m_count);
+ THR_ID_CAST(wxThread::GetCurrentId()), (unsigned long)m_count);
}
m_count--;
wxLogTrace(TRACE_SEMA,
wxT("Thread %p about to signal semaphore, count = %lu"),
- wxThread::GetCurrentId(), (unsigned long)m_count);
+ THR_ID_CAST(wxThread::GetCurrentId()), (unsigned long)m_count);
return m_cond.Signal() == wxCOND_NO_ERROR ? wxSEMA_NO_ERROR
: wxSEMA_MISC_ERROR;
static void *PthreadStart(wxThread *thread);
// thread actions
+ // create the thread
+ wxThreadError Create(wxThread *thread, unsigned int stackSize);
// start the thread
wxThreadError Run();
// unblock the thread allowing it to run
void SetState(wxThreadState state)
{
#if wxUSE_LOG_TRACE
- static const wxChar *stateNames[] =
+ static const wxChar *const stateNames[] =
{
wxT("NEW"),
wxT("RUNNING"),
};
wxLogTrace(TRACE_THREADS, wxT("Thread %p: %s => %s."),
- GetId(), stateNames[m_state], stateNames[state]);
+ THR_ID(this), stateNames[m_state], stateNames[state]);
#endif // wxUSE_LOG_TRACE
m_state = state;
// id
pthread_t GetId() const { return m_threadId; }
pthread_t *GetIdPtr() { return &m_threadId; }
+ // "created" flag
+ bool WasCreated() const { return m_created; }
// "cancelled" flag
void SetCancelFlag() { m_cancelled = true; }
bool WasCancelled() const { return m_cancelled; }
wxThreadState m_state; // see wxThreadState enum
int m_prio; // in wxWidgets units: from 0 to 100
+ // this flag is set when the thread was successfully created
+ bool m_created;
+
// this flag is set when the thread should terminate
bool m_cancelled;
int rc = pthread_setspecific(gs_keySelf, thread);
if ( rc != 0 )
{
- wxLogSysError(rc, _("Cannot start thread: error writing TLS"));
+ wxLogSysError(rc, _("Cannot start thread: error writing TLS."));
return (void *)-1;
}
wxTRY
{
- pthread->m_exitcode = thread->Entry();
+ pthread->m_exitcode = thread->CallEntry();
wxLogTrace(TRACE_THREADS,
wxT("Thread %p Entry() returned %lu."),
THR_ID(pthread), wxPtrToUInt(pthread->m_exitcode));
}
+#ifdef HAVE_ABI_FORCEDUNWIND
+ // When using common C++ ABI under Linux we must always rethrow this
+ // special exception used to unwind the stack when the thread was
+ // cancelled, otherwise the thread library would simply terminate the
+ // program, see http://udrepper.livejournal.com/21541.html
+ catch ( abi::__forced_unwind& )
+ {
+ wxCriticalSectionLocker lock(thread->m_critsect);
+ pthread->SetState(STATE_EXITED);
+ throw;
+ }
+#endif // HAVE_ABI_FORCEDUNWIND
wxCATCH_ALL( wxTheApp->OnUnhandledException(); )
{
wxThreadInternal::wxThreadInternal()
{
m_state = STATE_NEW;
+ m_created = false;
m_cancelled = false;
- m_prio = WXTHREAD_DEFAULT_PRIORITY;
+ m_prio = wxPRIORITY_DEFAULT;
m_threadId = 0;
m_exitcode = 0;
{
}
+#ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
+ #define WXUNUSED_STACKSIZE(identifier) identifier
+#else
+ #define WXUNUSED_STACKSIZE(identifier) WXUNUSED(identifier)
+#endif
+
+wxThreadError wxThreadInternal::Create(wxThread *thread,
+ unsigned int WXUNUSED_STACKSIZE(stackSize))
+{
+ if ( GetState() != STATE_NEW )
+ {
+ // don't recreate thread
+ return wxTHREAD_RUNNING;
+ }
+
+ // set up the thread attribute: right now, we only set thread priority
+ pthread_attr_t attr;
+ pthread_attr_init(&attr);
+
+#ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
+ if (stackSize)
+ pthread_attr_setstacksize(&attr, stackSize);
+#endif
+
+#ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
+ int policy;
+ if ( pthread_attr_getschedpolicy(&attr, &policy) != 0 )
+ {
+ wxLogError(_("Cannot retrieve thread scheduling policy."));
+ }
+
+#ifdef __VMS__
+ /* the pthread.h contains too many spaces. This is a work-around */
+# undef sched_get_priority_max
+#undef sched_get_priority_min
+#define sched_get_priority_max(_pol_) \
+ (_pol_ == SCHED_OTHER ? PRI_FG_MAX_NP : PRI_FIFO_MAX)
+#define sched_get_priority_min(_pol_) \
+ (_pol_ == SCHED_OTHER ? PRI_FG_MIN_NP : PRI_FIFO_MIN)
+#endif
+
+ int max_prio = sched_get_priority_max(policy),
+ min_prio = sched_get_priority_min(policy),
+ prio = GetPriority();
+
+ if ( min_prio == -1 || max_prio == -1 )
+ {
+ wxLogError(_("Cannot get priority range for scheduling policy %d."),
+ policy);
+ }
+ else if ( max_prio == min_prio )
+ {
+ if ( prio != wxPRIORITY_DEFAULT )
+ {
+ // notify the programmer that this doesn't work here
+ wxLogWarning(_("Thread priority setting is ignored."));
+ }
+ //else: we have default priority, so don't complain
+
+ // anyhow, don't do anything because priority is just ignored
+ }
+ else
+ {
+ struct sched_param sp;
+ if ( pthread_attr_getschedparam(&attr, &sp) != 0 )
+ {
+ wxFAIL_MSG(wxT("pthread_attr_getschedparam() failed"));
+ }
+
+ sp.sched_priority = min_prio + (prio*(max_prio - min_prio))/100;
+
+ if ( pthread_attr_setschedparam(&attr, &sp) != 0 )
+ {
+ wxFAIL_MSG(wxT("pthread_attr_setschedparam(priority) failed"));
+ }
+ }
+#endif // HAVE_THREAD_PRIORITY_FUNCTIONS
+
+#ifdef HAVE_PTHREAD_ATTR_SETSCOPE
+ // this will make the threads created by this process really concurrent
+ if ( pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM) != 0 )
+ {
+ wxFAIL_MSG(wxT("pthread_attr_setscope(PTHREAD_SCOPE_SYSTEM) failed"));
+ }
+#endif // HAVE_PTHREAD_ATTR_SETSCOPE
+
+ // VZ: assume that this one is always available (it's rather fundamental),
+ // if this function is ever missing we should try to use
+ // pthread_detach() instead (after thread creation)
+ if ( thread->IsDetached() )
+ {
+ if ( pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED) != 0 )
+ {
+ wxFAIL_MSG(wxT("pthread_attr_setdetachstate(DETACHED) failed"));
+ }
+
+ // never try to join detached threads
+ Detach();
+ }
+ //else: threads are created joinable by default, it's ok
+
+ // create the new OS thread object
+ int rc = pthread_create
+ (
+ GetIdPtr(),
+ &attr,
+ wxPthreadStart,
+ (void *)thread
+ );
+
+ if ( pthread_attr_destroy(&attr) != 0 )
+ {
+ wxFAIL_MSG(wxT("pthread_attr_destroy() failed"));
+ }
+
+ if ( rc != 0 )
+ {
+ SetState(STATE_EXITED);
+
+ return wxTHREAD_NO_RESOURCE;
+ }
+
+ m_created = true;
+ return wxTHREAD_NO_ERROR;
+}
+
wxThreadError wxThreadInternal::Run()
{
wxCHECK_MSG( GetState() == STATE_NEW, wxTHREAD_RUNNING,
// 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() )
+ {
+#ifdef __WXOSX__
+ // give the thread we're waiting for chance to do the GUI call
+ // it might be in, we don't do this conditionally as the to be waited on
+ // thread might have to acquire the mutex later but before terminating
+ if ( wxGuiOwnedByMainThread() )
+ wxMutexGuiLeave();
+#else
wxMutexGuiLeave();
+#endif
+ }
wxLogTrace(TRACE_THREADS,
wxT("Starting to wait for thread %p to exit."),
}
}
+#ifndef __WXOSX__
// reacquire GUI mutex
if ( wxThread::IsMain() )
wxMutexGuiEnter();
+#endif
}
void wxThreadInternal::Pause()
bool wxThread::SetConcurrency(size_t level)
{
-#ifdef HAVE_THR_SETCONCURRENCY
+#ifdef HAVE_PTHREAD_SET_CONCURRENCY
+ int rc = pthread_setconcurrency( level );
+#elif defined(HAVE_THR_SETCONCURRENCY)
int rc = thr_setconcurrency(level);
+#else // !HAVE_THR_SETCONCURRENCY
+ // ok only for the default value
+ int rc = level == 0 ? 0 : -1;
+#endif // HAVE_THR_SETCONCURRENCY/!HAVE_THR_SETCONCURRENCY
+
if ( rc != 0 )
{
- wxLogSysError(rc, wxT("thr_setconcurrency() failed"));
+ wxLogSysError(rc, _("Failed to set thread concurrency level to %lu"),
+ static_cast<unsigned long>(level));
+ return false;
}
- return rc == 0;
-#else // !HAVE_THR_SETCONCURRENCY
- // ok only for the default value
- return level == 0;
-#endif // HAVE_THR_SETCONCURRENCY/!HAVE_THR_SETCONCURRENCY
+ return true;
}
// -----------------------------------------------------------------------------
m_isDetached = kind == wxTHREAD_DETACHED;
}
-#ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
- #define WXUNUSED_STACKSIZE(identifier) identifier
-#else
- #define WXUNUSED_STACKSIZE(identifier) WXUNUSED(identifier)
-#endif
-
-wxThreadError wxThread::Create(unsigned int WXUNUSED_STACKSIZE(stackSize))
+wxThreadError wxThread::Create(unsigned int stackSize)
{
- if ( m_internal->GetState() != STATE_NEW )
- {
- // don't recreate thread
- return wxTHREAD_RUNNING;
- }
-
- // set up the thread attribute: right now, we only set thread priority
- pthread_attr_t attr;
- pthread_attr_init(&attr);
-
-#ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
- if (stackSize)
- pthread_attr_setstacksize(&attr, stackSize);
-#endif
-
-#ifdef HAVE_THREAD_PRIORITY_FUNCTIONS
- int policy;
- if ( pthread_attr_getschedpolicy(&attr, &policy) != 0 )
- {
- wxLogError(_("Cannot retrieve thread scheduling policy."));
- }
-
-#ifdef __VMS__
- /* the pthread.h contains too many spaces. This is a work-around */
-# undef sched_get_priority_max
-#undef sched_get_priority_min
-#define sched_get_priority_max(_pol_) \
- (_pol_ == SCHED_OTHER ? PRI_FG_MAX_NP : PRI_FIFO_MAX)
-#define sched_get_priority_min(_pol_) \
- (_pol_ == SCHED_OTHER ? PRI_FG_MIN_NP : PRI_FIFO_MIN)
-#endif
-
- int max_prio = sched_get_priority_max(policy),
- min_prio = sched_get_priority_min(policy),
- prio = m_internal->GetPriority();
-
- if ( min_prio == -1 || max_prio == -1 )
- {
- wxLogError(_("Cannot get priority range for scheduling policy %d."),
- policy);
- }
- else if ( max_prio == min_prio )
- {
- if ( prio != WXTHREAD_DEFAULT_PRIORITY )
- {
- // notify the programmer that this doesn't work here
- wxLogWarning(_("Thread priority setting is ignored."));
- }
- //else: we have default priority, so don't complain
-
- // anyhow, don't do anything because priority is just ignored
- }
- else
- {
- struct sched_param sp;
- if ( pthread_attr_getschedparam(&attr, &sp) != 0 )
- {
- wxFAIL_MSG(wxT("pthread_attr_getschedparam() failed"));
- }
-
- sp.sched_priority = min_prio + (prio*(max_prio - min_prio))/100;
-
- if ( pthread_attr_setschedparam(&attr, &sp) != 0 )
- {
- wxFAIL_MSG(wxT("pthread_attr_setschedparam(priority) failed"));
- }
- }
-#endif // HAVE_THREAD_PRIORITY_FUNCTIONS
-
-#ifdef HAVE_PTHREAD_ATTR_SETSCOPE
- // this will make the threads created by this process really concurrent
- if ( pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM) != 0 )
- {
- wxFAIL_MSG(wxT("pthread_attr_setscope(PTHREAD_SCOPE_SYSTEM) failed"));
- }
-#endif // HAVE_PTHREAD_ATTR_SETSCOPE
-
- // VZ: assume that this one is always available (it's rather fundamental),
- // if this function is ever missing we should try to use
- // pthread_detach() instead (after thread creation)
- if ( m_isDetached )
- {
- if ( pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED) != 0 )
- {
- wxFAIL_MSG(wxT("pthread_attr_setdetachstate(DETACHED) failed"));
- }
-
- // never try to join detached threads
- m_internal->Detach();
- }
- //else: threads are created joinable by default, it's ok
-
- // create the new OS thread object
- int rc = pthread_create
- (
- m_internal->GetIdPtr(),
- &attr,
- wxPthreadStart,
- (void *)this
- );
-
- if ( pthread_attr_destroy(&attr) != 0 )
- {
- wxFAIL_MSG(wxT("pthread_attr_destroy() failed"));
- }
-
- if ( rc != 0 )
- {
- m_internal->SetState(STATE_EXITED);
-
- return wxTHREAD_NO_RESOURCE;
- }
+ wxCriticalSectionLocker lock(m_critsect);
- return wxTHREAD_NO_ERROR;
+ return m_internal->Create(this, stackSize);
}
wxThreadError wxThread::Run()
{
wxCriticalSectionLocker lock(m_critsect);
- wxCHECK_MSG( m_internal->GetId(), wxTHREAD_MISC_ERROR,
- wxT("must call wxThread::Create() first") );
+ // Create the thread if it wasn't created yet with an explicit
+ // Create() call:
+ if ( !m_internal->WasCreated() )
+ {
+ wxThreadError rv = m_internal->Create(this, 0);
+ if ( rv != wxTHREAD_NO_ERROR )
+ return rv;
+ }
return m_internal->Run();
}
void wxThread::SetPriority(unsigned int prio)
{
- wxCHECK_RET( ((int)WXTHREAD_MIN_PRIORITY <= (int)prio) &&
- ((int)prio <= (int)WXTHREAD_MAX_PRIORITY),
+ wxCHECK_RET( wxPRIORITY_MIN <= prio && prio <= wxPRIORITY_MAX,
wxT("invalid thread priority") );
wxCriticalSectionLocker lock(m_critsect);
//
// FIXME this is not true for 2.6!!
- // map wx priorites WXTHREAD_MIN_PRIORITY..WXTHREAD_MAX_PRIORITY
- // to Unix priorities 20..-20
+ // map wx priorites 0..100 to Unix priorities 20..-20
if ( setpriority(PRIO_PROCESS, 0, -(2*(int)prio)/5 + 20) == -1 )
{
wxLogError(_("Failed to set thread priority %d."), prio);
{
case STATE_PAUSED:
wxLogTrace(TRACE_THREADS, wxT("Thread %p suspended, resuming."),
- GetId());
+ THR_ID(this));
m_internal->Resume();
case STATE_EXITED:
wxLogTrace(TRACE_THREADS, wxT("Thread %p exited, won't resume."),
- GetId());
+ THR_ID(this));
return wxTHREAD_NO_ERROR;
default:
// exiting thread
// -----------------------------------------------------------------------------
-wxThread::ExitCode wxThread::Wait()
+wxThread::ExitCode wxThread::Wait(wxThreadWait WXUNUSED(waitMode))
{
wxCHECK_MSG( This() != this, (ExitCode)-1,
wxT("a thread can't wait for itself") );
return m_internal->GetExitCode();
}
-wxThreadError wxThread::Delete(ExitCode *rc)
+wxThreadError wxThread::Delete(ExitCode *rc, wxThreadWait WXUNUSED(waitMode))
{
wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
wxT("a thread can't delete itself") );
m_critsect.Leave();
+ OnDelete();
+
switch ( state )
{
case STATE_NEW:
//else: can't wait for detached threads
}
+ if (state == STATE_NEW)
+ return wxTHREAD_MISC_ERROR;
+ // for coherency with the MSW implementation, signal the user that
+ // Delete() was called on a thread which didn't start to run yet.
+
return wxTHREAD_NO_ERROR;
}
wxCHECK_MSG( This() != this, wxTHREAD_MISC_ERROR,
wxT("a thread can't kill itself") );
+ OnKill();
+
switch ( m_internal->GetState() )
{
case STATE_NEW:
if ( m_internal->GetState() != STATE_EXITED &&
m_internal->GetState() != STATE_NEW )
{
- wxLogDebug(wxT("The thread %ld is being destroyed although it is still running! The application may crash."),
- (long)GetId());
+ wxLogDebug(wxT("The thread %p is being destroyed although it is still running! The application may crash."),
+ THR_ID(this));
}
m_critsect.Leave();
// wxThreadModule
//--------------------------------------------------------------------
+#ifdef __WXOSX__
+void wxOSXThreadModuleOnInit();
+void wxOSXThreadModuleOnExit();
+#endif
+
class wxThreadModule : public wxModule
{
public:
gs_mutexAllThreads = new wxMutex();
+#ifdef __WXOSX__
+ wxOSXThreadModuleOnInit();
+#else
gs_mutexGui = new wxMutex();
gs_mutexGui->Lock();
+#endif
gs_mutexDeleteThread = new wxMutex();
gs_condAllDeleted = new wxCondition(*gs_mutexDeleteThread);
delete gs_mutexAllThreads;
+#ifdef __WXOSX__
+ wxOSXThreadModuleOnExit();
+#else
// destroy GUI mutex
gs_mutexGui->Unlock();
delete gs_mutexGui;
+#endif
// and free TLD slot
(void)pthread_key_delete(gs_keySelf);
static void DeleteThread(wxThread *This)
{
- // gs_mutexDeleteThread should be unlocked before signalling the condition
- // or wxThreadModule::OnExit() would deadlock
- wxMutexLocker locker( *gs_mutexDeleteThread );
-
- wxLogTrace(TRACE_THREADS, wxT("Thread %p auto deletes."), This->GetId());
+ wxLogTrace(TRACE_THREADS, wxT("Thread %p auto deletes."), THR_ID(This));
delete This;
+ // only lock gs_mutexDeleteThread after deleting the thread to avoid
+ // calling out into user code with it locked as this may result in
+ // deadlocks if the thread dtor deletes another thread (see #11501)
+ wxMutexLocker locker( *gs_mutexDeleteThread );
+
wxCHECK_RET( gs_nThreadsBeingDeleted > 0,
wxT("no threads scheduled for deletion, yet we delete one?") );
}
}
+#ifndef __DARWIN__
+
void wxMutexGuiEnterImpl()
{
gs_mutexGui->Lock();
gs_mutexGui->Unlock();
}
+#endif
+
// ----------------------------------------------------------------------------
// include common implementation code
// ----------------------------------------------------------------------------