src/gromacs/utility/init.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 "gmxpre.h"
  43
  44 #include "gromacs/utility/init.h"
  45
  46 #include "config.h"
  47
  48 #ifdef GMX_LIB_MPI
  49 #include "gromacs/utility/gmxmpi.h"
  50 #endif
  51
  52 #include "gromacs/utility/common.h"
  53 #include "gromacs/utility/gmxassert.h"
  54
  55 namespace gmx
  56 {
  57
  58 namespace
  59 {
  60 #ifdef GMX_LIB_MPI
  61 //! Maintains global counter of attempts to initialize MPI
  62 int g_initializationCounter = 0;
  63 #endif
  64 }
  65
  66 void init(int *argc, char ***argv)
  67 {
  68 #ifdef GMX_LIB_MPI
  69     int isInitialized = 0, isFinalized = 0;
  70     MPI_Finalized(&isFinalized);
  71     GMX_RELEASE_ASSERT(!isFinalized, "Invalid attempt to initialize MPI after finalization");
  72     MPI_Initialized(&isInitialized);
  73     if (isInitialized)
  74     {
  75         if (0 == g_initializationCounter)
  76         {
  77             // Some other code has already initialized MPI, so bump the counter so that
  78             // we know not to finalize MPI ourselves later.
  79             g_initializationCounter++;
  80         }
  81     }
  82     else
  83     {
  84 #ifdef GMX_FAHCORE
  85         (void) fah_MPI_Init(argc, argv);
  86 #else
  87         (void) MPI_Init(argc, argv);
  88 #endif
  89     }
  90     // Bump the counter to record this initialization event
  91     g_initializationCounter++;
  92
  93 #else
  94     GMX_UNUSED_VALUE(argc);
  95     GMX_UNUSED_VALUE(argv);
  96 #endif
  97 }
  98
  99 void finalize()
 100 {
 101 #ifdef GMX_LIB_MPI
 102     GMX_RELEASE_ASSERT(0 < g_initializationCounter, "Excess attempt to finalize MPI");
 103     // Bump the counter to record this finalization event
 104     g_initializationCounter--;
 105
 106     if (0 == g_initializationCounter)
 107     {
 108         /* We sync the processes here to try to avoid problems
 109          * with buggy MPI implementations that could cause
 110          * unfinished processes to terminate.
 111          */
 112         MPI_Barrier(MPI_COMM_WORLD);
 113
 114         /* Apparently certain mpich implementations cause problems
 115          * with MPI_Finalize. In that case comment out MPI_Finalize.
 116          */
 117         MPI_Finalize();
 118     }
 119 #endif
 120 }
 121
 122 } // namespace gmx