src/gromacs/nbnxm/nbnxm_gpu_buffer_ops.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
  36 /*! \internal \file
  37  *  \brief
  38  *  Common code for GPU buffer operations, namely the coordinate layout conversion
  39  *
  40  *  \ingroup module_nbnxm
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "config.h"
  45
  46 #include "gromacs/gpu_utils/device_stream.h"
  47 #include "gromacs/gpu_utils/gpueventsynchronizer.h"
  48 #include "gromacs/mdtypes/locality.h"
  49 #include "gromacs/nbnxm/gridset.h"
  50 #include "gromacs/nbnxm/nbnxm_gpu.h"
  51 #include "gromacs/nbnxm/nbnxm_gpu_buffer_ops_internal.h"
  52 #if GMX_GPU_CUDA
  53 #    include "gromacs/nbnxm/cuda/nbnxm_cuda_types.h"
  54 #elif GMX_GPU_OPENCL
  55 #    include "gromacs/nbnxm/opencl/nbnxm_ocl_types.h"
  56 #elif GMX_GPU_SYCL
  57 #    include "gromacs/nbnxm/sycl/nbnxm_sycl_types.h"
  58 #endif
  59 #include "gromacs/utility/exceptions.h"
  60
  61 namespace Nbnxm
  62 {
  63
  64 void nbnxn_gpu_x_to_nbat_x(const Nbnxm::Grid&      grid,
  65                            NbnxmGpu*               nb,
  66                            DeviceBuffer<gmx::RVec> d_x,
  67                            GpuEventSynchronizer*   xReadyOnDevice,
  68                            const gmx::AtomLocality locality,
  69                            int                     gridId,
  70                            int                     numColumnsMax,
  71                            bool                    mustInsertNonLocalDependency)
  72 {
  73     GMX_ASSERT(bool(GMX_GPU_CUDA) || bool(GMX_GPU_SYCL),
  74                "NBNXM X buffer operations only supported in CUDA and SYCL");
  75     GMX_ASSERT(nb, "Need a valid nbnxn_gpu object");
  76     gmx::InteractionLocality interactionLoc = gmx::atomToInteractionLocality(locality);
  77
  78     const DeviceStream& deviceStream = *nb->deviceStreams[interactionLoc];
  79
  80     const int numAtoms = grid.srcAtomEnd() - grid.srcAtomBegin();
  81
  82     // Only insert wait on the first iteration of the loop.
  83     if (xReadyOnDevice != nullptr)
  84     {
  85         xReadyOnDevice->enqueueWaitEvent(deviceStream);
  86     }
  87
  88     // avoid empty kernel launch, skip to inserting stream dependency
  89     if (numAtoms != 0)
  90     {
  91         GMX_ASSERT(d_x, "Need a valid device pointer");
  92         launchNbnxmKernelTransformXToXq(grid, nb, d_x, deviceStream, numColumnsMax, gridId);
  93     }
  94
  95     if (mustInsertNonLocalDependency)
  96     {
  97         Nbnxm::nbnxnInsertNonlocalGpuDependency(nb, interactionLoc);
  98     }
  99 }
 100
 101 } // namespace Nbnxm