dcache.c 87 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * 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.
 */

18
#include <linux/ratelimit.h>
Linus Torvalds's avatar
Linus Torvalds committed
19 20 21
#include <linux/string.h>
#include <linux/mm.h>
#include <linux/fs.h>
22
#include <linux/fscrypt.h>
23
#include <linux/fsnotify.h>
Linus Torvalds's avatar
Linus Torvalds committed
24 25 26 27
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/hash.h>
#include <linux/cache.h>
28
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
29 30
#include <linux/security.h>
#include <linux/seqlock.h>
31
#include <linux/memblock.h>
32 33
#include <linux/bit_spinlock.h>
#include <linux/rculist_bl.h>
34
#include <linux/list_lru.h>
35
#include "internal.h"
36
#include "mount.h"
Linus Torvalds's avatar
Linus Torvalds committed
37

Nick Piggin's avatar
Nick Piggin committed
38 39
/*
 * Usage:
40
 * dcache->d_inode->i_lock protects:
41
 *   - i_dentry, d_u.d_alias, d_inode of aliases
42 43
 * dcache_hash_bucket lock protects:
 *   - the dcache hash table
44 45
 * s_roots bl list spinlock protects:
 *   - the s_roots list (see __d_drop)
46
 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin's avatar
Nick Piggin committed
47 48 49 50 51
 *   - the dcache lru lists and counters
 * d_lock protects:
 *   - d_flags
 *   - d_name
 *   - d_lru
52
 *   - d_count
Nick Piggin's avatar
Nick Piggin committed
53
 *   - d_unhashed()
Nick Piggin's avatar
Nick Piggin committed
54 55
 *   - d_parent and d_subdirs
 *   - childrens' d_child and d_parent
56
 *   - d_u.d_alias, d_inode
Nick Piggin's avatar
Nick Piggin committed
57 58
 *
 * Ordering:
59
 * dentry->d_inode->i_lock
Nick Piggin's avatar
Nick Piggin committed
60
 *   dentry->d_lock
61
 *     dentry->d_sb->s_dentry_lru_lock
62
 *     dcache_hash_bucket lock
63
 *     s_roots lock
Nick Piggin's avatar
Nick Piggin committed
64
 *
Nick Piggin's avatar
Nick Piggin committed
65 66 67 68 69 70 71
 * 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:
72
 * arbitrary, since it's serialized on rename_lock
Nick Piggin's avatar
Nick Piggin committed
73
 */
74
int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds's avatar
Linus Torvalds committed
75 76
EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);

Al Viro's avatar
Al Viro committed
77
__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds's avatar
Linus Torvalds committed
78

79
EXPORT_SYMBOL(rename_lock);
Linus Torvalds's avatar
Linus Torvalds committed
80

81
static struct kmem_cache *dentry_cache __ro_after_init;
Linus Torvalds's avatar
Linus Torvalds committed
82

83 84 85 86
const struct qstr empty_name = QSTR_INIT("", 0);
EXPORT_SYMBOL(empty_name);
const struct qstr slash_name = QSTR_INIT("/", 1);
EXPORT_SYMBOL(slash_name);
87 88
const struct qstr dotdot_name = QSTR_INIT("..", 2);
EXPORT_SYMBOL(dotdot_name);
89

Linus Torvalds's avatar
Linus Torvalds committed
90 91 92 93 94 95 96 97 98
/*
 * 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.
 */

99
static unsigned int d_hash_shift __ro_after_init;
100

101
static struct hlist_bl_head *dentry_hashtable __ro_after_init;
102

103
static inline struct hlist_bl_head *d_hash(unsigned int hash)
104
{
105
	return dentry_hashtable + (hash >> d_hash_shift);
106 107
}

108 109 110 111 112 113 114 115 116 117
#define IN_LOOKUP_SHIFT 10
static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];

static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
					unsigned int hash)
{
	hash += (unsigned long) parent / L1_CACHE_BYTES;
	return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
}

118 119 120 121 122 123 124
struct dentry_stat_t {
	long nr_dentry;
	long nr_unused;
	long age_limit;		/* age in seconds */
	long want_pages;	/* pages requested by system */
	long nr_negative;	/* # of unused negative dentries */
	long dummy;		/* Reserved for future use */
Linus Torvalds's avatar
Linus Torvalds committed
125 126
};

127
static DEFINE_PER_CPU(long, nr_dentry);
128
static DEFINE_PER_CPU(long, nr_dentry_unused);
129
static DEFINE_PER_CPU(long, nr_dentry_negative);
130 131

#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
132 133 134 135
/* Statistics gathering. */
static struct dentry_stat_t dentry_stat = {
	.age_limit = 45,
};
136 137 138 139 140 141 142 143 144 145 146 147 148

/*
 * 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.
 */
149
static long get_nr_dentry(void)
150 151
{
	int i;
152
	long sum = 0;
153 154 155 156 157
	for_each_possible_cpu(i)
		sum += per_cpu(nr_dentry, i);
	return sum < 0 ? 0 : sum;
}

158 159 160 161 162 163 164 165 166
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;
}

167 168 169 170 171 172 173 174 175 176
static long get_nr_dentry_negative(void)
{
	int i;
	long sum = 0;

	for_each_possible_cpu(i)
		sum += per_cpu(nr_dentry_negative, i);
	return sum < 0 ? 0 : sum;
}

177 178
static int proc_nr_dentry(struct ctl_table *table, int write, void *buffer,
			  size_t *lenp, loff_t *ppos)
179
{
180
	dentry_stat.nr_dentry = get_nr_dentry();
181
	dentry_stat.nr_unused = get_nr_dentry_unused();
182
	dentry_stat.nr_negative = get_nr_dentry_negative();
183
	return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
184
}
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

static struct ctl_table fs_dcache_sysctls[] = {
	{
		.procname	= "dentry-state",
		.data		= &dentry_stat,
		.maxlen		= 6*sizeof(long),
		.mode		= 0444,
		.proc_handler	= proc_nr_dentry,
	},
	{ }
};

static int __init init_fs_dcache_sysctls(void)
{
	register_sysctl_init("fs", fs_dcache_sysctls);
	return 0;
}
fs_initcall(init_fs_dcache_sysctls);
203 204
#endif

205 206 207 208
/*
 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
 * The strings are both count bytes long, and count is non-zero.
 */
209 210 211 212 213 214 215 216 217 218 219 220
#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.
 */
221
static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
222
{
223 224 225
	unsigned long a,b,mask;

	for (;;) {
226
		a = read_word_at_a_time(cs);
227
		b = load_unaligned_zeropad(ct);
228 229 230 231 232 233 234 235 236 237
		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;
	}
238
	mask = bytemask_from_count(tcount);
239
	return unlikely(!!((a ^ b) & mask));
240 241
}

242
#else
243

244
static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
245
{
246 247 248 249 250 251 252 253 254 255
	do {
		if (*cs != *ct)
			return 1;
		cs++;
		ct++;
		tcount--;
	} while (tcount);
	return 0;
}

256 257
#endif

258 259 260 261
static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
{
	/*
	 * Be careful about RCU walk racing with rename:
262
	 * use 'READ_ONCE' to fetch the name pointer.
263 264 265 266 267 268 269 270 271 272 273 274 275
	 *
	 * 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)
	 */
276
	const unsigned char *cs = READ_ONCE(dentry->d_name.name);
277

278
	return dentry_string_cmp(cs, ct, tcount);
279 280
}

281 282 283 284 285 286 287 288 289 290 291 292 293
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]);
}

Christoph Hellwig's avatar
Christoph Hellwig committed
294
static void __d_free(struct rcu_head *head)
Linus Torvalds's avatar
Linus Torvalds committed
295
{
Christoph Hellwig's avatar
Christoph Hellwig committed
296 297
	struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);

298 299 300 301 302 303
	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);
304
	kfree(external_name(dentry));
305
	kmem_cache_free(dentry_cache, dentry);
Linus Torvalds's avatar
Linus Torvalds committed
306 307
}

308 309 310 311 312
static inline int dname_external(const struct dentry *dentry)
{
	return dentry->d_name.name != dentry->d_iname;
}

Al Viro's avatar
Al Viro committed
313 314 315
void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
316
	name->name = dentry->d_name;
Al Viro's avatar
Al Viro committed
317
	if (unlikely(dname_external(dentry))) {
318
		atomic_inc(&external_name(dentry)->u.count);
Al Viro's avatar
Al Viro committed
319
	} else {
320 321
		memcpy(name->inline_name, dentry->d_iname,
		       dentry->d_name.len + 1);
322
		name->name.name = name->inline_name;
Al Viro's avatar
Al Viro committed
323
	}
324
	spin_unlock(&dentry->d_lock);
Al Viro's avatar
Al Viro committed
325 326 327 328 329
}
EXPORT_SYMBOL(take_dentry_name_snapshot);

void release_dentry_name_snapshot(struct name_snapshot *name)
{
330
	if (unlikely(name->name.name != name->inline_name)) {
Al Viro's avatar
Al Viro committed
331
		struct external_name *p;
332
		p = container_of(name->name.name, struct external_name, name[0]);
Al Viro's avatar
Al Viro committed
333
		if (unlikely(atomic_dec_and_test(&p->u.count)))
334
			kfree_rcu(p, u.head);
Al Viro's avatar
Al Viro committed
335 336 337 338
	}
}
EXPORT_SYMBOL(release_dentry_name_snapshot);

339 340 341 342 343 344 345 346
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);
Al Viro's avatar
Al Viro committed
347
	flags &= ~DCACHE_ENTRY_TYPE;
348
	flags |= type_flags;
349
	smp_store_release(&dentry->d_flags, flags);
350 351 352 353 354 355
}

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

Al Viro's avatar
Al Viro committed
356
	flags &= ~DCACHE_ENTRY_TYPE;
357 358
	WRITE_ONCE(dentry->d_flags, flags);
	dentry->d_inode = NULL;
359 360
	if (dentry->d_flags & DCACHE_LRU_LIST)
		this_cpu_inc(nr_dentry_negative);
361 362
}

Al Viro's avatar
Al Viro committed
363 364
static void dentry_free(struct dentry *dentry)
{
365
	WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
366 367 368 369 370 371 372
	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;
		}
	}
Al Viro's avatar
Al Viro committed
373
	/* if dentry was never visible to RCU, immediate free is OK */
374
	if (dentry->d_flags & DCACHE_NORCU)
Al Viro's avatar
Al Viro committed
375 376 377 378 379
		__d_free(&dentry->d_u.d_rcu);
	else
		call_rcu(&dentry->d_u.d_rcu, __d_free);
}

Linus Torvalds's avatar
Linus Torvalds committed
380 381
/*
 * Release the dentry's inode, using the filesystem
382
 * d_iput() operation if defined.
Nick Piggin's avatar
Nick Piggin committed
383 384 385
 */
static void dentry_unlink_inode(struct dentry * dentry)
	__releases(dentry->d_lock)
386
	__releases(dentry->d_inode->i_lock)
Nick Piggin's avatar
Nick Piggin committed
387 388
{
	struct inode *inode = dentry->d_inode;
389

390
	raw_write_seqcount_begin(&dentry->d_seq);
391
	__d_clear_type_and_inode(dentry);
392
	hlist_del_init(&dentry->d_u.d_alias);
393
	raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin's avatar
Nick Piggin committed
394
	spin_unlock(&dentry->d_lock);
395
	spin_unlock(&inode->i_lock);
Nick Piggin's avatar
Nick Piggin committed
396 397 398 399 400 401 402 403
	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);
}

404 405 406 407 408 409 410 411 412 413 414
/*
 * 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.
 *
415 416 417 418 419
 * The per-cpu "nr_dentry_negative" counters are only updated
 * when deleted from or added to the per-superblock LRU list, not
 * from/to the shrink list. That is to avoid an unneeded dec/inc
 * pair when moving from LRU to shrink list in select_collect().
 *
420 421 422 423 424 425 426 427 428
 * 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);
429 430
	if (d_is_negative(dentry))
		this_cpu_inc(nr_dentry_negative);
431 432 433 434 435 436 437 438
	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);
439 440
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
	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.
 */
466
static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
467 468 469 470
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags &= ~DCACHE_LRU_LIST;
	this_cpu_dec(nr_dentry_unused);
471 472
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
473
	list_lru_isolate(lru, &dentry->d_lru);
474 475
}

476 477
static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
			      struct list_head *list)
478 479 480
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags |= DCACHE_SHRINK_LIST;
481 482
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
483
	list_lru_isolate_move(lru, &dentry->d_lru, list);
484 485
}

486
static void ___d_drop(struct dentry *dentry)
Nick Piggin's avatar
Nick Piggin committed
487
{
488 489 490 491 492 493 494 495 496 497
	struct hlist_bl_head *b;
	/*
	 * Hashed dentries are normally on the dentry hashtable,
	 * with the exception of those newly allocated by
	 * d_obtain_root, which are always IS_ROOT:
	 */
	if (unlikely(IS_ROOT(dentry)))
		b = &dentry->d_sb->s_roots;
	else
		b = d_hash(dentry->d_name.hash);
498

499 500 501
	hlist_bl_lock(b);
	__hlist_bl_del(&dentry->d_hash);
	hlist_bl_unlock(b);
Nick Piggin's avatar
Nick Piggin committed
502
}
503 504 505

void __d_drop(struct dentry *dentry)
{
506 507 508 509 510
	if (!d_unhashed(dentry)) {
		___d_drop(dentry);
		dentry->d_hash.pprev = NULL;
		write_seqcount_invalidate(&dentry->d_seq);
	}
511
}
Nick Piggin's avatar
Nick Piggin committed
512 513
EXPORT_SYMBOL(__d_drop);

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
/**
 * 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
 *
 * ___d_drop doesn't mark dentry as "unhashed"
 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
 */
Nick Piggin's avatar
Nick Piggin committed
532 533 534 535 536 537 538 539
void d_drop(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__d_drop(dentry);
	spin_unlock(&dentry->d_lock);
}
EXPORT_SYMBOL(d_drop);

Al Viro's avatar
Al Viro committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
{
	struct dentry *next;
	/*
	 * Inform d_walk() and shrink_dentry_list() that we are no longer
	 * attached to the dentry tree
	 */
	dentry->d_flags |= DCACHE_DENTRY_KILLED;
	if (unlikely(list_empty(&dentry->d_child)))
		return;
	__list_del_entry(&dentry->d_child);
	/*
	 * Cursors can move around the list of children.  While we'd been
	 * a normal list member, it didn't matter - ->d_child.next would've
	 * been updated.  However, from now on it won't be and for the
	 * things like d_walk() it might end up with a nasty surprise.
	 * Normally d_walk() doesn't care about cursors moving around -
	 * ->d_lock on parent prevents that and since a cursor has no children
	 * of its own, we get through it without ever unlocking the parent.
	 * There is one exception, though - if we ascend from a child that
	 * gets killed as soon as we unlock it, the next sibling is found
	 * using the value left in its ->d_child.next.  And if _that_
	 * pointed to a cursor, and cursor got moved (e.g. by lseek())
	 * before d_walk() regains parent->d_lock, we'll end up skipping
	 * everything the cursor had been moved past.
	 *
	 * Solution: make sure that the pointer left behind in ->d_child.next
	 * points to something that won't be moving around.  I.e. skip the
	 * cursors.
	 */
	while (dentry->d_child.next != &parent->d_subdirs) {
		next = list_entry(dentry->d_child.next, struct dentry, d_child);
		if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
			break;
		dentry->d_child.next = next->d_child.next;
	}
}

Al Viro's avatar
Al Viro committed
578
static void __dentry_kill(struct dentry *dentry)
579
{
580 581 582
	struct dentry *parent = NULL;
	bool can_free = true;
	if (!IS_ROOT(dentry))
583
		parent = dentry->d_parent;
Nick Piggin's avatar
Nick Piggin committed
584

585 586 587 588 589
	/*
	 * The dentry is now unrecoverably dead to the world.
	 */
	lockref_mark_dead(&dentry->d_lockref);

590 591 592 593
	/*
	 * inform the fs via d_prune that this dentry is about to be
	 * unhashed and destroyed.
	 */
594
	if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng's avatar
Yan, Zheng committed
595 596
		dentry->d_op->d_prune(dentry);

597 598 599 600
	if (dentry->d_flags & DCACHE_LRU_LIST) {
		if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
			d_lru_del(dentry);
	}
601 602
	/* if it was on the hash then remove it */
	__d_drop(dentry);
Al Viro's avatar
Al Viro committed
603
	dentry_unlist(dentry, parent);
Al Viro's avatar
Al Viro committed
604 605
	if (parent)
		spin_unlock(&parent->d_lock);
606 607 608 609
	if (dentry->d_inode)
		dentry_unlink_inode(dentry);
	else
		spin_unlock(&dentry->d_lock);
Al Viro's avatar
Al Viro committed
610 611 612 613
	this_cpu_dec(nr_dentry);
	if (dentry->d_op && dentry->d_op->d_release)
		dentry->d_op->d_release(dentry);

614 615 616 617 618 619 620 621
	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);
622
	cond_resched();
Al Viro's avatar
Al Viro committed
623 624
}

625
static struct dentry *__lock_parent(struct dentry *dentry)
626
{
627
	struct dentry *parent;
628
	rcu_read_lock();
629
	spin_unlock(&dentry->d_lock);
630
again:
631
	parent = READ_ONCE(dentry->d_parent);
632 633 634 635 636 637 638 639 640 641 642 643 644
	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;
	}
645 646
	rcu_read_unlock();
	if (parent != dentry)
647
		spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
648
	else
649 650 651 652
		parent = NULL;
	return parent;
}

653 654 655 656 657 658 659 660 661 662
static inline struct dentry *lock_parent(struct dentry *dentry)
{
	struct dentry *parent = dentry->d_parent;
	if (IS_ROOT(dentry))
		return NULL;
	if (likely(spin_trylock(&parent->d_lock)))
		return parent;
	return __lock_parent(dentry);
}

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
static inline bool retain_dentry(struct dentry *dentry)
{
	WARN_ON(d_in_lookup(dentry));

	/* Unreachable? Get rid of it */
	if (unlikely(d_unhashed(dentry)))
		return false;

	if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
		return false;

	if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
		if (dentry->d_op->d_delete(dentry))
			return false;
	}
Ira Weiny's avatar
Ira Weiny committed
678 679 680 681

	if (unlikely(dentry->d_flags & DCACHE_DONTCACHE))
		return false;

682 683 684 685 686 687
	/* retain; LRU fodder */
	dentry->d_lockref.count--;
	if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
		d_lru_add(dentry);
	else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
		dentry->d_flags |= DCACHE_REFERENCED;
688 689 690
	return true;
}

Ira Weiny's avatar
Ira Weiny committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
void d_mark_dontcache(struct inode *inode)
{
	struct dentry *de;

	spin_lock(&inode->i_lock);
	hlist_for_each_entry(de, &inode->i_dentry, d_u.d_alias) {
		spin_lock(&de->d_lock);
		de->d_flags |= DCACHE_DONTCACHE;
		spin_unlock(&de->d_lock);
	}
	inode->i_state |= I_DONTCACHE;
	spin_unlock(&inode->i_lock);
}
EXPORT_SYMBOL(d_mark_dontcache);

706 707 708 709 710 711 712 713 714 715 716 717
/*
 * Finish off a dentry we've decided to kill.
 * dentry->d_lock must be held, returns with it unlocked.
 * Returns dentry requiring refcount drop, or NULL if we're done.
 */
static struct dentry *dentry_kill(struct dentry *dentry)
	__releases(dentry->d_lock)
{
	struct inode *inode = dentry->d_inode;
	struct dentry *parent = NULL;

	if (inode && unlikely(!spin_trylock(&inode->i_lock)))
718
		goto slow_positive;
719 720 721 722

	if (!IS_ROOT(dentry)) {
		parent = dentry->d_parent;
		if (unlikely(!spin_trylock(&parent->d_lock))) {
723 724 725 726 727 728 729 730
			parent = __lock_parent(dentry);
			if (likely(inode || !dentry->d_inode))
				goto got_locks;
			/* negative that became positive */
			if (parent)
				spin_unlock(&parent->d_lock);
			inode = dentry->d_inode;
			goto slow_positive;
731 732 733 734 735
		}
	}
	__dentry_kill(dentry);
	return parent;

736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
slow_positive:
	spin_unlock(&dentry->d_lock);
	spin_lock(&inode->i_lock);
	spin_lock(&dentry->d_lock);
	parent = lock_parent(dentry);
got_locks:
	if (unlikely(dentry->d_lockref.count != 1)) {
		dentry->d_lockref.count--;
	} else if (likely(!retain_dentry(dentry))) {
		__dentry_kill(dentry);
		return parent;
	}
	/* we are keeping it, after all */
	if (inode)
		spin_unlock(&inode->i_lock);
	if (parent)
		spin_unlock(&parent->d_lock);
753
	spin_unlock(&dentry->d_lock);
754
	return NULL;
755 756
}

757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
/*
 * 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
772
	 * let the dentry count go to zero, so use "put_or_lock".
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
	 */
	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);
793
			return true;
794
		}
795
		return false;
796 797 798 799 800 801
	}

	/*
	 * If we weren't the last ref, we're done.
	 */
	if (ret)
802
		return true;
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

	/*
	 * 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.
824 825 826 827 828 829
	 *
	 * Nevertheless, there are two cases that we should kill
	 * the dentry anyway.
	 * 1. free disconnected dentries as soon as their refcount
	 *    reached zero.
	 * 2. free dentries if they should not be cached.
830 831
	 */
	smp_rmb();
832
	d_flags = READ_ONCE(dentry->d_flags);
833 834
	d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST |
			DCACHE_DISCONNECTED | DCACHE_DONTCACHE;
835 836 837

	/* Nothing to do? Dropping the reference was all we needed? */
	if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
838
		return true;
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

	/*
	 * 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);
855
		return true;
856 857 858 859 860 861 862 863
	}

	/*
	 * 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;
864
	return false;
865 866 867
}


Linus Torvalds's avatar
Linus Torvalds committed
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
/* 
 * 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)
{
896 897
	while (dentry) {
		might_sleep();
Linus Torvalds's avatar
Linus Torvalds committed
898

899 900 901 902 903
		rcu_read_lock();
		if (likely(fast_dput(dentry))) {
			rcu_read_unlock();
			return;
		}
904

905
		/* Slow case: now with the dentry lock held */
906 907
		rcu_read_unlock();

908 909 910 911
		if (likely(retain_dentry(dentry))) {
			spin_unlock(&dentry->d_lock);
			return;
		}
912

913
		dentry = dentry_kill(dentry);
914
	}
Linus Torvalds's avatar
Linus Torvalds committed
915
}
916
EXPORT_SYMBOL(dput);
Linus Torvalds's avatar
Linus Torvalds committed
917

918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
static void __dput_to_list(struct dentry *dentry, struct list_head *list)
__must_hold(&dentry->d_lock)
{
	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
		/* let the owner of the list it's on deal with it */
		--dentry->d_lockref.count;
	} else {
		if (dentry->d_flags & DCACHE_LRU_LIST)
			d_lru_del(dentry);
		if (!--dentry->d_lockref.count)
			d_shrink_add(dentry, list);
	}
}

void dput_to_list(struct dentry *dentry, struct list_head *list)
{
	rcu_read_lock();
	if (likely(fast_dput(dentry))) {
		rcu_read_unlock();
		return;
	}
	rcu_read_unlock();
	if (!retain_dentry(dentry))
		__dput_to_list(dentry, list);
	spin_unlock(&dentry->d_lock);
}
Linus Torvalds's avatar
Linus Torvalds committed
944

Nick Piggin's avatar
Nick Piggin committed
945
/* This must be called with d_lock held */
946
static inline void __dget_dlock(struct dentry *dentry)
Nick Piggin's avatar
Nick Piggin committed
947
{
948
	dentry->d_lockref.count++;
Nick Piggin's avatar
Nick Piggin committed
949 950
}

951 952
struct dentry *dget_parent(struct dentry *dentry)
{
953
	int gotref;
954
	struct dentry *ret;
Al Viro's avatar
Al Viro committed
955
	unsigned seq;
956

957 958 959 960 961
	/*
	 * Do optimistic parent lookup without any
	 * locking.
	 */
	rcu_read_lock();
Al Viro's avatar
Al Viro committed
962
	seq = raw_seqcount_begin(&dentry->d_seq);
963
	ret = READ_ONCE(dentry->d_parent);
964 965 966
	gotref = lockref_get_not_zero(&ret->d_lockref);
	rcu_read_unlock();
	if (likely(gotref)) {
Al Viro's avatar
Al Viro committed
967
		if (!read_seqcount_retry(&dentry->d_seq, seq))
968 969 970 971
			return ret;
		dput(ret);
	}

972
repeat:
973 974 975 976 977
	/*
	 * Don't need rcu_dereference because we re-check it was correct under
	 * the lock.
	 */
	rcu_read_lock();
978
	ret = dentry->d_parent;
979 980 981 982
	spin_lock(&ret->d_lock);
	if (unlikely(ret != dentry->d_parent)) {
		spin_unlock(&ret->d_lock);
		rcu_read_unlock();
983 984
		goto repeat;
	}
985
	rcu_read_unlock();
986 987
	BUG_ON(!ret->d_lockref.count);
	ret->d_lockref.count++;
988 989 990 991 992
	spin_unlock(&ret->d_lock);
	return ret;
}
EXPORT_SYMBOL(dget_parent);

993 994 995 996 997 998 999
static struct dentry * __d_find_any_alias(struct inode *inode)
{
	struct dentry *alias;

	if (hlist_empty(&inode->i_dentry))
		return NULL;
	alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
Al Viro's avatar
Al Viro committed
1000
	lockref_get(&alias->d_lockref);
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
	return alias;
}

/**
 * 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)
{
	struct dentry *de;

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

1022
static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
1023
{
1024 1025 1026 1027
	struct dentry *alias;

	if (S_ISDIR(inode->i_mode))
		return __d_find_any_alias(inode);
Linus Torvalds's avatar
Linus Torvalds committed
1028

1029
	hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Piggin's avatar
Nick Piggin committed
1030
		spin_lock(&alias->d_lock);
1031
 		if (!d_unhashed(alias)) {
1032 1033 1034
			__dget_dlock(alias);
			spin_unlock(&alias->d_lock);
			return alias;
Linus Torvalds's avatar
Linus Torvalds committed
1035
		}
Nick Piggin's avatar
Nick Piggin committed
1036
		spin_unlock(&alias->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1037
	}
Nick Piggin's avatar
Nick Piggin committed
1038
	return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
1039 1040
}

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/**
 * 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
 * of a filesystem, or if the directory was renamed and d_revalidate
 * was the first vfs operation to notice.
 *
 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
 * any other hashed alias over that one.
 */
Nick Piggin's avatar
Nick Piggin committed
1055
struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
1056
{
1057 1058
	struct dentry *de = NULL;

1059
	if (!hlist_empty(&inode->i_dentry)) {
1060
		spin_lock(&inode->i_lock);
1061
		de = __d_find_alias(inode);
1062
		spin_unlock(&inode->i_lock);
1063
	}
Linus Torvalds's avatar
Linus Torvalds committed
1064 1065
	return de;
}
1066
EXPORT_SYMBOL(d_find_alias);
Linus Torvalds's avatar
Linus Torvalds committed
1067

Al Viro's avatar
Al Viro committed
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
/*
 *  Caller MUST be holding rcu_read_lock() and be guaranteed
 *  that inode won't get freed until rcu_read_unlock().
 */
struct dentry *d_find_alias_rcu(struct inode *inode)
{
	struct hlist_head *l = &inode->i_dentry;
	struct dentry *de = NULL;

	spin_lock(&inode->i_lock);
	// ->i_dentry and ->i_rcu are colocated, but the latter won't be
	// used without having I_FREEING set, which means no aliases left
	if (likely(!(inode->i_state & I_FREEING) && !hlist_empty(l))) {
		if (S_ISDIR(inode->i_mode)) {
			de = hlist_entry(l->first, struct dentry, d_u.d_alias);
		} else {
			hlist_for_each_entry(de, l, d_u.d_alias)
				if (!d_unhashed(de))
					break;
		}
	}
	spin_unlock(&inode->i_lock);
	return de;
}

Linus Torvalds's avatar
Linus Torvalds committed
1093 1094 1095 1096 1097 1098
/*
 *	Try to kill dentries associated with this inode.
 * WARNING: you must own a reference to inode.
 */
void d_prune_aliases(struct inode *inode)
{
1099
	struct dentry *dentry;
Linus Torvalds's avatar
Linus Torvalds committed
1100
restart:
1101
	spin_lock(&inode->i_lock);
1102
	hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds's avatar
Linus Torvalds committed
1103
		spin_lock(&dentry->d_lock);
1104
		if (!dentry->d_lockref.count) {
1105 1106 1107
			struct dentry *parent = lock_parent(dentry);
			if (likely(!dentry->d_lockref.count)) {
				__dentry_kill(dentry);
1108
				dput(parent);
1109 1110 1111 1112
				goto restart;
			}
			if (parent)
				spin_unlock(&parent->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1113 1114 1115
		}
		spin_unlock(&dentry->d_lock);
	}
1116
	spin_unlock(&inode->i_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1117
}
1118
EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds's avatar
Linus Torvalds committed
1119

1120 1121
/*
 * Lock a dentry from shrink list.
1122 1123
 * Called under rcu_read_lock() and dentry->d_lock; the former
 * guarantees that nothing we access will be freed under us.
1124
 * Note that dentry is *not* protected from concurrent dentry_kill(),
1125 1126
 * d_delete(), etc.
 *
1127 1128 1129 1130 1131
 * Return false if dentry has been disrupted or grabbed, leaving
 * the caller to kick it off-list.  Otherwise, return true and have
 * that dentry's inode and parent both locked.
 */
static bool shrink_lock_dentry(struct dentry *dentry)
Linus Torvalds's avatar
Linus Torvalds committed
1132
{
1133 1134
	struct inode *inode;
	struct dentry *parent;
1135

1136 1137 1138 1139 1140 1141 1142
	if (dentry->d_lockref.count)
		return false;

	inode = dentry->d_inode;
	if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
		spin_unlock(&dentry->d_lock);
		spin_lock(&inode->i_lock);
1143
		spin_lock(&dentry->d_lock);
1144 1145 1146 1147 1148 1149
		if (unlikely(dentry->d_lockref.count))
			goto out;
		/* changed inode means that somebody had grabbed it */
		if (unlikely(inode != dentry->d_inode))
			goto out;
	}
1150

1151 1152 1153
	parent = dentry->d_parent;
	if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
		return true;
1154

1155 1156 1157 1158 1159 1160 1161 1162
	spin_unlock(&dentry->d_lock);
	spin_lock(&parent->d_lock);
	if (unlikely(parent != dentry->d_parent)) {
		spin_unlock(&parent->d_lock);
		spin_lock(&dentry->d_lock);
		goto out;
	}
	spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1163
	if (likely(!dentry->d_lockref.count))
1164 1165 1166 1167 1168 1169 1170
		return true;
	spin_unlock(&parent->d_lock);
out:
	if (inode)
		spin_unlock(&inode->i_lock);
	return false;
}
1171

1172
void shrink_dentry_list(struct list_head *list)
1173 1174 1175
{
	while (!list_empty(list)) {
		struct dentry *dentry, *parent;
1176

1177 1178
		dentry = list_entry(list->prev, struct dentry, d_lru);
		spin_lock(&dentry->d_lock);
1179
		rcu_read_lock();
1180 1181
		if (!shrink_lock_dentry(dentry)) {
			bool can_free = false;
1182
			rcu_read_unlock();
1183 1184 1185
			d_shrink_del(dentry);
			if (dentry->d_lockref.count < 0)
				can_free = dentry->d_flags & DCACHE_MAY_FREE;
1186 1187 1188 1189 1190
			spin_unlock(&dentry->d_lock);
			if (can_free)
				dentry_free(dentry);
			continue;
		}
1191
		rcu_read_unlock();
1192 1193
		d_shrink_del(dentry);
		parent = dentry->d_parent;
1194 1195
		if (parent != dentry)
			__dput_to_list(parent, list);
1196
		__dentry_kill(dentry);
1197
	}
1198 1199
}

1200 1201
static enum lru_status dentry_lru_isolate(struct list_head *item,
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
{
	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) {
1221
		d_lru_isolate(lru, dentry);
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
		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;
	}

1252
	d_lru_shrink_move(lru, dentry, freeable);
1253 1254 1255 1256 1257
	spin_unlock(&dentry->d_lock);

	return LRU_REMOVED;
}

1258
/**
1259 1260
 * prune_dcache_sb - shrink the dcache
 * @sb: superblock
1261
 * @sc: shrink control, passed to list_lru_shrink_walk()
1262
 *
1263 1264
 * 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
1265
 * function.
1266
 *
1267 1268
 * This function may fail to free any resources if all the dentries are in
 * use.
1269
 */
1270
long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
1271
{
1272 1273
	LIST_HEAD(dispose);
	long freed;
1274

1275 1276
	freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
				     dentry_lru_isolate, &dispose);
1277
	shrink_dentry_list(&dispose);
1278
	return freed;
1279
}
Nick Piggin's avatar
Nick Piggin committed
1280

1281
static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
1282
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1283
{
1284 1285
	struct list_head *freeable = arg;
	struct dentry	*dentry = container_of(item, struct dentry, d_lru);
1286

1287 1288 1289 1290 1291 1292 1293 1294
	/*
	 * 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;

1295
	d_lru_shrink_move(lru, dentry, freeable);
1296
	spin_unlock(&dentry->d_lock);
1297

1298
	return LRU_REMOVED;
1299 1300
}

1301

Linus Torvalds's avatar
Linus Torvalds committed
1302 1303 1304 1305
/**
 * shrink_dcache_sb - shrink dcache for a superblock
 * @sb: superblock
 *
1306 1307
 * Shrink the dcache for the specified super block. This is used to free
 * the dcache before unmounting a file system.
Linus Torvalds's avatar
Linus Torvalds committed
1308
 */
1309
void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds's avatar
Linus Torvalds committed
1310
{
1311 1312 1313
	do {
		LIST_HEAD(dispose);

1314
		list_lru_walk(&sb->s_dentry_lru,
1315
			dentry_lru_isolate_shrink, &dispose, 1024);
1316
		shrink_dentry_list(&dispose);
1317
	} while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds's avatar
Linus Torvalds committed
1318
}
1319
EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds's avatar
Linus Torvalds committed
1320

Miklos Szeredi's avatar
Miklos Szeredi committed
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
/**
 * 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,
};
1334

Linus Torvalds's avatar
Linus Torvalds committed
1335
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
1336 1337 1338 1339
 * d_walk - walk the dentry tree
 * @parent:	start of walk
 * @data:	data passed to @enter() and @finish()
 * @enter:	callback when first entering the dentry
Linus Torvalds's avatar
Linus Torvalds committed
1340
 *
Al Viro's avatar
Al Viro committed
1341
 * The @enter() callbacks are called with d_lock held.
Linus Torvalds's avatar
Linus Torvalds committed
1342
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
1343
static void d_walk(struct dentry *parent, void *data,
Al Viro's avatar
Al Viro committed
1344
		   enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds's avatar
Linus Torvalds committed
1345
{
1346
	struct dentry *this_parent;
Linus Torvalds's avatar
Linus Torvalds committed
1347
	struct list_head *next;
1348
	unsigned seq = 0;
Miklos Szeredi's avatar
Miklos Szeredi committed
1349 1350
	enum d_walk_ret ret;
	bool retry = true;
1351

1352
again:
1353
	read_seqbegin_or_lock(&rename_lock, &seq);
1354
	this_parent = parent;
Nick Piggin's avatar
Nick Piggin committed
1355
	spin_lock(&this_parent->d_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367

	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;
	}
Linus Torvalds's avatar
Linus Torvalds committed
1368 1369 1370 1371 1372
repeat:
	next = this_parent->d_subdirs.next;
resume:
	while (next != &this_parent->d_subdirs) {
		struct list_head *tmp = next;
1373
		struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds's avatar
Linus Torvalds committed
1374
		next = tmp->next;
Nick Piggin's avatar
Nick Piggin committed
1375

Al Viro's avatar
Al Viro committed
1376 1377 1378
		if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
			continue;

Nick Piggin's avatar
Nick Piggin committed
1379
		spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredi's avatar
Miklos Szeredi committed
1380 1381 1382 1383 1384 1385

		ret = enter(data, dentry);
		switch (ret) {
		case D_WALK_CONTINUE:
			break;
		case D_WALK_QUIT:
Nick Piggin's avatar
Nick Piggin committed
1386
			spin_unlock(&dentry->d_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
1387 1388 1389 1390 1391 1392 1393
			goto out_unlock;
		case D_WALK_NORETRY:
			retry = false;
			break;
		case D_WALK_SKIP:
			spin_unlock(&dentry->d_lock);
			continue;
Nick Piggin's avatar
Nick Piggin committed
1394
		}
Miklos Szeredi's avatar
Miklos Szeredi committed
1395

Linus Torvalds's avatar
Linus Torvalds committed
1396
		if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin's avatar
Nick Piggin committed
1397
			spin_unlock(&this_parent->d_lock);
1398
			spin_release(&dentry->d_lock.dep_map, _RET_IP_);
Linus Torvalds's avatar
Linus Torvalds committed
1399
			this_parent = dentry;
Nick Piggin's avatar
Nick Piggin committed
1400
			spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds's avatar
Linus Torvalds committed
1401 1402
			goto repeat;
		}
Nick Piggin's avatar
Nick Piggin committed
1403
		spin_unlock(&dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1404 1405 1406 1407
	}
	/*
	 * All done at this level ... ascend and resume the search.
	 */
Al Viro's avatar
Al Viro committed
1408 1409
	rcu_read_lock();
ascend:
Linus Torvalds's avatar
Linus Torvalds committed
1410
	if (this_parent != parent) {
1411
		struct dentry *child = this_parent;
1412 1413 1414 1415 1416
		this_parent = child->d_parent;

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

Al Viro's avatar
Al Viro committed
1417 1418
		/* might go back up the wrong parent if we have had a rename. */
		if (need_seqretry(&rename_lock, seq))
1419
			goto rename_retry;
Al Viro's avatar
Al Viro committed
1420 1421 1422
		/* go into the first sibling still alive */
		do {
			next = child->d_child.next;
Al Viro's avatar
Al Viro committed
1423 1424 1425
			if (next == &this_parent->d_subdirs)
				goto ascend;
			child = list_entry(next, struct dentry, d_child);
Al Viro's avatar
Al Viro committed
1426
		} while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
1427
		rcu_read_unlock();
Linus Torvalds's avatar
Linus Torvalds committed
1428 1429
		goto resume;
	}
Al Viro's avatar
Al Viro committed
1430
	if (need_seqretry(&rename_lock, seq))
1431
		goto rename_retry;
Al Viro's avatar
Al Viro committed
1432
	rcu_read_unlock();
Miklos Szeredi's avatar
Miklos Szeredi committed
1433 1434 1435

out_unlock:
	spin_unlock(&this_parent->d_lock);
1436
	done_seqretry(&rename_lock, seq);
Miklos Szeredi's avatar
Miklos Szeredi committed
1437
	return;
1438 1439

rename_retry:
Al Viro's avatar
Al Viro committed
1440 1441 1442
	spin_unlock(&this_parent->d_lock);
	rcu_read_unlock();
	BUG_ON(seq & 1);
Miklos Szeredi's avatar
Miklos Szeredi committed
1443 1444
	if (!retry)
		return;
1445
	seq = 1;
1446
	goto again;
Linus Torvalds's avatar
Linus Torvalds committed
1447
}
Miklos Szeredi's avatar
Miklos Szeredi committed
1448

Ian Kent's avatar
Ian Kent committed
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
struct check_mount {
	struct vfsmount *mnt;
	unsigned int mounted;
};

static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
{
	struct check_mount *info = data;
	struct path path = { .mnt = info->mnt, .dentry = dentry };

	if (likely(!d_mountpoint(dentry)))
		return D_WALK_CONTINUE;
	if (__path_is_mountpoint(&path)) {
		info->mounted = 1;
		return D_WALK_QUIT;
	}
	return D_WALK_CONTINUE;
}

/**
 * path_has_submounts - check for mounts over a dentry in the
 *                      current namespace.
 * @parent: path to check.
 *
 * Return true if the parent or its subdirectories contain
 * a mount point in the current namespace.
 */
int path_has_submounts(const struct path *parent)
{
	struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };

	read_seqlock_excl(&mount_lock);
Al Viro's avatar
Al Viro committed
1481
	d_walk(parent->dentry, &data, path_check_mount);
Ian Kent's avatar
Ian Kent committed
1482 1483 1484 1485 1486 1487
	read_sequnlock_excl(&mount_lock);

	return data.mounted;
}
EXPORT_SYMBOL(path_has_submounts);

1488 1489 1490 1491 1492
/*
 * 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).
 *
1493
 * Only one of d_invalidate() and d_set_mounted() must succeed.  For
1494 1495 1496 1497 1498 1499 1500 1501
 * 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) {
1502
		/* Need exclusion wrt. d_invalidate() */
1503 1504 1505 1506 1507 1508 1509 1510 1511
		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)) {
1512 1513 1514 1515 1516
		ret = -EBUSY;
		if (!d_mountpoint(dentry)) {
			dentry->d_flags |= DCACHE_MOUNTED;
			ret = 0;
		}
1517 1518 1519 1520 1521 1522 1523
	}
 	spin_unlock(&dentry->d_lock);
out:
	write_sequnlock(&rename_lock);
	return ret;
}

Linus Torvalds's avatar
Linus Torvalds committed
1524
/*
1525
 * Search the dentry child list of the specified parent,
Linus Torvalds's avatar
Linus Torvalds committed
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
 * 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.
 */

Miklos Szeredi's avatar
Miklos Szeredi committed
1539 1540
struct select_data {
	struct dentry *start;
1541 1542 1543 1544
	union {
		long found;
		struct dentry *victim;
	};
Miklos Szeredi's avatar
Miklos Szeredi committed
1545 1546
	struct list_head dispose;
};
Nick Piggin's avatar
Nick Piggin committed
1547

Miklos Szeredi's avatar
Miklos Szeredi committed
1548 1549 1550 1551
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;
Linus Torvalds's avatar
Linus Torvalds committed
1552

Miklos Szeredi's avatar
Miklos Szeredi committed
1553 1554
	if (data->start == dentry)
		goto out;
Nick Piggin's avatar
Nick Piggin committed
1555

1556
	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredi's avatar
Miklos Szeredi committed
1557
		data->found++;
1558 1559 1560 1561 1562 1563 1564
	} 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++;
		}
Linus Torvalds's avatar
Linus Torvalds committed
1565
	}
Miklos Szeredi's avatar
Miklos Szeredi committed
1566 1567 1568 1569 1570
	/*
	 * We can return to the caller if we have found some (this
	 * ensures forward progress). We'll be coming back to find
	 * the rest.
	 */
1571 1572
	if (!list_empty(&data->dispose))
		ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds's avatar
Linus Torvalds committed
1573
out:
Miklos Szeredi's avatar
Miklos Szeredi committed
1574
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
1575 1576
}

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
static enum d_walk_ret select_collect2(void *_data, struct dentry *dentry)
{
	struct select_data *data = _data;
	enum d_walk_ret ret = D_WALK_CONTINUE;

	if (data->start == dentry)
		goto out;

	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
		if (!dentry->d_lockref.count) {
			rcu_read_lock();
			data->victim = dentry;
			return D_WALK_QUIT;
		}
	} else {
		if (dentry->d_flags & DCACHE_LRU_LIST)
			d_lru_del(dentry);
		if (!dentry->d_lockref.count)
			d_shrink_add(dentry, &data->dispose);
	}
	/*
	 * We can return to the caller if we have found some (this
	 * ensures forward progress). We'll be coming back to find
	 * the rest.
	 */
	if (!list_empty(&data->dispose))
		ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
out:
	return ret;
}

Linus Torvalds's avatar
Linus Torvalds committed
1608 1609 1610 1611 1612 1613
/**
 * shrink_dcache_parent - prune dcache
 * @parent: parent of entries to prune
 *
 * Prune the dcache to remove unused children of the parent dentry.
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
1614
void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds's avatar
Linus Torvalds committed
1615
{
Miklos Szeredi's avatar
Miklos Szeredi committed
1616
	for (;;) {
1617
		struct select_data data = {.start = parent};
Linus Torvalds's avatar
Linus Torvalds committed
1618

Miklos Szeredi's avatar
Miklos Szeredi committed
1619
		INIT_LIST_HEAD(&data.dispose);
Al Viro's avatar
Al Viro committed
1620
		d_walk(parent, &data, select_collect);
1621 1622 1623 1624 1625 1626 1627

		if (!list_empty(&data.dispose)) {
			shrink_dentry_list(&data.dispose);
			continue;
		}

		cond_resched();
Miklos Szeredi's avatar
Miklos Szeredi committed
1628 1629
		if (!data.found)
			break;
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
		data.victim = NULL;
		d_walk(parent, &data, select_collect2);
		if (data.victim) {
			struct dentry *parent;
			spin_lock(&data.victim->d_lock);
			if (!shrink_lock_dentry(data.victim)) {
				spin_unlock(&data.victim->d_lock);
				rcu_read_unlock();
			} else {
				rcu_read_unlock();
				parent = data.victim->d_parent;
				if (parent != data.victim)
					__dput_to_list(parent, &data.dispose);
				__dentry_kill(data.victim);
			}
		}
		if (!list_empty(&data.dispose))
			shrink_dentry_list(&data.dispose);
1648
	}
Linus Torvalds's avatar
Linus Torvalds committed
1649
}
1650
EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds's avatar
Linus Torvalds committed
1651

1652
static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
1653
{
1654 1655 1656
	/* it has busy descendents; complain about those instead */
	if (!list_empty(&dentry->d_subdirs))
		return D_WALK_CONTINUE;
1657

1658 1659 1660 1661
	/* root with refcount 1 is fine */
	if (dentry == _data && dentry->d_lockref.count == 1)
		return D_WALK_CONTINUE;

1662
	WARN(1, "BUG: Dentry %p{i=%lx,n=%pd} "
1663
			" still in use (%d) [unmount of %s %s]\n",
1664 1665 1666
		       dentry,
		       dentry->d_inode ?
		       dentry->d_inode->i_ino : 0UL,
1667
		       dentry,
1668 1669 1670
		       dentry->d_lockref.count,
		       dentry->d_sb->s_type->name,
		       dentry->d_sb->s_id);
1671 1672 1673 1674 1675 1676
	return D_WALK_CONTINUE;
}

static void do_one_tree(struct dentry *dentry)
{
	shrink_dcache_parent(dentry);
Al Viro's avatar
Al Viro committed
1677
	d_walk(dentry, dentry, umount_check);
1678 1679
	d_drop(dentry);
	dput(dentry);
1680 1681 1682 1683 1684 1685 1686 1687 1688
}

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

1689
	WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
1690 1691 1692

	dentry = sb->s_root;
	sb->s_root = NULL;
1693
	do_one_tree(dentry);
1694

1695 1696
	while (!hlist_bl_empty(&sb->s_roots)) {
		dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
1697
		do_one_tree(dentry);
1698 1699 1700
	}
}

1701
static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
1702
{
1703
	struct dentry **victim = _data;
1704
	if (d_mountpoint(dentry)) {
1705
		__dget_dlock(dentry);
1706
		*victim = dentry;
1707 1708
		return D_WALK_QUIT;
	}
1709
	return D_WALK_CONTINUE;
1710 1711 1712
}

/**
1713 1714
 * d_invalidate - detach submounts, prune dcache, and drop
 * @dentry: dentry to invalidate (aka detach, prune and drop)
1715
 */
1716
void d_invalidate(struct dentry *dentry)
1717
{
1718
	bool had_submounts = false;
1719 1720 1721
	spin_lock(&dentry->d_lock);
	if (d_unhashed(dentry)) {
		spin_unlock(&dentry->d_lock);
1722
		return;
1723
	}
1724
	__d_drop(dentry);
1725 1726
	spin_unlock(&dentry->d_lock);

1727
	/* Negative dentries can be dropped without further checks */
1728
	if (!dentry->d_inode)
1729
		return;
1730

1731
	shrink_dcache_parent(dentry);
1732
	for (;;) {
1733
		struct dentry *victim = NULL;
Al Viro's avatar
Al Viro committed
1734
		d_walk(dentry, &victim, find_submount);
1735 1736 1737
		if (!victim) {
			if (had_submounts)
				shrink_dcache_parent(dentry);
1738
			return;
1739
		}
1740 1741 1742
		had_submounts = true;
		detach_mounts(victim);
		dput(victim);
1743 1744
	}
}
1745
EXPORT_SYMBOL(d_invalidate);
1746

Linus Torvalds's avatar
Linus Torvalds committed
1747
/**
1748 1749
 * __d_alloc	-	allocate a dcache entry
 * @sb: filesystem it will belong to
Linus Torvalds's avatar
Linus Torvalds committed
1750 1751 1752 1753 1754 1755 1756
 * @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.
 */
 
Al Viro's avatar
Al Viro committed
1757
static struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
1758 1759 1760
{
	struct dentry *dentry;
	char *dname;
Miklos Szeredi's avatar
Miklos Szeredi committed
1761
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
1762

1763 1764
	dentry = kmem_cache_alloc_lru(dentry_cache, &sb->s_dentry_lru,
				      GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
1765 1766 1767
	if (!dentry)
		return NULL;

1768 1769 1770 1771 1772 1773 1774
	/*
	 * 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;
1775
	if (unlikely(!name)) {
1776
		name = &slash_name;
1777 1778
		dname = dentry->d_iname;
	} else if (name->len > DNAME_INLINE_LEN-1) {
1779
		size_t size = offsetof(struct external_name, name[1]);
1780 1781 1782 1783
		struct external_name *p = kmalloc(size + name->len,
						  GFP_KERNEL_ACCOUNT |
						  __GFP_RECLAIMABLE);
		if (!p) {
Linus Torvalds's avatar
Linus Torvalds committed
1784 1785 1786
			kmem_cache_free(dentry_cache, dentry); 
			return NULL;
		}
1787 1788
		atomic_set(&p->u.count, 1);
		dname = p->name;
Linus Torvalds's avatar
Linus Torvalds committed
1789 1790 1791 1792 1793 1794 1795 1796 1797
	} 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;

1798
	/* Make sure we always see the terminating NUL character */
1799
	smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
1800

1801
	dentry->d_lockref.count = 1;
1802
	dentry->d_flags = 0;
Linus Torvalds's avatar
Linus Torvalds committed
1803
	spin_lock_init(&dentry->d_lock);
1804
	seqcount_spinlock_init(&dentry->d_seq, &dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1805
	dentry->d_inode = NULL;
1806 1807
	dentry->d_parent = dentry;
	dentry->d_sb = sb;
Linus Torvalds's avatar
Linus Torvalds committed
1808 1809
	dentry->d_op = NULL;
	dentry->d_fsdata = NULL;
1810
	INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds's avatar
Linus Torvalds committed
1811 1812
	INIT_LIST_HEAD(&dentry->d_lru);
	INIT_LIST_HEAD(&dentry->d_subdirs);
1813 1814
	INIT_HLIST_NODE(&dentry->d_u.d_alias);
	INIT_LIST_HEAD(&dentry->d_child);
1815
	d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds's avatar
Linus Torvalds committed
1816

Miklos Szeredi's avatar
Miklos Szeredi committed
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
	if (dentry->d_op && dentry->d_op->d_init) {
		err = dentry->d_op->d_init(dentry);
		if (err) {
			if (dname_external(dentry))
				kfree(external_name(dentry));
			kmem_cache_free(dentry_cache, dentry);
			return NULL;
		}
	}

1827
	this_cpu_inc(nr_dentry);
1828

Linus Torvalds's avatar
Linus Torvalds committed
1829 1830
	return dentry;
}
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852

/**
 * 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;
1853
	list_add(&dentry->d_child, &parent->d_subdirs);
1854 1855 1856 1857
	spin_unlock(&parent->d_lock);

	return dentry;
}
1858
EXPORT_SYMBOL(d_alloc);
Linus Torvalds's avatar
Linus Torvalds committed
1859

1860 1861 1862 1863 1864 1865
struct dentry *d_alloc_anon(struct super_block *sb)
{
	return __d_alloc(sb, NULL);
}
EXPORT_SYMBOL(d_alloc_anon);

Al Viro's avatar
Al Viro committed
1866 1867
struct dentry *d_alloc_cursor(struct dentry * parent)
{
1868
	struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viro's avatar
Al Viro committed
1869
	if (dentry) {
1870
		dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viro's avatar
Al Viro committed
1871 1872 1873 1874 1875
		dentry->d_parent = dget(parent);
	}
	return dentry;
}

1876 1877 1878 1879 1880 1881 1882
/**
 * 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.
1883 1884 1885 1886
 * This is used for pipes, sockets et.al. - the stuff that should
 * never be anyone's children or parents.  Unlike all other
 * dentries, these will not have RCU delay between dropping the
 * last reference and freeing them.
Al Viro's avatar
Al Viro committed
1887 1888 1889
 *
 * The only user is alloc_file_pseudo() and that's what should
 * be considered a public interface.  Don't use directly.
1890
 */
1891 1892
struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
{
1893 1894 1895
	static const struct dentry_operations anon_ops = {
		.d_dname = simple_dname
	};
1896
	struct dentry *dentry = __d_alloc(sb, name);
1897
	if (likely(dentry)) {
1898
		dentry->d_flags |= DCACHE_NORCU;
1899 1900 1901
		if (!sb->s_d_op)
			d_set_d_op(dentry, &anon_ops);
	}
1902
	return dentry;
1903 1904
}

Linus Torvalds's avatar
Linus Torvalds committed
1905 1906 1907 1908 1909
struct dentry *d_alloc_name(struct dentry *parent, const char *name)
{
	struct qstr q;

	q.name = name;
1910
	q.hash_len = hashlen_string(parent, name);
Linus Torvalds's avatar
Linus Torvalds committed
1911 1912
	return d_alloc(parent, &q);
}
1913
EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds's avatar
Linus Torvalds committed
1914

1915 1916
void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
{
1917 1918
	WARN_ON_ONCE(dentry->d_op);
	WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH	|
1919 1920
				DCACHE_OP_COMPARE	|
				DCACHE_OP_REVALIDATE	|
1921
				DCACHE_OP_WEAK_REVALIDATE	|
1922
				DCACHE_OP_DELETE	|
Miklos Szeredi's avatar
Miklos Szeredi committed
1923
				DCACHE_OP_REAL));
1924 1925 1926 1927 1928 1929 1930 1931 1932
	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;
1933 1934
	if (op->d_weak_revalidate)
		dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
1935 1936
	if (op->d_delete)
		dentry->d_flags |= DCACHE_OP_DELETE;
1937 1938
	if (op->d_prune)
		dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredi's avatar
Miklos Szeredi committed
1939 1940
	if (op->d_real)
		dentry->d_flags |= DCACHE_OP_REAL;
1941 1942 1943 1944

}
EXPORT_SYMBOL(d_set_d_op);

1945 1946
static unsigned d_flags_for_inode(struct inode *inode)
{
1947
	unsigned add_flags = DCACHE_REGULAR_TYPE;
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959

	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;
		}
1960 1961 1962 1963
		goto type_determined;
	}

	if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1964
		if (unlikely(inode->i_op->get_link)) {
1965
			add_flags = DCACHE_SYMLINK_TYPE;
1966 1967 1968
			goto type_determined;
		}
		inode->i_opflags |= IOP_NOFOLLOW;
1969 1970
	}

1971 1972 1973 1974
	if (unlikely(!S_ISREG(inode->i_mode)))
		add_flags = DCACHE_SPECIAL_TYPE;

type_determined:
1975 1976 1977 1978 1979
	if (unlikely(IS_AUTOMOUNT(inode)))
		add_flags |= DCACHE_NEED_AUTOMOUNT;
	return add_flags;
}

1980 1981
static void __d_instantiate(struct dentry *dentry, struct inode *inode)
{
1982
	unsigned add_flags = d_flags_for_inode(inode);
1983
	WARN_ON(d_in_lookup(dentry));
1984

Nick Piggin's avatar
Nick Piggin committed
1985
	spin_lock(&dentry->d_lock);
1986 1987 1988 1989 1990
	/*
	 * Decrement negative dentry count if it was in the LRU list.
	 */
	if (dentry->d_flags & DCACHE_LRU_LIST)
		this_cpu_dec(nr_dentry_negative);
1991
	hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
1992
	raw_write_seqcount_begin(&dentry->d_seq);
1993
	__d_set_inode_and_type(dentry, inode, add_flags);
1994
	raw_write_seqcount_end(&dentry->d_seq);
Al Viro's avatar
Al Viro committed
1995
	fsnotify_update_flags(dentry);
Nick Piggin's avatar
Nick Piggin committed
1996
	spin_unlock(&dentry->d_lock);
1997 1998
}

Linus Torvalds's avatar
Linus Torvalds committed
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015
/**
 * 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)
{
2016
	BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
2017
	if (inode) {
2018
		security_d_instantiate(entry, inode);
2019
		spin_lock(&inode->i_lock);
2020
		__d_instantiate(entry, inode);
2021
		spin_unlock(&inode->i_lock);
2022
	}
Linus Torvalds's avatar
Linus Torvalds committed
2023
}
2024
EXPORT_SYMBOL(d_instantiate);
Linus Torvalds's avatar
Linus Torvalds committed
2025

2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
/*
 * This should be equivalent to d_instantiate() + unlock_new_inode(),
 * with lockdep-related part of unlock_new_inode() done before
 * anything else.  Use that instead of open-coding d_instantiate()/
 * unlock_new_inode() combinations.
 */
void d_instantiate_new(struct dentry *entry, struct inode *inode)
{
	BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
	BUG_ON(!inode);
	lockdep_annotate_inode_mutex_key(inode);
	security_d_instantiate(entry, inode);
	spin_lock(&inode->i_lock);
	__d_instantiate(entry, inode);
	WARN_ON(!(inode->i_state & I_NEW));
2041
	inode->i_state &= ~I_NEW & ~I_CREATING;
2042 2043 2044 2045 2046 2047
	smp_mb();
	wake_up_bit(&inode->i_state, __I_NEW);
	spin_unlock(&inode->i_lock);
}
EXPORT_SYMBOL(d_instantiate_new);

Al Viro's avatar
Al Viro committed
2048 2049 2050 2051 2052
struct dentry *d_make_root(struct inode *root_inode)
{
	struct dentry *res = NULL;

	if (root_inode) {
2053
		res = d_alloc_anon(root_inode->i_sb);
2054
		if (res)
Al Viro's avatar
Al Viro committed
2055
			d_instantiate(res, root_inode);
2056
		else
Al Viro's avatar
Al Viro committed
2057 2058 2059 2060 2061 2062
			iput(root_inode);
	}
	return res;
}
EXPORT_SYMBOL(d_make_root);

2063 2064
static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
{
2065 2066
	struct super_block *sb;
	struct dentry *new, *res;
2067 2068 2069 2070 2071 2072

	if (!inode)
		return ERR_PTR(-ESTALE);
	if (IS_ERR(inode))
		return ERR_CAST(inode);

2073 2074 2075
	sb = inode->i_sb;

	res = d_find_any_alias(inode); /* existing alias? */
2076
	if (res)
2077
		goto out;
2078

2079 2080
	new = d_alloc_anon(sb);
	if (!new) {
2081
		res = ERR_PTR(-ENOMEM);
2082
		goto out;
2083 2084
	}

2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
	security_d_instantiate(new, inode);
	spin_lock(&inode->i_lock);
	res = __d_find_any_alias(inode); /* recheck under lock */
	if (likely(!res)) { /* still no alias, attach a disconnected dentry */
		unsigned add_flags = d_flags_for_inode(inode);

		if (disconnected)
			add_flags |= DCACHE_DISCONNECTED;

		spin_lock(&new->d_lock);
		__d_set_inode_and_type(new, inode, add_flags);
		hlist_add_head(&new->d_u.d_alias, &inode->i_dentry);
		if (!disconnected) {
			hlist_bl_lock(&sb->s_roots);
			hlist_bl_add_head(&new->d_hash, &sb->s_roots);
			hlist_bl_unlock(&sb->s_roots);
		}
		spin_unlock(&new->d_lock);
		spin_unlock(&inode->i_lock);
		inode = NULL; /* consumed by new->d_inode */
		res = new;
	} else {
		spin_unlock(&inode->i_lock);
		dput(new);
	}
2110

2111
 out:
2112 2113 2114 2115
	iput(inode);
	return res;
}

2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
/**
 * 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)
{
2136
	return __d_obtain_alias(inode, true);
2137
}
2138
EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds's avatar
Linus Torvalds committed
2139

2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
/**
 * 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)
{
2157
	return __d_obtain_alias(inode, false);
2158 2159 2160
}
EXPORT_SYMBOL(d_obtain_root);

2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
/**
 * 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.
 *
2171 2172
 * For a case-insensitive lookup match and if the case-exact dentry
 * already exists in the dcache, use it and return it.
2173 2174 2175 2176
 *
 * If no entry exists with the exact case name, allocate new dentry with
 * the exact case, and return the spliced entry.
 */
2177
struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
2178 2179
			struct qstr *name)
{
2180
	struct dentry *found, *res;
2181

Christoph Hellwig's avatar
Christoph Hellwig committed
2182 2183 2184 2185
	/*
	 * First check if a dentry matching the name already exists,
	 * if not go ahead and create it now.
	 */
2186
	found = d_hash_and_lookup(dentry->d_parent, name);
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
	if (found) {
		iput(inode);
		return found;
	}
	if (d_in_lookup(dentry)) {
		found = d_alloc_parallel(dentry->d_parent, name,
					dentry->d_wait);
		if (IS_ERR(found) || !d_in_lookup(found)) {
			iput(inode);
			return found;
2197
		}
2198 2199 2200 2201 2202 2203 2204 2205 2206
	} else {
		found = d_alloc(dentry->d_parent, name);
		if (!found) {
			iput(inode);
			return ERR_PTR(-ENOMEM);
		} 
	}
	res = d_splice_alias(inode, found);
	if (res) {
2207
		d_lookup_done(found);
2208 2209
		dput(found);
		return res;
2210
	}
2211
	return found;
2212
}
2213
EXPORT_SYMBOL(d_add_ci);
Linus Torvalds's avatar
Linus Torvalds committed
2214

2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
/**
 * d_same_name - compare dentry name with case-exact name
 * @parent: parent dentry
 * @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
 *
 * Return: true if names are same, or false
 */
bool d_same_name(const struct dentry *dentry, const struct dentry *parent,
		 const struct qstr *name)
2225
{
Al Viro's avatar
Al Viro committed
2226 2227 2228 2229
	if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
		if (dentry->d_name.len != name->len)
			return false;
		return dentry_cmp(dentry, name->name, name->len) == 0;
2230
	}
2231
	return parent->d_op->d_compare(dentry,
Al Viro's avatar
Al Viro committed
2232 2233
				       dentry->d_name.len, dentry->d_name.name,
				       name) == 0;
2234
}
2235
EXPORT_SYMBOL_GPL(d_same_name);
2236

2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
/*
 * This is __d_lookup_rcu() when the parent dentry has
 * DCACHE_OP_COMPARE, which makes things much nastier.
 */
static noinline struct dentry *__d_lookup_rcu_op_compare(
	const struct dentry *parent,
	const struct qstr *name,
	unsigned *seqp)
{
	u64 hashlen = name->hash_len;
	struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
	struct hlist_bl_node *node;
	struct dentry *dentry;

	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
		int tlen;
		const char *tname;
		unsigned seq;

seqretry:
		seq = raw_seqcount_begin(&dentry->d_seq);
		if (dentry->d_parent != parent)
			continue;
		if (d_unhashed(dentry))
			continue;
		if (dentry->d_name.hash != hashlen_hash(hashlen))
			continue;
		tlen = dentry->d_name.len;
		tname = dentry->d_name.name;
		/* we want a consistent (name,len) pair */
		if (read_seqcount_retry(&dentry->d_seq, seq)) {
			cpu_relax();
			goto seqretry;
		}
		if (parent->d_op->d_compare(dentry, tlen, tname, name) != 0)
			continue;
		*seqp = seq;
		return dentry;
	}
	return NULL;
}

Nick Piggin's avatar
Nick Piggin committed
2279 2280 2281 2282
/**
 * __d_lookup_rcu - search for a dentry (racy, store-free)
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2283
 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin's avatar
Nick Piggin committed
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
 * 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.
 *
2297
 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin's avatar
Nick Piggin committed
2298 2299 2300 2301 2302 2303
 * 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.
2304 2305 2306
 *
 * NOTE! The caller *has* to check the resulting dentry against the sequence
 * number we've returned before using any of the resulting dentry state!
Nick Piggin's avatar
Nick Piggin committed
2307
 */
2308 2309
struct dentry *__d_lookup_rcu(const struct dentry *parent,
				const struct qstr *name,
2310
				unsigned *seqp)
Nick Piggin's avatar
Nick Piggin committed
2311
{
2312
	u64 hashlen = name->hash_len;
Nick Piggin's avatar
Nick Piggin committed
2313
	const unsigned char *str = name->name;
2314
	struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
2315
	struct hlist_bl_node *node;
Nick Piggin's avatar
Nick Piggin committed
2316 2317 2318 2319 2320 2321 2322 2323 2324
	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.
	 */

2325 2326 2327
	if (unlikely(parent->d_flags & DCACHE_OP_COMPARE))
		return __d_lookup_rcu_op_compare(parent, name, seqp);

Nick Piggin's avatar
Nick Piggin committed
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
	/*
	 * 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.
	 *
2339
	 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin's avatar
Nick Piggin committed
2340
	 */
2341
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
2342
		unsigned seq;
Nick Piggin's avatar
Nick Piggin committed
2343

2344 2345
		/*
		 * The dentry sequence count protects us from concurrent
2346
		 * renames, and thus protects parent and name fields.
2347 2348
		 *
		 * The caller must perform a seqcount check in order
2349
		 * to do anything useful with the returned dentry.
2350 2351 2352 2353 2354 2355 2356
		 *
		 * 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.
Al Viro's avatar
Al Viro committed
2357 2358 2359
		 *
		 * Note that raw_seqcount_begin still *does* smp_rmb(), so
		 * we are still guaranteed NUL-termination of ->d_name.name.
2360 2361
		 */
		seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin's avatar
Nick Piggin committed
2362 2363
		if (dentry->d_parent != parent)
			continue;
2364 2365
		if (d_unhashed(dentry))
			continue;
2366 2367 2368 2369
		if (dentry->d_name.hash_len != hashlen)
			continue;
		if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
			continue;
2370
		*seqp = seq;
Al Viro's avatar
Al Viro committed
2371
		return dentry;
Nick Piggin's avatar
Nick Piggin committed
2372 2373 2374 2375
	}
	return NULL;
}

Linus Torvalds's avatar
Linus Torvalds committed
2376 2377 2378 2379
/**
 * d_lookup - search for a dentry
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2380
 * Returns: dentry, or NULL
Linus Torvalds's avatar
Linus Torvalds committed
2381
 *
2382 2383 2384 2385
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
2386
 */
Al Viro's avatar
Al Viro committed
2387
struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
2388
{
Nick Piggin's avatar
Nick Piggin committed
2389
	struct dentry *dentry;
2390
	unsigned seq;
Linus Torvalds's avatar
Linus Torvalds committed
2391

2392 2393 2394 2395
	do {
		seq = read_seqbegin(&rename_lock);
		dentry = __d_lookup(parent, name);
		if (dentry)
Linus Torvalds's avatar
Linus Torvalds committed
2396 2397 2398 2399
			break;
	} while (read_seqretry(&rename_lock, seq));
	return dentry;
}
2400
EXPORT_SYMBOL(d_lookup);
Linus Torvalds's avatar
Linus Torvalds committed
2401

Nick Piggin's avatar
Nick Piggin committed
2402
/**
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
 * __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.
 */
Al Viro's avatar
Al Viro committed
2417
struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
2418 2419
{
	unsigned int hash = name->hash;
2420
	struct hlist_bl_head *b = d_hash(hash);
2421
	struct hlist_bl_node *node;
Nick Piggin's avatar
Nick Piggin committed
2422
	struct dentry *found = NULL;
2423
	struct dentry *dentry;
Linus Torvalds's avatar
Linus Torvalds committed
2424

Nick Piggin's avatar
Nick Piggin committed
2425 2426 2427 2428 2429 2430 2431
	/*
	 * 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.
	 */

2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
	/*
	 * 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.
	 *
2443
	 * See Documentation/filesystems/path-lookup.txt for more details.
2444
	 */
Linus Torvalds's avatar
Linus Torvalds committed
2445 2446
	rcu_read_lock();
	
2447
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds's avatar
Linus Torvalds committed
2448 2449 2450 2451 2452 2453 2454

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

		spin_lock(&dentry->d_lock);
		if (dentry->d_parent != parent)
			goto next;
2455 2456 2457
		if (d_unhashed(dentry))
			goto next;

Al Viro's avatar
Al Viro committed
2458 2459
		if (!d_same_name(dentry, parent, name))
			goto next;
Linus Torvalds's avatar
Linus Torvalds committed
2460

2461
		dentry->d_lockref.count++;
2462
		found = dentry;
Linus Torvalds's avatar
Linus Torvalds committed
2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
		spin_unlock(&dentry->d_lock);
		break;
next:
		spin_unlock(&dentry->d_lock);
 	}
 	rcu_read_unlock();

 	return found;
}

2473 2474 2475 2476 2477
/**
 * 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
 *
2478
 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
2479 2480 2481 2482 2483 2484 2485 2486
 */
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.
	 */
2487
	name->hash = full_name_hash(dir, name->name, name->len);
2488
	if (dir->d_flags & DCACHE_OP_HASH) {
2489
		int err = dir->d_op->d_hash(dir, name);
2490 2491
		if (unlikely(err < 0))
			return ERR_PTR(err);
2492
	}
2493
	return d_lookup(dir, name);
2494
}
2495
EXPORT_SYMBOL(d_hash_and_lookup);
2496

Linus Torvalds's avatar
Linus Torvalds committed
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
/*
 * 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)
{
2520 2521 2522 2523
	struct inode *inode = dentry->d_inode;

	spin_lock(&inode->i_lock);
	spin_lock(&dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
2524 2525 2526
	/*
	 * Are we the only user?
	 */
2527
	if (dentry->d_lockref.count == 1) {
2528
		dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin's avatar
Nick Piggin committed
2529
		dentry_unlink_inode(dentry);
2530
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
2531
		__d_drop(dentry);
2532 2533 2534
		spin_unlock(&dentry->d_lock);
		spin_unlock(&inode->i_lock);
	}
Linus Torvalds's avatar
Linus Torvalds committed
2535
}
2536
EXPORT_SYMBOL(d_delete);
Linus Torvalds's avatar
Linus Torvalds committed
2537

2538
static void __d_rehash(struct dentry *entry)
Linus Torvalds's avatar
Linus Torvalds committed
2539
{
2540
	struct hlist_bl_head *b = d_hash(entry->d_name.hash);
2541

2542
	hlist_bl_lock(b);
2543
	hlist_bl_add_head_rcu(&entry->d_hash, b);
2544
	hlist_bl_unlock(b);
Linus Torvalds's avatar
Linus Torvalds committed
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
}

/**
 * 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);
2557
	__d_rehash(entry);
Linus Torvalds's avatar
Linus Torvalds committed
2558 2559
	spin_unlock(&entry->d_lock);
}
2560
EXPORT_SYMBOL(d_rehash);
Linus Torvalds's avatar
Linus Torvalds committed
2561

2562 2563
static inline unsigned start_dir_add(struct inode *dir)
{
2564
	preempt_disable_nested();
2565 2566 2567 2568 2569 2570 2571 2572
	for (;;) {
		unsigned n = dir->i_dir_seq;
		if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
			return n;
		cpu_relax();
	}
}

2573 2574
static inline void end_dir_add(struct inode *dir, unsigned int n,
			       wait_queue_head_t *d_wait)
2575 2576
{
	smp_store_release(&dir->i_dir_seq, n + 2);
2577
	preempt_enable_nested();
2578
	wake_up_all(d_wait);
2579 2580
}

2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594
static void d_wait_lookup(struct dentry *dentry)
{
	if (d_in_lookup(dentry)) {
		DECLARE_WAITQUEUE(wait, current);
		add_wait_queue(dentry->d_wait, &wait);
		do {
			set_current_state(TASK_UNINTERRUPTIBLE);
			spin_unlock(&dentry->d_lock);
			schedule();
			spin_lock(&dentry->d_lock);
		} while (d_in_lookup(dentry));
	}
}

2595
struct dentry *d_alloc_parallel(struct dentry *parent,
2596 2597
				const struct qstr *name,
				wait_queue_head_t *wq)
2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610
{
	unsigned int hash = name->hash;
	struct hlist_bl_head *b = in_lookup_hash(parent, hash);
	struct hlist_bl_node *node;
	struct dentry *new = d_alloc(parent, name);
	struct dentry *dentry;
	unsigned seq, r_seq, d_seq;

	if (unlikely(!new))
		return ERR_PTR(-ENOMEM);

retry:
	rcu_read_lock();
2611
	seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631
	r_seq = read_seqbegin(&rename_lock);
	dentry = __d_lookup_rcu(parent, name, &d_seq);
	if (unlikely(dentry)) {
		if (!lockref_get_not_dead(&dentry->d_lockref)) {
			rcu_read_unlock();
			goto retry;
		}
		if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
			rcu_read_unlock();
			dput(dentry);
			goto retry;
		}
		rcu_read_unlock();
		dput(new);
		return dentry;
	}
	if (unlikely(read_seqretry(&rename_lock, r_seq))) {
		rcu_read_unlock();
		goto retry;
	}
2632 2633 2634 2635 2636 2637

	if (unlikely(seq & 1)) {
		rcu_read_unlock();
		goto retry;
	}

2638
	hlist_bl_lock(b);
2639
	if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655
		hlist_bl_unlock(b);
		rcu_read_unlock();
		goto retry;
	}
	/*
	 * No changes for the parent since the beginning of d_lookup().
	 * Since all removals from the chain happen with hlist_bl_lock(),
	 * any potential in-lookup matches are going to stay here until
	 * we unlock the chain.  All fields are stable in everything
	 * we encounter.
	 */
	hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
		if (dentry->d_name.hash != hash)
			continue;
		if (dentry->d_parent != parent)
			continue;
Al Viro's avatar
Al Viro committed
2656 2657
		if (!d_same_name(dentry, parent, name))
			continue;
2658
		hlist_bl_unlock(b);
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669
		/* now we can try to grab a reference */
		if (!lockref_get_not_dead(&dentry->d_lockref)) {
			rcu_read_unlock();
			goto retry;
		}

		rcu_read_unlock();
		/*
		 * somebody is likely to be still doing lookup for it;
		 * wait for them to finish
		 */
2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683
		spin_lock(&dentry->d_lock);
		d_wait_lookup(dentry);
		/*
		 * it's not in-lookup anymore; in principle we should repeat
		 * everything from dcache lookup, but it's likely to be what
		 * d_lookup() would've found anyway.  If it is, just return it;
		 * otherwise we really have to repeat the whole thing.
		 */
		if (unlikely(dentry->d_name.hash != hash))
			goto mismatch;
		if (unlikely(dentry->d_parent != parent))
			goto mismatch;
		if (unlikely(d_unhashed(dentry)))
			goto mismatch;
Al Viro's avatar
Al Viro committed
2684 2685
		if (unlikely(!d_same_name(dentry, parent, name)))
			goto mismatch;
2686 2687
		/* OK, it *is* a hashed match; return it */
		spin_unlock(&dentry->d_lock);
2688 2689 2690
		dput(new);
		return dentry;
	}
2691
	rcu_read_unlock();
2692 2693
	/* we can't take ->d_lock here; it's OK, though. */
	new->d_flags |= DCACHE_PAR_LOOKUP;
2694
	new->d_wait = wq;
2695 2696 2697
	hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
	hlist_bl_unlock(b);
	return new;
2698 2699 2700 2701
mismatch:
	spin_unlock(&dentry->d_lock);
	dput(dentry);
	goto retry;
2702 2703 2704
}
EXPORT_SYMBOL(d_alloc_parallel);

2705 2706 2707 2708 2709 2710
/*
 * - Unhash the dentry
 * - Retrieve and clear the waitqueue head in dentry
 * - Return the waitqueue head
 */
static wait_queue_head_t *__d_lookup_unhash(struct dentry *dentry)
2711
{
2712 2713 2714 2715 2716 2717
	wait_queue_head_t *d_wait;
	struct hlist_bl_head *b;

	lockdep_assert_held(&dentry->d_lock);

	b = in_lookup_hash(dentry->d_parent, dentry->d_name.hash);
2718
	hlist_bl_lock(b);
2719
	dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
2720
	__hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
2721
	d_wait = dentry->d_wait;
2722
	dentry->d_wait = NULL;
2723 2724
	hlist_bl_unlock(b);
	INIT_HLIST_NODE(&dentry->d_u.d_alias);
2725
	INIT_LIST_HEAD(&dentry->d_lru);
2726 2727 2728 2729 2730 2731 2732 2733
	return d_wait;
}

void __d_lookup_unhash_wake(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	wake_up_all(__d_lookup_unhash(dentry));
	spin_unlock(&dentry->d_lock);
2734
}
2735
EXPORT_SYMBOL(__d_lookup_unhash_wake);
Al Viro's avatar
Al Viro committed
2736 2737 2738 2739 2740

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

static inline void __d_add(struct dentry *dentry, struct inode *inode)
{
2741
	wait_queue_head_t *d_wait;
2742 2743
	struct inode *dir = NULL;
	unsigned n;
2744
	spin_lock(&dentry->d_lock);
2745 2746 2747
	if (unlikely(d_in_lookup(dentry))) {
		dir = dentry->d_parent->d_inode;
		n = start_dir_add(dir);
2748
		d_wait = __d_lookup_unhash(dentry);
2749
	}
Al Viro's avatar
Al Viro committed
2750
	if (inode) {
2751 2752 2753 2754 2755
		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);
Al Viro's avatar
Al Viro committed
2756
		fsnotify_update_flags(dentry);
Al Viro's avatar
Al Viro committed
2757
	}
2758
	__d_rehash(dentry);
2759
	if (dir)
2760
		end_dir_add(dir, n, d_wait);
2761 2762 2763
	spin_unlock(&dentry->d_lock);
	if (inode)
		spin_unlock(&inode->i_lock);
Al Viro's avatar
Al Viro committed
2764 2765
}

Al Viro's avatar
Al Viro committed
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
/**
 * 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)
{
2777 2778
	if (inode) {
		security_d_instantiate(entry, inode);
Al Viro's avatar
Al Viro committed
2779
		spin_lock(&inode->i_lock);
2780
	}
Al Viro's avatar
Al Viro committed
2781
	__d_add(entry, inode);
Al Viro's avatar
Al Viro committed
2782 2783 2784
}
EXPORT_SYMBOL(d_add);

2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
/**
 * 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;
	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;
Al Viro's avatar
Al Viro committed
2812
		if (!d_same_name(alias, entry->d_parent, &entry->d_name))
2813 2814 2815 2816 2817 2818 2819
			continue;
		spin_lock(&alias->d_lock);
		if (!d_unhashed(alias)) {
			spin_unlock(&alias->d_lock);
			alias = NULL;
		} else {
			__dget_dlock(alias);
2820
			__d_rehash(alias);
2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
			spin_unlock(&alias->d_lock);
		}
		spin_unlock(&inode->i_lock);
		return alias;
	}
	spin_unlock(&inode->i_lock);
	return NULL;
}
EXPORT_SYMBOL(d_exact_alias);

2831
static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds's avatar
Linus Torvalds committed
2832
{
2833 2834
	if (unlikely(dname_external(target))) {
		if (unlikely(dname_external(dentry))) {
Linus Torvalds's avatar
Linus Torvalds committed
2835 2836 2837
			/*
			 * Both external: swap the pointers
			 */
2838
			swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds's avatar
Linus Torvalds committed
2839 2840 2841 2842 2843
		} else {
			/*
			 * dentry:internal, target:external.  Steal target's
			 * storage and make target internal.
			 */
2844 2845
			memcpy(target->d_iname, dentry->d_name.name,
					dentry->d_name.len + 1);
Linus Torvalds's avatar
Linus Torvalds committed
2846 2847 2848 2849
			dentry->d_name.name = target->d_name.name;
			target->d_name.name = target->d_iname;
		}
	} else {
2850
		if (unlikely(dname_external(dentry))) {
Linus Torvalds's avatar
Linus Torvalds committed
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860
			/*
			 * 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 {
			/*
Miklos Szeredi's avatar
Miklos Szeredi committed
2861
			 * Both are internal.
Linus Torvalds's avatar
Linus Torvalds committed
2862
			 */
Miklos Szeredi's avatar
Miklos Szeredi committed
2863 2864 2865 2866 2867 2868
			unsigned int i;
			BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
			for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
				swap(((long *) &dentry->d_iname)[i],
				     ((long *) &target->d_iname)[i]);
			}
Linus Torvalds's avatar
Linus Torvalds committed
2869 2870
		}
	}
2871
	swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds's avatar
Linus Torvalds committed
2872 2873
}

2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
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)))
2889
		kfree_rcu(old_name, u.head);
2890 2891
}

2892
/*
2893
 * __d_move - move a dentry
Linus Torvalds's avatar
Linus Torvalds committed
2894 2895
 * @dentry: entry to move
 * @target: new dentry
Miklos Szeredi's avatar
Miklos Szeredi committed
2896
 * @exchange: exchange the two dentries
Linus Torvalds's avatar
Linus Torvalds committed
2897 2898
 *
 * Update the dcache to reflect the move of a file name. Negative
2899 2900 2901
 * 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().
Linus Torvalds's avatar
Linus Torvalds committed
2902
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
2903 2904
static void __d_move(struct dentry *dentry, struct dentry *target,
		     bool exchange)
Linus Torvalds's avatar
Linus Torvalds committed
2905
{
2906
	struct dentry *old_parent, *p;
2907
	wait_queue_head_t *d_wait;
2908 2909
	struct inode *dir = NULL;
	unsigned n;
Linus Torvalds's avatar
Linus Torvalds committed
2910

2911 2912 2913 2914
	WARN_ON(!dentry->d_inode);
	if (WARN_ON(dentry == target))
		return;

Nick Piggin's avatar
Nick Piggin committed
2915
	BUG_ON(d_ancestor(target, dentry));
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933
	old_parent = dentry->d_parent;
	p = d_ancestor(old_parent, target);
	if (IS_ROOT(dentry)) {
		BUG_ON(p);
		spin_lock(&target->d_parent->d_lock);
	} else if (!p) {
		/* target is not a descendent of dentry->d_parent */
		spin_lock(&target->d_parent->d_lock);
		spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
	} else {
		BUG_ON(p == dentry);
		spin_lock(&old_parent->d_lock);
		if (p != target)
			spin_lock_nested(&target->d_parent->d_lock,
					DENTRY_D_LOCK_NESTED);
	}
	spin_lock_nested(&dentry->d_lock, 2);
	spin_lock_nested(&target->d_lock, 3);
Nick Piggin's avatar
Nick Piggin committed
2934

2935 2936 2937
	if (unlikely(d_in_lookup(target))) {
		dir = target->d_parent->d_inode;
		n = start_dir_add(dir);
2938
		d_wait = __d_lookup_unhash(target);
2939
	}
Linus Torvalds's avatar
Linus Torvalds committed
2940

Nick Piggin's avatar
Nick Piggin committed
2941
	write_seqcount_begin(&dentry->d_seq);
2942
	write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin's avatar
Nick Piggin committed
2943

2944
	/* unhash both */
2945 2946 2947 2948
	if (!d_unhashed(dentry))
		___d_drop(dentry);
	if (!d_unhashed(target))
		___d_drop(target);
Linus Torvalds's avatar
Linus Torvalds committed
2949

2950 2951 2952
	/* ... and switch them in the tree */
	dentry->d_parent = target->d_parent;
	if (!exchange) {
2953
		copy_name(dentry, target);
2954
		target->d_hash.pprev = NULL;
2955
		dentry->d_parent->d_lockref.count++;
2956
		if (dentry != old_parent) /* wasn't IS_ROOT */
2957
			WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds's avatar
Linus Torvalds committed
2958
	} else {
2959 2960
		target->d_parent = old_parent;
		swap_names(dentry, target);
2961
		list_move(&target->d_child, &target->d_parent->d_subdirs);
2962 2963
		__d_rehash(target);
		fsnotify_update_flags(target);
Linus Torvalds's avatar
Linus Torvalds committed
2964
	}
2965 2966 2967
	list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
	__d_rehash(dentry);
	fsnotify_update_flags(dentry);
2968
	fscrypt_handle_d_move(dentry);
Linus Torvalds's avatar
Linus Torvalds committed
2969

Nick Piggin's avatar
Nick Piggin committed
2970 2971 2972
	write_seqcount_end(&target->d_seq);
	write_seqcount_end(&dentry->d_seq);

2973
	if (dir)
2974
		end_dir_add(dir, n, d_wait);
2975 2976 2977 2978 2979 2980 2981

	if (dentry->d_parent != old_parent)
		spin_unlock(&dentry->d_parent->d_lock);
	if (dentry != old_parent)
		spin_unlock(&old_parent->d_lock);
	spin_unlock(&target->d_lock);
	spin_unlock(&dentry->d_lock);
2982 2983 2984 2985 2986 2987 2988 2989
}

/*
 * d_move - move a dentry
 * @dentry: entry to move
 * @target: new dentry
 *
 * Update the dcache to reflect the move of a file name. Negative
2990 2991
 * dcache entries should not be moved in this way. See the locking
 * requirements for __d_move.
2992 2993 2994 2995
 */
void d_move(struct dentry *dentry, struct dentry *target)
{
	write_seqlock(&rename_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
2996
	__d_move(dentry, target, false);
Linus Torvalds's avatar
Linus Torvalds committed
2997
	write_sequnlock(&rename_lock);
2998
}
2999
EXPORT_SYMBOL(d_move);
Linus Torvalds's avatar
Linus Torvalds committed
3000

Miklos Szeredi's avatar
Miklos Szeredi committed
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019
/*
 * 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);
}

3020 3021 3022 3023 3024 3025 3026
/**
 * 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.
3027
 */
3028
struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
3029 3030 3031
{
	struct dentry *p;

3032
	for (p = p2; !IS_ROOT(p); p = p->d_parent) {
3033
		if (p->d_parent == p1)
3034
			return p;
3035
	}
3036
	return NULL;
3037 3038 3039 3040 3041 3042
}

/*
 * This helper attempts to cope with remotely renamed directories
 *
 * It assumes that the caller is already holding
3043
 * dentry->d_parent->d_inode->i_mutex, and rename_lock
3044 3045 3046 3047
 *
 * Note: If ever the locking in lock_rename() changes, then please
 * remember to update this too...
 */
3048
static int __d_unalias(struct inode *inode,
3049
		struct dentry *dentry, struct dentry *alias)
3050
{
3051 3052
	struct mutex *m1 = NULL;
	struct rw_semaphore *m2 = NULL;
3053
	int ret = -ESTALE;
3054 3055 3056 3057 3058 3059 3060 3061 3062

	/* 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;
3063
	if (!inode_trylock_shared(alias->d_parent->d_inode))
3064
		goto out_err;
3065
	m2 = &alias->d_parent->d_inode->i_rwsem;
3066
out_unalias:
3067
	__d_move(alias, dentry, false);
3068
	ret = 0;
3069 3070
out_err:
	if (m2)
3071
		up_read(m2);
3072 3073 3074 3075 3076
	if (m1)
		mutex_unlock(m1);
	return ret;
}

3077 3078 3079 3080 3081
/**
 * 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.
 *
3082 3083 3084
 * 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.
3085
 *
3086 3087 3088
 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
 * we should error out: directories can't have multiple aliases.
 *
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104
 * 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);

3105 3106
	BUG_ON(!d_unhashed(dentry));

3107
	if (!inode)
3108
		goto out;
3109

3110
	security_d_instantiate(dentry, inode);
3111
	spin_lock(&inode->i_lock);
3112
	if (S_ISDIR(inode->i_mode)) {
3113 3114
		struct dentry *new = __d_find_any_alias(inode);
		if (unlikely(new)) {
3115 3116
			/* The reference to new ensures it remains an alias */
			spin_unlock(&inode->i_lock);
3117
			write_seqlock(&rename_lock);
3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128
			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)) {
3129
				struct dentry *old_parent = dget(new->d_parent);
3130
				int err = __d_unalias(inode, dentry, new);
3131
				write_sequnlock(&rename_lock);
3132 3133 3134 3135
				if (err) {
					dput(new);
					new = ERR_PTR(err);
				}
3136
				dput(old_parent);
3137
			} else {
3138 3139
				__d_move(new, dentry, false);
				write_sequnlock(&rename_lock);
3140
			}
3141 3142
			iput(inode);
			return new;
3143
		}
3144
	}
3145
out:
Al Viro's avatar
Al Viro committed
3146
	__d_add(dentry, inode);
3147
	return NULL;
3148
}
3149
EXPORT_SYMBOL(d_splice_alias);
3150

Linus Torvalds's avatar
Linus Torvalds committed
3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
/*
 * 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
 *
3162 3163
 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
 * Returns false otherwise.
Linus Torvalds's avatar
Linus Torvalds committed
3164 3165 3166
 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
 */
  
3167
bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds's avatar
Linus Torvalds committed
3168
{
3169
	bool result;
3170
	unsigned seq;
Linus Torvalds's avatar
Linus Torvalds committed
3171

3172
	if (new_dentry == old_dentry)
3173
		return true;
3174 3175

	do {
Linus Torvalds's avatar
Linus Torvalds committed
3176 3177
		/* for restarting inner loop in case of seq retry */
		seq = read_seqbegin(&rename_lock);
3178 3179 3180 3181 3182
		/*
		 * Need rcu_readlock to protect against the d_parent trashing
		 * due to d_move
		 */
		rcu_read_lock();
3183
		if (d_ancestor(old_dentry, new_dentry))
3184
			result = true;
3185
		else
3186
			result = false;
3187
		rcu_read_unlock();
Linus Torvalds's avatar
Linus Torvalds committed
3188 3189 3190 3191
	} while (read_seqretry(&rename_lock, seq));

	return result;
}
3192
EXPORT_SYMBOL(is_subdir);
Linus Torvalds's avatar
Linus Torvalds committed
3193

Miklos Szeredi's avatar
Miklos Szeredi committed
3194
static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds's avatar
Linus Torvalds committed
3195
{
Miklos Szeredi's avatar
Miklos Szeredi committed
3196 3197 3198 3199
	struct dentry *root = data;
	if (dentry != root) {
		if (d_unhashed(dentry) || !dentry->d_inode)
			return D_WALK_SKIP;
Linus Torvalds's avatar
Linus Torvalds committed
3200

3201 3202 3203 3204
		if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
			dentry->d_flags |= DCACHE_GENOCIDE;
			dentry->d_lockref.count--;
		}
Linus Torvalds's avatar
Linus Torvalds committed
3205
	}
Miklos Szeredi's avatar
Miklos Szeredi committed
3206 3207
	return D_WALK_CONTINUE;
}
3208

Miklos Szeredi's avatar
Miklos Szeredi committed
3209 3210
void d_genocide(struct dentry *parent)
{
Al Viro's avatar
Al Viro committed
3211
	d_walk(parent, parent, d_genocide_kill);
Linus Torvalds's avatar
Linus Torvalds committed
3212 3213
}

3214
void d_mark_tmpfile(struct file *file, struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
3215
{
3216 3217
	struct dentry *dentry = file->f_path.dentry;

3218
	BUG_ON(dentry->d_name.name != dentry->d_iname ||
3219
		!hlist_unhashed(&dentry->d_u.d_alias) ||
3220 3221 3222 3223 3224 3225 3226
		!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);
3227 3228 3229 3230 3231 3232 3233 3234 3235
}
EXPORT_SYMBOL(d_mark_tmpfile);

void d_tmpfile(struct file *file, struct inode *inode)
{
	struct dentry *dentry = file->f_path.dentry;

	inode_dec_link_count(inode);
	d_mark_tmpfile(file, inode);
3236
	d_instantiate(dentry, inode);
Linus Torvalds's avatar
Linus Torvalds committed
3237
}
3238
EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds's avatar
Linus Torvalds committed
3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259

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)
{
	/* 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",
3260
					sizeof(struct hlist_bl_head),
Linus Torvalds's avatar
Linus Torvalds committed
3261 3262
					dhash_entries,
					13,
3263
					HASH_EARLY | HASH_ZERO,
Linus Torvalds's avatar
Linus Torvalds committed
3264
					&d_hash_shift,
3265
					NULL,
3266
					0,
Linus Torvalds's avatar
Linus Torvalds committed
3267
					0);
3268
	d_hash_shift = 32 - d_hash_shift;
Linus Torvalds's avatar
Linus Torvalds committed
3269 3270
}

3271
static void __init dcache_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
3272
{
3273
	/*
Linus Torvalds's avatar
Linus Torvalds committed
3274 3275
	 * A constructor could be added for stable state like the lists,
	 * but it is probably not worth it because of the cache nature
3276
	 * of the dcache.
Linus Torvalds's avatar
Linus Torvalds committed
3277
	 */
3278 3279 3280
	dentry_cache = KMEM_CACHE_USERCOPY(dentry,
		SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
		d_iname);
Linus Torvalds's avatar
Linus Torvalds committed
3281 3282 3283 3284 3285 3286 3287

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

	dentry_hashtable =
		alloc_large_system_hash("Dentry cache",
3288
					sizeof(struct hlist_bl_head),
Linus Torvalds's avatar
Linus Torvalds committed
3289 3290
					dhash_entries,
					13,
3291
					HASH_ZERO,
Linus Torvalds's avatar
Linus Torvalds committed
3292
					&d_hash_shift,
3293
					NULL,
3294
					0,
Linus Torvalds's avatar
Linus Torvalds committed
3295
					0);
3296
	d_hash_shift = 32 - d_hash_shift;
Linus Torvalds's avatar
Linus Torvalds committed
3297 3298 3299
}

/* SLAB cache for __getname() consumers */
3300
struct kmem_cache *names_cachep __ro_after_init;
3301
EXPORT_SYMBOL(names_cachep);
Linus Torvalds's avatar
Linus Torvalds committed
3302 3303 3304

void __init vfs_caches_init_early(void)
{
3305 3306 3307 3308 3309
	int i;

	for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
		INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);

Linus Torvalds's avatar
Linus Torvalds committed
3310 3311 3312 3313
	dcache_init_early();
	inode_init_early();
}

3314
void __init vfs_caches_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
3315
{
3316 3317
	names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
			SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
3318

3319 3320
	dcache_init();
	inode_init();
3321 3322
	files_init();
	files_maxfiles_init();
3323
	mnt_init();
Linus Torvalds's avatar
Linus Torvalds committed
3324 3325 3326
	bdev_cache_init();
	chrdev_init();
}