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