Begin using std::io::on_broken_pipe()

Author: Enselic

library/std/src/rt.rs

@@ -91,6 +91,8 @@ fn handle_rt_panic<T>(e: Box<dyn Any + Send>) -> T {
 //
 // # The `sigpipe` parameter
 //
+// FIXME: Update
+//
 // Since 2014, the Rust runtime on Unix has set the `SIGPIPE` handler to
 // `SIG_IGN`. Applications have good reasons to want a different behavior
 // though, so there is a `-Zon-broken-pipe` compiler flag that

library/std/src/sys/pal/unix/mod.rs

@@ -36,6 +36,8 @@ pub unsafe fn init(argc: isize, argv: *const *const u8, sigpipe: u8) {
     // Hence, we set SIGPIPE to ignore when the program starts up in order
     // to prevent this problem. Use `-Zon-broken-pipe=...` to alter this
     // behavior.
+    //
+    // FIXME: Explain how to use `eii`
     reset_sigpipe(sigpipe);
 
     stack_overflow::init();
@@ -156,25 +158,12 @@ pub unsafe fn init(argc: isize, argv: *const *const u8, sigpipe: u8) {
             target_vendor = "unikraft",
         )))]
         {
-            // We don't want to add this as a public type to std, nor do we
-            // want to `include!` a file from the compiler (which would break
-            // Miri and xargo for example), so we choose to duplicate these
-            // constants from `compiler/rustc_session/src/config/sigpipe.rs`.
-            // See the other file for docs. NOTE: Make sure to keep them in
-            // sync!
-            mod sigpipe {
-                pub const DEFAULT: u8 = 0;
-                pub const INHERIT: u8 = 1;
-                pub const SIG_IGN: u8 = 2;
-                pub const SIG_DFL: u8 = 3;
-            }
-
-            let (on_broken_pipe_used, handler) = match sigpipe {
-                sigpipe::DEFAULT => (false, Some(libc::SIG_IGN)),
-                sigpipe::INHERIT => (true, None),
-                sigpipe::SIG_IGN => (true, Some(libc::SIG_IGN)),
-                sigpipe::SIG_DFL => (true, Some(libc::SIG_DFL)),
-                _ => unreachable!(),
+            use crate::io::OnBrokenPipe;
+            let (on_broken_pipe_used, handler) = match crate::io::on_broken_pipe() {
+                OnBrokenPipe::BackwardsCompatible => (false, Some(libc::SIG_IGN)),
+                OnBrokenPipe::Inherit => (true, None),
+                OnBrokenPipe::Error => (true, Some(libc::SIG_IGN)),
+                OnBrokenPipe::Kill => (true, Some(libc::SIG_DFL)),
             };
             if on_broken_pipe_used {
                 ON_BROKEN_PIPE_USED.store(true, crate::sync::atomic::Ordering::Relaxed);

library/std/src/sys/process/unix/unix.rs

@@ -352,6 +352,7 @@ impl Command {
             // Inherit the signal mask from the parent rather than resetting it (i.e. do not call
             // pthread_sigmask).
 
+            // FIXME: Update
             // If -Zon-broken-pipe is used, don't reset SIGPIPE to SIG_DFL.
             // If -Zon-broken-pipe is not used, reset SIGPIPE to SIG_DFL for backward compatibility.
             //
@@ -729,6 +730,7 @@ impl Command {
             // Inherit the signal mask from this process rather than resetting it (i.e. do not call
             // posix_spawnattr_setsigmask).
 
+            // FIXME: Update
             // If -Zon-broken-pipe is used, don't reset SIGPIPE to SIG_DFL.
             // If -Zon-broken-pipe is not used, reset SIGPIPE to SIG_DFL for backward compatibility.
             //

src/bootstrap/src/bin/rustc.rs

@@ -137,7 +137,7 @@ fn main() {
         cmd.args(lint_flags.split_whitespace());
     }
 
-    // TODO: Use `sigpipe-default` crate
+    // FIXME: Use `sigpipe-default` crate
 
     if target.is_some() {
         // The stage0 compiler has a special sysroot distinct from what we

src/bootstrap/src/core/build_steps/compile.rs

@@ -1233,7 +1233,7 @@ pub fn rustc_cargo(
     // Also see the discussion for properly handling I/O errors related to broken pipes, i.e. safe
     // variants of `println!` in
     // <https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Internal.20lint.20for.20raw.20.60print!.60.20and.20.60println!.60.3F>.
-    cargo.rustflag("-Zon-broken-pipe=kill");
+    // FIXME: cargo.rustflag("-Zon-broken-pipe=kill");
 
     // Building with protected visibility reduces the number of dynamic relocations needed, giving
     // us a faster startup time. However GNU ld < 2.40 will error if we try to link a shared object

src/bootstrap/src/core/build_steps/tool.rs

@@ -305,6 +305,7 @@ pub fn prepare_tool_cargo(
     // <https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Internal.20lint.20for.20raw.20.60print!.60.20and.20.60println!.60.3F>
     // for proper solutions.
     if !path.ends_with("cargo") {
+        // FIXME: Update this code
         // Use an untracked env var `FORCE_ON_BROKEN_PIPE_KILL` here instead of `RUSTFLAGS`.
         // `RUSTFLAGS` is tracked by cargo. Conditionally omitting `-Zon-broken-pipe=kill` from
         // `RUSTFLAGS` causes unnecessary tool rebuilds due to cache invalidation from building e.g.

src/tools/compiletest/src/runtest.rs

@@ -1282,6 +1282,7 @@ impl<'test> TestCx<'test> {
                 let crate_name = path_to_crate_name(aux_path);
                 let mut lib_name = get_lib_name(&crate_name, aux_type);
 
+                // FIXME: Make this ugly hack more beatiful and easy to understand
                 // Some auxiliaries opt out of compiletest's default `--crate-type dylib`
                 // (e.g. via `//@ no-prefer-dynamic`). In that case, fall back to an rlib if the
                 // expected dylib doesn't exist.

src/tools/miri/src/eval.rs

@@ -416,10 +416,6 @@ fn call_main<'tcx>(
 
             let main_ptr = ecx.fn_ptr(FnVal::Instance(entry_instance));
 
-            // Always using DEFAULT is okay since we don't support signals in Miri anyway.
-            // (This means we are effectively ignoring `-Zon-broken-pipe`.)
-            let sigpipe = rustc_session::config::sigpipe::DEFAULT;
-
             ecx.call_function(
                 start_instance,
                 ExternAbi::Rust,
@@ -431,7 +427,7 @@ fn call_main<'tcx>(
                     ),
                     argc,
                     argv,
-                    ImmTy::from_uint(sigpipe, ecx.machine.layouts.u8),
+                    ImmTy::from_uint(0u8 /* unused */, ecx.machine.layouts.u8),
                 ],
                 Some(&ret_place),
                 ReturnContinuation::Stop { cleanup: true },

tests/run-make/broken-pipe-no-ice/rmake.rs

@@ -39,7 +39,8 @@ fn check_broken_pipe_handled_gracefully(bin: Binary, mut cmd: Command) {
 
     #[cfg(not(windows))]
     {
-        // On non-Windows, rustc/rustdoc built with `-Zon-broken-pipe=kill` shouldn't have an exit
+        // FIXME: Update comment
+        // On non-Windows, rustc/rustdoc built with `OnBrokenPipe::Kill` shouldn't have an exit
         // code of 101 because it should have an wait status that corresponds to SIGPIPE signal
         // number.
         assert_ne!(status.code(), Some(PANIC_ICE_EXIT_CODE), "{bin:?}");

tests/ui/runtime/on-broken-pipe/auxiliary/assert-inherit-sig_dfl.rs

@@ -1,5 +1,15 @@
 //@ aux-crate: sigpipe_utils=sigpipe-utils.rs
-//@ compile-flags: -Zon-broken-pipe=inherit
+
+// FIXME: Should not be needed TODO: Create specific issue
+//@ no-prefer-dynamic
+
+#![feature(on_broken_pipe)]
+#![feature(extern_item_impls)]
+
+#[std::io::on_broken_pipe]
+fn on_broken_pipe() -> std::io::OnBrokenPipe {
+    std::io::OnBrokenPipe::Inherit
+}
 
 fn main() {
     sigpipe_utils::assert_sigpipe_handler(sigpipe_utils::SignalHandler::Default);