blob: 97e81a844a966c6683e4688347f78149f886e16f [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * fs/dcache.c
4 *
5 * Complete reimplementation
6 * (C) 1997 Thomas Schoebel-Theuer,
7 * with heavy changes by Linus Torvalds
8 */
9
10/*
11 * Notes on the allocation strategy:
12 *
13 * The dcache is a master of the icache - whenever a dcache entry
14 * exists, the inode will always exist. "iput()" is done either when
15 * the dcache entry is deleted or garbage collected.
16 */
17
Al Viro7a5cf792018-03-05 19:15:50 -050018#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/string.h>
20#include <linux/mm.h>
21#include <linux/fs.h>
Eric Biggers0bf3d5c12019-03-20 11:39:11 -070022#include <linux/fscrypt.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040023#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/slab.h>
25#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/hash.h>
27#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050028#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/security.h>
30#include <linux/seqlock.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070031#include <linux/memblock.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110032#include <linux/bit_spinlock.h>
33#include <linux/rculist_bl.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100034#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020035#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050036#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Nick Piggin789680d2011-01-07 17:49:30 +110038/*
39 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110040 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040041 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110042 * dcache_hash_bucket lock protects:
43 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110044 * s_roots bl list spinlock protects:
45 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100046 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110047 * - the dcache lru lists and counters
48 * d_lock protects:
49 * - d_flags
50 * - d_name
51 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110052 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110053 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110054 * - d_parent and d_subdirs
55 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040056 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110057 *
58 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110059 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110060 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100061 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110062 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110063 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110064 *
Nick Pigginda502952011-01-07 17:49:33 +110065 * If there is an ancestor relationship:
66 * dentry->d_parent->...->d_parent->d_lock
67 * ...
68 * dentry->d_parent->d_lock
69 * dentry->d_lock
70 *
71 * If no ancestor relationship:
Al Viro076515f2018-03-10 23:15:52 -050072 * arbitrary, since it's serialized on rename_lock
Nick Piggin789680d2011-01-07 17:49:30 +110073 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080074int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
76
Al Viro74c3cbe2007-07-22 08:04:18 -040077__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Nick Piggin949854d2011-01-07 17:49:37 +110079EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Christoph Lametere18b8902006-12-06 20:33:20 -080081static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
David Howellscdf01222017-07-04 17:25:22 +010083const struct qstr empty_name = QSTR_INIT("", 0);
84EXPORT_SYMBOL(empty_name);
85const struct qstr slash_name = QSTR_INIT("/", 1);
86EXPORT_SYMBOL(slash_name);
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/*
89 * This is the single most critical data structure when it comes
90 * to the dcache: the hashtable for lookups. Somebody should try
91 * to make this good - I've just made it work.
92 *
93 * This hash-function tries to avoid losing too many bits of hash
94 * information, yet avoid using a prime hash-size or similar.
95 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Eric Dumazetfa3536c2006-03-26 01:37:24 -080097static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +110098
Linus Torvaldsb07ad992011-04-23 22:32:03 -070099static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100100
Linus Torvalds8387ff22016-06-10 07:51:30 -0700101static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300103 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104}
105
Al Viro94bdd652016-04-15 02:42:04 -0400106#define IN_LOOKUP_SHIFT 10
107static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
108
109static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
110 unsigned int hash)
111{
112 hash += (unsigned long) parent / L1_CACHE_BYTES;
113 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
114}
115
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117/* Statistics gathering. */
118struct dentry_stat_t dentry_stat = {
119 .age_limit = 45,
120};
121
Glauber Costa3942c072013-08-28 10:17:53 +1000122static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000123static DEFINE_PER_CPU(long, nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500124static DEFINE_PER_CPU(long, nr_dentry_negative);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400125
126#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000127
128/*
129 * Here we resort to our own counters instead of using generic per-cpu counters
130 * for consistency with what the vfs inode code does. We are expected to harvest
131 * better code and performance by having our own specialized counters.
132 *
133 * Please note that the loop is done over all possible CPUs, not over all online
134 * CPUs. The reason for this is that we don't want to play games with CPUs going
135 * on and off. If one of them goes off, we will just keep their counters.
136 *
137 * glommer: See cffbc8a for details, and if you ever intend to change this,
138 * please update all vfs counters to match.
139 */
Glauber Costa3942c072013-08-28 10:17:53 +1000140static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100141{
142 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000143 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100144 for_each_possible_cpu(i)
145 sum += per_cpu(nr_dentry, i);
146 return sum < 0 ? 0 : sum;
147}
148
Dave Chinner62d36c72013-08-28 10:17:54 +1000149static long get_nr_dentry_unused(void)
150{
151 int i;
152 long sum = 0;
153 for_each_possible_cpu(i)
154 sum += per_cpu(nr_dentry_unused, i);
155 return sum < 0 ? 0 : sum;
156}
157
Waiman Longaf0c9af2019-01-30 13:52:38 -0500158static long get_nr_dentry_negative(void)
159{
160 int i;
161 long sum = 0;
162
163 for_each_possible_cpu(i)
164 sum += per_cpu(nr_dentry_negative, i);
165 return sum < 0 ? 0 : sum;
166}
167
Christoph Hellwig32927392020-04-24 08:43:38 +0200168int proc_nr_dentry(struct ctl_table *table, int write, void *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169 size_t *lenp, loff_t *ppos)
170{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100171 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000172 dentry_stat.nr_unused = get_nr_dentry_unused();
Waiman Longaf0c9af2019-01-30 13:52:38 -0500173 dentry_stat.nr_negative = get_nr_dentry_negative();
Glauber Costa3942c072013-08-28 10:17:53 +1000174 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400175}
176#endif
177
Linus Torvalds5483f182012-03-04 15:51:42 -0800178/*
179 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
180 * The strings are both count bytes long, and count is non-zero.
181 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700182#ifdef CONFIG_DCACHE_WORD_ACCESS
183
184#include <asm/word-at-a-time.h>
185/*
186 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
187 * aligned allocation for this particular component. We don't
188 * strictly need the load_unaligned_zeropad() safety, but it
189 * doesn't hurt either.
190 *
191 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
192 * need the careful unaligned handling.
193 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700194static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800195{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800197
198 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300199 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700200 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800201 if (tcount < sizeof(unsigned long))
202 break;
203 if (unlikely(a != b))
204 return 1;
205 cs += sizeof(unsigned long);
206 ct += sizeof(unsigned long);
207 tcount -= sizeof(unsigned long);
208 if (!tcount)
209 return 0;
210 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000211 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800212 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213}
214
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800215#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700216
Linus Torvalds94753db52012-05-10 12:19:19 -0700217static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700218{
Linus Torvalds5483f182012-03-04 15:51:42 -0800219 do {
220 if (*cs != *ct)
221 return 1;
222 cs++;
223 ct++;
224 tcount--;
225 } while (tcount);
226 return 0;
227}
228
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700229#endif
230
Linus Torvalds94753db52012-05-10 12:19:19 -0700231static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
232{
Linus Torvalds94753db52012-05-10 12:19:19 -0700233 /*
234 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100235 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700236 *
237 * NOTE! Even if a rename will mean that the length
238 * was not loaded atomically, we don't care. The
239 * RCU walk will check the sequence count eventually,
240 * and catch it. And we won't overrun the buffer,
241 * because we're reading the name pointer atomically,
242 * and a dentry name is guaranteed to be properly
243 * terminated with a NUL byte.
244 *
245 * End result: even if 'len' is wrong, we'll exit
246 * early because the data cannot match (there can
247 * be no NUL in the ct/tcount data)
248 */
Will Deacon506458e2017-10-24 11:22:48 +0100249 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000250
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700251 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700252}
253
Al Viro8d85b482014-09-29 14:54:27 -0400254struct external_name {
255 union {
256 atomic_t count;
257 struct rcu_head head;
258 } u;
259 unsigned char name[];
260};
261
262static inline struct external_name *external_name(struct dentry *dentry)
263{
264 return container_of(dentry->d_name.name, struct external_name, name[0]);
265}
266
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400267static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400269 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
270
Al Viro8d85b482014-09-29 14:54:27 -0400271 kmem_cache_free(dentry_cache, dentry);
272}
273
274static void __d_free_external(struct rcu_head *head)
275{
276 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -0700277 kfree(external_name(dentry));
Roman Gushchinf1782c92018-04-10 16:27:44 -0700278 kmem_cache_free(dentry_cache, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279}
280
Al Viro810bb172014-10-12 12:45:37 -0400281static inline int dname_external(const struct dentry *dentry)
282{
283 return dentry->d_name.name != dentry->d_iname;
284}
285
Al Viro49d31c22017-07-07 14:51:19 -0400286void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
287{
288 spin_lock(&dentry->d_lock);
Al Viro230c6402019-04-26 13:07:27 -0400289 name->name = dentry->d_name;
Al Viro49d31c22017-07-07 14:51:19 -0400290 if (unlikely(dname_external(dentry))) {
Al Viro230c6402019-04-26 13:07:27 -0400291 atomic_inc(&external_name(dentry)->u.count);
Al Viro49d31c22017-07-07 14:51:19 -0400292 } else {
Tetsuo Handa6cd00a02018-08-17 15:44:34 -0700293 memcpy(name->inline_name, dentry->d_iname,
294 dentry->d_name.len + 1);
Al Viro230c6402019-04-26 13:07:27 -0400295 name->name.name = name->inline_name;
Al Viro49d31c22017-07-07 14:51:19 -0400296 }
Al Viro230c6402019-04-26 13:07:27 -0400297 spin_unlock(&dentry->d_lock);
Al Viro49d31c22017-07-07 14:51:19 -0400298}
299EXPORT_SYMBOL(take_dentry_name_snapshot);
300
301void release_dentry_name_snapshot(struct name_snapshot *name)
302{
Al Viro230c6402019-04-26 13:07:27 -0400303 if (unlikely(name->name.name != name->inline_name)) {
Al Viro49d31c22017-07-07 14:51:19 -0400304 struct external_name *p;
Al Viro230c6402019-04-26 13:07:27 -0400305 p = container_of(name->name.name, struct external_name, name[0]);
Al Viro49d31c22017-07-07 14:51:19 -0400306 if (unlikely(atomic_dec_and_test(&p->u.count)))
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -0700307 kfree_rcu(p, u.head);
Al Viro49d31c22017-07-07 14:51:19 -0400308 }
309}
310EXPORT_SYMBOL(release_dentry_name_snapshot);
311
David Howells4bf46a22015-03-05 14:09:22 +0000312static inline void __d_set_inode_and_type(struct dentry *dentry,
313 struct inode *inode,
314 unsigned type_flags)
315{
316 unsigned flags;
317
318 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000319 flags = READ_ONCE(dentry->d_flags);
320 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
321 flags |= type_flags;
Al Viro2fa6b1e2019-11-12 16:13:06 -0500322 smp_store_release(&dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000323}
324
David Howells4bf46a22015-03-05 14:09:22 +0000325static inline void __d_clear_type_and_inode(struct dentry *dentry)
326{
327 unsigned flags = READ_ONCE(dentry->d_flags);
328
329 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
330 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000331 dentry->d_inode = NULL;
Waiman Longaf0c9af2019-01-30 13:52:38 -0500332 if (dentry->d_flags & DCACHE_LRU_LIST)
333 this_cpu_inc(nr_dentry_negative);
David Howells4bf46a22015-03-05 14:09:22 +0000334}
335
Al Virob4f03542014-04-29 23:40:14 -0400336static void dentry_free(struct dentry *dentry)
337{
Al Viro946e51f2014-10-26 19:19:16 -0400338 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400339 if (unlikely(dname_external(dentry))) {
340 struct external_name *p = external_name(dentry);
341 if (likely(atomic_dec_and_test(&p->u.count))) {
342 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
343 return;
344 }
345 }
Al Virob4f03542014-04-29 23:40:14 -0400346 /* if dentry was never visible to RCU, immediate free is OK */
Al Viro5467a682019-03-15 22:23:19 -0400347 if (dentry->d_flags & DCACHE_NORCU)
Al Virob4f03542014-04-29 23:40:14 -0400348 __d_free(&dentry->d_u.d_rcu);
349 else
350 call_rcu(&dentry->d_u.d_rcu, __d_free);
351}
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353/*
354 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400355 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100356 */
357static void dentry_unlink_inode(struct dentry * dentry)
358 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100359 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100360{
361 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500362
Al Viro4c0d7cd2018-08-09 10:15:54 -0400363 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000364 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400365 hlist_del_init(&dentry->d_u.d_alias);
Al Viro4c0d7cd2018-08-09 10:15:54 -0400366 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100367 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100368 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100369 if (!inode->i_nlink)
370 fsnotify_inoderemove(inode);
371 if (dentry->d_op && dentry->d_op->d_iput)
372 dentry->d_op->d_iput(dentry, inode);
373 else
374 iput(inode);
375}
376
377/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400378 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
379 * is in use - which includes both the "real" per-superblock
380 * LRU list _and_ the DCACHE_SHRINK_LIST use.
381 *
382 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
383 * on the shrink list (ie not on the superblock LRU list).
384 *
385 * The per-cpu "nr_dentry_unused" counters are updated with
386 * the DCACHE_LRU_LIST bit.
387 *
Waiman Longaf0c9af2019-01-30 13:52:38 -0500388 * The per-cpu "nr_dentry_negative" counters are only updated
389 * when deleted from or added to the per-superblock LRU list, not
390 * from/to the shrink list. That is to avoid an unneeded dec/inc
391 * pair when moving from LRU to shrink list in select_collect().
392 *
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400393 * These helper functions make sure we always follow the
394 * rules. d_lock must be held by the caller.
395 */
396#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
397static void d_lru_add(struct dentry *dentry)
398{
399 D_FLAG_VERIFY(dentry, 0);
400 dentry->d_flags |= DCACHE_LRU_LIST;
401 this_cpu_inc(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500402 if (d_is_negative(dentry))
403 this_cpu_inc(nr_dentry_negative);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400404 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
405}
406
407static void d_lru_del(struct dentry *dentry)
408{
409 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
410 dentry->d_flags &= ~DCACHE_LRU_LIST;
411 this_cpu_dec(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500412 if (d_is_negative(dentry))
413 this_cpu_dec(nr_dentry_negative);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400414 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
415}
416
417static void d_shrink_del(struct dentry *dentry)
418{
419 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
420 list_del_init(&dentry->d_lru);
421 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
422 this_cpu_dec(nr_dentry_unused);
423}
424
425static void d_shrink_add(struct dentry *dentry, struct list_head *list)
426{
427 D_FLAG_VERIFY(dentry, 0);
428 list_add(&dentry->d_lru, list);
429 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
430 this_cpu_inc(nr_dentry_unused);
431}
432
433/*
434 * These can only be called under the global LRU lock, ie during the
435 * callback for freeing the LRU list. "isolate" removes it from the
436 * LRU lists entirely, while shrink_move moves it to the indicated
437 * private list.
438 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800439static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400440{
441 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
442 dentry->d_flags &= ~DCACHE_LRU_LIST;
443 this_cpu_dec(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500444 if (d_is_negative(dentry))
445 this_cpu_dec(nr_dentry_negative);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800446 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400447}
448
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800449static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
450 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400451{
452 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
453 dentry->d_flags |= DCACHE_SHRINK_LIST;
Waiman Longaf0c9af2019-01-30 13:52:38 -0500454 if (d_is_negative(dentry))
455 this_cpu_dec(nr_dentry_negative);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800456 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400457}
458
Miklos Szeredid52b9082007-05-08 00:23:46 -0700459/**
Nick Piggin789680d2011-01-07 17:49:30 +1100460 * d_drop - drop a dentry
461 * @dentry: dentry to drop
462 *
463 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
464 * be found through a VFS lookup any more. Note that this is different from
465 * deleting the dentry - d_delete will try to mark the dentry negative if
466 * possible, giving a successful _negative_ lookup, while d_drop will
467 * just make the cache lookup fail.
468 *
469 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
470 * reason (NFS timeouts or autofs deletes).
471 *
NeilBrown61647822017-11-10 15:45:41 +1100472 * __d_drop requires dentry->d_lock
473 * ___d_drop doesn't mark dentry as "unhashed"
474 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100475 */
NeilBrown61647822017-11-10 15:45:41 +1100476static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100477{
Al Viro0632a9a2018-03-07 00:49:10 -0500478 struct hlist_bl_head *b;
479 /*
480 * Hashed dentries are normally on the dentry hashtable,
481 * with the exception of those newly allocated by
482 * d_obtain_root, which are always IS_ROOT:
483 */
484 if (unlikely(IS_ROOT(dentry)))
485 b = &dentry->d_sb->s_roots;
486 else
487 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400488
Al Viro0632a9a2018-03-07 00:49:10 -0500489 hlist_bl_lock(b);
490 __hlist_bl_del(&dentry->d_hash);
491 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100492}
NeilBrown61647822017-11-10 15:45:41 +1100493
494void __d_drop(struct dentry *dentry)
495{
Al Viro0632a9a2018-03-07 00:49:10 -0500496 if (!d_unhashed(dentry)) {
497 ___d_drop(dentry);
498 dentry->d_hash.pprev = NULL;
499 write_seqcount_invalidate(&dentry->d_seq);
500 }
NeilBrown61647822017-11-10 15:45:41 +1100501}
Nick Piggin789680d2011-01-07 17:49:30 +1100502EXPORT_SYMBOL(__d_drop);
503
504void d_drop(struct dentry *dentry)
505{
Nick Piggin789680d2011-01-07 17:49:30 +1100506 spin_lock(&dentry->d_lock);
507 __d_drop(dentry);
508 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100509}
510EXPORT_SYMBOL(d_drop);
511
Al Viroba65dc52016-06-10 11:32:47 -0400512static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
513{
514 struct dentry *next;
515 /*
516 * Inform d_walk() and shrink_dentry_list() that we are no longer
517 * attached to the dentry tree
518 */
519 dentry->d_flags |= DCACHE_DENTRY_KILLED;
520 if (unlikely(list_empty(&dentry->d_child)))
521 return;
522 __list_del_entry(&dentry->d_child);
523 /*
524 * Cursors can move around the list of children. While we'd been
525 * a normal list member, it didn't matter - ->d_child.next would've
526 * been updated. However, from now on it won't be and for the
527 * things like d_walk() it might end up with a nasty surprise.
528 * Normally d_walk() doesn't care about cursors moving around -
529 * ->d_lock on parent prevents that and since a cursor has no children
530 * of its own, we get through it without ever unlocking the parent.
531 * There is one exception, though - if we ascend from a child that
532 * gets killed as soon as we unlock it, the next sibling is found
533 * using the value left in its ->d_child.next. And if _that_
534 * pointed to a cursor, and cursor got moved (e.g. by lseek())
535 * before d_walk() regains parent->d_lock, we'll end up skipping
536 * everything the cursor had been moved past.
537 *
538 * Solution: make sure that the pointer left behind in ->d_child.next
539 * points to something that won't be moving around. I.e. skip the
540 * cursors.
541 */
542 while (dentry->d_child.next != &parent->d_subdirs) {
543 next = list_entry(dentry->d_child.next, struct dentry, d_child);
544 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
545 break;
546 dentry->d_child.next = next->d_child.next;
547 }
548}
549
Al Viroe55fd012014-05-28 13:51:12 -0400550static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100551{
Al Viro41edf2782014-05-01 10:30:00 -0400552 struct dentry *parent = NULL;
553 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400554 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100555 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100556
Linus Torvalds0d984392013-09-08 13:46:52 -0700557 /*
558 * The dentry is now unrecoverably dead to the world.
559 */
560 lockref_mark_dead(&dentry->d_lockref);
561
Sage Weilf0023bc2011-10-28 10:02:42 -0700562 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700563 * inform the fs via d_prune that this dentry is about to be
564 * unhashed and destroyed.
565 */
Al Viro29266202014-05-30 11:39:02 -0400566 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800567 dentry->d_op->d_prune(dentry);
568
Al Viro01b60352014-04-29 23:42:52 -0400569 if (dentry->d_flags & DCACHE_LRU_LIST) {
570 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
571 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400572 }
Nick Piggin77812a12011-01-07 17:49:48 +1100573 /* if it was on the hash then remove it */
574 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400575 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400576 if (parent)
577 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400578 if (dentry->d_inode)
579 dentry_unlink_inode(dentry);
580 else
581 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400582 this_cpu_dec(nr_dentry);
583 if (dentry->d_op && dentry->d_op->d_release)
584 dentry->d_op->d_release(dentry);
585
Al Viro41edf2782014-05-01 10:30:00 -0400586 spin_lock(&dentry->d_lock);
587 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
588 dentry->d_flags |= DCACHE_MAY_FREE;
589 can_free = false;
590 }
591 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400592 if (likely(can_free))
593 dentry_free(dentry);
Al Viro9c5f1d32018-04-15 18:28:48 -0400594 cond_resched();
Al Viroe55fd012014-05-28 13:51:12 -0400595}
596
Al Viro8b987a42018-02-23 22:11:34 -0500597static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400598{
Al Viro8b987a42018-02-23 22:11:34 -0500599 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400600 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400601 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400602again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700603 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400604 spin_lock(&parent->d_lock);
605 /*
606 * We can't blindly lock dentry until we are sure
607 * that we won't violate the locking order.
608 * Any changes of dentry->d_parent must have
609 * been done with parent->d_lock held, so
610 * spin_lock() above is enough of a barrier
611 * for checking if it's still our child.
612 */
613 if (unlikely(parent != dentry->d_parent)) {
614 spin_unlock(&parent->d_lock);
615 goto again;
616 }
Al Viro3b821402018-02-23 20:47:17 -0500617 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500618 if (parent != dentry)
619 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
620 else
621 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400622 return parent;
623}
624
Al Viro8b987a42018-02-23 22:11:34 -0500625static inline struct dentry *lock_parent(struct dentry *dentry)
626{
627 struct dentry *parent = dentry->d_parent;
628 if (IS_ROOT(dentry))
629 return NULL;
630 if (likely(spin_trylock(&parent->d_lock)))
631 return parent;
632 return __lock_parent(dentry);
633}
634
Al Viroa3385792018-02-23 21:07:24 -0500635static inline bool retain_dentry(struct dentry *dentry)
636{
637 WARN_ON(d_in_lookup(dentry));
638
639 /* Unreachable? Get rid of it */
640 if (unlikely(d_unhashed(dentry)))
641 return false;
642
643 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
644 return false;
645
646 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
647 if (dentry->d_op->d_delete(dentry))
648 return false;
649 }
Ira Weiny2c567af2020-04-30 07:41:37 -0700650
651 if (unlikely(dentry->d_flags & DCACHE_DONTCACHE))
652 return false;
653
Al Viro62d99562018-03-06 21:37:31 -0500654 /* retain; LRU fodder */
655 dentry->d_lockref.count--;
656 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
657 d_lru_add(dentry);
658 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
659 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500660 return true;
661}
662
Ira Weiny2c567af2020-04-30 07:41:37 -0700663void d_mark_dontcache(struct inode *inode)
664{
665 struct dentry *de;
666
667 spin_lock(&inode->i_lock);
668 hlist_for_each_entry(de, &inode->i_dentry, d_u.d_alias) {
669 spin_lock(&de->d_lock);
670 de->d_flags |= DCACHE_DONTCACHE;
671 spin_unlock(&de->d_lock);
672 }
673 inode->i_state |= I_DONTCACHE;
674 spin_unlock(&inode->i_lock);
675}
676EXPORT_SYMBOL(d_mark_dontcache);
677
Linus Torvalds360f5472015-01-09 15:19:03 -0800678/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100679 * Finish off a dentry we've decided to kill.
680 * dentry->d_lock must be held, returns with it unlocked.
681 * Returns dentry requiring refcount drop, or NULL if we're done.
682 */
683static struct dentry *dentry_kill(struct dentry *dentry)
684 __releases(dentry->d_lock)
685{
686 struct inode *inode = dentry->d_inode;
687 struct dentry *parent = NULL;
688
689 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500690 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100691
692 if (!IS_ROOT(dentry)) {
693 parent = dentry->d_parent;
694 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500695 parent = __lock_parent(dentry);
696 if (likely(inode || !dentry->d_inode))
697 goto got_locks;
698 /* negative that became positive */
699 if (parent)
700 spin_unlock(&parent->d_lock);
701 inode = dentry->d_inode;
702 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100703 }
704 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100705 __dentry_kill(dentry);
706 return parent;
707
Al Virof657a662018-02-23 21:25:42 -0500708slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100709 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500710 spin_lock(&inode->i_lock);
711 spin_lock(&dentry->d_lock);
712 parent = lock_parent(dentry);
713got_locks:
714 if (unlikely(dentry->d_lockref.count != 1)) {
715 dentry->d_lockref.count--;
716 } else if (likely(!retain_dentry(dentry))) {
717 __dentry_kill(dentry);
718 return parent;
719 }
720 /* we are keeping it, after all */
721 if (inode)
722 spin_unlock(&inode->i_lock);
723 if (parent)
724 spin_unlock(&parent->d_lock);
725 spin_unlock(&dentry->d_lock);
726 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100727}
728
729/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800730 * Try to do a lockless dput(), and return whether that was successful.
731 *
732 * If unsuccessful, we return false, having already taken the dentry lock.
733 *
734 * The caller needs to hold the RCU read lock, so that the dentry is
735 * guaranteed to stay around even if the refcount goes down to zero!
736 */
737static inline bool fast_dput(struct dentry *dentry)
738{
739 int ret;
740 unsigned int d_flags;
741
742 /*
743 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100744 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800745 */
746 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
747 return lockref_put_or_lock(&dentry->d_lockref);
748
749 /*
750 * .. otherwise, we can try to just decrement the
751 * lockref optimistically.
752 */
753 ret = lockref_put_return(&dentry->d_lockref);
754
755 /*
756 * If the lockref_put_return() failed due to the lock being held
757 * by somebody else, the fast path has failed. We will need to
758 * get the lock, and then check the count again.
759 */
760 if (unlikely(ret < 0)) {
761 spin_lock(&dentry->d_lock);
762 if (dentry->d_lockref.count > 1) {
763 dentry->d_lockref.count--;
764 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500765 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800766 }
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500767 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800768 }
769
770 /*
771 * If we weren't the last ref, we're done.
772 */
773 if (ret)
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500774 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800775
776 /*
777 * Careful, careful. The reference count went down
778 * to zero, but we don't hold the dentry lock, so
779 * somebody else could get it again, and do another
780 * dput(), and we need to not race with that.
781 *
782 * However, there is a very special and common case
783 * where we don't care, because there is nothing to
784 * do: the dentry is still hashed, it does not have
785 * a 'delete' op, and it's referenced and already on
786 * the LRU list.
787 *
788 * NOTE! Since we aren't locked, these values are
789 * not "stable". However, it is sufficient that at
790 * some point after we dropped the reference the
791 * dentry was hashed and the flags had the proper
792 * value. Other dentry users may have re-gotten
793 * a reference to the dentry and change that, but
794 * our work is done - we can leave the dentry
795 * around with a zero refcount.
Hao Li77573fa2020-12-08 10:10:50 +0800796 *
797 * Nevertheless, there are two cases that we should kill
798 * the dentry anyway.
799 * 1. free disconnected dentries as soon as their refcount
800 * reached zero.
801 * 2. free dentries if they should not be cached.
Linus Torvalds360f5472015-01-09 15:19:03 -0800802 */
803 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700804 d_flags = READ_ONCE(dentry->d_flags);
Hao Li77573fa2020-12-08 10:10:50 +0800805 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST |
806 DCACHE_DISCONNECTED | DCACHE_DONTCACHE;
Linus Torvalds360f5472015-01-09 15:19:03 -0800807
808 /* Nothing to do? Dropping the reference was all we needed? */
809 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500810 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800811
812 /*
813 * Not the fast normal case? Get the lock. We've already decremented
814 * the refcount, but we'll need to re-check the situation after
815 * getting the lock.
816 */
817 spin_lock(&dentry->d_lock);
818
819 /*
820 * Did somebody else grab a reference to it in the meantime, and
821 * we're no longer the last user after all? Alternatively, somebody
822 * else could have killed it and marked it dead. Either way, we
823 * don't need to do anything else.
824 */
825 if (dentry->d_lockref.count) {
826 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500827 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800828 }
829
830 /*
831 * Re-get the reference we optimistically dropped. We hold the
832 * lock, and we just tested that it was zero, so we can just
833 * set it to 1.
834 */
835 dentry->d_lockref.count = 1;
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500836 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800837}
838
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840/*
841 * This is dput
842 *
843 * This is complicated by the fact that we do not want to put
844 * dentries that are no longer on any hash chain on the unused
845 * list: we'd much rather just get rid of them immediately.
846 *
847 * However, that implies that we have to traverse the dentry
848 * tree upwards to the parents which might _also_ now be
849 * scheduled for deletion (it may have been only waiting for
850 * its last child to go away).
851 *
852 * This tail recursion is done by hand as we don't want to depend
853 * on the compiler to always get this right (gcc generally doesn't).
854 * Real recursion would eat up our stack space.
855 */
856
857/*
858 * dput - release a dentry
859 * @dentry: dentry to release
860 *
861 * Release a dentry. This will drop the usage count and if appropriate
862 * call the dentry unlink method as well as removing it from the queues and
863 * releasing its resources. If the parent dentries were scheduled for release
864 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866void dput(struct dentry *dentry)
867{
Al Viro1088a642018-04-15 18:31:03 -0400868 while (dentry) {
869 might_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Al Viro1088a642018-04-15 18:31:03 -0400871 rcu_read_lock();
872 if (likely(fast_dput(dentry))) {
873 rcu_read_unlock();
874 return;
875 }
Wei Fang47be6182016-07-06 11:32:20 +0800876
Al Viro1088a642018-04-15 18:31:03 -0400877 /* Slow case: now with the dentry lock held */
Linus Torvalds360f5472015-01-09 15:19:03 -0800878 rcu_read_unlock();
Linus Torvalds360f5472015-01-09 15:19:03 -0800879
Al Viro1088a642018-04-15 18:31:03 -0400880 if (likely(retain_dentry(dentry))) {
881 spin_unlock(&dentry->d_lock);
882 return;
883 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Al Viro1088a642018-04-15 18:31:03 -0400885 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700888EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Al Viro9bdebc22019-06-29 18:31:24 -0400890static void __dput_to_list(struct dentry *dentry, struct list_head *list)
891__must_hold(&dentry->d_lock)
892{
893 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
894 /* let the owner of the list it's on deal with it */
895 --dentry->d_lockref.count;
896 } else {
897 if (dentry->d_flags & DCACHE_LRU_LIST)
898 d_lru_del(dentry);
899 if (!--dentry->d_lockref.count)
900 d_shrink_add(dentry, list);
901 }
902}
903
904void dput_to_list(struct dentry *dentry, struct list_head *list)
905{
906 rcu_read_lock();
907 if (likely(fast_dput(dentry))) {
908 rcu_read_unlock();
909 return;
910 }
911 rcu_read_unlock();
912 if (!retain_dentry(dentry))
913 __dput_to_list(dentry, list);
914 spin_unlock(&dentry->d_lock);
915}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100917/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100918static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
Waiman Long98474232013-08-28 18:24:59 -0700920 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921}
922
Nick Piggindc0474b2011-01-07 17:49:43 +1100923static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100924{
Waiman Long98474232013-08-28 18:24:59 -0700925 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100926}
927
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100928struct dentry *dget_parent(struct dentry *dentry)
929{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700930 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100931 struct dentry *ret;
Al Viroe8400932019-10-31 01:43:31 -0400932 unsigned seq;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100933
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700934 /*
935 * Do optimistic parent lookup without any
936 * locking.
937 */
938 rcu_read_lock();
Al Viroe8400932019-10-31 01:43:31 -0400939 seq = raw_seqcount_begin(&dentry->d_seq);
Mark Rutland66702eb2017-10-23 14:07:14 -0700940 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700941 gotref = lockref_get_not_zero(&ret->d_lockref);
942 rcu_read_unlock();
943 if (likely(gotref)) {
Al Viroe8400932019-10-31 01:43:31 -0400944 if (!read_seqcount_retry(&dentry->d_seq, seq))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700945 return ret;
946 dput(ret);
947 }
948
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100949repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100950 /*
951 * Don't need rcu_dereference because we re-check it was correct under
952 * the lock.
953 */
954 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100955 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100956 spin_lock(&ret->d_lock);
957 if (unlikely(ret != dentry->d_parent)) {
958 spin_unlock(&ret->d_lock);
959 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100960 goto repeat;
961 }
Nick Piggina734eb42011-01-07 17:49:44 +1100962 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700963 BUG_ON(!ret->d_lockref.count);
964 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100965 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100966 return ret;
967}
968EXPORT_SYMBOL(dget_parent);
969
Al Viro61fec492018-04-25 10:52:25 -0400970static struct dentry * __d_find_any_alias(struct inode *inode)
971{
972 struct dentry *alias;
973
974 if (hlist_empty(&inode->i_dentry))
975 return NULL;
976 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
977 __dget(alias);
978 return alias;
979}
980
981/**
982 * d_find_any_alias - find any alias for a given inode
983 * @inode: inode to find an alias for
984 *
985 * If any aliases exist for the given inode, take and return a
986 * reference for one of them. If no aliases exist, return %NULL.
987 */
988struct dentry *d_find_any_alias(struct inode *inode)
989{
990 struct dentry *de;
991
992 spin_lock(&inode->i_lock);
993 de = __d_find_any_alias(inode);
994 spin_unlock(&inode->i_lock);
995 return de;
996}
997EXPORT_SYMBOL(d_find_any_alias);
998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999/**
1000 * d_find_alias - grab a hashed alias of inode
1001 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 *
1003 * If inode has a hashed alias, or is a directory and has any alias,
1004 * acquire the reference to alias and return it. Otherwise return NULL.
1005 * Notice that if inode is a directory there can be only one alias and
1006 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -08001007 * of a filesystem, or if the directory was renamed and d_revalidate
1008 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 *
NeilBrown21c0d8f2006-10-04 02:16:16 -07001010 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001011 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001013static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014{
Al Viro61fec492018-04-25 10:52:25 -04001015 struct dentry *alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Al Viro61fec492018-04-25 10:52:25 -04001017 if (S_ISDIR(inode->i_mode))
1018 return __d_find_any_alias(inode);
1019
Al Viro946e51f2014-10-26 19:19:16 -04001020 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +11001021 spin_lock(&alias->d_lock);
Al Viro61fec492018-04-25 10:52:25 -04001022 if (!d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -05001023 __dget_dlock(alias);
1024 spin_unlock(&alias->d_lock);
1025 return alias;
Nick Pigginda502952011-01-07 17:49:33 +11001026 }
1027 spin_unlock(&alias->d_lock);
Nick Pigginda502952011-01-07 17:49:33 +11001028 }
1029 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030}
1031
Nick Pigginda502952011-01-07 17:49:33 +11001032struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033{
David Howells214fda12006-03-25 03:06:36 -08001034 struct dentry *de = NULL;
1035
Al Virob3d9b7a2012-06-09 13:51:19 -04001036 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001037 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001038 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001039 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -08001040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 return de;
1042}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001043EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
1045/*
1046 * Try to kill dentries associated with this inode.
1047 * WARNING: you must own a reference to inode.
1048 */
1049void d_prune_aliases(struct inode *inode)
1050{
Domen Puncer0cdca3f2005-09-10 00:27:07 -07001051 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052restart:
Nick Piggin873feea2011-01-07 17:50:06 +11001053 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -04001054 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -07001056 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -04001057 struct dentry *parent = lock_parent(dentry);
1058 if (likely(!dentry->d_lockref.count)) {
1059 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +08001060 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -04001061 goto restart;
1062 }
1063 if (parent)
1064 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 }
1066 spin_unlock(&dentry->d_lock);
1067 }
Nick Piggin873feea2011-01-07 17:50:06 +11001068 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001070EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Al Viro3b3f09f2018-02-23 21:54:18 -05001072/*
1073 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +01001074 * Called under rcu_read_lock() and dentry->d_lock; the former
1075 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -05001076 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +01001077 * d_delete(), etc.
1078 *
Al Viro3b3f09f2018-02-23 21:54:18 -05001079 * Return false if dentry has been disrupted or grabbed, leaving
1080 * the caller to kick it off-list. Otherwise, return true and have
1081 * that dentry's inode and parent both locked.
1082 */
1083static bool shrink_lock_dentry(struct dentry *dentry)
1084{
1085 struct inode *inode;
1086 struct dentry *parent;
1087
1088 if (dentry->d_lockref.count)
1089 return false;
1090
1091 inode = dentry->d_inode;
1092 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001093 spin_unlock(&dentry->d_lock);
1094 spin_lock(&inode->i_lock);
1095 spin_lock(&dentry->d_lock);
1096 if (unlikely(dentry->d_lockref.count))
1097 goto out;
1098 /* changed inode means that somebody had grabbed it */
1099 if (unlikely(inode != dentry->d_inode))
1100 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001101 }
1102
1103 parent = dentry->d_parent;
1104 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1105 return true;
1106
Al Viro3b3f09f2018-02-23 21:54:18 -05001107 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001108 spin_lock(&parent->d_lock);
1109 if (unlikely(parent != dentry->d_parent)) {
1110 spin_unlock(&parent->d_lock);
1111 spin_lock(&dentry->d_lock);
1112 goto out;
1113 }
1114 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001115 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001116 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001117 spin_unlock(&parent->d_lock);
1118out:
1119 if (inode)
1120 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001121 return false;
1122}
1123
Al Viro9bdebc22019-06-29 18:31:24 -04001124void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001126 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001127 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001128
Miklos Szeredi60942f22014-05-02 15:38:39 -04001129 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001130 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001131 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001132 if (!shrink_lock_dentry(dentry)) {
1133 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001134 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001135 d_shrink_del(dentry);
1136 if (dentry->d_lockref.count < 0)
1137 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001138 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001139 if (can_free)
1140 dentry_free(dentry);
1141 continue;
1142 }
John Ogness8f04da22018-02-23 00:50:24 +01001143 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001144 d_shrink_del(dentry);
1145 parent = dentry->d_parent;
Al Viro9bdebc22019-06-29 18:31:24 -04001146 if (parent != dentry)
1147 __dput_to_list(parent, list);
Al Viroff2fde92014-05-28 13:59:13 -04001148 __dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001150}
1151
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001152static enum lru_status dentry_lru_isolate(struct list_head *item,
1153 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001154{
1155 struct list_head *freeable = arg;
1156 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1157
1158
1159 /*
1160 * we are inverting the lru lock/dentry->d_lock here,
1161 * so use a trylock. If we fail to get the lock, just skip
1162 * it
1163 */
1164 if (!spin_trylock(&dentry->d_lock))
1165 return LRU_SKIP;
1166
1167 /*
1168 * Referenced dentries are still in use. If they have active
1169 * counts, just remove them from the LRU. Otherwise give them
1170 * another pass through the LRU.
1171 */
1172 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001173 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001174 spin_unlock(&dentry->d_lock);
1175 return LRU_REMOVED;
1176 }
1177
1178 if (dentry->d_flags & DCACHE_REFERENCED) {
1179 dentry->d_flags &= ~DCACHE_REFERENCED;
1180 spin_unlock(&dentry->d_lock);
1181
1182 /*
1183 * The list move itself will be made by the common LRU code. At
1184 * this point, we've dropped the dentry->d_lock but keep the
1185 * lru lock. This is safe to do, since every list movement is
1186 * protected by the lru lock even if both locks are held.
1187 *
1188 * This is guaranteed by the fact that all LRU management
1189 * functions are intermediated by the LRU API calls like
1190 * list_lru_add and list_lru_del. List movement in this file
1191 * only ever occur through this functions or through callbacks
1192 * like this one, that are called from the LRU API.
1193 *
1194 * The only exceptions to this are functions like
1195 * shrink_dentry_list, and code that first checks for the
1196 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1197 * operating only with stack provided lists after they are
1198 * properly isolated from the main list. It is thus, always a
1199 * local access.
1200 */
1201 return LRU_ROTATE;
1202 }
1203
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001204 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001205 spin_unlock(&dentry->d_lock);
1206
1207 return LRU_REMOVED;
1208}
1209
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001210/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001211 * prune_dcache_sb - shrink the dcache
1212 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001213 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001214 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001215 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1216 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001217 * function.
1218 *
1219 * This function may fail to free any resources if all the dentries are in
1220 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001221 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001222long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001223{
Dave Chinnerf6041562013-08-28 10:18:00 +10001224 LIST_HEAD(dispose);
1225 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001226
Vladimir Davydov503c3582015-02-12 14:58:47 -08001227 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1228 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001229 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001230 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231}
1232
Glauber Costa4e717f52013-08-28 10:18:03 +10001233static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001234 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001235{
Glauber Costa4e717f52013-08-28 10:18:03 +10001236 struct list_head *freeable = arg;
1237 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001238
Glauber Costa4e717f52013-08-28 10:18:03 +10001239 /*
1240 * we are inverting the lru lock/dentry->d_lock here,
1241 * so use a trylock. If we fail to get the lock, just skip
1242 * it
1243 */
1244 if (!spin_trylock(&dentry->d_lock))
1245 return LRU_SKIP;
1246
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001247 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001248 spin_unlock(&dentry->d_lock);
1249
1250 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001251}
1252
Glauber Costa4e717f52013-08-28 10:18:03 +10001253
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001254/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 * shrink_dcache_sb - shrink dcache for a superblock
1256 * @sb: superblock
1257 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001258 * Shrink the dcache for the specified super block. This is used to free
1259 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001261void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262{
Glauber Costa4e717f52013-08-28 10:18:03 +10001263 do {
1264 LIST_HEAD(dispose);
1265
Waiman Long1dbd4492019-01-30 13:52:36 -05001266 list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001267 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001268 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001269 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001271EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001274 * enum d_walk_ret - action to talke during tree walk
1275 * @D_WALK_CONTINUE: contrinue walk
1276 * @D_WALK_QUIT: quit walk
1277 * @D_WALK_NORETRY: quit when retry is needed
1278 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001280enum d_walk_ret {
1281 D_WALK_CONTINUE,
1282 D_WALK_QUIT,
1283 D_WALK_NORETRY,
1284 D_WALK_SKIP,
1285};
1286
1287/**
1288 * d_walk - walk the dentry tree
1289 * @parent: start of walk
1290 * @data: data passed to @enter() and @finish()
1291 * @enter: callback when first entering the dentry
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001292 *
Al Viro3a8e3612018-04-15 18:27:23 -04001293 * The @enter() callbacks are called with d_lock held.
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001294 */
1295static void d_walk(struct dentry *parent, void *data,
Al Viro3a8e3612018-04-15 18:27:23 -04001296 enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297{
Nick Piggin949854d2011-01-07 17:49:37 +11001298 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001300 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001301 enum d_walk_ret ret;
1302 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001303
Nick Piggin58db63d2011-01-07 17:49:39 +11001304again:
Al Viro48f5ec22013-09-09 15:22:25 -04001305 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001306 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001307 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001308
1309 ret = enter(data, this_parent);
1310 switch (ret) {
1311 case D_WALK_CONTINUE:
1312 break;
1313 case D_WALK_QUIT:
1314 case D_WALK_SKIP:
1315 goto out_unlock;
1316 case D_WALK_NORETRY:
1317 retry = false;
1318 break;
1319 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320repeat:
1321 next = this_parent->d_subdirs.next;
1322resume:
1323 while (next != &this_parent->d_subdirs) {
1324 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001325 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001327
Al Viroba65dc52016-06-10 11:32:47 -04001328 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1329 continue;
1330
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001331 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001332
1333 ret = enter(data, dentry);
1334 switch (ret) {
1335 case D_WALK_CONTINUE:
1336 break;
1337 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001338 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001339 goto out_unlock;
1340 case D_WALK_NORETRY:
1341 retry = false;
1342 break;
1343 case D_WALK_SKIP:
1344 spin_unlock(&dentry->d_lock);
1345 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001346 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001347
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001349 spin_unlock(&this_parent->d_lock);
Qian Cai5facae42019-09-19 12:09:40 -04001350 spin_release(&dentry->d_lock.dep_map, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001352 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 goto repeat;
1354 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001355 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 }
1357 /*
1358 * All done at this level ... ascend and resume the search.
1359 */
Al Viroca5358e2014-10-26 19:31:10 -04001360 rcu_read_lock();
1361ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001363 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001364 this_parent = child->d_parent;
1365
Al Viro31dec132013-10-25 17:04:27 -04001366 spin_unlock(&child->d_lock);
1367 spin_lock(&this_parent->d_lock);
1368
Al Viroca5358e2014-10-26 19:31:10 -04001369 /* might go back up the wrong parent if we have had a rename. */
1370 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001371 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001372 /* go into the first sibling still alive */
1373 do {
1374 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001375 if (next == &this_parent->d_subdirs)
1376 goto ascend;
1377 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001378 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001379 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 goto resume;
1381 }
Al Viroca5358e2014-10-26 19:31:10 -04001382 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001383 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001384 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001385
1386out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001387 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001388 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001389 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001390
1391rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001392 spin_unlock(&this_parent->d_lock);
1393 rcu_read_unlock();
1394 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001395 if (!retry)
1396 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001397 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001398 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001400
Ian Kent01619492016-11-24 08:03:41 +11001401struct check_mount {
1402 struct vfsmount *mnt;
1403 unsigned int mounted;
1404};
1405
1406static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1407{
1408 struct check_mount *info = data;
1409 struct path path = { .mnt = info->mnt, .dentry = dentry };
1410
1411 if (likely(!d_mountpoint(dentry)))
1412 return D_WALK_CONTINUE;
1413 if (__path_is_mountpoint(&path)) {
1414 info->mounted = 1;
1415 return D_WALK_QUIT;
1416 }
1417 return D_WALK_CONTINUE;
1418}
1419
1420/**
1421 * path_has_submounts - check for mounts over a dentry in the
1422 * current namespace.
1423 * @parent: path to check.
1424 *
1425 * Return true if the parent or its subdirectories contain
1426 * a mount point in the current namespace.
1427 */
1428int path_has_submounts(const struct path *parent)
1429{
1430 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1431
1432 read_seqlock_excl(&mount_lock);
Al Viro3a8e3612018-04-15 18:27:23 -04001433 d_walk(parent->dentry, &data, path_check_mount);
Ian Kent01619492016-11-24 08:03:41 +11001434 read_sequnlock_excl(&mount_lock);
1435
1436 return data.mounted;
1437}
1438EXPORT_SYMBOL(path_has_submounts);
1439
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001441 * Called by mount code to set a mountpoint and check if the mountpoint is
1442 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1443 * subtree can become unreachable).
1444 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001445 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001446 * this reason take rename_lock and d_lock on dentry and ancestors.
1447 */
1448int d_set_mounted(struct dentry *dentry)
1449{
1450 struct dentry *p;
1451 int ret = -ENOENT;
1452 write_seqlock(&rename_lock);
1453 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001454 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001455 spin_lock(&p->d_lock);
1456 if (unlikely(d_unhashed(p))) {
1457 spin_unlock(&p->d_lock);
1458 goto out;
1459 }
1460 spin_unlock(&p->d_lock);
1461 }
1462 spin_lock(&dentry->d_lock);
1463 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001464 ret = -EBUSY;
1465 if (!d_mountpoint(dentry)) {
1466 dentry->d_flags |= DCACHE_MOUNTED;
1467 ret = 0;
1468 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001469 }
1470 spin_unlock(&dentry->d_lock);
1471out:
1472 write_sequnlock(&rename_lock);
1473 return ret;
1474}
1475
1476/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001477 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 * and move any unused dentries to the end of the unused
1479 * list for prune_dcache(). We descend to the next level
1480 * whenever the d_subdirs list is non-empty and continue
1481 * searching.
1482 *
1483 * It returns zero iff there are no unused children,
1484 * otherwise it returns the number of children moved to
1485 * the end of the unused list. This may not be the total
1486 * number of unused children, because select_parent can
1487 * drop the lock and return early due to latency
1488 * constraints.
1489 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001490
1491struct select_data {
1492 struct dentry *start;
Al Viro9bdebc22019-06-29 18:31:24 -04001493 union {
1494 long found;
1495 struct dentry *victim;
1496 };
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001497 struct list_head dispose;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001498};
1499
1500static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001502 struct select_data *data = _data;
1503 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001505 if (data->start == dentry)
1506 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
Al Virofe915222014-05-03 00:02:25 -04001508 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001509 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001510 } else {
1511 if (dentry->d_flags & DCACHE_LRU_LIST)
1512 d_lru_del(dentry);
1513 if (!dentry->d_lockref.count) {
1514 d_shrink_add(dentry, &data->dispose);
1515 data->found++;
1516 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 }
1518 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001519 * We can return to the caller if we have found some (this
1520 * ensures forward progress). We'll be coming back to find
1521 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 */
Al Virofe915222014-05-03 00:02:25 -04001523 if (!list_empty(&data->dispose))
1524 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001526 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527}
1528
Al Viro9bdebc22019-06-29 18:31:24 -04001529static enum d_walk_ret select_collect2(void *_data, struct dentry *dentry)
1530{
1531 struct select_data *data = _data;
1532 enum d_walk_ret ret = D_WALK_CONTINUE;
1533
1534 if (data->start == dentry)
1535 goto out;
1536
1537 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
1538 if (!dentry->d_lockref.count) {
1539 rcu_read_lock();
1540 data->victim = dentry;
1541 return D_WALK_QUIT;
1542 }
1543 } else {
1544 if (dentry->d_flags & DCACHE_LRU_LIST)
1545 d_lru_del(dentry);
1546 if (!dentry->d_lockref.count)
1547 d_shrink_add(dentry, &data->dispose);
1548 }
1549 /*
1550 * We can return to the caller if we have found some (this
1551 * ensures forward progress). We'll be coming back to find
1552 * the rest.
1553 */
1554 if (!list_empty(&data->dispose))
1555 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
1556out:
1557 return ret;
1558}
1559
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560/**
1561 * shrink_dcache_parent - prune dcache
1562 * @parent: parent of entries to prune
1563 *
1564 * Prune the dcache to remove unused children of the parent dentry.
1565 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001566void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001568 for (;;) {
Al Viro9bdebc22019-06-29 18:31:24 -04001569 struct select_data data = {.start = parent};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001571 INIT_LIST_HEAD(&data.dispose);
Al Viro3a8e3612018-04-15 18:27:23 -04001572 d_walk(parent, &data, select_collect);
Al Viro4fb48872018-04-19 23:58:48 -04001573
1574 if (!list_empty(&data.dispose)) {
1575 shrink_dentry_list(&data.dispose);
1576 continue;
1577 }
1578
1579 cond_resched();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001580 if (!data.found)
1581 break;
Al Viro9bdebc22019-06-29 18:31:24 -04001582 data.victim = NULL;
1583 d_walk(parent, &data, select_collect2);
1584 if (data.victim) {
1585 struct dentry *parent;
1586 spin_lock(&data.victim->d_lock);
1587 if (!shrink_lock_dentry(data.victim)) {
1588 spin_unlock(&data.victim->d_lock);
1589 rcu_read_unlock();
1590 } else {
1591 rcu_read_unlock();
1592 parent = data.victim->d_parent;
1593 if (parent != data.victim)
1594 __dput_to_list(parent, &data.dispose);
1595 __dentry_kill(data.victim);
1596 }
1597 }
1598 if (!list_empty(&data.dispose))
1599 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001602EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
Al Viro9c8c10e2014-05-02 20:36:10 -04001604static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001605{
Al Viro9c8c10e2014-05-02 20:36:10 -04001606 /* it has busy descendents; complain about those instead */
1607 if (!list_empty(&dentry->d_subdirs))
1608 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001609
Al Viro9c8c10e2014-05-02 20:36:10 -04001610 /* root with refcount 1 is fine */
1611 if (dentry == _data && dentry->d_lockref.count == 1)
1612 return D_WALK_CONTINUE;
1613
1614 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1615 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001616 dentry,
1617 dentry->d_inode ?
1618 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001619 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001620 dentry->d_lockref.count,
1621 dentry->d_sb->s_type->name,
1622 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001623 WARN_ON(1);
1624 return D_WALK_CONTINUE;
1625}
1626
1627static void do_one_tree(struct dentry *dentry)
1628{
1629 shrink_dcache_parent(dentry);
Al Viro3a8e3612018-04-15 18:27:23 -04001630 d_walk(dentry, dentry, umount_check);
Al Viro9c8c10e2014-05-02 20:36:10 -04001631 d_drop(dentry);
1632 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001633}
1634
1635/*
1636 * destroy the dentries attached to a superblock on unmounting
1637 */
1638void shrink_dcache_for_umount(struct super_block *sb)
1639{
1640 struct dentry *dentry;
1641
Al Viro9c8c10e2014-05-02 20:36:10 -04001642 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001643
1644 dentry = sb->s_root;
1645 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001646 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001647
NeilBrownf1ee6162017-12-21 09:45:40 +11001648 while (!hlist_bl_empty(&sb->s_roots)) {
1649 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001650 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001651 }
1652}
1653
Al Viroff17fa52018-04-15 18:21:47 -04001654static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001655{
Al Viroff17fa52018-04-15 18:21:47 -04001656 struct dentry **victim = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001657 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001658 __dget_dlock(dentry);
Al Viroff17fa52018-04-15 18:21:47 -04001659 *victim = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001660 return D_WALK_QUIT;
1661 }
Al Viroff17fa52018-04-15 18:21:47 -04001662 return D_WALK_CONTINUE;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001663}
1664
1665/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001666 * d_invalidate - detach submounts, prune dcache, and drop
1667 * @dentry: dentry to invalidate (aka detach, prune and drop)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001668 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001669void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001670{
Al Viroff17fa52018-04-15 18:21:47 -04001671 bool had_submounts = false;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001672 spin_lock(&dentry->d_lock);
1673 if (d_unhashed(dentry)) {
1674 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001675 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001676 }
Al Viroff17fa52018-04-15 18:21:47 -04001677 __d_drop(dentry);
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001678 spin_unlock(&dentry->d_lock);
1679
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001680 /* Negative dentries can be dropped without further checks */
Al Viroff17fa52018-04-15 18:21:47 -04001681 if (!dentry->d_inode)
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001682 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001683
Al Viroff17fa52018-04-15 18:21:47 -04001684 shrink_dcache_parent(dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001685 for (;;) {
Al Viroff17fa52018-04-15 18:21:47 -04001686 struct dentry *victim = NULL;
Al Viro3a8e3612018-04-15 18:27:23 -04001687 d_walk(dentry, &victim, find_submount);
Al Viroff17fa52018-04-15 18:21:47 -04001688 if (!victim) {
1689 if (had_submounts)
1690 shrink_dcache_parent(dentry);
Al Viro81be24d2017-06-03 07:20:09 +01001691 return;
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001692 }
Al Viroff17fa52018-04-15 18:21:47 -04001693 had_submounts = true;
1694 detach_mounts(victim);
1695 dput(victim);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001696 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001697}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001698EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001699
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700/**
Al Viroa4464db2011-07-07 15:03:58 -04001701 * __d_alloc - allocate a dcache entry
1702 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 * @name: qstr of the name
1704 *
1705 * Allocates a dentry. It returns %NULL if there is insufficient memory
1706 * available. On a success the dentry is returned. The name passed in is
1707 * copied and the copy passed in may be reused after this call.
1708 */
1709
Al Viro5c8b0df2019-10-25 14:08:24 -04001710static struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711{
1712 struct dentry *dentry;
1713 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001714 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
Mel Gormane12ba742007-10-16 01:25:52 -07001716 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 if (!dentry)
1718 return NULL;
1719
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001720 /*
1721 * We guarantee that the inline name is always NUL-terminated.
1722 * This way the memcpy() done by the name switching in rename
1723 * will still always have a NUL at the end, even if we might
1724 * be overwriting an internal NUL character
1725 */
1726 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001727 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001728 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001729 dname = dentry->d_iname;
1730 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001731 size_t size = offsetof(struct external_name, name[1]);
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001732 struct external_name *p = kmalloc(size + name->len,
1733 GFP_KERNEL_ACCOUNT |
1734 __GFP_RECLAIMABLE);
1735 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 kmem_cache_free(dentry_cache, dentry);
1737 return NULL;
1738 }
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001739 atomic_set(&p->u.count, 1);
1740 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 } else {
1742 dname = dentry->d_iname;
1743 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744
1745 dentry->d_name.len = name->len;
1746 dentry->d_name.hash = name->hash;
1747 memcpy(dname, name->name, name->len);
1748 dname[name->len] = 0;
1749
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001750 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001751 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001752
Waiman Long98474232013-08-28 18:24:59 -07001753 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001754 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 spin_lock_init(&dentry->d_lock);
Ahmed S. Darwish26475372020-07-20 17:55:24 +02001756 seqcount_spinlock_init(&dentry->d_seq, &dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001758 dentry->d_parent = dentry;
1759 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 dentry->d_op = NULL;
1761 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001762 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 INIT_LIST_HEAD(&dentry->d_lru);
1764 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001765 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1766 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001767 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
Miklos Szeredi285b1022016-06-28 11:47:32 +02001769 if (dentry->d_op && dentry->d_op->d_init) {
1770 err = dentry->d_op->d_init(dentry);
1771 if (err) {
1772 if (dname_external(dentry))
1773 kfree(external_name(dentry));
1774 kmem_cache_free(dentry_cache, dentry);
1775 return NULL;
1776 }
1777 }
1778
Nick Piggin3e880fb2011-01-07 17:49:19 +11001779 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001780
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 return dentry;
1782}
Al Viroa4464db2011-07-07 15:03:58 -04001783
1784/**
1785 * d_alloc - allocate a dcache entry
1786 * @parent: parent of entry to allocate
1787 * @name: qstr of the name
1788 *
1789 * Allocates a dentry. It returns %NULL if there is insufficient memory
1790 * available. On a success the dentry is returned. The name passed in is
1791 * copied and the copy passed in may be reused after this call.
1792 */
1793struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1794{
1795 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1796 if (!dentry)
1797 return NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001798 spin_lock(&parent->d_lock);
1799 /*
1800 * don't need child lock because it is not subject
1801 * to concurrency here
1802 */
1803 __dget_dlock(parent);
1804 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001805 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001806 spin_unlock(&parent->d_lock);
1807
1808 return dentry;
1809}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001810EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Miklos Szeredif9c34672018-01-19 11:39:52 +01001812struct dentry *d_alloc_anon(struct super_block *sb)
1813{
1814 return __d_alloc(sb, NULL);
1815}
1816EXPORT_SYMBOL(d_alloc_anon);
1817
Al Viroba65dc52016-06-10 11:32:47 -04001818struct dentry *d_alloc_cursor(struct dentry * parent)
1819{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001820 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001821 if (dentry) {
Al Viro5467a682019-03-15 22:23:19 -04001822 dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viroba65dc52016-06-10 11:32:47 -04001823 dentry->d_parent = dget(parent);
1824 }
1825 return dentry;
1826}
1827
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001828/**
1829 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1830 * @sb: the superblock
1831 * @name: qstr of the name
1832 *
1833 * For a filesystem that just pins its dentries in memory and never
1834 * performs lookups at all, return an unhashed IS_ROOT dentry.
Al Viro5467a682019-03-15 22:23:19 -04001835 * This is used for pipes, sockets et.al. - the stuff that should
1836 * never be anyone's children or parents. Unlike all other
1837 * dentries, these will not have RCU delay between dropping the
1838 * last reference and freeing them.
Al Viroab1152d2019-03-15 22:58:11 -04001839 *
1840 * The only user is alloc_file_pseudo() and that's what should
1841 * be considered a public interface. Don't use directly.
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001842 */
Nick Piggin4b936882011-01-07 17:50:07 +11001843struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1844{
Al Viro5467a682019-03-15 22:23:19 -04001845 struct dentry *dentry = __d_alloc(sb, name);
1846 if (likely(dentry))
1847 dentry->d_flags |= DCACHE_NORCU;
1848 return dentry;
Nick Piggin4b936882011-01-07 17:50:07 +11001849}
Nick Piggin4b936882011-01-07 17:50:07 +11001850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1852{
1853 struct qstr q;
1854
1855 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001856 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 return d_alloc(parent, &q);
1858}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001859EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860
Nick Pigginfb045ad2011-01-07 17:49:55 +11001861void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1862{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001863 WARN_ON_ONCE(dentry->d_op);
1864 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001865 DCACHE_OP_COMPARE |
1866 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001867 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001868 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001869 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001870 dentry->d_op = op;
1871 if (!op)
1872 return;
1873 if (op->d_hash)
1874 dentry->d_flags |= DCACHE_OP_HASH;
1875 if (op->d_compare)
1876 dentry->d_flags |= DCACHE_OP_COMPARE;
1877 if (op->d_revalidate)
1878 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001879 if (op->d_weak_revalidate)
1880 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001881 if (op->d_delete)
1882 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001883 if (op->d_prune)
1884 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001885 if (op->d_real)
1886 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001887
1888}
1889EXPORT_SYMBOL(d_set_d_op);
1890
David Howellsdf1a0852015-01-29 12:02:28 +00001891
1892/*
1893 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1894 * @dentry - The dentry to mark
1895 *
1896 * Mark a dentry as falling through to the lower layer (as set with
1897 * d_pin_lower()). This flag may be recorded on the medium.
1898 */
1899void d_set_fallthru(struct dentry *dentry)
1900{
1901 spin_lock(&dentry->d_lock);
1902 dentry->d_flags |= DCACHE_FALLTHRU;
1903 spin_unlock(&dentry->d_lock);
1904}
1905EXPORT_SYMBOL(d_set_fallthru);
1906
David Howellsb18825a2013-09-12 19:22:53 +01001907static unsigned d_flags_for_inode(struct inode *inode)
1908{
David Howells44bdb5e2015-01-29 12:02:29 +00001909 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001910
1911 if (!inode)
1912 return DCACHE_MISS_TYPE;
1913
1914 if (S_ISDIR(inode->i_mode)) {
1915 add_flags = DCACHE_DIRECTORY_TYPE;
1916 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1917 if (unlikely(!inode->i_op->lookup))
1918 add_flags = DCACHE_AUTODIR_TYPE;
1919 else
1920 inode->i_opflags |= IOP_LOOKUP;
1921 }
David Howells44bdb5e2015-01-29 12:02:29 +00001922 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001923 }
1924
David Howells44bdb5e2015-01-29 12:02:29 +00001925 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001926 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001927 add_flags = DCACHE_SYMLINK_TYPE;
1928 goto type_determined;
1929 }
1930 inode->i_opflags |= IOP_NOFOLLOW;
1931 }
1932
1933 if (unlikely(!S_ISREG(inode->i_mode)))
1934 add_flags = DCACHE_SPECIAL_TYPE;
1935
1936type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001937 if (unlikely(IS_AUTOMOUNT(inode)))
1938 add_flags |= DCACHE_NEED_AUTOMOUNT;
1939 return add_flags;
1940}
1941
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001942static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1943{
David Howellsb18825a2013-09-12 19:22:53 +01001944 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001945 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001946
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001947 spin_lock(&dentry->d_lock);
Waiman Longaf0c9af2019-01-30 13:52:38 -05001948 /*
1949 * Decrement negative dentry count if it was in the LRU list.
1950 */
1951 if (dentry->d_flags & DCACHE_LRU_LIST)
1952 this_cpu_dec(nr_dentry_negative);
Al Virode689f52016-03-09 18:05:42 -05001953 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001954 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001955 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001956 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001957 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001958 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001959}
1960
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961/**
1962 * d_instantiate - fill in inode information for a dentry
1963 * @entry: dentry to complete
1964 * @inode: inode to attach to this dentry
1965 *
1966 * Fill in inode information in the entry.
1967 *
1968 * This turns negative dentries into productive full members
1969 * of society.
1970 *
1971 * NOTE! This assumes that the inode count has been incremented
1972 * (or otherwise set) by the caller to indicate that it is now
1973 * in use by the dcache.
1974 */
1975
1976void d_instantiate(struct dentry *entry, struct inode * inode)
1977{
Al Viro946e51f2014-10-26 19:19:16 -04001978 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001979 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001980 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001981 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001982 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001983 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001984 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001986EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Al Viro1e2e5472018-05-04 08:23:01 -04001988/*
1989 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1990 * with lockdep-related part of unlock_new_inode() done before
1991 * anything else. Use that instead of open-coding d_instantiate()/
1992 * unlock_new_inode() combinations.
1993 */
1994void d_instantiate_new(struct dentry *entry, struct inode *inode)
1995{
1996 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1997 BUG_ON(!inode);
1998 lockdep_annotate_inode_mutex_key(inode);
1999 security_d_instantiate(entry, inode);
2000 spin_lock(&inode->i_lock);
2001 __d_instantiate(entry, inode);
2002 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04002003 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro1e2e5472018-05-04 08:23:01 -04002004 smp_mb();
2005 wake_up_bit(&inode->i_state, __I_NEW);
2006 spin_unlock(&inode->i_lock);
2007}
2008EXPORT_SYMBOL(d_instantiate_new);
2009
Al Viroadc0e91a2012-01-08 16:49:21 -05002010struct dentry *d_make_root(struct inode *root_inode)
2011{
2012 struct dentry *res = NULL;
2013
2014 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01002015 res = d_alloc_anon(root_inode->i_sb);
Al Viro5467a682019-03-15 22:23:19 -04002016 if (res)
Al Viroadc0e91a2012-01-08 16:49:21 -05002017 d_instantiate(res, root_inode);
Al Viro5467a682019-03-15 22:23:19 -04002018 else
Al Viroadc0e91a2012-01-08 16:49:21 -05002019 iput(root_inode);
2020 }
2021 return res;
2022}
2023EXPORT_SYMBOL(d_make_root);
2024
Miklos Szeredif9c34672018-01-19 11:39:52 +01002025static struct dentry *__d_instantiate_anon(struct dentry *dentry,
2026 struct inode *inode,
2027 bool disconnected)
2028{
2029 struct dentry *res;
2030 unsigned add_flags;
2031
2032 security_d_instantiate(dentry, inode);
2033 spin_lock(&inode->i_lock);
2034 res = __d_find_any_alias(inode);
2035 if (res) {
2036 spin_unlock(&inode->i_lock);
2037 dput(dentry);
2038 goto out_iput;
2039 }
2040
2041 /* attach a disconnected dentry */
2042 add_flags = d_flags_for_inode(inode);
2043
2044 if (disconnected)
2045 add_flags |= DCACHE_DISCONNECTED;
2046
2047 spin_lock(&dentry->d_lock);
2048 __d_set_inode_and_type(dentry, inode, add_flags);
2049 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08002050 if (!disconnected) {
2051 hlist_bl_lock(&dentry->d_sb->s_roots);
2052 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
2053 hlist_bl_unlock(&dentry->d_sb->s_roots);
2054 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01002055 spin_unlock(&dentry->d_lock);
2056 spin_unlock(&inode->i_lock);
2057
2058 return dentry;
2059
2060 out_iput:
2061 iput(inode);
2062 return res;
2063}
2064
2065struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2066{
2067 return __d_instantiate_anon(dentry, inode, true);
2068}
2069EXPORT_SYMBOL(d_instantiate_anon);
2070
2071static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002072{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002073 struct dentry *tmp;
2074 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002075
2076 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002077 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002078 if (IS_ERR(inode))
2079 return ERR_CAST(inode);
2080
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002081 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002082 if (res)
2083 goto out_iput;
2084
Miklos Szeredif9c34672018-01-19 11:39:52 +01002085 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002086 if (!tmp) {
2087 res = ERR_PTR(-ENOMEM);
2088 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002089 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002090
Miklos Szeredif9c34672018-01-19 11:39:52 +01002091 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002092
Miklos Szeredif9c34672018-01-19 11:39:52 +01002093out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002094 iput(inode);
2095 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002096}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002097
2098/**
2099 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2100 * @inode: inode to allocate the dentry for
2101 *
2102 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2103 * similar open by handle operations. The returned dentry may be anonymous,
2104 * or may have a full name (if the inode was already in the cache).
2105 *
2106 * When called on a directory inode, we must ensure that the inode only ever
2107 * has one dentry. If a dentry is found, that is returned instead of
2108 * allocating a new one.
2109 *
2110 * On successful return, the reference to the inode has been transferred
2111 * to the dentry. In case of an error the reference on the inode is released.
2112 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2113 * be passed in and the error will be propagated to the return value,
2114 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2115 */
2116struct dentry *d_obtain_alias(struct inode *inode)
2117{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002118 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002119}
Benny Halevyadc48722009-02-27 14:02:59 -08002120EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
2122/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002123 * d_obtain_root - find or allocate a dentry for a given inode
2124 * @inode: inode to allocate the dentry for
2125 *
2126 * Obtain an IS_ROOT dentry for the root of a filesystem.
2127 *
2128 * We must ensure that directory inodes only ever have one dentry. If a
2129 * dentry is found, that is returned instead of allocating a new one.
2130 *
2131 * On successful return, the reference to the inode has been transferred
2132 * to the dentry. In case of an error the reference on the inode is
2133 * released. A %NULL or IS_ERR inode may be passed in and will be the
2134 * error will be propagate to the return value, with a %NULL @inode
2135 * replaced by ERR_PTR(-ESTALE).
2136 */
2137struct dentry *d_obtain_root(struct inode *inode)
2138{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002139 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002140}
2141EXPORT_SYMBOL(d_obtain_root);
2142
2143/**
Barry Naujok94035402008-05-21 16:50:46 +10002144 * d_add_ci - lookup or allocate new dentry with case-exact name
2145 * @inode: the inode case-insensitive lookup has found
2146 * @dentry: the negative dentry that was passed to the parent's lookup func
2147 * @name: the case-exact name to be associated with the returned dentry
2148 *
2149 * This is to avoid filling the dcache with case-insensitive names to the
2150 * same inode, only the actual correct case is stored in the dcache for
2151 * case-insensitive filesystems.
2152 *
2153 * For a case-insensitive lookup match and if the the case-exact dentry
2154 * already exists in in the dcache, use it and return it.
2155 *
2156 * If no entry exists with the exact case name, allocate new dentry with
2157 * the exact case, and return the spliced entry.
2158 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002159struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002160 struct qstr *name)
2161{
Al Virod9171b92016-04-15 03:33:13 -04002162 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002163
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002164 /*
2165 * First check if a dentry matching the name already exists,
2166 * if not go ahead and create it now.
2167 */
Barry Naujok94035402008-05-21 16:50:46 +10002168 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002169 if (found) {
2170 iput(inode);
2171 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002172 }
Al Virod9171b92016-04-15 03:33:13 -04002173 if (d_in_lookup(dentry)) {
2174 found = d_alloc_parallel(dentry->d_parent, name,
2175 dentry->d_wait);
2176 if (IS_ERR(found) || !d_in_lookup(found)) {
2177 iput(inode);
2178 return found;
2179 }
2180 } else {
2181 found = d_alloc(dentry->d_parent, name);
2182 if (!found) {
2183 iput(inode);
2184 return ERR_PTR(-ENOMEM);
2185 }
2186 }
2187 res = d_splice_alias(inode, found);
2188 if (res) {
2189 dput(found);
2190 return res;
2191 }
Al Viro4f522a22013-02-11 23:20:37 -05002192 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002193}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002194EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002196
Al Virod4c91a82016-06-25 23:33:49 -04002197static inline bool d_same_name(const struct dentry *dentry,
2198 const struct dentry *parent,
2199 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002200{
Al Virod4c91a82016-06-25 23:33:49 -04002201 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2202 if (dentry->d_name.len != name->len)
2203 return false;
2204 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002205 }
Al Viro6fa67e72016-07-31 16:37:25 -04002206 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002207 dentry->d_name.len, dentry->d_name.name,
2208 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002209}
2210
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002212 * __d_lookup_rcu - search for a dentry (racy, store-free)
2213 * @parent: parent dentry
2214 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002215 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002216 * Returns: dentry, or NULL
2217 *
2218 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2219 * resolution (store-free path walking) design described in
2220 * Documentation/filesystems/path-lookup.txt.
2221 *
2222 * This is not to be used outside core vfs.
2223 *
2224 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2225 * held, and rcu_read_lock held. The returned dentry must not be stored into
2226 * without taking d_lock and checking d_seq sequence count against @seq
2227 * returned here.
2228 *
Linus Torvalds15570082013-09-02 11:38:06 -07002229 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002230 * function.
2231 *
2232 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2233 * the returned dentry, so long as its parent's seqlock is checked after the
2234 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2235 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002236 *
2237 * NOTE! The caller *has* to check the resulting dentry against the sequence
2238 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002239 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002240struct dentry *__d_lookup_rcu(const struct dentry *parent,
2241 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002242 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002243{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002244 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002245 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002246 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002247 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002248 struct dentry *dentry;
2249
2250 /*
2251 * Note: There is significant duplication with __d_lookup_rcu which is
2252 * required to prevent single threaded performance regressions
2253 * especially on architectures where smp_rmb (in seqcounts) are costly.
2254 * Keep the two functions in sync.
2255 */
2256
2257 /*
2258 * The hash list is protected using RCU.
2259 *
2260 * Carefully use d_seq when comparing a candidate dentry, to avoid
2261 * races with d_move().
2262 *
2263 * It is possible that concurrent renames can mess up our list
2264 * walk here and result in missing our dentry, resulting in the
2265 * false-negative result. d_lookup() protects against concurrent
2266 * renames using rename_lock seqlock.
2267 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002268 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002269 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002270 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002271 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002272
Nick Piggin31e6b012011-01-07 17:49:52 +11002273seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002274 /*
2275 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002276 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002277 *
2278 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002279 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002280 *
2281 * NOTE! We do a "raw" seqcount_begin here. That means that
2282 * we don't wait for the sequence count to stabilize if it
2283 * is in the middle of a sequence change. If we do the slow
2284 * dentry compare, we will do seqretries until it is stable,
2285 * and if we end up with a successful lookup, we actually
2286 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002287 *
2288 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2289 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002290 */
2291 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002292 if (dentry->d_parent != parent)
2293 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002294 if (d_unhashed(dentry))
2295 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002296
2297 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002298 int tlen;
2299 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002300 if (dentry->d_name.hash != hashlen_hash(hashlen))
2301 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002302 tlen = dentry->d_name.len;
2303 tname = dentry->d_name.name;
2304 /* we want a consistent (name,len) pair */
2305 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2306 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002307 goto seqretry;
2308 }
Al Viro6fa67e72016-07-31 16:37:25 -04002309 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002310 tlen, tname, name) != 0)
2311 continue;
2312 } else {
2313 if (dentry->d_name.hash_len != hashlen)
2314 continue;
2315 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2316 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002317 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002318 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002319 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002320 }
2321 return NULL;
2322}
2323
2324/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 * d_lookup - search for a dentry
2326 * @parent: parent dentry
2327 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002328 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002330 * d_lookup searches the children of the parent dentry for the name in
2331 * question. If the dentry is found its reference count is incremented and the
2332 * dentry is returned. The caller must use dput to free the entry when it has
2333 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 */
Al Viroda2d8452013-01-24 18:29:34 -05002335struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336{
Nick Piggin31e6b012011-01-07 17:49:52 +11002337 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002338 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339
Daeseok Younb8314f92014-08-11 11:46:53 +09002340 do {
2341 seq = read_seqbegin(&rename_lock);
2342 dentry = __d_lookup(parent, name);
2343 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 break;
2345 } while (read_seqretry(&rename_lock, seq));
2346 return dentry;
2347}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002348EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349
Nick Piggin31e6b012011-01-07 17:49:52 +11002350/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002351 * __d_lookup - search for a dentry (racy)
2352 * @parent: parent dentry
2353 * @name: qstr of name we wish to find
2354 * Returns: dentry, or NULL
2355 *
2356 * __d_lookup is like d_lookup, however it may (rarely) return a
2357 * false-negative result due to unrelated rename activity.
2358 *
2359 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2360 * however it must be used carefully, eg. with a following d_lookup in
2361 * the case of failure.
2362 *
2363 * __d_lookup callers must be commented.
2364 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002365struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002368 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002369 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002370 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002371 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
Nick Pigginb04f7842010-08-18 04:37:34 +10002373 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002374 * Note: There is significant duplication with __d_lookup_rcu which is
2375 * required to prevent single threaded performance regressions
2376 * especially on architectures where smp_rmb (in seqcounts) are costly.
2377 * Keep the two functions in sync.
2378 */
2379
2380 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002381 * The hash list is protected using RCU.
2382 *
2383 * Take d_lock when comparing a candidate dentry, to avoid races
2384 * with d_move().
2385 *
2386 * It is possible that concurrent renames can mess up our list
2387 * walk here and result in missing our dentry, resulting in the
2388 * false-negative result. d_lookup() protects against concurrent
2389 * renames using rename_lock seqlock.
2390 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002391 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002392 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 rcu_read_lock();
2394
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002395 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 if (dentry->d_name.hash != hash)
2398 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399
2400 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 if (dentry->d_parent != parent)
2402 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002403 if (d_unhashed(dentry))
2404 goto next;
2405
Al Virod4c91a82016-06-25 23:33:49 -04002406 if (!d_same_name(dentry, parent, name))
2407 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408
Waiman Long98474232013-08-28 18:24:59 -07002409 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002410 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 spin_unlock(&dentry->d_lock);
2412 break;
2413next:
2414 spin_unlock(&dentry->d_lock);
2415 }
2416 rcu_read_unlock();
2417
2418 return found;
2419}
2420
2421/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002422 * d_hash_and_lookup - hash the qstr then search for a dentry
2423 * @dir: Directory to search in
2424 * @name: qstr of name we wish to find
2425 *
Al Viro4f522a22013-02-11 23:20:37 -05002426 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002427 */
2428struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2429{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002430 /*
2431 * Check for a fs-specific hash function. Note that we must
2432 * calculate the standard hash first, as the d_op->d_hash()
2433 * routine may choose to leave the hash value unchanged.
2434 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002435 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002436 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002437 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002438 if (unlikely(err < 0))
2439 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002440 }
Al Viro4f522a22013-02-11 23:20:37 -05002441 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002442}
Al Viro4f522a22013-02-11 23:20:37 -05002443EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002444
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445/*
2446 * When a file is deleted, we have two options:
2447 * - turn this dentry into a negative dentry
2448 * - unhash this dentry and free it.
2449 *
2450 * Usually, we want to just turn this into
2451 * a negative dentry, but if anybody else is
2452 * currently using the dentry or the inode
2453 * we can't do that and we fall back on removing
2454 * it from the hash queues and waiting for
2455 * it to be deleted later when it has no users
2456 */
2457
2458/**
2459 * d_delete - delete a dentry
2460 * @dentry: The dentry to delete
2461 *
2462 * Turn the dentry into a negative dentry if possible, otherwise
2463 * remove it from the hash queues so it can be deleted later
2464 */
2465
2466void d_delete(struct dentry * dentry)
2467{
Al Viroc19457f2018-02-23 21:02:31 -05002468 struct inode *inode = dentry->d_inode;
Al Viroc19457f2018-02-23 21:02:31 -05002469
2470 spin_lock(&inode->i_lock);
2471 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 /*
2473 * Are we the only user?
2474 */
Waiman Long98474232013-08-28 18:24:59 -07002475 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002476 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002477 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002478 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002480 spin_unlock(&dentry->d_lock);
2481 spin_unlock(&inode->i_lock);
2482 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002484EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
Al Viro15d3c582016-07-29 17:45:21 -04002486static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487{
Al Viro15d3c582016-07-29 17:45:21 -04002488 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002489
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002490 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002491 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002492 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493}
2494
2495/**
2496 * d_rehash - add an entry back to the hash
2497 * @entry: dentry to add to the hash
2498 *
2499 * Adds a dentry to the hash according to its name.
2500 */
2501
2502void d_rehash(struct dentry * entry)
2503{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002505 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002508EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509
Al Viro84e710d2016-04-15 00:58:55 -04002510static inline unsigned start_dir_add(struct inode *dir)
2511{
2512
2513 for (;;) {
2514 unsigned n = dir->i_dir_seq;
2515 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2516 return n;
2517 cpu_relax();
2518 }
2519}
2520
2521static inline void end_dir_add(struct inode *dir, unsigned n)
2522{
2523 smp_store_release(&dir->i_dir_seq, n + 2);
2524}
2525
Al Virod9171b92016-04-15 03:33:13 -04002526static void d_wait_lookup(struct dentry *dentry)
2527{
2528 if (d_in_lookup(dentry)) {
2529 DECLARE_WAITQUEUE(wait, current);
2530 add_wait_queue(dentry->d_wait, &wait);
2531 do {
2532 set_current_state(TASK_UNINTERRUPTIBLE);
2533 spin_unlock(&dentry->d_lock);
2534 schedule();
2535 spin_lock(&dentry->d_lock);
2536 } while (d_in_lookup(dentry));
2537 }
2538}
2539
Al Viro94bdd652016-04-15 02:42:04 -04002540struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002541 const struct qstr *name,
2542 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002543{
Al Viro94bdd652016-04-15 02:42:04 -04002544 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002545 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2546 struct hlist_bl_node *node;
2547 struct dentry *new = d_alloc(parent, name);
2548 struct dentry *dentry;
2549 unsigned seq, r_seq, d_seq;
2550
2551 if (unlikely(!new))
2552 return ERR_PTR(-ENOMEM);
2553
2554retry:
2555 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002556 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002557 r_seq = read_seqbegin(&rename_lock);
2558 dentry = __d_lookup_rcu(parent, name, &d_seq);
2559 if (unlikely(dentry)) {
2560 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2561 rcu_read_unlock();
2562 goto retry;
2563 }
2564 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2565 rcu_read_unlock();
2566 dput(dentry);
2567 goto retry;
2568 }
2569 rcu_read_unlock();
2570 dput(new);
2571 return dentry;
2572 }
2573 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2574 rcu_read_unlock();
2575 goto retry;
2576 }
Will Deacon015555f2018-02-19 14:55:54 +00002577
2578 if (unlikely(seq & 1)) {
2579 rcu_read_unlock();
2580 goto retry;
2581 }
2582
Al Viro94bdd652016-04-15 02:42:04 -04002583 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002584 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002585 hlist_bl_unlock(b);
2586 rcu_read_unlock();
2587 goto retry;
2588 }
Al Viro94bdd652016-04-15 02:42:04 -04002589 /*
2590 * No changes for the parent since the beginning of d_lookup().
2591 * Since all removals from the chain happen with hlist_bl_lock(),
2592 * any potential in-lookup matches are going to stay here until
2593 * we unlock the chain. All fields are stable in everything
2594 * we encounter.
2595 */
2596 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2597 if (dentry->d_name.hash != hash)
2598 continue;
2599 if (dentry->d_parent != parent)
2600 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002601 if (!d_same_name(dentry, parent, name))
2602 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002603 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002604 /* now we can try to grab a reference */
2605 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2606 rcu_read_unlock();
2607 goto retry;
2608 }
2609
2610 rcu_read_unlock();
2611 /*
2612 * somebody is likely to be still doing lookup for it;
2613 * wait for them to finish
2614 */
Al Virod9171b92016-04-15 03:33:13 -04002615 spin_lock(&dentry->d_lock);
2616 d_wait_lookup(dentry);
2617 /*
2618 * it's not in-lookup anymore; in principle we should repeat
2619 * everything from dcache lookup, but it's likely to be what
2620 * d_lookup() would've found anyway. If it is, just return it;
2621 * otherwise we really have to repeat the whole thing.
2622 */
2623 if (unlikely(dentry->d_name.hash != hash))
2624 goto mismatch;
2625 if (unlikely(dentry->d_parent != parent))
2626 goto mismatch;
2627 if (unlikely(d_unhashed(dentry)))
2628 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002629 if (unlikely(!d_same_name(dentry, parent, name)))
2630 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002631 /* OK, it *is* a hashed match; return it */
2632 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002633 dput(new);
2634 return dentry;
2635 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002636 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002637 /* we can't take ->d_lock here; it's OK, though. */
2638 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002639 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002640 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2641 hlist_bl_unlock(b);
2642 return new;
Al Virod9171b92016-04-15 03:33:13 -04002643mismatch:
2644 spin_unlock(&dentry->d_lock);
2645 dput(dentry);
2646 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002647}
2648EXPORT_SYMBOL(d_alloc_parallel);
2649
Al Viro85c7f812016-04-14 19:52:13 -04002650void __d_lookup_done(struct dentry *dentry)
2651{
Al Viro94bdd652016-04-15 02:42:04 -04002652 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2653 dentry->d_name.hash);
2654 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002655 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002656 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002657 wake_up_all(dentry->d_wait);
2658 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002659 hlist_bl_unlock(b);
2660 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002661 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002662}
2663EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002664
2665/* inode->i_lock held if inode is non-NULL */
2666
2667static inline void __d_add(struct dentry *dentry, struct inode *inode)
2668{
Al Viro84e710d2016-04-15 00:58:55 -04002669 struct inode *dir = NULL;
2670 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002671 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002672 if (unlikely(d_in_lookup(dentry))) {
2673 dir = dentry->d_parent->d_inode;
2674 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002675 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002676 }
Al Viroed782b52016-03-09 19:52:39 -05002677 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002678 unsigned add_flags = d_flags_for_inode(inode);
2679 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2680 raw_write_seqcount_begin(&dentry->d_seq);
2681 __d_set_inode_and_type(dentry, inode, add_flags);
2682 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002683 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002684 }
Al Viro15d3c582016-07-29 17:45:21 -04002685 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002686 if (dir)
2687 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002688 spin_unlock(&dentry->d_lock);
2689 if (inode)
2690 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002691}
2692
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002693/**
Al Viro34d0d192016-03-08 21:01:03 -05002694 * d_add - add dentry to hash queues
2695 * @entry: dentry to add
2696 * @inode: The inode to attach to this dentry
2697 *
2698 * This adds the entry to the hash queues and initializes @inode.
2699 * The entry was actually filled in earlier during d_alloc().
2700 */
2701
2702void d_add(struct dentry *entry, struct inode *inode)
2703{
Al Virob9680912016-04-11 00:53:26 -04002704 if (inode) {
2705 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002706 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002707 }
Al Viroed782b52016-03-09 19:52:39 -05002708 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002709}
2710EXPORT_SYMBOL(d_add);
2711
2712/**
Al Viro668d0cd2016-03-08 12:44:17 -05002713 * d_exact_alias - find and hash an exact unhashed alias
2714 * @entry: dentry to add
2715 * @inode: The inode to go with this dentry
2716 *
2717 * If an unhashed dentry with the same name/parent and desired
2718 * inode already exists, hash and return it. Otherwise, return
2719 * NULL.
2720 *
2721 * Parent directory should be locked.
2722 */
2723struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2724{
2725 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002726 unsigned int hash = entry->d_name.hash;
2727
2728 spin_lock(&inode->i_lock);
2729 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2730 /*
2731 * Don't need alias->d_lock here, because aliases with
2732 * d_parent == entry->d_parent are not subject to name or
2733 * parent changes, because the parent inode i_mutex is held.
2734 */
2735 if (alias->d_name.hash != hash)
2736 continue;
2737 if (alias->d_parent != entry->d_parent)
2738 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002739 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002740 continue;
2741 spin_lock(&alias->d_lock);
2742 if (!d_unhashed(alias)) {
2743 spin_unlock(&alias->d_lock);
2744 alias = NULL;
2745 } else {
2746 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002747 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002748 spin_unlock(&alias->d_lock);
2749 }
2750 spin_unlock(&inode->i_lock);
2751 return alias;
2752 }
2753 spin_unlock(&inode->i_lock);
2754 return NULL;
2755}
2756EXPORT_SYMBOL(d_exact_alias);
2757
Al Viro8d85b482014-09-29 14:54:27 -04002758static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759{
Al Viro8d85b482014-09-29 14:54:27 -04002760 if (unlikely(dname_external(target))) {
2761 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 /*
2763 * Both external: swap the pointers
2764 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002765 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 } else {
2767 /*
2768 * dentry:internal, target:external. Steal target's
2769 * storage and make target internal.
2770 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002771 memcpy(target->d_iname, dentry->d_name.name,
2772 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 dentry->d_name.name = target->d_name.name;
2774 target->d_name.name = target->d_iname;
2775 }
2776 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002777 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 /*
2779 * dentry:external, target:internal. Give dentry's
2780 * storage to target and make dentry internal
2781 */
2782 memcpy(dentry->d_iname, target->d_name.name,
2783 target->d_name.len + 1);
2784 target->d_name.name = dentry->d_name.name;
2785 dentry->d_name.name = dentry->d_iname;
2786 } else {
2787 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002788 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002790 unsigned int i;
2791 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2792 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2793 swap(((long *) &dentry->d_iname)[i],
2794 ((long *) &target->d_iname)[i]);
2795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 }
2797 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002798 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799}
2800
Al Viro8d85b482014-09-29 14:54:27 -04002801static void copy_name(struct dentry *dentry, struct dentry *target)
2802{
2803 struct external_name *old_name = NULL;
2804 if (unlikely(dname_external(dentry)))
2805 old_name = external_name(dentry);
2806 if (unlikely(dname_external(target))) {
2807 atomic_inc(&external_name(target)->u.count);
2808 dentry->d_name = target->d_name;
2809 } else {
2810 memcpy(dentry->d_iname, target->d_name.name,
2811 target->d_name.len + 1);
2812 dentry->d_name.name = dentry->d_iname;
2813 dentry->d_name.hash_len = target->d_name.hash_len;
2814 }
2815 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07002816 kfree_rcu(old_name, u.head);
Al Viro8d85b482014-09-29 14:54:27 -04002817}
2818
Trond Myklebust9eaef272006-10-21 10:24:20 -07002819/*
Al Viro18367502011-07-12 21:42:24 -04002820 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 * @dentry: entry to move
2822 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002823 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 *
2825 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002826 * dcache entries should not be moved in this way. Caller must hold
2827 * rename_lock, the i_mutex of the source and target directories,
2828 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002830static void __d_move(struct dentry *dentry, struct dentry *target,
2831 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832{
Al Viro42177002018-03-11 15:15:46 -04002833 struct dentry *old_parent, *p;
Al Viro84e710d2016-04-15 00:58:55 -04002834 struct inode *dir = NULL;
2835 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836
Al Viro42177002018-03-11 15:15:46 -04002837 WARN_ON(!dentry->d_inode);
2838 if (WARN_ON(dentry == target))
2839 return;
2840
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002841 BUG_ON(d_ancestor(target, dentry));
Al Viro42177002018-03-11 15:15:46 -04002842 old_parent = dentry->d_parent;
2843 p = d_ancestor(old_parent, target);
2844 if (IS_ROOT(dentry)) {
2845 BUG_ON(p);
2846 spin_lock(&target->d_parent->d_lock);
2847 } else if (!p) {
2848 /* target is not a descendent of dentry->d_parent */
2849 spin_lock(&target->d_parent->d_lock);
2850 spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
2851 } else {
2852 BUG_ON(p == dentry);
2853 spin_lock(&old_parent->d_lock);
2854 if (p != target)
2855 spin_lock_nested(&target->d_parent->d_lock,
2856 DENTRY_D_LOCK_NESTED);
2857 }
2858 spin_lock_nested(&dentry->d_lock, 2);
2859 spin_lock_nested(&target->d_lock, 3);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002860
Al Viro84e710d2016-04-15 00:58:55 -04002861 if (unlikely(d_in_lookup(target))) {
2862 dir = target->d_parent->d_inode;
2863 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002864 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002865 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866
Nick Piggin31e6b012011-01-07 17:49:52 +11002867 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002868 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002869
Al Viro15d3c582016-07-29 17:45:21 -04002870 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002871 if (!d_unhashed(dentry))
2872 ___d_drop(dentry);
2873 if (!d_unhashed(target))
2874 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875
Al Viro63cf4272014-09-26 23:06:14 -04002876 /* ... and switch them in the tree */
Al Viro076515f2018-03-10 23:15:52 -05002877 dentry->d_parent = target->d_parent;
2878 if (!exchange) {
2879 copy_name(dentry, target);
2880 target->d_hash.pprev = NULL;
2881 dentry->d_parent->d_lockref.count++;
Al Viro5467a682019-03-15 22:23:19 -04002882 if (dentry != old_parent) /* wasn't IS_ROOT */
Al Viro076515f2018-03-10 23:15:52 -05002883 WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884 } else {
Al Viro076515f2018-03-10 23:15:52 -05002885 target->d_parent = old_parent;
2886 swap_names(dentry, target);
Al Viro946e51f2014-10-26 19:19:16 -04002887 list_move(&target->d_child, &target->d_parent->d_subdirs);
Al Viro076515f2018-03-10 23:15:52 -05002888 __d_rehash(target);
2889 fsnotify_update_flags(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 }
Al Viro076515f2018-03-10 23:15:52 -05002891 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
2892 __d_rehash(dentry);
2893 fsnotify_update_flags(dentry);
Eric Biggers0bf3d5c12019-03-20 11:39:11 -07002894 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895
Nick Piggin31e6b012011-01-07 17:49:52 +11002896 write_seqcount_end(&target->d_seq);
2897 write_seqcount_end(&dentry->d_seq);
2898
Al Viro84e710d2016-04-15 00:58:55 -04002899 if (dir)
2900 end_dir_add(dir, n);
Al Viro076515f2018-03-10 23:15:52 -05002901
2902 if (dentry->d_parent != old_parent)
2903 spin_unlock(&dentry->d_parent->d_lock);
2904 if (dentry != old_parent)
2905 spin_unlock(&old_parent->d_lock);
2906 spin_unlock(&target->d_lock);
2907 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002908}
2909
2910/*
2911 * d_move - move a dentry
2912 * @dentry: entry to move
2913 * @target: new dentry
2914 *
2915 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002916 * dcache entries should not be moved in this way. See the locking
2917 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002918 */
2919void d_move(struct dentry *dentry, struct dentry *target)
2920{
2921 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002922 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002924}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002925EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926
Miklos Szeredida1ce062014-04-01 17:08:43 +02002927/*
2928 * d_exchange - exchange two dentries
2929 * @dentry1: first dentry
2930 * @dentry2: second dentry
2931 */
2932void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2933{
2934 write_seqlock(&rename_lock);
2935
2936 WARN_ON(!dentry1->d_inode);
2937 WARN_ON(!dentry2->d_inode);
2938 WARN_ON(IS_ROOT(dentry1));
2939 WARN_ON(IS_ROOT(dentry2));
2940
2941 __d_move(dentry1, dentry2, true);
2942
2943 write_sequnlock(&rename_lock);
2944}
2945
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002946/**
2947 * d_ancestor - search for an ancestor
2948 * @p1: ancestor dentry
2949 * @p2: child dentry
2950 *
2951 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2952 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002953 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002954struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002955{
2956 struct dentry *p;
2957
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002958 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002959 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002960 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002961 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002962 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002963}
2964
2965/*
2966 * This helper attempts to cope with remotely renamed directories
2967 *
2968 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002969 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002970 *
2971 * Note: If ever the locking in lock_rename() changes, then please
2972 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002973 */
Al Virob5ae6b12014-10-12 22:16:02 -04002974static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002975 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002976{
Al Viro9902af72016-04-15 15:08:36 -04002977 struct mutex *m1 = NULL;
2978 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002979 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980
2981 /* If alias and dentry share a parent, then no extra locks required */
2982 if (alias->d_parent == dentry->d_parent)
2983 goto out_unalias;
2984
Trond Myklebust9eaef272006-10-21 10:24:20 -07002985 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002986 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2987 goto out_err;
2988 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002989 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002990 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002991 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002992out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002993 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002994 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002995out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002996 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002997 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002998 if (m1)
2999 mutex_unlock(m1);
3000 return ret;
3001}
3002
David Howells770bfad2006-08-22 20:06:07 -04003003/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003004 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3005 * @inode: the inode which may have a disconnected dentry
3006 * @dentry: a negative dentry which we want to point to the inode.
3007 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003008 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3009 * place of the given dentry and return it, else simply d_add the inode
3010 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003011 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003012 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3013 * we should error out: directories can't have multiple aliases.
3014 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003015 * This is needed in the lookup routine of any filesystem that is exportable
3016 * (via knfsd) so that we can build dcache paths to directories effectively.
3017 *
3018 * If a dentry was found and moved, then it is returned. Otherwise NULL
3019 * is returned. This matches the expected return value of ->lookup.
3020 *
3021 * Cluster filesystems may call this function with a negative, hashed dentry.
3022 * In that case, we know that the inode will be a regular file, and also this
3023 * will only occur during atomic_open. So we need to check for the dentry
3024 * being already hashed only in the final case.
3025 */
3026struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3027{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003028 if (IS_ERR(inode))
3029 return ERR_CAST(inode);
3030
David Howells770bfad2006-08-22 20:06:07 -04003031 BUG_ON(!d_unhashed(dentry));
3032
Al Virode689f52016-03-09 18:05:42 -05003033 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003034 goto out;
Al Virode689f52016-03-09 18:05:42 -05003035
Al Virob9680912016-04-11 00:53:26 -04003036 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003037 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003038 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003039 struct dentry *new = __d_find_any_alias(inode);
3040 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003041 /* The reference to new ensures it remains an alias */
3042 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003043 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003044 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003045 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003046 dput(new);
3047 new = ERR_PTR(-ELOOP);
3048 pr_warn_ratelimited(
3049 "VFS: Lookup of '%s' in %s %s"
3050 " would have caused loop\n",
3051 dentry->d_name.name,
3052 inode->i_sb->s_type->name,
3053 inode->i_sb->s_id);
3054 } else if (!IS_ROOT(new)) {
Al Viro076515f2018-03-10 23:15:52 -05003055 struct dentry *old_parent = dget(new->d_parent);
Al Virob5ae6b12014-10-12 22:16:02 -04003056 int err = __d_unalias(inode, dentry, new);
3057 write_sequnlock(&rename_lock);
3058 if (err) {
3059 dput(new);
3060 new = ERR_PTR(err);
3061 }
Al Viro076515f2018-03-10 23:15:52 -05003062 dput(old_parent);
Al Viro18367502011-07-12 21:42:24 -04003063 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003064 __d_move(new, dentry, false);
3065 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003066 }
Al Virob5ae6b12014-10-12 22:16:02 -04003067 iput(inode);
3068 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003069 }
David Howells770bfad2006-08-22 20:06:07 -04003070 }
Al Virob5ae6b12014-10-12 22:16:02 -04003071out:
Al Viroed782b52016-03-09 19:52:39 -05003072 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003073 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003074}
Al Virob5ae6b12014-10-12 22:16:02 -04003075EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003076
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077/*
3078 * Test whether new_dentry is a subdirectory of old_dentry.
3079 *
3080 * Trivially implemented using the dcache structure
3081 */
3082
3083/**
3084 * is_subdir - is new dentry a subdirectory of old_dentry
3085 * @new_dentry: new dentry
3086 * @old_dentry: old dentry
3087 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003088 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3089 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3091 */
3092
Yaowei Baia6e57872015-11-17 14:40:11 +08003093bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094{
Yaowei Baia6e57872015-11-17 14:40:11 +08003095 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003096 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003098 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003099 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003100
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003101 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003104 /*
3105 * Need rcu_readlock to protect against the d_parent trashing
3106 * due to d_move
3107 */
3108 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003109 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003110 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003111 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003112 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003113 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115
3116 return result;
3117}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003118EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003120static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003122 struct dentry *root = data;
3123 if (dentry != root) {
3124 if (d_unhashed(dentry) || !dentry->d_inode)
3125 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003127 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3128 dentry->d_flags |= DCACHE_GENOCIDE;
3129 dentry->d_lockref.count--;
3130 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003132 return D_WALK_CONTINUE;
3133}
Nick Piggin58db63d2011-01-07 17:49:39 +11003134
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003135void d_genocide(struct dentry *parent)
3136{
Al Viro3a8e3612018-04-15 18:27:23 -04003137 d_walk(parent, parent, d_genocide_kill);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138}
3139
Al Virocbd4a5b2018-03-29 15:08:21 -04003140EXPORT_SYMBOL(d_genocide);
3141
Al Viro60545d02013-06-07 01:20:27 -04003142void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143{
Al Viro60545d02013-06-07 01:20:27 -04003144 inode_dec_link_count(inode);
3145 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003146 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003147 !d_unlinked(dentry));
3148 spin_lock(&dentry->d_parent->d_lock);
3149 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3150 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3151 (unsigned long long)inode->i_ino);
3152 spin_unlock(&dentry->d_lock);
3153 spin_unlock(&dentry->d_parent->d_lock);
3154 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155}
Al Viro60545d02013-06-07 01:20:27 -04003156EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
3158static __initdata unsigned long dhash_entries;
3159static int __init set_dhash_entries(char *str)
3160{
3161 if (!str)
3162 return 0;
3163 dhash_entries = simple_strtoul(str, &str, 0);
3164 return 1;
3165}
3166__setup("dhash_entries=", set_dhash_entries);
3167
3168static void __init dcache_init_early(void)
3169{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 /* If hashes are distributed across NUMA nodes, defer
3171 * hash allocation until vmalloc space is available.
3172 */
3173 if (hashdist)
3174 return;
3175
3176 dentry_hashtable =
3177 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003178 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 dhash_entries,
3180 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003181 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003183 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003184 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003186 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187}
3188
Denis Cheng74bf17c2007-10-16 23:26:30 -07003189static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003191 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 * A constructor could be added for stable state like the lists,
3193 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003194 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 */
David Windsor80344262017-06-10 22:50:44 -04003196 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3197 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3198 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
3200 /* Hash may have been set up in dcache_init_early */
3201 if (!hashdist)
3202 return;
3203
3204 dentry_hashtable =
3205 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003206 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207 dhash_entries,
3208 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003209 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003211 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003212 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003214 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215}
3216
3217/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003218struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003219EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221void __init vfs_caches_init_early(void)
3222{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003223 int i;
3224
3225 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3226 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3227
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228 dcache_init_early();
3229 inode_init_early();
3230}
3231
Mel Gorman4248b0d2015-08-06 15:46:20 -07003232void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233{
David Windsor6a9b8822017-06-10 22:50:30 -04003234 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3235 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236
Denis Cheng74bf17c2007-10-16 23:26:30 -07003237 dcache_init();
3238 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003239 files_init();
3240 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003241 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 bdev_cache_init();
3243 chrdev_init();
3244}