fuse: fix race between inode/dentry invalidation and readdir
Subsystems (2)
PATCH 1/1 fuse: fix race between inode/dentry invalidation and readdir
When there's a readdir in progress, doing a FUSE_NOTIFY_INVAL_{INODE,ENTRY} on an inode or dentry may result in stale directory info being cached. This is because the invalidation does not reset the readdir cache.
This patch fixes this issue by adding a call to fuse_rdc_reset() (modified to include the required locking) to these two operations, allowing the readdir cache to be invalidated while it's being filled-in.
--- fs/fuse/dir.c | 5 +++-- fs/fuse/fuse_i.h | 13 +++++++++++++ fs/fuse/inode.c | 1 + fs/fuse/readdir.c | 6 +++--- 4 files changed, 20 insertions(+), 5 deletions(-)
fs/fuse/dir.c +3 -2
@@ -1615,6 +1615,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,if (!(flags &FUSE_EXPIRE_ONLY ))d_invalidate (entry);fuse_invalidate_entry_cache (entry); +fuse_rdc_reset (entry->d_inode);if (child_nodeid !=0 ) {inode_lock (d_inode (entry));
@@ -1637,7 +1638,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,dont_mount (entry);clear_nlink (d_inode (entry)); err =0 ; - badentry: +badentry:inode_unlock (d_inode (entry));if (!err)d_delete (entry);
@@ -1646,7 +1647,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid, }end_removing (entry); - put_parent: +put_parent:dput (dir);iput (parent);return err;
fs/fuse/fuse_i.h +13 -0
@@ -1494,6 +1494,19 @@ int fuse_set_acl(struct mnt_idmap *, struct dentry *dentry,/* readdir.c */ int fuse_readdir (struct file *file,struct dir_context *ctx); +void __fuse_rdc_reset (struct inode *inode); + +static inline void fuse_rdc_reset (struct inode *inode) +{ +struct fuse_inode *fi; + +if (S_ISDIR (inode->i_mode)) { + fi =get_fuse_inode (inode); +spin_lock (&fi->rdc.lock); +__fuse_rdc_reset (inode); +spin_unlock (&fi->rdc.lock); + } +}/** * Return the number of bytes in an arguments list
fs/fuse/inode.c +1 -0
@@ -570,6 +570,7 @@ int fuse_reverse_inval_inode(struct fuse_conn *fc, u64 nodeid, fi->attr_version =atomic64_inc_return (&fc->attr_version);spin_unlock (&fi->lock); +fuse_rdc_reset (inode);fuse_invalidate_attr (inode);forget_all_cached_acls (inode);if (offset >=0 ) {
fs/fuse/readdir.c +3 -3
@@ -430,7 +430,7 @@ static enum fuse_parse_result fuse_parse_cache(struct fuse_file *ff,return res; } -static void fuse_rdc_reset (struct inode *inode) +void __fuse_rdc_reset (struct inode *inode) {struct fuse_inode *fi =get_fuse_inode (inode);
@@ -493,7 +493,7 @@ static int fuse_readdir_cached(struct file *file, struct dir_context *ctx)if (inode_peek_iversion (inode) != fi->rdc.iversion || !timespec64_equal (&fi->rdc.mtime, &mtime)) { -fuse_rdc_reset (inode); +__fuse_rdc_reset (inode); goto retry_locked; } }
@@ -541,7 +541,7 @@ static int fuse_readdir_cached(struct file *file, struct dir_context *ctx)* Uh-oh: page gone missing, cache is useless */ if (fi->rdc.version == ff->readdir.version) -fuse_rdc_reset (inode); +__fuse_rdc_reset (inode); goto retry_locked; }
Quoted 8 lines · Luis Henriques
When there's a readdir in progress, doing a FUSE_NOTIFY_INVAL_{INODE,ENTRY} on an inode or dentry may result in stale directory info being cached. This is because the invalidation does not reset the readdir cache.
This patch fixes this issue by adding a call to
fuse_rdc_reset()(modified to include the required locking) to these two operations, allowing the readdir cache to be invalidated while it's being filled-in.
Hi Luis,
Just curious, are you hitting this issue in practice or is this mostly theoretical?
afaict for fuse_notify_inval_entry(), it calls into fuse_reverse_inval_entry() -> fuse_dir_changed(parent), which calls inode_maybe_inc_iversion(). afaict, this actually increments i_version (since I_VERSION_QUERIED flag was set when the cache's iversion was initialized with inode_query_iversion() in fuse_readdir_cached()), which means the next readdir call will detect this version change and call fuse_rdc_reset() (in fuse_readdir_cached()). I'm not sure I see how this leads to stale directory info lingering in the cache after a concurrent fuse_notify_inval_entry()?
For teh fuse_notify_inval_inode() case, which I'm assuming is the case you're running into where the directory is the inode being invalidated, I see the call to fuse_reverse_inval_inode() which calls invalidate_inode_pages2_range() if the offset was non-negative, which will invalidate the readdir cache's pages, which means on the next readdir call, will already call fuse_rdc_reset() when it detects the missing page in the cache (in fuse_readdir_cached()). So I'm not really seeing how this can happen either for the fuse_notify_inval_inode() case? Unless you are passing a negative offset, but as I understand it, passing a negative offset is used only if the server wants attributes invalidated [1], not any data.
afaics, the onlyy stale directory info returned would be for the case for a concurrent readdir that has already passed the pos == 0 iversion/mtime check when the invalidation arrives, but that seems like a server synchronization issue, eg if the server wants uptodate data when doing a concurrent readdir and invalidation, they have to order that themselves. ANy fresh lookup after that though, I think wouldalways return fresh/non-stale data for the reasons mentioned above.
Does this align with what you're seeing in the code or am I missing something here?
Quoted 15 lines
Assisted-by Claude:claude-opus-4-5Signed-off-by Luis Henriques <[email protected]>--- fs/fuse/dir.c | 5 +++-- fs/fuse/fuse_i.h | 13 +++++++++++++ fs/fuse/inode.c | 1 + fs/fuse/readdir.c | 6 +++--- 4 files changed, 20 insertions(+), 5 deletions(-)fs/fuse/dir.c +0
-0
fs/fuse/dir.c int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid, · line 1618
Quoted 4 lines
fs/fuse/dir.c +1
-0@@ -1615,6 +1615,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,if (!(flags &FUSE_EXPIRE_ONLY ))d_invalidate (entry);fuse_invalidate_entry_cache (entry); +fuse_rdc_reset (entry->d_inode);
Hmm... I think this resets the child's readdir cache but it's the parent's readdir cache that would have to be invalidated, so would this have to be fuse_rdc_reset(parent)?
Thanks,
Joanne
[1] https://libfuse.github.io/doxygen/fuse__lowlevel_8h.html#a9cb974af9745294ff446d11cba2422f1
Quoted 12 lines
fs/fuse/dir.c +1
-1if (child_nodeid !=0 ) {inode_lock (d_inode (entry));@@ -1637,7 +1638,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,dont_mount (entry);clear_nlink (d_inode (entry)); err =0 ; - badentry: +badentry:inode_unlock (d_inode (entry));if (!err)d_delete (entry);
Hi Joanne!
Quoted 46 lines · Joanne Koong
Quoted 8 lines · Luis Henriques
When there's a readdir in progress, doing a FUSE_NOTIFY_INVAL_{INODE,ENTRY} on an inode or dentry may result in stale directory info being cached. This is because the invalidation does not reset the readdir cache.
This patch fixes this issue by adding a call to
fuse_rdc_reset()(modified to include the required locking) to these two operations, allowing the readdir cache to be invalidated while it's being filled-in.Hi Luis,
Just curious, are you hitting this issue in practice or is this mostly theoretical?
afaict for
fuse_notify_inval_entry(), it calls intofuse_reverse_inval_entry()->fuse_dir_changed(parent), which callsinode_maybe_inc_iversion(). afaict, this actually incrementsi_version(sinceI_VERSION_QUERIEDflag was set when the cache's iversion was initialized withinode_query_iversion()infuse_readdir_cached()), which means the next readdir call will detect this version change and callfuse_rdc_reset()(infuse_readdir_cached()). I'm not sure I see how this leads to stale directory info lingering in the cache after a concurrentfuse_notify_inval_entry()?For teh
fuse_notify_inval_inode()case, which I'm assuming is the case you're running into where the directory is the inode being invalidated, I see the call tofuse_reverse_inval_inode()which callsinvalidate_inode_pages2_range()if the offset was non-negative, which will invalidate the readdir cache's pages, which means on the next readdir call, will already callfuse_rdc_reset()when it detects the missing page in the cache (infuse_readdir_cached()). So I'm not really seeing how this can happen either for thefuse_notify_inval_inode()case? Unless you are passing a negative offset, but as I understand it, passing a negative offset is used only if the server wants attributes invalidated [1], not any data.afaics, the onlyy stale directory info returned would be for the case for a concurrent readdir that has already passed the pos == 0 iversion/mtime check when the invalidation arrives, but that seems like a server synchronization issue, eg if the server wants uptodate data when doing a concurrent readdir and invalidation, they have to order that themselves. ANy fresh lookup after that though, I think wouldalways return fresh/non-stale data for the reasons mentioned above.
Quoted 2 lines
Does this align with what you're seeing in the code or am I missing something here?
First of all, thanks a lot for looking into this and for doing such a great description of the issue.
So, I did had a report regarding a possible race between a readdir and invalidation when using keep_cache and cache_readdir. But, unfortunately, I don't have a lot of information regarding the actual issue, and it isn't something reproducible.
Then, looking at the code (and, for full-disclosure, I've also looked at a claude analysis that was handed over to me) I could see a race that I'm trying to fix with this patch. But I believe it's the race that you claim above that it's a server synchronisation problem. For example, with a NOTIFY_INVAL_INODE operation, when fuse_reverse_inval_inode() is called while fuse_add_dirent_to_cache() is being executed in parallel, the iversion/mtime update could be missed.
It is possible to hit this small race by instrumenting the code, and I could occasionally (and momentarily) see stale data while running readdir in such instrumented testing environment. Do you think that's something inherent to the usage of the INVAL_INODE op, and this race will need to be handled by user-space?
In fact, the report I got seemed to indicate that the issue was not going away with a fresh lookup (though an 'echo 1 > /proc/sys/vm/drop_cache' would fix it). But maybe that's another indication that this is a problem in the user-space server.
Cheers,
Signature · 1 line
Luís
Quoted 42 lines
Quoted 16 lines
Assisted-by Claude:claude-opus-4-5Signed-off-by Luis Henriques <[email protected]>--- fs/fuse/dir.c | 5 +++-- fs/fuse/fuse_i.h | 13 +++++++++++++ fs/fuse/inode.c | 1 + fs/fuse/readdir.c | 6 +++--- 4 files changed, 20 insertions(+), 5 deletions(-)fs/fuse/dir.c +0
-0fs/fuse/dir.c int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid, · line 1618
Quoted 4 lines
fs/fuse/dir.c +1
-0@@ -1615,6 +1615,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,if (!(flags &FUSE_EXPIRE_ONLY ))d_invalidate (entry);fuse_invalidate_entry_cache (entry); +fuse_rdc_reset (entry->d_inode);Hmm... I think this resets the child's readdir cache but it's the parent's readdir cache that would have to be invalidated, so would this have to be
fuse_rdc_reset(parent)?Thanks,
Joanne[1] https://libfuse.github.io/doxygen/fuse__lowlevel_8h.html#a9cb974af9745294ff446d11cba2422f1
Quoted 12 lines
fs/fuse/dir.c +1
-1if (child_nodeid !=0 ) {inode_lock (d_inode (entry));@@ -1637,7 +1638,7 @@ int fuse_reverse_inval_entry(struct fuse_conn *fc, u64 parent_nodeid,dont_mount (entry);clear_nlink (d_inode (entry)); err =0 ; - badentry: +badentry:inode_unlock (d_inode (entry));if (!err)d_delete (entry);
Quoted 53 lines · Luis Henriques
Hi Joanne!
Quoted 48 lines · Joanne Koong
Quoted 8 lines · Luis Henriques
When there's a readdir in progress, doing a FUSE_NOTIFY_INVAL_{INODE,ENTRY} on an inode or dentry may result in stale directory info being cached. This is because the invalidation does not reset the readdir cache.
This patch fixes this issue by adding a call to
fuse_rdc_reset()(modified to include the required locking) to these two operations, allowing the readdir cache to be invalidated while it's being filled-in.Hi Luis,
Just curious, are you hitting this issue in practice or is this mostly theoretical?
afaict for
fuse_notify_inval_entry(), it calls intofuse_reverse_inval_entry()->fuse_dir_changed(parent), which callsinode_maybe_inc_iversion(). afaict, this actually incrementsi_version(sinceI_VERSION_QUERIEDflag was set when the cache's iversion was initialized withinode_query_iversion()infuse_readdir_cached()), which means the next readdir call will detect this version change and callfuse_rdc_reset()(infuse_readdir_cached()). I'm not sure I see how this leads to stale directory info lingering in the cache after a concurrentfuse_notify_inval_entry()?For teh
fuse_notify_inval_inode()case, which I'm assuming is the case you're running into where the directory is the inode being invalidated, I see the call tofuse_reverse_inval_inode()which callsinvalidate_inode_pages2_range()if the offset was non-negative, which will invalidate the readdir cache's pages, which means on the next readdir call, will already callfuse_rdc_reset()when it detects the missing page in the cache (infuse_readdir_cached()). So I'm not really seeing how this can happen either for thefuse_notify_inval_inode()case? Unless you are passing a negative offset, but as I understand it, passing a negative offset is used only if the server wants attributes invalidated [1], not any data.afaics, the onlyy stale directory info returned would be for the case for a concurrent readdir that has already passed the pos == 0 iversion/mtime check when the invalidation arrives, but that seems like a server synchronization issue, eg if the server wants uptodate data when doing a concurrent readdir and invalidation, they have to order that themselves. ANy fresh lookup after that though, I think wouldalways return fresh/non-stale data for the reasons mentioned above.
Does this align with what you're seeing in the code or am I missing something here?
Hi Luis,
Quoted 17 lines
First of all, thanks a lot for looking into this and for doing such a great description of the issue.
So, I did had a report regarding a possible race between a readdir and invalidation when using
keep_cacheandcache_readdir. But, unfortunately, I don't have a lot of information regarding the actual issue, and it isn't something reproducible.Then, looking at the code (and, for full-disclosure, I've also looked at a claude analysis that was handed over to me) I could see a race that I'm trying to fix with this patch. But I believe it's the race that you claim above that it's a server synchronisation problem. For example, with a
NOTIFY_INVAL_INODEoperation, whenfuse_reverse_inval_inode()is called whilefuse_add_dirent_to_cache()is being executed in parallel, the iversion/mtime update could be missed.
Quoted 5 lines
It is possible to hit this small race by instrumenting the code, and I could occasionally (and momentarily) see stale data while running readdir in such instrumented testing environment. Do you think that's something inherent to the usage of the
INVAL_INODEop, and this race will need to be handled by user-space?
imo yes, that is not a bug in the kernel and userspace is responsible for synchronizing/coordinating that. I think the kernel is just responsible for ensuring that any subsequent readdirs are not stale, but afaict the existing code handles that.
Quoted 5 lines
In fact, the report I got seemed to indicate that the issue was not going away with a fresh lookup (though an 'echo 1 >
/proc/sys/vm/drop_cache' would fix it). But maybe that's another indication that this is a problem in the user-space server.
that seems weird to me, maybe there's something else at play here in addition to the concurrent race? Is there a repro for where the stale data survives a fresh lookup?
Thanks,
Joanne
Quoted 5 lines
Cheers,
--
Luís
Quoted 80 lines · Joanne Koong
Quoted 53 lines · Luis Henriques
Hi Joanne!
Quoted 48 lines · Joanne Koong
Quoted 8 lines · Luis Henriques
When there's a readdir in progress, doing a FUSE_NOTIFY_INVAL_{INODE,ENTRY} on an inode or dentry may result in stale directory info being cached. This is because the invalidation does not reset the readdir cache.
This patch fixes this issue by adding a call to
fuse_rdc_reset()(modified to include the required locking) to these two operations, allowing the readdir cache to be invalidated while it's being filled-in.Hi Luis,
Just curious, are you hitting this issue in practice or is this mostly theoretical?
afaict for
fuse_notify_inval_entry(), it calls intofuse_reverse_inval_entry()->fuse_dir_changed(parent), which callsinode_maybe_inc_iversion(). afaict, this actually incrementsi_version(sinceI_VERSION_QUERIEDflag was set when the cache's iversion was initialized withinode_query_iversion()infuse_readdir_cached()), which means the next readdir call will detect this version change and callfuse_rdc_reset()(infuse_readdir_cached()). I'm not sure I see how this leads to stale directory info lingering in the cache after a concurrentfuse_notify_inval_entry()?For teh
fuse_notify_inval_inode()case, which I'm assuming is the case you're running into where the directory is the inode being invalidated, I see the call tofuse_reverse_inval_inode()which callsinvalidate_inode_pages2_range()if the offset was non-negative, which will invalidate the readdir cache's pages, which means on the next readdir call, will already callfuse_rdc_reset()when it detects the missing page in the cache (infuse_readdir_cached()). So I'm not really seeing how this can happen either for thefuse_notify_inval_inode()case? Unless you are passing a negative offset, but as I understand it, passing a negative offset is used only if the server wants attributes invalidated [1], not any data.afaics, the onlyy stale directory info returned would be for the case for a concurrent readdir that has already passed the pos == 0 iversion/mtime check when the invalidation arrives, but that seems like a server synchronization issue, eg if the server wants uptodate data when doing a concurrent readdir and invalidation, they have to order that themselves. ANy fresh lookup after that though, I think wouldalways return fresh/non-stale data for the reasons mentioned above.
Does this align with what you're seeing in the code or am I missing something here?
Hi Luis,
Quoted 17 lines
First of all, thanks a lot for looking into this and for doing such a great description of the issue.
So, I did had a report regarding a possible race between a readdir and invalidation when using
keep_cacheandcache_readdir. But, unfortunately, I don't have a lot of information regarding the actual issue, and it isn't something reproducible.Then, looking at the code (and, for full-disclosure, I've also looked at a claude analysis that was handed over to me) I could see a race that I'm trying to fix with this patch. But I believe it's the race that you claim above that it's a server synchronisation problem. For example, with a
NOTIFY_INVAL_INODEoperation, whenfuse_reverse_inval_inode()is called whilefuse_add_dirent_to_cache()is being executed in parallel, the iversion/mtime update could be missed.Quoted 5 lines
It is possible to hit this small race by instrumenting the code, and I could occasionally (and momentarily) see stale data while running readdir in such instrumented testing environment. Do you think that's something inherent to the usage of the
INVAL_INODEop, and this race will need to be handled by user-space?
Quoted 4 lines
imo yes, that is not a bug in the kernel and userspace is responsible for synchronizing/coordinating that. I think the kernel is just responsible for ensuring that any subsequent readdirs are not stale, but afaict the existing code handles that.
Ack, thanks.
Quoted 8 lines
Quoted 4 lines
In fact, the report I got seemed to indicate that the issue was not going away with a fresh lookup (though an 'echo 1 >
/proc/sys/vm/drop_cache' would fix it). But maybe that's another indication that this is a problem in the user-space server.that seems weird to me, maybe there's something else at play here in addition to the concurrent race? Is there a repro for where the stale data survives a fresh lookup?
Unfortunately no, I do not have any reproducer. And from looking at the code I couldn't find anything else. I'll have to look closer into the user-space code doing the invalidation to try to understand what else could be at play here. And again, thank you for your feedback, Joanne.
Cheers,
Signature · 1 line
Luís