blob: 8ede5fa1e32cc60f126039728aa6c2219e2adc6f [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
Joe Perches1f7e0612014-06-06 14:38:05 -0700168int proc_nr_dentry(struct ctl_table *table, int write, void __user *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;
322 WRITE_ONCE(dentry->d_flags, flags);
323}
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 }
Al Viro62d99562018-03-06 21:37:31 -0500650 /* retain; LRU fodder */
651 dentry->d_lockref.count--;
652 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
653 d_lru_add(dentry);
654 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
655 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500656 return true;
657}
658
Linus Torvalds360f5472015-01-09 15:19:03 -0800659/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100660 * Finish off a dentry we've decided to kill.
661 * dentry->d_lock must be held, returns with it unlocked.
662 * Returns dentry requiring refcount drop, or NULL if we're done.
663 */
664static struct dentry *dentry_kill(struct dentry *dentry)
665 __releases(dentry->d_lock)
666{
667 struct inode *inode = dentry->d_inode;
668 struct dentry *parent = NULL;
669
670 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500671 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100672
673 if (!IS_ROOT(dentry)) {
674 parent = dentry->d_parent;
675 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500676 parent = __lock_parent(dentry);
677 if (likely(inode || !dentry->d_inode))
678 goto got_locks;
679 /* negative that became positive */
680 if (parent)
681 spin_unlock(&parent->d_lock);
682 inode = dentry->d_inode;
683 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100684 }
685 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100686 __dentry_kill(dentry);
687 return parent;
688
Al Virof657a662018-02-23 21:25:42 -0500689slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100690 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500691 spin_lock(&inode->i_lock);
692 spin_lock(&dentry->d_lock);
693 parent = lock_parent(dentry);
694got_locks:
695 if (unlikely(dentry->d_lockref.count != 1)) {
696 dentry->d_lockref.count--;
697 } else if (likely(!retain_dentry(dentry))) {
698 __dentry_kill(dentry);
699 return parent;
700 }
701 /* we are keeping it, after all */
702 if (inode)
703 spin_unlock(&inode->i_lock);
704 if (parent)
705 spin_unlock(&parent->d_lock);
706 spin_unlock(&dentry->d_lock);
707 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100708}
709
710/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800711 * Try to do a lockless dput(), and return whether that was successful.
712 *
713 * If unsuccessful, we return false, having already taken the dentry lock.
714 *
715 * The caller needs to hold the RCU read lock, so that the dentry is
716 * guaranteed to stay around even if the refcount goes down to zero!
717 */
718static inline bool fast_dput(struct dentry *dentry)
719{
720 int ret;
721 unsigned int d_flags;
722
723 /*
724 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100725 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800726 */
727 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
728 return lockref_put_or_lock(&dentry->d_lockref);
729
730 /*
731 * .. otherwise, we can try to just decrement the
732 * lockref optimistically.
733 */
734 ret = lockref_put_return(&dentry->d_lockref);
735
736 /*
737 * If the lockref_put_return() failed due to the lock being held
738 * by somebody else, the fast path has failed. We will need to
739 * get the lock, and then check the count again.
740 */
741 if (unlikely(ret < 0)) {
742 spin_lock(&dentry->d_lock);
743 if (dentry->d_lockref.count > 1) {
744 dentry->d_lockref.count--;
745 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500746 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800747 }
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500748 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800749 }
750
751 /*
752 * If we weren't the last ref, we're done.
753 */
754 if (ret)
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500755 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800756
757 /*
758 * Careful, careful. The reference count went down
759 * to zero, but we don't hold the dentry lock, so
760 * somebody else could get it again, and do another
761 * dput(), and we need to not race with that.
762 *
763 * However, there is a very special and common case
764 * where we don't care, because there is nothing to
765 * do: the dentry is still hashed, it does not have
766 * a 'delete' op, and it's referenced and already on
767 * the LRU list.
768 *
769 * NOTE! Since we aren't locked, these values are
770 * not "stable". However, it is sufficient that at
771 * some point after we dropped the reference the
772 * dentry was hashed and the flags had the proper
773 * value. Other dentry users may have re-gotten
774 * a reference to the dentry and change that, but
775 * our work is done - we can leave the dentry
776 * around with a zero refcount.
777 */
778 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700779 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100780 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800781
782 /* Nothing to do? Dropping the reference was all we needed? */
783 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500784 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800785
786 /*
787 * Not the fast normal case? Get the lock. We've already decremented
788 * the refcount, but we'll need to re-check the situation after
789 * getting the lock.
790 */
791 spin_lock(&dentry->d_lock);
792
793 /*
794 * Did somebody else grab a reference to it in the meantime, and
795 * we're no longer the last user after all? Alternatively, somebody
796 * else could have killed it and marked it dead. Either way, we
797 * don't need to do anything else.
798 */
799 if (dentry->d_lockref.count) {
800 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500801 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800802 }
803
804 /*
805 * Re-get the reference we optimistically dropped. We hold the
806 * lock, and we just tested that it was zero, so we can just
807 * set it to 1.
808 */
809 dentry->d_lockref.count = 1;
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500810 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800811}
812
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814/*
815 * This is dput
816 *
817 * This is complicated by the fact that we do not want to put
818 * dentries that are no longer on any hash chain on the unused
819 * list: we'd much rather just get rid of them immediately.
820 *
821 * However, that implies that we have to traverse the dentry
822 * tree upwards to the parents which might _also_ now be
823 * scheduled for deletion (it may have been only waiting for
824 * its last child to go away).
825 *
826 * This tail recursion is done by hand as we don't want to depend
827 * on the compiler to always get this right (gcc generally doesn't).
828 * Real recursion would eat up our stack space.
829 */
830
831/*
832 * dput - release a dentry
833 * @dentry: dentry to release
834 *
835 * Release a dentry. This will drop the usage count and if appropriate
836 * call the dentry unlink method as well as removing it from the queues and
837 * releasing its resources. If the parent dentries were scheduled for release
838 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840void dput(struct dentry *dentry)
841{
Al Viro1088a642018-04-15 18:31:03 -0400842 while (dentry) {
843 might_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Al Viro1088a642018-04-15 18:31:03 -0400845 rcu_read_lock();
846 if (likely(fast_dput(dentry))) {
847 rcu_read_unlock();
848 return;
849 }
Wei Fang47be6182016-07-06 11:32:20 +0800850
Al Viro1088a642018-04-15 18:31:03 -0400851 /* Slow case: now with the dentry lock held */
Linus Torvalds360f5472015-01-09 15:19:03 -0800852 rcu_read_unlock();
Linus Torvalds360f5472015-01-09 15:19:03 -0800853
Al Viro1088a642018-04-15 18:31:03 -0400854 if (likely(retain_dentry(dentry))) {
855 spin_unlock(&dentry->d_lock);
856 return;
857 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Al Viro1088a642018-04-15 18:31:03 -0400859 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700862EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Al Viro9bdebc22019-06-29 18:31:24 -0400864static void __dput_to_list(struct dentry *dentry, struct list_head *list)
865__must_hold(&dentry->d_lock)
866{
867 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
868 /* let the owner of the list it's on deal with it */
869 --dentry->d_lockref.count;
870 } else {
871 if (dentry->d_flags & DCACHE_LRU_LIST)
872 d_lru_del(dentry);
873 if (!--dentry->d_lockref.count)
874 d_shrink_add(dentry, list);
875 }
876}
877
878void dput_to_list(struct dentry *dentry, struct list_head *list)
879{
880 rcu_read_lock();
881 if (likely(fast_dput(dentry))) {
882 rcu_read_unlock();
883 return;
884 }
885 rcu_read_unlock();
886 if (!retain_dentry(dentry))
887 __dput_to_list(dentry, list);
888 spin_unlock(&dentry->d_lock);
889}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100891/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100892static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893{
Waiman Long98474232013-08-28 18:24:59 -0700894 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895}
896
Nick Piggindc0474b2011-01-07 17:49:43 +1100897static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100898{
Waiman Long98474232013-08-28 18:24:59 -0700899 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100900}
901
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100902struct dentry *dget_parent(struct dentry *dentry)
903{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700904 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100905 struct dentry *ret;
906
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700907 /*
908 * Do optimistic parent lookup without any
909 * locking.
910 */
911 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700912 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700913 gotref = lockref_get_not_zero(&ret->d_lockref);
914 rcu_read_unlock();
915 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700916 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700917 return ret;
918 dput(ret);
919 }
920
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100921repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100922 /*
923 * Don't need rcu_dereference because we re-check it was correct under
924 * the lock.
925 */
926 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100927 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100928 spin_lock(&ret->d_lock);
929 if (unlikely(ret != dentry->d_parent)) {
930 spin_unlock(&ret->d_lock);
931 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100932 goto repeat;
933 }
Nick Piggina734eb42011-01-07 17:49:44 +1100934 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700935 BUG_ON(!ret->d_lockref.count);
936 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100937 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100938 return ret;
939}
940EXPORT_SYMBOL(dget_parent);
941
Al Viro61fec492018-04-25 10:52:25 -0400942static struct dentry * __d_find_any_alias(struct inode *inode)
943{
944 struct dentry *alias;
945
946 if (hlist_empty(&inode->i_dentry))
947 return NULL;
948 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
949 __dget(alias);
950 return alias;
951}
952
953/**
954 * d_find_any_alias - find any alias for a given inode
955 * @inode: inode to find an alias for
956 *
957 * If any aliases exist for the given inode, take and return a
958 * reference for one of them. If no aliases exist, return %NULL.
959 */
960struct dentry *d_find_any_alias(struct inode *inode)
961{
962 struct dentry *de;
963
964 spin_lock(&inode->i_lock);
965 de = __d_find_any_alias(inode);
966 spin_unlock(&inode->i_lock);
967 return de;
968}
969EXPORT_SYMBOL(d_find_any_alias);
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971/**
972 * d_find_alias - grab a hashed alias of inode
973 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 *
975 * If inode has a hashed alias, or is a directory and has any alias,
976 * acquire the reference to alias and return it. Otherwise return NULL.
977 * Notice that if inode is a directory there can be only one alias and
978 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800979 * of a filesystem, or if the directory was renamed and d_revalidate
980 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700982 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500983 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500985static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986{
Al Viro61fec492018-04-25 10:52:25 -0400987 struct dentry *alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Al Viro61fec492018-04-25 10:52:25 -0400989 if (S_ISDIR(inode->i_mode))
990 return __d_find_any_alias(inode);
991
Al Viro946e51f2014-10-26 19:19:16 -0400992 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100993 spin_lock(&alias->d_lock);
Al Viro61fec492018-04-25 10:52:25 -0400994 if (!d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500995 __dget_dlock(alias);
996 spin_unlock(&alias->d_lock);
997 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100998 }
999 spin_unlock(&alias->d_lock);
Nick Pigginda502952011-01-07 17:49:33 +11001000 }
1001 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
1003
Nick Pigginda502952011-01-07 17:49:33 +11001004struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005{
David Howells214fda12006-03-25 03:06:36 -08001006 struct dentry *de = NULL;
1007
Al Virob3d9b7a2012-06-09 13:51:19 -04001008 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001009 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001010 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001011 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -08001012 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 return de;
1014}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001015EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017/*
1018 * Try to kill dentries associated with this inode.
1019 * WARNING: you must own a reference to inode.
1020 */
1021void d_prune_aliases(struct inode *inode)
1022{
Domen Puncer0cdca3f2005-09-10 00:27:07 -07001023 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024restart:
Nick Piggin873feea2011-01-07 17:50:06 +11001025 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -04001026 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -07001028 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -04001029 struct dentry *parent = lock_parent(dentry);
1030 if (likely(!dentry->d_lockref.count)) {
1031 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +08001032 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -04001033 goto restart;
1034 }
1035 if (parent)
1036 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 }
1038 spin_unlock(&dentry->d_lock);
1039 }
Nick Piggin873feea2011-01-07 17:50:06 +11001040 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001042EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Al Viro3b3f09f2018-02-23 21:54:18 -05001044/*
1045 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +01001046 * Called under rcu_read_lock() and dentry->d_lock; the former
1047 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -05001048 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +01001049 * d_delete(), etc.
1050 *
Al Viro3b3f09f2018-02-23 21:54:18 -05001051 * Return false if dentry has been disrupted or grabbed, leaving
1052 * the caller to kick it off-list. Otherwise, return true and have
1053 * that dentry's inode and parent both locked.
1054 */
1055static bool shrink_lock_dentry(struct dentry *dentry)
1056{
1057 struct inode *inode;
1058 struct dentry *parent;
1059
1060 if (dentry->d_lockref.count)
1061 return false;
1062
1063 inode = dentry->d_inode;
1064 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001065 spin_unlock(&dentry->d_lock);
1066 spin_lock(&inode->i_lock);
1067 spin_lock(&dentry->d_lock);
1068 if (unlikely(dentry->d_lockref.count))
1069 goto out;
1070 /* changed inode means that somebody had grabbed it */
1071 if (unlikely(inode != dentry->d_inode))
1072 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001073 }
1074
1075 parent = dentry->d_parent;
1076 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1077 return true;
1078
Al Viro3b3f09f2018-02-23 21:54:18 -05001079 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001080 spin_lock(&parent->d_lock);
1081 if (unlikely(parent != dentry->d_parent)) {
1082 spin_unlock(&parent->d_lock);
1083 spin_lock(&dentry->d_lock);
1084 goto out;
1085 }
1086 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001087 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001088 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001089 spin_unlock(&parent->d_lock);
1090out:
1091 if (inode)
1092 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001093 return false;
1094}
1095
Al Viro9bdebc22019-06-29 18:31:24 -04001096void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001098 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001099 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001100
Miklos Szeredi60942f22014-05-02 15:38:39 -04001101 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001102 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001103 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001104 if (!shrink_lock_dentry(dentry)) {
1105 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001106 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001107 d_shrink_del(dentry);
1108 if (dentry->d_lockref.count < 0)
1109 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001110 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001111 if (can_free)
1112 dentry_free(dentry);
1113 continue;
1114 }
John Ogness8f04da22018-02-23 00:50:24 +01001115 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001116 d_shrink_del(dentry);
1117 parent = dentry->d_parent;
Al Viro9bdebc22019-06-29 18:31:24 -04001118 if (parent != dentry)
1119 __dput_to_list(parent, list);
Al Viroff2fde92014-05-28 13:59:13 -04001120 __dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001122}
1123
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001124static enum lru_status dentry_lru_isolate(struct list_head *item,
1125 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001126{
1127 struct list_head *freeable = arg;
1128 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1129
1130
1131 /*
1132 * we are inverting the lru lock/dentry->d_lock here,
1133 * so use a trylock. If we fail to get the lock, just skip
1134 * it
1135 */
1136 if (!spin_trylock(&dentry->d_lock))
1137 return LRU_SKIP;
1138
1139 /*
1140 * Referenced dentries are still in use. If they have active
1141 * counts, just remove them from the LRU. Otherwise give them
1142 * another pass through the LRU.
1143 */
1144 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001145 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001146 spin_unlock(&dentry->d_lock);
1147 return LRU_REMOVED;
1148 }
1149
1150 if (dentry->d_flags & DCACHE_REFERENCED) {
1151 dentry->d_flags &= ~DCACHE_REFERENCED;
1152 spin_unlock(&dentry->d_lock);
1153
1154 /*
1155 * The list move itself will be made by the common LRU code. At
1156 * this point, we've dropped the dentry->d_lock but keep the
1157 * lru lock. This is safe to do, since every list movement is
1158 * protected by the lru lock even if both locks are held.
1159 *
1160 * This is guaranteed by the fact that all LRU management
1161 * functions are intermediated by the LRU API calls like
1162 * list_lru_add and list_lru_del. List movement in this file
1163 * only ever occur through this functions or through callbacks
1164 * like this one, that are called from the LRU API.
1165 *
1166 * The only exceptions to this are functions like
1167 * shrink_dentry_list, and code that first checks for the
1168 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1169 * operating only with stack provided lists after they are
1170 * properly isolated from the main list. It is thus, always a
1171 * local access.
1172 */
1173 return LRU_ROTATE;
1174 }
1175
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001176 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001177 spin_unlock(&dentry->d_lock);
1178
1179 return LRU_REMOVED;
1180}
1181
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001182/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001183 * prune_dcache_sb - shrink the dcache
1184 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001185 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001186 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001187 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1188 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001189 * function.
1190 *
1191 * This function may fail to free any resources if all the dentries are in
1192 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001193 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001194long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001195{
Dave Chinnerf6041562013-08-28 10:18:00 +10001196 LIST_HEAD(dispose);
1197 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001198
Vladimir Davydov503c3582015-02-12 14:58:47 -08001199 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1200 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001201 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001202 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
1204
Glauber Costa4e717f52013-08-28 10:18:03 +10001205static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001206 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001207{
Glauber Costa4e717f52013-08-28 10:18:03 +10001208 struct list_head *freeable = arg;
1209 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001210
Glauber Costa4e717f52013-08-28 10:18:03 +10001211 /*
1212 * we are inverting the lru lock/dentry->d_lock here,
1213 * so use a trylock. If we fail to get the lock, just skip
1214 * it
1215 */
1216 if (!spin_trylock(&dentry->d_lock))
1217 return LRU_SKIP;
1218
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001219 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001220 spin_unlock(&dentry->d_lock);
1221
1222 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001223}
1224
Glauber Costa4e717f52013-08-28 10:18:03 +10001225
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001226/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 * shrink_dcache_sb - shrink dcache for a superblock
1228 * @sb: superblock
1229 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001230 * Shrink the dcache for the specified super block. This is used to free
1231 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001233void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234{
Glauber Costa4e717f52013-08-28 10:18:03 +10001235 do {
1236 LIST_HEAD(dispose);
1237
Waiman Long1dbd4492019-01-30 13:52:36 -05001238 list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001239 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001240 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001241 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001243EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001246 * enum d_walk_ret - action to talke during tree walk
1247 * @D_WALK_CONTINUE: contrinue walk
1248 * @D_WALK_QUIT: quit walk
1249 * @D_WALK_NORETRY: quit when retry is needed
1250 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001252enum d_walk_ret {
1253 D_WALK_CONTINUE,
1254 D_WALK_QUIT,
1255 D_WALK_NORETRY,
1256 D_WALK_SKIP,
1257};
1258
1259/**
1260 * d_walk - walk the dentry tree
1261 * @parent: start of walk
1262 * @data: data passed to @enter() and @finish()
1263 * @enter: callback when first entering the dentry
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001264 *
Al Viro3a8e3612018-04-15 18:27:23 -04001265 * The @enter() callbacks are called with d_lock held.
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001266 */
1267static void d_walk(struct dentry *parent, void *data,
Al Viro3a8e3612018-04-15 18:27:23 -04001268 enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269{
Nick Piggin949854d2011-01-07 17:49:37 +11001270 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001272 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001273 enum d_walk_ret ret;
1274 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001275
Nick Piggin58db63d2011-01-07 17:49:39 +11001276again:
Al Viro48f5ec22013-09-09 15:22:25 -04001277 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001278 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001279 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001280
1281 ret = enter(data, this_parent);
1282 switch (ret) {
1283 case D_WALK_CONTINUE:
1284 break;
1285 case D_WALK_QUIT:
1286 case D_WALK_SKIP:
1287 goto out_unlock;
1288 case D_WALK_NORETRY:
1289 retry = false;
1290 break;
1291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292repeat:
1293 next = this_parent->d_subdirs.next;
1294resume:
1295 while (next != &this_parent->d_subdirs) {
1296 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001297 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001299
Al Viroba65dc52016-06-10 11:32:47 -04001300 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1301 continue;
1302
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001303 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001304
1305 ret = enter(data, dentry);
1306 switch (ret) {
1307 case D_WALK_CONTINUE:
1308 break;
1309 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001310 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001311 goto out_unlock;
1312 case D_WALK_NORETRY:
1313 retry = false;
1314 break;
1315 case D_WALK_SKIP:
1316 spin_unlock(&dentry->d_lock);
1317 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001318 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001321 spin_unlock(&this_parent->d_lock);
1322 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001324 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 goto repeat;
1326 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001327 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 }
1329 /*
1330 * All done at this level ... ascend and resume the search.
1331 */
Al Viroca5358e2014-10-26 19:31:10 -04001332 rcu_read_lock();
1333ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001335 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001336 this_parent = child->d_parent;
1337
Al Viro31dec132013-10-25 17:04:27 -04001338 spin_unlock(&child->d_lock);
1339 spin_lock(&this_parent->d_lock);
1340
Al Viroca5358e2014-10-26 19:31:10 -04001341 /* might go back up the wrong parent if we have had a rename. */
1342 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001343 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001344 /* go into the first sibling still alive */
1345 do {
1346 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001347 if (next == &this_parent->d_subdirs)
1348 goto ascend;
1349 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001350 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001351 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 goto resume;
1353 }
Al Viroca5358e2014-10-26 19:31:10 -04001354 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001355 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001356 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001357
1358out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001359 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001360 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001361 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001362
1363rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001364 spin_unlock(&this_parent->d_lock);
1365 rcu_read_unlock();
1366 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001367 if (!retry)
1368 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001369 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001370 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001372
Ian Kent01619492016-11-24 08:03:41 +11001373struct check_mount {
1374 struct vfsmount *mnt;
1375 unsigned int mounted;
1376};
1377
1378static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1379{
1380 struct check_mount *info = data;
1381 struct path path = { .mnt = info->mnt, .dentry = dentry };
1382
1383 if (likely(!d_mountpoint(dentry)))
1384 return D_WALK_CONTINUE;
1385 if (__path_is_mountpoint(&path)) {
1386 info->mounted = 1;
1387 return D_WALK_QUIT;
1388 }
1389 return D_WALK_CONTINUE;
1390}
1391
1392/**
1393 * path_has_submounts - check for mounts over a dentry in the
1394 * current namespace.
1395 * @parent: path to check.
1396 *
1397 * Return true if the parent or its subdirectories contain
1398 * a mount point in the current namespace.
1399 */
1400int path_has_submounts(const struct path *parent)
1401{
1402 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1403
1404 read_seqlock_excl(&mount_lock);
Al Viro3a8e3612018-04-15 18:27:23 -04001405 d_walk(parent->dentry, &data, path_check_mount);
Ian Kent01619492016-11-24 08:03:41 +11001406 read_sequnlock_excl(&mount_lock);
1407
1408 return data.mounted;
1409}
1410EXPORT_SYMBOL(path_has_submounts);
1411
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001413 * Called by mount code to set a mountpoint and check if the mountpoint is
1414 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1415 * subtree can become unreachable).
1416 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001417 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001418 * this reason take rename_lock and d_lock on dentry and ancestors.
1419 */
1420int d_set_mounted(struct dentry *dentry)
1421{
1422 struct dentry *p;
1423 int ret = -ENOENT;
1424 write_seqlock(&rename_lock);
1425 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001426 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001427 spin_lock(&p->d_lock);
1428 if (unlikely(d_unhashed(p))) {
1429 spin_unlock(&p->d_lock);
1430 goto out;
1431 }
1432 spin_unlock(&p->d_lock);
1433 }
1434 spin_lock(&dentry->d_lock);
1435 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001436 ret = -EBUSY;
1437 if (!d_mountpoint(dentry)) {
1438 dentry->d_flags |= DCACHE_MOUNTED;
1439 ret = 0;
1440 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001441 }
1442 spin_unlock(&dentry->d_lock);
1443out:
1444 write_sequnlock(&rename_lock);
1445 return ret;
1446}
1447
1448/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001449 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * and move any unused dentries to the end of the unused
1451 * list for prune_dcache(). We descend to the next level
1452 * whenever the d_subdirs list is non-empty and continue
1453 * searching.
1454 *
1455 * It returns zero iff there are no unused children,
1456 * otherwise it returns the number of children moved to
1457 * the end of the unused list. This may not be the total
1458 * number of unused children, because select_parent can
1459 * drop the lock and return early due to latency
1460 * constraints.
1461 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001462
1463struct select_data {
1464 struct dentry *start;
Al Viro9bdebc22019-06-29 18:31:24 -04001465 union {
1466 long found;
1467 struct dentry *victim;
1468 };
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001469 struct list_head dispose;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001470};
1471
1472static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001474 struct select_data *data = _data;
1475 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001477 if (data->start == dentry)
1478 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Al Virofe915222014-05-03 00:02:25 -04001480 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001481 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001482 } else {
1483 if (dentry->d_flags & DCACHE_LRU_LIST)
1484 d_lru_del(dentry);
1485 if (!dentry->d_lockref.count) {
1486 d_shrink_add(dentry, &data->dispose);
1487 data->found++;
1488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 }
1490 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001491 * We can return to the caller if we have found some (this
1492 * ensures forward progress). We'll be coming back to find
1493 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 */
Al Virofe915222014-05-03 00:02:25 -04001495 if (!list_empty(&data->dispose))
1496 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001498 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
1500
Al Viro9bdebc22019-06-29 18:31:24 -04001501static enum d_walk_ret select_collect2(void *_data, struct dentry *dentry)
1502{
1503 struct select_data *data = _data;
1504 enum d_walk_ret ret = D_WALK_CONTINUE;
1505
1506 if (data->start == dentry)
1507 goto out;
1508
1509 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
1510 if (!dentry->d_lockref.count) {
1511 rcu_read_lock();
1512 data->victim = dentry;
1513 return D_WALK_QUIT;
1514 }
1515 } else {
1516 if (dentry->d_flags & DCACHE_LRU_LIST)
1517 d_lru_del(dentry);
1518 if (!dentry->d_lockref.count)
1519 d_shrink_add(dentry, &data->dispose);
1520 }
1521 /*
1522 * We can return to the caller if we have found some (this
1523 * ensures forward progress). We'll be coming back to find
1524 * the rest.
1525 */
1526 if (!list_empty(&data->dispose))
1527 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
1528out:
1529 return ret;
1530}
1531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532/**
1533 * shrink_dcache_parent - prune dcache
1534 * @parent: parent of entries to prune
1535 *
1536 * Prune the dcache to remove unused children of the parent dentry.
1537 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001538void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001540 for (;;) {
Al Viro9bdebc22019-06-29 18:31:24 -04001541 struct select_data data = {.start = parent};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001543 INIT_LIST_HEAD(&data.dispose);
Al Viro3a8e3612018-04-15 18:27:23 -04001544 d_walk(parent, &data, select_collect);
Al Viro4fb48872018-04-19 23:58:48 -04001545
1546 if (!list_empty(&data.dispose)) {
1547 shrink_dentry_list(&data.dispose);
1548 continue;
1549 }
1550
1551 cond_resched();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001552 if (!data.found)
1553 break;
Al Viro9bdebc22019-06-29 18:31:24 -04001554 data.victim = NULL;
1555 d_walk(parent, &data, select_collect2);
1556 if (data.victim) {
1557 struct dentry *parent;
1558 spin_lock(&data.victim->d_lock);
1559 if (!shrink_lock_dentry(data.victim)) {
1560 spin_unlock(&data.victim->d_lock);
1561 rcu_read_unlock();
1562 } else {
1563 rcu_read_unlock();
1564 parent = data.victim->d_parent;
1565 if (parent != data.victim)
1566 __dput_to_list(parent, &data.dispose);
1567 __dentry_kill(data.victim);
1568 }
1569 }
1570 if (!list_empty(&data.dispose))
1571 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001574EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Al Viro9c8c10e2014-05-02 20:36:10 -04001576static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001577{
Al Viro9c8c10e2014-05-02 20:36:10 -04001578 /* it has busy descendents; complain about those instead */
1579 if (!list_empty(&dentry->d_subdirs))
1580 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001581
Al Viro9c8c10e2014-05-02 20:36:10 -04001582 /* root with refcount 1 is fine */
1583 if (dentry == _data && dentry->d_lockref.count == 1)
1584 return D_WALK_CONTINUE;
1585
1586 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1587 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001588 dentry,
1589 dentry->d_inode ?
1590 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001591 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001592 dentry->d_lockref.count,
1593 dentry->d_sb->s_type->name,
1594 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001595 WARN_ON(1);
1596 return D_WALK_CONTINUE;
1597}
1598
1599static void do_one_tree(struct dentry *dentry)
1600{
1601 shrink_dcache_parent(dentry);
Al Viro3a8e3612018-04-15 18:27:23 -04001602 d_walk(dentry, dentry, umount_check);
Al Viro9c8c10e2014-05-02 20:36:10 -04001603 d_drop(dentry);
1604 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001605}
1606
1607/*
1608 * destroy the dentries attached to a superblock on unmounting
1609 */
1610void shrink_dcache_for_umount(struct super_block *sb)
1611{
1612 struct dentry *dentry;
1613
Al Viro9c8c10e2014-05-02 20:36:10 -04001614 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001615
1616 dentry = sb->s_root;
1617 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001618 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001619
NeilBrownf1ee6162017-12-21 09:45:40 +11001620 while (!hlist_bl_empty(&sb->s_roots)) {
1621 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001622 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001623 }
1624}
1625
Al Viroff17fa52018-04-15 18:21:47 -04001626static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001627{
Al Viroff17fa52018-04-15 18:21:47 -04001628 struct dentry **victim = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001629 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001630 __dget_dlock(dentry);
Al Viroff17fa52018-04-15 18:21:47 -04001631 *victim = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001632 return D_WALK_QUIT;
1633 }
Al Viroff17fa52018-04-15 18:21:47 -04001634 return D_WALK_CONTINUE;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001635}
1636
1637/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001638 * d_invalidate - detach submounts, prune dcache, and drop
1639 * @dentry: dentry to invalidate (aka detach, prune and drop)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001640 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001641void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001642{
Al Viroff17fa52018-04-15 18:21:47 -04001643 bool had_submounts = false;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001644 spin_lock(&dentry->d_lock);
1645 if (d_unhashed(dentry)) {
1646 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001647 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001648 }
Al Viroff17fa52018-04-15 18:21:47 -04001649 __d_drop(dentry);
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001650 spin_unlock(&dentry->d_lock);
1651
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001652 /* Negative dentries can be dropped without further checks */
Al Viroff17fa52018-04-15 18:21:47 -04001653 if (!dentry->d_inode)
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001654 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001655
Al Viroff17fa52018-04-15 18:21:47 -04001656 shrink_dcache_parent(dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001657 for (;;) {
Al Viroff17fa52018-04-15 18:21:47 -04001658 struct dentry *victim = NULL;
Al Viro3a8e3612018-04-15 18:27:23 -04001659 d_walk(dentry, &victim, find_submount);
Al Viroff17fa52018-04-15 18:21:47 -04001660 if (!victim) {
1661 if (had_submounts)
1662 shrink_dcache_parent(dentry);
Al Viro81be24d2017-06-03 07:20:09 +01001663 return;
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001664 }
Al Viroff17fa52018-04-15 18:21:47 -04001665 had_submounts = true;
1666 detach_mounts(victim);
1667 dput(victim);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001668 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001669}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001670EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001671
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672/**
Al Viroa4464db2011-07-07 15:03:58 -04001673 * __d_alloc - allocate a dcache entry
1674 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 * @name: qstr of the name
1676 *
1677 * Allocates a dentry. It returns %NULL if there is insufficient memory
1678 * available. On a success the dentry is returned. The name passed in is
1679 * copied and the copy passed in may be reused after this call.
1680 */
1681
Al Viro5c8b0df2019-10-25 14:08:24 -04001682static struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683{
1684 struct dentry *dentry;
1685 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001686 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
Mel Gormane12ba742007-10-16 01:25:52 -07001688 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 if (!dentry)
1690 return NULL;
1691
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001692 /*
1693 * We guarantee that the inline name is always NUL-terminated.
1694 * This way the memcpy() done by the name switching in rename
1695 * will still always have a NUL at the end, even if we might
1696 * be overwriting an internal NUL character
1697 */
1698 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001699 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001700 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001701 dname = dentry->d_iname;
1702 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001703 size_t size = offsetof(struct external_name, name[1]);
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001704 struct external_name *p = kmalloc(size + name->len,
1705 GFP_KERNEL_ACCOUNT |
1706 __GFP_RECLAIMABLE);
1707 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 kmem_cache_free(dentry_cache, dentry);
1709 return NULL;
1710 }
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001711 atomic_set(&p->u.count, 1);
1712 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 } else {
1714 dname = dentry->d_iname;
1715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
1717 dentry->d_name.len = name->len;
1718 dentry->d_name.hash = name->hash;
1719 memcpy(dname, name->name, name->len);
1720 dname[name->len] = 0;
1721
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001722 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001723 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001724
Waiman Long98474232013-08-28 18:24:59 -07001725 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001726 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001728 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001730 dentry->d_parent = dentry;
1731 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 dentry->d_op = NULL;
1733 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001734 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 INIT_LIST_HEAD(&dentry->d_lru);
1736 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001737 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1738 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001739 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740
Miklos Szeredi285b1022016-06-28 11:47:32 +02001741 if (dentry->d_op && dentry->d_op->d_init) {
1742 err = dentry->d_op->d_init(dentry);
1743 if (err) {
1744 if (dname_external(dentry))
1745 kfree(external_name(dentry));
1746 kmem_cache_free(dentry_cache, dentry);
1747 return NULL;
1748 }
1749 }
1750
Nick Piggin3e880fb2011-01-07 17:49:19 +11001751 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001752
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 return dentry;
1754}
Al Viroa4464db2011-07-07 15:03:58 -04001755
1756/**
1757 * d_alloc - allocate a dcache entry
1758 * @parent: parent of entry to allocate
1759 * @name: qstr of the name
1760 *
1761 * Allocates a dentry. It returns %NULL if there is insufficient memory
1762 * available. On a success the dentry is returned. The name passed in is
1763 * copied and the copy passed in may be reused after this call.
1764 */
1765struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1766{
1767 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1768 if (!dentry)
1769 return NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001770 spin_lock(&parent->d_lock);
1771 /*
1772 * don't need child lock because it is not subject
1773 * to concurrency here
1774 */
1775 __dget_dlock(parent);
1776 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001777 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001778 spin_unlock(&parent->d_lock);
1779
1780 return dentry;
1781}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001782EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Miklos Szeredif9c34672018-01-19 11:39:52 +01001784struct dentry *d_alloc_anon(struct super_block *sb)
1785{
1786 return __d_alloc(sb, NULL);
1787}
1788EXPORT_SYMBOL(d_alloc_anon);
1789
Al Viroba65dc52016-06-10 11:32:47 -04001790struct dentry *d_alloc_cursor(struct dentry * parent)
1791{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001792 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001793 if (dentry) {
Al Viro5467a682019-03-15 22:23:19 -04001794 dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viroba65dc52016-06-10 11:32:47 -04001795 dentry->d_parent = dget(parent);
1796 }
1797 return dentry;
1798}
1799
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001800/**
1801 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1802 * @sb: the superblock
1803 * @name: qstr of the name
1804 *
1805 * For a filesystem that just pins its dentries in memory and never
1806 * performs lookups at all, return an unhashed IS_ROOT dentry.
Al Viro5467a682019-03-15 22:23:19 -04001807 * This is used for pipes, sockets et.al. - the stuff that should
1808 * never be anyone's children or parents. Unlike all other
1809 * dentries, these will not have RCU delay between dropping the
1810 * last reference and freeing them.
Al Viroab1152d2019-03-15 22:58:11 -04001811 *
1812 * The only user is alloc_file_pseudo() and that's what should
1813 * be considered a public interface. Don't use directly.
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001814 */
Nick Piggin4b936882011-01-07 17:50:07 +11001815struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1816{
Al Viro5467a682019-03-15 22:23:19 -04001817 struct dentry *dentry = __d_alloc(sb, name);
1818 if (likely(dentry))
1819 dentry->d_flags |= DCACHE_NORCU;
1820 return dentry;
Nick Piggin4b936882011-01-07 17:50:07 +11001821}
Nick Piggin4b936882011-01-07 17:50:07 +11001822
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1824{
1825 struct qstr q;
1826
1827 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001828 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 return d_alloc(parent, &q);
1830}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001831EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
Nick Pigginfb045ad2011-01-07 17:49:55 +11001833void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1834{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001835 WARN_ON_ONCE(dentry->d_op);
1836 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001837 DCACHE_OP_COMPARE |
1838 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001839 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001840 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001841 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001842 dentry->d_op = op;
1843 if (!op)
1844 return;
1845 if (op->d_hash)
1846 dentry->d_flags |= DCACHE_OP_HASH;
1847 if (op->d_compare)
1848 dentry->d_flags |= DCACHE_OP_COMPARE;
1849 if (op->d_revalidate)
1850 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001851 if (op->d_weak_revalidate)
1852 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001853 if (op->d_delete)
1854 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001855 if (op->d_prune)
1856 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001857 if (op->d_real)
1858 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001859
1860}
1861EXPORT_SYMBOL(d_set_d_op);
1862
David Howellsdf1a0852015-01-29 12:02:28 +00001863
1864/*
1865 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1866 * @dentry - The dentry to mark
1867 *
1868 * Mark a dentry as falling through to the lower layer (as set with
1869 * d_pin_lower()). This flag may be recorded on the medium.
1870 */
1871void d_set_fallthru(struct dentry *dentry)
1872{
1873 spin_lock(&dentry->d_lock);
1874 dentry->d_flags |= DCACHE_FALLTHRU;
1875 spin_unlock(&dentry->d_lock);
1876}
1877EXPORT_SYMBOL(d_set_fallthru);
1878
David Howellsb18825a2013-09-12 19:22:53 +01001879static unsigned d_flags_for_inode(struct inode *inode)
1880{
David Howells44bdb5e2015-01-29 12:02:29 +00001881 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001882
1883 if (!inode)
1884 return DCACHE_MISS_TYPE;
1885
1886 if (S_ISDIR(inode->i_mode)) {
1887 add_flags = DCACHE_DIRECTORY_TYPE;
1888 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1889 if (unlikely(!inode->i_op->lookup))
1890 add_flags = DCACHE_AUTODIR_TYPE;
1891 else
1892 inode->i_opflags |= IOP_LOOKUP;
1893 }
David Howells44bdb5e2015-01-29 12:02:29 +00001894 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001895 }
1896
David Howells44bdb5e2015-01-29 12:02:29 +00001897 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001898 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001899 add_flags = DCACHE_SYMLINK_TYPE;
1900 goto type_determined;
1901 }
1902 inode->i_opflags |= IOP_NOFOLLOW;
1903 }
1904
1905 if (unlikely(!S_ISREG(inode->i_mode)))
1906 add_flags = DCACHE_SPECIAL_TYPE;
1907
1908type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001909 if (unlikely(IS_AUTOMOUNT(inode)))
1910 add_flags |= DCACHE_NEED_AUTOMOUNT;
1911 return add_flags;
1912}
1913
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001914static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1915{
David Howellsb18825a2013-09-12 19:22:53 +01001916 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001917 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001918
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001919 spin_lock(&dentry->d_lock);
Waiman Longaf0c9af2019-01-30 13:52:38 -05001920 /*
1921 * Decrement negative dentry count if it was in the LRU list.
1922 */
1923 if (dentry->d_flags & DCACHE_LRU_LIST)
1924 this_cpu_dec(nr_dentry_negative);
Al Virode689f52016-03-09 18:05:42 -05001925 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001926 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001927 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001928 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001929 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001930 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001931}
1932
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933/**
1934 * d_instantiate - fill in inode information for a dentry
1935 * @entry: dentry to complete
1936 * @inode: inode to attach to this dentry
1937 *
1938 * Fill in inode information in the entry.
1939 *
1940 * This turns negative dentries into productive full members
1941 * of society.
1942 *
1943 * NOTE! This assumes that the inode count has been incremented
1944 * (or otherwise set) by the caller to indicate that it is now
1945 * in use by the dcache.
1946 */
1947
1948void d_instantiate(struct dentry *entry, struct inode * inode)
1949{
Al Viro946e51f2014-10-26 19:19:16 -04001950 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001951 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001952 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001953 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001954 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001955 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001958EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
Al Viro1e2e5472018-05-04 08:23:01 -04001960/*
1961 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1962 * with lockdep-related part of unlock_new_inode() done before
1963 * anything else. Use that instead of open-coding d_instantiate()/
1964 * unlock_new_inode() combinations.
1965 */
1966void d_instantiate_new(struct dentry *entry, struct inode *inode)
1967{
1968 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1969 BUG_ON(!inode);
1970 lockdep_annotate_inode_mutex_key(inode);
1971 security_d_instantiate(entry, inode);
1972 spin_lock(&inode->i_lock);
1973 __d_instantiate(entry, inode);
1974 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001975 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro1e2e5472018-05-04 08:23:01 -04001976 smp_mb();
1977 wake_up_bit(&inode->i_state, __I_NEW);
1978 spin_unlock(&inode->i_lock);
1979}
1980EXPORT_SYMBOL(d_instantiate_new);
1981
Al Viroadc0e91a2012-01-08 16:49:21 -05001982struct dentry *d_make_root(struct inode *root_inode)
1983{
1984 struct dentry *res = NULL;
1985
1986 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001987 res = d_alloc_anon(root_inode->i_sb);
Al Viro5467a682019-03-15 22:23:19 -04001988 if (res)
Al Viroadc0e91a2012-01-08 16:49:21 -05001989 d_instantiate(res, root_inode);
Al Viro5467a682019-03-15 22:23:19 -04001990 else
Al Viroadc0e91a2012-01-08 16:49:21 -05001991 iput(root_inode);
1992 }
1993 return res;
1994}
1995EXPORT_SYMBOL(d_make_root);
1996
Miklos Szeredif9c34672018-01-19 11:39:52 +01001997static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1998 struct inode *inode,
1999 bool disconnected)
2000{
2001 struct dentry *res;
2002 unsigned add_flags;
2003
2004 security_d_instantiate(dentry, inode);
2005 spin_lock(&inode->i_lock);
2006 res = __d_find_any_alias(inode);
2007 if (res) {
2008 spin_unlock(&inode->i_lock);
2009 dput(dentry);
2010 goto out_iput;
2011 }
2012
2013 /* attach a disconnected dentry */
2014 add_flags = d_flags_for_inode(inode);
2015
2016 if (disconnected)
2017 add_flags |= DCACHE_DISCONNECTED;
2018
2019 spin_lock(&dentry->d_lock);
2020 __d_set_inode_and_type(dentry, inode, add_flags);
2021 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08002022 if (!disconnected) {
2023 hlist_bl_lock(&dentry->d_sb->s_roots);
2024 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
2025 hlist_bl_unlock(&dentry->d_sb->s_roots);
2026 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01002027 spin_unlock(&dentry->d_lock);
2028 spin_unlock(&inode->i_lock);
2029
2030 return dentry;
2031
2032 out_iput:
2033 iput(inode);
2034 return res;
2035}
2036
2037struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2038{
2039 return __d_instantiate_anon(dentry, inode, true);
2040}
2041EXPORT_SYMBOL(d_instantiate_anon);
2042
2043static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002044{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002045 struct dentry *tmp;
2046 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002047
2048 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002049 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002050 if (IS_ERR(inode))
2051 return ERR_CAST(inode);
2052
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002053 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002054 if (res)
2055 goto out_iput;
2056
Miklos Szeredif9c34672018-01-19 11:39:52 +01002057 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002058 if (!tmp) {
2059 res = ERR_PTR(-ENOMEM);
2060 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002061 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002062
Miklos Szeredif9c34672018-01-19 11:39:52 +01002063 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002064
Miklos Szeredif9c34672018-01-19 11:39:52 +01002065out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002066 iput(inode);
2067 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002068}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002069
2070/**
2071 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2072 * @inode: inode to allocate the dentry for
2073 *
2074 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2075 * similar open by handle operations. The returned dentry may be anonymous,
2076 * or may have a full name (if the inode was already in the cache).
2077 *
2078 * When called on a directory inode, we must ensure that the inode only ever
2079 * has one dentry. If a dentry is found, that is returned instead of
2080 * allocating a new one.
2081 *
2082 * On successful return, the reference to the inode has been transferred
2083 * to the dentry. In case of an error the reference on the inode is released.
2084 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2085 * be passed in and the error will be propagated to the return value,
2086 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2087 */
2088struct dentry *d_obtain_alias(struct inode *inode)
2089{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002090 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002091}
Benny Halevyadc48722009-02-27 14:02:59 -08002092EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
2094/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002095 * d_obtain_root - find or allocate a dentry for a given inode
2096 * @inode: inode to allocate the dentry for
2097 *
2098 * Obtain an IS_ROOT dentry for the root of a filesystem.
2099 *
2100 * We must ensure that directory inodes only ever have one dentry. If a
2101 * dentry is found, that is returned instead of allocating a new one.
2102 *
2103 * On successful return, the reference to the inode has been transferred
2104 * to the dentry. In case of an error the reference on the inode is
2105 * released. A %NULL or IS_ERR inode may be passed in and will be the
2106 * error will be propagate to the return value, with a %NULL @inode
2107 * replaced by ERR_PTR(-ESTALE).
2108 */
2109struct dentry *d_obtain_root(struct inode *inode)
2110{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002111 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002112}
2113EXPORT_SYMBOL(d_obtain_root);
2114
2115/**
Barry Naujok94035402008-05-21 16:50:46 +10002116 * d_add_ci - lookup or allocate new dentry with case-exact name
2117 * @inode: the inode case-insensitive lookup has found
2118 * @dentry: the negative dentry that was passed to the parent's lookup func
2119 * @name: the case-exact name to be associated with the returned dentry
2120 *
2121 * This is to avoid filling the dcache with case-insensitive names to the
2122 * same inode, only the actual correct case is stored in the dcache for
2123 * case-insensitive filesystems.
2124 *
2125 * For a case-insensitive lookup match and if the the case-exact dentry
2126 * already exists in in the dcache, use it and return it.
2127 *
2128 * If no entry exists with the exact case name, allocate new dentry with
2129 * the exact case, and return the spliced entry.
2130 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002131struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002132 struct qstr *name)
2133{
Al Virod9171b92016-04-15 03:33:13 -04002134 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002135
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002136 /*
2137 * First check if a dentry matching the name already exists,
2138 * if not go ahead and create it now.
2139 */
Barry Naujok94035402008-05-21 16:50:46 +10002140 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002141 if (found) {
2142 iput(inode);
2143 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002144 }
Al Virod9171b92016-04-15 03:33:13 -04002145 if (d_in_lookup(dentry)) {
2146 found = d_alloc_parallel(dentry->d_parent, name,
2147 dentry->d_wait);
2148 if (IS_ERR(found) || !d_in_lookup(found)) {
2149 iput(inode);
2150 return found;
2151 }
2152 } else {
2153 found = d_alloc(dentry->d_parent, name);
2154 if (!found) {
2155 iput(inode);
2156 return ERR_PTR(-ENOMEM);
2157 }
2158 }
2159 res = d_splice_alias(inode, found);
2160 if (res) {
2161 dput(found);
2162 return res;
2163 }
Al Viro4f522a22013-02-11 23:20:37 -05002164 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002165}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002166EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002168
Al Virod4c91a82016-06-25 23:33:49 -04002169static inline bool d_same_name(const struct dentry *dentry,
2170 const struct dentry *parent,
2171 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002172{
Al Virod4c91a82016-06-25 23:33:49 -04002173 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2174 if (dentry->d_name.len != name->len)
2175 return false;
2176 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002177 }
Al Viro6fa67e72016-07-31 16:37:25 -04002178 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002179 dentry->d_name.len, dentry->d_name.name,
2180 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002181}
2182
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002184 * __d_lookup_rcu - search for a dentry (racy, store-free)
2185 * @parent: parent dentry
2186 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002187 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002188 * Returns: dentry, or NULL
2189 *
2190 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2191 * resolution (store-free path walking) design described in
2192 * Documentation/filesystems/path-lookup.txt.
2193 *
2194 * This is not to be used outside core vfs.
2195 *
2196 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2197 * held, and rcu_read_lock held. The returned dentry must not be stored into
2198 * without taking d_lock and checking d_seq sequence count against @seq
2199 * returned here.
2200 *
Linus Torvalds15570082013-09-02 11:38:06 -07002201 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002202 * function.
2203 *
2204 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2205 * the returned dentry, so long as its parent's seqlock is checked after the
2206 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2207 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002208 *
2209 * NOTE! The caller *has* to check the resulting dentry against the sequence
2210 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002211 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002212struct dentry *__d_lookup_rcu(const struct dentry *parent,
2213 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002214 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002215{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002216 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002217 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002218 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002219 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002220 struct dentry *dentry;
2221
2222 /*
2223 * Note: There is significant duplication with __d_lookup_rcu which is
2224 * required to prevent single threaded performance regressions
2225 * especially on architectures where smp_rmb (in seqcounts) are costly.
2226 * Keep the two functions in sync.
2227 */
2228
2229 /*
2230 * The hash list is protected using RCU.
2231 *
2232 * Carefully use d_seq when comparing a candidate dentry, to avoid
2233 * races with d_move().
2234 *
2235 * It is possible that concurrent renames can mess up our list
2236 * walk here and result in missing our dentry, resulting in the
2237 * false-negative result. d_lookup() protects against concurrent
2238 * renames using rename_lock seqlock.
2239 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002240 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002241 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002242 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002243 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002244
Nick Piggin31e6b012011-01-07 17:49:52 +11002245seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002246 /*
2247 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002248 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002249 *
2250 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002251 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002252 *
2253 * NOTE! We do a "raw" seqcount_begin here. That means that
2254 * we don't wait for the sequence count to stabilize if it
2255 * is in the middle of a sequence change. If we do the slow
2256 * dentry compare, we will do seqretries until it is stable,
2257 * and if we end up with a successful lookup, we actually
2258 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002259 *
2260 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2261 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002262 */
2263 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002264 if (dentry->d_parent != parent)
2265 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002266 if (d_unhashed(dentry))
2267 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002268
2269 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002270 int tlen;
2271 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002272 if (dentry->d_name.hash != hashlen_hash(hashlen))
2273 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002274 tlen = dentry->d_name.len;
2275 tname = dentry->d_name.name;
2276 /* we want a consistent (name,len) pair */
2277 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2278 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002279 goto seqretry;
2280 }
Al Viro6fa67e72016-07-31 16:37:25 -04002281 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002282 tlen, tname, name) != 0)
2283 continue;
2284 } else {
2285 if (dentry->d_name.hash_len != hashlen)
2286 continue;
2287 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2288 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002289 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002290 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002291 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002292 }
2293 return NULL;
2294}
2295
2296/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 * d_lookup - search for a dentry
2298 * @parent: parent dentry
2299 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002300 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002302 * d_lookup searches the children of the parent dentry for the name in
2303 * question. If the dentry is found its reference count is incremented and the
2304 * dentry is returned. The caller must use dput to free the entry when it has
2305 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 */
Al Viroda2d8452013-01-24 18:29:34 -05002307struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308{
Nick Piggin31e6b012011-01-07 17:49:52 +11002309 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002310 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311
Daeseok Younb8314f92014-08-11 11:46:53 +09002312 do {
2313 seq = read_seqbegin(&rename_lock);
2314 dentry = __d_lookup(parent, name);
2315 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 break;
2317 } while (read_seqretry(&rename_lock, seq));
2318 return dentry;
2319}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002320EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321
Nick Piggin31e6b012011-01-07 17:49:52 +11002322/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002323 * __d_lookup - search for a dentry (racy)
2324 * @parent: parent dentry
2325 * @name: qstr of name we wish to find
2326 * Returns: dentry, or NULL
2327 *
2328 * __d_lookup is like d_lookup, however it may (rarely) return a
2329 * false-negative result due to unrelated rename activity.
2330 *
2331 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2332 * however it must be used carefully, eg. with a following d_lookup in
2333 * the case of failure.
2334 *
2335 * __d_lookup callers must be commented.
2336 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002337struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002340 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002341 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002342 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002343 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344
Nick Pigginb04f7842010-08-18 04:37:34 +10002345 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002346 * Note: There is significant duplication with __d_lookup_rcu which is
2347 * required to prevent single threaded performance regressions
2348 * especially on architectures where smp_rmb (in seqcounts) are costly.
2349 * Keep the two functions in sync.
2350 */
2351
2352 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002353 * The hash list is protected using RCU.
2354 *
2355 * Take d_lock when comparing a candidate dentry, to avoid races
2356 * with d_move().
2357 *
2358 * It is possible that concurrent renames can mess up our list
2359 * walk here and result in missing our dentry, resulting in the
2360 * false-negative result. d_lookup() protects against concurrent
2361 * renames using rename_lock seqlock.
2362 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002363 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002364 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 rcu_read_lock();
2366
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002367 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 if (dentry->d_name.hash != hash)
2370 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371
2372 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 if (dentry->d_parent != parent)
2374 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002375 if (d_unhashed(dentry))
2376 goto next;
2377
Al Virod4c91a82016-06-25 23:33:49 -04002378 if (!d_same_name(dentry, parent, name))
2379 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380
Waiman Long98474232013-08-28 18:24:59 -07002381 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002382 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 spin_unlock(&dentry->d_lock);
2384 break;
2385next:
2386 spin_unlock(&dentry->d_lock);
2387 }
2388 rcu_read_unlock();
2389
2390 return found;
2391}
2392
2393/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002394 * d_hash_and_lookup - hash the qstr then search for a dentry
2395 * @dir: Directory to search in
2396 * @name: qstr of name we wish to find
2397 *
Al Viro4f522a22013-02-11 23:20:37 -05002398 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002399 */
2400struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2401{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002402 /*
2403 * Check for a fs-specific hash function. Note that we must
2404 * calculate the standard hash first, as the d_op->d_hash()
2405 * routine may choose to leave the hash value unchanged.
2406 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002407 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002408 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002409 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002410 if (unlikely(err < 0))
2411 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002412 }
Al Viro4f522a22013-02-11 23:20:37 -05002413 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002414}
Al Viro4f522a22013-02-11 23:20:37 -05002415EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002416
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417/*
2418 * When a file is deleted, we have two options:
2419 * - turn this dentry into a negative dentry
2420 * - unhash this dentry and free it.
2421 *
2422 * Usually, we want to just turn this into
2423 * a negative dentry, but if anybody else is
2424 * currently using the dentry or the inode
2425 * we can't do that and we fall back on removing
2426 * it from the hash queues and waiting for
2427 * it to be deleted later when it has no users
2428 */
2429
2430/**
2431 * d_delete - delete a dentry
2432 * @dentry: The dentry to delete
2433 *
2434 * Turn the dentry into a negative dentry if possible, otherwise
2435 * remove it from the hash queues so it can be deleted later
2436 */
2437
2438void d_delete(struct dentry * dentry)
2439{
Al Viroc19457f2018-02-23 21:02:31 -05002440 struct inode *inode = dentry->d_inode;
Al Viroc19457f2018-02-23 21:02:31 -05002441
2442 spin_lock(&inode->i_lock);
2443 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 /*
2445 * Are we the only user?
2446 */
Waiman Long98474232013-08-28 18:24:59 -07002447 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002448 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002449 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002450 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002452 spin_unlock(&dentry->d_lock);
2453 spin_unlock(&inode->i_lock);
2454 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002456EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457
Al Viro15d3c582016-07-29 17:45:21 -04002458static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
Al Viro15d3c582016-07-29 17:45:21 -04002460 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002461
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002462 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002463 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002464 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465}
2466
2467/**
2468 * d_rehash - add an entry back to the hash
2469 * @entry: dentry to add to the hash
2470 *
2471 * Adds a dentry to the hash according to its name.
2472 */
2473
2474void d_rehash(struct dentry * entry)
2475{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002477 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002480EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
Al Viro84e710d2016-04-15 00:58:55 -04002482static inline unsigned start_dir_add(struct inode *dir)
2483{
2484
2485 for (;;) {
2486 unsigned n = dir->i_dir_seq;
2487 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2488 return n;
2489 cpu_relax();
2490 }
2491}
2492
2493static inline void end_dir_add(struct inode *dir, unsigned n)
2494{
2495 smp_store_release(&dir->i_dir_seq, n + 2);
2496}
2497
Al Virod9171b92016-04-15 03:33:13 -04002498static void d_wait_lookup(struct dentry *dentry)
2499{
2500 if (d_in_lookup(dentry)) {
2501 DECLARE_WAITQUEUE(wait, current);
2502 add_wait_queue(dentry->d_wait, &wait);
2503 do {
2504 set_current_state(TASK_UNINTERRUPTIBLE);
2505 spin_unlock(&dentry->d_lock);
2506 schedule();
2507 spin_lock(&dentry->d_lock);
2508 } while (d_in_lookup(dentry));
2509 }
2510}
2511
Al Viro94bdd652016-04-15 02:42:04 -04002512struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002513 const struct qstr *name,
2514 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002515{
Al Viro94bdd652016-04-15 02:42:04 -04002516 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002517 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2518 struct hlist_bl_node *node;
2519 struct dentry *new = d_alloc(parent, name);
2520 struct dentry *dentry;
2521 unsigned seq, r_seq, d_seq;
2522
2523 if (unlikely(!new))
2524 return ERR_PTR(-ENOMEM);
2525
2526retry:
2527 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002528 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002529 r_seq = read_seqbegin(&rename_lock);
2530 dentry = __d_lookup_rcu(parent, name, &d_seq);
2531 if (unlikely(dentry)) {
2532 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2533 rcu_read_unlock();
2534 goto retry;
2535 }
2536 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2537 rcu_read_unlock();
2538 dput(dentry);
2539 goto retry;
2540 }
2541 rcu_read_unlock();
2542 dput(new);
2543 return dentry;
2544 }
2545 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2546 rcu_read_unlock();
2547 goto retry;
2548 }
Will Deacon015555f2018-02-19 14:55:54 +00002549
2550 if (unlikely(seq & 1)) {
2551 rcu_read_unlock();
2552 goto retry;
2553 }
2554
Al Viro94bdd652016-04-15 02:42:04 -04002555 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002556 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002557 hlist_bl_unlock(b);
2558 rcu_read_unlock();
2559 goto retry;
2560 }
Al Viro94bdd652016-04-15 02:42:04 -04002561 /*
2562 * No changes for the parent since the beginning of d_lookup().
2563 * Since all removals from the chain happen with hlist_bl_lock(),
2564 * any potential in-lookup matches are going to stay here until
2565 * we unlock the chain. All fields are stable in everything
2566 * we encounter.
2567 */
2568 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2569 if (dentry->d_name.hash != hash)
2570 continue;
2571 if (dentry->d_parent != parent)
2572 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002573 if (!d_same_name(dentry, parent, name))
2574 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002575 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002576 /* now we can try to grab a reference */
2577 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2578 rcu_read_unlock();
2579 goto retry;
2580 }
2581
2582 rcu_read_unlock();
2583 /*
2584 * somebody is likely to be still doing lookup for it;
2585 * wait for them to finish
2586 */
Al Virod9171b92016-04-15 03:33:13 -04002587 spin_lock(&dentry->d_lock);
2588 d_wait_lookup(dentry);
2589 /*
2590 * it's not in-lookup anymore; in principle we should repeat
2591 * everything from dcache lookup, but it's likely to be what
2592 * d_lookup() would've found anyway. If it is, just return it;
2593 * otherwise we really have to repeat the whole thing.
2594 */
2595 if (unlikely(dentry->d_name.hash != hash))
2596 goto mismatch;
2597 if (unlikely(dentry->d_parent != parent))
2598 goto mismatch;
2599 if (unlikely(d_unhashed(dentry)))
2600 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002601 if (unlikely(!d_same_name(dentry, parent, name)))
2602 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002603 /* OK, it *is* a hashed match; return it */
2604 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002605 dput(new);
2606 return dentry;
2607 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002608 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002609 /* we can't take ->d_lock here; it's OK, though. */
2610 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002611 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002612 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2613 hlist_bl_unlock(b);
2614 return new;
Al Virod9171b92016-04-15 03:33:13 -04002615mismatch:
2616 spin_unlock(&dentry->d_lock);
2617 dput(dentry);
2618 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002619}
2620EXPORT_SYMBOL(d_alloc_parallel);
2621
Al Viro85c7f812016-04-14 19:52:13 -04002622void __d_lookup_done(struct dentry *dentry)
2623{
Al Viro94bdd652016-04-15 02:42:04 -04002624 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2625 dentry->d_name.hash);
2626 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002627 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002628 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002629 wake_up_all(dentry->d_wait);
2630 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002631 hlist_bl_unlock(b);
2632 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002633 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002634}
2635EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002636
2637/* inode->i_lock held if inode is non-NULL */
2638
2639static inline void __d_add(struct dentry *dentry, struct inode *inode)
2640{
Al Viro84e710d2016-04-15 00:58:55 -04002641 struct inode *dir = NULL;
2642 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002643 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002644 if (unlikely(d_in_lookup(dentry))) {
2645 dir = dentry->d_parent->d_inode;
2646 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002647 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002648 }
Al Viroed782b52016-03-09 19:52:39 -05002649 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002650 unsigned add_flags = d_flags_for_inode(inode);
2651 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2652 raw_write_seqcount_begin(&dentry->d_seq);
2653 __d_set_inode_and_type(dentry, inode, add_flags);
2654 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002655 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002656 }
Al Viro15d3c582016-07-29 17:45:21 -04002657 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002658 if (dir)
2659 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002660 spin_unlock(&dentry->d_lock);
2661 if (inode)
2662 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002663}
2664
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002665/**
Al Viro34d0d192016-03-08 21:01:03 -05002666 * d_add - add dentry to hash queues
2667 * @entry: dentry to add
2668 * @inode: The inode to attach to this dentry
2669 *
2670 * This adds the entry to the hash queues and initializes @inode.
2671 * The entry was actually filled in earlier during d_alloc().
2672 */
2673
2674void d_add(struct dentry *entry, struct inode *inode)
2675{
Al Virob9680912016-04-11 00:53:26 -04002676 if (inode) {
2677 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002678 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002679 }
Al Viroed782b52016-03-09 19:52:39 -05002680 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002681}
2682EXPORT_SYMBOL(d_add);
2683
2684/**
Al Viro668d0cd2016-03-08 12:44:17 -05002685 * d_exact_alias - find and hash an exact unhashed alias
2686 * @entry: dentry to add
2687 * @inode: The inode to go with this dentry
2688 *
2689 * If an unhashed dentry with the same name/parent and desired
2690 * inode already exists, hash and return it. Otherwise, return
2691 * NULL.
2692 *
2693 * Parent directory should be locked.
2694 */
2695struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2696{
2697 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002698 unsigned int hash = entry->d_name.hash;
2699
2700 spin_lock(&inode->i_lock);
2701 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2702 /*
2703 * Don't need alias->d_lock here, because aliases with
2704 * d_parent == entry->d_parent are not subject to name or
2705 * parent changes, because the parent inode i_mutex is held.
2706 */
2707 if (alias->d_name.hash != hash)
2708 continue;
2709 if (alias->d_parent != entry->d_parent)
2710 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002711 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002712 continue;
2713 spin_lock(&alias->d_lock);
2714 if (!d_unhashed(alias)) {
2715 spin_unlock(&alias->d_lock);
2716 alias = NULL;
2717 } else {
2718 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002719 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002720 spin_unlock(&alias->d_lock);
2721 }
2722 spin_unlock(&inode->i_lock);
2723 return alias;
2724 }
2725 spin_unlock(&inode->i_lock);
2726 return NULL;
2727}
2728EXPORT_SYMBOL(d_exact_alias);
2729
Al Viro8d85b482014-09-29 14:54:27 -04002730static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731{
Al Viro8d85b482014-09-29 14:54:27 -04002732 if (unlikely(dname_external(target))) {
2733 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 /*
2735 * Both external: swap the pointers
2736 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002737 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 } else {
2739 /*
2740 * dentry:internal, target:external. Steal target's
2741 * storage and make target internal.
2742 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002743 memcpy(target->d_iname, dentry->d_name.name,
2744 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 dentry->d_name.name = target->d_name.name;
2746 target->d_name.name = target->d_iname;
2747 }
2748 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002749 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 /*
2751 * dentry:external, target:internal. Give dentry's
2752 * storage to target and make dentry internal
2753 */
2754 memcpy(dentry->d_iname, target->d_name.name,
2755 target->d_name.len + 1);
2756 target->d_name.name = dentry->d_name.name;
2757 dentry->d_name.name = dentry->d_iname;
2758 } else {
2759 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002760 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002762 unsigned int i;
2763 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2764 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2765 swap(((long *) &dentry->d_iname)[i],
2766 ((long *) &target->d_iname)[i]);
2767 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 }
2769 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002770 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771}
2772
Al Viro8d85b482014-09-29 14:54:27 -04002773static void copy_name(struct dentry *dentry, struct dentry *target)
2774{
2775 struct external_name *old_name = NULL;
2776 if (unlikely(dname_external(dentry)))
2777 old_name = external_name(dentry);
2778 if (unlikely(dname_external(target))) {
2779 atomic_inc(&external_name(target)->u.count);
2780 dentry->d_name = target->d_name;
2781 } else {
2782 memcpy(dentry->d_iname, target->d_name.name,
2783 target->d_name.len + 1);
2784 dentry->d_name.name = dentry->d_iname;
2785 dentry->d_name.hash_len = target->d_name.hash_len;
2786 }
2787 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07002788 kfree_rcu(old_name, u.head);
Al Viro8d85b482014-09-29 14:54:27 -04002789}
2790
Trond Myklebust9eaef272006-10-21 10:24:20 -07002791/*
Al Viro18367502011-07-12 21:42:24 -04002792 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 * @dentry: entry to move
2794 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002795 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 *
2797 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002798 * dcache entries should not be moved in this way. Caller must hold
2799 * rename_lock, the i_mutex of the source and target directories,
2800 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002802static void __d_move(struct dentry *dentry, struct dentry *target,
2803 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804{
Al Viro42177002018-03-11 15:15:46 -04002805 struct dentry *old_parent, *p;
Al Viro84e710d2016-04-15 00:58:55 -04002806 struct inode *dir = NULL;
2807 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808
Al Viro42177002018-03-11 15:15:46 -04002809 WARN_ON(!dentry->d_inode);
2810 if (WARN_ON(dentry == target))
2811 return;
2812
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002813 BUG_ON(d_ancestor(target, dentry));
Al Viro42177002018-03-11 15:15:46 -04002814 old_parent = dentry->d_parent;
2815 p = d_ancestor(old_parent, target);
2816 if (IS_ROOT(dentry)) {
2817 BUG_ON(p);
2818 spin_lock(&target->d_parent->d_lock);
2819 } else if (!p) {
2820 /* target is not a descendent of dentry->d_parent */
2821 spin_lock(&target->d_parent->d_lock);
2822 spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
2823 } else {
2824 BUG_ON(p == dentry);
2825 spin_lock(&old_parent->d_lock);
2826 if (p != target)
2827 spin_lock_nested(&target->d_parent->d_lock,
2828 DENTRY_D_LOCK_NESTED);
2829 }
2830 spin_lock_nested(&dentry->d_lock, 2);
2831 spin_lock_nested(&target->d_lock, 3);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002832
Al Viro84e710d2016-04-15 00:58:55 -04002833 if (unlikely(d_in_lookup(target))) {
2834 dir = target->d_parent->d_inode;
2835 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002836 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002837 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838
Nick Piggin31e6b012011-01-07 17:49:52 +11002839 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002840 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002841
Al Viro15d3c582016-07-29 17:45:21 -04002842 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002843 if (!d_unhashed(dentry))
2844 ___d_drop(dentry);
2845 if (!d_unhashed(target))
2846 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847
Al Viro63cf4272014-09-26 23:06:14 -04002848 /* ... and switch them in the tree */
Al Viro076515f2018-03-10 23:15:52 -05002849 dentry->d_parent = target->d_parent;
2850 if (!exchange) {
2851 copy_name(dentry, target);
2852 target->d_hash.pprev = NULL;
2853 dentry->d_parent->d_lockref.count++;
Al Viro5467a682019-03-15 22:23:19 -04002854 if (dentry != old_parent) /* wasn't IS_ROOT */
Al Viro076515f2018-03-10 23:15:52 -05002855 WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 } else {
Al Viro076515f2018-03-10 23:15:52 -05002857 target->d_parent = old_parent;
2858 swap_names(dentry, target);
Al Viro946e51f2014-10-26 19:19:16 -04002859 list_move(&target->d_child, &target->d_parent->d_subdirs);
Al Viro076515f2018-03-10 23:15:52 -05002860 __d_rehash(target);
2861 fsnotify_update_flags(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862 }
Al Viro076515f2018-03-10 23:15:52 -05002863 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
2864 __d_rehash(dentry);
2865 fsnotify_update_flags(dentry);
Eric Biggers0bf3d5c12019-03-20 11:39:11 -07002866 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867
Nick Piggin31e6b012011-01-07 17:49:52 +11002868 write_seqcount_end(&target->d_seq);
2869 write_seqcount_end(&dentry->d_seq);
2870
Al Viro84e710d2016-04-15 00:58:55 -04002871 if (dir)
2872 end_dir_add(dir, n);
Al Viro076515f2018-03-10 23:15:52 -05002873
2874 if (dentry->d_parent != old_parent)
2875 spin_unlock(&dentry->d_parent->d_lock);
2876 if (dentry != old_parent)
2877 spin_unlock(&old_parent->d_lock);
2878 spin_unlock(&target->d_lock);
2879 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002880}
2881
2882/*
2883 * d_move - move a dentry
2884 * @dentry: entry to move
2885 * @target: new dentry
2886 *
2887 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002888 * dcache entries should not be moved in this way. See the locking
2889 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002890 */
2891void d_move(struct dentry *dentry, struct dentry *target)
2892{
2893 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002894 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002896}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002897EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898
Miklos Szeredida1ce062014-04-01 17:08:43 +02002899/*
2900 * d_exchange - exchange two dentries
2901 * @dentry1: first dentry
2902 * @dentry2: second dentry
2903 */
2904void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2905{
2906 write_seqlock(&rename_lock);
2907
2908 WARN_ON(!dentry1->d_inode);
2909 WARN_ON(!dentry2->d_inode);
2910 WARN_ON(IS_ROOT(dentry1));
2911 WARN_ON(IS_ROOT(dentry2));
2912
2913 __d_move(dentry1, dentry2, true);
2914
2915 write_sequnlock(&rename_lock);
2916}
2917
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002918/**
2919 * d_ancestor - search for an ancestor
2920 * @p1: ancestor dentry
2921 * @p2: child dentry
2922 *
2923 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2924 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002925 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002926struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002927{
2928 struct dentry *p;
2929
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002930 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002931 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002932 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002933 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002934 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002935}
2936
2937/*
2938 * This helper attempts to cope with remotely renamed directories
2939 *
2940 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002941 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002942 *
2943 * Note: If ever the locking in lock_rename() changes, then please
2944 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002945 */
Al Virob5ae6b12014-10-12 22:16:02 -04002946static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002947 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002948{
Al Viro9902af72016-04-15 15:08:36 -04002949 struct mutex *m1 = NULL;
2950 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002951 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002952
2953 /* If alias and dentry share a parent, then no extra locks required */
2954 if (alias->d_parent == dentry->d_parent)
2955 goto out_unalias;
2956
Trond Myklebust9eaef272006-10-21 10:24:20 -07002957 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2959 goto out_err;
2960 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002961 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002962 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002963 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002964out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002965 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002966 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002967out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002968 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002969 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002970 if (m1)
2971 mutex_unlock(m1);
2972 return ret;
2973}
2974
David Howells770bfad2006-08-22 20:06:07 -04002975/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002976 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2977 * @inode: the inode which may have a disconnected dentry
2978 * @dentry: a negative dentry which we want to point to the inode.
2979 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002980 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2981 * place of the given dentry and return it, else simply d_add the inode
2982 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002983 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002984 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2985 * we should error out: directories can't have multiple aliases.
2986 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002987 * This is needed in the lookup routine of any filesystem that is exportable
2988 * (via knfsd) so that we can build dcache paths to directories effectively.
2989 *
2990 * If a dentry was found and moved, then it is returned. Otherwise NULL
2991 * is returned. This matches the expected return value of ->lookup.
2992 *
2993 * Cluster filesystems may call this function with a negative, hashed dentry.
2994 * In that case, we know that the inode will be a regular file, and also this
2995 * will only occur during atomic_open. So we need to check for the dentry
2996 * being already hashed only in the final case.
2997 */
2998struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2999{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003000 if (IS_ERR(inode))
3001 return ERR_CAST(inode);
3002
David Howells770bfad2006-08-22 20:06:07 -04003003 BUG_ON(!d_unhashed(dentry));
3004
Al Virode689f52016-03-09 18:05:42 -05003005 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003006 goto out;
Al Virode689f52016-03-09 18:05:42 -05003007
Al Virob9680912016-04-11 00:53:26 -04003008 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003009 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003010 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003011 struct dentry *new = __d_find_any_alias(inode);
3012 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003013 /* The reference to new ensures it remains an alias */
3014 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003015 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003016 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003017 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003018 dput(new);
3019 new = ERR_PTR(-ELOOP);
3020 pr_warn_ratelimited(
3021 "VFS: Lookup of '%s' in %s %s"
3022 " would have caused loop\n",
3023 dentry->d_name.name,
3024 inode->i_sb->s_type->name,
3025 inode->i_sb->s_id);
3026 } else if (!IS_ROOT(new)) {
Al Viro076515f2018-03-10 23:15:52 -05003027 struct dentry *old_parent = dget(new->d_parent);
Al Virob5ae6b12014-10-12 22:16:02 -04003028 int err = __d_unalias(inode, dentry, new);
3029 write_sequnlock(&rename_lock);
3030 if (err) {
3031 dput(new);
3032 new = ERR_PTR(err);
3033 }
Al Viro076515f2018-03-10 23:15:52 -05003034 dput(old_parent);
Al Viro18367502011-07-12 21:42:24 -04003035 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003036 __d_move(new, dentry, false);
3037 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003038 }
Al Virob5ae6b12014-10-12 22:16:02 -04003039 iput(inode);
3040 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003041 }
David Howells770bfad2006-08-22 20:06:07 -04003042 }
Al Virob5ae6b12014-10-12 22:16:02 -04003043out:
Al Viroed782b52016-03-09 19:52:39 -05003044 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003045 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003046}
Al Virob5ae6b12014-10-12 22:16:02 -04003047EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003048
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049/*
3050 * Test whether new_dentry is a subdirectory of old_dentry.
3051 *
3052 * Trivially implemented using the dcache structure
3053 */
3054
3055/**
3056 * is_subdir - is new dentry a subdirectory of old_dentry
3057 * @new_dentry: new dentry
3058 * @old_dentry: old dentry
3059 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003060 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3061 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3063 */
3064
Yaowei Baia6e57872015-11-17 14:40:11 +08003065bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066{
Yaowei Baia6e57872015-11-17 14:40:11 +08003067 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003068 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003070 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003071 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003072
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003073 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003076 /*
3077 * Need rcu_readlock to protect against the d_parent trashing
3078 * due to d_move
3079 */
3080 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003081 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003082 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003083 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003084 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003085 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087
3088 return result;
3089}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003090EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003092static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003094 struct dentry *root = data;
3095 if (dentry != root) {
3096 if (d_unhashed(dentry) || !dentry->d_inode)
3097 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003098
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003099 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3100 dentry->d_flags |= DCACHE_GENOCIDE;
3101 dentry->d_lockref.count--;
3102 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003104 return D_WALK_CONTINUE;
3105}
Nick Piggin58db63d2011-01-07 17:49:39 +11003106
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003107void d_genocide(struct dentry *parent)
3108{
Al Viro3a8e3612018-04-15 18:27:23 -04003109 d_walk(parent, parent, d_genocide_kill);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003110}
3111
Al Virocbd4a5b2018-03-29 15:08:21 -04003112EXPORT_SYMBOL(d_genocide);
3113
Al Viro60545d02013-06-07 01:20:27 -04003114void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115{
Al Viro60545d02013-06-07 01:20:27 -04003116 inode_dec_link_count(inode);
3117 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003118 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003119 !d_unlinked(dentry));
3120 spin_lock(&dentry->d_parent->d_lock);
3121 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3122 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3123 (unsigned long long)inode->i_ino);
3124 spin_unlock(&dentry->d_lock);
3125 spin_unlock(&dentry->d_parent->d_lock);
3126 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127}
Al Viro60545d02013-06-07 01:20:27 -04003128EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003129
3130static __initdata unsigned long dhash_entries;
3131static int __init set_dhash_entries(char *str)
3132{
3133 if (!str)
3134 return 0;
3135 dhash_entries = simple_strtoul(str, &str, 0);
3136 return 1;
3137}
3138__setup("dhash_entries=", set_dhash_entries);
3139
3140static void __init dcache_init_early(void)
3141{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142 /* If hashes are distributed across NUMA nodes, defer
3143 * hash allocation until vmalloc space is available.
3144 */
3145 if (hashdist)
3146 return;
3147
3148 dentry_hashtable =
3149 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003150 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151 dhash_entries,
3152 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003153 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003155 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003156 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003158 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159}
3160
Denis Cheng74bf17c2007-10-16 23:26:30 -07003161static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003163 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164 * A constructor could be added for stable state like the lists,
3165 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003166 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167 */
David Windsor80344262017-06-10 22:50:44 -04003168 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3169 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3170 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171
3172 /* Hash may have been set up in dcache_init_early */
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_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
3189/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003190struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003191EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193void __init vfs_caches_init_early(void)
3194{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003195 int i;
3196
3197 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3198 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3199
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 dcache_init_early();
3201 inode_init_early();
3202}
3203
Mel Gorman4248b0d2015-08-06 15:46:20 -07003204void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205{
David Windsor6a9b8822017-06-10 22:50:30 -04003206 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3207 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208
Denis Cheng74bf17c2007-10-16 23:26:30 -07003209 dcache_init();
3210 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003211 files_init();
3212 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003213 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214 bdev_cache_init();
3215 chrdev_init();
3216}