blob: e1abf9c02abac1338695d6c6c1131c10d0520a33 [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>
Eric Biggers7bc138e2019-03-20 11:39:11 -070021#include <linux/fscrypt.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040022#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/slab.h>
24#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/hash.h>
26#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/mount.h>
29#include <linux/file.h>
30#include <asm/uaccess.h>
31#include <linux/security.h>
32#include <linux/seqlock.h>
33#include <linux/swap.h>
34#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040035#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020036#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110037#include <linux/bit_spinlock.h>
38#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070039#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010040#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100041#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080042#include <linux/kasan.h>
43
David Howells07f3f052006-09-30 20:52:18 +020044#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050045#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Nick Piggin789680d2011-01-07 17:49:30 +110047/*
48 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110049 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040050 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110051 * dcache_hash_bucket lock protects:
52 * - the dcache hash table
53 * s_anon bl list spinlock protects:
54 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100055 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110056 * - the dcache lru lists and counters
57 * d_lock protects:
58 * - d_flags
59 * - d_name
60 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110061 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110062 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110063 * - d_parent and d_subdirs
64 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040065 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110066 *
67 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110068 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110069 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100070 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110071 * dcache_hash_bucket lock
72 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110073 *
Nick Pigginda502952011-01-07 17:49:33 +110074 * If there is an ancestor relationship:
75 * dentry->d_parent->...->d_parent->d_lock
76 * ...
77 * dentry->d_parent->d_lock
78 * dentry->d_lock
79 *
80 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110081 * if (dentry1 < dentry2)
82 * dentry1->d_lock
83 * dentry2->d_lock
84 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080085int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
87
Al Viro74c3cbe2007-07-22 08:04:18 -040088__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Nick Piggin949854d2011-01-07 17:49:37 +110090EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Christoph Lametere18b8902006-12-06 20:33:20 -080092static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*
95 * This is the single most critical data structure when it comes
96 * to the dcache: the hashtable for lookups. Somebody should try
97 * to make this good - I've just made it work.
98 *
99 * This hash-function tries to avoid losing too many bits of hash
100 * information, yet avoid using a prime hash-size or similar.
101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800103static unsigned int d_hash_mask __read_mostly;
104static 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{
George Spelvin703b5fa2016-06-10 00:22:12 -0400110 return dentry_hashtable + (hash >> (32 - 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 (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700194 a = *(unsigned long *)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:
He Kuangae0a8432016-03-26 09:12:10 +0000230 * use 'lockless_dereference' 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 */
He Kuangae0a8432016-03-26 09:12:10 +0000244 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
245
Linus Torvalds6326c712012-05-21 16:14:04 -0700246 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700247}
248
Al Viro8d85b482014-09-29 14:54:27 -0400249struct external_name {
250 union {
251 atomic_t count;
252 struct rcu_head head;
253 } u;
254 unsigned char name[];
255};
256
257static inline struct external_name *external_name(struct dentry *dentry)
258{
259 return container_of(dentry->d_name.name, struct external_name, name[0]);
260}
261
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400262static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
265
Al Viro8d85b482014-09-29 14:54:27 -0400266 kmem_cache_free(dentry_cache, dentry);
267}
268
269static void __d_free_external(struct rcu_head *head)
270{
271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400272 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 kmem_cache_free(dentry_cache, dentry);
274}
275
Al Viro810bb172014-10-12 12:45:37 -0400276static inline int dname_external(const struct dentry *dentry)
277{
278 return dentry->d_name.name != dentry->d_iname;
279}
280
Al Viroad25f112017-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 {
Tetsuo Handafc2afa82018-08-17 15:44:34 -0700290 memcpy(name->inline_name, dentry->d_iname,
291 dentry->d_name.len + 1);
Al Viroad25f112017-07-07 14:51:19 -0400292 spin_unlock(&dentry->d_lock);
293 name->name = name->inline_name;
294 }
295}
296EXPORT_SYMBOL(take_dentry_name_snapshot);
297
298void release_dentry_name_snapshot(struct name_snapshot *name)
299{
300 if (unlikely(name->name != name->inline_name)) {
301 struct external_name *p;
302 p = container_of(name->name, struct external_name, name[0]);
303 if (unlikely(atomic_dec_and_test(&p->u.count)))
304 kfree_rcu(p, u.head);
305 }
306}
307EXPORT_SYMBOL(release_dentry_name_snapshot);
308
David Howells4bf46a22015-03-05 14:09:22 +0000309static inline void __d_set_inode_and_type(struct dentry *dentry,
310 struct inode *inode,
311 unsigned type_flags)
312{
313 unsigned flags;
314
315 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000316 flags = READ_ONCE(dentry->d_flags);
317 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
318 flags |= type_flags;
319 WRITE_ONCE(dentry->d_flags, flags);
320}
321
David Howells4bf46a22015-03-05 14:09:22 +0000322static inline void __d_clear_type_and_inode(struct dentry *dentry)
323{
324 unsigned flags = READ_ONCE(dentry->d_flags);
325
326 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
327 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000328 dentry->d_inode = NULL;
329}
330
Al Virob4f03542014-04-29 23:40:14 -0400331static void dentry_free(struct dentry *dentry)
332{
Al Viro946e51f2014-10-26 19:19:16 -0400333 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400334 if (unlikely(dname_external(dentry))) {
335 struct external_name *p = external_name(dentry);
336 if (likely(atomic_dec_and_test(&p->u.count))) {
337 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
338 return;
339 }
340 }
Al Virob4f03542014-04-29 23:40:14 -0400341 /* if dentry was never visible to RCU, immediate free is OK */
342 if (!(dentry->d_flags & DCACHE_RCUACCESS))
343 __d_free(&dentry->d_u.d_rcu);
344 else
345 call_rcu(&dentry->d_u.d_rcu, __d_free);
346}
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348/*
349 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400350 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100351 */
352static void dentry_unlink_inode(struct dentry * dentry)
353 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100354 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100355{
356 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500357
Al Viro59199c02018-08-09 10:15:54 -0400358 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000359 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400360 hlist_del_init(&dentry->d_u.d_alias);
Al Viro59199c02018-08-09 10:15:54 -0400361 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100362 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100363 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100364 if (!inode->i_nlink)
365 fsnotify_inoderemove(inode);
366 if (dentry->d_op && dentry->d_op->d_iput)
367 dentry->d_op->d_iput(dentry, inode);
368 else
369 iput(inode);
370}
371
372/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400373 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
374 * is in use - which includes both the "real" per-superblock
375 * LRU list _and_ the DCACHE_SHRINK_LIST use.
376 *
377 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
378 * on the shrink list (ie not on the superblock LRU list).
379 *
380 * The per-cpu "nr_dentry_unused" counters are updated with
381 * the DCACHE_LRU_LIST bit.
382 *
383 * These helper functions make sure we always follow the
384 * rules. d_lock must be held by the caller.
385 */
386#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
387static void d_lru_add(struct dentry *dentry)
388{
389 D_FLAG_VERIFY(dentry, 0);
390 dentry->d_flags |= DCACHE_LRU_LIST;
391 this_cpu_inc(nr_dentry_unused);
392 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
393}
394
395static void d_lru_del(struct dentry *dentry)
396{
397 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
398 dentry->d_flags &= ~DCACHE_LRU_LIST;
399 this_cpu_dec(nr_dentry_unused);
400 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
401}
402
403static void d_shrink_del(struct dentry *dentry)
404{
405 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
406 list_del_init(&dentry->d_lru);
407 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
408 this_cpu_dec(nr_dentry_unused);
409}
410
411static void d_shrink_add(struct dentry *dentry, struct list_head *list)
412{
413 D_FLAG_VERIFY(dentry, 0);
414 list_add(&dentry->d_lru, list);
415 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
416 this_cpu_inc(nr_dentry_unused);
417}
418
419/*
420 * These can only be called under the global LRU lock, ie during the
421 * callback for freeing the LRU list. "isolate" removes it from the
422 * LRU lists entirely, while shrink_move moves it to the indicated
423 * private list.
424 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800425static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400426{
427 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
428 dentry->d_flags &= ~DCACHE_LRU_LIST;
429 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800430 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400431}
432
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800433static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
434 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400435{
436 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
437 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800438 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400439}
440
441/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000442 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700443 */
444static void dentry_lru_add(struct dentry *dentry)
445{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400446 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
447 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700448}
449
Miklos Szeredid52b9082007-05-08 00:23:46 -0700450/**
Nick Piggin789680d2011-01-07 17:49:30 +1100451 * d_drop - drop a dentry
452 * @dentry: dentry to drop
453 *
454 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
455 * be found through a VFS lookup any more. Note that this is different from
456 * deleting the dentry - d_delete will try to mark the dentry negative if
457 * possible, giving a successful _negative_ lookup, while d_drop will
458 * just make the cache lookup fail.
459 *
460 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
461 * reason (NFS timeouts or autofs deletes).
462 *
NeilBrown3aa66ba2017-11-10 15:45:41 +1100463 * __d_drop requires dentry->d_lock
464 * ___d_drop doesn't mark dentry as "unhashed"
465 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100466 */
NeilBrown3aa66ba2017-11-10 15:45:41 +1100467static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100468{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700469 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400470 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400471 /*
472 * Hashed dentries are normally on the dentry hashtable,
473 * with the exception of those newly allocated by
474 * d_obtain_alias, which are always IS_ROOT:
475 */
476 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400477 b = &dentry->d_sb->s_anon;
478 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700479 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400480
481 hlist_bl_lock(b);
482 __hlist_bl_del(&dentry->d_hash);
Al Virob61625d2013-10-04 11:09:01 -0400483 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400484 /* After this call, in-progress rcu-walk path lookup will fail. */
485 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100486 }
487}
NeilBrown3aa66ba2017-11-10 15:45:41 +1100488
489void __d_drop(struct dentry *dentry)
490{
491 ___d_drop(dentry);
492 dentry->d_hash.pprev = NULL;
493}
Nick Piggin789680d2011-01-07 17:49:30 +1100494EXPORT_SYMBOL(__d_drop);
495
496void d_drop(struct dentry *dentry)
497{
Nick Piggin789680d2011-01-07 17:49:30 +1100498 spin_lock(&dentry->d_lock);
499 __d_drop(dentry);
500 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100501}
502EXPORT_SYMBOL(d_drop);
503
Al Viroba65dc52016-06-10 11:32:47 -0400504static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
505{
506 struct dentry *next;
507 /*
508 * Inform d_walk() and shrink_dentry_list() that we are no longer
509 * attached to the dentry tree
510 */
511 dentry->d_flags |= DCACHE_DENTRY_KILLED;
512 if (unlikely(list_empty(&dentry->d_child)))
513 return;
514 __list_del_entry(&dentry->d_child);
515 /*
516 * Cursors can move around the list of children. While we'd been
517 * a normal list member, it didn't matter - ->d_child.next would've
518 * been updated. However, from now on it won't be and for the
519 * things like d_walk() it might end up with a nasty surprise.
520 * Normally d_walk() doesn't care about cursors moving around -
521 * ->d_lock on parent prevents that and since a cursor has no children
522 * of its own, we get through it without ever unlocking the parent.
523 * There is one exception, though - if we ascend from a child that
524 * gets killed as soon as we unlock it, the next sibling is found
525 * using the value left in its ->d_child.next. And if _that_
526 * pointed to a cursor, and cursor got moved (e.g. by lseek())
527 * before d_walk() regains parent->d_lock, we'll end up skipping
528 * everything the cursor had been moved past.
529 *
530 * Solution: make sure that the pointer left behind in ->d_child.next
531 * points to something that won't be moving around. I.e. skip the
532 * cursors.
533 */
534 while (dentry->d_child.next != &parent->d_subdirs) {
535 next = list_entry(dentry->d_child.next, struct dentry, d_child);
536 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
537 break;
538 dentry->d_child.next = next->d_child.next;
539 }
540}
541
Al Viroe55fd012014-05-28 13:51:12 -0400542static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100543{
Al Viro41edf272014-05-01 10:30:00 -0400544 struct dentry *parent = NULL;
545 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400546 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100547 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100548
Linus Torvalds0d984392013-09-08 13:46:52 -0700549 /*
550 * The dentry is now unrecoverably dead to the world.
551 */
552 lockref_mark_dead(&dentry->d_lockref);
553
Sage Weilf0023bc2011-10-28 10:02:42 -0700554 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700555 * inform the fs via d_prune that this dentry is about to be
556 * unhashed and destroyed.
557 */
Al Viro29266202014-05-30 11:39:02 -0400558 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800559 dentry->d_op->d_prune(dentry);
560
Al Viro01b60352014-04-29 23:42:52 -0400561 if (dentry->d_flags & DCACHE_LRU_LIST) {
562 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
563 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400564 }
Nick Piggin77812a12011-01-07 17:49:48 +1100565 /* if it was on the hash then remove it */
566 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400567 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400568 if (parent)
569 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400570 if (dentry->d_inode)
571 dentry_unlink_inode(dentry);
572 else
573 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400574 this_cpu_dec(nr_dentry);
575 if (dentry->d_op && dentry->d_op->d_release)
576 dentry->d_op->d_release(dentry);
577
Al Viro41edf272014-05-01 10:30:00 -0400578 spin_lock(&dentry->d_lock);
579 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
580 dentry->d_flags |= DCACHE_MAY_FREE;
581 can_free = false;
582 }
583 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400584 if (likely(can_free))
585 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400586}
587
588/*
589 * Finish off a dentry we've decided to kill.
590 * dentry->d_lock must be held, returns with it unlocked.
591 * If ref is non-zero, then decrement the refcount too.
592 * Returns dentry requiring refcount drop, or NULL if we're done.
593 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400594static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400595 __releases(dentry->d_lock)
596{
597 struct inode *inode = dentry->d_inode;
598 struct dentry *parent = NULL;
599
600 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
601 goto failed;
602
603 if (!IS_ROOT(dentry)) {
604 parent = dentry->d_parent;
605 if (unlikely(!spin_trylock(&parent->d_lock))) {
606 if (inode)
607 spin_unlock(&inode->i_lock);
608 goto failed;
609 }
610 }
611
612 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400613 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400614
615failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400616 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400617 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100618}
619
Al Viro046b9612014-05-29 08:54:52 -0400620static inline struct dentry *lock_parent(struct dentry *dentry)
621{
622 struct dentry *parent = dentry->d_parent;
623 if (IS_ROOT(dentry))
624 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800625 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400626 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400627 if (likely(spin_trylock(&parent->d_lock)))
628 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400629 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400630 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400631again:
632 parent = ACCESS_ONCE(dentry->d_parent);
633 spin_lock(&parent->d_lock);
634 /*
635 * We can't blindly lock dentry until we are sure
636 * that we won't violate the locking order.
637 * Any changes of dentry->d_parent must have
638 * been done with parent->d_lock held, so
639 * spin_lock() above is enough of a barrier
640 * for checking if it's still our child.
641 */
642 if (unlikely(parent != dentry->d_parent)) {
643 spin_unlock(&parent->d_lock);
644 goto again;
645 }
Al Viro05f16fe2018-02-23 20:47:17 -0500646 if (parent != dentry) {
Linus Torvalds9f126002014-05-31 09:13:21 -0700647 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro05f16fe2018-02-23 20:47:17 -0500648 if (unlikely(dentry->d_lockref.count < 0)) {
649 spin_unlock(&parent->d_lock);
650 parent = NULL;
651 }
652 } else {
Al Viro046b9612014-05-29 08:54:52 -0400653 parent = NULL;
Al Viro05f16fe2018-02-23 20:47:17 -0500654 }
655 rcu_read_unlock();
Al Viro046b9612014-05-29 08:54:52 -0400656 return parent;
657}
658
Linus Torvalds360f5472015-01-09 15:19:03 -0800659/*
660 * Try to do a lockless dput(), and return whether that was successful.
661 *
662 * If unsuccessful, we return false, having already taken the dentry lock.
663 *
664 * The caller needs to hold the RCU read lock, so that the dentry is
665 * guaranteed to stay around even if the refcount goes down to zero!
666 */
667static inline bool fast_dput(struct dentry *dentry)
668{
669 int ret;
670 unsigned int d_flags;
671
672 /*
673 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100674 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800675 */
676 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
677 return lockref_put_or_lock(&dentry->d_lockref);
678
679 /*
680 * .. otherwise, we can try to just decrement the
681 * lockref optimistically.
682 */
683 ret = lockref_put_return(&dentry->d_lockref);
684
685 /*
686 * If the lockref_put_return() failed due to the lock being held
687 * by somebody else, the fast path has failed. We will need to
688 * get the lock, and then check the count again.
689 */
690 if (unlikely(ret < 0)) {
691 spin_lock(&dentry->d_lock);
692 if (dentry->d_lockref.count > 1) {
693 dentry->d_lockref.count--;
694 spin_unlock(&dentry->d_lock);
695 return 1;
696 }
697 return 0;
698 }
699
700 /*
701 * If we weren't the last ref, we're done.
702 */
703 if (ret)
704 return 1;
705
706 /*
707 * Careful, careful. The reference count went down
708 * to zero, but we don't hold the dentry lock, so
709 * somebody else could get it again, and do another
710 * dput(), and we need to not race with that.
711 *
712 * However, there is a very special and common case
713 * where we don't care, because there is nothing to
714 * do: the dentry is still hashed, it does not have
715 * a 'delete' op, and it's referenced and already on
716 * the LRU list.
717 *
718 * NOTE! Since we aren't locked, these values are
719 * not "stable". However, it is sufficient that at
720 * some point after we dropped the reference the
721 * dentry was hashed and the flags had the proper
722 * value. Other dentry users may have re-gotten
723 * a reference to the dentry and change that, but
724 * our work is done - we can leave the dentry
725 * around with a zero refcount.
726 */
727 smp_rmb();
728 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100729 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800730
731 /* Nothing to do? Dropping the reference was all we needed? */
732 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
733 return 1;
734
735 /*
736 * Not the fast normal case? Get the lock. We've already decremented
737 * the refcount, but we'll need to re-check the situation after
738 * getting the lock.
739 */
740 spin_lock(&dentry->d_lock);
741
742 /*
743 * Did somebody else grab a reference to it in the meantime, and
744 * we're no longer the last user after all? Alternatively, somebody
745 * else could have killed it and marked it dead. Either way, we
746 * don't need to do anything else.
747 */
748 if (dentry->d_lockref.count) {
749 spin_unlock(&dentry->d_lock);
750 return 1;
751 }
752
753 /*
754 * Re-get the reference we optimistically dropped. We hold the
755 * lock, and we just tested that it was zero, so we can just
756 * set it to 1.
757 */
758 dentry->d_lockref.count = 1;
759 return 0;
760}
761
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763/*
764 * This is dput
765 *
766 * This is complicated by the fact that we do not want to put
767 * dentries that are no longer on any hash chain on the unused
768 * list: we'd much rather just get rid of them immediately.
769 *
770 * However, that implies that we have to traverse the dentry
771 * tree upwards to the parents which might _also_ now be
772 * scheduled for deletion (it may have been only waiting for
773 * its last child to go away).
774 *
775 * This tail recursion is done by hand as we don't want to depend
776 * on the compiler to always get this right (gcc generally doesn't).
777 * Real recursion would eat up our stack space.
778 */
779
780/*
781 * dput - release a dentry
782 * @dentry: dentry to release
783 *
784 * Release a dentry. This will drop the usage count and if appropriate
785 * call the dentry unlink method as well as removing it from the queues and
786 * releasing its resources. If the parent dentries were scheduled for release
787 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789void dput(struct dentry *dentry)
790{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700791 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 return;
793
794repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800795 might_sleep();
796
Linus Torvalds360f5472015-01-09 15:19:03 -0800797 rcu_read_lock();
798 if (likely(fast_dput(dentry))) {
799 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800801 }
802
803 /* Slow case: now with the dentry lock held */
804 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Al Viro85c7f812016-04-14 19:52:13 -0400806 WARN_ON(d_in_lookup(dentry));
807
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700808 /* Unreachable? Get rid of it */
809 if (unlikely(d_unhashed(dentry)))
810 goto kill_it;
811
Al Viro75a6f822015-07-08 02:42:38 +0100812 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
813 goto kill_it;
814
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700815 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100817 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 }
Nick Piggin265ac902010-10-10 05:36:24 -0400819
Linus Torvalds358eec12013-10-31 15:43:02 -0700820 if (!(dentry->d_flags & DCACHE_REFERENCED))
821 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400822 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400823
Waiman Long98474232013-08-28 18:24:59 -0700824 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100825 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return;
827
Miklos Szeredid52b9082007-05-08 00:23:46 -0700828kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400829 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800830 if (dentry) {
831 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700832 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700835EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100838/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100839static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Waiman Long98474232013-08-28 18:24:59 -0700841 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
843
Nick Piggindc0474b2011-01-07 17:49:43 +1100844static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100845{
Waiman Long98474232013-08-28 18:24:59 -0700846 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100847}
848
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100849struct dentry *dget_parent(struct dentry *dentry)
850{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700851 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100852 struct dentry *ret;
853
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700854 /*
855 * Do optimistic parent lookup without any
856 * locking.
857 */
858 rcu_read_lock();
859 ret = ACCESS_ONCE(dentry->d_parent);
860 gotref = lockref_get_not_zero(&ret->d_lockref);
861 rcu_read_unlock();
862 if (likely(gotref)) {
863 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
864 return ret;
865 dput(ret);
866 }
867
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100869 /*
870 * Don't need rcu_dereference because we re-check it was correct under
871 * the lock.
872 */
873 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100874 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100875 spin_lock(&ret->d_lock);
876 if (unlikely(ret != dentry->d_parent)) {
877 spin_unlock(&ret->d_lock);
878 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100879 goto repeat;
880 }
Nick Piggina734eb42011-01-07 17:49:44 +1100881 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700882 BUG_ON(!ret->d_lockref.count);
883 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100884 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100885 return ret;
886}
887EXPORT_SYMBOL(dget_parent);
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889/**
890 * d_find_alias - grab a hashed alias of inode
891 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 *
893 * If inode has a hashed alias, or is a directory and has any alias,
894 * acquire the reference to alias and return it. Otherwise return NULL.
895 * Notice that if inode is a directory there can be only one alias and
896 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800897 * of a filesystem, or if the directory was renamed and d_revalidate
898 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700900 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500901 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500903static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904{
Nick Pigginda502952011-01-07 17:49:33 +1100905 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Nick Pigginda502952011-01-07 17:49:33 +1100907again:
908 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400909 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100910 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700912 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100913 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500915 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100916 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100917 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 return alias;
919 }
920 }
Nick Pigginda502952011-01-07 17:49:33 +1100921 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 }
Nick Pigginda502952011-01-07 17:49:33 +1100923 if (discon_alias) {
924 alias = discon_alias;
925 spin_lock(&alias->d_lock);
926 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500927 __dget_dlock(alias);
928 spin_unlock(&alias->d_lock);
929 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100930 }
931 spin_unlock(&alias->d_lock);
932 goto again;
933 }
934 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935}
936
Nick Pigginda502952011-01-07 17:49:33 +1100937struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938{
David Howells214fda12006-03-25 03:06:36 -0800939 struct dentry *de = NULL;
940
Al Virob3d9b7a2012-06-09 13:51:19 -0400941 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100942 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500943 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100944 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 return de;
947}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700948EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
950/*
951 * Try to kill dentries associated with this inode.
952 * WARNING: you must own a reference to inode.
953 */
954void d_prune_aliases(struct inode *inode)
955{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700956 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100958 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400959 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700961 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400962 struct dentry *parent = lock_parent(dentry);
963 if (likely(!dentry->d_lockref.count)) {
964 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800965 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400966 goto restart;
967 }
968 if (parent)
969 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 }
971 spin_unlock(&dentry->d_lock);
972 }
Nick Piggin873feea2011-01-07 17:50:06 +1100973 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700975EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400977static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Al Viro5c47e6d2014-04-29 16:13:18 -0400979 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700980
Miklos Szeredi60942f22014-05-02 15:38:39 -0400981 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400982 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400983 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100984 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400985 parent = lock_parent(dentry);
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000988 * The dispose list is isolated and dentries are not accounted
989 * to the LRU here, so we can simply remove it from the list
990 * here regardless of whether it is referenced or not.
991 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400992 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000993
994 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000996 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800998 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700999 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001000 if (parent)
1001 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 continue;
1003 }
Nick Piggin77812a12011-01-07 17:49:48 +11001004
Al Viro64fd72e2014-05-28 09:48:44 -04001005
1006 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1007 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1008 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001009 if (parent)
1010 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001011 if (can_free)
1012 dentry_free(dentry);
1013 continue;
1014 }
1015
Al Viroff2fde92014-05-28 13:59:13 -04001016 inode = dentry->d_inode;
1017 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001018 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001019 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001020 if (parent)
1021 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001022 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001023 }
Al Viroff2fde92014-05-28 13:59:13 -04001024
Al Viroff2fde92014-05-28 13:59:13 -04001025 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001026
Al Viro5c47e6d2014-04-29 16:13:18 -04001027 /*
1028 * We need to prune ancestors too. This is necessary to prevent
1029 * quadratic behavior of shrink_dcache_parent(), but is also
1030 * expected to be beneficial in reducing dentry cache
1031 * fragmentation.
1032 */
1033 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001034 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1035 parent = lock_parent(dentry);
1036 if (dentry->d_lockref.count != 1) {
1037 dentry->d_lockref.count--;
1038 spin_unlock(&dentry->d_lock);
1039 if (parent)
1040 spin_unlock(&parent->d_lock);
1041 break;
1042 }
1043 inode = dentry->d_inode; /* can't be NULL */
1044 if (unlikely(!spin_trylock(&inode->i_lock))) {
1045 spin_unlock(&dentry->d_lock);
1046 if (parent)
1047 spin_unlock(&parent->d_lock);
1048 cpu_relax();
1049 continue;
1050 }
1051 __dentry_kill(dentry);
1052 dentry = parent;
1053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001055}
1056
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001057static enum lru_status dentry_lru_isolate(struct list_head *item,
1058 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001059{
1060 struct list_head *freeable = arg;
1061 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1062
1063
1064 /*
1065 * we are inverting the lru lock/dentry->d_lock here,
1066 * so use a trylock. If we fail to get the lock, just skip
1067 * it
1068 */
1069 if (!spin_trylock(&dentry->d_lock))
1070 return LRU_SKIP;
1071
1072 /*
1073 * Referenced dentries are still in use. If they have active
1074 * counts, just remove them from the LRU. Otherwise give them
1075 * another pass through the LRU.
1076 */
1077 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001078 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001079 spin_unlock(&dentry->d_lock);
1080 return LRU_REMOVED;
1081 }
1082
1083 if (dentry->d_flags & DCACHE_REFERENCED) {
1084 dentry->d_flags &= ~DCACHE_REFERENCED;
1085 spin_unlock(&dentry->d_lock);
1086
1087 /*
1088 * The list move itself will be made by the common LRU code. At
1089 * this point, we've dropped the dentry->d_lock but keep the
1090 * lru lock. This is safe to do, since every list movement is
1091 * protected by the lru lock even if both locks are held.
1092 *
1093 * This is guaranteed by the fact that all LRU management
1094 * functions are intermediated by the LRU API calls like
1095 * list_lru_add and list_lru_del. List movement in this file
1096 * only ever occur through this functions or through callbacks
1097 * like this one, that are called from the LRU API.
1098 *
1099 * The only exceptions to this are functions like
1100 * shrink_dentry_list, and code that first checks for the
1101 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1102 * operating only with stack provided lists after they are
1103 * properly isolated from the main list. It is thus, always a
1104 * local access.
1105 */
1106 return LRU_ROTATE;
1107 }
1108
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001109 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001110 spin_unlock(&dentry->d_lock);
1111
1112 return LRU_REMOVED;
1113}
1114
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001115/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001116 * prune_dcache_sb - shrink the dcache
1117 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001118 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001119 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001120 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1121 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001122 * function.
1123 *
1124 * This function may fail to free any resources if all the dentries are in
1125 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001126 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001127long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128{
Dave Chinnerf6041562013-08-28 10:18:00 +10001129 LIST_HEAD(dispose);
1130 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001131
Vladimir Davydov503c3582015-02-12 14:58:47 -08001132 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1133 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001134 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001135 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136}
1137
Glauber Costa4e717f52013-08-28 10:18:03 +10001138static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001139 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001140{
Glauber Costa4e717f52013-08-28 10:18:03 +10001141 struct list_head *freeable = arg;
1142 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001143
Glauber Costa4e717f52013-08-28 10:18:03 +10001144 /*
1145 * we are inverting the lru lock/dentry->d_lock here,
1146 * so use a trylock. If we fail to get the lock, just skip
1147 * it
1148 */
1149 if (!spin_trylock(&dentry->d_lock))
1150 return LRU_SKIP;
1151
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001152 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001153 spin_unlock(&dentry->d_lock);
1154
1155 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001156}
1157
Glauber Costa4e717f52013-08-28 10:18:03 +10001158
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001159/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 * shrink_dcache_sb - shrink dcache for a superblock
1161 * @sb: superblock
1162 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001163 * Shrink the dcache for the specified super block. This is used to free
1164 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001166void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167{
Glauber Costa4e717f52013-08-28 10:18:03 +10001168 do {
1169 LIST_HEAD(dispose);
1170
Waiman Long92744322019-01-30 13:52:36 -05001171 list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001172 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001173 shrink_dentry_list(&dispose);
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001174 cond_resched();
1175 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001177EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001180 * enum d_walk_ret - action to talke during tree walk
1181 * @D_WALK_CONTINUE: contrinue walk
1182 * @D_WALK_QUIT: quit walk
1183 * @D_WALK_NORETRY: quit when retry is needed
1184 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001186enum d_walk_ret {
1187 D_WALK_CONTINUE,
1188 D_WALK_QUIT,
1189 D_WALK_NORETRY,
1190 D_WALK_SKIP,
1191};
1192
1193/**
1194 * d_walk - walk the dentry tree
1195 * @parent: start of walk
1196 * @data: data passed to @enter() and @finish()
1197 * @enter: callback when first entering the dentry
1198 * @finish: callback when successfully finished the walk
1199 *
1200 * The @enter() and @finish() callbacks are called with d_lock held.
1201 */
1202static void d_walk(struct dentry *parent, void *data,
1203 enum d_walk_ret (*enter)(void *, struct dentry *),
1204 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Nick Piggin949854d2011-01-07 17:49:37 +11001206 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001208 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001209 enum d_walk_ret ret;
1210 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001211
Nick Piggin58db63d2011-01-07 17:49:39 +11001212again:
Al Viro48f5ec22013-09-09 15:22:25 -04001213 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001214 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001215 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001216
1217 ret = enter(data, this_parent);
1218 switch (ret) {
1219 case D_WALK_CONTINUE:
1220 break;
1221 case D_WALK_QUIT:
1222 case D_WALK_SKIP:
1223 goto out_unlock;
1224 case D_WALK_NORETRY:
1225 retry = false;
1226 break;
1227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228repeat:
1229 next = this_parent->d_subdirs.next;
1230resume:
1231 while (next != &this_parent->d_subdirs) {
1232 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001233 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001235
Al Viroba65dc52016-06-10 11:32:47 -04001236 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1237 continue;
1238
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001239 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001240
1241 ret = enter(data, dentry);
1242 switch (ret) {
1243 case D_WALK_CONTINUE:
1244 break;
1245 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001246 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001247 goto out_unlock;
1248 case D_WALK_NORETRY:
1249 retry = false;
1250 break;
1251 case D_WALK_SKIP:
1252 spin_unlock(&dentry->d_lock);
1253 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001254 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001257 spin_unlock(&this_parent->d_lock);
1258 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001260 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 goto repeat;
1262 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001263 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
1265 /*
1266 * All done at this level ... ascend and resume the search.
1267 */
Al Viroca5358e2014-10-26 19:31:10 -04001268 rcu_read_lock();
1269ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001271 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001272 this_parent = child->d_parent;
1273
Al Viro31dec132013-10-25 17:04:27 -04001274 spin_unlock(&child->d_lock);
1275 spin_lock(&this_parent->d_lock);
1276
Al Viroca5358e2014-10-26 19:31:10 -04001277 /* might go back up the wrong parent if we have had a rename. */
1278 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001279 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001280 /* go into the first sibling still alive */
1281 do {
1282 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001283 if (next == &this_parent->d_subdirs)
1284 goto ascend;
1285 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001286 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001287 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 goto resume;
1289 }
Al Viroca5358e2014-10-26 19:31:10 -04001290 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001291 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001292 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001293 if (finish)
1294 finish(data);
1295
1296out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001297 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001298 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001299 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001300
1301rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001302 spin_unlock(&this_parent->d_lock);
1303 rcu_read_unlock();
1304 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001305 if (!retry)
1306 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001307 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001308 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001310
1311/*
1312 * Search for at least 1 mount point in the dentry's subdirs.
1313 * We descend to the next level whenever the d_subdirs
1314 * list is non-empty and continue searching.
1315 */
1316
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001317static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1318{
1319 int *ret = data;
1320 if (d_mountpoint(dentry)) {
1321 *ret = 1;
1322 return D_WALK_QUIT;
1323 }
1324 return D_WALK_CONTINUE;
1325}
1326
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001327/**
1328 * have_submounts - check for mounts over a dentry
1329 * @parent: dentry to check.
1330 *
1331 * Return true if the parent or its subdirectories contain
1332 * a mount point
1333 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001334int have_submounts(struct dentry *parent)
1335{
1336 int ret = 0;
1337
1338 d_walk(parent, &ret, check_mount, NULL);
1339
1340 return ret;
1341}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001342EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
1344/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001345 * Called by mount code to set a mountpoint and check if the mountpoint is
1346 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1347 * subtree can become unreachable).
1348 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001349 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001350 * this reason take rename_lock and d_lock on dentry and ancestors.
1351 */
1352int d_set_mounted(struct dentry *dentry)
1353{
1354 struct dentry *p;
1355 int ret = -ENOENT;
1356 write_seqlock(&rename_lock);
1357 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001358 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001359 spin_lock(&p->d_lock);
1360 if (unlikely(d_unhashed(p))) {
1361 spin_unlock(&p->d_lock);
1362 goto out;
1363 }
1364 spin_unlock(&p->d_lock);
1365 }
1366 spin_lock(&dentry->d_lock);
1367 if (!d_unlinked(dentry)) {
Eric W. Biederman1a62a0f2017-01-03 14:18:43 +13001368 ret = -EBUSY;
1369 if (!d_mountpoint(dentry)) {
1370 dentry->d_flags |= DCACHE_MOUNTED;
1371 ret = 0;
1372 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001373 }
1374 spin_unlock(&dentry->d_lock);
1375out:
1376 write_sequnlock(&rename_lock);
1377 return ret;
1378}
1379
1380/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001381 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * and move any unused dentries to the end of the unused
1383 * list for prune_dcache(). We descend to the next level
1384 * whenever the d_subdirs list is non-empty and continue
1385 * searching.
1386 *
1387 * It returns zero iff there are no unused children,
1388 * otherwise it returns the number of children moved to
1389 * the end of the unused list. This may not be the total
1390 * number of unused children, because select_parent can
1391 * drop the lock and return early due to latency
1392 * constraints.
1393 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001394
1395struct select_data {
1396 struct dentry *start;
1397 struct list_head dispose;
1398 int found;
1399};
1400
1401static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001403 struct select_data *data = _data;
1404 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001406 if (data->start == dentry)
1407 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Al Virofe915222014-05-03 00:02:25 -04001409 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Sahitya Tummala39e8d0b2017-04-21 21:56:19 +05301410 goto out;
Al Virofe915222014-05-03 00:02:25 -04001411 } else {
1412 if (dentry->d_flags & DCACHE_LRU_LIST)
1413 d_lru_del(dentry);
1414 if (!dentry->d_lockref.count) {
1415 d_shrink_add(dentry, &data->dispose);
1416 data->found++;
1417 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 }
1419 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001420 * We can return to the caller if we have found some (this
1421 * ensures forward progress). We'll be coming back to find
1422 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 */
Al Virofe915222014-05-03 00:02:25 -04001424 if (!list_empty(&data->dispose))
1425 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001427 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428}
1429
1430/**
1431 * shrink_dcache_parent - prune dcache
1432 * @parent: parent of entries to prune
1433 *
1434 * Prune the dcache to remove unused children of the parent dentry.
1435 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001436void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001438 for (;;) {
1439 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001441 INIT_LIST_HEAD(&data.dispose);
1442 data.start = parent;
1443 data.found = 0;
1444
1445 d_walk(parent, &data, select_collect, NULL);
1446 if (!data.found)
1447 break;
1448
1449 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001450 cond_resched();
1451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001453EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
Al Viro9c8c10e2014-05-02 20:36:10 -04001455static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001456{
Al Viro9c8c10e2014-05-02 20:36:10 -04001457 /* it has busy descendents; complain about those instead */
1458 if (!list_empty(&dentry->d_subdirs))
1459 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001460
Al Viro9c8c10e2014-05-02 20:36:10 -04001461 /* root with refcount 1 is fine */
1462 if (dentry == _data && dentry->d_lockref.count == 1)
1463 return D_WALK_CONTINUE;
1464
1465 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1466 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001467 dentry,
1468 dentry->d_inode ?
1469 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001470 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001471 dentry->d_lockref.count,
1472 dentry->d_sb->s_type->name,
1473 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001474 WARN_ON(1);
1475 return D_WALK_CONTINUE;
1476}
1477
1478static void do_one_tree(struct dentry *dentry)
1479{
1480 shrink_dcache_parent(dentry);
1481 d_walk(dentry, dentry, umount_check, NULL);
1482 d_drop(dentry);
1483 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001484}
1485
1486/*
1487 * destroy the dentries attached to a superblock on unmounting
1488 */
1489void shrink_dcache_for_umount(struct super_block *sb)
1490{
1491 struct dentry *dentry;
1492
Al Viro9c8c10e2014-05-02 20:36:10 -04001493 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001494
1495 dentry = sb->s_root;
1496 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001497 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001498
1499 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001500 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1501 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001502 }
1503}
1504
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001505struct detach_data {
1506 struct select_data select;
1507 struct dentry *mountpoint;
1508};
1509static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001510{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001511 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001512
1513 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001514 __dget_dlock(dentry);
1515 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001516 return D_WALK_QUIT;
1517 }
1518
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001519 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001520}
1521
1522static void check_and_drop(void *_data)
1523{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001524 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001525
Al Viro19871722017-06-03 07:20:09 +01001526 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001527 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001528}
1529
1530/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001531 * d_invalidate - detach submounts, prune dcache, and drop
1532 * @dentry: dentry to invalidate (aka detach, prune and drop)
1533 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001534 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001535 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001536 * The final d_drop is done as an atomic operation relative to
1537 * rename_lock ensuring there are no races with d_set_mounted. This
1538 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001539 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001540void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001541{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001542 /*
1543 * If it's already been dropped, return OK.
1544 */
1545 spin_lock(&dentry->d_lock);
1546 if (d_unhashed(dentry)) {
1547 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001548 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001549 }
1550 spin_unlock(&dentry->d_lock);
1551
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552 /* Negative dentries can be dropped without further checks */
1553 if (!dentry->d_inode) {
1554 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001555 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001556 }
1557
1558 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001559 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001560
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001561 data.mountpoint = NULL;
1562 INIT_LIST_HEAD(&data.select.dispose);
1563 data.select.start = dentry;
1564 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001565
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001566 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001567
Al Viro19871722017-06-03 07:20:09 +01001568 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001569 shrink_dentry_list(&data.select.dispose);
Al Viro19871722017-06-03 07:20:09 +01001570 else if (!data.mountpoint)
1571 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001572
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001573 if (data.mountpoint) {
1574 detach_mounts(data.mountpoint);
1575 dput(data.mountpoint);
1576 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001577 cond_resched();
1578 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001579}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001580EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582/**
Al Viroa4464db2011-07-07 15:03:58 -04001583 * __d_alloc - allocate a dcache entry
1584 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 * @name: qstr of the name
1586 *
1587 * Allocates a dentry. It returns %NULL if there is insufficient memory
1588 * available. On a success the dentry is returned. The name passed in is
1589 * copied and the copy passed in may be reused after this call.
1590 */
1591
Al Viroa4464db2011-07-07 15:03:58 -04001592struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593{
1594 struct dentry *dentry;
1595 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001596 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
Mel Gormane12ba742007-10-16 01:25:52 -07001598 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 if (!dentry)
1600 return NULL;
1601
Linus Torvalds6326c712012-05-21 16:14:04 -07001602 /*
1603 * We guarantee that the inline name is always NUL-terminated.
1604 * This way the memcpy() done by the name switching in rename
1605 * will still always have a NUL at the end, even if we might
1606 * be overwriting an internal NUL character
1607 */
1608 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001609 if (unlikely(!name)) {
1610 static const struct qstr anon = QSTR_INIT("/", 1);
1611 name = &anon;
1612 dname = dentry->d_iname;
1613 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001614 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001615 struct external_name *p = kmalloc(size + name->len,
1616 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001617 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 kmem_cache_free(dentry_cache, dentry);
1619 return NULL;
1620 }
Al Viro8d85b482014-09-29 14:54:27 -04001621 atomic_set(&p->u.count, 1);
1622 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001623 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1624 kasan_unpoison_shadow(dname,
1625 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 } else {
1627 dname = dentry->d_iname;
1628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 dentry->d_name.len = name->len;
1631 dentry->d_name.hash = name->hash;
1632 memcpy(dname, name->name, name->len);
1633 dname[name->len] = 0;
1634
Linus Torvalds6326c712012-05-21 16:14:04 -07001635 /* Make sure we always see the terminating NUL character */
1636 smp_wmb();
1637 dentry->d_name.name = dname;
1638
Waiman Long98474232013-08-28 18:24:59 -07001639 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001640 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001642 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001644 dentry->d_parent = dentry;
1645 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 dentry->d_op = NULL;
1647 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001648 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 INIT_LIST_HEAD(&dentry->d_lru);
1650 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001651 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1652 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001653 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Miklos Szeredi285b1022016-06-28 11:47:32 +02001655 if (dentry->d_op && dentry->d_op->d_init) {
1656 err = dentry->d_op->d_init(dentry);
1657 if (err) {
1658 if (dname_external(dentry))
1659 kfree(external_name(dentry));
1660 kmem_cache_free(dentry_cache, dentry);
1661 return NULL;
1662 }
1663 }
1664
Nick Piggin3e880fb2011-01-07 17:49:19 +11001665 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001666
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 return dentry;
1668}
Al Viroa4464db2011-07-07 15:03:58 -04001669
1670/**
1671 * d_alloc - allocate a dcache entry
1672 * @parent: parent of entry to allocate
1673 * @name: qstr of the name
1674 *
1675 * Allocates a dentry. It returns %NULL if there is insufficient memory
1676 * available. On a success the dentry is returned. The name passed in is
1677 * copied and the copy passed in may be reused after this call.
1678 */
1679struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1680{
1681 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1682 if (!dentry)
1683 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001684 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001685 spin_lock(&parent->d_lock);
1686 /*
1687 * don't need child lock because it is not subject
1688 * to concurrency here
1689 */
1690 __dget_dlock(parent);
1691 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001692 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001693 spin_unlock(&parent->d_lock);
1694
1695 return dentry;
1696}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001697EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
Al Viroba65dc52016-06-10 11:32:47 -04001699struct dentry *d_alloc_cursor(struct dentry * parent)
1700{
1701 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1702 if (dentry) {
1703 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1704 dentry->d_parent = dget(parent);
1705 }
1706 return dentry;
1707}
1708
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001709/**
1710 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1711 * @sb: the superblock
1712 * @name: qstr of the name
1713 *
1714 * For a filesystem that just pins its dentries in memory and never
1715 * performs lookups at all, return an unhashed IS_ROOT dentry.
1716 */
Nick Piggin4b936882011-01-07 17:50:07 +11001717struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1718{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001719 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001720}
1721EXPORT_SYMBOL(d_alloc_pseudo);
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1724{
1725 struct qstr q;
1726
1727 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001728 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 return d_alloc(parent, &q);
1730}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001731EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732
Nick Pigginfb045ad2011-01-07 17:49:55 +11001733void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1734{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001735 WARN_ON_ONCE(dentry->d_op);
1736 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001737 DCACHE_OP_COMPARE |
1738 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001739 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001740 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001741 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001742 dentry->d_op = op;
1743 if (!op)
1744 return;
1745 if (op->d_hash)
1746 dentry->d_flags |= DCACHE_OP_HASH;
1747 if (op->d_compare)
1748 dentry->d_flags |= DCACHE_OP_COMPARE;
1749 if (op->d_revalidate)
1750 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001751 if (op->d_weak_revalidate)
1752 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001753 if (op->d_delete)
1754 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001755 if (op->d_prune)
1756 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001757 if (op->d_real)
1758 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001759
1760}
1761EXPORT_SYMBOL(d_set_d_op);
1762
David Howellsdf1a0852015-01-29 12:02:28 +00001763
1764/*
1765 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1766 * @dentry - The dentry to mark
1767 *
1768 * Mark a dentry as falling through to the lower layer (as set with
1769 * d_pin_lower()). This flag may be recorded on the medium.
1770 */
1771void d_set_fallthru(struct dentry *dentry)
1772{
1773 spin_lock(&dentry->d_lock);
1774 dentry->d_flags |= DCACHE_FALLTHRU;
1775 spin_unlock(&dentry->d_lock);
1776}
1777EXPORT_SYMBOL(d_set_fallthru);
1778
David Howellsb18825a2013-09-12 19:22:53 +01001779static unsigned d_flags_for_inode(struct inode *inode)
1780{
David Howells44bdb5e2015-01-29 12:02:29 +00001781 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001782
1783 if (!inode)
1784 return DCACHE_MISS_TYPE;
1785
1786 if (S_ISDIR(inode->i_mode)) {
1787 add_flags = DCACHE_DIRECTORY_TYPE;
1788 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1789 if (unlikely(!inode->i_op->lookup))
1790 add_flags = DCACHE_AUTODIR_TYPE;
1791 else
1792 inode->i_opflags |= IOP_LOOKUP;
1793 }
David Howells44bdb5e2015-01-29 12:02:29 +00001794 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001795 }
1796
David Howells44bdb5e2015-01-29 12:02:29 +00001797 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001798 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001799 add_flags = DCACHE_SYMLINK_TYPE;
1800 goto type_determined;
1801 }
1802 inode->i_opflags |= IOP_NOFOLLOW;
1803 }
1804
1805 if (unlikely(!S_ISREG(inode->i_mode)))
1806 add_flags = DCACHE_SPECIAL_TYPE;
1807
1808type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001809 if (unlikely(IS_AUTOMOUNT(inode)))
1810 add_flags |= DCACHE_NEED_AUTOMOUNT;
1811 return add_flags;
1812}
1813
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001814static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1815{
David Howellsb18825a2013-09-12 19:22:53 +01001816 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001817 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001818
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001819 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001820 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001821 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001822 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001823 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001824 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001825 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001826}
1827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828/**
1829 * d_instantiate - fill in inode information for a dentry
1830 * @entry: dentry to complete
1831 * @inode: inode to attach to this dentry
1832 *
1833 * Fill in inode information in the entry.
1834 *
1835 * This turns negative dentries into productive full members
1836 * of society.
1837 *
1838 * NOTE! This assumes that the inode count has been incremented
1839 * (or otherwise set) by the caller to indicate that it is now
1840 * in use by the dcache.
1841 */
1842
1843void d_instantiate(struct dentry *entry, struct inode * inode)
1844{
Al Viro946e51f2014-10-26 19:19:16 -04001845 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001846 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001847 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001848 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001849 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001850 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001851 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001853EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
Al Viro2d2d3f12018-05-04 08:23:01 -04001855/*
1856 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1857 * with lockdep-related part of unlock_new_inode() done before
1858 * anything else. Use that instead of open-coding d_instantiate()/
1859 * unlock_new_inode() combinations.
1860 */
1861void d_instantiate_new(struct dentry *entry, struct inode *inode)
1862{
1863 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1864 BUG_ON(!inode);
1865 lockdep_annotate_inode_mutex_key(inode);
1866 security_d_instantiate(entry, inode);
1867 spin_lock(&inode->i_lock);
1868 __d_instantiate(entry, inode);
1869 WARN_ON(!(inode->i_state & I_NEW));
1870 inode->i_state &= ~I_NEW;
1871 smp_mb();
1872 wake_up_bit(&inode->i_state, __I_NEW);
1873 spin_unlock(&inode->i_lock);
1874}
1875EXPORT_SYMBOL(d_instantiate_new);
1876
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001878 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1879 * @entry: dentry to complete
1880 * @inode: inode to attach to this dentry
1881 *
1882 * Fill in inode information in the entry. If a directory alias is found, then
1883 * return an error (and drop inode). Together with d_materialise_unique() this
1884 * guarantees that a directory inode may never have more than one alias.
1885 */
1886int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1887{
Al Viro946e51f2014-10-26 19:19:16 -04001888 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001889
Al Virob9680912016-04-11 00:53:26 -04001890 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001891 spin_lock(&inode->i_lock);
1892 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1893 spin_unlock(&inode->i_lock);
1894 iput(inode);
1895 return -EBUSY;
1896 }
1897 __d_instantiate(entry, inode);
1898 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001899
1900 return 0;
1901}
1902EXPORT_SYMBOL(d_instantiate_no_diralias);
1903
Al Viroadc0e912012-01-08 16:49:21 -05001904struct dentry *d_make_root(struct inode *root_inode)
1905{
1906 struct dentry *res = NULL;
1907
1908 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001909 res = __d_alloc(root_inode->i_sb, NULL);
Al Virocfac7df2018-08-06 09:03:58 -04001910 if (res) {
1911 res->d_flags |= DCACHE_RCUACCESS;
Al Viroadc0e912012-01-08 16:49:21 -05001912 d_instantiate(res, root_inode);
Al Virocfac7df2018-08-06 09:03:58 -04001913 } else {
Al Viroadc0e912012-01-08 16:49:21 -05001914 iput(root_inode);
Al Virocfac7df2018-08-06 09:03:58 -04001915 }
Al Viroadc0e912012-01-08 16:49:21 -05001916 }
1917 return res;
1918}
1919EXPORT_SYMBOL(d_make_root);
1920
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001921static struct dentry * __d_find_any_alias(struct inode *inode)
1922{
1923 struct dentry *alias;
1924
Al Virob3d9b7a2012-06-09 13:51:19 -04001925 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001926 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001927 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001928 __dget(alias);
1929 return alias;
1930}
1931
Sage Weil46f72b32012-01-10 09:04:37 -08001932/**
1933 * d_find_any_alias - find any alias for a given inode
1934 * @inode: inode to find an alias for
1935 *
1936 * If any aliases exist for the given inode, take and return a
1937 * reference for one of them. If no aliases exist, return %NULL.
1938 */
1939struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001940{
1941 struct dentry *de;
1942
1943 spin_lock(&inode->i_lock);
1944 de = __d_find_any_alias(inode);
1945 spin_unlock(&inode->i_lock);
1946 return de;
1947}
Sage Weil46f72b32012-01-10 09:04:37 -08001948EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001949
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001950static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001951{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001952 struct dentry *tmp;
1953 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001954 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001955
1956 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001957 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001958 if (IS_ERR(inode))
1959 return ERR_CAST(inode);
1960
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001961 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001962 if (res)
1963 goto out_iput;
1964
Al Viro798434b2016-03-24 20:38:43 -04001965 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001966 if (!tmp) {
1967 res = ERR_PTR(-ENOMEM);
1968 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001969 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001970
Al Virob9680912016-04-11 00:53:26 -04001971 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001972 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001973 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001974 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001975 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001976 dput(tmp);
1977 goto out_iput;
1978 }
1979
1980 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001981 add_flags = d_flags_for_inode(inode);
1982
1983 if (disconnected)
1984 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001985
Christoph Hellwig9308a612008-08-11 15:49:12 +02001986 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001987 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001988 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001989 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001990 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001991 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001992 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001993 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001994
Christoph Hellwig9308a612008-08-11 15:49:12 +02001995 return tmp;
1996
1997 out_iput:
1998 iput(inode);
1999 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002000}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002001
2002/**
2003 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2004 * @inode: inode to allocate the dentry for
2005 *
2006 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2007 * similar open by handle operations. The returned dentry may be anonymous,
2008 * or may have a full name (if the inode was already in the cache).
2009 *
2010 * When called on a directory inode, we must ensure that the inode only ever
2011 * has one dentry. If a dentry is found, that is returned instead of
2012 * allocating a new one.
2013 *
2014 * On successful return, the reference to the inode has been transferred
2015 * to the dentry. In case of an error the reference on the inode is released.
2016 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2017 * be passed in and the error will be propagated to the return value,
2018 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2019 */
2020struct dentry *d_obtain_alias(struct inode *inode)
2021{
2022 return __d_obtain_alias(inode, 1);
2023}
Benny Halevyadc48722009-02-27 14:02:59 -08002024EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025
2026/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002027 * d_obtain_root - find or allocate a dentry for a given inode
2028 * @inode: inode to allocate the dentry for
2029 *
2030 * Obtain an IS_ROOT dentry for the root of a filesystem.
2031 *
2032 * We must ensure that directory inodes only ever have one dentry. If a
2033 * dentry is found, that is returned instead of allocating a new one.
2034 *
2035 * On successful return, the reference to the inode has been transferred
2036 * to the dentry. In case of an error the reference on the inode is
2037 * released. A %NULL or IS_ERR inode may be passed in and will be the
2038 * error will be propagate to the return value, with a %NULL @inode
2039 * replaced by ERR_PTR(-ESTALE).
2040 */
2041struct dentry *d_obtain_root(struct inode *inode)
2042{
2043 return __d_obtain_alias(inode, 0);
2044}
2045EXPORT_SYMBOL(d_obtain_root);
2046
2047/**
Barry Naujok94035402008-05-21 16:50:46 +10002048 * d_add_ci - lookup or allocate new dentry with case-exact name
2049 * @inode: the inode case-insensitive lookup has found
2050 * @dentry: the negative dentry that was passed to the parent's lookup func
2051 * @name: the case-exact name to be associated with the returned dentry
2052 *
2053 * This is to avoid filling the dcache with case-insensitive names to the
2054 * same inode, only the actual correct case is stored in the dcache for
2055 * case-insensitive filesystems.
2056 *
2057 * For a case-insensitive lookup match and if the the case-exact dentry
2058 * already exists in in the dcache, use it and return it.
2059 *
2060 * If no entry exists with the exact case name, allocate new dentry with
2061 * the exact case, and return the spliced entry.
2062 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002063struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002064 struct qstr *name)
2065{
Al Virod9171b92016-04-15 03:33:13 -04002066 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002067
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002068 /*
2069 * First check if a dentry matching the name already exists,
2070 * if not go ahead and create it now.
2071 */
Barry Naujok94035402008-05-21 16:50:46 +10002072 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002073 if (found) {
2074 iput(inode);
2075 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002076 }
Al Virod9171b92016-04-15 03:33:13 -04002077 if (d_in_lookup(dentry)) {
2078 found = d_alloc_parallel(dentry->d_parent, name,
2079 dentry->d_wait);
2080 if (IS_ERR(found) || !d_in_lookup(found)) {
2081 iput(inode);
2082 return found;
2083 }
2084 } else {
2085 found = d_alloc(dentry->d_parent, name);
2086 if (!found) {
2087 iput(inode);
2088 return ERR_PTR(-ENOMEM);
2089 }
2090 }
2091 res = d_splice_alias(inode, found);
2092 if (res) {
2093 dput(found);
2094 return res;
2095 }
Al Viro4f522a22013-02-11 23:20:37 -05002096 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002097}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002098EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002100
Al Virod4c91a82016-06-25 23:33:49 -04002101static inline bool d_same_name(const struct dentry *dentry,
2102 const struct dentry *parent,
2103 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002104{
Al Virod4c91a82016-06-25 23:33:49 -04002105 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2106 if (dentry->d_name.len != name->len)
2107 return false;
2108 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002109 }
Al Viro6fa67e72016-07-31 16:37:25 -04002110 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002111 dentry->d_name.len, dentry->d_name.name,
2112 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002113}
2114
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002116 * __d_lookup_rcu - search for a dentry (racy, store-free)
2117 * @parent: parent dentry
2118 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002119 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002120 * Returns: dentry, or NULL
2121 *
2122 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2123 * resolution (store-free path walking) design described in
2124 * Documentation/filesystems/path-lookup.txt.
2125 *
2126 * This is not to be used outside core vfs.
2127 *
2128 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2129 * held, and rcu_read_lock held. The returned dentry must not be stored into
2130 * without taking d_lock and checking d_seq sequence count against @seq
2131 * returned here.
2132 *
Linus Torvalds15570082013-09-02 11:38:06 -07002133 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002134 * function.
2135 *
2136 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2137 * the returned dentry, so long as its parent's seqlock is checked after the
2138 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2139 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002140 *
2141 * NOTE! The caller *has* to check the resulting dentry against the sequence
2142 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002143 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002144struct dentry *__d_lookup_rcu(const struct dentry *parent,
2145 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002146 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002147{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002148 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002149 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002150 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002151 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002152 struct dentry *dentry;
2153
2154 /*
2155 * Note: There is significant duplication with __d_lookup_rcu which is
2156 * required to prevent single threaded performance regressions
2157 * especially on architectures where smp_rmb (in seqcounts) are costly.
2158 * Keep the two functions in sync.
2159 */
2160
2161 /*
2162 * The hash list is protected using RCU.
2163 *
2164 * Carefully use d_seq when comparing a candidate dentry, to avoid
2165 * races with d_move().
2166 *
2167 * It is possible that concurrent renames can mess up our list
2168 * walk here and result in missing our dentry, resulting in the
2169 * false-negative result. d_lookup() protects against concurrent
2170 * renames using rename_lock seqlock.
2171 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002172 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002173 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002174 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002175 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002176
Nick Piggin31e6b012011-01-07 17:49:52 +11002177seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002178 /*
2179 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002180 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002181 *
2182 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002183 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002184 *
2185 * NOTE! We do a "raw" seqcount_begin here. That means that
2186 * we don't wait for the sequence count to stabilize if it
2187 * is in the middle of a sequence change. If we do the slow
2188 * dentry compare, we will do seqretries until it is stable,
2189 * and if we end up with a successful lookup, we actually
2190 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002191 *
2192 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2193 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002194 */
2195 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002196 if (dentry->d_parent != parent)
2197 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002198 if (d_unhashed(dentry))
2199 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002200
2201 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002202 int tlen;
2203 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002204 if (dentry->d_name.hash != hashlen_hash(hashlen))
2205 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002206 tlen = dentry->d_name.len;
2207 tname = dentry->d_name.name;
2208 /* we want a consistent (name,len) pair */
2209 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2210 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002211 goto seqretry;
2212 }
Al Viro6fa67e72016-07-31 16:37:25 -04002213 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002214 tlen, tname, name) != 0)
2215 continue;
2216 } else {
2217 if (dentry->d_name.hash_len != hashlen)
2218 continue;
2219 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2220 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002221 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002222 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002223 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002224 }
2225 return NULL;
2226}
2227
2228/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 * d_lookup - search for a dentry
2230 * @parent: parent dentry
2231 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002232 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002234 * d_lookup searches the children of the parent dentry for the name in
2235 * question. If the dentry is found its reference count is incremented and the
2236 * dentry is returned. The caller must use dput to free the entry when it has
2237 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 */
Al Viroda2d8452013-01-24 18:29:34 -05002239struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240{
Nick Piggin31e6b012011-01-07 17:49:52 +11002241 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002242 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
Daeseok Younb8314f92014-08-11 11:46:53 +09002244 do {
2245 seq = read_seqbegin(&rename_lock);
2246 dentry = __d_lookup(parent, name);
2247 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 break;
2249 } while (read_seqretry(&rename_lock, seq));
2250 return dentry;
2251}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002252EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Nick Piggin31e6b012011-01-07 17:49:52 +11002254/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002255 * __d_lookup - search for a dentry (racy)
2256 * @parent: parent dentry
2257 * @name: qstr of name we wish to find
2258 * Returns: dentry, or NULL
2259 *
2260 * __d_lookup is like d_lookup, however it may (rarely) return a
2261 * false-negative result due to unrelated rename activity.
2262 *
2263 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2264 * however it must be used carefully, eg. with a following d_lookup in
2265 * the case of failure.
2266 *
2267 * __d_lookup callers must be commented.
2268 */
Al Viroa713ca22013-01-24 18:27:00 -05002269struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002272 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002273 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002274 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002275 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276
Nick Pigginb04f7842010-08-18 04:37:34 +10002277 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002278 * Note: There is significant duplication with __d_lookup_rcu which is
2279 * required to prevent single threaded performance regressions
2280 * especially on architectures where smp_rmb (in seqcounts) are costly.
2281 * Keep the two functions in sync.
2282 */
2283
2284 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002285 * The hash list is protected using RCU.
2286 *
2287 * Take d_lock when comparing a candidate dentry, to avoid races
2288 * with d_move().
2289 *
2290 * It is possible that concurrent renames can mess up our list
2291 * walk here and result in missing our dentry, resulting in the
2292 * false-negative result. d_lookup() protects against concurrent
2293 * renames using rename_lock seqlock.
2294 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002295 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002296 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 rcu_read_lock();
2298
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002299 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 if (dentry->d_name.hash != hash)
2302 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303
2304 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 if (dentry->d_parent != parent)
2306 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002307 if (d_unhashed(dentry))
2308 goto next;
2309
Al Virod4c91a82016-06-25 23:33:49 -04002310 if (!d_same_name(dentry, parent, name))
2311 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
Waiman Long98474232013-08-28 18:24:59 -07002313 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002314 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 spin_unlock(&dentry->d_lock);
2316 break;
2317next:
2318 spin_unlock(&dentry->d_lock);
2319 }
2320 rcu_read_unlock();
2321
2322 return found;
2323}
2324
2325/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002326 * d_hash_and_lookup - hash the qstr then search for a dentry
2327 * @dir: Directory to search in
2328 * @name: qstr of name we wish to find
2329 *
Al Viro4f522a22013-02-11 23:20:37 -05002330 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002331 */
2332struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2333{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002334 /*
2335 * Check for a fs-specific hash function. Note that we must
2336 * calculate the standard hash first, as the d_op->d_hash()
2337 * routine may choose to leave the hash value unchanged.
2338 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002339 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002340 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002341 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002342 if (unlikely(err < 0))
2343 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002344 }
Al Viro4f522a22013-02-11 23:20:37 -05002345 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002346}
Al Viro4f522a22013-02-11 23:20:37 -05002347EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002348
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349/*
2350 * When a file is deleted, we have two options:
2351 * - turn this dentry into a negative dentry
2352 * - unhash this dentry and free it.
2353 *
2354 * Usually, we want to just turn this into
2355 * a negative dentry, but if anybody else is
2356 * currently using the dentry or the inode
2357 * we can't do that and we fall back on removing
2358 * it from the hash queues and waiting for
2359 * it to be deleted later when it has no users
2360 */
2361
2362/**
2363 * d_delete - delete a dentry
2364 * @dentry: The dentry to delete
2365 *
2366 * Turn the dentry into a negative dentry if possible, otherwise
2367 * remove it from the hash queues so it can be deleted later
2368 */
2369
2370void d_delete(struct dentry * dentry)
2371{
Nick Piggin873feea2011-01-07 17:50:06 +11002372 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002373 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 /*
2375 * Are we the only user?
2376 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002377again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002379 inode = dentry->d_inode;
2380 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002381 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002382 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002383 spin_unlock(&dentry->d_lock);
2384 cpu_relax();
2385 goto again;
2386 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002387 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002388 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002389 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 return;
2391 }
2392
2393 if (!d_unhashed(dentry))
2394 __d_drop(dentry);
2395
2396 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002397
2398 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002400EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401
Al Viro15d3c582016-07-29 17:45:21 -04002402static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403{
Al Viro15d3c582016-07-29 17:45:21 -04002404 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown3aa66ba2017-11-10 15:45:41 +11002405
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002406 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002407 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002408 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409}
2410
2411/**
2412 * d_rehash - add an entry back to the hash
2413 * @entry: dentry to add to the hash
2414 *
2415 * Adds a dentry to the hash according to its name.
2416 */
2417
2418void d_rehash(struct dentry * entry)
2419{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002421 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002424EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425
Al Viro84e710d2016-04-15 00:58:55 -04002426static inline unsigned start_dir_add(struct inode *dir)
2427{
2428
2429 for (;;) {
2430 unsigned n = dir->i_dir_seq;
2431 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2432 return n;
2433 cpu_relax();
2434 }
2435}
2436
2437static inline void end_dir_add(struct inode *dir, unsigned n)
2438{
2439 smp_store_release(&dir->i_dir_seq, n + 2);
2440}
2441
Al Virod9171b92016-04-15 03:33:13 -04002442static void d_wait_lookup(struct dentry *dentry)
2443{
2444 if (d_in_lookup(dentry)) {
2445 DECLARE_WAITQUEUE(wait, current);
2446 add_wait_queue(dentry->d_wait, &wait);
2447 do {
2448 set_current_state(TASK_UNINTERRUPTIBLE);
2449 spin_unlock(&dentry->d_lock);
2450 schedule();
2451 spin_lock(&dentry->d_lock);
2452 } while (d_in_lookup(dentry));
2453 }
2454}
2455
Al Viro94bdd652016-04-15 02:42:04 -04002456struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002457 const struct qstr *name,
2458 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002459{
Al Viro94bdd652016-04-15 02:42:04 -04002460 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002461 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2462 struct hlist_bl_node *node;
2463 struct dentry *new = d_alloc(parent, name);
2464 struct dentry *dentry;
2465 unsigned seq, r_seq, d_seq;
2466
2467 if (unlikely(!new))
2468 return ERR_PTR(-ENOMEM);
2469
2470retry:
2471 rcu_read_lock();
Will Deaconbcefedb2018-02-19 14:55:54 +00002472 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002473 r_seq = read_seqbegin(&rename_lock);
2474 dentry = __d_lookup_rcu(parent, name, &d_seq);
2475 if (unlikely(dentry)) {
2476 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2477 rcu_read_unlock();
2478 goto retry;
2479 }
2480 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2481 rcu_read_unlock();
2482 dput(dentry);
2483 goto retry;
2484 }
2485 rcu_read_unlock();
2486 dput(new);
2487 return dentry;
2488 }
2489 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2490 rcu_read_unlock();
2491 goto retry;
2492 }
Will Deaconbcefedb2018-02-19 14:55:54 +00002493
2494 if (unlikely(seq & 1)) {
2495 rcu_read_unlock();
2496 goto retry;
2497 }
2498
Al Viro94bdd652016-04-15 02:42:04 -04002499 hlist_bl_lock(b);
Will Deacon527ed412018-02-19 14:55:55 +00002500 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002501 hlist_bl_unlock(b);
2502 rcu_read_unlock();
2503 goto retry;
2504 }
Al Viro94bdd652016-04-15 02:42:04 -04002505 /*
2506 * No changes for the parent since the beginning of d_lookup().
2507 * Since all removals from the chain happen with hlist_bl_lock(),
2508 * any potential in-lookup matches are going to stay here until
2509 * we unlock the chain. All fields are stable in everything
2510 * we encounter.
2511 */
2512 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2513 if (dentry->d_name.hash != hash)
2514 continue;
2515 if (dentry->d_parent != parent)
2516 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002517 if (!d_same_name(dentry, parent, name))
2518 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002519 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002520 /* now we can try to grab a reference */
2521 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2522 rcu_read_unlock();
2523 goto retry;
2524 }
2525
2526 rcu_read_unlock();
2527 /*
2528 * somebody is likely to be still doing lookup for it;
2529 * wait for them to finish
2530 */
Al Virod9171b92016-04-15 03:33:13 -04002531 spin_lock(&dentry->d_lock);
2532 d_wait_lookup(dentry);
2533 /*
2534 * it's not in-lookup anymore; in principle we should repeat
2535 * everything from dcache lookup, but it's likely to be what
2536 * d_lookup() would've found anyway. If it is, just return it;
2537 * otherwise we really have to repeat the whole thing.
2538 */
2539 if (unlikely(dentry->d_name.hash != hash))
2540 goto mismatch;
2541 if (unlikely(dentry->d_parent != parent))
2542 goto mismatch;
2543 if (unlikely(d_unhashed(dentry)))
2544 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002545 if (unlikely(!d_same_name(dentry, parent, name)))
2546 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002547 /* OK, it *is* a hashed match; return it */
2548 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002549 dput(new);
2550 return dentry;
2551 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002552 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002553 /* we can't take ->d_lock here; it's OK, though. */
2554 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002555 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002556 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2557 hlist_bl_unlock(b);
2558 return new;
Al Virod9171b92016-04-15 03:33:13 -04002559mismatch:
2560 spin_unlock(&dentry->d_lock);
2561 dput(dentry);
2562 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002563}
2564EXPORT_SYMBOL(d_alloc_parallel);
2565
Al Viro85c7f812016-04-14 19:52:13 -04002566void __d_lookup_done(struct dentry *dentry)
2567{
Al Viro94bdd652016-04-15 02:42:04 -04002568 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2569 dentry->d_name.hash);
2570 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002571 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002572 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002573 wake_up_all(dentry->d_wait);
2574 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002575 hlist_bl_unlock(b);
2576 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002577 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002578}
2579EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002580
2581/* inode->i_lock held if inode is non-NULL */
2582
2583static inline void __d_add(struct dentry *dentry, struct inode *inode)
2584{
Al Viro84e710d2016-04-15 00:58:55 -04002585 struct inode *dir = NULL;
2586 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002587 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002588 if (unlikely(d_in_lookup(dentry))) {
2589 dir = dentry->d_parent->d_inode;
2590 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002591 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002592 }
Al Viroed782b52016-03-09 19:52:39 -05002593 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002594 unsigned add_flags = d_flags_for_inode(inode);
2595 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2596 raw_write_seqcount_begin(&dentry->d_seq);
2597 __d_set_inode_and_type(dentry, inode, add_flags);
2598 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002599 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002600 }
Al Viro15d3c582016-07-29 17:45:21 -04002601 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002602 if (dir)
2603 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002604 spin_unlock(&dentry->d_lock);
2605 if (inode)
2606 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002607}
2608
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002609/**
Al Viro34d0d192016-03-08 21:01:03 -05002610 * d_add - add dentry to hash queues
2611 * @entry: dentry to add
2612 * @inode: The inode to attach to this dentry
2613 *
2614 * This adds the entry to the hash queues and initializes @inode.
2615 * The entry was actually filled in earlier during d_alloc().
2616 */
2617
2618void d_add(struct dentry *entry, struct inode *inode)
2619{
Al Virob9680912016-04-11 00:53:26 -04002620 if (inode) {
2621 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002622 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002623 }
Al Viroed782b52016-03-09 19:52:39 -05002624 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002625}
2626EXPORT_SYMBOL(d_add);
2627
2628/**
Al Viro668d0cd2016-03-08 12:44:17 -05002629 * d_exact_alias - find and hash an exact unhashed alias
2630 * @entry: dentry to add
2631 * @inode: The inode to go with this dentry
2632 *
2633 * If an unhashed dentry with the same name/parent and desired
2634 * inode already exists, hash and return it. Otherwise, return
2635 * NULL.
2636 *
2637 * Parent directory should be locked.
2638 */
2639struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2640{
2641 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002642 unsigned int hash = entry->d_name.hash;
2643
2644 spin_lock(&inode->i_lock);
2645 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2646 /*
2647 * Don't need alias->d_lock here, because aliases with
2648 * d_parent == entry->d_parent are not subject to name or
2649 * parent changes, because the parent inode i_mutex is held.
2650 */
2651 if (alias->d_name.hash != hash)
2652 continue;
2653 if (alias->d_parent != entry->d_parent)
2654 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002655 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002656 continue;
2657 spin_lock(&alias->d_lock);
2658 if (!d_unhashed(alias)) {
2659 spin_unlock(&alias->d_lock);
2660 alias = NULL;
2661 } else {
2662 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002663 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002664 spin_unlock(&alias->d_lock);
2665 }
2666 spin_unlock(&inode->i_lock);
2667 return alias;
2668 }
2669 spin_unlock(&inode->i_lock);
2670 return NULL;
2671}
2672EXPORT_SYMBOL(d_exact_alias);
2673
2674/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002675 * dentry_update_name_case - update case insensitive dentry with a new name
2676 * @dentry: dentry to be updated
2677 * @name: new name
2678 *
2679 * Update a case insensitive dentry with new case of name.
2680 *
2681 * dentry must have been returned by d_lookup with name @name. Old and new
2682 * name lengths must match (ie. no d_compare which allows mismatched name
2683 * lengths).
2684 *
2685 * Parent inode i_mutex must be held over d_lookup and into this call (to
2686 * keep renames and concurrent inserts, and readdir(2) away).
2687 */
Al Viro9aba36d2016-07-20 22:28:45 -04002688void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002689{
Al Viro59551022016-01-22 15:40:57 -05002690 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002691 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2692
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002693 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002694 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002695 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002696 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002697 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002698}
2699EXPORT_SYMBOL(dentry_update_name_case);
2700
Al Viro8d85b482014-09-29 14:54:27 -04002701static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702{
Al Viro8d85b482014-09-29 14:54:27 -04002703 if (unlikely(dname_external(target))) {
2704 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705 /*
2706 * Both external: swap the pointers
2707 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002708 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 } else {
2710 /*
2711 * dentry:internal, target:external. Steal target's
2712 * storage and make target internal.
2713 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002714 memcpy(target->d_iname, dentry->d_name.name,
2715 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716 dentry->d_name.name = target->d_name.name;
2717 target->d_name.name = target->d_iname;
2718 }
2719 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002720 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721 /*
2722 * dentry:external, target:internal. Give dentry's
2723 * storage to target and make dentry internal
2724 */
2725 memcpy(dentry->d_iname, target->d_name.name,
2726 target->d_name.len + 1);
2727 target->d_name.name = dentry->d_name.name;
2728 dentry->d_name.name = dentry->d_iname;
2729 } else {
2730 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002731 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002733 unsigned int i;
2734 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002735 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2736 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002737 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2738 swap(((long *) &dentry->d_iname)[i],
2739 ((long *) &target->d_iname)[i]);
2740 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741 }
2742 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002743 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744}
2745
Al Viro8d85b482014-09-29 14:54:27 -04002746static void copy_name(struct dentry *dentry, struct dentry *target)
2747{
2748 struct external_name *old_name = NULL;
2749 if (unlikely(dname_external(dentry)))
2750 old_name = external_name(dentry);
2751 if (unlikely(dname_external(target))) {
2752 atomic_inc(&external_name(target)->u.count);
2753 dentry->d_name = target->d_name;
2754 } else {
2755 memcpy(dentry->d_iname, target->d_name.name,
2756 target->d_name.len + 1);
2757 dentry->d_name.name = dentry->d_iname;
2758 dentry->d_name.hash_len = target->d_name.hash_len;
2759 }
2760 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2761 kfree_rcu(old_name, u.head);
2762}
2763
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002764static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2765{
2766 /*
2767 * XXXX: do we really need to take target->d_lock?
2768 */
2769 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2770 spin_lock(&target->d_parent->d_lock);
2771 else {
2772 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2773 spin_lock(&dentry->d_parent->d_lock);
2774 spin_lock_nested(&target->d_parent->d_lock,
2775 DENTRY_D_LOCK_NESTED);
2776 } else {
2777 spin_lock(&target->d_parent->d_lock);
2778 spin_lock_nested(&dentry->d_parent->d_lock,
2779 DENTRY_D_LOCK_NESTED);
2780 }
2781 }
2782 if (target < dentry) {
2783 spin_lock_nested(&target->d_lock, 2);
2784 spin_lock_nested(&dentry->d_lock, 3);
2785 } else {
2786 spin_lock_nested(&dentry->d_lock, 2);
2787 spin_lock_nested(&target->d_lock, 3);
2788 }
2789}
2790
Al Viro986c0192014-09-26 23:11:15 -04002791static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002792{
2793 if (target->d_parent != dentry->d_parent)
2794 spin_unlock(&dentry->d_parent->d_lock);
2795 if (target->d_parent != target)
2796 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002797 spin_unlock(&target->d_lock);
2798 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002799}
2800
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002802 * When switching names, the actual string doesn't strictly have to
2803 * be preserved in the target - because we're dropping the target
2804 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002805 * the new name before we switch, unless we are going to rehash
2806 * it. Note that if we *do* unhash the target, we are not allowed
2807 * to rehash it without giving it a new name/hash key - whether
2808 * we swap or overwrite the names here, resulting name won't match
2809 * the reality in filesystem; it's only there for d_path() purposes.
2810 * Note that all of this is happening under rename_lock, so the
2811 * any hash lookup seeing it in the middle of manipulations will
2812 * be discarded anyway. So we do not care what happens to the hash
2813 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002815/*
Al Viro18367502011-07-12 21:42:24 -04002816 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 * @dentry: entry to move
2818 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002819 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 *
2821 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002822 * dcache entries should not be moved in this way. Caller must hold
2823 * rename_lock, the i_mutex of the source and target directories,
2824 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002826static void __d_move(struct dentry *dentry, struct dentry *target,
2827 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828{
Al Viro84e710d2016-04-15 00:58:55 -04002829 struct inode *dir = NULL;
2830 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 if (!dentry->d_inode)
2832 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2833
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002834 BUG_ON(d_ancestor(dentry, target));
2835 BUG_ON(d_ancestor(target, dentry));
2836
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002837 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002838 if (unlikely(d_in_lookup(target))) {
2839 dir = target->d_parent->d_inode;
2840 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002841 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002842 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843
Nick Piggin31e6b012011-01-07 17:49:52 +11002844 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002845 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002846
Al Viro15d3c582016-07-29 17:45:21 -04002847 /* unhash both */
NeilBrown3aa66ba2017-11-10 15:45:41 +11002848 /* ___d_drop does write_seqcount_barrier, but they're OK to nest. */
2849 ___d_drop(dentry);
2850 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002853 if (exchange)
2854 swap_names(dentry, target);
2855 else
2856 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857
Al Viro15d3c582016-07-29 17:45:21 -04002858 /* rehash in new place(s) */
2859 __d_rehash(dentry);
2860 if (exchange)
2861 __d_rehash(target);
NeilBrown3aa66ba2017-11-10 15:45:41 +11002862 else
2863 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002864
Al Viro63cf4272014-09-26 23:06:14 -04002865 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002867 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002868 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869 dentry->d_parent = target->d_parent;
2870 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002871 list_del_init(&target->d_child);
2872 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002874 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002875 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002876 list_move(&target->d_child, &target->d_parent->d_subdirs);
2877 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002878 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002879 fsnotify_update_flags(target);
2880 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 }
Eric Biggers7bc138e2019-03-20 11:39:11 -07002882 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883
Nick Piggin31e6b012011-01-07 17:49:52 +11002884 write_seqcount_end(&target->d_seq);
2885 write_seqcount_end(&dentry->d_seq);
2886
Al Viro84e710d2016-04-15 00:58:55 -04002887 if (dir)
2888 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002889 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002890}
2891
2892/*
2893 * d_move - move a dentry
2894 * @dentry: entry to move
2895 * @target: new dentry
2896 *
2897 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002898 * dcache entries should not be moved in this way. See the locking
2899 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002900 */
2901void d_move(struct dentry *dentry, struct dentry *target)
2902{
2903 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002904 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002906}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002907EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908
Miklos Szeredida1ce062014-04-01 17:08:43 +02002909/*
2910 * d_exchange - exchange two dentries
2911 * @dentry1: first dentry
2912 * @dentry2: second dentry
2913 */
2914void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2915{
2916 write_seqlock(&rename_lock);
2917
2918 WARN_ON(!dentry1->d_inode);
2919 WARN_ON(!dentry2->d_inode);
2920 WARN_ON(IS_ROOT(dentry1));
2921 WARN_ON(IS_ROOT(dentry2));
2922
2923 __d_move(dentry1, dentry2, true);
2924
2925 write_sequnlock(&rename_lock);
2926}
2927
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002928/**
2929 * d_ancestor - search for an ancestor
2930 * @p1: ancestor dentry
2931 * @p2: child dentry
2932 *
2933 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2934 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002935 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002936struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002937{
2938 struct dentry *p;
2939
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002940 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002941 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002942 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002943 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002944 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002945}
2946
2947/*
2948 * This helper attempts to cope with remotely renamed directories
2949 *
2950 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002951 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002952 *
2953 * Note: If ever the locking in lock_rename() changes, then please
2954 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002955 */
Al Virob5ae6b12014-10-12 22:16:02 -04002956static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002957 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958{
Al Viro9902af72016-04-15 15:08:36 -04002959 struct mutex *m1 = NULL;
2960 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002961 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002962
2963 /* If alias and dentry share a parent, then no extra locks required */
2964 if (alias->d_parent == dentry->d_parent)
2965 goto out_unalias;
2966
Trond Myklebust9eaef272006-10-21 10:24:20 -07002967 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002968 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2969 goto out_err;
2970 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002971 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002972 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002973 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002974out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002975 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002976 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002977out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002978 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002979 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980 if (m1)
2981 mutex_unlock(m1);
2982 return ret;
2983}
2984
David Howells770bfad2006-08-22 20:06:07 -04002985/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002986 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2987 * @inode: the inode which may have a disconnected dentry
2988 * @dentry: a negative dentry which we want to point to the inode.
2989 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002990 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2991 * place of the given dentry and return it, else simply d_add the inode
2992 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002993 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002994 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2995 * we should error out: directories can't have multiple aliases.
2996 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002997 * This is needed in the lookup routine of any filesystem that is exportable
2998 * (via knfsd) so that we can build dcache paths to directories effectively.
2999 *
3000 * If a dentry was found and moved, then it is returned. Otherwise NULL
3001 * is returned. This matches the expected return value of ->lookup.
3002 *
3003 * Cluster filesystems may call this function with a negative, hashed dentry.
3004 * In that case, we know that the inode will be a regular file, and also this
3005 * will only occur during atomic_open. So we need to check for the dentry
3006 * being already hashed only in the final case.
3007 */
3008struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3009{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003010 if (IS_ERR(inode))
3011 return ERR_CAST(inode);
3012
David Howells770bfad2006-08-22 20:06:07 -04003013 BUG_ON(!d_unhashed(dentry));
3014
Al Virode689f52016-03-09 18:05:42 -05003015 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003016 goto out;
Al Virode689f52016-03-09 18:05:42 -05003017
Al Virob9680912016-04-11 00:53:26 -04003018 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003019 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003020 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003021 struct dentry *new = __d_find_any_alias(inode);
3022 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003023 /* The reference to new ensures it remains an alias */
3024 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003025 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003026 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003027 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003028 dput(new);
3029 new = ERR_PTR(-ELOOP);
3030 pr_warn_ratelimited(
3031 "VFS: Lookup of '%s' in %s %s"
3032 " would have caused loop\n",
3033 dentry->d_name.name,
3034 inode->i_sb->s_type->name,
3035 inode->i_sb->s_id);
3036 } else if (!IS_ROOT(new)) {
3037 int err = __d_unalias(inode, dentry, new);
3038 write_sequnlock(&rename_lock);
3039 if (err) {
3040 dput(new);
3041 new = ERR_PTR(err);
3042 }
Al Viro18367502011-07-12 21:42:24 -04003043 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003044 __d_move(new, dentry, false);
3045 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003046 }
Al Virob5ae6b12014-10-12 22:16:02 -04003047 iput(inode);
3048 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003049 }
David Howells770bfad2006-08-22 20:06:07 -04003050 }
Al Virob5ae6b12014-10-12 22:16:02 -04003051out:
Al Viroed782b52016-03-09 19:52:39 -05003052 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003053 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003054}
Al Virob5ae6b12014-10-12 22:16:02 -04003055EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003056
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003057static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003058{
3059 *buflen -= namelen;
3060 if (*buflen < 0)
3061 return -ENAMETOOLONG;
3062 *buffer -= namelen;
3063 memcpy(*buffer, str, namelen);
3064 return 0;
3065}
3066
Waiman Long232d2d62013-09-09 12:18:13 -04003067/**
3068 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003069 * @buffer: buffer pointer
3070 * @buflen: allocated length of the buffer
3071 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003072 *
3073 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3074 * make sure that either the old or the new name pointer and length are
3075 * fetched. However, there may be mismatch between length and pointer.
3076 * The length cannot be trusted, we need to copy it byte-by-byte until
3077 * the length is reached or a null byte is found. It also prepends "/" at
3078 * the beginning of the name. The sequence number check at the caller will
3079 * retry it again when a d_move() does happen. So any garbage in the buffer
3080 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003081 *
3082 * Data dependency barrier is needed to make sure that we see that terminating
3083 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003084 */
Al Viro9aba36d2016-07-20 22:28:45 -04003085static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003086{
Waiman Long232d2d62013-09-09 12:18:13 -04003087 const char *dname = ACCESS_ONCE(name->name);
3088 u32 dlen = ACCESS_ONCE(name->len);
3089 char *p;
3090
Al Viro6d13f692014-09-29 14:46:30 -04003091 smp_read_barrier_depends();
3092
Waiman Long232d2d62013-09-09 12:18:13 -04003093 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003094 if (*buflen < 0)
3095 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003096 p = *buffer -= dlen + 1;
3097 *p++ = '/';
3098 while (dlen--) {
3099 char c = *dname++;
3100 if (!c)
3101 break;
3102 *p++ = c;
3103 }
3104 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003105}
3106
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003108 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003109 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003110 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003111 * @buffer: pointer to the end of the buffer
3112 * @buflen: pointer to buffer length
3113 *
Waiman Long18129972013-09-12 10:55:35 -04003114 * The function will first try to write out the pathname without taking any
3115 * lock other than the RCU read lock to make sure that dentries won't go away.
3116 * It only checks the sequence number of the global rename_lock as any change
3117 * in the dentry's d_seq will be preceded by changes in the rename_lock
3118 * sequence number. If the sequence number had been changed, it will restart
3119 * the whole pathname back-tracing sequence again by taking the rename_lock.
3120 * In this case, there is no need to take the RCU read lock as the recursive
3121 * parent pointer references will keep the dentry chain alive as long as no
3122 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003123 */
Al Viro02125a82011-12-05 08:43:34 -05003124static int prepend_path(const struct path *path,
3125 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003126 char **buffer, int *buflen)
3127{
Al Viroede4ceb2013-11-13 07:45:40 -05003128 struct dentry *dentry;
3129 struct vfsmount *vfsmnt;
3130 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003131 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003132 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003133 char *bptr;
3134 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003135
Al Viro48f5ec22013-09-09 15:22:25 -04003136 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003137restart_mnt:
3138 read_seqbegin_or_lock(&mount_lock, &m_seq);
3139 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003140 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003141restart:
3142 bptr = *buffer;
3143 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003144 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003145 dentry = path->dentry;
3146 vfsmnt = path->mnt;
3147 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003148 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003149 while (dentry != root->dentry || vfsmnt != root->mnt) {
3150 struct dentry * parent;
3151
3152 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003153 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003154 /* Escaped? */
3155 if (dentry != vfsmnt->mnt_root) {
3156 bptr = *buffer;
3157 blen = *buflen;
3158 error = 3;
3159 break;
3160 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003161 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003162 if (mnt != parent) {
3163 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3164 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003165 vfsmnt = &mnt->mnt;
3166 continue;
3167 }
Waiman Long232d2d62013-09-09 12:18:13 -04003168 if (!error)
3169 error = is_mounted(vfsmnt) ? 1 : 2;
3170 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003171 }
3172 parent = dentry->d_parent;
3173 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003174 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003175 if (error)
3176 break;
3177
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003178 dentry = parent;
3179 }
Al Viro48f5ec22013-09-09 15:22:25 -04003180 if (!(seq & 1))
3181 rcu_read_unlock();
3182 if (need_seqretry(&rename_lock, seq)) {
3183 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003184 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003185 }
Al Viro48f5ec22013-09-09 15:22:25 -04003186 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003187
3188 if (!(m_seq & 1))
3189 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003190 if (need_seqretry(&mount_lock, m_seq)) {
3191 m_seq = 1;
3192 goto restart_mnt;
3193 }
3194 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003195
Waiman Long232d2d62013-09-09 12:18:13 -04003196 if (error >= 0 && bptr == *buffer) {
3197 if (--blen < 0)
3198 error = -ENAMETOOLONG;
3199 else
3200 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003201 }
Waiman Long232d2d62013-09-09 12:18:13 -04003202 *buffer = bptr;
3203 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003204 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003205}
3206
3207/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003208 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003209 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003210 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003211 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 * @buflen: buffer length
3213 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003214 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003216 * Returns a pointer into the buffer or an error code if the
3217 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003218 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003219 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003220 *
Al Viro02125a82011-12-05 08:43:34 -05003221 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 */
Al Viro02125a82011-12-05 08:43:34 -05003223char *__d_path(const struct path *path,
3224 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003225 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003226{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003227 char *res = buf + buflen;
3228 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003230 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003231 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003232
Al Viro02125a82011-12-05 08:43:34 -05003233 if (error < 0)
3234 return ERR_PTR(error);
3235 if (error > 0)
3236 return NULL;
3237 return res;
3238}
3239
3240char *d_absolute_path(const struct path *path,
3241 char *buf, int buflen)
3242{
3243 struct path root = {};
3244 char *res = buf + buflen;
3245 int error;
3246
3247 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003248 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003249
3250 if (error > 1)
3251 error = -EINVAL;
3252 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003253 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003254 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255}
Guenter Roeck671662b2016-03-24 10:32:35 -07003256EXPORT_SYMBOL(d_absolute_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003258/*
3259 * same as __d_path but appends "(deleted)" for unlinked files.
3260 */
Al Viro02125a82011-12-05 08:43:34 -05003261static int path_with_deleted(const struct path *path,
3262 const struct path *root,
3263 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003264{
3265 prepend(buf, buflen, "\0", 1);
3266 if (d_unlinked(path->dentry)) {
3267 int error = prepend(buf, buflen, " (deleted)", 10);
3268 if (error)
3269 return error;
3270 }
3271
3272 return prepend_path(path, root, buf, buflen);
3273}
3274
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003275static int prepend_unreachable(char **buffer, int *buflen)
3276{
3277 return prepend(buffer, buflen, "(unreachable)", 13);
3278}
3279
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003280static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3281{
3282 unsigned seq;
3283
3284 do {
3285 seq = read_seqcount_begin(&fs->seq);
3286 *root = fs->root;
3287 } while (read_seqcount_retry(&fs->seq, seq));
3288}
3289
Jan Bluncka03a8a702008-02-14 19:38:32 -08003290/**
3291 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003292 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003293 * @buf: buffer to return value in
3294 * @buflen: buffer length
3295 *
3296 * Convert a dentry into an ASCII path name. If the entry has been deleted
3297 * the string " (deleted)" is appended. Note that this is ambiguous.
3298 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003299 * Returns a pointer into the buffer or an error code if the path was
3300 * too long. Note: Callers should use the returned pointer, not the passed
3301 * in buffer, to use the name! The implementation often starts at an offset
3302 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003303 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003304 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003305 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003306char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003308 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003309 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003310 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003312 /*
3313 * We have various synthetic filesystems that never get mounted. On
3314 * these filesystems dentries are never used for lookup purposes, and
3315 * thus don't need to be hashed. They also don't need a name until a
3316 * user wants to identify the object in /proc/pid/fd/. The little hack
3317 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003318 *
3319 * Some pseudo inodes are mountable. When they are mounted
3320 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3321 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003322 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003323 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3324 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003325 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003326
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003327 rcu_read_lock();
3328 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003329 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003330 rcu_read_unlock();
3331
Al Viro02125a82011-12-05 08:43:34 -05003332 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003333 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003334 return res;
3335}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003336EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003337
3338/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003339 * Helper function for dentry_operations.d_dname() members
3340 */
3341char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3342 const char *fmt, ...)
3343{
3344 va_list args;
3345 char temp[64];
3346 int sz;
3347
3348 va_start(args, fmt);
3349 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3350 va_end(args);
3351
3352 if (sz > sizeof(temp) || sz > buflen)
3353 return ERR_PTR(-ENAMETOOLONG);
3354
3355 buffer += buflen - sz;
3356 return memcpy(buffer, temp, sz);
3357}
3358
Al Viro118b2302013-08-24 12:08:17 -04003359char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3360{
3361 char *end = buffer + buflen;
3362 /* these dentries are never renamed, so d_lock is not needed */
3363 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003364 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003365 prepend(&end, &buflen, "/", 1))
3366 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003367 return end;
Al Viro118b2302013-08-24 12:08:17 -04003368}
David Herrmann31bbe162014-01-03 14:09:47 +01003369EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003370
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003371/*
Ram Pai6092d042008-03-27 13:06:20 +01003372 * Write full pathname from the root of the filesystem into the buffer.
3373 */
Al Virof6500802014-01-26 12:37:55 -05003374static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003375{
Al Virof6500802014-01-26 12:37:55 -05003376 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003377 char *end, *retval;
3378 int len, seq = 0;
3379 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003380
Al Virof6500802014-01-26 12:37:55 -05003381 if (buflen < 2)
3382 goto Elong;
3383
Al Viro48f5ec22013-09-09 15:22:25 -04003384 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003385restart:
Al Virof6500802014-01-26 12:37:55 -05003386 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003387 end = buf + buflen;
3388 len = buflen;
3389 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003390 /* Get '/' right */
3391 retval = end-1;
3392 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003393 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003394 while (!IS_ROOT(dentry)) {
3395 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003396
Ram Pai6092d042008-03-27 13:06:20 +01003397 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003398 error = prepend_name(&end, &len, &dentry->d_name);
3399 if (error)
3400 break;
Ram Pai6092d042008-03-27 13:06:20 +01003401
3402 retval = end;
3403 dentry = parent;
3404 }
Al Viro48f5ec22013-09-09 15:22:25 -04003405 if (!(seq & 1))
3406 rcu_read_unlock();
3407 if (need_seqretry(&rename_lock, seq)) {
3408 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003409 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003410 }
3411 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003412 if (error)
3413 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003414 return retval;
3415Elong:
3416 return ERR_PTR(-ENAMETOOLONG);
3417}
Nick Pigginec2447c2011-01-07 17:49:29 +11003418
3419char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3420{
Waiman Long232d2d62013-09-09 12:18:13 -04003421 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003422}
3423EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003424
3425char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3426{
3427 char *p = NULL;
3428 char *retval;
3429
Al Viroc1031352010-06-06 22:31:14 -04003430 if (d_unlinked(dentry)) {
3431 p = buf + buflen;
3432 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3433 goto Elong;
3434 buflen++;
3435 }
3436 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003437 if (!IS_ERR(retval) && p)
3438 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003439 return retval;
3440Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003441 return ERR_PTR(-ENAMETOOLONG);
3442}
3443
Linus Torvalds8b19e342013-09-12 10:35:47 -07003444static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3445 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003446{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003447 unsigned seq;
3448
3449 do {
3450 seq = read_seqcount_begin(&fs->seq);
3451 *root = fs->root;
3452 *pwd = fs->pwd;
3453 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003454}
3455
Ram Pai6092d042008-03-27 13:06:20 +01003456/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457 * NOTE! The user-level library version returns a
3458 * character pointer. The kernel system call just
3459 * returns the length of the buffer filled (which
3460 * includes the ending '\0' character), or a negative
3461 * error value. So libc would do something like
3462 *
3463 * char *getcwd(char * buf, size_t size)
3464 * {
3465 * int retval;
3466 *
3467 * retval = sys_getcwd(buf, size);
3468 * if (retval >= 0)
3469 * return buf;
3470 * errno = -retval;
3471 * return NULL;
3472 * }
3473 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003474SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003475{
Linus Torvalds552ce542007-02-13 12:08:18 -08003476 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003477 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003478 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479
3480 if (!page)
3481 return -ENOMEM;
3482
Linus Torvalds8b19e342013-09-12 10:35:47 -07003483 rcu_read_lock();
3484 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485
Linus Torvalds552ce542007-02-13 12:08:18 -08003486 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003487 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003488 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003489 char *cwd = page + PATH_MAX;
3490 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003491
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003492 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003493 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003494 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003495
Al Viro02125a82011-12-05 08:43:34 -05003496 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003497 goto out;
3498
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003499 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003500 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003501 error = prepend_unreachable(&cwd, &buflen);
3502 if (error)
3503 goto out;
3504 }
3505
Linus Torvalds552ce542007-02-13 12:08:18 -08003506 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003507 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003508 if (len <= size) {
3509 error = len;
3510 if (copy_to_user(buf, cwd, len))
3511 error = -EFAULT;
3512 }
Nick Piggin949854d2011-01-07 17:49:37 +11003513 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003514 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516
3517out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003518 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519 return error;
3520}
3521
3522/*
3523 * Test whether new_dentry is a subdirectory of old_dentry.
3524 *
3525 * Trivially implemented using the dcache structure
3526 */
3527
3528/**
3529 * is_subdir - is new dentry a subdirectory of old_dentry
3530 * @new_dentry: new dentry
3531 * @old_dentry: old dentry
3532 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003533 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3534 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3536 */
3537
Yaowei Baia6e57872015-11-17 14:40:11 +08003538bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539{
Yaowei Baia6e57872015-11-17 14:40:11 +08003540 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003541 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003543 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003544 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003545
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003546 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003549 /*
3550 * Need rcu_readlock to protect against the d_parent trashing
3551 * due to d_move
3552 */
3553 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003554 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003555 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003556 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003557 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003558 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003559 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003560
3561 return result;
3562}
3563
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003564static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003566 struct dentry *root = data;
3567 if (dentry != root) {
3568 if (d_unhashed(dentry) || !dentry->d_inode)
3569 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003571 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3572 dentry->d_flags |= DCACHE_GENOCIDE;
3573 dentry->d_lockref.count--;
3574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003576 return D_WALK_CONTINUE;
3577}
Nick Piggin58db63d2011-01-07 17:49:39 +11003578
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003579void d_genocide(struct dentry *parent)
3580{
3581 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582}
3583
Al Viro60545d02013-06-07 01:20:27 -04003584void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585{
Al Viro60545d02013-06-07 01:20:27 -04003586 inode_dec_link_count(inode);
3587 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003588 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003589 !d_unlinked(dentry));
3590 spin_lock(&dentry->d_parent->d_lock);
3591 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3592 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3593 (unsigned long long)inode->i_ino);
3594 spin_unlock(&dentry->d_lock);
3595 spin_unlock(&dentry->d_parent->d_lock);
3596 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597}
Al Viro60545d02013-06-07 01:20:27 -04003598EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003599
3600static __initdata unsigned long dhash_entries;
3601static int __init set_dhash_entries(char *str)
3602{
3603 if (!str)
3604 return 0;
3605 dhash_entries = simple_strtoul(str, &str, 0);
3606 return 1;
3607}
3608__setup("dhash_entries=", set_dhash_entries);
3609
3610static void __init dcache_init_early(void)
3611{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003612 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613
3614 /* If hashes are distributed across NUMA nodes, defer
3615 * hash allocation until vmalloc space is available.
3616 */
3617 if (hashdist)
3618 return;
3619
3620 dentry_hashtable =
3621 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003622 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003623 dhash_entries,
3624 13,
3625 HASH_EARLY,
3626 &d_hash_shift,
3627 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003628 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003629 0);
3630
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003631 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003632 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003633}
3634
Denis Cheng74bf17c2007-10-16 23:26:30 -07003635static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003637 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638
3639 /*
3640 * A constructor could be added for stable state like the lists,
3641 * but it is probably not worth it because of the cache nature
3642 * of the dcache.
3643 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003644 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003645 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646
3647 /* Hash may have been set up in dcache_init_early */
3648 if (!hashdist)
3649 return;
3650
3651 dentry_hashtable =
3652 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003653 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654 dhash_entries,
3655 13,
3656 0,
3657 &d_hash_shift,
3658 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003659 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660 0);
3661
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003662 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003663 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003664}
3665
3666/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003667struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003668EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003669
Linus Torvalds1da177e2005-04-16 15:20:36 -07003670EXPORT_SYMBOL(d_genocide);
3671
Linus Torvalds1da177e2005-04-16 15:20:36 -07003672void __init vfs_caches_init_early(void)
3673{
3674 dcache_init_early();
3675 inode_init_early();
3676}
3677
Mel Gorman4248b0d2015-08-06 15:46:20 -07003678void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003679{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003680 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003681 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003682
Denis Cheng74bf17c2007-10-16 23:26:30 -07003683 dcache_init();
3684 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003685 files_init();
3686 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003687 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003688 bdev_cache_init();
3689 chrdev_init();
3690}