itkPlatformMultiThreader.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkPlatformMultiThreader_h
#define itkPlatformMultiThreader_h
 
#include "itkMultiThreaderBase.h"
#include <mutex>
#include <memory>
 
namespace itk
{
 
class ITKCommon_EXPORT PlatformMultiThreader : public MultiThreaderBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PlatformMultiThreader);

  using Self = PlatformMultiThreader;
  using Superclass = MultiThreaderBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PlatformMultiThreader);
 
#if !defined(ITK_LEGACY_REMOVE)
  itkLegacyMacro(static void SetGlobalMaximumNumberOfThreads(ThreadIdType val))
  {
    itkGenericOutputMacro("Warning: SetGlobalMaximumNumberOfThreads should now be called on itk::MultiThreaderBase. It "
                          "can affect all MultiThreaderBase's derived classes in ITK");
    Superclass::SetGlobalMaximumNumberOfThreads(val);
  }
  itkLegacyMacro(static ThreadIdType GetGlobalMaximumNumberOfThreads())
  {
    itkGenericOutputMacro("Warning: GetGlobalMaximumNumberOfThreads should now be called on itk::MultiThreaderBase. It "
                          "can affect all MultiThreaderBase's derived classes in ITK");
    return Superclass::GetGlobalMaximumNumberOfThreads();
  }

  itkLegacyMacro(static void SetGlobalDefaultNumberOfThreads(ThreadIdType val))
  {
    itkGenericOutputMacro("Warning: SetGlobalDefaultNumberOfThreads should now be called on itk::MultiThreaderBase. It "
                          "can affect all MultiThreaderBase's derived classes in ITK");
    Superclass::SetGlobalDefaultNumberOfThreads(val);
  }
  itkLegacyMacro(static ThreadIdType GetGlobalDefaultNumberOfThreads())
  {
    itkGenericOutputMacro("Warning: GetGlobalDefaultNumberOfThreads should now be called on itk::MultiThreaderBase. It "
                          "can affect all MultiThreaderBase's derived classes in ITK");
    return Superclass::GetGlobalDefaultNumberOfThreads();
  }
#endif

  void
  SingleMethodExecute() override;

  itkLegacyMacro(void MultipleMethodExecute();)

  void
  SetSingleMethod(ThreadFunctionType, void * data) override;

  itkLegacyMacro(void SetMultipleMethod(ThreadIdType index, ThreadFunctionType, void * data);)

  itkLegacyMacro(ThreadIdType SpawnThread(ThreadFunctionType, void * data);)

  itkLegacyMacro(void TerminateThread(ThreadIdType thread_id);)
 
  void
  SetMaximumNumberOfThreads(ThreadIdType numberOfThreads) override;
  void
  SetNumberOfWorkUnits(ThreadIdType numberOfWorkUnits) override;
 
  struct WorkUnitInfo : MultiThreaderBase::WorkUnitInfo
  {
    int *                       ActiveFlag = nullptr;
    std::shared_ptr<std::mutex> ActiveFlagLock;
  };
 
protected:
  PlatformMultiThreader();
  ~PlatformMultiThreader() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  WorkUnitInfo m_ThreadInfoArray[ITK_MAX_THREADS]{};

  int                         m_SpawnedThreadActiveFlag[ITK_MAX_THREADS]{};
  std::shared_ptr<std::mutex> m_SpawnedThreadActiveFlagMutex[ITK_MAX_THREADS]{};
  ThreadProcessIdType         m_SpawnedThreadProcessID[ITK_MAX_THREADS]{};
  WorkUnitInfo                m_SpawnedThreadInfoArray[ITK_MAX_THREADS]{};
 
#if !defined(ITK_LEGACY_REMOVE)
  ThreadFunctionType m_MultipleMethod[ITK_MAX_THREADS]{};

  void * m_MultipleData[ITK_MAX_THREADS]{};
#endif

  ThreadProcessIdType
  SpawnDispatchSingleMethodThread(WorkUnitInfo *);

  void SpawnWaitForSingleMethodThread(ThreadProcessIdType);