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_string
in /include/linux/ceph/string_table.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/string_table.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/include/linux/ceph/string_table.h b/include/linux/ceph/string_table.h
index a4a9962d1e14..ac75feb58007 100644
--- a/include/linux/ceph/string_table.h
+++ b/include/linux/ceph/string_table.h
@@ -7,13 +7,24 @@
#include <linux/rbtree.h>
#include <linux/rcupdate.h>
+/*
+ * Reference-counted string metadata: Interned string with automatic memory
+ * management and deduplication. Uses red-black tree for efficient lookup and
+ * RCU for safe concurrent access. Strings are immutable and shared across
+ * multiple users to reduce memory usage.
+ */
struct ceph_string {
+ /* Reference counting for automatic cleanup */
struct kref kref;
union {
+ /* Red-black tree node for string table lookup */
struct rb_node node;
+ /* RCU head for safe deferred cleanup */
struct rcu_head rcu;
};
+ /* Length of the string in bytes */
size_t len;
+ /* Variable-length string data (NUL-terminated) */
char str[];
};
--
2.51.0
