4 * This source code is part of
8 * GROningen MAchine for Chemical Simulations
11 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
12 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
13 * Copyright (c) 2001-2004, The GROMACS development team,
14 * check out http://www.gromacs.org for more information.
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version 2
19 * of the License, or (at your option) any later version.
21 * If you want to redistribute modifications, please consider that
22 * scientific software is very special. Version control is crucial -
23 * bugs must be traceable. We will be happy to consider code for
24 * inclusion in the official distribution, but derived work must not
25 * be called official GROMACS. Details are found in the README & COPYING
26 * files - if they are missing, get the official version at www.gromacs.org.
28 * To help us fund GROMACS development, we humbly ask that you cite
29 * the papers on the package - you can find them in the top README file.
31 * For more info, check our website at http://www.gromacs.org
34 * Gromacs Runs On Most of All Computer Systems
49 #ifndef __has_feature // Optional.
50 #define __has_feature(x) 0 // Compatibility with non-clang compilers.
53 /** \def GMX_ATTRIBUTE_NORETURN \brief Indicate that a function is not
55 * WARNING: In general this flag should not be used for compiler
56 * optimizations, since set_gmx_error_handler can be set to a
57 * handler which does not quit.
59 #ifndef GMX_ATTRIBUTE_NORETURN
60 #if __has_feature(attribute_analyzer_noreturn)
61 #define GMX_ATTRIBUTE_NORETURN __attribute__((analyzer_noreturn))
63 #define GMX_ATTRIBUTE_NORETURN
68 _where(const char *file,int line);
69 #define where() _where(__FILE__,__LINE__)
70 /* Prints filename and line to stdlog and only on amba memvail */
73 _set_fatal_tmp_file(const char *fn, const char *file, int line);
74 #define set_fatal_tmp_file(fn) _set_fatal_tmp_file(fn,__FILE__,__LINE__)
75 /* set filename to be removed when fatal_error is called */
78 _unset_fatal_tmp_file(const char *fn, const char *file, int line);
79 #define unset_fatal_tmp_file(fn) _unset_fatal_tmp_file(fn,__FILE__,__LINE__)
80 /* unsets filename to be removed */
83 gmx_fatal(int fatal_errno,const char *file,int line,const char *fmt,...) GMX_ATTRIBUTE_NORETURN;
84 #define FARGS 0,__FILE__,__LINE__
86 * Routine gmx_fatal prints
88 * "fatal error file %s line %s \n\t "
90 * followed by the string specified by fmt and supplied parameters. If
91 * errno is 0, only the message and arguments are printed. If errno is
92 * a legal system errno or -1, a perror like message is printed after the
93 * first message, if errno is -1, the last system errno will be used.
94 * The format of fmt is that like printf etc, only %d, %x, %c, %f, %g and %s
95 * are allowed as format specifiers.
98 * call this function using the FARGS macro:
99 * gmx_fatal(FARGS,fmt,...)
103 gmx_fatal_collective(int f_errno,const char *file,int line,
104 t_commrec *cr,gmx_domdec_t *dd,
105 const char *fmt,...) GMX_ATTRIBUTE_NORETURN;
106 /* As gmx_fatal, but only the master process prints the error message.
107 * This should only be called one of the following two situations:
108 * 1) On all nodes in cr->mpi_comm_mysim, with cr!=NULL,dd==NULL.
109 * 2) On all nodes in dd->mpi_comm_all, with cr==NULL,dd!=NULL.
110 * This will call MPI_Finalize instead of MPI_Abort when possible,
111 * This is useful for handling errors in code that is executed identically
116 gmx_fatal_set_log_file(FILE *fp);
117 /* Set the log file for printing error messages */
120 _invalid_case(const char *fn,int line);
121 #define invalid_case() _invalid_case(__FILE__,__LINE__)
122 /* Issue a warning stating 'Invalid case in switch' */
124 void _unexpected_eof(const char *fn,int line,const char *srcfn,int srcline);
125 #define unexpected_eof(fn,line) _unexpected_eof(fn,line,__FILE__,__LINE__)
128 * Functions can write to this file for debug info
129 * Before writing to it, it should be checked whether
130 * the file is not NULL:
131 * if (debug) fprintf(debug,"%s","Hallo");
134 extern gmx_bool gmx_debug_at;
136 void init_debug (const int dbglevel,const char *dbgfile);
138 gmx_bool bDebugMode(void);
139 /* Return TRUE when the program was started in debug mode */
141 #if (defined __sgi && defined USE_SGI_FPE)
142 void doexceptions(void);
143 /* Set exception handlers for debugging */
146 /* warn_str is allowed to be NULL.
148 void _range_check(int n,int n_min,int n_max,const char *warn_str,
150 const char *file,int line);
152 #define range_check_mesg(n,n_min,n_max,str) _range_check(n,n_min,n_max,str,#n,__FILE__,__LINE__)
153 /* Range check will terminate with an error message if not
154 * n E [ n_min, n_max >
155 * That is n_min is inclusive but not n_max.
158 #define range_check(n,n_min,n_max) _range_check(n,n_min,n_max,NULL,#n,__FILE__,__LINE__)
159 /* Range check will terminate with an error message if not
160 * n E [ n_min, n_max >
161 * That is n_min is inclusive but not n_max.
164 char *gmx_strerror(const char *key);
165 /* Return error message corresponding to the key.
166 * Maybe a multi-line message.
167 * The messages are stored in src/gmxlib/fatal.c
170 void _gmx_error(const char *key,const char *msg,const char *file,int line) GMX_ATTRIBUTE_NORETURN;
171 #define gmx_error(key,msg) _gmx_error(key,msg,__FILE__,__LINE__)
172 /* Error msg of type key is generated and the program is
173 * terminated unless and error handle is set (see below)
176 /* Some common error types */
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)
189 set_gmx_error_handler(void (*func)(const char *msg));
190 /* An error function will be called that terminates the program
191 * with a fatal error, unless you override it with another function.
193 * set_gmx_error_handler(my_func);
194 * where my_func is a function that takes a string as an argument.
195 * The string may be a multi-line string.
198 void gmx_warning(const char *fmt,...);
199 /* Print a warning message to stderr.
200 * The format of fmt is that like printf etc, only %d, %x, %c, %f, %g and %s
201 * are allowed as format specifiers.
202 * The message string should NOT start with "WARNING"
203 * and should NOT end with a newline.
210 #endif /* _fatal_h */