blob: 2acfc69878f55cc175d019156c15f031b3741c80 [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 Howells07f3f052006-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 Torvalds6326c71f2012-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 {
295 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
296 spin_unlock(&dentry->d_lock);
297 name->name = name->inline_name;
298 }
299}
300EXPORT_SYMBOL(take_dentry_name_snapshot);
301
302void release_dentry_name_snapshot(struct name_snapshot *name)
303{
304 if (unlikely(name->name != name->inline_name)) {
305 struct external_name *p;
306 p = container_of(name->name, struct external_name, name[0]);
307 if (unlikely(atomic_dec_and_test(&p->u.count)))
Roman Gushchinf1782c92018-04-10 16:27:44 -0700308 call_rcu(&p->u.head, __d_free_external_name);
Al Viro49d31c22017-07-07 14:51:19 -0400309 }
310}
311EXPORT_SYMBOL(release_dentry_name_snapshot);
312
David Howells4bf46a22015-03-05 14:09:22 +0000313static inline void __d_set_inode_and_type(struct dentry *dentry,
314 struct inode *inode,
315 unsigned type_flags)
316{
317 unsigned flags;
318
319 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000320 flags = READ_ONCE(dentry->d_flags);
321 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
322 flags |= type_flags;
323 WRITE_ONCE(dentry->d_flags, flags);
324}
325
David Howells4bf46a22015-03-05 14:09:22 +0000326static inline void __d_clear_type_and_inode(struct dentry *dentry)
327{
328 unsigned flags = READ_ONCE(dentry->d_flags);
329
330 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
331 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000332 dentry->d_inode = NULL;
333}
334
Al Virob4f03542014-04-29 23:40:14 -0400335static void dentry_free(struct dentry *dentry)
336{
Al Viro946e51f2014-10-26 19:19:16 -0400337 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400338 if (unlikely(dname_external(dentry))) {
339 struct external_name *p = external_name(dentry);
340 if (likely(atomic_dec_and_test(&p->u.count))) {
341 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
342 return;
343 }
344 }
Al Virob4f03542014-04-29 23:40:14 -0400345 /* if dentry was never visible to RCU, immediate free is OK */
346 if (!(dentry->d_flags & DCACHE_RCUACCESS))
347 __d_free(&dentry->d_u.d_rcu);
348 else
349 call_rcu(&dentry->d_u.d_rcu, __d_free);
350}
351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352/*
353 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400354 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100355 */
356static void dentry_unlink_inode(struct dentry * dentry)
357 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100358 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100359{
360 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400361 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500362
Al Viro550dce02016-05-29 20:13:30 -0400363 if (hashed)
364 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000365 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400366 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400367 if (hashed)
368 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100369 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100370 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100371 if (!inode->i_nlink)
372 fsnotify_inoderemove(inode);
373 if (dentry->d_op && dentry->d_op->d_iput)
374 dentry->d_op->d_iput(dentry, inode);
375 else
376 iput(inode);
377}
378
379/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400380 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
381 * is in use - which includes both the "real" per-superblock
382 * LRU list _and_ the DCACHE_SHRINK_LIST use.
383 *
384 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
385 * on the shrink list (ie not on the superblock LRU list).
386 *
387 * The per-cpu "nr_dentry_unused" counters are updated with
388 * the DCACHE_LRU_LIST bit.
389 *
390 * These helper functions make sure we always follow the
391 * rules. d_lock must be held by the caller.
392 */
393#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
394static void d_lru_add(struct dentry *dentry)
395{
396 D_FLAG_VERIFY(dentry, 0);
397 dentry->d_flags |= DCACHE_LRU_LIST;
398 this_cpu_inc(nr_dentry_unused);
399 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
400}
401
402static void d_lru_del(struct dentry *dentry)
403{
404 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
405 dentry->d_flags &= ~DCACHE_LRU_LIST;
406 this_cpu_dec(nr_dentry_unused);
407 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
408}
409
410static void d_shrink_del(struct dentry *dentry)
411{
412 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
413 list_del_init(&dentry->d_lru);
414 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
415 this_cpu_dec(nr_dentry_unused);
416}
417
418static void d_shrink_add(struct dentry *dentry, struct list_head *list)
419{
420 D_FLAG_VERIFY(dentry, 0);
421 list_add(&dentry->d_lru, list);
422 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
423 this_cpu_inc(nr_dentry_unused);
424}
425
426/*
427 * These can only be called under the global LRU lock, ie during the
428 * callback for freeing the LRU list. "isolate" removes it from the
429 * LRU lists entirely, while shrink_move moves it to the indicated
430 * private list.
431 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800432static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400433{
434 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
435 dentry->d_flags &= ~DCACHE_LRU_LIST;
436 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800437 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400438}
439
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800440static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
441 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400442{
443 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
444 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800445 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400446}
447
Miklos Szeredid52b9082007-05-08 00:23:46 -0700448/**
Nick Piggin789680d2011-01-07 17:49:30 +1100449 * d_drop - drop a dentry
450 * @dentry: dentry to drop
451 *
452 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
453 * be found through a VFS lookup any more. Note that this is different from
454 * deleting the dentry - d_delete will try to mark the dentry negative if
455 * possible, giving a successful _negative_ lookup, while d_drop will
456 * just make the cache lookup fail.
457 *
458 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
459 * reason (NFS timeouts or autofs deletes).
460 *
NeilBrown61647822017-11-10 15:45:41 +1100461 * __d_drop requires dentry->d_lock
462 * ___d_drop doesn't mark dentry as "unhashed"
463 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100464 */
NeilBrown61647822017-11-10 15:45:41 +1100465static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100466{
Al Viro0632a9a2018-03-07 00:49:10 -0500467 struct hlist_bl_head *b;
468 /*
469 * Hashed dentries are normally on the dentry hashtable,
470 * with the exception of those newly allocated by
471 * d_obtain_root, which are always IS_ROOT:
472 */
473 if (unlikely(IS_ROOT(dentry)))
474 b = &dentry->d_sb->s_roots;
475 else
476 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400477
Al Viro0632a9a2018-03-07 00:49:10 -0500478 hlist_bl_lock(b);
479 __hlist_bl_del(&dentry->d_hash);
480 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100481}
NeilBrown61647822017-11-10 15:45:41 +1100482
483void __d_drop(struct dentry *dentry)
484{
Al Viro0632a9a2018-03-07 00:49:10 -0500485 if (!d_unhashed(dentry)) {
486 ___d_drop(dentry);
487 dentry->d_hash.pprev = NULL;
488 write_seqcount_invalidate(&dentry->d_seq);
489 }
NeilBrown61647822017-11-10 15:45:41 +1100490}
Nick Piggin789680d2011-01-07 17:49:30 +1100491EXPORT_SYMBOL(__d_drop);
492
493void d_drop(struct dentry *dentry)
494{
Nick Piggin789680d2011-01-07 17:49:30 +1100495 spin_lock(&dentry->d_lock);
496 __d_drop(dentry);
497 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100498}
499EXPORT_SYMBOL(d_drop);
500
Al Viroba65dc52016-06-10 11:32:47 -0400501static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
502{
503 struct dentry *next;
504 /*
505 * Inform d_walk() and shrink_dentry_list() that we are no longer
506 * attached to the dentry tree
507 */
508 dentry->d_flags |= DCACHE_DENTRY_KILLED;
509 if (unlikely(list_empty(&dentry->d_child)))
510 return;
511 __list_del_entry(&dentry->d_child);
512 /*
513 * Cursors can move around the list of children. While we'd been
514 * a normal list member, it didn't matter - ->d_child.next would've
515 * been updated. However, from now on it won't be and for the
516 * things like d_walk() it might end up with a nasty surprise.
517 * Normally d_walk() doesn't care about cursors moving around -
518 * ->d_lock on parent prevents that and since a cursor has no children
519 * of its own, we get through it without ever unlocking the parent.
520 * There is one exception, though - if we ascend from a child that
521 * gets killed as soon as we unlock it, the next sibling is found
522 * using the value left in its ->d_child.next. And if _that_
523 * pointed to a cursor, and cursor got moved (e.g. by lseek())
524 * before d_walk() regains parent->d_lock, we'll end up skipping
525 * everything the cursor had been moved past.
526 *
527 * Solution: make sure that the pointer left behind in ->d_child.next
528 * points to something that won't be moving around. I.e. skip the
529 * cursors.
530 */
531 while (dentry->d_child.next != &parent->d_subdirs) {
532 next = list_entry(dentry->d_child.next, struct dentry, d_child);
533 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
534 break;
535 dentry->d_child.next = next->d_child.next;
536 }
537}
538
Al Viroe55fd012014-05-28 13:51:12 -0400539static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100540{
Al Viro41edf272014-05-01 10:30:00 -0400541 struct dentry *parent = NULL;
542 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400543 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100544 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100545
Linus Torvalds0d984392013-09-08 13:46:52 -0700546 /*
547 * The dentry is now unrecoverably dead to the world.
548 */
549 lockref_mark_dead(&dentry->d_lockref);
550
Sage Weilf0023bc2011-10-28 10:02:42 -0700551 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700552 * inform the fs via d_prune that this dentry is about to be
553 * unhashed and destroyed.
554 */
Al Viro29266202014-05-30 11:39:02 -0400555 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800556 dentry->d_op->d_prune(dentry);
557
Al Viro01b60352014-04-29 23:42:52 -0400558 if (dentry->d_flags & DCACHE_LRU_LIST) {
559 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
560 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400561 }
Nick Piggin77812a12011-01-07 17:49:48 +1100562 /* if it was on the hash then remove it */
563 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400564 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400565 if (parent)
566 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400567 if (dentry->d_inode)
568 dentry_unlink_inode(dentry);
569 else
570 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400571 this_cpu_dec(nr_dentry);
572 if (dentry->d_op && dentry->d_op->d_release)
573 dentry->d_op->d_release(dentry);
574
Al Viro41edf272014-05-01 10:30:00 -0400575 spin_lock(&dentry->d_lock);
576 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
577 dentry->d_flags |= DCACHE_MAY_FREE;
578 can_free = false;
579 }
580 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400581 if (likely(can_free))
582 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400583}
584
Al Viro8b987a42018-02-23 22:11:34 -0500585static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400586{
Al Viro8b987a42018-02-23 22:11:34 -0500587 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400588 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400589 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400590again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700591 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400592 spin_lock(&parent->d_lock);
593 /*
594 * We can't blindly lock dentry until we are sure
595 * that we won't violate the locking order.
596 * Any changes of dentry->d_parent must have
597 * been done with parent->d_lock held, so
598 * spin_lock() above is enough of a barrier
599 * for checking if it's still our child.
600 */
601 if (unlikely(parent != dentry->d_parent)) {
602 spin_unlock(&parent->d_lock);
603 goto again;
604 }
Al Viro3b821402018-02-23 20:47:17 -0500605 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500606 if (parent != dentry)
607 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
608 else
609 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400610 return parent;
611}
612
Al Viro8b987a42018-02-23 22:11:34 -0500613static inline struct dentry *lock_parent(struct dentry *dentry)
614{
615 struct dentry *parent = dentry->d_parent;
616 if (IS_ROOT(dentry))
617 return NULL;
618 if (likely(spin_trylock(&parent->d_lock)))
619 return parent;
620 return __lock_parent(dentry);
621}
622
Al Viroa3385792018-02-23 21:07:24 -0500623static inline bool retain_dentry(struct dentry *dentry)
624{
625 WARN_ON(d_in_lookup(dentry));
626
627 /* Unreachable? Get rid of it */
628 if (unlikely(d_unhashed(dentry)))
629 return false;
630
631 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
632 return false;
633
634 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
635 if (dentry->d_op->d_delete(dentry))
636 return false;
637 }
Al Viro62d99562018-03-06 21:37:31 -0500638 /* retain; LRU fodder */
639 dentry->d_lockref.count--;
640 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
641 d_lru_add(dentry);
642 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
643 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500644 return true;
645}
646
Linus Torvalds360f5472015-01-09 15:19:03 -0800647/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100648 * Finish off a dentry we've decided to kill.
649 * dentry->d_lock must be held, returns with it unlocked.
650 * Returns dentry requiring refcount drop, or NULL if we're done.
651 */
652static struct dentry *dentry_kill(struct dentry *dentry)
653 __releases(dentry->d_lock)
654{
655 struct inode *inode = dentry->d_inode;
656 struct dentry *parent = NULL;
657
658 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500659 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100660
661 if (!IS_ROOT(dentry)) {
662 parent = dentry->d_parent;
663 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500664 parent = __lock_parent(dentry);
665 if (likely(inode || !dentry->d_inode))
666 goto got_locks;
667 /* negative that became positive */
668 if (parent)
669 spin_unlock(&parent->d_lock);
670 inode = dentry->d_inode;
671 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100672 }
673 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100674 __dentry_kill(dentry);
675 return parent;
676
Al Virof657a662018-02-23 21:25:42 -0500677slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100678 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500679 spin_lock(&inode->i_lock);
680 spin_lock(&dentry->d_lock);
681 parent = lock_parent(dentry);
682got_locks:
683 if (unlikely(dentry->d_lockref.count != 1)) {
684 dentry->d_lockref.count--;
685 } else if (likely(!retain_dentry(dentry))) {
686 __dentry_kill(dentry);
687 return parent;
688 }
689 /* we are keeping it, after all */
690 if (inode)
691 spin_unlock(&inode->i_lock);
692 if (parent)
693 spin_unlock(&parent->d_lock);
694 spin_unlock(&dentry->d_lock);
695 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100696}
697
698/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800699 * Try to do a lockless dput(), and return whether that was successful.
700 *
701 * If unsuccessful, we return false, having already taken the dentry lock.
702 *
703 * The caller needs to hold the RCU read lock, so that the dentry is
704 * guaranteed to stay around even if the refcount goes down to zero!
705 */
706static inline bool fast_dput(struct dentry *dentry)
707{
708 int ret;
709 unsigned int d_flags;
710
711 /*
712 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100713 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800714 */
715 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
716 return lockref_put_or_lock(&dentry->d_lockref);
717
718 /*
719 * .. otherwise, we can try to just decrement the
720 * lockref optimistically.
721 */
722 ret = lockref_put_return(&dentry->d_lockref);
723
724 /*
725 * If the lockref_put_return() failed due to the lock being held
726 * by somebody else, the fast path has failed. We will need to
727 * get the lock, and then check the count again.
728 */
729 if (unlikely(ret < 0)) {
730 spin_lock(&dentry->d_lock);
731 if (dentry->d_lockref.count > 1) {
732 dentry->d_lockref.count--;
733 spin_unlock(&dentry->d_lock);
734 return 1;
735 }
736 return 0;
737 }
738
739 /*
740 * If we weren't the last ref, we're done.
741 */
742 if (ret)
743 return 1;
744
745 /*
746 * Careful, careful. The reference count went down
747 * to zero, but we don't hold the dentry lock, so
748 * somebody else could get it again, and do another
749 * dput(), and we need to not race with that.
750 *
751 * However, there is a very special and common case
752 * where we don't care, because there is nothing to
753 * do: the dentry is still hashed, it does not have
754 * a 'delete' op, and it's referenced and already on
755 * the LRU list.
756 *
757 * NOTE! Since we aren't locked, these values are
758 * not "stable". However, it is sufficient that at
759 * some point after we dropped the reference the
760 * dentry was hashed and the flags had the proper
761 * value. Other dentry users may have re-gotten
762 * a reference to the dentry and change that, but
763 * our work is done - we can leave the dentry
764 * around with a zero refcount.
765 */
766 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700767 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100768 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800769
770 /* Nothing to do? Dropping the reference was all we needed? */
771 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
772 return 1;
773
774 /*
775 * Not the fast normal case? Get the lock. We've already decremented
776 * the refcount, but we'll need to re-check the situation after
777 * getting the lock.
778 */
779 spin_lock(&dentry->d_lock);
780
781 /*
782 * Did somebody else grab a reference to it in the meantime, and
783 * we're no longer the last user after all? Alternatively, somebody
784 * else could have killed it and marked it dead. Either way, we
785 * don't need to do anything else.
786 */
787 if (dentry->d_lockref.count) {
788 spin_unlock(&dentry->d_lock);
789 return 1;
790 }
791
792 /*
793 * Re-get the reference we optimistically dropped. We hold the
794 * lock, and we just tested that it was zero, so we can just
795 * set it to 1.
796 */
797 dentry->d_lockref.count = 1;
798 return 0;
799}
800
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802/*
803 * This is dput
804 *
805 * This is complicated by the fact that we do not want to put
806 * dentries that are no longer on any hash chain on the unused
807 * list: we'd much rather just get rid of them immediately.
808 *
809 * However, that implies that we have to traverse the dentry
810 * tree upwards to the parents which might _also_ now be
811 * scheduled for deletion (it may have been only waiting for
812 * its last child to go away).
813 *
814 * This tail recursion is done by hand as we don't want to depend
815 * on the compiler to always get this right (gcc generally doesn't).
816 * Real recursion would eat up our stack space.
817 */
818
819/*
820 * dput - release a dentry
821 * @dentry: dentry to release
822 *
823 * Release a dentry. This will drop the usage count and if appropriate
824 * call the dentry unlink method as well as removing it from the queues and
825 * releasing its resources. If the parent dentries were scheduled for release
826 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828void dput(struct dentry *dentry)
829{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700830 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return;
832
833repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800834 might_sleep();
835
Linus Torvalds360f5472015-01-09 15:19:03 -0800836 rcu_read_lock();
837 if (likely(fast_dput(dentry))) {
838 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800840 }
841
842 /* Slow case: now with the dentry lock held */
843 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Al Viroa3385792018-02-23 21:07:24 -0500845 if (likely(retain_dentry(dentry))) {
Al Viroa3385792018-02-23 21:07:24 -0500846 spin_unlock(&dentry->d_lock);
847 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 }
Nick Piggin265ac902010-10-10 05:36:24 -0400849
Al Viro8cbf74d2014-05-29 09:18:26 -0400850 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800851 if (dentry) {
852 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700853 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700856EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100859/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100860static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861{
Waiman Long98474232013-08-28 18:24:59 -0700862 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
864
Nick Piggindc0474b2011-01-07 17:49:43 +1100865static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100866{
Waiman Long98474232013-08-28 18:24:59 -0700867 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100868}
869
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100870struct dentry *dget_parent(struct dentry *dentry)
871{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700872 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100873 struct dentry *ret;
874
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700875 /*
876 * Do optimistic parent lookup without any
877 * locking.
878 */
879 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700880 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700881 gotref = lockref_get_not_zero(&ret->d_lockref);
882 rcu_read_unlock();
883 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700884 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700885 return ret;
886 dput(ret);
887 }
888
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100889repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100890 /*
891 * Don't need rcu_dereference because we re-check it was correct under
892 * the lock.
893 */
894 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100895 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100896 spin_lock(&ret->d_lock);
897 if (unlikely(ret != dentry->d_parent)) {
898 spin_unlock(&ret->d_lock);
899 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100900 goto repeat;
901 }
Nick Piggina734eb42011-01-07 17:49:44 +1100902 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700903 BUG_ON(!ret->d_lockref.count);
904 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100905 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100906 return ret;
907}
908EXPORT_SYMBOL(dget_parent);
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910/**
911 * d_find_alias - grab a hashed alias of inode
912 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 *
914 * If inode has a hashed alias, or is a directory and has any alias,
915 * acquire the reference to alias and return it. Otherwise return NULL.
916 * Notice that if inode is a directory there can be only one alias and
917 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800918 * of a filesystem, or if the directory was renamed and d_revalidate
919 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700921 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500922 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500924static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925{
Nick Pigginda502952011-01-07 17:49:33 +1100926 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Nick Pigginda502952011-01-07 17:49:33 +1100928again:
929 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400930 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100931 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700933 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100934 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500936 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100937 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100938 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 return alias;
940 }
941 }
Nick Pigginda502952011-01-07 17:49:33 +1100942 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 }
Nick Pigginda502952011-01-07 17:49:33 +1100944 if (discon_alias) {
945 alias = discon_alias;
946 spin_lock(&alias->d_lock);
947 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500948 __dget_dlock(alias);
949 spin_unlock(&alias->d_lock);
950 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100951 }
952 spin_unlock(&alias->d_lock);
953 goto again;
954 }
955 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
957
Nick Pigginda502952011-01-07 17:49:33 +1100958struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959{
David Howells214fda12006-03-25 03:06:36 -0800960 struct dentry *de = NULL;
961
Al Virob3d9b7a2012-06-09 13:51:19 -0400962 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100963 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500964 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100965 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 return de;
968}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700969EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
971/*
972 * Try to kill dentries associated with this inode.
973 * WARNING: you must own a reference to inode.
974 */
975void d_prune_aliases(struct inode *inode)
976{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700977 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100979 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400980 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700982 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400983 struct dentry *parent = lock_parent(dentry);
984 if (likely(!dentry->d_lockref.count)) {
985 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800986 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400987 goto restart;
988 }
989 if (parent)
990 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 }
992 spin_unlock(&dentry->d_lock);
993 }
Nick Piggin873feea2011-01-07 17:50:06 +1100994 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700996EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Al Viro3b3f09f2018-02-23 21:54:18 -0500998/*
999 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +01001000 * Called under rcu_read_lock() and dentry->d_lock; the former
1001 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -05001002 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +01001003 * d_delete(), etc.
1004 *
Al Viro3b3f09f2018-02-23 21:54:18 -05001005 * Return false if dentry has been disrupted or grabbed, leaving
1006 * the caller to kick it off-list. Otherwise, return true and have
1007 * that dentry's inode and parent both locked.
1008 */
1009static bool shrink_lock_dentry(struct dentry *dentry)
1010{
1011 struct inode *inode;
1012 struct dentry *parent;
1013
1014 if (dentry->d_lockref.count)
1015 return false;
1016
1017 inode = dentry->d_inode;
1018 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001019 spin_unlock(&dentry->d_lock);
1020 spin_lock(&inode->i_lock);
1021 spin_lock(&dentry->d_lock);
1022 if (unlikely(dentry->d_lockref.count))
1023 goto out;
1024 /* changed inode means that somebody had grabbed it */
1025 if (unlikely(inode != dentry->d_inode))
1026 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001027 }
1028
1029 parent = dentry->d_parent;
1030 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1031 return true;
1032
Al Viro3b3f09f2018-02-23 21:54:18 -05001033 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001034 spin_lock(&parent->d_lock);
1035 if (unlikely(parent != dentry->d_parent)) {
1036 spin_unlock(&parent->d_lock);
1037 spin_lock(&dentry->d_lock);
1038 goto out;
1039 }
1040 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001041 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001042 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001043 spin_unlock(&parent->d_lock);
1044out:
1045 if (inode)
1046 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001047 return false;
1048}
1049
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001050static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001052 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001053 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001054
Nikolay Borisov32785c02018-04-10 16:35:49 -07001055 cond_resched();
1056
Miklos Szeredi60942f22014-05-02 15:38:39 -04001057 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001058 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001059 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001060 if (!shrink_lock_dentry(dentry)) {
1061 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001062 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001063 d_shrink_del(dentry);
1064 if (dentry->d_lockref.count < 0)
1065 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001066 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001067 if (can_free)
1068 dentry_free(dentry);
1069 continue;
1070 }
John Ogness8f04da22018-02-23 00:50:24 +01001071 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001072 d_shrink_del(dentry);
1073 parent = dentry->d_parent;
Al Viroff2fde92014-05-28 13:59:13 -04001074 __dentry_kill(dentry);
Al Viro3b3f09f2018-02-23 21:54:18 -05001075 if (parent == dentry)
1076 continue;
Al Viro5c47e6d2014-04-29 16:13:18 -04001077 /*
1078 * We need to prune ancestors too. This is necessary to prevent
1079 * quadratic behavior of shrink_dcache_parent(), but is also
1080 * expected to be beneficial in reducing dentry cache
1081 * fragmentation.
1082 */
1083 dentry = parent;
John Ogness8f04da22018-02-23 00:50:24 +01001084 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
1085 dentry = dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001087}
1088
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001089static enum lru_status dentry_lru_isolate(struct list_head *item,
1090 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001091{
1092 struct list_head *freeable = arg;
1093 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1094
1095
1096 /*
1097 * we are inverting the lru lock/dentry->d_lock here,
1098 * so use a trylock. If we fail to get the lock, just skip
1099 * it
1100 */
1101 if (!spin_trylock(&dentry->d_lock))
1102 return LRU_SKIP;
1103
1104 /*
1105 * Referenced dentries are still in use. If they have active
1106 * counts, just remove them from the LRU. Otherwise give them
1107 * another pass through the LRU.
1108 */
1109 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001110 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001111 spin_unlock(&dentry->d_lock);
1112 return LRU_REMOVED;
1113 }
1114
1115 if (dentry->d_flags & DCACHE_REFERENCED) {
1116 dentry->d_flags &= ~DCACHE_REFERENCED;
1117 spin_unlock(&dentry->d_lock);
1118
1119 /*
1120 * The list move itself will be made by the common LRU code. At
1121 * this point, we've dropped the dentry->d_lock but keep the
1122 * lru lock. This is safe to do, since every list movement is
1123 * protected by the lru lock even if both locks are held.
1124 *
1125 * This is guaranteed by the fact that all LRU management
1126 * functions are intermediated by the LRU API calls like
1127 * list_lru_add and list_lru_del. List movement in this file
1128 * only ever occur through this functions or through callbacks
1129 * like this one, that are called from the LRU API.
1130 *
1131 * The only exceptions to this are functions like
1132 * shrink_dentry_list, and code that first checks for the
1133 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1134 * operating only with stack provided lists after they are
1135 * properly isolated from the main list. It is thus, always a
1136 * local access.
1137 */
1138 return LRU_ROTATE;
1139 }
1140
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001141 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001142 spin_unlock(&dentry->d_lock);
1143
1144 return LRU_REMOVED;
1145}
1146
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001147/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001148 * prune_dcache_sb - shrink the dcache
1149 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001150 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001151 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001152 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1153 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001154 * function.
1155 *
1156 * This function may fail to free any resources if all the dentries are in
1157 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001158 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001159long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001160{
Dave Chinnerf6041562013-08-28 10:18:00 +10001161 LIST_HEAD(dispose);
1162 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001163
Vladimir Davydov503c3582015-02-12 14:58:47 -08001164 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1165 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001166 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001167 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168}
1169
Glauber Costa4e717f52013-08-28 10:18:03 +10001170static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001171 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001172{
Glauber Costa4e717f52013-08-28 10:18:03 +10001173 struct list_head *freeable = arg;
1174 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001175
Glauber Costa4e717f52013-08-28 10:18:03 +10001176 /*
1177 * we are inverting the lru lock/dentry->d_lock here,
1178 * so use a trylock. If we fail to get the lock, just skip
1179 * it
1180 */
1181 if (!spin_trylock(&dentry->d_lock))
1182 return LRU_SKIP;
1183
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001184 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001185 spin_unlock(&dentry->d_lock);
1186
1187 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001188}
1189
Glauber Costa4e717f52013-08-28 10:18:03 +10001190
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001191/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 * shrink_dcache_sb - shrink dcache for a superblock
1193 * @sb: superblock
1194 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001195 * Shrink the dcache for the specified super block. This is used to free
1196 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001198void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199{
Glauber Costa4e717f52013-08-28 10:18:03 +10001200 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001201
Glauber Costa4e717f52013-08-28 10:18:03 +10001202 do {
1203 LIST_HEAD(dispose);
1204
1205 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001206 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001207
1208 this_cpu_sub(nr_dentry_unused, freed);
1209 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001210 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001212EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001215 * enum d_walk_ret - action to talke during tree walk
1216 * @D_WALK_CONTINUE: contrinue walk
1217 * @D_WALK_QUIT: quit walk
1218 * @D_WALK_NORETRY: quit when retry is needed
1219 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001221enum d_walk_ret {
1222 D_WALK_CONTINUE,
1223 D_WALK_QUIT,
1224 D_WALK_NORETRY,
1225 D_WALK_SKIP,
1226};
1227
1228/**
1229 * d_walk - walk the dentry tree
1230 * @parent: start of walk
1231 * @data: data passed to @enter() and @finish()
1232 * @enter: callback when first entering the dentry
1233 * @finish: callback when successfully finished the walk
1234 *
1235 * The @enter() and @finish() callbacks are called with d_lock held.
1236 */
1237static void d_walk(struct dentry *parent, void *data,
1238 enum d_walk_ret (*enter)(void *, struct dentry *),
1239 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240{
Nick Piggin949854d2011-01-07 17:49:37 +11001241 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001243 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001244 enum d_walk_ret ret;
1245 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001246
Nick Piggin58db63d2011-01-07 17:49:39 +11001247again:
Al Viro48f5ec22013-09-09 15:22:25 -04001248 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001249 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001250 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001251
1252 ret = enter(data, this_parent);
1253 switch (ret) {
1254 case D_WALK_CONTINUE:
1255 break;
1256 case D_WALK_QUIT:
1257 case D_WALK_SKIP:
1258 goto out_unlock;
1259 case D_WALK_NORETRY:
1260 retry = false;
1261 break;
1262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263repeat:
1264 next = this_parent->d_subdirs.next;
1265resume:
1266 while (next != &this_parent->d_subdirs) {
1267 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001268 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001270
Al Viroba65dc52016-06-10 11:32:47 -04001271 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1272 continue;
1273
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001274 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001275
1276 ret = enter(data, dentry);
1277 switch (ret) {
1278 case D_WALK_CONTINUE:
1279 break;
1280 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001281 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001282 goto out_unlock;
1283 case D_WALK_NORETRY:
1284 retry = false;
1285 break;
1286 case D_WALK_SKIP:
1287 spin_unlock(&dentry->d_lock);
1288 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001289 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001292 spin_unlock(&this_parent->d_lock);
1293 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001295 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 goto repeat;
1297 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001298 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 }
1300 /*
1301 * All done at this level ... ascend and resume the search.
1302 */
Al Viroca5358e2014-10-26 19:31:10 -04001303 rcu_read_lock();
1304ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001306 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001307 this_parent = child->d_parent;
1308
Al Viro31dec132013-10-25 17:04:27 -04001309 spin_unlock(&child->d_lock);
1310 spin_lock(&this_parent->d_lock);
1311
Al Viroca5358e2014-10-26 19:31:10 -04001312 /* might go back up the wrong parent if we have had a rename. */
1313 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001314 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001315 /* go into the first sibling still alive */
1316 do {
1317 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001318 if (next == &this_parent->d_subdirs)
1319 goto ascend;
1320 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001321 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001322 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 goto resume;
1324 }
Al Viroca5358e2014-10-26 19:31:10 -04001325 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001326 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001327 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001328 if (finish)
1329 finish(data);
1330
1331out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001332 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001333 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001334 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001335
1336rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001337 spin_unlock(&this_parent->d_lock);
1338 rcu_read_unlock();
1339 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001340 if (!retry)
1341 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001342 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001343 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001345
Ian Kent01619492016-11-24 08:03:41 +11001346struct check_mount {
1347 struct vfsmount *mnt;
1348 unsigned int mounted;
1349};
1350
1351static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1352{
1353 struct check_mount *info = data;
1354 struct path path = { .mnt = info->mnt, .dentry = dentry };
1355
1356 if (likely(!d_mountpoint(dentry)))
1357 return D_WALK_CONTINUE;
1358 if (__path_is_mountpoint(&path)) {
1359 info->mounted = 1;
1360 return D_WALK_QUIT;
1361 }
1362 return D_WALK_CONTINUE;
1363}
1364
1365/**
1366 * path_has_submounts - check for mounts over a dentry in the
1367 * current namespace.
1368 * @parent: path to check.
1369 *
1370 * Return true if the parent or its subdirectories contain
1371 * a mount point in the current namespace.
1372 */
1373int path_has_submounts(const struct path *parent)
1374{
1375 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1376
1377 read_seqlock_excl(&mount_lock);
1378 d_walk(parent->dentry, &data, path_check_mount, NULL);
1379 read_sequnlock_excl(&mount_lock);
1380
1381 return data.mounted;
1382}
1383EXPORT_SYMBOL(path_has_submounts);
1384
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001386 * Called by mount code to set a mountpoint and check if the mountpoint is
1387 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1388 * subtree can become unreachable).
1389 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001390 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001391 * this reason take rename_lock and d_lock on dentry and ancestors.
1392 */
1393int d_set_mounted(struct dentry *dentry)
1394{
1395 struct dentry *p;
1396 int ret = -ENOENT;
1397 write_seqlock(&rename_lock);
1398 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001399 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001400 spin_lock(&p->d_lock);
1401 if (unlikely(d_unhashed(p))) {
1402 spin_unlock(&p->d_lock);
1403 goto out;
1404 }
1405 spin_unlock(&p->d_lock);
1406 }
1407 spin_lock(&dentry->d_lock);
1408 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001409 ret = -EBUSY;
1410 if (!d_mountpoint(dentry)) {
1411 dentry->d_flags |= DCACHE_MOUNTED;
1412 ret = 0;
1413 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001414 }
1415 spin_unlock(&dentry->d_lock);
1416out:
1417 write_sequnlock(&rename_lock);
1418 return ret;
1419}
1420
1421/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001422 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 * and move any unused dentries to the end of the unused
1424 * list for prune_dcache(). We descend to the next level
1425 * whenever the d_subdirs list is non-empty and continue
1426 * searching.
1427 *
1428 * It returns zero iff there are no unused children,
1429 * otherwise it returns the number of children moved to
1430 * the end of the unused list. This may not be the total
1431 * number of unused children, because select_parent can
1432 * drop the lock and return early due to latency
1433 * constraints.
1434 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001435
1436struct select_data {
1437 struct dentry *start;
1438 struct list_head dispose;
1439 int found;
1440};
1441
1442static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001444 struct select_data *data = _data;
1445 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001447 if (data->start == dentry)
1448 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Al Virofe915222014-05-03 00:02:25 -04001450 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001451 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001452 } else {
1453 if (dentry->d_flags & DCACHE_LRU_LIST)
1454 d_lru_del(dentry);
1455 if (!dentry->d_lockref.count) {
1456 d_shrink_add(dentry, &data->dispose);
1457 data->found++;
1458 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 }
1460 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001461 * We can return to the caller if we have found some (this
1462 * ensures forward progress). We'll be coming back to find
1463 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 */
Al Virofe915222014-05-03 00:02:25 -04001465 if (!list_empty(&data->dispose))
1466 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001468 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469}
1470
1471/**
1472 * shrink_dcache_parent - prune dcache
1473 * @parent: parent of entries to prune
1474 *
1475 * Prune the dcache to remove unused children of the parent dentry.
1476 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001477void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001479 for (;;) {
1480 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001482 INIT_LIST_HEAD(&data.dispose);
1483 data.start = parent;
1484 data.found = 0;
1485
1486 d_walk(parent, &data, select_collect, NULL);
1487 if (!data.found)
1488 break;
1489
1490 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001493EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Al Viro9c8c10e2014-05-02 20:36:10 -04001495static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001496{
Al Viro9c8c10e2014-05-02 20:36:10 -04001497 /* it has busy descendents; complain about those instead */
1498 if (!list_empty(&dentry->d_subdirs))
1499 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001500
Al Viro9c8c10e2014-05-02 20:36:10 -04001501 /* root with refcount 1 is fine */
1502 if (dentry == _data && dentry->d_lockref.count == 1)
1503 return D_WALK_CONTINUE;
1504
1505 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1506 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001507 dentry,
1508 dentry->d_inode ?
1509 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001510 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001511 dentry->d_lockref.count,
1512 dentry->d_sb->s_type->name,
1513 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001514 WARN_ON(1);
1515 return D_WALK_CONTINUE;
1516}
1517
1518static void do_one_tree(struct dentry *dentry)
1519{
1520 shrink_dcache_parent(dentry);
1521 d_walk(dentry, dentry, umount_check, NULL);
1522 d_drop(dentry);
1523 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001524}
1525
1526/*
1527 * destroy the dentries attached to a superblock on unmounting
1528 */
1529void shrink_dcache_for_umount(struct super_block *sb)
1530{
1531 struct dentry *dentry;
1532
Al Viro9c8c10e2014-05-02 20:36:10 -04001533 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001534
1535 dentry = sb->s_root;
1536 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001537 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001538
NeilBrownf1ee6162017-12-21 09:45:40 +11001539 while (!hlist_bl_empty(&sb->s_roots)) {
1540 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001541 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001542 }
1543}
1544
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001545struct detach_data {
1546 struct select_data select;
1547 struct dentry *mountpoint;
1548};
1549static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001550{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001551 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552
1553 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001554 __dget_dlock(dentry);
1555 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001556 return D_WALK_QUIT;
1557 }
1558
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001559 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001560}
1561
1562static void check_and_drop(void *_data)
1563{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001564 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001565
Al Viro81be24d2017-06-03 07:20:09 +01001566 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001567 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001568}
1569
1570/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001571 * d_invalidate - detach submounts, prune dcache, and drop
1572 * @dentry: dentry to invalidate (aka detach, prune and drop)
1573 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001574 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001576 * The final d_drop is done as an atomic operation relative to
1577 * rename_lock ensuring there are no races with d_set_mounted. This
1578 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001579 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001580void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001581{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001582 /*
1583 * If it's already been dropped, return OK.
1584 */
1585 spin_lock(&dentry->d_lock);
1586 if (d_unhashed(dentry)) {
1587 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001588 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001589 }
1590 spin_unlock(&dentry->d_lock);
1591
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001592 /* Negative dentries can be dropped without further checks */
1593 if (!dentry->d_inode) {
1594 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001595 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001596 }
1597
1598 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001599 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001600
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001601 data.mountpoint = NULL;
1602 INIT_LIST_HEAD(&data.select.dispose);
1603 data.select.start = dentry;
1604 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001605
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001606 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001607
Al Viro81be24d2017-06-03 07:20:09 +01001608 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001609 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001610 else if (!data.mountpoint)
1611 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001612
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001613 if (data.mountpoint) {
1614 detach_mounts(data.mountpoint);
1615 dput(data.mountpoint);
1616 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001617 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001618}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001619EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001620
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621/**
Al Viroa4464db2011-07-07 15:03:58 -04001622 * __d_alloc - allocate a dcache entry
1623 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 * @name: qstr of the name
1625 *
1626 * Allocates a dentry. It returns %NULL if there is insufficient memory
1627 * available. On a success the dentry is returned. The name passed in is
1628 * copied and the copy passed in may be reused after this call.
1629 */
1630
Al Viroa4464db2011-07-07 15:03:58 -04001631struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632{
Roman Gushchinf1782c92018-04-10 16:27:44 -07001633 struct external_name *ext = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 struct dentry *dentry;
1635 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001636 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Mel Gormane12ba742007-10-16 01:25:52 -07001638 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 if (!dentry)
1640 return NULL;
1641
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001642 /*
1643 * We guarantee that the inline name is always NUL-terminated.
1644 * This way the memcpy() done by the name switching in rename
1645 * will still always have a NUL at the end, even if we might
1646 * be overwriting an internal NUL character
1647 */
1648 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001649 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001650 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001651 dname = dentry->d_iname;
1652 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001653 size_t size = offsetof(struct external_name, name[1]);
Roman Gushchinf1782c92018-04-10 16:27:44 -07001654
1655 ext = kmalloc(size + name->len, GFP_KERNEL_ACCOUNT);
1656 if (!ext) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 kmem_cache_free(dentry_cache, dentry);
1658 return NULL;
1659 }
Roman Gushchinf1782c92018-04-10 16:27:44 -07001660 atomic_set(&ext->u.count, 1);
1661 dname = ext->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 } else {
1663 dname = dentry->d_iname;
1664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
1666 dentry->d_name.len = name->len;
1667 dentry->d_name.hash = name->hash;
1668 memcpy(dname, name->name, name->len);
1669 dname[name->len] = 0;
1670
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001671 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001672 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001673
Waiman Long98474232013-08-28 18:24:59 -07001674 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001675 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001677 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001679 dentry->d_parent = dentry;
1680 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 dentry->d_op = NULL;
1682 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001683 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 INIT_LIST_HEAD(&dentry->d_lru);
1685 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001686 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1687 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001688 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689
Miklos Szeredi285b1022016-06-28 11:47:32 +02001690 if (dentry->d_op && dentry->d_op->d_init) {
1691 err = dentry->d_op->d_init(dentry);
1692 if (err) {
1693 if (dname_external(dentry))
1694 kfree(external_name(dentry));
1695 kmem_cache_free(dentry_cache, dentry);
1696 return NULL;
1697 }
1698 }
1699
Roman Gushchinf1782c92018-04-10 16:27:44 -07001700 if (unlikely(ext)) {
1701 pg_data_t *pgdat = page_pgdat(virt_to_page(ext));
1702 mod_node_page_state(pgdat, NR_INDIRECTLY_RECLAIMABLE_BYTES,
1703 ksize(ext));
1704 }
1705
Nick Piggin3e880fb2011-01-07 17:49:19 +11001706 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001707
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 return dentry;
1709}
Al Viroa4464db2011-07-07 15:03:58 -04001710
1711/**
1712 * d_alloc - allocate a dcache entry
1713 * @parent: parent of entry to allocate
1714 * @name: qstr of the name
1715 *
1716 * Allocates a dentry. It returns %NULL if there is insufficient memory
1717 * available. On a success the dentry is returned. The name passed in is
1718 * copied and the copy passed in may be reused after this call.
1719 */
1720struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1721{
1722 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1723 if (!dentry)
1724 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001725 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001726 spin_lock(&parent->d_lock);
1727 /*
1728 * don't need child lock because it is not subject
1729 * to concurrency here
1730 */
1731 __dget_dlock(parent);
1732 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001733 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001734 spin_unlock(&parent->d_lock);
1735
1736 return dentry;
1737}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001738EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
Miklos Szeredif9c34672018-01-19 11:39:52 +01001740struct dentry *d_alloc_anon(struct super_block *sb)
1741{
1742 return __d_alloc(sb, NULL);
1743}
1744EXPORT_SYMBOL(d_alloc_anon);
1745
Al Viroba65dc52016-06-10 11:32:47 -04001746struct dentry *d_alloc_cursor(struct dentry * parent)
1747{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001748 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001749 if (dentry) {
1750 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1751 dentry->d_parent = dget(parent);
1752 }
1753 return dentry;
1754}
1755
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001756/**
1757 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1758 * @sb: the superblock
1759 * @name: qstr of the name
1760 *
1761 * For a filesystem that just pins its dentries in memory and never
1762 * performs lookups at all, return an unhashed IS_ROOT dentry.
1763 */
Nick Piggin4b936882011-01-07 17:50:07 +11001764struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1765{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001766 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001767}
1768EXPORT_SYMBOL(d_alloc_pseudo);
1769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1771{
1772 struct qstr q;
1773
1774 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001775 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 return d_alloc(parent, &q);
1777}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001778EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Nick Pigginfb045ad2011-01-07 17:49:55 +11001780void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1781{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001782 WARN_ON_ONCE(dentry->d_op);
1783 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001784 DCACHE_OP_COMPARE |
1785 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001786 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001787 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001788 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001789 dentry->d_op = op;
1790 if (!op)
1791 return;
1792 if (op->d_hash)
1793 dentry->d_flags |= DCACHE_OP_HASH;
1794 if (op->d_compare)
1795 dentry->d_flags |= DCACHE_OP_COMPARE;
1796 if (op->d_revalidate)
1797 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001798 if (op->d_weak_revalidate)
1799 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001800 if (op->d_delete)
1801 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001802 if (op->d_prune)
1803 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001804 if (op->d_real)
1805 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001806
1807}
1808EXPORT_SYMBOL(d_set_d_op);
1809
David Howellsdf1a0852015-01-29 12:02:28 +00001810
1811/*
1812 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1813 * @dentry - The dentry to mark
1814 *
1815 * Mark a dentry as falling through to the lower layer (as set with
1816 * d_pin_lower()). This flag may be recorded on the medium.
1817 */
1818void d_set_fallthru(struct dentry *dentry)
1819{
1820 spin_lock(&dentry->d_lock);
1821 dentry->d_flags |= DCACHE_FALLTHRU;
1822 spin_unlock(&dentry->d_lock);
1823}
1824EXPORT_SYMBOL(d_set_fallthru);
1825
David Howellsb18825a2013-09-12 19:22:53 +01001826static unsigned d_flags_for_inode(struct inode *inode)
1827{
David Howells44bdb5e2015-01-29 12:02:29 +00001828 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001829
1830 if (!inode)
1831 return DCACHE_MISS_TYPE;
1832
1833 if (S_ISDIR(inode->i_mode)) {
1834 add_flags = DCACHE_DIRECTORY_TYPE;
1835 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1836 if (unlikely(!inode->i_op->lookup))
1837 add_flags = DCACHE_AUTODIR_TYPE;
1838 else
1839 inode->i_opflags |= IOP_LOOKUP;
1840 }
David Howells44bdb5e2015-01-29 12:02:29 +00001841 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001842 }
1843
David Howells44bdb5e2015-01-29 12:02:29 +00001844 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001845 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001846 add_flags = DCACHE_SYMLINK_TYPE;
1847 goto type_determined;
1848 }
1849 inode->i_opflags |= IOP_NOFOLLOW;
1850 }
1851
1852 if (unlikely(!S_ISREG(inode->i_mode)))
1853 add_flags = DCACHE_SPECIAL_TYPE;
1854
1855type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001856 if (unlikely(IS_AUTOMOUNT(inode)))
1857 add_flags |= DCACHE_NEED_AUTOMOUNT;
1858 return add_flags;
1859}
1860
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001861static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1862{
David Howellsb18825a2013-09-12 19:22:53 +01001863 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001864 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001865
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001866 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001867 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001868 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001869 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001870 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001871 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001872 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001873}
1874
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875/**
1876 * d_instantiate - fill in inode information for a dentry
1877 * @entry: dentry to complete
1878 * @inode: inode to attach to this dentry
1879 *
1880 * Fill in inode information in the entry.
1881 *
1882 * This turns negative dentries into productive full members
1883 * of society.
1884 *
1885 * NOTE! This assumes that the inode count has been incremented
1886 * (or otherwise set) by the caller to indicate that it is now
1887 * in use by the dcache.
1888 */
1889
1890void d_instantiate(struct dentry *entry, struct inode * inode)
1891{
Al Viro946e51f2014-10-26 19:19:16 -04001892 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001893 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001894 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001895 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001896 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001897 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001898 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001900EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
Al Viro1e2e5472018-05-04 08:23:01 -04001902/*
1903 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1904 * with lockdep-related part of unlock_new_inode() done before
1905 * anything else. Use that instead of open-coding d_instantiate()/
1906 * unlock_new_inode() combinations.
1907 */
1908void d_instantiate_new(struct dentry *entry, struct inode *inode)
1909{
1910 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1911 BUG_ON(!inode);
1912 lockdep_annotate_inode_mutex_key(inode);
1913 security_d_instantiate(entry, inode);
1914 spin_lock(&inode->i_lock);
1915 __d_instantiate(entry, inode);
1916 WARN_ON(!(inode->i_state & I_NEW));
1917 inode->i_state &= ~I_NEW;
1918 smp_mb();
1919 wake_up_bit(&inode->i_state, __I_NEW);
1920 spin_unlock(&inode->i_lock);
1921}
1922EXPORT_SYMBOL(d_instantiate_new);
1923
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001925 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1926 * @entry: dentry to complete
1927 * @inode: inode to attach to this dentry
1928 *
1929 * Fill in inode information in the entry. If a directory alias is found, then
1930 * return an error (and drop inode). Together with d_materialise_unique() this
1931 * guarantees that a directory inode may never have more than one alias.
1932 */
1933int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1934{
Al Viro946e51f2014-10-26 19:19:16 -04001935 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001936
Al Virob9680912016-04-11 00:53:26 -04001937 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001938 spin_lock(&inode->i_lock);
1939 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1940 spin_unlock(&inode->i_lock);
1941 iput(inode);
1942 return -EBUSY;
1943 }
1944 __d_instantiate(entry, inode);
1945 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001946
1947 return 0;
1948}
1949EXPORT_SYMBOL(d_instantiate_no_diralias);
1950
Al Viroadc0e91a2012-01-08 16:49:21 -05001951struct dentry *d_make_root(struct inode *root_inode)
1952{
1953 struct dentry *res = NULL;
1954
1955 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001956 res = d_alloc_anon(root_inode->i_sb);
Al Viroadc0e91a2012-01-08 16:49:21 -05001957 if (res)
1958 d_instantiate(res, root_inode);
1959 else
1960 iput(root_inode);
1961 }
1962 return res;
1963}
1964EXPORT_SYMBOL(d_make_root);
1965
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001966static struct dentry * __d_find_any_alias(struct inode *inode)
1967{
1968 struct dentry *alias;
1969
Al Virob3d9b7a2012-06-09 13:51:19 -04001970 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001971 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001972 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001973 __dget(alias);
1974 return alias;
1975}
1976
Sage Weil46f72b32012-01-10 09:04:37 -08001977/**
1978 * d_find_any_alias - find any alias for a given inode
1979 * @inode: inode to find an alias for
1980 *
1981 * If any aliases exist for the given inode, take and return a
1982 * reference for one of them. If no aliases exist, return %NULL.
1983 */
1984struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001985{
1986 struct dentry *de;
1987
1988 spin_lock(&inode->i_lock);
1989 de = __d_find_any_alias(inode);
1990 spin_unlock(&inode->i_lock);
1991 return de;
1992}
Sage Weil46f72b32012-01-10 09:04:37 -08001993EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001994
Miklos Szeredif9c34672018-01-19 11:39:52 +01001995static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1996 struct inode *inode,
1997 bool disconnected)
1998{
1999 struct dentry *res;
2000 unsigned add_flags;
2001
2002 security_d_instantiate(dentry, inode);
2003 spin_lock(&inode->i_lock);
2004 res = __d_find_any_alias(inode);
2005 if (res) {
2006 spin_unlock(&inode->i_lock);
2007 dput(dentry);
2008 goto out_iput;
2009 }
2010
2011 /* attach a disconnected dentry */
2012 add_flags = d_flags_for_inode(inode);
2013
2014 if (disconnected)
2015 add_flags |= DCACHE_DISCONNECTED;
2016
2017 spin_lock(&dentry->d_lock);
2018 __d_set_inode_and_type(dentry, inode, add_flags);
2019 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08002020 if (!disconnected) {
2021 hlist_bl_lock(&dentry->d_sb->s_roots);
2022 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
2023 hlist_bl_unlock(&dentry->d_sb->s_roots);
2024 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01002025 spin_unlock(&dentry->d_lock);
2026 spin_unlock(&inode->i_lock);
2027
2028 return dentry;
2029
2030 out_iput:
2031 iput(inode);
2032 return res;
2033}
2034
2035struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2036{
2037 return __d_instantiate_anon(dentry, inode, true);
2038}
2039EXPORT_SYMBOL(d_instantiate_anon);
2040
2041static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002042{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002043 struct dentry *tmp;
2044 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002045
2046 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002047 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002048 if (IS_ERR(inode))
2049 return ERR_CAST(inode);
2050
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002051 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002052 if (res)
2053 goto out_iput;
2054
Miklos Szeredif9c34672018-01-19 11:39:52 +01002055 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002056 if (!tmp) {
2057 res = ERR_PTR(-ENOMEM);
2058 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002059 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002060
Miklos Szeredif9c34672018-01-19 11:39:52 +01002061 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002062
Miklos Szeredif9c34672018-01-19 11:39:52 +01002063out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002064 iput(inode);
2065 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002066}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002067
2068/**
2069 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2070 * @inode: inode to allocate the dentry for
2071 *
2072 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2073 * similar open by handle operations. The returned dentry may be anonymous,
2074 * or may have a full name (if the inode was already in the cache).
2075 *
2076 * When called on a directory inode, we must ensure that the inode only ever
2077 * has one dentry. If a dentry is found, that is returned instead of
2078 * allocating a new one.
2079 *
2080 * On successful return, the reference to the inode has been transferred
2081 * to the dentry. In case of an error the reference on the inode is released.
2082 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2083 * be passed in and the error will be propagated to the return value,
2084 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2085 */
2086struct dentry *d_obtain_alias(struct inode *inode)
2087{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002088 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002089}
Benny Halevyadc48722009-02-27 14:02:59 -08002090EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
2092/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002093 * d_obtain_root - find or allocate a dentry for a given inode
2094 * @inode: inode to allocate the dentry for
2095 *
2096 * Obtain an IS_ROOT dentry for the root of a filesystem.
2097 *
2098 * We must ensure that directory inodes only ever have one dentry. If a
2099 * dentry is found, that is returned instead of allocating a new one.
2100 *
2101 * On successful return, the reference to the inode has been transferred
2102 * to the dentry. In case of an error the reference on the inode is
2103 * released. A %NULL or IS_ERR inode may be passed in and will be the
2104 * error will be propagate to the return value, with a %NULL @inode
2105 * replaced by ERR_PTR(-ESTALE).
2106 */
2107struct dentry *d_obtain_root(struct inode *inode)
2108{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002109 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002110}
2111EXPORT_SYMBOL(d_obtain_root);
2112
2113/**
Barry Naujok94035402008-05-21 16:50:46 +10002114 * d_add_ci - lookup or allocate new dentry with case-exact name
2115 * @inode: the inode case-insensitive lookup has found
2116 * @dentry: the negative dentry that was passed to the parent's lookup func
2117 * @name: the case-exact name to be associated with the returned dentry
2118 *
2119 * This is to avoid filling the dcache with case-insensitive names to the
2120 * same inode, only the actual correct case is stored in the dcache for
2121 * case-insensitive filesystems.
2122 *
2123 * For a case-insensitive lookup match and if the the case-exact dentry
2124 * already exists in in the dcache, use it and return it.
2125 *
2126 * If no entry exists with the exact case name, allocate new dentry with
2127 * the exact case, and return the spliced entry.
2128 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002129struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002130 struct qstr *name)
2131{
Al Virod9171b92016-04-15 03:33:13 -04002132 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002133
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002134 /*
2135 * First check if a dentry matching the name already exists,
2136 * if not go ahead and create it now.
2137 */
Barry Naujok94035402008-05-21 16:50:46 +10002138 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002139 if (found) {
2140 iput(inode);
2141 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002142 }
Al Virod9171b92016-04-15 03:33:13 -04002143 if (d_in_lookup(dentry)) {
2144 found = d_alloc_parallel(dentry->d_parent, name,
2145 dentry->d_wait);
2146 if (IS_ERR(found) || !d_in_lookup(found)) {
2147 iput(inode);
2148 return found;
2149 }
2150 } else {
2151 found = d_alloc(dentry->d_parent, name);
2152 if (!found) {
2153 iput(inode);
2154 return ERR_PTR(-ENOMEM);
2155 }
2156 }
2157 res = d_splice_alias(inode, found);
2158 if (res) {
2159 dput(found);
2160 return res;
2161 }
Al Viro4f522a22013-02-11 23:20:37 -05002162 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002163}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002164EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002166
Al Virod4c91a82016-06-25 23:33:49 -04002167static inline bool d_same_name(const struct dentry *dentry,
2168 const struct dentry *parent,
2169 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002170{
Al Virod4c91a82016-06-25 23:33:49 -04002171 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2172 if (dentry->d_name.len != name->len)
2173 return false;
2174 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002175 }
Al Viro6fa67e72016-07-31 16:37:25 -04002176 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002177 dentry->d_name.len, dentry->d_name.name,
2178 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002179}
2180
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002182 * __d_lookup_rcu - search for a dentry (racy, store-free)
2183 * @parent: parent dentry
2184 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002185 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002186 * Returns: dentry, or NULL
2187 *
2188 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2189 * resolution (store-free path walking) design described in
2190 * Documentation/filesystems/path-lookup.txt.
2191 *
2192 * This is not to be used outside core vfs.
2193 *
2194 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2195 * held, and rcu_read_lock held. The returned dentry must not be stored into
2196 * without taking d_lock and checking d_seq sequence count against @seq
2197 * returned here.
2198 *
Linus Torvalds15570082013-09-02 11:38:06 -07002199 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002200 * function.
2201 *
2202 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2203 * the returned dentry, so long as its parent's seqlock is checked after the
2204 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2205 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002206 *
2207 * NOTE! The caller *has* to check the resulting dentry against the sequence
2208 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002209 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002210struct dentry *__d_lookup_rcu(const struct dentry *parent,
2211 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002212 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002213{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002214 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002215 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002216 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002217 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002218 struct dentry *dentry;
2219
2220 /*
2221 * Note: There is significant duplication with __d_lookup_rcu which is
2222 * required to prevent single threaded performance regressions
2223 * especially on architectures where smp_rmb (in seqcounts) are costly.
2224 * Keep the two functions in sync.
2225 */
2226
2227 /*
2228 * The hash list is protected using RCU.
2229 *
2230 * Carefully use d_seq when comparing a candidate dentry, to avoid
2231 * races with d_move().
2232 *
2233 * It is possible that concurrent renames can mess up our list
2234 * walk here and result in missing our dentry, resulting in the
2235 * false-negative result. d_lookup() protects against concurrent
2236 * renames using rename_lock seqlock.
2237 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002238 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002239 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002240 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002241 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002242
Nick Piggin31e6b012011-01-07 17:49:52 +11002243seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002244 /*
2245 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002246 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002247 *
2248 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002249 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002250 *
2251 * NOTE! We do a "raw" seqcount_begin here. That means that
2252 * we don't wait for the sequence count to stabilize if it
2253 * is in the middle of a sequence change. If we do the slow
2254 * dentry compare, we will do seqretries until it is stable,
2255 * and if we end up with a successful lookup, we actually
2256 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002257 *
2258 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2259 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002260 */
2261 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002262 if (dentry->d_parent != parent)
2263 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002264 if (d_unhashed(dentry))
2265 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002266
2267 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002268 int tlen;
2269 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002270 if (dentry->d_name.hash != hashlen_hash(hashlen))
2271 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002272 tlen = dentry->d_name.len;
2273 tname = dentry->d_name.name;
2274 /* we want a consistent (name,len) pair */
2275 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2276 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002277 goto seqretry;
2278 }
Al Viro6fa67e72016-07-31 16:37:25 -04002279 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002280 tlen, tname, name) != 0)
2281 continue;
2282 } else {
2283 if (dentry->d_name.hash_len != hashlen)
2284 continue;
2285 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2286 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002287 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002288 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002289 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002290 }
2291 return NULL;
2292}
2293
2294/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 * d_lookup - search for a dentry
2296 * @parent: parent dentry
2297 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002298 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002300 * d_lookup searches the children of the parent dentry for the name in
2301 * question. If the dentry is found its reference count is incremented and the
2302 * dentry is returned. The caller must use dput to free the entry when it has
2303 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 */
Al Viroda2d8452013-01-24 18:29:34 -05002305struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306{
Nick Piggin31e6b012011-01-07 17:49:52 +11002307 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002308 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Daeseok Younb8314f92014-08-11 11:46:53 +09002310 do {
2311 seq = read_seqbegin(&rename_lock);
2312 dentry = __d_lookup(parent, name);
2313 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 break;
2315 } while (read_seqretry(&rename_lock, seq));
2316 return dentry;
2317}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002318EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
Nick Piggin31e6b012011-01-07 17:49:52 +11002320/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002321 * __d_lookup - search for a dentry (racy)
2322 * @parent: parent dentry
2323 * @name: qstr of name we wish to find
2324 * Returns: dentry, or NULL
2325 *
2326 * __d_lookup is like d_lookup, however it may (rarely) return a
2327 * false-negative result due to unrelated rename activity.
2328 *
2329 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2330 * however it must be used carefully, eg. with a following d_lookup in
2331 * the case of failure.
2332 *
2333 * __d_lookup callers must be commented.
2334 */
Al Viroa713ca22013-01-24 18:27:00 -05002335struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002338 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002339 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002340 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002341 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
Nick Pigginb04f7842010-08-18 04:37:34 +10002343 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002344 * Note: There is significant duplication with __d_lookup_rcu which is
2345 * required to prevent single threaded performance regressions
2346 * especially on architectures where smp_rmb (in seqcounts) are costly.
2347 * Keep the two functions in sync.
2348 */
2349
2350 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002351 * The hash list is protected using RCU.
2352 *
2353 * Take d_lock when comparing a candidate dentry, to avoid races
2354 * with d_move().
2355 *
2356 * It is possible that concurrent renames can mess up our list
2357 * walk here and result in missing our dentry, resulting in the
2358 * false-negative result. d_lookup() protects against concurrent
2359 * renames using rename_lock seqlock.
2360 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002361 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002362 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 rcu_read_lock();
2364
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002365 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 if (dentry->d_name.hash != hash)
2368 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
2370 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 if (dentry->d_parent != parent)
2372 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002373 if (d_unhashed(dentry))
2374 goto next;
2375
Al Virod4c91a82016-06-25 23:33:49 -04002376 if (!d_same_name(dentry, parent, name))
2377 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378
Waiman Long98474232013-08-28 18:24:59 -07002379 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002380 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 spin_unlock(&dentry->d_lock);
2382 break;
2383next:
2384 spin_unlock(&dentry->d_lock);
2385 }
2386 rcu_read_unlock();
2387
2388 return found;
2389}
2390
2391/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002392 * d_hash_and_lookup - hash the qstr then search for a dentry
2393 * @dir: Directory to search in
2394 * @name: qstr of name we wish to find
2395 *
Al Viro4f522a22013-02-11 23:20:37 -05002396 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002397 */
2398struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2399{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002400 /*
2401 * Check for a fs-specific hash function. Note that we must
2402 * calculate the standard hash first, as the d_op->d_hash()
2403 * routine may choose to leave the hash value unchanged.
2404 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002405 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002406 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002407 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002408 if (unlikely(err < 0))
2409 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002410 }
Al Viro4f522a22013-02-11 23:20:37 -05002411 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002412}
Al Viro4f522a22013-02-11 23:20:37 -05002413EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002414
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415/*
2416 * When a file is deleted, we have two options:
2417 * - turn this dentry into a negative dentry
2418 * - unhash this dentry and free it.
2419 *
2420 * Usually, we want to just turn this into
2421 * a negative dentry, but if anybody else is
2422 * currently using the dentry or the inode
2423 * we can't do that and we fall back on removing
2424 * it from the hash queues and waiting for
2425 * it to be deleted later when it has no users
2426 */
2427
2428/**
2429 * d_delete - delete a dentry
2430 * @dentry: The dentry to delete
2431 *
2432 * Turn the dentry into a negative dentry if possible, otherwise
2433 * remove it from the hash queues so it can be deleted later
2434 */
2435
2436void d_delete(struct dentry * dentry)
2437{
Al Viroc19457f2018-02-23 21:02:31 -05002438 struct inode *inode = dentry->d_inode;
2439 int isdir = d_is_dir(dentry);
2440
2441 spin_lock(&inode->i_lock);
2442 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 /*
2444 * Are we the only user?
2445 */
Waiman Long98474232013-08-28 18:24:59 -07002446 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002447 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002448 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002449 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002451 spin_unlock(&dentry->d_lock);
2452 spin_unlock(&inode->i_lock);
2453 }
John McCutchan7a91bf72005-08-08 13:52:16 -04002454 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002456EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457
Al Viro15d3c582016-07-29 17:45:21 -04002458static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
Al Viro15d3c582016-07-29 17:45:21 -04002460 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002461
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002462 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002463 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002464 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465}
2466
2467/**
2468 * d_rehash - add an entry back to the hash
2469 * @entry: dentry to add to the hash
2470 *
2471 * Adds a dentry to the hash according to its name.
2472 */
2473
2474void d_rehash(struct dentry * entry)
2475{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002477 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002480EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
Al Viro84e710d2016-04-15 00:58:55 -04002482static inline unsigned start_dir_add(struct inode *dir)
2483{
2484
2485 for (;;) {
2486 unsigned n = dir->i_dir_seq;
2487 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2488 return n;
2489 cpu_relax();
2490 }
2491}
2492
2493static inline void end_dir_add(struct inode *dir, unsigned n)
2494{
2495 smp_store_release(&dir->i_dir_seq, n + 2);
2496}
2497
Al Virod9171b92016-04-15 03:33:13 -04002498static void d_wait_lookup(struct dentry *dentry)
2499{
2500 if (d_in_lookup(dentry)) {
2501 DECLARE_WAITQUEUE(wait, current);
2502 add_wait_queue(dentry->d_wait, &wait);
2503 do {
2504 set_current_state(TASK_UNINTERRUPTIBLE);
2505 spin_unlock(&dentry->d_lock);
2506 schedule();
2507 spin_lock(&dentry->d_lock);
2508 } while (d_in_lookup(dentry));
2509 }
2510}
2511
Al Viro94bdd652016-04-15 02:42:04 -04002512struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002513 const struct qstr *name,
2514 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002515{
Al Viro94bdd652016-04-15 02:42:04 -04002516 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002517 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2518 struct hlist_bl_node *node;
2519 struct dentry *new = d_alloc(parent, name);
2520 struct dentry *dentry;
2521 unsigned seq, r_seq, d_seq;
2522
2523 if (unlikely(!new))
2524 return ERR_PTR(-ENOMEM);
2525
2526retry:
2527 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002528 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002529 r_seq = read_seqbegin(&rename_lock);
2530 dentry = __d_lookup_rcu(parent, name, &d_seq);
2531 if (unlikely(dentry)) {
2532 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2533 rcu_read_unlock();
2534 goto retry;
2535 }
2536 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2537 rcu_read_unlock();
2538 dput(dentry);
2539 goto retry;
2540 }
2541 rcu_read_unlock();
2542 dput(new);
2543 return dentry;
2544 }
2545 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2546 rcu_read_unlock();
2547 goto retry;
2548 }
Will Deacon015555f2018-02-19 14:55:54 +00002549
2550 if (unlikely(seq & 1)) {
2551 rcu_read_unlock();
2552 goto retry;
2553 }
2554
Al Viro94bdd652016-04-15 02:42:04 -04002555 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002556 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002557 hlist_bl_unlock(b);
2558 rcu_read_unlock();
2559 goto retry;
2560 }
Al Viro94bdd652016-04-15 02:42:04 -04002561 /*
2562 * No changes for the parent since the beginning of d_lookup().
2563 * Since all removals from the chain happen with hlist_bl_lock(),
2564 * any potential in-lookup matches are going to stay here until
2565 * we unlock the chain. All fields are stable in everything
2566 * we encounter.
2567 */
2568 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2569 if (dentry->d_name.hash != hash)
2570 continue;
2571 if (dentry->d_parent != parent)
2572 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002573 if (!d_same_name(dentry, parent, name))
2574 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002575 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002576 /* now we can try to grab a reference */
2577 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2578 rcu_read_unlock();
2579 goto retry;
2580 }
2581
2582 rcu_read_unlock();
2583 /*
2584 * somebody is likely to be still doing lookup for it;
2585 * wait for them to finish
2586 */
Al Virod9171b92016-04-15 03:33:13 -04002587 spin_lock(&dentry->d_lock);
2588 d_wait_lookup(dentry);
2589 /*
2590 * it's not in-lookup anymore; in principle we should repeat
2591 * everything from dcache lookup, but it's likely to be what
2592 * d_lookup() would've found anyway. If it is, just return it;
2593 * otherwise we really have to repeat the whole thing.
2594 */
2595 if (unlikely(dentry->d_name.hash != hash))
2596 goto mismatch;
2597 if (unlikely(dentry->d_parent != parent))
2598 goto mismatch;
2599 if (unlikely(d_unhashed(dentry)))
2600 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002601 if (unlikely(!d_same_name(dentry, parent, name)))
2602 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002603 /* OK, it *is* a hashed match; return it */
2604 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002605 dput(new);
2606 return dentry;
2607 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002608 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002609 /* we can't take ->d_lock here; it's OK, though. */
2610 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002611 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002612 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2613 hlist_bl_unlock(b);
2614 return new;
Al Virod9171b92016-04-15 03:33:13 -04002615mismatch:
2616 spin_unlock(&dentry->d_lock);
2617 dput(dentry);
2618 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002619}
2620EXPORT_SYMBOL(d_alloc_parallel);
2621
Al Viro85c7f812016-04-14 19:52:13 -04002622void __d_lookup_done(struct dentry *dentry)
2623{
Al Viro94bdd652016-04-15 02:42:04 -04002624 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2625 dentry->d_name.hash);
2626 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002627 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002628 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002629 wake_up_all(dentry->d_wait);
2630 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002631 hlist_bl_unlock(b);
2632 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002633 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002634}
2635EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002636
2637/* inode->i_lock held if inode is non-NULL */
2638
2639static inline void __d_add(struct dentry *dentry, struct inode *inode)
2640{
Al Viro84e710d2016-04-15 00:58:55 -04002641 struct inode *dir = NULL;
2642 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002643 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002644 if (unlikely(d_in_lookup(dentry))) {
2645 dir = dentry->d_parent->d_inode;
2646 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002647 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002648 }
Al Viroed782b52016-03-09 19:52:39 -05002649 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002650 unsigned add_flags = d_flags_for_inode(inode);
2651 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2652 raw_write_seqcount_begin(&dentry->d_seq);
2653 __d_set_inode_and_type(dentry, inode, add_flags);
2654 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002655 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002656 }
Al Viro15d3c582016-07-29 17:45:21 -04002657 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002658 if (dir)
2659 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002660 spin_unlock(&dentry->d_lock);
2661 if (inode)
2662 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002663}
2664
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002665/**
Al Viro34d0d192016-03-08 21:01:03 -05002666 * d_add - add dentry to hash queues
2667 * @entry: dentry to add
2668 * @inode: The inode to attach to this dentry
2669 *
2670 * This adds the entry to the hash queues and initializes @inode.
2671 * The entry was actually filled in earlier during d_alloc().
2672 */
2673
2674void d_add(struct dentry *entry, struct inode *inode)
2675{
Al Virob9680912016-04-11 00:53:26 -04002676 if (inode) {
2677 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002678 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002679 }
Al Viroed782b52016-03-09 19:52:39 -05002680 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002681}
2682EXPORT_SYMBOL(d_add);
2683
2684/**
Al Viro668d0cd2016-03-08 12:44:17 -05002685 * d_exact_alias - find and hash an exact unhashed alias
2686 * @entry: dentry to add
2687 * @inode: The inode to go with this dentry
2688 *
2689 * If an unhashed dentry with the same name/parent and desired
2690 * inode already exists, hash and return it. Otherwise, return
2691 * NULL.
2692 *
2693 * Parent directory should be locked.
2694 */
2695struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2696{
2697 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002698 unsigned int hash = entry->d_name.hash;
2699
2700 spin_lock(&inode->i_lock);
2701 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2702 /*
2703 * Don't need alias->d_lock here, because aliases with
2704 * d_parent == entry->d_parent are not subject to name or
2705 * parent changes, because the parent inode i_mutex is held.
2706 */
2707 if (alias->d_name.hash != hash)
2708 continue;
2709 if (alias->d_parent != entry->d_parent)
2710 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002711 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002712 continue;
2713 spin_lock(&alias->d_lock);
2714 if (!d_unhashed(alias)) {
2715 spin_unlock(&alias->d_lock);
2716 alias = NULL;
2717 } else {
2718 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002719 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002720 spin_unlock(&alias->d_lock);
2721 }
2722 spin_unlock(&inode->i_lock);
2723 return alias;
2724 }
2725 spin_unlock(&inode->i_lock);
2726 return NULL;
2727}
2728EXPORT_SYMBOL(d_exact_alias);
2729
2730/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002731 * dentry_update_name_case - update case insensitive dentry with a new name
2732 * @dentry: dentry to be updated
2733 * @name: new name
2734 *
2735 * Update a case insensitive dentry with new case of name.
2736 *
2737 * dentry must have been returned by d_lookup with name @name. Old and new
2738 * name lengths must match (ie. no d_compare which allows mismatched name
2739 * lengths).
2740 *
2741 * Parent inode i_mutex must be held over d_lookup and into this call (to
2742 * keep renames and concurrent inserts, and readdir(2) away).
2743 */
Al Viro9aba36d2016-07-20 22:28:45 -04002744void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002745{
Al Viro59551022016-01-22 15:40:57 -05002746 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002747 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2748
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002749 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002750 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002751 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002752 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002753 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002754}
2755EXPORT_SYMBOL(dentry_update_name_case);
2756
Al Viro8d85b482014-09-29 14:54:27 -04002757static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758{
Al Viro8d85b482014-09-29 14:54:27 -04002759 if (unlikely(dname_external(target))) {
2760 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 /*
2762 * Both external: swap the pointers
2763 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002764 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 } else {
2766 /*
2767 * dentry:internal, target:external. Steal target's
2768 * storage and make target internal.
2769 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002770 memcpy(target->d_iname, dentry->d_name.name,
2771 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 dentry->d_name.name = target->d_name.name;
2773 target->d_name.name = target->d_iname;
2774 }
2775 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002776 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 /*
2778 * dentry:external, target:internal. Give dentry's
2779 * storage to target and make dentry internal
2780 */
2781 memcpy(dentry->d_iname, target->d_name.name,
2782 target->d_name.len + 1);
2783 target->d_name.name = dentry->d_name.name;
2784 dentry->d_name.name = dentry->d_iname;
2785 } else {
2786 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002787 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002789 unsigned int i;
2790 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2791 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2792 swap(((long *) &dentry->d_iname)[i],
2793 ((long *) &target->d_iname)[i]);
2794 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 }
2796 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002797 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798}
2799
Al Viro8d85b482014-09-29 14:54:27 -04002800static void copy_name(struct dentry *dentry, struct dentry *target)
2801{
2802 struct external_name *old_name = NULL;
2803 if (unlikely(dname_external(dentry)))
2804 old_name = external_name(dentry);
2805 if (unlikely(dname_external(target))) {
2806 atomic_inc(&external_name(target)->u.count);
2807 dentry->d_name = target->d_name;
2808 } else {
2809 memcpy(dentry->d_iname, target->d_name.name,
2810 target->d_name.len + 1);
2811 dentry->d_name.name = dentry->d_iname;
2812 dentry->d_name.hash_len = target->d_name.hash_len;
2813 }
2814 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
Roman Gushchinf1782c92018-04-10 16:27:44 -07002815 call_rcu(&old_name->u.head, __d_free_external_name);
Al Viro8d85b482014-09-29 14:54:27 -04002816}
2817
Trond Myklebust9eaef272006-10-21 10:24:20 -07002818/*
Al Viro18367502011-07-12 21:42:24 -04002819 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 * @dentry: entry to move
2821 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002822 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 *
2824 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002825 * dcache entries should not be moved in this way. Caller must hold
2826 * rename_lock, the i_mutex of the source and target directories,
2827 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002829static void __d_move(struct dentry *dentry, struct dentry *target,
2830 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831{
Al Viro42177002018-03-11 15:15:46 -04002832 struct dentry *old_parent, *p;
Al Viro84e710d2016-04-15 00:58:55 -04002833 struct inode *dir = NULL;
2834 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835
Al Viro42177002018-03-11 15:15:46 -04002836 WARN_ON(!dentry->d_inode);
2837 if (WARN_ON(dentry == target))
2838 return;
2839
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002840 BUG_ON(d_ancestor(target, dentry));
Al Viro42177002018-03-11 15:15:46 -04002841 old_parent = dentry->d_parent;
2842 p = d_ancestor(old_parent, target);
2843 if (IS_ROOT(dentry)) {
2844 BUG_ON(p);
2845 spin_lock(&target->d_parent->d_lock);
2846 } else if (!p) {
2847 /* target is not a descendent of dentry->d_parent */
2848 spin_lock(&target->d_parent->d_lock);
2849 spin_lock_nested(&old_parent->d_lock, DENTRY_D_LOCK_NESTED);
2850 } else {
2851 BUG_ON(p == dentry);
2852 spin_lock(&old_parent->d_lock);
2853 if (p != target)
2854 spin_lock_nested(&target->d_parent->d_lock,
2855 DENTRY_D_LOCK_NESTED);
2856 }
2857 spin_lock_nested(&dentry->d_lock, 2);
2858 spin_lock_nested(&target->d_lock, 3);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002859
Al Viro84e710d2016-04-15 00:58:55 -04002860 if (unlikely(d_in_lookup(target))) {
2861 dir = target->d_parent->d_inode;
2862 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002863 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002864 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865
Nick Piggin31e6b012011-01-07 17:49:52 +11002866 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002867 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002868
Al Viro15d3c582016-07-29 17:45:21 -04002869 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002870 if (!d_unhashed(dentry))
2871 ___d_drop(dentry);
2872 if (!d_unhashed(target))
2873 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874
Al Viro63cf4272014-09-26 23:06:14 -04002875 /* ... and switch them in the tree */
Al Viro076515f2018-03-10 23:15:52 -05002876 dentry->d_parent = target->d_parent;
2877 if (!exchange) {
2878 copy_name(dentry, target);
2879 target->d_hash.pprev = NULL;
2880 dentry->d_parent->d_lockref.count++;
2881 if (dentry == old_parent)
2882 dentry->d_flags |= DCACHE_RCUACCESS;
2883 else
2884 WARN_ON(!--old_parent->d_lockref.count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885 } else {
Al Viro076515f2018-03-10 23:15:52 -05002886 target->d_parent = old_parent;
2887 swap_names(dentry, target);
Al Viro946e51f2014-10-26 19:19:16 -04002888 list_move(&target->d_child, &target->d_parent->d_subdirs);
Al Viro076515f2018-03-10 23:15:52 -05002889 __d_rehash(target);
2890 fsnotify_update_flags(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 }
Al Viro076515f2018-03-10 23:15:52 -05002892 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
2893 __d_rehash(dentry);
2894 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895
Nick Piggin31e6b012011-01-07 17:49:52 +11002896 write_seqcount_end(&target->d_seq);
2897 write_seqcount_end(&dentry->d_seq);
2898
Al Viro84e710d2016-04-15 00:58:55 -04002899 if (dir)
2900 end_dir_add(dir, n);
Al Viro076515f2018-03-10 23:15:52 -05002901
2902 if (dentry->d_parent != old_parent)
2903 spin_unlock(&dentry->d_parent->d_lock);
2904 if (dentry != old_parent)
2905 spin_unlock(&old_parent->d_lock);
2906 spin_unlock(&target->d_lock);
2907 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002908}
2909
2910/*
2911 * d_move - move a dentry
2912 * @dentry: entry to move
2913 * @target: new dentry
2914 *
2915 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002916 * dcache entries should not be moved in this way. See the locking
2917 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002918 */
2919void d_move(struct dentry *dentry, struct dentry *target)
2920{
2921 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002922 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002924}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002925EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926
Miklos Szeredida1ce062014-04-01 17:08:43 +02002927/*
2928 * d_exchange - exchange two dentries
2929 * @dentry1: first dentry
2930 * @dentry2: second dentry
2931 */
2932void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2933{
2934 write_seqlock(&rename_lock);
2935
2936 WARN_ON(!dentry1->d_inode);
2937 WARN_ON(!dentry2->d_inode);
2938 WARN_ON(IS_ROOT(dentry1));
2939 WARN_ON(IS_ROOT(dentry2));
2940
2941 __d_move(dentry1, dentry2, true);
2942
2943 write_sequnlock(&rename_lock);
2944}
2945
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002946/**
2947 * d_ancestor - search for an ancestor
2948 * @p1: ancestor dentry
2949 * @p2: child dentry
2950 *
2951 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2952 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002953 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002954struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002955{
2956 struct dentry *p;
2957
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002958 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002959 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002960 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002961 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002962 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002963}
2964
2965/*
2966 * This helper attempts to cope with remotely renamed directories
2967 *
2968 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002969 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002970 *
2971 * Note: If ever the locking in lock_rename() changes, then please
2972 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002973 */
Al Virob5ae6b12014-10-12 22:16:02 -04002974static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002975 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002976{
Al Viro9902af72016-04-15 15:08:36 -04002977 struct mutex *m1 = NULL;
2978 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002979 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980
2981 /* If alias and dentry share a parent, then no extra locks required */
2982 if (alias->d_parent == dentry->d_parent)
2983 goto out_unalias;
2984
Trond Myklebust9eaef272006-10-21 10:24:20 -07002985 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002986 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2987 goto out_err;
2988 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002989 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002990 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002991 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002992out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002993 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002994 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002995out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002996 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002997 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002998 if (m1)
2999 mutex_unlock(m1);
3000 return ret;
3001}
3002
David Howells770bfad2006-08-22 20:06:07 -04003003/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003004 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3005 * @inode: the inode which may have a disconnected dentry
3006 * @dentry: a negative dentry which we want to point to the inode.
3007 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003008 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3009 * place of the given dentry and return it, else simply d_add the inode
3010 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003011 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003012 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3013 * we should error out: directories can't have multiple aliases.
3014 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003015 * This is needed in the lookup routine of any filesystem that is exportable
3016 * (via knfsd) so that we can build dcache paths to directories effectively.
3017 *
3018 * If a dentry was found and moved, then it is returned. Otherwise NULL
3019 * is returned. This matches the expected return value of ->lookup.
3020 *
3021 * Cluster filesystems may call this function with a negative, hashed dentry.
3022 * In that case, we know that the inode will be a regular file, and also this
3023 * will only occur during atomic_open. So we need to check for the dentry
3024 * being already hashed only in the final case.
3025 */
3026struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3027{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003028 if (IS_ERR(inode))
3029 return ERR_CAST(inode);
3030
David Howells770bfad2006-08-22 20:06:07 -04003031 BUG_ON(!d_unhashed(dentry));
3032
Al Virode689f52016-03-09 18:05:42 -05003033 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003034 goto out;
Al Virode689f52016-03-09 18:05:42 -05003035
Al Virob9680912016-04-11 00:53:26 -04003036 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003037 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003038 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003039 struct dentry *new = __d_find_any_alias(inode);
3040 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003041 /* The reference to new ensures it remains an alias */
3042 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003043 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003044 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003045 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003046 dput(new);
3047 new = ERR_PTR(-ELOOP);
3048 pr_warn_ratelimited(
3049 "VFS: Lookup of '%s' in %s %s"
3050 " would have caused loop\n",
3051 dentry->d_name.name,
3052 inode->i_sb->s_type->name,
3053 inode->i_sb->s_id);
3054 } else if (!IS_ROOT(new)) {
Al Viro076515f2018-03-10 23:15:52 -05003055 struct dentry *old_parent = dget(new->d_parent);
Al Virob5ae6b12014-10-12 22:16:02 -04003056 int err = __d_unalias(inode, dentry, new);
3057 write_sequnlock(&rename_lock);
3058 if (err) {
3059 dput(new);
3060 new = ERR_PTR(err);
3061 }
Al Viro076515f2018-03-10 23:15:52 -05003062 dput(old_parent);
Al Viro18367502011-07-12 21:42:24 -04003063 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003064 __d_move(new, dentry, false);
3065 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003066 }
Al Virob5ae6b12014-10-12 22:16:02 -04003067 iput(inode);
3068 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003069 }
David Howells770bfad2006-08-22 20:06:07 -04003070 }
Al Virob5ae6b12014-10-12 22:16:02 -04003071out:
Al Viroed782b52016-03-09 19:52:39 -05003072 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003073 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003074}
Al Virob5ae6b12014-10-12 22:16:02 -04003075EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003076
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077/*
3078 * Test whether new_dentry is a subdirectory of old_dentry.
3079 *
3080 * Trivially implemented using the dcache structure
3081 */
3082
3083/**
3084 * is_subdir - is new dentry a subdirectory of old_dentry
3085 * @new_dentry: new dentry
3086 * @old_dentry: old dentry
3087 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003088 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3089 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3091 */
3092
Yaowei Baia6e57872015-11-17 14:40:11 +08003093bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094{
Yaowei Baia6e57872015-11-17 14:40:11 +08003095 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003096 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003098 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003099 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003100
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003101 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003104 /*
3105 * Need rcu_readlock to protect against the d_parent trashing
3106 * due to d_move
3107 */
3108 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003109 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003110 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003111 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003112 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003113 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115
3116 return result;
3117}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003118EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003120static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003122 struct dentry *root = data;
3123 if (dentry != root) {
3124 if (d_unhashed(dentry) || !dentry->d_inode)
3125 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003127 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3128 dentry->d_flags |= DCACHE_GENOCIDE;
3129 dentry->d_lockref.count--;
3130 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003132 return D_WALK_CONTINUE;
3133}
Nick Piggin58db63d2011-01-07 17:49:39 +11003134
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003135void d_genocide(struct dentry *parent)
3136{
3137 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138}
3139
Al Virocbd4a5b2018-03-29 15:08:21 -04003140EXPORT_SYMBOL(d_genocide);
3141
Al Viro60545d02013-06-07 01:20:27 -04003142void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143{
Al Viro60545d02013-06-07 01:20:27 -04003144 inode_dec_link_count(inode);
3145 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003146 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003147 !d_unlinked(dentry));
3148 spin_lock(&dentry->d_parent->d_lock);
3149 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3150 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3151 (unsigned long long)inode->i_ino);
3152 spin_unlock(&dentry->d_lock);
3153 spin_unlock(&dentry->d_parent->d_lock);
3154 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155}
Al Viro60545d02013-06-07 01:20:27 -04003156EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
3158static __initdata unsigned long dhash_entries;
3159static int __init set_dhash_entries(char *str)
3160{
3161 if (!str)
3162 return 0;
3163 dhash_entries = simple_strtoul(str, &str, 0);
3164 return 1;
3165}
3166__setup("dhash_entries=", set_dhash_entries);
3167
3168static void __init dcache_init_early(void)
3169{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 /* If hashes are distributed across NUMA nodes, defer
3171 * hash allocation until vmalloc space is available.
3172 */
3173 if (hashdist)
3174 return;
3175
3176 dentry_hashtable =
3177 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003178 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 dhash_entries,
3180 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003181 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003183 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003184 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003186 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187}
3188
Denis Cheng74bf17c2007-10-16 23:26:30 -07003189static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003191 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 * A constructor could be added for stable state like the lists,
3193 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003194 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 */
David Windsor80344262017-06-10 22:50:44 -04003196 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3197 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3198 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
3200 /* Hash may have been set up in dcache_init_early */
3201 if (!hashdist)
3202 return;
3203
3204 dentry_hashtable =
3205 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003206 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207 dhash_entries,
3208 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003209 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003211 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003212 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003214 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215}
3216
3217/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003218struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003219EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221void __init vfs_caches_init_early(void)
3222{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003223 int i;
3224
3225 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3226 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3227
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228 dcache_init_early();
3229 inode_init_early();
3230}
3231
Mel Gorman4248b0d2015-08-06 15:46:20 -07003232void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233{
David Windsor6a9b8822017-06-10 22:50:30 -04003234 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3235 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236
Denis Cheng74bf17c2007-10-16 23:26:30 -07003237 dcache_init();
3238 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003239 files_init();
3240 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003241 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 bdev_cache_init();
3243 chrdev_init();
3244}