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,2018,2019, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
38 * \brief Implements functionality for printing information about the
39 * currently running binary
41 * \ingroup module_utility
45 #include "binaryinformation.h"
49 #if GMX_FFT_FFTW3 || GMX_FFT_ARMPL_FFTW3
50 // Needed for construction of the FFT library description string
59 #include <extrae_user_events.h>
74 /* This file is completely threadsafe - keep it that way! */
76 #include "buildinfo.h"
77 #include "gromacs/utility/arraysize.h"
78 #include "gromacs/utility/baseversion.h"
79 #include "gromacs/utility/exceptions.h"
80 #include "gromacs/utility/gmxassert.h"
81 #include "gromacs/utility/path.h"
82 #include "gromacs/utility/programcontext.h"
83 #include "gromacs/utility/stringutil.h"
84 #include "gromacs/utility/sysinfo.h"
85 #include "gromacs/utility/textwriter.h"
87 #include "cuda_version_information.h"
92 using gmx::formatString;
94 //! \cond Doxygen does not need to care about most of this stuff, and the macro usage is painful to document
96 int centeringOffset(int width, int length)
98 return std::max(width - length, 0) / 2;
101 std::string formatCentered(int width, const char *text)
103 const int offset = centeringOffset(width, std::strlen(text));
104 return formatString("%*s%s", offset, "", text);
107 void printCopyright(gmx::TextWriter *writer)
109 static const char * const Contributors[] = {
113 "Herman J.C. Berendsen",
116 "Viacheslav Bolnykh",
124 "Vincent Hindriksen",
127 "Christoph Junghans",
129 "Dimitrios Karkoulis",
150 "Christian Wennberg",
153 static const char * const CopyrightText[] = {
154 "Copyright (c) 1991-2000, University of Groningen, The Netherlands.",
155 "Copyright (c) 2001-2018, The GROMACS development team at",
156 "Uppsala University, Stockholm University and",
157 "the Royal Institute of Technology, Sweden.",
158 "check out http://www.gromacs.org for more information."
161 #define NCONTRIBUTORS static_cast<int>(asize(Contributors))
162 #define NCR static_cast<int>(asize(CopyrightText))
164 // TODO a centering behaviour of TextWriter could be useful here
165 writer->writeLine(formatCentered(78, "GROMACS is written by:"));
166 for (int i = 0; i < NCONTRIBUTORS; )
168 for (int j = 0; j < 4 && i < NCONTRIBUTORS; ++j, ++i)
170 const int width = 18;
171 std::array<char, 30> buf;
172 const int offset = centeringOffset(width, strlen(Contributors[i]));
173 GMX_RELEASE_ASSERT(static_cast<int>(strlen(Contributors[i])) + offset < gmx::ssize(buf),
174 "Formatting buffer is not long enough");
175 std::fill(buf.begin(), buf.begin()+offset, ' ');
176 std::strncpy(buf.data()+offset, Contributors[i], gmx::ssize(buf) - offset);
177 writer->writeString(formatString(" %-*s", width, buf.data()));
179 writer->ensureLineBreak();
181 writer->writeLine(formatCentered(78, "and the project leaders:"));
182 writer->writeLine(formatCentered(78, "Mark Abraham, Berk Hess, Erik Lindahl, and David van der Spoel"));
183 writer->ensureEmptyLine();
184 for (int i = 0; i < NCR; ++i)
186 writer->writeLine(CopyrightText[i]);
188 writer->ensureEmptyLine();
190 // Folding At Home has different licence to allow digital
191 // signatures in GROMACS, so does not need to show the normal
192 // license statement.
195 writer->writeLine("GROMACS is free software; you can redistribute it and/or modify it");
196 writer->writeLine("under the terms of the GNU Lesser General Public License");
197 writer->writeLine("as published by the Free Software Foundation; either version 2.1");
198 writer->writeLine("of the License, or (at your option) any later version.");
202 // Construct a string that describes the library that provides FFT support to this build
203 const char *getFftDescriptionString()
205 // Define the FFT description string
206 #if GMX_FFT_FFTW3 || GMX_FFT_ARMPL_FFTW3
207 # if GMX_NATIVE_WINDOWS
211 // Use the version string provided by libfftw3
215 return fftwf_version;
223 return "fftpack (built-in)";
227 void gmx_print_version_info(gmx::TextWriter *writer)
229 writer->writeLine(formatString("GROMACS version: %s", gmx_version()));
230 const char *const git_hash = gmx_version_git_full_hash();
231 if (git_hash[0] != '\0')
233 writer->writeLine(formatString("GIT SHA1 hash: %s", git_hash));
235 const char *const base_hash = gmx_version_git_central_base_hash();
236 if (base_hash[0] != '\0')
238 writer->writeLine(formatString("Branched from: %s", base_hash));
242 writer->writeLine("Precision: double");
244 writer->writeLine("Precision: single");
246 writer->writeLine(formatString("Memory model: %u bit", static_cast<unsigned>(8*sizeof(void *))));
249 writer->writeLine("MPI library: thread_mpi");
251 writer->writeLine("MPI library: MPI");
253 writer->writeLine("MPI library: none");
256 writer->writeLine(formatString("OpenMP support: enabled (GMX_OPENMP_MAX_THREADS = %d)", GMX_OPENMP_MAX_THREADS));
258 writer->writeLine("OpenMP support: disabled");
260 writer->writeLine(formatString("GPU support: %s", getGpuImplementationString()));
261 writer->writeLine(formatString("SIMD instructions: %s", GMX_SIMD_STRING));
262 writer->writeLine(formatString("FFT library: %s", getFftDescriptionString()));
263 writer->writeLine(formatString("RDTSCP usage: %s", HAVE_RDTSCP ? "enabled" : "disabled"));
265 writer->writeLine("TNG support: enabled");
267 writer->writeLine("TNG support: disabled");
270 writer->writeLine(formatString("Hwloc support: hwloc-%s", HWLOC_VERSION));
272 writer->writeLine("Hwloc support: disabled");
275 unsigned major, minor, revision;
276 Extrae_get_version(&major, &minor, &revision);
277 writer->writeLine(formatString("Tracing support: enabled. Using Extrae-%d.%d.%d", major, minor, revision));
279 writer->writeLine("Tracing support: disabled");
283 /* TODO: The below strings can be quite long, so it would be nice to wrap
284 * them. Can wait for later, as the master branch has ready code to do all
286 writer->writeLine(formatString("C compiler: %s", BUILD_C_COMPILER));
287 writer->writeLine(formatString("C compiler flags: %s", BUILD_CFLAGS));
288 writer->writeLine(formatString("C++ compiler: %s", BUILD_CXX_COMPILER));
289 writer->writeLine(formatString("C++ compiler flags: %s", BUILD_CXXFLAGS));
291 /* MKL might be used for LAPACK/BLAS even if FFTs use FFTW, so keep it separate */
292 writer->writeLine(formatString("Linked with Intel MKL version %d.%d.%d.",
293 __INTEL_MKL__, __INTEL_MKL_MINOR__, __INTEL_MKL_UPDATE__));
295 #if GMX_GPU == GMX_GPU_OPENCL
296 writer->writeLine(formatString("OpenCL include dir: %s", OPENCL_INCLUDE_DIR));
297 writer->writeLine(formatString("OpenCL library: %s", OPENCL_LIBRARY));
298 writer->writeLine(formatString("OpenCL version: %s", OPENCL_VERSION_STRING));
300 #if GMX_GPU == GMX_GPU_CUDA
301 writer->writeLine(formatString("CUDA compiler: %s", CUDA_COMPILER_INFO));
302 writer->writeLine(formatString("CUDA compiler flags:%s", CUDA_COMPILER_FLAGS));
303 writer->writeLine("CUDA driver: " + gmx::getCudaDriverVersionString());
304 writer->writeLine("CUDA runtime: " + gmx::getCudaRuntimeVersionString());
315 BinaryInformationSettings::BinaryInformationSettings()
316 : bExtendedInfo_(false), bCopyright_(false),
318 bGeneratedByHeader_(false), prefix_(""), suffix_("")
322 void printBinaryInformation(FILE *fp,
323 const IProgramContext &programContext)
325 TextWriter writer(fp);
326 printBinaryInformation(&writer, programContext, BinaryInformationSettings());
329 void printBinaryInformation(FILE *fp,
330 const IProgramContext &programContext,
331 const BinaryInformationSettings &settings)
335 TextWriter writer(fp);
336 printBinaryInformation(&writer, programContext, settings);
338 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
341 void printBinaryInformation(TextWriter *writer,
342 const IProgramContext &programContext,
343 const BinaryInformationSettings &settings)
345 // TODO Perhaps the writer could be configured with the prefix and
346 // suffix strings from the settings?
347 const char *prefix = settings.prefix_;
348 const char *suffix = settings.suffix_;
349 const char *precisionString = "";
351 precisionString = " (double precision)";
353 const char *const name = programContext.displayName();
354 if (settings.bGeneratedByHeader_)
356 writer->writeLine(formatString("%sCreated by:%s", prefix, suffix));
358 // TODO: It would be nice to know here whether we are really running a
359 // Gromacs binary or some other binary that is calling Gromacs; we
360 // could then print "%s is part of GROMACS" or some alternative text.
362 = formatString(":-) GROMACS - %s, %s%s (-:", name, gmx_version(), precisionString);
364 = centeringOffset(78 - std::strlen(prefix) - std::strlen(suffix), title.length()) + 1;
365 writer->writeLine(formatString("%s%*c%s%s", prefix, indent, ' ', title.c_str(), suffix));
366 writer->writeLine(formatString("%s%s", prefix, suffix));
367 if (settings.bCopyright_)
369 GMX_RELEASE_ASSERT(prefix[0] == '\0' && suffix[0] == '\0',
370 "Prefix/suffix not supported with copyright");
371 printCopyright(writer);
372 writer->ensureEmptyLine();
373 // This line is printed again after the copyright notice to make it
374 // appear together with all the other information, so that it is not
375 // necessary to read stuff above the copyright notice.
376 // The line above the copyright notice puts the copyright notice is
378 writer->writeLine(formatString("%sGROMACS: %s, version %s%s%s", prefix, name,
379 gmx_version(), precisionString, suffix));
381 const char *const binaryPath = programContext.fullBinaryPath();
382 if (!gmx::isNullOrEmpty(binaryPath))
384 writer->writeLine(formatString("%sExecutable: %s%s", prefix, binaryPath, suffix));
386 const gmx::InstallationPrefixInfo installPrefix = programContext.installationPrefix();
387 if (!gmx::isNullOrEmpty(installPrefix.path))
389 writer->writeLine(formatString("%sData prefix: %s%s%s", prefix, installPrefix.path,
390 installPrefix.bSourceLayout ? " (source tree)" : "", suffix));
392 const std::string workingDir = Path::getWorkingDirectory();
393 if (!workingDir.empty())
395 writer->writeLine(formatString("%sWorking dir: %s%s", prefix, workingDir.c_str(), suffix));
397 if (settings.bProcessId_)
399 writer->writeLine(formatString("%sProcess ID: %d%s", prefix, gmx_getpid(), suffix));
401 const char *const commandLine = programContext.commandLine();
402 if (!gmx::isNullOrEmpty(commandLine))
404 writer->writeLine(formatString("%sCommand line:%s\n%s %s%s",
405 prefix, suffix, prefix, commandLine, suffix));
407 if (settings.bExtendedInfo_)
409 GMX_RELEASE_ASSERT(prefix[0] == '\0' && suffix[0] == '\0',
410 "Prefix/suffix not supported with extended info");
411 writer->ensureEmptyLine();
412 gmx_print_version_info(writer);