external/bsd/atf/dist/atf-c/signals.h

   1 /*
   2  * Automated Testing Framework (atf)
   3  *
   4  * Copyright (c) 2008 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #if !defined(ATF_C_SIGNALS_H)
  31 #define ATF_C_SIGNALS_H
  32
  33 #include <signal.h>
  34 #include <stdbool.h>
  35
  36 #include <atf-c/error_fwd.h>
  37 #include <atf-c/object.h>
  38
  39 extern const int atf_signals_last_signo;
  40 typedef void (*atf_signal_handler_t)(int);
  41
  42 /* ---------------------------------------------------------------------
  43  * The "atf_signal_programmer" type.
  44  * --------------------------------------------------------------------- */
  45
  46 struct atf_signal_programmer {
  47     atf_object_t m_object;
  48
  49     int m_signo;
  50     atf_signal_handler_t m_handler;
  51     struct sigaction m_oldsa;
  52 };
  53 typedef struct atf_signal_programmer atf_signal_programmer_t;
  54
  55 /* Constructors/destructors. */
  56 atf_error_t atf_signal_programmer_init(atf_signal_programmer_t *, int,
  57                                        atf_signal_handler_t);
  58 void atf_signal_programmer_fini(atf_signal_programmer_t *);
  59
  60 /* ---------------------------------------------------------------------
  61  * The "atf_signal_holder" type.
  62  * --------------------------------------------------------------------- */
  63
  64 struct atf_signal_holder {
  65     atf_object_t m_object;
  66
  67     int m_signo;
  68     atf_signal_programmer_t m_sp;
  69 };
  70 typedef struct atf_signal_holder atf_signal_holder_t;
  71
  72 /* Constructors/destructors. */
  73 atf_error_t atf_signal_holder_init(atf_signal_holder_t *, int);
  74 void atf_signal_holder_fini(atf_signal_holder_t *);
  75
  76 /* Modifiers. */
  77 void atf_signal_holder_process(atf_signal_holder_t *);
  78
  79 /* ---------------------------------------------------------------------
  80  * Free functions.
  81  * --------------------------------------------------------------------- */
  82
  83 void atf_signal_reset(int);
  84
  85 #endif /* ATF_C_SIGNALS_H */