1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
//! An iterator over incoming signals. //! //! This provides a higher abstraction over the signals, providing a structure //! ([`Signals`](struct.Signals.html)) able to iterate over the incoming signals. //! //! In the future, there will be support for asynchronous frameworks (`mio`, `futures`). //! Depending on the features the crate is compiled with, integration with `mio` and `futures` is //! provided. For now it is mostly usable when there's a dedicated signal handling thread. //! //! # Examples //! //! ```rust //! extern crate libc; //! extern crate signal_hook; //! //! use std::io::Error; //! use std::thread; //! //! use signal_hook::iterator::Signals; //! //! fn main() -> Result<(), Error> { //! let signals = Signals::new(&[ //! libc::SIGHUP, //! libc::SIGTERM, //! libc::SIGINT, //! libc::SIGQUIT, //! # libc::SIGUSR1, //! ])?; //! # // A trick to terminate the example when run as doc-test. Not part of the real code. //! # unsafe { libc::kill(libc::getpid(), libc::SIGUSR1) }; //! loop { //! // Pick up signals that arrived since last time //! for signal in signals.pending() { //! match signal as libc::c_int { //! libc::SIGHUP => { //! // Reload configuration //! // Reopen the log file //! } //! libc::SIGTERM | libc::SIGINT | libc::SIGQUIT => break, //! libc::SIGUSR1 => return Ok(()), //! _ => unreachable!(), //! } //! } //! // Do some bit of work ‒ something with upper limit on waiting, so we don't block //! // forever with a SIGTERM already waiting. //! } //! println!("Terminating. Bye bye"); //! Ok(()) //! } //! ``` use std::borrow::Borrow; use std::collections::hash_map::{HashMap, Iter}; use std::io::Error; use std::os::unix::io::AsRawFd; use std::os::unix::net::UnixStream; use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; use libc::{self, c_int}; use pipe; use SigId; #[derive(Debug)] struct Waker { pending: HashMap<c_int, AtomicBool>, read: UnixStream, write: UnixStream, } /// The main structure of the module, representing interest in some signals. /// /// Unlike the helpers in other modules, this registers the signals when created and unregisters /// them on drop. It provides the pending signals during its lifetime, either in batches or as an /// infinite iterator. /// /// # Multiple consumers /// /// You may have noticed this structure can be used simultaneously by multiple threads. If it is /// done, a signal arrives to one of the threads (on the first come, first serve basis). The signal /// is *not* broadcasted to all currently active threads. /// /// # Examples /// /// ```rust /// # extern crate libc; /// # extern crate signal_hook; /// # /// # use std::io::Error; /// # use std::thread; /// # /// # fn main() -> Result<(), Error> { /// let signals = signal_hook::iterator::Signals::new(&[libc::SIGUSR1, libc::SIGUSR2])?; /// thread::spawn(move || { /// for signal in &signals { /// match signal { /// libc::SIGUSR1 => {}, /// libc::SIGUSR2 => {}, /// _ => unreachable!(), /// } /// } /// }); /// # Ok(()) /// # } #[derive(Clone, Debug)] pub struct Signals { ids: Vec<SigId>, waker: Arc<Waker>, } impl Signals { /// Creates the `Signals` structure. /// /// This registers all the signals listed. The same restrictions (panics, errors) apply as with /// [`register`](../fn.register.html). pub fn new<I, S>(signals: I) -> Result<Self, Error> where I: IntoIterator<Item = S>, S: Borrow<c_int>, { let (read, write) = UnixStream::pair()?; let pending = signals .into_iter() .map(|sig| (*sig.borrow(), AtomicBool::new(false))) .collect(); let waker = Arc::new(Waker { pending, read, write, }); let ids = waker .pending .keys() .map(|sig| { let sig = *sig; let waker = Arc::clone(&waker); let action = move || { waker.pending[&sig].store(true, Ordering::SeqCst); pipe::wake(waker.write.as_raw_fd()); }; unsafe { ::register(sig, action) } }) .collect::<Result<_, _>>()?; Ok(Self { ids, waker }) } /// Reads data from the internal self-pipe. /// /// If `wait` is `true` and there are no data in the self pipe, it blocks until some come. fn flush(&self, wait: bool) { const SIZE: usize = 1024; let mut buff = [0u8; SIZE]; unsafe { // We ignore all errors on purpose. This should not be something like closed file // descriptor. It could EAGAIN, but that's OK in case we say MSG_DONTWAIT. If it's // EINTR, then it's OK too, it'll only create a spurious wakeup. libc::recv( self.waker.read.as_raw_fd(), buff.as_mut_ptr() as *mut libc::c_void, SIZE, if wait { 0 } else { libc::MSG_DONTWAIT }, ); } } /// Returns an iterator of already received signals. /// /// This returns an iterator over all the signal numbers of the signals received since last /// time they were read (out of the set registered by this `Signals` instance). Note that they /// are returned in arbitrary order and a signal number is returned only once even if it was /// received multiple times. /// /// This method returns immediately (does not block) and may produce an empty iterator if there /// are no signals ready. pub fn pending(&self) -> Pending { self.flush(false); Pending(self.waker.pending.iter()) } /// Waits for some signals to be available and returns an iterator. /// /// This is similar to [`pending`](#method.pending). If there are no signals available, it /// tries to wait for some to arrive. However, due to implementation details, this still can /// produce an empty iterator. /// /// This can block for arbitrary length. /// /// Note that the blocking is done in this method, not in the iterator. pub fn wait(&self) -> Pending { self.flush(true); Pending(self.waker.pending.iter()) } /// Returns an infinite iterator over arriving signals. /// /// The iterator's `next()` blocks as necessary to wait for signals to arrive. This is adequate /// if you want to designate a thread solely to handling signals. If multiple signals come at /// the same time (between two values produced by the iterator), they will be returned in /// arbitrary order. Multiple instances of the same signal may be collated. /// /// This is also the iterator returned by `IntoIterator` implementation on `&Signals`. /// /// # Examples /// /// ```rust /// # extern crate libc; /// # extern crate signal_hook; /// # /// # use std::io::Error; /// # use std::thread; /// # /// # fn main() -> Result<(), Error> { /// let signals = signal_hook::iterator::Signals::new(&[libc::SIGUSR1, libc::SIGUSR2])?; /// thread::spawn(move || { /// for signal in signals.forever() { /// match signal { /// libc::SIGUSR1 => {}, /// libc::SIGUSR2 => {}, /// _ => unreachable!(), /// } /// } /// }); /// # Ok(()) /// # } /// ``` pub fn forever(&self) -> Forever { Forever { signals: self, iter: self.pending(), } } } impl Drop for Signals { fn drop(&mut self) { for id in &self.ids { ::unregister(*id); } } } impl<'a> IntoIterator for &'a Signals { type Item = c_int; type IntoIter = Forever<'a>; fn into_iter(self) -> Forever<'a> { self.forever() } } /// The iterator of one batch of signals. /// /// This is returned by the [`pending`](struct.Signals.html#method.pending) and /// [`wait`](struct.Signals.html#method.wait) methods. pub struct Pending<'a>(Iter<'a, c_int, AtomicBool>); impl<'a> Iterator for Pending<'a> { type Item = c_int; fn next(&mut self) -> Option<c_int> { while let Some((sig, flag)) = self.0.next() { if flag.swap(false, Ordering::SeqCst) { return Some(*sig); } } None } } /// The infinite iterator of signals. /// /// It is returned by the [`forever`](struct.Signals.html#method.forever) and by the `IntoIterator` /// implementation of [`&Signals`](struct.Signals.html). pub struct Forever<'a> { signals: &'a Signals, iter: Pending<'a>, } impl<'a> Iterator for Forever<'a> { type Item = c_int; fn next(&mut self) -> Option<c_int> { loop { if let Some(result) = self.iter.next() { return Some(result); } self.iter = self.signals.wait(); } } }