io: make duplex stream cooperative (#4470) #4478

GongLG · 2022-02-07T02:00:27Z

Add coop checks on pipe poll_read and poll_write.

Motivation

This attempts to fix #4470 DuplexStream does not participate in coop.

Solution

Similar to what's done in #4291. The change calls coop poll_proceed to decrement budge on poll_read and poll_write, then it calls made_progress to resume budget if made progress.

Testing

Without the changes, the added duplex_is_cooperative test would hang.
Ran cargo build, check and test with all-features. Ran cargo fmt.

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn · 2022-02-07T08:15:19Z

tokio/src/io/util/mem.rs

@@ -185,6 +185,7 @@ impl AsyncRead for Pipe {
        cx: &mut task::Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
+        ready!(poll_proceed_and_make_progress(cx));


We shouldn't make progress if it returns Poll::Pending.

Yea, looks like instead of calling make_progress always, we need to poll proceed at the start, and only call make_progress in the two branches below that would return Poll::Ready.

Darksonn · 2022-02-07T08:17:06Z

tokio/src/io/util/mem.rs

+cfg_coop! {
+    fn poll_proceed_and_make_progress(cx: &mut task::Context<'_>) -> Poll<()> {
+        let coop = ready!(crate::coop::poll_proceed(cx));
+        coop.made_progress();
+        Poll::Ready(())
+    }
+}


We aren't doing this conditional thing in src/io/util/empty.rs. Why is it needed here?

I'm not sure what you mean. It looks like it's in there:

tokio/tokio/src/io/util/empty.rs

Line 78 in d6143c9

cfg_coop! {

Hi! Thanks for the review!

Maybe I read it wrong but I thought this is added in https://github.com/tokio-rs/tokio/blob/master/tokio/src/io/util/empty.rs#L78-L90 so I thought we only want this under coop feature. I can change it real quick if this is not the plan.

Oh, seems like I'm just blind.

GongLG · 2022-02-08T02:18:14Z

Btw apparently I didn't run the build without coop cfg..I will fix the build.

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn · 2022-02-08T09:12:57Z

tokio/tests/io_mem_stream.rs

+                let buf = [3u8; 4096];
+                let _ = tx.write_all(&buf).await;
+                let mut buf = [0u8; 4096];
+                let _ = rx.read(&mut buf).await;


Suggested change

let buf = [3u8; 4096];

let _ = tx.write_all(&buf).await;

let mut buf = [0u8; 4096];

let _ = rx.read(&mut buf).await;

let buf = [3u8; 4096];

tx.write_all(&buf).await.unwrap();

let mut buf = [0u8; 4096];

rx.read(&mut buf).await.unwrap();

Darksonn · 2022-02-08T09:13:20Z

tokio/src/io/util/mem.rs

+
+    cfg_not_coop! {
+        fn poll_write(
+            mut self: Pin<&mut Self>,


You're getting a CI failure due to some warnings about these being unnecessary:

Suggested change

mut self: Pin<&mut Self>,

self: Pin<&mut Self>,

Ah..yeah..I fixed it once because the warning showed up in local build, but I guess I messed up git merge so this isn't removed here. Thanks I will fix it.

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn

Thanks.

# 1.16.2 (February 15, 2022) This release updates the minimum supported Rust version (MSRV) to 1.49, the `mio` dependency to v0.8, and the (optional) `parking_lot` dependency to v0.12. Additionally, it contains several bug fixes, as well as internal refactoring and performance improvements. ### Fixed - time: prevent panicking in `sleep` with large durations ([#4495]) - time: eliminate potential panics in `Instant` arithmetic on platforms where `Instant::now` is not monotonic ([#4461]) - io: fix `DuplexStream` not participating in cooperative yielding ([#4478]) - rt: fix potential double panic when dropping a `JoinHandle` ([#4430]) ### Changed - update minimum supported Rust version to 1.49 ([#4457]) - update `parking_lot` dependency to v0.12.0 ([#4459]) - update `mio` dependency to v0.8 ([#4449]) - rt: remove an unnecessary lock in the blocking pool ([#4436]) - rt: remove an unnecessary enum in the basic scheduler ([#4462]) - time: use bit manipulation instead of modulo to improve performance ([#4480]) - net: use `std::future::Ready` instead of our own `Ready` future ([#4271]) - replace deprecated `atomic::spin_loop_hint` with `hint::spin_loop` ([#4491]) - fix miri failures in intrusive linked lists ([#4397]) ### Documented - io: add an example for `tokio::process::ChildStdin` ([#4479]) ### Unstable The following changes only apply when building with `--cfg tokio_unstable`: - task: fix missing location information in `tracing` spans generated by `spawn_local` ([#4483]) - task: add `JoinSet` for managing sets of tasks ([#4335]) - metrics: fix compilation error on MIPS ([#4475]) - metrics: fix compilation error on arm32v7 ([#4453]) [#4495]: #4495 [#4461]: #4461 [#4478]: #4478 [#4430]: #4430 [#4457]: #4457 [#4459]: #4459 [#4449]: #4449 [#4462]: #4462 [#4436]: #4436 [#4480]: #4480 [#4271]: #4271 [#4491]: #4491 [#4397]: #4397 [#4479]: #4479 [#4483]: #4483 [#4335]: #4335 [#4475]: #4475 [#4453]: #4453

# 1.17.0 (February 16, 2022) This release updates the minimum supported Rust version (MSRV) to 1.49, the `mio` dependency to v0.8, and the (optional) `parking_lot` dependency to v0.12. Additionally, it contains several bug fixes, as well as internal refactoring and performance improvements. ### Fixed - time: prevent panicking in `sleep` with large durations ([#4495]) - time: eliminate potential panics in `Instant` arithmetic on platforms where `Instant::now` is not monotonic ([#4461]) - io: fix `DuplexStream` not participating in cooperative yielding ([#4478]) - rt: fix potential double panic when dropping a `JoinHandle` ([#4430]) ### Changed - update minimum supported Rust version to 1.49 ([#4457]) - update `parking_lot` dependency to v0.12.0 ([#4459]) - update `mio` dependency to v0.8 ([#4449]) - rt: remove an unnecessary lock in the blocking pool ([#4436]) - rt: remove an unnecessary enum in the basic scheduler ([#4462]) - time: use bit manipulation instead of modulo to improve performance ([#4480]) - net: use `std::future::Ready` instead of our own `Ready` future ([#4271]) - replace deprecated `atomic::spin_loop_hint` with `hint::spin_loop` ([#4491]) - fix miri failures in intrusive linked lists ([#4397]) ### Documented - io: add an example for `tokio::process::ChildStdin` ([#4479]) ### Unstable The following changes only apply when building with `--cfg tokio_unstable`: - task: fix missing location information in `tracing` spans generated by `spawn_local` ([#4483]) - task: add `JoinSet` for managing sets of tasks ([#4335]) - metrics: fix compilation error on MIPS ([#4475]) - metrics: fix compilation error on arm32v7 ([#4453]) [#4495]: #4495 [#4461]: #4461 [#4478]: #4478 [#4430]: #4430 [#4457]: #4457 [#4459]: #4459 [#4449]: #4449 [#4462]: #4462 [#4436]: #4436 [#4480]: #4480 [#4271]: #4271 [#4491]: #4491 [#4397]: #4397 [#4479]: #4479 [#4483]: #4483 [#4335]: #4335 [#4475]: #4475 [#4453]: #4453

io: make duplex stream cooperative (tokio-rs#4470)

0b9acc6

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn added A-tokio Area: The main tokio crate M-coop Module: tokio/coop M-io Module: tokio/io labels Feb 7, 2022

Darksonn reviewed Feb 7, 2022

View reviewed changes

GongLG and others added 3 commits February 7, 2022 21:05

Merge branch 'tokio-rs:master' into master

a9d580f

io: make duplex stream cooperative (tokio-rs#4470)

6a3b85d

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

io: make duplex stream cooperative (tokio-rs#4470)

5031a54

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn reviewed Feb 8, 2022

View reviewed changes

GongLG and others added 2 commits February 8, 2022 14:13

Merge branch 'tokio-rs:master' into master

40416b3

io: make duplex stream cooperative (tokio-rs#4470)

26c26c4

Add coop checks on pipe poll_read and poll_write. Fixes: tokio-rs#4470 Refs: tokio-rs#4291, tokio-rs#4300

Darksonn approved these changes Feb 9, 2022

View reviewed changes

Darksonn merged commit fd4d2b0 into tokio-rs:master Feb 9, 2022

hawkw mentioned this pull request Feb 15, 2022

chore: prepare Tokio v1.17.0 release #4504

Merged

softdevca mentioned this pull request Feb 17, 2022

Bump tokio from 1.16.1 to 1.17.0 softdevca/mootranscode#55

Merged

mox692 mentioned this pull request Dec 29, 2023

io: make repeat and sink cooperative #6254

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

io: make duplex stream cooperative (#4470) #4478

io: make duplex stream cooperative (#4470) #4478

GongLG commented Feb 7, 2022

Darksonn Feb 7, 2022

seanmonstar Feb 7, 2022

Darksonn Feb 7, 2022

seanmonstar Feb 7, 2022

GongLG Feb 8, 2022

Darksonn Feb 8, 2022

GongLG commented Feb 8, 2022

Darksonn Feb 8, 2022

Darksonn Feb 8, 2022

GongLG Feb 8, 2022

Darksonn left a comment

io: make duplex stream cooperative (#4470) #4478

io: make duplex stream cooperative (#4470) #4478

Conversation

GongLG commented Feb 7, 2022

Motivation

Solution

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GongLG commented Feb 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Darksonn left a comment

Choose a reason for hiding this comment