From: Viacheslav Dubeyko <Slava.Dubeyko@xxxxxxx>
We have a lot of declarations and not enough good
comments on it.
Claude AI generated comments for CephFS metadata structure
declarations in include/linux/ceph/*.h. These comments
have been reviewed, checked, and corrected.
This patch adds comments for struct ceph_vino,
struct ceph_cap_reservation in /include/linux/ceph/types.h.
Signed-off-by: Viacheslav Dubeyko <Slava.Dubeyko@xxxxxxx>
cc: Alex Markuze <amarkuze@xxxxxxxxxx>
cc: Ilya Dryomov <idryomov@xxxxxxxxx>
cc: Ceph Development <ceph-devel@xxxxxxxxxxxxxxx>
---
include/linux/ceph/types.h | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/include/linux/ceph/types.h b/include/linux/ceph/types.h
index bd3d532902d7..beda96d2c872 100644
--- a/include/linux/ceph/types.h
+++ b/include/linux/ceph/types.h
@@ -13,17 +13,27 @@
#include <linux/ceph/ceph_hash.h>
/*
- * Identify inodes by both their ino AND snapshot id (a u64).
+ * Virtual inode identifier metadata: Uniquely identifies an inode within
+ * the CephFS namespace by combining the inode number with a snapshot ID.
+ * This allows the same inode to exist in multiple snapshots simultaneously.
*/
struct ceph_vino {
+ /* Inode number within the filesystem */
u64 ino;
+ /* Snapshot ID (CEPH_NOSNAP for head/live version) */
u64 snap;
};
-/* context for the caps reservation mechanism */
+/*
+ * Capability reservation context metadata: Tracks reserved capabilities
+ * for atomic operations that require multiple caps. Prevents deadlocks
+ * by pre-reserving the required capabilities before starting operations.
+ */
struct ceph_cap_reservation {
+ /* Total number of capabilities reserved */
int count;
+ /* Number of reserved capabilities already consumed */
int used;
};
--
2.51.0
