Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

passthrough: open file with O_APPEND cleared when writeback is enabled #95

Merged
merged 1 commit into from
Sep 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions src/passthrough/async_io.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,17 +148,7 @@ impl<S: BitmapSlice + Send + Sync> PassthroughFs<S> {
inode: Inode,
mut flags: i32,
) -> io::Result<File> {
let mut new_flags = self.get_writeback_open_flags(flags);

// When writeback caching is enabled the kernel is responsible for handling `O_APPEND`.
// However, this breaks atomicity as the file may have changed on disk, invalidating the
// cached copy of the data in the kernel and the offset that the kernel thinks is the end of
// the file. Just allow this for now as it is the user's responsibility to enable writeback
// caching only for directories that are not shared. It also means that we need to clear the
// `O_APPEND` flag.
if self.writeback.load(Ordering::Relaxed) && flags & libc::O_APPEND != 0 {
new_flags &= !libc::O_APPEND;
}
let new_flags = self.get_writeback_open_flags(flags);

let data = self.inode_map.get(inode)?;
let file = data.async_get_file(&self.mount_fds).await?;
Expand Down
48 changes: 44 additions & 4 deletions src/passthrough/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1060,16 +1060,28 @@ impl<S: BitmapSlice + Send + Sync> PassthroughFs<S> {
}
}

// When writeback caching is enabled, the kernel may send read requests even if the userspace
// program opened the file write-only. So we need to ensure that we have opened the file for
// reading as well as writing.
fn get_writeback_open_flags(&self, flags: i32) -> i32 {
let mut new_flags = flags;
let writeback = self.writeback.load(Ordering::Relaxed);

// When writeback caching is enabled, the kernel may send read requests even if the
// userspace program opened the file write-only. So we need to ensure that we have opened
// the file for reading as well as writing.
if writeback && flags & libc::O_ACCMODE == libc::O_WRONLY {
new_flags &= !libc::O_ACCMODE;
new_flags |= libc::O_RDWR;
}

// When writeback caching is enabled the kernel is responsible for handling `O_APPEND`.
// However, this breaks atomicity as the file may have changed on disk, invalidating the
// cached copy of the data in the kernel and the offset that the kernel thinks is the end of
// the file. Just allow this for now as it is the user's responsibility to enable writeback
// caching only for directories that are not shared. It also means that we need to clear the
// `O_APPEND` flag.
if writeback && flags & libc::O_APPEND != 0 {
new_flags &= !libc::O_APPEND;
}

new_flags
}
}
Expand Down Expand Up @@ -1356,7 +1368,8 @@ mod tests {
#[test]
fn test_get_writeback_open_flags() {
// prepare a fs with writeback cache and open being true, so O_WRONLY should be promoted to
// O_RDWR, as writeback may read files even if file being opened with write-only.
// O_RDWR, as writeback may read files even if file being opened with write-only. And
// O_APPEND should be cleared as well.
let mut fs = prepare_passthroughfs();
fs.writeback = AtomicBool::new(true);
fs.no_open = AtomicBool::new(false);
Expand All @@ -1373,6 +1386,15 @@ mod tests {
let flags = libc::O_WRONLY;
assert_eq!(fs.get_writeback_open_flags(flags), libc::O_RDWR);

let flags = libc::O_RDWR | libc::O_APPEND;
assert_eq!(fs.get_writeback_open_flags(flags), libc::O_RDWR);

let flags = libc::O_RDONLY | libc::O_APPEND;
assert_eq!(fs.get_writeback_open_flags(flags), libc::O_RDONLY);

let flags = libc::O_WRONLY | libc::O_APPEND;
assert_eq!(fs.get_writeback_open_flags(flags), libc::O_RDWR);

// prepare a fs with writeback cache disabled, open flags should not change
let mut fs = prepare_passthroughfs();
fs.writeback = AtomicBool::new(false);
Expand All @@ -1389,6 +1411,24 @@ mod tests {

let flags = libc::O_WRONLY;
assert_eq!(fs.get_writeback_open_flags(flags), libc::O_WRONLY);

let flags = libc::O_RDWR | libc::O_APPEND;
assert_eq!(
fs.get_writeback_open_flags(flags),
libc::O_RDWR | libc::O_APPEND
);

let flags = libc::O_RDONLY | libc::O_APPEND;
assert_eq!(
fs.get_writeback_open_flags(flags),
libc::O_RDONLY | libc::O_APPEND
);

let flags = libc::O_WRONLY | libc::O_APPEND;
assert_eq!(
fs.get_writeback_open_flags(flags),
libc::O_WRONLY | libc::O_APPEND
);
}

#[test]
Expand Down
12 changes: 1 addition & 11 deletions src/passthrough/sync_io.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,7 @@ use crate::transport::FsCacheReqHandler;

impl<S: BitmapSlice + Send + Sync> PassthroughFs<S> {
fn open_inode(&self, inode: Inode, flags: i32) -> io::Result<File> {
let mut new_flags = self.get_writeback_open_flags(flags);

// When writeback caching is enabled the kernel is responsible for handling `O_APPEND`.
// However, this breaks atomicity as the file may have changed on disk, invalidating the
// cached copy of the data in the kernel and the offset that the kernel thinks is the end of
// the file. Just allow this for now as it is the user's responsibility to enable writeback
// caching only for directories that are not shared. It also means that we need to clear the
// `O_APPEND` flag.
if self.writeback.load(Ordering::Relaxed) && flags & libc::O_APPEND != 0 {
new_flags &= !libc::O_APPEND;
}
let new_flags = self.get_writeback_open_flags(flags);

let data = self.inode_map.get(inode)?;
let file = data.get_file(&self.mount_fds)?;
Expand Down