src/gromacs/utility/physicalnodecommunicator.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Defines functionality for communicators across physical nodes.
  38  *
  39  * \ingroup module_utility
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "physicalnodecommunicator.h"
  44
  45 #include "config.h"
  46
  47 #include "gromacs/utility/basedefinitions.h"
  48 #include "gromacs/utility/gmxmpi.h"
  49
  50 namespace gmx
  51 {
  52
  53 void MPI_Comm_free_wrapper(MPI_Comm* comm)
  54 {
  55 #if GMX_MPI
  56     // With thread-MPI *comm is shared between ranks which causes issues with
  57     // freeing. But all thread-mpi data is anyhow freed in tMPI_Finalize()
  58     // and in practice *comm is always MPI_COMM_WORLD with thread-MPI.
  59     // Only the thread-affinity test code uses *comm != MPI_COMM_WORLD.
  60     if (!GMX_THREAD_MPI)
  61     {
  62         MPI_Comm_free(comm);
  63     }
  64 #else
  65     GMX_UNUSED_VALUE(comm);
  66 #endif
  67 }
  68
  69 PhysicalNodeCommunicator::PhysicalNodeCommunicator(MPI_Comm world, int physicalNodeId)
  70 {
  71 #if GMX_MPI
  72     int isInitialized;
  73     MPI_Initialized(&isInitialized);
  74     if (isInitialized)
  75     {
  76         int sizeOfWorld;
  77         MPI_Comm_size(world, &sizeOfWorld);
  78         if (sizeOfWorld > 1)
  79         {
  80             int rankWithinWorld;
  81             MPI_Comm_rank(world, &rankWithinWorld);
  82             MPI_Comm_split(world, physicalNodeId, rankWithinWorld, &comm_);
  83             auto ptr = MPI_Comm_ptr(&comm_);
  84             commGuard_.swap(ptr);
  85             MPI_Comm_size(comm_, &size_);
  86             MPI_Comm_rank(comm_, &rank_);
  87         }
  88         else
  89         {
  90             // Handle this trivial case separately, because thread-MPI
  91             // doesn't have a valid communicator when there is only
  92             // one rank.
  93             comm_ = world;
  94             size_ = 1;
  95             rank_ = 0;
  96         }
  97     }
  98     else
  99     {
 100         comm_ = MPI_COMM_NULL;
 101         size_ = 1;
 102         rank_ = 0;
 103     }
 104 #else
 105     // Trivial case when there is no MPI support or not initialized
 106     GMX_UNUSED_VALUE(world);
 107     GMX_UNUSED_VALUE(physicalNodeId);
 108     comm_ = nullptr;
 109     size_ = 1;
 110     rank_ = 0;
 111 #endif
 112 }
 113
 114 void PhysicalNodeCommunicator::barrier() const
 115 {
 116 #if GMX_MPI
 117     if (size_ > 1)
 118     {
 119         MPI_Barrier(comm_);
 120     }
 121 #else
 122     // Nothing to do
 123 #endif
 124 }
 125
 126 } // namespace gmx