xref: /linux/fs/sysfs/dir.c (revision cfec0bc835c84d3d3723d4955587f05a94879b26)
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 <linux/security.h>
25 #include <linux/hash.h>
26 #include "sysfs.h"
27 
28 DEFINE_MUTEX(sysfs_mutex);
29 DEFINE_SPINLOCK(sysfs_assoc_lock);
30 
31 #define to_sysfs_dirent(X) rb_entry((X), struct sysfs_dirent, s_rb)
32 
33 static DEFINE_SPINLOCK(sysfs_ino_lock);
34 static DEFINE_IDA(sysfs_ino_ida);
35 
36 /**
37  *	sysfs_name_hash
38  *	@name: Null terminated string to hash
39  *	@ns:   Namespace tag to hash
40  *
41  *	Returns 31 bit hash of ns + name (so it fits in an off_t )
42  */
43 static unsigned int sysfs_name_hash(const char *name, const void *ns)
44 {
45 	unsigned long hash = init_name_hash();
46 	unsigned int len = strlen(name);
47 	while (len--)
48 		hash = partial_name_hash(*name++, hash);
49 	hash = (end_name_hash(hash) ^ hash_ptr((void *)ns, 31));
50 	hash &= 0x7fffffffU;
51 	/* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
52 	if (hash < 1)
53 		hash += 2;
54 	if (hash >= INT_MAX)
55 		hash = INT_MAX - 1;
56 	return hash;
57 }
58 
59 static int sysfs_name_compare(unsigned int hash, const char *name,
60 			      const void *ns, const struct sysfs_dirent *sd)
61 {
62 	if (hash != sd->s_hash)
63 		return hash - sd->s_hash;
64 	if (ns != sd->s_ns)
65 		return ns - sd->s_ns;
66 	return strcmp(name, sd->s_name);
67 }
68 
69 static int sysfs_sd_compare(const struct sysfs_dirent *left,
70 			    const struct sysfs_dirent *right)
71 {
72 	return sysfs_name_compare(left->s_hash, left->s_name, left->s_ns,
73 				  right);
74 }
75 
76 /**
77  *	sysfs_link_sibling - link sysfs_dirent into sibling rbtree
78  *	@sd: sysfs_dirent of interest
79  *
80  *	Link @sd into its sibling rbtree which starts from
81  *	sd->s_parent->s_dir.children.
82  *
83  *	Locking:
84  *	mutex_lock(sysfs_mutex)
85  *
86  *	RETURNS:
87  *	0 on susccess -EEXIST on failure.
88  */
89 static int sysfs_link_sibling(struct sysfs_dirent *sd)
90 {
91 	struct rb_node **node = &sd->s_parent->s_dir.children.rb_node;
92 	struct rb_node *parent = NULL;
93 
94 	if (sysfs_type(sd) == SYSFS_DIR)
95 		sd->s_parent->s_dir.subdirs++;
96 
97 	while (*node) {
98 		struct sysfs_dirent *pos;
99 		int result;
100 
101 		pos = to_sysfs_dirent(*node);
102 		parent = *node;
103 		result = sysfs_sd_compare(sd, pos);
104 		if (result < 0)
105 			node = &pos->s_rb.rb_left;
106 		else if (result > 0)
107 			node = &pos->s_rb.rb_right;
108 		else
109 			return -EEXIST;
110 	}
111 	/* add new node and rebalance the tree */
112 	rb_link_node(&sd->s_rb, parent, node);
113 	rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children);
114 
115 	/* if @sd has ns tag, mark the parent to enable ns filtering */
116 	if (sd->s_ns)
117 		sd->s_parent->s_flags |= SYSFS_FLAG_HAS_NS;
118 
119 	return 0;
120 }
121 
122 /**
123  *	sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree
124  *	@sd: sysfs_dirent of interest
125  *
126  *	Unlink @sd from its sibling rbtree which starts from
127  *	sd->s_parent->s_dir.children.
128  *
129  *	Locking:
130  *	mutex_lock(sysfs_mutex)
131  */
132 static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
133 {
134 	if (sysfs_type(sd) == SYSFS_DIR)
135 		sd->s_parent->s_dir.subdirs--;
136 
137 	rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children);
138 
139 	/*
140 	 * Either all or none of the children have tags.  Clearing HAS_NS
141 	 * when there's no child left is enough to keep the flag synced.
142 	 */
143 	if (RB_EMPTY_ROOT(&sd->s_parent->s_dir.children))
144 		sd->s_parent->s_flags &= ~SYSFS_FLAG_HAS_NS;
145 }
146 
147 #ifdef CONFIG_DEBUG_LOCK_ALLOC
148 
149 /* Test for attributes that want to ignore lockdep for read-locking */
150 static bool ignore_lockdep(struct sysfs_dirent *sd)
151 {
152 	return sysfs_type(sd) == SYSFS_KOBJ_ATTR &&
153 			sd->s_attr.attr->ignore_lockdep;
154 }
155 
156 #else
157 
158 static inline bool ignore_lockdep(struct sysfs_dirent *sd)
159 {
160 	return true;
161 }
162 
163 #endif
164 
165 /**
166  *	sysfs_get_active - get an active reference to sysfs_dirent
167  *	@sd: sysfs_dirent to get an active reference to
168  *
169  *	Get an active reference of @sd.  This function is noop if @sd
170  *	is NULL.
171  *
172  *	RETURNS:
173  *	Pointer to @sd on success, NULL on failure.
174  */
175 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
176 {
177 	if (unlikely(!sd))
178 		return NULL;
179 
180 	if (!atomic_inc_unless_negative(&sd->s_active))
181 		return NULL;
182 
183 	if (likely(!ignore_lockdep(sd)))
184 		rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
185 	return sd;
186 }
187 
188 /**
189  *	sysfs_put_active - put an active reference to sysfs_dirent
190  *	@sd: sysfs_dirent to put an active reference to
191  *
192  *	Put an active reference to @sd.  This function is noop if @sd
193  *	is NULL.
194  */
195 void sysfs_put_active(struct sysfs_dirent *sd)
196 {
197 	int v;
198 
199 	if (unlikely(!sd))
200 		return;
201 
202 	if (likely(!ignore_lockdep(sd)))
203 		rwsem_release(&sd->dep_map, 1, _RET_IP_);
204 	v = atomic_dec_return(&sd->s_active);
205 	if (likely(v != SD_DEACTIVATED_BIAS))
206 		return;
207 
208 	/* atomic_dec_return() is a mb(), we'll always see the updated
209 	 * sd->u.completion.
210 	 */
211 	complete(sd->u.completion);
212 }
213 
214 /**
215  *	sysfs_deactivate - deactivate sysfs_dirent
216  *	@sd: sysfs_dirent to deactivate
217  *
218  *	Deny new active references and drain existing ones.
219  */
220 static void sysfs_deactivate(struct sysfs_dirent *sd)
221 {
222 	DECLARE_COMPLETION_ONSTACK(wait);
223 	int v;
224 
225 	BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
226 
227 	if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
228 		return;
229 
230 	sd->u.completion = (void *)&wait;
231 
232 	rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
233 	/* atomic_add_return() is a mb(), put_active() will always see
234 	 * the updated sd->u.completion.
235 	 */
236 	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
237 
238 	if (v != SD_DEACTIVATED_BIAS) {
239 		lock_contended(&sd->dep_map, _RET_IP_);
240 		wait_for_completion(&wait);
241 	}
242 
243 	lock_acquired(&sd->dep_map, _RET_IP_);
244 	rwsem_release(&sd->dep_map, 1, _RET_IP_);
245 }
246 
247 static int sysfs_alloc_ino(unsigned int *pino)
248 {
249 	int ino, rc;
250 
251  retry:
252 	spin_lock(&sysfs_ino_lock);
253 	rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
254 	spin_unlock(&sysfs_ino_lock);
255 
256 	if (rc == -EAGAIN) {
257 		if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
258 			goto retry;
259 		rc = -ENOMEM;
260 	}
261 
262 	*pino = ino;
263 	return rc;
264 }
265 
266 static void sysfs_free_ino(unsigned int ino)
267 {
268 	spin_lock(&sysfs_ino_lock);
269 	ida_remove(&sysfs_ino_ida, ino);
270 	spin_unlock(&sysfs_ino_lock);
271 }
272 
273 void release_sysfs_dirent(struct sysfs_dirent *sd)
274 {
275 	struct sysfs_dirent *parent_sd;
276 
277  repeat:
278 	/* Moving/renaming is always done while holding reference.
279 	 * sd->s_parent won't change beneath us.
280 	 */
281 	parent_sd = sd->s_parent;
282 
283 	WARN(!(sd->s_flags & SYSFS_FLAG_REMOVED),
284 		"sysfs: free using entry: %s/%s\n",
285 		parent_sd ? parent_sd->s_name : "", sd->s_name);
286 
287 	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
288 		sysfs_put(sd->s_symlink.target_sd);
289 	if (sysfs_type(sd) & SYSFS_COPY_NAME)
290 		kfree(sd->s_name);
291 	if (sd->s_iattr && sd->s_iattr->ia_secdata)
292 		security_release_secctx(sd->s_iattr->ia_secdata,
293 					sd->s_iattr->ia_secdata_len);
294 	kfree(sd->s_iattr);
295 	sysfs_free_ino(sd->s_ino);
296 	kmem_cache_free(sysfs_dir_cachep, sd);
297 
298 	sd = parent_sd;
299 	if (sd && atomic_dec_and_test(&sd->s_count))
300 		goto repeat;
301 }
302 
303 static int sysfs_dentry_delete(const struct dentry *dentry)
304 {
305 	struct sysfs_dirent *sd = dentry->d_fsdata;
306 	return !(sd && !(sd->s_flags & SYSFS_FLAG_REMOVED));
307 }
308 
309 static int sysfs_dentry_revalidate(struct dentry *dentry, unsigned int flags)
310 {
311 	struct sysfs_dirent *sd;
312 
313 	if (flags & LOOKUP_RCU)
314 		return -ECHILD;
315 
316 	sd = dentry->d_fsdata;
317 	mutex_lock(&sysfs_mutex);
318 
319 	/* The sysfs dirent has been deleted */
320 	if (sd->s_flags & SYSFS_FLAG_REMOVED)
321 		goto out_bad;
322 
323 	/* The sysfs dirent has been moved? */
324 	if (dentry->d_parent->d_fsdata != sd->s_parent)
325 		goto out_bad;
326 
327 	/* The sysfs dirent has been renamed */
328 	if (strcmp(dentry->d_name.name, sd->s_name) != 0)
329 		goto out_bad;
330 
331 	/* The sysfs dirent has been moved to a different namespace */
332 	if (sd->s_ns && sd->s_ns != sysfs_info(dentry->d_sb)->ns)
333 		goto out_bad;
334 
335 	mutex_unlock(&sysfs_mutex);
336 out_valid:
337 	return 1;
338 out_bad:
339 	/* Remove the dentry from the dcache hashes.
340 	 * If this is a deleted dentry we use d_drop instead of d_delete
341 	 * so sysfs doesn't need to cope with negative dentries.
342 	 *
343 	 * If this is a dentry that has simply been renamed we
344 	 * use d_drop to remove it from the dcache lookup on its
345 	 * old parent.  If this dentry persists later when a lookup
346 	 * is performed at its new name the dentry will be readded
347 	 * to the dcache hashes.
348 	 */
349 	mutex_unlock(&sysfs_mutex);
350 
351 	/* If we have submounts we must allow the vfs caches
352 	 * to lie about the state of the filesystem to prevent
353 	 * leaks and other nasty things.
354 	 */
355 	if (check_submounts_and_drop(dentry) != 0)
356 		goto out_valid;
357 
358 	return 0;
359 }
360 
361 static void sysfs_dentry_release(struct dentry *dentry)
362 {
363 	sysfs_put(dentry->d_fsdata);
364 }
365 
366 const struct dentry_operations sysfs_dentry_ops = {
367 	.d_revalidate	= sysfs_dentry_revalidate,
368 	.d_delete	= sysfs_dentry_delete,
369 	.d_release	= sysfs_dentry_release,
370 };
371 
372 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
373 {
374 	char *dup_name = NULL;
375 	struct sysfs_dirent *sd;
376 
377 	if (type & SYSFS_COPY_NAME) {
378 		name = dup_name = kstrdup(name, GFP_KERNEL);
379 		if (!name)
380 			return NULL;
381 	}
382 
383 	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
384 	if (!sd)
385 		goto err_out1;
386 
387 	if (sysfs_alloc_ino(&sd->s_ino))
388 		goto err_out2;
389 
390 	atomic_set(&sd->s_count, 1);
391 	atomic_set(&sd->s_active, 0);
392 
393 	sd->s_name = name;
394 	sd->s_mode = mode;
395 	sd->s_flags = type | SYSFS_FLAG_REMOVED;
396 
397 	return sd;
398 
399  err_out2:
400 	kmem_cache_free(sysfs_dir_cachep, sd);
401  err_out1:
402 	kfree(dup_name);
403 	return NULL;
404 }
405 
406 /**
407  *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
408  *	@acxt: pointer to sysfs_addrm_cxt to be used
409  *	@parent_sd: parent sysfs_dirent
410  *
411  *	This function is called when the caller is about to add or
412  *	remove sysfs_dirent under @parent_sd.  This function acquires
413  *	sysfs_mutex.  @acxt is used to keep and pass context to
414  *	other addrm functions.
415  *
416  *	LOCKING:
417  *	Kernel thread context (may sleep).  sysfs_mutex is locked on
418  *	return.
419  */
420 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
421 		       struct sysfs_dirent *parent_sd)
422 {
423 	memset(acxt, 0, sizeof(*acxt));
424 	acxt->parent_sd = parent_sd;
425 
426 	mutex_lock(&sysfs_mutex);
427 }
428 
429 /**
430  *	__sysfs_add_one - add sysfs_dirent to parent without warning
431  *	@acxt: addrm context to use
432  *	@sd: sysfs_dirent to be added
433  *
434  *	Get @acxt->parent_sd and set sd->s_parent to it and increment
435  *	nlink of parent inode if @sd is a directory and link into the
436  *	children list of the parent.
437  *
438  *	This function should be called between calls to
439  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
440  *	passed the same @acxt as passed to sysfs_addrm_start().
441  *
442  *	LOCKING:
443  *	Determined by sysfs_addrm_start().
444  *
445  *	RETURNS:
446  *	0 on success, -EEXIST if entry with the given name already
447  *	exists.
448  */
449 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
450 {
451 	struct sysfs_inode_attrs *ps_iattr;
452 	int ret;
453 
454 	sd->s_hash = sysfs_name_hash(sd->s_name, sd->s_ns);
455 	sd->s_parent = sysfs_get(acxt->parent_sd);
456 
457 	ret = sysfs_link_sibling(sd);
458 	if (ret)
459 		return ret;
460 
461 	/* Update timestamps on the parent */
462 	ps_iattr = acxt->parent_sd->s_iattr;
463 	if (ps_iattr) {
464 		struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
465 		ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
466 	}
467 
468 	/* Mark the entry added into directory tree */
469 	sd->s_flags &= ~SYSFS_FLAG_REMOVED;
470 
471 	return 0;
472 }
473 
474 /**
475  *	sysfs_pathname - return full path to sysfs dirent
476  *	@sd: sysfs_dirent whose path we want
477  *	@path: caller allocated buffer of size PATH_MAX
478  *
479  *	Gives the name "/" to the sysfs_root entry; any path returned
480  *	is relative to wherever sysfs is mounted.
481  */
482 static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
483 {
484 	if (sd->s_parent) {
485 		sysfs_pathname(sd->s_parent, path);
486 		strlcat(path, "/", PATH_MAX);
487 	}
488 	strlcat(path, sd->s_name, PATH_MAX);
489 	return path;
490 }
491 
492 /**
493  *	sysfs_add_one - add sysfs_dirent to parent
494  *	@acxt: addrm context to use
495  *	@sd: sysfs_dirent to be added
496  *
497  *	Get @acxt->parent_sd and set sd->s_parent to it and increment
498  *	nlink of parent inode if @sd is a directory and link into the
499  *	children list of the parent.
500  *
501  *	This function should be called between calls to
502  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
503  *	passed the same @acxt as passed to sysfs_addrm_start().
504  *
505  *	LOCKING:
506  *	Determined by sysfs_addrm_start().
507  *
508  *	RETURNS:
509  *	0 on success, -EEXIST if entry with the given name already
510  *	exists.
511  */
512 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
513 {
514 	int ret;
515 
516 	ret = __sysfs_add_one(acxt, sd);
517 	if (ret == -EEXIST) {
518 		char *path = kzalloc(PATH_MAX, GFP_KERNEL);
519 		WARN(1, KERN_WARNING
520 		     "sysfs: cannot create duplicate filename '%s'\n",
521 		     (path == NULL) ? sd->s_name
522 				    : (sysfs_pathname(acxt->parent_sd, path),
523 				       strlcat(path, "/", PATH_MAX),
524 				       strlcat(path, sd->s_name, PATH_MAX),
525 				       path));
526 		kfree(path);
527 	}
528 
529 	return ret;
530 }
531 
532 /**
533  *	sysfs_remove_one - remove sysfs_dirent from parent
534  *	@acxt: addrm context to use
535  *	@sd: sysfs_dirent to be removed
536  *
537  *	Mark @sd removed and drop nlink of parent inode if @sd is a
538  *	directory.  @sd is unlinked from the children list.
539  *
540  *	This function should be called between calls to
541  *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
542  *	passed the same @acxt as passed to sysfs_addrm_start().
543  *
544  *	LOCKING:
545  *	Determined by sysfs_addrm_start().
546  */
547 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
548 {
549 	struct sysfs_inode_attrs *ps_iattr;
550 
551 	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
552 
553 	sysfs_unlink_sibling(sd);
554 
555 	/* Update timestamps on the parent */
556 	ps_iattr = acxt->parent_sd->s_iattr;
557 	if (ps_iattr) {
558 		struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
559 		ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
560 	}
561 
562 	sd->s_flags |= SYSFS_FLAG_REMOVED;
563 	sd->u.removed_list = acxt->removed;
564 	acxt->removed = sd;
565 }
566 
567 /**
568  *	sysfs_addrm_finish - finish up sysfs_dirent add/remove
569  *	@acxt: addrm context to finish up
570  *
571  *	Finish up sysfs_dirent add/remove.  Resources acquired by
572  *	sysfs_addrm_start() are released and removed sysfs_dirents are
573  *	cleaned up.
574  *
575  *	LOCKING:
576  *	sysfs_mutex is released.
577  */
578 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
579 {
580 	/* release resources acquired by sysfs_addrm_start() */
581 	mutex_unlock(&sysfs_mutex);
582 
583 	/* kill removed sysfs_dirents */
584 	while (acxt->removed) {
585 		struct sysfs_dirent *sd = acxt->removed;
586 
587 		acxt->removed = sd->u.removed_list;
588 
589 		sysfs_deactivate(sd);
590 		unmap_bin_file(sd);
591 		sysfs_put(sd);
592 	}
593 }
594 
595 /**
596  *	sysfs_find_dirent - find sysfs_dirent with the given name
597  *	@parent_sd: sysfs_dirent to search under
598  *	@name: name to look for
599  *	@ns: the namespace tag to use
600  *
601  *	Look for sysfs_dirent with name @name under @parent_sd.
602  *
603  *	LOCKING:
604  *	mutex_lock(sysfs_mutex)
605  *
606  *	RETURNS:
607  *	Pointer to sysfs_dirent if found, NULL if not.
608  */
609 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
610 				       const unsigned char *name,
611 				       const void *ns)
612 {
613 	struct rb_node *node = parent_sd->s_dir.children.rb_node;
614 	unsigned int hash;
615 
616 	hash = sysfs_name_hash(name, ns);
617 	while (node) {
618 		struct sysfs_dirent *sd;
619 		int result;
620 
621 		sd = to_sysfs_dirent(node);
622 		result = sysfs_name_compare(hash, name, ns, sd);
623 		if (result < 0)
624 			node = node->rb_left;
625 		else if (result > 0)
626 			node = node->rb_right;
627 		else
628 			return sd;
629 	}
630 	return NULL;
631 }
632 
633 /**
634  *	sysfs_get_dirent_ns - find and get sysfs_dirent with the given name
635  *	@parent_sd: sysfs_dirent to search under
636  *	@name: name to look for
637  *	@ns: the namespace tag to use
638  *
639  *	Look for sysfs_dirent with name @name under @parent_sd and get
640  *	it if found.
641  *
642  *	LOCKING:
643  *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
644  *
645  *	RETURNS:
646  *	Pointer to sysfs_dirent if found, NULL if not.
647  */
648 struct sysfs_dirent *sysfs_get_dirent_ns(struct sysfs_dirent *parent_sd,
649 					 const unsigned char *name,
650 					 const void *ns)
651 {
652 	struct sysfs_dirent *sd;
653 
654 	mutex_lock(&sysfs_mutex);
655 	sd = sysfs_find_dirent(parent_sd, name, ns);
656 	sysfs_get(sd);
657 	mutex_unlock(&sysfs_mutex);
658 
659 	return sd;
660 }
661 EXPORT_SYMBOL_GPL(sysfs_get_dirent_ns);
662 
663 static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
664 		      const char *name, const void *ns,
665 		      struct sysfs_dirent **p_sd)
666 {
667 	umode_t mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
668 	struct sysfs_addrm_cxt acxt;
669 	struct sysfs_dirent *sd;
670 	int rc;
671 
672 	/* allocate */
673 	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
674 	if (!sd)
675 		return -ENOMEM;
676 
677 	sd->s_ns = ns;
678 	sd->s_dir.kobj = kobj;
679 
680 	/* link in */
681 	sysfs_addrm_start(&acxt, parent_sd);
682 	rc = sysfs_add_one(&acxt, sd);
683 	sysfs_addrm_finish(&acxt);
684 
685 	if (rc == 0)
686 		*p_sd = sd;
687 	else
688 		sysfs_put(sd);
689 
690 	return rc;
691 }
692 
693 int sysfs_create_subdir(struct kobject *kobj, const char *name,
694 			struct sysfs_dirent **p_sd)
695 {
696 	return create_dir(kobj, kobj->sd, name, NULL, p_sd);
697 }
698 
699 /**
700  * sysfs_create_dir_ns - create a directory for an object with a namespace tag
701  * @kobj: object we're creating directory for
702  * @ns: the namespace tag to use
703  */
704 int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
705 {
706 	struct sysfs_dirent *parent_sd, *sd;
707 	int error = 0;
708 
709 	BUG_ON(!kobj);
710 
711 	if (kobj->parent)
712 		parent_sd = kobj->parent->sd;
713 	else
714 		parent_sd = &sysfs_root;
715 
716 	if (!parent_sd)
717 		return -ENOENT;
718 
719 	error = create_dir(kobj, parent_sd, kobject_name(kobj), ns, &sd);
720 	if (!error)
721 		kobj->sd = sd;
722 	return error;
723 }
724 
725 static struct dentry *sysfs_lookup(struct inode *dir, struct dentry *dentry,
726 				   unsigned int flags)
727 {
728 	struct dentry *ret = NULL;
729 	struct dentry *parent = dentry->d_parent;
730 	struct sysfs_dirent *parent_sd = parent->d_fsdata;
731 	struct sysfs_dirent *sd;
732 	struct inode *inode;
733 	const void *ns = NULL;
734 
735 	mutex_lock(&sysfs_mutex);
736 
737 	if (parent_sd->s_flags & SYSFS_FLAG_HAS_NS)
738 		ns = sysfs_info(dir->i_sb)->ns;
739 
740 	sd = sysfs_find_dirent(parent_sd, dentry->d_name.name, ns);
741 
742 	/* no such entry */
743 	if (!sd) {
744 		ret = ERR_PTR(-ENOENT);
745 		goto out_unlock;
746 	}
747 	dentry->d_fsdata = sysfs_get(sd);
748 
749 	/* attach dentry and inode */
750 	inode = sysfs_get_inode(dir->i_sb, sd);
751 	if (!inode) {
752 		ret = ERR_PTR(-ENOMEM);
753 		goto out_unlock;
754 	}
755 
756 	/* instantiate and hash dentry */
757 	ret = d_materialise_unique(dentry, inode);
758  out_unlock:
759 	mutex_unlock(&sysfs_mutex);
760 	return ret;
761 }
762 
763 const struct inode_operations sysfs_dir_inode_operations = {
764 	.lookup		= sysfs_lookup,
765 	.permission	= sysfs_permission,
766 	.setattr	= sysfs_setattr,
767 	.getattr	= sysfs_getattr,
768 	.setxattr	= sysfs_setxattr,
769 };
770 
771 static void remove_dir(struct sysfs_dirent *sd)
772 {
773 	struct sysfs_addrm_cxt acxt;
774 
775 	sysfs_addrm_start(&acxt, sd->s_parent);
776 	sysfs_remove_one(&acxt, sd);
777 	sysfs_addrm_finish(&acxt);
778 }
779 
780 void sysfs_remove_subdir(struct sysfs_dirent *sd)
781 {
782 	remove_dir(sd);
783 }
784 
785 
786 static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
787 {
788 	struct sysfs_addrm_cxt acxt;
789 	struct rb_node *pos;
790 
791 	if (!dir_sd)
792 		return;
793 
794 	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
795 	sysfs_addrm_start(&acxt, dir_sd);
796 	pos = rb_first(&dir_sd->s_dir.children);
797 	while (pos) {
798 		struct sysfs_dirent *sd = to_sysfs_dirent(pos);
799 		pos = rb_next(pos);
800 		if (sysfs_type(sd) != SYSFS_DIR)
801 			sysfs_remove_one(&acxt, sd);
802 	}
803 	sysfs_addrm_finish(&acxt);
804 
805 	remove_dir(dir_sd);
806 }
807 
808 /**
809  *	sysfs_remove_dir - remove an object's directory.
810  *	@kobj:	object.
811  *
812  *	The only thing special about this is that we remove any files in
813  *	the directory before we remove the directory, and we've inlined
814  *	what used to be sysfs_rmdir() below, instead of calling separately.
815  */
816 
817 void sysfs_remove_dir(struct kobject *kobj)
818 {
819 	struct sysfs_dirent *sd = kobj->sd;
820 
821 	spin_lock(&sysfs_assoc_lock);
822 	kobj->sd = NULL;
823 	spin_unlock(&sysfs_assoc_lock);
824 
825 	__sysfs_remove_dir(sd);
826 }
827 
828 int sysfs_rename(struct sysfs_dirent *sd, struct sysfs_dirent *new_parent_sd,
829 		 const char *new_name, const void *new_ns)
830 {
831 	int error;
832 
833 	mutex_lock(&sysfs_mutex);
834 
835 	error = 0;
836 	if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
837 	    (strcmp(sd->s_name, new_name) == 0))
838 		goto out;	/* nothing to rename */
839 
840 	error = -EEXIST;
841 	if (sysfs_find_dirent(new_parent_sd, new_name, new_ns))
842 		goto out;
843 
844 	/* rename sysfs_dirent */
845 	if (strcmp(sd->s_name, new_name) != 0) {
846 		error = -ENOMEM;
847 		new_name = kstrdup(new_name, GFP_KERNEL);
848 		if (!new_name)
849 			goto out;
850 
851 		kfree(sd->s_name);
852 		sd->s_name = new_name;
853 	}
854 
855 	/*
856 	 * Move to the appropriate place in the appropriate directories rbtree.
857 	 */
858 	sysfs_unlink_sibling(sd);
859 	sysfs_get(new_parent_sd);
860 	sysfs_put(sd->s_parent);
861 	sd->s_ns = new_ns;
862 	sd->s_hash = sysfs_name_hash(sd->s_name, sd->s_ns);
863 	sd->s_parent = new_parent_sd;
864 	sysfs_link_sibling(sd);
865 
866 	error = 0;
867  out:
868 	mutex_unlock(&sysfs_mutex);
869 	return error;
870 }
871 
872 int sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
873 			const void *new_ns)
874 {
875 	struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
876 
877 	return sysfs_rename(kobj->sd, parent_sd, new_name, new_ns);
878 }
879 
880 int sysfs_move_dir_ns(struct kobject *kobj, struct kobject *new_parent_kobj,
881 		      const void *new_ns)
882 {
883 	struct sysfs_dirent *sd = kobj->sd;
884 	struct sysfs_dirent *new_parent_sd;
885 
886 	BUG_ON(!sd->s_parent);
887 	new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
888 		new_parent_kobj->sd : &sysfs_root;
889 
890 	return sysfs_rename(sd, new_parent_sd, sd->s_name, new_ns);
891 }
892 
893 /* Relationship between s_mode and the DT_xxx types */
894 static inline unsigned char dt_type(struct sysfs_dirent *sd)
895 {
896 	return (sd->s_mode >> 12) & 15;
897 }
898 
899 static int sysfs_dir_release(struct inode *inode, struct file *filp)
900 {
901 	sysfs_put(filp->private_data);
902 	return 0;
903 }
904 
905 static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
906 	struct sysfs_dirent *parent_sd,	loff_t hash, struct sysfs_dirent *pos)
907 {
908 	if (pos) {
909 		int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
910 			pos->s_parent == parent_sd &&
911 			hash == pos->s_hash;
912 		sysfs_put(pos);
913 		if (!valid)
914 			pos = NULL;
915 	}
916 	if (!pos && (hash > 1) && (hash < INT_MAX)) {
917 		struct rb_node *node = parent_sd->s_dir.children.rb_node;
918 		while (node) {
919 			pos = to_sysfs_dirent(node);
920 
921 			if (hash < pos->s_hash)
922 				node = node->rb_left;
923 			else if (hash > pos->s_hash)
924 				node = node->rb_right;
925 			else
926 				break;
927 		}
928 	}
929 	/* Skip over entries in the wrong namespace */
930 	while (pos && pos->s_ns != ns) {
931 		struct rb_node *node = rb_next(&pos->s_rb);
932 		if (!node)
933 			pos = NULL;
934 		else
935 			pos = to_sysfs_dirent(node);
936 	}
937 	return pos;
938 }
939 
940 static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
941 	struct sysfs_dirent *parent_sd,	ino_t ino, struct sysfs_dirent *pos)
942 {
943 	pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
944 	if (pos)
945 		do {
946 			struct rb_node *node = rb_next(&pos->s_rb);
947 			if (!node)
948 				pos = NULL;
949 			else
950 				pos = to_sysfs_dirent(node);
951 		} while (pos && pos->s_ns != ns);
952 	return pos;
953 }
954 
955 static int sysfs_readdir(struct file *file, struct dir_context *ctx)
956 {
957 	struct dentry *dentry = file->f_path.dentry;
958 	struct sysfs_dirent *parent_sd = dentry->d_fsdata;
959 	struct sysfs_dirent *pos = file->private_data;
960 	const void *ns = NULL;
961 
962 	if (!dir_emit_dots(file, ctx))
963 		return 0;
964 	mutex_lock(&sysfs_mutex);
965 
966 	if (parent_sd->s_flags & SYSFS_FLAG_HAS_NS)
967 		ns = sysfs_info(dentry->d_sb)->ns;
968 
969 	for (pos = sysfs_dir_pos(ns, parent_sd, ctx->pos, pos);
970 	     pos;
971 	     pos = sysfs_dir_next_pos(ns, parent_sd, ctx->pos, pos)) {
972 		const char *name = pos->s_name;
973 		unsigned int type = dt_type(pos);
974 		int len = strlen(name);
975 		ino_t ino = pos->s_ino;
976 		ctx->pos = pos->s_hash;
977 		file->private_data = sysfs_get(pos);
978 
979 		mutex_unlock(&sysfs_mutex);
980 		if (!dir_emit(ctx, name, len, ino, type))
981 			return 0;
982 		mutex_lock(&sysfs_mutex);
983 	}
984 	mutex_unlock(&sysfs_mutex);
985 	file->private_data = NULL;
986 	ctx->pos = INT_MAX;
987 	return 0;
988 }
989 
990 static loff_t sysfs_dir_llseek(struct file *file, loff_t offset, int whence)
991 {
992 	struct inode *inode = file_inode(file);
993 	loff_t ret;
994 
995 	mutex_lock(&inode->i_mutex);
996 	ret = generic_file_llseek(file, offset, whence);
997 	mutex_unlock(&inode->i_mutex);
998 
999 	return ret;
1000 }
1001 
1002 const struct file_operations sysfs_dir_operations = {
1003 	.read		= generic_read_dir,
1004 	.iterate	= sysfs_readdir,
1005 	.release	= sysfs_dir_release,
1006 	.llseek		= sysfs_dir_llseek,
1007 };
1008