blob: 6c30be668487ca53725efc2229ac64dce68b9abc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080041#include <linux/kasan.h>
42
David Howells07f3f052006-09-30 20:52:18 +020043#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050044#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nick Piggin789680d2011-01-07 17:49:30 +110046/*
47 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110048 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040049 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110050 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100054 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110055 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110060 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110061 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110062 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040064 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110065 *
66 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110067 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110068 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100069 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110070 * dcache_hash_bucket lock
71 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110072 *
Nick Pigginda502952011-01-07 17:49:33 +110073 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110080 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080084int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
Al Viro74c3cbe2007-07-22 08:04:18 -040087__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Nick Piggin949854d2011-01-07 17:49:37 +110089EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Christoph Lametere18b8902006-12-06 20:33:20 -080091static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700105static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106
Linus Torvalds8387ff22016-06-10 07:51:30 -0700107static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108{
George Spelvin703b5fa2016-06-10 00:22:12 -0400109 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Al Viro94bdd652016-04-15 02:42:04 -0400112#define IN_LOOKUP_SHIFT 10
113static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
114
115static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
116 unsigned int hash)
117{
118 hash += (unsigned long) parent / L1_CACHE_BYTES;
119 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
120}
121
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Statistics gathering. */
124struct dentry_stat_t dentry_stat = {
125 .age_limit = 45,
126};
127
Glauber Costa3942c072013-08-28 10:17:53 +1000128static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000129static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400130
131#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000132
133/*
134 * Here we resort to our own counters instead of using generic per-cpu counters
135 * for consistency with what the vfs inode code does. We are expected to harvest
136 * better code and performance by having our own specialized counters.
137 *
138 * Please note that the loop is done over all possible CPUs, not over all online
139 * CPUs. The reason for this is that we don't want to play games with CPUs going
140 * on and off. If one of them goes off, we will just keep their counters.
141 *
142 * glommer: See cffbc8a for details, and if you ever intend to change this,
143 * please update all vfs counters to match.
144 */
Glauber Costa3942c072013-08-28 10:17:53 +1000145static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146{
147 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000148 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry, i);
151 return sum < 0 ? 0 : sum;
152}
153
Dave Chinner62d36c72013-08-28 10:17:54 +1000154static long get_nr_dentry_unused(void)
155{
156 int i;
157 long sum = 0;
158 for_each_possible_cpu(i)
159 sum += per_cpu(nr_dentry_unused, i);
160 return sum < 0 ? 0 : sum;
161}
162
Joe Perches1f7e0612014-06-06 14:38:05 -0700163int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400164 size_t *lenp, loff_t *ppos)
165{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000167 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000168 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169}
170#endif
171
Linus Torvalds5483f182012-03-04 15:51:42 -0800172/*
173 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
174 * The strings are both count bytes long, and count is non-zero.
175 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700176#ifdef CONFIG_DCACHE_WORD_ACCESS
177
178#include <asm/word-at-a-time.h>
179/*
180 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
181 * aligned allocation for this particular component. We don't
182 * strictly need the load_unaligned_zeropad() safety, but it
183 * doesn't hurt either.
184 *
185 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
186 * need the careful unaligned handling.
187 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700188static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800189{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800190 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191
192 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700193 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700194 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 if (tcount < sizeof(unsigned long))
196 break;
197 if (unlikely(a != b))
198 return 1;
199 cs += sizeof(unsigned long);
200 ct += sizeof(unsigned long);
201 tcount -= sizeof(unsigned long);
202 if (!tcount)
203 return 0;
204 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000205 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800206 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700207}
208
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800209#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210
Linus Torvalds94753db52012-05-10 12:19:19 -0700211static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212{
Linus Torvalds5483f182012-03-04 15:51:42 -0800213 do {
214 if (*cs != *ct)
215 return 1;
216 cs++;
217 ct++;
218 tcount--;
219 } while (tcount);
220 return 0;
221}
222
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700223#endif
224
Linus Torvalds94753db52012-05-10 12:19:19 -0700225static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
226{
Linus Torvalds94753db52012-05-10 12:19:19 -0700227 /*
228 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000229 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700230 *
231 * NOTE! Even if a rename will mean that the length
232 * was not loaded atomically, we don't care. The
233 * RCU walk will check the sequence count eventually,
234 * and catch it. And we won't overrun the buffer,
235 * because we're reading the name pointer atomically,
236 * and a dentry name is guaranteed to be properly
237 * terminated with a NUL byte.
238 *
239 * End result: even if 'len' is wrong, we'll exit
240 * early because the data cannot match (there can
241 * be no NUL in the ct/tcount data)
242 */
He Kuangae0a8432016-03-26 09:12:10 +0000243 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
244
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700245 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700246}
247
Al Viro8d85b482014-09-29 14:54:27 -0400248struct external_name {
249 union {
250 atomic_t count;
251 struct rcu_head head;
252 } u;
253 unsigned char name[];
254};
255
256static inline struct external_name *external_name(struct dentry *dentry)
257{
258 return container_of(dentry->d_name.name, struct external_name, name[0]);
259}
260
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400261static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400263 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
264
Al Viro8d85b482014-09-29 14:54:27 -0400265 kmem_cache_free(dentry_cache, dentry);
266}
267
268static void __d_free_external(struct rcu_head *head)
269{
270 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400271 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 kmem_cache_free(dentry_cache, dentry);
273}
274
Al Viro810bb172014-10-12 12:45:37 -0400275static inline int dname_external(const struct dentry *dentry)
276{
277 return dentry->d_name.name != dentry->d_iname;
278}
279
Al Viro49d31c22017-07-07 14:51:19 -0400280void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
281{
282 spin_lock(&dentry->d_lock);
283 if (unlikely(dname_external(dentry))) {
284 struct external_name *p = external_name(dentry);
285 atomic_inc(&p->u.count);
286 spin_unlock(&dentry->d_lock);
287 name->name = p->name;
288 } else {
289 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
290 spin_unlock(&dentry->d_lock);
291 name->name = name->inline_name;
292 }
293}
294EXPORT_SYMBOL(take_dentry_name_snapshot);
295
296void release_dentry_name_snapshot(struct name_snapshot *name)
297{
298 if (unlikely(name->name != name->inline_name)) {
299 struct external_name *p;
300 p = container_of(name->name, struct external_name, name[0]);
301 if (unlikely(atomic_dec_and_test(&p->u.count)))
302 kfree_rcu(p, u.head);
303 }
304}
305EXPORT_SYMBOL(release_dentry_name_snapshot);
306
David Howells4bf46a22015-03-05 14:09:22 +0000307static inline void __d_set_inode_and_type(struct dentry *dentry,
308 struct inode *inode,
309 unsigned type_flags)
310{
311 unsigned flags;
312
313 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000314 flags = READ_ONCE(dentry->d_flags);
315 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
316 flags |= type_flags;
317 WRITE_ONCE(dentry->d_flags, flags);
318}
319
David Howells4bf46a22015-03-05 14:09:22 +0000320static inline void __d_clear_type_and_inode(struct dentry *dentry)
321{
322 unsigned flags = READ_ONCE(dentry->d_flags);
323
324 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
325 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000326 dentry->d_inode = NULL;
327}
328
Al Virob4f03542014-04-29 23:40:14 -0400329static void dentry_free(struct dentry *dentry)
330{
Al Viro946e51f2014-10-26 19:19:16 -0400331 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400332 if (unlikely(dname_external(dentry))) {
333 struct external_name *p = external_name(dentry);
334 if (likely(atomic_dec_and_test(&p->u.count))) {
335 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
336 return;
337 }
338 }
Al Virob4f03542014-04-29 23:40:14 -0400339 /* if dentry was never visible to RCU, immediate free is OK */
340 if (!(dentry->d_flags & DCACHE_RCUACCESS))
341 __d_free(&dentry->d_u.d_rcu);
342 else
343 call_rcu(&dentry->d_u.d_rcu, __d_free);
344}
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346/*
347 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400348 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100349 */
350static void dentry_unlink_inode(struct dentry * dentry)
351 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100352 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100353{
354 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400355 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500356
Al Viro550dce02016-05-29 20:13:30 -0400357 if (hashed)
358 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 Viro550dce02016-05-29 20:13:30 -0400361 if (hashed)
362 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100363 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100364 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100365 if (!inode->i_nlink)
366 fsnotify_inoderemove(inode);
367 if (dentry->d_op && dentry->d_op->d_iput)
368 dentry->d_op->d_iput(dentry, inode);
369 else
370 iput(inode);
371}
372
373/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400374 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
375 * is in use - which includes both the "real" per-superblock
376 * LRU list _and_ the DCACHE_SHRINK_LIST use.
377 *
378 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
379 * on the shrink list (ie not on the superblock LRU list).
380 *
381 * The per-cpu "nr_dentry_unused" counters are updated with
382 * the DCACHE_LRU_LIST bit.
383 *
384 * These helper functions make sure we always follow the
385 * rules. d_lock must be held by the caller.
386 */
387#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
388static void d_lru_add(struct dentry *dentry)
389{
390 D_FLAG_VERIFY(dentry, 0);
391 dentry->d_flags |= DCACHE_LRU_LIST;
392 this_cpu_inc(nr_dentry_unused);
393 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
394}
395
396static void d_lru_del(struct dentry *dentry)
397{
398 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
399 dentry->d_flags &= ~DCACHE_LRU_LIST;
400 this_cpu_dec(nr_dentry_unused);
401 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
402}
403
404static void d_shrink_del(struct dentry *dentry)
405{
406 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
407 list_del_init(&dentry->d_lru);
408 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
409 this_cpu_dec(nr_dentry_unused);
410}
411
412static void d_shrink_add(struct dentry *dentry, struct list_head *list)
413{
414 D_FLAG_VERIFY(dentry, 0);
415 list_add(&dentry->d_lru, list);
416 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
417 this_cpu_inc(nr_dentry_unused);
418}
419
420/*
421 * These can only be called under the global LRU lock, ie during the
422 * callback for freeing the LRU list. "isolate" removes it from the
423 * LRU lists entirely, while shrink_move moves it to the indicated
424 * private list.
425 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800426static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400427{
428 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
429 dentry->d_flags &= ~DCACHE_LRU_LIST;
430 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800431 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400432}
433
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800434static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
435 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400436{
437 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
438 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800439 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400440}
441
442/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000443 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700444 */
445static void dentry_lru_add(struct dentry *dentry)
446{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400447 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
448 d_lru_add(dentry);
Josef Bacik563f4002017-04-18 16:04:17 -0400449 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
450 dentry->d_flags |= DCACHE_REFERENCED;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700451}
452
Miklos Szeredid52b9082007-05-08 00:23:46 -0700453/**
Nick Piggin789680d2011-01-07 17:49:30 +1100454 * d_drop - drop a dentry
455 * @dentry: dentry to drop
456 *
457 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
458 * be found through a VFS lookup any more. Note that this is different from
459 * deleting the dentry - d_delete will try to mark the dentry negative if
460 * possible, giving a successful _negative_ lookup, while d_drop will
461 * just make the cache lookup fail.
462 *
463 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
464 * reason (NFS timeouts or autofs deletes).
465 *
466 * __d_drop requires dentry->d_lock.
467 */
468void __d_drop(struct dentry *dentry)
469{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700470 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400471 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400472 /*
473 * Hashed dentries are normally on the dentry hashtable,
474 * with the exception of those newly allocated by
475 * d_obtain_alias, which are always IS_ROOT:
476 */
477 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400478 b = &dentry->d_sb->s_anon;
479 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700480 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400481
482 hlist_bl_lock(b);
483 __hlist_bl_del(&dentry->d_hash);
484 dentry->d_hash.pprev = NULL;
485 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400486 /* After this call, in-progress rcu-walk path lookup will fail. */
487 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100488 }
489}
490EXPORT_SYMBOL(__d_drop);
491
492void d_drop(struct dentry *dentry)
493{
Nick Piggin789680d2011-01-07 17:49:30 +1100494 spin_lock(&dentry->d_lock);
495 __d_drop(dentry);
496 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100497}
498EXPORT_SYMBOL(d_drop);
499
Al Viroba65dc52016-06-10 11:32:47 -0400500static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
501{
502 struct dentry *next;
503 /*
504 * Inform d_walk() and shrink_dentry_list() that we are no longer
505 * attached to the dentry tree
506 */
507 dentry->d_flags |= DCACHE_DENTRY_KILLED;
508 if (unlikely(list_empty(&dentry->d_child)))
509 return;
510 __list_del_entry(&dentry->d_child);
511 /*
512 * Cursors can move around the list of children. While we'd been
513 * a normal list member, it didn't matter - ->d_child.next would've
514 * been updated. However, from now on it won't be and for the
515 * things like d_walk() it might end up with a nasty surprise.
516 * Normally d_walk() doesn't care about cursors moving around -
517 * ->d_lock on parent prevents that and since a cursor has no children
518 * of its own, we get through it without ever unlocking the parent.
519 * There is one exception, though - if we ascend from a child that
520 * gets killed as soon as we unlock it, the next sibling is found
521 * using the value left in its ->d_child.next. And if _that_
522 * pointed to a cursor, and cursor got moved (e.g. by lseek())
523 * before d_walk() regains parent->d_lock, we'll end up skipping
524 * everything the cursor had been moved past.
525 *
526 * Solution: make sure that the pointer left behind in ->d_child.next
527 * points to something that won't be moving around. I.e. skip the
528 * cursors.
529 */
530 while (dentry->d_child.next != &parent->d_subdirs) {
531 next = list_entry(dentry->d_child.next, struct dentry, d_child);
532 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
533 break;
534 dentry->d_child.next = next->d_child.next;
535 }
536}
537
Al Viroe55fd012014-05-28 13:51:12 -0400538static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100539{
Al Viro41edf272014-05-01 10:30:00 -0400540 struct dentry *parent = NULL;
541 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400542 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100543 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100544
Linus Torvalds0d984392013-09-08 13:46:52 -0700545 /*
546 * The dentry is now unrecoverably dead to the world.
547 */
548 lockref_mark_dead(&dentry->d_lockref);
549
Sage Weilf0023bc2011-10-28 10:02:42 -0700550 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700551 * inform the fs via d_prune that this dentry is about to be
552 * unhashed and destroyed.
553 */
Al Viro29266202014-05-30 11:39:02 -0400554 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800555 dentry->d_op->d_prune(dentry);
556
Al Viro01b60352014-04-29 23:42:52 -0400557 if (dentry->d_flags & DCACHE_LRU_LIST) {
558 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
559 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400560 }
Nick Piggin77812a12011-01-07 17:49:48 +1100561 /* if it was on the hash then remove it */
562 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400563 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400564 if (parent)
565 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400566 if (dentry->d_inode)
567 dentry_unlink_inode(dentry);
568 else
569 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400570 this_cpu_dec(nr_dentry);
571 if (dentry->d_op && dentry->d_op->d_release)
572 dentry->d_op->d_release(dentry);
573
Al Viro41edf272014-05-01 10:30:00 -0400574 spin_lock(&dentry->d_lock);
575 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
576 dentry->d_flags |= DCACHE_MAY_FREE;
577 can_free = false;
578 }
579 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400580 if (likely(can_free))
581 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400582}
583
584/*
585 * Finish off a dentry we've decided to kill.
586 * dentry->d_lock must be held, returns with it unlocked.
587 * If ref is non-zero, then decrement the refcount too.
588 * Returns dentry requiring refcount drop, or NULL if we're done.
589 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400590static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400591 __releases(dentry->d_lock)
592{
593 struct inode *inode = dentry->d_inode;
594 struct dentry *parent = NULL;
595
596 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
597 goto failed;
598
599 if (!IS_ROOT(dentry)) {
600 parent = dentry->d_parent;
601 if (unlikely(!spin_trylock(&parent->d_lock))) {
602 if (inode)
603 spin_unlock(&inode->i_lock);
604 goto failed;
605 }
606 }
607
608 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400609 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400610
611failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400612 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400613 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100614}
615
Al Viro046b9612014-05-29 08:54:52 -0400616static inline struct dentry *lock_parent(struct dentry *dentry)
617{
618 struct dentry *parent = dentry->d_parent;
619 if (IS_ROOT(dentry))
620 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800621 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400622 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400623 if (likely(spin_trylock(&parent->d_lock)))
624 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400625 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400626 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400627again:
628 parent = ACCESS_ONCE(dentry->d_parent);
629 spin_lock(&parent->d_lock);
630 /*
631 * We can't blindly lock dentry until we are sure
632 * that we won't violate the locking order.
633 * Any changes of dentry->d_parent must have
634 * been done with parent->d_lock held, so
635 * spin_lock() above is enough of a barrier
636 * for checking if it's still our child.
637 */
638 if (unlikely(parent != dentry->d_parent)) {
639 spin_unlock(&parent->d_lock);
640 goto again;
641 }
642 rcu_read_unlock();
643 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700644 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400645 else
646 parent = NULL;
647 return parent;
648}
649
Linus Torvalds360f5472015-01-09 15:19:03 -0800650/*
651 * Try to do a lockless dput(), and return whether that was successful.
652 *
653 * If unsuccessful, we return false, having already taken the dentry lock.
654 *
655 * The caller needs to hold the RCU read lock, so that the dentry is
656 * guaranteed to stay around even if the refcount goes down to zero!
657 */
658static inline bool fast_dput(struct dentry *dentry)
659{
660 int ret;
661 unsigned int d_flags;
662
663 /*
664 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100665 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800666 */
667 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
668 return lockref_put_or_lock(&dentry->d_lockref);
669
670 /*
671 * .. otherwise, we can try to just decrement the
672 * lockref optimistically.
673 */
674 ret = lockref_put_return(&dentry->d_lockref);
675
676 /*
677 * If the lockref_put_return() failed due to the lock being held
678 * by somebody else, the fast path has failed. We will need to
679 * get the lock, and then check the count again.
680 */
681 if (unlikely(ret < 0)) {
682 spin_lock(&dentry->d_lock);
683 if (dentry->d_lockref.count > 1) {
684 dentry->d_lockref.count--;
685 spin_unlock(&dentry->d_lock);
686 return 1;
687 }
688 return 0;
689 }
690
691 /*
692 * If we weren't the last ref, we're done.
693 */
694 if (ret)
695 return 1;
696
697 /*
698 * Careful, careful. The reference count went down
699 * to zero, but we don't hold the dentry lock, so
700 * somebody else could get it again, and do another
701 * dput(), and we need to not race with that.
702 *
703 * However, there is a very special and common case
704 * where we don't care, because there is nothing to
705 * do: the dentry is still hashed, it does not have
706 * a 'delete' op, and it's referenced and already on
707 * the LRU list.
708 *
709 * NOTE! Since we aren't locked, these values are
710 * not "stable". However, it is sufficient that at
711 * some point after we dropped the reference the
712 * dentry was hashed and the flags had the proper
713 * value. Other dentry users may have re-gotten
714 * a reference to the dentry and change that, but
715 * our work is done - we can leave the dentry
716 * around with a zero refcount.
717 */
718 smp_rmb();
719 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100720 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800721
722 /* Nothing to do? Dropping the reference was all we needed? */
723 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
724 return 1;
725
726 /*
727 * Not the fast normal case? Get the lock. We've already decremented
728 * the refcount, but we'll need to re-check the situation after
729 * getting the lock.
730 */
731 spin_lock(&dentry->d_lock);
732
733 /*
734 * Did somebody else grab a reference to it in the meantime, and
735 * we're no longer the last user after all? Alternatively, somebody
736 * else could have killed it and marked it dead. Either way, we
737 * don't need to do anything else.
738 */
739 if (dentry->d_lockref.count) {
740 spin_unlock(&dentry->d_lock);
741 return 1;
742 }
743
744 /*
745 * Re-get the reference we optimistically dropped. We hold the
746 * lock, and we just tested that it was zero, so we can just
747 * set it to 1.
748 */
749 dentry->d_lockref.count = 1;
750 return 0;
751}
752
753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754/*
755 * This is dput
756 *
757 * This is complicated by the fact that we do not want to put
758 * dentries that are no longer on any hash chain on the unused
759 * list: we'd much rather just get rid of them immediately.
760 *
761 * However, that implies that we have to traverse the dentry
762 * tree upwards to the parents which might _also_ now be
763 * scheduled for deletion (it may have been only waiting for
764 * its last child to go away).
765 *
766 * This tail recursion is done by hand as we don't want to depend
767 * on the compiler to always get this right (gcc generally doesn't).
768 * Real recursion would eat up our stack space.
769 */
770
771/*
772 * dput - release a dentry
773 * @dentry: dentry to release
774 *
775 * Release a dentry. This will drop the usage count and if appropriate
776 * call the dentry unlink method as well as removing it from the queues and
777 * releasing its resources. If the parent dentries were scheduled for release
778 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780void dput(struct dentry *dentry)
781{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700782 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 return;
784
785repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800786 might_sleep();
787
Linus Torvalds360f5472015-01-09 15:19:03 -0800788 rcu_read_lock();
789 if (likely(fast_dput(dentry))) {
790 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800792 }
793
794 /* Slow case: now with the dentry lock held */
795 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Al Viro85c7f812016-04-14 19:52:13 -0400797 WARN_ON(d_in_lookup(dentry));
798
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700799 /* Unreachable? Get rid of it */
800 if (unlikely(d_unhashed(dentry)))
801 goto kill_it;
802
Al Viro75a6f822015-07-08 02:42:38 +0100803 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
804 goto kill_it;
805
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700806 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100808 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 }
Nick Piggin265ac902010-10-10 05:36:24 -0400810
Christoph Hellwiga4633352010-10-10 05:36:26 -0400811 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400812
Waiman Long98474232013-08-28 18:24:59 -0700813 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100814 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 return;
816
Miklos Szeredid52b9082007-05-08 00:23:46 -0700817kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400818 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800819 if (dentry) {
820 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700821 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700824EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100827/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100828static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829{
Waiman Long98474232013-08-28 18:24:59 -0700830 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
832
Nick Piggindc0474b2011-01-07 17:49:43 +1100833static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100834{
Waiman Long98474232013-08-28 18:24:59 -0700835 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100836}
837
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100838struct dentry *dget_parent(struct dentry *dentry)
839{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700840 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100841 struct dentry *ret;
842
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700843 /*
844 * Do optimistic parent lookup without any
845 * locking.
846 */
847 rcu_read_lock();
848 ret = ACCESS_ONCE(dentry->d_parent);
849 gotref = lockref_get_not_zero(&ret->d_lockref);
850 rcu_read_unlock();
851 if (likely(gotref)) {
852 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
853 return ret;
854 dput(ret);
855 }
856
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100857repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100858 /*
859 * Don't need rcu_dereference because we re-check it was correct under
860 * the lock.
861 */
862 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100863 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100864 spin_lock(&ret->d_lock);
865 if (unlikely(ret != dentry->d_parent)) {
866 spin_unlock(&ret->d_lock);
867 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868 goto repeat;
869 }
Nick Piggina734eb42011-01-07 17:49:44 +1100870 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700871 BUG_ON(!ret->d_lockref.count);
872 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100873 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100874 return ret;
875}
876EXPORT_SYMBOL(dget_parent);
877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878/**
879 * d_find_alias - grab a hashed alias of inode
880 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 *
882 * If inode has a hashed alias, or is a directory and has any alias,
883 * acquire the reference to alias and return it. Otherwise return NULL.
884 * Notice that if inode is a directory there can be only one alias and
885 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800886 * of a filesystem, or if the directory was renamed and d_revalidate
887 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700889 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500890 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500892static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893{
Nick Pigginda502952011-01-07 17:49:33 +1100894 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Nick Pigginda502952011-01-07 17:49:33 +1100896again:
897 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400898 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100899 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700901 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100902 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500904 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100905 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100906 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 return alias;
908 }
909 }
Nick Pigginda502952011-01-07 17:49:33 +1100910 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 }
Nick Pigginda502952011-01-07 17:49:33 +1100912 if (discon_alias) {
913 alias = discon_alias;
914 spin_lock(&alias->d_lock);
915 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500916 __dget_dlock(alias);
917 spin_unlock(&alias->d_lock);
918 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100919 }
920 spin_unlock(&alias->d_lock);
921 goto again;
922 }
923 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924}
925
Nick Pigginda502952011-01-07 17:49:33 +1100926struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
David Howells214fda12006-03-25 03:06:36 -0800928 struct dentry *de = NULL;
929
Al Virob3d9b7a2012-06-09 13:51:19 -0400930 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100931 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500932 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100933 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 return de;
936}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700937EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939/*
940 * Try to kill dentries associated with this inode.
941 * WARNING: you must own a reference to inode.
942 */
943void d_prune_aliases(struct inode *inode)
944{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700945 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100947 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400948 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700950 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400951 struct dentry *parent = lock_parent(dentry);
952 if (likely(!dentry->d_lockref.count)) {
953 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800954 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400955 goto restart;
956 }
957 if (parent)
958 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 }
960 spin_unlock(&dentry->d_lock);
961 }
Nick Piggin873feea2011-01-07 17:50:06 +1100962 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700964EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400966static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967{
Al Viro5c47e6d2014-04-29 16:13:18 -0400968 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700969
Miklos Szeredi60942f22014-05-02 15:38:39 -0400970 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400971 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400972 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100973 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400974 parent = lock_parent(dentry);
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000977 * The dispose list is isolated and dentries are not accounted
978 * to the LRU here, so we can simply remove it from the list
979 * here regardless of whether it is referenced or not.
980 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400981 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000982
983 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000985 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800987 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700988 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400989 if (parent)
990 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 continue;
992 }
Nick Piggin77812a12011-01-07 17:49:48 +1100993
Al Viro64fd72e2014-05-28 09:48:44 -0400994
995 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
996 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
997 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400998 if (parent)
999 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001000 if (can_free)
1001 dentry_free(dentry);
1002 continue;
1003 }
1004
Al Viroff2fde92014-05-28 13:59:13 -04001005 inode = dentry->d_inode;
1006 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001007 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001008 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001009 if (parent)
1010 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001011 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001012 }
Al Viroff2fde92014-05-28 13:59:13 -04001013
Al Viroff2fde92014-05-28 13:59:13 -04001014 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001015
Al Viro5c47e6d2014-04-29 16:13:18 -04001016 /*
1017 * We need to prune ancestors too. This is necessary to prevent
1018 * quadratic behavior of shrink_dcache_parent(), but is also
1019 * expected to be beneficial in reducing dentry cache
1020 * fragmentation.
1021 */
1022 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001023 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1024 parent = lock_parent(dentry);
1025 if (dentry->d_lockref.count != 1) {
1026 dentry->d_lockref.count--;
1027 spin_unlock(&dentry->d_lock);
1028 if (parent)
1029 spin_unlock(&parent->d_lock);
1030 break;
1031 }
1032 inode = dentry->d_inode; /* can't be NULL */
1033 if (unlikely(!spin_trylock(&inode->i_lock))) {
1034 spin_unlock(&dentry->d_lock);
1035 if (parent)
1036 spin_unlock(&parent->d_lock);
1037 cpu_relax();
1038 continue;
1039 }
1040 __dentry_kill(dentry);
1041 dentry = parent;
1042 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001044}
1045
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001046static enum lru_status dentry_lru_isolate(struct list_head *item,
1047 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001048{
1049 struct list_head *freeable = arg;
1050 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1051
1052
1053 /*
1054 * we are inverting the lru lock/dentry->d_lock here,
1055 * so use a trylock. If we fail to get the lock, just skip
1056 * it
1057 */
1058 if (!spin_trylock(&dentry->d_lock))
1059 return LRU_SKIP;
1060
1061 /*
1062 * Referenced dentries are still in use. If they have active
1063 * counts, just remove them from the LRU. Otherwise give them
1064 * another pass through the LRU.
1065 */
1066 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001067 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001068 spin_unlock(&dentry->d_lock);
1069 return LRU_REMOVED;
1070 }
1071
1072 if (dentry->d_flags & DCACHE_REFERENCED) {
1073 dentry->d_flags &= ~DCACHE_REFERENCED;
1074 spin_unlock(&dentry->d_lock);
1075
1076 /*
1077 * The list move itself will be made by the common LRU code. At
1078 * this point, we've dropped the dentry->d_lock but keep the
1079 * lru lock. This is safe to do, since every list movement is
1080 * protected by the lru lock even if both locks are held.
1081 *
1082 * This is guaranteed by the fact that all LRU management
1083 * functions are intermediated by the LRU API calls like
1084 * list_lru_add and list_lru_del. List movement in this file
1085 * only ever occur through this functions or through callbacks
1086 * like this one, that are called from the LRU API.
1087 *
1088 * The only exceptions to this are functions like
1089 * shrink_dentry_list, and code that first checks for the
1090 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1091 * operating only with stack provided lists after they are
1092 * properly isolated from the main list. It is thus, always a
1093 * local access.
1094 */
1095 return LRU_ROTATE;
1096 }
1097
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001098 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001099 spin_unlock(&dentry->d_lock);
1100
1101 return LRU_REMOVED;
1102}
1103
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001104/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001105 * prune_dcache_sb - shrink the dcache
1106 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001107 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001108 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001109 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1110 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001111 * function.
1112 *
1113 * This function may fail to free any resources if all the dentries are in
1114 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001115 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001116long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001117{
Dave Chinnerf6041562013-08-28 10:18:00 +10001118 LIST_HEAD(dispose);
1119 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001120
Vladimir Davydov503c3582015-02-12 14:58:47 -08001121 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1122 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001123 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001124 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125}
1126
Glauber Costa4e717f52013-08-28 10:18:03 +10001127static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001128 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001129{
Glauber Costa4e717f52013-08-28 10:18:03 +10001130 struct list_head *freeable = arg;
1131 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001132
Glauber Costa4e717f52013-08-28 10:18:03 +10001133 /*
1134 * we are inverting the lru lock/dentry->d_lock here,
1135 * so use a trylock. If we fail to get the lock, just skip
1136 * it
1137 */
1138 if (!spin_trylock(&dentry->d_lock))
1139 return LRU_SKIP;
1140
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001141 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001142 spin_unlock(&dentry->d_lock);
1143
1144 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001145}
1146
Glauber Costa4e717f52013-08-28 10:18:03 +10001147
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001148/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 * shrink_dcache_sb - shrink dcache for a superblock
1150 * @sb: superblock
1151 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001152 * Shrink the dcache for the specified super block. This is used to free
1153 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001155void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156{
Glauber Costa4e717f52013-08-28 10:18:03 +10001157 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001158
Glauber Costa4e717f52013-08-28 10:18:03 +10001159 do {
1160 LIST_HEAD(dispose);
1161
1162 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001163 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001164
1165 this_cpu_sub(nr_dentry_unused, freed);
1166 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001167 cond_resched();
1168 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001170EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001173 * enum d_walk_ret - action to talke during tree walk
1174 * @D_WALK_CONTINUE: contrinue walk
1175 * @D_WALK_QUIT: quit walk
1176 * @D_WALK_NORETRY: quit when retry is needed
1177 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001179enum d_walk_ret {
1180 D_WALK_CONTINUE,
1181 D_WALK_QUIT,
1182 D_WALK_NORETRY,
1183 D_WALK_SKIP,
1184};
1185
1186/**
1187 * d_walk - walk the dentry tree
1188 * @parent: start of walk
1189 * @data: data passed to @enter() and @finish()
1190 * @enter: callback when first entering the dentry
1191 * @finish: callback when successfully finished the walk
1192 *
1193 * The @enter() and @finish() callbacks are called with d_lock held.
1194 */
1195static void d_walk(struct dentry *parent, void *data,
1196 enum d_walk_ret (*enter)(void *, struct dentry *),
1197 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198{
Nick Piggin949854d2011-01-07 17:49:37 +11001199 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001201 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001202 enum d_walk_ret ret;
1203 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001204
Nick Piggin58db63d2011-01-07 17:49:39 +11001205again:
Al Viro48f5ec22013-09-09 15:22:25 -04001206 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001207 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001208 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001209
1210 ret = enter(data, this_parent);
1211 switch (ret) {
1212 case D_WALK_CONTINUE:
1213 break;
1214 case D_WALK_QUIT:
1215 case D_WALK_SKIP:
1216 goto out_unlock;
1217 case D_WALK_NORETRY:
1218 retry = false;
1219 break;
1220 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221repeat:
1222 next = this_parent->d_subdirs.next;
1223resume:
1224 while (next != &this_parent->d_subdirs) {
1225 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001226 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001228
Al Viroba65dc52016-06-10 11:32:47 -04001229 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1230 continue;
1231
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001232 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001233
1234 ret = enter(data, dentry);
1235 switch (ret) {
1236 case D_WALK_CONTINUE:
1237 break;
1238 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001239 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001240 goto out_unlock;
1241 case D_WALK_NORETRY:
1242 retry = false;
1243 break;
1244 case D_WALK_SKIP:
1245 spin_unlock(&dentry->d_lock);
1246 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001247 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001250 spin_unlock(&this_parent->d_lock);
1251 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001253 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 goto repeat;
1255 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001256 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
1258 /*
1259 * All done at this level ... ascend and resume the search.
1260 */
Al Viroca5358e2014-10-26 19:31:10 -04001261 rcu_read_lock();
1262ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001264 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001265 this_parent = child->d_parent;
1266
Al Viro31dec132013-10-25 17:04:27 -04001267 spin_unlock(&child->d_lock);
1268 spin_lock(&this_parent->d_lock);
1269
Al Viroca5358e2014-10-26 19:31:10 -04001270 /* might go back up the wrong parent if we have had a rename. */
1271 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001272 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001273 /* go into the first sibling still alive */
1274 do {
1275 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001276 if (next == &this_parent->d_subdirs)
1277 goto ascend;
1278 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001279 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001280 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 goto resume;
1282 }
Al Viroca5358e2014-10-26 19:31:10 -04001283 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001284 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001285 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001286 if (finish)
1287 finish(data);
1288
1289out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001290 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001291 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001292 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001293
1294rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001295 spin_unlock(&this_parent->d_lock);
1296 rcu_read_unlock();
1297 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001298 if (!retry)
1299 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001300 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001301 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001303
Ian Kent01619492016-11-24 08:03:41 +11001304struct check_mount {
1305 struct vfsmount *mnt;
1306 unsigned int mounted;
1307};
1308
1309static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1310{
1311 struct check_mount *info = data;
1312 struct path path = { .mnt = info->mnt, .dentry = dentry };
1313
1314 if (likely(!d_mountpoint(dentry)))
1315 return D_WALK_CONTINUE;
1316 if (__path_is_mountpoint(&path)) {
1317 info->mounted = 1;
1318 return D_WALK_QUIT;
1319 }
1320 return D_WALK_CONTINUE;
1321}
1322
1323/**
1324 * path_has_submounts - check for mounts over a dentry in the
1325 * current namespace.
1326 * @parent: path to check.
1327 *
1328 * Return true if the parent or its subdirectories contain
1329 * a mount point in the current namespace.
1330 */
1331int path_has_submounts(const struct path *parent)
1332{
1333 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1334
1335 read_seqlock_excl(&mount_lock);
1336 d_walk(parent->dentry, &data, path_check_mount, NULL);
1337 read_sequnlock_excl(&mount_lock);
1338
1339 return data.mounted;
1340}
1341EXPORT_SYMBOL(path_has_submounts);
1342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001344 * Called by mount code to set a mountpoint and check if the mountpoint is
1345 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1346 * subtree can become unreachable).
1347 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001348 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001349 * this reason take rename_lock and d_lock on dentry and ancestors.
1350 */
1351int d_set_mounted(struct dentry *dentry)
1352{
1353 struct dentry *p;
1354 int ret = -ENOENT;
1355 write_seqlock(&rename_lock);
1356 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001357 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001358 spin_lock(&p->d_lock);
1359 if (unlikely(d_unhashed(p))) {
1360 spin_unlock(&p->d_lock);
1361 goto out;
1362 }
1363 spin_unlock(&p->d_lock);
1364 }
1365 spin_lock(&dentry->d_lock);
1366 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001367 ret = -EBUSY;
1368 if (!d_mountpoint(dentry)) {
1369 dentry->d_flags |= DCACHE_MOUNTED;
1370 ret = 0;
1371 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001372 }
1373 spin_unlock(&dentry->d_lock);
1374out:
1375 write_sequnlock(&rename_lock);
1376 return ret;
1377}
1378
1379/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001380 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 * and move any unused dentries to the end of the unused
1382 * list for prune_dcache(). We descend to the next level
1383 * whenever the d_subdirs list is non-empty and continue
1384 * searching.
1385 *
1386 * It returns zero iff there are no unused children,
1387 * otherwise it returns the number of children moved to
1388 * the end of the unused list. This may not be the total
1389 * number of unused children, because select_parent can
1390 * drop the lock and return early due to latency
1391 * constraints.
1392 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001393
1394struct select_data {
1395 struct dentry *start;
1396 struct list_head dispose;
1397 int found;
1398};
1399
1400static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001402 struct select_data *data = _data;
1403 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001405 if (data->start == dentry)
1406 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Al Virofe915222014-05-03 00:02:25 -04001408 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001409 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001410 } else {
1411 if (dentry->d_flags & DCACHE_LRU_LIST)
1412 d_lru_del(dentry);
1413 if (!dentry->d_lockref.count) {
1414 d_shrink_add(dentry, &data->dispose);
1415 data->found++;
1416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 }
1418 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001419 * We can return to the caller if we have found some (this
1420 * ensures forward progress). We'll be coming back to find
1421 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 */
Al Virofe915222014-05-03 00:02:25 -04001423 if (!list_empty(&data->dispose))
1424 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001426 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
1428
1429/**
1430 * shrink_dcache_parent - prune dcache
1431 * @parent: parent of entries to prune
1432 *
1433 * Prune the dcache to remove unused children of the parent dentry.
1434 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001435void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001437 for (;;) {
1438 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001440 INIT_LIST_HEAD(&data.dispose);
1441 data.start = parent;
1442 data.found = 0;
1443
1444 d_walk(parent, &data, select_collect, NULL);
1445 if (!data.found)
1446 break;
1447
1448 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001449 cond_resched();
1450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001452EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Al Viro9c8c10e2014-05-02 20:36:10 -04001454static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001455{
Al Viro9c8c10e2014-05-02 20:36:10 -04001456 /* it has busy descendents; complain about those instead */
1457 if (!list_empty(&dentry->d_subdirs))
1458 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001459
Al Viro9c8c10e2014-05-02 20:36:10 -04001460 /* root with refcount 1 is fine */
1461 if (dentry == _data && dentry->d_lockref.count == 1)
1462 return D_WALK_CONTINUE;
1463
1464 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1465 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001466 dentry,
1467 dentry->d_inode ?
1468 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001469 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001470 dentry->d_lockref.count,
1471 dentry->d_sb->s_type->name,
1472 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001473 WARN_ON(1);
1474 return D_WALK_CONTINUE;
1475}
1476
1477static void do_one_tree(struct dentry *dentry)
1478{
1479 shrink_dcache_parent(dentry);
1480 d_walk(dentry, dentry, umount_check, NULL);
1481 d_drop(dentry);
1482 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001483}
1484
1485/*
1486 * destroy the dentries attached to a superblock on unmounting
1487 */
1488void shrink_dcache_for_umount(struct super_block *sb)
1489{
1490 struct dentry *dentry;
1491
Al Viro9c8c10e2014-05-02 20:36:10 -04001492 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001493
1494 dentry = sb->s_root;
1495 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001496 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001497
1498 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001499 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1500 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001501 }
1502}
1503
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001504struct detach_data {
1505 struct select_data select;
1506 struct dentry *mountpoint;
1507};
1508static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001509{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001510 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001511
1512 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001513 __dget_dlock(dentry);
1514 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001515 return D_WALK_QUIT;
1516 }
1517
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001518 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001519}
1520
1521static void check_and_drop(void *_data)
1522{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001523 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001524
Al Viro81be24d2017-06-03 07:20:09 +01001525 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001526 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527}
1528
1529/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001530 * d_invalidate - detach submounts, prune dcache, and drop
1531 * @dentry: dentry to invalidate (aka detach, prune and drop)
1532 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001533 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001534 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001535 * The final d_drop is done as an atomic operation relative to
1536 * rename_lock ensuring there are no races with d_set_mounted. This
1537 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001539void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001540{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001541 /*
1542 * If it's already been dropped, return OK.
1543 */
1544 spin_lock(&dentry->d_lock);
1545 if (d_unhashed(dentry)) {
1546 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001547 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001548 }
1549 spin_unlock(&dentry->d_lock);
1550
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001551 /* Negative dentries can be dropped without further checks */
1552 if (!dentry->d_inode) {
1553 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001554 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555 }
1556
1557 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001558 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001559
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001560 data.mountpoint = NULL;
1561 INIT_LIST_HEAD(&data.select.dispose);
1562 data.select.start = dentry;
1563 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001564
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001565 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001566
Al Viro81be24d2017-06-03 07:20:09 +01001567 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001568 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001569 else if (!data.mountpoint)
1570 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001571
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001572 if (data.mountpoint) {
1573 detach_mounts(data.mountpoint);
1574 dput(data.mountpoint);
1575 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001576 cond_resched();
1577 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001578}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001579EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581/**
Al Viroa4464db2011-07-07 15:03:58 -04001582 * __d_alloc - allocate a dcache entry
1583 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 * @name: qstr of the name
1585 *
1586 * Allocates a dentry. It returns %NULL if there is insufficient memory
1587 * available. On a success the dentry is returned. The name passed in is
1588 * copied and the copy passed in may be reused after this call.
1589 */
1590
Al Viroa4464db2011-07-07 15:03:58 -04001591struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592{
1593 struct dentry *dentry;
1594 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001595 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596
Mel Gormane12ba742007-10-16 01:25:52 -07001597 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 if (!dentry)
1599 return NULL;
1600
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001601 /*
1602 * We guarantee that the inline name is always NUL-terminated.
1603 * This way the memcpy() done by the name switching in rename
1604 * will still always have a NUL at the end, even if we might
1605 * be overwriting an internal NUL character
1606 */
1607 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001608 if (unlikely(!name)) {
1609 static const struct qstr anon = QSTR_INIT("/", 1);
1610 name = &anon;
1611 dname = dentry->d_iname;
1612 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001613 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001614 struct external_name *p = kmalloc(size + name->len,
1615 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001616 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 kmem_cache_free(dentry_cache, dentry);
1618 return NULL;
1619 }
Al Viro8d85b482014-09-29 14:54:27 -04001620 atomic_set(&p->u.count, 1);
1621 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001622 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1623 kasan_unpoison_shadow(dname,
1624 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 } else {
1626 dname = dentry->d_iname;
1627 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
1629 dentry->d_name.len = name->len;
1630 dentry->d_name.hash = name->hash;
1631 memcpy(dname, name->name, name->len);
1632 dname[name->len] = 0;
1633
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001634 /* Make sure we always see the terminating NUL character */
1635 smp_wmb();
1636 dentry->d_name.name = dname;
1637
Waiman Long98474232013-08-28 18:24:59 -07001638 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001639 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001641 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001643 dentry->d_parent = dentry;
1644 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 dentry->d_op = NULL;
1646 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001647 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 INIT_LIST_HEAD(&dentry->d_lru);
1649 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001650 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1651 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001652 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Miklos Szeredi285b1022016-06-28 11:47:32 +02001654 if (dentry->d_op && dentry->d_op->d_init) {
1655 err = dentry->d_op->d_init(dentry);
1656 if (err) {
1657 if (dname_external(dentry))
1658 kfree(external_name(dentry));
1659 kmem_cache_free(dentry_cache, dentry);
1660 return NULL;
1661 }
1662 }
1663
Nick Piggin3e880fb2011-01-07 17:49:19 +11001664 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 return dentry;
1667}
Al Viroa4464db2011-07-07 15:03:58 -04001668
1669/**
1670 * d_alloc - allocate a dcache entry
1671 * @parent: parent of entry to allocate
1672 * @name: qstr of the name
1673 *
1674 * Allocates a dentry. It returns %NULL if there is insufficient memory
1675 * available. On a success the dentry is returned. The name passed in is
1676 * copied and the copy passed in may be reused after this call.
1677 */
1678struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1679{
1680 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1681 if (!dentry)
1682 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001683 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001684 spin_lock(&parent->d_lock);
1685 /*
1686 * don't need child lock because it is not subject
1687 * to concurrency here
1688 */
1689 __dget_dlock(parent);
1690 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001691 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001692 spin_unlock(&parent->d_lock);
1693
1694 return dentry;
1695}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001696EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
Al Viroba65dc52016-06-10 11:32:47 -04001698struct dentry *d_alloc_cursor(struct dentry * parent)
1699{
1700 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1701 if (dentry) {
1702 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1703 dentry->d_parent = dget(parent);
1704 }
1705 return dentry;
1706}
1707
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001708/**
1709 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1710 * @sb: the superblock
1711 * @name: qstr of the name
1712 *
1713 * For a filesystem that just pins its dentries in memory and never
1714 * performs lookups at all, return an unhashed IS_ROOT dentry.
1715 */
Nick Piggin4b936882011-01-07 17:50:07 +11001716struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1717{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001718 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001719}
1720EXPORT_SYMBOL(d_alloc_pseudo);
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1723{
1724 struct qstr q;
1725
1726 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001727 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 return d_alloc(parent, &q);
1729}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001730EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
Nick Pigginfb045ad2011-01-07 17:49:55 +11001732void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1733{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001734 WARN_ON_ONCE(dentry->d_op);
1735 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001736 DCACHE_OP_COMPARE |
1737 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001738 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001739 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001740 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001741 dentry->d_op = op;
1742 if (!op)
1743 return;
1744 if (op->d_hash)
1745 dentry->d_flags |= DCACHE_OP_HASH;
1746 if (op->d_compare)
1747 dentry->d_flags |= DCACHE_OP_COMPARE;
1748 if (op->d_revalidate)
1749 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001750 if (op->d_weak_revalidate)
1751 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001752 if (op->d_delete)
1753 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001754 if (op->d_prune)
1755 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001756 if (op->d_real)
1757 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001758
1759}
1760EXPORT_SYMBOL(d_set_d_op);
1761
David Howellsdf1a0852015-01-29 12:02:28 +00001762
1763/*
1764 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1765 * @dentry - The dentry to mark
1766 *
1767 * Mark a dentry as falling through to the lower layer (as set with
1768 * d_pin_lower()). This flag may be recorded on the medium.
1769 */
1770void d_set_fallthru(struct dentry *dentry)
1771{
1772 spin_lock(&dentry->d_lock);
1773 dentry->d_flags |= DCACHE_FALLTHRU;
1774 spin_unlock(&dentry->d_lock);
1775}
1776EXPORT_SYMBOL(d_set_fallthru);
1777
David Howellsb18825a2013-09-12 19:22:53 +01001778static unsigned d_flags_for_inode(struct inode *inode)
1779{
David Howells44bdb5e2015-01-29 12:02:29 +00001780 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001781
1782 if (!inode)
1783 return DCACHE_MISS_TYPE;
1784
1785 if (S_ISDIR(inode->i_mode)) {
1786 add_flags = DCACHE_DIRECTORY_TYPE;
1787 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1788 if (unlikely(!inode->i_op->lookup))
1789 add_flags = DCACHE_AUTODIR_TYPE;
1790 else
1791 inode->i_opflags |= IOP_LOOKUP;
1792 }
David Howells44bdb5e2015-01-29 12:02:29 +00001793 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001794 }
1795
David Howells44bdb5e2015-01-29 12:02:29 +00001796 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001797 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001798 add_flags = DCACHE_SYMLINK_TYPE;
1799 goto type_determined;
1800 }
1801 inode->i_opflags |= IOP_NOFOLLOW;
1802 }
1803
1804 if (unlikely(!S_ISREG(inode->i_mode)))
1805 add_flags = DCACHE_SPECIAL_TYPE;
1806
1807type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001808 if (unlikely(IS_AUTOMOUNT(inode)))
1809 add_flags |= DCACHE_NEED_AUTOMOUNT;
1810 return add_flags;
1811}
1812
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001813static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1814{
David Howellsb18825a2013-09-12 19:22:53 +01001815 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001816 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001817
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001818 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001819 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001820 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001821 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001822 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001823 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001824 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001825}
1826
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827/**
1828 * d_instantiate - fill in inode information for a dentry
1829 * @entry: dentry to complete
1830 * @inode: inode to attach to this dentry
1831 *
1832 * Fill in inode information in the entry.
1833 *
1834 * This turns negative dentries into productive full members
1835 * of society.
1836 *
1837 * NOTE! This assumes that the inode count has been incremented
1838 * (or otherwise set) by the caller to indicate that it is now
1839 * in use by the dcache.
1840 */
1841
1842void d_instantiate(struct dentry *entry, struct inode * inode)
1843{
Al Viro946e51f2014-10-26 19:19:16 -04001844 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001845 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001846 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001847 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001848 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001849 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001850 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001852EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
1854/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001855 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1856 * @entry: dentry to complete
1857 * @inode: inode to attach to this dentry
1858 *
1859 * Fill in inode information in the entry. If a directory alias is found, then
1860 * return an error (and drop inode). Together with d_materialise_unique() this
1861 * guarantees that a directory inode may never have more than one alias.
1862 */
1863int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1864{
Al Viro946e51f2014-10-26 19:19:16 -04001865 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001866
Al Virob9680912016-04-11 00:53:26 -04001867 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001868 spin_lock(&inode->i_lock);
1869 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1870 spin_unlock(&inode->i_lock);
1871 iput(inode);
1872 return -EBUSY;
1873 }
1874 __d_instantiate(entry, inode);
1875 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001876
1877 return 0;
1878}
1879EXPORT_SYMBOL(d_instantiate_no_diralias);
1880
Al Viroadc0e91a2012-01-08 16:49:21 -05001881struct dentry *d_make_root(struct inode *root_inode)
1882{
1883 struct dentry *res = NULL;
1884
1885 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001886 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e91a2012-01-08 16:49:21 -05001887 if (res)
1888 d_instantiate(res, root_inode);
1889 else
1890 iput(root_inode);
1891 }
1892 return res;
1893}
1894EXPORT_SYMBOL(d_make_root);
1895
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001896static struct dentry * __d_find_any_alias(struct inode *inode)
1897{
1898 struct dentry *alias;
1899
Al Virob3d9b7a2012-06-09 13:51:19 -04001900 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001901 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001902 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001903 __dget(alias);
1904 return alias;
1905}
1906
Sage Weil46f72b32012-01-10 09:04:37 -08001907/**
1908 * d_find_any_alias - find any alias for a given inode
1909 * @inode: inode to find an alias for
1910 *
1911 * If any aliases exist for the given inode, take and return a
1912 * reference for one of them. If no aliases exist, return %NULL.
1913 */
1914struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001915{
1916 struct dentry *de;
1917
1918 spin_lock(&inode->i_lock);
1919 de = __d_find_any_alias(inode);
1920 spin_unlock(&inode->i_lock);
1921 return de;
1922}
Sage Weil46f72b32012-01-10 09:04:37 -08001923EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001924
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001925static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001926{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001927 struct dentry *tmp;
1928 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001929 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001930
1931 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001932 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001933 if (IS_ERR(inode))
1934 return ERR_CAST(inode);
1935
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001936 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001937 if (res)
1938 goto out_iput;
1939
Al Viro798434b2016-03-24 20:38:43 -04001940 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001941 if (!tmp) {
1942 res = ERR_PTR(-ENOMEM);
1943 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001944 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001945
Al Virob9680912016-04-11 00:53:26 -04001946 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001947 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001948 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001949 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001950 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001951 dput(tmp);
1952 goto out_iput;
1953 }
1954
1955 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001956 add_flags = d_flags_for_inode(inode);
1957
1958 if (disconnected)
1959 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001960
Christoph Hellwig9308a612008-08-11 15:49:12 +02001961 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001962 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001963 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001964 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001965 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001966 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001967 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001968 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001969
Christoph Hellwig9308a612008-08-11 15:49:12 +02001970 return tmp;
1971
1972 out_iput:
1973 iput(inode);
1974 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001975}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001976
1977/**
1978 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1979 * @inode: inode to allocate the dentry for
1980 *
1981 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1982 * similar open by handle operations. The returned dentry may be anonymous,
1983 * or may have a full name (if the inode was already in the cache).
1984 *
1985 * When called on a directory inode, we must ensure that the inode only ever
1986 * has one dentry. If a dentry is found, that is returned instead of
1987 * allocating a new one.
1988 *
1989 * On successful return, the reference to the inode has been transferred
1990 * to the dentry. In case of an error the reference on the inode is released.
1991 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1992 * be passed in and the error will be propagated to the return value,
1993 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1994 */
1995struct dentry *d_obtain_alias(struct inode *inode)
1996{
1997 return __d_obtain_alias(inode, 1);
1998}
Benny Halevyadc48722009-02-27 14:02:59 -08001999EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002002 * d_obtain_root - find or allocate a dentry for a given inode
2003 * @inode: inode to allocate the dentry for
2004 *
2005 * Obtain an IS_ROOT dentry for the root of a filesystem.
2006 *
2007 * We must ensure that directory inodes only ever have one dentry. If a
2008 * dentry is found, that is returned instead of allocating a new one.
2009 *
2010 * On successful return, the reference to the inode has been transferred
2011 * to the dentry. In case of an error the reference on the inode is
2012 * released. A %NULL or IS_ERR inode may be passed in and will be the
2013 * error will be propagate to the return value, with a %NULL @inode
2014 * replaced by ERR_PTR(-ESTALE).
2015 */
2016struct dentry *d_obtain_root(struct inode *inode)
2017{
2018 return __d_obtain_alias(inode, 0);
2019}
2020EXPORT_SYMBOL(d_obtain_root);
2021
2022/**
Barry Naujok94035402008-05-21 16:50:46 +10002023 * d_add_ci - lookup or allocate new dentry with case-exact name
2024 * @inode: the inode case-insensitive lookup has found
2025 * @dentry: the negative dentry that was passed to the parent's lookup func
2026 * @name: the case-exact name to be associated with the returned dentry
2027 *
2028 * This is to avoid filling the dcache with case-insensitive names to the
2029 * same inode, only the actual correct case is stored in the dcache for
2030 * case-insensitive filesystems.
2031 *
2032 * For a case-insensitive lookup match and if the the case-exact dentry
2033 * already exists in in the dcache, use it and return it.
2034 *
2035 * If no entry exists with the exact case name, allocate new dentry with
2036 * the exact case, and return the spliced entry.
2037 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002038struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002039 struct qstr *name)
2040{
Al Virod9171b92016-04-15 03:33:13 -04002041 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002042
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002043 /*
2044 * First check if a dentry matching the name already exists,
2045 * if not go ahead and create it now.
2046 */
Barry Naujok94035402008-05-21 16:50:46 +10002047 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002048 if (found) {
2049 iput(inode);
2050 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002051 }
Al Virod9171b92016-04-15 03:33:13 -04002052 if (d_in_lookup(dentry)) {
2053 found = d_alloc_parallel(dentry->d_parent, name,
2054 dentry->d_wait);
2055 if (IS_ERR(found) || !d_in_lookup(found)) {
2056 iput(inode);
2057 return found;
2058 }
2059 } else {
2060 found = d_alloc(dentry->d_parent, name);
2061 if (!found) {
2062 iput(inode);
2063 return ERR_PTR(-ENOMEM);
2064 }
2065 }
2066 res = d_splice_alias(inode, found);
2067 if (res) {
2068 dput(found);
2069 return res;
2070 }
Al Viro4f522a22013-02-11 23:20:37 -05002071 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002072}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002073EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002075
Al Virod4c91a82016-06-25 23:33:49 -04002076static inline bool d_same_name(const struct dentry *dentry,
2077 const struct dentry *parent,
2078 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002079{
Al Virod4c91a82016-06-25 23:33:49 -04002080 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2081 if (dentry->d_name.len != name->len)
2082 return false;
2083 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002084 }
Al Viro6fa67e72016-07-31 16:37:25 -04002085 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002086 dentry->d_name.len, dentry->d_name.name,
2087 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002088}
2089
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002091 * __d_lookup_rcu - search for a dentry (racy, store-free)
2092 * @parent: parent dentry
2093 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002094 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002095 * Returns: dentry, or NULL
2096 *
2097 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2098 * resolution (store-free path walking) design described in
2099 * Documentation/filesystems/path-lookup.txt.
2100 *
2101 * This is not to be used outside core vfs.
2102 *
2103 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2104 * held, and rcu_read_lock held. The returned dentry must not be stored into
2105 * without taking d_lock and checking d_seq sequence count against @seq
2106 * returned here.
2107 *
Linus Torvalds15570082013-09-02 11:38:06 -07002108 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002109 * function.
2110 *
2111 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2112 * the returned dentry, so long as its parent's seqlock is checked after the
2113 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2114 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002115 *
2116 * NOTE! The caller *has* to check the resulting dentry against the sequence
2117 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002118 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002119struct dentry *__d_lookup_rcu(const struct dentry *parent,
2120 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002121 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002122{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002123 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002124 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002125 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002126 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002127 struct dentry *dentry;
2128
2129 /*
2130 * Note: There is significant duplication with __d_lookup_rcu which is
2131 * required to prevent single threaded performance regressions
2132 * especially on architectures where smp_rmb (in seqcounts) are costly.
2133 * Keep the two functions in sync.
2134 */
2135
2136 /*
2137 * The hash list is protected using RCU.
2138 *
2139 * Carefully use d_seq when comparing a candidate dentry, to avoid
2140 * races with d_move().
2141 *
2142 * It is possible that concurrent renames can mess up our list
2143 * walk here and result in missing our dentry, resulting in the
2144 * false-negative result. d_lookup() protects against concurrent
2145 * renames using rename_lock seqlock.
2146 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002147 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002148 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002149 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002150 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002151
Nick Piggin31e6b012011-01-07 17:49:52 +11002152seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002153 /*
2154 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002155 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002156 *
2157 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002158 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002159 *
2160 * NOTE! We do a "raw" seqcount_begin here. That means that
2161 * we don't wait for the sequence count to stabilize if it
2162 * is in the middle of a sequence change. If we do the slow
2163 * dentry compare, we will do seqretries until it is stable,
2164 * and if we end up with a successful lookup, we actually
2165 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002166 *
2167 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2168 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002169 */
2170 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002171 if (dentry->d_parent != parent)
2172 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002173 if (d_unhashed(dentry))
2174 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002175
2176 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002177 int tlen;
2178 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002179 if (dentry->d_name.hash != hashlen_hash(hashlen))
2180 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002181 tlen = dentry->d_name.len;
2182 tname = dentry->d_name.name;
2183 /* we want a consistent (name,len) pair */
2184 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2185 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002186 goto seqretry;
2187 }
Al Viro6fa67e72016-07-31 16:37:25 -04002188 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002189 tlen, tname, name) != 0)
2190 continue;
2191 } else {
2192 if (dentry->d_name.hash_len != hashlen)
2193 continue;
2194 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2195 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002196 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002197 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002198 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002199 }
2200 return NULL;
2201}
2202
2203/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 * d_lookup - search for a dentry
2205 * @parent: parent dentry
2206 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002207 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002209 * d_lookup searches the children of the parent dentry for the name in
2210 * question. If the dentry is found its reference count is incremented and the
2211 * dentry is returned. The caller must use dput to free the entry when it has
2212 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 */
Al Viroda2d8452013-01-24 18:29:34 -05002214struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215{
Nick Piggin31e6b012011-01-07 17:49:52 +11002216 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002217 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218
Daeseok Younb8314f92014-08-11 11:46:53 +09002219 do {
2220 seq = read_seqbegin(&rename_lock);
2221 dentry = __d_lookup(parent, name);
2222 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 break;
2224 } while (read_seqretry(&rename_lock, seq));
2225 return dentry;
2226}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002227EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228
Nick Piggin31e6b012011-01-07 17:49:52 +11002229/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002230 * __d_lookup - search for a dentry (racy)
2231 * @parent: parent dentry
2232 * @name: qstr of name we wish to find
2233 * Returns: dentry, or NULL
2234 *
2235 * __d_lookup is like d_lookup, however it may (rarely) return a
2236 * false-negative result due to unrelated rename activity.
2237 *
2238 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2239 * however it must be used carefully, eg. with a following d_lookup in
2240 * the case of failure.
2241 *
2242 * __d_lookup callers must be commented.
2243 */
Al Viroa713ca22013-01-24 18:27:00 -05002244struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002247 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002248 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002249 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002250 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Nick Pigginb04f7842010-08-18 04:37:34 +10002252 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002253 * Note: There is significant duplication with __d_lookup_rcu which is
2254 * required to prevent single threaded performance regressions
2255 * especially on architectures where smp_rmb (in seqcounts) are costly.
2256 * Keep the two functions in sync.
2257 */
2258
2259 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002260 * The hash list is protected using RCU.
2261 *
2262 * Take d_lock when comparing a candidate dentry, to avoid races
2263 * with d_move().
2264 *
2265 * It is possible that concurrent renames can mess up our list
2266 * walk here and result in missing our dentry, resulting in the
2267 * false-negative result. d_lookup() protects against concurrent
2268 * renames using rename_lock seqlock.
2269 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002270 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002271 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 rcu_read_lock();
2273
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002274 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 if (dentry->d_name.hash != hash)
2277 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
2279 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 if (dentry->d_parent != parent)
2281 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002282 if (d_unhashed(dentry))
2283 goto next;
2284
Al Virod4c91a82016-06-25 23:33:49 -04002285 if (!d_same_name(dentry, parent, name))
2286 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Waiman Long98474232013-08-28 18:24:59 -07002288 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002289 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 spin_unlock(&dentry->d_lock);
2291 break;
2292next:
2293 spin_unlock(&dentry->d_lock);
2294 }
2295 rcu_read_unlock();
2296
2297 return found;
2298}
2299
2300/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002301 * d_hash_and_lookup - hash the qstr then search for a dentry
2302 * @dir: Directory to search in
2303 * @name: qstr of name we wish to find
2304 *
Al Viro4f522a22013-02-11 23:20:37 -05002305 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002306 */
2307struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2308{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002309 /*
2310 * Check for a fs-specific hash function. Note that we must
2311 * calculate the standard hash first, as the d_op->d_hash()
2312 * routine may choose to leave the hash value unchanged.
2313 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002314 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002315 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002316 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002317 if (unlikely(err < 0))
2318 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002319 }
Al Viro4f522a22013-02-11 23:20:37 -05002320 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002321}
Al Viro4f522a22013-02-11 23:20:37 -05002322EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002323
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324/*
2325 * When a file is deleted, we have two options:
2326 * - turn this dentry into a negative dentry
2327 * - unhash this dentry and free it.
2328 *
2329 * Usually, we want to just turn this into
2330 * a negative dentry, but if anybody else is
2331 * currently using the dentry or the inode
2332 * we can't do that and we fall back on removing
2333 * it from the hash queues and waiting for
2334 * it to be deleted later when it has no users
2335 */
2336
2337/**
2338 * d_delete - delete a dentry
2339 * @dentry: The dentry to delete
2340 *
2341 * Turn the dentry into a negative dentry if possible, otherwise
2342 * remove it from the hash queues so it can be deleted later
2343 */
2344
2345void d_delete(struct dentry * dentry)
2346{
Nick Piggin873feea2011-01-07 17:50:06 +11002347 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002348 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 /*
2350 * Are we the only user?
2351 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002352again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002354 inode = dentry->d_inode;
2355 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002356 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002357 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002358 spin_unlock(&dentry->d_lock);
2359 cpu_relax();
2360 goto again;
2361 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002362 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002363 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002364 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 return;
2366 }
2367
2368 if (!d_unhashed(dentry))
2369 __d_drop(dentry);
2370
2371 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002372
2373 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002375EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376
Al Viro15d3c582016-07-29 17:45:21 -04002377static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378{
Al Viro15d3c582016-07-29 17:45:21 -04002379 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002380 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002381 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002382 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002383 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384}
2385
2386/**
2387 * d_rehash - add an entry back to the hash
2388 * @entry: dentry to add to the hash
2389 *
2390 * Adds a dentry to the hash according to its name.
2391 */
2392
2393void d_rehash(struct dentry * entry)
2394{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002396 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002399EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Al Viro84e710d2016-04-15 00:58:55 -04002401static inline unsigned start_dir_add(struct inode *dir)
2402{
2403
2404 for (;;) {
2405 unsigned n = dir->i_dir_seq;
2406 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2407 return n;
2408 cpu_relax();
2409 }
2410}
2411
2412static inline void end_dir_add(struct inode *dir, unsigned n)
2413{
2414 smp_store_release(&dir->i_dir_seq, n + 2);
2415}
2416
Al Virod9171b92016-04-15 03:33:13 -04002417static void d_wait_lookup(struct dentry *dentry)
2418{
2419 if (d_in_lookup(dentry)) {
2420 DECLARE_WAITQUEUE(wait, current);
2421 add_wait_queue(dentry->d_wait, &wait);
2422 do {
2423 set_current_state(TASK_UNINTERRUPTIBLE);
2424 spin_unlock(&dentry->d_lock);
2425 schedule();
2426 spin_lock(&dentry->d_lock);
2427 } while (d_in_lookup(dentry));
2428 }
2429}
2430
Al Viro94bdd652016-04-15 02:42:04 -04002431struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002432 const struct qstr *name,
2433 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002434{
Al Viro94bdd652016-04-15 02:42:04 -04002435 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002436 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2437 struct hlist_bl_node *node;
2438 struct dentry *new = d_alloc(parent, name);
2439 struct dentry *dentry;
2440 unsigned seq, r_seq, d_seq;
2441
2442 if (unlikely(!new))
2443 return ERR_PTR(-ENOMEM);
2444
2445retry:
2446 rcu_read_lock();
2447 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2448 r_seq = read_seqbegin(&rename_lock);
2449 dentry = __d_lookup_rcu(parent, name, &d_seq);
2450 if (unlikely(dentry)) {
2451 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2452 rcu_read_unlock();
2453 goto retry;
2454 }
2455 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2456 rcu_read_unlock();
2457 dput(dentry);
2458 goto retry;
2459 }
2460 rcu_read_unlock();
2461 dput(new);
2462 return dentry;
2463 }
2464 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2465 rcu_read_unlock();
2466 goto retry;
2467 }
2468 hlist_bl_lock(b);
2469 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2470 hlist_bl_unlock(b);
2471 rcu_read_unlock();
2472 goto retry;
2473 }
Al Viro94bdd652016-04-15 02:42:04 -04002474 /*
2475 * No changes for the parent since the beginning of d_lookup().
2476 * Since all removals from the chain happen with hlist_bl_lock(),
2477 * any potential in-lookup matches are going to stay here until
2478 * we unlock the chain. All fields are stable in everything
2479 * we encounter.
2480 */
2481 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2482 if (dentry->d_name.hash != hash)
2483 continue;
2484 if (dentry->d_parent != parent)
2485 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002486 if (!d_same_name(dentry, parent, name))
2487 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002488 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002489 /* now we can try to grab a reference */
2490 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2491 rcu_read_unlock();
2492 goto retry;
2493 }
2494
2495 rcu_read_unlock();
2496 /*
2497 * somebody is likely to be still doing lookup for it;
2498 * wait for them to finish
2499 */
Al Virod9171b92016-04-15 03:33:13 -04002500 spin_lock(&dentry->d_lock);
2501 d_wait_lookup(dentry);
2502 /*
2503 * it's not in-lookup anymore; in principle we should repeat
2504 * everything from dcache lookup, but it's likely to be what
2505 * d_lookup() would've found anyway. If it is, just return it;
2506 * otherwise we really have to repeat the whole thing.
2507 */
2508 if (unlikely(dentry->d_name.hash != hash))
2509 goto mismatch;
2510 if (unlikely(dentry->d_parent != parent))
2511 goto mismatch;
2512 if (unlikely(d_unhashed(dentry)))
2513 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002514 if (unlikely(!d_same_name(dentry, parent, name)))
2515 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002516 /* OK, it *is* a hashed match; return it */
2517 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002518 dput(new);
2519 return dentry;
2520 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002521 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002522 /* we can't take ->d_lock here; it's OK, though. */
2523 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002524 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002525 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2526 hlist_bl_unlock(b);
2527 return new;
Al Virod9171b92016-04-15 03:33:13 -04002528mismatch:
2529 spin_unlock(&dentry->d_lock);
2530 dput(dentry);
2531 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002532}
2533EXPORT_SYMBOL(d_alloc_parallel);
2534
Al Viro85c7f812016-04-14 19:52:13 -04002535void __d_lookup_done(struct dentry *dentry)
2536{
Al Viro94bdd652016-04-15 02:42:04 -04002537 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2538 dentry->d_name.hash);
2539 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002540 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002541 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002542 wake_up_all(dentry->d_wait);
2543 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002544 hlist_bl_unlock(b);
2545 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002546 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002547}
2548EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002549
2550/* inode->i_lock held if inode is non-NULL */
2551
2552static inline void __d_add(struct dentry *dentry, struct inode *inode)
2553{
Al Viro84e710d2016-04-15 00:58:55 -04002554 struct inode *dir = NULL;
2555 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002556 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002557 if (unlikely(d_in_lookup(dentry))) {
2558 dir = dentry->d_parent->d_inode;
2559 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002560 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002561 }
Al Viroed782b52016-03-09 19:52:39 -05002562 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002563 unsigned add_flags = d_flags_for_inode(inode);
2564 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2565 raw_write_seqcount_begin(&dentry->d_seq);
2566 __d_set_inode_and_type(dentry, inode, add_flags);
2567 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002568 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002569 }
Al Viro15d3c582016-07-29 17:45:21 -04002570 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002571 if (dir)
2572 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002573 spin_unlock(&dentry->d_lock);
2574 if (inode)
2575 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002576}
2577
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002578/**
Al Viro34d0d192016-03-08 21:01:03 -05002579 * d_add - add dentry to hash queues
2580 * @entry: dentry to add
2581 * @inode: The inode to attach to this dentry
2582 *
2583 * This adds the entry to the hash queues and initializes @inode.
2584 * The entry was actually filled in earlier during d_alloc().
2585 */
2586
2587void d_add(struct dentry *entry, struct inode *inode)
2588{
Al Virob9680912016-04-11 00:53:26 -04002589 if (inode) {
2590 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002591 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002592 }
Al Viroed782b52016-03-09 19:52:39 -05002593 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002594}
2595EXPORT_SYMBOL(d_add);
2596
2597/**
Al Viro668d0cd2016-03-08 12:44:17 -05002598 * d_exact_alias - find and hash an exact unhashed alias
2599 * @entry: dentry to add
2600 * @inode: The inode to go with this dentry
2601 *
2602 * If an unhashed dentry with the same name/parent and desired
2603 * inode already exists, hash and return it. Otherwise, return
2604 * NULL.
2605 *
2606 * Parent directory should be locked.
2607 */
2608struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2609{
2610 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002611 unsigned int hash = entry->d_name.hash;
2612
2613 spin_lock(&inode->i_lock);
2614 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2615 /*
2616 * Don't need alias->d_lock here, because aliases with
2617 * d_parent == entry->d_parent are not subject to name or
2618 * parent changes, because the parent inode i_mutex is held.
2619 */
2620 if (alias->d_name.hash != hash)
2621 continue;
2622 if (alias->d_parent != entry->d_parent)
2623 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002624 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002625 continue;
2626 spin_lock(&alias->d_lock);
2627 if (!d_unhashed(alias)) {
2628 spin_unlock(&alias->d_lock);
2629 alias = NULL;
2630 } else {
2631 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002632 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002633 spin_unlock(&alias->d_lock);
2634 }
2635 spin_unlock(&inode->i_lock);
2636 return alias;
2637 }
2638 spin_unlock(&inode->i_lock);
2639 return NULL;
2640}
2641EXPORT_SYMBOL(d_exact_alias);
2642
2643/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002644 * dentry_update_name_case - update case insensitive dentry with a new name
2645 * @dentry: dentry to be updated
2646 * @name: new name
2647 *
2648 * Update a case insensitive dentry with new case of name.
2649 *
2650 * dentry must have been returned by d_lookup with name @name. Old and new
2651 * name lengths must match (ie. no d_compare which allows mismatched name
2652 * lengths).
2653 *
2654 * Parent inode i_mutex must be held over d_lookup and into this call (to
2655 * keep renames and concurrent inserts, and readdir(2) away).
2656 */
Al Viro9aba36d2016-07-20 22:28:45 -04002657void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002658{
Al Viro59551022016-01-22 15:40:57 -05002659 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002660 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2661
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002662 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002663 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002664 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002665 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002666 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002667}
2668EXPORT_SYMBOL(dentry_update_name_case);
2669
Al Viro8d85b482014-09-29 14:54:27 -04002670static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671{
Al Viro8d85b482014-09-29 14:54:27 -04002672 if (unlikely(dname_external(target))) {
2673 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674 /*
2675 * Both external: swap the pointers
2676 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002677 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 } else {
2679 /*
2680 * dentry:internal, target:external. Steal target's
2681 * storage and make target internal.
2682 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002683 memcpy(target->d_iname, dentry->d_name.name,
2684 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 dentry->d_name.name = target->d_name.name;
2686 target->d_name.name = target->d_iname;
2687 }
2688 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002689 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 /*
2691 * dentry:external, target:internal. Give dentry's
2692 * storage to target and make dentry internal
2693 */
2694 memcpy(dentry->d_iname, target->d_name.name,
2695 target->d_name.len + 1);
2696 target->d_name.name = dentry->d_name.name;
2697 dentry->d_name.name = dentry->d_iname;
2698 } else {
2699 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002700 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002702 unsigned int i;
2703 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002704 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2705 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002706 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2707 swap(((long *) &dentry->d_iname)[i],
2708 ((long *) &target->d_iname)[i]);
2709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 }
2711 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002712 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713}
2714
Al Viro8d85b482014-09-29 14:54:27 -04002715static void copy_name(struct dentry *dentry, struct dentry *target)
2716{
2717 struct external_name *old_name = NULL;
2718 if (unlikely(dname_external(dentry)))
2719 old_name = external_name(dentry);
2720 if (unlikely(dname_external(target))) {
2721 atomic_inc(&external_name(target)->u.count);
2722 dentry->d_name = target->d_name;
2723 } else {
2724 memcpy(dentry->d_iname, target->d_name.name,
2725 target->d_name.len + 1);
2726 dentry->d_name.name = dentry->d_iname;
2727 dentry->d_name.hash_len = target->d_name.hash_len;
2728 }
2729 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2730 kfree_rcu(old_name, u.head);
2731}
2732
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002733static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2734{
2735 /*
2736 * XXXX: do we really need to take target->d_lock?
2737 */
2738 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2739 spin_lock(&target->d_parent->d_lock);
2740 else {
2741 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2742 spin_lock(&dentry->d_parent->d_lock);
2743 spin_lock_nested(&target->d_parent->d_lock,
2744 DENTRY_D_LOCK_NESTED);
2745 } else {
2746 spin_lock(&target->d_parent->d_lock);
2747 spin_lock_nested(&dentry->d_parent->d_lock,
2748 DENTRY_D_LOCK_NESTED);
2749 }
2750 }
2751 if (target < dentry) {
2752 spin_lock_nested(&target->d_lock, 2);
2753 spin_lock_nested(&dentry->d_lock, 3);
2754 } else {
2755 spin_lock_nested(&dentry->d_lock, 2);
2756 spin_lock_nested(&target->d_lock, 3);
2757 }
2758}
2759
Al Viro986c0192014-09-26 23:11:15 -04002760static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002761{
2762 if (target->d_parent != dentry->d_parent)
2763 spin_unlock(&dentry->d_parent->d_lock);
2764 if (target->d_parent != target)
2765 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002766 spin_unlock(&target->d_lock);
2767 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002768}
2769
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002771 * When switching names, the actual string doesn't strictly have to
2772 * be preserved in the target - because we're dropping the target
2773 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002774 * the new name before we switch, unless we are going to rehash
2775 * it. Note that if we *do* unhash the target, we are not allowed
2776 * to rehash it without giving it a new name/hash key - whether
2777 * we swap or overwrite the names here, resulting name won't match
2778 * the reality in filesystem; it's only there for d_path() purposes.
2779 * Note that all of this is happening under rename_lock, so the
2780 * any hash lookup seeing it in the middle of manipulations will
2781 * be discarded anyway. So we do not care what happens to the hash
2782 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002784/*
Al Viro18367502011-07-12 21:42:24 -04002785 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786 * @dentry: entry to move
2787 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002788 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 *
2790 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002791 * dcache entries should not be moved in this way. Caller must hold
2792 * rename_lock, the i_mutex of the source and target directories,
2793 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002795static void __d_move(struct dentry *dentry, struct dentry *target,
2796 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797{
Al Viro84e710d2016-04-15 00:58:55 -04002798 struct inode *dir = NULL;
2799 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 if (!dentry->d_inode)
2801 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2802
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002803 BUG_ON(d_ancestor(dentry, target));
2804 BUG_ON(d_ancestor(target, dentry));
2805
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002806 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002807 if (unlikely(d_in_lookup(target))) {
2808 dir = target->d_parent->d_inode;
2809 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002810 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812
Nick Piggin31e6b012011-01-07 17:49:52 +11002813 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002814 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002815
Al Viro15d3c582016-07-29 17:45:21 -04002816 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002817 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002818 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 __d_drop(target);
2820
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002822 if (exchange)
2823 swap_names(dentry, target);
2824 else
2825 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826
Al Viro15d3c582016-07-29 17:45:21 -04002827 /* rehash in new place(s) */
2828 __d_rehash(dentry);
2829 if (exchange)
2830 __d_rehash(target);
2831
Al Viro63cf4272014-09-26 23:06:14 -04002832 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002834 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002835 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 dentry->d_parent = target->d_parent;
2837 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002838 list_del_init(&target->d_child);
2839 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002841 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002842 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002843 list_move(&target->d_child, &target->d_parent->d_subdirs);
2844 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002845 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002846 fsnotify_update_flags(target);
2847 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848 }
2849
Nick Piggin31e6b012011-01-07 17:49:52 +11002850 write_seqcount_end(&target->d_seq);
2851 write_seqcount_end(&dentry->d_seq);
2852
Al Viro84e710d2016-04-15 00:58:55 -04002853 if (dir)
2854 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002855 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002856}
2857
2858/*
2859 * d_move - move a dentry
2860 * @dentry: entry to move
2861 * @target: new dentry
2862 *
2863 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002864 * dcache entries should not be moved in this way. See the locking
2865 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002866 */
2867void d_move(struct dentry *dentry, struct dentry *target)
2868{
2869 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002870 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002872}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002873EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874
Miklos Szeredida1ce062014-04-01 17:08:43 +02002875/*
2876 * d_exchange - exchange two dentries
2877 * @dentry1: first dentry
2878 * @dentry2: second dentry
2879 */
2880void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2881{
2882 write_seqlock(&rename_lock);
2883
2884 WARN_ON(!dentry1->d_inode);
2885 WARN_ON(!dentry2->d_inode);
2886 WARN_ON(IS_ROOT(dentry1));
2887 WARN_ON(IS_ROOT(dentry2));
2888
2889 __d_move(dentry1, dentry2, true);
2890
2891 write_sequnlock(&rename_lock);
2892}
2893
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002894/**
2895 * d_ancestor - search for an ancestor
2896 * @p1: ancestor dentry
2897 * @p2: child dentry
2898 *
2899 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2900 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002901 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002902struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002903{
2904 struct dentry *p;
2905
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002906 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002907 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002908 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002909 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002910 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002911}
2912
2913/*
2914 * This helper attempts to cope with remotely renamed directories
2915 *
2916 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002917 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002918 *
2919 * Note: If ever the locking in lock_rename() changes, then please
2920 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002921 */
Al Virob5ae6b12014-10-12 22:16:02 -04002922static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002923 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002924{
Al Viro9902af72016-04-15 15:08:36 -04002925 struct mutex *m1 = NULL;
2926 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002927 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002928
2929 /* If alias and dentry share a parent, then no extra locks required */
2930 if (alias->d_parent == dentry->d_parent)
2931 goto out_unalias;
2932
Trond Myklebust9eaef272006-10-21 10:24:20 -07002933 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002934 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2935 goto out_err;
2936 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002937 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002938 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002939 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002940out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002941 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002942 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002943out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002944 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002945 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002946 if (m1)
2947 mutex_unlock(m1);
2948 return ret;
2949}
2950
David Howells770bfad2006-08-22 20:06:07 -04002951/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002952 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2953 * @inode: the inode which may have a disconnected dentry
2954 * @dentry: a negative dentry which we want to point to the inode.
2955 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002956 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2957 * place of the given dentry and return it, else simply d_add the inode
2958 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002959 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002960 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2961 * we should error out: directories can't have multiple aliases.
2962 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002963 * This is needed in the lookup routine of any filesystem that is exportable
2964 * (via knfsd) so that we can build dcache paths to directories effectively.
2965 *
2966 * If a dentry was found and moved, then it is returned. Otherwise NULL
2967 * is returned. This matches the expected return value of ->lookup.
2968 *
2969 * Cluster filesystems may call this function with a negative, hashed dentry.
2970 * In that case, we know that the inode will be a regular file, and also this
2971 * will only occur during atomic_open. So we need to check for the dentry
2972 * being already hashed only in the final case.
2973 */
2974struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2975{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002976 if (IS_ERR(inode))
2977 return ERR_CAST(inode);
2978
David Howells770bfad2006-08-22 20:06:07 -04002979 BUG_ON(!d_unhashed(dentry));
2980
Al Virode689f52016-03-09 18:05:42 -05002981 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002982 goto out;
Al Virode689f52016-03-09 18:05:42 -05002983
Al Virob9680912016-04-11 00:53:26 -04002984 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002985 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002986 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002987 struct dentry *new = __d_find_any_alias(inode);
2988 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002989 /* The reference to new ensures it remains an alias */
2990 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002991 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002992 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002993 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002994 dput(new);
2995 new = ERR_PTR(-ELOOP);
2996 pr_warn_ratelimited(
2997 "VFS: Lookup of '%s' in %s %s"
2998 " would have caused loop\n",
2999 dentry->d_name.name,
3000 inode->i_sb->s_type->name,
3001 inode->i_sb->s_id);
3002 } else if (!IS_ROOT(new)) {
3003 int err = __d_unalias(inode, dentry, new);
3004 write_sequnlock(&rename_lock);
3005 if (err) {
3006 dput(new);
3007 new = ERR_PTR(err);
3008 }
Al Viro18367502011-07-12 21:42:24 -04003009 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003010 __d_move(new, dentry, false);
3011 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003012 }
Al Virob5ae6b12014-10-12 22:16:02 -04003013 iput(inode);
3014 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003015 }
David Howells770bfad2006-08-22 20:06:07 -04003016 }
Al Virob5ae6b12014-10-12 22:16:02 -04003017out:
Al Viroed782b52016-03-09 19:52:39 -05003018 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003019 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003020}
Al Virob5ae6b12014-10-12 22:16:02 -04003021EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003022
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003023static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003024{
3025 *buflen -= namelen;
3026 if (*buflen < 0)
3027 return -ENAMETOOLONG;
3028 *buffer -= namelen;
3029 memcpy(*buffer, str, namelen);
3030 return 0;
3031}
3032
Waiman Long232d2d62013-09-09 12:18:13 -04003033/**
3034 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003035 * @buffer: buffer pointer
3036 * @buflen: allocated length of the buffer
3037 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003038 *
3039 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3040 * make sure that either the old or the new name pointer and length are
3041 * fetched. However, there may be mismatch between length and pointer.
3042 * The length cannot be trusted, we need to copy it byte-by-byte until
3043 * the length is reached or a null byte is found. It also prepends "/" at
3044 * the beginning of the name. The sequence number check at the caller will
3045 * retry it again when a d_move() does happen. So any garbage in the buffer
3046 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003047 *
3048 * Data dependency barrier is needed to make sure that we see that terminating
3049 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003050 */
Al Viro9aba36d2016-07-20 22:28:45 -04003051static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003052{
Waiman Long232d2d62013-09-09 12:18:13 -04003053 const char *dname = ACCESS_ONCE(name->name);
3054 u32 dlen = ACCESS_ONCE(name->len);
3055 char *p;
3056
Al Viro6d13f692014-09-29 14:46:30 -04003057 smp_read_barrier_depends();
3058
Waiman Long232d2d62013-09-09 12:18:13 -04003059 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003060 if (*buflen < 0)
3061 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003062 p = *buffer -= dlen + 1;
3063 *p++ = '/';
3064 while (dlen--) {
3065 char c = *dname++;
3066 if (!c)
3067 break;
3068 *p++ = c;
3069 }
3070 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003071}
3072
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003074 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003075 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003076 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003077 * @buffer: pointer to the end of the buffer
3078 * @buflen: pointer to buffer length
3079 *
Waiman Long18129972013-09-12 10:55:35 -04003080 * The function will first try to write out the pathname without taking any
3081 * lock other than the RCU read lock to make sure that dentries won't go away.
3082 * It only checks the sequence number of the global rename_lock as any change
3083 * in the dentry's d_seq will be preceded by changes in the rename_lock
3084 * sequence number. If the sequence number had been changed, it will restart
3085 * the whole pathname back-tracing sequence again by taking the rename_lock.
3086 * In this case, there is no need to take the RCU read lock as the recursive
3087 * parent pointer references will keep the dentry chain alive as long as no
3088 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003089 */
Al Viro02125a82011-12-05 08:43:34 -05003090static int prepend_path(const struct path *path,
3091 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003092 char **buffer, int *buflen)
3093{
Al Viroede4ceb2013-11-13 07:45:40 -05003094 struct dentry *dentry;
3095 struct vfsmount *vfsmnt;
3096 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003097 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003098 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003099 char *bptr;
3100 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003101
Al Viro48f5ec22013-09-09 15:22:25 -04003102 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003103restart_mnt:
3104 read_seqbegin_or_lock(&mount_lock, &m_seq);
3105 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003106 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003107restart:
3108 bptr = *buffer;
3109 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003110 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003111 dentry = path->dentry;
3112 vfsmnt = path->mnt;
3113 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003114 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003115 while (dentry != root->dentry || vfsmnt != root->mnt) {
3116 struct dentry * parent;
3117
3118 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003119 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003120 /* Escaped? */
3121 if (dentry != vfsmnt->mnt_root) {
3122 bptr = *buffer;
3123 blen = *buflen;
3124 error = 3;
3125 break;
3126 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003127 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003128 if (mnt != parent) {
3129 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3130 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003131 vfsmnt = &mnt->mnt;
3132 continue;
3133 }
Waiman Long232d2d62013-09-09 12:18:13 -04003134 if (!error)
3135 error = is_mounted(vfsmnt) ? 1 : 2;
3136 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003137 }
3138 parent = dentry->d_parent;
3139 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003140 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003141 if (error)
3142 break;
3143
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003144 dentry = parent;
3145 }
Al Viro48f5ec22013-09-09 15:22:25 -04003146 if (!(seq & 1))
3147 rcu_read_unlock();
3148 if (need_seqretry(&rename_lock, seq)) {
3149 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003150 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003151 }
Al Viro48f5ec22013-09-09 15:22:25 -04003152 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003153
3154 if (!(m_seq & 1))
3155 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003156 if (need_seqretry(&mount_lock, m_seq)) {
3157 m_seq = 1;
3158 goto restart_mnt;
3159 }
3160 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003161
Waiman Long232d2d62013-09-09 12:18:13 -04003162 if (error >= 0 && bptr == *buffer) {
3163 if (--blen < 0)
3164 error = -ENAMETOOLONG;
3165 else
3166 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003167 }
Waiman Long232d2d62013-09-09 12:18:13 -04003168 *buffer = bptr;
3169 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003170 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003171}
3172
3173/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003174 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003175 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003176 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003177 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178 * @buflen: buffer length
3179 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003180 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003181 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003182 * Returns a pointer into the buffer or an error code if the
3183 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003184 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003185 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003186 *
Al Viro02125a82011-12-05 08:43:34 -05003187 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188 */
Al Viro02125a82011-12-05 08:43:34 -05003189char *__d_path(const struct path *path,
3190 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003191 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003193 char *res = buf + buflen;
3194 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003196 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003197 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003198
Al Viro02125a82011-12-05 08:43:34 -05003199 if (error < 0)
3200 return ERR_PTR(error);
3201 if (error > 0)
3202 return NULL;
3203 return res;
3204}
3205
3206char *d_absolute_path(const struct path *path,
3207 char *buf, int buflen)
3208{
3209 struct path root = {};
3210 char *res = buf + buflen;
3211 int error;
3212
3213 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003214 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003215
3216 if (error > 1)
3217 error = -EINVAL;
3218 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003219 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003220 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221}
3222
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003223/*
3224 * same as __d_path but appends "(deleted)" for unlinked files.
3225 */
Al Viro02125a82011-12-05 08:43:34 -05003226static int path_with_deleted(const struct path *path,
3227 const struct path *root,
3228 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003229{
3230 prepend(buf, buflen, "\0", 1);
3231 if (d_unlinked(path->dentry)) {
3232 int error = prepend(buf, buflen, " (deleted)", 10);
3233 if (error)
3234 return error;
3235 }
3236
3237 return prepend_path(path, root, buf, buflen);
3238}
3239
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003240static int prepend_unreachable(char **buffer, int *buflen)
3241{
3242 return prepend(buffer, buflen, "(unreachable)", 13);
3243}
3244
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003245static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3246{
3247 unsigned seq;
3248
3249 do {
3250 seq = read_seqcount_begin(&fs->seq);
3251 *root = fs->root;
3252 } while (read_seqcount_retry(&fs->seq, seq));
3253}
3254
Jan Bluncka03a8a702008-02-14 19:38:32 -08003255/**
3256 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003257 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003258 * @buf: buffer to return value in
3259 * @buflen: buffer length
3260 *
3261 * Convert a dentry into an ASCII path name. If the entry has been deleted
3262 * the string " (deleted)" is appended. Note that this is ambiguous.
3263 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003264 * Returns a pointer into the buffer or an error code if the path was
3265 * too long. Note: Callers should use the returned pointer, not the passed
3266 * in buffer, to use the name! The implementation often starts at an offset
3267 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003268 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003269 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003270 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003271char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003272{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003273 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003274 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003275 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003277 /*
3278 * We have various synthetic filesystems that never get mounted. On
3279 * these filesystems dentries are never used for lookup purposes, and
3280 * thus don't need to be hashed. They also don't need a name until a
3281 * user wants to identify the object in /proc/pid/fd/. The little hack
3282 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003283 *
3284 * Some pseudo inodes are mountable. When they are mounted
3285 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3286 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003287 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003288 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3289 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003290 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003291
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003292 rcu_read_lock();
3293 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003294 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003295 rcu_read_unlock();
3296
Al Viro02125a82011-12-05 08:43:34 -05003297 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003298 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299 return res;
3300}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003301EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302
3303/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003304 * Helper function for dentry_operations.d_dname() members
3305 */
3306char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3307 const char *fmt, ...)
3308{
3309 va_list args;
3310 char temp[64];
3311 int sz;
3312
3313 va_start(args, fmt);
3314 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3315 va_end(args);
3316
3317 if (sz > sizeof(temp) || sz > buflen)
3318 return ERR_PTR(-ENAMETOOLONG);
3319
3320 buffer += buflen - sz;
3321 return memcpy(buffer, temp, sz);
3322}
3323
Al Viro118b2302013-08-24 12:08:17 -04003324char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3325{
3326 char *end = buffer + buflen;
3327 /* these dentries are never renamed, so d_lock is not needed */
3328 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003329 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003330 prepend(&end, &buflen, "/", 1))
3331 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003332 return end;
Al Viro118b2302013-08-24 12:08:17 -04003333}
David Herrmann31bbe162014-01-03 14:09:47 +01003334EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003335
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003336/*
Ram Pai6092d042008-03-27 13:06:20 +01003337 * Write full pathname from the root of the filesystem into the buffer.
3338 */
Al Virof6500802014-01-26 12:37:55 -05003339static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003340{
Al Virof6500802014-01-26 12:37:55 -05003341 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003342 char *end, *retval;
3343 int len, seq = 0;
3344 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003345
Al Virof6500802014-01-26 12:37:55 -05003346 if (buflen < 2)
3347 goto Elong;
3348
Al Viro48f5ec22013-09-09 15:22:25 -04003349 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003350restart:
Al Virof6500802014-01-26 12:37:55 -05003351 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003352 end = buf + buflen;
3353 len = buflen;
3354 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003355 /* Get '/' right */
3356 retval = end-1;
3357 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003358 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003359 while (!IS_ROOT(dentry)) {
3360 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003361
Ram Pai6092d042008-03-27 13:06:20 +01003362 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003363 error = prepend_name(&end, &len, &dentry->d_name);
3364 if (error)
3365 break;
Ram Pai6092d042008-03-27 13:06:20 +01003366
3367 retval = end;
3368 dentry = parent;
3369 }
Al Viro48f5ec22013-09-09 15:22:25 -04003370 if (!(seq & 1))
3371 rcu_read_unlock();
3372 if (need_seqretry(&rename_lock, seq)) {
3373 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003374 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003375 }
3376 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003377 if (error)
3378 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003379 return retval;
3380Elong:
3381 return ERR_PTR(-ENAMETOOLONG);
3382}
Nick Pigginec2447c2011-01-07 17:49:29 +11003383
3384char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3385{
Waiman Long232d2d62013-09-09 12:18:13 -04003386 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003387}
3388EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003389
3390char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3391{
3392 char *p = NULL;
3393 char *retval;
3394
Al Viroc1031352010-06-06 22:31:14 -04003395 if (d_unlinked(dentry)) {
3396 p = buf + buflen;
3397 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3398 goto Elong;
3399 buflen++;
3400 }
3401 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003402 if (!IS_ERR(retval) && p)
3403 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003404 return retval;
3405Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003406 return ERR_PTR(-ENAMETOOLONG);
3407}
3408
Linus Torvalds8b19e342013-09-12 10:35:47 -07003409static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3410 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003411{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003412 unsigned seq;
3413
3414 do {
3415 seq = read_seqcount_begin(&fs->seq);
3416 *root = fs->root;
3417 *pwd = fs->pwd;
3418 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003419}
3420
Ram Pai6092d042008-03-27 13:06:20 +01003421/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003422 * NOTE! The user-level library version returns a
3423 * character pointer. The kernel system call just
3424 * returns the length of the buffer filled (which
3425 * includes the ending '\0' character), or a negative
3426 * error value. So libc would do something like
3427 *
3428 * char *getcwd(char * buf, size_t size)
3429 * {
3430 * int retval;
3431 *
3432 * retval = sys_getcwd(buf, size);
3433 * if (retval >= 0)
3434 * return buf;
3435 * errno = -retval;
3436 * return NULL;
3437 * }
3438 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003439SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003440{
Linus Torvalds552ce542007-02-13 12:08:18 -08003441 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003442 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003443 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003444
3445 if (!page)
3446 return -ENOMEM;
3447
Linus Torvalds8b19e342013-09-12 10:35:47 -07003448 rcu_read_lock();
3449 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450
Linus Torvalds552ce542007-02-13 12:08:18 -08003451 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003452 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003453 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003454 char *cwd = page + PATH_MAX;
3455 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003457 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003458 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003459 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003460
Al Viro02125a82011-12-05 08:43:34 -05003461 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003462 goto out;
3463
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003464 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003465 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003466 error = prepend_unreachable(&cwd, &buflen);
3467 if (error)
3468 goto out;
3469 }
3470
Linus Torvalds552ce542007-02-13 12:08:18 -08003471 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003472 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003473 if (len <= size) {
3474 error = len;
3475 if (copy_to_user(buf, cwd, len))
3476 error = -EFAULT;
3477 }
Nick Piggin949854d2011-01-07 17:49:37 +11003478 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003479 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003480 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481
3482out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003483 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003484 return error;
3485}
3486
3487/*
3488 * Test whether new_dentry is a subdirectory of old_dentry.
3489 *
3490 * Trivially implemented using the dcache structure
3491 */
3492
3493/**
3494 * is_subdir - is new dentry a subdirectory of old_dentry
3495 * @new_dentry: new dentry
3496 * @old_dentry: old dentry
3497 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003498 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3499 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3501 */
3502
Yaowei Baia6e57872015-11-17 14:40:11 +08003503bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003504{
Yaowei Baia6e57872015-11-17 14:40:11 +08003505 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003506 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003508 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003509 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003510
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003511 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003514 /*
3515 * Need rcu_readlock to protect against the d_parent trashing
3516 * due to d_move
3517 */
3518 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003519 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003520 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003521 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003522 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003523 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003524 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525
3526 return result;
3527}
3528
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003529static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003531 struct dentry *root = data;
3532 if (dentry != root) {
3533 if (d_unhashed(dentry) || !dentry->d_inode)
3534 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003536 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3537 dentry->d_flags |= DCACHE_GENOCIDE;
3538 dentry->d_lockref.count--;
3539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003541 return D_WALK_CONTINUE;
3542}
Nick Piggin58db63d2011-01-07 17:49:39 +11003543
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003544void d_genocide(struct dentry *parent)
3545{
3546 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547}
3548
Al Viro60545d02013-06-07 01:20:27 -04003549void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550{
Al Viro60545d02013-06-07 01:20:27 -04003551 inode_dec_link_count(inode);
3552 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003553 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003554 !d_unlinked(dentry));
3555 spin_lock(&dentry->d_parent->d_lock);
3556 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3557 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3558 (unsigned long long)inode->i_ino);
3559 spin_unlock(&dentry->d_lock);
3560 spin_unlock(&dentry->d_parent->d_lock);
3561 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562}
Al Viro60545d02013-06-07 01:20:27 -04003563EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564
3565static __initdata unsigned long dhash_entries;
3566static int __init set_dhash_entries(char *str)
3567{
3568 if (!str)
3569 return 0;
3570 dhash_entries = simple_strtoul(str, &str, 0);
3571 return 1;
3572}
3573__setup("dhash_entries=", set_dhash_entries);
3574
3575static void __init dcache_init_early(void)
3576{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577 /* If hashes are distributed across NUMA nodes, defer
3578 * hash allocation until vmalloc space is available.
3579 */
3580 if (hashdist)
3581 return;
3582
3583 dentry_hashtable =
3584 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003585 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586 dhash_entries,
3587 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003588 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 &d_hash_shift,
3590 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003591 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003592 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593}
3594
Denis Cheng74bf17c2007-10-16 23:26:30 -07003595static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003596{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003597 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 * A constructor could be added for stable state like the lists,
3599 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003600 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003602 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003603 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604
3605 /* Hash may have been set up in dcache_init_early */
3606 if (!hashdist)
3607 return;
3608
3609 dentry_hashtable =
3610 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003611 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612 dhash_entries,
3613 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003614 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615 &d_hash_shift,
3616 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003617 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003618 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619}
3620
3621/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003622struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003623EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624
Linus Torvalds1da177e2005-04-16 15:20:36 -07003625EXPORT_SYMBOL(d_genocide);
3626
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627void __init vfs_caches_init_early(void)
3628{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003629 int i;
3630
3631 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3632 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3633
Linus Torvalds1da177e2005-04-16 15:20:36 -07003634 dcache_init_early();
3635 inode_init_early();
3636}
3637
Mel Gorman4248b0d2015-08-06 15:46:20 -07003638void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003641 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642
Denis Cheng74bf17c2007-10-16 23:26:30 -07003643 dcache_init();
3644 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003645 files_init();
3646 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003647 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648 bdev_cache_init();
3649 chrdev_init();
3650}