-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a `rustix::fs::ABS` constant, which corresponds to the undocumented but commonly used convention of using `-EBADF` as the file descriptor in `openat` and similar calls. This makes them fail if the path is not absolute. Fixes #1187.
- Loading branch information
1 parent
8adb366
commit 1f44e35
Showing
10 changed files
with
83 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
//! The `CWD` and `ABS` constants, representing the current working directory | ||
//! and absolute-only paths, respectively. | ||
//! | ||
//! # Safety | ||
//! | ||
//! This file uses `AT_FDCWD`, which is a raw file descriptor, but which is | ||
//! always valid, and `-EBADF`, which is an undocumented by commonly used | ||
//! convention for passing a value which will always fail if the accompanying | ||
//! path isn't absolute. | ||
#![allow(unsafe_code)] | ||
|
||
use crate::backend; | ||
use backend::c; | ||
use backend::fd::{BorrowedFd, RawFd}; | ||
|
||
/// `AT_FDCWD`—A handle representing the current working directory. | ||
/// | ||
/// This is a file descriptor which refers to the process current directory | ||
/// which can be used as the directory argument in `*at` functions such as | ||
/// [`openat`]. | ||
/// | ||
/// # References | ||
/// - [POSIX] | ||
/// | ||
/// [`openat`]: crate::fs::openat | ||
/// [POSIX]: https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/fcntl.h.html | ||
// SAFETY: `AT_FDCWD` is a reserved value that is never dynamically | ||
// allocated, so it'll remain valid for the duration of `'static`. | ||
#[doc(alias = "AT_FDCWD")] | ||
pub const CWD: BorrowedFd<'static> = | ||
unsafe { BorrowedFd::<'static>::borrow_raw(c::AT_FDCWD as RawFd) }; | ||
|
||
/// `-EBADF`—A handle that requires paths to be absolute. | ||
/// | ||
/// This is a file descriptor which refers to no directory, which can be used | ||
/// as the directory argument in `*at` functions such as [`openat`], which | ||
/// causes them to fail if the accompanying path is not absolute. | ||
/// | ||
/// [`openat`]: crate::fs::openat | ||
// SAFETY: This `-EBADF` convention is commonly used, such as in lxc, so OS's | ||
// aren't going to break it. | ||
pub const ABS: BorrowedFd<'static> = | ||
unsafe { BorrowedFd::<'static>::borrow_raw(c::EBADF.wrapping_neg() as RawFd) }; | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use super::*; | ||
use crate::fd::AsRawFd; | ||
|
||
#[test] | ||
fn test_cwd() { | ||
assert!(CWD.as_raw_fd() != -1); | ||
#[cfg(linux_kernel)] | ||
#[cfg(feature = "io_uring")] | ||
assert!(CWD.as_raw_fd() != linux_raw_sys::io_uring::IORING_REGISTER_FILES_SKIP); | ||
} | ||
|
||
#[test] | ||
fn test_abs() { | ||
assert!(ABS.as_raw_fd() < 0); | ||
assert!(ABS.as_raw_fd() != -1); | ||
assert!(ABS.as_raw_fd() != c::AT_FDCWD); | ||
#[cfg(linux_kernel)] | ||
#[cfg(feature = "io_uring")] | ||
assert!(ABS.as_raw_fd() != linux_raw_sys::io_uring::IORING_REGISTER_FILES_SKIP); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters