itkOpenCLKernelManager.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkOpenCLKernelManager_h
#define itkOpenCLKernelManager_h
 
#include <itkLightObject.h>
#include <itkObjectFactory.h>
 
#include "itkGPUDataManager.h"
#include "itkOpenCLContext.h"
#include "itkOpenCLKernel.h"
 
#include <vector>
 
namespace itk
{
class OpenCLContext;
 
class ITKOpenCL_EXPORT OpenCLKernelManager : public LightObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OpenCLKernelManager);
 
  using Self = OpenCLKernelManager;
  using Superclass = LightObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(OpenCLKernelManager, LightObject);
 
  OpenCLContext *
  GetContext() const
  {
    return this->m_Context;
  }
 
  OpenCLKernel &
  GetKernel(const std::size_t kernelId);
 
  OpenCLEvent
  LaunchKernel(const std::size_t kernelId);
 
  OpenCLEvent
  LaunchKernel(const std::size_t  kernelId,
               const OpenCLSize & global_work_size,
               const OpenCLSize & local_work_size = OpenCLSize::null,
               const OpenCLSize & global_work_offset = OpenCLSize::null);
 
  OpenCLEvent
  LaunchKernel(const std::size_t kernelId, const OpenCLEventList & event_list);
 
  OpenCLEvent
  LaunchKernel(const std::size_t       kernelId,
               const OpenCLEventList & event_list,
               const OpenCLSize &      global_work_size,
               const OpenCLSize &      local_work_size = OpenCLSize::null,
               const OpenCLSize &      global_work_offset = OpenCLSize::null);
 
  std::size_t
  CreateKernel(const OpenCLProgram & program, const std::string & name);
 
  OpenCLProgram
  BuildProgramFromSourceCode(const std::string & sourceCode,
                             const std::string & prefixSourceCode = std::string(),
                             const std::string & postfixSourceCode = std::string(),
                             const std::string & extraBuildOptions = std::string());
 
  OpenCLProgram
  BuildProgramFromSourceFile(const std::string & fileName,
                             const std::string & prefixSourceCode = std::string(),
                             const std::string & postfixSourceCode = std::string(),
                             const std::string & extraBuildOptions = std::string());
 
  void
  SetGlobalWorkSizeForAllKernels(const OpenCLSize & size);
 
  void
  SetLocalWorkSizeForAllKernels(const OpenCLSize & size);
 
  void
  SetGlobalWorkOffsetForAllKernels(const OpenCLSize & offset);
 
  bool
  SetKernelArg(const std::size_t kernelId, const cl_uint argId, const std::size_t argSize, const void * argVal);
 
  bool
  SetKernelArgForAllKernels(const cl_uint argId, const std::size_t argSize, const void * argVal);
 
  bool
  SetKernelArgWithImage(const std::size_t kernelId, cl_uint argId, const GPUDataManager::Pointer manager);
 
protected:
  OpenCLKernelManager();
  ~OpenCLKernelManager() override;
 
  bool
  CheckArgumentReady(const std::size_t kernelId);
 
  void
  ResetArguments(const std::size_t kernelIdx);
 
private:
  OpenCLContext * m_Context{};
 
  struct KernelArgumentList
  {
    bool                    m_IsReady;
    GPUDataManager::Pointer m_GPUDataManager;
  };
 
  std::vector<OpenCLKernel>                    m_Kernels{};
  std::vector<std::vector<KernelArgumentList>> m_KernelArgumentReady{};
};
 
} // end namespace itk
 
#endif /* itkOpenCLKernelManager_h */