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
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
//! Defines the Stream objects that applications are interacting with
use crate::connection::Connection;
use bytes::Bytes;
use core::{
fmt,
future::Future,
pin::Pin,
task::{ready, Context, Poll},
};
pub use s2n_quic_core::{
application,
stream::{ops, StreamError, StreamId, StreamType},
};
#[derive(Clone)]
struct State {
connection: Connection,
stream_id: StreamId,
rx: ops::Status,
tx: ops::Status,
}
impl State {
fn new(connection: Connection, stream_id: StreamId) -> Self {
Self {
connection,
stream_id,
rx: ops::Status::Open,
tx: ops::Status::Open,
}
}
fn poll_request(
&mut self,
request: &mut ops::Request,
context: Option<&Context>,
) -> Result<ops::Response, StreamError> {
let id = self.stream_id;
self.connection.poll_request(id, request, context)
}
fn request(&mut self) -> Request {
Request {
state: self,
request: ops::Request::default(),
}
}
}
impl Drop for State {
fn drop(&mut self) {
let is_rx_open = !self.rx.is_closed();
let is_tx_open = !self.tx.is_closed();
if is_rx_open || is_tx_open {
let mut request = self.request();
if is_tx_open {
// Dropping a send stream will automatically finish the stream
//
// This is to stay consistent with std::net::TcpStream
request.finish().detach_tx();
}
if is_rx_open {
// Send a STOP_SENDING message on the receiving half of the `Stream`,
// for the case the application did not consume all data.
// If that already happened, this will be a noop.
request
.stop_sending(application::Error::UNKNOWN)
.detach_rx();
}
let _ = request.poll(None);
}
}
}
macro_rules! tx_stream_apis {
() => {
/// Enqueues a chunk of data for sending it towards the peer.
///
/// The method will return:
/// - `Poll::Ready(Ok(()))` if the data was enqueued for sending. The provided `Bytes` will
/// be replaced with an empty `Bytes`, in order to reduce needless ref count increases.
/// - `Poll::Ready(Err(stream_error))` if the data could not be sent, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the send buffer capacity is currently exhausted. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_send(
&mut self,
chunk: &mut Bytes,
cx: &mut Context,
) -> Poll<Result<(), StreamError>> {
if chunk.is_empty() {
return Poll::Ready(Ok(()));
}
self.tx_request()?
.send(core::slice::from_mut(chunk))
.poll(Some(cx))?
.into()
}
/// Enqueues a slice of chunks of data for sending it towards the peer.
///
/// The method will return:
/// - `Poll::Ready(Ok(count))` if part of the slice was enqueued for sending. Any of the
/// consumed `Bytes` will be replaced with an empty `Bytes`, in order to reduce needless
/// ref count increases. If `count` does not equal the total number of chunks, the stream
/// will store the waker and wake the task once more capacity is available.
/// - `Poll::Ready(Err(stream_error))` if the data could not be sent, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the send buffer capacity is currently exhausted. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_send_vectored(
&mut self,
chunks: &mut [Bytes],
cx: &mut Context,
) -> Poll<Result<usize, StreamError>> {
if chunks.is_empty() {
return Poll::Ready(Ok(0));
}
let response = self.tx_request()?.send(chunks).poll(Some(cx))?;
if response.chunks.consumed == 0 {
return Poll::Pending;
}
Ok(response.tx().expect("invalid response").chunks.consumed).into()
}
/// Polls send readiness for the given stream.
///
/// The method will return:
/// - `Poll::Ready(Ok(available_bytes))` if the stream is ready to send data, where
/// `available_bytes` is how many bytes the stream can currently accept.
/// - `Poll::Ready(Err(stream_error))` if the data could not be sent, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the send buffer capacity is currently exhausted. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_send_ready(&mut self, cx: &mut Context) -> Poll<Result<usize, StreamError>> {
let response = ready!(self
.tx_request()?
.send_readiness()
.poll(Some(cx))?
.into_poll());
Ok(response.tx().expect("invalid response").bytes.available).into()
}
/// Enqueues a chunk of data for sending it towards the peer.
///
/// This method should only be called after calling `poll_send_ready` first, as the stream
/// may not have available send buffer capacity.
///
/// The method will return:
/// - `Ok(())` if the data was enqueued for sending.
/// - `Err(stream_error)` if the data could not be sent, because the stream
/// had previously entered an error state, or the stream was not ready to send data.
pub fn send_data(&mut self, chunk: Bytes) -> Result<(), StreamError> {
if chunk.is_empty() {
return Ok(());
}
match self.tx_request()?.send(&mut [chunk]).poll(None)? {
response if response.tx().expect("invalid response").chunks.consumed == 1 => Ok(()),
_ => Err(StreamError::sending_blocked()),
}
}
/// Flushes the send buffer and waits for acknowledgement from the peer.
///
/// The method will return:
/// - `Poll::Ready(Ok(()))` if the send buffer was completely flushed and acknowledged.
/// - `Poll::Ready(Err(stream_error))` if the stream could not be flushed, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the send buffer is still being flushed. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_flush(&mut self, cx: &mut Context) -> Poll<Result<(), StreamError>> {
self.tx_request()?.flush().poll(Some(cx))?.into()
}
/// Marks the stream as finished.
///
/// The method will return:
/// - `Ok(())` if the stream was finished successfully
/// - `Err(stream_error)` if the stream could not be finished, because the stream
/// had previously entered an error state.
pub fn finish(&mut self) -> Result<(), StreamError> {
self.tx_request()?.finish().poll(None)?;
Ok(())
}
/// Marks the stream as finished and waits for all outstanding data to be acknowledged
///
/// The method will return:
/// - `Poll::Ready(Ok(()))` if the stream was completely flushed and acknowledged.
/// - `Poll::Ready(Err(stream_error))` if the stream could not be flushed, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the stream is still being flushed. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_close(&mut self, cx: &mut Context) -> Poll<Result<(), StreamError>> {
self.tx_request()?.finish().flush().poll(Some(cx))?.into()
}
/// Initiates a `RESET` on the stream.
///
/// This will close the stream and notify the peer of the provided `error_code`.
pub fn reset(&mut self, error_code: application::Error) -> Result<(), StreamError> {
self.tx_request()?.reset(error_code).poll(None)?;
Ok(())
}
};
}
macro_rules! rx_stream_apis {
() => {
/// Receives a chunk of data from the stream.
///
/// The method will return:
/// - `Poll::Ready(Ok(Some(chunk)))` if the stream is open and data was available
/// - `Poll::Ready(Ok(None))` if the stream was finished and all of the data was consumed
/// - `Poll::Ready(Err(stream_error))` if the stream could not be read, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the stream is waiting to receive data from the peer. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_receive(
&mut self,
cx: &mut Context,
) -> Poll<Result<Option<Bytes>, StreamError>> {
let mut chunk = Bytes::new();
let response =
ready!(self.poll_receive_vectored(core::slice::from_mut(&mut chunk), cx))?;
Ok(match response {
// return the chunk if it was consumed
(consumed, _) if consumed > 0 => Some(chunk),
// any other response means the stream has ended
_ => None,
})
.into()
}
/// Receives a slice of chunks of data from the stream.
///
/// The method will return:
/// - `Poll::Ready(Ok((len, is_open)))` if the stream received data into the slice,
/// where `len` was the number of chunks received, and `is_open` indicating if the stream is
/// still open. If `is_open == false`, future calls to `poll_receive_vectored` will
/// always return `Poll::Ready(Ok((0, false)))`.
/// - `Poll::Ready(Err(stream_error))` if the stream could not be read, because the stream
/// had previously entered an error state.
/// - `Poll::Pending` if the stream is waiting to receive data from the peer. In this case, the
/// caller should retry sending after the `Waker` on the provided `Context` is notified.
pub fn poll_receive_vectored(
&mut self,
chunks: &mut [Bytes],
cx: &mut Context,
) -> Poll<Result<(usize, bool), StreamError>> {
let response = ready!(self
.rx_request()?
.receive(chunks)
.poll(Some(cx))?
.into_poll());
let rx = response.rx().expect("invalid response");
let consumed = rx.chunks.consumed;
debug_assert!(
consumed <= chunks.len(),
"consumed exceeded the number of chunks provided"
);
// return if the stream is still open to receiving more data
let is_open = rx.status.is_open() || rx.status.is_finishing();
Poll::Ready(Ok((consumed, is_open)))
}
/// Sends a `STOP_SENDING` message to the peer. This requests the peer to
/// finish the `Stream` as soon as possible by issuing a `RESET` with the
/// provided `error_code`.
///
/// Since this is merely a request to the peer to `RESET` the `Stream`, the
/// `Stream` will not immediately be in a `RESET` state after issuing this
/// API call.
///
/// If the `Stream` had been previously reset by the peer or if all data had
/// already been received the API call will not trigger any action.
pub fn stop_sending(&mut self, error_code: application::Error) -> Result<(), StreamError> {
self.rx_request()?.stop_sending(error_code).poll(None)?;
Ok(())
}
};
}
/// A readable and writeable QUIC stream
pub struct Stream(State);
impl fmt::Debug for Stream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let is_alternate = f.alternate();
let mut s = f.debug_struct("Stream");
s.field("id", &self.id());
// return additional information
if is_alternate {
// TODO query the shared state
}
s.finish()
}
}
impl Stream {
/// Creates a `Stream` instance, which represents a QUIC stream with the
/// given ID. All interactions with the `Stream` will be performed through
/// the provided [`SynchronizedSharedConnectionState`].
pub(crate) fn new(connection: Connection, stream_id: StreamId) -> Self {
Self(State::new(connection, stream_id))
}
pub fn id(&self) -> StreamId {
self.0.stream_id
}
pub fn connection(&self) -> &Connection {
&self.0.connection
}
pub fn request(&mut self) -> Request {
self.0.request()
}
pub fn tx_request(&mut self) -> Result<TxRequest, StreamError> {
Ok(TxRequest {
state: &mut self.0,
request: ops::Request::default(),
})
}
pub fn rx_request(&mut self) -> Result<RxRequest, StreamError> {
Ok(RxRequest {
state: &mut self.0,
request: ops::Request::default(),
})
}
tx_stream_apis!();
rx_stream_apis!();
/// Splits a bidirectional QUIC Stream in two halves.
///
/// One half can be used to read data from the Stream.
/// The other half can be used to send data.
pub fn split(self) -> (ReceiveStream, SendStream) {
let mut rx_state = self.0;
let mut tx_state = rx_state.clone();
// close the opposite sides
rx_state.tx = ops::Status::Finished;
tx_state.rx = ops::Status::Finished;
(ReceiveStream(rx_state), SendStream(tx_state))
}
}
/// A writeable QUIC stream
pub struct SendStream(State);
impl fmt::Debug for SendStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let is_alternate = f.alternate();
let mut s = f.debug_struct("SendStream");
s.field("id", &self.id());
// return additional information
if is_alternate {
// TODO query the shared state
}
s.finish()
}
}
impl SendStream {
pub fn id(&self) -> StreamId {
self.0.stream_id
}
pub fn connection(&self) -> &Connection {
&self.0.connection
}
pub fn tx_request(&mut self) -> Result<TxRequest, StreamError> {
Ok(TxRequest {
state: &mut self.0,
request: ops::Request::default(),
})
}
tx_stream_apis!();
}
impl From<Stream> for SendStream {
fn from(stream: Stream) -> Self {
Self(stream.0)
}
}
/// A readable QUIC stream
pub struct ReceiveStream(State);
impl fmt::Debug for ReceiveStream {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let is_alternate = f.alternate();
let mut s = f.debug_struct("ReceiveStream");
s.field("id", &self.id());
// return additional information
if is_alternate {
// TODO query the shared state
}
s.finish()
}
}
impl ReceiveStream {
pub fn id(&self) -> StreamId {
self.0.stream_id
}
pub fn connection(&self) -> &Connection {
&self.0.connection
}
pub fn rx_request(&mut self) -> Result<RxRequest, StreamError> {
Ok(RxRequest {
state: &mut self.0,
request: ops::Request::default(),
})
}
rx_stream_apis!();
}
impl From<Stream> for ReceiveStream {
fn from(stream: Stream) -> Self {
Self(stream.0)
}
}
macro_rules! tx_request_apis {
() => {
pub fn send(&mut self, chunks: &'chunks mut [Bytes]) -> &mut Self {
self.request.send(chunks);
self
}
pub fn send_readiness(&mut self) -> &mut Self {
// express interest in tx
if self.request.tx.is_none() {
self.request.tx = Some(Default::default());
}
self
}
pub fn finish(&mut self) -> &mut Self {
self.request.finish();
self
}
pub fn reset(&mut self, error_code: application::Error) -> &mut Self {
self.request.reset(error_code);
self
}
pub fn flush(&mut self) -> &mut Self {
self.request.flush();
self
}
};
}
macro_rules! rx_request_apis {
() => {
pub fn receive(&mut self, chunks: &'chunks mut [Bytes]) -> &mut Self {
self.request.receive(chunks);
self
}
pub fn with_watermark(&mut self, low: usize, high: usize) -> &mut Self {
self.request.with_watermark(low, high);
self
}
pub fn with_low_watermark(&mut self, low: usize) -> &mut Self {
self.request.with_low_watermark(low);
self
}
pub fn with_high_watermark(&mut self, high: usize) -> &mut Self {
self.request.with_high_watermark(high);
self
}
pub fn stop_sending(&mut self, error_code: application::Error) -> &mut Self {
self.request.stop_sending(error_code);
self
}
};
}
pub struct Request<'state, 'chunks> {
state: &'state mut State,
request: ops::Request<'chunks>,
}
impl<'state, 'chunks> Request<'state, 'chunks> {
tx_request_apis!();
rx_request_apis!();
fn detach_tx(&mut self) -> &mut Self {
self.request.detach_tx();
self
}
fn detach_rx(&mut self) -> &mut Self {
self.request.detach_rx();
self
}
pub fn poll(&mut self, context: Option<&Context>) -> Result<ops::Response, StreamError> {
if self.state.rx.is_finished() && self.state.tx.is_finished() {
// Tx and Rx are both finished, so return early to avoid sending a request
// for a stream that has been removed from the stream container already
return Ok(ops::Response {
tx: Some(ops::tx::Response {
status: ops::Status::Finished,
..Default::default()
}),
rx: Some(ops::rx::Response {
status: ops::Status::Finished,
..Default::default()
}),
});
}
let response = self.state.poll_request(&mut self.request, context)?;
if let Some(rx) = response.rx() {
self.state.rx = rx.status;
}
if let Some(tx) = response.tx() {
self.state.tx = tx.status;
}
Ok(response)
}
}
impl<'state, 'chunks> Future for Request<'state, 'chunks> {
type Output = Result<ops::Response, StreamError>;
fn poll(
mut self: Pin<&mut Self>,
context: &mut Context,
) -> Poll<Result<ops::Response, StreamError>> {
Self::poll(&mut self, Some(context))?.into()
}
}
pub struct TxRequest<'state, 'chunks> {
state: &'state mut State,
request: ops::Request<'chunks>,
}
impl<'state, 'chunks> TxRequest<'state, 'chunks> {
tx_request_apis!();
pub fn poll(&mut self, context: Option<&Context>) -> Result<ops::tx::Response, StreamError> {
if self.state.tx.is_finished() {
// return early to avoid sending a request for a stream that has been
// removed from the stream container already
return Ok(ops::tx::Response {
status: ops::Status::Finished,
..Default::default()
});
}
let response = self
.state
.poll_request(&mut self.request, context)?
.tx
.expect("invalid response");
self.state.tx = response.status;
Ok(response)
}
}
impl<'state, 'chunks> Future for TxRequest<'state, 'chunks> {
type Output = Result<ops::tx::Response, StreamError>;
fn poll(
mut self: Pin<&mut Self>,
context: &mut Context,
) -> Poll<Result<ops::tx::Response, StreamError>> {
Self::poll(&mut self, Some(context))?.into()
}
}
pub struct RxRequest<'state, 'chunks> {
state: &'state mut State,
request: ops::Request<'chunks>,
}
impl<'state, 'chunks> RxRequest<'state, 'chunks> {
rx_request_apis!();
pub fn poll(&mut self, context: Option<&Context>) -> Result<ops::rx::Response, StreamError> {
if self.state.rx.is_finished() {
// return early to avoid sending a request for a stream that has been
// removed from the stream container already
return Ok(ops::rx::Response {
status: ops::Status::Finished,
..Default::default()
});
}
let response = self
.state
.poll_request(&mut self.request, context)?
.rx
.expect("invalid response");
self.state.rx = response.status;
Ok(response)
}
}
impl<'state, 'chunks> Future for RxRequest<'state, 'chunks> {
type Output = Result<ops::rx::Response, StreamError>;
fn poll(
mut self: Pin<&mut Self>,
context: &mut Context,
) -> Poll<Result<ops::rx::Response, StreamError>> {
Self::poll(&mut self, Some(context))?.into()
}
}