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.state.is_local_error() {
482            // Locally reset streams must ignore frames "for some time".
483            // This is because the remote may have sent trailers before
484            // receiving the RST_STREAM frame.
485            tracing::trace!("recv_headers; ignoring trailers on {:?}", stream.id);
486            return Ok(());
487        }
488
489        let actions = &mut self.actions;
490        let mut send_buffer = send_buffer.inner.lock().unwrap();
491        let send_buffer = &mut *send_buffer;
492
493        self.counts.transition(stream, |counts, stream| {
494            tracing::trace!(
495                "recv_headers; stream={:?}; state={:?}",
496                stream.id,
497                stream.state
498            );
499
500            let res = if stream.state.is_recv_headers() {
501                match actions.recv.recv_headers(frame, stream, counts) {
502                    Ok(()) => Ok(()),
503                    Err(RecvHeaderBlockError::Oversize(resp)) => {
504                        if let Some(resp) = resp {
505                            let sent = actions.send.send_headers(
506                                resp, send_buffer, stream, counts, &mut actions.task);
507                            debug_assert!(sent.is_ok(), "oversize response should not fail");
508
509                            actions.send.schedule_implicit_reset(
510                                stream,
511                                Reason::PROTOCOL_ERROR,
512                                counts,
513                                &mut actions.task);
514
515                            actions.recv.enqueue_reset_expiration(stream, counts);
516
517                            Ok(())
518                        } else {
519                            Err(Error::library_reset(stream.id, Reason::PROTOCOL_ERROR))
520                        }
521                    },
522                    Err(RecvHeaderBlockError::State(err)) => Err(err),
523                }
524            } else {
525                if !frame.is_end_stream() {
526                    // Receiving trailers that don't set EOS is a "malformed"
527                    // message. Malformed messages are a stream error.
528                    proto_err!(stream: "recv_headers: trailers frame was not EOS; stream={:?}", stream.id);
529                    return Err(Error::library_reset(stream.id, Reason::PROTOCOL_ERROR));
530                }
531
532                actions.recv.recv_trailers(frame, stream)
533            };
534
535            actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
536        })
537    }
538
539    fn recv_data<B>(
540        &mut self,
541        peer: peer::Dyn,
542        send_buffer: &SendBuffer<B>,
543        frame: frame::Data,
544    ) -> Result<(), Error> {
545        let id = frame.stream_id();
546
547        let stream = match self.store.find_mut(&id) {
548            Some(stream) => stream,
549            None => {
550                // The GOAWAY process has begun. All streams with a greater ID
551                // than specified as part of GOAWAY should be ignored.
552                if id > self.actions.recv.max_stream_id() {
553                    tracing::trace!(
554                        "id ({:?}) > max_stream_id ({:?}), ignoring DATA",
555                        id,
556                        self.actions.recv.max_stream_id()
557                    );
558
559                    // We still need to account for connection-level flow control.
560                    let sz = frame.flow_controlled_len();
561                    assert!(sz <= super::MAX_WINDOW_SIZE as usize);
562                    let sz = sz as WindowSize;
563                    self.actions.recv.ignore_data(sz)?;
564
565                    return Ok(());
566                }
567
568                if self.actions.may_have_forgotten_stream(peer, id) {
569                    tracing::debug!("recv_data for old stream={:?}, sending STREAM_CLOSED", id,);
570
571                    let sz = frame.flow_controlled_len();
572                    // This should have been enforced at the codec::FramedRead layer, so
573                    // this is just a sanity check.
574                    assert!(sz <= super::MAX_WINDOW_SIZE as usize);
575                    let sz = sz as WindowSize;
576                    self.actions.recv.ignore_data(sz)?;
577
578                    return Err(Error::library_reset(id, Reason::STREAM_CLOSED));
579                }
580
581                proto_err!(conn: "recv_data: stream not found; id={:?}", id);
582                return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
583            }
584        };
585
586        let actions = &mut self.actions;
587        let mut send_buffer = send_buffer.inner.lock().unwrap();
588        let send_buffer = &mut *send_buffer;
589
590        self.counts.transition(stream, |counts, stream| {
591            let sz = frame.flow_controlled_len();
592            let res = actions.recv.recv_data(frame, stream);
593
594            // Any stream error after receiving a DATA frame means
595            // we won't give the data to the user, and so they can't
596            // release the capacity. We do it automatically.
597            if let Err(Error::Reset(..)) = res {
598                actions
599                    .recv
600                    .release_connection_capacity(sz as WindowSize, &mut None);
601            }
602            actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
603        })
604    }
605
606    fn recv_reset<B>(
607        &mut self,
608        send_buffer: &SendBuffer<B>,
609        frame: frame::Reset,
610    ) -> Result<(), Error> {
611        let id = frame.stream_id();
612
613        if id.is_zero() {
614            proto_err!(conn: "recv_reset: invalid stream ID 0");
615            return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
616        }
617
618        // The GOAWAY process has begun. All streams with a greater ID than
619        // specified as part of GOAWAY should be ignored.
620        if id > self.actions.recv.max_stream_id() {
621            tracing::trace!(
622                "id ({:?}) > max_stream_id ({:?}), ignoring RST_STREAM",
623                id,
624                self.actions.recv.max_stream_id()
625            );
626            return Ok(());
627        }
628
629        let stream = match self.store.find_mut(&id) {
630            Some(stream) => stream,
631            None => {
632                // TODO: Are there other error cases?
633                self.actions
634                    .ensure_not_idle(self.counts.peer(), id)
635                    .map_err(Error::library_go_away)?;
636
637                return Ok(());
638            }
639        };
640
641        let mut send_buffer = send_buffer.inner.lock().unwrap();
642        let send_buffer = &mut *send_buffer;
643
644        let actions = &mut self.actions;
645
646        self.counts.transition(stream, |counts, stream| {
647            actions.recv.recv_reset(frame, stream, counts)?;
648            actions.send.handle_error(send_buffer, stream, counts);
649            assert!(stream.state.is_closed());
650            Ok(())
651        })
652    }
653
654    fn recv_window_update<B>(
655        &mut self,
656        send_buffer: &SendBuffer<B>,
657        frame: frame::WindowUpdate,
658    ) -> Result<(), Error> {
659        let id = frame.stream_id();
660
661        let mut send_buffer = send_buffer.inner.lock().unwrap();
662        let send_buffer = &mut *send_buffer;
663
664        if id.is_zero() {
665            self.actions
666                .send
667                .recv_connection_window_update(frame, &mut self.store, &mut self.counts)
668                .map_err(Error::library_go_away)?;
669        } else {
670            // The remote may send window updates for streams that the local now
671            // considers closed. It's ok...
672            if let Some(mut stream) = self.store.find_mut(&id) {
673                let res = self
674                    .actions
675                    .send
676                    .recv_stream_window_update(
677                        frame.size_increment(),
678                        send_buffer,
679                        &mut stream,
680                        &mut self.counts,
681                        &mut self.actions.task,
682                    )
683                    .map_err(|reason| Error::library_reset(id, reason));
684
685                return self.actions.reset_on_recv_stream_err(
686                    send_buffer,
687                    &mut stream,
688                    &mut self.counts,
689                    res,
690                );
691            } else {
692                self.actions
693                    .ensure_not_idle(self.counts.peer(), id)
694                    .map_err(Error::library_go_away)?;
695            }
696        }
697
698        Ok(())
699    }
700
701    fn handle_error<B>(&mut self, send_buffer: &SendBuffer<B>, err: proto::Error) -> StreamId {
702        let actions = &mut self.actions;
703        let counts = &mut self.counts;
704        let mut send_buffer = send_buffer.inner.lock().unwrap();
705        let send_buffer = &mut *send_buffer;
706
707        let last_processed_id = actions.recv.last_processed_id();
708
709        self.store.for_each(|stream| {
710            counts.transition(stream, |counts, stream| {
711                actions.recv.handle_error(&err, &mut *stream);
712                actions.send.handle_error(send_buffer, stream, counts);
713            })
714        });
715
716        actions.conn_error = Some(err);
717
718        last_processed_id
719    }
720
721    fn recv_go_away<B>(
722        &mut self,
723        send_buffer: &SendBuffer<B>,
724        frame: &frame::GoAway,
725    ) -> Result<(), Error> {
726        let actions = &mut self.actions;
727        let counts = &mut self.counts;
728        let mut send_buffer = send_buffer.inner.lock().unwrap();
729        let send_buffer = &mut *send_buffer;
730
731        let last_stream_id = frame.last_stream_id();
732
733        actions.send.recv_go_away(last_stream_id)?;
734
735        let err = Error::remote_go_away(frame.debug_data().clone(), frame.reason());
736
737        let peer = counts.peer();
738        self.store.for_each(|stream| {
739            if stream.id > last_stream_id && peer.is_local_init(stream.id) {
740                counts.transition(stream, |counts, stream| {
741                    actions.recv.handle_error(&err, &mut *stream);
742                    actions.send.handle_error(send_buffer, stream, counts);
743                })
744            }
745        });
746
747        actions.conn_error = Some(err);
748
749        Ok(())
750    }
751
752    fn recv_push_promise<B>(
753        &mut self,
754        send_buffer: &SendBuffer<B>,
755        frame: frame::PushPromise,
756    ) -> Result<(), Error> {
757        let id = frame.stream_id();
758        let promised_id = frame.promised_id();
759
760        // First, ensure that the initiating stream is still in a valid state.
761        let parent_key = match self.store.find_mut(&id) {
762            Some(stream) => {
763                // The GOAWAY process has begun. All streams with a greater ID
764                // than specified as part of GOAWAY should be ignored.
765                if id > self.actions.recv.max_stream_id() {
766                    tracing::trace!(
767                        "id ({:?}) > max_stream_id ({:?}), ignoring PUSH_PROMISE",
768                        id,
769                        self.actions.recv.max_stream_id()
770                    );
771                    return Ok(());
772                }
773
774                // The stream must be receive open
775                if !stream.state.ensure_recv_open()? {
776                    proto_err!(conn: "recv_push_promise: initiating stream is not opened");
777                    return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
778                }
779
780                stream.key()
781            }
782            None => {
783                proto_err!(conn: "recv_push_promise: initiating stream is in an invalid state");
784                return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
785            }
786        };
787
788        // TODO: Streams in the reserved states do not count towards the concurrency
789        // limit. However, it seems like there should be a cap otherwise this
790        // could grow in memory indefinitely.
791
792        // Ensure that we can reserve streams
793        self.actions.recv.ensure_can_reserve()?;
794
795        // Next, open the stream.
796        //
797        // If `None` is returned, then the stream is being refused. There is no
798        // further work to be done.
799        if self
800            .actions
801            .recv
802            .open(promised_id, Open::PushPromise, &mut self.counts)?
803            .is_none()
804        {
805            return Ok(());
806        }
807
808        // Try to handle the frame and create a corresponding key for the pushed stream
809        // this requires a bit of indirection to make the borrow checker happy.
810        let child_key: Option<store::Key> = {
811            // Create state for the stream
812            let stream = self.store.insert(promised_id, {
813                Stream::new(
814                    promised_id,
815                    self.actions.send.init_window_sz(),
816                    self.actions.recv.init_window_sz(),
817                )
818            });
819
820            let actions = &mut self.actions;
821
822            self.counts.transition(stream, |counts, stream| {
823                let stream_valid = actions.recv.recv_push_promise(frame, stream);
824
825                match stream_valid {
826                    Ok(()) => Ok(Some(stream.key())),
827                    _ => {
828                        let mut send_buffer = send_buffer.inner.lock().unwrap();
829                        actions
830                            .reset_on_recv_stream_err(
831                                &mut *send_buffer,
832                                stream,
833                                counts,
834                                stream_valid,
835                            )
836                            .map(|()| None)
837                    }
838                }
839            })?
840        };
841        // If we're successful, push the headers and stream...
842        if let Some(child) = child_key {
843            let mut ppp = self.store[parent_key].pending_push_promises.take();
844            ppp.push(&mut self.store.resolve(child));
845
846            let parent = &mut self.store.resolve(parent_key);
847            parent.pending_push_promises = ppp;
848            parent.notify_push();
849        };
850
851        Ok(())
852    }
853
854    fn recv_eof<B>(
855        &mut self,
856        send_buffer: &SendBuffer<B>,
857        clear_pending_accept: bool,
858    ) -> Result<(), ()> {
859        let actions = &mut self.actions;
860        let counts = &mut self.counts;
861        let mut send_buffer = send_buffer.inner.lock().unwrap();
862        let send_buffer = &mut *send_buffer;
863
864        if actions.conn_error.is_none() {
865            actions.conn_error = Some(
866                io::Error::new(
867                    io::ErrorKind::BrokenPipe,
868                    "connection closed because of a broken pipe",
869                )
870                .into(),
871            );
872        }
873
874        tracing::trace!("Streams::recv_eof");
875
876        self.store.for_each(|stream| {
877            counts.transition(stream, |counts, stream| {
878                actions.recv.recv_eof(stream);
879
880                // This handles resetting send state associated with the
881                // stream
882                actions.send.handle_error(send_buffer, stream, counts);
883            })
884        });
885
886        actions.clear_queues(clear_pending_accept, &mut self.store, counts);
887        Ok(())
888    }
889
890    fn poll_complete<T, B>(
891        &mut self,
892        send_buffer: &SendBuffer<B>,
893        cx: &mut Context,
894        dst: &mut Codec<T, Prioritized<B>>,
895    ) -> Poll<io::Result<()>>
896    where
897        T: AsyncWrite + Unpin,
898        B: Buf,
899    {
900        let mut send_buffer = send_buffer.inner.lock().unwrap();
901        let send_buffer = &mut *send_buffer;
902
903        // Send WINDOW_UPDATE frames first
904        //
905        // TODO: It would probably be better to interleave updates w/ data
906        // frames.
907        ready!(self
908            .actions
909            .recv
910            .poll_complete(cx, &mut self.store, &mut self.counts, dst))?;
911
912        // Send any other pending frames
913        ready!(self.actions.send.poll_complete(
914            cx,
915            send_buffer,
916            &mut self.store,
917            &mut self.counts,
918            dst
919        ))?;
920
921        // Nothing else to do, track the task
922        self.actions.task = Some(cx.waker().clone());
923
924        Poll::Ready(Ok(()))
925    }
926
927    fn send_reset<B>(
928        &mut self,
929        send_buffer: &SendBuffer<B>,
930        id: StreamId,
931        reason: Reason,
932    ) -> Result<(), crate::proto::error::GoAway> {
933        let key = match self.store.find_entry(id) {
934            Entry::Occupied(e) => e.key(),
935            Entry::Vacant(e) => {
936                // Resetting a stream we don't know about? That could be OK...
937                //
938                // 1. As a server, we just received a request, but that request
939                //    was bad, so we're resetting before even accepting it.
940                //    This is totally fine.
941                //
942                // 2. The remote may have sent us a frame on new stream that
943                //    it's *not* supposed to have done, and thus, we don't know
944                //    the stream. In that case, sending a reset will "open" the
945                //    stream in our store. Maybe that should be a connection
946                //    error instead? At least for now, we need to update what
947                //    our vision of the next stream is.
948                if self.counts.peer().is_local_init(id) {
949                    // We normally would open this stream, so update our
950                    // next-send-id record.
951                    self.actions.send.maybe_reset_next_stream_id(id);
952                } else {
953                    // We normally would recv this stream, so update our
954                    // next-recv-id record.
955                    self.actions.recv.maybe_reset_next_stream_id(id);
956                }
957
958                let stream = Stream::new(id, 0, 0);
959
960                e.insert(stream)
961            }
962        };
963
964        let stream = self.store.resolve(key);
965        let mut send_buffer = send_buffer.inner.lock().unwrap();
966        let send_buffer = &mut *send_buffer;
967        self.actions.send_reset(
968            stream,
969            reason,
970            Initiator::Library,
971            &mut self.counts,
972            send_buffer,
973        )
974    }
975}
976
977impl<B> Streams<B, client::Peer>
978where
979    B: Buf,
980{
981    pub fn poll_pending_open(
982        &mut self,
983        cx: &Context,
984        pending: Option<&OpaqueStreamRef>,
985    ) -> Poll<Result<(), crate::Error>> {
986        let mut me = self.inner.lock().unwrap();
987        let me = &mut *me;
988
989        me.actions.ensure_no_conn_error()?;
990        me.actions.send.ensure_next_stream_id()?;
991
992        if let Some(pending) = pending {
993            let mut stream = me.store.resolve(pending.key);
994            tracing::trace!("poll_pending_open; stream = {:?}", stream.is_pending_open);
995            if stream.is_pending_open {
996                stream.wait_send(cx);
997                return Poll::Pending;
998            }
999        }
1000        Poll::Ready(Ok(()))
1001    }
1002}
1003
1004impl<B, P> Streams<B, P>
1005where
1006    P: Peer,
1007{
1008    pub fn as_dyn(&self) -> DynStreams<'_, B> {
1009        let Self {
1010            inner,
1011            send_buffer,
1012            _p,
1013        } = self;
1014        DynStreams {
1015            inner,
1016            send_buffer,
1017            peer: P::r#dyn(),
1018        }
1019    }
1020
1021    /// This function is safe to call multiple times.
1022    ///
1023    /// A `Result` is returned to avoid panicking if the mutex is poisoned.
1024    pub fn recv_eof(&mut self, clear_pending_accept: bool) -> Result<(), ()> {
1025        self.as_dyn().recv_eof(clear_pending_accept)
1026    }
1027
1028    pub(crate) fn max_send_streams(&self) -> usize {
1029        self.inner.lock().unwrap().counts.max_send_streams()
1030    }
1031
1032    pub(crate) fn max_recv_streams(&self) -> usize {
1033        self.inner.lock().unwrap().counts.max_recv_streams()
1034    }
1035
1036    #[cfg(feature = "unstable")]
1037    pub fn num_active_streams(&self) -> usize {
1038        let me = self.inner.lock().unwrap();
1039        me.store.num_active_streams()
1040    }
1041
1042    pub fn has_streams(&self) -> bool {
1043        let me = self.inner.lock().unwrap();
1044        me.counts.has_streams()
1045    }
1046
1047    pub fn has_streams_or_other_references(&self) -> bool {
1048        let me = self.inner.lock().unwrap();
1049        me.counts.has_streams() || me.refs > 1
1050    }
1051
1052    #[cfg(feature = "unstable")]
1053    pub fn num_wired_streams(&self) -> usize {
1054        let me = self.inner.lock().unwrap();
1055        me.store.num_wired_streams()
1056    }
1057}
1058
1059// no derive because we don't need B and P to be Clone.
1060impl<B, P> Clone for Streams<B, P>
1061where
1062    P: Peer,
1063{
1064    fn clone(&self) -> Self {
1065        self.inner.lock().unwrap().refs += 1;
1066        Streams {
1067            inner: self.inner.clone(),
1068            send_buffer: self.send_buffer.clone(),
1069            _p: ::std::marker::PhantomData,
1070        }
1071    }
1072}
1073
1074impl<B, P> Drop for Streams<B, P>
1075where
1076    P: Peer,
1077{
1078    fn drop(&mut self) {
1079        if let Ok(mut inner) = self.inner.lock() {
1080            inner.refs -= 1;
1081            if inner.refs == 1 {
1082                if let Some(task) = inner.actions.task.take() {
1083                    task.wake();
1084                }
1085            }
1086        }
1087    }
1088}
1089
1090// ===== impl StreamRef =====
1091
1092impl<B> StreamRef<B> {
1093    pub fn send_data(&mut self, data: B, end_stream: bool) -> Result<(), UserError>
1094    where
1095        B: Buf,
1096    {
1097        let mut me = self.opaque.inner.lock().unwrap();
1098        let me = &mut *me;
1099
1100        let stream = me.store.resolve(self.opaque.key);
1101        let actions = &mut me.actions;
1102        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1103        let send_buffer = &mut *send_buffer;
1104
1105        me.counts.transition(stream, |counts, stream| {
1106            // Create the data frame
1107            let mut frame = frame::Data::new(stream.id, data);
1108            frame.set_end_stream(end_stream);
1109
1110            // Send the data frame
1111            actions
1112                .send
1113                .send_data(frame, send_buffer, stream, counts, &mut actions.task)
1114        })
1115    }
1116
1117    pub fn send_trailers(&mut self, trailers: HeaderMap) -> Result<(), UserError> {
1118        let mut me = self.opaque.inner.lock().unwrap();
1119        let me = &mut *me;
1120
1121        let stream = me.store.resolve(self.opaque.key);
1122        let actions = &mut me.actions;
1123        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1124        let send_buffer = &mut *send_buffer;
1125
1126        me.counts.transition(stream, |counts, stream| {
1127            // Create the trailers frame
1128            let frame = frame::Headers::trailers(stream.id, trailers);
1129
1130            // Send the trailers frame
1131            actions
1132                .send
1133                .send_trailers(frame, send_buffer, stream, counts, &mut actions.task)
1134        })
1135    }
1136
1137    pub fn send_reset(&mut self, reason: Reason) {
1138        let mut me = self.opaque.inner.lock().unwrap();
1139        let me = &mut *me;
1140
1141        let stream = me.store.resolve(self.opaque.key);
1142        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1143        let send_buffer = &mut *send_buffer;
1144
1145        match me
1146            .actions
1147            .send_reset(stream, reason, Initiator::User, &mut me.counts, send_buffer)
1148        {
1149            Ok(()) => (),
1150            Err(crate::proto::error::GoAway { .. }) => {
1151                // this should never happen, because Initiator::User resets do
1152                // not count toward the local limit.
1153                // we could perhaps make this state impossible, if we made the
1154                // initiator argument a generic, and so this could return
1155                // Infallible instead of an impossible GoAway, but oh well.
1156                unreachable!("Initiator::User should not error sending reset");
1157            }
1158        }
1159    }
1160
1161    pub fn send_informational_headers(&mut self, frame: frame::Headers) -> Result<(), UserError> {
1162        let mut me = self.opaque.inner.lock().unwrap();
1163        let me = &mut *me;
1164
1165        let stream = me.store.resolve(self.opaque.key);
1166        let actions = &mut me.actions;
1167        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1168        let send_buffer = &mut *send_buffer;
1169
1170        me.counts.transition(stream, |counts, stream| {
1171            // For informational responses (1xx), we need to send headers without
1172            // changing the stream state. This allows multiple informational responses
1173            // to be sent before the final response.
1174
1175            // Validate that this is actually an informational response
1176            debug_assert!(
1177                frame.is_informational(),
1178                "Frame must be informational after conversion from informational response"
1179            );
1180
1181            // Ensure the frame is not marked as end_stream for informational responses
1182            if frame.is_end_stream() {
1183                return Err(UserError::UnexpectedFrameType);
1184            }
1185
1186            // Send the interim informational headers directly to the buffer without state changes
1187            // This bypasses the normal send_headers flow that would transition the stream state
1188            actions.send.send_interim_informational_headers(
1189                frame,
1190                send_buffer,
1191                stream,
1192                counts,
1193                &mut actions.task,
1194            )
1195        })
1196    }
1197
1198    pub fn send_response(
1199        &mut self,
1200        mut response: Response<()>,
1201        end_of_stream: bool,
1202    ) -> Result<(), UserError> {
1203        // Clear before taking lock, incase extensions contain a StreamRef.
1204        response.extensions_mut().clear();
1205        let mut me = self.opaque.inner.lock().unwrap();
1206        let me = &mut *me;
1207
1208        let stream = me.store.resolve(self.opaque.key);
1209        let actions = &mut me.actions;
1210        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1211        let send_buffer = &mut *send_buffer;
1212
1213        me.counts.transition(stream, |counts, stream| {
1214            let frame = server::Peer::convert_send_message(stream.id, response, end_of_stream);
1215
1216            actions
1217                .send
1218                .send_headers(frame, send_buffer, stream, counts, &mut actions.task)
1219        })
1220    }
1221
1222    pub fn send_push_promise(
1223        &mut self,
1224        mut request: Request<()>,
1225    ) -> Result<StreamRef<B>, UserError> {
1226        // Clear before taking lock, incase extensions contain a StreamRef.
1227        request.extensions_mut().clear();
1228        let mut me = self.opaque.inner.lock().unwrap();
1229        let me = &mut *me;
1230
1231        let mut send_buffer = self.send_buffer.inner.lock().unwrap();
1232        let send_buffer = &mut *send_buffer;
1233
1234        let actions = &mut me.actions;
1235        let promised_id = actions.send.reserve_local()?;
1236
1237        let child_key = {
1238            let mut child_stream = me.store.insert(
1239                promised_id,
1240                Stream::new(
1241                    promised_id,
1242                    actions.send.init_window_sz(),
1243                    actions.recv.init_window_sz(),
1244                ),
1245            );
1246            child_stream.state.reserve_local()?;
1247            child_stream.is_pending_push = true;
1248            child_stream.key()
1249        };
1250
1251        let pushed = {
1252            let mut stream = me.store.resolve(self.opaque.key);
1253
1254            let frame = crate::server::Peer::convert_push_message(stream.id, promised_id, request)?;
1255
1256            actions
1257                .send
1258                .send_push_promise(frame, send_buffer, &mut stream, &mut actions.task)
1259        };
1260
1261        if let Err(err) = pushed {
1262            let mut child_stream = me.store.resolve(child_key);
1263            child_stream.unlink();
1264            child_stream.remove();
1265            return Err(err);
1266        }
1267
1268        me.refs += 1;
1269        let opaque =
1270            OpaqueStreamRef::new(self.opaque.inner.clone(), &mut me.store.resolve(child_key));
1271
1272        Ok(StreamRef {
1273            opaque,
1274            send_buffer: self.send_buffer.clone(),
1275        })
1276    }
1277
1278    /// Called by the server after the stream is accepted. Given that clients
1279    /// initialize streams by sending HEADERS, the request will always be
1280    /// available.
1281    ///
1282    /// # Panics
1283    ///
1284    /// This function panics if the request isn't present.
1285    pub fn take_request(&self) -> Request<()> {
1286        let mut me = self.opaque.inner.lock().unwrap();
1287        let me = &mut *me;
1288
1289        let mut stream = me.store.resolve(self.opaque.key);
1290        me.actions.recv.take_request(&mut stream)
1291    }
1292
1293    /// Called by a client to see if the current stream is pending open
1294    pub fn is_pending_open(&self) -> bool {
1295        let mut me = self.opaque.inner.lock().unwrap();
1296        me.store.resolve(self.opaque.key).is_pending_open
1297    }
1298
1299    /// Request capacity to send data
1300    pub fn reserve_capacity(&mut self, capacity: WindowSize) {
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
1306        me.actions
1307            .send
1308            .reserve_capacity(capacity, &mut stream, &mut me.counts)
1309    }
1310
1311    /// Returns the stream's current send capacity.
1312    pub fn capacity(&self) -> WindowSize {
1313        let mut me = self.opaque.inner.lock().unwrap();
1314        let me = &mut *me;
1315
1316        let mut stream = me.store.resolve(self.opaque.key);
1317
1318        me.actions.send.capacity(&mut stream)
1319    }
1320
1321    /// Request to be notified when the stream's capacity increases
1322    pub fn poll_capacity(&mut self, cx: &Context) -> Poll<Option<Result<WindowSize, UserError>>> {
1323        let mut me = self.opaque.inner.lock().unwrap();
1324        let me = &mut *me;
1325
1326        let mut stream = me.store.resolve(self.opaque.key);
1327
1328        me.actions.send.poll_capacity(cx, &mut stream)
1329    }
1330
1331    /// Request to be notified for if a `RST_STREAM` is received for this stream.
1332    pub(crate) fn poll_reset(
1333        &mut self,
1334        cx: &Context,
1335        mode: proto::PollReset,
1336    ) -> Poll<Result<Reason, crate::Error>> {
1337        let mut me = self.opaque.inner.lock().unwrap();
1338        let me = &mut *me;
1339
1340        let mut stream = me.store.resolve(self.opaque.key);
1341
1342        me.actions.send.poll_reset(cx, &mut stream, mode)
1343    }
1344
1345    pub fn clone_to_opaque(&self) -> OpaqueStreamRef {
1346        self.opaque.clone()
1347    }
1348
1349    pub fn stream_id(&self) -> StreamId {
1350        self.opaque.stream_id()
1351    }
1352}
1353
1354impl<B> Clone for StreamRef<B> {
1355    fn clone(&self) -> Self {
1356        StreamRef {
1357            opaque: self.opaque.clone(),
1358            send_buffer: self.send_buffer.clone(),
1359        }
1360    }
1361}
1362
1363// ===== impl OpaqueStreamRef =====
1364
1365impl OpaqueStreamRef {
1366    fn new(inner: Arc<Mutex<Inner>>, stream: &mut store::Ptr) -> OpaqueStreamRef {
1367        stream.ref_inc();
1368        OpaqueStreamRef {
1369            inner,
1370            key: stream.key(),
1371        }
1372    }
1373    /// Called by a client to check for a received response.
1374    pub fn poll_response(&mut self, cx: &Context) -> Poll<Result<Response<()>, proto::Error>> {
1375        let mut me = self.inner.lock().unwrap();
1376        let me = &mut *me;
1377
1378        let mut stream = me.store.resolve(self.key);
1379
1380        me.actions.recv.poll_response(cx, &mut stream)
1381    }
1382
1383    /// Called by a client to check for informational responses (1xx status codes)
1384    pub fn poll_informational(
1385        &mut self,
1386        cx: &Context,
1387    ) -> Poll<Option<Result<Response<()>, proto::Error>>> {
1388        let mut me = self.inner.lock().unwrap();
1389        let me = &mut *me;
1390
1391        let mut stream = me.store.resolve(self.key);
1392
1393        me.actions.recv.poll_informational(cx, &mut stream)
1394    }
1395    /// Called by a client to check for a pushed request.
1396    pub fn poll_pushed(
1397        &mut self,
1398        cx: &Context,
1399    ) -> Poll<Option<Result<(Request<()>, OpaqueStreamRef), proto::Error>>> {
1400        let mut me = self.inner.lock().unwrap();
1401        let me = &mut *me;
1402
1403        let mut stream = me.store.resolve(self.key);
1404        me.actions
1405            .recv
1406            .poll_pushed(cx, &mut stream)
1407            .map_ok(|(h, key)| {
1408                me.refs += 1;
1409                let opaque_ref =
1410                    OpaqueStreamRef::new(self.inner.clone(), &mut me.store.resolve(key));
1411                (h, opaque_ref)
1412            })
1413    }
1414
1415    pub fn is_end_stream(&self) -> bool {
1416        let mut me = self.inner.lock().unwrap();
1417        let me = &mut *me;
1418
1419        let stream = me.store.resolve(self.key);
1420
1421        me.actions.recv.is_end_stream(&stream)
1422    }
1423
1424    pub fn poll_data(&mut self, cx: &Context) -> Poll<Option<Result<Bytes, proto::Error>>> {
1425        let mut me = self.inner.lock().unwrap();
1426        let me = &mut *me;
1427
1428        let mut stream = me.store.resolve(self.key);
1429
1430        me.actions.recv.poll_data(cx, &mut stream)
1431    }
1432
1433    pub fn poll_trailers(&mut self, cx: &Context) -> Poll<Option<Result<HeaderMap, proto::Error>>> {
1434        let mut me = self.inner.lock().unwrap();
1435        let me = &mut *me;
1436
1437        let mut stream = me.store.resolve(self.key);
1438
1439        me.actions.recv.poll_trailers(cx, &mut stream)
1440    }
1441
1442    pub(crate) fn available_recv_capacity(&self) -> isize {
1443        let me = self.inner.lock().unwrap();
1444        let me = &*me;
1445
1446        let stream = &me.store[self.key];
1447        stream.recv_flow.available().into()
1448    }
1449
1450    pub(crate) fn used_recv_capacity(&self) -> WindowSize {
1451        let me = self.inner.lock().unwrap();
1452        let me = &*me;
1453
1454        let stream = &me.store[self.key];
1455        stream.in_flight_recv_data
1456    }
1457
1458    /// Releases recv capacity back to the peer. This may result in sending
1459    /// WINDOW_UPDATE frames on both the stream and connection.
1460    pub fn release_capacity(&mut self, capacity: WindowSize) -> Result<(), UserError> {
1461        let mut me = self.inner.lock().unwrap();
1462        let me = &mut *me;
1463
1464        let mut stream = me.store.resolve(self.key);
1465
1466        me.actions
1467            .recv
1468            .release_capacity(capacity, &mut stream, &mut me.actions.task)
1469    }
1470
1471    /// Clear the receive queue and set the status to no longer receive data frames.
1472    pub(crate) fn clear_recv_buffer(&mut self) {
1473        let mut me = self.inner.lock().unwrap();
1474        let me = &mut *me;
1475
1476        let mut stream = me.store.resolve(self.key);
1477        stream.is_recv = false;
1478        me.actions.recv.clear_recv_buffer(&mut stream);
1479    }
1480
1481    pub fn stream_id(&self) -> StreamId {
1482        self.inner.lock().unwrap().store[self.key].id
1483    }
1484}
1485
1486impl fmt::Debug for OpaqueStreamRef {
1487    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1488        use std::sync::TryLockError::*;
1489
1490        match self.inner.try_lock() {
1491            Ok(me) => {
1492                let stream = &me.store[self.key];
1493                fmt.debug_struct("OpaqueStreamRef")
1494                    .field("stream_id", &stream.id)
1495                    .field("ref_count", &stream.ref_count)
1496                    .finish()
1497            }
1498            Err(Poisoned(_)) => fmt
1499                .debug_struct("OpaqueStreamRef")
1500                .field("inner", &"<Poisoned>")
1501                .finish(),
1502            Err(WouldBlock) => fmt
1503                .debug_struct("OpaqueStreamRef")
1504                .field("inner", &"<Locked>")
1505                .finish(),
1506        }
1507    }
1508}
1509
1510impl Clone for OpaqueStreamRef {
1511    fn clone(&self) -> Self {
1512        // Increment the ref count
1513        let mut inner = self.inner.lock().unwrap();
1514        inner.store.resolve(self.key).ref_inc();
1515        inner.refs += 1;
1516
1517        OpaqueStreamRef {
1518            inner: self.inner.clone(),
1519            key: self.key,
1520        }
1521    }
1522}
1523
1524impl Drop for OpaqueStreamRef {
1525    fn drop(&mut self) {
1526        drop_stream_ref(&self.inner, self.key);
1527    }
1528}
1529
1530// TODO: Move back in fn above
1531fn drop_stream_ref(inner: &Mutex<Inner>, key: store::Key) {
1532    let mut me = match inner.lock() {
1533        Ok(inner) => inner,
1534        Err(_) => {
1535            if ::std::thread::panicking() {
1536                tracing::trace!("StreamRef::drop; mutex poisoned");
1537                return;
1538            } else {
1539                panic!("StreamRef::drop; mutex poisoned");
1540            }
1541        }
1542    };
1543
1544    let me = &mut *me;
1545    me.refs -= 1;
1546    let mut stream = me.store.resolve(key);
1547
1548    tracing::trace!("drop_stream_ref; stream={:?}", stream);
1549
1550    // decrement the stream's ref count by 1.
1551    stream.ref_dec();
1552
1553    let actions = &mut me.actions;
1554
1555    // If the stream is not referenced and it is already
1556    // closed (does not have to go through logic below
1557    // of canceling the stream), we should notify the task
1558    // (connection) so that it can close properly
1559    if stream.ref_count == 0 && stream.is_closed() {
1560        if let Some(task) = actions.task.take() {
1561            task.wake();
1562        }
1563    }
1564
1565    me.counts.transition(stream, |counts, stream| {
1566        maybe_cancel(stream, actions, counts);
1567
1568        if stream.ref_count == 0 {
1569            // Release any recv window back to connection, no one can access
1570            // it anymore.
1571            actions
1572                .recv
1573                .release_closed_capacity(stream, &mut actions.task);
1574
1575            // We won't be able to reach our push promises anymore
1576            let mut ppp = stream.pending_push_promises.take();
1577            while let Some(promise) = ppp.pop(stream.store_mut()) {
1578                counts.transition(promise, |counts, stream| {
1579                    maybe_cancel(stream, actions, counts);
1580                });
1581            }
1582        }
1583    });
1584}
1585
1586fn maybe_cancel(stream: &mut store::Ptr, actions: &mut Actions, counts: &mut Counts) {
1587    if stream.is_canceled_interest() {
1588        // Server is allowed to early respond without fully consuming the client input stream
1589        // But per the RFC, must send a RST_STREAM(NO_ERROR) in such cases. https://www.rfc-editor.org/rfc/rfc7540#section-8.1
1590        // Some other http2 implementation may interpret other error code as fatal if not respected (i.e: nginx https://trac.nginx.org/nginx/ticket/2376)
1591        let reason = if counts.peer().is_server()
1592            && stream.state.is_send_closed()
1593            && stream.state.is_recv_streaming()
1594        {
1595            Reason::NO_ERROR
1596        } else {
1597            Reason::CANCEL
1598        };
1599
1600        actions
1601            .send
1602            .schedule_implicit_reset(stream, reason, counts, &mut actions.task);
1603        actions.recv.enqueue_reset_expiration(stream, counts);
1604    }
1605}
1606
1607// ===== impl SendBuffer =====
1608
1609impl<B> SendBuffer<B> {
1610    fn new() -> Self {
1611        let inner = Mutex::new(Buffer::new());
1612        SendBuffer { inner }
1613    }
1614
1615    pub fn is_empty(&self) -> bool {
1616        let buf = self.inner.lock().unwrap();
1617        buf.is_empty()
1618    }
1619}
1620
1621// ===== impl Actions =====
1622
1623impl Actions {
1624    fn send_reset<B>(
1625        &mut self,
1626        stream: store::Ptr,
1627        reason: Reason,
1628        initiator: Initiator,
1629        counts: &mut Counts,
1630        send_buffer: &mut Buffer<Frame<B>>,
1631    ) -> Result<(), crate::proto::error::GoAway> {
1632        counts.transition(stream, |counts, stream| {
1633            if initiator.is_library() {
1634                if counts.can_inc_num_local_error_resets() {
1635                    counts.inc_num_local_error_resets();
1636                } else {
1637                    tracing::warn!(
1638                        "locally-reset streams reached limit ({:?})",
1639                        counts.max_local_error_resets().unwrap(),
1640                    );
1641                    return Err(crate::proto::error::GoAway {
1642                        reason: Reason::ENHANCE_YOUR_CALM,
1643                        debug_data: "too_many_internal_resets".into(),
1644                    });
1645                }
1646            }
1647
1648            self.send.send_reset(
1649                reason,
1650                initiator,
1651                send_buffer,
1652                stream,
1653                counts,
1654                &mut self.task,
1655            );
1656            self.recv.enqueue_reset_expiration(stream, counts);
1657            // if a RecvStream is parked, ensure it's notified
1658            stream.notify_recv();
1659
1660            Ok(())
1661        })
1662    }
1663
1664    fn reset_on_recv_stream_err<B>(
1665        &mut self,
1666        buffer: &mut Buffer<Frame<B>>,
1667        stream: &mut store::Ptr,
1668        counts: &mut Counts,
1669        res: Result<(), Error>,
1670    ) -> Result<(), Error> {
1671        if let Err(Error::Reset(stream_id, reason, initiator)) = res {
1672            debug_assert_eq!(stream_id, stream.id);
1673
1674            if counts.can_inc_num_local_error_resets() {
1675                counts.inc_num_local_error_resets();
1676
1677                // Reset the stream.
1678                self.send
1679                    .send_reset(reason, initiator, buffer, stream, counts, &mut self.task);
1680                self.recv.enqueue_reset_expiration(stream, counts);
1681                // if a RecvStream is parked, ensure it's notified
1682                stream.notify_recv();
1683                Ok(())
1684            } else {
1685                tracing::warn!(
1686                    "reset_on_recv_stream_err; locally-reset streams reached limit ({:?})",
1687                    counts.max_local_error_resets().unwrap(),
1688                );
1689                Err(Error::library_go_away_data(
1690                    Reason::ENHANCE_YOUR_CALM,
1691                    "too_many_internal_resets",
1692                ))
1693            }
1694        } else {
1695            res
1696        }
1697    }
1698
1699    fn ensure_not_idle(&mut self, peer: peer::Dyn, id: StreamId) -> Result<(), Reason> {
1700        if peer.is_local_init(id) {
1701            self.send.ensure_not_idle(id)
1702        } else {
1703            self.recv.ensure_not_idle(id)
1704        }
1705    }
1706
1707    fn ensure_no_conn_error(&self) -> Result<(), proto::Error> {
1708        if let Some(ref err) = self.conn_error {
1709            Err(err.clone())
1710        } else {
1711            Ok(())
1712        }
1713    }
1714
1715    /// Check if we possibly could have processed and since forgotten this stream.
1716    ///
1717    /// If we send a RST_STREAM for a stream, we will eventually "forget" about
1718    /// the stream to free up memory. It's possible that the remote peer had
1719    /// frames in-flight, and by the time we receive them, our own state is
1720    /// gone. We *could* tear everything down by sending a GOAWAY, but it
1721    /// is more likely to be latency/memory constraints that caused this,
1722    /// and not a bad actor. So be less catastrophic, the spec allows
1723    /// us to send another RST_STREAM of STREAM_CLOSED.
1724    fn may_have_forgotten_stream(&self, peer: peer::Dyn, id: StreamId) -> bool {
1725        if id.is_zero() {
1726            return false;
1727        }
1728        if peer.is_local_init(id) {
1729            self.send.may_have_created_stream(id)
1730        } else {
1731            self.recv.may_have_created_stream(id)
1732        }
1733    }
1734
1735    fn clear_queues(&mut self, clear_pending_accept: bool, store: &mut Store, counts: &mut Counts) {
1736        self.recv.clear_queues(clear_pending_accept, store, counts);
1737        self.send.clear_queues(store, counts);
1738    }
1739}