use super::*; use super::store::Resolve; use {client, proto, server}; use codec::{RecvError, SendError, UserError}; use frame::Reason; use proto::*; use http::HeaderMap; use std::{fmt, io}; use std::sync::{Arc, Mutex}; #[derive(Debug)] pub(crate) struct Streams where P: Peer, { inner: Arc>>, } /// Reference to the stream state pub(crate) struct StreamRef where P: Peer, { inner: Arc>>, key: store::Key, } /// Fields needed to manage state related to managing the set of streams. This /// is mostly split out to make ownership happy. /// /// TODO: better name #[derive(Debug)] struct Inner where P: Peer, { /// Tracks send & recv stream concurrency. counts: Counts

, actions: Actions, store: Store, } #[derive(Debug)] struct Actions where P: Peer, { /// Manages state transitions initiated by receiving frames recv: Recv, /// Manages state transitions initiated by sending frames send: Send, /// Task that calls `poll_complete`. task: Option, /// If the connection errors, a copy is kept for any StreamRefs. conn_error: Option, } impl Streams where B: Buf, P: Peer, { pub fn new(config: Config) -> Self { Streams { inner: Arc::new(Mutex::new(Inner { counts: Counts::new(&config), actions: Actions { recv: Recv::new(&config), send: Send::new(&config), task: None, conn_error: None, }, store: Store::new(), })), } } /// Process inbound headers pub fn recv_headers(&mut self, frame: frame::Headers) -> Result<(), RecvError> { let id = frame.stream_id(); let mut me = self.inner.lock().unwrap(); let me = &mut *me; let key = match me.store.find_entry(id) { Entry::Occupied(e) => e.key(), Entry::Vacant(e) => match me.actions.recv.open(id, &mut me.counts)? { Some(stream_id) => { let stream = Stream::new( stream_id, me.actions.send.init_window_sz(), me.actions.recv.init_window_sz(), ); e.insert(stream) }, None => return Ok(()), }, }; let stream = me.store.resolve(key); let actions = &mut me.actions; me.counts.transition(stream, |counts, stream| { trace!( "recv_headers; stream={:?}; state={:?}", stream.id, stream.state ); let res = if stream.state.is_recv_headers() { actions.recv.recv_headers(frame, stream, counts) } else { if !frame.is_end_stream() { // TODO: Is this the right error return Err(RecvError::Connection(Reason::PROTOCOL_ERROR)); } actions.recv.recv_trailers(frame, stream) }; actions.reset_on_recv_stream_err(stream, res) }) } pub fn recv_data(&mut self, frame: frame::Data) -> Result<(), RecvError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let id = frame.stream_id(); let stream = match me.store.find_mut(&id) { Some(stream) => stream, None => return Err(RecvError::Connection(Reason::PROTOCOL_ERROR)), }; let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { let res = actions.recv.recv_data(frame, stream); actions.reset_on_recv_stream_err(stream, res) }) } pub fn recv_reset(&mut self, frame: frame::Reset) -> Result<(), RecvError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let id = frame.stream_id(); if id.is_zero() { return Err(RecvError::Connection(Reason::PROTOCOL_ERROR)); } let stream = match me.store.find_mut(&id) { Some(stream) => stream, None => { // TODO: Are there other error cases? me.actions .ensure_not_idle(id) .map_err(RecvError::Connection)?; return Ok(()); }, }; let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { actions.recv.recv_reset(frame, stream)?; assert!(stream.state.is_closed()); Ok(()) }) } /// Handle a received error and return the ID of the last processed stream. pub fn recv_err(&mut self, err: &proto::Error) -> StreamId { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let actions = &mut me.actions; let counts = &mut me.counts; let last_processed_id = actions.recv.last_processed_id(); me.store .for_each(|stream| { counts.transition(stream, |_, stream| { actions.recv.recv_err(err, &mut *stream); actions.send.recv_err(stream); Ok::<_, ()>(()) }) }) .unwrap(); actions.conn_error = Some(err.shallow_clone()); last_processed_id } pub fn recv_goaway(&mut self, frame: &frame::GoAway) { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let actions = &mut me.actions; let counts = &mut me.counts; let last_stream_id = frame.last_stream_id(); let err = frame.reason().into(); me.store .for_each(|stream| if stream.id > last_stream_id { counts.transition(stream, |_, stream| { actions.recv.recv_err(&err, &mut *stream); actions.send.recv_err(stream); Ok::<_, ()>(()) }) } else { Ok::<_, ()>(()) }) .unwrap(); actions.conn_error = Some(err); } pub fn last_processed_id(&self) -> StreamId { self.inner.lock().unwrap().actions.recv.last_processed_id() } pub fn recv_window_update(&mut self, frame: frame::WindowUpdate) -> Result<(), RecvError> { let id = frame.stream_id(); let mut me = self.inner.lock().unwrap(); let me = &mut *me; if id.is_zero() { me.actions .send .recv_connection_window_update(frame, &mut me.store) .map_err(RecvError::Connection)?; } else { // The remote may send window updates for streams that the local now // considers closed. It's ok... if let Some(mut stream) = me.store.find_mut(&id) { // This result is ignored as there is nothing to do when there // is an error. The stream is reset by the function on error and // the error is informational. let _ = me.actions.send.recv_stream_window_update( frame.size_increment(), &mut stream, &mut me.actions.task, ); } else { me.actions .recv .ensure_not_idle(id) .map_err(RecvError::Connection)?; } } Ok(()) } pub fn recv_push_promise(&mut self, frame: frame::PushPromise) -> Result<(), RecvError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let id = frame.stream_id(); let stream = match me.store.find_mut(&id) { Some(stream) => stream.key(), None => return Err(RecvError::Connection(Reason::PROTOCOL_ERROR)), }; me.actions .recv .recv_push_promise(frame, &me.actions.send, stream, &mut me.store) } pub fn next_incoming(&mut self) -> Option> { let key = { let mut me = self.inner.lock().unwrap(); let me = &mut *me; match me.actions.recv.next_incoming(&mut me.store) { Some(key) => { // Increment the ref count me.store.resolve(key).ref_inc(); // Return the key Some(key) }, None => None, } }; key.map(|key| { StreamRef { inner: self.inner.clone(), key, } }) } pub fn send_pending_refusal( &mut self, dst: &mut Codec>, ) -> Poll<(), io::Error> where T: AsyncWrite, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; me.actions.recv.send_pending_refusal(dst) } pub fn poll_complete(&mut self, dst: &mut Codec>) -> Poll<(), io::Error> where T: AsyncWrite, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; // Send WINDOW_UPDATE frames first // // TODO: It would probably be better to interleave updates w/ data // frames. try_ready!(me.actions.recv.poll_complete(&mut me.store, dst)); // Send any other pending frames try_ready!(me.actions.send.poll_complete( &mut me.store, &mut me.counts, dst )); // Nothing else to do, track the task me.actions.task = Some(task::current()); Ok(().into()) } pub fn apply_remote_settings(&mut self, frame: &frame::Settings) -> Result<(), RecvError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; me.counts.apply_remote_settings(frame); me.actions .send .apply_remote_settings(frame, &mut me.store, &mut me.actions.task) } pub fn send_request( &mut self, request: Request<()>, end_of_stream: bool, pending: Option<&store::Key>, ) -> Result, SendError> { use super::stream::ContentLength; use http::Method; // TODO: There is a hazard with assigning a stream ID before the // prioritize layer. If prioritization reorders new streams, this // implicitly closes the earlier stream IDs. // // See: carllerche/h2#11 let key = { let mut me = self.inner.lock().unwrap(); let me = &mut *me; me.actions.ensure_no_conn_error()?; me.actions.send.ensure_next_stream_id()?; // The `pending` argument is provided by the `Client`, and holds // a store `Key` of a `Stream` that may have been not been opened // yet. // // If that stream is still pending, the Client isn't allowed to // queue up another pending stream. They should use `poll_ready`. if let Some(key) = pending { if me.store.resolve(*key).is_pending_open { return Err(UserError::Rejected.into()); } } let stream_id = me.actions.send.open()?; let mut stream = Stream::new( stream_id, me.actions.send.init_window_sz(), me.actions.recv.init_window_sz(), ); if *request.method() == Method::HEAD { stream.content_length = ContentLength::Head; } // Convert the message let headers = client::Peer::convert_send_message(stream_id, request, end_of_stream); let mut stream = me.store.insert(stream.id, stream); me.actions.send.send_headers( headers, &mut stream, &mut me.counts, &mut me.actions.task, )?; // Given that the stream has been initialized, it should not be in the // closed state. debug_assert!(!stream.state.is_closed()); // Increment the stream ref count as we will be returning a handle. stream.ref_inc(); stream.key() }; Ok(StreamRef { inner: self.inner.clone(), key: key, }) } pub fn send_reset(&mut self, id: StreamId, reason: Reason) { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let key = match me.store.find_entry(id) { Entry::Occupied(e) => e.key(), Entry::Vacant(e) => match me.actions.recv.open(id, &mut me.counts) { Ok(Some(stream_id)) => { let stream = Stream::new(stream_id, 0, 0); e.insert(stream) }, _ => return, }, }; let stream = me.store.resolve(key); let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { actions .send .send_reset(reason, stream, &mut actions.task, true) }) } } impl Streams where B: Buf, { pub fn poll_pending_open(&mut self, key: Option<&store::Key>) -> Poll<(), ::Error> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; me.actions.ensure_no_conn_error()?; me.actions.send.ensure_next_stream_id()?; if let Some(key) = key { let mut stream = me.store.resolve(*key); trace!("poll_pending_open; stream = {:?}", stream.is_pending_open); if stream.is_pending_open { stream.send_task = Some(task::current()); return Ok(Async::NotReady); } } Ok(().into()) } } impl Streams where P: Peer, { pub fn num_active_streams(&self) -> usize { let me = self.inner.lock().unwrap(); me.store.num_active_streams() } #[cfg(feature = "unstable")] pub fn num_wired_streams(&self) -> usize { let me = self.inner.lock().unwrap(); me.store.num_wired_streams() } } // no derive because we don't need B and P to be Clone. impl Clone for Streams where P: Peer, { fn clone(&self) -> Self { Streams { inner: self.inner.clone(), } } } // ===== impl StreamRef ===== impl StreamRef where P: Peer, { pub fn send_data(&mut self, data: B, end_stream: bool) -> Result<(), UserError> where B: Buf, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let stream = me.store.resolve(self.key); let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { // Create the data frame let mut frame = frame::Data::new(stream.id, data); frame.set_end_stream(end_stream); // Send the data frame actions.send.send_data(frame, stream, &mut actions.task) }) } pub fn send_trailers(&mut self, trailers: HeaderMap) -> Result<(), UserError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let stream = me.store.resolve(self.key); let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { // Create the trailers frame let frame = frame::Headers::trailers(stream.id, trailers); // Send the trailers frame actions.send.send_trailers(frame, stream, &mut actions.task) }) } pub fn send_reset(&mut self, reason: Reason) { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let stream = me.store.resolve(self.key); let actions = &mut me.actions; me.counts.transition(stream, |_, stream| { actions .send .send_reset(reason, stream, &mut actions.task, true) }) } pub fn send_response( &mut self, response: Response<()>, end_of_stream: bool, ) -> Result<(), UserError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let stream = me.store.resolve(self.key); let actions = &mut me.actions; me.counts.transition(stream, |counts, stream| { let frame = server::Peer::convert_send_message(stream.id, response, end_of_stream); actions .send .send_headers(frame, stream, counts, &mut actions.task) }) } pub fn body_is_empty(&self) -> bool where B: Buf, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let stream = me.store.resolve(self.key); me.actions.recv.body_is_empty(&stream) } pub fn poll_data(&mut self) -> Poll, proto::Error> where B: Buf, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.recv.poll_data(&mut stream) } pub fn poll_trailers(&mut self) -> Poll, proto::Error> where B: Buf, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.recv.poll_trailers(&mut stream) } /// Releases recv capacity back to the peer. This may result in sending /// WINDOW_UPDATE frames on both the stream and connection. pub fn release_capacity(&mut self, capacity: WindowSize) -> Result<(), UserError> where B: Buf, { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions .recv .release_capacity(capacity, &mut stream, &mut me.actions.task) } /// Request capacity to send data pub fn reserve_capacity(&mut self, capacity: WindowSize) { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.send.reserve_capacity(capacity, &mut stream) } /// Returns the stream's current send capacity. pub fn capacity(&self) -> WindowSize { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.send.capacity(&mut stream) } /// Request to be notified when the stream's capacity increases pub fn poll_capacity(&mut self) -> Poll, UserError> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.send.poll_capacity(&mut stream) } pub(crate) fn key(&self) -> store::Key { self.key } } impl StreamRef where B: Buf, { /// Called by the server after the stream is accepted. Given that clients /// initialize streams by sending HEADERS, the request will always be /// available. /// /// # Panics /// /// This function panics if the request isn't present. pub fn take_request(&self) -> Request<()> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.recv.take_request(&mut stream) } } impl StreamRef where B: Buf, { pub fn poll_response(&mut self) -> Poll, proto::Error> { let mut me = self.inner.lock().unwrap(); let me = &mut *me; let mut stream = me.store.resolve(self.key); me.actions.recv.poll_response(&mut stream) } pub fn is_pending_open(&self) -> bool { let mut me = self.inner.lock().unwrap(); me.store.resolve(self.key).is_pending_open } } impl Clone for StreamRef where P: Peer, { fn clone(&self) -> Self { // Increment the ref count self.inner.lock().unwrap().store.resolve(self.key).ref_inc(); StreamRef { inner: self.inner.clone(), key: self.key.clone(), } } } impl fmt::Debug for StreamRef where P: Peer, { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { match self.inner.lock() { Ok(me) => { let stream = &me.store[self.key]; fmt.debug_struct("StreamRef") .field("stream_id", &stream.id) .field("ref_count", &stream.ref_count) .finish() }, Err(_poisoned) => fmt.debug_struct("StreamRef") .field("inner", &"") .finish(), } } } impl Drop for StreamRef where P: Peer, { fn drop(&mut self) { trace!("StreamRef::drop({:?})", self); let mut me = match self.inner.lock() { Ok(inner) => inner, Err(_) => if ::std::thread::panicking() { trace!("StreamRef::drop; mutex poisoned"); return; } else { panic!("StreamRef::drop; mutex poisoned"); }, }; let me = &mut *me; let mut stream = me.store.resolve(self.key); // decrement the stream's ref count by 1. stream.ref_dec(); let actions = &mut me.actions; // the reset must be sent inside a `transition` block. // `transition_after` will release the stream if it is // released. let recv_closed = stream.state.is_recv_closed(); me.counts.transition(stream, |_, stream| // if this is the last reference to the stream, reset the stream. if stream.ref_count == 0 && !recv_closed { trace!( " -> last reference to {:?} was dropped, trying to reset", stream.id, ); actions.send.send_reset( Reason::CANCEL, stream, &mut actions.task, false ); }); } } // ===== impl Actions ===== impl Actions where B: Buf, P: Peer, { fn reset_on_recv_stream_err( &mut self, stream: &mut store::Ptr, res: Result<(), RecvError>, ) -> Result<(), RecvError> { if let Err(RecvError::Stream { reason, .. }) = res { // Reset the stream. self.send.send_reset(reason, stream, &mut self.task, true); Ok(()) } else { res } } fn ensure_not_idle(&mut self, id: StreamId) -> Result<(), Reason> { if P::is_local_init(id) { self.send.ensure_not_idle(id) } else { self.recv.ensure_not_idle(id) } } fn ensure_no_conn_error(&self) -> Result<(), proto::Error> { if let Some(ref err) = self.conn_error { Err(err.shallow_clone()) } else { Ok(()) } } }