Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add a way to reserve many permits on bounded mpsc channel #6205

Merged
merged 45 commits into from Jan 2, 2024

Conversation

Totodore
Copy link
Contributor

@Totodore Totodore commented Dec 9, 2023

Motivation

I am in a situation where I need to be able to efficiently reserve n permit from the same mpsc::bounded channel. Because the Semaphore API already implement the possibility to reserve n permit. It is quite easy to propagate this API to the mpsc::bounded API. More details on this need can be found on the corresponding issue :

Solution

In order to avoid any API breaking change rather than adding a u32 field on the current Permit struct I added :

  • a ManyPermit struct
  • a reserve_many(n: u32) fn on the Sender struct
  • a try_reserve_many(n: u32) fn on the Sender struct

@github-actions github-actions bot added the R-loom-sync Run loom sync tests on this PR label Dec 9, 2023
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-sync Module: tokio/sync labels Dec 9, 2023
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
Totodore and others added 2 commits December 10, 2023 10:26
Totodore and others added 3 commits December 10, 2023 11:43
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
Co-authored-by: oliver <151407407+kwfn@users.noreply.github.com>
@Totodore
Copy link
Contributor Author

The scope of this PR has evolved a bit.
The internal batch_semaphore has been changed to take a usize permit count rather than a u32 permit count so that there is no conversion from usize to u32 because it might overflow.

@Darksonn
Copy link
Contributor

I think this looks reasonable. However, we will need some tests as well. Here are the tests that come to mind:

  • A test that just uses it to send n messages, then receives n messages. (You can wrap it in a for loop to try different values of n.)
  • A test that acquires n permits, sends k messages, and then drops the iterator. The capacity should be correct at the end. (Again with a for loop for a few differen t values of n and k.)
  • Test that you get a SendError in the right cases.
  • Test edge-cases, e.g. what happens if n == 0 or n == MAX_PERMITS or n == usize::MAX?

tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
tokio/tests/sync_mpsc.rs Outdated Show resolved Hide resolved
tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
@Totodore Totodore requested a review from Darksonn January 2, 2024 15:00
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. I came up with one minor improvement, but overall I think this is ready to be merged.

tokio/src/sync/mpsc/bounded.rs Outdated Show resolved Hide resolved
@Totodore
Copy link
Contributor Author

Totodore commented Jan 2, 2024

Ready to merge :).

@Darksonn Darksonn enabled auto-merge (squash) January 2, 2024 16:29
@Darksonn
Copy link
Contributor

Darksonn commented Jan 2, 2024

Thanks!

@Darksonn Darksonn merged commit 7c606ab into tokio-rs:master Jan 2, 2024
71 checks passed
@Totodore Totodore deleted the feat-mpsc-many-permit branch January 2, 2024 23:54
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Feb 5, 2024
Bumps tokio from 1.35.1 to 1.36.0.

Release notes
Sourced from tokio's releases.

Tokio v1.36.0
1.36.0 (February 2nd, 2024)
Added

io: add tokio::io::Join (#6220)
io: implement AsyncWrite for Empty (#6235)
net: add support for anonymous unix pipes (#6127)
net: add UnixSocket (#6290)
net: expose keepalive option on TcpSocket (#6311)
sync: add {Receiver,UnboundedReceiver}::poll_recv_many (#6236)
sync: add Sender::{try_,}reserve_many (#6205)
sync: add watch::Receiver::mark_unchanged (#6252)
task: add JoinSet::try_join_next (#6280)

Changed

io: make copy cooperative (#6265)
io: make repeat and sink cooperative (#6254)
io: simplify check for empty slice (#6293)
process: use pidfd on Linux when available (#6152)
sync: use AtomicBool in broadcast channel future (#6298)

Documented

io: clarify clear_ready docs (#6304)
net: document that *Fd traits on TcpSocket are unix-only (#6294)
sync: document FIFO behavior of tokio::sync::Mutex (#6279)
chore: typographic improvements (#6262)
runtime: remove obsolete comment (#6303)
task: fix typo (#6261)

#6220: tokio-rs/tokio#6220
#6235: tokio-rs/tokio#6235
#6127: tokio-rs/tokio#6127
#6290: tokio-rs/tokio#6290
#6311: tokio-rs/tokio#6311
#6236: tokio-rs/tokio#6236
#6205: tokio-rs/tokio#6205
#6252: tokio-rs/tokio#6252
#6280: tokio-rs/tokio#6280
#6265: tokio-rs/tokio#6265
#6254: tokio-rs/tokio#6254
#6293: tokio-rs/tokio#6293
#6238: tokio-rs/tokio#6238
#6152: tokio-rs/tokio#6152
#6298: tokio-rs/tokio#6298
#6262: tokio-rs/tokio#6262
#6303: tokio-rs/tokio#6303
#6261: tokio-rs/tokio#6261


... (truncated)


Commits

eaf81ed chore: prepare Tokio v1.36.0 (#6312)
53f9e5a ci: make sure dictionary words are sorted and unique (#6316)
9077762 net: expose keepalive option on TcpSocket (#6311)
131e7b4 ci: add spellchecking (#6297)
e53b92a io: clarify clear_ready docs (#6304)
7536132 sync: use AtomicBool in broadcast channel future (#6298)
b6d0c90 macros: fix trait_method breaking change detection (#6308)
4846959 runtime: remove obsolete comment (#6303)
ec30383 net: add UnixSocket (#6290)
f80bbec io: simplify check for empty slice (#6293)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-sync Module: tokio/sync R-loom-sync Run loom sync tests on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a way to request many permits on a mpsc::channel
3 participants