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 #ifndef __has_feature
  57 /** For compatibility with non-clang compilers. */
  58 #define __has_feature(x) 0
  59 #endif
  60
  61 /*! \def GMX_ATTRIBUTE_NORETURN
  62  * \brief
  63  * Indicate that a function is not expected to return.
  64  *
  65  * \todo
  66  * There are functions outside this header that need the same attribute.
  67  * This could be moved to a generic header and made it affect also compiler
  68  * code generation.
  69  */
  70 #ifndef GMX_ATTRIBUTE_NORETURN
  71 #if __has_feature(attribute_analyzer_noreturn)
  72 #define GMX_ATTRIBUTE_NORETURN __attribute__((analyzer_noreturn))
  73 #else
  74 #define GMX_ATTRIBUTE_NORETURN
  75 #endif
  76 #endif
  77
  78 /** Implementation for where(). */
  79 void
  80 _where(const char *file, int line);
  81 /** Prints filename and line to stdlog. */
  82 #define where() _where(__FILE__, __LINE__)
  83
  84 /*! \brief
  85  * Low-level fatal error reporting routine for collective MPI errors.
  86  *
  87  * This function works as gmx_fatal(), but provides additional control for
  88  * cases where it is known that the same error occurs on multiple MPI ranks.
  89  * The error handler is called only if \p bMaster is `TRUE`, and MPI_Finalize()
  90  * is called instead of MPI_Abort() in MPI-enabled \Gromacs if \p bFinalize is
  91  * `TRUE`.
  92  *
  93  * This is used to implement gmx_fatal_collective() (which cannot be declared
  94  * here, since it would bring with it mdrun-specific dependencies).
  95  */
  96 void
  97 gmx_fatal_mpi_va(int fatal_errno, const char *file, int line, gmx_bool bMaster,
  98                  gmx_bool bFinalize, const char *fmt, va_list ap) GMX_ATTRIBUTE_NORETURN;
  99
 100 /*! \brief
 101  * Fatal error reporting routine for \Gromacs.
 102  *
 103  * This function prints a fatal error message with a header that contains the
 104  * source file and line number of the call, followed by the string specified by
 105  * \p fmt and supplied parameters.
 106  * If \p fatal_errno is 0, only the message and arguments are printed.
 107  * If \p fatal_errno is a legal system errno or -1, a perror()-like message is
 108  * printed after the first message; if fatal_errno is -1, the last system errno
 109  * will be used.
 110  * The format of \p fmt uses printf()-like formatting.
 111  *
 112  * In case all MPI processes want to stop with the same fatal error,
 113  * use gmx_fatal_collective(), declared in network.h,
 114  * to avoid having as many error messages as processes.
 115  *
 116  * The first three parameters can be provided through ::FARGS:
 117  * \code
 118    gmx_fatal(FARGS, fmt, ...);
 119    \endcode
 120  */
 121 void
 122 gmx_fatal(int fatal_errno, const char *file, int line, const char *fmt, ...) GMX_ATTRIBUTE_NORETURN;
 123 /** Helper macro to pass first three parameters to gmx_fatal(). */
 124 #define FARGS 0, __FILE__, __LINE__
 125
 126 /** Sets the log file for printing error messages. */
 127 void
 128 gmx_fatal_set_log_file(FILE *fp);
 129
 130 /*! \brief
 131  * Debug log file.
 132  *
 133  * Functions can write to this file for debug info.
 134  * Before writing to it, it should be checked whether the file is not NULL:
 135  * \code
 136    if (debug)
 137    {
 138        fprintf(debug, "%s", "Debug text");
 139    }
 140    \endcode
 141  */
 142 extern FILE    *debug;
 143 /** Whether extra debugging is enabled. */
 144 extern gmx_bool gmx_debug_at;
 145
 146 /** Initializes debugging variables */
 147 void init_debug(const int dbglevel, const char *dbgfile);
 148
 149 /** Returns TRUE when the program was started in debug mode */
 150 gmx_bool bDebugMode(void);
 151
 152 /*! \brief
 153  * Implementation for range_check() and range_check_mesg().
 154  *
 155  * \p warn_str can be NULL.
 156  */
 157 void _range_check(int n, int n_min, int n_max, const char *warn_str,
 158                   const char *var,
 159                   const char *file, int line);
 160
 161 /*! \brief
 162  * Checks that a variable is within a range.
 163  *
 164  * If \p n is not in range [n_min, n_max), a fatal error is raised.
 165  * \p n_min is inclusive, but \p n_max is not.
 166  */
 167 #define range_check_mesg(n, n_min, n_max, str) _range_check(n, n_min, n_max, str,#n, __FILE__, __LINE__)
 168
 169 /*! \brief
 170  * Checks that a variable is within a range.
 171  *
 172  * This works as range_check_mesg(), but with a default error message.
 173  */
 174 #define range_check(n, n_min, n_max) _range_check(n, n_min, n_max, NULL,#n, __FILE__, __LINE__)
 175
 176 /*! \brief
 177  * Returns error message corresponding to a string key.
 178  *
 179  * This maps the strings used by gmx_error() to actual error messages.
 180  * Caller is responsible of freeing the returned string.
 181  */
 182 char *gmx_strerror(const char *key);
 183
 184 /** Implementation for gmx_error(). */
 185 void _gmx_error(const char *key, const char *msg, const char *file, int line) GMX_ATTRIBUTE_NORETURN;
 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_bug(), gmx_call()
 192  * etc.
 193  */
 194 #define gmx_error(key, msg) _gmx_error(key, msg, __FILE__, __LINE__)
 195
 196 /*! \name Fatal error routines for certain types of errors
 197  *
 198  * These wrap gmx_error() and provide the \p key parameter as one of the
 199  * recognized strings.
 200  */
 201 /*! \{ */
 202 #define gmx_bug(msg)    gmx_error("bug", msg)
 203 #define gmx_call(msg)   gmx_error("call", msg)
 204 #define gmx_comm(msg)   gmx_error("comm", msg)
 205 #define gmx_file(msg)   gmx_error("file", msg)
 206 #define gmx_cmd(msg)    gmx_error("cmd", msg)
 207 #define gmx_impl(msg)   gmx_error("impl", msg)
 208 #define gmx_incons(msg) gmx_error("incons", msg)
 209 #define gmx_input(msg)  gmx_error("input", msg)
 210 #define gmx_mem(msg)    gmx_error("mem", msg)
 211 #define gmx_open(fn)    gmx_error("open", fn)
 212 /*! \} */
 213
 214 /*! \brief
 215  * Sets an error handler for gmx_fatal() and other fatal error routines.
 216  *
 217  * The default handler prints the message.
 218  * \Gromacs will terminate the program after the error handler returns.
 219  * To make gmx_fatal_collective() work, the error handler should not terminate
 220  * the program, as it cannot know what is the desired way of termination.
 221  * The string passed to the handler may be a multi-line string.
 222  *
 223  * \see gmx_fatal()
 224  */
 225 void
 226 set_gmx_error_handler(void (*func)(const char *msg));
 227
 228 /*! \brief
 229  * Prints a warning message to stderr.
 230  *
 231  * The format of \p fmt uses printf()-like formatting.
 232  * The message string should NOT start with "WARNING"
 233  * and should NOT end with a newline.
 234  */
 235 void gmx_warning(const char *fmt, ...);
 236
 237 #ifdef __cplusplus
 238 }
 239 #endif
 240
 241 #endif