blob: b90cf8e09d5b90525330917a834b3153f86528df [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{
George Spelvin703b5fa2016-06-10 00:22:12 -0400109 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Al Viro94bdd652016-04-15 02:42:04 -0400112#define IN_LOOKUP_SHIFT 10
113static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
114
115static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
116 unsigned int hash)
117{
118 hash += (unsigned long) parent / L1_CACHE_BYTES;
119 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
120}
121
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Statistics gathering. */
124struct dentry_stat_t dentry_stat = {
125 .age_limit = 45,
126};
127
Glauber Costa3942c072013-08-28 10:17:53 +1000128static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000129static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400130
131#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000132
133/*
134 * Here we resort to our own counters instead of using generic per-cpu counters
135 * for consistency with what the vfs inode code does. We are expected to harvest
136 * better code and performance by having our own specialized counters.
137 *
138 * Please note that the loop is done over all possible CPUs, not over all online
139 * CPUs. The reason for this is that we don't want to play games with CPUs going
140 * on and off. If one of them goes off, we will just keep their counters.
141 *
142 * glommer: See cffbc8a for details, and if you ever intend to change this,
143 * please update all vfs counters to match.
144 */
Glauber Costa3942c072013-08-28 10:17:53 +1000145static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146{
147 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000148 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry, i);
151 return sum < 0 ? 0 : sum;
152}
153
Dave Chinner62d36c72013-08-28 10:17:54 +1000154static long get_nr_dentry_unused(void)
155{
156 int i;
157 long sum = 0;
158 for_each_possible_cpu(i)
159 sum += per_cpu(nr_dentry_unused, i);
160 return sum < 0 ? 0 : sum;
161}
162
Joe Perches1f7e0612014-06-06 14:38:05 -0700163int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400164 size_t *lenp, loff_t *ppos)
165{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000167 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000168 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169}
170#endif
171
Linus Torvalds5483f182012-03-04 15:51:42 -0800172/*
173 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
174 * The strings are both count bytes long, and count is non-zero.
175 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700176#ifdef CONFIG_DCACHE_WORD_ACCESS
177
178#include <asm/word-at-a-time.h>
179/*
180 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
181 * aligned allocation for this particular component. We don't
182 * strictly need the load_unaligned_zeropad() safety, but it
183 * doesn't hurt either.
184 *
185 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
186 * need the careful unaligned handling.
187 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700188static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800189{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800190 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191
192 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700193 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700194 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 if (tcount < sizeof(unsigned long))
196 break;
197 if (unlikely(a != b))
198 return 1;
199 cs += sizeof(unsigned long);
200 ct += sizeof(unsigned long);
201 tcount -= sizeof(unsigned long);
202 if (!tcount)
203 return 0;
204 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000205 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800206 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700207}
208
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800209#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210
Linus Torvalds94753db52012-05-10 12:19:19 -0700211static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212{
Linus Torvalds5483f182012-03-04 15:51:42 -0800213 do {
214 if (*cs != *ct)
215 return 1;
216 cs++;
217 ct++;
218 tcount--;
219 } while (tcount);
220 return 0;
221}
222
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700223#endif
224
Linus Torvalds94753db52012-05-10 12:19:19 -0700225static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
226{
Linus Torvalds94753db52012-05-10 12:19:19 -0700227 /*
228 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000229 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700230 *
231 * NOTE! Even if a rename will mean that the length
232 * was not loaded atomically, we don't care. The
233 * RCU walk will check the sequence count eventually,
234 * and catch it. And we won't overrun the buffer,
235 * because we're reading the name pointer atomically,
236 * and a dentry name is guaranteed to be properly
237 * terminated with a NUL byte.
238 *
239 * End result: even if 'len' is wrong, we'll exit
240 * early because the data cannot match (there can
241 * be no NUL in the ct/tcount data)
242 */
He Kuangae0a8432016-03-26 09:12:10 +0000243 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
244
Linus Torvalds6326c712012-05-21 16:14:04 -0700245 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700246}
247
Al Viro8d85b482014-09-29 14:54:27 -0400248struct external_name {
249 union {
250 atomic_t count;
251 struct rcu_head head;
252 } u;
253 unsigned char name[];
254};
255
256static inline struct external_name *external_name(struct dentry *dentry)
257{
258 return container_of(dentry->d_name.name, struct external_name, name[0]);
259}
260
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400261static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400263 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
264
Al Viro8d85b482014-09-29 14:54:27 -0400265 kmem_cache_free(dentry_cache, dentry);
266}
267
268static void __d_free_external(struct rcu_head *head)
269{
270 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400271 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 kmem_cache_free(dentry_cache, dentry);
273}
274
Al Viro810bb172014-10-12 12:45:37 -0400275static inline int dname_external(const struct dentry *dentry)
276{
277 return dentry->d_name.name != dentry->d_iname;
278}
279
David Howells4bf46a22015-03-05 14:09:22 +0000280static inline void __d_set_inode_and_type(struct dentry *dentry,
281 struct inode *inode,
282 unsigned type_flags)
283{
284 unsigned flags;
285
286 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000287 flags = READ_ONCE(dentry->d_flags);
288 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
289 flags |= type_flags;
290 WRITE_ONCE(dentry->d_flags, flags);
291}
292
David Howells4bf46a22015-03-05 14:09:22 +0000293static inline void __d_clear_type_and_inode(struct dentry *dentry)
294{
295 unsigned flags = READ_ONCE(dentry->d_flags);
296
297 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
298 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000299 dentry->d_inode = NULL;
300}
301
Al Virob4f03542014-04-29 23:40:14 -0400302static void dentry_free(struct dentry *dentry)
303{
Al Viro946e51f2014-10-26 19:19:16 -0400304 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400305 if (unlikely(dname_external(dentry))) {
306 struct external_name *p = external_name(dentry);
307 if (likely(atomic_dec_and_test(&p->u.count))) {
308 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
309 return;
310 }
311 }
Al Virob4f03542014-04-29 23:40:14 -0400312 /* if dentry was never visible to RCU, immediate free is OK */
313 if (!(dentry->d_flags & DCACHE_RCUACCESS))
314 __d_free(&dentry->d_u.d_rcu);
315 else
316 call_rcu(&dentry->d_u.d_rcu, __d_free);
317}
318
Nick Piggin31e6b012011-01-07 17:49:52 +1100319/**
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200320 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800321 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100322 * After this call, in-progress rcu-walk path lookup will fail. This
323 * should be called after unhashing, and after changing d_inode (if
324 * the dentry has not already been unhashed).
325 */
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200326static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
Nick Piggin31e6b012011-01-07 17:49:52 +1100327{
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200328 lockdep_assert_held(&dentry->d_lock);
329 /* Go through am invalidation barrier */
330 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100331}
332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333/*
334 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400335 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100336 */
337static void dentry_unlink_inode(struct dentry * dentry)
338 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100339 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100340{
341 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400342 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500343
Al Viro550dce02016-05-29 20:13:30 -0400344 if (hashed)
345 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000346 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400347 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400348 if (hashed)
349 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100350 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100351 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100352 if (!inode->i_nlink)
353 fsnotify_inoderemove(inode);
354 if (dentry->d_op && dentry->d_op->d_iput)
355 dentry->d_op->d_iput(dentry, inode);
356 else
357 iput(inode);
358}
359
360/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400361 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
362 * is in use - which includes both the "real" per-superblock
363 * LRU list _and_ the DCACHE_SHRINK_LIST use.
364 *
365 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
366 * on the shrink list (ie not on the superblock LRU list).
367 *
368 * The per-cpu "nr_dentry_unused" counters are updated with
369 * the DCACHE_LRU_LIST bit.
370 *
371 * These helper functions make sure we always follow the
372 * rules. d_lock must be held by the caller.
373 */
374#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
375static void d_lru_add(struct dentry *dentry)
376{
377 D_FLAG_VERIFY(dentry, 0);
378 dentry->d_flags |= DCACHE_LRU_LIST;
379 this_cpu_inc(nr_dentry_unused);
380 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
381}
382
383static void d_lru_del(struct dentry *dentry)
384{
385 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
386 dentry->d_flags &= ~DCACHE_LRU_LIST;
387 this_cpu_dec(nr_dentry_unused);
388 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
389}
390
391static void d_shrink_del(struct dentry *dentry)
392{
393 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
394 list_del_init(&dentry->d_lru);
395 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
396 this_cpu_dec(nr_dentry_unused);
397}
398
399static void d_shrink_add(struct dentry *dentry, struct list_head *list)
400{
401 D_FLAG_VERIFY(dentry, 0);
402 list_add(&dentry->d_lru, list);
403 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
404 this_cpu_inc(nr_dentry_unused);
405}
406
407/*
408 * These can only be called under the global LRU lock, ie during the
409 * callback for freeing the LRU list. "isolate" removes it from the
410 * LRU lists entirely, while shrink_move moves it to the indicated
411 * private list.
412 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800413static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400414{
415 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
416 dentry->d_flags &= ~DCACHE_LRU_LIST;
417 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800418 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400419}
420
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800421static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
422 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400423{
424 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
425 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800426 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400427}
428
429/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000430 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700431 */
432static void dentry_lru_add(struct dentry *dentry)
433{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400434 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
435 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700436}
437
Miklos Szeredid52b9082007-05-08 00:23:46 -0700438/**
Nick Piggin789680d2011-01-07 17:49:30 +1100439 * d_drop - drop a dentry
440 * @dentry: dentry to drop
441 *
442 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
443 * be found through a VFS lookup any more. Note that this is different from
444 * deleting the dentry - d_delete will try to mark the dentry negative if
445 * possible, giving a successful _negative_ lookup, while d_drop will
446 * just make the cache lookup fail.
447 *
448 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
449 * reason (NFS timeouts or autofs deletes).
450 *
451 * __d_drop requires dentry->d_lock.
452 */
453void __d_drop(struct dentry *dentry)
454{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700455 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400456 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400457 /*
458 * Hashed dentries are normally on the dentry hashtable,
459 * with the exception of those newly allocated by
460 * d_obtain_alias, which are always IS_ROOT:
461 */
462 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400463 b = &dentry->d_sb->s_anon;
464 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700465 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400466
467 hlist_bl_lock(b);
468 __hlist_bl_del(&dentry->d_hash);
469 dentry->d_hash.pprev = NULL;
470 hlist_bl_unlock(b);
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200471 dentry_rcuwalk_invalidate(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100472 }
473}
474EXPORT_SYMBOL(__d_drop);
475
476void d_drop(struct dentry *dentry)
477{
Nick Piggin789680d2011-01-07 17:49:30 +1100478 spin_lock(&dentry->d_lock);
479 __d_drop(dentry);
480 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100481}
482EXPORT_SYMBOL(d_drop);
483
Al Viroba65dc52016-06-10 11:32:47 -0400484static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
485{
486 struct dentry *next;
487 /*
488 * Inform d_walk() and shrink_dentry_list() that we are no longer
489 * attached to the dentry tree
490 */
491 dentry->d_flags |= DCACHE_DENTRY_KILLED;
492 if (unlikely(list_empty(&dentry->d_child)))
493 return;
494 __list_del_entry(&dentry->d_child);
495 /*
496 * Cursors can move around the list of children. While we'd been
497 * a normal list member, it didn't matter - ->d_child.next would've
498 * been updated. However, from now on it won't be and for the
499 * things like d_walk() it might end up with a nasty surprise.
500 * Normally d_walk() doesn't care about cursors moving around -
501 * ->d_lock on parent prevents that and since a cursor has no children
502 * of its own, we get through it without ever unlocking the parent.
503 * There is one exception, though - if we ascend from a child that
504 * gets killed as soon as we unlock it, the next sibling is found
505 * using the value left in its ->d_child.next. And if _that_
506 * pointed to a cursor, and cursor got moved (e.g. by lseek())
507 * before d_walk() regains parent->d_lock, we'll end up skipping
508 * everything the cursor had been moved past.
509 *
510 * Solution: make sure that the pointer left behind in ->d_child.next
511 * points to something that won't be moving around. I.e. skip the
512 * cursors.
513 */
514 while (dentry->d_child.next != &parent->d_subdirs) {
515 next = list_entry(dentry->d_child.next, struct dentry, d_child);
516 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
517 break;
518 dentry->d_child.next = next->d_child.next;
519 }
520}
521
Al Viroe55fd012014-05-28 13:51:12 -0400522static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100523{
Al Viro41edf272014-05-01 10:30:00 -0400524 struct dentry *parent = NULL;
525 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400526 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100527 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100528
Linus Torvalds0d984392013-09-08 13:46:52 -0700529 /*
530 * The dentry is now unrecoverably dead to the world.
531 */
532 lockref_mark_dead(&dentry->d_lockref);
533
Sage Weilf0023bc2011-10-28 10:02:42 -0700534 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700535 * inform the fs via d_prune that this dentry is about to be
536 * unhashed and destroyed.
537 */
Al Viro29266202014-05-30 11:39:02 -0400538 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800539 dentry->d_op->d_prune(dentry);
540
Al Viro01b60352014-04-29 23:42:52 -0400541 if (dentry->d_flags & DCACHE_LRU_LIST) {
542 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
543 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400544 }
Nick Piggin77812a12011-01-07 17:49:48 +1100545 /* if it was on the hash then remove it */
546 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400547 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400548 if (parent)
549 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400550 if (dentry->d_inode)
551 dentry_unlink_inode(dentry);
552 else
553 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400554 this_cpu_dec(nr_dentry);
555 if (dentry->d_op && dentry->d_op->d_release)
556 dentry->d_op->d_release(dentry);
557
Al Viro41edf272014-05-01 10:30:00 -0400558 spin_lock(&dentry->d_lock);
559 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
560 dentry->d_flags |= DCACHE_MAY_FREE;
561 can_free = false;
562 }
563 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400564 if (likely(can_free))
565 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400566}
567
568/*
569 * Finish off a dentry we've decided to kill.
570 * dentry->d_lock must be held, returns with it unlocked.
571 * If ref is non-zero, then decrement the refcount too.
572 * Returns dentry requiring refcount drop, or NULL if we're done.
573 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400574static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400575 __releases(dentry->d_lock)
576{
577 struct inode *inode = dentry->d_inode;
578 struct dentry *parent = NULL;
579
580 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
581 goto failed;
582
583 if (!IS_ROOT(dentry)) {
584 parent = dentry->d_parent;
585 if (unlikely(!spin_trylock(&parent->d_lock))) {
586 if (inode)
587 spin_unlock(&inode->i_lock);
588 goto failed;
589 }
590 }
591
592 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400593 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400594
595failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400596 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400597 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100598}
599
Al Viro046b9612014-05-29 08:54:52 -0400600static inline struct dentry *lock_parent(struct dentry *dentry)
601{
602 struct dentry *parent = dentry->d_parent;
603 if (IS_ROOT(dentry))
604 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800605 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400606 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400607 if (likely(spin_trylock(&parent->d_lock)))
608 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400609 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400610 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400611again:
612 parent = ACCESS_ONCE(dentry->d_parent);
613 spin_lock(&parent->d_lock);
614 /*
615 * We can't blindly lock dentry until we are sure
616 * that we won't violate the locking order.
617 * Any changes of dentry->d_parent must have
618 * been done with parent->d_lock held, so
619 * spin_lock() above is enough of a barrier
620 * for checking if it's still our child.
621 */
622 if (unlikely(parent != dentry->d_parent)) {
623 spin_unlock(&parent->d_lock);
624 goto again;
625 }
626 rcu_read_unlock();
627 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700628 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400629 else
630 parent = NULL;
631 return parent;
632}
633
Linus Torvalds360f5472015-01-09 15:19:03 -0800634/*
635 * Try to do a lockless dput(), and return whether that was successful.
636 *
637 * If unsuccessful, we return false, having already taken the dentry lock.
638 *
639 * The caller needs to hold the RCU read lock, so that the dentry is
640 * guaranteed to stay around even if the refcount goes down to zero!
641 */
642static inline bool fast_dput(struct dentry *dentry)
643{
644 int ret;
645 unsigned int d_flags;
646
647 /*
648 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100649 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800650 */
651 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
652 return lockref_put_or_lock(&dentry->d_lockref);
653
654 /*
655 * .. otherwise, we can try to just decrement the
656 * lockref optimistically.
657 */
658 ret = lockref_put_return(&dentry->d_lockref);
659
660 /*
661 * If the lockref_put_return() failed due to the lock being held
662 * by somebody else, the fast path has failed. We will need to
663 * get the lock, and then check the count again.
664 */
665 if (unlikely(ret < 0)) {
666 spin_lock(&dentry->d_lock);
667 if (dentry->d_lockref.count > 1) {
668 dentry->d_lockref.count--;
669 spin_unlock(&dentry->d_lock);
670 return 1;
671 }
672 return 0;
673 }
674
675 /*
676 * If we weren't the last ref, we're done.
677 */
678 if (ret)
679 return 1;
680
681 /*
682 * Careful, careful. The reference count went down
683 * to zero, but we don't hold the dentry lock, so
684 * somebody else could get it again, and do another
685 * dput(), and we need to not race with that.
686 *
687 * However, there is a very special and common case
688 * where we don't care, because there is nothing to
689 * do: the dentry is still hashed, it does not have
690 * a 'delete' op, and it's referenced and already on
691 * the LRU list.
692 *
693 * NOTE! Since we aren't locked, these values are
694 * not "stable". However, it is sufficient that at
695 * some point after we dropped the reference the
696 * dentry was hashed and the flags had the proper
697 * value. Other dentry users may have re-gotten
698 * a reference to the dentry and change that, but
699 * our work is done - we can leave the dentry
700 * around with a zero refcount.
701 */
702 smp_rmb();
703 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100704 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800705
706 /* Nothing to do? Dropping the reference was all we needed? */
707 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
708 return 1;
709
710 /*
711 * Not the fast normal case? Get the lock. We've already decremented
712 * the refcount, but we'll need to re-check the situation after
713 * getting the lock.
714 */
715 spin_lock(&dentry->d_lock);
716
717 /*
718 * Did somebody else grab a reference to it in the meantime, and
719 * we're no longer the last user after all? Alternatively, somebody
720 * else could have killed it and marked it dead. Either way, we
721 * don't need to do anything else.
722 */
723 if (dentry->d_lockref.count) {
724 spin_unlock(&dentry->d_lock);
725 return 1;
726 }
727
728 /*
729 * Re-get the reference we optimistically dropped. We hold the
730 * lock, and we just tested that it was zero, so we can just
731 * set it to 1.
732 */
733 dentry->d_lockref.count = 1;
734 return 0;
735}
736
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/*
739 * This is dput
740 *
741 * This is complicated by the fact that we do not want to put
742 * dentries that are no longer on any hash chain on the unused
743 * list: we'd much rather just get rid of them immediately.
744 *
745 * However, that implies that we have to traverse the dentry
746 * tree upwards to the parents which might _also_ now be
747 * scheduled for deletion (it may have been only waiting for
748 * its last child to go away).
749 *
750 * This tail recursion is done by hand as we don't want to depend
751 * on the compiler to always get this right (gcc generally doesn't).
752 * Real recursion would eat up our stack space.
753 */
754
755/*
756 * dput - release a dentry
757 * @dentry: dentry to release
758 *
759 * Release a dentry. This will drop the usage count and if appropriate
760 * call the dentry unlink method as well as removing it from the queues and
761 * releasing its resources. If the parent dentries were scheduled for release
762 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764void dput(struct dentry *dentry)
765{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700766 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return;
768
769repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800770 might_sleep();
771
Linus Torvalds360f5472015-01-09 15:19:03 -0800772 rcu_read_lock();
773 if (likely(fast_dput(dentry))) {
774 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800776 }
777
778 /* Slow case: now with the dentry lock held */
779 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Al Viro85c7f812016-04-14 19:52:13 -0400781 WARN_ON(d_in_lookup(dentry));
782
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700783 /* Unreachable? Get rid of it */
784 if (unlikely(d_unhashed(dentry)))
785 goto kill_it;
786
Al Viro75a6f822015-07-08 02:42:38 +0100787 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
788 goto kill_it;
789
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700790 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100792 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 }
Nick Piggin265ac902010-10-10 05:36:24 -0400794
Linus Torvalds358eec12013-10-31 15:43:02 -0700795 if (!(dentry->d_flags & DCACHE_REFERENCED))
796 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400797 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400798
Waiman Long98474232013-08-28 18:24:59 -0700799 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100800 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 return;
802
Miklos Szeredid52b9082007-05-08 00:23:46 -0700803kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400804 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800805 if (dentry) {
806 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700807 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800808 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700810EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100813/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100814static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
Waiman Long98474232013-08-28 18:24:59 -0700816 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
818
Nick Piggindc0474b2011-01-07 17:49:43 +1100819static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100820{
Waiman Long98474232013-08-28 18:24:59 -0700821 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100822}
823
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100824struct dentry *dget_parent(struct dentry *dentry)
825{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700826 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100827 struct dentry *ret;
828
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700829 /*
830 * Do optimistic parent lookup without any
831 * locking.
832 */
833 rcu_read_lock();
834 ret = ACCESS_ONCE(dentry->d_parent);
835 gotref = lockref_get_not_zero(&ret->d_lockref);
836 rcu_read_unlock();
837 if (likely(gotref)) {
838 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
839 return ret;
840 dput(ret);
841 }
842
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100843repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100844 /*
845 * Don't need rcu_dereference because we re-check it was correct under
846 * the lock.
847 */
848 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100849 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100850 spin_lock(&ret->d_lock);
851 if (unlikely(ret != dentry->d_parent)) {
852 spin_unlock(&ret->d_lock);
853 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100854 goto repeat;
855 }
Nick Piggina734eb42011-01-07 17:49:44 +1100856 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700857 BUG_ON(!ret->d_lockref.count);
858 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100859 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100860 return ret;
861}
862EXPORT_SYMBOL(dget_parent);
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864/**
865 * d_find_alias - grab a hashed alias of inode
866 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 *
868 * If inode has a hashed alias, or is a directory and has any alias,
869 * acquire the reference to alias and return it. Otherwise return NULL.
870 * Notice that if inode is a directory there can be only one alias and
871 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800872 * of a filesystem, or if the directory was renamed and d_revalidate
873 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700875 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500876 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500878static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879{
Nick Pigginda502952011-01-07 17:49:33 +1100880 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Nick Pigginda502952011-01-07 17:49:33 +1100882again:
883 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400884 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100885 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700887 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100888 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500890 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100891 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100892 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 return alias;
894 }
895 }
Nick Pigginda502952011-01-07 17:49:33 +1100896 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 }
Nick Pigginda502952011-01-07 17:49:33 +1100898 if (discon_alias) {
899 alias = discon_alias;
900 spin_lock(&alias->d_lock);
901 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500902 __dget_dlock(alias);
903 spin_unlock(&alias->d_lock);
904 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100905 }
906 spin_unlock(&alias->d_lock);
907 goto again;
908 }
909 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910}
911
Nick Pigginda502952011-01-07 17:49:33 +1100912struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
David Howells214fda12006-03-25 03:06:36 -0800914 struct dentry *de = NULL;
915
Al Virob3d9b7a2012-06-09 13:51:19 -0400916 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100917 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500918 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100919 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800920 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 return de;
922}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700923EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925/*
926 * Try to kill dentries associated with this inode.
927 * WARNING: you must own a reference to inode.
928 */
929void d_prune_aliases(struct inode *inode)
930{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700931 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100933 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400934 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700936 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400937 struct dentry *parent = lock_parent(dentry);
938 if (likely(!dentry->d_lockref.count)) {
939 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800940 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400941 goto restart;
942 }
943 if (parent)
944 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 }
946 spin_unlock(&dentry->d_lock);
947 }
Nick Piggin873feea2011-01-07 17:50:06 +1100948 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700950EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400952static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953{
Al Viro5c47e6d2014-04-29 16:13:18 -0400954 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700955
Miklos Szeredi60942f22014-05-02 15:38:39 -0400956 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400957 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400958 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100959 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400960 parent = lock_parent(dentry);
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000963 * The dispose list is isolated and dentries are not accounted
964 * to the LRU here, so we can simply remove it from the list
965 * here regardless of whether it is referenced or not.
966 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400967 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000968
969 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000971 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800973 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700974 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400975 if (parent)
976 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 continue;
978 }
Nick Piggin77812a12011-01-07 17:49:48 +1100979
Al Viro64fd72e2014-05-28 09:48:44 -0400980
981 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
982 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
983 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400984 if (parent)
985 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400986 if (can_free)
987 dentry_free(dentry);
988 continue;
989 }
990
Al Viroff2fde92014-05-28 13:59:13 -0400991 inode = dentry->d_inode;
992 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400993 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000994 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400995 if (parent)
996 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400997 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000998 }
Al Viroff2fde92014-05-28 13:59:13 -0400999
Al Viroff2fde92014-05-28 13:59:13 -04001000 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001001
Al Viro5c47e6d2014-04-29 16:13:18 -04001002 /*
1003 * We need to prune ancestors too. This is necessary to prevent
1004 * quadratic behavior of shrink_dcache_parent(), but is also
1005 * expected to be beneficial in reducing dentry cache
1006 * fragmentation.
1007 */
1008 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001009 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1010 parent = lock_parent(dentry);
1011 if (dentry->d_lockref.count != 1) {
1012 dentry->d_lockref.count--;
1013 spin_unlock(&dentry->d_lock);
1014 if (parent)
1015 spin_unlock(&parent->d_lock);
1016 break;
1017 }
1018 inode = dentry->d_inode; /* can't be NULL */
1019 if (unlikely(!spin_trylock(&inode->i_lock))) {
1020 spin_unlock(&dentry->d_lock);
1021 if (parent)
1022 spin_unlock(&parent->d_lock);
1023 cpu_relax();
1024 continue;
1025 }
1026 __dentry_kill(dentry);
1027 dentry = parent;
1028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001030}
1031
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001032static enum lru_status dentry_lru_isolate(struct list_head *item,
1033 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001034{
1035 struct list_head *freeable = arg;
1036 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1037
1038
1039 /*
1040 * we are inverting the lru lock/dentry->d_lock here,
1041 * so use a trylock. If we fail to get the lock, just skip
1042 * it
1043 */
1044 if (!spin_trylock(&dentry->d_lock))
1045 return LRU_SKIP;
1046
1047 /*
1048 * Referenced dentries are still in use. If they have active
1049 * counts, just remove them from the LRU. Otherwise give them
1050 * another pass through the LRU.
1051 */
1052 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001053 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001054 spin_unlock(&dentry->d_lock);
1055 return LRU_REMOVED;
1056 }
1057
1058 if (dentry->d_flags & DCACHE_REFERENCED) {
1059 dentry->d_flags &= ~DCACHE_REFERENCED;
1060 spin_unlock(&dentry->d_lock);
1061
1062 /*
1063 * The list move itself will be made by the common LRU code. At
1064 * this point, we've dropped the dentry->d_lock but keep the
1065 * lru lock. This is safe to do, since every list movement is
1066 * protected by the lru lock even if both locks are held.
1067 *
1068 * This is guaranteed by the fact that all LRU management
1069 * functions are intermediated by the LRU API calls like
1070 * list_lru_add and list_lru_del. List movement in this file
1071 * only ever occur through this functions or through callbacks
1072 * like this one, that are called from the LRU API.
1073 *
1074 * The only exceptions to this are functions like
1075 * shrink_dentry_list, and code that first checks for the
1076 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1077 * operating only with stack provided lists after they are
1078 * properly isolated from the main list. It is thus, always a
1079 * local access.
1080 */
1081 return LRU_ROTATE;
1082 }
1083
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001084 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001085 spin_unlock(&dentry->d_lock);
1086
1087 return LRU_REMOVED;
1088}
1089
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001090/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001091 * prune_dcache_sb - shrink the dcache
1092 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001093 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001094 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001095 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1096 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001097 * function.
1098 *
1099 * This function may fail to free any resources if all the dentries are in
1100 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001101 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001102long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001103{
Dave Chinnerf6041562013-08-28 10:18:00 +10001104 LIST_HEAD(dispose);
1105 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001106
Vladimir Davydov503c3582015-02-12 14:58:47 -08001107 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1108 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001109 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001110 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111}
1112
Glauber Costa4e717f52013-08-28 10:18:03 +10001113static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001114 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001115{
Glauber Costa4e717f52013-08-28 10:18:03 +10001116 struct list_head *freeable = arg;
1117 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001118
Glauber Costa4e717f52013-08-28 10:18:03 +10001119 /*
1120 * we are inverting the lru lock/dentry->d_lock here,
1121 * so use a trylock. If we fail to get the lock, just skip
1122 * it
1123 */
1124 if (!spin_trylock(&dentry->d_lock))
1125 return LRU_SKIP;
1126
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001127 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001128 spin_unlock(&dentry->d_lock);
1129
1130 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001131}
1132
Glauber Costa4e717f52013-08-28 10:18:03 +10001133
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001134/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 * shrink_dcache_sb - shrink dcache for a superblock
1136 * @sb: superblock
1137 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001138 * Shrink the dcache for the specified super block. This is used to free
1139 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001141void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142{
Glauber Costa4e717f52013-08-28 10:18:03 +10001143 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001144
Glauber Costa4e717f52013-08-28 10:18:03 +10001145 do {
1146 LIST_HEAD(dispose);
1147
1148 freed = list_lru_walk(&sb->s_dentry_lru,
1149 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1150
1151 this_cpu_sub(nr_dentry_unused, freed);
1152 shrink_dentry_list(&dispose);
1153 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001155EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001158 * enum d_walk_ret - action to talke during tree walk
1159 * @D_WALK_CONTINUE: contrinue walk
1160 * @D_WALK_QUIT: quit walk
1161 * @D_WALK_NORETRY: quit when retry is needed
1162 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001164enum d_walk_ret {
1165 D_WALK_CONTINUE,
1166 D_WALK_QUIT,
1167 D_WALK_NORETRY,
1168 D_WALK_SKIP,
1169};
1170
1171/**
1172 * d_walk - walk the dentry tree
1173 * @parent: start of walk
1174 * @data: data passed to @enter() and @finish()
1175 * @enter: callback when first entering the dentry
1176 * @finish: callback when successfully finished the walk
1177 *
1178 * The @enter() and @finish() callbacks are called with d_lock held.
1179 */
1180static void d_walk(struct dentry *parent, void *data,
1181 enum d_walk_ret (*enter)(void *, struct dentry *),
1182 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183{
Nick Piggin949854d2011-01-07 17:49:37 +11001184 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001186 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001187 enum d_walk_ret ret;
1188 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001189
Nick Piggin58db63d2011-01-07 17:49:39 +11001190again:
Al Viro48f5ec22013-09-09 15:22:25 -04001191 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001192 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001193 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001194
1195 ret = enter(data, this_parent);
1196 switch (ret) {
1197 case D_WALK_CONTINUE:
1198 break;
1199 case D_WALK_QUIT:
1200 case D_WALK_SKIP:
1201 goto out_unlock;
1202 case D_WALK_NORETRY:
1203 retry = false;
1204 break;
1205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206repeat:
1207 next = this_parent->d_subdirs.next;
1208resume:
1209 while (next != &this_parent->d_subdirs) {
1210 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001211 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001213
Al Viroba65dc52016-06-10 11:32:47 -04001214 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1215 continue;
1216
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001217 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218
1219 ret = enter(data, dentry);
1220 switch (ret) {
1221 case D_WALK_CONTINUE:
1222 break;
1223 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001224 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001225 goto out_unlock;
1226 case D_WALK_NORETRY:
1227 retry = false;
1228 break;
1229 case D_WALK_SKIP:
1230 spin_unlock(&dentry->d_lock);
1231 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001232 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001235 spin_unlock(&this_parent->d_lock);
1236 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001238 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 goto repeat;
1240 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001241 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 }
1243 /*
1244 * All done at this level ... ascend and resume the search.
1245 */
Al Viroca5358e2014-10-26 19:31:10 -04001246 rcu_read_lock();
1247ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001249 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001250 this_parent = child->d_parent;
1251
Al Viro31dec132013-10-25 17:04:27 -04001252 spin_unlock(&child->d_lock);
1253 spin_lock(&this_parent->d_lock);
1254
Al Viroca5358e2014-10-26 19:31:10 -04001255 /* might go back up the wrong parent if we have had a rename. */
1256 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001257 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001258 /* go into the first sibling still alive */
1259 do {
1260 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001261 if (next == &this_parent->d_subdirs)
1262 goto ascend;
1263 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001264 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001265 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 goto resume;
1267 }
Al Viroca5358e2014-10-26 19:31:10 -04001268 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001269 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001270 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001271 if (finish)
1272 finish(data);
1273
1274out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001275 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001276 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001277 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001278
1279rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001280 spin_unlock(&this_parent->d_lock);
1281 rcu_read_unlock();
1282 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001283 if (!retry)
1284 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001285 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001286 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001288
1289/*
1290 * Search for at least 1 mount point in the dentry's subdirs.
1291 * We descend to the next level whenever the d_subdirs
1292 * list is non-empty and continue searching.
1293 */
1294
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001295static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1296{
1297 int *ret = data;
1298 if (d_mountpoint(dentry)) {
1299 *ret = 1;
1300 return D_WALK_QUIT;
1301 }
1302 return D_WALK_CONTINUE;
1303}
1304
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001305/**
1306 * have_submounts - check for mounts over a dentry
1307 * @parent: dentry to check.
1308 *
1309 * Return true if the parent or its subdirectories contain
1310 * a mount point
1311 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001312int have_submounts(struct dentry *parent)
1313{
1314 int ret = 0;
1315
1316 d_walk(parent, &ret, check_mount, NULL);
1317
1318 return ret;
1319}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001320EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001323 * Called by mount code to set a mountpoint and check if the mountpoint is
1324 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1325 * subtree can become unreachable).
1326 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001327 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001328 * this reason take rename_lock and d_lock on dentry and ancestors.
1329 */
1330int d_set_mounted(struct dentry *dentry)
1331{
1332 struct dentry *p;
1333 int ret = -ENOENT;
1334 write_seqlock(&rename_lock);
1335 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001336 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001337 spin_lock(&p->d_lock);
1338 if (unlikely(d_unhashed(p))) {
1339 spin_unlock(&p->d_lock);
1340 goto out;
1341 }
1342 spin_unlock(&p->d_lock);
1343 }
1344 spin_lock(&dentry->d_lock);
1345 if (!d_unlinked(dentry)) {
1346 dentry->d_flags |= DCACHE_MOUNTED;
1347 ret = 0;
1348 }
1349 spin_unlock(&dentry->d_lock);
1350out:
1351 write_sequnlock(&rename_lock);
1352 return ret;
1353}
1354
1355/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001356 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 * and move any unused dentries to the end of the unused
1358 * list for prune_dcache(). We descend to the next level
1359 * whenever the d_subdirs list is non-empty and continue
1360 * searching.
1361 *
1362 * It returns zero iff there are no unused children,
1363 * otherwise it returns the number of children moved to
1364 * the end of the unused list. This may not be the total
1365 * number of unused children, because select_parent can
1366 * drop the lock and return early due to latency
1367 * constraints.
1368 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001369
1370struct select_data {
1371 struct dentry *start;
1372 struct list_head dispose;
1373 int found;
1374};
1375
1376static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001378 struct select_data *data = _data;
1379 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001381 if (data->start == dentry)
1382 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
Al Virofe915222014-05-03 00:02:25 -04001384 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001385 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001386 } else {
1387 if (dentry->d_flags & DCACHE_LRU_LIST)
1388 d_lru_del(dentry);
1389 if (!dentry->d_lockref.count) {
1390 d_shrink_add(dentry, &data->dispose);
1391 data->found++;
1392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 }
1394 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001395 * We can return to the caller if we have found some (this
1396 * ensures forward progress). We'll be coming back to find
1397 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 */
Al Virofe915222014-05-03 00:02:25 -04001399 if (!list_empty(&data->dispose))
1400 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001402 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403}
1404
1405/**
1406 * shrink_dcache_parent - prune dcache
1407 * @parent: parent of entries to prune
1408 *
1409 * Prune the dcache to remove unused children of the parent dentry.
1410 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001411void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001413 for (;;) {
1414 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001416 INIT_LIST_HEAD(&data.dispose);
1417 data.start = parent;
1418 data.found = 0;
1419
1420 d_walk(parent, &data, select_collect, NULL);
1421 if (!data.found)
1422 break;
1423
1424 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001425 cond_resched();
1426 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001428EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Al Viro9c8c10e2014-05-02 20:36:10 -04001430static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001431{
Al Viro9c8c10e2014-05-02 20:36:10 -04001432 /* it has busy descendents; complain about those instead */
1433 if (!list_empty(&dentry->d_subdirs))
1434 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001435
Al Viro9c8c10e2014-05-02 20:36:10 -04001436 /* root with refcount 1 is fine */
1437 if (dentry == _data && dentry->d_lockref.count == 1)
1438 return D_WALK_CONTINUE;
1439
1440 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1441 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001442 dentry,
1443 dentry->d_inode ?
1444 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001445 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001446 dentry->d_lockref.count,
1447 dentry->d_sb->s_type->name,
1448 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001449 WARN_ON(1);
1450 return D_WALK_CONTINUE;
1451}
1452
1453static void do_one_tree(struct dentry *dentry)
1454{
1455 shrink_dcache_parent(dentry);
1456 d_walk(dentry, dentry, umount_check, NULL);
1457 d_drop(dentry);
1458 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001459}
1460
1461/*
1462 * destroy the dentries attached to a superblock on unmounting
1463 */
1464void shrink_dcache_for_umount(struct super_block *sb)
1465{
1466 struct dentry *dentry;
1467
Al Viro9c8c10e2014-05-02 20:36:10 -04001468 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001469
1470 dentry = sb->s_root;
1471 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001472 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001473
1474 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001475 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1476 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001477 }
1478}
1479
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001480struct detach_data {
1481 struct select_data select;
1482 struct dentry *mountpoint;
1483};
1484static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001485{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001486 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001487
1488 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001489 __dget_dlock(dentry);
1490 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001491 return D_WALK_QUIT;
1492 }
1493
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001494 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001495}
1496
1497static void check_and_drop(void *_data)
1498{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001499 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001500
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001501 if (!data->mountpoint && !data->select.found)
1502 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001503}
1504
1505/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001506 * d_invalidate - detach submounts, prune dcache, and drop
1507 * @dentry: dentry to invalidate (aka detach, prune and drop)
1508 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001509 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001510 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001511 * The final d_drop is done as an atomic operation relative to
1512 * rename_lock ensuring there are no races with d_set_mounted. This
1513 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001514 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001515void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001516{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001517 /*
1518 * If it's already been dropped, return OK.
1519 */
1520 spin_lock(&dentry->d_lock);
1521 if (d_unhashed(dentry)) {
1522 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001523 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001524 }
1525 spin_unlock(&dentry->d_lock);
1526
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527 /* Negative dentries can be dropped without further checks */
1528 if (!dentry->d_inode) {
1529 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001530 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001531 }
1532
1533 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001535
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001536 data.mountpoint = NULL;
1537 INIT_LIST_HEAD(&data.select.dispose);
1538 data.select.start = dentry;
1539 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001540
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001541 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001542
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001543 if (data.select.found)
1544 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001545
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001546 if (data.mountpoint) {
1547 detach_mounts(data.mountpoint);
1548 dput(data.mountpoint);
1549 }
1550
1551 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552 break;
1553
1554 cond_resched();
1555 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001556}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001557EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001558
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559/**
Al Viroa4464db2011-07-07 15:03:58 -04001560 * __d_alloc - allocate a dcache entry
1561 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 * @name: qstr of the name
1563 *
1564 * Allocates a dentry. It returns %NULL if there is insufficient memory
1565 * available. On a success the dentry is returned. The name passed in is
1566 * copied and the copy passed in may be reused after this call.
1567 */
1568
Al Viroa4464db2011-07-07 15:03:58 -04001569struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
1571 struct dentry *dentry;
1572 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001573 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Mel Gormane12ba742007-10-16 01:25:52 -07001575 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 if (!dentry)
1577 return NULL;
1578
Linus Torvalds6326c712012-05-21 16:14:04 -07001579 /*
1580 * We guarantee that the inline name is always NUL-terminated.
1581 * This way the memcpy() done by the name switching in rename
1582 * will still always have a NUL at the end, even if we might
1583 * be overwriting an internal NUL character
1584 */
1585 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001586 if (unlikely(!name)) {
1587 static const struct qstr anon = QSTR_INIT("/", 1);
1588 name = &anon;
1589 dname = dentry->d_iname;
1590 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001591 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001592 struct external_name *p = kmalloc(size + name->len,
1593 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001594 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 kmem_cache_free(dentry_cache, dentry);
1596 return NULL;
1597 }
Al Viro8d85b482014-09-29 14:54:27 -04001598 atomic_set(&p->u.count, 1);
1599 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001600 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1601 kasan_unpoison_shadow(dname,
1602 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 } else {
1604 dname = dentry->d_iname;
1605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
1607 dentry->d_name.len = name->len;
1608 dentry->d_name.hash = name->hash;
1609 memcpy(dname, name->name, name->len);
1610 dname[name->len] = 0;
1611
Linus Torvalds6326c712012-05-21 16:14:04 -07001612 /* Make sure we always see the terminating NUL character */
1613 smp_wmb();
1614 dentry->d_name.name = dname;
1615
Waiman Long98474232013-08-28 18:24:59 -07001616 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001617 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001619 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001621 dentry->d_parent = dentry;
1622 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 dentry->d_op = NULL;
1624 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001625 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 INIT_LIST_HEAD(&dentry->d_lru);
1627 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001628 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1629 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001630 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Miklos Szeredi285b1022016-06-28 11:47:32 +02001632 if (dentry->d_op && dentry->d_op->d_init) {
1633 err = dentry->d_op->d_init(dentry);
1634 if (err) {
1635 if (dname_external(dentry))
1636 kfree(external_name(dentry));
1637 kmem_cache_free(dentry_cache, dentry);
1638 return NULL;
1639 }
1640 }
1641
Nick Piggin3e880fb2011-01-07 17:49:19 +11001642 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 return dentry;
1645}
Al Viroa4464db2011-07-07 15:03:58 -04001646
1647/**
1648 * d_alloc - allocate a dcache entry
1649 * @parent: parent of entry to allocate
1650 * @name: qstr of the name
1651 *
1652 * Allocates a dentry. It returns %NULL if there is insufficient memory
1653 * available. On a success the dentry is returned. The name passed in is
1654 * copied and the copy passed in may be reused after this call.
1655 */
1656struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1657{
1658 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1659 if (!dentry)
1660 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001661 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001662 spin_lock(&parent->d_lock);
1663 /*
1664 * don't need child lock because it is not subject
1665 * to concurrency here
1666 */
1667 __dget_dlock(parent);
1668 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001669 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001670 spin_unlock(&parent->d_lock);
1671
1672 return dentry;
1673}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001674EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Al Viroba65dc52016-06-10 11:32:47 -04001676struct dentry *d_alloc_cursor(struct dentry * parent)
1677{
1678 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1679 if (dentry) {
1680 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1681 dentry->d_parent = dget(parent);
1682 }
1683 return dentry;
1684}
1685
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001686/**
1687 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1688 * @sb: the superblock
1689 * @name: qstr of the name
1690 *
1691 * For a filesystem that just pins its dentries in memory and never
1692 * performs lookups at all, return an unhashed IS_ROOT dentry.
1693 */
Nick Piggin4b936882011-01-07 17:50:07 +11001694struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1695{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001696 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001697}
1698EXPORT_SYMBOL(d_alloc_pseudo);
1699
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1701{
1702 struct qstr q;
1703
1704 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001705 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 return d_alloc(parent, &q);
1707}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001708EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709
Nick Pigginfb045ad2011-01-07 17:49:55 +11001710void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1711{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001712 WARN_ON_ONCE(dentry->d_op);
1713 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001714 DCACHE_OP_COMPARE |
1715 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001716 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001717 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001718 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001719 dentry->d_op = op;
1720 if (!op)
1721 return;
1722 if (op->d_hash)
1723 dentry->d_flags |= DCACHE_OP_HASH;
1724 if (op->d_compare)
1725 dentry->d_flags |= DCACHE_OP_COMPARE;
1726 if (op->d_revalidate)
1727 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001728 if (op->d_weak_revalidate)
1729 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001730 if (op->d_delete)
1731 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001732 if (op->d_prune)
1733 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001734 if (op->d_real)
1735 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001736
1737}
1738EXPORT_SYMBOL(d_set_d_op);
1739
David Howellsdf1a0852015-01-29 12:02:28 +00001740
1741/*
1742 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1743 * @dentry - The dentry to mark
1744 *
1745 * Mark a dentry as falling through to the lower layer (as set with
1746 * d_pin_lower()). This flag may be recorded on the medium.
1747 */
1748void d_set_fallthru(struct dentry *dentry)
1749{
1750 spin_lock(&dentry->d_lock);
1751 dentry->d_flags |= DCACHE_FALLTHRU;
1752 spin_unlock(&dentry->d_lock);
1753}
1754EXPORT_SYMBOL(d_set_fallthru);
1755
David Howellsb18825a2013-09-12 19:22:53 +01001756static unsigned d_flags_for_inode(struct inode *inode)
1757{
David Howells44bdb5e2015-01-29 12:02:29 +00001758 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001759
1760 if (!inode)
1761 return DCACHE_MISS_TYPE;
1762
1763 if (S_ISDIR(inode->i_mode)) {
1764 add_flags = DCACHE_DIRECTORY_TYPE;
1765 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1766 if (unlikely(!inode->i_op->lookup))
1767 add_flags = DCACHE_AUTODIR_TYPE;
1768 else
1769 inode->i_opflags |= IOP_LOOKUP;
1770 }
David Howells44bdb5e2015-01-29 12:02:29 +00001771 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001772 }
1773
David Howells44bdb5e2015-01-29 12:02:29 +00001774 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001775 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001776 add_flags = DCACHE_SYMLINK_TYPE;
1777 goto type_determined;
1778 }
1779 inode->i_opflags |= IOP_NOFOLLOW;
1780 }
1781
1782 if (unlikely(!S_ISREG(inode->i_mode)))
1783 add_flags = DCACHE_SPECIAL_TYPE;
1784
1785type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001786 if (unlikely(IS_AUTOMOUNT(inode)))
1787 add_flags |= DCACHE_NEED_AUTOMOUNT;
1788 return add_flags;
1789}
1790
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001791static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1792{
David Howellsb18825a2013-09-12 19:22:53 +01001793 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001794 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001795
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001796 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001797 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001798 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001799 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001800 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001801 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001802 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001803}
1804
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805/**
1806 * d_instantiate - fill in inode information for a dentry
1807 * @entry: dentry to complete
1808 * @inode: inode to attach to this dentry
1809 *
1810 * Fill in inode information in the entry.
1811 *
1812 * This turns negative dentries into productive full members
1813 * of society.
1814 *
1815 * NOTE! This assumes that the inode count has been incremented
1816 * (or otherwise set) by the caller to indicate that it is now
1817 * in use by the dcache.
1818 */
1819
1820void d_instantiate(struct dentry *entry, struct inode * inode)
1821{
Al Viro946e51f2014-10-26 19:19:16 -04001822 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001823 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001824 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001825 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001826 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001827 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001828 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001830EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
1832/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001833 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1834 * @entry: dentry to complete
1835 * @inode: inode to attach to this dentry
1836 *
1837 * Fill in inode information in the entry. If a directory alias is found, then
1838 * return an error (and drop inode). Together with d_materialise_unique() this
1839 * guarantees that a directory inode may never have more than one alias.
1840 */
1841int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1842{
Al Viro946e51f2014-10-26 19:19:16 -04001843 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001844
Al Virob9680912016-04-11 00:53:26 -04001845 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001846 spin_lock(&inode->i_lock);
1847 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1848 spin_unlock(&inode->i_lock);
1849 iput(inode);
1850 return -EBUSY;
1851 }
1852 __d_instantiate(entry, inode);
1853 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001854
1855 return 0;
1856}
1857EXPORT_SYMBOL(d_instantiate_no_diralias);
1858
Al Viroadc0e912012-01-08 16:49:21 -05001859struct dentry *d_make_root(struct inode *root_inode)
1860{
1861 struct dentry *res = NULL;
1862
1863 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001864 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001865 if (res)
1866 d_instantiate(res, root_inode);
1867 else
1868 iput(root_inode);
1869 }
1870 return res;
1871}
1872EXPORT_SYMBOL(d_make_root);
1873
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001874static struct dentry * __d_find_any_alias(struct inode *inode)
1875{
1876 struct dentry *alias;
1877
Al Virob3d9b7a2012-06-09 13:51:19 -04001878 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001879 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001880 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001881 __dget(alias);
1882 return alias;
1883}
1884
Sage Weil46f72b32012-01-10 09:04:37 -08001885/**
1886 * d_find_any_alias - find any alias for a given inode
1887 * @inode: inode to find an alias for
1888 *
1889 * If any aliases exist for the given inode, take and return a
1890 * reference for one of them. If no aliases exist, return %NULL.
1891 */
1892struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001893{
1894 struct dentry *de;
1895
1896 spin_lock(&inode->i_lock);
1897 de = __d_find_any_alias(inode);
1898 spin_unlock(&inode->i_lock);
1899 return de;
1900}
Sage Weil46f72b32012-01-10 09:04:37 -08001901EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001902
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001903static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001904{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001905 struct dentry *tmp;
1906 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001907 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001908
1909 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001910 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001911 if (IS_ERR(inode))
1912 return ERR_CAST(inode);
1913
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001914 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001915 if (res)
1916 goto out_iput;
1917
Al Viro798434b2016-03-24 20:38:43 -04001918 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001919 if (!tmp) {
1920 res = ERR_PTR(-ENOMEM);
1921 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001922 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001923
Al Virob9680912016-04-11 00:53:26 -04001924 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001925 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001926 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001927 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001928 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001929 dput(tmp);
1930 goto out_iput;
1931 }
1932
1933 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001934 add_flags = d_flags_for_inode(inode);
1935
1936 if (disconnected)
1937 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001938
Christoph Hellwig9308a612008-08-11 15:49:12 +02001939 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001940 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001941 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001942 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001943 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001944 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001945 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001946 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001947
Christoph Hellwig9308a612008-08-11 15:49:12 +02001948 return tmp;
1949
1950 out_iput:
1951 iput(inode);
1952 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001953}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001954
1955/**
1956 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1957 * @inode: inode to allocate the dentry for
1958 *
1959 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1960 * similar open by handle operations. The returned dentry may be anonymous,
1961 * or may have a full name (if the inode was already in the cache).
1962 *
1963 * When called on a directory inode, we must ensure that the inode only ever
1964 * has one dentry. If a dentry is found, that is returned instead of
1965 * allocating a new one.
1966 *
1967 * On successful return, the reference to the inode has been transferred
1968 * to the dentry. In case of an error the reference on the inode is released.
1969 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1970 * be passed in and the error will be propagated to the return value,
1971 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1972 */
1973struct dentry *d_obtain_alias(struct inode *inode)
1974{
1975 return __d_obtain_alias(inode, 1);
1976}
Benny Halevyadc48722009-02-27 14:02:59 -08001977EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
1979/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001980 * d_obtain_root - find or allocate a dentry for a given inode
1981 * @inode: inode to allocate the dentry for
1982 *
1983 * Obtain an IS_ROOT dentry for the root of a filesystem.
1984 *
1985 * We must ensure that directory inodes only ever have one dentry. If a
1986 * dentry is found, that is returned instead of allocating a new one.
1987 *
1988 * On successful return, the reference to the inode has been transferred
1989 * to the dentry. In case of an error the reference on the inode is
1990 * released. A %NULL or IS_ERR inode may be passed in and will be the
1991 * error will be propagate to the return value, with a %NULL @inode
1992 * replaced by ERR_PTR(-ESTALE).
1993 */
1994struct dentry *d_obtain_root(struct inode *inode)
1995{
1996 return __d_obtain_alias(inode, 0);
1997}
1998EXPORT_SYMBOL(d_obtain_root);
1999
2000/**
Barry Naujok94035402008-05-21 16:50:46 +10002001 * d_add_ci - lookup or allocate new dentry with case-exact name
2002 * @inode: the inode case-insensitive lookup has found
2003 * @dentry: the negative dentry that was passed to the parent's lookup func
2004 * @name: the case-exact name to be associated with the returned dentry
2005 *
2006 * This is to avoid filling the dcache with case-insensitive names to the
2007 * same inode, only the actual correct case is stored in the dcache for
2008 * case-insensitive filesystems.
2009 *
2010 * For a case-insensitive lookup match and if the the case-exact dentry
2011 * already exists in in the dcache, use it and return it.
2012 *
2013 * If no entry exists with the exact case name, allocate new dentry with
2014 * the exact case, and return the spliced entry.
2015 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002016struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002017 struct qstr *name)
2018{
Al Virod9171b92016-04-15 03:33:13 -04002019 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002020
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002021 /*
2022 * First check if a dentry matching the name already exists,
2023 * if not go ahead and create it now.
2024 */
Barry Naujok94035402008-05-21 16:50:46 +10002025 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002026 if (found) {
2027 iput(inode);
2028 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002029 }
Al Virod9171b92016-04-15 03:33:13 -04002030 if (d_in_lookup(dentry)) {
2031 found = d_alloc_parallel(dentry->d_parent, name,
2032 dentry->d_wait);
2033 if (IS_ERR(found) || !d_in_lookup(found)) {
2034 iput(inode);
2035 return found;
2036 }
2037 } else {
2038 found = d_alloc(dentry->d_parent, name);
2039 if (!found) {
2040 iput(inode);
2041 return ERR_PTR(-ENOMEM);
2042 }
2043 }
2044 res = d_splice_alias(inode, found);
2045 if (res) {
2046 dput(found);
2047 return res;
2048 }
Al Viro4f522a22013-02-11 23:20:37 -05002049 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002050}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002051EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002053
Al Virod4c91a82016-06-25 23:33:49 -04002054static inline bool d_same_name(const struct dentry *dentry,
2055 const struct dentry *parent,
2056 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002057{
Al Virod4c91a82016-06-25 23:33:49 -04002058 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2059 if (dentry->d_name.len != name->len)
2060 return false;
2061 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002062 }
Al Virod4c91a82016-06-25 23:33:49 -04002063 return parent->d_op->d_compare(parent, dentry,
2064 dentry->d_name.len, dentry->d_name.name,
2065 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002066}
2067
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002069 * __d_lookup_rcu - search for a dentry (racy, store-free)
2070 * @parent: parent dentry
2071 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002072 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002073 * Returns: dentry, or NULL
2074 *
2075 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2076 * resolution (store-free path walking) design described in
2077 * Documentation/filesystems/path-lookup.txt.
2078 *
2079 * This is not to be used outside core vfs.
2080 *
2081 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2082 * held, and rcu_read_lock held. The returned dentry must not be stored into
2083 * without taking d_lock and checking d_seq sequence count against @seq
2084 * returned here.
2085 *
Linus Torvalds15570082013-09-02 11:38:06 -07002086 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002087 * function.
2088 *
2089 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2090 * the returned dentry, so long as its parent's seqlock is checked after the
2091 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2092 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002093 *
2094 * NOTE! The caller *has* to check the resulting dentry against the sequence
2095 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002097struct dentry *__d_lookup_rcu(const struct dentry *parent,
2098 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002099 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002100{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002101 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002102 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002103 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002104 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002105 struct dentry *dentry;
2106
2107 /*
2108 * Note: There is significant duplication with __d_lookup_rcu which is
2109 * required to prevent single threaded performance regressions
2110 * especially on architectures where smp_rmb (in seqcounts) are costly.
2111 * Keep the two functions in sync.
2112 */
2113
2114 /*
2115 * The hash list is protected using RCU.
2116 *
2117 * Carefully use d_seq when comparing a candidate dentry, to avoid
2118 * races with d_move().
2119 *
2120 * It is possible that concurrent renames can mess up our list
2121 * walk here and result in missing our dentry, resulting in the
2122 * false-negative result. d_lookup() protects against concurrent
2123 * renames using rename_lock seqlock.
2124 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002125 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002126 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002127 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002128 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002129
Nick Piggin31e6b012011-01-07 17:49:52 +11002130seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002131 /*
2132 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002133 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002134 *
2135 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002136 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002137 *
2138 * NOTE! We do a "raw" seqcount_begin here. That means that
2139 * we don't wait for the sequence count to stabilize if it
2140 * is in the middle of a sequence change. If we do the slow
2141 * dentry compare, we will do seqretries until it is stable,
2142 * and if we end up with a successful lookup, we actually
2143 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002144 *
2145 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2146 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002147 */
2148 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002149 if (dentry->d_parent != parent)
2150 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002151 if (d_unhashed(dentry))
2152 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002153
2154 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002155 int tlen;
2156 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002157 if (dentry->d_name.hash != hashlen_hash(hashlen))
2158 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002159 tlen = dentry->d_name.len;
2160 tname = dentry->d_name.name;
2161 /* we want a consistent (name,len) pair */
2162 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2163 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002164 goto seqretry;
2165 }
Al Virod4c91a82016-06-25 23:33:49 -04002166 if (parent->d_op->d_compare(parent, dentry,
2167 tlen, tname, name) != 0)
2168 continue;
2169 } else {
2170 if (dentry->d_name.hash_len != hashlen)
2171 continue;
2172 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2173 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002174 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002175 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002176 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002177 }
2178 return NULL;
2179}
2180
2181/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 * d_lookup - search for a dentry
2183 * @parent: parent dentry
2184 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002185 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002187 * d_lookup searches the children of the parent dentry for the name in
2188 * question. If the dentry is found its reference count is incremented and the
2189 * dentry is returned. The caller must use dput to free the entry when it has
2190 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 */
Al Viroda2d8452013-01-24 18:29:34 -05002192struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193{
Nick Piggin31e6b012011-01-07 17:49:52 +11002194 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002195 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196
Daeseok Younb8314f92014-08-11 11:46:53 +09002197 do {
2198 seq = read_seqbegin(&rename_lock);
2199 dentry = __d_lookup(parent, name);
2200 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 break;
2202 } while (read_seqretry(&rename_lock, seq));
2203 return dentry;
2204}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002205EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206
Nick Piggin31e6b012011-01-07 17:49:52 +11002207/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002208 * __d_lookup - search for a dentry (racy)
2209 * @parent: parent dentry
2210 * @name: qstr of name we wish to find
2211 * Returns: dentry, or NULL
2212 *
2213 * __d_lookup is like d_lookup, however it may (rarely) return a
2214 * false-negative result due to unrelated rename activity.
2215 *
2216 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2217 * however it must be used carefully, eg. with a following d_lookup in
2218 * the case of failure.
2219 *
2220 * __d_lookup callers must be commented.
2221 */
Al Viroa713ca22013-01-24 18:27:00 -05002222struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002225 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002226 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002227 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002228 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
Nick Pigginb04f7842010-08-18 04:37:34 +10002230 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002231 * Note: There is significant duplication with __d_lookup_rcu which is
2232 * required to prevent single threaded performance regressions
2233 * especially on architectures where smp_rmb (in seqcounts) are costly.
2234 * Keep the two functions in sync.
2235 */
2236
2237 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002238 * The hash list is protected using RCU.
2239 *
2240 * Take d_lock when comparing a candidate dentry, to avoid races
2241 * with d_move().
2242 *
2243 * It is possible that concurrent renames can mess up our list
2244 * walk here and result in missing our dentry, resulting in the
2245 * false-negative result. d_lookup() protects against concurrent
2246 * renames using rename_lock seqlock.
2247 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002248 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002249 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 rcu_read_lock();
2251
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002252 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 if (dentry->d_name.hash != hash)
2255 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
2257 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 if (dentry->d_parent != parent)
2259 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002260 if (d_unhashed(dentry))
2261 goto next;
2262
Al Virod4c91a82016-06-25 23:33:49 -04002263 if (!d_same_name(dentry, parent, name))
2264 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265
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{
Al Viro94bdd652016-04-15 02:42:04 -04002417 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002418 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2419 struct hlist_bl_node *node;
2420 struct dentry *new = d_alloc(parent, name);
2421 struct dentry *dentry;
2422 unsigned seq, r_seq, d_seq;
2423
2424 if (unlikely(!new))
2425 return ERR_PTR(-ENOMEM);
2426
2427retry:
2428 rcu_read_lock();
2429 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2430 r_seq = read_seqbegin(&rename_lock);
2431 dentry = __d_lookup_rcu(parent, name, &d_seq);
2432 if (unlikely(dentry)) {
2433 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2434 rcu_read_unlock();
2435 goto retry;
2436 }
2437 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2438 rcu_read_unlock();
2439 dput(dentry);
2440 goto retry;
2441 }
2442 rcu_read_unlock();
2443 dput(new);
2444 return dentry;
2445 }
2446 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2447 rcu_read_unlock();
2448 goto retry;
2449 }
2450 hlist_bl_lock(b);
2451 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2452 hlist_bl_unlock(b);
2453 rcu_read_unlock();
2454 goto retry;
2455 }
Al Viro94bdd652016-04-15 02:42:04 -04002456 /*
2457 * No changes for the parent since the beginning of d_lookup().
2458 * Since all removals from the chain happen with hlist_bl_lock(),
2459 * any potential in-lookup matches are going to stay here until
2460 * we unlock the chain. All fields are stable in everything
2461 * we encounter.
2462 */
2463 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2464 if (dentry->d_name.hash != hash)
2465 continue;
2466 if (dentry->d_parent != parent)
2467 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002468 if (!d_same_name(dentry, parent, name))
2469 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002470 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002471 /* now we can try to grab a reference */
2472 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2473 rcu_read_unlock();
2474 goto retry;
2475 }
2476
2477 rcu_read_unlock();
2478 /*
2479 * somebody is likely to be still doing lookup for it;
2480 * wait for them to finish
2481 */
Al Virod9171b92016-04-15 03:33:13 -04002482 spin_lock(&dentry->d_lock);
2483 d_wait_lookup(dentry);
2484 /*
2485 * it's not in-lookup anymore; in principle we should repeat
2486 * everything from dcache lookup, but it's likely to be what
2487 * d_lookup() would've found anyway. If it is, just return it;
2488 * otherwise we really have to repeat the whole thing.
2489 */
2490 if (unlikely(dentry->d_name.hash != hash))
2491 goto mismatch;
2492 if (unlikely(dentry->d_parent != parent))
2493 goto mismatch;
2494 if (unlikely(d_unhashed(dentry)))
2495 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002496 if (unlikely(!d_same_name(dentry, parent, name)))
2497 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002498 /* OK, it *is* a hashed match; return it */
2499 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002500 dput(new);
2501 return dentry;
2502 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002503 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002504 /* we can't take ->d_lock here; it's OK, though. */
2505 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002506 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002507 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2508 hlist_bl_unlock(b);
2509 return new;
Al Virod9171b92016-04-15 03:33:13 -04002510mismatch:
2511 spin_unlock(&dentry->d_lock);
2512 dput(dentry);
2513 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002514}
2515EXPORT_SYMBOL(d_alloc_parallel);
2516
Al Viro85c7f812016-04-14 19:52:13 -04002517void __d_lookup_done(struct dentry *dentry)
2518{
Al Viro94bdd652016-04-15 02:42:04 -04002519 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2520 dentry->d_name.hash);
2521 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002522 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002523 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002524 wake_up_all(dentry->d_wait);
2525 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002526 hlist_bl_unlock(b);
2527 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002528 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002529}
2530EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002531
2532/* inode->i_lock held if inode is non-NULL */
2533
2534static inline void __d_add(struct dentry *dentry, struct inode *inode)
2535{
Al Viro84e710d2016-04-15 00:58:55 -04002536 struct inode *dir = NULL;
2537 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002538 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002539 if (unlikely(d_in_lookup(dentry))) {
2540 dir = dentry->d_parent->d_inode;
2541 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002542 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002543 }
Al Viroed782b52016-03-09 19:52:39 -05002544 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002545 unsigned add_flags = d_flags_for_inode(inode);
2546 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2547 raw_write_seqcount_begin(&dentry->d_seq);
2548 __d_set_inode_and_type(dentry, inode, add_flags);
2549 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002550 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002551 }
Al Viro0568d702016-04-14 19:40:56 -04002552 _d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002553 if (dir)
2554 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002555 spin_unlock(&dentry->d_lock);
2556 if (inode)
2557 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002558}
2559
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002560/**
Al Viro34d0d192016-03-08 21:01:03 -05002561 * d_add - add dentry to hash queues
2562 * @entry: dentry to add
2563 * @inode: The inode to attach to this dentry
2564 *
2565 * This adds the entry to the hash queues and initializes @inode.
2566 * The entry was actually filled in earlier during d_alloc().
2567 */
2568
2569void d_add(struct dentry *entry, struct inode *inode)
2570{
Al Virob9680912016-04-11 00:53:26 -04002571 if (inode) {
2572 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002573 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002574 }
Al Viroed782b52016-03-09 19:52:39 -05002575 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002576}
2577EXPORT_SYMBOL(d_add);
2578
2579/**
Al Viro668d0cd2016-03-08 12:44:17 -05002580 * d_exact_alias - find and hash an exact unhashed alias
2581 * @entry: dentry to add
2582 * @inode: The inode to go with this dentry
2583 *
2584 * If an unhashed dentry with the same name/parent and desired
2585 * inode already exists, hash and return it. Otherwise, return
2586 * NULL.
2587 *
2588 * Parent directory should be locked.
2589 */
2590struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2591{
2592 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002593 unsigned int hash = entry->d_name.hash;
2594
2595 spin_lock(&inode->i_lock);
2596 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2597 /*
2598 * Don't need alias->d_lock here, because aliases with
2599 * d_parent == entry->d_parent are not subject to name or
2600 * parent changes, because the parent inode i_mutex is held.
2601 */
2602 if (alias->d_name.hash != hash)
2603 continue;
2604 if (alias->d_parent != entry->d_parent)
2605 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002606 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002607 continue;
2608 spin_lock(&alias->d_lock);
2609 if (!d_unhashed(alias)) {
2610 spin_unlock(&alias->d_lock);
2611 alias = NULL;
2612 } else {
2613 __dget_dlock(alias);
2614 _d_rehash(alias);
2615 spin_unlock(&alias->d_lock);
2616 }
2617 spin_unlock(&inode->i_lock);
2618 return alias;
2619 }
2620 spin_unlock(&inode->i_lock);
2621 return NULL;
2622}
2623EXPORT_SYMBOL(d_exact_alias);
2624
2625/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002626 * dentry_update_name_case - update case insensitive dentry with a new name
2627 * @dentry: dentry to be updated
2628 * @name: new name
2629 *
2630 * Update a case insensitive dentry with new case of name.
2631 *
2632 * dentry must have been returned by d_lookup with name @name. Old and new
2633 * name lengths must match (ie. no d_compare which allows mismatched name
2634 * lengths).
2635 *
2636 * Parent inode i_mutex must be held over d_lookup and into this call (to
2637 * keep renames and concurrent inserts, and readdir(2) away).
2638 */
2639void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2640{
Al Viro59551022016-01-22 15:40:57 -05002641 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002642 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2643
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002644 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002645 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002646 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002647 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002648 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002649}
2650EXPORT_SYMBOL(dentry_update_name_case);
2651
Al Viro8d85b482014-09-29 14:54:27 -04002652static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653{
Al Viro8d85b482014-09-29 14:54:27 -04002654 if (unlikely(dname_external(target))) {
2655 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 /*
2657 * Both external: swap the pointers
2658 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002659 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 } else {
2661 /*
2662 * dentry:internal, target:external. Steal target's
2663 * storage and make target internal.
2664 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002665 memcpy(target->d_iname, dentry->d_name.name,
2666 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 dentry->d_name.name = target->d_name.name;
2668 target->d_name.name = target->d_iname;
2669 }
2670 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002671 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672 /*
2673 * dentry:external, target:internal. Give dentry's
2674 * storage to target and make dentry internal
2675 */
2676 memcpy(dentry->d_iname, target->d_name.name,
2677 target->d_name.len + 1);
2678 target->d_name.name = dentry->d_name.name;
2679 dentry->d_name.name = dentry->d_iname;
2680 } else {
2681 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002682 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002684 unsigned int i;
2685 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002686 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2687 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002688 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2689 swap(((long *) &dentry->d_iname)[i],
2690 ((long *) &target->d_iname)[i]);
2691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 }
2693 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002694 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695}
2696
Al Viro8d85b482014-09-29 14:54:27 -04002697static void copy_name(struct dentry *dentry, struct dentry *target)
2698{
2699 struct external_name *old_name = NULL;
2700 if (unlikely(dname_external(dentry)))
2701 old_name = external_name(dentry);
2702 if (unlikely(dname_external(target))) {
2703 atomic_inc(&external_name(target)->u.count);
2704 dentry->d_name = target->d_name;
2705 } else {
2706 memcpy(dentry->d_iname, target->d_name.name,
2707 target->d_name.len + 1);
2708 dentry->d_name.name = dentry->d_iname;
2709 dentry->d_name.hash_len = target->d_name.hash_len;
2710 }
2711 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2712 kfree_rcu(old_name, u.head);
2713}
2714
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002715static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2716{
2717 /*
2718 * XXXX: do we really need to take target->d_lock?
2719 */
2720 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2721 spin_lock(&target->d_parent->d_lock);
2722 else {
2723 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2724 spin_lock(&dentry->d_parent->d_lock);
2725 spin_lock_nested(&target->d_parent->d_lock,
2726 DENTRY_D_LOCK_NESTED);
2727 } else {
2728 spin_lock(&target->d_parent->d_lock);
2729 spin_lock_nested(&dentry->d_parent->d_lock,
2730 DENTRY_D_LOCK_NESTED);
2731 }
2732 }
2733 if (target < dentry) {
2734 spin_lock_nested(&target->d_lock, 2);
2735 spin_lock_nested(&dentry->d_lock, 3);
2736 } else {
2737 spin_lock_nested(&dentry->d_lock, 2);
2738 spin_lock_nested(&target->d_lock, 3);
2739 }
2740}
2741
Al Viro986c0192014-09-26 23:11:15 -04002742static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002743{
2744 if (target->d_parent != dentry->d_parent)
2745 spin_unlock(&dentry->d_parent->d_lock);
2746 if (target->d_parent != target)
2747 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002748 spin_unlock(&target->d_lock);
2749 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002750}
2751
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002753 * When switching names, the actual string doesn't strictly have to
2754 * be preserved in the target - because we're dropping the target
2755 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002756 * the new name before we switch, unless we are going to rehash
2757 * it. Note that if we *do* unhash the target, we are not allowed
2758 * to rehash it without giving it a new name/hash key - whether
2759 * we swap or overwrite the names here, resulting name won't match
2760 * the reality in filesystem; it's only there for d_path() purposes.
2761 * Note that all of this is happening under rename_lock, so the
2762 * any hash lookup seeing it in the middle of manipulations will
2763 * be discarded anyway. So we do not care what happens to the hash
2764 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002766/*
Al Viro18367502011-07-12 21:42:24 -04002767 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 * @dentry: entry to move
2769 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002770 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 *
2772 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002773 * dcache entries should not be moved in this way. Caller must hold
2774 * rename_lock, the i_mutex of the source and target directories,
2775 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002777static void __d_move(struct dentry *dentry, struct dentry *target,
2778 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779{
Al Viro84e710d2016-04-15 00:58:55 -04002780 struct inode *dir = NULL;
2781 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 if (!dentry->d_inode)
2783 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2784
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002785 BUG_ON(d_ancestor(dentry, target));
2786 BUG_ON(d_ancestor(target, dentry));
2787
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002788 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002789 if (unlikely(d_in_lookup(target))) {
2790 dir = target->d_parent->d_inode;
2791 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002792 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002793 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794
Nick Piggin31e6b012011-01-07 17:49:52 +11002795 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002796 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002797
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002798 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2799
2800 /*
2801 * Move the dentry to the target hash queue. Don't bother checking
2802 * for the same hash queue because of how unlikely it is.
2803 */
2804 __d_drop(dentry);
Linus Torvalds8387ff22016-06-10 07:51:30 -07002805 __d_rehash(dentry, d_hash(target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
Miklos Szeredida1ce062014-04-01 17:08:43 +02002807 /*
2808 * Unhash the target (d_delete() is not usable here). If exchanging
2809 * the two dentries, then rehash onto the other's hash queue.
2810 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002812 if (exchange) {
Linus Torvalds8387ff22016-06-10 07:51:30 -07002813 __d_rehash(target, d_hash(dentry->d_name.hash));
Miklos Szeredida1ce062014-04-01 17:08:43 +02002814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002817 if (exchange)
2818 swap_names(dentry, target);
2819 else
2820 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821
Al Viro63cf4272014-09-26 23:06:14 -04002822 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002824 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002825 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826 dentry->d_parent = target->d_parent;
2827 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002828 list_del_init(&target->d_child);
2829 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002831 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002832 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002833 list_move(&target->d_child, &target->d_parent->d_subdirs);
2834 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002835 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002836 fsnotify_update_flags(target);
2837 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838 }
2839
Nick Piggin31e6b012011-01-07 17:49:52 +11002840 write_seqcount_end(&target->d_seq);
2841 write_seqcount_end(&dentry->d_seq);
2842
Al Viro84e710d2016-04-15 00:58:55 -04002843 if (dir)
2844 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002845 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002846}
2847
2848/*
2849 * d_move - move a dentry
2850 * @dentry: entry to move
2851 * @target: new dentry
2852 *
2853 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002854 * dcache entries should not be moved in this way. See the locking
2855 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002856 */
2857void d_move(struct dentry *dentry, struct dentry *target)
2858{
2859 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002860 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002862}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002863EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864
Miklos Szeredida1ce062014-04-01 17:08:43 +02002865/*
2866 * d_exchange - exchange two dentries
2867 * @dentry1: first dentry
2868 * @dentry2: second dentry
2869 */
2870void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2871{
2872 write_seqlock(&rename_lock);
2873
2874 WARN_ON(!dentry1->d_inode);
2875 WARN_ON(!dentry2->d_inode);
2876 WARN_ON(IS_ROOT(dentry1));
2877 WARN_ON(IS_ROOT(dentry2));
2878
2879 __d_move(dentry1, dentry2, true);
2880
2881 write_sequnlock(&rename_lock);
2882}
2883
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002884/**
2885 * d_ancestor - search for an ancestor
2886 * @p1: ancestor dentry
2887 * @p2: child dentry
2888 *
2889 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2890 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002891 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002892struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002893{
2894 struct dentry *p;
2895
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002896 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002897 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002898 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002899 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002900 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002901}
2902
2903/*
2904 * This helper attempts to cope with remotely renamed directories
2905 *
2906 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002907 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002908 *
2909 * Note: If ever the locking in lock_rename() changes, then please
2910 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002911 */
Al Virob5ae6b12014-10-12 22:16:02 -04002912static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002913 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914{
Al Viro9902af72016-04-15 15:08:36 -04002915 struct mutex *m1 = NULL;
2916 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002917 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002918
2919 /* If alias and dentry share a parent, then no extra locks required */
2920 if (alias->d_parent == dentry->d_parent)
2921 goto out_unalias;
2922
Trond Myklebust9eaef272006-10-21 10:24:20 -07002923 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002924 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2925 goto out_err;
2926 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002927 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002928 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002929 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002930out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002931 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002932 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002933out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002934 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002935 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002936 if (m1)
2937 mutex_unlock(m1);
2938 return ret;
2939}
2940
David Howells770bfad2006-08-22 20:06:07 -04002941/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002942 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2943 * @inode: the inode which may have a disconnected dentry
2944 * @dentry: a negative dentry which we want to point to the inode.
2945 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002946 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2947 * place of the given dentry and return it, else simply d_add the inode
2948 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002949 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002950 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2951 * we should error out: directories can't have multiple aliases.
2952 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002953 * This is needed in the lookup routine of any filesystem that is exportable
2954 * (via knfsd) so that we can build dcache paths to directories effectively.
2955 *
2956 * If a dentry was found and moved, then it is returned. Otherwise NULL
2957 * is returned. This matches the expected return value of ->lookup.
2958 *
2959 * Cluster filesystems may call this function with a negative, hashed dentry.
2960 * In that case, we know that the inode will be a regular file, and also this
2961 * will only occur during atomic_open. So we need to check for the dentry
2962 * being already hashed only in the final case.
2963 */
2964struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2965{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002966 if (IS_ERR(inode))
2967 return ERR_CAST(inode);
2968
David Howells770bfad2006-08-22 20:06:07 -04002969 BUG_ON(!d_unhashed(dentry));
2970
Al Virode689f52016-03-09 18:05:42 -05002971 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002972 goto out;
Al Virode689f52016-03-09 18:05:42 -05002973
Al Virob9680912016-04-11 00:53:26 -04002974 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002975 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002976 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002977 struct dentry *new = __d_find_any_alias(inode);
2978 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002979 /* The reference to new ensures it remains an alias */
2980 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002981 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002982 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002983 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002984 dput(new);
2985 new = ERR_PTR(-ELOOP);
2986 pr_warn_ratelimited(
2987 "VFS: Lookup of '%s' in %s %s"
2988 " would have caused loop\n",
2989 dentry->d_name.name,
2990 inode->i_sb->s_type->name,
2991 inode->i_sb->s_id);
2992 } else if (!IS_ROOT(new)) {
2993 int err = __d_unalias(inode, dentry, new);
2994 write_sequnlock(&rename_lock);
2995 if (err) {
2996 dput(new);
2997 new = ERR_PTR(err);
2998 }
Al Viro18367502011-07-12 21:42:24 -04002999 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003000 __d_move(new, dentry, false);
3001 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003002 }
Al Virob5ae6b12014-10-12 22:16:02 -04003003 iput(inode);
3004 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003005 }
David Howells770bfad2006-08-22 20:06:07 -04003006 }
Al Virob5ae6b12014-10-12 22:16:02 -04003007out:
Al Viroed782b52016-03-09 19:52:39 -05003008 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003009 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003010}
Al Virob5ae6b12014-10-12 22:16:02 -04003011EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003012
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003013static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003014{
3015 *buflen -= namelen;
3016 if (*buflen < 0)
3017 return -ENAMETOOLONG;
3018 *buffer -= namelen;
3019 memcpy(*buffer, str, namelen);
3020 return 0;
3021}
3022
Waiman Long232d2d62013-09-09 12:18:13 -04003023/**
3024 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003025 * @buffer: buffer pointer
3026 * @buflen: allocated length of the buffer
3027 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003028 *
3029 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3030 * make sure that either the old or the new name pointer and length are
3031 * fetched. However, there may be mismatch between length and pointer.
3032 * The length cannot be trusted, we need to copy it byte-by-byte until
3033 * the length is reached or a null byte is found. It also prepends "/" at
3034 * the beginning of the name. The sequence number check at the caller will
3035 * retry it again when a d_move() does happen. So any garbage in the buffer
3036 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003037 *
3038 * Data dependency barrier is needed to make sure that we see that terminating
3039 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003040 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003041static int prepend_name(char **buffer, int *buflen, struct qstr *name)
3042{
Waiman Long232d2d62013-09-09 12:18:13 -04003043 const char *dname = ACCESS_ONCE(name->name);
3044 u32 dlen = ACCESS_ONCE(name->len);
3045 char *p;
3046
Al Viro6d13f692014-09-29 14:46:30 -04003047 smp_read_barrier_depends();
3048
Waiman Long232d2d62013-09-09 12:18:13 -04003049 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003050 if (*buflen < 0)
3051 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003052 p = *buffer -= dlen + 1;
3053 *p++ = '/';
3054 while (dlen--) {
3055 char c = *dname++;
3056 if (!c)
3057 break;
3058 *p++ = c;
3059 }
3060 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003061}
3062
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003064 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003065 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003066 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003067 * @buffer: pointer to the end of the buffer
3068 * @buflen: pointer to buffer length
3069 *
Waiman Long18129972013-09-12 10:55:35 -04003070 * The function will first try to write out the pathname without taking any
3071 * lock other than the RCU read lock to make sure that dentries won't go away.
3072 * It only checks the sequence number of the global rename_lock as any change
3073 * in the dentry's d_seq will be preceded by changes in the rename_lock
3074 * sequence number. If the sequence number had been changed, it will restart
3075 * the whole pathname back-tracing sequence again by taking the rename_lock.
3076 * In this case, there is no need to take the RCU read lock as the recursive
3077 * parent pointer references will keep the dentry chain alive as long as no
3078 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003079 */
Al Viro02125a82011-12-05 08:43:34 -05003080static int prepend_path(const struct path *path,
3081 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003082 char **buffer, int *buflen)
3083{
Al Viroede4ceb2013-11-13 07:45:40 -05003084 struct dentry *dentry;
3085 struct vfsmount *vfsmnt;
3086 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003087 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003088 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003089 char *bptr;
3090 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003091
Al Viro48f5ec22013-09-09 15:22:25 -04003092 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003093restart_mnt:
3094 read_seqbegin_or_lock(&mount_lock, &m_seq);
3095 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003096 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003097restart:
3098 bptr = *buffer;
3099 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003100 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003101 dentry = path->dentry;
3102 vfsmnt = path->mnt;
3103 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003104 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003105 while (dentry != root->dentry || vfsmnt != root->mnt) {
3106 struct dentry * parent;
3107
3108 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003109 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003110 /* Escaped? */
3111 if (dentry != vfsmnt->mnt_root) {
3112 bptr = *buffer;
3113 blen = *buflen;
3114 error = 3;
3115 break;
3116 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003117 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003118 if (mnt != parent) {
3119 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3120 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003121 vfsmnt = &mnt->mnt;
3122 continue;
3123 }
Waiman Long232d2d62013-09-09 12:18:13 -04003124 if (!error)
3125 error = is_mounted(vfsmnt) ? 1 : 2;
3126 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003127 }
3128 parent = dentry->d_parent;
3129 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003130 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003131 if (error)
3132 break;
3133
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003134 dentry = parent;
3135 }
Al Viro48f5ec22013-09-09 15:22:25 -04003136 if (!(seq & 1))
3137 rcu_read_unlock();
3138 if (need_seqretry(&rename_lock, seq)) {
3139 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003140 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003141 }
Al Viro48f5ec22013-09-09 15:22:25 -04003142 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003143
3144 if (!(m_seq & 1))
3145 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003146 if (need_seqretry(&mount_lock, m_seq)) {
3147 m_seq = 1;
3148 goto restart_mnt;
3149 }
3150 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003151
Waiman Long232d2d62013-09-09 12:18:13 -04003152 if (error >= 0 && bptr == *buffer) {
3153 if (--blen < 0)
3154 error = -ENAMETOOLONG;
3155 else
3156 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003157 }
Waiman Long232d2d62013-09-09 12:18:13 -04003158 *buffer = bptr;
3159 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003160 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003161}
3162
3163/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003164 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003165 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003166 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003167 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168 * @buflen: buffer length
3169 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003170 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003172 * Returns a pointer into the buffer or an error code if the
3173 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003174 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003175 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003176 *
Al Viro02125a82011-12-05 08:43:34 -05003177 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178 */
Al Viro02125a82011-12-05 08:43:34 -05003179char *__d_path(const struct path *path,
3180 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003181 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003183 char *res = buf + buflen;
3184 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003186 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003187 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003188
Al Viro02125a82011-12-05 08:43:34 -05003189 if (error < 0)
3190 return ERR_PTR(error);
3191 if (error > 0)
3192 return NULL;
3193 return res;
3194}
3195
3196char *d_absolute_path(const struct path *path,
3197 char *buf, int buflen)
3198{
3199 struct path root = {};
3200 char *res = buf + buflen;
3201 int error;
3202
3203 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003204 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003205
3206 if (error > 1)
3207 error = -EINVAL;
3208 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003209 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003210 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211}
3212
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003213/*
3214 * same as __d_path but appends "(deleted)" for unlinked files.
3215 */
Al Viro02125a82011-12-05 08:43:34 -05003216static int path_with_deleted(const struct path *path,
3217 const struct path *root,
3218 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003219{
3220 prepend(buf, buflen, "\0", 1);
3221 if (d_unlinked(path->dentry)) {
3222 int error = prepend(buf, buflen, " (deleted)", 10);
3223 if (error)
3224 return error;
3225 }
3226
3227 return prepend_path(path, root, buf, buflen);
3228}
3229
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003230static int prepend_unreachable(char **buffer, int *buflen)
3231{
3232 return prepend(buffer, buflen, "(unreachable)", 13);
3233}
3234
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003235static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3236{
3237 unsigned seq;
3238
3239 do {
3240 seq = read_seqcount_begin(&fs->seq);
3241 *root = fs->root;
3242 } while (read_seqcount_retry(&fs->seq, seq));
3243}
3244
Jan Bluncka03a8a702008-02-14 19:38:32 -08003245/**
3246 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003247 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003248 * @buf: buffer to return value in
3249 * @buflen: buffer length
3250 *
3251 * Convert a dentry into an ASCII path name. If the entry has been deleted
3252 * the string " (deleted)" is appended. Note that this is ambiguous.
3253 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003254 * Returns a pointer into the buffer or an error code if the path was
3255 * too long. Note: Callers should use the returned pointer, not the passed
3256 * in buffer, to use the name! The implementation often starts at an offset
3257 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003258 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003259 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003260 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003261char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003263 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003264 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003265 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003267 /*
3268 * We have various synthetic filesystems that never get mounted. On
3269 * these filesystems dentries are never used for lookup purposes, and
3270 * thus don't need to be hashed. They also don't need a name until a
3271 * user wants to identify the object in /proc/pid/fd/. The little hack
3272 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003273 *
3274 * Some pseudo inodes are mountable. When they are mounted
3275 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3276 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003277 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003278 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3279 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003280 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003281
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003282 rcu_read_lock();
3283 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003284 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003285 rcu_read_unlock();
3286
Al Viro02125a82011-12-05 08:43:34 -05003287 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003288 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 return res;
3290}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003291EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292
3293/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003294 * Helper function for dentry_operations.d_dname() members
3295 */
3296char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3297 const char *fmt, ...)
3298{
3299 va_list args;
3300 char temp[64];
3301 int sz;
3302
3303 va_start(args, fmt);
3304 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3305 va_end(args);
3306
3307 if (sz > sizeof(temp) || sz > buflen)
3308 return ERR_PTR(-ENAMETOOLONG);
3309
3310 buffer += buflen - sz;
3311 return memcpy(buffer, temp, sz);
3312}
3313
Al Viro118b2302013-08-24 12:08:17 -04003314char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3315{
3316 char *end = buffer + buflen;
3317 /* these dentries are never renamed, so d_lock is not needed */
3318 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003319 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003320 prepend(&end, &buflen, "/", 1))
3321 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003322 return end;
Al Viro118b2302013-08-24 12:08:17 -04003323}
David Herrmann31bbe162014-01-03 14:09:47 +01003324EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003325
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003326/*
Ram Pai6092d042008-03-27 13:06:20 +01003327 * Write full pathname from the root of the filesystem into the buffer.
3328 */
Al Virof6500802014-01-26 12:37:55 -05003329static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003330{
Al Virof6500802014-01-26 12:37:55 -05003331 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003332 char *end, *retval;
3333 int len, seq = 0;
3334 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003335
Al Virof6500802014-01-26 12:37:55 -05003336 if (buflen < 2)
3337 goto Elong;
3338
Al Viro48f5ec22013-09-09 15:22:25 -04003339 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003340restart:
Al Virof6500802014-01-26 12:37:55 -05003341 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003342 end = buf + buflen;
3343 len = buflen;
3344 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003345 /* Get '/' right */
3346 retval = end-1;
3347 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003348 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003349 while (!IS_ROOT(dentry)) {
3350 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003351
Ram Pai6092d042008-03-27 13:06:20 +01003352 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003353 error = prepend_name(&end, &len, &dentry->d_name);
3354 if (error)
3355 break;
Ram Pai6092d042008-03-27 13:06:20 +01003356
3357 retval = end;
3358 dentry = parent;
3359 }
Al Viro48f5ec22013-09-09 15:22:25 -04003360 if (!(seq & 1))
3361 rcu_read_unlock();
3362 if (need_seqretry(&rename_lock, seq)) {
3363 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003364 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003365 }
3366 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003367 if (error)
3368 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003369 return retval;
3370Elong:
3371 return ERR_PTR(-ENAMETOOLONG);
3372}
Nick Pigginec2447c2011-01-07 17:49:29 +11003373
3374char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3375{
Waiman Long232d2d62013-09-09 12:18:13 -04003376 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003377}
3378EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003379
3380char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3381{
3382 char *p = NULL;
3383 char *retval;
3384
Al Viroc1031352010-06-06 22:31:14 -04003385 if (d_unlinked(dentry)) {
3386 p = buf + buflen;
3387 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3388 goto Elong;
3389 buflen++;
3390 }
3391 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003392 if (!IS_ERR(retval) && p)
3393 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003394 return retval;
3395Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003396 return ERR_PTR(-ENAMETOOLONG);
3397}
3398
Linus Torvalds8b19e342013-09-12 10:35:47 -07003399static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3400 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003401{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003402 unsigned seq;
3403
3404 do {
3405 seq = read_seqcount_begin(&fs->seq);
3406 *root = fs->root;
3407 *pwd = fs->pwd;
3408 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003409}
3410
Ram Pai6092d042008-03-27 13:06:20 +01003411/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003412 * NOTE! The user-level library version returns a
3413 * character pointer. The kernel system call just
3414 * returns the length of the buffer filled (which
3415 * includes the ending '\0' character), or a negative
3416 * error value. So libc would do something like
3417 *
3418 * char *getcwd(char * buf, size_t size)
3419 * {
3420 * int retval;
3421 *
3422 * retval = sys_getcwd(buf, size);
3423 * if (retval >= 0)
3424 * return buf;
3425 * errno = -retval;
3426 * return NULL;
3427 * }
3428 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003429SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003430{
Linus Torvalds552ce542007-02-13 12:08:18 -08003431 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003432 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003433 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003434
3435 if (!page)
3436 return -ENOMEM;
3437
Linus Torvalds8b19e342013-09-12 10:35:47 -07003438 rcu_read_lock();
3439 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003440
Linus Torvalds552ce542007-02-13 12:08:18 -08003441 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003442 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003443 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003444 char *cwd = page + PATH_MAX;
3445 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003446
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003447 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003448 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003449 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003450
Al Viro02125a82011-12-05 08:43:34 -05003451 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003452 goto out;
3453
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003454 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003455 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003456 error = prepend_unreachable(&cwd, &buflen);
3457 if (error)
3458 goto out;
3459 }
3460
Linus Torvalds552ce542007-02-13 12:08:18 -08003461 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003462 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003463 if (len <= size) {
3464 error = len;
3465 if (copy_to_user(buf, cwd, len))
3466 error = -EFAULT;
3467 }
Nick Piggin949854d2011-01-07 17:49:37 +11003468 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003469 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003470 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471
3472out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003473 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474 return error;
3475}
3476
3477/*
3478 * Test whether new_dentry is a subdirectory of old_dentry.
3479 *
3480 * Trivially implemented using the dcache structure
3481 */
3482
3483/**
3484 * is_subdir - is new dentry a subdirectory of old_dentry
3485 * @new_dentry: new dentry
3486 * @old_dentry: old dentry
3487 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003488 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3489 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003490 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3491 */
3492
Yaowei Baia6e57872015-11-17 14:40:11 +08003493bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494{
Yaowei Baia6e57872015-11-17 14:40:11 +08003495 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003496 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003498 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003499 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003500
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003501 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003504 /*
3505 * Need rcu_readlock to protect against the d_parent trashing
3506 * due to d_move
3507 */
3508 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003509 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003510 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003511 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003512 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003513 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515
3516 return result;
3517}
3518
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003519static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003521 struct dentry *root = data;
3522 if (dentry != root) {
3523 if (d_unhashed(dentry) || !dentry->d_inode)
3524 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003526 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3527 dentry->d_flags |= DCACHE_GENOCIDE;
3528 dentry->d_lockref.count--;
3529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003531 return D_WALK_CONTINUE;
3532}
Nick Piggin58db63d2011-01-07 17:49:39 +11003533
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003534void d_genocide(struct dentry *parent)
3535{
3536 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537}
3538
Al Viro60545d02013-06-07 01:20:27 -04003539void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540{
Al Viro60545d02013-06-07 01:20:27 -04003541 inode_dec_link_count(inode);
3542 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003543 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003544 !d_unlinked(dentry));
3545 spin_lock(&dentry->d_parent->d_lock);
3546 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3547 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3548 (unsigned long long)inode->i_ino);
3549 spin_unlock(&dentry->d_lock);
3550 spin_unlock(&dentry->d_parent->d_lock);
3551 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552}
Al Viro60545d02013-06-07 01:20:27 -04003553EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554
3555static __initdata unsigned long dhash_entries;
3556static int __init set_dhash_entries(char *str)
3557{
3558 if (!str)
3559 return 0;
3560 dhash_entries = simple_strtoul(str, &str, 0);
3561 return 1;
3562}
3563__setup("dhash_entries=", set_dhash_entries);
3564
3565static void __init dcache_init_early(void)
3566{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003567 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003568
3569 /* If hashes are distributed across NUMA nodes, defer
3570 * hash allocation until vmalloc space is available.
3571 */
3572 if (hashdist)
3573 return;
3574
3575 dentry_hashtable =
3576 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003577 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578 dhash_entries,
3579 13,
3580 HASH_EARLY,
3581 &d_hash_shift,
3582 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003583 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003584 0);
3585
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003586 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003587 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588}
3589
Denis Cheng74bf17c2007-10-16 23:26:30 -07003590static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003591{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003592 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593
3594 /*
3595 * A constructor could be added for stable state like the lists,
3596 * but it is probably not worth it because of the cache nature
3597 * of the dcache.
3598 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003599 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003600 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601
3602 /* Hash may have been set up in dcache_init_early */
3603 if (!hashdist)
3604 return;
3605
3606 dentry_hashtable =
3607 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003608 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003609 dhash_entries,
3610 13,
3611 0,
3612 &d_hash_shift,
3613 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003614 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615 0);
3616
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003617 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003618 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619}
3620
3621/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003622struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003623EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624
Linus Torvalds1da177e2005-04-16 15:20:36 -07003625EXPORT_SYMBOL(d_genocide);
3626
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627void __init vfs_caches_init_early(void)
3628{
3629 dcache_init_early();
3630 inode_init_early();
3631}
3632
Mel Gorman4248b0d2015-08-06 15:46:20 -07003633void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003634{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003635 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003636 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003637
Denis Cheng74bf17c2007-10-16 23:26:30 -07003638 dcache_init();
3639 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003640 files_init();
3641 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003642 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003643 bdev_cache_init();
3644 chrdev_init();
3645}