dox/Common/ExecutionModel/vtkExecutionScheduler.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkExecutionScheduler.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright (c) 2008, 2009 by SCI Institute, University of Utah.

  This is part of the Parallel Dataflow System originally developed by
  Huy T. Vo and Claudio T. Silva. For more information, see:

  "Parallel Dataflow Scheme for Streaming (Un)Structured Data" by Huy
  T. Vo, Daniel K. Osmari, Brian Summa, Joao L.D. Comba, Valerio
  Pascucci and Claudio T. Silva, SCI Institute, University of Utah,
  Technical Report #UUSCI-2009-004, 2009.

  "Multi-Threaded Streaming Pipeline For VTK" by Huy T. Vo and Claudio
  T. Silva, SCI Institute, University of Utah, Technical Report
  #UUSCI-2009-005, 2009.
-------------------------------------------------------------------------*/
#ifndef __vtkExecutionScheduler_h
#define __vtkExecutionScheduler_h

#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkExecutionSchedulerManager.h" // For singleton instantiation/cleanup

class vtkExecutive;
class vtkComputingResources;
class vtkMultiThreader;
class vtkMutexLock;
class vtkThreadMessager;
class vtkInformation;
class vtkInformationIntegerKey;
class vtkExecutiveCollection;

class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExecutionScheduler : public vtkObject
{
public:
  static vtkExecutionScheduler* New();
  vtkTypeMacro(vtkExecutionScheduler,vtkObject);
  void PrintSelf(ostream &os, vtkIndent indent);

  static vtkExecutionScheduler *GetGlobalScheduler();

  static vtkInformationIntegerKey* TASK_PRIORITY();

  void Schedule(vtkExecutiveCollection *execs, vtkInformation *info);

  void SchedulePropagate(vtkExecutiveCollection *execs, vtkInformation *info);

  void WaitUntilDone(vtkExecutiveCollection *execs);

  void WaitUntilReleased(vtkExecutiveCollection *execs);

  void WaitUntilAllDone();

  void WaitForTaskDone(vtkExecutive *exec);

  void WaitForInputsReleased(vtkExecutive *exec);

  vtkThreadMessager* GetTaskDoneMessager(vtkExecutive *exec);

  vtkThreadMessager* GetInputsReleasedMessager(vtkExecutive *exec);

  vtkMutexLock* GetInputsReleasedLock(vtkExecutive *exec);

  void ReleaseResources(vtkExecutive *exec);

  void ReacquireResources(vtkExecutive *exec);

  void RescheduleNetwork(vtkExecutive *sink);

  void RescheduleFrom(vtkExecutive *sink, vtkComputingResources *resources);

protected:
  vtkExecutionScheduler();
  ~vtkExecutionScheduler();

  vtkComputingResources       *Resources;
  vtkThreadMessager           *ScheduleMessager;
  vtkThreadMessager           *ResourceMessager;
  vtkMutexLock                *ScheduleLock;
  vtkMultiThreader            *ScheduleThreader;
  int                          ScheduleThreadId;

//BTX
  class implementation;
  implementation* const Implementation;
  friend class implementation;

  friend void * vtkExecutionScheduler_ScheduleThread(void *data);

  friend void * vtkExecutionScheduler_ExecuteThread(void *data);

//ETX


  static void ClassInitialize();
  static void ClassFinalize();
  friend class vtkExecutionSchedulerManager;

private:
  vtkExecutionScheduler(const vtkExecutionScheduler&);  // Not implemented.
  void operator=(const vtkExecutionScheduler&);  // Not implemented.

};

#endif