Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide an API for std::process::Command to set CreateProcess flags on Windows #37827

Closed
luser opened this issue Nov 17, 2016 · 9 comments
Closed

Provide an API for std::process::Command to set CreateProcess flags on Windows #37827

luser opened this issue Nov 17, 2016 · 9 comments
Labels
B-unstable Blocker: Implemented in the nightly compiler and unstable. final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. O-windows Operating system: Windows T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@luser
Copy link
Contributor

luser commented Nov 17, 2016 •
edited by alexcrichton
Loading

Updated report

Now a tracking issue for CommandExt::creation_flags on Windows.

Open questions:

  • Should we provide a method of adding flags as opposed to setting them entirely? Would be a bit more composition-friendly.

Also, don't forget to add to the prelude when stabilizing!

Original report

There's a currently-unused codepath in the Windows implementation of std::process::Command::spawn that can set DETATCHED_PROCESS:

rust/src/libstd/sys/windows/process.rs

Line 162 in b1363a7

flags |= c::DETACHED_PROCESS | c::CREATE_NEW_PROCESS_GROUP;

It looks like historically there was a method to set this but it got removed. Unfortunately there's currently no way to set this, and no other way to set the CreateProcess flags, so for a project I'm working on I basically had to reimplement spawn for Windows:
https://github.com/luser/sccache2/blob/89f4b44d01084846893a64137d965ee844fe2d72/src/commands.rs#L103

I think we need some way to set this, even if it's Windows-specific. There are a bunch of other flags that can be specified, so maybe a way to set arbitrary flags would be useful?
https://msdn.microsoft.com/en-us/library/windows/desktop/ms684863(v=vs.85).aspx

I think this would fit nicely onto a Windows equivalent of the std::os::unix::process::CommandExt trait, maybe something like:

trait CommandExt {
  fn process_flags(&mut self, flags: u32) -> &mut Command
}
@sfackler
Copy link
Member

Seems reasonable to me!

@sfackler sfackler added O-windows Operating system: Windows T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Nov 17, 2016
@alexcrichton
Copy link
Member

👍

@retep998
Copy link
Member

I'm always in favor of adding more Windows specific extension traits to expose useful functionality that other platforms don't seem to have.

@luser
Copy link
Contributor Author

luser commented Nov 30, 2016

I have a patch, it just took me a while to write a test for it. I'm trying to sort out the stability annotations for the new APIs--can I just use this issue as the tracking issue for the new feature?

@luser luser mentioned this issue Dec 1, 2016
Merged
@alexcrichton
Copy link
Member

can I just use this issue as the tracking issue for the new feature

Sure!

@luser
Copy link
Contributor Author

luser commented Dec 1, 2016

To the open question: I had first written the API as originally proposed: with a creation_flags method to set the flags directly. Then I thought that might make it difficult if callers wanted to set different flags in different places, so I split it into set_creation_flags and add_creation_flags methods, but Alex asked me to change it back. I'm not sure it's that important, I don't think there are that many process creation flags that it would be useful to set from a library context, and callers can always aggregate flags into a u32 and just call creation_flags with that value.

bors added a commit that referenced this issue Dec 5, 2016
@bors
Auto merge of #38098 - luser:windows-commandext, r=alexcrichton
b4f4b65 
Add std::os::windows::process::CommandExt. Fixes #37827

This adds a CommandExt trait for Windows along with an implementation of it
for std::process::Command with methods to set the process creation flags that
are passed to CreateProcess.
@bors bors closed this as completed in 8b1c4cb Dec 5, 2016
@alexcrichton alexcrichton reopened this Dec 5, 2016
@alexcrichton alexcrichton added the B-unstable Blocker: Implemented in the nightly compiler and unstable. label Dec 5, 2016
@luser luser changed the title Provide an API for std::process::Command to set DETACHED_PROCESS flag on Windows Provide an API for std::process::Command to set CreateProcess flags on Windows Dec 12, 2016
luser added a commit to mozilla/sccache that referenced this issue Dec 13, 2016
@luser
Don't create consoles for compiler invocations on Windows. Fixes #16.
c70dcf2 
This fixes the extra console windows that show up when the sccache server
creates compiler processes on Windows, but it only works on nightly Rust
currently, and requires building with `--features=unstable`, because it relies
on the not-yet-stable `windows_process_extensions` feature (rust-lang/rust#37827).

Also I added a bunch of extra documentation to the mock_command traits.
@alexcrichton
Copy link
Member

@rfcbot fcp merge

With the one remaining open question I think it's safe to stabilize as this is still consistent with our approach to custom flags in other areas of platform-specific extensions as well.

@rfcbot
Copy link

rfcbot commented Dec 29, 2016 •
edited by brson
Loading

Team member @alexcrichton has proposed to merge this. The next step is review by the rest of the tagged teams:

No concerns currently listed.

Once these reviewers reach consensus, this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rfcbot
Copy link

rfcbot commented Jan 23, 2017

🔔 This is now entering its final comment period, as per the review above. 🔔

psst @alexcrichton, I wasn't able to add the final-comment-period label, please do so.

@alexcrichton alexcrichton added the final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. label Jan 23, 2017
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jan 26, 2017
@alexcrichton
std: Stabilize APIs for the 1.16.0 release
671b1c1 
This commit applies the stabilization/deprecations of the 1.16.0 release, as
tracked by the rust-lang/rust issue tracker and the final-comment-period tag.

The following APIs were stabilized:

* `VecDeque::truncate`
* `VecDeque::resize`
* `String::insert_str`
* `Duration::checked_{add,sub,div,mul}`
* `str::replacen`
* `SocketAddr::is_ipv{4,6}`
* `IpAddr::is_ipv{4,6}`
* `str::repeat`
* `Vec::dedup_by`
* `Vec::dedup_by_key`
* `Result::unwrap_or_default`
* `<*const T>::wrapping_offset`
* `<*mut T>::wrapping_offset`
* `CommandExt::creation_flags` (on Windows)
* `File::set_permissions`
* `String::split_off`

The following APIs were deprecated

* `EnumSet` - replaced with other ecosystem abstractions, long since unstable

Closes rust-lang#27788
Closes rust-lang#35553
Closes rust-lang#35774
Closes rust-lang#36436
Closes rust-lang#36949
Closes rust-lang#37079
Closes rust-lang#37087
Closes rust-lang#37516
Closes rust-lang#37827
Closes rust-lang#37916
Closes rust-lang#37966
Closes rust-lang#38080
@alexcrichton alexcrichton mentioned this issue Jan 26, 2017
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jan 28, 2017
@alexcrichton
Rollup merge of rust-lang#39307 - alexcrichton:stabilize-1.16, r=brson
0edc3d3 
std: Stabilize APIs for the 1.16.0 release

This commit applies the stabilization/deprecations of the 1.16.0 release, as
tracked by the rust-lang/rust issue tracker and the final-comment-period tag.

The following APIs were stabilized:

* `VecDeque::truncate`
* `VecDeque::resize`
* `String::insert_str`
* `Duration::checked_{add,sub,div,mul}`
* `str::replacen`
* `SocketAddr::is_ipv{4,6}`
* `IpAddr::is_ipv{4,6}`
* `str::repeat`
* `Vec::dedup_by`
* `Vec::dedup_by_key`
* `Result::unwrap_or_default`
* `<*const T>::wrapping_offset`
* `<*mut T>::wrapping_offset`
* `CommandExt::creation_flags` (on Windows)
* `File::set_permissions`
* `String::split_off`

The following APIs were deprecated

* `EnumSet` - replaced with other ecosystem abstractions, long since unstable

Closes rust-lang#27788
Closes rust-lang#35553
Closes rust-lang#35774
Closes rust-lang#36436
Closes rust-lang#36949
Closes rust-lang#37079
Closes rust-lang#37087
Closes rust-lang#37516
Closes rust-lang#37827
Closes rust-lang#37916
Closes rust-lang#37966
Closes rust-lang#38080
@luser luser mentioned this issue Jan 30, 2017
Closed
@luser luser mentioned this issue Dec 15, 2020
Closed
@crwpenn crwpenn mentioned this issue Feb 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
B-unstable Blocker: Implemented in the nightly compiler and unstable. final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. O-windows Operating system: Windows T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@alexcrichton @luser @retep998 @sfackler @rfcbot