Restrict scope of step and step_rel
[alexxy/gromacs.git] / src / gromacs / mdrun / runner.cpp
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) 2011-2019,2020,2021, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37 /*! \internal \file
38  *
39  * \brief Implements the MD runner routine calling all integrators.
40  *
41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
42  * \ingroup module_mdrun
43  */
44 #include "gmxpre.h"
45
46 #include "runner.h"
47
48 #include "config.h"
49
50 #include <cassert>
51 #include <cinttypes>
52 #include <csignal>
53 #include <cstdlib>
54 #include <cstring>
55
56 #include <algorithm>
57 #include <memory>
58
59 #include "gromacs/commandline/filenm.h"
60 #include "gromacs/domdec/builder.h"
61 #include "gromacs/domdec/domdec.h"
62 #include "gromacs/domdec/domdec_struct.h"
63 #include "gromacs/domdec/gpuhaloexchange.h"
64 #include "gromacs/domdec/localatomsetmanager.h"
65 #include "gromacs/domdec/makebondedlinks.h"
66 #include "gromacs/domdec/partition.h"
67 #include "gromacs/domdec/reversetopology.h"
68 #include "gromacs/ewald/ewald_utils.h"
69 #include "gromacs/ewald/pme.h"
70 #include "gromacs/ewald/pme_gpu_program.h"
71 #include "gromacs/ewald/pme_only.h"
72 #include "gromacs/ewald/pme_pp_comm_gpu.h"
73 #include "gromacs/fileio/checkpoint.h"
74 #include "gromacs/fileio/gmxfio.h"
75 #include "gromacs/fileio/oenv.h"
76 #include "gromacs/fileio/tpxio.h"
77 #include "gromacs/gmxlib/network.h"
78 #include "gromacs/gmxlib/nrnb.h"
79 #include "gromacs/gpu_utils/device_stream_manager.h"
80 #include "gromacs/hardware/cpuinfo.h"
81 #include "gromacs/hardware/detecthardware.h"
82 #include "gromacs/hardware/device_management.h"
83 #include "gromacs/hardware/hardwaretopology.h"
84 #include "gromacs/hardware/printhardware.h"
85 #include "gromacs/imd/imd.h"
86 #include "gromacs/listed_forces/disre.h"
87 #include "gromacs/listed_forces/listed_forces_gpu.h"
88 #include "gromacs/listed_forces/listed_forces.h"
89 #include "gromacs/listed_forces/orires.h"
90 #include "gromacs/math/functions.h"
91 #include "gromacs/math/utilities.h"
92 #include "gromacs/math/vec.h"
93 #include "gromacs/mdlib/boxdeformation.h"
94 #include "gromacs/mdlib/broadcaststructs.h"
95 #include "gromacs/mdlib/calc_verletbuf.h"
96 #include "gromacs/mdlib/dispersioncorrection.h"
97 #include "gromacs/mdlib/enerdata_utils.h"
98 #include "gromacs/mdlib/force.h"
99 #include "gromacs/mdlib/forcerec.h"
100 #include "gromacs/mdlib/gmx_omp_nthreads.h"
101 #include "gromacs/mdlib/gpuforcereduction.h"
102 #include "gromacs/mdlib/makeconstraints.h"
103 #include "gromacs/mdlib/md_support.h"
104 #include "gromacs/mdlib/mdatoms.h"
105 #include "gromacs/mdlib/sighandler.h"
106 #include "gromacs/mdlib/stophandler.h"
107 #include "gromacs/mdlib/tgroup.h"
108 #include "gromacs/mdlib/updategroups.h"
109 #include "gromacs/mdlib/vsite.h"
110 #include "gromacs/mdrun/mdmodules.h"
111 #include "gromacs/mdrun/simulationcontext.h"
112 #include "gromacs/mdrun/simulationinput.h"
113 #include "gromacs/mdrun/simulationinputhandle.h"
114 #include "gromacs/mdrunutility/handlerestart.h"
115 #include "gromacs/mdrunutility/logging.h"
116 #include "gromacs/mdrunutility/multisim.h"
117 #include "gromacs/mdrunutility/printtime.h"
118 #include "gromacs/mdrunutility/threadaffinity.h"
119 #include "gromacs/mdtypes/checkpointdata.h"
120 #include "gromacs/mdtypes/commrec.h"
121 #include "gromacs/mdtypes/enerdata.h"
122 #include "gromacs/mdtypes/fcdata.h"
123 #include "gromacs/mdtypes/forcerec.h"
124 #include "gromacs/mdtypes/group.h"
125 #include "gromacs/mdtypes/inputrec.h"
126 #include "gromacs/mdtypes/interaction_const.h"
127 #include "gromacs/mdtypes/md_enums.h"
128 #include "gromacs/mdtypes/mdatom.h"
129 #include "gromacs/mdtypes/mdrunoptions.h"
130 #include "gromacs/mdtypes/observableshistory.h"
131 #include "gromacs/mdtypes/simulation_workload.h"
132 #include "gromacs/mdtypes/state.h"
133 #include "gromacs/mdtypes/state_propagator_data_gpu.h"
134 #include "gromacs/modularsimulator/modularsimulator.h"
135 #include "gromacs/nbnxm/gpu_data_mgmt.h"
136 #include "gromacs/nbnxm/nbnxm.h"
137 #include "gromacs/nbnxm/pairlist_tuning.h"
138 #include "gromacs/pbcutil/pbc.h"
139 #include "gromacs/pulling/output.h"
140 #include "gromacs/pulling/pull.h"
141 #include "gromacs/pulling/pull_rotation.h"
142 #include "gromacs/restraint/manager.h"
143 #include "gromacs/restraint/restraintmdmodule.h"
144 #include "gromacs/restraint/restraintpotential.h"
145 #include "gromacs/swap/swapcoords.h"
146 #include "gromacs/taskassignment/decidegpuusage.h"
147 #include "gromacs/taskassignment/decidesimulationworkload.h"
148 #include "gromacs/taskassignment/resourcedivision.h"
149 #include "gromacs/taskassignment/taskassignment.h"
150 #include "gromacs/taskassignment/usergpuids.h"
151 #include "gromacs/timing/gpu_timing.h"
152 #include "gromacs/timing/wallcycle.h"
153 #include "gromacs/timing/wallcyclereporting.h"
154 #include "gromacs/topology/mtop_util.h"
155 #include "gromacs/trajectory/trajectoryframe.h"
156 #include "gromacs/utility/basenetwork.h"
157 #include "gromacs/utility/cstringutil.h"
158 #include "gromacs/utility/exceptions.h"
159 #include "gromacs/utility/fatalerror.h"
160 #include "gromacs/utility/filestream.h"
161 #include "gromacs/utility/gmxassert.h"
162 #include "gromacs/utility/gmxmpi.h"
163 #include "gromacs/utility/keyvaluetree.h"
164 #include "gromacs/utility/logger.h"
165 #include "gromacs/utility/loggerbuilder.h"
166 #include "gromacs/utility/mdmodulesnotifiers.h"
167 #include "gromacs/utility/physicalnodecommunicator.h"
168 #include "gromacs/utility/pleasecite.h"
169 #include "gromacs/utility/programcontext.h"
170 #include "gromacs/utility/smalloc.h"
171 #include "gromacs/utility/stringutil.h"
172 #include "gromacs/utility/mpiinfo.h"
173
174 #include "isimulator.h"
175 #include "membedholder.h"
176 #include "replicaexchange.h"
177 #include "simulatorbuilder.h"
178
179 namespace gmx
180 {
181
182
183 /*! \brief Manage any development feature flag variables encountered
184  *
185  * The use of dev features indicated by environment variables is
186  * logged in order to ensure that runs with such features enabled can
187  * be identified from their log and standard output. Any cross
188  * dependencies are also checked, and if unsatisfied, a fatal error
189  * issued.
190  *
191  * Note that some development features overrides are applied already here:
192  * the GPU communication flags are set to false in non-tMPI and non-CUDA builds.
193  *
194  * \param[in]  mdlog                Logger object.
195  * \param[in]  useGpuForNonbonded   True if the nonbonded task is offloaded in this run.
196  * \param[in]  pmeRunMode           The PME run mode for this run
197  * \returns                         The object populated with development feature flags.
198  */
199 static DevelopmentFeatureFlags manageDevelopmentFeatures(const gmx::MDLogger& mdlog,
200                                                          const bool           useGpuForNonbonded,
201                                                          const PmeRunMode     pmeRunMode)
202 {
203     DevelopmentFeatureFlags devFlags;
204
205     devFlags.enableGpuBufferOps =
206             GMX_GPU_CUDA && useGpuForNonbonded && (getenv("GMX_USE_GPU_BUFFER_OPS") != nullptr);
207     devFlags.enableGpuHaloExchange = GMX_MPI && GMX_GPU_CUDA && getenv("GMX_GPU_DD_COMMS") != nullptr;
208     devFlags.forceGpuUpdateDefault = (getenv("GMX_FORCE_UPDATE_DEFAULT_GPU") != nullptr) || GMX_FAHCORE;
209     devFlags.enableGpuPmePPComm = GMX_MPI && GMX_GPU_CUDA && getenv("GMX_GPU_PME_PP_COMMS") != nullptr;
210
211     // Direct GPU comm path is being used with CUDA_AWARE_MPI
212     // make sure underlying MPI implementation is CUDA-aware
213     if (!GMX_THREAD_MPI && (devFlags.enableGpuPmePPComm || devFlags.enableGpuHaloExchange))
214     {
215         const bool haveDetectedCudaAwareMpi =
216                 (checkMpiCudaAwareSupport() == CudaAwareMpiStatus::Supported);
217         const bool forceCudaAwareMpi = (getenv("GMX_FORCE_CUDA_AWARE_MPI") != nullptr);
218
219         if (!haveDetectedCudaAwareMpi && forceCudaAwareMpi)
220         {
221             // CUDA-aware support not detected in MPI library but, user has forced it's use
222             GMX_LOG(mdlog.warning)
223                     .asParagraph()
224                     .appendTextFormatted(
225                             "This run has forced use of 'CUDA-aware MPI'. "
226                             "But, GROMACS cannot determine if underlying MPI "
227                             "is CUDA-aware. GROMACS recommends use of latest openMPI version "
228                             "for CUDA-aware support. "
229                             "If you observe failures at runtime, try unsetting "
230                             "GMX_FORCE_CUDA_AWARE_MPI environment variable.");
231         }
232
233         if (haveDetectedCudaAwareMpi || forceCudaAwareMpi)
234         {
235             devFlags.usingCudaAwareMpi = true;
236             GMX_LOG(mdlog.warning)
237                     .asParagraph()
238                     .appendTextFormatted(
239                             "Using CUDA-aware MPI for 'GPU halo exchange' or 'GPU PME-PP "
240                             "communications' feature.");
241         }
242         else
243         {
244             if (devFlags.enableGpuHaloExchange)
245             {
246                 GMX_LOG(mdlog.warning)
247                         .asParagraph()
248                         .appendTextFormatted(
249                                 "GMX_GPU_DD_COMMS environment variable detected, but the 'GPU "
250                                 "halo exchange' feature will not be enabled as GROMACS couldn't "
251                                 "detect CUDA_aware support in underlying MPI implementation.");
252                 devFlags.enableGpuHaloExchange = false;
253             }
254             if (devFlags.enableGpuPmePPComm)
255             {
256                 GMX_LOG(mdlog.warning)
257                         .asParagraph()
258                         .appendText(
259                                 "GMX_GPU_PME_PP_COMMS environment variable detected, but the "
260                                 "'GPU PME-PP communications' feature will not be enabled as "
261                                 "GROMACS couldn't "
262                                 "detect CUDA_aware support in underlying MPI implementation.");
263                 devFlags.enableGpuPmePPComm = false;
264             }
265
266             GMX_LOG(mdlog.warning)
267                     .asParagraph()
268                     .appendTextFormatted(
269                             "GROMACS recommends use of latest OpenMPI version for CUDA-aware "
270                             "support. "
271                             "If you are certain about CUDA-aware support in your MPI library, "
272                             "you can force it's use by setting environment variable "
273                             " GMX_FORCE_CUDA_AWARE_MPI.");
274         }
275     }
276
277     if (devFlags.enableGpuBufferOps)
278     {
279         GMX_LOG(mdlog.warning)
280                 .asParagraph()
281                 .appendTextFormatted(
282                         "This run uses the 'GPU buffer ops' feature, enabled by the "
283                         "GMX_USE_GPU_BUFFER_OPS environment variable.");
284     }
285
286     if (devFlags.forceGpuUpdateDefault)
287     {
288         GMX_LOG(mdlog.warning)
289                 .asParagraph()
290                 .appendTextFormatted(
291                         "This run will default to '-update gpu' as requested by the "
292                         "GMX_FORCE_UPDATE_DEFAULT_GPU environment variable. GPU update with domain "
293                         "decomposition lacks substantial testing and should be used with caution.");
294     }
295
296     if (devFlags.enableGpuHaloExchange)
297     {
298         if (useGpuForNonbonded)
299         {
300             if (!devFlags.enableGpuBufferOps)
301             {
302                 GMX_LOG(mdlog.warning)
303                         .asParagraph()
304                         .appendTextFormatted(
305                                 "Enabling GPU buffer operations required by GMX_GPU_DD_COMMS "
306                                 "(equivalent with GMX_USE_GPU_BUFFER_OPS=1).");
307                 devFlags.enableGpuBufferOps = true;
308             }
309             GMX_LOG(mdlog.warning)
310                     .asParagraph()
311                     .appendTextFormatted(
312                             "This run has requested the 'GPU halo exchange' feature, enabled by "
313                             "the "
314                             "GMX_GPU_DD_COMMS environment variable.");
315         }
316         else
317         {
318             GMX_LOG(mdlog.warning)
319                     .asParagraph()
320                     .appendTextFormatted(
321                             "GMX_GPU_DD_COMMS environment variable detected, but the 'GPU "
322                             "halo exchange' feature will not be enabled as nonbonded interactions "
323                             "are not offloaded.");
324             devFlags.enableGpuHaloExchange = false;
325         }
326     }
327
328     if (devFlags.enableGpuPmePPComm)
329     {
330         if (pmeRunMode == PmeRunMode::GPU)
331         {
332             if (!devFlags.enableGpuBufferOps)
333             {
334                 GMX_LOG(mdlog.warning)
335                         .asParagraph()
336                         .appendTextFormatted(
337                                 "Enabling GPU buffer operations required by GMX_GPU_PME_PP_COMMS "
338                                 "(equivalent with GMX_USE_GPU_BUFFER_OPS=1).");
339                 devFlags.enableGpuBufferOps = true;
340             }
341             GMX_LOG(mdlog.warning)
342                     .asParagraph()
343                     .appendTextFormatted(
344                             "This run uses the 'GPU PME-PP communications' feature, enabled "
345                             "by the GMX_GPU_PME_PP_COMMS environment variable.");
346         }
347         else
348         {
349             std::string clarification;
350             if (pmeRunMode == PmeRunMode::Mixed)
351             {
352                 clarification =
353                         "PME FFT and gather are not offloaded to the GPU (PME is running in mixed "
354                         "mode).";
355             }
356             else
357             {
358                 clarification = "PME is not offloaded to the GPU.";
359             }
360             GMX_LOG(mdlog.warning)
361                     .asParagraph()
362                     .appendText(
363                             "GMX_GPU_PME_PP_COMMS environment variable detected, but the "
364                             "'GPU PME-PP communications' feature was not enabled as "
365                             + clarification);
366             devFlags.enableGpuPmePPComm = false;
367         }
368     }
369
370     return devFlags;
371 }
372
373 /*! \brief Barrier for safe simultaneous thread access to mdrunner data
374  *
375  * Used to ensure that the master thread does not modify mdrunner during copy
376  * on the spawned threads. */
377 static void threadMpiMdrunnerAccessBarrier()
378 {
379 #if GMX_THREAD_MPI
380     MPI_Barrier(MPI_COMM_WORLD);
381 #endif
382 }
383
384 Mdrunner Mdrunner::cloneOnSpawnedThread() const
385 {
386     auto newRunner = Mdrunner(std::make_unique<MDModules>());
387
388     // All runners in the same process share a restraint manager resource because it is
389     // part of the interface to the client code, which is associated only with the
390     // original thread. Handles to the same resources can be obtained by copy.
391     {
392         newRunner.restraintManager_ = std::make_unique<RestraintManager>(*restraintManager_);
393     }
394
395     // Copy members of master runner.
396     // \todo Replace with builder when Simulation context and/or runner phases are better defined.
397     // Ref https://gitlab.com/gromacs/gromacs/-/issues/2587 and https://gitlab.com/gromacs/gromacs/-/issues/2375
398     newRunner.hw_opt    = hw_opt;
399     newRunner.filenames = filenames;
400
401     newRunner.hwinfo_         = hwinfo_;
402     newRunner.oenv            = oenv;
403     newRunner.mdrunOptions    = mdrunOptions;
404     newRunner.domdecOptions   = domdecOptions;
405     newRunner.nbpu_opt        = nbpu_opt;
406     newRunner.pme_opt         = pme_opt;
407     newRunner.pme_fft_opt     = pme_fft_opt;
408     newRunner.bonded_opt      = bonded_opt;
409     newRunner.update_opt      = update_opt;
410     newRunner.nstlist_cmdline = nstlist_cmdline;
411     newRunner.replExParams    = replExParams;
412     newRunner.pforce          = pforce;
413     // Give the spawned thread the newly created valid communicator
414     // for the simulation.
415     newRunner.libraryWorldCommunicator = MPI_COMM_WORLD;
416     newRunner.simulationCommunicator   = MPI_COMM_WORLD;
417     newRunner.ms                       = ms;
418     newRunner.startingBehavior         = startingBehavior;
419     newRunner.stopHandlerBuilder_      = std::make_unique<StopHandlerBuilder>(*stopHandlerBuilder_);
420     newRunner.inputHolder_             = inputHolder_;
421
422     threadMpiMdrunnerAccessBarrier();
423
424     return newRunner;
425 }
426
427 /*! \brief The callback used for running on spawned threads.
428  *
429  * Obtains the pointer to the master mdrunner object from the one
430  * argument permitted to the thread-launch API call, copies it to make
431  * a new runner for this thread, reinitializes necessary data, and
432  * proceeds to the simulation. */
433 static void mdrunner_start_fn(const void* arg)
434 {
435     try
436     {
437         const auto* masterMdrunner = reinterpret_cast<const gmx::Mdrunner*>(arg);
438         /* copy the arg list to make sure that it's thread-local. This
439            doesn't copy pointed-to items, of course; fnm, cr and fplog
440            are reset in the call below, all others should be const. */
441         gmx::Mdrunner mdrunner = masterMdrunner->cloneOnSpawnedThread();
442         mdrunner.mdrunner();
443     }
444     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
445 }
446
447
448 void Mdrunner::spawnThreads(int numThreadsToLaunch)
449 {
450 #if GMX_THREAD_MPI
451     /* now spawn new threads that start mdrunner_start_fn(), while
452        the main thread returns. Thread affinity is handled later. */
453     if (tMPI_Init_fn(TRUE, numThreadsToLaunch, TMPI_AFFINITY_NONE, mdrunner_start_fn, static_cast<const void*>(this))
454         != TMPI_SUCCESS)
455     {
456         GMX_THROW(gmx::InternalError("Failed to spawn thread-MPI threads"));
457     }
458
459     // Give the master thread the newly created valid communicator for
460     // the simulation.
461     libraryWorldCommunicator = MPI_COMM_WORLD;
462     simulationCommunicator   = MPI_COMM_WORLD;
463     threadMpiMdrunnerAccessBarrier();
464 #else
465     GMX_UNUSED_VALUE(numThreadsToLaunch);
466     GMX_UNUSED_VALUE(mdrunner_start_fn);
467 #endif
468 }
469
470 } // namespace gmx
471
472 /*! \brief Initialize variables for Verlet scheme simulation */
473 static void prepare_verlet_scheme(FILE*               fplog,
474                                   t_commrec*          cr,
475                                   t_inputrec*         ir,
476                                   int                 nstlist_cmdline,
477                                   const gmx_mtop_t&   mtop,
478                                   const matrix        box,
479                                   bool                makeGpuPairList,
480                                   const gmx::CpuInfo& cpuinfo)
481 {
482     // We checked the cut-offs in grompp, but double-check here.
483     // We have PME+LJcutoff kernels for rcoulomb>rvdw.
484     if (EEL_PME_EWALD(ir->coulombtype) && ir->vdwtype == VanDerWaalsType::Cut)
485     {
486         GMX_RELEASE_ASSERT(ir->rcoulomb >= ir->rvdw,
487                            "With Verlet lists and PME we should have rcoulomb>=rvdw");
488     }
489     else
490     {
491         GMX_RELEASE_ASSERT(ir->rcoulomb == ir->rvdw,
492                            "With Verlet lists and no PME rcoulomb and rvdw should be identical");
493     }
494     /* For NVE simulations, we will retain the initial list buffer */
495     if (EI_DYNAMICS(ir->eI) && ir->verletbuf_tol > 0
496         && !(EI_MD(ir->eI) && ir->etc == TemperatureCoupling::No))
497     {
498         /* Update the Verlet buffer size for the current run setup */
499
500         /* Here we assume SIMD-enabled kernels are being used. But as currently
501          * calc_verlet_buffer_size gives the same results for 4x8 and 4x4
502          * and 4x2 gives a larger buffer than 4x4, this is ok.
503          */
504         ListSetupType listType =
505                 (makeGpuPairList ? ListSetupType::Gpu : ListSetupType::CpuSimdWhenSupported);
506         VerletbufListSetup listSetup = verletbufGetSafeListSetup(listType);
507
508         const real rlist_new =
509                 calcVerletBufferSize(mtop, det(box), *ir, ir->nstlist, ir->nstlist - 1, -1, listSetup);
510
511         if (rlist_new != ir->rlist)
512         {
513             if (fplog != nullptr)
514             {
515                 fprintf(fplog,
516                         "\nChanging rlist from %g to %g for non-bonded %dx%d atom kernels\n\n",
517                         ir->rlist,
518                         rlist_new,
519                         listSetup.cluster_size_i,
520                         listSetup.cluster_size_j);
521             }
522             ir->rlist = rlist_new;
523         }
524     }
525
526     if (nstlist_cmdline > 0 && (!EI_DYNAMICS(ir->eI) || ir->verletbuf_tol <= 0))
527     {
528         gmx_fatal(FARGS,
529                   "Can not set nstlist without %s",
530                   !EI_DYNAMICS(ir->eI) ? "dynamics" : "verlet-buffer-tolerance");
531     }
532
533     if (EI_DYNAMICS(ir->eI))
534     {
535         /* Set or try nstlist values */
536         increaseNstlist(fplog, cr, ir, nstlist_cmdline, &mtop, box, makeGpuPairList, cpuinfo);
537     }
538 }
539
540 /*! \brief Override the nslist value in inputrec
541  *
542  * with value passed on the command line (if any)
543  */
544 static void override_nsteps_cmdline(const gmx::MDLogger& mdlog, int64_t nsteps_cmdline, t_inputrec* ir)
545 {
546     assert(ir);
547
548     /* override with anything else than the default -2 */
549     if (nsteps_cmdline > -2)
550     {
551         char sbuf_steps[STEPSTRSIZE];
552         char sbuf_msg[STRLEN];
553
554         ir->nsteps = nsteps_cmdline;
555         if (EI_DYNAMICS(ir->eI) && nsteps_cmdline != -1)
556         {
557             sprintf(sbuf_msg,
558                     "Overriding nsteps with value passed on the command line: %s steps, %.3g ps",
559                     gmx_step_str(nsteps_cmdline, sbuf_steps),
560                     fabs(nsteps_cmdline * ir->delta_t));
561         }
562         else
563         {
564             sprintf(sbuf_msg,
565                     "Overriding nsteps with value passed on the command line: %s steps",
566                     gmx_step_str(nsteps_cmdline, sbuf_steps));
567         }
568
569         GMX_LOG(mdlog.warning).asParagraph().appendText(sbuf_msg);
570     }
571     else if (nsteps_cmdline < -2)
572     {
573         gmx_fatal(FARGS, "Invalid nsteps value passed on the command line: %" PRId64, nsteps_cmdline);
574     }
575     /* Do nothing if nsteps_cmdline == -2 */
576 }
577
578 namespace gmx
579 {
580
581 /*! \brief Return whether GPU acceleration of nonbondeds is supported with the given settings.
582  *
583  * If not, and if a warning may be issued, logs a warning about
584  * falling back to CPU code. With thread-MPI, only the first
585  * call to this function should have \c issueWarning true. */
586 static bool gpuAccelerationOfNonbondedIsUseful(const MDLogger& mdlog, const t_inputrec& ir, bool issueWarning)
587 {
588     bool        gpuIsUseful = true;
589     std::string warning;
590
591     if (ir.opts.ngener - ir.nwall > 1)
592     {
593         /* The GPU code does not support more than one energy group.
594          * If the user requested GPUs explicitly, a fatal error is given later.
595          */
596         gpuIsUseful = false;
597         warning =
598                 "Multiple energy groups is not implemented for GPUs, falling back to the CPU. "
599                 "For better performance, run on the GPU without energy groups and then do "
600                 "gmx mdrun -rerun option on the trajectory with an energy group .tpr file.";
601     }
602
603     if (EI_TPI(ir.eI))
604     {
605         gpuIsUseful = false;
606         warning     = "TPI is not implemented for GPUs.";
607     }
608
609     if (!gpuIsUseful && issueWarning)
610     {
611         GMX_LOG(mdlog.warning).asParagraph().appendText(warning);
612     }
613
614     return gpuIsUseful;
615 }
616
617 //! Initializes the logger for mdrun.
618 static gmx::LoggerOwner buildLogger(FILE* fplog, const bool isSimulationMasterRank)
619 {
620     gmx::LoggerBuilder builder;
621     if (fplog != nullptr)
622     {
623         builder.addTargetFile(gmx::MDLogger::LogLevel::Info, fplog);
624     }
625     if (isSimulationMasterRank)
626     {
627         builder.addTargetStream(gmx::MDLogger::LogLevel::Warning, &gmx::TextOutputFile::standardError());
628     }
629     return builder.build();
630 }
631
632 //! Make a TaskTarget from an mdrun argument string.
633 static TaskTarget findTaskTarget(const char* optionString)
634 {
635     TaskTarget returnValue = TaskTarget::Auto;
636
637     if (strncmp(optionString, "auto", 3) == 0)
638     {
639         returnValue = TaskTarget::Auto;
640     }
641     else if (strncmp(optionString, "cpu", 3) == 0)
642     {
643         returnValue = TaskTarget::Cpu;
644     }
645     else if (strncmp(optionString, "gpu", 3) == 0)
646     {
647         returnValue = TaskTarget::Gpu;
648     }
649     else
650     {
651         GMX_ASSERT(false, "Option string should have been checked for sanity already");
652     }
653
654     return returnValue;
655 }
656
657 //! Finish run, aggregate data to print performance info.
658 static void finish_run(FILE*                     fplog,
659                        const gmx::MDLogger&      mdlog,
660                        const t_commrec*          cr,
661                        const t_inputrec&         inputrec,
662                        t_nrnb                    nrnb[],
663                        gmx_wallcycle*            wcycle,
664                        gmx_walltime_accounting_t walltime_accounting,
665                        nonbonded_verlet_t*       nbv,
666                        const gmx_pme_t*          pme,
667                        gmx_bool                  bWriteStat)
668 {
669     double delta_t = 0;
670     double nbfs = 0, mflop = 0;
671     double elapsed_time, elapsed_time_over_all_ranks, elapsed_time_over_all_threads,
672             elapsed_time_over_all_threads_over_all_ranks;
673     /* Control whether it is valid to print a report. Only the
674        simulation master may print, but it should not do so if the run
675        terminated e.g. before a scheduled reset step. This is
676        complicated by the fact that PME ranks are unaware of the
677        reason why they were sent a pmerecvqxFINISH. To avoid
678        communication deadlocks, we always do the communication for the
679        report, even if we've decided not to write the report, because
680        how long it takes to finish the run is not important when we've
681        decided not to report on the simulation performance.
682
683        Further, we only report performance for dynamical integrators,
684        because those are the only ones for which we plan to
685        consider doing any optimizations. */
686     bool printReport = EI_DYNAMICS(inputrec.eI) && SIMMASTER(cr);
687
688     if (printReport && !walltime_accounting_get_valid_finish(walltime_accounting))
689     {
690         GMX_LOG(mdlog.warning)
691                 .asParagraph()
692                 .appendText("Simulation ended prematurely, no performance report will be written.");
693         printReport = false;
694     }
695
696     t_nrnb*                 nrnb_tot;
697     std::unique_ptr<t_nrnb> nrnbTotalStorage;
698     if (cr->nnodes > 1)
699     {
700         nrnbTotalStorage = std::make_unique<t_nrnb>();
701         nrnb_tot         = nrnbTotalStorage.get();
702 #if GMX_MPI
703         MPI_Allreduce(nrnb->n.data(), nrnb_tot->n.data(), eNRNB, MPI_DOUBLE, MPI_SUM, cr->mpi_comm_mysim);
704 #endif
705     }
706     else
707     {
708         nrnb_tot = nrnb;
709     }
710
711     elapsed_time = walltime_accounting_get_time_since_reset(walltime_accounting);
712     elapsed_time_over_all_threads =
713             walltime_accounting_get_time_since_reset_over_all_threads(walltime_accounting);
714     if (cr->nnodes > 1)
715     {
716 #if GMX_MPI
717         /* reduce elapsed_time over all MPI ranks in the current simulation */
718         MPI_Allreduce(&elapsed_time, &elapsed_time_over_all_ranks, 1, MPI_DOUBLE, MPI_SUM, cr->mpi_comm_mysim);
719         elapsed_time_over_all_ranks /= cr->nnodes;
720         /* Reduce elapsed_time_over_all_threads over all MPI ranks in the
721          * current simulation. */
722         MPI_Allreduce(&elapsed_time_over_all_threads,
723                       &elapsed_time_over_all_threads_over_all_ranks,
724                       1,
725                       MPI_DOUBLE,
726                       MPI_SUM,
727                       cr->mpi_comm_mysim);
728 #endif
729     }
730     else
731     {
732         elapsed_time_over_all_ranks                  = elapsed_time;
733         elapsed_time_over_all_threads_over_all_ranks = elapsed_time_over_all_threads;
734     }
735
736     if (printReport)
737     {
738         print_flop(fplog, nrnb_tot, &nbfs, &mflop);
739     }
740
741     if (thisRankHasDuty(cr, DUTY_PP) && DOMAINDECOMP(cr))
742     {
743         print_dd_statistics(cr, inputrec, fplog);
744     }
745
746     /* TODO Move the responsibility for any scaling by thread counts
747      * to the code that handled the thread region, so that there's a
748      * mechanism to keep cycle counting working during the transition
749      * to task parallelism. */
750     int nthreads_pp  = gmx_omp_nthreads_get(ModuleMultiThread::Nonbonded);
751     int nthreads_pme = gmx_omp_nthreads_get(ModuleMultiThread::Pme);
752     wallcycle_scale_by_num_threads(
753             wcycle, thisRankHasDuty(cr, DUTY_PME) && !thisRankHasDuty(cr, DUTY_PP), nthreads_pp, nthreads_pme);
754     auto cycle_sum(wallcycle_sum(cr, wcycle));
755
756     if (printReport)
757     {
758         auto* nbnxn_gpu_timings =
759                 (nbv != nullptr && nbv->useGpu()) ? Nbnxm::gpu_get_timings(nbv->gpu_nbv) : nullptr;
760         gmx_wallclock_gpu_pme_t pme_gpu_timings = {};
761
762         if (pme_gpu_task_enabled(pme))
763         {
764             pme_gpu_get_timings(pme, &pme_gpu_timings);
765         }
766         wallcycle_print(fplog,
767                         mdlog,
768                         cr->nnodes,
769                         cr->npmenodes,
770                         nthreads_pp,
771                         nthreads_pme,
772                         elapsed_time_over_all_ranks,
773                         wcycle,
774                         cycle_sum,
775                         nbnxn_gpu_timings,
776                         &pme_gpu_timings);
777
778         if (EI_DYNAMICS(inputrec.eI))
779         {
780             delta_t = inputrec.delta_t;
781         }
782
783         if (fplog)
784         {
785             print_perf(fplog,
786                        elapsed_time_over_all_threads_over_all_ranks,
787                        elapsed_time_over_all_ranks,
788                        walltime_accounting_get_nsteps_done_since_reset(walltime_accounting),
789                        delta_t,
790                        nbfs,
791                        mflop);
792         }
793         if (bWriteStat)
794         {
795             print_perf(stderr,
796                        elapsed_time_over_all_threads_over_all_ranks,
797                        elapsed_time_over_all_ranks,
798                        walltime_accounting_get_nsteps_done_since_reset(walltime_accounting),
799                        delta_t,
800                        nbfs,
801                        mflop);
802         }
803     }
804 }
805
806 int Mdrunner::mdrunner()
807 {
808     matrix                      box;
809     std::unique_ptr<t_forcerec> fr;
810     real                        ewaldcoeff_q     = 0;
811     real                        ewaldcoeff_lj    = 0;
812     int                         nChargePerturbed = -1, nTypePerturbed = 0;
813     gmx_walltime_accounting_t   walltime_accounting = nullptr;
814     MembedHolder                membedHolder(filenames.size(), filenames.data());
815
816     /* CAUTION: threads may be started later on in this function, so
817        cr doesn't reflect the final parallel state right now */
818     gmx_mtop_t mtop;
819
820     /* TODO: inputrec should tell us whether we use an algorithm, not a file option */
821     const bool doEssentialDynamics = opt2bSet("-ei", filenames.size(), filenames.data());
822     const bool doRerun             = mdrunOptions.rerun;
823
824     // Handle task-assignment related user options.
825     EmulateGpuNonbonded emulateGpuNonbonded =
826             (getenv("GMX_EMULATE_GPU") != nullptr ? EmulateGpuNonbonded::Yes : EmulateGpuNonbonded::No);
827
828     std::vector<int> userGpuTaskAssignment;
829     try
830     {
831         userGpuTaskAssignment = parseUserTaskAssignmentString(hw_opt.userGpuTaskAssignment);
832     }
833     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
834     auto nonbondedTarget = findTaskTarget(nbpu_opt);
835     auto pmeTarget       = findTaskTarget(pme_opt);
836     auto pmeFftTarget    = findTaskTarget(pme_fft_opt);
837     auto bondedTarget    = findTaskTarget(bonded_opt);
838     auto updateTarget    = findTaskTarget(update_opt);
839
840     FILE* fplog = nullptr;
841     // If we are appending, we don't write log output because we need
842     // to check that the old log file matches what the checkpoint file
843     // expects. Otherwise, we should start to write log output now if
844     // there is a file ready for it.
845     if (logFileHandle != nullptr && startingBehavior != StartingBehavior::RestartWithAppending)
846     {
847         fplog = gmx_fio_getfp(logFileHandle);
848     }
849     const bool isSimulationMasterRank = findIsSimulationMasterRank(ms, simulationCommunicator);
850     gmx::LoggerOwner logOwner(buildLogger(fplog, isSimulationMasterRank));
851     gmx::MDLogger    mdlog(logOwner.logger());
852
853     gmx_print_detected_hardware(fplog, isSimulationMasterRank && isMasterSim(ms), mdlog, hwinfo_);
854
855     std::vector<int> availableDevices =
856             makeListOfAvailableDevices(hwinfo_->deviceInfoList, hw_opt.devicesSelectedByUser);
857     const int numAvailableDevices = gmx::ssize(availableDevices);
858
859     // Print citation requests after all software/hardware printing
860     pleaseCiteGromacs(fplog);
861
862     // Note: legacy program logic relies on checking whether these pointers are assigned.
863     // Objects may or may not be allocated later.
864     std::unique_ptr<t_inputrec> inputrec;
865     std::unique_ptr<t_state>    globalState;
866
867     auto partialDeserializedTpr = std::make_unique<PartialDeserializedTprFile>();
868
869     if (isSimulationMasterRank)
870     {
871         // Allocate objects to be initialized by later function calls.
872         /* Only the master rank has the global state */
873         globalState = std::make_unique<t_state>();
874         inputrec    = std::make_unique<t_inputrec>();
875
876         /* Read (nearly) all data required for the simulation
877          * and keep the partly serialized tpr contents to send to other ranks later
878          */
879         applyGlobalSimulationState(
880                 *inputHolder_.get(), partialDeserializedTpr.get(), globalState.get(), inputrec.get(), &mtop);
881     }
882
883     /* Check and update the hardware options for internal consistency */
884     checkAndUpdateHardwareOptions(
885             mdlog, &hw_opt, isSimulationMasterRank, domdecOptions.numPmeRanks, inputrec.get());
886
887     if (GMX_THREAD_MPI && isSimulationMasterRank)
888     {
889         bool useGpuForNonbonded = false;
890         bool useGpuForPme       = false;
891         try
892         {
893             GMX_RELEASE_ASSERT(inputrec != nullptr, "Keep the compiler happy");
894
895             // If the user specified the number of ranks, then we must
896             // respect that, but in default mode, we need to allow for
897             // the number of GPUs to choose the number of ranks.
898             auto canUseGpuForNonbonded = buildSupportsNonbondedOnGpu(nullptr);
899             useGpuForNonbonded         = decideWhetherToUseGpusForNonbondedWithThreadMpi(
900                     nonbondedTarget,
901                     numAvailableDevices > 0,
902                     userGpuTaskAssignment,
903                     emulateGpuNonbonded,
904                     canUseGpuForNonbonded,
905                     gpuAccelerationOfNonbondedIsUseful(mdlog, *inputrec, GMX_THREAD_MPI),
906                     hw_opt.nthreads_tmpi);
907             useGpuForPme = decideWhetherToUseGpusForPmeWithThreadMpi(useGpuForNonbonded,
908                                                                      pmeTarget,
909                                                                      numAvailableDevices,
910                                                                      userGpuTaskAssignment,
911                                                                      *hwinfo_,
912                                                                      *inputrec,
913                                                                      hw_opt.nthreads_tmpi,
914                                                                      domdecOptions.numPmeRanks);
915         }
916         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
917
918         /* Determine how many thread-MPI ranks to start.
919          *
920          * TODO Over-writing the user-supplied value here does
921          * prevent any possible subsequent checks from working
922          * correctly. */
923         hw_opt.nthreads_tmpi = get_nthreads_mpi(hwinfo_,
924                                                 &hw_opt,
925                                                 numAvailableDevices,
926                                                 useGpuForNonbonded,
927                                                 useGpuForPme,
928                                                 inputrec.get(),
929                                                 mtop,
930                                                 mdlog,
931                                                 membedHolder.doMembed());
932
933         // Now start the threads for thread MPI.
934         spawnThreads(hw_opt.nthreads_tmpi);
935         // The spawned threads enter mdrunner() and execution of
936         // master and spawned threads joins at the end of this block.
937     }
938
939     GMX_RELEASE_ASSERT(ms || simulationCommunicator != MPI_COMM_NULL,
940                        "Must have valid communicator unless running a multi-simulation");
941     CommrecHandle crHandle = init_commrec(simulationCommunicator);
942     t_commrec*    cr       = crHandle.get();
943     GMX_RELEASE_ASSERT(cr != nullptr, "Must have valid commrec");
944
945     PhysicalNodeCommunicator physicalNodeComm(libraryWorldCommunicator, gmx_physicalnode_id_hash());
946
947     // If we detected the topology on this system, double-check that it makes sense
948     if (hwinfo_->hardwareTopology->isThisSystem())
949     {
950         hardwareTopologyDoubleCheckDetection(mdlog, *hwinfo_->hardwareTopology);
951     }
952
953     if (PAR(cr))
954     {
955         /* now broadcast everything to the non-master nodes/threads: */
956         if (!isSimulationMasterRank)
957         {
958             // Until now, only the master rank has a non-null pointer.
959             // On non-master ranks, allocate the object that will receive data in the following call.
960             inputrec = std::make_unique<t_inputrec>();
961         }
962         init_parallel(cr->mpiDefaultCommunicator,
963                       MASTER(cr),
964                       inputrec.get(),
965                       &mtop,
966                       partialDeserializedTpr.get());
967     }
968     GMX_RELEASE_ASSERT(inputrec != nullptr, "All ranks should have a valid inputrec now");
969     partialDeserializedTpr.reset(nullptr);
970
971     GMX_RELEASE_ASSERT(
972             !inputrec->useConstantAcceleration,
973             "Linear acceleration has been removed in GROMACS 2022, and was broken for many years "
974             "before that. Use GROMACS 4.5 or earlier if you need this feature.");
975
976     // Now the number of ranks is known to all ranks, and each knows
977     // the inputrec read by the master rank. The ranks can now all run
978     // the task-deciding functions and will agree on the result
979     // without needing to communicate.
980     const bool useDomainDecomposition =
981             (PAR(cr) && !(EI_TPI(inputrec->eI) || inputrec->eI == IntegrationAlgorithm::NM));
982
983     // Note that these variables describe only their own node.
984     //
985     // Note that when bonded interactions run on a GPU they always run
986     // alongside a nonbonded task, so do not influence task assignment
987     // even though they affect the force calculation workload.
988     bool useGpuForNonbonded = false;
989     bool useGpuForPme       = false;
990     bool useGpuForBonded    = false;
991     bool useGpuForUpdate    = false;
992     bool gpusWereDetected   = hwinfo_->ngpu_compatible_tot > 0;
993     try
994     {
995         // It's possible that there are different numbers of GPUs on
996         // different nodes, which is the user's responsibility to
997         // handle. If unsuitable, we will notice that during task
998         // assignment.
999         auto canUseGpuForNonbonded = buildSupportsNonbondedOnGpu(nullptr);
1000         useGpuForNonbonded         = decideWhetherToUseGpusForNonbonded(
1001                 nonbondedTarget,
1002                 userGpuTaskAssignment,
1003                 emulateGpuNonbonded,
1004                 canUseGpuForNonbonded,
1005                 gpuAccelerationOfNonbondedIsUseful(mdlog, *inputrec, !GMX_THREAD_MPI),
1006                 gpusWereDetected);
1007         useGpuForPme    = decideWhetherToUseGpusForPme(useGpuForNonbonded,
1008                                                     pmeTarget,
1009                                                     userGpuTaskAssignment,
1010                                                     *hwinfo_,
1011                                                     *inputrec,
1012                                                     cr->sizeOfDefaultCommunicator,
1013                                                     domdecOptions.numPmeRanks,
1014                                                     gpusWereDetected);
1015         useGpuForBonded = decideWhetherToUseGpusForBonded(
1016                 useGpuForNonbonded, useGpuForPme, bondedTarget, *inputrec, mtop, domdecOptions.numPmeRanks, gpusWereDetected);
1017     }
1018     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1019
1020     const PmeRunMode pmeRunMode = determinePmeRunMode(useGpuForPme, pmeFftTarget, *inputrec);
1021
1022     // Initialize development feature flags that enabled by environment variable
1023     // and report those features that are enabled.
1024     const DevelopmentFeatureFlags devFlags =
1025             manageDevelopmentFeatures(mdlog, useGpuForNonbonded, pmeRunMode);
1026
1027     const bool useModularSimulator = checkUseModularSimulator(false,
1028                                                               inputrec.get(),
1029                                                               doRerun,
1030                                                               mtop,
1031                                                               ms,
1032                                                               replExParams,
1033                                                               nullptr,
1034                                                               doEssentialDynamics,
1035                                                               membedHolder.doMembed());
1036
1037     // Build restraints.
1038     // TODO: hide restraint implementation details from Mdrunner.
1039     // There is nothing unique about restraints at this point as far as the
1040     // Mdrunner is concerned. The Mdrunner should just be getting a sequence of
1041     // factory functions from the SimulationContext on which to call mdModules_->add().
1042     // TODO: capture all restraints into a single RestraintModule, passed to the runner builder.
1043     for (auto&& restraint : restraintManager_->getRestraints())
1044     {
1045         auto module = RestraintMDModule::create(restraint, restraint->sites());
1046         mdModules_->add(std::move(module));
1047     }
1048
1049     // TODO: Error handling
1050     mdModules_->assignOptionsToModules(*inputrec->params, nullptr);
1051     // now that the MDModules know their options, they know which callbacks to sign up to
1052     mdModules_->subscribeToSimulationSetupNotifications();
1053     const auto& setupNotifier = mdModules_->notifiers().simulationSetupNotifier_;
1054
1055     // Notify MdModules of existing logger
1056     setupNotifier.notify(mdlog);
1057
1058     // Notify MdModules of internal parameters, saved into KVT
1059     if (inputrec->internalParameters != nullptr)
1060     {
1061         setupNotifier.notify(*inputrec->internalParameters);
1062     }
1063
1064     // Let MdModules know the .tpr filename
1065     {
1066         gmx::MdRunInputFilename mdRunInputFilename = { ftp2fn(efTPR, filenames.size(), filenames.data()) };
1067         setupNotifier.notify(mdRunInputFilename);
1068     }
1069
1070     if (fplog != nullptr)
1071     {
1072         pr_inputrec(fplog, 0, "Input Parameters", inputrec.get(), FALSE);
1073         fprintf(fplog, "\n");
1074     }
1075
1076     if (SIMMASTER(cr))
1077     {
1078         /* In rerun, set velocities to zero if present */
1079         if (doRerun && ((globalState->flags & enumValueToBitMask(StateEntry::V)) != 0))
1080         {
1081             // rerun does not use velocities
1082             GMX_LOG(mdlog.info)
1083                     .asParagraph()
1084                     .appendText(
1085                             "Rerun trajectory contains velocities. Rerun does only evaluate "
1086                             "potential energy and forces. The velocities will be ignored.");
1087             for (int i = 0; i < globalState->natoms; i++)
1088             {
1089                 clear_rvec(globalState->v[i]);
1090             }
1091             globalState->flags &= ~enumValueToBitMask(StateEntry::V);
1092         }
1093
1094         /* now make sure the state is initialized and propagated */
1095         set_state_entries(globalState.get(), inputrec.get(), useModularSimulator);
1096     }
1097
1098     /* NM and TPI parallelize over force/energy calculations, not atoms,
1099      * so we need to initialize and broadcast the global state.
1100      */
1101     if (inputrec->eI == IntegrationAlgorithm::NM || inputrec->eI == IntegrationAlgorithm::TPI)
1102     {
1103         if (!MASTER(cr))
1104         {
1105             globalState = std::make_unique<t_state>();
1106         }
1107         broadcastStateWithoutDynamics(
1108                 cr->mpiDefaultCommunicator, DOMAINDECOMP(cr), PAR(cr), globalState.get());
1109     }
1110
1111     /* A parallel command line option consistency check that we can
1112        only do after any threads have started. */
1113     if (!PAR(cr)
1114         && (domdecOptions.numCells[XX] > 1 || domdecOptions.numCells[YY] > 1
1115             || domdecOptions.numCells[ZZ] > 1 || domdecOptions.numPmeRanks > 0))
1116     {
1117         gmx_fatal(FARGS,
1118                   "The -dd or -npme option request a parallel simulation, "
1119 #if !GMX_MPI
1120                   "but %s was compiled without threads or MPI enabled",
1121                   output_env_get_program_display_name(oenv));
1122 #elif GMX_THREAD_MPI
1123                   "but the number of MPI-threads (option -ntmpi) is not set or is 1");
1124 #else
1125                   "but %s was not started through mpirun/mpiexec or only one rank was requested "
1126                   "through mpirun/mpiexec",
1127                   output_env_get_program_display_name(oenv));
1128 #endif
1129     }
1130
1131     if (doRerun && (EI_ENERGY_MINIMIZATION(inputrec->eI) || IntegrationAlgorithm::NM == inputrec->eI))
1132     {
1133         gmx_fatal(FARGS,
1134                   "The .mdp file specified an energy mininization or normal mode algorithm, and "
1135                   "these are not compatible with mdrun -rerun");
1136     }
1137
1138     /* NMR restraints must be initialized before load_checkpoint,
1139      * since with time averaging the history is added to t_state.
1140      * For proper consistency check we therefore need to extend
1141      * t_state here.
1142      * So the PME-only nodes (if present) will also initialize
1143      * the distance restraints.
1144      */
1145
1146     /* This needs to be called before read_checkpoint to extend the state */
1147     t_disresdata* disresdata;
1148     snew(disresdata, 1);
1149     init_disres(fplog,
1150                 mtop,
1151                 inputrec.get(),
1152                 DisResRunMode::MDRun,
1153                 MASTER(cr) ? DDRole::Master : DDRole::Agent,
1154                 PAR(cr) ? NumRanks::Multiple : NumRanks::Single,
1155                 cr->mpi_comm_mysim,
1156                 ms,
1157                 disresdata,
1158                 globalState.get(),
1159                 replExParams.exchangeInterval > 0);
1160
1161     std::unique_ptr<t_oriresdata> oriresData;
1162     if (gmx_mtop_ftype_count(mtop, F_ORIRES) > 0)
1163     {
1164         oriresData = std::make_unique<t_oriresdata>(fplog, mtop, *inputrec, cr, ms, globalState.get());
1165     }
1166
1167     auto deform = prepareBoxDeformation(globalState != nullptr ? globalState->box : box,
1168                                         MASTER(cr) ? DDRole::Master : DDRole::Agent,
1169                                         PAR(cr) ? NumRanks::Multiple : NumRanks::Single,
1170                                         cr->mpi_comm_mygroup,
1171                                         *inputrec);
1172
1173 #if GMX_FAHCORE
1174     /* We have to remember the generation's first step before reading checkpoint.
1175        This way, we can report to the F@H core both the generation's first step
1176        and the restored first step, thus making it able to distinguish between
1177        an interruption/resume and start of the n-th generation simulation.
1178        Having this information, the F@H core can correctly calculate and report
1179        the progress.
1180      */
1181     int gen_first_step = 0;
1182     if (MASTER(cr))
1183     {
1184         gen_first_step = inputrec->init_step;
1185     }
1186 #endif
1187
1188     ObservablesHistory observablesHistory = {};
1189
1190     auto modularSimulatorCheckpointData = std::make_unique<ReadCheckpointDataHolder>();
1191     if (startingBehavior != StartingBehavior::NewSimulation)
1192     {
1193         /* Check if checkpoint file exists before doing continuation.
1194          * This way we can use identical input options for the first and subsequent runs...
1195          */
1196         if (mdrunOptions.numStepsCommandline > -2)
1197         {
1198             /* Temporarily set the number of steps to unlimited to avoid
1199              * triggering the nsteps check in load_checkpoint().
1200              * This hack will go away soon when the -nsteps option is removed.
1201              */
1202             inputrec->nsteps = -1;
1203         }
1204
1205         // Finish applying initial simulation state information from external sources on all ranks.
1206         // Reconcile checkpoint file data with Mdrunner state established up to this point.
1207         applyLocalState(*inputHolder_.get(),
1208                         logFileHandle,
1209                         cr,
1210                         domdecOptions.numCells,
1211                         inputrec.get(),
1212                         globalState.get(),
1213                         &observablesHistory,
1214                         mdrunOptions.reproducible,
1215                         mdModules_->notifiers(),
1216                         modularSimulatorCheckpointData.get(),
1217                         useModularSimulator);
1218         // TODO: (#3652) Synchronize filesystem state, SimulationInput contents, and program
1219         //  invariants
1220         //  on all code paths.
1221         // Write checkpoint or provide hook to update SimulationInput.
1222         // If there was a checkpoint file, SimulationInput contains more information
1223         // than if there wasn't. At this point, we have synchronized the in-memory
1224         // state with the filesystem state only for restarted simulations. We should
1225         // be calling applyLocalState unconditionally and expect that the completeness
1226         // of SimulationInput is not dependent on its creation method.
1227
1228         if (startingBehavior == StartingBehavior::RestartWithAppending && logFileHandle)
1229         {
1230             // Now we can start normal logging to the truncated log file.
1231             fplog = gmx_fio_getfp(logFileHandle);
1232             prepareLogAppending(fplog);
1233             logOwner = buildLogger(fplog, MASTER(cr));
1234             mdlog    = logOwner.logger();
1235         }
1236     }
1237
1238 #if GMX_FAHCORE
1239     if (MASTER(cr))
1240     {
1241         fcRegisterSteps(inputrec->nsteps + inputrec->init_step, gen_first_step);
1242     }
1243 #endif
1244
1245     if (mdrunOptions.numStepsCommandline > -2)
1246     {
1247         GMX_LOG(mdlog.info)
1248                 .asParagraph()
1249                 .appendText(
1250                         "The -nsteps functionality is deprecated, and may be removed in a future "
1251                         "version. "
1252                         "Consider using gmx convert-tpr -nsteps or changing the appropriate .mdp "
1253                         "file field.");
1254     }
1255     /* override nsteps with value set on the commandline */
1256     override_nsteps_cmdline(mdlog, mdrunOptions.numStepsCommandline, inputrec.get());
1257
1258     if (isSimulationMasterRank)
1259     {
1260         copy_mat(globalState->box, box);
1261     }
1262
1263     if (PAR(cr))
1264     {
1265         gmx_bcast(sizeof(box), box, cr->mpiDefaultCommunicator);
1266     }
1267
1268     if (inputrec->cutoff_scheme != CutoffScheme::Verlet)
1269     {
1270         gmx_fatal(FARGS,
1271                   "This group-scheme .tpr file can no longer be run by mdrun. Please update to the "
1272                   "Verlet scheme, or use an earlier version of GROMACS if necessary.");
1273     }
1274     /* Update rlist and nstlist. */
1275     /* Note: prepare_verlet_scheme is calling increaseNstlist(...), which (while attempting to
1276      * increase rlist) tries to check if the newly chosen value fits with the DD scheme. As this is
1277      * run before any DD scheme is set up, this check is never executed. See #3334 for more details.
1278      */
1279     prepare_verlet_scheme(fplog,
1280                           cr,
1281                           inputrec.get(),
1282                           nstlist_cmdline,
1283                           mtop,
1284                           box,
1285                           useGpuForNonbonded || (emulateGpuNonbonded == EmulateGpuNonbonded::Yes),
1286                           *hwinfo_->cpuInfo);
1287
1288     // We need to decide on update groups early, as this affects
1289     // inter-domain communication distances.
1290     auto       updateGroupingsPerMoleculeType = makeUpdateGroupingsPerMoleculeType(mtop);
1291     const real maxUpdateGroupRadius           = computeMaxUpdateGroupRadius(
1292             mtop, updateGroupingsPerMoleculeType, maxReferenceTemperature(*inputrec));
1293     const real   cutoffMargin = std::sqrt(max_cutoff2(inputrec->pbcType, box)) - inputrec->rlist;
1294     UpdateGroups updateGroups = makeUpdateGroups(mdlog,
1295                                                  std::move(updateGroupingsPerMoleculeType),
1296                                                  maxUpdateGroupRadius,
1297                                                  useDomainDecomposition,
1298                                                  systemHasConstraintsOrVsites(mtop),
1299                                                  cutoffMargin);
1300
1301     // This builder is necessary while we have multi-part construction
1302     // of DD. Before DD is constructed, we use the existence of
1303     // the builder object to indicate that further construction of DD
1304     // is needed.
1305     std::unique_ptr<DomainDecompositionBuilder> ddBuilder;
1306     if (useDomainDecomposition)
1307     {
1308         ddBuilder = std::make_unique<DomainDecompositionBuilder>(
1309                 mdlog,
1310                 cr,
1311                 domdecOptions,
1312                 mdrunOptions,
1313                 mtop,
1314                 *inputrec,
1315                 mdModules_->notifiers(),
1316                 box,
1317                 updateGroups.updateGroupingPerMoleculeType(),
1318                 updateGroups.useUpdateGroups(),
1319                 updateGroups.maxUpdateGroupRadius(),
1320                 positionsFromStatePointer(globalState.get()),
1321                 useGpuForNonbonded,
1322                 useGpuForPme);
1323     }
1324     else
1325     {
1326         /* PME, if used, is done on all nodes with 1D decomposition */
1327         cr->nnodes     = cr->sizeOfDefaultCommunicator;
1328         cr->sim_nodeid = cr->rankInDefaultCommunicator;
1329         cr->nodeid     = cr->rankInDefaultCommunicator;
1330         cr->npmenodes  = 0;
1331         cr->duty       = (DUTY_PP | DUTY_PME);
1332
1333         if (inputrec->pbcType == PbcType::Screw)
1334         {
1335             gmx_fatal(FARGS, "pbc=screw is only implemented with domain decomposition");
1336         }
1337     }
1338
1339     // Produce the task assignment for this rank - done after DD is constructed
1340     GpuTaskAssignments gpuTaskAssignments = GpuTaskAssignmentsBuilder::build(
1341             availableDevices,
1342             userGpuTaskAssignment,
1343             *hwinfo_,
1344             simulationCommunicator,
1345             physicalNodeComm,
1346             nonbondedTarget,
1347             pmeTarget,
1348             bondedTarget,
1349             updateTarget,
1350             useGpuForNonbonded,
1351             useGpuForPme,
1352             thisRankHasDuty(cr, DUTY_PP),
1353             // TODO cr->duty & DUTY_PME should imply that a PME
1354             // algorithm is active, but currently does not.
1355             EEL_PME(inputrec->coulombtype) && thisRankHasDuty(cr, DUTY_PME));
1356
1357     // Get the device handles for the modules, nullptr when no task is assigned.
1358     int                deviceId   = -1;
1359     DeviceInformation* deviceInfo = gpuTaskAssignments.initDevice(&deviceId);
1360
1361     // timing enabling - TODO put this in gpu_utils (even though generally this is just option handling?)
1362     bool useTiming = true;
1363
1364     if (GMX_GPU_CUDA)
1365     {
1366         /* WARNING: CUDA timings are incorrect with multiple streams.
1367          *          This is the main reason why they are disabled by default.
1368          */
1369         // TODO: Consider turning on by default when we can detect nr of streams.
1370         useTiming = (getenv("GMX_ENABLE_GPU_TIMING") != nullptr);
1371     }
1372     else if (GMX_GPU_OPENCL)
1373     {
1374         useTiming = (getenv("GMX_DISABLE_GPU_TIMING") == nullptr);
1375     }
1376
1377     // TODO Currently this is always built, yet DD partition code
1378     // checks if it is built before using it. Probably it should
1379     // become an MDModule that is made only when another module
1380     // requires it (e.g. pull, CompEl, density fitting), so that we
1381     // don't update the local atom sets unilaterally every step.
1382     LocalAtomSetManager atomSets;
1383     if (ddBuilder)
1384     {
1385         // TODO Pass the GPU streams to ddBuilder to use in buffer
1386         // transfers (e.g. halo exchange)
1387         cr->dd = ddBuilder->build(&atomSets);
1388         // The builder's job is done, so destruct it
1389         ddBuilder.reset(nullptr);
1390         // Note that local state still does not exist yet.
1391     }
1392
1393     // The GPU update is decided here because we need to know whether the constraints or
1394     // SETTLEs can span across the domain borders (i.e. whether or not update groups are
1395     // defined). This is only known after DD is initialized, hence decision on using GPU
1396     // update is done so late.
1397     try
1398     {
1399         const bool haveFrozenAtoms = inputrecFrozenAtoms(inputrec.get());
1400
1401         useGpuForUpdate = decideWhetherToUseGpuForUpdate(useDomainDecomposition,
1402                                                          updateGroups.useUpdateGroups(),
1403                                                          pmeRunMode,
1404                                                          domdecOptions.numPmeRanks > 0,
1405                                                          useGpuForNonbonded,
1406                                                          updateTarget,
1407                                                          gpusWereDetected,
1408                                                          *inputrec,
1409                                                          mtop,
1410                                                          doEssentialDynamics,
1411                                                          gmx_mtop_ftype_count(mtop, F_ORIRES) > 0,
1412                                                          haveFrozenAtoms,
1413                                                          doRerun,
1414                                                          devFlags,
1415                                                          mdlog);
1416     }
1417     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1418
1419     const bool printHostName = (cr->nnodes > 1);
1420     gpuTaskAssignments.reportGpuUsage(mdlog, printHostName, useGpuForBonded, pmeRunMode, useGpuForUpdate);
1421
1422     const bool disableNonbondedCalculation = (getenv("GMX_NO_NONBONDED") != nullptr);
1423     if (disableNonbondedCalculation)
1424     {
1425         /* turn off non-bonded calculations */
1426         GMX_LOG(mdlog.warning)
1427                 .asParagraph()
1428                 .appendText(
1429                         "Found environment variable GMX_NO_NONBONDED.\n"
1430                         "Disabling nonbonded calculations.");
1431     }
1432
1433     MdrunScheduleWorkload runScheduleWork;
1434
1435     bool useGpuDirectHalo = decideWhetherToUseGpuForHalo(devFlags,
1436                                                          havePPDomainDecomposition(cr),
1437                                                          useGpuForNonbonded,
1438                                                          useModularSimulator,
1439                                                          doRerun,
1440                                                          EI_ENERGY_MINIMIZATION(inputrec->eI));
1441
1442     // Also populates the simulation constant workload description.
1443     runScheduleWork.simulationWork = createSimulationWorkload(*inputrec,
1444                                                               disableNonbondedCalculation,
1445                                                               devFlags,
1446                                                               havePPDomainDecomposition(cr),
1447                                                               useGpuForNonbonded,
1448                                                               pmeRunMode,
1449                                                               useGpuForBonded,
1450                                                               useGpuForUpdate,
1451                                                               useGpuDirectHalo);
1452
1453     std::unique_ptr<DeviceStreamManager> deviceStreamManager = nullptr;
1454
1455     if (deviceInfo != nullptr)
1456     {
1457         if (DOMAINDECOMP(cr) && thisRankHasDuty(cr, DUTY_PP))
1458         {
1459             dd_setup_dlb_resource_sharing(cr, deviceId);
1460         }
1461         deviceStreamManager = std::make_unique<DeviceStreamManager>(
1462                 *deviceInfo, havePPDomainDecomposition(cr), runScheduleWork.simulationWork, useTiming);
1463     }
1464
1465     // If the user chose a task assignment, give them some hints
1466     // where appropriate.
1467     if (!userGpuTaskAssignment.empty())
1468     {
1469         gpuTaskAssignments.logPerformanceHints(mdlog, numAvailableDevices);
1470     }
1471
1472     if (PAR(cr))
1473     {
1474         /* After possible communicator splitting in make_dd_communicators.
1475          * we can set up the intra/inter node communication.
1476          */
1477         gmx_setup_nodecomm(fplog, cr);
1478     }
1479
1480 #if GMX_MPI
1481     if (isMultiSim(ms))
1482     {
1483         GMX_LOG(mdlog.warning)
1484                 .asParagraph()
1485                 .appendTextFormatted(
1486                         "This is simulation %d out of %d running as a composite GROMACS\n"
1487                         "multi-simulation job. Setup for this simulation:\n",
1488                         ms->simulationIndex_,
1489                         ms->numSimulations_);
1490     }
1491     GMX_LOG(mdlog.warning)
1492             .appendTextFormatted("Using %d MPI %s\n",
1493                                  cr->nnodes,
1494 #    if GMX_THREAD_MPI
1495                                  cr->nnodes == 1 ? "thread" : "threads"
1496 #    else
1497                                  cr->nnodes == 1 ? "process" : "processes"
1498 #    endif
1499             );
1500     fflush(stderr);
1501 #endif
1502
1503     // If mdrun -pin auto honors any affinity setting that already
1504     // exists. If so, it is nice to provide feedback about whether
1505     // that existing affinity setting was from OpenMP or something
1506     // else, so we run this code both before and after we initialize
1507     // the OpenMP support.
1508     gmx_check_thread_affinity_set(mdlog, &hw_opt, hwinfo_->nthreads_hw_avail, FALSE);
1509     /* Check and update the number of OpenMP threads requested */
1510     checkAndUpdateRequestedNumOpenmpThreads(
1511             &hw_opt, *hwinfo_, cr, ms, physicalNodeComm.size_, pmeRunMode, mtop, *inputrec);
1512
1513     gmx_omp_nthreads_init(mdlog,
1514                           cr,
1515                           hwinfo_->nthreads_hw_avail,
1516                           physicalNodeComm.size_,
1517                           hw_opt.nthreads_omp,
1518                           hw_opt.nthreads_omp_pme,
1519                           !thisRankHasDuty(cr, DUTY_PP));
1520
1521     const bool bEnableFPE = gmxShouldEnableFPExceptions();
1522     // FIXME - reconcile with gmx_feenableexcept() call from CommandLineModuleManager::run()
1523     if (bEnableFPE)
1524     {
1525         gmx_feenableexcept();
1526     }
1527
1528     /* Now that we know the setup is consistent, check for efficiency */
1529     check_resource_division_efficiency(
1530             hwinfo_, gpuTaskAssignments.thisRankHasAnyGpuTask(), mdrunOptions.ntompOptionIsSet, cr, mdlog);
1531
1532     /* getting number of PP/PME threads on this MPI / tMPI rank.
1533        PME: env variable should be read only on one node to make sure it is
1534        identical everywhere;
1535      */
1536     const int numThreadsOnThisRank = thisRankHasDuty(cr, DUTY_PP)
1537                                              ? gmx_omp_nthreads_get(ModuleMultiThread::Nonbonded)
1538                                              : gmx_omp_nthreads_get(ModuleMultiThread::Pme);
1539     checkHardwareOversubscription(
1540             numThreadsOnThisRank, cr->nodeid, *hwinfo_->hardwareTopology, physicalNodeComm, mdlog);
1541
1542     // Enable Peer access between GPUs where available
1543     // Only for DD, only master PP rank needs to perform setup, and only if thread MPI plus
1544     // any of the GPU communication features are active.
1545     if (DOMAINDECOMP(cr) && MASTER(cr) && thisRankHasDuty(cr, DUTY_PP) && GMX_THREAD_MPI
1546         && (runScheduleWork.simulationWork.useGpuHaloExchange
1547             || runScheduleWork.simulationWork.useGpuPmePpCommunication))
1548     {
1549         setupGpuDevicePeerAccess(gpuTaskAssignments.deviceIdsAssigned(), mdlog);
1550     }
1551
1552     if (hw_opt.threadAffinity != ThreadAffinity::Off)
1553     {
1554         /* Before setting affinity, check whether the affinity has changed
1555          * - which indicates that probably the OpenMP library has changed it
1556          * since we first checked).
1557          */
1558         gmx_check_thread_affinity_set(mdlog, &hw_opt, hwinfo_->nthreads_hw_avail, TRUE);
1559
1560         int numThreadsOnThisNode, intraNodeThreadOffset;
1561         analyzeThreadsOnThisNode(
1562                 physicalNodeComm, numThreadsOnThisRank, &numThreadsOnThisNode, &intraNodeThreadOffset);
1563
1564         /* Set the CPU affinity */
1565         gmx_set_thread_affinity(mdlog,
1566                                 cr,
1567                                 &hw_opt,
1568                                 *hwinfo_->hardwareTopology,
1569                                 numThreadsOnThisRank,
1570                                 numThreadsOnThisNode,
1571                                 intraNodeThreadOffset,
1572                                 nullptr);
1573     }
1574
1575     if (mdrunOptions.timingOptions.resetStep > -1)
1576     {
1577         GMX_LOG(mdlog.info)
1578                 .asParagraph()
1579                 .appendText(
1580                         "The -resetstep functionality is deprecated, and may be removed in a "
1581                         "future version.");
1582     }
1583     std::unique_ptr<gmx_wallcycle> wcycle =
1584             wallcycle_init(fplog, mdrunOptions.timingOptions.resetStep, cr);
1585
1586     if (PAR(cr))
1587     {
1588         /* Master synchronizes its value of reset_counters with all nodes
1589          * including PME only nodes */
1590         int64_t reset_counters = wcycle_get_reset_counters(wcycle.get());
1591         gmx_bcast(sizeof(reset_counters), &reset_counters, cr->mpi_comm_mysim);
1592         wcycle_set_reset_counters(wcycle.get(), reset_counters);
1593     }
1594
1595     // Membrane embedding must be initialized before we call init_forcerec()
1596     membedHolder.initializeMembed(fplog,
1597                                   filenames.size(),
1598                                   filenames.data(),
1599                                   &mtop,
1600                                   inputrec.get(),
1601                                   globalState.get(),
1602                                   cr,
1603                                   &mdrunOptions.checkpointOptions.period);
1604
1605     const bool               thisRankHasPmeGpuTask = gpuTaskAssignments.thisRankHasPmeGpuTask();
1606     std::unique_ptr<MDAtoms> mdAtoms;
1607     std::unique_ptr<VirtualSitesHandler> vsite;
1608
1609     t_nrnb nrnb;
1610     if (thisRankHasDuty(cr, DUTY_PP))
1611     {
1612         setupNotifier.notify(*cr);
1613         setupNotifier.notify(&atomSets);
1614         setupNotifier.notify(mtop);
1615         setupNotifier.notify(inputrec->pbcType);
1616         setupNotifier.notify(SimulationTimeStep{ inputrec->delta_t });
1617         /* Initiate forcerecord */
1618         fr                 = std::make_unique<t_forcerec>();
1619         fr->forceProviders = mdModules_->initForceProviders();
1620         init_forcerec(fplog,
1621                       mdlog,
1622                       runScheduleWork.simulationWork,
1623                       fr.get(),
1624                       *inputrec,
1625                       mtop,
1626                       cr,
1627                       box,
1628                       opt2fn("-table", filenames.size(), filenames.data()),
1629                       opt2fn("-tablep", filenames.size(), filenames.data()),
1630                       opt2fns("-tableb", filenames.size(), filenames.data()),
1631                       pforce);
1632         // Dirty hack, for fixing disres and orires should be made mdmodules
1633         fr->fcdata->disres = disresdata;
1634         fr->fcdata->orires.swap(oriresData);
1635
1636         // Save a handle to device stream manager to use elsewhere in the code
1637         // TODO: Forcerec is not a correct place to store it.
1638         fr->deviceStreamManager = deviceStreamManager.get();
1639
1640         if (runScheduleWork.simulationWork.useGpuPmePpCommunication && !thisRankHasDuty(cr, DUTY_PME))
1641         {
1642             GMX_RELEASE_ASSERT(
1643                     deviceStreamManager != nullptr,
1644                     "GPU device stream manager should be valid in order to use PME-PP direct "
1645                     "communications.");
1646             GMX_RELEASE_ASSERT(
1647                     deviceStreamManager->streamIsValid(DeviceStreamType::PmePpTransfer),
1648                     "GPU PP-PME stream should be valid in order to use GPU PME-PP direct "
1649                     "communications.");
1650             fr->pmePpCommGpu = std::make_unique<gmx::PmePpCommGpu>(
1651                     cr->mpi_comm_mysim,
1652                     cr->dd->pme_nodeid,
1653                     &cr->dd->pmeForceReceiveBuffer,
1654                     deviceStreamManager->context(),
1655                     deviceStreamManager->stream(DeviceStreamType::PmePpTransfer));
1656         }
1657
1658         fr->nbv = Nbnxm::init_nb_verlet(mdlog,
1659                                         *inputrec,
1660                                         *fr,
1661                                         cr,
1662                                         *hwinfo_,
1663                                         runScheduleWork.simulationWork.useGpuNonbonded,
1664                                         deviceStreamManager.get(),
1665                                         mtop,
1666                                         box,
1667                                         wcycle.get());
1668         // TODO: Move the logic below to a GPU bonded builder
1669         if (runScheduleWork.simulationWork.useGpuBonded)
1670         {
1671             GMX_RELEASE_ASSERT(deviceStreamManager != nullptr,
1672                                "GPU device stream manager should be valid in order to use GPU "
1673                                "version of bonded forces.");
1674             fr->listedForcesGpu = std::make_unique<ListedForcesGpu>(
1675                     mtop.ffparams,
1676                     fr->ic->epsfac * fr->fudgeQQ,
1677                     deviceStreamManager->context(),
1678                     deviceStreamManager->bondedStream(havePPDomainDecomposition(cr)),
1679                     wcycle.get());
1680         }
1681
1682         /* Initialize the mdAtoms structure.
1683          * mdAtoms is not filled with atom data,
1684          * as this can not be done now with domain decomposition.
1685          */
1686         mdAtoms = makeMDAtoms(fplog, mtop, *inputrec, thisRankHasPmeGpuTask);
1687         if (globalState && thisRankHasPmeGpuTask)
1688         {
1689             // The pinning of coordinates in the global state object works, because we only use
1690             // PME on GPU without DD or on a separate PME rank, and because the local state pointer
1691             // points to the global state object without DD.
1692             // FIXME: MD and EM separately set up the local state - this should happen in the same
1693             // function, which should also perform the pinning.
1694             changePinningPolicy(&globalState->x, pme_get_pinning_policy());
1695         }
1696
1697         /* Initialize the virtual site communication */
1698         vsite = makeVirtualSitesHandler(
1699                 mtop, cr, fr->pbcType, updateGroups.updateGroupingPerMoleculeType());
1700
1701         calc_shifts(box, fr->shift_vec);
1702
1703         /* With periodic molecules the charge groups should be whole at start up
1704          * and the virtual sites should not be far from their proper positions.
1705          */
1706         if (!inputrec->bContinuation && MASTER(cr)
1707             && !(inputrec->pbcType != PbcType::No && inputrec->bPeriodicMols))
1708         {
1709             /* Make molecules whole at start of run */
1710             if (fr->pbcType != PbcType::No)
1711             {
1712                 do_pbc_first_mtop(fplog, inputrec->pbcType, box, &mtop, globalState->x.rvec_array());
1713             }
1714             if (vsite)
1715             {
1716                 /* Correct initial vsite positions are required
1717                  * for the initial distribution in the domain decomposition
1718                  * and for the initial shell prediction.
1719                  */
1720                 constructVirtualSitesGlobal(mtop, globalState->x);
1721             }
1722         }
1723         // Make the DD reverse topology, now that any vsites that are present are available
1724         if (DOMAINDECOMP(cr))
1725         {
1726             dd_make_reverse_top(fplog, cr->dd, mtop, vsite.get(), *inputrec, domdecOptions.ddBondedChecking);
1727         }
1728
1729         if (EEL_PME(fr->ic->eeltype) || EVDW_PME(fr->ic->vdwtype))
1730         {
1731             ewaldcoeff_q  = fr->ic->ewaldcoeff_q;
1732             ewaldcoeff_lj = fr->ic->ewaldcoeff_lj;
1733         }
1734     }
1735     else
1736     {
1737         /* This is a PME only node */
1738
1739         GMX_ASSERT(globalState == nullptr,
1740                    "We don't need the state on a PME only rank and expect it to be unitialized");
1741
1742         ewaldcoeff_q  = calc_ewaldcoeff_q(inputrec->rcoulomb, inputrec->ewald_rtol);
1743         ewaldcoeff_lj = calc_ewaldcoeff_lj(inputrec->rvdw, inputrec->ewald_rtol_lj);
1744     }
1745
1746     gmx_pme_t* sepPmeData = nullptr;
1747     // This reference hides the fact that PME data is owned by runner on PME-only ranks and by forcerec on other ranks
1748     GMX_ASSERT(thisRankHasDuty(cr, DUTY_PP) == (fr != nullptr),
1749                "Double-checking that only PME-only ranks have no forcerec");
1750     gmx_pme_t*& pmedata = fr ? fr->pmedata : sepPmeData;
1751
1752     // TODO should live in ewald module once its testing is improved
1753     //
1754     // Later, this program could contain kernels that might be later
1755     // re-used as auto-tuning progresses, or subsequent simulations
1756     // are invoked.
1757     PmeGpuProgramStorage pmeGpuProgram;
1758     if (thisRankHasPmeGpuTask)
1759     {
1760         GMX_RELEASE_ASSERT(
1761                 (deviceStreamManager != nullptr),
1762                 "GPU device stream manager should be initialized in order to use GPU for PME.");
1763         GMX_RELEASE_ASSERT((deviceInfo != nullptr),
1764                            "GPU device should be initialized in order to use GPU for PME.");
1765         pmeGpuProgram = buildPmeGpuProgram(deviceStreamManager->context());
1766     }
1767
1768     /* Initiate PME if necessary,
1769      * either on all nodes or on dedicated PME nodes only. */
1770     if (EEL_PME(inputrec->coulombtype) || EVDW_PME(inputrec->vdwtype))
1771     {
1772         if (mdAtoms && mdAtoms->mdatoms())
1773         {
1774             nChargePerturbed = mdAtoms->mdatoms()->nChargePerturbed;
1775             if (EVDW_PME(inputrec->vdwtype))
1776             {
1777                 nTypePerturbed = mdAtoms->mdatoms()->nTypePerturbed;
1778             }
1779         }
1780         if (cr->npmenodes > 0)
1781         {
1782             /* The PME only nodes need to know nChargePerturbed(FEP on Q) and nTypePerturbed(FEP on LJ)*/
1783             gmx_bcast(sizeof(nChargePerturbed), &nChargePerturbed, cr->mpi_comm_mysim);
1784             gmx_bcast(sizeof(nTypePerturbed), &nTypePerturbed, cr->mpi_comm_mysim);
1785         }
1786
1787         if (thisRankHasDuty(cr, DUTY_PME))
1788         {
1789             try
1790             {
1791                 // TODO: This should be in the builder.
1792                 GMX_RELEASE_ASSERT(!runScheduleWork.simulationWork.useGpuPme
1793                                            || (deviceStreamManager != nullptr),
1794                                    "Device stream manager should be valid in order to use GPU "
1795                                    "version of PME.");
1796                 GMX_RELEASE_ASSERT(
1797                         !runScheduleWork.simulationWork.useGpuPme
1798                                 || deviceStreamManager->streamIsValid(DeviceStreamType::Pme),
1799                         "GPU PME stream should be valid in order to use GPU version of PME.");
1800
1801                 const DeviceContext* deviceContext = runScheduleWork.simulationWork.useGpuPme
1802                                                              ? &deviceStreamManager->context()
1803                                                              : nullptr;
1804                 const DeviceStream*  pmeStream =
1805                         runScheduleWork.simulationWork.useGpuPme
1806                                  ? &deviceStreamManager->stream(DeviceStreamType::Pme)
1807                                  : nullptr;
1808
1809                 pmedata = gmx_pme_init(cr,
1810                                        getNumPmeDomains(cr->dd),
1811                                        inputrec.get(),
1812                                        nChargePerturbed != 0,
1813                                        nTypePerturbed != 0,
1814                                        mdrunOptions.reproducible,
1815                                        ewaldcoeff_q,
1816                                        ewaldcoeff_lj,
1817                                        gmx_omp_nthreads_get(ModuleMultiThread::Pme),
1818                                        pmeRunMode,
1819                                        nullptr,
1820                                        deviceContext,
1821                                        pmeStream,
1822                                        pmeGpuProgram.get(),
1823                                        mdlog);
1824             }
1825             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
1826         }
1827     }
1828
1829
1830     if (EI_DYNAMICS(inputrec->eI))
1831     {
1832         /* Turn on signal handling on all nodes */
1833         /*
1834          * (A user signal from the PME nodes (if any)
1835          * is communicated to the PP nodes.
1836          */
1837         signal_handler_install();
1838     }
1839
1840     pull_t* pull_work = nullptr;
1841     if (thisRankHasDuty(cr, DUTY_PP))
1842     {
1843         /* Assumes uniform use of the number of OpenMP threads */
1844         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(ModuleMultiThread::Default));
1845
1846         if (inputrec->bPull)
1847         {
1848             /* Initialize pull code */
1849             pull_work = init_pull(fplog,
1850                                   inputrec->pull.get(),
1851                                   inputrec.get(),
1852                                   mtop,
1853                                   cr,
1854                                   &atomSets,
1855                                   inputrec->fepvals->init_lambda);
1856             if (inputrec->pull->bXOutAverage || inputrec->pull->bFOutAverage)
1857             {
1858                 initPullHistory(pull_work, &observablesHistory);
1859             }
1860             if (EI_DYNAMICS(inputrec->eI) && MASTER(cr))
1861             {
1862                 init_pull_output_files(pull_work, filenames.size(), filenames.data(), oenv, startingBehavior);
1863             }
1864         }
1865
1866         std::unique_ptr<EnforcedRotation> enforcedRotation;
1867         if (inputrec->bRot)
1868         {
1869             /* Initialize enforced rotation code */
1870             enforcedRotation = init_rot(fplog,
1871                                         inputrec.get(),
1872                                         filenames.size(),
1873                                         filenames.data(),
1874                                         cr,
1875                                         &atomSets,
1876                                         globalState.get(),
1877                                         mtop,
1878                                         oenv,
1879                                         mdrunOptions,
1880                                         startingBehavior);
1881         }
1882
1883         t_swap* swap = nullptr;
1884         if (inputrec->eSwapCoords != SwapType::No)
1885         {
1886             /* Initialize ion swapping code */
1887             swap = init_swapcoords(fplog,
1888                                    inputrec.get(),
1889                                    opt2fn_master("-swap", filenames.size(), filenames.data(), cr),
1890                                    mtop,
1891                                    globalState.get(),
1892                                    &observablesHistory,
1893                                    cr,
1894                                    &atomSets,
1895                                    oenv,
1896                                    mdrunOptions,
1897                                    startingBehavior);
1898         }
1899
1900         /* Let makeConstraints know whether we have essential dynamics constraints. */
1901         auto constr = makeConstraints(mtop,
1902                                       *inputrec,
1903                                       pull_work,
1904                                       doEssentialDynamics,
1905                                       fplog,
1906                                       cr,
1907                                       updateGroups.useUpdateGroups(),
1908                                       ms,
1909                                       &nrnb,
1910                                       wcycle.get(),
1911                                       fr->bMolPBC);
1912
1913         /* Energy terms and groups */
1914         gmx_enerdata_t enerd(mtop.groups.groups[SimulationAtomGroupType::EnergyOutput].size(),
1915                              inputrec->fepvals->n_lambda);
1916
1917         // cos acceleration is only supported by md, but older tpr
1918         // files might still combine it with other integrators
1919         GMX_RELEASE_ASSERT(inputrec->cos_accel == 0.0 || inputrec->eI == IntegrationAlgorithm::MD,
1920                            "cos_acceleration is only supported by integrator=md");
1921
1922         /* Kinetic energy data */
1923         gmx_ekindata_t ekind(inputrec->opts.ngtc,
1924                              inputrec->cos_accel,
1925                              gmx_omp_nthreads_get(ModuleMultiThread::Update));
1926
1927         /* Set up interactive MD (IMD) */
1928         auto imdSession = makeImdSession(inputrec.get(),
1929                                          cr,
1930                                          wcycle.get(),
1931                                          &enerd,
1932                                          ms,
1933                                          mtop,
1934                                          mdlog,
1935                                          MASTER(cr) ? globalState->x : gmx::ArrayRef<gmx::RVec>(),
1936                                          filenames.size(),
1937                                          filenames.data(),
1938                                          oenv,
1939                                          mdrunOptions.imdOptions,
1940                                          startingBehavior);
1941
1942         if (DOMAINDECOMP(cr))
1943         {
1944             GMX_RELEASE_ASSERT(fr, "fr was NULL while cr->duty was DUTY_PP");
1945             /* This call is not included in init_domain_decomposition
1946              * because fr->atomInfoForEachMoleculeBlock is set later.
1947              */
1948             makeBondedLinks(cr->dd, mtop, fr->atomInfoForEachMoleculeBlock);
1949         }
1950
1951         if (runScheduleWork.simulationWork.useGpuBufferOps)
1952         {
1953             fr->gpuForceReduction[gmx::AtomLocality::Local] = std::make_unique<gmx::GpuForceReduction>(
1954                     deviceStreamManager->context(),
1955                     deviceStreamManager->stream(gmx::DeviceStreamType::NonBondedLocal),
1956                     wcycle.get());
1957             fr->gpuForceReduction[gmx::AtomLocality::NonLocal] = std::make_unique<gmx::GpuForceReduction>(
1958                     deviceStreamManager->context(),
1959                     deviceStreamManager->stream(gmx::DeviceStreamType::NonBondedNonLocal),
1960                     wcycle.get());
1961         }
1962
1963         std::unique_ptr<gmx::StatePropagatorDataGpu> stateGpu;
1964         if (gpusWereDetected
1965             && ((runScheduleWork.simulationWork.useGpuPme && thisRankHasDuty(cr, DUTY_PME))
1966                 || runScheduleWork.simulationWork.useGpuBufferOps))
1967         {
1968             GpuApiCallBehavior transferKind =
1969                     (inputrec->eI == IntegrationAlgorithm::MD && !doRerun && !useModularSimulator)
1970                             ? GpuApiCallBehavior::Async
1971                             : GpuApiCallBehavior::Sync;
1972             GMX_RELEASE_ASSERT(deviceStreamManager != nullptr,
1973                                "GPU device stream manager should be initialized to use GPU.");
1974             stateGpu = std::make_unique<gmx::StatePropagatorDataGpu>(
1975                     *deviceStreamManager, transferKind, pme_gpu_get_block_size(fr->pmedata), wcycle.get());
1976             fr->stateGpu = stateGpu.get();
1977         }
1978
1979         GMX_ASSERT(stopHandlerBuilder_, "Runner must provide StopHandlerBuilder to simulator.");
1980         SimulatorBuilder simulatorBuilder;
1981
1982         simulatorBuilder.add(SimulatorStateData(globalState.get(), &observablesHistory, &enerd, &ekind));
1983         simulatorBuilder.add(std::move(membedHolder));
1984         simulatorBuilder.add(std::move(stopHandlerBuilder_));
1985         simulatorBuilder.add(SimulatorConfig(mdrunOptions, startingBehavior, &runScheduleWork));
1986
1987
1988         simulatorBuilder.add(SimulatorEnv(fplog, cr, ms, mdlog, oenv));
1989         simulatorBuilder.add(Profiling(&nrnb, walltime_accounting, wcycle.get()));
1990         simulatorBuilder.add(ConstraintsParam(
1991                 constr.get(), enforcedRotation ? enforcedRotation->getLegacyEnfrot() : nullptr, vsite.get()));
1992         // TODO: Separate `fr` to a separate add, and make the `build` handle the coupling sensibly.
1993         simulatorBuilder.add(LegacyInput(
1994                 static_cast<int>(filenames.size()), filenames.data(), inputrec.get(), fr.get()));
1995         simulatorBuilder.add(ReplicaExchangeParameters(replExParams));
1996         simulatorBuilder.add(InteractiveMD(imdSession.get()));
1997         simulatorBuilder.add(SimulatorModules(mdModules_->outputProvider(), mdModules_->notifiers()));
1998         simulatorBuilder.add(CenterOfMassPulling(pull_work));
1999         // Todo move to an MDModule
2000         simulatorBuilder.add(IonSwapping(swap));
2001         simulatorBuilder.add(TopologyData(mtop, mdAtoms.get()));
2002         simulatorBuilder.add(BoxDeformationHandle(deform.get()));
2003         simulatorBuilder.add(std::move(modularSimulatorCheckpointData));
2004
2005         // build and run simulator object based on user-input
2006         auto simulator = simulatorBuilder.build(useModularSimulator);
2007         simulator->run();
2008
2009         if (fr->pmePpCommGpu)
2010         {
2011             // destroy object since it is no longer required. (This needs to be done while the GPU context still exists.)
2012             fr->pmePpCommGpu.reset();
2013         }
2014
2015         if (inputrec->bPull)
2016         {
2017             finish_pull(pull_work);
2018         }
2019         finish_swapcoords(swap);
2020     }
2021     else
2022     {
2023         GMX_RELEASE_ASSERT(pmedata, "pmedata was NULL while cr->duty was not DUTY_PP");
2024         /* do PME only */
2025         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(ModuleMultiThread::Pme));
2026         gmx_pmeonly(pmedata,
2027                     cr,
2028                     &nrnb,
2029                     wcycle.get(),
2030                     walltime_accounting,
2031                     inputrec.get(),
2032                     pmeRunMode,
2033                     runScheduleWork.simulationWork.useGpuPmePpCommunication,
2034                     deviceStreamManager.get());
2035     }
2036
2037     wallcycle_stop(wcycle.get(), WallCycleCounter::Run);
2038
2039     /* Finish up, write some stuff
2040      * if rerunMD, don't write last frame again
2041      */
2042     finish_run(fplog,
2043                mdlog,
2044                cr,
2045                *inputrec,
2046                &nrnb,
2047                wcycle.get(),
2048                walltime_accounting,
2049                fr ? fr->nbv.get() : nullptr,
2050                pmedata,
2051                EI_DYNAMICS(inputrec->eI) && !isMultiSim(ms));
2052
2053
2054     deviceStreamManager.reset(nullptr);
2055     // Free PME data
2056     if (pmedata)
2057     {
2058         gmx_pme_destroy(pmedata);
2059         pmedata = nullptr;
2060     }
2061
2062     // FIXME: this is only here to manually unpin mdAtoms->chargeA_ and state->x,
2063     // before we destroy the GPU context(s)
2064     // Pinned buffers are associated with contexts in CUDA.
2065     // As soon as we destroy GPU contexts after mdrunner() exits, these lines should go.
2066     mdAtoms.reset(nullptr);
2067     globalState.reset(nullptr);
2068     mdModules_.reset(nullptr); // destruct force providers here as they might also use the GPU
2069     fr.reset(nullptr);         // destruct forcerec before gpu
2070     // TODO convert to C++ so we can get rid of these frees
2071     sfree(disresdata);
2072
2073     if (!hwinfo_->deviceInfoList.empty())
2074     {
2075         /* stop the GPU profiler (only CUDA) */
2076         stopGpuProfiler();
2077     }
2078
2079     /* With tMPI we need to wait for all ranks to finish deallocation before
2080      * destroying the CUDA context as some tMPI ranks may be sharing
2081      * GPU and context.
2082      *
2083      * This is not a concern in OpenCL where we use one context per rank.
2084      *
2085      * Note: it is safe to not call the barrier on the ranks which do not use GPU,
2086      * but it is easier and more futureproof to call it on the whole node.
2087      *
2088      * Note that this function needs to be called even if GPUs are not used
2089      * in this run because the PME ranks have no knowledge of whether GPUs
2090      * are used or not, but all ranks need to enter the barrier below.
2091      * \todo Remove this physical node barrier after making sure
2092      * that it's not needed anymore (with a shared GPU run).
2093      */
2094     if (GMX_THREAD_MPI)
2095     {
2096         physicalNodeComm.barrier();
2097     }
2098
2099     if (!devFlags.usingCudaAwareMpi)
2100     {
2101         // Don't reset GPU in case of CUDA-AWARE MPI
2102         // UCX creates CUDA buffers which are cleaned-up as part of MPI_Finalize()
2103         // resetting the device before MPI_Finalize() results in crashes inside UCX
2104         releaseDevice(deviceInfo);
2105     }
2106
2107     /* Does what it says */
2108     print_date_and_time(fplog, cr->nodeid, "Finished mdrun", gmx_gettime());
2109     walltime_accounting_destroy(walltime_accounting);
2110
2111     // Ensure log file content is written
2112     if (logFileHandle)
2113     {
2114         gmx_fio_flush(logFileHandle);
2115     }
2116
2117     /* Reset FPEs (important for unit tests) by disabling them. Assumes no
2118      * exceptions were enabled before function was called. */
2119     if (bEnableFPE)
2120     {
2121         gmx_fedisableexcept();
2122     }
2123
2124     auto rc = static_cast<int>(gmx_get_stop_condition());
2125
2126 #if GMX_THREAD_MPI
2127     /* we need to join all threads. The sub-threads join when they
2128        exit this function, but the master thread needs to be told to
2129        wait for that. */
2130     if (MASTER(cr))
2131     {
2132         tMPI_Finalize();
2133     }
2134 #endif
2135     return rc;
2136 } // namespace gmx
2137
2138 Mdrunner::~Mdrunner()
2139 {
2140     // Clean up of the Manager.
2141     // This will end up getting called on every thread-MPI rank, which is unnecessary,
2142     // but okay as long as threads synchronize some time before adding or accessing
2143     // a new set of restraints.
2144     if (restraintManager_)
2145     {
2146         restraintManager_->clear();
2147         GMX_ASSERT(restraintManager_->countRestraints() == 0,
2148                    "restraints added during runner life time should be cleared at runner "
2149                    "destruction.");
2150     }
2151 };
2152
2153 void Mdrunner::addPotential(std::shared_ptr<gmx::IRestraintPotential> puller, const std::string& name)
2154 {
2155     GMX_ASSERT(restraintManager_, "Mdrunner must have a restraint manager.");
2156     // Not sure if this should be logged through the md logger or something else,
2157     // but it is helpful to have some sort of INFO level message sent somewhere.
2158     //    std::cout << "Registering restraint named " << name << std::endl;
2159
2160     // When multiple restraints are used, it may be wasteful to register them separately.
2161     // Maybe instead register an entire Restraint Manager as a force provider.
2162     restraintManager_->addToSpec(std::move(puller), name);
2163 }
2164
2165 Mdrunner::Mdrunner(std::unique_ptr<MDModules> mdModules) : mdModules_(std::move(mdModules)) {}
2166
2167 Mdrunner::Mdrunner(Mdrunner&&) noexcept = default;
2168
2169 //NOLINTNEXTLINE(performance-noexcept-move-constructor) working around GCC bug 58265 in CentOS 7
2170 Mdrunner& Mdrunner::operator=(Mdrunner&& /*handle*/) noexcept(BUGFREE_NOEXCEPT_STRING) = default;
2171
2172 class Mdrunner::BuilderImplementation
2173 {
2174 public:
2175     BuilderImplementation() = delete;
2176     BuilderImplementation(std::unique_ptr<MDModules> mdModules, compat::not_null<SimulationContext*> context);
2177     ~BuilderImplementation();
2178
2179     BuilderImplementation& setExtraMdrunOptions(const MdrunOptions& options,
2180                                                 real                forceWarningThreshold,
2181                                                 StartingBehavior    startingBehavior);
2182
2183     void addHardwareDetectionResult(const gmx_hw_info_t* hwinfo);
2184
2185     void addDomdec(const DomdecOptions& options);
2186
2187     void addInput(SimulationInputHandle inputHolder);
2188
2189     void addVerletList(int nstlist);
2190
2191     void addReplicaExchange(const ReplicaExchangeParameters& params);
2192
2193     void addNonBonded(const char* nbpu_opt);
2194
2195     void addPME(const char* pme_opt_, const char* pme_fft_opt_);
2196
2197     void addBondedTaskAssignment(const char* bonded_opt);
2198
2199     void addUpdateTaskAssignment(const char* update_opt);
2200
2201     void addHardwareOptions(const gmx_hw_opt_t& hardwareOptions);
2202
2203     void addFilenames(ArrayRef<const t_filenm> filenames);
2204
2205     void addOutputEnvironment(gmx_output_env_t* outputEnvironment);
2206
2207     void addLogFile(t_fileio* logFileHandle);
2208
2209     void addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder);
2210
2211     Mdrunner build();
2212
2213 private:
2214     // Default parameters copied from runner.h
2215     // \todo Clarify source(s) of default parameters.
2216
2217     const char* nbpu_opt_    = nullptr;
2218     const char* pme_opt_     = nullptr;
2219     const char* pme_fft_opt_ = nullptr;
2220     const char* bonded_opt_  = nullptr;
2221     const char* update_opt_  = nullptr;
2222
2223     MdrunOptions mdrunOptions_;
2224
2225     DomdecOptions domdecOptions_;
2226
2227     ReplicaExchangeParameters replicaExchangeParameters_;
2228
2229     //! Command-line override for the duration of a neighbor list with the Verlet scheme.
2230     int nstlist_ = 0;
2231
2232     //! World communicator, used for hardware detection and task assignment
2233     MPI_Comm libraryWorldCommunicator_ = MPI_COMM_NULL;
2234
2235     //! Multisim communicator handle.
2236     gmx_multisim_t* multiSimulation_;
2237
2238     //! mdrun communicator
2239     MPI_Comm simulationCommunicator_ = MPI_COMM_NULL;
2240
2241     //! Print a warning if any force is larger than this (in kJ/mol nm).
2242     real forceWarningThreshold_ = -1;
2243
2244     //! Whether the simulation will start afresh, or restart with/without appending.
2245     StartingBehavior startingBehavior_ = StartingBehavior::NewSimulation;
2246
2247     //! The modules that comprise the functionality of mdrun.
2248     std::unique_ptr<MDModules> mdModules_;
2249
2250     //! Detected hardware.
2251     const gmx_hw_info_t* hwinfo_ = nullptr;
2252
2253     //! \brief Parallelism information.
2254     gmx_hw_opt_t hardwareOptions_;
2255
2256     //! filename options for simulation.
2257     ArrayRef<const t_filenm> filenames_;
2258
2259     /*! \brief Handle to output environment.
2260      *
2261      * \todo gmx_output_env_t needs lifetime management.
2262      */
2263     gmx_output_env_t* outputEnvironment_ = nullptr;
2264
2265     /*! \brief Non-owning handle to MD log file.
2266      *
2267      * \todo Context should own output facilities for client.
2268      * \todo Improve log file handle management.
2269      * \internal
2270      * Code managing the FILE* relies on the ability to set it to
2271      * nullptr to check whether the filehandle is valid.
2272      */
2273     t_fileio* logFileHandle_ = nullptr;
2274
2275     /*!
2276      * \brief Builder for simulation stop signal handler.
2277      */
2278     std::unique_ptr<StopHandlerBuilder> stopHandlerBuilder_ = nullptr;
2279
2280     /*!
2281      * \brief Sources for initial simulation state.
2282      *
2283      * See issue #3652 for near-term refinements to the SimulationInput interface.
2284      *
2285      * See issue #3379 for broader discussion on API aspects of simulation inputs and outputs.
2286      */
2287     SimulationInputHandle inputHolder_;
2288 };
2289
2290 Mdrunner::BuilderImplementation::BuilderImplementation(std::unique_ptr<MDModules> mdModules,
2291                                                        compat::not_null<SimulationContext*> context) :
2292     mdModules_(std::move(mdModules))
2293 {
2294     libraryWorldCommunicator_ = context->libraryWorldCommunicator_;
2295     simulationCommunicator_   = context->simulationCommunicator_;
2296     multiSimulation_          = context->multiSimulation_.get();
2297 }
2298
2299 Mdrunner::BuilderImplementation::~BuilderImplementation() = default;
2300
2301 Mdrunner::BuilderImplementation&
2302 Mdrunner::BuilderImplementation::setExtraMdrunOptions(const MdrunOptions&    options,
2303                                                       const real             forceWarningThreshold,
2304                                                       const StartingBehavior startingBehavior)
2305 {
2306     mdrunOptions_          = options;
2307     forceWarningThreshold_ = forceWarningThreshold;
2308     startingBehavior_      = startingBehavior;
2309     return *this;
2310 }
2311
2312 void Mdrunner::BuilderImplementation::addDomdec(const DomdecOptions& options)
2313 {
2314     domdecOptions_ = options;
2315 }
2316
2317 void Mdrunner::BuilderImplementation::addVerletList(int nstlist)
2318 {
2319     nstlist_ = nstlist;
2320 }
2321
2322 void Mdrunner::BuilderImplementation::addReplicaExchange(const ReplicaExchangeParameters& params)
2323 {
2324     replicaExchangeParameters_ = params;
2325 }
2326
2327 Mdrunner Mdrunner::BuilderImplementation::build()
2328 {
2329     auto newRunner = Mdrunner(std::move(mdModules_));
2330
2331     newRunner.mdrunOptions     = mdrunOptions_;
2332     newRunner.pforce           = forceWarningThreshold_;
2333     newRunner.startingBehavior = startingBehavior_;
2334     newRunner.domdecOptions    = domdecOptions_;
2335
2336     // \todo determine an invariant to check or confirm that all gmx_hw_opt_t objects are valid
2337     newRunner.hw_opt = hardwareOptions_;
2338
2339     // No invariant to check. This parameter exists to optionally override other behavior.
2340     newRunner.nstlist_cmdline = nstlist_;
2341
2342     newRunner.replExParams = replicaExchangeParameters_;
2343
2344     newRunner.filenames = filenames_;
2345
2346     newRunner.libraryWorldCommunicator = libraryWorldCommunicator_;
2347
2348     newRunner.simulationCommunicator = simulationCommunicator_;
2349
2350     // nullptr is a valid value for the multisim handle
2351     newRunner.ms = multiSimulation_;
2352
2353     if (hwinfo_)
2354     {
2355         newRunner.hwinfo_ = hwinfo_;
2356     }
2357     else
2358     {
2359         GMX_THROW(gmx::APIError(
2360                 "MdrunnerBuilder::addHardwareDetectionResult() is required before build()"));
2361     }
2362
2363     if (inputHolder_)
2364     {
2365         newRunner.inputHolder_ = std::move(inputHolder_);
2366     }
2367     else
2368     {
2369         GMX_THROW(gmx::APIError("MdrunnerBuilder::addInput() is required before build()."));
2370     }
2371
2372     // \todo Clarify ownership and lifetime management for gmx_output_env_t
2373     // \todo Update sanity checking when output environment has clearly specified invariants.
2374     // Initialization and default values for oenv are not well specified in the current version.
2375     if (outputEnvironment_)
2376     {
2377         newRunner.oenv = outputEnvironment_;
2378     }
2379     else
2380     {
2381         GMX_THROW(gmx::APIError(
2382                 "MdrunnerBuilder::addOutputEnvironment() is required before build()"));
2383     }
2384
2385     newRunner.logFileHandle = logFileHandle_;
2386
2387     if (nbpu_opt_)
2388     {
2389         newRunner.nbpu_opt = nbpu_opt_;
2390     }
2391     else
2392     {
2393         GMX_THROW(gmx::APIError("MdrunnerBuilder::addNonBonded() is required before build()"));
2394     }
2395
2396     if (pme_opt_ && pme_fft_opt_)
2397     {
2398         newRunner.pme_opt     = pme_opt_;
2399         newRunner.pme_fft_opt = pme_fft_opt_;
2400     }
2401     else
2402     {
2403         GMX_THROW(gmx::APIError("MdrunnerBuilder::addElectrostatics() is required before build()"));
2404     }
2405
2406     if (bonded_opt_)
2407     {
2408         newRunner.bonded_opt = bonded_opt_;
2409     }
2410     else
2411     {
2412         GMX_THROW(gmx::APIError(
2413                 "MdrunnerBuilder::addBondedTaskAssignment() is required before build()"));
2414     }
2415
2416     if (update_opt_)
2417     {
2418         newRunner.update_opt = update_opt_;
2419     }
2420     else
2421     {
2422         GMX_THROW(gmx::APIError(
2423                 "MdrunnerBuilder::addUpdateTaskAssignment() is required before build()  "));
2424     }
2425
2426
2427     newRunner.restraintManager_ = std::make_unique<gmx::RestraintManager>();
2428
2429     if (stopHandlerBuilder_)
2430     {
2431         newRunner.stopHandlerBuilder_ = std::move(stopHandlerBuilder_);
2432     }
2433     else
2434     {
2435         newRunner.stopHandlerBuilder_ = std::make_unique<StopHandlerBuilder>();
2436     }
2437
2438     return newRunner;
2439 }
2440
2441 void Mdrunner::BuilderImplementation::addHardwareDetectionResult(const gmx_hw_info_t* hwinfo)
2442 {
2443     hwinfo_ = hwinfo;
2444 }
2445
2446 void Mdrunner::BuilderImplementation::addNonBonded(const char* nbpu_opt)
2447 {
2448     nbpu_opt_ = nbpu_opt;
2449 }
2450
2451 void Mdrunner::BuilderImplementation::addPME(const char* pme_opt, const char* pme_fft_opt)
2452 {
2453     pme_opt_     = pme_opt;
2454     pme_fft_opt_ = pme_fft_opt;
2455 }
2456
2457 void Mdrunner::BuilderImplementation::addBondedTaskAssignment(const char* bonded_opt)
2458 {
2459     bonded_opt_ = bonded_opt;
2460 }
2461
2462 void Mdrunner::BuilderImplementation::addUpdateTaskAssignment(const char* update_opt)
2463 {
2464     update_opt_ = update_opt;
2465 }
2466
2467 void Mdrunner::BuilderImplementation::addHardwareOptions(const gmx_hw_opt_t& hardwareOptions)
2468 {
2469     hardwareOptions_ = hardwareOptions;
2470 }
2471
2472 void Mdrunner::BuilderImplementation::addFilenames(ArrayRef<const t_filenm> filenames)
2473 {
2474     filenames_ = filenames;
2475 }
2476
2477 void Mdrunner::BuilderImplementation::addOutputEnvironment(gmx_output_env_t* outputEnvironment)
2478 {
2479     outputEnvironment_ = outputEnvironment;
2480 }
2481
2482 void Mdrunner::BuilderImplementation::addLogFile(t_fileio* logFileHandle)
2483 {
2484     logFileHandle_ = logFileHandle;
2485 }
2486
2487 void Mdrunner::BuilderImplementation::addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder)
2488 {
2489     stopHandlerBuilder_ = std::move(builder);
2490 }
2491
2492 void Mdrunner::BuilderImplementation::addInput(SimulationInputHandle inputHolder)
2493 {
2494     inputHolder_ = std::move(inputHolder);
2495 }
2496
2497 MdrunnerBuilder::MdrunnerBuilder(std::unique_ptr<MDModules>           mdModules,
2498                                  compat::not_null<SimulationContext*> context) :
2499     impl_{ std::make_unique<Mdrunner::BuilderImplementation>(std::move(mdModules), context) }
2500 {
2501 }
2502
2503 MdrunnerBuilder::~MdrunnerBuilder() = default;
2504
2505 MdrunnerBuilder& MdrunnerBuilder::addHardwareDetectionResult(const gmx_hw_info_t* hwinfo)
2506 {
2507     impl_->addHardwareDetectionResult(hwinfo);
2508     return *this;
2509 }
2510
2511 MdrunnerBuilder& MdrunnerBuilder::addSimulationMethod(const MdrunOptions&    options,
2512                                                       real                   forceWarningThreshold,
2513                                                       const StartingBehavior startingBehavior)
2514 {
2515     impl_->setExtraMdrunOptions(options, forceWarningThreshold, startingBehavior);
2516     return *this;
2517 }
2518
2519 MdrunnerBuilder& MdrunnerBuilder::addDomainDecomposition(const DomdecOptions& options)
2520 {
2521     impl_->addDomdec(options);
2522     return *this;
2523 }
2524
2525 MdrunnerBuilder& MdrunnerBuilder::addNeighborList(int nstlist)
2526 {
2527     impl_->addVerletList(nstlist);
2528     return *this;
2529 }
2530
2531 MdrunnerBuilder& MdrunnerBuilder::addReplicaExchange(const ReplicaExchangeParameters& params)
2532 {
2533     impl_->addReplicaExchange(params);
2534     return *this;
2535 }
2536
2537 MdrunnerBuilder& MdrunnerBuilder::addNonBonded(const char* nbpu_opt)
2538 {
2539     impl_->addNonBonded(nbpu_opt);
2540     return *this;
2541 }
2542
2543 MdrunnerBuilder& MdrunnerBuilder::addElectrostatics(const char* pme_opt, const char* pme_fft_opt)
2544 {
2545     // The builder method may become more general in the future, but in this version,
2546     // parameters for PME electrostatics are both required and the only parameters
2547     // available.
2548     if (pme_opt && pme_fft_opt)
2549     {
2550         impl_->addPME(pme_opt, pme_fft_opt);
2551     }
2552     else
2553     {
2554         GMX_THROW(
2555                 gmx::InvalidInputError("addElectrostatics() arguments must be non-null pointers."));
2556     }
2557     return *this;
2558 }
2559
2560 MdrunnerBuilder& MdrunnerBuilder::addBondedTaskAssignment(const char* bonded_opt)
2561 {
2562     impl_->addBondedTaskAssignment(bonded_opt);
2563     return *this;
2564 }
2565
2566 MdrunnerBuilder& MdrunnerBuilder::addUpdateTaskAssignment(const char* update_opt)
2567 {
2568     impl_->addUpdateTaskAssignment(update_opt);
2569     return *this;
2570 }
2571
2572 Mdrunner MdrunnerBuilder::build()
2573 {
2574     return impl_->build();
2575 }
2576
2577 MdrunnerBuilder& MdrunnerBuilder::addHardwareOptions(const gmx_hw_opt_t& hardwareOptions)
2578 {
2579     impl_->addHardwareOptions(hardwareOptions);
2580     return *this;
2581 }
2582
2583 MdrunnerBuilder& MdrunnerBuilder::addFilenames(ArrayRef<const t_filenm> filenames)
2584 {
2585     impl_->addFilenames(filenames);
2586     return *this;
2587 }
2588
2589 MdrunnerBuilder& MdrunnerBuilder::addOutputEnvironment(gmx_output_env_t* outputEnvironment)
2590 {
2591     impl_->addOutputEnvironment(outputEnvironment);
2592     return *this;
2593 }
2594
2595 MdrunnerBuilder& MdrunnerBuilder::addLogFile(t_fileio* logFileHandle)
2596 {
2597     impl_->addLogFile(logFileHandle);
2598     return *this;
2599 }
2600
2601 MdrunnerBuilder& MdrunnerBuilder::addStopHandlerBuilder(std::unique_ptr<StopHandlerBuilder> builder)
2602 {
2603     impl_->addStopHandlerBuilder(std::move(builder));
2604     return *this;
2605 }
2606
2607 MdrunnerBuilder& MdrunnerBuilder::addInput(SimulationInputHandle input)
2608 {
2609     impl_->addInput(std::move(input));
2610     return *this;
2611 }
2612
2613 MdrunnerBuilder::MdrunnerBuilder(MdrunnerBuilder&&) noexcept = default;
2614
2615 MdrunnerBuilder& MdrunnerBuilder::operator=(MdrunnerBuilder&&) noexcept = default;
2616
2617 } // namespace gmx