Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion tokio/src/net/tcp/stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1112,8 +1112,16 @@ impl TcpStream {
/// This function will cause all pending and future I/O on the specified
/// portions to return immediately with an appropriate value (see the
/// documentation of `Shutdown`).
///
/// Remark: this function transforms `Err(std::io::ErrorKind::NotConnected)` to `Ok(())`.
/// It does this to abstract away OS specific logic and to prevent a race condition between
/// this function call and the OS closing this socket because of external events (e.g. TCP reset).
/// See <https://github.com/tokio-rs/tokio/issues/4665> for more information.
pub(super) fn shutdown_std(&self, how: Shutdown) -> io::Result<()> {
self.io.shutdown(how)
match self.io.shutdown(how) {
Err(err) if err.kind() == std::io::ErrorKind::NotConnected => Ok(()),
result => result,
}
}

/// Gets the value of the `TCP_NODELAY` option on this socket.
Expand Down
55 changes: 54 additions & 1 deletion tokio/tests/tcp_shutdown.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@
#![cfg(all(feature = "full", not(target_os = "wasi"), not(miri)))] // Wasi doesn't support bind
// No `socket` on miri.

use std::time::Duration;
use tokio::io::{self, AsyncReadExt, AsyncWriteExt};
use tokio::net::{TcpListener, TcpStream};
use tokio::sync::oneshot::channel;
use tokio_test::assert_ok;

#[tokio::test]
async fn shutdown() {
let srv = assert_ok!(TcpListener::bind("127.0.0.1:0").await);
let addr = assert_ok!(srv.local_addr());

tokio::spawn(async move {
let handle = tokio::spawn(async move {
let mut stream = assert_ok!(TcpStream::connect(&addr).await);

assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
Expand All @@ -26,4 +28,55 @@ async fn shutdown() {

let n = assert_ok!(io::copy(&mut rd, &mut wr).await);
assert_eq!(n, 0);
assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
handle.await.unwrap()
}

#[tokio::test]
async fn shutdown_after_tcp_reset() {
let srv = assert_ok!(TcpListener::bind("127.0.0.1:0").await);
let addr = assert_ok!(srv.local_addr());

let (connected_tx, connected_rx) = channel();
let (dropped_tx, dropped_rx) = channel();

let handle = tokio::spawn(async move {
let mut stream = assert_ok!(TcpStream::connect(&addr).await);
connected_tx.send(()).unwrap();

dropped_rx.await.unwrap();
assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
});

let (stream, _) = assert_ok!(srv.accept().await);
// By setting linger to 0 we will trigger a TCP reset
stream.set_linger(Some(Duration::new(0, 0))).unwrap();
connected_rx.await.unwrap();

drop(stream);
dropped_tx.send(()).unwrap();

handle.await.unwrap();
}

#[tokio::test]
async fn shutdown_multiple_calls() {
let srv = assert_ok!(TcpListener::bind("127.0.0.1:0").await);
let addr = assert_ok!(srv.local_addr());

let (connected_tx, connected_rx) = channel();

let handle = tokio::spawn(async move {
let mut stream = assert_ok!(TcpStream::connect(&addr).await);
connected_tx.send(()).unwrap();
assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
});

let (mut stream, _) = assert_ok!(srv.accept().await);
connected_rx.await.unwrap();

assert_ok!(AsyncWriteExt::shutdown(&mut stream).await);
handle.await.unwrap();
}
Loading