src/gromacs/mdrun/runner.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \internal \file
  38  *
  39  * \brief Implements the MD runner routine calling all integrators.
  40  *
  41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  42  * \ingroup module_mdrun
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "runner.h"
  47
  48 #include "config.h"
  49
  50 #include <cassert>
  51 #include <cinttypes>
  52 #include <csignal>
  53 #include <cstdlib>
  54 #include <cstring>
  55
  56 #include <algorithm>
  57
  58 #include "gromacs/commandline/filenm.h"
  59 #include "gromacs/compat/make_unique.h"
  60 #include "gromacs/domdec/domdec.h"
  61 #include "gromacs/domdec/domdec_struct.h"
  62 #include "gromacs/domdec/localatomsetmanager.h"
  63 #include "gromacs/ewald/ewald-utils.h"
  64 #include "gromacs/ewald/pme.h"
  65 #include "gromacs/ewald/pme-gpu-program.h"
  66 #include "gromacs/fileio/checkpoint.h"
  67 #include "gromacs/fileio/oenv.h"
  68 #include "gromacs/fileio/tpxio.h"
  69 #include "gromacs/gmxlib/network.h"
  70 #include "gromacs/gmxlib/nrnb.h"
  71 #include "gromacs/gpu_utils/clfftinitializer.h"
  72 #include "gromacs/gpu_utils/gpu_utils.h"
  73 #include "gromacs/hardware/cpuinfo.h"
  74 #include "gromacs/hardware/detecthardware.h"
  75 #include "gromacs/hardware/printhardware.h"
  76 #include "gromacs/listed-forces/disre.h"
  77 #include "gromacs/listed-forces/orires.h"
  78 #include "gromacs/math/functions.h"
  79 #include "gromacs/math/utilities.h"
  80 #include "gromacs/math/vec.h"
  81 #include "gromacs/mdlib/boxdeformation.h"
  82 #include "gromacs/mdlib/calc_verletbuf.h"
  83 #include "gromacs/mdlib/forcerec.h"
  84 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  85 #include "gromacs/mdlib/makeconstraints.h"
  86 #include "gromacs/mdlib/md_support.h"
  87 #include "gromacs/mdlib/mdatoms.h"
  88 #include "gromacs/mdlib/mdrun.h"
  89 #include "gromacs/mdlib/membed.h"
  90 #include "gromacs/mdlib/nb_verlet.h"
  91 #include "gromacs/mdlib/nbnxn_gpu_data_mgmt.h"
  92 #include "gromacs/mdlib/nbnxn_search.h"
  93 #include "gromacs/mdlib/nbnxn_tuning.h"
  94 #include "gromacs/mdlib/qmmm.h"
  95 #include "gromacs/mdlib/sighandler.h"
  96 #include "gromacs/mdlib/sim_util.h"
  97 #include "gromacs/mdrun/logging.h"
  98 #include "gromacs/mdrun/multisim.h"
  99 #include "gromacs/mdrunutility/mdmodules.h"
 100 #include "gromacs/mdrunutility/threadaffinity.h"
 101 #include "gromacs/mdtypes/commrec.h"
 102 #include "gromacs/mdtypes/fcdata.h"
 103 #include "gromacs/mdtypes/inputrec.h"
 104 #include "gromacs/mdtypes/md_enums.h"
 105 #include "gromacs/mdtypes/observableshistory.h"
 106 #include "gromacs/mdtypes/state.h"
 107 #include "gromacs/pbcutil/pbc.h"
 108 #include "gromacs/pulling/pull.h"
 109 #include "gromacs/pulling/pull_rotation.h"
 110 #include "gromacs/swap/swapcoords.h"
 111 #include "gromacs/taskassignment/decidegpuusage.h"
 112 #include "gromacs/taskassignment/resourcedivision.h"
 113 #include "gromacs/taskassignment/taskassignment.h"
 114 #include "gromacs/taskassignment/usergpuids.h"
 115 #include "gromacs/timing/wallcycle.h"
 116 #include "gromacs/topology/mtop_util.h"
 117 #include "gromacs/trajectory/trajectoryframe.h"
 118 #include "gromacs/utility/basenetwork.h"
 119 #include "gromacs/utility/cstringutil.h"
 120 #include "gromacs/utility/exceptions.h"
 121 #include "gromacs/utility/fatalerror.h"
 122 #include "gromacs/utility/filestream.h"
 123 #include "gromacs/utility/gmxassert.h"
 124 #include "gromacs/utility/gmxmpi.h"
 125 #include "gromacs/utility/logger.h"
 126 #include "gromacs/utility/loggerbuilder.h"
 127 #include "gromacs/utility/physicalnodecommunicator.h"
 128 #include "gromacs/utility/pleasecite.h"
 129 #include "gromacs/utility/programcontext.h"
 130 #include "gromacs/utility/smalloc.h"
 131 #include "gromacs/utility/stringutil.h"
 132
 133 #include "integrator.h"
 134 #include "replicaexchange.h"
 135
 136 #ifdef GMX_FAHCORE
 137 #include "corewrap.h"
 138 #endif
 139
 140 namespace gmx
 141 {
 142
 143 /*! \brief Barrier for safe simultaneous thread access to mdrunner data
 144  *
 145  * Used to ensure that the master thread does not modify mdrunner during copy
 146  * on the spawned threads. */
 147 static void threadMpiMdrunnerAccessBarrier()
 148 {
 149 #if GMX_THREAD_MPI
 150     MPI_Barrier(MPI_COMM_WORLD);
 151 #endif
 152 }
 153
 154 void Mdrunner::reinitializeOnSpawnedThread()
 155 {
 156     threadMpiMdrunnerAccessBarrier();
 157
 158     cr  = reinitialize_commrec_for_this_thread(cr);
 159
 160     GMX_RELEASE_ASSERT(!MASTER(cr), "reinitializeOnSpawnedThread should only be called on spawned threads");
 161
 162     // Only the master rank writes to the log file
 163     fplog = nullptr;
 164 }
 165
 166 /*! \brief The callback used for running on spawned threads.
 167  *
 168  * Obtains the pointer to the master mdrunner object from the one
 169  * argument permitted to the thread-launch API call, copies it to make
 170  * a new runner for this thread, reinitializes necessary data, and
 171  * proceeds to the simulation. */
 172 static void mdrunner_start_fn(const void *arg)
 173 {
 174     try
 175     {
 176         auto masterMdrunner = reinterpret_cast<const gmx::Mdrunner *>(arg);
 177         /* copy the arg list to make sure that it's thread-local. This
 178            doesn't copy pointed-to items, of course; fnm, cr and fplog
 179            are reset in the call below, all others should be const. */
 180         gmx::Mdrunner mdrunner = *masterMdrunner;
 181         mdrunner.reinitializeOnSpawnedThread();
 182         mdrunner.mdrunner();
 183     }
 184     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 185 }
 186
 187
 188 /*! \brief Start thread-MPI threads.
 189  *
 190  * Called by mdrunner() to start a specific number of threads
 191  * (including the main thread) for thread-parallel runs. This in turn
 192  * calls mdrunner() for each thread. All options are the same as for
 193  * mdrunner(). */
 194 t_commrec *Mdrunner::spawnThreads(int numThreadsToLaunch) const
 195 {
 196
 197     /* first check whether we even need to start tMPI */
 198     if (numThreadsToLaunch < 2)
 199     {
 200         return cr;
 201     }
 202
 203 #if GMX_THREAD_MPI
 204     /* now spawn new threads that start mdrunner_start_fn(), while
 205        the main thread returns, we set thread affinity later */
 206     if (tMPI_Init_fn(TRUE, numThreadsToLaunch, TMPI_AFFINITY_NONE,
 207                      mdrunner_start_fn, static_cast<const void*>(this)) != TMPI_SUCCESS)
 208     {
 209         GMX_THROW(gmx::InternalError("Failed to spawn thread-MPI threads"));
 210     }
 211
 212     threadMpiMdrunnerAccessBarrier();
 213 #else
 214     GMX_UNUSED_VALUE(mdrunner_start_fn);
 215 #endif
 216
 217     return reinitialize_commrec_for_this_thread(cr);
 218 }
 219
 220 }  // namespace gmx
 221
 222 /*! \brief Initialize variables for Verlet scheme simulation */
 223 static void prepare_verlet_scheme(FILE                           *fplog,
 224                                   t_commrec                      *cr,
 225                                   t_inputrec                     *ir,
 226                                   int                             nstlist_cmdline,
 227                                   const gmx_mtop_t               *mtop,
 228                                   const matrix                    box,
 229                                   bool                            makeGpuPairList,
 230                                   const gmx::CpuInfo             &cpuinfo)
 231 {
 232     /* For NVE simulations, we will retain the initial list buffer */
 233     if (EI_DYNAMICS(ir->eI) &&
 234         ir->verletbuf_tol > 0 &&
 235         !(EI_MD(ir->eI) && ir->etc == etcNO))
 236     {
 237         /* Update the Verlet buffer size for the current run setup */
 238
 239         /* Here we assume SIMD-enabled kernels are being used. But as currently
 240          * calc_verlet_buffer_size gives the same results for 4x8 and 4x4
 241          * and 4x2 gives a larger buffer than 4x4, this is ok.
 242          */
 243         ListSetupType      listType  = (makeGpuPairList ? ListSetupType::Gpu : ListSetupType::CpuSimdWhenSupported);
 244         VerletbufListSetup listSetup = verletbufGetSafeListSetup(listType);
 245
 246         real               rlist_new;
 247         calc_verlet_buffer_size(mtop, det(box), ir, ir->nstlist, ir->nstlist - 1, -1, &listSetup, nullptr, &rlist_new);
 248
 249         if (rlist_new != ir->rlist)
 250         {
 251             if (fplog != nullptr)
 252             {
 253                 fprintf(fplog, "\nChanging rlist from %g to %g for non-bonded %dx%d atom kernels\n\n",
 254                         ir->rlist, rlist_new,
 255                         listSetup.cluster_size_i, listSetup.cluster_size_j);
 256             }
 257             ir->rlist     = rlist_new;
 258         }
 259     }
 260
 261     if (nstlist_cmdline > 0 && (!EI_DYNAMICS(ir->eI) || ir->verletbuf_tol <= 0))
 262     {
 263         gmx_fatal(FARGS, "Can not set nstlist without %s",
 264                   !EI_DYNAMICS(ir->eI) ? "dynamics" : "verlet-buffer-tolerance");
 265     }
 266
 267     if (EI_DYNAMICS(ir->eI))
 268     {
 269         /* Set or try nstlist values */
 270         increaseNstlist(fplog, cr, ir, nstlist_cmdline, mtop, box, makeGpuPairList, cpuinfo);
 271     }
 272 }
 273
 274 /*! \brief Override the nslist value in inputrec
 275  *
 276  * with value passed on the command line (if any)
 277  */
 278 static void override_nsteps_cmdline(const gmx::MDLogger &mdlog,
 279                                     int64_t              nsteps_cmdline,
 280                                     t_inputrec          *ir)
 281 {
 282     assert(ir);
 283
 284     /* override with anything else than the default -2 */
 285     if (nsteps_cmdline > -2)
 286     {
 287         char sbuf_steps[STEPSTRSIZE];
 288         char sbuf_msg[STRLEN];
 289
 290         ir->nsteps = nsteps_cmdline;
 291         if (EI_DYNAMICS(ir->eI) && nsteps_cmdline != -1)
 292         {
 293             sprintf(sbuf_msg, "Overriding nsteps with value passed on the command line: %s steps, %.3g ps",
 294                     gmx_step_str(nsteps_cmdline, sbuf_steps),
 295                     fabs(nsteps_cmdline*ir->delta_t));
 296         }
 297         else
 298         {
 299             sprintf(sbuf_msg, "Overriding nsteps with value passed on the command line: %s steps",
 300                     gmx_step_str(nsteps_cmdline, sbuf_steps));
 301         }
 302
 303         GMX_LOG(mdlog.warning).asParagraph().appendText(sbuf_msg);
 304     }
 305     else if (nsteps_cmdline < -2)
 306     {
 307         gmx_fatal(FARGS, "Invalid nsteps value passed on the command line: %" PRId64,
 308                   nsteps_cmdline);
 309     }
 310     /* Do nothing if nsteps_cmdline == -2 */
 311 }
 312
 313 namespace gmx
 314 {
 315
 316 /*! \brief Return whether GPU acceleration of nonbondeds is supported with the given settings.
 317  *
 318  * If not, and if a warning may be issued, logs a warning about
 319  * falling back to CPU code. With thread-MPI, only the first
 320  * call to this function should have \c issueWarning true. */
 321 static bool gpuAccelerationOfNonbondedIsUseful(const MDLogger   &mdlog,
 322                                                const t_inputrec *ir,
 323                                                bool              issueWarning)
 324 {
 325     if (ir->opts.ngener - ir->nwall > 1)
 326     {
 327         /* The GPU code does not support more than one energy group.
 328          * If the user requested GPUs explicitly, a fatal error is given later.
 329          */
 330         if (issueWarning)
 331         {
 332             GMX_LOG(mdlog.warning).asParagraph()
 333                 .appendText("Multiple energy groups is not implemented for GPUs, falling back to the CPU. "
 334                             "For better performance, run on the GPU without energy groups and then do "
 335                             "gmx mdrun -rerun option on the trajectory with an energy group .tpr file.");
 336         }
 337         return false;
 338     }
 339     return true;
 340 }
 341
 342 //! Initializes the logger for mdrun.
 343 static gmx::LoggerOwner buildLogger(FILE *fplog, const t_commrec *cr)
 344 {
 345     gmx::LoggerBuilder builder;
 346     if (fplog != nullptr)
 347     {
 348         builder.addTargetFile(gmx::MDLogger::LogLevel::Info, fplog);
 349     }
 350     if (cr == nullptr || SIMMASTER(cr))
 351     {
 352         builder.addTargetStream(gmx::MDLogger::LogLevel::Warning,
 353                                 &gmx::TextOutputFile::standardError());
 354     }
 355     return builder.build();
 356 }
 357
 358 //! Make a TaskTarget from an mdrun argument string.
 359 static TaskTarget findTaskTarget(const char *optionString)
 360 {
 361     TaskTarget returnValue = TaskTarget::Auto;
 362
 363     if (strncmp(optionString, "auto", 3) == 0)
 364     {
 365         returnValue = TaskTarget::Auto;
 366     }
 367     else if (strncmp(optionString, "cpu", 3) == 0)
 368     {
 369         returnValue = TaskTarget::Cpu;
 370     }
 371     else if (strncmp(optionString, "gpu", 3) == 0)
 372     {
 373         returnValue = TaskTarget::Gpu;
 374     }
 375     else
 376     {
 377         GMX_ASSERT(false, "Option string should have been checked for sanity already");
 378     }
 379
 380     return returnValue;
 381 }
 382
 383 int Mdrunner::mdrunner()
 384 {
 385     matrix                    box;
 386     t_nrnb                   *nrnb;
 387     t_forcerec               *fr               = nullptr;
 388     t_fcdata                 *fcd              = nullptr;
 389     real                      ewaldcoeff_q     = 0;
 390     real                      ewaldcoeff_lj    = 0;
 391     int                       nChargePerturbed = -1, nTypePerturbed = 0;
 392     gmx_wallcycle_t           wcycle;
 393     gmx_walltime_accounting_t walltime_accounting = nullptr;
 394     int                       rc;
 395     int64_t                   reset_counters;
 396     int                       nthreads_pme = 1;
 397     gmx_membed_t *            membed       = nullptr;
 398     gmx_hw_info_t            *hwinfo       = nullptr;
 399
 400     /* CAUTION: threads may be started later on in this function, so
 401        cr doesn't reflect the final parallel state right now */
 402     std::unique_ptr<gmx::MDModules> mdModules(new gmx::MDModules);
 403     t_inputrec                      inputrecInstance;
 404     t_inputrec                     *inputrec = &inputrecInstance;
 405     gmx_mtop_t                      mtop;
 406
 407     if (mdrunOptions.continuationOptions.appendFiles)
 408     {
 409         fplog = nullptr;
 410     }
 411
 412     bool doMembed = opt2bSet("-membed", nfile, fnm);
 413     bool doRerun  = mdrunOptions.rerun;
 414
 415     // Handle task-assignment related user options.
 416     EmulateGpuNonbonded emulateGpuNonbonded = (getenv("GMX_EMULATE_GPU") != nullptr ?
 417                                                EmulateGpuNonbonded::Yes : EmulateGpuNonbonded::No);
 418     std::vector<int>    gpuIdsAvailable;
 419     try
 420     {
 421         gpuIdsAvailable = parseUserGpuIds(hw_opt.gpuIdsAvailable);
 422         // TODO We could put the GPU IDs into a std::map to find
 423         // duplicates, but for the small numbers of IDs involved, this
 424         // code is simple and fast.
 425         for (size_t i = 0; i != gpuIdsAvailable.size(); ++i)
 426         {
 427             for (size_t j = i+1; j != gpuIdsAvailable.size(); ++j)
 428             {
 429                 if (gpuIdsAvailable[i] == gpuIdsAvailable[j])
 430                 {
 431                     GMX_THROW(InvalidInputError(formatString("The string of available GPU device IDs '%s' may not contain duplicate device IDs", hw_opt.gpuIdsAvailable.c_str())));
 432                 }
 433             }
 434         }
 435     }
 436     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 437
 438     std::vector<int> userGpuTaskAssignment;
 439     try
 440     {
 441         userGpuTaskAssignment = parseUserGpuIds(hw_opt.userGpuTaskAssignment);
 442     }
 443     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 444     auto       nonbondedTarget = findTaskTarget(nbpu_opt);
 445     auto       pmeTarget       = findTaskTarget(pme_opt);
 446     auto       pmeFftTarget    = findTaskTarget(pme_fft_opt);
 447     PmeRunMode pmeRunMode      = PmeRunMode::None;
 448
 449     // Here we assume that SIMMASTER(cr) does not change even after the
 450     // threads are started.
 451     gmx::LoggerOwner logOwner(buildLogger(fplog, cr));
 452     gmx::MDLogger    mdlog(logOwner.logger());
 453
 454     // TODO The thread-MPI master rank makes a working
 455     // PhysicalNodeCommunicator here, but it gets rebuilt by all ranks
 456     // after the threads have been launched. This works because no use
 457     // is made of that communicator until after the execution paths
 458     // have rejoined. But it is likely that we can improve the way
 459     // this is expressed, e.g. by expressly running detection only the
 460     // master rank for thread-MPI, rather than relying on the mutex
 461     // and reference count.
 462     PhysicalNodeCommunicator physicalNodeComm(MPI_COMM_WORLD, gmx_physicalnode_id_hash());
 463     hwinfo = gmx_detect_hardware(mdlog, physicalNodeComm);
 464
 465     gmx_print_detected_hardware(fplog, cr, ms, mdlog, hwinfo);
 466
 467     std::vector<int> gpuIdsToUse;
 468     auto             compatibleGpus = getCompatibleGpus(hwinfo->gpu_info);
 469     if (gpuIdsAvailable.empty())
 470     {
 471         gpuIdsToUse = compatibleGpus;
 472     }
 473     else
 474     {
 475         for (const auto &availableGpuId : gpuIdsAvailable)
 476         {
 477             bool availableGpuIsCompatible = false;
 478             for (const auto &compatibleGpuId : compatibleGpus)
 479             {
 480                 if (availableGpuId == compatibleGpuId)
 481                 {
 482                     availableGpuIsCompatible = true;
 483                     break;
 484                 }
 485             }
 486             if (!availableGpuIsCompatible)
 487             {
 488                 gmx_fatal(FARGS, "You limited the set of compatible GPUs to a set that included ID #%d, but that ID is not for a compatible GPU. List only compatible GPUs.", availableGpuId);
 489             }
 490             gpuIdsToUse.push_back(availableGpuId);
 491         }
 492     }
 493
 494     if (fplog != nullptr)
 495     {
 496         /* Print references after all software/hardware printing */
 497         please_cite(fplog, "Abraham2015");
 498         please_cite(fplog, "Pall2015");
 499         please_cite(fplog, "Pronk2013");
 500         please_cite(fplog, "Hess2008b");
 501         please_cite(fplog, "Spoel2005a");
 502         please_cite(fplog, "Lindahl2001a");
 503         please_cite(fplog, "Berendsen95a");
 504     }
 505
 506     std::unique_ptr<t_state> globalState;
 507
 508     if (SIMMASTER(cr))
 509     {
 510         /* Only the master rank has the global state */
 511         globalState = compat::make_unique<t_state>();
 512
 513         /* Read (nearly) all data required for the simulation */
 514         read_tpx_state(ftp2fn(efTPR, nfile, fnm), inputrec, globalState.get(), &mtop);
 515
 516         if (inputrec->cutoff_scheme != ecutsVERLET)
 517         {
 518             if (nstlist_cmdline > 0)
 519             {
 520                 gmx_fatal(FARGS, "Can not set nstlist with the group cut-off scheme");
 521             }
 522
 523             if (!compatibleGpus.empty())
 524             {
 525                 GMX_LOG(mdlog.warning).asParagraph().appendText(
 526                         "NOTE: GPU(s) found, but the current simulation can not use GPUs\n"
 527                         "      To use a GPU, set the mdp option: cutoff-scheme = Verlet");
 528             }
 529         }
 530     }
 531
 532     /* Check and update the hardware options for internal consistency */
 533     check_and_update_hw_opt_1(mdlog, &hw_opt, cr, domdecOptions.numPmeRanks);
 534
 535     /* Early check for externally set process affinity. */
 536     gmx_check_thread_affinity_set(mdlog, cr,
 537                                   &hw_opt, hwinfo->nthreads_hw_avail, FALSE);
 538
 539     if (GMX_THREAD_MPI && SIMMASTER(cr))
 540     {
 541         if (domdecOptions.numPmeRanks > 0 && hw_opt.nthreads_tmpi <= 0)
 542         {
 543             gmx_fatal(FARGS, "You need to explicitly specify the number of MPI threads (-ntmpi) when using separate PME ranks");
 544         }
 545
 546         /* Since the master knows the cut-off scheme, update hw_opt for this.
 547          * This is done later for normal MPI and also once more with tMPI
 548          * for all tMPI ranks.
 549          */
 550         check_and_update_hw_opt_2(&hw_opt, inputrec->cutoff_scheme);
 551
 552         bool useGpuForNonbonded = false;
 553         bool useGpuForPme       = false;
 554         try
 555         {
 556             // If the user specified the number of ranks, then we must
 557             // respect that, but in default mode, we need to allow for
 558             // the number of GPUs to choose the number of ranks.
 559
 560             useGpuForNonbonded = decideWhetherToUseGpusForNonbondedWithThreadMpi
 561                     (nonbondedTarget, gpuIdsToUse, userGpuTaskAssignment, emulateGpuNonbonded,
 562                     inputrec->cutoff_scheme == ecutsVERLET,
 563                     gpuAccelerationOfNonbondedIsUseful(mdlog, inputrec, GMX_THREAD_MPI),
 564                     hw_opt.nthreads_tmpi);
 565             auto canUseGpuForPme   = pme_gpu_supports_build(nullptr) && pme_gpu_supports_input(*inputrec, mtop, nullptr);
 566             useGpuForPme = decideWhetherToUseGpusForPmeWithThreadMpi
 567                     (useGpuForNonbonded, pmeTarget, gpuIdsToUse, userGpuTaskAssignment,
 568                     canUseGpuForPme, hw_opt.nthreads_tmpi, domdecOptions.numPmeRanks);
 569
 570         }
 571         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 572
 573         /* Determine how many thread-MPI ranks to start.
 574          *
 575          * TODO Over-writing the user-supplied value here does
 576          * prevent any possible subsequent checks from working
 577          * correctly. */
 578         hw_opt.nthreads_tmpi = get_nthreads_mpi(hwinfo,
 579                                                 &hw_opt,
 580                                                 gpuIdsToUse,
 581                                                 useGpuForNonbonded,
 582                                                 useGpuForPme,
 583                                                 inputrec, &mtop,
 584                                                 mdlog,
 585                                                 doMembed);
 586
 587         // Now start the threads for thread MPI.
 588         cr = spawnThreads(hw_opt.nthreads_tmpi);
 589         /* The main thread continues here with a new cr. We don't deallocate
 590            the old cr because other threads may still be reading it. */
 591         // TODO Both master and spawned threads call dup_tfn and
 592         // reinitialize_commrec_for_this_thread. Find a way to express
 593         // this better.
 594         physicalNodeComm = PhysicalNodeCommunicator(MPI_COMM_WORLD, gmx_physicalnode_id_hash());
 595     }
 596     // END OF CAUTION: cr and physicalNodeComm are now reliable
 597
 598     if (PAR(cr))
 599     {
 600         /* now broadcast everything to the non-master nodes/threads: */
 601         init_parallel(cr, inputrec, &mtop);
 602     }
 603
 604     // Now each rank knows the inputrec that SIMMASTER read and used,
 605     // and (if applicable) cr->nnodes has been assigned the number of
 606     // thread-MPI ranks that have been chosen. The ranks can now all
 607     // run the task-deciding functions and will agree on the result
 608     // without needing to communicate.
 609     //
 610     // TODO Should we do the communication in debug mode to support
 611     // having an assertion?
 612     //
 613     // Note that these variables describe only their own node.
 614     bool useGpuForNonbonded = false;
 615     bool useGpuForPme       = false;
 616     try
 617     {
 618         // It's possible that there are different numbers of GPUs on
 619         // different nodes, which is the user's responsibilty to
 620         // handle. If unsuitable, we will notice that during task
 621         // assignment.
 622         bool gpusWereDetected = hwinfo->ngpu_compatible_tot > 0;
 623         useGpuForNonbonded = decideWhetherToUseGpusForNonbonded(nonbondedTarget, userGpuTaskAssignment,
 624                                                                 emulateGpuNonbonded, inputrec->cutoff_scheme == ecutsVERLET,
 625                                                                 gpuAccelerationOfNonbondedIsUseful(mdlog, inputrec, !GMX_THREAD_MPI),
 626                                                                 gpusWereDetected);
 627         auto canUseGpuForPme   = pme_gpu_supports_build(nullptr) && pme_gpu_supports_input(*inputrec, mtop, nullptr);
 628         useGpuForPme = decideWhetherToUseGpusForPme(useGpuForNonbonded, pmeTarget, userGpuTaskAssignment,
 629                                                     canUseGpuForPme, cr->nnodes, domdecOptions.numPmeRanks,
 630                                                     gpusWereDetected);
 631
 632         pmeRunMode   = (useGpuForPme ? PmeRunMode::GPU : PmeRunMode::CPU);
 633         if (pmeRunMode == PmeRunMode::GPU)
 634         {
 635             if (pmeFftTarget == TaskTarget::Cpu)
 636             {
 637                 pmeRunMode = PmeRunMode::Mixed;
 638             }
 639         }
 640         else if (pmeFftTarget == TaskTarget::Gpu)
 641         {
 642             gmx_fatal(FARGS, "Assigning FFTs to GPU requires PME to be assigned to GPU as well. With PME on CPU you should not be using -pmefft.");
 643         }
 644     }
 645     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 646
 647     // TODO: Error handling
 648     mdModules->assignOptionsToModules(*inputrec->params, nullptr);
 649
 650     if (fplog != nullptr)
 651     {
 652         pr_inputrec(fplog, 0, "Input Parameters", inputrec, FALSE);
 653         fprintf(fplog, "\n");
 654     }
 655
 656     if (SIMMASTER(cr))
 657     {
 658         /* now make sure the state is initialized and propagated */
 659         set_state_entries(globalState.get(), inputrec);
 660     }
 661
 662     /* NM and TPI parallelize over force/energy calculations, not atoms,
 663      * so we need to initialize and broadcast the global state.
 664      */
 665     if (inputrec->eI == eiNM || inputrec->eI == eiTPI)
 666     {
 667         if (!MASTER(cr))
 668         {
 669             globalState = compat::make_unique<t_state>();
 670         }
 671         broadcastStateWithoutDynamics(cr, globalState.get());
 672     }
 673
 674     /* A parallel command line option consistency check that we can
 675        only do after any threads have started. */
 676     if (!PAR(cr) && (domdecOptions.numCells[XX] > 1 ||
 677                      domdecOptions.numCells[YY] > 1 ||
 678                      domdecOptions.numCells[ZZ] > 1 ||
 679                      domdecOptions.numPmeRanks > 0))
 680     {
 681         gmx_fatal(FARGS,
 682                   "The -dd or -npme option request a parallel simulation, "
 683 #if !GMX_MPI
 684                   "but %s was compiled without threads or MPI enabled", output_env_get_program_display_name(oenv));
 685 #else
 686 #if GMX_THREAD_MPI
 687                   "but the number of MPI-threads (option -ntmpi) is not set or is 1");
 688 #else
 689                   "but %s was not started through mpirun/mpiexec or only one rank was requested through mpirun/mpiexec", output_env_get_program_display_name(oenv));
 690 #endif
 691 #endif
 692     }
 693
 694     if (doRerun &&
 695         (EI_ENERGY_MINIMIZATION(inputrec->eI) || eiNM == inputrec->eI))
 696     {
 697         gmx_fatal(FARGS, "The .mdp file specified an energy mininization or normal mode algorithm, and these are not compatible with mdrun -rerun");
 698     }
 699
 700     if (can_use_allvsall(inputrec, TRUE, cr, fplog) && DOMAINDECOMP(cr))
 701     {
 702         gmx_fatal(FARGS, "All-vs-all loops do not work with domain decomposition, use a single MPI rank");
 703     }
 704
 705     if (!(EEL_PME(inputrec->coulombtype) || EVDW_PME(inputrec->vdwtype)))
 706     {
 707         if (domdecOptions.numPmeRanks > 0)
 708         {
 709             gmx_fatal_collective(FARGS, cr->mpi_comm_mysim, MASTER(cr),
 710                                  "PME-only ranks are requested, but the system does not use PME for electrostatics or LJ");
 711         }
 712
 713         domdecOptions.numPmeRanks = 0;
 714     }
 715
 716     if (useGpuForNonbonded && domdecOptions.numPmeRanks < 0)
 717     {
 718         /* With NB GPUs we don't automatically use PME-only CPU ranks. PME ranks can
 719          * improve performance with many threads per GPU, since our OpenMP
 720          * scaling is bad, but it's difficult to automate the setup.
 721          */
 722         domdecOptions.numPmeRanks = 0;
 723     }
 724     if (useGpuForPme)
 725     {
 726         if (domdecOptions.numPmeRanks < 0)
 727         {
 728             domdecOptions.numPmeRanks = 0;
 729             // TODO possibly print a note that one can opt-in for a separate PME GPU rank?
 730         }
 731         else
 732         {
 733             GMX_RELEASE_ASSERT(domdecOptions.numPmeRanks <= 1, "PME GPU decomposition is not supported");
 734         }
 735     }
 736
 737 #ifdef GMX_FAHCORE
 738     if (MASTER(cr))
 739     {
 740         fcRegisterSteps(inputrec->nsteps, inputrec->init_step);
 741     }
 742 #endif
 743
 744     /* NMR restraints must be initialized before load_checkpoint,
 745      * since with time averaging the history is added to t_state.
 746      * For proper consistency check we therefore need to extend
 747      * t_state here.
 748      * So the PME-only nodes (if present) will also initialize
 749      * the distance restraints.
 750      */
 751     snew(fcd, 1);
 752
 753     /* This needs to be called before read_checkpoint to extend the state */
 754     init_disres(fplog, &mtop, inputrec, cr, ms, fcd, globalState.get(), replExParams.exchangeInterval > 0);
 755
 756     init_orires(fplog, &mtop, inputrec, cr, ms, globalState.get(), &(fcd->orires));
 757
 758     auto                 deform = prepareBoxDeformation(globalState->box, cr, *inputrec);
 759
 760     ObservablesHistory   observablesHistory = {};
 761
 762     ContinuationOptions &continuationOptions = mdrunOptions.continuationOptions;
 763
 764     if (continuationOptions.startedFromCheckpoint)
 765     {
 766         /* Check if checkpoint file exists before doing continuation.
 767          * This way we can use identical input options for the first and subsequent runs...
 768          */
 769         gmx_bool bReadEkin;
 770
 771         load_checkpoint(opt2fn_master("-cpi", nfile, fnm, cr), &fplog,
 772                         cr, domdecOptions.numCells,
 773                         inputrec, globalState.get(),
 774                         &bReadEkin, &observablesHistory,
 775                         continuationOptions.appendFiles,
 776                         continuationOptions.appendFilesOptionSet,
 777                         mdrunOptions.reproducible);
 778
 779         if (bReadEkin)
 780         {
 781             continuationOptions.haveReadEkin = true;
 782         }
 783     }
 784
 785     if (SIMMASTER(cr) && continuationOptions.appendFiles)
 786     {
 787         gmx_log_open(ftp2fn(efLOG, nfile, fnm), cr,
 788                      continuationOptions.appendFiles, &fplog);
 789         logOwner = buildLogger(fplog, nullptr);
 790         mdlog    = logOwner.logger();
 791     }
 792
 793     if (mdrunOptions.numStepsCommandline > -2)
 794     {
 795         GMX_LOG(mdlog.info).asParagraph().
 796             appendText("The -nsteps functionality is deprecated, and may be removed in a future version. "
 797                        "Consider using gmx convert-tpr -nsteps or changing the appropriate .mdp file field.");
 798     }
 799     /* override nsteps with value set on the commamdline */
 800     override_nsteps_cmdline(mdlog, mdrunOptions.numStepsCommandline, inputrec);
 801
 802     if (SIMMASTER(cr))
 803     {
 804         copy_mat(globalState->box, box);
 805     }
 806
 807     if (PAR(cr))
 808     {
 809         gmx_bcast(sizeof(box), box, cr);
 810     }
 811
 812     /* Update rlist and nstlist. */
 813     if (inputrec->cutoff_scheme == ecutsVERLET)
 814     {
 815         prepare_verlet_scheme(fplog, cr, inputrec, nstlist_cmdline, &mtop, box,
 816                               useGpuForNonbonded || (emulateGpuNonbonded == EmulateGpuNonbonded::Yes), *hwinfo->cpuInfo);
 817     }
 818
 819     LocalAtomSetManager atomSets;
 820
 821     if (PAR(cr) && !(EI_TPI(inputrec->eI) ||
 822                      inputrec->eI == eiNM))
 823     {
 824         cr->dd = init_domain_decomposition(mdlog, cr, domdecOptions, mdrunOptions,
 825                                            &mtop, inputrec,
 826                                            box, positionsFromStatePointer(globalState.get()),
 827                                            &atomSets);
 828         // Note that local state still does not exist yet.
 829     }
 830     else
 831     {
 832         /* PME, if used, is done on all nodes with 1D decomposition */
 833         cr->npmenodes = 0;
 834         cr->duty      = (DUTY_PP | DUTY_PME);
 835
 836         if (inputrec->ePBC == epbcSCREW)
 837         {
 838             gmx_fatal(FARGS,
 839                       "pbc=screw is only implemented with domain decomposition");
 840         }
 841     }
 842
 843     if (PAR(cr))
 844     {
 845         /* After possible communicator splitting in make_dd_communicators.
 846          * we can set up the intra/inter node communication.
 847          */
 848         gmx_setup_nodecomm(fplog, cr);
 849     }
 850
 851 #if GMX_MPI
 852     if (isMultiSim(ms))
 853     {
 854         GMX_LOG(mdlog.warning).asParagraph().appendTextFormatted(
 855                 "This is simulation %d out of %d running as a composite GROMACS\n"
 856                 "multi-simulation job. Setup for this simulation:\n",
 857                 ms->sim, ms->nsim);
 858     }
 859     GMX_LOG(mdlog.warning).appendTextFormatted(
 860             "Using %d MPI %s\n",
 861             cr->nnodes,
 862 #if GMX_THREAD_MPI
 863             cr->nnodes == 1 ? "thread" : "threads"
 864 #else
 865             cr->nnodes == 1 ? "process" : "processes"
 866 #endif
 867             );
 868     fflush(stderr);
 869 #endif
 870
 871     /* Check and update hw_opt for the cut-off scheme */
 872     check_and_update_hw_opt_2(&hw_opt, inputrec->cutoff_scheme);
 873
 874     /* Check and update the number of OpenMP threads requested */
 875     checkAndUpdateRequestedNumOpenmpThreads(&hw_opt, *hwinfo, cr, ms, physicalNodeComm.size_,
 876                                             pmeRunMode, mtop);
 877
 878     gmx_omp_nthreads_init(mdlog, cr,
 879                           hwinfo->nthreads_hw_avail,
 880                           physicalNodeComm.size_,
 881                           hw_opt.nthreads_omp,
 882                           hw_opt.nthreads_omp_pme,
 883                           !thisRankHasDuty(cr, DUTY_PP),
 884                           inputrec->cutoff_scheme == ecutsVERLET);
 885
 886     // Enable FP exception but not in Release mode and not for compilers
 887     // with known buggy FP exception support (clang with any optimization)
 888     // or suspected buggy FP exception support (gcc 7.* with optimization).
 889 #if !defined NDEBUG && \
 890     !((defined __clang__ || (defined(__GNUC__) && !defined(__ICC) && __GNUC__ == 7)) \
 891     && defined __OPTIMIZE__)
 892     const bool bEnableFPE = !EI_TPI(inputrec->eI) &&
 893         inputrec->cutoff_scheme == ecutsVERLET;
 894 #else
 895     const bool bEnableFPE = false;
 896 #endif
 897     //FIXME - reconcile with gmx_feenableexcept() call from CommandLineModuleManager::run()
 898     if (bEnableFPE)
 899     {
 900         gmx_feenableexcept();
 901     }
 902
 903     // Build a data structure that expresses which kinds of non-bonded
 904     // task are handled by this rank.
 905     //
 906     // TODO Later, this might become a loop over all registered modules
 907     // relevant to the mdp inputs, to find those that have such tasks.
 908     //
 909     // TODO This could move before init_domain_decomposition() as part
 910     // of refactoring that separates the responsibility for duty
 911     // assignment from setup for communication between tasks, and
 912     // setup for tasks handled with a domain (ie including short-ranged
 913     // tasks, bonded tasks, etc.).
 914     //
 915     // Note that in general useGpuForNonbonded, etc. can have a value
 916     // that is inconsistent with the presence of actual GPUs on any
 917     // rank, and that is not known to be a problem until the
 918     // duty of the ranks on a node become node.
 919     //
 920     // TODO Later we might need the concept of computeTasksOnThisRank,
 921     // from which we construct gpuTasksOnThisRank.
 922     //
 923     // Currently the DD code assigns duty to ranks that can
 924     // include PP work that currently can be executed on a single
 925     // GPU, if present and compatible.  This has to be coordinated
 926     // across PP ranks on a node, with possible multiple devices
 927     // or sharing devices on a node, either from the user
 928     // selection, or automatically.
 929     auto                 haveGpus = !gpuIdsToUse.empty();
 930     std::vector<GpuTask> gpuTasksOnThisRank;
 931     if (thisRankHasDuty(cr, DUTY_PP))
 932     {
 933         if (useGpuForNonbonded)
 934         {
 935             if (haveGpus)
 936             {
 937                 gpuTasksOnThisRank.push_back(GpuTask::Nonbonded);
 938             }
 939             else if (nonbondedTarget == TaskTarget::Gpu)
 940             {
 941                 gmx_fatal(FARGS, "Cannot run short-ranged nonbonded interactions on a GPU because there is none detected.");
 942             }
 943         }
 944     }
 945     // TODO cr->duty & DUTY_PME should imply that a PME algorithm is active, but currently does not.
 946     if (EEL_PME(inputrec->coulombtype) && (thisRankHasDuty(cr, DUTY_PME)))
 947     {
 948         if (useGpuForPme)
 949         {
 950             if (haveGpus)
 951             {
 952                 gpuTasksOnThisRank.push_back(GpuTask::Pme);
 953             }
 954             else if (pmeTarget == TaskTarget::Gpu)
 955             {
 956                 gmx_fatal(FARGS, "Cannot run PME on a GPU because there is none detected.");
 957             }
 958         }
 959     }
 960
 961     GpuTaskAssignment gpuTaskAssignment;
 962     try
 963     {
 964         // Produce the task assignment for this rank.
 965         gpuTaskAssignment = runTaskAssignment(gpuIdsToUse, userGpuTaskAssignment, *hwinfo,
 966                                               mdlog, cr, ms, physicalNodeComm, gpuTasksOnThisRank);
 967     }
 968     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 969
 970     /* Prevent other ranks from continuing after an issue was found
 971      * and reported as a fatal error.
 972      *
 973      * TODO This function implements a barrier so that MPI runtimes
 974      * can organize an orderly shutdown if one of the ranks has had to
 975      * issue a fatal error in various code already run. When we have
 976      * MPI-aware error handling and reporting, this should be
 977      * improved. */
 978 #if GMX_MPI
 979     if (PAR(cr))
 980     {
 981         MPI_Barrier(cr->mpi_comm_mysim);
 982     }
 983     if (isMultiSim(ms))
 984     {
 985         if (SIMMASTER(cr))
 986         {
 987             MPI_Barrier(ms->mpi_comm_masters);
 988         }
 989         /* We need another barrier to prevent non-master ranks from contiuing
 990          * when an error occured in a different simulation.
 991          */
 992         MPI_Barrier(cr->mpi_comm_mysim);
 993     }
 994 #endif
 995
 996     /* Now that we know the setup is consistent, check for efficiency */
 997     check_resource_division_efficiency(hwinfo, !gpuTaskAssignment.empty(), mdrunOptions.ntompOptionIsSet,
 998                                        cr, mdlog);
 999
1000     gmx_device_info_t *nonbondedDeviceInfo = nullptr;
1001
1002     if (thisRankHasDuty(cr, DUTY_PP))
1003     {
1004         // This works because only one task of each type is currently permitted.
1005         auto nbGpuTaskMapping = std::find_if(gpuTaskAssignment.begin(), gpuTaskAssignment.end(),
1006                                              hasTaskType<GpuTask::Nonbonded>);
1007         if (nbGpuTaskMapping != gpuTaskAssignment.end())
1008         {
1009             int nonbondedDeviceId = nbGpuTaskMapping->deviceId_;
1010             nonbondedDeviceInfo = getDeviceInfo(hwinfo->gpu_info, nonbondedDeviceId);
1011             init_gpu(mdlog, nonbondedDeviceInfo);
1012
1013             if (DOMAINDECOMP(cr))
1014             {
1015                 /* When we share GPUs over ranks, we need to know this for the DLB */
1016                 dd_setup_dlb_resource_sharing(cr, nonbondedDeviceId);
1017             }
1018
1019         }
1020     }
1021
1022     std::unique_ptr<ClfftInitializer> initializedClfftLibrary;
1023
1024     gmx_device_info_t                *pmeDeviceInfo = nullptr;
1025     // Later, this program could contain kernels that might be later
1026     // re-used as auto-tuning progresses, or subsequent simulations
1027     // are invoked.
1028     PmeGpuProgramStorage pmeGpuProgram;
1029     // This works because only one task of each type is currently permitted.
1030     auto                 pmeGpuTaskMapping     = std::find_if(gpuTaskAssignment.begin(), gpuTaskAssignment.end(), hasTaskType<GpuTask::Pme>);
1031     const bool           thisRankHasPmeGpuTask = (pmeGpuTaskMapping != gpuTaskAssignment.end());
1032     if (thisRankHasPmeGpuTask)
1033     {
1034         pmeDeviceInfo = getDeviceInfo(hwinfo->gpu_info, pmeGpuTaskMapping->deviceId_);
1035         init_gpu(mdlog, pmeDeviceInfo);
1036         pmeGpuProgram = buildPmeGpuProgram(pmeDeviceInfo);
1037         // TODO It would be nice to move this logic into the factory
1038         // function. See Redmine #2535.
1039         bool isMasterThread = !GMX_THREAD_MPI || MASTER(cr);
1040         if (pmeRunMode == PmeRunMode::GPU && !initializedClfftLibrary && isMasterThread)
1041         {
1042             initializedClfftLibrary = initializeClfftLibrary();
1043         }
1044     }
1045
1046     /* getting number of PP/PME threads
1047        PME: env variable should be read only on one node to make sure it is
1048        identical everywhere;
1049      */
1050     nthreads_pme = gmx_omp_nthreads_get(emntPME);
1051
1052     int numThreadsOnThisRank;
1053     /* threads on this MPI process or TMPI thread */
1054     if (thisRankHasDuty(cr, DUTY_PP))
1055     {
1056         numThreadsOnThisRank = gmx_omp_nthreads_get(emntNonbonded);
1057     }
1058     else
1059     {
1060         numThreadsOnThisRank = nthreads_pme;
1061     }
1062
1063     checkHardwareOversubscription(numThreadsOnThisRank, cr->nodeid,
1064                                   *hwinfo->hardwareTopology,
1065                                   physicalNodeComm, mdlog);
1066
1067     if (hw_opt.thread_affinity != threadaffOFF)
1068     {
1069         /* Before setting affinity, check whether the affinity has changed
1070          * - which indicates that probably the OpenMP library has changed it
1071          * since we first checked).
1072          */
1073         gmx_check_thread_affinity_set(mdlog, cr,
1074                                       &hw_opt, hwinfo->nthreads_hw_avail, TRUE);
1075
1076         int numThreadsOnThisNode, intraNodeThreadOffset;
1077         analyzeThreadsOnThisNode(physicalNodeComm, numThreadsOnThisRank, &numThreadsOnThisNode,
1078                                  &intraNodeThreadOffset);
1079
1080         /* Set the CPU affinity */
1081         gmx_set_thread_affinity(mdlog, cr, &hw_opt, *hwinfo->hardwareTopology,
1082                                 numThreadsOnThisRank, numThreadsOnThisNode,
1083                                 intraNodeThreadOffset, nullptr);
1084     }
1085
1086     if (mdrunOptions.timingOptions.resetStep > -1)
1087     {
1088         GMX_LOG(mdlog.info).asParagraph().
1089             appendText("The -resetstep functionality is deprecated, and may be removed in a future version.");
1090     }
1091     wcycle = wallcycle_init(fplog, mdrunOptions.timingOptions.resetStep, cr);
1092
1093     if (PAR(cr))
1094     {
1095         /* Master synchronizes its value of reset_counters with all nodes
1096          * including PME only nodes */
1097         reset_counters = wcycle_get_reset_counters(wcycle);
1098         gmx_bcast_sim(sizeof(reset_counters), &reset_counters, cr);
1099         wcycle_set_reset_counters(wcycle, reset_counters);
1100     }
1101
1102     // Membrane embedding must be initialized before we call init_forcerec()
1103     if (doMembed)
1104     {
1105         if (MASTER(cr))
1106         {
1107             fprintf(stderr, "Initializing membed");
1108         }
1109         /* Note that membed cannot work in parallel because mtop is
1110          * changed here. Fix this if we ever want to make it run with
1111          * multiple ranks. */
1112         membed = init_membed(fplog, nfile, fnm, &mtop, inputrec, globalState.get(), cr, &mdrunOptions.checkpointOptions.period);
1113     }
1114
1115     std::unique_ptr<MDAtoms>     mdAtoms;
1116     std::unique_ptr<gmx_vsite_t> vsite;
1117
1118     snew(nrnb, 1);
1119     if (thisRankHasDuty(cr, DUTY_PP))
1120     {
1121         /* Initiate forcerecord */
1122         fr                 = mk_forcerec();
1123         fr->forceProviders = mdModules->initForceProviders();
1124         init_forcerec(fplog, mdlog, fr, fcd,
1125                       inputrec, &mtop, cr, box,
1126                       opt2fn("-table", nfile, fnm),
1127                       opt2fn("-tablep", nfile, fnm),
1128                       opt2fns("-tableb", nfile, fnm),
1129                       *hwinfo, nonbondedDeviceInfo,
1130                       FALSE,
1131                       pforce);
1132
1133         /* Initialize QM-MM */
1134         if (fr->bQMMM)
1135         {
1136             GMX_LOG(mdlog.info).asParagraph().
1137                 appendText("Large parts of the QM/MM support is deprecated, and may be removed in a future "
1138                            "version. Please get in touch with the developers if you find the support useful, "
1139                            "as help is needed if the functionality is to continue to be available.");
1140             init_QMMMrec(cr, &mtop, inputrec, fr);
1141         }
1142
1143         /* Initialize the mdAtoms structure.
1144          * mdAtoms is not filled with atom data,
1145          * as this can not be done now with domain decomposition.
1146          */
1147         mdAtoms = makeMDAtoms(fplog, mtop, *inputrec, thisRankHasPmeGpuTask);
1148         if (globalState && thisRankHasPmeGpuTask)
1149         {
1150             // The pinning of coordinates in the global state object works, because we only use
1151             // PME on GPU without DD or on a separate PME rank, and because the local state pointer
1152             // points to the global state object without DD.
1153             // FIXME: MD and EM separately set up the local state - this should happen in the same function,
1154             // which should also perform the pinning.
1155             changePinningPolicy(&globalState->x, pme_get_pinning_policy());
1156         }
1157
1158         /* Initialize the virtual site communication */
1159         vsite = initVsite(mtop, cr);
1160
1161         calc_shifts(box, fr->shift_vec);
1162
1163         /* With periodic molecules the charge groups should be whole at start up
1164          * and the virtual sites should not be far from their proper positions.
1165          */
1166         if (!inputrec->bContinuation && MASTER(cr) &&
1167             !(inputrec->ePBC != epbcNONE && inputrec->bPeriodicMols))
1168         {
1169             /* Make molecules whole at start of run */
1170             if (fr->ePBC != epbcNONE)
1171             {
1172                 rvec *xGlobal = as_rvec_array(globalState->x.data());
1173                 do_pbc_first_mtop(fplog, inputrec->ePBC, box, &mtop, xGlobal);
1174             }
1175             if (vsite)
1176             {
1177                 /* Correct initial vsite positions are required
1178                  * for the initial distribution in the domain decomposition
1179                  * and for the initial shell prediction.
1180                  */
1181                 constructVsitesGlobal(mtop, globalState->x);
1182             }
1183         }
1184
1185         if (EEL_PME(fr->ic->eeltype) || EVDW_PME(fr->ic->vdwtype))
1186         {
1187             ewaldcoeff_q  = fr->ic->ewaldcoeff_q;
1188             ewaldcoeff_lj = fr->ic->ewaldcoeff_lj;
1189         }
1190     }
1191     else
1192     {
1193         /* This is a PME only node */
1194
1195         GMX_ASSERT(globalState == nullptr, "We don't need the state on a PME only rank and expect it to be unitialized");
1196
1197         ewaldcoeff_q  = calc_ewaldcoeff_q(inputrec->rcoulomb, inputrec->ewald_rtol);
1198         ewaldcoeff_lj = calc_ewaldcoeff_lj(inputrec->rvdw, inputrec->ewald_rtol_lj);
1199     }
1200
1201     gmx_pme_t *sepPmeData = nullptr;
1202     // This reference hides the fact that PME data is owned by runner on PME-only ranks and by forcerec on other ranks
1203     GMX_ASSERT(thisRankHasDuty(cr, DUTY_PP) == (fr != nullptr), "Double-checking that only PME-only ranks have no forcerec");
1204     gmx_pme_t * &pmedata = fr ? fr->pmedata : sepPmeData;
1205
1206     /* Initiate PME if necessary,
1207      * either on all nodes or on dedicated PME nodes only. */
1208     if (EEL_PME(inputrec->coulombtype) || EVDW_PME(inputrec->vdwtype))
1209     {
1210         if (mdAtoms && mdAtoms->mdatoms())
1211         {
1212             nChargePerturbed = mdAtoms->mdatoms()->nChargePerturbed;
1213             if (EVDW_PME(inputrec->vdwtype))
1214             {
1215                 nTypePerturbed   = mdAtoms->mdatoms()->nTypePerturbed;
1216             }
1217         }
1218         if (cr->npmenodes > 0)
1219         {
1220             /* The PME only nodes need to know nChargePerturbed(FEP on Q) and nTypePerturbed(FEP on LJ)*/
1221             gmx_bcast_sim(sizeof(nChargePerturbed), &nChargePerturbed, cr);
1222             gmx_bcast_sim(sizeof(nTypePerturbed), &nTypePerturbed, cr);
1223         }
1224
1225         if (thisRankHasDuty(cr, DUTY_PME))
1226         {
1227             try
1228             {
1229                 pmedata = gmx_pme_init(cr,
1230                                        getNumPmeDomains(cr->dd),
1231                                        inputrec,
1232                                        mtop.natoms, nChargePerturbed != 0, nTypePerturbed != 0,
1233                                        mdrunOptions.reproducible,
1234                                        ewaldcoeff_q, ewaldcoeff_lj,
1235                                        nthreads_pme,
1236                                        pmeRunMode, nullptr,
1237                                        pmeDeviceInfo, pmeGpuProgram.get(), mdlog);
1238             }
1239             GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1240         }
1241     }
1242
1243
1244     if (EI_DYNAMICS(inputrec->eI))
1245     {
1246         /* Turn on signal handling on all nodes */
1247         /*
1248          * (A user signal from the PME nodes (if any)
1249          * is communicated to the PP nodes.
1250          */
1251         signal_handler_install();
1252     }
1253
1254     if (thisRankHasDuty(cr, DUTY_PP))
1255     {
1256         /* Assumes uniform use of the number of OpenMP threads */
1257         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(emntDefault));
1258
1259         if (inputrec->bPull)
1260         {
1261             /* Initialize pull code */
1262             inputrec->pull_work =
1263                 init_pull(fplog, inputrec->pull, inputrec,
1264                           &mtop, cr, &atomSets, inputrec->fepvals->init_lambda);
1265             if (EI_DYNAMICS(inputrec->eI) && MASTER(cr))
1266             {
1267                 init_pull_output_files(inputrec->pull_work,
1268                                        nfile, fnm, oenv,
1269                                        continuationOptions);
1270             }
1271         }
1272
1273         std::unique_ptr<EnforcedRotation> enforcedRotation;
1274         if (inputrec->bRot)
1275         {
1276             /* Initialize enforced rotation code */
1277             enforcedRotation = init_rot(fplog, inputrec, nfile, fnm, cr, &atomSets, globalState.get(), &mtop, oenv, mdrunOptions);
1278         }
1279
1280         if (inputrec->eSwapCoords != eswapNO)
1281         {
1282             /* Initialize ion swapping code */
1283             init_swapcoords(fplog, inputrec, opt2fn_master("-swap", nfile, fnm, cr),
1284                             &mtop, globalState.get(), &observablesHistory,
1285                             cr, &atomSets, oenv, mdrunOptions);
1286         }
1287
1288         /* Let makeConstraints know whether we have essential dynamics constraints.
1289          * TODO: inputrec should tell us whether we use an algorithm, not a file option or the checkpoint
1290          */
1291         bool doEssentialDynamics = (opt2fn_null("-ei", nfile, fnm) != nullptr || observablesHistory.edsamHistory);
1292         auto constr              = makeConstraints(mtop, *inputrec, doEssentialDynamics,
1293                                                    fplog, *mdAtoms->mdatoms(),
1294                                                    cr, *ms, nrnb, wcycle, fr->bMolPBC);
1295
1296         if (DOMAINDECOMP(cr))
1297         {
1298             GMX_RELEASE_ASSERT(fr, "fr was NULL while cr->duty was DUTY_PP");
1299             /* This call is not included in init_domain_decomposition mainly
1300              * because fr->cginfo_mb is set later.
1301              */
1302             dd_init_bondeds(fplog, cr->dd, &mtop, vsite.get(), inputrec,
1303                             domdecOptions.checkBondedInteractions,
1304                             fr->cginfo_mb);
1305         }
1306
1307         /* Now do whatever the user wants us to do (how flexible...) */
1308         Integrator integrator {
1309             fplog, cr, ms, mdlog, nfile, fnm,
1310             oenv,
1311             mdrunOptions,
1312             vsite.get(), constr.get(),
1313             enforcedRotation ? enforcedRotation->getLegacyEnfrot() : nullptr,
1314             deform.get(),
1315             mdModules->outputProvider(),
1316             inputrec, &mtop,
1317             fcd,
1318             globalState.get(),
1319             &observablesHistory,
1320             mdAtoms.get(), nrnb, wcycle, fr,
1321             replExParams,
1322             membed,
1323             walltime_accounting
1324         };
1325         integrator.run(inputrec->eI);
1326
1327         if (inputrec->bPull)
1328         {
1329             finish_pull(inputrec->pull_work);
1330         }
1331
1332     }
1333     else
1334     {
1335         GMX_RELEASE_ASSERT(pmedata, "pmedata was NULL while cr->duty was not DUTY_PP");
1336         /* do PME only */
1337         walltime_accounting = walltime_accounting_init(gmx_omp_nthreads_get(emntPME));
1338         gmx_pmeonly(pmedata, cr, nrnb, wcycle, walltime_accounting, inputrec, pmeRunMode);
1339     }
1340
1341     wallcycle_stop(wcycle, ewcRUN);
1342
1343     /* Finish up, write some stuff
1344      * if rerunMD, don't write last frame again
1345      */
1346     finish_run(fplog, mdlog, cr,
1347                inputrec, nrnb, wcycle, walltime_accounting,
1348                fr ? fr->nbv : nullptr,
1349                pmedata,
1350                EI_DYNAMICS(inputrec->eI) && !isMultiSim(ms));
1351
1352     // Free PME data
1353     if (pmedata)
1354     {
1355         gmx_pme_destroy(pmedata);
1356         pmedata = nullptr;
1357     }
1358
1359     // FIXME: this is only here to manually unpin mdAtoms->chargeA_ and state->x,
1360     // before we destroy the GPU context(s) in free_gpu_resources().
1361     // Pinned buffers are associated with contexts in CUDA.
1362     // As soon as we destroy GPU contexts after mdrunner() exits, these lines should go.
1363     mdAtoms.reset(nullptr);
1364     globalState.reset(nullptr);
1365     mdModules.reset(nullptr);   // destruct force providers here as they might also use the GPU
1366
1367     /* Free GPU memory and set a physical node tMPI barrier (which should eventually go away) */
1368     free_gpu_resources(fr, physicalNodeComm);
1369     free_gpu(nonbondedDeviceInfo);
1370     free_gpu(pmeDeviceInfo);
1371     done_forcerec(fr, mtop.molblock.size(), mtop.groups.grps[egcENER].nr);
1372     sfree(fcd);
1373
1374     if (doMembed)
1375     {
1376         free_membed(membed);
1377     }
1378
1379     gmx_hardware_info_free();
1380
1381     /* Does what it says */
1382     print_date_and_time(fplog, cr->nodeid, "Finished mdrun", gmx_gettime());
1383     walltime_accounting_destroy(walltime_accounting);
1384     sfree(nrnb);
1385
1386     /* Close logfile already here if we were appending to it */
1387     if (MASTER(cr) && continuationOptions.appendFiles)
1388     {
1389         gmx_log_close(fplog);
1390         fplog = nullptr;
1391     }
1392
1393     /* Reset FPEs (important for unit tests) by disabling them. Assumes no
1394      * exceptions were enabled before function was called. */
1395     if (bEnableFPE)
1396     {
1397         gmx_fedisableexcept();
1398     }
1399
1400     rc = static_cast<int>(gmx_get_stop_condition());
1401
1402 #if GMX_THREAD_MPI
1403     /* we need to join all threads. The sub-threads join when they
1404        exit this function, but the master thread needs to be told to
1405        wait for that. */
1406     if (PAR(cr) && MASTER(cr))
1407     {
1408         done_commrec(cr);
1409         tMPI_Finalize();
1410     }
1411 #endif
1412
1413     return rc;
1414 }
1415
1416 } // namespace gmx