1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
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 * GROningen Mixture of Alchemy and Childrens' Stories
49 #include "gmx_fatal.h"
63 static gmx_bool bDebug
= FALSE
;
64 static char *fatal_tmp_file
= NULL
;
65 static FILE *log_file
= NULL
;
68 static tMPI_Thread_mutex_t debug_mutex
=TMPI_THREAD_MUTEX_INITIALIZER
;
69 static tMPI_Thread_mutex_t where_mutex
=TMPI_THREAD_MUTEX_INITIALIZER
;
70 static tMPI_Thread_mutex_t fatal_tmp_mutex
=TMPI_THREAD_MUTEX_INITIALIZER
;
74 gmx_bool
bDebugMode(void)
77 /*#ifdef GMX_THREADS*/
79 tMPI_Thread_mutex_lock(&debug_mutex
);
82 /*#ifdef GMX_THREADS*/
84 tMPI_Thread_mutex_unlock(&debug_mutex
);
89 void gmx_fatal_set_log_file(FILE *fp
)
94 void _where(const char *file
,int line
)
96 static gmx_bool bFirst
= TRUE
;
97 static int nskip
= -1;
98 static int nwhere
= 0;
104 tMPI_Thread_mutex_lock(&where_mutex
);
105 if (bFirst
) /* we repeat the check in the locked section because things
106 might have changed */
109 if ((temp
=getenv("WHERE")) != NULL
)
110 nskip
= strtol(temp
, NULL
, 10);
114 tMPI_Thread_mutex_unlock(&where_mutex
);
120 /* Skip the first n occasions, this allows to see where it goes wrong */
121 if (nwhere
>= nskip
) {
126 fprintf(fp
,"WHERE %d, file %s - line %d\n",nwhere
,file
,line
);
132 static void bputc(char *msg
,int *len
,char ch
)
137 static void bputs(char *msg
,int *len
,const char *s
,int fld
)
139 for (fld
-=(int)strlen(s
); fld
>0; fld
--)
142 bputc(msg
,len
,*(s
++));
145 static void bputd(char *msg
,int *len
,int d
)
147 if (d
<10) bputc(msg
,len
,d
+'0'); else bputc(msg
,len
,d
-10+'a');
150 static void bputi(char *msg
,int *len
,int val
,int radix
,int fld
,gmx_bool bNeg
)
159 for (fld
--; fld
>fmax
; fld
--)
169 bputi(msg
,len
,val
/radix
,radix
,fld
-1,FALSE
);
170 bputd(msg
,len
,val
%radix
);
174 static int getfld(const char **p
)
179 while (isdigit(**p
)) fld
=(fld
*10)+((*((*p
)++))-'0');
183 /*static void _halt(char *file,int line,char *reason)
185 fprintf(stderr,"\nHALT in file %s line %d because:\n\t%s\n",
191 static int fatal_errno
= 0;
193 static void quit_gmx(const char *msg
)
196 tMPI_Thread_mutex_lock(&debug_mutex
);
198 if (fatal_errno
== 0)
202 fprintf(log_file
,"%s\n",msg
);
204 fprintf(stderr
,"%s\n",msg
);
205 /* we set it to no-zero because if this function is called, something
211 if (fatal_errno
!= -1)
219 if (gmx_parallel_env_initialized())
224 nnodes
= gmx_node_num();
225 noderank
= gmx_node_rank();
228 fprintf(stderr
,"Error on node %d, will try to stop all the nodes\n",
230 gmx_abort(noderank
,nnodes
,-1);
238 fprintf(stderr
,"dump core (y/n):");
240 if (toupper(getc(stdin
))!='N')
247 tMPI_Thread_mutex_unlock(&debug_mutex
);
251 /* The function below should be identical to quit_gmx,
252 * except that is does not actually quit and call gmx_abort.
254 static void quit_gmx_noquit(const char *msg
)
257 tMPI_Thread_mutex_lock(&debug_mutex
);
262 fprintf(log_file
,"%s\n",msg
);
263 fprintf(stderr
,"%s\n",msg
);
264 /* we set it to no-zero because if this function is called, something
270 if (fatal_errno
!= -1)
275 if (!gmx_parallel_env_initialized())
280 fprintf(stderr
,"dump core (y/n):");
282 if (toupper(getc(stdin
))!='N')
288 tMPI_Thread_mutex_unlock(&debug_mutex
);
292 void _set_fatal_tmp_file(const char *fn
, const char *file
, int line
)
295 tMPI_Thread_mutex_lock(&fatal_tmp_mutex
);
297 if (fatal_tmp_file
== NULL
)
298 fatal_tmp_file
= strdup(fn
);
300 fprintf(stderr
,"BUGWARNING: fatal_tmp_file already set at %s:%d",
303 tMPI_Thread_mutex_unlock(&fatal_tmp_mutex
);
307 void _unset_fatal_tmp_file(const char *fn
, const char *file
, int line
)
310 tMPI_Thread_mutex_lock(&fatal_tmp_mutex
);
312 if (strcmp(fn
,fatal_tmp_file
) == 0) {
313 sfree(fatal_tmp_file
);
314 fatal_tmp_file
= NULL
;
316 fprintf(stderr
,"BUGWARNING: file %s not set as fatal_tmp_file at %s:%d",
319 tMPI_Thread_mutex_unlock(&fatal_tmp_mutex
);
323 static void clean_fatal_tmp_file()
326 tMPI_Thread_mutex_lock(&fatal_tmp_mutex
);
328 if (fatal_tmp_file
) {
329 fprintf(stderr
,"Cleaning up temporary file %s\n",fatal_tmp_file
);
330 remove(fatal_tmp_file
);
331 sfree(fatal_tmp_file
);
332 fatal_tmp_file
= NULL
;
335 tMPI_Thread_mutex_unlock(&fatal_tmp_mutex
);
339 static void parse_printf_args(const char *fmt
,va_list *ap
,char *msg
)
344 char ibuf
[64],ifmt
[64];
361 ival
= va_arg(*ap
,int);
362 sprintf(ifmt
,"0x%%%dx",fld
);
363 sprintf(ibuf
,ifmt
,(unsigned int)ival
);
364 for(index
=0; (index
<(int)strlen(ibuf
)); index
++)
365 bputc(msg
,&len
,ibuf
[index
]);
368 ival
= va_arg(*ap
,int);
369 sprintf(ifmt
,"%%%dd",fld
);
370 sprintf(ibuf
,ifmt
,ival
);
371 for(index
=0; (index
<(int)strlen(ibuf
)); index
++)
372 bputc(msg
,&len
,ibuf
[index
]);
375 ival
= va_arg(*ap
,unsigned);
376 sprintf(ifmt
,"%%%du",fld
);
377 sprintf(ibuf
,ifmt
,ival
);
378 for(index
=0; (index
<(int)strlen(ibuf
)); index
++)
379 bputc(msg
,&len
,ibuf
[index
]);
382 dval
= va_arg(*ap
,double);
383 sprintf(ifmt
,"%%%df",fld
);
384 sprintf(ibuf
,ifmt
,dval
);
385 for(index
=0; (index
<(int)strlen(ibuf
)); index
++)
386 bputc(msg
,&len
,ibuf
[index
]);
389 dval
= va_arg(*ap
,double);
390 sprintf(ifmt
,"%%%dg",fld
);
391 sprintf(ibuf
,ifmt
,dval
);
392 for(index
=0; (index
<(int)strlen(ibuf
)); index
++)
393 bputc(msg
,&len
,ibuf
[index
]);
396 cval
= (char) va_arg(*ap
,int); /* char is promoted to int */
397 bputc(msg
,&len
,cval
);
400 sval
= va_arg(*ap
,char *);
402 sval
= strdup("(null)");
403 bputs(msg
,&len
,sval
,fld
);
414 bputc(msg
,&len
,'\0');
417 void gmx_fatal(int f_errno
,const char *file
,int line
,const char *fmt
,...)
424 clean_fatal_tmp_file();
426 parse_printf_args(fmt
,&ap
,msg
);
431 tMPI_Thread_mutex_lock(&debug_mutex
);
434 fatal_errno
= f_errno
;
437 tMPI_Thread_mutex_unlock(&debug_mutex
);
440 _gmx_error("fatal",msg
,file
,line
);
443 void gmx_fatal_collective(int f_errno
,const char *file
,int line
,
444 t_commrec
*cr
,gmx_domdec_t
*dd
,
457 if (gmx_parallel_env_initialized())
459 /* Check if we are calling on all processes in MPI_COMM_WORLD */
462 MPI_Comm_compare(cr
->mpi_comm_mysim
,MPI_COMM_WORLD
,&result
);
466 MPI_Comm_compare(dd
->mpi_comm_all
,MPI_COMM_WORLD
,&result
);
468 /* Any result except MPI_UNEQUAL allows us to call MPI_Finalize */
469 bFinalize
= (result
!= MPI_UNEQUAL
);
473 if ((cr
!= NULL
&& MASTER(cr
) ) ||
474 (dd
!= NULL
&& DDMASTER(dd
)))
478 clean_fatal_tmp_file();
480 parse_printf_args(fmt
,&ap
,msg
);
485 tMPI_Thread_mutex_lock(&debug_mutex
);
488 fatal_errno
= f_errno
;
491 tMPI_Thread_mutex_unlock(&debug_mutex
);
496 /* Use an error handler that does not quit */
497 set_gmx_error_handler(quit_gmx_noquit
);
500 _gmx_error("fatal",msg
,file
,line
);
504 if (gmx_parallel_env_initialized())
508 /* Broadcast the fatal error number possibly modified
509 * on the master process, in case the user would like
510 * to use the return status on a non-master process.
511 * The master process in cr and dd always has global rank 0.
513 MPI_Bcast(&fatal_errno
,sizeof(fatal_errno
),MPI_BYTE
,
516 /* Finalize nicely instead of aborting */
521 /* Let all other processes wait till the master has printed
522 * the error message and issued MPI_Abort.
524 MPI_Barrier(MPI_COMM_WORLD
);
532 void _invalid_case(const char *fn
,int line
)
534 gmx_fatal(FARGS
,"Invalid case in switch statement, file %s, line %d",
538 void _unexpected_eof(const char *fn
,int line
,const char *srcfn
,int srcline
)
540 gmx_fatal(FARGS
,"Unexpected end of file in file %s at line %d\n"
541 "(Source file %s, line %d)",fn
,line
,srcfn
,srcline
);
545 * These files are global variables in the gromacs preprocessor
546 * Every routine in a file that includes gmx_fatal.h can write to these
547 * debug channels. Depending on the debuglevel used
548 * 0 to 3 of these filed are redirected to /dev/null
552 gmx_bool gmx_debug_at
=FALSE
;
554 void init_debug (const int dbglevel
,const char *dbgfile
)
557 tMPI_Thread_mutex_lock(&debug_mutex
);
559 if (!bDebug
) /* another thread hasn't already run this*/
562 debug
=gmx_fio_fopen(dbgfile
,"w+");
568 tMPI_Thread_mutex_unlock(&debug_mutex
);
572 #if (defined __sgi && defined USE_SGI_FPE)
573 static void user_routine(unsigned us
[5], int ii
[2])
575 fprintf(stderr
,"User routine us=(%u,%u,%u,%u,%u) ii=(%d,%d)\n",
576 us
[0],us
[1],us
[2],us
[3],us
[4],ii
[0],ii
[1]);
577 fprintf(stderr
,"Exception encountered! Dumping core\n");
581 static void abort_routine(unsigned int **ii
)
583 fprintf(stderr
,"Abort routine\n");
587 static void handle_signals(int n
)
589 fprintf(stderr
,"Handle signals: n = %d\n",n
);
590 fprintf(stderr
,"Dumping core\n");
594 void doexceptions(void)
598 int hs
[] = { SIGILL
, SIGFPE
, SIGTRAP
, SIGEMT
, SIGSYS
};
600 int onoff
,en_mask
,abort_action
,i
;
603 tMPI_Thread_mutex_lock(&debug_mutex
);
606 en_mask
= _EN_UNDERFL
| _EN_OVERFL
| _EN_DIVZERO
|
607 _EN_INVALID
| _EN_INT_OVERFL
;
608 abort_action
= _ABORT_ON_ERROR
;
609 handle_sigfpes(onoff
,en_mask
,user_routine
,abort_action
,abort_routine
);
611 for(i
=0; (i
<asize(hs
)); i
++)
612 signal(hs
[i
],handle_signals
);
614 tMPI_Thread_mutex_unlock(&debug_mutex
);
617 #endif /* __sgi and FPE */
619 static const char *gmxuser
= "Please report this to the mailing list (gmx-users@gromacs.org)";
621 static void (*gmx_error_handler
)(const char *msg
) = quit_gmx
;
623 void set_gmx_error_handler(void (*func
)(const char *msg
))
626 tMPI_Thread_mutex_lock(&debug_mutex
);
628 gmx_error_handler
= func
;
630 tMPI_Thread_mutex_unlock(&debug_mutex
);
634 char *gmx_strerror(const char *key
)
637 const char *key
,*msg
;
639 error_msg_t msg
[] = {
640 { "bug", "Possible bug" },
641 { "call", "Routine should not have been called" },
642 { "comm", "Communication (parallel processing) problem" },
643 { "fatal", "Fatal error" },
644 { "cmd", "Invalid command line argument" },
645 { "file", "File input/output error" },
646 { "impl", "Implementation restriction" },
647 { "incons", "Software inconsistency error" },
648 { "input", "Input error or input inconsistency" },
649 { "mem", "Memory allocation/freeing error" },
650 { "open", "Can not open file" },
651 { "range", "Range checking error" }
653 #define NMSG asize(msg)
658 return strdup("Empty message");
660 for(i
=0; (i
<NMSG
); i
++)
661 if (strcmp(key
,msg
[i
].key
) == 0)
664 sprintf(buf
,"No error message associated with key %s\n%s",key
,gmxuser
);
668 return strdup(msg
[i
].msg
);
673 void _gmx_error(const char *key
,const char *msg
,const char *file
,int line
)
675 char buf
[10240],tmpbuf
[1024],errerrbuf
[1024];
677 const char *llines
= "-------------------------------------------------------";
680 /* protect the audience from suggestive discussions */
684 sprintf(errerrbuf
,"Empty fatal_error message. %s",gmxuser
);
687 cool_quote(tmpbuf
,1023,&cqnum
);
688 strerr
= gmx_strerror(key
);
689 sprintf(buf
,"\n%s\nProgram %s, %s\n"
690 "Source code file: %s, line: %d\n\n"
691 "%s:\n%s\nFor more information and tips for troubleshooting, please check the GROMACS\n"
692 "website at http://www.gromacs.org/Documentation/Errors\n%s\n\n%s\n",
693 llines
,ShortProgram(),GromacsVersion(),file
,line
,
694 strerr
,msg
? msg
: errerrbuf
,llines
,tmpbuf
);
697 gmx_error_handler(buf
);
700 void _range_check(int n
,int n_min
,int n_max
,const char *warn_str
,
701 const char *var
,const char *file
,int line
)
705 if ((n
< n_min
) || (n
>= n_max
)) {
706 if (warn_str
!= NULL
) {
707 strcpy(buf
,warn_str
);
713 sprintf(buf
+strlen(buf
),"Variable %s has value %d. It should have been "
714 "within [ %d .. %d ]\n",var
,n
,n_min
,n_max
);
716 _gmx_error("range",buf
,file
,line
);
720 void gmx_warning(const char *fmt
,...)
727 parse_printf_args(fmt
,&ap
,msg
);
731 fprintf(stderr
,"\nWARNING: %s\n\n",msg
);