dir.c 23.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * dir.c - Operations for sysfs directories.
 */

#undef DEBUG

#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/module.h>
#include <linux/kobject.h>
11
#include <linux/namei.h>
12
#include <linux/idr.h>
13
#include <linux/completion.h>
D
Dave Young 已提交
14
#include <linux/mutex.h>
L
Linus Torvalds 已提交
15 16
#include "sysfs.h"

17
DEFINE_MUTEX(sysfs_mutex);
18
DEFINE_MUTEX(sysfs_rename_mutex);
T
Tejun Heo 已提交
19
spinlock_t sysfs_assoc_lock = SPIN_LOCK_UNLOCKED;
L
Linus Torvalds 已提交
20

21 22 23
static spinlock_t sysfs_ino_lock = SPIN_LOCK_UNLOCKED;
static DEFINE_IDA(sysfs_ino_ida);

24 25 26 27 28 29 30 31
/**
 *	sysfs_link_sibling - link sysfs_dirent into sibling list
 *	@sd: sysfs_dirent of interest
 *
 *	Link @sd into its sibling list which starts from
 *	sd->s_parent->s_children.
 *
 *	Locking:
32
 *	mutex_lock(sysfs_mutex)
33
 */
34
static void sysfs_link_sibling(struct sysfs_dirent *sd)
35 36
{
	struct sysfs_dirent *parent_sd = sd->s_parent;
E
Eric W. Biederman 已提交
37
	struct sysfs_dirent **pos;
38 39

	BUG_ON(sd->s_sibling);
E
Eric W. Biederman 已提交
40 41 42 43 44 45 46 47 48 49 50

	/* Store directory entries in order by ino.  This allows
	 * readdir to properly restart without having to add a
	 * cursor into the s_children list.
	 */
	for (pos = &parent_sd->s_children; *pos; pos = &(*pos)->s_sibling) {
		if (sd->s_ino < (*pos)->s_ino)
			break;
	}
	sd->s_sibling = *pos;
	*pos = sd;
51 52 53 54 55 56 57 58 59 60
}

/**
 *	sysfs_unlink_sibling - unlink sysfs_dirent from sibling list
 *	@sd: sysfs_dirent of interest
 *
 *	Unlink @sd from its sibling list which starts from
 *	sd->s_parent->s_children.
 *
 *	Locking:
61
 *	mutex_lock(sysfs_mutex)
62
 */
63
static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
64 65 66 67 68 69 70 71 72 73 74 75
{
	struct sysfs_dirent **pos;

	for (pos = &sd->s_parent->s_children; *pos; pos = &(*pos)->s_sibling) {
		if (*pos == sd) {
			*pos = sd->s_sibling;
			sd->s_sibling = NULL;
			break;
		}
	}
}

T
Tejun Heo 已提交
76 77 78 79 80 81 82 83 84 85
/**
 *	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
 *	present.  This function climbs sysfs_dirent tree till it
 *	reaches a sysfs_dirent with valid dentry attached and descends
 *	down from there looking up dentry for each step.
 *
 *	LOCKING:
86
 *	mutex_lock(sysfs_rename_mutex)
T
Tejun Heo 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
 *
 *	RETURNS:
 *	Pointer to found dentry on success, ERR_PTR() value on error.
 */
struct dentry *sysfs_get_dentry(struct sysfs_dirent *sd)
{
	struct sysfs_dirent *cur;
	struct dentry *parent_dentry, *dentry;
	int i, depth;

	/* Find the first parent which has valid s_dentry and get the
	 * dentry.
	 */
	mutex_lock(&sysfs_mutex);
 restart0:
	spin_lock(&sysfs_assoc_lock);
 restart1:
	spin_lock(&dcache_lock);

	dentry = NULL;
	depth = 0;
	cur = sd;
	while (!cur->s_dentry || !cur->s_dentry->d_inode) {
		if (cur->s_flags & SYSFS_FLAG_REMOVED) {
			dentry = ERR_PTR(-ENOENT);
			depth = 0;
			break;
		}
		cur = cur->s_parent;
		depth++;
	}
	if (!IS_ERR(dentry))
		dentry = dget_locked(cur->s_dentry);

	spin_unlock(&dcache_lock);
	spin_unlock(&sysfs_assoc_lock);

	/* from the found dentry, look up depth times */
	while (depth--) {
		/* find and get depth'th ancestor */
		for (cur = sd, i = 0; cur && i < depth; i++)
			cur = cur->s_parent;

		/* This can happen if tree structure was modified due
		 * to move/rename.  Restart.
		 */
		if (i != depth) {
			dput(dentry);
			goto restart0;
		}

		sysfs_get(cur);

		mutex_unlock(&sysfs_mutex);

		/* look it up */
		parent_dentry = dentry;
144
		mutex_lock(&parent_dentry->d_inode->i_mutex);
T
Tejun Heo 已提交
145 146
		dentry = lookup_one_len_kern(cur->s_name, parent_dentry,
					     strlen(cur->s_name));
147
		mutex_unlock(&parent_dentry->d_inode->i_mutex);
T
Tejun Heo 已提交
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
		dput(parent_dentry);

		if (IS_ERR(dentry)) {
			sysfs_put(cur);
			return dentry;
		}

		mutex_lock(&sysfs_mutex);
		spin_lock(&sysfs_assoc_lock);

		/* This, again, can happen if tree structure has
		 * changed and we looked up the wrong thing.  Restart.
		 */
		if (cur->s_dentry != dentry) {
			dput(dentry);
			sysfs_put(cur);
			goto restart1;
		}

		spin_unlock(&sysfs_assoc_lock);

		sysfs_put(cur);
	}

	mutex_unlock(&sysfs_mutex);
	return dentry;
}

176 177 178 179 180 181 182 183 184 185 186 187
/**
 *	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.
 */
struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
{
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
	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();
205 206 207 208 209 210 211 212 213 214 215 216
	}
}

/**
 *	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.
 */
void sysfs_put_active(struct sysfs_dirent *sd)
{
217 218 219 220 221 222 223 224 225 226 227
	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
228
	 * sd->s_sibling.
229
	 */
230
	cmpl = (void *)sd->s_sibling;
231
	complete(cmpl);
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 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 274 275 276
}

/**
 *	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
 *
277
 *	Deny new active references and drain existing ones.
278
 */
279
static void sysfs_deactivate(struct sysfs_dirent *sd)
280
{
281 282
	DECLARE_COMPLETION_ONSTACK(wait);
	int v;
283

284
	BUG_ON(sd->s_sibling || !(sd->s_flags & SYSFS_FLAG_REMOVED));
285
	sd->s_sibling = (void *)&wait;
286 287

	/* atomic_add_return() is a mb(), put_active() will always see
288
	 * the updated sd->s_sibling.
289
	 */
290 291 292 293 294
	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);

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

295
	sd->s_sibling = NULL;
296 297
}

T
Tejun Heo 已提交
298
static int sysfs_alloc_ino(ino_t *pino)
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
{
	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);
}

324 325
void release_sysfs_dirent(struct sysfs_dirent * sd)
{
T
Tejun Heo 已提交
326 327 328
	struct sysfs_dirent *parent_sd;

 repeat:
329 330 331
	/* Moving/renaming is always done while holding reference.
	 * sd->s_parent won't change beneath us.
	 */
T
Tejun Heo 已提交
332 333
	parent_sd = sd->s_parent;

334
	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
335
		sysfs_put(sd->s_elem.symlink.target_sd);
336
	if (sysfs_type(sd) & SYSFS_COPY_NAME)
T
Tejun Heo 已提交
337
		kfree(sd->s_name);
338
	kfree(sd->s_iattr);
339
	sysfs_free_ino(sd->s_ino);
340
	kmem_cache_free(sysfs_dir_cachep, sd);
T
Tejun Heo 已提交
341 342 343 344

	sd = parent_sd;
	if (sd && atomic_dec_and_test(&sd->s_count))
		goto repeat;
345 346
}

L
Linus Torvalds 已提交
347 348 349 350 351
static void sysfs_d_iput(struct dentry * dentry, struct inode * inode)
{
	struct sysfs_dirent * sd = dentry->d_fsdata;

	if (sd) {
T
Tejun Heo 已提交
352 353
		/* sd->s_dentry is protected with sysfs_assoc_lock.
		 * This allows sysfs_drop_dentry() to dereference it.
354
		 */
T
Tejun Heo 已提交
355
		spin_lock(&sysfs_assoc_lock);
356 357 358 359 360 361 362 363

		/* The dentry might have been deleted or another
		 * lookup could have happened updating sd->s_dentry to
		 * point the new dentry.  Ignore if it isn't pointing
		 * to this dentry.
		 */
		if (sd->s_dentry == dentry)
			sd->s_dentry = NULL;
T
Tejun Heo 已提交
364
		spin_unlock(&sysfs_assoc_lock);
L
Linus Torvalds 已提交
365 366 367 368 369 370 371 372 373
		sysfs_put(sd);
	}
	iput(inode);
}

static struct dentry_operations sysfs_dentry_ops = {
	.d_iput		= sysfs_d_iput,
};

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

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

385
	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
386
	if (!sd)
387
		goto err_out1;
L
Linus Torvalds 已提交
388

T
Tejun Heo 已提交
389
	if (sysfs_alloc_ino(&sd->s_ino))
390
		goto err_out2;
391

L
Linus Torvalds 已提交
392
	atomic_set(&sd->s_count, 1);
393
	atomic_set(&sd->s_active, 0);
394
	atomic_set(&sd->s_event, 1);
395

T
Tejun Heo 已提交
396
	sd->s_name = name;
397
	sd->s_mode = mode;
398
	sd->s_flags = type;
L
Linus Torvalds 已提交
399 400

	return sd;
T
Tejun Heo 已提交
401

402
 err_out2:
T
Tejun Heo 已提交
403
	kmem_cache_free(sysfs_dir_cachep, sd);
404 405
 err_out1:
	kfree(dup_name);
T
Tejun Heo 已提交
406
	return NULL;
L
Linus Torvalds 已提交
407 408
}

409 410 411 412 413 414 415 416 417 418 419
/**
 *	sysfs_attach_dentry - associate sysfs_dirent with dentry
 *	@sd: target sysfs_dirent
 *	@dentry: dentry to associate
 *
 *	Associate @sd with @dentry.  This is protected by
 *	sysfs_assoc_lock to avoid race with sysfs_d_iput().
 *
 *	LOCKING:
 *	mutex_lock(sysfs_mutex)
 */
420 421 422 423 424 425
static void sysfs_attach_dentry(struct sysfs_dirent *sd, struct dentry *dentry)
{
	dentry->d_op = &sysfs_dentry_ops;
	dentry->d_fsdata = sysfs_get(sd);

	/* protect sd->s_dentry against sysfs_d_iput */
T
Tejun Heo 已提交
426
	spin_lock(&sysfs_assoc_lock);
427
	sd->s_dentry = dentry;
T
Tejun Heo 已提交
428
	spin_unlock(&sysfs_assoc_lock);
429 430 431 432

	d_rehash(dentry);
}

433 434 435 436 437 438
static int sysfs_ilookup_test(struct inode *inode, void *arg)
{
	struct sysfs_dirent *sd = arg;
	return inode->i_ino == sd->s_ino;
}

439
/**
440 441 442
 *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
 *	@acxt: pointer to sysfs_addrm_cxt to be used
 *	@parent_sd: parent sysfs_dirent
443
 *
444 445 446 447 448
 *	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.
449 450
 *
 *	LOCKING:
451 452 453
 *	Kernel thread context (may sleep).  sysfs_mutex is locked on
 *	return.  i_mutex of parent inode is locked on return if
 *	available.
454
 */
455 456
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd)
457
{
458
	struct inode *inode;
459

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 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 502 503 504 505 506
	memset(acxt, 0, sizeof(*acxt));
	acxt->parent_sd = parent_sd;

	/* Lookup parent inode.  inode initialization and I_NEW
	 * clearing are protected by sysfs_mutex.  By grabbing it and
	 * looking up with _nowait variant, inode state can be
	 * determined reliably.
	 */
	mutex_lock(&sysfs_mutex);

	inode = ilookup5_nowait(sysfs_sb, parent_sd->s_ino, sysfs_ilookup_test,
				parent_sd);

	if (inode && !(inode->i_state & I_NEW)) {
		/* 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);
		}
	} else
		iput(inode);
}

/**
 *	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.  @sd is NOT
 *	linked into the children list of the parent.  The caller
 *	should invoke sysfs_link_sibling() after this function
 *	completes if @sd needs to be on the children list.
 *
 *	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().
507 508 509 510
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
511
 */
512
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
513
{
514 515 516
	if (sysfs_find_dirent(acxt->parent_sd, sd->s_name))
		return -EEXIST;

517 518 519 520 521 522
	sd->s_parent = sysfs_get(acxt->parent_sd);

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

	acxt->cnt++;
523 524

	sysfs_link_sibling(sd);
525 526

	return 0;
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
}

/**
 *	sysfs_remove_one - remove sysfs_dirent from parent
 *	@acxt: addrm context to use
 *	@sd: sysfs_dirent to be added
 *
 *	Mark @sd removed and drop nlink of parent inode if @sd is a
 *	directory.  @sd is NOT unlinked from the children list of the
 *	parent.  The caller is repsonsible for removing @sd from the
 *	children list before calling this function.
 *
 *	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)
{
548 549 550
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

	sysfs_unlink_sibling(sd);
551 552 553 554 555 556 557 558 559 560 561

	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++;
}

562 563 564 565 566 567 568 569 570 571 572
/**
 *	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;
573 574 575 576 577
	struct dentry *dentry;

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

579 580 581 582 583 584
	/* 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.
585
	 */
586
repeat:
587
	spin_lock(&dcache_lock);
588 589 590 591
	list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
		if (d_unhashed(dentry))
			continue;
		dget_locked(dentry);
592 593 594
		spin_lock(&dentry->d_lock);
		__d_drop(dentry);
		spin_unlock(&dentry->d_lock);
595 596 597
		spin_unlock(&dcache_lock);
		dput(dentry);
		goto repeat;
598 599 600 601
	}
	spin_unlock(&dcache_lock);

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

604 605 606
	inode->i_ctime = CURRENT_TIME;
	drop_nlink(inode);
	if (sysfs_type(sd) == SYSFS_DIR)
607 608
		drop_nlink(inode);

609 610 611
	mutex_unlock(&inode->i_mutex);

	iput(inode);
612 613
}

614 615 616 617 618 619 620 621 622 623 624
/**
 *	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.
 */
625
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
{
	/* 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);
		sysfs_put(sd);
T
Tejun Heo 已提交
650
	}
651 652
}

653 654 655 656 657 658
/**
 *	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.
659
 *
660
 *	LOCKING:
661
 *	mutex_lock(sysfs_mutex)
662
 *
663 664
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
665
 */
666 667
struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
				       const unsigned char *name)
668
{
669 670 671
	struct sysfs_dirent *sd;

	for (sd = parent_sd->s_children; sd; sd = sd->s_sibling)
E
Eric W. Biederman 已提交
672
		if (!strcmp(sd->s_name, name))
673 674 675
			return sd;
	return NULL;
}
676

677 678 679 680 681 682 683 684 685
/**
 *	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:
686
 *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
687 688 689 690 691 692 693 694 695
 *
 *	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;

696
	mutex_lock(&sysfs_mutex);
697 698
	sd = sysfs_find_dirent(parent_sd, name);
	sysfs_get(sd);
699
	mutex_unlock(&sysfs_mutex);
700 701

	return sd;
702 703
}

704 705
static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
		      const char *name, struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
706 707
{
	umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
708
	struct sysfs_addrm_cxt acxt;
709
	struct sysfs_dirent *sd;
710
	int rc;
L
Linus Torvalds 已提交
711

712
	/* allocate */
713
	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
714
	if (!sd)
715
		return -ENOMEM;
716
	sd->s_elem.dir.kobj = kobj;
717

718
	/* link in */
719
	sysfs_addrm_start(&acxt, parent_sd);
720 721
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
722

723 724 725
	if (rc == 0)
		*p_sd = sd;
	else
726
		sysfs_put(sd);
727

728
	return rc;
L
Linus Torvalds 已提交
729 730
}

731 732
int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
733
{
734
	return create_dir(kobj, kobj->sd, name, p_sd);
L
Linus Torvalds 已提交
735 736 737 738 739 740
}

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

	BUG_ON(!kobj);

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

753
	error = create_dir(kobj, parent_sd, kobject_name(kobj), &sd);
L
Linus Torvalds 已提交
754
	if (!error)
755
		kobj->sd = sd;
L
Linus Torvalds 已提交
756 757 758 759 760 761
	return error;
}

static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
				struct nameidata *nd)
{
762
	struct dentry *ret = NULL;
763 764
	struct sysfs_dirent *parent_sd = dentry->d_parent->d_fsdata;
	struct sysfs_dirent *sd;
765
	struct inode *inode;
L
Linus Torvalds 已提交
766

767 768
	mutex_lock(&sysfs_mutex);

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

771
	/* no such entry */
772
	if (!sd)
773
		goto out_unlock;
774 775

	/* attach dentry and inode */
776
	inode = sysfs_get_inode(sd);
777 778 779 780
	if (!inode) {
		ret = ERR_PTR(-ENOMEM);
		goto out_unlock;
	}
781

782
	d_instantiate(dentry, inode);
783 784
	sysfs_attach_dentry(sd, dentry);

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

790
const struct inode_operations sysfs_dir_inode_operations = {
L
Linus Torvalds 已提交
791
	.lookup		= sysfs_lookup,
792
	.setattr	= sysfs_setattr,
L
Linus Torvalds 已提交
793 794
};

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

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

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


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

815
	if (!dir_sd)
L
Linus Torvalds 已提交
816 817
		return;

818
	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
819
	sysfs_addrm_start(&acxt, dir_sd);
820
	pos = &dir_sd->s_children;
821 822 823
	while (*pos) {
		struct sysfs_dirent *sd = *pos;

E
Eric W. Biederman 已提交
824
		if (sysfs_type(sd) != SYSFS_DIR)
825
			sysfs_remove_one(&acxt, sd);
826
		else
827
			pos = &(*pos)->s_sibling;
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_dir(struct kobject * kobj, const char *new_name)
L
Linus Torvalds 已提交
855
{
856 857
	struct sysfs_dirent *sd;
	struct dentry *parent = NULL;
858 859
	struct dentry *old_dentry = NULL, *new_dentry = NULL;
	const char *dup_name = NULL;
860
	int error;
L
Linus Torvalds 已提交
861

862 863
	mutex_lock(&sysfs_rename_mutex);

T
Tejun Heo 已提交
864
	/* get the original dentry */
865
	sd = kobj->sd;
866 867 868 869 870 871
	old_dentry = sysfs_get_dentry(sd);
	if (IS_ERR(old_dentry)) {
		error = PTR_ERR(old_dentry);
		goto out_dput;
	}

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

874 875
	/* lock parent and get dentry for new name */
	mutex_lock(&parent->d_inode->i_mutex);
L
Linus Torvalds 已提交
876

877
	new_dentry = lookup_one_len(new_name, parent, strlen(new_name));
878 879 880
	if (IS_ERR(new_dentry)) {
		error = PTR_ERR(new_dentry);
		goto out_unlock;
L
Linus Torvalds 已提交
881
	}
882 883

	error = -EINVAL;
884
	if (old_dentry == new_dentry)
885
		goto out_unlock;
886 887 888

	error = -EEXIST;
	if (new_dentry->d_inode)
889
		goto out_unlock;
890

T
Tejun Heo 已提交
891 892 893 894 895 896
	/* rename kobject and sysfs_dirent */
	error = -ENOMEM;
	new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
	if (!new_name)
		goto out_drop;

897 898
	error = kobject_set_name(kobj, "%s", new_name);
	if (error)
899
		goto out_drop;
900

901
	mutex_lock(&sysfs_mutex);
902
	dup_name = sd->s_name;
T
Tejun Heo 已提交
903
	sd->s_name = new_name;
T
Tejun Heo 已提交
904
	mutex_unlock(&sysfs_mutex);
T
Tejun Heo 已提交
905

T
Tejun Heo 已提交
906
	/* rename */
907
	d_add(new_dentry, NULL);
908
	d_move(sd->s_dentry, new_dentry);
909 910 911 912 913 914 915

	error = 0;
	goto out_unlock;

 out_drop:
	d_drop(new_dentry);
 out_unlock:
916
	mutex_unlock(&parent->d_inode->i_mutex);
917 918 919 920
 out_dput:
	kfree(dup_name);
	dput(old_dentry);
	dput(new_dentry);
921
	mutex_unlock(&sysfs_rename_mutex);
L
Linus Torvalds 已提交
922 923 924
	return error;
}

925
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
926
{
927 928 929 930
	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;
931 932
	int error;

933
	mutex_lock(&sysfs_rename_mutex);
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
	BUG_ON(!sd->s_parent);
	new_parent_sd = new_parent_kobj->sd ? new_parent_kobj->sd : &sysfs_root;

	/* get dentries */
	old_dentry = sysfs_get_dentry(sd);
	if (IS_ERR(old_dentry)) {
		error = PTR_ERR(old_dentry);
		goto out_dput;
	}
	old_parent = sd->s_parent->s_dentry;

	new_parent = sysfs_get_dentry(new_parent_sd);
	if (IS_ERR(new_parent)) {
		error = PTR_ERR(new_parent);
		goto out_dput;
	}
950

951 952 953 954
	if (old_parent->d_inode == new_parent->d_inode) {
		error = 0;
		goto out_dput;	/* nothing to move */
	}
955
again:
956 957 958
	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);
959 960 961
		goto again;
	}

962
	new_dentry = lookup_one_len(kobject_name(kobj), new_parent, strlen(kobject_name(kobj)));
963 964
	if (IS_ERR(new_dentry)) {
		error = PTR_ERR(new_dentry);
965
		goto out_unlock;
966 967 968
	} else
		error = 0;
	d_add(new_dentry, NULL);
969
	d_move(sd->s_dentry, new_dentry);
970 971 972
	dput(new_dentry);

	/* Remove from old parent's list and insert into new parent's list. */
973 974
	mutex_lock(&sysfs_mutex);

975
	sysfs_unlink_sibling(sd);
976 977 978
	sysfs_get(new_parent_sd);
	sysfs_put(sd->s_parent);
	sd->s_parent = new_parent_sd;
979
	sysfs_link_sibling(sd);
980

981
	mutex_unlock(&sysfs_mutex);
982

983 984 985 986 987 988 989
 out_unlock:
	mutex_unlock(&new_parent->d_inode->i_mutex);
	mutex_unlock(&old_parent->d_inode->i_mutex);
 out_dput:
	dput(new_parent);
	dput(old_dentry);
	dput(new_dentry);
990
	mutex_unlock(&sysfs_rename_mutex);
991 992 993
	return error;
}

L
Linus Torvalds 已提交
994 995 996 997 998 999 1000 1001
/* 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)
{
1002
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
1003
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
E
Eric W. Biederman 已提交
1004
	struct sysfs_dirent *pos;
L
Linus Torvalds 已提交
1005 1006
	ino_t ino;

E
Eric W. Biederman 已提交
1007 1008 1009
	if (filp->f_pos == 0) {
		ino = parent_sd->s_ino;
		if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
L
Linus Torvalds 已提交
1010
			filp->f_pos++;
E
Eric W. Biederman 已提交
1011 1012 1013 1014 1015 1016 1017
	}
	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 已提交
1018
			filp->f_pos++;
E
Eric W. Biederman 已提交
1019 1020 1021
	}
	if ((filp->f_pos > 1) && (filp->f_pos < INT_MAX)) {
		mutex_lock(&sysfs_mutex);
1022

E
Eric W. Biederman 已提交
1023 1024 1025 1026
		/* Skip the dentries we have already reported */
		pos = parent_sd->s_children;
		while (pos && (filp->f_pos > pos->s_ino))
			pos = pos->s_sibling;
1027

E
Eric W. Biederman 已提交
1028 1029 1030
		for ( ; pos; pos = pos->s_sibling) {
			const char * name;
			int len;
L
Linus Torvalds 已提交
1031

E
Eric W. Biederman 已提交
1032 1033 1034
			name = pos->s_name;
			len = strlen(name);
			filp->f_pos = ino = pos->s_ino;
L
Linus Torvalds 已提交
1035

E
Eric W. Biederman 已提交
1036 1037
			if (filldir(dirent, name, len, filp->f_pos, ino,
					 dt_type(pos)) < 0)
L
Linus Torvalds 已提交
1038 1039
				break;
		}
E
Eric W. Biederman 已提交
1040 1041
		if (!pos)
			filp->f_pos = INT_MAX;
1042
		mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1043
	}
E
Eric W. Biederman 已提交
1044
	return 0;
L
Linus Torvalds 已提交
1045 1046
}

E
Eric W. Biederman 已提交
1047

1048
const struct file_operations sysfs_dir_operations = {
L
Linus Torvalds 已提交
1049 1050 1051
	.read		= generic_read_dir,
	.readdir	= sysfs_readdir,
};