process_unix.rs.html -- source
Description: Source to the Rust file `src/libstd/sys/unix/process/process_unix.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499

    use crate::fmt;
    use crate::io::{self, Error, ErrorKind};
    use crate::ptr;
    use crate::sys;
    use crate::sys::cvt;
    use crate::sys::process::process_common::*;

    use libc::{c_int, gid_t, pid_t, uid_t};

    ////////////////////////////////////////////////////////////////////////////////
    // Command
    ////////////////////////////////////////////////////////////////////////////////

    impl Command {
        pub fn spawn(
            &mut self,
            default: Stdio,
            needs_stdin: bool,
        ) -> io::Result<(Process, StdioPipes)> {
            const CLOEXEC_MSG_FOOTER: &[u8] = b"NOEX";

            let envp = self.capture_env();

            if self.saw_nul() {
                return Err(io::Error::new(ErrorKind::InvalidInput, "nul byte found in provided data"));
            }

            let (ours, theirs) = self.setup_io(default, needs_stdin)?;

            if let Some(ret) = self.posix_spawn(&theirs, envp.as_ref())? {
                return Ok((ret, ours));
            }

            let (input, output) = sys::pipe::anon_pipe()?;

            // Whatever happens after the fork is almost for sure going to touch or
            // look at the environment in one way or another (PATH in `execvp` or
            // accessing the `environ` pointer ourselves). Make sure no other thread
            // is accessing the environment when we do the fork itself.
            //
            // Note that as soon as we're done with the fork there's no need to hold
            // a lock any more because the parent won't do anything and the child is
            // in its own process.
            let result = unsafe {
                let _env_lock = sys::os::env_lock();
                cvt(libc::fork())?
            };

            let pid = unsafe {
                match result {
                    0 => {
                        drop(input);
                        let Err(err) = self.do_exec(theirs, envp.as_ref());
                        let errno = err.raw_os_error().unwrap_or(libc::EINVAL) as u32;
                        let bytes = [
                            (errno >> 24) as u8,
                            (errno >> 16) as u8,
                            (errno >> 8) as u8,
                            (errno >> 0) as u8,
                            CLOEXEC_MSG_FOOTER[0],
                            CLOEXEC_MSG_FOOTER[1],
                            CLOEXEC_MSG_FOOTER[2],
                            CLOEXEC_MSG_FOOTER[3],
                        ];
                        // pipe I/O up to PIPE_BUF bytes should be atomic, and then
                        // we want to be sure we *don't* run at_exit destructors as
                        // we're being torn down regardless
                        assert!(output.write(&bytes).is_ok());
                        libc::_exit(1)
                    }
                    n => n,
                }
            };

            let mut p = Process { pid, status: None };
            drop(output);
            let mut bytes = [0; 8];

            // loop to handle EINTR
            loop {
                match input.read(&mut bytes) {
                    Ok(0) => return Ok((p, ours)),
                    Ok(8) => {
                        assert!(
                            combine(CLOEXEC_MSG_FOOTER) == combine(&bytes[4..8]),
                            "Validation on the CLOEXEC pipe failed: {:?}",
                            bytes
                        );
                        let errno = combine(&bytes[0..4]);
                        assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
                        return Err(Error::from_raw_os_error(errno));
                    }
                    Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                    Err(e) => {
                        assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
                        panic!("the CLOEXEC pipe failed: {:?}", e)
                    }
                    Ok(..) => {
                        // pipe I/O up to PIPE_BUF bytes should be atomic
                        assert!(p.wait().is_ok(), "wait() should either return Ok or panic");
                        panic!("short read on the CLOEXEC pipe")
                    }
                }
            }

            fn combine(arr: &[u8]) -> i32 {
                let a = arr[0] as u32;
                let b = arr[1] as u32;
                let c = arr[2] as u32;
                let d = arr[3] as u32;

                ((a << 24) | (b << 16) | (c << 8) | (d << 0)) as i32
            }
        }

        pub fn exec(&mut self, default: Stdio) -> io::Error {
            let envp = self.capture_env();

            if self.saw_nul() {
                return io::Error::new(ErrorKind::InvalidInput, "nul byte found in provided data");
            }

            match self.setup_io(default, true) {
                Ok((_, theirs)) => {
                    unsafe {
                        // Similar to when forking, we want to ensure that access to
                        // the environment is synchronized, so make sure to grab the
                        // environment lock before we try to exec.
                        let _lock = sys::os::env_lock();

                        let Err(e) = self.do_exec(theirs, envp.as_ref());
                        e
                    }
                }
                Err(e) => e,
            }
        }

        // And at this point we've reached a special time in the life of the
        // child. The child must now be considered hamstrung and unable to
        // do anything other than syscalls really. Consider the following
        // scenario:
        //
        //      1. Thread A of process 1 grabs the malloc() mutex
        //      2. Thread B of process 1 forks(), creating thread C
        //      3. Thread C of process 2 then attempts to malloc()
        //      4. The memory of process 2 is the same as the memory of
        //         process 1, so the mutex is locked.
        //
        // This situation looks a lot like deadlock, right? It turns out
        // that this is what pthread_atfork() takes care of, which is
        // presumably implemented across platforms. The first thing that
        // threads to *before* forking is to do things like grab the malloc
        // mutex, and then after the fork they unlock it.
        //
        // Despite this information, libnative's spawn has been witnessed to
        // deadlock on both macOS and FreeBSD. I'm not entirely sure why, but
        // all collected backtraces point at malloc/free traffic in the
        // child spawned process.
        //
        // For this reason, the block of code below should contain 0
        // invocations of either malloc of free (or their related friends).
        //
        // As an example of not having malloc/free traffic, we don't close
        // this file descriptor by dropping the FileDesc (which contains an
        // allocation). Instead we just close it manually. This will never
        // have the drop glue anyway because this code never returns (the
        // child will either exec() or invoke libc::exit)
        unsafe fn do_exec(
            &mut self,
            stdio: ChildPipes,
            maybe_envp: Option<&CStringArray>,
        ) -> Result<!, io::Error> {
            use crate::sys::{self, cvt_r};

            if let Some(fd) = stdio.stdin.fd() {
                cvt_r(|| libc::dup2(fd, libc::STDIN_FILENO))?;
            }
            if let Some(fd) = stdio.stdout.fd() {
                cvt_r(|| libc::dup2(fd, libc::STDOUT_FILENO))?;
            }
            if let Some(fd) = stdio.stderr.fd() {
                cvt_r(|| libc::dup2(fd, libc::STDERR_FILENO))?;
            }

            #[cfg(not(target_os = "l4re"))]
            {
                if let Some(u) = self.get_gid() {
                    cvt(libc::setgid(u as gid_t))?;
                }
                if let Some(u) = self.get_uid() {
                    // When dropping privileges from root, the `setgroups` call
                    // will remove any extraneous groups. If we don't call this,
                    // then even though our uid has dropped, we may still have
                    // groups that enable us to do super-user things. This will
                    // fail if we aren't root, so don't bother checking the
                    // return value, this is just done as an optimistic
                    // privilege dropping function.
                    //FIXME: Redox kernel does not support setgroups yet
                    #[cfg(not(target_os = "redox"))]
                    let _ = libc::setgroups(0, ptr::null());
                    cvt(libc::setuid(u as uid_t))?;
                }
            }
            if let Some(ref cwd) = *self.get_cwd() {
                cvt(libc::chdir(cwd.as_ptr()))?;
            }

            // emscripten has no signal support.
            #[cfg(not(target_os = "emscripten"))]
            {
                use crate::mem::MaybeUninit;
                // Reset signal handling so the child process starts in a
                // standardized state. libstd ignores SIGPIPE, and signal-handling
                // libraries often set a mask. Child processes inherit ignored
                // signals and the signal mask from their parent, but most
                // UNIX programs do not reset these things on their own, so we
                // need to clean things up now to avoid confusing the program
                // we're about to run.
                let mut set = MaybeUninit::<libc::sigset_t>::uninit();
                cvt(sigemptyset(set.as_mut_ptr()))?;
                cvt(libc::pthread_sigmask(libc::SIG_SETMASK, set.as_ptr(), ptr::null_mut()))?;
                let ret = sys::signal(libc::SIGPIPE, libc::SIG_DFL);
                if ret == libc::SIG_ERR {
                    return Err(io::Error::last_os_error());
                }
            }

            for callback in self.get_closures().iter_mut() {
                callback()?;
            }

            // Although we're performing an exec here we may also return with an
            // error from this function (without actually exec'ing) in which case we
            // want to be sure to restore the global environment back to what it
            // once was, ensuring that our temporary override, when free'd, doesn't
            // corrupt our process's environment.
            let mut _reset = None;
            if let Some(envp) = maybe_envp {
                struct Reset(*const *const libc::c_char);

                impl Drop for Reset {
                    fn drop(&mut self) {
                        unsafe {
                            *sys::os::environ() = self.0;
                        }
                    }
                }

                _reset = Some(Reset(*sys::os::environ()));
                *sys::os::environ() = envp.as_ptr();
            }

            libc::execvp(self.get_program().as_ptr(), self.get_argv().as_ptr());
            Err(io::Error::last_os_error())
        }

        #[cfg(not(any(
            target_os = "macos",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "gnu")
        )))]
        fn posix_spawn(
            &mut self,
            _: &ChildPipes,
            _: Option<&CStringArray>,
        ) -> io::Result<Option<Process>> {
            Ok(None)
        }

        // Only support platforms for which posix_spawn() can return ENOENT
        // directly.
        #[cfg(any(
            target_os = "macos",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "gnu")
        ))]
        fn posix_spawn(
            &mut self,
            stdio: &ChildPipes,
            envp: Option<&CStringArray>,
        ) -> io::Result<Option<Process>> {
            use crate::mem::MaybeUninit;
            use crate::sys;

            if self.get_gid().is_some()
                || self.get_uid().is_some()
                || self.env_saw_path()
                || !self.get_closures().is_empty()
            {
                return Ok(None);
            }

            // Only glibc 2.24+ posix_spawn() supports returning ENOENT directly.
            #[cfg(all(target_os = "linux", target_env = "gnu"))]
            {
                if let Some(version) = sys::os::glibc_version() {
                    if version < (2, 24) {
                        return Ok(None);
                    }
                } else {
                    return Ok(None);
                }
            }

            // Solaris and glibc 2.29+ can set a new working directory, and maybe
            // others will gain this non-POSIX function too. We'll check for this
            // weak symbol as soon as it's needed, so we can return early otherwise
            // to do a manual chdir before exec.
            weak! {
                fn posix_spawn_file_actions_addchdir_np(
                    *mut libc::posix_spawn_file_actions_t,
                    *const libc::c_char
                ) -> libc::c_int
            }
            let addchdir = match self.get_cwd() {
                Some(cwd) => match posix_spawn_file_actions_addchdir_np.get() {
                    Some(f) => Some((f, cwd)),
                    None => return Ok(None),
                },
                None => None,
            };

            let mut p = Process { pid: 0, status: None };

            struct PosixSpawnFileActions(MaybeUninit<libc::posix_spawn_file_actions_t>);

            impl Drop for PosixSpawnFileActions {
                fn drop(&mut self) {
                    unsafe {
                        libc::posix_spawn_file_actions_destroy(self.0.as_mut_ptr());
                    }
                }
            }

            struct PosixSpawnattr(MaybeUninit<libc::posix_spawnattr_t>);

            impl Drop for PosixSpawnattr {
                fn drop(&mut self) {
                    unsafe {
                        libc::posix_spawnattr_destroy(self.0.as_mut_ptr());
                    }
                }
            }

            unsafe {
                let mut file_actions = PosixSpawnFileActions(MaybeUninit::uninit());
                let mut attrs = PosixSpawnattr(MaybeUninit::uninit());

                libc::posix_spawnattr_init(attrs.0.as_mut_ptr());
                libc::posix_spawn_file_actions_init(file_actions.0.as_mut_ptr());

                if let Some(fd) = stdio.stdin.fd() {
                    cvt(libc::posix_spawn_file_actions_adddup2(
                        file_actions.0.as_mut_ptr(),
                        fd,
                        libc::STDIN_FILENO,
                    ))?;
                }
                if let Some(fd) = stdio.stdout.fd() {
                    cvt(libc::posix_spawn_file_actions_adddup2(
                        file_actions.0.as_mut_ptr(),
                        fd,
                        libc::STDOUT_FILENO,
                    ))?;
                }
                if let Some(fd) = stdio.stderr.fd() {
                    cvt(libc::posix_spawn_file_actions_adddup2(
                        file_actions.0.as_mut_ptr(),
                        fd,
                        libc::STDERR_FILENO,
                    ))?;
                }
                if let Some((f, cwd)) = addchdir {
                    cvt(f(file_actions.0.as_mut_ptr(), cwd.as_ptr()))?;
                }

                let mut set = MaybeUninit::<libc::sigset_t>::uninit();
                cvt(sigemptyset(set.as_mut_ptr()))?;
                cvt(libc::posix_spawnattr_setsigmask(attrs.0.as_mut_ptr(), set.as_ptr()))?;
                cvt(sigaddset(set.as_mut_ptr(), libc::SIGPIPE))?;
                cvt(libc::posix_spawnattr_setsigdefault(attrs.0.as_mut_ptr(), set.as_ptr()))?;

                let flags = libc::POSIX_SPAWN_SETSIGDEF | libc::POSIX_SPAWN_SETSIGMASK;
                cvt(libc::posix_spawnattr_setflags(attrs.0.as_mut_ptr(), flags as _))?;

                // Make sure we synchronize access to the global `environ` resource
                let _env_lock = sys::os::env_lock();
                let envp = envp.map(|c| c.as_ptr()).unwrap_or_else(|| *sys::os::environ() as *const _);
                let ret = libc::posix_spawnp(
                    &mut p.pid,
                    self.get_program().as_ptr(),
                    file_actions.0.as_ptr(),
                    attrs.0.as_ptr(),
                    self.get_argv().as_ptr() as *const _,
                    envp as *const _,
                );
                if ret == 0 { Ok(Some(p)) } else { Err(io::Error::from_raw_os_error(ret)) }
            }
        }
    }

    ////////////////////////////////////////////////////////////////////////////////
    // Processes
    ////////////////////////////////////////////////////////////////////////////////

    /// The unique ID of the process (this should never be negative).
    pub struct Process {
        pid: pid_t,
        status: Option<ExitStatus>,
    }

    impl Process {
        pub fn id(&self) -> u32 {
            self.pid as u32
        }

        pub fn kill(&mut self) -> io::Result<()> {
            // If we've already waited on this process then the pid can be recycled
            // and used for another process, and we probably shouldn't be killing
            // random processes, so just return an error.
            if self.status.is_some() {
                Err(Error::new(
                    ErrorKind::InvalidInput,
                    "invalid argument: can't kill an exited process",
                ))
            } else {
                cvt(unsafe { libc::kill(self.pid, libc::SIGKILL) }).map(drop)
            }
        }

        pub fn wait(&mut self) -> io::Result<ExitStatus> {
            use crate::sys::cvt_r;
            if let Some(status) = self.status {
                return Ok(status);
            }
            let mut status = 0 as c_int;
            cvt_r(|| unsafe { libc::waitpid(self.pid, &mut status, 0) })?;
            self.status = Some(ExitStatus::new(status));
            Ok(ExitStatus::new(status))
        }

        pub fn try_wait(&mut self) -> io::Result<Option<ExitStatus>> {
            if let Some(status) = self.status {
                return Ok(Some(status));
            }
            let mut status = 0 as c_int;
            let pid = cvt(unsafe { libc::waitpid(self.pid, &mut status, libc::WNOHANG) })?;
            if pid == 0 {
                Ok(None)
            } else {
                self.status = Some(ExitStatus::new(status));
                Ok(Some(ExitStatus::new(status)))
            }
        }
    }

    /// Unix exit statuses
    #[derive(PartialEq, Eq, Clone, Copy, Debug)]
    pub struct ExitStatus(c_int);

    impl ExitStatus {
        pub fn new(status: c_int) -> ExitStatus {
            ExitStatus(status)
        }

        fn exited(&self) -> bool {
            unsafe { libc::WIFEXITED(self.0) }
        }

        pub fn success(&self) -> bool {
            self.code() == Some(0)
        }

        pub fn code(&self) -> Option<i32> {
            if self.exited() { Some(unsafe { libc::WEXITSTATUS(self.0) }) } else { None }
        }

        pub fn signal(&self) -> Option<i32> {
            if !self.exited() { Some(unsafe { libc::WTERMSIG(self.0) }) } else { None }
        }
    }

    impl From<c_int> for ExitStatus {
        fn from(a: c_int) -> ExitStatus {
            ExitStatus(a)
        }
    }

    impl fmt::Display for ExitStatus {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            if let Some(code) = self.code() {
                write!(f, "exit code: {}", code)
            } else {
                let signal = self.signal().unwrap();
                write!(f, "signal: {}", signal)
            }
        }
    }