BaseThread.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$
 * Date modified: $Date: 2005-01-17 22:34:01 -0600 (Mon, 17 Jan 2005) $
 * Version:       $Revision: 16635 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 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_BASE_THREAD_H_
#define _VPR_BASE_THREAD_H_

#include <vpr/vprConfig.h>

#include <boost/concept_check.hpp>
#include <vpr/vprTypes.h>
#include <vpr/Thread/TSTable.h>            /* Needed to cache a copy here */

namespace vpr
{

typedef void (*thread_func_t)(void *);


class BaseThreadFunctor;

class VPR_CLASS_API BaseThread
{
public:
   enum VPRThreadPriority
   {
      VPR_PRIORITY_LOW,      
      VPR_PRIORITY_NORMAL,   
      VPR_PRIORITY_HIGH,     
      VPR_PRIORITY_URGENT    
   };

   enum VPRThreadScope
   {
      VPR_LOCAL_THREAD,
      VPR_GLOBAL_THREAD
   };

   enum VPRThreadState
   {
      VPR_JOINABLE_THREAD,   
      VPR_UNJOINABLE_THREAD  
   };

   BaseThread() : mThreadId(-1)
   {
      ;
   }

   virtual ~BaseThread()
   {
      ;
   }

   virtual void setFunctor(BaseThreadFunctor* functorPtr) = 0;

   virtual vpr::ReturnStatus start() = 0;

public:     // Thread specific data caching
   TSTable* getTSTable()
   {
      return &mTSTable;
   }

   static TSTable* getGlobalTSTable()
   {
      return &gTSTable;
   }

private:
   TSTable        mTSTable;  
   static TSTable gTSTable;  
protected:
   void registerThread(bool successfulCreation);

   void unregisterThread();

/*
   virtual vpr::ReturnStatus spawn(BaseThreadFunctor* functorPtr,
                                   VPRThreadPriority priority = VPR_PRIORITY_NORMAL,
                                   VPRThreadScope scope = VPR_GLOBAL_THREAD,
                                   VPRThreadState state = VPR_JOINABLE_THREAD,
                                   size_t stack_size = 0)
   {
      std::cerr << "Base spawn.  Should NOT be called." << std::endl;
      return vpr::ReturnStatus::Fail;
   }
*/

public:
   virtual int join(void** status = 0)
   {
      boost::ignore_unused_variable_warning(status);
      return -1;
   }

   virtual int resume()
   {
      return -1;
   }

   virtual int suspend()
   {
      return -1;
   }

   virtual int getPrio(VPRThreadPriority* prio)
   {
      boost::ignore_unused_variable_warning(prio);
      return -1;
   }

   virtual int setPrio(VPRThreadPriority prio)
   {
      boost::ignore_unused_variable_warning(prio);
      return -1;
   }

   vpr::Int32 getTID()
   {
      return mThreadId;
   }

   bool valid()
   {
      return (mThreadId != -1);
   }

   virtual int kill(int signum)
   {
      boost::ignore_unused_variable_warning(signum);
      return -1;
   }

   virtual void kill()
   {;}

   virtual std::ostream& outStream(std::ostream& out);

protected:
   void createThreadId()
   {
      mThreadId = getNextThreadId();
   }

private:
   BaseThread(BaseThread&)
   {;}

protected:
   vpr::Int32  mThreadId;    

   // --- STATICS ---- //

private:
   // XXX: What happens when it rolls over after we have been running for a
   // LONG time.
   vpr::Int32 getNextThreadId()
   {
      return mNextThreadId++;
   }

   static vpr::Int32 mNextThreadId;    // Initialized to 0
};

VPR_API(std::ostream&) operator<<(std::ostream& out, Thread* threadPtr);

} // End of vpr namespace


#endif

---