include/sighandler.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _sighandler_h
  37 #define _sighandler_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43 #include <signal.h>
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /* NOTE: the terminology is:
  50    incoming signals (provided by the operating system, or transmitted from
  51    other nodes) lead to stop conditions. These stop conditions should be
  52    checked for and acted on by the outer loop of the simulation */
  53
  54 /* the stop conditions. They are explicitly allowed to be compared against
  55    each other. */
  56 typedef enum
  57 {
  58     gmx_stop_cond_none=0,
  59     gmx_stop_cond_next_ns, /* stop a the next neighbour searching step */
  60     gmx_stop_cond_next, /* stop a the next step */
  61     gmx_stop_cond_abort  /* stop now. (this should never be seen) */
  62 } gmx_stop_cond_t;
  63
  64 /* Our names for the stop conditions.
  65    These must match the number given in gmx_stop_cond_t.*/
  66 extern const char *gmx_stop_cond_name[];
  67
  68 /* the externally visible functions: */
  69
  70 /* install the signal handlers that can set the stop condition. */
  71 void signal_handler_install(void);
  72
  73 /* get the current stop condition */
  74 gmx_stop_cond_t gmx_get_stop_condition(void);
  75
  76 /* set the stop condition upon receiving a remote one */
  77 void gmx_set_stop_condition(gmx_stop_cond_t recvd_stop_cond);
  78
  79 /* get the signal name that lead to the current stop condition. */
  80 const char *gmx_get_signal_name(void);
  81
  82 /* check whether we received a USR1 signal.
  83    The condition is reset once a TRUE value is returned, so this function
  84    only returns TRUE once for a single signal. */
  85 bool gmx_got_usr_signal(void);
  86
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92
  93 #endif  /* _sighandler_h */