src/gromacs/commandline/cmdlineinit.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 cmdlineinit.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #include "gromacs/commandline/cmdlineinit.h"
  43
  44 #include <cstring>
  45
  46 #include <boost/scoped_ptr.hpp>
  47
  48 #include "gromacs/legacyheaders/network.h"
  49 #include "gromacs/legacyheaders/smalloc.h"
  50 #include "gromacs/legacyheaders/types/commrec.h"
  51
  52 #include "gromacs/commandline/cmdlinemodulemanager.h"
  53 #include "gromacs/commandline/cmdlineprogramcontext.h"
  54 #include "gromacs/utility/exceptions.h"
  55 #include "gromacs/utility/gmxassert.h"
  56 #include "gromacs/utility/init.h"
  57 #include "gromacs/utility/programcontext.h"
  58
  59 namespace gmx
  60 {
  61
  62 namespace
  63 {
  64
  65 //! \addtogroup module_commandline
  66 //! \{
  67
  68 //! Global context instance initialized in initForCommandLine().
  69 boost::scoped_ptr<CommandLineProgramContext> g_commandLineContext;
  70
  71 #ifdef GMX_LIB_MPI
  72 void broadcastArguments(const t_commrec *cr, int *argc, char ***argv)
  73 {
  74     gmx_bcast(sizeof(*argc), argc, cr);
  75
  76     if (!MASTER(cr))
  77     {
  78         snew(*argv, *argc+1);
  79     }
  80     for (int i = 0; i < *argc; i++)
  81     {
  82         int len;
  83         if (MASTER(cr))
  84         {
  85             len = std::strlen((*argv)[i])+1;
  86         }
  87         gmx_bcast(sizeof(len), &len, cr);
  88         if (!MASTER(cr))
  89         {
  90             snew((*argv)[i], len);
  91         }
  92         gmx_bcast(len, (*argv)[i], cr);
  93     }
  94 }
  95 #endif
  96
  97 //! \}
  98
  99 }   // namespace
 100
 101 CommandLineProgramContext &initForCommandLine(int *argc, char ***argv)
 102 {
 103     gmx::init(argc, argv);
 104     GMX_RELEASE_ASSERT(!g_commandLineContext,
 105                        "initForCommandLine() calls cannot be nested");
 106 #ifdef GMX_LIB_MPI
 107     // TODO: Rewrite this to not use t_commrec once there is clarity on
 108     // the approach for MPI in C++ code.
 109     // TODO: Consider whether the argument broadcast would better be done
 110     // in CommandLineModuleManager.
 111     t_commrec cr;
 112     std::memset(&cr, 0, sizeof(cr));
 113
 114     gmx_fill_commrec_from_mpi(&cr);
 115     if (PAR(&cr))
 116     {
 117         broadcastArguments(&cr, argc, argv);
 118     }
 119 #endif
 120     try
 121     {
 122         g_commandLineContext.reset(new CommandLineProgramContext(*argc, *argv));
 123         setProgramContext(g_commandLineContext.get());
 124     }
 125     catch (const std::exception &ex)
 126     {
 127         printFatalErrorMessage(stderr, ex);
 128         std::exit(processExceptionAtExit(ex));
 129     }
 130     return *g_commandLineContext;
 131 }
 132
 133 void finalizeForCommandLine()
 134 {
 135     gmx::finalize();
 136     setProgramContext(NULL);
 137     g_commandLineContext.reset();
 138 }
 139
 140 int runCommandLineModule(int argc, char *argv[],
 141                          CommandLineModuleInterface *module)
 142 {
 143     return gmx::CommandLineModuleManager::runAsMainSingleModule(argc, argv, module);
 144 }
 145
 146 } // namespace gmx
 147
 148 int gmx_run_cmain(int argc, char *argv[], int (*mainFunction)(int, char *[]))
 149 {
 150     return gmx::CommandLineModuleManager::runAsMainCMain(argc, argv, mainFunction);
 151 }