Skip to content

sync: add sender_weak_count and sender_strong_count for Receiver #6661

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.

Sign up for GitHub

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

Merged
wathenjiang merged 2 commits into from
Jul 2, 2024
Merged

sync: add sender_weak_count and sender_strong_count for Receiver #6661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cf8228
sync: add weak_count and strong_count for Receiver
0xPoe Jun 27, 2024
954858c
refactor: rename
0xPoe Jul 1, 2024
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: 10 additions & 0 deletions tokio/src/sync/mpsc/bounded.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,16 @@ impl<T> Receiver<T> {
) -> Poll<usize> {
self.chan.recv_many(cx, buffer, limit)
}

/// Returns the number of [`Sender`] handles.
pub fn sender_strong_count(&self) -> usize {
self.chan.sender_strong_count()
}

/// Returns the number of [`WeakSender`] handles.
pub fn sender_weak_count(&self) -> usize {
self.chan.sender_weak_count()
}
}

impl<T> fmt::Debug for Receiver<T> {
Expand Down
8 changes: 8 additions & 0 deletions tokio/src/sync/mpsc/chan.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,14 @@ impl<T, S: Semaphore> Rx<T, S> {
pub(super) fn semaphore(&self) -> &S {
&self.inner.semaphore
}

pub(super) fn sender_strong_count(&self) -> usize {
self.inner.tx_count.load(Acquire)
}

pub(super) fn sender_weak_count(&self) -> usize {
self.inner.tx_weak_count.load(Relaxed)
Copy link
Copy Markdown

@randomairborne randomairborne Jun 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Why Relaxed here? Wouldn't Acquire be appropriate?
(I am curious, not saying you're wrong)

Copy link
Copy Markdown
Member

@Darksonn Darksonn Jun 30, 2024

Choose a reason for hiding this comment

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

It looks like this is just mirroring the orderings on the equivalent sender methods. I don't think it really matters.

Copy link
Copy Markdown
Contributor Author

@0xPoe 0xPoe Jul 1, 2024

Choose a reason for hiding this comment

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

The main difference between them as I understand it is that with tx_weak_count, it's simply a counter. So it doesn't matter what order it's in.
But with tx_count we rely on it to decide whether to close the channel or not, in addition to counting the number, and it's more of a synchronized operation, where we have to make sure that there is a guaranteed ordering of operations on it between threads.
I'm not sure if I'm right about this, I could be completely wrong 😆

}
}

impl<T, S: Semaphore> Drop for Rx<T, S> {
Expand Down
12 changes: 11 additions & 1 deletion tokio/src/sync/mpsc/unbounded.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ impl<T> UnboundedReceiver<T> {
/// assert!(!rx.is_closed());
///
/// rx.close();
///
///
/// assert!(rx.is_closed());
/// }
/// ```
Expand Down Expand Up @@ -498,6 +498,16 @@ impl<T> UnboundedReceiver<T> {
) -> Poll<usize> {
self.chan.recv_many(cx, buffer, limit)
}

/// Returns the number of [`UnboundedSender`] handles.
pub fn sender_strong_count(&self) -> usize {
self.chan.sender_strong_count()
}

/// Returns the number of [`WeakUnboundedSender`] handles.
pub fn sender_weak_count(&self) -> usize {
self.chan.sender_weak_count()
}
}

impl<T> UnboundedSender<T> {
Expand Down
33 changes: 24 additions & 9 deletions tokio/tests/sync_mpsc_weak.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,12 +532,13 @@ async fn test_rx_unbounded_is_closed_when_dropping_all_senders_except_weak_sende

#[tokio::test]
async fn sender_strong_count_when_cloned() {
let (tx, _rx) = mpsc::channel::<()>(1);
let (tx, rx) = mpsc::channel::<()>(1);

let tx2 = tx.clone();

assert_eq!(tx.strong_count(), 2);
assert_eq!(tx2.strong_count(), 2);
assert_eq!(rx.sender_strong_count(), 2);
}

#[tokio::test]
Expand All @@ -552,29 +553,31 @@ async fn sender_weak_count_when_downgraded() {

#[tokio::test]
async fn sender_strong_count_when_dropped() {
let (tx, _rx) = mpsc::channel::<()>(1);
let (tx, rx) = mpsc::channel::<()>(1);

let tx2 = tx.clone();

drop(tx2);

assert_eq!(tx.strong_count(), 1);
assert_eq!(rx.sender_strong_count(), 1);
}

#[tokio::test]
async fn sender_weak_count_when_dropped() {
let (tx, _rx) = mpsc::channel::<()>(1);
let (tx, rx) = mpsc::channel::<()>(1);

let weak = tx.downgrade();

drop(weak);

assert_eq!(tx.weak_count(), 0);
assert_eq!(rx.sender_weak_count(), 0);
}

#[tokio::test]
async fn sender_strong_and_weak_conut() {
let (tx, _rx) = mpsc::channel::<()>(1);
let (tx, rx) = mpsc::channel::<()>(1);

let tx2 = tx.clone();

Expand All @@ -585,67 +588,75 @@ async fn sender_strong_and_weak_conut() {
assert_eq!(tx2.strong_count(), 2);
assert_eq!(weak.strong_count(), 2);
assert_eq!(weak2.strong_count(), 2);
assert_eq!(rx.sender_strong_count(), 2);

assert_eq!(tx.weak_count(), 2);
assert_eq!(tx2.weak_count(), 2);
assert_eq!(weak.weak_count(), 2);
assert_eq!(weak2.weak_count(), 2);
assert_eq!(rx.sender_weak_count(), 2);

drop(tx2);
drop(weak2);

assert_eq!(tx.strong_count(), 1);
assert_eq!(weak.strong_count(), 1);
assert_eq!(rx.sender_strong_count(), 1);

assert_eq!(tx.weak_count(), 1);
assert_eq!(weak.weak_count(), 1);
assert_eq!(rx.sender_weak_count(), 1);
}

#[tokio::test]
async fn unbounded_sender_strong_count_when_cloned() {
let (tx, _rx) = mpsc::unbounded_channel::<()>();
let (tx, rx) = mpsc::unbounded_channel::<()>();

let tx2 = tx.clone();

assert_eq!(tx.strong_count(), 2);
assert_eq!(tx2.strong_count(), 2);
assert_eq!(rx.sender_strong_count(), 2);
}

#[tokio::test]
async fn unbounded_sender_weak_count_when_downgraded() {
let (tx, _rx) = mpsc::unbounded_channel::<()>();
let (tx, rx) = mpsc::unbounded_channel::<()>();

let weak = tx.downgrade();

assert_eq!(tx.weak_count(), 1);
assert_eq!(weak.weak_count(), 1);
assert_eq!(rx.sender_weak_count(), 1);
}

#[tokio::test]
async fn unbounded_sender_strong_count_when_dropped() {
let (tx, _rx) = mpsc::unbounded_channel::<()>();
let (tx, rx) = mpsc::unbounded_channel::<()>();

let tx2 = tx.clone();

drop(tx2);

assert_eq!(tx.strong_count(), 1);
assert_eq!(rx.sender_strong_count(), 1);
}

#[tokio::test]
async fn unbounded_sender_weak_count_when_dropped() {
let (tx, _rx) = mpsc::unbounded_channel::<()>();
let (tx, rx) = mpsc::unbounded_channel::<()>();

let weak = tx.downgrade();

drop(weak);

assert_eq!(tx.weak_count(), 0);
assert_eq!(rx.sender_weak_count(), 0);
}

#[tokio::test]
async fn unbounded_sender_strong_and_weak_conut() {
let (tx, _rx) = mpsc::unbounded_channel::<()>();
let (tx, rx) = mpsc::unbounded_channel::<()>();

let tx2 = tx.clone();

Expand All @@ -656,18 +667,22 @@ async fn unbounded_sender_strong_and_weak_conut() {
assert_eq!(tx2.strong_count(), 2);
assert_eq!(weak.strong_count(), 2);
assert_eq!(weak2.strong_count(), 2);
assert_eq!(rx.sender_strong_count(), 2);

assert_eq!(tx.weak_count(), 2);
assert_eq!(tx2.weak_count(), 2);
assert_eq!(weak.weak_count(), 2);
assert_eq!(weak2.weak_count(), 2);
assert_eq!(rx.sender_weak_count(), 2);

drop(tx2);
drop(weak2);

assert_eq!(tx.strong_count(), 1);
assert_eq!(weak.strong_count(), 1);
assert_eq!(rx.sender_strong_count(), 1);

assert_eq!(tx.weak_count(), 1);
assert_eq!(weak.weak_count(), 1);
assert_eq!(rx.sender_weak_count(), 1);
}