fs icon indicating copy to clipboard operation
fs copied to clipboard

NFS caching causes `file_exists()` to return wrong result

Open epruesse opened this issue 1 year ago • 1 comments

The file_exists() method relies on stat() to determine whether or not a file exists. Since stat() is subject to the NFS attribute cache, this information can easily be a full minute out of date. A more appropriate file existence test might be a call to open() followed by an immediate close(). This is not cached. Notably, the open()/close() sequence also flushes the NFS cache, making a subsequent call to access() (fs::file_access()) or stat() (fs::file_info()) yield fresh results.

I would propose to change file_exists() to the open/close pattern, as here caching is both unexpected (other implementations use open/close to detect file presence) and not usually performance relevant. At least, I can't think of many scenarios where a API user would check for the existence of a million files. With file_access() and file_info() the situation is different, it is more obvious that this is meta data that may get cached (on NFS specifically) and these are more likely to be called on large input vectors or many times. The rest can be docs, and file_exists can also double as cache flush. Also, this is much less code change than an extra flag to all the functions and a dedicated cache flush function.

(Happy to do PR to this effect if desired)

epruesse avatar Jun 07 '24 00:06 epruesse

I am sorry for the late response.

I assume that open() + close() is much (?) more costly than stat(), especially if the latter is cached. So it does not seem like a good idea to have the former as the default. Maybe we could have another implementation, selected by an optional argument.

Personally I am not sure if this is worth it, because file_exists() is a race condition by definition, anyway. But if it is still important for you, I'll be happy to review a PR.

gaborcsardi avatar Apr 25 '25 11:04 gaborcsardi