include/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * 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
  39 #ifndef _sighandler_h
  40 #define _sighandler_h
  41
  42 #include <signal.h>
  43 #include "visibility.h"
  44 #include "typedefs.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /* NOTE: the terminology is:
  51    incoming signals (provided by the operating system, or transmitted from
  52    other nodes) lead to stop conditions. These stop conditions should be
  53    checked for and acted on by the outer loop of the simulation */
  54
  55 /* the stop conditions. They are explicitly allowed to be compared against
  56    each other. */
  57 typedef enum
  58 {
  59     gmx_stop_cond_none = 0,
  60     gmx_stop_cond_next_ns, /* stop a the next neighbour searching step */
  61     gmx_stop_cond_next,    /* stop a the next step */
  62     gmx_stop_cond_abort    /* stop now. (this should never be seen) */
  63 } gmx_stop_cond_t;
  64
  65 /* Our names for the stop conditions.
  66    These must match the number given in gmx_stop_cond_t.*/
  67 extern const char *gmx_stop_cond_name[];
  68
  69 /* the externally visible functions: */
  70
  71 /* install the signal handlers that can set the stop condition. */
  72 GMX_LIBGMX_EXPORT
  73 void signal_handler_install(void);
  74
  75 /* get the current stop condition */
  76 GMX_LIBGMX_EXPORT
  77 gmx_stop_cond_t gmx_get_stop_condition(void);
  78
  79 /* set the stop condition upon receiving a remote one */
  80 GMX_LIBGMX_EXPORT
  81 void gmx_set_stop_condition(gmx_stop_cond_t recvd_stop_cond);
  82
  83 /* get the signal name that lead to the current stop condition. */
  84 GMX_LIBGMX_EXPORT
  85 const char *gmx_get_signal_name(void);
  86
  87 /* check whether we received a USR1 signal.
  88    The condition is reset once a TRUE value is returned, so this function
  89    only returns TRUE once for a single signal. */
  90 GMX_LIBGMX_EXPORT
  91 gmx_bool gmx_got_usr_signal(void);
  92
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98
  99 #endif  /* _sighandler_h */