Merge branch release-4-6
[alexxy/gromacs.git] / src / programs / mdrun / runner.c
1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
2  *
3  *
4  *                This source code is part of
5  *
6  *                 G   R   O   M   A   C   S
7  *
8  *          GROningen MAchine for Chemical Simulations
9  *
10  *                        VERSION 3.2.0
11  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
12  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
13  * Copyright (c) 2001-2004, The GROMACS development team,
14  * check out http://www.gromacs.org for more information.
15
16  * This program is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU General Public License
18  * as published by the Free Software Foundation; either version 2
19  * of the License, or (at your option) any later version.
20  *
21  * If you want to redistribute modifications, please consider that
22  * scientific software is very special. Version control is crucial -
23  * bugs must be traceable. We will be happy to consider code for
24  * inclusion in the official distribution, but derived work must not
25  * be called official GROMACS. Details are found in the README & COPYING
26  * files - if they are missing, get the official version at www.gromacs.org.
27  *
28  * To help us fund GROMACS development, we humbly ask that you cite
29  * the papers on the package - you can find them in the top README file.
30  *
31  * For more info, check our website at http://www.gromacs.org
32  *
33  * And Hey:
34  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
35  */
36 #ifdef HAVE_CONFIG_H
37 #include <config.h>
38 #endif
39 #include <signal.h>
40 #include <stdlib.h>
41 #ifdef HAVE_UNISTD_H
42 #include <unistd.h>
43 #endif
44 #include <string.h>
45 #include <assert.h>
46
47 #include "typedefs.h"
48 #include "smalloc.h"
49 #include "sysstuff.h"
50 #include "statutil.h"
51 #include "force.h"
52 #include "mdrun.h"
53 #include "md_logging.h"
54 #include "md_support.h"
55 #include "network.h"
56 #include "pull.h"
57 #include "pull_rotation.h"
58 #include "names.h"
59 #include "disre.h"
60 #include "orires.h"
61 #include "pme.h"
62 #include "mdatoms.h"
63 #include "repl_ex.h"
64 #include "qmmm.h"
65 #include "domdec.h"
66 #include "partdec.h"
67 #include "coulomb.h"
68 #include "constr.h"
69 #include "mvdata.h"
70 #include "checkpoint.h"
71 #include "mtop_util.h"
72 #include "sighandler.h"
73 #include "tpxio.h"
74 #include "txtdump.h"
75 #include "gmx_detect_hardware.h"
76 #include "gmx_omp_nthreads.h"
77 #include "pull_rotation.h"
78 #include "calc_verletbuf.h"
79 #include "../mdlib/nbnxn_search.h"
80 #include "../mdlib/nbnxn_consts.h"
81 #include "gmx_fatal_collective.h"
82 #include "membed.h"
83 #include "macros.h"
84 #include "gmx_omp.h"
85 #include "gmx_thread_affinity.h"
86
87 #include "gromacs/utility/gmxmpi.h"
88
89 #ifdef GMX_FAHCORE
90 #include "corewrap.h"
91 #endif
92
93 #include "gpu_utils.h"
94 #include "nbnxn_cuda_data_mgmt.h"
95
96 typedef struct {
97     gmx_integrator_t *func;
98 } gmx_intp_t;
99
100 /* The array should match the eI array in include/types/enums.h */
101 const gmx_intp_t    integrator[eiNR] = { {do_md}, {do_steep}, {do_cg}, {do_md}, {do_md}, {do_nm}, {do_lbfgs}, {do_tpi}, {do_tpi}, {do_md}, {do_md}, {do_md}};
102
103 gmx_large_int_t     deform_init_init_step_tpx;
104 matrix              deform_init_box_tpx;
105 #ifdef GMX_THREAD_MPI
106 tMPI_Thread_mutex_t deform_init_box_mutex = TMPI_THREAD_MUTEX_INITIALIZER;
107 #endif
108
109
110 #ifdef GMX_THREAD_MPI
111 struct mdrunner_arglist
112 {
113     gmx_hw_opt_t   *hw_opt;
114     FILE           *fplog;
115     t_commrec      *cr;
116     int             nfile;
117     const t_filenm *fnm;
118     output_env_t    oenv;
119     gmx_bool        bVerbose;
120     gmx_bool        bCompact;
121     int             nstglobalcomm;
122     ivec            ddxyz;
123     int             dd_node_order;
124     real            rdd;
125     real            rconstr;
126     const char     *dddlb_opt;
127     real            dlb_scale;
128     const char     *ddcsx;
129     const char     *ddcsy;
130     const char     *ddcsz;
131     const char     *nbpu_opt;
132     gmx_large_int_t nsteps_cmdline;
133     int             nstepout;
134     int             resetstep;
135     int             nmultisim;
136     int             repl_ex_nst;
137     int             repl_ex_nex;
138     int             repl_ex_seed;
139     real            pforce;
140     real            cpt_period;
141     real            max_hours;
142     const char     *deviceOptions;
143     unsigned long   Flags;
144     int             ret; /* return value */
145 };
146
147
148 /* The function used for spawning threads. Extracts the mdrunner()
149    arguments from its one argument and calls mdrunner(), after making
150    a commrec. */
151 static void mdrunner_start_fn(void *arg)
152 {
153     struct mdrunner_arglist *mda = (struct mdrunner_arglist*)arg;
154     struct mdrunner_arglist  mc  = *mda; /* copy the arg list to make sure
155                                             that it's thread-local. This doesn't
156                                             copy pointed-to items, of course,
157                                             but those are all const. */
158     t_commrec *cr;                       /* we need a local version of this */
159     FILE      *fplog = NULL;
160     t_filenm  *fnm;
161
162     fnm = dup_tfn(mc.nfile, mc.fnm);
163
164     cr = init_par_threads(mc.cr);
165
166     if (MASTER(cr))
167     {
168         fplog = mc.fplog;
169     }
170
171     mda->ret = mdrunner(mc.hw_opt, fplog, cr, mc.nfile, fnm, mc.oenv,
172                         mc.bVerbose, mc.bCompact, mc.nstglobalcomm,
173                         mc.ddxyz, mc.dd_node_order, mc.rdd,
174                         mc.rconstr, mc.dddlb_opt, mc.dlb_scale,
175                         mc.ddcsx, mc.ddcsy, mc.ddcsz,
176                         mc.nbpu_opt,
177                         mc.nsteps_cmdline, mc.nstepout, mc.resetstep,
178                         mc.nmultisim, mc.repl_ex_nst, mc.repl_ex_nex, mc.repl_ex_seed, mc.pforce,
179                         mc.cpt_period, mc.max_hours, mc.deviceOptions, mc.Flags);
180 }
181
182 /* called by mdrunner() to start a specific number of threads (including
183    the main thread) for thread-parallel runs. This in turn calls mdrunner()
184    for each thread.
185    All options besides nthreads are the same as for mdrunner(). */
186 static t_commrec *mdrunner_start_threads(gmx_hw_opt_t *hw_opt,
187                                          FILE *fplog, t_commrec *cr, int nfile,
188                                          const t_filenm fnm[], const output_env_t oenv, gmx_bool bVerbose,
189                                          gmx_bool bCompact, int nstglobalcomm,
190                                          ivec ddxyz, int dd_node_order, real rdd, real rconstr,
191                                          const char *dddlb_opt, real dlb_scale,
192                                          const char *ddcsx, const char *ddcsy, const char *ddcsz,
193                                          const char *nbpu_opt,
194                                          gmx_large_int_t nsteps_cmdline,
195                                          int nstepout, int resetstep,
196                                          int nmultisim, int repl_ex_nst, int repl_ex_nex, int repl_ex_seed,
197                                          real pforce, real cpt_period, real max_hours,
198                                          const char *deviceOptions, unsigned long Flags)
199 {
200     int                      ret;
201     struct mdrunner_arglist *mda;
202     t_commrec               *crn; /* the new commrec */
203     t_filenm                *fnmn;
204
205     /* first check whether we even need to start tMPI */
206     if (hw_opt->nthreads_tmpi < 2)
207     {
208         return cr;
209     }
210
211     /* a few small, one-time, almost unavoidable memory leaks: */
212     snew(mda, 1);
213     fnmn = dup_tfn(nfile, fnm);
214
215     /* fill the data structure to pass as void pointer to thread start fn */
216     mda->hw_opt         = hw_opt;
217     mda->fplog          = fplog;
218     mda->cr             = cr;
219     mda->nfile          = nfile;
220     mda->fnm            = fnmn;
221     mda->oenv           = oenv;
222     mda->bVerbose       = bVerbose;
223     mda->bCompact       = bCompact;
224     mda->nstglobalcomm  = nstglobalcomm;
225     mda->ddxyz[XX]      = ddxyz[XX];
226     mda->ddxyz[YY]      = ddxyz[YY];
227     mda->ddxyz[ZZ]      = ddxyz[ZZ];
228     mda->dd_node_order  = dd_node_order;
229     mda->rdd            = rdd;
230     mda->rconstr        = rconstr;
231     mda->dddlb_opt      = dddlb_opt;
232     mda->dlb_scale      = dlb_scale;
233     mda->ddcsx          = ddcsx;
234     mda->ddcsy          = ddcsy;
235     mda->ddcsz          = ddcsz;
236     mda->nbpu_opt       = nbpu_opt;
237     mda->nsteps_cmdline = nsteps_cmdline;
238     mda->nstepout       = nstepout;
239     mda->resetstep      = resetstep;
240     mda->nmultisim      = nmultisim;
241     mda->repl_ex_nst    = repl_ex_nst;
242     mda->repl_ex_nex    = repl_ex_nex;
243     mda->repl_ex_seed   = repl_ex_seed;
244     mda->pforce         = pforce;
245     mda->cpt_period     = cpt_period;
246     mda->max_hours      = max_hours;
247     mda->deviceOptions  = deviceOptions;
248     mda->Flags          = Flags;
249
250     /* now spawn new threads that start mdrunner_start_fn(), while
251        the main thread returns, we set thread affinity later */
252     ret = tMPI_Init_fn(TRUE, hw_opt->nthreads_tmpi, TMPI_AFFINITY_NONE,
253                        mdrunner_start_fn, (void*)(mda) );
254     if (ret != TMPI_SUCCESS)
255     {
256         return NULL;
257     }
258
259     /* make a new comm_rec to reflect the new situation */
260     crn = init_par_threads(cr);
261     return crn;
262 }
263
264
265 static int get_tmpi_omp_thread_division(const gmx_hw_info_t *hwinfo,
266                                         const gmx_hw_opt_t  *hw_opt,
267                                         int                  nthreads_tot,
268                                         int                  ngpu)
269 {
270     int nthreads_tmpi;
271
272     /* There are no separate PME nodes here, as we ensured in
273      * check_and_update_hw_opt that nthreads_tmpi>0 with PME nodes
274      * and a conditional ensures we would not have ended up here.
275      * Note that separate PME nodes might be switched on later.
276      */
277     if (ngpu > 0)
278     {
279         nthreads_tmpi = ngpu;
280         if (nthreads_tot > 0 && nthreads_tot < nthreads_tmpi)
281         {
282             nthreads_tmpi = nthreads_tot;
283         }
284     }
285     else if (hw_opt->nthreads_omp > 0)
286     {
287         /* Here we could oversubscribe, when we do, we issue a warning later */
288         nthreads_tmpi = max(1, nthreads_tot/hw_opt->nthreads_omp);
289     }
290     else
291     {
292         /* TODO choose nthreads_omp based on hardware topology
293            when we have a hardware topology detection library */
294         /* In general, when running up to 4 threads, OpenMP should be faster.
295          * Note: on AMD Bulldozer we should avoid running OpenMP over two dies.
296          * On Intel>=Nehalem running OpenMP on a single CPU is always faster,
297          * even on two CPUs it's usually faster (but with many OpenMP threads
298          * it could be faster not to use HT, currently we always use HT).
299          * On Nehalem/Westmere we want to avoid running 16 threads over
300          * two CPUs with HT, so we need a limit<16; thus we use 12.
301          * A reasonable limit for Intel Sandy and Ivy bridge,
302          * not knowing the topology, is 16 threads.
303          */
304         const int nthreads_omp_always_faster             =  4;
305         const int nthreads_omp_always_faster_Nehalem     = 12;
306         const int nthreads_omp_always_faster_SandyBridge = 16;
307         const int first_model_Nehalem                    = 0x1A;
308         const int first_model_SandyBridge                = 0x2A;
309         gmx_bool  bIntel_Family6;
310
311         bIntel_Family6 =
312             (gmx_cpuid_vendor(hwinfo->cpuid_info) == GMX_CPUID_VENDOR_INTEL &&
313              gmx_cpuid_family(hwinfo->cpuid_info) == 6);
314
315         if (nthreads_tot <= nthreads_omp_always_faster ||
316             (bIntel_Family6 &&
317              ((gmx_cpuid_model(hwinfo->cpuid_info) >= nthreads_omp_always_faster_Nehalem && nthreads_tot <= nthreads_omp_always_faster_Nehalem) ||
318               (gmx_cpuid_model(hwinfo->cpuid_info) >= nthreads_omp_always_faster_SandyBridge && nthreads_tot <= nthreads_omp_always_faster_SandyBridge))))
319         {
320             /* Use pure OpenMP parallelization */
321             nthreads_tmpi = 1;
322         }
323         else
324         {
325             /* Don't use OpenMP parallelization */
326             nthreads_tmpi = nthreads_tot;
327         }
328     }
329
330     return nthreads_tmpi;
331 }
332
333
334 /* Get the number of threads to use for thread-MPI based on how many
335  * were requested, which algorithms we're using,
336  * and how many particles there are.
337  * At the point we have already called check_and_update_hw_opt.
338  * Thus all options should be internally consistent and consistent
339  * with the hardware, except that ntmpi could be larger than #GPU.
340  */
341 static int get_nthreads_mpi(const gmx_hw_info_t *hwinfo,
342                             gmx_hw_opt_t *hw_opt,
343                             t_inputrec *inputrec, gmx_mtop_t *mtop,
344                             const t_commrec *cr,
345                             FILE *fplog)
346 {
347     int      nthreads_hw, nthreads_tot_max, nthreads_tmpi, nthreads_new, ngpu;
348     int      min_atoms_per_mpi_thread;
349     char    *env;
350     char     sbuf[STRLEN];
351     gmx_bool bCanUseGPU;
352
353     if (hw_opt->nthreads_tmpi > 0)
354     {
355         /* Trivial, return right away */
356         return hw_opt->nthreads_tmpi;
357     }
358
359     nthreads_hw = hwinfo->nthreads_hw_avail;
360
361     /* How many total (#tMPI*#OpenMP) threads can we start? */
362     if (hw_opt->nthreads_tot > 0)
363     {
364         nthreads_tot_max = hw_opt->nthreads_tot;
365     }
366     else
367     {
368         nthreads_tot_max = nthreads_hw;
369     }
370
371     bCanUseGPU = (inputrec->cutoff_scheme == ecutsVERLET && hwinfo->bCanUseGPU);
372     if (bCanUseGPU)
373     {
374         ngpu = hwinfo->gpu_info.ncuda_dev_use;
375     }
376     else
377     {
378         ngpu = 0;
379     }
380
381     nthreads_tmpi =
382         get_tmpi_omp_thread_division(hwinfo, hw_opt, nthreads_tot_max, ngpu);
383
384     if (inputrec->eI == eiNM || EI_TPI(inputrec->eI))
385     {
386         /* Dims/steps are divided over the nodes iso splitting the atoms */
387         min_atoms_per_mpi_thread = 0;
388     }
389     else
390     {
391         if (bCanUseGPU)
392         {
393             min_atoms_per_mpi_thread = MIN_ATOMS_PER_GPU;
394         }
395         else
396         {
397             min_atoms_per_mpi_thread = MIN_ATOMS_PER_MPI_THREAD;
398         }
399     }
400
401     /* Check if an algorithm does not support parallel simulation.  */
402     if (nthreads_tmpi != 1 &&
403         ( inputrec->eI == eiLBFGS ||
404           inputrec->coulombtype == eelEWALD ) )
405     {
406         nthreads_tmpi = 1;
407
408         md_print_warn(cr, fplog, "The integration or electrostatics algorithm doesn't support parallel runs. Using a single thread-MPI thread.\n");
409         if (hw_opt->nthreads_tmpi > nthreads_tmpi)
410         {
411             gmx_fatal(FARGS, "You asked for more than 1 thread-MPI thread, but an algorithm doesn't support that");
412         }
413     }
414     else if (mtop->natoms/nthreads_tmpi < min_atoms_per_mpi_thread)
415     {
416         /* the thread number was chosen automatically, but there are too many
417            threads (too few atoms per thread) */
418         nthreads_new = max(1, mtop->natoms/min_atoms_per_mpi_thread);
419
420         /* Avoid partial use of Hyper-Threading */
421         if (gmx_cpuid_x86_smt(hwinfo->cpuid_info) == GMX_CPUID_X86_SMT_ENABLED &&
422             nthreads_new > nthreads_hw/2 && nthreads_new < nthreads_hw)
423         {
424             nthreads_new = nthreads_hw/2;
425         }
426
427         /* Avoid large prime numbers in the thread count */
428         if (nthreads_new >= 6)
429         {
430             /* Use only 6,8,10 with additional factors of 2 */
431             int fac;
432
433             fac = 2;
434             while (3*fac*2 <= nthreads_new)
435             {
436                 fac *= 2;
437             }
438
439             nthreads_new = (nthreads_new/fac)*fac;
440         }
441         else
442         {
443             /* Avoid 5 */
444             if (nthreads_new == 5)
445             {
446                 nthreads_new = 4;
447             }
448         }
449
450         nthreads_tmpi = nthreads_new;
451
452         fprintf(stderr, "\n");
453         fprintf(stderr, "NOTE: Parallelization is limited by the small number of atoms,\n");
454         fprintf(stderr, "      only starting %d thread-MPI threads.\n", nthreads_tmpi);
455         fprintf(stderr, "      You can use the -nt and/or -ntmpi option to optimize the number of threads.\n\n");
456     }
457
458     return nthreads_tmpi;
459 }
460 #endif /* GMX_THREAD_MPI */
461
462
463 /* Environment variable for setting nstlist */
464 static const char*  NSTLIST_ENVVAR          =  "GMX_NSTLIST";
465 /* Try to increase nstlist when using a GPU with nstlist less than this */
466 static const int    NSTLIST_GPU_ENOUGH      = 20;
467 /* Increase nstlist until the non-bonded cost increases more than this factor */
468 static const float  NBNXN_GPU_LIST_OK_FAC   = 1.25;
469 /* Don't increase nstlist beyond a non-bonded cost increases of this factor */
470 static const float  NBNXN_GPU_LIST_MAX_FAC  = 1.40;
471
472 /* Try to increase nstlist when running on a GPU */
473 static void increase_nstlist(FILE *fp, t_commrec *cr,
474                              t_inputrec *ir, const gmx_mtop_t *mtop, matrix box)
475 {
476     char                  *env;
477     int                    nstlist_orig, nstlist_prev;
478     verletbuf_list_setup_t ls;
479     real                   rlist_inc, rlist_ok, rlist_max, rlist_new, rlist_prev;
480     int                    i;
481     t_state                state_tmp;
482     gmx_bool               bBox, bDD, bCont;
483     const char            *nstl_fmt = "\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";
484     const char            *vbd_err  = "Can not increase nstlist for GPU run because verlet-buffer-drift is not set or used";
485     const char            *box_err  = "Can not increase nstlist for GPU run because the box is too small";
486     const char            *dd_err   = "Can not increase nstlist for GPU run because of domain decomposition limitations";
487     char                   buf[STRLEN];
488
489     /* Number of + nstlist alternative values to try when switching  */
490     const int nstl[] = { 20, 25, 40, 50 };
491 #define NNSTL  sizeof(nstl)/sizeof(nstl[0])
492
493     env = getenv(NSTLIST_ENVVAR);
494     if (env == NULL)
495     {
496         if (fp != NULL)
497         {
498             fprintf(fp, nstl_fmt, ir->nstlist);
499         }
500     }
501
502     if (ir->verletbuf_drift == 0)
503     {
504         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");
505     }
506
507     if (ir->verletbuf_drift < 0)
508     {
509         if (MASTER(cr))
510         {
511             fprintf(stderr, "%s\n", vbd_err);
512         }
513         if (fp != NULL)
514         {
515             fprintf(fp, "%s\n", vbd_err);
516         }
517
518         return;
519     }
520
521     nstlist_orig = ir->nstlist;
522     if (env != NULL)
523     {
524         sprintf(buf, "Getting nstlist from environment variable GMX_NSTLIST=%s", env);
525         if (MASTER(cr))
526         {
527             fprintf(stderr, "%s\n", buf);
528         }
529         if (fp != NULL)
530         {
531             fprintf(fp, "%s\n", buf);
532         }
533         sscanf(env, "%d", &ir->nstlist);
534     }
535
536     verletbuf_get_list_setup(TRUE, &ls);
537
538     /* Allow rlist to make the list double the size of the cut-off sphere */
539     rlist_inc = nbnxn_get_rlist_effective_inc(NBNXN_GPU_CLUSTER_SIZE, mtop->natoms/det(box));
540     rlist_ok  = (max(ir->rvdw, ir->rcoulomb) + rlist_inc)*pow(NBNXN_GPU_LIST_OK_FAC, 1.0/3.0) - rlist_inc;
541     rlist_max = (max(ir->rvdw, ir->rcoulomb) + rlist_inc)*pow(NBNXN_GPU_LIST_MAX_FAC, 1.0/3.0) - rlist_inc;
542     if (debug)
543     {
544         fprintf(debug, "GPU nstlist tuning: rlist_inc %.3f rlist_max %.3f\n",
545                 rlist_inc, rlist_max);
546     }
547
548     i            = 0;
549     nstlist_prev = nstlist_orig;
550     rlist_prev   = ir->rlist;
551     do
552     {
553         if (env == NULL)
554         {
555             ir->nstlist = nstl[i];
556         }
557
558         /* Set the pair-list buffer size in ir */
559         calc_verlet_buffer_size(mtop, det(box), ir, ir->verletbuf_drift, &ls,
560                                 NULL, &rlist_new);
561
562         /* Does rlist fit in the box? */
563         bBox = (sqr(rlist_new) < max_cutoff2(ir->ePBC, box));
564         bDD  = TRUE;
565         if (bBox && DOMAINDECOMP(cr))
566         {
567             /* Check if rlist fits in the domain decomposition */
568             if (inputrec2nboundeddim(ir) < DIM)
569             {
570                 gmx_incons("Changing nstlist with domain decomposition and unbounded dimensions is not implemented yet");
571             }
572             copy_mat(box, state_tmp.box);
573             bDD = change_dd_cutoff(cr, &state_tmp, ir, rlist_new);
574         }
575
576         bCont = FALSE;
577
578         if (env == NULL)
579         {
580             if (bBox && bDD && rlist_new <= rlist_max)
581             {
582                 /* Increase nstlist */
583                 nstlist_prev = ir->nstlist;
584                 rlist_prev   = rlist_new;
585                 bCont        = (i+1 < NNSTL && rlist_new < rlist_ok);
586             }
587             else
588             {
589                 /* Stick with the previous nstlist */
590                 ir->nstlist = nstlist_prev;
591                 rlist_new   = rlist_prev;
592                 bBox        = TRUE;
593                 bDD         = TRUE;
594             }
595         }
596
597         i++;
598     }
599     while (bCont);
600
601     if (!bBox || !bDD)
602     {
603         gmx_warning(!bBox ? box_err : dd_err);
604         if (fp != NULL)
605         {
606             fprintf(fp, "\n%s\n", bBox ? box_err : dd_err);
607         }
608         ir->nstlist = nstlist_orig;
609     }
610     else if (ir->nstlist != nstlist_orig || rlist_new != ir->rlist)
611     {
612         sprintf(buf, "Changing nstlist from %d to %d, rlist from %g to %g",
613                 nstlist_orig, ir->nstlist,
614                 ir->rlist, rlist_new);
615         if (MASTER(cr))
616         {
617             fprintf(stderr, "%s\n\n", buf);
618         }
619         if (fp != NULL)
620         {
621             fprintf(fp, "%s\n\n", buf);
622         }
623         ir->rlist     = rlist_new;
624         ir->rlistlong = rlist_new;
625     }
626 }
627
628 static void prepare_verlet_scheme(FILE                           *fplog,
629                                   const gmx_hw_info_t            *hwinfo,
630                                   t_commrec                      *cr,
631                                   t_inputrec                     *ir,
632                                   const gmx_mtop_t               *mtop,
633                                   matrix                          box,
634                                   gmx_bool                       *bUseGPU)
635 {
636     /* Here we only check for GPU usage on the MPI master process,
637      * as here we don't know how many GPUs we will use yet.
638      * We check for a GPU on all processes later.
639      */
640     *bUseGPU = hwinfo->bCanUseGPU || (getenv("GMX_EMULATE_GPU") != NULL);
641
642     if (ir->verletbuf_drift > 0)
643     {
644         /* Update the Verlet buffer size for the current run setup */
645         verletbuf_list_setup_t ls;
646         real                   rlist_new;
647
648         /* Here we assume CPU acceleration is on. But as currently
649          * calc_verlet_buffer_size gives the same results for 4x8 and 4x4
650          * and 4x2 gives a larger buffer than 4x4, this is ok.
651          */
652         verletbuf_get_list_setup(*bUseGPU, &ls);
653
654         calc_verlet_buffer_size(mtop, det(box), ir,
655                                 ir->verletbuf_drift, &ls,
656                                 NULL, &rlist_new);
657         if (rlist_new != ir->rlist)
658         {
659             if (fplog != NULL)
660             {
661                 fprintf(fplog, "\nChanging rlist from %g to %g for non-bonded %dx%d atom kernels\n\n",
662                         ir->rlist, rlist_new,
663                         ls.cluster_size_i, ls.cluster_size_j);
664             }
665             ir->rlist     = rlist_new;
666             ir->rlistlong = rlist_new;
667         }
668     }
669
670     /* With GPU or emulation we should check nstlist for performance */
671     if ((EI_DYNAMICS(ir->eI) &&
672          *bUseGPU &&
673          ir->nstlist < NSTLIST_GPU_ENOUGH) ||
674         getenv(NSTLIST_ENVVAR) != NULL)
675     {
676         /* Choose a better nstlist */
677         increase_nstlist(fplog, cr, ir, mtop, box);
678     }
679 }
680
681 static void convert_to_verlet_scheme(FILE *fplog,
682                                      t_inputrec *ir,
683                                      gmx_mtop_t *mtop, real box_vol)
684 {
685     char *conv_mesg = "Converting input file with group cut-off scheme to the Verlet cut-off scheme";
686
687     md_print_warn(NULL, fplog, "%s\n", conv_mesg);
688
689     ir->cutoff_scheme   = ecutsVERLET;
690     ir->verletbuf_drift = 0.005;
691
692     if (ir->rcoulomb != ir->rvdw)
693     {
694         gmx_fatal(FARGS, "The VdW and Coulomb cut-offs are different, whereas the Verlet scheme only supports equal cut-offs");
695     }
696
697     if (ir->vdwtype == evdwUSER || EEL_USER(ir->coulombtype))
698     {
699         gmx_fatal(FARGS, "User non-bonded potentials are not (yet) supported with the Verlet scheme");
700     }
701     else if (EVDW_SWITCHED(ir->vdwtype) || EEL_SWITCHED(ir->coulombtype))
702     {
703         md_print_warn(NULL, fplog, "Converting switched or shifted interactions to a shifted potential (without force shift), this will lead to slightly different interaction potentials");
704
705         if (EVDW_SWITCHED(ir->vdwtype))
706         {
707             ir->vdwtype = evdwCUT;
708         }
709         if (EEL_SWITCHED(ir->coulombtype))
710         {
711             if (EEL_FULL(ir->coulombtype))
712             {
713                 /* With full electrostatic only PME can be switched */
714                 ir->coulombtype = eelPME;
715             }
716             else
717             {
718                 md_print_warn(NULL, fplog, "NOTE: Replacing %s electrostatics with reaction-field with epsilon-rf=inf\n", eel_names[ir->coulombtype]);
719                 ir->coulombtype = eelRF;
720                 ir->epsilon_rf  = 0.0;
721             }
722         }
723
724         /* We set the target energy drift to a small number.
725          * Note that this is only for testing. For production the user
726          * should think about this and set the mdp options.
727          */
728         ir->verletbuf_drift = 1e-4;
729     }
730
731     if (inputrec2nboundeddim(ir) != 3)
732     {
733         gmx_fatal(FARGS, "Can only convert old tpr files to the Verlet cut-off scheme with 3D pbc");
734     }
735
736     if (ir->efep != efepNO || ir->implicit_solvent != eisNO)
737     {
738         gmx_fatal(FARGS, "Will not convert old tpr files to the Verlet cut-off scheme with free-energy calculations or implicit solvent");
739     }
740
741     if (EI_DYNAMICS(ir->eI) && !(EI_MD(ir->eI) && ir->etc == etcNO))
742     {
743         verletbuf_list_setup_t ls;
744
745         verletbuf_get_list_setup(FALSE, &ls);
746         calc_verlet_buffer_size(mtop, box_vol, ir, ir->verletbuf_drift, &ls,
747                                 NULL, &ir->rlist);
748     }
749     else
750     {
751         ir->verletbuf_drift = -1;
752         ir->rlist           = 1.05*max(ir->rvdw, ir->rcoulomb);
753     }
754
755     gmx_mtop_remove_chargegroups(mtop);
756 }
757
758 static void check_and_update_hw_opt(gmx_hw_opt_t *hw_opt,
759                                     int           cutoff_scheme,
760                                     gmx_bool      bIsSimMaster)
761 {
762     gmx_omp_nthreads_read_env(&hw_opt->nthreads_omp, bIsSimMaster);
763
764 #ifndef GMX_THREAD_MPI
765     if (hw_opt->nthreads_tot > 0)
766     {
767         gmx_fatal(FARGS, "Setting the total number of threads is only supported with thread-MPI and Gromacs was compiled without thread-MPI");
768     }
769     if (hw_opt->nthreads_tmpi > 0)
770     {
771         gmx_fatal(FARGS, "Setting the number of thread-MPI threads is only supported with thread-MPI and Gromacs was compiled without thread-MPI");
772     }
773 #endif
774
775 #ifndef GMX_OPENMP
776     if (hw_opt->nthreads_omp > 1)
777     {
778         gmx_fatal(FARGS, "More than 1 OpenMP thread requested, but Gromacs was compiled without OpenMP support");
779     }
780     hw_opt->nthreads_omp = 1;
781 #endif
782
783     if (hw_opt->nthreads_tot > 0 && hw_opt->nthreads_omp_pme <= 0)
784     {
785         /* We have the same number of OpenMP threads for PP and PME processes,
786          * thus we can perform several consistency checks.
787          */
788         if (hw_opt->nthreads_tmpi > 0 &&
789             hw_opt->nthreads_omp > 0 &&
790             hw_opt->nthreads_tot != hw_opt->nthreads_tmpi*hw_opt->nthreads_omp)
791         {
792             gmx_fatal(FARGS, "The total number of threads requested (%d) does not match the thread-MPI threads (%d) times the OpenMP threads (%d) requested",
793                       hw_opt->nthreads_tot, hw_opt->nthreads_tmpi, hw_opt->nthreads_omp);
794         }
795
796         if (hw_opt->nthreads_tmpi > 0 &&
797             hw_opt->nthreads_tot % hw_opt->nthreads_tmpi != 0)
798         {
799             gmx_fatal(FARGS, "The total number of threads requested (%d) is not divisible by the number of thread-MPI threads requested (%d)",
800                       hw_opt->nthreads_tot, hw_opt->nthreads_tmpi);
801         }
802
803         if (hw_opt->nthreads_omp > 0 &&
804             hw_opt->nthreads_tot % hw_opt->nthreads_omp != 0)
805         {
806             gmx_fatal(FARGS, "The total number of threads requested (%d) is not divisible by the number of OpenMP threads requested (%d)",
807                       hw_opt->nthreads_tot, hw_opt->nthreads_omp);
808         }
809
810         if (hw_opt->nthreads_tmpi > 0 &&
811             hw_opt->nthreads_omp <= 0)
812         {
813             hw_opt->nthreads_omp = hw_opt->nthreads_tot/hw_opt->nthreads_tmpi;
814         }
815     }
816
817 #ifndef GMX_OPENMP
818     if (hw_opt->nthreads_omp > 1)
819     {
820         gmx_fatal(FARGS, "OpenMP threads are requested, but Gromacs was compiled without OpenMP support");
821     }
822 #endif
823
824     if (cutoff_scheme == ecutsGROUP)
825     {
826         /* We only have OpenMP support for PME only nodes */
827         if (hw_opt->nthreads_omp > 1)
828         {
829             gmx_fatal(FARGS, "OpenMP threads have been requested with cut-off scheme %s, but these are only supported with cut-off scheme %s",
830                       ecutscheme_names[cutoff_scheme],
831                       ecutscheme_names[ecutsVERLET]);
832         }
833         hw_opt->nthreads_omp = 1;
834     }
835
836     if (hw_opt->nthreads_omp_pme > 0 && hw_opt->nthreads_omp <= 0)
837     {
838         gmx_fatal(FARGS, "You need to specify -ntomp in addition to -ntomp_pme");
839     }
840
841     if (hw_opt->nthreads_tot == 1)
842     {
843         hw_opt->nthreads_tmpi = 1;
844
845         if (hw_opt->nthreads_omp > 1)
846         {
847             gmx_fatal(FARGS, "You requested %d OpenMP threads with %d total threads",
848                       hw_opt->nthreads_tmpi, hw_opt->nthreads_tot);
849         }
850         hw_opt->nthreads_omp = 1;
851     }
852
853     if (hw_opt->nthreads_omp_pme <= 0 && hw_opt->nthreads_omp > 0)
854     {
855         hw_opt->nthreads_omp_pme = hw_opt->nthreads_omp;
856     }
857
858     if (debug)
859     {
860         fprintf(debug, "hw_opt: nt %d ntmpi %d ntomp %d ntomp_pme %d gpu_id '%s'\n",
861                 hw_opt->nthreads_tot,
862                 hw_opt->nthreads_tmpi,
863                 hw_opt->nthreads_omp,
864                 hw_opt->nthreads_omp_pme,
865                 hw_opt->gpu_id != NULL ? hw_opt->gpu_id : "");
866
867     }
868 }
869
870
871 /* Override the value in inputrec with value passed on the command line (if any) */
872 static void override_nsteps_cmdline(FILE            *fplog,
873                                     gmx_large_int_t  nsteps_cmdline,
874                                     t_inputrec      *ir,
875                                     const t_commrec *cr)
876 {
877     char sbuf[STEPSTRSIZE];
878
879     assert(ir);
880     assert(cr);
881
882     /* override with anything else than the default -2 */
883     if (nsteps_cmdline > -2)
884     {
885         char stmp[STRLEN];
886
887         ir->nsteps = nsteps_cmdline;
888         if (EI_DYNAMICS(ir->eI))
889         {
890             sprintf(stmp, "Overriding nsteps with value passed on the command line: %s steps, %.3f ps",
891                     gmx_step_str(nsteps_cmdline, sbuf),
892                     nsteps_cmdline*ir->delta_t);
893         }
894         else
895         {
896             sprintf(stmp, "Overriding nsteps with value passed on the command line: %s steps",
897                     gmx_step_str(nsteps_cmdline, sbuf));
898         }
899
900         md_print_warn(cr, fplog, "%s\n", stmp);
901     }
902 }
903
904 /* Data structure set by SIMMASTER which needs to be passed to all nodes
905  * before the other nodes have read the tpx file and called gmx_detect_hardware.
906  */
907 typedef struct {
908     int      cutoff_scheme; /* The cutoff scheme from inputrec_t */
909     gmx_bool bUseGPU;       /* Use GPU or GPU emulation          */
910 } master_inf_t;
911
912 int mdrunner(gmx_hw_opt_t *hw_opt,
913              FILE *fplog, t_commrec *cr, int nfile,
914              const t_filenm fnm[], const output_env_t oenv, gmx_bool bVerbose,
915              gmx_bool bCompact, int nstglobalcomm,
916              ivec ddxyz, int dd_node_order, real rdd, real rconstr,
917              const char *dddlb_opt, real dlb_scale,
918              const char *ddcsx, const char *ddcsy, const char *ddcsz,
919              const char *nbpu_opt,
920              gmx_large_int_t nsteps_cmdline, int nstepout, int resetstep,
921              int nmultisim, int repl_ex_nst, int repl_ex_nex,
922              int repl_ex_seed, real pforce, real cpt_period, real max_hours,
923              const char *deviceOptions, unsigned long Flags)
924 {
925     gmx_bool        bForceUseGPU, bTryUseGPU;
926     double          nodetime = 0, realtime;
927     t_inputrec     *inputrec;
928     t_state        *state = NULL;
929     matrix          box;
930     gmx_ddbox_t     ddbox = {0};
931     int             npme_major, npme_minor;
932     real            tmpr1, tmpr2;
933     t_nrnb         *nrnb;
934     gmx_mtop_t     *mtop       = NULL;
935     t_mdatoms      *mdatoms    = NULL;
936     t_forcerec     *fr         = NULL;
937     t_fcdata       *fcd        = NULL;
938     real            ewaldcoeff = 0;
939     gmx_pme_t      *pmedata    = NULL;
940     gmx_vsite_t    *vsite      = NULL;
941     gmx_constr_t    constr;
942     int             i, m, nChargePerturbed = -1, status, nalloc;
943     char           *gro;
944     gmx_wallcycle_t wcycle;
945     gmx_bool        bReadRNG, bReadEkin;
946     int             list;
947     gmx_runtime_t   runtime;
948     int             rc;
949     gmx_large_int_t reset_counters;
950     gmx_edsam_t     ed           = NULL;
951     t_commrec      *cr_old       = cr;
952     int             nthreads_pme = 1;
953     int             nthreads_pp  = 1;
954     gmx_membed_t    membed       = NULL;
955     gmx_hw_info_t  *hwinfo       = NULL;
956     master_inf_t    minf         = {-1, FALSE};
957
958     /* CAUTION: threads may be started later on in this function, so
959        cr doesn't reflect the final parallel state right now */
960     snew(inputrec, 1);
961     snew(mtop, 1);
962
963     if (Flags & MD_APPENDFILES)
964     {
965         fplog = NULL;
966     }
967
968     bForceUseGPU = (strncmp(nbpu_opt, "gpu", 3) == 0);
969     bTryUseGPU   = (strncmp(nbpu_opt, "auto", 4) == 0) || bForceUseGPU;
970
971     /* Detect hardware, gather information. This is an operation that is
972      * global for this process (MPI rank). */
973     hwinfo = gmx_detect_hardware(fplog, cr,
974                                  bForceUseGPU, bTryUseGPU, hw_opt->gpu_id);
975
976
977     snew(state, 1);
978     if (SIMMASTER(cr))
979     {
980         /* Read (nearly) all data required for the simulation */
981         read_tpx_state(ftp2fn(efTPX, nfile, fnm), inputrec, state, NULL, mtop);
982
983         if (inputrec->cutoff_scheme != ecutsVERLET &&
984             ((Flags & MD_TESTVERLET) || getenv("GMX_VERLET_SCHEME") != NULL))
985         {
986             convert_to_verlet_scheme(fplog, inputrec, mtop, det(state->box));
987         }
988
989
990         minf.cutoff_scheme = inputrec->cutoff_scheme;
991         minf.bUseGPU       = FALSE;
992
993         if (inputrec->cutoff_scheme == ecutsVERLET)
994         {
995             prepare_verlet_scheme(fplog, hwinfo, cr,
996                                   inputrec, mtop, state->box,
997                                   &minf.bUseGPU);
998         }
999         else if (hwinfo->bCanUseGPU)
1000         {
1001             md_print_warn(cr, fplog,
1002                           "NOTE: GPU(s) found, but the current simulation can not use GPUs\n"
1003                           "      To use a GPU, set the mdp option: cutoff-scheme = Verlet\n"
1004                           "      (for quick performance testing you can use the -testverlet option)\n");
1005
1006             if (bForceUseGPU)
1007             {
1008                 gmx_fatal(FARGS, "GPU requested, but can't be used without cutoff-scheme=Verlet");
1009             }
1010         }
1011     }
1012 #ifndef GMX_THREAD_MPI
1013     if (PAR(cr))
1014     {
1015         gmx_bcast_sim(sizeof(minf), &minf, cr);
1016     }
1017 #endif
1018     if (minf.bUseGPU && cr->npmenodes == -1)
1019     {
1020         /* Don't automatically use PME-only nodes with GPUs */
1021         cr->npmenodes = 0;
1022     }
1023
1024     /* Check for externally set OpenMP affinity and turn off internal
1025      * pinning if any is found. We need to do this check early to tell
1026      * thread-MPI whether it should do pinning when spawning threads.
1027      * TODO: the above no longer holds, we should move these checks down
1028      */
1029     gmx_omp_check_thread_affinity(fplog, cr, hw_opt);
1030
1031 #ifdef GMX_THREAD_MPI
1032     /* With thread-MPI inputrec is only set here on the master thread */
1033     if (SIMMASTER(cr))
1034 #endif
1035     {
1036         check_and_update_hw_opt(hw_opt, minf.cutoff_scheme, SIMMASTER(cr));
1037
1038 #ifdef GMX_THREAD_MPI
1039         /* Early check for externally set process affinity. Can't do over all
1040          * MPI processes because hwinfo is not available everywhere, but with
1041          * thread-MPI it's needed as pinning might get turned off which needs
1042          * to be known before starting thread-MPI. */
1043         gmx_check_thread_affinity_set(fplog,
1044                                       NULL,
1045                                       hw_opt, hwinfo->nthreads_hw_avail, FALSE);
1046 #endif
1047
1048 #ifdef GMX_THREAD_MPI
1049         if (cr->npmenodes > 0 && hw_opt->nthreads_tmpi <= 0)
1050         {
1051             gmx_fatal(FARGS, "You need to explicitly specify the number of MPI threads (-ntmpi) when using separate PME nodes");
1052         }
1053 #endif
1054
1055         if (hw_opt->nthreads_omp_pme != hw_opt->nthreads_omp &&
1056             cr->npmenodes <= 0)
1057         {
1058             gmx_fatal(FARGS, "You need to explicitly specify the number of PME nodes (-npme) when using different number of OpenMP threads for PP and PME nodes");
1059         }
1060     }
1061
1062 #ifdef GMX_THREAD_MPI
1063     if (SIMMASTER(cr))
1064     {
1065         /* NOW the threads will be started: */
1066         hw_opt->nthreads_tmpi = get_nthreads_mpi(hwinfo,
1067                                                  hw_opt,
1068                                                  inputrec, mtop,
1069                                                  cr, fplog);
1070         if (hw_opt->nthreads_tot > 0 && hw_opt->nthreads_omp <= 0)
1071         {
1072             hw_opt->nthreads_omp = hw_opt->nthreads_tot/hw_opt->nthreads_tmpi;
1073         }
1074
1075         if (hw_opt->nthreads_tmpi > 1)
1076         {
1077             /* now start the threads. */
1078             cr = mdrunner_start_threads(hw_opt, fplog, cr_old, nfile, fnm,
1079                                         oenv, bVerbose, bCompact, nstglobalcomm,
1080                                         ddxyz, dd_node_order, rdd, rconstr,
1081                                         dddlb_opt, dlb_scale, ddcsx, ddcsy, ddcsz,
1082                                         nbpu_opt,
1083                                         nsteps_cmdline, nstepout, resetstep, nmultisim,
1084                                         repl_ex_nst, repl_ex_nex, repl_ex_seed, pforce,
1085                                         cpt_period, max_hours, deviceOptions,
1086                                         Flags);
1087             /* the main thread continues here with a new cr. We don't deallocate
1088                the old cr because other threads may still be reading it. */
1089             if (cr == NULL)
1090             {
1091                 gmx_comm("Failed to spawn threads");
1092             }
1093         }
1094     }
1095 #endif
1096     /* END OF CAUTION: cr is now reliable */
1097
1098     /* g_membed initialisation *
1099      * Because we change the mtop, init_membed is called before the init_parallel *
1100      * (in case we ever want to make it run in parallel) */
1101     if (opt2bSet("-membed", nfile, fnm))
1102     {
1103         if (MASTER(cr))
1104         {
1105             fprintf(stderr, "Initializing membed");
1106         }
1107         membed = init_membed(fplog, nfile, fnm, mtop, inputrec, state, cr, &cpt_period);
1108     }
1109
1110     if (PAR(cr))
1111     {
1112         /* now broadcast everything to the non-master nodes/threads: */
1113         init_parallel(cr, inputrec, mtop);
1114
1115         /* This check needs to happen after get_nthreads_mpi() */
1116         if (inputrec->cutoff_scheme == ecutsVERLET && (Flags & MD_PARTDEC))
1117         {
1118             gmx_fatal_collective(FARGS, cr, NULL,
1119                                  "The Verlet cut-off scheme is not supported with particle decomposition.\n"
1120                                  "You can achieve the same effect as particle decomposition by running in parallel using only OpenMP threads.");
1121         }
1122     }
1123     if (fplog != NULL)
1124     {
1125         pr_inputrec(fplog, 0, "Input Parameters", inputrec, FALSE);
1126     }
1127
1128     /* now make sure the state is initialized and propagated */
1129     set_state_entries(state, inputrec, cr->nnodes);
1130
1131     /* A parallel command line option consistency check that we can
1132        only do after any threads have started. */
1133     if (!PAR(cr) &&
1134         (ddxyz[XX] > 1 || ddxyz[YY] > 1 || ddxyz[ZZ] > 1 || cr->npmenodes > 0))
1135     {
1136         gmx_fatal(FARGS,
1137                   "The -dd or -npme option request a parallel simulation, "
1138 #ifndef GMX_MPI
1139                   "but %s was compiled without threads or MPI enabled"
1140 #else
1141 #ifdef GMX_THREAD_MPI
1142                   "but the number of threads (option -nt) is 1"
1143 #else
1144                   "but %s was not started through mpirun/mpiexec or only one process was requested through mpirun/mpiexec"
1145 #endif
1146 #endif
1147                   , ShortProgram()
1148                   );
1149     }
1150
1151     if ((Flags & MD_RERUN) &&
1152         (EI_ENERGY_MINIMIZATION(inputrec->eI) || eiNM == inputrec->eI))
1153     {
1154         gmx_fatal(FARGS, "The .mdp file specified an energy mininization or normal mode algorithm, and these are not compatible with mdrun -rerun");
1155     }
1156
1157     if (can_use_allvsall(inputrec, TRUE, cr, fplog) && PAR(cr))
1158     {
1159         /* Simple neighbour searching and (also?) all-vs-all loops
1160          * do not work with domain decomposition. */
1161         Flags |= MD_PARTDEC;
1162     }
1163
1164     if (!EEL_PME(inputrec->coulombtype) || (Flags & MD_PARTDEC))
1165     {
1166         if (cr->npmenodes > 0)
1167         {
1168             if (!EEL_PME(inputrec->coulombtype))
1169             {
1170                 gmx_fatal_collective(FARGS, cr, NULL,
1171                                      "PME nodes are requested, but the system does not use PME electrostatics");
1172             }
1173             if (Flags & MD_PARTDEC)
1174             {
1175                 gmx_fatal_collective(FARGS, cr, NULL,
1176                                      "PME nodes are requested, but particle decomposition does not support separate PME nodes");
1177             }
1178         }
1179
1180         cr->npmenodes = 0;
1181     }
1182
1183 #ifdef GMX_FAHCORE
1184     fcRegisterSteps(inputrec->nsteps, inputrec->init_step);
1185 #endif
1186
1187     /* NMR restraints must be initialized before load_checkpoint,
1188      * since with time averaging the history is added to t_state.
1189      * For proper consistency check we therefore need to extend
1190      * t_state here.
1191      * So the PME-only nodes (if present) will also initialize
1192      * the distance restraints.
1193      */
1194     snew(fcd, 1);
1195
1196     /* This needs to be called before read_checkpoint to extend the state */
1197     init_disres(fplog, mtop, inputrec, cr, Flags & MD_PARTDEC, fcd, state, repl_ex_nst > 0);
1198
1199     if (gmx_mtop_ftype_count(mtop, F_ORIRES) > 0)
1200     {
1201         if (PAR(cr) && !(Flags & MD_PARTDEC))
1202         {
1203             gmx_fatal(FARGS, "Orientation restraints do not work (yet) with domain decomposition, use particle decomposition (mdrun option -pd)");
1204         }
1205         /* Orientation restraints */
1206         if (MASTER(cr))
1207         {
1208             init_orires(fplog, mtop, state->x, inputrec, cr->ms, &(fcd->orires),
1209                         state);
1210         }
1211     }
1212
1213     if (DEFORM(*inputrec))
1214     {
1215         /* Store the deform reference box before reading the checkpoint */
1216         if (SIMMASTER(cr))
1217         {
1218             copy_mat(state->box, box);
1219         }
1220         if (PAR(cr))
1221         {
1222             gmx_bcast(sizeof(box), box, cr);
1223         }
1224         /* Because we do not have the update struct available yet
1225          * in which the reference values should be stored,
1226          * we store them temporarily in static variables.
1227          * This should be thread safe, since they are only written once
1228          * and with identical values.
1229          */
1230 #ifdef GMX_THREAD_MPI
1231         tMPI_Thread_mutex_lock(&deform_init_box_mutex);
1232 #endif
1233         deform_init_init_step_tpx = inputrec->init_step;
1234         copy_mat(box, deform_init_box_tpx);
1235 #ifdef GMX_THREAD_MPI
1236         tMPI_Thread_mutex_unlock(&deform_init_box_mutex);
1237 #endif
1238     }
1239
1240     if (opt2bSet("-cpi", nfile, fnm))
1241     {
1242         /* Check if checkpoint file exists before doing continuation.
1243          * This way we can use identical input options for the first and subsequent runs...
1244          */
1245         if (gmx_fexist_master(opt2fn_master("-cpi", nfile, fnm, cr), cr) )
1246         {
1247             load_checkpoint(opt2fn_master("-cpi", nfile, fnm, cr), &fplog,
1248                             cr, Flags & MD_PARTDEC, ddxyz,
1249                             inputrec, state, &bReadRNG, &bReadEkin,
1250                             (Flags & MD_APPENDFILES),
1251                             (Flags & MD_APPENDFILESSET));
1252
1253             if (bReadRNG)
1254             {
1255                 Flags |= MD_READ_RNG;
1256             }
1257             if (bReadEkin)
1258             {
1259                 Flags |= MD_READ_EKIN;
1260             }
1261         }
1262     }
1263
1264     if (((MASTER(cr) || (Flags & MD_SEPPOT)) && (Flags & MD_APPENDFILES))
1265 #ifdef GMX_THREAD_MPI
1266         /* With thread MPI only the master node/thread exists in mdrun.c,
1267          * therefore non-master nodes need to open the "seppot" log file here.
1268          */
1269         || (!MASTER(cr) && (Flags & MD_SEPPOT))
1270 #endif
1271         )
1272     {
1273         gmx_log_open(ftp2fn(efLOG, nfile, fnm), cr, !(Flags & MD_SEPPOT),
1274                      Flags, &fplog);
1275     }
1276
1277     /* override nsteps with value from cmdline */
1278     override_nsteps_cmdline(fplog, nsteps_cmdline, inputrec, cr);
1279
1280     if (SIMMASTER(cr))
1281     {
1282         copy_mat(state->box, box);
1283     }
1284
1285     if (PAR(cr))
1286     {
1287         gmx_bcast(sizeof(box), box, cr);
1288     }
1289
1290     /* Essential dynamics */
1291     if (opt2bSet("-ei", nfile, fnm))
1292     {
1293         /* Open input and output files, allocate space for ED data structure */
1294         ed = ed_open(mtop->natoms, &state->edsamstate, nfile, fnm, Flags, oenv, cr);
1295     }
1296
1297     if (PAR(cr) && !((Flags & MD_PARTDEC) ||
1298                      EI_TPI(inputrec->eI) ||
1299                      inputrec->eI == eiNM))
1300     {
1301         cr->dd = init_domain_decomposition(fplog, cr, Flags, ddxyz, rdd, rconstr,
1302                                            dddlb_opt, dlb_scale,
1303                                            ddcsx, ddcsy, ddcsz,
1304                                            mtop, inputrec,
1305                                            box, state->x,
1306                                            &ddbox, &npme_major, &npme_minor);
1307
1308         make_dd_communicators(fplog, cr, dd_node_order);
1309
1310         /* Set overallocation to avoid frequent reallocation of arrays */
1311         set_over_alloc_dd(TRUE);
1312     }
1313     else
1314     {
1315         /* PME, if used, is done on all nodes with 1D decomposition */
1316         cr->npmenodes = 0;
1317         cr->duty      = (DUTY_PP | DUTY_PME);
1318         npme_major    = 1;
1319         npme_minor    = 1;
1320         /* NM and TPI perform single node energy calculations in parallel */
1321         if (!(inputrec->eI == eiNM || EI_TPI(inputrec->eI)))
1322         {
1323             npme_major = cr->nnodes;
1324         }
1325
1326         if (inputrec->ePBC == epbcSCREW)
1327         {
1328             gmx_fatal(FARGS,
1329                       "pbc=%s is only implemented with domain decomposition",
1330                       epbc_names[inputrec->ePBC]);
1331         }
1332     }
1333
1334     if (PAR(cr))
1335     {
1336         /* After possible communicator splitting in make_dd_communicators.
1337          * we can set up the intra/inter node communication.
1338          */
1339         gmx_setup_nodecomm(fplog, cr);
1340     }
1341
1342     /* Initialize per-physical-node MPI process/thread ID and counters. */
1343     gmx_init_intranode_counters(cr);
1344
1345 #ifdef GMX_MPI
1346     md_print_info(cr, fplog, "Using %d MPI %s\n",
1347                   cr->nnodes,
1348 #ifdef GMX_THREAD_MPI
1349                   cr->nnodes == 1 ? "thread" : "threads"
1350 #else
1351                   cr->nnodes == 1 ? "process" : "processes"
1352 #endif
1353                   );
1354     fflush(stderr);
1355 #endif
1356
1357     gmx_omp_nthreads_init(fplog, cr,
1358                           hwinfo->nthreads_hw_avail,
1359                           hw_opt->nthreads_omp,
1360                           hw_opt->nthreads_omp_pme,
1361                           (cr->duty & DUTY_PP) == 0,
1362                           inputrec->cutoff_scheme == ecutsVERLET);
1363
1364     /* check consistency and decide on the number of gpus to use. */
1365     gmx_check_hw_runconf_consistency(fplog, hwinfo, cr, hw_opt->nthreads_tmpi,
1366                                      minf.bUseGPU);
1367
1368     /* getting number of PP/PME threads
1369        PME: env variable should be read only on one node to make sure it is
1370        identical everywhere;
1371      */
1372     /* TODO nthreads_pp is only used for pinning threads.
1373      * This is a temporary solution until we have a hw topology library.
1374      */
1375     nthreads_pp  = gmx_omp_nthreads_get(emntNonbonded);
1376     nthreads_pme = gmx_omp_nthreads_get(emntPME);
1377
1378     wcycle = wallcycle_init(fplog, resetstep, cr, nthreads_pp, nthreads_pme);
1379
1380     if (PAR(cr))
1381     {
1382         /* Master synchronizes its value of reset_counters with all nodes
1383          * including PME only nodes */
1384         reset_counters = wcycle_get_reset_counters(wcycle);
1385         gmx_bcast_sim(sizeof(reset_counters), &reset_counters, cr);
1386         wcycle_set_reset_counters(wcycle, reset_counters);
1387     }
1388
1389     snew(nrnb, 1);
1390     if (cr->duty & DUTY_PP)
1391     {
1392         /* For domain decomposition we allocate dynamically
1393          * in dd_partition_system.
1394          */
1395         if (DOMAINDECOMP(cr))
1396         {
1397             bcast_state_setup(cr, state);
1398         }
1399         else
1400         {
1401             if (PAR(cr))
1402             {
1403                 bcast_state(cr, state, TRUE);
1404             }
1405         }
1406
1407         /* Initiate forcerecord */
1408         fr         = mk_forcerec();
1409         fr->hwinfo = hwinfo;
1410         init_forcerec(fplog, oenv, fr, fcd, inputrec, mtop, cr, box,
1411                       opt2fn("-table", nfile, fnm),
1412                       opt2fn("-tabletf", nfile, fnm),
1413                       opt2fn("-tablep", nfile, fnm),
1414                       opt2fn("-tableb", nfile, fnm),
1415                       nbpu_opt,
1416                       FALSE, pforce);
1417
1418         /* version for PCA_NOT_READ_NODE (see md.c) */
1419         /*init_forcerec(fplog,fr,fcd,inputrec,mtop,cr,box,FALSE,
1420            "nofile","nofile","nofile","nofile",FALSE,pforce);
1421          */
1422         fr->bSepDVDL = ((Flags & MD_SEPPOT) == MD_SEPPOT);
1423
1424         /* Initialize QM-MM */
1425         if (fr->bQMMM)
1426         {
1427             init_QMMMrec(cr, mtop, inputrec, fr);
1428         }
1429
1430         /* Initialize the mdatoms structure.
1431          * mdatoms is not filled with atom data,
1432          * as this can not be done now with domain decomposition.
1433          */
1434         mdatoms = init_mdatoms(fplog, mtop, inputrec->efep != efepNO);
1435
1436         if (mdatoms->nPerturbed > 0 && inputrec->cutoff_scheme == ecutsVERLET)
1437         {
1438             gmx_fatal(FARGS, "The Verlet cut-off scheme does not (yet) support free-energy calculations with perturbed atoms, only perturbed interactions. This will be implemented soon. Use the group scheme for now.");
1439         }
1440
1441         /* Initialize the virtual site communication */
1442         vsite = init_vsite(mtop, cr, FALSE);
1443
1444         calc_shifts(box, fr->shift_vec);
1445
1446         /* With periodic molecules the charge groups should be whole at start up
1447          * and the virtual sites should not be far from their proper positions.
1448          */
1449         if (!inputrec->bContinuation && MASTER(cr) &&
1450             !(inputrec->ePBC != epbcNONE && inputrec->bPeriodicMols))
1451         {
1452             /* Make molecules whole at start of run */
1453             if (fr->ePBC != epbcNONE)
1454             {
1455                 do_pbc_first_mtop(fplog, inputrec->ePBC, box, mtop, state->x);
1456             }
1457             if (vsite)
1458             {
1459                 /* Correct initial vsite positions are required
1460                  * for the initial distribution in the domain decomposition
1461                  * and for the initial shell prediction.
1462                  */
1463                 construct_vsites_mtop(vsite, mtop, state->x);
1464             }
1465         }
1466
1467         if (EEL_PME(fr->eeltype))
1468         {
1469             ewaldcoeff = fr->ewaldcoeff;
1470             pmedata    = &fr->pmedata;
1471         }
1472         else
1473         {
1474             pmedata = NULL;
1475         }
1476     }
1477     else
1478     {
1479         /* This is a PME only node */
1480
1481         /* We don't need the state */
1482         done_state(state);
1483
1484         ewaldcoeff = calc_ewaldcoeff(inputrec->rcoulomb, inputrec->ewald_rtol);
1485         snew(pmedata, 1);
1486     }
1487
1488     if (hw_opt->thread_affinity != threadaffOFF)
1489     {
1490         /* Before setting affinity, check whether the affinity has changed
1491          * - which indicates that probably the OpenMP library has changed it
1492          * since we first checked).
1493          */
1494         gmx_check_thread_affinity_set(fplog, cr,
1495                                       hw_opt, hwinfo->nthreads_hw_avail, TRUE);
1496
1497         /* Set the CPU affinity */
1498         gmx_set_thread_affinity(fplog, cr, hw_opt, hwinfo);
1499     }
1500
1501     /* Initiate PME if necessary,
1502      * either on all nodes or on dedicated PME nodes only. */
1503     if (EEL_PME(inputrec->coulombtype))
1504     {
1505         if (mdatoms)
1506         {
1507             nChargePerturbed = mdatoms->nChargePerturbed;
1508         }
1509         if (cr->npmenodes > 0)
1510         {
1511             /* The PME only nodes need to know nChargePerturbed */
1512             gmx_bcast_sim(sizeof(nChargePerturbed), &nChargePerturbed, cr);
1513         }
1514
1515         if (cr->duty & DUTY_PME)
1516         {
1517             status = gmx_pme_init(pmedata, cr, npme_major, npme_minor, inputrec,
1518                                   mtop ? mtop->natoms : 0, nChargePerturbed,
1519                                   (Flags & MD_REPRODUCIBLE), nthreads_pme);
1520             if (status != 0)
1521             {
1522                 gmx_fatal(FARGS, "Error %d initializing PME", status);
1523             }
1524         }
1525     }
1526
1527
1528     if (integrator[inputrec->eI].func == do_md)
1529     {
1530         /* Turn on signal handling on all nodes */
1531         /*
1532          * (A user signal from the PME nodes (if any)
1533          * is communicated to the PP nodes.
1534          */
1535         signal_handler_install();
1536     }
1537
1538     if (cr->duty & DUTY_PP)
1539     {
1540         if (inputrec->ePull != epullNO)
1541         {
1542             /* Initialize pull code */
1543             init_pull(fplog, inputrec, nfile, fnm, mtop, cr, oenv, inputrec->fepvals->init_lambda,
1544                       EI_DYNAMICS(inputrec->eI) && MASTER(cr), Flags);
1545         }
1546
1547         if (inputrec->bRot)
1548         {
1549             /* Initialize enforced rotation code */
1550             init_rot(fplog, inputrec, nfile, fnm, cr, state->x, box, mtop, oenv,
1551                      bVerbose, Flags);
1552         }
1553
1554         constr = init_constraints(fplog, mtop, inputrec, ed, state, cr);
1555
1556         if (DOMAINDECOMP(cr))
1557         {
1558             dd_init_bondeds(fplog, cr->dd, mtop, vsite, inputrec,
1559                             Flags & MD_DDBONDCHECK, fr->cginfo_mb);
1560
1561             set_dd_parameters(fplog, cr->dd, dlb_scale, inputrec, &ddbox);
1562
1563             setup_dd_grid(fplog, cr->dd);
1564         }
1565
1566         /* Now do whatever the user wants us to do (how flexible...) */
1567         integrator[inputrec->eI].func(fplog, cr, nfile, fnm,
1568                                       oenv, bVerbose, bCompact,
1569                                       nstglobalcomm,
1570                                       vsite, constr,
1571                                       nstepout, inputrec, mtop,
1572                                       fcd, state,
1573                                       mdatoms, nrnb, wcycle, ed, fr,
1574                                       repl_ex_nst, repl_ex_nex, repl_ex_seed,
1575                                       membed,
1576                                       cpt_period, max_hours,
1577                                       deviceOptions,
1578                                       Flags,
1579                                       &runtime);
1580
1581         if (inputrec->ePull != epullNO)
1582         {
1583             finish_pull(inputrec->pull);
1584         }
1585
1586         if (inputrec->bRot)
1587         {
1588             finish_rot(inputrec->rot);
1589         }
1590
1591     }
1592     else
1593     {
1594         /* do PME only */
1595         gmx_pmeonly(*pmedata, cr, nrnb, wcycle, &runtime, ewaldcoeff, inputrec);
1596     }
1597
1598     if (EI_DYNAMICS(inputrec->eI) || EI_TPI(inputrec->eI))
1599     {
1600         /* Some timing stats */
1601         if (SIMMASTER(cr))
1602         {
1603             if (runtime.proc == 0)
1604             {
1605                 runtime.proc = runtime.real;
1606             }
1607         }
1608         else
1609         {
1610             runtime.real = 0;
1611         }
1612     }
1613
1614     wallcycle_stop(wcycle, ewcRUN);
1615
1616     /* Finish up, write some stuff
1617      * if rerunMD, don't write last frame again
1618      */
1619     finish_run(fplog, cr,
1620                inputrec, nrnb, wcycle, &runtime,
1621                fr != NULL && fr->nbv != NULL && fr->nbv->bUseGPU ?
1622                nbnxn_cuda_get_timings(fr->nbv->cu_nbv) : NULL,
1623                EI_DYNAMICS(inputrec->eI) && !MULTISIM(cr));
1624
1625     if ((cr->duty & DUTY_PP) && fr->nbv != NULL && fr->nbv->bUseGPU)
1626     {
1627         char gpu_err_str[STRLEN];
1628
1629         /* free GPU memory and uninitialize GPU (by destroying the context) */
1630         nbnxn_cuda_free(fplog, fr->nbv->cu_nbv);
1631
1632         if (!free_gpu(gpu_err_str))
1633         {
1634             gmx_warning("On node %d failed to free GPU #%d: %s",
1635                         cr->nodeid, get_current_gpu_device_id(), gpu_err_str);
1636         }
1637     }
1638
1639     if (opt2bSet("-membed", nfile, fnm))
1640     {
1641         sfree(membed);
1642     }
1643
1644     gmx_hardware_info_free(hwinfo);
1645
1646     /* Does what it says */
1647     print_date_and_time(fplog, cr->nodeid, "Finished mdrun", &runtime);
1648
1649     /* Close logfile already here if we were appending to it */
1650     if (MASTER(cr) && (Flags & MD_APPENDFILES))
1651     {
1652         gmx_log_close(fplog);
1653     }
1654
1655     rc = (int)gmx_get_stop_condition();
1656
1657 #ifdef GMX_THREAD_MPI
1658     /* we need to join all threads. The sub-threads join when they
1659        exit this function, but the master thread needs to be told to
1660        wait for that. */
1661     if (PAR(cr) && MASTER(cr))
1662     {
1663         tMPI_Finalize();
1664     }
1665 #endif
1666
1667     return rc;
1668 }