src/gromacs/gpu_utils/oclraii.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief Declare RAII helpers for OpenCL types, along with
  37  * supporting type traits.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \inlibraryapi
  41  */
  42 #ifndef GMX_GPU_UTILS_OCLRAII_H
  43 #define GMX_GPU_UTILS_OCLRAII_H
  44
  45 #include "gromacs/gpu_utils/gmxopencl.h"
  46
  47 namespace gmx
  48 {
  49
  50 /*! \libinternal \brief Stub for OpenCL type traits */
  51 template<typename cl_type>
  52 struct OpenClTraits;
  53
  54 /*! \libinternal \brief Implements common trait infrastructure for OpenCL types. */
  55 template<typename cl_type>
  56 struct OpenClTraitsBase
  57 {
  58     //! Type of the function that will release a handle of this type.
  59     using ReleaserType = cl_int (*)(cl_type);
  60 };
  61
  62 /*! \libinternal \brief Implements traits for cl_context. */
  63 template<>
  64 struct OpenClTraits<cl_context> : public OpenClTraitsBase<cl_context>
  65 {
  66     //! Function that will release a handle of this type.
  67     static constexpr ReleaserType releaser = clReleaseContext;
  68 };
  69
  70 /*! \libinternal \brief Implements traits for cl_command_queue. */
  71 template<>
  72 struct OpenClTraits<cl_command_queue> : public OpenClTraitsBase<cl_command_queue>
  73 {
  74     //! Function that will release a handle of this type.
  75     static constexpr ReleaserType releaser = clReleaseCommandQueue;
  76 };
  77
  78 /*! \libinternal \brief Implements traits for cl_program. */
  79 template<>
  80 struct OpenClTraits<cl_program> : public OpenClTraitsBase<cl_program>
  81 {
  82     //! Function that will release a handle of this type.
  83     static constexpr ReleaserType releaser = clReleaseProgram;
  84 };
  85
  86 /*! \libinternal \brief Implements traits for cl_kernel. */
  87 template<>
  88 struct OpenClTraits<cl_kernel> : public OpenClTraitsBase<cl_kernel>
  89 {
  90     //! Function that will release a handle of this type.
  91     static constexpr ReleaserType releaser = clReleaseKernel;
  92 };
  93
  94 /*! \libinternal \brief Wrapper of OpenCL type \c cl_type to implement RAII.
  95  *
  96  * Works by calling the releaser function associated with cl_type
  97  * by OpenClTraits.
  98  *
  99  * Simple copying and assignment are not supported, because there's no
 100  * need for that, and would require OpenCL API calls for deep copies
 101  * if they were needed. Move and move assignment are fine, however. */
 102 template<typename cl_type>
 103 class ClHandle
 104 {
 105 public:
 106     //! Constructor that takes an already created handle.
 107     explicit ClHandle(cl_type handle) : handle_(handle) {}
 108     //! Destructor that calls the releaser associated with cl_type.
 109     ~ClHandle() { OpenClTraits<cl_type>::releaser(handle_); }
 110     //! Deleted default constructor.
 111     ClHandle() = delete;
 112     //! Deleted assignment operator.
 113     ClHandle& operator=(const ClHandle&) = delete;
 114     //! Deleted copy constructor.
 115     ClHandle(const ClHandle&) = delete;
 116     //! Default move assignment operator.
 117     ClHandle& operator=(ClHandle&&) noexcept = default;
 118     //! Default copy constructor.
 119     ClHandle(ClHandle&&) noexcept = default;
 120     /*! \brief Convenience conversion operator so the wrapper type
 121      * can simply convert to the wrapped type. */
 122     operator cl_type() const { return handle_; }
 123
 124 private:
 125     //! The wrapped object.
 126     cl_type handle_;
 127 };
 128
 129 //! Convenience declarations.
 130 /*! @{ */
 131 using ClContext      = ClHandle<cl_context>;
 132 using ClCommandQueue = ClHandle<cl_command_queue>;
 133 using ClProgram      = ClHandle<cl_program>;
 134 using ClKernel       = ClHandle<cl_kernel>;
 135 /*! @} */
 136
 137 } // namespace gmx
 138
 139 #endif