]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
VFS: introduce start_removing_dentry()
authorNeilBrown <neil@brown.name>
Thu, 13 Nov 2025 00:18:31 +0000 (11:18 +1100)
committerChristian Brauner <brauner@kernel.org>
Fri, 14 Nov 2025 12:15:57 +0000 (13:15 +0100)
start_removing_dentry() is similar to start_removing() but instead of
providing a name for lookup, the target dentry is given.

start_removing_dentry() checks that the dentry is still hashed and in
the parent, and if so it locks and increases the refcount so that
end_removing() can be used to finish the operation.

This is used in cachefiles, overlayfs, smb/server, and apparmor.

There will be other users including ecryptfs.

As start_removing_dentry() takes an extra reference to the dentry (to be
put by end_removing()), there is no need to explicitly take an extra
reference to stop d_delete() from using dentry_unlink_inode() to negate
the dentry - as in cachefiles_delete_object(), and ksmbd_vfs_unlink().

cachefiles_bury_object() now gets an extra ref to the victim, which is
drops.  As it includes the needed end_removing() calls, the caller
doesn't need them.

Reviewed-by: Amir Goldstein <amir73il@gmail.com>
Reviewed-by: Namjae Jeon <linkinjeon@kernel.org>
Reviewed-by: Jeff Layton <jlayton@kernel.org>
Signed-off-by: NeilBrown <neil@brown.name>
Link: https://patch.msgid.link/20251113002050.676694-9-neilb@ownmail.net
Signed-off-by: Christian Brauner <brauner@kernel.org>
fs/cachefiles/interface.c
fs/cachefiles/namei.c
fs/cachefiles/volume.c
fs/namei.c
fs/overlayfs/dir.c
fs/overlayfs/readdir.c
fs/smb/server/vfs.c
include/linux/namei.h
security/apparmor/apparmorfs.c

index 3e63cfe15874728653c5592cba288b3c1d661da4..a08250d244ea251fcd4dbd6a7de5c9213949c661 100644 (file)
@@ -9,6 +9,7 @@
 #include <linux/mount.h>
 #include <linux/xattr.h>
 #include <linux/file.h>
+#include <linux/namei.h>
 #include <linux/falloc.h>
 #include <trace/events/fscache.h>
 #include "internal.h"
@@ -428,11 +429,13 @@ static bool cachefiles_invalidate_cookie(struct fscache_cookie *cookie)
                if (!old_tmpfile) {
                        struct cachefiles_volume *volume = object->volume;
                        struct dentry *fan = volume->fanout[(u8)cookie->key_hash];
+                       struct dentry *obj;
 
-                       inode_lock_nested(d_inode(fan), I_MUTEX_PARENT);
-                       cachefiles_bury_object(volume->cache, object, fan,
-                                              old_file->f_path.dentry,
-                                              FSCACHE_OBJECT_INVALIDATED);
+                       obj = start_removing_dentry(fan, old_file->f_path.dentry);
+                       if (!IS_ERR(obj))
+                               cachefiles_bury_object(volume->cache, object,
+                                                      fan, obj,
+                                                      FSCACHE_OBJECT_INVALIDATED);
                }
                fput(old_file);
        }
index c7f0c6ab9b88aed3cc544ba48fff146584d78278..0104ac00485d6e4f25458ea85c6b94170dd251c6 100644 (file)
@@ -261,6 +261,7 @@ static int cachefiles_unlink(struct cachefiles_cache *cache,
  * - Directory backed objects are stuffed into the graveyard for userspace to
  *   delete
  * On entry dir must be locked.  It will be unlocked on exit.
+ * On entry there must be at least 2 refs on rep, one will be dropped on exit.
  */
 int cachefiles_bury_object(struct cachefiles_cache *cache,
                           struct cachefiles_object *object,
@@ -275,12 +276,6 @@ int cachefiles_bury_object(struct cachefiles_cache *cache,
 
        _enter(",'%pd','%pd'", dir, rep);
 
-       /* end_removing() will dput() @rep but we need to keep
-        * a ref, so take one now.  This also stops the dentry
-        * being negated when unlinked which we need.
-        */
-       dget(rep);
-
        if (rep->d_parent != dir) {
                end_removing(rep);
                _leave(" = -ESTALE");
@@ -425,13 +420,12 @@ int cachefiles_delete_object(struct cachefiles_object *object,
 
        _enter(",OBJ%x{%pD}", object->debug_id, object->file);
 
-       /* Stop the dentry being negated if it's only pinned by a file struct. */
-       dget(dentry);
-
-       inode_lock_nested(d_backing_inode(fan), I_MUTEX_PARENT);
-       ret = cachefiles_unlink(volume->cache, object, fan, dentry, why);
-       inode_unlock(d_backing_inode(fan));
-       dput(dentry);
+       dentry = start_removing_dentry(fan, dentry);
+       if (IS_ERR(dentry))
+               ret = PTR_ERR(dentry);
+       else
+               ret = cachefiles_unlink(volume->cache, object, fan, dentry, why);
+       end_removing(dentry);
        return ret;
 }
 
@@ -644,9 +638,13 @@ bool cachefiles_look_up_object(struct cachefiles_object *object)
 
        if (!d_is_reg(dentry)) {
                pr_err("%pd is not a file\n", dentry);
-               inode_lock_nested(d_inode(fan), I_MUTEX_PARENT);
-               ret = cachefiles_bury_object(volume->cache, object, fan, dentry,
-                                            FSCACHE_OBJECT_IS_WEIRD);
+               struct dentry *de = start_removing_dentry(fan, dentry);
+               if (IS_ERR(de))
+                       ret = PTR_ERR(de);
+               else
+                       ret = cachefiles_bury_object(volume->cache, object,
+                                                    fan, de,
+                                                    FSCACHE_OBJECT_IS_WEIRD);
                dput(dentry);
                if (ret < 0)
                        return false;
index 781aac4ef274bdf5459e073de762c045f13f9112..90ba926f488e0a4408e7d2c581b23888acbf6480 100644 (file)
@@ -7,6 +7,7 @@
 
 #include <linux/fs.h>
 #include <linux/slab.h>
+#include <linux/namei.h>
 #include "internal.h"
 #include <trace/events/fscache.h>
 
@@ -58,9 +59,11 @@ retry:
                if (ret < 0) {
                        if (ret != -ESTALE)
                                goto error_dir;
-                       inode_lock_nested(d_inode(cache->store), I_MUTEX_PARENT);
-                       cachefiles_bury_object(cache, NULL, cache->store, vdentry,
-                                              FSCACHE_VOLUME_IS_WEIRD);
+                       vdentry = start_removing_dentry(cache->store, vdentry);
+                       if (!IS_ERR(vdentry))
+                               cachefiles_bury_object(cache, NULL, cache->store,
+                                                      vdentry,
+                                                      FSCACHE_VOLUME_IS_WEIRD);
                        cachefiles_put_directory(volume->dentry);
                        cond_resched();
                        goto retry;
index 696e4b794416f95260bfb9644ad948a56c9e0455..bfc443bec8a9cc1d55ab0b0e0e84458934759ba1 100644 (file)
@@ -3323,6 +3323,39 @@ struct dentry *start_removing_noperm(struct dentry *parent,
 }
 EXPORT_SYMBOL(start_removing_noperm);
 
+/**
+ * start_removing_dentry - prepare to remove a given dentry
+ * @parent: directory from which dentry should be removed
+ * @child:  the dentry to be removed
+ *
+ * A lock is taken to protect the dentry again other dirops and
+ * the validity of the dentry is checked: correct parent and still hashed.
+ *
+ * If the dentry is valid and positive, a reference is taken and
+ * returned.  If not an error is returned.
+ *
+ * end_removing() should be called when removal is complete, or aborted.
+ *
+ * Returns: the valid dentry, or an error.
+ */
+struct dentry *start_removing_dentry(struct dentry *parent,
+                                    struct dentry *child)
+{
+       inode_lock_nested(parent->d_inode, I_MUTEX_PARENT);
+       if (unlikely(IS_DEADDIR(parent->d_inode) ||
+                    child->d_parent != parent ||
+                    d_unhashed(child))) {
+               inode_unlock(parent->d_inode);
+               return ERR_PTR(-EINVAL);
+       }
+       if (d_is_negative(child)) {
+               inode_unlock(parent->d_inode);
+               return ERR_PTR(-ENOENT);
+       }
+       return dget(child);
+}
+EXPORT_SYMBOL(start_removing_dentry);
+
 #ifdef CONFIG_UNIX98_PTYS
 int path_pts(struct path *path)
 {
index f0b6e2e7c9d4c9b202c33dc7bdbc6a6b8c8f33e9..82b6ff0ab2d3705181ff1261772be33d8af6293f 100644 (file)
@@ -47,14 +47,12 @@ static int ovl_cleanup_locked(struct ovl_fs *ofs, struct inode *wdir,
 int ovl_cleanup(struct ovl_fs *ofs, struct dentry *workdir,
                struct dentry *wdentry)
 {
-       int err;
-
-       err = ovl_parent_lock(workdir, wdentry);
-       if (err)
-               return err;
+       wdentry = start_removing_dentry(workdir, wdentry);
+       if (IS_ERR(wdentry))
+               return PTR_ERR(wdentry);
 
        ovl_cleanup_locked(ofs, workdir->d_inode, wdentry);
-       ovl_parent_unlock(workdir);
+       end_removing(wdentry);
 
        return 0;
 }
index 1e9792cc557b8db20199c5ebb1eaa81f2fa28396..77ecc39fc33af834f5b7f3064e06788f5d476309 100644 (file)
@@ -1242,11 +1242,11 @@ int ovl_workdir_cleanup(struct ovl_fs *ofs, struct dentry *parent,
        if (!d_is_dir(dentry) || level > 1)
                return ovl_cleanup(ofs, parent, dentry);
 
-       err = ovl_parent_lock(parent, dentry);
-       if (err)
-               return err;
+       dentry = start_removing_dentry(parent, dentry);
+       if (IS_ERR(dentry))
+               return PTR_ERR(dentry);
        err = ovl_do_rmdir(ofs, parent->d_inode, dentry);
-       ovl_parent_unlock(parent);
+       end_removing(dentry);
        if (err) {
                struct path path = { .mnt = mnt, .dentry = dentry };
 
index ea0a06b0ae4461ed2b49e816594586f4769a5f92..148c65d59e423dc912c6050e17b5c8d51a852919 100644 (file)
@@ -49,24 +49,6 @@ static void ksmbd_vfs_inherit_owner(struct ksmbd_work *work,
        i_uid_write(inode, i_uid_read(parent_inode));
 }
 
-/**
- * ksmbd_vfs_lock_parent() - lock parent dentry if it is stable
- * @parent: parent dentry
- * @child: child dentry
- *
- * Returns: %0 on success, %-ENOENT if the parent dentry is not stable
- */
-int ksmbd_vfs_lock_parent(struct dentry *parent, struct dentry *child)
-{
-       inode_lock_nested(d_inode(parent), I_MUTEX_PARENT);
-       if (child->d_parent != parent) {
-               inode_unlock(d_inode(parent));
-               return -ENOENT;
-       }
-
-       return 0;
-}
-
 static int ksmbd_vfs_path_lookup(struct ksmbd_share_config *share_conf,
                                 char *pathname, unsigned int flags,
                                 struct path *path, bool for_remove)
@@ -1082,18 +1064,17 @@ int ksmbd_vfs_unlink(struct file *filp)
                return err;
 
        dir = dget_parent(dentry);
-       err = ksmbd_vfs_lock_parent(dir, dentry);
-       if (err)
+       dentry = start_removing_dentry(dir, dentry);
+       err = PTR_ERR(dentry);
+       if (IS_ERR(dentry))
                goto out;
-       dget(dentry);
 
        if (S_ISDIR(d_inode(dentry)->i_mode))
                err = vfs_rmdir(idmap, d_inode(dir), dentry);
        else
                err = vfs_unlink(idmap, d_inode(dir), dentry, NULL);
 
-       dput(dentry);
-       inode_unlock(d_inode(dir));
+       end_removing(dentry);
        if (err)
                ksmbd_debug(VFS, "failed to delete, err %d\n", err);
 out:
index 688e157d6afcee3b685e76721667bb269116a73c..7e916e9d77260d1bc2affc3b529b1c9e640d4aea 100644 (file)
@@ -94,6 +94,8 @@ struct dentry *start_removing(struct mnt_idmap *idmap, struct dentry *parent,
                              struct qstr *name);
 struct dentry *start_creating_noperm(struct dentry *parent, struct qstr *name);
 struct dentry *start_removing_noperm(struct dentry *parent, struct qstr *name);
+struct dentry *start_removing_dentry(struct dentry *parent,
+                                    struct dentry *child);
 
 /**
  * end_creating - finish action started with start_creating
index 391a586d0557f04b8ebe7e6175ceb71717a4ccdd..9d08d103f142694ac3eb36907cdd88d4832666b1 100644 (file)
@@ -355,17 +355,17 @@ static void aafs_remove(struct dentry *dentry)
        if (!dentry || IS_ERR(dentry))
                return;
 
+       /* ->d_parent is stable as rename is not supported */
        dir = d_inode(dentry->d_parent);
-       inode_lock(dir);
-       if (simple_positive(dentry)) {
+       dentry = start_removing_dentry(dentry->d_parent, dentry);
+       if (!IS_ERR(dentry) && simple_positive(dentry)) {
                if (d_is_dir(dentry))
                        simple_rmdir(dir, dentry);
                else
                        simple_unlink(dir, dentry);
                d_delete(dentry);
-               dput(dentry);
        }
-       inode_unlock(dir);
+       end_removing(dentry);
        simple_release_fs(&aafs_mnt, &aafs_count);
 }