src/gromacs/gpu_utils/devicebuffer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,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 #ifndef GMX_GPU_UTILS_DEVICEBUFFER_H
  36 #define GMX_GPU_UTILS_DEVICEBUFFER_H
  37
  38 /*! \libinternal \file
  39  *  \brief Implements the logic for handling of DeviceBuffer types in OpenCL, CUDA and SYCL.
  40  *
  41  *  Can only be included on GPU build paths.
  42  *
  43  *  Note that most of the buffer operations have an early return, if the requested operation
  44  *  size is zero. This allows for calling these functions with zero operation size even when
  45  *  the underlying buffers were not properly intialized.
  46  *
  47  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  48  *
  49  *  \inlibraryapi
  50  */
  51
  52 #include "config.h"
  53
  54 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  55 #include "gromacs/utility/gmxassert.h"
  56 #include "gromacs/utility/smalloc.h" // TODO: this is only for over_alloc_large
  57
  58 #if GMX_GPU_CUDA
  59 #    include "gromacs/gpu_utils/devicebuffer.cuh"
  60 #elif GMX_GPU_OPENCL
  61 #    include "gromacs/gpu_utils/devicebuffer_ocl.h"
  62 #elif GMX_GPU_SYCL
  63 #    include "gromacs/gpu_utils/devicebuffer_sycl.h"
  64 #else
  65 #    error "devicebuffer.h included on non-GPU build!"
  66 #endif
  67
  68 /*! \brief
  69  *  Reallocates the device-side buffer.
  70  *
  71  *  Reallocates the device-side memory pointed by \p buffer.
  72  *  Allocation is buffered and therefore freeing is only needed
  73  *  if the previously allocated space is not enough.
  74  *  \p currentNumValues and \p currentMaxNumValues are updated.
  75  *  TODO: \p currentNumValues, \p currentMaxNumValues, \p deviceContext
  76  *  should all be encapsulated in a host-side class together with the buffer.
  77  *
  78  *  \tparam        ValueType            Raw value type of the \p buffer.
  79  *  \param[in,out] buffer               Pointer to the device-side buffer
  80  *  \param[in]     numValues            Number of values to accommodate.
  81  *  \param[in,out] currentNumValues     The pointer to the buffer's number of values.
  82  *  \param[in,out] currentMaxNumValues  The pointer to the buffer's capacity.
  83  *  \param[in]     deviceContext        The buffer's device context.
  84  */
  85 template<typename ValueType>
  86 void reallocateDeviceBuffer(DeviceBuffer<ValueType>* buffer,
  87                             size_t                   numValues,
  88                             int*                     currentNumValues,
  89                             int*                     currentMaxNumValues,
  90                             const DeviceContext&     deviceContext)
  91 {
  92     GMX_ASSERT(buffer, "needs a buffer pointer");
  93     GMX_ASSERT(currentNumValues, "needs a size pointer");
  94     GMX_ASSERT(currentMaxNumValues, "needs a capacity pointer");
  95
  96     /* reallocate only if the data does not fit */
  97     if (static_cast<int>(numValues) > *currentMaxNumValues)
  98     {
  99         if (*currentMaxNumValues >= 0)
 100         {
 101             freeDeviceBuffer(buffer);
 102         }
 103
 104         *currentMaxNumValues = over_alloc_large(numValues);
 105         allocateDeviceBuffer(buffer, *currentMaxNumValues, deviceContext);
 106     }
 107     /* size could have changed without actual reallocation */
 108     *currentNumValues = numValues;
 109 }
 110
 111 #endif