src/gromacs/gmxlib/network.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) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "gmxpre.h"
  39
  40 #include "network.h"
  41
  42 #include "config.h"
  43
  44 #include <cctype>
  45 #include <cstdarg>
  46 #include <cstdlib>
  47 #include <cstring>
  48
  49 #include "gromacs/commandline/filenm.h"
  50 #include "gromacs/mdtypes/commrec.h"
  51 #include "gromacs/utility/basenetwork.h"
  52 #include "gromacs/utility/cstringutil.h"
  53 #include "gromacs/utility/fatalerror.h"
  54 #include "gromacs/utility/futil.h"
  55 #include "gromacs/utility/gmxassert.h"
  56 #include "gromacs/utility/gmxmpi.h"
  57 #include "gromacs/utility/real.h"
  58 #include "gromacs/utility/smalloc.h"
  59
  60 /* The source code in this file should be thread-safe.
  61       Please keep it that way. */
  62
  63 CommrecHandle init_commrec(MPI_Comm communicator)
  64 {
  65     CommrecHandle handle;
  66     t_commrec*    cr;
  67
  68     snew(cr, 1);
  69     handle.reset(cr);
  70
  71     int rankInCommunicator, sizeOfCommunicator;
  72 #if GMX_MPI
  73 #    if GMX_LIB_MPI
  74     GMX_RELEASE_ASSERT(gmx_mpi_initialized(), "Must have initialized MPI before building commrec");
  75 #    endif
  76     MPI_Comm_rank(communicator, &rankInCommunicator);
  77     MPI_Comm_size(communicator, &sizeOfCommunicator);
  78 #else
  79     GMX_UNUSED_VALUE(communicator);
  80     rankInCommunicator = 0;
  81     sizeOfCommunicator = 1;
  82 #endif
  83
  84     cr->mpiDefaultCommunicator    = communicator;
  85     cr->sizeOfDefaultCommunicator = sizeOfCommunicator;
  86     cr->rankInDefaultCommunicator = rankInCommunicator;
  87
  88     // For now, we want things to go horribly wrong if this is used too early...
  89     // TODO: Remove when communicators are removed from commrec (#2395)
  90     cr->nnodes           = -1;
  91     cr->nodeid           = -1;
  92     cr->sim_nodeid       = -1;
  93     cr->mpi_comm_mysim   = MPI_COMM_NULL;
  94     cr->mpi_comm_mygroup = MPI_COMM_NULL;
  95
  96     // TODO cr->duty should not be initialized here
  97     cr->duty = (DUTY_PP | DUTY_PME);
  98
  99     return handle;
 100 }
 101
 102 void done_commrec(t_commrec* cr)
 103 {
 104     if (MASTER(cr))
 105     {
 106         if (nullptr != cr->dd)
 107         {
 108             // TODO: implement
 109             // done_domdec(cr->dd);
 110         }
 111     }
 112 #if GMX_MPI
 113     // TODO We need to be able to free communicators, but the
 114     // structure of the commrec and domdec initialization code makes
 115     // it hard to avoid both leaks and double frees.
 116     bool mySimIsMyGroup = (cr->mpi_comm_mysim == cr->mpi_comm_mygroup);
 117     if (cr->mpi_comm_mysim != MPI_COMM_NULL && cr->mpi_comm_mysim != MPI_COMM_WORLD)
 118     {
 119         // TODO see above
 120         // MPI_Comm_free(&cr->mpi_comm_mysim);
 121     }
 122     if (!mySimIsMyGroup && cr->mpi_comm_mygroup != MPI_COMM_NULL && cr->mpi_comm_mygroup != MPI_COMM_WORLD)
 123     {
 124         // TODO see above
 125         // MPI_Comm_free(&cr->mpi_comm_mygroup);
 126     }
 127 #endif
 128     sfree(cr);
 129 }
 130
 131 void gmx_setup_nodecomm(FILE gmx_unused* fplog, t_commrec* cr)
 132 {
 133     gmx_nodecomm_t* nc;
 134
 135     /* Many MPI implementations do not optimize MPI_Allreduce
 136      * (and probably also other global communication calls)
 137      * for multi-core nodes connected by a network.
 138      * We can optimize such communication by using one MPI call
 139      * within each node and one between the nodes.
 140      * For MVAPICH2 and Intel MPI this reduces the time for
 141      * the global_stat communication by 25%
 142      * for 2x2-core 3 GHz Woodcrest connected by mixed DDR/SDR Infiniband.
 143      * B. Hess, November 2007
 144      */
 145
 146     nc = &cr->nc;
 147
 148     nc->bUse = FALSE;
 149 #if !GMX_THREAD_MPI
 150 #    if GMX_MPI
 151     int n, rank;
 152
 153     // TODO PhysicalNodeCommunicator could be extended/used to handle
 154     // the need for per-node per-group communicators.
 155     MPI_Comm_size(cr->mpi_comm_mygroup, &n);
 156     MPI_Comm_rank(cr->mpi_comm_mygroup, &rank);
 157
 158     int nodehash = gmx_physicalnode_id_hash();
 159
 160     if (debug)
 161     {
 162         fprintf(debug, "In gmx_setup_nodecomm: splitting communicator of size %d\n", n);
 163     }
 164
 165
 166     /* The intra-node communicator, split on node number */
 167     MPI_Comm_split(cr->mpi_comm_mygroup, nodehash, rank, &nc->comm_intra);
 168     MPI_Comm_rank(nc->comm_intra, &nc->rank_intra);
 169     if (debug)
 170     {
 171         fprintf(debug, "In gmx_setup_nodecomm: node ID %d rank within node %d\n", rank, nc->rank_intra);
 172     }
 173     /* The inter-node communicator, split on rank_intra.
 174      * We actually only need the one for rank=0,
 175      * but it is easier to create them all.
 176      */
 177     MPI_Comm_split(cr->mpi_comm_mygroup, nc->rank_intra, rank, &nc->comm_inter);
 178     /* Check if this really created two step communication */
 179     int ng, ni;
 180
 181     MPI_Comm_size(nc->comm_inter, &ng);
 182     MPI_Comm_size(nc->comm_intra, &ni);
 183     if (debug)
 184     {
 185         fprintf(debug, "In gmx_setup_nodecomm: groups %d, my group size %d\n", ng, ni);
 186     }
 187
 188     if (getenv("GMX_NO_NODECOMM") == nullptr && ((ng > 1 && ng < n) || (ni > 1 && ni < n)))
 189     {
 190         nc->bUse = TRUE;
 191         if (fplog)
 192         {
 193             fprintf(fplog,
 194                     "Using two step summing over %d groups of on average %.1f ranks\n\n",
 195                     ng,
 196                     real(n) / real(ng));
 197         }
 198         if (nc->rank_intra > 0)
 199         {
 200             MPI_Comm_free(&nc->comm_inter);
 201         }
 202     }
 203     else
 204     {
 205         /* One group or all processes in a separate group, use normal summing */
 206         MPI_Comm_free(&nc->comm_inter);
 207         MPI_Comm_free(&nc->comm_intra);
 208         if (debug)
 209         {
 210             fprintf(debug,
 211                     "In gmx_setup_nodecomm: not unsing separate inter- and intra-node "
 212                     "communicators.\n");
 213         }
 214     }
 215 #    endif
 216 #else
 217     /* tMPI runs only on a single node so just use the nodeid */
 218     nc->rank_intra = cr->nodeid;
 219 #endif
 220 }
 221
 222 void gmx_barrier(MPI_Comm gmx_unused communicator)
 223 {
 224 #if !GMX_MPI
 225     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_barrier");
 226 #else
 227     MPI_Barrier(communicator);
 228 #endif
 229 }
 230
 231 void gmx_bcast(int gmx_unused nbytes, void gmx_unused* b, MPI_Comm gmx_unused communicator)
 232 {
 233 #if !GMX_MPI
 234     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_bcast");
 235 #else
 236     MPI_Bcast(b, nbytes, MPI_BYTE, 0, communicator);
 237 #endif
 238 }
 239
 240 void gmx_sumd(int gmx_unused nr, double gmx_unused r[], const t_commrec gmx_unused* cr)
 241 {
 242 #if !GMX_MPI
 243     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_sumd");
 244 #else
 245     if (cr->nc.bUse)
 246     {
 247         if (cr->nc.rank_intra == 0)
 248         {
 249             /* Use two step summing. */
 250             MPI_Reduce(MPI_IN_PLACE, r, nr, MPI_DOUBLE, MPI_SUM, 0, cr->nc.comm_intra);
 251             /* Sum the roots of the internal (intra) buffers. */
 252             MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_DOUBLE, MPI_SUM, cr->nc.comm_inter);
 253         }
 254         else
 255         {
 256             /* This is here because of the silly MPI specification
 257                 that MPI_IN_PLACE should be put in sendbuf instead of recvbuf */
 258             MPI_Reduce(r, nullptr, nr, MPI_DOUBLE, MPI_SUM, 0, cr->nc.comm_intra);
 259         }
 260         MPI_Bcast(r, nr, MPI_DOUBLE, 0, cr->nc.comm_intra);
 261     }
 262     else
 263     {
 264         MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_DOUBLE, MPI_SUM, cr->mpi_comm_mygroup);
 265     }
 266 #endif
 267 }
 268
 269 void gmx_sumf(int gmx_unused nr, float gmx_unused r[], const t_commrec gmx_unused* cr)
 270 {
 271 #if !GMX_MPI
 272     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_sumf");
 273 #else
 274     if (cr->nc.bUse)
 275     {
 276         /* Use two step summing.  */
 277         if (cr->nc.rank_intra == 0)
 278         {
 279             MPI_Reduce(MPI_IN_PLACE, r, nr, MPI_FLOAT, MPI_SUM, 0, cr->nc.comm_intra);
 280             /* Sum the roots of the internal (intra) buffers */
 281             MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_FLOAT, MPI_SUM, cr->nc.comm_inter);
 282         }
 283         else
 284         {
 285             /* This is here because of the silly MPI specification
 286                 that MPI_IN_PLACE should be put in sendbuf instead of recvbuf */
 287             MPI_Reduce(r, nullptr, nr, MPI_FLOAT, MPI_SUM, 0, cr->nc.comm_intra);
 288         }
 289         MPI_Bcast(r, nr, MPI_FLOAT, 0, cr->nc.comm_intra);
 290     }
 291     else
 292     {
 293         MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_FLOAT, MPI_SUM, cr->mpi_comm_mygroup);
 294     }
 295 #endif
 296 }
 297
 298 void gmx_sumi(int gmx_unused nr, int gmx_unused r[], const t_commrec gmx_unused* cr)
 299 {
 300 #if !GMX_MPI
 301     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_sumi");
 302 #else
 303     if (cr->nc.bUse)
 304     {
 305         /* Use two step summing */
 306         if (cr->nc.rank_intra == 0)
 307         {
 308             MPI_Reduce(MPI_IN_PLACE, r, nr, MPI_INT, MPI_SUM, 0, cr->nc.comm_intra);
 309             /* Sum with the buffers reversed */
 310             MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_INT, MPI_SUM, cr->nc.comm_inter);
 311         }
 312         else
 313         {
 314             /* This is here because of the silly MPI specification
 315                 that MPI_IN_PLACE should be put in sendbuf instead of recvbuf */
 316             MPI_Reduce(r, nullptr, nr, MPI_INT, MPI_SUM, 0, cr->nc.comm_intra);
 317         }
 318         MPI_Bcast(r, nr, MPI_INT, 0, cr->nc.comm_intra);
 319     }
 320     else
 321     {
 322         MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_INT, MPI_SUM, cr->mpi_comm_mygroup);
 323     }
 324 #endif
 325 }
 326
 327 void gmx_sumli(int gmx_unused nr, int64_t gmx_unused r[], const t_commrec gmx_unused* cr)
 328 {
 329 #if !GMX_MPI
 330     GMX_RELEASE_ASSERT(false, "Invalid call to gmx_sumli");
 331 #else
 332     if (cr->nc.bUse)
 333     {
 334         /* Use two step summing */
 335         if (cr->nc.rank_intra == 0)
 336         {
 337             MPI_Reduce(MPI_IN_PLACE, r, nr, MPI_INT64_T, MPI_SUM, 0, cr->nc.comm_intra);
 338             /* Sum with the buffers reversed */
 339             MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_INT64_T, MPI_SUM, cr->nc.comm_inter);
 340         }
 341         else
 342         {
 343             /* This is here because of the silly MPI specification
 344                 that MPI_IN_PLACE should be put in sendbuf instead of recvbuf */
 345             MPI_Reduce(r, nullptr, nr, MPI_INT64_T, MPI_SUM, 0, cr->nc.comm_intra);
 346         }
 347         MPI_Bcast(r, nr, MPI_INT64_T, 0, cr->nc.comm_intra);
 348     }
 349     else
 350     {
 351         MPI_Allreduce(MPI_IN_PLACE, r, nr, MPI_INT64_T, MPI_SUM, cr->mpi_comm_mygroup);
 352     }
 353 #endif
 354 }
 355
 356 const char* opt2fn_master(const char* opt, int nfile, const t_filenm fnm[], t_commrec* cr)
 357 {
 358     return SIMMASTER(cr) ? opt2fn(opt, nfile, fnm) : nullptr;
 359 }
 360
 361 void gmx_fatal_collective(int                    f_errno,
 362                           const char*            file,
 363                           int                    line,
 364                           MPI_Comm               comm,
 365                           gmx_bool               bMaster,
 366                           gmx_fmtstr const char* fmt,
 367                           ...)
 368 {
 369     va_list  ap;
 370     gmx_bool bFinalize;
 371 #if GMX_MPI
 372     int result;
 373     /* Check if we are calling on all processes in MPI_COMM_WORLD */
 374     MPI_Comm_compare(comm, MPI_COMM_WORLD, &result);
 375     /* Any result except MPI_UNEQUAL allows us to call MPI_Finalize */
 376     bFinalize = (result != MPI_UNEQUAL);
 377 #else
 378     GMX_UNUSED_VALUE(comm);
 379     bFinalize = TRUE;
 380 #endif
 381
 382     va_start(ap, fmt);
 383     gmx_fatal_mpi_va(f_errno, file, line, bMaster, bFinalize, fmt, ap);
 384     va_end(ap);
 385 }