Skip to content

Commit

Permalink
fs: Use readdir() instead of readdir_r() on Linux
Browse files Browse the repository at this point in the history
readdir() is preferred over readdir_r() on Linux and many other
platforms because it more gracefully supports long file names.  Both
glibc and musl (and presumably all other Linux libc implementations)
guarantee that readdir() is thread-safe as long as a single DIR* is not
accessed concurrently, which is enough to make a readdir()-based
implementation of ReadDir safe.  This implementation is already used for
some other OSes including Fuchsia, Redox, and Solaris.

See rust-lang#40021 for more details.  Fixes rust-lang#86649.
  • Loading branch information
tavianator committed Jan 11, 2022
1 parent 2e2c86e commit ea9181b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
22 changes: 17 additions & 5 deletions library/std/src/sys/unix/fs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ use libc::c_char;
use libc::dirfd;
#[cfg(any(target_os = "linux", target_os = "emscripten"))]
use libc::fstatat64;
#[cfg(any(
target_os = "solaris",
target_os = "fuchsia",
target_os = "redox",
target_os = "illumos"
))]
use libc::readdir as readdir64;
#[cfg(target_os = "linux")]
use libc::readdir64;
#[cfg(not(any(
target_os = "linux",
target_os = "emscripten",
Expand All @@ -60,9 +69,7 @@ use libc::{
lstat as lstat64, off_t as off64_t, open as open64, stat as stat64,
};
#[cfg(any(target_os = "linux", target_os = "emscripten", target_os = "l4re"))]
use libc::{
dirent64, fstat64, ftruncate64, lseek64, lstat64, off64_t, open64, readdir64_r, stat64,
};
use libc::{dirent64, fstat64, ftruncate64, lseek64, lstat64, off64_t, open64, stat64};

pub use crate::sys_common::fs::{remove_dir_all, try_exists};

Expand Down Expand Up @@ -202,6 +209,7 @@ struct InnerReadDir {
pub struct ReadDir {
inner: Arc<InnerReadDir>,
#[cfg(not(any(
target_os = "linux",
target_os = "solaris",
target_os = "illumos",
target_os = "fuchsia",
Expand All @@ -223,6 +231,7 @@ pub struct DirEntry {
// array to store the name, b) its lifetime between readdir
// calls is not guaranteed.
#[cfg(any(
target_os = "linux",
target_os = "solaris",
target_os = "illumos",
target_os = "fuchsia",
Expand Down Expand Up @@ -449,6 +458,7 @@ impl Iterator for ReadDir {
type Item = io::Result<DirEntry>;

#[cfg(any(
target_os = "linux",
target_os = "solaris",
target_os = "fuchsia",
target_os = "redox",
Expand All @@ -464,7 +474,7 @@ impl Iterator for ReadDir {
// is safe to use in threaded applications and it is generally preferred
// over the readdir_r(3C) function.
super::os::set_errno(0);
let entry_ptr = libc::readdir(self.inner.dirp.0);
let entry_ptr = readdir64(self.inner.dirp.0);
if entry_ptr.is_null() {
// null can mean either the end is reached or an error occurred.
// So we had to clear errno beforehand to check for an error now.
Expand Down Expand Up @@ -492,6 +502,7 @@ impl Iterator for ReadDir {
}

#[cfg(not(any(
target_os = "linux",
target_os = "solaris",
target_os = "fuchsia",
target_os = "redox",
Expand Down Expand Up @@ -647,7 +658,6 @@ impl DirEntry {
}
#[cfg(any(
target_os = "android",
target_os = "linux",
target_os = "emscripten",
target_os = "l4re",
target_os = "haiku",
Expand All @@ -658,6 +668,7 @@ impl DirEntry {
unsafe { CStr::from_ptr(self.entry.d_name.as_ptr()).to_bytes() }
}
#[cfg(any(
target_os = "linux",
target_os = "solaris",
target_os = "illumos",
target_os = "fuchsia",
Expand Down Expand Up @@ -1068,6 +1079,7 @@ pub fn readdir(p: &Path) -> io::Result<ReadDir> {
Ok(ReadDir {
inner: Arc::new(inner),
#[cfg(not(any(
target_os = "linux",
target_os = "solaris",
target_os = "illumos",
target_os = "fuchsia",
Expand Down
2 changes: 1 addition & 1 deletion library/std/src/sys/unix/os.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ pub fn errno() -> i32 {
}

/// Sets the platform-specific value of errno
#[cfg(all(not(target_os = "linux"), not(target_os = "dragonfly"), not(target_os = "vxworks")))] // needed for readdir and syscall!
#[cfg(all(not(target_os = "dragonfly"), not(target_os = "vxworks")))] // needed for readdir and syscall!
#[allow(dead_code)] // but not all target cfgs actually end up using it
pub fn set_errno(e: i32) {
unsafe { *errno_location() = e as c_int }
Expand Down

0 comments on commit ea9181b

Please sign in to comment.