/
streams.rs
1565 lines (1317 loc) · 49.8 KB
/
streams.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use super::recv::RecvHeaderBlockError;
use super::store::{self, Entry, Resolve, Store};
use super::{Buffer, Config, Counts, Prioritized, Recv, Send, Stream, StreamId};
use crate::codec::{Codec, SendError, UserError};
use crate::ext::Protocol;
use crate::frame::{self, Frame, Reason};
use crate::proto::{peer, Error, Initiator, Open, Peer, WindowSize};
use crate::{client, proto, server};
use bytes::{Buf, Bytes};
use http::{HeaderMap, Request, Response};
use std::task::{Context, Poll, Waker};
use tokio::io::AsyncWrite;
use crate::PollExt;
use std::sync::{Arc, Mutex};
use std::{fmt, io};
#[derive(Debug)]
pub(crate) struct Streams<B, P>
where
P: Peer,
{
/// Holds most of the connection and stream related state for processing
/// HTTP/2 frames associated with streams.
inner: Arc<Mutex<Inner>>,
/// This is the queue of frames to be written to the wire. This is split out
/// to avoid requiring a `B` generic on all public API types even if `B` is
/// not technically required.
///
/// Currently, splitting this out requires a second `Arc` + `Mutex`.
/// However, it should be possible to avoid this duplication with a little
/// bit of unsafe code. This optimization has been postponed until it has
/// been shown to be necessary.
send_buffer: Arc<SendBuffer<B>>,
_p: ::std::marker::PhantomData<P>,
}
// Like `Streams` but with a `peer::Dyn` field instead of a static `P: Peer` type parameter.
// Ensures that the methods only get one instantiation, instead of two (client and server)
#[derive(Debug)]
pub(crate) struct DynStreams<'a, B> {
inner: &'a Mutex<Inner>,
send_buffer: &'a SendBuffer<B>,
peer: peer::Dyn,
}
/// Reference to the stream state
#[derive(Debug)]
pub(crate) struct StreamRef<B> {
opaque: OpaqueStreamRef,
send_buffer: Arc<SendBuffer<B>>,
}
/// Reference to the stream state that hides the send data chunk generic
pub(crate) struct OpaqueStreamRef {
inner: Arc<Mutex<Inner>>,
key: store::Key,
}
/// Fields needed to manage state related to managing the set of streams. This
/// is mostly split out to make ownership happy.
///
/// TODO: better name
#[derive(Debug)]
struct Inner {
/// Tracks send & recv stream concurrency.
counts: Counts,
/// Connection level state and performs actions on streams
actions: Actions,
/// Stores stream state
store: Store,
/// The number of stream refs to this shared state.
refs: usize,
}
#[derive(Debug)]
struct Actions {
/// Manages state transitions initiated by receiving frames
recv: Recv,
/// Manages state transitions initiated by sending frames
send: Send,
/// Task that calls `poll_complete`.
task: Option<Waker>,
/// If the connection errors, a copy is kept for any StreamRefs.
conn_error: Option<proto::Error>,
}
/// Contains the buffer of frames to be written to the wire.
#[derive(Debug)]
struct SendBuffer<B> {
inner: Mutex<Buffer<Frame<B>>>,
}
// ===== impl Streams =====
impl<B, P> Streams<B, P>
where
B: Buf,
P: Peer,
{
pub fn new(config: Config) -> Self {
let peer = P::r#dyn();
Streams {
inner: Inner::new(peer, config),
send_buffer: Arc::new(SendBuffer::new()),
_p: ::std::marker::PhantomData,
}
}
pub fn set_target_connection_window_size(&mut self, size: WindowSize) {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions
.recv
.set_target_connection_window(size, &mut me.actions.task)
}
pub fn next_incoming(&mut self) -> Option<StreamRef<B>> {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions.recv.next_incoming(&mut me.store).map(|key| {
let stream = &mut me.store.resolve(key);
tracing::trace!(
"next_incoming; id={:?}, state={:?}",
stream.id,
stream.state
);
// TODO: ideally, OpaqueStreamRefs::new would do this, but we're holding
// the lock, so it can't.
me.refs += 1;
StreamRef {
opaque: OpaqueStreamRef::new(self.inner.clone(), stream),
send_buffer: self.send_buffer.clone(),
}
})
}
pub fn send_pending_refusal<T>(
&mut self,
cx: &mut Context,
dst: &mut Codec<T, Prioritized<B>>,
) -> Poll<io::Result<()>>
where
T: AsyncWrite + Unpin,
{
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions.recv.send_pending_refusal(cx, dst)
}
pub fn clear_expired_reset_streams(&mut self) {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions
.recv
.clear_expired_reset_streams(&mut me.store, &mut me.counts);
}
pub fn poll_complete<T>(
&mut self,
cx: &mut Context,
dst: &mut Codec<T, Prioritized<B>>,
) -> Poll<io::Result<()>>
where
T: AsyncWrite + Unpin,
{
let mut me = self.inner.lock().unwrap();
me.poll_complete(&self.send_buffer, cx, dst)
}
pub fn apply_remote_settings(&mut self, frame: &frame::Settings) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
let mut send_buffer = self.send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
me.counts.apply_remote_settings(frame);
me.actions.send.apply_remote_settings(
frame,
send_buffer,
&mut me.store,
&mut me.counts,
&mut me.actions.task,
)
}
pub fn apply_local_settings(&mut self, frame: &frame::Settings) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions.recv.apply_local_settings(frame, &mut me.store)
}
pub fn send_request(
&mut self,
mut request: Request<()>,
end_of_stream: bool,
pending: Option<&OpaqueStreamRef>,
) -> Result<StreamRef<B>, SendError> {
use super::stream::ContentLength;
use http::Method;
let protocol = request.extensions_mut().remove::<Protocol>();
// Clear before taking lock, incase extensions contain a StreamRef.
request.extensions_mut().clear();
// TODO: There is a hazard with assigning a stream ID before the
// prioritize layer. If prioritization reorders new streams, this
// implicitly closes the earlier stream IDs.
//
// See: hyperium/h2#11
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
let mut send_buffer = self.send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
me.actions.ensure_no_conn_error()?;
me.actions.send.ensure_next_stream_id()?;
// The `pending` argument is provided by the `Client`, and holds
// a store `Key` of a `Stream` that may have been not been opened
// yet.
//
// If that stream is still pending, the Client isn't allowed to
// queue up another pending stream. They should use `poll_ready`.
if let Some(stream) = pending {
if me.store.resolve(stream.key).is_pending_open {
return Err(UserError::Rejected.into());
}
}
if me.counts.peer().is_server() {
// Servers cannot open streams. PushPromise must first be reserved.
return Err(UserError::UnexpectedFrameType.into());
}
let stream_id = me.actions.send.open()?;
let mut stream = Stream::new(
stream_id,
me.actions.send.init_window_sz(),
me.actions.recv.init_window_sz(),
);
if *request.method() == Method::HEAD {
stream.content_length = ContentLength::Head;
}
// Convert the message
let headers =
client::Peer::convert_send_message(stream_id, request, protocol, end_of_stream)?;
let mut stream = me.store.insert(stream.id, stream);
let sent = me.actions.send.send_headers(
headers,
send_buffer,
&mut stream,
&mut me.counts,
&mut me.actions.task,
);
// send_headers can return a UserError, if it does,
// we should forget about this stream.
if let Err(err) = sent {
stream.unlink();
stream.remove();
return Err(err.into());
}
// Given that the stream has been initialized, it should not be in the
// closed state.
debug_assert!(!stream.state.is_closed());
// TODO: ideally, OpaqueStreamRefs::new would do this, but we're holding
// the lock, so it can't.
me.refs += 1;
Ok(StreamRef {
opaque: OpaqueStreamRef::new(self.inner.clone(), &mut stream),
send_buffer: self.send_buffer.clone(),
})
}
pub(crate) fn is_extended_connect_protocol_enabled(&self) -> bool {
self.inner
.lock()
.unwrap()
.actions
.send
.is_extended_connect_protocol_enabled()
}
}
impl<B> DynStreams<'_, B> {
pub fn recv_headers(&mut self, frame: frame::Headers) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_headers(self.peer, &self.send_buffer, frame)
}
pub fn recv_data(&mut self, frame: frame::Data) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_data(self.peer, &self.send_buffer, frame)
}
pub fn recv_reset(&mut self, frame: frame::Reset) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_reset(&self.send_buffer, frame)
}
/// Notify all streams that a connection-level error happened.
pub fn handle_error(&mut self, err: proto::Error) -> StreamId {
let mut me = self.inner.lock().unwrap();
me.handle_error(&self.send_buffer, err)
}
pub fn recv_go_away(&mut self, frame: &frame::GoAway) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_go_away(&self.send_buffer, frame)
}
pub fn last_processed_id(&self) -> StreamId {
self.inner.lock().unwrap().actions.recv.last_processed_id()
}
pub fn recv_window_update(&mut self, frame: frame::WindowUpdate) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_window_update(&self.send_buffer, frame)
}
pub fn recv_push_promise(&mut self, frame: frame::PushPromise) -> Result<(), Error> {
let mut me = self.inner.lock().unwrap();
me.recv_push_promise(&self.send_buffer, frame)
}
pub fn recv_eof(&mut self, clear_pending_accept: bool) -> Result<(), ()> {
let mut me = self.inner.lock().map_err(|_| ())?;
me.recv_eof(&self.send_buffer, clear_pending_accept)
}
pub fn send_reset(&mut self, id: StreamId, reason: Reason) {
let mut me = self.inner.lock().unwrap();
me.send_reset(&self.send_buffer, id, reason)
}
pub fn send_go_away(&mut self, last_processed_id: StreamId) {
let mut me = self.inner.lock().unwrap();
me.actions.recv.go_away(last_processed_id);
}
}
impl Inner {
fn new(peer: peer::Dyn, config: Config) -> Arc<Mutex<Self>> {
Arc::new(Mutex::new(Inner {
counts: Counts::new(peer, &config),
actions: Actions {
recv: Recv::new(peer, &config),
send: Send::new(&config),
task: None,
conn_error: None,
},
store: Store::new(),
refs: 1,
}))
}
fn recv_headers<B>(
&mut self,
peer: peer::Dyn,
send_buffer: &SendBuffer<B>,
frame: frame::Headers,
) -> Result<(), Error> {
let id = frame.stream_id();
// The GOAWAY process has begun. All streams with a greater ID than
// specified as part of GOAWAY should be ignored.
if id > self.actions.recv.max_stream_id() {
tracing::trace!(
"id ({:?}) > max_stream_id ({:?}), ignoring HEADERS",
id,
self.actions.recv.max_stream_id()
);
return Ok(());
}
let key = match self.store.find_entry(id) {
Entry::Occupied(e) => e.key(),
Entry::Vacant(e) => {
// Client: it's possible to send a request, and then send
// a RST_STREAM while the response HEADERS were in transit.
//
// Server: we can't reset a stream before having received
// the request headers, so don't allow.
if !peer.is_server() {
// This may be response headers for a stream we've already
// forgotten about...
if self.actions.may_have_forgotten_stream(peer, id) {
tracing::debug!(
"recv_headers for old stream={:?}, sending STREAM_CLOSED",
id,
);
return Err(Error::library_reset(id, Reason::STREAM_CLOSED));
}
}
match self
.actions
.recv
.open(id, Open::Headers, &mut self.counts)?
{
Some(stream_id) => {
let stream = Stream::new(
stream_id,
self.actions.send.init_window_sz(),
self.actions.recv.init_window_sz(),
);
e.insert(stream)
}
None => return Ok(()),
}
}
};
let stream = self.store.resolve(key);
if stream.state.is_local_reset() {
// Locally reset streams must ignore frames "for some time".
// This is because the remote may have sent trailers before
// receiving the RST_STREAM frame.
tracing::trace!("recv_headers; ignoring trailers on {:?}", stream.id);
return Ok(());
}
let actions = &mut self.actions;
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
self.counts.transition(stream, |counts, stream| {
tracing::trace!(
"recv_headers; stream={:?}; state={:?}",
stream.id,
stream.state
);
let res = if stream.state.is_recv_headers() {
match actions.recv.recv_headers(frame, stream, counts) {
Ok(()) => Ok(()),
Err(RecvHeaderBlockError::Oversize(resp)) => {
if let Some(resp) = resp {
let sent = actions.send.send_headers(
resp, send_buffer, stream, counts, &mut actions.task);
debug_assert!(sent.is_ok(), "oversize response should not fail");
actions.send.schedule_implicit_reset(
stream,
Reason::REFUSED_STREAM,
counts,
&mut actions.task);
actions.recv.enqueue_reset_expiration(stream, counts);
Ok(())
} else {
Err(Error::library_reset(stream.id, Reason::REFUSED_STREAM))
}
},
Err(RecvHeaderBlockError::State(err)) => Err(err),
}
} else {
if !frame.is_end_stream() {
// Receiving trailers that don't set EOS is a "malformed"
// message. Malformed messages are a stream error.
proto_err!(stream: "recv_headers: trailers frame was not EOS; stream={:?}", stream.id);
return Err(Error::library_reset(stream.id, Reason::PROTOCOL_ERROR));
}
actions.recv.recv_trailers(frame, stream)
};
actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
})
}
fn recv_data<B>(
&mut self,
peer: peer::Dyn,
send_buffer: &SendBuffer<B>,
frame: frame::Data,
) -> Result<(), Error> {
let id = frame.stream_id();
let stream = match self.store.find_mut(&id) {
Some(stream) => stream,
None => {
// The GOAWAY process has begun. All streams with a greater ID
// than specified as part of GOAWAY should be ignored.
if id > self.actions.recv.max_stream_id() {
tracing::trace!(
"id ({:?}) > max_stream_id ({:?}), ignoring DATA",
id,
self.actions.recv.max_stream_id()
);
return Ok(());
}
if self.actions.may_have_forgotten_stream(peer, id) {
tracing::debug!("recv_data for old stream={:?}, sending STREAM_CLOSED", id,);
let sz = frame.payload().len();
// This should have been enforced at the codec::FramedRead layer, so
// this is just a sanity check.
assert!(sz <= super::MAX_WINDOW_SIZE as usize);
let sz = sz as WindowSize;
self.actions.recv.ignore_data(sz)?;
return Err(Error::library_reset(id, Reason::STREAM_CLOSED));
}
proto_err!(conn: "recv_data: stream not found; id={:?}", id);
return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
}
};
let actions = &mut self.actions;
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
self.counts.transition(stream, |counts, stream| {
let sz = frame.payload().len();
let res = actions.recv.recv_data(frame, stream);
// Any stream error after receiving a DATA frame means
// we won't give the data to the user, and so they can't
// release the capacity. We do it automatically.
if let Err(Error::Reset(..)) = res {
actions
.recv
.release_connection_capacity(sz as WindowSize, &mut None);
}
actions.reset_on_recv_stream_err(send_buffer, stream, counts, res)
})
}
fn recv_reset<B>(
&mut self,
send_buffer: &SendBuffer<B>,
frame: frame::Reset,
) -> Result<(), Error> {
let id = frame.stream_id();
if id.is_zero() {
proto_err!(conn: "recv_reset: invalid stream ID 0");
return Err(Error::library_go_away(Reason::PROTOCOL_ERROR));
}
// The GOAWAY process has begun. All streams with a greater ID than
// specified as part of GOAWAY should be ignored.
if id > self.actions.recv.max_stream_id() {
tracing::trace!(
"id ({:?}) > max_stream_id ({:?}), ignoring RST_STREAM",
id,
self.actions.recv.max_stream_id()
);
return Ok(());
}
let stream = match self.store.find_mut(&id) {
Some(stream) => stream,
None => {
// TODO: Are there other error cases?
self.actions
.ensure_not_idle(self.counts.peer(), id)
.map_err(Error::library_go_away)?;
return Ok(());
}
};
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
let actions = &mut self.actions;
self.counts.transition(stream, |counts, stream| {
actions.recv.recv_reset(frame, stream);
actions.send.handle_error(send_buffer, stream, counts);
assert!(stream.state.is_closed());
Ok(())
})
}
fn recv_window_update<B>(
&mut self,
send_buffer: &SendBuffer<B>,
frame: frame::WindowUpdate,
) -> Result<(), Error> {
let id = frame.stream_id();
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
if id.is_zero() {
self.actions
.send
.recv_connection_window_update(frame, &mut self.store, &mut self.counts)
.map_err(Error::library_go_away)?;
} else {
// The remote may send window updates for streams that the local now
// considers closed. It's ok...
if let Some(mut stream) = self.store.find_mut(&id) {
// This result is ignored as there is nothing to do when there
// is an error. The stream is reset by the function on error and
// the error is informational.
let _ = self.actions.send.recv_stream_window_update(
frame.size_increment(),
send_buffer,
&mut stream,
&mut self.counts,
&mut self.actions.task,
);
} else {
self.actions
.ensure_not_idle(self.counts.peer(), id)
.map_err(Error::library_go_away)?;
}
}
Ok(())
}
fn handle_error<B>(&mut self, send_buffer: &SendBuffer<B>, err: proto::Error) -> StreamId {
let actions = &mut self.actions;
let counts = &mut self.counts;
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
let last_processed_id = actions.recv.last_processed_id();
self.store.for_each(|stream| {
counts.transition(stream, |counts, stream| {
actions.recv.handle_error(&err, &mut *stream);
actions.send.handle_error(send_buffer, stream, counts);
})
});
actions.conn_error = Some(err);
last_processed_id
}
fn recv_go_away<B>(
&mut self,
send_buffer: &SendBuffer<B>,
frame: &frame::GoAway,
) -> Result<(), Error> {
let actions = &mut self.actions;
let counts = &mut self.counts;
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
let last_stream_id = frame.last_stream_id();
actions.send.recv_go_away(last_stream_id)?;
let err = Error::remote_go_away(frame.debug_data().clone(), frame.reason());
self.store.for_each(|stream| {
if stream.id > last_stream_id {
counts.transition(stream, |counts, stream| {
actions.recv.handle_error(&err, &mut *stream);
actions.send.handle_error(send_buffer, stream, counts);
})
}
});
actions.conn_error = Some(err);
Ok(())
}
fn recv_push_promise<B>(
&mut self,
send_buffer: &SendBuffer<B>,
frame: frame::PushPromise,
) -> Result<(), Error> {
let id = frame.stream_id();
let promised_id = frame.promised_id();
// First, ensure that the initiating stream is still in a valid state.
let parent_key = match self.store.find_mut(&id) {
Some(stream) => {
// The GOAWAY process has begun. All streams with a greater ID
// than specified as part of GOAWAY should be ignored.
if id > self.actions.recv.max_stream_id() {
tracing::trace!(
"id ({:?}) > max_stream_id ({:?}), ignoring PUSH_PROMISE",
id,
self.actions.recv.max_stream_id()
);
return Ok(());
}
// The stream must be receive open
stream.state.ensure_recv_open()?;
stream.key()
}
None => {
proto_err!(conn: "recv_push_promise: initiating stream is in an invalid state");
return Err(Error::library_go_away(Reason::PROTOCOL_ERROR).into());
}
};
// TODO: Streams in the reserved states do not count towards the concurrency
// limit. However, it seems like there should be a cap otherwise this
// could grow in memory indefinitely.
// Ensure that we can reserve streams
self.actions.recv.ensure_can_reserve()?;
// Next, open the stream.
//
// If `None` is returned, then the stream is being refused. There is no
// further work to be done.
if self
.actions
.recv
.open(promised_id, Open::PushPromise, &mut self.counts)?
.is_none()
{
return Ok(());
}
// Try to handle the frame and create a corresponding key for the pushed stream
// this requires a bit of indirection to make the borrow checker happy.
let child_key: Option<store::Key> = {
// Create state for the stream
let stream = self.store.insert(promised_id, {
Stream::new(
promised_id,
self.actions.send.init_window_sz(),
self.actions.recv.init_window_sz(),
)
});
let actions = &mut self.actions;
self.counts.transition(stream, |counts, stream| {
let stream_valid = actions.recv.recv_push_promise(frame, stream);
match stream_valid {
Ok(()) => Ok(Some(stream.key())),
_ => {
let mut send_buffer = send_buffer.inner.lock().unwrap();
actions
.reset_on_recv_stream_err(
&mut *send_buffer,
stream,
counts,
stream_valid,
)
.map(|()| None)
}
}
})?
};
// If we're successful, push the headers and stream...
if let Some(child) = child_key {
let mut ppp = self.store[parent_key].pending_push_promises.take();
ppp.push(&mut self.store.resolve(child));
let parent = &mut self.store.resolve(parent_key);
parent.pending_push_promises = ppp;
parent.notify_recv();
};
Ok(())
}
fn recv_eof<B>(
&mut self,
send_buffer: &SendBuffer<B>,
clear_pending_accept: bool,
) -> Result<(), ()> {
let actions = &mut self.actions;
let counts = &mut self.counts;
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
if actions.conn_error.is_none() {
actions.conn_error = Some(io::Error::from(io::ErrorKind::BrokenPipe).into());
}
tracing::trace!("Streams::recv_eof");
self.store.for_each(|stream| {
counts.transition(stream, |counts, stream| {
actions.recv.recv_eof(stream);
// This handles resetting send state associated with the
// stream
actions.send.handle_error(send_buffer, stream, counts);
})
});
actions.clear_queues(clear_pending_accept, &mut self.store, counts);
Ok(())
}
fn poll_complete<T, B>(
&mut self,
send_buffer: &SendBuffer<B>,
cx: &mut Context,
dst: &mut Codec<T, Prioritized<B>>,
) -> Poll<io::Result<()>>
where
T: AsyncWrite + Unpin,
B: Buf,
{
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
// Send WINDOW_UPDATE frames first
//
// TODO: It would probably be better to interleave updates w/ data
// frames.
ready!(self
.actions
.recv
.poll_complete(cx, &mut self.store, &mut self.counts, dst))?;
// Send any other pending frames
ready!(self.actions.send.poll_complete(
cx,
send_buffer,
&mut self.store,
&mut self.counts,
dst
))?;
// Nothing else to do, track the task
self.actions.task = Some(cx.waker().clone());
Poll::Ready(Ok(()))
}
fn send_reset<B>(&mut self, send_buffer: &SendBuffer<B>, id: StreamId, reason: Reason) {
let key = match self.store.find_entry(id) {
Entry::Occupied(e) => e.key(),
Entry::Vacant(e) => {
// Resetting a stream we don't know about? That could be OK...
//
// 1. As a server, we just received a request, but that request
// was bad, so we're resetting before even accepting it.
// This is totally fine.
//
// 2. The remote may have sent us a frame on new stream that
// it's *not* supposed to have done, and thus, we don't know
// the stream. In that case, sending a reset will "open" the
// stream in our store. Maybe that should be a connection
// error instead? At least for now, we need to update what
// our vision of the next stream is.
if self.counts.peer().is_local_init(id) {
// We normally would open this stream, so update our
// next-send-id record.
self.actions.send.maybe_reset_next_stream_id(id);
} else {
// We normally would recv this stream, so update our
// next-recv-id record.
self.actions.recv.maybe_reset_next_stream_id(id);
}
let stream = Stream::new(id, 0, 0);
e.insert(stream)
}
};
let stream = self.store.resolve(key);
let mut send_buffer = send_buffer.inner.lock().unwrap();
let send_buffer = &mut *send_buffer;
self.actions.send_reset(
stream,
reason,
Initiator::Library,
&mut self.counts,
send_buffer,
);
}
}
impl<B> Streams<B, client::Peer>
where
B: Buf,
{
pub fn poll_pending_open(
&mut self,
cx: &Context,
pending: Option<&OpaqueStreamRef>,
) -> Poll<Result<(), crate::Error>> {
let mut me = self.inner.lock().unwrap();
let me = &mut *me;
me.actions.ensure_no_conn_error()?;
me.actions.send.ensure_next_stream_id()?;
if let Some(pending) = pending {
let mut stream = me.store.resolve(pending.key);
tracing::trace!("poll_pending_open; stream = {:?}", stream.is_pending_open);
if stream.is_pending_open {
stream.wait_send(cx);
return Poll::Pending;
}
}
Poll::Ready(Ok(()))
}
}
impl<B, P> Streams<B, P>
where
P: Peer,
{
pub fn as_dyn(&self) -> DynStreams<B> {
let Self {
inner,
send_buffer,
_p,
} = self;
DynStreams {
inner,
send_buffer,
peer: P::r#dyn(),
}
}
/// This function is safe to call multiple times.
///
/// A `Result` is returned to avoid panicking if the mutex is poisoned.
pub fn recv_eof(&mut self, clear_pending_accept: bool) -> Result<(), ()> {
self.as_dyn().recv_eof(clear_pending_accept)
}
pub(crate) fn max_send_streams(&self) -> usize {
self.inner.lock().unwrap().counts.max_send_streams()
}
pub(crate) fn max_recv_streams(&self) -> usize {
self.inner.lock().unwrap().counts.max_recv_streams()
}
#[cfg(feature = "unstable")]
pub fn num_active_streams(&self) -> usize {
let me = self.inner.lock().unwrap();
me.store.num_active_streams()
}
pub fn has_streams(&self) -> bool {
let me = self.inner.lock().unwrap();
me.counts.has_streams()
}
pub fn has_streams_or_other_references(&self) -> bool {
let me = self.inner.lock().unwrap();
me.counts.has_streams() || me.refs > 1
}
#[cfg(feature = "unstable")]
pub fn num_wired_streams(&self) -> usize {
let me = self.inner.lock().unwrap();
me.store.num_wired_streams()
}
}
// no derive because we don't need B and P to be Clone.
impl<B, P> Clone for Streams<B, P>
where
P: Peer,
{
fn clone(&self) -> Self {
self.inner.lock().unwrap().refs += 1;
Streams {