command: Add process_group method to Command struct #5114

HarveyHunt · 2022-10-21T13:06:37Z

Rust 1.64 stabilised the process_group method of the std::os::unix::process::CommandExt trait. This allows the caller to set the process group that a command is spawned in.

Expose that functionality from Tokio's Command structure.

This fixes #4312.

I'm not really familiar with the process for adding a new Tokio method, so I've gated it behind the tokio_unstable check - please let me know if I should be doing it differently. Thanks!

HarveyHunt · 2022-10-21T16:00:28Z

It looks like the FreeBSD doc tests are failing because the nightly version used there is old, whilst the other FreeBSD tests are using stable.

Nightly is 1.61.0 (logs)
Stable is 1.64.0 (logs)

The Cirrus CI config is hardcoding an old nightly version - perhaps that could be updated?

https://github.com/tokio-rs/tokio/blob/master/.cirrus.yml#L5

ipetkov · 2022-10-22T00:42:22Z

Doc tests are also failing, I would be okay to remove that example as it's pretty simplistic anyway

Darksonn

I don't mind adding this. Bumping the nightly version in CI is perfectly fine.

Darksonn · 2022-10-23T18:23:54Z

tokio/src/process/mod.rs

+    /// Sets the process group ID (PGID) of the child process. Equivalent to a
+    /// setpgid call in the child process, but may be more efficient.
+    ///
+    /// Process groups determine which processes receive signals.


This should document that it is unstable, how to enable unstable features (a link is fine - see doc for other unstable methods), and that it will become stable when our MSRV is new enough to allow this in a stable manner. It would also be nice to mention that you can do this today by constructing an std::process::Command and using our From impl to convert it.

carllerche · 2022-10-24T18:18:22Z

I'm fine adding it as an unstable feature w/ a comment saying to "stabilize" it when possible.

HarveyHunt · 2022-10-26T12:15:15Z

Thanks for the feedback, I've updated the original commit to include some more documentation.

I've also added another commit that bumps the Cirrus CI version - please let me know if you'd prefer that in a separate PR.

Darksonn · 2022-10-26T13:09:01Z

tokio/src/process/mod.rs

+    ///
+    /// If you want similar behaviour without using this unstable feature you can
+    /// create a [`std::process::Command`] and convert that into a
+    /// [`crate::process::Command`] using the `From` trait.


We don't use crate in our documentation.

Suggested change

/// [`crate::process::Command`] using the `From` trait.

/// [`tokio::process::Command`] using the `From` trait.

If this link doesn't work out of the box, then you can add

[`tokio::process::Command`]: crate::process::Command

Ah, thanks for the pointer about the alias - I tried tokio::process::Command earlier and the docs wouldn't build. With that alias, it works. :)

Darksonn · 2022-10-26T13:10:05Z

I've also added another commit that bumps the Cirrus CI version - please let me know if you'd prefer that in a separate PR.

If it also requires a bunch of unrelated fixes of warnings, then I'd prefer a separate PR. Otherwise it is fine here.

Darksonn

Lgtm

Darksonn · 2022-10-26T18:07:16Z

You'll need to fix the CI failure. Otherwise, I'm ready to merge this.

The nightly version used by Cirrus CI is a few months old now. Update it to a recent nightly so that features relying on 1.64.0 can be landed. Further, fix up a doc generation warning that causes the FreeBSD doc CI to fail.

Rust 1.64 stabilised the `process_group` method of the `std::os::unix::process::CommandExt` trait. This allows the caller to set the process group that a command is spawned in. Expose that functionality from Tokio's `Command` structure, behind the unstable feature. This fixes tokio-rs#4312.

HarveyHunt · 2022-10-27T11:25:21Z

Thanks for accepting! I've fixed up the warning in the doc test so this change should be good to merge now. :)

Darksonn

Thanks.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dependencies | minor | `1.21.2` -> `1.22.0` | | [tokio](https://tokio.rs) ([source](https://github.com/tokio-rs/tokio)) | dev-dependencies | minor | `1.21.2` -> `1.22.0` | --- ### Release Notes <details> <summary>tokio-rs/tokio</summary> ### [`v1.22.0`](https://github.com/tokio-rs/tokio/releases/tag/tokio-1.22.0): Tokio v1.22.0 [Compare Source](tokio-rs/tokio@tokio-1.21.2...tokio-1.22.0) ##### Added - runtime: add `Handle::runtime_flavor` ([#5138]) - sync: add `Mutex::blocking_lock_owned` ([#5130]) - sync: add `Semaphore::MAX_PERMITS` ([#5144]) - sync: add `merge()` to semaphore permits ([#4948]) - sync: add `mpsc::WeakUnboundedSender` ([#5189]) ##### Added (unstable) - process: add `Command::process_group` ([#5114]) - runtime: export metrics about the blocking thread pool ([#5161]) - task: add `task::id()` and `task::try_id()` ([#5171]) ##### Fixed - macros: don't take ownership of futures in macros ([#5087]) - runtime: fix Stacked Borrows violation in `LocalOwnedTasks` ([#5099]) - runtime: mitigate ABA with 32-bit queue indices when possible ([#5042]) - task: wake local tasks to the local queue when woken by the same thread ([#5095]) - time: panic in release mode when `mark_pending` called illegally ([#5093]) - runtime: fix typo in expect message ([#5169]) - runtime: fix `unsync_load` on atomic types ([#5175]) - task: elaborate safety comments in task deallocation ([#5172]) - runtime: fix `LocalSet` drop in thread local ([#5179]) - net: remove libc type leakage in a public API ([#5191]) - runtime: update the alignment of `CachePadded` ([#5106]) ##### Changed - io: make `tokio::io::copy` continue filling the buffer when writer stalls ([#5066]) - runtime: remove `coop::budget` from `LocalSet::run_until` ([#5155]) - sync: make `Notify` panic safe ([#5154]) ##### Documented - io: fix doc for `write_i8` to use signed integers ([#5040]) - net: fix doc typos for TCP and UDP `set_tos` methods ([#5073]) - net: fix function name in `UdpSocket::recv` documentation ([#5150]) - sync: typo in `TryLockError` for `RwLock::try_write` ([#5160]) - task: document that spawned tasks execute immediately ([#5117]) - time: document return type of `timeout` ([#5118]) - time: document that `timeout` checks only before poll ([#5126]) - sync: specify return type of `oneshot::Receiver` in docs ([#5198]) ##### Internal changes - runtime: use const `Mutex::new` for globals ([#5061]) - runtime: remove `Option` around `mio::Events` in io driver ([#5078]) - runtime: remove a conditional compilation clause ([#5104]) - runtime: remove a reference to internal time handle ([#5107]) - runtime: misc time driver cleanup ([#5120]) - runtime: move signal driver to runtime module ([#5121]) - runtime: signal driver now uses I/O driver directly ([#5125]) - runtime: start decoupling I/O driver and I/O handle ([#5127]) - runtime: switch `io::handle` refs with scheduler:Handle ([#5128]) - runtime: remove Arc from I/O driver ([#5134]) - runtime: use signal driver handle via `scheduler::Handle` ([#5135]) - runtime: move internal clock fns out of context ([#5139]) - runtime: remove `runtime::context` module ([#5140]) - runtime: keep driver cfgs in `driver.rs` ([#5141]) - runtime: add `runtime::context` to unify thread-locals ([#5143]) - runtime: rename some confusing internal variables/fns ([#5151]) - runtime: move `coop` mod into `runtime` ([#5152]) - runtime: move budget state to context thread-local ([#5157]) - runtime: move park logic into runtime module ([#5158]) - runtime: move `Runtime` into its own file ([#5159]) - runtime: unify entering a runtime with `Handle::enter` ([#5163]) - runtime: remove handle reference from each scheduler ([#5166]) - runtime: move `enter` into `context` ([#5167]) - runtime: combine context and entered thread-locals ([#5168]) - runtime: fix accidental unsetting of current handle ([#5178]) - runtime: move `CoreStage` methods to `Core` ([#5182]) - sync: name mpsc semaphore types ([#5146]) [#4948]: tokio-rs/tokio#4948 [#5040]: tokio-rs/tokio#5040 [#5042]: tokio-rs/tokio#5042 [#5061]: tokio-rs/tokio#5061 [#5066]: tokio-rs/tokio#5066 [#5073]: tokio-rs/tokio#5073 [#5078]: tokio-rs/tokio#5078 [#5087]: tokio-rs/tokio#5087 [#5093]: tokio-rs/tokio#5093 [#5095]: tokio-rs/tokio#5095 [#5099]: tokio-rs/tokio#5099 [#5104]: tokio-rs/tokio#5104 [#5106]: tokio-rs/tokio#5106 [#5107]: tokio-rs/tokio#5107 [#5114]: tokio-rs/tokio#5114 [#5117]: tokio-rs/tokio#5117 [#5118]: tokio-rs/tokio#5118 [#5120]: tokio-rs/tokio#5120 [#5121]: tokio-rs/tokio#5121 [#5125]: tokio-rs/tokio#5125 [#5126]: tokio-rs/tokio#5126 [#5127]: tokio-rs/tokio#5127 [#5128]: tokio-rs/tokio#5128 [#5130]: tokio-rs/tokio#5130 [#5134]: tokio-rs/tokio#5134 [#5135]: tokio-rs/tokio#5135 [#5138]: tokio-rs/tokio#5138 [#5138]: tokio-rs/tokio#5138 [#5139]: tokio-rs/tokio#5139 [#5140]: tokio-rs/tokio#5140 [#5141]: tokio-rs/tokio#5141 [#5143]: tokio-rs/tokio#5143 [#5144]: tokio-rs/tokio#5144 [#5144]: tokio-rs/tokio#5144 [#5146]: tokio-rs/tokio#5146 [#5150]: tokio-rs/tokio#5150 [#5151]: tokio-rs/tokio#5151 [#5152]: tokio-rs/tokio#5152 [#5154]: tokio-rs/tokio#5154 [#5155]: tokio-rs/tokio#5155 [#5157]: tokio-rs/tokio#5157 [#5158]: tokio-rs/tokio#5158 [#5159]: tokio-rs/tokio#5159 [#5160]: tokio-rs/tokio#5160 [#5161]: tokio-rs/tokio#5161 [#5163]: tokio-rs/tokio#5163 [#5166]: tokio-rs/tokio#5166 [#5167]: tokio-rs/tokio#5167 [#5168]: tokio-rs/tokio#5168 [#5169]: tokio-rs/tokio#5169 [#5171]: tokio-rs/tokio#5171 [#5172]: tokio-rs/tokio#5172 [#5175]: tokio-rs/tokio#5175 [#5178]: tokio-rs/tokio#5178 [#5179]: tokio-rs/tokio#5179 [#5182]: tokio-rs/tokio#5182 [#5189]: tokio-rs/tokio#5189 [#5191]: tokio-rs/tokio#5191 [#5198]: tokio-rs/tokio#5198 </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, check this box --- 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/1651 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>

cablehead · 2023-10-13T13:42:57Z

Hi, just checking if this feature still needs to be gated behind tokio_unstable? Thank you for all your work!

niklasf · 2023-10-13T15:54:04Z

Yes. The standard library function was added in Rust 1.64.0, but tokio is at MSRV 1.63.

Darksonn added A-tokio Area: The main tokio crate M-process Module: tokio/process labels Oct 21, 2022

HarveyHunt force-pushed the command-process-group branch 2 times, most recently from c4edb3a to c52b0cc Compare October 21, 2022 14:43

Darksonn reviewed Oct 23, 2022

View reviewed changes

HarveyHunt force-pushed the command-process-group branch from c52b0cc to 9f56fb0 Compare October 26, 2022 12:14

Darksonn reviewed Oct 26, 2022

View reviewed changes

HarveyHunt force-pushed the command-process-group branch from 76e2def to 6237cea Compare October 26, 2022 14:54

Darksonn approved these changes Oct 26, 2022

View reviewed changes

ipetkov approved these changes Oct 27, 2022

View reviewed changes

HarveyHunt added 2 commits October 27, 2022 09:32

ci: Update Rust nightly version for cirrus CI

aae33d3

The nightly version used by Cirrus CI is a few months old now. Update it to a recent nightly so that features relying on 1.64.0 can be landed. Further, fix up a doc generation warning that causes the FreeBSD doc CI to fail.

HarveyHunt force-pushed the command-process-group branch from 6237cea to 1763601 Compare October 27, 2022 08:32

github-actions bot added the R-loom Run loom tests on this PR label Oct 27, 2022

Darksonn approved these changes Oct 29, 2022

View reviewed changes

Darksonn enabled auto-merge (squash) October 29, 2022 14:26

Darksonn merged commit 1ab80ba into tokio-rs:master Oct 29, 2022

Hoverbear mentioned this pull request Nov 9, 2022

Ctrl+C should be handled and terminate us at the nearest safe point DeterminateSystems/nix-installer#41

Closed

Darksonn mentioned this pull request Nov 17, 2022

chore: prepare Tokio v1.22.0 #5203

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

command: Add process_group method to Command struct #5114

command: Add process_group method to Command struct #5114

HarveyHunt commented Oct 21, 2022

HarveyHunt commented Oct 21, 2022

ipetkov commented Oct 22, 2022

Darksonn left a comment

Darksonn Oct 23, 2022

carllerche commented Oct 24, 2022

HarveyHunt commented Oct 26, 2022

Darksonn Oct 26, 2022 •

edited

HarveyHunt Oct 26, 2022

Darksonn commented Oct 26, 2022

Darksonn left a comment

Darksonn commented Oct 26, 2022

HarveyHunt commented Oct 27, 2022

Darksonn left a comment

cablehead commented Oct 13, 2023 •

edited

niklasf commented Oct 13, 2023

	/// [`crate::process::Command`] using the `From` trait.
	/// [`tokio::process::Command`] using the `From` trait.

command: Add process_group method to Command struct #5114

command: Add process_group method to Command struct #5114

Conversation

HarveyHunt commented Oct 21, 2022

HarveyHunt commented Oct 21, 2022

ipetkov commented Oct 22, 2022

Darksonn left a comment

Choose a reason for hiding this comment

Darksonn Oct 23, 2022

Choose a reason for hiding this comment

carllerche commented Oct 24, 2022

HarveyHunt commented Oct 26, 2022

Darksonn Oct 26, 2022 • edited

Choose a reason for hiding this comment

HarveyHunt Oct 26, 2022

Choose a reason for hiding this comment

Darksonn commented Oct 26, 2022

Darksonn left a comment

Choose a reason for hiding this comment

Darksonn commented Oct 26, 2022

HarveyHunt commented Oct 27, 2022

Darksonn left a comment

Choose a reason for hiding this comment

cablehead commented Oct 13, 2023 • edited

niklasf commented Oct 13, 2023

Darksonn Oct 26, 2022 •

edited

cablehead commented Oct 13, 2023 •

edited