src/gmxlib/sighandler.c

   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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42 #include "typedefs.h"
  43 #include "gmx_fatal.h"
  44 #include "sighandler.h"
  45
  46
  47 const char *gmx_stop_cond_name[] =
  48 {
  49     "None",
  50     "Stop at the next neighbor search step",
  51     "Stop at the next step",
  52     "Abort"
  53 };
  54
  55 /* these do not neccesarily match the stop condition, but are
  56    referred to in the signal handler. */
  57 const char *gmx_signal_name[] =
  58 {
  59     "None",
  60     "INT",
  61     "TERM",
  62     "second INT/TERM",
  63     "remote INT/TERM",
  64     "remote second INT/TERM",
  65     "USR1",
  66     "Abort"
  67 };
  68
  69 static volatile sig_atomic_t stop_condition=gmx_stop_cond_none;
  70 static volatile sig_atomic_t last_signal_name=0;
  71
  72 static volatile sig_atomic_t usr_condition=0;
  73
  74 static void signal_handler(int n)
  75 {
  76     switch (n) {
  77 /* windows doesn't do SIGINT correctly according to ANSI (yes, signals are in
  78    ANSI C89, and windows spawns a thread specifically to run the INT signal
  79    handler), but that doesn't matter for a simple signal handler like this. */
  80         case SIGTERM:
  81         case SIGINT:
  82             /* we explicitly set things up to allow this: */
  83             stop_condition++;
  84             if (n==SIGINT)
  85                 last_signal_name=1;
  86             if (n==SIGTERM)
  87                 last_signal_name=2;
  88             if (stop_condition == gmx_stop_cond_next)
  89                 last_signal_name=3;
  90             if (stop_condition >= gmx_stop_cond_abort)
  91                 abort();
  92             break;
  93 #ifdef HAVE_SIGUSR1
  94         case SIGUSR1:
  95             usr_condition=1;
  96             break;
  97 #endif
  98         default:
  99             break;
 100     }
 101 }
 102
 103 static void gmx_signal(int signum)
 104 {
 105 #ifdef HAVE_SIGACTION
 106     struct sigaction act;
 107     act.sa_handler = signal_handler;
 108     sigemptyset(&act.sa_mask);
 109     act.sa_flags = SA_RESTART;
 110     sigaction(signum,&act,NULL);
 111 #else
 112     signal(signum,signal_handler);
 113 #endif
 114 }
 115
 116 void signal_handler_install(void)
 117 {
 118     if (getenv("GMX_NO_TERM") == NULL)
 119     {
 120         if (debug)
 121         {
 122             fprintf(debug,"Installing signal handler for SIGTERM\n");
 123         }
 124         gmx_signal(SIGTERM);
 125     }
 126     if (getenv("GMX_NO_INT") == NULL)
 127     {
 128         if (debug)
 129         {
 130             fprintf(debug,"Installing signal handler for SIGINT\n");
 131         }
 132         gmx_signal(SIGINT);
 133     }
 134 #ifdef HAVE_SIGUSR1
 135     if (getenv("GMX_NO_USR1") == NULL)
 136     {
 137         if (debug)
 138         {
 139             fprintf(debug,"Installing signal handler for SIGUSR1\n");
 140         }
 141         gmx_signal(SIGUSR1);
 142     }
 143 #endif
 144 }
 145
 146 gmx_stop_cond_t gmx_get_stop_condition(void)
 147 {
 148     return (gmx_stop_cond_t)stop_condition;
 149 }
 150
 151 void gmx_set_stop_condition(gmx_stop_cond_t recvd_stop_cond)
 152 {
 153     if (recvd_stop_cond > stop_condition)
 154     {
 155         stop_condition=recvd_stop_cond;
 156         if (stop_condition == gmx_stop_cond_next_ns)
 157             last_signal_name=4;
 158         if (stop_condition == gmx_stop_cond_next)
 159             last_signal_name=5;
 160     }
 161 }
 162
 163 const char *gmx_get_signal_name(void)
 164 {
 165     return gmx_signal_name[last_signal_name];
 166 }
 167
 168 gmx_bool gmx_got_usr_signal(void)
 169 {
 170 #ifdef HAVE_SIGUSR1
 171     gmx_bool ret=(gmx_bool)usr_condition;
 172     usr_condition=0;
 173     return ret;
 174 #else
 175     return FALSE;
 176 #endif
 177 }
 178
 179