src/gromacs/mdlib/sighandler.cpp

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