src/gromacs/mdlib/sighandler.h

   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) 2010,2014,2015,2018,2019,2021, 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 #ifndef GMX_MDLIB_SIGHANDLER_H
  38 #define GMX_MDLIB_SIGHANDLER_H
  39
  40 #include "gromacs/utility/basedefinitions.h"
  41
  42 #include <csignal>
  43
  44 /* NOTE: the terminology is:
  45    incoming signals (provided by the operating system, or transmitted from
  46    other nodes) lead to stop conditions. These stop conditions should be
  47    checked for and acted on by the outer loop of the simulation */
  48
  49 /* the stop conditions. They are explicitly allowed to be compared against
  50    each other. */
  51 enum class StopCondition : sig_atomic_t
  52 {
  53     None = 0,
  54     NextNS, /* stop a the next neighbour searching step */
  55     Next,   /* stop a the next step */
  56     Abort,  /* stop now. (this should never be seen) */
  57     Count
  58 };
  59
  60 /* Our names for the stop conditions.
  61    These must match the number given in gmx_stop_cond_t.*/
  62 const char* enumValueToString(StopCondition enumValue);
  63
  64 /* the externally visible functions: */
  65
  66 /* install the signal handlers that can set the stop condition. */
  67 void signal_handler_install();
  68
  69 /* get the current stop condition */
  70 StopCondition gmx_get_stop_condition();
  71
  72 /* set the stop condition upon receiving a remote one */
  73 void gmx_set_stop_condition(StopCondition recvd_stop_cond);
  74
  75 /*!
  76  * \brief Reinitializes the global stop condition.
  77  *
  78  * Resets any stop condition currently stored in global library state as read or
  79  * written with gmx_get_stop_condition() and gmx_set_stop_condition(). Does not
  80  * affect the result of gmx_got_usr_signal() gmx_get_signal_name() for
  81  * previously terminated simulations.
  82  *
  83  * The reset is necessary between simulation segments performed in the same
  84  * process and should be called only while simulation is idle, such as after
  85  * a gmx::Mdrunner has finished its work and simulation results have been processed.
  86  */
  87 void gmx_reset_stop_condition();
  88
  89 /* get the signal name that lead to the current stop condition. */
  90 const char* gmx_get_signal_name();
  91
  92 /* check whether we received a USR1 signal.
  93    The condition is reset once a TRUE value is returned, so this function
  94    only returns TRUE once for a single signal. */
  95 gmx_bool gmx_got_usr_signal();
  96
  97 #endif