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