blob: 1897833a46685be6da4870a9cc130321d0e78f99 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Al Viro7a5cf792018-03-05 19:15:50 -050017#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/security.h>
28#include <linux/seqlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/bootmem.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110030#include <linux/bit_spinlock.h>
31#include <linux/rculist_bl.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100032#include <linux/list_lru.h>
David Howells07f3f05c2006-09-30 20:52:18 +020033#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050034#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Nick Piggin789680d2011-01-07 17:49:30 +110036/*
37 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110038 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040039 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110040 * dcache_hash_bucket lock protects:
41 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110042 * s_roots bl list spinlock protects:
43 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100044 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110045 * - the dcache lru lists and counters
46 * d_lock protects:
47 * - d_flags
48 * - d_name
49 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110050 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110051 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110052 * - d_parent and d_subdirs
53 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040054 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110055 *
56 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110057 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110058 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100059 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110060 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110061 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110062 *
Nick Pigginda502952011-01-07 17:49:33 +110063 * If there is an ancestor relationship:
64 * dentry->d_parent->...->d_parent->d_lock
65 * ...
66 * dentry->d_parent->d_lock
67 * dentry->d_lock
68 *
69 * If no ancestor relationship:
Al Viro076515f2018-03-10 23:15:52 -050070 * arbitrary, since it's serialized on rename_lock
Nick Piggin789680d2011-01-07 17:49:30 +110071 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080072int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
74
Al Viro74c3cbe2007-07-22 08:04:18 -040075__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Nick Piggin949854d2011-01-07 17:49:37 +110077EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Christoph Lametere18b8902006-12-06 20:33:20 -080079static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
David Howellscdf01222017-07-04 17:25:22 +010081const struct qstr empty_name = QSTR_INIT("", 0);
82EXPORT_SYMBOL(empty_name);
83const struct qstr slash_name = QSTR_INIT("/", 1);
84EXPORT_SYMBOL(slash_name);
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/*
87 * This is the single most critical data structure when it comes
88 * to the dcache: the hashtable for lookups. Somebody should try
89 * to make this good - I've just made it work.
90 *
91 * This hash-function tries to avoid losing too many bits of hash
92 * information, yet avoid using a prime hash-size or similar.
93 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Eric Dumazetfa3536c2006-03-26 01:37:24 -080095static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +110096
Linus Torvaldsb07ad992011-04-23 22:32:03 -070097static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +110098
Linus Torvalds8387ff22016-06-10 07:51:30 -070099static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100100{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300101 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102}
103
Al Viro94bdd652016-04-15 02:42:04 -0400104#define IN_LOOKUP_SHIFT 10
105static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
106
107static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
108 unsigned int hash)
109{
110 hash += (unsigned long) parent / L1_CACHE_BYTES;
111 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
112}
113
114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115/* Statistics gathering. */
116struct dentry_stat_t dentry_stat = {
117 .age_limit = 45,
118};
119
Glauber Costa3942c072013-08-28 10:17:53 +1000120static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000121static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400122
123#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000124
125/*
126 * Here we resort to our own counters instead of using generic per-cpu counters
127 * for consistency with what the vfs inode code does. We are expected to harvest
128 * better code and performance by having our own specialized counters.
129 *
130 * Please note that the loop is done over all possible CPUs, not over all online
131 * CPUs. The reason for this is that we don't want to play games with CPUs going
132 * on and off. If one of them goes off, we will just keep their counters.
133 *
134 * glommer: See cffbc8a for details, and if you ever intend to change this,
135 * please update all vfs counters to match.
136 */
Glauber Costa3942c072013-08-28 10:17:53 +1000137static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100138{
139 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000140 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100141 for_each_possible_cpu(i)
142 sum += per_cpu(nr_dentry, i);
143 return sum < 0 ? 0 : sum;
144}
145
Dave Chinner62d36c72013-08-28 10:17:54 +1000146static long get_nr_dentry_unused(void)
147{
148 int i;
149 long sum = 0;
150 for_each_possible_cpu(i)
151 sum += per_cpu(nr_dentry_unused, i);
152 return sum < 0 ? 0 : sum;
153}
154
Joe Perches1f7e0612014-06-06 14:38:05 -0700155int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400156 size_t *lenp, loff_t *ppos)
157{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100158 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000159 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000160 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400161}
162#endif
163
Linus Torvalds5483f182012-03-04 15:51:42 -0800164/*
165 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
166 * The strings are both count bytes long, and count is non-zero.
167 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700168#ifdef CONFIG_DCACHE_WORD_ACCESS
169
170#include <asm/word-at-a-time.h>
171/*
172 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
173 * aligned allocation for this particular component. We don't
174 * strictly need the load_unaligned_zeropad() safety, but it
175 * doesn't hurt either.
176 *
177 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
178 * need the careful unaligned handling.
179 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700180static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800181{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800182 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800183
184 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300185 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700186 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800187 if (tcount < sizeof(unsigned long))
188 break;
189 if (unlikely(a != b))
190 return 1;
191 cs += sizeof(unsigned long);
192 ct += sizeof(unsigned long);
193 tcount -= sizeof(unsigned long);
194 if (!tcount)
195 return 0;
196 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000197 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800198 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700199}
200
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800201#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700202
Linus Torvalds94753db52012-05-10 12:19:19 -0700203static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700204{
Linus Torvalds5483f182012-03-04 15:51:42 -0800205 do {
206 if (*cs != *ct)
207 return 1;
208 cs++;
209 ct++;
210 tcount--;
211 } while (tcount);
212 return 0;
213}
214
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700215#endif
216
Linus Torvalds94753db52012-05-10 12:19:19 -0700217static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
218{
Linus Torvalds94753db52012-05-10 12:19:19 -0700219 /*
220 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100221 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700222 *
223 * NOTE! Even if a rename will mean that the length
224 * was not loaded atomically, we don't care. The
225 * RCU walk will check the sequence count eventually,
226 * and catch it. And we won't overrun the buffer,
227 * because we're reading the name pointer atomically,
228 * and a dentry name is guaranteed to be properly
229 * terminated with a NUL byte.
230 *
231 * End result: even if 'len' is wrong, we'll exit
232 * early because the data cannot match (there can
233 * be no NUL in the ct/tcount data)
234 */
Will Deacon506458e2017-10-24 11:22:48 +0100235 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000236
Linus Torvalds6326c712012-05-21 16:14:04 -0700237 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700238}
239
Al Viro8d85b482014-09-29 14:54:27 -0400240struct external_name {
241 union {
242 atomic_t count;
243 struct rcu_head head;
244 } u;
245 unsigned char name[];
246};
247
248static inline struct external_name *external_name(struct dentry *dentry)
249{
250 return container_of(dentry->d_name.name, struct external_name, name[0]);
251}
252
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400253static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400255 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
256
Al Viro8d85b482014-09-29 14:54:27 -0400257 kmem_cache_free(dentry_cache, dentry);
258}
259
Roman Gushchinf1782c92018-04-10 16:27:44 -0700260static void __d_free_external_name(struct rcu_head *head)
261{
262 struct external_name *name = container_of(head, struct external_name,
263 u.head);
264
265 mod_node_page_state(page_pgdat(virt_to_page(name)),
266 NR_INDIRECTLY_RECLAIMABLE_BYTES,
267 -ksize(name));
268
269 kfree(name);
270}
271
Al Viro8d85b482014-09-29 14:54:27 -0400272static void __d_free_external(struct rcu_head *head)
273{
274 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Roman Gushchinf1782c92018-04-10 16:27:44 -0700275
276 __d_free_external_name(&external_name(dentry)->u.head);
277
278 kmem_cache_free(dentry_cache, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279}
280
Al Viro810bb172014-10-12 12:45:37 -0400281static inline int dname_external(const struct dentry *dentry)
282{
283 return dentry->d_name.name != dentry->d_iname;
284}
285
Al Viro49d31c22017-07-07 14:51:19 -0400286void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
287{
288 spin_lock(&dentry->d_lock);
289 if (unlikely(dname_external(dentry))) {
290 struct external_name *p = external_name(dentry);
291 atomic_inc(&p->u.count);
292 spin_unlock(&dentry->d_lock);
293 name->name = p->name;
294 } else {
Tetsuo Handa6cd00a02018-08-17 15:44:34 -0700295 memcpy(name->inline_name, dentry->d_iname,
296 dentry->d_name.len + 1);
Al Viro49d31c22017-07-07 14:51:19 -0400297 spin_unlock(&dentry->d_lock);
298 name->name = name->inline_name;
299 }
300}
301EXPORT_SYMBOL(take_dentry_name_snapshot);
302
303void release_dentry_name_snapshot(struct name_snapshot *name)
304{
305 if (unlikely(name->name != name->inline_name)) {
306 struct external_name *p;
307 p = container_of(name->name, struct external_name, name[0]);
308 if (unlikely(atomic_dec_and_test(&p->u.count)))
Roman Gushchinf1782c92018-04-10 16:27:44 -0700309 call_rcu(&p->u.head, __d_free_external_name);
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;
324 WRITE_ONCE(dentry->d_flags, flags);
325}
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;
334}
335
Al Virob4f03542014-04-29 23:40:14 -0400336static void dentry_free(struct dentry *dentry)
337{
Al Viro946e51f2014-10-26 19:19:16 -0400338 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400339 if (unlikely(dname_external(dentry))) {
340 struct external_name *p = external_name(dentry);
341 if (likely(atomic_dec_and_test(&p->u.count))) {
342 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
343 return;
344 }
345 }
Al Virob4f03542014-04-29 23:40:14 -0400346 /* if dentry was never visible to RCU, immediate free is OK */
Al Viroc9391212019-03-15 22:23:19 -0400347 if (dentry->d_flags & DCACHE_NORCU)
Al Virob4f03542014-04-29 23:40:14 -0400348 __d_free(&dentry->d_u.d_rcu);
349 else
350 call_rcu(&dentry->d_u.d_rcu, __d_free);
351}
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353/*
354 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400355 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100356 */
357static void dentry_unlink_inode(struct dentry * dentry)
358 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100359 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100360{
361 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500362
Al Viro4c0d7cd2018-08-09 10:15:54 -0400363 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000364 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400365 hlist_del_init(&dentry->d_u.d_alias);
Al Viro4c0d7cd2018-08-09 10:15:54 -0400366 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100367 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100368 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100369 if (!inode->i_nlink)
370 fsnotify_inoderemove(inode);
371 if (dentry->d_op && dentry->d_op->d_iput)
372 dentry->d_op->d_iput(dentry, inode);
373 else
374 iput(inode);
375}
376
377/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400378 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
379 * is in use - which includes both the "real" per-superblock
380 * LRU list _and_ the DCACHE_SHRINK_LIST use.
381 *
382 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
383 * on the shrink list (ie not on the superblock LRU list).
384 *
385 * The per-cpu "nr_dentry_unused" counters are updated with
386 * the DCACHE_LRU_LIST bit.
387 *
388 * These helper functions make sure we always follow the
389 * rules. d_lock must be held by the caller.
390 */
391#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
392static void d_lru_add(struct dentry *dentry)
393{
394 D_FLAG_VERIFY(dentry, 0);
395 dentry->d_flags |= DCACHE_LRU_LIST;
396 this_cpu_inc(nr_dentry_unused);
397 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
398}
399
400static void d_lru_del(struct dentry *dentry)
401{
402 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
403 dentry->d_flags &= ~DCACHE_LRU_LIST;
404 this_cpu_dec(nr_dentry_unused);
405 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
406}
407
408static void d_shrink_del(struct dentry *dentry)
409{
410 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
411 list_del_init(&dentry->d_lru);
412 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
413 this_cpu_dec(nr_dentry_unused);
414}
415
416static void d_shrink_add(struct dentry *dentry, struct list_head *list)
417{
418 D_FLAG_VERIFY(dentry, 0);
419 list_add(&dentry->d_lru, list);
420 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
421 this_cpu_inc(nr_dentry_unused);
422}
423
424/*
425 * These can only be called under the global LRU lock, ie during the
426 * callback for freeing the LRU list. "isolate" removes it from the
427 * LRU lists entirely, while shrink_move moves it to the indicated
428 * private list.
429 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800430static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400431{
432 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
433 dentry->d_flags &= ~DCACHE_LRU_LIST;
434 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800435 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400436}
437
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800438static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
439 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400440{
441 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
442 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800443 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400444}
445
Miklos Szeredid52b9082007-05-08 00:23:46 -0700446/**
Nick Piggin789680d2011-01-07 17:49:30 +1100447 * d_drop - drop a dentry
448 * @dentry: dentry to drop
449 *
450 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
451 * be found through a VFS lookup any more. Note that this is different from
452 * deleting the dentry - d_delete will try to mark the dentry negative if
453 * possible, giving a successful _negative_ lookup, while d_drop will
454 * just make the cache lookup fail.
455 *
456 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
457 * reason (NFS timeouts or autofs deletes).
458 *
NeilBrown61647822017-11-10 15:45:41 +1100459 * __d_drop requires dentry->d_lock
460 * ___d_drop doesn't mark dentry as "unhashed"
461 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100462 */
NeilBrown61647822017-11-10 15:45:41 +1100463static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100464{
Al Viro0632a9a2018-03-07 00:49:10 -0500465 struct hlist_bl_head *b;
466 /*
467 * Hashed dentries are normally on the dentry hashtable,
468 * with the exception of those newly allocated by
469 * d_obtain_root, which are always IS_ROOT:
470 */
471 if (unlikely(IS_ROOT(dentry)))
472 b = &dentry->d_sb->s_roots;
473 else
474 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400475
Al Viro0632a9a2018-03-07 00:49:10 -0500476 hlist_bl_lock(b);
477 __hlist_bl_del(&dentry->d_hash);
478 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100479}
NeilBrown61647822017-11-10 15:45:41 +1100480
481void __d_drop(struct dentry *dentry)
482{
Al Viro0632a9a2018-03-07 00:49:10 -0500483 if (!d_unhashed(dentry)) {
484 ___d_drop(dentry);
485 dentry->d_hash.pprev = NULL;
486 write_seqcount_invalidate(&dentry->d_seq);
487 }
NeilBrown61647822017-11-10 15:45:41 +1100488}
Nick Piggin789680d2011-01-07 17:49:30 +1100489EXPORT_SYMBOL(__d_drop);
490
491void d_drop(struct dentry *dentry)
492{
Nick Piggin789680d2011-01-07 17:49:30 +1100493 spin_lock(&dentry->d_lock);
494 __d_drop(dentry);
495 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100496}
497EXPORT_SYMBOL(d_drop);
498
Al Viroba65dc52016-06-10 11:32:47 -0400499static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
500{
501 struct dentry *next;
502 /*
503 * Inform d_walk() and shrink_dentry_list() that we are no longer
504 * attached to the dentry tree
505 */
506 dentry->d_flags |= DCACHE_DENTRY_KILLED;
507 if (unlikely(list_empty(&dentry->d_child)))
508 return;
509 __list_del_entry(&dentry->d_child);
510 /*
511 * Cursors can move around the list of children. While we'd been
512 * a normal list member, it didn't matter - ->d_child.next would've
513 * been updated. However, from now on it won't be and for the
514 * things like d_walk() it might end up with a nasty surprise.
515 * Normally d_walk() doesn't care about cursors moving around -
516 * ->d_lock on parent prevents that and since a cursor has no children
517 * of its own, we get through it without ever unlocking the parent.
518 * There is one exception, though - if we ascend from a child that
519 * gets killed as soon as we unlock it, the next sibling is found
520 * using the value left in its ->d_child.next. And if _that_
521 * pointed to a cursor, and cursor got moved (e.g. by lseek())
522 * before d_walk() regains parent->d_lock, we'll end up skipping
523 * everything the cursor had been moved past.
524 *
525 * Solution: make sure that the pointer left behind in ->d_child.next
526 * points to something that won't be moving around. I.e. skip the
527 * cursors.
528 */
529 while (dentry->d_child.next != &parent->d_subdirs) {
530 next = list_entry(dentry->d_child.next, struct dentry, d_child);
531 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
532 break;
533 dentry->d_child.next = next->d_child.next;
534 }
535}
536
Al Viroe55fd012014-05-28 13:51:12 -0400537static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100538{
Al Viro41edf272014-05-01 10:30:00 -0400539 struct dentry *parent = NULL;
540 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400541 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100542 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100543
Linus Torvalds0d984392013-09-08 13:46:52 -0700544 /*
545 * The dentry is now unrecoverably dead to the world.
546 */
547 lockref_mark_dead(&dentry->d_lockref);
548
Sage Weilf0023bc2011-10-28 10:02:42 -0700549 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700550 * inform the fs via d_prune that this dentry is about to be
551 * unhashed and destroyed.
552 */
Al Viro29266202014-05-30 11:39:02 -0400553 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800554 dentry->d_op->d_prune(dentry);
555
Al Viro01b60352014-04-29 23:42:52 -0400556 if (dentry->d_flags & DCACHE_LRU_LIST) {
557 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
558 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400559 }
Nick Piggin77812a12011-01-07 17:49:48 +1100560 /* if it was on the hash then remove it */
561 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400562 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400563 if (parent)
564 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400565 if (dentry->d_inode)
566 dentry_unlink_inode(dentry);
567 else
568 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400569 this_cpu_dec(nr_dentry);
570 if (dentry->d_op && dentry->d_op->d_release)
571 dentry->d_op->d_release(dentry);
572
Al Viro41edf272014-05-01 10:30:00 -0400573 spin_lock(&dentry->d_lock);
574 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
575 dentry->d_flags |= DCACHE_MAY_FREE;
576 can_free = false;
577 }
578 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400579 if (likely(can_free))
580 dentry_free(dentry);
Al Viro9c5f1d32018-04-15 18:28:48 -0400581 cond_resched();
Al Viroe55fd012014-05-28 13:51:12 -0400582}
583
Al Viro8b987a42018-02-23 22:11:34 -0500584static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400585{
Al Viro8b987a42018-02-23 22:11:34 -0500586 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400587 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400588 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400589again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700590 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400591 spin_lock(&parent->d_lock);
592 /*
593 * We can't blindly lock dentry until we are sure
594 * that we won't violate the locking order.
595 * Any changes of dentry->d_parent must have
596 * been done with parent->d_lock held, so
597 * spin_lock() above is enough of a barrier
598 * for checking if it's still our child.
599 */
600 if (unlikely(parent != dentry->d_parent)) {
601 spin_unlock(&parent->d_lock);
602 goto again;
603 }
Al Viro3b821402018-02-23 20:47:17 -0500604 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500605 if (parent != dentry)
606 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
607 else
608 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400609 return parent;
610}
611
Al Viro8b987a42018-02-23 22:11:34 -0500612static inline struct dentry *lock_parent(struct dentry *dentry)
613{
614 struct dentry *parent = dentry->d_parent;
615 if (IS_ROOT(dentry))
616 return NULL;
617 if (likely(spin_trylock(&parent->d_lock)))
618 return parent;
619 return __lock_parent(dentry);
620}
621
Al Viroa3385792018-02-23 21:07:24 -0500622static inline bool retain_dentry(struct dentry *dentry)
623{
624 WARN_ON(d_in_lookup(dentry));
625
626 /* Unreachable? Get rid of it */
627 if (unlikely(d_unhashed(dentry)))
628 return false;
629
630 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
631 return false;
632
633 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
634 if (dentry->d_op->d_delete(dentry))
635 return false;
636 }
Al Viro62d99562018-03-06 21:37:31 -0500637 /* retain; LRU fodder */
638 dentry->d_lockref.count--;
639 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
640 d_lru_add(dentry);
641 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
642 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500643 return true;
644}
645
Linus Torvalds360f5472015-01-09 15:19:03 -0800646/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100647 * Finish off a dentry we've decided to kill.
648 * dentry->d_lock must be held, returns with it unlocked.
649 * Returns dentry requiring refcount drop, or NULL if we're done.
650 */
651static struct dentry *dentry_kill(struct dentry *dentry)
652 __releases(dentry->d_lock)
653{
654 struct inode *inode = dentry->d_inode;
655 struct dentry *parent = NULL;
656
657 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500658 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100659
660 if (!IS_ROOT(dentry)) {
661 parent = dentry->d_parent;
662 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500663 parent = __lock_parent(dentry);
664 if (likely(inode || !dentry->d_inode))
665 goto got_locks;
666 /* negative that became positive */
667 if (parent)
668 spin_unlock(&parent->d_lock);
669 inode = dentry->d_inode;
670 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100671 }
672 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100673 __dentry_kill(dentry);
674 return parent;
675
Al Virof657a662018-02-23 21:25:42 -0500676slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100677 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500678 spin_lock(&inode->i_lock);
679 spin_lock(&dentry->d_lock);
680 parent = lock_parent(dentry);
681got_locks:
682 if (unlikely(dentry->d_lockref.count != 1)) {
683 dentry->d_lockref.count--;
684 } else if (likely(!retain_dentry(dentry))) {
685 __dentry_kill(dentry);
686 return parent;
687 }
688 /* we are keeping it, after all */
689 if (inode)
690 spin_unlock(&inode->i_lock);
691 if (parent)
692 spin_unlock(&parent->d_lock);
693 spin_unlock(&dentry->d_lock);
694 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100695}
696
697/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800698 * Try to do a lockless dput(), and return whether that was successful.
699 *
700 * If unsuccessful, we return false, having already taken the dentry lock.
701 *
702 * The caller needs to hold the RCU read lock, so that the dentry is
703 * guaranteed to stay around even if the refcount goes down to zero!
704 */
705static inline bool fast_dput(struct dentry *dentry)
706{
707 int ret;
708 unsigned int d_flags;
709
710 /*
711 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100712 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800713 */
714 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
715 return lockref_put_or_lock(&dentry->d_lockref);
716
717 /*
718 * .. otherwise, we can try to just decrement the
719 * lockref optimistically.
720 */
721 ret = lockref_put_return(&dentry->d_lockref);
722
723 /*
724 * If the lockref_put_return() failed due to the lock being held
725 * by somebody else, the fast path has failed. We will need to
726 * get the lock, and then check the count again.
727 */
728 if (unlikely(ret < 0)) {
729 spin_lock(&dentry->d_lock);
730 if (dentry->d_lockref.count > 1) {
731 dentry->d_lockref.count--;
732 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500733 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800734 }
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500735 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800736 }
737
738 /*
739 * If we weren't the last ref, we're done.
740 */
741 if (ret)
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500742 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800743
744 /*
745 * Careful, careful. The reference count went down
746 * to zero, but we don't hold the dentry lock, so
747 * somebody else could get it again, and do another
748 * dput(), and we need to not race with that.
749 *
750 * However, there is a very special and common case
751 * where we don't care, because there is nothing to
752 * do: the dentry is still hashed, it does not have
753 * a 'delete' op, and it's referenced and already on
754 * the LRU list.
755 *
756 * NOTE! Since we aren't locked, these values are
757 * not "stable". However, it is sufficient that at
758 * some point after we dropped the reference the
759 * dentry was hashed and the flags had the proper
760 * value. Other dentry users may have re-gotten
761 * a reference to the dentry and change that, but
762 * our work is done - we can leave the dentry
763 * around with a zero refcount.
764 */
765 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700766 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100767 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800768
769 /* Nothing to do? Dropping the reference was all we needed? */
770 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500771 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800772
773 /*
774 * Not the fast normal case? Get the lock. We've already decremented
775 * the refcount, but we'll need to re-check the situation after
776 * getting the lock.
777 */
778 spin_lock(&dentry->d_lock);
779
780 /*
781 * Did somebody else grab a reference to it in the meantime, and
782 * we're no longer the last user after all? Alternatively, somebody
783 * else could have killed it and marked it dead. Either way, we
784 * don't need to do anything else.
785 */
786 if (dentry->d_lockref.count) {
787 spin_unlock(&dentry->d_lock);
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500788 return true;
Linus Torvalds360f5472015-01-09 15:19:03 -0800789 }
790
791 /*
792 * Re-get the reference we optimistically dropped. We hold the
793 * lock, and we just tested that it was zero, so we can just
794 * set it to 1.
795 */
796 dentry->d_lockref.count = 1;
Gustavo A. R. Silva79644102018-08-01 19:39:05 -0500797 return false;
Linus Torvalds360f5472015-01-09 15:19:03 -0800798}
799
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801/*
802 * This is dput
803 *
804 * This is complicated by the fact that we do not want to put
805 * dentries that are no longer on any hash chain on the unused
806 * list: we'd much rather just get rid of them immediately.
807 *
808 * However, that implies that we have to traverse the dentry
809 * tree upwards to the parents which might _also_ now be
810 * scheduled for deletion (it may have been only waiting for
811 * its last child to go away).
812 *
813 * This tail recursion is done by hand as we don't want to depend
814 * on the compiler to always get this right (gcc generally doesn't).
815 * Real recursion would eat up our stack space.
816 */
817
818/*
819 * dput - release a dentry
820 * @dentry: dentry to release
821 *
822 * Release a dentry. This will drop the usage count and if appropriate
823 * call the dentry unlink method as well as removing it from the queues and
824 * releasing its resources. If the parent dentries were scheduled for release
825 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827void dput(struct dentry *dentry)
828{
Al Viro1088a642018-04-15 18:31:03 -0400829 while (dentry) {
830 might_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Al Viro1088a642018-04-15 18:31:03 -0400832 rcu_read_lock();
833 if (likely(fast_dput(dentry))) {
834 rcu_read_unlock();
835 return;
836 }
Wei Fang47be6182016-07-06 11:32:20 +0800837
Al Viro1088a642018-04-15 18:31:03 -0400838 /* Slow case: now with the dentry lock held */
Linus Torvalds360f5472015-01-09 15:19:03 -0800839 rcu_read_unlock();
Linus Torvalds360f5472015-01-09 15:19:03 -0800840
Al Viro1088a642018-04-15 18:31:03 -0400841 if (likely(retain_dentry(dentry))) {
842 spin_unlock(&dentry->d_lock);
843 return;
844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Al Viro1088a642018-04-15 18:31:03 -0400846 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800847 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700849EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100852/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100853static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854{
Waiman Long98474232013-08-28 18:24:59 -0700855 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}
857
Nick Piggindc0474b2011-01-07 17:49:43 +1100858static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100859{
Waiman Long98474232013-08-28 18:24:59 -0700860 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100861}
862
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100863struct dentry *dget_parent(struct dentry *dentry)
864{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700865 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100866 struct dentry *ret;
Al Viro98e151b2019-10-31 01:43:31 -0400867 unsigned seq;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700869 /*
870 * Do optimistic parent lookup without any
871 * locking.
872 */
873 rcu_read_lock();
Al Viro98e151b2019-10-31 01:43:31 -0400874 seq = raw_seqcount_begin(&dentry->d_seq);
Mark Rutland66702eb2017-10-23 14:07:14 -0700875 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700876 gotref = lockref_get_not_zero(&ret->d_lockref);
877 rcu_read_unlock();
878 if (likely(gotref)) {
Al Viro98e151b2019-10-31 01:43:31 -0400879 if (!read_seqcount_retry(&dentry->d_seq, seq))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700880 return ret;
881 dput(ret);
882 }
883
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100884repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100885 /*
886 * Don't need rcu_dereference because we re-check it was correct under
887 * the lock.
888 */
889 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100890 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100891 spin_lock(&ret->d_lock);
892 if (unlikely(ret != dentry->d_parent)) {
893 spin_unlock(&ret->d_lock);
894 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100895 goto repeat;
896 }
Nick Piggina734eb42011-01-07 17:49:44 +1100897 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700898 BUG_ON(!ret->d_lockref.count);
899 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100900 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100901 return ret;
902}
903EXPORT_SYMBOL(dget_parent);
904
Al Viro61fec492018-04-25 10:52:25 -0400905static struct dentry * __d_find_any_alias(struct inode *inode)
906{
907 struct dentry *alias;
908
909 if (hlist_empty(&inode->i_dentry))
910 return NULL;
911 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
912 __dget(alias);
913 return alias;
914}
915
916/**
917 * d_find_any_alias - find any alias for a given inode
918 * @inode: inode to find an alias for
919 *
920 * If any aliases exist for the given inode, take and return a
921 * reference for one of them. If no aliases exist, return %NULL.
922 */
923struct dentry *d_find_any_alias(struct inode *inode)
924{
925 struct dentry *de;
926
927 spin_lock(&inode->i_lock);
928 de = __d_find_any_alias(inode);
929 spin_unlock(&inode->i_lock);
930 return de;
931}
932EXPORT_SYMBOL(d_find_any_alias);
933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934/**
935 * d_find_alias - grab a hashed alias of inode
936 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 *
938 * If inode has a hashed alias, or is a directory and has any alias,
939 * acquire the reference to alias and return it. Otherwise return NULL.
940 * Notice that if inode is a directory there can be only one alias and
941 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800942 * of a filesystem, or if the directory was renamed and d_revalidate
943 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700945 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500946 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500948static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949{
Al Viro61fec492018-04-25 10:52:25 -0400950 struct dentry *alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Al Viro61fec492018-04-25 10:52:25 -0400952 if (S_ISDIR(inode->i_mode))
953 return __d_find_any_alias(inode);
954
Al Viro946e51f2014-10-26 19:19:16 -0400955 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100956 spin_lock(&alias->d_lock);
Al Viro61fec492018-04-25 10:52:25 -0400957 if (!d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500958 __dget_dlock(alias);
959 spin_unlock(&alias->d_lock);
960 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100961 }
962 spin_unlock(&alias->d_lock);
Nick Pigginda502952011-01-07 17:49:33 +1100963 }
964 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965}
966
Nick Pigginda502952011-01-07 17:49:33 +1100967struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968{
David Howells214fda12006-03-25 03:06:36 -0800969 struct dentry *de = NULL;
970
Al Virob3d9b7a2012-06-09 13:51:19 -0400971 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100972 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500973 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100974 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800975 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return de;
977}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700978EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980/*
981 * Try to kill dentries associated with this inode.
982 * WARNING: you must own a reference to inode.
983 */
984void d_prune_aliases(struct inode *inode)
985{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700986 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100988 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400989 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700991 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400992 struct dentry *parent = lock_parent(dentry);
993 if (likely(!dentry->d_lockref.count)) {
994 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800995 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400996 goto restart;
997 }
998 if (parent)
999 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 }
1001 spin_unlock(&dentry->d_lock);
1002 }
Nick Piggin873feea2011-01-07 17:50:06 +11001003 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001005EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Al Viro3b3f09f2018-02-23 21:54:18 -05001007/*
1008 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +01001009 * Called under rcu_read_lock() and dentry->d_lock; the former
1010 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -05001011 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +01001012 * d_delete(), etc.
1013 *
Al Viro3b3f09f2018-02-23 21:54:18 -05001014 * Return false if dentry has been disrupted or grabbed, leaving
1015 * the caller to kick it off-list. Otherwise, return true and have
1016 * that dentry's inode and parent both locked.
1017 */
1018static bool shrink_lock_dentry(struct dentry *dentry)
1019{
1020 struct inode *inode;
1021 struct dentry *parent;
1022
1023 if (dentry->d_lockref.count)
1024 return false;
1025
1026 inode = dentry->d_inode;
1027 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001028 spin_unlock(&dentry->d_lock);
1029 spin_lock(&inode->i_lock);
1030 spin_lock(&dentry->d_lock);
1031 if (unlikely(dentry->d_lockref.count))
1032 goto out;
1033 /* changed inode means that somebody had grabbed it */
1034 if (unlikely(inode != dentry->d_inode))
1035 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001036 }
1037
1038 parent = dentry->d_parent;
1039 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1040 return true;
1041
Al Viro3b3f09f2018-02-23 21:54:18 -05001042 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001043 spin_lock(&parent->d_lock);
1044 if (unlikely(parent != dentry->d_parent)) {
1045 spin_unlock(&parent->d_lock);
1046 spin_lock(&dentry->d_lock);
1047 goto out;
1048 }
1049 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001050 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001051 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001052 spin_unlock(&parent->d_lock);
1053out:
1054 if (inode)
1055 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001056 return false;
1057}
1058
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001059static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001061 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001062 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001063
Miklos Szeredi60942f22014-05-02 15:38:39 -04001064 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001065 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001066 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001067 if (!shrink_lock_dentry(dentry)) {
1068 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001069 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001070 d_shrink_del(dentry);
1071 if (dentry->d_lockref.count < 0)
1072 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001073 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001074 if (can_free)
1075 dentry_free(dentry);
1076 continue;
1077 }
John Ogness8f04da22018-02-23 00:50:24 +01001078 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001079 d_shrink_del(dentry);
1080 parent = dentry->d_parent;
Al Viroff2fde92014-05-28 13:59:13 -04001081 __dentry_kill(dentry);
Al Viro3b3f09f2018-02-23 21:54:18 -05001082 if (parent == dentry)
1083 continue;
Al Viro5c47e6d2014-04-29 16:13:18 -04001084 /*
1085 * We need to prune ancestors too. This is necessary to prevent
1086 * quadratic behavior of shrink_dcache_parent(), but is also
1087 * expected to be beneficial in reducing dentry cache
1088 * fragmentation.
1089 */
1090 dentry = parent;
John Ogness8f04da22018-02-23 00:50:24 +01001091 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
1092 dentry = dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001094}
1095
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001096static enum lru_status dentry_lru_isolate(struct list_head *item,
1097 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001098{
1099 struct list_head *freeable = arg;
1100 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1101
1102
1103 /*
1104 * we are inverting the lru lock/dentry->d_lock here,
1105 * so use a trylock. If we fail to get the lock, just skip
1106 * it
1107 */
1108 if (!spin_trylock(&dentry->d_lock))
1109 return LRU_SKIP;
1110
1111 /*
1112 * Referenced dentries are still in use. If they have active
1113 * counts, just remove them from the LRU. Otherwise give them
1114 * another pass through the LRU.
1115 */
1116 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001117 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001118 spin_unlock(&dentry->d_lock);
1119 return LRU_REMOVED;
1120 }
1121
1122 if (dentry->d_flags & DCACHE_REFERENCED) {
1123 dentry->d_flags &= ~DCACHE_REFERENCED;
1124 spin_unlock(&dentry->d_lock);
1125
1126 /*
1127 * The list move itself will be made by the common LRU code. At
1128 * this point, we've dropped the dentry->d_lock but keep the
1129 * lru lock. This is safe to do, since every list movement is
1130 * protected by the lru lock even if both locks are held.
1131 *
1132 * This is guaranteed by the fact that all LRU management
1133 * functions are intermediated by the LRU API calls like
1134 * list_lru_add and list_lru_del. List movement in this file
1135 * only ever occur through this functions or through callbacks
1136 * like this one, that are called from the LRU API.
1137 *
1138 * The only exceptions to this are functions like
1139 * shrink_dentry_list, and code that first checks for the
1140 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1141 * operating only with stack provided lists after they are
1142 * properly isolated from the main list. It is thus, always a
1143 * local access.
1144 */
1145 return LRU_ROTATE;
1146 }
1147
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001148 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001149 spin_unlock(&dentry->d_lock);
1150
1151 return LRU_REMOVED;
1152}
1153
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001154/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001155 * prune_dcache_sb - shrink the dcache
1156 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001157 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001158 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001159 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1160 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001161 * function.
1162 *
1163 * This function may fail to free any resources if all the dentries are in
1164 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001165 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001166long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001167{
Dave Chinnerf6041562013-08-28 10:18:00 +10001168 LIST_HEAD(dispose);
1169 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001170
Vladimir Davydov503c3582015-02-12 14:58:47 -08001171 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1172 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001173 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001174 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175}
1176
Glauber Costa4e717f52013-08-28 10:18:03 +10001177static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001178 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001179{
Glauber Costa4e717f52013-08-28 10:18:03 +10001180 struct list_head *freeable = arg;
1181 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001182
Glauber Costa4e717f52013-08-28 10:18:03 +10001183 /*
1184 * we are inverting the lru lock/dentry->d_lock here,
1185 * so use a trylock. If we fail to get the lock, just skip
1186 * it
1187 */
1188 if (!spin_trylock(&dentry->d_lock))
1189 return LRU_SKIP;
1190
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001191 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001192 spin_unlock(&dentry->d_lock);
1193
1194 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001195}
1196
Glauber Costa4e717f52013-08-28 10:18:03 +10001197
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001198/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 * shrink_dcache_sb - shrink dcache for a superblock
1200 * @sb: superblock
1201 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001202 * Shrink the dcache for the specified super block. This is used to free
1203 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001205void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206{
Glauber Costa4e717f52013-08-28 10:18:03 +10001207 do {
1208 LIST_HEAD(dispose);
1209
Waiman Longbb4e1ff2019-01-30 13:52:36 -05001210 list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001211 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001212 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001213 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001215EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218 * enum d_walk_ret - action to talke during tree walk
1219 * @D_WALK_CONTINUE: contrinue walk
1220 * @D_WALK_QUIT: quit walk
1221 * @D_WALK_NORETRY: quit when retry is needed
1222 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001224enum d_walk_ret {
1225 D_WALK_CONTINUE,
1226 D_WALK_QUIT,
1227 D_WALK_NORETRY,
1228 D_WALK_SKIP,
1229};
1230
1231/**
1232 * d_walk - walk the dentry tree
1233 * @parent: start of walk
1234 * @data: data passed to @enter() and @finish()
1235 * @enter: callback when first entering the dentry
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001236 *
Al Viro3a8e3612018-04-15 18:27:23 -04001237 * The @enter() callbacks are called with d_lock held.
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001238 */
1239static void d_walk(struct dentry *parent, void *data,
Al Viro3a8e3612018-04-15 18:27:23 -04001240 enum d_walk_ret (*enter)(void *, struct dentry *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241{
Nick Piggin949854d2011-01-07 17:49:37 +11001242 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001244 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001245 enum d_walk_ret ret;
1246 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001247
Nick Piggin58db63d2011-01-07 17:49:39 +11001248again:
Al Viro48f5ec22013-09-09 15:22:25 -04001249 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001250 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001251 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001252
1253 ret = enter(data, this_parent);
1254 switch (ret) {
1255 case D_WALK_CONTINUE:
1256 break;
1257 case D_WALK_QUIT:
1258 case D_WALK_SKIP:
1259 goto out_unlock;
1260 case D_WALK_NORETRY:
1261 retry = false;
1262 break;
1263 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264repeat:
1265 next = this_parent->d_subdirs.next;
1266resume:
1267 while (next != &this_parent->d_subdirs) {
1268 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001269 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001271
Al Viroba65dc52016-06-10 11:32:47 -04001272 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1273 continue;
1274
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001275 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001276
1277 ret = enter(data, dentry);
1278 switch (ret) {
1279 case D_WALK_CONTINUE:
1280 break;
1281 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001282 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001283 goto out_unlock;
1284 case D_WALK_NORETRY:
1285 retry = false;
1286 break;
1287 case D_WALK_SKIP:
1288 spin_unlock(&dentry->d_lock);
1289 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001290 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001291
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001293 spin_unlock(&this_parent->d_lock);
1294 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001296 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 goto repeat;
1298 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001299 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 }
1301 /*
1302 * All done at this level ... ascend and resume the search.
1303 */
Al Viroca5358e2014-10-26 19:31:10 -04001304 rcu_read_lock();
1305ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001307 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001308 this_parent = child->d_parent;
1309
Al Viro31dec132013-10-25 17:04:27 -04001310 spin_unlock(&child->d_lock);
1311 spin_lock(&this_parent->d_lock);
1312
Al Viroca5358e2014-10-26 19:31:10 -04001313 /* might go back up the wrong parent if we have had a rename. */
1314 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001315 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001316 /* go into the first sibling still alive */
1317 do {
1318 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001319 if (next == &this_parent->d_subdirs)
1320 goto ascend;
1321 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001322 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001323 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 goto resume;
1325 }
Al Viroca5358e2014-10-26 19:31:10 -04001326 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001327 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001328 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001329
1330out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001331 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001332 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001333 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001334
1335rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001336 spin_unlock(&this_parent->d_lock);
1337 rcu_read_unlock();
1338 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001339 if (!retry)
1340 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001341 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001342 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001344
Ian Kent01619492016-11-24 08:03:41 +11001345struct check_mount {
1346 struct vfsmount *mnt;
1347 unsigned int mounted;
1348};
1349
1350static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1351{
1352 struct check_mount *info = data;
1353 struct path path = { .mnt = info->mnt, .dentry = dentry };
1354
1355 if (likely(!d_mountpoint(dentry)))
1356 return D_WALK_CONTINUE;
1357 if (__path_is_mountpoint(&path)) {
1358 info->mounted = 1;
1359 return D_WALK_QUIT;
1360 }
1361 return D_WALK_CONTINUE;
1362}
1363
1364/**
1365 * path_has_submounts - check for mounts over a dentry in the
1366 * current namespace.
1367 * @parent: path to check.
1368 *
1369 * Return true if the parent or its subdirectories contain
1370 * a mount point in the current namespace.
1371 */
1372int path_has_submounts(const struct path *parent)
1373{
1374 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1375
1376 read_seqlock_excl(&mount_lock);
Al Viro3a8e3612018-04-15 18:27:23 -04001377 d_walk(parent->dentry, &data, path_check_mount);
Ian Kent01619492016-11-24 08:03:41 +11001378 read_sequnlock_excl(&mount_lock);
1379
1380 return data.mounted;
1381}
1382EXPORT_SYMBOL(path_has_submounts);
1383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001385 * Called by mount code to set a mountpoint and check if the mountpoint is
1386 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1387 * subtree can become unreachable).
1388 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001389 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001390 * this reason take rename_lock and d_lock on dentry and ancestors.
1391 */
1392int d_set_mounted(struct dentry *dentry)
1393{
1394 struct dentry *p;
1395 int ret = -ENOENT;
1396 write_seqlock(&rename_lock);
1397 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001398 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001399 spin_lock(&p->d_lock);
1400 if (unlikely(d_unhashed(p))) {
1401 spin_unlock(&p->d_lock);
1402 goto out;
1403 }
1404 spin_unlock(&p->d_lock);
1405 }
1406 spin_lock(&dentry->d_lock);
1407 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001408 ret = -EBUSY;
1409 if (!d_mountpoint(dentry)) {
1410 dentry->d_flags |= DCACHE_MOUNTED;
1411 ret = 0;
1412 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001413 }
1414 spin_unlock(&dentry->d_lock);
1415out:
1416 write_sequnlock(&rename_lock);
1417 return ret;
1418}
1419
1420/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001421 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 * and move any unused dentries to the end of the unused
1423 * list for prune_dcache(). We descend to the next level
1424 * whenever the d_subdirs list is non-empty and continue
1425 * searching.
1426 *
1427 * It returns zero iff there are no unused children,
1428 * otherwise it returns the number of children moved to
1429 * the end of the unused list. This may not be the total
1430 * number of unused children, because select_parent can
1431 * drop the lock and return early due to latency
1432 * constraints.
1433 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001434
1435struct select_data {
1436 struct dentry *start;
1437 struct list_head dispose;
1438 int found;
1439};
1440
1441static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001443 struct select_data *data = _data;
1444 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001446 if (data->start == dentry)
1447 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Al Virofe915222014-05-03 00:02:25 -04001449 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001450 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001451 } else {
1452 if (dentry->d_flags & DCACHE_LRU_LIST)
1453 d_lru_del(dentry);
1454 if (!dentry->d_lockref.count) {
1455 d_shrink_add(dentry, &data->dispose);
1456 data->found++;
1457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 }
1459 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001460 * We can return to the caller if we have found some (this
1461 * ensures forward progress). We'll be coming back to find
1462 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 */
Al Virofe915222014-05-03 00:02:25 -04001464 if (!list_empty(&data->dispose))
1465 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001467 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
1469
1470/**
1471 * shrink_dcache_parent - prune dcache
1472 * @parent: parent of entries to prune
1473 *
1474 * Prune the dcache to remove unused children of the parent dentry.
1475 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001476void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001478 for (;;) {
1479 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001481 INIT_LIST_HEAD(&data.dispose);
1482 data.start = parent;
1483 data.found = 0;
1484
Al Viro3a8e3612018-04-15 18:27:23 -04001485 d_walk(parent, &data, select_collect);
Al Viro4fb48872018-04-19 23:58:48 -04001486
1487 if (!list_empty(&data.dispose)) {
1488 shrink_dentry_list(&data.dispose);
1489 continue;
1490 }
1491
1492 cond_resched();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001493 if (!data.found)
1494 break;
Greg Thelen421348f2013-04-30 15:26:48 -07001495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001497EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
Al Viro9c8c10e2014-05-02 20:36:10 -04001499static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001500{
Al Viro9c8c10e2014-05-02 20:36:10 -04001501 /* it has busy descendents; complain about those instead */
1502 if (!list_empty(&dentry->d_subdirs))
1503 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001504
Al Viro9c8c10e2014-05-02 20:36:10 -04001505 /* root with refcount 1 is fine */
1506 if (dentry == _data && dentry->d_lockref.count == 1)
1507 return D_WALK_CONTINUE;
1508
1509 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1510 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001511 dentry,
1512 dentry->d_inode ?
1513 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001514 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001515 dentry->d_lockref.count,
1516 dentry->d_sb->s_type->name,
1517 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001518 WARN_ON(1);
1519 return D_WALK_CONTINUE;
1520}
1521
1522static void do_one_tree(struct dentry *dentry)
1523{
1524 shrink_dcache_parent(dentry);
Al Viro3a8e3612018-04-15 18:27:23 -04001525 d_walk(dentry, dentry, umount_check);
Al Viro9c8c10e2014-05-02 20:36:10 -04001526 d_drop(dentry);
1527 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001528}
1529
1530/*
1531 * destroy the dentries attached to a superblock on unmounting
1532 */
1533void shrink_dcache_for_umount(struct super_block *sb)
1534{
1535 struct dentry *dentry;
1536
Al Viro9c8c10e2014-05-02 20:36:10 -04001537 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001538
1539 dentry = sb->s_root;
1540 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001541 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001542
NeilBrownf1ee6162017-12-21 09:45:40 +11001543 while (!hlist_bl_empty(&sb->s_roots)) {
1544 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001545 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001546 }
1547}
1548
Al Viroff17fa52018-04-15 18:21:47 -04001549static enum d_walk_ret find_submount(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001550{
Al Viroff17fa52018-04-15 18:21:47 -04001551 struct dentry **victim = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001553 __dget_dlock(dentry);
Al Viroff17fa52018-04-15 18:21:47 -04001554 *victim = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555 return D_WALK_QUIT;
1556 }
Al Viroff17fa52018-04-15 18:21:47 -04001557 return D_WALK_CONTINUE;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001558}
1559
1560/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001561 * d_invalidate - detach submounts, prune dcache, and drop
1562 * @dentry: dentry to invalidate (aka detach, prune and drop)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001563 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001564void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001565{
Al Viroff17fa52018-04-15 18:21:47 -04001566 bool had_submounts = false;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001567 spin_lock(&dentry->d_lock);
1568 if (d_unhashed(dentry)) {
1569 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001570 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001571 }
Al Viroff17fa52018-04-15 18:21:47 -04001572 __d_drop(dentry);
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001573 spin_unlock(&dentry->d_lock);
1574
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575 /* Negative dentries can be dropped without further checks */
Al Viroff17fa52018-04-15 18:21:47 -04001576 if (!dentry->d_inode)
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001577 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001578
Al Viroff17fa52018-04-15 18:21:47 -04001579 shrink_dcache_parent(dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001580 for (;;) {
Al Viroff17fa52018-04-15 18:21:47 -04001581 struct dentry *victim = NULL;
Al Viro3a8e3612018-04-15 18:27:23 -04001582 d_walk(dentry, &victim, find_submount);
Al Viroff17fa52018-04-15 18:21:47 -04001583 if (!victim) {
1584 if (had_submounts)
1585 shrink_dcache_parent(dentry);
Al Viro81be24d2017-06-03 07:20:09 +01001586 return;
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001587 }
Al Viroff17fa52018-04-15 18:21:47 -04001588 had_submounts = true;
1589 detach_mounts(victim);
1590 dput(victim);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001591 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001592}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001593EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595/**
Al Viroa4464db2011-07-07 15:03:58 -04001596 * __d_alloc - allocate a dcache entry
1597 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 * @name: qstr of the name
1599 *
1600 * Allocates a dentry. It returns %NULL if there is insufficient memory
1601 * available. On a success the dentry is returned. The name passed in is
1602 * copied and the copy passed in may be reused after this call.
1603 */
1604
Al Viroa4464db2011-07-07 15:03:58 -04001605struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606{
Roman Gushchinf1782c92018-04-10 16:27:44 -07001607 struct external_name *ext = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 struct dentry *dentry;
1609 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001610 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Mel Gormane12ba742007-10-16 01:25:52 -07001612 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 if (!dentry)
1614 return NULL;
1615
Linus Torvalds6326c712012-05-21 16:14:04 -07001616 /*
1617 * We guarantee that the inline name is always NUL-terminated.
1618 * This way the memcpy() done by the name switching in rename
1619 * will still always have a NUL at the end, even if we might
1620 * be overwriting an internal NUL character
1621 */
1622 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001623 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001624 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001625 dname = dentry->d_iname;
1626 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001627 size_t size = offsetof(struct external_name, name[1]);
Roman Gushchinf1782c92018-04-10 16:27:44 -07001628
1629 ext = kmalloc(size + name->len, GFP_KERNEL_ACCOUNT);
1630 if (!ext) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 kmem_cache_free(dentry_cache, dentry);
1632 return NULL;
1633 }
Roman Gushchinf1782c92018-04-10 16:27:44 -07001634 atomic_set(&ext->u.count, 1);
1635 dname = ext->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 } else {
1637 dname = dentry->d_iname;
1638 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639
1640 dentry->d_name.len = name->len;
1641 dentry->d_name.hash = name->hash;
1642 memcpy(dname, name->name, name->len);
1643 dname[name->len] = 0;
1644
Linus Torvalds6326c712012-05-21 16:14:04 -07001645 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001646 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c712012-05-21 16:14:04 -07001647
Waiman Long98474232013-08-28 18:24:59 -07001648 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001649 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001651 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001653 dentry->d_parent = dentry;
1654 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 dentry->d_op = NULL;
1656 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001657 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 INIT_LIST_HEAD(&dentry->d_lru);
1659 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001660 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1661 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001662 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Miklos Szeredi285b1022016-06-28 11:47:32 +02001664 if (dentry->d_op && dentry->d_op->d_init) {
1665 err = dentry->d_op->d_init(dentry);
1666 if (err) {
1667 if (dname_external(dentry))
1668 kfree(external_name(dentry));
1669 kmem_cache_free(dentry_cache, dentry);
1670 return NULL;
1671 }
1672 }
1673
Roman Gushchinf1782c92018-04-10 16:27:44 -07001674 if (unlikely(ext)) {
1675 pg_data_t *pgdat = page_pgdat(virt_to_page(ext));
1676 mod_node_page_state(pgdat, NR_INDIRECTLY_RECLAIMABLE_BYTES,
1677 ksize(ext));
1678 }
1679
Nick Piggin3e880fb2011-01-07 17:49:19 +11001680 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return dentry;
1683}
Al Viroa4464db2011-07-07 15:03:58 -04001684
1685/**
1686 * d_alloc - allocate a dcache entry
1687 * @parent: parent of entry to allocate
1688 * @name: qstr of the name
1689 *
1690 * Allocates a dentry. It returns %NULL if there is insufficient memory
1691 * available. On a success the dentry is returned. The name passed in is
1692 * copied and the copy passed in may be reused after this call.
1693 */
1694struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1695{
1696 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1697 if (!dentry)
1698 return NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001699 spin_lock(&parent->d_lock);
1700 /*
1701 * don't need child lock because it is not subject
1702 * to concurrency here
1703 */
1704 __dget_dlock(parent);
1705 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001706 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001707 spin_unlock(&parent->d_lock);
1708
1709 return dentry;
1710}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001711EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
Miklos Szeredif9c34672018-01-19 11:39:52 +01001713struct dentry *d_alloc_anon(struct super_block *sb)
1714{
1715 return __d_alloc(sb, NULL);
1716}
1717EXPORT_SYMBOL(d_alloc_anon);
1718
Al Viroba65dc52016-06-10 11:32:47 -04001719struct dentry *d_alloc_cursor(struct dentry * parent)
1720{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001721 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001722 if (dentry) {
Al Viroc9391212019-03-15 22:23:19 -04001723 dentry->d_flags |= DCACHE_DENTRY_CURSOR;
Al Viroba65dc52016-06-10 11:32:47 -04001724 dentry->d_parent = dget(parent);
1725 }
1726 return dentry;
1727}
1728
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001729/**
1730 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1731 * @sb: the superblock
1732 * @name: qstr of the name
1733 *
1734 * For a filesystem that just pins its dentries in memory and never
1735 * performs lookups at all, return an unhashed IS_ROOT dentry.
Al Viroc9391212019-03-15 22:23:19 -04001736 * This is used for pipes, sockets et.al. - the stuff that should
1737 * never be anyone's children or parents. Unlike all other
1738 * dentries, these will not have RCU delay between dropping the
1739 * last reference and freeing them.
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001740 */
Nick Piggin4b936882011-01-07 17:50:07 +11001741struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1742{
Al Viroc9391212019-03-15 22:23:19 -04001743 struct dentry *dentry = __d_alloc(sb, name);
1744 if (likely(dentry))
1745 dentry->d_flags |= DCACHE_NORCU;
1746 return dentry;
Nick Piggin4b936882011-01-07 17:50:07 +11001747}
1748EXPORT_SYMBOL(d_alloc_pseudo);
1749
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1751{
1752 struct qstr q;
1753
1754 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001755 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 return d_alloc(parent, &q);
1757}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001758EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
Nick Pigginfb045ad2011-01-07 17:49:55 +11001760void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1761{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001762 WARN_ON_ONCE(dentry->d_op);
1763 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001764 DCACHE_OP_COMPARE |
1765 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001766 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001767 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001768 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001769 dentry->d_op = op;
1770 if (!op)
1771 return;
1772 if (op->d_hash)
1773 dentry->d_flags |= DCACHE_OP_HASH;
1774 if (op->d_compare)
1775 dentry->d_flags |= DCACHE_OP_COMPARE;
1776 if (op->d_revalidate)
1777 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001778 if (op->d_weak_revalidate)
1779 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001780 if (op->d_delete)
1781 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001782 if (op->d_prune)
1783 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001784 if (op->d_real)
1785 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001786
1787}
1788EXPORT_SYMBOL(d_set_d_op);
1789
David Howellsdf1a0852015-01-29 12:02:28 +00001790
1791/*
1792 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1793 * @dentry - The dentry to mark
1794 *
1795 * Mark a dentry as falling through to the lower layer (as set with
1796 * d_pin_lower()). This flag may be recorded on the medium.
1797 */
1798void d_set_fallthru(struct dentry *dentry)
1799{
1800 spin_lock(&dentry->d_lock);
1801 dentry->d_flags |= DCACHE_FALLTHRU;
1802 spin_unlock(&dentry->d_lock);
1803}
1804EXPORT_SYMBOL(d_set_fallthru);
1805
David Howellsb18825a2013-09-12 19:22:53 +01001806static unsigned d_flags_for_inode(struct inode *inode)
1807{
David Howells44bdb5e2015-01-29 12:02:29 +00001808 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001809
1810 if (!inode)
1811 return DCACHE_MISS_TYPE;
1812
1813 if (S_ISDIR(inode->i_mode)) {
1814 add_flags = DCACHE_DIRECTORY_TYPE;
1815 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1816 if (unlikely(!inode->i_op->lookup))
1817 add_flags = DCACHE_AUTODIR_TYPE;
1818 else
1819 inode->i_opflags |= IOP_LOOKUP;
1820 }
David Howells44bdb5e2015-01-29 12:02:29 +00001821 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001822 }
1823
David Howells44bdb5e2015-01-29 12:02:29 +00001824 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001825 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001826 add_flags = DCACHE_SYMLINK_TYPE;
1827 goto type_determined;
1828 }
1829 inode->i_opflags |= IOP_NOFOLLOW;
1830 }
1831
1832 if (unlikely(!S_ISREG(inode->i_mode)))
1833 add_flags = DCACHE_SPECIAL_TYPE;
1834
1835type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001836 if (unlikely(IS_AUTOMOUNT(inode)))
1837 add_flags |= DCACHE_NEED_AUTOMOUNT;
1838 return add_flags;
1839}
1840
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001841static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1842{
David Howellsb18825a2013-09-12 19:22:53 +01001843 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001844 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001845
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001846 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001847 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001848 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001849 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001850 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001851 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001852 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001853}
1854
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855/**
1856 * d_instantiate - fill in inode information for a dentry
1857 * @entry: dentry to complete
1858 * @inode: inode to attach to this dentry
1859 *
1860 * Fill in inode information in the entry.
1861 *
1862 * This turns negative dentries into productive full members
1863 * of society.
1864 *
1865 * NOTE! This assumes that the inode count has been incremented
1866 * (or otherwise set) by the caller to indicate that it is now
1867 * in use by the dcache.
1868 */
1869
1870void d_instantiate(struct dentry *entry, struct inode * inode)
1871{
Al Viro946e51f2014-10-26 19:19:16 -04001872 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001873 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001874 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001875 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001876 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001877 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001880EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
Al Viro1e2e5472018-05-04 08:23:01 -04001882/*
1883 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1884 * with lockdep-related part of unlock_new_inode() done before
1885 * anything else. Use that instead of open-coding d_instantiate()/
1886 * unlock_new_inode() combinations.
1887 */
1888void d_instantiate_new(struct dentry *entry, struct inode *inode)
1889{
1890 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1891 BUG_ON(!inode);
1892 lockdep_annotate_inode_mutex_key(inode);
1893 security_d_instantiate(entry, inode);
1894 spin_lock(&inode->i_lock);
1895 __d_instantiate(entry, inode);
1896 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001897 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro1e2e5472018-05-04 08:23:01 -04001898 smp_mb();
1899 wake_up_bit(&inode->i_state, __I_NEW);
1900 spin_unlock(&inode->i_lock);
1901}
1902EXPORT_SYMBOL(d_instantiate_new);
1903
Al Viroadc0e912012-01-08 16:49:21 -05001904struct dentry *d_make_root(struct inode *root_inode)
1905{
1906 struct dentry *res = NULL;
1907
1908 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001909 res = d_alloc_anon(root_inode->i_sb);
Al Viroc9391212019-03-15 22:23:19 -04001910 if (res)
Al Viroadc0e912012-01-08 16:49:21 -05001911 d_instantiate(res, root_inode);
Al Viroc9391212019-03-15 22:23:19 -04001912 else
Al Viroadc0e912012-01-08 16:49:21 -05001913 iput(root_inode);
1914 }
1915 return res;
1916}
1917EXPORT_SYMBOL(d_make_root);
1918
Miklos Szeredif9c34672018-01-19 11:39:52 +01001919static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1920 struct inode *inode,
1921 bool disconnected)
1922{
1923 struct dentry *res;
1924 unsigned add_flags;
1925
1926 security_d_instantiate(dentry, inode);
1927 spin_lock(&inode->i_lock);
1928 res = __d_find_any_alias(inode);
1929 if (res) {
1930 spin_unlock(&inode->i_lock);
1931 dput(dentry);
1932 goto out_iput;
1933 }
1934
1935 /* attach a disconnected dentry */
1936 add_flags = d_flags_for_inode(inode);
1937
1938 if (disconnected)
1939 add_flags |= DCACHE_DISCONNECTED;
1940
1941 spin_lock(&dentry->d_lock);
1942 __d_set_inode_and_type(dentry, inode, add_flags);
1943 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08001944 if (!disconnected) {
1945 hlist_bl_lock(&dentry->d_sb->s_roots);
1946 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
1947 hlist_bl_unlock(&dentry->d_sb->s_roots);
1948 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01001949 spin_unlock(&dentry->d_lock);
1950 spin_unlock(&inode->i_lock);
1951
1952 return dentry;
1953
1954 out_iput:
1955 iput(inode);
1956 return res;
1957}
1958
1959struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
1960{
1961 return __d_instantiate_anon(dentry, inode, true);
1962}
1963EXPORT_SYMBOL(d_instantiate_anon);
1964
1965static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001966{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001967 struct dentry *tmp;
1968 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001969
1970 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001971 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001972 if (IS_ERR(inode))
1973 return ERR_CAST(inode);
1974
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001975 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001976 if (res)
1977 goto out_iput;
1978
Miklos Szeredif9c34672018-01-19 11:39:52 +01001979 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001980 if (!tmp) {
1981 res = ERR_PTR(-ENOMEM);
1982 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001983 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001984
Miklos Szeredif9c34672018-01-19 11:39:52 +01001985 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001986
Miklos Szeredif9c34672018-01-19 11:39:52 +01001987out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02001988 iput(inode);
1989 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001990}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001991
1992/**
1993 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1994 * @inode: inode to allocate the dentry for
1995 *
1996 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1997 * similar open by handle operations. The returned dentry may be anonymous,
1998 * or may have a full name (if the inode was already in the cache).
1999 *
2000 * When called on a directory inode, we must ensure that the inode only ever
2001 * has one dentry. If a dentry is found, that is returned instead of
2002 * allocating a new one.
2003 *
2004 * On successful return, the reference to the inode has been transferred
2005 * to the dentry. In case of an error the reference on the inode is released.
2006 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2007 * be passed in and the error will be propagated to the return value,
2008 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2009 */
2010struct dentry *d_obtain_alias(struct inode *inode)
2011{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002012 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002013}
Benny Halevyadc48722009-02-27 14:02:59 -08002014EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
2016/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002017 * d_obtain_root - find or allocate a dentry for a given inode
2018 * @inode: inode to allocate the dentry for
2019 *
2020 * Obtain an IS_ROOT dentry for the root of a filesystem.
2021 *
2022 * We must ensure that directory inodes only ever have one dentry. If a
2023 * dentry is found, that is returned instead of allocating a new one.
2024 *
2025 * On successful return, the reference to the inode has been transferred
2026 * to the dentry. In case of an error the reference on the inode is
2027 * released. A %NULL or IS_ERR inode may be passed in and will be the
2028 * error will be propagate to the return value, with a %NULL @inode
2029 * replaced by ERR_PTR(-ESTALE).
2030 */
2031struct dentry *d_obtain_root(struct inode *inode)
2032{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002033 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002034}
2035EXPORT_SYMBOL(d_obtain_root);
2036
2037/**
Barry Naujok94035402008-05-21 16:50:46 +10002038 * d_add_ci - lookup or allocate new dentry with case-exact name
2039 * @inode: the inode case-insensitive lookup has found
2040 * @dentry: the negative dentry that was passed to the parent's lookup func
2041 * @name: the case-exact name to be associated with the returned dentry
2042 *
2043 * This is to avoid filling the dcache with case-insensitive names to the
2044 * same inode, only the actual correct case is stored in the dcache for
2045 * case-insensitive filesystems.
2046 *
2047 * For a case-insensitive lookup match and if the the case-exact dentry
2048 * already exists in in the dcache, use it and return it.
2049 *
2050 * If no entry exists with the exact case name, allocate new dentry with
2051 * the exact case, and return the spliced entry.
2052 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002053struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002054 struct qstr *name)
2055{
Al Virod9171b92016-04-15 03:33:13 -04002056 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002057
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002058 /*
2059 * First check if a dentry matching the name already exists,
2060 * if not go ahead and create it now.
2061 */
Barry Naujok94035402008-05-21 16:50:46 +10002062 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002063 if (found) {
2064 iput(inode);
2065 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002066 }
Al Virod9171b92016-04-15 03:33:13 -04002067 if (d_in_lookup(dentry)) {
2068 found = d_alloc_parallel(dentry->d_parent, name,
2069 dentry->d_wait);
2070 if (IS_ERR(found) || !d_in_lookup(found)) {
2071 iput(inode);
2072 return found;
2073 }
2074 } else {
2075 found = d_alloc(dentry->d_parent, name);
2076 if (!found) {
2077 iput(inode);
2078 return ERR_PTR(-ENOMEM);
2079 }
2080 }
2081 res = d_splice_alias(inode, found);
2082 if (res) {
2083 dput(found);
2084 return res;
2085 }
Al Viro4f522a22013-02-11 23:20:37 -05002086 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002087}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002088EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002090
Al Virod4c91a82016-06-25 23:33:49 -04002091static inline bool d_same_name(const struct dentry *dentry,
2092 const struct dentry *parent,
2093 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002094{
Al Virod4c91a82016-06-25 23:33:49 -04002095 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2096 if (dentry->d_name.len != name->len)
2097 return false;
2098 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002099 }
Al Viro6fa67e72016-07-31 16:37:25 -04002100 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002101 dentry->d_name.len, dentry->d_name.name,
2102 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002103}
2104
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002106 * __d_lookup_rcu - search for a dentry (racy, store-free)
2107 * @parent: parent dentry
2108 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002109 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002110 * Returns: dentry, or NULL
2111 *
2112 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2113 * resolution (store-free path walking) design described in
2114 * Documentation/filesystems/path-lookup.txt.
2115 *
2116 * This is not to be used outside core vfs.
2117 *
2118 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2119 * held, and rcu_read_lock held. The returned dentry must not be stored into
2120 * without taking d_lock and checking d_seq sequence count against @seq
2121 * returned here.
2122 *
Linus Torvalds15570082013-09-02 11:38:06 -07002123 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002124 * function.
2125 *
2126 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2127 * the returned dentry, so long as its parent's seqlock is checked after the
2128 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2129 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002130 *
2131 * NOTE! The caller *has* to check the resulting dentry against the sequence
2132 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002133 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002134struct dentry *__d_lookup_rcu(const struct dentry *parent,
2135 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002136 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002137{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002138 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002139 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002140 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002141 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002142 struct dentry *dentry;
2143
2144 /*
2145 * Note: There is significant duplication with __d_lookup_rcu which is
2146 * required to prevent single threaded performance regressions
2147 * especially on architectures where smp_rmb (in seqcounts) are costly.
2148 * Keep the two functions in sync.
2149 */
2150
2151 /*
2152 * The hash list is protected using RCU.
2153 *
2154 * Carefully use d_seq when comparing a candidate dentry, to avoid
2155 * races with d_move().
2156 *
2157 * It is possible that concurrent renames can mess up our list
2158 * walk here and result in missing our dentry, resulting in the
2159 * false-negative result. d_lookup() protects against concurrent
2160 * renames using rename_lock seqlock.
2161 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002162 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002163 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002164 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002165 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002166
Nick Piggin31e6b012011-01-07 17:49:52 +11002167seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002168 /*
2169 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002170 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002171 *
2172 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002173 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002174 *
2175 * NOTE! We do a "raw" seqcount_begin here. That means that
2176 * we don't wait for the sequence count to stabilize if it
2177 * is in the middle of a sequence change. If we do the slow
2178 * dentry compare, we will do seqretries until it is stable,
2179 * and if we end up with a successful lookup, we actually
2180 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002181 *
2182 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2183 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002184 */
2185 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002186 if (dentry->d_parent != parent)
2187 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002188 if (d_unhashed(dentry))
2189 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002190
2191 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002192 int tlen;
2193 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002194 if (dentry->d_name.hash != hashlen_hash(hashlen))
2195 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002196 tlen = dentry->d_name.len;
2197 tname = dentry->d_name.name;
2198 /* we want a consistent (name,len) pair */
2199 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2200 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002201 goto seqretry;
2202 }
Al Viro6fa67e72016-07-31 16:37:25 -04002203 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002204 tlen, tname, name) != 0)
2205 continue;
2206 } else {
2207 if (dentry->d_name.hash_len != hashlen)
2208 continue;
2209 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2210 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002211 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002212 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002213 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002214 }
2215 return NULL;
2216}
2217
2218/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 * d_lookup - search for a dentry
2220 * @parent: parent dentry
2221 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002222 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002224 * d_lookup searches the children of the parent dentry for the name in
2225 * question. If the dentry is found its reference count is incremented and the
2226 * dentry is returned. The caller must use dput to free the entry when it has
2227 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 */
Al Viroda2d8452013-01-24 18:29:34 -05002229struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230{
Nick Piggin31e6b012011-01-07 17:49:52 +11002231 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002232 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233
Daeseok Younb8314f92014-08-11 11:46:53 +09002234 do {
2235 seq = read_seqbegin(&rename_lock);
2236 dentry = __d_lookup(parent, name);
2237 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 break;
2239 } while (read_seqretry(&rename_lock, seq));
2240 return dentry;
2241}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002242EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
Nick Piggin31e6b012011-01-07 17:49:52 +11002244/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002245 * __d_lookup - search for a dentry (racy)
2246 * @parent: parent dentry
2247 * @name: qstr of name we wish to find
2248 * Returns: dentry, or NULL
2249 *
2250 * __d_lookup is like d_lookup, however it may (rarely) return a
2251 * false-negative result due to unrelated rename activity.
2252 *
2253 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2254 * however it must be used carefully, eg. with a following d_lookup in
2255 * the case of failure.
2256 *
2257 * __d_lookup callers must be commented.
2258 */
Al Viroa713ca22013-01-24 18:27:00 -05002259struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002262 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002263 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002264 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002265 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266
Nick Pigginb04f7842010-08-18 04:37:34 +10002267 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002268 * Note: There is significant duplication with __d_lookup_rcu which is
2269 * required to prevent single threaded performance regressions
2270 * especially on architectures where smp_rmb (in seqcounts) are costly.
2271 * Keep the two functions in sync.
2272 */
2273
2274 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002275 * The hash list is protected using RCU.
2276 *
2277 * Take d_lock when comparing a candidate dentry, to avoid races
2278 * with d_move().
2279 *
2280 * It is possible that concurrent renames can mess up our list
2281 * walk here and result in missing our dentry, resulting in the
2282 * false-negative result. d_lookup() protects against concurrent
2283 * renames using rename_lock seqlock.
2284 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002285 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002286 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 rcu_read_lock();
2288
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002289 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 if (dentry->d_name.hash != hash)
2292 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293
2294 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 if (dentry->d_parent != parent)
2296 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002297 if (d_unhashed(dentry))
2298 goto next;
2299
Al Virod4c91a82016-06-25 23:33:49 -04002300 if (!d_same_name(dentry, parent, name))
2301 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
Waiman Long98474232013-08-28 18:24:59 -07002303 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002304 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 spin_unlock(&dentry->d_lock);
2306 break;
2307next:
2308 spin_unlock(&dentry->d_lock);
2309 }
2310 rcu_read_unlock();
2311
2312 return found;
2313}
2314
2315/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002316 * d_hash_and_lookup - hash the qstr then search for a dentry
2317 * @dir: Directory to search in
2318 * @name: qstr of name we wish to find
2319 *
Al Viro4f522a22013-02-11 23:20:37 -05002320 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002321 */
2322struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2323{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002324 /*
2325 * Check for a fs-specific hash function. Note that we must
2326 * calculate the standard hash first, as the d_op->d_hash()
2327 * routine may choose to leave the hash value unchanged.
2328 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002329 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002330 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002331 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002332 if (unlikely(err < 0))
2333 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002334 }
Al Viro4f522a22013-02-11 23:20:37 -05002335 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002336}
Al Viro4f522a22013-02-11 23:20:37 -05002337EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002338
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339/*
2340 * When a file is deleted, we have two options:
2341 * - turn this dentry into a negative dentry
2342 * - unhash this dentry and free it.
2343 *
2344 * Usually, we want to just turn this into
2345 * a negative dentry, but if anybody else is
2346 * currently using the dentry or the inode
2347 * we can't do that and we fall back on removing
2348 * it from the hash queues and waiting for
2349 * it to be deleted later when it has no users
2350 */
2351
2352/**
2353 * d_delete - delete a dentry
2354 * @dentry: The dentry to delete
2355 *
2356 * Turn the dentry into a negative dentry if possible, otherwise
2357 * remove it from the hash queues so it can be deleted later
2358 */
2359
2360void d_delete(struct dentry * dentry)
2361{
Al Viroc19457f2018-02-23 21:02:31 -05002362 struct inode *inode = dentry->d_inode;
2363 int isdir = d_is_dir(dentry);
2364
2365 spin_lock(&inode->i_lock);
2366 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 /*
2368 * Are we the only user?
2369 */
Waiman Long98474232013-08-28 18:24:59 -07002370 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002371 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002372 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002373 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002375 spin_unlock(&dentry->d_lock);
2376 spin_unlock(&inode->i_lock);
2377 }
John McCutchan7a91bf72005-08-08 13:52:16 -04002378 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002380EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381
Al Viro15d3c582016-07-29 17:45:21 -04002382static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383{
Al Viro15d3c582016-07-29 17:45:21 -04002384 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002385
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002386 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002387 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002388 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389}
2390
2391/**
2392 * d_rehash - add an entry back to the hash
2393 * @entry: dentry to add to the hash
2394 *
2395 * Adds a dentry to the hash according to its name.
2396 */
2397
2398void d_rehash(struct dentry * entry)
2399{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002401 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002404EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
Al Viro84e710d2016-04-15 00:58:55 -04002406static inline unsigned start_dir_add(struct inode *dir)
2407{
2408
2409 for (;;) {
2410 unsigned n = dir->i_dir_seq;
2411 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2412 return n;
2413 cpu_relax();
2414 }
2415}
2416
2417static inline void end_dir_add(struct inode *dir, unsigned n)
2418{
2419 smp_store_release(&dir->i_dir_seq, n + 2);
2420}
2421
Al Virod9171b92016-04-15 03:33:13 -04002422static void d_wait_lookup(struct dentry *dentry)
2423{
2424 if (d_in_lookup(dentry)) {
2425 DECLARE_WAITQUEUE(wait, current);
2426 add_wait_queue(dentry->d_wait, &wait);
2427 do {
2428 set_current_state(TASK_UNINTERRUPTIBLE);
2429 spin_unlock(&dentry->d_lock);
2430 schedule();
2431 spin_lock(&dentry->d_lock);
2432 } while (d_in_lookup(dentry));
2433 }
2434}
2435
Al Viro94bdd652016-04-15 02:42:04 -04002436struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002437 const struct qstr *name,
2438 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002439{
Al Viro94bdd652016-04-15 02:42:04 -04002440 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002441 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2442 struct hlist_bl_node *node;
2443 struct dentry *new = d_alloc(parent, name);
2444 struct dentry *dentry;
2445 unsigned seq, r_seq, d_seq;
2446
2447 if (unlikely(!new))
2448 return ERR_PTR(-ENOMEM);
2449
2450retry:
2451 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002452 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002453 r_seq = read_seqbegin(&rename_lock);
2454 dentry = __d_lookup_rcu(parent, name, &d_seq);
2455 if (unlikely(dentry)) {
2456 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2457 rcu_read_unlock();
2458 goto retry;
2459 }
2460 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2461 rcu_read_unlock();
2462 dput(dentry);
2463 goto retry;
2464 }
2465 rcu_read_unlock();
2466 dput(new);
2467 return dentry;
2468 }
2469 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2470 rcu_read_unlock();
2471 goto retry;
2472 }
Will Deacon015555f2018-02-19 14:55:54 +00002473
2474 if (unlikely(seq & 1)) {
2475 rcu_read_unlock();
2476 goto retry;
2477 }
2478
Al Viro94bdd652016-04-15 02:42:04 -04002479 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002480 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002481 hlist_bl_unlock(b);
2482 rcu_read_unlock();
2483 goto retry;
2484 }
Al Viro94bdd652016-04-15 02:42:04 -04002485 /*
2486 * No changes for the parent since the beginning of d_lookup().
2487 * Since all removals from the chain happen with hlist_bl_lock(),
2488 * any potential in-lookup matches are going to stay here until
2489 * we unlock the chain. All fields are stable in everything
2490 * we encounter.
2491 */
2492 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2493 if (dentry->d_name.hash != hash)
2494 continue;
2495 if (dentry->d_parent != parent)
2496 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002497 if (!d_same_name(dentry, parent, name))
2498 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002499 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002500 /* now we can try to grab a reference */
2501 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2502 rcu_read_unlock();
2503 goto retry;
2504 }
2505
2506 rcu_read_unlock();
2507 /*
2508 * somebody is likely to be still doing lookup for it;
2509 * wait for them to finish
2510 */
Al Virod9171b92016-04-15 03:33:13 -04002511 spin_lock(&dentry->d_lock);
2512 d_wait_lookup(dentry);
2513 /*
2514 * it's not in-lookup anymore; in principle we should repeat
2515 * everything from dcache lookup, but it's likely to be what
2516 * d_lookup() would've found anyway. If it is, just return it;
2517 * otherwise we really have to repeat the whole thing.
2518 */
2519 if (unlikely(dentry->d_name.hash != hash))
2520 goto mismatch;
2521 if (unlikely(dentry->d_parent != parent))
2522 goto mismatch;
2523 if (unlikely(d_unhashed(dentry)))
2524 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002525 if (unlikely(!d_same_name(dentry, parent, name)))
2526 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002527 /* OK, it *is* a hashed match; return it */
2528 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002529 dput(new);
2530 return dentry;
2531 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002532 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002533 /* we can't take ->d_lock here; it's OK, though. */
2534 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002535 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002536 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2537 hlist_bl_unlock(b);
2538 return new;
Al Virod9171b92016-04-15 03:33:13 -04002539mismatch:
2540 spin_unlock(&dentry->d_lock);
2541 dput(dentry);
2542 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002543}
2544EXPORT_SYMBOL(d_alloc_parallel);
2545
Al Viro85c7f812016-04-14 19:52:13 -04002546void __d_lookup_done(struct dentry *dentry)
2547{
Al Viro94bdd652016-04-15 02:42:04 -04002548 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2549 dentry->d_name.hash);
2550 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002551 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002552 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002553 wake_up_all(dentry->d_wait);
2554 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002555 hlist_bl_unlock(b);
2556 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002557 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002558}
2559EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002560
2561/* inode->i_lock held if inode is non-NULL */
2562
2563static inline void __d_add(struct dentry *dentry, struct inode *inode)
2564{
Al Viro84e710d2016-04-15 00:58:55 -04002565 struct inode *dir = NULL;
2566 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002567 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002568 if (unlikely(d_in_lookup(dentry))) {
2569 dir = dentry->d_parent->d_inode;
2570 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002571 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002572 }
Al Viroed782b52016-03-09 19:52:39 -05002573 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002574 unsigned add_flags = d_flags_for_inode(inode);
2575 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2576 raw_write_seqcount_begin(&dentry->d_seq);
2577 __d_set_inode_and_type(dentry, inode, add_flags);
2578 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002579 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002580 }
Al Viro15d3c582016-07-29 17:45:21 -04002581 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002582 if (dir)
2583 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002584 spin_unlock(&dentry->d_lock);
2585 if (inode)
2586 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002587}
2588
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002589/**
Al Viro34d0d192016-03-08 21:01:03 -05002590 * d_add - add dentry to hash queues
2591 * @entry: dentry to add
2592 * @inode: The inode to attach to this dentry
2593 *
2594 * This adds the entry to the hash queues and initializes @inode.
2595 * The entry was actually filled in earlier during d_alloc().
2596 */
2597
2598void d_add(struct dentry *entry, struct inode *inode)
2599{
Al Virob9680912016-04-11 00:53:26 -04002600 if (inode) {
2601 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002602 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002603 }
Al Viroed782b52016-03-09 19:52:39 -05002604 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002605}
2606EXPORT_SYMBOL(d_add);
2607
2608/**
Al Viro668d0cd2016-03-08 12:44:17 -05002609 * d_exact_alias - find and hash an exact unhashed alias
2610 * @entry: dentry to add
2611 * @inode: The inode to go with this dentry
2612 *
2613 * If an unhashed dentry with the same name/parent and desired
2614 * inode already exists, hash and return it. Otherwise, return
2615 * NULL.
2616 *
2617 * Parent directory should be locked.
2618 */
2619struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2620{
2621 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002622 unsigned int hash = entry->d_name.hash;
2623
2624 spin_lock(&inode->i_lock);
2625 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2626 /*
2627 * Don't need alias->d_lock here, because aliases with
2628 * d_parent == entry->d_parent are not subject to name or
2629 * parent changes, because the parent inode i_mutex is held.
2630 */
2631 if (alias->d_name.hash != hash)
2632 continue;
2633 if (alias->d_parent != entry->d_parent)
2634 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002635 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002636 continue;
2637 spin_lock(&alias->d_lock);
2638 if (!d_unhashed(alias)) {
2639 spin_unlock(&alias->d_lock);
2640 alias = NULL;
2641 } else {
2642 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002643 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002644 spin_unlock(&alias->d_lock);
2645 }
2646 spin_unlock(&inode->i_lock);
2647 return alias;
2648 }
2649 spin_unlock(&inode->i_lock);
2650 return NULL;
2651}
2652EXPORT_SYMBOL(d_exact_alias);
2653
Al Viro8d85b482014-09-29 14:54:27 -04002654static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655{
Al Viro8d85b482014-09-29 14:54:27 -04002656 if (unlikely(dname_external(target))) {
2657 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658 /*
2659 * Both external: swap the pointers
2660 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002661 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 } else {
2663 /*
2664 * dentry:internal, target:external. Steal target's
2665 * storage and make target internal.
2666 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002667 memcpy(target->d_iname, dentry->d_name.name,
2668 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 dentry->d_name.name = target->d_name.name;
2670 target->d_name.name = target->d_iname;
2671 }
2672 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002673 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674 /*
2675 * dentry:external, target:internal. Give dentry's
2676 * storage to target and make dentry internal
2677 */
2678 memcpy(dentry->d_iname, target->d_name.name,
2679 target->d_name.len + 1);
2680 target->d_name.name = dentry->d_name.name;
2681 dentry->d_name.name = dentry->d_iname;
2682 } else {
2683 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002684 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002686 unsigned int i;
2687 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2688 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2689 swap(((long *) &dentry->d_iname)[i],
2690 ((long *) &target->d_iname)[i]);
2691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 }
2693 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002694 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695}
2696
Al Viro8d85b482014-09-29 14:54:27 -04002697static void copy_name(struct dentry *dentry, struct dentry *target)
2698{
2699 struct external_name *old_name = NULL;
2700 if (unlikely(dname_external(dentry)))
2701 old_name = external_name(dentry);
2702 if (unlikely(dname_external(target))) {
2703 atomic_inc(&external_name(target)->u.count);
2704 dentry->d_name = target->d_name;
2705 } else {
2706 memcpy(dentry->d_iname, target->d_name.name,
2707 target->d_name.len + 1);
2708 dentry->d_name.name = dentry->d_iname;
2709 dentry->d_name.hash_len = target->d_name.hash_len;
2710 }
2711 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
Roman Gushchinf1782c92018-04-10 16:27:44 -07002712 call_rcu(&old_name->u.head, __d_free_external_name);
Al Viro8d85b482014-09-29 14:54:27 -04002713}
2714
Trond Myklebust9eaef272006-10-21 10:24:20 -07002715/*
Eric Biggers906242d2020-10-31 15:05:51 -07002716 * When d_splice_alias() moves a directory's encrypted alias to its decrypted
2717 * alias as a result of the encryption key being added, DCACHE_ENCRYPTED_NAME
2718 * must be cleared. Note that we don't have to support arbitrary moves of this
2719 * flag because fscrypt doesn't allow encrypted aliases to be the source or
2720 * target of a rename().
2721 */
2722static inline void fscrypt_handle_d_move(struct dentry *dentry)
2723{
2724#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
2725 dentry->d_flags &= ~DCACHE_ENCRYPTED_NAME;
2726#endif
2727}
2728
2729/*
Al Viro18367502011-07-12 21:42:24 -04002730 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 * @dentry: entry to move
2732 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002733 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 *
2735 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002736 * dcache entries should not be moved in this way. Caller must hold
2737 * rename_lock, the i_mutex of the source and target directories,
2738 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002740static void __d_move(struct dentry *dentry, struct dentry *target,
2741 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742{
Al Viro42177002018-03-11 15:15:46 -04002743 struct dentry *old_parent, *p;
Al Viro84e710d2016-04-15 00:58:55 -04002744 struct inode *dir = NULL;
2745 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746
Al Viro42177002018-03-11 15:15:46 -04002747 WARN_ON(!dentry->d_inode);
2748 if (WARN_ON(dentry == target))
2749 return;
2750
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002751 BUG_ON(d_ancestor(target, dentry));
Al Viro42177002018-03-11 15:15:46 -04002752 old_parent = dentry->d_parent;
2753 p = d_ancestor(old_parent, target);
2754 if (IS_ROOT(dentry)) {
2755 BUG_ON(p);
2756 spin_lock(&target->d_parent->d_lock);
2757 } else if (!p) {
2758 /* target is not a descendent of dentry->d_parent */
2759 spin_lock(&target->d_parent->d_lock);
2760 spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
2761 } else {
2762 BUG_ON(p == dentry);
2763 spin_lock(&old_parent->d_lock);
2764 if (p != target)
2765 spin_lock_nested(&target->d_parent->d_lock,
2766 DENTRY_D_LOCK_NESTED);
2767 }
2768 spin_lock_nested(&dentry->d_lock, 2);
2769 spin_lock_nested(&target->d_lock, 3);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002770
Al Viro84e710d2016-04-15 00:58:55 -04002771 if (unlikely(d_in_lookup(target))) {
2772 dir = target->d_parent->d_inode;
2773 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002774 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776
Nick Piggin31e6b012011-01-07 17:49:52 +11002777 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002778 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002779
Al Viro15d3c582016-07-29 17:45:21 -04002780 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002781 if (!d_unhashed(dentry))
2782 ___d_drop(dentry);
2783 if (!d_unhashed(target))
2784 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785
Al Viro63cf4272014-09-26 23:06:14 -04002786 /* ... and switch them in the tree */
Al Viro076515f2018-03-10 23:15:52 -05002787 dentry->d_parent = target->d_parent;
2788 if (!exchange) {
2789 copy_name(dentry, target);
2790 target->d_hash.pprev = NULL;
2791 dentry->d_parent->d_lockref.count++;
Al Viroc9391212019-03-15 22:23:19 -04002792 if (dentry != old_parent) /* wasn't IS_ROOT */
Al Viro076515f2018-03-10 23:15:52 -05002793 WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 } else {
Al Viro076515f2018-03-10 23:15:52 -05002795 target->d_parent = old_parent;
2796 swap_names(dentry, target);
Al Viro946e51f2014-10-26 19:19:16 -04002797 list_move(&target->d_child, &target->d_parent->d_subdirs);
Al Viro076515f2018-03-10 23:15:52 -05002798 __d_rehash(target);
2799 fsnotify_update_flags(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 }
Al Viro076515f2018-03-10 23:15:52 -05002801 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
2802 __d_rehash(dentry);
2803 fsnotify_update_flags(dentry);
Eric Biggers906242d2020-10-31 15:05:51 -07002804 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805
Nick Piggin31e6b012011-01-07 17:49:52 +11002806 write_seqcount_end(&target->d_seq);
2807 write_seqcount_end(&dentry->d_seq);
2808
Al Viro84e710d2016-04-15 00:58:55 -04002809 if (dir)
2810 end_dir_add(dir, n);
Al Viro076515f2018-03-10 23:15:52 -05002811
2812 if (dentry->d_parent != old_parent)
2813 spin_unlock(&dentry->d_parent->d_lock);
2814 if (dentry != old_parent)
2815 spin_unlock(&old_parent->d_lock);
2816 spin_unlock(&target->d_lock);
2817 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002818}
2819
2820/*
2821 * d_move - move a dentry
2822 * @dentry: entry to move
2823 * @target: new dentry
2824 *
2825 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002826 * dcache entries should not be moved in this way. See the locking
2827 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002828 */
2829void d_move(struct dentry *dentry, struct dentry *target)
2830{
2831 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002832 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002834}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002835EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836
Miklos Szeredida1ce062014-04-01 17:08:43 +02002837/*
2838 * d_exchange - exchange two dentries
2839 * @dentry1: first dentry
2840 * @dentry2: second dentry
2841 */
2842void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2843{
2844 write_seqlock(&rename_lock);
2845
2846 WARN_ON(!dentry1->d_inode);
2847 WARN_ON(!dentry2->d_inode);
2848 WARN_ON(IS_ROOT(dentry1));
2849 WARN_ON(IS_ROOT(dentry2));
2850
2851 __d_move(dentry1, dentry2, true);
2852
2853 write_sequnlock(&rename_lock);
2854}
2855
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002856/**
2857 * d_ancestor - search for an ancestor
2858 * @p1: ancestor dentry
2859 * @p2: child dentry
2860 *
2861 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2862 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002863 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002864struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002865{
2866 struct dentry *p;
2867
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002868 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002869 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002870 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002871 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002872 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002873}
2874
2875/*
2876 * This helper attempts to cope with remotely renamed directories
2877 *
2878 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002879 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002880 *
2881 * Note: If ever the locking in lock_rename() changes, then please
2882 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002883 */
Al Virob5ae6b12014-10-12 22:16:02 -04002884static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002885 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002886{
Al Viro9902af72016-04-15 15:08:36 -04002887 struct mutex *m1 = NULL;
2888 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002889 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002890
2891 /* If alias and dentry share a parent, then no extra locks required */
2892 if (alias->d_parent == dentry->d_parent)
2893 goto out_unalias;
2894
Trond Myklebust9eaef272006-10-21 10:24:20 -07002895 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002896 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2897 goto out_err;
2898 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002899 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002900 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002901 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002902out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002903 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002904 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002905out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002906 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002907 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002908 if (m1)
2909 mutex_unlock(m1);
2910 return ret;
2911}
2912
David Howells770bfad2006-08-22 20:06:07 -04002913/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002914 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2915 * @inode: the inode which may have a disconnected dentry
2916 * @dentry: a negative dentry which we want to point to the inode.
2917 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002918 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2919 * place of the given dentry and return it, else simply d_add the inode
2920 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002921 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002922 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2923 * we should error out: directories can't have multiple aliases.
2924 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002925 * This is needed in the lookup routine of any filesystem that is exportable
2926 * (via knfsd) so that we can build dcache paths to directories effectively.
2927 *
2928 * If a dentry was found and moved, then it is returned. Otherwise NULL
2929 * is returned. This matches the expected return value of ->lookup.
2930 *
2931 * Cluster filesystems may call this function with a negative, hashed dentry.
2932 * In that case, we know that the inode will be a regular file, and also this
2933 * will only occur during atomic_open. So we need to check for the dentry
2934 * being already hashed only in the final case.
2935 */
2936struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2937{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002938 if (IS_ERR(inode))
2939 return ERR_CAST(inode);
2940
David Howells770bfad2006-08-22 20:06:07 -04002941 BUG_ON(!d_unhashed(dentry));
2942
Al Virode689f52016-03-09 18:05:42 -05002943 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002944 goto out;
Al Virode689f52016-03-09 18:05:42 -05002945
Al Virob9680912016-04-11 00:53:26 -04002946 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002947 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002948 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002949 struct dentry *new = __d_find_any_alias(inode);
2950 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002951 /* The reference to new ensures it remains an alias */
2952 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002953 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002954 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002955 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002956 dput(new);
2957 new = ERR_PTR(-ELOOP);
2958 pr_warn_ratelimited(
2959 "VFS: Lookup of '%s' in %s %s"
2960 " would have caused loop\n",
2961 dentry->d_name.name,
2962 inode->i_sb->s_type->name,
2963 inode->i_sb->s_id);
2964 } else if (!IS_ROOT(new)) {
Al Viro076515f2018-03-10 23:15:52 -05002965 struct dentry *old_parent = dget(new->d_parent);
Al Virob5ae6b12014-10-12 22:16:02 -04002966 int err = __d_unalias(inode, dentry, new);
2967 write_sequnlock(&rename_lock);
2968 if (err) {
2969 dput(new);
2970 new = ERR_PTR(err);
2971 }
Al Viro076515f2018-03-10 23:15:52 -05002972 dput(old_parent);
Al Viro18367502011-07-12 21:42:24 -04002973 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002974 __d_move(new, dentry, false);
2975 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002976 }
Al Virob5ae6b12014-10-12 22:16:02 -04002977 iput(inode);
2978 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002979 }
David Howells770bfad2006-08-22 20:06:07 -04002980 }
Al Virob5ae6b12014-10-12 22:16:02 -04002981out:
Al Viroed782b52016-03-09 19:52:39 -05002982 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002983 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002984}
Al Virob5ae6b12014-10-12 22:16:02 -04002985EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002986
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987/*
2988 * Test whether new_dentry is a subdirectory of old_dentry.
2989 *
2990 * Trivially implemented using the dcache structure
2991 */
2992
2993/**
2994 * is_subdir - is new dentry a subdirectory of old_dentry
2995 * @new_dentry: new dentry
2996 * @old_dentry: old dentry
2997 *
Yaowei Baia6e57872015-11-17 14:40:11 +08002998 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
2999 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3001 */
3002
Yaowei Baia6e57872015-11-17 14:40:11 +08003003bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004{
Yaowei Baia6e57872015-11-17 14:40:11 +08003005 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003006 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003008 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003009 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003010
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003011 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003014 /*
3015 * Need rcu_readlock to protect against the d_parent trashing
3016 * due to d_move
3017 */
3018 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003019 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003020 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003021 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003022 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003023 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003025
3026 return result;
3027}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003028EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003030static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003032 struct dentry *root = data;
3033 if (dentry != root) {
3034 if (d_unhashed(dentry) || !dentry->d_inode)
3035 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003037 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3038 dentry->d_flags |= DCACHE_GENOCIDE;
3039 dentry->d_lockref.count--;
3040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003042 return D_WALK_CONTINUE;
3043}
Nick Piggin58db63d2011-01-07 17:49:39 +11003044
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003045void d_genocide(struct dentry *parent)
3046{
Al Viro3a8e3612018-04-15 18:27:23 -04003047 d_walk(parent, parent, d_genocide_kill);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048}
3049
Al Virocbd4a5b2018-03-29 15:08:21 -04003050EXPORT_SYMBOL(d_genocide);
3051
Al Viro60545d02013-06-07 01:20:27 -04003052void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053{
Al Viro60545d02013-06-07 01:20:27 -04003054 inode_dec_link_count(inode);
3055 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003056 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003057 !d_unlinked(dentry));
3058 spin_lock(&dentry->d_parent->d_lock);
3059 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3060 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3061 (unsigned long long)inode->i_ino);
3062 spin_unlock(&dentry->d_lock);
3063 spin_unlock(&dentry->d_parent->d_lock);
3064 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065}
Al Viro60545d02013-06-07 01:20:27 -04003066EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067
3068static __initdata unsigned long dhash_entries;
3069static int __init set_dhash_entries(char *str)
3070{
3071 if (!str)
3072 return 0;
3073 dhash_entries = simple_strtoul(str, &str, 0);
3074 return 1;
3075}
3076__setup("dhash_entries=", set_dhash_entries);
3077
3078static void __init dcache_init_early(void)
3079{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080 /* If hashes are distributed across NUMA nodes, defer
3081 * hash allocation until vmalloc space is available.
3082 */
3083 if (hashdist)
3084 return;
3085
3086 dentry_hashtable =
3087 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003088 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089 dhash_entries,
3090 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003091 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003093 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003094 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003095 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003096 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097}
3098
Denis Cheng74bf17c2007-10-16 23:26:30 -07003099static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003101 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102 * A constructor could be added for stable state like the lists,
3103 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003104 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 */
David Windsor80344262017-06-10 22:50:44 -04003106 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3107 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3108 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109
3110 /* Hash may have been set up in dcache_init_early */
3111 if (!hashdist)
3112 return;
3113
3114 dentry_hashtable =
3115 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003116 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117 dhash_entries,
3118 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003119 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003120 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003121 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003122 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003123 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003124 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125}
3126
3127/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003128struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003129EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131void __init vfs_caches_init_early(void)
3132{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003133 int i;
3134
3135 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3136 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3137
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138 dcache_init_early();
3139 inode_init_early();
3140}
3141
Mel Gorman4248b0d2015-08-06 15:46:20 -07003142void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143{
David Windsor6a9b8822017-06-10 22:50:30 -04003144 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3145 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146
Denis Cheng74bf17c2007-10-16 23:26:30 -07003147 dcache_init();
3148 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003149 files_init();
3150 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003151 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152 bdev_cache_init();
3153 chrdev_init();
3154}