---

CondVarGeneric.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: CondVarGeneric.h,v $
 * Date modified: $Date: 2004/02/03 21:26:03 $
 * Version:       $Revision: 1.18 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_CondVarGeneric_h_
#define _VPR_CondVarGeneric_h_

#include <vpr/vprConfig.h>

#include <iostream>
#include <iomanip>

#ifdef VPR_OS_Win32
#  include <process.h>
#endif

#include <sys/types.h>

#ifdef HAVE_UNISTD_H
#  include <unistd.h>
#endif

#include <vpr/Sync/Semaphore.h>
#include <vpr/Sync/Mutex.h>
#include <vpr/Util/Debug.h>
#include <vpr/Util/Interval.h>


namespace vpr
{

class VPR_CLASS_API CondVarGeneric
{
public:
   CondVarGeneric(Mutex* mutex = NULL)
      : mWaiters(0)
      , mCondMutex(NULL)
   {
      if ( mutex == NULL )
      {
         mutex = &mDefaultMutex;
      }

      mCondMutex = mutex;

      std::cerr << "------------------------------------\n"
                << "  vpr::CondVarGeneric: DOES NOT WORK\n"
                << "------------------------------------\n";
   }

   vpr::ReturnStatus wait(vpr::Interval time_to_wait = vpr::Interval::NoTimeout);

   vpr::ReturnStatus signal()
   {
      std::cerr << std::setw(5) << getpid() << "  Signal" << std::endl;
      // ASSERT:  We have been locked
      if ( mCondMutex->test() == 0 )    // Not locked
      {
         std::cerr << " vpr::CondVarGeneric::signal: Mutex was not locked when signal called!!!" << std::endl;
      }

      if ( mWaiters > 0 )
      {
         return mSema.release();
      }
      else
      {
         return vpr::ReturnStatus();
      }
   }

   vpr::ReturnStatus broadcast()
   {
      // ASSERT:  We have been locked
      if ( mCondMutex->test() == 0 )    // Not locked
      {
         std::cerr << " vpr::CondVarGeneric::broadcast: Mutex was not locked when broadcase called!!!" << std::endl;
      }

      for ( int i = mWaiters;i>0;i-- )
      {
         mSema.release();
      }

      return vpr::ReturnStatus();
   }

   vpr::ReturnStatus acquire()
   {
      return mCondMutex->acquire();
   }

   vpr::ReturnStatus tryAcquire()
   {
      return mCondMutex->tryAcquire();
   }

   vpr::ReturnStatus release()
   {
      return mCondMutex->release();
   }

   void setMutex(Mutex* mutex)
   {
      mutex->release();       // NOT exactly correct, but just make sure not to leave it locked
      mCondMutex = mutex;
   }

   int test()
   {
      return mCondMutex->test();
   }

   void dump() const
   {
      vprDEBUG_BEGIN(vprDBG_ALL,0)
         << "------------- vpr::CondVarGeneric::Dump ---------\n"
         << vprDEBUG_FLUSH;
      vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL) << "mWaiters: "
                                                << mWaiters << std::endl
                                                << vprDEBUG_FLUSH;
      mCondMutex->dump();
      vprDEBUG_END(vprDBG_ALL,0) << "-----------------------------------\n"
                                 << vprDEBUG_FLUSH;
   }

private:
   // --- These make up the "condition variable" ---- ///
   Semaphore mSema;     
   long mWaiters;       
   Mutex* mCondMutex;   
   Mutex mDefaultMutex; 
   // = Prevent assignment and initialization.
   void operator= (const CondVarGeneric&)
   {
      ;
   }

   CondVarGeneric(const CondVarGeneric& c)
   {
      ;
   }
};

} // End of vpr namespace


#endif

---