cmtkThreadPool.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkThreadPool_h_included_
#define __cmtkThreadPool_h_included_

#include <cmtkconfig.h>

#include <System/cmtkCannotBeCopied.h>

#include <System/cmtkThreadSystemTypes.h>
#include <System/cmtkThreadSemaphore.h>
#include <System/cmtkMutexLock.h>
#include <System/cmtkSmartPtr.h>

#include <vector>

namespace
cmtk
{

class ThreadPool :
  private CannotBeCopied
{
public:
  typedef ThreadPool Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef void (*TaskFunction)( void *const args, 
                                const size_t taskIdx, 
                                const size_t taskCnt, 
                                const size_t threadIdx, 
                                const size_t threadCont 
    );

  ThreadPool( const size_t nThreads = 0 );

  ~ThreadPool();

  size_t GetNumberOfThreads() const
  {
    return this->m_NumberOfThreads;
  }

  template<class TParam> 
  void Run( TaskFunction taskFunction, 
            std::vector<TParam>& taskParameters, 
            const size_t numberOfTasksOverride = 0 
    );

  void ThreadFunction( const size_t threadIdx  );
  
  static Self& GetGlobalThreadPool();

  class ThreadPoolArg
  {
  public:
    ThreadPool* m_Pool;

    size_t m_Index;
  };

private:
  ThreadSemaphore m_TaskWaitingSemaphore;

  ThreadSemaphore m_ThreadWaitingSemaphore;

  size_t m_NumberOfTasks;

  size_t m_NextTaskIndex;

  MutexLock m_NextTaskIndexLock;

  TaskFunction m_TaskFunction;

  std::vector<void*> m_TaskParameters;

  std::vector<Self::ThreadPoolArg> m_ThreadArgs;
  
  size_t m_NumberOfThreads;

#ifdef CMTK_BUILD_SMP

  std::vector<ThreadIDType> m_ThreadID;
  
#ifdef _MSC_VER

  std::vector<HANDLE> m_ThreadHandles;
#endif
#endif
  
  bool m_ThreadsRunning;

  bool m_ContinueThreads;

  void StartThreads();

  void EndThreads();
};

} // namespace cmtk

extern "C" CMTK_THREAD_RETURN_TYPE cmtkThreadPoolThreadFunction( CMTK_THREAD_ARG_TYPE arg  );

#include "cmtkThreadPool.txx"

#endif // #ifndef __cmtkThreadPool_h_included_