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
//! Readiness tracking streams, backing I/O objects. //! //! This module contains the core type which is used to back all I/O on object //! in `tokio-core`. The `PollEvented` type is the implementation detail of //! all I/O. Each `PollEvented` manages registration with a reactor, //! acquisition of a token, and tracking of the readiness state on the //! underlying I/O primitive. use std::io::{self, Read, Write}; use std::sync::atomic::{AtomicUsize, Ordering}; use futures::Async; use mio; use io::Io; use reactor::{Handle, Remote}; use reactor::io_token::IoToken; /// A concrete implementation of a stream of readiness notifications for I/O /// objects that originates from an event loop. /// /// Created by the `PollEvented::new` method, each `PollEvented` is /// associated with a specific event loop and source of events that will be /// registered with an event loop. /// /// Each readiness stream has a number of methods to test whether the underlying /// object is readable or writable. Once the methods return that an object is /// readable/writable, then it will continue to do so until the `need_read` or /// `need_write` methods are called. /// /// That is, this object is typically wrapped in another form of I/O object. /// It's the responsibility of the wrapper to inform the readiness stream when a /// "would block" I/O event is seen. The readiness stream will then take care of /// any scheduling necessary to get notified when the event is ready again. /// /// You can find more information about creating a custom I/O object [online]. /// /// [online]: https://tokio.rs/docs/going-deeper/core-low-level/#custom-io pub struct PollEvented<E> { token: IoToken, handle: Remote, readiness: AtomicUsize, io: E, } impl<E: mio::Evented> PollEvented<E> { /// Creates a new readiness stream associated with the provided /// `loop_handle` and for the given `source`. /// /// This method returns a future which will resolve to the readiness stream /// when it's ready. pub fn new(io: E, handle: &Handle) -> io::Result<PollEvented<E>> { Ok(PollEvented { token: try!(IoToken::new(&io, handle)), handle: handle.remote().clone(), readiness: AtomicUsize::new(0), io: io, }) } /// Deregisters this source of events from the reactor core specified. /// /// This method can optionally be called to unregister the underlying I/O /// object with the event loop that the `handle` provided points to. /// Typically this method is not required as this automatically happens when /// `E` is dropped, but for some use cases the `E` object doesn't represent /// an owned reference, so dropping it won't automatically unreigster with /// the event loop. /// /// This consumes `self` as it will no longer provide events after the /// method is called, and will likely return an error if this `PollEvented` /// was created on a separate event loop from the `handle` specified. pub fn deregister(self, handle: &Handle) -> io::Result<()> { let inner = match handle.inner.upgrade() { Some(inner) => inner, None => return Ok(()), }; let ret = inner.borrow_mut().deregister_source(&self.io); return ret } } impl<E> PollEvented<E> { /// Tests to see if this source is ready to be read from or not. /// /// If this stream is not ready for a read then `NotReady` will be returned /// and the current task will be scheduled to receive a notification when /// the stream is readable again. In other words, this method is only safe /// to call from within the context of a future's task, typically done in a /// `Future::poll` method. pub fn poll_read(&self) -> Async<()> { if self.readiness.load(Ordering::SeqCst) & 1 != 0 { return Async::Ready(()) } self.readiness.fetch_or(self.token.take_readiness(), Ordering::SeqCst); if self.readiness.load(Ordering::SeqCst) & 1 != 0 { Async::Ready(()) } else { self.token.schedule_read(&self.handle); Async::NotReady } } /// Tests to see if this source is ready to be written to or not. /// /// If this stream is not ready for a write then `NotReady` will be returned /// and the current task will be scheduled to receive a notification when /// the stream is writable again. In other words, this method is only safe /// to call from within the context of a future's task, typically done in a /// `Future::poll` method. pub fn poll_write(&self) -> Async<()> { if self.readiness.load(Ordering::SeqCst) & 2 != 0 { return Async::Ready(()) } self.readiness.fetch_or(self.token.take_readiness(), Ordering::SeqCst); if self.readiness.load(Ordering::SeqCst) & 2 != 0 { Async::Ready(()) } else { self.token.schedule_write(&self.handle); Async::NotReady } } /// Indicates to this source of events that the corresponding I/O object is /// no longer readable, but it needs to be. /// /// This function, like `poll_read`, is only safe to call from the context /// of a future's task (typically in a `Future::poll` implementation). It /// informs this readiness stream that the underlying object is no longer /// readable, typically because a "would block" error was seen. /// /// The flag indicating that this stream is readable is unset and the /// current task is scheduled to receive a notification when the stream is /// then again readable. /// /// Note that it is also only valid to call this method if `poll_read` /// previously indicated that the object is readable. That is, this function /// must always be paired with calls to `poll_read` previously. pub fn need_read(&self) { self.readiness.fetch_and(!1, Ordering::SeqCst); self.token.schedule_read(&self.handle) } /// Indicates to this source of events that the corresponding I/O object is /// no longer writable, but it needs to be. /// /// This function, like `poll_write`, is only safe to call from the context /// of a future's task (typically in a `Future::poll` implementation). It /// informs this readiness stream that the underlying object is no longer /// writable, typically because a "would block" error was seen. /// /// The flag indicating that this stream is writable is unset and the /// current task is scheduled to receive a notification when the stream is /// then again writable. /// /// Note that it is also only valid to call this method if `poll_write` /// previously indicated that the object is writeable. That is, this function /// must always be paired with calls to `poll_write` previously. pub fn need_write(&self) { self.readiness.fetch_and(!2, Ordering::SeqCst); self.token.schedule_write(&self.handle) } /// Returns a reference to the event loop handle that this readiness stream /// is associated with. pub fn remote(&self) -> &Remote { &self.handle } /// Returns a shared reference to the underlying I/O object this readiness /// stream is wrapping. pub fn get_ref(&self) -> &E { &self.io } /// Returns a mutable reference to the underlying I/O object this readiness /// stream is wrapping. pub fn get_mut(&mut self) -> &mut E { &mut self.io } } impl<E: Read> Read for PollEvented<E> { fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> { if let Async::NotReady = self.poll_read() { return Err(mio::would_block()) } let r = self.get_mut().read(buf); if is_wouldblock(&r) { self.need_read(); } return r } } impl<E: Write> Write for PollEvented<E> { fn write(&mut self, buf: &[u8]) -> io::Result<usize> { if let Async::NotReady = self.poll_write() { return Err(mio::would_block()) } let r = self.get_mut().write(buf); if is_wouldblock(&r) { self.need_write(); } return r } fn flush(&mut self) -> io::Result<()> { if let Async::NotReady = self.poll_write() { return Err(mio::would_block()) } let r = self.get_mut().flush(); if is_wouldblock(&r) { self.need_write(); } return r } } impl<E: Read + Write> Io for PollEvented<E> { fn poll_read(&mut self) -> Async<()> { <PollEvented<E>>::poll_read(self) } fn poll_write(&mut self) -> Async<()> { <PollEvented<E>>::poll_write(self) } } impl<'a, E> Read for &'a PollEvented<E> where &'a E: Read, { fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> { if let Async::NotReady = self.poll_read() { return Err(mio::would_block()) } let r = self.get_ref().read(buf); if is_wouldblock(&r) { self.need_read(); } return r } } impl<'a, E> Write for &'a PollEvented<E> where &'a E: Write, { fn write(&mut self, buf: &[u8]) -> io::Result<usize> { if let Async::NotReady = self.poll_write() { return Err(mio::would_block()) } let r = self.get_ref().write(buf); if is_wouldblock(&r) { self.need_write(); } return r } fn flush(&mut self) -> io::Result<()> { if let Async::NotReady = self.poll_write() { return Err(mio::would_block()) } let r = self.get_ref().flush(); if is_wouldblock(&r) { self.need_write(); } return r } } impl<'a, E> Io for &'a PollEvented<E> where &'a E: Read + Write, { fn poll_read(&mut self) -> Async<()> { <PollEvented<E>>::poll_read(self) } fn poll_write(&mut self) -> Async<()> { <PollEvented<E>>::poll_write(self) } } fn is_wouldblock<T>(r: &io::Result<T>) -> bool { match *r { Ok(_) => false, Err(ref e) => e.kind() == io::ErrorKind::WouldBlock, } } impl<E> Drop for PollEvented<E> { fn drop(&mut self) { self.token.drop_source(&self.handle); } }