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