use std::io;
use std::os::fd::{AsFd, OwnedFd};
use rustix::fs::{FlockOperation, Mode, OFlags};
pub const LOCK_FILE_NAME: &str = "lock";
#[derive(Debug)]
pub struct StateLock {
_fd: OwnedFd,
}
#[derive(Debug, thiserror::Error)]
pub enum LockError {
#[error("another Byssus process holds the state lock")]
Held,
#[error("cannot lock state directory: {0}")]
Io(#[from] io::Error),
}
impl StateLock {
pub fn acquire(state_dir: impl AsFd) -> Result<Self, LockError> {
let fd = rustix::fs::openat(
state_dir,
LOCK_FILE_NAME,
OFlags::RDWR | OFlags::CREATE | OFlags::CLOEXEC | OFlags::NOFOLLOW,
Mode::from_raw_mode(0o640),
)
.map_err(io::Error::from)?;
match rustix::fs::flock(&fd, FlockOperation::NonBlockingLockExclusive) {
Ok(()) => Ok(Self { _fd: fd }),
Err(rustix::io::Errno::WOULDBLOCK) => Err(LockError::Held),
Err(e) => Err(LockError::Io(e.into())),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
fn dir_fd(dir: &tempfile::TempDir) -> OwnedFd {
rustix::fs::open(
dir.path(),
OFlags::RDONLY | OFlags::DIRECTORY | OFlags::CLOEXEC,
Mode::empty(),
)
.unwrap()
}
#[test]
fn exclusive_and_released_on_drop() {
let dir = tempfile::tempdir().unwrap();
let fd = dir_fd(&dir);
let first = StateLock::acquire(&fd).unwrap();
assert!(matches!(StateLock::acquire(&fd), Err(LockError::Held)));
drop(first);
assert!(StateLock::acquire(&fd).is_ok());
}
#[test]
fn refuses_symlinked_lock_file() {
let dir = tempfile::tempdir().unwrap();
std::os::unix::fs::symlink("/etc/passwd", dir.path().join(LOCK_FILE_NAME)).unwrap();
let fd = dir_fd(&dir);
assert!(matches!(StateLock::acquire(&fd), Err(LockError::Io(_))));
}
}