Implement Metadata:from_statx for Linux MetadataExt trait

Author: asder8215

library/std/src/os/linux/fs.rs

@@ -4,10 +4,20 @@
 
 #![stable(feature = "metadata_ext", since = "1.1.0")]
 
+use core::mem;
+
 use crate::fs::Metadata;
 #[allow(deprecated)]
 use crate::os::linux::raw;
+use crate::os::raw::c_void;
 use crate::sys::AsInner;
+use crate::sys::fs::cfg_has_statx;
+cfg_has_statx! {{
+    use crate::sys::fs::{FileAttr, StatxExtraFields};
+    use crate::sys::FromInner;
+} else {
+    use crate::sys::unsupported;
+}}
 
 /// OS-specific extensions to [`fs::Metadata`].
 ///
@@ -41,6 +51,45 @@ pub trait MetadataExt {
     #[allow(deprecated)]
     fn as_raw_stat(&self) -> &raw::stat;
 
+    /// Creates a [`Metadata`] from a const void pointer populated by the [`statx`] syscall.
+    ///
+    /// # Safety
+    ///
+    /// The caller must take care to provide a valid const void pointer containing information
+    /// populated by the [`statx`] syscall.
+    ///
+    /// [`Metadata`]: crate::fs::Metadata
+    /// [`statx`]: https://docs.rs/libc/latest/libc/struct.statx.html
+    ///
+    /// ```no_run
+    /// #![feature(metadata_statx)]
+    /// use libc::statx;
+    /// use std::ffi::c_void;
+    /// use std::fs::{write, Metadata};
+    /// use std::io;
+    /// use std::os::linux::fs::MetadataExt;
+    ///
+    /// fn main() -> io::Result<()> {
+    ///     write("hello.txt", "Hello World!")?;
+    ///     let mut buf = Box::<statx>::new_uninit();
+    ///     unsafe {
+    ///         libc::statx(
+    ///             libc::AT_FDCWD,
+    ///             "hello.txt".as_ptr().cast(),
+    ///             libc::AT_STATX_SYNC_AS_STAT,
+    ///             libc::STATX_BASIC_STATS,
+    ///             buf.as_mut_ptr().cast()
+    ///         );
+    ///     }
+    ///     let statxbuf: Box<statx> = unsafe { buf.assume_init() };
+    ///     let metadata = unsafe { Metadata::from_statx(&*statxbuf as *const statx as *const c_void) };
+    ///     assert_eq!(metadata.len(), 12); // "Hello World!" is 12 bytes
+    ///     Ok(())
+    /// }
+    /// ```
+    #[unstable(feature = "metadata_statx", issue = "156268")]
+    unsafe fn from_statx(statxbuf: *const c_void) -> Self;
+
     /// Returns the device ID on which this file resides.
     ///
     /// # Examples
@@ -337,6 +386,39 @@ impl MetadataExt for Metadata {
             &*(self.as_inner().as_inner() as *const libc::stat64 as *const raw::stat)
         }
     }
+    cfg_has_statx! {{
+        unsafe fn from_statx(statxbuf: *const c_void) -> Metadata {
+            let buf =  statxbuf as *const libc::statx;
+
+            // We cannot fill `stat64` exhaustively because of private padding fields.
+            let mut stat: libc::stat64 = mem::zeroed();
+            // `c_ulong` on gnu-mips, `dev_t` otherwise
+            stat.st_dev = libc::makedev((*buf).stx_dev_major, (*buf).stx_dev_minor) as _;
+            stat.st_ino = (*buf).stx_ino as libc::ino64_t;
+            stat.st_nlink = (*buf).stx_nlink as libc::nlink_t;
+            stat.st_mode = (*buf).stx_mode as libc::mode_t;
+            stat.st_uid = (*buf).stx_uid as libc::uid_t;
+            stat.st_gid = (*buf).stx_gid as libc::gid_t;
+            stat.st_rdev = libc::makedev((*buf).stx_rdev_major, (*buf).stx_rdev_minor) as _;
+            stat.st_size = (*buf).stx_size as libc::off64_t;
+            stat.st_blksize = (*buf).stx_blksize as libc::blksize_t;
+            stat.st_blocks = (*buf).stx_blocks as libc::blkcnt64_t;
+            stat.st_atime = (*buf).stx_atime.tv_sec as libc::time_t;
+            // `i64` on gnu-x86_64-x32, `c_ulong` otherwise.
+            stat.st_atime_nsec = (*buf).stx_atime.tv_nsec as _;
+            stat.st_mtime = (*buf).stx_mtime.tv_sec as libc::time_t;
+            stat.st_mtime_nsec = (*buf).stx_mtime.tv_nsec as _;
+            stat.st_ctime = (*buf).stx_ctime.tv_sec as libc::time_t;
+            stat.st_ctime_nsec = (*buf).stx_ctime.tv_nsec as _;
+
+            let extra = StatxExtraFields::from_statx(statxbuf);
+
+            Metadata::from_inner(FileAttr::from_statx(stat, Some(extra)))
+        }} else {
+            unsafe fn from_statx(statxbuf: *const c_void) -> Self {
+                unsupported();
+            }
+    }}
     fn st_dev(&self) -> u64 {
         self.as_inner().as_inner().st_dev as u64
     }

library/std/src/sys/fs/mod.rs

@@ -18,6 +18,10 @@ cfg_select! {
         #[cfg(any(target_os = "linux", target_os = "android"))]
         pub(super) use unix::CachedFileMetadata;
         use crate::sys::helpers::run_path_with_cstr as with_native_path;
+        #[cfg(all(target_os = "linux", target_env = "gnu"))]
+        pub(crate) use unix::{
+            cfg_has_statx, StatxExtraFields
+        };
     }
     target_os = "windows" => {
         mod windows;

library/std/src/sys/fs/unix.rs

@@ -83,6 +83,9 @@ use crate::fmt::{self, Write as _};
 use crate::fs::TryLockError;
 use crate::io::{self, BorrowedCursor, Error, IoSlice, IoSliceMut, SeekFrom};
 use crate::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd};
+cfg_has_statx! {{
+    use crate::os::raw::c_void;
+} else {}}
 #[cfg(target_family = "unix")]
 use crate::os::unix::prelude::*;
 #[cfg(target_os = "wasi")]
@@ -125,6 +128,8 @@ macro_rules! cfg_has_statx {
     };
 }
 
+pub(crate) use cfg_has_statx;
+
 cfg_has_statx! {{
     #[derive(Clone)]
     pub struct FileAttr {
@@ -133,7 +138,7 @@ cfg_has_statx! {{
     }
 
     #[derive(Clone)]
-    struct StatxExtraFields {
+    pub struct StatxExtraFields {
         // This is needed to check if btime is supported by the filesystem.
         stx_mask: u32,
         stx_btime: libc::statx_timestamp,
@@ -525,11 +530,32 @@ pub struct DirBuilder {
 struct Mode(mode_t);
 
 cfg_has_statx! {{
+    impl StatxExtraFields {
+        pub unsafe fn from_statx(statxbuf: *const c_void) -> Self {
+            let buf =  statxbuf as *const libc::statx;
+
+            StatxExtraFields {
+                stx_mask: (*buf).stx_mask,
+                stx_btime: (*buf).stx_btime,
+                // Store full times to avoid 32-bit `time_t` truncation.
+                #[cfg(target_pointer_width = "32")]
+                stx_atime: (*buf).stx_atime,
+                #[cfg(target_pointer_width = "32")]
+                stx_ctime: (*buf).stx_ctime,
+                #[cfg(target_pointer_width = "32")]
+                stx_mtime: (*buf).stx_mtime,
+            }
+        }
+    }
     impl FileAttr {
         fn from_stat64(stat: stat64) -> Self {
             Self { stat, statx_extra_fields: None }
         }
 
+        pub fn from_statx(stat: stat64, extra: Option<StatxExtraFields>) -> Self {
+            Self {stat, statx_extra_fields: extra}
+        }
+
         #[cfg(target_pointer_width = "32")]
         pub fn stx_mtime(&self) -> Option<&libc::statx_timestamp> {
             if let Some(ext) = &self.statx_extra_fields {