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