Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-27 13:23:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix rust version of is_wsl() check (#9746)

Browse source 
Somewhat counter-intuitively, this code is active when compiling under *Linux*
and is always false when compiling under Windows. The logic was incorrectly
reversed before (it's easier to reason about when you realize that fish doesn't
even compile under Windows because it uses tons of libc functions).

As the code was actually never compiled, it wasn't actually tested for validity
either and there were some issues that prevented it from compiling that have
since been fixed. The logic has also been adjusted a bit to make it possible to
use the rust-native int parsing instead of `libc::strtod()`.

The code has been changed to use `once_cell::race::OnceBool` instead of
`once_cell::sync::Lazy<T>` which imposes a greater runtime burden with locking
and other overhead. We don't care if the code runs more than once on init (if
calls were to race, though they probably don't) - just that the code isn't
subsequently executed on each call. The `once_cell::race` module is a better fit
here, though it doesn't expose the ergonomic `Lazy<T>` façade around its types.
This commit is contained in:
Mahmoud Al-Qudsi 2023-04-23 12:28:23 -05:00 committed by GitHub
parent ff28f29e8f
commit 3a2033b992
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
fish-rust/src/common.rs
View file

@ -1615,6 +1615,13 @@ pub fn restore_term_foreground_process_group_for_exit() {
}
}
fn slice_contains_slice<T: Eq>(a: &[T], b: &[T]) -> bool {
a.windows(b.len()).any(|aw| aw == b)
}
#[cfg(target_os = "linux")]
static IS_WINDOWS_SUBSYSTEM_FOR_LINUX: once_cell::race::OnceBool = once_cell::race::OnceBool::new();
/// Determines if we are running under Microsoft's Windows Subsystem for Linux to work around
/// some known limitations and/or bugs.
/// See https://github.com/Microsoft/WSL/issues/423 and Microsoft/WSL#2997
@ -1623,55 +1630,61 @@ pub fn is_windows_subsystem_for_linux() -> bool {
// overhead since there's no actual race condition here - even if multiple threads call this
// routine simultaneously the first time around, we just end up needlessly querying uname(2) one
// more time.
*IS_WINDOWS_SUBSYSTEM_FOR_LINUX
}
fn slice_contains_slice<T: Eq>(a: &[T], b: &[T]) -> bool {
a.windows(b.len()).any(|aw| aw == b)
}
#[cfg(not(windows))]
static IS_WINDOWS_SUBSYSTEM_FOR_LINUX: Lazy<bool> = Lazy::new(|| false);
#[cfg(windows)]
static IS_WINDOWS_SUBSYSTEM_FOR_LINUX: Lazy<bool> = Lazy::new(|| {
let mut info: libc::utsname = unsafe { mem::zeroed() };
unsafe {
libc::uname(&mut info);
}
// Sample utsname.release under WSL, testing for something like `4.4.0-17763-Microsoft`
if !slice_contains_slice(&info.release, b"Microsoft") {
return false;
}
let dash = info.release.iter().position('-');
if dash
.map(|d| unsafe { libc::strtod(&info.release[d + 1], std::ptr::null()) } >= 17763)
.unwrap_or(false)
#[cfg(not(target_os = "linux"))]
{
return false;
false
}
// #5298, #5661: There are acknowledged, published, and (later) fixed issues with
// job control under early WSL releases that prevent fish from running correctly,
// with unexpected failures when piping. Fish 3.0 nightly builds worked around this
// issue with some needlessly complicated code that was later stripped from the
// fish 3.0 release, so we just bail. Note that fish 2.0 was also broken, but we
// just didn't warn about it.
#[cfg(target_os = "linux")]
IS_WINDOWS_SUBSYSTEM_FOR_LINUX.get_or_init(|| {
let mut info: libc::utsname = unsafe { mem::zeroed() };
let release: &[u8] = unsafe {
libc::uname(&mut info);
std::mem::transmute(&info.release[..])
};
// #6038 & 5101bde: It's been requested that there be some sort of way to disable
// this check: if the environment variable FISH_NO_WSL_CHECK is present, this test
// is bypassed. We intentionally do not include this in the error message because
// it'll only allow fish to run but not to actually work. Here be dragons!
if env::var("FISH_NO_WSL_CHECK") == Err(env::VarError::NotPresent) {
FLOG!(
error,
"This version of WSL has known bugs that prevent fish from working.\
Please upgrade to Windows 10 1809 (17763) or higher to use fish!"
);
}
true;
});
// Sample utsname.release under WSL, testing for something like `4.4.0-17763-Microsoft`
if !slice_contains_slice(release, b"Microsoft") {
return false;
}
let release: Vec<_> = release
.iter()
.skip_while(|c| **c != b'-')
.skip(1) // the dash itself
.take_while(|c| c.is_ascii_digit())
.copied()
.collect();
let build: Result<u32, _> = std::str::from_utf8(&release).unwrap().parse();
match build {
Ok(17763..) => return true,
Ok(_) => (), // handled below
_ => return false, // if parsing fails, assume this isn't WSL
};
// #5298, #5661: There are acknowledged, published, and (later) fixed issues with
// job control under early WSL releases that prevent fish from running correctly,
// with unexpected failures when piping. Fish 3.0 nightly builds worked around this
// issue with some needlessly complicated code that was later stripped from the
// fish 3.0 release, so we just bail. Note that fish 2.0 was also broken, but we
// just didn't warn about it.
// #6038 & 5101bde: It's been requested that there be some sort of way to disable
// this check: if the environment variable FISH_NO_WSL_CHECK is present, this test
// is bypassed. We intentionally do not include this in the error message because
// it'll only allow fish to run but not to actually work. Here be dragons!
if env::var("FISH_NO_WSL_CHECK") == Err(env::VarError::NotPresent) {
crate::flog::FLOG!(
error,
concat!(
"This version of WSL has known bugs that prevent fish from working.\n",
"Please upgrade to Windows 10 1809 (17763) or higher to use fish!"
)
);
}
true
})
}
/// Return true if the character is in a range reserved for fish's private use.
///