src/gromacs/mdrunutility/logging.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal \file
  36  *
  37  * \brief Implements the MD log file handling routines.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_mdrunutility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "logging.h"
  45
  46 #include <memory>
  47
  48 #include "gromacs/fileio/gmxfio.h"
  49 #include "gromacs/utility/binaryinformation.h"
  50 #include "gromacs/utility/cstringutil.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/fatalerror.h"
  53 #include "gromacs/utility/programcontext.h"
  54 #include "gromacs/utility/smalloc.h"
  55
  56 namespace gmx
  57 {
  58
  59 //! Implements aspects of logfile handling common to opening either for writing or appending.
  60 static void prepareLogFile(BinaryInformationSettings settings,
  61                            FILE                     *fplog)
  62 {
  63     GMX_RELEASE_ASSERT(fplog != nullptr, "Log file must be already open");
  64     // TODO This function is writing initial content to the log
  65     // file. Preparing the error output handling should happen at some
  66     // later point, using this log file, but should not be done at the
  67     // same time as writing content. Move this call there.
  68     gmx_fatal_set_log_file(fplog);
  69
  70     try
  71     {
  72         settings
  73             .extendedInfo(true)
  74             .processId(true);
  75         printBinaryInformation(fplog, getProgramContext(), settings);
  76     }
  77     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
  78     fprintf(fplog, "\n");
  79
  80     fflush(fplog);
  81 }
  82
  83 LogFilePtr openLogFile(const char *lognm,
  84                        bool        appendFiles)
  85 {
  86     const char *fileOpeningMode = "w+";
  87     if (appendFiles)
  88     {
  89         fileOpeningMode = GMX_FAHCORE ? "a" : "r+";
  90     }
  91
  92     LogFilePtr logfio(gmx_fio_open(lognm, fileOpeningMode));
  93     if (!logfio)
  94     {
  95         GMX_THROW(FileIOError("Could not open log file" + std::string(lognm)));
  96     }
  97     // If appending, then there is no need to write this header
  98     // information, and we don't want to change the file until the
  99     // checksum has been computed.
 100     if (!appendFiles)
 101     {
 102         FILE *fplog = gmx_fio_getfp(logfio.get());
 103         gmx::BinaryInformationSettings settings;
 104         settings.copyright(true);
 105         prepareLogFile(settings, fplog);
 106     }
 107     return logfio;
 108 }
 109
 110 void prepareLogAppending(FILE *fplog)
 111 {
 112     GMX_RELEASE_ASSERT(fplog != nullptr, "Log file must be already open");
 113     fprintf(fplog,
 114             "\n"
 115             "\n"
 116             "-----------------------------------------------------------\n"
 117             "Restarting from checkpoint, appending to previous log file.\n"
 118             "\n"
 119             );
 120     gmx::BinaryInformationSettings settings;
 121     settings.copyright(false);
 122     prepareLogFile(settings, fplog);
 123 }
 124
 125 void closeLogFile(t_fileio *logfio)
 126 {
 127     if (logfio)
 128     {
 129         gmx_fatal_set_log_file(nullptr);
 130         gmx_fio_close(logfio);
 131     }
 132 }
 133
 134 }    // namespace gmx