2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,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.
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.
37 * Implements gmx::CommandLineProgramContext.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
42 #include "cmdlineprogramcontext.h"
54 #include <boost/scoped_ptr.hpp>
56 #include "thread_mpi/mutex.h"
58 #include "gromacs/fileio/path.h"
59 #include "gromacs/utility/exceptions.h"
60 #include "gromacs/utility/file.h"
61 #include "gromacs/utility/gmxassert.h"
62 #include "gromacs/utility/stringutil.h"
70 //! \addtogroup module_commandline
74 * Quotes a string if it contains spaces.
76 std::string quoteIfNecessary(const char *str)
78 const bool bSpaces = (std::strchr(str, ' ') != NULL);
81 return formatString("'%s'", str);
87 * Default implementation for ExecutableEnvironmentInterface.
89 * Used if ExecutableEnvironmentInterface is not explicitly provided when
90 * constructing CommandLineProgramContext.
92 class DefaultExecutableEnvironment : public ExecutableEnvironmentInterface
95 //! Allocates a default environment.
96 static ExecutableEnvironmentPointer create()
98 return ExecutableEnvironmentPointer(new DefaultExecutableEnvironment());
101 DefaultExecutableEnvironment()
102 : initialWorkingDirectory_(Path::getWorkingDirectory())
106 virtual std::string getWorkingDirectory() const
108 return initialWorkingDirectory_;
110 virtual std::vector<std::string> getExecutablePaths() const
112 return Path::getExecutablePaths();
116 std::string initialWorkingDirectory_;
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
129 std::string findFullBinaryPath(const std::string &invokedName,
130 const ExecutableEnvironmentInterface &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 (defined GMX_NATIVE_WINDOWS || defined GMX_CYGWIN)
136 if (!endsWith(searchName, ".exe"))
138 searchName.append(".exe");
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))
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);
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, "gurgle.dat"));
178 * Returns whether given path prefix contains files from `share/top/`.
180 * \param[in] path Path prefix to check.
181 * \param[out] result If return value is `true`, the pointee is set to the
182 * actual data directory. Otherwise, the pointee is not modified.
183 * \returns `true` if \p path contains the data files.
185 * Checks whether \p path could be the installation prefix where `share/top/`
186 * files have been installed: appends the relative installation path of the
187 * data files and calls isAcceptableLibraryPath().
189 bool isAcceptableLibraryPathPrefix(const std::string &path, std::string *result)
191 std::string testPath = Path::join(path, GMXLIB_SEARCH_DIR);
192 if (isAcceptableLibraryPath(testPath))
201 * Returns a fallback data path.
203 * Checks a few standard locations for the data files before returning a
204 * configure-time hard-coded path. The hard-coded path is preferred if it
205 * actually contains the data files, though.
207 std::string findFallbackLibraryDataPath()
209 #ifndef GMX_NATIVE_WINDOWS
210 if (!isAcceptableLibraryPath(GMXLIB_FALLBACK))
212 std::string foundPath;
213 if (isAcceptableLibraryPathPrefix("/usr/local", &foundPath))
217 if (isAcceptableLibraryPathPrefix("/usr", &foundPath))
221 if (isAcceptableLibraryPathPrefix("/opt", &foundPath))
227 return GMXLIB_FALLBACK;
231 * Finds the library data files based on path of the binary.
233 * \param[in] binaryPath Absolute path to the binary.
234 * \returns Path to the `share/top/` data files.
236 * The search based on the path only works if the binary is in the same
237 * relative path as the installed \Gromacs binaries. If the binary is
238 * somewhere else, a hard-coded fallback is used. This doesn't work if the
239 * binaries are somewhere else than the path given during configure time...
241 * Extra logic is present to allow running binaries from the build tree such
242 * that they use up-to-date data files from the source tree.
244 std::string findDefaultLibraryDataPath(const std::string &binaryPath)
246 // If the input path is not absolute, the binary could not be found.
247 // Don't search anything.
248 if (Path::isAbsolute(binaryPath))
250 // Remove the executable name.
251 std::string searchPath = Path::getParentPath(binaryPath);
252 // If running directly from the build tree, try to use the source
254 #if (defined CMAKE_SOURCE_DIR && defined CMAKE_BINARY_DIR)
255 if (Path::startsWith(searchPath, CMAKE_BINARY_DIR))
257 std::string testPath = Path::join(CMAKE_SOURCE_DIR, "share/top");
258 if (isAcceptableLibraryPath(testPath))
265 // Use the executable path to (try to) find the library dir.
266 while (!searchPath.empty())
268 std::string testPath = Path::join(searchPath, GMXLIB_SEARCH_DIR);
269 if (isAcceptableLibraryPath(testPath))
273 searchPath = Path::getParentPath(searchPath);
277 // End of smart searching. If we didn't find it in our parent tree,
278 // or if the program name wasn't set, return a fallback.
279 return findFallbackLibraryDataPath();
286 /********************************************************************
287 * CommandLineProgramContext::Impl
290 class CommandLineProgramContext::Impl
294 Impl(int argc, const char *const argv[],
295 ExecutableEnvironmentPointer env);
298 * Finds the full binary path if it isn't searched yet.
300 * Sets \a fullBinaryPath_ if it isn't set yet.
302 * The \a binaryPathMutex_ should be locked by the caller before
303 * calling this function.
305 void findBinaryPath() const;
307 ExecutableEnvironmentPointer executableEnv_;
308 std::string invokedName_;
309 std::string programName_;
310 std::string displayName_;
311 std::string commandLine_;
312 mutable std::string fullBinaryPath_;
313 mutable std::string defaultLibraryDataPath_;
314 mutable tMPI::mutex binaryPathMutex_;
317 CommandLineProgramContext::Impl::Impl()
318 : programName_("GROMACS")
322 CommandLineProgramContext::Impl::Impl(int argc, const char *const argv[],
323 ExecutableEnvironmentPointer env)
324 : executableEnv_(move(env))
326 invokedName_ = (argc != 0 ? argv[0] : "");
327 programName_ = Path::getFilename(invokedName_);
328 programName_ = stripSuffixIfPresent(programName_, ".exe");
330 commandLine_ = quoteIfNecessary(programName_.c_str());
331 for (int i = 1; i < argc; ++i)
333 commandLine_.append(" ");
334 commandLine_.append(quoteIfNecessary(argv[i]));
338 void CommandLineProgramContext::Impl::findBinaryPath() const
340 if (fullBinaryPath_.empty())
342 fullBinaryPath_ = findFullBinaryPath(invokedName_, *executableEnv_);
343 fullBinaryPath_ = Path::normalize(Path::resolveSymlinks(fullBinaryPath_));
344 // TODO: Investigate/Consider using a dladdr()-based solution.
345 // Potentially less portable, but significantly simpler, and also works
346 // with user binaries even if they are located in some arbitrary location,
347 // as long as shared libraries are used.
351 /********************************************************************
352 * CommandLineProgramContext
355 CommandLineProgramContext::CommandLineProgramContext()
360 CommandLineProgramContext::CommandLineProgramContext(const char *binaryName)
361 : impl_(new Impl(1, &binaryName, DefaultExecutableEnvironment::create()))
365 CommandLineProgramContext::CommandLineProgramContext(
366 int argc, const char *const argv[])
367 : impl_(new Impl(argc, argv, DefaultExecutableEnvironment::create()))
371 CommandLineProgramContext::CommandLineProgramContext(
372 int argc, const char *const argv[], ExecutableEnvironmentPointer env)
373 : impl_(new Impl(argc, argv, move(env)))
377 CommandLineProgramContext::~CommandLineProgramContext()
381 void CommandLineProgramContext::setDisplayName(const std::string &name)
383 GMX_RELEASE_ASSERT(impl_->displayName_.empty(),
384 "Can only set display name once");
385 impl_->displayName_ = name;
388 const char *CommandLineProgramContext::programName() const
390 return impl_->programName_.c_str();
393 const char *CommandLineProgramContext::displayName() const
395 return impl_->displayName_.empty()
396 ? impl_->programName_.c_str()
397 : impl_->displayName_.c_str();
400 const char *CommandLineProgramContext::commandLine() const
402 return impl_->commandLine_.c_str();
405 const char *CommandLineProgramContext::fullBinaryPath() const
407 tMPI::lock_guard<tMPI::mutex> lock(impl_->binaryPathMutex_);
408 impl_->findBinaryPath();
409 return impl_->fullBinaryPath_.c_str();
412 const char *CommandLineProgramContext::defaultLibraryDataPath() const
414 tMPI::lock_guard<tMPI::mutex> lock(impl_->binaryPathMutex_);
415 if (impl_->defaultLibraryDataPath_.empty())
417 impl_->findBinaryPath();
418 impl_->defaultLibraryDataPath_ =
419 Path::normalize(findDefaultLibraryDataPath(impl_->fullBinaryPath_));
421 return impl_->defaultLibraryDataPath_.c_str();