src/api/cpp/context.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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 /*! \file
  36  * \brief Implementation details of gmxapi::Context
  37  *
  38  * \todo Share mdrun input handling implementation via modernized modular options framework.
  39  * Initial implementation of `launch` relies on borrowed code from the mdrun command
  40  * line input processing.
  41  *
  42  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  43  * \ingroup gmxapi
  44  */
  45
  46 #include "gmxapi/context.h"
  47
  48 #include <cstring>
  49
  50 #include <memory>
  51 #include <utility>
  52 #include <vector>
  53
  54 #include "gromacs/commandline/pargs.h"
  55 #include "gromacs/commandline/filenm.h"
  56 #include "gromacs/commandline/pargs.h"
  57 #include "gromacs/compat/make_unique.h"
  58 #include "gromacs/gmxlib/network.h"
  59 #include "gromacs/mdlib/stophandler.h"
  60 #include "gromacs/mdrun/logging.h"
  61 #include "gromacs/mdrun/multisim.h"
  62 #include "gromacs/mdrun/runner.h"
  63 #include "gromacs/mdrunutility/handlerestart.h"
  64 #include "gromacs/mdtypes/commrec.h"
  65 #include "gromacs/utility/arraysize.h"
  66 #include "gromacs/utility/fatalerror.h"
  67 #include "gromacs/utility/smalloc.h"
  68
  69 #include "gmxapi/exceptions.h"
  70 #include "gmxapi/session.h"
  71 #include "gmxapi/status.h"
  72 #include "gmxapi/version.h"
  73
  74 #include "context-impl.h"
  75 #include "createsession.h"
  76 #include "session-impl.h"
  77 #include "workflow.h"
  78
  79 namespace gmxapi
  80 {
  81
  82 ContextImpl::ContextImpl()
  83 {
  84     GMX_ASSERT(session_.expired(), "This implementation assumes an expired weak_ptr at initialization.");
  85 }
  86
  87 std::shared_ptr<gmxapi::ContextImpl> ContextImpl::create()
  88 {
  89     std::shared_ptr<ContextImpl> impl = std::make_shared<ContextImpl>();
  90     return impl;
  91 }
  92
  93 std::shared_ptr<Session> ContextImpl::launch(const Workflow &work)
  94 {
  95     using namespace gmx;
  96     // Much of this implementation is not easily testable: we need tools to inspect simulation results and to modify
  97     // simulation inputs.
  98
  99     std::shared_ptr<Session> launchedSession = nullptr;
 100
 101     // This implementation can only run one workflow at a time.
 102     // Check whether we are already aware of an active session.
 103     if (session_.expired())
 104     {
 105         // Check workflow spec, build graph for current context, launch and return new session.
 106         // \todo This is specific to the session implementation...
 107         auto        mdNode = work.getNode("MD");
 108         std::string filename {};
 109         if (mdNode != nullptr)
 110         {
 111             filename = mdNode->params();
 112         }
 113
 114         /* As default behavior, automatically extend trajectories from the checkpoint file.
 115          * In the future, our API for objects used to initialize a simulation needs to address the fact that currently a
 116          * microstate requires data from both the TPR and checkpoint file to be fully specified. Put another way,
 117          * current
 118          * GROMACS simulations can take a "configuration" as input that does not constitute a complete microstate in
 119          * terms of hidden degrees of freedom (integrator/thermostat/barostat/PRNG state), but we want a clear notion of
 120          * a microstate for gmxapi interfaces.
 121          */
 122
 123         // Note: these output options normalize the file names, but not their
 124         // paths. gmxapi 0.0.7 changes working directory for each session, so the
 125         // relative paths are appropriate, but a near-future version will avoid
 126         // changing directories once the process starts and manage file paths explicitly.
 127         using gmxapi::c_majorVersion;
 128         using gmxapi::c_minorVersion;
 129         using gmxapi::c_patchVersion;
 130         static_assert(!(c_majorVersion != 0 || c_minorVersion != 0 || c_patchVersion > 7),
 131                       "Developer notice: check assumptions about working directory and relative file paths for this "
 132                       "software version.");
 133
 134         // Set input TPR name
 135         mdArgs_.emplace_back("-s");
 136         mdArgs_.emplace_back(filename);
 137         // Set checkpoint file name
 138         mdArgs_.emplace_back("-cpi");
 139         mdArgs_.emplace_back("state.cpt");
 140
 141         // Create a mock argv. Note that argv[0] is expected to hold the program name.
 142         const int  offset = 1;
 143         const auto argc   = static_cast<size_t>(mdArgs_.size() + offset);
 144         auto       argv   = std::vector<char *>(argc, nullptr);
 145         // argv[0] is ignored, but should be a valid string (e.g. null terminated array of char)
 146         argv[0]  = new char[1];
 147         *argv[0] = '\0';
 148         for (size_t argvIndex = offset; argvIndex < argc; ++argvIndex)
 149         {
 150             const auto &mdArg = mdArgs_[argvIndex - offset];
 151             argv[argvIndex] = new char[mdArg.length() + 1];
 152             strcpy(argv[argvIndex], mdArg.c_str());
 153         }
 154
 155         // pointer-to-t_commrec is the de facto handle type for communications record.
 156         // Complete shared / borrowed ownership requires a reference to this stack variable
 157         // (or pointer-to-pointer-to-t_commrec) since borrowing code may update the pointer.
 158         // \todo Define the ownership and lifetime management semantics for a communication record, handle or value type.
 159
 160         // Note: this communications record initialization acts directly on
 161         // MPI_COMM_WORLD and is incompatible with MPI environment sharing in
 162         // gmxapi through 0.0.7, at least.
 163         options_.cr = init_commrec();
 164
 165         const char *desc[]  = {"gmxapi placeholder text"};
 166         if (options_.updateFromCommandLine(argc, argv.data(), desc) == 0)
 167         {
 168             return nullptr;
 169         }
 170
 171         if (MASTER(options_.cr))
 172         {
 173             options_.logFileGuard = openLogFile(ftp2fn(efLOG,
 174                                                        options_.filenames.size(),
 175                                                        options_.filenames.data()),
 176                                                 options_.mdrunOptions.continuationOptions.appendFiles,
 177                                                 options_.cr->nodeid,
 178                                                 options_.cr->nnodes);
 179         }
 180
 181         auto simulationContext = createSimulationContext(options_.cr);
 182
 183         auto builder = MdrunnerBuilder(compat::not_null<decltype( &simulationContext)>(&simulationContext));
 184         builder.addSimulationMethod(options_.mdrunOptions, options_.pforce);
 185         builder.addDomainDecomposition(options_.domdecOptions);
 186         // \todo pass by value
 187         builder.addNonBonded(options_.nbpu_opt_choices[0]);
 188         // \todo pass by value
 189         builder.addElectrostatics(options_.pme_opt_choices[0], options_.pme_fft_opt_choices[0]);
 190         builder.addNeighborList(options_.nstlist_cmdline);
 191         builder.addReplicaExchange(options_.replExParams);
 192         // \todo take ownership of multisim resources (ms)
 193         builder.addMultiSim(options_.ms);
 194         // \todo Provide parallelism resources through SimulationContext.
 195         // Need to establish run-time values from various inputs to provide a resource handle to Mdrunner
 196         builder.addHardwareOptions(options_.hw_opt);
 197         // \todo File names are parameters that should be managed modularly through further factoring.
 198         builder.addFilenames(options_.filenames);
 199         // Note: The gmx_output_env_t life time is not managed after the call to parse_common_args.
 200         // \todo Implement lifetime management for gmx_output_env_t.
 201         // \todo Output environment should be configured outside of Mdrunner and provided as a resource.
 202         builder.addOutputEnvironment(options_.oenv);
 203         builder.addLogFile(options_.logFileGuard.get());
 204
 205         // Note, creation is not mature enough to be exposed in the external API yet.
 206         launchedSession = createSession(shared_from_this(),
 207                                         std::move(builder),
 208                                         simulationContext,
 209                                         std::move(options_.logFileGuard),
 210                                         options_.ms);
 211
 212         // Clean up argv once builder is no longer in use
 213         for (auto && string : argv)
 214         {
 215             if (string != nullptr)
 216             {
 217                 delete[] string;
 218                 string = nullptr;
 219             }
 220         }
 221
 222     }
 223     else
 224     {
 225         throw gmxapi::ProtocolError("Tried to launch a session while a session is still active.");
 226     }
 227
 228     if (launchedSession != nullptr)
 229     {
 230         // Update weak reference.
 231         session_ = launchedSession;
 232     }
 233     return launchedSession;
 234 }
 235
 236 // As of gmxapi 0.0.3 there is only one Context type
 237 Context::Context() :
 238     Context {ContextImpl::create()}
 239 {
 240     GMX_ASSERT(impl_, "Context requires a non-null implementation member.");
 241 }
 242
 243 std::shared_ptr<Session> Context::launch(const Workflow &work)
 244 {
 245     return impl_->launch(work);
 246 }
 247
 248 Context::Context(std::shared_ptr<ContextImpl> impl) :
 249     impl_ {std::move(impl)}
 250 {
 251     GMX_ASSERT(impl_, "Context requires a non-null implementation member.");
 252 }
 253
 254 void Context::setMDArgs(const MDArgs &mdArgs)
 255 {
 256     impl_->mdArgs_ = mdArgs;
 257 }
 258
 259 Context::~Context() = default;
 260
 261 } // end namespace gmxapi