src/gromacs/ewald/pme.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \libinternal \file
  39  *
  40  * \brief This file contains function declarations necessary for
  41  * computing energies and forces for the PME long-ranged part (Coulomb
  42  * and LJ).
  43  *
  44  * \author Berk Hess <hess@kth.se>
  45  * \inlibraryapi
  46  * \ingroup module_ewald
  47  */
  48
  49 #ifndef GMX_EWALD_PME_H
  50 #define GMX_EWALD_PME_H
  51
  52 #include <string>
  53 #include <vector>
  54
  55 #include "gromacs/gpu_utils/devicebuffer_datatype.h"
  56 #include "gromacs/gpu_utils/gpu_macros.h"
  57 #include "gromacs/math/vectypes.h"
  58 #include "gromacs/utility/real.h"
  59
  60 struct gmx_hw_info_t;
  61 struct t_commrec;
  62 struct t_inputrec;
  63 struct t_nrnb;
  64 struct PmeGpu;
  65 struct gmx_wallclock_gpu_pme_t;
  66 struct gmx_enerdata_t;
  67 struct gmx_mtop_t;
  68 struct gmx_pme_t;
  69 struct gmx_wallcycle;
  70 struct NumPmeDomains;
  71
  72 class DeviceContext;
  73 class DeviceStream;
  74 enum class GpuTaskCompletion;
  75 class PmeGpuProgram;
  76 class GpuEventSynchronizer;
  77
  78 namespace gmx
  79 {
  80 template<typename>
  81 class ArrayRef;
  82 class ForceWithVirial;
  83 class MDLogger;
  84 enum class PinningPolicy : int;
  85 class StepWorkload;
  86
  87 /*! \libinternal \brief Class for managing usage of separate PME-only ranks
  88  *
  89  * Used for checking if some parts of the code could not use PME-only ranks
  90  *
  91  */
  92 class SeparatePmeRanksPermitted
  93 {
  94 public:
  95     //! Disables PME ranks permitted flag with a reason
  96     void disablePmeRanks(const std::string& reason);
  97     //! Return status of PME ranks usage
  98     bool permitSeparatePmeRanks() const;
  99     //! Returns all reasons, for not using PME ranks
 100     std::string reasonsWhyDisabled() const;
 101
 102 private:
 103     //! Flag that informs whether simualtion could use dedicated PME ranks
 104     bool permitSeparatePmeRanks_ = true;
 105     //! Storage for all reasons, why PME ranks could not be used
 106     std::vector<std::string> reasons_;
 107 };
 108
 109 } // namespace gmx
 110
 111 enum
 112 {
 113     GMX_SUM_GRID_FORWARD,
 114     GMX_SUM_GRID_BACKWARD
 115 };
 116
 117 /*! \brief Possible PME codepaths on a rank.
 118  * \todo: make this enum class with gmx_pme_t C++ refactoring
 119  */
 120 enum class PmeRunMode
 121 {
 122     None,  //!< No PME task is done
 123     CPU,   //!< Whole PME computation is done on CPU
 124     GPU,   //!< Whole PME computation is done on GPU
 125     Mixed, //!< Mixed mode: only spread and gather run on GPU; FFT and solving are done on CPU.
 126 };
 127
 128 /*! \brief Return the smallest allowed PME grid size for \p pmeOrder */
 129 int minimalPmeGridSize(int pmeOrder);
 130
 131 //! Return whether the grid of \c pme is identical to \c grid_size.
 132 bool gmx_pme_grid_matches(const gmx_pme_t& pme, const ivec grid_size);
 133
 134 /*! \brief Check restrictions on pme_order and the PME grid nkx,nky,nkz.
 135  *
 136  * With errorsAreFatal=true, an exception or fatal error is generated
 137  * on violation of restrictions.
 138  * With errorsAreFatal=false, false is returned on violation of restrictions.
 139  * When all restrictions are obeyed, true is returned.
 140  * Argument useThreads tells if any MPI rank doing PME uses more than 1 threads.
 141  * If at calling useThreads is unknown, pass true for conservative checking.
 142  *
 143  * The PME GPU restrictions are checked separately during pme_gpu_init().
 144  */
 145 bool gmx_pme_check_restrictions(int  pme_order,
 146                                 int  nkx,
 147                                 int  nky,
 148                                 int  nkz,
 149                                 int  numPmeDomainsAlongX,
 150                                 bool useThreads,
 151                                 bool errorsAreFatal);
 152
 153 /*! \brief Construct PME data
 154  *
 155  * \throws   gmx::InconsistentInputError if input grid sizes/PME order are inconsistent.
 156  * \returns  Pointer to newly allocated and initialized PME data.
 157  *
 158  * \todo We should evolve something like a \c GpuManager that holds \c
 159  * DeviceInformation* and \c PmeGpuProgram* and perhaps other
 160  * related things whose lifetime can/should exceed that of a task (or
 161  * perhaps task manager). See Issue #2522.
 162  */
 163 gmx_pme_t* gmx_pme_init(const t_commrec*     cr,
 164                         const NumPmeDomains& numPmeDomains,
 165                         const t_inputrec*    ir,
 166                         gmx_bool             bFreeEnergy_q,
 167                         gmx_bool             bFreeEnergy_lj,
 168                         gmx_bool             bReproducible,
 169                         real                 ewaldcoeff_q,
 170                         real                 ewaldcoeff_lj,
 171                         int                  nthread,
 172                         PmeRunMode           runMode,
 173                         PmeGpu*              pmeGpu,
 174                         const DeviceContext* deviceContext,
 175                         const DeviceStream*  deviceStream,
 176                         const PmeGpuProgram* pmeGpuProgram,
 177                         const gmx::MDLogger& mdlog);
 178
 179 /*! \brief As gmx_pme_init, but takes most settings, except the grid/Ewald coefficients, from
 180  * pme_src. This is only called when the PME cut-off/grid size changes.
 181  */
 182 void gmx_pme_reinit(gmx_pme_t**       pmedata,
 183                     const t_commrec*  cr,
 184                     gmx_pme_t*        pme_src,
 185                     const t_inputrec* ir,
 186                     const ivec        grid_size,
 187                     real              ewaldcoeff_q,
 188                     real              ewaldcoeff_lj);
 189
 190 /*! \brief Destroys the PME data structure.*/
 191 void gmx_pme_destroy(gmx_pme_t* pme);
 192
 193 /*! \brief Do a PME calculation on a CPU for the long range electrostatics and/or LJ.
 194  *
 195  * Computes the PME forces and the energy and viral, when requested,
 196  * for all atoms in \p coordinates. Forces, when requested, are added
 197  * to the buffer \p forces, which is allowed to contain more elements
 198  * than the number of elements in \p coordinates.
 199  * The meaning of \p flags is defined above, and determines which
 200  * parts of the calculation are performed.
 201  *
 202  * \return 0 indicates all well, non zero is an error code.
 203  */
 204 int gmx_pme_do(struct gmx_pme_t*              pme,
 205                gmx::ArrayRef<const gmx::RVec> coordinates,
 206                gmx::ArrayRef<gmx::RVec>       forces,
 207                gmx::ArrayRef<const real>      chargeA,
 208                gmx::ArrayRef<const real>      chargeB,
 209                gmx::ArrayRef<const real>      c6A,
 210                gmx::ArrayRef<const real>      c6B,
 211                gmx::ArrayRef<const real>      sigmaA,
 212                gmx::ArrayRef<const real>      sigmaB,
 213                const matrix                   box,
 214                const t_commrec*               cr,
 215                int                            maxshift_x,
 216                int                            maxshift_y,
 217                t_nrnb*                        nrnb,
 218                gmx_wallcycle*                 wcycle,
 219                matrix                         vir_q,
 220                matrix                         vir_lj,
 221                real*                          energy_q,
 222                real*                          energy_lj,
 223                real                           lambda_q,
 224                real                           lambda_lj,
 225                real*                          dvdlambda_q,
 226                real*                          dvdlambda_lj,
 227                const gmx::StepWorkload&       stepWork);
 228
 229 /*! \brief Calculate the PME grid energy V for n charges.
 230  *
 231  * The potential (found in \p pme) must have been found already with a
 232  * call to gmx_pme_do(). Note that the charges are not spread on the grid in the
 233  * pme struct. Currently does not work in parallel or with free
 234  * energy.
 235  */
 236 void gmx_pme_calc_energy(gmx_pme_t* pme, gmx::ArrayRef<const gmx::RVec> x, gmx::ArrayRef<const real> q, real* V);
 237
 238 /*! \brief
 239  * This function updates the local atom data on GPU after DD (charges, coordinates, etc.).
 240  * TODO: it should update the PME CPU atom data as well.
 241  * (currently PME CPU call gmx_pme_do() gets passed the input pointers for each computation).
 242  *
 243  * \param[in,out] pme        The PME structure.
 244  * \param[in]     numAtoms   The number of particles.
 245  * \param[in]     chargesA   The pointer to the array of particle charges in the normal state or FEP
 246  * state A. Can be nullptr if PME is not performed on the GPU.
 247  * \param[in]     chargesB   The pointer to the array of particle charges in state B. Only used if
 248  * charges are perturbed and can otherwise be nullptr.
 249  */
 250 void gmx_pme_reinit_atoms(gmx_pme_t* pme, int numAtoms, const real* chargesA, const real* chargesB);
 251
 252 /* A block of PME GPU functions */
 253
 254 /*! \brief Checks whether the GROMACS build allows to run PME on GPU.
 255  * TODO: this partly duplicates an internal PME assert function
 256  * pme_gpu_check_restrictions(), except that works with a
 257  * formed gmx_pme_t structure. Should that one go away/work with inputrec?
 258  *
 259  * \param[out] error   If non-null, the error message when PME is not supported on GPU.
 260  *
 261  * \returns true if PME can run on GPU on this build, false otherwise.
 262  */
 263 bool pme_gpu_supports_build(std::string* error);
 264
 265 /*! \brief Checks whether the detected (GPU) hardware allows to run PME on GPU.
 266  *
 267  * \param[in]  hwinfo  Information about the detected hardware
 268  * \param[out] error   If non-null, the error message when PME is not supported on GPU.
 269  *
 270  * \returns true if PME can run on GPU on this build, false otherwise.
 271  */
 272 bool pme_gpu_supports_hardware(const gmx_hw_info_t& hwinfo, std::string* error);
 273
 274 /*! \brief Checks whether the input system allows to run PME on GPU.
 275  * TODO: this partly duplicates an internal PME assert function
 276  * pme_gpu_check_restrictions(), except that works with a
 277  * formed gmx_pme_t structure. Should that one go away/work with inputrec?
 278  *
 279  * \param[in]  ir     Input system.
 280  * \param[out] error  If non-null, the error message if the input is not supported on GPU.
 281  *
 282  * \returns true if PME can run on GPU with this input, false otherwise.
 283  */
 284 bool pme_gpu_supports_input(const t_inputrec& ir, std::string* error);
 285
 286 /*! \brief
 287  * Returns the active PME codepath (CPU, GPU, mixed).
 288  * \todo This is a rather static data that should be managed by the higher level task scheduler.
 289  *
 290  * \param[in]  pme            The PME data structure.
 291  * \returns active PME codepath.
 292  */
 293 PmeRunMode pme_run_mode(const gmx_pme_t* pme);
 294
 295 /*! \libinternal \brief
 296  * Return the pinning policy appropriate for this build configuration
 297  * for relevant buffers used for PME task on this rank (e.g. running
 298  * on a GPU). */
 299 gmx::PinningPolicy pme_get_pinning_policy();
 300
 301 /*! \brief
 302  * Tells if PME is enabled to run on GPU (not necessarily active at the moment).
 303  * \todo This is a rather static data that should be managed by the hardware assignment manager.
 304  * For now, it is synonymous with the active PME codepath (in the absence of dynamic switching).
 305  *
 306  * \param[in]  pme            The PME data structure.
 307  * \returns true if PME can run on GPU, false otherwise.
 308  */
 309 inline bool pme_gpu_task_enabled(const gmx_pme_t* pme)
 310 {
 311     return (pme != nullptr) && (pme_run_mode(pme) != PmeRunMode::CPU);
 312 }
 313
 314 /*! \brief Returns the block size requirement
 315  *
 316  * The GPU version of PME requires that the coordinates array have a
 317  * size divisible by the returned number.
 318  *
 319  * \param[in]  pme  The PME data structure.
 320  */
 321 GPU_FUNC_QUALIFIER int pme_gpu_get_block_size(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
 322         GPU_FUNC_TERM_WITH_RETURN(0);
 323
 324 // The following functions are all the PME GPU entry points,
 325 // currently inlining to nothing on non-CUDA builds.
 326
 327 /*! \brief
 328  * Resets the PME GPU timings. To be called at the reset step.
 329  *
 330  * \param[in] pme            The PME structure.
 331  */
 332 GPU_FUNC_QUALIFIER void pme_gpu_reset_timings(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme)) GPU_FUNC_TERM;
 333
 334 /*! \brief
 335  * Copies the PME GPU timings to the gmx_wallclock_gpu_pme_t structure (for log output). To be called at the run end.
 336  *
 337  * \param[in] pme               The PME structure.
 338  * \param[in] timings           The gmx_wallclock_gpu_pme_t structure.
 339  */
 340 GPU_FUNC_QUALIFIER void pme_gpu_get_timings(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
 341                                             gmx_wallclock_gpu_pme_t* GPU_FUNC_ARGUMENT(timings)) GPU_FUNC_TERM;
 342
 343 /* The main PME GPU functions */
 344
 345 /*! \brief
 346  * Prepares PME on GPU computation (updating the box if needed)
 347  * \param[in] pme               The PME data structure.
 348  * \param[in] box               The unit cell box.
 349  * \param[in] wcycle            The wallclock counter.
 350  * \param[in] stepWork          The required work for this simulation step
 351  */
 352 GPU_FUNC_QUALIFIER void pme_gpu_prepare_computation(gmx_pme_t*     GPU_FUNC_ARGUMENT(pme),
 353                                                     const matrix   GPU_FUNC_ARGUMENT(box),
 354                                                     gmx_wallcycle* GPU_FUNC_ARGUMENT(wcycle),
 355                                                     const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork)) GPU_FUNC_TERM;
 356
 357 /*! \brief
 358  * Launches first stage of PME on GPU - spreading kernel.
 359  *
 360  * \param[in] pme                The PME data structure.
 361  * \param[in] xReadyOnDevice     Event synchronizer indicating that the coordinates
 362  * are ready in the device memory; nullptr allowed only on separate PME ranks.
 363  * \param[in] wcycle             The wallclock counter.
 364  * \param[in] lambdaQ            The Coulomb lambda of the current state of the
 365  * system. Only used if FEP of Coulomb is active.
 366  */
 367 GPU_FUNC_QUALIFIER void pme_gpu_launch_spread(gmx_pme_t*            GPU_FUNC_ARGUMENT(pme),
 368                                               GpuEventSynchronizer* GPU_FUNC_ARGUMENT(xReadyOnDevice),
 369                                               gmx_wallcycle*        GPU_FUNC_ARGUMENT(wcycle),
 370                                               real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
 371
 372 /*! \brief
 373  * Launches middle stages of PME (FFT R2C, solving, FFT C2R) either on GPU or on CPU, depending on the run mode.
 374  *
 375  * \param[in] pme               The PME data structure.
 376  * \param[in] wcycle            The wallclock counter.
 377  * \param[in] stepWork          The required work for this simulation step
 378  */
 379 GPU_FUNC_QUALIFIER void
 380 pme_gpu_launch_complex_transforms(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
 381                                   gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
 382                                   const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork)) GPU_FUNC_TERM;
 383
 384 /*! \brief
 385  * Launches last stage of PME on GPU - force gathering and D2H force transfer.
 386  *
 387  * \param[in] pme               The PME data structure.
 388  * \param[in] wcycle            The wallclock counter.
 389  * \param[in] lambdaQ           The Coulomb lambda to use when calculating the results.
 390  */
 391 GPU_FUNC_QUALIFIER void pme_gpu_launch_gather(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
 392                                               gmx_wallcycle*   GPU_FUNC_ARGUMENT(wcycle),
 393                                               real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
 394
 395 /*! \brief
 396  * Attempts to complete PME GPU tasks.
 397  *
 398  * The \p completionKind argument controls whether the function blocks until all
 399  * PME GPU tasks enqueued completed (as pme_gpu_wait_finish_task() does) or only
 400  * checks and returns immediately if they did not.
 401  * When blocking or the tasks have completed it also gets the output forces
 402  * by assigning the ArrayRef to the \p forces pointer passed in.
 403  * Virial/energy are also outputs if they were to be computed.
 404  *
 405  * \param[in]  pme             The PME data structure.
 406  * \param[in]  stepWork        The required work for this simulation step
 407  * \param[in]  wcycle          The wallclock counter.
 408  * \param[out] forceWithVirial The output force and virial
 409  * \param[out] enerd           The output energies
 410  * \param[in]  lambdaQ         The Coulomb lambda to use when calculating the results.
 411  * \param[in]  completionKind  Indicates whether PME task completion should only be checked rather
 412  *                             than waited for
 413  * \returns                    True if the PME GPU tasks have completed
 414  */
 415 GPU_FUNC_QUALIFIER bool pme_gpu_try_finish_task(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
 416                                                 const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork),
 417                                                 gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
 418                                                 gmx::ForceWithVirial* GPU_FUNC_ARGUMENT(forceWithVirial),
 419                                                 gmx_enerdata_t*       GPU_FUNC_ARGUMENT(enerd),
 420                                                 real                  GPU_FUNC_ARGUMENT(lambdaQ),
 421                                                 GpuTaskCompletion GPU_FUNC_ARGUMENT(completionKind))
 422         GPU_FUNC_TERM_WITH_RETURN(false);
 423
 424 /*! \brief
 425  * Blocks until PME GPU tasks are completed, and gets the output forces and virial/energy
 426  * (if they were to be computed).
 427  *
 428  * \param[in]  pme             The PME data structure.
 429  * \param[in]  stepWork        The required work for this simulation step
 430  * \param[in]  wcycle          The wallclock counter.
 431  * \param[out] forceWithVirial The output force and virial
 432  * \param[out] enerd           The output energies
 433  * \param[in]  lambdaQ         The Coulomb lambda to use when calculating the results.
 434  */
 435 GPU_FUNC_QUALIFIER void pme_gpu_wait_and_reduce(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
 436                                                 const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork),
 437                                                 gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
 438                                                 gmx::ForceWithVirial* GPU_FUNC_ARGUMENT(forceWithVirial),
 439                                                 gmx_enerdata_t*       GPU_FUNC_ARGUMENT(enerd),
 440                                                 real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
 441
 442 /*! \brief
 443  * The PME GPU reinitialization function that is called both at the end of any PME computation and on any load balancing.
 444  *
 445  * Clears the internal grid and energy/virial buffers; it is not safe to start
 446  * the PME computation without calling this.
 447  * Note that unlike in the nbnxn module, the force buffer does not need clearing.
 448  *
 449  * \todo Rename this function to *clear* -- it clearly only does output resetting
 450  * and we should be clear about what the function does..
 451  *
 452  * \param[in] pme            The PME data structure.
 453  * \param[in] wcycle         The wallclock counter.
 454  */
 455 GPU_FUNC_QUALIFIER void pme_gpu_reinit_computation(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
 456                                                    gmx_wallcycle* GPU_FUNC_ARGUMENT(wcycle)) GPU_FUNC_TERM;
 457
 458 /*! \brief Set pointer to device copy of coordinate data.
 459  * \param[in] pme            The PME data structure.
 460  * \param[in] d_x            The pointer to the positions buffer to be set
 461  */
 462 GPU_FUNC_QUALIFIER void pme_gpu_set_device_x(const gmx_pme_t*        GPU_FUNC_ARGUMENT(pme),
 463                                              DeviceBuffer<gmx::RVec> GPU_FUNC_ARGUMENT(d_x)) GPU_FUNC_TERM;
 464
 465 /*! \brief Get pointer to device copy of force data.
 466  * \param[in] pme            The PME data structure.
 467  * \returns                  Pointer to force data
 468  */
 469 GPU_FUNC_QUALIFIER DeviceBuffer<gmx::RVec> pme_gpu_get_device_f(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
 470         GPU_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
 471
 472 /*! \brief Get pointer to the device synchronizer object that allows syncing on PME force calculation completion
 473  * \param[in] pme            The PME data structure.
 474  * \returns                  Pointer to synchronizer
 475  */
 476 GPU_FUNC_QUALIFIER GpuEventSynchronizer* pme_gpu_get_f_ready_synchronizer(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
 477         GPU_FUNC_TERM_WITH_RETURN(nullptr);
 478
 479 #endif