src/gromacs/gpu_utils/device_stream_ocl.cpp

   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 /*! \internal \file
  36  *
  37  * \brief Implements the DeviceStream for OpenCL.
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  * \ingroup module_gpu_utils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "gromacs/gpu_utils/device_context.h"
  46 #include "gromacs/gpu_utils/device_stream.h"
  47 #include "gromacs/gpu_utils/gputraits_ocl.h"
  48 #include "gromacs/hardware/device_information.h"
  49 #include "gromacs/utility/exceptions.h"
  50 #include "gromacs/utility/gmxassert.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 DeviceStream::DeviceStream(const DeviceContext& deviceContext,
  54                            DeviceStreamPriority /* priority */,
  55                            const bool useTiming)
  56 {
  57     const DeviceInformation&    deviceInfo      = deviceContext.deviceInfo();
  58     cl_command_queue_properties queueProperties = useTiming ? CL_QUEUE_PROFILING_ENABLE : 0;
  59     cl_device_id                deviceId        = deviceInfo.oclDeviceId;
  60     cl_int                      clError;
  61     stream_ = clCreateCommandQueue(deviceContext.context(), deviceId, queueProperties, &clError);
  62     if (clError != CL_SUCCESS)
  63     {
  64         GMX_THROW(gmx::InternalError(gmx::formatString(
  65                 "Failed to create OpenCL command queue on GPU %s (OpenCL error ID %d).",
  66                 deviceInfo.device_name,
  67                 clError)));
  68     }
  69 }
  70
  71 DeviceStream::~DeviceStream()
  72 {
  73     if (isValid())
  74     {
  75         cl_int clError = clReleaseCommandQueue(stream_);
  76         GMX_RELEASE_ASSERT(
  77                 clError == CL_SUCCESS,
  78                 gmx::formatString("Failed to release OpenCL stream (OpenCL error ID %d).", clError).c_str());
  79         stream_ = nullptr;
  80     }
  81 }
  82
  83 cl_command_queue DeviceStream::stream() const
  84 {
  85     return stream_;
  86 }
  87
  88 bool DeviceStream::isValid() const
  89 {
  90     return (stream_ != nullptr);
  91 }
  92
  93 void DeviceStream::synchronize() const
  94 {
  95     cl_int clError = clFinish(stream_);
  96     GMX_RELEASE_ASSERT(
  97             CL_SUCCESS == clError,
  98             gmx::formatString("Error caught during clFinish (OpenCL error ID %d).", clError).c_str());
  99 }