xref: /linux/fs/sysfs/dir.c (revision cabc5c0f7fa1342049042d6e147db5a73773955b)
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 const 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 is protected by
374 	 * sysfs_mutex, so inode existence can be determined by
375 	 * looking up inode while holding sysfs_mutex.
376 	 */
377 	mutex_lock(&sysfs_mutex);
378 
379 	inode = ilookup5(sysfs_sb, parent_sd->s_ino, sysfs_ilookup_test,
380 			 parent_sd);
381 	if (inode) {
382 		WARN_ON(inode->i_state & I_NEW);
383 
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 	}
397 }
398 
399 /**
400  *	__sysfs_add_one - add sysfs_dirent to parent without warning
401  *	@acxt: addrm context to use
402  *	@sd: sysfs_dirent to be added
403  *
404  *	Get @acxt->parent_sd and set sd->s_parent to it and increment
405  *	nlink of parent inode if @sd is a directory and link into the
406  *	children list of the parent.
407  *
408  *	This function should be called between calls to
409  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
410  *	passed the same @acxt as passed to sysfs_addrm_start().
411  *
412  *	LOCKING:
413  *	Determined by sysfs_addrm_start().
414  *
415  *	RETURNS:
416  *	0 on success, -EEXIST if entry with the given name already
417  *	exists.
418  */
419 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
420 {
421 	if (sysfs_find_dirent(acxt->parent_sd, sd->s_name))
422 		return -EEXIST;
423 
424 	sd->s_parent = sysfs_get(acxt->parent_sd);
425 
426 	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
427 		inc_nlink(acxt->parent_inode);
428 
429 	acxt->cnt++;
430 
431 	sysfs_link_sibling(sd);
432 
433 	return 0;
434 }
435 
436 /**
437  *	sysfs_pathname - return full path to sysfs dirent
438  *	@sd: sysfs_dirent whose path we want
439  *	@path: caller allocated buffer
440  *
441  *	Gives the name "/" to the sysfs_root entry; any path returned
442  *	is relative to wherever sysfs is mounted.
443  *
444  *	XXX: does no error checking on @path size
445  */
446 static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
447 {
448 	if (sd->s_parent) {
449 		sysfs_pathname(sd->s_parent, path);
450 		strcat(path, "/");
451 	}
452 	strcat(path, sd->s_name);
453 	return path;
454 }
455 
456 /**
457  *	sysfs_add_one - add sysfs_dirent to parent
458  *	@acxt: addrm context to use
459  *	@sd: sysfs_dirent to be added
460  *
461  *	Get @acxt->parent_sd and set sd->s_parent to it and increment
462  *	nlink of parent inode if @sd is a directory and link into the
463  *	children list of the parent.
464  *
465  *	This function should be called between calls to
466  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
467  *	passed the same @acxt as passed to sysfs_addrm_start().
468  *
469  *	LOCKING:
470  *	Determined by sysfs_addrm_start().
471  *
472  *	RETURNS:
473  *	0 on success, -EEXIST if entry with the given name already
474  *	exists.
475  */
476 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
477 {
478 	int ret;
479 
480 	ret = __sysfs_add_one(acxt, sd);
481 	if (ret == -EEXIST) {
482 		char *path = kzalloc(PATH_MAX, GFP_KERNEL);
483 		WARN(1, KERN_WARNING
484 		     "sysfs: cannot create duplicate filename '%s'\n",
485 		     (path == NULL) ? sd->s_name :
486 		     strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
487 		            sd->s_name));
488 		kfree(path);
489 	}
490 
491 	return ret;
492 }
493 
494 /**
495  *	sysfs_remove_one - remove sysfs_dirent from parent
496  *	@acxt: addrm context to use
497  *	@sd: sysfs_dirent to be removed
498  *
499  *	Mark @sd removed and drop nlink of parent inode if @sd is a
500  *	directory.  @sd is unlinked from the children list.
501  *
502  *	This function should be called between calls to
503  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
504  *	passed the same @acxt as passed to sysfs_addrm_start().
505  *
506  *	LOCKING:
507  *	Determined by sysfs_addrm_start().
508  */
509 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
510 {
511 	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
512 
513 	sysfs_unlink_sibling(sd);
514 
515 	sd->s_flags |= SYSFS_FLAG_REMOVED;
516 	sd->s_sibling = acxt->removed;
517 	acxt->removed = sd;
518 
519 	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
520 		drop_nlink(acxt->parent_inode);
521 
522 	acxt->cnt++;
523 }
524 
525 /**
526  *	sysfs_drop_dentry - drop dentry for the specified sysfs_dirent
527  *	@sd: target sysfs_dirent
528  *
529  *	Drop dentry for @sd.  @sd must have been unlinked from its
530  *	parent on entry to this function such that it can't be looked
531  *	up anymore.
532  */
533 static void sysfs_drop_dentry(struct sysfs_dirent *sd)
534 {
535 	struct inode *inode;
536 	struct dentry *dentry;
537 
538 	inode = ilookup(sysfs_sb, sd->s_ino);
539 	if (!inode)
540 		return;
541 
542 	/* Drop any existing dentries associated with sd.
543 	 *
544 	 * For the dentry to be properly freed we need to grab a
545 	 * reference to the dentry under the dcache lock,  unhash it,
546 	 * and then put it.  The playing with the dentry count allows
547 	 * dput to immediately free the dentry  if it is not in use.
548 	 */
549 repeat:
550 	spin_lock(&dcache_lock);
551 	list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
552 		if (d_unhashed(dentry))
553 			continue;
554 		dget_locked(dentry);
555 		spin_lock(&dentry->d_lock);
556 		__d_drop(dentry);
557 		spin_unlock(&dentry->d_lock);
558 		spin_unlock(&dcache_lock);
559 		dput(dentry);
560 		goto repeat;
561 	}
562 	spin_unlock(&dcache_lock);
563 
564 	/* adjust nlink and update timestamp */
565 	mutex_lock(&inode->i_mutex);
566 
567 	inode->i_ctime = CURRENT_TIME;
568 	drop_nlink(inode);
569 	if (sysfs_type(sd) == SYSFS_DIR)
570 		drop_nlink(inode);
571 
572 	mutex_unlock(&inode->i_mutex);
573 
574 	iput(inode);
575 }
576 
577 /**
578  *	sysfs_addrm_finish - finish up sysfs_dirent add/remove
579  *	@acxt: addrm context to finish up
580  *
581  *	Finish up sysfs_dirent add/remove.  Resources acquired by
582  *	sysfs_addrm_start() are released and removed sysfs_dirents are
583  *	cleaned up.  Timestamps on the parent inode are updated.
584  *
585  *	LOCKING:
586  *	All mutexes acquired by sysfs_addrm_start() are released.
587  */
588 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
589 {
590 	/* release resources acquired by sysfs_addrm_start() */
591 	mutex_unlock(&sysfs_mutex);
592 	if (acxt->parent_inode) {
593 		struct inode *inode = acxt->parent_inode;
594 
595 		/* if added/removed, update timestamps on the parent */
596 		if (acxt->cnt)
597 			inode->i_ctime = inode->i_mtime = CURRENT_TIME;
598 
599 		mutex_unlock(&inode->i_mutex);
600 		iput(inode);
601 	}
602 
603 	/* kill removed sysfs_dirents */
604 	while (acxt->removed) {
605 		struct sysfs_dirent *sd = acxt->removed;
606 
607 		acxt->removed = sd->s_sibling;
608 		sd->s_sibling = NULL;
609 
610 		sysfs_drop_dentry(sd);
611 		sysfs_deactivate(sd);
612 		unmap_bin_file(sd);
613 		sysfs_put(sd);
614 	}
615 }
616 
617 /**
618  *	sysfs_find_dirent - find sysfs_dirent with the given name
619  *	@parent_sd: sysfs_dirent to search under
620  *	@name: name to look for
621  *
622  *	Look for sysfs_dirent with name @name under @parent_sd.
623  *
624  *	LOCKING:
625  *	mutex_lock(sysfs_mutex)
626  *
627  *	RETURNS:
628  *	Pointer to sysfs_dirent if found, NULL if not.
629  */
630 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
631 				       const unsigned char *name)
632 {
633 	struct sysfs_dirent *sd;
634 
635 	for (sd = parent_sd->s_dir.children; sd; sd = sd->s_sibling)
636 		if (!strcmp(sd->s_name, name))
637 			return sd;
638 	return NULL;
639 }
640 
641 /**
642  *	sysfs_get_dirent - find and get sysfs_dirent with the given name
643  *	@parent_sd: sysfs_dirent to search under
644  *	@name: name to look for
645  *
646  *	Look for sysfs_dirent with name @name under @parent_sd and get
647  *	it if found.
648  *
649  *	LOCKING:
650  *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
651  *
652  *	RETURNS:
653  *	Pointer to sysfs_dirent if found, NULL if not.
654  */
655 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
656 				      const unsigned char *name)
657 {
658 	struct sysfs_dirent *sd;
659 
660 	mutex_lock(&sysfs_mutex);
661 	sd = sysfs_find_dirent(parent_sd, name);
662 	sysfs_get(sd);
663 	mutex_unlock(&sysfs_mutex);
664 
665 	return sd;
666 }
667 EXPORT_SYMBOL_GPL(sysfs_get_dirent);
668 
669 static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
670 		      const char *name, struct sysfs_dirent **p_sd)
671 {
672 	umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
673 	struct sysfs_addrm_cxt acxt;
674 	struct sysfs_dirent *sd;
675 	int rc;
676 
677 	/* allocate */
678 	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
679 	if (!sd)
680 		return -ENOMEM;
681 	sd->s_dir.kobj = kobj;
682 
683 	/* link in */
684 	sysfs_addrm_start(&acxt, parent_sd);
685 	rc = sysfs_add_one(&acxt, sd);
686 	sysfs_addrm_finish(&acxt);
687 
688 	if (rc == 0)
689 		*p_sd = sd;
690 	else
691 		sysfs_put(sd);
692 
693 	return rc;
694 }
695 
696 int sysfs_create_subdir(struct kobject *kobj, const char *name,
697 			struct sysfs_dirent **p_sd)
698 {
699 	return create_dir(kobj, kobj->sd, name, p_sd);
700 }
701 
702 /**
703  *	sysfs_create_dir - create a directory for an object.
704  *	@kobj:		object we're creating directory for.
705  */
706 int sysfs_create_dir(struct kobject * kobj)
707 {
708 	struct sysfs_dirent *parent_sd, *sd;
709 	int error = 0;
710 
711 	BUG_ON(!kobj);
712 
713 	if (kobj->parent)
714 		parent_sd = kobj->parent->sd;
715 	else
716 		parent_sd = &sysfs_root;
717 
718 	error = create_dir(kobj, parent_sd, kobject_name(kobj), &sd);
719 	if (!error)
720 		kobj->sd = sd;
721 	return error;
722 }
723 
724 static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
725 				struct nameidata *nd)
726 {
727 	struct dentry *ret = NULL;
728 	struct sysfs_dirent *parent_sd = dentry->d_parent->d_fsdata;
729 	struct sysfs_dirent *sd;
730 	struct inode *inode;
731 
732 	mutex_lock(&sysfs_mutex);
733 
734 	sd = sysfs_find_dirent(parent_sd, dentry->d_name.name);
735 
736 	/* no such entry */
737 	if (!sd) {
738 		ret = ERR_PTR(-ENOENT);
739 		goto out_unlock;
740 	}
741 
742 	/* attach dentry and inode */
743 	inode = sysfs_get_inode(sd);
744 	if (!inode) {
745 		ret = ERR_PTR(-ENOMEM);
746 		goto out_unlock;
747 	}
748 
749 	/* instantiate and hash dentry */
750 	dentry->d_op = &sysfs_dentry_ops;
751 	dentry->d_fsdata = sysfs_get(sd);
752 	d_instantiate(dentry, inode);
753 	d_rehash(dentry);
754 
755  out_unlock:
756 	mutex_unlock(&sysfs_mutex);
757 	return ret;
758 }
759 
760 const struct inode_operations sysfs_dir_inode_operations = {
761 	.lookup		= sysfs_lookup,
762 	.setattr	= sysfs_setattr,
763 	.setxattr	= sysfs_setxattr,
764 };
765 
766 static void remove_dir(struct sysfs_dirent *sd)
767 {
768 	struct sysfs_addrm_cxt acxt;
769 
770 	sysfs_addrm_start(&acxt, sd->s_parent);
771 	sysfs_remove_one(&acxt, sd);
772 	sysfs_addrm_finish(&acxt);
773 }
774 
775 void sysfs_remove_subdir(struct sysfs_dirent *sd)
776 {
777 	remove_dir(sd);
778 }
779 
780 
781 static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
782 {
783 	struct sysfs_addrm_cxt acxt;
784 	struct sysfs_dirent **pos;
785 
786 	if (!dir_sd)
787 		return;
788 
789 	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
790 	sysfs_addrm_start(&acxt, dir_sd);
791 	pos = &dir_sd->s_dir.children;
792 	while (*pos) {
793 		struct sysfs_dirent *sd = *pos;
794 
795 		if (sysfs_type(sd) != SYSFS_DIR)
796 			sysfs_remove_one(&acxt, sd);
797 		else
798 			pos = &(*pos)->s_sibling;
799 	}
800 	sysfs_addrm_finish(&acxt);
801 
802 	remove_dir(dir_sd);
803 }
804 
805 /**
806  *	sysfs_remove_dir - remove an object's directory.
807  *	@kobj:	object.
808  *
809  *	The only thing special about this is that we remove any files in
810  *	the directory before we remove the directory, and we've inlined
811  *	what used to be sysfs_rmdir() below, instead of calling separately.
812  */
813 
814 void sysfs_remove_dir(struct kobject * kobj)
815 {
816 	struct sysfs_dirent *sd = kobj->sd;
817 
818 	spin_lock(&sysfs_assoc_lock);
819 	kobj->sd = NULL;
820 	spin_unlock(&sysfs_assoc_lock);
821 
822 	__sysfs_remove_dir(sd);
823 }
824 
825 int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
826 {
827 	struct sysfs_dirent *sd = kobj->sd;
828 	struct dentry *parent = NULL;
829 	struct dentry *old_dentry = NULL, *new_dentry = NULL;
830 	const char *dup_name = NULL;
831 	int error;
832 
833 	mutex_lock(&sysfs_rename_mutex);
834 
835 	error = 0;
836 	if (strcmp(sd->s_name, new_name) == 0)
837 		goto out;	/* nothing to rename */
838 
839 	/* get the original dentry */
840 	old_dentry = sysfs_get_dentry(sd);
841 	if (IS_ERR(old_dentry)) {
842 		error = PTR_ERR(old_dentry);
843 		old_dentry = NULL;
844 		goto out;
845 	}
846 
847 	parent = old_dentry->d_parent;
848 
849 	/* lock parent and get dentry for new name */
850 	mutex_lock(&parent->d_inode->i_mutex);
851 	mutex_lock(&sysfs_mutex);
852 
853 	error = -EEXIST;
854 	if (sysfs_find_dirent(sd->s_parent, new_name))
855 		goto out_unlock;
856 
857 	error = -ENOMEM;
858 	new_dentry = d_alloc_name(parent, new_name);
859 	if (!new_dentry)
860 		goto out_unlock;
861 
862 	/* rename sysfs_dirent */
863 	error = -ENOMEM;
864 	new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
865 	if (!new_name)
866 		goto out_unlock;
867 
868 	dup_name = sd->s_name;
869 	sd->s_name = new_name;
870 
871 	/* rename */
872 	d_add(new_dentry, NULL);
873 	d_move(old_dentry, new_dentry);
874 
875 	error = 0;
876  out_unlock:
877 	mutex_unlock(&sysfs_mutex);
878 	mutex_unlock(&parent->d_inode->i_mutex);
879 	kfree(dup_name);
880 	dput(old_dentry);
881 	dput(new_dentry);
882  out:
883 	mutex_unlock(&sysfs_rename_mutex);
884 	return error;
885 }
886 
887 int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
888 {
889 	struct sysfs_dirent *sd = kobj->sd;
890 	struct sysfs_dirent *new_parent_sd;
891 	struct dentry *old_parent, *new_parent = NULL;
892 	struct dentry *old_dentry = NULL, *new_dentry = NULL;
893 	int error;
894 
895 	mutex_lock(&sysfs_rename_mutex);
896 	BUG_ON(!sd->s_parent);
897 	new_parent_sd = new_parent_kobj->sd ? new_parent_kobj->sd : &sysfs_root;
898 
899 	error = 0;
900 	if (sd->s_parent == new_parent_sd)
901 		goto out;	/* nothing to move */
902 
903 	/* get dentries */
904 	old_dentry = sysfs_get_dentry(sd);
905 	if (IS_ERR(old_dentry)) {
906 		error = PTR_ERR(old_dentry);
907 		old_dentry = NULL;
908 		goto out;
909 	}
910 	old_parent = old_dentry->d_parent;
911 
912 	new_parent = sysfs_get_dentry(new_parent_sd);
913 	if (IS_ERR(new_parent)) {
914 		error = PTR_ERR(new_parent);
915 		new_parent = NULL;
916 		goto out;
917 	}
918 
919 again:
920 	mutex_lock(&old_parent->d_inode->i_mutex);
921 	if (!mutex_trylock(&new_parent->d_inode->i_mutex)) {
922 		mutex_unlock(&old_parent->d_inode->i_mutex);
923 		goto again;
924 	}
925 	mutex_lock(&sysfs_mutex);
926 
927 	error = -EEXIST;
928 	if (sysfs_find_dirent(new_parent_sd, sd->s_name))
929 		goto out_unlock;
930 
931 	error = -ENOMEM;
932 	new_dentry = d_alloc_name(new_parent, sd->s_name);
933 	if (!new_dentry)
934 		goto out_unlock;
935 
936 	error = 0;
937 	d_add(new_dentry, NULL);
938 	d_move(old_dentry, new_dentry);
939 
940 	/* Remove from old parent's list and insert into new parent's list. */
941 	sysfs_unlink_sibling(sd);
942 	sysfs_get(new_parent_sd);
943 	drop_nlink(old_parent->d_inode);
944 	sysfs_put(sd->s_parent);
945 	sd->s_parent = new_parent_sd;
946 	inc_nlink(new_parent->d_inode);
947 	sysfs_link_sibling(sd);
948 
949  out_unlock:
950 	mutex_unlock(&sysfs_mutex);
951 	mutex_unlock(&new_parent->d_inode->i_mutex);
952 	mutex_unlock(&old_parent->d_inode->i_mutex);
953  out:
954 	dput(new_parent);
955 	dput(old_dentry);
956 	dput(new_dentry);
957 	mutex_unlock(&sysfs_rename_mutex);
958 	return error;
959 }
960 
961 /* Relationship between s_mode and the DT_xxx types */
962 static inline unsigned char dt_type(struct sysfs_dirent *sd)
963 {
964 	return (sd->s_mode >> 12) & 15;
965 }
966 
967 static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
968 {
969 	struct dentry *dentry = filp->f_path.dentry;
970 	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
971 	struct sysfs_dirent *pos;
972 	ino_t ino;
973 
974 	if (filp->f_pos == 0) {
975 		ino = parent_sd->s_ino;
976 		if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
977 			filp->f_pos++;
978 	}
979 	if (filp->f_pos == 1) {
980 		if (parent_sd->s_parent)
981 			ino = parent_sd->s_parent->s_ino;
982 		else
983 			ino = parent_sd->s_ino;
984 		if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
985 			filp->f_pos++;
986 	}
987 	if ((filp->f_pos > 1) && (filp->f_pos < INT_MAX)) {
988 		mutex_lock(&sysfs_mutex);
989 
990 		/* Skip the dentries we have already reported */
991 		pos = parent_sd->s_dir.children;
992 		while (pos && (filp->f_pos > pos->s_ino))
993 			pos = pos->s_sibling;
994 
995 		for ( ; pos; pos = pos->s_sibling) {
996 			const char * name;
997 			int len;
998 
999 			name = pos->s_name;
1000 			len = strlen(name);
1001 			filp->f_pos = ino = pos->s_ino;
1002 
1003 			if (filldir(dirent, name, len, filp->f_pos, ino,
1004 					 dt_type(pos)) < 0)
1005 				break;
1006 		}
1007 		if (!pos)
1008 			filp->f_pos = INT_MAX;
1009 		mutex_unlock(&sysfs_mutex);
1010 	}
1011 	return 0;
1012 }
1013 
1014 
1015 const struct file_operations sysfs_dir_operations = {
1016 	.read		= generic_read_dir,
1017 	.readdir	= sysfs_readdir,
1018 	.llseek		= generic_file_llseek,
1019 };
1020