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
//! Manages a group of threads that all have the same return type and can be [join()]ed as a unit. //! //! The implementation uses a [mpsc channel] internaly so that children (spawned threads) can notify //! the parent (owner of a [`ThreadGroup`]) that they are finished without the parent having to use //! a blocking [`std::thread::JoinHandle.join()`] call. //! //! # Examples //! ```rust //! use std::thread::sleep; //! use std::time::Duration; //! use threadgroup::{JoinError, ThreadGroup}; //! //! // Initialize a group of threads returning `u32`. //! let mut tg: ThreadGroup<u32> = ThreadGroup::new(); //! //! // Start a bunch of threads that'll return or panic after a while //! tg.spawn::<_,u32>(|| {sleep(Duration::new(0,3000000));2}); //! tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1500000));panic!()}); //! tg.spawn::<_,u32>(|| {sleep(Duration::new(10,0));3}); //! tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1000000));1}); //! //! // Join them in the order they finished //! assert_eq!(1, tg.join().unwrap()); //! assert_eq!(JoinError::Panicked, tg.join().unwrap_err()); //! assert_eq!(2, tg.join().unwrap()); //! assert_eq!(JoinError::Timeout, tg.join_timeout(Duration::new(0,10000)).unwrap_err()); //! ``` //! [join()]: struct.ThreadGroup.html#method.join //! [`ThreadGroup`]: struct.ThreadGroup.html //! [mpsc channel]: https://doc.rust-lang.org/stable/std/sync/mpsc/index.html //! [`std::thread::JoinHandle.join()`]: https://doc.rust-lang.org/stable/std/thread/struct.JoinHandle.html#method.join //#![doc(html_playground_url = "https://play.rust-lang.org/")] //#![doc(include = "README.md")] use std::sync::mpsc; use std::sync::mpsc::{Receiver, RecvError, RecvTimeoutError, Sender}; use std::thread; use std::thread::{JoinHandle, ThreadId}; use std::time::Duration; /// Possible error returns from [`join()`] and [`join_timeout()`]. /// [`join()`]: struct.ThreadGroup.html#method.join /// [`join_timeout()`]: struct.ThreadGroup.html#method.join_timeout #[derive(Debug,PartialEq)] pub enum JoinError { /// Thread list is empty, nothing to join. AllDone, /// Joined thread has panicked, no result available. Panicked,//FIXME: include panic::PanicInfo /// No thread has finished yet. Timeout, /// Internal channel got disconnected (should not happen, only included for completeness). Disconnected, } /// Holds the collection of threads and the notification channel. /// All public functions operate on this struct. pub struct ThreadGroup<T> { tx: Sender<ThreadId>, rx: Receiver<ThreadId>, handles: Vec<JoinHandle<T>>, } /// Sends current thread id on its channel when it gets out of scope. struct SendOnDrop { tx: Sender<ThreadId>, } impl Drop for SendOnDrop { fn drop(&mut self) { self.tx.send(thread::current().id()).unwrap(); } } // TODO: Allow passing something during spawn() that'll be returned during join() // TODO: check threads.len() on drop() // TODO: join_all() // TODO: iter() or into_iter() impl<T> ThreadGroup<T> { /// Initialize a group of threads returning `T`. /// # Examples /// ```rust /// use threadgroup::ThreadGroup; /// // spawning and joining require the struct to be mutable, and you'll need to provide type hints. /// let mut tg: ThreadGroup<u32> = ThreadGroup::new(); /// ``` pub fn new() -> ThreadGroup<T> { let (tx, rx): (Sender<ThreadId>, Receiver<ThreadId>) = mpsc::channel(); ThreadGroup::<T>{tx: tx, rx: rx, handles: vec![]} } /// Spawn a new thread, adding it to the ThreadGroup. /// /// Operates like [`std::thread::spawn()`], but modifies the ThreadGroup instead of returning a [`JoinHandle`]. /// # Examples /// ```rust /// use std::time::Duration; /// use std::thread::sleep; /// use threadgroup::{JoinError, ThreadGroup}; /// let mut tg: ThreadGroup<u32> = ThreadGroup::new(); /// tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1000000));1}); /// ``` /// [`std::thread::spawn()`]: https://doc.rust-lang.org/stable/std/thread/fn.spawn.html /// [`JoinHandle`]: https://doc.rust-lang.org/stable/std/thread/struct.JoinHandle.html // FIXME: Is there a way to remove the need to specify the type when calling spawn() ? // The ThreadGroup has type T and we know that R is the same type, but the compiler doesn't see that. pub fn spawn<F, R>(&mut self, f: F) where F: FnOnce() -> T, F: Send + 'static, R: Send + 'static, T: Send + 'static, { let thread_tx = self.tx.clone(); let jh: JoinHandle<T> = thread::spawn(move || { let _sender = SendOnDrop{tx: thread_tx.clone()}; f() }); self.handles.push(jh); } /// Return count of threads that have been [`spawn()`]ed but not yet [`join()`]ed. /// [`spawn()`]: struct.ThreadGroup.html#method.spawn /// [`join()`]: struct.ThreadGroup.html#method.join pub fn len(&self) -> usize { self.handles.len() } /// Check if there is any thread not yet [`join()`]ed. /// [`join()`]: struct.ThreadGroup.html#method.join pub fn is_empty(&self) -> bool { self.handles.is_empty() } /// Join one thread of the ThreadGroup. /// /// Operates like [`std::thread::JoinHandle.join()`], but picks the first thread that /// terminates. /// # Examples /// ```rust /// use threadgroup::ThreadGroup; /// let mut tg: ThreadGroup<u32> = ThreadGroup::new(); /// while !tg.is_empty() { /// match tg.join() { /// Ok(ret) => println!("Thread returned {}", ret), /// Err(e) => panic!("Oh noes !"), /// } /// } /// ``` /// [`std::thread::JoinHandle.join()`]: https://doc.rust-lang.org/stable/std/thread/struct.JoinHandle.html#method.join pub fn join(&mut self) -> Result<T, JoinError> { match self.handles.is_empty() { true => Err(JoinError::AllDone), false => match self.rx.recv() { Ok(id) => self.do_join(id), Err(RecvError{}) => Err(JoinError::Disconnected) } } } /// Try to join one thread of the ThreadGroup. /// /// Operates like [`std::thread::JoinHandle.join()`], but picks the first thread that terminates /// and gives up if the timeout is reached. /// # Examples /// ```rust /// use std::time::Duration; /// use threadgroup::{JoinError, ThreadGroup}; /// let mut tg: ThreadGroup<u32> = ThreadGroup::new(); /// for _ in 0..10 { /// if let Err(JoinError::Timeout) = tg.join_timeout(Duration::new(0,10000)) { /// println!("Still working..."); /// } /// } /// ``` /// [`std::thread::JoinHandle.join()`]: https://doc.rust-lang.org/stable/std/thread/struct.JoinHandle.html#method.join pub fn join_timeout(&mut self, timeout: Duration) -> Result<T, JoinError> { match self.handles.is_empty() { true => Err(JoinError::AllDone), false => match self.rx.recv_timeout(timeout) { Ok(id) => self.do_join(id), Err(RecvTimeoutError::Timeout) => Err(JoinError::Timeout), Err(RecvTimeoutError::Disconnected) => Err(JoinError::Disconnected) } } } /// Find a thread by its id. // TODO: replace with https://doc.rust-lang.org/nightly/std/vec/struct.Vec.html#method.remove_item fn find(&self, id: ThreadId) -> Option<usize> { for (i,jh) in self.handles.iter().enumerate() { if jh.thread().id() == id { return Some(i) } } None } /// Actual [`JoinHandle.join()`] once we know that the thread has finished. /// [`JoinHandle.join()`]: https://doc.rust-lang.org/stable/std/thread/struct.JoinHandle.html#method.join fn do_join(&mut self, id: ThreadId) -> Result<T, JoinError> { // We need to separately find and remove the JoinHandle from the vector in order to not upset the borrow checker let i = self.find(id).unwrap(); match self.handles.remove(i).join() { Ok(ret) => Ok(ret), Err(_) => Err(JoinError::Panicked), } } } #[cfg(test)] mod tests { use std::thread::sleep; use std::time::Duration; use ::{JoinError, ThreadGroup}; #[test] fn empty_group() { let mut tg: ThreadGroup<u32> = ThreadGroup::new(); assert!(tg.is_empty()); assert_eq!(tg.len(), 0); assert_eq!(JoinError::AllDone, tg.join().unwrap_err()); } #[test] fn basic_join() { let mut tg: ThreadGroup<u32> = ThreadGroup::new(); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1000000));1}); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,3000000));3}); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,2000000));2}); assert_eq!(1, tg.join().unwrap()); assert_eq!(2, tg.join().unwrap()); assert_eq!(3, tg.join().unwrap()); assert_eq!(JoinError::AllDone, tg.join().unwrap_err()); } #[test] fn panic_join() { let mut tg: ThreadGroup<u32> = ThreadGroup::new(); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1500000));panic!()}); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1000000));1}); assert_eq!(1, tg.join().unwrap()); assert_eq!(JoinError::Panicked, tg.join().unwrap_err()); assert_eq!(JoinError::AllDone, tg.join().unwrap_err()); } #[test] fn timeout_join() { let mut tg: ThreadGroup<u32> = ThreadGroup::new(); tg.spawn::<_,u32>(|| {sleep(Duration::new(1000000,0));2}); tg.spawn::<_,u32>(|| {sleep(Duration::new(0,1000000));1}); let t = Duration::new(1,0); assert_eq!(1, tg.join_timeout(t).unwrap()); assert_eq!(JoinError::Timeout, tg.join_timeout(t).unwrap_err()); assert!(!tg.is_empty()); assert_eq!(tg.len(), 1); } }