xref: /linux/fs/sysfs/dir.c (revision 96916090f488986a4ebb8e9ffa6a3b50881d5ccd)
1 /*
2  * fs/sysfs/dir.c - sysfs core and dir operation implementation
3  *
4  * Copyright (c) 2001-3 Patrick Mochel
5  * Copyright (c) 2007 SUSE Linux Products GmbH
6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
7  *
8  * This file is released under the GPLv2.
9  *
10  * Please see Documentation/filesystems/sysfs.txt for more information.
11  */
12 
13 #undef DEBUG
14 
15 #include <linux/fs.h>
16 #include <linux/mount.h>
17 #include <linux/module.h>
18 #include <linux/kobject.h>
19 #include <linux/namei.h>
20 #include <linux/idr.h>
21 #include <linux/completion.h>
22 #include <linux/mutex.h>
23 #include <linux/slab.h>
24 #include "sysfs.h"
25 
26 DEFINE_MUTEX(sysfs_mutex);
27 DEFINE_MUTEX(sysfs_rename_mutex);
28 DEFINE_SPINLOCK(sysfs_assoc_lock);
29 
30 static DEFINE_SPINLOCK(sysfs_ino_lock);
31 static DEFINE_IDA(sysfs_ino_ida);
32 
33 /**
34  *	sysfs_link_sibling - link sysfs_dirent into sibling list
35  *	@sd: sysfs_dirent of interest
36  *
37  *	Link @sd into its sibling list which starts from
38  *	sd->s_parent->s_dir.children.
39  *
40  *	Locking:
41  *	mutex_lock(sysfs_mutex)
42  */
43 static void sysfs_link_sibling(struct sysfs_dirent *sd)
44 {
45 	struct sysfs_dirent *parent_sd = sd->s_parent;
46 	struct sysfs_dirent **pos;
47 
48 	BUG_ON(sd->s_sibling);
49 
50 	/* Store directory entries in order by ino.  This allows
51 	 * readdir to properly restart without having to add a
52 	 * cursor into the s_dir.children list.
53 	 */
54 	for (pos = &parent_sd->s_dir.children; *pos; pos = &(*pos)->s_sibling) {
55 		if (sd->s_ino < (*pos)->s_ino)
56 			break;
57 	}
58 	sd->s_sibling = *pos;
59 	*pos = sd;
60 }
61 
62 /**
63  *	sysfs_unlink_sibling - unlink sysfs_dirent from sibling list
64  *	@sd: sysfs_dirent of interest
65  *
66  *	Unlink @sd from its sibling list which starts from
67  *	sd->s_parent->s_dir.children.
68  *
69  *	Locking:
70  *	mutex_lock(sysfs_mutex)
71  */
72 static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
73 {
74 	struct sysfs_dirent **pos;
75 
76 	for (pos = &sd->s_parent->s_dir.children; *pos;
77 	     pos = &(*pos)->s_sibling) {
78 		if (*pos == sd) {
79 			*pos = sd->s_sibling;
80 			sd->s_sibling = NULL;
81 			break;
82 		}
83 	}
84 }
85 
86 /**
87  *	sysfs_get_dentry - get dentry for the given sysfs_dirent
88  *	@sd: sysfs_dirent of interest
89  *
90  *	Get dentry for @sd.  Dentry is looked up if currently not
91  *	present.  This function descends from the root looking up
92  *	dentry for each step.
93  *
94  *	LOCKING:
95  *	mutex_lock(sysfs_rename_mutex)
96  *
97  *	RETURNS:
98  *	Pointer to found dentry on success, ERR_PTR() value on error.
99  */
100 struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd)
101 {
102 	struct dentry *dentry = dget(sysfs_sb->s_root);
103 
104 	while (dentry->d_fsdata != sd) {
105 		struct sysfs_dirent *cur;
106 		struct dentry *parent;
107 
108 		/* find the first ancestor which hasn't been looked up */
109 		cur = sd;
110 		while (cur->s_parent != dentry->d_fsdata)
111 			cur = cur->s_parent;
112 
113 		/* look it up */
114 		parent = dentry;
115 		mutex_lock(&parent->d_inode->i_mutex);
116 		dentry = lookup_one_noperm(cur->s_name, parent);
117 		mutex_unlock(&parent->d_inode->i_mutex);
118 		dput(parent);
119 
120 		if (IS_ERR(dentry))
121 			break;
122 	}
123 	return dentry;
124 }
125 
126 /**
127  *	sysfs_get_active - get an active reference to sysfs_dirent
128  *	@sd: sysfs_dirent to get an active reference to
129  *
130  *	Get an active reference of @sd.  This function is noop if @sd
131  *	is NULL.
132  *
133  *	RETURNS:
134  *	Pointer to @sd on success, NULL on failure.
135  */
136 static struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
137 {
138 	if (unlikely(!sd))
139 		return NULL;
140 
141 	while (1) {
142 		int v, t;
143 
144 		v = atomic_read(&sd->s_active);
145 		if (unlikely(v < 0))
146 			return NULL;
147 
148 		t = atomic_cmpxchg(&sd->s_active, v, v + 1);
149 		if (likely(t == v))
150 			return sd;
151 		if (t < 0)
152 			return NULL;
153 
154 		cpu_relax();
155 	}
156 }
157 
158 /**
159  *	sysfs_put_active - put an active reference to sysfs_dirent
160  *	@sd: sysfs_dirent to put an active reference to
161  *
162  *	Put an active reference to @sd.  This function is noop if @sd
163  *	is NULL.
164  */
165 static void sysfs_put_active(struct sysfs_dirent *sd)
166 {
167 	struct completion *cmpl;
168 	int v;
169 
170 	if (unlikely(!sd))
171 		return;
172 
173 	v = atomic_dec_return(&sd->s_active);
174 	if (likely(v != SD_DEACTIVATED_BIAS))
175 		return;
176 
177 	/* atomic_dec_return() is a mb(), we'll always see the updated
178 	 * sd->s_sibling.
179 	 */
180 	cmpl = (void *)sd->s_sibling;
181 	complete(cmpl);
182 }
183 
184 /**
185  *	sysfs_get_active_two - get active references to sysfs_dirent and parent
186  *	@sd: sysfs_dirent of interest
187  *
188  *	Get active reference to @sd and its parent.  Parent's active
189  *	reference is grabbed first.  This function is noop if @sd is
190  *	NULL.
191  *
192  *	RETURNS:
193  *	Pointer to @sd on success, NULL on failure.
194  */
195 struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd)
196 {
197 	if (sd) {
198 		if (sd->s_parent && unlikely(!sysfs_get_active(sd->s_parent)))
199 			return NULL;
200 		if (unlikely(!sysfs_get_active(sd))) {
201 			sysfs_put_active(sd->s_parent);
202 			return NULL;
203 		}
204 	}
205 	return sd;
206 }
207 
208 /**
209  *	sysfs_put_active_two - put active references to sysfs_dirent and parent
210  *	@sd: sysfs_dirent of interest
211  *
212  *	Put active references to @sd and its parent.  This function is
213  *	noop if @sd is NULL.
214  */
215 void sysfs_put_active_two(struct sysfs_dirent *sd)
216 {
217 	if (sd) {
218 		sysfs_put_active(sd);
219 		sysfs_put_active(sd->s_parent);
220 	}
221 }
222 
223 /**
224  *	sysfs_deactivate - deactivate sysfs_dirent
225  *	@sd: sysfs_dirent to deactivate
226  *
227  *	Deny new active references and drain existing ones.
228  */
229 static void sysfs_deactivate(struct sysfs_dirent *sd)
230 {
231 	DECLARE_COMPLETION_ONSTACK(wait);
232 	int v;
233 
234 	BUG_ON(sd->s_sibling || !(sd->s_flags & SYSFS_FLAG_REMOVED));
235 	sd->s_sibling = (void *)&wait;
236 
237 	/* atomic_add_return() is a mb(), put_active() will always see
238 	 * the updated sd->s_sibling.
239 	 */
240 	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
241 
242 	if (v != SD_DEACTIVATED_BIAS)
243 		wait_for_completion(&wait);
244 
245 	sd->s_sibling = NULL;
246 }
247 
248 static int sysfs_alloc_ino(ino_t *pino)
249 {
250 	int ino, rc;
251 
252  retry:
253 	spin_lock(&sysfs_ino_lock);
254 	rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
255 	spin_unlock(&sysfs_ino_lock);
256 
257 	if (rc == -EAGAIN) {
258 		if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
259 			goto retry;
260 		rc = -ENOMEM;
261 	}
262 
263 	*pino = ino;
264 	return rc;
265 }
266 
267 static void sysfs_free_ino(ino_t ino)
268 {
269 	spin_lock(&sysfs_ino_lock);
270 	ida_remove(&sysfs_ino_ida, ino);
271 	spin_unlock(&sysfs_ino_lock);
272 }
273 
274 void release_sysfs_dirent(struct sysfs_dirent * sd)
275 {
276 	struct sysfs_dirent *parent_sd;
277 
278  repeat:
279 	/* Moving/renaming is always done while holding reference.
280 	 * sd->s_parent won't change beneath us.
281 	 */
282 	parent_sd = sd->s_parent;
283 
284 	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
285 		sysfs_put(sd->s_symlink.target_sd);
286 	if (sysfs_type(sd) & SYSFS_COPY_NAME)
287 		kfree(sd->s_name);
288 	kfree(sd->s_iattr);
289 	sysfs_free_ino(sd->s_ino);
290 	kmem_cache_free(sysfs_dir_cachep, sd);
291 
292 	sd = parent_sd;
293 	if (sd && atomic_dec_and_test(&sd->s_count))
294 		goto repeat;
295 }
296 
297 static void sysfs_d_iput(struct dentry * dentry, struct inode * inode)
298 {
299 	struct sysfs_dirent * sd = dentry->d_fsdata;
300 
301 	sysfs_put(sd);
302 	iput(inode);
303 }
304 
305 static struct dentry_operations sysfs_dentry_ops = {
306 	.d_iput		= sysfs_d_iput,
307 };
308 
309 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
310 {
311 	char *dup_name = NULL;
312 	struct sysfs_dirent *sd;
313 
314 	if (type & SYSFS_COPY_NAME) {
315 		name = dup_name = kstrdup(name, GFP_KERNEL);
316 		if (!name)
317 			return NULL;
318 	}
319 
320 	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
321 	if (!sd)
322 		goto err_out1;
323 
324 	if (sysfs_alloc_ino(&sd->s_ino))
325 		goto err_out2;
326 
327 	atomic_set(&sd->s_count, 1);
328 	atomic_set(&sd->s_active, 0);
329 
330 	sd->s_name = name;
331 	sd->s_mode = mode;
332 	sd->s_flags = type;
333 
334 	return sd;
335 
336  err_out2:
337 	kmem_cache_free(sysfs_dir_cachep, sd);
338  err_out1:
339 	kfree(dup_name);
340 	return NULL;
341 }
342 
343 static int sysfs_ilookup_test(struct inode *inode, void *arg)
344 {
345 	struct sysfs_dirent *sd = arg;
346 	return inode->i_ino == sd->s_ino;
347 }
348 
349 /**
350  *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
351  *	@acxt: pointer to sysfs_addrm_cxt to be used
352  *	@parent_sd: parent sysfs_dirent
353  *
354  *	This function is called when the caller is about to add or
355  *	remove sysfs_dirent under @parent_sd.  This function acquires
356  *	sysfs_mutex, grabs inode for @parent_sd if available and lock
357  *	i_mutex of it.  @acxt is used to keep and pass context to
358  *	other addrm functions.
359  *
360  *	LOCKING:
361  *	Kernel thread context (may sleep).  sysfs_mutex is locked on
362  *	return.  i_mutex of parent inode is locked on return if
363  *	available.
364  */
365 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
366 		       struct sysfs_dirent *parent_sd)
367 {
368 	struct inode *inode;
369 
370 	memset(acxt, 0, sizeof(*acxt));
371 	acxt->parent_sd = parent_sd;
372 
373 	/* Lookup parent inode.  inode initialization and I_NEW
374 	 * clearing are protected by sysfs_mutex.  By grabbing it and
375 	 * looking up with _nowait variant, inode state can be
376 	 * determined reliably.
377 	 */
378 	mutex_lock(&sysfs_mutex);
379 
380 	inode = ilookup5_nowait(sysfs_sb, parent_sd->s_ino, sysfs_ilookup_test,
381 				parent_sd);
382 
383 	if (inode && !(inode->i_state & I_NEW)) {
384 		/* parent inode available */
385 		acxt->parent_inode = inode;
386 
387 		/* sysfs_mutex is below i_mutex in lock hierarchy.
388 		 * First, trylock i_mutex.  If fails, unlock
389 		 * sysfs_mutex and lock them in order.
390 		 */
391 		if (!mutex_trylock(&inode->i_mutex)) {
392 			mutex_unlock(&sysfs_mutex);
393 			mutex_lock(&inode->i_mutex);
394 			mutex_lock(&sysfs_mutex);
395 		}
396 	} else
397 		iput(inode);
398 }
399 
400 /**
401  *	sysfs_add_one - add sysfs_dirent to parent
402  *	@acxt: addrm context to use
403  *	@sd: sysfs_dirent to be added
404  *
405  *	Get @acxt->parent_sd and set sd->s_parent to it and increment
406  *	nlink of parent inode if @sd is a directory and link into the
407  *	children list of the parent.
408  *
409  *	This function should be called between calls to
410  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
411  *	passed the same @acxt as passed to sysfs_addrm_start().
412  *
413  *	LOCKING:
414  *	Determined by sysfs_addrm_start().
415  *
416  *	RETURNS:
417  *	0 on success, -EEXIST if entry with the given name already
418  *	exists.
419  */
420 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
421 {
422 	if (sysfs_find_dirent(acxt->parent_sd, sd->s_name)) {
423 		printk(KERN_WARNING "sysfs: duplicate filename '%s' "
424 		       "can not be created\n", sd->s_name);
425 		WARN_ON(1);
426 		return -EEXIST;
427 	}
428 
429 	sd->s_parent = sysfs_get(acxt->parent_sd);
430 
431 	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
432 		inc_nlink(acxt->parent_inode);
433 
434 	acxt->cnt++;
435 
436 	sysfs_link_sibling(sd);
437 
438 	return 0;
439 }
440 
441 /**
442  *	sysfs_remove_one - remove sysfs_dirent from parent
443  *	@acxt: addrm context to use
444  *	@sd: sysfs_dirent to be removed
445  *
446  *	Mark @sd removed and drop nlink of parent inode if @sd is a
447  *	directory.  @sd is unlinked from the children list.
448  *
449  *	This function should be called between calls to
450  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
451  *	passed the same @acxt as passed to sysfs_addrm_start().
452  *
453  *	LOCKING:
454  *	Determined by sysfs_addrm_start().
455  */
456 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
457 {
458 	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
459 
460 	sysfs_unlink_sibling(sd);
461 
462 	sd->s_flags |= SYSFS_FLAG_REMOVED;
463 	sd->s_sibling = acxt->removed;
464 	acxt->removed = sd;
465 
466 	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
467 		drop_nlink(acxt->parent_inode);
468 
469 	acxt->cnt++;
470 }
471 
472 /**
473  *	sysfs_drop_dentry - drop dentry for the specified sysfs_dirent
474  *	@sd: target sysfs_dirent
475  *
476  *	Drop dentry for @sd.  @sd must have been unlinked from its
477  *	parent on entry to this function such that it can't be looked
478  *	up anymore.
479  */
480 static void sysfs_drop_dentry(struct sysfs_dirent *sd)
481 {
482 	struct inode *inode;
483 	struct dentry *dentry;
484 
485 	inode = ilookup(sysfs_sb, sd->s_ino);
486 	if (!inode)
487 		return;
488 
489 	/* Drop any existing dentries associated with sd.
490 	 *
491 	 * For the dentry to be properly freed we need to grab a
492 	 * reference to the dentry under the dcache lock,  unhash it,
493 	 * and then put it.  The playing with the dentry count allows
494 	 * dput to immediately free the dentry  if it is not in use.
495 	 */
496 repeat:
497 	spin_lock(&dcache_lock);
498 	list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
499 		if (d_unhashed(dentry))
500 			continue;
501 		dget_locked(dentry);
502 		spin_lock(&dentry->d_lock);
503 		__d_drop(dentry);
504 		spin_unlock(&dentry->d_lock);
505 		spin_unlock(&dcache_lock);
506 		dput(dentry);
507 		goto repeat;
508 	}
509 	spin_unlock(&dcache_lock);
510 
511 	/* adjust nlink and update timestamp */
512 	mutex_lock(&inode->i_mutex);
513 
514 	inode->i_ctime = CURRENT_TIME;
515 	drop_nlink(inode);
516 	if (sysfs_type(sd) == SYSFS_DIR)
517 		drop_nlink(inode);
518 
519 	mutex_unlock(&inode->i_mutex);
520 
521 	iput(inode);
522 }
523 
524 /**
525  *	sysfs_addrm_finish - finish up sysfs_dirent add/remove
526  *	@acxt: addrm context to finish up
527  *
528  *	Finish up sysfs_dirent add/remove.  Resources acquired by
529  *	sysfs_addrm_start() are released and removed sysfs_dirents are
530  *	cleaned up.  Timestamps on the parent inode are updated.
531  *
532  *	LOCKING:
533  *	All mutexes acquired by sysfs_addrm_start() are released.
534  */
535 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
536 {
537 	/* release resources acquired by sysfs_addrm_start() */
538 	mutex_unlock(&sysfs_mutex);
539 	if (acxt->parent_inode) {
540 		struct inode *inode = acxt->parent_inode;
541 
542 		/* if added/removed, update timestamps on the parent */
543 		if (acxt->cnt)
544 			inode->i_ctime = inode->i_mtime = CURRENT_TIME;
545 
546 		mutex_unlock(&inode->i_mutex);
547 		iput(inode);
548 	}
549 
550 	/* kill removed sysfs_dirents */
551 	while (acxt->removed) {
552 		struct sysfs_dirent *sd = acxt->removed;
553 
554 		acxt->removed = sd->s_sibling;
555 		sd->s_sibling = NULL;
556 
557 		sysfs_drop_dentry(sd);
558 		sysfs_deactivate(sd);
559 		sysfs_put(sd);
560 	}
561 }
562 
563 /**
564  *	sysfs_find_dirent - find sysfs_dirent with the given name
565  *	@parent_sd: sysfs_dirent to search under
566  *	@name: name to look for
567  *
568  *	Look for sysfs_dirent with name @name under @parent_sd.
569  *
570  *	LOCKING:
571  *	mutex_lock(sysfs_mutex)
572  *
573  *	RETURNS:
574  *	Pointer to sysfs_dirent if found, NULL if not.
575  */
576 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
577 				       const unsigned char *name)
578 {
579 	struct sysfs_dirent *sd;
580 
581 	for (sd = parent_sd->s_dir.children; sd; sd = sd->s_sibling)
582 		if (!strcmp(sd->s_name, name))
583 			return sd;
584 	return NULL;
585 }
586 
587 /**
588  *	sysfs_get_dirent - find and get sysfs_dirent with the given name
589  *	@parent_sd: sysfs_dirent to search under
590  *	@name: name to look for
591  *
592  *	Look for sysfs_dirent with name @name under @parent_sd and get
593  *	it if found.
594  *
595  *	LOCKING:
596  *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
597  *
598  *	RETURNS:
599  *	Pointer to sysfs_dirent if found, NULL if not.
600  */
601 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
602 				      const unsigned char *name)
603 {
604 	struct sysfs_dirent *sd;
605 
606 	mutex_lock(&sysfs_mutex);
607 	sd = sysfs_find_dirent(parent_sd, name);
608 	sysfs_get(sd);
609 	mutex_unlock(&sysfs_mutex);
610 
611 	return sd;
612 }
613 
614 static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
615 		      const char *name, struct sysfs_dirent **p_sd)
616 {
617 	umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
618 	struct sysfs_addrm_cxt acxt;
619 	struct sysfs_dirent *sd;
620 	int rc;
621 
622 	/* allocate */
623 	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
624 	if (!sd)
625 		return -ENOMEM;
626 	sd->s_dir.kobj = kobj;
627 
628 	/* link in */
629 	sysfs_addrm_start(&acxt, parent_sd);
630 	rc = sysfs_add_one(&acxt, sd);
631 	sysfs_addrm_finish(&acxt);
632 
633 	if (rc == 0)
634 		*p_sd = sd;
635 	else
636 		sysfs_put(sd);
637 
638 	return rc;
639 }
640 
641 int sysfs_create_subdir(struct kobject *kobj, const char *name,
642 			struct sysfs_dirent **p_sd)
643 {
644 	return create_dir(kobj, kobj->sd, name, p_sd);
645 }
646 
647 /**
648  *	sysfs_create_dir - create a directory for an object.
649  *	@kobj:		object we're creating directory for.
650  */
651 int sysfs_create_dir(struct kobject * kobj)
652 {
653 	struct sysfs_dirent *parent_sd, *sd;
654 	int error = 0;
655 
656 	BUG_ON(!kobj);
657 
658 	if (kobj->parent)
659 		parent_sd = kobj->parent->sd;
660 	else
661 		parent_sd = &sysfs_root;
662 
663 	error = create_dir(kobj, parent_sd, kobject_name(kobj), &sd);
664 	if (!error)
665 		kobj->sd = sd;
666 	return error;
667 }
668 
669 static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
670 				struct nameidata *nd)
671 {
672 	struct dentry *ret = NULL;
673 	struct sysfs_dirent *parent_sd = dentry->d_parent->d_fsdata;
674 	struct sysfs_dirent *sd;
675 	struct inode *inode;
676 
677 	mutex_lock(&sysfs_mutex);
678 
679 	sd = sysfs_find_dirent(parent_sd, dentry->d_name.name);
680 
681 	/* no such entry */
682 	if (!sd) {
683 		ret = ERR_PTR(-ENOENT);
684 		goto out_unlock;
685 	}
686 
687 	/* attach dentry and inode */
688 	inode = sysfs_get_inode(sd);
689 	if (!inode) {
690 		ret = ERR_PTR(-ENOMEM);
691 		goto out_unlock;
692 	}
693 
694 	/* instantiate and hash dentry */
695 	dentry->d_op = &sysfs_dentry_ops;
696 	dentry->d_fsdata = sysfs_get(sd);
697 	d_instantiate(dentry, inode);
698 	d_rehash(dentry);
699 
700  out_unlock:
701 	mutex_unlock(&sysfs_mutex);
702 	return ret;
703 }
704 
705 const struct inode_operations sysfs_dir_inode_operations = {
706 	.lookup		= sysfs_lookup,
707 	.setattr	= sysfs_setattr,
708 };
709 
710 static void remove_dir(struct sysfs_dirent *sd)
711 {
712 	struct sysfs_addrm_cxt acxt;
713 
714 	sysfs_addrm_start(&acxt, sd->s_parent);
715 	sysfs_remove_one(&acxt, sd);
716 	sysfs_addrm_finish(&acxt);
717 }
718 
719 void sysfs_remove_subdir(struct sysfs_dirent *sd)
720 {
721 	remove_dir(sd);
722 }
723 
724 
725 static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
726 {
727 	struct sysfs_addrm_cxt acxt;
728 	struct sysfs_dirent **pos;
729 
730 	if (!dir_sd)
731 		return;
732 
733 	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
734 	sysfs_addrm_start(&acxt, dir_sd);
735 	pos = &dir_sd->s_dir.children;
736 	while (*pos) {
737 		struct sysfs_dirent *sd = *pos;
738 
739 		if (sysfs_type(sd) != SYSFS_DIR)
740 			sysfs_remove_one(&acxt, sd);
741 		else
742 			pos = &(*pos)->s_sibling;
743 	}
744 	sysfs_addrm_finish(&acxt);
745 
746 	remove_dir(dir_sd);
747 }
748 
749 /**
750  *	sysfs_remove_dir - remove an object's directory.
751  *	@kobj:	object.
752  *
753  *	The only thing special about this is that we remove any files in
754  *	the directory before we remove the directory, and we've inlined
755  *	what used to be sysfs_rmdir() below, instead of calling separately.
756  */
757 
758 void sysfs_remove_dir(struct kobject * kobj)
759 {
760 	struct sysfs_dirent *sd = kobj->sd;
761 
762 	spin_lock(&sysfs_assoc_lock);
763 	kobj->sd = NULL;
764 	spin_unlock(&sysfs_assoc_lock);
765 
766 	__sysfs_remove_dir(sd);
767 }
768 
769 int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
770 {
771 	struct sysfs_dirent *sd = kobj->sd;
772 	struct dentry *parent = NULL;
773 	struct dentry *old_dentry = NULL, *new_dentry = NULL;
774 	const char *dup_name = NULL;
775 	int error;
776 
777 	mutex_lock(&sysfs_rename_mutex);
778 
779 	error = 0;
780 	if (strcmp(sd->s_name, new_name) == 0)
781 		goto out;	/* nothing to rename */
782 
783 	/* get the original dentry */
784 	old_dentry = sysfs_get_dentry(sd);
785 	if (IS_ERR(old_dentry)) {
786 		error = PTR_ERR(old_dentry);
787 		old_dentry = NULL;
788 		goto out;
789 	}
790 
791 	parent = old_dentry->d_parent;
792 
793 	/* lock parent and get dentry for new name */
794 	mutex_lock(&parent->d_inode->i_mutex);
795 	mutex_lock(&sysfs_mutex);
796 
797 	error = -EEXIST;
798 	if (sysfs_find_dirent(sd->s_parent, new_name))
799 		goto out_unlock;
800 
801 	error = -ENOMEM;
802 	new_dentry = d_alloc_name(parent, new_name);
803 	if (!new_dentry)
804 		goto out_unlock;
805 
806 	/* rename kobject and sysfs_dirent */
807 	error = -ENOMEM;
808 	new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
809 	if (!new_name)
810 		goto out_unlock;
811 
812 	error = kobject_set_name(kobj, "%s", new_name);
813 	if (error)
814 		goto out_unlock;
815 
816 	dup_name = sd->s_name;
817 	sd->s_name = new_name;
818 
819 	/* rename */
820 	d_add(new_dentry, NULL);
821 	d_move(old_dentry, new_dentry);
822 
823 	error = 0;
824  out_unlock:
825 	mutex_unlock(&sysfs_mutex);
826 	mutex_unlock(&parent->d_inode->i_mutex);
827 	kfree(dup_name);
828 	dput(old_dentry);
829 	dput(new_dentry);
830  out:
831 	mutex_unlock(&sysfs_rename_mutex);
832 	return error;
833 }
834 
835 int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
836 {
837 	struct sysfs_dirent *sd = kobj->sd;
838 	struct sysfs_dirent *new_parent_sd;
839 	struct dentry *old_parent, *new_parent = NULL;
840 	struct dentry *old_dentry = NULL, *new_dentry = NULL;
841 	int error;
842 
843 	mutex_lock(&sysfs_rename_mutex);
844 	BUG_ON(!sd->s_parent);
845 	new_parent_sd = new_parent_kobj->sd ? new_parent_kobj->sd : &sysfs_root;
846 
847 	error = 0;
848 	if (sd->s_parent == new_parent_sd)
849 		goto out;	/* nothing to move */
850 
851 	/* get dentries */
852 	old_dentry = sysfs_get_dentry(sd);
853 	if (IS_ERR(old_dentry)) {
854 		error = PTR_ERR(old_dentry);
855 		old_dentry = NULL;
856 		goto out;
857 	}
858 	old_parent = old_dentry->d_parent;
859 
860 	new_parent = sysfs_get_dentry(new_parent_sd);
861 	if (IS_ERR(new_parent)) {
862 		error = PTR_ERR(new_parent);
863 		new_parent = NULL;
864 		goto out;
865 	}
866 
867 again:
868 	mutex_lock(&old_parent->d_inode->i_mutex);
869 	if (!mutex_trylock(&new_parent->d_inode->i_mutex)) {
870 		mutex_unlock(&old_parent->d_inode->i_mutex);
871 		goto again;
872 	}
873 	mutex_lock(&sysfs_mutex);
874 
875 	error = -EEXIST;
876 	if (sysfs_find_dirent(new_parent_sd, sd->s_name))
877 		goto out_unlock;
878 
879 	error = -ENOMEM;
880 	new_dentry = d_alloc_name(new_parent, sd->s_name);
881 	if (!new_dentry)
882 		goto out_unlock;
883 
884 	error = 0;
885 	d_add(new_dentry, NULL);
886 	d_move(old_dentry, new_dentry);
887 
888 	/* Remove from old parent's list and insert into new parent's list. */
889 	sysfs_unlink_sibling(sd);
890 	sysfs_get(new_parent_sd);
891 	sysfs_put(sd->s_parent);
892 	sd->s_parent = new_parent_sd;
893 	sysfs_link_sibling(sd);
894 
895  out_unlock:
896 	mutex_unlock(&sysfs_mutex);
897 	mutex_unlock(&new_parent->d_inode->i_mutex);
898 	mutex_unlock(&old_parent->d_inode->i_mutex);
899  out:
900 	dput(new_parent);
901 	dput(old_dentry);
902 	dput(new_dentry);
903 	mutex_unlock(&sysfs_rename_mutex);
904 	return error;
905 }
906 
907 /* Relationship between s_mode and the DT_xxx types */
908 static inline unsigned char dt_type(struct sysfs_dirent *sd)
909 {
910 	return (sd->s_mode >> 12) & 15;
911 }
912 
913 static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
914 {
915 	struct dentry *dentry = filp->f_path.dentry;
916 	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
917 	struct sysfs_dirent *pos;
918 	ino_t ino;
919 
920 	if (filp->f_pos == 0) {
921 		ino = parent_sd->s_ino;
922 		if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
923 			filp->f_pos++;
924 	}
925 	if (filp->f_pos == 1) {
926 		if (parent_sd->s_parent)
927 			ino = parent_sd->s_parent->s_ino;
928 		else
929 			ino = parent_sd->s_ino;
930 		if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
931 			filp->f_pos++;
932 	}
933 	if ((filp->f_pos > 1) && (filp->f_pos < INT_MAX)) {
934 		mutex_lock(&sysfs_mutex);
935 
936 		/* Skip the dentries we have already reported */
937 		pos = parent_sd->s_dir.children;
938 		while (pos && (filp->f_pos > pos->s_ino))
939 			pos = pos->s_sibling;
940 
941 		for ( ; pos; pos = pos->s_sibling) {
942 			const char * name;
943 			int len;
944 
945 			name = pos->s_name;
946 			len = strlen(name);
947 			filp->f_pos = ino = pos->s_ino;
948 
949 			if (filldir(dirent, name, len, filp->f_pos, ino,
950 					 dt_type(pos)) < 0)
951 				break;
952 		}
953 		if (!pos)
954 			filp->f_pos = INT_MAX;
955 		mutex_unlock(&sysfs_mutex);
956 	}
957 	return 0;
958 }
959 
960 
961 const struct file_operations sysfs_dir_operations = {
962 	.read		= generic_read_dir,
963 	.readdir	= sysfs_readdir,
964 };
965