dcache.c 90.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * fs/dcache.c
 *
 * Complete reimplementation
 * (C) 1997 Thomas Schoebel-Theuer,
 * with heavy changes by Linus Torvalds
 */

/*
 * Notes on the allocation strategy:
 *
 * The dcache is a master of the icache - whenever a dcache entry
 * exists, the inode will always exist. "iput()" is done either when
 * the dcache entry is deleted or garbage collected.
 */

#include <linux/syscalls.h>
#include <linux/string.h>
#include <linux/mm.h>
#include <linux/fs.h>
21
#include <linux/fsnotify.h>
L
Linus Torvalds 已提交
22 23 24 25
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/hash.h>
#include <linux/cache.h>
26
#include <linux/export.h>
L
Linus Torvalds 已提交
27 28 29 30 31 32 33
#include <linux/mount.h>
#include <linux/file.h>
#include <asm/uaccess.h>
#include <linux/security.h>
#include <linux/seqlock.h>
#include <linux/swap.h>
#include <linux/bootmem.h>
34
#include <linux/fs_struct.h>
35
#include <linux/hardirq.h>
36 37
#include <linux/bit_spinlock.h>
#include <linux/rculist_bl.h>
38
#include <linux/prefetch.h>
39
#include <linux/ratelimit.h>
40
#include <linux/list_lru.h>
41 42
#include <linux/kasan.h>

43
#include "internal.h"
44
#include "mount.h"
L
Linus Torvalds 已提交
45

N
Nick Piggin 已提交
46 47
/*
 * Usage:
48
 * dcache->d_inode->i_lock protects:
49
 *   - i_dentry, d_u.d_alias, d_inode of aliases
50 51 52 53
 * dcache_hash_bucket lock protects:
 *   - the dcache hash table
 * s_anon bl list spinlock protects:
 *   - the s_anon list (see __d_drop)
D
Dave Chinner 已提交
54
 * dentry->d_sb->s_dentry_lru_lock protects:
N
Nick Piggin 已提交
55 56 57 58 59
 *   - the dcache lru lists and counters
 * d_lock protects:
 *   - d_flags
 *   - d_name
 *   - d_lru
N
Nick Piggin 已提交
60
 *   - d_count
N
Nick Piggin 已提交
61
 *   - d_unhashed()
N
Nick Piggin 已提交
62 63
 *   - d_parent and d_subdirs
 *   - childrens' d_child and d_parent
64
 *   - d_u.d_alias, d_inode
N
Nick Piggin 已提交
65 66
 *
 * Ordering:
67
 * dentry->d_inode->i_lock
N
Nick Piggin 已提交
68
 *   dentry->d_lock
D
Dave Chinner 已提交
69
 *     dentry->d_sb->s_dentry_lru_lock
70 71
 *     dcache_hash_bucket lock
 *     s_anon lock
N
Nick Piggin 已提交
72
 *
N
Nick Piggin 已提交
73 74 75 76 77 78 79
 * If there is an ancestor relationship:
 * dentry->d_parent->...->d_parent->d_lock
 *   ...
 *     dentry->d_parent->d_lock
 *       dentry->d_lock
 *
 * If no ancestor relationship:
N
Nick Piggin 已提交
80 81 82 83
 * if (dentry1 < dentry2)
 *   dentry1->d_lock
 *     dentry2->d_lock
 */
84
int sysctl_vfs_cache_pressure __read_mostly = 100;
L
Linus Torvalds 已提交
85 86
EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);

A
Al Viro 已提交
87
__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
L
Linus Torvalds 已提交
88

89
EXPORT_SYMBOL(rename_lock);
L
Linus Torvalds 已提交
90

91
static struct kmem_cache *dentry_cache __read_mostly;
L
Linus Torvalds 已提交
92 93 94 95 96 97 98 99 100 101

/*
 * This is the single most critical data structure when it comes
 * to the dcache: the hashtable for lookups. Somebody should try
 * to make this good - I've just made it work.
 *
 * This hash-function tries to avoid losing too many bits of hash
 * information, yet avoid using a prime hash-size or similar.
 */

102 103
static unsigned int d_hash_mask __read_mostly;
static unsigned int d_hash_shift __read_mostly;
104

105
static struct hlist_bl_head *dentry_hashtable __read_mostly;
106

107
static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
108
					unsigned int hash)
109
{
110
	hash += (unsigned long) parent / L1_CACHE_BYTES;
111
	return dentry_hashtable + hash_32(hash, d_hash_shift);
112 113
}

L
Linus Torvalds 已提交
114 115 116 117 118
/* Statistics gathering. */
struct dentry_stat_t dentry_stat = {
	.age_limit = 45,
};

119
static DEFINE_PER_CPU(long, nr_dentry);
120
static DEFINE_PER_CPU(long, nr_dentry_unused);
121 122

#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
123 124 125 126 127 128 129 130 131 132 133 134 135

/*
 * Here we resort to our own counters instead of using generic per-cpu counters
 * for consistency with what the vfs inode code does. We are expected to harvest
 * better code and performance by having our own specialized counters.
 *
 * Please note that the loop is done over all possible CPUs, not over all online
 * CPUs. The reason for this is that we don't want to play games with CPUs going
 * on and off. If one of them goes off, we will just keep their counters.
 *
 * glommer: See cffbc8a for details, and if you ever intend to change this,
 * please update all vfs counters to match.
 */
136
static long get_nr_dentry(void)
137 138
{
	int i;
139
	long sum = 0;
140 141 142 143 144
	for_each_possible_cpu(i)
		sum += per_cpu(nr_dentry, i);
	return sum < 0 ? 0 : sum;
}

145 146 147 148 149 150 151 152 153
static long get_nr_dentry_unused(void)
{
	int i;
	long sum = 0;
	for_each_possible_cpu(i)
		sum += per_cpu(nr_dentry_unused, i);
	return sum < 0 ? 0 : sum;
}

154
int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
155 156
		   size_t *lenp, loff_t *ppos)
{
157
	dentry_stat.nr_dentry = get_nr_dentry();
158
	dentry_stat.nr_unused = get_nr_dentry_unused();
159
	return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
160 161 162
}
#endif

163 164 165 166
/*
 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
 * The strings are both count bytes long, and count is non-zero.
 */
167 168 169 170 171 172 173 174 175 176 177 178
#ifdef CONFIG_DCACHE_WORD_ACCESS

#include <asm/word-at-a-time.h>
/*
 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
 * aligned allocation for this particular component. We don't
 * strictly need the load_unaligned_zeropad() safety, but it
 * doesn't hurt either.
 *
 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
 * need the careful unaligned handling.
 */
179
static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
180
{
181 182 183
	unsigned long a,b,mask;

	for (;;) {
184
		a = *(unsigned long *)cs;
185
		b = load_unaligned_zeropad(ct);
186 187 188 189 190 191 192 193 194 195
		if (tcount < sizeof(unsigned long))
			break;
		if (unlikely(a != b))
			return 1;
		cs += sizeof(unsigned long);
		ct += sizeof(unsigned long);
		tcount -= sizeof(unsigned long);
		if (!tcount)
			return 0;
	}
196
	mask = bytemask_from_count(tcount);
197
	return unlikely(!!((a ^ b) & mask));
198 199
}

200
#else
201

202
static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
203
{
204 205 206 207 208 209 210 211 212 213
	do {
		if (*cs != *ct)
			return 1;
		cs++;
		ct++;
		tcount--;
	} while (tcount);
	return 0;
}

214 215
#endif

216 217
static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
{
218
	const unsigned char *cs;
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
	/*
	 * Be careful about RCU walk racing with rename:
	 * use ACCESS_ONCE to fetch the name pointer.
	 *
	 * NOTE! Even if a rename will mean that the length
	 * was not loaded atomically, we don't care. The
	 * RCU walk will check the sequence count eventually,
	 * and catch it. And we won't overrun the buffer,
	 * because we're reading the name pointer atomically,
	 * and a dentry name is guaranteed to be properly
	 * terminated with a NUL byte.
	 *
	 * End result: even if 'len' is wrong, we'll exit
	 * early because the data cannot match (there can
	 * be no NUL in the ct/tcount data)
	 */
235 236 237
	cs = ACCESS_ONCE(dentry->d_name.name);
	smp_read_barrier_depends();
	return dentry_string_cmp(cs, ct, tcount);
238 239
}

240 241 242 243 244 245 246 247 248 249 250 251 252
struct external_name {
	union {
		atomic_t count;
		struct rcu_head head;
	} u;
	unsigned char name[];
};

static inline struct external_name *external_name(struct dentry *dentry)
{
	return container_of(dentry->d_name.name, struct external_name, name[0]);
}

C
Christoph Hellwig 已提交
253
static void __d_free(struct rcu_head *head)
L
Linus Torvalds 已提交
254
{
C
Christoph Hellwig 已提交
255 256
	struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);

257 258 259 260 261 262 263
	kmem_cache_free(dentry_cache, dentry); 
}

static void __d_free_external(struct rcu_head *head)
{
	struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
	kfree(external_name(dentry));
L
Linus Torvalds 已提交
264 265 266
	kmem_cache_free(dentry_cache, dentry); 
}

A
Al Viro 已提交
267 268 269 270 271
static inline int dname_external(const struct dentry *dentry)
{
	return dentry->d_name.name != dentry->d_iname;
}

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
static inline void __d_set_inode_and_type(struct dentry *dentry,
					  struct inode *inode,
					  unsigned type_flags)
{
	unsigned flags;

	dentry->d_inode = inode;
	flags = READ_ONCE(dentry->d_flags);
	flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
	flags |= type_flags;
	WRITE_ONCE(dentry->d_flags, flags);
}

static inline void __d_clear_type_and_inode(struct dentry *dentry)
{
	unsigned flags = READ_ONCE(dentry->d_flags);

	flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
	WRITE_ONCE(dentry->d_flags, flags);
	dentry->d_inode = NULL;
}

A
Al Viro 已提交
294 295
static void dentry_free(struct dentry *dentry)
{
296
	WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
297 298 299 300 301 302 303
	if (unlikely(dname_external(dentry))) {
		struct external_name *p = external_name(dentry);
		if (likely(atomic_dec_and_test(&p->u.count))) {
			call_rcu(&dentry->d_u.d_rcu, __d_free_external);
			return;
		}
	}
A
Al Viro 已提交
304 305 306 307 308 309 310
	/* if dentry was never visible to RCU, immediate free is OK */
	if (!(dentry->d_flags & DCACHE_RCUACCESS))
		__d_free(&dentry->d_u.d_rcu);
	else
		call_rcu(&dentry->d_u.d_rcu, __d_free);
}

N
Nick Piggin 已提交
311
/**
312
 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
313
 * @dentry: the target dentry
N
Nick Piggin 已提交
314 315 316 317
 * After this call, in-progress rcu-walk path lookup will fail. This
 * should be called after unhashing, and after changing d_inode (if
 * the dentry has not already been unhashed).
 */
318
static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
N
Nick Piggin 已提交
319
{
320 321 322
	lockdep_assert_held(&dentry->d_lock);
	/* Go through am invalidation barrier */
	write_seqcount_invalidate(&dentry->d_seq);
N
Nick Piggin 已提交
323 324
}

L
Linus Torvalds 已提交
325 326
/*
 * Release the dentry's inode, using the filesystem
N
Nick Piggin 已提交
327 328
 * d_iput() operation if defined. Dentry has no refcount
 * and is unhashed.
L
Linus Torvalds 已提交
329
 */
330
static void dentry_iput(struct dentry * dentry)
331
	__releases(dentry->d_lock)
332
	__releases(dentry->d_inode->i_lock)
L
Linus Torvalds 已提交
333 334 335
{
	struct inode *inode = dentry->d_inode;
	if (inode) {
336
		__d_clear_type_and_inode(dentry);
337
		hlist_del_init(&dentry->d_u.d_alias);
L
Linus Torvalds 已提交
338
		spin_unlock(&dentry->d_lock);
339
		spin_unlock(&inode->i_lock);
340 341
		if (!inode->i_nlink)
			fsnotify_inoderemove(inode);
L
Linus Torvalds 已提交
342 343 344 345 346 347 348 349 350
		if (dentry->d_op && dentry->d_op->d_iput)
			dentry->d_op->d_iput(dentry, inode);
		else
			iput(inode);
	} else {
		spin_unlock(&dentry->d_lock);
	}
}

N
Nick Piggin 已提交
351 352 353 354 355 356
/*
 * Release the dentry's inode, using the filesystem
 * d_iput() operation if defined. dentry remains in-use.
 */
static void dentry_unlink_inode(struct dentry * dentry)
	__releases(dentry->d_lock)
357
	__releases(dentry->d_inode->i_lock)
N
Nick Piggin 已提交
358 359
{
	struct inode *inode = dentry->d_inode;
360 361

	raw_write_seqcount_begin(&dentry->d_seq);
362
	__d_clear_type_and_inode(dentry);
363
	hlist_del_init(&dentry->d_u.d_alias);
364
	raw_write_seqcount_end(&dentry->d_seq);
N
Nick Piggin 已提交
365
	spin_unlock(&dentry->d_lock);
366
	spin_unlock(&inode->i_lock);
N
Nick Piggin 已提交
367 368 369 370 371 372 373 374
	if (!inode->i_nlink)
		fsnotify_inoderemove(inode);
	if (dentry->d_op && dentry->d_op->d_iput)
		dentry->d_op->d_iput(dentry, inode);
	else
		iput(inode);
}

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/*
 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
 * is in use - which includes both the "real" per-superblock
 * LRU list _and_ the DCACHE_SHRINK_LIST use.
 *
 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
 * on the shrink list (ie not on the superblock LRU list).
 *
 * The per-cpu "nr_dentry_unused" counters are updated with
 * the DCACHE_LRU_LIST bit.
 *
 * These helper functions make sure we always follow the
 * rules. d_lock must be held by the caller.
 */
#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
static void d_lru_add(struct dentry *dentry)
{
	D_FLAG_VERIFY(dentry, 0);
	dentry->d_flags |= DCACHE_LRU_LIST;
	this_cpu_inc(nr_dentry_unused);
	WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
}

static void d_lru_del(struct dentry *dentry)
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags &= ~DCACHE_LRU_LIST;
	this_cpu_dec(nr_dentry_unused);
	WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
}

static void d_shrink_del(struct dentry *dentry)
{
	D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
	list_del_init(&dentry->d_lru);
	dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
	this_cpu_dec(nr_dentry_unused);
}

static void d_shrink_add(struct dentry *dentry, struct list_head *list)
{
	D_FLAG_VERIFY(dentry, 0);
	list_add(&dentry->d_lru, list);
	dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
	this_cpu_inc(nr_dentry_unused);
}

/*
 * These can only be called under the global LRU lock, ie during the
 * callback for freeing the LRU list. "isolate" removes it from the
 * LRU lists entirely, while shrink_move moves it to the indicated
 * private list.
 */
428
static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
429 430 431 432
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags &= ~DCACHE_LRU_LIST;
	this_cpu_dec(nr_dentry_unused);
433
	list_lru_isolate(lru, &dentry->d_lru);
434 435
}

436 437
static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
			      struct list_head *list)
438 439 440
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags |= DCACHE_SHRINK_LIST;
441
	list_lru_isolate_move(lru, &dentry->d_lru, list);
442 443
}

444
/*
445
 * dentry_lru_(add|del)_list) must be called with d_lock held.
446 447 448
 */
static void dentry_lru_add(struct dentry *dentry)
{
449 450
	if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
		d_lru_add(dentry);
451 452
}

N
Nick Piggin 已提交
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
/**
 * d_drop - drop a dentry
 * @dentry: dentry to drop
 *
 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
 * be found through a VFS lookup any more. Note that this is different from
 * deleting the dentry - d_delete will try to mark the dentry negative if
 * possible, giving a successful _negative_ lookup, while d_drop will
 * just make the cache lookup fail.
 *
 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
 * reason (NFS timeouts or autofs deletes).
 *
 * __d_drop requires dentry->d_lock.
 */
void __d_drop(struct dentry *dentry)
{
470
	if (!d_unhashed(dentry)) {
471
		struct hlist_bl_head *b;
472 473 474 475 476 477
		/*
		 * Hashed dentries are normally on the dentry hashtable,
		 * with the exception of those newly allocated by
		 * d_obtain_alias, which are always IS_ROOT:
		 */
		if (unlikely(IS_ROOT(dentry)))
478 479 480 481 482 483 484 485
			b = &dentry->d_sb->s_anon;
		else
			b = d_hash(dentry->d_parent, dentry->d_name.hash);

		hlist_bl_lock(b);
		__hlist_bl_del(&dentry->d_hash);
		dentry->d_hash.pprev = NULL;
		hlist_bl_unlock(b);
486
		dentry_rcuwalk_invalidate(dentry);
N
Nick Piggin 已提交
487 488 489 490 491 492 493 494 495 496 497 498
	}
}
EXPORT_SYMBOL(__d_drop);

void d_drop(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__d_drop(dentry);
	spin_unlock(&dentry->d_lock);
}
EXPORT_SYMBOL(d_drop);

A
Al Viro 已提交
499
static void __dentry_kill(struct dentry *dentry)
500
{
501 502 503
	struct dentry *parent = NULL;
	bool can_free = true;
	if (!IS_ROOT(dentry))
504
		parent = dentry->d_parent;
N
Nick Piggin 已提交
505

506 507 508 509 510
	/*
	 * The dentry is now unrecoverably dead to the world.
	 */
	lockref_mark_dead(&dentry->d_lockref);

S
Sage Weil 已提交
511 512 513 514
	/*
	 * inform the fs via d_prune that this dentry is about to be
	 * unhashed and destroyed.
	 */
515
	if (dentry->d_flags & DCACHE_OP_PRUNE)
Y
Yan, Zheng 已提交
516 517
		dentry->d_op->d_prune(dentry);

518 519 520 521
	if (dentry->d_flags & DCACHE_LRU_LIST) {
		if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
			d_lru_del(dentry);
	}
522 523
	/* if it was on the hash then remove it */
	__d_drop(dentry);
A
Al Viro 已提交
524
	__list_del_entry(&dentry->d_child);
A
Al Viro 已提交
525 526 527 528 529 530 531 532 533 534 535 536
	/*
	 * Inform d_walk() that we are no longer attached to the
	 * dentry tree
	 */
	dentry->d_flags |= DCACHE_DENTRY_KILLED;
	if (parent)
		spin_unlock(&parent->d_lock);
	dentry_iput(dentry);
	/*
	 * dentry_iput drops the locks, at which point nobody (except
	 * transient RCU lookups) can reach this dentry.
	 */
537
	BUG_ON(dentry->d_lockref.count > 0);
A
Al Viro 已提交
538 539 540 541
	this_cpu_dec(nr_dentry);
	if (dentry->d_op && dentry->d_op->d_release)
		dentry->d_op->d_release(dentry);

542 543 544 545 546 547 548 549
	spin_lock(&dentry->d_lock);
	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
		dentry->d_flags |= DCACHE_MAY_FREE;
		can_free = false;
	}
	spin_unlock(&dentry->d_lock);
	if (likely(can_free))
		dentry_free(dentry);
A
Al Viro 已提交
550 551 552 553 554 555 556 557
}

/*
 * Finish off a dentry we've decided to kill.
 * dentry->d_lock must be held, returns with it unlocked.
 * If ref is non-zero, then decrement the refcount too.
 * Returns dentry requiring refcount drop, or NULL if we're done.
 */
558
static struct dentry *dentry_kill(struct dentry *dentry)
A
Al Viro 已提交
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
	__releases(dentry->d_lock)
{
	struct inode *inode = dentry->d_inode;
	struct dentry *parent = NULL;

	if (inode && unlikely(!spin_trylock(&inode->i_lock)))
		goto failed;

	if (!IS_ROOT(dentry)) {
		parent = dentry->d_parent;
		if (unlikely(!spin_trylock(&parent->d_lock))) {
			if (inode)
				spin_unlock(&inode->i_lock);
			goto failed;
		}
	}

	__dentry_kill(dentry);
A
Al Viro 已提交
577
	return parent;
A
Al Viro 已提交
578 579

failed:
580 581
	spin_unlock(&dentry->d_lock);
	cpu_relax();
A
Al Viro 已提交
582
	return dentry; /* try again with same dentry */
583 584
}

585 586 587 588 589
static inline struct dentry *lock_parent(struct dentry *dentry)
{
	struct dentry *parent = dentry->d_parent;
	if (IS_ROOT(dentry))
		return NULL;
590
	if (unlikely(dentry->d_lockref.count < 0))
591
		return NULL;
592 593 594
	if (likely(spin_trylock(&parent->d_lock)))
		return parent;
	rcu_read_lock();
595
	spin_unlock(&dentry->d_lock);
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
again:
	parent = ACCESS_ONCE(dentry->d_parent);
	spin_lock(&parent->d_lock);
	/*
	 * We can't blindly lock dentry until we are sure
	 * that we won't violate the locking order.
	 * Any changes of dentry->d_parent must have
	 * been done with parent->d_lock held, so
	 * spin_lock() above is enough of a barrier
	 * for checking if it's still our child.
	 */
	if (unlikely(parent != dentry->d_parent)) {
		spin_unlock(&parent->d_lock);
		goto again;
	}
	rcu_read_unlock();
	if (parent != dentry)
613
		spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
614 615 616 617 618
	else
		parent = NULL;
	return parent;
}

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
/*
 * Try to do a lockless dput(), and return whether that was successful.
 *
 * If unsuccessful, we return false, having already taken the dentry lock.
 *
 * The caller needs to hold the RCU read lock, so that the dentry is
 * guaranteed to stay around even if the refcount goes down to zero!
 */
static inline bool fast_dput(struct dentry *dentry)
{
	int ret;
	unsigned int d_flags;

	/*
	 * If we have a d_op->d_delete() operation, we sould not
634
	 * let the dentry count go to zero, so use "put_or_lock".
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
	 */
	if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
		return lockref_put_or_lock(&dentry->d_lockref);

	/*
	 * .. otherwise, we can try to just decrement the
	 * lockref optimistically.
	 */
	ret = lockref_put_return(&dentry->d_lockref);

	/*
	 * If the lockref_put_return() failed due to the lock being held
	 * by somebody else, the fast path has failed. We will need to
	 * get the lock, and then check the count again.
	 */
	if (unlikely(ret < 0)) {
		spin_lock(&dentry->d_lock);
		if (dentry->d_lockref.count > 1) {
			dentry->d_lockref.count--;
			spin_unlock(&dentry->d_lock);
			return 1;
		}
		return 0;
	}

	/*
	 * If we weren't the last ref, we're done.
	 */
	if (ret)
		return 1;

	/*
	 * Careful, careful. The reference count went down
	 * to zero, but we don't hold the dentry lock, so
	 * somebody else could get it again, and do another
	 * dput(), and we need to not race with that.
	 *
	 * However, there is a very special and common case
	 * where we don't care, because there is nothing to
	 * do: the dentry is still hashed, it does not have
	 * a 'delete' op, and it's referenced and already on
	 * the LRU list.
	 *
	 * NOTE! Since we aren't locked, these values are
	 * not "stable". However, it is sufficient that at
	 * some point after we dropped the reference the
	 * dentry was hashed and the flags had the proper
	 * value. Other dentry users may have re-gotten
	 * a reference to the dentry and change that, but
	 * our work is done - we can leave the dentry
	 * around with a zero refcount.
	 */
	smp_rmb();
	d_flags = ACCESS_ONCE(dentry->d_flags);
689
	d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722

	/* Nothing to do? Dropping the reference was all we needed? */
	if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
		return 1;

	/*
	 * Not the fast normal case? Get the lock. We've already decremented
	 * the refcount, but we'll need to re-check the situation after
	 * getting the lock.
	 */
	spin_lock(&dentry->d_lock);

	/*
	 * Did somebody else grab a reference to it in the meantime, and
	 * we're no longer the last user after all? Alternatively, somebody
	 * else could have killed it and marked it dead. Either way, we
	 * don't need to do anything else.
	 */
	if (dentry->d_lockref.count) {
		spin_unlock(&dentry->d_lock);
		return 1;
	}

	/*
	 * Re-get the reference we optimistically dropped. We hold the
	 * lock, and we just tested that it was zero, so we can just
	 * set it to 1.
	 */
	dentry->d_lockref.count = 1;
	return 0;
}


L
Linus Torvalds 已提交
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
/* 
 * This is dput
 *
 * This is complicated by the fact that we do not want to put
 * dentries that are no longer on any hash chain on the unused
 * list: we'd much rather just get rid of them immediately.
 *
 * However, that implies that we have to traverse the dentry
 * tree upwards to the parents which might _also_ now be
 * scheduled for deletion (it may have been only waiting for
 * its last child to go away).
 *
 * This tail recursion is done by hand as we don't want to depend
 * on the compiler to always get this right (gcc generally doesn't).
 * Real recursion would eat up our stack space.
 */

/*
 * dput - release a dentry
 * @dentry: dentry to release 
 *
 * Release a dentry. This will drop the usage count and if appropriate
 * call the dentry unlink method as well as removing it from the queues and
 * releasing its resources. If the parent dentries were scheduled for release
 * they too may now get deleted.
 */
void dput(struct dentry *dentry)
{
751
	if (unlikely(!dentry))
L
Linus Torvalds 已提交
752 753 754
		return;

repeat:
755 756 757
	rcu_read_lock();
	if (likely(fast_dput(dentry))) {
		rcu_read_unlock();
L
Linus Torvalds 已提交
758
		return;
759 760 761 762
	}

	/* Slow case: now with the dentry lock held */
	rcu_read_unlock();
L
Linus Torvalds 已提交
763

764 765
	WARN_ON(d_in_lookup(dentry));

766 767 768 769
	/* Unreachable? Get rid of it */
	if (unlikely(d_unhashed(dentry)))
		goto kill_it;

770 771 772
	if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
		goto kill_it;

773
	if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
L
Linus Torvalds 已提交
774
		if (dentry->d_op->d_delete(dentry))
N
Nick Piggin 已提交
775
			goto kill_it;
L
Linus Torvalds 已提交
776
	}
N
Nick Piggin 已提交
777

778 779
	if (!(dentry->d_flags & DCACHE_REFERENCED))
		dentry->d_flags |= DCACHE_REFERENCED;
780
	dentry_lru_add(dentry);
N
Nick Piggin 已提交
781

782
	dentry->d_lockref.count--;
N
Nick Piggin 已提交
783
	spin_unlock(&dentry->d_lock);
L
Linus Torvalds 已提交
784 785
	return;

786
kill_it:
787
	dentry = dentry_kill(dentry);
788 789
	if (dentry)
		goto repeat;
L
Linus Torvalds 已提交
790
}
791
EXPORT_SYMBOL(dput);
L
Linus Torvalds 已提交
792 793


N
Nick Piggin 已提交
794
/* This must be called with d_lock held */
795
static inline void __dget_dlock(struct dentry *dentry)
N
Nick Piggin 已提交
796
{
797
	dentry->d_lockref.count++;
N
Nick Piggin 已提交
798 799
}

800
static inline void __dget(struct dentry *dentry)
L
Linus Torvalds 已提交
801
{
802
	lockref_get(&dentry->d_lockref);
L
Linus Torvalds 已提交
803 804
}

N
Nick Piggin 已提交
805 806
struct dentry *dget_parent(struct dentry *dentry)
{
807
	int gotref;
N
Nick Piggin 已提交
808 809
	struct dentry *ret;

810 811 812 813 814 815 816 817 818 819 820 821 822 823
	/*
	 * Do optimistic parent lookup without any
	 * locking.
	 */
	rcu_read_lock();
	ret = ACCESS_ONCE(dentry->d_parent);
	gotref = lockref_get_not_zero(&ret->d_lockref);
	rcu_read_unlock();
	if (likely(gotref)) {
		if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
			return ret;
		dput(ret);
	}

N
Nick Piggin 已提交
824
repeat:
N
Nick Piggin 已提交
825 826 827 828 829
	/*
	 * Don't need rcu_dereference because we re-check it was correct under
	 * the lock.
	 */
	rcu_read_lock();
N
Nick Piggin 已提交
830
	ret = dentry->d_parent;
N
Nick Piggin 已提交
831 832 833 834
	spin_lock(&ret->d_lock);
	if (unlikely(ret != dentry->d_parent)) {
		spin_unlock(&ret->d_lock);
		rcu_read_unlock();
N
Nick Piggin 已提交
835 836
		goto repeat;
	}
N
Nick Piggin 已提交
837
	rcu_read_unlock();
838 839
	BUG_ON(!ret->d_lockref.count);
	ret->d_lockref.count++;
N
Nick Piggin 已提交
840 841 842 843 844
	spin_unlock(&ret->d_lock);
	return ret;
}
EXPORT_SYMBOL(dget_parent);

L
Linus Torvalds 已提交
845 846 847 848 849 850 851 852
/**
 * d_find_alias - grab a hashed alias of inode
 * @inode: inode in question
 *
 * If inode has a hashed alias, or is a directory and has any alias,
 * acquire the reference to alias and return it. Otherwise return NULL.
 * Notice that if inode is a directory there can be only one alias and
 * it can be unhashed only if it has no children, or if it is the root
853 854
 * of a filesystem, or if the directory was renamed and d_revalidate
 * was the first vfs operation to notice.
L
Linus Torvalds 已提交
855
 *
856
 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
857
 * any other hashed alias over that one.
L
Linus Torvalds 已提交
858
 */
859
static struct dentry *__d_find_alias(struct inode *inode)
L
Linus Torvalds 已提交
860
{
N
Nick Piggin 已提交
861
	struct dentry *alias, *discon_alias;
L
Linus Torvalds 已提交
862

N
Nick Piggin 已提交
863 864
again:
	discon_alias = NULL;
865
	hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
N
Nick Piggin 已提交
866
		spin_lock(&alias->d_lock);
L
Linus Torvalds 已提交
867
 		if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
868
			if (IS_ROOT(alias) &&
N
Nick Piggin 已提交
869
			    (alias->d_flags & DCACHE_DISCONNECTED)) {
L
Linus Torvalds 已提交
870
				discon_alias = alias;
871
			} else {
872
				__dget_dlock(alias);
N
Nick Piggin 已提交
873 874 875 876 877 878 879 880 881 882
				spin_unlock(&alias->d_lock);
				return alias;
			}
		}
		spin_unlock(&alias->d_lock);
	}
	if (discon_alias) {
		alias = discon_alias;
		spin_lock(&alias->d_lock);
		if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
883 884 885
			__dget_dlock(alias);
			spin_unlock(&alias->d_lock);
			return alias;
L
Linus Torvalds 已提交
886
		}
N
Nick Piggin 已提交
887 888
		spin_unlock(&alias->d_lock);
		goto again;
L
Linus Torvalds 已提交
889
	}
N
Nick Piggin 已提交
890
	return NULL;
L
Linus Torvalds 已提交
891 892
}

N
Nick Piggin 已提交
893
struct dentry *d_find_alias(struct inode *inode)
L
Linus Torvalds 已提交
894
{
D
David Howells 已提交
895 896
	struct dentry *de = NULL;

A
Al Viro 已提交
897
	if (!hlist_empty(&inode->i_dentry)) {
898
		spin_lock(&inode->i_lock);
899
		de = __d_find_alias(inode);
900
		spin_unlock(&inode->i_lock);
D
David Howells 已提交
901
	}
L
Linus Torvalds 已提交
902 903
	return de;
}
904
EXPORT_SYMBOL(d_find_alias);
L
Linus Torvalds 已提交
905 906 907 908 909 910 911

/*
 *	Try to kill dentries associated with this inode.
 * WARNING: you must own a reference to inode.
 */
void d_prune_aliases(struct inode *inode)
{
912
	struct dentry *dentry;
L
Linus Torvalds 已提交
913
restart:
914
	spin_lock(&inode->i_lock);
915
	hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
L
Linus Torvalds 已提交
916
		spin_lock(&dentry->d_lock);
917
		if (!dentry->d_lockref.count) {
918 919 920
			struct dentry *parent = lock_parent(dentry);
			if (likely(!dentry->d_lockref.count)) {
				__dentry_kill(dentry);
921
				dput(parent);
922 923 924 925
				goto restart;
			}
			if (parent)
				spin_unlock(&parent->d_lock);
L
Linus Torvalds 已提交
926 927 928
		}
		spin_unlock(&dentry->d_lock);
	}
929
	spin_unlock(&inode->i_lock);
L
Linus Torvalds 已提交
930
}
931
EXPORT_SYMBOL(d_prune_aliases);
L
Linus Torvalds 已提交
932

C
Christoph Hellwig 已提交
933
static void shrink_dentry_list(struct list_head *list)
L
Linus Torvalds 已提交
934
{
A
Al Viro 已提交
935
	struct dentry *dentry, *parent;
936

937
	while (!list_empty(list)) {
938
		struct inode *inode;
939
		dentry = list_entry(list->prev, struct dentry, d_lru);
940
		spin_lock(&dentry->d_lock);
941 942
		parent = lock_parent(dentry);

943 944 945 946 947
		/*
		 * The dispose list is isolated and dentries are not accounted
		 * to the LRU here, so we can simply remove it from the list
		 * here regardless of whether it is referenced or not.
		 */
948
		d_shrink_del(dentry);
949

L
Linus Torvalds 已提交
950 951
		/*
		 * We found an inuse dentry which was not removed from
952
		 * the LRU because of laziness during lookup. Do not free it.
L
Linus Torvalds 已提交
953
		 */
954
		if (dentry->d_lockref.count > 0) {
955
			spin_unlock(&dentry->d_lock);
956 957
			if (parent)
				spin_unlock(&parent->d_lock);
L
Linus Torvalds 已提交
958 959
			continue;
		}
960

961 962 963 964

		if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
			bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
			spin_unlock(&dentry->d_lock);
965 966
			if (parent)
				spin_unlock(&parent->d_lock);
967 968 969 970 971
			if (can_free)
				dentry_free(dentry);
			continue;
		}

972 973
		inode = dentry->d_inode;
		if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
974
			d_shrink_add(dentry, list);
975
			spin_unlock(&dentry->d_lock);
976 977
			if (parent)
				spin_unlock(&parent->d_lock);
A
Al Viro 已提交
978
			continue;
979
		}
980 981

		__dentry_kill(dentry);
982

A
Al Viro 已提交
983 984 985 986 987 988 989
		/*
		 * We need to prune ancestors too. This is necessary to prevent
		 * quadratic behavior of shrink_dcache_parent(), but is also
		 * expected to be beneficial in reducing dentry cache
		 * fragmentation.
		 */
		dentry = parent;
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
		while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
			parent = lock_parent(dentry);
			if (dentry->d_lockref.count != 1) {
				dentry->d_lockref.count--;
				spin_unlock(&dentry->d_lock);
				if (parent)
					spin_unlock(&parent->d_lock);
				break;
			}
			inode = dentry->d_inode;	/* can't be NULL */
			if (unlikely(!spin_trylock(&inode->i_lock))) {
				spin_unlock(&dentry->d_lock);
				if (parent)
					spin_unlock(&parent->d_lock);
				cpu_relax();
				continue;
			}
			__dentry_kill(dentry);
			dentry = parent;
		}
1010
	}
C
Christoph Hellwig 已提交
1011 1012
}

1013 1014
static enum lru_status dentry_lru_isolate(struct list_head *item,
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
{
	struct list_head *freeable = arg;
	struct dentry	*dentry = container_of(item, struct dentry, d_lru);


	/*
	 * we are inverting the lru lock/dentry->d_lock here,
	 * so use a trylock. If we fail to get the lock, just skip
	 * it
	 */
	if (!spin_trylock(&dentry->d_lock))
		return LRU_SKIP;

	/*
	 * Referenced dentries are still in use. If they have active
	 * counts, just remove them from the LRU. Otherwise give them
	 * another pass through the LRU.
	 */
	if (dentry->d_lockref.count) {
1034
		d_lru_isolate(lru, dentry);
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		spin_unlock(&dentry->d_lock);
		return LRU_REMOVED;
	}

	if (dentry->d_flags & DCACHE_REFERENCED) {
		dentry->d_flags &= ~DCACHE_REFERENCED;
		spin_unlock(&dentry->d_lock);

		/*
		 * The list move itself will be made by the common LRU code. At
		 * this point, we've dropped the dentry->d_lock but keep the
		 * lru lock. This is safe to do, since every list movement is
		 * protected by the lru lock even if both locks are held.
		 *
		 * This is guaranteed by the fact that all LRU management
		 * functions are intermediated by the LRU API calls like
		 * list_lru_add and list_lru_del. List movement in this file
		 * only ever occur through this functions or through callbacks
		 * like this one, that are called from the LRU API.
		 *
		 * The only exceptions to this are functions like
		 * shrink_dentry_list, and code that first checks for the
		 * DCACHE_SHRINK_LIST flag.  Those are guaranteed to be
		 * operating only with stack provided lists after they are
		 * properly isolated from the main list.  It is thus, always a
		 * local access.
		 */
		return LRU_ROTATE;
	}

1065
	d_lru_shrink_move(lru, dentry, freeable);
1066 1067 1068 1069 1070
	spin_unlock(&dentry->d_lock);

	return LRU_REMOVED;
}

C
Christoph Hellwig 已提交
1071
/**
1072 1073
 * prune_dcache_sb - shrink the dcache
 * @sb: superblock
1074
 * @sc: shrink control, passed to list_lru_shrink_walk()
1075
 *
1076 1077
 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
 * is done when we need more memory and called from the superblock shrinker
1078
 * function.
C
Christoph Hellwig 已提交
1079
 *
1080 1081
 * This function may fail to free any resources if all the dentries are in
 * use.
C
Christoph Hellwig 已提交
1082
 */
1083
long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
C
Christoph Hellwig 已提交
1084
{
1085 1086
	LIST_HEAD(dispose);
	long freed;
C
Christoph Hellwig 已提交
1087

1088 1089
	freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
				     dentry_lru_isolate, &dispose);
1090
	shrink_dentry_list(&dispose);
1091
	return freed;
1092
}
N
Nick Piggin 已提交
1093

1094
static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
1095
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1096
{
1097 1098
	struct list_head *freeable = arg;
	struct dentry	*dentry = container_of(item, struct dentry, d_lru);
1099

1100 1101 1102 1103 1104 1105 1106 1107
	/*
	 * we are inverting the lru lock/dentry->d_lock here,
	 * so use a trylock. If we fail to get the lock, just skip
	 * it
	 */
	if (!spin_trylock(&dentry->d_lock))
		return LRU_SKIP;

1108
	d_lru_shrink_move(lru, dentry, freeable);
1109
	spin_unlock(&dentry->d_lock);
1110

1111
	return LRU_REMOVED;
1112 1113
}

1114

L
Linus Torvalds 已提交
1115 1116 1117 1118
/**
 * shrink_dcache_sb - shrink dcache for a superblock
 * @sb: superblock
 *
C
Christoph Hellwig 已提交
1119 1120
 * Shrink the dcache for the specified super block. This is used to free
 * the dcache before unmounting a file system.
L
Linus Torvalds 已提交
1121
 */
C
Christoph Hellwig 已提交
1122
void shrink_dcache_sb(struct super_block *sb)
L
Linus Torvalds 已提交
1123
{
1124 1125 1126 1127 1128 1129 1130
	long freed;

	do {
		LIST_HEAD(dispose);

		freed = list_lru_walk(&sb->s_dentry_lru,
			dentry_lru_isolate_shrink, &dispose, UINT_MAX);
C
Christoph Hellwig 已提交
1131

1132 1133 1134
		this_cpu_sub(nr_dentry_unused, freed);
		shrink_dentry_list(&dispose);
	} while (freed > 0);
L
Linus Torvalds 已提交
1135
}
1136
EXPORT_SYMBOL(shrink_dcache_sb);
L
Linus Torvalds 已提交
1137

M
Miklos Szeredi 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
/**
 * enum d_walk_ret - action to talke during tree walk
 * @D_WALK_CONTINUE:	contrinue walk
 * @D_WALK_QUIT:	quit walk
 * @D_WALK_NORETRY:	quit when retry is needed
 * @D_WALK_SKIP:	skip this dentry and its children
 */
enum d_walk_ret {
	D_WALK_CONTINUE,
	D_WALK_QUIT,
	D_WALK_NORETRY,
	D_WALK_SKIP,
};
1151

L
Linus Torvalds 已提交
1152
/**
M
Miklos Szeredi 已提交
1153 1154 1155 1156 1157
 * d_walk - walk the dentry tree
 * @parent:	start of walk
 * @data:	data passed to @enter() and @finish()
 * @enter:	callback when first entering the dentry
 * @finish:	callback when successfully finished the walk
L
Linus Torvalds 已提交
1158
 *
M
Miklos Szeredi 已提交
1159
 * The @enter() and @finish() callbacks are called with d_lock held.
L
Linus Torvalds 已提交
1160
 */
M
Miklos Szeredi 已提交
1161 1162 1163
static void d_walk(struct dentry *parent, void *data,
		   enum d_walk_ret (*enter)(void *, struct dentry *),
		   void (*finish)(void *))
L
Linus Torvalds 已提交
1164
{
1165
	struct dentry *this_parent;
L
Linus Torvalds 已提交
1166
	struct list_head *next;
1167
	unsigned seq = 0;
M
Miklos Szeredi 已提交
1168 1169
	enum d_walk_ret ret;
	bool retry = true;
1170

1171
again:
1172
	read_seqbegin_or_lock(&rename_lock, &seq);
1173
	this_parent = parent;
N
Nick Piggin 已提交
1174
	spin_lock(&this_parent->d_lock);
M
Miklos Szeredi 已提交
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

	ret = enter(data, this_parent);
	switch (ret) {
	case D_WALK_CONTINUE:
		break;
	case D_WALK_QUIT:
	case D_WALK_SKIP:
		goto out_unlock;
	case D_WALK_NORETRY:
		retry = false;
		break;
	}
L
Linus Torvalds 已提交
1187 1188 1189 1190 1191
repeat:
	next = this_parent->d_subdirs.next;
resume:
	while (next != &this_parent->d_subdirs) {
		struct list_head *tmp = next;
1192
		struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
L
Linus Torvalds 已提交
1193
		next = tmp->next;
N
Nick Piggin 已提交
1194 1195

		spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
M
Miklos Szeredi 已提交
1196 1197 1198 1199 1200 1201

		ret = enter(data, dentry);
		switch (ret) {
		case D_WALK_CONTINUE:
			break;
		case D_WALK_QUIT:
N
Nick Piggin 已提交
1202
			spin_unlock(&dentry->d_lock);
M
Miklos Szeredi 已提交
1203 1204 1205 1206 1207 1208 1209
			goto out_unlock;
		case D_WALK_NORETRY:
			retry = false;
			break;
		case D_WALK_SKIP:
			spin_unlock(&dentry->d_lock);
			continue;
N
Nick Piggin 已提交
1210
		}
M
Miklos Szeredi 已提交
1211

L
Linus Torvalds 已提交
1212
		if (!list_empty(&dentry->d_subdirs)) {
N
Nick Piggin 已提交
1213 1214
			spin_unlock(&this_parent->d_lock);
			spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
L
Linus Torvalds 已提交
1215
			this_parent = dentry;
N
Nick Piggin 已提交
1216
			spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
L
Linus Torvalds 已提交
1217 1218
			goto repeat;
		}
N
Nick Piggin 已提交
1219
		spin_unlock(&dentry->d_lock);
L
Linus Torvalds 已提交
1220 1221 1222 1223
	}
	/*
	 * All done at this level ... ascend and resume the search.
	 */
A
Al Viro 已提交
1224 1225
	rcu_read_lock();
ascend:
L
Linus Torvalds 已提交
1226
	if (this_parent != parent) {
1227
		struct dentry *child = this_parent;
1228 1229 1230 1231 1232
		this_parent = child->d_parent;

		spin_unlock(&child->d_lock);
		spin_lock(&this_parent->d_lock);

A
Al Viro 已提交
1233 1234
		/* might go back up the wrong parent if we have had a rename. */
		if (need_seqretry(&rename_lock, seq))
1235
			goto rename_retry;
A
Al Viro 已提交
1236 1237 1238
		/* go into the first sibling still alive */
		do {
			next = child->d_child.next;
A
Al Viro 已提交
1239 1240 1241
			if (next == &this_parent->d_subdirs)
				goto ascend;
			child = list_entry(next, struct dentry, d_child);
A
Al Viro 已提交
1242
		} while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
1243
		rcu_read_unlock();
L
Linus Torvalds 已提交
1244 1245
		goto resume;
	}
A
Al Viro 已提交
1246
	if (need_seqretry(&rename_lock, seq))
1247
		goto rename_retry;
A
Al Viro 已提交
1248
	rcu_read_unlock();
M
Miklos Szeredi 已提交
1249 1250 1251 1252 1253
	if (finish)
		finish(data);

out_unlock:
	spin_unlock(&this_parent->d_lock);
1254
	done_seqretry(&rename_lock, seq);
M
Miklos Szeredi 已提交
1255
	return;
1256 1257

rename_retry:
A
Al Viro 已提交
1258 1259 1260
	spin_unlock(&this_parent->d_lock);
	rcu_read_unlock();
	BUG_ON(seq & 1);
M
Miklos Szeredi 已提交
1261 1262
	if (!retry)
		return;
1263
	seq = 1;
1264
	goto again;
L
Linus Torvalds 已提交
1265
}
M
Miklos Szeredi 已提交
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282

/*
 * Search for at least 1 mount point in the dentry's subdirs.
 * We descend to the next level whenever the d_subdirs
 * list is non-empty and continue searching.
 */

static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
{
	int *ret = data;
	if (d_mountpoint(dentry)) {
		*ret = 1;
		return D_WALK_QUIT;
	}
	return D_WALK_CONTINUE;
}

R
Randy Dunlap 已提交
1283 1284 1285 1286 1287 1288 1289
/**
 * have_submounts - check for mounts over a dentry
 * @parent: dentry to check.
 *
 * Return true if the parent or its subdirectories contain
 * a mount point
 */
M
Miklos Szeredi 已提交
1290 1291 1292 1293 1294 1295 1296 1297
int have_submounts(struct dentry *parent)
{
	int ret = 0;

	d_walk(parent, &ret, check_mount, NULL);

	return ret;
}
1298
EXPORT_SYMBOL(have_submounts);
L
Linus Torvalds 已提交
1299

1300 1301 1302 1303 1304
/*
 * Called by mount code to set a mountpoint and check if the mountpoint is
 * reachable (e.g. NFS can unhash a directory dentry and then the complete
 * subtree can become unreachable).
 *
1305
 * Only one of d_invalidate() and d_set_mounted() must succeed.  For
1306 1307 1308 1309 1310 1311 1312 1313
 * this reason take rename_lock and d_lock on dentry and ancestors.
 */
int d_set_mounted(struct dentry *dentry)
{
	struct dentry *p;
	int ret = -ENOENT;
	write_seqlock(&rename_lock);
	for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1314
		/* Need exclusion wrt. d_invalidate() */
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
		spin_lock(&p->d_lock);
		if (unlikely(d_unhashed(p))) {
			spin_unlock(&p->d_lock);
			goto out;
		}
		spin_unlock(&p->d_lock);
	}
	spin_lock(&dentry->d_lock);
	if (!d_unlinked(dentry)) {
		dentry->d_flags |= DCACHE_MOUNTED;
		ret = 0;
	}
 	spin_unlock(&dentry->d_lock);
out:
	write_sequnlock(&rename_lock);
	return ret;
}

L
Linus Torvalds 已提交
1333
/*
1334
 * Search the dentry child list of the specified parent,
L
Linus Torvalds 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
 * and move any unused dentries to the end of the unused
 * list for prune_dcache(). We descend to the next level
 * whenever the d_subdirs list is non-empty and continue
 * searching.
 *
 * It returns zero iff there are no unused children,
 * otherwise  it returns the number of children moved to
 * the end of the unused list. This may not be the total
 * number of unused children, because select_parent can
 * drop the lock and return early due to latency
 * constraints.
 */

M
Miklos Szeredi 已提交
1348 1349 1350 1351 1352
struct select_data {
	struct dentry *start;
	struct list_head dispose;
	int found;
};
N
Nick Piggin 已提交
1353

M
Miklos Szeredi 已提交
1354 1355 1356 1357
static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
{
	struct select_data *data = _data;
	enum d_walk_ret ret = D_WALK_CONTINUE;
L
Linus Torvalds 已提交
1358

M
Miklos Szeredi 已提交
1359 1360
	if (data->start == dentry)
		goto out;
N
Nick Piggin 已提交
1361

1362
	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
M
Miklos Szeredi 已提交
1363
		data->found++;
1364 1365 1366 1367 1368 1369 1370
	} else {
		if (dentry->d_flags & DCACHE_LRU_LIST)
			d_lru_del(dentry);
		if (!dentry->d_lockref.count) {
			d_shrink_add(dentry, &data->dispose);
			data->found++;
		}
L
Linus Torvalds 已提交
1371
	}
M
Miklos Szeredi 已提交
1372 1373 1374 1375 1376
	/*
	 * We can return to the caller if we have found some (this
	 * ensures forward progress). We'll be coming back to find
	 * the rest.
	 */
1377 1378
	if (!list_empty(&data->dispose))
		ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
L
Linus Torvalds 已提交
1379
out:
M
Miklos Szeredi 已提交
1380
	return ret;
L
Linus Torvalds 已提交
1381 1382 1383 1384 1385 1386 1387 1388
}

/**
 * shrink_dcache_parent - prune dcache
 * @parent: parent of entries to prune
 *
 * Prune the dcache to remove unused children of the parent dentry.
 */
M
Miklos Szeredi 已提交
1389
void shrink_dcache_parent(struct dentry *parent)
L
Linus Torvalds 已提交
1390
{
M
Miklos Szeredi 已提交
1391 1392
	for (;;) {
		struct select_data data;
L
Linus Torvalds 已提交
1393

M
Miklos Szeredi 已提交
1394 1395 1396 1397 1398 1399 1400 1401 1402
		INIT_LIST_HEAD(&data.dispose);
		data.start = parent;
		data.found = 0;

		d_walk(parent, &data, select_collect, NULL);
		if (!data.found)
			break;

		shrink_dentry_list(&data.dispose);
1403 1404
		cond_resched();
	}
L
Linus Torvalds 已提交
1405
}
1406
EXPORT_SYMBOL(shrink_dcache_parent);
L
Linus Torvalds 已提交
1407

1408
static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
1409
{
1410 1411 1412
	/* it has busy descendents; complain about those instead */
	if (!list_empty(&dentry->d_subdirs))
		return D_WALK_CONTINUE;
1413

1414 1415 1416 1417 1418 1419
	/* root with refcount 1 is fine */
	if (dentry == _data && dentry->d_lockref.count == 1)
		return D_WALK_CONTINUE;

	printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
			" still in use (%d) [unmount of %s %s]\n",
1420 1421 1422
		       dentry,
		       dentry->d_inode ?
		       dentry->d_inode->i_ino : 0UL,
1423
		       dentry,
1424 1425 1426
		       dentry->d_lockref.count,
		       dentry->d_sb->s_type->name,
		       dentry->d_sb->s_id);
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
	WARN_ON(1);
	return D_WALK_CONTINUE;
}

static void do_one_tree(struct dentry *dentry)
{
	shrink_dcache_parent(dentry);
	d_walk(dentry, dentry, umount_check, NULL);
	d_drop(dentry);
	dput(dentry);
1437 1438 1439 1440 1441 1442 1443 1444 1445
}

/*
 * destroy the dentries attached to a superblock on unmounting
 */
void shrink_dcache_for_umount(struct super_block *sb)
{
	struct dentry *dentry;

1446
	WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
1447 1448 1449

	dentry = sb->s_root;
	sb->s_root = NULL;
1450
	do_one_tree(dentry);
1451 1452

	while (!hlist_bl_empty(&sb->s_anon)) {
1453 1454
		dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
		do_one_tree(dentry);
1455 1456 1457
	}
}

1458 1459 1460 1461 1462
struct detach_data {
	struct select_data select;
	struct dentry *mountpoint;
};
static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
1463
{
1464
	struct detach_data *data = _data;
1465 1466

	if (d_mountpoint(dentry)) {
1467 1468
		__dget_dlock(dentry);
		data->mountpoint = dentry;
1469 1470 1471
		return D_WALK_QUIT;
	}

1472
	return select_collect(&data->select, dentry);
1473 1474 1475 1476
}

static void check_and_drop(void *_data)
{
1477
	struct detach_data *data = _data;
1478

1479 1480
	if (!data->mountpoint && !data->select.found)
		__d_drop(data->select.start);
1481 1482 1483
}

/**
1484 1485 1486 1487
 * d_invalidate - detach submounts, prune dcache, and drop
 * @dentry: dentry to invalidate (aka detach, prune and drop)
 *
 * no dcache lock.
1488
 *
1489 1490 1491
 * The final d_drop is done as an atomic operation relative to
 * rename_lock ensuring there are no races with d_set_mounted.  This
 * ensures there are no unhashed dentries on the path to a mountpoint.
1492
 */
1493
void d_invalidate(struct dentry *dentry)
1494
{
1495 1496 1497 1498 1499 1500
	/*
	 * If it's already been dropped, return OK.
	 */
	spin_lock(&dentry->d_lock);
	if (d_unhashed(dentry)) {
		spin_unlock(&dentry->d_lock);
1501
		return;
1502 1503 1504
	}
	spin_unlock(&dentry->d_lock);

1505 1506 1507
	/* Negative dentries can be dropped without further checks */
	if (!dentry->d_inode) {
		d_drop(dentry);
1508
		return;
1509 1510 1511
	}

	for (;;) {
1512
		struct detach_data data;
1513

1514 1515 1516 1517 1518 1519
		data.mountpoint = NULL;
		INIT_LIST_HEAD(&data.select.dispose);
		data.select.start = dentry;
		data.select.found = 0;

		d_walk(dentry, &data, detach_and_collect, check_and_drop);
1520

1521 1522
		if (data.select.found)
			shrink_dentry_list(&data.select.dispose);
1523

1524 1525 1526 1527
		if (data.mountpoint) {
			detach_mounts(data.mountpoint);
			dput(data.mountpoint);
		}
1528

1529
		if (!data.mountpoint && !data.select.found)
1530 1531 1532 1533 1534
			break;

		cond_resched();
	}
}
1535
EXPORT_SYMBOL(d_invalidate);
1536

L
Linus Torvalds 已提交
1537
/**
1538 1539
 * __d_alloc	-	allocate a dcache entry
 * @sb: filesystem it will belong to
L
Linus Torvalds 已提交
1540 1541 1542 1543 1544 1545 1546
 * @name: qstr of the name
 *
 * Allocates a dentry. It returns %NULL if there is insufficient memory
 * available. On a success the dentry is returned. The name passed in is
 * copied and the copy passed in may be reused after this call.
 */
 
1547
struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
L
Linus Torvalds 已提交
1548 1549 1550 1551
{
	struct dentry *dentry;
	char *dname;

1552
	dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
L
Linus Torvalds 已提交
1553 1554 1555
	if (!dentry)
		return NULL;

1556 1557 1558 1559 1560 1561 1562
	/*
	 * We guarantee that the inline name is always NUL-terminated.
	 * This way the memcpy() done by the name switching in rename
	 * will still always have a NUL at the end, even if we might
	 * be overwriting an internal NUL character
	 */
	dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
L
Linus Torvalds 已提交
1563
	if (name->len > DNAME_INLINE_LEN-1) {
1564
		size_t size = offsetof(struct external_name, name[1]);
1565 1566
		struct external_name *p = kmalloc(size + name->len,
						  GFP_KERNEL_ACCOUNT);
1567
		if (!p) {
L
Linus Torvalds 已提交
1568 1569 1570
			kmem_cache_free(dentry_cache, dentry); 
			return NULL;
		}
1571 1572
		atomic_set(&p->u.count, 1);
		dname = p->name;
1573 1574 1575
		if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
			kasan_unpoison_shadow(dname,
				round_up(name->len + 1,	sizeof(unsigned long)));
L
Linus Torvalds 已提交
1576 1577 1578 1579 1580 1581 1582 1583 1584
	} else  {
		dname = dentry->d_iname;
	}	

	dentry->d_name.len = name->len;
	dentry->d_name.hash = name->hash;
	memcpy(dname, name->name, name->len);
	dname[name->len] = 0;

1585 1586 1587 1588
	/* Make sure we always see the terminating NUL character */
	smp_wmb();
	dentry->d_name.name = dname;

1589
	dentry->d_lockref.count = 1;
1590
	dentry->d_flags = 0;
L
Linus Torvalds 已提交
1591
	spin_lock_init(&dentry->d_lock);
N
Nick Piggin 已提交
1592
	seqcount_init(&dentry->d_seq);
L
Linus Torvalds 已提交
1593
	dentry->d_inode = NULL;
1594 1595
	dentry->d_parent = dentry;
	dentry->d_sb = sb;
L
Linus Torvalds 已提交
1596 1597
	dentry->d_op = NULL;
	dentry->d_fsdata = NULL;
1598
	INIT_HLIST_BL_NODE(&dentry->d_hash);
L
Linus Torvalds 已提交
1599 1600
	INIT_LIST_HEAD(&dentry->d_lru);
	INIT_LIST_HEAD(&dentry->d_subdirs);
1601 1602
	INIT_HLIST_NODE(&dentry->d_u.d_alias);
	INIT_LIST_HEAD(&dentry->d_child);
1603
	d_set_d_op(dentry, dentry->d_sb->s_d_op);
L
Linus Torvalds 已提交
1604

1605
	this_cpu_inc(nr_dentry);
1606

L
Linus Torvalds 已提交
1607 1608
	return dentry;
}
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631

/**
 * d_alloc	-	allocate a dcache entry
 * @parent: parent of entry to allocate
 * @name: qstr of the name
 *
 * Allocates a dentry. It returns %NULL if there is insufficient memory
 * available. On a success the dentry is returned. The name passed in is
 * copied and the copy passed in may be reused after this call.
 */
struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
{
	struct dentry *dentry = __d_alloc(parent->d_sb, name);
	if (!dentry)
		return NULL;

	spin_lock(&parent->d_lock);
	/*
	 * don't need child lock because it is not subject
	 * to concurrency here
	 */
	__dget_dlock(parent);
	dentry->d_parent = parent;
1632
	list_add(&dentry->d_child, &parent->d_subdirs);
1633 1634 1635 1636
	spin_unlock(&parent->d_lock);

	return dentry;
}
1637
EXPORT_SYMBOL(d_alloc);
L
Linus Torvalds 已提交
1638

1639 1640 1641 1642 1643 1644 1645 1646
/**
 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
 * @sb: the superblock
 * @name: qstr of the name
 *
 * For a filesystem that just pins its dentries in memory and never
 * performs lookups at all, return an unhashed IS_ROOT dentry.
 */
1647 1648
struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
{
1649
	return __d_alloc(sb, name);
1650 1651 1652
}
EXPORT_SYMBOL(d_alloc_pseudo);

L
Linus Torvalds 已提交
1653 1654 1655 1656 1657 1658 1659 1660 1661
struct dentry *d_alloc_name(struct dentry *parent, const char *name)
{
	struct qstr q;

	q.name = name;
	q.len = strlen(name);
	q.hash = full_name_hash(q.name, q.len);
	return d_alloc(parent, &q);
}
1662
EXPORT_SYMBOL(d_alloc_name);
L
Linus Torvalds 已提交
1663

1664 1665
void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
{
1666 1667
	WARN_ON_ONCE(dentry->d_op);
	WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH	|
1668 1669
				DCACHE_OP_COMPARE	|
				DCACHE_OP_REVALIDATE	|
1670
				DCACHE_OP_WEAK_REVALIDATE	|
1671
				DCACHE_OP_DELETE	|
M
Miklos Szeredi 已提交
1672 1673
				DCACHE_OP_SELECT_INODE	|
				DCACHE_OP_REAL));
1674 1675 1676 1677 1678 1679 1680 1681 1682
	dentry->d_op = op;
	if (!op)
		return;
	if (op->d_hash)
		dentry->d_flags |= DCACHE_OP_HASH;
	if (op->d_compare)
		dentry->d_flags |= DCACHE_OP_COMPARE;
	if (op->d_revalidate)
		dentry->d_flags |= DCACHE_OP_REVALIDATE;
1683 1684
	if (op->d_weak_revalidate)
		dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
1685 1686
	if (op->d_delete)
		dentry->d_flags |= DCACHE_OP_DELETE;
S
Sage Weil 已提交
1687 1688
	if (op->d_prune)
		dentry->d_flags |= DCACHE_OP_PRUNE;
1689 1690
	if (op->d_select_inode)
		dentry->d_flags |= DCACHE_OP_SELECT_INODE;
M
Miklos Szeredi 已提交
1691 1692
	if (op->d_real)
		dentry->d_flags |= DCACHE_OP_REAL;
1693 1694 1695 1696

}
EXPORT_SYMBOL(d_set_d_op);

1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712

/*
 * d_set_fallthru - Mark a dentry as falling through to a lower layer
 * @dentry - The dentry to mark
 *
 * Mark a dentry as falling through to the lower layer (as set with
 * d_pin_lower()).  This flag may be recorded on the medium.
 */
void d_set_fallthru(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	dentry->d_flags |= DCACHE_FALLTHRU;
	spin_unlock(&dentry->d_lock);
}
EXPORT_SYMBOL(d_set_fallthru);

1713 1714
static unsigned d_flags_for_inode(struct inode *inode)
{
1715
	unsigned add_flags = DCACHE_REGULAR_TYPE;
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727

	if (!inode)
		return DCACHE_MISS_TYPE;

	if (S_ISDIR(inode->i_mode)) {
		add_flags = DCACHE_DIRECTORY_TYPE;
		if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
			if (unlikely(!inode->i_op->lookup))
				add_flags = DCACHE_AUTODIR_TYPE;
			else
				inode->i_opflags |= IOP_LOOKUP;
		}
1728 1729 1730 1731
		goto type_determined;
	}

	if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1732
		if (unlikely(inode->i_op->get_link)) {
1733
			add_flags = DCACHE_SYMLINK_TYPE;
1734 1735 1736
			goto type_determined;
		}
		inode->i_opflags |= IOP_NOFOLLOW;
1737 1738
	}

1739 1740 1741 1742
	if (unlikely(!S_ISREG(inode->i_mode)))
		add_flags = DCACHE_SPECIAL_TYPE;

type_determined:
1743 1744 1745 1746 1747
	if (unlikely(IS_AUTOMOUNT(inode)))
		add_flags |= DCACHE_NEED_AUTOMOUNT;
	return add_flags;
}

1748 1749
static void __d_instantiate(struct dentry *dentry, struct inode *inode)
{
1750
	unsigned add_flags = d_flags_for_inode(inode);
1751
	WARN_ON(d_in_lookup(dentry));
1752

N
Nick Piggin 已提交
1753
	spin_lock(&dentry->d_lock);
1754
	hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
1755
	raw_write_seqcount_begin(&dentry->d_seq);
1756
	__d_set_inode_and_type(dentry, inode, add_flags);
1757
	raw_write_seqcount_end(&dentry->d_seq);
1758
	__fsnotify_d_instantiate(dentry);
N
Nick Piggin 已提交
1759
	spin_unlock(&dentry->d_lock);
1760 1761
}

L
Linus Torvalds 已提交
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
/**
 * d_instantiate - fill in inode information for a dentry
 * @entry: dentry to complete
 * @inode: inode to attach to this dentry
 *
 * Fill in inode information in the entry.
 *
 * This turns negative dentries into productive full members
 * of society.
 *
 * NOTE! This assumes that the inode count has been incremented
 * (or otherwise set) by the caller to indicate that it is now
 * in use by the dcache.
 */
 
void d_instantiate(struct dentry *entry, struct inode * inode)
{
1779
	BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1780
	if (inode) {
1781
		security_d_instantiate(entry, inode);
1782
		spin_lock(&inode->i_lock);
1783
		__d_instantiate(entry, inode);
1784
		spin_unlock(&inode->i_lock);
1785
	}
L
Linus Torvalds 已提交
1786
}
1787
EXPORT_SYMBOL(d_instantiate);
L
Linus Torvalds 已提交
1788

1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
/**
 * d_instantiate_no_diralias - instantiate a non-aliased dentry
 * @entry: dentry to complete
 * @inode: inode to attach to this dentry
 *
 * Fill in inode information in the entry.  If a directory alias is found, then
 * return an error (and drop inode).  Together with d_materialise_unique() this
 * guarantees that a directory inode may never have more than one alias.
 */
int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
{
1800
	BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1801

1802
	security_d_instantiate(entry, inode);
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815
	spin_lock(&inode->i_lock);
	if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
		spin_unlock(&inode->i_lock);
		iput(inode);
		return -EBUSY;
	}
	__d_instantiate(entry, inode);
	spin_unlock(&inode->i_lock);

	return 0;
}
EXPORT_SYMBOL(d_instantiate_no_diralias);

A
Al Viro 已提交
1816 1817 1818 1819 1820
struct dentry *d_make_root(struct inode *root_inode)
{
	struct dentry *res = NULL;

	if (root_inode) {
1821
		static const struct qstr name = QSTR_INIT("/", 1);
A
Al Viro 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832

		res = __d_alloc(root_inode->i_sb, &name);
		if (res)
			d_instantiate(res, root_inode);
		else
			iput(root_inode);
	}
	return res;
}
EXPORT_SYMBOL(d_make_root);

1833 1834 1835 1836
static struct dentry * __d_find_any_alias(struct inode *inode)
{
	struct dentry *alias;

A
Al Viro 已提交
1837
	if (hlist_empty(&inode->i_dentry))
1838
		return NULL;
1839
	alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
1840 1841 1842 1843
	__dget(alias);
	return alias;
}

1844 1845 1846 1847 1848 1849 1850 1851
/**
 * d_find_any_alias - find any alias for a given inode
 * @inode: inode to find an alias for
 *
 * If any aliases exist for the given inode, take and return a
 * reference for one of them.  If no aliases exist, return %NULL.
 */
struct dentry *d_find_any_alias(struct inode *inode)
1852 1853 1854 1855 1856 1857 1858 1859
{
	struct dentry *de;

	spin_lock(&inode->i_lock);
	de = __d_find_any_alias(inode);
	spin_unlock(&inode->i_lock);
	return de;
}
1860
EXPORT_SYMBOL(d_find_any_alias);
1861

F
Fengguang Wu 已提交
1862
static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
1863
{
1864
	static const struct qstr anonstring = QSTR_INIT("/", 1);
C
Christoph Hellwig 已提交
1865 1866
	struct dentry *tmp;
	struct dentry *res;
1867
	unsigned add_flags;
1868 1869

	if (!inode)
1870
		return ERR_PTR(-ESTALE);
1871 1872 1873
	if (IS_ERR(inode))
		return ERR_CAST(inode);

1874
	res = d_find_any_alias(inode);
C
Christoph Hellwig 已提交
1875 1876 1877
	if (res)
		goto out_iput;

1878
	tmp = __d_alloc(inode->i_sb, &anonstring);
C
Christoph Hellwig 已提交
1879 1880 1881
	if (!tmp) {
		res = ERR_PTR(-ENOMEM);
		goto out_iput;
1882
	}
N
Nick Piggin 已提交
1883

1884
	security_d_instantiate(tmp, inode);
1885
	spin_lock(&inode->i_lock);
1886
	res = __d_find_any_alias(inode);
C
Christoph Hellwig 已提交
1887
	if (res) {
1888
		spin_unlock(&inode->i_lock);
C
Christoph Hellwig 已提交
1889 1890 1891 1892 1893
		dput(tmp);
		goto out_iput;
	}

	/* attach a disconnected dentry */
1894 1895 1896 1897
	add_flags = d_flags_for_inode(inode);

	if (disconnected)
		add_flags |= DCACHE_DISCONNECTED;
1898

C
Christoph Hellwig 已提交
1899
	spin_lock(&tmp->d_lock);
1900
	__d_set_inode_and_type(tmp, inode, add_flags);
1901
	hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
1902
	hlist_bl_lock(&tmp->d_sb->s_anon);
1903
	hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
1904
	hlist_bl_unlock(&tmp->d_sb->s_anon);
C
Christoph Hellwig 已提交
1905
	spin_unlock(&tmp->d_lock);
1906
	spin_unlock(&inode->i_lock);
C
Christoph Hellwig 已提交
1907 1908 1909 1910 1911 1912

	return tmp;

 out_iput:
	iput(inode);
	return res;
1913
}
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936

/**
 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
 * @inode: inode to allocate the dentry for
 *
 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
 * similar open by handle operations.  The returned dentry may be anonymous,
 * or may have a full name (if the inode was already in the cache).
 *
 * When called on a directory inode, we must ensure that the inode only ever
 * has one dentry.  If a dentry is found, that is returned instead of
 * allocating a new one.
 *
 * On successful return, the reference to the inode has been transferred
 * to the dentry.  In case of an error the reference on the inode is released.
 * To make it easier to use in export operations a %NULL or IS_ERR inode may
 * be passed in and the error will be propagated to the return value,
 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
 */
struct dentry *d_obtain_alias(struct inode *inode)
{
	return __d_obtain_alias(inode, 1);
}
1937
EXPORT_SYMBOL(d_obtain_alias);
L
Linus Torvalds 已提交
1938

1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
/**
 * d_obtain_root - find or allocate a dentry for a given inode
 * @inode: inode to allocate the dentry for
 *
 * Obtain an IS_ROOT dentry for the root of a filesystem.
 *
 * We must ensure that directory inodes only ever have one dentry.  If a
 * dentry is found, that is returned instead of allocating a new one.
 *
 * On successful return, the reference to the inode has been transferred
 * to the dentry.  In case of an error the reference on the inode is
 * released.  A %NULL or IS_ERR inode may be passed in and will be the
 * error will be propagate to the return value, with a %NULL @inode
 * replaced by ERR_PTR(-ESTALE).
 */
struct dentry *d_obtain_root(struct inode *inode)
{
	return __d_obtain_alias(inode, 0);
}
EXPORT_SYMBOL(d_obtain_root);

1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
/**
 * d_add_ci - lookup or allocate new dentry with case-exact name
 * @inode:  the inode case-insensitive lookup has found
 * @dentry: the negative dentry that was passed to the parent's lookup func
 * @name:   the case-exact name to be associated with the returned dentry
 *
 * This is to avoid filling the dcache with case-insensitive names to the
 * same inode, only the actual correct case is stored in the dcache for
 * case-insensitive filesystems.
 *
 * For a case-insensitive lookup match and if the the case-exact dentry
 * already exists in in the dcache, use it and return it.
 *
 * If no entry exists with the exact case name, allocate new dentry with
 * the exact case, and return the spliced entry.
 */
1976
struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
1977 1978 1979 1980 1981
			struct qstr *name)
{
	struct dentry *found;
	struct dentry *new;

C
Christoph Hellwig 已提交
1982 1983 1984 1985
	/*
	 * First check if a dentry matching the name already exists,
	 * if not go ahead and create it now.
	 */
1986 1987 1988 1989
	found = d_hash_and_lookup(dentry->d_parent, name);
	if (!found) {
		new = d_alloc(dentry->d_parent, name);
		if (!new) {
1990
			found = ERR_PTR(-ENOMEM);
1991 1992 1993 1994 1995 1996 1997
		} else {
			found = d_splice_alias(inode, new);
			if (found) {
				dput(new);
				return found;
			}
			return new;
1998 1999 2000
		}
	}
	iput(inode);
2001
	return found;
2002
}
2003
EXPORT_SYMBOL(d_add_ci);
L
Linus Torvalds 已提交
2004

2005 2006 2007 2008
/*
 * Do the slow-case of the dentry name compare.
 *
 * Unlike the dentry_cmp() function, we need to atomically
2009
 * load the name and length information, so that the
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
 * filesystem can rely on them, and can use the 'name' and
 * 'len' information without worrying about walking off the
 * end of memory etc.
 *
 * Thus the read_seqcount_retry() and the "duplicate" info
 * in arguments (the low-level filesystem should not look
 * at the dentry inode or name contents directly, since
 * rename can change them while we're in RCU mode).
 */
enum slow_d_compare {
	D_COMP_OK,
	D_COMP_NOMATCH,
	D_COMP_SEQRETRY,
};

static noinline enum slow_d_compare slow_dentry_cmp(
		const struct dentry *parent,
		struct dentry *dentry,
		unsigned int seq,
		const struct qstr *name)
{
	int tlen = dentry->d_name.len;
	const char *tname = dentry->d_name.name;

	if (read_seqcount_retry(&dentry->d_seq, seq)) {
		cpu_relax();
		return D_COMP_SEQRETRY;
	}
2038
	if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2039 2040 2041 2042
		return D_COMP_NOMATCH;
	return D_COMP_OK;
}

N
Nick Piggin 已提交
2043 2044 2045 2046
/**
 * __d_lookup_rcu - search for a dentry (racy, store-free)
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2047
 * @seqp: returns d_seq value at the point where the dentry was found
N
Nick Piggin 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
 * Returns: dentry, or NULL
 *
 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
 * resolution (store-free path walking) design described in
 * Documentation/filesystems/path-lookup.txt.
 *
 * This is not to be used outside core vfs.
 *
 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
 * held, and rcu_read_lock held. The returned dentry must not be stored into
 * without taking d_lock and checking d_seq sequence count against @seq
 * returned here.
 *
2061
 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
N
Nick Piggin 已提交
2062 2063 2064 2065 2066 2067
 * function.
 *
 * Alternatively, __d_lookup_rcu may be called again to look up the child of
 * the returned dentry, so long as its parent's seqlock is checked after the
 * child is looked up. Thus, an interlocking stepping of sequence lock checks
 * is formed, giving integrity down the path walk.
2068 2069 2070
 *
 * NOTE! The caller *has* to check the resulting dentry against the sequence
 * number we've returned before using any of the resulting dentry state!
N
Nick Piggin 已提交
2071
 */
2072 2073
struct dentry *__d_lookup_rcu(const struct dentry *parent,
				const struct qstr *name,
2074
				unsigned *seqp)
N
Nick Piggin 已提交
2075
{
2076
	u64 hashlen = name->hash_len;
N
Nick Piggin 已提交
2077
	const unsigned char *str = name->name;
2078
	struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
2079
	struct hlist_bl_node *node;
N
Nick Piggin 已提交
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
	struct dentry *dentry;

	/*
	 * Note: There is significant duplication with __d_lookup_rcu which is
	 * required to prevent single threaded performance regressions
	 * especially on architectures where smp_rmb (in seqcounts) are costly.
	 * Keep the two functions in sync.
	 */

	/*
	 * The hash list is protected using RCU.
	 *
	 * Carefully use d_seq when comparing a candidate dentry, to avoid
	 * races with d_move().
	 *
	 * It is possible that concurrent renames can mess up our list
	 * walk here and result in missing our dentry, resulting in the
	 * false-negative result. d_lookup() protects against concurrent
	 * renames using rename_lock seqlock.
	 *
2100
	 * See Documentation/filesystems/path-lookup.txt for more details.
N
Nick Piggin 已提交
2101
	 */
2102
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
2103
		unsigned seq;
N
Nick Piggin 已提交
2104 2105

seqretry:
2106 2107
		/*
		 * The dentry sequence count protects us from concurrent
2108
		 * renames, and thus protects parent and name fields.
2109 2110
		 *
		 * The caller must perform a seqcount check in order
2111
		 * to do anything useful with the returned dentry.
2112 2113 2114 2115 2116 2117 2118 2119 2120
		 *
		 * NOTE! We do a "raw" seqcount_begin here. That means that
		 * we don't wait for the sequence count to stabilize if it
		 * is in the middle of a sequence change. If we do the slow
		 * dentry compare, we will do seqretries until it is stable,
		 * and if we end up with a successful lookup, we actually
		 * want to exit RCU lookup anyway.
		 */
		seq = raw_seqcount_begin(&dentry->d_seq);
N
Nick Piggin 已提交
2121 2122
		if (dentry->d_parent != parent)
			continue;
2123 2124
		if (d_unhashed(dentry))
			continue;
2125

2126
		if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
2127 2128
			if (dentry->d_name.hash != hashlen_hash(hashlen))
				continue;
2129 2130
			*seqp = seq;
			switch (slow_dentry_cmp(parent, dentry, seq, name)) {
2131 2132 2133
			case D_COMP_OK:
				return dentry;
			case D_COMP_NOMATCH:
N
Nick Piggin 已提交
2134
				continue;
2135 2136 2137
			default:
				goto seqretry;
			}
N
Nick Piggin 已提交
2138
		}
2139

2140
		if (dentry->d_name.hash_len != hashlen)
2141
			continue;
2142
		*seqp = seq;
2143
		if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
2144
			return dentry;
N
Nick Piggin 已提交
2145 2146 2147 2148
	}
	return NULL;
}

L
Linus Torvalds 已提交
2149 2150 2151 2152
/**
 * d_lookup - search for a dentry
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2153
 * Returns: dentry, or NULL
L
Linus Torvalds 已提交
2154
 *
2155 2156 2157 2158
 * d_lookup searches the children of the parent dentry for the name in
 * question. If the dentry is found its reference count is incremented and the
 * dentry is returned. The caller must use dput to free the entry when it has
 * finished using it. %NULL is returned if the dentry does not exist.
L
Linus Torvalds 已提交
2159
 */
A
Al Viro 已提交
2160
struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
L
Linus Torvalds 已提交
2161
{
N
Nick Piggin 已提交
2162
	struct dentry *dentry;
2163
	unsigned seq;
L
Linus Torvalds 已提交
2164

2165 2166 2167 2168
	do {
		seq = read_seqbegin(&rename_lock);
		dentry = __d_lookup(parent, name);
		if (dentry)
L
Linus Torvalds 已提交
2169 2170 2171 2172
			break;
	} while (read_seqretry(&rename_lock, seq));
	return dentry;
}
2173
EXPORT_SYMBOL(d_lookup);
L
Linus Torvalds 已提交
2174

N
Nick Piggin 已提交
2175
/**
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
 * __d_lookup - search for a dentry (racy)
 * @parent: parent dentry
 * @name: qstr of name we wish to find
 * Returns: dentry, or NULL
 *
 * __d_lookup is like d_lookup, however it may (rarely) return a
 * false-negative result due to unrelated rename activity.
 *
 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
 * however it must be used carefully, eg. with a following d_lookup in
 * the case of failure.
 *
 * __d_lookup callers must be commented.
 */
A
Al Viro 已提交
2190
struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
L
Linus Torvalds 已提交
2191 2192 2193 2194
{
	unsigned int len = name->len;
	unsigned int hash = name->hash;
	const unsigned char *str = name->name;
2195
	struct hlist_bl_head *b = d_hash(parent, hash);
2196
	struct hlist_bl_node *node;
N
Nick Piggin 已提交
2197
	struct dentry *found = NULL;
2198
	struct dentry *dentry;
L
Linus Torvalds 已提交
2199

N
Nick Piggin 已提交
2200 2201 2202 2203 2204 2205 2206
	/*
	 * Note: There is significant duplication with __d_lookup_rcu which is
	 * required to prevent single threaded performance regressions
	 * especially on architectures where smp_rmb (in seqcounts) are costly.
	 * Keep the two functions in sync.
	 */

2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
	/*
	 * The hash list is protected using RCU.
	 *
	 * Take d_lock when comparing a candidate dentry, to avoid races
	 * with d_move().
	 *
	 * It is possible that concurrent renames can mess up our list
	 * walk here and result in missing our dentry, resulting in the
	 * false-negative result. d_lookup() protects against concurrent
	 * renames using rename_lock seqlock.
	 *
2218
	 * See Documentation/filesystems/path-lookup.txt for more details.
2219
	 */
L
Linus Torvalds 已提交
2220 2221
	rcu_read_lock();
	
2222
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
L
Linus Torvalds 已提交
2223 2224 2225 2226 2227 2228 2229

		if (dentry->d_name.hash != hash)
			continue;

		spin_lock(&dentry->d_lock);
		if (dentry->d_parent != parent)
			goto next;
2230 2231 2232
		if (d_unhashed(dentry))
			goto next;

L
Linus Torvalds 已提交
2233 2234 2235 2236
		/*
		 * It is safe to compare names since d_move() cannot
		 * change the qstr (protected by d_lock).
		 */
2237
		if (parent->d_flags & DCACHE_OP_COMPARE) {
2238 2239
			int tlen = dentry->d_name.len;
			const char *tname = dentry->d_name.name;
2240
			if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
L
Linus Torvalds 已提交
2241 2242
				goto next;
		} else {
2243 2244
			if (dentry->d_name.len != len)
				goto next;
2245
			if (dentry_cmp(dentry, str, len))
L
Linus Torvalds 已提交
2246 2247 2248
				goto next;
		}

2249
		dentry->d_lockref.count++;
2250
		found = dentry;
L
Linus Torvalds 已提交
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
		spin_unlock(&dentry->d_lock);
		break;
next:
		spin_unlock(&dentry->d_lock);
 	}
 	rcu_read_unlock();

 	return found;
}

2261 2262 2263 2264 2265
/**
 * d_hash_and_lookup - hash the qstr then search for a dentry
 * @dir: Directory to search in
 * @name: qstr of name we wish to find
 *
2266
 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
2267 2268 2269 2270 2271 2272 2273 2274 2275
 */
struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
{
	/*
	 * Check for a fs-specific hash function. Note that we must
	 * calculate the standard hash first, as the d_op->d_hash()
	 * routine may choose to leave the hash value unchanged.
	 */
	name->hash = full_name_hash(name->name, name->len);
2276
	if (dir->d_flags & DCACHE_OP_HASH) {
2277
		int err = dir->d_op->d_hash(dir, name);
2278 2279
		if (unlikely(err < 0))
			return ERR_PTR(err);
2280
	}
2281
	return d_lookup(dir, name);
2282
}
2283
EXPORT_SYMBOL(d_hash_and_lookup);
2284

L
Linus Torvalds 已提交
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
/*
 * When a file is deleted, we have two options:
 * - turn this dentry into a negative dentry
 * - unhash this dentry and free it.
 *
 * Usually, we want to just turn this into
 * a negative dentry, but if anybody else is
 * currently using the dentry or the inode
 * we can't do that and we fall back on removing
 * it from the hash queues and waiting for
 * it to be deleted later when it has no users
 */
 
/**
 * d_delete - delete a dentry
 * @dentry: The dentry to delete
 *
 * Turn the dentry into a negative dentry if possible, otherwise
 * remove it from the hash queues so it can be deleted later
 */
 
void d_delete(struct dentry * dentry)
{
2308
	struct inode *inode;
2309
	int isdir = 0;
L
Linus Torvalds 已提交
2310 2311 2312
	/*
	 * Are we the only user?
	 */
2313
again:
L
Linus Torvalds 已提交
2314
	spin_lock(&dentry->d_lock);
2315 2316
	inode = dentry->d_inode;
	isdir = S_ISDIR(inode->i_mode);
2317
	if (dentry->d_lockref.count == 1) {
A
Alan Cox 已提交
2318
		if (!spin_trylock(&inode->i_lock)) {
2319 2320 2321 2322
			spin_unlock(&dentry->d_lock);
			cpu_relax();
			goto again;
		}
A
Al Viro 已提交
2323
		dentry->d_flags &= ~DCACHE_CANT_MOUNT;
N
Nick Piggin 已提交
2324
		dentry_unlink_inode(dentry);
2325
		fsnotify_nameremove(dentry, isdir);
L
Linus Torvalds 已提交
2326 2327 2328 2329 2330 2331 2332
		return;
	}

	if (!d_unhashed(dentry))
		__d_drop(dentry);

	spin_unlock(&dentry->d_lock);
2333 2334

	fsnotify_nameremove(dentry, isdir);
L
Linus Torvalds 已提交
2335
}
2336
EXPORT_SYMBOL(d_delete);
L
Linus Torvalds 已提交
2337

2338
static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
L
Linus Torvalds 已提交
2339
{
2340
	BUG_ON(!d_unhashed(entry));
2341
	hlist_bl_lock(b);
2342
	entry->d_flags |= DCACHE_RCUACCESS;
2343
	hlist_bl_add_head_rcu(&entry->d_hash, b);
2344
	hlist_bl_unlock(b);
L
Linus Torvalds 已提交
2345 2346
}

2347 2348 2349 2350 2351
static void _d_rehash(struct dentry * entry)
{
	__d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
}

L
Linus Torvalds 已提交
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
/**
 * d_rehash	- add an entry back to the hash
 * @entry: dentry to add to the hash
 *
 * Adds a dentry to the hash according to its name.
 */
 
void d_rehash(struct dentry * entry)
{
	spin_lock(&entry->d_lock);
2362
	_d_rehash(entry);
L
Linus Torvalds 已提交
2363 2364
	spin_unlock(&entry->d_lock);
}
2365
EXPORT_SYMBOL(d_rehash);
L
Linus Torvalds 已提交
2366

A
Al Viro 已提交
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382
static inline unsigned start_dir_add(struct inode *dir)
{

	for (;;) {
		unsigned n = dir->i_dir_seq;
		if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
			return n;
		cpu_relax();
	}
}

static inline void end_dir_add(struct inode *dir, unsigned n)
{
	smp_store_release(&dir->i_dir_seq, n + 2);
}

2383 2384 2385 2386 2387 2388
void __d_lookup_done(struct dentry *dentry)
{
	dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
	/* more stuff will land here */
}
EXPORT_SYMBOL(__d_lookup_done);
A
Al Viro 已提交
2389 2390 2391 2392 2393

/* inode->i_lock held if inode is non-NULL */

static inline void __d_add(struct dentry *dentry, struct inode *inode)
{
A
Al Viro 已提交
2394 2395
	struct inode *dir = NULL;
	unsigned n;
A
Al Viro 已提交
2396
	spin_lock(&dentry->d_lock);
A
Al Viro 已提交
2397 2398 2399
	if (unlikely(d_in_lookup(dentry))) {
		dir = dentry->d_parent->d_inode;
		n = start_dir_add(dir);
2400
		__d_lookup_done(dentry);
A
Al Viro 已提交
2401
	}
A
Al Viro 已提交
2402
	if (inode) {
A
Al Viro 已提交
2403 2404 2405 2406 2407 2408
		unsigned add_flags = d_flags_for_inode(inode);
		hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
		raw_write_seqcount_begin(&dentry->d_seq);
		__d_set_inode_and_type(dentry, inode, add_flags);
		raw_write_seqcount_end(&dentry->d_seq);
		__fsnotify_d_instantiate(dentry);
A
Al Viro 已提交
2409
	}
A
Al Viro 已提交
2410
	_d_rehash(dentry);
A
Al Viro 已提交
2411 2412
	if (dir)
		end_dir_add(dir, n);
A
Al Viro 已提交
2413 2414 2415
	spin_unlock(&dentry->d_lock);
	if (inode)
		spin_unlock(&inode->i_lock);
A
Al Viro 已提交
2416 2417
}

A
Al Viro 已提交
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
/**
 * d_add - add dentry to hash queues
 * @entry: dentry to add
 * @inode: The inode to attach to this dentry
 *
 * This adds the entry to the hash queues and initializes @inode.
 * The entry was actually filled in earlier during d_alloc().
 */

void d_add(struct dentry *entry, struct inode *inode)
{
2429 2430
	if (inode) {
		security_d_instantiate(entry, inode);
A
Al Viro 已提交
2431
		spin_lock(&inode->i_lock);
2432
	}
A
Al Viro 已提交
2433
	__d_add(entry, inode);
A
Al Viro 已提交
2434 2435 2436
}
EXPORT_SYMBOL(d_add);

2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
/**
 * d_exact_alias - find and hash an exact unhashed alias
 * @entry: dentry to add
 * @inode: The inode to go with this dentry
 *
 * If an unhashed dentry with the same name/parent and desired
 * inode already exists, hash and return it.  Otherwise, return
 * NULL.
 *
 * Parent directory should be locked.
 */
struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
{
	struct dentry *alias;
	int len = entry->d_name.len;
	const char *name = entry->d_name.name;
	unsigned int hash = entry->d_name.hash;

	spin_lock(&inode->i_lock);
	hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
		/*
		 * Don't need alias->d_lock here, because aliases with
		 * d_parent == entry->d_parent are not subject to name or
		 * parent changes, because the parent inode i_mutex is held.
		 */
		if (alias->d_name.hash != hash)
			continue;
		if (alias->d_parent != entry->d_parent)
			continue;
		if (alias->d_name.len != len)
			continue;
		if (dentry_cmp(alias, name, len))
			continue;
		spin_lock(&alias->d_lock);
		if (!d_unhashed(alias)) {
			spin_unlock(&alias->d_lock);
			alias = NULL;
		} else {
			__dget_dlock(alias);
			_d_rehash(alias);
			spin_unlock(&alias->d_lock);
		}
		spin_unlock(&inode->i_lock);
		return alias;
	}
	spin_unlock(&inode->i_lock);
	return NULL;
}
EXPORT_SYMBOL(d_exact_alias);

N
Nick Piggin 已提交
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
/**
 * dentry_update_name_case - update case insensitive dentry with a new name
 * @dentry: dentry to be updated
 * @name: new name
 *
 * Update a case insensitive dentry with new case of name.
 *
 * dentry must have been returned by d_lookup with name @name. Old and new
 * name lengths must match (ie. no d_compare which allows mismatched name
 * lengths).
 *
 * Parent inode i_mutex must be held over d_lookup and into this call (to
 * keep renames and concurrent inserts, and readdir(2) away).
 */
void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
{
A
Al Viro 已提交
2503
	BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
N
Nick Piggin 已提交
2504 2505 2506
	BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */

	spin_lock(&dentry->d_lock);
N
Nick Piggin 已提交
2507
	write_seqcount_begin(&dentry->d_seq);
N
Nick Piggin 已提交
2508
	memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
N
Nick Piggin 已提交
2509
	write_seqcount_end(&dentry->d_seq);
N
Nick Piggin 已提交
2510 2511 2512 2513
	spin_unlock(&dentry->d_lock);
}
EXPORT_SYMBOL(dentry_update_name_case);

2514
static void swap_names(struct dentry *dentry, struct dentry *target)
L
Linus Torvalds 已提交
2515
{
2516 2517
	if (unlikely(dname_external(target))) {
		if (unlikely(dname_external(dentry))) {
L
Linus Torvalds 已提交
2518 2519 2520
			/*
			 * Both external: swap the pointers
			 */
2521
			swap(target->d_name.name, dentry->d_name.name);
L
Linus Torvalds 已提交
2522 2523 2524 2525 2526
		} else {
			/*
			 * dentry:internal, target:external.  Steal target's
			 * storage and make target internal.
			 */
2527 2528
			memcpy(target->d_iname, dentry->d_name.name,
					dentry->d_name.len + 1);
L
Linus Torvalds 已提交
2529 2530 2531 2532
			dentry->d_name.name = target->d_name.name;
			target->d_name.name = target->d_iname;
		}
	} else {
2533
		if (unlikely(dname_external(dentry))) {
L
Linus Torvalds 已提交
2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
			/*
			 * dentry:external, target:internal.  Give dentry's
			 * storage to target and make dentry internal
			 */
			memcpy(dentry->d_iname, target->d_name.name,
					target->d_name.len + 1);
			target->d_name.name = dentry->d_name.name;
			dentry->d_name.name = dentry->d_iname;
		} else {
			/*
M
Miklos Szeredi 已提交
2544
			 * Both are internal.
L
Linus Torvalds 已提交
2545
			 */
M
Miklos Szeredi 已提交
2546 2547
			unsigned int i;
			BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2548 2549
			kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
			kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
M
Miklos Szeredi 已提交
2550 2551 2552 2553
			for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
				swap(((long *) &dentry->d_iname)[i],
				     ((long *) &target->d_iname)[i]);
			}
L
Linus Torvalds 已提交
2554 2555
		}
	}
2556
	swap(dentry->d_name.hash_len, target->d_name.hash_len);
L
Linus Torvalds 已提交
2557 2558
}

2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
static void copy_name(struct dentry *dentry, struct dentry *target)
{
	struct external_name *old_name = NULL;
	if (unlikely(dname_external(dentry)))
		old_name = external_name(dentry);
	if (unlikely(dname_external(target))) {
		atomic_inc(&external_name(target)->u.count);
		dentry->d_name = target->d_name;
	} else {
		memcpy(dentry->d_iname, target->d_name.name,
				target->d_name.len + 1);
		dentry->d_name.name = dentry->d_iname;
		dentry->d_name.hash_len = target->d_name.hash_len;
	}
	if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
		kfree_rcu(old_name, u.head);
}

N
Nick Piggin 已提交
2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603
static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
{
	/*
	 * XXXX: do we really need to take target->d_lock?
	 */
	if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
		spin_lock(&target->d_parent->d_lock);
	else {
		if (d_ancestor(dentry->d_parent, target->d_parent)) {
			spin_lock(&dentry->d_parent->d_lock);
			spin_lock_nested(&target->d_parent->d_lock,
						DENTRY_D_LOCK_NESTED);
		} else {
			spin_lock(&target->d_parent->d_lock);
			spin_lock_nested(&dentry->d_parent->d_lock,
						DENTRY_D_LOCK_NESTED);
		}
	}
	if (target < dentry) {
		spin_lock_nested(&target->d_lock, 2);
		spin_lock_nested(&dentry->d_lock, 3);
	} else {
		spin_lock_nested(&dentry->d_lock, 2);
		spin_lock_nested(&target->d_lock, 3);
	}
}

2604
static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
N
Nick Piggin 已提交
2605 2606 2607 2608 2609
{
	if (target->d_parent != dentry->d_parent)
		spin_unlock(&dentry->d_parent->d_lock);
	if (target->d_parent != target)
		spin_unlock(&target->d_parent->d_lock);
2610 2611
	spin_unlock(&target->d_lock);
	spin_unlock(&dentry->d_lock);
N
Nick Piggin 已提交
2612 2613
}

L
Linus Torvalds 已提交
2614
/*
N
Nick Piggin 已提交
2615 2616 2617
 * When switching names, the actual string doesn't strictly have to
 * be preserved in the target - because we're dropping the target
 * anyway. As such, we can just do a simple memcpy() to copy over
2618 2619 2620 2621 2622 2623 2624 2625 2626
 * the new name before we switch, unless we are going to rehash
 * it.  Note that if we *do* unhash the target, we are not allowed
 * to rehash it without giving it a new name/hash key - whether
 * we swap or overwrite the names here, resulting name won't match
 * the reality in filesystem; it's only there for d_path() purposes.
 * Note that all of this is happening under rename_lock, so the
 * any hash lookup seeing it in the middle of manipulations will
 * be discarded anyway.  So we do not care what happens to the hash
 * key in that case.
L
Linus Torvalds 已提交
2627
 */
2628
/*
2629
 * __d_move - move a dentry
L
Linus Torvalds 已提交
2630 2631
 * @dentry: entry to move
 * @target: new dentry
M
Miklos Szeredi 已提交
2632
 * @exchange: exchange the two dentries
L
Linus Torvalds 已提交
2633 2634
 *
 * Update the dcache to reflect the move of a file name. Negative
2635 2636 2637
 * dcache entries should not be moved in this way. Caller must hold
 * rename_lock, the i_mutex of the source and target directories,
 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
L
Linus Torvalds 已提交
2638
 */
M
Miklos Szeredi 已提交
2639 2640
static void __d_move(struct dentry *dentry, struct dentry *target,
		     bool exchange)
L
Linus Torvalds 已提交
2641
{
A
Al Viro 已提交
2642 2643
	struct inode *dir = NULL;
	unsigned n;
L
Linus Torvalds 已提交
2644 2645 2646
	if (!dentry->d_inode)
		printk(KERN_WARNING "VFS: moving negative dcache entry\n");

N
Nick Piggin 已提交
2647 2648 2649 2650
	BUG_ON(d_ancestor(dentry, target));
	BUG_ON(d_ancestor(target, dentry));

	dentry_lock_for_move(dentry, target);
A
Al Viro 已提交
2651 2652 2653
	if (unlikely(d_in_lookup(target))) {
		dir = target->d_parent->d_inode;
		n = start_dir_add(dir);
2654
		__d_lookup_done(target);
A
Al Viro 已提交
2655
	}
L
Linus Torvalds 已提交
2656

N
Nick Piggin 已提交
2657
	write_seqcount_begin(&dentry->d_seq);
2658
	write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
N
Nick Piggin 已提交
2659

2660 2661 2662 2663 2664 2665 2666
	/* __d_drop does write_seqcount_barrier, but they're OK to nest. */

	/*
	 * Move the dentry to the target hash queue. Don't bother checking
	 * for the same hash queue because of how unlikely it is.
	 */
	__d_drop(dentry);
N
Nick Piggin 已提交
2667
	__d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
L
Linus Torvalds 已提交
2668

M
Miklos Szeredi 已提交
2669 2670 2671 2672
	/*
	 * Unhash the target (d_delete() is not usable here).  If exchanging
	 * the two dentries, then rehash onto the other's hash queue.
	 */
L
Linus Torvalds 已提交
2673
	__d_drop(target);
M
Miklos Szeredi 已提交
2674 2675 2676 2677
	if (exchange) {
		__d_rehash(target,
			   d_hash(dentry->d_parent, dentry->d_name.hash));
	}
L
Linus Torvalds 已提交
2678 2679

	/* Switch the names.. */
2680 2681 2682 2683
	if (exchange)
		swap_names(dentry, target);
	else
		copy_name(dentry, target);
L
Linus Torvalds 已提交
2684

A
Al Viro 已提交
2685
	/* ... and switch them in the tree */
L
Linus Torvalds 已提交
2686
	if (IS_ROOT(dentry)) {
A
Al Viro 已提交
2687
		/* splicing a tree */
L
Linus Torvalds 已提交
2688 2689
		dentry->d_parent = target->d_parent;
		target->d_parent = target;
2690 2691
		list_del_init(&target->d_child);
		list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
L
Linus Torvalds 已提交
2692
	} else {
A
Al Viro 已提交
2693
		/* swapping two dentries */
2694
		swap(dentry->d_parent, target->d_parent);
2695 2696
		list_move(&target->d_child, &target->d_parent->d_subdirs);
		list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
A
Al Viro 已提交
2697 2698 2699
		if (exchange)
			fsnotify_d_move(target);
		fsnotify_d_move(dentry);
L
Linus Torvalds 已提交
2700 2701
	}

N
Nick Piggin 已提交
2702 2703 2704
	write_seqcount_end(&target->d_seq);
	write_seqcount_end(&dentry->d_seq);

A
Al Viro 已提交
2705 2706
	if (dir)
		end_dir_add(dir, n);
2707
	dentry_unlock_for_move(dentry, target);
2708 2709 2710 2711 2712 2713 2714 2715
}

/*
 * d_move - move a dentry
 * @dentry: entry to move
 * @target: new dentry
 *
 * Update the dcache to reflect the move of a file name. Negative
2716 2717
 * dcache entries should not be moved in this way. See the locking
 * requirements for __d_move.
2718 2719 2720 2721
 */
void d_move(struct dentry *dentry, struct dentry *target)
{
	write_seqlock(&rename_lock);
M
Miklos Szeredi 已提交
2722
	__d_move(dentry, target, false);
L
Linus Torvalds 已提交
2723
	write_sequnlock(&rename_lock);
2724
}
2725
EXPORT_SYMBOL(d_move);
L
Linus Torvalds 已提交
2726

M
Miklos Szeredi 已提交
2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
/*
 * d_exchange - exchange two dentries
 * @dentry1: first dentry
 * @dentry2: second dentry
 */
void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
{
	write_seqlock(&rename_lock);

	WARN_ON(!dentry1->d_inode);
	WARN_ON(!dentry2->d_inode);
	WARN_ON(IS_ROOT(dentry1));
	WARN_ON(IS_ROOT(dentry2));

	__d_move(dentry1, dentry2, true);

	write_sequnlock(&rename_lock);
}

2746 2747 2748 2749 2750 2751 2752
/**
 * d_ancestor - search for an ancestor
 * @p1: ancestor dentry
 * @p2: child dentry
 *
 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
 * an ancestor of p2, else NULL.
2753
 */
2754
struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
2755 2756 2757
{
	struct dentry *p;

2758
	for (p = p2; !IS_ROOT(p); p = p->d_parent) {
2759
		if (p->d_parent == p1)
2760
			return p;
2761
	}
2762
	return NULL;
2763 2764 2765 2766 2767 2768
}

/*
 * This helper attempts to cope with remotely renamed directories
 *
 * It assumes that the caller is already holding
2769
 * dentry->d_parent->d_inode->i_mutex, and rename_lock
2770 2771 2772 2773
 *
 * Note: If ever the locking in lock_rename() changes, then please
 * remember to update this too...
 */
2774
static int __d_unalias(struct inode *inode,
2775
		struct dentry *dentry, struct dentry *alias)
2776 2777
{
	struct mutex *m1 = NULL, *m2 = NULL;
2778
	int ret = -ESTALE;
2779 2780 2781 2782 2783 2784 2785 2786 2787

	/* If alias and dentry share a parent, then no extra locks required */
	if (alias->d_parent == dentry->d_parent)
		goto out_unalias;

	/* See lock_rename() */
	if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
		goto out_err;
	m1 = &dentry->d_sb->s_vfs_rename_mutex;
A
Al Viro 已提交
2788
	if (!inode_trylock(alias->d_parent->d_inode))
2789 2790 2791
		goto out_err;
	m2 = &alias->d_parent->d_inode->i_mutex;
out_unalias:
2792
	__d_move(alias, dentry, false);
2793
	ret = 0;
2794 2795 2796 2797 2798 2799 2800 2801
out_err:
	if (m2)
		mutex_unlock(m2);
	if (m1)
		mutex_unlock(m1);
	return ret;
}

J
J. Bruce Fields 已提交
2802 2803 2804 2805 2806
/**
 * d_splice_alias - splice a disconnected dentry into the tree if one exists
 * @inode:  the inode which may have a disconnected dentry
 * @dentry: a negative dentry which we want to point to the inode.
 *
2807 2808 2809
 * If inode is a directory and has an IS_ROOT alias, then d_move that in
 * place of the given dentry and return it, else simply d_add the inode
 * to the dentry and return NULL.
J
J. Bruce Fields 已提交
2810
 *
2811 2812 2813
 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
 * we should error out: directories can't have multiple aliases.
 *
J
J. Bruce Fields 已提交
2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
 * This is needed in the lookup routine of any filesystem that is exportable
 * (via knfsd) so that we can build dcache paths to directories effectively.
 *
 * If a dentry was found and moved, then it is returned.  Otherwise NULL
 * is returned.  This matches the expected return value of ->lookup.
 *
 * Cluster filesystems may call this function with a negative, hashed dentry.
 * In that case, we know that the inode will be a regular file, and also this
 * will only occur during atomic_open. So we need to check for the dentry
 * being already hashed only in the final case.
 */
struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
{
	if (IS_ERR(inode))
		return ERR_CAST(inode);

2830 2831
	BUG_ON(!d_unhashed(dentry));

2832
	if (!inode)
2833
		goto out;
2834

2835
	security_d_instantiate(dentry, inode);
2836
	spin_lock(&inode->i_lock);
2837
	if (S_ISDIR(inode->i_mode)) {
2838 2839
		struct dentry *new = __d_find_any_alias(inode);
		if (unlikely(new)) {
2840 2841
			/* The reference to new ensures it remains an alias */
			spin_unlock(&inode->i_lock);
2842
			write_seqlock(&rename_lock);
2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
			if (unlikely(d_ancestor(new, dentry))) {
				write_sequnlock(&rename_lock);
				dput(new);
				new = ERR_PTR(-ELOOP);
				pr_warn_ratelimited(
					"VFS: Lookup of '%s' in %s %s"
					" would have caused loop\n",
					dentry->d_name.name,
					inode->i_sb->s_type->name,
					inode->i_sb->s_id);
			} else if (!IS_ROOT(new)) {
				int err = __d_unalias(inode, dentry, new);
2855
				write_sequnlock(&rename_lock);
2856 2857 2858 2859
				if (err) {
					dput(new);
					new = ERR_PTR(err);
				}
2860
			} else {
2861 2862
				__d_move(new, dentry, false);
				write_sequnlock(&rename_lock);
2863
			}
2864 2865
			iput(inode);
			return new;
2866
		}
2867
	}
2868
out:
A
Al Viro 已提交
2869
	__d_add(dentry, inode);
2870
	return NULL;
2871
}
2872
EXPORT_SYMBOL(d_splice_alias);
2873

2874
static int prepend(char **buffer, int *buflen, const char *str, int namelen)
2875 2876 2877 2878 2879 2880 2881 2882 2883
{
	*buflen -= namelen;
	if (*buflen < 0)
		return -ENAMETOOLONG;
	*buffer -= namelen;
	memcpy(*buffer, str, namelen);
	return 0;
}

2884 2885
/**
 * prepend_name - prepend a pathname in front of current buffer pointer
2886 2887 2888
 * @buffer: buffer pointer
 * @buflen: allocated length of the buffer
 * @name:   name string and length qstr structure
2889 2890 2891 2892 2893 2894 2895 2896 2897
 *
 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
 * make sure that either the old or the new name pointer and length are
 * fetched. However, there may be mismatch between length and pointer.
 * The length cannot be trusted, we need to copy it byte-by-byte until
 * the length is reached or a null byte is found. It also prepends "/" at
 * the beginning of the name. The sequence number check at the caller will
 * retry it again when a d_move() does happen. So any garbage in the buffer
 * due to mismatched pointer and length will be discarded.
2898 2899 2900
 *
 * Data dependency barrier is needed to make sure that we see that terminating
 * NUL.  Alpha strikes again, film at 11...
2901
 */
2902 2903
static int prepend_name(char **buffer, int *buflen, struct qstr *name)
{
2904 2905 2906 2907
	const char *dname = ACCESS_ONCE(name->name);
	u32 dlen = ACCESS_ONCE(name->len);
	char *p;

2908 2909
	smp_read_barrier_depends();

2910
	*buflen -= dlen + 1;
2911 2912
	if (*buflen < 0)
		return -ENAMETOOLONG;
2913 2914 2915 2916 2917 2918 2919 2920 2921
	p = *buffer -= dlen + 1;
	*p++ = '/';
	while (dlen--) {
		char c = *dname++;
		if (!c)
			break;
		*p++ = c;
	}
	return 0;
2922 2923
}

L
Linus Torvalds 已提交
2924
/**
2925
 * prepend_path - Prepend path string to a buffer
2926
 * @path: the dentry/vfsmount to report
2927
 * @root: root vfsmnt/dentry
M
Miklos Szeredi 已提交
2928 2929
 * @buffer: pointer to the end of the buffer
 * @buflen: pointer to buffer length
2930
 *
2931 2932 2933 2934 2935 2936 2937 2938 2939
 * The function will first try to write out the pathname without taking any
 * lock other than the RCU read lock to make sure that dentries won't go away.
 * It only checks the sequence number of the global rename_lock as any change
 * in the dentry's d_seq will be preceded by changes in the rename_lock
 * sequence number. If the sequence number had been changed, it will restart
 * the whole pathname back-tracing sequence again by taking the rename_lock.
 * In this case, there is no need to take the RCU read lock as the recursive
 * parent pointer references will keep the dentry chain alive as long as no
 * rename operation is performed.
L
Linus Torvalds 已提交
2940
 */
2941 2942
static int prepend_path(const struct path *path,
			const struct path *root,
M
Miklos Szeredi 已提交
2943
			char **buffer, int *buflen)
L
Linus Torvalds 已提交
2944
{
2945 2946 2947
	struct dentry *dentry;
	struct vfsmount *vfsmnt;
	struct mount *mnt;
M
Miklos Szeredi 已提交
2948
	int error = 0;
A
Al Viro 已提交
2949
	unsigned seq, m_seq = 0;
2950 2951
	char *bptr;
	int blen;
2952

2953
	rcu_read_lock();
A
Al Viro 已提交
2954 2955 2956
restart_mnt:
	read_seqbegin_or_lock(&mount_lock, &m_seq);
	seq = 0;
L
Li Zhong 已提交
2957
	rcu_read_lock();
2958 2959 2960
restart:
	bptr = *buffer;
	blen = *buflen;
A
Al Viro 已提交
2961
	error = 0;
2962 2963 2964
	dentry = path->dentry;
	vfsmnt = path->mnt;
	mnt = real_mount(vfsmnt);
2965
	read_seqbegin_or_lock(&rename_lock, &seq);
M
Miklos Szeredi 已提交
2966
	while (dentry != root->dentry || vfsmnt != root->mnt) {
L
Linus Torvalds 已提交
2967 2968 2969
		struct dentry * parent;

		if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
A
Al Viro 已提交
2970
			struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
2971 2972 2973 2974 2975 2976 2977
			/* Escaped? */
			if (dentry != vfsmnt->mnt_root) {
				bptr = *buffer;
				blen = *buflen;
				error = 3;
				break;
			}
2978
			/* Global root? */
A
Al Viro 已提交
2979 2980 2981
			if (mnt != parent) {
				dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
				mnt = parent;
2982 2983 2984 2985 2986 2987
				vfsmnt = &mnt->mnt;
				continue;
			}
			if (!error)
				error = is_mounted(vfsmnt) ? 1 : 2;
			break;
L
Linus Torvalds 已提交
2988 2989 2990
		}
		parent = dentry->d_parent;
		prefetch(parent);
2991
		error = prepend_name(&bptr, &blen, &dentry->d_name);
M
Miklos Szeredi 已提交
2992 2993 2994
		if (error)
			break;

L
Linus Torvalds 已提交
2995 2996
		dentry = parent;
	}
2997 2998 2999 3000
	if (!(seq & 1))
		rcu_read_unlock();
	if (need_seqretry(&rename_lock, seq)) {
		seq = 1;
3001
		goto restart;
3002 3003
	}
	done_seqretry(&rename_lock, seq);
L
Li Zhong 已提交
3004 3005 3006

	if (!(m_seq & 1))
		rcu_read_unlock();
A
Al Viro 已提交
3007 3008 3009 3010 3011
	if (need_seqretry(&mount_lock, m_seq)) {
		m_seq = 1;
		goto restart_mnt;
	}
	done_seqretry(&mount_lock, m_seq);
L
Linus Torvalds 已提交
3012

3013 3014 3015 3016 3017 3018 3019 3020
	if (error >= 0 && bptr == *buffer) {
		if (--blen < 0)
			error = -ENAMETOOLONG;
		else
			*--bptr = '/';
	}
	*buffer = bptr;
	*buflen = blen;
A
Al Viro 已提交
3021
	return error;
M
Miklos Szeredi 已提交
3022
}
3023

M
Miklos Szeredi 已提交
3024 3025 3026
/**
 * __d_path - return the path of a dentry
 * @path: the dentry/vfsmount to report
3027
 * @root: root vfsmnt/dentry
3028
 * @buf: buffer to return value in
M
Miklos Szeredi 已提交
3029 3030
 * @buflen: buffer length
 *
3031
 * Convert a dentry into an ASCII path name.
M
Miklos Szeredi 已提交
3032 3033 3034 3035
 *
 * Returns a pointer into the buffer or an error code if the
 * path was too long.
 *
3036
 * "buflen" should be positive.
M
Miklos Szeredi 已提交
3037
 *
3038
 * If the path is not reachable from the supplied root, return %NULL.
M
Miklos Szeredi 已提交
3039
 */
3040 3041
char *__d_path(const struct path *path,
	       const struct path *root,
M
Miklos Szeredi 已提交
3042 3043 3044 3045 3046 3047 3048
	       char *buf, int buflen)
{
	char *res = buf + buflen;
	int error;

	prepend(&res, &buflen, "\0", 1);
	error = prepend_path(path, root, &res, &buflen);
3049

3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069
	if (error < 0)
		return ERR_PTR(error);
	if (error > 0)
		return NULL;
	return res;
}

char *d_absolute_path(const struct path *path,
	       char *buf, int buflen)
{
	struct path root = {};
	char *res = buf + buflen;
	int error;

	prepend(&res, &buflen, "\0", 1);
	error = prepend_path(path, &root, &res, &buflen);

	if (error > 1)
		error = -EINVAL;
	if (error < 0)
M
Miklos Szeredi 已提交
3070 3071
		return ERR_PTR(error);
	return res;
L
Linus Torvalds 已提交
3072 3073
}

3074 3075 3076
/*
 * same as __d_path but appends "(deleted)" for unlinked files.
 */
3077 3078 3079
static int path_with_deleted(const struct path *path,
			     const struct path *root,
			     char **buf, int *buflen)
3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090
{
	prepend(buf, buflen, "\0", 1);
	if (d_unlinked(path->dentry)) {
		int error = prepend(buf, buflen, " (deleted)", 10);
		if (error)
			return error;
	}

	return prepend_path(path, root, buf, buflen);
}

3091 3092 3093 3094 3095
static int prepend_unreachable(char **buffer, int *buflen)
{
	return prepend(buffer, buflen, "(unreachable)", 13);
}

3096 3097 3098 3099 3100 3101 3102 3103 3104 3105
static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
{
	unsigned seq;

	do {
		seq = read_seqcount_begin(&fs->seq);
		*root = fs->root;
	} while (read_seqcount_retry(&fs->seq, seq));
}

J
Jan Blunck 已提交
3106 3107
/**
 * d_path - return the path of a dentry
3108
 * @path: path to report
J
Jan Blunck 已提交
3109 3110 3111 3112 3113 3114
 * @buf: buffer to return value in
 * @buflen: buffer length
 *
 * Convert a dentry into an ASCII path name. If the entry has been deleted
 * the string " (deleted)" is appended. Note that this is ambiguous.
 *
3115 3116 3117 3118
 * Returns a pointer into the buffer or an error code if the path was
 * too long. Note: Callers should use the returned pointer, not the passed
 * in buffer, to use the name! The implementation often starts at an offset
 * into the buffer, and may leave 0 bytes at the start.
J
Jan Blunck 已提交
3119
 *
3120
 * "buflen" should be positive.
J
Jan Blunck 已提交
3121
 */
3122
char *d_path(const struct path *path, char *buf, int buflen)
L
Linus Torvalds 已提交
3123
{
3124
	char *res = buf + buflen;
J
Jan Blunck 已提交
3125
	struct path root;
3126
	int error;
L
Linus Torvalds 已提交
3127

3128 3129 3130 3131 3132 3133
	/*
	 * We have various synthetic filesystems that never get mounted.  On
	 * these filesystems dentries are never used for lookup purposes, and
	 * thus don't need to be hashed.  They also don't need a name until a
	 * user wants to identify the object in /proc/pid/fd/.  The little hack
	 * below allows us to generate a name for these objects on demand:
3134 3135 3136 3137
	 *
	 * Some pseudo inodes are mountable.  When they are mounted
	 * path->dentry == path->mnt->mnt_root.  In that case don't call d_dname
	 * and instead have d_path return the mounted path.
3138
	 */
3139 3140
	if (path->dentry->d_op && path->dentry->d_op->d_dname &&
	    (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
3141
		return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
3142

3143 3144
	rcu_read_lock();
	get_fs_root_rcu(current->fs, &root);
3145
	error = path_with_deleted(path, &root, &res, &buflen);
3146 3147
	rcu_read_unlock();

3148
	if (error < 0)
3149
		res = ERR_PTR(error);
L
Linus Torvalds 已提交
3150 3151
	return res;
}
3152
EXPORT_SYMBOL(d_path);
L
Linus Torvalds 已提交
3153

3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
/*
 * Helper function for dentry_operations.d_dname() members
 */
char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
			const char *fmt, ...)
{
	va_list args;
	char temp[64];
	int sz;

	va_start(args, fmt);
	sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
	va_end(args);

	if (sz > sizeof(temp) || sz > buflen)
		return ERR_PTR(-ENAMETOOLONG);

	buffer += buflen - sz;
	return memcpy(buffer, temp, sz);
}

3175 3176 3177 3178 3179
char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
{
	char *end = buffer + buflen;
	/* these dentries are never renamed, so d_lock is not needed */
	if (prepend(&end, &buflen, " (deleted)", 11) ||
3180
	    prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
3181 3182
	    prepend(&end, &buflen, "/", 1))  
		end = ERR_PTR(-ENAMETOOLONG);
3183
	return end;
3184
}
3185
EXPORT_SYMBOL(simple_dname);
3186

3187 3188 3189
/*
 * Write full pathname from the root of the filesystem into the buffer.
 */
A
Al Viro 已提交
3190
static char *__dentry_path(struct dentry *d, char *buf, int buflen)
3191
{
A
Al Viro 已提交
3192
	struct dentry *dentry;
3193 3194 3195
	char *end, *retval;
	int len, seq = 0;
	int error = 0;
3196

A
Al Viro 已提交
3197 3198 3199
	if (buflen < 2)
		goto Elong;

3200
	rcu_read_lock();
3201
restart:
A
Al Viro 已提交
3202
	dentry = d;
3203 3204 3205
	end = buf + buflen;
	len = buflen;
	prepend(&end, &len, "\0", 1);
3206 3207 3208
	/* Get '/' right */
	retval = end-1;
	*retval = '/';
3209
	read_seqbegin_or_lock(&rename_lock, &seq);
3210 3211
	while (!IS_ROOT(dentry)) {
		struct dentry *parent = dentry->d_parent;
3212 3213

		prefetch(parent);
3214 3215 3216
		error = prepend_name(&end, &len, &dentry->d_name);
		if (error)
			break;
3217 3218 3219 3220

		retval = end;
		dentry = parent;
	}
3221 3222 3223 3224
	if (!(seq & 1))
		rcu_read_unlock();
	if (need_seqretry(&rename_lock, seq)) {
		seq = 1;
3225
		goto restart;
3226 3227
	}
	done_seqretry(&rename_lock, seq);
3228 3229
	if (error)
		goto Elong;
A
Al Viro 已提交
3230 3231 3232 3233
	return retval;
Elong:
	return ERR_PTR(-ENAMETOOLONG);
}
N
Nick Piggin 已提交
3234 3235 3236

char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
{
3237
	return __dentry_path(dentry, buf, buflen);
N
Nick Piggin 已提交
3238 3239
}
EXPORT_SYMBOL(dentry_path_raw);
A
Al Viro 已提交
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254

char *dentry_path(struct dentry *dentry, char *buf, int buflen)
{
	char *p = NULL;
	char *retval;

	if (d_unlinked(dentry)) {
		p = buf + buflen;
		if (prepend(&p, &buflen, "//deleted", 10) != 0)
			goto Elong;
		buflen++;
	}
	retval = __dentry_path(dentry, buf, buflen);
	if (!IS_ERR(retval) && p)
		*p = '/';	/* restore '/' overriden with '\0' */
3255 3256 3257 3258 3259
	return retval;
Elong:
	return ERR_PTR(-ENAMETOOLONG);
}

3260 3261
static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
				    struct path *pwd)
3262
{
3263 3264 3265 3266 3267 3268 3269
	unsigned seq;

	do {
		seq = read_seqcount_begin(&fs->seq);
		*root = fs->root;
		*pwd = fs->pwd;
	} while (read_seqcount_retry(&fs->seq, seq));
3270 3271
}

L
Linus Torvalds 已提交
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289
/*
 * NOTE! The user-level library version returns a
 * character pointer. The kernel system call just
 * returns the length of the buffer filled (which
 * includes the ending '\0' character), or a negative
 * error value. So libc would do something like
 *
 *	char *getcwd(char * buf, size_t size)
 *	{
 *		int retval;
 *
 *		retval = sys_getcwd(buf, size);
 *		if (retval >= 0)
 *			return buf;
 *		errno = -retval;
 *		return NULL;
 *	}
 */
3290
SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
L
Linus Torvalds 已提交
3291
{
3292
	int error;
J
Jan Blunck 已提交
3293
	struct path pwd, root;
3294
	char *page = __getname();
L
Linus Torvalds 已提交
3295 3296 3297 3298

	if (!page)
		return -ENOMEM;

3299 3300
	rcu_read_lock();
	get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
L
Linus Torvalds 已提交
3301

3302
	error = -ENOENT;
3303
	if (!d_unlinked(pwd.dentry)) {
3304
		unsigned long len;
3305 3306
		char *cwd = page + PATH_MAX;
		int buflen = PATH_MAX;
L
Linus Torvalds 已提交
3307

3308
		prepend(&cwd, &buflen, "\0", 1);
3309
		error = prepend_path(&pwd, &root, &cwd, &buflen);
3310
		rcu_read_unlock();
3311

3312
		if (error < 0)
3313 3314
			goto out;

3315
		/* Unreachable from current root */
3316
		if (error > 0) {
3317 3318 3319 3320 3321
			error = prepend_unreachable(&cwd, &buflen);
			if (error)
				goto out;
		}

3322
		error = -ERANGE;
3323
		len = PATH_MAX + page - cwd;
3324 3325 3326 3327 3328
		if (len <= size) {
			error = len;
			if (copy_to_user(buf, cwd, len))
				error = -EFAULT;
		}
3329
	} else {
3330
		rcu_read_unlock();
3331
	}
L
Linus Torvalds 已提交
3332 3333

out:
3334
	__putname(page);
L
Linus Torvalds 已提交
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348
	return error;
}

/*
 * Test whether new_dentry is a subdirectory of old_dentry.
 *
 * Trivially implemented using the dcache structure
 */

/**
 * is_subdir - is new dentry a subdirectory of old_dentry
 * @new_dentry: new dentry
 * @old_dentry: old dentry
 *
Y
Yaowei Bai 已提交
3349 3350
 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
 * Returns false otherwise.
L
Linus Torvalds 已提交
3351 3352 3353
 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
 */
  
Y
Yaowei Bai 已提交
3354
bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
L
Linus Torvalds 已提交
3355
{
Y
Yaowei Bai 已提交
3356
	bool result;
3357
	unsigned seq;
L
Linus Torvalds 已提交
3358

3359
	if (new_dentry == old_dentry)
Y
Yaowei Bai 已提交
3360
		return true;
3361 3362

	do {
L
Linus Torvalds 已提交
3363 3364
		/* for restarting inner loop in case of seq retry */
		seq = read_seqbegin(&rename_lock);
3365 3366 3367 3368 3369
		/*
		 * Need rcu_readlock to protect against the d_parent trashing
		 * due to d_move
		 */
		rcu_read_lock();
3370
		if (d_ancestor(old_dentry, new_dentry))
Y
Yaowei Bai 已提交
3371
			result = true;
3372
		else
Y
Yaowei Bai 已提交
3373
			result = false;
3374
		rcu_read_unlock();
L
Linus Torvalds 已提交
3375 3376 3377 3378 3379
	} while (read_seqretry(&rename_lock, seq));

	return result;
}

M
Miklos Szeredi 已提交
3380
static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
L
Linus Torvalds 已提交
3381
{
M
Miklos Szeredi 已提交
3382 3383 3384 3385
	struct dentry *root = data;
	if (dentry != root) {
		if (d_unhashed(dentry) || !dentry->d_inode)
			return D_WALK_SKIP;
L
Linus Torvalds 已提交
3386

M
Miklos Szeredi 已提交
3387 3388 3389 3390
		if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
			dentry->d_flags |= DCACHE_GENOCIDE;
			dentry->d_lockref.count--;
		}
L
Linus Torvalds 已提交
3391
	}
M
Miklos Szeredi 已提交
3392 3393
	return D_WALK_CONTINUE;
}
3394

M
Miklos Szeredi 已提交
3395 3396 3397
void d_genocide(struct dentry *parent)
{
	d_walk(parent, parent, d_genocide_kill, NULL);
L
Linus Torvalds 已提交
3398 3399
}

3400
void d_tmpfile(struct dentry *dentry, struct inode *inode)
L
Linus Torvalds 已提交
3401
{
3402 3403
	inode_dec_link_count(inode);
	BUG_ON(dentry->d_name.name != dentry->d_iname ||
3404
		!hlist_unhashed(&dentry->d_u.d_alias) ||
3405 3406 3407 3408 3409 3410 3411 3412
		!d_unlinked(dentry));
	spin_lock(&dentry->d_parent->d_lock);
	spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
	dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
				(unsigned long long)inode->i_ino);
	spin_unlock(&dentry->d_lock);
	spin_unlock(&dentry->d_parent->d_lock);
	d_instantiate(dentry, inode);
L
Linus Torvalds 已提交
3413
}
3414
EXPORT_SYMBOL(d_tmpfile);
L
Linus Torvalds 已提交
3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427

static __initdata unsigned long dhash_entries;
static int __init set_dhash_entries(char *str)
{
	if (!str)
		return 0;
	dhash_entries = simple_strtoul(str, &str, 0);
	return 1;
}
__setup("dhash_entries=", set_dhash_entries);

static void __init dcache_init_early(void)
{
3428
	unsigned int loop;
L
Linus Torvalds 已提交
3429 3430 3431 3432 3433 3434 3435 3436 3437

	/* If hashes are distributed across NUMA nodes, defer
	 * hash allocation until vmalloc space is available.
	 */
	if (hashdist)
		return;

	dentry_hashtable =
		alloc_large_system_hash("Dentry cache",
3438
					sizeof(struct hlist_bl_head),
L
Linus Torvalds 已提交
3439 3440 3441 3442 3443
					dhash_entries,
					13,
					HASH_EARLY,
					&d_hash_shift,
					&d_hash_mask,
3444
					0,
L
Linus Torvalds 已提交
3445 3446
					0);

3447
	for (loop = 0; loop < (1U << d_hash_shift); loop++)
3448
		INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
L
Linus Torvalds 已提交
3449 3450
}

3451
static void __init dcache_init(void)
L
Linus Torvalds 已提交
3452
{
3453
	unsigned int loop;
L
Linus Torvalds 已提交
3454 3455 3456 3457 3458 3459

	/* 
	 * A constructor could be added for stable state like the lists,
	 * but it is probably not worth it because of the cache nature
	 * of the dcache. 
	 */
3460
	dentry_cache = KMEM_CACHE(dentry,
3461
		SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
L
Linus Torvalds 已提交
3462 3463 3464 3465 3466 3467 3468

	/* Hash may have been set up in dcache_init_early */
	if (!hashdist)
		return;

	dentry_hashtable =
		alloc_large_system_hash("Dentry cache",
3469
					sizeof(struct hlist_bl_head),
L
Linus Torvalds 已提交
3470 3471 3472 3473 3474
					dhash_entries,
					13,
					0,
					&d_hash_shift,
					&d_hash_mask,
3475
					0,
L
Linus Torvalds 已提交
3476 3477
					0);

3478
	for (loop = 0; loop < (1U << d_hash_shift); loop++)
3479
		INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
L
Linus Torvalds 已提交
3480 3481 3482
}

/* SLAB cache for __getname() consumers */
3483
struct kmem_cache *names_cachep __read_mostly;
3484
EXPORT_SYMBOL(names_cachep);
L
Linus Torvalds 已提交
3485 3486 3487 3488 3489 3490 3491 3492 3493

EXPORT_SYMBOL(d_genocide);

void __init vfs_caches_init_early(void)
{
	dcache_init_early();
	inode_init_early();
}

3494
void __init vfs_caches_init(void)
L
Linus Torvalds 已提交
3495 3496
{
	names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
3497
			SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
L
Linus Torvalds 已提交
3498

3499 3500
	dcache_init();
	inode_init();
3501 3502
	files_init();
	files_maxfiles_init();
3503
	mnt_init();
L
Linus Torvalds 已提交
3504 3505 3506
	bdev_cache_init();
	chrdev_init();
}