dir.c 23.1 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>
L
Linus Torvalds 已提交
24 25
#include "sysfs.h"

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

R
Roel Kluin 已提交
30
static DEFINE_SPINLOCK(sysfs_ino_lock);
31 32
static DEFINE_IDA(sysfs_ino_ida);

33 34 35 36 37
/**
 *	sysfs_link_sibling - link sysfs_dirent into sibling list
 *	@sd: sysfs_dirent of interest
 *
 *	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;
E
Eric W. Biederman 已提交
46
	struct sysfs_dirent **pos;
47 48

	BUG_ON(sd->s_sibling);
E
Eric W. Biederman 已提交
49 50 51

	/* Store directory entries in order by ino.  This allows
	 * readdir to properly restart without having to add a
52
	 * cursor into the s_dir.children list.
E
Eric W. Biederman 已提交
53
	 */
54
	for (pos = &parent_sd->s_dir.children; *pos; pos = &(*pos)->s_sibling) {
E
Eric W. Biederman 已提交
55 56 57 58 59
		if (sd->s_ino < (*pos)->s_ino)
			break;
	}
	sd->s_sibling = *pos;
	*pos = sd;
60 61 62 63 64 65 66
}

/**
 *	sysfs_unlink_sibling - unlink sysfs_dirent from sibling list
 *	@sd: sysfs_dirent of interest
 *
 *	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 75
{
	struct sysfs_dirent **pos;

76 77
	for (pos = &sd->s_parent->s_dir.children; *pos;
	     pos = &(*pos)->s_sibling) {
78 79 80 81 82 83 84 85
		if (*pos == sd) {
			*pos = sd->s_sibling;
			sd->s_sibling = NULL;
			break;
		}
	}
}

T
Tejun Heo 已提交
86 87 88 89 90
/**
 *	sysfs_get_dentry - get dentry for the given sysfs_dirent
 *	@sd: sysfs_dirent of interest
 *
 *	Get dentry for @sd.  Dentry is looked up if currently not
T
Tejun Heo 已提交
91 92
 *	present.  This function descends from the root looking up
 *	dentry for each step.
T
Tejun Heo 已提交
93 94
 *
 *	LOCKING:
95
 *	mutex_lock(sysfs_rename_mutex)
T
Tejun Heo 已提交
96 97 98 99 100 101
 *
 *	RETURNS:
 *	Pointer to found dentry on success, ERR_PTR() value on error.
 */
struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd)
{
T
Tejun Heo 已提交
102
	struct dentry *dentry = dget(sysfs_sb->s_root);
T
Tejun Heo 已提交
103

T
Tejun Heo 已提交
104 105 106
	while (dentry->d_fsdata != sd) {
		struct sysfs_dirent *cur;
		struct dentry *parent;
T
Tejun Heo 已提交
107

T
Tejun Heo 已提交
108 109 110
		/* find the first ancestor which hasn't been looked up */
		cur = sd;
		while (cur->s_parent != dentry->d_fsdata)
T
Tejun Heo 已提交
111 112 113
			cur = cur->s_parent;

		/* look it up */
T
Tejun Heo 已提交
114 115
		parent = dentry;
		mutex_lock(&parent->d_inode->i_mutex);
116
		dentry = lookup_one_noperm(cur->s_name, parent);
T
Tejun Heo 已提交
117 118
		mutex_unlock(&parent->d_inode->i_mutex);
		dput(parent);
T
Tejun Heo 已提交
119

T
Tejun Heo 已提交
120 121
		if (IS_ERR(dentry))
			break;
T
Tejun Heo 已提交
122 123 124 125
	}
	return dentry;
}

126 127 128 129 130 131 132 133 134 135
/**
 *	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.
 */
136
static struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
137
{
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
	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);
		if (likely(t == v))
			return sd;
		if (t < 0)
			return NULL;

		cpu_relax();
155 156 157 158 159 160 161 162 163 164
	}
}

/**
 *	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.
 */
165
static void sysfs_put_active(struct sysfs_dirent *sd)
166
{
167 168 169 170 171 172 173 174 175 176 177
	struct completion *cmpl;
	int v;

	if (unlikely(!sd))
		return;

	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
178
	 * sd->s_sibling.
179
	 */
180
	cmpl = (void *)sd->s_sibling;
181
	complete(cmpl);
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
}

/**
 *	sysfs_get_active_two - get active references to sysfs_dirent and parent
 *	@sd: sysfs_dirent of interest
 *
 *	Get active reference to @sd and its parent.  Parent's active
 *	reference is grabbed first.  This function is noop if @sd is
 *	NULL.
 *
 *	RETURNS:
 *	Pointer to @sd on success, NULL on failure.
 */
struct sysfs_dirent *sysfs_get_active_two(struct sysfs_dirent *sd)
{
	if (sd) {
		if (sd->s_parent && unlikely(!sysfs_get_active(sd->s_parent)))
			return NULL;
		if (unlikely(!sysfs_get_active(sd))) {
			sysfs_put_active(sd->s_parent);
			return NULL;
		}
	}
	return sd;
}

/**
 *	sysfs_put_active_two - put active references to sysfs_dirent and parent
 *	@sd: sysfs_dirent of interest
 *
 *	Put active references to @sd and its parent.  This function is
 *	noop if @sd is NULL.
 */
void sysfs_put_active_two(struct sysfs_dirent *sd)
{
	if (sd) {
		sysfs_put_active(sd);
		sysfs_put_active(sd->s_parent);
	}
}

/**
 *	sysfs_deactivate - deactivate sysfs_dirent
 *	@sd: sysfs_dirent to deactivate
 *
227
 *	Deny new active references and drain existing ones.
228
 */
229
static void sysfs_deactivate(struct sysfs_dirent *sd)
230
{
231 232
	DECLARE_COMPLETION_ONSTACK(wait);
	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 241 242 243 244
	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);

	if (v != SD_DEACTIVATED_BIAS)
		wait_for_completion(&wait);

245
	sd->s_sibling = NULL;
246 247
}

T
Tejun Heo 已提交
248
static int sysfs_alloc_ino(ino_t *pino)
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
{
	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;
}

static void sysfs_free_ino(ino_t ino)
{
	spin_lock(&sysfs_ino_lock);
	ida_remove(&sysfs_ino_ida, ino);
	spin_unlock(&sysfs_ino_lock);
}

274 275
void release_sysfs_dirent(struct sysfs_dirent * sd)
{
T
Tejun Heo 已提交
276 277 278
	struct sysfs_dirent *parent_sd;

 repeat:
279 280 281
	/* Moving/renaming is always done while holding reference.
	 * sd->s_parent won't change beneath us.
	 */
T
Tejun Heo 已提交
282 283
	parent_sd = sd->s_parent;

284
	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
T
Tejun Heo 已提交
285
		sysfs_put(sd->s_symlink.target_sd);
286
	if (sysfs_type(sd) & SYSFS_COPY_NAME)
T
Tejun Heo 已提交
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);
T
Tejun Heo 已提交
291 292 293 294

	sd = parent_sd;
	if (sd && atomic_dec_and_test(&sd->s_count))
		goto repeat;
295 296
}

L
Linus Torvalds 已提交
297 298 299 300
static void sysfs_d_iput(struct dentry * dentry, struct inode * inode)
{
	struct sysfs_dirent * sd = dentry->d_fsdata;

E
Eric W. Biederman 已提交
301
	sysfs_put(sd);
L
Linus Torvalds 已提交
302 303 304
	iput(inode);
}

A
Al Viro 已提交
305
static const struct dentry_operations sysfs_dentry_ops = {
L
Linus Torvalds 已提交
306 307 308
	.d_iput		= sysfs_d_iput,
};

309
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
L
Linus Torvalds 已提交
310
{
T
Tejun Heo 已提交
311
	char *dup_name = NULL;
312
	struct sysfs_dirent *sd;
T
Tejun Heo 已提交
313 314 315 316

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

320
	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
321
	if (!sd)
322
		goto err_out1;
L
Linus Torvalds 已提交
323

T
Tejun Heo 已提交
324
	if (sysfs_alloc_ino(&sd->s_ino))
325
		goto err_out2;
326

L
Linus Torvalds 已提交
327
	atomic_set(&sd->s_count, 1);
328
	atomic_set(&sd->s_active, 0);
329

T
Tejun Heo 已提交
330
	sd->s_name = name;
331
	sd->s_mode = mode;
332
	sd->s_flags = type;
L
Linus Torvalds 已提交
333 334

	return sd;
T
Tejun Heo 已提交
335

336
 err_out2:
T
Tejun Heo 已提交
337
	kmem_cache_free(sysfs_dir_cachep, sd);
338 339
 err_out1:
	kfree(dup_name);
T
Tejun Heo 已提交
340
	return NULL;
L
Linus Torvalds 已提交
341 342
}

343 344 345 346 347 348
static int sysfs_ilookup_test(struct inode *inode, void *arg)
{
	struct sysfs_dirent *sd = arg;
	return inode->i_ino == sd->s_ino;
}

349
/**
350 351 352
 *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
 *	@acxt: pointer to sysfs_addrm_cxt to be used
 *	@parent_sd: parent sysfs_dirent
353
 *
354 355 356 357 358
 *	This function is called when the caller is about to add or
 *	remove sysfs_dirent under @parent_sd.  This function acquires
 *	sysfs_mutex, grabs inode for @parent_sd if available and lock
 *	i_mutex of it.  @acxt is used to keep and pass context to
 *	other addrm functions.
359 360
 *
 *	LOCKING:
361 362 363
 *	Kernel thread context (may sleep).  sysfs_mutex is locked on
 *	return.  i_mutex of parent inode is locked on return if
 *	available.
364
 */
365 366
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd)
367
{
368
	struct inode *inode;
369

370 371 372
	memset(acxt, 0, sizeof(*acxt));
	acxt->parent_sd = parent_sd;

373 374 375
	/* Lookup parent inode.  inode initialization is protected by
	 * sysfs_mutex, so inode existence can be determined by
	 * looking up inode while holding sysfs_mutex.
376 377 378
	 */
	mutex_lock(&sysfs_mutex);

379 380 381 382
	inode = ilookup5(sysfs_sb, parent_sd->s_ino, sysfs_ilookup_test,
			 parent_sd);
	if (inode) {
		WARN_ON(inode->i_state & I_NEW);
383 384 385 386 387 388 389 390 391 392 393 394 395

		/* parent inode available */
		acxt->parent_inode = inode;

		/* sysfs_mutex is below i_mutex in lock hierarchy.
		 * First, trylock i_mutex.  If fails, unlock
		 * sysfs_mutex and lock them in order.
		 */
		if (!mutex_trylock(&inode->i_mutex)) {
			mutex_unlock(&sysfs_mutex);
			mutex_lock(&inode->i_mutex);
			mutex_lock(&sysfs_mutex);
		}
396
	}
397 398 399
}

/**
400
 *	__sysfs_add_one - add sysfs_dirent to parent without warning
401 402 403 404
 *	@acxt: addrm context to use
 *	@sd: sysfs_dirent to be added
 *
 *	Get @acxt->parent_sd and set sd->s_parent to it and increment
405 406
 *	nlink of parent inode if @sd is a directory and link into the
 *	children list of the parent.
407 408 409 410 411 412 413
 *
 *	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().
414 415 416 417
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	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 423
		return -EEXIST;

424 425 426 427 428 429
	sd->s_parent = sysfs_get(acxt->parent_sd);

	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
		inc_nlink(acxt->parent_inode);

	acxt->cnt++;
430 431

	sysfs_link_sibling(sd);
432 433

	return 0;
434 435
}

436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
/**
 *	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;
}

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
/**
 *	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);
481 482 483 484 485 486 487 488 489 490
	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);
	}

491 492 493
	return ret;
}

494 495 496
/**
 *	sysfs_remove_one - remove sysfs_dirent from parent
 *	@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 503 504 505 506 507 508 509 510
 *
 *	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)
{
511 512 513
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

	sysfs_unlink_sibling(sd);
514 515 516 517 518 519 520 521 522 523 524

	sd->s_flags |= SYSFS_FLAG_REMOVED;
	sd->s_sibling = acxt->removed;
	acxt->removed = sd;

	if (sysfs_type(sd) == SYSFS_DIR && acxt->parent_inode)
		drop_nlink(acxt->parent_inode);

	acxt->cnt++;
}

525 526 527 528 529 530 531 532 533 534 535
/**
 *	sysfs_drop_dentry - drop dentry for the specified sysfs_dirent
 *	@sd: target sysfs_dirent
 *
 *	Drop dentry for @sd.  @sd must have been unlinked from its
 *	parent on entry to this function such that it can't be looked
 *	up anymore.
 */
static void sysfs_drop_dentry(struct sysfs_dirent *sd)
{
	struct inode *inode;
536 537 538 539 540
	struct dentry *dentry;

	inode = ilookup(sysfs_sb, sd->s_ino);
	if (!inode)
		return;
541

542 543 544 545 546 547
	/* Drop any existing dentries associated with sd.
	 *
	 * For the dentry to be properly freed we need to grab a
	 * reference to the dentry under the dcache lock,  unhash it,
	 * and then put it.  The playing with the dentry count allows
	 * dput to immediately free the dentry  if it is not in use.
548
	 */
549
repeat:
550
	spin_lock(&dcache_lock);
551 552 553 554
	list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
		if (d_unhashed(dentry))
			continue;
		dget_locked(dentry);
555 556 557
		spin_lock(&dentry->d_lock);
		__d_drop(dentry);
		spin_unlock(&dentry->d_lock);
558 559 560
		spin_unlock(&dcache_lock);
		dput(dentry);
		goto repeat;
561 562 563 564
	}
	spin_unlock(&dcache_lock);

	/* adjust nlink and update timestamp */
565
	mutex_lock(&inode->i_mutex);
566

567 568 569
	inode->i_ctime = CURRENT_TIME;
	drop_nlink(inode);
	if (sysfs_type(sd) == SYSFS_DIR)
570 571
		drop_nlink(inode);

572 573 574
	mutex_unlock(&inode->i_mutex);

	iput(inode);
575 576
}

577 578 579 580 581 582 583 584 585 586 587
/**
 *	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
 *	cleaned up.  Timestamps on the parent inode are updated.
 *
 *	LOCKING:
 *	All mutexes acquired by sysfs_addrm_start() are released.
 */
588
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
{
	/* release resources acquired by sysfs_addrm_start() */
	mutex_unlock(&sysfs_mutex);
	if (acxt->parent_inode) {
		struct inode *inode = acxt->parent_inode;

		/* if added/removed, update timestamps on the parent */
		if (acxt->cnt)
			inode->i_ctime = inode->i_mtime = CURRENT_TIME;

		mutex_unlock(&inode->i_mutex);
		iput(inode);
	}

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

		acxt->removed = sd->s_sibling;
		sd->s_sibling = NULL;

		sysfs_drop_dentry(sd);
		sysfs_deactivate(sd);
612
		unmap_bin_file(sd);
613
		sysfs_put(sd);
T
Tejun Heo 已提交
614
	}
615 616
}

617 618 619 620 621 622
/**
 *	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.
623
 *
624
 *	LOCKING:
625
 *	mutex_lock(sysfs_mutex)
626
 *
627 628
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
629
 */
630 631
struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
				       const unsigned char *name)
632
{
633 634
	struct sysfs_dirent *sd;

635
	for (sd = parent_sd->s_dir.children; sd; sd = sd->s_sibling)
E
Eric W. Biederman 已提交
636
		if (!strcmp(sd->s_name, name))
637 638 639
			return sd;
	return NULL;
}
640

641 642 643 644 645 646 647 648 649
/**
 *	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:
650
 *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
651 652 653 654 655 656 657 658 659
 *
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
 */
struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
				      const unsigned char *name)
{
	struct sysfs_dirent *sd;

660
	mutex_lock(&sysfs_mutex);
661 662
	sd = sysfs_find_dirent(parent_sd, name);
	sysfs_get(sd);
663
	mutex_unlock(&sysfs_mutex);
664 665

	return sd;
666
}
667
EXPORT_SYMBOL_GPL(sysfs_get_dirent);
668

669 670
static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
		      const char *name, struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
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;
L
Linus Torvalds 已提交
676

677
	/* allocate */
678
	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
679
	if (!sd)
680
		return -ENOMEM;
T
Tejun Heo 已提交
681
	sd->s_dir.kobj = kobj;
682

683
	/* link in */
684
	sysfs_addrm_start(&acxt, parent_sd);
685 686
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
687

688 689 690
	if (rc == 0)
		*p_sd = sd;
	else
691
		sysfs_put(sd);
692

693
	return rc;
L
Linus Torvalds 已提交
694 695
}

696 697
int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
698
{
699
	return create_dir(kobj, kobj->sd, name, p_sd);
L
Linus Torvalds 已提交
700 701 702 703 704 705
}

/**
 *	sysfs_create_dir - create a directory for an object.
 *	@kobj:		object we're creating directory for. 
 */
706
int sysfs_create_dir(struct kobject * kobj)
L
Linus Torvalds 已提交
707
{
708
	struct sysfs_dirent *parent_sd, *sd;
L
Linus Torvalds 已提交
709 710 711 712
	int error = 0;

	BUG_ON(!kobj);

713
	if (kobj->parent)
714
		parent_sd = kobj->parent->sd;
L
Linus Torvalds 已提交
715
	else
E
Eric W. Biederman 已提交
716
		parent_sd = &sysfs_root;
L
Linus Torvalds 已提交
717

718
	error = create_dir(kobj, parent_sd, kobject_name(kobj), &sd);
L
Linus Torvalds 已提交
719
	if (!error)
720
		kobj->sd = sd;
L
Linus Torvalds 已提交
721 722 723 724 725 726
	return error;
}

static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
				struct nameidata *nd)
{
727
	struct dentry *ret = NULL;
728 729
	struct sysfs_dirent *parent_sd = dentry->d_parent->d_fsdata;
	struct sysfs_dirent *sd;
730
	struct inode *inode;
L
Linus Torvalds 已提交
731

732 733
	mutex_lock(&sysfs_mutex);

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

736
	/* no such entry */
737 738
	if (!sd) {
		ret = ERR_PTR(-ENOENT);
739
		goto out_unlock;
740
	}
741 742

	/* attach dentry and inode */
743
	inode = sysfs_get_inode(sd);
744 745 746 747
	if (!inode) {
		ret = ERR_PTR(-ENOMEM);
		goto out_unlock;
	}
748

T
Tejun Heo 已提交
749 750 751
	/* instantiate and hash dentry */
	dentry->d_op = &sysfs_dentry_ops;
	dentry->d_fsdata = sysfs_get(sd);
752
	d_instantiate(dentry, inode);
T
Tejun Heo 已提交
753
	d_rehash(dentry);
754

755
 out_unlock:
756
	mutex_unlock(&sysfs_mutex);
757
	return ret;
L
Linus Torvalds 已提交
758 759
}

760
const struct inode_operations sysfs_dir_inode_operations = {
L
Linus Torvalds 已提交
761
	.lookup		= sysfs_lookup,
762
	.setattr	= sysfs_setattr,
L
Linus Torvalds 已提交
763 764
};

765
static void remove_dir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
766
{
767
	struct sysfs_addrm_cxt acxt;
L
Linus Torvalds 已提交
768

769 770 771
	sysfs_addrm_start(&acxt, sd->s_parent);
	sysfs_remove_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
L
Linus Torvalds 已提交
772 773
}

774
void sysfs_remove_subdir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
775
{
776
	remove_dir(sd);
L
Linus Torvalds 已提交
777 778 779
}


780
static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
L
Linus Torvalds 已提交
781
{
782
	struct sysfs_addrm_cxt acxt;
783
	struct sysfs_dirent **pos;
L
Linus Torvalds 已提交
784

785
	if (!dir_sd)
L
Linus Torvalds 已提交
786 787
		return;

788
	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
789
	sysfs_addrm_start(&acxt, dir_sd);
790
	pos = &dir_sd->s_dir.children;
791 792 793
	while (*pos) {
		struct sysfs_dirent *sd = *pos;

E
Eric W. Biederman 已提交
794
		if (sysfs_type(sd) != SYSFS_DIR)
795
			sysfs_remove_one(&acxt, sd);
796
		else
797
			pos = &(*pos)->s_sibling;
L
Linus Torvalds 已提交
798
	}
799
	sysfs_addrm_finish(&acxt);
800

801
	remove_dir(dir_sd);
802 803 804 805 806 807 808 809 810 811 812 813 814
}

/**
 *	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)
{
815
	struct sysfs_dirent *sd = kobj->sd;
816

T
Tejun Heo 已提交
817
	spin_lock(&sysfs_assoc_lock);
818
	kobj->sd = NULL;
T
Tejun Heo 已提交
819
	spin_unlock(&sysfs_assoc_lock);
820

821
	__sysfs_remove_dir(sd);
L
Linus Torvalds 已提交
822 823
}

824
int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
L
Linus Torvalds 已提交
825
{
826
	struct sysfs_dirent *sd = kobj->sd;
827
	struct dentry *parent = NULL;
828 829
	struct dentry *old_dentry = NULL, *new_dentry = NULL;
	const char *dup_name = NULL;
830
	int error;
L
Linus Torvalds 已提交
831

832 833
	mutex_lock(&sysfs_rename_mutex);

834 835 836 837
	error = 0;
	if (strcmp(sd->s_name, new_name) == 0)
		goto out;	/* nothing to rename */

T
Tejun Heo 已提交
838
	/* get the original dentry */
839 840 841
	old_dentry = sysfs_get_dentry(sd);
	if (IS_ERR(old_dentry)) {
		error = PTR_ERR(old_dentry);
842
		old_dentry = NULL;
843
		goto out;
844 845
	}

T
Tejun Heo 已提交
846
	parent = old_dentry->d_parent;
L
Linus Torvalds 已提交
847

848 849
	/* lock parent and get dentry for new name */
	mutex_lock(&parent->d_inode->i_mutex);
850
	mutex_lock(&sysfs_mutex);
L
Linus Torvalds 已提交
851

852 853
	error = -EEXIST;
	if (sysfs_find_dirent(sd->s_parent, new_name))
854
		goto out_unlock;
855

856 857 858
	error = -ENOMEM;
	new_dentry = d_alloc_name(parent, new_name);
	if (!new_dentry)
859
		goto out_unlock;
860

861
	/* rename sysfs_dirent */
T
Tejun Heo 已提交
862 863 864
	error = -ENOMEM;
	new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
	if (!new_name)
865
		goto out_unlock;
T
Tejun Heo 已提交
866

867
	dup_name = sd->s_name;
T
Tejun Heo 已提交
868 869
	sd->s_name = new_name;

T
Tejun Heo 已提交
870
	/* rename */
871
	d_add(new_dentry, NULL);
E
Eric W. Biederman 已提交
872
	d_move(old_dentry, new_dentry);
873 874 875

	error = 0;
 out_unlock:
876
	mutex_unlock(&sysfs_mutex);
877
	mutex_unlock(&parent->d_inode->i_mutex);
878 879 880
	kfree(dup_name);
	dput(old_dentry);
	dput(new_dentry);
881
 out:
882
	mutex_unlock(&sysfs_rename_mutex);
L
Linus Torvalds 已提交
883 884 885
	return error;
}

886
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
887
{
888 889 890 891
	struct sysfs_dirent *sd = kobj->sd;
	struct sysfs_dirent *new_parent_sd;
	struct dentry *old_parent, *new_parent = NULL;
	struct dentry *old_dentry = NULL, *new_dentry = NULL;
892 893
	int error;

894
	mutex_lock(&sysfs_rename_mutex);
895 896 897
	BUG_ON(!sd->s_parent);
	new_parent_sd = new_parent_kobj->sd ? new_parent_kobj->sd : &sysfs_root;

898 899 900 901
	error = 0;
	if (sd->s_parent == new_parent_sd)
		goto out;	/* nothing to move */

902 903 904 905
	/* get dentries */
	old_dentry = sysfs_get_dentry(sd);
	if (IS_ERR(old_dentry)) {
		error = PTR_ERR(old_dentry);
906
		old_dentry = NULL;
907
		goto out;
908
	}
E
Eric W. Biederman 已提交
909
	old_parent = old_dentry->d_parent;
910 911 912 913

	new_parent = sysfs_get_dentry(new_parent_sd);
	if (IS_ERR(new_parent)) {
		error = PTR_ERR(new_parent);
914
		new_parent = NULL;
915
		goto out;
916
	}
917 918

again:
919 920 921
	mutex_lock(&old_parent->d_inode->i_mutex);
	if (!mutex_trylock(&new_parent->d_inode->i_mutex)) {
		mutex_unlock(&old_parent->d_inode->i_mutex);
922 923
		goto again;
	}
924
	mutex_lock(&sysfs_mutex);
925

926 927
	error = -EEXIST;
	if (sysfs_find_dirent(new_parent_sd, sd->s_name))
928
		goto out_unlock;
929 930 931 932 933 934 935

	error = -ENOMEM;
	new_dentry = d_alloc_name(new_parent, sd->s_name);
	if (!new_dentry)
		goto out_unlock;

	error = 0;
936
	d_add(new_dentry, NULL);
E
Eric W. Biederman 已提交
937
	d_move(old_dentry, new_dentry);
938 939

	/* Remove from old parent's list and insert into new parent's list. */
940
	sysfs_unlink_sibling(sd);
941
	sysfs_get(new_parent_sd);
942
	drop_nlink(old_parent->d_inode);
943 944
	sysfs_put(sd->s_parent);
	sd->s_parent = new_parent_sd;
945
	inc_nlink(new_parent->d_inode);
946
	sysfs_link_sibling(sd);
947

948
 out_unlock:
949
	mutex_unlock(&sysfs_mutex);
950 951
	mutex_unlock(&new_parent->d_inode->i_mutex);
	mutex_unlock(&old_parent->d_inode->i_mutex);
952
 out:
953 954 955
	dput(new_parent);
	dput(old_dentry);
	dput(new_dentry);
956
	mutex_unlock(&sysfs_rename_mutex);
957 958 959
	return error;
}

L
Linus Torvalds 已提交
960 961 962 963 964 965 966 967
/* 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;
}

static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
{
968
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
969
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
E
Eric W. Biederman 已提交
970
	struct sysfs_dirent *pos;
L
Linus Torvalds 已提交
971 972
	ino_t ino;

E
Eric W. Biederman 已提交
973 974 975
	if (filp->f_pos == 0) {
		ino = parent_sd->s_ino;
		if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
L
Linus Torvalds 已提交
976
			filp->f_pos++;
E
Eric W. Biederman 已提交
977 978 979 980 981 982 983
	}
	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 已提交
984
			filp->f_pos++;
E
Eric W. Biederman 已提交
985 986 987
	}
	if ((filp->f_pos > 1) && (filp->f_pos < INT_MAX)) {
		mutex_lock(&sysfs_mutex);
988

E
Eric W. Biederman 已提交
989
		/* Skip the dentries we have already reported */
990
		pos = parent_sd->s_dir.children;
E
Eric W. Biederman 已提交
991 992
		while (pos && (filp->f_pos > pos->s_ino))
			pos = pos->s_sibling;
993

E
Eric W. Biederman 已提交
994 995 996
		for ( ; pos; pos = pos->s_sibling) {
			const char * name;
			int len;
L
Linus Torvalds 已提交
997

E
Eric W. Biederman 已提交
998 999 1000
			name = pos->s_name;
			len = strlen(name);
			filp->f_pos = ino = pos->s_ino;
L
Linus Torvalds 已提交
1001

E
Eric W. Biederman 已提交
1002 1003
			if (filldir(dirent, name, len, filp->f_pos, ino,
					 dt_type(pos)) < 0)
L
Linus Torvalds 已提交
1004 1005
				break;
		}
E
Eric W. Biederman 已提交
1006 1007
		if (!pos)
			filp->f_pos = INT_MAX;
1008
		mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1009
	}
E
Eric W. Biederman 已提交
1010
	return 0;
L
Linus Torvalds 已提交
1011 1012
}

E
Eric W. Biederman 已提交
1013

1014
const struct file_operations sysfs_dir_operations = {
L
Linus Torvalds 已提交
1015 1016
	.read		= generic_read_dir,
	.readdir	= sysfs_readdir,
1017
	.llseek		= generic_file_llseek,
L
Linus Torvalds 已提交
1018
};