Skip to main content

h2/proto/streams/
streams.rs

1use super::recv::RecvHeaderBlockError;
2use super::store::{self, Entry, Resolve, Store};
3use super::{Buffer, Config, Counts, Prioritized, Recv, Send, Stream, StreamId};
4use crate::codec::{Codec, SendError, UserError};
5use crate::ext::Protocol;
6use crate::frame::{self, Frame, Reason};
7use crate::proto::{peer, Error, Initiator, Open, Peer, WindowSize};
8use crate::{client, proto, server};
9
10use bytes::{Buf, Bytes};
11use http::{HeaderMap, Request, Response};
12use std::task::{Context, Poll, Waker};
13use tokio::io::AsyncWrite;
14
15use std::sync::{Arc, Mutex};
16use std::{fmt, io};
17
18#[derive(Debug)]
19pub(crate) struct Streams<B, P>
20where
21    P: Peer,
22{
23    /// Holds most of the connection and stream related state for processing
24    /// HTTP/2 frames associated with streams.
25    inner: Arc<Mutex<Inner>>,
26
27    /// This is the queue of frames to be written to the wire. This is split out
28    /// to avoid requiring a `B` generic on all public API types even if `B` is
29    /// not technically required.
30    ///
31    /// Currently, splitting this out requires a second `Arc` + `Mutex`.
32    /// However, it should be possible to avoid this duplication with a little
33    /// bit of unsafe code. This optimization has been postponed until it has
34    /// been shown to be necessary.
35    send_buffer: Arc<SendBuffer<B>>,
36
37    _p: ::std::marker::PhantomData<P>,
38}
39
40// Like `Streams` but with a `peer::Dyn` field instead of a static `P: Peer` type parameter.
41// Ensures that the methods only get one instantiation, instead of two (client and server)
42#[derive(Debug)]
43pub(crate) struct DynStreams<'a, B> {
44    inner: &'a Mutex<Inner>,
45
46    send_buffer: &'a SendBuffer<B>,
47
48    peer: peer::Dyn,
49}
50
51/// Reference to the stream state
52#[derive(Debug)]
53pub(crate) struct StreamRef<B> {
54    opaque: OpaqueStreamRef,
55    send_buffer: Arc<SendBuffer<B>>,
56}
57
58/// Reference to the stream state that hides the send data chunk generic
59pub(crate) struct OpaqueStreamRef {
60    inner: Arc<Mutex<Inner>>,
61    key: store::Key,
62}
63
64/// Fields needed to manage state related to managing the set of streams. This
65/// is mostly split out to make ownership happy.
66///
67/// TODO: better name
68#[derive(Debug)]
69struct Inner {
70    /// Tracks send & recv stream concurrency.
71    counts: Counts,
72
73    /// Connection level state and performs actions on streams
74    actions: Actions,
75
76    /// Stores stream state
77    store: Store,
78
79    /// The number of stream refs to this shared state.
80    refs: usize,
81}
82
83#[derive(Debug)]
84struct Actions {
85    /// Manages state transitions initiated by receiving frames
86    recv: Recv,
87
88    /// Manages state transitions initiated by sending frames
89    send: Send,
90
91    /// Task that calls `poll_complete`.
92    task: Option<Waker>,
93
94    /// If the connection errors, a copy is kept for any StreamRefs.
95    conn_error: Option<proto::Error>,
96}
97
98/// Contains the buffer of frames to be written to the wire.
99#[derive(Debug)]
100struct SendBuffer<B> {
101    inner: Mutex<Buffer<Frame<B>>>,
102}
103
104// ===== impl Streams =====
105
106impl<B, P> Streams<B, P>
107where
108    B: Buf,
109    P: Peer,
110{
111    pub fn new(config: Config) -> Self {
112        let peer = P::r#dyn();
113
114        Streams {
115            inner: Inner::new(peer, config),
116            send_buffer: Arc::new(SendBuffer::new()),
117            _p: ::std::marker::PhantomData,
118        }
119    }
120
121    pub fn set_target_connection_window_size(&mut self, size: WindowSize) -> Result<(), Reason> {
122        let mut me = self.inner.lock().unwrap();
123        let me = &mut *me;
124
125        me.actions
126            .recv
127            .set_target_connection_window(size, &mut me.actions.task)
128    }
129
130    pub fn next_incoming(&mut self) -> Option<StreamRef<B>> {
131        let mut me = self.inner.lock().unwrap();
132        let me = &mut *me;
133        me.actions.recv.next_incoming(&mut me.store).map(|key| {
134            let stream = &mut me.store.resolve(key);
135            tracing::trace!(
136                "next_incoming; id={:?}, state={:?}",
137                stream.id,
138                stream.state
139            );
140            // TODO: ideally, OpaqueStreamRefs::new would do this, but we're holding
141            // the lock, so it can't.
142            me.refs += 1;
143
144            // Pending-accepted remotely-reset streams are counted.
145            if stream.state.is_remote_reset() {
146                me.counts.dec_num_remote_reset_streams();
147            }
148
149            StreamRef {
150                opaque: OpaqueStreamRef::new(self.inner.clone(), stream),
151                send_buffer: self.send_buffer.clone(),
152            }
153        })
154    }
155
156    pub fn send_pending_refusal<T>(
157        &mut self,
158        cx: &mut Context,
159        dst: &mut Codec<T, Prioritized<B>>,
160    ) -> Poll<io::Result<()>>
161    where
162        T: AsyncWrite + Unpin,
163    {
164        let mut me = self.inner.lock().unwrap();
165        let me = &mut *me;
166        me.actions.recv.send_pending_refusal(cx, dst)
167    }
168
169    pub fn clear_expired_reset_streams(&mut self) {
170        let mut me = self.inner.lock().unwrap();
171        let me = &mut *me;
172        me.actions
173            .recv
174            .clear_expired_reset_streams(&mut me.store, &mut me.counts);
175    }
176
177    pub fn poll_complete<T>(
178        &mut self,
179        cx: &mut Context,
180        dst: &mut Codec<T, Prioritized<B>>,
181    ) -> Poll<io::Result<()>>
182    where
183        T: AsyncWrite + Unpin,
184    {
185        let mut me = self.inner.lock().unwrap();
186        me.poll_complete(&self.send_buffer, cx, dst)
187    }
188
189    pub fn apply_remote_settings(
190        &mut self,
191        frame: &frame::Settings,
192        is_initial: bool,
193    ) -> Result<(), Error> {
194        let mut me = self.inner.lock().unwrap();
195        let me = &mut *me;
196
197        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
198        let send_buffer = &mut *send_buffer;
199
200        me.counts.apply_remote_settings(frame, is_initial);
201
202        me.actions.send.apply_remote_settings(
203            frame,
204            send_buffer,
205            &mut me.store,
206            &mut me.counts,
207            &mut me.actions.task,
208        )
209    }
210
211    pub fn apply_local_settings(&mut self, frame: &frame::Settings) -> Result<(), Error> {
212        let mut me = self.inner.lock().unwrap();
213        let me = &mut *me;
214
215        me.actions.recv.apply_local_settings(frame, &mut me.store)
216    }
217
218    pub fn send_request(
219        &mut self,
220        mut request: Request<()>,
221        end_of_stream: bool,
222        pending: Option<&OpaqueStreamRef>,
223    ) -> Result<(StreamRef<B>, bool), SendError> {
224        use super::stream::ContentLength;
225        use http::Method;
226
227        let protocol = request.extensions_mut().remove::<Protocol>();
228
229        // Clear before taking lock, incase extensions contain a StreamRef.
230        request.extensions_mut().clear();
231
232        // TODO: There is a hazard with assigning a stream ID before the
233        // prioritize layer. If prioritization reorders new streams, this
234        // implicitly closes the earlier stream IDs.
235        //
236        // See: hyperium/h2#11
237        let mut me = self.inner.lock().unwrap();
238        let me = &mut *me;
239
240        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
241        let send_buffer = &mut *send_buffer;
242
243        me.actions.ensure_no_conn_error()?;
244        me.actions.send.ensure_next_stream_id()?;
245
246        // The `pending` argument is provided by the `Client`, and holds
247        // a store `Key` of a `Stream` that may have been not been opened
248        // yet.
249        //
250        // If that stream is still pending, the Client isn't allowed to
251        // queue up another pending stream. They should use `poll_ready`.
252        if let Some(stream) = pending {
253            if me.store.resolve(stream.key).is_pending_open {
254                return Err(UserError::Rejected.into());
255            }
256        }
257
258        if me.counts.peer().is_server() {
259            // Servers cannot open streams. PushPromise must first be reserved.
260            return Err(UserError::UnexpectedFrameType.into());
261        }
262
263        let stream_id = me.actions.send.open()?;
264
265        let mut stream = Stream::new(
266            stream_id,
267            me.actions.send.init_window_sz(),
268            me.actions.recv.init_window_sz(),
269        );
270
271        if *request.method() == Method::HEAD {
272            stream.content_length = ContentLength::Head;
273        }
274
275        // Convert the message
276        let headers =
277            client::Peer::convert_send_message(stream_id, request, protocol, end_of_stream)?;
278
279        let mut stream = me.store.insert(stream.id, stream);
280
281        let sent = me.actions.send.send_headers(
282            headers,
283            send_buffer,
284            &mut stream,
285            &mut me.counts,
286            &mut me.actions.task,
287        );
288
289        // send_headers can return a UserError, if it does,
290        // we should forget about this stream.
291        if let Err(err) = sent {
292            stream.unlink();
293            stream.remove();
294            return Err(err.into());
295        }
296
297        // Given that the stream has been initialized, it should not be in the
298        // closed state.
299        debug_assert!(!stream.state.is_closed());
300
301        // TODO: ideally, OpaqueStreamRefs::new would do this, but we're holding
302        // the lock, so it can't.
303        me.refs += 1;
304
305        let is_full = me.counts.next_send_stream_will_reach_capacity();
306        Ok((
307            StreamRef {
308                opaque: OpaqueStreamRef::new(self.inner.clone(), &mut stream),
309                send_buffer: self.send_buffer.clone(),
310            },
311            is_full,
312        ))
313    }
314
315    pub(crate) fn is_extended_connect_protocol_enabled(&self) -> bool {
316        self.inner
317            .lock()
318            .unwrap()
319            .actions
320            .send
321            .is_extended_connect_protocol_enabled()
322    }
323
324    pub fn current_max_send_streams(&self) -> usize {
325        let me = self.inner.lock().unwrap();
326        me.counts.max_send_streams()
327    }
328
329    pub fn current_max_recv_streams(&self) -> usize {
330        let me = self.inner.lock().unwrap();
331        me.counts.max_recv_streams()
332    }
333}
334
335impl<B> DynStreams<'_, B> {
336    pub fn is_buffer_empty(&self) -> bool {
337        self.send_buffer.is_empty()
338    }
339
340    pub fn is_server(&self) -> bool {
341        self.peer.is_server()
342    }
343
344    pub fn recv_headers(&mut self, frame: frame::Headers) -> Result<(), Error> {
345        let mut me = self.inner.lock().unwrap();
346
347        me.recv_headers(self.peer, self.send_buffer, frame)
348    }
349
350    pub fn recv_data(&mut self, frame: frame::Data) -> Result<(), Error> {
351        let mut me = self.inner.lock().unwrap();
352        me.recv_data(self.peer, self.send_buffer, frame)
353    }
354
355    pub fn recv_reset(&mut self, frame: frame::Reset) -> Result<(), Error> {
356        let mut me = self.inner.lock().unwrap();
357
358        me.recv_reset(self.send_buffer, frame)
359    }
360
361    /// Notify all streams that a connection-level error happened.
362    pub fn handle_error(&mut self, err: proto::Error) -> StreamId {
363        let mut me = self.inner.lock().unwrap();
364        me.handle_error(self.send_buffer, err)
365    }
366
367    pub fn recv_go_away(&mut self, frame: &frame::GoAway) -> Result<(), Error> {
368        let mut me = self.inner.lock().unwrap();
369        me.recv_go_away(self.send_buffer, frame)
370    }
371
372    pub fn last_processed_id(&self) -> StreamId {
373        self.inner.lock().unwrap().actions.recv.last_processed_id()
374    }
375
376    pub fn recv_window_update(&mut self, frame: frame::WindowUpdate) -> Result<(), Error> {
377        let mut me = self.inner.lock().unwrap();
378        me.recv_window_update(self.send_buffer, frame)
379    }
380
381    pub fn recv_push_promise(&mut self, frame: frame::PushPromise) -> Result<(), Error> {
382        let mut me = self.inner.lock().unwrap();
383        me.recv_push_promise(self.send_buffer, frame)
384    }
385
386    pub fn recv_eof(&mut self, clear_pending_accept: bool) -> Result<(), ()> {
387        let mut me = self.inner.lock().map_err(|_| ())?;
388        me.recv_eof(self.send_buffer, clear_pending_accept)
389    }
390
391    pub fn send_reset(
392        &mut self,
393        id: StreamId,
394        reason: Reason,
395    ) -> Result<(), crate::proto::error::GoAway> {
396        let mut me = self.inner.lock().unwrap();
397        me.send_reset(self.send_buffer, id, reason)
398    }
399
400    pub fn send_go_away(&mut self, last_processed_id: StreamId) {
401        let mut me = self.inner.lock().unwrap();
402        me.actions.recv.go_away(last_processed_id);
403    }
404}
405
406impl Inner {
407    fn new(peer: peer::Dyn, config: Config) -> Arc<Mutex<Self>> {
408        Arc::new(Mutex::new(Inner {
409            counts: Counts::new(peer, &config),
410            actions: Actions {
411                recv: Recv::new(peer, &config),
412                send: Send::new(&config),
413                task: None,
414                conn_error: None,
415            },
416            store: Store::new(),
417            refs: 1,
418        }))
419    }
420
421    fn recv_headers<B>(
422        &mut self,
423        peer: peer::Dyn,
424        send_buffer: &SendBuffer<B>,
425        frame: frame::Headers,
426    ) -> Result<(), Error> {
427        let id = frame.stream_id();
428
429        // The GOAWAY process has begun. All streams with a greater ID than
430        // specified as part of GOAWAY should be ignored.
431        if id > self.actions.recv.max_stream_id() {
432            tracing::trace!(
433                "id ({:?}) > max_stream_id ({:?}), ignoring HEADERS",
434                id,
435                self.actions.recv.max_stream_id()
436            );
437            return Ok(());
438        }
439
440        let key = match self.store.find_entry(id) {
441            Entry::Occupied(e) => e.key(),
442            Entry::Vacant(e) => {
443                // Client: it's possible to send a request, and then send
444                // a RST_STREAM while the response HEADERS were in transit.
445                //
446                // Server: we can't reset a stream before having received
447                // the request headers, so don't allow.
448                if !peer.is_server() {
449                    // This may be response headers for a stream we've already
450                    // forgotten about...
451                    if self.actions.may_have_forgotten_stream(peer, id) {
452                        tracing::debug!(
453                            "recv_headers for old stream={:?}, sending STREAM_CLOSED",
454                            id,
455                        );
456                        return Err(Error::library_reset(id, Reason::STREAM_CLOSED));
457                    }
458                }
459
460                match self
461                    .actions
462                    .recv
463                    .open(id, Open::Headers, &mut self.counts)?
464                {
465                    Some(stream_id) => {
466                        let stream = Stream::new(
467                            stream_id,
468                            self.actions.send.init_window_sz(),
469                            self.actions.recv.init_window_sz(),
470                        );
471
472                        e.insert(stream)
473                    }
474                    None => return Ok(()),
475                }
476            }
477        };
478
479        let stream = self.store.resolve(key);
480
481        if stream.is_pending_open {
482            proto_err!(conn: "recv_headers: received frame on idle stream {:?}", id);
483            return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
484        }
485
486        if stream.state.is_local_error() {
487            // Locally reset streams must ignore frames "for some time".
488            // This is because the remote may have sent trailers before
489            // receiving the RST_STREAM frame.
490            tracing::trace!("recv_headers; ignoring trailers on {:?}", stream.id);
491            return Ok(());
492        }
493
494        let actions = &mut self.actions;
495        let mut send_buffer = send_buffer.inner.lock().unwrap();
496        let send_buffer = &mut *send_buffer;
497
498        self.counts.transition(stream, |counts, stream| {
499            tracing::trace!(
500                "recv_headers; stream={:?}; state={:?}",
501                stream.id,
502                stream.state
503            );
504
505            let res = if stream.state.is_recv_headers() {
506                match actions.recv.recv_headers(frame, stream, counts) {
507                    Ok(()) => Ok(()),
508                    Err(RecvHeaderBlockError::Oversize(resp)) => {
509                        if let Some(resp) = resp {
510                            let sent = actions.send.send_headers(
511                                resp, send_buffer, stream, counts, &mut actions.task);
512                            debug_assert!(sent.is_ok(), "oversize response should not fail");
513
514                            actions.send.schedule_implicit_reset(
515                                stream,
516                                Reason::PROTOCOL_ERROR,
517                                counts,
518                                &mut actions.task);
519
520                            actions.recv.enqueue_reset_expiration(stream, counts);
521
522                            Ok(())
523                        } else {
524                            Err(Error::library_reset(stream.id, Reason::PROTOCOL_ERROR))
525                        }
526                    },
527                    Err(RecvHeaderBlockError::State(err)) => Err(err),
528                }
529            } else {
530                if !frame.is_end_stream() {
531                    // Receiving trailers that don't set EOS is a "malformed"
532                    // message. Malformed messages are a stream error.
533                    proto_err!(stream: "recv_headers: trailers frame was not EOS; stream={:?}", stream.id);
534                    return Err(Error::library_reset(stream.id, Reason::PROTOCOL_ERROR));
535                }
536
537                actions.recv.recv_trailers(frame, stream)
538            };
539
540            actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
541        })
542    }
543
544    fn recv_data<B>(
545        &mut self,
546        peer: peer::Dyn,
547        send_buffer: &SendBuffer<B>,
548        frame: frame::Data,
549    ) -> Result<(), Error> {
550        let id = frame.stream_id();
551
552        let stream = match self.store.find_mut(&id) {
553            Some(stream) => stream,
554            None => {
555                // The GOAWAY process has begun. All streams with a greater ID
556                // than specified as part of GOAWAY should be ignored.
557                if id > self.actions.recv.max_stream_id() {
558                    tracing::trace!(
559                        "id ({:?}) > max_stream_id ({:?}), ignoring DATA",
560                        id,
561                        self.actions.recv.max_stream_id()
562                    );
563
564                    // We still need to account for connection-level flow control.
565                    let sz = frame.flow_controlled_len();
566                    assert!(sz <= super::MAX_WINDOW_SIZE as usize);
567                    let sz = sz as WindowSize;
568                    self.actions.recv.ignore_data(sz)?;
569
570                    return Ok(());
571                }
572
573                if self.actions.may_have_forgotten_stream(peer, id) {
574                    tracing::debug!("recv_data for old stream={:?}, sending STREAM_CLOSED", id,);
575
576                    let sz = frame.flow_controlled_len();
577                    // This should have been enforced at the codec::FramedRead layer, so
578                    // this is just a sanity check.
579                    assert!(sz <= super::MAX_WINDOW_SIZE as usize);
580                    let sz = sz as WindowSize;
581                    self.actions.recv.ignore_data(sz)?;
582
583                    return Err(Error::library_reset(id, Reason::STREAM_CLOSED));
584                }
585
586                proto_err!(conn: "recv_data: stream not found; id={:?}", id);
587                return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
588            }
589        };
590
591        let actions = &mut self.actions;
592        let mut send_buffer = send_buffer.inner.lock().unwrap();
593        let send_buffer = &mut *send_buffer;
594
595        self.counts.transition(stream, |counts, stream| {
596            let sz = frame.flow_controlled_len();
597            let res = actions.recv.recv_data(frame, stream);
598
599            // Any stream error after receiving a DATA frame means
600            // we won't give the data to the user, and so they can't
601            // release the capacity. We do it automatically.
602            if let Err(Error::Reset(..)) = res {
603                actions
604                    .recv
605                    .release_connection_capacity(sz as WindowSize, &mut None);
606            }
607            actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
608        })
609    }
610
611    fn recv_reset<B>(
612        &mut self,
613        send_buffer: &SendBuffer<B>,
614        frame: frame::Reset,
615    ) -> Result<(), Error> {
616        let id = frame.stream_id();
617
618        if id.is_zero() {
619            proto_err!(conn: "recv_reset: invalid stream ID 0");
620            return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
621        }
622
623        // The GOAWAY process has begun. All streams with a greater ID than
624        // specified as part of GOAWAY should be ignored.
625        if id > self.actions.recv.max_stream_id() {
626            tracing::trace!(
627                "id ({:?}) > max_stream_id ({:?}), ignoring RST_STREAM",
628                id,
629                self.actions.recv.max_stream_id()
630            );
631            return Ok(());
632        }
633
634        let stream = match self.store.find_mut(&id) {
635            Some(stream) => stream,
636            None => {
637                // TODO: Are there other error cases?
638                self.actions
639                    .ensure_not_idle(self.counts.peer(), id)
640                    .map_err(Error::library_go_away)?;
641
642                return Ok(());
643            }
644        };
645
646        if stream.is_pending_open {
647            proto_err!(conn: "recv_reset: received frame on idle stream {:?}", id);
648            return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
649        }
650
651        let mut send_buffer = send_buffer.inner.lock().unwrap();
652        let send_buffer = &mut *send_buffer;
653
654        let actions = &mut self.actions;
655
656        self.counts.transition(stream, |counts, stream| {
657            actions.recv.recv_reset(frame, stream, counts)?;
658            actions.send.handle_error(send_buffer, stream, counts);
659            assert!(stream.state.is_closed());
660            Ok(())
661        })
662    }
663
664    fn recv_window_update<B>(
665        &mut self,
666        send_buffer: &SendBuffer<B>,
667        frame: frame::WindowUpdate,
668    ) -> Result<(), Error> {
669        let id = frame.stream_id();
670
671        let mut send_buffer = send_buffer.inner.lock().unwrap();
672        let send_buffer = &mut *send_buffer;
673
674        if id.is_zero() {
675            self.actions
676                .send
677                .recv_connection_window_update(frame, &mut self.store, &mut self.counts)
678                .map_err(Error::library_go_away)?;
679        } else {
680            // The remote may send window updates for streams that the local now
681            // considers closed. It's ok...
682            if let Some(mut stream) = self.store.find_mut(&id) {
683                if stream.is_pending_open {
684                    proto_err!(conn: "recv_window_update: received frame on idle stream {:?}", id);
685                    return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
686                }
687
688                let res = self
689                    .actions
690                    .send
691                    .recv_stream_window_update(
692                        frame.size_increment(),
693                        send_buffer,
694                        &mut stream,
695                        &mut self.counts,
696                        &mut self.actions.task,
697                    )
698                    .map_err(|reason| Error::library_reset(id, reason));
699
700                return self.actions.reset_on_recv_stream_err(
701                    send_buffer,
702                    &mut stream,
703                    &mut self.counts,
704                    res,
705                );
706            } else {
707                self.actions
708                    .ensure_not_idle(self.counts.peer(), id)
709                    .map_err(Error::library_go_away)?;
710            }
711        }
712
713        Ok(())
714    }
715
716    fn handle_error<B>(&mut self, send_buffer: &SendBuffer<B>, err: proto::Error) -> StreamId {
717        let actions = &mut self.actions;
718        let counts = &mut self.counts;
719        let mut send_buffer = send_buffer.inner.lock().unwrap();
720        let send_buffer = &mut *send_buffer;
721
722        let last_processed_id = actions.recv.last_processed_id();
723
724        self.store.for_each(|stream| {
725            counts.transition(stream, |counts, stream| {
726                actions.recv.handle_error(&err, &mut *stream);
727                actions.send.handle_error(send_buffer, stream, counts);
728            })
729        });
730
731        actions.conn_error = Some(err);
732
733        last_processed_id
734    }
735
736    fn recv_go_away<B>(
737        &mut self,
738        send_buffer: &SendBuffer<B>,
739        frame: &frame::GoAway,
740    ) -> Result<(), Error> {
741        let actions = &mut self.actions;
742        let counts = &mut self.counts;
743        let mut send_buffer = send_buffer.inner.lock().unwrap();
744        let send_buffer = &mut *send_buffer;
745
746        let last_stream_id = frame.last_stream_id();
747
748        actions.send.recv_go_away(last_stream_id)?;
749
750        let err = Error::remote_go_away(frame.debug_data().clone(), frame.reason());
751
752        let peer = counts.peer();
753        self.store.for_each(|stream| {
754            if stream.id > last_stream_id && peer.is_local_init(stream.id) {
755                counts.transition(stream, |counts, stream| {
756                    actions.recv.handle_error(&err, &mut *stream);
757                    actions.send.handle_error(send_buffer, stream, counts);
758                })
759            }
760        });
761
762        actions.conn_error = Some(err);
763
764        Ok(())
765    }
766
767    fn recv_push_promise<B>(
768        &mut self,
769        send_buffer: &SendBuffer<B>,
770        frame: frame::PushPromise,
771    ) -> Result<(), Error> {
772        let id = frame.stream_id();
773        let promised_id = frame.promised_id();
774
775        // First, ensure that the initiating stream is still in a valid state.
776        let parent_key = match self.store.find_mut(&id) {
777            Some(stream) => {
778                // The GOAWAY process has begun. All streams with a greater ID
779                // than specified as part of GOAWAY should be ignored.
780                if id > self.actions.recv.max_stream_id() {
781                    tracing::trace!(
782                        "id ({:?}) > max_stream_id ({:?}), ignoring PUSH_PROMISE",
783                        id,
784                        self.actions.recv.max_stream_id()
785                    );
786                    return Ok(());
787                }
788
789                // The stream must be receive open
790                if !stream.state.ensure_recv_open()? {
791                    proto_err!(conn: "recv_push_promise: initiating stream is not opened");
792                    return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
793                }
794
795                stream.key()
796            }
797            None => {
798                proto_err!(conn: "recv_push_promise: initiating stream is in an invalid state");
799                return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
800            }
801        };
802
803        // TODO: Streams in the reserved states do not count towards the concurrency
804        // limit. However, it seems like there should be a cap otherwise this
805        // could grow in memory indefinitely.
806
807        // Ensure that we can reserve streams
808        self.actions.recv.ensure_can_reserve()?;
809
810        // Next, open the stream.
811        //
812        // If `None` is returned, then the stream is being refused. There is no
813        // further work to be done.
814        if self
815            .actions
816            .recv
817            .open(promised_id, Open::PushPromise, &mut self.counts)?
818            .is_none()
819        {
820            return Ok(());
821        }
822
823        // Try to handle the frame and create a corresponding key for the pushed stream
824        // this requires a bit of indirection to make the borrow checker happy.
825        let child_key: Option<store::Key> = {
826            // Create state for the stream
827            let stream = self.store.insert(promised_id, {
828                Stream::new(
829                    promised_id,
830                    self.actions.send.init_window_sz(),
831                    self.actions.recv.init_window_sz(),
832                )
833            });
834
835            let actions = &mut self.actions;
836
837            self.counts.transition(stream, |counts, stream| {
838                let stream_valid = actions.recv.recv_push_promise(frame, stream);
839
840                match stream_valid {
841                    Ok(()) => Ok(Some(stream.key())),
842                    _ => {
843                        let mut send_buffer = send_buffer.inner.lock().unwrap();
844                        actions
845                            .reset_on_recv_stream_err(
846                                &mut *send_buffer,
847                                stream,
848                                counts,
849                                stream_valid,
850                            )
851                            .map(|()| None)
852                    }
853                }
854            })?
855        };
856        // If we're successful, push the headers and stream...
857        if let Some(child) = child_key {
858            let mut ppp = self.store[parent_key].pending_push_promises.take();
859            ppp.push(&mut self.store.resolve(child));
860
861            let parent = &mut self.store.resolve(parent_key);
862            parent.pending_push_promises = ppp;
863            parent.notify_push();
864        };
865
866        Ok(())
867    }
868
869    fn recv_eof<B>(
870        &mut self,
871        send_buffer: &SendBuffer<B>,
872        clear_pending_accept: bool,
873    ) -> Result<(), ()> {
874        let actions = &mut self.actions;
875        let counts = &mut self.counts;
876        let mut send_buffer = send_buffer.inner.lock().unwrap();
877        let send_buffer = &mut *send_buffer;
878
879        if actions.conn_error.is_none() {
880            actions.conn_error = Some(
881                io::Error::new(
882                    io::ErrorKind::BrokenPipe,
883                    "connection closed because of a broken pipe",
884                )
885                .into(),
886            );
887        }
888
889        tracing::trace!("Streams::recv_eof");
890
891        self.store.for_each(|stream| {
892            counts.transition(stream, |counts, stream| {
893                actions.recv.recv_eof(stream);
894
895                // This handles resetting send state associated with the
896                // stream
897                actions.send.handle_error(send_buffer, stream, counts);
898            })
899        });
900
901        actions.clear_queues(clear_pending_accept, &mut self.store, counts);
902        Ok(())
903    }
904
905    fn poll_complete<T, B>(
906        &mut self,
907        send_buffer: &SendBuffer<B>,
908        cx: &mut Context,
909        dst: &mut Codec<T, Prioritized<B>>,
910    ) -> Poll<io::Result<()>>
911    where
912        T: AsyncWrite + Unpin,
913        B: Buf,
914    {
915        let mut send_buffer = send_buffer.inner.lock().unwrap();
916        let send_buffer = &mut *send_buffer;
917
918        // Send WINDOW_UPDATE frames first
919        //
920        // TODO: It would probably be better to interleave updates w/ data
921        // frames.
922        ready!(self
923            .actions
924            .recv
925            .poll_complete(cx, &mut self.store, &mut self.counts, dst))?;
926
927        // Send any other pending frames
928        ready!(self.actions.send.poll_complete(
929            cx,
930            send_buffer,
931            &mut self.store,
932            &mut self.counts,
933            dst
934        ))?;
935
936        // Nothing else to do, track the task
937        self.actions.task = Some(cx.waker().clone());
938
939        Poll::Ready(Ok(()))
940    }
941
942    fn send_reset<B>(
943        &mut self,
944        send_buffer: &SendBuffer<B>,
945        id: StreamId,
946        reason: Reason,
947    ) -> Result<(), crate::proto::error::GoAway> {
948        let key = match self.store.find_entry(id) {
949            Entry::Occupied(e) => e.key(),
950            Entry::Vacant(e) => {
951                // Resetting a stream we don't know about? That could be OK...
952                //
953                // 1. As a server, we just received a request, but that request
954                //    was bad, so we're resetting before even accepting it.
955                //    This is totally fine.
956                //
957                // 2. The remote may have sent us a frame on new stream that
958                //    it's *not* supposed to have done, and thus, we don't know
959                //    the stream. In that case, sending a reset will "open" the
960                //    stream in our store. Maybe that should be a connection
961                //    error instead? At least for now, we need to update what
962                //    our vision of the next stream is.
963                if self.counts.peer().is_local_init(id) {
964                    // We normally would open this stream, so update our
965                    // next-send-id record.
966                    self.actions.send.maybe_reset_next_stream_id(id);
967                } else {
968                    // We normally would recv this stream, so update our
969                    // next-recv-id record.
970                    self.actions.recv.maybe_reset_next_stream_id(id);
971                }
972
973                let stream = Stream::new(id, 0, 0);
974
975                e.insert(stream)
976            }
977        };
978
979        let stream = self.store.resolve(key);
980        let mut send_buffer = send_buffer.inner.lock().unwrap();
981        let send_buffer = &mut *send_buffer;
982        self.actions.send_reset(
983            stream,
984            reason,
985            Initiator::Library,
986            &mut self.counts,
987            send_buffer,
988        )
989    }
990}
991
992impl<B> Streams<B, client::Peer>
993where
994    B: Buf,
995{
996    pub fn poll_pending_open(
997        &mut self,
998        cx: &Context,
999        pending: Option<&OpaqueStreamRef>,
1000    ) -> Poll<Result<(), crate::Error>> {
1001        let mut me = self.inner.lock().unwrap();
1002        let me = &mut *me;
1003
1004        me.actions.ensure_no_conn_error()?;
1005        me.actions.send.ensure_next_stream_id()?;
1006
1007        if let Some(pending) = pending {
1008            let mut stream = me.store.resolve(pending.key);
1009            tracing::trace!("poll_pending_open; stream = {:?}", stream.is_pending_open);
1010            if stream.is_pending_open {
1011                stream.wait_send(cx);
1012                return Poll::Pending;
1013            }
1014        }
1015        Poll::Ready(Ok(()))
1016    }
1017}
1018
1019impl<B, P> Streams<B, P>
1020where
1021    P: Peer,
1022{
1023    pub fn as_dyn(&self) -> DynStreams<'_, B> {
1024        let Self {
1025            inner,
1026            send_buffer,
1027            _p,
1028        } = self;
1029        DynStreams {
1030            inner,
1031            send_buffer,
1032            peer: P::r#dyn(),
1033        }
1034    }
1035
1036    /// This function is safe to call multiple times.
1037    ///
1038    /// A `Result` is returned to avoid panicking if the mutex is poisoned.
1039    pub fn recv_eof(&mut self, clear_pending_accept: bool) -> Result<(), ()> {
1040        self.as_dyn().recv_eof(clear_pending_accept)
1041    }
1042
1043    pub(crate) fn max_send_streams(&self) -> usize {
1044        self.inner.lock().unwrap().counts.max_send_streams()
1045    }
1046
1047    pub(crate) fn max_recv_streams(&self) -> usize {
1048        self.inner.lock().unwrap().counts.max_recv_streams()
1049    }
1050
1051    #[cfg(feature = "unstable")]
1052    pub fn num_active_streams(&self) -> usize {
1053        let me = self.inner.lock().unwrap();
1054        me.store.num_active_streams()
1055    }
1056
1057    pub fn has_streams(&self) -> bool {
1058        let me = self.inner.lock().unwrap();
1059        me.counts.has_streams()
1060    }
1061
1062    pub fn has_streams_or_other_references(&self) -> bool {
1063        let me = self.inner.lock().unwrap();
1064        me.counts.has_streams() || me.refs > 1
1065    }
1066
1067    #[cfg(feature = "unstable")]
1068    pub fn num_wired_streams(&self) -> usize {
1069        let me = self.inner.lock().unwrap();
1070        me.store.num_wired_streams()
1071    }
1072}
1073
1074// no derive because we don't need B and P to be Clone.
1075impl<B, P> Clone for Streams<B, P>
1076where
1077    P: Peer,
1078{
1079    fn clone(&self) -> Self {
1080        self.inner.lock().unwrap().refs += 1;
1081        Streams {
1082            inner: self.inner.clone(),
1083            send_buffer: self.send_buffer.clone(),
1084            _p: ::std::marker::PhantomData,
1085        }
1086    }
1087}
1088
1089impl<B, P> Drop for Streams<B, P>
1090where
1091    P: Peer,
1092{
1093    fn drop(&mut self) {
1094        if let Ok(mut inner) = self.inner.lock() {
1095            inner.refs -= 1;
1096            if inner.refs == 1 {
1097                if let Some(task) = inner.actions.task.take() {
1098                    task.wake();
1099                }
1100            }
1101        }
1102    }
1103}
1104
1105// ===== impl StreamRef =====
1106
1107impl<B> StreamRef<B> {
1108    pub fn send_data(&mut self, data: B, end_stream: bool) -> Result<(), UserError>
1109    where
1110        B: Buf,
1111    {
1112        let mut me = self.opaque.inner.lock().unwrap();
1113        let me = &mut *me;
1114
1115        let stream = me.store.resolve(self.opaque.key);
1116        let actions = &mut me.actions;
1117        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1118        let send_buffer = &mut *send_buffer;
1119
1120        me.counts.transition(stream, |counts, stream| {
1121            // Create the data frame
1122            let mut frame = frame::Data::new(stream.id, data);
1123            frame.set_end_stream(end_stream);
1124
1125            // Send the data frame
1126            actions
1127                .send
1128                .send_data(frame, send_buffer, stream, counts, &mut actions.task)
1129        })
1130    }
1131
1132    pub fn send_trailers(&mut self, trailers: HeaderMap) -> Result<(), UserError> {
1133        let mut me = self.opaque.inner.lock().unwrap();
1134        let me = &mut *me;
1135
1136        let stream = me.store.resolve(self.opaque.key);
1137        let actions = &mut me.actions;
1138        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1139        let send_buffer = &mut *send_buffer;
1140
1141        me.counts.transition(stream, |counts, stream| {
1142            // Create the trailers frame
1143            let frame = frame::Headers::trailers(stream.id, trailers);
1144
1145            // Send the trailers frame
1146            actions
1147                .send
1148                .send_trailers(frame, send_buffer, stream, counts, &mut actions.task)
1149        })
1150    }
1151
1152    pub fn send_reset(&mut self, reason: Reason) {
1153        let mut me = self.opaque.inner.lock().unwrap();
1154        let me = &mut *me;
1155
1156        let stream = me.store.resolve(self.opaque.key);
1157        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1158        let send_buffer = &mut *send_buffer;
1159
1160        match me
1161            .actions
1162            .send_reset(stream, reason, Initiator::User, &mut me.counts, send_buffer)
1163        {
1164            Ok(()) => (),
1165            Err(crate::proto::error::GoAway { .. }) => {
1166                // this should never happen, because Initiator::User resets do
1167                // not count toward the local limit.
1168                // we could perhaps make this state impossible, if we made the
1169                // initiator argument a generic, and so this could return
1170                // Infallible instead of an impossible GoAway, but oh well.
1171                unreachable!("Initiator::User should not error sending reset");
1172            }
1173        }
1174    }
1175
1176    pub fn send_informational_headers(&mut self, frame: frame::Headers) -> Result<(), UserError> {
1177        let mut me = self.opaque.inner.lock().unwrap();
1178        let me = &mut *me;
1179
1180        let stream = me.store.resolve(self.opaque.key);
1181        let actions = &mut me.actions;
1182        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1183        let send_buffer = &mut *send_buffer;
1184
1185        me.counts.transition(stream, |counts, stream| {
1186            // For informational responses (1xx), we need to send headers without
1187            // changing the stream state. This allows multiple informational responses
1188            // to be sent before the final response.
1189
1190            // Validate that this is actually an informational response
1191            debug_assert!(
1192                frame.is_informational(),
1193                "Frame must be informational after conversion from informational response"
1194            );
1195
1196            // Ensure the frame is not marked as end_stream for informational responses
1197            if frame.is_end_stream() {
1198                return Err(UserError::UnexpectedFrameType);
1199            }
1200
1201            // Send the interim informational headers directly to the buffer without state changes
1202            // This bypasses the normal send_headers flow that would transition the stream state
1203            actions.send.send_interim_informational_headers(
1204                frame,
1205                send_buffer,
1206                stream,
1207                counts,
1208                &mut actions.task,
1209            )
1210        })
1211    }
1212
1213    pub fn send_response(
1214        &mut self,
1215        mut response: Response<()>,
1216        end_of_stream: bool,
1217    ) -> Result<(), UserError> {
1218        // Clear before taking lock, incase extensions contain a StreamRef.
1219        response.extensions_mut().clear();
1220        let mut me = self.opaque.inner.lock().unwrap();
1221        let me = &mut *me;
1222
1223        let stream = me.store.resolve(self.opaque.key);
1224        let actions = &mut me.actions;
1225        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1226        let send_buffer = &mut *send_buffer;
1227
1228        me.counts.transition(stream, |counts, stream| {
1229            let frame = server::Peer::convert_send_message(stream.id, response, end_of_stream);
1230
1231            actions
1232                .send
1233                .send_headers(frame, send_buffer, stream, counts, &mut actions.task)
1234        })
1235    }
1236
1237    pub fn send_push_promise(
1238        &mut self,
1239        mut request: Request<()>,
1240    ) -> Result<StreamRef<B>, UserError> {
1241        // Clear before taking lock, incase extensions contain a StreamRef.
1242        request.extensions_mut().clear();
1243        let mut me = self.opaque.inner.lock().unwrap();
1244        let me = &mut *me;
1245
1246        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1247        let send_buffer = &mut *send_buffer;
1248
1249        let actions = &mut me.actions;
1250        let promised_id = actions.send.reserve_local()?;
1251
1252        let child_key = {
1253            let mut child_stream = me.store.insert(
1254                promised_id,
1255                Stream::new(
1256                    promised_id,
1257                    actions.send.init_window_sz(),
1258                    actions.recv.init_window_sz(),
1259                ),
1260            );
1261            child_stream.state.reserve_local()?;
1262            child_stream.is_pending_push = true;
1263            child_stream.key()
1264        };
1265
1266        let pushed = {
1267            let mut stream = me.store.resolve(self.opaque.key);
1268
1269            let frame = crate::server::Peer::convert_push_message(stream.id, promised_id, request)?;
1270
1271            actions
1272                .send
1273                .send_push_promise(frame, send_buffer, &mut stream, &mut actions.task)
1274        };
1275
1276        if let Err(err) = pushed {
1277            let mut child_stream = me.store.resolve(child_key);
1278            child_stream.unlink();
1279            child_stream.remove();
1280            return Err(err);
1281        }
1282
1283        me.refs += 1;
1284        let opaque =
1285            OpaqueStreamRef::new(self.opaque.inner.clone(), &mut me.store.resolve(child_key));
1286
1287        Ok(StreamRef {
1288            opaque,
1289            send_buffer: self.send_buffer.clone(),
1290        })
1291    }
1292
1293    /// Called by the server after the stream is accepted. Given that clients
1294    /// initialize streams by sending HEADERS, the request will always be
1295    /// available.
1296    ///
1297    /// # Panics
1298    ///
1299    /// This function panics if the request isn't present.
1300    pub fn take_request(&self) -> Request<()> {
1301        let mut me = self.opaque.inner.lock().unwrap();
1302        let me = &mut *me;
1303
1304        let mut stream = me.store.resolve(self.opaque.key);
1305        me.actions.recv.take_request(&mut stream)
1306    }
1307
1308    /// Called by a client to see if the current stream is pending open
1309    pub fn is_pending_open(&self) -> bool {
1310        let mut me = self.opaque.inner.lock().unwrap();
1311        me.store.resolve(self.opaque.key).is_pending_open
1312    }
1313
1314    /// Request capacity to send data
1315    pub fn reserve_capacity(&mut self, capacity: WindowSize) {
1316        let mut me = self.opaque.inner.lock().unwrap();
1317        let me = &mut *me;
1318
1319        let mut stream = me.store.resolve(self.opaque.key);
1320
1321        me.actions
1322            .send
1323            .reserve_capacity(capacity, &mut stream, &mut me.counts)
1324    }
1325
1326    /// Returns the stream's current send capacity.
1327    pub fn capacity(&self) -> WindowSize {
1328        let mut me = self.opaque.inner.lock().unwrap();
1329        let me = &mut *me;
1330
1331        let mut stream = me.store.resolve(self.opaque.key);
1332
1333        me.actions.send.capacity(&mut stream)
1334    }
1335
1336    /// Request to be notified when the stream's capacity increases
1337    pub fn poll_capacity(&mut self, cx: &Context) -> Poll<Option<Result<WindowSize, UserError>>> {
1338        let mut me = self.opaque.inner.lock().unwrap();
1339        let me = &mut *me;
1340
1341        let mut stream = me.store.resolve(self.opaque.key);
1342
1343        me.actions.send.poll_capacity(cx, &mut stream)
1344    }
1345
1346    /// Request to be notified for if a `RST_STREAM` is received for this stream.
1347    pub(crate) fn poll_reset(
1348        &mut self,
1349        cx: &Context,
1350        mode: proto::PollReset,
1351    ) -> Poll<Result<Reason, crate::Error>> {
1352        let mut me = self.opaque.inner.lock().unwrap();
1353        let me = &mut *me;
1354
1355        let mut stream = me.store.resolve(self.opaque.key);
1356
1357        me.actions.send.poll_reset(cx, &mut stream, mode)
1358    }
1359
1360    pub fn clone_to_opaque(&self) -> OpaqueStreamRef {
1361        self.opaque.clone()
1362    }
1363
1364    pub fn stream_id(&self) -> StreamId {
1365        self.opaque.stream_id()
1366    }
1367}
1368
1369impl<B> Clone for StreamRef<B> {
1370    fn clone(&self) -> Self {
1371        StreamRef {
1372            opaque: self.opaque.clone(),
1373            send_buffer: self.send_buffer.clone(),
1374        }
1375    }
1376}
1377
1378// ===== impl OpaqueStreamRef =====
1379
1380impl OpaqueStreamRef {
1381    fn new(inner: Arc<Mutex<Inner>>, stream: &mut store::Ptr) -> OpaqueStreamRef {
1382        stream.ref_inc();
1383        OpaqueStreamRef {
1384            inner,
1385            key: stream.key(),
1386        }
1387    }
1388    /// Called by a client to check for a received response.
1389    pub fn poll_response(&mut self, cx: &Context) -> Poll<Result<Response<()>, proto::Error>> {
1390        let mut me = self.inner.lock().unwrap();
1391        let me = &mut *me;
1392
1393        let mut stream = me.store.resolve(self.key);
1394
1395        me.actions.recv.poll_response(cx, &mut stream)
1396    }
1397
1398    /// Called by a client to check for informational responses (1xx status codes)
1399    pub fn poll_informational(
1400        &mut self,
1401        cx: &Context,
1402    ) -> Poll<Option<Result<Response<()>, proto::Error>>> {
1403        let mut me = self.inner.lock().unwrap();
1404        let me = &mut *me;
1405
1406        let mut stream = me.store.resolve(self.key);
1407
1408        me.actions.recv.poll_informational(cx, &mut stream)
1409    }
1410    /// Called by a client to check for a pushed request.
1411    pub fn poll_pushed(
1412        &mut self,
1413        cx: &Context,
1414    ) -> Poll<Option<Result<(Request<()>, OpaqueStreamRef), proto::Error>>> {
1415        let mut me = self.inner.lock().unwrap();
1416        let me = &mut *me;
1417
1418        let mut stream = me.store.resolve(self.key);
1419        me.actions
1420            .recv
1421            .poll_pushed(cx, &mut stream)
1422            .map_ok(|(h, key)| {
1423                me.refs += 1;
1424                let opaque_ref =
1425                    OpaqueStreamRef::new(self.inner.clone(), &mut me.store.resolve(key));
1426                (h, opaque_ref)
1427            })
1428    }
1429
1430    pub fn is_end_stream(&self) -> bool {
1431        let mut me = self.inner.lock().unwrap();
1432        let me = &mut *me;
1433
1434        let stream = me.store.resolve(self.key);
1435
1436        me.actions.recv.is_end_stream(&stream)
1437    }
1438
1439    pub fn poll_data(&mut self, cx: &Context) -> Poll<Option<Result<Bytes, proto::Error>>> {
1440        let mut me = self.inner.lock().unwrap();
1441        let me = &mut *me;
1442
1443        let mut stream = me.store.resolve(self.key);
1444
1445        me.actions.recv.poll_data(cx, &mut stream)
1446    }
1447
1448    pub fn poll_trailers(&mut self, cx: &Context) -> Poll<Option<Result<HeaderMap, proto::Error>>> {
1449        let mut me = self.inner.lock().unwrap();
1450        let me = &mut *me;
1451
1452        let mut stream = me.store.resolve(self.key);
1453
1454        me.actions.recv.poll_trailers(cx, &mut stream)
1455    }
1456
1457    pub(crate) fn available_recv_capacity(&self) -> isize {
1458        let me = self.inner.lock().unwrap();
1459        let me = &*me;
1460
1461        let stream = &me.store[self.key];
1462        stream.recv_flow.available().into()
1463    }
1464
1465    pub(crate) fn used_recv_capacity(&self) -> WindowSize {
1466        let me = self.inner.lock().unwrap();
1467        let me = &*me;
1468
1469        let stream = &me.store[self.key];
1470        stream.in_flight_recv_data
1471    }
1472
1473    /// Releases recv capacity back to the peer. This may result in sending
1474    /// WINDOW_UPDATE frames on both the stream and connection.
1475    pub fn release_capacity(&mut self, capacity: WindowSize) -> Result<(), UserError> {
1476        let mut me = self.inner.lock().unwrap();
1477        let me = &mut *me;
1478
1479        let mut stream = me.store.resolve(self.key);
1480
1481        me.actions
1482            .recv
1483            .release_capacity(capacity, &mut stream, &mut me.actions.task)
1484    }
1485
1486    /// Clear the receive queue and set the status to no longer receive data frames.
1487    pub(crate) fn clear_recv_buffer(&mut self) {
1488        let mut me = self.inner.lock().unwrap();
1489        let me = &mut *me;
1490
1491        let mut stream = me.store.resolve(self.key);
1492        stream.is_recv = false;
1493        me.actions.recv.clear_recv_buffer(&mut stream);
1494    }
1495
1496    pub fn stream_id(&self) -> StreamId {
1497        self.inner.lock().unwrap().store[self.key].id
1498    }
1499}
1500
1501impl fmt::Debug for OpaqueStreamRef {
1502    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1503        use std::sync::TryLockError::*;
1504
1505        match self.inner.try_lock() {
1506            Ok(me) => {
1507                let stream = &me.store[self.key];
1508                fmt.debug_struct("OpaqueStreamRef")
1509                    .field("stream_id", &stream.id)
1510                    .field("ref_count", &stream.ref_count)
1511                    .finish()
1512            }
1513            Err(Poisoned(_)) => fmt
1514                .debug_struct("OpaqueStreamRef")
1515                .field("inner", &"<Poisoned>")
1516                .finish(),
1517            Err(WouldBlock) => fmt
1518                .debug_struct("OpaqueStreamRef")
1519                .field("inner", &"<Locked>")
1520                .finish(),
1521        }
1522    }
1523}
1524
1525impl Clone for OpaqueStreamRef {
1526    fn clone(&self) -> Self {
1527        // Increment the ref count
1528        let mut inner = self.inner.lock().unwrap();
1529        inner.store.resolve(self.key).ref_inc();
1530        inner.refs += 1;
1531
1532        OpaqueStreamRef {
1533            inner: self.inner.clone(),
1534            key: self.key,
1535        }
1536    }
1537}
1538
1539impl Drop for OpaqueStreamRef {
1540    fn drop(&mut self) {
1541        drop_stream_ref(&self.inner, self.key);
1542    }
1543}
1544
1545// TODO: Move back in fn above
1546fn drop_stream_ref(inner: &Mutex<Inner>, key: store::Key) {
1547    let mut me = match inner.lock() {
1548        Ok(inner) => inner,
1549        Err(_) => {
1550            if ::std::thread::panicking() {
1551                tracing::trace!("StreamRef::drop; mutex poisoned");
1552                return;
1553            } else {
1554                panic!("StreamRef::drop; mutex poisoned");
1555            }
1556        }
1557    };
1558
1559    let me = &mut *me;
1560    me.refs -= 1;
1561    let mut stream = me.store.resolve(key);
1562
1563    tracing::trace!("drop_stream_ref; stream={:?}", stream);
1564
1565    // decrement the stream's ref count by 1.
1566    stream.ref_dec();
1567
1568    let actions = &mut me.actions;
1569
1570    // If the stream is not referenced and it is already
1571    // closed (does not have to go through logic below
1572    // of canceling the stream), we should notify the task
1573    // (connection) so that it can close properly
1574    if stream.ref_count == 0 && stream.is_closed() {
1575        if let Some(task) = actions.task.take() {
1576            task.wake();
1577        }
1578    }
1579
1580    me.counts.transition(stream, |counts, stream| {
1581        maybe_cancel(stream, actions, counts);
1582
1583        if stream.ref_count == 0 {
1584            // Release any recv window back to connection, no one can access
1585            // it anymore.
1586            actions
1587                .recv
1588                .release_closed_capacity(stream, &mut actions.task);
1589
1590            // We won't be able to reach our push promises anymore
1591            let mut ppp = stream.pending_push_promises.take();
1592            while let Some(promise) = ppp.pop(stream.store_mut()) {
1593                counts.transition(promise, |counts, stream| {
1594                    maybe_cancel(stream, actions, counts);
1595                });
1596            }
1597        }
1598    });
1599}
1600
1601fn maybe_cancel(stream: &mut store::Ptr, actions: &mut Actions, counts: &mut Counts) {
1602    if stream.is_canceled_interest() {
1603        // Server is allowed to early respond without fully consuming the client input stream
1604        // But per the RFC, must send a RST_STREAM(NO_ERROR) in such cases. https://www.rfc-editor.org/rfc/rfc7540#section-8.1
1605        // Some other http2 implementation may interpret other error code as fatal if not respected (i.e: nginx https://trac.nginx.org/nginx/ticket/2376)
1606        let reason = if counts.peer().is_server()
1607            && stream.state.is_send_closed()
1608            && stream.state.is_recv_streaming()
1609        {
1610            Reason::NO_ERROR
1611        } else {
1612            Reason::CANCEL
1613        };
1614
1615        actions
1616            .send
1617            .schedule_implicit_reset(stream, reason, counts, &mut actions.task);
1618        actions.recv.enqueue_reset_expiration(stream, counts);
1619    }
1620}
1621
1622// ===== impl SendBuffer =====
1623
1624impl<B> SendBuffer<B> {
1625    fn new() -> Self {
1626        let inner = Mutex::new(Buffer::new());
1627        SendBuffer { inner }
1628    }
1629
1630    pub fn is_empty(&self) -> bool {
1631        let buf = self.inner.lock().unwrap();
1632        buf.is_empty()
1633    }
1634}
1635
1636// ===== impl Actions =====
1637
1638impl Actions {
1639    fn send_reset<B>(
1640        &mut self,
1641        stream: store::Ptr,
1642        reason: Reason,
1643        initiator: Initiator,
1644        counts: &mut Counts,
1645        send_buffer: &mut Buffer<Frame<B>>,
1646    ) -> Result<(), crate::proto::error::GoAway> {
1647        counts.transition(stream, |counts, stream| {
1648            if initiator.is_library() {
1649                if counts.can_inc_num_local_error_resets() {
1650                    counts.inc_num_local_error_resets();
1651                } else {
1652                    tracing::warn!(
1653                        "locally-reset streams reached limit ({:?})",
1654                        counts.max_local_error_resets().unwrap(),
1655                    );
1656                    return Err(crate::proto::error::GoAway {
1657                        reason: Reason::ENHANCE_YOUR_CALM,
1658                        debug_data: "too_many_internal_resets".into(),
1659                    });
1660                }
1661            }
1662
1663            self.send.send_reset(
1664                reason,
1665                initiator,
1666                send_buffer,
1667                stream,
1668                counts,
1669                &mut self.task,
1670            );
1671            self.recv.enqueue_reset_expiration(stream, counts);
1672            // if a RecvStream is parked, ensure it's notified
1673            stream.notify_recv();
1674
1675            Ok(())
1676        })
1677    }
1678
1679    fn reset_on_recv_stream_err<B>(
1680        &mut self,
1681        buffer: &mut Buffer<Frame<B>>,
1682        stream: &mut store::Ptr,
1683        counts: &mut Counts,
1684        res: Result<(), Error>,
1685    ) -> Result<(), Error> {
1686        if let Err(Error::Reset(stream_id, reason, initiator)) = res {
1687            debug_assert_eq!(stream_id, stream.id);
1688
1689            if counts.can_inc_num_local_error_resets() {
1690                counts.inc_num_local_error_resets();
1691
1692                // Reset the stream.
1693                self.send
1694                    .send_reset(reason, initiator, buffer, stream, counts, &mut self.task);
1695                self.recv.enqueue_reset_expiration(stream, counts);
1696                // if a RecvStream is parked, ensure it's notified
1697                stream.notify_recv();
1698                Ok(())
1699            } else {
1700                tracing::warn!(
1701                    "reset_on_recv_stream_err; locally-reset streams reached limit ({:?})",
1702                    counts.max_local_error_resets().unwrap(),
1703                );
1704                Err(Error::library_go_away_data(
1705                    Reason::ENHANCE_YOUR_CALM,
1706                    "too_many_internal_resets",
1707                ))
1708            }
1709        } else {
1710            res
1711        }
1712    }
1713
1714    fn ensure_not_idle(&mut self, peer: peer::Dyn, id: StreamId) -> Result<(), Reason> {
1715        if peer.is_local_init(id) {
1716            self.send.ensure_not_idle(id)
1717        } else {
1718            self.recv.ensure_not_idle(id)
1719        }
1720    }
1721
1722    fn ensure_no_conn_error(&self) -> Result<(), proto::Error> {
1723        if let Some(ref err) = self.conn_error {
1724            Err(err.clone())
1725        } else {
1726            Ok(())
1727        }
1728    }
1729
1730    /// Check if we possibly could have processed and since forgotten this stream.
1731    ///
1732    /// If we send a RST_STREAM for a stream, we will eventually "forget" about
1733    /// the stream to free up memory. It's possible that the remote peer had
1734    /// frames in-flight, and by the time we receive them, our own state is
1735    /// gone. We *could* tear everything down by sending a GOAWAY, but it
1736    /// is more likely to be latency/memory constraints that caused this,
1737    /// and not a bad actor. So be less catastrophic, the spec allows
1738    /// us to send another RST_STREAM of STREAM_CLOSED.
1739    fn may_have_forgotten_stream(&self, peer: peer::Dyn, id: StreamId) -> bool {
1740        if id.is_zero() {
1741            return false;
1742        }
1743        if peer.is_local_init(id) {
1744            self.send.may_have_created_stream(id)
1745        } else {
1746            self.recv.may_have_created_stream(id)
1747        }
1748    }
1749
1750    fn clear_queues(&mut self, clear_pending_accept: bool, store: &mut Store, counts: &mut Counts) {
1751        self.recv.clear_queues(clear_pending_accept, store, counts);
1752        self.send.clear_queues(store, counts);
1753    }
1754}