Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. #118960

tvallotton · 2023-12-15T02:22:17Z

Implementation for #118959.

rustbot · 2023-12-15T02:22:24Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

library/core/src/task/wake.rs

tvallotton · 2023-12-15T13:16:21Z

This CI failure is strange:

Error: tidy error: /checkout/library/core/src/task/wake.rs:713: issue "87021" mismatches the previous issue of "96992"

It seems the error message is correct about the fact that we shouldn't be linking to #87021 and we should link instead to #96992. But it makes me question why does it only fail on my branch, I didn't change this issue number after all.

rustbot · 2023-12-15T13:32:55Z

rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead.

cc @rust-lang/rust-analyzer

tvallotton · 2023-12-15T22:41:33Z

Just for the record, it might be wise to check if ContextBuilder<'a> should be future proofed to be invariant, since I noticed that the with_waker example seems to break when changing the variance. Naturally, that makes the implementation of From<&mut Context> practically useless.

EDIT: This implementation was later removed

Mark-Simulacrum

Do we have signoff from T-libs-api on the new unstable surface area? The ACP issue seems to have had a good bit of discussion but I didn't see that signoff made explicit. If you can drive that towards a comment here or there and/or link something, that would be good.

I'm particularly concerned about the surface area confusing newer users -- especially given the frequent concerns over async complexity -- I wonder if we should add a sentence/paragraph to the top-level docs in https://doc.rust-lang.org/nightly/std/task/index.html to clarify the current state (i.e., stable surface area should be sufficient for most uses or so).

library/alloc/src/task.rs

library/core/src/task/wake.rs

tvallotton · 2024-01-13T16:51:26Z

I wonder if we should add a sentence/paragraph to the top-level docs in https://doc.rust-lang.org/nightly/std/task/index.html to clarify the current state (i.e., stable surface area should be sufficient for most uses or so).

I think it may be better to put it on the docs for LocalWaker. What do you think?

Thomasdezeeuw

I like to see a LocalWaker type, but this not the way to do it in my opinion. That's coming from someone who has written a lot of Futures, async function and a runtime specialised in thread-locality (i.e. I very much like to see this change).

I don't think making the Waker optional in Context is wise considering all existing Future related code depends on the Waker type always being part of the Context, it was never not there, a promise we're walking back with this pr.

library/core/src/task/wake.rs

tvallotton · 2024-01-13T18:12:37Z

I made the waker type mandatory on the last commit. Several people have expressed their concern with this aspect of the API. And while I do think that it is better for them to be optional than not, that is not something I consider terribly important.

bors · 2024-01-20T05:44:26Z

☔ The latest upstream changes (presumably #120136) made this pull request unmergeable. Please resolve the merge conflicts.

…w the extention of contexts by futures

…y removing a #[cfg(target_has_atomic = ptr)]

Co-authored-by: Mark Rousskov <mark.simulacrum@gmail.com>

…ation

This also removes * impl From<&Context> for ContextBuilder * Context::try_waker() The from implementation is removed because now that wakers are always supported, there are less incentives to override the current context. Before, the incentive was to add Waker support to a reactor that didn't have any.

tvallotton · 2024-01-28T16:23:37Z

@Mark-Simulacrum Do we really need an explicit signoff here? Both teams have discussed it and approved nightly experimentation (libs-team, wg-async). I feel that with no significant changes on the proposal, it is going to be hard to get the teams to meet to discuss the same topic again.

Mark-Simulacrum · 2024-01-28T16:30:45Z

Those comments seem sufficient to me (I hadn't seen them in my quick skim) for nightly experimentation.

@rustbot ready

Mark-Simulacrum · 2024-02-04T15:43:19Z

@bors r+

bors · 2024-02-04T15:43:21Z

📌 Commit 180c68b has been approved by Mark-Simulacrum

It is now in the queue for this repository.

…ulacrum Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. Implementation for rust-lang#118959.

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#113833 (`std::error::Error` -> Trait Implementations: lifetimes consistency improvement) - rust-lang#115386 (PartialEq, PartialOrd: update and synchronize handling of transitive chains) - rust-lang#116284 (make matching on NaN a hard error, and remove the rest of illegal_floating_point_literal_pattern) - rust-lang#118960 (Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc.) - rust-lang#120060 (Use the same mir-opt bless targets on all platforms) - rust-lang#120214 (match lowering: consistently lower bindings deepest-first) - rust-lang#120384 (Use `<T, U>` for array/slice equality `impl`s) r? `@ghost` `@rustbot` modify labels: rollup

…ulacrum Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. Implementation for rust-lang#118959.

…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#113833 (`std::error::Error` -> Trait Implementations: lifetimes consistency improvement) - rust-lang#115386 (PartialEq, PartialOrd: update and synchronize handling of transitive chains) - rust-lang#116284 (make matching on NaN a hard error, and remove the rest of illegal_floating_point_literal_pattern) - rust-lang#118960 (Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc.) - rust-lang#120384 (Use `<T, U>` for array/slice equality `impl`s) - rust-lang#120518 (riscv only supports split_debuginfo=off for now) - rust-lang#120619 (Assert that params with the same *index* have the same *name*) - rust-lang#120657 (Remove unused struct) - rust-lang#120661 (target: default to the medium code model on LoongArch targets) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#113833 (`std::error::Error` -> Trait Implementations: lifetimes consistency improvement) - rust-lang#115386 (PartialEq, PartialOrd: update and synchronize handling of transitive chains) - rust-lang#116284 (make matching on NaN a hard error, and remove the rest of illegal_floating_point_literal_pattern) - rust-lang#118960 (Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc.) - rust-lang#120384 (Use `<T, U>` for array/slice equality `impl`s) - rust-lang#120518 (riscv only supports split_debuginfo=off for now) - rust-lang#120657 (Remove unused struct) - rust-lang#120661 (target: default to the medium code model on LoongArch targets) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#118960 - tvallotton:local_waker, r=Mark-Simulacrum Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. Implementation for rust-lang#118959.

fix: waker_getters tracking issue from 87021 for 96992. I was directed to make the fix here by this comment rust-lang/rust#118960 (comment).

…ulacrum Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. Implementation for rust-lang#118959.

rustbot assigned Mark-Simulacrum Dec 15, 2023

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Dec 15, 2023

This comment has been minimized.

Sign in to view

tvallotton mentioned this pull request Dec 15, 2023

Tracking Issue for LocalWaker #118959

Open

4 tasks

This comment has been minimized.

Sign in to view

cynecx reviewed Dec 15, 2023

View reviewed changes

library/core/src/task/wake.rs Show resolved Hide resolved

workingjubilee added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Dec 15, 2023

This was referenced Dec 15, 2023

Fix tracking issue for waker_getters rust-lang/rust-analyzer#16132

Closed

fix: waker_getters tracking issue from 87021 for 96992. rust-lang/rust-analyzer#16134

Merged

Mark-Simulacrum reviewed Dec 31, 2023

View reviewed changes

Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 31, 2023

tvallotton mentioned this pull request Jan 13, 2024

Add LocalWaker support rust-lang/libs-team#191

Open

Thomasdezeeuw suggested changes Jan 13, 2024

View reviewed changes

library/core/src/task/wake.rs Outdated Show resolved Hide resolved

tvallotton added 8 commits January 20, 2024 10:13

feat: add LocalWaker type, ContextBuilder type, and LocalWake trait.

60a0819

perf: move null check from local_wake() to build()

0cb5e2f

refactor: remove in favor of and to make the API infallible.

232cc2b

feat: add try_waker and From<&mut Context> for ContextBuilder to allo…

403718b

…w the extention of contexts by futures

fix: make LocalWake available in targets that don't support atomics b…

2012d4b

…y removing a #[cfg(target_has_atomic = ptr)]

chore: add tracking issue number to local waker feature

0cb7a0a

feat: impl AsRef<LocalWaker> for Waker.

f824373

chore: fix ci failures

093f80b

tvallotton and others added 6 commits January 20, 2024 10:14

doc: update thread safety explanation for RawWakerVTable and RawWaker.

a8e71f2

fix: Apply suggestions from code review

c67a446

Co-authored-by: Mark Rousskov <mark.simulacrum@gmail.com>

docs: remove recommendations to use LocalWaker in stable API document…

eccb5e7

…ation

chore: make method order consistent with waker

7c6a9cb

doc: fix some doctests after rebase

180c68b

tvallotton force-pushed the local_waker branch from 5e55bad to 180c68b Compare January 20, 2024 13:28

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 28, 2024

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 4, 2024

matthiaskrgr mentioned this pull request Feb 5, 2024

Rollup of 7 pull requests #120663

Closed

matthiaskrgr mentioned this pull request Feb 5, 2024

Rollup of 9 pull requests #120666

Closed

matthiaskrgr mentioned this pull request Feb 5, 2024

Rollup of 8 pull requests #120671

Merged

bors merged commit 80e8c7e into rust-lang:master Feb 5, 2024
11 checks passed

rustbot added this to the 1.78.0 milestone Feb 5, 2024

bors added a commit to rust-lang/rust-analyzer that referenced this pull request Feb 8, 2024

Auto merge of #16134 - tvallotton:master, r=Veykril

6655960

fix: waker_getters tracking issue from 87021 for 96992. I was directed to make the fix here by this comment rust-lang/rust#118960 (comment).

fmease mentioned this pull request Mar 31, 2024

regression: Context changed sizes #123283

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. #118960

Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. #118960

tvallotton commented Dec 15, 2023

rustbot commented Dec 15, 2023

This comment has been minimized.

This comment has been minimized.

tvallotton commented Dec 15, 2023

rustbot commented Dec 15, 2023

tvallotton commented Dec 15, 2023 •

edited

Mark-Simulacrum left a comment

tvallotton commented Jan 13, 2024

Thomasdezeeuw left a comment

tvallotton commented Jan 13, 2024

bors commented Jan 20, 2024

tvallotton commented Jan 28, 2024

Mark-Simulacrum commented Jan 28, 2024

Mark-Simulacrum commented Feb 4, 2024

bors commented Feb 4, 2024

Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. #118960

Add LocalWaker and ContextBuilder types to core, and LocalWake trait to alloc. #118960

Conversation

tvallotton commented Dec 15, 2023

rustbot commented Dec 15, 2023

This comment has been minimized.

This comment has been minimized.

tvallotton commented Dec 15, 2023

rustbot commented Dec 15, 2023

tvallotton commented Dec 15, 2023 • edited

Mark-Simulacrum left a comment

Choose a reason for hiding this comment

tvallotton commented Jan 13, 2024

Thomasdezeeuw left a comment

Choose a reason for hiding this comment

tvallotton commented Jan 13, 2024

bors commented Jan 20, 2024

tvallotton commented Jan 28, 2024

Mark-Simulacrum commented Jan 28, 2024

Mark-Simulacrum commented Feb 4, 2024

bors commented Feb 4, 2024

tvallotton commented Dec 15, 2023 •

edited