dir.c 24.4 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 49 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 77
 *	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);
	hash = ( end_name_hash(hash) ^ hash_ptr( (void *)ns, 31 ) );
	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);
}

/**
 *	sysfs_link_subling - 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
/**
 *	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.
 */
145
struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
146
{
147 148 149 150 151 152 153 154 155 156 157
	if (unlikely(!sd))
		return NULL;

	while (1) {
		int v, t;

		v = atomic_read(&sd->s_active);
		if (unlikely(v < 0))
			return NULL;

		t = atomic_cmpxchg(&sd->s_active, v, v + 1);
158 159
		if (likely(t == v)) {
			rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
160
			return sd;
161
		}
162 163 164 165
		if (t < 0)
			return NULL;

		cpu_relax();
166 167 168 169 170 171 172 173 174 175
	}
}

/**
 *	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.
 */
176
void sysfs_put_active(struct sysfs_dirent *sd)
177
{
178 179 180 181 182
	int v;

	if (unlikely(!sd))
		return;

183
	rwsem_release(&sd->dep_map, 1, _RET_IP_);
184 185 186 187 188
	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 已提交
189
	 * sd->u.completion.
190
	 */
M
Mikulas Patocka 已提交
191
	complete(sd->u.completion);
192 193 194 195 196 197
}

/**
 *	sysfs_deactivate - deactivate sysfs_dirent
 *	@sd: sysfs_dirent to deactivate
 *
198
 *	Deny new active references and drain existing ones.
199
 */
200
static void sysfs_deactivate(struct sysfs_dirent *sd)
201
{
202 203
	DECLARE_COMPLETION_ONSTACK(wait);
	int v;
204

M
Mikulas Patocka 已提交
205
	BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
206 207 208 209

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

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

212
	rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
213
	/* atomic_add_return() is a mb(), put_active() will always see
M
Mikulas Patocka 已提交
214
	 * the updated sd->u.completion.
215
	 */
216 217
	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);

218 219
	if (v != SD_DEACTIVATED_BIAS) {
		lock_contended(&sd->dep_map, _RET_IP_);
220
		wait_for_completion(&wait);
221
	}
222

223 224
	lock_acquired(&sd->dep_map, _RET_IP_);
	rwsem_release(&sd->dep_map, 1, _RET_IP_);
225 226
}

227
static int sysfs_alloc_ino(unsigned int *pino)
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
{
	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;
}

246
static void sysfs_free_ino(unsigned int ino)
247 248 249 250 251 252
{
	spin_lock(&sysfs_ino_lock);
	ida_remove(&sysfs_ino_ida, ino);
	spin_unlock(&sysfs_ino_lock);
}

253 254
void release_sysfs_dirent(struct sysfs_dirent * sd)
{
T
Tejun Heo 已提交
255 256 257
	struct sysfs_dirent *parent_sd;

 repeat:
258 259 260
	/* Moving/renaming is always done while holding reference.
	 * sd->s_parent won't change beneath us.
	 */
T
Tejun Heo 已提交
261 262
	parent_sd = sd->s_parent;

263
	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
T
Tejun Heo 已提交
264
		sysfs_put(sd->s_symlink.target_sd);
265
	if (sysfs_type(sd) & SYSFS_COPY_NAME)
T
Tejun Heo 已提交
266
		kfree(sd->s_name);
267 268 269
	if (sd->s_iattr && sd->s_iattr->ia_secdata)
		security_release_secctx(sd->s_iattr->ia_secdata,
					sd->s_iattr->ia_secdata_len);
270
	kfree(sd->s_iattr);
271
	sysfs_free_ino(sd->s_ino);
272
	kmem_cache_free(sysfs_dir_cachep, sd);
T
Tejun Heo 已提交
273 274 275 276

	sd = parent_sd;
	if (sd && atomic_dec_and_test(&sd->s_count))
		goto repeat;
277 278
}

N
Nick Piggin 已提交
279
static int sysfs_dentry_delete(const struct dentry *dentry)
280 281 282 283 284 285 286
{
	struct sysfs_dirent *sd = dentry->d_fsdata;
	return !!(sd->s_flags & SYSFS_FLAG_REMOVED);
}

static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd)
{
287
	struct sysfs_dirent *sd;
288 289
	int is_dir;

290 291 292 293
	if (nd->flags & LOOKUP_RCU)
		return -ECHILD;

	sd = dentry->d_fsdata;
294 295 296 297 298 299
	mutex_lock(&sysfs_mutex);

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

300 301 302 303 304 305 306 307
	/* 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;

308 309 310 311 312 313 314
	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.
315 316 317 318 319 320
	 *
	 * 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.
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
	 */
	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;
}

337
static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode)
L
Linus Torvalds 已提交
338 339 340
{
	struct sysfs_dirent * sd = dentry->d_fsdata;

E
Eric W. Biederman 已提交
341
	sysfs_put(sd);
L
Linus Torvalds 已提交
342 343 344
	iput(inode);
}

A
Al Viro 已提交
345
static const struct dentry_operations sysfs_dentry_ops = {
346 347
	.d_revalidate	= sysfs_dentry_revalidate,
	.d_delete	= sysfs_dentry_delete,
348
	.d_iput		= sysfs_dentry_iput,
L
Linus Torvalds 已提交
349 350
};

351
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
L
Linus Torvalds 已提交
352
{
T
Tejun Heo 已提交
353
	char *dup_name = NULL;
354
	struct sysfs_dirent *sd;
T
Tejun Heo 已提交
355 356 357 358

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

362
	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
363
	if (!sd)
364
		goto err_out1;
L
Linus Torvalds 已提交
365

T
Tejun Heo 已提交
366
	if (sysfs_alloc_ino(&sd->s_ino))
367
		goto err_out2;
368

L
Linus Torvalds 已提交
369
	atomic_set(&sd->s_count, 1);
370
	atomic_set(&sd->s_active, 0);
371

T
Tejun Heo 已提交
372
	sd->s_name = name;
373
	sd->s_mode = mode;
374
	sd->s_flags = type;
L
Linus Torvalds 已提交
375 376

	return sd;
T
Tejun Heo 已提交
377

378
 err_out2:
T
Tejun Heo 已提交
379
	kmem_cache_free(sysfs_dir_cachep, sd);
380 381
 err_out1:
	kfree(dup_name);
T
Tejun Heo 已提交
382
	return NULL;
L
Linus Torvalds 已提交
383 384
}

385
/**
386 387 388
 *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
 *	@acxt: pointer to sysfs_addrm_cxt to be used
 *	@parent_sd: parent sysfs_dirent
389
 *
390 391
 *	This function is called when the caller is about to add or
 *	remove sysfs_dirent under @parent_sd.  This function acquires
392
 *	sysfs_mutex.  @acxt is used to keep and pass context to
393
 *	other addrm functions.
394 395
 *
 *	LOCKING:
396
 *	Kernel thread context (may sleep).  sysfs_mutex is locked on
397
 *	return.
398
 */
399 400
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd)
401
{
402 403 404 405 406 407 408
	memset(acxt, 0, sizeof(*acxt));
	acxt->parent_sd = parent_sd;

	mutex_lock(&sysfs_mutex);
}

/**
409
 *	__sysfs_add_one - add sysfs_dirent to parent without warning
410 411 412 413
 *	@acxt: addrm context to use
 *	@sd: sysfs_dirent to be added
 *
 *	Get @acxt->parent_sd and set sd->s_parent to it and increment
414 415
 *	nlink of parent inode if @sd is a directory and link into the
 *	children list of the parent.
416 417 418 419 420 421 422
 *
 *	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().
423 424 425 426
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
427
 */
428
int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
429
{
430
	struct sysfs_inode_attrs *ps_iattr;
431
	int ret;
432

433 434 435 436 437 438 439
	if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
		WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
			sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
			acxt->parent_sd->s_name, sd->s_name);
		return -EINVAL;
	}

440
	sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
441 442
	sd->s_parent = sysfs_get(acxt->parent_sd);

443 444 445
	ret = sysfs_link_sibling(sd);
	if (ret)
		return ret;
446

447 448 449 450 451 452 453
	/* 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;
	}

454
	return 0;
455 456
}

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
/**
 *	sysfs_pathname - return full path to sysfs dirent
 *	@sd: sysfs_dirent whose path we want
 *	@path: caller allocated buffer
 *
 *	Gives the name "/" to the sysfs_root entry; any path returned
 *	is relative to wherever sysfs is mounted.
 *
 *	XXX: does no error checking on @path size
 */
static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
{
	if (sd->s_parent) {
		sysfs_pathname(sd->s_parent, path);
		strcat(path, "/");
	}
	strcat(path, sd->s_name);
	return path;
}

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
/**
 *	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);
502 503 504 505 506 507 508 509 510 511
	if (ret == -EEXIST) {
		char *path = kzalloc(PATH_MAX, GFP_KERNEL);
		WARN(1, KERN_WARNING
		     "sysfs: cannot create duplicate filename '%s'\n",
		     (path == NULL) ? sd->s_name :
		     strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
		            sd->s_name));
		kfree(path);
	}

512 513 514
	return ret;
}

515 516 517
/**
 *	sysfs_remove_one - remove sysfs_dirent from parent
 *	@acxt: addrm context to use
518
 *	@sd: sysfs_dirent to be removed
519 520
 *
 *	Mark @sd removed and drop nlink of parent inode if @sd is a
521
 *	directory.  @sd is unlinked from the children list.
522 523 524 525 526 527 528 529 530 531
 *
 *	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)
{
532 533
	struct sysfs_inode_attrs *ps_iattr;

534 535 536
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

	sysfs_unlink_sibling(sd);
537

538 539 540 541 542 543 544
	/* 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;
	}

545
	sd->s_flags |= SYSFS_FLAG_REMOVED;
M
Mikulas Patocka 已提交
546
	sd->u.removed_list = acxt->removed;
547
	acxt->removed = sd;
548 549
}

550 551 552 553 554 555
/**
 *	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
556
 *	cleaned up.
557 558
 *
 *	LOCKING:
559
 *	sysfs_mutex is released.
560
 */
561
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
562 563 564 565 566 567 568 569
{
	/* 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 已提交
570
		acxt->removed = sd->u.removed_list;
571 572

		sysfs_deactivate(sd);
573
		unmap_bin_file(sd);
574
		sysfs_put(sd);
T
Tejun Heo 已提交
575
	}
576 577
}

578 579 580 581 582 583
/**
 *	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.
584
 *
585
 *	LOCKING:
586
 *	mutex_lock(sysfs_mutex)
587
 *
588 589
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
590
 */
591
struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
592
				       const void *ns,
593
				       const unsigned char *name)
594
{
595 596
	struct rb_node *node = parent_sd->s_dir.children.rb_node;
	unsigned int hash;
597

598 599 600 601 602 603 604
	if (!!sysfs_ns_type(parent_sd) != !!ns) {
		WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
			sysfs_ns_type(parent_sd)? "required": "invalid",
			parent_sd->s_name, name);
		return NULL;
	}

605 606 607 608 609 610 611 612 613 614 615 616 617
	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;
618
	}
619
	return NULL;
620
}
621

622 623 624 625 626 627 628 629 630
/**
 *	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:
631
 *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
632 633 634 635 636
 *
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
 */
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
637
				      const void *ns,
638 639 640 641
				      const unsigned char *name)
{
	struct sysfs_dirent *sd;

642
	mutex_lock(&sysfs_mutex);
643
	sd = sysfs_find_dirent(parent_sd, ns, name);
644
	sysfs_get(sd);
645
	mutex_unlock(&sysfs_mutex);
646 647

	return sd;
648
}
649
EXPORT_SYMBOL_GPL(sysfs_get_dirent);
650

651
static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
652 653
	enum kobj_ns_type type, const void *ns, const char *name,
	struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
654 655
{
	umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
656
	struct sysfs_addrm_cxt acxt;
657
	struct sysfs_dirent *sd;
658
	int rc;
L
Linus Torvalds 已提交
659

660
	/* allocate */
661
	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
662
	if (!sd)
663
		return -ENOMEM;
664 665 666

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

669
	/* link in */
670
	sysfs_addrm_start(&acxt, parent_sd);
671 672
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
673

674 675 676
	if (rc == 0)
		*p_sd = sd;
	else
677
		sysfs_put(sd);
678

679
	return rc;
L
Linus Torvalds 已提交
680 681
}

682 683
int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
684
{
685 686 687 688
	return create_dir(kobj, kobj->sd,
			  KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
}

689 690 691 692 693 694 695 696
/**
 *	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
 */
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
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 已提交
712 713 714 715 716 717
}

/**
 *	sysfs_create_dir - create a directory for an object.
 *	@kobj:		object we're creating directory for. 
 */
718
int sysfs_create_dir(struct kobject * kobj)
L
Linus Torvalds 已提交
719
{
720
	enum kobj_ns_type type;
721
	struct sysfs_dirent *parent_sd, *sd;
722
	const void *ns = NULL;
L
Linus Torvalds 已提交
723 724 725 726
	int error = 0;

	BUG_ON(!kobj);

727
	if (kobj->parent)
728
		parent_sd = kobj->parent->sd;
L
Linus Torvalds 已提交
729
	else
E
Eric W. Biederman 已提交
730
		parent_sd = &sysfs_root;
L
Linus Torvalds 已提交
731

732 733 734 735 736
	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 已提交
737
	if (!error)
738
		kobj->sd = sd;
L
Linus Torvalds 已提交
739 740 741 742 743 744
	return error;
}

static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
				struct nameidata *nd)
{
745
	struct dentry *ret = NULL;
746 747
	struct dentry *parent = dentry->d_parent;
	struct sysfs_dirent *parent_sd = parent->d_fsdata;
748
	struct sysfs_dirent *sd;
749
	struct inode *inode;
750 751
	enum kobj_ns_type type;
	const void *ns;
L
Linus Torvalds 已提交
752

753 754
	mutex_lock(&sysfs_mutex);

755 756 757 758
	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 已提交
759

760
	/* no such entry */
761 762
	if (!sd) {
		ret = ERR_PTR(-ENOENT);
763
		goto out_unlock;
764
	}
765 766

	/* attach dentry and inode */
767
	inode = sysfs_get_inode(dir->i_sb, sd);
768 769 770 771
	if (!inode) {
		ret = ERR_PTR(-ENOMEM);
		goto out_unlock;
	}
772

T
Tejun Heo 已提交
773
	/* instantiate and hash dentry */
774 775
	ret = d_find_alias(inode);
	if (!ret) {
776
		d_set_d_op(dentry, &sysfs_dentry_ops);
777 778 779 780 781 782
		dentry->d_fsdata = sysfs_get(sd);
		d_add(dentry, inode);
	} else {
		d_move(ret, dentry);
		iput(inode);
	}
783

784
 out_unlock:
785
	mutex_unlock(&sysfs_mutex);
786
	return ret;
L
Linus Torvalds 已提交
787 788
}

789
const struct inode_operations sysfs_dir_inode_operations = {
L
Linus Torvalds 已提交
790
	.lookup		= sysfs_lookup,
791
	.permission	= sysfs_permission,
792
	.setattr	= sysfs_setattr,
793
	.getattr	= sysfs_getattr,
794
	.setxattr	= sysfs_setxattr,
L
Linus Torvalds 已提交
795 796
};

797
static void remove_dir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
798
{
799
	struct sysfs_addrm_cxt acxt;
L
Linus Torvalds 已提交
800

801 802 803
	sysfs_addrm_start(&acxt, sd->s_parent);
	sysfs_remove_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
L
Linus Torvalds 已提交
804 805
}

806
void sysfs_remove_subdir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
807
{
808
	remove_dir(sd);
L
Linus Torvalds 已提交
809 810 811
}


812
static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
L
Linus Torvalds 已提交
813
{
814
	struct sysfs_addrm_cxt acxt;
815
	struct rb_node *pos;
L
Linus Torvalds 已提交
816

817
	if (!dir_sd)
L
Linus Torvalds 已提交
818 819
		return;

820
	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
821
	sysfs_addrm_start(&acxt, dir_sd);
822
	pos = rb_first(&dir_sd->s_dir.children);
823
	while (pos) {
824
		struct sysfs_dirent *sd = to_sysfs_dirent(pos);
825
		pos = rb_next(pos);
E
Eric W. Biederman 已提交
826
		if (sysfs_type(sd) != SYSFS_DIR)
827
			sysfs_remove_one(&acxt, sd);
L
Linus Torvalds 已提交
828
	}
829
	sysfs_addrm_finish(&acxt);
830

831
	remove_dir(dir_sd);
832 833 834 835 836 837 838 839 840 841 842 843 844
}

/**
 *	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.
 */

void sysfs_remove_dir(struct kobject * kobj)
{
845
	struct sysfs_dirent *sd = kobj->sd;
846

T
Tejun Heo 已提交
847
	spin_lock(&sysfs_assoc_lock);
848
	kobj->sd = NULL;
T
Tejun Heo 已提交
849
	spin_unlock(&sysfs_assoc_lock);
850

851
	__sysfs_remove_dir(sd);
L
Linus Torvalds 已提交
852 853
}

854
int sysfs_rename(struct sysfs_dirent *sd,
855 856
	struct sysfs_dirent *new_parent_sd, const void *new_ns,
	const char *new_name)
L
Linus Torvalds 已提交
857
{
858
	const char *dup_name = NULL;
859
	int error;
L
Linus Torvalds 已提交
860

861
	mutex_lock(&sysfs_mutex);
862

863
	error = 0;
864
	if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
865
	    (strcmp(sd->s_name, new_name) == 0))
866 867 868
		goto out;	/* nothing to rename */

	error = -EEXIST;
869
	if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
870
		goto out;
871

872
	/* rename sysfs_dirent */
873 874 875 876 877 878 879 880 881
	if (strcmp(sd->s_name, new_name) != 0) {
		error = -ENOMEM;
		new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
		if (!new_name)
			goto out;

		dup_name = sd->s_name;
		sd->s_name = new_name;
	}
T
Tejun Heo 已提交
882

883 884 885 886
	/* Move to the appropriate place in the appropriate directories rbtree. */
	sysfs_unlink_sibling(sd);
	sysfs_get(new_parent_sd);
	sysfs_put(sd->s_parent);
887
	sd->s_ns = new_ns;
888
	sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name);
889 890
	sd->s_parent = new_parent_sd;
	sysfs_link_sibling(sd);
T
Tejun Heo 已提交
891

892
	error = 0;
893
 out:
894
	mutex_unlock(&sysfs_mutex);
895
	kfree(dup_name);
L
Linus Torvalds 已提交
896 897 898
	return error;
}

899 900
int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
{
901 902 903 904 905 906 907
	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);
908 909
}

910
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
911
{
912 913
	struct sysfs_dirent *sd = kobj->sd;
	struct sysfs_dirent *new_parent_sd;
914
	const void *new_ns = NULL;
915

916
	BUG_ON(!sd->s_parent);
917 918
	if (sysfs_ns_type(sd->s_parent))
		new_ns = kobj->ktype->namespace(kobj);
919
	new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
920
		new_parent_kobj->sd : &sysfs_root;
921

922
	return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
923 924
}

L
Linus Torvalds 已提交
925 926 927 928 929 930
/* 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;
}

931 932 933 934 935 936
static int sysfs_dir_release(struct inode *inode, struct file *filp)
{
	sysfs_put(filp->private_data);
	return 0;
}

937
static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
938
	struct sysfs_dirent *parent_sd,	loff_t hash, struct sysfs_dirent *pos)
939 940 941 942
{
	if (pos) {
		int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
			pos->s_parent == parent_sd &&
943
			hash == pos->s_hash;
944
		sysfs_put(pos);
945 946
		if (!valid)
			pos = NULL;
947
	}
948 949 950 951 952 953 954 955 956 957
	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
958 959 960
				break;
		}
	}
961
	/* Skip over entries in the wrong namespace */
962
	while (pos && pos->s_ns != ns) {
963 964
		struct rb_node *node = rb_next(&pos->s_rb);
		if (!node)
965 966
			pos = NULL;
		else
967
			pos = to_sysfs_dirent(node);
968 969 970 971
	}
	return pos;
}

972 973
static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
	struct sysfs_dirent *parent_sd,	ino_t ino, struct sysfs_dirent *pos)
974
{
975
	pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
976
	if (pos) do {
977 978
		struct rb_node *node = rb_next(&pos->s_rb);
		if (!node)
979 980
			pos = NULL;
		else
981
			pos = to_sysfs_dirent(node);
982
	} while (pos && pos->s_ns != ns);
983 984 985
	return pos;
}

L
Linus Torvalds 已提交
986 987
static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
{
988
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
989
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
990
	struct sysfs_dirent *pos = filp->private_data;
991 992
	enum kobj_ns_type type;
	const void *ns;
L
Linus Torvalds 已提交
993 994
	ino_t ino;

995 996 997
	type = sysfs_ns_type(parent_sd);
	ns = sysfs_info(dentry->d_sb)->ns[type];

E
Eric W. Biederman 已提交
998 999 1000
	if (filp->f_pos == 0) {
		ino = parent_sd->s_ino;
		if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
L
Linus Torvalds 已提交
1001
			filp->f_pos++;
E
Eric W. Biederman 已提交
1002 1003 1004 1005 1006 1007 1008
	}
	if (filp->f_pos == 1) {
		if (parent_sd->s_parent)
			ino = parent_sd->s_parent->s_ino;
		else
			ino = parent_sd->s_ino;
		if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
L
Linus Torvalds 已提交
1009
			filp->f_pos++;
E
Eric W. Biederman 已提交
1010
	}
1011
	mutex_lock(&sysfs_mutex);
1012
	for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos);
1013
	     pos;
1014
	     pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) {
1015 1016 1017 1018 1019 1020 1021 1022
		const char * name;
		unsigned int type;
		int len, ret;

		name = pos->s_name;
		len = strlen(name);
		ino = pos->s_ino;
		type = dt_type(pos);
1023
		filp->f_pos = pos->s_hash;
1024
		filp->private_data = sysfs_get(pos);
L
Linus Torvalds 已提交
1025

1026
		mutex_unlock(&sysfs_mutex);
1027 1028 1029 1030 1031 1032 1033 1034 1035
		ret = filldir(dirent, name, len, filp->f_pos, ino, type);
		mutex_lock(&sysfs_mutex);
		if (ret < 0)
			break;
	}
	mutex_unlock(&sysfs_mutex);
	if ((filp->f_pos > 1) && !pos) { /* EOF */
		filp->f_pos = INT_MAX;
		filp->private_data = NULL;
L
Linus Torvalds 已提交
1036
	}
E
Eric W. Biederman 已提交
1037
	return 0;
L
Linus Torvalds 已提交
1038 1039
}

E
Eric W. Biederman 已提交
1040

1041
const struct file_operations sysfs_dir_operations = {
L
Linus Torvalds 已提交
1042 1043
	.read		= generic_read_dir,
	.readdir	= sysfs_readdir,
1044
	.release	= sysfs_dir_release,
1045
	.llseek		= generic_file_llseek,
L
Linus Torvalds 已提交
1046
};