blob: f2d94568802513be38290abc52c5aa29f604a9af [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>
28#include <linux/file.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110035#include <linux/bit_spinlock.h>
36#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070037#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010038#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100039#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020040#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050041#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Nick Piggin789680d2011-01-07 17:49:30 +110043/*
44 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110045 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040046 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110047 * dcache_hash_bucket lock protects:
48 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110049 * s_roots bl list spinlock protects:
50 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100051 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110052 * - the dcache lru lists and counters
53 * d_lock protects:
54 * - d_flags
55 * - d_name
56 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110057 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110058 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110059 * - d_parent and d_subdirs
60 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040061 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110062 *
63 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110064 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110065 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100066 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110067 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110068 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110069 *
Nick Pigginda502952011-01-07 17:49:33 +110070 * If there is an ancestor relationship:
71 * dentry->d_parent->...->d_parent->d_lock
72 * ...
73 * dentry->d_parent->d_lock
74 * dentry->d_lock
75 *
76 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110077 * if (dentry1 < dentry2)
78 * dentry1->d_lock
79 * dentry2->d_lock
80 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080081int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
83
Al Viro74c3cbe2007-07-22 08:04:18 -040084__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Nick Piggin949854d2011-01-07 17:49:37 +110086EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Christoph Lametere18b8902006-12-06 20:33:20 -080088static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
David Howellscdf01222017-07-04 17:25:22 +010090const struct qstr empty_name = QSTR_INIT("", 0);
91EXPORT_SYMBOL(empty_name);
92const struct qstr slash_name = QSTR_INIT("/", 1);
93EXPORT_SYMBOL(slash_name);
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095/*
96 * This is the single most critical data structure when it comes
97 * to the dcache: the hashtable for lookups. Somebody should try
98 * to make this good - I've just made it work.
99 *
100 * This hash-function tries to avoid losing too many bits of hash
101 * information, yet avoid using a prime hash-size or similar.
102 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800104static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100105
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700106static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107
Linus Torvalds8387ff22016-06-10 07:51:30 -0700108static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300110 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111}
112
Al Viro94bdd652016-04-15 02:42:04 -0400113#define IN_LOOKUP_SHIFT 10
114static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
115
116static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
117 unsigned int hash)
118{
119 hash += (unsigned long) parent / L1_CACHE_BYTES;
120 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
121}
122
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124/* Statistics gathering. */
125struct dentry_stat_t dentry_stat = {
126 .age_limit = 45,
127};
128
Glauber Costa3942c072013-08-28 10:17:53 +1000129static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000130static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400131
132#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000133
134/*
135 * Here we resort to our own counters instead of using generic per-cpu counters
136 * for consistency with what the vfs inode code does. We are expected to harvest
137 * better code and performance by having our own specialized counters.
138 *
139 * Please note that the loop is done over all possible CPUs, not over all online
140 * CPUs. The reason for this is that we don't want to play games with CPUs going
141 * on and off. If one of them goes off, we will just keep their counters.
142 *
143 * glommer: See cffbc8a for details, and if you ever intend to change this,
144 * please update all vfs counters to match.
145 */
Glauber Costa3942c072013-08-28 10:17:53 +1000146static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100147{
148 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000149 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100150 for_each_possible_cpu(i)
151 sum += per_cpu(nr_dentry, i);
152 return sum < 0 ? 0 : sum;
153}
154
Dave Chinner62d36c72013-08-28 10:17:54 +1000155static long get_nr_dentry_unused(void)
156{
157 int i;
158 long sum = 0;
159 for_each_possible_cpu(i)
160 sum += per_cpu(nr_dentry_unused, i);
161 return sum < 0 ? 0 : sum;
162}
163
Joe Perches1f7e0612014-06-06 14:38:05 -0700164int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400165 size_t *lenp, loff_t *ppos)
166{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100167 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000168 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000169 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400170}
171#endif
172
Linus Torvalds5483f182012-03-04 15:51:42 -0800173/*
174 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
175 * The strings are both count bytes long, and count is non-zero.
176 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700177#ifdef CONFIG_DCACHE_WORD_ACCESS
178
179#include <asm/word-at-a-time.h>
180/*
181 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
182 * aligned allocation for this particular component. We don't
183 * strictly need the load_unaligned_zeropad() safety, but it
184 * doesn't hurt either.
185 *
186 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
187 * need the careful unaligned handling.
188 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700189static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800190{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800192
193 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300194 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700195 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 if (tcount < sizeof(unsigned long))
197 break;
198 if (unlikely(a != b))
199 return 1;
200 cs += sizeof(unsigned long);
201 ct += sizeof(unsigned long);
202 tcount -= sizeof(unsigned long);
203 if (!tcount)
204 return 0;
205 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000206 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800207 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700208}
209
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800210#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700211
Linus Torvalds94753db52012-05-10 12:19:19 -0700212static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213{
Linus Torvalds5483f182012-03-04 15:51:42 -0800214 do {
215 if (*cs != *ct)
216 return 1;
217 cs++;
218 ct++;
219 tcount--;
220 } while (tcount);
221 return 0;
222}
223
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700224#endif
225
Linus Torvalds94753db52012-05-10 12:19:19 -0700226static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
227{
Linus Torvalds94753db52012-05-10 12:19:19 -0700228 /*
229 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100230 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700231 *
232 * NOTE! Even if a rename will mean that the length
233 * was not loaded atomically, we don't care. The
234 * RCU walk will check the sequence count eventually,
235 * and catch it. And we won't overrun the buffer,
236 * because we're reading the name pointer atomically,
237 * and a dentry name is guaranteed to be properly
238 * terminated with a NUL byte.
239 *
240 * End result: even if 'len' is wrong, we'll exit
241 * early because the data cannot match (there can
242 * be no NUL in the ct/tcount data)
243 */
Will Deacon506458e2017-10-24 11:22:48 +0100244 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000245
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700246 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700247}
248
Al Viro8d85b482014-09-29 14:54:27 -0400249struct external_name {
250 union {
251 atomic_t count;
252 struct rcu_head head;
253 } u;
254 unsigned char name[];
255};
256
257static inline struct external_name *external_name(struct dentry *dentry)
258{
259 return container_of(dentry->d_name.name, struct external_name, name[0]);
260}
261
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400262static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
265
Al Viro8d85b482014-09-29 14:54:27 -0400266 kmem_cache_free(dentry_cache, dentry);
267}
268
269static void __d_free_external(struct rcu_head *head)
270{
271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400272 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 kmem_cache_free(dentry_cache, dentry);
274}
275
Al Viro810bb172014-10-12 12:45:37 -0400276static inline int dname_external(const struct dentry *dentry)
277{
278 return dentry->d_name.name != dentry->d_iname;
279}
280
Al Viro49d31c22017-07-07 14:51:19 -0400281void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
282{
283 spin_lock(&dentry->d_lock);
284 if (unlikely(dname_external(dentry))) {
285 struct external_name *p = external_name(dentry);
286 atomic_inc(&p->u.count);
287 spin_unlock(&dentry->d_lock);
288 name->name = p->name;
289 } else {
290 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
291 spin_unlock(&dentry->d_lock);
292 name->name = name->inline_name;
293 }
294}
295EXPORT_SYMBOL(take_dentry_name_snapshot);
296
297void release_dentry_name_snapshot(struct name_snapshot *name)
298{
299 if (unlikely(name->name != name->inline_name)) {
300 struct external_name *p;
301 p = container_of(name->name, struct external_name, name[0]);
302 if (unlikely(atomic_dec_and_test(&p->u.count)))
303 kfree_rcu(p, u.head);
304 }
305}
306EXPORT_SYMBOL(release_dentry_name_snapshot);
307
David Howells4bf46a22015-03-05 14:09:22 +0000308static inline void __d_set_inode_and_type(struct dentry *dentry,
309 struct inode *inode,
310 unsigned type_flags)
311{
312 unsigned flags;
313
314 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000315 flags = READ_ONCE(dentry->d_flags);
316 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
317 flags |= type_flags;
318 WRITE_ONCE(dentry->d_flags, flags);
319}
320
David Howells4bf46a22015-03-05 14:09:22 +0000321static inline void __d_clear_type_and_inode(struct dentry *dentry)
322{
323 unsigned flags = READ_ONCE(dentry->d_flags);
324
325 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
326 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000327 dentry->d_inode = NULL;
328}
329
Al Virob4f03542014-04-29 23:40:14 -0400330static void dentry_free(struct dentry *dentry)
331{
Al Viro946e51f2014-10-26 19:19:16 -0400332 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400333 if (unlikely(dname_external(dentry))) {
334 struct external_name *p = external_name(dentry);
335 if (likely(atomic_dec_and_test(&p->u.count))) {
336 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
337 return;
338 }
339 }
Al Virob4f03542014-04-29 23:40:14 -0400340 /* if dentry was never visible to RCU, immediate free is OK */
341 if (!(dentry->d_flags & DCACHE_RCUACCESS))
342 __d_free(&dentry->d_u.d_rcu);
343 else
344 call_rcu(&dentry->d_u.d_rcu, __d_free);
345}
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347/*
348 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400349 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100350 */
351static void dentry_unlink_inode(struct dentry * dentry)
352 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100353 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100354{
355 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400356 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500357
Al Viro550dce02016-05-29 20:13:30 -0400358 if (hashed)
359 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000360 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400361 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400362 if (hashed)
363 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100364 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100365 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100366 if (!inode->i_nlink)
367 fsnotify_inoderemove(inode);
368 if (dentry->d_op && dentry->d_op->d_iput)
369 dentry->d_op->d_iput(dentry, inode);
370 else
371 iput(inode);
372}
373
374/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400375 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
376 * is in use - which includes both the "real" per-superblock
377 * LRU list _and_ the DCACHE_SHRINK_LIST use.
378 *
379 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
380 * on the shrink list (ie not on the superblock LRU list).
381 *
382 * The per-cpu "nr_dentry_unused" counters are updated with
383 * the DCACHE_LRU_LIST bit.
384 *
385 * These helper functions make sure we always follow the
386 * rules. d_lock must be held by the caller.
387 */
388#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
389static void d_lru_add(struct dentry *dentry)
390{
391 D_FLAG_VERIFY(dentry, 0);
392 dentry->d_flags |= DCACHE_LRU_LIST;
393 this_cpu_inc(nr_dentry_unused);
394 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
395}
396
397static void d_lru_del(struct dentry *dentry)
398{
399 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
400 dentry->d_flags &= ~DCACHE_LRU_LIST;
401 this_cpu_dec(nr_dentry_unused);
402 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
403}
404
405static void d_shrink_del(struct dentry *dentry)
406{
407 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
408 list_del_init(&dentry->d_lru);
409 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
410 this_cpu_dec(nr_dentry_unused);
411}
412
413static void d_shrink_add(struct dentry *dentry, struct list_head *list)
414{
415 D_FLAG_VERIFY(dentry, 0);
416 list_add(&dentry->d_lru, list);
417 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
418 this_cpu_inc(nr_dentry_unused);
419}
420
421/*
422 * These can only be called under the global LRU lock, ie during the
423 * callback for freeing the LRU list. "isolate" removes it from the
424 * LRU lists entirely, while shrink_move moves it to the indicated
425 * private list.
426 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800427static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400428{
429 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
430 dentry->d_flags &= ~DCACHE_LRU_LIST;
431 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800432 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400433}
434
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800435static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
436 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400437{
438 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
439 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800440 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400441}
442
Miklos Szeredid52b9082007-05-08 00:23:46 -0700443/**
Nick Piggin789680d2011-01-07 17:49:30 +1100444 * d_drop - drop a dentry
445 * @dentry: dentry to drop
446 *
447 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
448 * be found through a VFS lookup any more. Note that this is different from
449 * deleting the dentry - d_delete will try to mark the dentry negative if
450 * possible, giving a successful _negative_ lookup, while d_drop will
451 * just make the cache lookup fail.
452 *
453 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
454 * reason (NFS timeouts or autofs deletes).
455 *
NeilBrown61647822017-11-10 15:45:41 +1100456 * __d_drop requires dentry->d_lock
457 * ___d_drop doesn't mark dentry as "unhashed"
458 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100459 */
NeilBrown61647822017-11-10 15:45:41 +1100460static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100461{
Al Viro0632a9a2018-03-07 00:49:10 -0500462 struct hlist_bl_head *b;
463 /*
464 * Hashed dentries are normally on the dentry hashtable,
465 * with the exception of those newly allocated by
466 * d_obtain_root, which are always IS_ROOT:
467 */
468 if (unlikely(IS_ROOT(dentry)))
469 b = &dentry->d_sb->s_roots;
470 else
471 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400472
Al Viro0632a9a2018-03-07 00:49:10 -0500473 hlist_bl_lock(b);
474 __hlist_bl_del(&dentry->d_hash);
475 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100476}
NeilBrown61647822017-11-10 15:45:41 +1100477
478void __d_drop(struct dentry *dentry)
479{
Al Viro0632a9a2018-03-07 00:49:10 -0500480 if (!d_unhashed(dentry)) {
481 ___d_drop(dentry);
482 dentry->d_hash.pprev = NULL;
483 write_seqcount_invalidate(&dentry->d_seq);
484 }
NeilBrown61647822017-11-10 15:45:41 +1100485}
Nick Piggin789680d2011-01-07 17:49:30 +1100486EXPORT_SYMBOL(__d_drop);
487
488void d_drop(struct dentry *dentry)
489{
Nick Piggin789680d2011-01-07 17:49:30 +1100490 spin_lock(&dentry->d_lock);
491 __d_drop(dentry);
492 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100493}
494EXPORT_SYMBOL(d_drop);
495
Al Viroba65dc52016-06-10 11:32:47 -0400496static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
497{
498 struct dentry *next;
499 /*
500 * Inform d_walk() and shrink_dentry_list() that we are no longer
501 * attached to the dentry tree
502 */
503 dentry->d_flags |= DCACHE_DENTRY_KILLED;
504 if (unlikely(list_empty(&dentry->d_child)))
505 return;
506 __list_del_entry(&dentry->d_child);
507 /*
508 * Cursors can move around the list of children. While we'd been
509 * a normal list member, it didn't matter - ->d_child.next would've
510 * been updated. However, from now on it won't be and for the
511 * things like d_walk() it might end up with a nasty surprise.
512 * Normally d_walk() doesn't care about cursors moving around -
513 * ->d_lock on parent prevents that and since a cursor has no children
514 * of its own, we get through it without ever unlocking the parent.
515 * There is one exception, though - if we ascend from a child that
516 * gets killed as soon as we unlock it, the next sibling is found
517 * using the value left in its ->d_child.next. And if _that_
518 * pointed to a cursor, and cursor got moved (e.g. by lseek())
519 * before d_walk() regains parent->d_lock, we'll end up skipping
520 * everything the cursor had been moved past.
521 *
522 * Solution: make sure that the pointer left behind in ->d_child.next
523 * points to something that won't be moving around. I.e. skip the
524 * cursors.
525 */
526 while (dentry->d_child.next != &parent->d_subdirs) {
527 next = list_entry(dentry->d_child.next, struct dentry, d_child);
528 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
529 break;
530 dentry->d_child.next = next->d_child.next;
531 }
532}
533
Al Viroe55fd012014-05-28 13:51:12 -0400534static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100535{
Al Viro41edf2782014-05-01 10:30:00 -0400536 struct dentry *parent = NULL;
537 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400538 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100539 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100540
Linus Torvalds0d984392013-09-08 13:46:52 -0700541 /*
542 * The dentry is now unrecoverably dead to the world.
543 */
544 lockref_mark_dead(&dentry->d_lockref);
545
Sage Weilf0023bc2011-10-28 10:02:42 -0700546 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700547 * inform the fs via d_prune that this dentry is about to be
548 * unhashed and destroyed.
549 */
Al Viro29266202014-05-30 11:39:02 -0400550 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800551 dentry->d_op->d_prune(dentry);
552
Al Viro01b60352014-04-29 23:42:52 -0400553 if (dentry->d_flags & DCACHE_LRU_LIST) {
554 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
555 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400556 }
Nick Piggin77812a12011-01-07 17:49:48 +1100557 /* if it was on the hash then remove it */
558 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400559 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400560 if (parent)
561 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400562 if (dentry->d_inode)
563 dentry_unlink_inode(dentry);
564 else
565 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400566 this_cpu_dec(nr_dentry);
567 if (dentry->d_op && dentry->d_op->d_release)
568 dentry->d_op->d_release(dentry);
569
Al Viro41edf2782014-05-01 10:30:00 -0400570 spin_lock(&dentry->d_lock);
571 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
572 dentry->d_flags |= DCACHE_MAY_FREE;
573 can_free = false;
574 }
575 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400576 if (likely(can_free))
577 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400578}
579
Al Viro8b987a42018-02-23 22:11:34 -0500580static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400581{
Al Viro8b987a42018-02-23 22:11:34 -0500582 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400583 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400584 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400585again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700586 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400587 spin_lock(&parent->d_lock);
588 /*
589 * We can't blindly lock dentry until we are sure
590 * that we won't violate the locking order.
591 * Any changes of dentry->d_parent must have
592 * been done with parent->d_lock held, so
593 * spin_lock() above is enough of a barrier
594 * for checking if it's still our child.
595 */
596 if (unlikely(parent != dentry->d_parent)) {
597 spin_unlock(&parent->d_lock);
598 goto again;
599 }
Al Viro3b821402018-02-23 20:47:17 -0500600 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500601 if (parent != dentry)
602 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
603 else
604 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400605 return parent;
606}
607
Al Viro8b987a42018-02-23 22:11:34 -0500608static inline struct dentry *lock_parent(struct dentry *dentry)
609{
610 struct dentry *parent = dentry->d_parent;
611 if (IS_ROOT(dentry))
612 return NULL;
613 if (likely(spin_trylock(&parent->d_lock)))
614 return parent;
615 return __lock_parent(dentry);
616}
617
Al Viroa3385792018-02-23 21:07:24 -0500618static inline bool retain_dentry(struct dentry *dentry)
619{
620 WARN_ON(d_in_lookup(dentry));
621
622 /* Unreachable? Get rid of it */
623 if (unlikely(d_unhashed(dentry)))
624 return false;
625
626 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
627 return false;
628
629 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
630 if (dentry->d_op->d_delete(dentry))
631 return false;
632 }
Al Viro62d99562018-03-06 21:37:31 -0500633 /* retain; LRU fodder */
634 dentry->d_lockref.count--;
635 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
636 d_lru_add(dentry);
637 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
638 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500639 return true;
640}
641
Linus Torvalds360f5472015-01-09 15:19:03 -0800642/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100643 * Finish off a dentry we've decided to kill.
644 * dentry->d_lock must be held, returns with it unlocked.
645 * Returns dentry requiring refcount drop, or NULL if we're done.
646 */
647static struct dentry *dentry_kill(struct dentry *dentry)
648 __releases(dentry->d_lock)
649{
650 struct inode *inode = dentry->d_inode;
651 struct dentry *parent = NULL;
652
653 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
Al Virof657a662018-02-23 21:25:42 -0500654 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100655
656 if (!IS_ROOT(dentry)) {
657 parent = dentry->d_parent;
658 if (unlikely(!spin_trylock(&parent->d_lock))) {
Al Virof657a662018-02-23 21:25:42 -0500659 parent = __lock_parent(dentry);
660 if (likely(inode || !dentry->d_inode))
661 goto got_locks;
662 /* negative that became positive */
663 if (parent)
664 spin_unlock(&parent->d_lock);
665 inode = dentry->d_inode;
666 goto slow_positive;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100667 }
668 }
John Ognessc1d0c1a2018-02-23 00:50:21 +0100669 __dentry_kill(dentry);
670 return parent;
671
Al Virof657a662018-02-23 21:25:42 -0500672slow_positive:
John Ognessc1d0c1a2018-02-23 00:50:21 +0100673 spin_unlock(&dentry->d_lock);
Al Virof657a662018-02-23 21:25:42 -0500674 spin_lock(&inode->i_lock);
675 spin_lock(&dentry->d_lock);
676 parent = lock_parent(dentry);
677got_locks:
678 if (unlikely(dentry->d_lockref.count != 1)) {
679 dentry->d_lockref.count--;
680 } else if (likely(!retain_dentry(dentry))) {
681 __dentry_kill(dentry);
682 return parent;
683 }
684 /* we are keeping it, after all */
685 if (inode)
686 spin_unlock(&inode->i_lock);
687 if (parent)
688 spin_unlock(&parent->d_lock);
689 spin_unlock(&dentry->d_lock);
690 return NULL;
John Ognessc1d0c1a2018-02-23 00:50:21 +0100691}
692
693/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800694 * Try to do a lockless dput(), and return whether that was successful.
695 *
696 * If unsuccessful, we return false, having already taken the dentry lock.
697 *
698 * The caller needs to hold the RCU read lock, so that the dentry is
699 * guaranteed to stay around even if the refcount goes down to zero!
700 */
701static inline bool fast_dput(struct dentry *dentry)
702{
703 int ret;
704 unsigned int d_flags;
705
706 /*
707 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100708 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800709 */
710 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
711 return lockref_put_or_lock(&dentry->d_lockref);
712
713 /*
714 * .. otherwise, we can try to just decrement the
715 * lockref optimistically.
716 */
717 ret = lockref_put_return(&dentry->d_lockref);
718
719 /*
720 * If the lockref_put_return() failed due to the lock being held
721 * by somebody else, the fast path has failed. We will need to
722 * get the lock, and then check the count again.
723 */
724 if (unlikely(ret < 0)) {
725 spin_lock(&dentry->d_lock);
726 if (dentry->d_lockref.count > 1) {
727 dentry->d_lockref.count--;
728 spin_unlock(&dentry->d_lock);
729 return 1;
730 }
731 return 0;
732 }
733
734 /*
735 * If we weren't the last ref, we're done.
736 */
737 if (ret)
738 return 1;
739
740 /*
741 * Careful, careful. The reference count went down
742 * to zero, but we don't hold the dentry lock, so
743 * somebody else could get it again, and do another
744 * dput(), and we need to not race with that.
745 *
746 * However, there is a very special and common case
747 * where we don't care, because there is nothing to
748 * do: the dentry is still hashed, it does not have
749 * a 'delete' op, and it's referenced and already on
750 * the LRU list.
751 *
752 * NOTE! Since we aren't locked, these values are
753 * not "stable". However, it is sufficient that at
754 * some point after we dropped the reference the
755 * dentry was hashed and the flags had the proper
756 * value. Other dentry users may have re-gotten
757 * a reference to the dentry and change that, but
758 * our work is done - we can leave the dentry
759 * around with a zero refcount.
760 */
761 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700762 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100763 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800764
765 /* Nothing to do? Dropping the reference was all we needed? */
766 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
767 return 1;
768
769 /*
770 * Not the fast normal case? Get the lock. We've already decremented
771 * the refcount, but we'll need to re-check the situation after
772 * getting the lock.
773 */
774 spin_lock(&dentry->d_lock);
775
776 /*
777 * Did somebody else grab a reference to it in the meantime, and
778 * we're no longer the last user after all? Alternatively, somebody
779 * else could have killed it and marked it dead. Either way, we
780 * don't need to do anything else.
781 */
782 if (dentry->d_lockref.count) {
783 spin_unlock(&dentry->d_lock);
784 return 1;
785 }
786
787 /*
788 * Re-get the reference we optimistically dropped. We hold the
789 * lock, and we just tested that it was zero, so we can just
790 * set it to 1.
791 */
792 dentry->d_lockref.count = 1;
793 return 0;
794}
795
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797/*
798 * This is dput
799 *
800 * This is complicated by the fact that we do not want to put
801 * dentries that are no longer on any hash chain on the unused
802 * list: we'd much rather just get rid of them immediately.
803 *
804 * However, that implies that we have to traverse the dentry
805 * tree upwards to the parents which might _also_ now be
806 * scheduled for deletion (it may have been only waiting for
807 * its last child to go away).
808 *
809 * This tail recursion is done by hand as we don't want to depend
810 * on the compiler to always get this right (gcc generally doesn't).
811 * Real recursion would eat up our stack space.
812 */
813
814/*
815 * dput - release a dentry
816 * @dentry: dentry to release
817 *
818 * Release a dentry. This will drop the usage count and if appropriate
819 * call the dentry unlink method as well as removing it from the queues and
820 * releasing its resources. If the parent dentries were scheduled for release
821 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823void dput(struct dentry *dentry)
824{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700825 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return;
827
828repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800829 might_sleep();
830
Linus Torvalds360f5472015-01-09 15:19:03 -0800831 rcu_read_lock();
832 if (likely(fast_dput(dentry))) {
833 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800835 }
836
837 /* Slow case: now with the dentry lock held */
838 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Al Viroa3385792018-02-23 21:07:24 -0500840 if (likely(retain_dentry(dentry))) {
Al Viroa3385792018-02-23 21:07:24 -0500841 spin_unlock(&dentry->d_lock);
842 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 }
Nick Piggin265ac902010-10-10 05:36:24 -0400844
Al Viro8cbf74d2014-05-29 09:18:26 -0400845 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800846 if (dentry) {
847 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700848 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700851EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100854/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100855static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856{
Waiman Long98474232013-08-28 18:24:59 -0700857 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858}
859
Nick Piggindc0474b2011-01-07 17:49:43 +1100860static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100861{
Waiman Long98474232013-08-28 18:24:59 -0700862 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100863}
864
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100865struct dentry *dget_parent(struct dentry *dentry)
866{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700867 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868 struct dentry *ret;
869
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700870 /*
871 * Do optimistic parent lookup without any
872 * locking.
873 */
874 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700875 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700876 gotref = lockref_get_not_zero(&ret->d_lockref);
877 rcu_read_unlock();
878 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700879 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700880 return ret;
881 dput(ret);
882 }
883
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100884repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100885 /*
886 * Don't need rcu_dereference because we re-check it was correct under
887 * the lock.
888 */
889 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100890 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100891 spin_lock(&ret->d_lock);
892 if (unlikely(ret != dentry->d_parent)) {
893 spin_unlock(&ret->d_lock);
894 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100895 goto repeat;
896 }
Nick Piggina734eb42011-01-07 17:49:44 +1100897 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700898 BUG_ON(!ret->d_lockref.count);
899 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100900 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100901 return ret;
902}
903EXPORT_SYMBOL(dget_parent);
904
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905/**
906 * d_find_alias - grab a hashed alias of inode
907 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 *
909 * If inode has a hashed alias, or is a directory and has any alias,
910 * acquire the reference to alias and return it. Otherwise return NULL.
911 * Notice that if inode is a directory there can be only one alias and
912 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800913 * of a filesystem, or if the directory was renamed and d_revalidate
914 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700916 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500917 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500919static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
Nick Pigginda502952011-01-07 17:49:33 +1100921 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Nick Pigginda502952011-01-07 17:49:33 +1100923again:
924 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400925 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100926 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700928 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100929 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500931 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100932 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100933 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 return alias;
935 }
936 }
Nick Pigginda502952011-01-07 17:49:33 +1100937 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 }
Nick Pigginda502952011-01-07 17:49:33 +1100939 if (discon_alias) {
940 alias = discon_alias;
941 spin_lock(&alias->d_lock);
942 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500943 __dget_dlock(alias);
944 spin_unlock(&alias->d_lock);
945 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100946 }
947 spin_unlock(&alias->d_lock);
948 goto again;
949 }
950 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951}
952
Nick Pigginda502952011-01-07 17:49:33 +1100953struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{
David Howells214fda12006-03-25 03:06:36 -0800955 struct dentry *de = NULL;
956
Al Virob3d9b7a2012-06-09 13:51:19 -0400957 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100958 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500959 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100960 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return de;
963}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700964EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966/*
967 * Try to kill dentries associated with this inode.
968 * WARNING: you must own a reference to inode.
969 */
970void d_prune_aliases(struct inode *inode)
971{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700972 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100974 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400975 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700977 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400978 struct dentry *parent = lock_parent(dentry);
979 if (likely(!dentry->d_lockref.count)) {
980 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800981 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400982 goto restart;
983 }
984 if (parent)
985 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 }
987 spin_unlock(&dentry->d_lock);
988 }
Nick Piggin873feea2011-01-07 17:50:06 +1100989 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700991EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Al Viro3b3f09f2018-02-23 21:54:18 -0500993/*
994 * Lock a dentry from shrink list.
995 * Note that dentry is *not* protected from concurrent dentry_kill(),
996 * d_delete(), etc. It is protected from freeing (by the fact of
997 * being on a shrink list), but everything else is fair game.
998 * Return false if dentry has been disrupted or grabbed, leaving
999 * the caller to kick it off-list. Otherwise, return true and have
1000 * that dentry's inode and parent both locked.
1001 */
1002static bool shrink_lock_dentry(struct dentry *dentry)
1003{
1004 struct inode *inode;
1005 struct dentry *parent;
1006
1007 if (dentry->d_lockref.count)
1008 return false;
1009
1010 inode = dentry->d_inode;
1011 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
1012 rcu_read_lock(); /* to protect inode */
1013 spin_unlock(&dentry->d_lock);
1014 spin_lock(&inode->i_lock);
1015 spin_lock(&dentry->d_lock);
1016 if (unlikely(dentry->d_lockref.count))
1017 goto out;
1018 /* changed inode means that somebody had grabbed it */
1019 if (unlikely(inode != dentry->d_inode))
1020 goto out;
1021 rcu_read_unlock();
1022 }
1023
1024 parent = dentry->d_parent;
1025 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1026 return true;
1027
1028 rcu_read_lock(); /* to protect parent */
1029 spin_unlock(&dentry->d_lock);
1030 parent = READ_ONCE(dentry->d_parent);
1031 spin_lock(&parent->d_lock);
1032 if (unlikely(parent != dentry->d_parent)) {
1033 spin_unlock(&parent->d_lock);
1034 spin_lock(&dentry->d_lock);
1035 goto out;
1036 }
1037 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1038 if (likely(!dentry->d_lockref.count)) {
1039 rcu_read_unlock();
1040 return true;
1041 }
1042 spin_unlock(&parent->d_lock);
1043out:
1044 if (inode)
1045 spin_unlock(&inode->i_lock);
1046 rcu_read_unlock();
1047 return false;
1048}
1049
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001050static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001052 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001053 struct dentry *dentry, *parent;
Al Viroff2fde92014-05-28 13:59:13 -04001054 struct inode *inode;
Al Viro3b3f09f2018-02-23 21:54:18 -05001055
Miklos Szeredi60942f22014-05-02 15:38:39 -04001056 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001057 spin_lock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001058 if (!shrink_lock_dentry(dentry)) {
1059 bool can_free = false;
1060 d_shrink_del(dentry);
1061 if (dentry->d_lockref.count < 0)
1062 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001063 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001064 if (can_free)
1065 dentry_free(dentry);
1066 continue;
1067 }
Al Viro3b3f09f2018-02-23 21:54:18 -05001068 d_shrink_del(dentry);
1069 parent = dentry->d_parent;
Al Viroff2fde92014-05-28 13:59:13 -04001070 __dentry_kill(dentry);
Al Viro3b3f09f2018-02-23 21:54:18 -05001071 if (parent == dentry)
1072 continue;
Al Viro5c47e6d2014-04-29 16:13:18 -04001073 /*
1074 * We need to prune ancestors too. This is necessary to prevent
1075 * quadratic behavior of shrink_dcache_parent(), but is also
1076 * expected to be beneficial in reducing dentry cache
1077 * fragmentation.
1078 */
1079 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001080 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1081 parent = lock_parent(dentry);
1082 if (dentry->d_lockref.count != 1) {
1083 dentry->d_lockref.count--;
1084 spin_unlock(&dentry->d_lock);
1085 if (parent)
1086 spin_unlock(&parent->d_lock);
1087 break;
1088 }
1089 inode = dentry->d_inode; /* can't be NULL */
1090 if (unlikely(!spin_trylock(&inode->i_lock))) {
1091 spin_unlock(&dentry->d_lock);
1092 if (parent)
1093 spin_unlock(&parent->d_lock);
1094 cpu_relax();
1095 continue;
1096 }
1097 __dentry_kill(dentry);
1098 dentry = parent;
1099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001101}
1102
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001103static enum lru_status dentry_lru_isolate(struct list_head *item,
1104 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001105{
1106 struct list_head *freeable = arg;
1107 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1108
1109
1110 /*
1111 * we are inverting the lru lock/dentry->d_lock here,
1112 * so use a trylock. If we fail to get the lock, just skip
1113 * it
1114 */
1115 if (!spin_trylock(&dentry->d_lock))
1116 return LRU_SKIP;
1117
1118 /*
1119 * Referenced dentries are still in use. If they have active
1120 * counts, just remove them from the LRU. Otherwise give them
1121 * another pass through the LRU.
1122 */
1123 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001124 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001125 spin_unlock(&dentry->d_lock);
1126 return LRU_REMOVED;
1127 }
1128
1129 if (dentry->d_flags & DCACHE_REFERENCED) {
1130 dentry->d_flags &= ~DCACHE_REFERENCED;
1131 spin_unlock(&dentry->d_lock);
1132
1133 /*
1134 * The list move itself will be made by the common LRU code. At
1135 * this point, we've dropped the dentry->d_lock but keep the
1136 * lru lock. This is safe to do, since every list movement is
1137 * protected by the lru lock even if both locks are held.
1138 *
1139 * This is guaranteed by the fact that all LRU management
1140 * functions are intermediated by the LRU API calls like
1141 * list_lru_add and list_lru_del. List movement in this file
1142 * only ever occur through this functions or through callbacks
1143 * like this one, that are called from the LRU API.
1144 *
1145 * The only exceptions to this are functions like
1146 * shrink_dentry_list, and code that first checks for the
1147 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1148 * operating only with stack provided lists after they are
1149 * properly isolated from the main list. It is thus, always a
1150 * local access.
1151 */
1152 return LRU_ROTATE;
1153 }
1154
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001155 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001156 spin_unlock(&dentry->d_lock);
1157
1158 return LRU_REMOVED;
1159}
1160
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001161/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001162 * prune_dcache_sb - shrink the dcache
1163 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001164 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001165 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001166 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1167 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001168 * function.
1169 *
1170 * This function may fail to free any resources if all the dentries are in
1171 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001172 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001173long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001174{
Dave Chinnerf6041562013-08-28 10:18:00 +10001175 LIST_HEAD(dispose);
1176 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001177
Vladimir Davydov503c3582015-02-12 14:58:47 -08001178 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1179 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001180 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001181 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
1183
Glauber Costa4e717f52013-08-28 10:18:03 +10001184static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001185 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001186{
Glauber Costa4e717f52013-08-28 10:18:03 +10001187 struct list_head *freeable = arg;
1188 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001189
Glauber Costa4e717f52013-08-28 10:18:03 +10001190 /*
1191 * we are inverting the lru lock/dentry->d_lock here,
1192 * so use a trylock. If we fail to get the lock, just skip
1193 * it
1194 */
1195 if (!spin_trylock(&dentry->d_lock))
1196 return LRU_SKIP;
1197
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001198 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001199 spin_unlock(&dentry->d_lock);
1200
1201 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001202}
1203
Glauber Costa4e717f52013-08-28 10:18:03 +10001204
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001205/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 * shrink_dcache_sb - shrink dcache for a superblock
1207 * @sb: superblock
1208 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001209 * Shrink the dcache for the specified super block. This is used to free
1210 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001212void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213{
Glauber Costa4e717f52013-08-28 10:18:03 +10001214 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001215
Glauber Costa4e717f52013-08-28 10:18:03 +10001216 do {
1217 LIST_HEAD(dispose);
1218
1219 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001220 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001221
1222 this_cpu_sub(nr_dentry_unused, freed);
1223 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001224 cond_resched();
1225 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001227EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001230 * enum d_walk_ret - action to talke during tree walk
1231 * @D_WALK_CONTINUE: contrinue walk
1232 * @D_WALK_QUIT: quit walk
1233 * @D_WALK_NORETRY: quit when retry is needed
1234 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001236enum d_walk_ret {
1237 D_WALK_CONTINUE,
1238 D_WALK_QUIT,
1239 D_WALK_NORETRY,
1240 D_WALK_SKIP,
1241};
1242
1243/**
1244 * d_walk - walk the dentry tree
1245 * @parent: start of walk
1246 * @data: data passed to @enter() and @finish()
1247 * @enter: callback when first entering the dentry
1248 * @finish: callback when successfully finished the walk
1249 *
1250 * The @enter() and @finish() callbacks are called with d_lock held.
1251 */
1252static void d_walk(struct dentry *parent, void *data,
1253 enum d_walk_ret (*enter)(void *, struct dentry *),
1254 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
Nick Piggin949854d2011-01-07 17:49:37 +11001256 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001258 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001259 enum d_walk_ret ret;
1260 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001261
Nick Piggin58db63d2011-01-07 17:49:39 +11001262again:
Al Viro48f5ec22013-09-09 15:22:25 -04001263 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001264 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001265 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001266
1267 ret = enter(data, this_parent);
1268 switch (ret) {
1269 case D_WALK_CONTINUE:
1270 break;
1271 case D_WALK_QUIT:
1272 case D_WALK_SKIP:
1273 goto out_unlock;
1274 case D_WALK_NORETRY:
1275 retry = false;
1276 break;
1277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278repeat:
1279 next = this_parent->d_subdirs.next;
1280resume:
1281 while (next != &this_parent->d_subdirs) {
1282 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001283 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001285
Al Viroba65dc52016-06-10 11:32:47 -04001286 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1287 continue;
1288
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001289 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001290
1291 ret = enter(data, dentry);
1292 switch (ret) {
1293 case D_WALK_CONTINUE:
1294 break;
1295 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001296 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001297 goto out_unlock;
1298 case D_WALK_NORETRY:
1299 retry = false;
1300 break;
1301 case D_WALK_SKIP:
1302 spin_unlock(&dentry->d_lock);
1303 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001304 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001307 spin_unlock(&this_parent->d_lock);
1308 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001310 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 goto repeat;
1312 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001313 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 }
1315 /*
1316 * All done at this level ... ascend and resume the search.
1317 */
Al Viroca5358e2014-10-26 19:31:10 -04001318 rcu_read_lock();
1319ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001321 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001322 this_parent = child->d_parent;
1323
Al Viro31dec132013-10-25 17:04:27 -04001324 spin_unlock(&child->d_lock);
1325 spin_lock(&this_parent->d_lock);
1326
Al Viroca5358e2014-10-26 19:31:10 -04001327 /* might go back up the wrong parent if we have had a rename. */
1328 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001329 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001330 /* go into the first sibling still alive */
1331 do {
1332 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001333 if (next == &this_parent->d_subdirs)
1334 goto ascend;
1335 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001336 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001337 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 goto resume;
1339 }
Al Viroca5358e2014-10-26 19:31:10 -04001340 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001341 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001342 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001343 if (finish)
1344 finish(data);
1345
1346out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001347 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001348 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001349 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001350
1351rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001352 spin_unlock(&this_parent->d_lock);
1353 rcu_read_unlock();
1354 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001355 if (!retry)
1356 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001357 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001358 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001360
Ian Kent01619492016-11-24 08:03:41 +11001361struct check_mount {
1362 struct vfsmount *mnt;
1363 unsigned int mounted;
1364};
1365
1366static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1367{
1368 struct check_mount *info = data;
1369 struct path path = { .mnt = info->mnt, .dentry = dentry };
1370
1371 if (likely(!d_mountpoint(dentry)))
1372 return D_WALK_CONTINUE;
1373 if (__path_is_mountpoint(&path)) {
1374 info->mounted = 1;
1375 return D_WALK_QUIT;
1376 }
1377 return D_WALK_CONTINUE;
1378}
1379
1380/**
1381 * path_has_submounts - check for mounts over a dentry in the
1382 * current namespace.
1383 * @parent: path to check.
1384 *
1385 * Return true if the parent or its subdirectories contain
1386 * a mount point in the current namespace.
1387 */
1388int path_has_submounts(const struct path *parent)
1389{
1390 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1391
1392 read_seqlock_excl(&mount_lock);
1393 d_walk(parent->dentry, &data, path_check_mount, NULL);
1394 read_sequnlock_excl(&mount_lock);
1395
1396 return data.mounted;
1397}
1398EXPORT_SYMBOL(path_has_submounts);
1399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001401 * Called by mount code to set a mountpoint and check if the mountpoint is
1402 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1403 * subtree can become unreachable).
1404 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001405 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001406 * this reason take rename_lock and d_lock on dentry and ancestors.
1407 */
1408int d_set_mounted(struct dentry *dentry)
1409{
1410 struct dentry *p;
1411 int ret = -ENOENT;
1412 write_seqlock(&rename_lock);
1413 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001414 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001415 spin_lock(&p->d_lock);
1416 if (unlikely(d_unhashed(p))) {
1417 spin_unlock(&p->d_lock);
1418 goto out;
1419 }
1420 spin_unlock(&p->d_lock);
1421 }
1422 spin_lock(&dentry->d_lock);
1423 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001424 ret = -EBUSY;
1425 if (!d_mountpoint(dentry)) {
1426 dentry->d_flags |= DCACHE_MOUNTED;
1427 ret = 0;
1428 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001429 }
1430 spin_unlock(&dentry->d_lock);
1431out:
1432 write_sequnlock(&rename_lock);
1433 return ret;
1434}
1435
1436/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001437 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 * and move any unused dentries to the end of the unused
1439 * list for prune_dcache(). We descend to the next level
1440 * whenever the d_subdirs list is non-empty and continue
1441 * searching.
1442 *
1443 * It returns zero iff there are no unused children,
1444 * otherwise it returns the number of children moved to
1445 * the end of the unused list. This may not be the total
1446 * number of unused children, because select_parent can
1447 * drop the lock and return early due to latency
1448 * constraints.
1449 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001450
1451struct select_data {
1452 struct dentry *start;
1453 struct list_head dispose;
1454 int found;
1455};
1456
1457static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001459 struct select_data *data = _data;
1460 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001462 if (data->start == dentry)
1463 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Al Virofe915222014-05-03 00:02:25 -04001465 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001466 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001467 } else {
1468 if (dentry->d_flags & DCACHE_LRU_LIST)
1469 d_lru_del(dentry);
1470 if (!dentry->d_lockref.count) {
1471 d_shrink_add(dentry, &data->dispose);
1472 data->found++;
1473 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 }
1475 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001476 * We can return to the caller if we have found some (this
1477 * ensures forward progress). We'll be coming back to find
1478 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 */
Al Virofe915222014-05-03 00:02:25 -04001480 if (!list_empty(&data->dispose))
1481 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001483 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484}
1485
1486/**
1487 * shrink_dcache_parent - prune dcache
1488 * @parent: parent of entries to prune
1489 *
1490 * Prune the dcache to remove unused children of the parent dentry.
1491 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001492void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001494 for (;;) {
1495 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001497 INIT_LIST_HEAD(&data.dispose);
1498 data.start = parent;
1499 data.found = 0;
1500
1501 d_walk(parent, &data, select_collect, NULL);
1502 if (!data.found)
1503 break;
1504
1505 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001506 cond_resched();
1507 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001509EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Al Viro9c8c10e2014-05-02 20:36:10 -04001511static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001512{
Al Viro9c8c10e2014-05-02 20:36:10 -04001513 /* it has busy descendents; complain about those instead */
1514 if (!list_empty(&dentry->d_subdirs))
1515 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001516
Al Viro9c8c10e2014-05-02 20:36:10 -04001517 /* root with refcount 1 is fine */
1518 if (dentry == _data && dentry->d_lockref.count == 1)
1519 return D_WALK_CONTINUE;
1520
1521 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1522 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001523 dentry,
1524 dentry->d_inode ?
1525 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001526 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001527 dentry->d_lockref.count,
1528 dentry->d_sb->s_type->name,
1529 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001530 WARN_ON(1);
1531 return D_WALK_CONTINUE;
1532}
1533
1534static void do_one_tree(struct dentry *dentry)
1535{
1536 shrink_dcache_parent(dentry);
1537 d_walk(dentry, dentry, umount_check, NULL);
1538 d_drop(dentry);
1539 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001540}
1541
1542/*
1543 * destroy the dentries attached to a superblock on unmounting
1544 */
1545void shrink_dcache_for_umount(struct super_block *sb)
1546{
1547 struct dentry *dentry;
1548
Al Viro9c8c10e2014-05-02 20:36:10 -04001549 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001550
1551 dentry = sb->s_root;
1552 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001553 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001554
NeilBrownf1ee6162017-12-21 09:45:40 +11001555 while (!hlist_bl_empty(&sb->s_roots)) {
1556 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001557 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001558 }
1559}
1560
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001561struct detach_data {
1562 struct select_data select;
1563 struct dentry *mountpoint;
1564};
1565static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001566{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001567 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001568
1569 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001570 __dget_dlock(dentry);
1571 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001572 return D_WALK_QUIT;
1573 }
1574
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001575 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001576}
1577
1578static void check_and_drop(void *_data)
1579{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001580 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001581
Al Viro81be24d2017-06-03 07:20:09 +01001582 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001583 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001584}
1585
1586/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001587 * d_invalidate - detach submounts, prune dcache, and drop
1588 * @dentry: dentry to invalidate (aka detach, prune and drop)
1589 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001590 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001591 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001592 * The final d_drop is done as an atomic operation relative to
1593 * rename_lock ensuring there are no races with d_set_mounted. This
1594 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001595 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001596void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001597{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001598 /*
1599 * If it's already been dropped, return OK.
1600 */
1601 spin_lock(&dentry->d_lock);
1602 if (d_unhashed(dentry)) {
1603 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001604 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001605 }
1606 spin_unlock(&dentry->d_lock);
1607
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001608 /* Negative dentries can be dropped without further checks */
1609 if (!dentry->d_inode) {
1610 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001611 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001612 }
1613
1614 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001615 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001616
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001617 data.mountpoint = NULL;
1618 INIT_LIST_HEAD(&data.select.dispose);
1619 data.select.start = dentry;
1620 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001621
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001622 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001623
Al Viro81be24d2017-06-03 07:20:09 +01001624 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001625 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001626 else if (!data.mountpoint)
1627 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001628
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001629 if (data.mountpoint) {
1630 detach_mounts(data.mountpoint);
1631 dput(data.mountpoint);
1632 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001633 cond_resched();
1634 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001635}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001636EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638/**
Al Viroa4464db2011-07-07 15:03:58 -04001639 * __d_alloc - allocate a dcache entry
1640 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 * @name: qstr of the name
1642 *
1643 * Allocates a dentry. It returns %NULL if there is insufficient memory
1644 * available. On a success the dentry is returned. The name passed in is
1645 * copied and the copy passed in may be reused after this call.
1646 */
1647
Al Viroa4464db2011-07-07 15:03:58 -04001648struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649{
1650 struct dentry *dentry;
1651 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001652 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Mel Gormane12ba742007-10-16 01:25:52 -07001654 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 if (!dentry)
1656 return NULL;
1657
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001658 /*
1659 * We guarantee that the inline name is always NUL-terminated.
1660 * This way the memcpy() done by the name switching in rename
1661 * will still always have a NUL at the end, even if we might
1662 * be overwriting an internal NUL character
1663 */
1664 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001665 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001666 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001667 dname = dentry->d_iname;
1668 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001669 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001670 struct external_name *p = kmalloc(size + name->len,
1671 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001672 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 kmem_cache_free(dentry_cache, dentry);
1674 return NULL;
1675 }
Al Viro8d85b482014-09-29 14:54:27 -04001676 atomic_set(&p->u.count, 1);
1677 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 } else {
1679 dname = dentry->d_iname;
1680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
1682 dentry->d_name.len = name->len;
1683 dentry->d_name.hash = name->hash;
1684 memcpy(dname, name->name, name->len);
1685 dname[name->len] = 0;
1686
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001687 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001688 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001689
Waiman Long98474232013-08-28 18:24:59 -07001690 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001691 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001693 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001695 dentry->d_parent = dentry;
1696 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 dentry->d_op = NULL;
1698 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001699 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 INIT_LIST_HEAD(&dentry->d_lru);
1701 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001702 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1703 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001704 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
Miklos Szeredi285b1022016-06-28 11:47:32 +02001706 if (dentry->d_op && dentry->d_op->d_init) {
1707 err = dentry->d_op->d_init(dentry);
1708 if (err) {
1709 if (dname_external(dentry))
1710 kfree(external_name(dentry));
1711 kmem_cache_free(dentry_cache, dentry);
1712 return NULL;
1713 }
1714 }
1715
Nick Piggin3e880fb2011-01-07 17:49:19 +11001716 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001717
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 return dentry;
1719}
Al Viroa4464db2011-07-07 15:03:58 -04001720
1721/**
1722 * d_alloc - allocate a dcache entry
1723 * @parent: parent of entry to allocate
1724 * @name: qstr of the name
1725 *
1726 * Allocates a dentry. It returns %NULL if there is insufficient memory
1727 * available. On a success the dentry is returned. The name passed in is
1728 * copied and the copy passed in may be reused after this call.
1729 */
1730struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1731{
1732 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1733 if (!dentry)
1734 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001735 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001736 spin_lock(&parent->d_lock);
1737 /*
1738 * don't need child lock because it is not subject
1739 * to concurrency here
1740 */
1741 __dget_dlock(parent);
1742 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001743 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001744 spin_unlock(&parent->d_lock);
1745
1746 return dentry;
1747}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001748EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749
Miklos Szeredif9c34672018-01-19 11:39:52 +01001750struct dentry *d_alloc_anon(struct super_block *sb)
1751{
1752 return __d_alloc(sb, NULL);
1753}
1754EXPORT_SYMBOL(d_alloc_anon);
1755
Al Viroba65dc52016-06-10 11:32:47 -04001756struct dentry *d_alloc_cursor(struct dentry * parent)
1757{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001758 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001759 if (dentry) {
1760 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1761 dentry->d_parent = dget(parent);
1762 }
1763 return dentry;
1764}
1765
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001766/**
1767 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1768 * @sb: the superblock
1769 * @name: qstr of the name
1770 *
1771 * For a filesystem that just pins its dentries in memory and never
1772 * performs lookups at all, return an unhashed IS_ROOT dentry.
1773 */
Nick Piggin4b936882011-01-07 17:50:07 +11001774struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1775{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001776 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001777}
1778EXPORT_SYMBOL(d_alloc_pseudo);
1779
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1781{
1782 struct qstr q;
1783
1784 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001785 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 return d_alloc(parent, &q);
1787}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001788EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
Nick Pigginfb045ad2011-01-07 17:49:55 +11001790void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1791{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001792 WARN_ON_ONCE(dentry->d_op);
1793 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001794 DCACHE_OP_COMPARE |
1795 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001796 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001797 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001798 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001799 dentry->d_op = op;
1800 if (!op)
1801 return;
1802 if (op->d_hash)
1803 dentry->d_flags |= DCACHE_OP_HASH;
1804 if (op->d_compare)
1805 dentry->d_flags |= DCACHE_OP_COMPARE;
1806 if (op->d_revalidate)
1807 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001808 if (op->d_weak_revalidate)
1809 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001810 if (op->d_delete)
1811 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001812 if (op->d_prune)
1813 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001814 if (op->d_real)
1815 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001816
1817}
1818EXPORT_SYMBOL(d_set_d_op);
1819
David Howellsdf1a0852015-01-29 12:02:28 +00001820
1821/*
1822 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1823 * @dentry - The dentry to mark
1824 *
1825 * Mark a dentry as falling through to the lower layer (as set with
1826 * d_pin_lower()). This flag may be recorded on the medium.
1827 */
1828void d_set_fallthru(struct dentry *dentry)
1829{
1830 spin_lock(&dentry->d_lock);
1831 dentry->d_flags |= DCACHE_FALLTHRU;
1832 spin_unlock(&dentry->d_lock);
1833}
1834EXPORT_SYMBOL(d_set_fallthru);
1835
David Howellsb18825a2013-09-12 19:22:53 +01001836static unsigned d_flags_for_inode(struct inode *inode)
1837{
David Howells44bdb5e2015-01-29 12:02:29 +00001838 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001839
1840 if (!inode)
1841 return DCACHE_MISS_TYPE;
1842
1843 if (S_ISDIR(inode->i_mode)) {
1844 add_flags = DCACHE_DIRECTORY_TYPE;
1845 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1846 if (unlikely(!inode->i_op->lookup))
1847 add_flags = DCACHE_AUTODIR_TYPE;
1848 else
1849 inode->i_opflags |= IOP_LOOKUP;
1850 }
David Howells44bdb5e2015-01-29 12:02:29 +00001851 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001852 }
1853
David Howells44bdb5e2015-01-29 12:02:29 +00001854 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001855 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001856 add_flags = DCACHE_SYMLINK_TYPE;
1857 goto type_determined;
1858 }
1859 inode->i_opflags |= IOP_NOFOLLOW;
1860 }
1861
1862 if (unlikely(!S_ISREG(inode->i_mode)))
1863 add_flags = DCACHE_SPECIAL_TYPE;
1864
1865type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001866 if (unlikely(IS_AUTOMOUNT(inode)))
1867 add_flags |= DCACHE_NEED_AUTOMOUNT;
1868 return add_flags;
1869}
1870
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001871static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1872{
David Howellsb18825a2013-09-12 19:22:53 +01001873 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001874 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001875
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001876 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001877 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001878 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001879 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001880 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001881 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001882 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001883}
1884
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885/**
1886 * d_instantiate - fill in inode information for a dentry
1887 * @entry: dentry to complete
1888 * @inode: inode to attach to this dentry
1889 *
1890 * Fill in inode information in the entry.
1891 *
1892 * This turns negative dentries into productive full members
1893 * of society.
1894 *
1895 * NOTE! This assumes that the inode count has been incremented
1896 * (or otherwise set) by the caller to indicate that it is now
1897 * in use by the dcache.
1898 */
1899
1900void d_instantiate(struct dentry *entry, struct inode * inode)
1901{
Al Viro946e51f2014-10-26 19:19:16 -04001902 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001903 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001904 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001905 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001906 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001907 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001910EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
1912/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001913 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1914 * @entry: dentry to complete
1915 * @inode: inode to attach to this dentry
1916 *
1917 * Fill in inode information in the entry. If a directory alias is found, then
1918 * return an error (and drop inode). Together with d_materialise_unique() this
1919 * guarantees that a directory inode may never have more than one alias.
1920 */
1921int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1922{
Al Viro946e51f2014-10-26 19:19:16 -04001923 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001924
Al Virob9680912016-04-11 00:53:26 -04001925 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001926 spin_lock(&inode->i_lock);
1927 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1928 spin_unlock(&inode->i_lock);
1929 iput(inode);
1930 return -EBUSY;
1931 }
1932 __d_instantiate(entry, inode);
1933 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001934
1935 return 0;
1936}
1937EXPORT_SYMBOL(d_instantiate_no_diralias);
1938
Al Viroadc0e91a2012-01-08 16:49:21 -05001939struct dentry *d_make_root(struct inode *root_inode)
1940{
1941 struct dentry *res = NULL;
1942
1943 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001944 res = d_alloc_anon(root_inode->i_sb);
Al Viroadc0e91a2012-01-08 16:49:21 -05001945 if (res)
1946 d_instantiate(res, root_inode);
1947 else
1948 iput(root_inode);
1949 }
1950 return res;
1951}
1952EXPORT_SYMBOL(d_make_root);
1953
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001954static struct dentry * __d_find_any_alias(struct inode *inode)
1955{
1956 struct dentry *alias;
1957
Al Virob3d9b7a2012-06-09 13:51:19 -04001958 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001959 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001960 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001961 __dget(alias);
1962 return alias;
1963}
1964
Sage Weil46f72b32012-01-10 09:04:37 -08001965/**
1966 * d_find_any_alias - find any alias for a given inode
1967 * @inode: inode to find an alias for
1968 *
1969 * If any aliases exist for the given inode, take and return a
1970 * reference for one of them. If no aliases exist, return %NULL.
1971 */
1972struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001973{
1974 struct dentry *de;
1975
1976 spin_lock(&inode->i_lock);
1977 de = __d_find_any_alias(inode);
1978 spin_unlock(&inode->i_lock);
1979 return de;
1980}
Sage Weil46f72b32012-01-10 09:04:37 -08001981EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001982
Miklos Szeredif9c34672018-01-19 11:39:52 +01001983static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1984 struct inode *inode,
1985 bool disconnected)
1986{
1987 struct dentry *res;
1988 unsigned add_flags;
1989
1990 security_d_instantiate(dentry, inode);
1991 spin_lock(&inode->i_lock);
1992 res = __d_find_any_alias(inode);
1993 if (res) {
1994 spin_unlock(&inode->i_lock);
1995 dput(dentry);
1996 goto out_iput;
1997 }
1998
1999 /* attach a disconnected dentry */
2000 add_flags = d_flags_for_inode(inode);
2001
2002 if (disconnected)
2003 add_flags |= DCACHE_DISCONNECTED;
2004
2005 spin_lock(&dentry->d_lock);
2006 __d_set_inode_and_type(dentry, inode, add_flags);
2007 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08002008 if (!disconnected) {
2009 hlist_bl_lock(&dentry->d_sb->s_roots);
2010 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
2011 hlist_bl_unlock(&dentry->d_sb->s_roots);
2012 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01002013 spin_unlock(&dentry->d_lock);
2014 spin_unlock(&inode->i_lock);
2015
2016 return dentry;
2017
2018 out_iput:
2019 iput(inode);
2020 return res;
2021}
2022
2023struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2024{
2025 return __d_instantiate_anon(dentry, inode, true);
2026}
2027EXPORT_SYMBOL(d_instantiate_anon);
2028
2029static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002030{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002031 struct dentry *tmp;
2032 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002033
2034 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002035 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002036 if (IS_ERR(inode))
2037 return ERR_CAST(inode);
2038
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002039 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002040 if (res)
2041 goto out_iput;
2042
Miklos Szeredif9c34672018-01-19 11:39:52 +01002043 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002044 if (!tmp) {
2045 res = ERR_PTR(-ENOMEM);
2046 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002047 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002048
Miklos Szeredif9c34672018-01-19 11:39:52 +01002049 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002050
Miklos Szeredif9c34672018-01-19 11:39:52 +01002051out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002052 iput(inode);
2053 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002054}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002055
2056/**
2057 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2058 * @inode: inode to allocate the dentry for
2059 *
2060 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2061 * similar open by handle operations. The returned dentry may be anonymous,
2062 * or may have a full name (if the inode was already in the cache).
2063 *
2064 * When called on a directory inode, we must ensure that the inode only ever
2065 * has one dentry. If a dentry is found, that is returned instead of
2066 * allocating a new one.
2067 *
2068 * On successful return, the reference to the inode has been transferred
2069 * to the dentry. In case of an error the reference on the inode is released.
2070 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2071 * be passed in and the error will be propagated to the return value,
2072 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2073 */
2074struct dentry *d_obtain_alias(struct inode *inode)
2075{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002076 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002077}
Benny Halevyadc48722009-02-27 14:02:59 -08002078EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002081 * d_obtain_root - find or allocate a dentry for a given inode
2082 * @inode: inode to allocate the dentry for
2083 *
2084 * Obtain an IS_ROOT dentry for the root of a filesystem.
2085 *
2086 * We must ensure that directory inodes only ever have one dentry. If a
2087 * dentry is found, that is returned instead of allocating a new one.
2088 *
2089 * On successful return, the reference to the inode has been transferred
2090 * to the dentry. In case of an error the reference on the inode is
2091 * released. A %NULL or IS_ERR inode may be passed in and will be the
2092 * error will be propagate to the return value, with a %NULL @inode
2093 * replaced by ERR_PTR(-ESTALE).
2094 */
2095struct dentry *d_obtain_root(struct inode *inode)
2096{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002097 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002098}
2099EXPORT_SYMBOL(d_obtain_root);
2100
2101/**
Barry Naujok94035402008-05-21 16:50:46 +10002102 * d_add_ci - lookup or allocate new dentry with case-exact name
2103 * @inode: the inode case-insensitive lookup has found
2104 * @dentry: the negative dentry that was passed to the parent's lookup func
2105 * @name: the case-exact name to be associated with the returned dentry
2106 *
2107 * This is to avoid filling the dcache with case-insensitive names to the
2108 * same inode, only the actual correct case is stored in the dcache for
2109 * case-insensitive filesystems.
2110 *
2111 * For a case-insensitive lookup match and if the the case-exact dentry
2112 * already exists in in the dcache, use it and return it.
2113 *
2114 * If no entry exists with the exact case name, allocate new dentry with
2115 * the exact case, and return the spliced entry.
2116 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002117struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002118 struct qstr *name)
2119{
Al Virod9171b92016-04-15 03:33:13 -04002120 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002121
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002122 /*
2123 * First check if a dentry matching the name already exists,
2124 * if not go ahead and create it now.
2125 */
Barry Naujok94035402008-05-21 16:50:46 +10002126 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002127 if (found) {
2128 iput(inode);
2129 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002130 }
Al Virod9171b92016-04-15 03:33:13 -04002131 if (d_in_lookup(dentry)) {
2132 found = d_alloc_parallel(dentry->d_parent, name,
2133 dentry->d_wait);
2134 if (IS_ERR(found) || !d_in_lookup(found)) {
2135 iput(inode);
2136 return found;
2137 }
2138 } else {
2139 found = d_alloc(dentry->d_parent, name);
2140 if (!found) {
2141 iput(inode);
2142 return ERR_PTR(-ENOMEM);
2143 }
2144 }
2145 res = d_splice_alias(inode, found);
2146 if (res) {
2147 dput(found);
2148 return res;
2149 }
Al Viro4f522a22013-02-11 23:20:37 -05002150 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002151}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002152EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002154
Al Virod4c91a82016-06-25 23:33:49 -04002155static inline bool d_same_name(const struct dentry *dentry,
2156 const struct dentry *parent,
2157 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002158{
Al Virod4c91a82016-06-25 23:33:49 -04002159 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2160 if (dentry->d_name.len != name->len)
2161 return false;
2162 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002163 }
Al Viro6fa67e72016-07-31 16:37:25 -04002164 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002165 dentry->d_name.len, dentry->d_name.name,
2166 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002167}
2168
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002170 * __d_lookup_rcu - search for a dentry (racy, store-free)
2171 * @parent: parent dentry
2172 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002173 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002174 * Returns: dentry, or NULL
2175 *
2176 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2177 * resolution (store-free path walking) design described in
2178 * Documentation/filesystems/path-lookup.txt.
2179 *
2180 * This is not to be used outside core vfs.
2181 *
2182 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2183 * held, and rcu_read_lock held. The returned dentry must not be stored into
2184 * without taking d_lock and checking d_seq sequence count against @seq
2185 * returned here.
2186 *
Linus Torvalds15570082013-09-02 11:38:06 -07002187 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002188 * function.
2189 *
2190 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2191 * the returned dentry, so long as its parent's seqlock is checked after the
2192 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2193 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002194 *
2195 * NOTE! The caller *has* to check the resulting dentry against the sequence
2196 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002197 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002198struct dentry *__d_lookup_rcu(const struct dentry *parent,
2199 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002200 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002201{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002202 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002203 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002204 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002205 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002206 struct dentry *dentry;
2207
2208 /*
2209 * Note: There is significant duplication with __d_lookup_rcu which is
2210 * required to prevent single threaded performance regressions
2211 * especially on architectures where smp_rmb (in seqcounts) are costly.
2212 * Keep the two functions in sync.
2213 */
2214
2215 /*
2216 * The hash list is protected using RCU.
2217 *
2218 * Carefully use d_seq when comparing a candidate dentry, to avoid
2219 * races with d_move().
2220 *
2221 * It is possible that concurrent renames can mess up our list
2222 * walk here and result in missing our dentry, resulting in the
2223 * false-negative result. d_lookup() protects against concurrent
2224 * renames using rename_lock seqlock.
2225 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002226 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002227 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002228 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002229 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002230
Nick Piggin31e6b012011-01-07 17:49:52 +11002231seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002232 /*
2233 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002234 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002235 *
2236 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002237 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002238 *
2239 * NOTE! We do a "raw" seqcount_begin here. That means that
2240 * we don't wait for the sequence count to stabilize if it
2241 * is in the middle of a sequence change. If we do the slow
2242 * dentry compare, we will do seqretries until it is stable,
2243 * and if we end up with a successful lookup, we actually
2244 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002245 *
2246 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2247 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002248 */
2249 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002250 if (dentry->d_parent != parent)
2251 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002252 if (d_unhashed(dentry))
2253 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002254
2255 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002256 int tlen;
2257 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002258 if (dentry->d_name.hash != hashlen_hash(hashlen))
2259 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002260 tlen = dentry->d_name.len;
2261 tname = dentry->d_name.name;
2262 /* we want a consistent (name,len) pair */
2263 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2264 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002265 goto seqretry;
2266 }
Al Viro6fa67e72016-07-31 16:37:25 -04002267 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002268 tlen, tname, name) != 0)
2269 continue;
2270 } else {
2271 if (dentry->d_name.hash_len != hashlen)
2272 continue;
2273 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2274 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002275 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002276 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002277 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002278 }
2279 return NULL;
2280}
2281
2282/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 * d_lookup - search for a dentry
2284 * @parent: parent dentry
2285 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002286 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002288 * d_lookup searches the children of the parent dentry for the name in
2289 * question. If the dentry is found its reference count is incremented and the
2290 * dentry is returned. The caller must use dput to free the entry when it has
2291 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 */
Al Viroda2d8452013-01-24 18:29:34 -05002293struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294{
Nick Piggin31e6b012011-01-07 17:49:52 +11002295 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002296 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297
Daeseok Younb8314f92014-08-11 11:46:53 +09002298 do {
2299 seq = read_seqbegin(&rename_lock);
2300 dentry = __d_lookup(parent, name);
2301 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 break;
2303 } while (read_seqretry(&rename_lock, seq));
2304 return dentry;
2305}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002306EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
Nick Piggin31e6b012011-01-07 17:49:52 +11002308/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002309 * __d_lookup - search for a dentry (racy)
2310 * @parent: parent dentry
2311 * @name: qstr of name we wish to find
2312 * Returns: dentry, or NULL
2313 *
2314 * __d_lookup is like d_lookup, however it may (rarely) return a
2315 * false-negative result due to unrelated rename activity.
2316 *
2317 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2318 * however it must be used carefully, eg. with a following d_lookup in
2319 * the case of failure.
2320 *
2321 * __d_lookup callers must be commented.
2322 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002323struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002326 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002327 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002328 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002329 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
Nick Pigginb04f7842010-08-18 04:37:34 +10002331 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002332 * Note: There is significant duplication with __d_lookup_rcu which is
2333 * required to prevent single threaded performance regressions
2334 * especially on architectures where smp_rmb (in seqcounts) are costly.
2335 * Keep the two functions in sync.
2336 */
2337
2338 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002339 * The hash list is protected using RCU.
2340 *
2341 * Take d_lock when comparing a candidate dentry, to avoid races
2342 * with d_move().
2343 *
2344 * It is possible that concurrent renames can mess up our list
2345 * walk here and result in missing our dentry, resulting in the
2346 * false-negative result. d_lookup() protects against concurrent
2347 * renames using rename_lock seqlock.
2348 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002349 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002350 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 rcu_read_lock();
2352
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002353 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 if (dentry->d_name.hash != hash)
2356 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357
2358 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 if (dentry->d_parent != parent)
2360 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002361 if (d_unhashed(dentry))
2362 goto next;
2363
Al Virod4c91a82016-06-25 23:33:49 -04002364 if (!d_same_name(dentry, parent, name))
2365 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366
Waiman Long98474232013-08-28 18:24:59 -07002367 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002368 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 spin_unlock(&dentry->d_lock);
2370 break;
2371next:
2372 spin_unlock(&dentry->d_lock);
2373 }
2374 rcu_read_unlock();
2375
2376 return found;
2377}
2378
2379/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002380 * d_hash_and_lookup - hash the qstr then search for a dentry
2381 * @dir: Directory to search in
2382 * @name: qstr of name we wish to find
2383 *
Al Viro4f522a22013-02-11 23:20:37 -05002384 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002385 */
2386struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2387{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002388 /*
2389 * Check for a fs-specific hash function. Note that we must
2390 * calculate the standard hash first, as the d_op->d_hash()
2391 * routine may choose to leave the hash value unchanged.
2392 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002393 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002394 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002395 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002396 if (unlikely(err < 0))
2397 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002398 }
Al Viro4f522a22013-02-11 23:20:37 -05002399 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002400}
Al Viro4f522a22013-02-11 23:20:37 -05002401EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002402
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403/*
2404 * When a file is deleted, we have two options:
2405 * - turn this dentry into a negative dentry
2406 * - unhash this dentry and free it.
2407 *
2408 * Usually, we want to just turn this into
2409 * a negative dentry, but if anybody else is
2410 * currently using the dentry or the inode
2411 * we can't do that and we fall back on removing
2412 * it from the hash queues and waiting for
2413 * it to be deleted later when it has no users
2414 */
2415
2416/**
2417 * d_delete - delete a dentry
2418 * @dentry: The dentry to delete
2419 *
2420 * Turn the dentry into a negative dentry if possible, otherwise
2421 * remove it from the hash queues so it can be deleted later
2422 */
2423
2424void d_delete(struct dentry * dentry)
2425{
Al Viroc19457f2018-02-23 21:02:31 -05002426 struct inode *inode = dentry->d_inode;
2427 int isdir = d_is_dir(dentry);
2428
2429 spin_lock(&inode->i_lock);
2430 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 /*
2432 * Are we the only user?
2433 */
Waiman Long98474232013-08-28 18:24:59 -07002434 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002435 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002436 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002437 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002439 spin_unlock(&dentry->d_lock);
2440 spin_unlock(&inode->i_lock);
2441 }
John McCutchan7a91bf72005-08-08 13:52:16 -04002442 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002444EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Al Viro15d3c582016-07-29 17:45:21 -04002446static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447{
Al Viro15d3c582016-07-29 17:45:21 -04002448 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002449
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002450 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002451 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002452 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453}
2454
2455/**
2456 * d_rehash - add an entry back to the hash
2457 * @entry: dentry to add to the hash
2458 *
2459 * Adds a dentry to the hash according to its name.
2460 */
2461
2462void d_rehash(struct dentry * entry)
2463{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002465 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002468EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469
Al Viro84e710d2016-04-15 00:58:55 -04002470static inline unsigned start_dir_add(struct inode *dir)
2471{
2472
2473 for (;;) {
2474 unsigned n = dir->i_dir_seq;
2475 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2476 return n;
2477 cpu_relax();
2478 }
2479}
2480
2481static inline void end_dir_add(struct inode *dir, unsigned n)
2482{
2483 smp_store_release(&dir->i_dir_seq, n + 2);
2484}
2485
Al Virod9171b92016-04-15 03:33:13 -04002486static void d_wait_lookup(struct dentry *dentry)
2487{
2488 if (d_in_lookup(dentry)) {
2489 DECLARE_WAITQUEUE(wait, current);
2490 add_wait_queue(dentry->d_wait, &wait);
2491 do {
2492 set_current_state(TASK_UNINTERRUPTIBLE);
2493 spin_unlock(&dentry->d_lock);
2494 schedule();
2495 spin_lock(&dentry->d_lock);
2496 } while (d_in_lookup(dentry));
2497 }
2498}
2499
Al Viro94bdd652016-04-15 02:42:04 -04002500struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002501 const struct qstr *name,
2502 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002503{
Al Viro94bdd652016-04-15 02:42:04 -04002504 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002505 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2506 struct hlist_bl_node *node;
2507 struct dentry *new = d_alloc(parent, name);
2508 struct dentry *dentry;
2509 unsigned seq, r_seq, d_seq;
2510
2511 if (unlikely(!new))
2512 return ERR_PTR(-ENOMEM);
2513
2514retry:
2515 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002516 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002517 r_seq = read_seqbegin(&rename_lock);
2518 dentry = __d_lookup_rcu(parent, name, &d_seq);
2519 if (unlikely(dentry)) {
2520 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2521 rcu_read_unlock();
2522 goto retry;
2523 }
2524 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2525 rcu_read_unlock();
2526 dput(dentry);
2527 goto retry;
2528 }
2529 rcu_read_unlock();
2530 dput(new);
2531 return dentry;
2532 }
2533 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2534 rcu_read_unlock();
2535 goto retry;
2536 }
Will Deacon015555f2018-02-19 14:55:54 +00002537
2538 if (unlikely(seq & 1)) {
2539 rcu_read_unlock();
2540 goto retry;
2541 }
2542
Al Viro94bdd652016-04-15 02:42:04 -04002543 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002544 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002545 hlist_bl_unlock(b);
2546 rcu_read_unlock();
2547 goto retry;
2548 }
Al Viro94bdd652016-04-15 02:42:04 -04002549 /*
2550 * No changes for the parent since the beginning of d_lookup().
2551 * Since all removals from the chain happen with hlist_bl_lock(),
2552 * any potential in-lookup matches are going to stay here until
2553 * we unlock the chain. All fields are stable in everything
2554 * we encounter.
2555 */
2556 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2557 if (dentry->d_name.hash != hash)
2558 continue;
2559 if (dentry->d_parent != parent)
2560 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002561 if (!d_same_name(dentry, parent, name))
2562 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002563 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002564 /* now we can try to grab a reference */
2565 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2566 rcu_read_unlock();
2567 goto retry;
2568 }
2569
2570 rcu_read_unlock();
2571 /*
2572 * somebody is likely to be still doing lookup for it;
2573 * wait for them to finish
2574 */
Al Virod9171b92016-04-15 03:33:13 -04002575 spin_lock(&dentry->d_lock);
2576 d_wait_lookup(dentry);
2577 /*
2578 * it's not in-lookup anymore; in principle we should repeat
2579 * everything from dcache lookup, but it's likely to be what
2580 * d_lookup() would've found anyway. If it is, just return it;
2581 * otherwise we really have to repeat the whole thing.
2582 */
2583 if (unlikely(dentry->d_name.hash != hash))
2584 goto mismatch;
2585 if (unlikely(dentry->d_parent != parent))
2586 goto mismatch;
2587 if (unlikely(d_unhashed(dentry)))
2588 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002589 if (unlikely(!d_same_name(dentry, parent, name)))
2590 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002591 /* OK, it *is* a hashed match; return it */
2592 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002593 dput(new);
2594 return dentry;
2595 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002596 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002597 /* we can't take ->d_lock here; it's OK, though. */
2598 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002599 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002600 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2601 hlist_bl_unlock(b);
2602 return new;
Al Virod9171b92016-04-15 03:33:13 -04002603mismatch:
2604 spin_unlock(&dentry->d_lock);
2605 dput(dentry);
2606 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002607}
2608EXPORT_SYMBOL(d_alloc_parallel);
2609
Al Viro85c7f812016-04-14 19:52:13 -04002610void __d_lookup_done(struct dentry *dentry)
2611{
Al Viro94bdd652016-04-15 02:42:04 -04002612 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2613 dentry->d_name.hash);
2614 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002615 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002616 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002617 wake_up_all(dentry->d_wait);
2618 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002619 hlist_bl_unlock(b);
2620 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002621 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002622}
2623EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002624
2625/* inode->i_lock held if inode is non-NULL */
2626
2627static inline void __d_add(struct dentry *dentry, struct inode *inode)
2628{
Al Viro84e710d2016-04-15 00:58:55 -04002629 struct inode *dir = NULL;
2630 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002631 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002632 if (unlikely(d_in_lookup(dentry))) {
2633 dir = dentry->d_parent->d_inode;
2634 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002635 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002636 }
Al Viroed782b52016-03-09 19:52:39 -05002637 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002638 unsigned add_flags = d_flags_for_inode(inode);
2639 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2640 raw_write_seqcount_begin(&dentry->d_seq);
2641 __d_set_inode_and_type(dentry, inode, add_flags);
2642 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002643 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002644 }
Al Viro15d3c582016-07-29 17:45:21 -04002645 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002646 if (dir)
2647 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002648 spin_unlock(&dentry->d_lock);
2649 if (inode)
2650 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002651}
2652
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002653/**
Al Viro34d0d192016-03-08 21:01:03 -05002654 * d_add - add dentry to hash queues
2655 * @entry: dentry to add
2656 * @inode: The inode to attach to this dentry
2657 *
2658 * This adds the entry to the hash queues and initializes @inode.
2659 * The entry was actually filled in earlier during d_alloc().
2660 */
2661
2662void d_add(struct dentry *entry, struct inode *inode)
2663{
Al Virob9680912016-04-11 00:53:26 -04002664 if (inode) {
2665 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002666 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002667 }
Al Viroed782b52016-03-09 19:52:39 -05002668 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002669}
2670EXPORT_SYMBOL(d_add);
2671
2672/**
Al Viro668d0cd2016-03-08 12:44:17 -05002673 * d_exact_alias - find and hash an exact unhashed alias
2674 * @entry: dentry to add
2675 * @inode: The inode to go with this dentry
2676 *
2677 * If an unhashed dentry with the same name/parent and desired
2678 * inode already exists, hash and return it. Otherwise, return
2679 * NULL.
2680 *
2681 * Parent directory should be locked.
2682 */
2683struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2684{
2685 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002686 unsigned int hash = entry->d_name.hash;
2687
2688 spin_lock(&inode->i_lock);
2689 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2690 /*
2691 * Don't need alias->d_lock here, because aliases with
2692 * d_parent == entry->d_parent are not subject to name or
2693 * parent changes, because the parent inode i_mutex is held.
2694 */
2695 if (alias->d_name.hash != hash)
2696 continue;
2697 if (alias->d_parent != entry->d_parent)
2698 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002699 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002700 continue;
2701 spin_lock(&alias->d_lock);
2702 if (!d_unhashed(alias)) {
2703 spin_unlock(&alias->d_lock);
2704 alias = NULL;
2705 } else {
2706 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002707 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002708 spin_unlock(&alias->d_lock);
2709 }
2710 spin_unlock(&inode->i_lock);
2711 return alias;
2712 }
2713 spin_unlock(&inode->i_lock);
2714 return NULL;
2715}
2716EXPORT_SYMBOL(d_exact_alias);
2717
2718/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002719 * dentry_update_name_case - update case insensitive dentry with a new name
2720 * @dentry: dentry to be updated
2721 * @name: new name
2722 *
2723 * Update a case insensitive dentry with new case of name.
2724 *
2725 * dentry must have been returned by d_lookup with name @name. Old and new
2726 * name lengths must match (ie. no d_compare which allows mismatched name
2727 * lengths).
2728 *
2729 * Parent inode i_mutex must be held over d_lookup and into this call (to
2730 * keep renames and concurrent inserts, and readdir(2) away).
2731 */
Al Viro9aba36d2016-07-20 22:28:45 -04002732void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002733{
Al Viro59551022016-01-22 15:40:57 -05002734 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002735 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2736
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002737 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002738 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002739 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002740 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002741 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002742}
2743EXPORT_SYMBOL(dentry_update_name_case);
2744
Al Viro8d85b482014-09-29 14:54:27 -04002745static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746{
Al Viro8d85b482014-09-29 14:54:27 -04002747 if (unlikely(dname_external(target))) {
2748 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749 /*
2750 * Both external: swap the pointers
2751 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002752 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 } else {
2754 /*
2755 * dentry:internal, target:external. Steal target's
2756 * storage and make target internal.
2757 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002758 memcpy(target->d_iname, dentry->d_name.name,
2759 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 dentry->d_name.name = target->d_name.name;
2761 target->d_name.name = target->d_iname;
2762 }
2763 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002764 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 /*
2766 * dentry:external, target:internal. Give dentry's
2767 * storage to target and make dentry internal
2768 */
2769 memcpy(dentry->d_iname, target->d_name.name,
2770 target->d_name.len + 1);
2771 target->d_name.name = dentry->d_name.name;
2772 dentry->d_name.name = dentry->d_iname;
2773 } else {
2774 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002775 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002777 unsigned int i;
2778 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2779 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2780 swap(((long *) &dentry->d_iname)[i],
2781 ((long *) &target->d_iname)[i]);
2782 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 }
2784 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002785 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786}
2787
Al Viro8d85b482014-09-29 14:54:27 -04002788static void copy_name(struct dentry *dentry, struct dentry *target)
2789{
2790 struct external_name *old_name = NULL;
2791 if (unlikely(dname_external(dentry)))
2792 old_name = external_name(dentry);
2793 if (unlikely(dname_external(target))) {
2794 atomic_inc(&external_name(target)->u.count);
2795 dentry->d_name = target->d_name;
2796 } else {
2797 memcpy(dentry->d_iname, target->d_name.name,
2798 target->d_name.len + 1);
2799 dentry->d_name.name = dentry->d_iname;
2800 dentry->d_name.hash_len = target->d_name.hash_len;
2801 }
2802 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2803 kfree_rcu(old_name, u.head);
2804}
2805
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002806static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2807{
2808 /*
2809 * XXXX: do we really need to take target->d_lock?
2810 */
2811 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2812 spin_lock(&target->d_parent->d_lock);
2813 else {
2814 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2815 spin_lock(&dentry->d_parent->d_lock);
2816 spin_lock_nested(&target->d_parent->d_lock,
2817 DENTRY_D_LOCK_NESTED);
2818 } else {
2819 spin_lock(&target->d_parent->d_lock);
2820 spin_lock_nested(&dentry->d_parent->d_lock,
2821 DENTRY_D_LOCK_NESTED);
2822 }
2823 }
2824 if (target < dentry) {
2825 spin_lock_nested(&target->d_lock, 2);
2826 spin_lock_nested(&dentry->d_lock, 3);
2827 } else {
2828 spin_lock_nested(&dentry->d_lock, 2);
2829 spin_lock_nested(&target->d_lock, 3);
2830 }
2831}
2832
Al Viro986c01942014-09-26 23:11:15 -04002833static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002834{
2835 if (target->d_parent != dentry->d_parent)
2836 spin_unlock(&dentry->d_parent->d_lock);
2837 if (target->d_parent != target)
2838 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002839 spin_unlock(&target->d_lock);
2840 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002841}
2842
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002844 * When switching names, the actual string doesn't strictly have to
2845 * be preserved in the target - because we're dropping the target
2846 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002847 * the new name before we switch, unless we are going to rehash
2848 * it. Note that if we *do* unhash the target, we are not allowed
2849 * to rehash it without giving it a new name/hash key - whether
2850 * we swap or overwrite the names here, resulting name won't match
2851 * the reality in filesystem; it's only there for d_path() purposes.
2852 * Note that all of this is happening under rename_lock, so the
2853 * any hash lookup seeing it in the middle of manipulations will
2854 * be discarded anyway. So we do not care what happens to the hash
2855 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002857/*
Al Viro18367502011-07-12 21:42:24 -04002858 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859 * @dentry: entry to move
2860 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002861 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862 *
2863 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002864 * dcache entries should not be moved in this way. Caller must hold
2865 * rename_lock, the i_mutex of the source and target directories,
2866 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002868static void __d_move(struct dentry *dentry, struct dentry *target,
2869 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870{
Al Viro84e710d2016-04-15 00:58:55 -04002871 struct inode *dir = NULL;
2872 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 if (!dentry->d_inode)
2874 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2875
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002876 BUG_ON(d_ancestor(dentry, target));
2877 BUG_ON(d_ancestor(target, dentry));
2878
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002879 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002880 if (unlikely(d_in_lookup(target))) {
2881 dir = target->d_parent->d_inode;
2882 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002883 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885
Nick Piggin31e6b012011-01-07 17:49:52 +11002886 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002887 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002888
Al Viro15d3c582016-07-29 17:45:21 -04002889 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002890 if (!d_unhashed(dentry))
2891 ___d_drop(dentry);
2892 if (!d_unhashed(target))
2893 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002896 if (exchange)
2897 swap_names(dentry, target);
2898 else
2899 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900
Al Viro15d3c582016-07-29 17:45:21 -04002901 /* rehash in new place(s) */
2902 __d_rehash(dentry);
2903 if (exchange)
2904 __d_rehash(target);
NeilBrown61647822017-11-10 15:45:41 +11002905 else
2906 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002907
Al Viro63cf4272014-09-26 23:06:14 -04002908 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002910 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002911 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912 dentry->d_parent = target->d_parent;
2913 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002914 list_del_init(&target->d_child);
2915 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002917 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002918 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002919 list_move(&target->d_child, &target->d_parent->d_subdirs);
2920 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002921 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002922 fsnotify_update_flags(target);
2923 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924 }
2925
Nick Piggin31e6b012011-01-07 17:49:52 +11002926 write_seqcount_end(&target->d_seq);
2927 write_seqcount_end(&dentry->d_seq);
2928
Al Viro84e710d2016-04-15 00:58:55 -04002929 if (dir)
2930 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002931 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002932}
2933
2934/*
2935 * d_move - move a dentry
2936 * @dentry: entry to move
2937 * @target: new dentry
2938 *
2939 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002940 * dcache entries should not be moved in this way. See the locking
2941 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002942 */
2943void d_move(struct dentry *dentry, struct dentry *target)
2944{
2945 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002946 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002948}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002949EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950
Miklos Szeredida1ce062014-04-01 17:08:43 +02002951/*
2952 * d_exchange - exchange two dentries
2953 * @dentry1: first dentry
2954 * @dentry2: second dentry
2955 */
2956void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2957{
2958 write_seqlock(&rename_lock);
2959
2960 WARN_ON(!dentry1->d_inode);
2961 WARN_ON(!dentry2->d_inode);
2962 WARN_ON(IS_ROOT(dentry1));
2963 WARN_ON(IS_ROOT(dentry2));
2964
2965 __d_move(dentry1, dentry2, true);
2966
2967 write_sequnlock(&rename_lock);
2968}
2969
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002970/**
2971 * d_ancestor - search for an ancestor
2972 * @p1: ancestor dentry
2973 * @p2: child dentry
2974 *
2975 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2976 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002977 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002978struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002979{
2980 struct dentry *p;
2981
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002982 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002983 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002984 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002985 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002986 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002987}
2988
2989/*
2990 * This helper attempts to cope with remotely renamed directories
2991 *
2992 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002993 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002994 *
2995 * Note: If ever the locking in lock_rename() changes, then please
2996 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002997 */
Al Virob5ae6b12014-10-12 22:16:02 -04002998static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002999 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07003000{
Al Viro9902af72016-04-15 15:08:36 -04003001 struct mutex *m1 = NULL;
3002 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05003003 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003004
3005 /* If alias and dentry share a parent, then no extra locks required */
3006 if (alias->d_parent == dentry->d_parent)
3007 goto out_unalias;
3008
Trond Myklebust9eaef272006-10-21 10:24:20 -07003009 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07003010 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
3011 goto out_err;
3012 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04003013 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07003014 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04003015 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003016out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07003017 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04003018 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003019out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07003020 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04003021 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003022 if (m1)
3023 mutex_unlock(m1);
3024 return ret;
3025}
3026
David Howells770bfad2006-08-22 20:06:07 -04003027/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003028 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3029 * @inode: the inode which may have a disconnected dentry
3030 * @dentry: a negative dentry which we want to point to the inode.
3031 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003032 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3033 * place of the given dentry and return it, else simply d_add the inode
3034 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003035 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003036 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3037 * we should error out: directories can't have multiple aliases.
3038 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003039 * This is needed in the lookup routine of any filesystem that is exportable
3040 * (via knfsd) so that we can build dcache paths to directories effectively.
3041 *
3042 * If a dentry was found and moved, then it is returned. Otherwise NULL
3043 * is returned. This matches the expected return value of ->lookup.
3044 *
3045 * Cluster filesystems may call this function with a negative, hashed dentry.
3046 * In that case, we know that the inode will be a regular file, and also this
3047 * will only occur during atomic_open. So we need to check for the dentry
3048 * being already hashed only in the final case.
3049 */
3050struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3051{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003052 if (IS_ERR(inode))
3053 return ERR_CAST(inode);
3054
David Howells770bfad2006-08-22 20:06:07 -04003055 BUG_ON(!d_unhashed(dentry));
3056
Al Virode689f52016-03-09 18:05:42 -05003057 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003058 goto out;
Al Virode689f52016-03-09 18:05:42 -05003059
Al Virob9680912016-04-11 00:53:26 -04003060 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003061 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003062 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003063 struct dentry *new = __d_find_any_alias(inode);
3064 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003065 /* The reference to new ensures it remains an alias */
3066 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003067 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003068 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003069 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003070 dput(new);
3071 new = ERR_PTR(-ELOOP);
3072 pr_warn_ratelimited(
3073 "VFS: Lookup of '%s' in %s %s"
3074 " would have caused loop\n",
3075 dentry->d_name.name,
3076 inode->i_sb->s_type->name,
3077 inode->i_sb->s_id);
3078 } else if (!IS_ROOT(new)) {
3079 int err = __d_unalias(inode, dentry, new);
3080 write_sequnlock(&rename_lock);
3081 if (err) {
3082 dput(new);
3083 new = ERR_PTR(err);
3084 }
Al Viro18367502011-07-12 21:42:24 -04003085 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003086 __d_move(new, dentry, false);
3087 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003088 }
Al Virob5ae6b12014-10-12 22:16:02 -04003089 iput(inode);
3090 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003091 }
David Howells770bfad2006-08-22 20:06:07 -04003092 }
Al Virob5ae6b12014-10-12 22:16:02 -04003093out:
Al Viroed782b52016-03-09 19:52:39 -05003094 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003095 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003096}
Al Virob5ae6b12014-10-12 22:16:02 -04003097EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003098
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003099static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003100{
3101 *buflen -= namelen;
3102 if (*buflen < 0)
3103 return -ENAMETOOLONG;
3104 *buffer -= namelen;
3105 memcpy(*buffer, str, namelen);
3106 return 0;
3107}
3108
Waiman Long232d2d62013-09-09 12:18:13 -04003109/**
3110 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003111 * @buffer: buffer pointer
3112 * @buflen: allocated length of the buffer
3113 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003114 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003115 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003116 * make sure that either the old or the new name pointer and length are
3117 * fetched. However, there may be mismatch between length and pointer.
3118 * The length cannot be trusted, we need to copy it byte-by-byte until
3119 * the length is reached or a null byte is found. It also prepends "/" at
3120 * the beginning of the name. The sequence number check at the caller will
3121 * retry it again when a d_move() does happen. So any garbage in the buffer
3122 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003123 *
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003124 * Load acquire is needed to make sure that we see that terminating NUL.
Waiman Long232d2d62013-09-09 12:18:13 -04003125 */
Al Viro9aba36d2016-07-20 22:28:45 -04003126static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003127{
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003128 const char *dname = smp_load_acquire(&name->name); /* ^^^ */
Mark Rutland66702eb2017-10-23 14:07:14 -07003129 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003130 char *p;
3131
Waiman Long232d2d62013-09-09 12:18:13 -04003132 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003133 if (*buflen < 0)
3134 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003135 p = *buffer -= dlen + 1;
3136 *p++ = '/';
3137 while (dlen--) {
3138 char c = *dname++;
3139 if (!c)
3140 break;
3141 *p++ = c;
3142 }
3143 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003144}
3145
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003147 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003148 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003149 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003150 * @buffer: pointer to the end of the buffer
3151 * @buflen: pointer to buffer length
3152 *
Waiman Long18129972013-09-12 10:55:35 -04003153 * The function will first try to write out the pathname without taking any
3154 * lock other than the RCU read lock to make sure that dentries won't go away.
3155 * It only checks the sequence number of the global rename_lock as any change
3156 * in the dentry's d_seq will be preceded by changes in the rename_lock
3157 * sequence number. If the sequence number had been changed, it will restart
3158 * the whole pathname back-tracing sequence again by taking the rename_lock.
3159 * In this case, there is no need to take the RCU read lock as the recursive
3160 * parent pointer references will keep the dentry chain alive as long as no
3161 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003162 */
Al Viro02125a82011-12-05 08:43:34 -05003163static int prepend_path(const struct path *path,
3164 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003165 char **buffer, int *buflen)
3166{
Al Viroede4ceb2013-11-13 07:45:40 -05003167 struct dentry *dentry;
3168 struct vfsmount *vfsmnt;
3169 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003170 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003171 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003172 char *bptr;
3173 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003174
Al Viro48f5ec22013-09-09 15:22:25 -04003175 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003176restart_mnt:
3177 read_seqbegin_or_lock(&mount_lock, &m_seq);
3178 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003179 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003180restart:
3181 bptr = *buffer;
3182 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003183 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003184 dentry = path->dentry;
3185 vfsmnt = path->mnt;
3186 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003187 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003188 while (dentry != root->dentry || vfsmnt != root->mnt) {
3189 struct dentry * parent;
3190
3191 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003192 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003193 /* Escaped? */
3194 if (dentry != vfsmnt->mnt_root) {
3195 bptr = *buffer;
3196 blen = *buflen;
3197 error = 3;
3198 break;
3199 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003200 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003201 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003202 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003203 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003204 vfsmnt = &mnt->mnt;
3205 continue;
3206 }
Waiman Long232d2d62013-09-09 12:18:13 -04003207 if (!error)
3208 error = is_mounted(vfsmnt) ? 1 : 2;
3209 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003210 }
3211 parent = dentry->d_parent;
3212 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003213 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003214 if (error)
3215 break;
3216
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003217 dentry = parent;
3218 }
Al Viro48f5ec22013-09-09 15:22:25 -04003219 if (!(seq & 1))
3220 rcu_read_unlock();
3221 if (need_seqretry(&rename_lock, seq)) {
3222 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003223 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003224 }
Al Viro48f5ec22013-09-09 15:22:25 -04003225 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003226
3227 if (!(m_seq & 1))
3228 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003229 if (need_seqretry(&mount_lock, m_seq)) {
3230 m_seq = 1;
3231 goto restart_mnt;
3232 }
3233 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003234
Waiman Long232d2d62013-09-09 12:18:13 -04003235 if (error >= 0 && bptr == *buffer) {
3236 if (--blen < 0)
3237 error = -ENAMETOOLONG;
3238 else
3239 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003240 }
Waiman Long232d2d62013-09-09 12:18:13 -04003241 *buffer = bptr;
3242 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003243 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003244}
3245
3246/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003247 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003248 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003249 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003250 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251 * @buflen: buffer length
3252 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003253 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003255 * Returns a pointer into the buffer or an error code if the
3256 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003257 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003258 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003259 *
Al Viro02125a82011-12-05 08:43:34 -05003260 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 */
Al Viro02125a82011-12-05 08:43:34 -05003262char *__d_path(const struct path *path,
3263 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003264 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003266 char *res = buf + buflen;
3267 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003269 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003270 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003271
Al Viro02125a82011-12-05 08:43:34 -05003272 if (error < 0)
3273 return ERR_PTR(error);
3274 if (error > 0)
3275 return NULL;
3276 return res;
3277}
3278
3279char *d_absolute_path(const struct path *path,
3280 char *buf, int buflen)
3281{
3282 struct path root = {};
3283 char *res = buf + buflen;
3284 int error;
3285
3286 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003287 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003288
3289 if (error > 1)
3290 error = -EINVAL;
3291 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003292 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003293 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294}
3295
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003296/*
3297 * same as __d_path but appends "(deleted)" for unlinked files.
3298 */
Al Viro02125a82011-12-05 08:43:34 -05003299static int path_with_deleted(const struct path *path,
3300 const struct path *root,
3301 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003302{
3303 prepend(buf, buflen, "\0", 1);
3304 if (d_unlinked(path->dentry)) {
3305 int error = prepend(buf, buflen, " (deleted)", 10);
3306 if (error)
3307 return error;
3308 }
3309
3310 return prepend_path(path, root, buf, buflen);
3311}
3312
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003313static int prepend_unreachable(char **buffer, int *buflen)
3314{
3315 return prepend(buffer, buflen, "(unreachable)", 13);
3316}
3317
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003318static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3319{
3320 unsigned seq;
3321
3322 do {
3323 seq = read_seqcount_begin(&fs->seq);
3324 *root = fs->root;
3325 } while (read_seqcount_retry(&fs->seq, seq));
3326}
3327
Jan Bluncka03a8a702008-02-14 19:38:32 -08003328/**
3329 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003330 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003331 * @buf: buffer to return value in
3332 * @buflen: buffer length
3333 *
3334 * Convert a dentry into an ASCII path name. If the entry has been deleted
3335 * the string " (deleted)" is appended. Note that this is ambiguous.
3336 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003337 * Returns a pointer into the buffer or an error code if the path was
3338 * too long. Note: Callers should use the returned pointer, not the passed
3339 * in buffer, to use the name! The implementation often starts at an offset
3340 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003341 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003342 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003343 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003344char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003346 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003347 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003348 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003350 /*
3351 * We have various synthetic filesystems that never get mounted. On
3352 * these filesystems dentries are never used for lookup purposes, and
3353 * thus don't need to be hashed. They also don't need a name until a
3354 * user wants to identify the object in /proc/pid/fd/. The little hack
3355 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003356 *
3357 * Some pseudo inodes are mountable. When they are mounted
3358 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3359 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003360 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003361 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3362 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003363 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003364
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003365 rcu_read_lock();
3366 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003367 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003368 rcu_read_unlock();
3369
Al Viro02125a82011-12-05 08:43:34 -05003370 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003371 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 return res;
3373}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003374EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003375
3376/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003377 * Helper function for dentry_operations.d_dname() members
3378 */
3379char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3380 const char *fmt, ...)
3381{
3382 va_list args;
3383 char temp[64];
3384 int sz;
3385
3386 va_start(args, fmt);
3387 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3388 va_end(args);
3389
3390 if (sz > sizeof(temp) || sz > buflen)
3391 return ERR_PTR(-ENAMETOOLONG);
3392
3393 buffer += buflen - sz;
3394 return memcpy(buffer, temp, sz);
3395}
3396
Al Viro118b2302013-08-24 12:08:17 -04003397char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3398{
3399 char *end = buffer + buflen;
3400 /* these dentries are never renamed, so d_lock is not needed */
3401 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003402 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003403 prepend(&end, &buflen, "/", 1))
3404 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003405 return end;
Al Viro118b2302013-08-24 12:08:17 -04003406}
David Herrmann31bbe162014-01-03 14:09:47 +01003407EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003408
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003409/*
Ram Pai6092d042008-03-27 13:06:20 +01003410 * Write full pathname from the root of the filesystem into the buffer.
3411 */
Al Virof6500802014-01-26 12:37:55 -05003412static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003413{
Al Virof6500802014-01-26 12:37:55 -05003414 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003415 char *end, *retval;
3416 int len, seq = 0;
3417 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003418
Al Virof6500802014-01-26 12:37:55 -05003419 if (buflen < 2)
3420 goto Elong;
3421
Al Viro48f5ec22013-09-09 15:22:25 -04003422 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003423restart:
Al Virof6500802014-01-26 12:37:55 -05003424 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003425 end = buf + buflen;
3426 len = buflen;
3427 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003428 /* Get '/' right */
3429 retval = end-1;
3430 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003431 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003432 while (!IS_ROOT(dentry)) {
3433 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003434
Ram Pai6092d042008-03-27 13:06:20 +01003435 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003436 error = prepend_name(&end, &len, &dentry->d_name);
3437 if (error)
3438 break;
Ram Pai6092d042008-03-27 13:06:20 +01003439
3440 retval = end;
3441 dentry = parent;
3442 }
Al Viro48f5ec22013-09-09 15:22:25 -04003443 if (!(seq & 1))
3444 rcu_read_unlock();
3445 if (need_seqretry(&rename_lock, seq)) {
3446 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003447 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003448 }
3449 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003450 if (error)
3451 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003452 return retval;
3453Elong:
3454 return ERR_PTR(-ENAMETOOLONG);
3455}
Nick Pigginec2447c2011-01-07 17:49:29 +11003456
3457char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3458{
Waiman Long232d2d62013-09-09 12:18:13 -04003459 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003460}
3461EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003462
3463char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3464{
3465 char *p = NULL;
3466 char *retval;
3467
Al Viroc1031352010-06-06 22:31:14 -04003468 if (d_unlinked(dentry)) {
3469 p = buf + buflen;
3470 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3471 goto Elong;
3472 buflen++;
3473 }
3474 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003475 if (!IS_ERR(retval) && p)
3476 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003477 return retval;
3478Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003479 return ERR_PTR(-ENAMETOOLONG);
3480}
3481
Linus Torvalds8b19e342013-09-12 10:35:47 -07003482static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3483 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003484{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003485 unsigned seq;
3486
3487 do {
3488 seq = read_seqcount_begin(&fs->seq);
3489 *root = fs->root;
3490 *pwd = fs->pwd;
3491 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003492}
3493
Ram Pai6092d042008-03-27 13:06:20 +01003494/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003495 * NOTE! The user-level library version returns a
3496 * character pointer. The kernel system call just
3497 * returns the length of the buffer filled (which
3498 * includes the ending '\0' character), or a negative
3499 * error value. So libc would do something like
3500 *
3501 * char *getcwd(char * buf, size_t size)
3502 * {
3503 * int retval;
3504 *
3505 * retval = sys_getcwd(buf, size);
3506 * if (retval >= 0)
3507 * return buf;
3508 * errno = -retval;
3509 * return NULL;
3510 * }
3511 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003512SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513{
Linus Torvalds552ce542007-02-13 12:08:18 -08003514 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003515 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003516 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003517
3518 if (!page)
3519 return -ENOMEM;
3520
Linus Torvalds8b19e342013-09-12 10:35:47 -07003521 rcu_read_lock();
3522 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523
Linus Torvalds552ce542007-02-13 12:08:18 -08003524 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003525 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003526 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003527 char *cwd = page + PATH_MAX;
3528 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003529
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003530 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003531 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003532 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003533
Al Viro02125a82011-12-05 08:43:34 -05003534 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003535 goto out;
3536
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003537 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003538 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003539 error = prepend_unreachable(&cwd, &buflen);
3540 if (error)
3541 goto out;
3542 }
3543
Linus Torvalds552ce542007-02-13 12:08:18 -08003544 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003545 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003546 if (len <= size) {
3547 error = len;
3548 if (copy_to_user(buf, cwd, len))
3549 error = -EFAULT;
3550 }
Nick Piggin949854d2011-01-07 17:49:37 +11003551 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003552 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554
3555out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003556 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557 return error;
3558}
3559
3560/*
3561 * Test whether new_dentry is a subdirectory of old_dentry.
3562 *
3563 * Trivially implemented using the dcache structure
3564 */
3565
3566/**
3567 * is_subdir - is new dentry a subdirectory of old_dentry
3568 * @new_dentry: new dentry
3569 * @old_dentry: old dentry
3570 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003571 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3572 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3574 */
3575
Yaowei Baia6e57872015-11-17 14:40:11 +08003576bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577{
Yaowei Baia6e57872015-11-17 14:40:11 +08003578 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003579 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003581 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003582 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003583
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003584 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003587 /*
3588 * Need rcu_readlock to protect against the d_parent trashing
3589 * due to d_move
3590 */
3591 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003592 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003593 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003594 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003595 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003596 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598
3599 return result;
3600}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003601EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003603static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003605 struct dentry *root = data;
3606 if (dentry != root) {
3607 if (d_unhashed(dentry) || !dentry->d_inode)
3608 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003609
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003610 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3611 dentry->d_flags |= DCACHE_GENOCIDE;
3612 dentry->d_lockref.count--;
3613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003615 return D_WALK_CONTINUE;
3616}
Nick Piggin58db63d2011-01-07 17:49:39 +11003617
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003618void d_genocide(struct dentry *parent)
3619{
3620 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621}
3622
Al Viro60545d02013-06-07 01:20:27 -04003623void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624{
Al Viro60545d02013-06-07 01:20:27 -04003625 inode_dec_link_count(inode);
3626 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003627 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003628 !d_unlinked(dentry));
3629 spin_lock(&dentry->d_parent->d_lock);
3630 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3631 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3632 (unsigned long long)inode->i_ino);
3633 spin_unlock(&dentry->d_lock);
3634 spin_unlock(&dentry->d_parent->d_lock);
3635 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636}
Al Viro60545d02013-06-07 01:20:27 -04003637EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638
3639static __initdata unsigned long dhash_entries;
3640static int __init set_dhash_entries(char *str)
3641{
3642 if (!str)
3643 return 0;
3644 dhash_entries = simple_strtoul(str, &str, 0);
3645 return 1;
3646}
3647__setup("dhash_entries=", set_dhash_entries);
3648
3649static void __init dcache_init_early(void)
3650{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651 /* If hashes are distributed across NUMA nodes, defer
3652 * hash allocation until vmalloc space is available.
3653 */
3654 if (hashdist)
3655 return;
3656
3657 dentry_hashtable =
3658 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003659 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660 dhash_entries,
3661 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003662 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003663 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003664 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003665 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003666 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003667 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003668}
3669
Denis Cheng74bf17c2007-10-16 23:26:30 -07003670static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003671{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003672 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003673 * A constructor could be added for stable state like the lists,
3674 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003675 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003676 */
David Windsor80344262017-06-10 22:50:44 -04003677 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3678 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3679 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003680
3681 /* Hash may have been set up in dcache_init_early */
3682 if (!hashdist)
3683 return;
3684
3685 dentry_hashtable =
3686 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003687 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003688 dhash_entries,
3689 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003690 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003691 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003692 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003693 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003694 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003695 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003696}
3697
3698/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003699struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003700EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003701
Linus Torvalds1da177e2005-04-16 15:20:36 -07003702EXPORT_SYMBOL(d_genocide);
3703
Linus Torvalds1da177e2005-04-16 15:20:36 -07003704void __init vfs_caches_init_early(void)
3705{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003706 int i;
3707
3708 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3709 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3710
Linus Torvalds1da177e2005-04-16 15:20:36 -07003711 dcache_init_early();
3712 inode_init_early();
3713}
3714
Mel Gorman4248b0d2015-08-06 15:46:20 -07003715void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003716{
David Windsor6a9b8822017-06-10 22:50:30 -04003717 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3718 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003719
Denis Cheng74bf17c2007-10-16 23:26:30 -07003720 dcache_init();
3721 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003722 files_init();
3723 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003724 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003725 bdev_cache_init();
3726 chrdev_init();
3727}