2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2013, 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.
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.
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.
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.
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.
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.
37 * Implements functions from init.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_utility
42 #include "gromacs/utility/init.h"
51 #include "gromacs/utility/gmxmpi.h"
54 #include "gromacs/legacyheaders/network.h"
55 #include "gromacs/legacyheaders/smalloc.h"
56 #include "gromacs/legacyheaders/types/commrec.h"
57 #include "gromacs/utility/programinfo.h"
58 #include "gromacs/utility/gmxassert.h"
66 //! Maintains global counter of attempts to initialize MPI
67 int g_initializationCounter = 0;
75 void broadcastArguments(const t_commrec *cr, int *argc, char ***argv)
77 gmx_bcast(sizeof(*argc), argc, cr);
83 for (int i = 0; i < *argc; i++)
88 len = std::strlen((*argv)[i])+1;
90 gmx_bcast(sizeof(len), &len, cr);
93 snew((*argv)[i], len);
95 gmx_bcast(len, (*argv)[i], cr);
102 ProgramInfo &init(const char *realBinaryName, int *argc, char ***argv)
105 int isInitialized = 0, isFinalized = 0;
106 MPI_Finalized(&isFinalized);
107 GMX_RELEASE_ASSERT(!isFinalized, "Invalid attempt to initialize MPI after finalization");
108 MPI_Initialized(&isInitialized);
111 if (0 == g_initializationCounter)
113 // Some other code has already initialized MPI, so bump the counter so that
114 // we know not to finalize MPI ourselves later.
115 g_initializationCounter++;
121 (void) fah_MPI_Init(argc, argv);
123 (void) MPI_Init(argc, argv);
126 // Bump the counter to record this initialization event
127 g_initializationCounter++;
129 // TODO: Rewrite this to not use t_commrec once there is clarity on
130 // the approach for MPI in C++ code.
131 // TODO: Consider whether the argument broadcast would better be done
132 // in CommandLineModuleManager.
134 std::memset(&cr, 0, sizeof(cr));
136 gmx_fill_commrec_from_mpi(&cr);
139 broadcastArguments(&cr, argc, argv);
142 return ProgramInfo::init(realBinaryName, *argc, *argv);
145 ProgramInfo &init(int *argc, char ***argv)
147 return init(NULL, argc, argv);
153 GMX_RELEASE_ASSERT(0 < g_initializationCounter, "Excess attempt to finalize MPI");
154 // Bump the counter to record this finalization event
155 g_initializationCounter--;
157 if (0 == g_initializationCounter)
159 /* We sync the processes here to try to avoid problems
160 * with buggy MPI implementations that could cause
161 * unfinished processes to terminate.
163 MPI_Barrier(MPI_COMM_WORLD);
165 /* Apparently certain mpich implementations cause problems
166 * with MPI_Finalize. In that case comment out MPI_Finalize.