dir.c 24.8 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
T
Tejun Heo 已提交
2 3 4 5 6 7 8 9 10
 * fs/sysfs/dir.c - sysfs core and dir operation implementation
 *
 * Copyright (c) 2001-3 Patrick Mochel
 * Copyright (c) 2007 SUSE Linux Products GmbH
 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
 *
 * This file is released under the GPLv2.
 *
 * Please see Documentation/filesystems/sysfs.txt for more information.
L
Linus Torvalds 已提交
11 12 13 14 15 16 17 18
 */

#undef DEBUG

#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/module.h>
#include <linux/kobject.h>
19
#include <linux/namei.h>
20
#include <linux/idr.h>
21
#include <linux/completion.h>
D
Dave Young 已提交
22
#include <linux/mutex.h>
23
#include <linux/slab.h>
24
#include <linux/security.h>
25
#include <linux/hash.h>
L
Linus Torvalds 已提交
26 27
#include "sysfs.h"

28
DEFINE_MUTEX(sysfs_mutex);
R
Roel Kluin 已提交
29
DEFINE_SPINLOCK(sysfs_assoc_lock);
L
Linus Torvalds 已提交
30

31 32
#define to_sysfs_dirent(X) rb_entry((X), struct sysfs_dirent, s_rb);

R
Roel Kluin 已提交
33
static DEFINE_SPINLOCK(sysfs_ino_lock);
34 35
static DEFINE_IDA(sysfs_ino_ida);

36
/**
37 38 39 40 41 42 43 44 45 46 47 48
 *	sysfs_name_hash
 *	@ns:   Namespace tag to hash
 *	@name: Null terminated string to hash
 *
 *	Returns 31 bit hash of ns + name (so it fits in an off_t )
 */
static unsigned int sysfs_name_hash(const void *ns, const char *name)
{
	unsigned long hash = init_name_hash();
	unsigned int len = strlen(name);
	while (len--)
		hash = partial_name_hash(*name++, hash);
49
	hash = (end_name_hash(hash) ^ hash_ptr((void *)ns, 31));
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
	hash &= 0x7fffffffU;
	/* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
	if (hash < 1)
		hash += 2;
	if (hash >= INT_MAX)
		hash = INT_MAX - 1;
	return hash;
}

static int sysfs_name_compare(unsigned int hash, const void *ns,
	const char *name, const struct sysfs_dirent *sd)
{
	if (hash != sd->s_hash)
		return hash - sd->s_hash;
	if (ns != sd->s_ns)
		return ns - sd->s_ns;
	return strcmp(name, sd->s_name);
}

static int sysfs_sd_compare(const struct sysfs_dirent *left,
			    const struct sysfs_dirent *right)
{
	return sysfs_name_compare(left->s_hash, left->s_ns, left->s_name,
				  right);
}

/**
77
 *	sysfs_link_sibling - link sysfs_dirent into sibling rbtree
78 79
 *	@sd: sysfs_dirent of interest
 *
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 87
 *
 *	RETURNS:
 *	0 on susccess -EEXIST on failure.
88
 */
89
static int sysfs_link_sibling(struct sysfs_dirent *sd)
90
{
91 92
	struct rb_node **node = &sd->s_parent->s_dir.children.rb_node;
	struct rb_node *parent = NULL;
93

94 95 96
	if (sysfs_type(sd) == SYSFS_DIR)
		sd->s_parent->s_dir.subdirs++;

97 98 99 100 101 102 103 104 105 106 107 108 109
	while (*node) {
		struct sysfs_dirent *pos;
		int result;

		pos = to_sysfs_dirent(*node);
		parent = *node;
		result = sysfs_sd_compare(sd, pos);
		if (result < 0)
			node = &pos->s_rb.rb_left;
		else if (result > 0)
			node = &pos->s_rb.rb_right;
		else
			return -EEXIST;
110
	}
111 112 113 114
	/* add new node and rebalance the tree */
	rb_link_node(&sd->s_rb, parent, node);
	rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children);
	return 0;
115 116 117
}

/**
118
 *	sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree
119 120
 *	@sd: sysfs_dirent of interest
 *
121
 *	Unlink @sd from its sibling rbtree which starts from
122
 *	sd->s_parent->s_dir.children.
123 124
 *
 *	Locking:
125
 *	mutex_lock(sysfs_mutex)
126
 */
127
static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
128
{
129 130 131
	if (sysfs_type(sd) == SYSFS_DIR)
		sd->s_parent->s_dir.subdirs--;

132
	rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children);
133 134
}

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
#ifdef CONFIG_DEBUG_LOCK_ALLOC

/* Test for attributes that want to ignore lockdep for read-locking */
static bool ignore_lockdep(struct sysfs_dirent *sd)
{
	return sysfs_type(sd) == SYSFS_KOBJ_ATTR &&
			sd->s_attr.attr->ignore_lockdep;
}

#else

static inline bool ignore_lockdep(struct sysfs_dirent *sd)
{
	return true;
}

#endif

153 154 155 156 157 158 159 160 161 162
/**
 *	sysfs_get_active - get an active reference to sysfs_dirent
 *	@sd: sysfs_dirent to get an active reference to
 *
 *	Get an active reference of @sd.  This function is noop if @sd
 *	is NULL.
 *
 *	RETURNS:
 *	Pointer to @sd on success, NULL on failure.
 */
163
struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
164
{
165 166 167
	if (unlikely(!sd))
		return NULL;

168 169
	if (!atomic_inc_unless_negative(&sd->s_active))
		return NULL;
170 171 172 173

	if (likely(!ignore_lockdep(sd)))
		rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
	return sd;
174 175 176 177 178 179 180 181 182
}

/**
 *	sysfs_put_active - put an active reference to sysfs_dirent
 *	@sd: sysfs_dirent to put an active reference to
 *
 *	Put an active reference to @sd.  This function is noop if @sd
 *	is NULL.
 */
183
void sysfs_put_active(struct sysfs_dirent *sd)
184
{
185 186 187 188 189
	int v;

	if (unlikely(!sd))
		return;

190 191
	if (likely(!ignore_lockdep(sd)))
		rwsem_release(&sd->dep_map, 1, _RET_IP_);
192 193 194 195 196
	v = atomic_dec_return(&sd->s_active);
	if (likely(v != SD_DEACTIVATED_BIAS))
		return;

	/* atomic_dec_return() is a mb(), we'll always see the updated
M
Mikulas Patocka 已提交
197
	 * sd->u.completion.
198
	 */
M
Mikulas Patocka 已提交
199
	complete(sd->u.completion);
200 201 202 203 204 205
}

/**
 *	sysfs_deactivate - deactivate sysfs_dirent
 *	@sd: sysfs_dirent to deactivate
 *
206
 *	Deny new active references and drain existing ones.
207
 */
208
static void sysfs_deactivate(struct sysfs_dirent *sd)
209
{
210 211
	DECLARE_COMPLETION_ONSTACK(wait);
	int v;
212

M
Mikulas Patocka 已提交
213
	BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
214 215 216 217

	if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
		return;

M
Mikulas Patocka 已提交
218
	sd->u.completion = (void *)&wait;
219

220
	rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
221
	/* atomic_add_return() is a mb(), put_active() will always see
M
Mikulas Patocka 已提交
222
	 * the updated sd->u.completion.
223
	 */
224 225
	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);

226 227
	if (v != SD_DEACTIVATED_BIAS) {
		lock_contended(&sd->dep_map, _RET_IP_);
228
		wait_for_completion(&wait);
229
	}
230

231 232
	lock_acquired(&sd->dep_map, _RET_IP_);
	rwsem_release(&sd->dep_map, 1, _RET_IP_);
233 234
}

235
static int sysfs_alloc_ino(unsigned int *pino)
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
{
	int ino, rc;

 retry:
	spin_lock(&sysfs_ino_lock);
	rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
	spin_unlock(&sysfs_ino_lock);

	if (rc == -EAGAIN) {
		if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
			goto retry;
		rc = -ENOMEM;
	}

	*pino = ino;
	return rc;
}

254
static void sysfs_free_ino(unsigned int ino)
255 256 257 258 259 260
{
	spin_lock(&sysfs_ino_lock);
	ida_remove(&sysfs_ino_ida, ino);
	spin_unlock(&sysfs_ino_lock);
}

261
void release_sysfs_dirent(struct sysfs_dirent *sd)
262
{
T
Tejun Heo 已提交
263 264 265
	struct sysfs_dirent *parent_sd;

 repeat:
266 267 268
	/* Moving/renaming is always done while holding reference.
	 * sd->s_parent won't change beneath us.
	 */
T
Tejun Heo 已提交
269 270
	parent_sd = sd->s_parent;

271 272 273 274
	WARN(!(sd->s_flags & SYSFS_FLAG_REMOVED),
		"sysfs: free using entry: %s/%s\n",
		parent_sd ? parent_sd->s_name : "", sd->s_name);

275
	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
T
Tejun Heo 已提交
276
		sysfs_put(sd->s_symlink.target_sd);
277
	if (sysfs_type(sd) & SYSFS_COPY_NAME)
T
Tejun Heo 已提交
278
		kfree(sd->s_name);
279 280 281
	if (sd->s_iattr && sd->s_iattr->ia_secdata)
		security_release_secctx(sd->s_iattr->ia_secdata,
					sd->s_iattr->ia_secdata_len);
282
	kfree(sd->s_iattr);
283
	sysfs_free_ino(sd->s_ino);
284
	kmem_cache_free(sysfs_dir_cachep, sd);
T
Tejun Heo 已提交
285 286 287 288

	sd = parent_sd;
	if (sd && atomic_dec_and_test(&sd->s_count))
		goto repeat;
289 290
}

N
Nick Piggin 已提交
291
static int sysfs_dentry_delete(const struct dentry *dentry)
292 293
{
	struct sysfs_dirent *sd = dentry->d_fsdata;
294
	return !(sd && !(sd->s_flags & SYSFS_FLAG_REMOVED));
295 296
}

297
static int sysfs_dentry_revalidate(struct dentry *dentry, unsigned int flags)
298
{
299
	struct sysfs_dirent *sd;
300
	int is_dir;
301
	int type;
302

303
	if (flags & LOOKUP_RCU)
304 305 306
		return -ECHILD;

	sd = dentry->d_fsdata;
307 308 309 310 311 312
	mutex_lock(&sysfs_mutex);

	/* The sysfs dirent has been deleted */
	if (sd->s_flags & SYSFS_FLAG_REMOVED)
		goto out_bad;

313 314 315 316 317 318 319 320
	/* The sysfs dirent has been moved? */
	if (dentry->d_parent->d_fsdata != sd->s_parent)
		goto out_bad;

	/* The sysfs dirent has been renamed */
	if (strcmp(dentry->d_name.name, sd->s_name) != 0)
		goto out_bad;

321 322
	/* The sysfs dirent has been moved to a different namespace */
	type = KOBJ_NS_TYPE_NONE;
323
	if (sd->s_parent) {
324
		type = sysfs_ns_type(sd->s_parent);
325 326 327 328
		if (type != KOBJ_NS_TYPE_NONE &&
				sysfs_info(dentry->d_sb)->ns[type] != sd->s_ns)
			goto out_bad;
	}
329

330 331 332 333 334 335 336
	mutex_unlock(&sysfs_mutex);
out_valid:
	return 1;
out_bad:
	/* Remove the dentry from the dcache hashes.
	 * If this is a deleted dentry we use d_drop instead of d_delete
	 * so sysfs doesn't need to cope with negative dentries.
337 338 339 340 341 342
	 *
	 * If this is a dentry that has simply been renamed we
	 * use d_drop to remove it from the dcache lookup on its
	 * old parent.  If this dentry persists later when a lookup
	 * is performed at its new name the dentry will be readded
	 * to the dcache hashes.
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
	 */
	is_dir = (sysfs_type(sd) == SYSFS_DIR);
	mutex_unlock(&sysfs_mutex);
	if (is_dir) {
		/* If we have submounts we must allow the vfs caches
		 * to lie about the state of the filesystem to prevent
		 * leaks and other nasty things.
		 */
		if (have_submounts(dentry))
			goto out_valid;
		shrink_dcache_parent(dentry);
	}
	d_drop(dentry);
	return 0;
}

359
static void sysfs_dentry_release(struct dentry *dentry)
L
Linus Torvalds 已提交
360
{
361
	sysfs_put(dentry->d_fsdata);
L
Linus Torvalds 已提交
362 363
}

364
const struct dentry_operations sysfs_dentry_ops = {
365 366
	.d_revalidate	= sysfs_dentry_revalidate,
	.d_delete	= sysfs_dentry_delete,
367
	.d_release	= sysfs_dentry_release,
L
Linus Torvalds 已提交
368 369
};

370
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
L
Linus Torvalds 已提交
371
{
T
Tejun Heo 已提交
372
	char *dup_name = NULL;
373
	struct sysfs_dirent *sd;
T
Tejun Heo 已提交
374 375 376 377

	if (type & SYSFS_COPY_NAME) {
		name = dup_name = kstrdup(name, GFP_KERNEL);
		if (!name)
378
			return NULL;
T
Tejun Heo 已提交
379
	}
L
Linus Torvalds 已提交
380

381
	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
382
	if (!sd)
383
		goto err_out1;
L
Linus Torvalds 已提交
384

T
Tejun Heo 已提交
385
	if (sysfs_alloc_ino(&sd->s_ino))
386
		goto err_out2;
387

L
Linus Torvalds 已提交
388
	atomic_set(&sd->s_count, 1);
389
	atomic_set(&sd->s_active, 0);
390

T
Tejun Heo 已提交
391
	sd->s_name = name;
392
	sd->s_mode = mode;
393
	sd->s_flags = type | SYSFS_FLAG_REMOVED;
L
Linus Torvalds 已提交
394 395

	return sd;
T
Tejun Heo 已提交
396

397
 err_out2:
T
Tejun Heo 已提交
398
	kmem_cache_free(sysfs_dir_cachep, sd);
399 400
 err_out1:
	kfree(dup_name);
T
Tejun Heo 已提交
401
	return NULL;
L
Linus Torvalds 已提交
402 403
}

404
/**
405 406 407
 *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
 *	@acxt: pointer to sysfs_addrm_cxt to be used
 *	@parent_sd: parent sysfs_dirent
408
 *
409 410
 *	This function is called when the caller is about to add or
 *	remove sysfs_dirent under @parent_sd.  This function acquires
411
 *	sysfs_mutex.  @acxt is used to keep and pass context to
412
 *	other addrm functions.
413 414
 *
 *	LOCKING:
415
 *	Kernel thread context (may sleep).  sysfs_mutex is locked on
416
 *	return.
417
 */
418 419
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd)
420
{
421 422 423 424 425 426 427
	memset(acxt, 0, sizeof(*acxt));
	acxt->parent_sd = parent_sd;

	mutex_lock(&sysfs_mutex);
}

/**
428
 *	__sysfs_add_one - add sysfs_dirent to parent without warning
429 430 431 432
 *	@acxt: addrm context to use
 *	@sd: sysfs_dirent to be added
 *
 *	Get @acxt->parent_sd and set sd->s_parent to it and increment
433 434
 *	nlink of parent inode if @sd is a directory and link into the
 *	children list of the parent.
435 436 437 438 439 440 441
 *
 *	This function should be called between calls to
 *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
 *	passed the same @acxt as passed to sysfs_addrm_start().
 *
 *	LOCKING:
 *	Determined by sysfs_addrm_start().
442 443 444 445
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
446
 */
447
int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
448
{
449
	struct sysfs_inode_attrs *ps_iattr;
450
	int ret;
451

452 453
	if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
		WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
454
			sysfs_ns_type(acxt->parent_sd) ? "required" : "invalid",
455 456 457 458
			acxt->parent_sd->s_name, sd->s_name);
		return -EINVAL;
	}

459
	sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
460 461
	sd->s_parent = sysfs_get(acxt->parent_sd);

462 463 464
	ret = sysfs_link_sibling(sd);
	if (ret)
		return ret;
465

466 467 468 469 470 471 472
	/* Update timestamps on the parent */
	ps_iattr = acxt->parent_sd->s_iattr;
	if (ps_iattr) {
		struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
		ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
	}

473 474 475
	/* Mark the entry added into directory tree */
	sd->s_flags &= ~SYSFS_FLAG_REMOVED;

476
	return 0;
477 478
}

479 480 481
/**
 *	sysfs_pathname - return full path to sysfs dirent
 *	@sd: sysfs_dirent whose path we want
482
 *	@path: caller allocated buffer of size PATH_MAX
483 484 485 486 487 488 489 490
 *
 *	Gives the name "/" to the sysfs_root entry; any path returned
 *	is relative to wherever sysfs is mounted.
 */
static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
{
	if (sd->s_parent) {
		sysfs_pathname(sd->s_parent, path);
491
		strlcat(path, "/", PATH_MAX);
492
	}
493
	strlcat(path, sd->s_name, PATH_MAX);
494 495 496
	return path;
}

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/**
 *	sysfs_add_one - add sysfs_dirent to parent
 *	@acxt: addrm context to use
 *	@sd: sysfs_dirent to be added
 *
 *	Get @acxt->parent_sd and set sd->s_parent to it and increment
 *	nlink of parent inode if @sd is a directory and link into the
 *	children list of the parent.
 *
 *	This function should be called between calls to
 *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
 *	passed the same @acxt as passed to sysfs_addrm_start().
 *
 *	LOCKING:
 *	Determined by sysfs_addrm_start().
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
 */
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
{
	int ret;

	ret = __sysfs_add_one(acxt, sd);
522 523 524 525
	if (ret == -EEXIST) {
		char *path = kzalloc(PATH_MAX, GFP_KERNEL);
		WARN(1, KERN_WARNING
		     "sysfs: cannot create duplicate filename '%s'\n",
526 527 528 529 530
		     (path == NULL) ? sd->s_name
				    : (sysfs_pathname(acxt->parent_sd, path),
				       strlcat(path, "/", PATH_MAX),
				       strlcat(path, sd->s_name, PATH_MAX),
				       path));
531 532 533
		kfree(path);
	}

534 535 536
	return ret;
}

537 538 539
/**
 *	sysfs_remove_one - remove sysfs_dirent from parent
 *	@acxt: addrm context to use
540
 *	@sd: sysfs_dirent to be removed
541 542
 *
 *	Mark @sd removed and drop nlink of parent inode if @sd is a
543
 *	directory.  @sd is unlinked from the children list.
544 545 546 547 548 549 550 551 552 553
 *
 *	This function should be called between calls to
 *	sysfs_addrm_start() and sysfs_addrm_finish() and should be
 *	passed the same @acxt as passed to sysfs_addrm_start().
 *
 *	LOCKING:
 *	Determined by sysfs_addrm_start().
 */
void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
{
554 555
	struct sysfs_inode_attrs *ps_iattr;

556 557 558
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

	sysfs_unlink_sibling(sd);
559

560 561 562 563 564 565 566
	/* Update timestamps on the parent */
	ps_iattr = acxt->parent_sd->s_iattr;
	if (ps_iattr) {
		struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
		ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
	}

567
	sd->s_flags |= SYSFS_FLAG_REMOVED;
M
Mikulas Patocka 已提交
568
	sd->u.removed_list = acxt->removed;
569
	acxt->removed = sd;
570 571
}

572 573 574 575 576 577
/**
 *	sysfs_addrm_finish - finish up sysfs_dirent add/remove
 *	@acxt: addrm context to finish up
 *
 *	Finish up sysfs_dirent add/remove.  Resources acquired by
 *	sysfs_addrm_start() are released and removed sysfs_dirents are
578
 *	cleaned up.
579 580
 *
 *	LOCKING:
581
 *	sysfs_mutex is released.
582
 */
583
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
584 585 586 587 588 589 590 591
{
	/* release resources acquired by sysfs_addrm_start() */
	mutex_unlock(&sysfs_mutex);

	/* kill removed sysfs_dirents */
	while (acxt->removed) {
		struct sysfs_dirent *sd = acxt->removed;

M
Mikulas Patocka 已提交
592
		acxt->removed = sd->u.removed_list;
593 594

		sysfs_deactivate(sd);
595
		unmap_bin_file(sd);
596
		sysfs_put(sd);
T
Tejun Heo 已提交
597
	}
598 599
}

600 601 602 603 604 605
/**
 *	sysfs_find_dirent - find sysfs_dirent with the given name
 *	@parent_sd: sysfs_dirent to search under
 *	@name: name to look for
 *
 *	Look for sysfs_dirent with name @name under @parent_sd.
606
 *
607
 *	LOCKING:
608
 *	mutex_lock(sysfs_mutex)
609
 *
610 611
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
612
 */
613
struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
614
				       const void *ns,
615
				       const unsigned char *name)
616
{
617 618
	struct rb_node *node = parent_sd->s_dir.children.rb_node;
	unsigned int hash;
619

620 621
	if (!!sysfs_ns_type(parent_sd) != !!ns) {
		WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
622
			sysfs_ns_type(parent_sd) ? "required" : "invalid",
623 624 625 626
			parent_sd->s_name, name);
		return NULL;
	}

627 628 629 630 631 632 633 634 635 636 637 638 639
	hash = sysfs_name_hash(ns, name);
	while (node) {
		struct sysfs_dirent *sd;
		int result;

		sd = to_sysfs_dirent(node);
		result = sysfs_name_compare(hash, ns, name, sd);
		if (result < 0)
			node = node->rb_left;
		else if (result > 0)
			node = node->rb_right;
		else
			return sd;
640
	}
641
	return NULL;
642
}
643

644 645 646 647 648 649 650 651 652
/**
 *	sysfs_get_dirent - find and get sysfs_dirent with the given name
 *	@parent_sd: sysfs_dirent to search under
 *	@name: name to look for
 *
 *	Look for sysfs_dirent with name @name under @parent_sd and get
 *	it if found.
 *
 *	LOCKING:
653
 *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
654 655 656 657 658
 *
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
 */
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
659
				      const void *ns,
660 661 662 663
				      const unsigned char *name)
{
	struct sysfs_dirent *sd;

664
	mutex_lock(&sysfs_mutex);
665
	sd = sysfs_find_dirent(parent_sd, ns, name);
666
	sysfs_get(sd);
667
	mutex_unlock(&sysfs_mutex);
668 669

	return sd;
670
}
671
EXPORT_SYMBOL_GPL(sysfs_get_dirent);
672

673
static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
674 675
	enum kobj_ns_type type, const void *ns, const char *name,
	struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
676
{
677
	umode_t mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
678
	struct sysfs_addrm_cxt acxt;
679
	struct sysfs_dirent *sd;
680
	int rc;
L
Linus Torvalds 已提交
681

682
	/* allocate */
683
	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
684
	if (!sd)
685
		return -ENOMEM;
686 687 688

	sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
	sd->s_ns = ns;
T
Tejun Heo 已提交
689
	sd->s_dir.kobj = kobj;
690

691
	/* link in */
692
	sysfs_addrm_start(&acxt, parent_sd);
693 694
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
695

696 697 698
	if (rc == 0)
		*p_sd = sd;
	else
699
		sysfs_put(sd);
700

701
	return rc;
L
Linus Torvalds 已提交
702 703
}

704 705
int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
706
{
707 708 709 710
	return create_dir(kobj, kobj->sd,
			  KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
}

711 712 713 714 715 716 717 718
/**
 *	sysfs_read_ns_type: return associated ns_type
 *	@kobj: the kobject being queried
 *
 *	Each kobject can be tagged with exactly one namespace type
 *	(i.e. network or user).  Return the ns_type associated with
 *	this object if any
 */
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
{
	const struct kobj_ns_type_operations *ops;
	enum kobj_ns_type type;

	ops = kobj_child_ns_ops(kobj);
	if (!ops)
		return KOBJ_NS_TYPE_NONE;

	type = ops->type;
	BUG_ON(type <= KOBJ_NS_TYPE_NONE);
	BUG_ON(type >= KOBJ_NS_TYPES);
	BUG_ON(!kobj_ns_type_registered(type));

	return type;
L
Linus Torvalds 已提交
734 735 736 737
}

/**
 *	sysfs_create_dir - create a directory for an object.
738
 *	@kobj:		object we're creating directory for.
L
Linus Torvalds 已提交
739
 */
740
int sysfs_create_dir(struct kobject *kobj)
L
Linus Torvalds 已提交
741
{
742
	enum kobj_ns_type type;
743
	struct sysfs_dirent *parent_sd, *sd;
744
	const void *ns = NULL;
L
Linus Torvalds 已提交
745 746 747 748
	int error = 0;

	BUG_ON(!kobj);

749
	if (kobj->parent)
750
		parent_sd = kobj->parent->sd;
L
Linus Torvalds 已提交
751
	else
E
Eric W. Biederman 已提交
752
		parent_sd = &sysfs_root;
L
Linus Torvalds 已提交
753

754 755 756
	if (!parent_sd)
		return -ENOENT;

757 758 759 760 761
	if (sysfs_ns_type(parent_sd))
		ns = kobj->ktype->namespace(kobj);
	type = sysfs_read_ns_type(kobj);

	error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
L
Linus Torvalds 已提交
762
	if (!error)
763
		kobj->sd = sd;
L
Linus Torvalds 已提交
764 765 766
	return error;
}

767 768
static struct dentry *sysfs_lookup(struct inode *dir, struct dentry *dentry,
				   unsigned int flags)
L
Linus Torvalds 已提交
769
{
770
	struct dentry *ret = NULL;
771 772
	struct dentry *parent = dentry->d_parent;
	struct sysfs_dirent *parent_sd = parent->d_fsdata;
773
	struct sysfs_dirent *sd;
774
	struct inode *inode;
775 776
	enum kobj_ns_type type;
	const void *ns;
L
Linus Torvalds 已提交
777

778 779
	mutex_lock(&sysfs_mutex);

780 781 782 783
	type = sysfs_ns_type(parent_sd);
	ns = sysfs_info(dir->i_sb)->ns[type];

	sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
L
Linus Torvalds 已提交
784

785
	/* no such entry */
786 787
	if (!sd) {
		ret = ERR_PTR(-ENOENT);
788
		goto out_unlock;
789
	}
790
	dentry->d_fsdata = sysfs_get(sd);
791 792

	/* attach dentry and inode */
793
	inode = sysfs_get_inode(dir->i_sb, sd);
794 795 796 797
	if (!inode) {
		ret = ERR_PTR(-ENOMEM);
		goto out_unlock;
	}
798

T
Tejun Heo 已提交
799
	/* instantiate and hash dentry */
A
Al Viro 已提交
800
	ret = d_materialise_unique(dentry, inode);
801
 out_unlock:
802
	mutex_unlock(&sysfs_mutex);
803
	return ret;
L
Linus Torvalds 已提交
804 805
}

806
const struct inode_operations sysfs_dir_inode_operations = {
L
Linus Torvalds 已提交
807
	.lookup		= sysfs_lookup,
808
	.permission	= sysfs_permission,
809
	.setattr	= sysfs_setattr,
810
	.getattr	= sysfs_getattr,
811
	.setxattr	= sysfs_setxattr,
L
Linus Torvalds 已提交
812 813
};

814
static void remove_dir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
815
{
816
	struct sysfs_addrm_cxt acxt;
L
Linus Torvalds 已提交
817

818 819 820
	sysfs_addrm_start(&acxt, sd->s_parent);
	sysfs_remove_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
L
Linus Torvalds 已提交
821 822
}

823
void sysfs_remove_subdir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
824
{
825
	remove_dir(sd);
L
Linus Torvalds 已提交
826 827 828
}


829
static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
L
Linus Torvalds 已提交
830
{
831
	struct sysfs_addrm_cxt acxt;
832
	struct rb_node *pos;
L
Linus Torvalds 已提交
833

834
	if (!dir_sd)
L
Linus Torvalds 已提交
835 836
		return;

837
	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
838
	sysfs_addrm_start(&acxt, dir_sd);
839
	pos = rb_first(&dir_sd->s_dir.children);
840
	while (pos) {
841
		struct sysfs_dirent *sd = to_sysfs_dirent(pos);
842
		pos = rb_next(pos);
E
Eric W. Biederman 已提交
843
		if (sysfs_type(sd) != SYSFS_DIR)
844
			sysfs_remove_one(&acxt, sd);
L
Linus Torvalds 已提交
845
	}
846
	sysfs_addrm_finish(&acxt);
847

848
	remove_dir(dir_sd);
849 850 851 852 853 854 855 856 857 858 859
}

/**
 *	sysfs_remove_dir - remove an object's directory.
 *	@kobj:	object.
 *
 *	The only thing special about this is that we remove any files in
 *	the directory before we remove the directory, and we've inlined
 *	what used to be sysfs_rmdir() below, instead of calling separately.
 */

860
void sysfs_remove_dir(struct kobject *kobj)
861
{
862
	struct sysfs_dirent *sd = kobj->sd;
863

T
Tejun Heo 已提交
864
	spin_lock(&sysfs_assoc_lock);
865
	kobj->sd = NULL;
T
Tejun Heo 已提交
866
	spin_unlock(&sysfs_assoc_lock);
867

868
	__sysfs_remove_dir(sd);
L
Linus Torvalds 已提交
869 870
}

871
int sysfs_rename(struct sysfs_dirent *sd,
872 873
	struct sysfs_dirent *new_parent_sd, const void *new_ns,
	const char *new_name)
L
Linus Torvalds 已提交
874
{
875
	int error;
L
Linus Torvalds 已提交
876

877
	mutex_lock(&sysfs_mutex);
878

879
	error = 0;
880
	if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
881
	    (strcmp(sd->s_name, new_name) == 0))
882 883 884
		goto out;	/* nothing to rename */

	error = -EEXIST;
885
	if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
886
		goto out;
887

888
	/* rename sysfs_dirent */
889 890
	if (strcmp(sd->s_name, new_name) != 0) {
		error = -ENOMEM;
891
		new_name = kstrdup(new_name, GFP_KERNEL);
892 893 894
		if (!new_name)
			goto out;

895
		kfree(sd->s_name);
896 897
		sd->s_name = new_name;
	}
T
Tejun Heo 已提交
898

899 900 901
	/*
	 * Move to the appropriate place in the appropriate directories rbtree.
	 */
902 903 904
	sysfs_unlink_sibling(sd);
	sysfs_get(new_parent_sd);
	sysfs_put(sd->s_parent);
905
	sd->s_ns = new_ns;
906
	sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
907 908
	sd->s_parent = new_parent_sd;
	sysfs_link_sibling(sd);
T
Tejun Heo 已提交
909

910
	error = 0;
911
 out:
912
	mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
913 914 915
	return error;
}

916 917
int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
{
918 919 920 921 922 923 924
	struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
	const void *new_ns = NULL;

	if (sysfs_ns_type(parent_sd))
		new_ns = kobj->ktype->namespace(kobj);

	return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
925 926
}

927
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
928
{
929 930
	struct sysfs_dirent *sd = kobj->sd;
	struct sysfs_dirent *new_parent_sd;
931
	const void *new_ns = NULL;
932

933
	BUG_ON(!sd->s_parent);
934 935
	if (sysfs_ns_type(sd->s_parent))
		new_ns = kobj->ktype->namespace(kobj);
936
	new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
937
		new_parent_kobj->sd : &sysfs_root;
938

939
	return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
940 941
}

L
Linus Torvalds 已提交
942 943 944 945 946 947
/* Relationship between s_mode and the DT_xxx types */
static inline unsigned char dt_type(struct sysfs_dirent *sd)
{
	return (sd->s_mode >> 12) & 15;
}

948 949 950 951 952 953
static int sysfs_dir_release(struct inode *inode, struct file *filp)
{
	sysfs_put(filp->private_data);
	return 0;
}

954
static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
955
	struct sysfs_dirent *parent_sd,	loff_t hash, struct sysfs_dirent *pos)
956 957 958 959
{
	if (pos) {
		int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
			pos->s_parent == parent_sd &&
960
			hash == pos->s_hash;
961
		sysfs_put(pos);
962 963
		if (!valid)
			pos = NULL;
964
	}
965 966 967 968 969 970 971 972 973 974
	if (!pos && (hash > 1) && (hash < INT_MAX)) {
		struct rb_node *node = parent_sd->s_dir.children.rb_node;
		while (node) {
			pos = to_sysfs_dirent(node);

			if (hash < pos->s_hash)
				node = node->rb_left;
			else if (hash > pos->s_hash)
				node = node->rb_right;
			else
975 976 977
				break;
		}
	}
978
	/* Skip over entries in the wrong namespace */
979
	while (pos && pos->s_ns != ns) {
980 981
		struct rb_node *node = rb_next(&pos->s_rb);
		if (!node)
982 983
			pos = NULL;
		else
984
			pos = to_sysfs_dirent(node);
985 986 987 988
	}
	return pos;
}

989 990
static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
	struct sysfs_dirent *parent_sd,	ino_t ino, struct sysfs_dirent *pos)
991
{
992
	pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
993
	if (pos) do {
994 995
		struct rb_node *node = rb_next(&pos->s_rb);
		if (!node)
996 997
			pos = NULL;
		else
998
			pos = to_sysfs_dirent(node);
999
	} while (pos && pos->s_ns != ns);
1000 1001 1002
	return pos;
}

A
Al Viro 已提交
1003
static int sysfs_readdir(struct file *file, struct dir_context *ctx)
L
Linus Torvalds 已提交
1004
{
A
Al Viro 已提交
1005
	struct dentry *dentry = file->f_path.dentry;
1006
	struct sysfs_dirent *parent_sd = dentry->d_fsdata;
A
Al Viro 已提交
1007
	struct sysfs_dirent *pos = file->private_data;
1008 1009
	enum kobj_ns_type type;
	const void *ns;
L
Linus Torvalds 已提交
1010

1011 1012 1013
	type = sysfs_ns_type(parent_sd);
	ns = sysfs_info(dentry->d_sb)->ns[type];

A
Al Viro 已提交
1014 1015
	if (!dir_emit_dots(file, ctx))
		return 0;
1016
	mutex_lock(&sysfs_mutex);
A
Al Viro 已提交
1017
	for (pos = sysfs_dir_pos(ns, parent_sd, ctx->pos, pos);
1018
	     pos;
A
Al Viro 已提交
1019 1020 1021 1022 1023 1024 1025
	     pos = sysfs_dir_next_pos(ns, parent_sd, ctx->pos, pos)) {
		const char *name = pos->s_name;
		unsigned int type = dt_type(pos);
		int len = strlen(name);
		ino_t ino = pos->s_ino;
		ctx->pos = pos->s_hash;
		file->private_data = sysfs_get(pos);
L
Linus Torvalds 已提交
1026

1027
		mutex_unlock(&sysfs_mutex);
A
Al Viro 已提交
1028 1029
		if (!dir_emit(ctx, name, len, ino, type))
			return 0;
1030 1031 1032
		mutex_lock(&sysfs_mutex);
	}
	mutex_unlock(&sysfs_mutex);
A
Al Viro 已提交
1033 1034
	file->private_data = NULL;
	ctx->pos = INT_MAX;
E
Eric W. Biederman 已提交
1035
	return 0;
L
Linus Torvalds 已提交
1036 1037
}

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
static loff_t sysfs_dir_llseek(struct file *file, loff_t offset, int whence)
{
	struct inode *inode = file_inode(file);
	loff_t ret;

	mutex_lock(&inode->i_mutex);
	ret = generic_file_llseek(file, offset, whence);
	mutex_unlock(&inode->i_mutex);

	return ret;
}
E
Eric W. Biederman 已提交
1049

1050
const struct file_operations sysfs_dir_operations = {
L
Linus Torvalds 已提交
1051
	.read		= generic_read_dir,
A
Al Viro 已提交
1052
	.iterate	= sysfs_readdir,
1053
	.release	= sysfs_dir_release,
1054
	.llseek		= sysfs_dir_llseek,
L
Linus Torvalds 已提交
1055
};