src/programs/mdrun/runner.cpp

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