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