src/gromacs/gpu_utils/tests/devicetransfers_ocl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,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  * \brief Defines helper functionality for device transfers for tests
  37  * for GPU host allocator.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/gpu_utils/gmxopencl.h"
  44 #include "gromacs/gpu_utils/oclutils.h"
  45 #include "gromacs/hardware/device_information.h"
  46 #include "gromacs/hardware/device_management.h"
  47 #include "gromacs/utility/arrayref.h"
  48 #include "gromacs/utility/exceptions.h"
  49 #include "gromacs/utility/gmxassert.h"
  50 #include "gromacs/utility/stringutil.h"
  51
  52 #include "devicetransfers.h"
  53
  54 namespace gmx
  55 {
  56 namespace
  57 {
  58
  59 /*! \brief Help give useful diagnostics about error \c status while doing \c message.
  60  *
  61  * \throws InternalError  If status indicates failure, supplying
  62  *                        descriptive text from \c message. */
  63 void throwUponFailure(cl_int status, const char* message)
  64 {
  65     if (status != CL_SUCCESS)
  66     {
  67         GMX_THROW(InternalError(formatString("Failure while %s, error was %s", message,
  68                                              ocl_get_error_string(status).c_str())));
  69     }
  70 }
  71
  72 } // namespace
  73
  74 void doDeviceTransfers(const DeviceInformation& deviceInfo, ArrayRef<const char> input, ArrayRef<char> output)
  75 {
  76     GMX_RELEASE_ASSERT(input.size() == output.size(), "Input and output must have matching size");
  77
  78     cl_int status;
  79
  80     cl_context_properties properties[] = {
  81         CL_CONTEXT_PLATFORM, reinterpret_cast<cl_context_properties>(deviceInfo.oclPlatformId), 0
  82     };
  83
  84     auto deviceId = deviceInfo.oclDeviceId;
  85     auto context  = clCreateContext(properties, 1, &deviceId, nullptr, nullptr, &status);
  86     throwUponFailure(status, "creating context");
  87     auto commandQueue = clCreateCommandQueue(context, deviceId, 0, &status);
  88     throwUponFailure(status, "creating command queue");
  89
  90     auto devicePointer = clCreateBuffer(context, CL_MEM_READ_WRITE, input.size(), nullptr, &status);
  91     throwUponFailure(status, "creating buffer");
  92
  93     status = clEnqueueWriteBuffer(commandQueue, devicePointer, CL_TRUE, 0, input.size(),
  94                                   input.data(), 0, nullptr, nullptr);
  95     throwUponFailure(status, "transferring host to device");
  96     status = clEnqueueReadBuffer(commandQueue, devicePointer, CL_TRUE, 0, output.size(),
  97                                  output.data(), 0, nullptr, nullptr);
  98     throwUponFailure(status, "transferring device to host");
  99
 100     status = clReleaseMemObject(devicePointer);
 101     throwUponFailure(status, "releasing buffer");
 102     status = clReleaseContext(context);
 103     throwUponFailure(status, "releasing context");
 104 }
 105
 106 } // namespace gmx