dir.c 23.6 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);
T
Tejun Heo 已提交
18
spinlock_t sysfs_assoc_lock = SPIN_LOCK_UNLOCKED;
L
Linus Torvalds 已提交
19

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

23 24 25 26 27 28 29 30
/**
 *	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:
31
 *	mutex_lock(sysfs_mutex)
32
 */
33
static void sysfs_link_sibling(struct sysfs_dirent *sd)
34 35
{
	struct sysfs_dirent *parent_sd = sd->s_parent;
E
Eric W. Biederman 已提交
36
	struct sysfs_dirent **pos;
37 38

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

	/* 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;
50 51 52 53 54 55 56 57 58 59
}

/**
 *	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:
60
 *	mutex_lock(sysfs_mutex)
61
 */
62
static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
63 64 65 66 67 68 69 70 71 72 73 74
{
	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 已提交
75 76 77 78 79 80 81 82 83 84 85 86 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
/**
 *	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:
 *	Kernel thread context (may sleep)
 *
 *	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;
143
		mutex_lock(&parent_dentry->d_inode->i_mutex);
T
Tejun Heo 已提交
144 145
		dentry = lookup_one_len_kern(cur->s_name, parent_dentry,
					     strlen(cur->s_name));
146
		mutex_unlock(&parent_dentry->d_inode->i_mutex);
T
Tejun Heo 已提交
147 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
		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;
}

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

/**
 *	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)
{
216 217 218 219 220 221 222 223 224 225 226
	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
227
	 * sd->s_sibling.
228
	 */
229
	cmpl = (void *)sd->s_sibling;
230
	complete(cmpl);
231 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
}

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

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

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

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

294
	sd->s_sibling = NULL;
295 296
}

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

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

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

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

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

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

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

		/* 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 已提交
363
		spin_unlock(&sysfs_assoc_lock);
L
Linus Torvalds 已提交
364 365 366 367 368 369 370 371 372
		sysfs_put(sd);
	}
	iput(inode);
}

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

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

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

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

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

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

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

	return sd;
T
Tejun Heo 已提交
400

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

408 409 410 411 412 413 414 415 416 417 418
/**
 *	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)
 */
419 420 421 422 423 424
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 已提交
425
	spin_lock(&sysfs_assoc_lock);
426
	sd->s_dentry = dentry;
T
Tejun Heo 已提交
427
	spin_unlock(&sysfs_assoc_lock);
428 429 430 431

	d_rehash(dentry);
}

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

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

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
	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().
506 507 508 509
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
510
 */
511
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
512
{
513 514 515
	if (sysfs_find_dirent(acxt->parent_sd, sd->s_name))
		return -EEXIST;

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

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

	acxt->cnt++;
522 523

	sysfs_link_sibling(sd);
524 525

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

/**
 *	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)
{
547 548 549
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

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

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

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

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

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

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

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

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

	iput(inode);
611 612
}

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

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

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

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

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

	return sd;
701 702
}

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

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

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

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

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

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

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

	BUG_ON(!kobj);

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

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

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

766 767
	mutex_lock(&sysfs_mutex);

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

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

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

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

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
	.setattr	= sysfs_setattr,
L
Linus Torvalds 已提交
792 793
};

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

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

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


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

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

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

E
Eric W. Biederman 已提交
823
		if (sysfs_type(sd) != SYSFS_DIR)
824
			sysfs_remove_one(&acxt, sd);
825
		else
826
			pos = &(*pos)->s_sibling;
L
Linus Torvalds 已提交
827
	}
828
	sysfs_addrm_finish(&acxt);
829

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

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

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

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

853
int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
L
Linus Torvalds 已提交
854
{
855 856
	struct sysfs_dirent *sd;
	struct dentry *parent = NULL;
857 858
	struct dentry *old_dentry = NULL, *new_dentry = NULL;
	const char *dup_name = NULL;
859
	int error;
L
Linus Torvalds 已提交
860

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

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

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

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

	error = -EINVAL;
881
	if (old_dentry == new_dentry)
882
		goto out_unlock;
883 884 885

	error = -EEXIST;
	if (new_dentry->d_inode)
886
		goto out_unlock;
887

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

894 895
	error = kobject_set_name(kobj, "%s", new_name);
	if (error)
896
		goto out_drop;
897

898
	mutex_lock(&sysfs_mutex);
899
	dup_name = sd->s_name;
T
Tejun Heo 已提交
900
	sd->s_name = new_name;
T
Tejun Heo 已提交
901
	mutex_unlock(&sysfs_mutex);
T
Tejun Heo 已提交
902

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

	error = 0;
	goto out_unlock;

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

921
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
922
{
923 924 925 926
	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;
927 928
	int error;

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
	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;
	}
945

946 947 948 949
	if (old_parent->d_inode == new_parent->d_inode) {
		error = 0;
		goto out_dput;	/* nothing to move */
	}
950
again:
951 952 953
	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);
954 955 956
		goto again;
	}

957
	new_dentry = lookup_one_len(kobject_name(kobj), new_parent, strlen(kobject_name(kobj)));
958 959
	if (IS_ERR(new_dentry)) {
		error = PTR_ERR(new_dentry);
960
		goto out_unlock;
961 962 963
	} else
		error = 0;
	d_add(new_dentry, NULL);
964
	d_move(sd->s_dentry, new_dentry);
965 966 967
	dput(new_dentry);

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

970
	sysfs_unlink_sibling(sd);
971 972 973
	sysfs_get(new_parent_sd);
	sysfs_put(sd->s_parent);
	sd->s_parent = new_parent_sd;
974
	sysfs_link_sibling(sd);
975

976
	mutex_unlock(&sysfs_mutex);
977

978 979 980 981 982 983 984
 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);
985 986 987
	return error;
}

L
Linus Torvalds 已提交
988 989 990 991 992 993 994 995
/* 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)
{
996
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
997
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
E
Eric W. Biederman 已提交
998
	struct sysfs_dirent *pos;
L
Linus Torvalds 已提交
999 1000
	ino_t ino;

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

E
Eric W. Biederman 已提交
1017 1018 1019 1020
		/* Skip the dentries we have already reported */
		pos = parent_sd->s_children;
		while (pos && (filp->f_pos > pos->s_ino))
			pos = pos->s_sibling;
1021

E
Eric W. Biederman 已提交
1022 1023 1024
		for ( ; pos; pos = pos->s_sibling) {
			const char * name;
			int len;
L
Linus Torvalds 已提交
1025

E
Eric W. Biederman 已提交
1026 1027 1028
			name = pos->s_name;
			len = strlen(name);
			filp->f_pos = ino = pos->s_ino;
L
Linus Torvalds 已提交
1029

E
Eric W. Biederman 已提交
1030 1031
			if (filldir(dirent, name, len, filp->f_pos, ino,
					 dt_type(pos)) < 0)
L
Linus Torvalds 已提交
1032 1033
				break;
		}
E
Eric W. Biederman 已提交
1034 1035
		if (!pos)
			filp->f_pos = INT_MAX;
1036
		mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1037
	}
E
Eric W. Biederman 已提交
1038
	return 0;
L
Linus Torvalds 已提交
1039 1040
}

E
Eric W. Biederman 已提交
1041

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