RGBCube/uutils-coreutils
1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-07-28 11:37:44 +00:00
Code Issues Activity

Merge pull request #8017 from jtracey/sync-safety

Browse source 
sync: reduce use of unsafe and improve comments
This commit is contained in:
Sylvestre Ledru 2025-05-28 08:43:36 +02:00 • committed by GitHub
commit 15f606a12b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 50 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/uu/sync/Cargo.toml
View file

@ -22,7 +22,7 @@ clap = { workspace = true }
libc = { workspace = true }
uucore = { workspace = true, features = ["wide"] }
[target.'cfg(any(target_os = "linux", target_os = "android"))'.dependencies]
[target.'cfg(unix)'.dependencies]
nix = { workspace = true }
[target.'cfg(target_os = "windows")'.dependencies]

92
src/uu/sync/src/sync.rs
View file

@ -31,45 +31,32 @@ static ARG_FILES: &str = "files";
#[cfg(unix)]
mod platform {
use nix::unistd::sync;
#[cfg(any(target_os = "linux", target_os = "android"))]
use nix::unistd::{fdatasync, syncfs};
#[cfg(any(target_os = "linux", target_os = "android"))]
use std::fs::File;
#[cfg(any(target_os = "linux", target_os = "android"))]
use std::os::unix::io::AsRawFd;
use uucore::error::UResult;
/// # Safety
/// This function is unsafe because it calls `libc::sync` or `libc::syscall` which are unsafe.
pub unsafe fn do_sync() -> UResult<()> {
unsafe {
// see https://github.com/rust-lang/libc/pull/2161
#[cfg(target_os = "android")]
libc::syscall(libc::SYS_sync);
#[cfg(not(target_os = "android"))]
libc::sync();
pub fn do_sync() -> UResult<()> {
sync();
Ok(())
}
#[cfg(any(target_os = "linux", target_os = "android"))]
pub fn do_syncfs(files: Vec<String>) -> UResult<()> {
for path in files {
let f = File::open(path).unwrap();
syncfs(f)?;
}
Ok(())
}
#[cfg(any(target_os = "linux", target_os = "android"))]
/// # Safety
/// This function is unsafe because it calls `libc::syscall` which is unsafe.
pub unsafe fn do_syncfs(files: Vec<String>) -> UResult<()> {
pub fn do_fdatasync(files: Vec<String>) -> UResult<()> {
for path in files {
let f = File::open(path).unwrap();
let fd = f.as_raw_fd();
unsafe { libc::syscall(libc::SYS_syncfs, fd) };
}
Ok(())
}
#[cfg(any(target_os = "linux", target_os = "android"))]
/// # Safety
/// This function is unsafe because it calls `libc::syscall` which is unsafe.
pub unsafe fn do_fdatasync(files: Vec<String>) -> UResult<()> {
for path in files {
let f = File::open(path).unwrap();
let fd = f.as_raw_fd();
unsafe { libc::syscall(libc::SYS_fdatasync, fd) };
fdatasync(f)?;
}
Ok(())
}
@ -90,17 +77,22 @@ mod platform {
};
use windows_sys::Win32::System::WindowsProgramming::DRIVE_FIXED;
/// # Safety
/// This function is unsafe because it calls an unsafe function.
unsafe fn flush_volume(name: &str) -> UResult<()> {
fn get_last_error() -> u32 {
// SAFETY: GetLastError has no safety preconditions
unsafe { GetLastError() as u32 }
}
fn flush_volume(name: &str) -> UResult<()> {
let name_wide = name.to_wide_null();
// SAFETY: `name` is a valid `str`, so `name_wide` is valid null-terminated UTF-16
if unsafe { GetDriveTypeW(name_wide.as_ptr()) } == DRIVE_FIXED {
let sliced_name = &name[..name.len() - 1]; // eliminate trailing backslash
match OpenOptions::new().write(true).open(sliced_name) {
Ok(file) => {
// SAFETY: `file` is a valid `File`
if unsafe { FlushFileBuffers(file.as_raw_handle() as HANDLE) } == 0 {
Err(USimpleError::new(
unsafe { GetLastError() } as i32,
get_last_error() as i32,
"failed to flush file buffer",
))
} else {
@ -117,14 +109,13 @@ mod platform {
}
}
/// # Safety
/// This function is unsafe because it calls an unsafe function.
unsafe fn find_first_volume() -> UResult<(String, HANDLE)> {
fn find_first_volume() -> UResult<(String, HANDLE)> {
let mut name: [u16; MAX_PATH as usize] = [0; MAX_PATH as usize];
// SAFETY: `name` was just constructed and in scope, `len()` is its length by definition
let handle = unsafe { FindFirstVolumeW(name.as_mut_ptr(), name.len() as u32) };
if handle == INVALID_HANDLE_VALUE {
return Err(USimpleError::new(
unsafe { GetLastError() } as i32,
get_last_error() as i32,
"failed to find first volume",
));
}
@ -133,16 +124,19 @@ mod platform {
/// # Safety
/// This function is unsafe because it calls an unsafe function.
unsafe fn find_all_volumes() -> UResult<Vec<String>> {
let (first_volume, next_volume_handle) = unsafe { find_first_volume()? };
fn find_all_volumes() -> UResult<Vec<String>> {
let (first_volume, next_volume_handle) = find_first_volume()?;
let mut volumes = vec![first_volume];
loop {
let mut name: [u16; MAX_PATH as usize] = [0; MAX_PATH as usize];
// SAFETY: `next_volume_handle` was returned by `find_first_volume`,
// `name` was just constructed and in scope, `len()` is its length by definition
if unsafe { FindNextVolumeW(next_volume_handle, name.as_mut_ptr(), name.len() as u32) }
== 0
{
return match unsafe { GetLastError() } {
return match get_last_error() {
ERROR_NO_MORE_FILES => {
// SAFETY: next_volume_handle was returned by `find_first_volume`
unsafe { FindVolumeClose(next_volume_handle) };
Ok(volumes)
}
@ -154,21 +148,16 @@ mod platform {
}
}
/// # Safety
/// This function is unsafe because it calls `find_all_volumes` which is unsafe.
pub unsafe fn do_sync() -> UResult<()> {
let volumes = unsafe { find_all_volumes()? };
pub fn do_sync() -> UResult<()> {
let volumes = find_all_volumes()?;
for vol in &volumes {
unsafe { flush_volume(vol)? };
flush_volume(vol)?;
}
Ok(())
}
/// # Safety
/// This function is unsafe because it calls `find_all_volumes` which is unsafe.
pub unsafe fn do_syncfs(files: Vec<String>) -> UResult<()> {
pub fn do_syncfs(files: Vec<String>) -> UResult<()> {
for path in files {
unsafe {
flush_volume(
Path::new(&path)
.components()
@ -179,7 +168,6 @@ mod platform {
.unwrap(),
)?;
}
}
Ok(())
}
}
@ -263,15 +251,15 @@ pub fn uu_app() -> Command {
}
fn sync() -> UResult<()> {
unsafe { platform::do_sync() }
platform::do_sync()
}
#[cfg(any(target_os = "linux", target_os = "android", target_os = "windows"))]
fn syncfs(files: Vec<String>) -> UResult<()> {
unsafe { platform::do_syncfs(files) }
platform::do_syncfs(files)
}
#[cfg(any(target_os = "linux", target_os = "android"))]
fn fdatasync(files: Vec<String>) -> UResult<()> {
unsafe { platform::do_fdatasync(files) }
platform::do_fdatasync(files)
}