src/gromacs/gpu_utils/device_context_ocl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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 #ifndef GMX_GPU_UTILS_DEVICE_CONTEXT_OCL_H
  36 #define GMX_GPU_UTILS_DEVICE_CONTEXT_OCL_H
  37
  38 /*! \libinternal \file
  39  *
  40  * \brief Declarations for DeviceContext class.
  41  *
  42  * Only needed for OpenCL builds. Other platforms will be given a stub class.
  43  *
  44  * \author Mark Abraham <mark.j.abraham@gmail.com>
  45  * \author Artem Zhmurov <zhmurov@gmail.com>
  46  *
  47  * \ingroup module_gpu_utils
  48  * \inlibraryapi
  49  */
  50
  51 #ifndef DOXYGEN
  52
  53 #    include "gromacs/gpu_utils/gmxopencl.h"
  54 #    include "gromacs/utility/classhelpers.h"
  55
  56 struct DeviceInformation;
  57
  58 // OpenCL device context class
  59 class DeviceContext
  60 {
  61 public:
  62     /*! \brief Constructor that creates the \c cl_context
  63      *
  64      * \param[in] deviceInfo Platform-specific device information.
  65      *
  66      * \throws InternalError if context creation failed.
  67      */
  68     DeviceContext(const DeviceInformation& deviceInfo);
  69     //! Destructor
  70     ~DeviceContext();
  71
  72     //! Get the associated device information
  73     const DeviceInformation& deviceInfo() const { return deviceInfo_; }
  74     //! Getter
  75     cl_context context() const;
  76
  77 private:
  78     //! A reference to the device information used upon context creation
  79     const DeviceInformation& deviceInfo_;
  80     //! OpenCL context object
  81     cl_context context_ = nullptr;
  82
  83     GMX_DISALLOW_COPY_MOVE_AND_ASSIGN(DeviceContext);
  84 };
  85
  86 #endif // !defined DOXYGEN
  87 #endif // GMX_GPU_UTILS_DEVICE_CONTEXT_OCL_H