1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * dir.c - Operations for configfs directories.
6 * sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
8 * configfs Copyright (C) 2005 Oracle. All rights reserved.
14 #include <linux/fsnotify.h>
15 #include <linux/mount.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/err.h>
20 #include <linux/configfs.h>
21 #include "configfs_internal.h"
24 * Protects mutations of configfs_dirent linkage together with proper i_mutex
25 * Also protects mutations of symlinks linkage to target configfs_dirent
26 * Mutators of configfs_dirent linkage must *both* have the proper inode locked
27 * and configfs_dirent_lock locked, in that order.
28 * This allows one to safely traverse configfs_dirent trees and symlinks without
29 * having to lock inodes.
31 * Protects setting of CONFIGFS_USET_DROPPING: checking the flag
32 * unlocked is not reliable unless in detach_groups() called from
33 * rmdir()/unregister() and from configfs_attach_group()
35 DEFINE_SPINLOCK(configfs_dirent_lock
);
38 * All of link_obj/unlink_obj/link_group/unlink_group require that
39 * subsys->su_mutex is held.
40 * But parent configfs_subsystem is NULL when config_item is root.
41 * Use this mutex when config_item is root.
43 static DEFINE_MUTEX(configfs_subsystem_mutex
);
45 static void configfs_d_iput(struct dentry
* dentry
,
48 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
51 /* Coordinate with configfs_readdir */
52 spin_lock(&configfs_dirent_lock
);
54 * Set sd->s_dentry to null only when this dentry is the one
55 * that is going to be killed. Otherwise configfs_d_iput may
56 * run just after configfs_lookup and set sd->s_dentry to
57 * NULL even it's still in use.
59 if (sd
->s_dentry
== dentry
)
62 spin_unlock(&configfs_dirent_lock
);
68 const struct dentry_operations configfs_dentry_ops
= {
69 .d_iput
= configfs_d_iput
,
70 .d_delete
= always_delete_dentry
,
76 * Helpers to make lockdep happy with our recursive locking of default groups'
77 * inodes (see configfs_attach_group() and configfs_detach_group()).
78 * We put default groups i_mutexes in separate classes according to their depth
79 * from the youngest non-default group ancestor.
81 * For a non-default group A having default groups A/B, A/C, and A/C/D, default
82 * groups A/B and A/C will have their inode's mutex in class
83 * default_group_class[0], and default group A/C/D will be in
84 * default_group_class[1].
86 * The lock classes are declared and assigned in inode.c, according to the
88 * The s_depth value is initialized to -1, adjusted to >= 0 when attaching
89 * default groups, and reset to -1 when all default groups are attached. During
90 * attachment, if configfs_create() sees s_depth > 0, the lock class of the new
91 * inode's mutex is set to default_group_class[s_depth - 1].
94 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
99 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
100 struct configfs_dirent
*sd
)
102 int parent_depth
= parent_sd
->s_depth
;
104 if (parent_depth
>= 0)
105 sd
->s_depth
= parent_depth
+ 1;
109 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
112 * item's i_mutex class is already setup, so s_depth is now only
113 * used to set new sub-directories s_depth, which is always done
114 * with item's i_mutex locked.
117 * sd->s_depth == -1 iff we are a non default group.
118 * else (we are a default group) sd->s_depth > 0 (see
121 if (sd
->s_depth
== -1)
123 * We are a non default group and we are going to create
130 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
132 /* We will not create default groups anymore. */
136 #else /* CONFIG_LOCKDEP */
138 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
142 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
143 struct configfs_dirent
*sd
)
148 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
153 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
157 #endif /* CONFIG_LOCKDEP */
159 static struct configfs_fragment
*new_fragment(void)
161 struct configfs_fragment
*p
;
163 p
= kmalloc(sizeof(struct configfs_fragment
), GFP_KERNEL
);
165 atomic_set(&p
->frag_count
, 1);
166 init_rwsem(&p
->frag_sem
);
167 p
->frag_dead
= false;
172 void put_fragment(struct configfs_fragment
*frag
)
174 if (frag
&& atomic_dec_and_test(&frag
->frag_count
))
178 struct configfs_fragment
*get_fragment(struct configfs_fragment
*frag
)
181 atomic_inc(&frag
->frag_count
);
186 * Allocates a new configfs_dirent and links it to the parent configfs_dirent
188 static struct configfs_dirent
*configfs_new_dirent(struct configfs_dirent
*parent_sd
,
189 void *element
, int type
,
190 struct configfs_fragment
*frag
)
192 struct configfs_dirent
* sd
;
194 sd
= kmem_cache_zalloc(configfs_dir_cachep
, GFP_KERNEL
);
196 return ERR_PTR(-ENOMEM
);
198 atomic_set(&sd
->s_count
, 1);
199 INIT_LIST_HEAD(&sd
->s_children
);
200 sd
->s_element
= element
;
202 configfs_init_dirent_depth(sd
);
203 spin_lock(&configfs_dirent_lock
);
204 if (parent_sd
->s_type
& CONFIGFS_USET_DROPPING
) {
205 spin_unlock(&configfs_dirent_lock
);
206 kmem_cache_free(configfs_dir_cachep
, sd
);
207 return ERR_PTR(-ENOENT
);
209 sd
->s_frag
= get_fragment(frag
);
212 * configfs_lookup scans only for unpinned items. s_children is
213 * partitioned so that configfs_lookup can bail out early.
214 * CONFIGFS_PINNED and CONFIGFS_NOT_PINNED are not symmetrical. readdir
215 * cursors still need to be inserted at the front of the list.
217 if (sd
->s_type
& CONFIGFS_PINNED
)
218 list_add_tail(&sd
->s_sibling
, &parent_sd
->s_children
);
220 list_add(&sd
->s_sibling
, &parent_sd
->s_children
);
221 spin_unlock(&configfs_dirent_lock
);
228 * Return -EEXIST if there is already a configfs element with the same
229 * name for the same parent.
231 * called with parent inode's i_mutex held
233 static int configfs_dirent_exists(struct dentry
*dentry
)
235 struct configfs_dirent
*parent_sd
= dentry
->d_parent
->d_fsdata
;
236 const unsigned char *new = dentry
->d_name
.name
;
237 struct configfs_dirent
*sd
;
239 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
241 const unsigned char *existing
= configfs_get_name(sd
);
242 if (strcmp(existing
, new))
253 int configfs_make_dirent(struct configfs_dirent
* parent_sd
,
254 struct dentry
* dentry
, void * element
,
255 umode_t mode
, int type
, struct configfs_fragment
*frag
)
257 struct configfs_dirent
* sd
;
259 sd
= configfs_new_dirent(parent_sd
, element
, type
, frag
);
264 sd
->s_dentry
= dentry
;
266 dentry
->d_fsdata
= configfs_get(sd
);
271 static void configfs_remove_dirent(struct dentry
*dentry
)
273 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
277 spin_lock(&configfs_dirent_lock
);
278 list_del_init(&sd
->s_sibling
);
279 spin_unlock(&configfs_dirent_lock
);
284 * configfs_create_dir - create a directory for an config_item.
285 * @item: config_itemwe're creating directory for.
286 * @dentry: config_item's dentry.
287 * @frag: config_item's fragment.
289 * Note: user-created entries won't be allowed under this new directory
290 * until it is validated by configfs_dir_set_ready()
293 static int configfs_create_dir(struct config_item
*item
, struct dentry
*dentry
,
294 struct configfs_fragment
*frag
)
297 umode_t mode
= S_IFDIR
| S_IRWXU
| S_IRUGO
| S_IXUGO
;
298 struct dentry
*p
= dentry
->d_parent
;
303 error
= configfs_make_dirent(p
->d_fsdata
, dentry
, item
, mode
,
304 CONFIGFS_DIR
| CONFIGFS_USET_CREATING
,
309 configfs_set_dir_dirent_depth(p
->d_fsdata
, dentry
->d_fsdata
);
310 inode
= configfs_create(dentry
, mode
);
314 inode
->i_op
= &configfs_dir_inode_operations
;
315 inode
->i_fop
= &configfs_dir_operations
;
316 /* directory inodes start off with i_nlink == 2 (for "." entry) */
318 d_instantiate(dentry
, inode
);
320 dget(dentry
); /* pin directory dentries in core */
321 inc_nlink(d_inode(p
));
322 item
->ci_dentry
= dentry
;
326 configfs_put(dentry
->d_fsdata
);
327 configfs_remove_dirent(dentry
);
328 return PTR_ERR(inode
);
332 * Allow userspace to create new entries under a new directory created with
333 * configfs_create_dir(), and under all of its chidlren directories recursively.
334 * @sd configfs_dirent of the new directory to validate
336 * Caller must hold configfs_dirent_lock.
338 static void configfs_dir_set_ready(struct configfs_dirent
*sd
)
340 struct configfs_dirent
*child_sd
;
342 sd
->s_type
&= ~CONFIGFS_USET_CREATING
;
343 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
)
344 if (child_sd
->s_type
& CONFIGFS_USET_CREATING
)
345 configfs_dir_set_ready(child_sd
);
349 * Check that a directory does not belong to a directory hierarchy being
350 * attached and not validated yet.
351 * @sd configfs_dirent of the directory to check
353 * @return non-zero iff the directory was validated
355 * Note: takes configfs_dirent_lock, so the result may change from false to true
356 * in two consecutive calls, but never from true to false.
358 int configfs_dirent_is_ready(struct configfs_dirent
*sd
)
362 spin_lock(&configfs_dirent_lock
);
363 ret
= !(sd
->s_type
& CONFIGFS_USET_CREATING
);
364 spin_unlock(&configfs_dirent_lock
);
369 int configfs_create_link(struct configfs_dirent
*target
, struct dentry
*parent
,
370 struct dentry
*dentry
, char *body
)
373 umode_t mode
= S_IFLNK
| S_IRWXUGO
;
374 struct configfs_dirent
*p
= parent
->d_fsdata
;
377 err
= configfs_make_dirent(p
, dentry
, target
, mode
, CONFIGFS_ITEM_LINK
,
382 inode
= configfs_create(dentry
, mode
);
386 inode
->i_link
= body
;
387 inode
->i_op
= &configfs_symlink_inode_operations
;
388 d_instantiate(dentry
, inode
);
389 dget(dentry
); /* pin link dentries in core */
393 configfs_put(dentry
->d_fsdata
);
394 configfs_remove_dirent(dentry
);
395 return PTR_ERR(inode
);
398 static void remove_dir(struct dentry
* d
)
400 struct dentry
* parent
= dget(d
->d_parent
);
402 configfs_remove_dirent(d
);
404 if (d_really_is_positive(d
))
405 simple_rmdir(d_inode(parent
),d
);
407 pr_debug(" o %pd removing done (%d)\n", d
, d_count(d
));
413 * configfs_remove_dir - remove an config_item's directory.
414 * @item: config_item we're removing.
416 * The only thing special about this is that we remove any files in
417 * the directory before we remove the directory, and we've inlined
418 * what used to be configfs_rmdir() below, instead of calling separately.
420 * Caller holds the mutex of the item's inode
423 static void configfs_remove_dir(struct config_item
* item
)
425 struct dentry
* dentry
= dget(item
->ci_dentry
);
432 * Drop reference from dget() on entrance.
437 static struct dentry
* configfs_lookup(struct inode
*dir
,
438 struct dentry
*dentry
,
441 struct configfs_dirent
* parent_sd
= dentry
->d_parent
->d_fsdata
;
442 struct configfs_dirent
* sd
;
443 struct inode
*inode
= NULL
;
445 if (dentry
->d_name
.len
> NAME_MAX
)
446 return ERR_PTR(-ENAMETOOLONG
);
449 * Fake invisibility if dir belongs to a group/default groups hierarchy
452 * This forbids userspace to read/write attributes of items which may
453 * not complete their initialization, since the dentries of the
454 * attributes won't be instantiated.
456 if (!configfs_dirent_is_ready(parent_sd
))
457 return ERR_PTR(-ENOENT
);
459 spin_lock(&configfs_dirent_lock
);
460 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
463 * s_children is partitioned, see configfs_new_dirent. The first
464 * pinned item indicates we can stop scanning.
466 if (sd
->s_type
& CONFIGFS_PINNED
)
470 * Note: CONFIGFS_PINNED and CONFIGFS_NOT_PINNED are asymmetric.
471 * there may be a readdir cursor in this list
473 if ((sd
->s_type
& CONFIGFS_NOT_PINNED
) &&
474 !strcmp(configfs_get_name(sd
), dentry
->d_name
.name
)) {
475 struct configfs_attribute
*attr
= sd
->s_element
;
476 umode_t mode
= (attr
->ca_mode
& S_IALLUGO
) | S_IFREG
;
478 dentry
->d_fsdata
= configfs_get(sd
);
479 sd
->s_dentry
= dentry
;
480 spin_unlock(&configfs_dirent_lock
);
482 inode
= configfs_create(dentry
, mode
);
485 return ERR_CAST(inode
);
487 if (sd
->s_type
& CONFIGFS_ITEM_BIN_ATTR
) {
489 inode
->i_fop
= &configfs_bin_file_operations
;
491 inode
->i_size
= PAGE_SIZE
;
492 inode
->i_fop
= &configfs_file_operations
;
497 spin_unlock(&configfs_dirent_lock
);
499 d_add(dentry
, inode
);
504 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
505 * attributes and are removed by rmdir(). We recurse, setting
506 * CONFIGFS_USET_DROPPING on all children that are candidates for
508 * If there is an error, the caller will reset the flags via
509 * configfs_detach_rollback().
511 static int configfs_detach_prep(struct dentry
*dentry
, struct dentry
**wait
)
513 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
514 struct configfs_dirent
*sd
;
517 /* Mark that we're trying to drop the group */
518 parent_sd
->s_type
|= CONFIGFS_USET_DROPPING
;
521 if (parent_sd
->s_links
)
525 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
526 if (!sd
->s_element
||
527 (sd
->s_type
& CONFIGFS_NOT_PINNED
))
529 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
) {
530 /* Abort if racing with mkdir() */
531 if (sd
->s_type
& CONFIGFS_USET_IN_MKDIR
) {
533 *wait
= dget(sd
->s_dentry
);
538 * Yup, recursive. If there's a problem, blame
539 * deep nesting of default_groups
541 ret
= configfs_detach_prep(sd
->s_dentry
, wait
);
555 * Walk the tree, resetting CONFIGFS_USET_DROPPING wherever it was
558 static void configfs_detach_rollback(struct dentry
*dentry
)
560 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
561 struct configfs_dirent
*sd
;
563 parent_sd
->s_type
&= ~CONFIGFS_USET_DROPPING
;
565 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
)
566 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
567 configfs_detach_rollback(sd
->s_dentry
);
570 static void detach_attrs(struct config_item
* item
)
572 struct dentry
* dentry
= dget(item
->ci_dentry
);
573 struct configfs_dirent
* parent_sd
;
574 struct configfs_dirent
* sd
, * tmp
;
579 pr_debug("configfs %s: dropping attrs for dir\n",
580 dentry
->d_name
.name
);
582 parent_sd
= dentry
->d_fsdata
;
583 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
584 if (!sd
->s_element
|| !(sd
->s_type
& CONFIGFS_NOT_PINNED
))
586 spin_lock(&configfs_dirent_lock
);
587 list_del_init(&sd
->s_sibling
);
588 spin_unlock(&configfs_dirent_lock
);
589 configfs_drop_dentry(sd
, dentry
);
594 * Drop reference from dget() on entrance.
599 static int populate_attrs(struct config_item
*item
)
601 const struct config_item_type
*t
= item
->ci_type
;
602 struct configfs_group_operations
*ops
;
603 struct configfs_attribute
*attr
;
604 struct configfs_bin_attribute
*bin_attr
;
611 ops
= t
->ct_group_ops
;
614 for (i
= 0; (attr
= t
->ct_attrs
[i
]) != NULL
; i
++) {
615 if (ops
&& ops
->is_visible
&& !ops
->is_visible(item
, attr
, i
))
618 if ((error
= configfs_create_file(item
, attr
)))
622 if (t
->ct_bin_attrs
) {
623 for (i
= 0; (bin_attr
= t
->ct_bin_attrs
[i
]) != NULL
; i
++) {
624 if (ops
&& ops
->is_bin_visible
&& !ops
->is_bin_visible(item
, bin_attr
, i
))
627 error
= configfs_create_bin_file(item
, bin_attr
);
639 static int configfs_attach_group(struct config_item
*parent_item
,
640 struct config_item
*item
,
641 struct dentry
*dentry
,
642 struct configfs_fragment
*frag
);
643 static void configfs_detach_group(struct config_item
*item
);
645 static void detach_groups(struct config_group
*group
)
647 struct dentry
* dentry
= dget(group
->cg_item
.ci_dentry
);
648 struct dentry
*child
;
649 struct configfs_dirent
*parent_sd
;
650 struct configfs_dirent
*sd
, *tmp
;
655 parent_sd
= dentry
->d_fsdata
;
656 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
657 if (!sd
->s_element
||
658 !(sd
->s_type
& CONFIGFS_USET_DEFAULT
))
661 child
= sd
->s_dentry
;
663 inode_lock(d_inode(child
));
665 configfs_detach_group(sd
->s_element
);
666 d_inode(child
)->i_flags
|= S_DEAD
;
669 inode_unlock(d_inode(child
));
676 * Drop reference from dget() on entrance.
682 * This fakes mkdir(2) on a default_groups[] entry. It
683 * creates a dentry, attachs it, and then does fixup
686 * We could, perhaps, tweak our parent's ->mkdir for a minute and
687 * try using vfs_mkdir. Just a thought.
689 static int create_default_group(struct config_group
*parent_group
,
690 struct config_group
*group
,
691 struct configfs_fragment
*frag
)
694 struct configfs_dirent
*sd
;
695 /* We trust the caller holds a reference to parent */
696 struct dentry
*child
, *parent
= parent_group
->cg_item
.ci_dentry
;
698 if (!group
->cg_item
.ci_name
)
699 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
702 child
= d_alloc_name(parent
, group
->cg_item
.ci_name
);
706 ret
= configfs_attach_group(&parent_group
->cg_item
,
707 &group
->cg_item
, child
, frag
);
709 sd
= child
->d_fsdata
;
710 sd
->s_type
|= CONFIGFS_USET_DEFAULT
;
712 BUG_ON(d_inode(child
));
721 static int populate_groups(struct config_group
*group
,
722 struct configfs_fragment
*frag
)
724 struct config_group
*new_group
;
727 list_for_each_entry(new_group
, &group
->default_groups
, group_entry
) {
728 ret
= create_default_group(group
, new_group
, frag
);
730 detach_groups(group
);
738 void configfs_remove_default_groups(struct config_group
*group
)
740 struct config_group
*g
, *n
;
742 list_for_each_entry_safe(g
, n
, &group
->default_groups
, group_entry
) {
743 list_del(&g
->group_entry
);
744 config_item_put(&g
->cg_item
);
747 EXPORT_SYMBOL(configfs_remove_default_groups
);
750 * All of link_obj/unlink_obj/link_group/unlink_group require that
751 * subsys->su_mutex is held.
754 static void unlink_obj(struct config_item
*item
)
756 struct config_group
*group
;
758 group
= item
->ci_group
;
760 list_del_init(&item
->ci_entry
);
762 item
->ci_group
= NULL
;
763 item
->ci_parent
= NULL
;
765 /* Drop the reference for ci_entry */
766 config_item_put(item
);
768 /* Drop the reference for ci_parent */
769 config_group_put(group
);
773 static void link_obj(struct config_item
*parent_item
, struct config_item
*item
)
776 * Parent seems redundant with group, but it makes certain
777 * traversals much nicer.
779 item
->ci_parent
= parent_item
;
782 * We hold a reference on the parent for the child's ci_parent
785 item
->ci_group
= config_group_get(to_config_group(parent_item
));
786 list_add_tail(&item
->ci_entry
, &item
->ci_group
->cg_children
);
789 * We hold a reference on the child for ci_entry on the parent's
792 config_item_get(item
);
795 static void unlink_group(struct config_group
*group
)
797 struct config_group
*new_group
;
799 list_for_each_entry(new_group
, &group
->default_groups
, group_entry
)
800 unlink_group(new_group
);
802 group
->cg_subsys
= NULL
;
803 unlink_obj(&group
->cg_item
);
806 static void link_group(struct config_group
*parent_group
, struct config_group
*group
)
808 struct config_group
*new_group
;
809 struct configfs_subsystem
*subsys
= NULL
; /* gcc is a turd */
811 link_obj(&parent_group
->cg_item
, &group
->cg_item
);
813 if (parent_group
->cg_subsys
)
814 subsys
= parent_group
->cg_subsys
;
815 else if (configfs_is_root(&parent_group
->cg_item
))
816 subsys
= to_configfs_subsystem(group
);
819 group
->cg_subsys
= subsys
;
821 list_for_each_entry(new_group
, &group
->default_groups
, group_entry
)
822 link_group(group
, new_group
);
826 * The goal is that configfs_attach_item() (and
827 * configfs_attach_group()) can be called from either the VFS or this
828 * module. That is, they assume that the items have been created,
829 * the dentry allocated, and the dcache is all ready to go.
831 * If they fail, they must clean up after themselves as if they
832 * had never been called. The caller (VFS or local function) will
833 * handle cleaning up the dcache bits.
835 * configfs_detach_group() and configfs_detach_item() behave similarly on
836 * the way out. They assume that the proper semaphores are held, they
837 * clean up the configfs items, and they expect their callers will
838 * handle the dcache bits.
840 static int configfs_attach_item(struct config_item
*parent_item
,
841 struct config_item
*item
,
842 struct dentry
*dentry
,
843 struct configfs_fragment
*frag
)
847 ret
= configfs_create_dir(item
, dentry
, frag
);
849 ret
= populate_attrs(item
);
852 * We are going to remove an inode and its dentry but
853 * the VFS may already have hit and used them. Thus,
854 * we must lock them as rmdir() would.
856 inode_lock(d_inode(dentry
));
857 configfs_remove_dir(item
);
858 d_inode(dentry
)->i_flags
|= S_DEAD
;
860 inode_unlock(d_inode(dentry
));
868 /* Caller holds the mutex of the item's inode */
869 static void configfs_detach_item(struct config_item
*item
)
872 configfs_remove_dir(item
);
875 static int configfs_attach_group(struct config_item
*parent_item
,
876 struct config_item
*item
,
877 struct dentry
*dentry
,
878 struct configfs_fragment
*frag
)
881 struct configfs_dirent
*sd
;
883 ret
= configfs_attach_item(parent_item
, item
, dentry
, frag
);
885 sd
= dentry
->d_fsdata
;
886 sd
->s_type
|= CONFIGFS_USET_DIR
;
889 * FYI, we're faking mkdir in populate_groups()
890 * We must lock the group's inode to avoid races with the VFS
891 * which can already hit the inode and try to add/remove entries
894 * We must also lock the inode to remove it safely in case of
895 * error, as rmdir() would.
897 inode_lock_nested(d_inode(dentry
), I_MUTEX_CHILD
);
898 configfs_adjust_dir_dirent_depth_before_populate(sd
);
899 ret
= populate_groups(to_config_group(item
), frag
);
901 configfs_detach_item(item
);
902 d_inode(dentry
)->i_flags
|= S_DEAD
;
905 configfs_adjust_dir_dirent_depth_after_populate(sd
);
906 inode_unlock(d_inode(dentry
));
914 /* Caller holds the mutex of the group's inode */
915 static void configfs_detach_group(struct config_item
*item
)
917 detach_groups(to_config_group(item
));
918 configfs_detach_item(item
);
922 * After the item has been detached from the filesystem view, we are
923 * ready to tear it out of the hierarchy. Notify the client before
924 * we do that so they can perform any cleanup that requires
925 * navigating the hierarchy. A client does not need to provide this
926 * callback. The subsystem semaphore MUST be held by the caller, and
927 * references must be valid for both items. It also assumes the
928 * caller has validated ci_type.
930 static void client_disconnect_notify(struct config_item
*parent_item
,
931 struct config_item
*item
)
933 const struct config_item_type
*type
;
935 type
= parent_item
->ci_type
;
938 if (type
->ct_group_ops
&& type
->ct_group_ops
->disconnect_notify
)
939 type
->ct_group_ops
->disconnect_notify(to_config_group(parent_item
),
944 * Drop the initial reference from make_item()/make_group()
945 * This function assumes that reference is held on item
946 * and that item holds a valid reference to the parent. Also, it
947 * assumes the caller has validated ci_type.
949 static void client_drop_item(struct config_item
*parent_item
,
950 struct config_item
*item
)
952 const struct config_item_type
*type
;
954 type
= parent_item
->ci_type
;
958 * If ->drop_item() exists, it is responsible for the
961 if (type
->ct_group_ops
&& type
->ct_group_ops
->drop_item
)
962 type
->ct_group_ops
->drop_item(to_config_group(parent_item
),
965 config_item_put(item
);
969 static void configfs_dump_one(struct configfs_dirent
*sd
, int level
)
971 pr_info("%*s\"%s\":\n", level
, " ", configfs_get_name(sd
));
973 #define type_print(_type) if (sd->s_type & _type) pr_info("%*s %s\n", level, " ", #_type);
974 type_print(CONFIGFS_ROOT
);
975 type_print(CONFIGFS_DIR
);
976 type_print(CONFIGFS_ITEM_ATTR
);
977 type_print(CONFIGFS_ITEM_LINK
);
978 type_print(CONFIGFS_USET_DIR
);
979 type_print(CONFIGFS_USET_DEFAULT
);
980 type_print(CONFIGFS_USET_DROPPING
);
984 static int configfs_dump(struct configfs_dirent
*sd
, int level
)
986 struct configfs_dirent
*child_sd
;
989 configfs_dump_one(sd
, level
);
991 if (!(sd
->s_type
& (CONFIGFS_DIR
|CONFIGFS_ROOT
)))
994 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
995 ret
= configfs_dump(child_sd
, level
+ 2);
1006 * configfs_depend_item() and configfs_undepend_item()
1008 * WARNING: Do not call these from a configfs callback!
1010 * This describes these functions and their helpers.
1012 * Allow another kernel system to depend on a config_item. If this
1013 * happens, the item cannot go away until the dependent can live without
1014 * it. The idea is to give client modules as simple an interface as
1015 * possible. When a system asks them to depend on an item, they just
1016 * call configfs_depend_item(). If the item is live and the client
1017 * driver is in good shape, we'll happily do the work for them.
1019 * Why is the locking complex? Because configfs uses the VFS to handle
1020 * all locking, but this function is called outside the normal
1021 * VFS->configfs path. So it must take VFS locks to prevent the
1022 * VFS->configfs stuff (configfs_mkdir(), configfs_rmdir(), etc). This is
1023 * why you can't call these functions underneath configfs callbacks.
1025 * Note, btw, that this can be called at *any* time, even when a configfs
1026 * subsystem isn't registered, or when configfs is loading or unloading.
1027 * Just like configfs_register_subsystem(). So we take the same
1028 * precautions. We pin the filesystem. We lock configfs_dirent_lock.
1029 * If we can find the target item in the
1030 * configfs tree, it must be part of the subsystem tree as well, so we
1031 * do not need the subsystem semaphore. Holding configfs_dirent_lock helps
1032 * locking out mkdir() and rmdir(), who might be racing us.
1036 * configfs_depend_prep()
1038 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
1039 * attributes. This is similar but not the same to configfs_detach_prep().
1040 * Note that configfs_detach_prep() expects the parent to be locked when it
1041 * is called, but we lock the parent *inside* configfs_depend_prep(). We
1042 * do that so we can unlock it if we find nothing.
1044 * Here we do a depth-first search of the dentry hierarchy looking for
1046 * We deliberately ignore items tagged as dropping since they are virtually
1047 * dead, as well as items in the middle of attachment since they virtually
1048 * do not exist yet. This completes the locking out of racing mkdir() and
1050 * Note: subdirectories in the middle of attachment start with s_type =
1051 * CONFIGFS_DIR|CONFIGFS_USET_CREATING set by create_dir(). When
1052 * CONFIGFS_USET_CREATING is set, we ignore the item. The actual set of
1053 * s_type is in configfs_new_dirent(), which has configfs_dirent_lock.
1055 * If the target is not found, -ENOENT is bubbled up.
1057 * This adds a requirement that all config_items be unique!
1059 * This is recursive. There isn't
1060 * much on the stack, though, so folks that need this function - be careful
1061 * about your stack! Patches will be accepted to make it iterative.
1063 static int configfs_depend_prep(struct dentry
*origin
,
1064 struct config_item
*target
)
1066 struct configfs_dirent
*child_sd
, *sd
;
1069 BUG_ON(!origin
|| !origin
->d_fsdata
);
1070 sd
= origin
->d_fsdata
;
1072 if (sd
->s_element
== target
) /* Boo-yah */
1075 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
1076 if ((child_sd
->s_type
& CONFIGFS_DIR
) &&
1077 !(child_sd
->s_type
& CONFIGFS_USET_DROPPING
) &&
1078 !(child_sd
->s_type
& CONFIGFS_USET_CREATING
)) {
1079 ret
= configfs_depend_prep(child_sd
->s_dentry
,
1082 goto out
; /* Child path boo-yah */
1086 /* We looped all our children and didn't find target */
1093 static int configfs_do_depend_item(struct dentry
*subsys_dentry
,
1094 struct config_item
*target
)
1096 struct configfs_dirent
*p
;
1099 spin_lock(&configfs_dirent_lock
);
1100 /* Scan the tree, return 0 if found */
1101 ret
= configfs_depend_prep(subsys_dentry
, target
);
1103 goto out_unlock_dirent_lock
;
1106 * We are sure that the item is not about to be removed by rmdir(), and
1107 * not in the middle of attachment by mkdir().
1109 p
= target
->ci_dentry
->d_fsdata
;
1110 p
->s_dependent_count
+= 1;
1112 out_unlock_dirent_lock
:
1113 spin_unlock(&configfs_dirent_lock
);
1118 static inline struct configfs_dirent
*
1119 configfs_find_subsys_dentry(struct configfs_dirent
*root_sd
,
1120 struct config_item
*subsys_item
)
1122 struct configfs_dirent
*p
;
1123 struct configfs_dirent
*ret
= NULL
;
1125 list_for_each_entry(p
, &root_sd
->s_children
, s_sibling
) {
1126 if (p
->s_type
& CONFIGFS_DIR
&&
1127 p
->s_element
== subsys_item
) {
1137 int configfs_depend_item(struct configfs_subsystem
*subsys
,
1138 struct config_item
*target
)
1141 struct configfs_dirent
*subsys_sd
;
1142 struct config_item
*s_item
= &subsys
->su_group
.cg_item
;
1143 struct dentry
*root
;
1146 * Pin the configfs filesystem. This means we can safely access
1147 * the root of the configfs filesystem.
1149 root
= configfs_pin_fs();
1151 return PTR_ERR(root
);
1154 * Next, lock the root directory. We're going to check that the
1155 * subsystem is really registered, and so we need to lock out
1156 * configfs_[un]register_subsystem().
1158 inode_lock(d_inode(root
));
1160 subsys_sd
= configfs_find_subsys_dentry(root
->d_fsdata
, s_item
);
1166 /* Ok, now we can trust subsys/s_item */
1167 ret
= configfs_do_depend_item(subsys_sd
->s_dentry
, target
);
1170 inode_unlock(d_inode(root
));
1173 * If we succeeded, the fs is pinned via other methods. If not,
1174 * we're done with it anyway. So release_fs() is always right.
1176 configfs_release_fs();
1180 EXPORT_SYMBOL(configfs_depend_item
);
1183 * Release the dependent linkage. This is much simpler than
1184 * configfs_depend_item() because we know that the client driver is
1185 * pinned, thus the subsystem is pinned, and therefore configfs is pinned.
1187 void configfs_undepend_item(struct config_item
*target
)
1189 struct configfs_dirent
*sd
;
1192 * Since we can trust everything is pinned, we just need
1193 * configfs_dirent_lock.
1195 spin_lock(&configfs_dirent_lock
);
1197 sd
= target
->ci_dentry
->d_fsdata
;
1198 BUG_ON(sd
->s_dependent_count
< 1);
1200 sd
->s_dependent_count
-= 1;
1203 * After this unlock, we cannot trust the item to stay alive!
1204 * DO NOT REFERENCE item after this unlock.
1206 spin_unlock(&configfs_dirent_lock
);
1208 EXPORT_SYMBOL(configfs_undepend_item
);
1211 * caller_subsys is a caller's subsystem not target's. This is used to
1212 * determine if we should lock root and check subsys or not. When we are
1213 * in the same subsystem as our target there is no need to do locking as
1214 * we know that subsys is valid and is not unregistered during this function
1215 * as we are called from callback of one of his children and VFS holds a lock
1216 * on some inode. Otherwise we have to lock our root to ensure that target's
1217 * subsystem it is not unregistered during this function.
1219 int configfs_depend_item_unlocked(struct configfs_subsystem
*caller_subsys
,
1220 struct config_item
*target
)
1222 struct configfs_subsystem
*target_subsys
;
1223 struct config_group
*root
, *parent
;
1224 struct configfs_dirent
*subsys_sd
;
1227 /* Disallow this function for configfs root */
1228 if (configfs_is_root(target
))
1231 parent
= target
->ci_group
;
1233 * This may happen when someone is trying to depend root
1234 * directory of some subsystem
1236 if (configfs_is_root(&parent
->cg_item
)) {
1237 target_subsys
= to_configfs_subsystem(to_config_group(target
));
1240 target_subsys
= parent
->cg_subsys
;
1241 /* Find a cofnigfs root as we may need it for locking */
1242 for (root
= parent
; !configfs_is_root(&root
->cg_item
);
1243 root
= root
->cg_item
.ci_group
)
1247 if (target_subsys
!= caller_subsys
) {
1249 * We are in other configfs subsystem, so we have to do
1250 * additional locking to prevent other subsystem from being
1253 inode_lock(d_inode(root
->cg_item
.ci_dentry
));
1256 * As we are trying to depend item from other subsystem
1257 * we have to check if this subsystem is still registered
1259 subsys_sd
= configfs_find_subsys_dentry(
1260 root
->cg_item
.ci_dentry
->d_fsdata
,
1261 &target_subsys
->su_group
.cg_item
);
1263 goto out_root_unlock
;
1265 subsys_sd
= target_subsys
->su_group
.cg_item
.ci_dentry
->d_fsdata
;
1268 /* Now we can execute core of depend item */
1269 ret
= configfs_do_depend_item(subsys_sd
->s_dentry
, target
);
1271 if (target_subsys
!= caller_subsys
)
1274 * We were called from subsystem other than our target so we
1275 * took some locks so now it's time to release them
1277 inode_unlock(d_inode(root
->cg_item
.ci_dentry
));
1281 EXPORT_SYMBOL(configfs_depend_item_unlocked
);
1283 static int configfs_mkdir(struct mnt_idmap
*idmap
, struct inode
*dir
,
1284 struct dentry
*dentry
, umode_t mode
)
1288 struct config_group
*group
= NULL
;
1289 struct config_item
*item
= NULL
;
1290 struct config_item
*parent_item
;
1291 struct configfs_subsystem
*subsys
;
1292 struct configfs_dirent
*sd
;
1293 const struct config_item_type
*type
;
1294 struct module
*subsys_owner
= NULL
, *new_item_owner
= NULL
;
1295 struct configfs_fragment
*frag
;
1298 sd
= dentry
->d_parent
->d_fsdata
;
1301 * Fake invisibility if dir belongs to a group/default groups hierarchy
1304 if (!configfs_dirent_is_ready(sd
)) {
1309 if (!(sd
->s_type
& CONFIGFS_USET_DIR
)) {
1314 frag
= new_fragment();
1320 /* Get a working ref for the duration of this function */
1321 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1322 type
= parent_item
->ci_type
;
1323 subsys
= to_config_group(parent_item
)->cg_subsys
;
1326 if (!type
|| !type
->ct_group_ops
||
1327 (!type
->ct_group_ops
->make_group
&&
1328 !type
->ct_group_ops
->make_item
)) {
1329 ret
= -EPERM
; /* Lack-of-mkdir returns -EPERM */
1334 * The subsystem may belong to a different module than the item
1335 * being created. We don't want to safely pin the new item but
1336 * fail to pin the subsystem it sits under.
1338 if (!subsys
->su_group
.cg_item
.ci_type
) {
1342 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1343 if (!try_module_get(subsys_owner
)) {
1348 name
= kmalloc(dentry
->d_name
.len
+ 1, GFP_KERNEL
);
1351 goto out_subsys_put
;
1354 snprintf(name
, dentry
->d_name
.len
+ 1, "%s", dentry
->d_name
.name
);
1356 mutex_lock(&subsys
->su_mutex
);
1357 if (type
->ct_group_ops
->make_group
) {
1358 group
= type
->ct_group_ops
->make_group(to_config_group(parent_item
), name
);
1360 group
= ERR_PTR(-ENOMEM
);
1361 if (!IS_ERR(group
)) {
1362 link_group(to_config_group(parent_item
), group
);
1363 item
= &group
->cg_item
;
1365 ret
= PTR_ERR(group
);
1367 item
= type
->ct_group_ops
->make_item(to_config_group(parent_item
), name
);
1369 item
= ERR_PTR(-ENOMEM
);
1371 link_obj(parent_item
, item
);
1373 ret
= PTR_ERR(item
);
1375 mutex_unlock(&subsys
->su_mutex
);
1380 * If ret != 0, then link_obj() was never called.
1381 * There are no extra references to clean up.
1383 goto out_subsys_put
;
1387 * link_obj() has been called (via link_group() for groups).
1388 * From here on out, errors must clean that up.
1391 type
= item
->ci_type
;
1397 new_item_owner
= type
->ct_owner
;
1398 if (!try_module_get(new_item_owner
)) {
1404 * I hate doing it this way, but if there is
1405 * an error, module_put() probably should
1406 * happen after any cleanup.
1411 * Make racing rmdir() fail if it did not tag parent with
1412 * CONFIGFS_USET_DROPPING
1413 * Note: if CONFIGFS_USET_DROPPING is already set, attach_group() will
1414 * fail and let rmdir() terminate correctly
1416 spin_lock(&configfs_dirent_lock
);
1417 /* This will make configfs_detach_prep() fail */
1418 sd
->s_type
|= CONFIGFS_USET_IN_MKDIR
;
1419 spin_unlock(&configfs_dirent_lock
);
1422 ret
= configfs_attach_group(parent_item
, item
, dentry
, frag
);
1424 ret
= configfs_attach_item(parent_item
, item
, dentry
, frag
);
1426 spin_lock(&configfs_dirent_lock
);
1427 sd
->s_type
&= ~CONFIGFS_USET_IN_MKDIR
;
1429 configfs_dir_set_ready(dentry
->d_fsdata
);
1430 spin_unlock(&configfs_dirent_lock
);
1434 /* Tear down everything we built up */
1435 mutex_lock(&subsys
->su_mutex
);
1437 client_disconnect_notify(parent_item
, item
);
1439 unlink_group(group
);
1442 client_drop_item(parent_item
, item
);
1444 mutex_unlock(&subsys
->su_mutex
);
1447 module_put(new_item_owner
);
1452 module_put(subsys_owner
);
1456 * link_obj()/link_group() took a reference from child->parent,
1457 * so the parent is safely pinned. We can drop our working
1460 config_item_put(parent_item
);
1467 static int configfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
1469 struct config_item
*parent_item
;
1470 struct config_item
*item
;
1471 struct configfs_subsystem
*subsys
;
1472 struct configfs_dirent
*sd
;
1473 struct configfs_fragment
*frag
;
1474 struct module
*subsys_owner
= NULL
, *dead_item_owner
= NULL
;
1477 sd
= dentry
->d_fsdata
;
1478 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
1481 /* Get a working ref until we have the child */
1482 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1483 subsys
= to_config_group(parent_item
)->cg_subsys
;
1486 if (!parent_item
->ci_type
) {
1487 config_item_put(parent_item
);
1491 /* configfs_mkdir() shouldn't have allowed this */
1492 BUG_ON(!subsys
->su_group
.cg_item
.ci_type
);
1493 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1496 * Ensure that no racing symlink() will make detach_prep() fail while
1497 * the new link is temporarily attached
1500 struct dentry
*wait
;
1502 mutex_lock(&configfs_symlink_mutex
);
1503 spin_lock(&configfs_dirent_lock
);
1505 * Here's where we check for dependents. We're protected by
1506 * configfs_dirent_lock.
1507 * If no dependent, atomically tag the item as dropping.
1509 ret
= sd
->s_dependent_count
? -EBUSY
: 0;
1511 ret
= configfs_detach_prep(dentry
, &wait
);
1513 configfs_detach_rollback(dentry
);
1515 spin_unlock(&configfs_dirent_lock
);
1516 mutex_unlock(&configfs_symlink_mutex
);
1519 if (ret
!= -EAGAIN
) {
1520 config_item_put(parent_item
);
1524 /* Wait until the racing operation terminates */
1525 inode_lock(d_inode(wait
));
1526 inode_unlock(d_inode(wait
));
1529 } while (ret
== -EAGAIN
);
1532 if (down_write_killable(&frag
->frag_sem
)) {
1533 spin_lock(&configfs_dirent_lock
);
1534 configfs_detach_rollback(dentry
);
1535 spin_unlock(&configfs_dirent_lock
);
1536 config_item_put(parent_item
);
1539 frag
->frag_dead
= true;
1540 up_write(&frag
->frag_sem
);
1542 /* Get a working ref for the duration of this function */
1543 item
= configfs_get_config_item(dentry
);
1545 /* Drop reference from above, item already holds one. */
1546 config_item_put(parent_item
);
1549 dead_item_owner
= item
->ci_type
->ct_owner
;
1551 if (sd
->s_type
& CONFIGFS_USET_DIR
) {
1552 configfs_detach_group(item
);
1554 mutex_lock(&subsys
->su_mutex
);
1555 client_disconnect_notify(parent_item
, item
);
1556 unlink_group(to_config_group(item
));
1558 configfs_detach_item(item
);
1560 mutex_lock(&subsys
->su_mutex
);
1561 client_disconnect_notify(parent_item
, item
);
1565 client_drop_item(parent_item
, item
);
1566 mutex_unlock(&subsys
->su_mutex
);
1568 /* Drop our reference from above */
1569 config_item_put(item
);
1571 module_put(dead_item_owner
);
1572 module_put(subsys_owner
);
1577 const struct inode_operations configfs_dir_inode_operations
= {
1578 .mkdir
= configfs_mkdir
,
1579 .rmdir
= configfs_rmdir
,
1580 .symlink
= configfs_symlink
,
1581 .unlink
= configfs_unlink
,
1582 .lookup
= configfs_lookup
,
1583 .setattr
= configfs_setattr
,
1586 const struct inode_operations configfs_root_inode_operations
= {
1587 .lookup
= configfs_lookup
,
1588 .setattr
= configfs_setattr
,
1591 static int configfs_dir_open(struct inode
*inode
, struct file
*file
)
1593 struct dentry
* dentry
= file
->f_path
.dentry
;
1594 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1597 inode_lock(d_inode(dentry
));
1599 * Fake invisibility if dir belongs to a group/default groups hierarchy
1603 if (configfs_dirent_is_ready(parent_sd
)) {
1604 file
->private_data
= configfs_new_dirent(parent_sd
, NULL
, 0, NULL
);
1605 if (IS_ERR(file
->private_data
))
1606 err
= PTR_ERR(file
->private_data
);
1610 inode_unlock(d_inode(dentry
));
1615 static int configfs_dir_close(struct inode
*inode
, struct file
*file
)
1617 struct dentry
* dentry
= file
->f_path
.dentry
;
1618 struct configfs_dirent
* cursor
= file
->private_data
;
1620 inode_lock(d_inode(dentry
));
1621 spin_lock(&configfs_dirent_lock
);
1622 list_del_init(&cursor
->s_sibling
);
1623 spin_unlock(&configfs_dirent_lock
);
1624 inode_unlock(d_inode(dentry
));
1626 release_configfs_dirent(cursor
);
1631 static int configfs_readdir(struct file
*file
, struct dir_context
*ctx
)
1633 struct dentry
*dentry
= file
->f_path
.dentry
;
1634 struct super_block
*sb
= dentry
->d_sb
;
1635 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1636 struct configfs_dirent
*cursor
= file
->private_data
;
1637 struct list_head
*p
, *q
= &cursor
->s_sibling
;
1640 if (!dir_emit_dots(file
, ctx
))
1642 spin_lock(&configfs_dirent_lock
);
1644 list_move(q
, &parent_sd
->s_children
);
1645 for (p
= q
->next
; p
!= &parent_sd
->s_children
; p
= p
->next
) {
1646 struct configfs_dirent
*next
;
1649 struct inode
*inode
= NULL
;
1651 next
= list_entry(p
, struct configfs_dirent
, s_sibling
);
1652 if (!next
->s_element
)
1656 * We'll have a dentry and an inode for
1657 * PINNED items and for open attribute
1658 * files. We lock here to prevent a race
1659 * with configfs_d_iput() clearing
1660 * s_dentry before calling iput().
1662 * Why do we go to the trouble? If
1663 * someone has an attribute file open,
1664 * the inode number should match until
1665 * they close it. Beyond that, we don't
1668 dentry
= next
->s_dentry
;
1670 inode
= d_inode(dentry
);
1673 spin_unlock(&configfs_dirent_lock
);
1675 ino
= iunique(sb
, 2);
1677 name
= configfs_get_name(next
);
1680 if (!dir_emit(ctx
, name
, len
, ino
,
1681 fs_umode_to_dtype(next
->s_mode
)))
1684 spin_lock(&configfs_dirent_lock
);
1689 spin_unlock(&configfs_dirent_lock
);
1693 static loff_t
configfs_dir_lseek(struct file
*file
, loff_t offset
, int whence
)
1695 struct dentry
* dentry
= file
->f_path
.dentry
;
1699 offset
+= file
->f_pos
;
1708 if (offset
!= file
->f_pos
) {
1709 file
->f_pos
= offset
;
1710 if (file
->f_pos
>= 2) {
1711 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
1712 struct configfs_dirent
*cursor
= file
->private_data
;
1713 struct list_head
*p
;
1714 loff_t n
= file
->f_pos
- 2;
1716 spin_lock(&configfs_dirent_lock
);
1717 list_del(&cursor
->s_sibling
);
1718 p
= sd
->s_children
.next
;
1719 while (n
&& p
!= &sd
->s_children
) {
1720 struct configfs_dirent
*next
;
1721 next
= list_entry(p
, struct configfs_dirent
,
1723 if (next
->s_element
)
1727 list_add_tail(&cursor
->s_sibling
, p
);
1728 spin_unlock(&configfs_dirent_lock
);
1734 const struct file_operations configfs_dir_operations
= {
1735 .open
= configfs_dir_open
,
1736 .release
= configfs_dir_close
,
1737 .llseek
= configfs_dir_lseek
,
1738 .read
= generic_read_dir
,
1739 .iterate_shared
= configfs_readdir
,
1743 * configfs_register_group - creates a parent-child relation between two groups
1744 * @parent_group: parent group
1745 * @group: child group
1747 * link groups, creates dentry for the child and attaches it to the
1750 * Return: 0 on success, negative errno code on error
1752 int configfs_register_group(struct config_group
*parent_group
,
1753 struct config_group
*group
)
1755 struct configfs_subsystem
*subsys
= parent_group
->cg_subsys
;
1756 struct dentry
*parent
;
1757 struct configfs_fragment
*frag
;
1760 frag
= new_fragment();
1764 mutex_lock(&subsys
->su_mutex
);
1765 link_group(parent_group
, group
);
1766 mutex_unlock(&subsys
->su_mutex
);
1768 parent
= parent_group
->cg_item
.ci_dentry
;
1770 inode_lock_nested(d_inode(parent
), I_MUTEX_PARENT
);
1771 ret
= create_default_group(parent_group
, group
, frag
);
1775 spin_lock(&configfs_dirent_lock
);
1776 configfs_dir_set_ready(group
->cg_item
.ci_dentry
->d_fsdata
);
1777 spin_unlock(&configfs_dirent_lock
);
1778 inode_unlock(d_inode(parent
));
1782 inode_unlock(d_inode(parent
));
1783 mutex_lock(&subsys
->su_mutex
);
1784 unlink_group(group
);
1785 mutex_unlock(&subsys
->su_mutex
);
1789 EXPORT_SYMBOL(configfs_register_group
);
1792 * configfs_unregister_group() - unregisters a child group from its parent
1793 * @group: parent group to be unregistered
1795 * Undoes configfs_register_group()
1797 void configfs_unregister_group(struct config_group
*group
)
1799 struct configfs_subsystem
*subsys
= group
->cg_subsys
;
1800 struct dentry
*dentry
= group
->cg_item
.ci_dentry
;
1801 struct dentry
*parent
= group
->cg_item
.ci_parent
->ci_dentry
;
1802 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
1803 struct configfs_fragment
*frag
= sd
->s_frag
;
1805 down_write(&frag
->frag_sem
);
1806 frag
->frag_dead
= true;
1807 up_write(&frag
->frag_sem
);
1809 inode_lock_nested(d_inode(parent
), I_MUTEX_PARENT
);
1810 spin_lock(&configfs_dirent_lock
);
1811 configfs_detach_prep(dentry
, NULL
);
1812 spin_unlock(&configfs_dirent_lock
);
1814 configfs_detach_group(&group
->cg_item
);
1815 d_inode(dentry
)->i_flags
|= S_DEAD
;
1818 fsnotify_rmdir(d_inode(parent
), dentry
);
1819 inode_unlock(d_inode(parent
));
1823 mutex_lock(&subsys
->su_mutex
);
1824 unlink_group(group
);
1825 mutex_unlock(&subsys
->su_mutex
);
1827 EXPORT_SYMBOL(configfs_unregister_group
);
1830 * configfs_register_default_group() - allocates and registers a child group
1831 * @parent_group: parent group
1832 * @name: child group name
1833 * @item_type: child item type description
1835 * boilerplate to allocate and register a child group with its parent. We need
1836 * kzalloc'ed memory because child's default_group is initially empty.
1838 * Return: allocated config group or ERR_PTR() on error
1840 struct config_group
*
1841 configfs_register_default_group(struct config_group
*parent_group
,
1843 const struct config_item_type
*item_type
)
1846 struct config_group
*group
;
1848 group
= kzalloc(sizeof(*group
), GFP_KERNEL
);
1850 return ERR_PTR(-ENOMEM
);
1851 config_group_init_type_name(group
, name
, item_type
);
1853 ret
= configfs_register_group(parent_group
, group
);
1856 return ERR_PTR(ret
);
1860 EXPORT_SYMBOL(configfs_register_default_group
);
1863 * configfs_unregister_default_group() - unregisters and frees a child group
1864 * @group: the group to act on
1866 void configfs_unregister_default_group(struct config_group
*group
)
1868 configfs_unregister_group(group
);
1871 EXPORT_SYMBOL(configfs_unregister_default_group
);
1873 int configfs_register_subsystem(struct configfs_subsystem
*subsys
)
1876 struct config_group
*group
= &subsys
->su_group
;
1877 struct dentry
*dentry
;
1878 struct dentry
*root
;
1879 struct configfs_dirent
*sd
;
1880 struct configfs_fragment
*frag
;
1882 frag
= new_fragment();
1886 root
= configfs_pin_fs();
1889 return PTR_ERR(root
);
1892 if (!group
->cg_item
.ci_name
)
1893 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
1895 sd
= root
->d_fsdata
;
1896 mutex_lock(&configfs_subsystem_mutex
);
1897 link_group(to_config_group(sd
->s_element
), group
);
1898 mutex_unlock(&configfs_subsystem_mutex
);
1900 inode_lock_nested(d_inode(root
), I_MUTEX_PARENT
);
1903 dentry
= d_alloc_name(root
, group
->cg_item
.ci_name
);
1905 d_add(dentry
, NULL
);
1907 err
= configfs_dirent_exists(dentry
);
1909 err
= configfs_attach_group(sd
->s_element
,
1913 BUG_ON(d_inode(dentry
));
1917 spin_lock(&configfs_dirent_lock
);
1918 configfs_dir_set_ready(dentry
->d_fsdata
);
1919 spin_unlock(&configfs_dirent_lock
);
1923 inode_unlock(d_inode(root
));
1926 mutex_lock(&configfs_subsystem_mutex
);
1927 unlink_group(group
);
1928 mutex_unlock(&configfs_subsystem_mutex
);
1929 configfs_release_fs();
1936 void configfs_unregister_subsystem(struct configfs_subsystem
*subsys
)
1938 struct config_group
*group
= &subsys
->su_group
;
1939 struct dentry
*dentry
= group
->cg_item
.ci_dentry
;
1940 struct dentry
*root
= dentry
->d_sb
->s_root
;
1941 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
1942 struct configfs_fragment
*frag
= sd
->s_frag
;
1944 if (dentry
->d_parent
!= root
) {
1945 pr_err("Tried to unregister non-subsystem!\n");
1949 down_write(&frag
->frag_sem
);
1950 frag
->frag_dead
= true;
1951 up_write(&frag
->frag_sem
);
1953 inode_lock_nested(d_inode(root
),
1955 inode_lock_nested(d_inode(dentry
), I_MUTEX_CHILD
);
1956 mutex_lock(&configfs_symlink_mutex
);
1957 spin_lock(&configfs_dirent_lock
);
1958 if (configfs_detach_prep(dentry
, NULL
)) {
1959 pr_err("Tried to unregister non-empty subsystem!\n");
1961 spin_unlock(&configfs_dirent_lock
);
1962 mutex_unlock(&configfs_symlink_mutex
);
1963 configfs_detach_group(&group
->cg_item
);
1964 d_inode(dentry
)->i_flags
|= S_DEAD
;
1966 inode_unlock(d_inode(dentry
));
1969 fsnotify_rmdir(d_inode(root
), dentry
);
1971 inode_unlock(d_inode(root
));
1975 mutex_lock(&configfs_subsystem_mutex
);
1976 unlink_group(group
);
1977 mutex_unlock(&configfs_subsystem_mutex
);
1978 configfs_release_fs();
1981 EXPORT_SYMBOL(configfs_register_subsystem
);
1982 EXPORT_SYMBOL(configfs_unregister_subsystem
);