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.

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

use RWlock when accessing os::env #81850

Merged
merged 5 commits into from
Feb 13, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions library/std/src/sys/unix/os.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ use crate::str;
use crate::sys::cvt;
use crate::sys::fd;
use crate::sys_common::mutex::{StaticMutex, StaticMutexGuard};
use crate::sys_common::rwlock::{RWLock, RWLockGuard};
use crate::vec;

use libc::{c_char, c_int, c_void};
Expand Down Expand Up @@ -493,17 +494,16 @@ pub unsafe fn environ() -> *mut *const *const c_char {
&mut environ
}

pub unsafe fn env_lock() -> StaticMutexGuard {
// It is UB to attempt to acquire this mutex reentrantly!
static ENV_LOCK: StaticMutex = StaticMutex::new();
ENV_LOCK.lock()
pub unsafe fn env_rwlock(readonly: bool) -> RWLockGuard {
static ENV_LOCK: RWLock = RWLock::new();
if readonly { ENV_LOCK.read_with_guard() } else { ENV_LOCK.write_with_guard() }
}

/// Returns a vector of (variable, value) byte-vector pairs for all the
/// environment variables of the current process.
pub fn env() -> Env {
unsafe {
let _guard = env_lock();
let _guard = env_rwlock(true);
the8472 marked this conversation as resolved.
Show resolved Hide resolved
let mut environ = *environ();
the8472 marked this conversation as resolved.
Show resolved Hide resolved
let mut result = Vec::new();
if !environ.is_null() {
Expand Down Expand Up @@ -540,7 +540,7 @@ pub fn getenv(k: &OsStr) -> io::Result<Option<OsString>> {
// always None as well
let k = CString::new(k.as_bytes())?;
unsafe {
let _guard = env_lock();
let _guard = env_rwlock(true);
let s = libc::getenv(k.as_ptr()) as *const libc::c_char;
let ret = if s.is_null() {
None
Expand All @@ -556,7 +556,7 @@ pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
let v = CString::new(v.as_bytes())?;

unsafe {
let _guard = env_lock();
let _guard = env_rwlock(false);
cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(drop)
}
}
Expand All @@ -565,7 +565,7 @@ pub fn unsetenv(n: &OsStr) -> io::Result<()> {
let nbuf = CString::new(n.as_bytes())?;

unsafe {
let _guard = env_lock();
let _guard = env_rwlock(false);
cvt(libc::unsetenv(nbuf.as_ptr())).map(drop)
}
}
Expand Down
6 changes: 3 additions & 3 deletions library/std/src/sys/unix/process/process_unix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ impl Command {
// 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();
let _env_lock = sys::os::env_rwlock(true);
cvt(libc::fork())?
};

Expand Down Expand Up @@ -124,7 +124,7 @@ impl Command {
// 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 _lock = sys::os::env_rwlock(true);

let Err(e) = self.do_exec(theirs, envp.as_ref());
e
Expand Down Expand Up @@ -404,7 +404,7 @@ impl Command {
cvt_nz(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 _env_lock = sys::os::env_rwlock(true);
let envp = envp.map(|c| c.as_ptr()).unwrap_or_else(|| *sys::os::environ() as *const _);
cvt_nz(libc::posix_spawnp(
&mut p.pid,
Expand Down
49 changes: 49 additions & 0 deletions library/std/src/sys_common/rwlock.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
use crate::sys::rwlock as imp;

#[cfg(unix)]
enum GuardType {
Read,
Write,
}

#[cfg(unix)]
pub struct RWLockGuard(&'static RWLock, GuardType);

#[cfg(unix)]
impl Drop for RWLockGuard {
fn drop(&mut self) {
unsafe {
match &self.1 {
GuardType::Read => self.0.read_unlock(),
GuardType::Write => self.0.write_unlock(),
}
}
}
}

/// An OS-based reader-writer lock.
///
/// This structure is entirely unsafe and serves as the lowest layer of a
Expand All @@ -26,6 +47,20 @@ impl RWLock {
self.0.read()
}

/// Acquires shared access to the underlying lock, blocking the current
/// thread to do so.
///
/// The lock is automatically unlocked when the returned guard is dropped.
///
/// Behavior is undefined if the rwlock has been moved between this and any
/// previous method call.
the8472 marked this conversation as resolved.
Show resolved Hide resolved
#[inline]
#[cfg(unix)]
pub unsafe fn read_with_guard(&'static self) -> RWLockGuard {
self.read();
RWLockGuard(&self, GuardType::Read)
}

/// Attempts to acquire shared access to this lock, returning whether it
/// succeeded or not.
///
Expand All @@ -48,6 +83,20 @@ impl RWLock {
self.0.write()
}

/// Acquires write access to the underlying lock, blocking the current thread
/// to do so.
///
/// The lock is automatically unlocked when the returned guard is dropped.
///
/// Behavior is undefined if the rwlock has been moved between this and any
/// previous method call.
#[inline]
#[cfg(unix)]
pub unsafe fn write_with_guard(&'static self) -> RWLockGuard {
self.write();
RWLockGuard(&self, GuardType::Write)
}

/// Attempts to acquire exclusive access to this lock, returning whether it
/// succeeded or not.
///
Expand Down