Introduce SimulatorBuilder
[gromacs.git] / src / gromacs / commandline / cmdlineprogramcontext.cpp
blobf6dcffb3afd9ea6da93ba2966ed97926bdd0e3a1
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016,2017,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.
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.
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.
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.
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.
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.
35 /*! \internal \file
36 * \brief
37 * Implements gmx::CommandLineProgramContext.
39 * See \linktodevmanual{relocatable-binaries,developer guide section on
40 * relocatable binaries} for explanation of the searching logic.
42 * \author Teemu Murtola <teemu.murtola@gmail.com>
43 * \ingroup module_commandline
45 #include "gmxpre.h"
47 #include "cmdlineprogramcontext.h"
49 #include "config.h"
51 #include <cstdlib>
52 #include <cstring>
54 #include <string>
55 #include <vector>
57 #include "buildinfo.h"
58 #include "gromacs/utility/exceptions.h"
59 #include "gromacs/utility/gmxassert.h"
60 #include "gromacs/utility/mutex.h"
61 #include "gromacs/utility/path.h"
62 #include "gromacs/utility/stringutil.h"
64 namespace gmx
67 namespace
70 //! \addtogroup module_commandline
71 //! \{
73 /*! \brief
74 * Quotes a string if it contains spaces.
76 std::string quoteIfNecessary(const char *str)
78 const bool bSpaces = (std::strchr(str, ' ') != nullptr);
79 if (bSpaces)
81 return formatString("'%s'", str);
83 return str;
86 /*! \brief
87 * Default implementation for IExecutableEnvironment.
89 * Used if IExecutableEnvironment is not explicitly provided when
90 * constructing CommandLineProgramContext.
92 class DefaultExecutableEnvironment : public IExecutableEnvironment
94 public:
95 //! Allocates a default environment.
96 static ExecutableEnvironmentPointer create()
98 return ExecutableEnvironmentPointer(new DefaultExecutableEnvironment());
101 DefaultExecutableEnvironment()
102 : initialWorkingDirectory_(Path::getWorkingDirectory())
106 std::string getWorkingDirectory() const override
108 return initialWorkingDirectory_;
110 std::vector<std::string> getExecutablePaths() const override
112 return Path::getExecutablePaths();
115 private:
116 std::string initialWorkingDirectory_;
119 /*! \brief
120 * Finds the absolute path of the binary from \c argv[0].
122 * \param[in] invokedName \c argv[0] the binary was invoked with.
123 * \param[in] env Executable environment.
124 * \returns The full path of the binary.
126 * If a binary with the given name cannot be located, \p invokedName is
127 * returned.
129 std::string findFullBinaryPath(const std::string &invokedName,
130 const IExecutableEnvironment &env)
132 std::string searchName = invokedName;
133 // On Windows & Cygwin we need to add the .exe extension,
134 // or we wont be able to detect that the file exists.
135 #if GMX_NATIVE_WINDOWS || GMX_CYGWIN
136 if (!endsWith(searchName, ".exe"))
138 searchName.append(".exe");
140 #endif
141 if (!Path::containsDirectory(searchName))
143 // No directory in name means it must be in the path - search it!
144 std::vector<std::string> pathEntries = env.getExecutablePaths();
145 std::vector<std::string>::const_iterator i;
146 for (i = pathEntries.begin(); i != pathEntries.end(); ++i)
148 const std::string &dir = i->empty() ? env.getWorkingDirectory() : *i;
149 std::string testPath = Path::join(dir, searchName);
150 if (File::exists(testPath, File::returnFalseOnError))
152 return testPath;
156 else if (!Path::isAbsolute(searchName))
158 // Name contains directories, but is not absolute, i.e.,
159 // it is relative to the current directory.
160 std::string cwd = env.getWorkingDirectory();
161 std::string testPath = Path::join(cwd, searchName);
162 return testPath;
164 return searchName;
167 /*! \brief
168 * Returns whether given path contains files from `share/top/`.
170 * Only checks for a single file that has an uncommon enough name.
172 bool isAcceptableLibraryPath(const std::string &path)
174 return Path::exists(Path::join(path, "residuetypes.dat"));
177 /*! \brief
178 * Returns whether given path prefix contains files from `share/top/`.
180 * \param[in] path Path prefix to check.
181 * \returns `true` if \p path contains the data files.
183 * Checks whether \p path could be the installation prefix where `share/top/`
184 * files have been installed: appends the relative installation path of the
185 * data files and calls isAcceptableLibraryPath().
187 bool isAcceptableLibraryPathPrefix(const std::string &path)
189 std::string testPath = Path::join(path, GMX_INSTALL_GMXDATADIR, "top");
190 return isAcceptableLibraryPath(testPath);
193 /*! \brief
194 * Returns a fallback installation prefix path.
196 * Checks a few standard locations for the data files before returning a
197 * configure-time hard-coded path. The hard-coded path is preferred if it
198 * actually contains the data files, though.
200 std::string findFallbackInstallationPrefixPath()
202 #if !GMX_NATIVE_WINDOWS
203 if (!isAcceptableLibraryPathPrefix(CMAKE_INSTALL_PREFIX))
205 if (isAcceptableLibraryPathPrefix("/usr/local"))
207 return "/usr/local";
209 if (isAcceptableLibraryPathPrefix("/usr"))
211 return "/usr";
213 if (isAcceptableLibraryPathPrefix("/opt"))
215 return "/opt";
218 #endif
219 return CMAKE_INSTALL_PREFIX;
222 /*! \brief
223 * Generic function to find data files based on path of the binary.
225 * \param[in] binaryPath Absolute path to the binary.
226 * \param[out] bSourceLayout Set to `true` if the binary is run from
227 * the build tree and the original source directory can be found.
228 * \returns Path to the `share/top/` data files.
230 * The search based on the path only works if the binary is in the same
231 * relative path as the installed \Gromacs binaries. If the binary is
232 * somewhere else, a hard-coded fallback is used. This doesn't work if the
233 * binaries are somewhere else than the path given during configure time...
235 * Extra logic is present to allow running binaries from the build tree such
236 * that they use up-to-date data files from the source tree.
238 std::string findInstallationPrefixPath(const std::string &binaryPath,
239 bool *bSourceLayout)
241 *bSourceLayout = false;
242 // Don't search anything if binary cannot be found.
243 if (Path::exists(binaryPath))
245 // Remove the executable name.
246 std::string searchPath = Path::getParentPath(binaryPath);
247 // If running directly from the build tree, try to use the source
248 // directory.
249 #if (defined CMAKE_SOURCE_DIR && defined CMAKE_BINARY_DIR)
250 std::string buildBinPath;
251 #ifdef CMAKE_INTDIR /*In multi-configuration build systems the output subdirectory*/
252 buildBinPath = Path::join(CMAKE_BINARY_DIR, "bin", CMAKE_INTDIR);
253 #else
254 buildBinPath = Path::join(CMAKE_BINARY_DIR, "bin");
255 #endif
256 if (Path::isEquivalent(searchPath, buildBinPath))
258 std::string testPath = Path::join(CMAKE_SOURCE_DIR, "share/top");
259 if (isAcceptableLibraryPath(testPath))
261 *bSourceLayout = true;
262 return CMAKE_SOURCE_DIR;
265 #endif
267 // Use the executable path to (try to) find the library dir.
268 // TODO: Consider only going up exactly the required number of levels.
269 while (!searchPath.empty())
271 if (isAcceptableLibraryPathPrefix(searchPath))
273 return searchPath;
275 searchPath = Path::getParentPath(searchPath);
279 // End of smart searching. If we didn't find it in our parent tree,
280 // or if the program name wasn't set, return a fallback.
281 return findFallbackInstallationPrefixPath();
284 //! \}
286 } // namespace
288 /********************************************************************
289 * CommandLineProgramContext::Impl
292 class CommandLineProgramContext::Impl
294 public:
295 Impl();
296 Impl(int argc, const char *const argv[],
297 ExecutableEnvironmentPointer env);
299 /*! \brief
300 * Finds the full binary path if it isn't searched yet.
302 * Sets \a fullBinaryPath_ if it isn't set yet.
304 * The \a binaryPathMutex_ should be locked by the caller before
305 * calling this function.
307 void findBinaryPath() const;
309 ExecutableEnvironmentPointer executableEnv_;
310 std::string invokedName_;
311 std::string programName_;
312 std::string displayName_;
313 std::string commandLine_;
314 mutable std::string fullBinaryPath_;
315 mutable std::string installationPrefix_;
316 mutable bool bSourceLayout_;
317 mutable Mutex binaryPathMutex_;
320 CommandLineProgramContext::Impl::Impl()
321 : programName_("GROMACS"), bSourceLayout_(false)
325 CommandLineProgramContext::Impl::Impl(int argc, const char *const argv[],
326 ExecutableEnvironmentPointer env)
327 : executableEnv_(std::move(env)), invokedName_(argc != 0 ? argv[0] : ""), bSourceLayout_(false)
329 programName_ = Path::getFilename(invokedName_);
330 programName_ = stripSuffixIfPresent(programName_, ".exe");
332 commandLine_ = quoteIfNecessary(programName_.c_str());
333 for (int i = 1; i < argc; ++i)
335 commandLine_.append(" ");
336 commandLine_.append(quoteIfNecessary(argv[i]));
340 void CommandLineProgramContext::Impl::findBinaryPath() const
342 if (fullBinaryPath_.empty())
344 fullBinaryPath_ = findFullBinaryPath(invokedName_, *executableEnv_);
345 fullBinaryPath_ = Path::normalize(Path::resolveSymlinks(fullBinaryPath_));
346 // TODO: Investigate/Consider using a dladdr()-based solution.
347 // Potentially less portable, but significantly simpler, and also works
348 // with user binaries even if they are located in some arbitrary location,
349 // as long as shared libraries are used.
353 /********************************************************************
354 * CommandLineProgramContext
357 CommandLineProgramContext::CommandLineProgramContext()
358 : impl_(new Impl)
362 CommandLineProgramContext::CommandLineProgramContext(const char *binaryName)
363 : impl_(new Impl(1, &binaryName, DefaultExecutableEnvironment::create()))
367 CommandLineProgramContext::CommandLineProgramContext(
368 int argc, const char *const argv[])
369 : impl_(new Impl(argc, argv, DefaultExecutableEnvironment::create()))
373 CommandLineProgramContext::CommandLineProgramContext(
374 int argc, const char *const argv[], ExecutableEnvironmentPointer env)
375 : impl_(new Impl(argc, argv, move(env)))
379 CommandLineProgramContext::~CommandLineProgramContext()
383 void CommandLineProgramContext::setDisplayName(const std::string &name)
385 GMX_RELEASE_ASSERT(impl_->displayName_.empty(),
386 "Can only set display name once");
387 impl_->displayName_ = name;
390 const char *CommandLineProgramContext::programName() const
392 return impl_->programName_.c_str();
395 const char *CommandLineProgramContext::displayName() const
397 return impl_->displayName_.empty()
398 ? impl_->programName_.c_str()
399 : impl_->displayName_.c_str();
402 const char *CommandLineProgramContext::commandLine() const
404 return impl_->commandLine_.c_str();
407 const char *CommandLineProgramContext::fullBinaryPath() const
409 lock_guard<Mutex> lock(impl_->binaryPathMutex_);
410 impl_->findBinaryPath();
411 return impl_->fullBinaryPath_.c_str();
414 InstallationPrefixInfo CommandLineProgramContext::installationPrefix() const
416 lock_guard<Mutex> lock(impl_->binaryPathMutex_);
417 if (impl_->installationPrefix_.empty())
419 impl_->findBinaryPath();
420 impl_->installationPrefix_ =
421 Path::normalize(findInstallationPrefixPath(impl_->fullBinaryPath_,
422 &impl_->bSourceLayout_));
424 return InstallationPrefixInfo(
425 impl_->installationPrefix_.c_str(),
426 impl_->bSourceLayout_);
429 } // namespace gmx