src/gromacs/utility/init.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015, 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  * Implements functions from init.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gromacs/utility/init.h"
  43
  44 #ifdef HAVE_CONFIG_H
  45 #include "config.h"
  46 #endif
  47
  48 #include "gromacs/legacyheaders/gmx_fatal.h"
  49
  50 #ifdef GMX_LIB_MPI
  51 #include "gromacs/utility/gmxmpi.h"
  52 #endif
  53
  54 #include "gromacs/utility/common.h"
  55 #include "gromacs/utility/gmxassert.h"
  56
  57 namespace gmx
  58 {
  59
  60 namespace
  61 {
  62 #ifdef GMX_LIB_MPI
  63 //! Maintains global counter of attempts to initialize MPI
  64 int g_initializationCounter = 0;
  65 #endif
  66 }
  67
  68 void init(int *argc, char ***argv)
  69 {
  70 #ifdef GMX_LIB_MPI
  71     int isInitialized = 0, isFinalized = 0;
  72     MPI_Finalized(&isFinalized);
  73     GMX_RELEASE_ASSERT(!isFinalized, "Invalid attempt to initialize MPI after finalization");
  74     MPI_Initialized(&isInitialized);
  75     if (isInitialized)
  76     {
  77         if (0 == g_initializationCounter)
  78         {
  79             // Some other code has already initialized MPI, so bump the counter so that
  80             // we know not to finalize MPI ourselves later.
  81             g_initializationCounter++;
  82         }
  83     }
  84     else
  85     {
  86 #ifdef GMX_FAHCORE
  87         fah_MPI_Init(argc, argv);
  88 #else
  89 #    ifdef GMX_OPENMP
  90         /* Formally we need to use MPI_Init_thread and ask for MPI_THREAD_FUNNELED
  91          * level of thread support when using OpenMP. However, in practice we
  92          * have never seen any problems with just using MPI_Init(), and some MPI
  93          * versions that only return MPI_THREAD_SINGLE as their support level
  94          * still return an OK initialization code when we request MPI_THREAD_FUNNELED.
  95          *
  96          * To avoid requiring users to recompile and install new libraries for something
  97          * that probably isn't a problem, we don't make a fuss about it (no warning)
  98          * if MPI_Init_thread() returns ok. If it does not return OK we
  99          * call a second init call without thread support, but since the library
 100          * apparently tried to prevent this we do issue a warning in this case.
 101          *
 102          * support, and if that doesn't work we simply use the simple MPI_Init().
 103          * Note that MPICH does not allow us to call MPI_Query_thread() before
 104          * we have initialized the library, and calling MPI_Init twice could
 105          * be a bit fragile. However, some implementations also advice against
 106          * doing anything else after calling MPI_Finalize, so at the end of the
 107          * day we'll have to cross our fingers...
 108          */
 109         int provided, rc;
 110         rc = MPI_Init_thread(argc, argv, MPI_THREAD_FUNNELED, &provided);
 111         if (rc != 0 && provided < MPI_THREAD_FUNNELED)
 112         {
 113             gmx_warning("GROMACS was compiled with OpenMP support, but there is no thread support in the MPI library. Keep your fingers crossed.");
 114             MPI_Init(argc, argv);
 115         }
 116 #    else
 117         MPI_Init(argc, argv);
 118 #    endif
 119 #endif
 120     }
 121     // Bump the counter to record this initialization event
 122     g_initializationCounter++;
 123
 124 #else
 125     GMX_UNUSED_VALUE(argc);
 126     GMX_UNUSED_VALUE(argv);
 127 #endif
 128 }
 129
 130 void finalize()
 131 {
 132 #ifdef GMX_LIB_MPI
 133     GMX_RELEASE_ASSERT(0 < g_initializationCounter, "Excess attempt to finalize MPI");
 134     // Bump the counter to record this finalization event
 135     g_initializationCounter--;
 136
 137     if (0 == g_initializationCounter)
 138     {
 139         /* We sync the processes here to try to avoid problems
 140          * with buggy MPI implementations that could cause
 141          * unfinished processes to terminate.
 142          */
 143         MPI_Barrier(MPI_COMM_WORLD);
 144
 145         /* Apparently certain mpich implementations cause problems
 146          * with MPI_Finalize. In that case comment out MPI_Finalize.
 147          */
 148         MPI_Finalize();
 149     }
 150 #endif
 151 }
 152
 153 } // namespace gmx