open_toontown_panda3d/panda/src/express/conditionVarDebug.cxx

140 lines
5.1 KiB
C++
Executable File

// Filename: conditionVarDebug.cxx
// Created by: drose (13Feb06)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
//
// All use of this software is subject to the terms of the Panda 3d
// Software license. You should have received a copy of this license
// along with this source code; you will also find a current copy of
// the license at http://etc.cmu.edu/panda3d/docs/license/ .
//
// To contact the maintainers of this program write to
// panda3d-general@lists.sourceforge.net .
//
////////////////////////////////////////////////////////////////////
#include "conditionVarDebug.h"
#include "thread.h"
#ifdef DEBUG_THREADS
////////////////////////////////////////////////////////////////////
// Function: ConditionVarDebug::Constructor
// Access: Public
// Description: You must pass in a Mutex to the condition variable
// constructor. This mutex may be shared by other
// condition variables, if desired. It is the caller's
// responsibility to ensure the Mutex object does not
// destruct during the lifetime of the condition
// variable.
////////////////////////////////////////////////////////////////////
ConditionVarDebug::
ConditionVarDebug(MutexDebug &mutex) :
_mutex(mutex),
_impl(mutex._global_mutex)
{
nassertv(!_mutex._allow_recursion);
}
////////////////////////////////////////////////////////////////////
// Function: ConditionVarDebug::Destructor
// Access: Public, Virtual
// Description:
////////////////////////////////////////////////////////////////////
ConditionVarDebug::
~ConditionVarDebug() {
}
////////////////////////////////////////////////////////////////////
// Function: ConditionVarDebug::wait
// Access: Public
// Description: Waits on the condition. The caller must already be
// holding the lock associated with the condition
// variable before calling this function.
//
// wait() will release the lock, then go to sleep until
// some other thread calls signal() on this condition
// variable. At that time at least one thread waiting
// on the same ConditionVarDebug will grab the lock again,
// and then return from wait().
//
// It is possible that wait() will return even if no one
// has called signal(). It is the responsibility of the
// calling process to verify the condition on return
// from wait, and possibly loop back to wait again if
// necessary.
//
// Note the semantics of a condition variable: the mutex
// must be held before wait() is called, and it will
// still be held when wait() returns. However, it will
// be temporarily released during the wait() call
// itself.
////////////////////////////////////////////////////////////////////
void ConditionVarDebug::
wait() {
_mutex._global_mutex.lock();
if (!_mutex.do_debug_is_locked()) {
ostringstream ostr;
ostr << *Thread::get_current_thread() << " attempted to wait on "
<< *this << " without holding " << _mutex;
nassert_raise(ostr.str());
_mutex._global_mutex.release();
return;
}
_mutex.do_release();
_impl.wait();
_mutex.do_lock();
_mutex._global_mutex.release();
}
////////////////////////////////////////////////////////////////////
// Function: ConditionVarDebug::signal
// Access: Public
// Description: Informs one of the other threads who are currently
// blocked on wait() that the relevant condition has
// changed. If multiple threads are currently waiting,
// at least one of them will be woken up, although there
// is no way to predict which one.
//
// The caller must be holding the mutex associated with
// the condition variable before making this call, which
// will not release the mutex.
//
// If no threads are waiting, this is a no-op: the
// signal is lost.
////////////////////////////////////////////////////////////////////
void ConditionVarDebug::
signal() {
_mutex._global_mutex.lock();
if (!_mutex.do_debug_is_locked()) {
ostringstream ostr;
ostr << *Thread::get_current_thread() << " attempted to signal "
<< *this << " without holding " << _mutex;
nassert_raise(ostr.str());
_mutex._global_mutex.release();
return;
}
_impl.signal();
_mutex._global_mutex.release();
}
////////////////////////////////////////////////////////////////////
// Function: ConditionVarDebug::output
// Access: Public, Virtual
// Description: This method is declared virtual in ConditionVarDebug,
// but non-virtual in ConditionVarDirect.
////////////////////////////////////////////////////////////////////
void ConditionVarDebug::
output(ostream &out) const {
out << "ConditionVar " << (void *)this;
}
#endif // DEBUG_THREADS