blob: cf871a81f4fdcc5501463c3c3a35e4aac3c03eec [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);
Al Viro80e5d1ff52021-04-15 19:46:50 -040087const struct qstr dotdot_name = QSTR_INIT("..", 2);
88EXPORT_SYMBOL(dotdot_name);
David Howellscdf01222017-07-04 17:25:22 +010089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/*
91 * This is the single most critical data structure when it comes
92 * to the dcache: the hashtable for lookups. Somebody should try
93 * to make this good - I've just made it work.
94 *
95 * This hash-function tries to avoid losing too many bits of hash
96 * information, yet avoid using a prime hash-size or similar.
97 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Eric Dumazetfa3536c2006-03-26 01:37:24 -080099static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100100
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700101static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102
Linus Torvalds8387ff22016-06-10 07:51:30 -0700103static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300105 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106}
107
Al Viro94bdd652016-04-15 02:42:04 -0400108#define IN_LOOKUP_SHIFT 10
109static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
110
111static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
112 unsigned int hash)
113{
114 hash += (unsigned long) parent / L1_CACHE_BYTES;
115 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
116}
117
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119/* Statistics gathering. */
120struct dentry_stat_t dentry_stat = {
121 .age_limit = 45,
122};
123
Glauber Costa3942c072013-08-28 10:17:53 +1000124static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000125static DEFINE_PER_CPU(long, nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500126static DEFINE_PER_CPU(long, nr_dentry_negative);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400127
128#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000129
130/*
131 * Here we resort to our own counters instead of using generic per-cpu counters
132 * for consistency with what the vfs inode code does. We are expected to harvest
133 * better code and performance by having our own specialized counters.
134 *
135 * Please note that the loop is done over all possible CPUs, not over all online
136 * CPUs. The reason for this is that we don't want to play games with CPUs going
137 * on and off. If one of them goes off, we will just keep their counters.
138 *
139 * glommer: See cffbc8a for details, and if you ever intend to change this,
140 * please update all vfs counters to match.
141 */
Glauber Costa3942c072013-08-28 10:17:53 +1000142static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100143{
144 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000145 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146 for_each_possible_cpu(i)
147 sum += per_cpu(nr_dentry, i);
148 return sum < 0 ? 0 : sum;
149}
150
Dave Chinner62d36c72013-08-28 10:17:54 +1000151static long get_nr_dentry_unused(void)
152{
153 int i;
154 long sum = 0;
155 for_each_possible_cpu(i)
156 sum += per_cpu(nr_dentry_unused, i);
157 return sum < 0 ? 0 : sum;
158}
159
Waiman Longaf0c9af2019-01-30 13:52:38 -0500160static long get_nr_dentry_negative(void)
161{
162 int i;
163 long sum = 0;
164
165 for_each_possible_cpu(i)
166 sum += per_cpu(nr_dentry_negative, i);
167 return sum < 0 ? 0 : sum;
168}
169
Christoph Hellwig32927392020-04-24 08:43:38 +0200170int proc_nr_dentry(struct ctl_table *table, int write, void *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400171 size_t *lenp, loff_t *ppos)
172{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100173 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000174 dentry_stat.nr_unused = get_nr_dentry_unused();
Waiman Longaf0c9af2019-01-30 13:52:38 -0500175 dentry_stat.nr_negative = get_nr_dentry_negative();
Glauber Costa3942c072013-08-28 10:17:53 +1000176 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400177}
178#endif
179
Linus Torvalds5483f182012-03-04 15:51:42 -0800180/*
181 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
182 * The strings are both count bytes long, and count is non-zero.
183 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700184#ifdef CONFIG_DCACHE_WORD_ACCESS
185
186#include <asm/word-at-a-time.h>
187/*
188 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
189 * aligned allocation for this particular component. We don't
190 * strictly need the load_unaligned_zeropad() safety, but it
191 * doesn't hurt either.
192 *
193 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
194 * need the careful unaligned handling.
195 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700196static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800197{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800198 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800199
200 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300201 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700202 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800203 if (tcount < sizeof(unsigned long))
204 break;
205 if (unlikely(a != b))
206 return 1;
207 cs += sizeof(unsigned long);
208 ct += sizeof(unsigned long);
209 tcount -= sizeof(unsigned long);
210 if (!tcount)
211 return 0;
212 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000213 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800214 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700215}
216
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800217#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700218
Linus Torvalds94753db52012-05-10 12:19:19 -0700219static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700220{
Linus Torvalds5483f182012-03-04 15:51:42 -0800221 do {
222 if (*cs != *ct)
223 return 1;
224 cs++;
225 ct++;
226 tcount--;
227 } while (tcount);
228 return 0;
229}
230
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700231#endif
232
Linus Torvalds94753db52012-05-10 12:19:19 -0700233static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
234{
Linus Torvalds94753db52012-05-10 12:19:19 -0700235 /*
236 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100237 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700238 *
239 * NOTE! Even if a rename will mean that the length
240 * was not loaded atomically, we don't care. The
241 * RCU walk will check the sequence count eventually,
242 * and catch it. And we won't overrun the buffer,
243 * because we're reading the name pointer atomically,
244 * and a dentry name is guaranteed to be properly
245 * terminated with a NUL byte.
246 *
247 * End result: even if 'len' is wrong, we'll exit
248 * early because the data cannot match (there can
249 * be no NUL in the ct/tcount data)
250 */
Will Deacon506458e2017-10-24 11:22:48 +0100251 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000252
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700253 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700254}
255
Al Viro8d85b482014-09-29 14:54:27 -0400256struct external_name {
257 union {
258 atomic_t count;
259 struct rcu_head head;
260 } u;
261 unsigned char name[];
262};
263
264static inline struct external_name *external_name(struct dentry *dentry)
265{
266 return container_of(dentry->d_name.name, struct external_name, name[0]);
267}
268
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400269static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
272
Al Viro8d85b482014-09-29 14:54:27 -0400273 kmem_cache_free(dentry_cache, dentry);
274}
275
276static void __d_free_external(struct rcu_head *head)
277{
278 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -0700279 kfree(external_name(dentry));
Roman Gushchinf1782c92018-04-10 16:27:44 -0700280 kmem_cache_free(dentry_cache, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
Al Viro810bb172014-10-12 12:45:37 -0400283static inline int dname_external(const struct dentry *dentry)
284{
285 return dentry->d_name.name != dentry->d_iname;
286}
287
Al Viro49d31c22017-07-07 14:51:19 -0400288void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
289{
290 spin_lock(&dentry->d_lock);
Al Viro230c6402019-04-26 13:07:27 -0400291 name->name = dentry->d_name;
Al Viro49d31c22017-07-07 14:51:19 -0400292 if (unlikely(dname_external(dentry))) {
Al Viro230c6402019-04-26 13:07:27 -0400293 atomic_inc(&external_name(dentry)->u.count);
Al Viro49d31c22017-07-07 14:51:19 -0400294 } else {
Tetsuo Handa6cd00a02018-08-17 15:44:34 -0700295 memcpy(name->inline_name, dentry->d_iname,
296 dentry->d_name.len + 1);
Al Viro230c6402019-04-26 13:07:27 -0400297 name->name.name = name->inline_name;
Al Viro49d31c22017-07-07 14:51:19 -0400298 }
Al Viro230c6402019-04-26 13:07:27 -0400299 spin_unlock(&dentry->d_lock);
Al Viro49d31c22017-07-07 14:51:19 -0400300}
301EXPORT_SYMBOL(take_dentry_name_snapshot);
302
303void release_dentry_name_snapshot(struct name_snapshot *name)
304{
Al Viro230c6402019-04-26 13:07:27 -0400305 if (unlikely(name->name.name != name->inline_name)) {
Al Viro49d31c22017-07-07 14:51:19 -0400306 struct external_name *p;
Al Viro230c6402019-04-26 13:07:27 -0400307 p = container_of(name->name.name, struct external_name, name[0]);
Al Viro49d31c22017-07-07 14:51:19 -0400308 if (unlikely(atomic_dec_and_test(&p->u.count)))
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -0700309 kfree_rcu(p, u.head);
Al Viro49d31c22017-07-07 14:51:19 -0400310 }
311}
312EXPORT_SYMBOL(release_dentry_name_snapshot);
313
David Howells4bf46a22015-03-05 14:09:22 +0000314static inline void __d_set_inode_and_type(struct dentry *dentry,
315 struct inode *inode,
316 unsigned type_flags)
317{
318 unsigned flags;
319
320 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000321 flags = READ_ONCE(dentry->d_flags);
322 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
323 flags |= type_flags;
Al Viro2fa6b1e2019-11-12 16:13:06 -0500324 smp_store_release(&dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000325}
326
David Howells4bf46a22015-03-05 14:09:22 +0000327static inline void __d_clear_type_and_inode(struct dentry *dentry)
328{
329 unsigned flags = READ_ONCE(dentry->d_flags);
330
331 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
332 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000333 dentry->d_inode = NULL;
Waiman Longaf0c9af2019-01-30 13:52:38 -0500334 if (dentry->d_flags & DCACHE_LRU_LIST)
335 this_cpu_inc(nr_dentry_negative);
David Howells4bf46a22015-03-05 14:09:22 +0000336}
337
Al Virob4f03542014-04-29 23:40:14 -0400338static void dentry_free(struct dentry *dentry)
339{
Al Viro946e51f2014-10-26 19:19:16 -0400340 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400341 if (unlikely(dname_external(dentry))) {
342 struct external_name *p = external_name(dentry);
343 if (likely(atomic_dec_and_test(&p->u.count))) {
344 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
345 return;
346 }
347 }
Al Virob4f03542014-04-29 23:40:14 -0400348 /* if dentry was never visible to RCU, immediate free is OK */
Al Viro5467a682019-03-15 22:23:19 -0400349 if (dentry->d_flags & DCACHE_NORCU)
Al Virob4f03542014-04-29 23:40:14 -0400350 __d_free(&dentry->d_u.d_rcu);
351 else
352 call_rcu(&dentry->d_u.d_rcu, __d_free);
353}
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355/*
356 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400357 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100358 */
359static void dentry_unlink_inode(struct dentry * dentry)
360 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100361 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100362{
363 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500364
Al Viro4c0d7cd2018-08-09 10:15:54 -0400365 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000366 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400367 hlist_del_init(&dentry->d_u.d_alias);
Al Viro4c0d7cd2018-08-09 10:15:54 -0400368 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100369 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100370 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100371 if (!inode->i_nlink)
372 fsnotify_inoderemove(inode);
373 if (dentry->d_op && dentry->d_op->d_iput)
374 dentry->d_op->d_iput(dentry, inode);
375 else
376 iput(inode);
377}
378
379/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400380 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
381 * is in use - which includes both the "real" per-superblock
382 * LRU list _and_ the DCACHE_SHRINK_LIST use.
383 *
384 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
385 * on the shrink list (ie not on the superblock LRU list).
386 *
387 * The per-cpu "nr_dentry_unused" counters are updated with
388 * the DCACHE_LRU_LIST bit.
389 *
Waiman Longaf0c9af2019-01-30 13:52:38 -0500390 * The per-cpu "nr_dentry_negative" counters are only updated
391 * when deleted from or added to the per-superblock LRU list, not
392 * from/to the shrink list. That is to avoid an unneeded dec/inc
393 * pair when moving from LRU to shrink list in select_collect().
394 *
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400395 * These helper functions make sure we always follow the
396 * rules. d_lock must be held by the caller.
397 */
398#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
399static void d_lru_add(struct dentry *dentry)
400{
401 D_FLAG_VERIFY(dentry, 0);
402 dentry->d_flags |= DCACHE_LRU_LIST;
403 this_cpu_inc(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500404 if (d_is_negative(dentry))
405 this_cpu_inc(nr_dentry_negative);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400406 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
407}
408
409static void d_lru_del(struct dentry *dentry)
410{
411 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
412 dentry->d_flags &= ~DCACHE_LRU_LIST;
413 this_cpu_dec(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500414 if (d_is_negative(dentry))
415 this_cpu_dec(nr_dentry_negative);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400416 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
417}
418
419static void d_shrink_del(struct dentry *dentry)
420{
421 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
422 list_del_init(&dentry->d_lru);
423 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
424 this_cpu_dec(nr_dentry_unused);
425}
426
427static void d_shrink_add(struct dentry *dentry, struct list_head *list)
428{
429 D_FLAG_VERIFY(dentry, 0);
430 list_add(&dentry->d_lru, list);
431 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
432 this_cpu_inc(nr_dentry_unused);
433}
434
435/*
436 * These can only be called under the global LRU lock, ie during the
437 * callback for freeing the LRU list. "isolate" removes it from the
438 * LRU lists entirely, while shrink_move moves it to the indicated
439 * private list.
440 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800441static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400442{
443 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
444 dentry->d_flags &= ~DCACHE_LRU_LIST;
445 this_cpu_dec(nr_dentry_unused);
Waiman Longaf0c9af2019-01-30 13:52:38 -0500446 if (d_is_negative(dentry))
447 this_cpu_dec(nr_dentry_negative);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800448 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400449}
450
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800451static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
452 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400453{
454 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
455 dentry->d_flags |= DCACHE_SHRINK_LIST;
Waiman Longaf0c9af2019-01-30 13:52:38 -0500456 if (d_is_negative(dentry))
457 this_cpu_dec(nr_dentry_negative);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800458 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400459}
460
NeilBrown61647822017-11-10 15:45:41 +1100461static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100462{
Al Viro0632a9a2018-03-07 00:49:10 -0500463 struct hlist_bl_head *b;
464 /*
465 * Hashed dentries are normally on the dentry hashtable,
466 * with the exception of those newly allocated by
467 * d_obtain_root, which are always IS_ROOT:
468 */
469 if (unlikely(IS_ROOT(dentry)))
470 b = &dentry->d_sb->s_roots;
471 else
472 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400473
Al Viro0632a9a2018-03-07 00:49:10 -0500474 hlist_bl_lock(b);
475 __hlist_bl_del(&dentry->d_hash);
476 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100477}
NeilBrown61647822017-11-10 15:45:41 +1100478
479void __d_drop(struct dentry *dentry)
480{
Al Viro0632a9a2018-03-07 00:49:10 -0500481 if (!d_unhashed(dentry)) {
482 ___d_drop(dentry);
483 dentry->d_hash.pprev = NULL;
484 write_seqcount_invalidate(&dentry->d_seq);
485 }
NeilBrown61647822017-11-10 15:45:41 +1100486}
Nick Piggin789680d2011-01-07 17:49:30 +1100487EXPORT_SYMBOL(__d_drop);
488
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +0100489/**
490 * d_drop - drop a dentry
491 * @dentry: dentry to drop
492 *
493 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
494 * be found through a VFS lookup any more. Note that this is different from
495 * deleting the dentry - d_delete will try to mark the dentry negative if
496 * possible, giving a successful _negative_ lookup, while d_drop will
497 * just make the cache lookup fail.
498 *
499 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
500 * reason (NFS timeouts or autofs deletes).
501 *
502 * __d_drop requires dentry->d_lock
503 *
504 * ___d_drop doesn't mark dentry as "unhashed"
505 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
506 */
Nick Piggin789680d2011-01-07 17:49:30 +1100507void d_drop(struct dentry *dentry)
508{
Nick Piggin789680d2011-01-07 17:49:30 +1100509 spin_lock(&dentry->d_lock);
510 __d_drop(dentry);
511 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100512}
513EXPORT_SYMBOL(d_drop);
514
Al Viroba65dc52016-06-10 11:32:47 -0400515static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
516{
517 struct dentry *next;
518 /*
519 * Inform d_walk() and shrink_dentry_list() that we are no longer
520 * attached to the dentry tree
521 */
522 dentry->d_flags |= DCACHE_DENTRY_KILLED;
523 if (unlikely(list_empty(&dentry->d_child)))
524 return;
525 __list_del_entry(&dentry->d_child);
526 /*
527 * Cursors can move around the list of children. While we'd been
528 * a normal list member, it didn't matter - ->d_child.next would've
529 * been updated. However, from now on it won't be and for the
530 * things like d_walk() it might end up with a nasty surprise.
531 * Normally d_walk() doesn't care about cursors moving around -
532 * ->d_lock on parent prevents that and since a cursor has no children
533 * of its own, we get through it without ever unlocking the parent.
534 * There is one exception, though - if we ascend from a child that
535 * gets killed as soon as we unlock it, the next sibling is found
536 * using the value left in its ->d_child.next. And if _that_
537 * pointed to a cursor, and cursor got moved (e.g. by lseek())
538 * before d_walk() regains parent->d_lock, we'll end up skipping
539 * everything the cursor had been moved past.
540 *
541 * Solution: make sure that the pointer left behind in ->d_child.next
542 * points to something that won't be moving around. I.e. skip the
543 * cursors.
544 */
545 while (dentry->d_child.next != &parent->d_subdirs) {
546 next = list_entry(dentry->d_child.next, struct dentry, d_child);
547 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
548 break;
549 dentry->d_child.next = next->d_child.next;
550 }
551}
552
Al Viroe55fd012014-05-28 13:51:12 -0400553static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100554{
Al Viro41edf2782014-05-01 10:30:00 -0400555 struct dentry *parent = NULL;
556 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400557 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100558 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100559
Linus Torvalds0d984392013-09-08 13:46:52 -0700560 /*
561 * The dentry is now unrecoverably dead to the world.
562 */
563 lockref_mark_dead(&dentry->d_lockref);
564
Sage Weilf0023bc2011-10-28 10:02:42 -0700565 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700566 * inform the fs via d_prune that this dentry is about to be
567 * unhashed and destroyed.
568 */
Al Viro29266202014-05-30 11:39:02 -0400569 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800570 dentry->d_op->d_prune(dentry);
571
Al Viro01b60352014-04-29 23:42:52 -0400572 if (dentry->d_flags & DCACHE_LRU_LIST) {
573 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
574 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400575 }
Nick Piggin77812a12011-01-07 17:49:48 +1100576 /* if it was on the hash then remove it */
577 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400578 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400579 if (parent)
580 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400581 if (dentry->d_inode)
582 dentry_unlink_inode(dentry);
583 else
584 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400585 this_cpu_dec(nr_dentry);
586 if (dentry->d_op && dentry->d_op->d_release)
587 dentry->d_op->d_release(dentry);
588
Al Viro41edf2782014-05-01 10:30:00 -0400589 spin_lock(&dentry->d_lock);
590 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
591 dentry->d_flags |= DCACHE_MAY_FREE;
592 can_free = false;
593 }
594 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400595 if (likely(can_free))
596 dentry_free(dentry);
Al Viro9c5f1d32018-04-15 18:28:48 -0400597 cond_resched();
Al Viroe55fd012014-05-28 13:51:12 -0400598}
599
Al Viro8b987a42018-02-23 22:11:34 -0500600static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400601{
Al Viro8b987a42018-02-23 22:11:34 -0500602 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400603 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400604 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400605again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700606 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400607 spin_lock(&parent->d_lock);
608 /*
609 * We can't blindly lock dentry until we are sure
610 * that we won't violate the locking order.
611 * Any changes of dentry->d_parent must have
612 * been done with parent->d_lock held, so
613 * spin_lock() above is enough of a barrier
614 * for checking if it's still our child.
615 */
616 if (unlikely(parent != dentry->d_parent)) {
617 spin_unlock(&parent->d_lock);
618 goto again;
619 }
Al Viro3b821402018-02-23 20:47:17 -0500620 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500621 if (parent != dentry)
622 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
623 else
624 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400625 return parent;
626}
627
Al Viro8b987a42018-02-23 22:11:34 -0500628static inline struct dentry *lock_parent(struct dentry *dentry)
629{
630 struct dentry *parent = dentry->d_parent;
631 if (IS_ROOT(dentry))
632 return NULL;
633 if (likely(spin_trylock(&parent->d_lock)))
634 return parent;
635 return __lock_parent(dentry);
636}
637
Al Viroa3385792018-02-23 21:07:24 -0500638static inline bool retain_dentry(struct dentry *dentry)
639{
640 WARN_ON(d_in_lookup(dentry));
641
642 /* Unreachable? Get rid of it */
643 if (unlikely(d_unhashed(dentry)))
644 return false;
645
646 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
647 return false;
648
649 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
650 if (dentry->d_op->d_delete(dentry))
651 return false;
652 }
Ira Weiny2c567af2020-04-30 07:41:37 -0700653
654 if (unlikely(dentry->d_flags & DCACHE_DONTCACHE))
655 return false;
656
Al Viro62d99562018-03-06 21:37:31 -0500657 /* retain; LRU fodder */
658 dentry->d_lockref.count--;
659 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
660 d_lru_add(dentry);
661 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
662 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500663 return true;
664}
665
Ira Weiny2c567af2020-04-30 07:41:37 -0700666void d_mark_dontcache(struct inode *inode)
667{
668 struct dentry *de;
669
670 spin_lock(&inode->i_lock);
671 hlist_for_each_entry(de, &inode->i_dentry, d_u.d_alias) {
672 spin_lock(&de->d_lock);
673 de->d_flags |= DCACHE_DONTCACHE;
674 spin_unlock(&de->d_lock);
675 }
676 inode->i_state |= I_DONTCACHE;
677 spin_unlock(&inode->i_lock);
678}
679EXPORT_SYMBOL(d_mark_dontcache);
680
Linus Torvalds360f5472015-01-09 15:19:03 -0800681/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100682 * Finish off a dentry we've decided to kill.
683 * dentry->d_lock must be held, returns with it unlocked.
684 * Returns dentry requiring refcount drop, or NULL if we're done.
685 */
686static struct dentry *dentry_kill(struct dentry *dentry)
687 __releases(dentry->d_lock)
688{
689 struct inode *inode = dentry->d_inode;
690 struct dentry *parent = NULL;
691
692 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500693 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100694
695 if (!IS_ROOT(dentry)) {
696 parent = dentry->d_parent;
697 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500698 parent = __lock_parent(dentry);
699 if (likely(inode || !dentry->d_inode))
700 goto got_locks;
701 /* negative that became positive */
702 if (parent)
703 spin_unlock(&parent->d_lock);
704 inode = dentry->d_inode;
705 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100706 }
707 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100708 __dentry_kill(dentry);
709 return parent;
710
Al Virof657a662018-02-23 21:25:42 -0500711slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100712 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500713 spin_lock(&inode->i_lock);
714 spin_lock(&dentry->d_lock);
715 parent = lock_parent(dentry);
716got_locks:
717 if (unlikely(dentry->d_lockref.count != 1)) {
718 dentry->d_lockref.count--;
719 } else if (likely(!retain_dentry(dentry))) {
720 __dentry_kill(dentry);
721 return parent;
722 }
723 /* we are keeping it, after all */
724 if (inode)
725 spin_unlock(&inode->i_lock);
726 if (parent)
727 spin_unlock(&parent->d_lock);
728 spin_unlock(&dentry->d_lock);
729 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100730}
731
732/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800733 * Try to do a lockless dput(), and return whether that was successful.
734 *
735 * If unsuccessful, we return false, having already taken the dentry lock.
736 *
737 * The caller needs to hold the RCU read lock, so that the dentry is
738 * guaranteed to stay around even if the refcount goes down to zero!
739 */
740static inline bool fast_dput(struct dentry *dentry)
741{
742 int ret;
743 unsigned int d_flags;
744
745 /*
746 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100747 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800748 */
749 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
750 return lockref_put_or_lock(&dentry->d_lockref);
751
752 /*
753 * .. otherwise, we can try to just decrement the
754 * lockref optimistically.
755 */
756 ret = lockref_put_return(&dentry->d_lockref);
757
758 /*
759 * If the lockref_put_return() failed due to the lock being held
760 * by somebody else, the fast path has failed. We will need to
761 * get the lock, and then check the count again.
762 */
763 if (unlikely(ret < 0)) {
764 spin_lock(&dentry->d_lock);
765 if (dentry->d_lockref.count > 1) {
766 dentry->d_lockref.count--;
767 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500768 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800769 }
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500770 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800771 }
772
773 /*
774 * If we weren't the last ref, we're done.
775 */
776 if (ret)
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500777 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800778
779 /*
780 * Careful, careful. The reference count went down
781 * to zero, but we don't hold the dentry lock, so
782 * somebody else could get it again, and do another
783 * dput(), and we need to not race with that.
784 *
785 * However, there is a very special and common case
786 * where we don't care, because there is nothing to
787 * do: the dentry is still hashed, it does not have
788 * a 'delete' op, and it's referenced and already on
789 * the LRU list.
790 *
791 * NOTE! Since we aren't locked, these values are
792 * not "stable". However, it is sufficient that at
793 * some point after we dropped the reference the
794 * dentry was hashed and the flags had the proper
795 * value. Other dentry users may have re-gotten
796 * a reference to the dentry and change that, but
797 * our work is done - we can leave the dentry
798 * around with a zero refcount.
Hao Li77573fa2020-12-08 10:10:50 +0800799 *
800 * Nevertheless, there are two cases that we should kill
801 * the dentry anyway.
802 * 1. free disconnected dentries as soon as their refcount
803 * reached zero.
804 * 2. free dentries if they should not be cached.
Linus Torvalds360f5472015-01-09 15:19:03 -0800805 */
806 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700807 d_flags = READ_ONCE(dentry->d_flags);
Hao Li77573fa2020-12-08 10:10:50 +0800808 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST |
809 DCACHE_DISCONNECTED | DCACHE_DONTCACHE;
Linus Torvalds360f5472015-01-09 15:19:03 -0800810
811 /* Nothing to do? Dropping the reference was all we needed? */
812 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500813 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800814
815 /*
816 * Not the fast normal case? Get the lock. We've already decremented
817 * the refcount, but we'll need to re-check the situation after
818 * getting the lock.
819 */
820 spin_lock(&dentry->d_lock);
821
822 /*
823 * Did somebody else grab a reference to it in the meantime, and
824 * we're no longer the last user after all? Alternatively, somebody
825 * else could have killed it and marked it dead. Either way, we
826 * don't need to do anything else.
827 */
828 if (dentry->d_lockref.count) {
829 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500830 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800831 }
832
833 /*
834 * Re-get the reference we optimistically dropped. We hold the
835 * lock, and we just tested that it was zero, so we can just
836 * set it to 1.
837 */
838 dentry->d_lockref.count = 1;
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500839 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800840}
841
842
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843/*
844 * This is dput
845 *
846 * This is complicated by the fact that we do not want to put
847 * dentries that are no longer on any hash chain on the unused
848 * list: we'd much rather just get rid of them immediately.
849 *
850 * However, that implies that we have to traverse the dentry
851 * tree upwards to the parents which might _also_ now be
852 * scheduled for deletion (it may have been only waiting for
853 * its last child to go away).
854 *
855 * This tail recursion is done by hand as we don't want to depend
856 * on the compiler to always get this right (gcc generally doesn't).
857 * Real recursion would eat up our stack space.
858 */
859
860/*
861 * dput - release a dentry
862 * @dentry: dentry to release
863 *
864 * Release a dentry. This will drop the usage count and if appropriate
865 * call the dentry unlink method as well as removing it from the queues and
866 * releasing its resources. If the parent dentries were scheduled for release
867 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869void dput(struct dentry *dentry)
870{
Al Viro1088a642018-04-15 18:31:03 -0400871 while (dentry) {
872 might_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Al Viro1088a642018-04-15 18:31:03 -0400874 rcu_read_lock();
875 if (likely(fast_dput(dentry))) {
876 rcu_read_unlock();
877 return;
878 }
Wei Fang47be6182016-07-06 11:32:20 +0800879
Al Viro1088a642018-04-15 18:31:03 -0400880 /* Slow case: now with the dentry lock held */
Linus Torvalds360f5472015-01-09 15:19:03 -0800881 rcu_read_unlock();
Linus Torvalds360f5472015-01-09 15:19:03 -0800882
Al Viro1088a642018-04-15 18:31:03 -0400883 if (likely(retain_dentry(dentry))) {
884 spin_unlock(&dentry->d_lock);
885 return;
886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Al Viro1088a642018-04-15 18:31:03 -0400888 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800889 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700891EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Al Viro9bdebc22019-06-29 18:31:24 -0400893static void __dput_to_list(struct dentry *dentry, struct list_head *list)
894__must_hold(&dentry->d_lock)
895{
896 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
897 /* let the owner of the list it's on deal with it */
898 --dentry->d_lockref.count;
899 } else {
900 if (dentry->d_flags & DCACHE_LRU_LIST)
901 d_lru_del(dentry);
902 if (!--dentry->d_lockref.count)
903 d_shrink_add(dentry, list);
904 }
905}
906
907void dput_to_list(struct dentry *dentry, struct list_head *list)
908{
909 rcu_read_lock();
910 if (likely(fast_dput(dentry))) {
911 rcu_read_unlock();
912 return;
913 }
914 rcu_read_unlock();
915 if (!retain_dentry(dentry))
916 __dput_to_list(dentry, list);
917 spin_unlock(&dentry->d_lock);
918}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100920/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100921static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922{
Waiman Long98474232013-08-28 18:24:59 -0700923 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
925
Nick Piggindc0474b2011-01-07 17:49:43 +1100926static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100927{
Waiman Long98474232013-08-28 18:24:59 -0700928 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100929}
930
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100931struct dentry *dget_parent(struct dentry *dentry)
932{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700933 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100934 struct dentry *ret;
Al Viroe8400932019-10-31 01:43:31 -0400935 unsigned seq;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100936
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700937 /*
938 * Do optimistic parent lookup without any
939 * locking.
940 */
941 rcu_read_lock();
Al Viroe8400932019-10-31 01:43:31 -0400942 seq = raw_seqcount_begin(&dentry->d_seq);
Mark Rutland66702eb2017-10-23 14:07:14 -0700943 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700944 gotref = lockref_get_not_zero(&ret->d_lockref);
945 rcu_read_unlock();
946 if (likely(gotref)) {
Al Viroe8400932019-10-31 01:43:31 -0400947 if (!read_seqcount_retry(&dentry->d_seq, seq))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700948 return ret;
949 dput(ret);
950 }
951
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100952repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100953 /*
954 * Don't need rcu_dereference because we re-check it was correct under
955 * the lock.
956 */
957 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100958 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100959 spin_lock(&ret->d_lock);
960 if (unlikely(ret != dentry->d_parent)) {
961 spin_unlock(&ret->d_lock);
962 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100963 goto repeat;
964 }
Nick Piggina734eb42011-01-07 17:49:44 +1100965 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700966 BUG_ON(!ret->d_lockref.count);
967 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100968 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100969 return ret;
970}
971EXPORT_SYMBOL(dget_parent);
972
Al Viro61fec492018-04-25 10:52:25 -0400973static struct dentry * __d_find_any_alias(struct inode *inode)
974{
975 struct dentry *alias;
976
977 if (hlist_empty(&inode->i_dentry))
978 return NULL;
979 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
980 __dget(alias);
981 return alias;
982}
983
984/**
985 * d_find_any_alias - find any alias for a given inode
986 * @inode: inode to find an alias for
987 *
988 * If any aliases exist for the given inode, take and return a
989 * reference for one of them. If no aliases exist, return %NULL.
990 */
991struct dentry *d_find_any_alias(struct inode *inode)
992{
993 struct dentry *de;
994
995 spin_lock(&inode->i_lock);
996 de = __d_find_any_alias(inode);
997 spin_unlock(&inode->i_lock);
998 return de;
999}
1000EXPORT_SYMBOL(d_find_any_alias);
1001
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001002static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003{
Al Viro61fec492018-04-25 10:52:25 -04001004 struct dentry *alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Al Viro61fec492018-04-25 10:52:25 -04001006 if (S_ISDIR(inode->i_mode))
1007 return __d_find_any_alias(inode);
1008
Al Viro946e51f2014-10-26 19:19:16 -04001009 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +11001010 spin_lock(&alias->d_lock);
Al Viro61fec492018-04-25 10:52:25 -04001011 if (!d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -05001012 __dget_dlock(alias);
1013 spin_unlock(&alias->d_lock);
1014 return alias;
Nick Pigginda502952011-01-07 17:49:33 +11001015 }
1016 spin_unlock(&alias->d_lock);
Nick Pigginda502952011-01-07 17:49:33 +11001017 }
1018 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019}
1020
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001021/**
1022 * d_find_alias - grab a hashed alias of inode
1023 * @inode: inode in question
1024 *
1025 * If inode has a hashed alias, or is a directory and has any alias,
1026 * acquire the reference to alias and return it. Otherwise return NULL.
1027 * Notice that if inode is a directory there can be only one alias and
1028 * it can be unhashed only if it has no children, or if it is the root
1029 * of a filesystem, or if the directory was renamed and d_revalidate
1030 * was the first vfs operation to notice.
1031 *
1032 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
1033 * any other hashed alias over that one.
1034 */
Nick Pigginda502952011-01-07 17:49:33 +11001035struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036{
David Howells214fda12006-03-25 03:06:36 -08001037 struct dentry *de = NULL;
1038
Al Virob3d9b7a2012-06-09 13:51:19 -04001039 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001040 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -05001041 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001042 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -08001043 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 return de;
1045}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001046EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048/*
Al Virobca585d2021-01-05 14:13:52 -05001049 * Caller MUST be holding rcu_read_lock() and be guaranteed
1050 * that inode won't get freed until rcu_read_unlock().
1051 */
1052struct dentry *d_find_alias_rcu(struct inode *inode)
1053{
1054 struct hlist_head *l = &inode->i_dentry;
1055 struct dentry *de = NULL;
1056
1057 spin_lock(&inode->i_lock);
1058 // ->i_dentry and ->i_rcu are colocated, but the latter won't be
1059 // used without having I_FREEING set, which means no aliases left
1060 if (likely(!(inode->i_state & I_FREEING) && !hlist_empty(l))) {
1061 if (S_ISDIR(inode->i_mode)) {
1062 de = hlist_entry(l->first, struct dentry, d_u.d_alias);
1063 } else {
1064 hlist_for_each_entry(de, l, d_u.d_alias)
1065 if (!d_unhashed(de))
1066 break;
1067 }
1068 }
1069 spin_unlock(&inode->i_lock);
1070 return de;
1071}
1072
1073/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 * Try to kill dentries associated with this inode.
1075 * WARNING: you must own a reference to inode.
1076 */
1077void d_prune_aliases(struct inode *inode)
1078{
Domen Puncer0cdca3f2005-09-10 00:27:07 -07001079 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080restart:
Nick Piggin873feea2011-01-07 17:50:06 +11001081 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -04001082 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -07001084 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -04001085 struct dentry *parent = lock_parent(dentry);
1086 if (likely(!dentry->d_lockref.count)) {
1087 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +08001088 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -04001089 goto restart;
1090 }
1091 if (parent)
1092 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
1094 spin_unlock(&dentry->d_lock);
1095 }
Nick Piggin873feea2011-01-07 17:50:06 +11001096 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001098EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Al Viro3b3f09f2018-02-23 21:54:18 -05001100/*
1101 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +01001102 * Called under rcu_read_lock() and dentry->d_lock; the former
1103 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -05001104 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +01001105 * d_delete(), etc.
1106 *
Al Viro3b3f09f2018-02-23 21:54:18 -05001107 * Return false if dentry has been disrupted or grabbed, leaving
1108 * the caller to kick it off-list. Otherwise, return true and have
1109 * that dentry's inode and parent both locked.
1110 */
1111static bool shrink_lock_dentry(struct dentry *dentry)
1112{
1113 struct inode *inode;
1114 struct dentry *parent;
1115
1116 if (dentry->d_lockref.count)
1117 return false;
1118
1119 inode = dentry->d_inode;
1120 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001121 spin_unlock(&dentry->d_lock);
1122 spin_lock(&inode->i_lock);
1123 spin_lock(&dentry->d_lock);
1124 if (unlikely(dentry->d_lockref.count))
1125 goto out;
1126 /* changed inode means that somebody had grabbed it */
1127 if (unlikely(inode != dentry->d_inode))
1128 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001129 }
1130
1131 parent = dentry->d_parent;
1132 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1133 return true;
1134
Al Viro3b3f09f2018-02-23 21:54:18 -05001135 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001136 spin_lock(&parent->d_lock);
1137 if (unlikely(parent != dentry->d_parent)) {
1138 spin_unlock(&parent->d_lock);
1139 spin_lock(&dentry->d_lock);
1140 goto out;
1141 }
1142 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001143 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001144 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001145 spin_unlock(&parent->d_lock);
1146out:
1147 if (inode)
1148 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001149 return false;
1150}
1151
Al Viro9bdebc22019-06-29 18:31:24 -04001152void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001154 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001155 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001156
Miklos Szeredi60942f22014-05-02 15:38:39 -04001157 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001158 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001159 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001160 if (!shrink_lock_dentry(dentry)) {
1161 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001162 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001163 d_shrink_del(dentry);
1164 if (dentry->d_lockref.count < 0)
1165 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001166 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001167 if (can_free)
1168 dentry_free(dentry);
1169 continue;
1170 }
John Ogness8f04da22018-02-23 00:50:24 +01001171 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001172 d_shrink_del(dentry);
1173 parent = dentry->d_parent;
Al Viro9bdebc22019-06-29 18:31:24 -04001174 if (parent != dentry)
1175 __dput_to_list(parent, list);
Al Viroff2fde92014-05-28 13:59:13 -04001176 __dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001178}
1179
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001180static enum lru_status dentry_lru_isolate(struct list_head *item,
1181 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001182{
1183 struct list_head *freeable = arg;
1184 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1185
1186
1187 /*
1188 * we are inverting the lru lock/dentry->d_lock here,
1189 * so use a trylock. If we fail to get the lock, just skip
1190 * it
1191 */
1192 if (!spin_trylock(&dentry->d_lock))
1193 return LRU_SKIP;
1194
1195 /*
1196 * Referenced dentries are still in use. If they have active
1197 * counts, just remove them from the LRU. Otherwise give them
1198 * another pass through the LRU.
1199 */
1200 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001201 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001202 spin_unlock(&dentry->d_lock);
1203 return LRU_REMOVED;
1204 }
1205
1206 if (dentry->d_flags & DCACHE_REFERENCED) {
1207 dentry->d_flags &= ~DCACHE_REFERENCED;
1208 spin_unlock(&dentry->d_lock);
1209
1210 /*
1211 * The list move itself will be made by the common LRU code. At
1212 * this point, we've dropped the dentry->d_lock but keep the
1213 * lru lock. This is safe to do, since every list movement is
1214 * protected by the lru lock even if both locks are held.
1215 *
1216 * This is guaranteed by the fact that all LRU management
1217 * functions are intermediated by the LRU API calls like
1218 * list_lru_add and list_lru_del. List movement in this file
1219 * only ever occur through this functions or through callbacks
1220 * like this one, that are called from the LRU API.
1221 *
1222 * The only exceptions to this are functions like
1223 * shrink_dentry_list, and code that first checks for the
1224 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1225 * operating only with stack provided lists after they are
1226 * properly isolated from the main list. It is thus, always a
1227 * local access.
1228 */
1229 return LRU_ROTATE;
1230 }
1231
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001232 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001233 spin_unlock(&dentry->d_lock);
1234
1235 return LRU_REMOVED;
1236}
1237
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001238/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001239 * prune_dcache_sb - shrink the dcache
1240 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001241 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001242 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001243 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1244 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001245 * function.
1246 *
1247 * This function may fail to free any resources if all the dentries are in
1248 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001249 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001250long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001251{
Dave Chinnerf6041562013-08-28 10:18:00 +10001252 LIST_HEAD(dispose);
1253 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001254
Vladimir Davydov503c3582015-02-12 14:58:47 -08001255 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1256 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001257 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001258 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259}
1260
Glauber Costa4e717f52013-08-28 10:18:03 +10001261static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001262 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001263{
Glauber Costa4e717f52013-08-28 10:18:03 +10001264 struct list_head *freeable = arg;
1265 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001266
Glauber Costa4e717f52013-08-28 10:18:03 +10001267 /*
1268 * we are inverting the lru lock/dentry->d_lock here,
1269 * so use a trylock. If we fail to get the lock, just skip
1270 * it
1271 */
1272 if (!spin_trylock(&dentry->d_lock))
1273 return LRU_SKIP;
1274
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001275 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001276 spin_unlock(&dentry->d_lock);
1277
1278 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001279}
1280
Glauber Costa4e717f52013-08-28 10:18:03 +10001281
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001282/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 * shrink_dcache_sb - shrink dcache for a superblock
1284 * @sb: superblock
1285 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001286 * Shrink the dcache for the specified super block. This is used to free
1287 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001289void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290{
Glauber Costa4e717f52013-08-28 10:18:03 +10001291 do {
1292 LIST_HEAD(dispose);
1293
Waiman Long1dbd4492019-01-30 13:52:36 -05001294 list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001295 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001296 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001297 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001299EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001302 * enum d_walk_ret - action to talke during tree walk
1303 * @D_WALK_CONTINUE: contrinue walk
1304 * @D_WALK_QUIT: quit walk
1305 * @D_WALK_NORETRY: quit when retry is needed
1306 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001308enum d_walk_ret {
1309 D_WALK_CONTINUE,
1310 D_WALK_QUIT,
1311 D_WALK_NORETRY,
1312 D_WALK_SKIP,
1313};
1314
1315/**
1316 * d_walk - walk the dentry tree
1317 * @parent: start of walk
1318 * @data: data passed to @enter() and @finish()
1319 * @enter: callback when first entering the dentry
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001320 *
Al Viro3a8e3612018-04-15 18:27:23 -04001321 * The @enter() callbacks are called with d_lock held.
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001322 */
1323static void d_walk(struct dentry *parent, void *data,
Al Viro3a8e3612018-04-15 18:27:23 -04001324 enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
Nick Piggin949854d2011-01-07 17:49:37 +11001326 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001328 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001329 enum d_walk_ret ret;
1330 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001331
Nick Piggin58db63d2011-01-07 17:49:39 +11001332again:
Al Viro48f5ec22013-09-09 15:22:25 -04001333 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001334 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001335 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336
1337 ret = enter(data, this_parent);
1338 switch (ret) {
1339 case D_WALK_CONTINUE:
1340 break;
1341 case D_WALK_QUIT:
1342 case D_WALK_SKIP:
1343 goto out_unlock;
1344 case D_WALK_NORETRY:
1345 retry = false;
1346 break;
1347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348repeat:
1349 next = this_parent->d_subdirs.next;
1350resume:
1351 while (next != &this_parent->d_subdirs) {
1352 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001353 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001355
Al Viroba65dc52016-06-10 11:32:47 -04001356 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1357 continue;
1358
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001359 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001360
1361 ret = enter(data, dentry);
1362 switch (ret) {
1363 case D_WALK_CONTINUE:
1364 break;
1365 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001366 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001367 goto out_unlock;
1368 case D_WALK_NORETRY:
1369 retry = false;
1370 break;
1371 case D_WALK_SKIP:
1372 spin_unlock(&dentry->d_lock);
1373 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001374 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001375
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001377 spin_unlock(&this_parent->d_lock);
Qian Cai5facae42019-09-19 12:09:40 -04001378 spin_release(&dentry->d_lock.dep_map, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001380 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 goto repeat;
1382 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001383 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 }
1385 /*
1386 * All done at this level ... ascend and resume the search.
1387 */
Al Viroca5358e2014-10-26 19:31:10 -04001388 rcu_read_lock();
1389ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001391 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001392 this_parent = child->d_parent;
1393
Al Viro31dec132013-10-25 17:04:27 -04001394 spin_unlock(&child->d_lock);
1395 spin_lock(&this_parent->d_lock);
1396
Al Viroca5358e2014-10-26 19:31:10 -04001397 /* might go back up the wrong parent if we have had a rename. */
1398 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001399 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001400 /* go into the first sibling still alive */
1401 do {
1402 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001403 if (next == &this_parent->d_subdirs)
1404 goto ascend;
1405 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001406 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001407 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 goto resume;
1409 }
Al Viroca5358e2014-10-26 19:31:10 -04001410 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001411 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001412 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001413
1414out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001415 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001416 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001417 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001418
1419rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001420 spin_unlock(&this_parent->d_lock);
1421 rcu_read_unlock();
1422 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001423 if (!retry)
1424 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001425 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001426 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001428
Ian Kent01619492016-11-24 08:03:41 +11001429struct check_mount {
1430 struct vfsmount *mnt;
1431 unsigned int mounted;
1432};
1433
1434static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1435{
1436 struct check_mount *info = data;
1437 struct path path = { .mnt = info->mnt, .dentry = dentry };
1438
1439 if (likely(!d_mountpoint(dentry)))
1440 return D_WALK_CONTINUE;
1441 if (__path_is_mountpoint(&path)) {
1442 info->mounted = 1;
1443 return D_WALK_QUIT;
1444 }
1445 return D_WALK_CONTINUE;
1446}
1447
1448/**
1449 * path_has_submounts - check for mounts over a dentry in the
1450 * current namespace.
1451 * @parent: path to check.
1452 *
1453 * Return true if the parent or its subdirectories contain
1454 * a mount point in the current namespace.
1455 */
1456int path_has_submounts(const struct path *parent)
1457{
1458 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1459
1460 read_seqlock_excl(&mount_lock);
Al Viro3a8e3612018-04-15 18:27:23 -04001461 d_walk(parent->dentry, &data, path_check_mount);
Ian Kent01619492016-11-24 08:03:41 +11001462 read_sequnlock_excl(&mount_lock);
1463
1464 return data.mounted;
1465}
1466EXPORT_SYMBOL(path_has_submounts);
1467
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001469 * Called by mount code to set a mountpoint and check if the mountpoint is
1470 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1471 * subtree can become unreachable).
1472 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001473 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001474 * this reason take rename_lock and d_lock on dentry and ancestors.
1475 */
1476int d_set_mounted(struct dentry *dentry)
1477{
1478 struct dentry *p;
1479 int ret = -ENOENT;
1480 write_seqlock(&rename_lock);
1481 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001482 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001483 spin_lock(&p->d_lock);
1484 if (unlikely(d_unhashed(p))) {
1485 spin_unlock(&p->d_lock);
1486 goto out;
1487 }
1488 spin_unlock(&p->d_lock);
1489 }
1490 spin_lock(&dentry->d_lock);
1491 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001492 ret = -EBUSY;
1493 if (!d_mountpoint(dentry)) {
1494 dentry->d_flags |= DCACHE_MOUNTED;
1495 ret = 0;
1496 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001497 }
1498 spin_unlock(&dentry->d_lock);
1499out:
1500 write_sequnlock(&rename_lock);
1501 return ret;
1502}
1503
1504/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001505 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 * and move any unused dentries to the end of the unused
1507 * list for prune_dcache(). We descend to the next level
1508 * whenever the d_subdirs list is non-empty and continue
1509 * searching.
1510 *
1511 * It returns zero iff there are no unused children,
1512 * otherwise it returns the number of children moved to
1513 * the end of the unused list. This may not be the total
1514 * number of unused children, because select_parent can
1515 * drop the lock and return early due to latency
1516 * constraints.
1517 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001518
1519struct select_data {
1520 struct dentry *start;
Al Viro9bdebc22019-06-29 18:31:24 -04001521 union {
1522 long found;
1523 struct dentry *victim;
1524 };
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001525 struct list_head dispose;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001526};
1527
1528static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001530 struct select_data *data = _data;
1531 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001533 if (data->start == dentry)
1534 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Al Virofe915222014-05-03 00:02:25 -04001536 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001537 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001538 } else {
1539 if (dentry->d_flags & DCACHE_LRU_LIST)
1540 d_lru_del(dentry);
1541 if (!dentry->d_lockref.count) {
1542 d_shrink_add(dentry, &data->dispose);
1543 data->found++;
1544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 }
1546 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001547 * We can return to the caller if we have found some (this
1548 * ensures forward progress). We'll be coming back to find
1549 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 */
Al Virofe915222014-05-03 00:02:25 -04001551 if (!list_empty(&data->dispose))
1552 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001554 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555}
1556
Al Viro9bdebc22019-06-29 18:31:24 -04001557static enum d_walk_ret select_collect2(void *_data, struct dentry *dentry)
1558{
1559 struct select_data *data = _data;
1560 enum d_walk_ret ret = D_WALK_CONTINUE;
1561
1562 if (data->start == dentry)
1563 goto out;
1564
1565 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
1566 if (!dentry->d_lockref.count) {
1567 rcu_read_lock();
1568 data->victim = dentry;
1569 return D_WALK_QUIT;
1570 }
1571 } else {
1572 if (dentry->d_flags & DCACHE_LRU_LIST)
1573 d_lru_del(dentry);
1574 if (!dentry->d_lockref.count)
1575 d_shrink_add(dentry, &data->dispose);
1576 }
1577 /*
1578 * We can return to the caller if we have found some (this
1579 * ensures forward progress). We'll be coming back to find
1580 * the rest.
1581 */
1582 if (!list_empty(&data->dispose))
1583 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
1584out:
1585 return ret;
1586}
1587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588/**
1589 * shrink_dcache_parent - prune dcache
1590 * @parent: parent of entries to prune
1591 *
1592 * Prune the dcache to remove unused children of the parent dentry.
1593 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001594void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001596 for (;;) {
Al Viro9bdebc22019-06-29 18:31:24 -04001597 struct select_data data = {.start = parent};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001599 INIT_LIST_HEAD(&data.dispose);
Al Viro3a8e3612018-04-15 18:27:23 -04001600 d_walk(parent, &data, select_collect);
Al Viro4fb48872018-04-19 23:58:48 -04001601
1602 if (!list_empty(&data.dispose)) {
1603 shrink_dentry_list(&data.dispose);
1604 continue;
1605 }
1606
1607 cond_resched();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001608 if (!data.found)
1609 break;
Al Viro9bdebc22019-06-29 18:31:24 -04001610 data.victim = NULL;
1611 d_walk(parent, &data, select_collect2);
1612 if (data.victim) {
1613 struct dentry *parent;
1614 spin_lock(&data.victim->d_lock);
1615 if (!shrink_lock_dentry(data.victim)) {
1616 spin_unlock(&data.victim->d_lock);
1617 rcu_read_unlock();
1618 } else {
1619 rcu_read_unlock();
1620 parent = data.victim->d_parent;
1621 if (parent != data.victim)
1622 __dput_to_list(parent, &data.dispose);
1623 __dentry_kill(data.victim);
1624 }
1625 }
1626 if (!list_empty(&data.dispose))
1627 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001630EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Al Viro9c8c10e2014-05-02 20:36:10 -04001632static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001633{
Al Viro9c8c10e2014-05-02 20:36:10 -04001634 /* it has busy descendents; complain about those instead */
1635 if (!list_empty(&dentry->d_subdirs))
1636 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001637
Al Viro9c8c10e2014-05-02 20:36:10 -04001638 /* root with refcount 1 is fine */
1639 if (dentry == _data && dentry->d_lockref.count == 1)
1640 return D_WALK_CONTINUE;
1641
1642 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1643 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001644 dentry,
1645 dentry->d_inode ?
1646 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001647 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001648 dentry->d_lockref.count,
1649 dentry->d_sb->s_type->name,
1650 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001651 WARN_ON(1);
1652 return D_WALK_CONTINUE;
1653}
1654
1655static void do_one_tree(struct dentry *dentry)
1656{
1657 shrink_dcache_parent(dentry);
Al Viro3a8e3612018-04-15 18:27:23 -04001658 d_walk(dentry, dentry, umount_check);
Al Viro9c8c10e2014-05-02 20:36:10 -04001659 d_drop(dentry);
1660 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001661}
1662
1663/*
1664 * destroy the dentries attached to a superblock on unmounting
1665 */
1666void shrink_dcache_for_umount(struct super_block *sb)
1667{
1668 struct dentry *dentry;
1669
Al Viro9c8c10e2014-05-02 20:36:10 -04001670 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001671
1672 dentry = sb->s_root;
1673 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001674 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001675
NeilBrownf1ee6162017-12-21 09:45:40 +11001676 while (!hlist_bl_empty(&sb->s_roots)) {
1677 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001678 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001679 }
1680}
1681
Al Viroff17fa52018-04-15 18:21:47 -04001682static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001683{
Al Viroff17fa52018-04-15 18:21:47 -04001684 struct dentry **victim = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001685 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001686 __dget_dlock(dentry);
Al Viroff17fa52018-04-15 18:21:47 -04001687 *victim = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001688 return D_WALK_QUIT;
1689 }
Al Viroff17fa52018-04-15 18:21:47 -04001690 return D_WALK_CONTINUE;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001691}
1692
1693/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001694 * d_invalidate - detach submounts, prune dcache, and drop
1695 * @dentry: dentry to invalidate (aka detach, prune and drop)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001696 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001697void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001698{
Al Viroff17fa52018-04-15 18:21:47 -04001699 bool had_submounts = false;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001700 spin_lock(&dentry->d_lock);
1701 if (d_unhashed(dentry)) {
1702 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001703 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001704 }
Al Viroff17fa52018-04-15 18:21:47 -04001705 __d_drop(dentry);
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001706 spin_unlock(&dentry->d_lock);
1707
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001708 /* Negative dentries can be dropped without further checks */
Al Viroff17fa52018-04-15 18:21:47 -04001709 if (!dentry->d_inode)
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001710 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001711
Al Viroff17fa52018-04-15 18:21:47 -04001712 shrink_dcache_parent(dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001713 for (;;) {
Al Viroff17fa52018-04-15 18:21:47 -04001714 struct dentry *victim = NULL;
Al Viro3a8e3612018-04-15 18:27:23 -04001715 d_walk(dentry, &victim, find_submount);
Al Viroff17fa52018-04-15 18:21:47 -04001716 if (!victim) {
1717 if (had_submounts)
1718 shrink_dcache_parent(dentry);
Al Viro81be24d2017-06-03 07:20:09 +01001719 return;
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001720 }
Al Viroff17fa52018-04-15 18:21:47 -04001721 had_submounts = true;
1722 detach_mounts(victim);
1723 dput(victim);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001724 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001725}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001726EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001727
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728/**
Al Viroa4464db2011-07-07 15:03:58 -04001729 * __d_alloc - allocate a dcache entry
1730 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 * @name: qstr of the name
1732 *
1733 * Allocates a dentry. It returns %NULL if there is insufficient memory
1734 * available. On a success the dentry is returned. The name passed in is
1735 * copied and the copy passed in may be reused after this call.
1736 */
1737
Al Viro5c8b0df2019-10-25 14:08:24 -04001738static struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739{
1740 struct dentry *dentry;
1741 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001742 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743
Mel Gormane12ba742007-10-16 01:25:52 -07001744 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 if (!dentry)
1746 return NULL;
1747
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001748 /*
1749 * We guarantee that the inline name is always NUL-terminated.
1750 * This way the memcpy() done by the name switching in rename
1751 * will still always have a NUL at the end, even if we might
1752 * be overwriting an internal NUL character
1753 */
1754 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001755 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001756 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001757 dname = dentry->d_iname;
1758 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001759 size_t size = offsetof(struct external_name, name[1]);
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001760 struct external_name *p = kmalloc(size + name->len,
1761 GFP_KERNEL_ACCOUNT |
1762 __GFP_RECLAIMABLE);
1763 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 kmem_cache_free(dentry_cache, dentry);
1765 return NULL;
1766 }
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07001767 atomic_set(&p->u.count, 1);
1768 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 } else {
1770 dname = dentry->d_iname;
1771 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
1773 dentry->d_name.len = name->len;
1774 dentry->d_name.hash = name->hash;
1775 memcpy(dname, name->name, name->len);
1776 dname[name->len] = 0;
1777
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001778 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001779 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001780
Waiman Long98474232013-08-28 18:24:59 -07001781 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001782 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 spin_lock_init(&dentry->d_lock);
Ahmed S. Darwish26475372020-07-20 17:55:24 +02001784 seqcount_spinlock_init(&dentry->d_seq, &dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001786 dentry->d_parent = dentry;
1787 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 dentry->d_op = NULL;
1789 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001790 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 INIT_LIST_HEAD(&dentry->d_lru);
1792 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001793 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1794 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001795 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
Miklos Szeredi285b1022016-06-28 11:47:32 +02001797 if (dentry->d_op && dentry->d_op->d_init) {
1798 err = dentry->d_op->d_init(dentry);
1799 if (err) {
1800 if (dname_external(dentry))
1801 kfree(external_name(dentry));
1802 kmem_cache_free(dentry_cache, dentry);
1803 return NULL;
1804 }
1805 }
1806
Nick Piggin3e880fb2011-01-07 17:49:19 +11001807 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001808
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 return dentry;
1810}
Al Viroa4464db2011-07-07 15:03:58 -04001811
1812/**
1813 * d_alloc - allocate a dcache entry
1814 * @parent: parent of entry to allocate
1815 * @name: qstr of the name
1816 *
1817 * Allocates a dentry. It returns %NULL if there is insufficient memory
1818 * available. On a success the dentry is returned. The name passed in is
1819 * copied and the copy passed in may be reused after this call.
1820 */
1821struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1822{
1823 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1824 if (!dentry)
1825 return NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001826 spin_lock(&parent->d_lock);
1827 /*
1828 * don't need child lock because it is not subject
1829 * to concurrency here
1830 */
1831 __dget_dlock(parent);
1832 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001833 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001834 spin_unlock(&parent->d_lock);
1835
1836 return dentry;
1837}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001838EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
Miklos Szeredif9c34672018-01-19 11:39:52 +01001840struct dentry *d_alloc_anon(struct super_block *sb)
1841{
1842 return __d_alloc(sb, NULL);
1843}
1844EXPORT_SYMBOL(d_alloc_anon);
1845
Al Viroba65dc52016-06-10 11:32:47 -04001846struct dentry *d_alloc_cursor(struct dentry * parent)
1847{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001848 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001849 if (dentry) {
Al Viro5467a682019-03-15 22:23:19 -04001850 dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viroba65dc52016-06-10 11:32:47 -04001851 dentry->d_parent = dget(parent);
1852 }
1853 return dentry;
1854}
1855
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001856/**
1857 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1858 * @sb: the superblock
1859 * @name: qstr of the name
1860 *
1861 * For a filesystem that just pins its dentries in memory and never
1862 * performs lookups at all, return an unhashed IS_ROOT dentry.
Al Viro5467a682019-03-15 22:23:19 -04001863 * This is used for pipes, sockets et.al. - the stuff that should
1864 * never be anyone's children or parents. Unlike all other
1865 * dentries, these will not have RCU delay between dropping the
1866 * last reference and freeing them.
Al Viroab1152d2019-03-15 22:58:11 -04001867 *
1868 * The only user is alloc_file_pseudo() and that's what should
1869 * be considered a public interface. Don't use directly.
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001870 */
Nick Piggin4b936882011-01-07 17:50:07 +11001871struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1872{
Al Viro5467a682019-03-15 22:23:19 -04001873 struct dentry *dentry = __d_alloc(sb, name);
1874 if (likely(dentry))
1875 dentry->d_flags |= DCACHE_NORCU;
1876 return dentry;
Nick Piggin4b936882011-01-07 17:50:07 +11001877}
Nick Piggin4b936882011-01-07 17:50:07 +11001878
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1880{
1881 struct qstr q;
1882
1883 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001884 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 return d_alloc(parent, &q);
1886}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001887EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
Nick Pigginfb045ad2011-01-07 17:49:55 +11001889void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1890{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001891 WARN_ON_ONCE(dentry->d_op);
1892 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001893 DCACHE_OP_COMPARE |
1894 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001895 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001896 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001897 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001898 dentry->d_op = op;
1899 if (!op)
1900 return;
1901 if (op->d_hash)
1902 dentry->d_flags |= DCACHE_OP_HASH;
1903 if (op->d_compare)
1904 dentry->d_flags |= DCACHE_OP_COMPARE;
1905 if (op->d_revalidate)
1906 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001907 if (op->d_weak_revalidate)
1908 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001909 if (op->d_delete)
1910 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001911 if (op->d_prune)
1912 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001913 if (op->d_real)
1914 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001915
1916}
1917EXPORT_SYMBOL(d_set_d_op);
1918
David Howellsdf1a0852015-01-29 12:02:28 +00001919
1920/*
1921 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1922 * @dentry - The dentry to mark
1923 *
1924 * Mark a dentry as falling through to the lower layer (as set with
1925 * d_pin_lower()). This flag may be recorded on the medium.
1926 */
1927void d_set_fallthru(struct dentry *dentry)
1928{
1929 spin_lock(&dentry->d_lock);
1930 dentry->d_flags |= DCACHE_FALLTHRU;
1931 spin_unlock(&dentry->d_lock);
1932}
1933EXPORT_SYMBOL(d_set_fallthru);
1934
David Howellsb18825a2013-09-12 19:22:53 +01001935static unsigned d_flags_for_inode(struct inode *inode)
1936{
David Howells44bdb5e2015-01-29 12:02:29 +00001937 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001938
1939 if (!inode)
1940 return DCACHE_MISS_TYPE;
1941
1942 if (S_ISDIR(inode->i_mode)) {
1943 add_flags = DCACHE_DIRECTORY_TYPE;
1944 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1945 if (unlikely(!inode->i_op->lookup))
1946 add_flags = DCACHE_AUTODIR_TYPE;
1947 else
1948 inode->i_opflags |= IOP_LOOKUP;
1949 }
David Howells44bdb5e2015-01-29 12:02:29 +00001950 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001951 }
1952
David Howells44bdb5e2015-01-29 12:02:29 +00001953 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001954 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001955 add_flags = DCACHE_SYMLINK_TYPE;
1956 goto type_determined;
1957 }
1958 inode->i_opflags |= IOP_NOFOLLOW;
1959 }
1960
1961 if (unlikely(!S_ISREG(inode->i_mode)))
1962 add_flags = DCACHE_SPECIAL_TYPE;
1963
1964type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001965 if (unlikely(IS_AUTOMOUNT(inode)))
1966 add_flags |= DCACHE_NEED_AUTOMOUNT;
1967 return add_flags;
1968}
1969
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001970static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1971{
David Howellsb18825a2013-09-12 19:22:53 +01001972 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001973 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001974
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001975 spin_lock(&dentry->d_lock);
Waiman Longaf0c9af2019-01-30 13:52:38 -05001976 /*
1977 * Decrement negative dentry count if it was in the LRU list.
1978 */
1979 if (dentry->d_flags & DCACHE_LRU_LIST)
1980 this_cpu_dec(nr_dentry_negative);
Al Virode689f52016-03-09 18:05:42 -05001981 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001982 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001983 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001984 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001985 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001986 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001987}
1988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989/**
1990 * d_instantiate - fill in inode information for a dentry
1991 * @entry: dentry to complete
1992 * @inode: inode to attach to this dentry
1993 *
1994 * Fill in inode information in the entry.
1995 *
1996 * This turns negative dentries into productive full members
1997 * of society.
1998 *
1999 * NOTE! This assumes that the inode count has been incremented
2000 * (or otherwise set) by the caller to indicate that it is now
2001 * in use by the dcache.
2002 */
2003
2004void d_instantiate(struct dentry *entry, struct inode * inode)
2005{
Al Viro946e51f2014-10-26 19:19:16 -04002006 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05002007 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04002008 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002009 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05002010 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002011 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05002012 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002014EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
Al Viro1e2e5472018-05-04 08:23:01 -04002016/*
2017 * This should be equivalent to d_instantiate() + unlock_new_inode(),
2018 * with lockdep-related part of unlock_new_inode() done before
2019 * anything else. Use that instead of open-coding d_instantiate()/
2020 * unlock_new_inode() combinations.
2021 */
2022void d_instantiate_new(struct dentry *entry, struct inode *inode)
2023{
2024 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
2025 BUG_ON(!inode);
2026 lockdep_annotate_inode_mutex_key(inode);
2027 security_d_instantiate(entry, inode);
2028 spin_lock(&inode->i_lock);
2029 __d_instantiate(entry, inode);
2030 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04002031 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro1e2e5472018-05-04 08:23:01 -04002032 smp_mb();
2033 wake_up_bit(&inode->i_state, __I_NEW);
2034 spin_unlock(&inode->i_lock);
2035}
2036EXPORT_SYMBOL(d_instantiate_new);
2037
Al Viroadc0e91a2012-01-08 16:49:21 -05002038struct dentry *d_make_root(struct inode *root_inode)
2039{
2040 struct dentry *res = NULL;
2041
2042 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01002043 res = d_alloc_anon(root_inode->i_sb);
Al Viro5467a682019-03-15 22:23:19 -04002044 if (res)
Al Viroadc0e91a2012-01-08 16:49:21 -05002045 d_instantiate(res, root_inode);
Al Viro5467a682019-03-15 22:23:19 -04002046 else
Al Viroadc0e91a2012-01-08 16:49:21 -05002047 iput(root_inode);
2048 }
2049 return res;
2050}
2051EXPORT_SYMBOL(d_make_root);
2052
Miklos Szeredif9c34672018-01-19 11:39:52 +01002053static struct dentry *__d_instantiate_anon(struct dentry *dentry,
2054 struct inode *inode,
2055 bool disconnected)
2056{
2057 struct dentry *res;
2058 unsigned add_flags;
2059
2060 security_d_instantiate(dentry, inode);
2061 spin_lock(&inode->i_lock);
2062 res = __d_find_any_alias(inode);
2063 if (res) {
2064 spin_unlock(&inode->i_lock);
2065 dput(dentry);
2066 goto out_iput;
2067 }
2068
2069 /* attach a disconnected dentry */
2070 add_flags = d_flags_for_inode(inode);
2071
2072 if (disconnected)
2073 add_flags |= DCACHE_DISCONNECTED;
2074
2075 spin_lock(&dentry->d_lock);
2076 __d_set_inode_and_type(dentry, inode, add_flags);
2077 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08002078 if (!disconnected) {
2079 hlist_bl_lock(&dentry->d_sb->s_roots);
2080 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
2081 hlist_bl_unlock(&dentry->d_sb->s_roots);
2082 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01002083 spin_unlock(&dentry->d_lock);
2084 spin_unlock(&inode->i_lock);
2085
2086 return dentry;
2087
2088 out_iput:
2089 iput(inode);
2090 return res;
2091}
2092
2093struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2094{
2095 return __d_instantiate_anon(dentry, inode, true);
2096}
2097EXPORT_SYMBOL(d_instantiate_anon);
2098
2099static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002100{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002101 struct dentry *tmp;
2102 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002103
2104 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002105 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002106 if (IS_ERR(inode))
2107 return ERR_CAST(inode);
2108
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002109 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002110 if (res)
2111 goto out_iput;
2112
Miklos Szeredif9c34672018-01-19 11:39:52 +01002113 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002114 if (!tmp) {
2115 res = ERR_PTR(-ENOMEM);
2116 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002117 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002118
Miklos Szeredif9c34672018-01-19 11:39:52 +01002119 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002120
Miklos Szeredif9c34672018-01-19 11:39:52 +01002121out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002122 iput(inode);
2123 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002124}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002125
2126/**
2127 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2128 * @inode: inode to allocate the dentry for
2129 *
2130 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2131 * similar open by handle operations. The returned dentry may be anonymous,
2132 * or may have a full name (if the inode was already in the cache).
2133 *
2134 * When called on a directory inode, we must ensure that the inode only ever
2135 * has one dentry. If a dentry is found, that is returned instead of
2136 * allocating a new one.
2137 *
2138 * On successful return, the reference to the inode has been transferred
2139 * to the dentry. In case of an error the reference on the inode is released.
2140 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2141 * be passed in and the error will be propagated to the return value,
2142 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2143 */
2144struct dentry *d_obtain_alias(struct inode *inode)
2145{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002146 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002147}
Benny Halevyadc48722009-02-27 14:02:59 -08002148EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149
2150/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002151 * d_obtain_root - find or allocate a dentry for a given inode
2152 * @inode: inode to allocate the dentry for
2153 *
2154 * Obtain an IS_ROOT dentry for the root of a filesystem.
2155 *
2156 * We must ensure that directory inodes only ever have one dentry. If a
2157 * dentry is found, that is returned instead of allocating a new one.
2158 *
2159 * On successful return, the reference to the inode has been transferred
2160 * to the dentry. In case of an error the reference on the inode is
2161 * released. A %NULL or IS_ERR inode may be passed in and will be the
2162 * error will be propagate to the return value, with a %NULL @inode
2163 * replaced by ERR_PTR(-ESTALE).
2164 */
2165struct dentry *d_obtain_root(struct inode *inode)
2166{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002167 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002168}
2169EXPORT_SYMBOL(d_obtain_root);
2170
2171/**
Barry Naujok94035402008-05-21 16:50:46 +10002172 * d_add_ci - lookup or allocate new dentry with case-exact name
2173 * @inode: the inode case-insensitive lookup has found
2174 * @dentry: the negative dentry that was passed to the parent's lookup func
2175 * @name: the case-exact name to be associated with the returned dentry
2176 *
2177 * This is to avoid filling the dcache with case-insensitive names to the
2178 * same inode, only the actual correct case is stored in the dcache for
2179 * case-insensitive filesystems.
2180 *
Randy Dunlap3d742d42021-02-24 12:00:48 -08002181 * For a case-insensitive lookup match and if the case-exact dentry
2182 * already exists in the dcache, use it and return it.
Barry Naujok94035402008-05-21 16:50:46 +10002183 *
2184 * If no entry exists with the exact case name, allocate new dentry with
2185 * the exact case, and return the spliced entry.
2186 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002187struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002188 struct qstr *name)
2189{
Al Virod9171b92016-04-15 03:33:13 -04002190 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002191
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002192 /*
2193 * First check if a dentry matching the name already exists,
2194 * if not go ahead and create it now.
2195 */
Barry Naujok94035402008-05-21 16:50:46 +10002196 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002197 if (found) {
2198 iput(inode);
2199 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002200 }
Al Virod9171b92016-04-15 03:33:13 -04002201 if (d_in_lookup(dentry)) {
2202 found = d_alloc_parallel(dentry->d_parent, name,
2203 dentry->d_wait);
2204 if (IS_ERR(found) || !d_in_lookup(found)) {
2205 iput(inode);
2206 return found;
2207 }
2208 } else {
2209 found = d_alloc(dentry->d_parent, name);
2210 if (!found) {
2211 iput(inode);
2212 return ERR_PTR(-ENOMEM);
2213 }
2214 }
2215 res = d_splice_alias(inode, found);
2216 if (res) {
2217 dput(found);
2218 return res;
2219 }
Al Viro4f522a22013-02-11 23:20:37 -05002220 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002221}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002222EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002224
Al Virod4c91a82016-06-25 23:33:49 -04002225static inline bool d_same_name(const struct dentry *dentry,
2226 const struct dentry *parent,
2227 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002228{
Al Virod4c91a82016-06-25 23:33:49 -04002229 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2230 if (dentry->d_name.len != name->len)
2231 return false;
2232 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002233 }
Al Viro6fa67e72016-07-31 16:37:25 -04002234 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002235 dentry->d_name.len, dentry->d_name.name,
2236 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002237}
2238
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002240 * __d_lookup_rcu - search for a dentry (racy, store-free)
2241 * @parent: parent dentry
2242 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002243 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002244 * Returns: dentry, or NULL
2245 *
2246 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2247 * resolution (store-free path walking) design described in
2248 * Documentation/filesystems/path-lookup.txt.
2249 *
2250 * This is not to be used outside core vfs.
2251 *
2252 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2253 * held, and rcu_read_lock held. The returned dentry must not be stored into
2254 * without taking d_lock and checking d_seq sequence count against @seq
2255 * returned here.
2256 *
Linus Torvalds15570082013-09-02 11:38:06 -07002257 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002258 * function.
2259 *
2260 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2261 * the returned dentry, so long as its parent's seqlock is checked after the
2262 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2263 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002264 *
2265 * NOTE! The caller *has* to check the resulting dentry against the sequence
2266 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002267 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002268struct dentry *__d_lookup_rcu(const struct dentry *parent,
2269 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002270 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002271{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002272 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002273 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002274 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002275 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002276 struct dentry *dentry;
2277
2278 /*
2279 * Note: There is significant duplication with __d_lookup_rcu which is
2280 * required to prevent single threaded performance regressions
2281 * especially on architectures where smp_rmb (in seqcounts) are costly.
2282 * Keep the two functions in sync.
2283 */
2284
2285 /*
2286 * The hash list is protected using RCU.
2287 *
2288 * Carefully use d_seq when comparing a candidate dentry, to avoid
2289 * races with d_move().
2290 *
2291 * It is possible that concurrent renames can mess up our list
2292 * walk here and result in missing our dentry, resulting in the
2293 * false-negative result. d_lookup() protects against concurrent
2294 * renames using rename_lock seqlock.
2295 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002296 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002297 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002298 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002299 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002300
Nick Piggin31e6b012011-01-07 17:49:52 +11002301seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002302 /*
2303 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002304 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002305 *
2306 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002307 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002308 *
2309 * NOTE! We do a "raw" seqcount_begin here. That means that
2310 * we don't wait for the sequence count to stabilize if it
2311 * is in the middle of a sequence change. If we do the slow
2312 * dentry compare, we will do seqretries until it is stable,
2313 * and if we end up with a successful lookup, we actually
2314 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002315 *
2316 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2317 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002318 */
2319 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002320 if (dentry->d_parent != parent)
2321 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002322 if (d_unhashed(dentry))
2323 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002324
2325 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002326 int tlen;
2327 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002328 if (dentry->d_name.hash != hashlen_hash(hashlen))
2329 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002330 tlen = dentry->d_name.len;
2331 tname = dentry->d_name.name;
2332 /* we want a consistent (name,len) pair */
2333 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2334 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002335 goto seqretry;
2336 }
Al Viro6fa67e72016-07-31 16:37:25 -04002337 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002338 tlen, tname, name) != 0)
2339 continue;
2340 } else {
2341 if (dentry->d_name.hash_len != hashlen)
2342 continue;
2343 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2344 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002345 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002346 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002347 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002348 }
2349 return NULL;
2350}
2351
2352/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 * d_lookup - search for a dentry
2354 * @parent: parent dentry
2355 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002356 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002358 * d_lookup searches the children of the parent dentry for the name in
2359 * question. If the dentry is found its reference count is incremented and the
2360 * dentry is returned. The caller must use dput to free the entry when it has
2361 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 */
Al Viroda2d8452013-01-24 18:29:34 -05002363struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364{
Nick Piggin31e6b012011-01-07 17:49:52 +11002365 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002366 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367
Daeseok Younb8314f92014-08-11 11:46:53 +09002368 do {
2369 seq = read_seqbegin(&rename_lock);
2370 dentry = __d_lookup(parent, name);
2371 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 break;
2373 } while (read_seqretry(&rename_lock, seq));
2374 return dentry;
2375}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002376EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377
Nick Piggin31e6b012011-01-07 17:49:52 +11002378/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002379 * __d_lookup - search for a dentry (racy)
2380 * @parent: parent dentry
2381 * @name: qstr of name we wish to find
2382 * Returns: dentry, or NULL
2383 *
2384 * __d_lookup is like d_lookup, however it may (rarely) return a
2385 * false-negative result due to unrelated rename activity.
2386 *
2387 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2388 * however it must be used carefully, eg. with a following d_lookup in
2389 * the case of failure.
2390 *
2391 * __d_lookup callers must be commented.
2392 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002393struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002396 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002397 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002398 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002399 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Nick Pigginb04f7842010-08-18 04:37:34 +10002401 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002402 * Note: There is significant duplication with __d_lookup_rcu which is
2403 * required to prevent single threaded performance regressions
2404 * especially on architectures where smp_rmb (in seqcounts) are costly.
2405 * Keep the two functions in sync.
2406 */
2407
2408 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002409 * The hash list is protected using RCU.
2410 *
2411 * Take d_lock when comparing a candidate dentry, to avoid races
2412 * with d_move().
2413 *
2414 * It is possible that concurrent renames can mess up our list
2415 * walk here and result in missing our dentry, resulting in the
2416 * false-negative result. d_lookup() protects against concurrent
2417 * renames using rename_lock seqlock.
2418 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002419 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002420 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 rcu_read_lock();
2422
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002423 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 if (dentry->d_name.hash != hash)
2426 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427
2428 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 if (dentry->d_parent != parent)
2430 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002431 if (d_unhashed(dentry))
2432 goto next;
2433
Al Virod4c91a82016-06-25 23:33:49 -04002434 if (!d_same_name(dentry, parent, name))
2435 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Waiman Long98474232013-08-28 18:24:59 -07002437 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002438 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 spin_unlock(&dentry->d_lock);
2440 break;
2441next:
2442 spin_unlock(&dentry->d_lock);
2443 }
2444 rcu_read_unlock();
2445
2446 return found;
2447}
2448
2449/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002450 * d_hash_and_lookup - hash the qstr then search for a dentry
2451 * @dir: Directory to search in
2452 * @name: qstr of name we wish to find
2453 *
Al Viro4f522a22013-02-11 23:20:37 -05002454 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002455 */
2456struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2457{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002458 /*
2459 * Check for a fs-specific hash function. Note that we must
2460 * calculate the standard hash first, as the d_op->d_hash()
2461 * routine may choose to leave the hash value unchanged.
2462 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002463 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002464 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002465 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002466 if (unlikely(err < 0))
2467 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002468 }
Al Viro4f522a22013-02-11 23:20:37 -05002469 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002470}
Al Viro4f522a22013-02-11 23:20:37 -05002471EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002472
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473/*
2474 * When a file is deleted, we have two options:
2475 * - turn this dentry into a negative dentry
2476 * - unhash this dentry and free it.
2477 *
2478 * Usually, we want to just turn this into
2479 * a negative dentry, but if anybody else is
2480 * currently using the dentry or the inode
2481 * we can't do that and we fall back on removing
2482 * it from the hash queues and waiting for
2483 * it to be deleted later when it has no users
2484 */
2485
2486/**
2487 * d_delete - delete a dentry
2488 * @dentry: The dentry to delete
2489 *
2490 * Turn the dentry into a negative dentry if possible, otherwise
2491 * remove it from the hash queues so it can be deleted later
2492 */
2493
2494void d_delete(struct dentry * dentry)
2495{
Al Viroc19457f2018-02-23 21:02:31 -05002496 struct inode *inode = dentry->d_inode;
Al Viroc19457f2018-02-23 21:02:31 -05002497
2498 spin_lock(&inode->i_lock);
2499 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 /*
2501 * Are we the only user?
2502 */
Waiman Long98474232013-08-28 18:24:59 -07002503 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002504 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002505 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002506 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002508 spin_unlock(&dentry->d_lock);
2509 spin_unlock(&inode->i_lock);
2510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002512EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513
Al Viro15d3c582016-07-29 17:45:21 -04002514static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515{
Al Viro15d3c582016-07-29 17:45:21 -04002516 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002517
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002518 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002519 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002520 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521}
2522
2523/**
2524 * d_rehash - add an entry back to the hash
2525 * @entry: dentry to add to the hash
2526 *
2527 * Adds a dentry to the hash according to its name.
2528 */
2529
2530void d_rehash(struct dentry * entry)
2531{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002533 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002536EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537
Al Viro84e710d2016-04-15 00:58:55 -04002538static inline unsigned start_dir_add(struct inode *dir)
2539{
2540
2541 for (;;) {
2542 unsigned n = dir->i_dir_seq;
2543 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2544 return n;
2545 cpu_relax();
2546 }
2547}
2548
2549static inline void end_dir_add(struct inode *dir, unsigned n)
2550{
2551 smp_store_release(&dir->i_dir_seq, n + 2);
2552}
2553
Al Virod9171b92016-04-15 03:33:13 -04002554static void d_wait_lookup(struct dentry *dentry)
2555{
2556 if (d_in_lookup(dentry)) {
2557 DECLARE_WAITQUEUE(wait, current);
2558 add_wait_queue(dentry->d_wait, &wait);
2559 do {
2560 set_current_state(TASK_UNINTERRUPTIBLE);
2561 spin_unlock(&dentry->d_lock);
2562 schedule();
2563 spin_lock(&dentry->d_lock);
2564 } while (d_in_lookup(dentry));
2565 }
2566}
2567
Al Viro94bdd652016-04-15 02:42:04 -04002568struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002569 const struct qstr *name,
2570 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002571{
Al Viro94bdd652016-04-15 02:42:04 -04002572 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002573 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2574 struct hlist_bl_node *node;
2575 struct dentry *new = d_alloc(parent, name);
2576 struct dentry *dentry;
2577 unsigned seq, r_seq, d_seq;
2578
2579 if (unlikely(!new))
2580 return ERR_PTR(-ENOMEM);
2581
2582retry:
2583 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002584 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002585 r_seq = read_seqbegin(&rename_lock);
2586 dentry = __d_lookup_rcu(parent, name, &d_seq);
2587 if (unlikely(dentry)) {
2588 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2589 rcu_read_unlock();
2590 goto retry;
2591 }
2592 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2593 rcu_read_unlock();
2594 dput(dentry);
2595 goto retry;
2596 }
2597 rcu_read_unlock();
2598 dput(new);
2599 return dentry;
2600 }
2601 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2602 rcu_read_unlock();
2603 goto retry;
2604 }
Will Deacon015555f2018-02-19 14:55:54 +00002605
2606 if (unlikely(seq & 1)) {
2607 rcu_read_unlock();
2608 goto retry;
2609 }
2610
Al Viro94bdd652016-04-15 02:42:04 -04002611 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002612 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002613 hlist_bl_unlock(b);
2614 rcu_read_unlock();
2615 goto retry;
2616 }
Al Viro94bdd652016-04-15 02:42:04 -04002617 /*
2618 * No changes for the parent since the beginning of d_lookup().
2619 * Since all removals from the chain happen with hlist_bl_lock(),
2620 * any potential in-lookup matches are going to stay here until
2621 * we unlock the chain. All fields are stable in everything
2622 * we encounter.
2623 */
2624 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2625 if (dentry->d_name.hash != hash)
2626 continue;
2627 if (dentry->d_parent != parent)
2628 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002629 if (!d_same_name(dentry, parent, name))
2630 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002631 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002632 /* now we can try to grab a reference */
2633 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2634 rcu_read_unlock();
2635 goto retry;
2636 }
2637
2638 rcu_read_unlock();
2639 /*
2640 * somebody is likely to be still doing lookup for it;
2641 * wait for them to finish
2642 */
Al Virod9171b92016-04-15 03:33:13 -04002643 spin_lock(&dentry->d_lock);
2644 d_wait_lookup(dentry);
2645 /*
2646 * it's not in-lookup anymore; in principle we should repeat
2647 * everything from dcache lookup, but it's likely to be what
2648 * d_lookup() would've found anyway. If it is, just return it;
2649 * otherwise we really have to repeat the whole thing.
2650 */
2651 if (unlikely(dentry->d_name.hash != hash))
2652 goto mismatch;
2653 if (unlikely(dentry->d_parent != parent))
2654 goto mismatch;
2655 if (unlikely(d_unhashed(dentry)))
2656 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002657 if (unlikely(!d_same_name(dentry, parent, name)))
2658 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002659 /* OK, it *is* a hashed match; return it */
2660 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002661 dput(new);
2662 return dentry;
2663 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002664 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002665 /* we can't take ->d_lock here; it's OK, though. */
2666 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002667 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002668 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2669 hlist_bl_unlock(b);
2670 return new;
Al Virod9171b92016-04-15 03:33:13 -04002671mismatch:
2672 spin_unlock(&dentry->d_lock);
2673 dput(dentry);
2674 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002675}
2676EXPORT_SYMBOL(d_alloc_parallel);
2677
Al Viro85c7f812016-04-14 19:52:13 -04002678void __d_lookup_done(struct dentry *dentry)
2679{
Al Viro94bdd652016-04-15 02:42:04 -04002680 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2681 dentry->d_name.hash);
2682 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002683 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002684 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002685 wake_up_all(dentry->d_wait);
2686 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002687 hlist_bl_unlock(b);
2688 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002689 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002690}
2691EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002692
2693/* inode->i_lock held if inode is non-NULL */
2694
2695static inline void __d_add(struct dentry *dentry, struct inode *inode)
2696{
Al Viro84e710d2016-04-15 00:58:55 -04002697 struct inode *dir = NULL;
2698 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002699 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002700 if (unlikely(d_in_lookup(dentry))) {
2701 dir = dentry->d_parent->d_inode;
2702 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002703 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002704 }
Al Viroed782b52016-03-09 19:52:39 -05002705 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002706 unsigned add_flags = d_flags_for_inode(inode);
2707 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2708 raw_write_seqcount_begin(&dentry->d_seq);
2709 __d_set_inode_and_type(dentry, inode, add_flags);
2710 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002711 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002712 }
Al Viro15d3c582016-07-29 17:45:21 -04002713 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002714 if (dir)
2715 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002716 spin_unlock(&dentry->d_lock);
2717 if (inode)
2718 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002719}
2720
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002721/**
Al Viro34d0d192016-03-08 21:01:03 -05002722 * d_add - add dentry to hash queues
2723 * @entry: dentry to add
2724 * @inode: The inode to attach to this dentry
2725 *
2726 * This adds the entry to the hash queues and initializes @inode.
2727 * The entry was actually filled in earlier during d_alloc().
2728 */
2729
2730void d_add(struct dentry *entry, struct inode *inode)
2731{
Al Virob9680912016-04-11 00:53:26 -04002732 if (inode) {
2733 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002734 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002735 }
Al Viroed782b52016-03-09 19:52:39 -05002736 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002737}
2738EXPORT_SYMBOL(d_add);
2739
2740/**
Al Viro668d0cd2016-03-08 12:44:17 -05002741 * d_exact_alias - find and hash an exact unhashed alias
2742 * @entry: dentry to add
2743 * @inode: The inode to go with this dentry
2744 *
2745 * If an unhashed dentry with the same name/parent and desired
2746 * inode already exists, hash and return it. Otherwise, return
2747 * NULL.
2748 *
2749 * Parent directory should be locked.
2750 */
2751struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2752{
2753 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002754 unsigned int hash = entry->d_name.hash;
2755
2756 spin_lock(&inode->i_lock);
2757 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2758 /*
2759 * Don't need alias->d_lock here, because aliases with
2760 * d_parent == entry->d_parent are not subject to name or
2761 * parent changes, because the parent inode i_mutex is held.
2762 */
2763 if (alias->d_name.hash != hash)
2764 continue;
2765 if (alias->d_parent != entry->d_parent)
2766 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002767 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002768 continue;
2769 spin_lock(&alias->d_lock);
2770 if (!d_unhashed(alias)) {
2771 spin_unlock(&alias->d_lock);
2772 alias = NULL;
2773 } else {
2774 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002775 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002776 spin_unlock(&alias->d_lock);
2777 }
2778 spin_unlock(&inode->i_lock);
2779 return alias;
2780 }
2781 spin_unlock(&inode->i_lock);
2782 return NULL;
2783}
2784EXPORT_SYMBOL(d_exact_alias);
2785
Al Viro8d85b482014-09-29 14:54:27 -04002786static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787{
Al Viro8d85b482014-09-29 14:54:27 -04002788 if (unlikely(dname_external(target))) {
2789 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 /*
2791 * Both external: swap the pointers
2792 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002793 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 } else {
2795 /*
2796 * dentry:internal, target:external. Steal target's
2797 * storage and make target internal.
2798 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002799 memcpy(target->d_iname, dentry->d_name.name,
2800 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 dentry->d_name.name = target->d_name.name;
2802 target->d_name.name = target->d_iname;
2803 }
2804 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002805 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 /*
2807 * dentry:external, target:internal. Give dentry's
2808 * storage to target and make dentry internal
2809 */
2810 memcpy(dentry->d_iname, target->d_name.name,
2811 target->d_name.len + 1);
2812 target->d_name.name = dentry->d_name.name;
2813 dentry->d_name.name = dentry->d_iname;
2814 } else {
2815 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002816 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002818 unsigned int i;
2819 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2820 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2821 swap(((long *) &dentry->d_iname)[i],
2822 ((long *) &target->d_iname)[i]);
2823 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 }
2825 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002826 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827}
2828
Al Viro8d85b482014-09-29 14:54:27 -04002829static void copy_name(struct dentry *dentry, struct dentry *target)
2830{
2831 struct external_name *old_name = NULL;
2832 if (unlikely(dname_external(dentry)))
2833 old_name = external_name(dentry);
2834 if (unlikely(dname_external(target))) {
2835 atomic_inc(&external_name(target)->u.count);
2836 dentry->d_name = target->d_name;
2837 } else {
2838 memcpy(dentry->d_iname, target->d_name.name,
2839 target->d_name.len + 1);
2840 dentry->d_name.name = dentry->d_iname;
2841 dentry->d_name.hash_len = target->d_name.hash_len;
2842 }
2843 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
Vlastimil Babka2e03b4b2018-10-26 15:05:41 -07002844 kfree_rcu(old_name, u.head);
Al Viro8d85b482014-09-29 14:54:27 -04002845}
2846
Trond Myklebust9eaef272006-10-21 10:24:20 -07002847/*
Al Viro18367502011-07-12 21:42:24 -04002848 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849 * @dentry: entry to move
2850 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002851 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852 *
2853 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002854 * dcache entries should not be moved in this way. Caller must hold
2855 * rename_lock, the i_mutex of the source and target directories,
2856 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002858static void __d_move(struct dentry *dentry, struct dentry *target,
2859 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860{
Al Viro42177002018-03-11 15:15:46 -04002861 struct dentry *old_parent, *p;
Al Viro84e710d2016-04-15 00:58:55 -04002862 struct inode *dir = NULL;
2863 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864
Al Viro42177002018-03-11 15:15:46 -04002865 WARN_ON(!dentry->d_inode);
2866 if (WARN_ON(dentry == target))
2867 return;
2868
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002869 BUG_ON(d_ancestor(target, dentry));
Al Viro42177002018-03-11 15:15:46 -04002870 old_parent = dentry->d_parent;
2871 p = d_ancestor(old_parent, target);
2872 if (IS_ROOT(dentry)) {
2873 BUG_ON(p);
2874 spin_lock(&target->d_parent->d_lock);
2875 } else if (!p) {
2876 /* target is not a descendent of dentry->d_parent */
2877 spin_lock(&target->d_parent->d_lock);
2878 spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
2879 } else {
2880 BUG_ON(p == dentry);
2881 spin_lock(&old_parent->d_lock);
2882 if (p != target)
2883 spin_lock_nested(&target->d_parent->d_lock,
2884 DENTRY_D_LOCK_NESTED);
2885 }
2886 spin_lock_nested(&dentry->d_lock, 2);
2887 spin_lock_nested(&target->d_lock, 3);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002888
Al Viro84e710d2016-04-15 00:58:55 -04002889 if (unlikely(d_in_lookup(target))) {
2890 dir = target->d_parent->d_inode;
2891 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002892 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002893 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Nick Piggin31e6b012011-01-07 17:49:52 +11002895 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002896 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002897
Al Viro15d3c582016-07-29 17:45:21 -04002898 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002899 if (!d_unhashed(dentry))
2900 ___d_drop(dentry);
2901 if (!d_unhashed(target))
2902 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903
Al Viro63cf4272014-09-26 23:06:14 -04002904 /* ... and switch them in the tree */
Al Viro076515f2018-03-10 23:15:52 -05002905 dentry->d_parent = target->d_parent;
2906 if (!exchange) {
2907 copy_name(dentry, target);
2908 target->d_hash.pprev = NULL;
2909 dentry->d_parent->d_lockref.count++;
Al Viro5467a682019-03-15 22:23:19 -04002910 if (dentry != old_parent) /* wasn't IS_ROOT */
Al Viro076515f2018-03-10 23:15:52 -05002911 WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912 } else {
Al Viro076515f2018-03-10 23:15:52 -05002913 target->d_parent = old_parent;
2914 swap_names(dentry, target);
Al Viro946e51f2014-10-26 19:19:16 -04002915 list_move(&target->d_child, &target->d_parent->d_subdirs);
Al Viro076515f2018-03-10 23:15:52 -05002916 __d_rehash(target);
2917 fsnotify_update_flags(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 }
Al Viro076515f2018-03-10 23:15:52 -05002919 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
2920 __d_rehash(dentry);
2921 fsnotify_update_flags(dentry);
Eric Biggers0bf3d5c12019-03-20 11:39:11 -07002922 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923
Nick Piggin31e6b012011-01-07 17:49:52 +11002924 write_seqcount_end(&target->d_seq);
2925 write_seqcount_end(&dentry->d_seq);
2926
Al Viro84e710d2016-04-15 00:58:55 -04002927 if (dir)
2928 end_dir_add(dir, n);
Al Viro076515f2018-03-10 23:15:52 -05002929
2930 if (dentry->d_parent != old_parent)
2931 spin_unlock(&dentry->d_parent->d_lock);
2932 if (dentry != old_parent)
2933 spin_unlock(&old_parent->d_lock);
2934 spin_unlock(&target->d_lock);
2935 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002936}
2937
2938/*
2939 * d_move - move a dentry
2940 * @dentry: entry to move
2941 * @target: new dentry
2942 *
2943 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002944 * dcache entries should not be moved in this way. See the locking
2945 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002946 */
2947void d_move(struct dentry *dentry, struct dentry *target)
2948{
2949 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002950 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002952}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002953EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954
Miklos Szeredida1ce062014-04-01 17:08:43 +02002955/*
2956 * d_exchange - exchange two dentries
2957 * @dentry1: first dentry
2958 * @dentry2: second dentry
2959 */
2960void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2961{
2962 write_seqlock(&rename_lock);
2963
2964 WARN_ON(!dentry1->d_inode);
2965 WARN_ON(!dentry2->d_inode);
2966 WARN_ON(IS_ROOT(dentry1));
2967 WARN_ON(IS_ROOT(dentry2));
2968
2969 __d_move(dentry1, dentry2, true);
2970
2971 write_sequnlock(&rename_lock);
2972}
2973
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002974/**
2975 * d_ancestor - search for an ancestor
2976 * @p1: ancestor dentry
2977 * @p2: child dentry
2978 *
2979 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2980 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002981 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002982struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002983{
2984 struct dentry *p;
2985
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002986 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002987 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002988 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002989 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002990 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002991}
2992
2993/*
2994 * This helper attempts to cope with remotely renamed directories
2995 *
2996 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002997 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002998 *
2999 * Note: If ever the locking in lock_rename() changes, then please
3000 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07003001 */
Al Virob5ae6b12014-10-12 22:16:02 -04003002static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11003003 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07003004{
Al Viro9902af72016-04-15 15:08:36 -04003005 struct mutex *m1 = NULL;
3006 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05003007 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003008
3009 /* If alias and dentry share a parent, then no extra locks required */
3010 if (alias->d_parent == dentry->d_parent)
3011 goto out_unalias;
3012
Trond Myklebust9eaef272006-10-21 10:24:20 -07003013 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07003014 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
3015 goto out_err;
3016 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04003017 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07003018 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04003019 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003020out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07003021 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04003022 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003023out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07003024 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04003025 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003026 if (m1)
3027 mutex_unlock(m1);
3028 return ret;
3029}
3030
David Howells770bfad2006-08-22 20:06:07 -04003031/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003032 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3033 * @inode: the inode which may have a disconnected dentry
3034 * @dentry: a negative dentry which we want to point to the inode.
3035 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003036 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3037 * place of the given dentry and return it, else simply d_add the inode
3038 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003039 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003040 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3041 * we should error out: directories can't have multiple aliases.
3042 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003043 * This is needed in the lookup routine of any filesystem that is exportable
3044 * (via knfsd) so that we can build dcache paths to directories effectively.
3045 *
3046 * If a dentry was found and moved, then it is returned. Otherwise NULL
3047 * is returned. This matches the expected return value of ->lookup.
3048 *
3049 * Cluster filesystems may call this function with a negative, hashed dentry.
3050 * In that case, we know that the inode will be a regular file, and also this
3051 * will only occur during atomic_open. So we need to check for the dentry
3052 * being already hashed only in the final case.
3053 */
3054struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3055{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003056 if (IS_ERR(inode))
3057 return ERR_CAST(inode);
3058
David Howells770bfad2006-08-22 20:06:07 -04003059 BUG_ON(!d_unhashed(dentry));
3060
Al Virode689f52016-03-09 18:05:42 -05003061 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003062 goto out;
Al Virode689f52016-03-09 18:05:42 -05003063
Al Virob9680912016-04-11 00:53:26 -04003064 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003065 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003066 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003067 struct dentry *new = __d_find_any_alias(inode);
3068 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003069 /* The reference to new ensures it remains an alias */
3070 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003071 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003072 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003073 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003074 dput(new);
3075 new = ERR_PTR(-ELOOP);
3076 pr_warn_ratelimited(
3077 "VFS: Lookup of '%s' in %s %s"
3078 " would have caused loop\n",
3079 dentry->d_name.name,
3080 inode->i_sb->s_type->name,
3081 inode->i_sb->s_id);
3082 } else if (!IS_ROOT(new)) {
Al Viro076515f2018-03-10 23:15:52 -05003083 struct dentry *old_parent = dget(new->d_parent);
Al Virob5ae6b12014-10-12 22:16:02 -04003084 int err = __d_unalias(inode, dentry, new);
3085 write_sequnlock(&rename_lock);
3086 if (err) {
3087 dput(new);
3088 new = ERR_PTR(err);
3089 }
Al Viro076515f2018-03-10 23:15:52 -05003090 dput(old_parent);
Al Viro18367502011-07-12 21:42:24 -04003091 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003092 __d_move(new, dentry, false);
3093 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003094 }
Al Virob5ae6b12014-10-12 22:16:02 -04003095 iput(inode);
3096 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003097 }
David Howells770bfad2006-08-22 20:06:07 -04003098 }
Al Virob5ae6b12014-10-12 22:16:02 -04003099out:
Al Viroed782b52016-03-09 19:52:39 -05003100 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003101 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003102}
Al Virob5ae6b12014-10-12 22:16:02 -04003103EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003104
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105/*
3106 * Test whether new_dentry is a subdirectory of old_dentry.
3107 *
3108 * Trivially implemented using the dcache structure
3109 */
3110
3111/**
3112 * is_subdir - is new dentry a subdirectory of old_dentry
3113 * @new_dentry: new dentry
3114 * @old_dentry: old dentry
3115 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003116 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3117 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3119 */
3120
Yaowei Baia6e57872015-11-17 14:40:11 +08003121bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122{
Yaowei Baia6e57872015-11-17 14:40:11 +08003123 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003124 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003126 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003127 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003128
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003129 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003132 /*
3133 * Need rcu_readlock to protect against the d_parent trashing
3134 * due to d_move
3135 */
3136 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003137 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003138 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003139 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003140 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003141 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143
3144 return result;
3145}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003146EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003148static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003150 struct dentry *root = data;
3151 if (dentry != root) {
3152 if (d_unhashed(dentry) || !dentry->d_inode)
3153 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003155 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3156 dentry->d_flags |= DCACHE_GENOCIDE;
3157 dentry->d_lockref.count--;
3158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003160 return D_WALK_CONTINUE;
3161}
Nick Piggin58db63d2011-01-07 17:49:39 +11003162
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003163void d_genocide(struct dentry *parent)
3164{
Al Viro3a8e3612018-04-15 18:27:23 -04003165 d_walk(parent, parent, d_genocide_kill);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166}
3167
Al Virocbd4a5b2018-03-29 15:08:21 -04003168EXPORT_SYMBOL(d_genocide);
3169
Al Viro60545d02013-06-07 01:20:27 -04003170void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171{
Al Viro60545d02013-06-07 01:20:27 -04003172 inode_dec_link_count(inode);
3173 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003174 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003175 !d_unlinked(dentry));
3176 spin_lock(&dentry->d_parent->d_lock);
3177 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3178 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3179 (unsigned long long)inode->i_ino);
3180 spin_unlock(&dentry->d_lock);
3181 spin_unlock(&dentry->d_parent->d_lock);
3182 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183}
Al Viro60545d02013-06-07 01:20:27 -04003184EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185
3186static __initdata unsigned long dhash_entries;
3187static int __init set_dhash_entries(char *str)
3188{
3189 if (!str)
3190 return 0;
3191 dhash_entries = simple_strtoul(str, &str, 0);
3192 return 1;
3193}
3194__setup("dhash_entries=", set_dhash_entries);
3195
3196static void __init dcache_init_early(void)
3197{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198 /* If hashes are distributed across NUMA nodes, defer
3199 * hash allocation until vmalloc space is available.
3200 */
3201 if (hashdist)
3202 return;
3203
3204 dentry_hashtable =
3205 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003206 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207 dhash_entries,
3208 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003209 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003211 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003212 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003214 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215}
3216
Denis Cheng74bf17c2007-10-16 23:26:30 -07003217static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003219 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220 * A constructor could be added for stable state like the lists,
3221 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003222 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223 */
David Windsor80344262017-06-10 22:50:44 -04003224 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3225 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3226 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003227
3228 /* Hash may have been set up in dcache_init_early */
3229 if (!hashdist)
3230 return;
3231
3232 dentry_hashtable =
3233 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003234 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003235 dhash_entries,
3236 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003237 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003239 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003240 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003242 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243}
3244
3245/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003246struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003247EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249void __init vfs_caches_init_early(void)
3250{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003251 int i;
3252
3253 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3254 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3255
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256 dcache_init_early();
3257 inode_init_early();
3258}
3259
Mel Gorman4248b0d2015-08-06 15:46:20 -07003260void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261{
David Windsor6a9b8822017-06-10 22:50:30 -04003262 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3263 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264
Denis Cheng74bf17c2007-10-16 23:26:30 -07003265 dcache_init();
3266 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003267 files_init();
3268 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003269 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270 bdev_cache_init();
3271 chrdev_init();
3272}