dcache.c 84.6 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

38 39
#include <asm/runtime-const.h>

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

Al Viro's avatar
Al Viro committed
79
__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds's avatar
Linus Torvalds committed
80

81
EXPORT_SYMBOL(rename_lock);
Linus Torvalds's avatar
Linus Torvalds committed
82

83
static struct kmem_cache *dentry_cache __ro_after_init;
Linus Torvalds's avatar
Linus Torvalds committed
84

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

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

101
static unsigned int d_hash_shift __ro_after_init;
102

103
static struct hlist_bl_head *dentry_hashtable __ro_after_init;
104

105
static inline struct hlist_bl_head *d_hash(unsigned long hashlen)
106
{
107 108
	return runtime_const_ptr(dentry_hashtable) +
		runtime_const_shift_right_32(hashlen, d_hash_shift);
109 110
}

111 112 113 114 115 116 117 118 119 120
#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);
}

121 122 123 124 125 126 127
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
128 129
};

130
static DEFINE_PER_CPU(long, nr_dentry);
131
static DEFINE_PER_CPU(long, nr_dentry_unused);
132
static DEFINE_PER_CPU(long, nr_dentry_negative);
133 134

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

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

161 162 163 164 165 166 167 168 169
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;
}

170 171 172 173 174 175 176 177 178 179
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;
}

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

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);
205 206
#endif

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

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

244
#else
245

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

258 259
#endif

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

280
	return dentry_string_cmp(cs, ct, tcount);
281 282
}

283 284 285 286 287 288 289 290 291 292 293 294 295
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
296
static void __d_free(struct rcu_head *head)
Linus Torvalds's avatar
Linus Torvalds committed
297
{
Christoph Hellwig's avatar
Christoph Hellwig committed
298 299
	struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);

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

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

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

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

341 342 343 344 345 346 347 348
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
349
	flags &= ~DCACHE_ENTRY_TYPE;
350
	flags |= type_flags;
351
	smp_store_release(&dentry->d_flags, flags);
352 353 354 355 356 357
}

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
358
	flags &= ~DCACHE_ENTRY_TYPE;
359 360
	WRITE_ONCE(dentry->d_flags, flags);
	dentry->d_inode = NULL;
361 362 363 364 365
	/*
	 * The negative counter only tracks dentries on the LRU. Don't inc if
	 * d_lru is on another list.
	 */
	if ((flags & (DCACHE_LRU_LIST|DCACHE_SHRINK_LIST)) == DCACHE_LRU_LIST)
366
		this_cpu_inc(nr_dentry_negative);
367 368
}

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

Linus Torvalds's avatar
Linus Torvalds committed
386 387
/*
 * Release the dentry's inode, using the filesystem
388
 * d_iput() operation if defined.
Nick Piggin's avatar
Nick Piggin committed
389 390 391
 */
static void dentry_unlink_inode(struct dentry * dentry)
	__releases(dentry->d_lock)
392
	__releases(dentry->d_inode->i_lock)
Nick Piggin's avatar
Nick Piggin committed
393 394
{
	struct inode *inode = dentry->d_inode;
395

396
	raw_write_seqcount_begin(&dentry->d_seq);
397
	__d_clear_type_and_inode(dentry);
398
	hlist_del_init(&dentry->d_u.d_alias);
399
	raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin's avatar
Nick Piggin committed
400
	spin_unlock(&dentry->d_lock);
401
	spin_unlock(&inode->i_lock);
Nick Piggin's avatar
Nick Piggin committed
402 403 404 405 406 407 408 409
	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);
}

410 411 412 413 414 415 416 417 418 419 420
/*
 * 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.
 *
421 422 423 424 425
 * 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().
 *
426 427 428 429 430 431 432 433 434
 * 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);
435 436
	if (d_is_negative(dentry))
		this_cpu_inc(nr_dentry_negative);
437 438
	WARN_ON_ONCE(!list_lru_add_obj(
			&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
439 440 441 442 443 444 445
}

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);
446 447
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
448 449
	WARN_ON_ONCE(!list_lru_del_obj(
			&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
}

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.
 */
474
static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
475 476 477 478
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags &= ~DCACHE_LRU_LIST;
	this_cpu_dec(nr_dentry_unused);
479 480
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
481
	list_lru_isolate(lru, &dentry->d_lru);
482 483
}

484 485
static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
			      struct list_head *list)
486 487 488
{
	D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
	dentry->d_flags |= DCACHE_SHRINK_LIST;
489 490
	if (d_is_negative(dentry))
		this_cpu_dec(nr_dentry_negative);
491
	list_lru_isolate_move(lru, &dentry->d_lru, list);
492 493
}

494
static void ___d_drop(struct dentry *dentry)
Nick Piggin's avatar
Nick Piggin committed
495
{
496 497 498 499 500 501 502 503 504 505
	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);
506

507 508 509
	hlist_bl_lock(b);
	__hlist_bl_del(&dentry->d_hash);
	hlist_bl_unlock(b);
Nick Piggin's avatar
Nick Piggin committed
510
}
511 512 513

void __d_drop(struct dentry *dentry)
{
514 515 516 517 518
	if (!d_unhashed(dentry)) {
		___d_drop(dentry);
		dentry->d_hash.pprev = NULL;
		write_seqcount_invalidate(&dentry->d_seq);
	}
519
}
Nick Piggin's avatar
Nick Piggin committed
520 521
EXPORT_SYMBOL(__d_drop);

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
/**
 * 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
540 541 542 543 544 545 546 547
void d_drop(struct dentry *dentry)
{
	spin_lock(&dentry->d_lock);
	__d_drop(dentry);
	spin_unlock(&dentry->d_lock);
}
EXPORT_SYMBOL(d_drop);

548
static inline void dentry_unlist(struct dentry *dentry)
Al Viro's avatar
Al Viro committed
549 550 551 552 553 554 555
{
	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;
556
	if (unlikely(hlist_unhashed(&dentry->d_sib)))
Al Viro's avatar
Al Viro committed
557
		return;
558
	__hlist_del(&dentry->d_sib);
Al Viro's avatar
Al Viro committed
559 560
	/*
	 * Cursors can move around the list of children.  While we'd been
561
	 * a normal list member, it didn't matter - ->d_sib.next would've
Al Viro's avatar
Al Viro committed
562 563 564 565 566 567 568
	 * 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
569
	 * using the value left in its ->d_sib.next.  And if _that_
Al Viro's avatar
Al Viro committed
570 571 572 573
	 * 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.
	 *
574
	 * Solution: make sure that the pointer left behind in ->d_sib.next
Al Viro's avatar
Al Viro committed
575 576 577
	 * points to something that won't be moving around.  I.e. skip the
	 * cursors.
	 */
578 579
	while (dentry->d_sib.next) {
		next = hlist_entry(dentry->d_sib.next, struct dentry, d_sib);
Al Viro's avatar
Al Viro committed
580 581
		if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
			break;
582
		dentry->d_sib.next = next->d_sib.next;
Al Viro's avatar
Al Viro committed
583 584 585
	}
}

586
static struct dentry *__dentry_kill(struct dentry *dentry)
587
{
588 589
	struct dentry *parent = NULL;
	bool can_free = true;
Nick Piggin's avatar
Nick Piggin committed
590

591 592 593 594 595
	/*
	 * The dentry is now unrecoverably dead to the world.
	 */
	lockref_mark_dead(&dentry->d_lockref);

596 597 598 599
	/*
	 * inform the fs via d_prune that this dentry is about to be
	 * unhashed and destroyed.
	 */
600
	if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng's avatar
Yan, Zheng committed
601 602
		dentry->d_op->d_prune(dentry);

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

617 618 619 620 621
	cond_resched();
	/* now that it's negative, ->d_parent is stable */
	if (!IS_ROOT(dentry)) {
		parent = dentry->d_parent;
		spin_lock(&parent->d_lock);
622
	}
623 624
	spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
	dentry_unlist(dentry);
Al Viro's avatar
Al Viro committed
625
	if (dentry->d_flags & DCACHE_SHRINK_LIST)
626 627 628 629
		can_free = false;
	spin_unlock(&dentry->d_lock);
	if (likely(can_free))
		dentry_free(dentry);
630
	if (parent && --parent->d_lockref.count) {
631
		spin_unlock(&parent->d_lock);
632
		return NULL;
633 634 635 636
	}
	return parent;
}

637 638 639 640 641 642 643 644
/*
 * Lock a dentry for feeding it to __dentry_kill().
 * Called under rcu_read_lock() and dentry->d_lock; the former
 * guarantees that nothing we access will be freed under us.
 * Note that dentry is *not* protected from concurrent dentry_kill(),
 * d_delete(), etc.
 *
 * Return false if dentry is busy.  Otherwise, return true and have
645
 * that dentry's inode locked.
646 647 648
 */

static bool lock_for_kill(struct dentry *dentry)
649
{
650 651 652 653 654
	struct inode *inode = dentry->d_inode;

	if (unlikely(dentry->d_lockref.count))
		return false;

655
	if (!inode || likely(spin_trylock(&inode->i_lock)))
656 657
		return true;

658 659 660 661
	do {
		spin_unlock(&dentry->d_lock);
		spin_lock(&inode->i_lock);
		spin_lock(&dentry->d_lock);
662 663
		if (likely(inode == dentry->d_inode))
			break;
664
		spin_unlock(&inode->i_lock);
665
		inode = dentry->d_inode;
666
	} while (inode);
667 668 669 670 671
	if (likely(!dentry->d_lockref.count))
		return true;
	if (inode)
		spin_unlock(&inode->i_lock);
	return false;
672 673
}

674 675 676 677 678 679 680 681 682 683 684 685
/*
 * Decide if dentry is worth retaining.  Usually this is called with dentry
 * locked; if not locked, we are more limited and might not be able to tell
 * without a lock.  False in this case means "punt to locked path and recheck".
 *
 * In case we aren't locked, these predicates 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.
 */
static inline bool retain_dentry(struct dentry *dentry, bool locked)
686
{
687
	unsigned int d_flags;
688

689 690
	smp_rmb();
	d_flags = READ_ONCE(dentry->d_flags);
691

692
	// Unreachable? Nobody would be able to look it up, no point retaining
693 694 695
	if (unlikely(d_unhashed(dentry)))
		return false;

696 697
	// Same if it's disconnected
	if (unlikely(d_flags & DCACHE_DISCONNECTED))
698 699
		return false;

700 701 702 703
	// ->d_delete() might tell us not to bother, but that requires
	// ->d_lock; can't decide without it
	if (unlikely(d_flags & DCACHE_OP_DELETE)) {
		if (!locked || dentry->d_op->d_delete(dentry))
704 705
			return false;
	}
Ira Weiny's avatar
Ira Weiny committed
706

707 708
	// Explicitly told not to bother
	if (unlikely(d_flags & DCACHE_DONTCACHE))
Ira Weiny's avatar
Ira Weiny committed
709 710
		return false;

711 712 713 714 715 716 717 718
	// At this point it looks like we ought to keep it.  We also might
	// need to do something - put it on LRU if it wasn't there already
	// and mark it referenced if it was on LRU, but not marked yet.
	// Unfortunately, both actions require ->d_lock, so in lockless
	// case we'd have to punt rather than doing those.
	if (unlikely(!(d_flags & DCACHE_LRU_LIST))) {
		if (!locked)
			return false;
719
		d_lru_add(dentry);
720 721 722
	} else if (unlikely(!(d_flags & DCACHE_REFERENCED))) {
		if (!locked)
			return false;
723
		dentry->d_flags |= DCACHE_REFERENCED;
724
	}
725 726 727
	return true;
}

Ira Weiny's avatar
Ira Weiny committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
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);

743 744 745 746
/*
 * Try to do a lockless dput(), and return whether that was successful.
 *
 * If unsuccessful, we return false, having already taken the dentry lock.
747 748
 * In that case refcount is guaranteed to be zero and we have already
 * decided that it's not worth keeping around.
749 750 751 752 753 754 755 756 757
 *
 * 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;

	/*
758
	 * try to decrement the lockref optimistically.
759 760 761 762 763 764 765 766 767 768
	 */
	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);
769
		if (WARN_ON_ONCE(dentry->d_lockref.count <= 0)) {
770
			spin_unlock(&dentry->d_lock);
771
			return true;
772
		}
773 774
		dentry->d_lockref.count--;
		goto locked;
775 776 777 778 779 780
	}

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

	/*
784 785 786 787
	 * Can we decide that decrement of refcount is all we needed without
	 * taking the lock?  There's a very common case when it's all we need -
	 * dentry looks like it ought to be retained and there's nothing else
	 * to do.
788
	 */
789
	if (retain_dentry(dentry, false))
790
		return true;
791 792

	/*
793 794 795
	 * Either not worth retaining or we can't tell without the lock.
	 * Get the lock, then.  We've already decremented the refcount to 0,
	 * but we'll need to re-check the situation after getting the lock.
796 797 798 799 800 801 802 803 804
	 */
	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.
	 */
805
locked:
806
	if (dentry->d_lockref.count || retain_dentry(dentry, true)) {
807
		spin_unlock(&dentry->d_lock);
808
		return true;
809
	}
810
	return false;
811 812 813
}


Linus Torvalds's avatar
Linus Torvalds committed
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
/* 
 * 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)
{
842 843 844 845 846
	if (!dentry)
		return;
	might_sleep();
	rcu_read_lock();
	if (likely(fast_dput(dentry))) {
847
		rcu_read_unlock();
848 849 850 851 852 853
		return;
	}
	while (lock_for_kill(dentry)) {
		rcu_read_unlock();
		dentry = __dentry_kill(dentry);
		if (!dentry)
854
			return;
855
		if (retain_dentry(dentry, true)) {
856 857 858
			spin_unlock(&dentry->d_lock);
			return;
		}
859
		rcu_read_lock();
860
	}
861 862
	rcu_read_unlock();
	spin_unlock(&dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
863
}
864
EXPORT_SYMBOL(dput);
Linus Torvalds's avatar
Linus Torvalds committed
865

866
static void to_shrink_list(struct dentry *dentry, struct list_head *list)
867 868
__must_hold(&dentry->d_lock)
{
869
	if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
870 871
		if (dentry->d_flags & DCACHE_LRU_LIST)
			d_lru_del(dentry);
872
		d_shrink_add(dentry, list);
873 874 875 876 877 878 879 880 881 882 883
	}
}

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();
884
	to_shrink_list(dentry, list);
885 886
	spin_unlock(&dentry->d_lock);
}
Linus Torvalds's avatar
Linus Torvalds committed
887

888 889
struct dentry *dget_parent(struct dentry *dentry)
{
890
	int gotref;
891
	struct dentry *ret;
Al Viro's avatar
Al Viro committed
892
	unsigned seq;
893

894 895 896 897 898
	/*
	 * Do optimistic parent lookup without any
	 * locking.
	 */
	rcu_read_lock();
Al Viro's avatar
Al Viro committed
899
	seq = raw_seqcount_begin(&dentry->d_seq);
900
	ret = READ_ONCE(dentry->d_parent);
901 902 903
	gotref = lockref_get_not_zero(&ret->d_lockref);
	rcu_read_unlock();
	if (likely(gotref)) {
Al Viro's avatar
Al Viro committed
904
		if (!read_seqcount_retry(&dentry->d_seq, seq))
905 906 907 908
			return ret;
		dput(ret);
	}

909
repeat:
910 911 912 913 914
	/*
	 * Don't need rcu_dereference because we re-check it was correct under
	 * the lock.
	 */
	rcu_read_lock();
915
	ret = dentry->d_parent;
916 917 918 919
	spin_lock(&ret->d_lock);
	if (unlikely(ret != dentry->d_parent)) {
		spin_unlock(&ret->d_lock);
		rcu_read_unlock();
920 921
		goto repeat;
	}
922
	rcu_read_unlock();
923 924
	BUG_ON(!ret->d_lockref.count);
	ret->d_lockref.count++;
925 926 927 928 929
	spin_unlock(&ret->d_lock);
	return ret;
}
EXPORT_SYMBOL(dget_parent);

930 931 932 933 934 935 936
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
937
	lockref_get(&alias->d_lockref);
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
	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);

959
static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
960
{
961 962 963 964
	struct dentry *alias;

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

966
	hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Piggin's avatar
Nick Piggin committed
967
		spin_lock(&alias->d_lock);
968
 		if (!d_unhashed(alias)) {
969
			dget_dlock(alias);
970 971
			spin_unlock(&alias->d_lock);
			return alias;
Linus Torvalds's avatar
Linus Torvalds committed
972
		}
Nick Piggin's avatar
Nick Piggin committed
973
		spin_unlock(&alias->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
974
	}
Nick Piggin's avatar
Nick Piggin committed
975
	return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
976 977
}

978 979 980 981 982 983 984 985 986 987 988 989 990 991
/**
 * 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
992
struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
993
{
994 995
	struct dentry *de = NULL;

996
	if (!hlist_empty(&inode->i_dentry)) {
997
		spin_lock(&inode->i_lock);
998
		de = __d_find_alias(inode);
999
		spin_unlock(&inode->i_lock);
1000
	}
Linus Torvalds's avatar
Linus Torvalds committed
1001 1002
	return de;
}
1003
EXPORT_SYMBOL(d_find_alias);
Linus Torvalds's avatar
Linus Torvalds committed
1004

Al Viro's avatar
Al Viro committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
/*
 *  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
1030 1031 1032 1033 1034 1035
/*
 *	Try to kill dentries associated with this inode.
 * WARNING: you must own a reference to inode.
 */
void d_prune_aliases(struct inode *inode)
{
1036
	LIST_HEAD(dispose);
1037
	struct dentry *dentry;
1038

1039
	spin_lock(&inode->i_lock);
1040
	hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds's avatar
Linus Torvalds committed
1041
		spin_lock(&dentry->d_lock);
1042 1043
		if (!dentry->d_lockref.count)
			to_shrink_list(dentry, &dispose);
Linus Torvalds's avatar
Linus Torvalds committed
1044 1045
		spin_unlock(&dentry->d_lock);
	}
1046
	spin_unlock(&inode->i_lock);
1047
	shrink_dentry_list(&dispose);
Linus Torvalds's avatar
Linus Torvalds committed
1048
}
1049
EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds's avatar
Linus Torvalds committed
1050

1051
static inline void shrink_kill(struct dentry *victim)
Linus Torvalds's avatar
Linus Torvalds committed
1052
{
1053 1054 1055 1056 1057 1058 1059 1060
	do {
		rcu_read_unlock();
		victim = __dentry_kill(victim);
		rcu_read_lock();
	} while (victim && lock_for_kill(victim));
	rcu_read_unlock();
	if (victim)
		spin_unlock(&victim->d_lock);
1061
}
1062

1063
void shrink_dentry_list(struct list_head *list)
1064 1065
{
	while (!list_empty(list)) {
1066
		struct dentry *dentry;
1067

1068 1069
		dentry = list_entry(list->prev, struct dentry, d_lru);
		spin_lock(&dentry->d_lock);
1070
		rcu_read_lock();
1071
		if (!lock_for_kill(dentry)) {
1072
			bool can_free;
1073
			rcu_read_unlock();
1074
			d_shrink_del(dentry);
Al Viro's avatar
Al Viro committed
1075
			can_free = dentry->d_flags & DCACHE_DENTRY_KILLED;
1076 1077 1078 1079 1080
			spin_unlock(&dentry->d_lock);
			if (can_free)
				dentry_free(dentry);
			continue;
		}
1081
		d_shrink_del(dentry);
1082
		shrink_kill(dentry);
1083
	}
1084 1085
}

1086 1087
static enum lru_status dentry_lru_isolate(struct list_head *item,
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
{
	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) {
1107
		d_lru_isolate(lru, dentry);
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
		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
1124
		 * list_lru_add_obj and list_lru_del_obj. List movement in this file
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
		 * 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;
	}

1138
	d_lru_shrink_move(lru, dentry, freeable);
1139 1140 1141 1142 1143
	spin_unlock(&dentry->d_lock);

	return LRU_REMOVED;
}

1144
/**
1145 1146
 * prune_dcache_sb - shrink the dcache
 * @sb: superblock
1147
 * @sc: shrink control, passed to list_lru_shrink_walk()
1148
 *
1149 1150
 * 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
1151
 * function.
1152
 *
1153 1154
 * This function may fail to free any resources if all the dentries are in
 * use.
1155
 */
1156
long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
1157
{
1158 1159
	LIST_HEAD(dispose);
	long freed;
1160

1161 1162
	freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
				     dentry_lru_isolate, &dispose);
1163
	shrink_dentry_list(&dispose);
1164
	return freed;
1165
}
Nick Piggin's avatar
Nick Piggin committed
1166

1167
static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
1168
		struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1169
{
1170 1171
	struct list_head *freeable = arg;
	struct dentry	*dentry = container_of(item, struct dentry, d_lru);
1172

1173 1174 1175 1176 1177 1178 1179 1180
	/*
	 * 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;

1181
	d_lru_shrink_move(lru, dentry, freeable);
1182
	spin_unlock(&dentry->d_lock);
1183

1184
	return LRU_REMOVED;
1185 1186
}

1187

Linus Torvalds's avatar
Linus Torvalds committed
1188 1189 1190 1191
/**
 * shrink_dcache_sb - shrink dcache for a superblock
 * @sb: superblock
 *
1192 1193
 * 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
1194
 */
1195
void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds's avatar
Linus Torvalds committed
1196
{
1197 1198 1199
	do {
		LIST_HEAD(dispose);

1200
		list_lru_walk(&sb->s_dentry_lru,
1201
			dentry_lru_isolate_shrink, &dispose, 1024);
1202
		shrink_dentry_list(&dispose);
1203
	} while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds's avatar
Linus Torvalds committed
1204
}
1205
EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds's avatar
Linus Torvalds committed
1206

Miklos Szeredi's avatar
Miklos Szeredi committed
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
/**
 * 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,
};
1220

Linus Torvalds's avatar
Linus Torvalds committed
1221
/**
Miklos Szeredi's avatar
Miklos Szeredi committed
1222 1223 1224 1225
 * 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
1226
 *
Al Viro's avatar
Al Viro committed
1227
 * The @enter() callbacks are called with d_lock held.
Linus Torvalds's avatar
Linus Torvalds committed
1228
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
1229
static void d_walk(struct dentry *parent, void *data,
Al Viro's avatar
Al Viro committed
1230
		   enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds's avatar
Linus Torvalds committed
1231
{
1232
	struct dentry *this_parent, *dentry;
1233
	unsigned seq = 0;
Miklos Szeredi's avatar
Miklos Szeredi committed
1234 1235
	enum d_walk_ret ret;
	bool retry = true;
1236

1237
again:
1238
	read_seqbegin_or_lock(&rename_lock, &seq);
1239
	this_parent = parent;
Nick Piggin's avatar
Nick Piggin committed
1240
	spin_lock(&this_parent->d_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

	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
1253
repeat:
1254
	dentry = d_first_child(this_parent);
Linus Torvalds's avatar
Linus Torvalds committed
1255
resume:
1256
	hlist_for_each_entry_from(dentry, d_sib) {
Al Viro's avatar
Al Viro committed
1257 1258 1259
		if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
			continue;

Nick Piggin's avatar
Nick Piggin committed
1260
		spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredi's avatar
Miklos Szeredi committed
1261 1262 1263 1264 1265 1266

		ret = enter(data, dentry);
		switch (ret) {
		case D_WALK_CONTINUE:
			break;
		case D_WALK_QUIT:
Nick Piggin's avatar
Nick Piggin committed
1267
			spin_unlock(&dentry->d_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
1268 1269 1270 1271 1272 1273 1274
			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
1275
		}
Miklos Szeredi's avatar
Miklos Szeredi committed
1276

1277
		if (!hlist_empty(&dentry->d_children)) {
Nick Piggin's avatar
Nick Piggin committed
1278
			spin_unlock(&this_parent->d_lock);
1279
			spin_release(&dentry->d_lock.dep_map, _RET_IP_);
Linus Torvalds's avatar
Linus Torvalds committed
1280
			this_parent = dentry;
Nick Piggin's avatar
Nick Piggin committed
1281
			spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds's avatar
Linus Torvalds committed
1282 1283
			goto repeat;
		}
Nick Piggin's avatar
Nick Piggin committed
1284
		spin_unlock(&dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1285 1286 1287 1288
	}
	/*
	 * All done at this level ... ascend and resume the search.
	 */
Al Viro's avatar
Al Viro committed
1289 1290
	rcu_read_lock();
ascend:
Linus Torvalds's avatar
Linus Torvalds committed
1291
	if (this_parent != parent) {
1292 1293
		dentry = this_parent;
		this_parent = dentry->d_parent;
1294

1295
		spin_unlock(&dentry->d_lock);
1296 1297
		spin_lock(&this_parent->d_lock);

Al Viro's avatar
Al Viro committed
1298 1299
		/* might go back up the wrong parent if we have had a rename. */
		if (need_seqretry(&rename_lock, seq))
1300
			goto rename_retry;
Al Viro's avatar
Al Viro committed
1301
		/* go into the first sibling still alive */
1302 1303 1304 1305 1306 1307 1308
		hlist_for_each_entry_continue(dentry, d_sib) {
			if (likely(!(dentry->d_flags & DCACHE_DENTRY_KILLED))) {
				rcu_read_unlock();
				goto resume;
			}
		}
		goto ascend;
Linus Torvalds's avatar
Linus Torvalds committed
1309
	}
Al Viro's avatar
Al Viro committed
1310
	if (need_seqretry(&rename_lock, seq))
1311
		goto rename_retry;
Al Viro's avatar
Al Viro committed
1312
	rcu_read_unlock();
Miklos Szeredi's avatar
Miklos Szeredi committed
1313 1314 1315

out_unlock:
	spin_unlock(&this_parent->d_lock);
1316
	done_seqretry(&rename_lock, seq);
Miklos Szeredi's avatar
Miklos Szeredi committed
1317
	return;
1318 1319

rename_retry:
Al Viro's avatar
Al Viro committed
1320 1321 1322
	spin_unlock(&this_parent->d_lock);
	rcu_read_unlock();
	BUG_ON(seq & 1);
Miklos Szeredi's avatar
Miklos Szeredi committed
1323 1324
	if (!retry)
		return;
1325
	seq = 1;
1326
	goto again;
Linus Torvalds's avatar
Linus Torvalds committed
1327
}
Miklos Szeredi's avatar
Miklos Szeredi committed
1328

Ian Kent's avatar
Ian Kent committed
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
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
1361
	d_walk(parent->dentry, &data, path_check_mount);
Ian Kent's avatar
Ian Kent committed
1362 1363 1364 1365 1366 1367
	read_sequnlock_excl(&mount_lock);

	return data.mounted;
}
EXPORT_SYMBOL(path_has_submounts);

1368 1369 1370 1371 1372
/*
 * 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).
 *
1373
 * Only one of d_invalidate() and d_set_mounted() must succeed.  For
1374 1375 1376 1377 1378 1379 1380 1381
 * 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) {
1382
		/* Need exclusion wrt. d_invalidate() */
1383 1384 1385 1386 1387 1388 1389 1390 1391
		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)) {
1392 1393 1394 1395 1396
		ret = -EBUSY;
		if (!d_mountpoint(dentry)) {
			dentry->d_flags |= DCACHE_MOUNTED;
			ret = 0;
		}
1397 1398 1399 1400 1401 1402 1403
	}
 	spin_unlock(&dentry->d_lock);
out:
	write_sequnlock(&rename_lock);
	return ret;
}

Linus Torvalds's avatar
Linus Torvalds committed
1404
/*
1405
 * Search the dentry child list of the specified parent,
Linus Torvalds's avatar
Linus Torvalds committed
1406 1407
 * and move any unused dentries to the end of the unused
 * list for prune_dcache(). We descend to the next level
1408
 * whenever the d_children list is non-empty and continue
Linus Torvalds's avatar
Linus Torvalds committed
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
 * 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
1419 1420
struct select_data {
	struct dentry *start;
1421 1422 1423 1424
	union {
		long found;
		struct dentry *victim;
	};
Miklos Szeredi's avatar
Miklos Szeredi committed
1425 1426
	struct list_head dispose;
};
Nick Piggin's avatar
Nick Piggin committed
1427

Miklos Szeredi's avatar
Miklos Szeredi committed
1428 1429 1430 1431
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
1432

Miklos Szeredi's avatar
Miklos Szeredi committed
1433 1434
	if (data->start == dentry)
		goto out;
Nick Piggin's avatar
Nick Piggin committed
1435

1436
	if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredi's avatar
Miklos Szeredi committed
1437
		data->found++;
1438 1439 1440
	} else if (!dentry->d_lockref.count) {
		to_shrink_list(dentry, &data->dispose);
		data->found++;
1441 1442
	} else if (dentry->d_lockref.count < 0) {
		data->found++;
Linus Torvalds's avatar
Linus Torvalds committed
1443
	}
Miklos Szeredi's avatar
Miklos Szeredi committed
1444 1445 1446 1447 1448
	/*
	 * We can return to the caller if we have found some (this
	 * ensures forward progress). We'll be coming back to find
	 * the rest.
	 */
1449 1450
	if (!list_empty(&data->dispose))
		ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds's avatar
Linus Torvalds committed
1451
out:
Miklos Szeredi's avatar
Miklos Szeredi committed
1452
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
1453 1454
}

1455 1456 1457 1458 1459 1460 1461 1462
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;

1463 1464
	if (!dentry->d_lockref.count) {
		if (dentry->d_flags & DCACHE_SHRINK_LIST) {
1465 1466 1467 1468
			rcu_read_lock();
			data->victim = dentry;
			return D_WALK_QUIT;
		}
1469
		to_shrink_list(dentry, &data->dispose);
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
	}
	/*
	 * 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
1482 1483 1484 1485 1486 1487
/**
 * 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
1488
void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds's avatar
Linus Torvalds committed
1489
{
Miklos Szeredi's avatar
Miklos Szeredi committed
1490
	for (;;) {
1491
		struct select_data data = {.start = parent};
Linus Torvalds's avatar
Linus Torvalds committed
1492

Miklos Szeredi's avatar
Miklos Szeredi committed
1493
		INIT_LIST_HEAD(&data.dispose);
Al Viro's avatar
Al Viro committed
1494
		d_walk(parent, &data, select_collect);
1495 1496 1497 1498 1499 1500 1501

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

		cond_resched();
Miklos Szeredi's avatar
Miklos Szeredi committed
1502 1503
		if (!data.found)
			break;
1504 1505 1506 1507
		data.victim = NULL;
		d_walk(parent, &data, select_collect2);
		if (data.victim) {
			spin_lock(&data.victim->d_lock);
1508
			if (!lock_for_kill(data.victim)) {
1509 1510 1511
				spin_unlock(&data.victim->d_lock);
				rcu_read_unlock();
			} else {
1512
				shrink_kill(data.victim);
1513 1514 1515 1516
			}
		}
		if (!list_empty(&data.dispose))
			shrink_dentry_list(&data.dispose);
1517
	}
Linus Torvalds's avatar
Linus Torvalds committed
1518
}
1519
EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds's avatar
Linus Torvalds committed
1520

1521
static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
1522
{
1523
	/* it has busy descendents; complain about those instead */
1524
	if (!hlist_empty(&dentry->d_children))
1525
		return D_WALK_CONTINUE;
1526

1527 1528 1529 1530
	/* root with refcount 1 is fine */
	if (dentry == _data && dentry->d_lockref.count == 1)
		return D_WALK_CONTINUE;

1531
	WARN(1, "BUG: Dentry %p{i=%lx,n=%pd} "
1532
			" still in use (%d) [unmount of %s %s]\n",
1533 1534 1535
		       dentry,
		       dentry->d_inode ?
		       dentry->d_inode->i_ino : 0UL,
1536
		       dentry,
1537 1538 1539
		       dentry->d_lockref.count,
		       dentry->d_sb->s_type->name,
		       dentry->d_sb->s_id);
1540 1541 1542 1543 1544 1545
	return D_WALK_CONTINUE;
}

static void do_one_tree(struct dentry *dentry)
{
	shrink_dcache_parent(dentry);
Al Viro's avatar
Al Viro committed
1546
	d_walk(dentry, dentry, umount_check);
1547 1548
	d_drop(dentry);
	dput(dentry);
1549 1550 1551 1552 1553 1554 1555 1556 1557
}

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

1558
	rwsem_assert_held_write(&sb->s_umount);
1559 1560 1561

	dentry = sb->s_root;
	sb->s_root = NULL;
1562
	do_one_tree(dentry);
1563

1564 1565
	while (!hlist_bl_empty(&sb->s_roots)) {
		dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
1566
		do_one_tree(dentry);
1567 1568 1569
	}
}

1570
static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
1571
{
1572
	struct dentry **victim = _data;
1573
	if (d_mountpoint(dentry)) {
1574
		*victim = dget_dlock(dentry);
1575 1576
		return D_WALK_QUIT;
	}
1577
	return D_WALK_CONTINUE;
1578 1579 1580
}

/**
1581 1582
 * d_invalidate - detach submounts, prune dcache, and drop
 * @dentry: dentry to invalidate (aka detach, prune and drop)
1583
 */
1584
void d_invalidate(struct dentry *dentry)
1585
{
1586
	bool had_submounts = false;
1587 1588 1589
	spin_lock(&dentry->d_lock);
	if (d_unhashed(dentry)) {
		spin_unlock(&dentry->d_lock);
1590
		return;
1591
	}
1592
	__d_drop(dentry);
1593 1594
	spin_unlock(&dentry->d_lock);

1595
	/* Negative dentries can be dropped without further checks */
1596
	if (!dentry->d_inode)
1597
		return;
1598

1599
	shrink_dcache_parent(dentry);
1600
	for (;;) {
1601
		struct dentry *victim = NULL;
Al Viro's avatar
Al Viro committed
1602
		d_walk(dentry, &victim, find_submount);
1603 1604 1605
		if (!victim) {
			if (had_submounts)
				shrink_dcache_parent(dentry);
1606
			return;
1607
		}
1608 1609 1610
		had_submounts = true;
		detach_mounts(victim);
		dput(victim);
1611 1612
	}
}
1613
EXPORT_SYMBOL(d_invalidate);
1614

Linus Torvalds's avatar
Linus Torvalds committed
1615
/**
1616 1617
 * __d_alloc	-	allocate a dcache entry
 * @sb: filesystem it will belong to
Linus Torvalds's avatar
Linus Torvalds committed
1618 1619 1620 1621 1622 1623 1624
 * @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
1625
static struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
1626 1627 1628
{
	struct dentry *dentry;
	char *dname;
Miklos Szeredi's avatar
Miklos Szeredi committed
1629
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
1630

1631 1632
	dentry = kmem_cache_alloc_lru(dentry_cache, &sb->s_dentry_lru,
				      GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
1633 1634 1635
	if (!dentry)
		return NULL;

1636 1637 1638 1639 1640 1641 1642
	/*
	 * 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;
1643
	if (unlikely(!name)) {
1644
		name = &slash_name;
1645 1646
		dname = dentry->d_iname;
	} else if (name->len > DNAME_INLINE_LEN-1) {
1647
		size_t size = offsetof(struct external_name, name[1]);
1648 1649 1650 1651
		struct external_name *p = kmalloc(size + name->len,
						  GFP_KERNEL_ACCOUNT |
						  __GFP_RECLAIMABLE);
		if (!p) {
Linus Torvalds's avatar
Linus Torvalds committed
1652 1653 1654
			kmem_cache_free(dentry_cache, dentry); 
			return NULL;
		}
1655 1656
		atomic_set(&p->u.count, 1);
		dname = p->name;
Linus Torvalds's avatar
Linus Torvalds committed
1657 1658 1659 1660 1661 1662 1663 1664 1665
	} 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;

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

1669
	dentry->d_lockref.count = 1;
1670
	dentry->d_flags = 0;
Linus Torvalds's avatar
Linus Torvalds committed
1671
	spin_lock_init(&dentry->d_lock);
1672
	seqcount_spinlock_init(&dentry->d_seq, &dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
1673
	dentry->d_inode = NULL;
1674 1675
	dentry->d_parent = dentry;
	dentry->d_sb = sb;
Linus Torvalds's avatar
Linus Torvalds committed
1676 1677
	dentry->d_op = NULL;
	dentry->d_fsdata = NULL;
1678
	INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds's avatar
Linus Torvalds committed
1679
	INIT_LIST_HEAD(&dentry->d_lru);
1680
	INIT_HLIST_HEAD(&dentry->d_children);
1681
	INIT_HLIST_NODE(&dentry->d_u.d_alias);
1682
	INIT_HLIST_NODE(&dentry->d_sib);
1683
	d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds's avatar
Linus Torvalds committed
1684

Miklos Szeredi's avatar
Miklos Szeredi committed
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
	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;
		}
	}

1695
	this_cpu_inc(nr_dentry);
1696

Linus Torvalds's avatar
Linus Torvalds committed
1697 1698
	return dentry;
}
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718

/**
 * 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
	 */
1719
	dentry->d_parent = dget_dlock(parent);
1720
	hlist_add_head(&dentry->d_sib, &parent->d_children);
1721 1722 1723 1724
	spin_unlock(&parent->d_lock);

	return dentry;
}
1725
EXPORT_SYMBOL(d_alloc);
Linus Torvalds's avatar
Linus Torvalds committed
1726

1727 1728 1729 1730 1731 1732
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
1733 1734
struct dentry *d_alloc_cursor(struct dentry * parent)
{
1735
	struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viro's avatar
Al Viro committed
1736
	if (dentry) {
1737
		dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viro's avatar
Al Viro committed
1738 1739 1740 1741 1742
		dentry->d_parent = dget(parent);
	}
	return dentry;
}

1743 1744 1745 1746 1747 1748 1749
/**
 * 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.
1750 1751 1752 1753
 * 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
1754 1755 1756
 *
 * The only user is alloc_file_pseudo() and that's what should
 * be considered a public interface.  Don't use directly.
1757
 */
1758 1759
struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
{
1760 1761 1762
	static const struct dentry_operations anon_ops = {
		.d_dname = simple_dname
	};
1763
	struct dentry *dentry = __d_alloc(sb, name);
1764
	if (likely(dentry)) {
1765
		dentry->d_flags |= DCACHE_NORCU;
1766 1767 1768
		if (!sb->s_d_op)
			d_set_d_op(dentry, &anon_ops);
	}
1769
	return dentry;
1770 1771
}

Linus Torvalds's avatar
Linus Torvalds committed
1772 1773 1774 1775 1776
struct dentry *d_alloc_name(struct dentry *parent, const char *name)
{
	struct qstr q;

	q.name = name;
1777
	q.hash_len = hashlen_string(parent, name);
Linus Torvalds's avatar
Linus Torvalds committed
1778 1779
	return d_alloc(parent, &q);
}
1780
EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds's avatar
Linus Torvalds committed
1781

1782 1783
void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
{
1784 1785
	WARN_ON_ONCE(dentry->d_op);
	WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH	|
1786 1787
				DCACHE_OP_COMPARE	|
				DCACHE_OP_REVALIDATE	|
1788
				DCACHE_OP_WEAK_REVALIDATE	|
1789
				DCACHE_OP_DELETE	|
Miklos Szeredi's avatar
Miklos Szeredi committed
1790
				DCACHE_OP_REAL));
1791 1792 1793 1794 1795 1796 1797 1798 1799
	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;
1800 1801
	if (op->d_weak_revalidate)
		dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
1802 1803
	if (op->d_delete)
		dentry->d_flags |= DCACHE_OP_DELETE;
1804 1805
	if (op->d_prune)
		dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredi's avatar
Miklos Szeredi committed
1806 1807
	if (op->d_real)
		dentry->d_flags |= DCACHE_OP_REAL;
1808 1809 1810 1811

}
EXPORT_SYMBOL(d_set_d_op);

1812 1813
static unsigned d_flags_for_inode(struct inode *inode)
{
1814
	unsigned add_flags = DCACHE_REGULAR_TYPE;
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826

	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;
		}
1827 1828 1829 1830
		goto type_determined;
	}

	if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1831
		if (unlikely(inode->i_op->get_link)) {
1832
			add_flags = DCACHE_SYMLINK_TYPE;
1833 1834 1835
			goto type_determined;
		}
		inode->i_opflags |= IOP_NOFOLLOW;
1836 1837
	}

1838 1839 1840 1841
	if (unlikely(!S_ISREG(inode->i_mode)))
		add_flags = DCACHE_SPECIAL_TYPE;

type_determined:
1842 1843 1844 1845 1846
	if (unlikely(IS_AUTOMOUNT(inode)))
		add_flags |= DCACHE_NEED_AUTOMOUNT;
	return add_flags;
}

1847 1848
static void __d_instantiate(struct dentry *dentry, struct inode *inode)
{
1849
	unsigned add_flags = d_flags_for_inode(inode);
1850
	WARN_ON(d_in_lookup(dentry));
1851

Nick Piggin's avatar
Nick Piggin committed
1852
	spin_lock(&dentry->d_lock);
1853
	/*
1854 1855
	 * The negative counter only tracks dentries on the LRU. Don't dec if
	 * d_lru is on another list.
1856
	 */
1857 1858
	if ((dentry->d_flags &
	     (DCACHE_LRU_LIST|DCACHE_SHRINK_LIST)) == DCACHE_LRU_LIST)
1859
		this_cpu_dec(nr_dentry_negative);
1860
	hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
1861
	raw_write_seqcount_begin(&dentry->d_seq);
1862
	__d_set_inode_and_type(dentry, inode, add_flags);
1863
	raw_write_seqcount_end(&dentry->d_seq);
Al Viro's avatar
Al Viro committed
1864
	fsnotify_update_flags(dentry);
Nick Piggin's avatar
Nick Piggin committed
1865
	spin_unlock(&dentry->d_lock);
1866 1867
}

Linus Torvalds's avatar
Linus Torvalds committed
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
/**
 * 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)
{
1885
	BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1886
	if (inode) {
1887
		security_d_instantiate(entry, inode);
1888
		spin_lock(&inode->i_lock);
1889
		__d_instantiate(entry, inode);
1890
		spin_unlock(&inode->i_lock);
1891
	}
Linus Torvalds's avatar
Linus Torvalds committed
1892
}
1893
EXPORT_SYMBOL(d_instantiate);
Linus Torvalds's avatar
Linus Torvalds committed
1894

1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
/*
 * 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));
1910
	inode->i_state &= ~I_NEW & ~I_CREATING;
1911 1912 1913 1914 1915 1916
	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
1917 1918 1919 1920 1921
struct dentry *d_make_root(struct inode *root_inode)
{
	struct dentry *res = NULL;

	if (root_inode) {
1922
		res = d_alloc_anon(root_inode->i_sb);
1923
		if (res)
Al Viro's avatar
Al Viro committed
1924
			d_instantiate(res, root_inode);
1925
		else
Al Viro's avatar
Al Viro committed
1926 1927 1928 1929 1930 1931
			iput(root_inode);
	}
	return res;
}
EXPORT_SYMBOL(d_make_root);

1932 1933
static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
{
1934 1935
	struct super_block *sb;
	struct dentry *new, *res;
1936 1937 1938 1939 1940 1941

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

1942 1943 1944
	sb = inode->i_sb;

	res = d_find_any_alias(inode); /* existing alias? */
1945
	if (res)
1946
		goto out;
1947

1948 1949
	new = d_alloc_anon(sb);
	if (!new) {
1950
		res = ERR_PTR(-ENOMEM);
1951
		goto out;
1952 1953
	}

1954 1955 1956 1957 1958 1959 1960 1961
	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;
1962

1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
		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);
	}
1979

1980
 out:
1981 1982 1983 1984
	iput(inode);
	return res;
}

1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
/**
 * 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)
{
2005
	return __d_obtain_alias(inode, true);
2006
}
2007
EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds's avatar
Linus Torvalds committed
2008

2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
/**
 * 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)
{
2026
	return __d_obtain_alias(inode, false);
2027 2028 2029
}
EXPORT_SYMBOL(d_obtain_root);

2030 2031 2032 2033 2034 2035 2036 2037 2038 2039
/**
 * 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.
 *
2040 2041
 * For a case-insensitive lookup match and if the case-exact dentry
 * already exists in the dcache, use it and return it.
2042 2043 2044 2045
 *
 * If no entry exists with the exact case name, allocate new dentry with
 * the exact case, and return the spliced entry.
 */
2046
struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
2047 2048
			struct qstr *name)
{
2049
	struct dentry *found, *res;
2050

Christoph Hellwig's avatar
Christoph Hellwig committed
2051 2052 2053 2054
	/*
	 * First check if a dentry matching the name already exists,
	 * if not go ahead and create it now.
	 */
2055
	found = d_hash_and_lookup(dentry->d_parent, name);
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
	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;
2066
		}
2067 2068 2069 2070 2071 2072 2073 2074 2075
	} else {
		found = d_alloc(dentry->d_parent, name);
		if (!found) {
			iput(inode);
			return ERR_PTR(-ENOMEM);
		} 
	}
	res = d_splice_alias(inode, found);
	if (res) {
2076
		d_lookup_done(found);
2077 2078
		dput(found);
		return res;
2079
	}
2080
	return found;
2081
}
2082
EXPORT_SYMBOL(d_add_ci);
Linus Torvalds's avatar
Linus Torvalds committed
2083

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
/**
 * 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)
2094
{
Al Viro's avatar
Al Viro committed
2095 2096 2097 2098
	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;
2099
	}
2100
	return parent->d_op->d_compare(dentry,
Al Viro's avatar
Al Viro committed
2101 2102
				       dentry->d_name.len, dentry->d_name.name,
				       name) == 0;
2103
}
2104
EXPORT_SYMBOL_GPL(d_same_name);
2105

2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
/*
 * 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;
2116
	struct hlist_bl_head *b = d_hash(hashlen);
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
	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
2148 2149 2150 2151
/**
 * __d_lookup_rcu - search for a dentry (racy, store-free)
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2152
 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin's avatar
Nick Piggin committed
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169
 * 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.
 *
 * 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.
2170 2171 2172
 *
 * 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
2173
 */
2174 2175
struct dentry *__d_lookup_rcu(const struct dentry *parent,
				const struct qstr *name,
2176
				unsigned *seqp)
Nick Piggin's avatar
Nick Piggin committed
2177
{
2178
	u64 hashlen = name->hash_len;
Nick Piggin's avatar
Nick Piggin committed
2179
	const unsigned char *str = name->name;
2180
	struct hlist_bl_head *b = d_hash(hashlen);
2181
	struct hlist_bl_node *node;
Nick Piggin's avatar
Nick Piggin committed
2182 2183 2184 2185 2186 2187 2188 2189 2190
	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.
	 */

2191 2192 2193
	if (unlikely(parent->d_flags & DCACHE_OP_COMPARE))
		return __d_lookup_rcu_op_compare(parent, name, seqp);

Nick Piggin's avatar
Nick Piggin committed
2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204
	/*
	 * 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.
	 *
2205
	 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin's avatar
Nick Piggin committed
2206
	 */
2207
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
2208
		unsigned seq;
Nick Piggin's avatar
Nick Piggin committed
2209

2210 2211
		/*
		 * The dentry sequence count protects us from concurrent
2212
		 * renames, and thus protects parent and name fields.
2213 2214
		 *
		 * The caller must perform a seqcount check in order
2215
		 * to do anything useful with the returned dentry.
2216 2217 2218 2219 2220 2221 2222
		 *
		 * 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
2223 2224 2225
		 *
		 * Note that raw_seqcount_begin still *does* smp_rmb(), so
		 * we are still guaranteed NUL-termination of ->d_name.name.
2226 2227
		 */
		seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin's avatar
Nick Piggin committed
2228 2229
		if (dentry->d_parent != parent)
			continue;
2230 2231
		if (d_unhashed(dentry))
			continue;
2232 2233 2234 2235
		if (dentry->d_name.hash_len != hashlen)
			continue;
		if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
			continue;
2236
		*seqp = seq;
Al Viro's avatar
Al Viro committed
2237
		return dentry;
Nick Piggin's avatar
Nick Piggin committed
2238 2239 2240 2241
	}
	return NULL;
}

Linus Torvalds's avatar
Linus Torvalds committed
2242 2243 2244 2245
/**
 * d_lookup - search for a dentry
 * @parent: parent dentry
 * @name: qstr of name we wish to find
2246
 * Returns: dentry, or NULL
Linus Torvalds's avatar
Linus Torvalds committed
2247
 *
2248 2249 2250 2251
 * 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
2252
 */
Al Viro's avatar
Al Viro committed
2253
struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
2254
{
Nick Piggin's avatar
Nick Piggin committed
2255
	struct dentry *dentry;
2256
	unsigned seq;
Linus Torvalds's avatar
Linus Torvalds committed
2257

2258 2259 2260 2261
	do {
		seq = read_seqbegin(&rename_lock);
		dentry = __d_lookup(parent, name);
		if (dentry)
Linus Torvalds's avatar
Linus Torvalds committed
2262 2263 2264 2265
			break;
	} while (read_seqretry(&rename_lock, seq));
	return dentry;
}
2266
EXPORT_SYMBOL(d_lookup);
Linus Torvalds's avatar
Linus Torvalds committed
2267

Nick Piggin's avatar
Nick Piggin committed
2268
/**
2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
 * __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
2283
struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds's avatar
Linus Torvalds committed
2284 2285
{
	unsigned int hash = name->hash;
2286
	struct hlist_bl_head *b = d_hash(hash);
2287
	struct hlist_bl_node *node;
Nick Piggin's avatar
Nick Piggin committed
2288
	struct dentry *found = NULL;
2289
	struct dentry *dentry;
Linus Torvalds's avatar
Linus Torvalds committed
2290

Nick Piggin's avatar
Nick Piggin committed
2291 2292 2293 2294 2295 2296 2297
	/*
	 * 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.
	 */

2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
	/*
	 * 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.
	 *
2309
	 * See Documentation/filesystems/path-lookup.txt for more details.
2310
	 */
Linus Torvalds's avatar
Linus Torvalds committed
2311 2312
	rcu_read_lock();
	
2313
	hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds's avatar
Linus Torvalds committed
2314 2315 2316 2317 2318 2319 2320

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

		spin_lock(&dentry->d_lock);
		if (dentry->d_parent != parent)
			goto next;
2321 2322 2323
		if (d_unhashed(dentry))
			goto next;

Al Viro's avatar
Al Viro committed
2324 2325
		if (!d_same_name(dentry, parent, name))
			goto next;
Linus Torvalds's avatar
Linus Torvalds committed
2326

2327
		dentry->d_lockref.count++;
2328
		found = dentry;
Linus Torvalds's avatar
Linus Torvalds committed
2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
		spin_unlock(&dentry->d_lock);
		break;
next:
		spin_unlock(&dentry->d_lock);
 	}
 	rcu_read_unlock();

 	return found;
}

2339 2340 2341 2342 2343
/**
 * 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
 *
2344
 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
2345 2346 2347 2348 2349 2350 2351 2352
 */
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.
	 */
2353
	name->hash = full_name_hash(dir, name->name, name->len);
2354
	if (dir->d_flags & DCACHE_OP_HASH) {
2355
		int err = dir->d_op->d_hash(dir, name);
2356 2357
		if (unlikely(err < 0))
			return ERR_PTR(err);
2358
	}
2359
	return d_lookup(dir, name);
2360
}
2361
EXPORT_SYMBOL(d_hash_and_lookup);
2362

Linus Torvalds's avatar
Linus Torvalds committed
2363 2364 2365 2366 2367 2368
/*
 * 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
2369 2370 2371 2372 2373
 * 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
Linus Torvalds's avatar
Linus Torvalds committed
2374 2375 2376 2377 2378 2379
 */
 
/**
 * d_delete - delete a dentry
 * @dentry: The dentry to delete
 *
2380 2381
 * Turn the dentry into a negative dentry if possible, otherwise
 * remove it from the hash queues so it can be deleted later
Linus Torvalds's avatar
Linus Torvalds committed
2382 2383 2384 2385
 */
 
void d_delete(struct dentry * dentry)
{
2386 2387 2388 2389
	struct inode *inode = dentry->d_inode;

	spin_lock(&inode->i_lock);
	spin_lock(&dentry->d_lock);
Linus Torvalds's avatar
Linus Torvalds committed
2390 2391 2392
	/*
	 * Are we the only user?
	 */
2393
	if (dentry->d_lockref.count == 1) {
2394
		dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin's avatar
Nick Piggin committed
2395
		dentry_unlink_inode(dentry);
2396
	} else {
2397
		__d_drop(dentry);
2398 2399 2400
		spin_unlock(&dentry->d_lock);
		spin_unlock(&inode->i_lock);
	}
Linus Torvalds's avatar
Linus Torvalds committed
2401
}
2402
EXPORT_SYMBOL(d_delete);
Linus Torvalds's avatar
Linus Torvalds committed
2403

2404
static void __d_rehash(struct dentry *entry)
Linus Torvalds's avatar
Linus Torvalds committed
2405
{
2406
	struct hlist_bl_head *b = d_hash(entry->d_name.hash);
2407

2408
	hlist_bl_lock(b);
2409
	hlist_bl_add_head_rcu(&entry->d_hash, b);
2410
	hlist_bl_unlock(b);
Linus Torvalds's avatar
Linus Torvalds committed
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
}

/**
 * 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);
2423
	__d_rehash(entry);
Linus Torvalds's avatar
Linus Torvalds committed
2424 2425
	spin_unlock(&entry->d_lock);
}
2426
EXPORT_SYMBOL(d_rehash);
Linus Torvalds's avatar
Linus Torvalds committed
2427

2428 2429
static inline unsigned start_dir_add(struct inode *dir)
{
2430
	preempt_disable_nested();
2431 2432 2433 2434 2435 2436 2437 2438
	for (;;) {
		unsigned n = dir->i_dir_seq;
		if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
			return n;
		cpu_relax();
	}
}

2439 2440
static inline void end_dir_add(struct inode *dir, unsigned int n,
			       wait_queue_head_t *d_wait)
2441 2442
{
	smp_store_release(&dir->i_dir_seq, n + 2);
2443
	preempt_enable_nested();
2444
	wake_up_all(d_wait);
2445 2446
}

2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
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));
	}
}

2461
struct dentry *d_alloc_parallel(struct dentry *parent,
2462 2463
				const struct qstr *name,
				wait_queue_head_t *wq)
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
{
	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();
2477
	seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
	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;
	}
2498 2499 2500 2501 2502 2503

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

2504
	hlist_bl_lock(b);
2505
	if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
		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
2522 2523
		if (!d_same_name(dentry, parent, name))
			continue;
2524
		hlist_bl_unlock(b);
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
		/* 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
		 */
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549
		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
2550 2551
		if (unlikely(!d_same_name(dentry, parent, name)))
			goto mismatch;
2552 2553
		/* OK, it *is* a hashed match; return it */
		spin_unlock(&dentry->d_lock);
2554 2555 2556
		dput(new);
		return dentry;
	}
2557
	rcu_read_unlock();
2558 2559
	/* we can't take ->d_lock here; it's OK, though. */
	new->d_flags |= DCACHE_PAR_LOOKUP;
2560
	new->d_wait = wq;
2561
	hlist_bl_add_head(&new->d_u.d_in_lookup_hash, b);
2562 2563
	hlist_bl_unlock(b);
	return new;
2564 2565 2566 2567
mismatch:
	spin_unlock(&dentry->d_lock);
	dput(dentry);
	goto retry;
2568 2569 2570
}
EXPORT_SYMBOL(d_alloc_parallel);

2571 2572 2573 2574 2575 2576
/*
 * - 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)
2577
{
2578 2579 2580 2581 2582 2583
	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);
2584
	hlist_bl_lock(b);
2585
	dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
2586
	__hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
2587
	d_wait = dentry->d_wait;
2588
	dentry->d_wait = NULL;
2589 2590
	hlist_bl_unlock(b);
	INIT_HLIST_NODE(&dentry->d_u.d_alias);
2591
	INIT_LIST_HEAD(&dentry->d_lru);
2592 2593 2594 2595 2596 2597 2598 2599
	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);
2600
}
2601
EXPORT_SYMBOL(__d_lookup_unhash_wake);
Al Viro's avatar
Al Viro committed
2602 2603 2604 2605 2606

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

static inline void __d_add(struct dentry *dentry, struct inode *inode)
{
2607
	wait_queue_head_t *d_wait;
2608 2609
	struct inode *dir = NULL;
	unsigned n;
2610
	spin_lock(&dentry->d_lock);
2611 2612 2613
	if (unlikely(d_in_lookup(dentry))) {
		dir = dentry->d_parent->d_inode;
		n = start_dir_add(dir);
2614
		d_wait = __d_lookup_unhash(dentry);
2615
	}
Al Viro's avatar
Al Viro committed
2616
	if (inode) {
2617 2618 2619 2620 2621
		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
2622
		fsnotify_update_flags(dentry);
Al Viro's avatar
Al Viro committed
2623
	}
2624
	__d_rehash(dentry);
2625
	if (dir)
2626
		end_dir_add(dir, n, d_wait);
2627 2628 2629
	spin_unlock(&dentry->d_lock);
	if (inode)
		spin_unlock(&inode->i_lock);
Al Viro's avatar
Al Viro committed
2630 2631
}

Al Viro's avatar
Al Viro committed
2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
/**
 * 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)
{
2643 2644
	if (inode) {
		security_d_instantiate(entry, inode);
Al Viro's avatar
Al Viro committed
2645
		spin_lock(&inode->i_lock);
2646
	}
Al Viro's avatar
Al Viro committed
2647
	__d_add(entry, inode);
Al Viro's avatar
Al Viro committed
2648 2649 2650
}
EXPORT_SYMBOL(d_add);

2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677
/**
 * 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
2678
		if (!d_same_name(alias, entry->d_parent, &entry->d_name))
2679 2680 2681 2682 2683 2684
			continue;
		spin_lock(&alias->d_lock);
		if (!d_unhashed(alias)) {
			spin_unlock(&alias->d_lock);
			alias = NULL;
		} else {
2685
			dget_dlock(alias);
2686
			__d_rehash(alias);
2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
			spin_unlock(&alias->d_lock);
		}
		spin_unlock(&inode->i_lock);
		return alias;
	}
	spin_unlock(&inode->i_lock);
	return NULL;
}
EXPORT_SYMBOL(d_exact_alias);

2697
static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds's avatar
Linus Torvalds committed
2698
{
2699 2700
	if (unlikely(dname_external(target))) {
		if (unlikely(dname_external(dentry))) {
Linus Torvalds's avatar
Linus Torvalds committed
2701 2702 2703
			/*
			 * Both external: swap the pointers
			 */
2704
			swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds's avatar
Linus Torvalds committed
2705 2706 2707 2708 2709
		} else {
			/*
			 * dentry:internal, target:external.  Steal target's
			 * storage and make target internal.
			 */
2710 2711
			memcpy(target->d_iname, dentry->d_name.name,
					dentry->d_name.len + 1);
Linus Torvalds's avatar
Linus Torvalds committed
2712 2713 2714 2715
			dentry->d_name.name = target->d_name.name;
			target->d_name.name = target->d_iname;
		}
	} else {
2716
		if (unlikely(dname_external(dentry))) {
Linus Torvalds's avatar
Linus Torvalds committed
2717 2718 2719 2720 2721 2722 2723 2724 2725 2726
			/*
			 * 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
2727
			 * Both are internal.
Linus Torvalds's avatar
Linus Torvalds committed
2728
			 */
Miklos Szeredi's avatar
Miklos Szeredi committed
2729 2730 2731 2732 2733 2734
			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
2735 2736
		}
	}
2737
	swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds's avatar
Linus Torvalds committed
2738 2739
}

2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
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)))
2755
		kfree_rcu(old_name, u.head);
2756 2757
}

2758
/*
2759
 * __d_move - move a dentry
Linus Torvalds's avatar
Linus Torvalds committed
2760 2761
 * @dentry: entry to move
 * @target: new dentry
Miklos Szeredi's avatar
Miklos Szeredi committed
2762
 * @exchange: exchange the two dentries
Linus Torvalds's avatar
Linus Torvalds committed
2763 2764
 *
 * Update the dcache to reflect the move of a file name. Negative
2765 2766 2767
 * 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
2768
 */
Miklos Szeredi's avatar
Miklos Szeredi committed
2769 2770
static void __d_move(struct dentry *dentry, struct dentry *target,
		     bool exchange)
Linus Torvalds's avatar
Linus Torvalds committed
2771
{
2772
	struct dentry *old_parent, *p;
2773
	wait_queue_head_t *d_wait;
2774 2775
	struct inode *dir = NULL;
	unsigned n;
Linus Torvalds's avatar
Linus Torvalds committed
2776

2777 2778 2779 2780
	WARN_ON(!dentry->d_inode);
	if (WARN_ON(dentry == target))
		return;

Nick Piggin's avatar
Nick Piggin committed
2781
	BUG_ON(d_ancestor(target, dentry));
2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799
	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
2800

2801 2802 2803
	if (unlikely(d_in_lookup(target))) {
		dir = target->d_parent->d_inode;
		n = start_dir_add(dir);
2804
		d_wait = __d_lookup_unhash(target);
2805
	}
Linus Torvalds's avatar
Linus Torvalds committed
2806

Nick Piggin's avatar
Nick Piggin committed
2807
	write_seqcount_begin(&dentry->d_seq);
2808
	write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin's avatar
Nick Piggin committed
2809

2810
	/* unhash both */
2811 2812 2813 2814
	if (!d_unhashed(dentry))
		___d_drop(dentry);
	if (!d_unhashed(target))
		___d_drop(target);
Linus Torvalds's avatar
Linus Torvalds committed
2815

2816 2817 2818
	/* ... and switch them in the tree */
	dentry->d_parent = target->d_parent;
	if (!exchange) {
2819
		copy_name(dentry, target);
2820
		target->d_hash.pprev = NULL;
2821
		dentry->d_parent->d_lockref.count++;
2822
		if (dentry != old_parent) /* wasn't IS_ROOT */
2823
			WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds's avatar
Linus Torvalds committed
2824
	} else {
2825 2826
		target->d_parent = old_parent;
		swap_names(dentry, target);
2827 2828 2829
		if (!hlist_unhashed(&target->d_sib))
			__hlist_del(&target->d_sib);
		hlist_add_head(&target->d_sib, &target->d_parent->d_children);
2830 2831
		__d_rehash(target);
		fsnotify_update_flags(target);
Linus Torvalds's avatar
Linus Torvalds committed
2832
	}
2833 2834 2835
	if (!hlist_unhashed(&dentry->d_sib))
		__hlist_del(&dentry->d_sib);
	hlist_add_head(&dentry->d_sib, &dentry->d_parent->d_children);
2836 2837
	__d_rehash(dentry);
	fsnotify_update_flags(dentry);
2838
	fscrypt_handle_d_move(dentry);
Linus Torvalds's avatar
Linus Torvalds committed
2839

Nick Piggin's avatar
Nick Piggin committed
2840 2841 2842
	write_seqcount_end(&target->d_seq);
	write_seqcount_end(&dentry->d_seq);

2843
	if (dir)
2844
		end_dir_add(dir, n, d_wait);
2845 2846 2847 2848 2849 2850 2851

	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);
2852 2853 2854 2855 2856 2857 2858 2859
}

/*
 * d_move - move a dentry
 * @dentry: entry to move
 * @target: new dentry
 *
 * Update the dcache to reflect the move of a file name. Negative
2860 2861
 * dcache entries should not be moved in this way. See the locking
 * requirements for __d_move.
2862 2863 2864 2865
 */
void d_move(struct dentry *dentry, struct dentry *target)
{
	write_seqlock(&rename_lock);
Miklos Szeredi's avatar
Miklos Szeredi committed
2866
	__d_move(dentry, target, false);
Linus Torvalds's avatar
Linus Torvalds committed
2867
	write_sequnlock(&rename_lock);
2868
}
2869
EXPORT_SYMBOL(d_move);
Linus Torvalds's avatar
Linus Torvalds committed
2870

Miklos Szeredi's avatar
Miklos Szeredi committed
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889
/*
 * 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);
}

2890 2891 2892 2893 2894 2895 2896
/**
 * 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.
2897
 */
2898
struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
2899 2900 2901
{
	struct dentry *p;

2902
	for (p = p2; !IS_ROOT(p); p = p->d_parent) {
2903
		if (p->d_parent == p1)
2904
			return p;
2905
	}
2906
	return NULL;
2907 2908 2909 2910 2911 2912
}

/*
 * This helper attempts to cope with remotely renamed directories
 *
 * It assumes that the caller is already holding
2913
 * dentry->d_parent->d_inode->i_mutex, and rename_lock
2914 2915 2916 2917
 *
 * Note: If ever the locking in lock_rename() changes, then please
 * remember to update this too...
 */
2918
static int __d_unalias(struct dentry *dentry, struct dentry *alias)
2919
{
2920 2921
	struct mutex *m1 = NULL;
	struct rw_semaphore *m2 = NULL;
2922
	int ret = -ESTALE;
2923 2924 2925 2926 2927 2928 2929 2930 2931

	/* 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;
2932
	if (!inode_trylock_shared(alias->d_parent->d_inode))
2933
		goto out_err;
2934
	m2 = &alias->d_parent->d_inode->i_rwsem;
2935
out_unalias:
2936
	__d_move(alias, dentry, false);
2937
	ret = 0;
2938 2939
out_err:
	if (m2)
2940
		up_read(m2);
2941 2942 2943 2944 2945
	if (m1)
		mutex_unlock(m1);
	return ret;
}

2946 2947 2948 2949 2950
/**
 * 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.
 *
2951 2952 2953
 * 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.
2954
 *
2955 2956 2957
 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
 * we should error out: directories can't have multiple aliases.
 *
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
 * 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);

2974 2975
	BUG_ON(!d_unhashed(dentry));

2976
	if (!inode)
2977
		goto out;
2978

2979
	security_d_instantiate(dentry, inode);
2980
	spin_lock(&inode->i_lock);
2981
	if (S_ISDIR(inode->i_mode)) {
2982 2983
		struct dentry *new = __d_find_any_alias(inode);
		if (unlikely(new)) {
2984 2985
			/* The reference to new ensures it remains an alias */
			spin_unlock(&inode->i_lock);
2986
			write_seqlock(&rename_lock);
2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997
			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)) {
2998
				struct dentry *old_parent = dget(new->d_parent);
2999
				int err = __d_unalias(dentry, new);
3000
				write_sequnlock(&rename_lock);
3001 3002 3003 3004
				if (err) {
					dput(new);
					new = ERR_PTR(err);
				}
3005
				dput(old_parent);
3006
			} else {
3007 3008
				__d_move(new, dentry, false);
				write_sequnlock(&rename_lock);
3009
			}
3010 3011
			iput(inode);
			return new;
3012
		}
3013
	}
3014
out:
Al Viro's avatar
Al Viro committed
3015
	__d_add(dentry, inode);
3016
	return NULL;
3017
}
3018
EXPORT_SYMBOL(d_splice_alias);
3019

Linus Torvalds's avatar
Linus Torvalds committed
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
/*
 * 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
 *
3031 3032
 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
 * Returns false otherwise.
Linus Torvalds's avatar
Linus Torvalds committed
3033 3034 3035
 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
 */
  
3036
bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds's avatar
Linus Torvalds committed
3037
{
3038
	bool subdir;
3039
	unsigned seq;
Linus Torvalds's avatar
Linus Torvalds committed
3040

3041
	if (new_dentry == old_dentry)
3042
		return true;
3043

3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056
	/* Access d_parent under rcu as d_move() may change it. */
	rcu_read_lock();
	seq = read_seqbegin(&rename_lock);
	subdir = d_ancestor(old_dentry, new_dentry);
	 /* Try lockless once... */
	if (read_seqretry(&rename_lock, seq)) {
		/* ...else acquire lock for progress even on deep chains. */
		read_seqlock_excl(&rename_lock);
		subdir = d_ancestor(old_dentry, new_dentry);
		read_sequnlock_excl(&rename_lock);
	}
	rcu_read_unlock();
	return subdir;
Linus Torvalds's avatar
Linus Torvalds committed
3057
}
3058
EXPORT_SYMBOL(is_subdir);
Linus Torvalds's avatar
Linus Torvalds committed
3059

Miklos Szeredi's avatar
Miklos Szeredi committed
3060
static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds's avatar
Linus Torvalds committed
3061
{
Miklos Szeredi's avatar
Miklos Szeredi committed
3062 3063 3064 3065
	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
3066

3067 3068 3069 3070
		if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
			dentry->d_flags |= DCACHE_GENOCIDE;
			dentry->d_lockref.count--;
		}
Linus Torvalds's avatar
Linus Torvalds committed
3071
	}
Miklos Szeredi's avatar
Miklos Szeredi committed
3072 3073
	return D_WALK_CONTINUE;
}
3074

Miklos Szeredi's avatar
Miklos Szeredi committed
3075 3076
void d_genocide(struct dentry *parent)
{
Al Viro's avatar
Al Viro committed
3077
	d_walk(parent, parent, d_genocide_kill);
Linus Torvalds's avatar
Linus Torvalds committed
3078 3079
}

3080
void d_mark_tmpfile(struct file *file, struct inode *inode)
Linus Torvalds's avatar
Linus Torvalds committed
3081
{
3082 3083
	struct dentry *dentry = file->f_path.dentry;

3084
	BUG_ON(dentry->d_name.name != dentry->d_iname ||
3085
		!hlist_unhashed(&dentry->d_u.d_alias) ||
3086 3087 3088 3089 3090 3091 3092
		!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);
3093 3094 3095 3096 3097 3098 3099 3100 3101
}
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);
3102
	d_instantiate(dentry, inode);
Linus Torvalds's avatar
Linus Torvalds committed
3103
}
3104
EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds's avatar
Linus Torvalds committed
3105

3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
/*
 * Obtain inode number of the parent dentry.
 */
ino_t d_parent_ino(struct dentry *dentry)
{
	struct dentry *parent;
	struct inode *iparent;
	unsigned seq;
	ino_t ret;

	scoped_guard(rcu) {
		seq = raw_seqcount_begin(&dentry->d_seq);
		parent = READ_ONCE(dentry->d_parent);
		iparent = d_inode_rcu(parent);
		if (likely(iparent)) {
			ret = iparent->i_ino;
			if (!read_seqcount_retry(&dentry->d_seq, seq))
				return ret;
		}
	}

	spin_lock(&dentry->d_lock);
	ret = dentry->d_parent->d_inode->i_ino;
	spin_unlock(&dentry->d_lock);
	return ret;
}
EXPORT_SYMBOL(d_parent_ino);

Linus Torvalds's avatar
Linus Torvalds committed
3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
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",
3154
					sizeof(struct hlist_bl_head),
Linus Torvalds's avatar
Linus Torvalds committed
3155 3156
					dhash_entries,
					13,
3157
					HASH_EARLY | HASH_ZERO,
Linus Torvalds's avatar
Linus Torvalds committed
3158
					&d_hash_shift,
3159
					NULL,
3160
					0,
Linus Torvalds's avatar
Linus Torvalds committed
3161
					0);
3162
	d_hash_shift = 32 - d_hash_shift;
3163 3164 3165

	runtime_const_init(shift, d_hash_shift);
	runtime_const_init(ptr, dentry_hashtable);
Linus Torvalds's avatar
Linus Torvalds committed
3166 3167
}

3168
static void __init dcache_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
3169
{
3170
	/*
Linus Torvalds's avatar
Linus Torvalds committed
3171 3172
	 * A constructor could be added for stable state like the lists,
	 * but it is probably not worth it because of the cache nature
3173
	 * of the dcache.
Linus Torvalds's avatar
Linus Torvalds committed
3174
	 */
3175
	dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3176
		SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_ACCOUNT,
3177
		d_iname);
Linus Torvalds's avatar
Linus Torvalds committed
3178 3179 3180 3181 3182 3183 3184

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

	dentry_hashtable =
		alloc_large_system_hash("Dentry cache",
3185
					sizeof(struct hlist_bl_head),
Linus Torvalds's avatar
Linus Torvalds committed
3186 3187
					dhash_entries,
					13,
3188
					HASH_ZERO,
Linus Torvalds's avatar
Linus Torvalds committed
3189
					&d_hash_shift,
3190
					NULL,
3191
					0,
Linus Torvalds's avatar
Linus Torvalds committed
3192
					0);
3193
	d_hash_shift = 32 - d_hash_shift;
3194 3195 3196

	runtime_const_init(shift, d_hash_shift);
	runtime_const_init(ptr, dentry_hashtable);
Linus Torvalds's avatar
Linus Torvalds committed
3197 3198 3199
}

/* SLAB cache for __getname() consumers */
3200
struct kmem_cache *names_cachep __ro_after_init;
3201
EXPORT_SYMBOL(names_cachep);
Linus Torvalds's avatar
Linus Torvalds committed
3202 3203 3204

void __init vfs_caches_init_early(void)
{
3205 3206 3207 3208 3209
	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
3210 3211 3212 3213
	dcache_init_early();
	inode_init_early();
}

3214
void __init vfs_caches_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
3215
{
3216 3217
	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
3218

3219 3220
	dcache_init();
	inode_init();
3221 3222
	files_init();
	files_maxfiles_init();
3223
	mnt_init();
Linus Torvalds's avatar
Linus Torvalds committed
3224 3225 3226
	bdev_cache_init();
	chrdev_init();
}