2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
7 * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
39 * \brief Implements functionality for printing information about the
40 * currently running binary
42 * \ingroup module_utility
46 #include "binaryinformation.h"
50 #if GMX_FFT_FFTW3 || GMX_FFT_ARMPL_FFTW3
51 // Needed for construction of the FFT library description string
60 # include <extrae_user_events.h>
75 /* This file is completely threadsafe - keep it that way! */
77 #include "buildinfo.h"
78 #include "gromacs/utility/arraysize.h"
79 #include "gromacs/utility/baseversion.h"
80 #include "gromacs/utility/exceptions.h"
81 #include "gromacs/utility/gmxassert.h"
82 #include "gromacs/utility/path.h"
83 #include "gromacs/utility/programcontext.h"
84 #include "gromacs/utility/stringutil.h"
85 #include "gromacs/utility/sysinfo.h"
86 #include "gromacs/utility/textwriter.h"
88 #include "cuda_version_information.h"
93 using gmx::formatString;
95 //! \cond Doxygen does not need to care about most of this stuff, and the macro usage is painful to document
97 int centeringOffset(int width, int length)
99 return std::max(width - length, 0) / 2;
102 std::string formatCentered(int width, const char* text)
104 const int offset = centeringOffset(width, std::strlen(text));
105 return formatString("%*s%s", offset, "", text);
108 void printCopyright(gmx::TextWriter* writer)
110 static const char* const Contributors[] = {
111 "Emile Apol", "Rossen Apostolov", "Paul Bauer", "Herman J.C. Berendsen",
112 "Par Bjelkmar", "Christian Blau", "Viacheslav Bolnykh", "Kevin Boyd",
113 "Aldert van Buuren", "Rudi van Drunen", "Anton Feenstra", "Alan Gray",
114 "Gerrit Groenhof", "Anca Hamuraru", "Vincent Hindriksen", "M. Eric Irrgang",
115 "Aleksei Iupinov", "Christoph Junghans", "Joe Jordan", "Dimitrios Karkoulis",
116 "Peter Kasson", "Jiri Kraus", "Carsten Kutzner", "Per Larsson",
117 "Justin A. Lemkul", "Viveca Lindahl", "Magnus Lundborg", "Erik Marklund",
118 "Pascal Merz", "Pieter Meulenhoff", "Teemu Murtola", "Szilard Pall",
119 "Sander Pronk", "Roland Schulz", "Michael Shirts", "Alexey Shvetsov",
120 "Alfons Sijbers", "Peter Tieleman", "Jon Vincent", "Teemu Virolainen",
121 "Christian Wennberg", "Maarten Wolf", "Artem Zhmurov"
123 static const char* const CopyrightText[] = {
124 "Copyright (c) 1991-2000, University of Groningen, The Netherlands.",
125 "Copyright (c) 2001-2019, The GROMACS development team at",
126 "Uppsala University, Stockholm University and", "the Royal Institute of Technology, Sweden.",
127 "check out http://www.gromacs.org for more information."
130 #define NCONTRIBUTORS static_cast<int>(asize(Contributors))
131 #define NCR static_cast<int>(asize(CopyrightText))
133 // TODO a centering behaviour of TextWriter could be useful here
134 writer->writeLine(formatCentered(78, "GROMACS is written by:"));
135 for (int i = 0; i < NCONTRIBUTORS;)
137 for (int j = 0; j < 4 && i < NCONTRIBUTORS; ++j, ++i)
139 const int width = 18;
140 std::array<char, 30> buf;
141 const int offset = centeringOffset(width, strlen(Contributors[i]));
142 GMX_RELEASE_ASSERT(static_cast<int>(strlen(Contributors[i])) + offset < gmx::ssize(buf),
143 "Formatting buffer is not long enough");
144 std::fill(buf.begin(), buf.begin() + offset, ' ');
145 std::strncpy(buf.data() + offset, Contributors[i], gmx::ssize(buf) - offset);
146 writer->writeString(formatString(" %-*s", width, buf.data()));
148 writer->ensureLineBreak();
150 writer->writeLine(formatCentered(78, "and the project leaders:"));
152 formatCentered(78, "Mark Abraham, Berk Hess, Erik Lindahl, and David van der Spoel"));
153 writer->ensureEmptyLine();
154 for (int i = 0; i < NCR; ++i)
156 writer->writeLine(CopyrightText[i]);
158 writer->ensureEmptyLine();
160 // Folding At Home has different licence to allow digital
161 // signatures in GROMACS, so does not need to show the normal
162 // license statement.
165 writer->writeLine("GROMACS is free software; you can redistribute it and/or modify it");
166 writer->writeLine("under the terms of the GNU Lesser General Public License");
167 writer->writeLine("as published by the Free Software Foundation; either version 2.1");
168 writer->writeLine("of the License, or (at your option) any later version.");
172 // Construct a string that describes the library that provides FFT support to this build
173 const char* getFftDescriptionString()
175 // Define the FFT description string
176 #if GMX_FFT_FFTW3 || GMX_FFT_ARMPL_FFTW3
177 # if GMX_NATIVE_WINDOWS
181 // Use the version string provided by libfftw3
185 return fftwf_version;
193 return "fftpack (built-in)";
197 void gmx_print_version_info(gmx::TextWriter* writer)
199 writer->writeLine(formatString("GROMACS version: %s", gmx_version()));
200 const char* const git_hash = gmx_version_git_full_hash();
201 if (git_hash[0] != '\0')
203 writer->writeLine(formatString("GIT SHA1 hash: %s", git_hash));
205 const char* const base_hash = gmx_version_git_central_base_hash();
206 if (base_hash[0] != '\0')
208 writer->writeLine(formatString("Branched from: %s", base_hash));
210 const char* const releaseSourceChecksum = gmxReleaseSourceChecksum();
211 const char* const currentSourceChecksum = gmxCurrentSourceChecksum();
212 if (releaseSourceChecksum[0] != '\0')
214 if (std::strcmp(releaseSourceChecksum, "NoChecksumFile") == 0)
216 writer->writeLine(formatString(
217 "The source code this program was compiled from has not been verified because "
218 "the reference checksum was missing during compilation. This means you have an "
219 "incomplete GROMACS distribution, please make sure to download an intact "
220 "source distribution and compile that before proceeding."));
221 writer->writeLine(formatString("Computed checksum: %s", currentSourceChecksum));
223 else if (std::strcmp(releaseSourceChecksum, "NoPythonAvailable") == 0)
226 formatString("Build source could not be verified, because the checksum could "
227 "not be computed."));
229 else if (std::strcmp(releaseSourceChecksum, currentSourceChecksum) != 0)
231 writer->writeLine(formatString(
232 "This program has been built from source code that has been altered and does "
233 "not match the code released as part of the official GROMACS version %s. If "
234 "you did not intend to use an altered GROMACS version, make sure to download "
235 "an intact source distribution and compile that before proceeding.",
237 writer->writeLine(formatString(
238 "If you have modified the source code, you are strongly encouraged to set your "
239 "custom version suffix (using -DGMX_VERSION_STRING_OF_FORK) which will can "
240 "help later with scientific reproducibility but also when reporting bugs."));
241 writer->writeLine(formatString("Release checksum: %s", releaseSourceChecksum));
242 writer->writeLine(formatString("Computed checksum: %s", currentSourceChecksum));
246 writer->writeLine(formatString("Verified release checksum is %s", releaseSourceChecksum));
252 writer->writeLine("Precision: double");
254 writer->writeLine("Precision: single");
256 writer->writeLine(formatString("Memory model: %u bit", static_cast<unsigned>(8 * sizeof(void*))));
259 writer->writeLine("MPI library: thread_mpi");
261 writer->writeLine("MPI library: MPI");
263 writer->writeLine("MPI library: none");
266 writer->writeLine(formatString("OpenMP support: enabled (GMX_OPENMP_MAX_THREADS = %d)",
267 GMX_OPENMP_MAX_THREADS));
269 writer->writeLine("OpenMP support: disabled");
271 writer->writeLine(formatString("GPU support: %s", getGpuImplementationString()));
272 writer->writeLine(formatString("SIMD instructions: %s", GMX_SIMD_STRING));
273 writer->writeLine(formatString("FFT library: %s", getFftDescriptionString()));
275 writer->writeLine(formatString("RDTSCP usage: %s", GMX_USE_RDTSCP ? "enabled" : "disabled"));
278 writer->writeLine("TNG support: enabled");
280 writer->writeLine("TNG support: disabled");
283 writer->writeLine(formatString("Hwloc support: hwloc-%s", HWLOC_VERSION));
285 writer->writeLine("Hwloc support: disabled");
288 unsigned major, minor, revision;
289 Extrae_get_version(&major, &minor, &revision);
290 writer->writeLine(formatString("Tracing support: enabled. Using Extrae-%d.%d.%d", major,
293 writer->writeLine("Tracing support: disabled");
297 /* TODO: The below strings can be quite long, so it would be nice to wrap
298 * them. Can wait for later, as the master branch has ready code to do all
300 writer->writeLine(formatString("C compiler: %s", BUILD_C_COMPILER));
301 writer->writeLine(formatString("C compiler flags: %s %s", BUILD_CFLAGS,
302 CMAKE_BUILD_CONFIGURATION_C_FLAGS));
303 writer->writeLine(formatString("C++ compiler: %s", BUILD_CXX_COMPILER));
304 writer->writeLine(formatString("C++ compiler flags: %s %s", BUILD_CXXFLAGS,
305 CMAKE_BUILD_CONFIGURATION_CXX_FLAGS));
307 /* MKL might be used for LAPACK/BLAS even if FFTs use FFTW, so keep it separate */
308 writer->writeLine(formatString("Linked with Intel MKL version %d.%d.%d.", __INTEL_MKL__,
309 __INTEL_MKL_MINOR__, __INTEL_MKL_UPDATE__));
312 writer->writeLine(formatString("OpenCL include dir: %s", OPENCL_INCLUDE_DIR));
313 writer->writeLine(formatString("OpenCL library: %s", OPENCL_LIBRARY));
314 writer->writeLine(formatString("OpenCL version: %s", OPENCL_VERSION_STRING));
317 writer->writeLine(formatString("CUDA compiler: %s", CUDA_COMPILER_INFO));
318 writer->writeLine(formatString("CUDA compiler flags:%s %s", CUDA_COMPILER_FLAGS,
319 CMAKE_BUILD_CONFIGURATION_CXX_FLAGS));
320 writer->writeLine("CUDA driver: " + gmx::getCudaDriverVersionString());
321 writer->writeLine("CUDA runtime: " + gmx::getCudaRuntimeVersionString());
332 BinaryInformationSettings::BinaryInformationSettings() :
333 bExtendedInfo_(false),
336 bGeneratedByHeader_(false),
342 void printBinaryInformation(FILE* fp, const IProgramContext& programContext)
344 TextWriter writer(fp);
345 printBinaryInformation(&writer, programContext, BinaryInformationSettings());
348 void printBinaryInformation(FILE* fp,
349 const IProgramContext& programContext,
350 const BinaryInformationSettings& settings)
354 TextWriter writer(fp);
355 printBinaryInformation(&writer, programContext, settings);
357 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
360 void printBinaryInformation(TextWriter* writer,
361 const IProgramContext& programContext,
362 const BinaryInformationSettings& settings)
364 // TODO Perhaps the writer could be configured with the prefix and
365 // suffix strings from the settings?
366 const char* prefix = settings.prefix_;
367 const char* suffix = settings.suffix_;
368 const char* precisionString = "";
370 precisionString = " (double precision)";
372 const char* const name = programContext.displayName();
373 if (settings.bGeneratedByHeader_)
375 writer->writeLine(formatString("%sCreated by:%s", prefix, suffix));
377 // TODO: It would be nice to know here whether we are really running a
378 // Gromacs binary or some other binary that is calling Gromacs; we
379 // could then print "%s is part of GROMACS" or some alternative text.
380 std::string title = formatString(":-) GROMACS - %s, %s%s (-:", name, gmx_version(), precisionString);
382 centeringOffset(78 - std::strlen(prefix) - std::strlen(suffix), title.length()) + 1;
383 writer->writeLine(formatString("%s%*c%s%s", prefix, indent, ' ', title.c_str(), suffix));
384 writer->writeLine(formatString("%s%s", prefix, suffix));
385 if (settings.bCopyright_)
387 GMX_RELEASE_ASSERT(prefix[0] == '\0' && suffix[0] == '\0',
388 "Prefix/suffix not supported with copyright");
389 printCopyright(writer);
390 writer->ensureEmptyLine();
391 // This line is printed again after the copyright notice to make it
392 // appear together with all the other information, so that it is not
393 // necessary to read stuff above the copyright notice.
394 // The line above the copyright notice puts the copyright notice is
396 writer->writeLine(formatString("%sGROMACS: %s, version %s%s%s", prefix, name,
397 gmx_version(), precisionString, suffix));
399 const char* const binaryPath = programContext.fullBinaryPath();
400 if (!gmx::isNullOrEmpty(binaryPath))
402 writer->writeLine(formatString("%sExecutable: %s%s", prefix, binaryPath, suffix));
404 const gmx::InstallationPrefixInfo installPrefix = programContext.installationPrefix();
405 if (!gmx::isNullOrEmpty(installPrefix.path))
407 writer->writeLine(formatString("%sData prefix: %s%s%s", prefix, installPrefix.path,
408 installPrefix.bSourceLayout ? " (source tree)" : "", suffix));
410 const std::string workingDir = Path::getWorkingDirectory();
411 if (!workingDir.empty())
413 writer->writeLine(formatString("%sWorking dir: %s%s", prefix, workingDir.c_str(), suffix));
415 if (settings.bProcessId_)
417 writer->writeLine(formatString("%sProcess ID: %d%s", prefix, gmx_getpid(), suffix));
419 const char* const commandLine = programContext.commandLine();
420 if (!gmx::isNullOrEmpty(commandLine))
422 writer->writeLine(formatString("%sCommand line:%s\n%s %s%s", prefix, suffix, prefix,
423 commandLine, suffix));
425 if (settings.bExtendedInfo_)
427 GMX_RELEASE_ASSERT(prefix[0] == '\0' && suffix[0] == '\0',
428 "Prefix/suffix not supported with extended info");
429 writer->ensureEmptyLine();
430 gmx_print_version_info(writer);