blob: 95efb7b2bf841fe3d3f6aff9bf9759a937a1ddd5 [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
David Howellscdf01222017-07-04 17:25:22 +010093const struct qstr empty_name = QSTR_INIT("", 0);
94EXPORT_SYMBOL(empty_name);
95const struct qstr slash_name = QSTR_INIT("/", 1);
96EXPORT_SYMBOL(slash_name);
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098/*
99 * This is the single most critical data structure when it comes
100 * to the dcache: the hashtable for lookups. Somebody should try
101 * to make this good - I've just made it work.
102 *
103 * This hash-function tries to avoid losing too many bits of hash
104 * information, yet avoid using a prime hash-size or similar.
105 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800107static unsigned int d_hash_mask __read_mostly;
108static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700110static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111
Linus Torvalds8387ff22016-06-10 07:51:30 -0700112static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100113{
George Spelvin703b5fa2016-06-10 00:22:12 -0400114 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100115}
116
Al Viro94bdd652016-04-15 02:42:04 -0400117#define IN_LOOKUP_SHIFT 10
118static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
119
120static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
121 unsigned int hash)
122{
123 hash += (unsigned long) parent / L1_CACHE_BYTES;
124 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
125}
126
127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128/* Statistics gathering. */
129struct dentry_stat_t dentry_stat = {
130 .age_limit = 45,
131};
132
Glauber Costa3942c072013-08-28 10:17:53 +1000133static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000134static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400135
136#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000137
138/*
139 * Here we resort to our own counters instead of using generic per-cpu counters
140 * for consistency with what the vfs inode code does. We are expected to harvest
141 * better code and performance by having our own specialized counters.
142 *
143 * Please note that the loop is done over all possible CPUs, not over all online
144 * CPUs. The reason for this is that we don't want to play games with CPUs going
145 * on and off. If one of them goes off, we will just keep their counters.
146 *
147 * glommer: See cffbc8a for details, and if you ever intend to change this,
148 * please update all vfs counters to match.
149 */
Glauber Costa3942c072013-08-28 10:17:53 +1000150static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100151{
152 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000153 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100154 for_each_possible_cpu(i)
155 sum += per_cpu(nr_dentry, i);
156 return sum < 0 ? 0 : sum;
157}
158
Dave Chinner62d36c72013-08-28 10:17:54 +1000159static long get_nr_dentry_unused(void)
160{
161 int i;
162 long sum = 0;
163 for_each_possible_cpu(i)
164 sum += per_cpu(nr_dentry_unused, i);
165 return sum < 0 ? 0 : sum;
166}
167
Joe Perches1f7e0612014-06-06 14:38:05 -0700168int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169 size_t *lenp, loff_t *ppos)
170{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100171 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000172 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000173 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400174}
175#endif
176
Linus Torvalds5483f182012-03-04 15:51:42 -0800177/*
178 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
179 * The strings are both count bytes long, and count is non-zero.
180 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700181#ifdef CONFIG_DCACHE_WORD_ACCESS
182
183#include <asm/word-at-a-time.h>
184/*
185 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
186 * aligned allocation for this particular component. We don't
187 * strictly need the load_unaligned_zeropad() safety, but it
188 * doesn't hurt either.
189 *
190 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
191 * need the careful unaligned handling.
192 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700193static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800194{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196
197 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700198 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700199 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800200 if (tcount < sizeof(unsigned long))
201 break;
202 if (unlikely(a != b))
203 return 1;
204 cs += sizeof(unsigned long);
205 ct += sizeof(unsigned long);
206 tcount -= sizeof(unsigned long);
207 if (!tcount)
208 return 0;
209 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000210 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800211 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212}
213
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800214#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700215
Linus Torvalds94753db52012-05-10 12:19:19 -0700216static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700217{
Linus Torvalds5483f182012-03-04 15:51:42 -0800218 do {
219 if (*cs != *ct)
220 return 1;
221 cs++;
222 ct++;
223 tcount--;
224 } while (tcount);
225 return 0;
226}
227
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700228#endif
229
Linus Torvalds94753db52012-05-10 12:19:19 -0700230static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
231{
Linus Torvalds94753db52012-05-10 12:19:19 -0700232 /*
233 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000234 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700235 *
236 * NOTE! Even if a rename will mean that the length
237 * was not loaded atomically, we don't care. The
238 * RCU walk will check the sequence count eventually,
239 * and catch it. And we won't overrun the buffer,
240 * because we're reading the name pointer atomically,
241 * and a dentry name is guaranteed to be properly
242 * terminated with a NUL byte.
243 *
244 * End result: even if 'len' is wrong, we'll exit
245 * early because the data cannot match (there can
246 * be no NUL in the ct/tcount data)
247 */
He Kuangae0a8432016-03-26 09:12:10 +0000248 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
249
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700250 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700251}
252
Al Viro8d85b482014-09-29 14:54:27 -0400253struct external_name {
254 union {
255 atomic_t count;
256 struct rcu_head head;
257 } u;
258 unsigned char name[];
259};
260
261static inline struct external_name *external_name(struct dentry *dentry)
262{
263 return container_of(dentry->d_name.name, struct external_name, name[0]);
264}
265
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400266static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400268 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
269
Al Viro8d85b482014-09-29 14:54:27 -0400270 kmem_cache_free(dentry_cache, dentry);
271}
272
273static void __d_free_external(struct rcu_head *head)
274{
275 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400276 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 kmem_cache_free(dentry_cache, dentry);
278}
279
Al Viro810bb172014-10-12 12:45:37 -0400280static inline int dname_external(const struct dentry *dentry)
281{
282 return dentry->d_name.name != dentry->d_iname;
283}
284
David Howells4bf46a22015-03-05 14:09:22 +0000285static inline void __d_set_inode_and_type(struct dentry *dentry,
286 struct inode *inode,
287 unsigned type_flags)
288{
289 unsigned flags;
290
291 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000292 flags = READ_ONCE(dentry->d_flags);
293 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
294 flags |= type_flags;
295 WRITE_ONCE(dentry->d_flags, flags);
296}
297
David Howells4bf46a22015-03-05 14:09:22 +0000298static inline void __d_clear_type_and_inode(struct dentry *dentry)
299{
300 unsigned flags = READ_ONCE(dentry->d_flags);
301
302 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
303 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000304 dentry->d_inode = NULL;
305}
306
Al Virob4f03542014-04-29 23:40:14 -0400307static void dentry_free(struct dentry *dentry)
308{
Al Viro946e51f2014-10-26 19:19:16 -0400309 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400310 if (unlikely(dname_external(dentry))) {
311 struct external_name *p = external_name(dentry);
312 if (likely(atomic_dec_and_test(&p->u.count))) {
313 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
314 return;
315 }
316 }
Al Virob4f03542014-04-29 23:40:14 -0400317 /* if dentry was never visible to RCU, immediate free is OK */
318 if (!(dentry->d_flags & DCACHE_RCUACCESS))
319 __d_free(&dentry->d_u.d_rcu);
320 else
321 call_rcu(&dentry->d_u.d_rcu, __d_free);
322}
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324/*
325 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400326 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100327 */
328static void dentry_unlink_inode(struct dentry * dentry)
329 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100330 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100331{
332 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400333 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500334
Al Viro550dce02016-05-29 20:13:30 -0400335 if (hashed)
336 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000337 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400338 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400339 if (hashed)
340 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100341 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100342 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100343 if (!inode->i_nlink)
344 fsnotify_inoderemove(inode);
345 if (dentry->d_op && dentry->d_op->d_iput)
346 dentry->d_op->d_iput(dentry, inode);
347 else
348 iput(inode);
349}
350
351/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400352 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
353 * is in use - which includes both the "real" per-superblock
354 * LRU list _and_ the DCACHE_SHRINK_LIST use.
355 *
356 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
357 * on the shrink list (ie not on the superblock LRU list).
358 *
359 * The per-cpu "nr_dentry_unused" counters are updated with
360 * the DCACHE_LRU_LIST bit.
361 *
362 * These helper functions make sure we always follow the
363 * rules. d_lock must be held by the caller.
364 */
365#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
366static void d_lru_add(struct dentry *dentry)
367{
368 D_FLAG_VERIFY(dentry, 0);
369 dentry->d_flags |= DCACHE_LRU_LIST;
370 this_cpu_inc(nr_dentry_unused);
371 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
372}
373
374static void d_lru_del(struct dentry *dentry)
375{
376 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
377 dentry->d_flags &= ~DCACHE_LRU_LIST;
378 this_cpu_dec(nr_dentry_unused);
379 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
380}
381
382static void d_shrink_del(struct dentry *dentry)
383{
384 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
385 list_del_init(&dentry->d_lru);
386 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
387 this_cpu_dec(nr_dentry_unused);
388}
389
390static void d_shrink_add(struct dentry *dentry, struct list_head *list)
391{
392 D_FLAG_VERIFY(dentry, 0);
393 list_add(&dentry->d_lru, list);
394 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
395 this_cpu_inc(nr_dentry_unused);
396}
397
398/*
399 * These can only be called under the global LRU lock, ie during the
400 * callback for freeing the LRU list. "isolate" removes it from the
401 * LRU lists entirely, while shrink_move moves it to the indicated
402 * private list.
403 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800404static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400405{
406 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
407 dentry->d_flags &= ~DCACHE_LRU_LIST;
408 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800409 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400410}
411
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800412static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
413 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400414{
415 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
416 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800417 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400418}
419
420/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000421 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700422 */
423static void dentry_lru_add(struct dentry *dentry)
424{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400425 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
426 d_lru_add(dentry);
Josef Bacik563f4002017-04-18 16:04:17 -0400427 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
428 dentry->d_flags |= DCACHE_REFERENCED;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700429}
430
Miklos Szeredid52b9082007-05-08 00:23:46 -0700431/**
Nick Piggin789680d2011-01-07 17:49:30 +1100432 * d_drop - drop a dentry
433 * @dentry: dentry to drop
434 *
435 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
436 * be found through a VFS lookup any more. Note that this is different from
437 * deleting the dentry - d_delete will try to mark the dentry negative if
438 * possible, giving a successful _negative_ lookup, while d_drop will
439 * just make the cache lookup fail.
440 *
441 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
442 * reason (NFS timeouts or autofs deletes).
443 *
444 * __d_drop requires dentry->d_lock.
445 */
446void __d_drop(struct dentry *dentry)
447{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700448 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400449 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400450 /*
451 * Hashed dentries are normally on the dentry hashtable,
452 * with the exception of those newly allocated by
453 * d_obtain_alias, which are always IS_ROOT:
454 */
455 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400456 b = &dentry->d_sb->s_anon;
457 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700458 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400459
460 hlist_bl_lock(b);
461 __hlist_bl_del(&dentry->d_hash);
462 dentry->d_hash.pprev = NULL;
463 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400464 /* After this call, in-progress rcu-walk path lookup will fail. */
465 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100466 }
467}
468EXPORT_SYMBOL(__d_drop);
469
470void d_drop(struct dentry *dentry)
471{
Nick Piggin789680d2011-01-07 17:49:30 +1100472 spin_lock(&dentry->d_lock);
473 __d_drop(dentry);
474 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100475}
476EXPORT_SYMBOL(d_drop);
477
Al Viroba65dc52016-06-10 11:32:47 -0400478static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
479{
480 struct dentry *next;
481 /*
482 * Inform d_walk() and shrink_dentry_list() that we are no longer
483 * attached to the dentry tree
484 */
485 dentry->d_flags |= DCACHE_DENTRY_KILLED;
486 if (unlikely(list_empty(&dentry->d_child)))
487 return;
488 __list_del_entry(&dentry->d_child);
489 /*
490 * Cursors can move around the list of children. While we'd been
491 * a normal list member, it didn't matter - ->d_child.next would've
492 * been updated. However, from now on it won't be and for the
493 * things like d_walk() it might end up with a nasty surprise.
494 * Normally d_walk() doesn't care about cursors moving around -
495 * ->d_lock on parent prevents that and since a cursor has no children
496 * of its own, we get through it without ever unlocking the parent.
497 * There is one exception, though - if we ascend from a child that
498 * gets killed as soon as we unlock it, the next sibling is found
499 * using the value left in its ->d_child.next. And if _that_
500 * pointed to a cursor, and cursor got moved (e.g. by lseek())
501 * before d_walk() regains parent->d_lock, we'll end up skipping
502 * everything the cursor had been moved past.
503 *
504 * Solution: make sure that the pointer left behind in ->d_child.next
505 * points to something that won't be moving around. I.e. skip the
506 * cursors.
507 */
508 while (dentry->d_child.next != &parent->d_subdirs) {
509 next = list_entry(dentry->d_child.next, struct dentry, d_child);
510 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
511 break;
512 dentry->d_child.next = next->d_child.next;
513 }
514}
515
Al Viroe55fd012014-05-28 13:51:12 -0400516static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100517{
Al Viro41edf2782014-05-01 10:30:00 -0400518 struct dentry *parent = NULL;
519 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400520 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100521 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100522
Linus Torvalds0d984392013-09-08 13:46:52 -0700523 /*
524 * The dentry is now unrecoverably dead to the world.
525 */
526 lockref_mark_dead(&dentry->d_lockref);
527
Sage Weilf0023bc2011-10-28 10:02:42 -0700528 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700529 * inform the fs via d_prune that this dentry is about to be
530 * unhashed and destroyed.
531 */
Al Viro29266202014-05-30 11:39:02 -0400532 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800533 dentry->d_op->d_prune(dentry);
534
Al Viro01b60352014-04-29 23:42:52 -0400535 if (dentry->d_flags & DCACHE_LRU_LIST) {
536 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
537 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400538 }
Nick Piggin77812a12011-01-07 17:49:48 +1100539 /* if it was on the hash then remove it */
540 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400541 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400542 if (parent)
543 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400544 if (dentry->d_inode)
545 dentry_unlink_inode(dentry);
546 else
547 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400548 this_cpu_dec(nr_dentry);
549 if (dentry->d_op && dentry->d_op->d_release)
550 dentry->d_op->d_release(dentry);
551
Al Viro41edf2782014-05-01 10:30:00 -0400552 spin_lock(&dentry->d_lock);
553 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
554 dentry->d_flags |= DCACHE_MAY_FREE;
555 can_free = false;
556 }
557 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400558 if (likely(can_free))
559 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400560}
561
562/*
563 * Finish off a dentry we've decided to kill.
564 * dentry->d_lock must be held, returns with it unlocked.
565 * If ref is non-zero, then decrement the refcount too.
566 * Returns dentry requiring refcount drop, or NULL if we're done.
567 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400568static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400569 __releases(dentry->d_lock)
570{
571 struct inode *inode = dentry->d_inode;
572 struct dentry *parent = NULL;
573
574 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
575 goto failed;
576
577 if (!IS_ROOT(dentry)) {
578 parent = dentry->d_parent;
579 if (unlikely(!spin_trylock(&parent->d_lock))) {
580 if (inode)
581 spin_unlock(&inode->i_lock);
582 goto failed;
583 }
584 }
585
586 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400587 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400588
589failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400590 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400591 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100592}
593
Al Viro046b9612014-05-29 08:54:52 -0400594static inline struct dentry *lock_parent(struct dentry *dentry)
595{
596 struct dentry *parent = dentry->d_parent;
597 if (IS_ROOT(dentry))
598 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800599 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400600 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400601 if (likely(spin_trylock(&parent->d_lock)))
602 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400603 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400604 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400605again:
606 parent = ACCESS_ONCE(dentry->d_parent);
607 spin_lock(&parent->d_lock);
608 /*
609 * We can't blindly lock dentry until we are sure
610 * that we won't violate the locking order.
611 * Any changes of dentry->d_parent must have
612 * been done with parent->d_lock held, so
613 * spin_lock() above is enough of a barrier
614 * for checking if it's still our child.
615 */
616 if (unlikely(parent != dentry->d_parent)) {
617 spin_unlock(&parent->d_lock);
618 goto again;
619 }
620 rcu_read_unlock();
621 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700622 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400623 else
624 parent = NULL;
625 return parent;
626}
627
Linus Torvalds360f5472015-01-09 15:19:03 -0800628/*
629 * Try to do a lockless dput(), and return whether that was successful.
630 *
631 * If unsuccessful, we return false, having already taken the dentry lock.
632 *
633 * The caller needs to hold the RCU read lock, so that the dentry is
634 * guaranteed to stay around even if the refcount goes down to zero!
635 */
636static inline bool fast_dput(struct dentry *dentry)
637{
638 int ret;
639 unsigned int d_flags;
640
641 /*
642 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100643 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800644 */
645 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
646 return lockref_put_or_lock(&dentry->d_lockref);
647
648 /*
649 * .. otherwise, we can try to just decrement the
650 * lockref optimistically.
651 */
652 ret = lockref_put_return(&dentry->d_lockref);
653
654 /*
655 * If the lockref_put_return() failed due to the lock being held
656 * by somebody else, the fast path has failed. We will need to
657 * get the lock, and then check the count again.
658 */
659 if (unlikely(ret < 0)) {
660 spin_lock(&dentry->d_lock);
661 if (dentry->d_lockref.count > 1) {
662 dentry->d_lockref.count--;
663 spin_unlock(&dentry->d_lock);
664 return 1;
665 }
666 return 0;
667 }
668
669 /*
670 * If we weren't the last ref, we're done.
671 */
672 if (ret)
673 return 1;
674
675 /*
676 * Careful, careful. The reference count went down
677 * to zero, but we don't hold the dentry lock, so
678 * somebody else could get it again, and do another
679 * dput(), and we need to not race with that.
680 *
681 * However, there is a very special and common case
682 * where we don't care, because there is nothing to
683 * do: the dentry is still hashed, it does not have
684 * a 'delete' op, and it's referenced and already on
685 * the LRU list.
686 *
687 * NOTE! Since we aren't locked, these values are
688 * not "stable". However, it is sufficient that at
689 * some point after we dropped the reference the
690 * dentry was hashed and the flags had the proper
691 * value. Other dentry users may have re-gotten
692 * a reference to the dentry and change that, but
693 * our work is done - we can leave the dentry
694 * around with a zero refcount.
695 */
696 smp_rmb();
697 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100698 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800699
700 /* Nothing to do? Dropping the reference was all we needed? */
701 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
702 return 1;
703
704 /*
705 * Not the fast normal case? Get the lock. We've already decremented
706 * the refcount, but we'll need to re-check the situation after
707 * getting the lock.
708 */
709 spin_lock(&dentry->d_lock);
710
711 /*
712 * Did somebody else grab a reference to it in the meantime, and
713 * we're no longer the last user after all? Alternatively, somebody
714 * else could have killed it and marked it dead. Either way, we
715 * don't need to do anything else.
716 */
717 if (dentry->d_lockref.count) {
718 spin_unlock(&dentry->d_lock);
719 return 1;
720 }
721
722 /*
723 * Re-get the reference we optimistically dropped. We hold the
724 * lock, and we just tested that it was zero, so we can just
725 * set it to 1.
726 */
727 dentry->d_lockref.count = 1;
728 return 0;
729}
730
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
733 * This is dput
734 *
735 * This is complicated by the fact that we do not want to put
736 * dentries that are no longer on any hash chain on the unused
737 * list: we'd much rather just get rid of them immediately.
738 *
739 * However, that implies that we have to traverse the dentry
740 * tree upwards to the parents which might _also_ now be
741 * scheduled for deletion (it may have been only waiting for
742 * its last child to go away).
743 *
744 * This tail recursion is done by hand as we don't want to depend
745 * on the compiler to always get this right (gcc generally doesn't).
746 * Real recursion would eat up our stack space.
747 */
748
749/*
750 * dput - release a dentry
751 * @dentry: dentry to release
752 *
753 * Release a dentry. This will drop the usage count and if appropriate
754 * call the dentry unlink method as well as removing it from the queues and
755 * releasing its resources. If the parent dentries were scheduled for release
756 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758void dput(struct dentry *dentry)
759{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700760 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 return;
762
763repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800764 might_sleep();
765
Linus Torvalds360f5472015-01-09 15:19:03 -0800766 rcu_read_lock();
767 if (likely(fast_dput(dentry))) {
768 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800770 }
771
772 /* Slow case: now with the dentry lock held */
773 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Al Viro85c7f812016-04-14 19:52:13 -0400775 WARN_ON(d_in_lookup(dentry));
776
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700777 /* Unreachable? Get rid of it */
778 if (unlikely(d_unhashed(dentry)))
779 goto kill_it;
780
Al Viro75a6f822015-07-08 02:42:38 +0100781 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
782 goto kill_it;
783
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700784 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100786 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 }
Nick Piggin265ac902010-10-10 05:36:24 -0400788
Christoph Hellwiga4633352010-10-10 05:36:26 -0400789 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400790
Waiman Long98474232013-08-28 18:24:59 -0700791 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100792 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 return;
794
Miklos Szeredid52b9082007-05-08 00:23:46 -0700795kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400796 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800797 if (dentry) {
798 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700799 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700802EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100805/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100806static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
Waiman Long98474232013-08-28 18:24:59 -0700808 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
810
Nick Piggindc0474b2011-01-07 17:49:43 +1100811static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100812{
Waiman Long98474232013-08-28 18:24:59 -0700813 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100814}
815
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100816struct dentry *dget_parent(struct dentry *dentry)
817{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700818 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100819 struct dentry *ret;
820
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700821 /*
822 * Do optimistic parent lookup without any
823 * locking.
824 */
825 rcu_read_lock();
826 ret = ACCESS_ONCE(dentry->d_parent);
827 gotref = lockref_get_not_zero(&ret->d_lockref);
828 rcu_read_unlock();
829 if (likely(gotref)) {
830 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
831 return ret;
832 dput(ret);
833 }
834
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100835repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100836 /*
837 * Don't need rcu_dereference because we re-check it was correct under
838 * the lock.
839 */
840 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100841 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100842 spin_lock(&ret->d_lock);
843 if (unlikely(ret != dentry->d_parent)) {
844 spin_unlock(&ret->d_lock);
845 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100846 goto repeat;
847 }
Nick Piggina734eb42011-01-07 17:49:44 +1100848 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700849 BUG_ON(!ret->d_lockref.count);
850 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100851 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100852 return ret;
853}
854EXPORT_SYMBOL(dget_parent);
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856/**
857 * d_find_alias - grab a hashed alias of inode
858 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 *
860 * If inode has a hashed alias, or is a directory and has any alias,
861 * acquire the reference to alias and return it. Otherwise return NULL.
862 * Notice that if inode is a directory there can be only one alias and
863 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800864 * of a filesystem, or if the directory was renamed and d_revalidate
865 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700867 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500868 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500870static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Nick Pigginda502952011-01-07 17:49:33 +1100872 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Nick Pigginda502952011-01-07 17:49:33 +1100874again:
875 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400876 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100877 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700879 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100880 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500882 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100883 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100884 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 return alias;
886 }
887 }
Nick Pigginda502952011-01-07 17:49:33 +1100888 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 }
Nick Pigginda502952011-01-07 17:49:33 +1100890 if (discon_alias) {
891 alias = discon_alias;
892 spin_lock(&alias->d_lock);
893 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500894 __dget_dlock(alias);
895 spin_unlock(&alias->d_lock);
896 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100897 }
898 spin_unlock(&alias->d_lock);
899 goto again;
900 }
901 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902}
903
Nick Pigginda502952011-01-07 17:49:33 +1100904struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905{
David Howells214fda12006-03-25 03:06:36 -0800906 struct dentry *de = NULL;
907
Al Virob3d9b7a2012-06-09 13:51:19 -0400908 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100909 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500910 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100911 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800912 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 return de;
914}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700915EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
917/*
918 * Try to kill dentries associated with this inode.
919 * WARNING: you must own a reference to inode.
920 */
921void d_prune_aliases(struct inode *inode)
922{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700923 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100925 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400926 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700928 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400929 struct dentry *parent = lock_parent(dentry);
930 if (likely(!dentry->d_lockref.count)) {
931 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800932 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400933 goto restart;
934 }
935 if (parent)
936 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 }
938 spin_unlock(&dentry->d_lock);
939 }
Nick Piggin873feea2011-01-07 17:50:06 +1100940 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700942EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400944static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945{
Al Viro5c47e6d2014-04-29 16:13:18 -0400946 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700947
Miklos Szeredi60942f22014-05-02 15:38:39 -0400948 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400949 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400950 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100951 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400952 parent = lock_parent(dentry);
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000955 * The dispose list is isolated and dentries are not accounted
956 * to the LRU here, so we can simply remove it from the list
957 * here regardless of whether it is referenced or not.
958 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400959 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000960
961 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000963 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800965 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700966 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400967 if (parent)
968 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 continue;
970 }
Nick Piggin77812a12011-01-07 17:49:48 +1100971
Al Viro64fd72e2014-05-28 09:48:44 -0400972
973 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
974 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
975 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400976 if (parent)
977 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400978 if (can_free)
979 dentry_free(dentry);
980 continue;
981 }
982
Al Viroff2fde92014-05-28 13:59:13 -0400983 inode = dentry->d_inode;
984 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400985 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000986 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400987 if (parent)
988 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400989 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000990 }
Al Viroff2fde92014-05-28 13:59:13 -0400991
Al Viroff2fde92014-05-28 13:59:13 -0400992 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400993
Al Viro5c47e6d2014-04-29 16:13:18 -0400994 /*
995 * We need to prune ancestors too. This is necessary to prevent
996 * quadratic behavior of shrink_dcache_parent(), but is also
997 * expected to be beneficial in reducing dentry cache
998 * fragmentation.
999 */
1000 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001001 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1002 parent = lock_parent(dentry);
1003 if (dentry->d_lockref.count != 1) {
1004 dentry->d_lockref.count--;
1005 spin_unlock(&dentry->d_lock);
1006 if (parent)
1007 spin_unlock(&parent->d_lock);
1008 break;
1009 }
1010 inode = dentry->d_inode; /* can't be NULL */
1011 if (unlikely(!spin_trylock(&inode->i_lock))) {
1012 spin_unlock(&dentry->d_lock);
1013 if (parent)
1014 spin_unlock(&parent->d_lock);
1015 cpu_relax();
1016 continue;
1017 }
1018 __dentry_kill(dentry);
1019 dentry = parent;
1020 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001022}
1023
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001024static enum lru_status dentry_lru_isolate(struct list_head *item,
1025 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001026{
1027 struct list_head *freeable = arg;
1028 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1029
1030
1031 /*
1032 * we are inverting the lru lock/dentry->d_lock here,
1033 * so use a trylock. If we fail to get the lock, just skip
1034 * it
1035 */
1036 if (!spin_trylock(&dentry->d_lock))
1037 return LRU_SKIP;
1038
1039 /*
1040 * Referenced dentries are still in use. If they have active
1041 * counts, just remove them from the LRU. Otherwise give them
1042 * another pass through the LRU.
1043 */
1044 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001045 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001046 spin_unlock(&dentry->d_lock);
1047 return LRU_REMOVED;
1048 }
1049
1050 if (dentry->d_flags & DCACHE_REFERENCED) {
1051 dentry->d_flags &= ~DCACHE_REFERENCED;
1052 spin_unlock(&dentry->d_lock);
1053
1054 /*
1055 * The list move itself will be made by the common LRU code. At
1056 * this point, we've dropped the dentry->d_lock but keep the
1057 * lru lock. This is safe to do, since every list movement is
1058 * protected by the lru lock even if both locks are held.
1059 *
1060 * This is guaranteed by the fact that all LRU management
1061 * functions are intermediated by the LRU API calls like
1062 * list_lru_add and list_lru_del. List movement in this file
1063 * only ever occur through this functions or through callbacks
1064 * like this one, that are called from the LRU API.
1065 *
1066 * The only exceptions to this are functions like
1067 * shrink_dentry_list, and code that first checks for the
1068 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1069 * operating only with stack provided lists after they are
1070 * properly isolated from the main list. It is thus, always a
1071 * local access.
1072 */
1073 return LRU_ROTATE;
1074 }
1075
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001076 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001077 spin_unlock(&dentry->d_lock);
1078
1079 return LRU_REMOVED;
1080}
1081
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001082/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001083 * prune_dcache_sb - shrink the dcache
1084 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001085 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001086 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001087 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1088 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001089 * function.
1090 *
1091 * This function may fail to free any resources if all the dentries are in
1092 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001094long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001095{
Dave Chinnerf6041562013-08-28 10:18:00 +10001096 LIST_HEAD(dispose);
1097 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001098
Vladimir Davydov503c3582015-02-12 14:58:47 -08001099 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1100 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001101 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001102 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103}
1104
Glauber Costa4e717f52013-08-28 10:18:03 +10001105static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001106 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001107{
Glauber Costa4e717f52013-08-28 10:18:03 +10001108 struct list_head *freeable = arg;
1109 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001110
Glauber Costa4e717f52013-08-28 10:18:03 +10001111 /*
1112 * we are inverting the lru lock/dentry->d_lock here,
1113 * so use a trylock. If we fail to get the lock, just skip
1114 * it
1115 */
1116 if (!spin_trylock(&dentry->d_lock))
1117 return LRU_SKIP;
1118
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001119 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001120 spin_unlock(&dentry->d_lock);
1121
1122 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001123}
1124
Glauber Costa4e717f52013-08-28 10:18:03 +10001125
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001126/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 * shrink_dcache_sb - shrink dcache for a superblock
1128 * @sb: superblock
1129 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001130 * Shrink the dcache for the specified super block. This is used to free
1131 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001133void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134{
Glauber Costa4e717f52013-08-28 10:18:03 +10001135 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001136
Glauber Costa4e717f52013-08-28 10:18:03 +10001137 do {
1138 LIST_HEAD(dispose);
1139
1140 freed = list_lru_walk(&sb->s_dentry_lru,
1141 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1142
1143 this_cpu_sub(nr_dentry_unused, freed);
1144 shrink_dentry_list(&dispose);
1145 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001147EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001150 * enum d_walk_ret - action to talke during tree walk
1151 * @D_WALK_CONTINUE: contrinue walk
1152 * @D_WALK_QUIT: quit walk
1153 * @D_WALK_NORETRY: quit when retry is needed
1154 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001156enum d_walk_ret {
1157 D_WALK_CONTINUE,
1158 D_WALK_QUIT,
1159 D_WALK_NORETRY,
1160 D_WALK_SKIP,
1161};
1162
1163/**
1164 * d_walk - walk the dentry tree
1165 * @parent: start of walk
1166 * @data: data passed to @enter() and @finish()
1167 * @enter: callback when first entering the dentry
1168 * @finish: callback when successfully finished the walk
1169 *
1170 * The @enter() and @finish() callbacks are called with d_lock held.
1171 */
1172static void d_walk(struct dentry *parent, void *data,
1173 enum d_walk_ret (*enter)(void *, struct dentry *),
1174 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175{
Nick Piggin949854d2011-01-07 17:49:37 +11001176 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001178 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001179 enum d_walk_ret ret;
1180 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001181
Nick Piggin58db63d2011-01-07 17:49:39 +11001182again:
Al Viro48f5ec22013-09-09 15:22:25 -04001183 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001184 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001185 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001186
1187 ret = enter(data, this_parent);
1188 switch (ret) {
1189 case D_WALK_CONTINUE:
1190 break;
1191 case D_WALK_QUIT:
1192 case D_WALK_SKIP:
1193 goto out_unlock;
1194 case D_WALK_NORETRY:
1195 retry = false;
1196 break;
1197 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198repeat:
1199 next = this_parent->d_subdirs.next;
1200resume:
1201 while (next != &this_parent->d_subdirs) {
1202 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001203 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001205
Al Viroba65dc52016-06-10 11:32:47 -04001206 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1207 continue;
1208
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001209 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001210
1211 ret = enter(data, dentry);
1212 switch (ret) {
1213 case D_WALK_CONTINUE:
1214 break;
1215 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001216 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001217 goto out_unlock;
1218 case D_WALK_NORETRY:
1219 retry = false;
1220 break;
1221 case D_WALK_SKIP:
1222 spin_unlock(&dentry->d_lock);
1223 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001224 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001227 spin_unlock(&this_parent->d_lock);
1228 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001230 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 goto repeat;
1232 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001233 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 }
1235 /*
1236 * All done at this level ... ascend and resume the search.
1237 */
Al Viroca5358e2014-10-26 19:31:10 -04001238 rcu_read_lock();
1239ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001241 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001242 this_parent = child->d_parent;
1243
Al Viro31dec132013-10-25 17:04:27 -04001244 spin_unlock(&child->d_lock);
1245 spin_lock(&this_parent->d_lock);
1246
Al Viroca5358e2014-10-26 19:31:10 -04001247 /* might go back up the wrong parent if we have had a rename. */
1248 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001249 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001250 /* go into the first sibling still alive */
1251 do {
1252 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001253 if (next == &this_parent->d_subdirs)
1254 goto ascend;
1255 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001256 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001257 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 goto resume;
1259 }
Al Viroca5358e2014-10-26 19:31:10 -04001260 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001261 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001262 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001263 if (finish)
1264 finish(data);
1265
1266out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001267 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001268 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001269 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001270
1271rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001272 spin_unlock(&this_parent->d_lock);
1273 rcu_read_unlock();
1274 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001275 if (!retry)
1276 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001277 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001278 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001280
Ian Kent01619492016-11-24 08:03:41 +11001281struct check_mount {
1282 struct vfsmount *mnt;
1283 unsigned int mounted;
1284};
1285
1286static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1287{
1288 struct check_mount *info = data;
1289 struct path path = { .mnt = info->mnt, .dentry = dentry };
1290
1291 if (likely(!d_mountpoint(dentry)))
1292 return D_WALK_CONTINUE;
1293 if (__path_is_mountpoint(&path)) {
1294 info->mounted = 1;
1295 return D_WALK_QUIT;
1296 }
1297 return D_WALK_CONTINUE;
1298}
1299
1300/**
1301 * path_has_submounts - check for mounts over a dentry in the
1302 * current namespace.
1303 * @parent: path to check.
1304 *
1305 * Return true if the parent or its subdirectories contain
1306 * a mount point in the current namespace.
1307 */
1308int path_has_submounts(const struct path *parent)
1309{
1310 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1311
1312 read_seqlock_excl(&mount_lock);
1313 d_walk(parent->dentry, &data, path_check_mount, NULL);
1314 read_sequnlock_excl(&mount_lock);
1315
1316 return data.mounted;
1317}
1318EXPORT_SYMBOL(path_has_submounts);
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001321 * Called by mount code to set a mountpoint and check if the mountpoint is
1322 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1323 * subtree can become unreachable).
1324 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001325 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001326 * this reason take rename_lock and d_lock on dentry and ancestors.
1327 */
1328int d_set_mounted(struct dentry *dentry)
1329{
1330 struct dentry *p;
1331 int ret = -ENOENT;
1332 write_seqlock(&rename_lock);
1333 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001334 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001335 spin_lock(&p->d_lock);
1336 if (unlikely(d_unhashed(p))) {
1337 spin_unlock(&p->d_lock);
1338 goto out;
1339 }
1340 spin_unlock(&p->d_lock);
1341 }
1342 spin_lock(&dentry->d_lock);
1343 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001344 ret = -EBUSY;
1345 if (!d_mountpoint(dentry)) {
1346 dentry->d_flags |= DCACHE_MOUNTED;
1347 ret = 0;
1348 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001349 }
1350 spin_unlock(&dentry->d_lock);
1351out:
1352 write_sequnlock(&rename_lock);
1353 return ret;
1354}
1355
1356/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001357 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 * and move any unused dentries to the end of the unused
1359 * list for prune_dcache(). We descend to the next level
1360 * whenever the d_subdirs list is non-empty and continue
1361 * searching.
1362 *
1363 * It returns zero iff there are no unused children,
1364 * otherwise it returns the number of children moved to
1365 * the end of the unused list. This may not be the total
1366 * number of unused children, because select_parent can
1367 * drop the lock and return early due to latency
1368 * constraints.
1369 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001370
1371struct select_data {
1372 struct dentry *start;
1373 struct list_head dispose;
1374 int found;
1375};
1376
1377static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001379 struct select_data *data = _data;
1380 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001382 if (data->start == dentry)
1383 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Al Virofe915222014-05-03 00:02:25 -04001385 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001386 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001387 } else {
1388 if (dentry->d_flags & DCACHE_LRU_LIST)
1389 d_lru_del(dentry);
1390 if (!dentry->d_lockref.count) {
1391 d_shrink_add(dentry, &data->dispose);
1392 data->found++;
1393 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 }
1395 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001396 * We can return to the caller if we have found some (this
1397 * ensures forward progress). We'll be coming back to find
1398 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 */
Al Virofe915222014-05-03 00:02:25 -04001400 if (!list_empty(&data->dispose))
1401 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001403 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
1405
1406/**
1407 * shrink_dcache_parent - prune dcache
1408 * @parent: parent of entries to prune
1409 *
1410 * Prune the dcache to remove unused children of the parent dentry.
1411 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001412void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001414 for (;;) {
1415 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001417 INIT_LIST_HEAD(&data.dispose);
1418 data.start = parent;
1419 data.found = 0;
1420
1421 d_walk(parent, &data, select_collect, NULL);
1422 if (!data.found)
1423 break;
1424
1425 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001426 cond_resched();
1427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001429EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Al Viro9c8c10e2014-05-02 20:36:10 -04001431static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001432{
Al Viro9c8c10e2014-05-02 20:36:10 -04001433 /* it has busy descendents; complain about those instead */
1434 if (!list_empty(&dentry->d_subdirs))
1435 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001436
Al Viro9c8c10e2014-05-02 20:36:10 -04001437 /* root with refcount 1 is fine */
1438 if (dentry == _data && dentry->d_lockref.count == 1)
1439 return D_WALK_CONTINUE;
1440
1441 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1442 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001443 dentry,
1444 dentry->d_inode ?
1445 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001446 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001447 dentry->d_lockref.count,
1448 dentry->d_sb->s_type->name,
1449 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001450 WARN_ON(1);
1451 return D_WALK_CONTINUE;
1452}
1453
1454static void do_one_tree(struct dentry *dentry)
1455{
1456 shrink_dcache_parent(dentry);
1457 d_walk(dentry, dentry, umount_check, NULL);
1458 d_drop(dentry);
1459 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001460}
1461
1462/*
1463 * destroy the dentries attached to a superblock on unmounting
1464 */
1465void shrink_dcache_for_umount(struct super_block *sb)
1466{
1467 struct dentry *dentry;
1468
Al Viro9c8c10e2014-05-02 20:36:10 -04001469 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001470
1471 dentry = sb->s_root;
1472 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001473 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001474
1475 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001476 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1477 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001478 }
1479}
1480
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001481struct detach_data {
1482 struct select_data select;
1483 struct dentry *mountpoint;
1484};
1485static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001486{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001487 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001488
1489 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001490 __dget_dlock(dentry);
1491 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001492 return D_WALK_QUIT;
1493 }
1494
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001495 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001496}
1497
1498static void check_and_drop(void *_data)
1499{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001500 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001501
Al Viro81be24d2017-06-03 07:20:09 +01001502 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001503 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001504}
1505
1506/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001507 * d_invalidate - detach submounts, prune dcache, and drop
1508 * @dentry: dentry to invalidate (aka detach, prune and drop)
1509 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001510 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001511 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001512 * The final d_drop is done as an atomic operation relative to
1513 * rename_lock ensuring there are no races with d_set_mounted. This
1514 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001515 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001516void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001517{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001518 /*
1519 * If it's already been dropped, return OK.
1520 */
1521 spin_lock(&dentry->d_lock);
1522 if (d_unhashed(dentry)) {
1523 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001524 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001525 }
1526 spin_unlock(&dentry->d_lock);
1527
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001528 /* Negative dentries can be dropped without further checks */
1529 if (!dentry->d_inode) {
1530 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001531 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001532 }
1533
1534 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001535 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001536
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001537 data.mountpoint = NULL;
1538 INIT_LIST_HEAD(&data.select.dispose);
1539 data.select.start = dentry;
1540 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001541
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001542 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001543
Al Viro81be24d2017-06-03 07:20:09 +01001544 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001545 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001546 else if (!data.mountpoint)
1547 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001548
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001549 if (data.mountpoint) {
1550 detach_mounts(data.mountpoint);
1551 dput(data.mountpoint);
1552 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001553 cond_resched();
1554 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001556EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558/**
Al Viroa4464db2011-07-07 15:03:58 -04001559 * __d_alloc - allocate a dcache entry
1560 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 * @name: qstr of the name
1562 *
1563 * Allocates a dentry. It returns %NULL if there is insufficient memory
1564 * available. On a success the dentry is returned. The name passed in is
1565 * copied and the copy passed in may be reused after this call.
1566 */
1567
Al Viroa4464db2011-07-07 15:03:58 -04001568struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569{
1570 struct dentry *dentry;
1571 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001572 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Mel Gormane12ba742007-10-16 01:25:52 -07001574 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 if (!dentry)
1576 return NULL;
1577
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001578 /*
1579 * We guarantee that the inline name is always NUL-terminated.
1580 * This way the memcpy() done by the name switching in rename
1581 * will still always have a NUL at the end, even if we might
1582 * be overwriting an internal NUL character
1583 */
1584 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001585 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001586 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001587 dname = dentry->d_iname;
1588 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001589 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001590 struct external_name *p = kmalloc(size + name->len,
1591 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001592 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 kmem_cache_free(dentry_cache, dentry);
1594 return NULL;
1595 }
Al Viro8d85b482014-09-29 14:54:27 -04001596 atomic_set(&p->u.count, 1);
1597 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001598 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1599 kasan_unpoison_shadow(dname,
1600 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 } else {
1602 dname = dentry->d_iname;
1603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605 dentry->d_name.len = name->len;
1606 dentry->d_name.hash = name->hash;
1607 memcpy(dname, name->name, name->len);
1608 dname[name->len] = 0;
1609
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001610 /* Make sure we always see the terminating NUL character */
1611 smp_wmb();
1612 dentry->d_name.name = dname;
1613
Waiman Long98474232013-08-28 18:24:59 -07001614 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001615 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001617 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001619 dentry->d_parent = dentry;
1620 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 dentry->d_op = NULL;
1622 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001623 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 INIT_LIST_HEAD(&dentry->d_lru);
1625 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001626 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1627 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001628 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Miklos Szeredi285b1022016-06-28 11:47:32 +02001630 if (dentry->d_op && dentry->d_op->d_init) {
1631 err = dentry->d_op->d_init(dentry);
1632 if (err) {
1633 if (dname_external(dentry))
1634 kfree(external_name(dentry));
1635 kmem_cache_free(dentry_cache, dentry);
1636 return NULL;
1637 }
1638 }
1639
Nick Piggin3e880fb2011-01-07 17:49:19 +11001640 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 return dentry;
1643}
Al Viroa4464db2011-07-07 15:03:58 -04001644
1645/**
1646 * d_alloc - allocate a dcache entry
1647 * @parent: parent of entry to allocate
1648 * @name: qstr of the name
1649 *
1650 * Allocates a dentry. It returns %NULL if there is insufficient memory
1651 * available. On a success the dentry is returned. The name passed in is
1652 * copied and the copy passed in may be reused after this call.
1653 */
1654struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1655{
1656 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1657 if (!dentry)
1658 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001659 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001660 spin_lock(&parent->d_lock);
1661 /*
1662 * don't need child lock because it is not subject
1663 * to concurrency here
1664 */
1665 __dget_dlock(parent);
1666 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001667 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001668 spin_unlock(&parent->d_lock);
1669
1670 return dentry;
1671}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001672EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Al Viroba65dc52016-06-10 11:32:47 -04001674struct dentry *d_alloc_cursor(struct dentry * parent)
1675{
1676 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1677 if (dentry) {
1678 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1679 dentry->d_parent = dget(parent);
1680 }
1681 return dentry;
1682}
1683
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001684/**
1685 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1686 * @sb: the superblock
1687 * @name: qstr of the name
1688 *
1689 * For a filesystem that just pins its dentries in memory and never
1690 * performs lookups at all, return an unhashed IS_ROOT dentry.
1691 */
Nick Piggin4b936882011-01-07 17:50:07 +11001692struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1693{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001694 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001695}
1696EXPORT_SYMBOL(d_alloc_pseudo);
1697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1699{
1700 struct qstr q;
1701
1702 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001703 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 return d_alloc(parent, &q);
1705}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001706EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
Nick Pigginfb045ad2011-01-07 17:49:55 +11001708void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1709{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001710 WARN_ON_ONCE(dentry->d_op);
1711 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001712 DCACHE_OP_COMPARE |
1713 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001714 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001715 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001716 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001717 dentry->d_op = op;
1718 if (!op)
1719 return;
1720 if (op->d_hash)
1721 dentry->d_flags |= DCACHE_OP_HASH;
1722 if (op->d_compare)
1723 dentry->d_flags |= DCACHE_OP_COMPARE;
1724 if (op->d_revalidate)
1725 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001726 if (op->d_weak_revalidate)
1727 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001728 if (op->d_delete)
1729 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001730 if (op->d_prune)
1731 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001732 if (op->d_real)
1733 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001734
1735}
1736EXPORT_SYMBOL(d_set_d_op);
1737
David Howellsdf1a0852015-01-29 12:02:28 +00001738
1739/*
1740 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1741 * @dentry - The dentry to mark
1742 *
1743 * Mark a dentry as falling through to the lower layer (as set with
1744 * d_pin_lower()). This flag may be recorded on the medium.
1745 */
1746void d_set_fallthru(struct dentry *dentry)
1747{
1748 spin_lock(&dentry->d_lock);
1749 dentry->d_flags |= DCACHE_FALLTHRU;
1750 spin_unlock(&dentry->d_lock);
1751}
1752EXPORT_SYMBOL(d_set_fallthru);
1753
David Howellsb18825a2013-09-12 19:22:53 +01001754static unsigned d_flags_for_inode(struct inode *inode)
1755{
David Howells44bdb5e2015-01-29 12:02:29 +00001756 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001757
1758 if (!inode)
1759 return DCACHE_MISS_TYPE;
1760
1761 if (S_ISDIR(inode->i_mode)) {
1762 add_flags = DCACHE_DIRECTORY_TYPE;
1763 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1764 if (unlikely(!inode->i_op->lookup))
1765 add_flags = DCACHE_AUTODIR_TYPE;
1766 else
1767 inode->i_opflags |= IOP_LOOKUP;
1768 }
David Howells44bdb5e2015-01-29 12:02:29 +00001769 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001770 }
1771
David Howells44bdb5e2015-01-29 12:02:29 +00001772 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001773 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001774 add_flags = DCACHE_SYMLINK_TYPE;
1775 goto type_determined;
1776 }
1777 inode->i_opflags |= IOP_NOFOLLOW;
1778 }
1779
1780 if (unlikely(!S_ISREG(inode->i_mode)))
1781 add_flags = DCACHE_SPECIAL_TYPE;
1782
1783type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001784 if (unlikely(IS_AUTOMOUNT(inode)))
1785 add_flags |= DCACHE_NEED_AUTOMOUNT;
1786 return add_flags;
1787}
1788
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001789static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1790{
David Howellsb18825a2013-09-12 19:22:53 +01001791 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001792 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001793
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001794 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001795 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001796 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001797 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001798 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001799 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001800 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001801}
1802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803/**
1804 * d_instantiate - fill in inode information for a dentry
1805 * @entry: dentry to complete
1806 * @inode: inode to attach to this dentry
1807 *
1808 * Fill in inode information in the entry.
1809 *
1810 * This turns negative dentries into productive full members
1811 * of society.
1812 *
1813 * NOTE! This assumes that the inode count has been incremented
1814 * (or otherwise set) by the caller to indicate that it is now
1815 * in use by the dcache.
1816 */
1817
1818void d_instantiate(struct dentry *entry, struct inode * inode)
1819{
Al Viro946e51f2014-10-26 19:19:16 -04001820 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001821 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001822 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001823 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001824 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001825 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001826 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001828EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
1830/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001831 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1832 * @entry: dentry to complete
1833 * @inode: inode to attach to this dentry
1834 *
1835 * Fill in inode information in the entry. If a directory alias is found, then
1836 * return an error (and drop inode). Together with d_materialise_unique() this
1837 * guarantees that a directory inode may never have more than one alias.
1838 */
1839int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1840{
Al Viro946e51f2014-10-26 19:19:16 -04001841 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001842
Al Virob9680912016-04-11 00:53:26 -04001843 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001844 spin_lock(&inode->i_lock);
1845 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1846 spin_unlock(&inode->i_lock);
1847 iput(inode);
1848 return -EBUSY;
1849 }
1850 __d_instantiate(entry, inode);
1851 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001852
1853 return 0;
1854}
1855EXPORT_SYMBOL(d_instantiate_no_diralias);
1856
Al Viroadc0e91a2012-01-08 16:49:21 -05001857struct dentry *d_make_root(struct inode *root_inode)
1858{
1859 struct dentry *res = NULL;
1860
1861 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001862 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e91a2012-01-08 16:49:21 -05001863 if (res)
1864 d_instantiate(res, root_inode);
1865 else
1866 iput(root_inode);
1867 }
1868 return res;
1869}
1870EXPORT_SYMBOL(d_make_root);
1871
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001872static struct dentry * __d_find_any_alias(struct inode *inode)
1873{
1874 struct dentry *alias;
1875
Al Virob3d9b7a2012-06-09 13:51:19 -04001876 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001877 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001878 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001879 __dget(alias);
1880 return alias;
1881}
1882
Sage Weil46f72b32012-01-10 09:04:37 -08001883/**
1884 * d_find_any_alias - find any alias for a given inode
1885 * @inode: inode to find an alias for
1886 *
1887 * If any aliases exist for the given inode, take and return a
1888 * reference for one of them. If no aliases exist, return %NULL.
1889 */
1890struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001891{
1892 struct dentry *de;
1893
1894 spin_lock(&inode->i_lock);
1895 de = __d_find_any_alias(inode);
1896 spin_unlock(&inode->i_lock);
1897 return de;
1898}
Sage Weil46f72b32012-01-10 09:04:37 -08001899EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001900
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001901static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001902{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001903 struct dentry *tmp;
1904 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001905 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001906
1907 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001908 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001909 if (IS_ERR(inode))
1910 return ERR_CAST(inode);
1911
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001912 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001913 if (res)
1914 goto out_iput;
1915
Al Viro798434b2016-03-24 20:38:43 -04001916 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001917 if (!tmp) {
1918 res = ERR_PTR(-ENOMEM);
1919 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001920 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001921
Al Virob9680912016-04-11 00:53:26 -04001922 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001923 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001924 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001925 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001926 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001927 dput(tmp);
1928 goto out_iput;
1929 }
1930
1931 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001932 add_flags = d_flags_for_inode(inode);
1933
1934 if (disconnected)
1935 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001936
Christoph Hellwig9308a612008-08-11 15:49:12 +02001937 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001938 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001939 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001940 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001941 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001942 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001943 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001944 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001945
Christoph Hellwig9308a612008-08-11 15:49:12 +02001946 return tmp;
1947
1948 out_iput:
1949 iput(inode);
1950 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001951}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001952
1953/**
1954 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1955 * @inode: inode to allocate the dentry for
1956 *
1957 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1958 * similar open by handle operations. The returned dentry may be anonymous,
1959 * or may have a full name (if the inode was already in the cache).
1960 *
1961 * When called on a directory inode, we must ensure that the inode only ever
1962 * has one dentry. If a dentry is found, that is returned instead of
1963 * allocating a new one.
1964 *
1965 * On successful return, the reference to the inode has been transferred
1966 * to the dentry. In case of an error the reference on the inode is released.
1967 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1968 * be passed in and the error will be propagated to the return value,
1969 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1970 */
1971struct dentry *d_obtain_alias(struct inode *inode)
1972{
1973 return __d_obtain_alias(inode, 1);
1974}
Benny Halevyadc48722009-02-27 14:02:59 -08001975EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
1977/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001978 * d_obtain_root - find or allocate a dentry for a given inode
1979 * @inode: inode to allocate the dentry for
1980 *
1981 * Obtain an IS_ROOT dentry for the root of a filesystem.
1982 *
1983 * We must ensure that directory inodes only ever have one dentry. If a
1984 * dentry is found, that is returned instead of allocating a new one.
1985 *
1986 * On successful return, the reference to the inode has been transferred
1987 * to the dentry. In case of an error the reference on the inode is
1988 * released. A %NULL or IS_ERR inode may be passed in and will be the
1989 * error will be propagate to the return value, with a %NULL @inode
1990 * replaced by ERR_PTR(-ESTALE).
1991 */
1992struct dentry *d_obtain_root(struct inode *inode)
1993{
1994 return __d_obtain_alias(inode, 0);
1995}
1996EXPORT_SYMBOL(d_obtain_root);
1997
1998/**
Barry Naujok94035402008-05-21 16:50:46 +10001999 * d_add_ci - lookup or allocate new dentry with case-exact name
2000 * @inode: the inode case-insensitive lookup has found
2001 * @dentry: the negative dentry that was passed to the parent's lookup func
2002 * @name: the case-exact name to be associated with the returned dentry
2003 *
2004 * This is to avoid filling the dcache with case-insensitive names to the
2005 * same inode, only the actual correct case is stored in the dcache for
2006 * case-insensitive filesystems.
2007 *
2008 * For a case-insensitive lookup match and if the the case-exact dentry
2009 * already exists in in the dcache, use it and return it.
2010 *
2011 * If no entry exists with the exact case name, allocate new dentry with
2012 * the exact case, and return the spliced entry.
2013 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002014struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002015 struct qstr *name)
2016{
Al Virod9171b92016-04-15 03:33:13 -04002017 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002018
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002019 /*
2020 * First check if a dentry matching the name already exists,
2021 * if not go ahead and create it now.
2022 */
Barry Naujok94035402008-05-21 16:50:46 +10002023 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002024 if (found) {
2025 iput(inode);
2026 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002027 }
Al Virod9171b92016-04-15 03:33:13 -04002028 if (d_in_lookup(dentry)) {
2029 found = d_alloc_parallel(dentry->d_parent, name,
2030 dentry->d_wait);
2031 if (IS_ERR(found) || !d_in_lookup(found)) {
2032 iput(inode);
2033 return found;
2034 }
2035 } else {
2036 found = d_alloc(dentry->d_parent, name);
2037 if (!found) {
2038 iput(inode);
2039 return ERR_PTR(-ENOMEM);
2040 }
2041 }
2042 res = d_splice_alias(inode, found);
2043 if (res) {
2044 dput(found);
2045 return res;
2046 }
Al Viro4f522a22013-02-11 23:20:37 -05002047 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002048}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002049EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002051
Al Virod4c91a82016-06-25 23:33:49 -04002052static inline bool d_same_name(const struct dentry *dentry,
2053 const struct dentry *parent,
2054 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002055{
Al Virod4c91a82016-06-25 23:33:49 -04002056 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2057 if (dentry->d_name.len != name->len)
2058 return false;
2059 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002060 }
Al Viro6fa67e72016-07-31 16:37:25 -04002061 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002062 dentry->d_name.len, dentry->d_name.name,
2063 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002064}
2065
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002067 * __d_lookup_rcu - search for a dentry (racy, store-free)
2068 * @parent: parent dentry
2069 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002070 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002071 * Returns: dentry, or NULL
2072 *
2073 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2074 * resolution (store-free path walking) design described in
2075 * Documentation/filesystems/path-lookup.txt.
2076 *
2077 * This is not to be used outside core vfs.
2078 *
2079 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2080 * held, and rcu_read_lock held. The returned dentry must not be stored into
2081 * without taking d_lock and checking d_seq sequence count against @seq
2082 * returned here.
2083 *
Linus Torvalds15570082013-09-02 11:38:06 -07002084 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002085 * function.
2086 *
2087 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2088 * the returned dentry, so long as its parent's seqlock is checked after the
2089 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2090 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002091 *
2092 * NOTE! The caller *has* to check the resulting dentry against the sequence
2093 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002094 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002095struct dentry *__d_lookup_rcu(const struct dentry *parent,
2096 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002097 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002098{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002099 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002100 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002101 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002102 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002103 struct dentry *dentry;
2104
2105 /*
2106 * Note: There is significant duplication with __d_lookup_rcu which is
2107 * required to prevent single threaded performance regressions
2108 * especially on architectures where smp_rmb (in seqcounts) are costly.
2109 * Keep the two functions in sync.
2110 */
2111
2112 /*
2113 * The hash list is protected using RCU.
2114 *
2115 * Carefully use d_seq when comparing a candidate dentry, to avoid
2116 * races with d_move().
2117 *
2118 * It is possible that concurrent renames can mess up our list
2119 * walk here and result in missing our dentry, resulting in the
2120 * false-negative result. d_lookup() protects against concurrent
2121 * renames using rename_lock seqlock.
2122 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002123 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002124 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002125 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002126 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002127
Nick Piggin31e6b012011-01-07 17:49:52 +11002128seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002129 /*
2130 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002131 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002132 *
2133 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002134 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002135 *
2136 * NOTE! We do a "raw" seqcount_begin here. That means that
2137 * we don't wait for the sequence count to stabilize if it
2138 * is in the middle of a sequence change. If we do the slow
2139 * dentry compare, we will do seqretries until it is stable,
2140 * and if we end up with a successful lookup, we actually
2141 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002142 *
2143 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2144 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002145 */
2146 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002147 if (dentry->d_parent != parent)
2148 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002149 if (d_unhashed(dentry))
2150 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002151
2152 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002153 int tlen;
2154 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002155 if (dentry->d_name.hash != hashlen_hash(hashlen))
2156 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002157 tlen = dentry->d_name.len;
2158 tname = dentry->d_name.name;
2159 /* we want a consistent (name,len) pair */
2160 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2161 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002162 goto seqretry;
2163 }
Al Viro6fa67e72016-07-31 16:37:25 -04002164 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002165 tlen, tname, name) != 0)
2166 continue;
2167 } else {
2168 if (dentry->d_name.hash_len != hashlen)
2169 continue;
2170 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2171 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002172 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002173 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002174 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002175 }
2176 return NULL;
2177}
2178
2179/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 * d_lookup - search for a dentry
2181 * @parent: parent dentry
2182 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002183 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002185 * d_lookup searches the children of the parent dentry for the name in
2186 * question. If the dentry is found its reference count is incremented and the
2187 * dentry is returned. The caller must use dput to free the entry when it has
2188 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 */
Al Viroda2d8452013-01-24 18:29:34 -05002190struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Nick Piggin31e6b012011-01-07 17:49:52 +11002192 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002193 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
Daeseok Younb8314f92014-08-11 11:46:53 +09002195 do {
2196 seq = read_seqbegin(&rename_lock);
2197 dentry = __d_lookup(parent, name);
2198 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 break;
2200 } while (read_seqretry(&rename_lock, seq));
2201 return dentry;
2202}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002203EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204
Nick Piggin31e6b012011-01-07 17:49:52 +11002205/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002206 * __d_lookup - search for a dentry (racy)
2207 * @parent: parent dentry
2208 * @name: qstr of name we wish to find
2209 * Returns: dentry, or NULL
2210 *
2211 * __d_lookup is like d_lookup, however it may (rarely) return a
2212 * false-negative result due to unrelated rename activity.
2213 *
2214 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2215 * however it must be used carefully, eg. with a following d_lookup in
2216 * the case of failure.
2217 *
2218 * __d_lookup callers must be commented.
2219 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002220struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002223 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002224 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002225 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002226 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
Nick Pigginb04f7842010-08-18 04:37:34 +10002228 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002229 * Note: There is significant duplication with __d_lookup_rcu which is
2230 * required to prevent single threaded performance regressions
2231 * especially on architectures where smp_rmb (in seqcounts) are costly.
2232 * Keep the two functions in sync.
2233 */
2234
2235 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002236 * The hash list is protected using RCU.
2237 *
2238 * Take d_lock when comparing a candidate dentry, to avoid races
2239 * with d_move().
2240 *
2241 * It is possible that concurrent renames can mess up our list
2242 * walk here and result in missing our dentry, resulting in the
2243 * false-negative result. d_lookup() protects against concurrent
2244 * renames using rename_lock seqlock.
2245 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002246 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002247 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 rcu_read_lock();
2249
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002250 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 if (dentry->d_name.hash != hash)
2253 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
2255 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 if (dentry->d_parent != parent)
2257 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002258 if (d_unhashed(dentry))
2259 goto next;
2260
Al Virod4c91a82016-06-25 23:33:49 -04002261 if (!d_same_name(dentry, parent, name))
2262 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Waiman Long98474232013-08-28 18:24:59 -07002264 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002265 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 spin_unlock(&dentry->d_lock);
2267 break;
2268next:
2269 spin_unlock(&dentry->d_lock);
2270 }
2271 rcu_read_unlock();
2272
2273 return found;
2274}
2275
2276/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002277 * d_hash_and_lookup - hash the qstr then search for a dentry
2278 * @dir: Directory to search in
2279 * @name: qstr of name we wish to find
2280 *
Al Viro4f522a22013-02-11 23:20:37 -05002281 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002282 */
2283struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2284{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002285 /*
2286 * Check for a fs-specific hash function. Note that we must
2287 * calculate the standard hash first, as the d_op->d_hash()
2288 * routine may choose to leave the hash value unchanged.
2289 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002290 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002291 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002292 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002293 if (unlikely(err < 0))
2294 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002295 }
Al Viro4f522a22013-02-11 23:20:37 -05002296 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002297}
Al Viro4f522a22013-02-11 23:20:37 -05002298EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002299
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300/*
2301 * When a file is deleted, we have two options:
2302 * - turn this dentry into a negative dentry
2303 * - unhash this dentry and free it.
2304 *
2305 * Usually, we want to just turn this into
2306 * a negative dentry, but if anybody else is
2307 * currently using the dentry or the inode
2308 * we can't do that and we fall back on removing
2309 * it from the hash queues and waiting for
2310 * it to be deleted later when it has no users
2311 */
2312
2313/**
2314 * d_delete - delete a dentry
2315 * @dentry: The dentry to delete
2316 *
2317 * Turn the dentry into a negative dentry if possible, otherwise
2318 * remove it from the hash queues so it can be deleted later
2319 */
2320
2321void d_delete(struct dentry * dentry)
2322{
Nick Piggin873feea2011-01-07 17:50:06 +11002323 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002324 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 /*
2326 * Are we the only user?
2327 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002328again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002330 inode = dentry->d_inode;
2331 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002332 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002333 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002334 spin_unlock(&dentry->d_lock);
2335 cpu_relax();
2336 goto again;
2337 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002338 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002339 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002340 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 return;
2342 }
2343
2344 if (!d_unhashed(dentry))
2345 __d_drop(dentry);
2346
2347 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002348
2349 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002351EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352
Al Viro15d3c582016-07-29 17:45:21 -04002353static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354{
Al Viro15d3c582016-07-29 17:45:21 -04002355 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002356 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002357 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002358 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002359 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360}
2361
2362/**
2363 * d_rehash - add an entry back to the hash
2364 * @entry: dentry to add to the hash
2365 *
2366 * Adds a dentry to the hash according to its name.
2367 */
2368
2369void d_rehash(struct dentry * entry)
2370{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002372 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002375EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376
Al Viro84e710d2016-04-15 00:58:55 -04002377static inline unsigned start_dir_add(struct inode *dir)
2378{
2379
2380 for (;;) {
2381 unsigned n = dir->i_dir_seq;
2382 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2383 return n;
2384 cpu_relax();
2385 }
2386}
2387
2388static inline void end_dir_add(struct inode *dir, unsigned n)
2389{
2390 smp_store_release(&dir->i_dir_seq, n + 2);
2391}
2392
Al Virod9171b92016-04-15 03:33:13 -04002393static void d_wait_lookup(struct dentry *dentry)
2394{
2395 if (d_in_lookup(dentry)) {
2396 DECLARE_WAITQUEUE(wait, current);
2397 add_wait_queue(dentry->d_wait, &wait);
2398 do {
2399 set_current_state(TASK_UNINTERRUPTIBLE);
2400 spin_unlock(&dentry->d_lock);
2401 schedule();
2402 spin_lock(&dentry->d_lock);
2403 } while (d_in_lookup(dentry));
2404 }
2405}
2406
Al Viro94bdd652016-04-15 02:42:04 -04002407struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002408 const struct qstr *name,
2409 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002410{
Al Viro94bdd652016-04-15 02:42:04 -04002411 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002412 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2413 struct hlist_bl_node *node;
2414 struct dentry *new = d_alloc(parent, name);
2415 struct dentry *dentry;
2416 unsigned seq, r_seq, d_seq;
2417
2418 if (unlikely(!new))
2419 return ERR_PTR(-ENOMEM);
2420
2421retry:
2422 rcu_read_lock();
2423 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2424 r_seq = read_seqbegin(&rename_lock);
2425 dentry = __d_lookup_rcu(parent, name, &d_seq);
2426 if (unlikely(dentry)) {
2427 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2428 rcu_read_unlock();
2429 goto retry;
2430 }
2431 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2432 rcu_read_unlock();
2433 dput(dentry);
2434 goto retry;
2435 }
2436 rcu_read_unlock();
2437 dput(new);
2438 return dentry;
2439 }
2440 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2441 rcu_read_unlock();
2442 goto retry;
2443 }
2444 hlist_bl_lock(b);
2445 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2446 hlist_bl_unlock(b);
2447 rcu_read_unlock();
2448 goto retry;
2449 }
Al Viro94bdd652016-04-15 02:42:04 -04002450 /*
2451 * No changes for the parent since the beginning of d_lookup().
2452 * Since all removals from the chain happen with hlist_bl_lock(),
2453 * any potential in-lookup matches are going to stay here until
2454 * we unlock the chain. All fields are stable in everything
2455 * we encounter.
2456 */
2457 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2458 if (dentry->d_name.hash != hash)
2459 continue;
2460 if (dentry->d_parent != parent)
2461 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002462 if (!d_same_name(dentry, parent, name))
2463 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002464 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002465 /* now we can try to grab a reference */
2466 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2467 rcu_read_unlock();
2468 goto retry;
2469 }
2470
2471 rcu_read_unlock();
2472 /*
2473 * somebody is likely to be still doing lookup for it;
2474 * wait for them to finish
2475 */
Al Virod9171b92016-04-15 03:33:13 -04002476 spin_lock(&dentry->d_lock);
2477 d_wait_lookup(dentry);
2478 /*
2479 * it's not in-lookup anymore; in principle we should repeat
2480 * everything from dcache lookup, but it's likely to be what
2481 * d_lookup() would've found anyway. If it is, just return it;
2482 * otherwise we really have to repeat the whole thing.
2483 */
2484 if (unlikely(dentry->d_name.hash != hash))
2485 goto mismatch;
2486 if (unlikely(dentry->d_parent != parent))
2487 goto mismatch;
2488 if (unlikely(d_unhashed(dentry)))
2489 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002490 if (unlikely(!d_same_name(dentry, parent, name)))
2491 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002492 /* OK, it *is* a hashed match; return it */
2493 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002494 dput(new);
2495 return dentry;
2496 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002497 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002498 /* we can't take ->d_lock here; it's OK, though. */
2499 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002500 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002501 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2502 hlist_bl_unlock(b);
2503 return new;
Al Virod9171b92016-04-15 03:33:13 -04002504mismatch:
2505 spin_unlock(&dentry->d_lock);
2506 dput(dentry);
2507 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002508}
2509EXPORT_SYMBOL(d_alloc_parallel);
2510
Al Viro85c7f812016-04-14 19:52:13 -04002511void __d_lookup_done(struct dentry *dentry)
2512{
Al Viro94bdd652016-04-15 02:42:04 -04002513 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2514 dentry->d_name.hash);
2515 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002516 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002517 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002518 wake_up_all(dentry->d_wait);
2519 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002520 hlist_bl_unlock(b);
2521 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002522 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002523}
2524EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002525
2526/* inode->i_lock held if inode is non-NULL */
2527
2528static inline void __d_add(struct dentry *dentry, struct inode *inode)
2529{
Al Viro84e710d2016-04-15 00:58:55 -04002530 struct inode *dir = NULL;
2531 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002532 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002533 if (unlikely(d_in_lookup(dentry))) {
2534 dir = dentry->d_parent->d_inode;
2535 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002536 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002537 }
Al Viroed782b52016-03-09 19:52:39 -05002538 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002539 unsigned add_flags = d_flags_for_inode(inode);
2540 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2541 raw_write_seqcount_begin(&dentry->d_seq);
2542 __d_set_inode_and_type(dentry, inode, add_flags);
2543 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002544 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002545 }
Al Viro15d3c582016-07-29 17:45:21 -04002546 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002547 if (dir)
2548 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002549 spin_unlock(&dentry->d_lock);
2550 if (inode)
2551 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002552}
2553
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002554/**
Al Viro34d0d192016-03-08 21:01:03 -05002555 * d_add - add dentry to hash queues
2556 * @entry: dentry to add
2557 * @inode: The inode to attach to this dentry
2558 *
2559 * This adds the entry to the hash queues and initializes @inode.
2560 * The entry was actually filled in earlier during d_alloc().
2561 */
2562
2563void d_add(struct dentry *entry, struct inode *inode)
2564{
Al Virob9680912016-04-11 00:53:26 -04002565 if (inode) {
2566 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002567 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002568 }
Al Viroed782b52016-03-09 19:52:39 -05002569 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002570}
2571EXPORT_SYMBOL(d_add);
2572
2573/**
Al Viro668d0cd2016-03-08 12:44:17 -05002574 * d_exact_alias - find and hash an exact unhashed alias
2575 * @entry: dentry to add
2576 * @inode: The inode to go with this dentry
2577 *
2578 * If an unhashed dentry with the same name/parent and desired
2579 * inode already exists, hash and return it. Otherwise, return
2580 * NULL.
2581 *
2582 * Parent directory should be locked.
2583 */
2584struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2585{
2586 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002587 unsigned int hash = entry->d_name.hash;
2588
2589 spin_lock(&inode->i_lock);
2590 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2591 /*
2592 * Don't need alias->d_lock here, because aliases with
2593 * d_parent == entry->d_parent are not subject to name or
2594 * parent changes, because the parent inode i_mutex is held.
2595 */
2596 if (alias->d_name.hash != hash)
2597 continue;
2598 if (alias->d_parent != entry->d_parent)
2599 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002600 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002601 continue;
2602 spin_lock(&alias->d_lock);
2603 if (!d_unhashed(alias)) {
2604 spin_unlock(&alias->d_lock);
2605 alias = NULL;
2606 } else {
2607 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002608 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002609 spin_unlock(&alias->d_lock);
2610 }
2611 spin_unlock(&inode->i_lock);
2612 return alias;
2613 }
2614 spin_unlock(&inode->i_lock);
2615 return NULL;
2616}
2617EXPORT_SYMBOL(d_exact_alias);
2618
2619/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002620 * dentry_update_name_case - update case insensitive dentry with a new name
2621 * @dentry: dentry to be updated
2622 * @name: new name
2623 *
2624 * Update a case insensitive dentry with new case of name.
2625 *
2626 * dentry must have been returned by d_lookup with name @name. Old and new
2627 * name lengths must match (ie. no d_compare which allows mismatched name
2628 * lengths).
2629 *
2630 * Parent inode i_mutex must be held over d_lookup and into this call (to
2631 * keep renames and concurrent inserts, and readdir(2) away).
2632 */
Al Viro9aba36d2016-07-20 22:28:45 -04002633void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002634{
Al Viro59551022016-01-22 15:40:57 -05002635 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002636 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2637
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002638 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002639 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002640 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002641 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002642 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002643}
2644EXPORT_SYMBOL(dentry_update_name_case);
2645
Al Viro8d85b482014-09-29 14:54:27 -04002646static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647{
Al Viro8d85b482014-09-29 14:54:27 -04002648 if (unlikely(dname_external(target))) {
2649 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 /*
2651 * Both external: swap the pointers
2652 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002653 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 } else {
2655 /*
2656 * dentry:internal, target:external. Steal target's
2657 * storage and make target internal.
2658 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002659 memcpy(target->d_iname, dentry->d_name.name,
2660 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 dentry->d_name.name = target->d_name.name;
2662 target->d_name.name = target->d_iname;
2663 }
2664 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002665 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 /*
2667 * dentry:external, target:internal. Give dentry's
2668 * storage to target and make dentry internal
2669 */
2670 memcpy(dentry->d_iname, target->d_name.name,
2671 target->d_name.len + 1);
2672 target->d_name.name = dentry->d_name.name;
2673 dentry->d_name.name = dentry->d_iname;
2674 } else {
2675 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002676 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002678 unsigned int i;
2679 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002680 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2681 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002682 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2683 swap(((long *) &dentry->d_iname)[i],
2684 ((long *) &target->d_iname)[i]);
2685 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 }
2687 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002688 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689}
2690
Al Viro8d85b482014-09-29 14:54:27 -04002691static void copy_name(struct dentry *dentry, struct dentry *target)
2692{
2693 struct external_name *old_name = NULL;
2694 if (unlikely(dname_external(dentry)))
2695 old_name = external_name(dentry);
2696 if (unlikely(dname_external(target))) {
2697 atomic_inc(&external_name(target)->u.count);
2698 dentry->d_name = target->d_name;
2699 } else {
2700 memcpy(dentry->d_iname, target->d_name.name,
2701 target->d_name.len + 1);
2702 dentry->d_name.name = dentry->d_iname;
2703 dentry->d_name.hash_len = target->d_name.hash_len;
2704 }
2705 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2706 kfree_rcu(old_name, u.head);
2707}
2708
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002709static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2710{
2711 /*
2712 * XXXX: do we really need to take target->d_lock?
2713 */
2714 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2715 spin_lock(&target->d_parent->d_lock);
2716 else {
2717 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2718 spin_lock(&dentry->d_parent->d_lock);
2719 spin_lock_nested(&target->d_parent->d_lock,
2720 DENTRY_D_LOCK_NESTED);
2721 } else {
2722 spin_lock(&target->d_parent->d_lock);
2723 spin_lock_nested(&dentry->d_parent->d_lock,
2724 DENTRY_D_LOCK_NESTED);
2725 }
2726 }
2727 if (target < dentry) {
2728 spin_lock_nested(&target->d_lock, 2);
2729 spin_lock_nested(&dentry->d_lock, 3);
2730 } else {
2731 spin_lock_nested(&dentry->d_lock, 2);
2732 spin_lock_nested(&target->d_lock, 3);
2733 }
2734}
2735
Al Viro986c01942014-09-26 23:11:15 -04002736static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002737{
2738 if (target->d_parent != dentry->d_parent)
2739 spin_unlock(&dentry->d_parent->d_lock);
2740 if (target->d_parent != target)
2741 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002742 spin_unlock(&target->d_lock);
2743 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002744}
2745
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002747 * When switching names, the actual string doesn't strictly have to
2748 * be preserved in the target - because we're dropping the target
2749 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002750 * the new name before we switch, unless we are going to rehash
2751 * it. Note that if we *do* unhash the target, we are not allowed
2752 * to rehash it without giving it a new name/hash key - whether
2753 * we swap or overwrite the names here, resulting name won't match
2754 * the reality in filesystem; it's only there for d_path() purposes.
2755 * Note that all of this is happening under rename_lock, so the
2756 * any hash lookup seeing it in the middle of manipulations will
2757 * be discarded anyway. So we do not care what happens to the hash
2758 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002760/*
Al Viro18367502011-07-12 21:42:24 -04002761 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 * @dentry: entry to move
2763 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002764 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 *
2766 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002767 * dcache entries should not be moved in this way. Caller must hold
2768 * rename_lock, the i_mutex of the source and target directories,
2769 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002771static void __d_move(struct dentry *dentry, struct dentry *target,
2772 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773{
Al Viro84e710d2016-04-15 00:58:55 -04002774 struct inode *dir = NULL;
2775 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 if (!dentry->d_inode)
2777 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2778
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002779 BUG_ON(d_ancestor(dentry, target));
2780 BUG_ON(d_ancestor(target, dentry));
2781
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002782 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002783 if (unlikely(d_in_lookup(target))) {
2784 dir = target->d_parent->d_inode;
2785 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002786 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788
Nick Piggin31e6b012011-01-07 17:49:52 +11002789 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002790 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002791
Al Viro15d3c582016-07-29 17:45:21 -04002792 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002793 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002794 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 __d_drop(target);
2796
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002798 if (exchange)
2799 swap_names(dentry, target);
2800 else
2801 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802
Al Viro15d3c582016-07-29 17:45:21 -04002803 /* rehash in new place(s) */
2804 __d_rehash(dentry);
2805 if (exchange)
2806 __d_rehash(target);
2807
Al Viro63cf4272014-09-26 23:06:14 -04002808 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002810 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002811 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 dentry->d_parent = target->d_parent;
2813 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002814 list_del_init(&target->d_child);
2815 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002817 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002818 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002819 list_move(&target->d_child, &target->d_parent->d_subdirs);
2820 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002821 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002822 fsnotify_update_flags(target);
2823 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 }
2825
Nick Piggin31e6b012011-01-07 17:49:52 +11002826 write_seqcount_end(&target->d_seq);
2827 write_seqcount_end(&dentry->d_seq);
2828
Al Viro84e710d2016-04-15 00:58:55 -04002829 if (dir)
2830 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002831 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002832}
2833
2834/*
2835 * d_move - move a dentry
2836 * @dentry: entry to move
2837 * @target: new dentry
2838 *
2839 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002840 * dcache entries should not be moved in this way. See the locking
2841 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002842 */
2843void d_move(struct dentry *dentry, struct dentry *target)
2844{
2845 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002846 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002848}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002849EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850
Miklos Szeredida1ce062014-04-01 17:08:43 +02002851/*
2852 * d_exchange - exchange two dentries
2853 * @dentry1: first dentry
2854 * @dentry2: second dentry
2855 */
2856void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2857{
2858 write_seqlock(&rename_lock);
2859
2860 WARN_ON(!dentry1->d_inode);
2861 WARN_ON(!dentry2->d_inode);
2862 WARN_ON(IS_ROOT(dentry1));
2863 WARN_ON(IS_ROOT(dentry2));
2864
2865 __d_move(dentry1, dentry2, true);
2866
2867 write_sequnlock(&rename_lock);
2868}
2869
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002870/**
2871 * d_ancestor - search for an ancestor
2872 * @p1: ancestor dentry
2873 * @p2: child dentry
2874 *
2875 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2876 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002877 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002878struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002879{
2880 struct dentry *p;
2881
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002882 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002883 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002884 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002885 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002886 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002887}
2888
2889/*
2890 * This helper attempts to cope with remotely renamed directories
2891 *
2892 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002893 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002894 *
2895 * Note: If ever the locking in lock_rename() changes, then please
2896 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002897 */
Al Virob5ae6b12014-10-12 22:16:02 -04002898static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002899 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002900{
Al Viro9902af72016-04-15 15:08:36 -04002901 struct mutex *m1 = NULL;
2902 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002903 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002904
2905 /* If alias and dentry share a parent, then no extra locks required */
2906 if (alias->d_parent == dentry->d_parent)
2907 goto out_unalias;
2908
Trond Myklebust9eaef272006-10-21 10:24:20 -07002909 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2911 goto out_err;
2912 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002913 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002915 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002916out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002917 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002918 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002919out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002920 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002921 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002922 if (m1)
2923 mutex_unlock(m1);
2924 return ret;
2925}
2926
David Howells770bfad2006-08-22 20:06:07 -04002927/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002928 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2929 * @inode: the inode which may have a disconnected dentry
2930 * @dentry: a negative dentry which we want to point to the inode.
2931 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002932 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2933 * place of the given dentry and return it, else simply d_add the inode
2934 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002935 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002936 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2937 * we should error out: directories can't have multiple aliases.
2938 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002939 * This is needed in the lookup routine of any filesystem that is exportable
2940 * (via knfsd) so that we can build dcache paths to directories effectively.
2941 *
2942 * If a dentry was found and moved, then it is returned. Otherwise NULL
2943 * is returned. This matches the expected return value of ->lookup.
2944 *
2945 * Cluster filesystems may call this function with a negative, hashed dentry.
2946 * In that case, we know that the inode will be a regular file, and also this
2947 * will only occur during atomic_open. So we need to check for the dentry
2948 * being already hashed only in the final case.
2949 */
2950struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2951{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002952 if (IS_ERR(inode))
2953 return ERR_CAST(inode);
2954
David Howells770bfad2006-08-22 20:06:07 -04002955 BUG_ON(!d_unhashed(dentry));
2956
Al Virode689f52016-03-09 18:05:42 -05002957 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002958 goto out;
Al Virode689f52016-03-09 18:05:42 -05002959
Al Virob9680912016-04-11 00:53:26 -04002960 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002961 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002962 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002963 struct dentry *new = __d_find_any_alias(inode);
2964 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002965 /* The reference to new ensures it remains an alias */
2966 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002967 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002968 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002969 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002970 dput(new);
2971 new = ERR_PTR(-ELOOP);
2972 pr_warn_ratelimited(
2973 "VFS: Lookup of '%s' in %s %s"
2974 " would have caused loop\n",
2975 dentry->d_name.name,
2976 inode->i_sb->s_type->name,
2977 inode->i_sb->s_id);
2978 } else if (!IS_ROOT(new)) {
2979 int err = __d_unalias(inode, dentry, new);
2980 write_sequnlock(&rename_lock);
2981 if (err) {
2982 dput(new);
2983 new = ERR_PTR(err);
2984 }
Al Viro18367502011-07-12 21:42:24 -04002985 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002986 __d_move(new, dentry, false);
2987 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002988 }
Al Virob5ae6b12014-10-12 22:16:02 -04002989 iput(inode);
2990 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002991 }
David Howells770bfad2006-08-22 20:06:07 -04002992 }
Al Virob5ae6b12014-10-12 22:16:02 -04002993out:
Al Viroed782b52016-03-09 19:52:39 -05002994 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002995 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002996}
Al Virob5ae6b12014-10-12 22:16:02 -04002997EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002998
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002999static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003000{
3001 *buflen -= namelen;
3002 if (*buflen < 0)
3003 return -ENAMETOOLONG;
3004 *buffer -= namelen;
3005 memcpy(*buffer, str, namelen);
3006 return 0;
3007}
3008
Waiman Long232d2d62013-09-09 12:18:13 -04003009/**
3010 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003011 * @buffer: buffer pointer
3012 * @buflen: allocated length of the buffer
3013 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003014 *
3015 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3016 * make sure that either the old or the new name pointer and length are
3017 * fetched. However, there may be mismatch between length and pointer.
3018 * The length cannot be trusted, we need to copy it byte-by-byte until
3019 * the length is reached or a null byte is found. It also prepends "/" at
3020 * the beginning of the name. The sequence number check at the caller will
3021 * retry it again when a d_move() does happen. So any garbage in the buffer
3022 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003023 *
3024 * Data dependency barrier is needed to make sure that we see that terminating
3025 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003026 */
Al Viro9aba36d2016-07-20 22:28:45 -04003027static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003028{
Waiman Long232d2d62013-09-09 12:18:13 -04003029 const char *dname = ACCESS_ONCE(name->name);
3030 u32 dlen = ACCESS_ONCE(name->len);
3031 char *p;
3032
Al Viro6d13f692014-09-29 14:46:30 -04003033 smp_read_barrier_depends();
3034
Waiman Long232d2d62013-09-09 12:18:13 -04003035 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003036 if (*buflen < 0)
3037 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003038 p = *buffer -= dlen + 1;
3039 *p++ = '/';
3040 while (dlen--) {
3041 char c = *dname++;
3042 if (!c)
3043 break;
3044 *p++ = c;
3045 }
3046 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003047}
3048
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003050 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003051 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003052 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003053 * @buffer: pointer to the end of the buffer
3054 * @buflen: pointer to buffer length
3055 *
Waiman Long18129972013-09-12 10:55:35 -04003056 * The function will first try to write out the pathname without taking any
3057 * lock other than the RCU read lock to make sure that dentries won't go away.
3058 * It only checks the sequence number of the global rename_lock as any change
3059 * in the dentry's d_seq will be preceded by changes in the rename_lock
3060 * sequence number. If the sequence number had been changed, it will restart
3061 * the whole pathname back-tracing sequence again by taking the rename_lock.
3062 * In this case, there is no need to take the RCU read lock as the recursive
3063 * parent pointer references will keep the dentry chain alive as long as no
3064 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003065 */
Al Viro02125a82011-12-05 08:43:34 -05003066static int prepend_path(const struct path *path,
3067 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003068 char **buffer, int *buflen)
3069{
Al Viroede4ceb2013-11-13 07:45:40 -05003070 struct dentry *dentry;
3071 struct vfsmount *vfsmnt;
3072 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003073 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003074 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003075 char *bptr;
3076 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003077
Al Viro48f5ec22013-09-09 15:22:25 -04003078 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003079restart_mnt:
3080 read_seqbegin_or_lock(&mount_lock, &m_seq);
3081 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003082 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003083restart:
3084 bptr = *buffer;
3085 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003086 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003087 dentry = path->dentry;
3088 vfsmnt = path->mnt;
3089 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003090 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003091 while (dentry != root->dentry || vfsmnt != root->mnt) {
3092 struct dentry * parent;
3093
3094 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003095 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003096 /* Escaped? */
3097 if (dentry != vfsmnt->mnt_root) {
3098 bptr = *buffer;
3099 blen = *buflen;
3100 error = 3;
3101 break;
3102 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003103 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003104 if (mnt != parent) {
3105 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3106 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003107 vfsmnt = &mnt->mnt;
3108 continue;
3109 }
Waiman Long232d2d62013-09-09 12:18:13 -04003110 if (!error)
3111 error = is_mounted(vfsmnt) ? 1 : 2;
3112 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003113 }
3114 parent = dentry->d_parent;
3115 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003116 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003117 if (error)
3118 break;
3119
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003120 dentry = parent;
3121 }
Al Viro48f5ec22013-09-09 15:22:25 -04003122 if (!(seq & 1))
3123 rcu_read_unlock();
3124 if (need_seqretry(&rename_lock, seq)) {
3125 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003126 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003127 }
Al Viro48f5ec22013-09-09 15:22:25 -04003128 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003129
3130 if (!(m_seq & 1))
3131 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003132 if (need_seqretry(&mount_lock, m_seq)) {
3133 m_seq = 1;
3134 goto restart_mnt;
3135 }
3136 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003137
Waiman Long232d2d62013-09-09 12:18:13 -04003138 if (error >= 0 && bptr == *buffer) {
3139 if (--blen < 0)
3140 error = -ENAMETOOLONG;
3141 else
3142 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003143 }
Waiman Long232d2d62013-09-09 12:18:13 -04003144 *buffer = bptr;
3145 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003146 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003147}
3148
3149/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003150 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003151 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003152 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003153 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154 * @buflen: buffer length
3155 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003156 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003158 * Returns a pointer into the buffer or an error code if the
3159 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003160 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003161 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003162 *
Al Viro02125a82011-12-05 08:43:34 -05003163 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164 */
Al Viro02125a82011-12-05 08:43:34 -05003165char *__d_path(const struct path *path,
3166 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003167 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003169 char *res = buf + buflen;
3170 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003172 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003173 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003174
Al Viro02125a82011-12-05 08:43:34 -05003175 if (error < 0)
3176 return ERR_PTR(error);
3177 if (error > 0)
3178 return NULL;
3179 return res;
3180}
3181
3182char *d_absolute_path(const struct path *path,
3183 char *buf, int buflen)
3184{
3185 struct path root = {};
3186 char *res = buf + buflen;
3187 int error;
3188
3189 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003190 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003191
3192 if (error > 1)
3193 error = -EINVAL;
3194 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003195 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003196 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197}
3198
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003199/*
3200 * same as __d_path but appends "(deleted)" for unlinked files.
3201 */
Al Viro02125a82011-12-05 08:43:34 -05003202static int path_with_deleted(const struct path *path,
3203 const struct path *root,
3204 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003205{
3206 prepend(buf, buflen, "\0", 1);
3207 if (d_unlinked(path->dentry)) {
3208 int error = prepend(buf, buflen, " (deleted)", 10);
3209 if (error)
3210 return error;
3211 }
3212
3213 return prepend_path(path, root, buf, buflen);
3214}
3215
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003216static int prepend_unreachable(char **buffer, int *buflen)
3217{
3218 return prepend(buffer, buflen, "(unreachable)", 13);
3219}
3220
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003221static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3222{
3223 unsigned seq;
3224
3225 do {
3226 seq = read_seqcount_begin(&fs->seq);
3227 *root = fs->root;
3228 } while (read_seqcount_retry(&fs->seq, seq));
3229}
3230
Jan Bluncka03a8a702008-02-14 19:38:32 -08003231/**
3232 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003233 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003234 * @buf: buffer to return value in
3235 * @buflen: buffer length
3236 *
3237 * Convert a dentry into an ASCII path name. If the entry has been deleted
3238 * the string " (deleted)" is appended. Note that this is ambiguous.
3239 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003240 * Returns a pointer into the buffer or an error code if the path was
3241 * too long. Note: Callers should use the returned pointer, not the passed
3242 * in buffer, to use the name! The implementation often starts at an offset
3243 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003244 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003245 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003246 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003247char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003249 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003250 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003251 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003253 /*
3254 * We have various synthetic filesystems that never get mounted. On
3255 * these filesystems dentries are never used for lookup purposes, and
3256 * thus don't need to be hashed. They also don't need a name until a
3257 * user wants to identify the object in /proc/pid/fd/. The little hack
3258 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003259 *
3260 * Some pseudo inodes are mountable. When they are mounted
3261 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3262 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003263 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003264 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3265 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003266 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003267
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003268 rcu_read_lock();
3269 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003270 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003271 rcu_read_unlock();
3272
Al Viro02125a82011-12-05 08:43:34 -05003273 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003274 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275 return res;
3276}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003277EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278
3279/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003280 * Helper function for dentry_operations.d_dname() members
3281 */
3282char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3283 const char *fmt, ...)
3284{
3285 va_list args;
3286 char temp[64];
3287 int sz;
3288
3289 va_start(args, fmt);
3290 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3291 va_end(args);
3292
3293 if (sz > sizeof(temp) || sz > buflen)
3294 return ERR_PTR(-ENAMETOOLONG);
3295
3296 buffer += buflen - sz;
3297 return memcpy(buffer, temp, sz);
3298}
3299
Al Viro118b2302013-08-24 12:08:17 -04003300char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3301{
3302 char *end = buffer + buflen;
3303 /* these dentries are never renamed, so d_lock is not needed */
3304 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003305 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003306 prepend(&end, &buflen, "/", 1))
3307 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003308 return end;
Al Viro118b2302013-08-24 12:08:17 -04003309}
David Herrmann31bbe162014-01-03 14:09:47 +01003310EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003311
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003312/*
Ram Pai6092d042008-03-27 13:06:20 +01003313 * Write full pathname from the root of the filesystem into the buffer.
3314 */
Al Virof6500802014-01-26 12:37:55 -05003315static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003316{
Al Virof6500802014-01-26 12:37:55 -05003317 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003318 char *end, *retval;
3319 int len, seq = 0;
3320 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003321
Al Virof6500802014-01-26 12:37:55 -05003322 if (buflen < 2)
3323 goto Elong;
3324
Al Viro48f5ec22013-09-09 15:22:25 -04003325 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003326restart:
Al Virof6500802014-01-26 12:37:55 -05003327 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003328 end = buf + buflen;
3329 len = buflen;
3330 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003331 /* Get '/' right */
3332 retval = end-1;
3333 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003334 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003335 while (!IS_ROOT(dentry)) {
3336 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003337
Ram Pai6092d042008-03-27 13:06:20 +01003338 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003339 error = prepend_name(&end, &len, &dentry->d_name);
3340 if (error)
3341 break;
Ram Pai6092d042008-03-27 13:06:20 +01003342
3343 retval = end;
3344 dentry = parent;
3345 }
Al Viro48f5ec22013-09-09 15:22:25 -04003346 if (!(seq & 1))
3347 rcu_read_unlock();
3348 if (need_seqretry(&rename_lock, seq)) {
3349 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003350 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003351 }
3352 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003353 if (error)
3354 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003355 return retval;
3356Elong:
3357 return ERR_PTR(-ENAMETOOLONG);
3358}
Nick Pigginec2447c2011-01-07 17:49:29 +11003359
3360char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3361{
Waiman Long232d2d62013-09-09 12:18:13 -04003362 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003363}
3364EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003365
3366char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3367{
3368 char *p = NULL;
3369 char *retval;
3370
Al Viroc1031352010-06-06 22:31:14 -04003371 if (d_unlinked(dentry)) {
3372 p = buf + buflen;
3373 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3374 goto Elong;
3375 buflen++;
3376 }
3377 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003378 if (!IS_ERR(retval) && p)
3379 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003380 return retval;
3381Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003382 return ERR_PTR(-ENAMETOOLONG);
3383}
3384
Linus Torvalds8b19e342013-09-12 10:35:47 -07003385static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3386 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003387{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003388 unsigned seq;
3389
3390 do {
3391 seq = read_seqcount_begin(&fs->seq);
3392 *root = fs->root;
3393 *pwd = fs->pwd;
3394 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003395}
3396
Ram Pai6092d042008-03-27 13:06:20 +01003397/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398 * NOTE! The user-level library version returns a
3399 * character pointer. The kernel system call just
3400 * returns the length of the buffer filled (which
3401 * includes the ending '\0' character), or a negative
3402 * error value. So libc would do something like
3403 *
3404 * char *getcwd(char * buf, size_t size)
3405 * {
3406 * int retval;
3407 *
3408 * retval = sys_getcwd(buf, size);
3409 * if (retval >= 0)
3410 * return buf;
3411 * errno = -retval;
3412 * return NULL;
3413 * }
3414 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003415SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003416{
Linus Torvalds552ce542007-02-13 12:08:18 -08003417 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003418 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003419 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420
3421 if (!page)
3422 return -ENOMEM;
3423
Linus Torvalds8b19e342013-09-12 10:35:47 -07003424 rcu_read_lock();
3425 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003426
Linus Torvalds552ce542007-02-13 12:08:18 -08003427 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003428 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003429 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003430 char *cwd = page + PATH_MAX;
3431 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003433 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003434 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003435 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003436
Al Viro02125a82011-12-05 08:43:34 -05003437 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003438 goto out;
3439
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003440 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003441 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003442 error = prepend_unreachable(&cwd, &buflen);
3443 if (error)
3444 goto out;
3445 }
3446
Linus Torvalds552ce542007-02-13 12:08:18 -08003447 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003448 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003449 if (len <= size) {
3450 error = len;
3451 if (copy_to_user(buf, cwd, len))
3452 error = -EFAULT;
3453 }
Nick Piggin949854d2011-01-07 17:49:37 +11003454 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003455 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457
3458out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003459 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460 return error;
3461}
3462
3463/*
3464 * Test whether new_dentry is a subdirectory of old_dentry.
3465 *
3466 * Trivially implemented using the dcache structure
3467 */
3468
3469/**
3470 * is_subdir - is new dentry a subdirectory of old_dentry
3471 * @new_dentry: new dentry
3472 * @old_dentry: old dentry
3473 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003474 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3475 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3477 */
3478
Yaowei Baia6e57872015-11-17 14:40:11 +08003479bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003480{
Yaowei Baia6e57872015-11-17 14:40:11 +08003481 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003482 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003484 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003485 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003486
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003487 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003488 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003490 /*
3491 * Need rcu_readlock to protect against the d_parent trashing
3492 * due to d_move
3493 */
3494 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003495 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003496 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003497 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003498 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003499 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501
3502 return result;
3503}
3504
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003505static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003507 struct dentry *root = data;
3508 if (dentry != root) {
3509 if (d_unhashed(dentry) || !dentry->d_inode)
3510 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003512 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3513 dentry->d_flags |= DCACHE_GENOCIDE;
3514 dentry->d_lockref.count--;
3515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003517 return D_WALK_CONTINUE;
3518}
Nick Piggin58db63d2011-01-07 17:49:39 +11003519
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003520void d_genocide(struct dentry *parent)
3521{
3522 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523}
3524
Al Viro60545d02013-06-07 01:20:27 -04003525void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526{
Al Viro60545d02013-06-07 01:20:27 -04003527 inode_dec_link_count(inode);
3528 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003529 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003530 !d_unlinked(dentry));
3531 spin_lock(&dentry->d_parent->d_lock);
3532 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3533 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3534 (unsigned long long)inode->i_ino);
3535 spin_unlock(&dentry->d_lock);
3536 spin_unlock(&dentry->d_parent->d_lock);
3537 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003538}
Al Viro60545d02013-06-07 01:20:27 -04003539EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540
3541static __initdata unsigned long dhash_entries;
3542static int __init set_dhash_entries(char *str)
3543{
3544 if (!str)
3545 return 0;
3546 dhash_entries = simple_strtoul(str, &str, 0);
3547 return 1;
3548}
3549__setup("dhash_entries=", set_dhash_entries);
3550
3551static void __init dcache_init_early(void)
3552{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003553 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554
3555 /* If hashes are distributed across NUMA nodes, defer
3556 * hash allocation until vmalloc space is available.
3557 */
3558 if (hashdist)
3559 return;
3560
3561 dentry_hashtable =
3562 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003563 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564 dhash_entries,
3565 13,
3566 HASH_EARLY,
3567 &d_hash_shift,
3568 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003569 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570 0);
3571
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003572 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003573 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574}
3575
Denis Cheng74bf17c2007-10-16 23:26:30 -07003576static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003578 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003579
3580 /*
3581 * A constructor could be added for stable state like the lists,
3582 * but it is probably not worth it because of the cache nature
3583 * of the dcache.
3584 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003585 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003586 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587
3588 /* Hash may have been set up in dcache_init_early */
3589 if (!hashdist)
3590 return;
3591
3592 dentry_hashtable =
3593 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003594 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003595 dhash_entries,
3596 13,
3597 0,
3598 &d_hash_shift,
3599 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003600 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601 0);
3602
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003603 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003604 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605}
3606
3607/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003608struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003609EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610
Linus Torvalds1da177e2005-04-16 15:20:36 -07003611EXPORT_SYMBOL(d_genocide);
3612
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613void __init vfs_caches_init_early(void)
3614{
3615 dcache_init_early();
3616 inode_init_early();
3617}
3618
Mel Gorman4248b0d2015-08-06 15:46:20 -07003619void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003620{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003622 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003623
Denis Cheng74bf17c2007-10-16 23:26:30 -07003624 dcache_init();
3625 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003626 files_init();
3627 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003628 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003629 bdev_cache_init();
3630 chrdev_init();
3631}