src/gromacs/utility/fatalerror.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2012,2014,2015,2018, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 /*! \file
  38  * \brief
  39  * Declares fatal error handling and debugging routines for C code.
  40  *
  41  * \inpublicapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_FATALERROR_H
  45 #define GMX_UTILITY_FATALERROR_H
  46
  47 #include <stdarg.h>
  48 #include <stdio.h>
  49
  50 #include "gromacs/utility/basedefinitions.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 /*! \brief
  57  * Debug log file.
  58  *
  59  * Functions can write to this file for debug info.
  60  * Before writing to it, it should be checked whether the file is not NULL:
  61  * \code
  62    if (debug)
  63    {
  64        fprintf(debug, "%s", "Debug text");
  65    }
  66    \endcode
  67  */
  68 extern FILE    *debug;
  69 /** Whether extra debugging is enabled. */
  70 extern gmx_bool gmx_debug_at;
  71
  72 /*! \brief
  73  * Initializes debugging variables.
  74  *
  75  * This function is not threadsafe.  It should be called as part of
  76  * initializing \Gromacs, before any other thread accesses the library.
  77  * For command line programs, gmx::CommandLineModuleManager takes care
  78  * of this if the user requests debugging.
  79  */
  80 void gmx_init_debug(int dbglevel, const char *dbgfile);
  81
  82 /** Returns TRUE when the program was started in debug mode */
  83 gmx_bool bDebugMode(void);
  84
  85 /** Sets the log file for printing error messages. */
  86 void
  87 gmx_fatal_set_log_file(FILE *fp);
  88
  89 /** Function pointer type for fatal error handler callback. */
  90 typedef void (*gmx_error_handler_t)(const char *title, const char *msg, const char *file, int line);
  91
  92 /*! \brief
  93  * Sets an error handler for gmx_fatal() and other fatal error routines.
  94  *
  95  * The default handler prints the message.
  96  * \Gromacs will terminate the program after the error handler returns.
  97  * To make gmx_fatal_collective() work, the error handler should not terminate
  98  * the program, as it cannot know what is the desired way of termination.
  99  * The message passed to the handler may be a multi-line string.
 100  *
 101  * \see gmx_fatal()
 102  */
 103 void gmx_set_error_handler(gmx_error_handler_t func);
 104
 105 /** Identifies the state of the program on a fatal error. */
 106 enum ExitType
 107 {
 108     /*! \brief
 109      * Clean exit is possible.
 110      *
 111      * There should be no concurrently executing code that might be accessing
 112      * global objects, and all MPI ranks should reach the same fatal error.
 113      */
 114     ExitType_CleanExit,
 115     /*! \brief
 116      * Program needs to be aborted.
 117      *
 118      * There are no preconditions for this state.
 119      */
 120     ExitType_Abort,
 121     /*! \brief
 122      * Program needs to be aborted, but some other rank is responsible of it.
 123      *
 124      * There should be some other MPI rank that reaches the same fatal error,
 125      * but uses ExitType_Abort.  The other ranks can then use
 126      * ExitType_NonMasterAbort to wait for that one rank to issue the abort.
 127      */
 128     ExitType_NonMasterAbort
 129 };
 130
 131 /*! \brief
 132  * Helper function to terminate the program on a fatal error.
 133  *
 134  * \param[in] exitType  Identifies the state of the program at the time of the
 135  *    call, determining how the program can be terminated.
 136  * \param[in] returnValue  Exit code for the program, for cases where it can be
 137  *    used.
 138  */
 139 [[noreturn]] void gmx_exit_on_fatal_error(enum ExitType exitType, int returnValue);
 140
 141 /*! \brief
 142  * Low-level fatal error reporting routine for collective MPI errors.
 143  *
 144  * This function works as gmx_fatal(), but provides additional control for
 145  * cases where it is known that the same error occurs on multiple MPI ranks.
 146  * The error handler is called only if \p bMaster is `TRUE`, and MPI_Finalize()
 147  * is called instead of MPI_Abort() in MPI-enabled \Gromacs if \p bFinalize is
 148  * `TRUE`.
 149  *
 150  * This is used to implement gmx_fatal_collective() (which cannot be declared
 151  * here, since it would bring with it mdrun-specific dependencies).
 152  */
 153 [[noreturn]] void
 154 gmx_fatal_mpi_va(int fatal_errno, const char *file, int line,
 155                  gmx_bool bMaster, gmx_bool bFinalize,
 156                  const char *fmt, va_list ap);
 157
 158 /*! \brief
 159  * Fatal error reporting routine for \Gromacs.
 160  *
 161  * This function prints a fatal error message with a header that contains the
 162  * source file and line number of the call, followed by the string specified by
 163  * \p fmt and supplied parameters.
 164  * If \p fatal_errno is 0, only the message and arguments are printed.
 165  * If \p fatal_errno is a legal system errno or -1, a perror()-like message is
 166  * printed after the first message; if fatal_errno is -1, the last system errno
 167  * will be used.
 168  * The format of \p fmt uses printf()-like formatting.
 169  *
 170  * In case all MPI processes want to stop with the same fatal error,
 171  * use gmx_fatal_collective(), declared in network.h,
 172  * to avoid having as many error messages as processes.
 173  *
 174  * The first three parameters can be provided through ::FARGS:
 175  * \code
 176    gmx_fatal(FARGS, fmt, ...);
 177    \endcode
 178  */
 179 [[noreturn]] void
 180 gmx_fatal(int fatal_errno, const char *file, int line, const char *fmt, ...);
 181 /** Helper macro to pass first three parameters to gmx_fatal(). */
 182 #define FARGS 0, __FILE__, __LINE__
 183
 184 /** Implementation for gmx_error(). */
 185 [[noreturn]] void _gmx_error(const char *key, const char *msg, const char *file, int line);
 186 /*! \brief
 187  * Alternative fatal error routine with canned messages.
 188  *
 189  * This works as gmx_fatal(), except that a generic error message is added
 190  * based on a string key, and printf-style formatting is not supported.
 191  * Should not typically be called directly, but through gmx_call() etc.
 192  */
 193 #define gmx_error(key, msg) _gmx_error(key, msg, __FILE__, __LINE__)
 194
 195 /*! \name Fatal error routines for certain types of errors
 196  *
 197  * These wrap gmx_error() and provide the \p key parameter as one of the
 198  * recognized strings.
 199  */
 200 /*! \{ */
 201 #define gmx_call(msg)   gmx_error("call", msg)
 202 #define gmx_comm(msg)   gmx_error("comm", msg)
 203 #define gmx_file(msg)   gmx_error("file", msg)
 204 #define gmx_impl(msg)   gmx_error("impl", msg)
 205 #define gmx_incons(msg) gmx_error("incons", msg)
 206 #define gmx_input(msg)  gmx_error("input", msg)
 207 #define gmx_mem(msg)    gmx_error("mem", msg)
 208 #define gmx_open(fn)    gmx_error("open", fn)
 209 /*! \} */
 210
 211 /*! \brief
 212  * Implementation for range_check() and range_check_mesg().
 213  *
 214  * \p warn_str can be NULL.
 215  */
 216 void _range_check(int n, int n_min, int n_max, const char *warn_str,
 217                   const char *var,
 218                   const char *file, int line);
 219
 220 /*! \brief
 221  * Checks that a variable is within a range.
 222  *
 223  * If \p n is not in range [n_min, n_max), a fatal error is raised.
 224  * \p n_min is inclusive, but \p n_max is not.
 225  */
 226 #define range_check_mesg(n, n_min, n_max, str) _range_check(n, n_min, n_max, str,#n, __FILE__, __LINE__)
 227
 228 /*! \brief
 229  * Checks that a variable is within a range.
 230  *
 231  * This works as range_check_mesg(), but with a default error message.
 232  */
 233 #define range_check(n, n_min, n_max) _range_check(n, n_min, n_max, NULL,#n, __FILE__, __LINE__)
 234
 235 /*! \brief
 236  * Prints a warning message to stderr.
 237  *
 238  * The format of \p fmt uses printf()-like formatting.
 239  * The message string should NOT start with "WARNING"
 240  * and should NOT end with a newline.
 241  */
 242 void gmx_warning(const char *fmt, ...);
 243
 244 #ifdef __cplusplus
 245 }
 246 #endif
 247
 248 #endif