Merge branch 'reimpl-at_fdcwd' into 'master'

refactor: Reimplement the *at functions using openat and CWD fd

See merge request redox-os/relibc!1058
This commit is contained in:
Jeremy Soller
2026-03-01 07:08:31 -07:00
6 changed files with 230 additions and 158 deletions
+12
View File
@@ -31,12 +31,24 @@ impl File {
.map_err(Errno::sync)
}
pub fn openat(dirfd: c_int, path: CStr, oflag: c_int) -> Result<Self, Errno> {
Sys::openat(dirfd, path, oflag, 0)
.map(Self::new)
.map_err(Errno::sync)
}
pub fn create(path: CStr, oflag: c_int, mode: mode_t) -> Result<Self, Errno> {
Sys::open(path, oflag | O_CREAT, mode)
.map(Self::new)
.map_err(Errno::sync)
}
pub fn createat(dirfd: c_int, path: CStr, oflag: c_int, mode: mode_t) -> Result<Self, Errno> {
Sys::openat(dirfd, path, oflag | O_CREAT, mode)
.map(Self::new)
.map_err(Errno::sync)
}
pub fn sync_all(&self) -> Result<(), Errno> {
Sys::fsync(self.fd).map_err(Errno::sync)
}
+4
View File
@@ -598,6 +598,10 @@ impl Pal for Sys {
.map(|fd| fd as c_int)
}
fn openat(dirfd: c_int, path: CStr, oflag: c_int, mode: mode_t) -> Result<c_int> {
e_raw(unsafe { syscall!(OPENAT, dirfd, path.as_ptr(), oflag, mode) }).map(|fd| fd as c_int)
}
fn pipe2(mut fildes: Out<[c_int; 2]>, flags: c_int) -> Result<()> {
e_raw(unsafe { syscall!(PIPE2, fildes.as_mut_ptr(), flags) }).map(|_| ())
}
+2
View File
@@ -222,6 +222,8 @@ pub trait Pal {
fn open(path: CStr, oflag: c_int, mode: mode_t) -> Result<c_int>;
fn openat(dirfd: c_int, path: CStr, oflag: c_int, mode: mode_t) -> Result<c_int>;
fn pipe2(fildes: Out<[c_int; 2]>, flags: c_int) -> Result<()>;
fn posix_fallocate(fd: c_int, offset: u64, length: NonZeroU64) -> Result<()>;
+15
View File
@@ -32,6 +32,21 @@ pub fn open(path: &str, oflag: c_int, mode: mode_t) -> Result<usize> {
.map(|f| f as usize)
}
pub fn openat(dirfd: c_int, path: &str, oflag: c_int, mode: mode_t) -> Result<usize> {
let usize_fd = super::path::openat(
dirfd,
path,
((oflag as usize) & 0xFFFF_0000) | ((mode as usize) & 0xFFFF),
)?;
c_int::try_from(usize_fd)
.map_err(|_| {
let _ = syscall::close(usize_fd);
Error::new(EMFILE)
})
.map(|f| f as usize)
}
pub unsafe fn fstat(fd: usize, buf: *mut crate::header::sys_stat::stat) -> Result<()> {
let mut redox_buf: syscall::Stat = Default::default();
syscall::fstat(fd, &mut redox_buf)?;
+34 -48
View File
@@ -28,8 +28,8 @@ use crate::{
header::{
bits_time::timespec,
errno::{
EBADF, EBADFD, EBADR, EEXIST, EFAULT, EFBIG, EINTR, EINVAL, EIO, ENAMETOOLONG, ENOENT,
ENOMEM, ENOSYS, EOPNOTSUPP, EPERM,
EBADF, EBADFD, EEXIST, EFAULT, EFBIG, EINTR, EINVAL, EIO, ENAMETOOLONG, ENOENT, ENOMEM,
ENOSYS, EOPNOTSUPP, EPERM,
},
fcntl::{
self, AT_EMPTY_PATH, AT_FDCWD, AT_SYMLINK_NOFOLLOW, F_GETLK, F_OFD_GETLK, F_OFD_SETLK,
@@ -772,21 +772,13 @@ impl Pal for Sys {
}
fn mkdirat(dir_fd: c_int, path_name: CStr, mode: mode_t) -> Result<()> {
let mut dir_path_buf = [0; 4096];
let res = Sys::fpath(dir_fd, &mut dir_path_buf)?;
let dir_path = str::from_utf8(&dir_path_buf[..res as usize]).map_err(|_| Errno(EBADR))?;
let resource_path =
path::canonicalize_using_cwd(Some(&dir_path), &path_name.to_string_lossy())
// Since parent_dir_path is resolved by fpath, it is more likely that
// the problem was with path.
.ok_or(Errno(ENOENT))?;
Sys::mkdir(
CStr::borrow(&CString::new(resource_path.as_bytes()).unwrap()),
mode,
)
File::createat(
dir_fd,
path_name,
fcntl::O_DIRECTORY | fcntl::O_EXCL | fcntl::O_CLOEXEC,
0o777,
)?;
Ok(())
}
fn mkdir(path: CStr, mode: mode_t) -> Result<()> {
@@ -799,19 +791,11 @@ impl Pal for Sys {
}
fn mkfifoat(dir_fd: c_int, path_name: CStr, mode: mode_t) -> Result<()> {
let mut dir_path_buf = [0; 4096];
let res = Sys::fpath(dir_fd, &mut dir_path_buf)?;
let dir_path = str::from_utf8(&dir_path_buf[..res as usize]).map_err(|_| Errno(EBADR))?;
let resource_path =
path::canonicalize_using_cwd(Some(&dir_path), &path_name.to_string_lossy())
// Since parent_dir_path is resolved by fpath, it is more likely that
// the problem was with path.
.ok_or(Errno(ENOENT))?;
Sys::mkfifo(
CStr::borrow(&CString::new(resource_path.as_bytes()).unwrap()),
mode,
Sys::mknodat(
dir_fd,
path_name,
syscall::MODE_FIFO as mode_t | (mode & 0o777),
0,
)
}
@@ -820,22 +804,8 @@ impl Pal for Sys {
}
fn mknodat(dir_fd: c_int, path_name: CStr, mode: mode_t, dev: dev_t) -> Result<()> {
let mut dir_path_buf = [0; 4096];
let res = Sys::fpath(dir_fd, &mut dir_path_buf)?;
let dir_path = str::from_utf8(&dir_path_buf[..res as usize]).map_err(|_| Errno(EBADR))?;
let resource_path =
path::canonicalize_using_cwd(Some(&dir_path), &path_name.to_string_lossy())
// Since parent_dir_path is resolved by fpath, it is more likely that
// the problem was with path.
.ok_or(Errno(ENOENT))?;
Sys::mknod(
CStr::borrow(&CString::new(resource_path.as_bytes()).unwrap()),
mode,
dev,
)
File::createat(dir_fd, path_name, fcntl::O_CREAT | fcntl::O_CLOEXEC, mode)?;
Ok(())
}
fn mknod(path: CStr, mode: mode_t, dev: dev_t) -> Result<(), Errno> {
@@ -995,6 +965,21 @@ impl Pal for Sys {
Ok(libredox::open(path, oflag, effective_mode)? as c_int)
}
fn openat(dirfd: c_int, path: CStr, oflag: c_int, mode: mode_t) -> Result<c_int> {
let path = path.to_str().map_err(|_| Errno(EINVAL))?;
// POSIX states that umask should affect the following:
//
// open, openat, creat, mkdir, mkdirat,
// mkfifo, mkfifoat, mknod, mknodat,
// mq_open, and sem_open,
//
// all of which (the ones that exist thus far) currently call this function.
let effective_mode = mode & !(redox_rt::sys::get_umask() as mode_t);
Ok(libredox::openat(dirfd, path, oflag, effective_mode)? as c_int)
}
fn pipe2(mut fds: Out<[c_int; 2]>, flags: c_int) -> Result<()> {
fds.write(extra::pipe2(flags as usize)?);
Ok(())
@@ -1167,11 +1152,11 @@ impl Pal for Sys {
}
let new_path = new_path.to_str().map_err(|_| Errno(EINVAL))?;
let target = openat2_path(new_dir, new_path, 0)?;
// Fail if the target exists with RENAME_NOREPLACE.
if flags & RENAME_NOREPLACE != 0
&& let Ok(fd) =
libredox::open(&target, fcntl::O_PATH | fcntl::O_CLOEXEC, 0).map(FdGuard::new)
libredox::openat(new_dir, &new_path, fcntl::O_PATH | fcntl::O_CLOEXEC, 0)
.map(FdGuard::new)
{
return Err(Errno(EEXIST));
}
@@ -1180,6 +1165,7 @@ impl Pal for Sys {
// oflags are the same as Sys::rename above.
let source = openat2(old_dir, old_path, 0, fcntl::O_NOFOLLOW | fcntl::O_PATH)?;
let target = openat2_path(new_dir, new_path, 0)?;
// I'm avoiding Sys::rename to avoid reallocating a CString from a String.
syscall::frename(*source as usize, target)
.map(|_| ())
+163 -110
View File
@@ -83,9 +83,6 @@ fn partially_canonical(path: &str) -> Option<String> {
)
}
// TODO: Define in syscall
const PATH_MAX: usize = 4096;
// POSIX states chdir is both thread-safe and signal-safe. Thus we need to synchronize access to CWD, but at the
// same time forbid signal handlers from running in the meantime, to avoid reentrant deadlock.
pub fn chdir(path: &str) -> Result<()> {
@@ -132,8 +129,8 @@ pub fn chdir(path: &str) -> Result<()> {
}
pub fn fchdir(fd: c_int) -> Result<()> {
let mut buf = [0; PATH_MAX];
let res = syscall::fpath(fd as usize, &mut buf)?;
let mut buf = [0_u8; limits::PATH_MAX];
let res = Sys::fpath(fd, &mut buf)?;
let path = core::str::from_utf8(&buf[..res])
.map_err(|_| Errno(EINVAL))?
@@ -168,6 +165,7 @@ pub fn getcwd(mut buf: Out<[u8]>) -> Result<usize> {
// Get Cwd object
pub fn current_dir() -> Result<ReadGuard<'static, Option<Cwd>>> {
let _siglock = tmp_disable_signals();
let guard = CWD.read();
if guard.as_ref().is_none() {
@@ -229,92 +227,56 @@ pub fn clone_cwd() -> Option<Box<str>> {
CWD.read().as_ref().map(|cwd| cwd.path.clone())
}
// TODO: Move to redox-rt, or maybe part of it?
pub fn open(path: &str, flags: usize) -> Result<usize> {
// TODO: SYMLOOP_MAX
const MAX_LEVEL: usize = 64;
if path == "" {
return Err(Error::new(ENOENT));
fn open_absolute(path: &str, flags: usize) -> Result<usize> {
if path.starts_with(libcscheme::LIBC_SCHEME) {
libcscheme::open(path, flags)
} else {
redox_rt::sys::open(path, flags)
}
}
let open_absolute = |path: &str| -> Result<usize> {
if path.starts_with(libcscheme::LIBC_SCHEME) {
libcscheme::open(path, flags)
} else {
redox_rt::sys::open(path, flags)
}
};
fn link_target(fd: FdGuard) -> Result<String> {
let mut resolve_buf = [0_u8; limits::PATH_MAX];
let count = fd.read(&mut resolve_buf)?;
if count == resolve_buf.len() {
// TODO: make resolve_buf PATH_MAX + 1 bytes?
return Err(Error::new(ENAMETOOLONG));
}
// If the symbolic link path is non-UTF8, it cannot be opened, and is thus
// considered a "dangling symbolic link".
core::str::from_utf8(&resolve_buf[..count])
.map_err(|_| Error::new(ENOENT))
.map(|s| s.to_string())
}
let read_link_content = |path: &str, is_relative: bool| -> Result<String> {
let mut resolve_buf = [0_u8; 4096];
let resolve_flags = O_CLOEXEC | O_SYMLINK | O_RDONLY;
fn read_link_content(path: &str, is_relative: bool) -> Result<String> {
let resolve_flags = O_CLOEXEC | O_SYMLINK | O_RDONLY;
let fd = if is_relative {
let fcntl_flags = resolve_flags & syscall::O_FCNTL_MASK;
current_dir()?
.as_ref()
.unwrap()
.fd
.openat(path, resolve_flags, fcntl_flags)?
} else {
FdGuard::open(path, resolve_flags)?
};
let count = fd.read(&mut resolve_buf)?;
if count == resolve_buf.len() {
// TODO: make resolve_buf PATH_MAX + 1 bytes?
return Err(Error::new(ENAMETOOLONG));
}
// If the symbolic link path is non-UTF8, it cannot be opened, and is thus
// considered a "dangling symbolic link".
core::str::from_utf8(&resolve_buf[..count])
.map_err(|_| Error::new(ENOENT))
.map(|s| s.to_string())
};
let calc_next_abs_path = |current_abs: &str, link_target: &str| -> Result<String> {
let _siglock = tmp_disable_signals();
let parent = get_parent_path(current_abs).ok_or(Error::new(ENOENT))?;
canonicalize_using_cwd(Some(parent), link_target).ok_or(Error::new(ENOENT))
};
let (is_relative, canon) = normalize_scheme_rooted_path(path).ok_or(Error::new(ENOENT))?;
let mut current_path_string: String;
// First try
let initial_res = if is_relative {
let fcntl_flags = flags & syscall::O_FCNTL_MASK;
let fd = if is_relative {
current_dir()?
.as_ref()
.unwrap()
.fd
.openat(&canon, flags, fcntl_flags)
.map(|fd: FdGuard| fd.take())
.openat(path, resolve_flags, 0)?
} else {
open_absolute(&canon)
FdGuard::open(path, resolve_flags)?
};
match initial_res {
Ok(fd) => return Ok(fd),
Err(e) if e == Error::new(EXDEV) => {
let link_target = read_link_content(&canon, is_relative)?;
link_target(fd)
}
let _siglock = tmp_disable_signals();
let cwd_guard = CWD.read();
let current_abs =
canonicalize_using_cwd(cwd_guard.as_ref().map(|c| c.path.as_ref()), &canon)
.ok_or(Error::new(ENOENT))?;
fn calc_next_abs_path(current_abs: &str, link_target: &str) -> Result<String> {
let parent = get_parent_path(current_abs).ok_or(Error::new(ENOENT))?;
current_path_string = calc_next_abs_path(&current_abs, &link_target)?;
}
Err(e) => return Err(e),
}
canonicalize_using_cwd(Some(&parent), link_target).ok_or(Error::new(ENOENT))
}
fn resolve_sym_links(mut current_path_string: String, flags: usize) -> Result<usize> {
// TODO: SYMLOOP_MAX
const MAX_LEVEL: usize = 64;
// Sym reolve loop
for _ in 0..(MAX_LEVEL - 1) {
match open_absolute(&current_path_string) {
match open_absolute(&current_path_string, flags) {
Ok(fd) => return Ok(fd),
Err(e) if e == Error::new(EXDEV) => {
let link_target = read_link_content(&current_path_string, false)?;
@@ -328,6 +290,125 @@ pub fn open(path: &str, flags: usize) -> Result<usize> {
Err(Error::new(ELOOP))
}
// TODO: Move to redox-rt, or maybe part of it?
pub fn openat(dirfd: c_int, path: &str, flags: usize) -> Result<usize> {
if path.is_empty() && flags as i32 & fcntl::AT_EMPTY_PATH != fcntl::AT_EMPTY_PATH {
return Err(Error::new(ENOENT));
}
let (is_relative, path_to_open) = normalize_path(path).ok_or(Error::new(ENOENT))?;
if !is_relative {
return open(path, flags);
}
let _siglock = tmp_disable_signals();
let fcntl_flags = flags & syscall::O_FCNTL_MASK;
// First try
let initial_res = if dirfd == fcntl::AT_FDCWD {
current_dir()?
.as_ref()
.unwrap()
.fd
.openat(&path_to_open, flags, fcntl_flags)
.map(|fd: FdGuard| fd.take())
} else {
redox_rt::sys::openat(dirfd as usize, &path_to_open, flags, fcntl_flags)
};
let current_path_string = match initial_res {
Ok(fd) => return Ok(fd),
Err(e) if e == Error::new(EXDEV) => {
let resolve_flags = O_CLOEXEC | O_SYMLINK | O_RDONLY;
let fd = if dirfd == fcntl::AT_FDCWD {
current_dir()?
.as_ref()
.unwrap()
.fd
.openat(path, resolve_flags, 0)?
} else {
redox_rt::sys::openat(dirfd as usize, &path_to_open, flags, fcntl_flags)
.map(FdGuard::new)?
};
let link_target = link_target(fd)?;
let current_abs = openat2_path(dirfd, path, 0)?;
calc_next_abs_path(&current_abs, &link_target)?
}
Err(e) => return Err(e),
};
resolve_sym_links(current_path_string, flags)
}
// TODO: Move to redox-rt, or maybe part of it?
pub fn open(path: &str, flags: usize) -> Result<usize> {
let _siglock = tmp_disable_signals();
if path == "" {
return Err(Error::new(ENOENT));
}
let (is_relative, canon) = normalize_scheme_rooted_path(path).ok_or(Error::new(ENOENT))?;
// First try
let initial_res = if is_relative {
let fcntl_flags = flags & syscall::O_FCNTL_MASK;
current_dir()?
.as_ref()
.unwrap()
.fd
.openat(&canon, flags, fcntl_flags)
.map(|fd: FdGuard| fd.take())
} else {
open_absolute(&canon, flags)
};
let current_path_string = match initial_res {
Ok(fd) => return Ok(fd),
Err(e) if e == Error::new(EXDEV) => {
let link_target = read_link_content(&canon, is_relative)?;
let cwd_guard = CWD.read();
let current_abs =
canonicalize_using_cwd(cwd_guard.as_ref().map(|c| c.path.as_ref()), &canon)
.ok_or(Error::new(ENOENT))?;
calc_next_abs_path(&current_abs, &link_target)?
}
Err(e) => return Err(e),
};
// Sym reolve loop
resolve_sym_links(current_path_string, flags)
}
fn get_parent_path(path: &str) -> Option<String> {
let path = path.strip_suffix('/').unwrap_or(path);
fn parent_opt(path: &str) -> Option<&str> {
path.rfind('/').map(|index| {
if index == 0 {
// Path is something like "/file.txt" or the root "/".
// The parent is the root directory "/".
"/"
} else {
// Path is something like "/a/b/c.txt".
// Take the slice from the beginning up to the last '/'.
&path[..index]
}
})
}
match RedoxPath::from_absolute(path) {
Some(path) => {
let (scheme, reference) = path.as_parts()?;
let parent_ref = parent_opt(reference.as_ref()).unwrap_or("");
Some(format!("/scheme/{}/{}", scheme.as_ref(), parent_ref))
}
None => parent_opt(path).map(String::from),
}
}
pub fn dir_path_and_fd_path(socket_path: &str) -> Result<(String, String)> {
let _siglock = tmp_disable_signals();
let cwd_guard = CWD.read();
@@ -341,31 +422,17 @@ pub fn dir_path_and_fd_path(socket_path: &str) -> Result<(String, String)> {
return Err(Error::new(EINVAL));
}
if redox_path.is_default_scheme() {
let dir_to_open = String::from(get_parent_path(&full_path).ok_or(Error::new(EINVAL))?);
let dir_to_open = get_parent_path(&full_path).ok_or(Error::new(EINVAL))?;
Ok((dir_to_open, ref_path.as_ref().to_string()))
} else {
let full_path = canonicalize_with_cwd_internal(cwd_path, ref_path.as_ref())?;
let redox_path = RedoxPath::from_absolute(&full_path).ok_or(Error::new(EINVAL))?;
let (_, path) = redox_path.as_parts().ok_or(Error::new(EINVAL))?;
let dir_to_open = String::from(get_parent_path(&full_path).ok_or(Error::new(EINVAL))?);
let dir_to_open = get_parent_path(&full_path).ok_or(Error::new(EINVAL))?;
Ok((dir_to_open, path.as_ref().to_string()))
}
}
fn get_parent_path(path: &str) -> Option<&str> {
path.rfind('/').and_then(|index| {
if index == 0 {
// Path is something like "/file.txt" or the root "/".
// The parent is the root directory "/".
Some("/")
} else {
// Path is something like "/a/b/c.txt".
// Take the slice from the beginning up to the last '/'.
Some(&path[..index])
}
})
}
pub struct FileLock(c_int);
impl FileLock {
@@ -405,18 +472,9 @@ pub(super) fn openat2_path(dirfd: c_int, path: &str, at_flags: c_int) -> Result<
// isn't needed.
if dirfd == fcntl::AT_FDCWD {
// The special constant AT_FDCWD indicates that we should use the cwd.
let mut buf = [0; limits::PATH_MAX];
let len = match getcwd(Out::from_mut(&mut buf)) {
Ok(len) => len,
Err(e) if e.errno == ERANGE => {
return Err(Errno(ENAMETOOLONG));
}
Err(e) => return Err(Errno(e.errno)),
};
// SAFETY: Redox's cwd is stored as a str.
let cwd = unsafe { str::from_utf8_unchecked(&buf[..len]) };
canonicalize_using_cwd(Some(cwd), path).ok_or(Errno(EBADF))
let cwd_guard = CWD.read();
canonicalize_using_cwd(cwd_guard.as_ref().map(|c| c.path.as_ref()), path)
.ok_or(Errno(EBADF))
} else {
let mut buf = [0; limits::PATH_MAX];
let len = Sys::fpath(dirfd, &mut buf)?;
@@ -453,17 +511,12 @@ pub(super) fn openat2(
at_flags: c_int,
oflags: c_int,
) -> Result<File, Errno> {
let path = openat2_path(dirfd, path, at_flags)?;
let path = CString::new(path).map_err(|_| Errno(ENOENT))?;
// Translate at flags into open flags; openat will do this on its own most likely.
let oflags = if at_flags & fcntl::AT_SYMLINK_NOFOLLOW == fcntl::AT_SYMLINK_NOFOLLOW {
fcntl::O_CLOEXEC | fcntl::O_NOFOLLOW | fcntl::O_PATH | fcntl::O_SYMLINK | oflags
} else {
fcntl::O_CLOEXEC | oflags
};
// TODO:
// * Switch open to openat.
File::open(path.as_c_str().into(), oflags)
let c_path = CString::new(path).map_err(|_| Errno(EINVAL))?;
File::openat(dirfd, c_path.as_c_str().into(), oflags)
}