xref: /freebsd/contrib/kyua/utils/signals/interrupts.hpp (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 // Copyright 2012 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/signals/interrupts.hpp
30 /// Handling of interrupts.
31 
32 #if !defined(UTILS_SIGNALS_INTERRUPTS_HPP)
33 #define UTILS_SIGNALS_INTERRUPTS_HPP
34 
35 #include "utils/signals/interrupts_fwd.hpp"
36 
37 #include <unistd.h>
38 
39 #include "utils/noncopyable.hpp"
40 
41 namespace utils {
42 namespace signals {
43 
44 
45 /// Provides a scope in which interrupts can be detected and handled.
46 ///
47 /// This RAII-modeled object installs signal handler when instantiated and
48 /// removes them upon destruction.  While this object is active, the
49 /// check_interrupt() free function can be used to determine if an interrupt has
50 /// happened.
51 class interrupts_handler : noncopyable {
52     /// Whether the interrupts are still programmed or not.
53     ///
54     /// Used by the destructor to prevent double-unprogramming when unprogram()
55     /// is explicitly called by the user.
56     bool _programmed;
57 
58 public:
59     interrupts_handler(void);
60     ~interrupts_handler(void);
61 
62     void unprogram(void);
63 };
64 
65 
66 /// Disables interrupts while the object is alive.
67 class interrupts_inhibiter : noncopyable {
68 public:
69     interrupts_inhibiter(void);
70     ~interrupts_inhibiter(void);
71 };
72 
73 
74 void check_interrupt(void);
75 
76 void add_pid_to_kill(const pid_t);
77 void remove_pid_to_kill(const pid_t);
78 
79 
80 } // namespace signals
81 } // namespace utils
82 
83 #endif // !defined(UTILS_SIGNALS_INTERRUPTS_HPP)
84