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