blob: 91626643fc8618bab33b280fa4dc893c0352d0b5 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#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/mount.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080028#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/security.h>
30#include <linux/seqlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040032#include <linux/fs_struct.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110033#include <linux/bit_spinlock.h>
34#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070035#include <linux/prefetch.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100036#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020037#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050038#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Nick Piggin789680d2011-01-07 17:49:30 +110040/*
41 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110042 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040043 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110044 * dcache_hash_bucket lock protects:
45 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110046 * s_roots bl list spinlock protects:
47 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100048 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110049 * - the dcache lru lists and counters
50 * d_lock protects:
51 * - d_flags
52 * - d_name
53 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110054 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110055 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110056 * - d_parent and d_subdirs
57 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040058 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110059 *
60 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110061 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110062 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100063 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110064 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110065 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110066 *
Nick Pigginda502952011-01-07 17:49:33 +110067 * If there is an ancestor relationship:
68 * dentry->d_parent->...->d_parent->d_lock
69 * ...
70 * dentry->d_parent->d_lock
71 * dentry->d_lock
72 *
73 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110074 * if (dentry1 < dentry2)
75 * dentry1->d_lock
76 * dentry2->d_lock
77 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080078int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
80
Al Viro74c3cbe2007-07-22 08:04:18 -040081__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Nick Piggin949854d2011-01-07 17:49:37 +110083EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Christoph Lametere18b8902006-12-06 20:33:20 -080085static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
David Howellscdf01222017-07-04 17:25:22 +010087const struct qstr empty_name = QSTR_INIT("", 0);
88EXPORT_SYMBOL(empty_name);
89const struct qstr slash_name = QSTR_INIT("/", 1);
90EXPORT_SYMBOL(slash_name);
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092/*
93 * This is the single most critical data structure when it comes
94 * to the dcache: the hashtable for lookups. Somebody should try
95 * to make this good - I've just made it work.
96 *
97 * This hash-function tries to avoid losing too many bits of hash
98 * information, yet avoid using a prime hash-size or similar.
99 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800101static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700103static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvalds8387ff22016-06-10 07:51:30 -0700105static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300107 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108}
109
Al Viro94bdd652016-04-15 02:42:04 -0400110#define IN_LOOKUP_SHIFT 10
111static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
112
113static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
114 unsigned int hash)
115{
116 hash += (unsigned long) parent / L1_CACHE_BYTES;
117 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
118}
119
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/* Statistics gathering. */
122struct dentry_stat_t dentry_stat = {
123 .age_limit = 45,
124};
125
Glauber Costa3942c072013-08-28 10:17:53 +1000126static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000127static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400128
129#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000130
131/*
132 * Here we resort to our own counters instead of using generic per-cpu counters
133 * for consistency with what the vfs inode code does. We are expected to harvest
134 * better code and performance by having our own specialized counters.
135 *
136 * Please note that the loop is done over all possible CPUs, not over all online
137 * CPUs. The reason for this is that we don't want to play games with CPUs going
138 * on and off. If one of them goes off, we will just keep their counters.
139 *
140 * glommer: See cffbc8a for details, and if you ever intend to change this,
141 * please update all vfs counters to match.
142 */
Glauber Costa3942c072013-08-28 10:17:53 +1000143static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100144{
145 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000146 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100147 for_each_possible_cpu(i)
148 sum += per_cpu(nr_dentry, i);
149 return sum < 0 ? 0 : sum;
150}
151
Dave Chinner62d36c72013-08-28 10:17:54 +1000152static long get_nr_dentry_unused(void)
153{
154 int i;
155 long sum = 0;
156 for_each_possible_cpu(i)
157 sum += per_cpu(nr_dentry_unused, i);
158 return sum < 0 ? 0 : sum;
159}
160
Joe Perches1f7e0612014-06-06 14:38:05 -0700161int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400162 size_t *lenp, loff_t *ppos)
163{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100164 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000165 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000166 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400167}
168#endif
169
Linus Torvalds5483f182012-03-04 15:51:42 -0800170/*
171 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
172 * The strings are both count bytes long, and count is non-zero.
173 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700174#ifdef CONFIG_DCACHE_WORD_ACCESS
175
176#include <asm/word-at-a-time.h>
177/*
178 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
179 * aligned allocation for this particular component. We don't
180 * strictly need the load_unaligned_zeropad() safety, but it
181 * doesn't hurt either.
182 *
183 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
184 * need the careful unaligned handling.
185 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700186static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800187{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800188 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800189
190 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300191 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700192 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800193 if (tcount < sizeof(unsigned long))
194 break;
195 if (unlikely(a != b))
196 return 1;
197 cs += sizeof(unsigned long);
198 ct += sizeof(unsigned long);
199 tcount -= sizeof(unsigned long);
200 if (!tcount)
201 return 0;
202 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000203 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800204 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700205}
206
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800207#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700208
Linus Torvalds94753db52012-05-10 12:19:19 -0700209static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210{
Linus Torvalds5483f182012-03-04 15:51:42 -0800211 do {
212 if (*cs != *ct)
213 return 1;
214 cs++;
215 ct++;
216 tcount--;
217 } while (tcount);
218 return 0;
219}
220
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700221#endif
222
Linus Torvalds94753db52012-05-10 12:19:19 -0700223static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
224{
Linus Torvalds94753db52012-05-10 12:19:19 -0700225 /*
226 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100227 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700228 *
229 * NOTE! Even if a rename will mean that the length
230 * was not loaded atomically, we don't care. The
231 * RCU walk will check the sequence count eventually,
232 * and catch it. And we won't overrun the buffer,
233 * because we're reading the name pointer atomically,
234 * and a dentry name is guaranteed to be properly
235 * terminated with a NUL byte.
236 *
237 * End result: even if 'len' is wrong, we'll exit
238 * early because the data cannot match (there can
239 * be no NUL in the ct/tcount data)
240 */
Will Deacon506458e2017-10-24 11:22:48 +0100241 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000242
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700243 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700244}
245
Al Viro8d85b482014-09-29 14:54:27 -0400246struct external_name {
247 union {
248 atomic_t count;
249 struct rcu_head head;
250 } u;
251 unsigned char name[];
252};
253
254static inline struct external_name *external_name(struct dentry *dentry)
255{
256 return container_of(dentry->d_name.name, struct external_name, name[0]);
257}
258
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400259static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400261 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
262
Al Viro8d85b482014-09-29 14:54:27 -0400263 kmem_cache_free(dentry_cache, dentry);
264}
265
266static void __d_free_external(struct rcu_head *head)
267{
268 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400269 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 kmem_cache_free(dentry_cache, dentry);
271}
272
Al Viro810bb172014-10-12 12:45:37 -0400273static inline int dname_external(const struct dentry *dentry)
274{
275 return dentry->d_name.name != dentry->d_iname;
276}
277
Al Viro49d31c22017-07-07 14:51:19 -0400278void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
279{
280 spin_lock(&dentry->d_lock);
281 if (unlikely(dname_external(dentry))) {
282 struct external_name *p = external_name(dentry);
283 atomic_inc(&p->u.count);
284 spin_unlock(&dentry->d_lock);
285 name->name = p->name;
286 } else {
287 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
288 spin_unlock(&dentry->d_lock);
289 name->name = name->inline_name;
290 }
291}
292EXPORT_SYMBOL(take_dentry_name_snapshot);
293
294void release_dentry_name_snapshot(struct name_snapshot *name)
295{
296 if (unlikely(name->name != name->inline_name)) {
297 struct external_name *p;
298 p = container_of(name->name, struct external_name, name[0]);
299 if (unlikely(atomic_dec_and_test(&p->u.count)))
300 kfree_rcu(p, u.head);
301 }
302}
303EXPORT_SYMBOL(release_dentry_name_snapshot);
304
David Howells4bf46a22015-03-05 14:09:22 +0000305static inline void __d_set_inode_and_type(struct dentry *dentry,
306 struct inode *inode,
307 unsigned type_flags)
308{
309 unsigned flags;
310
311 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000312 flags = READ_ONCE(dentry->d_flags);
313 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
314 flags |= type_flags;
315 WRITE_ONCE(dentry->d_flags, flags);
316}
317
David Howells4bf46a22015-03-05 14:09:22 +0000318static inline void __d_clear_type_and_inode(struct dentry *dentry)
319{
320 unsigned flags = READ_ONCE(dentry->d_flags);
321
322 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
323 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000324 dentry->d_inode = NULL;
325}
326
Al Virob4f03542014-04-29 23:40:14 -0400327static void dentry_free(struct dentry *dentry)
328{
Al Viro946e51f2014-10-26 19:19:16 -0400329 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400330 if (unlikely(dname_external(dentry))) {
331 struct external_name *p = external_name(dentry);
332 if (likely(atomic_dec_and_test(&p->u.count))) {
333 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
334 return;
335 }
336 }
Al Virob4f03542014-04-29 23:40:14 -0400337 /* if dentry was never visible to RCU, immediate free is OK */
338 if (!(dentry->d_flags & DCACHE_RCUACCESS))
339 __d_free(&dentry->d_u.d_rcu);
340 else
341 call_rcu(&dentry->d_u.d_rcu, __d_free);
342}
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344/*
345 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400346 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100347 */
348static void dentry_unlink_inode(struct dentry * dentry)
349 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100350 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100351{
352 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400353 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500354
Al Viro550dce02016-05-29 20:13:30 -0400355 if (hashed)
356 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000357 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400358 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400359 if (hashed)
360 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100361 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100362 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100363 if (!inode->i_nlink)
364 fsnotify_inoderemove(inode);
365 if (dentry->d_op && dentry->d_op->d_iput)
366 dentry->d_op->d_iput(dentry, inode);
367 else
368 iput(inode);
369}
370
371/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400372 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
373 * is in use - which includes both the "real" per-superblock
374 * LRU list _and_ the DCACHE_SHRINK_LIST use.
375 *
376 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
377 * on the shrink list (ie not on the superblock LRU list).
378 *
379 * The per-cpu "nr_dentry_unused" counters are updated with
380 * the DCACHE_LRU_LIST bit.
381 *
382 * These helper functions make sure we always follow the
383 * rules. d_lock must be held by the caller.
384 */
385#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
386static void d_lru_add(struct dentry *dentry)
387{
388 D_FLAG_VERIFY(dentry, 0);
389 dentry->d_flags |= DCACHE_LRU_LIST;
390 this_cpu_inc(nr_dentry_unused);
391 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
392}
393
394static void d_lru_del(struct dentry *dentry)
395{
396 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
397 dentry->d_flags &= ~DCACHE_LRU_LIST;
398 this_cpu_dec(nr_dentry_unused);
399 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
400}
401
402static void d_shrink_del(struct dentry *dentry)
403{
404 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
405 list_del_init(&dentry->d_lru);
406 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
407 this_cpu_dec(nr_dentry_unused);
408}
409
410static void d_shrink_add(struct dentry *dentry, struct list_head *list)
411{
412 D_FLAG_VERIFY(dentry, 0);
413 list_add(&dentry->d_lru, list);
414 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
415 this_cpu_inc(nr_dentry_unused);
416}
417
418/*
419 * These can only be called under the global LRU lock, ie during the
420 * callback for freeing the LRU list. "isolate" removes it from the
421 * LRU lists entirely, while shrink_move moves it to the indicated
422 * private list.
423 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800424static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400425{
426 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
427 dentry->d_flags &= ~DCACHE_LRU_LIST;
428 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800429 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400430}
431
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800432static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
433 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400434{
435 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
436 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800437 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400438}
439
Miklos Szeredid52b9082007-05-08 00:23:46 -0700440/**
Nick Piggin789680d2011-01-07 17:49:30 +1100441 * d_drop - drop a dentry
442 * @dentry: dentry to drop
443 *
444 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
445 * be found through a VFS lookup any more. Note that this is different from
446 * deleting the dentry - d_delete will try to mark the dentry negative if
447 * possible, giving a successful _negative_ lookup, while d_drop will
448 * just make the cache lookup fail.
449 *
450 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
451 * reason (NFS timeouts or autofs deletes).
452 *
NeilBrown61647822017-11-10 15:45:41 +1100453 * __d_drop requires dentry->d_lock
454 * ___d_drop doesn't mark dentry as "unhashed"
455 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100456 */
NeilBrown61647822017-11-10 15:45:41 +1100457static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100458{
Al Viro0632a9a2018-03-07 00:49:10 -0500459 struct hlist_bl_head *b;
460 /*
461 * Hashed dentries are normally on the dentry hashtable,
462 * with the exception of those newly allocated by
463 * d_obtain_root, which are always IS_ROOT:
464 */
465 if (unlikely(IS_ROOT(dentry)))
466 b = &dentry->d_sb->s_roots;
467 else
468 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400469
Al Viro0632a9a2018-03-07 00:49:10 -0500470 hlist_bl_lock(b);
471 __hlist_bl_del(&dentry->d_hash);
472 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100473}
NeilBrown61647822017-11-10 15:45:41 +1100474
475void __d_drop(struct dentry *dentry)
476{
Al Viro0632a9a2018-03-07 00:49:10 -0500477 if (!d_unhashed(dentry)) {
478 ___d_drop(dentry);
479 dentry->d_hash.pprev = NULL;
480 write_seqcount_invalidate(&dentry->d_seq);
481 }
NeilBrown61647822017-11-10 15:45:41 +1100482}
Nick Piggin789680d2011-01-07 17:49:30 +1100483EXPORT_SYMBOL(__d_drop);
484
485void d_drop(struct dentry *dentry)
486{
Nick Piggin789680d2011-01-07 17:49:30 +1100487 spin_lock(&dentry->d_lock);
488 __d_drop(dentry);
489 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100490}
491EXPORT_SYMBOL(d_drop);
492
Al Viroba65dc52016-06-10 11:32:47 -0400493static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
494{
495 struct dentry *next;
496 /*
497 * Inform d_walk() and shrink_dentry_list() that we are no longer
498 * attached to the dentry tree
499 */
500 dentry->d_flags |= DCACHE_DENTRY_KILLED;
501 if (unlikely(list_empty(&dentry->d_child)))
502 return;
503 __list_del_entry(&dentry->d_child);
504 /*
505 * Cursors can move around the list of children. While we'd been
506 * a normal list member, it didn't matter - ->d_child.next would've
507 * been updated. However, from now on it won't be and for the
508 * things like d_walk() it might end up with a nasty surprise.
509 * Normally d_walk() doesn't care about cursors moving around -
510 * ->d_lock on parent prevents that and since a cursor has no children
511 * of its own, we get through it without ever unlocking the parent.
512 * There is one exception, though - if we ascend from a child that
513 * gets killed as soon as we unlock it, the next sibling is found
514 * using the value left in its ->d_child.next. And if _that_
515 * pointed to a cursor, and cursor got moved (e.g. by lseek())
516 * before d_walk() regains parent->d_lock, we'll end up skipping
517 * everything the cursor had been moved past.
518 *
519 * Solution: make sure that the pointer left behind in ->d_child.next
520 * points to something that won't be moving around. I.e. skip the
521 * cursors.
522 */
523 while (dentry->d_child.next != &parent->d_subdirs) {
524 next = list_entry(dentry->d_child.next, struct dentry, d_child);
525 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
526 break;
527 dentry->d_child.next = next->d_child.next;
528 }
529}
530
Al Viroe55fd012014-05-28 13:51:12 -0400531static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100532{
Al Viro41edf2782014-05-01 10:30:00 -0400533 struct dentry *parent = NULL;
534 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400535 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100536 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100537
Linus Torvalds0d984392013-09-08 13:46:52 -0700538 /*
539 * The dentry is now unrecoverably dead to the world.
540 */
541 lockref_mark_dead(&dentry->d_lockref);
542
Sage Weilf0023bc2011-10-28 10:02:42 -0700543 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700544 * inform the fs via d_prune that this dentry is about to be
545 * unhashed and destroyed.
546 */
Al Viro29266202014-05-30 11:39:02 -0400547 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800548 dentry->d_op->d_prune(dentry);
549
Al Viro01b60352014-04-29 23:42:52 -0400550 if (dentry->d_flags & DCACHE_LRU_LIST) {
551 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
552 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400553 }
Nick Piggin77812a12011-01-07 17:49:48 +1100554 /* if it was on the hash then remove it */
555 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400556 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400557 if (parent)
558 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400559 if (dentry->d_inode)
560 dentry_unlink_inode(dentry);
561 else
562 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400563 this_cpu_dec(nr_dentry);
564 if (dentry->d_op && dentry->d_op->d_release)
565 dentry->d_op->d_release(dentry);
566
Al Viro41edf2782014-05-01 10:30:00 -0400567 spin_lock(&dentry->d_lock);
568 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
569 dentry->d_flags |= DCACHE_MAY_FREE;
570 can_free = false;
571 }
572 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400573 if (likely(can_free))
574 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400575}
576
Al Viro8b987a42018-02-23 22:11:34 -0500577static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400578{
Al Viro8b987a42018-02-23 22:11:34 -0500579 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400580 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400581 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400582again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700583 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400584 spin_lock(&parent->d_lock);
585 /*
586 * We can't blindly lock dentry until we are sure
587 * that we won't violate the locking order.
588 * Any changes of dentry->d_parent must have
589 * been done with parent->d_lock held, so
590 * spin_lock() above is enough of a barrier
591 * for checking if it's still our child.
592 */
593 if (unlikely(parent != dentry->d_parent)) {
594 spin_unlock(&parent->d_lock);
595 goto again;
596 }
Al Viro3b821402018-02-23 20:47:17 -0500597 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500598 if (parent != dentry)
599 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
600 else
601 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400602 return parent;
603}
604
Al Viro8b987a42018-02-23 22:11:34 -0500605static inline struct dentry *lock_parent(struct dentry *dentry)
606{
607 struct dentry *parent = dentry->d_parent;
608 if (IS_ROOT(dentry))
609 return NULL;
610 if (likely(spin_trylock(&parent->d_lock)))
611 return parent;
612 return __lock_parent(dentry);
613}
614
Al Viroa3385792018-02-23 21:07:24 -0500615static inline bool retain_dentry(struct dentry *dentry)
616{
617 WARN_ON(d_in_lookup(dentry));
618
619 /* Unreachable? Get rid of it */
620 if (unlikely(d_unhashed(dentry)))
621 return false;
622
623 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
624 return false;
625
626 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
627 if (dentry->d_op->d_delete(dentry))
628 return false;
629 }
Al Viro62d99562018-03-06 21:37:31 -0500630 /* retain; LRU fodder */
631 dentry->d_lockref.count--;
632 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
633 d_lru_add(dentry);
634 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
635 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500636 return true;
637}
638
Linus Torvalds360f5472015-01-09 15:19:03 -0800639/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100640 * Finish off a dentry we've decided to kill.
641 * dentry->d_lock must be held, returns with it unlocked.
642 * Returns dentry requiring refcount drop, or NULL if we're done.
643 */
644static struct dentry *dentry_kill(struct dentry *dentry)
645 __releases(dentry->d_lock)
646{
647 struct inode *inode = dentry->d_inode;
648 struct dentry *parent = NULL;
649
650 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500651 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100652
653 if (!IS_ROOT(dentry)) {
654 parent = dentry->d_parent;
655 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500656 parent = __lock_parent(dentry);
657 if (likely(inode || !dentry->d_inode))
658 goto got_locks;
659 /* negative that became positive */
660 if (parent)
661 spin_unlock(&parent->d_lock);
662 inode = dentry->d_inode;
663 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100664 }
665 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100666 __dentry_kill(dentry);
667 return parent;
668
Al Virof657a662018-02-23 21:25:42 -0500669slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100670 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500671 spin_lock(&inode->i_lock);
672 spin_lock(&dentry->d_lock);
673 parent = lock_parent(dentry);
674got_locks:
675 if (unlikely(dentry->d_lockref.count != 1)) {
676 dentry->d_lockref.count--;
677 } else if (likely(!retain_dentry(dentry))) {
678 __dentry_kill(dentry);
679 return parent;
680 }
681 /* we are keeping it, after all */
682 if (inode)
683 spin_unlock(&inode->i_lock);
684 if (parent)
685 spin_unlock(&parent->d_lock);
686 spin_unlock(&dentry->d_lock);
687 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100688}
689
690/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800691 * Try to do a lockless dput(), and return whether that was successful.
692 *
693 * If unsuccessful, we return false, having already taken the dentry lock.
694 *
695 * The caller needs to hold the RCU read lock, so that the dentry is
696 * guaranteed to stay around even if the refcount goes down to zero!
697 */
698static inline bool fast_dput(struct dentry *dentry)
699{
700 int ret;
701 unsigned int d_flags;
702
703 /*
704 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100705 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800706 */
707 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
708 return lockref_put_or_lock(&dentry->d_lockref);
709
710 /*
711 * .. otherwise, we can try to just decrement the
712 * lockref optimistically.
713 */
714 ret = lockref_put_return(&dentry->d_lockref);
715
716 /*
717 * If the lockref_put_return() failed due to the lock being held
718 * by somebody else, the fast path has failed. We will need to
719 * get the lock, and then check the count again.
720 */
721 if (unlikely(ret < 0)) {
722 spin_lock(&dentry->d_lock);
723 if (dentry->d_lockref.count > 1) {
724 dentry->d_lockref.count--;
725 spin_unlock(&dentry->d_lock);
726 return 1;
727 }
728 return 0;
729 }
730
731 /*
732 * If we weren't the last ref, we're done.
733 */
734 if (ret)
735 return 1;
736
737 /*
738 * Careful, careful. The reference count went down
739 * to zero, but we don't hold the dentry lock, so
740 * somebody else could get it again, and do another
741 * dput(), and we need to not race with that.
742 *
743 * However, there is a very special and common case
744 * where we don't care, because there is nothing to
745 * do: the dentry is still hashed, it does not have
746 * a 'delete' op, and it's referenced and already on
747 * the LRU list.
748 *
749 * NOTE! Since we aren't locked, these values are
750 * not "stable". However, it is sufficient that at
751 * some point after we dropped the reference the
752 * dentry was hashed and the flags had the proper
753 * value. Other dentry users may have re-gotten
754 * a reference to the dentry and change that, but
755 * our work is done - we can leave the dentry
756 * around with a zero refcount.
757 */
758 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700759 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100760 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800761
762 /* Nothing to do? Dropping the reference was all we needed? */
763 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
764 return 1;
765
766 /*
767 * Not the fast normal case? Get the lock. We've already decremented
768 * the refcount, but we'll need to re-check the situation after
769 * getting the lock.
770 */
771 spin_lock(&dentry->d_lock);
772
773 /*
774 * Did somebody else grab a reference to it in the meantime, and
775 * we're no longer the last user after all? Alternatively, somebody
776 * else could have killed it and marked it dead. Either way, we
777 * don't need to do anything else.
778 */
779 if (dentry->d_lockref.count) {
780 spin_unlock(&dentry->d_lock);
781 return 1;
782 }
783
784 /*
785 * Re-get the reference we optimistically dropped. We hold the
786 * lock, and we just tested that it was zero, so we can just
787 * set it to 1.
788 */
789 dentry->d_lockref.count = 1;
790 return 0;
791}
792
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794/*
795 * This is dput
796 *
797 * This is complicated by the fact that we do not want to put
798 * dentries that are no longer on any hash chain on the unused
799 * list: we'd much rather just get rid of them immediately.
800 *
801 * However, that implies that we have to traverse the dentry
802 * tree upwards to the parents which might _also_ now be
803 * scheduled for deletion (it may have been only waiting for
804 * its last child to go away).
805 *
806 * This tail recursion is done by hand as we don't want to depend
807 * on the compiler to always get this right (gcc generally doesn't).
808 * Real recursion would eat up our stack space.
809 */
810
811/*
812 * dput - release a dentry
813 * @dentry: dentry to release
814 *
815 * Release a dentry. This will drop the usage count and if appropriate
816 * call the dentry unlink method as well as removing it from the queues and
817 * releasing its resources. If the parent dentries were scheduled for release
818 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820void dput(struct dentry *dentry)
821{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700822 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return;
824
825repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800826 might_sleep();
827
Linus Torvalds360f5472015-01-09 15:19:03 -0800828 rcu_read_lock();
829 if (likely(fast_dput(dentry))) {
830 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800832 }
833
834 /* Slow case: now with the dentry lock held */
835 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Al Viroa3385792018-02-23 21:07:24 -0500837 if (likely(retain_dentry(dentry))) {
Al Viroa3385792018-02-23 21:07:24 -0500838 spin_unlock(&dentry->d_lock);
839 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 }
Nick Piggin265ac902010-10-10 05:36:24 -0400841
Al Viro8cbf74d2014-05-29 09:18:26 -0400842 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800843 if (dentry) {
844 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700845 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700848EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100851/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100852static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
Waiman Long98474232013-08-28 18:24:59 -0700854 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
Nick Piggindc0474b2011-01-07 17:49:43 +1100857static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100858{
Waiman Long98474232013-08-28 18:24:59 -0700859 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100860}
861
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100862struct dentry *dget_parent(struct dentry *dentry)
863{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700864 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100865 struct dentry *ret;
866
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700867 /*
868 * Do optimistic parent lookup without any
869 * locking.
870 */
871 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700872 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700873 gotref = lockref_get_not_zero(&ret->d_lockref);
874 rcu_read_unlock();
875 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700876 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700877 return ret;
878 dput(ret);
879 }
880
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100881repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100882 /*
883 * Don't need rcu_dereference because we re-check it was correct under
884 * the lock.
885 */
886 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100887 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100888 spin_lock(&ret->d_lock);
889 if (unlikely(ret != dentry->d_parent)) {
890 spin_unlock(&ret->d_lock);
891 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100892 goto repeat;
893 }
Nick Piggina734eb42011-01-07 17:49:44 +1100894 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700895 BUG_ON(!ret->d_lockref.count);
896 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100897 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100898 return ret;
899}
900EXPORT_SYMBOL(dget_parent);
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902/**
903 * d_find_alias - grab a hashed alias of inode
904 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 *
906 * If inode has a hashed alias, or is a directory and has any alias,
907 * acquire the reference to alias and return it. Otherwise return NULL.
908 * Notice that if inode is a directory there can be only one alias and
909 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800910 * of a filesystem, or if the directory was renamed and d_revalidate
911 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700913 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500914 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500916static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917{
Nick Pigginda502952011-01-07 17:49:33 +1100918 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Nick Pigginda502952011-01-07 17:49:33 +1100920again:
921 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400922 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100923 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700925 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100926 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500928 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100929 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100930 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 return alias;
932 }
933 }
Nick Pigginda502952011-01-07 17:49:33 +1100934 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 }
Nick Pigginda502952011-01-07 17:49:33 +1100936 if (discon_alias) {
937 alias = discon_alias;
938 spin_lock(&alias->d_lock);
939 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500940 __dget_dlock(alias);
941 spin_unlock(&alias->d_lock);
942 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100943 }
944 spin_unlock(&alias->d_lock);
945 goto again;
946 }
947 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
949
Nick Pigginda502952011-01-07 17:49:33 +1100950struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951{
David Howells214fda12006-03-25 03:06:36 -0800952 struct dentry *de = NULL;
953
Al Virob3d9b7a2012-06-09 13:51:19 -0400954 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100955 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500956 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100957 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800958 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return de;
960}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700961EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
963/*
964 * Try to kill dentries associated with this inode.
965 * WARNING: you must own a reference to inode.
966 */
967void d_prune_aliases(struct inode *inode)
968{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700969 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100971 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400972 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700974 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400975 struct dentry *parent = lock_parent(dentry);
976 if (likely(!dentry->d_lockref.count)) {
977 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800978 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400979 goto restart;
980 }
981 if (parent)
982 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 }
984 spin_unlock(&dentry->d_lock);
985 }
Nick Piggin873feea2011-01-07 17:50:06 +1100986 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700988EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Al Viro3b3f09f2018-02-23 21:54:18 -0500990/*
991 * Lock a dentry from shrink list.
John Ogness8f04da22018-02-23 00:50:24 +0100992 * Called under rcu_read_lock() and dentry->d_lock; the former
993 * guarantees that nothing we access will be freed under us.
Al Viro3b3f09f2018-02-23 21:54:18 -0500994 * Note that dentry is *not* protected from concurrent dentry_kill(),
John Ogness8f04da22018-02-23 00:50:24 +0100995 * d_delete(), etc.
996 *
Al Viro3b3f09f2018-02-23 21:54:18 -0500997 * Return false if dentry has been disrupted or grabbed, leaving
998 * the caller to kick it off-list. Otherwise, return true and have
999 * that dentry's inode and parent both locked.
1000 */
1001static bool shrink_lock_dentry(struct dentry *dentry)
1002{
1003 struct inode *inode;
1004 struct dentry *parent;
1005
1006 if (dentry->d_lockref.count)
1007 return false;
1008
1009 inode = dentry->d_inode;
1010 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001011 spin_unlock(&dentry->d_lock);
1012 spin_lock(&inode->i_lock);
1013 spin_lock(&dentry->d_lock);
1014 if (unlikely(dentry->d_lockref.count))
1015 goto out;
1016 /* changed inode means that somebody had grabbed it */
1017 if (unlikely(inode != dentry->d_inode))
1018 goto out;
Al Viro3b3f09f2018-02-23 21:54:18 -05001019 }
1020
1021 parent = dentry->d_parent;
1022 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1023 return true;
1024
Al Viro3b3f09f2018-02-23 21:54:18 -05001025 spin_unlock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001026 spin_lock(&parent->d_lock);
1027 if (unlikely(parent != dentry->d_parent)) {
1028 spin_unlock(&parent->d_lock);
1029 spin_lock(&dentry->d_lock);
1030 goto out;
1031 }
1032 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
John Ogness8f04da22018-02-23 00:50:24 +01001033 if (likely(!dentry->d_lockref.count))
Al Viro3b3f09f2018-02-23 21:54:18 -05001034 return true;
Al Viro3b3f09f2018-02-23 21:54:18 -05001035 spin_unlock(&parent->d_lock);
1036out:
1037 if (inode)
1038 spin_unlock(&inode->i_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001039 return false;
1040}
1041
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001042static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001044 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001045 struct dentry *dentry, *parent;
Al Viro3b3f09f2018-02-23 21:54:18 -05001046
Miklos Szeredi60942f22014-05-02 15:38:39 -04001047 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001048 spin_lock(&dentry->d_lock);
John Ogness8f04da22018-02-23 00:50:24 +01001049 rcu_read_lock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001050 if (!shrink_lock_dentry(dentry)) {
1051 bool can_free = false;
John Ogness8f04da22018-02-23 00:50:24 +01001052 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001053 d_shrink_del(dentry);
1054 if (dentry->d_lockref.count < 0)
1055 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001056 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001057 if (can_free)
1058 dentry_free(dentry);
1059 continue;
1060 }
John Ogness8f04da22018-02-23 00:50:24 +01001061 rcu_read_unlock();
Al Viro3b3f09f2018-02-23 21:54:18 -05001062 d_shrink_del(dentry);
1063 parent = dentry->d_parent;
Al Viroff2fde92014-05-28 13:59:13 -04001064 __dentry_kill(dentry);
Al Viro3b3f09f2018-02-23 21:54:18 -05001065 if (parent == dentry)
1066 continue;
Al Viro5c47e6d2014-04-29 16:13:18 -04001067 /*
1068 * We need to prune ancestors too. This is necessary to prevent
1069 * quadratic behavior of shrink_dcache_parent(), but is also
1070 * expected to be beneficial in reducing dentry cache
1071 * fragmentation.
1072 */
1073 dentry = parent;
John Ogness8f04da22018-02-23 00:50:24 +01001074 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
1075 dentry = dentry_kill(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001077}
1078
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001079static enum lru_status dentry_lru_isolate(struct list_head *item,
1080 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001081{
1082 struct list_head *freeable = arg;
1083 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1084
1085
1086 /*
1087 * we are inverting the lru lock/dentry->d_lock here,
1088 * so use a trylock. If we fail to get the lock, just skip
1089 * it
1090 */
1091 if (!spin_trylock(&dentry->d_lock))
1092 return LRU_SKIP;
1093
1094 /*
1095 * Referenced dentries are still in use. If they have active
1096 * counts, just remove them from the LRU. Otherwise give them
1097 * another pass through the LRU.
1098 */
1099 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001100 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001101 spin_unlock(&dentry->d_lock);
1102 return LRU_REMOVED;
1103 }
1104
1105 if (dentry->d_flags & DCACHE_REFERENCED) {
1106 dentry->d_flags &= ~DCACHE_REFERENCED;
1107 spin_unlock(&dentry->d_lock);
1108
1109 /*
1110 * The list move itself will be made by the common LRU code. At
1111 * this point, we've dropped the dentry->d_lock but keep the
1112 * lru lock. This is safe to do, since every list movement is
1113 * protected by the lru lock even if both locks are held.
1114 *
1115 * This is guaranteed by the fact that all LRU management
1116 * functions are intermediated by the LRU API calls like
1117 * list_lru_add and list_lru_del. List movement in this file
1118 * only ever occur through this functions or through callbacks
1119 * like this one, that are called from the LRU API.
1120 *
1121 * The only exceptions to this are functions like
1122 * shrink_dentry_list, and code that first checks for the
1123 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1124 * operating only with stack provided lists after they are
1125 * properly isolated from the main list. It is thus, always a
1126 * local access.
1127 */
1128 return LRU_ROTATE;
1129 }
1130
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001131 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001132 spin_unlock(&dentry->d_lock);
1133
1134 return LRU_REMOVED;
1135}
1136
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001137/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001138 * prune_dcache_sb - shrink the dcache
1139 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001140 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001141 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001142 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1143 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001144 * function.
1145 *
1146 * This function may fail to free any resources if all the dentries are in
1147 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001148 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001149long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001150{
Dave Chinnerf6041562013-08-28 10:18:00 +10001151 LIST_HEAD(dispose);
1152 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001153
Vladimir Davydov503c3582015-02-12 14:58:47 -08001154 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1155 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001156 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001157 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
1159
Glauber Costa4e717f52013-08-28 10:18:03 +10001160static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001161 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001162{
Glauber Costa4e717f52013-08-28 10:18:03 +10001163 struct list_head *freeable = arg;
1164 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001165
Glauber Costa4e717f52013-08-28 10:18:03 +10001166 /*
1167 * we are inverting the lru lock/dentry->d_lock here,
1168 * so use a trylock. If we fail to get the lock, just skip
1169 * it
1170 */
1171 if (!spin_trylock(&dentry->d_lock))
1172 return LRU_SKIP;
1173
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001174 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001175 spin_unlock(&dentry->d_lock);
1176
1177 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001178}
1179
Glauber Costa4e717f52013-08-28 10:18:03 +10001180
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001181/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 * shrink_dcache_sb - shrink dcache for a superblock
1183 * @sb: superblock
1184 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001185 * Shrink the dcache for the specified super block. This is used to free
1186 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001188void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
Glauber Costa4e717f52013-08-28 10:18:03 +10001190 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001191
Glauber Costa4e717f52013-08-28 10:18:03 +10001192 do {
1193 LIST_HEAD(dispose);
1194
1195 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001196 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001197
1198 this_cpu_sub(nr_dentry_unused, freed);
1199 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001200 cond_resched();
1201 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001203EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001206 * enum d_walk_ret - action to talke during tree walk
1207 * @D_WALK_CONTINUE: contrinue walk
1208 * @D_WALK_QUIT: quit walk
1209 * @D_WALK_NORETRY: quit when retry is needed
1210 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001212enum d_walk_ret {
1213 D_WALK_CONTINUE,
1214 D_WALK_QUIT,
1215 D_WALK_NORETRY,
1216 D_WALK_SKIP,
1217};
1218
1219/**
1220 * d_walk - walk the dentry tree
1221 * @parent: start of walk
1222 * @data: data passed to @enter() and @finish()
1223 * @enter: callback when first entering the dentry
1224 * @finish: callback when successfully finished the walk
1225 *
1226 * The @enter() and @finish() callbacks are called with d_lock held.
1227 */
1228static void d_walk(struct dentry *parent, void *data,
1229 enum d_walk_ret (*enter)(void *, struct dentry *),
1230 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231{
Nick Piggin949854d2011-01-07 17:49:37 +11001232 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001234 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001235 enum d_walk_ret ret;
1236 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001237
Nick Piggin58db63d2011-01-07 17:49:39 +11001238again:
Al Viro48f5ec22013-09-09 15:22:25 -04001239 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001240 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001241 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242
1243 ret = enter(data, this_parent);
1244 switch (ret) {
1245 case D_WALK_CONTINUE:
1246 break;
1247 case D_WALK_QUIT:
1248 case D_WALK_SKIP:
1249 goto out_unlock;
1250 case D_WALK_NORETRY:
1251 retry = false;
1252 break;
1253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254repeat:
1255 next = this_parent->d_subdirs.next;
1256resume:
1257 while (next != &this_parent->d_subdirs) {
1258 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001259 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001261
Al Viroba65dc52016-06-10 11:32:47 -04001262 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1263 continue;
1264
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001265 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001266
1267 ret = enter(data, dentry);
1268 switch (ret) {
1269 case D_WALK_CONTINUE:
1270 break;
1271 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001272 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001273 goto out_unlock;
1274 case D_WALK_NORETRY:
1275 retry = false;
1276 break;
1277 case D_WALK_SKIP:
1278 spin_unlock(&dentry->d_lock);
1279 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001280 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001281
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001283 spin_unlock(&this_parent->d_lock);
1284 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001286 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 goto repeat;
1288 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001289 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 }
1291 /*
1292 * All done at this level ... ascend and resume the search.
1293 */
Al Viroca5358e2014-10-26 19:31:10 -04001294 rcu_read_lock();
1295ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001297 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001298 this_parent = child->d_parent;
1299
Al Viro31dec132013-10-25 17:04:27 -04001300 spin_unlock(&child->d_lock);
1301 spin_lock(&this_parent->d_lock);
1302
Al Viroca5358e2014-10-26 19:31:10 -04001303 /* might go back up the wrong parent if we have had a rename. */
1304 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001305 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001306 /* go into the first sibling still alive */
1307 do {
1308 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001309 if (next == &this_parent->d_subdirs)
1310 goto ascend;
1311 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001312 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001313 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 goto resume;
1315 }
Al Viroca5358e2014-10-26 19:31:10 -04001316 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001317 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001318 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001319 if (finish)
1320 finish(data);
1321
1322out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001323 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001324 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001325 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001326
1327rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001328 spin_unlock(&this_parent->d_lock);
1329 rcu_read_unlock();
1330 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001331 if (!retry)
1332 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001333 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001334 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336
Ian Kent01619492016-11-24 08:03:41 +11001337struct check_mount {
1338 struct vfsmount *mnt;
1339 unsigned int mounted;
1340};
1341
1342static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1343{
1344 struct check_mount *info = data;
1345 struct path path = { .mnt = info->mnt, .dentry = dentry };
1346
1347 if (likely(!d_mountpoint(dentry)))
1348 return D_WALK_CONTINUE;
1349 if (__path_is_mountpoint(&path)) {
1350 info->mounted = 1;
1351 return D_WALK_QUIT;
1352 }
1353 return D_WALK_CONTINUE;
1354}
1355
1356/**
1357 * path_has_submounts - check for mounts over a dentry in the
1358 * current namespace.
1359 * @parent: path to check.
1360 *
1361 * Return true if the parent or its subdirectories contain
1362 * a mount point in the current namespace.
1363 */
1364int path_has_submounts(const struct path *parent)
1365{
1366 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1367
1368 read_seqlock_excl(&mount_lock);
1369 d_walk(parent->dentry, &data, path_check_mount, NULL);
1370 read_sequnlock_excl(&mount_lock);
1371
1372 return data.mounted;
1373}
1374EXPORT_SYMBOL(path_has_submounts);
1375
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001377 * Called by mount code to set a mountpoint and check if the mountpoint is
1378 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1379 * subtree can become unreachable).
1380 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001381 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001382 * this reason take rename_lock and d_lock on dentry and ancestors.
1383 */
1384int d_set_mounted(struct dentry *dentry)
1385{
1386 struct dentry *p;
1387 int ret = -ENOENT;
1388 write_seqlock(&rename_lock);
1389 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001390 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001391 spin_lock(&p->d_lock);
1392 if (unlikely(d_unhashed(p))) {
1393 spin_unlock(&p->d_lock);
1394 goto out;
1395 }
1396 spin_unlock(&p->d_lock);
1397 }
1398 spin_lock(&dentry->d_lock);
1399 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001400 ret = -EBUSY;
1401 if (!d_mountpoint(dentry)) {
1402 dentry->d_flags |= DCACHE_MOUNTED;
1403 ret = 0;
1404 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001405 }
1406 spin_unlock(&dentry->d_lock);
1407out:
1408 write_sequnlock(&rename_lock);
1409 return ret;
1410}
1411
1412/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001413 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 * and move any unused dentries to the end of the unused
1415 * list for prune_dcache(). We descend to the next level
1416 * whenever the d_subdirs list is non-empty and continue
1417 * searching.
1418 *
1419 * It returns zero iff there are no unused children,
1420 * otherwise it returns the number of children moved to
1421 * the end of the unused list. This may not be the total
1422 * number of unused children, because select_parent can
1423 * drop the lock and return early due to latency
1424 * constraints.
1425 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001426
1427struct select_data {
1428 struct dentry *start;
1429 struct list_head dispose;
1430 int found;
1431};
1432
1433static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001435 struct select_data *data = _data;
1436 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001438 if (data->start == dentry)
1439 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Al Virofe915222014-05-03 00:02:25 -04001441 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001442 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001443 } else {
1444 if (dentry->d_flags & DCACHE_LRU_LIST)
1445 d_lru_del(dentry);
1446 if (!dentry->d_lockref.count) {
1447 d_shrink_add(dentry, &data->dispose);
1448 data->found++;
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 }
1451 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001452 * We can return to the caller if we have found some (this
1453 * ensures forward progress). We'll be coming back to find
1454 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 */
Al Virofe915222014-05-03 00:02:25 -04001456 if (!list_empty(&data->dispose))
1457 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001459 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460}
1461
1462/**
1463 * shrink_dcache_parent - prune dcache
1464 * @parent: parent of entries to prune
1465 *
1466 * Prune the dcache to remove unused children of the parent dentry.
1467 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001468void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001470 for (;;) {
1471 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001473 INIT_LIST_HEAD(&data.dispose);
1474 data.start = parent;
1475 data.found = 0;
1476
1477 d_walk(parent, &data, select_collect, NULL);
1478 if (!data.found)
1479 break;
1480
1481 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001482 cond_resched();
1483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001485EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Al Viro9c8c10e2014-05-02 20:36:10 -04001487static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001488{
Al Viro9c8c10e2014-05-02 20:36:10 -04001489 /* it has busy descendents; complain about those instead */
1490 if (!list_empty(&dentry->d_subdirs))
1491 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001492
Al Viro9c8c10e2014-05-02 20:36:10 -04001493 /* root with refcount 1 is fine */
1494 if (dentry == _data && dentry->d_lockref.count == 1)
1495 return D_WALK_CONTINUE;
1496
1497 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1498 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001499 dentry,
1500 dentry->d_inode ?
1501 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001502 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001503 dentry->d_lockref.count,
1504 dentry->d_sb->s_type->name,
1505 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001506 WARN_ON(1);
1507 return D_WALK_CONTINUE;
1508}
1509
1510static void do_one_tree(struct dentry *dentry)
1511{
1512 shrink_dcache_parent(dentry);
1513 d_walk(dentry, dentry, umount_check, NULL);
1514 d_drop(dentry);
1515 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001516}
1517
1518/*
1519 * destroy the dentries attached to a superblock on unmounting
1520 */
1521void shrink_dcache_for_umount(struct super_block *sb)
1522{
1523 struct dentry *dentry;
1524
Al Viro9c8c10e2014-05-02 20:36:10 -04001525 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001526
1527 dentry = sb->s_root;
1528 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001529 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001530
NeilBrownf1ee6162017-12-21 09:45:40 +11001531 while (!hlist_bl_empty(&sb->s_roots)) {
1532 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001533 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001534 }
1535}
1536
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001537struct detach_data {
1538 struct select_data select;
1539 struct dentry *mountpoint;
1540};
1541static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001542{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001543 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001544
1545 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001546 __dget_dlock(dentry);
1547 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001548 return D_WALK_QUIT;
1549 }
1550
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001551 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552}
1553
1554static void check_and_drop(void *_data)
1555{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001556 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001557
Al Viro81be24d2017-06-03 07:20:09 +01001558 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001559 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001560}
1561
1562/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001563 * d_invalidate - detach submounts, prune dcache, and drop
1564 * @dentry: dentry to invalidate (aka detach, prune and drop)
1565 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001566 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001567 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001568 * The final d_drop is done as an atomic operation relative to
1569 * rename_lock ensuring there are no races with d_set_mounted. This
1570 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001571 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001572void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001573{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001574 /*
1575 * If it's already been dropped, return OK.
1576 */
1577 spin_lock(&dentry->d_lock);
1578 if (d_unhashed(dentry)) {
1579 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001580 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001581 }
1582 spin_unlock(&dentry->d_lock);
1583
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001584 /* Negative dentries can be dropped without further checks */
1585 if (!dentry->d_inode) {
1586 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001587 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001588 }
1589
1590 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001591 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001592
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001593 data.mountpoint = NULL;
1594 INIT_LIST_HEAD(&data.select.dispose);
1595 data.select.start = dentry;
1596 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001597
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001598 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001599
Al Viro81be24d2017-06-03 07:20:09 +01001600 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001601 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001602 else if (!data.mountpoint)
1603 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001604
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001605 if (data.mountpoint) {
1606 detach_mounts(data.mountpoint);
1607 dput(data.mountpoint);
1608 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001609 cond_resched();
1610 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001611}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001612EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614/**
Al Viroa4464db2011-07-07 15:03:58 -04001615 * __d_alloc - allocate a dcache entry
1616 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 * @name: qstr of the name
1618 *
1619 * Allocates a dentry. It returns %NULL if there is insufficient memory
1620 * available. On a success the dentry is returned. The name passed in is
1621 * copied and the copy passed in may be reused after this call.
1622 */
1623
Al Viroa4464db2011-07-07 15:03:58 -04001624struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625{
1626 struct dentry *dentry;
1627 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001628 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Mel Gormane12ba742007-10-16 01:25:52 -07001630 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 if (!dentry)
1632 return NULL;
1633
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001634 /*
1635 * We guarantee that the inline name is always NUL-terminated.
1636 * This way the memcpy() done by the name switching in rename
1637 * will still always have a NUL at the end, even if we might
1638 * be overwriting an internal NUL character
1639 */
1640 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001641 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001642 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001643 dname = dentry->d_iname;
1644 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001645 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001646 struct external_name *p = kmalloc(size + name->len,
1647 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001648 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 kmem_cache_free(dentry_cache, dentry);
1650 return NULL;
1651 }
Al Viro8d85b482014-09-29 14:54:27 -04001652 atomic_set(&p->u.count, 1);
1653 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 } else {
1655 dname = dentry->d_iname;
1656 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658 dentry->d_name.len = name->len;
1659 dentry->d_name.hash = name->hash;
1660 memcpy(dname, name->name, name->len);
1661 dname[name->len] = 0;
1662
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001663 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001664 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001665
Waiman Long98474232013-08-28 18:24:59 -07001666 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001667 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001669 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001671 dentry->d_parent = dentry;
1672 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 dentry->d_op = NULL;
1674 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001675 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 INIT_LIST_HEAD(&dentry->d_lru);
1677 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001678 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1679 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001680 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
Miklos Szeredi285b1022016-06-28 11:47:32 +02001682 if (dentry->d_op && dentry->d_op->d_init) {
1683 err = dentry->d_op->d_init(dentry);
1684 if (err) {
1685 if (dname_external(dentry))
1686 kfree(external_name(dentry));
1687 kmem_cache_free(dentry_cache, dentry);
1688 return NULL;
1689 }
1690 }
1691
Nick Piggin3e880fb2011-01-07 17:49:19 +11001692 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 return dentry;
1695}
Al Viroa4464db2011-07-07 15:03:58 -04001696
1697/**
1698 * d_alloc - allocate a dcache entry
1699 * @parent: parent of entry to allocate
1700 * @name: qstr of the name
1701 *
1702 * Allocates a dentry. It returns %NULL if there is insufficient memory
1703 * available. On a success the dentry is returned. The name passed in is
1704 * copied and the copy passed in may be reused after this call.
1705 */
1706struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1707{
1708 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1709 if (!dentry)
1710 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001711 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001712 spin_lock(&parent->d_lock);
1713 /*
1714 * don't need child lock because it is not subject
1715 * to concurrency here
1716 */
1717 __dget_dlock(parent);
1718 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001719 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001720 spin_unlock(&parent->d_lock);
1721
1722 return dentry;
1723}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001724EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
Miklos Szeredif9c34672018-01-19 11:39:52 +01001726struct dentry *d_alloc_anon(struct super_block *sb)
1727{
1728 return __d_alloc(sb, NULL);
1729}
1730EXPORT_SYMBOL(d_alloc_anon);
1731
Al Viroba65dc52016-06-10 11:32:47 -04001732struct dentry *d_alloc_cursor(struct dentry * parent)
1733{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001734 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001735 if (dentry) {
1736 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1737 dentry->d_parent = dget(parent);
1738 }
1739 return dentry;
1740}
1741
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001742/**
1743 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1744 * @sb: the superblock
1745 * @name: qstr of the name
1746 *
1747 * For a filesystem that just pins its dentries in memory and never
1748 * performs lookups at all, return an unhashed IS_ROOT dentry.
1749 */
Nick Piggin4b936882011-01-07 17:50:07 +11001750struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1751{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001752 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001753}
1754EXPORT_SYMBOL(d_alloc_pseudo);
1755
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1757{
1758 struct qstr q;
1759
1760 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001761 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 return d_alloc(parent, &q);
1763}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001764EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
Nick Pigginfb045ad2011-01-07 17:49:55 +11001766void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1767{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001768 WARN_ON_ONCE(dentry->d_op);
1769 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001770 DCACHE_OP_COMPARE |
1771 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001772 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001773 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001774 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001775 dentry->d_op = op;
1776 if (!op)
1777 return;
1778 if (op->d_hash)
1779 dentry->d_flags |= DCACHE_OP_HASH;
1780 if (op->d_compare)
1781 dentry->d_flags |= DCACHE_OP_COMPARE;
1782 if (op->d_revalidate)
1783 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001784 if (op->d_weak_revalidate)
1785 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001786 if (op->d_delete)
1787 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001788 if (op->d_prune)
1789 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001790 if (op->d_real)
1791 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001792
1793}
1794EXPORT_SYMBOL(d_set_d_op);
1795
David Howellsdf1a0852015-01-29 12:02:28 +00001796
1797/*
1798 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1799 * @dentry - The dentry to mark
1800 *
1801 * Mark a dentry as falling through to the lower layer (as set with
1802 * d_pin_lower()). This flag may be recorded on the medium.
1803 */
1804void d_set_fallthru(struct dentry *dentry)
1805{
1806 spin_lock(&dentry->d_lock);
1807 dentry->d_flags |= DCACHE_FALLTHRU;
1808 spin_unlock(&dentry->d_lock);
1809}
1810EXPORT_SYMBOL(d_set_fallthru);
1811
David Howellsb18825a2013-09-12 19:22:53 +01001812static unsigned d_flags_for_inode(struct inode *inode)
1813{
David Howells44bdb5e2015-01-29 12:02:29 +00001814 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001815
1816 if (!inode)
1817 return DCACHE_MISS_TYPE;
1818
1819 if (S_ISDIR(inode->i_mode)) {
1820 add_flags = DCACHE_DIRECTORY_TYPE;
1821 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1822 if (unlikely(!inode->i_op->lookup))
1823 add_flags = DCACHE_AUTODIR_TYPE;
1824 else
1825 inode->i_opflags |= IOP_LOOKUP;
1826 }
David Howells44bdb5e2015-01-29 12:02:29 +00001827 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001828 }
1829
David Howells44bdb5e2015-01-29 12:02:29 +00001830 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001831 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001832 add_flags = DCACHE_SYMLINK_TYPE;
1833 goto type_determined;
1834 }
1835 inode->i_opflags |= IOP_NOFOLLOW;
1836 }
1837
1838 if (unlikely(!S_ISREG(inode->i_mode)))
1839 add_flags = DCACHE_SPECIAL_TYPE;
1840
1841type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001842 if (unlikely(IS_AUTOMOUNT(inode)))
1843 add_flags |= DCACHE_NEED_AUTOMOUNT;
1844 return add_flags;
1845}
1846
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001847static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1848{
David Howellsb18825a2013-09-12 19:22:53 +01001849 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001850 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001851
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001852 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001853 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001854 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001855 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001856 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001857 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001858 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001859}
1860
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861/**
1862 * d_instantiate - fill in inode information for a dentry
1863 * @entry: dentry to complete
1864 * @inode: inode to attach to this dentry
1865 *
1866 * Fill in inode information in the entry.
1867 *
1868 * This turns negative dentries into productive full members
1869 * of society.
1870 *
1871 * NOTE! This assumes that the inode count has been incremented
1872 * (or otherwise set) by the caller to indicate that it is now
1873 * in use by the dcache.
1874 */
1875
1876void d_instantiate(struct dentry *entry, struct inode * inode)
1877{
Al Viro946e51f2014-10-26 19:19:16 -04001878 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001879 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001880 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001881 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001882 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001883 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001886EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887
1888/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001889 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1890 * @entry: dentry to complete
1891 * @inode: inode to attach to this dentry
1892 *
1893 * Fill in inode information in the entry. If a directory alias is found, then
1894 * return an error (and drop inode). Together with d_materialise_unique() this
1895 * guarantees that a directory inode may never have more than one alias.
1896 */
1897int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1898{
Al Viro946e51f2014-10-26 19:19:16 -04001899 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001900
Al Virob9680912016-04-11 00:53:26 -04001901 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001902 spin_lock(&inode->i_lock);
1903 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1904 spin_unlock(&inode->i_lock);
1905 iput(inode);
1906 return -EBUSY;
1907 }
1908 __d_instantiate(entry, inode);
1909 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001910
1911 return 0;
1912}
1913EXPORT_SYMBOL(d_instantiate_no_diralias);
1914
Al Viroadc0e91a2012-01-08 16:49:21 -05001915struct dentry *d_make_root(struct inode *root_inode)
1916{
1917 struct dentry *res = NULL;
1918
1919 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001920 res = d_alloc_anon(root_inode->i_sb);
Al Viroadc0e91a2012-01-08 16:49:21 -05001921 if (res)
1922 d_instantiate(res, root_inode);
1923 else
1924 iput(root_inode);
1925 }
1926 return res;
1927}
1928EXPORT_SYMBOL(d_make_root);
1929
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001930static struct dentry * __d_find_any_alias(struct inode *inode)
1931{
1932 struct dentry *alias;
1933
Al Virob3d9b7a2012-06-09 13:51:19 -04001934 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001935 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001936 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001937 __dget(alias);
1938 return alias;
1939}
1940
Sage Weil46f72b32012-01-10 09:04:37 -08001941/**
1942 * d_find_any_alias - find any alias for a given inode
1943 * @inode: inode to find an alias for
1944 *
1945 * If any aliases exist for the given inode, take and return a
1946 * reference for one of them. If no aliases exist, return %NULL.
1947 */
1948struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001949{
1950 struct dentry *de;
1951
1952 spin_lock(&inode->i_lock);
1953 de = __d_find_any_alias(inode);
1954 spin_unlock(&inode->i_lock);
1955 return de;
1956}
Sage Weil46f72b32012-01-10 09:04:37 -08001957EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001958
Miklos Szeredif9c34672018-01-19 11:39:52 +01001959static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1960 struct inode *inode,
1961 bool disconnected)
1962{
1963 struct dentry *res;
1964 unsigned add_flags;
1965
1966 security_d_instantiate(dentry, inode);
1967 spin_lock(&inode->i_lock);
1968 res = __d_find_any_alias(inode);
1969 if (res) {
1970 spin_unlock(&inode->i_lock);
1971 dput(dentry);
1972 goto out_iput;
1973 }
1974
1975 /* attach a disconnected dentry */
1976 add_flags = d_flags_for_inode(inode);
1977
1978 if (disconnected)
1979 add_flags |= DCACHE_DISCONNECTED;
1980
1981 spin_lock(&dentry->d_lock);
1982 __d_set_inode_and_type(dentry, inode, add_flags);
1983 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08001984 if (!disconnected) {
1985 hlist_bl_lock(&dentry->d_sb->s_roots);
1986 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
1987 hlist_bl_unlock(&dentry->d_sb->s_roots);
1988 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01001989 spin_unlock(&dentry->d_lock);
1990 spin_unlock(&inode->i_lock);
1991
1992 return dentry;
1993
1994 out_iput:
1995 iput(inode);
1996 return res;
1997}
1998
1999struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2000{
2001 return __d_instantiate_anon(dentry, inode, true);
2002}
2003EXPORT_SYMBOL(d_instantiate_anon);
2004
2005static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002006{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002007 struct dentry *tmp;
2008 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002009
2010 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002011 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002012 if (IS_ERR(inode))
2013 return ERR_CAST(inode);
2014
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002015 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002016 if (res)
2017 goto out_iput;
2018
Miklos Szeredif9c34672018-01-19 11:39:52 +01002019 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002020 if (!tmp) {
2021 res = ERR_PTR(-ENOMEM);
2022 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002023 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002024
Miklos Szeredif9c34672018-01-19 11:39:52 +01002025 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002026
Miklos Szeredif9c34672018-01-19 11:39:52 +01002027out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002028 iput(inode);
2029 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002030}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002031
2032/**
2033 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2034 * @inode: inode to allocate the dentry for
2035 *
2036 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2037 * similar open by handle operations. The returned dentry may be anonymous,
2038 * or may have a full name (if the inode was already in the cache).
2039 *
2040 * When called on a directory inode, we must ensure that the inode only ever
2041 * has one dentry. If a dentry is found, that is returned instead of
2042 * allocating a new one.
2043 *
2044 * On successful return, the reference to the inode has been transferred
2045 * to the dentry. In case of an error the reference on the inode is released.
2046 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2047 * be passed in and the error will be propagated to the return value,
2048 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2049 */
2050struct dentry *d_obtain_alias(struct inode *inode)
2051{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002052 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002053}
Benny Halevyadc48722009-02-27 14:02:59 -08002054EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055
2056/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002057 * d_obtain_root - find or allocate a dentry for a given inode
2058 * @inode: inode to allocate the dentry for
2059 *
2060 * Obtain an IS_ROOT dentry for the root of a filesystem.
2061 *
2062 * We must ensure that directory inodes only ever have one dentry. If a
2063 * dentry is found, that is returned instead of allocating a new one.
2064 *
2065 * On successful return, the reference to the inode has been transferred
2066 * to the dentry. In case of an error the reference on the inode is
2067 * released. A %NULL or IS_ERR inode may be passed in and will be the
2068 * error will be propagate to the return value, with a %NULL @inode
2069 * replaced by ERR_PTR(-ESTALE).
2070 */
2071struct dentry *d_obtain_root(struct inode *inode)
2072{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002073 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002074}
2075EXPORT_SYMBOL(d_obtain_root);
2076
2077/**
Barry Naujok94035402008-05-21 16:50:46 +10002078 * d_add_ci - lookup or allocate new dentry with case-exact name
2079 * @inode: the inode case-insensitive lookup has found
2080 * @dentry: the negative dentry that was passed to the parent's lookup func
2081 * @name: the case-exact name to be associated with the returned dentry
2082 *
2083 * This is to avoid filling the dcache with case-insensitive names to the
2084 * same inode, only the actual correct case is stored in the dcache for
2085 * case-insensitive filesystems.
2086 *
2087 * For a case-insensitive lookup match and if the the case-exact dentry
2088 * already exists in in the dcache, use it and return it.
2089 *
2090 * If no entry exists with the exact case name, allocate new dentry with
2091 * the exact case, and return the spliced entry.
2092 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002093struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002094 struct qstr *name)
2095{
Al Virod9171b92016-04-15 03:33:13 -04002096 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002097
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002098 /*
2099 * First check if a dentry matching the name already exists,
2100 * if not go ahead and create it now.
2101 */
Barry Naujok94035402008-05-21 16:50:46 +10002102 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002103 if (found) {
2104 iput(inode);
2105 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002106 }
Al Virod9171b92016-04-15 03:33:13 -04002107 if (d_in_lookup(dentry)) {
2108 found = d_alloc_parallel(dentry->d_parent, name,
2109 dentry->d_wait);
2110 if (IS_ERR(found) || !d_in_lookup(found)) {
2111 iput(inode);
2112 return found;
2113 }
2114 } else {
2115 found = d_alloc(dentry->d_parent, name);
2116 if (!found) {
2117 iput(inode);
2118 return ERR_PTR(-ENOMEM);
2119 }
2120 }
2121 res = d_splice_alias(inode, found);
2122 if (res) {
2123 dput(found);
2124 return res;
2125 }
Al Viro4f522a22013-02-11 23:20:37 -05002126 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002127}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002128EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002130
Al Virod4c91a82016-06-25 23:33:49 -04002131static inline bool d_same_name(const struct dentry *dentry,
2132 const struct dentry *parent,
2133 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002134{
Al Virod4c91a82016-06-25 23:33:49 -04002135 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2136 if (dentry->d_name.len != name->len)
2137 return false;
2138 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002139 }
Al Viro6fa67e72016-07-31 16:37:25 -04002140 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002141 dentry->d_name.len, dentry->d_name.name,
2142 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002143}
2144
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002146 * __d_lookup_rcu - search for a dentry (racy, store-free)
2147 * @parent: parent dentry
2148 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002149 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002150 * Returns: dentry, or NULL
2151 *
2152 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2153 * resolution (store-free path walking) design described in
2154 * Documentation/filesystems/path-lookup.txt.
2155 *
2156 * This is not to be used outside core vfs.
2157 *
2158 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2159 * held, and rcu_read_lock held. The returned dentry must not be stored into
2160 * without taking d_lock and checking d_seq sequence count against @seq
2161 * returned here.
2162 *
Linus Torvalds15570082013-09-02 11:38:06 -07002163 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002164 * function.
2165 *
2166 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2167 * the returned dentry, so long as its parent's seqlock is checked after the
2168 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2169 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002170 *
2171 * NOTE! The caller *has* to check the resulting dentry against the sequence
2172 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002173 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002174struct dentry *__d_lookup_rcu(const struct dentry *parent,
2175 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002176 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002177{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002178 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002179 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002180 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002181 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002182 struct dentry *dentry;
2183
2184 /*
2185 * Note: There is significant duplication with __d_lookup_rcu which is
2186 * required to prevent single threaded performance regressions
2187 * especially on architectures where smp_rmb (in seqcounts) are costly.
2188 * Keep the two functions in sync.
2189 */
2190
2191 /*
2192 * The hash list is protected using RCU.
2193 *
2194 * Carefully use d_seq when comparing a candidate dentry, to avoid
2195 * races with d_move().
2196 *
2197 * It is possible that concurrent renames can mess up our list
2198 * walk here and result in missing our dentry, resulting in the
2199 * false-negative result. d_lookup() protects against concurrent
2200 * renames using rename_lock seqlock.
2201 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002202 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002203 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002204 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002205 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002206
Nick Piggin31e6b012011-01-07 17:49:52 +11002207seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002208 /*
2209 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002210 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002211 *
2212 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002213 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002214 *
2215 * NOTE! We do a "raw" seqcount_begin here. That means that
2216 * we don't wait for the sequence count to stabilize if it
2217 * is in the middle of a sequence change. If we do the slow
2218 * dentry compare, we will do seqretries until it is stable,
2219 * and if we end up with a successful lookup, we actually
2220 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002221 *
2222 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2223 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002224 */
2225 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002226 if (dentry->d_parent != parent)
2227 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002228 if (d_unhashed(dentry))
2229 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002230
2231 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002232 int tlen;
2233 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002234 if (dentry->d_name.hash != hashlen_hash(hashlen))
2235 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002236 tlen = dentry->d_name.len;
2237 tname = dentry->d_name.name;
2238 /* we want a consistent (name,len) pair */
2239 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2240 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002241 goto seqretry;
2242 }
Al Viro6fa67e72016-07-31 16:37:25 -04002243 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002244 tlen, tname, name) != 0)
2245 continue;
2246 } else {
2247 if (dentry->d_name.hash_len != hashlen)
2248 continue;
2249 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2250 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002251 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002252 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002253 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002254 }
2255 return NULL;
2256}
2257
2258/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 * d_lookup - search for a dentry
2260 * @parent: parent dentry
2261 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002262 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002264 * d_lookup searches the children of the parent dentry for the name in
2265 * question. If the dentry is found its reference count is incremented and the
2266 * dentry is returned. The caller must use dput to free the entry when it has
2267 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 */
Al Viroda2d8452013-01-24 18:29:34 -05002269struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270{
Nick Piggin31e6b012011-01-07 17:49:52 +11002271 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002272 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Daeseok Younb8314f92014-08-11 11:46:53 +09002274 do {
2275 seq = read_seqbegin(&rename_lock);
2276 dentry = __d_lookup(parent, name);
2277 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 break;
2279 } while (read_seqretry(&rename_lock, seq));
2280 return dentry;
2281}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002282EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
Nick Piggin31e6b012011-01-07 17:49:52 +11002284/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002285 * __d_lookup - search for a dentry (racy)
2286 * @parent: parent dentry
2287 * @name: qstr of name we wish to find
2288 * Returns: dentry, or NULL
2289 *
2290 * __d_lookup is like d_lookup, however it may (rarely) return a
2291 * false-negative result due to unrelated rename activity.
2292 *
2293 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2294 * however it must be used carefully, eg. with a following d_lookup in
2295 * the case of failure.
2296 *
2297 * __d_lookup callers must be commented.
2298 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002299struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002302 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002303 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002304 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002305 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306
Nick Pigginb04f7842010-08-18 04:37:34 +10002307 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002308 * Note: There is significant duplication with __d_lookup_rcu which is
2309 * required to prevent single threaded performance regressions
2310 * especially on architectures where smp_rmb (in seqcounts) are costly.
2311 * Keep the two functions in sync.
2312 */
2313
2314 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002315 * The hash list is protected using RCU.
2316 *
2317 * Take d_lock when comparing a candidate dentry, to avoid races
2318 * with d_move().
2319 *
2320 * It is possible that concurrent renames can mess up our list
2321 * walk here and result in missing our dentry, resulting in the
2322 * false-negative result. d_lookup() protects against concurrent
2323 * renames using rename_lock seqlock.
2324 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002325 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002326 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 rcu_read_lock();
2328
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002329 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 if (dentry->d_name.hash != hash)
2332 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
2334 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 if (dentry->d_parent != parent)
2336 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002337 if (d_unhashed(dentry))
2338 goto next;
2339
Al Virod4c91a82016-06-25 23:33:49 -04002340 if (!d_same_name(dentry, parent, name))
2341 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
Waiman Long98474232013-08-28 18:24:59 -07002343 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002344 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 spin_unlock(&dentry->d_lock);
2346 break;
2347next:
2348 spin_unlock(&dentry->d_lock);
2349 }
2350 rcu_read_unlock();
2351
2352 return found;
2353}
2354
2355/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002356 * d_hash_and_lookup - hash the qstr then search for a dentry
2357 * @dir: Directory to search in
2358 * @name: qstr of name we wish to find
2359 *
Al Viro4f522a22013-02-11 23:20:37 -05002360 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002361 */
2362struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2363{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002364 /*
2365 * Check for a fs-specific hash function. Note that we must
2366 * calculate the standard hash first, as the d_op->d_hash()
2367 * routine may choose to leave the hash value unchanged.
2368 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002369 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002370 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002371 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002372 if (unlikely(err < 0))
2373 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002374 }
Al Viro4f522a22013-02-11 23:20:37 -05002375 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002376}
Al Viro4f522a22013-02-11 23:20:37 -05002377EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002378
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379/*
2380 * When a file is deleted, we have two options:
2381 * - turn this dentry into a negative dentry
2382 * - unhash this dentry and free it.
2383 *
2384 * Usually, we want to just turn this into
2385 * a negative dentry, but if anybody else is
2386 * currently using the dentry or the inode
2387 * we can't do that and we fall back on removing
2388 * it from the hash queues and waiting for
2389 * it to be deleted later when it has no users
2390 */
2391
2392/**
2393 * d_delete - delete a dentry
2394 * @dentry: The dentry to delete
2395 *
2396 * Turn the dentry into a negative dentry if possible, otherwise
2397 * remove it from the hash queues so it can be deleted later
2398 */
2399
2400void d_delete(struct dentry * dentry)
2401{
Al Viroc19457f2018-02-23 21:02:31 -05002402 struct inode *inode = dentry->d_inode;
2403 int isdir = d_is_dir(dentry);
2404
2405 spin_lock(&inode->i_lock);
2406 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 /*
2408 * Are we the only user?
2409 */
Waiman Long98474232013-08-28 18:24:59 -07002410 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002411 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002412 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002413 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002415 spin_unlock(&dentry->d_lock);
2416 spin_unlock(&inode->i_lock);
2417 }
John McCutchan7a91bf72005-08-08 13:52:16 -04002418 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002420EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421
Al Viro15d3c582016-07-29 17:45:21 -04002422static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423{
Al Viro15d3c582016-07-29 17:45:21 -04002424 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002425
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002426 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002427 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002428 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429}
2430
2431/**
2432 * d_rehash - add an entry back to the hash
2433 * @entry: dentry to add to the hash
2434 *
2435 * Adds a dentry to the hash according to its name.
2436 */
2437
2438void d_rehash(struct dentry * entry)
2439{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002441 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002444EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Al Viro84e710d2016-04-15 00:58:55 -04002446static inline unsigned start_dir_add(struct inode *dir)
2447{
2448
2449 for (;;) {
2450 unsigned n = dir->i_dir_seq;
2451 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2452 return n;
2453 cpu_relax();
2454 }
2455}
2456
2457static inline void end_dir_add(struct inode *dir, unsigned n)
2458{
2459 smp_store_release(&dir->i_dir_seq, n + 2);
2460}
2461
Al Virod9171b92016-04-15 03:33:13 -04002462static void d_wait_lookup(struct dentry *dentry)
2463{
2464 if (d_in_lookup(dentry)) {
2465 DECLARE_WAITQUEUE(wait, current);
2466 add_wait_queue(dentry->d_wait, &wait);
2467 do {
2468 set_current_state(TASK_UNINTERRUPTIBLE);
2469 spin_unlock(&dentry->d_lock);
2470 schedule();
2471 spin_lock(&dentry->d_lock);
2472 } while (d_in_lookup(dentry));
2473 }
2474}
2475
Al Viro94bdd652016-04-15 02:42:04 -04002476struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002477 const struct qstr *name,
2478 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002479{
Al Viro94bdd652016-04-15 02:42:04 -04002480 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002481 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2482 struct hlist_bl_node *node;
2483 struct dentry *new = d_alloc(parent, name);
2484 struct dentry *dentry;
2485 unsigned seq, r_seq, d_seq;
2486
2487 if (unlikely(!new))
2488 return ERR_PTR(-ENOMEM);
2489
2490retry:
2491 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002492 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002493 r_seq = read_seqbegin(&rename_lock);
2494 dentry = __d_lookup_rcu(parent, name, &d_seq);
2495 if (unlikely(dentry)) {
2496 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2497 rcu_read_unlock();
2498 goto retry;
2499 }
2500 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2501 rcu_read_unlock();
2502 dput(dentry);
2503 goto retry;
2504 }
2505 rcu_read_unlock();
2506 dput(new);
2507 return dentry;
2508 }
2509 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2510 rcu_read_unlock();
2511 goto retry;
2512 }
Will Deacon015555f2018-02-19 14:55:54 +00002513
2514 if (unlikely(seq & 1)) {
2515 rcu_read_unlock();
2516 goto retry;
2517 }
2518
Al Viro94bdd652016-04-15 02:42:04 -04002519 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002520 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002521 hlist_bl_unlock(b);
2522 rcu_read_unlock();
2523 goto retry;
2524 }
Al Viro94bdd652016-04-15 02:42:04 -04002525 /*
2526 * No changes for the parent since the beginning of d_lookup().
2527 * Since all removals from the chain happen with hlist_bl_lock(),
2528 * any potential in-lookup matches are going to stay here until
2529 * we unlock the chain. All fields are stable in everything
2530 * we encounter.
2531 */
2532 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2533 if (dentry->d_name.hash != hash)
2534 continue;
2535 if (dentry->d_parent != parent)
2536 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002537 if (!d_same_name(dentry, parent, name))
2538 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002539 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002540 /* now we can try to grab a reference */
2541 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2542 rcu_read_unlock();
2543 goto retry;
2544 }
2545
2546 rcu_read_unlock();
2547 /*
2548 * somebody is likely to be still doing lookup for it;
2549 * wait for them to finish
2550 */
Al Virod9171b92016-04-15 03:33:13 -04002551 spin_lock(&dentry->d_lock);
2552 d_wait_lookup(dentry);
2553 /*
2554 * it's not in-lookup anymore; in principle we should repeat
2555 * everything from dcache lookup, but it's likely to be what
2556 * d_lookup() would've found anyway. If it is, just return it;
2557 * otherwise we really have to repeat the whole thing.
2558 */
2559 if (unlikely(dentry->d_name.hash != hash))
2560 goto mismatch;
2561 if (unlikely(dentry->d_parent != parent))
2562 goto mismatch;
2563 if (unlikely(d_unhashed(dentry)))
2564 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002565 if (unlikely(!d_same_name(dentry, parent, name)))
2566 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002567 /* OK, it *is* a hashed match; return it */
2568 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002569 dput(new);
2570 return dentry;
2571 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002572 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002573 /* we can't take ->d_lock here; it's OK, though. */
2574 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002575 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002576 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2577 hlist_bl_unlock(b);
2578 return new;
Al Virod9171b92016-04-15 03:33:13 -04002579mismatch:
2580 spin_unlock(&dentry->d_lock);
2581 dput(dentry);
2582 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002583}
2584EXPORT_SYMBOL(d_alloc_parallel);
2585
Al Viro85c7f812016-04-14 19:52:13 -04002586void __d_lookup_done(struct dentry *dentry)
2587{
Al Viro94bdd652016-04-15 02:42:04 -04002588 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2589 dentry->d_name.hash);
2590 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002591 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002592 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002593 wake_up_all(dentry->d_wait);
2594 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002595 hlist_bl_unlock(b);
2596 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002597 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002598}
2599EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002600
2601/* inode->i_lock held if inode is non-NULL */
2602
2603static inline void __d_add(struct dentry *dentry, struct inode *inode)
2604{
Al Viro84e710d2016-04-15 00:58:55 -04002605 struct inode *dir = NULL;
2606 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002607 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002608 if (unlikely(d_in_lookup(dentry))) {
2609 dir = dentry->d_parent->d_inode;
2610 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002611 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002612 }
Al Viroed782b52016-03-09 19:52:39 -05002613 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002614 unsigned add_flags = d_flags_for_inode(inode);
2615 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2616 raw_write_seqcount_begin(&dentry->d_seq);
2617 __d_set_inode_and_type(dentry, inode, add_flags);
2618 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002619 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002620 }
Al Viro15d3c582016-07-29 17:45:21 -04002621 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002622 if (dir)
2623 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002624 spin_unlock(&dentry->d_lock);
2625 if (inode)
2626 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002627}
2628
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002629/**
Al Viro34d0d192016-03-08 21:01:03 -05002630 * d_add - add dentry to hash queues
2631 * @entry: dentry to add
2632 * @inode: The inode to attach to this dentry
2633 *
2634 * This adds the entry to the hash queues and initializes @inode.
2635 * The entry was actually filled in earlier during d_alloc().
2636 */
2637
2638void d_add(struct dentry *entry, struct inode *inode)
2639{
Al Virob9680912016-04-11 00:53:26 -04002640 if (inode) {
2641 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002642 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002643 }
Al Viroed782b52016-03-09 19:52:39 -05002644 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002645}
2646EXPORT_SYMBOL(d_add);
2647
2648/**
Al Viro668d0cd2016-03-08 12:44:17 -05002649 * d_exact_alias - find and hash an exact unhashed alias
2650 * @entry: dentry to add
2651 * @inode: The inode to go with this dentry
2652 *
2653 * If an unhashed dentry with the same name/parent and desired
2654 * inode already exists, hash and return it. Otherwise, return
2655 * NULL.
2656 *
2657 * Parent directory should be locked.
2658 */
2659struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2660{
2661 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002662 unsigned int hash = entry->d_name.hash;
2663
2664 spin_lock(&inode->i_lock);
2665 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2666 /*
2667 * Don't need alias->d_lock here, because aliases with
2668 * d_parent == entry->d_parent are not subject to name or
2669 * parent changes, because the parent inode i_mutex is held.
2670 */
2671 if (alias->d_name.hash != hash)
2672 continue;
2673 if (alias->d_parent != entry->d_parent)
2674 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002675 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002676 continue;
2677 spin_lock(&alias->d_lock);
2678 if (!d_unhashed(alias)) {
2679 spin_unlock(&alias->d_lock);
2680 alias = NULL;
2681 } else {
2682 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002683 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002684 spin_unlock(&alias->d_lock);
2685 }
2686 spin_unlock(&inode->i_lock);
2687 return alias;
2688 }
2689 spin_unlock(&inode->i_lock);
2690 return NULL;
2691}
2692EXPORT_SYMBOL(d_exact_alias);
2693
2694/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002695 * dentry_update_name_case - update case insensitive dentry with a new name
2696 * @dentry: dentry to be updated
2697 * @name: new name
2698 *
2699 * Update a case insensitive dentry with new case of name.
2700 *
2701 * dentry must have been returned by d_lookup with name @name. Old and new
2702 * name lengths must match (ie. no d_compare which allows mismatched name
2703 * lengths).
2704 *
2705 * Parent inode i_mutex must be held over d_lookup and into this call (to
2706 * keep renames and concurrent inserts, and readdir(2) away).
2707 */
Al Viro9aba36d2016-07-20 22:28:45 -04002708void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002709{
Al Viro59551022016-01-22 15:40:57 -05002710 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002711 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2712
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002713 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002714 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002715 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002716 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002717 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002718}
2719EXPORT_SYMBOL(dentry_update_name_case);
2720
Al Viro8d85b482014-09-29 14:54:27 -04002721static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722{
Al Viro8d85b482014-09-29 14:54:27 -04002723 if (unlikely(dname_external(target))) {
2724 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 /*
2726 * Both external: swap the pointers
2727 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002728 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 } else {
2730 /*
2731 * dentry:internal, target:external. Steal target's
2732 * storage and make target internal.
2733 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002734 memcpy(target->d_iname, dentry->d_name.name,
2735 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 dentry->d_name.name = target->d_name.name;
2737 target->d_name.name = target->d_iname;
2738 }
2739 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002740 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741 /*
2742 * dentry:external, target:internal. Give dentry's
2743 * storage to target and make dentry internal
2744 */
2745 memcpy(dentry->d_iname, target->d_name.name,
2746 target->d_name.len + 1);
2747 target->d_name.name = dentry->d_name.name;
2748 dentry->d_name.name = dentry->d_iname;
2749 } else {
2750 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002751 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002753 unsigned int i;
2754 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2755 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2756 swap(((long *) &dentry->d_iname)[i],
2757 ((long *) &target->d_iname)[i]);
2758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 }
2760 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002761 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
2763
Al Viro8d85b482014-09-29 14:54:27 -04002764static void copy_name(struct dentry *dentry, struct dentry *target)
2765{
2766 struct external_name *old_name = NULL;
2767 if (unlikely(dname_external(dentry)))
2768 old_name = external_name(dentry);
2769 if (unlikely(dname_external(target))) {
2770 atomic_inc(&external_name(target)->u.count);
2771 dentry->d_name = target->d_name;
2772 } else {
2773 memcpy(dentry->d_iname, target->d_name.name,
2774 target->d_name.len + 1);
2775 dentry->d_name.name = dentry->d_iname;
2776 dentry->d_name.hash_len = target->d_name.hash_len;
2777 }
2778 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2779 kfree_rcu(old_name, u.head);
2780}
2781
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002782static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2783{
2784 /*
2785 * XXXX: do we really need to take target->d_lock?
2786 */
2787 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2788 spin_lock(&target->d_parent->d_lock);
2789 else {
2790 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2791 spin_lock(&dentry->d_parent->d_lock);
2792 spin_lock_nested(&target->d_parent->d_lock,
2793 DENTRY_D_LOCK_NESTED);
2794 } else {
2795 spin_lock(&target->d_parent->d_lock);
2796 spin_lock_nested(&dentry->d_parent->d_lock,
2797 DENTRY_D_LOCK_NESTED);
2798 }
2799 }
2800 if (target < dentry) {
2801 spin_lock_nested(&target->d_lock, 2);
2802 spin_lock_nested(&dentry->d_lock, 3);
2803 } else {
2804 spin_lock_nested(&dentry->d_lock, 2);
2805 spin_lock_nested(&target->d_lock, 3);
2806 }
2807}
2808
Al Viro986c01942014-09-26 23:11:15 -04002809static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002810{
2811 if (target->d_parent != dentry->d_parent)
2812 spin_unlock(&dentry->d_parent->d_lock);
2813 if (target->d_parent != target)
2814 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002815 spin_unlock(&target->d_lock);
2816 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002817}
2818
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002820 * When switching names, the actual string doesn't strictly have to
2821 * be preserved in the target - because we're dropping the target
2822 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002823 * the new name before we switch, unless we are going to rehash
2824 * it. Note that if we *do* unhash the target, we are not allowed
2825 * to rehash it without giving it a new name/hash key - whether
2826 * we swap or overwrite the names here, resulting name won't match
2827 * the reality in filesystem; it's only there for d_path() purposes.
2828 * Note that all of this is happening under rename_lock, so the
2829 * any hash lookup seeing it in the middle of manipulations will
2830 * be discarded anyway. So we do not care what happens to the hash
2831 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002833/*
Al Viro18367502011-07-12 21:42:24 -04002834 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835 * @dentry: entry to move
2836 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002837 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838 *
2839 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002840 * dcache entries should not be moved in this way. Caller must hold
2841 * rename_lock, the i_mutex of the source and target directories,
2842 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002844static void __d_move(struct dentry *dentry, struct dentry *target,
2845 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846{
Al Viro84e710d2016-04-15 00:58:55 -04002847 struct inode *dir = NULL;
2848 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849 if (!dentry->d_inode)
2850 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2851
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002852 BUG_ON(d_ancestor(dentry, target));
2853 BUG_ON(d_ancestor(target, dentry));
2854
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002855 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002856 if (unlikely(d_in_lookup(target))) {
2857 dir = target->d_parent->d_inode;
2858 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002859 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861
Nick Piggin31e6b012011-01-07 17:49:52 +11002862 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002863 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002864
Al Viro15d3c582016-07-29 17:45:21 -04002865 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002866 if (!d_unhashed(dentry))
2867 ___d_drop(dentry);
2868 if (!d_unhashed(target))
2869 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002872 if (exchange)
2873 swap_names(dentry, target);
2874 else
2875 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876
Al Viro15d3c582016-07-29 17:45:21 -04002877 /* rehash in new place(s) */
2878 __d_rehash(dentry);
2879 if (exchange)
2880 __d_rehash(target);
NeilBrown61647822017-11-10 15:45:41 +11002881 else
2882 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002883
Al Viro63cf4272014-09-26 23:06:14 -04002884 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002886 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002887 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888 dentry->d_parent = target->d_parent;
2889 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002890 list_del_init(&target->d_child);
2891 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002893 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002894 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002895 list_move(&target->d_child, &target->d_parent->d_subdirs);
2896 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002897 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002898 fsnotify_update_flags(target);
2899 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 }
2901
Nick Piggin31e6b012011-01-07 17:49:52 +11002902 write_seqcount_end(&target->d_seq);
2903 write_seqcount_end(&dentry->d_seq);
2904
Al Viro84e710d2016-04-15 00:58:55 -04002905 if (dir)
2906 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002907 dentry_unlock_for_move(dentry, target);
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)) {
3055 int err = __d_unalias(inode, dentry, new);
3056 write_sequnlock(&rename_lock);
3057 if (err) {
3058 dput(new);
3059 new = ERR_PTR(err);
3060 }
Al Viro18367502011-07-12 21:42:24 -04003061 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003062 __d_move(new, dentry, false);
3063 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003064 }
Al Virob5ae6b12014-10-12 22:16:02 -04003065 iput(inode);
3066 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003067 }
David Howells770bfad2006-08-22 20:06:07 -04003068 }
Al Virob5ae6b12014-10-12 22:16:02 -04003069out:
Al Viroed782b52016-03-09 19:52:39 -05003070 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003071 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003072}
Al Virob5ae6b12014-10-12 22:16:02 -04003073EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003074
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003075static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003076{
3077 *buflen -= namelen;
3078 if (*buflen < 0)
3079 return -ENAMETOOLONG;
3080 *buffer -= namelen;
3081 memcpy(*buffer, str, namelen);
3082 return 0;
3083}
3084
Waiman Long232d2d62013-09-09 12:18:13 -04003085/**
3086 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003087 * @buffer: buffer pointer
3088 * @buflen: allocated length of the buffer
3089 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003090 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003091 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003092 * make sure that either the old or the new name pointer and length are
3093 * fetched. However, there may be mismatch between length and pointer.
3094 * The length cannot be trusted, we need to copy it byte-by-byte until
3095 * the length is reached or a null byte is found. It also prepends "/" at
3096 * the beginning of the name. The sequence number check at the caller will
3097 * retry it again when a d_move() does happen. So any garbage in the buffer
3098 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003099 *
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003100 * Load acquire is needed to make sure that we see that terminating NUL.
Waiman Long232d2d62013-09-09 12:18:13 -04003101 */
Al Viro9aba36d2016-07-20 22:28:45 -04003102static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003103{
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003104 const char *dname = smp_load_acquire(&name->name); /* ^^^ */
Mark Rutland66702eb2017-10-23 14:07:14 -07003105 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003106 char *p;
3107
Waiman Long232d2d62013-09-09 12:18:13 -04003108 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003109 if (*buflen < 0)
3110 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003111 p = *buffer -= dlen + 1;
3112 *p++ = '/';
3113 while (dlen--) {
3114 char c = *dname++;
3115 if (!c)
3116 break;
3117 *p++ = c;
3118 }
3119 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003120}
3121
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003123 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003124 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003125 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003126 * @buffer: pointer to the end of the buffer
3127 * @buflen: pointer to buffer length
3128 *
Waiman Long18129972013-09-12 10:55:35 -04003129 * The function will first try to write out the pathname without taking any
3130 * lock other than the RCU read lock to make sure that dentries won't go away.
3131 * It only checks the sequence number of the global rename_lock as any change
3132 * in the dentry's d_seq will be preceded by changes in the rename_lock
3133 * sequence number. If the sequence number had been changed, it will restart
3134 * the whole pathname back-tracing sequence again by taking the rename_lock.
3135 * In this case, there is no need to take the RCU read lock as the recursive
3136 * parent pointer references will keep the dentry chain alive as long as no
3137 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003138 */
Al Viro02125a82011-12-05 08:43:34 -05003139static int prepend_path(const struct path *path,
3140 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003141 char **buffer, int *buflen)
3142{
Al Viroede4ceb2013-11-13 07:45:40 -05003143 struct dentry *dentry;
3144 struct vfsmount *vfsmnt;
3145 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003146 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003147 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003148 char *bptr;
3149 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003150
Al Viro48f5ec22013-09-09 15:22:25 -04003151 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003152restart_mnt:
3153 read_seqbegin_or_lock(&mount_lock, &m_seq);
3154 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003155 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003156restart:
3157 bptr = *buffer;
3158 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003159 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003160 dentry = path->dentry;
3161 vfsmnt = path->mnt;
3162 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003163 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003164 while (dentry != root->dentry || vfsmnt != root->mnt) {
3165 struct dentry * parent;
3166
3167 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003168 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003169 /* Escaped? */
3170 if (dentry != vfsmnt->mnt_root) {
3171 bptr = *buffer;
3172 blen = *buflen;
3173 error = 3;
3174 break;
3175 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003176 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003177 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003178 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003179 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003180 vfsmnt = &mnt->mnt;
3181 continue;
3182 }
Waiman Long232d2d62013-09-09 12:18:13 -04003183 if (!error)
3184 error = is_mounted(vfsmnt) ? 1 : 2;
3185 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003186 }
3187 parent = dentry->d_parent;
3188 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003189 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003190 if (error)
3191 break;
3192
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003193 dentry = parent;
3194 }
Al Viro48f5ec22013-09-09 15:22:25 -04003195 if (!(seq & 1))
3196 rcu_read_unlock();
3197 if (need_seqretry(&rename_lock, seq)) {
3198 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003199 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003200 }
Al Viro48f5ec22013-09-09 15:22:25 -04003201 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003202
3203 if (!(m_seq & 1))
3204 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003205 if (need_seqretry(&mount_lock, m_seq)) {
3206 m_seq = 1;
3207 goto restart_mnt;
3208 }
3209 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003210
Waiman Long232d2d62013-09-09 12:18:13 -04003211 if (error >= 0 && bptr == *buffer) {
3212 if (--blen < 0)
3213 error = -ENAMETOOLONG;
3214 else
3215 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003216 }
Waiman Long232d2d62013-09-09 12:18:13 -04003217 *buffer = bptr;
3218 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003219 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003220}
3221
3222/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003223 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003224 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003225 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003226 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003227 * @buflen: buffer length
3228 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003229 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003231 * Returns a pointer into the buffer or an error code if the
3232 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003233 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003234 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003235 *
Al Viro02125a82011-12-05 08:43:34 -05003236 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237 */
Al Viro02125a82011-12-05 08:43:34 -05003238char *__d_path(const struct path *path,
3239 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003240 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003242 char *res = buf + buflen;
3243 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003245 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003246 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003247
Al Viro02125a82011-12-05 08:43:34 -05003248 if (error < 0)
3249 return ERR_PTR(error);
3250 if (error > 0)
3251 return NULL;
3252 return res;
3253}
3254
3255char *d_absolute_path(const struct path *path,
3256 char *buf, int buflen)
3257{
3258 struct path root = {};
3259 char *res = buf + buflen;
3260 int error;
3261
3262 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003263 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003264
3265 if (error > 1)
3266 error = -EINVAL;
3267 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003268 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003269 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270}
3271
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003272/*
3273 * same as __d_path but appends "(deleted)" for unlinked files.
3274 */
Al Viro02125a82011-12-05 08:43:34 -05003275static int path_with_deleted(const struct path *path,
3276 const struct path *root,
3277 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003278{
3279 prepend(buf, buflen, "\0", 1);
3280 if (d_unlinked(path->dentry)) {
3281 int error = prepend(buf, buflen, " (deleted)", 10);
3282 if (error)
3283 return error;
3284 }
3285
3286 return prepend_path(path, root, buf, buflen);
3287}
3288
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003289static int prepend_unreachable(char **buffer, int *buflen)
3290{
3291 return prepend(buffer, buflen, "(unreachable)", 13);
3292}
3293
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003294static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3295{
3296 unsigned seq;
3297
3298 do {
3299 seq = read_seqcount_begin(&fs->seq);
3300 *root = fs->root;
3301 } while (read_seqcount_retry(&fs->seq, seq));
3302}
3303
Jan Bluncka03a8a702008-02-14 19:38:32 -08003304/**
3305 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003306 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003307 * @buf: buffer to return value in
3308 * @buflen: buffer length
3309 *
3310 * Convert a dentry into an ASCII path name. If the entry has been deleted
3311 * the string " (deleted)" is appended. Note that this is ambiguous.
3312 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003313 * Returns a pointer into the buffer or an error code if the path was
3314 * too long. Note: Callers should use the returned pointer, not the passed
3315 * in buffer, to use the name! The implementation often starts at an offset
3316 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003317 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003318 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003319 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003320char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003322 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003323 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003324 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003326 /*
3327 * We have various synthetic filesystems that never get mounted. On
3328 * these filesystems dentries are never used for lookup purposes, and
3329 * thus don't need to be hashed. They also don't need a name until a
3330 * user wants to identify the object in /proc/pid/fd/. The little hack
3331 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003332 *
3333 * Some pseudo inodes are mountable. When they are mounted
3334 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3335 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003336 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003337 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3338 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003339 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003340
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003341 rcu_read_lock();
3342 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003343 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003344 rcu_read_unlock();
3345
Al Viro02125a82011-12-05 08:43:34 -05003346 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003347 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348 return res;
3349}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003350EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351
3352/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003353 * Helper function for dentry_operations.d_dname() members
3354 */
3355char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3356 const char *fmt, ...)
3357{
3358 va_list args;
3359 char temp[64];
3360 int sz;
3361
3362 va_start(args, fmt);
3363 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3364 va_end(args);
3365
3366 if (sz > sizeof(temp) || sz > buflen)
3367 return ERR_PTR(-ENAMETOOLONG);
3368
3369 buffer += buflen - sz;
3370 return memcpy(buffer, temp, sz);
3371}
3372
Al Viro118b2302013-08-24 12:08:17 -04003373char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3374{
3375 char *end = buffer + buflen;
3376 /* these dentries are never renamed, so d_lock is not needed */
3377 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003378 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003379 prepend(&end, &buflen, "/", 1))
3380 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003381 return end;
Al Viro118b2302013-08-24 12:08:17 -04003382}
David Herrmann31bbe162014-01-03 14:09:47 +01003383EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003384
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003385/*
Ram Pai6092d042008-03-27 13:06:20 +01003386 * Write full pathname from the root of the filesystem into the buffer.
3387 */
Al Virof6500802014-01-26 12:37:55 -05003388static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003389{
Al Virof6500802014-01-26 12:37:55 -05003390 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003391 char *end, *retval;
3392 int len, seq = 0;
3393 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003394
Al Virof6500802014-01-26 12:37:55 -05003395 if (buflen < 2)
3396 goto Elong;
3397
Al Viro48f5ec22013-09-09 15:22:25 -04003398 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003399restart:
Al Virof6500802014-01-26 12:37:55 -05003400 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003401 end = buf + buflen;
3402 len = buflen;
3403 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003404 /* Get '/' right */
3405 retval = end-1;
3406 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003407 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003408 while (!IS_ROOT(dentry)) {
3409 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003410
Ram Pai6092d042008-03-27 13:06:20 +01003411 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003412 error = prepend_name(&end, &len, &dentry->d_name);
3413 if (error)
3414 break;
Ram Pai6092d042008-03-27 13:06:20 +01003415
3416 retval = end;
3417 dentry = parent;
3418 }
Al Viro48f5ec22013-09-09 15:22:25 -04003419 if (!(seq & 1))
3420 rcu_read_unlock();
3421 if (need_seqretry(&rename_lock, seq)) {
3422 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003423 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003424 }
3425 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003426 if (error)
3427 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003428 return retval;
3429Elong:
3430 return ERR_PTR(-ENAMETOOLONG);
3431}
Nick Pigginec2447c2011-01-07 17:49:29 +11003432
3433char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3434{
Waiman Long232d2d62013-09-09 12:18:13 -04003435 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003436}
3437EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003438
3439char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3440{
3441 char *p = NULL;
3442 char *retval;
3443
Al Viroc1031352010-06-06 22:31:14 -04003444 if (d_unlinked(dentry)) {
3445 p = buf + buflen;
3446 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3447 goto Elong;
3448 buflen++;
3449 }
3450 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003451 if (!IS_ERR(retval) && p)
3452 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003453 return retval;
3454Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003455 return ERR_PTR(-ENAMETOOLONG);
3456}
3457
Linus Torvalds8b19e342013-09-12 10:35:47 -07003458static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3459 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003460{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003461 unsigned seq;
3462
3463 do {
3464 seq = read_seqcount_begin(&fs->seq);
3465 *root = fs->root;
3466 *pwd = fs->pwd;
3467 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003468}
3469
Ram Pai6092d042008-03-27 13:06:20 +01003470/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471 * NOTE! The user-level library version returns a
3472 * character pointer. The kernel system call just
3473 * returns the length of the buffer filled (which
3474 * includes the ending '\0' character), or a negative
3475 * error value. So libc would do something like
3476 *
3477 * char *getcwd(char * buf, size_t size)
3478 * {
3479 * int retval;
3480 *
3481 * retval = sys_getcwd(buf, size);
3482 * if (retval >= 0)
3483 * return buf;
3484 * errno = -retval;
3485 * return NULL;
3486 * }
3487 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003488SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489{
Linus Torvalds552ce542007-02-13 12:08:18 -08003490 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003491 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003492 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493
3494 if (!page)
3495 return -ENOMEM;
3496
Linus Torvalds8b19e342013-09-12 10:35:47 -07003497 rcu_read_lock();
3498 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499
Linus Torvalds552ce542007-02-13 12:08:18 -08003500 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003501 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003502 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003503 char *cwd = page + PATH_MAX;
3504 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003506 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003507 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003508 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003509
Al Viro02125a82011-12-05 08:43:34 -05003510 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003511 goto out;
3512
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003513 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003514 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003515 error = prepend_unreachable(&cwd, &buflen);
3516 if (error)
3517 goto out;
3518 }
3519
Linus Torvalds552ce542007-02-13 12:08:18 -08003520 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003521 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003522 if (len <= size) {
3523 error = len;
3524 if (copy_to_user(buf, cwd, len))
3525 error = -EFAULT;
3526 }
Nick Piggin949854d2011-01-07 17:49:37 +11003527 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003528 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530
3531out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003532 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003533 return error;
3534}
3535
3536/*
3537 * Test whether new_dentry is a subdirectory of old_dentry.
3538 *
3539 * Trivially implemented using the dcache structure
3540 */
3541
3542/**
3543 * is_subdir - is new dentry a subdirectory of old_dentry
3544 * @new_dentry: new dentry
3545 * @old_dentry: old dentry
3546 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003547 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3548 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3550 */
3551
Yaowei Baia6e57872015-11-17 14:40:11 +08003552bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553{
Yaowei Baia6e57872015-11-17 14:40:11 +08003554 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003555 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003556
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003557 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003558 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003559
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003560 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003563 /*
3564 * Need rcu_readlock to protect against the d_parent trashing
3565 * due to d_move
3566 */
3567 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003568 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003569 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003570 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003571 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003572 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574
3575 return result;
3576}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003577EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003579static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003581 struct dentry *root = data;
3582 if (dentry != root) {
3583 if (d_unhashed(dentry) || !dentry->d_inode)
3584 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003586 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3587 dentry->d_flags |= DCACHE_GENOCIDE;
3588 dentry->d_lockref.count--;
3589 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003591 return D_WALK_CONTINUE;
3592}
Nick Piggin58db63d2011-01-07 17:49:39 +11003593
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003594void d_genocide(struct dentry *parent)
3595{
3596 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597}
3598
Al Viro60545d02013-06-07 01:20:27 -04003599void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600{
Al Viro60545d02013-06-07 01:20:27 -04003601 inode_dec_link_count(inode);
3602 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003603 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003604 !d_unlinked(dentry));
3605 spin_lock(&dentry->d_parent->d_lock);
3606 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3607 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3608 (unsigned long long)inode->i_ino);
3609 spin_unlock(&dentry->d_lock);
3610 spin_unlock(&dentry->d_parent->d_lock);
3611 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612}
Al Viro60545d02013-06-07 01:20:27 -04003613EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614
3615static __initdata unsigned long dhash_entries;
3616static int __init set_dhash_entries(char *str)
3617{
3618 if (!str)
3619 return 0;
3620 dhash_entries = simple_strtoul(str, &str, 0);
3621 return 1;
3622}
3623__setup("dhash_entries=", set_dhash_entries);
3624
3625static void __init dcache_init_early(void)
3626{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627 /* If hashes are distributed across NUMA nodes, defer
3628 * hash allocation until vmalloc space is available.
3629 */
3630 if (hashdist)
3631 return;
3632
3633 dentry_hashtable =
3634 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003635 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636 dhash_entries,
3637 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003638 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003640 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003641 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003643 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003644}
3645
Denis Cheng74bf17c2007-10-16 23:26:30 -07003646static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003647{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003648 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003649 * A constructor could be added for stable state like the lists,
3650 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003651 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003652 */
David Windsor80344262017-06-10 22:50:44 -04003653 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3654 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3655 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003656
3657 /* Hash may have been set up in dcache_init_early */
3658 if (!hashdist)
3659 return;
3660
3661 dentry_hashtable =
3662 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003663 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003664 dhash_entries,
3665 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003666 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003667 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003668 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003669 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003670 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003671 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003672}
3673
3674/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003675struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003676EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003677
Linus Torvalds1da177e2005-04-16 15:20:36 -07003678EXPORT_SYMBOL(d_genocide);
3679
Linus Torvalds1da177e2005-04-16 15:20:36 -07003680void __init vfs_caches_init_early(void)
3681{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003682 int i;
3683
3684 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3685 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3686
Linus Torvalds1da177e2005-04-16 15:20:36 -07003687 dcache_init_early();
3688 inode_init_early();
3689}
3690
Mel Gorman4248b0d2015-08-06 15:46:20 -07003691void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003692{
David Windsor6a9b8822017-06-10 22:50:30 -04003693 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3694 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003695
Denis Cheng74bf17c2007-10-16 23:26:30 -07003696 dcache_init();
3697 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003698 files_init();
3699 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003700 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003701 bdev_cache_init();
3702 chrdev_init();
3703}