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, 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 "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(const int dbglevel, const char *dbgfile);
  81
  82 /** Returns TRUE when the program was started in debug mode */
  83 gmx_bool bDebugMode(void);
  84
  85 /** Implementation for where(). */
  86 void
  87 _where(const char *file, int line);
  88 /** Prints filename and line to stdlog. */
  89 #define where() _where(__FILE__, __LINE__)
  90
  91 /** Sets the log file for printing error messages. */
  92 void
  93 gmx_fatal_set_log_file(FILE *fp);
  94
  95 /*! \brief
  96  * Sets an error handler for gmx_fatal() and other fatal error routines.
  97  *
  98  * The default handler prints the message.
  99  * \Gromacs will terminate the program after the error handler returns.
 100  * To make gmx_fatal_collective() work, the error handler should not terminate
 101  * the program, as it cannot know what is the desired way of termination.
 102  * The string passed to the handler may be a multi-line string.
 103  *
 104  * \see gmx_fatal()
 105  */
 106 void
 107 set_gmx_error_handler(void (*func)(const char *msg));
 108
 109 /*! \brief
 110  * Low-level fatal error reporting routine for collective MPI errors.
 111  *
 112  * This function works as gmx_fatal(), but provides additional control for
 113  * cases where it is known that the same error occurs on multiple MPI ranks.
 114  * The error handler is called only if \p bMaster is `TRUE`, and MPI_Finalize()
 115  * is called instead of MPI_Abort() in MPI-enabled \Gromacs if \p bFinalize is
 116  * `TRUE`.
 117  *
 118  * This is used to implement gmx_fatal_collective() (which cannot be declared
 119  * here, since it would bring with it mdrun-specific dependencies).
 120  */
 121 gmx_noreturn void
 122 gmx_fatal_mpi_va(int fatal_errno, const char *file, int line, gmx_bool bMaster,
 123                  gmx_bool bFinalize, const char *fmt, va_list ap);
 124
 125 /*! \brief
 126  * Fatal error reporting routine for \Gromacs.
 127  *
 128  * This function prints a fatal error message with a header that contains the
 129  * source file and line number of the call, followed by the string specified by
 130  * \p fmt and supplied parameters.
 131  * If \p fatal_errno is 0, only the message and arguments are printed.
 132  * If \p fatal_errno is a legal system errno or -1, a perror()-like message is
 133  * printed after the first message; if fatal_errno is -1, the last system errno
 134  * will be used.
 135  * The format of \p fmt uses printf()-like formatting.
 136  *
 137  * In case all MPI processes want to stop with the same fatal error,
 138  * use gmx_fatal_collective(), declared in network.h,
 139  * to avoid having as many error messages as processes.
 140  *
 141  * The first three parameters can be provided through ::FARGS:
 142  * \code
 143    gmx_fatal(FARGS, fmt, ...);
 144    \endcode
 145  */
 146 gmx_noreturn void
 147 gmx_fatal(int fatal_errno, const char *file, int line, const char *fmt, ...);
 148 /** Helper macro to pass first three parameters to gmx_fatal(). */
 149 #define FARGS 0, __FILE__, __LINE__
 150
 151 /*! \brief
 152  * Returns error message corresponding to a string key.
 153  *
 154  * This maps the strings used by gmx_error() to actual error messages.
 155  * Caller is responsible of freeing the returned string.
 156  */
 157 char *gmx_strerror(const char *key);
 158
 159 /** Implementation for gmx_error(). */
 160 gmx_noreturn void _gmx_error(const char *key, const char *msg, const char *file, int line);
 161 /*! \brief
 162  * Alternative fatal error routine with canned messages.
 163  *
 164  * This works as gmx_fatal(), except that a generic error message is added
 165  * based on a string key, and printf-style formatting is not supported.
 166  * Should not typically be called directly, but through gmx_bug(), gmx_call()
 167  * etc.
 168  */
 169 #define gmx_error(key, msg) _gmx_error(key, msg, __FILE__, __LINE__)
 170
 171 /*! \name Fatal error routines for certain types of errors
 172  *
 173  * These wrap gmx_error() and provide the \p key parameter as one of the
 174  * recognized strings.
 175  */
 176 /*! \{ */
 177 #define gmx_bug(msg)    gmx_error("bug", msg)
 178 #define gmx_call(msg)   gmx_error("call", msg)
 179 #define gmx_comm(msg)   gmx_error("comm", msg)
 180 #define gmx_file(msg)   gmx_error("file", msg)
 181 #define gmx_cmd(msg)    gmx_error("cmd", msg)
 182 #define gmx_impl(msg)   gmx_error("impl", msg)
 183 #define gmx_incons(msg) gmx_error("incons", msg)
 184 #define gmx_input(msg)  gmx_error("input", msg)
 185 #define gmx_mem(msg)    gmx_error("mem", msg)
 186 #define gmx_open(fn)    gmx_error("open", fn)
 187 /*! \} */
 188
 189 /*! \brief
 190  * Implementation for range_check() and range_check_mesg().
 191  *
 192  * \p warn_str can be NULL.
 193  */
 194 void _range_check(int n, int n_min, int n_max, const char *warn_str,
 195                   const char *var,
 196                   const char *file, int line);
 197
 198 /*! \brief
 199  * Checks that a variable is within a range.
 200  *
 201  * If \p n is not in range [n_min, n_max), a fatal error is raised.
 202  * \p n_min is inclusive, but \p n_max is not.
 203  */
 204 #define range_check_mesg(n, n_min, n_max, str) _range_check(n, n_min, n_max, str,#n, __FILE__, __LINE__)
 205
 206 /*! \brief
 207  * Checks that a variable is within a range.
 208  *
 209  * This works as range_check_mesg(), but with a default error message.
 210  */
 211 #define range_check(n, n_min, n_max) _range_check(n, n_min, n_max, NULL,#n, __FILE__, __LINE__)
 212
 213 /*! \brief
 214  * Prints a warning message to stderr.
 215  *
 216  * The format of \p fmt uses printf()-like formatting.
 217  * The message string should NOT start with "WARNING"
 218  * and should NOT end with a newline.
 219  */
 220 void gmx_warning(const char *fmt, ...);
 221
 222 #ifdef __cplusplus
 223 }
 224 #endif
 225
 226 #endif