src/gromacs/mdtypes/commrec.h

   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,2017,2018,2019, 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 #ifndef GMX_MDTYPES_COMMREC_H
  38 #define GMX_MDTYPES_COMMREC_H
  39
  40 #include <stddef.h>
  41
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/gmxassert.h"
  44 #include "gromacs/utility/gmxmpi.h"
  45
  46 struct mpi_in_place_buf_t;
  47 struct gmx_domdec_t;
  48
  49 #define DUTY_PP (1U << 0U)
  50 #define DUTY_PME (1U << 1U)
  51
  52 typedef struct
  53 {
  54     int      bUse;
  55     MPI_Comm comm_intra;
  56     int      rank_intra;
  57     MPI_Comm comm_inter;
  58
  59 } gmx_nodecomm_t;
  60
  61 struct t_commrec
  62 {
  63     /* The nodeids in one sim are numbered sequentially from 0.
  64      * All communication within some simulation should happen
  65      * in mpi_comm_mysim, or its subset mpi_comm_mygroup.
  66      */
  67     int sim_nodeid, nnodes, npmenodes;
  68
  69     /* thread numbers: */
  70     /* Not used yet: int threadid, nthreads; */
  71     /* The nodeid in the PP/PME, PP or PME group */
  72     int nodeid;
  73
  74     /* MPI communicators within a single simulation
  75      * Note: other parts of the code may further subset these communicators.
  76      */
  77     MPI_Comm mpi_comm_mysim;   /* communicator including all ranks of
  78                                   a single simulation */
  79     MPI_Comm mpi_comm_mygroup; /* subset of mpi_comm_mysim including only
  80                                   the ranks in the same group (PP or PME) */
  81
  82     gmx_nodecomm_t nc;
  83
  84     /* For domain decomposition */
  85     gmx_domdec_t* dd;
  86
  87     /* The duties of this node, see the DUTY_ defines above.
  88      * This should be read through thisRankHasDuty() or getThisRankDuties().
  89      */
  90     int duty;
  91
  92     /* these buffers are used as destination buffers if MPI_IN_PLACE isn't
  93        supported.*/
  94     mpi_in_place_buf_t* mpb;
  95 };
  96
  97 /*! \brief
  98  * Returns the rank's duty, and asserts that it has been initialized.
  99  */
 100 inline int getThisRankDuties(const t_commrec* cr)
 101 {
 102     GMX_ASSERT(cr, "Invalid commrec pointer");
 103     GMX_ASSERT(cr->duty != 0, "Commrec duty was not initialized!");
 104     return cr->duty;
 105 }
 106
 107 /*! \brief
 108  * A convenience getter for the commrec duty assignment;
 109  * asserts that duty is actually valid (have been initialized).
 110  *
 111  * \param[in] cr    Communication structure pointer
 112  * \param[in] duty  A single duty's corresponding DUTY_ flag. Combinations are not supported.
 113  *
 114  * \returns Whether this duty is assigned to this rank.
 115  */
 116 inline bool thisRankHasDuty(const t_commrec* cr, int duty)
 117 {
 118     GMX_ASSERT((duty == DUTY_PME) || (duty == DUTY_PP), "Invalid duty type");
 119     return (getThisRankDuties(cr) & duty) != 0;
 120 }
 121
 122 /*! \brief True if this is a simulation with more than 1 rank
 123  *
 124  * In particular, this is true for multi-rank runs with TPI and NM, because
 125  * they use a decomposition that is not the domain decomposition used by
 126  * other simulation types. */
 127 #define PAR(cr) ((cr)->nnodes > 1)
 128
 129 //! True of this is the master node
 130 #define MASTER(cr) (((cr)->nodeid == 0) || !PAR(cr))
 131
 132 //! True if this is the particle-particle master
 133 #define SIMMASTER(cr) ((MASTER(cr) && thisRankHasDuty((cr), DUTY_PP)) || !PAR(cr))
 134
 135 //! The node id for this rank
 136 #define RANK(cr, nodeid) (nodeid)
 137
 138 //! The node id for the master
 139 #define MASTERRANK(cr) (0)
 140
 141 /*! \brief Do we decompose the work of this simulation?
 142  *
 143  * True if this simulation uses more than one PP rank, or if this simulation
 144  * uses at least one PME-only rank.
 145  *
 146  * PAR(cr) is true if this is true, but the converse does not apply (see docs
 147  * of PAR(cr)).
 148  *
 149  * This is true if havePPDomainDecomposition is true, but the converse does not
 150  * apply (see docs of havePpDomainDecomposition()).
 151  *
 152  * \todo As part of Redmine #2395, replace calls to this with
 153  * havePPDomainDecomposition or a call of some other/new function, as
 154  * appropriate to each case. Then eliminate this macro. */
 155 #define DOMAINDECOMP(cr) (((cr)->dd != nullptr) && PAR(cr))
 156
 157 /*! \brief Returns whether we have actual domain decomposition for the particle-particle interactions
 158  *
 159  * Will return false when we use 1 rank for PP and 1 for PME
 160  */
 161 static bool inline havePPDomainDecomposition(const t_commrec* cr)
 162 {
 163     /* NOTE: It would be better to use cr->dd->nnodes, but we do not want
 164      *       to pull in a dependency on domdec.h into this file.
 165      */
 166     GMX_ASSERT(cr != nullptr, "Invalid call of havePPDomainDecomposition before commrec is made");
 167     GMX_ASSERT(cr->npmenodes >= 0,
 168                "Invalid call of havePPDomainDecomposition before MPMD automated decomposition was "
 169                "chosen.");
 170     return (cr->dd != nullptr && cr->nnodes - cr->npmenodes > 1);
 171 }
 172
 173 #endif