blob: f5609902c6dd865ee19af484bba27440d3af9fad [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110035#include <linux/bit_spinlock.h>
36#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070037#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010038#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100039#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020040#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050041#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Nick Piggin789680d2011-01-07 17:49:30 +110043/*
44 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110045 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040046 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110047 * dcache_hash_bucket lock protects:
48 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110049 * s_roots bl list spinlock protects:
50 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100051 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110052 * - the dcache lru lists and counters
53 * d_lock protects:
54 * - d_flags
55 * - d_name
56 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110057 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110058 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110059 * - d_parent and d_subdirs
60 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040061 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110062 *
63 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110064 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110065 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100066 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110067 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110068 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110069 *
Nick Pigginda502952011-01-07 17:49:33 +110070 * If there is an ancestor relationship:
71 * dentry->d_parent->...->d_parent->d_lock
72 * ...
73 * dentry->d_parent->d_lock
74 * dentry->d_lock
75 *
76 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110077 * if (dentry1 < dentry2)
78 * dentry1->d_lock
79 * dentry2->d_lock
80 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080081int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
83
Al Viro74c3cbe2007-07-22 08:04:18 -040084__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Nick Piggin949854d2011-01-07 17:49:37 +110086EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Christoph Lametere18b8902006-12-06 20:33:20 -080088static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
David Howellscdf01222017-07-04 17:25:22 +010090const struct qstr empty_name = QSTR_INIT("", 0);
91EXPORT_SYMBOL(empty_name);
92const struct qstr slash_name = QSTR_INIT("/", 1);
93EXPORT_SYMBOL(slash_name);
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095/*
96 * This is the single most critical data structure when it comes
97 * to the dcache: the hashtable for lookups. Somebody should try
98 * to make this good - I've just made it work.
99 *
100 * This hash-function tries to avoid losing too many bits of hash
101 * information, yet avoid using a prime hash-size or similar.
102 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800104static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100105
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700106static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107
Linus Torvalds8387ff22016-06-10 07:51:30 -0700108static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300110 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111}
112
Al Viro94bdd652016-04-15 02:42:04 -0400113#define IN_LOOKUP_SHIFT 10
114static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
115
116static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
117 unsigned int hash)
118{
119 hash += (unsigned long) parent / L1_CACHE_BYTES;
120 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
121}
122
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124/* Statistics gathering. */
125struct dentry_stat_t dentry_stat = {
126 .age_limit = 45,
127};
128
Glauber Costa3942c072013-08-28 10:17:53 +1000129static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000130static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400131
132#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000133
134/*
135 * Here we resort to our own counters instead of using generic per-cpu counters
136 * for consistency with what the vfs inode code does. We are expected to harvest
137 * better code and performance by having our own specialized counters.
138 *
139 * Please note that the loop is done over all possible CPUs, not over all online
140 * CPUs. The reason for this is that we don't want to play games with CPUs going
141 * on and off. If one of them goes off, we will just keep their counters.
142 *
143 * glommer: See cffbc8a for details, and if you ever intend to change this,
144 * please update all vfs counters to match.
145 */
Glauber Costa3942c072013-08-28 10:17:53 +1000146static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100147{
148 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000149 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100150 for_each_possible_cpu(i)
151 sum += per_cpu(nr_dentry, i);
152 return sum < 0 ? 0 : sum;
153}
154
Dave Chinner62d36c72013-08-28 10:17:54 +1000155static long get_nr_dentry_unused(void)
156{
157 int i;
158 long sum = 0;
159 for_each_possible_cpu(i)
160 sum += per_cpu(nr_dentry_unused, i);
161 return sum < 0 ? 0 : sum;
162}
163
Joe Perches1f7e0612014-06-06 14:38:05 -0700164int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400165 size_t *lenp, loff_t *ppos)
166{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100167 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000168 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000169 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400170}
171#endif
172
Linus Torvalds5483f182012-03-04 15:51:42 -0800173/*
174 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
175 * The strings are both count bytes long, and count is non-zero.
176 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700177#ifdef CONFIG_DCACHE_WORD_ACCESS
178
179#include <asm/word-at-a-time.h>
180/*
181 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
182 * aligned allocation for this particular component. We don't
183 * strictly need the load_unaligned_zeropad() safety, but it
184 * doesn't hurt either.
185 *
186 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
187 * need the careful unaligned handling.
188 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700189static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800190{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800192
193 for (;;) {
Andrey Ryabininbfe7aa62018-02-01 21:00:51 +0300194 a = read_word_at_a_time(cs);
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700195 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 if (tcount < sizeof(unsigned long))
197 break;
198 if (unlikely(a != b))
199 return 1;
200 cs += sizeof(unsigned long);
201 ct += sizeof(unsigned long);
202 tcount -= sizeof(unsigned long);
203 if (!tcount)
204 return 0;
205 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000206 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800207 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700208}
209
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800210#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700211
Linus Torvalds94753db52012-05-10 12:19:19 -0700212static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213{
Linus Torvalds5483f182012-03-04 15:51:42 -0800214 do {
215 if (*cs != *ct)
216 return 1;
217 cs++;
218 ct++;
219 tcount--;
220 } while (tcount);
221 return 0;
222}
223
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700224#endif
225
Linus Torvalds94753db52012-05-10 12:19:19 -0700226static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
227{
Linus Torvalds94753db52012-05-10 12:19:19 -0700228 /*
229 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100230 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700231 *
232 * NOTE! Even if a rename will mean that the length
233 * was not loaded atomically, we don't care. The
234 * RCU walk will check the sequence count eventually,
235 * and catch it. And we won't overrun the buffer,
236 * because we're reading the name pointer atomically,
237 * and a dentry name is guaranteed to be properly
238 * terminated with a NUL byte.
239 *
240 * End result: even if 'len' is wrong, we'll exit
241 * early because the data cannot match (there can
242 * be no NUL in the ct/tcount data)
243 */
Will Deacon506458e2017-10-24 11:22:48 +0100244 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000245
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700246 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700247}
248
Al Viro8d85b482014-09-29 14:54:27 -0400249struct external_name {
250 union {
251 atomic_t count;
252 struct rcu_head head;
253 } u;
254 unsigned char name[];
255};
256
257static inline struct external_name *external_name(struct dentry *dentry)
258{
259 return container_of(dentry->d_name.name, struct external_name, name[0]);
260}
261
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400262static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
265
Al Viro8d85b482014-09-29 14:54:27 -0400266 kmem_cache_free(dentry_cache, dentry);
267}
268
269static void __d_free_external(struct rcu_head *head)
270{
271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400272 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 kmem_cache_free(dentry_cache, dentry);
274}
275
Al Viro810bb172014-10-12 12:45:37 -0400276static inline int dname_external(const struct dentry *dentry)
277{
278 return dentry->d_name.name != dentry->d_iname;
279}
280
Al Viro49d31c22017-07-07 14:51:19 -0400281void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
282{
283 spin_lock(&dentry->d_lock);
284 if (unlikely(dname_external(dentry))) {
285 struct external_name *p = external_name(dentry);
286 atomic_inc(&p->u.count);
287 spin_unlock(&dentry->d_lock);
288 name->name = p->name;
289 } else {
290 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
291 spin_unlock(&dentry->d_lock);
292 name->name = name->inline_name;
293 }
294}
295EXPORT_SYMBOL(take_dentry_name_snapshot);
296
297void release_dentry_name_snapshot(struct name_snapshot *name)
298{
299 if (unlikely(name->name != name->inline_name)) {
300 struct external_name *p;
301 p = container_of(name->name, struct external_name, name[0]);
302 if (unlikely(atomic_dec_and_test(&p->u.count)))
303 kfree_rcu(p, u.head);
304 }
305}
306EXPORT_SYMBOL(release_dentry_name_snapshot);
307
David Howells4bf46a22015-03-05 14:09:22 +0000308static inline void __d_set_inode_and_type(struct dentry *dentry,
309 struct inode *inode,
310 unsigned type_flags)
311{
312 unsigned flags;
313
314 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000315 flags = READ_ONCE(dentry->d_flags);
316 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
317 flags |= type_flags;
318 WRITE_ONCE(dentry->d_flags, flags);
319}
320
David Howells4bf46a22015-03-05 14:09:22 +0000321static inline void __d_clear_type_and_inode(struct dentry *dentry)
322{
323 unsigned flags = READ_ONCE(dentry->d_flags);
324
325 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
326 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000327 dentry->d_inode = NULL;
328}
329
Al Virob4f03542014-04-29 23:40:14 -0400330static void dentry_free(struct dentry *dentry)
331{
Al Viro946e51f2014-10-26 19:19:16 -0400332 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400333 if (unlikely(dname_external(dentry))) {
334 struct external_name *p = external_name(dentry);
335 if (likely(atomic_dec_and_test(&p->u.count))) {
336 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
337 return;
338 }
339 }
Al Virob4f03542014-04-29 23:40:14 -0400340 /* if dentry was never visible to RCU, immediate free is OK */
341 if (!(dentry->d_flags & DCACHE_RCUACCESS))
342 __d_free(&dentry->d_u.d_rcu);
343 else
344 call_rcu(&dentry->d_u.d_rcu, __d_free);
345}
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347/*
348 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400349 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100350 */
351static void dentry_unlink_inode(struct dentry * dentry)
352 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100353 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100354{
355 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400356 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500357
Al Viro550dce02016-05-29 20:13:30 -0400358 if (hashed)
359 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000360 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400361 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400362 if (hashed)
363 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100364 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100365 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100366 if (!inode->i_nlink)
367 fsnotify_inoderemove(inode);
368 if (dentry->d_op && dentry->d_op->d_iput)
369 dentry->d_op->d_iput(dentry, inode);
370 else
371 iput(inode);
372}
373
374/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400375 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
376 * is in use - which includes both the "real" per-superblock
377 * LRU list _and_ the DCACHE_SHRINK_LIST use.
378 *
379 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
380 * on the shrink list (ie not on the superblock LRU list).
381 *
382 * The per-cpu "nr_dentry_unused" counters are updated with
383 * the DCACHE_LRU_LIST bit.
384 *
385 * These helper functions make sure we always follow the
386 * rules. d_lock must be held by the caller.
387 */
388#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
389static void d_lru_add(struct dentry *dentry)
390{
391 D_FLAG_VERIFY(dentry, 0);
392 dentry->d_flags |= DCACHE_LRU_LIST;
393 this_cpu_inc(nr_dentry_unused);
394 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
395}
396
397static void d_lru_del(struct dentry *dentry)
398{
399 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
400 dentry->d_flags &= ~DCACHE_LRU_LIST;
401 this_cpu_dec(nr_dentry_unused);
402 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
403}
404
405static void d_shrink_del(struct dentry *dentry)
406{
407 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
408 list_del_init(&dentry->d_lru);
409 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
410 this_cpu_dec(nr_dentry_unused);
411}
412
413static void d_shrink_add(struct dentry *dentry, struct list_head *list)
414{
415 D_FLAG_VERIFY(dentry, 0);
416 list_add(&dentry->d_lru, list);
417 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
418 this_cpu_inc(nr_dentry_unused);
419}
420
421/*
422 * These can only be called under the global LRU lock, ie during the
423 * callback for freeing the LRU list. "isolate" removes it from the
424 * LRU lists entirely, while shrink_move moves it to the indicated
425 * private list.
426 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800427static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400428{
429 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
430 dentry->d_flags &= ~DCACHE_LRU_LIST;
431 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800432 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400433}
434
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800435static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
436 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400437{
438 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
439 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800440 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400441}
442
Miklos Szeredid52b9082007-05-08 00:23:46 -0700443/**
Nick Piggin789680d2011-01-07 17:49:30 +1100444 * d_drop - drop a dentry
445 * @dentry: dentry to drop
446 *
447 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
448 * be found through a VFS lookup any more. Note that this is different from
449 * deleting the dentry - d_delete will try to mark the dentry negative if
450 * possible, giving a successful _negative_ lookup, while d_drop will
451 * just make the cache lookup fail.
452 *
453 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
454 * reason (NFS timeouts or autofs deletes).
455 *
NeilBrown61647822017-11-10 15:45:41 +1100456 * __d_drop requires dentry->d_lock
457 * ___d_drop doesn't mark dentry as "unhashed"
458 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100459 */
NeilBrown61647822017-11-10 15:45:41 +1100460static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100461{
Al Viro0632a9a2018-03-07 00:49:10 -0500462 struct hlist_bl_head *b;
463 /*
464 * Hashed dentries are normally on the dentry hashtable,
465 * with the exception of those newly allocated by
466 * d_obtain_root, which are always IS_ROOT:
467 */
468 if (unlikely(IS_ROOT(dentry)))
469 b = &dentry->d_sb->s_roots;
470 else
471 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400472
Al Viro0632a9a2018-03-07 00:49:10 -0500473 hlist_bl_lock(b);
474 __hlist_bl_del(&dentry->d_hash);
475 hlist_bl_unlock(b);
Nick Piggin789680d2011-01-07 17:49:30 +1100476}
NeilBrown61647822017-11-10 15:45:41 +1100477
478void __d_drop(struct dentry *dentry)
479{
Al Viro0632a9a2018-03-07 00:49:10 -0500480 if (!d_unhashed(dentry)) {
481 ___d_drop(dentry);
482 dentry->d_hash.pprev = NULL;
483 write_seqcount_invalidate(&dentry->d_seq);
484 }
NeilBrown61647822017-11-10 15:45:41 +1100485}
Nick Piggin789680d2011-01-07 17:49:30 +1100486EXPORT_SYMBOL(__d_drop);
487
488void d_drop(struct dentry *dentry)
489{
Nick Piggin789680d2011-01-07 17:49:30 +1100490 spin_lock(&dentry->d_lock);
491 __d_drop(dentry);
492 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100493}
494EXPORT_SYMBOL(d_drop);
495
Al Viroba65dc52016-06-10 11:32:47 -0400496static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
497{
498 struct dentry *next;
499 /*
500 * Inform d_walk() and shrink_dentry_list() that we are no longer
501 * attached to the dentry tree
502 */
503 dentry->d_flags |= DCACHE_DENTRY_KILLED;
504 if (unlikely(list_empty(&dentry->d_child)))
505 return;
506 __list_del_entry(&dentry->d_child);
507 /*
508 * Cursors can move around the list of children. While we'd been
509 * a normal list member, it didn't matter - ->d_child.next would've
510 * been updated. However, from now on it won't be and for the
511 * things like d_walk() it might end up with a nasty surprise.
512 * Normally d_walk() doesn't care about cursors moving around -
513 * ->d_lock on parent prevents that and since a cursor has no children
514 * of its own, we get through it without ever unlocking the parent.
515 * There is one exception, though - if we ascend from a child that
516 * gets killed as soon as we unlock it, the next sibling is found
517 * using the value left in its ->d_child.next. And if _that_
518 * pointed to a cursor, and cursor got moved (e.g. by lseek())
519 * before d_walk() regains parent->d_lock, we'll end up skipping
520 * everything the cursor had been moved past.
521 *
522 * Solution: make sure that the pointer left behind in ->d_child.next
523 * points to something that won't be moving around. I.e. skip the
524 * cursors.
525 */
526 while (dentry->d_child.next != &parent->d_subdirs) {
527 next = list_entry(dentry->d_child.next, struct dentry, d_child);
528 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
529 break;
530 dentry->d_child.next = next->d_child.next;
531 }
532}
533
Al Viroe55fd012014-05-28 13:51:12 -0400534static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100535{
Al Viro41edf2782014-05-01 10:30:00 -0400536 struct dentry *parent = NULL;
537 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400538 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100539 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100540
Linus Torvalds0d984392013-09-08 13:46:52 -0700541 /*
542 * The dentry is now unrecoverably dead to the world.
543 */
544 lockref_mark_dead(&dentry->d_lockref);
545
Sage Weilf0023bc2011-10-28 10:02:42 -0700546 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700547 * inform the fs via d_prune that this dentry is about to be
548 * unhashed and destroyed.
549 */
Al Viro29266202014-05-30 11:39:02 -0400550 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800551 dentry->d_op->d_prune(dentry);
552
Al Viro01b60352014-04-29 23:42:52 -0400553 if (dentry->d_flags & DCACHE_LRU_LIST) {
554 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
555 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400556 }
Nick Piggin77812a12011-01-07 17:49:48 +1100557 /* if it was on the hash then remove it */
558 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400559 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400560 if (parent)
561 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400562 if (dentry->d_inode)
563 dentry_unlink_inode(dentry);
564 else
565 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400566 this_cpu_dec(nr_dentry);
567 if (dentry->d_op && dentry->d_op->d_release)
568 dentry->d_op->d_release(dentry);
569
Al Viro41edf2782014-05-01 10:30:00 -0400570 spin_lock(&dentry->d_lock);
571 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
572 dentry->d_flags |= DCACHE_MAY_FREE;
573 can_free = false;
574 }
575 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400576 if (likely(can_free))
577 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400578}
579
Al Viro8b987a42018-02-23 22:11:34 -0500580static struct dentry *__lock_parent(struct dentry *dentry)
Al Viro046b9612014-05-29 08:54:52 -0400581{
Al Viro8b987a42018-02-23 22:11:34 -0500582 struct dentry *parent;
Al Viro046b9612014-05-29 08:54:52 -0400583 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400584 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400585again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700586 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400587 spin_lock(&parent->d_lock);
588 /*
589 * We can't blindly lock dentry until we are sure
590 * that we won't violate the locking order.
591 * Any changes of dentry->d_parent must have
592 * been done with parent->d_lock held, so
593 * spin_lock() above is enough of a barrier
594 * for checking if it's still our child.
595 */
596 if (unlikely(parent != dentry->d_parent)) {
597 spin_unlock(&parent->d_lock);
598 goto again;
599 }
Al Viro3b821402018-02-23 20:47:17 -0500600 rcu_read_unlock();
Al Viro65d8eb52018-02-23 22:07:35 -0500601 if (parent != dentry)
602 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
603 else
604 parent = NULL;
Al Viro046b9612014-05-29 08:54:52 -0400605 return parent;
606}
607
Al Viro8b987a42018-02-23 22:11:34 -0500608static inline struct dentry *lock_parent(struct dentry *dentry)
609{
610 struct dentry *parent = dentry->d_parent;
611 if (IS_ROOT(dentry))
612 return NULL;
613 if (likely(spin_trylock(&parent->d_lock)))
614 return parent;
615 return __lock_parent(dentry);
616}
617
Al Viroa3385792018-02-23 21:07:24 -0500618static inline bool retain_dentry(struct dentry *dentry)
619{
620 WARN_ON(d_in_lookup(dentry));
621
622 /* Unreachable? Get rid of it */
623 if (unlikely(d_unhashed(dentry)))
624 return false;
625
626 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
627 return false;
628
629 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
630 if (dentry->d_op->d_delete(dentry))
631 return false;
632 }
Al Viro62d99562018-03-06 21:37:31 -0500633 /* retain; LRU fodder */
634 dentry->d_lockref.count--;
635 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
636 d_lru_add(dentry);
637 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
638 dentry->d_flags |= DCACHE_REFERENCED;
Al Viroa3385792018-02-23 21:07:24 -0500639 return true;
640}
641
Linus Torvalds360f5472015-01-09 15:19:03 -0800642/*
John Ognessc1d0c1a2018-02-23 00:50:21 +0100643 * Finish off a dentry we've decided to kill.
644 * dentry->d_lock must be held, returns with it unlocked.
645 * Returns dentry requiring refcount drop, or NULL if we're done.
646 */
647static struct dentry *dentry_kill(struct dentry *dentry)
648 __releases(dentry->d_lock)
649{
650 struct inode *inode = dentry->d_inode;
651 struct dentry *parent = NULL;
652
653 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
654 goto failed;
655
656 if (!IS_ROOT(dentry)) {
657 parent = dentry->d_parent;
658 if (unlikely(!spin_trylock(&parent->d_lock))) {
659 if (inode)
660 spin_unlock(&inode->i_lock);
661 goto failed;
662 }
663 }
664
665 __dentry_kill(dentry);
666 return parent;
667
668failed:
669 spin_unlock(&dentry->d_lock);
670 return dentry; /* try again with same dentry */
671}
672
673/*
Linus Torvalds360f5472015-01-09 15:19:03 -0800674 * Try to do a lockless dput(), and return whether that was successful.
675 *
676 * If unsuccessful, we return false, having already taken the dentry lock.
677 *
678 * The caller needs to hold the RCU read lock, so that the dentry is
679 * guaranteed to stay around even if the refcount goes down to zero!
680 */
681static inline bool fast_dput(struct dentry *dentry)
682{
683 int ret;
684 unsigned int d_flags;
685
686 /*
687 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100688 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800689 */
690 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
691 return lockref_put_or_lock(&dentry->d_lockref);
692
693 /*
694 * .. otherwise, we can try to just decrement the
695 * lockref optimistically.
696 */
697 ret = lockref_put_return(&dentry->d_lockref);
698
699 /*
700 * If the lockref_put_return() failed due to the lock being held
701 * by somebody else, the fast path has failed. We will need to
702 * get the lock, and then check the count again.
703 */
704 if (unlikely(ret < 0)) {
705 spin_lock(&dentry->d_lock);
706 if (dentry->d_lockref.count > 1) {
707 dentry->d_lockref.count--;
708 spin_unlock(&dentry->d_lock);
709 return 1;
710 }
711 return 0;
712 }
713
714 /*
715 * If we weren't the last ref, we're done.
716 */
717 if (ret)
718 return 1;
719
720 /*
721 * Careful, careful. The reference count went down
722 * to zero, but we don't hold the dentry lock, so
723 * somebody else could get it again, and do another
724 * dput(), and we need to not race with that.
725 *
726 * However, there is a very special and common case
727 * where we don't care, because there is nothing to
728 * do: the dentry is still hashed, it does not have
729 * a 'delete' op, and it's referenced and already on
730 * the LRU list.
731 *
732 * NOTE! Since we aren't locked, these values are
733 * not "stable". However, it is sufficient that at
734 * some point after we dropped the reference the
735 * dentry was hashed and the flags had the proper
736 * value. Other dentry users may have re-gotten
737 * a reference to the dentry and change that, but
738 * our work is done - we can leave the dentry
739 * around with a zero refcount.
740 */
741 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700742 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100743 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800744
745 /* Nothing to do? Dropping the reference was all we needed? */
746 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
747 return 1;
748
749 /*
750 * Not the fast normal case? Get the lock. We've already decremented
751 * the refcount, but we'll need to re-check the situation after
752 * getting the lock.
753 */
754 spin_lock(&dentry->d_lock);
755
756 /*
757 * Did somebody else grab a reference to it in the meantime, and
758 * we're no longer the last user after all? Alternatively, somebody
759 * else could have killed it and marked it dead. Either way, we
760 * don't need to do anything else.
761 */
762 if (dentry->d_lockref.count) {
763 spin_unlock(&dentry->d_lock);
764 return 1;
765 }
766
767 /*
768 * Re-get the reference we optimistically dropped. We hold the
769 * lock, and we just tested that it was zero, so we can just
770 * set it to 1.
771 */
772 dentry->d_lockref.count = 1;
773 return 0;
774}
775
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777/*
778 * This is dput
779 *
780 * This is complicated by the fact that we do not want to put
781 * dentries that are no longer on any hash chain on the unused
782 * list: we'd much rather just get rid of them immediately.
783 *
784 * However, that implies that we have to traverse the dentry
785 * tree upwards to the parents which might _also_ now be
786 * scheduled for deletion (it may have been only waiting for
787 * its last child to go away).
788 *
789 * This tail recursion is done by hand as we don't want to depend
790 * on the compiler to always get this right (gcc generally doesn't).
791 * Real recursion would eat up our stack space.
792 */
793
794/*
795 * dput - release a dentry
796 * @dentry: dentry to release
797 *
798 * Release a dentry. This will drop the usage count and if appropriate
799 * call the dentry unlink method as well as removing it from the queues and
800 * releasing its resources. If the parent dentries were scheduled for release
801 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803void dput(struct dentry *dentry)
804{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700805 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 return;
807
808repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800809 might_sleep();
810
Linus Torvalds360f5472015-01-09 15:19:03 -0800811 rcu_read_lock();
812 if (likely(fast_dput(dentry))) {
813 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800815 }
816
817 /* Slow case: now with the dentry lock held */
818 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Al Viroa3385792018-02-23 21:07:24 -0500820 if (likely(retain_dentry(dentry))) {
Al Viroa3385792018-02-23 21:07:24 -0500821 spin_unlock(&dentry->d_lock);
822 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 }
Nick Piggin265ac902010-10-10 05:36:24 -0400824
Al Viro8cbf74d2014-05-29 09:18:26 -0400825 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800826 if (dentry) {
827 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700828 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800829 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700831EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100834/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100835static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Waiman Long98474232013-08-28 18:24:59 -0700837 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
Nick Piggindc0474b2011-01-07 17:49:43 +1100840static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100841{
Waiman Long98474232013-08-28 18:24:59 -0700842 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100843}
844
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100845struct dentry *dget_parent(struct dentry *dentry)
846{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700847 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100848 struct dentry *ret;
849
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700850 /*
851 * Do optimistic parent lookup without any
852 * locking.
853 */
854 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700855 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700856 gotref = lockref_get_not_zero(&ret->d_lockref);
857 rcu_read_unlock();
858 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700859 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700860 return ret;
861 dput(ret);
862 }
863
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100864repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100865 /*
866 * Don't need rcu_dereference because we re-check it was correct under
867 * the lock.
868 */
869 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100870 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100871 spin_lock(&ret->d_lock);
872 if (unlikely(ret != dentry->d_parent)) {
873 spin_unlock(&ret->d_lock);
874 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100875 goto repeat;
876 }
Nick Piggina734eb42011-01-07 17:49:44 +1100877 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700878 BUG_ON(!ret->d_lockref.count);
879 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100880 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100881 return ret;
882}
883EXPORT_SYMBOL(dget_parent);
884
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885/**
886 * d_find_alias - grab a hashed alias of inode
887 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 *
889 * If inode has a hashed alias, or is a directory and has any alias,
890 * acquire the reference to alias and return it. Otherwise return NULL.
891 * Notice that if inode is a directory there can be only one alias and
892 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800893 * of a filesystem, or if the directory was renamed and d_revalidate
894 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700896 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500897 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500899static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900{
Nick Pigginda502952011-01-07 17:49:33 +1100901 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Nick Pigginda502952011-01-07 17:49:33 +1100903again:
904 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400905 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100906 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700908 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100909 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500911 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100912 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100913 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 return alias;
915 }
916 }
Nick Pigginda502952011-01-07 17:49:33 +1100917 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 }
Nick Pigginda502952011-01-07 17:49:33 +1100919 if (discon_alias) {
920 alias = discon_alias;
921 spin_lock(&alias->d_lock);
922 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500923 __dget_dlock(alias);
924 spin_unlock(&alias->d_lock);
925 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100926 }
927 spin_unlock(&alias->d_lock);
928 goto again;
929 }
930 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
Nick Pigginda502952011-01-07 17:49:33 +1100933struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
David Howells214fda12006-03-25 03:06:36 -0800935 struct dentry *de = NULL;
936
Al Virob3d9b7a2012-06-09 13:51:19 -0400937 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100938 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500939 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100940 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800941 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 return de;
943}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700944EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
946/*
947 * Try to kill dentries associated with this inode.
948 * WARNING: you must own a reference to inode.
949 */
950void d_prune_aliases(struct inode *inode)
951{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700952 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100954 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400955 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700957 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400958 struct dentry *parent = lock_parent(dentry);
959 if (likely(!dentry->d_lockref.count)) {
960 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800961 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400962 goto restart;
963 }
964 if (parent)
965 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 }
967 spin_unlock(&dentry->d_lock);
968 }
Nick Piggin873feea2011-01-07 17:50:06 +1100969 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700971EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Al Viro3b3f09f2018-02-23 21:54:18 -0500973/*
974 * Lock a dentry from shrink list.
975 * Note that dentry is *not* protected from concurrent dentry_kill(),
976 * d_delete(), etc. It is protected from freeing (by the fact of
977 * being on a shrink list), but everything else is fair game.
978 * Return false if dentry has been disrupted or grabbed, leaving
979 * the caller to kick it off-list. Otherwise, return true and have
980 * that dentry's inode and parent both locked.
981 */
982static bool shrink_lock_dentry(struct dentry *dentry)
983{
984 struct inode *inode;
985 struct dentry *parent;
986
987 if (dentry->d_lockref.count)
988 return false;
989
990 inode = dentry->d_inode;
991 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
992 rcu_read_lock(); /* to protect inode */
993 spin_unlock(&dentry->d_lock);
994 spin_lock(&inode->i_lock);
995 spin_lock(&dentry->d_lock);
996 if (unlikely(dentry->d_lockref.count))
997 goto out;
998 /* changed inode means that somebody had grabbed it */
999 if (unlikely(inode != dentry->d_inode))
1000 goto out;
1001 rcu_read_unlock();
1002 }
1003
1004 parent = dentry->d_parent;
1005 if (IS_ROOT(dentry) || likely(spin_trylock(&parent->d_lock)))
1006 return true;
1007
1008 rcu_read_lock(); /* to protect parent */
1009 spin_unlock(&dentry->d_lock);
1010 parent = READ_ONCE(dentry->d_parent);
1011 spin_lock(&parent->d_lock);
1012 if (unlikely(parent != dentry->d_parent)) {
1013 spin_unlock(&parent->d_lock);
1014 spin_lock(&dentry->d_lock);
1015 goto out;
1016 }
1017 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1018 if (likely(!dentry->d_lockref.count)) {
1019 rcu_read_unlock();
1020 return true;
1021 }
1022 spin_unlock(&parent->d_lock);
1023out:
1024 if (inode)
1025 spin_unlock(&inode->i_lock);
1026 rcu_read_unlock();
1027 return false;
1028}
1029
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001030static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031{
Miklos Szeredi60942f22014-05-02 15:38:39 -04001032 while (!list_empty(list)) {
Al Viro3b3f09f2018-02-23 21:54:18 -05001033 struct dentry *dentry, *parent;
Al Viroff2fde92014-05-28 13:59:13 -04001034 struct inode *inode;
Al Viro3b3f09f2018-02-23 21:54:18 -05001035
Miklos Szeredi60942f22014-05-02 15:38:39 -04001036 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +11001037 spin_lock(&dentry->d_lock);
Al Viro3b3f09f2018-02-23 21:54:18 -05001038 if (!shrink_lock_dentry(dentry)) {
1039 bool can_free = false;
1040 d_shrink_del(dentry);
1041 if (dentry->d_lockref.count < 0)
1042 can_free = dentry->d_flags & DCACHE_MAY_FREE;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001043 spin_unlock(&dentry->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001044 if (can_free)
1045 dentry_free(dentry);
1046 continue;
1047 }
Al Viro3b3f09f2018-02-23 21:54:18 -05001048 d_shrink_del(dentry);
1049 parent = dentry->d_parent;
Al Viroff2fde92014-05-28 13:59:13 -04001050 __dentry_kill(dentry);
Al Viro3b3f09f2018-02-23 21:54:18 -05001051 if (parent == dentry)
1052 continue;
Al Viro5c47e6d2014-04-29 16:13:18 -04001053 /*
1054 * We need to prune ancestors too. This is necessary to prevent
1055 * quadratic behavior of shrink_dcache_parent(), but is also
1056 * expected to be beneficial in reducing dentry cache
1057 * fragmentation.
1058 */
1059 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001060 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1061 parent = lock_parent(dentry);
1062 if (dentry->d_lockref.count != 1) {
1063 dentry->d_lockref.count--;
1064 spin_unlock(&dentry->d_lock);
1065 if (parent)
1066 spin_unlock(&parent->d_lock);
1067 break;
1068 }
1069 inode = dentry->d_inode; /* can't be NULL */
1070 if (unlikely(!spin_trylock(&inode->i_lock))) {
1071 spin_unlock(&dentry->d_lock);
1072 if (parent)
1073 spin_unlock(&parent->d_lock);
1074 cpu_relax();
1075 continue;
1076 }
1077 __dentry_kill(dentry);
1078 dentry = parent;
1079 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001081}
1082
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001083static enum lru_status dentry_lru_isolate(struct list_head *item,
1084 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001085{
1086 struct list_head *freeable = arg;
1087 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1088
1089
1090 /*
1091 * we are inverting the lru lock/dentry->d_lock here,
1092 * so use a trylock. If we fail to get the lock, just skip
1093 * it
1094 */
1095 if (!spin_trylock(&dentry->d_lock))
1096 return LRU_SKIP;
1097
1098 /*
1099 * Referenced dentries are still in use. If they have active
1100 * counts, just remove them from the LRU. Otherwise give them
1101 * another pass through the LRU.
1102 */
1103 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001104 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001105 spin_unlock(&dentry->d_lock);
1106 return LRU_REMOVED;
1107 }
1108
1109 if (dentry->d_flags & DCACHE_REFERENCED) {
1110 dentry->d_flags &= ~DCACHE_REFERENCED;
1111 spin_unlock(&dentry->d_lock);
1112
1113 /*
1114 * The list move itself will be made by the common LRU code. At
1115 * this point, we've dropped the dentry->d_lock but keep the
1116 * lru lock. This is safe to do, since every list movement is
1117 * protected by the lru lock even if both locks are held.
1118 *
1119 * This is guaranteed by the fact that all LRU management
1120 * functions are intermediated by the LRU API calls like
1121 * list_lru_add and list_lru_del. List movement in this file
1122 * only ever occur through this functions or through callbacks
1123 * like this one, that are called from the LRU API.
1124 *
1125 * The only exceptions to this are functions like
1126 * shrink_dentry_list, and code that first checks for the
1127 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1128 * operating only with stack provided lists after they are
1129 * properly isolated from the main list. It is thus, always a
1130 * local access.
1131 */
1132 return LRU_ROTATE;
1133 }
1134
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001135 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001136 spin_unlock(&dentry->d_lock);
1137
1138 return LRU_REMOVED;
1139}
1140
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001141/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001142 * prune_dcache_sb - shrink the dcache
1143 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001144 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001145 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001146 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1147 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001148 * function.
1149 *
1150 * This function may fail to free any resources if all the dentries are in
1151 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001152 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001153long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001154{
Dave Chinnerf6041562013-08-28 10:18:00 +10001155 LIST_HEAD(dispose);
1156 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001157
Vladimir Davydov503c3582015-02-12 14:58:47 -08001158 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1159 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001160 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001161 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162}
1163
Glauber Costa4e717f52013-08-28 10:18:03 +10001164static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001165 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001166{
Glauber Costa4e717f52013-08-28 10:18:03 +10001167 struct list_head *freeable = arg;
1168 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001169
Glauber Costa4e717f52013-08-28 10:18:03 +10001170 /*
1171 * we are inverting the lru lock/dentry->d_lock here,
1172 * so use a trylock. If we fail to get the lock, just skip
1173 * it
1174 */
1175 if (!spin_trylock(&dentry->d_lock))
1176 return LRU_SKIP;
1177
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001178 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001179 spin_unlock(&dentry->d_lock);
1180
1181 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001182}
1183
Glauber Costa4e717f52013-08-28 10:18:03 +10001184
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001185/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 * shrink_dcache_sb - shrink dcache for a superblock
1187 * @sb: superblock
1188 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001189 * Shrink the dcache for the specified super block. This is used to free
1190 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001192void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193{
Glauber Costa4e717f52013-08-28 10:18:03 +10001194 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001195
Glauber Costa4e717f52013-08-28 10:18:03 +10001196 do {
1197 LIST_HEAD(dispose);
1198
1199 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001200 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001201
1202 this_cpu_sub(nr_dentry_unused, freed);
1203 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001204 cond_resched();
1205 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001207EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001210 * enum d_walk_ret - action to talke during tree walk
1211 * @D_WALK_CONTINUE: contrinue walk
1212 * @D_WALK_QUIT: quit walk
1213 * @D_WALK_NORETRY: quit when retry is needed
1214 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001216enum d_walk_ret {
1217 D_WALK_CONTINUE,
1218 D_WALK_QUIT,
1219 D_WALK_NORETRY,
1220 D_WALK_SKIP,
1221};
1222
1223/**
1224 * d_walk - walk the dentry tree
1225 * @parent: start of walk
1226 * @data: data passed to @enter() and @finish()
1227 * @enter: callback when first entering the dentry
1228 * @finish: callback when successfully finished the walk
1229 *
1230 * The @enter() and @finish() callbacks are called with d_lock held.
1231 */
1232static void d_walk(struct dentry *parent, void *data,
1233 enum d_walk_ret (*enter)(void *, struct dentry *),
1234 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235{
Nick Piggin949854d2011-01-07 17:49:37 +11001236 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001238 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001239 enum d_walk_ret ret;
1240 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001241
Nick Piggin58db63d2011-01-07 17:49:39 +11001242again:
Al Viro48f5ec22013-09-09 15:22:25 -04001243 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001244 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001245 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001246
1247 ret = enter(data, this_parent);
1248 switch (ret) {
1249 case D_WALK_CONTINUE:
1250 break;
1251 case D_WALK_QUIT:
1252 case D_WALK_SKIP:
1253 goto out_unlock;
1254 case D_WALK_NORETRY:
1255 retry = false;
1256 break;
1257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258repeat:
1259 next = this_parent->d_subdirs.next;
1260resume:
1261 while (next != &this_parent->d_subdirs) {
1262 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001263 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001265
Al Viroba65dc52016-06-10 11:32:47 -04001266 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1267 continue;
1268
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001269 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001270
1271 ret = enter(data, dentry);
1272 switch (ret) {
1273 case D_WALK_CONTINUE:
1274 break;
1275 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001276 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001277 goto out_unlock;
1278 case D_WALK_NORETRY:
1279 retry = false;
1280 break;
1281 case D_WALK_SKIP:
1282 spin_unlock(&dentry->d_lock);
1283 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001284 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001285
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001287 spin_unlock(&this_parent->d_lock);
1288 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001290 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 goto repeat;
1292 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001293 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 }
1295 /*
1296 * All done at this level ... ascend and resume the search.
1297 */
Al Viroca5358e2014-10-26 19:31:10 -04001298 rcu_read_lock();
1299ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001301 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001302 this_parent = child->d_parent;
1303
Al Viro31dec132013-10-25 17:04:27 -04001304 spin_unlock(&child->d_lock);
1305 spin_lock(&this_parent->d_lock);
1306
Al Viroca5358e2014-10-26 19:31:10 -04001307 /* might go back up the wrong parent if we have had a rename. */
1308 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001309 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001310 /* go into the first sibling still alive */
1311 do {
1312 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001313 if (next == &this_parent->d_subdirs)
1314 goto ascend;
1315 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001316 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001317 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 goto resume;
1319 }
Al Viroca5358e2014-10-26 19:31:10 -04001320 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001321 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001322 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001323 if (finish)
1324 finish(data);
1325
1326out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001327 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001328 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001329 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001330
1331rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001332 spin_unlock(&this_parent->d_lock);
1333 rcu_read_unlock();
1334 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001335 if (!retry)
1336 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001337 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001338 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001340
Ian Kent01619492016-11-24 08:03:41 +11001341struct check_mount {
1342 struct vfsmount *mnt;
1343 unsigned int mounted;
1344};
1345
1346static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1347{
1348 struct check_mount *info = data;
1349 struct path path = { .mnt = info->mnt, .dentry = dentry };
1350
1351 if (likely(!d_mountpoint(dentry)))
1352 return D_WALK_CONTINUE;
1353 if (__path_is_mountpoint(&path)) {
1354 info->mounted = 1;
1355 return D_WALK_QUIT;
1356 }
1357 return D_WALK_CONTINUE;
1358}
1359
1360/**
1361 * path_has_submounts - check for mounts over a dentry in the
1362 * current namespace.
1363 * @parent: path to check.
1364 *
1365 * Return true if the parent or its subdirectories contain
1366 * a mount point in the current namespace.
1367 */
1368int path_has_submounts(const struct path *parent)
1369{
1370 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1371
1372 read_seqlock_excl(&mount_lock);
1373 d_walk(parent->dentry, &data, path_check_mount, NULL);
1374 read_sequnlock_excl(&mount_lock);
1375
1376 return data.mounted;
1377}
1378EXPORT_SYMBOL(path_has_submounts);
1379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001381 * Called by mount code to set a mountpoint and check if the mountpoint is
1382 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1383 * subtree can become unreachable).
1384 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001385 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001386 * this reason take rename_lock and d_lock on dentry and ancestors.
1387 */
1388int d_set_mounted(struct dentry *dentry)
1389{
1390 struct dentry *p;
1391 int ret = -ENOENT;
1392 write_seqlock(&rename_lock);
1393 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001394 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001395 spin_lock(&p->d_lock);
1396 if (unlikely(d_unhashed(p))) {
1397 spin_unlock(&p->d_lock);
1398 goto out;
1399 }
1400 spin_unlock(&p->d_lock);
1401 }
1402 spin_lock(&dentry->d_lock);
1403 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001404 ret = -EBUSY;
1405 if (!d_mountpoint(dentry)) {
1406 dentry->d_flags |= DCACHE_MOUNTED;
1407 ret = 0;
1408 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001409 }
1410 spin_unlock(&dentry->d_lock);
1411out:
1412 write_sequnlock(&rename_lock);
1413 return ret;
1414}
1415
1416/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001417 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 * and move any unused dentries to the end of the unused
1419 * list for prune_dcache(). We descend to the next level
1420 * whenever the d_subdirs list is non-empty and continue
1421 * searching.
1422 *
1423 * It returns zero iff there are no unused children,
1424 * otherwise it returns the number of children moved to
1425 * the end of the unused list. This may not be the total
1426 * number of unused children, because select_parent can
1427 * drop the lock and return early due to latency
1428 * constraints.
1429 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001430
1431struct select_data {
1432 struct dentry *start;
1433 struct list_head dispose;
1434 int found;
1435};
1436
1437static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001439 struct select_data *data = _data;
1440 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001442 if (data->start == dentry)
1443 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
Al Virofe915222014-05-03 00:02:25 -04001445 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001446 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001447 } else {
1448 if (dentry->d_flags & DCACHE_LRU_LIST)
1449 d_lru_del(dentry);
1450 if (!dentry->d_lockref.count) {
1451 d_shrink_add(dentry, &data->dispose);
1452 data->found++;
1453 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 }
1455 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001456 * We can return to the caller if we have found some (this
1457 * ensures forward progress). We'll be coming back to find
1458 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 */
Al Virofe915222014-05-03 00:02:25 -04001460 if (!list_empty(&data->dispose))
1461 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001463 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
1466/**
1467 * shrink_dcache_parent - prune dcache
1468 * @parent: parent of entries to prune
1469 *
1470 * Prune the dcache to remove unused children of the parent dentry.
1471 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001472void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001474 for (;;) {
1475 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001477 INIT_LIST_HEAD(&data.dispose);
1478 data.start = parent;
1479 data.found = 0;
1480
1481 d_walk(parent, &data, select_collect, NULL);
1482 if (!data.found)
1483 break;
1484
1485 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001486 cond_resched();
1487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001489EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
Al Viro9c8c10e2014-05-02 20:36:10 -04001491static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001492{
Al Viro9c8c10e2014-05-02 20:36:10 -04001493 /* it has busy descendents; complain about those instead */
1494 if (!list_empty(&dentry->d_subdirs))
1495 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001496
Al Viro9c8c10e2014-05-02 20:36:10 -04001497 /* root with refcount 1 is fine */
1498 if (dentry == _data && dentry->d_lockref.count == 1)
1499 return D_WALK_CONTINUE;
1500
1501 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1502 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001503 dentry,
1504 dentry->d_inode ?
1505 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001506 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001507 dentry->d_lockref.count,
1508 dentry->d_sb->s_type->name,
1509 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001510 WARN_ON(1);
1511 return D_WALK_CONTINUE;
1512}
1513
1514static void do_one_tree(struct dentry *dentry)
1515{
1516 shrink_dcache_parent(dentry);
1517 d_walk(dentry, dentry, umount_check, NULL);
1518 d_drop(dentry);
1519 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001520}
1521
1522/*
1523 * destroy the dentries attached to a superblock on unmounting
1524 */
1525void shrink_dcache_for_umount(struct super_block *sb)
1526{
1527 struct dentry *dentry;
1528
Al Viro9c8c10e2014-05-02 20:36:10 -04001529 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001530
1531 dentry = sb->s_root;
1532 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001533 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001534
NeilBrownf1ee6162017-12-21 09:45:40 +11001535 while (!hlist_bl_empty(&sb->s_roots)) {
1536 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001537 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001538 }
1539}
1540
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001541struct detach_data {
1542 struct select_data select;
1543 struct dentry *mountpoint;
1544};
1545static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001546{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001547 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001548
1549 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001550 __dget_dlock(dentry);
1551 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552 return D_WALK_QUIT;
1553 }
1554
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001555 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001556}
1557
1558static void check_and_drop(void *_data)
1559{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001560 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001561
Al Viro81be24d2017-06-03 07:20:09 +01001562 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001563 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001564}
1565
1566/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001567 * d_invalidate - detach submounts, prune dcache, and drop
1568 * @dentry: dentry to invalidate (aka detach, prune and drop)
1569 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001570 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001571 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001572 * The final d_drop is done as an atomic operation relative to
1573 * rename_lock ensuring there are no races with d_set_mounted. This
1574 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001576void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001577{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001578 /*
1579 * If it's already been dropped, return OK.
1580 */
1581 spin_lock(&dentry->d_lock);
1582 if (d_unhashed(dentry)) {
1583 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001584 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001585 }
1586 spin_unlock(&dentry->d_lock);
1587
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001588 /* Negative dentries can be dropped without further checks */
1589 if (!dentry->d_inode) {
1590 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001591 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001592 }
1593
1594 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001595 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001596
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001597 data.mountpoint = NULL;
1598 INIT_LIST_HEAD(&data.select.dispose);
1599 data.select.start = dentry;
1600 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001601
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001602 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001603
Al Viro81be24d2017-06-03 07:20:09 +01001604 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001605 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001606 else if (!data.mountpoint)
1607 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001608
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001609 if (data.mountpoint) {
1610 detach_mounts(data.mountpoint);
1611 dput(data.mountpoint);
1612 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001613 cond_resched();
1614 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001615}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001616EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618/**
Al Viroa4464db2011-07-07 15:03:58 -04001619 * __d_alloc - allocate a dcache entry
1620 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 * @name: qstr of the name
1622 *
1623 * Allocates a dentry. It returns %NULL if there is insufficient memory
1624 * available. On a success the dentry is returned. The name passed in is
1625 * copied and the copy passed in may be reused after this call.
1626 */
1627
Al Viroa4464db2011-07-07 15:03:58 -04001628struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
1630 struct dentry *dentry;
1631 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001632 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Mel Gormane12ba742007-10-16 01:25:52 -07001634 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 if (!dentry)
1636 return NULL;
1637
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001638 /*
1639 * We guarantee that the inline name is always NUL-terminated.
1640 * This way the memcpy() done by the name switching in rename
1641 * will still always have a NUL at the end, even if we might
1642 * be overwriting an internal NUL character
1643 */
1644 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001645 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001646 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001647 dname = dentry->d_iname;
1648 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001649 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001650 struct external_name *p = kmalloc(size + name->len,
1651 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001652 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 kmem_cache_free(dentry_cache, dentry);
1654 return NULL;
1655 }
Al Viro8d85b482014-09-29 14:54:27 -04001656 atomic_set(&p->u.count, 1);
1657 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 } else {
1659 dname = dentry->d_iname;
1660 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
1662 dentry->d_name.len = name->len;
1663 dentry->d_name.hash = name->hash;
1664 memcpy(dname, name->name, name->len);
1665 dname[name->len] = 0;
1666
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001667 /* Make sure we always see the terminating NUL character */
Paul E. McKenney7088efa2017-10-09 10:04:27 -07001668 smp_store_release(&dentry->d_name.name, dname); /* ^^^ */
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001669
Waiman Long98474232013-08-28 18:24:59 -07001670 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001671 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001673 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001675 dentry->d_parent = dentry;
1676 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 dentry->d_op = NULL;
1678 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001679 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 INIT_LIST_HEAD(&dentry->d_lru);
1681 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001682 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1683 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001684 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Miklos Szeredi285b1022016-06-28 11:47:32 +02001686 if (dentry->d_op && dentry->d_op->d_init) {
1687 err = dentry->d_op->d_init(dentry);
1688 if (err) {
1689 if (dname_external(dentry))
1690 kfree(external_name(dentry));
1691 kmem_cache_free(dentry_cache, dentry);
1692 return NULL;
1693 }
1694 }
1695
Nick Piggin3e880fb2011-01-07 17:49:19 +11001696 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 return dentry;
1699}
Al Viroa4464db2011-07-07 15:03:58 -04001700
1701/**
1702 * d_alloc - allocate a dcache entry
1703 * @parent: parent of entry to allocate
1704 * @name: qstr of the name
1705 *
1706 * Allocates a dentry. It returns %NULL if there is insufficient memory
1707 * available. On a success the dentry is returned. The name passed in is
1708 * copied and the copy passed in may be reused after this call.
1709 */
1710struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1711{
1712 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1713 if (!dentry)
1714 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001715 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001716 spin_lock(&parent->d_lock);
1717 /*
1718 * don't need child lock because it is not subject
1719 * to concurrency here
1720 */
1721 __dget_dlock(parent);
1722 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001723 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001724 spin_unlock(&parent->d_lock);
1725
1726 return dentry;
1727}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001728EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
Miklos Szeredif9c34672018-01-19 11:39:52 +01001730struct dentry *d_alloc_anon(struct super_block *sb)
1731{
1732 return __d_alloc(sb, NULL);
1733}
1734EXPORT_SYMBOL(d_alloc_anon);
1735
Al Viroba65dc52016-06-10 11:32:47 -04001736struct dentry *d_alloc_cursor(struct dentry * parent)
1737{
Miklos Szeredif9c34672018-01-19 11:39:52 +01001738 struct dentry *dentry = d_alloc_anon(parent->d_sb);
Al Viroba65dc52016-06-10 11:32:47 -04001739 if (dentry) {
1740 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1741 dentry->d_parent = dget(parent);
1742 }
1743 return dentry;
1744}
1745
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001746/**
1747 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1748 * @sb: the superblock
1749 * @name: qstr of the name
1750 *
1751 * For a filesystem that just pins its dentries in memory and never
1752 * performs lookups at all, return an unhashed IS_ROOT dentry.
1753 */
Nick Piggin4b936882011-01-07 17:50:07 +11001754struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1755{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001756 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001757}
1758EXPORT_SYMBOL(d_alloc_pseudo);
1759
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1761{
1762 struct qstr q;
1763
1764 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001765 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 return d_alloc(parent, &q);
1767}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001768EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Nick Pigginfb045ad2011-01-07 17:49:55 +11001770void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1771{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001772 WARN_ON_ONCE(dentry->d_op);
1773 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001774 DCACHE_OP_COMPARE |
1775 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001776 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001777 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001778 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001779 dentry->d_op = op;
1780 if (!op)
1781 return;
1782 if (op->d_hash)
1783 dentry->d_flags |= DCACHE_OP_HASH;
1784 if (op->d_compare)
1785 dentry->d_flags |= DCACHE_OP_COMPARE;
1786 if (op->d_revalidate)
1787 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001788 if (op->d_weak_revalidate)
1789 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001790 if (op->d_delete)
1791 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001792 if (op->d_prune)
1793 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001794 if (op->d_real)
1795 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001796
1797}
1798EXPORT_SYMBOL(d_set_d_op);
1799
David Howellsdf1a0852015-01-29 12:02:28 +00001800
1801/*
1802 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1803 * @dentry - The dentry to mark
1804 *
1805 * Mark a dentry as falling through to the lower layer (as set with
1806 * d_pin_lower()). This flag may be recorded on the medium.
1807 */
1808void d_set_fallthru(struct dentry *dentry)
1809{
1810 spin_lock(&dentry->d_lock);
1811 dentry->d_flags |= DCACHE_FALLTHRU;
1812 spin_unlock(&dentry->d_lock);
1813}
1814EXPORT_SYMBOL(d_set_fallthru);
1815
David Howellsb18825a2013-09-12 19:22:53 +01001816static unsigned d_flags_for_inode(struct inode *inode)
1817{
David Howells44bdb5e2015-01-29 12:02:29 +00001818 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001819
1820 if (!inode)
1821 return DCACHE_MISS_TYPE;
1822
1823 if (S_ISDIR(inode->i_mode)) {
1824 add_flags = DCACHE_DIRECTORY_TYPE;
1825 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1826 if (unlikely(!inode->i_op->lookup))
1827 add_flags = DCACHE_AUTODIR_TYPE;
1828 else
1829 inode->i_opflags |= IOP_LOOKUP;
1830 }
David Howells44bdb5e2015-01-29 12:02:29 +00001831 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001832 }
1833
David Howells44bdb5e2015-01-29 12:02:29 +00001834 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001835 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001836 add_flags = DCACHE_SYMLINK_TYPE;
1837 goto type_determined;
1838 }
1839 inode->i_opflags |= IOP_NOFOLLOW;
1840 }
1841
1842 if (unlikely(!S_ISREG(inode->i_mode)))
1843 add_flags = DCACHE_SPECIAL_TYPE;
1844
1845type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001846 if (unlikely(IS_AUTOMOUNT(inode)))
1847 add_flags |= DCACHE_NEED_AUTOMOUNT;
1848 return add_flags;
1849}
1850
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001851static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1852{
David Howellsb18825a2013-09-12 19:22:53 +01001853 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001854 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001855
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001856 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001857 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001858 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001859 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001860 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001861 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001862 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001863}
1864
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865/**
1866 * d_instantiate - fill in inode information for a dentry
1867 * @entry: dentry to complete
1868 * @inode: inode to attach to this dentry
1869 *
1870 * Fill in inode information in the entry.
1871 *
1872 * This turns negative dentries into productive full members
1873 * of society.
1874 *
1875 * NOTE! This assumes that the inode count has been incremented
1876 * (or otherwise set) by the caller to indicate that it is now
1877 * in use by the dcache.
1878 */
1879
1880void d_instantiate(struct dentry *entry, struct inode * inode)
1881{
Al Viro946e51f2014-10-26 19:19:16 -04001882 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001883 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001884 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001885 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001886 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001887 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001888 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001890EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
1892/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001893 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1894 * @entry: dentry to complete
1895 * @inode: inode to attach to this dentry
1896 *
1897 * Fill in inode information in the entry. If a directory alias is found, then
1898 * return an error (and drop inode). Together with d_materialise_unique() this
1899 * guarantees that a directory inode may never have more than one alias.
1900 */
1901int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1902{
Al Viro946e51f2014-10-26 19:19:16 -04001903 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001904
Al Virob9680912016-04-11 00:53:26 -04001905 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001906 spin_lock(&inode->i_lock);
1907 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1908 spin_unlock(&inode->i_lock);
1909 iput(inode);
1910 return -EBUSY;
1911 }
1912 __d_instantiate(entry, inode);
1913 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001914
1915 return 0;
1916}
1917EXPORT_SYMBOL(d_instantiate_no_diralias);
1918
Al Viroadc0e91a2012-01-08 16:49:21 -05001919struct dentry *d_make_root(struct inode *root_inode)
1920{
1921 struct dentry *res = NULL;
1922
1923 if (root_inode) {
Miklos Szeredif9c34672018-01-19 11:39:52 +01001924 res = d_alloc_anon(root_inode->i_sb);
Al Viroadc0e91a2012-01-08 16:49:21 -05001925 if (res)
1926 d_instantiate(res, root_inode);
1927 else
1928 iput(root_inode);
1929 }
1930 return res;
1931}
1932EXPORT_SYMBOL(d_make_root);
1933
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001934static struct dentry * __d_find_any_alias(struct inode *inode)
1935{
1936 struct dentry *alias;
1937
Al Virob3d9b7a2012-06-09 13:51:19 -04001938 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001939 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001940 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001941 __dget(alias);
1942 return alias;
1943}
1944
Sage Weil46f72b32012-01-10 09:04:37 -08001945/**
1946 * d_find_any_alias - find any alias for a given inode
1947 * @inode: inode to find an alias for
1948 *
1949 * If any aliases exist for the given inode, take and return a
1950 * reference for one of them. If no aliases exist, return %NULL.
1951 */
1952struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001953{
1954 struct dentry *de;
1955
1956 spin_lock(&inode->i_lock);
1957 de = __d_find_any_alias(inode);
1958 spin_unlock(&inode->i_lock);
1959 return de;
1960}
Sage Weil46f72b32012-01-10 09:04:37 -08001961EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001962
Miklos Szeredif9c34672018-01-19 11:39:52 +01001963static struct dentry *__d_instantiate_anon(struct dentry *dentry,
1964 struct inode *inode,
1965 bool disconnected)
1966{
1967 struct dentry *res;
1968 unsigned add_flags;
1969
1970 security_d_instantiate(dentry, inode);
1971 spin_lock(&inode->i_lock);
1972 res = __d_find_any_alias(inode);
1973 if (res) {
1974 spin_unlock(&inode->i_lock);
1975 dput(dentry);
1976 goto out_iput;
1977 }
1978
1979 /* attach a disconnected dentry */
1980 add_flags = d_flags_for_inode(inode);
1981
1982 if (disconnected)
1983 add_flags |= DCACHE_DISCONNECTED;
1984
1985 spin_lock(&dentry->d_lock);
1986 __d_set_inode_and_type(dentry, inode, add_flags);
1987 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Linus Torvalds139351f2018-02-05 13:05:20 -08001988 if (!disconnected) {
1989 hlist_bl_lock(&dentry->d_sb->s_roots);
1990 hlist_bl_add_head(&dentry->d_hash, &dentry->d_sb->s_roots);
1991 hlist_bl_unlock(&dentry->d_sb->s_roots);
1992 }
Miklos Szeredif9c34672018-01-19 11:39:52 +01001993 spin_unlock(&dentry->d_lock);
1994 spin_unlock(&inode->i_lock);
1995
1996 return dentry;
1997
1998 out_iput:
1999 iput(inode);
2000 return res;
2001}
2002
2003struct dentry *d_instantiate_anon(struct dentry *dentry, struct inode *inode)
2004{
2005 return __d_instantiate_anon(dentry, inode, true);
2006}
2007EXPORT_SYMBOL(d_instantiate_anon);
2008
2009static struct dentry *__d_obtain_alias(struct inode *inode, bool disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002010{
Christoph Hellwig9308a612008-08-11 15:49:12 +02002011 struct dentry *tmp;
2012 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002013
2014 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02002015 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002016 if (IS_ERR(inode))
2017 return ERR_CAST(inode);
2018
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05002019 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002020 if (res)
2021 goto out_iput;
2022
Miklos Szeredif9c34672018-01-19 11:39:52 +01002023 tmp = d_alloc_anon(inode->i_sb);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002024 if (!tmp) {
2025 res = ERR_PTR(-ENOMEM);
2026 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002027 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11002028
Miklos Szeredif9c34672018-01-19 11:39:52 +01002029 return __d_instantiate_anon(tmp, inode, disconnected);
Christoph Hellwig9308a612008-08-11 15:49:12 +02002030
Miklos Szeredif9c34672018-01-19 11:39:52 +01002031out_iput:
Christoph Hellwig9308a612008-08-11 15:49:12 +02002032 iput(inode);
2033 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002034}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002035
2036/**
2037 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2038 * @inode: inode to allocate the dentry for
2039 *
2040 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2041 * similar open by handle operations. The returned dentry may be anonymous,
2042 * or may have a full name (if the inode was already in the cache).
2043 *
2044 * When called on a directory inode, we must ensure that the inode only ever
2045 * has one dentry. If a dentry is found, that is returned instead of
2046 * allocating a new one.
2047 *
2048 * On successful return, the reference to the inode has been transferred
2049 * to the dentry. In case of an error the reference on the inode is released.
2050 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2051 * be passed in and the error will be propagated to the return value,
2052 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2053 */
2054struct dentry *d_obtain_alias(struct inode *inode)
2055{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002056 return __d_obtain_alias(inode, true);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002057}
Benny Halevyadc48722009-02-27 14:02:59 -08002058EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059
2060/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002061 * d_obtain_root - find or allocate a dentry for a given inode
2062 * @inode: inode to allocate the dentry for
2063 *
2064 * Obtain an IS_ROOT dentry for the root of a filesystem.
2065 *
2066 * We must ensure that directory inodes only ever have one dentry. If a
2067 * dentry is found, that is returned instead of allocating a new one.
2068 *
2069 * On successful return, the reference to the inode has been transferred
2070 * to the dentry. In case of an error the reference on the inode is
2071 * released. A %NULL or IS_ERR inode may be passed in and will be the
2072 * error will be propagate to the return value, with a %NULL @inode
2073 * replaced by ERR_PTR(-ESTALE).
2074 */
2075struct dentry *d_obtain_root(struct inode *inode)
2076{
Miklos Szeredif9c34672018-01-19 11:39:52 +01002077 return __d_obtain_alias(inode, false);
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002078}
2079EXPORT_SYMBOL(d_obtain_root);
2080
2081/**
Barry Naujok94035402008-05-21 16:50:46 +10002082 * d_add_ci - lookup or allocate new dentry with case-exact name
2083 * @inode: the inode case-insensitive lookup has found
2084 * @dentry: the negative dentry that was passed to the parent's lookup func
2085 * @name: the case-exact name to be associated with the returned dentry
2086 *
2087 * This is to avoid filling the dcache with case-insensitive names to the
2088 * same inode, only the actual correct case is stored in the dcache for
2089 * case-insensitive filesystems.
2090 *
2091 * For a case-insensitive lookup match and if the the case-exact dentry
2092 * already exists in in the dcache, use it and return it.
2093 *
2094 * If no entry exists with the exact case name, allocate new dentry with
2095 * the exact case, and return the spliced entry.
2096 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002097struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002098 struct qstr *name)
2099{
Al Virod9171b92016-04-15 03:33:13 -04002100 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002101
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002102 /*
2103 * First check if a dentry matching the name already exists,
2104 * if not go ahead and create it now.
2105 */
Barry Naujok94035402008-05-21 16:50:46 +10002106 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002107 if (found) {
2108 iput(inode);
2109 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002110 }
Al Virod9171b92016-04-15 03:33:13 -04002111 if (d_in_lookup(dentry)) {
2112 found = d_alloc_parallel(dentry->d_parent, name,
2113 dentry->d_wait);
2114 if (IS_ERR(found) || !d_in_lookup(found)) {
2115 iput(inode);
2116 return found;
2117 }
2118 } else {
2119 found = d_alloc(dentry->d_parent, name);
2120 if (!found) {
2121 iput(inode);
2122 return ERR_PTR(-ENOMEM);
2123 }
2124 }
2125 res = d_splice_alias(inode, found);
2126 if (res) {
2127 dput(found);
2128 return res;
2129 }
Al Viro4f522a22013-02-11 23:20:37 -05002130 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002131}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002132EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002134
Al Virod4c91a82016-06-25 23:33:49 -04002135static inline bool d_same_name(const struct dentry *dentry,
2136 const struct dentry *parent,
2137 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002138{
Al Virod4c91a82016-06-25 23:33:49 -04002139 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2140 if (dentry->d_name.len != name->len)
2141 return false;
2142 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002143 }
Al Viro6fa67e72016-07-31 16:37:25 -04002144 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002145 dentry->d_name.len, dentry->d_name.name,
2146 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002147}
2148
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002150 * __d_lookup_rcu - search for a dentry (racy, store-free)
2151 * @parent: parent dentry
2152 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002153 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002154 * Returns: dentry, or NULL
2155 *
2156 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2157 * resolution (store-free path walking) design described in
2158 * Documentation/filesystems/path-lookup.txt.
2159 *
2160 * This is not to be used outside core vfs.
2161 *
2162 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2163 * held, and rcu_read_lock held. The returned dentry must not be stored into
2164 * without taking d_lock and checking d_seq sequence count against @seq
2165 * returned here.
2166 *
Linus Torvalds15570082013-09-02 11:38:06 -07002167 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002168 * function.
2169 *
2170 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2171 * the returned dentry, so long as its parent's seqlock is checked after the
2172 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2173 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002174 *
2175 * NOTE! The caller *has* to check the resulting dentry against the sequence
2176 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002177 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002178struct dentry *__d_lookup_rcu(const struct dentry *parent,
2179 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002180 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002181{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002182 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002183 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002184 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002185 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002186 struct dentry *dentry;
2187
2188 /*
2189 * Note: There is significant duplication with __d_lookup_rcu which is
2190 * required to prevent single threaded performance regressions
2191 * especially on architectures where smp_rmb (in seqcounts) are costly.
2192 * Keep the two functions in sync.
2193 */
2194
2195 /*
2196 * The hash list is protected using RCU.
2197 *
2198 * Carefully use d_seq when comparing a candidate dentry, to avoid
2199 * races with d_move().
2200 *
2201 * It is possible that concurrent renames can mess up our list
2202 * walk here and result in missing our dentry, resulting in the
2203 * false-negative result. d_lookup() protects against concurrent
2204 * renames using rename_lock seqlock.
2205 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002206 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002207 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002208 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002209 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002210
Nick Piggin31e6b012011-01-07 17:49:52 +11002211seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002212 /*
2213 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002214 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002215 *
2216 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002217 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002218 *
2219 * NOTE! We do a "raw" seqcount_begin here. That means that
2220 * we don't wait for the sequence count to stabilize if it
2221 * is in the middle of a sequence change. If we do the slow
2222 * dentry compare, we will do seqretries until it is stable,
2223 * and if we end up with a successful lookup, we actually
2224 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002225 *
2226 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2227 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002228 */
2229 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002230 if (dentry->d_parent != parent)
2231 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002232 if (d_unhashed(dentry))
2233 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002234
2235 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002236 int tlen;
2237 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002238 if (dentry->d_name.hash != hashlen_hash(hashlen))
2239 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002240 tlen = dentry->d_name.len;
2241 tname = dentry->d_name.name;
2242 /* we want a consistent (name,len) pair */
2243 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2244 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002245 goto seqretry;
2246 }
Al Viro6fa67e72016-07-31 16:37:25 -04002247 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002248 tlen, tname, name) != 0)
2249 continue;
2250 } else {
2251 if (dentry->d_name.hash_len != hashlen)
2252 continue;
2253 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2254 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002255 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002256 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002257 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002258 }
2259 return NULL;
2260}
2261
2262/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 * d_lookup - search for a dentry
2264 * @parent: parent dentry
2265 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002266 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002268 * d_lookup searches the children of the parent dentry for the name in
2269 * question. If the dentry is found its reference count is incremented and the
2270 * dentry is returned. The caller must use dput to free the entry when it has
2271 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 */
Al Viroda2d8452013-01-24 18:29:34 -05002273struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274{
Nick Piggin31e6b012011-01-07 17:49:52 +11002275 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002276 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277
Daeseok Younb8314f92014-08-11 11:46:53 +09002278 do {
2279 seq = read_seqbegin(&rename_lock);
2280 dentry = __d_lookup(parent, name);
2281 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 break;
2283 } while (read_seqretry(&rename_lock, seq));
2284 return dentry;
2285}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002286EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Nick Piggin31e6b012011-01-07 17:49:52 +11002288/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002289 * __d_lookup - search for a dentry (racy)
2290 * @parent: parent dentry
2291 * @name: qstr of name we wish to find
2292 * Returns: dentry, or NULL
2293 *
2294 * __d_lookup is like d_lookup, however it may (rarely) return a
2295 * false-negative result due to unrelated rename activity.
2296 *
2297 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2298 * however it must be used carefully, eg. with a following d_lookup in
2299 * the case of failure.
2300 *
2301 * __d_lookup callers must be commented.
2302 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002303struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002306 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002307 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002308 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002309 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
Nick Pigginb04f7842010-08-18 04:37:34 +10002311 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002312 * Note: There is significant duplication with __d_lookup_rcu which is
2313 * required to prevent single threaded performance regressions
2314 * especially on architectures where smp_rmb (in seqcounts) are costly.
2315 * Keep the two functions in sync.
2316 */
2317
2318 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002319 * The hash list is protected using RCU.
2320 *
2321 * Take d_lock when comparing a candidate dentry, to avoid races
2322 * with d_move().
2323 *
2324 * It is possible that concurrent renames can mess up our list
2325 * walk here and result in missing our dentry, resulting in the
2326 * false-negative result. d_lookup() protects against concurrent
2327 * renames using rename_lock seqlock.
2328 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002329 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002330 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 rcu_read_lock();
2332
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002333 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 if (dentry->d_name.hash != hash)
2336 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
2338 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 if (dentry->d_parent != parent)
2340 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002341 if (d_unhashed(dentry))
2342 goto next;
2343
Al Virod4c91a82016-06-25 23:33:49 -04002344 if (!d_same_name(dentry, parent, name))
2345 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346
Waiman Long98474232013-08-28 18:24:59 -07002347 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002348 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 spin_unlock(&dentry->d_lock);
2350 break;
2351next:
2352 spin_unlock(&dentry->d_lock);
2353 }
2354 rcu_read_unlock();
2355
2356 return found;
2357}
2358
2359/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002360 * d_hash_and_lookup - hash the qstr then search for a dentry
2361 * @dir: Directory to search in
2362 * @name: qstr of name we wish to find
2363 *
Al Viro4f522a22013-02-11 23:20:37 -05002364 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002365 */
2366struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2367{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002368 /*
2369 * Check for a fs-specific hash function. Note that we must
2370 * calculate the standard hash first, as the d_op->d_hash()
2371 * routine may choose to leave the hash value unchanged.
2372 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002373 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002374 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002375 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002376 if (unlikely(err < 0))
2377 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002378 }
Al Viro4f522a22013-02-11 23:20:37 -05002379 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002380}
Al Viro4f522a22013-02-11 23:20:37 -05002381EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002382
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383/*
2384 * When a file is deleted, we have two options:
2385 * - turn this dentry into a negative dentry
2386 * - unhash this dentry and free it.
2387 *
2388 * Usually, we want to just turn this into
2389 * a negative dentry, but if anybody else is
2390 * currently using the dentry or the inode
2391 * we can't do that and we fall back on removing
2392 * it from the hash queues and waiting for
2393 * it to be deleted later when it has no users
2394 */
2395
2396/**
2397 * d_delete - delete a dentry
2398 * @dentry: The dentry to delete
2399 *
2400 * Turn the dentry into a negative dentry if possible, otherwise
2401 * remove it from the hash queues so it can be deleted later
2402 */
2403
2404void d_delete(struct dentry * dentry)
2405{
Al Viroc19457f2018-02-23 21:02:31 -05002406 struct inode *inode = dentry->d_inode;
2407 int isdir = d_is_dir(dentry);
2408
2409 spin_lock(&inode->i_lock);
2410 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 /*
2412 * Are we the only user?
2413 */
Waiman Long98474232013-08-28 18:24:59 -07002414 if (dentry->d_lockref.count == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04002415 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002416 dentry_unlink_inode(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002417 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 __d_drop(dentry);
Al Viroc19457f2018-02-23 21:02:31 -05002419 spin_unlock(&dentry->d_lock);
2420 spin_unlock(&inode->i_lock);
2421 }
John McCutchan7a91bf72005-08-08 13:52:16 -04002422 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002424EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425
Al Viro15d3c582016-07-29 17:45:21 -04002426static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427{
Al Viro15d3c582016-07-29 17:45:21 -04002428 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002429
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002430 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002431 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002432 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433}
2434
2435/**
2436 * d_rehash - add an entry back to the hash
2437 * @entry: dentry to add to the hash
2438 *
2439 * Adds a dentry to the hash according to its name.
2440 */
2441
2442void d_rehash(struct dentry * entry)
2443{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002445 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002448EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
Al Viro84e710d2016-04-15 00:58:55 -04002450static inline unsigned start_dir_add(struct inode *dir)
2451{
2452
2453 for (;;) {
2454 unsigned n = dir->i_dir_seq;
2455 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2456 return n;
2457 cpu_relax();
2458 }
2459}
2460
2461static inline void end_dir_add(struct inode *dir, unsigned n)
2462{
2463 smp_store_release(&dir->i_dir_seq, n + 2);
2464}
2465
Al Virod9171b92016-04-15 03:33:13 -04002466static void d_wait_lookup(struct dentry *dentry)
2467{
2468 if (d_in_lookup(dentry)) {
2469 DECLARE_WAITQUEUE(wait, current);
2470 add_wait_queue(dentry->d_wait, &wait);
2471 do {
2472 set_current_state(TASK_UNINTERRUPTIBLE);
2473 spin_unlock(&dentry->d_lock);
2474 schedule();
2475 spin_lock(&dentry->d_lock);
2476 } while (d_in_lookup(dentry));
2477 }
2478}
2479
Al Viro94bdd652016-04-15 02:42:04 -04002480struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002481 const struct qstr *name,
2482 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002483{
Al Viro94bdd652016-04-15 02:42:04 -04002484 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002485 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2486 struct hlist_bl_node *node;
2487 struct dentry *new = d_alloc(parent, name);
2488 struct dentry *dentry;
2489 unsigned seq, r_seq, d_seq;
2490
2491 if (unlikely(!new))
2492 return ERR_PTR(-ENOMEM);
2493
2494retry:
2495 rcu_read_lock();
Will Deacon015555f2018-02-19 14:55:54 +00002496 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002497 r_seq = read_seqbegin(&rename_lock);
2498 dentry = __d_lookup_rcu(parent, name, &d_seq);
2499 if (unlikely(dentry)) {
2500 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2501 rcu_read_unlock();
2502 goto retry;
2503 }
2504 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2505 rcu_read_unlock();
2506 dput(dentry);
2507 goto retry;
2508 }
2509 rcu_read_unlock();
2510 dput(new);
2511 return dentry;
2512 }
2513 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2514 rcu_read_unlock();
2515 goto retry;
2516 }
Will Deacon015555f2018-02-19 14:55:54 +00002517
2518 if (unlikely(seq & 1)) {
2519 rcu_read_unlock();
2520 goto retry;
2521 }
2522
Al Viro94bdd652016-04-15 02:42:04 -04002523 hlist_bl_lock(b);
Will Deacon8cc07c82018-02-19 14:55:55 +00002524 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002525 hlist_bl_unlock(b);
2526 rcu_read_unlock();
2527 goto retry;
2528 }
Al Viro94bdd652016-04-15 02:42:04 -04002529 /*
2530 * No changes for the parent since the beginning of d_lookup().
2531 * Since all removals from the chain happen with hlist_bl_lock(),
2532 * any potential in-lookup matches are going to stay here until
2533 * we unlock the chain. All fields are stable in everything
2534 * we encounter.
2535 */
2536 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2537 if (dentry->d_name.hash != hash)
2538 continue;
2539 if (dentry->d_parent != parent)
2540 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002541 if (!d_same_name(dentry, parent, name))
2542 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002543 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002544 /* now we can try to grab a reference */
2545 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2546 rcu_read_unlock();
2547 goto retry;
2548 }
2549
2550 rcu_read_unlock();
2551 /*
2552 * somebody is likely to be still doing lookup for it;
2553 * wait for them to finish
2554 */
Al Virod9171b92016-04-15 03:33:13 -04002555 spin_lock(&dentry->d_lock);
2556 d_wait_lookup(dentry);
2557 /*
2558 * it's not in-lookup anymore; in principle we should repeat
2559 * everything from dcache lookup, but it's likely to be what
2560 * d_lookup() would've found anyway. If it is, just return it;
2561 * otherwise we really have to repeat the whole thing.
2562 */
2563 if (unlikely(dentry->d_name.hash != hash))
2564 goto mismatch;
2565 if (unlikely(dentry->d_parent != parent))
2566 goto mismatch;
2567 if (unlikely(d_unhashed(dentry)))
2568 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002569 if (unlikely(!d_same_name(dentry, parent, name)))
2570 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002571 /* OK, it *is* a hashed match; return it */
2572 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002573 dput(new);
2574 return dentry;
2575 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002576 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002577 /* we can't take ->d_lock here; it's OK, though. */
2578 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002579 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002580 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2581 hlist_bl_unlock(b);
2582 return new;
Al Virod9171b92016-04-15 03:33:13 -04002583mismatch:
2584 spin_unlock(&dentry->d_lock);
2585 dput(dentry);
2586 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002587}
2588EXPORT_SYMBOL(d_alloc_parallel);
2589
Al Viro85c7f812016-04-14 19:52:13 -04002590void __d_lookup_done(struct dentry *dentry)
2591{
Al Viro94bdd652016-04-15 02:42:04 -04002592 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2593 dentry->d_name.hash);
2594 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002595 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002596 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002597 wake_up_all(dentry->d_wait);
2598 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002599 hlist_bl_unlock(b);
2600 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002601 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002602}
2603EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002604
2605/* inode->i_lock held if inode is non-NULL */
2606
2607static inline void __d_add(struct dentry *dentry, struct inode *inode)
2608{
Al Viro84e710d2016-04-15 00:58:55 -04002609 struct inode *dir = NULL;
2610 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002611 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002612 if (unlikely(d_in_lookup(dentry))) {
2613 dir = dentry->d_parent->d_inode;
2614 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002615 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002616 }
Al Viroed782b52016-03-09 19:52:39 -05002617 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002618 unsigned add_flags = d_flags_for_inode(inode);
2619 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2620 raw_write_seqcount_begin(&dentry->d_seq);
2621 __d_set_inode_and_type(dentry, inode, add_flags);
2622 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002623 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002624 }
Al Viro15d3c582016-07-29 17:45:21 -04002625 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002626 if (dir)
2627 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002628 spin_unlock(&dentry->d_lock);
2629 if (inode)
2630 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002631}
2632
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002633/**
Al Viro34d0d192016-03-08 21:01:03 -05002634 * d_add - add dentry to hash queues
2635 * @entry: dentry to add
2636 * @inode: The inode to attach to this dentry
2637 *
2638 * This adds the entry to the hash queues and initializes @inode.
2639 * The entry was actually filled in earlier during d_alloc().
2640 */
2641
2642void d_add(struct dentry *entry, struct inode *inode)
2643{
Al Virob9680912016-04-11 00:53:26 -04002644 if (inode) {
2645 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002646 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002647 }
Al Viroed782b52016-03-09 19:52:39 -05002648 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002649}
2650EXPORT_SYMBOL(d_add);
2651
2652/**
Al Viro668d0cd2016-03-08 12:44:17 -05002653 * d_exact_alias - find and hash an exact unhashed alias
2654 * @entry: dentry to add
2655 * @inode: The inode to go with this dentry
2656 *
2657 * If an unhashed dentry with the same name/parent and desired
2658 * inode already exists, hash and return it. Otherwise, return
2659 * NULL.
2660 *
2661 * Parent directory should be locked.
2662 */
2663struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2664{
2665 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002666 unsigned int hash = entry->d_name.hash;
2667
2668 spin_lock(&inode->i_lock);
2669 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2670 /*
2671 * Don't need alias->d_lock here, because aliases with
2672 * d_parent == entry->d_parent are not subject to name or
2673 * parent changes, because the parent inode i_mutex is held.
2674 */
2675 if (alias->d_name.hash != hash)
2676 continue;
2677 if (alias->d_parent != entry->d_parent)
2678 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002679 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002680 continue;
2681 spin_lock(&alias->d_lock);
2682 if (!d_unhashed(alias)) {
2683 spin_unlock(&alias->d_lock);
2684 alias = NULL;
2685 } else {
2686 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002687 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002688 spin_unlock(&alias->d_lock);
2689 }
2690 spin_unlock(&inode->i_lock);
2691 return alias;
2692 }
2693 spin_unlock(&inode->i_lock);
2694 return NULL;
2695}
2696EXPORT_SYMBOL(d_exact_alias);
2697
2698/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002699 * dentry_update_name_case - update case insensitive dentry with a new name
2700 * @dentry: dentry to be updated
2701 * @name: new name
2702 *
2703 * Update a case insensitive dentry with new case of name.
2704 *
2705 * dentry must have been returned by d_lookup with name @name. Old and new
2706 * name lengths must match (ie. no d_compare which allows mismatched name
2707 * lengths).
2708 *
2709 * Parent inode i_mutex must be held over d_lookup and into this call (to
2710 * keep renames and concurrent inserts, and readdir(2) away).
2711 */
Al Viro9aba36d2016-07-20 22:28:45 -04002712void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002713{
Al Viro59551022016-01-22 15:40:57 -05002714 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002715 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2716
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002717 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002718 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002719 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002720 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002721 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002722}
2723EXPORT_SYMBOL(dentry_update_name_case);
2724
Al Viro8d85b482014-09-29 14:54:27 -04002725static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726{
Al Viro8d85b482014-09-29 14:54:27 -04002727 if (unlikely(dname_external(target))) {
2728 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 /*
2730 * Both external: swap the pointers
2731 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002732 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 } else {
2734 /*
2735 * dentry:internal, target:external. Steal target's
2736 * storage and make target internal.
2737 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002738 memcpy(target->d_iname, dentry->d_name.name,
2739 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740 dentry->d_name.name = target->d_name.name;
2741 target->d_name.name = target->d_iname;
2742 }
2743 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002744 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 /*
2746 * dentry:external, target:internal. Give dentry's
2747 * storage to target and make dentry internal
2748 */
2749 memcpy(dentry->d_iname, target->d_name.name,
2750 target->d_name.len + 1);
2751 target->d_name.name = dentry->d_name.name;
2752 dentry->d_name.name = dentry->d_iname;
2753 } else {
2754 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002755 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002757 unsigned int i;
2758 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2759 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2760 swap(((long *) &dentry->d_iname)[i],
2761 ((long *) &target->d_iname)[i]);
2762 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 }
2764 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002765 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
2767
Al Viro8d85b482014-09-29 14:54:27 -04002768static void copy_name(struct dentry *dentry, struct dentry *target)
2769{
2770 struct external_name *old_name = NULL;
2771 if (unlikely(dname_external(dentry)))
2772 old_name = external_name(dentry);
2773 if (unlikely(dname_external(target))) {
2774 atomic_inc(&external_name(target)->u.count);
2775 dentry->d_name = target->d_name;
2776 } else {
2777 memcpy(dentry->d_iname, target->d_name.name,
2778 target->d_name.len + 1);
2779 dentry->d_name.name = dentry->d_iname;
2780 dentry->d_name.hash_len = target->d_name.hash_len;
2781 }
2782 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2783 kfree_rcu(old_name, u.head);
2784}
2785
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002786static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2787{
2788 /*
2789 * XXXX: do we really need to take target->d_lock?
2790 */
2791 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2792 spin_lock(&target->d_parent->d_lock);
2793 else {
2794 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2795 spin_lock(&dentry->d_parent->d_lock);
2796 spin_lock_nested(&target->d_parent->d_lock,
2797 DENTRY_D_LOCK_NESTED);
2798 } else {
2799 spin_lock(&target->d_parent->d_lock);
2800 spin_lock_nested(&dentry->d_parent->d_lock,
2801 DENTRY_D_LOCK_NESTED);
2802 }
2803 }
2804 if (target < dentry) {
2805 spin_lock_nested(&target->d_lock, 2);
2806 spin_lock_nested(&dentry->d_lock, 3);
2807 } else {
2808 spin_lock_nested(&dentry->d_lock, 2);
2809 spin_lock_nested(&target->d_lock, 3);
2810 }
2811}
2812
Al Viro986c01942014-09-26 23:11:15 -04002813static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002814{
2815 if (target->d_parent != dentry->d_parent)
2816 spin_unlock(&dentry->d_parent->d_lock);
2817 if (target->d_parent != target)
2818 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002819 spin_unlock(&target->d_lock);
2820 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002821}
2822
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002824 * When switching names, the actual string doesn't strictly have to
2825 * be preserved in the target - because we're dropping the target
2826 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002827 * the new name before we switch, unless we are going to rehash
2828 * it. Note that if we *do* unhash the target, we are not allowed
2829 * to rehash it without giving it a new name/hash key - whether
2830 * we swap or overwrite the names here, resulting name won't match
2831 * the reality in filesystem; it's only there for d_path() purposes.
2832 * Note that all of this is happening under rename_lock, so the
2833 * any hash lookup seeing it in the middle of manipulations will
2834 * be discarded anyway. So we do not care what happens to the hash
2835 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002837/*
Al Viro18367502011-07-12 21:42:24 -04002838 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839 * @dentry: entry to move
2840 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002841 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 *
2843 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002844 * dcache entries should not be moved in this way. Caller must hold
2845 * rename_lock, the i_mutex of the source and target directories,
2846 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002848static void __d_move(struct dentry *dentry, struct dentry *target,
2849 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850{
Al Viro84e710d2016-04-15 00:58:55 -04002851 struct inode *dir = NULL;
2852 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 if (!dentry->d_inode)
2854 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2855
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002856 BUG_ON(d_ancestor(dentry, target));
2857 BUG_ON(d_ancestor(target, dentry));
2858
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002859 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002860 if (unlikely(d_in_lookup(target))) {
2861 dir = target->d_parent->d_inode;
2862 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002863 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002864 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865
Nick Piggin31e6b012011-01-07 17:49:52 +11002866 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002867 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002868
Al Viro15d3c582016-07-29 17:45:21 -04002869 /* unhash both */
Al Viro0632a9a2018-03-07 00:49:10 -05002870 if (!d_unhashed(dentry))
2871 ___d_drop(dentry);
2872 if (!d_unhashed(target))
2873 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002876 if (exchange)
2877 swap_names(dentry, target);
2878 else
2879 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880
Al Viro15d3c582016-07-29 17:45:21 -04002881 /* rehash in new place(s) */
2882 __d_rehash(dentry);
2883 if (exchange)
2884 __d_rehash(target);
NeilBrown61647822017-11-10 15:45:41 +11002885 else
2886 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002887
Al Viro63cf4272014-09-26 23:06:14 -04002888 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002890 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002891 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892 dentry->d_parent = target->d_parent;
2893 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002894 list_del_init(&target->d_child);
2895 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002897 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002898 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002899 list_move(&target->d_child, &target->d_parent->d_subdirs);
2900 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002901 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002902 fsnotify_update_flags(target);
2903 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904 }
2905
Nick Piggin31e6b012011-01-07 17:49:52 +11002906 write_seqcount_end(&target->d_seq);
2907 write_seqcount_end(&dentry->d_seq);
2908
Al Viro84e710d2016-04-15 00:58:55 -04002909 if (dir)
2910 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002911 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002912}
2913
2914/*
2915 * d_move - move a dentry
2916 * @dentry: entry to move
2917 * @target: new dentry
2918 *
2919 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002920 * dcache entries should not be moved in this way. See the locking
2921 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002922 */
2923void d_move(struct dentry *dentry, struct dentry *target)
2924{
2925 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002926 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002928}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002929EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930
Miklos Szeredida1ce062014-04-01 17:08:43 +02002931/*
2932 * d_exchange - exchange two dentries
2933 * @dentry1: first dentry
2934 * @dentry2: second dentry
2935 */
2936void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2937{
2938 write_seqlock(&rename_lock);
2939
2940 WARN_ON(!dentry1->d_inode);
2941 WARN_ON(!dentry2->d_inode);
2942 WARN_ON(IS_ROOT(dentry1));
2943 WARN_ON(IS_ROOT(dentry2));
2944
2945 __d_move(dentry1, dentry2, true);
2946
2947 write_sequnlock(&rename_lock);
2948}
2949
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002950/**
2951 * d_ancestor - search for an ancestor
2952 * @p1: ancestor dentry
2953 * @p2: child dentry
2954 *
2955 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2956 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002957 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002958struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002959{
2960 struct dentry *p;
2961
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002962 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002963 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002964 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002965 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002966 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002967}
2968
2969/*
2970 * This helper attempts to cope with remotely renamed directories
2971 *
2972 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002973 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002974 *
2975 * Note: If ever the locking in lock_rename() changes, then please
2976 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002977 */
Al Virob5ae6b12014-10-12 22:16:02 -04002978static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002979 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980{
Al Viro9902af72016-04-15 15:08:36 -04002981 struct mutex *m1 = NULL;
2982 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002983 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002984
2985 /* If alias and dentry share a parent, then no extra locks required */
2986 if (alias->d_parent == dentry->d_parent)
2987 goto out_unalias;
2988
Trond Myklebust9eaef272006-10-21 10:24:20 -07002989 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002990 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2991 goto out_err;
2992 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002993 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002994 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002995 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002996out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002997 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002998 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002999out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07003000 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04003001 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003002 if (m1)
3003 mutex_unlock(m1);
3004 return ret;
3005}
3006
David Howells770bfad2006-08-22 20:06:07 -04003007/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003008 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3009 * @inode: the inode which may have a disconnected dentry
3010 * @dentry: a negative dentry which we want to point to the inode.
3011 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003012 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3013 * place of the given dentry and return it, else simply d_add the inode
3014 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003015 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003016 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3017 * we should error out: directories can't have multiple aliases.
3018 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003019 * This is needed in the lookup routine of any filesystem that is exportable
3020 * (via knfsd) so that we can build dcache paths to directories effectively.
3021 *
3022 * If a dentry was found and moved, then it is returned. Otherwise NULL
3023 * is returned. This matches the expected return value of ->lookup.
3024 *
3025 * Cluster filesystems may call this function with a negative, hashed dentry.
3026 * In that case, we know that the inode will be a regular file, and also this
3027 * will only occur during atomic_open. So we need to check for the dentry
3028 * being already hashed only in the final case.
3029 */
3030struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3031{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003032 if (IS_ERR(inode))
3033 return ERR_CAST(inode);
3034
David Howells770bfad2006-08-22 20:06:07 -04003035 BUG_ON(!d_unhashed(dentry));
3036
Al Virode689f52016-03-09 18:05:42 -05003037 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003038 goto out;
Al Virode689f52016-03-09 18:05:42 -05003039
Al Virob9680912016-04-11 00:53:26 -04003040 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003041 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003042 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003043 struct dentry *new = __d_find_any_alias(inode);
3044 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003045 /* The reference to new ensures it remains an alias */
3046 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003047 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003048 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003049 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003050 dput(new);
3051 new = ERR_PTR(-ELOOP);
3052 pr_warn_ratelimited(
3053 "VFS: Lookup of '%s' in %s %s"
3054 " would have caused loop\n",
3055 dentry->d_name.name,
3056 inode->i_sb->s_type->name,
3057 inode->i_sb->s_id);
3058 } else if (!IS_ROOT(new)) {
3059 int err = __d_unalias(inode, dentry, new);
3060 write_sequnlock(&rename_lock);
3061 if (err) {
3062 dput(new);
3063 new = ERR_PTR(err);
3064 }
Al Viro18367502011-07-12 21:42:24 -04003065 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003066 __d_move(new, dentry, false);
3067 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003068 }
Al Virob5ae6b12014-10-12 22:16:02 -04003069 iput(inode);
3070 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003071 }
David Howells770bfad2006-08-22 20:06:07 -04003072 }
Al Virob5ae6b12014-10-12 22:16:02 -04003073out:
Al Viroed782b52016-03-09 19:52:39 -05003074 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003075 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003076}
Al Virob5ae6b12014-10-12 22:16:02 -04003077EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003078
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003079static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003080{
3081 *buflen -= namelen;
3082 if (*buflen < 0)
3083 return -ENAMETOOLONG;
3084 *buffer -= namelen;
3085 memcpy(*buffer, str, namelen);
3086 return 0;
3087}
3088
Waiman Long232d2d62013-09-09 12:18:13 -04003089/**
3090 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003091 * @buffer: buffer pointer
3092 * @buflen: allocated length of the buffer
3093 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003094 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003095 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003096 * make sure that either the old or the new name pointer and length are
3097 * fetched. However, there may be mismatch between length and pointer.
3098 * The length cannot be trusted, we need to copy it byte-by-byte until
3099 * the length is reached or a null byte is found. It also prepends "/" at
3100 * the beginning of the name. The sequence number check at the caller will
3101 * retry it again when a d_move() does happen. So any garbage in the buffer
3102 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003103 *
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003104 * Load acquire is needed to make sure that we see that terminating NUL.
Waiman Long232d2d62013-09-09 12:18:13 -04003105 */
Al Viro9aba36d2016-07-20 22:28:45 -04003106static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003107{
Paul E. McKenney7088efa2017-10-09 10:04:27 -07003108 const char *dname = smp_load_acquire(&name->name); /* ^^^ */
Mark Rutland66702eb2017-10-23 14:07:14 -07003109 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003110 char *p;
3111
Waiman Long232d2d62013-09-09 12:18:13 -04003112 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003113 if (*buflen < 0)
3114 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003115 p = *buffer -= dlen + 1;
3116 *p++ = '/';
3117 while (dlen--) {
3118 char c = *dname++;
3119 if (!c)
3120 break;
3121 *p++ = c;
3122 }
3123 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003124}
3125
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003127 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003128 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003129 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003130 * @buffer: pointer to the end of the buffer
3131 * @buflen: pointer to buffer length
3132 *
Waiman Long18129972013-09-12 10:55:35 -04003133 * The function will first try to write out the pathname without taking any
3134 * lock other than the RCU read lock to make sure that dentries won't go away.
3135 * It only checks the sequence number of the global rename_lock as any change
3136 * in the dentry's d_seq will be preceded by changes in the rename_lock
3137 * sequence number. If the sequence number had been changed, it will restart
3138 * the whole pathname back-tracing sequence again by taking the rename_lock.
3139 * In this case, there is no need to take the RCU read lock as the recursive
3140 * parent pointer references will keep the dentry chain alive as long as no
3141 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003142 */
Al Viro02125a82011-12-05 08:43:34 -05003143static int prepend_path(const struct path *path,
3144 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003145 char **buffer, int *buflen)
3146{
Al Viroede4ceb2013-11-13 07:45:40 -05003147 struct dentry *dentry;
3148 struct vfsmount *vfsmnt;
3149 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003150 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003151 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003152 char *bptr;
3153 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003154
Al Viro48f5ec22013-09-09 15:22:25 -04003155 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003156restart_mnt:
3157 read_seqbegin_or_lock(&mount_lock, &m_seq);
3158 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003159 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003160restart:
3161 bptr = *buffer;
3162 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003163 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003164 dentry = path->dentry;
3165 vfsmnt = path->mnt;
3166 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003167 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168 while (dentry != root->dentry || vfsmnt != root->mnt) {
3169 struct dentry * parent;
3170
3171 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003172 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003173 /* Escaped? */
3174 if (dentry != vfsmnt->mnt_root) {
3175 bptr = *buffer;
3176 blen = *buflen;
3177 error = 3;
3178 break;
3179 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003180 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003181 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003182 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003183 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003184 vfsmnt = &mnt->mnt;
3185 continue;
3186 }
Waiman Long232d2d62013-09-09 12:18:13 -04003187 if (!error)
3188 error = is_mounted(vfsmnt) ? 1 : 2;
3189 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003190 }
3191 parent = dentry->d_parent;
3192 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003193 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003194 if (error)
3195 break;
3196
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003197 dentry = parent;
3198 }
Al Viro48f5ec22013-09-09 15:22:25 -04003199 if (!(seq & 1))
3200 rcu_read_unlock();
3201 if (need_seqretry(&rename_lock, seq)) {
3202 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003203 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003204 }
Al Viro48f5ec22013-09-09 15:22:25 -04003205 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003206
3207 if (!(m_seq & 1))
3208 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003209 if (need_seqretry(&mount_lock, m_seq)) {
3210 m_seq = 1;
3211 goto restart_mnt;
3212 }
3213 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003214
Waiman Long232d2d62013-09-09 12:18:13 -04003215 if (error >= 0 && bptr == *buffer) {
3216 if (--blen < 0)
3217 error = -ENAMETOOLONG;
3218 else
3219 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003220 }
Waiman Long232d2d62013-09-09 12:18:13 -04003221 *buffer = bptr;
3222 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003223 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003224}
3225
3226/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003227 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003228 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003229 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003230 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231 * @buflen: buffer length
3232 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003233 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003235 * Returns a pointer into the buffer or an error code if the
3236 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003237 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003238 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003239 *
Al Viro02125a82011-12-05 08:43:34 -05003240 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241 */
Al Viro02125a82011-12-05 08:43:34 -05003242char *__d_path(const struct path *path,
3243 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003244 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003246 char *res = buf + buflen;
3247 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003249 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003250 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003251
Al Viro02125a82011-12-05 08:43:34 -05003252 if (error < 0)
3253 return ERR_PTR(error);
3254 if (error > 0)
3255 return NULL;
3256 return res;
3257}
3258
3259char *d_absolute_path(const struct path *path,
3260 char *buf, int buflen)
3261{
3262 struct path root = {};
3263 char *res = buf + buflen;
3264 int error;
3265
3266 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003267 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003268
3269 if (error > 1)
3270 error = -EINVAL;
3271 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003272 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003273 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
3275
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003276/*
3277 * same as __d_path but appends "(deleted)" for unlinked files.
3278 */
Al Viro02125a82011-12-05 08:43:34 -05003279static int path_with_deleted(const struct path *path,
3280 const struct path *root,
3281 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003282{
3283 prepend(buf, buflen, "\0", 1);
3284 if (d_unlinked(path->dentry)) {
3285 int error = prepend(buf, buflen, " (deleted)", 10);
3286 if (error)
3287 return error;
3288 }
3289
3290 return prepend_path(path, root, buf, buflen);
3291}
3292
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003293static int prepend_unreachable(char **buffer, int *buflen)
3294{
3295 return prepend(buffer, buflen, "(unreachable)", 13);
3296}
3297
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003298static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3299{
3300 unsigned seq;
3301
3302 do {
3303 seq = read_seqcount_begin(&fs->seq);
3304 *root = fs->root;
3305 } while (read_seqcount_retry(&fs->seq, seq));
3306}
3307
Jan Bluncka03a8a702008-02-14 19:38:32 -08003308/**
3309 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003310 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003311 * @buf: buffer to return value in
3312 * @buflen: buffer length
3313 *
3314 * Convert a dentry into an ASCII path name. If the entry has been deleted
3315 * the string " (deleted)" is appended. Note that this is ambiguous.
3316 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003317 * Returns a pointer into the buffer or an error code if the path was
3318 * too long. Note: Callers should use the returned pointer, not the passed
3319 * in buffer, to use the name! The implementation often starts at an offset
3320 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003321 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003322 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003323 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003324char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003326 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003327 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003328 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003329
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003330 /*
3331 * We have various synthetic filesystems that never get mounted. On
3332 * these filesystems dentries are never used for lookup purposes, and
3333 * thus don't need to be hashed. They also don't need a name until a
3334 * user wants to identify the object in /proc/pid/fd/. The little hack
3335 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003336 *
3337 * Some pseudo inodes are mountable. When they are mounted
3338 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3339 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003340 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003341 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3342 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003343 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003344
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003345 rcu_read_lock();
3346 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003347 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003348 rcu_read_unlock();
3349
Al Viro02125a82011-12-05 08:43:34 -05003350 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003351 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003352 return res;
3353}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003354EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003355
3356/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003357 * Helper function for dentry_operations.d_dname() members
3358 */
3359char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3360 const char *fmt, ...)
3361{
3362 va_list args;
3363 char temp[64];
3364 int sz;
3365
3366 va_start(args, fmt);
3367 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3368 va_end(args);
3369
3370 if (sz > sizeof(temp) || sz > buflen)
3371 return ERR_PTR(-ENAMETOOLONG);
3372
3373 buffer += buflen - sz;
3374 return memcpy(buffer, temp, sz);
3375}
3376
Al Viro118b2302013-08-24 12:08:17 -04003377char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3378{
3379 char *end = buffer + buflen;
3380 /* these dentries are never renamed, so d_lock is not needed */
3381 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003382 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003383 prepend(&end, &buflen, "/", 1))
3384 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003385 return end;
Al Viro118b2302013-08-24 12:08:17 -04003386}
David Herrmann31bbe162014-01-03 14:09:47 +01003387EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003388
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003389/*
Ram Pai6092d042008-03-27 13:06:20 +01003390 * Write full pathname from the root of the filesystem into the buffer.
3391 */
Al Virof6500802014-01-26 12:37:55 -05003392static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003393{
Al Virof6500802014-01-26 12:37:55 -05003394 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003395 char *end, *retval;
3396 int len, seq = 0;
3397 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003398
Al Virof6500802014-01-26 12:37:55 -05003399 if (buflen < 2)
3400 goto Elong;
3401
Al Viro48f5ec22013-09-09 15:22:25 -04003402 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003403restart:
Al Virof6500802014-01-26 12:37:55 -05003404 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003405 end = buf + buflen;
3406 len = buflen;
3407 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003408 /* Get '/' right */
3409 retval = end-1;
3410 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003411 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003412 while (!IS_ROOT(dentry)) {
3413 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003414
Ram Pai6092d042008-03-27 13:06:20 +01003415 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003416 error = prepend_name(&end, &len, &dentry->d_name);
3417 if (error)
3418 break;
Ram Pai6092d042008-03-27 13:06:20 +01003419
3420 retval = end;
3421 dentry = parent;
3422 }
Al Viro48f5ec22013-09-09 15:22:25 -04003423 if (!(seq & 1))
3424 rcu_read_unlock();
3425 if (need_seqretry(&rename_lock, seq)) {
3426 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003427 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003428 }
3429 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003430 if (error)
3431 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003432 return retval;
3433Elong:
3434 return ERR_PTR(-ENAMETOOLONG);
3435}
Nick Pigginec2447c2011-01-07 17:49:29 +11003436
3437char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3438{
Waiman Long232d2d62013-09-09 12:18:13 -04003439 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003440}
3441EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003442
3443char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3444{
3445 char *p = NULL;
3446 char *retval;
3447
Al Viroc1031352010-06-06 22:31:14 -04003448 if (d_unlinked(dentry)) {
3449 p = buf + buflen;
3450 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3451 goto Elong;
3452 buflen++;
3453 }
3454 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003455 if (!IS_ERR(retval) && p)
3456 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003457 return retval;
3458Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003459 return ERR_PTR(-ENAMETOOLONG);
3460}
3461
Linus Torvalds8b19e342013-09-12 10:35:47 -07003462static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3463 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003464{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003465 unsigned seq;
3466
3467 do {
3468 seq = read_seqcount_begin(&fs->seq);
3469 *root = fs->root;
3470 *pwd = fs->pwd;
3471 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003472}
3473
Ram Pai6092d042008-03-27 13:06:20 +01003474/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003475 * NOTE! The user-level library version returns a
3476 * character pointer. The kernel system call just
3477 * returns the length of the buffer filled (which
3478 * includes the ending '\0' character), or a negative
3479 * error value. So libc would do something like
3480 *
3481 * char *getcwd(char * buf, size_t size)
3482 * {
3483 * int retval;
3484 *
3485 * retval = sys_getcwd(buf, size);
3486 * if (retval >= 0)
3487 * return buf;
3488 * errno = -retval;
3489 * return NULL;
3490 * }
3491 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003492SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493{
Linus Torvalds552ce542007-02-13 12:08:18 -08003494 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003495 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003496 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497
3498 if (!page)
3499 return -ENOMEM;
3500
Linus Torvalds8b19e342013-09-12 10:35:47 -07003501 rcu_read_lock();
3502 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503
Linus Torvalds552ce542007-02-13 12:08:18 -08003504 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003505 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003506 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003507 char *cwd = page + PATH_MAX;
3508 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003510 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003511 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003512 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003513
Al Viro02125a82011-12-05 08:43:34 -05003514 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003515 goto out;
3516
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003517 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003518 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003519 error = prepend_unreachable(&cwd, &buflen);
3520 if (error)
3521 goto out;
3522 }
3523
Linus Torvalds552ce542007-02-13 12:08:18 -08003524 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003525 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003526 if (len <= size) {
3527 error = len;
3528 if (copy_to_user(buf, cwd, len))
3529 error = -EFAULT;
3530 }
Nick Piggin949854d2011-01-07 17:49:37 +11003531 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003532 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003533 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534
3535out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003536 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537 return error;
3538}
3539
3540/*
3541 * Test whether new_dentry is a subdirectory of old_dentry.
3542 *
3543 * Trivially implemented using the dcache structure
3544 */
3545
3546/**
3547 * is_subdir - is new dentry a subdirectory of old_dentry
3548 * @new_dentry: new dentry
3549 * @old_dentry: old dentry
3550 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003551 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3552 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3554 */
3555
Yaowei Baia6e57872015-11-17 14:40:11 +08003556bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557{
Yaowei Baia6e57872015-11-17 14:40:11 +08003558 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003559 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003560
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003561 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003562 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003563
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003564 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003566 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003567 /*
3568 * Need rcu_readlock to protect against the d_parent trashing
3569 * due to d_move
3570 */
3571 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003572 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003573 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003574 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003575 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003576 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578
3579 return result;
3580}
Amir Goldsteine8f9e5b2018-01-11 11:33:24 +02003581EXPORT_SYMBOL(is_subdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003583static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003584{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003585 struct dentry *root = data;
3586 if (dentry != root) {
3587 if (d_unhashed(dentry) || !dentry->d_inode)
3588 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003590 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3591 dentry->d_flags |= DCACHE_GENOCIDE;
3592 dentry->d_lockref.count--;
3593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003595 return D_WALK_CONTINUE;
3596}
Nick Piggin58db63d2011-01-07 17:49:39 +11003597
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003598void d_genocide(struct dentry *parent)
3599{
3600 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601}
3602
Al Viro60545d02013-06-07 01:20:27 -04003603void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604{
Al Viro60545d02013-06-07 01:20:27 -04003605 inode_dec_link_count(inode);
3606 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003607 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003608 !d_unlinked(dentry));
3609 spin_lock(&dentry->d_parent->d_lock);
3610 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3611 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3612 (unsigned long long)inode->i_ino);
3613 spin_unlock(&dentry->d_lock);
3614 spin_unlock(&dentry->d_parent->d_lock);
3615 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616}
Al Viro60545d02013-06-07 01:20:27 -04003617EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003618
3619static __initdata unsigned long dhash_entries;
3620static int __init set_dhash_entries(char *str)
3621{
3622 if (!str)
3623 return 0;
3624 dhash_entries = simple_strtoul(str, &str, 0);
3625 return 1;
3626}
3627__setup("dhash_entries=", set_dhash_entries);
3628
3629static void __init dcache_init_early(void)
3630{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003631 /* If hashes are distributed across NUMA nodes, defer
3632 * hash allocation until vmalloc space is available.
3633 */
3634 if (hashdist)
3635 return;
3636
3637 dentry_hashtable =
3638 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003639 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640 dhash_entries,
3641 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003642 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003643 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003644 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003645 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003647 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648}
3649
Denis Cheng74bf17c2007-10-16 23:26:30 -07003650static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003652 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003653 * A constructor could be added for stable state like the lists,
3654 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003655 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003656 */
David Windsor80344262017-06-10 22:50:44 -04003657 dentry_cache = KMEM_CACHE_USERCOPY(dentry,
3658 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT,
3659 d_iname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660
3661 /* Hash may have been set up in dcache_init_early */
3662 if (!hashdist)
3663 return;
3664
3665 dentry_hashtable =
3666 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003667 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003668 dhash_entries,
3669 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003670 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003671 &d_hash_shift,
Alexey Dobriyanb35d7862017-11-20 18:05:52 +03003672 NULL,
Tim Bird31fe62b2012-05-23 13:33:35 +00003673 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003674 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003675 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003676}
3677
3678/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003679struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003680EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003681
Linus Torvalds1da177e2005-04-16 15:20:36 -07003682EXPORT_SYMBOL(d_genocide);
3683
Linus Torvalds1da177e2005-04-16 15:20:36 -07003684void __init vfs_caches_init_early(void)
3685{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003686 int i;
3687
3688 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3689 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3690
Linus Torvalds1da177e2005-04-16 15:20:36 -07003691 dcache_init_early();
3692 inode_init_early();
3693}
3694
Mel Gorman4248b0d2015-08-06 15:46:20 -07003695void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003696{
David Windsor6a9b8822017-06-10 22:50:30 -04003697 names_cachep = kmem_cache_create_usercopy("names_cache", PATH_MAX, 0,
3698 SLAB_HWCACHE_ALIGN|SLAB_PANIC, 0, PATH_MAX, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003699
Denis Cheng74bf17c2007-10-16 23:26:30 -07003700 dcache_init();
3701 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003702 files_init();
3703 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003704 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003705 bdev_cache_init();
3706 chrdev_init();
3707}