93145d4e1e9807b6aa92197e912eff175e9a2c6f
[alexxy/gromacs.git] / 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 /*! \brief Hack to selectively enable some parts of PME during unit testing.
79  *
80  * Set to \c false by default. If any of the tests sets it to \c true, it will
81  * make the compatibility check consider PME to be supported in SYCL builds.
82  *
83  * Currently we don't have proper PME implementation with SYCL, but we still want
84  * to run tests for some of the kernels.
85  *
86  * \todo Remove after #3927 is done and PME is fully enabled in SYCL builds.
87  */
88 //NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
89 extern bool g_allowPmeWithSyclForTesting;
90
91 namespace gmx
92 {
93 template<typename>
94 class ArrayRef;
95 class ForceWithVirial;
96 class MDLogger;
97 enum class PinningPolicy : int;
98 class StepWorkload;
99
100 /*! \libinternal \brief Class for managing usage of separate PME-only ranks
101  *
102  * Used for checking if some parts of the code could not use PME-only ranks
103  *
104  */
105 class SeparatePmeRanksPermitted
106 {
107 public:
108     //! Disables PME ranks permitted flag with a reason
109     void disablePmeRanks(const std::string& reason);
110     //! Return status of PME ranks usage
111     bool permitSeparatePmeRanks() const;
112     //! Returns all reasons, for not using PME ranks
113     std::string reasonsWhyDisabled() const;
114
115 private:
116     //! Flag that informs whether simualtion could use dedicated PME ranks
117     bool permitSeparatePmeRanks_ = true;
118     //! Storage for all reasons, why PME ranks could not be used
119     std::vector<std::string> reasons_;
120 };
121
122 } // namespace gmx
123
124 enum
125 {
126     GMX_SUM_GRID_FORWARD,
127     GMX_SUM_GRID_BACKWARD
128 };
129
130 /*! \brief Possible PME codepaths on a rank.
131  * \todo: make this enum class with gmx_pme_t C++ refactoring
132  */
133 enum class PmeRunMode
134 {
135     None,  //!< No PME task is done
136     CPU,   //!< Whole PME computation is done on CPU
137     GPU,   //!< Whole PME computation is done on GPU
138     Mixed, //!< Mixed mode: only spread and gather run on GPU; FFT and solving are done on CPU.
139 };
140
141 /*! \brief Return the smallest allowed PME grid size for \p pmeOrder */
142 int minimalPmeGridSize(int pmeOrder);
143
144 //! Return whether the grid of \c pme is identical to \c grid_size.
145 bool gmx_pme_grid_matches(const gmx_pme_t& pme, const ivec grid_size);
146
147 /*! \brief Check restrictions on pme_order and the PME grid nkx,nky,nkz.
148  *
149  * With errorsAreFatal=true, an exception or fatal error is generated
150  * on violation of restrictions.
151  * With errorsAreFatal=false, false is returned on violation of restrictions.
152  * When all restrictions are obeyed, true is returned.
153  * Argument useThreads tells if any MPI rank doing PME uses more than 1 threads.
154  * If at calling useThreads is unknown, pass true for conservative checking.
155  *
156  * The PME GPU restrictions are checked separately during pme_gpu_init().
157  */
158 bool gmx_pme_check_restrictions(int  pme_order,
159                                 int  nkx,
160                                 int  nky,
161                                 int  nkz,
162                                 int  numPmeDomainsAlongX,
163                                 bool useThreads,
164                                 bool errorsAreFatal);
165
166 /*! \brief Construct PME data
167  *
168  * \throws   gmx::InconsistentInputError if input grid sizes/PME order are inconsistent.
169  * \returns  Pointer to newly allocated and initialized PME data.
170  *
171  * \todo We should evolve something like a \c GpuManager that holds \c
172  * DeviceInformation* and \c PmeGpuProgram* and perhaps other
173  * related things whose lifetime can/should exceed that of a task (or
174  * perhaps task manager). See Issue #2522.
175  */
176 gmx_pme_t* gmx_pme_init(const t_commrec*     cr,
177                         const NumPmeDomains& numPmeDomains,
178                         const t_inputrec*    ir,
179                         gmx_bool             bFreeEnergy_q,
180                         gmx_bool             bFreeEnergy_lj,
181                         gmx_bool             bReproducible,
182                         real                 ewaldcoeff_q,
183                         real                 ewaldcoeff_lj,
184                         int                  nthread,
185                         PmeRunMode           runMode,
186                         PmeGpu*              pmeGpu,
187                         const DeviceContext* deviceContext,
188                         const DeviceStream*  deviceStream,
189                         const PmeGpuProgram* pmeGpuProgram,
190                         const gmx::MDLogger& mdlog);
191
192 /*! \brief As gmx_pme_init, but takes most settings, except the grid/Ewald coefficients, from
193  * pme_src. This is only called when the PME cut-off/grid size changes.
194  */
195 void gmx_pme_reinit(gmx_pme_t**       pmedata,
196                     const t_commrec*  cr,
197                     gmx_pme_t*        pme_src,
198                     const t_inputrec* ir,
199                     const ivec        grid_size,
200                     real              ewaldcoeff_q,
201                     real              ewaldcoeff_lj);
202
203 /*! \brief Destroys the PME data structure.*/
204 void gmx_pme_destroy(gmx_pme_t* pme);
205
206 /*! \brief Do a PME calculation on a CPU for the long range electrostatics and/or LJ.
207  *
208  * Computes the PME forces and the energy and viral, when requested,
209  * for all atoms in \p coordinates. Forces, when requested, are added
210  * to the buffer \p forces, which is allowed to contain more elements
211  * than the number of elements in \p coordinates.
212  * The meaning of \p flags is defined above, and determines which
213  * parts of the calculation are performed.
214  *
215  * \return 0 indicates all well, non zero is an error code.
216  */
217 int gmx_pme_do(struct gmx_pme_t*              pme,
218                gmx::ArrayRef<const gmx::RVec> coordinates,
219                gmx::ArrayRef<gmx::RVec>       forces,
220                gmx::ArrayRef<const real>      chargeA,
221                gmx::ArrayRef<const real>      chargeB,
222                gmx::ArrayRef<const real>      c6A,
223                gmx::ArrayRef<const real>      c6B,
224                gmx::ArrayRef<const real>      sigmaA,
225                gmx::ArrayRef<const real>      sigmaB,
226                const matrix                   box,
227                const t_commrec*               cr,
228                int                            maxshift_x,
229                int                            maxshift_y,
230                t_nrnb*                        nrnb,
231                gmx_wallcycle*                 wcycle,
232                matrix                         vir_q,
233                matrix                         vir_lj,
234                real*                          energy_q,
235                real*                          energy_lj,
236                real                           lambda_q,
237                real                           lambda_lj,
238                real*                          dvdlambda_q,
239                real*                          dvdlambda_lj,
240                const gmx::StepWorkload&       stepWork);
241
242 /*! \brief Calculate the PME grid energy V for n charges.
243  *
244  * The potential (found in \p pme) must have been found already with a
245  * call to gmx_pme_do(). Note that the charges are not spread on the grid in the
246  * pme struct. Currently does not work in parallel or with free
247  * energy.
248  */
249 real gmx_pme_calc_energy(gmx_pme_t* pme, gmx::ArrayRef<const gmx::RVec> x, gmx::ArrayRef<const real> q);
250
251 /*! \brief
252  * This function updates the local atom data on GPU after DD (charges, coordinates, etc.).
253  * TODO: it should update the PME CPU atom data as well.
254  * (currently PME CPU call gmx_pme_do() gets passed the input pointers for each computation).
255  *
256  * \param[in,out] pme        The PME structure.
257  * \param[in]     numAtoms   The number of particles.
258  * \param[in]     chargesA   The pointer to the array of particle charges in the normal state or FEP
259  * state A. Can be nullptr if PME is not performed on the GPU.
260  * \param[in]     chargesB   The pointer to the array of particle charges in state B. Only used if
261  * charges are perturbed and can otherwise be nullptr.
262  */
263 void gmx_pme_reinit_atoms(gmx_pme_t*                pme,
264                           int                       numAtoms,
265                           gmx::ArrayRef<const real> chargesA,
266                           gmx::ArrayRef<const real> chargesB);
267
268 /* A block of PME GPU functions */
269
270 /*! \brief Checks whether the GROMACS build allows to run PME on GPU.
271  * TODO: this partly duplicates an internal PME assert function
272  * pme_gpu_check_restrictions(), except that works with a
273  * formed gmx_pme_t structure. Should that one go away/work with inputrec?
274  *
275  * \param[out] error   If non-null, the error message when PME is not supported on GPU.
276  *
277  * \returns true if PME can run on GPU on this build, false otherwise.
278  */
279 bool pme_gpu_supports_build(std::string* error);
280
281 /*! \brief Checks whether the detected (GPU) hardware allows to run PME on GPU.
282  *
283  * \param[in]  hwinfo  Information about the detected hardware
284  * \param[out] error   If non-null, the error message when PME is not supported on GPU.
285  *
286  * \returns true if PME can run on GPU on this build, false otherwise.
287  */
288 bool pme_gpu_supports_hardware(const gmx_hw_info_t& hwinfo, std::string* error);
289
290 /*! \brief Checks whether the input system allows to run PME on GPU.
291  * TODO: this partly duplicates an internal PME assert function
292  * pme_gpu_check_restrictions(), except that works with a
293  * formed gmx_pme_t structure. Should that one go away/work with inputrec?
294  *
295  * \param[in]  ir     Input system.
296  * \param[out] error  If non-null, the error message if the input is not supported on GPU.
297  *
298  * \returns true if PME can run on GPU with this input, false otherwise.
299  */
300 bool pme_gpu_supports_input(const t_inputrec& ir, std::string* error);
301
302 /*! \brief
303  * Returns the active PME codepath (CPU, GPU, mixed).
304  * \todo This is a rather static data that should be managed by the higher level task scheduler.
305  *
306  * \param[in]  pme            The PME data structure.
307  * \returns active PME codepath.
308  */
309 PmeRunMode pme_run_mode(const gmx_pme_t* pme);
310
311 /*! \libinternal \brief
312  * Return the pinning policy appropriate for this build configuration
313  * for relevant buffers used for PME task on this rank (e.g. running
314  * on a GPU). */
315 gmx::PinningPolicy pme_get_pinning_policy();
316
317 /*! \brief
318  * Tells if PME is enabled to run on GPU (not necessarily active at the moment).
319  * \todo This is a rather static data that should be managed by the hardware assignment manager.
320  * For now, it is synonymous with the active PME codepath (in the absence of dynamic switching).
321  *
322  * \param[in]  pme            The PME data structure.
323  * \returns true if PME can run on GPU, false otherwise.
324  */
325 inline bool pme_gpu_task_enabled(const gmx_pme_t* pme)
326 {
327     return (pme != nullptr) && (pme_run_mode(pme) != PmeRunMode::CPU);
328 }
329
330 /*! \brief Returns the block size requirement
331  *
332  * The GPU version of PME requires that the coordinates array have a
333  * size divisible by the returned number.
334  *
335  * \param[in]  pme  The PME data structure.
336  */
337 GPU_FUNC_QUALIFIER int pme_gpu_get_block_size(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
338         GPU_FUNC_TERM_WITH_RETURN(0);
339
340 // The following functions are all the PME GPU entry points,
341 // currently inlining to nothing on non-CUDA builds.
342
343 /*! \brief
344  * Resets the PME GPU timings. To be called at the reset step.
345  *
346  * \param[in] pme            The PME structure.
347  */
348 GPU_FUNC_QUALIFIER void pme_gpu_reset_timings(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme)) GPU_FUNC_TERM;
349
350 /*! \brief
351  * Copies the PME GPU timings to the gmx_wallclock_gpu_pme_t structure (for log output). To be called at the run end.
352  *
353  * \param[in] pme               The PME structure.
354  * \param[in] timings           The gmx_wallclock_gpu_pme_t structure.
355  */
356 GPU_FUNC_QUALIFIER void pme_gpu_get_timings(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
357                                             gmx_wallclock_gpu_pme_t* GPU_FUNC_ARGUMENT(timings)) GPU_FUNC_TERM;
358
359 /* The main PME GPU functions */
360
361 /*! \brief
362  * Prepares PME on GPU computation (updating the box if needed)
363  * \param[in] pme               The PME data structure.
364  * \param[in] box               The unit cell box.
365  * \param[in] wcycle            The wallclock counter.
366  * \param[in] stepWork          The required work for this simulation step
367  */
368 GPU_FUNC_QUALIFIER void pme_gpu_prepare_computation(gmx_pme_t*     GPU_FUNC_ARGUMENT(pme),
369                                                     const matrix   GPU_FUNC_ARGUMENT(box),
370                                                     gmx_wallcycle* GPU_FUNC_ARGUMENT(wcycle),
371                                                     const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork)) GPU_FUNC_TERM;
372
373 /*! \brief
374  * Launches first stage of PME on GPU - spreading kernel.
375  *
376  * \param[in] pme                The PME data structure.
377  * \param[in] xReadyOnDevice     Event synchronizer indicating that the coordinates
378  * are ready in the device memory; nullptr allowed only on separate PME ranks.
379  * \param[in] wcycle             The wallclock counter.
380  * \param[in] lambdaQ            The Coulomb lambda of the current state of the
381  * system. Only used if FEP of Coulomb is active.
382  */
383 GPU_FUNC_QUALIFIER void pme_gpu_launch_spread(gmx_pme_t*            GPU_FUNC_ARGUMENT(pme),
384                                               GpuEventSynchronizer* GPU_FUNC_ARGUMENT(xReadyOnDevice),
385                                               gmx_wallcycle*        GPU_FUNC_ARGUMENT(wcycle),
386                                               real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
387
388 /*! \brief
389  * Launches middle stages of PME (FFT R2C, solving, FFT C2R) either on GPU or on CPU, depending on the run mode.
390  *
391  * \param[in] pme               The PME data structure.
392  * \param[in] wcycle            The wallclock counter.
393  * \param[in] stepWork          The required work for this simulation step
394  */
395 GPU_FUNC_QUALIFIER void
396 pme_gpu_launch_complex_transforms(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
397                                   gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
398                                   const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork)) GPU_FUNC_TERM;
399
400 /*! \brief
401  * Launches last stage of PME on GPU - force gathering and D2H force transfer.
402  *
403  * \param[in] pme               The PME data structure.
404  * \param[in] wcycle            The wallclock counter.
405  * \param[in] lambdaQ           The Coulomb lambda to use when calculating the results.
406  */
407 GPU_FUNC_QUALIFIER void pme_gpu_launch_gather(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
408                                               gmx_wallcycle*   GPU_FUNC_ARGUMENT(wcycle),
409                                               real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
410
411 /*! \brief
412  * Attempts to complete PME GPU tasks.
413  *
414  * The \p completionKind argument controls whether the function blocks until all
415  * PME GPU tasks enqueued completed (as pme_gpu_wait_finish_task() does) or only
416  * checks and returns immediately if they did not.
417  * When blocking or the tasks have completed it also gets the output forces
418  * by assigning the ArrayRef to the \p forces pointer passed in.
419  * Virial/energy are also outputs if they were to be computed.
420  *
421  * \param[in]  pme             The PME data structure.
422  * \param[in]  stepWork        The required work for this simulation step
423  * \param[in]  wcycle          The wallclock counter.
424  * \param[out] forceWithVirial The output force and virial
425  * \param[out] enerd           The output energies
426  * \param[in]  lambdaQ         The Coulomb lambda to use when calculating the results.
427  * \param[in]  completionKind  Indicates whether PME task completion should only be checked rather
428  *                             than waited for
429  * \returns                    True if the PME GPU tasks have completed
430  */
431 GPU_FUNC_QUALIFIER bool pme_gpu_try_finish_task(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
432                                                 const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork),
433                                                 gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
434                                                 gmx::ForceWithVirial* GPU_FUNC_ARGUMENT(forceWithVirial),
435                                                 gmx_enerdata_t*       GPU_FUNC_ARGUMENT(enerd),
436                                                 real                  GPU_FUNC_ARGUMENT(lambdaQ),
437                                                 GpuTaskCompletion GPU_FUNC_ARGUMENT(completionKind))
438         GPU_FUNC_TERM_WITH_RETURN(false);
439
440 /*! \brief
441  * Blocks until PME GPU tasks are completed, and gets the output forces and virial/energy
442  * (if they were to be computed).
443  *
444  * \param[in]  pme             The PME data structure.
445  * \param[in]  stepWork        The required work for this simulation step
446  * \param[in]  wcycle          The wallclock counter.
447  * \param[out] forceWithVirial The output force and virial
448  * \param[out] enerd           The output energies
449  * \param[in]  lambdaQ         The Coulomb lambda to use when calculating the results.
450  */
451 GPU_FUNC_QUALIFIER void pme_gpu_wait_and_reduce(gmx_pme_t*               GPU_FUNC_ARGUMENT(pme),
452                                                 const gmx::StepWorkload& GPU_FUNC_ARGUMENT(stepWork),
453                                                 gmx_wallcycle*           GPU_FUNC_ARGUMENT(wcycle),
454                                                 gmx::ForceWithVirial* GPU_FUNC_ARGUMENT(forceWithVirial),
455                                                 gmx_enerdata_t*       GPU_FUNC_ARGUMENT(enerd),
456                                                 real GPU_FUNC_ARGUMENT(lambdaQ)) GPU_FUNC_TERM;
457
458 /*! \brief
459  * The PME GPU reinitialization function that is called both at the end of any PME computation and on any load balancing.
460  *
461  * Clears the internal grid and energy/virial buffers; it is not safe to start
462  * the PME computation without calling this.
463  * Note that unlike in the nbnxn module, the force buffer does not need clearing.
464  *
465  * \todo Rename this function to *clear* -- it clearly only does output resetting
466  * and we should be clear about what the function does..
467  *
468  * \param[in] pme            The PME data structure.
469  * \param[in] wcycle         The wallclock counter.
470  */
471 GPU_FUNC_QUALIFIER void pme_gpu_reinit_computation(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme),
472                                                    gmx_wallcycle* GPU_FUNC_ARGUMENT(wcycle)) GPU_FUNC_TERM;
473
474 /*! \brief Set pointer to device copy of coordinate data.
475  * \param[in] pme            The PME data structure.
476  * \param[in] d_x            The pointer to the positions buffer to be set
477  */
478 GPU_FUNC_QUALIFIER void pme_gpu_set_device_x(const gmx_pme_t*        GPU_FUNC_ARGUMENT(pme),
479                                              DeviceBuffer<gmx::RVec> GPU_FUNC_ARGUMENT(d_x)) GPU_FUNC_TERM;
480
481 /*! \brief Get pointer to device copy of force data.
482  * \param[in] pme            The PME data structure.
483  * \returns                  Pointer to force data
484  */
485 GPU_FUNC_QUALIFIER DeviceBuffer<gmx::RVec> pme_gpu_get_device_f(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
486         GPU_FUNC_TERM_WITH_RETURN(DeviceBuffer<gmx::RVec>{});
487
488 /*! \brief Get pointer to the device synchronizer object that allows syncing on PME force calculation completion
489  * \param[in] pme            The PME data structure.
490  * \returns                  Pointer to synchronizer
491  */
492 GPU_FUNC_QUALIFIER GpuEventSynchronizer* pme_gpu_get_f_ready_synchronizer(const gmx_pme_t* GPU_FUNC_ARGUMENT(pme))
493         GPU_FUNC_TERM_WITH_RETURN(nullptr);
494
495 #endif