Commit 72f582ff authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge branch 'work.recursive_removal' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs 

Pull vfs recursive removal updates from Al Viro:
 "We have quite a few places where synthetic filesystems do an
  equivalent of 'rm -rf', with varying amounts of code duplication,
  wrong locking, etc. That really ought to be a library helper.

  Only debugfs (and very similar tracefs) are converted here - I have
  more conversions, but they'd never been in -next, so they'll have to
  wait"

* 'work.recursive_removal' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs:
  simple_recursive_removal(): kernel-side rm -rf for ramfs-style filesystems
parents bddea11b a3d1e7eb

fs/debugfs/inode.c

+14 −107
Original line number Diff line number Diff line
@@ -332,6 +332,9 @@ static struct dentry *start_creating(const char *name, struct dentry *parent) 
		parent = debugfs_mount->mnt_root;



	inode_lock(d_inode(parent));

	if (unlikely(IS_DEADDIR(d_inode(parent))))

		dentry = ERR_PTR(-ENOENT);

	else

		dentry = lookup_one_len(name, parent, strlen(name));

	if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {

		if (d_is_dir(dentry))
@@ -681,62 +684,15 @@ static void __debugfs_file_removed(struct dentry *dentry) 
		wait_for_completion(&fsd->active_users_drained);

}



static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)

static void remove_one(struct dentry *victim)

{

	int ret = 0;



	if (simple_positive(dentry)) {

		dget(dentry);

		if (d_is_dir(dentry)) {

			ret = simple_rmdir(d_inode(parent), dentry);

			if (!ret)

				fsnotify_rmdir(d_inode(parent), dentry);

		} else {

			simple_unlink(d_inode(parent), dentry);

			fsnotify_unlink(d_inode(parent), dentry);

		}

		if (!ret)

			d_delete(dentry);

		if (d_is_reg(dentry))

			__debugfs_file_removed(dentry);

		dput(dentry);

	}

	return ret;

}



/**

 * debugfs_remove - removes a file or directory from the debugfs filesystem

 * @dentry: a pointer to a the dentry of the file or directory to be

 *          removed.  If this parameter is NULL or an error value, nothing

 *          will be done.

 *

 * This function removes a file or directory in debugfs that was previously

 * created with a call to another debugfs function (like

 * debugfs_create_file() or variants thereof.)

 *

 * This function is required to be called in order for the file to be

 * removed, no automatic cleanup of files will happen when a module is

 * removed, you are responsible here.

 */

void debugfs_remove(struct dentry *dentry)

{

	struct dentry *parent;

	int ret;



	if (IS_ERR_OR_NULL(dentry))

		return;



	parent = dentry->d_parent;

	inode_lock(d_inode(parent));

	ret = __debugfs_remove(dentry, parent);

	inode_unlock(d_inode(parent));

	if (!ret)

        if (d_is_reg(victim))

		__debugfs_file_removed(victim);

	simple_release_fs(&debugfs_mount, &debugfs_mount_count);

}

EXPORT_SYMBOL_GPL(debugfs_remove);



/**

 * debugfs_remove_recursive - recursively removes a directory

 * debugfs_remove - recursively removes a directory

 * @dentry: a pointer to a the dentry of the directory to be removed.  If this

 *          parameter is NULL or an error value, nothing will be done.

 *
@@ -748,65 +704,16 @@ EXPORT_SYMBOL_GPL(debugfs_remove); 
 * removed, no automatic cleanup of files will happen when a module is

 * removed, you are responsible here.

 */

void debugfs_remove_recursive(struct dentry *dentry)

void debugfs_remove(struct dentry *dentry)

{

	struct dentry *child, *parent;



	if (IS_ERR_OR_NULL(dentry))

		return;



	parent = dentry;

 down:

	inode_lock(d_inode(parent));

 loop:

	/*

	 * The parent->d_subdirs is protected by the d_lock. Outside that

	 * lock, the child can be unlinked and set to be freed which can

	 * use the d_u.d_child as the rcu head and corrupt this list.

	 */

	spin_lock(&parent->d_lock);

	list_for_each_entry(child, &parent->d_subdirs, d_child) {

		if (!simple_positive(child))

			continue;



		/* perhaps simple_empty(child) makes more sense */

		if (!list_empty(&child->d_subdirs)) {

			spin_unlock(&parent->d_lock);

			inode_unlock(d_inode(parent));

			parent = child;

			goto down;

		}



		spin_unlock(&parent->d_lock);



		if (!__debugfs_remove(child, parent))

			simple_release_fs(&debugfs_mount, &debugfs_mount_count);



		/*

		 * The parent->d_lock protects agaist child from unlinking

		 * from d_subdirs. When releasing the parent->d_lock we can

		 * no longer trust that the next pointer is valid.

		 * Restart the loop. We'll skip this one with the

		 * simple_positive() check.

		 */

		goto loop;

	}

	spin_unlock(&parent->d_lock);



	inode_unlock(d_inode(parent));

	child = parent;

	parent = parent->d_parent;

	inode_lock(d_inode(parent));



	if (child != dentry)

		/* go up */

		goto loop;



	if (!__debugfs_remove(child, parent))

	simple_pin_fs(&debug_fs_type, &debugfs_mount, &debugfs_mount_count);

	simple_recursive_removal(dentry, remove_one);

	simple_release_fs(&debugfs_mount, &debugfs_mount_count);

	inode_unlock(d_inode(parent));

}

EXPORT_SYMBOL_GPL(debugfs_remove_recursive);

EXPORT_SYMBOL_GPL(debugfs_remove);



/**

 * debugfs_rename - rename a file/directory in the debugfs filesystem

fs/libfs.c

+70 −0
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ 
#include <linux/buffer_head.h> /* sync_mapping_buffers */

#include <linux/fs_context.h>

#include <linux/pseudo_fs.h>

#include <linux/fsnotify.h>



#include <linux/uaccess.h>
@@ -239,6 +240,75 @@ const struct inode_operations simple_dir_inode_operations = { 
};

EXPORT_SYMBOL(simple_dir_inode_operations);



static struct dentry *find_next_child(struct dentry *parent, struct dentry *prev)

{

	struct dentry *child = NULL;

	struct list_head *p = prev ? &prev->d_child : &parent->d_subdirs;



	spin_lock(&parent->d_lock);

	while ((p = p->next) != &parent->d_subdirs) {

		struct dentry *d = container_of(p, struct dentry, d_child);

		if (simple_positive(d)) {

			spin_lock_nested(&d->d_lock, DENTRY_D_LOCK_NESTED);

			if (simple_positive(d))

				child = dget_dlock(d);

			spin_unlock(&d->d_lock);

			if (likely(child))

				break;

		}

	}

	spin_unlock(&parent->d_lock);

	dput(prev);

	return child;

}



void simple_recursive_removal(struct dentry *dentry,

                              void (*callback)(struct dentry *))

{

	struct dentry *this = dget(dentry);

	while (true) {

		struct dentry *victim = NULL, *child;

		struct inode *inode = this->d_inode;



		inode_lock(inode);

		if (d_is_dir(this))

			inode->i_flags |= S_DEAD;

		while ((child = find_next_child(this, victim)) == NULL) {

			// kill and ascend

			// update metadata while it's still locked

			inode->i_ctime = current_time(inode);

			clear_nlink(inode);

			inode_unlock(inode);

			victim = this;

			this = this->d_parent;

			inode = this->d_inode;

			inode_lock(inode);

			if (simple_positive(victim)) {

				d_invalidate(victim);	// avoid lost mounts

				if (d_is_dir(victim))

					fsnotify_rmdir(inode, victim);

				else

					fsnotify_unlink(inode, victim);

				if (callback)

					callback(victim);

				dput(victim);		// unpin it

			}

			if (victim == dentry) {

				inode->i_ctime = inode->i_mtime =

					current_time(inode);

				if (d_is_dir(dentry))

					drop_nlink(inode);

				inode_unlock(inode);

				dput(dentry);

				return;

			}

		}

		inode_unlock(inode);

		this = child;

	}

}

EXPORT_SYMBOL(simple_recursive_removal);



static const struct super_operations simple_super_operations = {

	.statfs		= simple_statfs,

};

fs/tracefs/inode.c

+11 −103
Original line number Diff line number Diff line
@@ -330,6 +330,9 @@ static struct dentry *start_creating(const char *name, struct dentry *parent) 
		parent = tracefs_mount->mnt_root;



	inode_lock(parent->d_inode);

	if (unlikely(IS_DEADDIR(parent->d_inode)))

		dentry = ERR_PTR(-ENOENT);

	else

		dentry = lookup_one_len(name, parent, strlen(name));

	if (!IS_ERR(dentry) && dentry->d_inode) {

		dput(dentry);
@@ -499,122 +502,27 @@ __init struct dentry *tracefs_create_instance_dir(const char *name, 
	return dentry;

}



static int __tracefs_remove(struct dentry *dentry, struct dentry *parent)

static void remove_one(struct dentry *victim)

{

	int ret = 0;



	if (simple_positive(dentry)) {

		if (dentry->d_inode) {

			dget(dentry);

			switch (dentry->d_inode->i_mode & S_IFMT) {

			case S_IFDIR:

				ret = simple_rmdir(parent->d_inode, dentry);

				if (!ret)

					fsnotify_rmdir(parent->d_inode, dentry);

				break;

			default:

				simple_unlink(parent->d_inode, dentry);

				fsnotify_unlink(parent->d_inode, dentry);

				break;

			}

			if (!ret)

				d_delete(dentry);

			dput(dentry);

		}

	}

	return ret;

}



/**

 * tracefs_remove - removes a file or directory from the tracefs filesystem

 * @dentry: a pointer to a the dentry of the file or directory to be

 *          removed.

 *

 * This function removes a file or directory in tracefs that was previously

 * created with a call to another tracefs function (like

 * tracefs_create_file() or variants thereof.)

 */

void tracefs_remove(struct dentry *dentry)

{

	struct dentry *parent;

	int ret;



	if (IS_ERR_OR_NULL(dentry))

		return;



	parent = dentry->d_parent;

	inode_lock(parent->d_inode);

	ret = __tracefs_remove(dentry, parent);

	inode_unlock(parent->d_inode);

	if (!ret)

	simple_release_fs(&tracefs_mount, &tracefs_mount_count);

}



/**

 * tracefs_remove_recursive - recursively removes a directory

 * tracefs_remove - recursively removes a directory

 * @dentry: a pointer to a the dentry of the directory to be removed.

 *

 * This function recursively removes a directory tree in tracefs that

 * was previously created with a call to another tracefs function

 * (like tracefs_create_file() or variants thereof.)

 */

void tracefs_remove_recursive(struct dentry *dentry)

void tracefs_remove(struct dentry *dentry)

{

	struct dentry *child, *parent;



	if (IS_ERR_OR_NULL(dentry))

		return;



	parent = dentry;

 down:

	inode_lock(parent->d_inode);

 loop:

	/*

	 * The parent->d_subdirs is protected by the d_lock. Outside that

	 * lock, the child can be unlinked and set to be freed which can

	 * use the d_u.d_child as the rcu head and corrupt this list.

	 */

	spin_lock(&parent->d_lock);

	list_for_each_entry(child, &parent->d_subdirs, d_child) {

		if (!simple_positive(child))

			continue;



		/* perhaps simple_empty(child) makes more sense */

		if (!list_empty(&child->d_subdirs)) {

			spin_unlock(&parent->d_lock);

			inode_unlock(parent->d_inode);

			parent = child;

			goto down;

		}



		spin_unlock(&parent->d_lock);



		if (!__tracefs_remove(child, parent))

	simple_pin_fs(&trace_fs_type, &tracefs_mount, &tracefs_mount_count);

	simple_recursive_removal(dentry, remove_one);

	simple_release_fs(&tracefs_mount, &tracefs_mount_count);



		/*

		 * The parent->d_lock protects agaist child from unlinking

		 * from d_subdirs. When releasing the parent->d_lock we can

		 * no longer trust that the next pointer is valid.

		 * Restart the loop. We'll skip this one with the

		 * simple_positive() check.

		 */

		goto loop;

	}

	spin_unlock(&parent->d_lock);



	inode_unlock(parent->d_inode);

	child = parent;

	parent = parent->d_parent;

	inode_lock(parent->d_inode);



	if (child != dentry)

		/* go up */

		goto loop;



	if (!__tracefs_remove(child, parent))

		simple_release_fs(&tracefs_mount, &tracefs_mount_count);

	inode_unlock(parent->d_inode);

}



/**

include/linux/debugfs.h

+1 −1
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ struct dentry *debugfs_create_automount(const char *name, 
					void *data);



void debugfs_remove(struct dentry *dentry);

void debugfs_remove_recursive(struct dentry *dentry);

#define debugfs_remove_recursive debugfs_remove



const struct file_operations *debugfs_real_fops(const struct file *filp);

include/linux/fs.h

+2 −0
Original line number Diff line number Diff line
@@ -3318,6 +3318,8 @@ extern int simple_unlink(struct inode *, struct dentry *); 
extern int simple_rmdir(struct inode *, struct dentry *);

extern int simple_rename(struct inode *, struct dentry *,

			 struct inode *, struct dentry *, unsigned int);

extern void simple_recursive_removal(struct dentry *,

                              void (*callback)(struct dentry *));

extern int noop_fsync(struct file *, loff_t, loff_t, int);

extern int noop_set_page_dirty(struct page *page);

extern void noop_invalidatepage(struct page *page, unsigned int offset,

CRA Git | Maintained and supported by SUSTech CRA and CCSE