2 * This file is part of the GROMACS molecular simulation package.
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.
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 cmdlineinit.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
44 #include "cmdlineinit.h"
50 #include <boost/scoped_ptr.hpp>
52 #include "gromacs/commandline/cmdlinemodulemanager.h"
53 #include "gromacs/commandline/cmdlineoptionsmodule.h"
54 #include "gromacs/commandline/cmdlineprogramcontext.h"
55 #include "gromacs/legacyheaders/network.h"
56 #include "gromacs/legacyheaders/types/commrec.h"
57 #include "gromacs/utility/datafilefinder.h"
58 #include "gromacs/utility/exceptions.h"
59 #include "gromacs/utility/futil.h"
60 #include "gromacs/utility/gmxassert.h"
61 #include "gromacs/utility/init.h"
62 #include "gromacs/utility/programcontext.h"
63 #include "gromacs/utility/smalloc.h"
71 //! \addtogroup module_commandline
74 //! Global context instance initialized in initForCommandLine().
75 boost::scoped_ptr<CommandLineProgramContext> g_commandLineContext;
76 //! Global library data file finder that respects GMXLIB.
77 boost::scoped_ptr<DataFileFinder> g_libFileFinder;
80 void broadcastArguments(const t_commrec *cr, int *argc, char ***argv)
82 gmx_bcast(sizeof(*argc), argc, cr);
88 for (int i = 0; i < *argc; i++)
93 len = std::strlen((*argv)[i])+1;
95 gmx_bcast(sizeof(len), &len, cr);
98 snew((*argv)[i], len);
100 gmx_bcast(len, (*argv)[i], cr);
109 CommandLineProgramContext &initForCommandLine(int *argc, char ***argv)
111 gmx::init(argc, argv);
112 GMX_RELEASE_ASSERT(!g_commandLineContext,
113 "initForCommandLine() calls cannot be nested");
115 // TODO: Rewrite this to not use t_commrec once there is clarity on
116 // the approach for MPI in C++ code.
117 // TODO: Consider whether the argument broadcast would better be done
118 // in CommandLineModuleManager.
120 std::memset(&cr, 0, sizeof(cr));
122 gmx_fill_commrec_from_mpi(&cr);
125 broadcastArguments(&cr, argc, argv);
130 g_commandLineContext.reset(new CommandLineProgramContext(*argc, *argv));
131 setProgramContext(g_commandLineContext.get());
132 g_libFileFinder.reset(new DataFileFinder());
133 g_libFileFinder->setSearchPathFromEnv("GMXLIB");
134 setLibraryFileFinder(g_libFileFinder.get());
136 catch (const std::exception &ex)
138 printFatalErrorMessage(stderr, ex);
139 std::exit(processExceptionAtExit(ex));
141 return *g_commandLineContext;
144 void finalizeForCommandLine()
147 setLibraryFileFinder(NULL);
148 g_libFileFinder.reset();
149 setProgramContext(NULL);
150 g_commandLineContext.reset();
153 int processExceptionAtExitForCommandLine(const std::exception &ex)
155 int rc = processExceptionAtExit(ex); //Currently this aborts for GMX_LIB_MPI
156 finalizeForCommandLine(); //thus this MPI_Finalize doesn't matter
160 int runCommandLineModule(int argc, char *argv[],
161 ICommandLineModule *module)
163 return CommandLineModuleManager::runAsMainSingleModule(argc, argv, module);
166 int runCommandLineModule(int argc, char *argv[],
167 const char *name, const char *description,
168 ICommandLineOptionsModule *(*factory)())
170 return ICommandLineOptionsModule::runAsMain(
171 argc, argv, name, description, factory);
176 int gmx_run_cmain(int argc, char *argv[], int (*mainFunction)(int, char *[]))
178 return gmx::CommandLineModuleManager::runAsMainCMain(argc, argv, mainFunction);