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