Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
runtime: rework binding of new tasks (#3955)
- Loading branch information
Showing
20 changed files
with
504 additions
and
271 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,141 @@ | ||
| //! This module has containers for storing the tasks spawned on a scheduler. The | ||
| //! `OwnedTasks` container is thread-safe but can only store tasks that | ||
| //! implement Send. The `LocalOwnedTasks` container is not thread safe, but can | ||
| //! store non-Send tasks. | ||
| //! | ||
| //! The collections can be closed to prevent adding new tasks during shutdown of | ||
| //! the scheduler with the collection. | ||
|
|
||
| use crate::future::Future; | ||
| use crate::loom::sync::Mutex; | ||
| use crate::runtime::task::Task; | ||
| use crate::runtime::task::{JoinHandle, Notified, Schedule, Task}; | ||
| use crate::util::linked_list::{Link, LinkedList}; | ||
|
|
||
| use std::marker::PhantomData; | ||
|
|
||
| pub(crate) struct OwnedTasks<S: 'static> { | ||
| list: Mutex<LinkedList<Task<S>, <Task<S> as Link>::Target>>, | ||
| inner: Mutex<OwnedTasksInner<S>>, | ||
| } | ||
| struct OwnedTasksInner<S: 'static> { | ||
| list: LinkedList<Task<S>, <Task<S> as Link>::Target>, | ||
| closed: bool, | ||
| } | ||
|
|
||
| pub(crate) struct LocalOwnedTasks<S: 'static> { | ||
| list: LinkedList<Task<S>, <Task<S> as Link>::Target>, | ||
| closed: bool, | ||
| _not_send: PhantomData<*const ()>, | ||
| } | ||
|
|
||
| impl<S: 'static> OwnedTasks<S> { | ||
| pub(crate) fn new() -> Self { | ||
| Self { | ||
| list: Mutex::new(LinkedList::new()), | ||
| inner: Mutex::new(OwnedTasksInner { | ||
| list: LinkedList::new(), | ||
| closed: false, | ||
| }), | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn push_front(&self, task: Task<S>) { | ||
| self.list.lock().push_front(task); | ||
| /// Bind the provided task to this OwnedTasks instance. This fails if the | ||
| /// OwnedTasks has been closed. | ||
| pub(crate) fn bind<T>( | ||
| &self, | ||
| task: T, | ||
| scheduler: S, | ||
| ) -> (JoinHandle<T::Output>, Option<Notified<S>>) | ||
| where | ||
| S: Schedule, | ||
| T: Future + Send + 'static, | ||
| T::Output: Send + 'static, | ||
| { | ||
| let (task, notified, join) = super::new_task(task, scheduler); | ||
|
|
||
| let mut lock = self.inner.lock(); | ||
| if lock.closed { | ||
| drop(lock); | ||
| drop(task); | ||
| notified.shutdown(); | ||
| (join, None) | ||
| } else { | ||
| lock.list.push_front(task); | ||
| (join, Some(notified)) | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn pop_back(&self) -> Option<Task<S>> { | ||
| self.list.lock().pop_back() | ||
| self.inner.lock().list.pop_back() | ||
| } | ||
|
|
||
| /// The caller must ensure that if the provided task is stored in a | ||
| /// linked list, then it is in this linked list. | ||
| pub(crate) unsafe fn remove(&self, task: &Task<S>) -> Option<Task<S>> { | ||
| self.list.lock().remove(task.header().into()) | ||
| self.inner.lock().list.remove(task.header().into()) | ||
| } | ||
|
|
||
| pub(crate) fn is_empty(&self) -> bool { | ||
| self.inner.lock().list.is_empty() | ||
| } | ||
|
|
||
| #[cfg(feature = "rt-multi-thread")] | ||
| pub(crate) fn is_closed(&self) -> bool { | ||
| self.inner.lock().closed | ||
| } | ||
|
|
||
| /// Close the OwnedTasks. This prevents adding new tasks to the collection. | ||
| pub(crate) fn close(&self) { | ||
| self.inner.lock().closed = true; | ||
| } | ||
| } | ||
|
|
||
| impl<S: 'static> LocalOwnedTasks<S> { | ||
| pub(crate) fn new() -> Self { | ||
| Self { | ||
| list: LinkedList::new(), | ||
| closed: false, | ||
| _not_send: PhantomData, | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn bind<T>( | ||
| &mut self, | ||
| task: T, | ||
| scheduler: S, | ||
| ) -> (JoinHandle<T::Output>, Option<Notified<S>>) | ||
| where | ||
| S: Schedule, | ||
| T: Future + 'static, | ||
| T::Output: 'static, | ||
| { | ||
| let (task, notified, join) = super::new_task(task, scheduler); | ||
|
|
||
| if self.closed { | ||
| drop(task); | ||
| notified.shutdown(); | ||
| (join, None) | ||
| } else { | ||
| self.list.push_front(task); | ||
| (join, Some(notified)) | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn pop_back(&mut self) -> Option<Task<S>> { | ||
| self.list.pop_back() | ||
| } | ||
|
|
||
| /// The caller must ensure that if the provided task is stored in a | ||
| /// linked list, then it is in this linked list. | ||
| pub(crate) unsafe fn remove(&mut self, task: &Task<S>) -> Option<Task<S>> { | ||
| self.list.remove(task.header().into()) | ||
| } | ||
|
|
||
| pub(crate) fn is_empty(&self) -> bool { | ||
| self.list.lock().is_empty() | ||
| self.list.is_empty() | ||
| } | ||
|
|
||
| /// Close the LocalOwnedTasks. This prevents adding new tasks to the | ||
| /// collection. | ||
| pub(crate) fn close(&mut self) { | ||
| self.closed = true; | ||
| } | ||
| } |
Oops, something went wrong.
2087f3eThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible performance regression was detected for benchmark 'sync_mpsc'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold
2.send_large64390ns/iter (± 6099)29702ns/iter (± 338)2.17This comment was automatically generated by workflow using github-action-benchmark.
CC: @tokio-rs/maintainers