dir.c 26.3 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49
{
	struct sysfs_dirent *parent_sd = sd->s_parent;

	BUG_ON(sd->s_sibling);
	sd->s_sibling = parent_sd->s_children;
	parent_sd->s_children = sd;
}

/**
 *	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:
50
 *	mutex_lock(sysfs_mutex)
51
 */
52
static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
53 54 55 56 57 58 59 60 61 62 63 64
{
	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 已提交
65 66 67 68 69 70 71 72 73 74 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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
/**
 *	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;
		dentry = lookup_one_len_kern(cur->s_name, parent_dentry,
					     strlen(cur->s_name));
		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;
}

163 164 165 166 167 168 169 170 171 172 173 174
/**
 *	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)
{
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
	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();
192 193 194 195 196 197 198 199 200 201 202 203
	}
}

/**
 *	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)
{
204 205 206 207 208 209 210 211 212 213 214
	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
215
	 * sd->s_sibling.
216
	 */
217
	cmpl = (void *)sd->s_sibling;
218
	complete(cmpl);
219 220 221 222 223 224 225 226 227 228 229 230 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
}

/**
 *	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
 *
264
 *	Deny new active references and drain existing ones.
265
 */
266
static void sysfs_deactivate(struct sysfs_dirent *sd)
267
{
268 269
	DECLARE_COMPLETION_ONSTACK(wait);
	int v;
270

271
	BUG_ON(sd->s_sibling || !(sd->s_flags & SYSFS_FLAG_REMOVED));
272
	sd->s_sibling = (void *)&wait;
273 274

	/* atomic_add_return() is a mb(), put_active() will always see
275
	 * the updated sd->s_sibling.
276
	 */
277 278 279 280 281
	v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);

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

282
	sd->s_sibling = NULL;
283 284
}

T
Tejun Heo 已提交
285
static int sysfs_alloc_ino(ino_t *pino)
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
{
	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);
}

311 312
void release_sysfs_dirent(struct sysfs_dirent * sd)
{
T
Tejun Heo 已提交
313 314 315
	struct sysfs_dirent *parent_sd;

 repeat:
316 317 318
	/* Moving/renaming is always done while holding reference.
	 * sd->s_parent won't change beneath us.
	 */
T
Tejun Heo 已提交
319 320
	parent_sd = sd->s_parent;

321
	if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
322
		sysfs_put(sd->s_elem.symlink.target_sd);
323
	if (sysfs_type(sd) & SYSFS_COPY_NAME)
T
Tejun Heo 已提交
324
		kfree(sd->s_name);
325
	kfree(sd->s_iattr);
326
	sysfs_free_ino(sd->s_ino);
327
	kmem_cache_free(sysfs_dir_cachep, sd);
T
Tejun Heo 已提交
328 329 330 331

	sd = parent_sd;
	if (sd && atomic_dec_and_test(&sd->s_count))
		goto repeat;
332 333
}

L
Linus Torvalds 已提交
334 335 336 337 338
static void sysfs_d_iput(struct dentry * dentry, struct inode * inode)
{
	struct sysfs_dirent * sd = dentry->d_fsdata;

	if (sd) {
T
Tejun Heo 已提交
339 340
		/* sd->s_dentry is protected with sysfs_assoc_lock.
		 * This allows sysfs_drop_dentry() to dereference it.
341
		 */
T
Tejun Heo 已提交
342
		spin_lock(&sysfs_assoc_lock);
343 344 345 346 347 348 349 350

		/* 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 已提交
351
		spin_unlock(&sysfs_assoc_lock);
L
Linus Torvalds 已提交
352 353 354 355 356 357 358 359 360
		sysfs_put(sd);
	}
	iput(inode);
}

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

361
struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
L
Linus Torvalds 已提交
362
{
T
Tejun Heo 已提交
363
	char *dup_name = NULL;
364
	struct sysfs_dirent *sd;
T
Tejun Heo 已提交
365 366 367 368

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

372
	sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
L
Linus Torvalds 已提交
373
	if (!sd)
374
		goto err_out1;
L
Linus Torvalds 已提交
375

T
Tejun Heo 已提交
376
	if (sysfs_alloc_ino(&sd->s_ino))
377
		goto err_out2;
378

L
Linus Torvalds 已提交
379
	atomic_set(&sd->s_count, 1);
380
	atomic_set(&sd->s_active, 0);
381
	atomic_set(&sd->s_event, 1);
382

T
Tejun Heo 已提交
383
	sd->s_name = name;
384
	sd->s_mode = mode;
385
	sd->s_flags = type;
L
Linus Torvalds 已提交
386 387

	return sd;
T
Tejun Heo 已提交
388

389
 err_out2:
T
Tejun Heo 已提交
390
	kmem_cache_free(sysfs_dir_cachep, sd);
391 392
 err_out1:
	kfree(dup_name);
T
Tejun Heo 已提交
393
	return NULL;
L
Linus Torvalds 已提交
394 395
}

396 397 398 399 400 401 402 403 404 405 406
/**
 *	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)
 */
407 408 409 410 411 412
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 已提交
413
	spin_lock(&sysfs_assoc_lock);
414
	sd->s_dentry = dentry;
T
Tejun Heo 已提交
415
	spin_unlock(&sysfs_assoc_lock);
416 417 418 419

	d_rehash(dentry);
}

420 421 422 423 424 425
static int sysfs_ilookup_test(struct inode *inode, void *arg)
{
	struct sysfs_dirent *sd = arg;
	return inode->i_ino == sd->s_ino;
}

426
/**
427 428 429
 *	sysfs_addrm_start - prepare for sysfs_dirent add/remove
 *	@acxt: pointer to sysfs_addrm_cxt to be used
 *	@parent_sd: parent sysfs_dirent
430
 *
431 432 433 434 435
 *	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.
436 437
 *
 *	LOCKING:
438 439 440
 *	Kernel thread context (may sleep).  sysfs_mutex is locked on
 *	return.  i_mutex of parent inode is locked on return if
 *	available.
441
 */
442 443
void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
		       struct sysfs_dirent *parent_sd)
444
{
445
	struct inode *inode;
446

447 448 449 450 451 452 453 454 455 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 481 482 483 484 485 486 487 488 489 490 491 492 493
	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().
494 495 496 497
 *
 *	RETURNS:
 *	0 on success, -EEXIST if entry with the given name already
 *	exists.
498
 */
499
int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
500
{
501 502 503
	if (sysfs_find_dirent(acxt->parent_sd, sd->s_name))
		return -EEXIST;

504 505 506 507 508 509
	sd->s_parent = sysfs_get(acxt->parent_sd);

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

	acxt->cnt++;
510 511

	sysfs_link_sibling(sd);
512 513

	return 0;
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
}

/**
 *	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)
{
535 536 537
	BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);

	sysfs_unlink_sibling(sd);
538 539 540 541 542 543 544 545 546 547 548

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

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
/**
 *	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.
 *
 *	@sd->s_dentry which is protected with sysfs_assoc_lock points
 *	to the currently associated dentry but we're not holding a
 *	reference to it and racing with dput().  Grab dcache_lock and
 *	verify dentry before dropping it.  If @sd->s_dentry is NULL or
 *	dput() beats us, no need to bother.
 */
static void sysfs_drop_dentry(struct sysfs_dirent *sd)
{
	struct dentry *dentry = NULL;
	struct inode *inode;

	/* We're not holding a reference to ->s_dentry dentry but the
	 * field will stay valid as long as sysfs_assoc_lock is held.
	 */
	spin_lock(&sysfs_assoc_lock);
	spin_lock(&dcache_lock);

	/* drop dentry if it's there and dput() didn't kill it yet */
	if (sd->s_dentry && sd->s_dentry->d_inode) {
		dentry = dget_locked(sd->s_dentry);
		spin_lock(&dentry->d_lock);
		__d_drop(dentry);
		spin_unlock(&dentry->d_lock);
	}

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

585
	dput(dentry);
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601

	/* adjust nlink and update timestamp */
	inode = ilookup(sysfs_sb, sd->s_ino);
	if (inode) {
		mutex_lock(&inode->i_mutex);

		inode->i_ctime = CURRENT_TIME;
		drop_nlink(inode);
		if (sysfs_type(sd) == SYSFS_DIR)
			drop_nlink(inode);

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

602 603 604 605 606 607 608 609 610 611 612
/**
 *	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.
 */
613
void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
{
	/* 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 已提交
638
	}
639 640
}

641 642 643 644 645 646
/**
 *	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.
647
 *
648
 *	LOCKING:
649
 *	mutex_lock(sysfs_mutex)
650
 *
651 652
 *	RETURNS:
 *	Pointer to sysfs_dirent if found, NULL if not.
653
 */
654 655
struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
				       const unsigned char *name)
656
{
657 658 659 660 661 662 663
	struct sysfs_dirent *sd;

	for (sd = parent_sd->s_children; sd; sd = sd->s_sibling)
		if (sysfs_type(sd) && !strcmp(sd->s_name, name))
			return sd;
	return NULL;
}
664

665 666 667 668 669 670 671 672 673
/**
 *	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:
674
 *	Kernel thread context (may sleep).  Grabs sysfs_mutex.
675 676 677 678 679 680 681 682 683
 *
 *	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;

684
	mutex_lock(&sysfs_mutex);
685 686
	sd = sysfs_find_dirent(parent_sd, name);
	sysfs_get(sd);
687
	mutex_unlock(&sysfs_mutex);
688 689

	return sd;
690 691
}

692 693
static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
		      const char *name, struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
694 695
{
	umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
696
	struct sysfs_addrm_cxt acxt;
697
	struct sysfs_dirent *sd;
698
	int rc;
L
Linus Torvalds 已提交
699

700
	/* allocate */
701
	sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
702
	if (!sd)
703
		return -ENOMEM;
704
	sd->s_elem.dir.kobj = kobj;
705

706
	/* link in */
707
	sysfs_addrm_start(&acxt, parent_sd);
708 709
	rc = sysfs_add_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
710

711 712 713
	if (rc == 0)
		*p_sd = sd;
	else
714
		sysfs_put(sd);
715

716
	return rc;
L
Linus Torvalds 已提交
717 718
}

719 720
int sysfs_create_subdir(struct kobject *kobj, const char *name,
			struct sysfs_dirent **p_sd)
L
Linus Torvalds 已提交
721
{
722
	return create_dir(kobj, kobj->sd, name, p_sd);
L
Linus Torvalds 已提交
723 724 725 726 727 728
}

/**
 *	sysfs_create_dir - create a directory for an object.
 *	@kobj:		object we're creating directory for. 
 */
729
int sysfs_create_dir(struct kobject * kobj)
L
Linus Torvalds 已提交
730
{
731
	struct sysfs_dirent *parent_sd, *sd;
L
Linus Torvalds 已提交
732 733 734 735
	int error = 0;

	BUG_ON(!kobj);

736
	if (kobj->parent)
737
		parent_sd = kobj->parent->sd;
L
Linus Torvalds 已提交
738
	else if (sysfs_mount && sysfs_mount->mnt_sb)
739
		parent_sd = sysfs_mount->mnt_sb->s_root->d_fsdata;
L
Linus Torvalds 已提交
740 741 742
	else
		return -EFAULT;

743
	error = create_dir(kobj, parent_sd, kobject_name(kobj), &sd);
L
Linus Torvalds 已提交
744
	if (!error)
745
		kobj->sd = sd;
L
Linus Torvalds 已提交
746 747 748
	return error;
}

749 750 751 752 753 754 755 756 757 758 759
static int sysfs_count_nlink(struct sysfs_dirent *sd)
{
	struct sysfs_dirent *child;
	int nr = 0;

	for (child = sd->s_children; child; child = child->s_sibling)
		if (sysfs_type(child) == SYSFS_DIR)
			nr++;
	return nr + 2;
}

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

769 770
	mutex_lock(&sysfs_mutex);

771 772
	for (sd = parent_sd->s_children; sd; sd = sd->s_sibling)
		if (sysfs_type(sd) && !strcmp(sd->s_name, dentry->d_name.name))
L
Linus Torvalds 已提交
773 774
			break;

775
	/* no such entry */
776
	if (!sd)
777
		goto out_unlock;
778 779

	/* attach dentry and inode */
780
	inode = sysfs_get_inode(sd);
781 782 783 784
	if (!inode) {
		ret = ERR_PTR(-ENOMEM);
		goto out_unlock;
	}
785

786 787
	if (inode->i_state & I_NEW) {
		/* initialize inode according to type */
788
		switch (sysfs_type(sd)) {
789 790 791 792 793
		case SYSFS_DIR:
			inode->i_op = &sysfs_dir_inode_operations;
			inode->i_fop = &sysfs_dir_operations;
			inode->i_nlink = sysfs_count_nlink(sd);
			break;
794
		case SYSFS_KOBJ_ATTR:
795 796
			inode->i_size = PAGE_SIZE;
			inode->i_fop = &sysfs_file_operations;
797 798 799
			break;
		case SYSFS_KOBJ_BIN_ATTR:
			bin_attr = sd->s_elem.bin_attr.bin_attr;
800 801
			inode->i_size = bin_attr->size;
			inode->i_fop = &bin_fops;
802 803
			break;
		case SYSFS_KOBJ_LINK:
804
			inode->i_op = &sysfs_symlink_inode_operations;
805 806 807 808
			break;
		default:
			BUG();
		}
809
	}
810 811 812 813

	sysfs_instantiate(dentry, inode);
	sysfs_attach_dentry(sd, dentry);

814
 out_unlock:
815
	mutex_unlock(&sysfs_mutex);
816
	return ret;
L
Linus Torvalds 已提交
817 818
}

819
const struct inode_operations sysfs_dir_inode_operations = {
L
Linus Torvalds 已提交
820
	.lookup		= sysfs_lookup,
821
	.setattr	= sysfs_setattr,
L
Linus Torvalds 已提交
822 823
};

824
static void remove_dir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
825
{
826
	struct sysfs_addrm_cxt acxt;
L
Linus Torvalds 已提交
827

828 829 830
	sysfs_addrm_start(&acxt, sd->s_parent);
	sysfs_remove_one(&acxt, sd);
	sysfs_addrm_finish(&acxt);
L
Linus Torvalds 已提交
831 832
}

833
void sysfs_remove_subdir(struct sysfs_dirent *sd)
L
Linus Torvalds 已提交
834
{
835
	remove_dir(sd);
L
Linus Torvalds 已提交
836 837 838
}


839
static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
L
Linus Torvalds 已提交
840
{
841
	struct sysfs_addrm_cxt acxt;
842
	struct sysfs_dirent **pos;
L
Linus Torvalds 已提交
843

844
	if (!dir_sd)
L
Linus Torvalds 已提交
845 846
		return;

847
	pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
848
	sysfs_addrm_start(&acxt, dir_sd);
849
	pos = &dir_sd->s_children;
850 851 852
	while (*pos) {
		struct sysfs_dirent *sd = *pos;

853
		if (sysfs_type(sd) && sysfs_type(sd) != SYSFS_DIR)
854
			sysfs_remove_one(&acxt, sd);
855
		else
856
			pos = &(*pos)->s_sibling;
L
Linus Torvalds 已提交
857
	}
858
	sysfs_addrm_finish(&acxt);
859

860
	remove_dir(dir_sd);
861 862 863 864 865 866 867 868 869 870 871 872 873
}

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

T
Tejun Heo 已提交
876
	spin_lock(&sysfs_assoc_lock);
877
	kobj->sd = NULL;
T
Tejun Heo 已提交
878
	spin_unlock(&sysfs_assoc_lock);
879

880
	__sysfs_remove_dir(sd);
L
Linus Torvalds 已提交
881 882
}

883
int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
L
Linus Torvalds 已提交
884
{
885 886
	struct sysfs_dirent *sd;
	struct dentry *parent = NULL;
887 888
	struct dentry *old_dentry = NULL, *new_dentry = NULL;
	const char *dup_name = NULL;
889
	int error;
L
Linus Torvalds 已提交
890

T
Tejun Heo 已提交
891
	/* get the original dentry */
892
	sd = kobj->sd;
893 894 895 896 897 898
	old_dentry = sysfs_get_dentry(sd);
	if (IS_ERR(old_dentry)) {
		error = PTR_ERR(old_dentry);
		goto out_dput;
	}

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

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

904
	new_dentry = lookup_one_len(new_name, parent, strlen(new_name));
905 906 907
	if (IS_ERR(new_dentry)) {
		error = PTR_ERR(new_dentry);
		goto out_unlock;
L
Linus Torvalds 已提交
908
	}
909 910

	error = -EINVAL;
911
	if (old_dentry == new_dentry)
912
		goto out_unlock;
913 914 915

	error = -EEXIST;
	if (new_dentry->d_inode)
916
		goto out_unlock;
917

T
Tejun Heo 已提交
918 919 920 921 922 923
	/* rename kobject and sysfs_dirent */
	error = -ENOMEM;
	new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
	if (!new_name)
		goto out_drop;

924 925
	error = kobject_set_name(kobj, "%s", new_name);
	if (error)
926
		goto out_drop;
927

928
	mutex_lock(&sysfs_mutex);
929
	dup_name = sd->s_name;
T
Tejun Heo 已提交
930
	sd->s_name = new_name;
T
Tejun Heo 已提交
931
	mutex_unlock(&sysfs_mutex);
T
Tejun Heo 已提交
932

T
Tejun Heo 已提交
933
	/* rename */
934
	d_add(new_dentry, NULL);
935
	d_move(sd->s_dentry, new_dentry);
936 937 938 939 940 941 942

	error = 0;
	goto out_unlock;

 out_drop:
	d_drop(new_dentry);
 out_unlock:
943
	mutex_unlock(&parent->d_inode->i_mutex);
944 945 946 947
 out_dput:
	kfree(dup_name);
	dput(old_dentry);
	dput(new_dentry);
L
Linus Torvalds 已提交
948 949 950
	return error;
}

951
int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
952
{
953 954 955 956
	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;
957 958
	int error;

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
	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;
	}
975

976 977 978 979
	if (old_parent->d_inode == new_parent->d_inode) {
		error = 0;
		goto out_dput;	/* nothing to move */
	}
980
again:
981 982 983
	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);
984 985 986
		goto again;
	}

987
	new_dentry = lookup_one_len(kobject_name(kobj), new_parent, strlen(kobject_name(kobj)));
988 989
	if (IS_ERR(new_dentry)) {
		error = PTR_ERR(new_dentry);
990
		goto out_unlock;
991 992 993
	} else
		error = 0;
	d_add(new_dentry, NULL);
994
	d_move(sd->s_dentry, new_dentry);
995 996 997
	dput(new_dentry);

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

1000
	sysfs_unlink_sibling(sd);
1001 1002 1003
	sysfs_get(new_parent_sd);
	sysfs_put(sd->s_parent);
	sd->s_parent = new_parent_sd;
1004
	sysfs_link_sibling(sd);
1005

1006
	mutex_unlock(&sysfs_mutex);
1007

1008 1009 1010 1011 1012 1013 1014
 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);
1015 1016 1017
	return error;
}

L
Linus Torvalds 已提交
1018 1019
static int sysfs_dir_open(struct inode *inode, struct file *file)
{
1020
	struct dentry * dentry = file->f_path.dentry;
L
Linus Torvalds 已提交
1021
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
1022
	struct sysfs_dirent * sd;
L
Linus Torvalds 已提交
1023

1024
	sd = sysfs_new_dirent("_DIR_", 0, 0);
1025 1026
	if (sd) {
		mutex_lock(&sysfs_mutex);
1027 1028
		sd->s_parent = sysfs_get(parent_sd);
		sysfs_link_sibling(sd);
1029 1030
		mutex_unlock(&sysfs_mutex);
	}
L
Linus Torvalds 已提交
1031

1032 1033
	file->private_data = sd;
	return sd ? 0 : -ENOMEM;
L
Linus Torvalds 已提交
1034 1035 1036 1037 1038 1039
}

static int sysfs_dir_close(struct inode *inode, struct file *file)
{
	struct sysfs_dirent * cursor = file->private_data;

1040
	mutex_lock(&sysfs_mutex);
1041
	sysfs_unlink_sibling(cursor);
1042
	mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

	release_sysfs_dirent(cursor);

	return 0;
}

/* 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)
{
1057
	struct dentry *dentry = filp->f_path.dentry;
L
Linus Torvalds 已提交
1058 1059
	struct sysfs_dirent * parent_sd = dentry->d_fsdata;
	struct sysfs_dirent *cursor = filp->private_data;
1060
	struct sysfs_dirent **pos;
L
Linus Torvalds 已提交
1061 1062 1063 1064 1065
	ino_t ino;
	int i = filp->f_pos;

	switch (i) {
		case 0:
1066
			ino = parent_sd->s_ino;
L
Linus Torvalds 已提交
1067 1068 1069 1070 1071 1072
			if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
				break;
			filp->f_pos++;
			i++;
			/* fallthrough */
		case 1:
T
Tejun Heo 已提交
1073 1074 1075 1076
			if (parent_sd->s_parent)
				ino = parent_sd->s_parent->s_ino;
			else
				ino = parent_sd->s_ino;
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082
			if (filldir(dirent, "..", 2, i, ino, DT_DIR) < 0)
				break;
			filp->f_pos++;
			i++;
			/* fallthrough */
		default:
1083 1084
			mutex_lock(&sysfs_mutex);

1085 1086 1087 1088 1089 1090 1091
			pos = &parent_sd->s_children;
			while (*pos != cursor)
				pos = &(*pos)->s_sibling;

			/* unlink cursor */
			*pos = cursor->s_sibling;

A
Akinobu Mita 已提交
1092
			if (filp->f_pos == 2)
1093
				pos = &parent_sd->s_children;
A
Akinobu Mita 已提交
1094

1095 1096
			for ( ; *pos; pos = &(*pos)->s_sibling) {
				struct sysfs_dirent *next = *pos;
L
Linus Torvalds 已提交
1097 1098 1099
				const char * name;
				int len;

1100
				if (!sysfs_type(next))
L
Linus Torvalds 已提交
1101 1102
					continue;

T
Tejun Heo 已提交
1103
				name = next->s_name;
L
Linus Torvalds 已提交
1104
				len = strlen(name);
1105
				ino = next->s_ino;
L
Linus Torvalds 已提交
1106 1107 1108

				if (filldir(dirent, name, len, filp->f_pos, ino,
						 dt_type(next)) < 0)
1109
					break;
L
Linus Torvalds 已提交
1110 1111 1112

				filp->f_pos++;
			}
1113 1114 1115 1116

			/* put cursor back in */
			cursor->s_sibling = *pos;
			*pos = cursor;
1117 1118

			mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1119 1120 1121 1122 1123 1124
	}
	return 0;
}

static loff_t sysfs_dir_lseek(struct file * file, loff_t offset, int origin)
{
1125
	struct dentry * dentry = file->f_path.dentry;
L
Linus Torvalds 已提交
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136

	switch (origin) {
		case 1:
			offset += file->f_pos;
		case 0:
			if (offset >= 0)
				break;
		default:
			return -EINVAL;
	}
	if (offset != file->f_pos) {
1137 1138
		mutex_lock(&sysfs_mutex);

L
Linus Torvalds 已提交
1139 1140 1141 1142
		file->f_pos = offset;
		if (file->f_pos >= 2) {
			struct sysfs_dirent *sd = dentry->d_fsdata;
			struct sysfs_dirent *cursor = file->private_data;
1143
			struct sysfs_dirent **pos;
L
Linus Torvalds 已提交
1144 1145
			loff_t n = file->f_pos - 2;

1146 1147 1148 1149 1150
			sysfs_unlink_sibling(cursor);

			pos = &sd->s_children;
			while (n && *pos) {
				struct sysfs_dirent *next = *pos;
1151
				if (sysfs_type(next))
L
Linus Torvalds 已提交
1152
					n--;
1153
				pos = &(*pos)->s_sibling;
L
Linus Torvalds 已提交
1154
			}
1155 1156 1157

			cursor->s_sibling = *pos;
			*pos = cursor;
L
Linus Torvalds 已提交
1158
		}
1159 1160

		mutex_unlock(&sysfs_mutex);
L
Linus Torvalds 已提交
1161
	}
1162

L
Linus Torvalds 已提交
1163 1164 1165
	return offset;
}

1166
const struct file_operations sysfs_dir_operations = {
L
Linus Torvalds 已提交
1167 1168 1169 1170 1171 1172
	.open		= sysfs_dir_open,
	.release	= sysfs_dir_close,
	.llseek		= sysfs_dir_lseek,
	.read		= generic_read_dir,
	.readdir	= sysfs_readdir,
};