2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2011,2012,2013,2014,2015,2016, 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.
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.
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.
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.
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.
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.
39 * \brief Implements the MD runner routine calling all integrators.
41 * \author David van der Spoel <david.vanderspoel@icm.uu.se>
42 * \ingroup module_mdlib
57 #include "gromacs/commandline/filenm.h"
58 #include "gromacs/domdec/domdec.h"
59 #include "gromacs/domdec/domdec_struct.h"
60 #include "gromacs/essentialdynamics/edsam.h"
61 #include "gromacs/ewald/pme.h"
62 #include "gromacs/fileio/checkpoint.h"
63 #include "gromacs/fileio/oenv.h"
64 #include "gromacs/fileio/tpxio.h"
65 #include "gromacs/gmxlib/network.h"
66 #include "gromacs/gpu_utils/gpu_utils.h"
67 #include "gromacs/hardware/cpuinfo.h"
68 #include "gromacs/hardware/detecthardware.h"
69 #include "gromacs/listed-forces/disre.h"
70 #include "gromacs/listed-forces/orires.h"
71 #include "gromacs/math/calculate-ewald-splitting-coefficient.h"
72 #include "gromacs/math/functions.h"
73 #include "gromacs/math/utilities.h"
74 #include "gromacs/math/vec.h"
75 #include "gromacs/mdlib/calc_verletbuf.h"
76 #include "gromacs/mdlib/constr.h"
77 #include "gromacs/mdlib/force.h"
78 #include "gromacs/mdlib/forcerec.h"
79 #include "gromacs/mdlib/gmx_omp_nthreads.h"
80 #include "gromacs/mdlib/integrator.h"
81 #include "gromacs/mdlib/main.h"
82 #include "gromacs/mdlib/md_support.h"
83 #include "gromacs/mdlib/mdatoms.h"
84 #include "gromacs/mdlib/mdrun.h"
85 #include "gromacs/mdlib/minimize.h"
86 #include "gromacs/mdlib/nbnxn_search.h"
87 #include "gromacs/mdlib/qmmm.h"
88 #include "gromacs/mdlib/sighandler.h"
89 #include "gromacs/mdlib/sim_util.h"
90 #include "gromacs/mdlib/tpi.h"
91 #include "gromacs/mdrunutility/mdmodules.h"
92 #include "gromacs/mdrunutility/threadaffinity.h"
93 #include "gromacs/mdtypes/commrec.h"
94 #include "gromacs/mdtypes/inputrec.h"
95 #include "gromacs/mdtypes/md_enums.h"
96 #include "gromacs/mdtypes/state.h"
97 #include "gromacs/pbcutil/pbc.h"
98 #include "gromacs/pulling/pull.h"
99 #include "gromacs/pulling/pull_rotation.h"
100 #include "gromacs/timing/wallcycle.h"
101 #include "gromacs/topology/mtop_util.h"
102 #include "gromacs/trajectory/trajectoryframe.h"
103 #include "gromacs/utility/cstringutil.h"
104 #include "gromacs/utility/exceptions.h"
105 #include "gromacs/utility/fatalerror.h"
106 #include "gromacs/utility/filestream.h"
107 #include "gromacs/utility/gmxassert.h"
108 #include "gromacs/utility/gmxmpi.h"
109 #include "gromacs/utility/logger.h"
110 #include "gromacs/utility/loggerbuilder.h"
111 #include "gromacs/utility/pleasecite.h"
112 #include "gromacs/utility/smalloc.h"
118 #include "resource-division.h"
121 #include "corewrap.h"
124 //! First step used in pressure scaling
125 gmx_int64_t deform_init_init_step_tpx
;
126 //! Initial box for pressure scaling
127 matrix deform_init_box_tpx
;
128 //! MPI variable for use in pressure scaling
129 tMPI_Thread_mutex_t deform_init_box_mutex
= TMPI_THREAD_MUTEX_INITIALIZER
;
132 /* The minimum number of atoms per tMPI thread. With fewer atoms than this,
133 * the number of threads will get lowered.
135 #define MIN_ATOMS_PER_MPI_THREAD 90
136 #define MIN_ATOMS_PER_GPU 900
138 struct mdrunner_arglist
145 const gmx_output_env_t
*oenv
;
153 const char *dddlb_opt
;
158 const char *nbpu_opt
;
160 gmx_int64_t nsteps_cmdline
;
175 /* The function used for spawning threads. Extracts the mdrunner()
176 arguments from its one argument and calls mdrunner(), after making
178 static void mdrunner_start_fn(void *arg
)
182 struct mdrunner_arglist
*mda
= (struct mdrunner_arglist
*)arg
;
183 struct mdrunner_arglist mc
= *mda
; /* copy the arg list to make sure
184 that it's thread-local. This doesn't
185 copy pointed-to items, of course,
186 but those are all const. */
187 t_commrec
*cr
; /* we need a local version of this */
191 fnm
= dup_tfn(mc
.nfile
, mc
.fnm
);
193 cr
= reinitialize_commrec_for_this_thread(mc
.cr
);
200 gmx::mdrunner(&mc
.hw_opt
, fplog
, cr
, mc
.nfile
, fnm
, mc
.oenv
,
201 mc
.bVerbose
, mc
.nstglobalcomm
,
202 mc
.ddxyz
, mc
.dd_rank_order
, mc
.npme
, mc
.rdd
,
203 mc
.rconstr
, mc
.dddlb_opt
, mc
.dlb_scale
,
204 mc
.ddcsx
, mc
.ddcsy
, mc
.ddcsz
,
205 mc
.nbpu_opt
, mc
.nstlist_cmdline
,
206 mc
.nsteps_cmdline
, mc
.nstepout
, mc
.resetstep
,
207 mc
.nmultisim
, mc
.repl_ex_nst
, mc
.repl_ex_nex
, mc
.repl_ex_seed
, mc
.pforce
,
208 mc
.cpt_period
, mc
.max_hours
, mc
.imdport
, mc
.Flags
);
210 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
;
214 /* called by mdrunner() to start a specific number of threads (including
215 the main thread) for thread-parallel runs. This in turn calls mdrunner()
217 All options besides nthreads are the same as for mdrunner(). */
218 static t_commrec
*mdrunner_start_threads(gmx_hw_opt_t
*hw_opt
,
219 FILE *fplog
, t_commrec
*cr
, int nfile
,
220 const t_filenm fnm
[], const gmx_output_env_t
*oenv
, gmx_bool bVerbose
,
222 ivec ddxyz
, int dd_rank_order
, int npme
,
223 real rdd
, real rconstr
,
224 const char *dddlb_opt
, real dlb_scale
,
225 const char *ddcsx
, const char *ddcsy
, const char *ddcsz
,
226 const char *nbpu_opt
, int nstlist_cmdline
,
227 gmx_int64_t nsteps_cmdline
,
228 int nstepout
, int resetstep
,
229 int nmultisim
, int repl_ex_nst
, int repl_ex_nex
, int repl_ex_seed
,
230 real pforce
, real cpt_period
, real max_hours
,
234 struct mdrunner_arglist
*mda
;
235 t_commrec
*crn
; /* the new commrec */
238 /* first check whether we even need to start tMPI */
239 if (hw_opt
->nthreads_tmpi
< 2)
244 /* a few small, one-time, almost unavoidable memory leaks: */
246 fnmn
= dup_tfn(nfile
, fnm
);
248 /* fill the data structure to pass as void pointer to thread start fn */
249 /* hw_opt contains pointers, which should all be NULL at this stage */
250 mda
->hw_opt
= *hw_opt
;
256 mda
->bVerbose
= bVerbose
;
257 mda
->nstglobalcomm
= nstglobalcomm
;
258 mda
->ddxyz
[XX
] = ddxyz
[XX
];
259 mda
->ddxyz
[YY
] = ddxyz
[YY
];
260 mda
->ddxyz
[ZZ
] = ddxyz
[ZZ
];
261 mda
->dd_rank_order
= dd_rank_order
;
264 mda
->rconstr
= rconstr
;
265 mda
->dddlb_opt
= dddlb_opt
;
266 mda
->dlb_scale
= dlb_scale
;
270 mda
->nbpu_opt
= nbpu_opt
;
271 mda
->nstlist_cmdline
= nstlist_cmdline
;
272 mda
->nsteps_cmdline
= nsteps_cmdline
;
273 mda
->nstepout
= nstepout
;
274 mda
->resetstep
= resetstep
;
275 mda
->nmultisim
= nmultisim
;
276 mda
->repl_ex_nst
= repl_ex_nst
;
277 mda
->repl_ex_nex
= repl_ex_nex
;
278 mda
->repl_ex_seed
= repl_ex_seed
;
279 mda
->pforce
= pforce
;
280 mda
->cpt_period
= cpt_period
;
281 mda
->max_hours
= max_hours
;
284 /* now spawn new threads that start mdrunner_start_fn(), while
285 the main thread returns, we set thread affinity later */
286 ret
= tMPI_Init_fn(TRUE
, hw_opt
->nthreads_tmpi
, TMPI_AFFINITY_NONE
,
287 mdrunner_start_fn
, (void*)(mda
) );
288 if (ret
!= TMPI_SUCCESS
)
293 crn
= reinitialize_commrec_for_this_thread(cr
);
297 #endif /* GMX_THREAD_MPI */
300 /*! \brief Cost of non-bonded kernels
302 * We determine the extra cost of the non-bonded kernels compared to
303 * a reference nstlist value of 10 (which is the default in grompp).
305 static const int nbnxnReferenceNstlist
= 10;
306 //! The values to try when switching
307 const int nstlist_try
[] = { 20, 25, 40 };
308 //! Number of elements in the neighborsearch list trials.
309 #define NNSTL sizeof(nstlist_try)/sizeof(nstlist_try[0])
310 /* Increase nstlist until the non-bonded cost increases more than listfac_ok,
311 * but never more than listfac_max.
312 * A standard (protein+)water system at 300K with PME ewald_rtol=1e-5
313 * needs 1.28 at rcoulomb=0.9 and 1.24 at rcoulomb=1.0 to get to nstlist=40.
314 * Note that both CPU and GPU factors are conservative. Performance should
315 * not go down due to this tuning, except with a relatively slow GPU.
316 * On the other hand, at medium/high parallelization or with fast GPUs
317 * nstlist will not be increased enough to reach optimal performance.
319 /* CPU: pair-search is about a factor 1.5 slower than the non-bonded kernel */
320 //! Max OK performance ratio beween force calc and neighbor searching
321 static const float nbnxn_cpu_listfac_ok
= 1.05;
322 //! Too high performance ratio beween force calc and neighbor searching
323 static const float nbnxn_cpu_listfac_max
= 1.09;
324 /* CPU: pair-search is about a factor 2-3 slower than the non-bonded kernel */
325 //! Max OK performance ratio beween force calc and neighbor searching
326 static const float nbnxn_knl_listfac_ok
= 1.22;
327 //! Too high performance ratio beween force calc and neighbor searching
328 static const float nbnxn_knl_listfac_max
= 1.3;
329 /* GPU: pair-search is a factor 1.5-3 slower than the non-bonded kernel */
330 //! Max OK performance ratio beween force calc and neighbor searching
331 static const float nbnxn_gpu_listfac_ok
= 1.20;
332 //! Too high performance ratio beween force calc and neighbor searching
333 static const float nbnxn_gpu_listfac_max
= 1.30;
335 /*! \brief Try to increase nstlist when using the Verlet cut-off scheme */
336 static void increase_nstlist(FILE *fp
, t_commrec
*cr
,
337 t_inputrec
*ir
, int nstlist_cmdline
,
338 const gmx_mtop_t
*mtop
, matrix box
,
339 gmx_bool bGPU
, const gmx::CpuInfo
&cpuinfo
)
341 float listfac_ok
, listfac_max
;
342 int nstlist_orig
, nstlist_prev
;
343 verletbuf_list_setup_t ls
;
344 real rlistWithReferenceNstlist
, rlist_inc
, rlist_ok
, rlist_max
;
345 real rlist_new
, rlist_prev
;
346 size_t nstlist_ind
= 0;
348 gmx_bool bBox
, bDD
, bCont
;
349 const char *nstl_gpu
= "\nFor optimal performance with a GPU nstlist (now %d) should be larger.\nThe optimum depends on your CPU and GPU resources.\nYou might want to try several nstlist values.\n";
350 const char *nve_err
= "Can not increase nstlist because an NVE ensemble is used";
351 const char *vbd_err
= "Can not increase nstlist because verlet-buffer-tolerance is not set or used";
352 const char *box_err
= "Can not increase nstlist because the box is too small";
353 const char *dd_err
= "Can not increase nstlist because of domain decomposition limitations";
356 if (nstlist_cmdline
<= 0)
358 if (ir
->nstlist
== 1)
360 /* The user probably set nstlist=1 for a reason,
361 * don't mess with the settings.
366 if (fp
!= NULL
&& bGPU
&& ir
->nstlist
< nstlist_try
[0])
368 fprintf(fp
, nstl_gpu
, ir
->nstlist
);
371 while (nstlist_ind
< NNSTL
&& ir
->nstlist
>= nstlist_try
[nstlist_ind
])
375 if (nstlist_ind
== NNSTL
)
377 /* There are no larger nstlist value to try */
382 if (EI_MD(ir
->eI
) && ir
->etc
== etcNO
)
386 fprintf(stderr
, "%s\n", nve_err
);
390 fprintf(fp
, "%s\n", nve_err
);
396 if (ir
->verletbuf_tol
== 0 && bGPU
)
398 gmx_fatal(FARGS
, "You are using an old tpr file with a GPU, please generate a new tpr file with an up to date version of grompp");
401 if (ir
->verletbuf_tol
< 0)
405 fprintf(stderr
, "%s\n", vbd_err
);
409 fprintf(fp
, "%s\n", vbd_err
);
417 listfac_ok
= nbnxn_gpu_listfac_ok
;
418 listfac_max
= nbnxn_gpu_listfac_max
;
420 else if (cpuinfo
.feature(gmx::CpuInfo::Feature::X86_Avx512ER
))
422 listfac_ok
= nbnxn_knl_listfac_ok
;
423 listfac_max
= nbnxn_knl_listfac_max
;
427 listfac_ok
= nbnxn_cpu_listfac_ok
;
428 listfac_max
= nbnxn_cpu_listfac_max
;
431 nstlist_orig
= ir
->nstlist
;
432 if (nstlist_cmdline
> 0)
436 sprintf(buf
, "Getting nstlist=%d from command line option",
439 ir
->nstlist
= nstlist_cmdline
;
442 verletbuf_get_list_setup(TRUE
, bGPU
, &ls
);
444 /* Allow rlist to make the list a given factor larger than the list
445 * would be with the reference value for nstlist (10).
447 nstlist_prev
= ir
->nstlist
;
448 ir
->nstlist
= nbnxnReferenceNstlist
;
449 calc_verlet_buffer_size(mtop
, det(box
), ir
, -1, &ls
, NULL
,
450 &rlistWithReferenceNstlist
);
451 ir
->nstlist
= nstlist_prev
;
453 /* Determine the pair list size increase due to zero interactions */
454 rlist_inc
= nbnxn_get_rlist_effective_inc(ls
.cluster_size_j
,
455 mtop
->natoms
/det(box
));
456 rlist_ok
= (rlistWithReferenceNstlist
+ rlist_inc
)*std::cbrt(listfac_ok
) - rlist_inc
;
457 rlist_max
= (rlistWithReferenceNstlist
+ rlist_inc
)*std::cbrt(listfac_max
) - rlist_inc
;
460 fprintf(debug
, "nstlist tuning: rlist_inc %.3f rlist_ok %.3f rlist_max %.3f\n",
461 rlist_inc
, rlist_ok
, rlist_max
);
464 nstlist_prev
= nstlist_orig
;
465 rlist_prev
= ir
->rlist
;
468 if (nstlist_cmdline
<= 0)
470 ir
->nstlist
= nstlist_try
[nstlist_ind
];
473 /* Set the pair-list buffer size in ir */
474 calc_verlet_buffer_size(mtop
, det(box
), ir
, -1, &ls
, NULL
, &rlist_new
);
476 /* Does rlist fit in the box? */
477 bBox
= (gmx::square(rlist_new
) < max_cutoff2(ir
->ePBC
, box
));
479 if (bBox
&& DOMAINDECOMP(cr
))
481 /* Check if rlist fits in the domain decomposition */
482 if (inputrec2nboundeddim(ir
) < DIM
)
484 gmx_incons("Changing nstlist with domain decomposition and unbounded dimensions is not implemented yet");
486 copy_mat(box
, state_tmp
.box
);
487 bDD
= change_dd_cutoff(cr
, &state_tmp
, ir
, rlist_new
);
492 fprintf(debug
, "nstlist %d rlist %.3f bBox %d bDD %d\n",
493 ir
->nstlist
, rlist_new
, bBox
, bDD
);
498 if (nstlist_cmdline
<= 0)
500 if (bBox
&& bDD
&& rlist_new
<= rlist_max
)
502 /* Increase nstlist */
503 nstlist_prev
= ir
->nstlist
;
504 rlist_prev
= rlist_new
;
505 bCont
= (nstlist_ind
+1 < NNSTL
&& rlist_new
< rlist_ok
);
509 /* Stick with the previous nstlist */
510 ir
->nstlist
= nstlist_prev
;
511 rlist_new
= rlist_prev
;
523 gmx_warning(!bBox
? box_err
: dd_err
);
526 fprintf(fp
, "\n%s\n", bBox
? box_err
: dd_err
);
528 ir
->nstlist
= nstlist_orig
;
530 else if (ir
->nstlist
!= nstlist_orig
|| rlist_new
!= ir
->rlist
)
532 sprintf(buf
, "Changing nstlist from %d to %d, rlist from %g to %g",
533 nstlist_orig
, ir
->nstlist
,
534 ir
->rlist
, rlist_new
);
537 fprintf(stderr
, "%s\n\n", buf
);
541 fprintf(fp
, "%s\n\n", buf
);
543 ir
->rlist
= rlist_new
;
547 /*! \brief Initialize variables for Verlet scheme simulation */
548 static void prepare_verlet_scheme(FILE *fplog
,
552 const gmx_mtop_t
*mtop
,
555 const gmx::CpuInfo
&cpuinfo
)
557 /* For NVE simulations, we will retain the initial list buffer */
558 if (EI_DYNAMICS(ir
->eI
) &&
559 ir
->verletbuf_tol
> 0 &&
560 !(EI_MD(ir
->eI
) && ir
->etc
== etcNO
))
562 /* Update the Verlet buffer size for the current run setup */
563 verletbuf_list_setup_t ls
;
566 /* Here we assume SIMD-enabled kernels are being used. But as currently
567 * calc_verlet_buffer_size gives the same results for 4x8 and 4x4
568 * and 4x2 gives a larger buffer than 4x4, this is ok.
570 verletbuf_get_list_setup(TRUE
, bUseGPU
, &ls
);
572 calc_verlet_buffer_size(mtop
, det(box
), ir
, -1, &ls
, NULL
, &rlist_new
);
574 if (rlist_new
!= ir
->rlist
)
578 fprintf(fplog
, "\nChanging rlist from %g to %g for non-bonded %dx%d atom kernels\n\n",
579 ir
->rlist
, rlist_new
,
580 ls
.cluster_size_i
, ls
.cluster_size_j
);
582 ir
->rlist
= rlist_new
;
586 if (nstlist_cmdline
> 0 && (!EI_DYNAMICS(ir
->eI
) || ir
->verletbuf_tol
<= 0))
588 gmx_fatal(FARGS
, "Can not set nstlist without %s",
589 !EI_DYNAMICS(ir
->eI
) ? "dynamics" : "verlet-buffer-tolerance");
592 if (EI_DYNAMICS(ir
->eI
))
594 /* Set or try nstlist values */
595 increase_nstlist(fplog
, cr
, ir
, nstlist_cmdline
, mtop
, box
, bUseGPU
, cpuinfo
);
599 /*! \brief Override the nslist value in inputrec
601 * with value passed on the command line (if any)
603 static void override_nsteps_cmdline(const gmx::MDLogger
&mdlog
,
604 gmx_int64_t nsteps_cmdline
,
609 /* override with anything else than the default -2 */
610 if (nsteps_cmdline
> -2)
612 char sbuf_steps
[STEPSTRSIZE
];
613 char sbuf_msg
[STRLEN
];
615 ir
->nsteps
= nsteps_cmdline
;
616 if (EI_DYNAMICS(ir
->eI
) && nsteps_cmdline
!= -1)
618 sprintf(sbuf_msg
, "Overriding nsteps with value passed on the command line: %s steps, %.3g ps",
619 gmx_step_str(nsteps_cmdline
, sbuf_steps
),
620 fabs(nsteps_cmdline
*ir
->delta_t
));
624 sprintf(sbuf_msg
, "Overriding nsteps with value passed on the command line: %s steps",
625 gmx_step_str(nsteps_cmdline
, sbuf_steps
));
628 GMX_LOG(mdlog
.warning
).asParagraph().appendText(sbuf_msg
);
630 else if (nsteps_cmdline
< -2)
632 gmx_fatal(FARGS
, "Invalid nsteps value passed on the command line: %d",
635 /* Do nothing if nsteps_cmdline == -2 */
641 //! \brief Return the correct integrator function.
642 static integrator_t
*my_integrator(unsigned int ei
)
651 if (!EI_DYNAMICS(ei
))
653 GMX_THROW(APIError("do_md integrator would be called for a non-dynamical integrator"));
668 GMX_THROW(APIError("do_tpi integrator would be called for a non-TPI integrator"));
672 GMX_THROW(NotImplementedError("SD2 integrator has been removed"));
674 GMX_THROW(APIError("Non existing integrator selected"));
678 //! Initializes the logger for mdrun.
679 static gmx::LoggerOwner
buildLogger(FILE *fplog
, const t_commrec
*cr
)
681 gmx::LoggerBuilder builder
;
684 builder
.addTargetFile(gmx::MDLogger::LogLevel::Info
, fplog
);
686 if (cr
== nullptr || SIMMASTER(cr
))
688 builder
.addTargetStream(gmx::MDLogger::LogLevel::Warning
,
689 &gmx::TextOutputFile::standardError());
691 return builder
.build();
694 int mdrunner(gmx_hw_opt_t
*hw_opt
,
695 FILE *fplog
, t_commrec
*cr
, int nfile
,
696 const t_filenm fnm
[], const gmx_output_env_t
*oenv
, gmx_bool bVerbose
,
698 ivec ddxyz
, int dd_rank_order
, int npme
, real rdd
, real rconstr
,
699 const char *dddlb_opt
, real dlb_scale
,
700 const char *ddcsx
, const char *ddcsy
, const char *ddcsz
,
701 const char *nbpu_opt
, int nstlist_cmdline
,
702 gmx_int64_t nsteps_cmdline
, int nstepout
, int resetstep
,
703 int gmx_unused nmultisim
, int repl_ex_nst
, int repl_ex_nex
,
704 int repl_ex_seed
, real pforce
, real cpt_period
, real max_hours
,
705 int imdport
, unsigned long Flags
)
707 gmx_bool bForceUseGPU
, bTryUseGPU
, bRerunMD
;
708 t_inputrec
*inputrec
;
709 t_state
*state
= NULL
;
711 gmx_ddbox_t ddbox
= {0};
712 int npme_major
, npme_minor
;
714 gmx_mtop_t
*mtop
= NULL
;
715 t_mdatoms
*mdatoms
= NULL
;
716 t_forcerec
*fr
= NULL
;
717 t_fcdata
*fcd
= NULL
;
718 real ewaldcoeff_q
= 0;
719 real ewaldcoeff_lj
= 0;
720 struct gmx_pme_t
**pmedata
= NULL
;
721 gmx_vsite_t
*vsite
= NULL
;
723 int nChargePerturbed
= -1, nTypePerturbed
= 0, status
;
724 gmx_wallcycle_t wcycle
;
725 gmx_walltime_accounting_t walltime_accounting
= NULL
;
727 gmx_int64_t reset_counters
;
728 gmx_edsam_t ed
= NULL
;
729 int nthreads_pme
= 1;
730 gmx_membed_t
* membed
= NULL
;
731 gmx_hw_info_t
*hwinfo
= NULL
;
732 /* The master rank decides early on bUseGPU and broadcasts this later */
733 gmx_bool bUseGPU
= FALSE
;
735 /* CAUTION: threads may be started later on in this function, so
736 cr doesn't reflect the final parallel state right now */
737 gmx::MDModules mdModules
;
738 inputrec
= mdModules
.inputrec();
741 if (Flags
& MD_APPENDFILES
)
746 bool doMembed
= opt2bSet("-membed", nfile
, fnm
);
747 bRerunMD
= (Flags
& MD_RERUN
);
748 bForceUseGPU
= (strncmp(nbpu_opt
, "gpu", 3) == 0);
749 bTryUseGPU
= (strncmp(nbpu_opt
, "auto", 4) == 0) || bForceUseGPU
;
751 // Here we assume that SIMMASTER(cr) does not change even after the
752 // threads are started.
753 gmx::LoggerOwner
logOwner(buildLogger(fplog
, cr
));
754 gmx::MDLogger
mdlog(logOwner
.logger());
756 /* Detect hardware, gather information. This is an operation that is
757 * global for this process (MPI rank). */
758 hwinfo
= gmx_detect_hardware(mdlog
, cr
, bTryUseGPU
);
760 gmx_print_detected_hardware(fplog
, cr
, mdlog
, hwinfo
);
764 /* Print references after all software/hardware printing */
765 please_cite(fplog
, "Abraham2015");
766 please_cite(fplog
, "Pall2015");
767 please_cite(fplog
, "Pronk2013");
768 please_cite(fplog
, "Hess2008b");
769 please_cite(fplog
, "Spoel2005a");
770 please_cite(fplog
, "Lindahl2001a");
771 please_cite(fplog
, "Berendsen95a");
777 /* Read (nearly) all data required for the simulation */
778 read_tpx_state(ftp2fn(efTPR
, nfile
, fnm
), inputrec
, state
, mtop
);
780 if (inputrec
->cutoff_scheme
== ecutsVERLET
)
782 /* Here the master rank decides if all ranks will use GPUs */
783 bUseGPU
= (hwinfo
->gpu_info
.n_dev_compatible
> 0 ||
784 getenv("GMX_EMULATE_GPU") != NULL
);
786 /* TODO add GPU kernels for this and replace this check by:
787 * (bUseGPU && (ir->vdwtype == evdwPME &&
788 * ir->ljpme_combination_rule == eljpmeLB))
789 * update the message text and the content of nbnxn_acceleration_supported.
792 !nbnxn_gpu_acceleration_supported(mdlog
, inputrec
, bRerunMD
))
794 /* Fallback message printed by nbnxn_acceleration_supported */
797 gmx_fatal(FARGS
, "GPU acceleration requested, but not supported with the given input settings");
802 prepare_verlet_scheme(fplog
, cr
,
803 inputrec
, nstlist_cmdline
, mtop
, state
->box
,
804 bUseGPU
, *hwinfo
->cpuInfo
);
808 if (nstlist_cmdline
> 0)
810 gmx_fatal(FARGS
, "Can not set nstlist with the group cut-off scheme");
813 if (hwinfo
->gpu_info
.n_dev_compatible
> 0)
815 GMX_LOG(mdlog
.warning
).asParagraph().appendText(
816 "NOTE: GPU(s) found, but the current simulation can not use GPUs\n"
817 " To use a GPU, set the mdp option: cutoff-scheme = Verlet");
822 gmx_fatal(FARGS
, "GPU requested, but can't be used without cutoff-scheme=Verlet");
826 md_print_warn(cr
, fplog
,
827 "NOTE: There is no SIMD implementation of the group scheme kernels on\n"
828 " BlueGene/Q. You will observe better performance from using the\n"
829 " Verlet cut-off scheme.\n");
834 /* Check and update the hardware options for internal consistency */
835 check_and_update_hw_opt_1(hw_opt
, cr
, npme
);
837 /* Early check for externally set process affinity. */
838 gmx_check_thread_affinity_set(mdlog
, cr
,
839 hw_opt
, hwinfo
->nthreads_hw_avail
, FALSE
);
844 if (npme
> 0 && hw_opt
->nthreads_tmpi
<= 0)
846 gmx_fatal(FARGS
, "You need to explicitly specify the number of MPI threads (-ntmpi) when using separate PME ranks");
849 /* Since the master knows the cut-off scheme, update hw_opt for this.
850 * This is done later for normal MPI and also once more with tMPI
851 * for all tMPI ranks.
853 check_and_update_hw_opt_2(hw_opt
, inputrec
->cutoff_scheme
);
855 /* NOW the threads will be started: */
856 hw_opt
->nthreads_tmpi
= get_nthreads_mpi(hwinfo
,
862 if (hw_opt
->nthreads_tmpi
> 1)
864 t_commrec
*cr_old
= cr
;
865 /* now start the threads. */
866 cr
= mdrunner_start_threads(hw_opt
, fplog
, cr_old
, nfile
, fnm
,
867 oenv
, bVerbose
, nstglobalcomm
,
868 ddxyz
, dd_rank_order
, npme
, rdd
, rconstr
,
869 dddlb_opt
, dlb_scale
, ddcsx
, ddcsy
, ddcsz
,
870 nbpu_opt
, nstlist_cmdline
,
871 nsteps_cmdline
, nstepout
, resetstep
, nmultisim
,
872 repl_ex_nst
, repl_ex_nex
, repl_ex_seed
, pforce
,
873 cpt_period
, max_hours
,
875 /* the main thread continues here with a new cr. We don't deallocate
876 the old cr because other threads may still be reading it. */
879 gmx_comm("Failed to spawn threads");
884 /* END OF CAUTION: cr is now reliable */
888 /* now broadcast everything to the non-master nodes/threads: */
889 init_parallel(cr
, inputrec
, mtop
);
891 /* The master rank decided on the use of GPUs,
892 * broadcast this information to all ranks.
894 gmx_bcast_sim(sizeof(bUseGPU
), &bUseGPU
, cr
);
899 pr_inputrec(fplog
, 0, "Input Parameters", inputrec
, FALSE
);
900 fprintf(fplog
, "\n");
903 /* now make sure the state is initialized and propagated */
904 set_state_entries(state
, inputrec
);
906 /* A parallel command line option consistency check that we can
907 only do after any threads have started. */
909 (ddxyz
[XX
] > 1 || ddxyz
[YY
] > 1 || ddxyz
[ZZ
] > 1 || npme
> 0))
912 "The -dd or -npme option request a parallel simulation, "
914 "but %s was compiled without threads or MPI enabled"
917 "but the number of MPI-threads (option -ntmpi) is not set or is 1"
919 "but %s was not started through mpirun/mpiexec or only one rank was requested through mpirun/mpiexec"
922 , output_env_get_program_display_name(oenv
)
927 (EI_ENERGY_MINIMIZATION(inputrec
->eI
) || eiNM
== inputrec
->eI
))
929 gmx_fatal(FARGS
, "The .mdp file specified an energy mininization or normal mode algorithm, and these are not compatible with mdrun -rerun");
932 if (can_use_allvsall(inputrec
, TRUE
, cr
, fplog
) && DOMAINDECOMP(cr
))
934 gmx_fatal(FARGS
, "All-vs-all loops do not work with domain decomposition, use a single MPI rank");
937 if (!(EEL_PME(inputrec
->coulombtype
) || EVDW_PME(inputrec
->vdwtype
)))
941 gmx_fatal_collective(FARGS
, cr
->mpi_comm_mysim
, MASTER(cr
),
942 "PME-only ranks are requested, but the system does not use PME for electrostatics or LJ");
948 if (bUseGPU
&& npme
< 0)
950 /* With GPUs we don't automatically use PME-only ranks. PME ranks can
951 * improve performance with many threads per GPU, since our OpenMP
952 * scaling is bad, but it's difficult to automate the setup.
960 fcRegisterSteps(inputrec
->nsteps
, inputrec
->init_step
);
964 /* NMR restraints must be initialized before load_checkpoint,
965 * since with time averaging the history is added to t_state.
966 * For proper consistency check we therefore need to extend
968 * So the PME-only nodes (if present) will also initialize
969 * the distance restraints.
973 /* This needs to be called before read_checkpoint to extend the state */
974 init_disres(fplog
, mtop
, inputrec
, cr
, fcd
, state
, repl_ex_nst
> 0);
976 init_orires(fplog
, mtop
, state
->x
, inputrec
, cr
, &(fcd
->orires
),
979 if (inputrecDeform(inputrec
))
981 /* Store the deform reference box before reading the checkpoint */
984 copy_mat(state
->box
, box
);
988 gmx_bcast(sizeof(box
), box
, cr
);
990 /* Because we do not have the update struct available yet
991 * in which the reference values should be stored,
992 * we store them temporarily in static variables.
993 * This should be thread safe, since they are only written once
994 * and with identical values.
996 tMPI_Thread_mutex_lock(&deform_init_box_mutex
);
997 deform_init_init_step_tpx
= inputrec
->init_step
;
998 copy_mat(box
, deform_init_box_tpx
);
999 tMPI_Thread_mutex_unlock(&deform_init_box_mutex
);
1002 if (Flags
& MD_STARTFROMCPT
)
1004 /* Check if checkpoint file exists before doing continuation.
1005 * This way we can use identical input options for the first and subsequent runs...
1009 load_checkpoint(opt2fn_master("-cpi", nfile
, fnm
, cr
), &fplog
,
1011 inputrec
, state
, &bReadEkin
,
1012 (Flags
& MD_APPENDFILES
),
1013 (Flags
& MD_APPENDFILESSET
),
1014 (Flags
& MD_REPRODUCIBLE
));
1018 Flags
|= MD_READ_EKIN
;
1022 if (SIMMASTER(cr
) && (Flags
& MD_APPENDFILES
))
1024 gmx_log_open(ftp2fn(efLOG
, nfile
, fnm
), cr
,
1026 logOwner
= buildLogger(fplog
, nullptr);
1027 mdlog
= logOwner
.logger();
1030 /* override nsteps with value from cmdline */
1031 override_nsteps_cmdline(mdlog
, nsteps_cmdline
, inputrec
);
1035 copy_mat(state
->box
, box
);
1040 gmx_bcast(sizeof(box
), box
, cr
);
1043 // TODO This should move to do_md(), because it only makes sense
1044 // with dynamical integrators, but there is no test coverage and
1045 // it interacts with constraints, somehow.
1046 /* Essential dynamics */
1047 if (opt2bSet("-ei", nfile
, fnm
))
1049 /* Open input and output files, allocate space for ED data structure */
1050 ed
= ed_open(mtop
->natoms
, &state
->edsamstate
, nfile
, fnm
, Flags
, oenv
, cr
);
1053 if (PAR(cr
) && !(EI_TPI(inputrec
->eI
) ||
1054 inputrec
->eI
== eiNM
))
1056 cr
->dd
= init_domain_decomposition(fplog
, cr
, Flags
, ddxyz
, npme
,
1059 dddlb_opt
, dlb_scale
,
1060 ddcsx
, ddcsy
, ddcsz
,
1063 &ddbox
, &npme_major
, &npme_minor
);
1067 /* PME, if used, is done on all nodes with 1D decomposition */
1069 cr
->duty
= (DUTY_PP
| DUTY_PME
);
1073 if (inputrec
->ePBC
== epbcSCREW
)
1076 "pbc=%s is only implemented with domain decomposition",
1077 epbc_names
[inputrec
->ePBC
]);
1083 /* After possible communicator splitting in make_dd_communicators.
1084 * we can set up the intra/inter node communication.
1086 gmx_setup_nodecomm(fplog
, cr
);
1089 /* Initialize per-physical-node MPI process/thread ID and counters. */
1090 gmx_init_intranode_counters(cr
);
1094 GMX_LOG(mdlog
.warning
).asParagraph().appendTextFormatted(
1095 "This is simulation %d out of %d running as a composite GROMACS\n"
1096 "multi-simulation job. Setup for this simulation:\n",
1097 cr
->ms
->sim
, cr
->ms
->nsim
);
1099 GMX_LOG(mdlog
.warning
).appendTextFormatted(
1100 "Using %d MPI %s\n",
1103 cr
->nnodes
== 1 ? "thread" : "threads"
1105 cr
->nnodes
== 1 ? "process" : "processes"
1111 /* Check and update hw_opt for the cut-off scheme */
1112 check_and_update_hw_opt_2(hw_opt
, inputrec
->cutoff_scheme
);
1114 /* Check and update hw_opt for the number of MPI ranks */
1115 check_and_update_hw_opt_3(hw_opt
);
1117 gmx_omp_nthreads_init(mdlog
, cr
,
1118 hwinfo
->nthreads_hw_avail
,
1119 hw_opt
->nthreads_omp
,
1120 hw_opt
->nthreads_omp_pme
,
1121 (cr
->duty
& DUTY_PP
) == 0,
1122 inputrec
->cutoff_scheme
== ecutsVERLET
);
1125 if (EI_TPI(inputrec
->eI
) &&
1126 inputrec
->cutoff_scheme
== ecutsVERLET
)
1128 gmx_feenableexcept();
1134 /* Select GPU id's to use */
1135 gmx_select_gpu_ids(mdlog
, cr
, &hwinfo
->gpu_info
, bForceUseGPU
,
1140 /* Ignore (potentially) manually selected GPUs */
1141 hw_opt
->gpu_opt
.n_dev_use
= 0;
1144 /* check consistency across ranks of things like SIMD
1145 * support and number of GPUs selected */
1146 gmx_check_hw_runconf_consistency(mdlog
, hwinfo
, cr
, hw_opt
, bUseGPU
);
1148 /* Now that we know the setup is consistent, check for efficiency */
1149 check_resource_division_efficiency(hwinfo
, hw_opt
, Flags
& MD_NTOMPSET
,
1152 if (DOMAINDECOMP(cr
))
1154 /* When we share GPUs over ranks, we need to know this for the DLB */
1155 dd_setup_dlb_resource_sharing(cr
, hwinfo
, hw_opt
);
1158 /* getting number of PP/PME threads
1159 PME: env variable should be read only on one node to make sure it is
1160 identical everywhere;
1162 nthreads_pme
= gmx_omp_nthreads_get(emntPME
);
1164 wcycle
= wallcycle_init(fplog
, resetstep
, cr
);
1168 /* Master synchronizes its value of reset_counters with all nodes
1169 * including PME only nodes */
1170 reset_counters
= wcycle_get_reset_counters(wcycle
);
1171 gmx_bcast_sim(sizeof(reset_counters
), &reset_counters
, cr
);
1172 wcycle_set_reset_counters(wcycle
, reset_counters
);
1175 // Membrane embedding must be initialized before we call init_forcerec()
1180 fprintf(stderr
, "Initializing membed");
1182 /* Note that membed cannot work in parallel because mtop is
1183 * changed here. Fix this if we ever want to make it run with
1184 * multiple ranks. */
1185 membed
= init_membed(fplog
, nfile
, fnm
, mtop
, inputrec
, state
, cr
, &cpt_period
);
1189 if (cr
->duty
& DUTY_PP
)
1191 bcast_state(cr
, state
);
1193 /* Initiate forcerecord */
1195 fr
->hwinfo
= hwinfo
;
1196 fr
->gpu_opt
= &hw_opt
->gpu_opt
;
1197 init_forcerec(fplog
, mdlog
, fr
, fcd
, inputrec
, mtop
, cr
, box
,
1198 opt2fn("-table", nfile
, fnm
),
1199 opt2fn("-tablep", nfile
, fnm
),
1200 getFilenm("-tableb", nfile
, fnm
),
1205 /* Initialize QM-MM */
1208 init_QMMMrec(cr
, mtop
, inputrec
, fr
);
1211 /* Initialize the mdatoms structure.
1212 * mdatoms is not filled with atom data,
1213 * as this can not be done now with domain decomposition.
1215 mdatoms
= init_mdatoms(fplog
, mtop
, inputrec
->efep
!= efepNO
);
1217 /* Initialize the virtual site communication */
1218 vsite
= init_vsite(mtop
, cr
, FALSE
);
1220 calc_shifts(box
, fr
->shift_vec
);
1222 /* With periodic molecules the charge groups should be whole at start up
1223 * and the virtual sites should not be far from their proper positions.
1225 if (!inputrec
->bContinuation
&& MASTER(cr
) &&
1226 !(inputrec
->ePBC
!= epbcNONE
&& inputrec
->bPeriodicMols
))
1228 /* Make molecules whole at start of run */
1229 if (fr
->ePBC
!= epbcNONE
)
1231 do_pbc_first_mtop(fplog
, inputrec
->ePBC
, box
, mtop
, state
->x
);
1235 /* Correct initial vsite positions are required
1236 * for the initial distribution in the domain decomposition
1237 * and for the initial shell prediction.
1239 construct_vsites_mtop(vsite
, mtop
, state
->x
);
1243 if (EEL_PME(fr
->eeltype
) || EVDW_PME(fr
->vdwtype
))
1245 ewaldcoeff_q
= fr
->ewaldcoeff_q
;
1246 ewaldcoeff_lj
= fr
->ewaldcoeff_lj
;
1247 pmedata
= &fr
->pmedata
;
1256 /* This is a PME only node */
1258 /* We don't need the state */
1261 ewaldcoeff_q
= calc_ewaldcoeff_q(inputrec
->rcoulomb
, inputrec
->ewald_rtol
);
1262 ewaldcoeff_lj
= calc_ewaldcoeff_lj(inputrec
->rvdw
, inputrec
->ewald_rtol_lj
);
1266 if (hw_opt
->thread_affinity
!= threadaffOFF
)
1268 /* Before setting affinity, check whether the affinity has changed
1269 * - which indicates that probably the OpenMP library has changed it
1270 * since we first checked).
1272 gmx_check_thread_affinity_set(mdlog
, cr
,
1273 hw_opt
, hwinfo
->nthreads_hw_avail
, TRUE
);
1276 /* threads on this MPI process or TMPI thread */
1277 if (cr
->duty
& DUTY_PP
)
1279 nthread_local
= gmx_omp_nthreads_get(emntNonbonded
);
1283 nthread_local
= gmx_omp_nthreads_get(emntPME
);
1286 /* Set the CPU affinity */
1287 gmx_set_thread_affinity(fplog
, mdlog
, cr
, hw_opt
, *hwinfo
->hardwareTopology
,
1288 nthread_local
, nullptr);
1291 /* Initiate PME if necessary,
1292 * either on all nodes or on dedicated PME nodes only. */
1293 if (EEL_PME(inputrec
->coulombtype
) || EVDW_PME(inputrec
->vdwtype
))
1297 nChargePerturbed
= mdatoms
->nChargePerturbed
;
1298 if (EVDW_PME(inputrec
->vdwtype
))
1300 nTypePerturbed
= mdatoms
->nTypePerturbed
;
1303 if (cr
->npmenodes
> 0)
1305 /* The PME only nodes need to know nChargePerturbed(FEP on Q) and nTypePerturbed(FEP on LJ)*/
1306 gmx_bcast_sim(sizeof(nChargePerturbed
), &nChargePerturbed
, cr
);
1307 gmx_bcast_sim(sizeof(nTypePerturbed
), &nTypePerturbed
, cr
);
1310 if (cr
->duty
& DUTY_PME
)
1312 status
= gmx_pme_init(pmedata
, cr
, npme_major
, npme_minor
, inputrec
,
1313 mtop
? mtop
->natoms
: 0, nChargePerturbed
, nTypePerturbed
,
1314 (Flags
& MD_REPRODUCIBLE
),
1315 ewaldcoeff_q
, ewaldcoeff_lj
,
1319 gmx_fatal(FARGS
, "Error %d initializing PME", status
);
1325 if (EI_DYNAMICS(inputrec
->eI
))
1327 /* Turn on signal handling on all nodes */
1329 * (A user signal from the PME nodes (if any)
1330 * is communicated to the PP nodes.
1332 signal_handler_install();
1335 if (cr
->duty
& DUTY_PP
)
1337 /* Assumes uniform use of the number of OpenMP threads */
1338 walltime_accounting
= walltime_accounting_init(gmx_omp_nthreads_get(emntDefault
));
1340 if (inputrec
->bPull
)
1342 /* Initialize pull code */
1343 inputrec
->pull_work
=
1344 init_pull(fplog
, inputrec
->pull
, inputrec
, nfile
, fnm
,
1345 mtop
, cr
, oenv
, inputrec
->fepvals
->init_lambda
,
1346 EI_DYNAMICS(inputrec
->eI
) && MASTER(cr
), Flags
);
1351 /* Initialize enforced rotation code */
1352 init_rot(fplog
, inputrec
, nfile
, fnm
, cr
, state
->x
, state
->box
, mtop
, oenv
,
1356 constr
= init_constraints(fplog
, mtop
, inputrec
, ed
, state
, cr
);
1358 if (DOMAINDECOMP(cr
))
1360 GMX_RELEASE_ASSERT(fr
, "fr was NULL while cr->duty was DUTY_PP");
1361 /* This call is not included in init_domain_decomposition mainly
1362 * because fr->cginfo_mb is set later.
1364 dd_init_bondeds(fplog
, cr
->dd
, mtop
, vsite
, inputrec
,
1365 Flags
& MD_DDBONDCHECK
, fr
->cginfo_mb
);
1368 /* Now do whatever the user wants us to do (how flexible...) */
1369 my_integrator(inputrec
->eI
) (fplog
, cr
, mdlog
, nfile
, fnm
,
1373 nstepout
, inputrec
, mtop
,
1375 mdatoms
, nrnb
, wcycle
, ed
, fr
,
1376 repl_ex_nst
, repl_ex_nex
, repl_ex_seed
,
1378 cpt_period
, max_hours
,
1381 walltime_accounting
);
1385 finish_rot(inputrec
->rot
);
1388 if (inputrec
->bPull
)
1390 finish_pull(inputrec
->pull_work
);
1396 GMX_RELEASE_ASSERT(pmedata
, "pmedata was NULL while cr->duty was not DUTY_PP");
1398 walltime_accounting
= walltime_accounting_init(gmx_omp_nthreads_get(emntPME
));
1399 gmx_pmeonly(*pmedata
, cr
, nrnb
, wcycle
, walltime_accounting
, ewaldcoeff_q
, ewaldcoeff_lj
, inputrec
);
1402 wallcycle_stop(wcycle
, ewcRUN
);
1404 /* Finish up, write some stuff
1405 * if rerunMD, don't write last frame again
1407 finish_run(fplog
, mdlog
, cr
,
1408 inputrec
, nrnb
, wcycle
, walltime_accounting
,
1409 fr
? fr
->nbv
: NULL
,
1410 EI_DYNAMICS(inputrec
->eI
) && !MULTISIM(cr
));
1415 gmx_pme_destroy(pmedata
);
1419 /* Free GPU memory and context */
1420 free_gpu_resources(fr
, cr
, &hwinfo
->gpu_info
, fr
? fr
->gpu_opt
: NULL
);
1424 free_membed(membed
);
1427 gmx_hardware_info_free(hwinfo
);
1429 /* Does what it says */
1430 print_date_and_time(fplog
, cr
->nodeid
, "Finished mdrun", gmx_gettime());
1431 walltime_accounting_destroy(walltime_accounting
);
1433 /* Close logfile already here if we were appending to it */
1434 if (MASTER(cr
) && (Flags
& MD_APPENDFILES
))
1436 gmx_log_close(fplog
);
1439 rc
= (int)gmx_get_stop_condition();
1444 /* we need to join all threads. The sub-threads join when they
1445 exit this function, but the master thread needs to be told to
1447 if (PAR(cr
) && MASTER(cr
))