src/gromacs/gpu_utils/device_context_ocl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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 /*! \internal \file
  36  *
  37  * \brief Implements the DeviceContext for OpenCL
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \author Artem Zhmurov <zhmurov@gmail.com>
  41  *
  42  * \ingroup module_gpu_utils
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "gromacs/gpu_utils/device_context.h"
  47 #include "gromacs/hardware/device_information.h"
  48 #include "gromacs/utility/exceptions.h"
  49 #include "gromacs/utility/fatalerror.h"
  50 #include "gromacs/utility/gmxassert.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 #ifndef DOXYGEN
  54
  55 /*! \brief Copies of values from cl_driver_diagnostics_intel.h,
  56  * which isn't guaranteed to be available. */
  57 /**@{*/
  58 #    ifndef CL_CONTEXT_SHOW_DIAGNOSTICS_INTEL
  59 #        define CL_CONTEXT_SHOW_DIAGNOSTICS_INTEL 0x4106
  60 #    endif
  61 #    ifndef CL_CONTEXT_DIAGNOSTICS_LEVEL_GOOD_INTEL
  62 #        define CL_CONTEXT_DIAGNOSTICS_LEVEL_GOOD_INTEL 0x1
  63 #    endif
  64 #    ifndef CL_CONTEXT_DIAGNOSTICS_LEVEL_BAD_INTEL
  65 #        define CL_CONTEXT_DIAGNOSTICS_LEVEL_BAD_INTEL 0x2
  66 #    endif
  67 #    ifndef CL_CONTEXT_DIAGNOSTICS_LEVEL_NEUTRAL_INTEL
  68 #        define CL_CONTEXT_DIAGNOSTICS_LEVEL_NEUTRAL_INTEL 0x4
  69 #    endif
  70 /**@}*/
  71
  72 DeviceContext::DeviceContext(const DeviceInformation& deviceInfo) : deviceInfo_(deviceInfo)
  73 {
  74     cl_platform_id                     platformId = deviceInfo.oclPlatformId;
  75     cl_device_id                       deviceId   = deviceInfo.oclDeviceId;
  76     std::vector<cl_context_properties> contextProperties;
  77
  78     contextProperties.emplace_back(CL_CONTEXT_PLATFORM);
  79     contextProperties.emplace_back(reinterpret_cast<cl_context_properties>(platformId));
  80
  81     if (getenv("GMX_OCL_SHOW_DIAGNOSTICS"))
  82     {
  83         contextProperties.emplace_back(CL_CONTEXT_SHOW_DIAGNOSTICS_INTEL);
  84         contextProperties.emplace_back(CL_CONTEXT_DIAGNOSTICS_LEVEL_BAD_INTEL
  85                                        | CL_CONTEXT_DIAGNOSTICS_LEVEL_NEUTRAL_INTEL);
  86     }
  87     contextProperties.emplace_back(0);
  88
  89     cl_int clError;
  90     context_ = clCreateContext(contextProperties.data(), 1, &deviceId, nullptr, nullptr, &clError);
  91     if (clError != CL_SUCCESS)
  92     {
  93         GMX_THROW(gmx::InternalError(gmx::formatString(
  94                 "Failed to create OpenCL context on device %s (OpenCL error ID %d).",
  95                 deviceInfo.device_name,
  96                 clError)));
  97     }
  98 }
  99
 100 DeviceContext::~DeviceContext()
 101 {
 102     cl_int clError;
 103
 104     if (context_)
 105     {
 106         clError = clReleaseContext(context_);
 107         GMX_RELEASE_ASSERT(
 108                 clError == CL_SUCCESS,
 109                 gmx::formatString("Failed to release OpenCL context (OpenCL error ID %d).", clError).c_str());
 110         context_ = nullptr;
 111     }
 112 }
 113
 114 cl_context DeviceContext::context() const
 115 {
 116     return context_;
 117 }
 118
 119 #endif