itkGPUDataManager.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.
 *
 *=========================================================================*/
 
#ifndef itkGPUDataManager_h
#define itkGPUDataManager_h
 
#include "itkObject.h"
#include "itkDataObject.h"
#include "itkObjectFactory.h"
#include "itkOpenCLUtil.h"
#include "itkGPUContextManager.h"
#include <mutex>
 
namespace itk
{
class GPUDataManager : public Object // DataObject//
{
  friend class GPUKernelManager;
 
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUDataManager);
 
  using Self = GPUDataManager;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(GPUDataManager);
 
  using MutexHolderType = std::lock_guard<std::mutex>;

  void
  SetBufferSize(unsigned int num);
 
  unsigned int
  GetBufferSize() const
  {
    return m_BufferSize;
  }
 
  void
  SetBufferFlag(cl_mem_flags flags);
 
  void
  SetCPUBufferPointer(void * ptr);
 
  void
  SetCPUDirtyFlag(bool isDirty);
 
  void
  SetGPUDirtyFlag(bool isDirty);

  void
  SetCPUBufferDirty();

  void
  SetGPUBufferDirty();
 
  bool
  IsCPUBufferDirty() const
  {
    return m_IsCPUBufferDirty;
  }
 
  bool
  IsGPUBufferDirty() const
  {
    return m_IsGPUBufferDirty;
  }

  virtual void
  UpdateCPUBuffer();

  virtual void
  UpdateGPUBuffer();
 
  void
  Allocate();
 
  void
  SetCurrentCommandQueue(int queueid);
 
  int
  GetCurrentCommandQueueID() const;

  bool
  Update();

  virtual void
  Graft(const GPUDataManager * data);

  virtual void
  Initialize();

  cl_mem *
  GetGPUBufferPointer();

  void *
  GetCPUBufferPointer();
 
protected:
  GPUDataManager();
  ~GPUDataManager() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
protected:
  /* NOTE: ivars are protected instead of private to improve performance access in child classes*/
 
  unsigned int m_BufferSize{}; // # of bytes
 
  GPUContextManager * m_ContextManager{};
 
  int m_CommandQueueId{};

  cl_mem_flags m_MemFlags{};

  cl_mem m_GPUBuffer{};
  void * m_CPUBuffer{};

  bool m_IsGPUBufferDirty{};
  bool m_IsCPUBufferDirty{};

  std::mutex m_Mutex{};
};
 
} // namespace itk
 
#endif