2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015, 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 * 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
47 #include "cmdlineprogramcontext.h"
57 #include <boost/scoped_ptr.hpp>
59 #include "buildinfo.h"
60 #include "gromacs/utility/exceptions.h"
61 #include "gromacs/utility/gmxassert.h"
62 #include "gromacs/utility/mutex.h"
63 #include "gromacs/utility/path.h"
64 #include "gromacs/utility/stringutil.h"
72 //! \addtogroup module_commandline
76 * Quotes a string if it contains spaces.
78 std::string quoteIfNecessary(const char *str)
80 const bool bSpaces = (std::strchr(str, ' ') != NULL);
83 return formatString("'%s'", str);
89 * Default implementation for IExecutableEnvironment.
91 * Used if IExecutableEnvironment is not explicitly provided when
92 * constructing CommandLineProgramContext.
94 class DefaultExecutableEnvironment : public IExecutableEnvironment
97 //! Allocates a default environment.
98 static ExecutableEnvironmentPointer create()
100 return ExecutableEnvironmentPointer(new DefaultExecutableEnvironment());
103 DefaultExecutableEnvironment()
104 : initialWorkingDirectory_(Path::getWorkingDirectory())
108 virtual std::string getWorkingDirectory() const
110 return initialWorkingDirectory_;
112 virtual std::vector<std::string> getExecutablePaths() const
114 return Path::getExecutablePaths();
118 std::string initialWorkingDirectory_;
122 * Finds the absolute path of the binary from \c argv[0].
124 * \param[in] invokedName \c argv[0] the binary was invoked with.
125 * \param[in] env Executable environment.
126 * \returns The full path of the binary.
128 * If a binary with the given name cannot be located, \p invokedName is
131 std::string findFullBinaryPath(const std::string &invokedName,
132 const IExecutableEnvironment &env)
134 std::string searchName = invokedName;
135 // On Windows & Cygwin we need to add the .exe extension,
136 // or we wont be able to detect that the file exists.
137 #if (defined GMX_NATIVE_WINDOWS || defined GMX_CYGWIN)
138 if (!endsWith(searchName, ".exe"))
140 searchName.append(".exe");
143 if (!Path::containsDirectory(searchName))
145 // No directory in name means it must be in the path - search it!
146 std::vector<std::string> pathEntries = env.getExecutablePaths();
147 std::vector<std::string>::const_iterator i;
148 for (i = pathEntries.begin(); i != pathEntries.end(); ++i)
150 const std::string &dir = i->empty() ? env.getWorkingDirectory() : *i;
151 std::string testPath = Path::join(dir, searchName);
152 if (File::exists(testPath))
158 else if (!Path::isAbsolute(searchName))
160 // Name contains directories, but is not absolute, i.e.,
161 // it is relative to the current directory.
162 std::string cwd = env.getWorkingDirectory();
163 std::string testPath = Path::join(cwd, searchName);
170 * Returns whether given path contains files from `share/top/`.
172 * Only checks for a single file that has an uncommon enough name.
174 bool isAcceptableLibraryPath(const std::string &path)
176 return Path::exists(Path::join(path, "gurgle.dat"));
180 * Returns whether given path prefix contains files from `share/top/`.
182 * \param[in] path Path prefix to check.
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)
191 std::string testPath = Path::join(path, DATA_INSTALL_DIR, "top");
192 if (isAcceptableLibraryPath(testPath))
200 * Returns a fallback installation prefix path.
202 * Checks a few standard locations for the data files before returning a
203 * configure-time hard-coded path. The hard-coded path is preferred if it
204 * actually contains the data files, though.
206 std::string findFallbackInstallationPrefixPath()
208 #ifndef GMX_NATIVE_WINDOWS
209 if (!isAcceptableLibraryPathPrefix(CMAKE_INSTALL_PREFIX))
211 if (isAcceptableLibraryPathPrefix("/usr/local"))
215 if (isAcceptableLibraryPathPrefix("/usr"))
219 if (isAcceptableLibraryPathPrefix("/opt"))
225 return CMAKE_INSTALL_PREFIX;
229 * Generic function to find data files based on path of the binary.
231 * \param[in] binaryPath Absolute path to the binary.
232 * \param[out] bSourceLayout Set to `true` if the binary is run from
233 * the build tree and the original source directory can be found.
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 findInstallationPrefixPath(const std::string &binaryPath,
247 *bSourceLayout = false;
248 // Don't search anything if binary cannot be found.
249 if (Path::exists(binaryPath))
251 // Remove the executable name.
252 std::string searchPath = Path::getParentPath(binaryPath);
253 // If running directly from the build tree, try to use the source
255 #if (defined CMAKE_SOURCE_DIR && defined CMAKE_BINARY_DIR)
256 std::string buildBinPath;
257 #ifdef CMAKE_INTDIR /*In multi-configuration build systems the output subdirectory*/
258 buildBinPath = Path::join(CMAKE_BINARY_DIR, "bin", CMAKE_INTDIR);
260 buildBinPath = Path::join(CMAKE_BINARY_DIR, "bin");
262 if (Path::isEquivalent(searchPath, buildBinPath))
264 std::string testPath = Path::join(CMAKE_SOURCE_DIR, "share/top");
265 if (isAcceptableLibraryPath(testPath))
267 *bSourceLayout = true;
268 return CMAKE_SOURCE_DIR;
273 // Use the executable path to (try to) find the library dir.
274 // TODO: Consider only going up exactly the required number of levels.
275 while (!searchPath.empty())
277 if (isAcceptableLibraryPathPrefix(searchPath))
281 searchPath = Path::getParentPath(searchPath);
285 // End of smart searching. If we didn't find it in our parent tree,
286 // or if the program name wasn't set, return a fallback.
287 return findFallbackInstallationPrefixPath();
294 /********************************************************************
295 * CommandLineProgramContext::Impl
298 class CommandLineProgramContext::Impl
302 Impl(int argc, const char *const argv[],
303 ExecutableEnvironmentPointer env);
306 * Finds the full binary path if it isn't searched yet.
308 * Sets \a fullBinaryPath_ if it isn't set yet.
310 * The \a binaryPathMutex_ should be locked by the caller before
311 * calling this function.
313 void findBinaryPath() const;
315 ExecutableEnvironmentPointer executableEnv_;
316 std::string invokedName_;
317 std::string programName_;
318 std::string displayName_;
319 std::string commandLine_;
320 mutable std::string fullBinaryPath_;
321 mutable std::string installationPrefix_;
322 mutable bool bSourceLayout_;
323 mutable Mutex binaryPathMutex_;
326 CommandLineProgramContext::Impl::Impl()
327 : programName_("GROMACS"), bSourceLayout_(false)
331 CommandLineProgramContext::Impl::Impl(int argc, const char *const argv[],
332 ExecutableEnvironmentPointer env)
333 : executableEnv_(env), bSourceLayout_(false)
335 invokedName_ = (argc != 0 ? argv[0] : "");
336 programName_ = Path::getFilename(invokedName_);
337 programName_ = stripSuffixIfPresent(programName_, ".exe");
339 commandLine_ = quoteIfNecessary(programName_.c_str());
340 for (int i = 1; i < argc; ++i)
342 commandLine_.append(" ");
343 commandLine_.append(quoteIfNecessary(argv[i]));
347 void CommandLineProgramContext::Impl::findBinaryPath() const
349 if (fullBinaryPath_.empty())
351 fullBinaryPath_ = findFullBinaryPath(invokedName_, *executableEnv_);
352 fullBinaryPath_ = Path::normalize(Path::resolveSymlinks(fullBinaryPath_));
353 // TODO: Investigate/Consider using a dladdr()-based solution.
354 // Potentially less portable, but significantly simpler, and also works
355 // with user binaries even if they are located in some arbitrary location,
356 // as long as shared libraries are used.
360 /********************************************************************
361 * CommandLineProgramContext
364 CommandLineProgramContext::CommandLineProgramContext()
369 CommandLineProgramContext::CommandLineProgramContext(const char *binaryName)
370 : impl_(new Impl(1, &binaryName, DefaultExecutableEnvironment::create()))
374 CommandLineProgramContext::CommandLineProgramContext(
375 int argc, const char *const argv[])
376 : impl_(new Impl(argc, argv, DefaultExecutableEnvironment::create()))
380 CommandLineProgramContext::CommandLineProgramContext(
381 int argc, const char *const argv[], ExecutableEnvironmentPointer env)
382 : impl_(new Impl(argc, argv, env))
386 CommandLineProgramContext::~CommandLineProgramContext()
390 void CommandLineProgramContext::setDisplayName(const std::string &name)
392 GMX_RELEASE_ASSERT(impl_->displayName_.empty(),
393 "Can only set display name once");
394 impl_->displayName_ = name;
397 const char *CommandLineProgramContext::programName() const
399 return impl_->programName_.c_str();
402 const char *CommandLineProgramContext::displayName() const
404 return impl_->displayName_.empty()
405 ? impl_->programName_.c_str()
406 : impl_->displayName_.c_str();
409 const char *CommandLineProgramContext::commandLine() const
411 return impl_->commandLine_.c_str();
414 const char *CommandLineProgramContext::fullBinaryPath() const
416 lock_guard<Mutex> lock(impl_->binaryPathMutex_);
417 impl_->findBinaryPath();
418 return impl_->fullBinaryPath_.c_str();
421 InstallationPrefixInfo CommandLineProgramContext::installationPrefix() const
423 lock_guard<Mutex> lock(impl_->binaryPathMutex_);
424 if (impl_->installationPrefix_.empty())
426 impl_->findBinaryPath();
427 impl_->installationPrefix_ =
428 Path::normalize(findInstallationPrefixPath(impl_->fullBinaryPath_,
429 &impl_->bSourceLayout_));
431 return InstallationPrefixInfo(
432 impl_->installationPrefix_.c_str(),
433 impl_->bSourceLayout_);