src/gmxlib/fatal.c

   1 /*
   2  * $Id$
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.1
  11  * Copyright (c) 1991-2001, University of Groningen, The Netherlands
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * If you want to redistribute modifications, please consider that
  18  * scientific software is very special. Version control is crucial -
  19  * bugs must be traceable. We will be happy to consider code for
  20  * inclusion in the official distribution, but derived work must not
  21  * be called official GROMACS. Details are found in the README & COPYING
  22  * files - if they are missing, get the official version at www.gromacs.org.
  23  *
  24  * To help us fund GROMACS development, we humbly ask that you cite
  25  * the papers on the package - you can find them in the top README file.
  26  *
  27  * For more info, check our website at http://www.gromacs.org
  28  *
  29  * And Hey:
  30  * Great Red Owns Many ACres of Sand
  31  */
  32
  33 #include <sysstuff.h>
  34 #include <ctype.h>
  35 #include <errno.h>
  36 #include <stdarg.h>
  37 #include <string.h>
  38 #include "futil.h"
  39 #include "statutil.h"
  40 #include "main.h"
  41 #include "network.h"
  42 #include "fatal.h"
  43 #include "macros.h"
  44 #include "string2.h"
  45 #include "smalloc.h"
  46
  47
  48 static bool bDebug = FALSE;
  49 static char *fatal_tmp_file = NULL;
  50
  51 bool bDebugMode(void)
  52 {
  53   return bDebug;
  54 }
  55
  56 void _where(char *file,int line)
  57 {
  58   static bool bFirst = TRUE;
  59   static int  nskip  = -1;
  60   static int  nwhere =  0;
  61   FILE *fp;
  62   char *temp;
  63
  64   if ( bFirst ) {
  65     if ((temp=getenv("WHERE")) != NULL)
  66       nskip = atoi(temp);
  67     bFirst = FALSE;
  68   }
  69
  70   if (nskip >= 0) {
  71     /* Skip the first n occasions, this allows to see where it goes wrong */
  72     if (nwhere >= nskip) {
  73       if (stdlog)
  74         fp = stdlog;
  75       else
  76         fp = stderr;
  77       fprintf(fp,"WHERE %d, file %s - line %d\n",nwhere,file,line);
  78     }
  79     nwhere++;
  80   }
  81 }
  82
  83 static void bputc(char *msg,int *len,char ch)
  84 {
  85   msg[(*len)++]=ch;
  86 }
  87
  88 static void bputs(char *msg,int *len,char *s,int fld)
  89 {
  90   for (fld-=(int)strlen(s); fld>0; fld--) bputc(msg,len,' ');
  91   while (*s) bputc(msg,len,*(s++));
  92 }
  93
  94 static void bputd(char *msg,int *len,int d)
  95 {
  96   if (d<10) bputc(msg,len,d+'0'); else bputc(msg,len,d-10+'a');
  97 }
  98
  99 static void bputi(char *msg,int *len,int val,int radix,int fld,bool bNeg)
 100 {
 101   int fmax=0;
 102
 103   if (bNeg)
 104     fmax=1;
 105
 106   if (val<radix)
 107     {
 108       for (fld--; fld>fmax; fld--)
 109         bputc(msg,len,' ');
 110       if (bNeg)
 111         bputc(msg,len,'-');
 112       bputd(msg,len,val);
 113     }
 114   else
 115     {
 116       if (bNeg)
 117         bputc(msg,len,'-');
 118       bputi(msg,len,val/radix,radix,fld-1,FALSE);
 119       bputd(msg,len,val%radix);
 120     }
 121 }
 122
 123 static int getfld(char **p)
 124 {
 125   int fld;
 126
 127   fld=0;
 128   while (isdigit(**p)) fld=(fld*10)+((*((*p)++))-'0');
 129   return fld;
 130 }
 131
 132 void _halt(char *file,int line,char *reason)
 133 {
 134   fprintf(stderr,"\nHALT in file %s line %d because:\n\t%s\n",
 135           file,line,reason);
 136   exit(1);
 137 }
 138
 139 void quit_gmx(int fatal_errno,char *msg)
 140 {
 141   if (!fatal_errno) {
 142     if (stdlog)
 143       fprintf(stdlog,"%s\n",msg);
 144     fprintf(stderr,"%s\n",msg);
 145   }
 146   else {
 147     if (fatal_errno != -1)
 148       errno=fatal_errno;
 149     perror(msg);
 150   }
 151
 152 #ifdef USE_MPI
 153   if (gmx_parallel) {
 154     int  nnodes;
 155     int  nodeid;
 156
 157     nnodes = gmx_node_num();
 158     nodeid    = gmx_node_id();
 159
 160     if (nnodes > 1)
 161       fprintf(stderr,"Error on node %d, will try to stop all the nodes\n",nodeid);
 162     gmx_abort(nodeid,nnodes,-1);
 163   }
 164 #else
 165   if (debug)
 166     fflush(debug);
 167   if (bDebug) {
 168     fprintf(stderr,"dump core (y/n):");
 169     fflush(stderr);
 170     if (toupper(getc(stdin))!='N')
 171       (void) abort();
 172   }
 173 #endif
 174   exit(-1);
 175 }
 176
 177 void _set_fatal_tmp_file(char *fn, char *file, int line)
 178 {
 179   if (fatal_tmp_file == NULL)
 180     fatal_tmp_file = strdup(fn);
 181   else
 182     fprintf(stderr,"BUGWARNING: fatal_tmp_file already set at %s:%d",
 183             file,line);
 184 }
 185
 186 void _unset_fatal_tmp_file(char *fn, char *file, int line)
 187 {
 188   if (strcmp(fn,fatal_tmp_file) == 0) {
 189     sfree(fatal_tmp_file);
 190     fatal_tmp_file = NULL;
 191   } else
 192     fprintf(stderr,"BUGWARNING: file %s not set as fatal_tmp_file at %s:%d",
 193             fn,file,line);
 194 }
 195
 196 void fatal_error(int fatal_errno,char *fmt,...)
 197 {
 198   va_list ap;
 199   char    *p,cval,*sval,msg[STRLEN];
 200   char    ibuf[64],ifmt[64];
 201   int     index,ival,fld,len;
 202   double  dval;
 203 #ifdef _SPECIAL_VAR_ARG
 204   int     fatal_errno;
 205   char    *fmt;
 206
 207   va_start(ap,);
 208   fatal_errno=va_arg(ap,int);
 209   fmt=va_arg(ap,char *);
 210 #else
 211   va_start(ap,fmt);
 212 #endif
 213
 214   if (fatal_tmp_file) {
 215     fprintf(stderr,"Cleaning up temporary file %s\n",fatal_tmp_file);
 216     remove(fatal_tmp_file);
 217     sfree(fatal_tmp_file);
 218     fatal_tmp_file = NULL;
 219   }
 220
 221   len=0;
 222   bputs(msg,&len,"Fatal error: ",0);
 223   for (p=fmt; *p; p++) {
 224     if (*p!='%')
 225       bputc(msg,&len,*p);
 226     else {
 227       p++;
 228       fld=getfld(&p);
 229       switch(*p) {
 230       case 'x':
 231         ival=va_arg(ap,int);
 232         sprintf(ifmt,"0x%%%dx",fld);
 233         sprintf(ibuf,ifmt,(unsigned int)ival);
 234         for(index=0; (index<(int)strlen(ibuf)); index++)
 235           bputc(msg,&len,ibuf[index]);
 236         break;
 237       case 'd':
 238         ival=va_arg(ap,int);
 239         sprintf(ifmt,"%%%dd",fld);
 240         sprintf(ibuf,ifmt,ival);
 241         for(index=0; (index<(int)strlen(ibuf)); index++)
 242           bputc(msg,&len,ibuf[index]);
 243         break;
 244       case 'f':
 245         dval=va_arg(ap,double);
 246         sprintf(ifmt,"%%%df",fld);
 247         sprintf(ibuf,ifmt,dval);
 248         for(index=0; (index<(int)strlen(ibuf)); index++)
 249           bputc(msg,&len,ibuf[index]);
 250         break;
 251       case 'c':
 252         cval=(char) va_arg(ap,int); /* char is promoted to int */
 253         bputc(msg,&len,cval);
 254         break;
 255       case 's':
 256         sval=va_arg(ap,char *);
 257         bputs(msg,&len,sval,fld);
 258         break;
 259       default:
 260         break;
 261       }
 262     }
 263   }
 264   va_end(ap);
 265   bputc(msg,&len,'\0');
 266
 267   quit_gmx(fatal_errno,msg);
 268 }
 269
 270 static int  nwarn       = 0;
 271 static int  maxwarn     = 10;
 272 static int  lineno      = 1;
 273 static char filenm[256] = "";
 274 char   warn_buf[1024];
 275
 276 void init_warning(int maxwarning)
 277 {
 278   maxwarn = maxwarning;
 279   nwarn   = 0;
 280 }
 281
 282 void set_warning_line(char *s,int line)
 283 {
 284   strcpy(filenm,s);
 285   lineno = line;
 286 }
 287
 288 int get_warning_line()
 289 {
 290   return lineno;
 291 }
 292
 293 char *get_warning_file()
 294 {
 295   return filenm;
 296 }
 297
 298 void warning(char *s)
 299 {
 300 #define indent 2
 301   char linenobuf[32], *temp, *temp2;
 302   int i;
 303
 304   nwarn++;
 305   if (s == NULL)
 306     s = warn_buf;
 307   if (lineno != -1)
 308     sprintf(linenobuf,"%d",lineno);
 309   else
 310     strcpy(linenobuf,"unknown");
 311   snew(temp,strlen(s)+indent+1);
 312   for(i=0; i<indent; i++)
 313     temp[i] = ' ';
 314   temp[indent] = '\0';
 315   strcat(temp,s);
 316   temp2 = wrap_lines(temp,81-indent,indent);
 317   fprintf(stderr,"WARNING %d [file %s, line %s]:\n%s\n",
 318           nwarn,filenm,linenobuf,temp2);
 319   sfree(temp);
 320   sfree(temp2);
 321   if (nwarn >= maxwarn)
 322     fatal_error(0,"Too many warnings, %s terminated",Program());
 323 }
 324
 325 void print_warn_num(void)
 326 {
 327   if (nwarn > 0)
 328     fprintf(stderr,"There %s %d warning%s\n",
 329             (nwarn==1) ? "was" : "were", nwarn, (nwarn==1) ? "" : "s");
 330 }
 331
 332 void _too_few(char *fn,int line)
 333 {
 334   sprintf(warn_buf,"Too few parameters on line (source file %s, line %d)",
 335           fn,line);
 336   warning(NULL);
 337 }
 338
 339 void _invalid_case(char *fn,int line)
 340 {
 341   fatal_error(0,"Invalid case in switch statement, file %s, line %d",
 342               fn,line);
 343 }
 344
 345 void _unexpected_eof(char *fn,int line,char *srcfn,int srcline)
 346 {
 347   fatal_error(0,"Unexpected end of file in file %s at line %d\n"
 348               "(Source file %s, line %d)",fn,line,srcfn,srcline);
 349 }
 350
 351 /*
 352  * These files are global variables in the gromacs preprocessor
 353  * Every routine in a file that includes fatal.h can write to these
 354  * debug channels. Depending on the debuglevel used
 355  * 0 to 3 of these filed are redirected to /dev/null
 356  *
 357  */
 358 FILE *debug=NULL;
 359
 360 void init_debug (char *dbgfile)
 361 {
 362   no_buffers();
 363   debug=ffopen(dbgfile,"w");
 364   bDebug = TRUE;
 365 }
 366
 367 #if (defined __sgi && defined USE_SGI_FPE)
 368 static void user_routine(unsigned us[5], int ii[2])
 369 {
 370   fprintf(stderr,"User routine us=(%u,%u,%u,%u,%u) ii=(%d,%d)\n",
 371           us[0],us[1],us[2],us[3],us[4],ii[0],ii[1]);
 372   fprintf(stderr,"Exception encountered! Dumping core\n");
 373   abort();
 374 }
 375
 376 static void abort_routine(unsigned int **ii)
 377 {
 378   fprintf(stderr,"Abort routine\n");
 379   abort();
 380 }
 381
 382 static void handle_signals(int n)
 383 {
 384   fprintf(stderr,"Handle signals: n = %d\n",n);
 385   fprintf(stderr,"Dumping core\n");
 386   abort();
 387 }
 388
 389 void doexceptions(void)
 390 {
 391 #include <sigfpe.h>
 392 #include <signal.h>
 393   int hs[] = { SIGILL, SIGFPE, SIGTRAP, SIGEMT, SIGSYS };
 394
 395   int onoff,en_mask,abort_action,i;
 396
 397   onoff   = _DEBUG;
 398   en_mask = _EN_UNDERFL | _EN_OVERFL | _EN_DIVZERO |
 399     _EN_INVALID | _EN_INT_OVERFL;
 400   abort_action = _ABORT_ON_ERROR;
 401   handle_sigfpes(onoff,en_mask,user_routine,abort_action,abort_routine);
 402
 403   for(i=0; (i<asize(hs)); i++)
 404     signal(hs[i],handle_signals);
 405 }
 406 #endif /* __sgi and FPE */
 407
 408
 409
 410