This is a note to let you know that I've just added the patch titled
NFSD: Flesh out a documenting comment for filecache.c
to the 6.1-stable tree which can be found at:
http://www.kernel.org/git/?p=linux/kernel/git/stable/stable-queue.git;a=summary
The filename of the patch is:
nfsd-flesh-out-a-documenting-comment-for-filecache.c.patch
and it can be found in the queue-6.1 subdirectory.
If you, or anyone else, feels it should not be added to the stable tree,
please let <stable@xxxxxxxxxxxxxxx> know about it.
>From 06d8447f0ae19330b1214367aa39fbd956dc4fee Mon Sep 17 00:00:00 2001
From: Chuck Lever <chuck.lever@xxxxxxxxxx>
Date: Tue, 1 Nov 2022 13:30:46 -0400
Subject: NFSD: Flesh out a documenting comment for filecache.c
From: Chuck Lever <chuck.lever@xxxxxxxxxx>
[ Upstream commit b3276c1f5b268ff56622e9e125b792b4c3dc03ac ]
Record what we've learned recently about the NFSD filecache in a
documenting comment so our future selves don't forget what all this
is for.
Signed-off-by: Chuck Lever <chuck.lever@xxxxxxxxxx>
Reviewed-by: Jeff Layton <jlayton@xxxxxxxxxx>
Signed-off-by: Chuck Lever <chuck.lever@xxxxxxxxxx>
Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
---
fs/nfsd/filecache.c | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
--- a/fs/nfsd/filecache.c
+++ b/fs/nfsd/filecache.c
@@ -2,6 +2,30 @@
* Open file cache.
*
* (c) 2015 - Jeff Layton <jeff.layton@xxxxxxxxxxxxxxx>
+ *
+ * An nfsd_file object is a per-file collection of open state that binds
+ * together:
+ * - a struct file *
+ * - a user credential
+ * - a network namespace
+ * - a read-ahead context
+ * - monitoring for writeback errors
+ *
+ * nfsd_file objects are reference-counted. Consumers acquire a new
+ * object via the nfsd_file_acquire API. They manage their interest in
+ * the acquired object, and hence the object's reference count, via
+ * nfsd_file_get and nfsd_file_put. There are two varieties of nfsd_file
+ * object:
+ *
+ * * non-garbage-collected: When a consumer wants to precisely control
+ * the lifetime of a file's open state, it acquires a non-garbage-
+ * collected nfsd_file. The final nfsd_file_put releases the open
+ * state immediately.
+ *
+ * * garbage-collected: When a consumer does not control the lifetime
+ * of open state, it acquires a garbage-collected nfsd_file. The
+ * final nfsd_file_put allows the open state to linger for a period
+ * during which it may be re-used.
*/
#include <linux/hash.h>
Patches currently in stable-queue which might be from chuck.lever@xxxxxxxxxx are
queue-6.1/nfsd-refactor-find_file.patch
queue-6.1/nfsd-register-unregister-of-nfsd-client-shrinker-at-nfsd-startup-shutdown-time.patch
queue-6.1/nfsd-refactoring-courtesy_client_reaper-to-a-generic-low-memory-shrinker.patch
queue-6.1/lockd-use-locks_inode_context-helper.patch
queue-6.1/nfsd-remove-redundant-assignment-to-variable-host_err.patch
queue-6.1/nfsd-use-set_bit-rq_dropme.patch
queue-6.1/nfsd-ignore-requests-to-disable-unsupported-versions.patch
queue-6.1/nfsd-fix-licensing-header-in-filecache.c.patch
queue-6.1/nfsd-add-delegation-reaper-to-react-to-low-memory-condition.patch
queue-6.1/nfsd-trace-stateids-returned-via-delegreturn.patch
queue-6.1/lockd-ensure-we-use-the-correct-file-descriptor-when-unlocking.patch
queue-6.1/trace-relocate-event-helper-files.patch
queue-6.1/nfsd-update-file_hashtbl-helpers.patch
queue-6.1/nfsd-clean-up-nfs4_preprocess_stateid_op-call-sites.patch
queue-6.1/nfsd-don-t-destroy-global-nfs4_file-table-in-per-net-shutdown.patch
queue-6.1/nfsd-use-only-rq_dropme-to-signal-the-need-to-drop-a-reply.patch
queue-6.1/nfsd-use-locks_inode_context-helper.patch
queue-6.1/nfsd-use-struct_size-helper-in-alloc_session.patch
queue-6.1/nfsd-fix-up-the-filecache-laundrette-scheduling.patch
queue-6.1/nfsd-move-nfserrno-to-vfs.c.patch
queue-6.1/exportfs-use-pr_debug-for-unreachable-debug-statements.patch
queue-6.1/nfsd-use-const-pointers-as-parameters-to-fh_-helpers.patch
queue-6.1/nfsd-use-rhashtable-for-managing-nfs4_file-objects.patch
queue-6.1/nfsd-clean-up-nfsd4_init_file.patch
queue-6.1/nfsd-add-a-nfsd4_file_hash_remove-helper.patch
queue-6.1/nfsd-simplify-read_plus.patch
queue-6.1/nfsd-trace-delegation-revocations.patch
queue-6.1/nfsd-allow-disabling-nfsv2-at-compile-time.patch
queue-6.1/nfsd-flesh-out-a-documenting-comment-for-filecache.c.patch
queue-6.1/nfsd-replace-delayed_work-with-work_struct-for-nfsd_client_shrinker.patch
queue-6.1/lockd-set-missing-fl_flags-field-when-retrieving-args.patch
queue-6.1/filelock-add-a-new-locks_inode_context-accessor-function.patch
queue-6.1/nfsd-add-support-for-sending-cb_recall_any.patch
queue-6.1/lockd-fix-file-selection-in-nlmsvc_cancel_blocked.patch
queue-6.1/nfsd-add-cb_recall_any-tracepoints.patch
queue-6.1/nfsd-avoid-clashing-function-prototypes.patch
queue-6.1/nfsd-clean-up-find_or_add_file.patch
