Pipeline GPU PME Spline/Spread with PP Comms
[alexxy/gromacs.git] / src / gromacs / ewald / pme.cuh
index 0f37af38d6c4678e0128f4d2a464a7f29b8ad2cf..d166b22653ee91c67344563212a8f969e6a88dc7 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2016,2017,2018, by the GROMACS development team, led by
+ * Copyright (c) 2016,2017,2018,2019,2020,2021, by the GROMACS development team, led by
  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
  * and including many others, as listed in the AUTHORS file in the
  * top-level source directory and at http://www.gromacs.org.
  */
 
 /*! \internal \file
- * \brief This file defines the PME CUDA-specific data structure,
- * various compile-time constants shared among the PME CUDA kernels,
- * and also names some PME CUDA memory management routines.
- * TODO: consider changing defines into variables where possible; have inline getters.
+ * \brief This file defines the PME CUDA-specific kernel parameter data structure.
+ * \todo Rename the file (pme-gpu-types.cuh?), reconsider inheritance approach.
  *
  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  */
 #ifndef GMX_EWALD_PME_CUH
 #define GMX_EWALD_PME_CUH
 
-#include <cassert>
-
-#include <array>
-#include <set>
-
-#include "gromacs/gpu_utils/cuda_arch_utils.cuh" // for warp_size
-
-#include "pme-gpu-internal.h"                    // for the general PME GPU behaviour defines
-#include "pme-timings.cuh"
-
-class GpuParallel3dFft;
-
-/* Some defines for PME behaviour follow */
-
-/*
-    Here is a current memory layout for the theta/dtheta B-spline float parameter arrays.
-    This is the data in global memory used both by spreading and gathering kernels (with same scheduling).
-    This example has PME order 4 and 2 particles per warp/data chunk.
-    Each particle has 16 threads assigned to it, each thread works on 4 non-sequential global grid contributions.
-
-    ----------------------------------------------------------------------------
-    particles 0, 1                                        | particles 2, 3     | ...
-    ----------------------------------------------------------------------------
-    order index 0           | index 1 | index 2 | index 3 | order index 0 .....
-    ----------------------------------------------------------------------------
-    tx0 tx1 ty0 ty1 tz0 tz1 | ..........
-    ----------------------------------------------------------------------------
-
-    Each data chunk for a single warp is 24 floats. This goes both for theta and dtheta.
-    24 = 2 particles per warp * order 4 * 3 dimensions. 48 floats (1.5 warp size) per warp in total.
-    I have also tried intertwining theta and theta in a single array (they are used in pairs in gathering stage anyway)
-    and it didn't seem to make a performance difference.
-
-    The corresponding defines follow.
- */
-
-/* This is the distance between the neighbour theta elements - would be 2 for the intertwining layout */
-#define PME_SPLINE_THETA_STRIDE 1
-
-/*! \brief
- * The number of GPU threads used for computing spread/gather contributions of a single atom as function of the PME order.
- * The assumption is currently that any thread processes only a single atom's contributions.
- */
-#define PME_SPREADGATHER_THREADS_PER_ATOM (order * order)
-
-/*! \brief
- * The number of atoms processed by a single warp in spread/gather.
- * This macro depends on the templated order parameter (2 atoms per warp for order 4).
- * It is mostly used for spline data layout tweaked for coalesced access.
- */
-#define PME_SPREADGATHER_ATOMS_PER_WARP (warp_size / PME_SPREADGATHER_THREADS_PER_ATOM)
-
-/*! \brief
- * Atom data alignment (in terms of number of atoms).
- * If the GPU atom data buffers are padded (c_usePadding == true),
- * Then the numbers of atoms which would fit in the padded GPU buffers has to be divisible by this.
- * The literal number (16) expresses maximum spread/gather block width in warps.
- * Accordingly, spread and gather block widths in warps should be divisors of this
- * (e.g. in the pme-spread.cu: constexpr int c_spreadMaxThreadsPerBlock = 8 * warp_size;).
- * There are debug asserts for this divisibility.
- */
-#define PME_ATOM_DATA_ALIGNMENT (16 * PME_SPREADGATHER_ATOMS_PER_WARP)
-
-/*! \brief \internal
- * An inline CUDA function for checking the global atom data indices against the atom data array sizes.
- *
- * \param[in] atomDataIndexGlobal  The atom data index.
- * \param[in] nAtomData            The atom data array element count.
- * \returns                        Non-0 if index is within bounds (or PME data padding is enabled), 0 otherwise.
- *
- * This is called from the spline_and_spread and gather PME kernels.
- * The goal is to isolate the global range checks, and allow avoiding them with c_usePadding enabled.
- */
-int __device__ __forceinline__ pme_gpu_check_atom_data_index(const int atomDataIndex, const int nAtomData)
-{
-    return c_usePadding ? 1 : (atomDataIndex < nAtomData);
-}
-
-/*! \brief \internal
- * An inline CUDA function for skipping the zero-charge atoms.
- *
- * \returns                        Non-0 if atom should be processed, 0 otherwise.
- * \param[in] coefficient          The atom charge.
- *
- * This is called from the spline_and_spread and gather PME kernels.
- */
-int __device__ __forceinline__ pme_gpu_check_atom_charge(const float coefficient)
-{
-    assert(isfinite(coefficient));
-    return c_skipNeutralAtoms ? (coefficient != 0.0f) : 1;
-}
-
-/*! \brief \internal
- * Given possibly large \p blockCount, returns a compact 1D or 2D grid for kernel scheduling,
- * to minimize number of unused blocks.
- */
-template <typename PmeGpu>
-dim3 __host__ inline pmeGpuCreateGrid(const PmeGpu *pmeGpu, int blockCount)
-{
-    // How many maximum widths in X do we need (hopefully just one)
-    const int minRowCount = (blockCount + pmeGpu->maxGridWidthX - 1) / pmeGpu->maxGridWidthX;
-    // Trying to make things even
-    const int colCount = (blockCount + minRowCount - 1) / minRowCount;
-    GMX_ASSERT((colCount * minRowCount - blockCount) >= 0, "pmeGpuCreateGrid: totally wrong");
-    GMX_ASSERT((colCount * minRowCount - blockCount) < minRowCount, "pmeGpuCreateGrid: excessive blocks");
-    return dim3(colCount, minRowCount);
-}
-
-/*! \brief \internal
- * The main PME CUDA-specific host data structure, included in the PME GPU structure by the archSpecific pointer.
- */
-struct PmeGpuCuda
-{
-    /*! \brief The CUDA stream where everything related to the PME happens. */
-    cudaStream_t pmeStream;
-
-    /* Synchronization events */
-    /*! \brief Triggered after the grid has been copied to the host (after the spreading stage). */
-    cudaEvent_t syncSpreadGridD2H;
-
-    // TODO: consider moving some things below into the non-CUDA struct.
-
-    /* Settings which are set at the start of the run */
-    /*! \brief A boolean which tells whether the complex and real grids for cuFFT are different or same. Currenty true. */
-    bool performOutOfPlaceFFT;
-    /*! \brief A boolean which tells if the CUDA timing events are enabled.
-     *  False by default, can be enabled by setting the environment variable GMX_ENABLE_GPU_TIMING.
-     *  Note: will not be reliable when multiple GPU tasks are running concurrently on the same device context,
-     * as CUDA events on multiple streams are untrustworthy.
-     */
-    bool                                             useTiming;
-
-    std::vector<std::unique_ptr<GpuParallel3dFft > > fftSetup;
-
-    std::array<GpuRegionTimer, gtPME_EVENT_COUNT>    timingEvents;
-
-    std::set<size_t>                                 activeTimers; // indices into timingEvents
-
-    /* GPU arrays element counts (not the arrays sizes in bytes!).
-     * They might be larger than the actual meaningful data sizes.
-     * These are paired: the actual element count + the maximum element count that can fit in the current allocated memory.
-     * These integer pairs are mostly meaningful for the cu_realloc_buffered calls.
-     * As such, if cu_realloc_buffered is refactored, they can be freely changed, too.
-     * The only exceptions are realGridSize and complexGridSize which are also used for grid clearing/copying.
-     * TODO: these should live in a clean buffered container type, and be refactored in the NB/cudautils as well.
-     */
-    /*! \brief The kernelParams.atoms.coordinates float element count (actual)*/
-    int coordinatesSize;
-    /*! \brief The kernelParams.atoms.coordinates float element count (reserved) */
-    int coordinatesSizeAlloc;
-    /*! \brief The kernelParams.atoms.forces float element count (actual) */
-    int forcesSize;
-    /*! \brief The kernelParams.atoms.forces float element count (reserved) */
-    int forcesSizeAlloc;
-    /*! \brief The kernelParams.atoms.gridlineIndices int element count (actual) */
-    int gridlineIndicesSize;
-    /*! \brief The kernelParams.atoms.gridlineIndices int element count (reserved) */
-    int gridlineIndicesSizeAlloc;
-    /*! \brief Both the kernelParams.atoms.theta and kernelParams.atoms.dtheta float element count (actual) */
-    int splineDataSize;
-    /*! \brief Both the kernelParams.atoms.theta and kernelParams.atoms.dtheta float element count (reserved) */
-    int splineDataSizeAlloc;
-    /*! \brief The kernelParams.atoms.coefficients float element count (actual) */
-    int coefficientsSize;
-    /*! \brief The kernelParams.atoms.coefficients float element count (reserved) */
-    int coefficientsSizeAlloc;
-    /*! \brief The kernelParams.grid.splineValuesArray float element count (actual) */
-    int splineValuesSize;
-    /*! \brief The kernelParams.grid.splineValuesArray float element count (reserved) */
-    int splineValuesSizeAlloc;
-    /*! \brief The kernelParams.grid.realGrid float element count (actual) */
-    int realGridSize;
-    /*! \brief The kernelParams.grid.realGrid float element count (reserved) */
-    int realGridSizeAlloc;
-    /*! \brief The kernelParams.grid.fourierGrid float (not float2!) element count (actual) */
-    int complexGridSize;
-    /*! \brief The kernelParams.grid.fourierGrid float (not float2!) element count (reserved) */
-    int complexGridSizeAlloc;
-};
+#include "gromacs/math/vectypes.h" // for DIM
 
+#include "pme_gpu_constants.h"
+#include "pme_gpu_internal.h" // for GridOrdering
+#include "pme_gpu_types.h"
 
 /*! \brief \internal
- * A single structure encompassing all the PME data used in CUDA kernels.
- * This inherits from PmeGpuKernelParamsBase and adds a couple cudaTextureObject_t handles,
- * which we would like to avoid in plain C++.
+ * An alias for PME parameters in CUDA.
+ * \todo Remove if we decide to unify CUDA and OpenCL
  */
 struct PmeGpuCudaKernelParams : PmeGpuKernelParamsBase
 {
-    /* These are CUDA texture objects, related to the grid size. */
-    /*! \brief CUDA texture object for accessing grid.d_fractShiftsTable */
-    cudaTextureObject_t fractShiftsTableTexture;
-    /*! \brief CUDA texture object for accessing grid.d_gridlineIndicesTable */
-    cudaTextureObject_t gridlineIndicesTableTexture;
+    // Place CUDA-specific stuff here
 };
 
 #endif