1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
4 * dir.c - Operations for configfs directories.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA.
22 * sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
24 * configfs Copyright (C) 2005 Oracle. All rights reserved.
30 #include <linux/mount.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/err.h>
35 #include <linux/configfs.h>
36 #include "configfs_internal.h"
38 DECLARE_RWSEM(configfs_rename_sem
);
40 * Protects mutations of configfs_dirent linkage together with proper i_mutex
41 * Also protects mutations of symlinks linkage to target configfs_dirent
42 * Mutators of configfs_dirent linkage must *both* have the proper inode locked
43 * and configfs_dirent_lock locked, in that order.
44 * This allows one to safely traverse configfs_dirent trees and symlinks without
45 * having to lock inodes.
47 * Protects setting of CONFIGFS_USET_DROPPING: checking the flag
48 * unlocked is not reliable unless in detach_groups() called from
49 * rmdir()/unregister() and from configfs_attach_group()
51 DEFINE_SPINLOCK(configfs_dirent_lock
);
53 static void configfs_d_iput(struct dentry
* dentry
,
56 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
59 BUG_ON(sd
->s_dentry
!= dentry
);
60 /* Coordinate with configfs_readdir */
61 spin_lock(&configfs_dirent_lock
);
63 spin_unlock(&configfs_dirent_lock
);
70 * We _must_ delete our dentries on last dput, as the chain-to-parent
71 * behavior is required to clear the parents of default_groups.
73 static int configfs_d_delete(const struct dentry
*dentry
)
78 const struct dentry_operations configfs_dentry_ops
= {
79 .d_iput
= configfs_d_iput
,
80 /* simple_delete_dentry() isn't exported */
81 .d_delete
= configfs_d_delete
,
87 * Helpers to make lockdep happy with our recursive locking of default groups'
88 * inodes (see configfs_attach_group() and configfs_detach_group()).
89 * We put default groups i_mutexes in separate classes according to their depth
90 * from the youngest non-default group ancestor.
92 * For a non-default group A having default groups A/B, A/C, and A/C/D, default
93 * groups A/B and A/C will have their inode's mutex in class
94 * default_group_class[0], and default group A/C/D will be in
95 * default_group_class[1].
97 * The lock classes are declared and assigned in inode.c, according to the
99 * The s_depth value is initialized to -1, adjusted to >= 0 when attaching
100 * default groups, and reset to -1 when all default groups are attached. During
101 * attachment, if configfs_create() sees s_depth > 0, the lock class of the new
102 * inode's mutex is set to default_group_class[s_depth - 1].
105 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
110 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
111 struct configfs_dirent
*sd
)
113 int parent_depth
= parent_sd
->s_depth
;
115 if (parent_depth
>= 0)
116 sd
->s_depth
= parent_depth
+ 1;
120 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
123 * item's i_mutex class is already setup, so s_depth is now only
124 * used to set new sub-directories s_depth, which is always done
125 * with item's i_mutex locked.
128 * sd->s_depth == -1 iff we are a non default group.
129 * else (we are a default group) sd->s_depth > 0 (see
132 if (sd
->s_depth
== -1)
134 * We are a non default group and we are going to create
141 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
143 /* We will not create default groups anymore. */
147 #else /* CONFIG_LOCKDEP */
149 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
153 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
154 struct configfs_dirent
*sd
)
159 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
164 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
168 #endif /* CONFIG_LOCKDEP */
171 * Allocates a new configfs_dirent and links it to the parent configfs_dirent
173 static struct configfs_dirent
*configfs_new_dirent(struct configfs_dirent
*parent_sd
,
174 void *element
, int type
)
176 struct configfs_dirent
* sd
;
178 sd
= kmem_cache_zalloc(configfs_dir_cachep
, GFP_KERNEL
);
180 return ERR_PTR(-ENOMEM
);
182 atomic_set(&sd
->s_count
, 1);
183 INIT_LIST_HEAD(&sd
->s_links
);
184 INIT_LIST_HEAD(&sd
->s_children
);
185 sd
->s_element
= element
;
187 configfs_init_dirent_depth(sd
);
188 spin_lock(&configfs_dirent_lock
);
189 if (parent_sd
->s_type
& CONFIGFS_USET_DROPPING
) {
190 spin_unlock(&configfs_dirent_lock
);
191 kmem_cache_free(configfs_dir_cachep
, sd
);
192 return ERR_PTR(-ENOENT
);
194 list_add(&sd
->s_sibling
, &parent_sd
->s_children
);
195 spin_unlock(&configfs_dirent_lock
);
202 * Return -EEXIST if there is already a configfs element with the same
203 * name for the same parent.
205 * called with parent inode's i_mutex held
207 static int configfs_dirent_exists(struct configfs_dirent
*parent_sd
,
208 const unsigned char *new)
210 struct configfs_dirent
* sd
;
212 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
214 const unsigned char *existing
= configfs_get_name(sd
);
215 if (strcmp(existing
, new))
226 int configfs_make_dirent(struct configfs_dirent
* parent_sd
,
227 struct dentry
* dentry
, void * element
,
228 umode_t mode
, int type
)
230 struct configfs_dirent
* sd
;
232 sd
= configfs_new_dirent(parent_sd
, element
, type
);
237 sd
->s_dentry
= dentry
;
239 dentry
->d_fsdata
= configfs_get(sd
);
244 static int init_dir(struct inode
* inode
)
246 inode
->i_op
= &configfs_dir_inode_operations
;
247 inode
->i_fop
= &configfs_dir_operations
;
249 /* directory inodes start off with i_nlink == 2 (for "." entry) */
254 static int configfs_init_file(struct inode
* inode
)
256 inode
->i_size
= PAGE_SIZE
;
257 inode
->i_fop
= &configfs_file_operations
;
261 static int init_symlink(struct inode
* inode
)
263 inode
->i_op
= &configfs_symlink_inode_operations
;
267 static int create_dir(struct config_item
*k
, struct dentry
*d
)
270 umode_t mode
= S_IFDIR
| S_IRWXU
| S_IRUGO
| S_IXUGO
;
271 struct dentry
*p
= d
->d_parent
;
275 error
= configfs_dirent_exists(p
->d_fsdata
, d
->d_name
.name
);
277 error
= configfs_make_dirent(p
->d_fsdata
, d
, k
, mode
,
278 CONFIGFS_DIR
| CONFIGFS_USET_CREATING
);
280 configfs_set_dir_dirent_depth(p
->d_fsdata
, d
->d_fsdata
);
281 error
= configfs_create(d
, mode
, init_dir
);
283 inc_nlink(p
->d_inode
);
285 struct configfs_dirent
*sd
= d
->d_fsdata
;
287 spin_lock(&configfs_dirent_lock
);
288 list_del_init(&sd
->s_sibling
);
289 spin_unlock(&configfs_dirent_lock
);
299 * configfs_create_dir - create a directory for an config_item.
300 * @item: config_itemwe're creating directory for.
301 * @dentry: config_item's dentry.
303 * Note: user-created entries won't be allowed under this new directory
304 * until it is validated by configfs_dir_set_ready()
307 static int configfs_create_dir(struct config_item
* item
, struct dentry
*dentry
)
309 int error
= create_dir(item
, dentry
);
311 item
->ci_dentry
= dentry
;
316 * Allow userspace to create new entries under a new directory created with
317 * configfs_create_dir(), and under all of its chidlren directories recursively.
318 * @sd configfs_dirent of the new directory to validate
320 * Caller must hold configfs_dirent_lock.
322 static void configfs_dir_set_ready(struct configfs_dirent
*sd
)
324 struct configfs_dirent
*child_sd
;
326 sd
->s_type
&= ~CONFIGFS_USET_CREATING
;
327 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
)
328 if (child_sd
->s_type
& CONFIGFS_USET_CREATING
)
329 configfs_dir_set_ready(child_sd
);
333 * Check that a directory does not belong to a directory hierarchy being
334 * attached and not validated yet.
335 * @sd configfs_dirent of the directory to check
337 * @return non-zero iff the directory was validated
339 * Note: takes configfs_dirent_lock, so the result may change from false to true
340 * in two consecutive calls, but never from true to false.
342 int configfs_dirent_is_ready(struct configfs_dirent
*sd
)
346 spin_lock(&configfs_dirent_lock
);
347 ret
= !(sd
->s_type
& CONFIGFS_USET_CREATING
);
348 spin_unlock(&configfs_dirent_lock
);
353 int configfs_create_link(struct configfs_symlink
*sl
,
354 struct dentry
*parent
,
355 struct dentry
*dentry
)
358 umode_t mode
= S_IFLNK
| S_IRWXUGO
;
360 err
= configfs_make_dirent(parent
->d_fsdata
, dentry
, sl
, mode
,
363 err
= configfs_create(dentry
, mode
, init_symlink
);
365 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
367 spin_lock(&configfs_dirent_lock
);
368 list_del_init(&sd
->s_sibling
);
369 spin_unlock(&configfs_dirent_lock
);
377 static void remove_dir(struct dentry
* d
)
379 struct dentry
* parent
= dget(d
->d_parent
);
380 struct configfs_dirent
* sd
;
383 spin_lock(&configfs_dirent_lock
);
384 list_del_init(&sd
->s_sibling
);
385 spin_unlock(&configfs_dirent_lock
);
388 simple_rmdir(parent
->d_inode
,d
);
390 pr_debug(" o %s removing done (%d)\n",d
->d_name
.name
, d_count(d
));
396 * configfs_remove_dir - remove an config_item's directory.
397 * @item: config_item we're removing.
399 * The only thing special about this is that we remove any files in
400 * the directory before we remove the directory, and we've inlined
401 * what used to be configfs_rmdir() below, instead of calling separately.
403 * Caller holds the mutex of the item's inode
406 static void configfs_remove_dir(struct config_item
* item
)
408 struct dentry
* dentry
= dget(item
->ci_dentry
);
415 * Drop reference from dget() on entrance.
421 /* attaches attribute's configfs_dirent to the dentry corresponding to the
424 static int configfs_attach_attr(struct configfs_dirent
* sd
, struct dentry
* dentry
)
426 struct configfs_attribute
* attr
= sd
->s_element
;
429 dentry
->d_fsdata
= configfs_get(sd
);
430 sd
->s_dentry
= dentry
;
431 error
= configfs_create(dentry
, (attr
->ca_mode
& S_IALLUGO
) | S_IFREG
,
443 static struct dentry
* configfs_lookup(struct inode
*dir
,
444 struct dentry
*dentry
,
447 struct configfs_dirent
* parent_sd
= dentry
->d_parent
->d_fsdata
;
448 struct configfs_dirent
* sd
;
453 * Fake invisibility if dir belongs to a group/default groups hierarchy
456 * This forbids userspace to read/write attributes of items which may
457 * not complete their initialization, since the dentries of the
458 * attributes won't be instantiated.
461 if (!configfs_dirent_is_ready(parent_sd
))
464 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
465 if (sd
->s_type
& CONFIGFS_NOT_PINNED
) {
466 const unsigned char * name
= configfs_get_name(sd
);
468 if (strcmp(name
, dentry
->d_name
.name
))
472 err
= configfs_attach_attr(sd
, dentry
);
479 * If it doesn't exist and it isn't a NOT_PINNED item,
480 * it must be negative.
482 if (dentry
->d_name
.len
> NAME_MAX
)
483 return ERR_PTR(-ENAMETOOLONG
);
493 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
494 * attributes and are removed by rmdir(). We recurse, setting
495 * CONFIGFS_USET_DROPPING on all children that are candidates for
497 * If there is an error, the caller will reset the flags via
498 * configfs_detach_rollback().
500 static int configfs_detach_prep(struct dentry
*dentry
, struct mutex
**wait_mutex
)
502 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
503 struct configfs_dirent
*sd
;
506 /* Mark that we're trying to drop the group */
507 parent_sd
->s_type
|= CONFIGFS_USET_DROPPING
;
510 if (!list_empty(&parent_sd
->s_links
))
514 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
515 if (!sd
->s_element
||
516 (sd
->s_type
& CONFIGFS_NOT_PINNED
))
518 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
) {
519 /* Abort if racing with mkdir() */
520 if (sd
->s_type
& CONFIGFS_USET_IN_MKDIR
) {
522 *wait_mutex
= &sd
->s_dentry
->d_inode
->i_mutex
;
527 * Yup, recursive. If there's a problem, blame
528 * deep nesting of default_groups
530 ret
= configfs_detach_prep(sd
->s_dentry
, wait_mutex
);
544 * Walk the tree, resetting CONFIGFS_USET_DROPPING wherever it was
547 static void configfs_detach_rollback(struct dentry
*dentry
)
549 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
550 struct configfs_dirent
*sd
;
552 parent_sd
->s_type
&= ~CONFIGFS_USET_DROPPING
;
554 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
)
555 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
556 configfs_detach_rollback(sd
->s_dentry
);
559 static void detach_attrs(struct config_item
* item
)
561 struct dentry
* dentry
= dget(item
->ci_dentry
);
562 struct configfs_dirent
* parent_sd
;
563 struct configfs_dirent
* sd
, * tmp
;
568 pr_debug("configfs %s: dropping attrs for dir\n",
569 dentry
->d_name
.name
);
571 parent_sd
= dentry
->d_fsdata
;
572 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
573 if (!sd
->s_element
|| !(sd
->s_type
& CONFIGFS_NOT_PINNED
))
575 spin_lock(&configfs_dirent_lock
);
576 list_del_init(&sd
->s_sibling
);
577 spin_unlock(&configfs_dirent_lock
);
578 configfs_drop_dentry(sd
, dentry
);
583 * Drop reference from dget() on entrance.
588 static int populate_attrs(struct config_item
*item
)
590 struct config_item_type
*t
= item
->ci_type
;
591 struct configfs_attribute
*attr
;
598 for (i
= 0; (attr
= t
->ct_attrs
[i
]) != NULL
; i
++) {
599 if ((error
= configfs_create_file(item
, attr
)))
610 static int configfs_attach_group(struct config_item
*parent_item
,
611 struct config_item
*item
,
612 struct dentry
*dentry
);
613 static void configfs_detach_group(struct config_item
*item
);
615 static void detach_groups(struct config_group
*group
)
617 struct dentry
* dentry
= dget(group
->cg_item
.ci_dentry
);
618 struct dentry
*child
;
619 struct configfs_dirent
*parent_sd
;
620 struct configfs_dirent
*sd
, *tmp
;
625 parent_sd
= dentry
->d_fsdata
;
626 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
627 if (!sd
->s_element
||
628 !(sd
->s_type
& CONFIGFS_USET_DEFAULT
))
631 child
= sd
->s_dentry
;
633 mutex_lock(&child
->d_inode
->i_mutex
);
635 configfs_detach_group(sd
->s_element
);
636 child
->d_inode
->i_flags
|= S_DEAD
;
639 mutex_unlock(&child
->d_inode
->i_mutex
);
646 * Drop reference from dget() on entrance.
652 * This fakes mkdir(2) on a default_groups[] entry. It
653 * creates a dentry, attachs it, and then does fixup
656 * We could, perhaps, tweak our parent's ->mkdir for a minute and
657 * try using vfs_mkdir. Just a thought.
659 static int create_default_group(struct config_group
*parent_group
,
660 struct config_group
*group
)
663 struct configfs_dirent
*sd
;
664 /* We trust the caller holds a reference to parent */
665 struct dentry
*child
, *parent
= parent_group
->cg_item
.ci_dentry
;
667 if (!group
->cg_item
.ci_name
)
668 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
671 child
= d_alloc_name(parent
, group
->cg_item
.ci_name
);
675 ret
= configfs_attach_group(&parent_group
->cg_item
,
676 &group
->cg_item
, child
);
678 sd
= child
->d_fsdata
;
679 sd
->s_type
|= CONFIGFS_USET_DEFAULT
;
681 BUG_ON(child
->d_inode
);
690 static int populate_groups(struct config_group
*group
)
692 struct config_group
*new_group
;
696 if (group
->default_groups
) {
697 for (i
= 0; group
->default_groups
[i
]; i
++) {
698 new_group
= group
->default_groups
[i
];
700 ret
= create_default_group(group
, new_group
);
702 detach_groups(group
);
712 * All of link_obj/unlink_obj/link_group/unlink_group require that
713 * subsys->su_mutex is held.
716 static void unlink_obj(struct config_item
*item
)
718 struct config_group
*group
;
720 group
= item
->ci_group
;
722 list_del_init(&item
->ci_entry
);
724 item
->ci_group
= NULL
;
725 item
->ci_parent
= NULL
;
727 /* Drop the reference for ci_entry */
728 config_item_put(item
);
730 /* Drop the reference for ci_parent */
731 config_group_put(group
);
735 static void link_obj(struct config_item
*parent_item
, struct config_item
*item
)
738 * Parent seems redundant with group, but it makes certain
739 * traversals much nicer.
741 item
->ci_parent
= parent_item
;
744 * We hold a reference on the parent for the child's ci_parent
747 item
->ci_group
= config_group_get(to_config_group(parent_item
));
748 list_add_tail(&item
->ci_entry
, &item
->ci_group
->cg_children
);
751 * We hold a reference on the child for ci_entry on the parent's
754 config_item_get(item
);
757 static void unlink_group(struct config_group
*group
)
760 struct config_group
*new_group
;
762 if (group
->default_groups
) {
763 for (i
= 0; group
->default_groups
[i
]; i
++) {
764 new_group
= group
->default_groups
[i
];
765 unlink_group(new_group
);
769 group
->cg_subsys
= NULL
;
770 unlink_obj(&group
->cg_item
);
773 static void link_group(struct config_group
*parent_group
, struct config_group
*group
)
776 struct config_group
*new_group
;
777 struct configfs_subsystem
*subsys
= NULL
; /* gcc is a turd */
779 link_obj(&parent_group
->cg_item
, &group
->cg_item
);
781 if (parent_group
->cg_subsys
)
782 subsys
= parent_group
->cg_subsys
;
783 else if (configfs_is_root(&parent_group
->cg_item
))
784 subsys
= to_configfs_subsystem(group
);
787 group
->cg_subsys
= subsys
;
789 if (group
->default_groups
) {
790 for (i
= 0; group
->default_groups
[i
]; i
++) {
791 new_group
= group
->default_groups
[i
];
792 link_group(group
, new_group
);
798 * The goal is that configfs_attach_item() (and
799 * configfs_attach_group()) can be called from either the VFS or this
800 * module. That is, they assume that the items have been created,
801 * the dentry allocated, and the dcache is all ready to go.
803 * If they fail, they must clean up after themselves as if they
804 * had never been called. The caller (VFS or local function) will
805 * handle cleaning up the dcache bits.
807 * configfs_detach_group() and configfs_detach_item() behave similarly on
808 * the way out. They assume that the proper semaphores are held, they
809 * clean up the configfs items, and they expect their callers will
810 * handle the dcache bits.
812 static int configfs_attach_item(struct config_item
*parent_item
,
813 struct config_item
*item
,
814 struct dentry
*dentry
)
818 ret
= configfs_create_dir(item
, dentry
);
820 ret
= populate_attrs(item
);
823 * We are going to remove an inode and its dentry but
824 * the VFS may already have hit and used them. Thus,
825 * we must lock them as rmdir() would.
827 mutex_lock(&dentry
->d_inode
->i_mutex
);
828 configfs_remove_dir(item
);
829 dentry
->d_inode
->i_flags
|= S_DEAD
;
831 mutex_unlock(&dentry
->d_inode
->i_mutex
);
839 /* Caller holds the mutex of the item's inode */
840 static void configfs_detach_item(struct config_item
*item
)
843 configfs_remove_dir(item
);
846 static int configfs_attach_group(struct config_item
*parent_item
,
847 struct config_item
*item
,
848 struct dentry
*dentry
)
851 struct configfs_dirent
*sd
;
853 ret
= configfs_attach_item(parent_item
, item
, dentry
);
855 sd
= dentry
->d_fsdata
;
856 sd
->s_type
|= CONFIGFS_USET_DIR
;
859 * FYI, we're faking mkdir in populate_groups()
860 * We must lock the group's inode to avoid races with the VFS
861 * which can already hit the inode and try to add/remove entries
864 * We must also lock the inode to remove it safely in case of
865 * error, as rmdir() would.
867 mutex_lock_nested(&dentry
->d_inode
->i_mutex
, I_MUTEX_CHILD
);
868 configfs_adjust_dir_dirent_depth_before_populate(sd
);
869 ret
= populate_groups(to_config_group(item
));
871 configfs_detach_item(item
);
872 dentry
->d_inode
->i_flags
|= S_DEAD
;
875 configfs_adjust_dir_dirent_depth_after_populate(sd
);
876 mutex_unlock(&dentry
->d_inode
->i_mutex
);
884 /* Caller holds the mutex of the group's inode */
885 static void configfs_detach_group(struct config_item
*item
)
887 detach_groups(to_config_group(item
));
888 configfs_detach_item(item
);
892 * After the item has been detached from the filesystem view, we are
893 * ready to tear it out of the hierarchy. Notify the client before
894 * we do that so they can perform any cleanup that requires
895 * navigating the hierarchy. A client does not need to provide this
896 * callback. The subsystem semaphore MUST be held by the caller, and
897 * references must be valid for both items. It also assumes the
898 * caller has validated ci_type.
900 static void client_disconnect_notify(struct config_item
*parent_item
,
901 struct config_item
*item
)
903 struct config_item_type
*type
;
905 type
= parent_item
->ci_type
;
908 if (type
->ct_group_ops
&& type
->ct_group_ops
->disconnect_notify
)
909 type
->ct_group_ops
->disconnect_notify(to_config_group(parent_item
),
914 * Drop the initial reference from make_item()/make_group()
915 * This function assumes that reference is held on item
916 * and that item holds a valid reference to the parent. Also, it
917 * assumes the caller has validated ci_type.
919 static void client_drop_item(struct config_item
*parent_item
,
920 struct config_item
*item
)
922 struct config_item_type
*type
;
924 type
= parent_item
->ci_type
;
928 * If ->drop_item() exists, it is responsible for the
931 if (type
->ct_group_ops
&& type
->ct_group_ops
->drop_item
)
932 type
->ct_group_ops
->drop_item(to_config_group(parent_item
),
935 config_item_put(item
);
939 static void configfs_dump_one(struct configfs_dirent
*sd
, int level
)
941 printk(KERN_INFO
"%*s\"%s\":\n", level
, " ", configfs_get_name(sd
));
943 #define type_print(_type) if (sd->s_type & _type) printk(KERN_INFO "%*s %s\n", level, " ", #_type);
944 type_print(CONFIGFS_ROOT
);
945 type_print(CONFIGFS_DIR
);
946 type_print(CONFIGFS_ITEM_ATTR
);
947 type_print(CONFIGFS_ITEM_LINK
);
948 type_print(CONFIGFS_USET_DIR
);
949 type_print(CONFIGFS_USET_DEFAULT
);
950 type_print(CONFIGFS_USET_DROPPING
);
954 static int configfs_dump(struct configfs_dirent
*sd
, int level
)
956 struct configfs_dirent
*child_sd
;
959 configfs_dump_one(sd
, level
);
961 if (!(sd
->s_type
& (CONFIGFS_DIR
|CONFIGFS_ROOT
)))
964 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
965 ret
= configfs_dump(child_sd
, level
+ 2);
976 * configfs_depend_item() and configfs_undepend_item()
978 * WARNING: Do not call these from a configfs callback!
980 * This describes these functions and their helpers.
982 * Allow another kernel system to depend on a config_item. If this
983 * happens, the item cannot go away until the dependent can live without
984 * it. The idea is to give client modules as simple an interface as
985 * possible. When a system asks them to depend on an item, they just
986 * call configfs_depend_item(). If the item is live and the client
987 * driver is in good shape, we'll happily do the work for them.
989 * Why is the locking complex? Because configfs uses the VFS to handle
990 * all locking, but this function is called outside the normal
991 * VFS->configfs path. So it must take VFS locks to prevent the
992 * VFS->configfs stuff (configfs_mkdir(), configfs_rmdir(), etc). This is
993 * why you can't call these functions underneath configfs callbacks.
995 * Note, btw, that this can be called at *any* time, even when a configfs
996 * subsystem isn't registered, or when configfs is loading or unloading.
997 * Just like configfs_register_subsystem(). So we take the same
998 * precautions. We pin the filesystem. We lock configfs_dirent_lock.
999 * If we can find the target item in the
1000 * configfs tree, it must be part of the subsystem tree as well, so we
1001 * do not need the subsystem semaphore. Holding configfs_dirent_lock helps
1002 * locking out mkdir() and rmdir(), who might be racing us.
1006 * configfs_depend_prep()
1008 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
1009 * attributes. This is similar but not the same to configfs_detach_prep().
1010 * Note that configfs_detach_prep() expects the parent to be locked when it
1011 * is called, but we lock the parent *inside* configfs_depend_prep(). We
1012 * do that so we can unlock it if we find nothing.
1014 * Here we do a depth-first search of the dentry hierarchy looking for
1016 * We deliberately ignore items tagged as dropping since they are virtually
1017 * dead, as well as items in the middle of attachment since they virtually
1018 * do not exist yet. This completes the locking out of racing mkdir() and
1020 * Note: subdirectories in the middle of attachment start with s_type =
1021 * CONFIGFS_DIR|CONFIGFS_USET_CREATING set by create_dir(). When
1022 * CONFIGFS_USET_CREATING is set, we ignore the item. The actual set of
1023 * s_type is in configfs_new_dirent(), which has configfs_dirent_lock.
1025 * If the target is not found, -ENOENT is bubbled up.
1027 * This adds a requirement that all config_items be unique!
1029 * This is recursive. There isn't
1030 * much on the stack, though, so folks that need this function - be careful
1031 * about your stack! Patches will be accepted to make it iterative.
1033 static int configfs_depend_prep(struct dentry
*origin
,
1034 struct config_item
*target
)
1036 struct configfs_dirent
*child_sd
, *sd
;
1039 BUG_ON(!origin
|| !origin
->d_fsdata
);
1040 sd
= origin
->d_fsdata
;
1042 if (sd
->s_element
== target
) /* Boo-yah */
1045 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
1046 if ((child_sd
->s_type
& CONFIGFS_DIR
) &&
1047 !(child_sd
->s_type
& CONFIGFS_USET_DROPPING
) &&
1048 !(child_sd
->s_type
& CONFIGFS_USET_CREATING
)) {
1049 ret
= configfs_depend_prep(child_sd
->s_dentry
,
1052 goto out
; /* Child path boo-yah */
1056 /* We looped all our children and didn't find target */
1063 int configfs_depend_item(struct configfs_subsystem
*subsys
,
1064 struct config_item
*target
)
1067 struct configfs_dirent
*p
, *root_sd
, *subsys_sd
= NULL
;
1068 struct config_item
*s_item
= &subsys
->su_group
.cg_item
;
1069 struct dentry
*root
;
1072 * Pin the configfs filesystem. This means we can safely access
1073 * the root of the configfs filesystem.
1075 root
= configfs_pin_fs();
1077 return PTR_ERR(root
);
1080 * Next, lock the root directory. We're going to check that the
1081 * subsystem is really registered, and so we need to lock out
1082 * configfs_[un]register_subsystem().
1084 mutex_lock(&root
->d_inode
->i_mutex
);
1086 root_sd
= root
->d_fsdata
;
1088 list_for_each_entry(p
, &root_sd
->s_children
, s_sibling
) {
1089 if (p
->s_type
& CONFIGFS_DIR
) {
1090 if (p
->s_element
== s_item
) {
1102 /* Ok, now we can trust subsys/s_item */
1104 spin_lock(&configfs_dirent_lock
);
1105 /* Scan the tree, return 0 if found */
1106 ret
= configfs_depend_prep(subsys_sd
->s_dentry
, target
);
1108 goto out_unlock_dirent_lock
;
1111 * We are sure that the item is not about to be removed by rmdir(), and
1112 * not in the middle of attachment by mkdir().
1114 p
= target
->ci_dentry
->d_fsdata
;
1115 p
->s_dependent_count
+= 1;
1117 out_unlock_dirent_lock
:
1118 spin_unlock(&configfs_dirent_lock
);
1120 mutex_unlock(&root
->d_inode
->i_mutex
);
1123 * If we succeeded, the fs is pinned via other methods. If not,
1124 * we're done with it anyway. So release_fs() is always right.
1126 configfs_release_fs();
1130 EXPORT_SYMBOL(configfs_depend_item
);
1133 * Release the dependent linkage. This is much simpler than
1134 * configfs_depend_item() because we know that that the client driver is
1135 * pinned, thus the subsystem is pinned, and therefore configfs is pinned.
1137 void configfs_undepend_item(struct configfs_subsystem
*subsys
,
1138 struct config_item
*target
)
1140 struct configfs_dirent
*sd
;
1143 * Since we can trust everything is pinned, we just need
1144 * configfs_dirent_lock.
1146 spin_lock(&configfs_dirent_lock
);
1148 sd
= target
->ci_dentry
->d_fsdata
;
1149 BUG_ON(sd
->s_dependent_count
< 1);
1151 sd
->s_dependent_count
-= 1;
1154 * After this unlock, we cannot trust the item to stay alive!
1155 * DO NOT REFERENCE item after this unlock.
1157 spin_unlock(&configfs_dirent_lock
);
1159 EXPORT_SYMBOL(configfs_undepend_item
);
1161 static int configfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
1165 struct config_group
*group
= NULL
;
1166 struct config_item
*item
= NULL
;
1167 struct config_item
*parent_item
;
1168 struct configfs_subsystem
*subsys
;
1169 struct configfs_dirent
*sd
;
1170 struct config_item_type
*type
;
1171 struct module
*subsys_owner
= NULL
, *new_item_owner
= NULL
;
1174 sd
= dentry
->d_parent
->d_fsdata
;
1177 * Fake invisibility if dir belongs to a group/default groups hierarchy
1180 if (!configfs_dirent_is_ready(sd
)) {
1185 if (!(sd
->s_type
& CONFIGFS_USET_DIR
)) {
1190 /* Get a working ref for the duration of this function */
1191 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1192 type
= parent_item
->ci_type
;
1193 subsys
= to_config_group(parent_item
)->cg_subsys
;
1196 if (!type
|| !type
->ct_group_ops
||
1197 (!type
->ct_group_ops
->make_group
&&
1198 !type
->ct_group_ops
->make_item
)) {
1199 ret
= -EPERM
; /* Lack-of-mkdir returns -EPERM */
1204 * The subsystem may belong to a different module than the item
1205 * being created. We don't want to safely pin the new item but
1206 * fail to pin the subsystem it sits under.
1208 if (!subsys
->su_group
.cg_item
.ci_type
) {
1212 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1213 if (!try_module_get(subsys_owner
)) {
1218 name
= kmalloc(dentry
->d_name
.len
+ 1, GFP_KERNEL
);
1221 goto out_subsys_put
;
1224 snprintf(name
, dentry
->d_name
.len
+ 1, "%s", dentry
->d_name
.name
);
1226 mutex_lock(&subsys
->su_mutex
);
1227 if (type
->ct_group_ops
->make_group
) {
1228 group
= type
->ct_group_ops
->make_group(to_config_group(parent_item
), name
);
1230 group
= ERR_PTR(-ENOMEM
);
1231 if (!IS_ERR(group
)) {
1232 link_group(to_config_group(parent_item
), group
);
1233 item
= &group
->cg_item
;
1235 ret
= PTR_ERR(group
);
1237 item
= type
->ct_group_ops
->make_item(to_config_group(parent_item
), name
);
1239 item
= ERR_PTR(-ENOMEM
);
1241 link_obj(parent_item
, item
);
1243 ret
= PTR_ERR(item
);
1245 mutex_unlock(&subsys
->su_mutex
);
1250 * If ret != 0, then link_obj() was never called.
1251 * There are no extra references to clean up.
1253 goto out_subsys_put
;
1257 * link_obj() has been called (via link_group() for groups).
1258 * From here on out, errors must clean that up.
1261 type
= item
->ci_type
;
1267 new_item_owner
= type
->ct_owner
;
1268 if (!try_module_get(new_item_owner
)) {
1274 * I hate doing it this way, but if there is
1275 * an error, module_put() probably should
1276 * happen after any cleanup.
1281 * Make racing rmdir() fail if it did not tag parent with
1282 * CONFIGFS_USET_DROPPING
1283 * Note: if CONFIGFS_USET_DROPPING is already set, attach_group() will
1284 * fail and let rmdir() terminate correctly
1286 spin_lock(&configfs_dirent_lock
);
1287 /* This will make configfs_detach_prep() fail */
1288 sd
->s_type
|= CONFIGFS_USET_IN_MKDIR
;
1289 spin_unlock(&configfs_dirent_lock
);
1292 ret
= configfs_attach_group(parent_item
, item
, dentry
);
1294 ret
= configfs_attach_item(parent_item
, item
, dentry
);
1296 spin_lock(&configfs_dirent_lock
);
1297 sd
->s_type
&= ~CONFIGFS_USET_IN_MKDIR
;
1299 configfs_dir_set_ready(dentry
->d_fsdata
);
1300 spin_unlock(&configfs_dirent_lock
);
1304 /* Tear down everything we built up */
1305 mutex_lock(&subsys
->su_mutex
);
1307 client_disconnect_notify(parent_item
, item
);
1309 unlink_group(group
);
1312 client_drop_item(parent_item
, item
);
1314 mutex_unlock(&subsys
->su_mutex
);
1317 module_put(new_item_owner
);
1322 module_put(subsys_owner
);
1326 * link_obj()/link_group() took a reference from child->parent,
1327 * so the parent is safely pinned. We can drop our working
1330 config_item_put(parent_item
);
1336 static int configfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
1338 struct config_item
*parent_item
;
1339 struct config_item
*item
;
1340 struct configfs_subsystem
*subsys
;
1341 struct configfs_dirent
*sd
;
1342 struct module
*subsys_owner
= NULL
, *dead_item_owner
= NULL
;
1345 sd
= dentry
->d_fsdata
;
1346 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
1349 /* Get a working ref until we have the child */
1350 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1351 subsys
= to_config_group(parent_item
)->cg_subsys
;
1354 if (!parent_item
->ci_type
) {
1355 config_item_put(parent_item
);
1359 /* configfs_mkdir() shouldn't have allowed this */
1360 BUG_ON(!subsys
->su_group
.cg_item
.ci_type
);
1361 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1364 * Ensure that no racing symlink() will make detach_prep() fail while
1365 * the new link is temporarily attached
1368 struct mutex
*wait_mutex
;
1370 mutex_lock(&configfs_symlink_mutex
);
1371 spin_lock(&configfs_dirent_lock
);
1373 * Here's where we check for dependents. We're protected by
1374 * configfs_dirent_lock.
1375 * If no dependent, atomically tag the item as dropping.
1377 ret
= sd
->s_dependent_count
? -EBUSY
: 0;
1379 ret
= configfs_detach_prep(dentry
, &wait_mutex
);
1381 configfs_detach_rollback(dentry
);
1383 spin_unlock(&configfs_dirent_lock
);
1384 mutex_unlock(&configfs_symlink_mutex
);
1387 if (ret
!= -EAGAIN
) {
1388 config_item_put(parent_item
);
1392 /* Wait until the racing operation terminates */
1393 mutex_lock(wait_mutex
);
1394 mutex_unlock(wait_mutex
);
1396 } while (ret
== -EAGAIN
);
1398 /* Get a working ref for the duration of this function */
1399 item
= configfs_get_config_item(dentry
);
1401 /* Drop reference from above, item already holds one. */
1402 config_item_put(parent_item
);
1405 dead_item_owner
= item
->ci_type
->ct_owner
;
1407 if (sd
->s_type
& CONFIGFS_USET_DIR
) {
1408 configfs_detach_group(item
);
1410 mutex_lock(&subsys
->su_mutex
);
1411 client_disconnect_notify(parent_item
, item
);
1412 unlink_group(to_config_group(item
));
1414 configfs_detach_item(item
);
1416 mutex_lock(&subsys
->su_mutex
);
1417 client_disconnect_notify(parent_item
, item
);
1421 client_drop_item(parent_item
, item
);
1422 mutex_unlock(&subsys
->su_mutex
);
1424 /* Drop our reference from above */
1425 config_item_put(item
);
1427 module_put(dead_item_owner
);
1428 module_put(subsys_owner
);
1433 const struct inode_operations configfs_dir_inode_operations
= {
1434 .mkdir
= configfs_mkdir
,
1435 .rmdir
= configfs_rmdir
,
1436 .symlink
= configfs_symlink
,
1437 .unlink
= configfs_unlink
,
1438 .lookup
= configfs_lookup
,
1439 .setattr
= configfs_setattr
,
1442 const struct inode_operations configfs_root_inode_operations
= {
1443 .lookup
= configfs_lookup
,
1444 .setattr
= configfs_setattr
,
1448 int configfs_rename_dir(struct config_item
* item
, const char *new_name
)
1451 struct dentry
* new_dentry
, * parent
;
1453 if (!strcmp(config_item_name(item
), new_name
))
1459 down_write(&configfs_rename_sem
);
1460 parent
= item
->parent
->dentry
;
1462 mutex_lock(&parent
->d_inode
->i_mutex
);
1464 new_dentry
= lookup_one_len(new_name
, parent
, strlen(new_name
));
1465 if (!IS_ERR(new_dentry
)) {
1466 if (!new_dentry
->d_inode
) {
1467 error
= config_item_set_name(item
, "%s", new_name
);
1469 d_add(new_dentry
, NULL
);
1470 d_move(item
->dentry
, new_dentry
);
1473 d_delete(new_dentry
);
1478 mutex_unlock(&parent
->d_inode
->i_mutex
);
1479 up_write(&configfs_rename_sem
);
1485 static int configfs_dir_open(struct inode
*inode
, struct file
*file
)
1487 struct dentry
* dentry
= file
->f_path
.dentry
;
1488 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1491 mutex_lock(&dentry
->d_inode
->i_mutex
);
1493 * Fake invisibility if dir belongs to a group/default groups hierarchy
1497 if (configfs_dirent_is_ready(parent_sd
)) {
1498 file
->private_data
= configfs_new_dirent(parent_sd
, NULL
, 0);
1499 if (IS_ERR(file
->private_data
))
1500 err
= PTR_ERR(file
->private_data
);
1504 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1509 static int configfs_dir_close(struct inode
*inode
, struct file
*file
)
1511 struct dentry
* dentry
= file
->f_path
.dentry
;
1512 struct configfs_dirent
* cursor
= file
->private_data
;
1514 mutex_lock(&dentry
->d_inode
->i_mutex
);
1515 spin_lock(&configfs_dirent_lock
);
1516 list_del_init(&cursor
->s_sibling
);
1517 spin_unlock(&configfs_dirent_lock
);
1518 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1520 release_configfs_dirent(cursor
);
1525 /* Relationship between s_mode and the DT_xxx types */
1526 static inline unsigned char dt_type(struct configfs_dirent
*sd
)
1528 return (sd
->s_mode
>> 12) & 15;
1531 static int configfs_readdir(struct file
*file
, struct dir_context
*ctx
)
1533 struct dentry
*dentry
= file
->f_path
.dentry
;
1534 struct super_block
*sb
= dentry
->d_sb
;
1535 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1536 struct configfs_dirent
*cursor
= file
->private_data
;
1537 struct list_head
*p
, *q
= &cursor
->s_sibling
;
1540 if (!dir_emit_dots(file
, ctx
))
1542 if (ctx
->pos
== 2) {
1543 spin_lock(&configfs_dirent_lock
);
1544 list_move(q
, &parent_sd
->s_children
);
1545 spin_unlock(&configfs_dirent_lock
);
1547 for (p
= q
->next
; p
!= &parent_sd
->s_children
; p
= p
->next
) {
1548 struct configfs_dirent
*next
;
1551 struct inode
*inode
= NULL
;
1553 next
= list_entry(p
, struct configfs_dirent
, s_sibling
);
1554 if (!next
->s_element
)
1557 name
= configfs_get_name(next
);
1561 * We'll have a dentry and an inode for
1562 * PINNED items and for open attribute
1563 * files. We lock here to prevent a race
1564 * with configfs_d_iput() clearing
1565 * s_dentry before calling iput().
1567 * Why do we go to the trouble? If
1568 * someone has an attribute file open,
1569 * the inode number should match until
1570 * they close it. Beyond that, we don't
1573 spin_lock(&configfs_dirent_lock
);
1574 dentry
= next
->s_dentry
;
1576 inode
= dentry
->d_inode
;
1579 spin_unlock(&configfs_dirent_lock
);
1581 ino
= iunique(sb
, 2);
1583 if (!dir_emit(ctx
, name
, len
, ino
, dt_type(next
)))
1586 spin_lock(&configfs_dirent_lock
);
1588 spin_unlock(&configfs_dirent_lock
);
1595 static loff_t
configfs_dir_lseek(struct file
*file
, loff_t offset
, int whence
)
1597 struct dentry
* dentry
= file
->f_path
.dentry
;
1599 mutex_lock(&dentry
->d_inode
->i_mutex
);
1602 offset
+= file
->f_pos
;
1607 mutex_unlock(&file_inode(file
)->i_mutex
);
1610 if (offset
!= file
->f_pos
) {
1611 file
->f_pos
= offset
;
1612 if (file
->f_pos
>= 2) {
1613 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
1614 struct configfs_dirent
*cursor
= file
->private_data
;
1615 struct list_head
*p
;
1616 loff_t n
= file
->f_pos
- 2;
1618 spin_lock(&configfs_dirent_lock
);
1619 list_del(&cursor
->s_sibling
);
1620 p
= sd
->s_children
.next
;
1621 while (n
&& p
!= &sd
->s_children
) {
1622 struct configfs_dirent
*next
;
1623 next
= list_entry(p
, struct configfs_dirent
,
1625 if (next
->s_element
)
1629 list_add_tail(&cursor
->s_sibling
, p
);
1630 spin_unlock(&configfs_dirent_lock
);
1633 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1637 const struct file_operations configfs_dir_operations
= {
1638 .open
= configfs_dir_open
,
1639 .release
= configfs_dir_close
,
1640 .llseek
= configfs_dir_lseek
,
1641 .read
= generic_read_dir
,
1642 .iterate
= configfs_readdir
,
1645 int configfs_register_subsystem(struct configfs_subsystem
*subsys
)
1648 struct config_group
*group
= &subsys
->su_group
;
1649 struct dentry
*dentry
;
1650 struct dentry
*root
;
1651 struct configfs_dirent
*sd
;
1653 root
= configfs_pin_fs();
1655 return PTR_ERR(root
);
1657 if (!group
->cg_item
.ci_name
)
1658 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
1660 sd
= root
->d_fsdata
;
1661 link_group(to_config_group(sd
->s_element
), group
);
1663 mutex_lock_nested(&root
->d_inode
->i_mutex
, I_MUTEX_PARENT
);
1666 dentry
= d_alloc_name(root
, group
->cg_item
.ci_name
);
1668 d_add(dentry
, NULL
);
1670 err
= configfs_attach_group(sd
->s_element
, &group
->cg_item
,
1673 BUG_ON(dentry
->d_inode
);
1677 spin_lock(&configfs_dirent_lock
);
1678 configfs_dir_set_ready(dentry
->d_fsdata
);
1679 spin_unlock(&configfs_dirent_lock
);
1683 mutex_unlock(&root
->d_inode
->i_mutex
);
1686 unlink_group(group
);
1687 configfs_release_fs();
1693 void configfs_unregister_subsystem(struct configfs_subsystem
*subsys
)
1695 struct config_group
*group
= &subsys
->su_group
;
1696 struct dentry
*dentry
= group
->cg_item
.ci_dentry
;
1697 struct dentry
*root
= dentry
->d_sb
->s_root
;
1699 if (dentry
->d_parent
!= root
) {
1700 printk(KERN_ERR
"configfs: Tried to unregister non-subsystem!\n");
1704 mutex_lock_nested(&root
->d_inode
->i_mutex
,
1706 mutex_lock_nested(&dentry
->d_inode
->i_mutex
, I_MUTEX_CHILD
);
1707 mutex_lock(&configfs_symlink_mutex
);
1708 spin_lock(&configfs_dirent_lock
);
1709 if (configfs_detach_prep(dentry
, NULL
)) {
1710 printk(KERN_ERR
"configfs: Tried to unregister non-empty subsystem!\n");
1712 spin_unlock(&configfs_dirent_lock
);
1713 mutex_unlock(&configfs_symlink_mutex
);
1714 configfs_detach_group(&group
->cg_item
);
1715 dentry
->d_inode
->i_flags
|= S_DEAD
;
1717 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1721 mutex_unlock(&root
->d_inode
->i_mutex
);
1725 unlink_group(group
);
1726 configfs_release_fs();
1729 EXPORT_SYMBOL(configfs_register_subsystem
);
1730 EXPORT_SYMBOL(configfs_unregister_subsystem
);