lkml.org 
[lkml]   [2022]   [Aug]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH] Doc fix for dget_dlock and dget
dcache header:

1. Remove a warning for dget_dlock

2. Add a similar comment for dget and
mention the difference between dget and dget_dlock
as suggested by Mr. Randy Dunlap
Link: https://lore.kernel.org/all/29708eb3-ff1e-411e-cf84-7aa9af765603@infradead.org/

Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
---
include/linux/dcache.h | 24 +++++++++++++++++++-----
1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/include/linux/dcache.h b/include/linux/dcache.h
index 92c78ed02..aa473b6bf 100644
--- a/include/linux/dcache.h
+++ b/include/linux/dcache.h
@@ -299,12 +299,15 @@ extern char *dentry_path(const struct dentry *, char *, int);
/* Allocation counts.. */

/**
- * dget, dget_dlock - get a reference to a dentry
- * @dentry: dentry to get a reference to
+ * dget_dlock - get a reference to a dentry
+ * @dentry: dentry to get a reference to
*
- * Given a dentry or %NULL pointer increment the reference count
- * if appropriate and return the dentry. A dentry will not be
- * destroyed when it has references.
+ * Given a dentry or %NULL pointer increment the reference count
+ * if appropriate and return the dentry. A dentry will not be
+ * destroyed when it has references.
+ *
+ * The reference count increment in this function is not atomic.
+ * Consider dget() if atomicity is required.
*/
static inline struct dentry *dget_dlock(struct dentry *dentry)
{
@@ -313,6 +316,17 @@ static inline struct dentry *dget_dlock(struct dentry *dentry)
return dentry;
}

+/**
+ * dget - get a reference to a dentry
+ * @dentry: dentry to get a reference to
+ *
+ * Given a dentry or %NULL pointer increment the reference count
+ * if appropriate and return the dentry. A dentry will not be
+ * destroyed when it has references.
+ *
+ * This function atomically increments the reference count.
+ * Consider dget_dlock() if atomicity is not required or manually managed.
+ */
static inline struct dentry *dget(struct dentry *dentry)
{
if (dentry)
--
2.35.1
\
 
 \ /
  Last update: 2022-08-13 10:22    [W:0.028 / U:1.244 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site