Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

fs: Fix crash loop from closedir panic during worktree scan (#59953)

MB30730a305ae2
diff --git a/Cargo.lock b/Cargo.lock
index 5d22ca539aa..0bf1f8a61cf 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -6917,6 +6917,7 @@ dependencies = [
"paths",
"proto",
"rope",
+ "rustix 1.1.2",
"serde",
"serde_json",
"slotmap",
diff --git a/Cargo.toml b/Cargo.toml
index 3eb608e555e..4056f9d568a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -779,6 +779,7 @@ runtimelib = { version = "1.4.0", default-features = false, features = [
] }
rust-embed = { version = "8.11", features = ["include-exclude"] }
rustc-hash = "2.1.0"
+rustix = { version = "1.1", features = ["fs"] }
rustls = { version = "0.23.26" }
rustls-platform-verifier = "0.5.0"
# WARNING: If you change this, you must also publish a new version of zed-scap to crates.io
diff --git a/crates/fs/Cargo.toml b/crates/fs/Cargo.toml
index ef0cb4bd8c2..2f1d694f25a 100644
--- a/crates/fs/Cargo.toml
+++ b/crates/fs/Cargo.toml
@@ -47,6 +47,10 @@ path.workspace = true
is_executable = "1.0.5"
notify = "9.0.0-rc.4"
trash = { git = "https://github.com/zed-industries/trash-rs", rev = "47761739192828a66b11a94ba5420b82d63c03c5" }
+
+[target.'cfg(unix)'.dependencies]
+rustix.workspace = true
+
[target.'cfg(target_os = "windows")'.dependencies]
windows.workspace = true
dunce.workspace = true
diff --git a/crates/fs/src/fs.rs b/crates/fs/src/fs.rs
index a7784922c74..9b3adda7125 100644
--- a/crates/fs/src/fs.rs
+++ b/crates/fs/src/fs.rs
@@ -9,7 +9,7 @@ use std::sync::atomic::{AtomicU8, AtomicUsize, Ordering};
use std::time::Instant;
use util::maybe;
-use anyhow::{Context as _, Result, anyhow};
+use anyhow::{Context as _, Result};
use futures::stream::iter;
use gpui::App;
use gpui::BackgroundExecutor;
@@ -629,6 +629,59 @@ fn path_to_c_string(path: &Path) -> io::Result<CString> {
})
}
+// On Unix targets, std::fs::ReadDir panics in its Drop implementation
+// when an unexpected error is returned from closedir(2). We hit this
+// condition in production; one cause seems to be macOS's FSEventStream
+// incorrectly closing fds it doesn't own, resulting in closedir returning
+// EBADF, see https://github.com/zed-industries/zed/issues/59952#issuecomment-5080178879.
+//
+// We also see occasional errors like ENXIO and ETIMEDOUT that seem to
+// come from network or other exotic filesystems.
+//
+// To avoid crashing the app in this situation, we use the rustix analogue of
+// ReadDir, which doesn't have this panic in drop.
+#[cfg(unix)]
+fn read_dir_entries(path: PathBuf) -> Result<impl Send + Iterator<Item = Result<PathBuf>>> {
+ use rustix::fs::{Dir, Mode, OFlags};
+ use std::ffi::OsStr;
+ use std::os::unix::ffi::OsStrExt;
+
+ let directory_fd = rustix::fs::open(
+ &path,
+ OFlags::RDONLY | OFlags::DIRECTORY | OFlags::CLOEXEC,
+ Mode::empty(),
+ )
+ .with_context(|| format!("failed to open directory {path:?}"))?;
+ let directory =
+ Dir::new(directory_fd).with_context(|| format!("failed to read directory {path:?}"))?;
+
+ Ok(directory.filter_map(move |entry| {
+ let entry = match entry {
+ Ok(entry) => entry,
+ Err(error) => {
+ return Some(Err(anyhow::Error::new(error)
+ .context(format!("failed to read directory entry in {path:?}"))));
+ }
+ };
+ let name = entry.file_name().to_bytes();
+ if name == b"." || name == b".." {
+ return None;
+ }
+ Some(Ok(path.join(OsStr::from_bytes(name))))
+ }))
+}
+
+#[cfg(not(unix))]
+fn read_dir_entries(path: PathBuf) -> Result<impl Send + Iterator<Item = Result<PathBuf>>> {
+ let entries =
+ std::fs::read_dir(&path).with_context(|| format!("failed to open directory {path:?}"))?;
+ Ok(entries.map(move |entry| {
+ entry
+ .map(|entry| entry.path())
+ .with_context(|| format!("failed to read directory entry in {path:?}"))
+ }))
+}
+
#[async_trait::async_trait]
impl Fs for RealFs {
async fn create_dir(&self, path: &Path) -> Result<()> {
@@ -1063,16 +1116,11 @@ impl Fs for RealFs {
path: &Path,
) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>> {
let path = path.to_owned();
- let result = iter(
- self.executor
- .spawn(async move { std::fs::read_dir(path) })
- .await?,
- )
- .map(|entry| match entry {
- Ok(entry) => Ok(entry.path()),
- Err(error) => Err(anyhow!("failed to read dir entry {error:?}")),
- });
- Ok(Box::pin(result))
+ let entries = self
+ .executor
+ .spawn(async move { read_dir_entries(path) })
+ .await?;
+ Ok(Box::pin(iter(entries)))
}
async fn watch(
@@ -1591,7 +1639,7 @@ impl FakeFsState {
Ok(self
.try_entry(target, true)
.ok_or_else(|| {
- anyhow!(io::Error::new(
+ anyhow::anyhow!(io::Error::new(
io::ErrorKind::NotFound,
format!("not found: {target:?}")
))