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
);
67 * We _must_ delete our dentries on last dput, as the chain-to-parent
68 * behavior is required to clear the parents of default_groups.
70 static int configfs_d_delete(const struct dentry
*dentry
)
75 const struct dentry_operations configfs_dentry_ops
= {
76 .d_iput
= configfs_d_iput
,
77 /* simple_delete_dentry() isn't exported */
78 .d_delete
= configfs_d_delete
,
84 * Helpers to make lockdep happy with our recursive locking of default groups'
85 * inodes (see configfs_attach_group() and configfs_detach_group()).
86 * We put default groups i_mutexes in separate classes according to their depth
87 * from the youngest non-default group ancestor.
89 * For a non-default group A having default groups A/B, A/C, and A/C/D, default
90 * groups A/B and A/C will have their inode's mutex in class
91 * default_group_class[0], and default group A/C/D will be in
92 * default_group_class[1].
94 * The lock classes are declared and assigned in inode.c, according to the
96 * The s_depth value is initialized to -1, adjusted to >= 0 when attaching
97 * default groups, and reset to -1 when all default groups are attached. During
98 * attachment, if configfs_create() sees s_depth > 0, the lock class of the new
99 * inode's mutex is set to default_group_class[s_depth - 1].
102 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
107 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
108 struct configfs_dirent
*sd
)
110 int parent_depth
= parent_sd
->s_depth
;
112 if (parent_depth
>= 0)
113 sd
->s_depth
= parent_depth
+ 1;
117 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
120 * item's i_mutex class is already setup, so s_depth is now only
121 * used to set new sub-directories s_depth, which is always done
122 * with item's i_mutex locked.
125 * sd->s_depth == -1 iff we are a non default group.
126 * else (we are a default group) sd->s_depth > 0 (see
129 if (sd
->s_depth
== -1)
131 * We are a non default group and we are going to create
138 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
140 /* We will not create default groups anymore. */
144 #else /* CONFIG_LOCKDEP */
146 static void configfs_init_dirent_depth(struct configfs_dirent
*sd
)
150 static void configfs_set_dir_dirent_depth(struct configfs_dirent
*parent_sd
,
151 struct configfs_dirent
*sd
)
156 configfs_adjust_dir_dirent_depth_before_populate(struct configfs_dirent
*sd
)
161 configfs_adjust_dir_dirent_depth_after_populate(struct configfs_dirent
*sd
)
165 #endif /* CONFIG_LOCKDEP */
168 * Allocates a new configfs_dirent and links it to the parent configfs_dirent
170 static struct configfs_dirent
*configfs_new_dirent(struct configfs_dirent
*parent_sd
,
171 void *element
, int type
)
173 struct configfs_dirent
* sd
;
175 sd
= kmem_cache_zalloc(configfs_dir_cachep
, GFP_KERNEL
);
177 return ERR_PTR(-ENOMEM
);
179 atomic_set(&sd
->s_count
, 1);
180 INIT_LIST_HEAD(&sd
->s_links
);
181 INIT_LIST_HEAD(&sd
->s_children
);
182 sd
->s_element
= element
;
184 configfs_init_dirent_depth(sd
);
185 spin_lock(&configfs_dirent_lock
);
186 if (parent_sd
->s_type
& CONFIGFS_USET_DROPPING
) {
187 spin_unlock(&configfs_dirent_lock
);
188 kmem_cache_free(configfs_dir_cachep
, sd
);
189 return ERR_PTR(-ENOENT
);
191 list_add(&sd
->s_sibling
, &parent_sd
->s_children
);
192 spin_unlock(&configfs_dirent_lock
);
199 * Return -EEXIST if there is already a configfs element with the same
200 * name for the same parent.
202 * called with parent inode's i_mutex held
204 static int configfs_dirent_exists(struct configfs_dirent
*parent_sd
,
205 const unsigned char *new)
207 struct configfs_dirent
* sd
;
209 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
211 const unsigned char *existing
= configfs_get_name(sd
);
212 if (strcmp(existing
, new))
223 int configfs_make_dirent(struct configfs_dirent
* parent_sd
,
224 struct dentry
* dentry
, void * element
,
225 umode_t mode
, int type
)
227 struct configfs_dirent
* sd
;
229 sd
= configfs_new_dirent(parent_sd
, element
, type
);
234 sd
->s_dentry
= dentry
;
236 dentry
->d_fsdata
= configfs_get(sd
);
241 static int init_dir(struct inode
* inode
)
243 inode
->i_op
= &configfs_dir_inode_operations
;
244 inode
->i_fop
= &configfs_dir_operations
;
246 /* directory inodes start off with i_nlink == 2 (for "." entry) */
251 static int configfs_init_file(struct inode
* inode
)
253 inode
->i_size
= PAGE_SIZE
;
254 inode
->i_fop
= &configfs_file_operations
;
258 static int init_symlink(struct inode
* inode
)
260 inode
->i_op
= &configfs_symlink_inode_operations
;
264 static int create_dir(struct config_item
* k
, struct dentry
* p
,
268 umode_t mode
= S_IFDIR
| S_IRWXU
| S_IRUGO
| S_IXUGO
;
270 error
= configfs_dirent_exists(p
->d_fsdata
, d
->d_name
.name
);
272 error
= configfs_make_dirent(p
->d_fsdata
, d
, k
, mode
,
273 CONFIGFS_DIR
| CONFIGFS_USET_CREATING
);
275 configfs_set_dir_dirent_depth(p
->d_fsdata
, d
->d_fsdata
);
276 error
= configfs_create(d
, mode
, init_dir
);
278 inc_nlink(p
->d_inode
);
280 struct configfs_dirent
*sd
= d
->d_fsdata
;
282 spin_lock(&configfs_dirent_lock
);
283 list_del_init(&sd
->s_sibling
);
284 spin_unlock(&configfs_dirent_lock
);
294 * configfs_create_dir - create a directory for an config_item.
295 * @item: config_itemwe're creating directory for.
296 * @dentry: config_item's dentry.
298 * Note: user-created entries won't be allowed under this new directory
299 * until it is validated by configfs_dir_set_ready()
302 static int configfs_create_dir(struct config_item
* item
, struct dentry
*dentry
)
304 struct dentry
* parent
;
310 parent
= item
->ci_parent
->ci_dentry
;
311 else if (configfs_mount
&& configfs_mount
->mnt_sb
)
312 parent
= configfs_mount
->mnt_sb
->s_root
;
316 error
= create_dir(item
,parent
,dentry
);
318 item
->ci_dentry
= dentry
;
323 * Allow userspace to create new entries under a new directory created with
324 * configfs_create_dir(), and under all of its chidlren directories recursively.
325 * @sd configfs_dirent of the new directory to validate
327 * Caller must hold configfs_dirent_lock.
329 static void configfs_dir_set_ready(struct configfs_dirent
*sd
)
331 struct configfs_dirent
*child_sd
;
333 sd
->s_type
&= ~CONFIGFS_USET_CREATING
;
334 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
)
335 if (child_sd
->s_type
& CONFIGFS_USET_CREATING
)
336 configfs_dir_set_ready(child_sd
);
340 * Check that a directory does not belong to a directory hierarchy being
341 * attached and not validated yet.
342 * @sd configfs_dirent of the directory to check
344 * @return non-zero iff the directory was validated
346 * Note: takes configfs_dirent_lock, so the result may change from false to true
347 * in two consecutive calls, but never from true to false.
349 int configfs_dirent_is_ready(struct configfs_dirent
*sd
)
353 spin_lock(&configfs_dirent_lock
);
354 ret
= !(sd
->s_type
& CONFIGFS_USET_CREATING
);
355 spin_unlock(&configfs_dirent_lock
);
360 int configfs_create_link(struct configfs_symlink
*sl
,
361 struct dentry
*parent
,
362 struct dentry
*dentry
)
365 umode_t mode
= S_IFLNK
| S_IRWXUGO
;
367 err
= configfs_make_dirent(parent
->d_fsdata
, dentry
, sl
, mode
,
370 err
= configfs_create(dentry
, mode
, init_symlink
);
372 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
374 spin_lock(&configfs_dirent_lock
);
375 list_del_init(&sd
->s_sibling
);
376 spin_unlock(&configfs_dirent_lock
);
384 static void remove_dir(struct dentry
* d
)
386 struct dentry
* parent
= dget(d
->d_parent
);
387 struct configfs_dirent
* sd
;
390 spin_lock(&configfs_dirent_lock
);
391 list_del_init(&sd
->s_sibling
);
392 spin_unlock(&configfs_dirent_lock
);
395 simple_rmdir(parent
->d_inode
,d
);
397 pr_debug(" o %s removing done (%d)\n",d
->d_name
.name
, d
->d_count
);
403 * configfs_remove_dir - remove an config_item's directory.
404 * @item: config_item we're removing.
406 * The only thing special about this is that we remove any files in
407 * the directory before we remove the directory, and we've inlined
408 * what used to be configfs_rmdir() below, instead of calling separately.
410 * Caller holds the mutex of the item's inode
413 static void configfs_remove_dir(struct config_item
* item
)
415 struct dentry
* dentry
= dget(item
->ci_dentry
);
422 * Drop reference from dget() on entrance.
428 /* attaches attribute's configfs_dirent to the dentry corresponding to the
431 static int configfs_attach_attr(struct configfs_dirent
* sd
, struct dentry
* dentry
)
433 struct configfs_attribute
* attr
= sd
->s_element
;
436 dentry
->d_fsdata
= configfs_get(sd
);
437 sd
->s_dentry
= dentry
;
438 error
= configfs_create(dentry
, (attr
->ca_mode
& S_IALLUGO
) | S_IFREG
,
450 static struct dentry
* configfs_lookup(struct inode
*dir
,
451 struct dentry
*dentry
,
452 struct nameidata
*nd
)
454 struct configfs_dirent
* parent_sd
= dentry
->d_parent
->d_fsdata
;
455 struct configfs_dirent
* sd
;
460 * Fake invisibility if dir belongs to a group/default groups hierarchy
463 * This forbids userspace to read/write attributes of items which may
464 * not complete their initialization, since the dentries of the
465 * attributes won't be instantiated.
468 if (!configfs_dirent_is_ready(parent_sd
))
471 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
472 if (sd
->s_type
& CONFIGFS_NOT_PINNED
) {
473 const unsigned char * name
= configfs_get_name(sd
);
475 if (strcmp(name
, dentry
->d_name
.name
))
479 err
= configfs_attach_attr(sd
, dentry
);
486 * If it doesn't exist and it isn't a NOT_PINNED item,
487 * it must be negative.
489 if (dentry
->d_name
.len
> NAME_MAX
)
490 return ERR_PTR(-ENAMETOOLONG
);
500 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
501 * attributes and are removed by rmdir(). We recurse, setting
502 * CONFIGFS_USET_DROPPING on all children that are candidates for
504 * If there is an error, the caller will reset the flags via
505 * configfs_detach_rollback().
507 static int configfs_detach_prep(struct dentry
*dentry
, struct mutex
**wait_mutex
)
509 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
510 struct configfs_dirent
*sd
;
513 /* Mark that we're trying to drop the group */
514 parent_sd
->s_type
|= CONFIGFS_USET_DROPPING
;
517 if (!list_empty(&parent_sd
->s_links
))
521 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
) {
522 if (!sd
->s_element
||
523 (sd
->s_type
& CONFIGFS_NOT_PINNED
))
525 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
) {
526 /* Abort if racing with mkdir() */
527 if (sd
->s_type
& CONFIGFS_USET_IN_MKDIR
) {
529 *wait_mutex
= &sd
->s_dentry
->d_inode
->i_mutex
;
534 * Yup, recursive. If there's a problem, blame
535 * deep nesting of default_groups
537 ret
= configfs_detach_prep(sd
->s_dentry
, wait_mutex
);
551 * Walk the tree, resetting CONFIGFS_USET_DROPPING wherever it was
554 static void configfs_detach_rollback(struct dentry
*dentry
)
556 struct configfs_dirent
*parent_sd
= dentry
->d_fsdata
;
557 struct configfs_dirent
*sd
;
559 parent_sd
->s_type
&= ~CONFIGFS_USET_DROPPING
;
561 list_for_each_entry(sd
, &parent_sd
->s_children
, s_sibling
)
562 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
563 configfs_detach_rollback(sd
->s_dentry
);
566 static void detach_attrs(struct config_item
* item
)
568 struct dentry
* dentry
= dget(item
->ci_dentry
);
569 struct configfs_dirent
* parent_sd
;
570 struct configfs_dirent
* sd
, * tmp
;
575 pr_debug("configfs %s: dropping attrs for dir\n",
576 dentry
->d_name
.name
);
578 parent_sd
= dentry
->d_fsdata
;
579 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
580 if (!sd
->s_element
|| !(sd
->s_type
& CONFIGFS_NOT_PINNED
))
582 spin_lock(&configfs_dirent_lock
);
583 list_del_init(&sd
->s_sibling
);
584 spin_unlock(&configfs_dirent_lock
);
585 configfs_drop_dentry(sd
, dentry
);
590 * Drop reference from dget() on entrance.
595 static int populate_attrs(struct config_item
*item
)
597 struct config_item_type
*t
= item
->ci_type
;
598 struct configfs_attribute
*attr
;
605 for (i
= 0; (attr
= t
->ct_attrs
[i
]) != NULL
; i
++) {
606 if ((error
= configfs_create_file(item
, attr
)))
617 static int configfs_attach_group(struct config_item
*parent_item
,
618 struct config_item
*item
,
619 struct dentry
*dentry
);
620 static void configfs_detach_group(struct config_item
*item
);
622 static void detach_groups(struct config_group
*group
)
624 struct dentry
* dentry
= dget(group
->cg_item
.ci_dentry
);
625 struct dentry
*child
;
626 struct configfs_dirent
*parent_sd
;
627 struct configfs_dirent
*sd
, *tmp
;
632 parent_sd
= dentry
->d_fsdata
;
633 list_for_each_entry_safe(sd
, tmp
, &parent_sd
->s_children
, s_sibling
) {
634 if (!sd
->s_element
||
635 !(sd
->s_type
& CONFIGFS_USET_DEFAULT
))
638 child
= sd
->s_dentry
;
640 mutex_lock(&child
->d_inode
->i_mutex
);
642 configfs_detach_group(sd
->s_element
);
643 child
->d_inode
->i_flags
|= S_DEAD
;
646 mutex_unlock(&child
->d_inode
->i_mutex
);
653 * Drop reference from dget() on entrance.
659 * This fakes mkdir(2) on a default_groups[] entry. It
660 * creates a dentry, attachs it, and then does fixup
663 * We could, perhaps, tweak our parent's ->mkdir for a minute and
664 * try using vfs_mkdir. Just a thought.
666 static int create_default_group(struct config_group
*parent_group
,
667 struct config_group
*group
)
671 struct configfs_dirent
*sd
;
672 /* We trust the caller holds a reference to parent */
673 struct dentry
*child
, *parent
= parent_group
->cg_item
.ci_dentry
;
675 if (!group
->cg_item
.ci_name
)
676 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
677 name
.name
= group
->cg_item
.ci_name
;
678 name
.len
= strlen(name
.name
);
679 name
.hash
= full_name_hash(name
.name
, name
.len
);
682 child
= d_alloc(parent
, &name
);
686 ret
= configfs_attach_group(&parent_group
->cg_item
,
687 &group
->cg_item
, child
);
689 sd
= child
->d_fsdata
;
690 sd
->s_type
|= CONFIGFS_USET_DEFAULT
;
700 static int populate_groups(struct config_group
*group
)
702 struct config_group
*new_group
;
706 if (group
->default_groups
) {
707 for (i
= 0; group
->default_groups
[i
]; i
++) {
708 new_group
= group
->default_groups
[i
];
710 ret
= create_default_group(group
, new_group
);
712 detach_groups(group
);
722 * All of link_obj/unlink_obj/link_group/unlink_group require that
723 * subsys->su_mutex is held.
726 static void unlink_obj(struct config_item
*item
)
728 struct config_group
*group
;
730 group
= item
->ci_group
;
732 list_del_init(&item
->ci_entry
);
734 item
->ci_group
= NULL
;
735 item
->ci_parent
= NULL
;
737 /* Drop the reference for ci_entry */
738 config_item_put(item
);
740 /* Drop the reference for ci_parent */
741 config_group_put(group
);
745 static void link_obj(struct config_item
*parent_item
, struct config_item
*item
)
748 * Parent seems redundant with group, but it makes certain
749 * traversals much nicer.
751 item
->ci_parent
= parent_item
;
754 * We hold a reference on the parent for the child's ci_parent
757 item
->ci_group
= config_group_get(to_config_group(parent_item
));
758 list_add_tail(&item
->ci_entry
, &item
->ci_group
->cg_children
);
761 * We hold a reference on the child for ci_entry on the parent's
764 config_item_get(item
);
767 static void unlink_group(struct config_group
*group
)
770 struct config_group
*new_group
;
772 if (group
->default_groups
) {
773 for (i
= 0; group
->default_groups
[i
]; i
++) {
774 new_group
= group
->default_groups
[i
];
775 unlink_group(new_group
);
779 group
->cg_subsys
= NULL
;
780 unlink_obj(&group
->cg_item
);
783 static void link_group(struct config_group
*parent_group
, struct config_group
*group
)
786 struct config_group
*new_group
;
787 struct configfs_subsystem
*subsys
= NULL
; /* gcc is a turd */
789 link_obj(&parent_group
->cg_item
, &group
->cg_item
);
791 if (parent_group
->cg_subsys
)
792 subsys
= parent_group
->cg_subsys
;
793 else if (configfs_is_root(&parent_group
->cg_item
))
794 subsys
= to_configfs_subsystem(group
);
797 group
->cg_subsys
= subsys
;
799 if (group
->default_groups
) {
800 for (i
= 0; group
->default_groups
[i
]; i
++) {
801 new_group
= group
->default_groups
[i
];
802 link_group(group
, new_group
);
808 * The goal is that configfs_attach_item() (and
809 * configfs_attach_group()) can be called from either the VFS or this
810 * module. That is, they assume that the items have been created,
811 * the dentry allocated, and the dcache is all ready to go.
813 * If they fail, they must clean up after themselves as if they
814 * had never been called. The caller (VFS or local function) will
815 * handle cleaning up the dcache bits.
817 * configfs_detach_group() and configfs_detach_item() behave similarly on
818 * the way out. They assume that the proper semaphores are held, they
819 * clean up the configfs items, and they expect their callers will
820 * handle the dcache bits.
822 static int configfs_attach_item(struct config_item
*parent_item
,
823 struct config_item
*item
,
824 struct dentry
*dentry
)
828 ret
= configfs_create_dir(item
, dentry
);
830 ret
= populate_attrs(item
);
833 * We are going to remove an inode and its dentry but
834 * the VFS may already have hit and used them. Thus,
835 * we must lock them as rmdir() would.
837 mutex_lock(&dentry
->d_inode
->i_mutex
);
838 configfs_remove_dir(item
);
839 dentry
->d_inode
->i_flags
|= S_DEAD
;
841 mutex_unlock(&dentry
->d_inode
->i_mutex
);
849 /* Caller holds the mutex of the item's inode */
850 static void configfs_detach_item(struct config_item
*item
)
853 configfs_remove_dir(item
);
856 static int configfs_attach_group(struct config_item
*parent_item
,
857 struct config_item
*item
,
858 struct dentry
*dentry
)
861 struct configfs_dirent
*sd
;
863 ret
= configfs_attach_item(parent_item
, item
, dentry
);
865 sd
= dentry
->d_fsdata
;
866 sd
->s_type
|= CONFIGFS_USET_DIR
;
869 * FYI, we're faking mkdir in populate_groups()
870 * We must lock the group's inode to avoid races with the VFS
871 * which can already hit the inode and try to add/remove entries
874 * We must also lock the inode to remove it safely in case of
875 * error, as rmdir() would.
877 mutex_lock_nested(&dentry
->d_inode
->i_mutex
, I_MUTEX_CHILD
);
878 configfs_adjust_dir_dirent_depth_before_populate(sd
);
879 ret
= populate_groups(to_config_group(item
));
881 configfs_detach_item(item
);
882 dentry
->d_inode
->i_flags
|= S_DEAD
;
885 configfs_adjust_dir_dirent_depth_after_populate(sd
);
886 mutex_unlock(&dentry
->d_inode
->i_mutex
);
894 /* Caller holds the mutex of the group's inode */
895 static void configfs_detach_group(struct config_item
*item
)
897 detach_groups(to_config_group(item
));
898 configfs_detach_item(item
);
902 * After the item has been detached from the filesystem view, we are
903 * ready to tear it out of the hierarchy. Notify the client before
904 * we do that so they can perform any cleanup that requires
905 * navigating the hierarchy. A client does not need to provide this
906 * callback. The subsystem semaphore MUST be held by the caller, and
907 * references must be valid for both items. It also assumes the
908 * caller has validated ci_type.
910 static void client_disconnect_notify(struct config_item
*parent_item
,
911 struct config_item
*item
)
913 struct config_item_type
*type
;
915 type
= parent_item
->ci_type
;
918 if (type
->ct_group_ops
&& type
->ct_group_ops
->disconnect_notify
)
919 type
->ct_group_ops
->disconnect_notify(to_config_group(parent_item
),
924 * Drop the initial reference from make_item()/make_group()
925 * This function assumes that reference is held on item
926 * and that item holds a valid reference to the parent. Also, it
927 * assumes the caller has validated ci_type.
929 static void client_drop_item(struct config_item
*parent_item
,
930 struct config_item
*item
)
932 struct config_item_type
*type
;
934 type
= parent_item
->ci_type
;
938 * If ->drop_item() exists, it is responsible for the
941 if (type
->ct_group_ops
&& type
->ct_group_ops
->drop_item
)
942 type
->ct_group_ops
->drop_item(to_config_group(parent_item
),
945 config_item_put(item
);
949 static void configfs_dump_one(struct configfs_dirent
*sd
, int level
)
951 printk(KERN_INFO
"%*s\"%s\":\n", level
, " ", configfs_get_name(sd
));
953 #define type_print(_type) if (sd->s_type & _type) printk(KERN_INFO "%*s %s\n", level, " ", #_type);
954 type_print(CONFIGFS_ROOT
);
955 type_print(CONFIGFS_DIR
);
956 type_print(CONFIGFS_ITEM_ATTR
);
957 type_print(CONFIGFS_ITEM_LINK
);
958 type_print(CONFIGFS_USET_DIR
);
959 type_print(CONFIGFS_USET_DEFAULT
);
960 type_print(CONFIGFS_USET_DROPPING
);
964 static int configfs_dump(struct configfs_dirent
*sd
, int level
)
966 struct configfs_dirent
*child_sd
;
969 configfs_dump_one(sd
, level
);
971 if (!(sd
->s_type
& (CONFIGFS_DIR
|CONFIGFS_ROOT
)))
974 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
975 ret
= configfs_dump(child_sd
, level
+ 2);
986 * configfs_depend_item() and configfs_undepend_item()
988 * WARNING: Do not call these from a configfs callback!
990 * This describes these functions and their helpers.
992 * Allow another kernel system to depend on a config_item. If this
993 * happens, the item cannot go away until the dependant can live without
994 * it. The idea is to give client modules as simple an interface as
995 * possible. When a system asks them to depend on an item, they just
996 * call configfs_depend_item(). If the item is live and the client
997 * driver is in good shape, we'll happily do the work for them.
999 * Why is the locking complex? Because configfs uses the VFS to handle
1000 * all locking, but this function is called outside the normal
1001 * VFS->configfs path. So it must take VFS locks to prevent the
1002 * VFS->configfs stuff (configfs_mkdir(), configfs_rmdir(), etc). This is
1003 * why you can't call these functions underneath configfs callbacks.
1005 * Note, btw, that this can be called at *any* time, even when a configfs
1006 * subsystem isn't registered, or when configfs is loading or unloading.
1007 * Just like configfs_register_subsystem(). So we take the same
1008 * precautions. We pin the filesystem. We lock configfs_dirent_lock.
1009 * If we can find the target item in the
1010 * configfs tree, it must be part of the subsystem tree as well, so we
1011 * do not need the subsystem semaphore. Holding configfs_dirent_lock helps
1012 * locking out mkdir() and rmdir(), who might be racing us.
1016 * configfs_depend_prep()
1018 * Only subdirectories count here. Files (CONFIGFS_NOT_PINNED) are
1019 * attributes. This is similar but not the same to configfs_detach_prep().
1020 * Note that configfs_detach_prep() expects the parent to be locked when it
1021 * is called, but we lock the parent *inside* configfs_depend_prep(). We
1022 * do that so we can unlock it if we find nothing.
1024 * Here we do a depth-first search of the dentry hierarchy looking for
1026 * We deliberately ignore items tagged as dropping since they are virtually
1027 * dead, as well as items in the middle of attachment since they virtually
1028 * do not exist yet. This completes the locking out of racing mkdir() and
1030 * Note: subdirectories in the middle of attachment start with s_type =
1031 * CONFIGFS_DIR|CONFIGFS_USET_CREATING set by create_dir(). When
1032 * CONFIGFS_USET_CREATING is set, we ignore the item. The actual set of
1033 * s_type is in configfs_new_dirent(), which has configfs_dirent_lock.
1035 * If the target is not found, -ENOENT is bubbled up.
1037 * This adds a requirement that all config_items be unique!
1039 * This is recursive. There isn't
1040 * much on the stack, though, so folks that need this function - be careful
1041 * about your stack! Patches will be accepted to make it iterative.
1043 static int configfs_depend_prep(struct dentry
*origin
,
1044 struct config_item
*target
)
1046 struct configfs_dirent
*child_sd
, *sd
= origin
->d_fsdata
;
1049 BUG_ON(!origin
|| !sd
);
1051 if (sd
->s_element
== target
) /* Boo-yah */
1054 list_for_each_entry(child_sd
, &sd
->s_children
, s_sibling
) {
1055 if ((child_sd
->s_type
& CONFIGFS_DIR
) &&
1056 !(child_sd
->s_type
& CONFIGFS_USET_DROPPING
) &&
1057 !(child_sd
->s_type
& CONFIGFS_USET_CREATING
)) {
1058 ret
= configfs_depend_prep(child_sd
->s_dentry
,
1061 goto out
; /* Child path boo-yah */
1065 /* We looped all our children and didn't find target */
1072 int configfs_depend_item(struct configfs_subsystem
*subsys
,
1073 struct config_item
*target
)
1076 struct configfs_dirent
*p
, *root_sd
, *subsys_sd
= NULL
;
1077 struct config_item
*s_item
= &subsys
->su_group
.cg_item
;
1080 * Pin the configfs filesystem. This means we can safely access
1081 * the root of the configfs filesystem.
1083 ret
= configfs_pin_fs();
1088 * Next, lock the root directory. We're going to check that the
1089 * subsystem is really registered, and so we need to lock out
1090 * configfs_[un]register_subsystem().
1092 mutex_lock(&configfs_sb
->s_root
->d_inode
->i_mutex
);
1094 root_sd
= configfs_sb
->s_root
->d_fsdata
;
1096 list_for_each_entry(p
, &root_sd
->s_children
, s_sibling
) {
1097 if (p
->s_type
& CONFIGFS_DIR
) {
1098 if (p
->s_element
== s_item
) {
1110 /* Ok, now we can trust subsys/s_item */
1112 spin_lock(&configfs_dirent_lock
);
1113 /* Scan the tree, return 0 if found */
1114 ret
= configfs_depend_prep(subsys_sd
->s_dentry
, target
);
1116 goto out_unlock_dirent_lock
;
1119 * We are sure that the item is not about to be removed by rmdir(), and
1120 * not in the middle of attachment by mkdir().
1122 p
= target
->ci_dentry
->d_fsdata
;
1123 p
->s_dependent_count
+= 1;
1125 out_unlock_dirent_lock
:
1126 spin_unlock(&configfs_dirent_lock
);
1128 mutex_unlock(&configfs_sb
->s_root
->d_inode
->i_mutex
);
1131 * If we succeeded, the fs is pinned via other methods. If not,
1132 * we're done with it anyway. So release_fs() is always right.
1134 configfs_release_fs();
1138 EXPORT_SYMBOL(configfs_depend_item
);
1141 * Release the dependent linkage. This is much simpler than
1142 * configfs_depend_item() because we know that that the client driver is
1143 * pinned, thus the subsystem is pinned, and therefore configfs is pinned.
1145 void configfs_undepend_item(struct configfs_subsystem
*subsys
,
1146 struct config_item
*target
)
1148 struct configfs_dirent
*sd
;
1151 * Since we can trust everything is pinned, we just need
1152 * configfs_dirent_lock.
1154 spin_lock(&configfs_dirent_lock
);
1156 sd
= target
->ci_dentry
->d_fsdata
;
1157 BUG_ON(sd
->s_dependent_count
< 1);
1159 sd
->s_dependent_count
-= 1;
1162 * After this unlock, we cannot trust the item to stay alive!
1163 * DO NOT REFERENCE item after this unlock.
1165 spin_unlock(&configfs_dirent_lock
);
1167 EXPORT_SYMBOL(configfs_undepend_item
);
1169 static int configfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
1173 struct config_group
*group
= NULL
;
1174 struct config_item
*item
= NULL
;
1175 struct config_item
*parent_item
;
1176 struct configfs_subsystem
*subsys
;
1177 struct configfs_dirent
*sd
;
1178 struct config_item_type
*type
;
1179 struct module
*subsys_owner
= NULL
, *new_item_owner
= NULL
;
1182 if (dentry
->d_parent
== configfs_sb
->s_root
) {
1187 sd
= dentry
->d_parent
->d_fsdata
;
1190 * Fake invisibility if dir belongs to a group/default groups hierarchy
1193 if (!configfs_dirent_is_ready(sd
)) {
1198 if (!(sd
->s_type
& CONFIGFS_USET_DIR
)) {
1203 /* Get a working ref for the duration of this function */
1204 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1205 type
= parent_item
->ci_type
;
1206 subsys
= to_config_group(parent_item
)->cg_subsys
;
1209 if (!type
|| !type
->ct_group_ops
||
1210 (!type
->ct_group_ops
->make_group
&&
1211 !type
->ct_group_ops
->make_item
)) {
1212 ret
= -EPERM
; /* Lack-of-mkdir returns -EPERM */
1217 * The subsystem may belong to a different module than the item
1218 * being created. We don't want to safely pin the new item but
1219 * fail to pin the subsystem it sits under.
1221 if (!subsys
->su_group
.cg_item
.ci_type
) {
1225 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1226 if (!try_module_get(subsys_owner
)) {
1231 name
= kmalloc(dentry
->d_name
.len
+ 1, GFP_KERNEL
);
1234 goto out_subsys_put
;
1237 snprintf(name
, dentry
->d_name
.len
+ 1, "%s", dentry
->d_name
.name
);
1239 mutex_lock(&subsys
->su_mutex
);
1240 if (type
->ct_group_ops
->make_group
) {
1241 group
= type
->ct_group_ops
->make_group(to_config_group(parent_item
), name
);
1243 group
= ERR_PTR(-ENOMEM
);
1244 if (!IS_ERR(group
)) {
1245 link_group(to_config_group(parent_item
), group
);
1246 item
= &group
->cg_item
;
1248 ret
= PTR_ERR(group
);
1250 item
= type
->ct_group_ops
->make_item(to_config_group(parent_item
), name
);
1252 item
= ERR_PTR(-ENOMEM
);
1254 link_obj(parent_item
, item
);
1256 ret
= PTR_ERR(item
);
1258 mutex_unlock(&subsys
->su_mutex
);
1263 * If ret != 0, then link_obj() was never called.
1264 * There are no extra references to clean up.
1266 goto out_subsys_put
;
1270 * link_obj() has been called (via link_group() for groups).
1271 * From here on out, errors must clean that up.
1274 type
= item
->ci_type
;
1280 new_item_owner
= type
->ct_owner
;
1281 if (!try_module_get(new_item_owner
)) {
1287 * I hate doing it this way, but if there is
1288 * an error, module_put() probably should
1289 * happen after any cleanup.
1294 * Make racing rmdir() fail if it did not tag parent with
1295 * CONFIGFS_USET_DROPPING
1296 * Note: if CONFIGFS_USET_DROPPING is already set, attach_group() will
1297 * fail and let rmdir() terminate correctly
1299 spin_lock(&configfs_dirent_lock
);
1300 /* This will make configfs_detach_prep() fail */
1301 sd
->s_type
|= CONFIGFS_USET_IN_MKDIR
;
1302 spin_unlock(&configfs_dirent_lock
);
1305 ret
= configfs_attach_group(parent_item
, item
, dentry
);
1307 ret
= configfs_attach_item(parent_item
, item
, dentry
);
1309 spin_lock(&configfs_dirent_lock
);
1310 sd
->s_type
&= ~CONFIGFS_USET_IN_MKDIR
;
1312 configfs_dir_set_ready(dentry
->d_fsdata
);
1313 spin_unlock(&configfs_dirent_lock
);
1317 /* Tear down everything we built up */
1318 mutex_lock(&subsys
->su_mutex
);
1320 client_disconnect_notify(parent_item
, item
);
1322 unlink_group(group
);
1325 client_drop_item(parent_item
, item
);
1327 mutex_unlock(&subsys
->su_mutex
);
1330 module_put(new_item_owner
);
1335 module_put(subsys_owner
);
1339 * link_obj()/link_group() took a reference from child->parent,
1340 * so the parent is safely pinned. We can drop our working
1343 config_item_put(parent_item
);
1349 static int configfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
1351 struct config_item
*parent_item
;
1352 struct config_item
*item
;
1353 struct configfs_subsystem
*subsys
;
1354 struct configfs_dirent
*sd
;
1355 struct module
*subsys_owner
= NULL
, *dead_item_owner
= NULL
;
1358 if (dentry
->d_parent
== configfs_sb
->s_root
)
1361 sd
= dentry
->d_fsdata
;
1362 if (sd
->s_type
& CONFIGFS_USET_DEFAULT
)
1365 /* Get a working ref until we have the child */
1366 parent_item
= configfs_get_config_item(dentry
->d_parent
);
1367 subsys
= to_config_group(parent_item
)->cg_subsys
;
1370 if (!parent_item
->ci_type
) {
1371 config_item_put(parent_item
);
1375 /* configfs_mkdir() shouldn't have allowed this */
1376 BUG_ON(!subsys
->su_group
.cg_item
.ci_type
);
1377 subsys_owner
= subsys
->su_group
.cg_item
.ci_type
->ct_owner
;
1380 * Ensure that no racing symlink() will make detach_prep() fail while
1381 * the new link is temporarily attached
1384 struct mutex
*wait_mutex
;
1386 mutex_lock(&configfs_symlink_mutex
);
1387 spin_lock(&configfs_dirent_lock
);
1389 * Here's where we check for dependents. We're protected by
1390 * configfs_dirent_lock.
1391 * If no dependent, atomically tag the item as dropping.
1393 ret
= sd
->s_dependent_count
? -EBUSY
: 0;
1395 ret
= configfs_detach_prep(dentry
, &wait_mutex
);
1397 configfs_detach_rollback(dentry
);
1399 spin_unlock(&configfs_dirent_lock
);
1400 mutex_unlock(&configfs_symlink_mutex
);
1403 if (ret
!= -EAGAIN
) {
1404 config_item_put(parent_item
);
1408 /* Wait until the racing operation terminates */
1409 mutex_lock(wait_mutex
);
1410 mutex_unlock(wait_mutex
);
1412 } while (ret
== -EAGAIN
);
1414 /* Get a working ref for the duration of this function */
1415 item
= configfs_get_config_item(dentry
);
1417 /* Drop reference from above, item already holds one. */
1418 config_item_put(parent_item
);
1421 dead_item_owner
= item
->ci_type
->ct_owner
;
1423 if (sd
->s_type
& CONFIGFS_USET_DIR
) {
1424 configfs_detach_group(item
);
1426 mutex_lock(&subsys
->su_mutex
);
1427 client_disconnect_notify(parent_item
, item
);
1428 unlink_group(to_config_group(item
));
1430 configfs_detach_item(item
);
1432 mutex_lock(&subsys
->su_mutex
);
1433 client_disconnect_notify(parent_item
, item
);
1437 client_drop_item(parent_item
, item
);
1438 mutex_unlock(&subsys
->su_mutex
);
1440 /* Drop our reference from above */
1441 config_item_put(item
);
1443 module_put(dead_item_owner
);
1444 module_put(subsys_owner
);
1449 const struct inode_operations configfs_dir_inode_operations
= {
1450 .mkdir
= configfs_mkdir
,
1451 .rmdir
= configfs_rmdir
,
1452 .symlink
= configfs_symlink
,
1453 .unlink
= configfs_unlink
,
1454 .lookup
= configfs_lookup
,
1455 .setattr
= configfs_setattr
,
1459 int configfs_rename_dir(struct config_item
* item
, const char *new_name
)
1462 struct dentry
* new_dentry
, * parent
;
1464 if (!strcmp(config_item_name(item
), new_name
))
1470 down_write(&configfs_rename_sem
);
1471 parent
= item
->parent
->dentry
;
1473 mutex_lock(&parent
->d_inode
->i_mutex
);
1475 new_dentry
= lookup_one_len(new_name
, parent
, strlen(new_name
));
1476 if (!IS_ERR(new_dentry
)) {
1477 if (!new_dentry
->d_inode
) {
1478 error
= config_item_set_name(item
, "%s", new_name
);
1480 d_add(new_dentry
, NULL
);
1481 d_move(item
->dentry
, new_dentry
);
1484 d_delete(new_dentry
);
1489 mutex_unlock(&parent
->d_inode
->i_mutex
);
1490 up_write(&configfs_rename_sem
);
1496 static int configfs_dir_open(struct inode
*inode
, struct file
*file
)
1498 struct dentry
* dentry
= file
->f_path
.dentry
;
1499 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1502 mutex_lock(&dentry
->d_inode
->i_mutex
);
1504 * Fake invisibility if dir belongs to a group/default groups hierarchy
1508 if (configfs_dirent_is_ready(parent_sd
)) {
1509 file
->private_data
= configfs_new_dirent(parent_sd
, NULL
, 0);
1510 if (IS_ERR(file
->private_data
))
1511 err
= PTR_ERR(file
->private_data
);
1515 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1520 static int configfs_dir_close(struct inode
*inode
, struct file
*file
)
1522 struct dentry
* dentry
= file
->f_path
.dentry
;
1523 struct configfs_dirent
* cursor
= file
->private_data
;
1525 mutex_lock(&dentry
->d_inode
->i_mutex
);
1526 spin_lock(&configfs_dirent_lock
);
1527 list_del_init(&cursor
->s_sibling
);
1528 spin_unlock(&configfs_dirent_lock
);
1529 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1531 release_configfs_dirent(cursor
);
1536 /* Relationship between s_mode and the DT_xxx types */
1537 static inline unsigned char dt_type(struct configfs_dirent
*sd
)
1539 return (sd
->s_mode
>> 12) & 15;
1542 static int configfs_readdir(struct file
* filp
, void * dirent
, filldir_t filldir
)
1544 struct dentry
*dentry
= filp
->f_path
.dentry
;
1545 struct configfs_dirent
* parent_sd
= dentry
->d_fsdata
;
1546 struct configfs_dirent
*cursor
= filp
->private_data
;
1547 struct list_head
*p
, *q
= &cursor
->s_sibling
;
1549 int i
= filp
->f_pos
;
1553 ino
= dentry
->d_inode
->i_ino
;
1554 if (filldir(dirent
, ".", 1, i
, ino
, DT_DIR
) < 0)
1560 ino
= parent_ino(dentry
);
1561 if (filldir(dirent
, "..", 2, i
, ino
, DT_DIR
) < 0)
1567 if (filp
->f_pos
== 2) {
1568 spin_lock(&configfs_dirent_lock
);
1569 list_move(q
, &parent_sd
->s_children
);
1570 spin_unlock(&configfs_dirent_lock
);
1572 for (p
=q
->next
; p
!= &parent_sd
->s_children
; p
=p
->next
) {
1573 struct configfs_dirent
*next
;
1577 next
= list_entry(p
, struct configfs_dirent
,
1579 if (!next
->s_element
)
1582 name
= configfs_get_name(next
);
1585 ino
= next
->s_dentry
->d_inode
->i_ino
;
1587 ino
= iunique(configfs_sb
, 2);
1589 if (filldir(dirent
, name
, len
, filp
->f_pos
, ino
,
1593 spin_lock(&configfs_dirent_lock
);
1595 spin_unlock(&configfs_dirent_lock
);
1603 static loff_t
configfs_dir_lseek(struct file
* file
, loff_t offset
, int origin
)
1605 struct dentry
* dentry
= file
->f_path
.dentry
;
1607 mutex_lock(&dentry
->d_inode
->i_mutex
);
1610 offset
+= file
->f_pos
;
1615 mutex_unlock(&file
->f_path
.dentry
->d_inode
->i_mutex
);
1618 if (offset
!= file
->f_pos
) {
1619 file
->f_pos
= offset
;
1620 if (file
->f_pos
>= 2) {
1621 struct configfs_dirent
*sd
= dentry
->d_fsdata
;
1622 struct configfs_dirent
*cursor
= file
->private_data
;
1623 struct list_head
*p
;
1624 loff_t n
= file
->f_pos
- 2;
1626 spin_lock(&configfs_dirent_lock
);
1627 list_del(&cursor
->s_sibling
);
1628 p
= sd
->s_children
.next
;
1629 while (n
&& p
!= &sd
->s_children
) {
1630 struct configfs_dirent
*next
;
1631 next
= list_entry(p
, struct configfs_dirent
,
1633 if (next
->s_element
)
1637 list_add_tail(&cursor
->s_sibling
, p
);
1638 spin_unlock(&configfs_dirent_lock
);
1641 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1645 const struct file_operations configfs_dir_operations
= {
1646 .open
= configfs_dir_open
,
1647 .release
= configfs_dir_close
,
1648 .llseek
= configfs_dir_lseek
,
1649 .read
= generic_read_dir
,
1650 .readdir
= configfs_readdir
,
1653 int configfs_register_subsystem(struct configfs_subsystem
*subsys
)
1656 struct config_group
*group
= &subsys
->su_group
;
1658 struct dentry
*dentry
;
1659 struct configfs_dirent
*sd
;
1661 err
= configfs_pin_fs();
1665 if (!group
->cg_item
.ci_name
)
1666 group
->cg_item
.ci_name
= group
->cg_item
.ci_namebuf
;
1668 sd
= configfs_sb
->s_root
->d_fsdata
;
1669 link_group(to_config_group(sd
->s_element
), group
);
1671 mutex_lock_nested(&configfs_sb
->s_root
->d_inode
->i_mutex
,
1674 name
.name
= group
->cg_item
.ci_name
;
1675 name
.len
= strlen(name
.name
);
1676 name
.hash
= full_name_hash(name
.name
, name
.len
);
1679 dentry
= d_alloc(configfs_sb
->s_root
, &name
);
1681 d_add(dentry
, NULL
);
1683 err
= configfs_attach_group(sd
->s_element
, &group
->cg_item
,
1689 spin_lock(&configfs_dirent_lock
);
1690 configfs_dir_set_ready(dentry
->d_fsdata
);
1691 spin_unlock(&configfs_dirent_lock
);
1695 mutex_unlock(&configfs_sb
->s_root
->d_inode
->i_mutex
);
1698 unlink_group(group
);
1699 configfs_release_fs();
1705 void configfs_unregister_subsystem(struct configfs_subsystem
*subsys
)
1707 struct config_group
*group
= &subsys
->su_group
;
1708 struct dentry
*dentry
= group
->cg_item
.ci_dentry
;
1710 if (dentry
->d_parent
!= configfs_sb
->s_root
) {
1711 printk(KERN_ERR
"configfs: Tried to unregister non-subsystem!\n");
1715 mutex_lock_nested(&configfs_sb
->s_root
->d_inode
->i_mutex
,
1717 mutex_lock_nested(&dentry
->d_inode
->i_mutex
, I_MUTEX_CHILD
);
1718 mutex_lock(&configfs_symlink_mutex
);
1719 spin_lock(&configfs_dirent_lock
);
1720 if (configfs_detach_prep(dentry
, NULL
)) {
1721 printk(KERN_ERR
"configfs: Tried to unregister non-empty subsystem!\n");
1723 spin_unlock(&configfs_dirent_lock
);
1724 mutex_unlock(&configfs_symlink_mutex
);
1725 configfs_detach_group(&group
->cg_item
);
1726 dentry
->d_inode
->i_flags
|= S_DEAD
;
1728 mutex_unlock(&dentry
->d_inode
->i_mutex
);
1732 mutex_unlock(&configfs_sb
->s_root
->d_inode
->i_mutex
);
1736 unlink_group(group
);
1737 configfs_release_fs();
1740 EXPORT_SYMBOL(configfs_register_subsystem
);
1741 EXPORT_SYMBOL(configfs_unregister_subsystem
);