rt: implement initial set of task hooks #6742
Merged
Conversation
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
github-actions
bot
added
R-loom-current-thread
Darksonn
added
A-tokio
Noah-Kennedy
force-pushed
the
noah/task-hooks
branch
2 times, most recently
from
7dfe910 to
12debd5
Compare
|
Can you summarize the intended use-case? |
Noah-Kennedy
force-pushed
the
noah/task-hooks
branch
from
12debd5 to
de28721
Compare
Sure! The initial use-case here is for book-keeping purposes, such as tracking long-running tasks which may not be spawned by the user (e.g those in hyper) and thus may not be instrumentable through other means. I'd like to add support later down the line for before_poll and after_poll hooks to allow for similar things to be done with all task polls on the runtime (regardless of whether or not you can instrument them). |
Noah-Kennedy
force-pushed
the
noah/task-hooks
branch
from
902cc4f to
b157f1f
Compare
This change implements two hooks for per-task actions, one which is invoked on task spawn, and one which is invoked during task termination. These hooks initially are only supplied with the task ID (on unstable only), but more information can be added in the future, as the struct used to supply parameters is opaque. Fixes #3181.
Noah-Kennedy
force-pushed
the
noah/task-hooks
branch
from
b157f1f to
4dde1ca
Compare
Darksonn
reviewed
Aug 2, 2024
|
@Darksonn per our conversation elsewhere, I'll gate this API behind tokio_unstable for now |
|
@Darksonn I've requested a re-review from you and gated this behind tokio_unstable. |
Darksonn
reviewed
Aug 6, 2024
mox692
reviewed
Aug 6, 2024
Co-authored-by: Alice Ryhl <[email protected]>
Darksonn
reviewed
Aug 15, 2024
mox692
approved these changes
Aug 16, 2024
kodiakhq bot
pushed a commit
to pdylanross/fatigue
that referenced
this pull request
Aug 30, 2024
Bumps tokio from 1.39.3 to 1.40.0.
Release notes
Sourced from tokio's releases.
Tokio v1.40.0
1.40.0 (August 30th, 2024)
Added
io: add util::SimplexStream (#6589)
process: stabilize Command::process_group (#6731)
sync: add {TrySendError,SendTimeoutError}::into_inner (#6755)
task: add JoinSet::join_all (#6784)
Added (unstable)
runtime: add Builder::{on_task_spawn, on_task_terminate} (#6742)
Changed
io: use vectored io for write_all_buf when possible (#6724)
runtime: prevent niche-optimization to avoid triggering miri (#6744)
sync: mark mpsc types as UnwindSafe (#6783)
sync,time: make Sleep and BatchSemaphore instrumentation explicit roots (#6727)
task: use NonZeroU64 for task::Id (#6733)
task: include panic message when printing JoinError (#6753)
task: add #[must_use] to JoinHandle::abort_handle (#6762)
time: eliminate timer wheel allocations (#6779)
Documented
docs: clarify that [build] section doesn't go in Cargo.toml (#6728)
io: clarify zero remaining capacity case (#6790)
macros: improve documentation for select! (#6774)
sync: document mpsc channel allocation behavior (#6773)
#6589: tokio-rs/tokio#6589
#6724: tokio-rs/tokio#6724
#6727: tokio-rs/tokio#6727
#6728: tokio-rs/tokio#6728
#6731: tokio-rs/tokio#6731
#6733: tokio-rs/tokio#6733
#6742: tokio-rs/tokio#6742
#6744: tokio-rs/tokio#6744
#6753: tokio-rs/tokio#6753
#6755: tokio-rs/tokio#6755
#6762: tokio-rs/tokio#6762
#6773: tokio-rs/tokio#6773
#6774: tokio-rs/tokio#6774
#6779: tokio-rs/tokio#6779
#6783: tokio-rs/tokio#6783
#6784: tokio-rs/tokio#6784
#6790: tokio-rs/tokio#6790
Commits
ea6d652 chore: prepare Tokio v1.40.0 (#6806)
11f66f4 chore: replace ready! with std::task::ready! (#6804)
479a56a time: eliminate timer wheel allocations (#6779)
b37f0de runtime: implement initial set of task hooks (#6742)
c9fad08 codec: fix typo in the docs for Encoder::Error (#6800)
cc70a21 task: add join_all method to JoinSet (#6784)
1ac8dff task: add AbortOnDropHandle type (#6786)
ff3f2a8 io: add SimplexStream (#6589)
5b9a290 io: clarify zero remaining capacity case (#6790)
70569bd task: fix typo in TaskTracker docs (#6792)
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change implements two hooks for per-task actions, one which is invoked on task spawn, and one which is invoked during task termination.
These hooks initially are only supplied with the task ID (on unstable only), but more information can be added in the future, as the struct used to supply parameters is opaque.
Fixes #3181.