src/gromacs/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  * Copyright (c) 2012, 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 #ifdef HAVE_CONFIG_H
  38 #include <config.h>
  39 #endif
  40
  41 #include "typedefs.h"
  42 #include "gmx_fatal.h"
  43 #include "sighandler.h"
  44
  45
  46 const char *gmx_stop_cond_name[] =
  47 {
  48     "None",
  49     "Stop at the next neighbor search step",
  50     "Stop at the next step",
  51     "Abort"
  52 };
  53
  54 /* these do not neccesarily match the stop condition, but are
  55    referred to in the signal handler. */
  56 const char *gmx_signal_name[] =
  57 {
  58     "None",
  59     "INT",
  60     "TERM",
  61     "second INT/TERM",
  62     "remote INT/TERM",
  63     "remote second INT/TERM",
  64     "USR1",
  65     "Abort"
  66 };
  67
  68 static volatile sig_atomic_t stop_condition   = gmx_stop_cond_none;
  69 static volatile sig_atomic_t last_signal_name = 0;
  70
  71 static volatile sig_atomic_t usr_condition = 0;
  72
  73 static void signal_handler(int n)
  74 {
  75     switch (n)
  76     {
  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             {
  86                 last_signal_name = 1;
  87             }
  88             if (n == SIGTERM)
  89             {
  90                 last_signal_name = 2;
  91             }
  92             if (stop_condition == gmx_stop_cond_next)
  93             {
  94                 last_signal_name = 3;
  95             }
  96             if (stop_condition >= gmx_stop_cond_abort)
  97             {
  98                 abort();
  99             }
 100             break;
 101 #ifdef HAVE_SIGUSR1
 102         case SIGUSR1:
 103             usr_condition = 1;
 104             break;
 105 #endif
 106         default:
 107             break;
 108     }
 109 }
 110
 111 static void gmx_signal(int signum)
 112 {
 113 #ifdef HAVE_SIGACTION
 114     struct sigaction act;
 115     act.sa_handler = signal_handler;
 116     sigemptyset(&act.sa_mask);
 117     act.sa_flags = SA_RESTART;
 118     sigaction(signum, &act, NULL);
 119 #else
 120     signal(signum, signal_handler);
 121 #endif
 122 }
 123
 124 void signal_handler_install(void)
 125 {
 126     if (getenv("GMX_NO_TERM") == NULL)
 127     {
 128         if (debug)
 129         {
 130             fprintf(debug, "Installing signal handler for SIGTERM\n");
 131         }
 132         gmx_signal(SIGTERM);
 133     }
 134     if (getenv("GMX_NO_INT") == NULL)
 135     {
 136         if (debug)
 137         {
 138             fprintf(debug, "Installing signal handler for SIGINT\n");
 139         }
 140         gmx_signal(SIGINT);
 141     }
 142 #ifdef HAVE_SIGUSR1
 143     if (getenv("GMX_NO_USR1") == NULL)
 144     {
 145         if (debug)
 146         {
 147             fprintf(debug, "Installing signal handler for SIGUSR1\n");
 148         }
 149         gmx_signal(SIGUSR1);
 150     }
 151 #endif
 152 }
 153
 154 gmx_stop_cond_t gmx_get_stop_condition(void)
 155 {
 156     return (gmx_stop_cond_t)stop_condition;
 157 }
 158
 159 void gmx_set_stop_condition(gmx_stop_cond_t recvd_stop_cond)
 160 {
 161     if (recvd_stop_cond > stop_condition)
 162     {
 163         stop_condition = recvd_stop_cond;
 164         if (stop_condition == gmx_stop_cond_next_ns)
 165         {
 166             last_signal_name = 4;
 167         }
 168         if (stop_condition == gmx_stop_cond_next)
 169         {
 170             last_signal_name = 5;
 171         }
 172     }
 173 }
 174
 175 const char *gmx_get_signal_name(void)
 176 {
 177     return gmx_signal_name[last_signal_name];
 178 }
 179
 180 gmx_bool gmx_got_usr_signal(void)
 181 {
 182 #ifdef HAVE_SIGUSR1
 183     gmx_bool ret = (gmx_bool)usr_condition;
 184     usr_condition = 0;
 185     return ret;
 186 #else
 187     return FALSE;
 188 #endif
 189 }