blob: 7c38f39958bc371d0324197968a732d68da927d8 [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 Howells07f3f05c2006-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 Torvalds6326c712012-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
443/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000444 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700445 */
446static void dentry_lru_add(struct dentry *dentry)
447{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400448 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
449 d_lru_add(dentry);
Josef Bacik563f4002017-04-18 16:04:17 -0400450 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
451 dentry->d_flags |= DCACHE_REFERENCED;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700452}
453
Miklos Szeredid52b9082007-05-08 00:23:46 -0700454/**
Nick Piggin789680d2011-01-07 17:49:30 +1100455 * d_drop - drop a dentry
456 * @dentry: dentry to drop
457 *
458 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
459 * be found through a VFS lookup any more. Note that this is different from
460 * deleting the dentry - d_delete will try to mark the dentry negative if
461 * possible, giving a successful _negative_ lookup, while d_drop will
462 * just make the cache lookup fail.
463 *
464 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
465 * reason (NFS timeouts or autofs deletes).
466 *
NeilBrown61647822017-11-10 15:45:41 +1100467 * __d_drop requires dentry->d_lock
468 * ___d_drop doesn't mark dentry as "unhashed"
469 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100470 */
NeilBrown61647822017-11-10 15:45:41 +1100471static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100472{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700473 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400474 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400475 /*
476 * Hashed dentries are normally on the dentry hashtable,
477 * with the exception of those newly allocated by
NeilBrownf1ee6162017-12-21 09:45:40 +1100478 * d_obtain_root, which are always IS_ROOT:
J. Bruce Fields7632e462012-06-28 12:10:55 -0400479 */
480 if (unlikely(IS_ROOT(dentry)))
NeilBrownf1ee6162017-12-21 09:45:40 +1100481 b = &dentry->d_sb->s_roots;
Al Virob61625d2013-10-04 11:09:01 -0400482 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700483 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400484
485 hlist_bl_lock(b);
486 __hlist_bl_del(&dentry->d_hash);
Al Virob61625d2013-10-04 11:09:01 -0400487 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400488 /* After this call, in-progress rcu-walk path lookup will fail. */
489 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100490 }
491}
NeilBrown61647822017-11-10 15:45:41 +1100492
493void __d_drop(struct dentry *dentry)
494{
495 ___d_drop(dentry);
496 dentry->d_hash.pprev = NULL;
497}
Nick Piggin789680d2011-01-07 17:49:30 +1100498EXPORT_SYMBOL(__d_drop);
499
500void d_drop(struct dentry *dentry)
501{
Nick Piggin789680d2011-01-07 17:49:30 +1100502 spin_lock(&dentry->d_lock);
503 __d_drop(dentry);
504 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100505}
506EXPORT_SYMBOL(d_drop);
507
Al Viroba65dc52016-06-10 11:32:47 -0400508static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
509{
510 struct dentry *next;
511 /*
512 * Inform d_walk() and shrink_dentry_list() that we are no longer
513 * attached to the dentry tree
514 */
515 dentry->d_flags |= DCACHE_DENTRY_KILLED;
516 if (unlikely(list_empty(&dentry->d_child)))
517 return;
518 __list_del_entry(&dentry->d_child);
519 /*
520 * Cursors can move around the list of children. While we'd been
521 * a normal list member, it didn't matter - ->d_child.next would've
522 * been updated. However, from now on it won't be and for the
523 * things like d_walk() it might end up with a nasty surprise.
524 * Normally d_walk() doesn't care about cursors moving around -
525 * ->d_lock on parent prevents that and since a cursor has no children
526 * of its own, we get through it without ever unlocking the parent.
527 * There is one exception, though - if we ascend from a child that
528 * gets killed as soon as we unlock it, the next sibling is found
529 * using the value left in its ->d_child.next. And if _that_
530 * pointed to a cursor, and cursor got moved (e.g. by lseek())
531 * before d_walk() regains parent->d_lock, we'll end up skipping
532 * everything the cursor had been moved past.
533 *
534 * Solution: make sure that the pointer left behind in ->d_child.next
535 * points to something that won't be moving around. I.e. skip the
536 * cursors.
537 */
538 while (dentry->d_child.next != &parent->d_subdirs) {
539 next = list_entry(dentry->d_child.next, struct dentry, d_child);
540 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
541 break;
542 dentry->d_child.next = next->d_child.next;
543 }
544}
545
Al Viroe55fd012014-05-28 13:51:12 -0400546static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100547{
Al Viro41edf272014-05-01 10:30:00 -0400548 struct dentry *parent = NULL;
549 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400550 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100551 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100552
Linus Torvalds0d984392013-09-08 13:46:52 -0700553 /*
554 * The dentry is now unrecoverably dead to the world.
555 */
556 lockref_mark_dead(&dentry->d_lockref);
557
Sage Weilf0023bc2011-10-28 10:02:42 -0700558 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700559 * inform the fs via d_prune that this dentry is about to be
560 * unhashed and destroyed.
561 */
Al Viro29266202014-05-30 11:39:02 -0400562 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800563 dentry->d_op->d_prune(dentry);
564
Al Viro01b60352014-04-29 23:42:52 -0400565 if (dentry->d_flags & DCACHE_LRU_LIST) {
566 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
567 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400568 }
Nick Piggin77812a12011-01-07 17:49:48 +1100569 /* if it was on the hash then remove it */
570 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400571 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400572 if (parent)
573 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400574 if (dentry->d_inode)
575 dentry_unlink_inode(dentry);
576 else
577 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400578 this_cpu_dec(nr_dentry);
579 if (dentry->d_op && dentry->d_op->d_release)
580 dentry->d_op->d_release(dentry);
581
Al Viro41edf272014-05-01 10:30:00 -0400582 spin_lock(&dentry->d_lock);
583 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
584 dentry->d_flags |= DCACHE_MAY_FREE;
585 can_free = false;
586 }
587 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400588 if (likely(can_free))
589 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400590}
591
592/*
593 * Finish off a dentry we've decided to kill.
594 * dentry->d_lock must be held, returns with it unlocked.
595 * If ref is non-zero, then decrement the refcount too.
596 * Returns dentry requiring refcount drop, or NULL if we're done.
597 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400598static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400599 __releases(dentry->d_lock)
600{
601 struct inode *inode = dentry->d_inode;
602 struct dentry *parent = NULL;
603
604 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
605 goto failed;
606
607 if (!IS_ROOT(dentry)) {
608 parent = dentry->d_parent;
609 if (unlikely(!spin_trylock(&parent->d_lock))) {
610 if (inode)
611 spin_unlock(&inode->i_lock);
612 goto failed;
613 }
614 }
615
616 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400617 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400618
619failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400620 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400621 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100622}
623
Al Viro046b9612014-05-29 08:54:52 -0400624static inline struct dentry *lock_parent(struct dentry *dentry)
625{
626 struct dentry *parent = dentry->d_parent;
627 if (IS_ROOT(dentry))
628 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800629 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400630 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400631 if (likely(spin_trylock(&parent->d_lock)))
632 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400633 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400634 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400635again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700636 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400637 spin_lock(&parent->d_lock);
638 /*
639 * We can't blindly lock dentry until we are sure
640 * that we won't violate the locking order.
641 * Any changes of dentry->d_parent must have
642 * been done with parent->d_lock held, so
643 * spin_lock() above is enough of a barrier
644 * for checking if it's still our child.
645 */
646 if (unlikely(parent != dentry->d_parent)) {
647 spin_unlock(&parent->d_lock);
648 goto again;
649 }
650 rcu_read_unlock();
651 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700652 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400653 else
654 parent = NULL;
655 return parent;
656}
657
Linus Torvalds360f5472015-01-09 15:19:03 -0800658/*
659 * Try to do a lockless dput(), and return whether that was successful.
660 *
661 * If unsuccessful, we return false, having already taken the dentry lock.
662 *
663 * The caller needs to hold the RCU read lock, so that the dentry is
664 * guaranteed to stay around even if the refcount goes down to zero!
665 */
666static inline bool fast_dput(struct dentry *dentry)
667{
668 int ret;
669 unsigned int d_flags;
670
671 /*
672 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100673 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800674 */
675 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
676 return lockref_put_or_lock(&dentry->d_lockref);
677
678 /*
679 * .. otherwise, we can try to just decrement the
680 * lockref optimistically.
681 */
682 ret = lockref_put_return(&dentry->d_lockref);
683
684 /*
685 * If the lockref_put_return() failed due to the lock being held
686 * by somebody else, the fast path has failed. We will need to
687 * get the lock, and then check the count again.
688 */
689 if (unlikely(ret < 0)) {
690 spin_lock(&dentry->d_lock);
691 if (dentry->d_lockref.count > 1) {
692 dentry->d_lockref.count--;
693 spin_unlock(&dentry->d_lock);
694 return 1;
695 }
696 return 0;
697 }
698
699 /*
700 * If we weren't the last ref, we're done.
701 */
702 if (ret)
703 return 1;
704
705 /*
706 * Careful, careful. The reference count went down
707 * to zero, but we don't hold the dentry lock, so
708 * somebody else could get it again, and do another
709 * dput(), and we need to not race with that.
710 *
711 * However, there is a very special and common case
712 * where we don't care, because there is nothing to
713 * do: the dentry is still hashed, it does not have
714 * a 'delete' op, and it's referenced and already on
715 * the LRU list.
716 *
717 * NOTE! Since we aren't locked, these values are
718 * not "stable". However, it is sufficient that at
719 * some point after we dropped the reference the
720 * dentry was hashed and the flags had the proper
721 * value. Other dentry users may have re-gotten
722 * a reference to the dentry and change that, but
723 * our work is done - we can leave the dentry
724 * around with a zero refcount.
725 */
726 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700727 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100728 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800729
730 /* Nothing to do? Dropping the reference was all we needed? */
731 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
732 return 1;
733
734 /*
735 * Not the fast normal case? Get the lock. We've already decremented
736 * the refcount, but we'll need to re-check the situation after
737 * getting the lock.
738 */
739 spin_lock(&dentry->d_lock);
740
741 /*
742 * Did somebody else grab a reference to it in the meantime, and
743 * we're no longer the last user after all? Alternatively, somebody
744 * else could have killed it and marked it dead. Either way, we
745 * don't need to do anything else.
746 */
747 if (dentry->d_lockref.count) {
748 spin_unlock(&dentry->d_lock);
749 return 1;
750 }
751
752 /*
753 * Re-get the reference we optimistically dropped. We hold the
754 * lock, and we just tested that it was zero, so we can just
755 * set it to 1.
756 */
757 dentry->d_lockref.count = 1;
758 return 0;
759}
760
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/*
763 * This is dput
764 *
765 * This is complicated by the fact that we do not want to put
766 * dentries that are no longer on any hash chain on the unused
767 * list: we'd much rather just get rid of them immediately.
768 *
769 * However, that implies that we have to traverse the dentry
770 * tree upwards to the parents which might _also_ now be
771 * scheduled for deletion (it may have been only waiting for
772 * its last child to go away).
773 *
774 * This tail recursion is done by hand as we don't want to depend
775 * on the compiler to always get this right (gcc generally doesn't).
776 * Real recursion would eat up our stack space.
777 */
778
779/*
780 * dput - release a dentry
781 * @dentry: dentry to release
782 *
783 * Release a dentry. This will drop the usage count and if appropriate
784 * call the dentry unlink method as well as removing it from the queues and
785 * releasing its resources. If the parent dentries were scheduled for release
786 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788void dput(struct dentry *dentry)
789{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700790 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 return;
792
793repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800794 might_sleep();
795
Linus Torvalds360f5472015-01-09 15:19:03 -0800796 rcu_read_lock();
797 if (likely(fast_dput(dentry))) {
798 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800800 }
801
802 /* Slow case: now with the dentry lock held */
803 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Al Viro85c7f812016-04-14 19:52:13 -0400805 WARN_ON(d_in_lookup(dentry));
806
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700807 /* Unreachable? Get rid of it */
808 if (unlikely(d_unhashed(dentry)))
809 goto kill_it;
810
Al Viro75a6f822015-07-08 02:42:38 +0100811 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
812 goto kill_it;
813
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700814 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100816 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 }
Nick Piggin265ac902010-10-10 05:36:24 -0400818
Christoph Hellwiga4633352010-10-10 05:36:26 -0400819 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400820
Waiman Long98474232013-08-28 18:24:59 -0700821 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100822 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return;
824
Miklos Szeredid52b9082007-05-08 00:23:46 -0700825kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400826 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800827 if (dentry) {
828 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700829 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800830 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700832EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100835/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100836static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837{
Waiman Long98474232013-08-28 18:24:59 -0700838 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839}
840
Nick Piggindc0474b2011-01-07 17:49:43 +1100841static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100842{
Waiman Long98474232013-08-28 18:24:59 -0700843 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100844}
845
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100846struct dentry *dget_parent(struct dentry *dentry)
847{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700848 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100849 struct dentry *ret;
850
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700851 /*
852 * Do optimistic parent lookup without any
853 * locking.
854 */
855 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700856 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700857 gotref = lockref_get_not_zero(&ret->d_lockref);
858 rcu_read_unlock();
859 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700860 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700861 return ret;
862 dput(ret);
863 }
864
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100865repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100866 /*
867 * Don't need rcu_dereference because we re-check it was correct under
868 * the lock.
869 */
870 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100871 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100872 spin_lock(&ret->d_lock);
873 if (unlikely(ret != dentry->d_parent)) {
874 spin_unlock(&ret->d_lock);
875 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100876 goto repeat;
877 }
Nick Piggina734eb42011-01-07 17:49:44 +1100878 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700879 BUG_ON(!ret->d_lockref.count);
880 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100881 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100882 return ret;
883}
884EXPORT_SYMBOL(dget_parent);
885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886/**
887 * d_find_alias - grab a hashed alias of inode
888 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 *
890 * If inode has a hashed alias, or is a directory and has any alias,
891 * acquire the reference to alias and return it. Otherwise return NULL.
892 * Notice that if inode is a directory there can be only one alias and
893 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800894 * of a filesystem, or if the directory was renamed and d_revalidate
895 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700897 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500898 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500900static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901{
Nick Pigginda502952011-01-07 17:49:33 +1100902 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Nick Pigginda502952011-01-07 17:49:33 +1100904again:
905 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400906 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100907 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700909 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100910 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500912 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100913 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100914 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return alias;
916 }
917 }
Nick Pigginda502952011-01-07 17:49:33 +1100918 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 }
Nick Pigginda502952011-01-07 17:49:33 +1100920 if (discon_alias) {
921 alias = discon_alias;
922 spin_lock(&alias->d_lock);
923 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500924 __dget_dlock(alias);
925 spin_unlock(&alias->d_lock);
926 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100927 }
928 spin_unlock(&alias->d_lock);
929 goto again;
930 }
931 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}
933
Nick Pigginda502952011-01-07 17:49:33 +1100934struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
David Howells214fda12006-03-25 03:06:36 -0800936 struct dentry *de = NULL;
937
Al Virob3d9b7a2012-06-09 13:51:19 -0400938 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100939 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500940 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100941 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800942 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 return de;
944}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700945EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
947/*
948 * Try to kill dentries associated with this inode.
949 * WARNING: you must own a reference to inode.
950 */
951void d_prune_aliases(struct inode *inode)
952{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700953 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100955 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400956 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700958 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400959 struct dentry *parent = lock_parent(dentry);
960 if (likely(!dentry->d_lockref.count)) {
961 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800962 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400963 goto restart;
964 }
965 if (parent)
966 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 }
968 spin_unlock(&dentry->d_lock);
969 }
Nick Piggin873feea2011-01-07 17:50:06 +1100970 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700972EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400974static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
Al Viro5c47e6d2014-04-29 16:13:18 -0400976 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700977
Miklos Szeredi60942f22014-05-02 15:38:39 -0400978 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400979 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400980 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100981 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400982 parent = lock_parent(dentry);
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000985 * The dispose list is isolated and dentries are not accounted
986 * to the LRU here, so we can simply remove it from the list
987 * here regardless of whether it is referenced or not.
988 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400989 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000990
991 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000993 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800995 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700996 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400997 if (parent)
998 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 continue;
1000 }
Nick Piggin77812a12011-01-07 17:49:48 +11001001
Al Viro64fd72e2014-05-28 09:48:44 -04001002
1003 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1004 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1005 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001006 if (parent)
1007 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001008 if (can_free)
1009 dentry_free(dentry);
1010 continue;
1011 }
1012
Al Viroff2fde92014-05-28 13:59:13 -04001013 inode = dentry->d_inode;
1014 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001015 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001016 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001017 if (parent)
1018 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001019 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001020 }
Al Viroff2fde92014-05-28 13:59:13 -04001021
Al Viroff2fde92014-05-28 13:59:13 -04001022 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001023
Al Viro5c47e6d2014-04-29 16:13:18 -04001024 /*
1025 * We need to prune ancestors too. This is necessary to prevent
1026 * quadratic behavior of shrink_dcache_parent(), but is also
1027 * expected to be beneficial in reducing dentry cache
1028 * fragmentation.
1029 */
1030 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001031 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1032 parent = lock_parent(dentry);
1033 if (dentry->d_lockref.count != 1) {
1034 dentry->d_lockref.count--;
1035 spin_unlock(&dentry->d_lock);
1036 if (parent)
1037 spin_unlock(&parent->d_lock);
1038 break;
1039 }
1040 inode = dentry->d_inode; /* can't be NULL */
1041 if (unlikely(!spin_trylock(&inode->i_lock))) {
1042 spin_unlock(&dentry->d_lock);
1043 if (parent)
1044 spin_unlock(&parent->d_lock);
1045 cpu_relax();
1046 continue;
1047 }
1048 __dentry_kill(dentry);
1049 dentry = parent;
1050 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001052}
1053
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001054static enum lru_status dentry_lru_isolate(struct list_head *item,
1055 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001056{
1057 struct list_head *freeable = arg;
1058 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1059
1060
1061 /*
1062 * we are inverting the lru lock/dentry->d_lock here,
1063 * so use a trylock. If we fail to get the lock, just skip
1064 * it
1065 */
1066 if (!spin_trylock(&dentry->d_lock))
1067 return LRU_SKIP;
1068
1069 /*
1070 * Referenced dentries are still in use. If they have active
1071 * counts, just remove them from the LRU. Otherwise give them
1072 * another pass through the LRU.
1073 */
1074 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001075 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001076 spin_unlock(&dentry->d_lock);
1077 return LRU_REMOVED;
1078 }
1079
1080 if (dentry->d_flags & DCACHE_REFERENCED) {
1081 dentry->d_flags &= ~DCACHE_REFERENCED;
1082 spin_unlock(&dentry->d_lock);
1083
1084 /*
1085 * The list move itself will be made by the common LRU code. At
1086 * this point, we've dropped the dentry->d_lock but keep the
1087 * lru lock. This is safe to do, since every list movement is
1088 * protected by the lru lock even if both locks are held.
1089 *
1090 * This is guaranteed by the fact that all LRU management
1091 * functions are intermediated by the LRU API calls like
1092 * list_lru_add and list_lru_del. List movement in this file
1093 * only ever occur through this functions or through callbacks
1094 * like this one, that are called from the LRU API.
1095 *
1096 * The only exceptions to this are functions like
1097 * shrink_dentry_list, and code that first checks for the
1098 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1099 * operating only with stack provided lists after they are
1100 * properly isolated from the main list. It is thus, always a
1101 * local access.
1102 */
1103 return LRU_ROTATE;
1104 }
1105
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001106 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001107 spin_unlock(&dentry->d_lock);
1108
1109 return LRU_REMOVED;
1110}
1111
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001112/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001113 * prune_dcache_sb - shrink the dcache
1114 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001115 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001116 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001117 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1118 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001119 * function.
1120 *
1121 * This function may fail to free any resources if all the dentries are in
1122 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001123 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001124long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001125{
Dave Chinnerf6041562013-08-28 10:18:00 +10001126 LIST_HEAD(dispose);
1127 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128
Vladimir Davydov503c3582015-02-12 14:58:47 -08001129 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1130 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001131 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001132 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133}
1134
Glauber Costa4e717f52013-08-28 10:18:03 +10001135static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001136 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001137{
Glauber Costa4e717f52013-08-28 10:18:03 +10001138 struct list_head *freeable = arg;
1139 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001140
Glauber Costa4e717f52013-08-28 10:18:03 +10001141 /*
1142 * we are inverting the lru lock/dentry->d_lock here,
1143 * so use a trylock. If we fail to get the lock, just skip
1144 * it
1145 */
1146 if (!spin_trylock(&dentry->d_lock))
1147 return LRU_SKIP;
1148
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001149 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001150 spin_unlock(&dentry->d_lock);
1151
1152 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001153}
1154
Glauber Costa4e717f52013-08-28 10:18:03 +10001155
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001156/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 * shrink_dcache_sb - shrink dcache for a superblock
1158 * @sb: superblock
1159 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001160 * Shrink the dcache for the specified super block. This is used to free
1161 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001163void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164{
Glauber Costa4e717f52013-08-28 10:18:03 +10001165 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001166
Glauber Costa4e717f52013-08-28 10:18:03 +10001167 do {
1168 LIST_HEAD(dispose);
1169
1170 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001171 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001172
1173 this_cpu_sub(nr_dentry_unused, freed);
1174 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001175 cond_resched();
1176 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001178EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001181 * enum d_walk_ret - action to talke during tree walk
1182 * @D_WALK_CONTINUE: contrinue walk
1183 * @D_WALK_QUIT: quit walk
1184 * @D_WALK_NORETRY: quit when retry is needed
1185 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001187enum d_walk_ret {
1188 D_WALK_CONTINUE,
1189 D_WALK_QUIT,
1190 D_WALK_NORETRY,
1191 D_WALK_SKIP,
1192};
1193
1194/**
1195 * d_walk - walk the dentry tree
1196 * @parent: start of walk
1197 * @data: data passed to @enter() and @finish()
1198 * @enter: callback when first entering the dentry
1199 * @finish: callback when successfully finished the walk
1200 *
1201 * The @enter() and @finish() callbacks are called with d_lock held.
1202 */
1203static void d_walk(struct dentry *parent, void *data,
1204 enum d_walk_ret (*enter)(void *, struct dentry *),
1205 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206{
Nick Piggin949854d2011-01-07 17:49:37 +11001207 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001209 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001210 enum d_walk_ret ret;
1211 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001212
Nick Piggin58db63d2011-01-07 17:49:39 +11001213again:
Al Viro48f5ec22013-09-09 15:22:25 -04001214 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001215 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001216 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001217
1218 ret = enter(data, this_parent);
1219 switch (ret) {
1220 case D_WALK_CONTINUE:
1221 break;
1222 case D_WALK_QUIT:
1223 case D_WALK_SKIP:
1224 goto out_unlock;
1225 case D_WALK_NORETRY:
1226 retry = false;
1227 break;
1228 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229repeat:
1230 next = this_parent->d_subdirs.next;
1231resume:
1232 while (next != &this_parent->d_subdirs) {
1233 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001234 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001236
Al Viroba65dc52016-06-10 11:32:47 -04001237 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1238 continue;
1239
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001240 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001241
1242 ret = enter(data, dentry);
1243 switch (ret) {
1244 case D_WALK_CONTINUE:
1245 break;
1246 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001247 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001248 goto out_unlock;
1249 case D_WALK_NORETRY:
1250 retry = false;
1251 break;
1252 case D_WALK_SKIP:
1253 spin_unlock(&dentry->d_lock);
1254 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001255 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001258 spin_unlock(&this_parent->d_lock);
1259 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001261 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 goto repeat;
1263 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001264 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 }
1266 /*
1267 * All done at this level ... ascend and resume the search.
1268 */
Al Viroca5358e2014-10-26 19:31:10 -04001269 rcu_read_lock();
1270ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001272 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001273 this_parent = child->d_parent;
1274
Al Viro31dec132013-10-25 17:04:27 -04001275 spin_unlock(&child->d_lock);
1276 spin_lock(&this_parent->d_lock);
1277
Al Viroca5358e2014-10-26 19:31:10 -04001278 /* might go back up the wrong parent if we have had a rename. */
1279 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001280 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001281 /* go into the first sibling still alive */
1282 do {
1283 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001284 if (next == &this_parent->d_subdirs)
1285 goto ascend;
1286 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001287 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001288 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 goto resume;
1290 }
Al Viroca5358e2014-10-26 19:31:10 -04001291 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001292 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001293 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001294 if (finish)
1295 finish(data);
1296
1297out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001298 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001299 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001300 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001301
1302rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001303 spin_unlock(&this_parent->d_lock);
1304 rcu_read_unlock();
1305 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001306 if (!retry)
1307 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001308 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001309 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001311
Ian Kent01619492016-11-24 08:03:41 +11001312struct check_mount {
1313 struct vfsmount *mnt;
1314 unsigned int mounted;
1315};
1316
1317static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1318{
1319 struct check_mount *info = data;
1320 struct path path = { .mnt = info->mnt, .dentry = dentry };
1321
1322 if (likely(!d_mountpoint(dentry)))
1323 return D_WALK_CONTINUE;
1324 if (__path_is_mountpoint(&path)) {
1325 info->mounted = 1;
1326 return D_WALK_QUIT;
1327 }
1328 return D_WALK_CONTINUE;
1329}
1330
1331/**
1332 * path_has_submounts - check for mounts over a dentry in the
1333 * current namespace.
1334 * @parent: path to check.
1335 *
1336 * Return true if the parent or its subdirectories contain
1337 * a mount point in the current namespace.
1338 */
1339int path_has_submounts(const struct path *parent)
1340{
1341 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1342
1343 read_seqlock_excl(&mount_lock);
1344 d_walk(parent->dentry, &data, path_check_mount, NULL);
1345 read_sequnlock_excl(&mount_lock);
1346
1347 return data.mounted;
1348}
1349EXPORT_SYMBOL(path_has_submounts);
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001352 * Called by mount code to set a mountpoint and check if the mountpoint is
1353 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1354 * subtree can become unreachable).
1355 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001356 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001357 * this reason take rename_lock and d_lock on dentry and ancestors.
1358 */
1359int d_set_mounted(struct dentry *dentry)
1360{
1361 struct dentry *p;
1362 int ret = -ENOENT;
1363 write_seqlock(&rename_lock);
1364 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001365 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001366 spin_lock(&p->d_lock);
1367 if (unlikely(d_unhashed(p))) {
1368 spin_unlock(&p->d_lock);
1369 goto out;
1370 }
1371 spin_unlock(&p->d_lock);
1372 }
1373 spin_lock(&dentry->d_lock);
1374 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001375 ret = -EBUSY;
1376 if (!d_mountpoint(dentry)) {
1377 dentry->d_flags |= DCACHE_MOUNTED;
1378 ret = 0;
1379 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001380 }
1381 spin_unlock(&dentry->d_lock);
1382out:
1383 write_sequnlock(&rename_lock);
1384 return ret;
1385}
1386
1387/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001388 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 * and move any unused dentries to the end of the unused
1390 * list for prune_dcache(). We descend to the next level
1391 * whenever the d_subdirs list is non-empty and continue
1392 * searching.
1393 *
1394 * It returns zero iff there are no unused children,
1395 * otherwise it returns the number of children moved to
1396 * the end of the unused list. This may not be the total
1397 * number of unused children, because select_parent can
1398 * drop the lock and return early due to latency
1399 * constraints.
1400 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001401
1402struct select_data {
1403 struct dentry *start;
1404 struct list_head dispose;
1405 int found;
1406};
1407
1408static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001410 struct select_data *data = _data;
1411 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001413 if (data->start == dentry)
1414 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Al Virofe915222014-05-03 00:02:25 -04001416 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001417 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001418 } else {
1419 if (dentry->d_flags & DCACHE_LRU_LIST)
1420 d_lru_del(dentry);
1421 if (!dentry->d_lockref.count) {
1422 d_shrink_add(dentry, &data->dispose);
1423 data->found++;
1424 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 }
1426 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001427 * We can return to the caller if we have found some (this
1428 * ensures forward progress). We'll be coming back to find
1429 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 */
Al Virofe915222014-05-03 00:02:25 -04001431 if (!list_empty(&data->dispose))
1432 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001434 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435}
1436
1437/**
1438 * shrink_dcache_parent - prune dcache
1439 * @parent: parent of entries to prune
1440 *
1441 * Prune the dcache to remove unused children of the parent dentry.
1442 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001443void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001445 for (;;) {
1446 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001448 INIT_LIST_HEAD(&data.dispose);
1449 data.start = parent;
1450 data.found = 0;
1451
1452 d_walk(parent, &data, select_collect, NULL);
1453 if (!data.found)
1454 break;
1455
1456 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001457 cond_resched();
1458 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001460EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Al Viro9c8c10e2014-05-02 20:36:10 -04001462static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001463{
Al Viro9c8c10e2014-05-02 20:36:10 -04001464 /* it has busy descendents; complain about those instead */
1465 if (!list_empty(&dentry->d_subdirs))
1466 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001467
Al Viro9c8c10e2014-05-02 20:36:10 -04001468 /* root with refcount 1 is fine */
1469 if (dentry == _data && dentry->d_lockref.count == 1)
1470 return D_WALK_CONTINUE;
1471
1472 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1473 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001474 dentry,
1475 dentry->d_inode ?
1476 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001477 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001478 dentry->d_lockref.count,
1479 dentry->d_sb->s_type->name,
1480 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001481 WARN_ON(1);
1482 return D_WALK_CONTINUE;
1483}
1484
1485static void do_one_tree(struct dentry *dentry)
1486{
1487 shrink_dcache_parent(dentry);
1488 d_walk(dentry, dentry, umount_check, NULL);
1489 d_drop(dentry);
1490 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001491}
1492
1493/*
1494 * destroy the dentries attached to a superblock on unmounting
1495 */
1496void shrink_dcache_for_umount(struct super_block *sb)
1497{
1498 struct dentry *dentry;
1499
Al Viro9c8c10e2014-05-02 20:36:10 -04001500 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001501
1502 dentry = sb->s_root;
1503 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001504 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001505
NeilBrownf1ee6162017-12-21 09:45:40 +11001506 while (!hlist_bl_empty(&sb->s_roots)) {
1507 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001508 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001509 }
1510}
1511
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001512struct detach_data {
1513 struct select_data select;
1514 struct dentry *mountpoint;
1515};
1516static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001517{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001518 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001519
1520 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001521 __dget_dlock(dentry);
1522 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001523 return D_WALK_QUIT;
1524 }
1525
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001526 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527}
1528
1529static void check_and_drop(void *_data)
1530{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001531 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001532
Al Viro81be24d2017-06-03 07:20:09 +01001533 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001535}
1536
1537/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001538 * d_invalidate - detach submounts, prune dcache, and drop
1539 * @dentry: dentry to invalidate (aka detach, prune and drop)
1540 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001541 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001542 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001543 * The final d_drop is done as an atomic operation relative to
1544 * rename_lock ensuring there are no races with d_set_mounted. This
1545 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001546 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001547void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001548{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001549 /*
1550 * If it's already been dropped, return OK.
1551 */
1552 spin_lock(&dentry->d_lock);
1553 if (d_unhashed(dentry)) {
1554 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001555 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001556 }
1557 spin_unlock(&dentry->d_lock);
1558
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001559 /* Negative dentries can be dropped without further checks */
1560 if (!dentry->d_inode) {
1561 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001562 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001563 }
1564
1565 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001566 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001567
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001568 data.mountpoint = NULL;
1569 INIT_LIST_HEAD(&data.select.dispose);
1570 data.select.start = dentry;
1571 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001572
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001573 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001574
Al Viro81be24d2017-06-03 07:20:09 +01001575 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001576 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001577 else if (!data.mountpoint)
1578 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001579
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001580 if (data.mountpoint) {
1581 detach_mounts(data.mountpoint);
1582 dput(data.mountpoint);
1583 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001584 cond_resched();
1585 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001586}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001587EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001588
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589/**
Al Viroa4464db2011-07-07 15:03:58 -04001590 * __d_alloc - allocate a dcache entry
1591 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 * @name: qstr of the name
1593 *
1594 * Allocates a dentry. It returns %NULL if there is insufficient memory
1595 * available. On a success the dentry is returned. The name passed in is
1596 * copied and the copy passed in may be reused after this call.
1597 */
1598
Al Viroa4464db2011-07-07 15:03:58 -04001599struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600{
1601 struct dentry *dentry;
1602 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001603 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
Mel Gormane12ba742007-10-16 01:25:52 -07001605 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 if (!dentry)
1607 return NULL;
1608
Linus Torvalds6326c712012-05-21 16:14:04 -07001609 /*
1610 * We guarantee that the inline name is always NUL-terminated.
1611 * This way the memcpy() done by the name switching in rename
1612 * will still always have a NUL at the end, even if we might
1613 * be overwriting an internal NUL character
1614 */
1615 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001616 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001617 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001618 dname = dentry->d_iname;
1619 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001620 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001621 struct external_name *p = kmalloc(size + name->len,
1622 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001623 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 kmem_cache_free(dentry_cache, dentry);
1625 return NULL;
1626 }
Al Viro8d85b482014-09-29 14:54:27 -04001627 atomic_set(&p->u.count, 1);
1628 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 } else {
1630 dname = dentry->d_iname;
1631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
1633 dentry->d_name.len = name->len;
1634 dentry->d_name.hash = name->hash;
1635 memcpy(dname, name->name, name->len);
1636 dname[name->len] = 0;
1637
Linus Torvalds6326c712012-05-21 16:14:04 -07001638 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001639 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c712012-05-21 16:14:04 -07001640
Waiman Long98474232013-08-28 18:24:59 -07001641 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001642 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001644 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001646 dentry->d_parent = dentry;
1647 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 dentry->d_op = NULL;
1649 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001650 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 INIT_LIST_HEAD(&dentry->d_lru);
1652 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001653 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1654 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001655 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Miklos Szeredi285b1022016-06-28 11:47:32 +02001657 if (dentry->d_op && dentry->d_op->d_init) {
1658 err = dentry->d_op->d_init(dentry);
1659 if (err) {
1660 if (dname_external(dentry))
1661 kfree(external_name(dentry));
1662 kmem_cache_free(dentry_cache, dentry);
1663 return NULL;
1664 }
1665 }
1666
Nick Piggin3e880fb2011-01-07 17:49:19 +11001667 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 return dentry;
1670}
Al Viroa4464db2011-07-07 15:03:58 -04001671
1672/**
1673 * d_alloc - allocate a dcache entry
1674 * @parent: parent of entry to allocate
1675 * @name: qstr of the name
1676 *
1677 * Allocates a dentry. It returns %NULL if there is insufficient memory
1678 * available. On a success the dentry is returned. The name passed in is
1679 * copied and the copy passed in may be reused after this call.
1680 */
1681struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1682{
1683 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1684 if (!dentry)
1685 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001686 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001687 spin_lock(&parent->d_lock);
1688 /*
1689 * don't need child lock because it is not subject
1690 * to concurrency here
1691 */
1692 __dget_dlock(parent);
1693 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001694 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001695 spin_unlock(&parent->d_lock);
1696
1697 return dentry;
1698}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001699EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Miklos Szeredif9c34672018-01-19 11:39:52 +01001701struct dentry *d_alloc_anon(struct super_block *sb)
1702{
1703 return __d_alloc(sb, NULL);
1704}
1705EXPORT_SYMBOL(d_alloc_anon);
1706
Al Viroba65dc52016-06-10 11:32:47 -04001707struct dentry *d_alloc_cursor(struct dentry * parent)
1708{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001709 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001710 if (dentry) {
1711 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1712 dentry->d_parent = dget(parent);
1713 }
1714 return dentry;
1715}
1716
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001717/**
1718 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1719 * @sb: the superblock
1720 * @name: qstr of the name
1721 *
1722 * For a filesystem that just pins its dentries in memory and never
1723 * performs lookups at all, return an unhashed IS_ROOT dentry.
1724 */
Nick Piggin4b936882011-01-07 17:50:07 +11001725struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1726{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001727 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001728}
1729EXPORT_SYMBOL(d_alloc_pseudo);
1730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1732{
1733 struct qstr q;
1734
1735 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001736 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 return d_alloc(parent, &q);
1738}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001739EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740
Nick Pigginfb045ad2011-01-07 17:49:55 +11001741void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1742{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001743 WARN_ON_ONCE(dentry->d_op);
1744 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001745 DCACHE_OP_COMPARE |
1746 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001747 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001748 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001749 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001750 dentry->d_op = op;
1751 if (!op)
1752 return;
1753 if (op->d_hash)
1754 dentry->d_flags |= DCACHE_OP_HASH;
1755 if (op->d_compare)
1756 dentry->d_flags |= DCACHE_OP_COMPARE;
1757 if (op->d_revalidate)
1758 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001759 if (op->d_weak_revalidate)
1760 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001761 if (op->d_delete)
1762 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001763 if (op->d_prune)
1764 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001765 if (op->d_real)
1766 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001767
1768}
1769EXPORT_SYMBOL(d_set_d_op);
1770
David Howellsdf1a0852015-01-29 12:02:28 +00001771
1772/*
1773 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1774 * @dentry - The dentry to mark
1775 *
1776 * Mark a dentry as falling through to the lower layer (as set with
1777 * d_pin_lower()). This flag may be recorded on the medium.
1778 */
1779void d_set_fallthru(struct dentry *dentry)
1780{
1781 spin_lock(&dentry->d_lock);
1782 dentry->d_flags |= DCACHE_FALLTHRU;
1783 spin_unlock(&dentry->d_lock);
1784}
1785EXPORT_SYMBOL(d_set_fallthru);
1786
David Howellsb18825a2013-09-12 19:22:53 +01001787static unsigned d_flags_for_inode(struct inode *inode)
1788{
David Howells44bdb5e2015-01-29 12:02:29 +00001789 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001790
1791 if (!inode)
1792 return DCACHE_MISS_TYPE;
1793
1794 if (S_ISDIR(inode->i_mode)) {
1795 add_flags = DCACHE_DIRECTORY_TYPE;
1796 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1797 if (unlikely(!inode->i_op->lookup))
1798 add_flags = DCACHE_AUTODIR_TYPE;
1799 else
1800 inode->i_opflags |= IOP_LOOKUP;
1801 }
David Howells44bdb5e2015-01-29 12:02:29 +00001802 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001803 }
1804
David Howells44bdb5e2015-01-29 12:02:29 +00001805 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001806 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001807 add_flags = DCACHE_SYMLINK_TYPE;
1808 goto type_determined;
1809 }
1810 inode->i_opflags |= IOP_NOFOLLOW;
1811 }
1812
1813 if (unlikely(!S_ISREG(inode->i_mode)))
1814 add_flags = DCACHE_SPECIAL_TYPE;
1815
1816type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001817 if (unlikely(IS_AUTOMOUNT(inode)))
1818 add_flags |= DCACHE_NEED_AUTOMOUNT;
1819 return add_flags;
1820}
1821
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001822static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1823{
David Howellsb18825a2013-09-12 19:22:53 +01001824 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001825 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001826
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001827 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001828 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001829 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001830 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001831 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001832 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001833 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001834}
1835
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836/**
1837 * d_instantiate - fill in inode information for a dentry
1838 * @entry: dentry to complete
1839 * @inode: inode to attach to this dentry
1840 *
1841 * Fill in inode information in the entry.
1842 *
1843 * This turns negative dentries into productive full members
1844 * of society.
1845 *
1846 * NOTE! This assumes that the inode count has been incremented
1847 * (or otherwise set) by the caller to indicate that it is now
1848 * in use by the dcache.
1849 */
1850
1851void d_instantiate(struct dentry *entry, struct inode * inode)
1852{
Al Viro946e51f2014-10-26 19:19:16 -04001853 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001854 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001855 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001856 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001857 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001858 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001859 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001861EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
1863/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001864 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1865 * @entry: dentry to complete
1866 * @inode: inode to attach to this dentry
1867 *
1868 * Fill in inode information in the entry. If a directory alias is found, then
1869 * return an error (and drop inode). Together with d_materialise_unique() this
1870 * guarantees that a directory inode may never have more than one alias.
1871 */
1872int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1873{
Al Viro946e51f2014-10-26 19:19:16 -04001874 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001875
Al Virob9680912016-04-11 00:53:26 -04001876 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001877 spin_lock(&inode->i_lock);
1878 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1879 spin_unlock(&inode->i_lock);
1880 iput(inode);
1881 return -EBUSY;
1882 }
1883 __d_instantiate(entry, inode);
1884 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001885
1886 return 0;
1887}
1888EXPORT_SYMBOL(d_instantiate_no_diralias);
1889
Al Viroadc0e912012-01-08 16:49:21 -05001890struct dentry *d_make_root(struct inode *root_inode)
1891{
1892 struct dentry *res = NULL;
1893
1894 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001895 res = d_alloc_anon(root_inode->i_sb);
Al Viroadc0e912012-01-08 16:49:21 -05001896 if (res)
1897 d_instantiate(res, root_inode);
1898 else
1899 iput(root_inode);
1900 }
1901 return res;
1902}
1903EXPORT_SYMBOL(d_make_root);
1904
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001905static struct dentry * __d_find_any_alias(struct inode *inode)
1906{
1907 struct dentry *alias;
1908
Al Virob3d9b7a2012-06-09 13:51:19 -04001909 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001910 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001911 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001912 __dget(alias);
1913 return alias;
1914}
1915
Sage Weil46f72b32012-01-10 09:04:37 -08001916/**
1917 * d_find_any_alias - find any alias for a given inode
1918 * @inode: inode to find an alias for
1919 *
1920 * If any aliases exist for the given inode, take and return a
1921 * reference for one of them. If no aliases exist, return %NULL.
1922 */
1923struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001924{
1925 struct dentry *de;
1926
1927 spin_lock(&inode->i_lock);
1928 de = __d_find_any_alias(inode);
1929 spin_unlock(&inode->i_lock);
1930 return de;
1931}
Sage Weil46f72b32012-01-10 09:04:37 -08001932EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001933
Miklos Szeredif9c34672018-01-19 11:39:52 +01001934static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1935 struct inode *inode,
1936 bool disconnected)
1937{
1938 struct dentry *res;
1939 unsigned add_flags;
1940
1941 security_d_instantiate(dentry, inode);
1942 spin_lock(&inode->i_lock);
1943 res = __d_find_any_alias(inode);
1944 if (res) {
1945 spin_unlock(&inode->i_lock);
1946 dput(dentry);
1947 goto out_iput;
1948 }
1949
1950 /* attach a disconnected dentry */
1951 add_flags = d_flags_for_inode(inode);
1952
1953 if (disconnected)
1954 add_flags |= DCACHE_DISCONNECTED;
1955
1956 spin_lock(&dentry->d_lock);
1957 __d_set_inode_and_type(dentry, inode, add_flags);
1958 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08001959 if (!disconnected) {
1960 hlist_bl_lock(&dentry->d_sb->s_roots);
1961 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
1962 hlist_bl_unlock(&dentry->d_sb->s_roots);
1963 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01001964 spin_unlock(&dentry->d_lock);
1965 spin_unlock(&inode->i_lock);
1966
1967 return dentry;
1968
1969 out_iput:
1970 iput(inode);
1971 return res;
1972}
1973
1974struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
1975{
1976 return __d_instantiate_anon(dentry, inode, true);
1977}
1978EXPORT_SYMBOL(d_instantiate_anon);
1979
1980static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001981{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001982 struct dentry *tmp;
1983 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001984
1985 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001986 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001987 if (IS_ERR(inode))
1988 return ERR_CAST(inode);
1989
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001990 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001991 if (res)
1992 goto out_iput;
1993
Miklos Szeredif9c34672018-01-19 11:39:52 +01001994 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001995 if (!tmp) {
1996 res = ERR_PTR(-ENOMEM);
1997 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001998 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001999
Miklos Szeredif9c34672018-01-19 11:39:52 +01002000 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002001
Miklos Szeredif9c34672018-01-19 11:39:52 +01002002out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002003 iput(inode);
2004 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002005}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002006
2007/**
2008 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2009 * @inode: inode to allocate the dentry for
2010 *
2011 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2012 * similar open by handle operations. The returned dentry may be anonymous,
2013 * or may have a full name (if the inode was already in the cache).
2014 *
2015 * When called on a directory inode, we must ensure that the inode only ever
2016 * has one dentry. If a dentry is found, that is returned instead of
2017 * allocating a new one.
2018 *
2019 * On successful return, the reference to the inode has been transferred
2020 * to the dentry. In case of an error the reference on the inode is released.
2021 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2022 * be passed in and the error will be propagated to the return value,
2023 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2024 */
2025struct dentry *d_obtain_alias(struct inode *inode)
2026{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002027 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002028}
Benny Halevyadc48722009-02-27 14:02:59 -08002029EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030
2031/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002032 * d_obtain_root - find or allocate a dentry for a given inode
2033 * @inode: inode to allocate the dentry for
2034 *
2035 * Obtain an IS_ROOT dentry for the root of a filesystem.
2036 *
2037 * We must ensure that directory inodes only ever have one dentry. If a
2038 * dentry is found, that is returned instead of allocating a new one.
2039 *
2040 * On successful return, the reference to the inode has been transferred
2041 * to the dentry. In case of an error the reference on the inode is
2042 * released. A %NULL or IS_ERR inode may be passed in and will be the
2043 * error will be propagate to the return value, with a %NULL @inode
2044 * replaced by ERR_PTR(-ESTALE).
2045 */
2046struct dentry *d_obtain_root(struct inode *inode)
2047{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002048 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002049}
2050EXPORT_SYMBOL(d_obtain_root);
2051
2052/**
Barry Naujok94035402008-05-21 16:50:46 +10002053 * d_add_ci - lookup or allocate new dentry with case-exact name
2054 * @inode: the inode case-insensitive lookup has found
2055 * @dentry: the negative dentry that was passed to the parent's lookup func
2056 * @name: the case-exact name to be associated with the returned dentry
2057 *
2058 * This is to avoid filling the dcache with case-insensitive names to the
2059 * same inode, only the actual correct case is stored in the dcache for
2060 * case-insensitive filesystems.
2061 *
2062 * For a case-insensitive lookup match and if the the case-exact dentry
2063 * already exists in in the dcache, use it and return it.
2064 *
2065 * If no entry exists with the exact case name, allocate new dentry with
2066 * the exact case, and return the spliced entry.
2067 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002068struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002069 struct qstr *name)
2070{
Al Virod9171b92016-04-15 03:33:13 -04002071 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002072
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002073 /*
2074 * First check if a dentry matching the name already exists,
2075 * if not go ahead and create it now.
2076 */
Barry Naujok94035402008-05-21 16:50:46 +10002077 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002078 if (found) {
2079 iput(inode);
2080 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002081 }
Al Virod9171b92016-04-15 03:33:13 -04002082 if (d_in_lookup(dentry)) {
2083 found = d_alloc_parallel(dentry->d_parent, name,
2084 dentry->d_wait);
2085 if (IS_ERR(found) || !d_in_lookup(found)) {
2086 iput(inode);
2087 return found;
2088 }
2089 } else {
2090 found = d_alloc(dentry->d_parent, name);
2091 if (!found) {
2092 iput(inode);
2093 return ERR_PTR(-ENOMEM);
2094 }
2095 }
2096 res = d_splice_alias(inode, found);
2097 if (res) {
2098 dput(found);
2099 return res;
2100 }
Al Viro4f522a22013-02-11 23:20:37 -05002101 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002102}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002103EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002105
Al Virod4c91a82016-06-25 23:33:49 -04002106static inline bool d_same_name(const struct dentry *dentry,
2107 const struct dentry *parent,
2108 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002109{
Al Virod4c91a82016-06-25 23:33:49 -04002110 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2111 if (dentry->d_name.len != name->len)
2112 return false;
2113 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002114 }
Al Viro6fa67e72016-07-31 16:37:25 -04002115 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002116 dentry->d_name.len, dentry->d_name.name,
2117 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002118}
2119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002121 * __d_lookup_rcu - search for a dentry (racy, store-free)
2122 * @parent: parent dentry
2123 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002124 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002125 * Returns: dentry, or NULL
2126 *
2127 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2128 * resolution (store-free path walking) design described in
2129 * Documentation/filesystems/path-lookup.txt.
2130 *
2131 * This is not to be used outside core vfs.
2132 *
2133 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2134 * held, and rcu_read_lock held. The returned dentry must not be stored into
2135 * without taking d_lock and checking d_seq sequence count against @seq
2136 * returned here.
2137 *
Linus Torvalds15570082013-09-02 11:38:06 -07002138 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002139 * function.
2140 *
2141 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2142 * the returned dentry, so long as its parent's seqlock is checked after the
2143 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2144 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002145 *
2146 * NOTE! The caller *has* to check the resulting dentry against the sequence
2147 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002148 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002149struct dentry *__d_lookup_rcu(const struct dentry *parent,
2150 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002151 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002152{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002153 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002154 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002155 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002156 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002157 struct dentry *dentry;
2158
2159 /*
2160 * Note: There is significant duplication with __d_lookup_rcu which is
2161 * required to prevent single threaded performance regressions
2162 * especially on architectures where smp_rmb (in seqcounts) are costly.
2163 * Keep the two functions in sync.
2164 */
2165
2166 /*
2167 * The hash list is protected using RCU.
2168 *
2169 * Carefully use d_seq when comparing a candidate dentry, to avoid
2170 * races with d_move().
2171 *
2172 * It is possible that concurrent renames can mess up our list
2173 * walk here and result in missing our dentry, resulting in the
2174 * false-negative result. d_lookup() protects against concurrent
2175 * renames using rename_lock seqlock.
2176 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002177 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002178 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002179 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002180 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002181
Nick Piggin31e6b012011-01-07 17:49:52 +11002182seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002183 /*
2184 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002185 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002186 *
2187 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002188 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002189 *
2190 * NOTE! We do a "raw" seqcount_begin here. That means that
2191 * we don't wait for the sequence count to stabilize if it
2192 * is in the middle of a sequence change. If we do the slow
2193 * dentry compare, we will do seqretries until it is stable,
2194 * and if we end up with a successful lookup, we actually
2195 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002196 *
2197 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2198 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002199 */
2200 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002201 if (dentry->d_parent != parent)
2202 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002203 if (d_unhashed(dentry))
2204 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002205
2206 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002207 int tlen;
2208 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002209 if (dentry->d_name.hash != hashlen_hash(hashlen))
2210 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002211 tlen = dentry->d_name.len;
2212 tname = dentry->d_name.name;
2213 /* we want a consistent (name,len) pair */
2214 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2215 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002216 goto seqretry;
2217 }
Al Viro6fa67e72016-07-31 16:37:25 -04002218 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002219 tlen, tname, name) != 0)
2220 continue;
2221 } else {
2222 if (dentry->d_name.hash_len != hashlen)
2223 continue;
2224 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2225 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002226 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002227 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002228 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002229 }
2230 return NULL;
2231}
2232
2233/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 * d_lookup - search for a dentry
2235 * @parent: parent dentry
2236 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002237 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002239 * d_lookup searches the children of the parent dentry for the name in
2240 * question. If the dentry is found its reference count is incremented and the
2241 * dentry is returned. The caller must use dput to free the entry when it has
2242 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 */
Al Viroda2d8452013-01-24 18:29:34 -05002244struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245{
Nick Piggin31e6b012011-01-07 17:49:52 +11002246 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002247 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248
Daeseok Younb8314f92014-08-11 11:46:53 +09002249 do {
2250 seq = read_seqbegin(&rename_lock);
2251 dentry = __d_lookup(parent, name);
2252 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 break;
2254 } while (read_seqretry(&rename_lock, seq));
2255 return dentry;
2256}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002257EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258
Nick Piggin31e6b012011-01-07 17:49:52 +11002259/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002260 * __d_lookup - search for a dentry (racy)
2261 * @parent: parent dentry
2262 * @name: qstr of name we wish to find
2263 * Returns: dentry, or NULL
2264 *
2265 * __d_lookup is like d_lookup, however it may (rarely) return a
2266 * false-negative result due to unrelated rename activity.
2267 *
2268 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2269 * however it must be used carefully, eg. with a following d_lookup in
2270 * the case of failure.
2271 *
2272 * __d_lookup callers must be commented.
2273 */
Al Viroa713ca22013-01-24 18:27:00 -05002274struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002277 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002278 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002279 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002280 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
Nick Pigginb04f7842010-08-18 04:37:34 +10002282 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002283 * Note: There is significant duplication with __d_lookup_rcu which is
2284 * required to prevent single threaded performance regressions
2285 * especially on architectures where smp_rmb (in seqcounts) are costly.
2286 * Keep the two functions in sync.
2287 */
2288
2289 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002290 * The hash list is protected using RCU.
2291 *
2292 * Take d_lock when comparing a candidate dentry, to avoid races
2293 * with d_move().
2294 *
2295 * It is possible that concurrent renames can mess up our list
2296 * walk here and result in missing our dentry, resulting in the
2297 * false-negative result. d_lookup() protects against concurrent
2298 * renames using rename_lock seqlock.
2299 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002300 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002301 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 rcu_read_lock();
2303
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002304 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 if (dentry->d_name.hash != hash)
2307 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308
2309 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 if (dentry->d_parent != parent)
2311 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002312 if (d_unhashed(dentry))
2313 goto next;
2314
Al Virod4c91a82016-06-25 23:33:49 -04002315 if (!d_same_name(dentry, parent, name))
2316 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
Waiman Long98474232013-08-28 18:24:59 -07002318 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002319 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 spin_unlock(&dentry->d_lock);
2321 break;
2322next:
2323 spin_unlock(&dentry->d_lock);
2324 }
2325 rcu_read_unlock();
2326
2327 return found;
2328}
2329
2330/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002331 * d_hash_and_lookup - hash the qstr then search for a dentry
2332 * @dir: Directory to search in
2333 * @name: qstr of name we wish to find
2334 *
Al Viro4f522a22013-02-11 23:20:37 -05002335 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002336 */
2337struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2338{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002339 /*
2340 * Check for a fs-specific hash function. Note that we must
2341 * calculate the standard hash first, as the d_op->d_hash()
2342 * routine may choose to leave the hash value unchanged.
2343 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002344 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002345 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002346 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002347 if (unlikely(err < 0))
2348 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002349 }
Al Viro4f522a22013-02-11 23:20:37 -05002350 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002351}
Al Viro4f522a22013-02-11 23:20:37 -05002352EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002353
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354/*
2355 * When a file is deleted, we have two options:
2356 * - turn this dentry into a negative dentry
2357 * - unhash this dentry and free it.
2358 *
2359 * Usually, we want to just turn this into
2360 * a negative dentry, but if anybody else is
2361 * currently using the dentry or the inode
2362 * we can't do that and we fall back on removing
2363 * it from the hash queues and waiting for
2364 * it to be deleted later when it has no users
2365 */
2366
2367/**
2368 * d_delete - delete a dentry
2369 * @dentry: The dentry to delete
2370 *
2371 * Turn the dentry into a negative dentry if possible, otherwise
2372 * remove it from the hash queues so it can be deleted later
2373 */
2374
2375void d_delete(struct dentry * dentry)
2376{
Nick Piggin873feea2011-01-07 17:50:06 +11002377 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002378 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 /*
2380 * Are we the only user?
2381 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002382again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002384 inode = dentry->d_inode;
2385 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002386 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002387 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002388 spin_unlock(&dentry->d_lock);
2389 cpu_relax();
2390 goto again;
2391 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002392 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002393 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002394 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 return;
2396 }
2397
2398 if (!d_unhashed(dentry))
2399 __d_drop(dentry);
2400
2401 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002402
2403 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002405EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406
Al Viro15d3c582016-07-29 17:45:21 -04002407static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408{
Al Viro15d3c582016-07-29 17:45:21 -04002409 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002410
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002411 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002412 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002413 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414}
2415
2416/**
2417 * d_rehash - add an entry back to the hash
2418 * @entry: dentry to add to the hash
2419 *
2420 * Adds a dentry to the hash according to its name.
2421 */
2422
2423void d_rehash(struct dentry * entry)
2424{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002426 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002429EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430
Al Viro84e710d2016-04-15 00:58:55 -04002431static inline unsigned start_dir_add(struct inode *dir)
2432{
2433
2434 for (;;) {
2435 unsigned n = dir->i_dir_seq;
2436 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2437 return n;
2438 cpu_relax();
2439 }
2440}
2441
2442static inline void end_dir_add(struct inode *dir, unsigned n)
2443{
2444 smp_store_release(&dir->i_dir_seq, n + 2);
2445}
2446
Al Virod9171b92016-04-15 03:33:13 -04002447static void d_wait_lookup(struct dentry *dentry)
2448{
2449 if (d_in_lookup(dentry)) {
2450 DECLARE_WAITQUEUE(wait, current);
2451 add_wait_queue(dentry->d_wait, &wait);
2452 do {
2453 set_current_state(TASK_UNINTERRUPTIBLE);
2454 spin_unlock(&dentry->d_lock);
2455 schedule();
2456 spin_lock(&dentry->d_lock);
2457 } while (d_in_lookup(dentry));
2458 }
2459}
2460
Al Viro94bdd652016-04-15 02:42:04 -04002461struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002462 const struct qstr *name,
2463 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002464{
Al Viro94bdd652016-04-15 02:42:04 -04002465 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002466 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2467 struct hlist_bl_node *node;
2468 struct dentry *new = d_alloc(parent, name);
2469 struct dentry *dentry;
2470 unsigned seq, r_seq, d_seq;
2471
2472 if (unlikely(!new))
2473 return ERR_PTR(-ENOMEM);
2474
2475retry:
2476 rcu_read_lock();
2477 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2478 r_seq = read_seqbegin(&rename_lock);
2479 dentry = __d_lookup_rcu(parent, name, &d_seq);
2480 if (unlikely(dentry)) {
2481 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2482 rcu_read_unlock();
2483 goto retry;
2484 }
2485 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2486 rcu_read_unlock();
2487 dput(dentry);
2488 goto retry;
2489 }
2490 rcu_read_unlock();
2491 dput(new);
2492 return dentry;
2493 }
2494 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2495 rcu_read_unlock();
2496 goto retry;
2497 }
2498 hlist_bl_lock(b);
2499 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2500 hlist_bl_unlock(b);
2501 rcu_read_unlock();
2502 goto retry;
2503 }
Al Viro94bdd652016-04-15 02:42:04 -04002504 /*
2505 * No changes for the parent since the beginning of d_lookup().
2506 * Since all removals from the chain happen with hlist_bl_lock(),
2507 * any potential in-lookup matches are going to stay here until
2508 * we unlock the chain. All fields are stable in everything
2509 * we encounter.
2510 */
2511 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2512 if (dentry->d_name.hash != hash)
2513 continue;
2514 if (dentry->d_parent != parent)
2515 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002516 if (!d_same_name(dentry, parent, name))
2517 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002518 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002519 /* now we can try to grab a reference */
2520 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2521 rcu_read_unlock();
2522 goto retry;
2523 }
2524
2525 rcu_read_unlock();
2526 /*
2527 * somebody is likely to be still doing lookup for it;
2528 * wait for them to finish
2529 */
Al Virod9171b92016-04-15 03:33:13 -04002530 spin_lock(&dentry->d_lock);
2531 d_wait_lookup(dentry);
2532 /*
2533 * it's not in-lookup anymore; in principle we should repeat
2534 * everything from dcache lookup, but it's likely to be what
2535 * d_lookup() would've found anyway. If it is, just return it;
2536 * otherwise we really have to repeat the whole thing.
2537 */
2538 if (unlikely(dentry->d_name.hash != hash))
2539 goto mismatch;
2540 if (unlikely(dentry->d_parent != parent))
2541 goto mismatch;
2542 if (unlikely(d_unhashed(dentry)))
2543 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002544 if (unlikely(!d_same_name(dentry, parent, name)))
2545 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002546 /* OK, it *is* a hashed match; return it */
2547 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002548 dput(new);
2549 return dentry;
2550 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002551 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002552 /* we can't take ->d_lock here; it's OK, though. */
2553 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002554 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002555 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2556 hlist_bl_unlock(b);
2557 return new;
Al Virod9171b92016-04-15 03:33:13 -04002558mismatch:
2559 spin_unlock(&dentry->d_lock);
2560 dput(dentry);
2561 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002562}
2563EXPORT_SYMBOL(d_alloc_parallel);
2564
Al Viro85c7f812016-04-14 19:52:13 -04002565void __d_lookup_done(struct dentry *dentry)
2566{
Al Viro94bdd652016-04-15 02:42:04 -04002567 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2568 dentry->d_name.hash);
2569 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002570 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002571 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002572 wake_up_all(dentry->d_wait);
2573 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002574 hlist_bl_unlock(b);
2575 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002576 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002577}
2578EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002579
2580/* inode->i_lock held if inode is non-NULL */
2581
2582static inline void __d_add(struct dentry *dentry, struct inode *inode)
2583{
Al Viro84e710d2016-04-15 00:58:55 -04002584 struct inode *dir = NULL;
2585 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002586 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002587 if (unlikely(d_in_lookup(dentry))) {
2588 dir = dentry->d_parent->d_inode;
2589 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002590 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002591 }
Al Viroed782b52016-03-09 19:52:39 -05002592 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002593 unsigned add_flags = d_flags_for_inode(inode);
2594 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2595 raw_write_seqcount_begin(&dentry->d_seq);
2596 __d_set_inode_and_type(dentry, inode, add_flags);
2597 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002598 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002599 }
Al Viro15d3c582016-07-29 17:45:21 -04002600 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002601 if (dir)
2602 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002603 spin_unlock(&dentry->d_lock);
2604 if (inode)
2605 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002606}
2607
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002608/**
Al Viro34d0d192016-03-08 21:01:03 -05002609 * d_add - add dentry to hash queues
2610 * @entry: dentry to add
2611 * @inode: The inode to attach to this dentry
2612 *
2613 * This adds the entry to the hash queues and initializes @inode.
2614 * The entry was actually filled in earlier during d_alloc().
2615 */
2616
2617void d_add(struct dentry *entry, struct inode *inode)
2618{
Al Virob9680912016-04-11 00:53:26 -04002619 if (inode) {
2620 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002621 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002622 }
Al Viroed782b52016-03-09 19:52:39 -05002623 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002624}
2625EXPORT_SYMBOL(d_add);
2626
2627/**
Al Viro668d0cd2016-03-08 12:44:17 -05002628 * d_exact_alias - find and hash an exact unhashed alias
2629 * @entry: dentry to add
2630 * @inode: The inode to go with this dentry
2631 *
2632 * If an unhashed dentry with the same name/parent and desired
2633 * inode already exists, hash and return it. Otherwise, return
2634 * NULL.
2635 *
2636 * Parent directory should be locked.
2637 */
2638struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2639{
2640 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002641 unsigned int hash = entry->d_name.hash;
2642
2643 spin_lock(&inode->i_lock);
2644 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2645 /*
2646 * Don't need alias->d_lock here, because aliases with
2647 * d_parent == entry->d_parent are not subject to name or
2648 * parent changes, because the parent inode i_mutex is held.
2649 */
2650 if (alias->d_name.hash != hash)
2651 continue;
2652 if (alias->d_parent != entry->d_parent)
2653 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002654 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002655 continue;
2656 spin_lock(&alias->d_lock);
2657 if (!d_unhashed(alias)) {
2658 spin_unlock(&alias->d_lock);
2659 alias = NULL;
2660 } else {
2661 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002662 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002663 spin_unlock(&alias->d_lock);
2664 }
2665 spin_unlock(&inode->i_lock);
2666 return alias;
2667 }
2668 spin_unlock(&inode->i_lock);
2669 return NULL;
2670}
2671EXPORT_SYMBOL(d_exact_alias);
2672
2673/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002674 * dentry_update_name_case - update case insensitive dentry with a new name
2675 * @dentry: dentry to be updated
2676 * @name: new name
2677 *
2678 * Update a case insensitive dentry with new case of name.
2679 *
2680 * dentry must have been returned by d_lookup with name @name. Old and new
2681 * name lengths must match (ie. no d_compare which allows mismatched name
2682 * lengths).
2683 *
2684 * Parent inode i_mutex must be held over d_lookup and into this call (to
2685 * keep renames and concurrent inserts, and readdir(2) away).
2686 */
Al Viro9aba36d2016-07-20 22:28:45 -04002687void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002688{
Al Viro59551022016-01-22 15:40:57 -05002689 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002690 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2691
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002692 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002693 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002694 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002695 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002696 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002697}
2698EXPORT_SYMBOL(dentry_update_name_case);
2699
Al Viro8d85b482014-09-29 14:54:27 -04002700static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701{
Al Viro8d85b482014-09-29 14:54:27 -04002702 if (unlikely(dname_external(target))) {
2703 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704 /*
2705 * Both external: swap the pointers
2706 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002707 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708 } else {
2709 /*
2710 * dentry:internal, target:external. Steal target's
2711 * storage and make target internal.
2712 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002713 memcpy(target->d_iname, dentry->d_name.name,
2714 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715 dentry->d_name.name = target->d_name.name;
2716 target->d_name.name = target->d_iname;
2717 }
2718 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002719 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 /*
2721 * dentry:external, target:internal. Give dentry's
2722 * storage to target and make dentry internal
2723 */
2724 memcpy(dentry->d_iname, target->d_name.name,
2725 target->d_name.len + 1);
2726 target->d_name.name = dentry->d_name.name;
2727 dentry->d_name.name = dentry->d_iname;
2728 } else {
2729 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002730 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002732 unsigned int i;
2733 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2734 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2735 swap(((long *) &dentry->d_iname)[i],
2736 ((long *) &target->d_iname)[i]);
2737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 }
2739 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002740 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741}
2742
Al Viro8d85b482014-09-29 14:54:27 -04002743static void copy_name(struct dentry *dentry, struct dentry *target)
2744{
2745 struct external_name *old_name = NULL;
2746 if (unlikely(dname_external(dentry)))
2747 old_name = external_name(dentry);
2748 if (unlikely(dname_external(target))) {
2749 atomic_inc(&external_name(target)->u.count);
2750 dentry->d_name = target->d_name;
2751 } else {
2752 memcpy(dentry->d_iname, target->d_name.name,
2753 target->d_name.len + 1);
2754 dentry->d_name.name = dentry->d_iname;
2755 dentry->d_name.hash_len = target->d_name.hash_len;
2756 }
2757 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2758 kfree_rcu(old_name, u.head);
2759}
2760
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002761static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2762{
2763 /*
2764 * XXXX: do we really need to take target->d_lock?
2765 */
2766 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2767 spin_lock(&target->d_parent->d_lock);
2768 else {
2769 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2770 spin_lock(&dentry->d_parent->d_lock);
2771 spin_lock_nested(&target->d_parent->d_lock,
2772 DENTRY_D_LOCK_NESTED);
2773 } else {
2774 spin_lock(&target->d_parent->d_lock);
2775 spin_lock_nested(&dentry->d_parent->d_lock,
2776 DENTRY_D_LOCK_NESTED);
2777 }
2778 }
2779 if (target < dentry) {
2780 spin_lock_nested(&target->d_lock, 2);
2781 spin_lock_nested(&dentry->d_lock, 3);
2782 } else {
2783 spin_lock_nested(&dentry->d_lock, 2);
2784 spin_lock_nested(&target->d_lock, 3);
2785 }
2786}
2787
Al Viro986c0192014-09-26 23:11:15 -04002788static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002789{
2790 if (target->d_parent != dentry->d_parent)
2791 spin_unlock(&dentry->d_parent->d_lock);
2792 if (target->d_parent != target)
2793 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002794 spin_unlock(&target->d_lock);
2795 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002796}
2797
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002799 * When switching names, the actual string doesn't strictly have to
2800 * be preserved in the target - because we're dropping the target
2801 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002802 * the new name before we switch, unless we are going to rehash
2803 * it. Note that if we *do* unhash the target, we are not allowed
2804 * to rehash it without giving it a new name/hash key - whether
2805 * we swap or overwrite the names here, resulting name won't match
2806 * the reality in filesystem; it's only there for d_path() purposes.
2807 * Note that all of this is happening under rename_lock, so the
2808 * any hash lookup seeing it in the middle of manipulations will
2809 * be discarded anyway. So we do not care what happens to the hash
2810 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002812/*
Al Viro18367502011-07-12 21:42:24 -04002813 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814 * @dentry: entry to move
2815 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002816 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 *
2818 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002819 * dcache entries should not be moved in this way. Caller must hold
2820 * rename_lock, the i_mutex of the source and target directories,
2821 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002823static void __d_move(struct dentry *dentry, struct dentry *target,
2824 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825{
Al Viro84e710d2016-04-15 00:58:55 -04002826 struct inode *dir = NULL;
2827 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828 if (!dentry->d_inode)
2829 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2830
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002831 BUG_ON(d_ancestor(dentry, target));
2832 BUG_ON(d_ancestor(target, dentry));
2833
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002834 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002835 if (unlikely(d_in_lookup(target))) {
2836 dir = target->d_parent->d_inode;
2837 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002838 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002839 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840
Nick Piggin31e6b012011-01-07 17:49:52 +11002841 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002842 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002843
Al Viro15d3c582016-07-29 17:45:21 -04002844 /* unhash both */
NeilBrown61647822017-11-10 15:45:41 +11002845 /* ___d_drop does write_seqcount_barrier, but they're OK to nest. */
2846 ___d_drop(dentry);
2847 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002850 if (exchange)
2851 swap_names(dentry, target);
2852 else
2853 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002854
Al Viro15d3c582016-07-29 17:45:21 -04002855 /* rehash in new place(s) */
2856 __d_rehash(dentry);
2857 if (exchange)
2858 __d_rehash(target);
NeilBrown61647822017-11-10 15:45:41 +11002859 else
2860 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002861
Al Viro63cf4272014-09-26 23:06:14 -04002862 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002864 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002865 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866 dentry->d_parent = target->d_parent;
2867 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002868 list_del_init(&target->d_child);
2869 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002871 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002872 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002873 list_move(&target->d_child, &target->d_parent->d_subdirs);
2874 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002875 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002876 fsnotify_update_flags(target);
2877 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 }
2879
Nick Piggin31e6b012011-01-07 17:49:52 +11002880 write_seqcount_end(&target->d_seq);
2881 write_seqcount_end(&dentry->d_seq);
2882
Al Viro84e710d2016-04-15 00:58:55 -04002883 if (dir)
2884 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002885 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002886}
2887
2888/*
2889 * d_move - move a dentry
2890 * @dentry: entry to move
2891 * @target: new dentry
2892 *
2893 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002894 * dcache entries should not be moved in this way. See the locking
2895 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002896 */
2897void d_move(struct dentry *dentry, struct dentry *target)
2898{
2899 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002900 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002902}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002903EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904
Miklos Szeredida1ce062014-04-01 17:08:43 +02002905/*
2906 * d_exchange - exchange two dentries
2907 * @dentry1: first dentry
2908 * @dentry2: second dentry
2909 */
2910void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2911{
2912 write_seqlock(&rename_lock);
2913
2914 WARN_ON(!dentry1->d_inode);
2915 WARN_ON(!dentry2->d_inode);
2916 WARN_ON(IS_ROOT(dentry1));
2917 WARN_ON(IS_ROOT(dentry2));
2918
2919 __d_move(dentry1, dentry2, true);
2920
2921 write_sequnlock(&rename_lock);
2922}
2923
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002924/**
2925 * d_ancestor - search for an ancestor
2926 * @p1: ancestor dentry
2927 * @p2: child dentry
2928 *
2929 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2930 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002931 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002932struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002933{
2934 struct dentry *p;
2935
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002936 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002937 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002938 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002939 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002940 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002941}
2942
2943/*
2944 * This helper attempts to cope with remotely renamed directories
2945 *
2946 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002947 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002948 *
2949 * Note: If ever the locking in lock_rename() changes, then please
2950 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002951 */
Al Virob5ae6b12014-10-12 22:16:02 -04002952static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002953 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002954{
Al Viro9902af72016-04-15 15:08:36 -04002955 struct mutex *m1 = NULL;
2956 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002957 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958
2959 /* If alias and dentry share a parent, then no extra locks required */
2960 if (alias->d_parent == dentry->d_parent)
2961 goto out_unalias;
2962
Trond Myklebust9eaef272006-10-21 10:24:20 -07002963 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002964 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2965 goto out_err;
2966 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002967 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002968 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002969 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002970out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002971 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002972 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002973out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002974 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002975 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002976 if (m1)
2977 mutex_unlock(m1);
2978 return ret;
2979}
2980
David Howells770bfad2006-08-22 20:06:07 -04002981/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002982 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2983 * @inode: the inode which may have a disconnected dentry
2984 * @dentry: a negative dentry which we want to point to the inode.
2985 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002986 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2987 * place of the given dentry and return it, else simply d_add the inode
2988 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002989 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002990 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2991 * we should error out: directories can't have multiple aliases.
2992 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002993 * This is needed in the lookup routine of any filesystem that is exportable
2994 * (via knfsd) so that we can build dcache paths to directories effectively.
2995 *
2996 * If a dentry was found and moved, then it is returned. Otherwise NULL
2997 * is returned. This matches the expected return value of ->lookup.
2998 *
2999 * Cluster filesystems may call this function with a negative, hashed dentry.
3000 * In that case, we know that the inode will be a regular file, and also this
3001 * will only occur during atomic_open. So we need to check for the dentry
3002 * being already hashed only in the final case.
3003 */
3004struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3005{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003006 if (IS_ERR(inode))
3007 return ERR_CAST(inode);
3008
David Howells770bfad2006-08-22 20:06:07 -04003009 BUG_ON(!d_unhashed(dentry));
3010
Al Virode689f52016-03-09 18:05:42 -05003011 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003012 goto out;
Al Virode689f52016-03-09 18:05:42 -05003013
Al Virob9680912016-04-11 00:53:26 -04003014 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003015 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003016 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003017 struct dentry *new = __d_find_any_alias(inode);
3018 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003019 /* The reference to new ensures it remains an alias */
3020 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003021 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003022 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003023 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003024 dput(new);
3025 new = ERR_PTR(-ELOOP);
3026 pr_warn_ratelimited(
3027 "VFS: Lookup of '%s' in %s %s"
3028 " would have caused loop\n",
3029 dentry->d_name.name,
3030 inode->i_sb->s_type->name,
3031 inode->i_sb->s_id);
3032 } else if (!IS_ROOT(new)) {
3033 int err = __d_unalias(inode, dentry, new);
3034 write_sequnlock(&rename_lock);
3035 if (err) {
3036 dput(new);
3037 new = ERR_PTR(err);
3038 }
Al Viro18367502011-07-12 21:42:24 -04003039 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003040 __d_move(new, dentry, false);
3041 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003042 }
Al Virob5ae6b12014-10-12 22:16:02 -04003043 iput(inode);
3044 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003045 }
David Howells770bfad2006-08-22 20:06:07 -04003046 }
Al Virob5ae6b12014-10-12 22:16:02 -04003047out:
Al Viroed782b52016-03-09 19:52:39 -05003048 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003049 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003050}
Al Virob5ae6b12014-10-12 22:16:02 -04003051EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003052
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003053static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003054{
3055 *buflen -= namelen;
3056 if (*buflen < 0)
3057 return -ENAMETOOLONG;
3058 *buffer -= namelen;
3059 memcpy(*buffer, str, namelen);
3060 return 0;
3061}
3062
Waiman Long232d2d62013-09-09 12:18:13 -04003063/**
3064 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003065 * @buffer: buffer pointer
3066 * @buflen: allocated length of the buffer
3067 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003068 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003069 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003070 * make sure that either the old or the new name pointer and length are
3071 * fetched. However, there may be mismatch between length and pointer.
3072 * The length cannot be trusted, we need to copy it byte-by-byte until
3073 * the length is reached or a null byte is found. It also prepends "/" at
3074 * the beginning of the name. The sequence number check at the caller will
3075 * retry it again when a d_move() does happen. So any garbage in the buffer
3076 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003077 *
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003078 * Load acquire is needed to make sure that we see that terminating NUL.
Waiman Long232d2d62013-09-09 12:18:13 -04003079 */
Al Viro9aba36d2016-07-20 22:28:45 -04003080static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003081{
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003082 const char *dname = smp_load_acquire(&name->name); /* ^^^ */
Mark Rutland66702eb2017-10-23 14:07:14 -07003083 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003084 char *p;
3085
Waiman Long232d2d62013-09-09 12:18:13 -04003086 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003087 if (*buflen < 0)
3088 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003089 p = *buffer -= dlen + 1;
3090 *p++ = '/';
3091 while (dlen--) {
3092 char c = *dname++;
3093 if (!c)
3094 break;
3095 *p++ = c;
3096 }
3097 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003098}
3099
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003101 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003102 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003103 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003104 * @buffer: pointer to the end of the buffer
3105 * @buflen: pointer to buffer length
3106 *
Waiman Long18129972013-09-12 10:55:35 -04003107 * The function will first try to write out the pathname without taking any
3108 * lock other than the RCU read lock to make sure that dentries won't go away.
3109 * It only checks the sequence number of the global rename_lock as any change
3110 * in the dentry's d_seq will be preceded by changes in the rename_lock
3111 * sequence number. If the sequence number had been changed, it will restart
3112 * the whole pathname back-tracing sequence again by taking the rename_lock.
3113 * In this case, there is no need to take the RCU read lock as the recursive
3114 * parent pointer references will keep the dentry chain alive as long as no
3115 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003116 */
Al Viro02125a82011-12-05 08:43:34 -05003117static int prepend_path(const struct path *path,
3118 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003119 char **buffer, int *buflen)
3120{
Al Viroede4ceb2013-11-13 07:45:40 -05003121 struct dentry *dentry;
3122 struct vfsmount *vfsmnt;
3123 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003124 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003125 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003126 char *bptr;
3127 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003128
Al Viro48f5ec22013-09-09 15:22:25 -04003129 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003130restart_mnt:
3131 read_seqbegin_or_lock(&mount_lock, &m_seq);
3132 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003133 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003134restart:
3135 bptr = *buffer;
3136 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003137 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003138 dentry = path->dentry;
3139 vfsmnt = path->mnt;
3140 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003141 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003142 while (dentry != root->dentry || vfsmnt != root->mnt) {
3143 struct dentry * parent;
3144
3145 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003146 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003147 /* Escaped? */
3148 if (dentry != vfsmnt->mnt_root) {
3149 bptr = *buffer;
3150 blen = *buflen;
3151 error = 3;
3152 break;
3153 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003154 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003155 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003156 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003157 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003158 vfsmnt = &mnt->mnt;
3159 continue;
3160 }
Waiman Long232d2d62013-09-09 12:18:13 -04003161 if (!error)
3162 error = is_mounted(vfsmnt) ? 1 : 2;
3163 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003164 }
3165 parent = dentry->d_parent;
3166 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003167 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168 if (error)
3169 break;
3170
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003171 dentry = parent;
3172 }
Al Viro48f5ec22013-09-09 15:22:25 -04003173 if (!(seq & 1))
3174 rcu_read_unlock();
3175 if (need_seqretry(&rename_lock, seq)) {
3176 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003177 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003178 }
Al Viro48f5ec22013-09-09 15:22:25 -04003179 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003180
3181 if (!(m_seq & 1))
3182 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003183 if (need_seqretry(&mount_lock, m_seq)) {
3184 m_seq = 1;
3185 goto restart_mnt;
3186 }
3187 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003188
Waiman Long232d2d62013-09-09 12:18:13 -04003189 if (error >= 0 && bptr == *buffer) {
3190 if (--blen < 0)
3191 error = -ENAMETOOLONG;
3192 else
3193 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003194 }
Waiman Long232d2d62013-09-09 12:18:13 -04003195 *buffer = bptr;
3196 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003197 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003198}
3199
3200/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003201 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003202 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003203 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003204 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 * @buflen: buffer length
3206 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003207 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003209 * Returns a pointer into the buffer or an error code if the
3210 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003211 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003212 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003213 *
Al Viro02125a82011-12-05 08:43:34 -05003214 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 */
Al Viro02125a82011-12-05 08:43:34 -05003216char *__d_path(const struct path *path,
3217 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003218 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003220 char *res = buf + buflen;
3221 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003223 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003224 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003225
Al Viro02125a82011-12-05 08:43:34 -05003226 if (error < 0)
3227 return ERR_PTR(error);
3228 if (error > 0)
3229 return NULL;
3230 return res;
3231}
3232
3233char *d_absolute_path(const struct path *path,
3234 char *buf, int buflen)
3235{
3236 struct path root = {};
3237 char *res = buf + buflen;
3238 int error;
3239
3240 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003241 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003242
3243 if (error > 1)
3244 error = -EINVAL;
3245 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003246 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003247 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248}
3249
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003250/*
3251 * same as __d_path but appends "(deleted)" for unlinked files.
3252 */
Al Viro02125a82011-12-05 08:43:34 -05003253static int path_with_deleted(const struct path *path,
3254 const struct path *root,
3255 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003256{
3257 prepend(buf, buflen, "\0", 1);
3258 if (d_unlinked(path->dentry)) {
3259 int error = prepend(buf, buflen, " (deleted)", 10);
3260 if (error)
3261 return error;
3262 }
3263
3264 return prepend_path(path, root, buf, buflen);
3265}
3266
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003267static int prepend_unreachable(char **buffer, int *buflen)
3268{
3269 return prepend(buffer, buflen, "(unreachable)", 13);
3270}
3271
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003272static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3273{
3274 unsigned seq;
3275
3276 do {
3277 seq = read_seqcount_begin(&fs->seq);
3278 *root = fs->root;
3279 } while (read_seqcount_retry(&fs->seq, seq));
3280}
3281
Jan Bluncka03a8a702008-02-14 19:38:32 -08003282/**
3283 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003284 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003285 * @buf: buffer to return value in
3286 * @buflen: buffer length
3287 *
3288 * Convert a dentry into an ASCII path name. If the entry has been deleted
3289 * the string " (deleted)" is appended. Note that this is ambiguous.
3290 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003291 * Returns a pointer into the buffer or an error code if the path was
3292 * too long. Note: Callers should use the returned pointer, not the passed
3293 * in buffer, to use the name! The implementation often starts at an offset
3294 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003295 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003296 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003297 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003298char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003300 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003301 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003302 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003304 /*
3305 * We have various synthetic filesystems that never get mounted. On
3306 * these filesystems dentries are never used for lookup purposes, and
3307 * thus don't need to be hashed. They also don't need a name until a
3308 * user wants to identify the object in /proc/pid/fd/. The little hack
3309 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003310 *
3311 * Some pseudo inodes are mountable. When they are mounted
3312 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3313 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003314 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003315 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3316 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003317 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003318
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003319 rcu_read_lock();
3320 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003321 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003322 rcu_read_unlock();
3323
Al Viro02125a82011-12-05 08:43:34 -05003324 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003325 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003326 return res;
3327}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003328EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003329
3330/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003331 * Helper function for dentry_operations.d_dname() members
3332 */
3333char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3334 const char *fmt, ...)
3335{
3336 va_list args;
3337 char temp[64];
3338 int sz;
3339
3340 va_start(args, fmt);
3341 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3342 va_end(args);
3343
3344 if (sz > sizeof(temp) || sz > buflen)
3345 return ERR_PTR(-ENAMETOOLONG);
3346
3347 buffer += buflen - sz;
3348 return memcpy(buffer, temp, sz);
3349}
3350
Al Viro118b2302013-08-24 12:08:17 -04003351char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3352{
3353 char *end = buffer + buflen;
3354 /* these dentries are never renamed, so d_lock is not needed */
3355 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003356 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003357 prepend(&end, &buflen, "/", 1))
3358 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003359 return end;
Al Viro118b2302013-08-24 12:08:17 -04003360}
David Herrmann31bbe162014-01-03 14:09:47 +01003361EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003362
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003363/*
Ram Pai6092d042008-03-27 13:06:20 +01003364 * Write full pathname from the root of the filesystem into the buffer.
3365 */
Al Virof6500802014-01-26 12:37:55 -05003366static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003367{
Al Virof6500802014-01-26 12:37:55 -05003368 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003369 char *end, *retval;
3370 int len, seq = 0;
3371 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003372
Al Virof6500802014-01-26 12:37:55 -05003373 if (buflen < 2)
3374 goto Elong;
3375
Al Viro48f5ec22013-09-09 15:22:25 -04003376 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003377restart:
Al Virof6500802014-01-26 12:37:55 -05003378 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003379 end = buf + buflen;
3380 len = buflen;
3381 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003382 /* Get '/' right */
3383 retval = end-1;
3384 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003385 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003386 while (!IS_ROOT(dentry)) {
3387 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003388
Ram Pai6092d042008-03-27 13:06:20 +01003389 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003390 error = prepend_name(&end, &len, &dentry->d_name);
3391 if (error)
3392 break;
Ram Pai6092d042008-03-27 13:06:20 +01003393
3394 retval = end;
3395 dentry = parent;
3396 }
Al Viro48f5ec22013-09-09 15:22:25 -04003397 if (!(seq & 1))
3398 rcu_read_unlock();
3399 if (need_seqretry(&rename_lock, seq)) {
3400 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003401 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003402 }
3403 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003404 if (error)
3405 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003406 return retval;
3407Elong:
3408 return ERR_PTR(-ENAMETOOLONG);
3409}
Nick Pigginec2447c2011-01-07 17:49:29 +11003410
3411char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3412{
Waiman Long232d2d62013-09-09 12:18:13 -04003413 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003414}
3415EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003416
3417char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3418{
3419 char *p = NULL;
3420 char *retval;
3421
Al Viroc1031352010-06-06 22:31:14 -04003422 if (d_unlinked(dentry)) {
3423 p = buf + buflen;
3424 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3425 goto Elong;
3426 buflen++;
3427 }
3428 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003429 if (!IS_ERR(retval) && p)
3430 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003431 return retval;
3432Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003433 return ERR_PTR(-ENAMETOOLONG);
3434}
3435
Linus Torvalds8b19e342013-09-12 10:35:47 -07003436static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3437 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003438{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003439 unsigned seq;
3440
3441 do {
3442 seq = read_seqcount_begin(&fs->seq);
3443 *root = fs->root;
3444 *pwd = fs->pwd;
3445 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003446}
3447
Ram Pai6092d042008-03-27 13:06:20 +01003448/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003449 * NOTE! The user-level library version returns a
3450 * character pointer. The kernel system call just
3451 * returns the length of the buffer filled (which
3452 * includes the ending '\0' character), or a negative
3453 * error value. So libc would do something like
3454 *
3455 * char *getcwd(char * buf, size_t size)
3456 * {
3457 * int retval;
3458 *
3459 * retval = sys_getcwd(buf, size);
3460 * if (retval >= 0)
3461 * return buf;
3462 * errno = -retval;
3463 * return NULL;
3464 * }
3465 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003466SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467{
Linus Torvalds552ce542007-02-13 12:08:18 -08003468 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003469 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003470 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471
3472 if (!page)
3473 return -ENOMEM;
3474
Linus Torvalds8b19e342013-09-12 10:35:47 -07003475 rcu_read_lock();
3476 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003477
Linus Torvalds552ce542007-02-13 12:08:18 -08003478 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003479 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003480 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003481 char *cwd = page + PATH_MAX;
3482 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003484 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003485 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003486 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003487
Al Viro02125a82011-12-05 08:43:34 -05003488 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003489 goto out;
3490
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003491 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003492 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003493 error = prepend_unreachable(&cwd, &buflen);
3494 if (error)
3495 goto out;
3496 }
3497
Linus Torvalds552ce542007-02-13 12:08:18 -08003498 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003499 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003500 if (len <= size) {
3501 error = len;
3502 if (copy_to_user(buf, cwd, len))
3503 error = -EFAULT;
3504 }
Nick Piggin949854d2011-01-07 17:49:37 +11003505 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003506 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003507 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003508
3509out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003510 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 return error;
3512}
3513
3514/*
3515 * Test whether new_dentry is a subdirectory of old_dentry.
3516 *
3517 * Trivially implemented using the dcache structure
3518 */
3519
3520/**
3521 * is_subdir - is new dentry a subdirectory of old_dentry
3522 * @new_dentry: new dentry
3523 * @old_dentry: old dentry
3524 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003525 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3526 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3528 */
3529
Yaowei Baia6e57872015-11-17 14:40:11 +08003530bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531{
Yaowei Baia6e57872015-11-17 14:40:11 +08003532 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003533 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003535 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003536 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003537
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003538 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003541 /*
3542 * Need rcu_readlock to protect against the d_parent trashing
3543 * due to d_move
3544 */
3545 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003546 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003547 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003548 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003549 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003550 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552
3553 return result;
3554}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003555EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003556
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003557static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003558{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003559 struct dentry *root = data;
3560 if (dentry != root) {
3561 if (d_unhashed(dentry) || !dentry->d_inode)
3562 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003564 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3565 dentry->d_flags |= DCACHE_GENOCIDE;
3566 dentry->d_lockref.count--;
3567 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003568 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003569 return D_WALK_CONTINUE;
3570}
Nick Piggin58db63d2011-01-07 17:49:39 +11003571
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003572void d_genocide(struct dentry *parent)
3573{
3574 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575}
3576
Al Viro60545d02013-06-07 01:20:27 -04003577void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578{
Al Viro60545d02013-06-07 01:20:27 -04003579 inode_dec_link_count(inode);
3580 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003581 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003582 !d_unlinked(dentry));
3583 spin_lock(&dentry->d_parent->d_lock);
3584 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3585 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3586 (unsigned long long)inode->i_ino);
3587 spin_unlock(&dentry->d_lock);
3588 spin_unlock(&dentry->d_parent->d_lock);
3589 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590}
Al Viro60545d02013-06-07 01:20:27 -04003591EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003592
3593static __initdata unsigned long dhash_entries;
3594static int __init set_dhash_entries(char *str)
3595{
3596 if (!str)
3597 return 0;
3598 dhash_entries = simple_strtoul(str, &str, 0);
3599 return 1;
3600}
3601__setup("dhash_entries=", set_dhash_entries);
3602
3603static void __init dcache_init_early(void)
3604{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605 /* If hashes are distributed across NUMA nodes, defer
3606 * hash allocation until vmalloc space is available.
3607 */
3608 if (hashdist)
3609 return;
3610
3611 dentry_hashtable =
3612 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003613 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614 dhash_entries,
3615 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003616 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003618 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003619 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003620 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003621 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622}
3623
Denis Cheng74bf17c2007-10-16 23:26:30 -07003624static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003625{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003626 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627 * A constructor could be added for stable state like the lists,
3628 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003629 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630 */
David Windsor80344262017-06-10 22:50:44 -04003631 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3632 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3633 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003634
3635 /* Hash may have been set up in dcache_init_early */
3636 if (!hashdist)
3637 return;
3638
3639 dentry_hashtable =
3640 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003641 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642 dhash_entries,
3643 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003644 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003645 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003646 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003647 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003649 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003650}
3651
3652/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003653struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003654EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003655
Linus Torvalds1da177e2005-04-16 15:20:36 -07003656EXPORT_SYMBOL(d_genocide);
3657
Linus Torvalds1da177e2005-04-16 15:20:36 -07003658void __init vfs_caches_init_early(void)
3659{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003660 int i;
3661
3662 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3663 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3664
Linus Torvalds1da177e2005-04-16 15:20:36 -07003665 dcache_init_early();
3666 inode_init_early();
3667}
3668
Mel Gorman4248b0d2015-08-06 15:46:20 -07003669void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003670{
David Windsor6a9b8822017-06-10 22:50:30 -04003671 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3672 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003673
Denis Cheng74bf17c2007-10-16 23:26:30 -07003674 dcache_init();
3675 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003676 files_init();
3677 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003678 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003679 bdev_cache_init();
3680 chrdev_init();
3681}