Feature: Add more windows signal handlers #4924

jkelleyrtp · 2022-08-18T22:32:04Z

Add the other _event types from the winapi crate. Addresses #4921

Includes:

Console Close
Shutdown
Logoff

It might be worth tying console close into the ctrl_c handling framework, depending on how the Tokio authors consider it to fit.

Console Close I believe is analogous to unix's SIGHUP, which doesn't seem to be in the ctrl_c framework.

Darksonn

You also need to add them to src/signal/windows.rs

ipetkov

Approach LGTM but Alice is right that these aren't publicly exposed yet

ipetkov · 2022-08-20T05:27:08Z

tokio/src/signal/windows.rs

+    }
+}
+
+/// Creates a new stream which receives "ctrl-c" notifications sent to the


Should be "ctrl-logoff"

ipetkov

I forgot that OsStorage also needs to be updated to dispatch the signals appropriately. Might not be a bad idea to add tests for all the events to make sure they don't break.

We could do them in a big loop so we don't have to copy paste the same test case N times but will leave it up to you

tokio/src/signal/windows/sys.rs

ipetkov · 2022-08-30T15:25:13Z

@jkelleyrtp LGTM thanks for implementing this! Just a few more things and I'm happy to merge:

we'll need to rebase/merge as this branch has fallen behind (there may be a merge conflict that the UI is warning about, not sure)
update the ctrl_logoff method to specify "ctrl-logoff" (not "ctrl-c")
update the tests that each of the handlers works (right now we have to manually dispatch the received signals so it would be good to get test coverage there)

Feel free to ask if you have any questions!

jkelleyrtp · 2022-08-30T20:00:49Z

All three tasks complete - thanks for being so responsive!

ipetkov

Thanks for addressing all the feedback!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dependencies | minor | `1.20.1` -> `1.21.0` | | [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dev-dependencies | minor | `1.20.1` -> `1.21.0` | --- ### Release Notes <details> <summary>tokio-rs/tokio</summary> ### [`v1.21.0`](https://github.com/tokio-rs/tokio/releases/tag/tokio-1.21.0) [Compare Source](tokio-rs/tokio@tokio-1.20.1...tokio-1.21.0) ##### 1.21.0 (September 2, 2022) This release is the first release of Tokio to intentionally support WASM. The `sync,macros,io-util,rt,time` features are stabilized on WASM. Additionally the wasm32-wasi target is given unstable support for the `net` feature. ##### Added - net: add `device` and `bind_device` methods to TCP/UDP sockets ([#4882]) - net: add `tos` and `set_tos` methods to TCP and UDP sockets ([#4877]) - net: add security flags to named pipe `ServerOptions` ([#4845]) - signal: add more windows signal handlers ([#4924]) - sync: add `mpsc::Sender::max_capacity` method ([#4904]) - sync: implement Weak version of `mpsc::Sender` ([#4595]) - task: add `LocalSet::enter` ([#4765]) - task: stabilize `JoinSet` and `AbortHandle` ([#4920]) - tokio: add `track_caller` to public APIs ([#4805], [#4848], [#4852]) - wasm: initial support for `wasm32-wasi` target ([#4716]) ##### Fixed - miri: improve miri compatibility by avoiding temporary references in `linked_list::Link` impls ([#4841]) - signal: don't register write interest on signal pipe ([#4898]) - sync: add `#[must_use]` to lock guards ([#4886]) - sync: fix hang when calling `recv` on closed and reopened broadcast channel ([#4867]) - task: propagate attributes on task-locals ([#4837]) ##### Changed - fs: change panic to error in `File::start_seek` ([#4897]) - io: reduce syscalls in `poll_read` ([#4840]) - process: use blocking threadpool for child stdio I/O ([#4824]) - signal: make `SignalKind` methods const ([#4956]) ##### Internal changes - rt: extract `basic_scheduler::Config` ([#4935]) - rt: move I/O driver into `runtime` module ([#4942]) - rt: rename internal scheduler types ([#4945]) ##### Documented - chore: fix typos and grammar ([#4858], [#4894], [#4928]) - io: fix typo in `AsyncSeekExt::rewind` docs ([#4893]) - net: add documentation to `try_read()` for zero-length buffers ([#4937]) - runtime: remove incorrect panic section for `Builder::worker_threads` ([#4849]) - sync: doc of `watch::Sender::send` improved ([#4959]) - task: add cancel safety docs to `JoinHandle` ([#4901]) - task: expand on cancellation of `spawn_blocking` ([#4811]) - time: clarify that the first tick of `Interval::tick` happens immediately ([#4951]) ##### Unstable - rt: add unstable option to disable the LIFO slot ([#4936]) - task: fix incorrect signature in `Builder::spawn_on` ([#4953]) - task: make `task::Builder::spawn*` methods fallible ([#4823]) [#4595]: tokio-rs/tokio#4595 [#4716]: tokio-rs/tokio#4716 [#4765]: tokio-rs/tokio#4765 [#4805]: tokio-rs/tokio#4805 [#4811]: tokio-rs/tokio#4811 [#4823]: tokio-rs/tokio#4823 [#4824]: tokio-rs/tokio#4824 [#4837]: tokio-rs/tokio#4837 [#4840]: tokio-rs/tokio#4840 [#4841]: tokio-rs/tokio#4841 [#4845]: tokio-rs/tokio#4845 [#4848]: tokio-rs/tokio#4848 [#4849]: tokio-rs/tokio#4849 [#4852]: tokio-rs/tokio#4852 [#4858]: tokio-rs/tokio#4858 [#4867]: tokio-rs/tokio#4867 [#4877]: tokio-rs/tokio#4877 [#4882]: tokio-rs/tokio#4882 [#4886]: tokio-rs/tokio#4886 [#4893]: tokio-rs/tokio#4893 [#4894]: tokio-rs/tokio#4894 [#4897]: tokio-rs/tokio#4897 [#4898]: tokio-rs/tokio#4898 [#4901]: tokio-rs/tokio#4901 [#4904]: tokio-rs/tokio#4904 [#4920]: tokio-rs/tokio#4920 [#4924]: tokio-rs/tokio#4924 [#4928]: tokio-rs/tokio#4928 [#4935]: tokio-rs/tokio#4935 [#4936]: tokio-rs/tokio#4936 [#4937]: tokio-rs/tokio#4937 [#4942]: tokio-rs/tokio#4942 [#4945]: tokio-rs/tokio#4945 [#4951]: tokio-rs/tokio#4951 [#4953]: tokio-rs/tokio#4953 [#4956]: tokio-rs/tokio#4956 [#4959]: tokio-rs/tokio#4959 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1532 Reviewed-by: crapStone <crapstone@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

Darksonn added A-tokio Area: The main tokio crate M-signal Module: tokio/signal labels Aug 19, 2022

Darksonn reviewed Aug 19, 2022

View reviewed changes

ipetkov reviewed Aug 19, 2022

View reviewed changes

jkelleyrtp requested review from Darksonn and ipetkov and removed request for Darksonn and ipetkov August 19, 2022 22:44

ipetkov approved these changes Aug 20, 2022

View reviewed changes

ipetkov requested changes Aug 20, 2022

View reviewed changes

Darksonn requested a review from ipetkov August 25, 2022 09:07

ipetkov reviewed Aug 27, 2022

View reviewed changes

tokio/src/signal/windows/sys.rs Outdated Show resolved Hide resolved

jkelleyrtp requested review from ipetkov and removed request for Darksonn August 30, 2022 04:27

jkelleyrtp and others added 8 commits August 30, 2022 11:24

feat: add more windows signals

3f94f49

docs: add new windows signals to public api

18d4be7

fix: typos in windows signal handlers

7f169c0

fix: typo in windows signals

9b35645

feat: implement osstorage handlers for all windows signals

c5effa2

fix: imports on windows signals

93677bd

fix: doc comments in windows signals module

c87a999

fmt: add trailing commas to windows signals module

7968158

jkelleyrtp force-pushed the jk/more-windows-signals branch from 11aaa27 to 7968158 Compare August 30, 2022 18:24

chore: update documentation of windows signal module

ffcc086

chore: update tests for windows signals

a21219c

ipetkov approved these changes Aug 31, 2022

View reviewed changes

ipetkov enabled auto-merge (squash) August 31, 2022 00:29

ipetkov merged commit adc774b into tokio-rs:master Aug 31, 2022

Darksonn mentioned this pull request Sep 1, 2022

chore: prepare Tokio v1.21.0 #4967

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Add more windows signal handlers #4924

Feature: Add more windows signal handlers #4924

jkelleyrtp commented Aug 18, 2022 •

edited

Darksonn left a comment

ipetkov left a comment

ipetkov Aug 20, 2022

ipetkov left a comment

ipetkov commented Aug 30, 2022

jkelleyrtp commented Aug 30, 2022

ipetkov left a comment

Feature: Add more windows signal handlers #4924

Feature: Add more windows signal handlers #4924

Conversation

jkelleyrtp commented Aug 18, 2022 • edited

Darksonn left a comment

Choose a reason for hiding this comment

ipetkov left a comment

Choose a reason for hiding this comment

ipetkov Aug 20, 2022

Choose a reason for hiding this comment

ipetkov left a comment

Choose a reason for hiding this comment

ipetkov commented Aug 30, 2022

jkelleyrtp commented Aug 30, 2022

ipetkov left a comment

Choose a reason for hiding this comment

jkelleyrtp commented Aug 18, 2022 •

edited