blob: 9522b8b638714ff65b73e6b8ee0acb03f6d3cc61 [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>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080041#include <linux/kasan.h>
42
David Howells07f3f052006-09-30 20:52:18 +020043#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050044#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nick Piggin789680d2011-01-07 17:49:30 +110046/*
47 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110048 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040049 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110050 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100054 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110055 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110060 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110061 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110062 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040064 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110065 *
66 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110067 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110068 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100069 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110070 * dcache_hash_bucket lock
71 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110072 *
Nick Pigginda502952011-01-07 17:49:33 +110073 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110080 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080084int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
Al Viro74c3cbe2007-07-22 08:04:18 -040087__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Nick Piggin949854d2011-01-07 17:49:37 +110089EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Christoph Lametere18b8902006-12-06 20:33:20 -080091static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700105static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106
Linus Torvalds8387ff22016-06-10 07:51:30 -0700107static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108{
Linus Torvalds99d263d2014-09-13 11:30:10 -0700109 return dentry_hashtable + hash_32(hash, d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Al Viro94bdd652016-04-15 02:42:04 -0400112#define IN_LOOKUP_SHIFT 10
113static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
114
115static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
116 unsigned int hash)
117{
118 hash += (unsigned long) parent / L1_CACHE_BYTES;
119 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
120}
121
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Statistics gathering. */
124struct dentry_stat_t dentry_stat = {
125 .age_limit = 45,
126};
127
Glauber Costa3942c072013-08-28 10:17:53 +1000128static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000129static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400130
131#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000132
133/*
134 * Here we resort to our own counters instead of using generic per-cpu counters
135 * for consistency with what the vfs inode code does. We are expected to harvest
136 * better code and performance by having our own specialized counters.
137 *
138 * Please note that the loop is done over all possible CPUs, not over all online
139 * CPUs. The reason for this is that we don't want to play games with CPUs going
140 * on and off. If one of them goes off, we will just keep their counters.
141 *
142 * glommer: See cffbc8a for details, and if you ever intend to change this,
143 * please update all vfs counters to match.
144 */
Glauber Costa3942c072013-08-28 10:17:53 +1000145static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146{
147 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000148 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry, i);
151 return sum < 0 ? 0 : sum;
152}
153
Dave Chinner62d36c72013-08-28 10:17:54 +1000154static long get_nr_dentry_unused(void)
155{
156 int i;
157 long sum = 0;
158 for_each_possible_cpu(i)
159 sum += per_cpu(nr_dentry_unused, i);
160 return sum < 0 ? 0 : sum;
161}
162
Joe Perches1f7e0612014-06-06 14:38:05 -0700163int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400164 size_t *lenp, loff_t *ppos)
165{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000167 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000168 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169}
170#endif
171
Linus Torvalds5483f182012-03-04 15:51:42 -0800172/*
173 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
174 * The strings are both count bytes long, and count is non-zero.
175 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700176#ifdef CONFIG_DCACHE_WORD_ACCESS
177
178#include <asm/word-at-a-time.h>
179/*
180 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
181 * aligned allocation for this particular component. We don't
182 * strictly need the load_unaligned_zeropad() safety, but it
183 * doesn't hurt either.
184 *
185 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
186 * need the careful unaligned handling.
187 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700188static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800189{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800190 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191
192 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700193 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700194 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 if (tcount < sizeof(unsigned long))
196 break;
197 if (unlikely(a != b))
198 return 1;
199 cs += sizeof(unsigned long);
200 ct += sizeof(unsigned long);
201 tcount -= sizeof(unsigned long);
202 if (!tcount)
203 return 0;
204 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000205 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800206 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700207}
208
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800209#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210
Linus Torvalds94753db52012-05-10 12:19:19 -0700211static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212{
Linus Torvalds5483f182012-03-04 15:51:42 -0800213 do {
214 if (*cs != *ct)
215 return 1;
216 cs++;
217 ct++;
218 tcount--;
219 } while (tcount);
220 return 0;
221}
222
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700223#endif
224
Linus Torvalds94753db52012-05-10 12:19:19 -0700225static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
226{
Linus Torvalds6326c712012-05-21 16:14:04 -0700227 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700228 /*
229 * Be careful about RCU walk racing with rename:
230 * use ACCESS_ONCE to fetch the name pointer.
231 *
232 * NOTE! Even if a rename will mean that the length
233 * was not loaded atomically, we don't care. The
234 * RCU walk will check the sequence count eventually,
235 * and catch it. And we won't overrun the buffer,
236 * because we're reading the name pointer atomically,
237 * and a dentry name is guaranteed to be properly
238 * terminated with a NUL byte.
239 *
240 * End result: even if 'len' is wrong, we'll exit
241 * early because the data cannot match (there can
242 * be no NUL in the ct/tcount data)
243 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700244 cs = ACCESS_ONCE(dentry->d_name.name);
245 smp_read_barrier_depends();
246 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700247}
248
Al Viro8d85b482014-09-29 14:54:27 -0400249struct external_name {
250 union {
251 atomic_t count;
252 struct rcu_head head;
253 } u;
254 unsigned char name[];
255};
256
257static inline struct external_name *external_name(struct dentry *dentry)
258{
259 return container_of(dentry->d_name.name, struct external_name, name[0]);
260}
261
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400262static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
265
Al Viro8d85b482014-09-29 14:54:27 -0400266 kmem_cache_free(dentry_cache, dentry);
267}
268
269static void __d_free_external(struct rcu_head *head)
270{
271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400272 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 kmem_cache_free(dentry_cache, dentry);
274}
275
Al Viro810bb172014-10-12 12:45:37 -0400276static inline int dname_external(const struct dentry *dentry)
277{
278 return dentry->d_name.name != dentry->d_iname;
279}
280
David Howells4bf46a22015-03-05 14:09:22 +0000281static inline void __d_set_inode_and_type(struct dentry *dentry,
282 struct inode *inode,
283 unsigned type_flags)
284{
285 unsigned flags;
286
287 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000288 flags = READ_ONCE(dentry->d_flags);
289 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
290 flags |= type_flags;
291 WRITE_ONCE(dentry->d_flags, flags);
292}
293
David Howells4bf46a22015-03-05 14:09:22 +0000294static inline void __d_clear_type_and_inode(struct dentry *dentry)
295{
296 unsigned flags = READ_ONCE(dentry->d_flags);
297
298 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
299 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000300 dentry->d_inode = NULL;
301}
302
Al Virob4f03542014-04-29 23:40:14 -0400303static void dentry_free(struct dentry *dentry)
304{
Al Viro946e51f2014-10-26 19:19:16 -0400305 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400306 if (unlikely(dname_external(dentry))) {
307 struct external_name *p = external_name(dentry);
308 if (likely(atomic_dec_and_test(&p->u.count))) {
309 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
310 return;
311 }
312 }
Al Virob4f03542014-04-29 23:40:14 -0400313 /* if dentry was never visible to RCU, immediate free is OK */
314 if (!(dentry->d_flags & DCACHE_RCUACCESS))
315 __d_free(&dentry->d_u.d_rcu);
316 else
317 call_rcu(&dentry->d_u.d_rcu, __d_free);
318}
319
Nick Piggin31e6b012011-01-07 17:49:52 +1100320/**
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200321 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800322 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100323 * After this call, in-progress rcu-walk path lookup will fail. This
324 * should be called after unhashing, and after changing d_inode (if
325 * the dentry has not already been unhashed).
326 */
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200327static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
Nick Piggin31e6b012011-01-07 17:49:52 +1100328{
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200329 lockdep_assert_held(&dentry->d_lock);
330 /* Go through am invalidation barrier */
331 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100332}
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334/*
335 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100336 * d_iput() operation if defined. Dentry has no refcount
337 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800339static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200340 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100341 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
343 struct inode *inode = dentry->d_inode;
344 if (inode) {
David Howells4bf46a22015-03-05 14:09:22 +0000345 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400346 hlist_del_init(&dentry->d_u.d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100348 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700349 if (!inode->i_nlink)
350 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 if (dentry->d_op && dentry->d_op->d_iput)
352 dentry->d_op->d_iput(dentry, inode);
353 else
354 iput(inode);
355 } else {
356 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 }
358}
359
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700360/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100361 * Release the dentry's inode, using the filesystem
362 * d_iput() operation if defined. dentry remains in-use.
363 */
364static void dentry_unlink_inode(struct dentry * dentry)
365 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100366 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100367{
368 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500369
370 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000371 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400372 hlist_del_init(&dentry->d_u.d_alias);
Al Viroa528aca2016-02-29 12:12:46 -0500373 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100374 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100375 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100376 if (!inode->i_nlink)
377 fsnotify_inoderemove(inode);
378 if (dentry->d_op && dentry->d_op->d_iput)
379 dentry->d_op->d_iput(dentry, inode);
380 else
381 iput(inode);
382}
383
384/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400385 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
386 * is in use - which includes both the "real" per-superblock
387 * LRU list _and_ the DCACHE_SHRINK_LIST use.
388 *
389 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
390 * on the shrink list (ie not on the superblock LRU list).
391 *
392 * The per-cpu "nr_dentry_unused" counters are updated with
393 * the DCACHE_LRU_LIST bit.
394 *
395 * These helper functions make sure we always follow the
396 * rules. d_lock must be held by the caller.
397 */
398#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
399static void d_lru_add(struct dentry *dentry)
400{
401 D_FLAG_VERIFY(dentry, 0);
402 dentry->d_flags |= DCACHE_LRU_LIST;
403 this_cpu_inc(nr_dentry_unused);
404 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
405}
406
407static void d_lru_del(struct dentry *dentry)
408{
409 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
410 dentry->d_flags &= ~DCACHE_LRU_LIST;
411 this_cpu_dec(nr_dentry_unused);
412 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
413}
414
415static void d_shrink_del(struct dentry *dentry)
416{
417 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
418 list_del_init(&dentry->d_lru);
419 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
420 this_cpu_dec(nr_dentry_unused);
421}
422
423static void d_shrink_add(struct dentry *dentry, struct list_head *list)
424{
425 D_FLAG_VERIFY(dentry, 0);
426 list_add(&dentry->d_lru, list);
427 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
428 this_cpu_inc(nr_dentry_unused);
429}
430
431/*
432 * These can only be called under the global LRU lock, ie during the
433 * callback for freeing the LRU list. "isolate" removes it from the
434 * LRU lists entirely, while shrink_move moves it to the indicated
435 * private list.
436 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800437static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400438{
439 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
440 dentry->d_flags &= ~DCACHE_LRU_LIST;
441 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800442 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400443}
444
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800445static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
446 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400447{
448 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
449 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800450 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400451}
452
453/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000454 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700455 */
456static void dentry_lru_add(struct dentry *dentry)
457{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400458 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
459 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700460}
461
Miklos Szeredid52b9082007-05-08 00:23:46 -0700462/**
Nick Piggin789680d2011-01-07 17:49:30 +1100463 * d_drop - drop a dentry
464 * @dentry: dentry to drop
465 *
466 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
467 * be found through a VFS lookup any more. Note that this is different from
468 * deleting the dentry - d_delete will try to mark the dentry negative if
469 * possible, giving a successful _negative_ lookup, while d_drop will
470 * just make the cache lookup fail.
471 *
472 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
473 * reason (NFS timeouts or autofs deletes).
474 *
475 * __d_drop requires dentry->d_lock.
476 */
477void __d_drop(struct dentry *dentry)
478{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700479 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400480 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400481 /*
482 * Hashed dentries are normally on the dentry hashtable,
483 * with the exception of those newly allocated by
484 * d_obtain_alias, which are always IS_ROOT:
485 */
486 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400487 b = &dentry->d_sb->s_anon;
488 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700489 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400490
491 hlist_bl_lock(b);
492 __hlist_bl_del(&dentry->d_hash);
493 dentry->d_hash.pprev = NULL;
494 hlist_bl_unlock(b);
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200495 dentry_rcuwalk_invalidate(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100496 }
497}
498EXPORT_SYMBOL(__d_drop);
499
500void d_drop(struct dentry *dentry)
501{
Nick Piggin789680d2011-01-07 17:49:30 +1100502 spin_lock(&dentry->d_lock);
503 __d_drop(dentry);
504 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100505}
506EXPORT_SYMBOL(d_drop);
507
Al Viroe55fd012014-05-28 13:51:12 -0400508static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100509{
Al Viro41edf272014-05-01 10:30:00 -0400510 struct dentry *parent = NULL;
511 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400512 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100513 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100514
Linus Torvalds0d984392013-09-08 13:46:52 -0700515 /*
516 * The dentry is now unrecoverably dead to the world.
517 */
518 lockref_mark_dead(&dentry->d_lockref);
519
Sage Weilf0023bc2011-10-28 10:02:42 -0700520 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700521 * inform the fs via d_prune that this dentry is about to be
522 * unhashed and destroyed.
523 */
Al Viro29266202014-05-30 11:39:02 -0400524 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800525 dentry->d_op->d_prune(dentry);
526
Al Viro01b60352014-04-29 23:42:52 -0400527 if (dentry->d_flags & DCACHE_LRU_LIST) {
528 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
529 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400530 }
Nick Piggin77812a12011-01-07 17:49:48 +1100531 /* if it was on the hash then remove it */
532 __d_drop(dentry);
Al Viroca5358e2014-10-26 19:31:10 -0400533 __list_del_entry(&dentry->d_child);
Al Viro03b3b882014-04-29 15:45:28 -0400534 /*
535 * Inform d_walk() that we are no longer attached to the
536 * dentry tree
537 */
538 dentry->d_flags |= DCACHE_DENTRY_KILLED;
539 if (parent)
540 spin_unlock(&parent->d_lock);
541 dentry_iput(dentry);
542 /*
543 * dentry_iput drops the locks, at which point nobody (except
544 * transient RCU lookups) can reach this dentry.
545 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800546 BUG_ON(dentry->d_lockref.count > 0);
Al Viro03b3b882014-04-29 15:45:28 -0400547 this_cpu_dec(nr_dentry);
548 if (dentry->d_op && dentry->d_op->d_release)
549 dentry->d_op->d_release(dentry);
550
Al Viro41edf272014-05-01 10:30:00 -0400551 spin_lock(&dentry->d_lock);
552 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
553 dentry->d_flags |= DCACHE_MAY_FREE;
554 can_free = false;
555 }
556 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400557 if (likely(can_free))
558 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400559}
560
561/*
562 * Finish off a dentry we've decided to kill.
563 * dentry->d_lock must be held, returns with it unlocked.
564 * If ref is non-zero, then decrement the refcount too.
565 * Returns dentry requiring refcount drop, or NULL if we're done.
566 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400567static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400568 __releases(dentry->d_lock)
569{
570 struct inode *inode = dentry->d_inode;
571 struct dentry *parent = NULL;
572
573 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
574 goto failed;
575
576 if (!IS_ROOT(dentry)) {
577 parent = dentry->d_parent;
578 if (unlikely(!spin_trylock(&parent->d_lock))) {
579 if (inode)
580 spin_unlock(&inode->i_lock);
581 goto failed;
582 }
583 }
584
585 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400586 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400587
588failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400589 spin_unlock(&dentry->d_lock);
590 cpu_relax();
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:
Linus Torvalds360f5472015-01-09 15:19:03 -0800764 rcu_read_lock();
765 if (likely(fast_dput(dentry))) {
766 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800768 }
769
770 /* Slow case: now with the dentry lock held */
771 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Al Viro85c7f812016-04-14 19:52:13 -0400773 WARN_ON(d_in_lookup(dentry));
774
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700775 /* Unreachable? Get rid of it */
776 if (unlikely(d_unhashed(dentry)))
777 goto kill_it;
778
Al Viro75a6f822015-07-08 02:42:38 +0100779 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
780 goto kill_it;
781
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700782 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100784 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 }
Nick Piggin265ac902010-10-10 05:36:24 -0400786
Linus Torvalds358eec12013-10-31 15:43:02 -0700787 if (!(dentry->d_flags & DCACHE_REFERENCED))
788 dentry->d_flags |= DCACHE_REFERENCED;
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);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700797 if (dentry)
798 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700800EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100803/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100804static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805{
Waiman Long98474232013-08-28 18:24:59 -0700806 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Nick Piggindc0474b2011-01-07 17:49:43 +1100809static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100810{
Waiman Long98474232013-08-28 18:24:59 -0700811 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100812}
813
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100814struct dentry *dget_parent(struct dentry *dentry)
815{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700816 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100817 struct dentry *ret;
818
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700819 /*
820 * Do optimistic parent lookup without any
821 * locking.
822 */
823 rcu_read_lock();
824 ret = ACCESS_ONCE(dentry->d_parent);
825 gotref = lockref_get_not_zero(&ret->d_lockref);
826 rcu_read_unlock();
827 if (likely(gotref)) {
828 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
829 return ret;
830 dput(ret);
831 }
832
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100833repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100834 /*
835 * Don't need rcu_dereference because we re-check it was correct under
836 * the lock.
837 */
838 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100839 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100840 spin_lock(&ret->d_lock);
841 if (unlikely(ret != dentry->d_parent)) {
842 spin_unlock(&ret->d_lock);
843 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100844 goto repeat;
845 }
Nick Piggina734eb42011-01-07 17:49:44 +1100846 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700847 BUG_ON(!ret->d_lockref.count);
848 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100849 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100850 return ret;
851}
852EXPORT_SYMBOL(dget_parent);
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/**
855 * d_find_alias - grab a hashed alias of inode
856 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 *
858 * If inode has a hashed alias, or is a directory and has any alias,
859 * acquire the reference to alias and return it. Otherwise return NULL.
860 * Notice that if inode is a directory there can be only one alias and
861 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800862 * of a filesystem, or if the directory was renamed and d_revalidate
863 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700865 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500866 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500868static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
Nick Pigginda502952011-01-07 17:49:33 +1100870 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Nick Pigginda502952011-01-07 17:49:33 +1100872again:
873 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400874 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100875 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700877 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100878 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500880 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100881 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100882 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 return alias;
884 }
885 }
Nick Pigginda502952011-01-07 17:49:33 +1100886 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 }
Nick Pigginda502952011-01-07 17:49:33 +1100888 if (discon_alias) {
889 alias = discon_alias;
890 spin_lock(&alias->d_lock);
891 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500892 __dget_dlock(alias);
893 spin_unlock(&alias->d_lock);
894 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100895 }
896 spin_unlock(&alias->d_lock);
897 goto again;
898 }
899 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
901
Nick Pigginda502952011-01-07 17:49:33 +1100902struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
David Howells214fda12006-03-25 03:06:36 -0800904 struct dentry *de = NULL;
905
Al Virob3d9b7a2012-06-09 13:51:19 -0400906 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100907 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500908 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100909 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return de;
912}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700913EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
915/*
916 * Try to kill dentries associated with this inode.
917 * WARNING: you must own a reference to inode.
918 */
919void d_prune_aliases(struct inode *inode)
920{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700921 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100923 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400924 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700926 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400927 struct dentry *parent = lock_parent(dentry);
928 if (likely(!dentry->d_lockref.count)) {
929 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800930 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400931 goto restart;
932 }
933 if (parent)
934 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 }
936 spin_unlock(&dentry->d_lock);
937 }
Nick Piggin873feea2011-01-07 17:50:06 +1100938 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700940EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400942static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943{
Al Viro5c47e6d2014-04-29 16:13:18 -0400944 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700945
Miklos Szeredi60942f22014-05-02 15:38:39 -0400946 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400947 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400948 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100949 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400950 parent = lock_parent(dentry);
951
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000953 * The dispose list is isolated and dentries are not accounted
954 * to the LRU here, so we can simply remove it from the list
955 * here regardless of whether it is referenced or not.
956 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400957 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000958
959 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000961 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800963 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700964 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400965 if (parent)
966 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 continue;
968 }
Nick Piggin77812a12011-01-07 17:49:48 +1100969
Al Viro64fd72e2014-05-28 09:48:44 -0400970
971 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
972 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
973 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400974 if (parent)
975 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400976 if (can_free)
977 dentry_free(dentry);
978 continue;
979 }
980
Al Viroff2fde92014-05-28 13:59:13 -0400981 inode = dentry->d_inode;
982 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400983 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000984 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400985 if (parent)
986 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400987 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000988 }
Al Viroff2fde92014-05-28 13:59:13 -0400989
Al Viroff2fde92014-05-28 13:59:13 -0400990 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400991
Al Viro5c47e6d2014-04-29 16:13:18 -0400992 /*
993 * We need to prune ancestors too. This is necessary to prevent
994 * quadratic behavior of shrink_dcache_parent(), but is also
995 * expected to be beneficial in reducing dentry cache
996 * fragmentation.
997 */
998 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400999 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1000 parent = lock_parent(dentry);
1001 if (dentry->d_lockref.count != 1) {
1002 dentry->d_lockref.count--;
1003 spin_unlock(&dentry->d_lock);
1004 if (parent)
1005 spin_unlock(&parent->d_lock);
1006 break;
1007 }
1008 inode = dentry->d_inode; /* can't be NULL */
1009 if (unlikely(!spin_trylock(&inode->i_lock))) {
1010 spin_unlock(&dentry->d_lock);
1011 if (parent)
1012 spin_unlock(&parent->d_lock);
1013 cpu_relax();
1014 continue;
1015 }
1016 __dentry_kill(dentry);
1017 dentry = parent;
1018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001020}
1021
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001022static enum lru_status dentry_lru_isolate(struct list_head *item,
1023 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001024{
1025 struct list_head *freeable = arg;
1026 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1027
1028
1029 /*
1030 * we are inverting the lru lock/dentry->d_lock here,
1031 * so use a trylock. If we fail to get the lock, just skip
1032 * it
1033 */
1034 if (!spin_trylock(&dentry->d_lock))
1035 return LRU_SKIP;
1036
1037 /*
1038 * Referenced dentries are still in use. If they have active
1039 * counts, just remove them from the LRU. Otherwise give them
1040 * another pass through the LRU.
1041 */
1042 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001043 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001044 spin_unlock(&dentry->d_lock);
1045 return LRU_REMOVED;
1046 }
1047
1048 if (dentry->d_flags & DCACHE_REFERENCED) {
1049 dentry->d_flags &= ~DCACHE_REFERENCED;
1050 spin_unlock(&dentry->d_lock);
1051
1052 /*
1053 * The list move itself will be made by the common LRU code. At
1054 * this point, we've dropped the dentry->d_lock but keep the
1055 * lru lock. This is safe to do, since every list movement is
1056 * protected by the lru lock even if both locks are held.
1057 *
1058 * This is guaranteed by the fact that all LRU management
1059 * functions are intermediated by the LRU API calls like
1060 * list_lru_add and list_lru_del. List movement in this file
1061 * only ever occur through this functions or through callbacks
1062 * like this one, that are called from the LRU API.
1063 *
1064 * The only exceptions to this are functions like
1065 * shrink_dentry_list, and code that first checks for the
1066 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1067 * operating only with stack provided lists after they are
1068 * properly isolated from the main list. It is thus, always a
1069 * local access.
1070 */
1071 return LRU_ROTATE;
1072 }
1073
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001074 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001075 spin_unlock(&dentry->d_lock);
1076
1077 return LRU_REMOVED;
1078}
1079
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001080/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001081 * prune_dcache_sb - shrink the dcache
1082 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001083 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001084 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001085 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1086 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001087 * function.
1088 *
1089 * This function may fail to free any resources if all the dentries are in
1090 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001091 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001092long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093{
Dave Chinnerf6041562013-08-28 10:18:00 +10001094 LIST_HEAD(dispose);
1095 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001096
Vladimir Davydov503c3582015-02-12 14:58:47 -08001097 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1098 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001099 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001100 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101}
1102
Glauber Costa4e717f52013-08-28 10:18:03 +10001103static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001104 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001105{
Glauber Costa4e717f52013-08-28 10:18:03 +10001106 struct list_head *freeable = arg;
1107 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001108
Glauber Costa4e717f52013-08-28 10:18:03 +10001109 /*
1110 * we are inverting the lru lock/dentry->d_lock here,
1111 * so use a trylock. If we fail to get the lock, just skip
1112 * it
1113 */
1114 if (!spin_trylock(&dentry->d_lock))
1115 return LRU_SKIP;
1116
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001117 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001118 spin_unlock(&dentry->d_lock);
1119
1120 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001121}
1122
Glauber Costa4e717f52013-08-28 10:18:03 +10001123
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001124/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 * shrink_dcache_sb - shrink dcache for a superblock
1126 * @sb: superblock
1127 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128 * Shrink the dcache for the specified super block. This is used to free
1129 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001131void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132{
Glauber Costa4e717f52013-08-28 10:18:03 +10001133 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001134
Glauber Costa4e717f52013-08-28 10:18:03 +10001135 do {
1136 LIST_HEAD(dispose);
1137
1138 freed = list_lru_walk(&sb->s_dentry_lru,
1139 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1140
1141 this_cpu_sub(nr_dentry_unused, freed);
1142 shrink_dentry_list(&dispose);
1143 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001145EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001148 * enum d_walk_ret - action to talke during tree walk
1149 * @D_WALK_CONTINUE: contrinue walk
1150 * @D_WALK_QUIT: quit walk
1151 * @D_WALK_NORETRY: quit when retry is needed
1152 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001154enum d_walk_ret {
1155 D_WALK_CONTINUE,
1156 D_WALK_QUIT,
1157 D_WALK_NORETRY,
1158 D_WALK_SKIP,
1159};
1160
1161/**
1162 * d_walk - walk the dentry tree
1163 * @parent: start of walk
1164 * @data: data passed to @enter() and @finish()
1165 * @enter: callback when first entering the dentry
1166 * @finish: callback when successfully finished the walk
1167 *
1168 * The @enter() and @finish() callbacks are called with d_lock held.
1169 */
1170static void d_walk(struct dentry *parent, void *data,
1171 enum d_walk_ret (*enter)(void *, struct dentry *),
1172 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173{
Nick Piggin949854d2011-01-07 17:49:37 +11001174 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001176 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001177 enum d_walk_ret ret;
1178 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001179
Nick Piggin58db63d2011-01-07 17:49:39 +11001180again:
Al Viro48f5ec22013-09-09 15:22:25 -04001181 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001182 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001183 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001184
1185 ret = enter(data, this_parent);
1186 switch (ret) {
1187 case D_WALK_CONTINUE:
1188 break;
1189 case D_WALK_QUIT:
1190 case D_WALK_SKIP:
1191 goto out_unlock;
1192 case D_WALK_NORETRY:
1193 retry = false;
1194 break;
1195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196repeat:
1197 next = this_parent->d_subdirs.next;
1198resume:
1199 while (next != &this_parent->d_subdirs) {
1200 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001201 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001203
1204 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001205
1206 ret = enter(data, dentry);
1207 switch (ret) {
1208 case D_WALK_CONTINUE:
1209 break;
1210 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001211 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001212 goto out_unlock;
1213 case D_WALK_NORETRY:
1214 retry = false;
1215 break;
1216 case D_WALK_SKIP:
1217 spin_unlock(&dentry->d_lock);
1218 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001219 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001222 spin_unlock(&this_parent->d_lock);
1223 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001225 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 goto repeat;
1227 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001228 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230 /*
1231 * All done at this level ... ascend and resume the search.
1232 */
Al Viroca5358e2014-10-26 19:31:10 -04001233 rcu_read_lock();
1234ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001236 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001237 this_parent = child->d_parent;
1238
Al Viro31dec132013-10-25 17:04:27 -04001239 spin_unlock(&child->d_lock);
1240 spin_lock(&this_parent->d_lock);
1241
Al Viroca5358e2014-10-26 19:31:10 -04001242 /* might go back up the wrong parent if we have had a rename. */
1243 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001244 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001245 /* go into the first sibling still alive */
1246 do {
1247 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001248 if (next == &this_parent->d_subdirs)
1249 goto ascend;
1250 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001251 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001252 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 goto resume;
1254 }
Al Viroca5358e2014-10-26 19:31:10 -04001255 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001257 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001258 if (finish)
1259 finish(data);
1260
1261out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001262 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001263 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001264 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001265
1266rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001267 spin_unlock(&this_parent->d_lock);
1268 rcu_read_unlock();
1269 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001270 if (!retry)
1271 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001272 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001273 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001275
1276/*
1277 * Search for at least 1 mount point in the dentry's subdirs.
1278 * We descend to the next level whenever the d_subdirs
1279 * list is non-empty and continue searching.
1280 */
1281
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001282static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1283{
1284 int *ret = data;
1285 if (d_mountpoint(dentry)) {
1286 *ret = 1;
1287 return D_WALK_QUIT;
1288 }
1289 return D_WALK_CONTINUE;
1290}
1291
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001292/**
1293 * have_submounts - check for mounts over a dentry
1294 * @parent: dentry to check.
1295 *
1296 * Return true if the parent or its subdirectories contain
1297 * a mount point
1298 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001299int have_submounts(struct dentry *parent)
1300{
1301 int ret = 0;
1302
1303 d_walk(parent, &ret, check_mount, NULL);
1304
1305 return ret;
1306}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001307EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
1309/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001310 * Called by mount code to set a mountpoint and check if the mountpoint is
1311 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1312 * subtree can become unreachable).
1313 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001314 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001315 * this reason take rename_lock and d_lock on dentry and ancestors.
1316 */
1317int d_set_mounted(struct dentry *dentry)
1318{
1319 struct dentry *p;
1320 int ret = -ENOENT;
1321 write_seqlock(&rename_lock);
1322 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001323 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001324 spin_lock(&p->d_lock);
1325 if (unlikely(d_unhashed(p))) {
1326 spin_unlock(&p->d_lock);
1327 goto out;
1328 }
1329 spin_unlock(&p->d_lock);
1330 }
1331 spin_lock(&dentry->d_lock);
1332 if (!d_unlinked(dentry)) {
1333 dentry->d_flags |= DCACHE_MOUNTED;
1334 ret = 0;
1335 }
1336 spin_unlock(&dentry->d_lock);
1337out:
1338 write_sequnlock(&rename_lock);
1339 return ret;
1340}
1341
1342/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001343 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 * and move any unused dentries to the end of the unused
1345 * list for prune_dcache(). We descend to the next level
1346 * whenever the d_subdirs list is non-empty and continue
1347 * searching.
1348 *
1349 * It returns zero iff there are no unused children,
1350 * otherwise it returns the number of children moved to
1351 * the end of the unused list. This may not be the total
1352 * number of unused children, because select_parent can
1353 * drop the lock and return early due to latency
1354 * constraints.
1355 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001356
1357struct select_data {
1358 struct dentry *start;
1359 struct list_head dispose;
1360 int found;
1361};
1362
1363static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001365 struct select_data *data = _data;
1366 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001368 if (data->start == dentry)
1369 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
Al Virofe915222014-05-03 00:02:25 -04001371 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001372 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001373 } else {
1374 if (dentry->d_flags & DCACHE_LRU_LIST)
1375 d_lru_del(dentry);
1376 if (!dentry->d_lockref.count) {
1377 d_shrink_add(dentry, &data->dispose);
1378 data->found++;
1379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 }
1381 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001382 * We can return to the caller if we have found some (this
1383 * ensures forward progress). We'll be coming back to find
1384 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 */
Al Virofe915222014-05-03 00:02:25 -04001386 if (!list_empty(&data->dispose))
1387 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001389 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390}
1391
1392/**
1393 * shrink_dcache_parent - prune dcache
1394 * @parent: parent of entries to prune
1395 *
1396 * Prune the dcache to remove unused children of the parent dentry.
1397 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001398void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001400 for (;;) {
1401 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001403 INIT_LIST_HEAD(&data.dispose);
1404 data.start = parent;
1405 data.found = 0;
1406
1407 d_walk(parent, &data, select_collect, NULL);
1408 if (!data.found)
1409 break;
1410
1411 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001412 cond_resched();
1413 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001415EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Al Viro9c8c10e2014-05-02 20:36:10 -04001417static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001418{
Al Viro9c8c10e2014-05-02 20:36:10 -04001419 /* it has busy descendents; complain about those instead */
1420 if (!list_empty(&dentry->d_subdirs))
1421 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001422
Al Viro9c8c10e2014-05-02 20:36:10 -04001423 /* root with refcount 1 is fine */
1424 if (dentry == _data && dentry->d_lockref.count == 1)
1425 return D_WALK_CONTINUE;
1426
1427 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1428 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001429 dentry,
1430 dentry->d_inode ?
1431 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001432 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001433 dentry->d_lockref.count,
1434 dentry->d_sb->s_type->name,
1435 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001436 WARN_ON(1);
1437 return D_WALK_CONTINUE;
1438}
1439
1440static void do_one_tree(struct dentry *dentry)
1441{
1442 shrink_dcache_parent(dentry);
1443 d_walk(dentry, dentry, umount_check, NULL);
1444 d_drop(dentry);
1445 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001446}
1447
1448/*
1449 * destroy the dentries attached to a superblock on unmounting
1450 */
1451void shrink_dcache_for_umount(struct super_block *sb)
1452{
1453 struct dentry *dentry;
1454
Al Viro9c8c10e2014-05-02 20:36:10 -04001455 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001456
1457 dentry = sb->s_root;
1458 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001459 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001460
1461 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001462 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1463 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001464 }
1465}
1466
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001467struct detach_data {
1468 struct select_data select;
1469 struct dentry *mountpoint;
1470};
1471static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001472{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001473 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001474
1475 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001476 __dget_dlock(dentry);
1477 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001478 return D_WALK_QUIT;
1479 }
1480
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001481 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001482}
1483
1484static void check_and_drop(void *_data)
1485{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001486 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001487
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001488 if (!data->mountpoint && !data->select.found)
1489 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001490}
1491
1492/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001493 * d_invalidate - detach submounts, prune dcache, and drop
1494 * @dentry: dentry to invalidate (aka detach, prune and drop)
1495 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001496 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001497 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001498 * The final d_drop is done as an atomic operation relative to
1499 * rename_lock ensuring there are no races with d_set_mounted. This
1500 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001501 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001502void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001503{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001504 /*
1505 * If it's already been dropped, return OK.
1506 */
1507 spin_lock(&dentry->d_lock);
1508 if (d_unhashed(dentry)) {
1509 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001510 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001511 }
1512 spin_unlock(&dentry->d_lock);
1513
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001514 /* Negative dentries can be dropped without further checks */
1515 if (!dentry->d_inode) {
1516 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001517 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001518 }
1519
1520 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001521 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001522
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001523 data.mountpoint = NULL;
1524 INIT_LIST_HEAD(&data.select.dispose);
1525 data.select.start = dentry;
1526 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001528 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001529
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001530 if (data.select.found)
1531 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001532
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001533 if (data.mountpoint) {
1534 detach_mounts(data.mountpoint);
1535 dput(data.mountpoint);
1536 }
1537
1538 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001539 break;
1540
1541 cond_resched();
1542 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001543}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001544EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546/**
Al Viroa4464db2011-07-07 15:03:58 -04001547 * __d_alloc - allocate a dcache entry
1548 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 * @name: qstr of the name
1550 *
1551 * Allocates a dentry. It returns %NULL if there is insufficient memory
1552 * available. On a success the dentry is returned. The name passed in is
1553 * copied and the copy passed in may be reused after this call.
1554 */
1555
Al Viroa4464db2011-07-07 15:03:58 -04001556struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
1558 struct dentry *dentry;
1559 char *dname;
1560
Mel Gormane12ba742007-10-16 01:25:52 -07001561 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 if (!dentry)
1563 return NULL;
1564
Linus Torvalds6326c712012-05-21 16:14:04 -07001565 /*
1566 * We guarantee that the inline name is always NUL-terminated.
1567 * This way the memcpy() done by the name switching in rename
1568 * will still always have a NUL at the end, even if we might
1569 * be overwriting an internal NUL character
1570 */
1571 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001572 if (unlikely(!name)) {
1573 static const struct qstr anon = QSTR_INIT("/", 1);
1574 name = &anon;
1575 dname = dentry->d_iname;
1576 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001577 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001578 struct external_name *p = kmalloc(size + name->len,
1579 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001580 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 kmem_cache_free(dentry_cache, dentry);
1582 return NULL;
1583 }
Al Viro8d85b482014-09-29 14:54:27 -04001584 atomic_set(&p->u.count, 1);
1585 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001586 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1587 kasan_unpoison_shadow(dname,
1588 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 } else {
1590 dname = dentry->d_iname;
1591 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
1593 dentry->d_name.len = name->len;
1594 dentry->d_name.hash = name->hash;
1595 memcpy(dname, name->name, name->len);
1596 dname[name->len] = 0;
1597
Linus Torvalds6326c712012-05-21 16:14:04 -07001598 /* Make sure we always see the terminating NUL character */
1599 smp_wmb();
1600 dentry->d_name.name = dname;
1601
Waiman Long98474232013-08-28 18:24:59 -07001602 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001603 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001605 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001607 dentry->d_parent = dentry;
1608 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 dentry->d_op = NULL;
1610 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001611 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 INIT_LIST_HEAD(&dentry->d_lru);
1613 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001614 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1615 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001616 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Nick Piggin3e880fb2011-01-07 17:49:19 +11001618 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001619
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 return dentry;
1621}
Al Viroa4464db2011-07-07 15:03:58 -04001622
1623/**
1624 * d_alloc - allocate a dcache entry
1625 * @parent: parent of entry to allocate
1626 * @name: qstr of the name
1627 *
1628 * Allocates a dentry. It returns %NULL if there is insufficient memory
1629 * available. On a success the dentry is returned. The name passed in is
1630 * copied and the copy passed in may be reused after this call.
1631 */
1632struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1633{
1634 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1635 if (!dentry)
1636 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001637 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001638 spin_lock(&parent->d_lock);
1639 /*
1640 * don't need child lock because it is not subject
1641 * to concurrency here
1642 */
1643 __dget_dlock(parent);
1644 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001645 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001646 spin_unlock(&parent->d_lock);
1647
1648 return dentry;
1649}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001650EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001652/**
1653 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1654 * @sb: the superblock
1655 * @name: qstr of the name
1656 *
1657 * For a filesystem that just pins its dentries in memory and never
1658 * performs lookups at all, return an unhashed IS_ROOT dentry.
1659 */
Nick Piggin4b936882011-01-07 17:50:07 +11001660struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1661{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001662 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001663}
1664EXPORT_SYMBOL(d_alloc_pseudo);
1665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1667{
1668 struct qstr q;
1669
1670 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001671 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 return d_alloc(parent, &q);
1673}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001674EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Nick Pigginfb045ad2011-01-07 17:49:55 +11001676void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1677{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001678 WARN_ON_ONCE(dentry->d_op);
1679 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001680 DCACHE_OP_COMPARE |
1681 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001682 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001683 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001684 DCACHE_OP_SELECT_INODE |
1685 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001686 dentry->d_op = op;
1687 if (!op)
1688 return;
1689 if (op->d_hash)
1690 dentry->d_flags |= DCACHE_OP_HASH;
1691 if (op->d_compare)
1692 dentry->d_flags |= DCACHE_OP_COMPARE;
1693 if (op->d_revalidate)
1694 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001695 if (op->d_weak_revalidate)
1696 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001697 if (op->d_delete)
1698 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001699 if (op->d_prune)
1700 dentry->d_flags |= DCACHE_OP_PRUNE;
David Howells4bacc9c2015-06-18 14:32:31 +01001701 if (op->d_select_inode)
1702 dentry->d_flags |= DCACHE_OP_SELECT_INODE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001703 if (op->d_real)
1704 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001705
1706}
1707EXPORT_SYMBOL(d_set_d_op);
1708
David Howellsdf1a0852015-01-29 12:02:28 +00001709
1710/*
1711 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1712 * @dentry - The dentry to mark
1713 *
1714 * Mark a dentry as falling through to the lower layer (as set with
1715 * d_pin_lower()). This flag may be recorded on the medium.
1716 */
1717void d_set_fallthru(struct dentry *dentry)
1718{
1719 spin_lock(&dentry->d_lock);
1720 dentry->d_flags |= DCACHE_FALLTHRU;
1721 spin_unlock(&dentry->d_lock);
1722}
1723EXPORT_SYMBOL(d_set_fallthru);
1724
David Howellsb18825a2013-09-12 19:22:53 +01001725static unsigned d_flags_for_inode(struct inode *inode)
1726{
David Howells44bdb5e2015-01-29 12:02:29 +00001727 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001728
1729 if (!inode)
1730 return DCACHE_MISS_TYPE;
1731
1732 if (S_ISDIR(inode->i_mode)) {
1733 add_flags = DCACHE_DIRECTORY_TYPE;
1734 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1735 if (unlikely(!inode->i_op->lookup))
1736 add_flags = DCACHE_AUTODIR_TYPE;
1737 else
1738 inode->i_opflags |= IOP_LOOKUP;
1739 }
David Howells44bdb5e2015-01-29 12:02:29 +00001740 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001741 }
1742
David Howells44bdb5e2015-01-29 12:02:29 +00001743 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001744 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001745 add_flags = DCACHE_SYMLINK_TYPE;
1746 goto type_determined;
1747 }
1748 inode->i_opflags |= IOP_NOFOLLOW;
1749 }
1750
1751 if (unlikely(!S_ISREG(inode->i_mode)))
1752 add_flags = DCACHE_SPECIAL_TYPE;
1753
1754type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001755 if (unlikely(IS_AUTOMOUNT(inode)))
1756 add_flags |= DCACHE_NEED_AUTOMOUNT;
1757 return add_flags;
1758}
1759
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001760static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1761{
David Howellsb18825a2013-09-12 19:22:53 +01001762 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001763 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001764
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001765 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001766 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001767 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001768 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001769 raw_write_seqcount_end(&dentry->d_seq);
Al Virode689f52016-03-09 18:05:42 -05001770 __fsnotify_d_instantiate(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001771 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001772}
1773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774/**
1775 * d_instantiate - fill in inode information for a dentry
1776 * @entry: dentry to complete
1777 * @inode: inode to attach to this dentry
1778 *
1779 * Fill in inode information in the entry.
1780 *
1781 * This turns negative dentries into productive full members
1782 * of society.
1783 *
1784 * NOTE! This assumes that the inode count has been incremented
1785 * (or otherwise set) by the caller to indicate that it is now
1786 * in use by the dcache.
1787 */
1788
1789void d_instantiate(struct dentry *entry, struct inode * inode)
1790{
Al Viro946e51f2014-10-26 19:19:16 -04001791 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001792 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001793 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001794 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001795 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001796 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001797 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001799EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
1801/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001802 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1803 * @entry: dentry to complete
1804 * @inode: inode to attach to this dentry
1805 *
1806 * Fill in inode information in the entry. If a directory alias is found, then
1807 * return an error (and drop inode). Together with d_materialise_unique() this
1808 * guarantees that a directory inode may never have more than one alias.
1809 */
1810int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1811{
Al Viro946e51f2014-10-26 19:19:16 -04001812 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001813
Al Virob9680912016-04-11 00:53:26 -04001814 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001815 spin_lock(&inode->i_lock);
1816 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1817 spin_unlock(&inode->i_lock);
1818 iput(inode);
1819 return -EBUSY;
1820 }
1821 __d_instantiate(entry, inode);
1822 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001823
1824 return 0;
1825}
1826EXPORT_SYMBOL(d_instantiate_no_diralias);
1827
Al Viroadc0e912012-01-08 16:49:21 -05001828struct dentry *d_make_root(struct inode *root_inode)
1829{
1830 struct dentry *res = NULL;
1831
1832 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001833 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001834 if (res)
1835 d_instantiate(res, root_inode);
1836 else
1837 iput(root_inode);
1838 }
1839 return res;
1840}
1841EXPORT_SYMBOL(d_make_root);
1842
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001843static struct dentry * __d_find_any_alias(struct inode *inode)
1844{
1845 struct dentry *alias;
1846
Al Virob3d9b7a2012-06-09 13:51:19 -04001847 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001848 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001849 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001850 __dget(alias);
1851 return alias;
1852}
1853
Sage Weil46f72b32012-01-10 09:04:37 -08001854/**
1855 * d_find_any_alias - find any alias for a given inode
1856 * @inode: inode to find an alias for
1857 *
1858 * If any aliases exist for the given inode, take and return a
1859 * reference for one of them. If no aliases exist, return %NULL.
1860 */
1861struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001862{
1863 struct dentry *de;
1864
1865 spin_lock(&inode->i_lock);
1866 de = __d_find_any_alias(inode);
1867 spin_unlock(&inode->i_lock);
1868 return de;
1869}
Sage Weil46f72b32012-01-10 09:04:37 -08001870EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001871
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001872static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001873{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001874 struct dentry *tmp;
1875 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001876 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001877
1878 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001879 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001880 if (IS_ERR(inode))
1881 return ERR_CAST(inode);
1882
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001883 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001884 if (res)
1885 goto out_iput;
1886
Al Viro798434b2016-03-24 20:38:43 -04001887 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001888 if (!tmp) {
1889 res = ERR_PTR(-ENOMEM);
1890 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001891 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001892
Al Virob9680912016-04-11 00:53:26 -04001893 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001894 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001895 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001896 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001897 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001898 dput(tmp);
1899 goto out_iput;
1900 }
1901
1902 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001903 add_flags = d_flags_for_inode(inode);
1904
1905 if (disconnected)
1906 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001907
Christoph Hellwig9308a612008-08-11 15:49:12 +02001908 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001909 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001910 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001911 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001912 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001913 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001914 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001915 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001916
Christoph Hellwig9308a612008-08-11 15:49:12 +02001917 return tmp;
1918
1919 out_iput:
1920 iput(inode);
1921 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001922}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001923
1924/**
1925 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1926 * @inode: inode to allocate the dentry for
1927 *
1928 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1929 * similar open by handle operations. The returned dentry may be anonymous,
1930 * or may have a full name (if the inode was already in the cache).
1931 *
1932 * When called on a directory inode, we must ensure that the inode only ever
1933 * has one dentry. If a dentry is found, that is returned instead of
1934 * allocating a new one.
1935 *
1936 * On successful return, the reference to the inode has been transferred
1937 * to the dentry. In case of an error the reference on the inode is released.
1938 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1939 * be passed in and the error will be propagated to the return value,
1940 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1941 */
1942struct dentry *d_obtain_alias(struct inode *inode)
1943{
1944 return __d_obtain_alias(inode, 1);
1945}
Benny Halevyadc48722009-02-27 14:02:59 -08001946EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
1948/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001949 * d_obtain_root - find or allocate a dentry for a given inode
1950 * @inode: inode to allocate the dentry for
1951 *
1952 * Obtain an IS_ROOT dentry for the root of a filesystem.
1953 *
1954 * We must ensure that directory inodes only ever have one dentry. If a
1955 * dentry is found, that is returned instead of allocating a new one.
1956 *
1957 * On successful return, the reference to the inode has been transferred
1958 * to the dentry. In case of an error the reference on the inode is
1959 * released. A %NULL or IS_ERR inode may be passed in and will be the
1960 * error will be propagate to the return value, with a %NULL @inode
1961 * replaced by ERR_PTR(-ESTALE).
1962 */
1963struct dentry *d_obtain_root(struct inode *inode)
1964{
1965 return __d_obtain_alias(inode, 0);
1966}
1967EXPORT_SYMBOL(d_obtain_root);
1968
1969/**
Barry Naujok94035402008-05-21 16:50:46 +10001970 * d_add_ci - lookup or allocate new dentry with case-exact name
1971 * @inode: the inode case-insensitive lookup has found
1972 * @dentry: the negative dentry that was passed to the parent's lookup func
1973 * @name: the case-exact name to be associated with the returned dentry
1974 *
1975 * This is to avoid filling the dcache with case-insensitive names to the
1976 * same inode, only the actual correct case is stored in the dcache for
1977 * case-insensitive filesystems.
1978 *
1979 * For a case-insensitive lookup match and if the the case-exact dentry
1980 * already exists in in the dcache, use it and return it.
1981 *
1982 * If no entry exists with the exact case name, allocate new dentry with
1983 * the exact case, and return the spliced entry.
1984 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001985struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001986 struct qstr *name)
1987{
Al Virod9171b92016-04-15 03:33:13 -04001988 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10001989
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001990 /*
1991 * First check if a dentry matching the name already exists,
1992 * if not go ahead and create it now.
1993 */
Barry Naujok94035402008-05-21 16:50:46 +10001994 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04001995 if (found) {
1996 iput(inode);
1997 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001998 }
Al Virod9171b92016-04-15 03:33:13 -04001999 if (d_in_lookup(dentry)) {
2000 found = d_alloc_parallel(dentry->d_parent, name,
2001 dentry->d_wait);
2002 if (IS_ERR(found) || !d_in_lookup(found)) {
2003 iput(inode);
2004 return found;
2005 }
2006 } else {
2007 found = d_alloc(dentry->d_parent, name);
2008 if (!found) {
2009 iput(inode);
2010 return ERR_PTR(-ENOMEM);
2011 }
2012 }
2013 res = d_splice_alias(inode, found);
2014 if (res) {
2015 dput(found);
2016 return res;
2017 }
Al Viro4f522a22013-02-11 23:20:37 -05002018 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002019}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002020EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002022/*
2023 * Do the slow-case of the dentry name compare.
2024 *
2025 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07002026 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002027 * filesystem can rely on them, and can use the 'name' and
2028 * 'len' information without worrying about walking off the
2029 * end of memory etc.
2030 *
2031 * Thus the read_seqcount_retry() and the "duplicate" info
2032 * in arguments (the low-level filesystem should not look
2033 * at the dentry inode or name contents directly, since
2034 * rename can change them while we're in RCU mode).
2035 */
2036enum slow_d_compare {
2037 D_COMP_OK,
2038 D_COMP_NOMATCH,
2039 D_COMP_SEQRETRY,
2040};
2041
2042static noinline enum slow_d_compare slow_dentry_cmp(
2043 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002044 struct dentry *dentry,
2045 unsigned int seq,
2046 const struct qstr *name)
2047{
2048 int tlen = dentry->d_name.len;
2049 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002050
2051 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2052 cpu_relax();
2053 return D_COMP_SEQRETRY;
2054 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002055 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002056 return D_COMP_NOMATCH;
2057 return D_COMP_OK;
2058}
2059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002061 * __d_lookup_rcu - search for a dentry (racy, store-free)
2062 * @parent: parent dentry
2063 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002064 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002065 * Returns: dentry, or NULL
2066 *
2067 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2068 * resolution (store-free path walking) design described in
2069 * Documentation/filesystems/path-lookup.txt.
2070 *
2071 * This is not to be used outside core vfs.
2072 *
2073 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2074 * held, and rcu_read_lock held. The returned dentry must not be stored into
2075 * without taking d_lock and checking d_seq sequence count against @seq
2076 * returned here.
2077 *
Linus Torvalds15570082013-09-02 11:38:06 -07002078 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002079 * function.
2080 *
2081 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2082 * the returned dentry, so long as its parent's seqlock is checked after the
2083 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2084 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002085 *
2086 * NOTE! The caller *has* to check the resulting dentry against the sequence
2087 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002088 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002089struct dentry *__d_lookup_rcu(const struct dentry *parent,
2090 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002091 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002092{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002093 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002094 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002095 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002096 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002097 struct dentry *dentry;
2098
2099 /*
2100 * Note: There is significant duplication with __d_lookup_rcu which is
2101 * required to prevent single threaded performance regressions
2102 * especially on architectures where smp_rmb (in seqcounts) are costly.
2103 * Keep the two functions in sync.
2104 */
2105
2106 /*
2107 * The hash list is protected using RCU.
2108 *
2109 * Carefully use d_seq when comparing a candidate dentry, to avoid
2110 * races with d_move().
2111 *
2112 * It is possible that concurrent renames can mess up our list
2113 * walk here and result in missing our dentry, resulting in the
2114 * false-negative result. d_lookup() protects against concurrent
2115 * renames using rename_lock seqlock.
2116 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002117 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002118 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002119 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002120 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002121
Nick Piggin31e6b012011-01-07 17:49:52 +11002122seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002123 /*
2124 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002125 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002126 *
2127 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002128 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002129 *
2130 * NOTE! We do a "raw" seqcount_begin here. That means that
2131 * we don't wait for the sequence count to stabilize if it
2132 * is in the middle of a sequence change. If we do the slow
2133 * dentry compare, we will do seqretries until it is stable,
2134 * and if we end up with a successful lookup, we actually
2135 * want to exit RCU lookup anyway.
2136 */
2137 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002138 if (dentry->d_parent != parent)
2139 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002140 if (d_unhashed(dentry))
2141 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002142
2143 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002144 if (dentry->d_name.hash != hashlen_hash(hashlen))
2145 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002146 *seqp = seq;
2147 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002148 case D_COMP_OK:
2149 return dentry;
2150 case D_COMP_NOMATCH:
2151 continue;
2152 default:
2153 goto seqretry;
2154 }
2155 }
2156
Linus Torvalds26fe5752012-05-10 13:14:12 -07002157 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002158 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002159 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002160 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002161 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002162 }
2163 return NULL;
2164}
2165
2166/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 * d_lookup - search for a dentry
2168 * @parent: parent dentry
2169 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002170 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002172 * d_lookup searches the children of the parent dentry for the name in
2173 * question. If the dentry is found its reference count is incremented and the
2174 * dentry is returned. The caller must use dput to free the entry when it has
2175 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 */
Al Viroda2d8452013-01-24 18:29:34 -05002177struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178{
Nick Piggin31e6b012011-01-07 17:49:52 +11002179 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002180 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181
Daeseok Younb8314f92014-08-11 11:46:53 +09002182 do {
2183 seq = read_seqbegin(&rename_lock);
2184 dentry = __d_lookup(parent, name);
2185 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 break;
2187 } while (read_seqretry(&rename_lock, seq));
2188 return dentry;
2189}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002190EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Nick Piggin31e6b012011-01-07 17:49:52 +11002192/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002193 * __d_lookup - search for a dentry (racy)
2194 * @parent: parent dentry
2195 * @name: qstr of name we wish to find
2196 * Returns: dentry, or NULL
2197 *
2198 * __d_lookup is like d_lookup, however it may (rarely) return a
2199 * false-negative result due to unrelated rename activity.
2200 *
2201 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2202 * however it must be used carefully, eg. with a following d_lookup in
2203 * the case of failure.
2204 *
2205 * __d_lookup callers must be commented.
2206 */
Al Viroa713ca22013-01-24 18:27:00 -05002207struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208{
2209 unsigned int len = name->len;
2210 unsigned int hash = name->hash;
2211 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002212 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002213 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002214 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002215 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216
Nick Pigginb04f7842010-08-18 04:37:34 +10002217 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002218 * Note: There is significant duplication with __d_lookup_rcu which is
2219 * required to prevent single threaded performance regressions
2220 * especially on architectures where smp_rmb (in seqcounts) are costly.
2221 * Keep the two functions in sync.
2222 */
2223
2224 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002225 * The hash list is protected using RCU.
2226 *
2227 * Take d_lock when comparing a candidate dentry, to avoid races
2228 * with d_move().
2229 *
2230 * It is possible that concurrent renames can mess up our list
2231 * walk here and result in missing our dentry, resulting in the
2232 * false-negative result. d_lookup() protects against concurrent
2233 * renames using rename_lock seqlock.
2234 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002235 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002236 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 rcu_read_lock();
2238
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002239 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 if (dentry->d_name.hash != hash)
2242 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
2244 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 if (dentry->d_parent != parent)
2246 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002247 if (d_unhashed(dentry))
2248 goto next;
2249
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 /*
2251 * It is safe to compare names since d_move() cannot
2252 * change the qstr (protected by d_lock).
2253 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002254 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002255 int tlen = dentry->d_name.len;
2256 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002257 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 goto next;
2259 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002260 if (dentry->d_name.len != len)
2261 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002262 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 goto next;
2264 }
2265
Waiman Long98474232013-08-28 18:24:59 -07002266 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002267 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 spin_unlock(&dentry->d_lock);
2269 break;
2270next:
2271 spin_unlock(&dentry->d_lock);
2272 }
2273 rcu_read_unlock();
2274
2275 return found;
2276}
2277
2278/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002279 * d_hash_and_lookup - hash the qstr then search for a dentry
2280 * @dir: Directory to search in
2281 * @name: qstr of name we wish to find
2282 *
Al Viro4f522a22013-02-11 23:20:37 -05002283 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002284 */
2285struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2286{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002287 /*
2288 * Check for a fs-specific hash function. Note that we must
2289 * calculate the standard hash first, as the d_op->d_hash()
2290 * routine may choose to leave the hash value unchanged.
2291 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002292 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002293 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002294 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002295 if (unlikely(err < 0))
2296 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002297 }
Al Viro4f522a22013-02-11 23:20:37 -05002298 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002299}
Al Viro4f522a22013-02-11 23:20:37 -05002300EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002301
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302/*
2303 * When a file is deleted, we have two options:
2304 * - turn this dentry into a negative dentry
2305 * - unhash this dentry and free it.
2306 *
2307 * Usually, we want to just turn this into
2308 * a negative dentry, but if anybody else is
2309 * currently using the dentry or the inode
2310 * we can't do that and we fall back on removing
2311 * it from the hash queues and waiting for
2312 * it to be deleted later when it has no users
2313 */
2314
2315/**
2316 * d_delete - delete a dentry
2317 * @dentry: The dentry to delete
2318 *
2319 * Turn the dentry into a negative dentry if possible, otherwise
2320 * remove it from the hash queues so it can be deleted later
2321 */
2322
2323void d_delete(struct dentry * dentry)
2324{
Nick Piggin873feea2011-01-07 17:50:06 +11002325 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002326 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 /*
2328 * Are we the only user?
2329 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002330again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002332 inode = dentry->d_inode;
2333 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002334 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002335 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002336 spin_unlock(&dentry->d_lock);
2337 cpu_relax();
2338 goto again;
2339 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002340 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002341 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002342 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 return;
2344 }
2345
2346 if (!d_unhashed(dentry))
2347 __d_drop(dentry);
2348
2349 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002350
2351 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002353EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002355static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002357 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002358 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002359 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002360 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361}
2362
David Howells770bfad2006-08-22 20:06:07 -04002363static void _d_rehash(struct dentry * entry)
2364{
Linus Torvalds8387ff22016-06-10 07:51:30 -07002365 __d_rehash(entry, d_hash(entry->d_name.hash));
David Howells770bfad2006-08-22 20:06:07 -04002366}
2367
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368/**
2369 * d_rehash - add an entry back to the hash
2370 * @entry: dentry to add to the hash
2371 *
2372 * Adds a dentry to the hash according to its name.
2373 */
2374
2375void d_rehash(struct dentry * entry)
2376{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002378 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002381EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382
Al Viro84e710d2016-04-15 00:58:55 -04002383static inline unsigned start_dir_add(struct inode *dir)
2384{
2385
2386 for (;;) {
2387 unsigned n = dir->i_dir_seq;
2388 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2389 return n;
2390 cpu_relax();
2391 }
2392}
2393
2394static inline void end_dir_add(struct inode *dir, unsigned n)
2395{
2396 smp_store_release(&dir->i_dir_seq, n + 2);
2397}
2398
Al Virod9171b92016-04-15 03:33:13 -04002399static void d_wait_lookup(struct dentry *dentry)
2400{
2401 if (d_in_lookup(dentry)) {
2402 DECLARE_WAITQUEUE(wait, current);
2403 add_wait_queue(dentry->d_wait, &wait);
2404 do {
2405 set_current_state(TASK_UNINTERRUPTIBLE);
2406 spin_unlock(&dentry->d_lock);
2407 schedule();
2408 spin_lock(&dentry->d_lock);
2409 } while (d_in_lookup(dentry));
2410 }
2411}
2412
Al Viro94bdd652016-04-15 02:42:04 -04002413struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002414 const struct qstr *name,
2415 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002416{
2417 unsigned int len = name->len;
2418 unsigned int hash = name->hash;
2419 const unsigned char *str = name->name;
2420 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2421 struct hlist_bl_node *node;
2422 struct dentry *new = d_alloc(parent, name);
2423 struct dentry *dentry;
2424 unsigned seq, r_seq, d_seq;
2425
2426 if (unlikely(!new))
2427 return ERR_PTR(-ENOMEM);
2428
2429retry:
2430 rcu_read_lock();
2431 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2432 r_seq = read_seqbegin(&rename_lock);
2433 dentry = __d_lookup_rcu(parent, name, &d_seq);
2434 if (unlikely(dentry)) {
2435 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2436 rcu_read_unlock();
2437 goto retry;
2438 }
2439 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2440 rcu_read_unlock();
2441 dput(dentry);
2442 goto retry;
2443 }
2444 rcu_read_unlock();
2445 dput(new);
2446 return dentry;
2447 }
2448 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2449 rcu_read_unlock();
2450 goto retry;
2451 }
2452 hlist_bl_lock(b);
2453 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2454 hlist_bl_unlock(b);
2455 rcu_read_unlock();
2456 goto retry;
2457 }
2458 rcu_read_unlock();
2459 /*
2460 * No changes for the parent since the beginning of d_lookup().
2461 * Since all removals from the chain happen with hlist_bl_lock(),
2462 * any potential in-lookup matches are going to stay here until
2463 * we unlock the chain. All fields are stable in everything
2464 * we encounter.
2465 */
2466 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2467 if (dentry->d_name.hash != hash)
2468 continue;
2469 if (dentry->d_parent != parent)
2470 continue;
2471 if (d_unhashed(dentry))
2472 continue;
2473 if (parent->d_flags & DCACHE_OP_COMPARE) {
2474 int tlen = dentry->d_name.len;
2475 const char *tname = dentry->d_name.name;
2476 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2477 continue;
2478 } else {
2479 if (dentry->d_name.len != len)
2480 continue;
2481 if (dentry_cmp(dentry, str, len))
2482 continue;
2483 }
2484 dget(dentry);
2485 hlist_bl_unlock(b);
Al Virod9171b92016-04-15 03:33:13 -04002486 /* somebody is doing lookup for it right now; wait for it */
2487 spin_lock(&dentry->d_lock);
2488 d_wait_lookup(dentry);
2489 /*
2490 * it's not in-lookup anymore; in principle we should repeat
2491 * everything from dcache lookup, but it's likely to be what
2492 * d_lookup() would've found anyway. If it is, just return it;
2493 * otherwise we really have to repeat the whole thing.
2494 */
2495 if (unlikely(dentry->d_name.hash != hash))
2496 goto mismatch;
2497 if (unlikely(dentry->d_parent != parent))
2498 goto mismatch;
2499 if (unlikely(d_unhashed(dentry)))
2500 goto mismatch;
2501 if (parent->d_flags & DCACHE_OP_COMPARE) {
2502 int tlen = dentry->d_name.len;
2503 const char *tname = dentry->d_name.name;
2504 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2505 goto mismatch;
2506 } else {
2507 if (unlikely(dentry->d_name.len != len))
2508 goto mismatch;
2509 if (unlikely(dentry_cmp(dentry, str, len)))
2510 goto mismatch;
2511 }
2512 /* OK, it *is* a hashed match; return it */
2513 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002514 dput(new);
2515 return dentry;
2516 }
2517 /* we can't take ->d_lock here; it's OK, though. */
2518 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002519 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002520 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2521 hlist_bl_unlock(b);
2522 return new;
Al Virod9171b92016-04-15 03:33:13 -04002523mismatch:
2524 spin_unlock(&dentry->d_lock);
2525 dput(dentry);
2526 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002527}
2528EXPORT_SYMBOL(d_alloc_parallel);
2529
Al Viro85c7f812016-04-14 19:52:13 -04002530void __d_lookup_done(struct dentry *dentry)
2531{
Al Viro94bdd652016-04-15 02:42:04 -04002532 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2533 dentry->d_name.hash);
2534 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002535 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002536 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002537 wake_up_all(dentry->d_wait);
2538 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002539 hlist_bl_unlock(b);
2540 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002541 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002542}
2543EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002544
2545/* inode->i_lock held if inode is non-NULL */
2546
2547static inline void __d_add(struct dentry *dentry, struct inode *inode)
2548{
Al Viro84e710d2016-04-15 00:58:55 -04002549 struct inode *dir = NULL;
2550 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002551 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002552 if (unlikely(d_in_lookup(dentry))) {
2553 dir = dentry->d_parent->d_inode;
2554 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002555 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002556 }
Al Viroed782b52016-03-09 19:52:39 -05002557 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002558 unsigned add_flags = d_flags_for_inode(inode);
2559 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2560 raw_write_seqcount_begin(&dentry->d_seq);
2561 __d_set_inode_and_type(dentry, inode, add_flags);
2562 raw_write_seqcount_end(&dentry->d_seq);
2563 __fsnotify_d_instantiate(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002564 }
Al Viro0568d702016-04-14 19:40:56 -04002565 _d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002566 if (dir)
2567 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002568 spin_unlock(&dentry->d_lock);
2569 if (inode)
2570 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002571}
2572
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002573/**
Al Viro34d0d192016-03-08 21:01:03 -05002574 * d_add - add dentry to hash queues
2575 * @entry: dentry to add
2576 * @inode: The inode to attach to this dentry
2577 *
2578 * This adds the entry to the hash queues and initializes @inode.
2579 * The entry was actually filled in earlier during d_alloc().
2580 */
2581
2582void d_add(struct dentry *entry, struct inode *inode)
2583{
Al Virob9680912016-04-11 00:53:26 -04002584 if (inode) {
2585 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002586 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002587 }
Al Viroed782b52016-03-09 19:52:39 -05002588 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002589}
2590EXPORT_SYMBOL(d_add);
2591
2592/**
Al Viro668d0cd2016-03-08 12:44:17 -05002593 * d_exact_alias - find and hash an exact unhashed alias
2594 * @entry: dentry to add
2595 * @inode: The inode to go with this dentry
2596 *
2597 * If an unhashed dentry with the same name/parent and desired
2598 * inode already exists, hash and return it. Otherwise, return
2599 * NULL.
2600 *
2601 * Parent directory should be locked.
2602 */
2603struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2604{
2605 struct dentry *alias;
2606 int len = entry->d_name.len;
2607 const char *name = entry->d_name.name;
2608 unsigned int hash = entry->d_name.hash;
2609
2610 spin_lock(&inode->i_lock);
2611 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2612 /*
2613 * Don't need alias->d_lock here, because aliases with
2614 * d_parent == entry->d_parent are not subject to name or
2615 * parent changes, because the parent inode i_mutex is held.
2616 */
2617 if (alias->d_name.hash != hash)
2618 continue;
2619 if (alias->d_parent != entry->d_parent)
2620 continue;
2621 if (alias->d_name.len != len)
2622 continue;
2623 if (dentry_cmp(alias, name, len))
2624 continue;
2625 spin_lock(&alias->d_lock);
2626 if (!d_unhashed(alias)) {
2627 spin_unlock(&alias->d_lock);
2628 alias = NULL;
2629 } else {
2630 __dget_dlock(alias);
2631 _d_rehash(alias);
2632 spin_unlock(&alias->d_lock);
2633 }
2634 spin_unlock(&inode->i_lock);
2635 return alias;
2636 }
2637 spin_unlock(&inode->i_lock);
2638 return NULL;
2639}
2640EXPORT_SYMBOL(d_exact_alias);
2641
2642/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002643 * dentry_update_name_case - update case insensitive dentry with a new name
2644 * @dentry: dentry to be updated
2645 * @name: new name
2646 *
2647 * Update a case insensitive dentry with new case of name.
2648 *
2649 * dentry must have been returned by d_lookup with name @name. Old and new
2650 * name lengths must match (ie. no d_compare which allows mismatched name
2651 * lengths).
2652 *
2653 * Parent inode i_mutex must be held over d_lookup and into this call (to
2654 * keep renames and concurrent inserts, and readdir(2) away).
2655 */
2656void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2657{
Al Viro59551022016-01-22 15:40:57 -05002658 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002659 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2660
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002661 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002662 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002663 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002664 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002665 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002666}
2667EXPORT_SYMBOL(dentry_update_name_case);
2668
Al Viro8d85b482014-09-29 14:54:27 -04002669static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670{
Al Viro8d85b482014-09-29 14:54:27 -04002671 if (unlikely(dname_external(target))) {
2672 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673 /*
2674 * Both external: swap the pointers
2675 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002676 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677 } else {
2678 /*
2679 * dentry:internal, target:external. Steal target's
2680 * storage and make target internal.
2681 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002682 memcpy(target->d_iname, dentry->d_name.name,
2683 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684 dentry->d_name.name = target->d_name.name;
2685 target->d_name.name = target->d_iname;
2686 }
2687 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002688 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 /*
2690 * dentry:external, target:internal. Give dentry's
2691 * storage to target and make dentry internal
2692 */
2693 memcpy(dentry->d_iname, target->d_name.name,
2694 target->d_name.len + 1);
2695 target->d_name.name = dentry->d_name.name;
2696 dentry->d_name.name = dentry->d_iname;
2697 } else {
2698 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002699 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002701 unsigned int i;
2702 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002703 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2704 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002705 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2706 swap(((long *) &dentry->d_iname)[i],
2707 ((long *) &target->d_iname)[i]);
2708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 }
2710 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002711 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712}
2713
Al Viro8d85b482014-09-29 14:54:27 -04002714static void copy_name(struct dentry *dentry, struct dentry *target)
2715{
2716 struct external_name *old_name = NULL;
2717 if (unlikely(dname_external(dentry)))
2718 old_name = external_name(dentry);
2719 if (unlikely(dname_external(target))) {
2720 atomic_inc(&external_name(target)->u.count);
2721 dentry->d_name = target->d_name;
2722 } else {
2723 memcpy(dentry->d_iname, target->d_name.name,
2724 target->d_name.len + 1);
2725 dentry->d_name.name = dentry->d_iname;
2726 dentry->d_name.hash_len = target->d_name.hash_len;
2727 }
2728 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2729 kfree_rcu(old_name, u.head);
2730}
2731
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002732static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2733{
2734 /*
2735 * XXXX: do we really need to take target->d_lock?
2736 */
2737 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2738 spin_lock(&target->d_parent->d_lock);
2739 else {
2740 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2741 spin_lock(&dentry->d_parent->d_lock);
2742 spin_lock_nested(&target->d_parent->d_lock,
2743 DENTRY_D_LOCK_NESTED);
2744 } else {
2745 spin_lock(&target->d_parent->d_lock);
2746 spin_lock_nested(&dentry->d_parent->d_lock,
2747 DENTRY_D_LOCK_NESTED);
2748 }
2749 }
2750 if (target < dentry) {
2751 spin_lock_nested(&target->d_lock, 2);
2752 spin_lock_nested(&dentry->d_lock, 3);
2753 } else {
2754 spin_lock_nested(&dentry->d_lock, 2);
2755 spin_lock_nested(&target->d_lock, 3);
2756 }
2757}
2758
Al Viro986c0192014-09-26 23:11:15 -04002759static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002760{
2761 if (target->d_parent != dentry->d_parent)
2762 spin_unlock(&dentry->d_parent->d_lock);
2763 if (target->d_parent != target)
2764 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002765 spin_unlock(&target->d_lock);
2766 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002767}
2768
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002770 * When switching names, the actual string doesn't strictly have to
2771 * be preserved in the target - because we're dropping the target
2772 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002773 * the new name before we switch, unless we are going to rehash
2774 * it. Note that if we *do* unhash the target, we are not allowed
2775 * to rehash it without giving it a new name/hash key - whether
2776 * we swap or overwrite the names here, resulting name won't match
2777 * the reality in filesystem; it's only there for d_path() purposes.
2778 * Note that all of this is happening under rename_lock, so the
2779 * any hash lookup seeing it in the middle of manipulations will
2780 * be discarded anyway. So we do not care what happens to the hash
2781 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002783/*
Al Viro18367502011-07-12 21:42:24 -04002784 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 * @dentry: entry to move
2786 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002787 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 *
2789 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002790 * dcache entries should not be moved in this way. Caller must hold
2791 * rename_lock, the i_mutex of the source and target directories,
2792 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002794static void __d_move(struct dentry *dentry, struct dentry *target,
2795 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796{
Al Viro84e710d2016-04-15 00:58:55 -04002797 struct inode *dir = NULL;
2798 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 if (!dentry->d_inode)
2800 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2801
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002802 BUG_ON(d_ancestor(dentry, target));
2803 BUG_ON(d_ancestor(target, dentry));
2804
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002805 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002806 if (unlikely(d_in_lookup(target))) {
2807 dir = target->d_parent->d_inode;
2808 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002809 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002810 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811
Nick Piggin31e6b012011-01-07 17:49:52 +11002812 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002813 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002814
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002815 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2816
2817 /*
2818 * Move the dentry to the target hash queue. Don't bother checking
2819 * for the same hash queue because of how unlikely it is.
2820 */
2821 __d_drop(dentry);
Linus Torvalds8387ff22016-06-10 07:51:30 -07002822 __d_rehash(dentry, d_hash(target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823
Miklos Szeredida1ce062014-04-01 17:08:43 +02002824 /*
2825 * Unhash the target (d_delete() is not usable here). If exchanging
2826 * the two dentries, then rehash onto the other's hash queue.
2827 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002829 if (exchange) {
Linus Torvalds8387ff22016-06-10 07:51:30 -07002830 __d_rehash(target, d_hash(dentry->d_name.hash));
Miklos Szeredida1ce062014-04-01 17:08:43 +02002831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002834 if (exchange)
2835 swap_names(dentry, target);
2836 else
2837 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838
Al Viro63cf4272014-09-26 23:06:14 -04002839 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002841 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002842 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 dentry->d_parent = target->d_parent;
2844 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002845 list_del_init(&target->d_child);
2846 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002848 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002849 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002850 list_move(&target->d_child, &target->d_parent->d_subdirs);
2851 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002852 if (exchange)
2853 fsnotify_d_move(target);
2854 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855 }
2856
Nick Piggin31e6b012011-01-07 17:49:52 +11002857 write_seqcount_end(&target->d_seq);
2858 write_seqcount_end(&dentry->d_seq);
2859
Al Viro84e710d2016-04-15 00:58:55 -04002860 if (dir)
2861 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002862 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002863}
2864
2865/*
2866 * d_move - move a dentry
2867 * @dentry: entry to move
2868 * @target: new dentry
2869 *
2870 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002871 * dcache entries should not be moved in this way. See the locking
2872 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002873 */
2874void d_move(struct dentry *dentry, struct dentry *target)
2875{
2876 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002877 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002879}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002880EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881
Miklos Szeredida1ce062014-04-01 17:08:43 +02002882/*
2883 * d_exchange - exchange two dentries
2884 * @dentry1: first dentry
2885 * @dentry2: second dentry
2886 */
2887void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2888{
2889 write_seqlock(&rename_lock);
2890
2891 WARN_ON(!dentry1->d_inode);
2892 WARN_ON(!dentry2->d_inode);
2893 WARN_ON(IS_ROOT(dentry1));
2894 WARN_ON(IS_ROOT(dentry2));
2895
2896 __d_move(dentry1, dentry2, true);
2897
2898 write_sequnlock(&rename_lock);
2899}
2900
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002901/**
2902 * d_ancestor - search for an ancestor
2903 * @p1: ancestor dentry
2904 * @p2: child dentry
2905 *
2906 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2907 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002908 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002909struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910{
2911 struct dentry *p;
2912
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002913 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002915 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002916 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002917 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002918}
2919
2920/*
2921 * This helper attempts to cope with remotely renamed directories
2922 *
2923 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002924 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002925 *
2926 * Note: If ever the locking in lock_rename() changes, then please
2927 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002928 */
Al Virob5ae6b12014-10-12 22:16:02 -04002929static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002930 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002931{
Al Viro9902af72016-04-15 15:08:36 -04002932 struct mutex *m1 = NULL;
2933 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002934 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002935
2936 /* If alias and dentry share a parent, then no extra locks required */
2937 if (alias->d_parent == dentry->d_parent)
2938 goto out_unalias;
2939
Trond Myklebust9eaef272006-10-21 10:24:20 -07002940 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002941 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2942 goto out_err;
2943 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002944 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002945 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002946 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002947out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002948 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002949 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002950out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002951 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002952 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002953 if (m1)
2954 mutex_unlock(m1);
2955 return ret;
2956}
2957
David Howells770bfad2006-08-22 20:06:07 -04002958/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002959 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2960 * @inode: the inode which may have a disconnected dentry
2961 * @dentry: a negative dentry which we want to point to the inode.
2962 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002963 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2964 * place of the given dentry and return it, else simply d_add the inode
2965 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002966 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002967 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2968 * we should error out: directories can't have multiple aliases.
2969 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002970 * This is needed in the lookup routine of any filesystem that is exportable
2971 * (via knfsd) so that we can build dcache paths to directories effectively.
2972 *
2973 * If a dentry was found and moved, then it is returned. Otherwise NULL
2974 * is returned. This matches the expected return value of ->lookup.
2975 *
2976 * Cluster filesystems may call this function with a negative, hashed dentry.
2977 * In that case, we know that the inode will be a regular file, and also this
2978 * will only occur during atomic_open. So we need to check for the dentry
2979 * being already hashed only in the final case.
2980 */
2981struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2982{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002983 if (IS_ERR(inode))
2984 return ERR_CAST(inode);
2985
David Howells770bfad2006-08-22 20:06:07 -04002986 BUG_ON(!d_unhashed(dentry));
2987
Al Virode689f52016-03-09 18:05:42 -05002988 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002989 goto out;
Al Virode689f52016-03-09 18:05:42 -05002990
Al Virob9680912016-04-11 00:53:26 -04002991 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002992 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002993 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002994 struct dentry *new = __d_find_any_alias(inode);
2995 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002996 /* The reference to new ensures it remains an alias */
2997 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002998 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002999 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003000 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003001 dput(new);
3002 new = ERR_PTR(-ELOOP);
3003 pr_warn_ratelimited(
3004 "VFS: Lookup of '%s' in %s %s"
3005 " would have caused loop\n",
3006 dentry->d_name.name,
3007 inode->i_sb->s_type->name,
3008 inode->i_sb->s_id);
3009 } else if (!IS_ROOT(new)) {
3010 int err = __d_unalias(inode, dentry, new);
3011 write_sequnlock(&rename_lock);
3012 if (err) {
3013 dput(new);
3014 new = ERR_PTR(err);
3015 }
Al Viro18367502011-07-12 21:42:24 -04003016 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003017 __d_move(new, dentry, false);
3018 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003019 }
Al Virob5ae6b12014-10-12 22:16:02 -04003020 iput(inode);
3021 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003022 }
David Howells770bfad2006-08-22 20:06:07 -04003023 }
Al Virob5ae6b12014-10-12 22:16:02 -04003024out:
Al Viroed782b52016-03-09 19:52:39 -05003025 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003026 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003027}
Al Virob5ae6b12014-10-12 22:16:02 -04003028EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003029
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003030static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003031{
3032 *buflen -= namelen;
3033 if (*buflen < 0)
3034 return -ENAMETOOLONG;
3035 *buffer -= namelen;
3036 memcpy(*buffer, str, namelen);
3037 return 0;
3038}
3039
Waiman Long232d2d62013-09-09 12:18:13 -04003040/**
3041 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003042 * @buffer: buffer pointer
3043 * @buflen: allocated length of the buffer
3044 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003045 *
3046 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3047 * make sure that either the old or the new name pointer and length are
3048 * fetched. However, there may be mismatch between length and pointer.
3049 * The length cannot be trusted, we need to copy it byte-by-byte until
3050 * the length is reached or a null byte is found. It also prepends "/" at
3051 * the beginning of the name. The sequence number check at the caller will
3052 * retry it again when a d_move() does happen. So any garbage in the buffer
3053 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003054 *
3055 * Data dependency barrier is needed to make sure that we see that terminating
3056 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003057 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003058static int prepend_name(char **buffer, int *buflen, struct qstr *name)
3059{
Waiman Long232d2d62013-09-09 12:18:13 -04003060 const char *dname = ACCESS_ONCE(name->name);
3061 u32 dlen = ACCESS_ONCE(name->len);
3062 char *p;
3063
Al Viro6d13f692014-09-29 14:46:30 -04003064 smp_read_barrier_depends();
3065
Waiman Long232d2d62013-09-09 12:18:13 -04003066 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003067 if (*buflen < 0)
3068 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003069 p = *buffer -= dlen + 1;
3070 *p++ = '/';
3071 while (dlen--) {
3072 char c = *dname++;
3073 if (!c)
3074 break;
3075 *p++ = c;
3076 }
3077 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003078}
3079
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003081 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003082 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003083 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003084 * @buffer: pointer to the end of the buffer
3085 * @buflen: pointer to buffer length
3086 *
Waiman Long18129972013-09-12 10:55:35 -04003087 * The function will first try to write out the pathname without taking any
3088 * lock other than the RCU read lock to make sure that dentries won't go away.
3089 * It only checks the sequence number of the global rename_lock as any change
3090 * in the dentry's d_seq will be preceded by changes in the rename_lock
3091 * sequence number. If the sequence number had been changed, it will restart
3092 * the whole pathname back-tracing sequence again by taking the rename_lock.
3093 * In this case, there is no need to take the RCU read lock as the recursive
3094 * parent pointer references will keep the dentry chain alive as long as no
3095 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003096 */
Al Viro02125a82011-12-05 08:43:34 -05003097static int prepend_path(const struct path *path,
3098 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003099 char **buffer, int *buflen)
3100{
Al Viroede4ceb2013-11-13 07:45:40 -05003101 struct dentry *dentry;
3102 struct vfsmount *vfsmnt;
3103 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003104 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003105 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003106 char *bptr;
3107 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003108
Al Viro48f5ec22013-09-09 15:22:25 -04003109 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003110restart_mnt:
3111 read_seqbegin_or_lock(&mount_lock, &m_seq);
3112 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003113 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003114restart:
3115 bptr = *buffer;
3116 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003117 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003118 dentry = path->dentry;
3119 vfsmnt = path->mnt;
3120 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003121 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003122 while (dentry != root->dentry || vfsmnt != root->mnt) {
3123 struct dentry * parent;
3124
3125 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003126 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003127 /* Escaped? */
3128 if (dentry != vfsmnt->mnt_root) {
3129 bptr = *buffer;
3130 blen = *buflen;
3131 error = 3;
3132 break;
3133 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003134 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003135 if (mnt != parent) {
3136 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3137 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003138 vfsmnt = &mnt->mnt;
3139 continue;
3140 }
Waiman Long232d2d62013-09-09 12:18:13 -04003141 if (!error)
3142 error = is_mounted(vfsmnt) ? 1 : 2;
3143 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003144 }
3145 parent = dentry->d_parent;
3146 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003147 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003148 if (error)
3149 break;
3150
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003151 dentry = parent;
3152 }
Al Viro48f5ec22013-09-09 15:22:25 -04003153 if (!(seq & 1))
3154 rcu_read_unlock();
3155 if (need_seqretry(&rename_lock, seq)) {
3156 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003157 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003158 }
Al Viro48f5ec22013-09-09 15:22:25 -04003159 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003160
3161 if (!(m_seq & 1))
3162 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003163 if (need_seqretry(&mount_lock, m_seq)) {
3164 m_seq = 1;
3165 goto restart_mnt;
3166 }
3167 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168
Waiman Long232d2d62013-09-09 12:18:13 -04003169 if (error >= 0 && bptr == *buffer) {
3170 if (--blen < 0)
3171 error = -ENAMETOOLONG;
3172 else
3173 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003174 }
Waiman Long232d2d62013-09-09 12:18:13 -04003175 *buffer = bptr;
3176 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003177 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003178}
3179
3180/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003181 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003182 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003183 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003184 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 * @buflen: buffer length
3186 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003187 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003189 * Returns a pointer into the buffer or an error code if the
3190 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003191 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003192 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003193 *
Al Viro02125a82011-12-05 08:43:34 -05003194 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 */
Al Viro02125a82011-12-05 08:43:34 -05003196char *__d_path(const struct path *path,
3197 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003198 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003200 char *res = buf + buflen;
3201 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003203 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003204 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003205
Al Viro02125a82011-12-05 08:43:34 -05003206 if (error < 0)
3207 return ERR_PTR(error);
3208 if (error > 0)
3209 return NULL;
3210 return res;
3211}
3212
3213char *d_absolute_path(const struct path *path,
3214 char *buf, int buflen)
3215{
3216 struct path root = {};
3217 char *res = buf + buflen;
3218 int error;
3219
3220 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003221 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003222
3223 if (error > 1)
3224 error = -EINVAL;
3225 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003226 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003227 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228}
3229
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003230/*
3231 * same as __d_path but appends "(deleted)" for unlinked files.
3232 */
Al Viro02125a82011-12-05 08:43:34 -05003233static int path_with_deleted(const struct path *path,
3234 const struct path *root,
3235 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003236{
3237 prepend(buf, buflen, "\0", 1);
3238 if (d_unlinked(path->dentry)) {
3239 int error = prepend(buf, buflen, " (deleted)", 10);
3240 if (error)
3241 return error;
3242 }
3243
3244 return prepend_path(path, root, buf, buflen);
3245}
3246
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003247static int prepend_unreachable(char **buffer, int *buflen)
3248{
3249 return prepend(buffer, buflen, "(unreachable)", 13);
3250}
3251
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003252static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3253{
3254 unsigned seq;
3255
3256 do {
3257 seq = read_seqcount_begin(&fs->seq);
3258 *root = fs->root;
3259 } while (read_seqcount_retry(&fs->seq, seq));
3260}
3261
Jan Bluncka03a8a702008-02-14 19:38:32 -08003262/**
3263 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003264 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003265 * @buf: buffer to return value in
3266 * @buflen: buffer length
3267 *
3268 * Convert a dentry into an ASCII path name. If the entry has been deleted
3269 * the string " (deleted)" is appended. Note that this is ambiguous.
3270 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003271 * Returns a pointer into the buffer or an error code if the path was
3272 * too long. Note: Callers should use the returned pointer, not the passed
3273 * in buffer, to use the name! The implementation often starts at an offset
3274 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003275 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003276 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003277 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003278char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003280 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003281 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003282 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003283
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003284 /*
3285 * We have various synthetic filesystems that never get mounted. On
3286 * these filesystems dentries are never used for lookup purposes, and
3287 * thus don't need to be hashed. They also don't need a name until a
3288 * user wants to identify the object in /proc/pid/fd/. The little hack
3289 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003290 *
3291 * Some pseudo inodes are mountable. When they are mounted
3292 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3293 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003294 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003295 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3296 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003297 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003298
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003299 rcu_read_lock();
3300 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003301 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003302 rcu_read_unlock();
3303
Al Viro02125a82011-12-05 08:43:34 -05003304 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003305 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306 return res;
3307}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003308EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003309
3310/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003311 * Helper function for dentry_operations.d_dname() members
3312 */
3313char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3314 const char *fmt, ...)
3315{
3316 va_list args;
3317 char temp[64];
3318 int sz;
3319
3320 va_start(args, fmt);
3321 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3322 va_end(args);
3323
3324 if (sz > sizeof(temp) || sz > buflen)
3325 return ERR_PTR(-ENAMETOOLONG);
3326
3327 buffer += buflen - sz;
3328 return memcpy(buffer, temp, sz);
3329}
3330
Al Viro118b2302013-08-24 12:08:17 -04003331char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3332{
3333 char *end = buffer + buflen;
3334 /* these dentries are never renamed, so d_lock is not needed */
3335 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003336 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003337 prepend(&end, &buflen, "/", 1))
3338 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003339 return end;
Al Viro118b2302013-08-24 12:08:17 -04003340}
David Herrmann31bbe162014-01-03 14:09:47 +01003341EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003342
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003343/*
Ram Pai6092d042008-03-27 13:06:20 +01003344 * Write full pathname from the root of the filesystem into the buffer.
3345 */
Al Virof6500802014-01-26 12:37:55 -05003346static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003347{
Al Virof6500802014-01-26 12:37:55 -05003348 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003349 char *end, *retval;
3350 int len, seq = 0;
3351 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003352
Al Virof6500802014-01-26 12:37:55 -05003353 if (buflen < 2)
3354 goto Elong;
3355
Al Viro48f5ec22013-09-09 15:22:25 -04003356 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003357restart:
Al Virof6500802014-01-26 12:37:55 -05003358 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003359 end = buf + buflen;
3360 len = buflen;
3361 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003362 /* Get '/' right */
3363 retval = end-1;
3364 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003365 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003366 while (!IS_ROOT(dentry)) {
3367 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003368
Ram Pai6092d042008-03-27 13:06:20 +01003369 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003370 error = prepend_name(&end, &len, &dentry->d_name);
3371 if (error)
3372 break;
Ram Pai6092d042008-03-27 13:06:20 +01003373
3374 retval = end;
3375 dentry = parent;
3376 }
Al Viro48f5ec22013-09-09 15:22:25 -04003377 if (!(seq & 1))
3378 rcu_read_unlock();
3379 if (need_seqretry(&rename_lock, seq)) {
3380 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003381 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003382 }
3383 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003384 if (error)
3385 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003386 return retval;
3387Elong:
3388 return ERR_PTR(-ENAMETOOLONG);
3389}
Nick Pigginec2447c2011-01-07 17:49:29 +11003390
3391char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3392{
Waiman Long232d2d62013-09-09 12:18:13 -04003393 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003394}
3395EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003396
3397char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3398{
3399 char *p = NULL;
3400 char *retval;
3401
Al Viroc1031352010-06-06 22:31:14 -04003402 if (d_unlinked(dentry)) {
3403 p = buf + buflen;
3404 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3405 goto Elong;
3406 buflen++;
3407 }
3408 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003409 if (!IS_ERR(retval) && p)
3410 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003411 return retval;
3412Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003413 return ERR_PTR(-ENAMETOOLONG);
3414}
3415
Linus Torvalds8b19e342013-09-12 10:35:47 -07003416static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3417 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003418{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003419 unsigned seq;
3420
3421 do {
3422 seq = read_seqcount_begin(&fs->seq);
3423 *root = fs->root;
3424 *pwd = fs->pwd;
3425 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003426}
3427
Ram Pai6092d042008-03-27 13:06:20 +01003428/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429 * NOTE! The user-level library version returns a
3430 * character pointer. The kernel system call just
3431 * returns the length of the buffer filled (which
3432 * includes the ending '\0' character), or a negative
3433 * error value. So libc would do something like
3434 *
3435 * char *getcwd(char * buf, size_t size)
3436 * {
3437 * int retval;
3438 *
3439 * retval = sys_getcwd(buf, size);
3440 * if (retval >= 0)
3441 * return buf;
3442 * errno = -retval;
3443 * return NULL;
3444 * }
3445 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003446SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003447{
Linus Torvalds552ce542007-02-13 12:08:18 -08003448 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003449 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003450 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451
3452 if (!page)
3453 return -ENOMEM;
3454
Linus Torvalds8b19e342013-09-12 10:35:47 -07003455 rcu_read_lock();
3456 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457
Linus Torvalds552ce542007-02-13 12:08:18 -08003458 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003459 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003460 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003461 char *cwd = page + PATH_MAX;
3462 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003464 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003465 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003466 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003467
Al Viro02125a82011-12-05 08:43:34 -05003468 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003469 goto out;
3470
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003471 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003472 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003473 error = prepend_unreachable(&cwd, &buflen);
3474 if (error)
3475 goto out;
3476 }
3477
Linus Torvalds552ce542007-02-13 12:08:18 -08003478 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003479 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003480 if (len <= size) {
3481 error = len;
3482 if (copy_to_user(buf, cwd, len))
3483 error = -EFAULT;
3484 }
Nick Piggin949854d2011-01-07 17:49:37 +11003485 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003486 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003488
3489out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003490 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003491 return error;
3492}
3493
3494/*
3495 * Test whether new_dentry is a subdirectory of old_dentry.
3496 *
3497 * Trivially implemented using the dcache structure
3498 */
3499
3500/**
3501 * is_subdir - is new dentry a subdirectory of old_dentry
3502 * @new_dentry: new dentry
3503 * @old_dentry: old dentry
3504 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003505 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3506 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3508 */
3509
Yaowei Baia6e57872015-11-17 14:40:11 +08003510bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511{
Yaowei Baia6e57872015-11-17 14:40:11 +08003512 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003513 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003515 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003516 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003517
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003518 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003521 /*
3522 * Need rcu_readlock to protect against the d_parent trashing
3523 * due to d_move
3524 */
3525 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003526 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003527 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003528 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003529 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003530 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532
3533 return result;
3534}
3535
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003536static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003538 struct dentry *root = data;
3539 if (dentry != root) {
3540 if (d_unhashed(dentry) || !dentry->d_inode)
3541 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003543 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3544 dentry->d_flags |= DCACHE_GENOCIDE;
3545 dentry->d_lockref.count--;
3546 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003548 return D_WALK_CONTINUE;
3549}
Nick Piggin58db63d2011-01-07 17:49:39 +11003550
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003551void d_genocide(struct dentry *parent)
3552{
3553 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554}
3555
Al Viro60545d02013-06-07 01:20:27 -04003556void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557{
Al Viro60545d02013-06-07 01:20:27 -04003558 inode_dec_link_count(inode);
3559 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003560 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003561 !d_unlinked(dentry));
3562 spin_lock(&dentry->d_parent->d_lock);
3563 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3564 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3565 (unsigned long long)inode->i_ino);
3566 spin_unlock(&dentry->d_lock);
3567 spin_unlock(&dentry->d_parent->d_lock);
3568 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003569}
Al Viro60545d02013-06-07 01:20:27 -04003570EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003571
3572static __initdata unsigned long dhash_entries;
3573static int __init set_dhash_entries(char *str)
3574{
3575 if (!str)
3576 return 0;
3577 dhash_entries = simple_strtoul(str, &str, 0);
3578 return 1;
3579}
3580__setup("dhash_entries=", set_dhash_entries);
3581
3582static void __init dcache_init_early(void)
3583{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003584 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585
3586 /* If hashes are distributed across NUMA nodes, defer
3587 * hash allocation until vmalloc space is available.
3588 */
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 HASH_EARLY,
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
Denis Cheng74bf17c2007-10-16 23:26:30 -07003607static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003609 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610
3611 /*
3612 * A constructor could be added for stable state like the lists,
3613 * but it is probably not worth it because of the cache nature
3614 * of the dcache.
3615 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003616 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003617 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003618
3619 /* Hash may have been set up in dcache_init_early */
3620 if (!hashdist)
3621 return;
3622
3623 dentry_hashtable =
3624 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003625 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003626 dhash_entries,
3627 13,
3628 0,
3629 &d_hash_shift,
3630 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003631 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632 0);
3633
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003634 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003635 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636}
3637
3638/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003639struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003640EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003641
Linus Torvalds1da177e2005-04-16 15:20:36 -07003642EXPORT_SYMBOL(d_genocide);
3643
Linus Torvalds1da177e2005-04-16 15:20:36 -07003644void __init vfs_caches_init_early(void)
3645{
3646 dcache_init_early();
3647 inode_init_early();
3648}
3649
Mel Gorman4248b0d2015-08-06 15:46:20 -07003650void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003652 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003653 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654
Denis Cheng74bf17c2007-10-16 23:26:30 -07003655 dcache_init();
3656 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003657 files_init();
3658 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003659 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660 bdev_cache_init();
3661 chrdev_init();
3662}