blob: fe7cde2f2fe52428112d8e4b09c5952584ebca50 [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 Torvalds8966be92012-03-02 14:23:30 -0800107static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700110 hash += (unsigned long) parent / L1_CACHE_BYTES;
Linus Torvalds99d263d2014-09-13 11:30:10 -0700111 return dentry_hashtable + hash_32(hash, d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100112}
113
Al Viro94bdd652016-04-15 02:42:04 -0400114#define IN_LOOKUP_SHIFT 10
115static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
116
117static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
118 unsigned int hash)
119{
120 hash += (unsigned long) parent / L1_CACHE_BYTES;
121 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
122}
123
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125/* Statistics gathering. */
126struct dentry_stat_t dentry_stat = {
127 .age_limit = 45,
128};
129
Glauber Costa3942c072013-08-28 10:17:53 +1000130static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000131static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400132
133#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000134
135/*
136 * Here we resort to our own counters instead of using generic per-cpu counters
137 * for consistency with what the vfs inode code does. We are expected to harvest
138 * better code and performance by having our own specialized counters.
139 *
140 * Please note that the loop is done over all possible CPUs, not over all online
141 * CPUs. The reason for this is that we don't want to play games with CPUs going
142 * on and off. If one of them goes off, we will just keep their counters.
143 *
144 * glommer: See cffbc8a for details, and if you ever intend to change this,
145 * please update all vfs counters to match.
146 */
Glauber Costa3942c072013-08-28 10:17:53 +1000147static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100148{
149 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000150 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100151 for_each_possible_cpu(i)
152 sum += per_cpu(nr_dentry, i);
153 return sum < 0 ? 0 : sum;
154}
155
Dave Chinner62d36c72013-08-28 10:17:54 +1000156static long get_nr_dentry_unused(void)
157{
158 int i;
159 long sum = 0;
160 for_each_possible_cpu(i)
161 sum += per_cpu(nr_dentry_unused, i);
162 return sum < 0 ? 0 : sum;
163}
164
Joe Perches1f7e0612014-06-06 14:38:05 -0700165int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400166 size_t *lenp, loff_t *ppos)
167{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100168 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000169 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000170 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400171}
172#endif
173
Linus Torvalds5483f182012-03-04 15:51:42 -0800174/*
175 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
176 * The strings are both count bytes long, and count is non-zero.
177 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700178#ifdef CONFIG_DCACHE_WORD_ACCESS
179
180#include <asm/word-at-a-time.h>
181/*
182 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
183 * aligned allocation for this particular component. We don't
184 * strictly need the load_unaligned_zeropad() safety, but it
185 * doesn't hurt either.
186 *
187 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
188 * need the careful unaligned handling.
189 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700190static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800191{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800192 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800193
194 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700195 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700196 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800197 if (tcount < sizeof(unsigned long))
198 break;
199 if (unlikely(a != b))
200 return 1;
201 cs += sizeof(unsigned long);
202 ct += sizeof(unsigned long);
203 tcount -= sizeof(unsigned long);
204 if (!tcount)
205 return 0;
206 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000207 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800208 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700209}
210
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800211#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212
Linus Torvalds94753db52012-05-10 12:19:19 -0700213static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700214{
Linus Torvalds5483f182012-03-04 15:51:42 -0800215 do {
216 if (*cs != *ct)
217 return 1;
218 cs++;
219 ct++;
220 tcount--;
221 } while (tcount);
222 return 0;
223}
224
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700225#endif
226
Linus Torvalds94753db52012-05-10 12:19:19 -0700227static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
228{
Linus Torvalds6326c712012-05-21 16:14:04 -0700229 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700230 /*
231 * Be careful about RCU walk racing with rename:
232 * use ACCESS_ONCE to fetch the name pointer.
233 *
234 * NOTE! Even if a rename will mean that the length
235 * was not loaded atomically, we don't care. The
236 * RCU walk will check the sequence count eventually,
237 * and catch it. And we won't overrun the buffer,
238 * because we're reading the name pointer atomically,
239 * and a dentry name is guaranteed to be properly
240 * terminated with a NUL byte.
241 *
242 * End result: even if 'len' is wrong, we'll exit
243 * early because the data cannot match (there can
244 * be no NUL in the ct/tcount data)
245 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700246 cs = ACCESS_ONCE(dentry->d_name.name);
247 smp_read_barrier_depends();
248 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700249}
250
Al Viro8d85b482014-09-29 14:54:27 -0400251struct external_name {
252 union {
253 atomic_t count;
254 struct rcu_head head;
255 } u;
256 unsigned char name[];
257};
258
259static inline struct external_name *external_name(struct dentry *dentry)
260{
261 return container_of(dentry->d_name.name, struct external_name, name[0]);
262}
263
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400266 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
267
Al Viro8d85b482014-09-29 14:54:27 -0400268 kmem_cache_free(dentry_cache, dentry);
269}
270
271static void __d_free_external(struct rcu_head *head)
272{
273 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400274 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 kmem_cache_free(dentry_cache, dentry);
276}
277
Al Viro810bb172014-10-12 12:45:37 -0400278static inline int dname_external(const struct dentry *dentry)
279{
280 return dentry->d_name.name != dentry->d_iname;
281}
282
David Howells4bf46a22015-03-05 14:09:22 +0000283static inline void __d_set_inode_and_type(struct dentry *dentry,
284 struct inode *inode,
285 unsigned type_flags)
286{
287 unsigned flags;
288
289 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000290 flags = READ_ONCE(dentry->d_flags);
291 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
292 flags |= type_flags;
293 WRITE_ONCE(dentry->d_flags, flags);
294}
295
David Howells4bf46a22015-03-05 14:09:22 +0000296static inline void __d_clear_type_and_inode(struct dentry *dentry)
297{
298 unsigned flags = READ_ONCE(dentry->d_flags);
299
300 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
301 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000302 dentry->d_inode = NULL;
303}
304
Al Virob4f03542014-04-29 23:40:14 -0400305static void dentry_free(struct dentry *dentry)
306{
Al Viro946e51f2014-10-26 19:19:16 -0400307 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400308 if (unlikely(dname_external(dentry))) {
309 struct external_name *p = external_name(dentry);
310 if (likely(atomic_dec_and_test(&p->u.count))) {
311 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
312 return;
313 }
314 }
Al Virob4f03542014-04-29 23:40:14 -0400315 /* if dentry was never visible to RCU, immediate free is OK */
316 if (!(dentry->d_flags & DCACHE_RCUACCESS))
317 __d_free(&dentry->d_u.d_rcu);
318 else
319 call_rcu(&dentry->d_u.d_rcu, __d_free);
320}
321
Nick Piggin31e6b012011-01-07 17:49:52 +1100322/**
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200323 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800324 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100325 * After this call, in-progress rcu-walk path lookup will fail. This
326 * should be called after unhashing, and after changing d_inode (if
327 * the dentry has not already been unhashed).
328 */
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200329static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
Nick Piggin31e6b012011-01-07 17:49:52 +1100330{
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200331 lockdep_assert_held(&dentry->d_lock);
332 /* Go through am invalidation barrier */
333 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100334}
335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336/*
337 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400338 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100339 */
340static void dentry_unlink_inode(struct dentry * dentry)
341 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100342 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100343{
344 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400345 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500346
Al Viro550dce02016-05-29 20:13:30 -0400347 if (hashed)
348 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000349 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400350 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400351 if (hashed)
352 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100353 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100354 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100355 if (!inode->i_nlink)
356 fsnotify_inoderemove(inode);
357 if (dentry->d_op && dentry->d_op->d_iput)
358 dentry->d_op->d_iput(dentry, inode);
359 else
360 iput(inode);
361}
362
363/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400364 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
365 * is in use - which includes both the "real" per-superblock
366 * LRU list _and_ the DCACHE_SHRINK_LIST use.
367 *
368 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
369 * on the shrink list (ie not on the superblock LRU list).
370 *
371 * The per-cpu "nr_dentry_unused" counters are updated with
372 * the DCACHE_LRU_LIST bit.
373 *
374 * These helper functions make sure we always follow the
375 * rules. d_lock must be held by the caller.
376 */
377#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
378static void d_lru_add(struct dentry *dentry)
379{
380 D_FLAG_VERIFY(dentry, 0);
381 dentry->d_flags |= DCACHE_LRU_LIST;
382 this_cpu_inc(nr_dentry_unused);
383 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
384}
385
386static void d_lru_del(struct dentry *dentry)
387{
388 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
389 dentry->d_flags &= ~DCACHE_LRU_LIST;
390 this_cpu_dec(nr_dentry_unused);
391 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
392}
393
394static void d_shrink_del(struct dentry *dentry)
395{
396 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
397 list_del_init(&dentry->d_lru);
398 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
399 this_cpu_dec(nr_dentry_unused);
400}
401
402static void d_shrink_add(struct dentry *dentry, struct list_head *list)
403{
404 D_FLAG_VERIFY(dentry, 0);
405 list_add(&dentry->d_lru, list);
406 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
407 this_cpu_inc(nr_dentry_unused);
408}
409
410/*
411 * These can only be called under the global LRU lock, ie during the
412 * callback for freeing the LRU list. "isolate" removes it from the
413 * LRU lists entirely, while shrink_move moves it to the indicated
414 * private list.
415 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800416static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400417{
418 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
419 dentry->d_flags &= ~DCACHE_LRU_LIST;
420 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800421 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400422}
423
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800424static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
425 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400426{
427 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
428 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800429 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400430}
431
432/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000433 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700434 */
435static void dentry_lru_add(struct dentry *dentry)
436{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400437 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
438 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700439}
440
Miklos Szeredid52b9082007-05-08 00:23:46 -0700441/**
Nick Piggin789680d2011-01-07 17:49:30 +1100442 * d_drop - drop a dentry
443 * @dentry: dentry to drop
444 *
445 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
446 * be found through a VFS lookup any more. Note that this is different from
447 * deleting the dentry - d_delete will try to mark the dentry negative if
448 * possible, giving a successful _negative_ lookup, while d_drop will
449 * just make the cache lookup fail.
450 *
451 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
452 * reason (NFS timeouts or autofs deletes).
453 *
454 * __d_drop requires dentry->d_lock.
455 */
456void __d_drop(struct dentry *dentry)
457{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700458 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400459 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400460 /*
461 * Hashed dentries are normally on the dentry hashtable,
462 * with the exception of those newly allocated by
463 * d_obtain_alias, which are always IS_ROOT:
464 */
465 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400466 b = &dentry->d_sb->s_anon;
467 else
468 b = d_hash(dentry->d_parent, dentry->d_name.hash);
469
470 hlist_bl_lock(b);
471 __hlist_bl_del(&dentry->d_hash);
472 dentry->d_hash.pprev = NULL;
473 hlist_bl_unlock(b);
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200474 dentry_rcuwalk_invalidate(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100475 }
476}
477EXPORT_SYMBOL(__d_drop);
478
479void d_drop(struct dentry *dentry)
480{
Nick Piggin789680d2011-01-07 17:49:30 +1100481 spin_lock(&dentry->d_lock);
482 __d_drop(dentry);
483 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100484}
485EXPORT_SYMBOL(d_drop);
486
Al Viroe55fd012014-05-28 13:51:12 -0400487static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100488{
Al Viro41edf272014-05-01 10:30:00 -0400489 struct dentry *parent = NULL;
490 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400491 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100492 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100493
Linus Torvalds0d984392013-09-08 13:46:52 -0700494 /*
495 * The dentry is now unrecoverably dead to the world.
496 */
497 lockref_mark_dead(&dentry->d_lockref);
498
Sage Weilf0023bc2011-10-28 10:02:42 -0700499 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700500 * inform the fs via d_prune that this dentry is about to be
501 * unhashed and destroyed.
502 */
Al Viro29266202014-05-30 11:39:02 -0400503 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800504 dentry->d_op->d_prune(dentry);
505
Al Viro01b60352014-04-29 23:42:52 -0400506 if (dentry->d_flags & DCACHE_LRU_LIST) {
507 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
508 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400509 }
Nick Piggin77812a12011-01-07 17:49:48 +1100510 /* if it was on the hash then remove it */
511 __d_drop(dentry);
Al Viroca5358e2014-10-26 19:31:10 -0400512 __list_del_entry(&dentry->d_child);
Al Viro03b3b882014-04-29 15:45:28 -0400513 /*
514 * Inform d_walk() that we are no longer attached to the
515 * dentry tree
516 */
517 dentry->d_flags |= DCACHE_DENTRY_KILLED;
518 if (parent)
519 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400520 if (dentry->d_inode)
521 dentry_unlink_inode(dentry);
522 else
523 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400524 this_cpu_dec(nr_dentry);
525 if (dentry->d_op && dentry->d_op->d_release)
526 dentry->d_op->d_release(dentry);
527
Al Viro41edf272014-05-01 10:30:00 -0400528 spin_lock(&dentry->d_lock);
529 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
530 dentry->d_flags |= DCACHE_MAY_FREE;
531 can_free = false;
532 }
533 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400534 if (likely(can_free))
535 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400536}
537
538/*
539 * Finish off a dentry we've decided to kill.
540 * dentry->d_lock must be held, returns with it unlocked.
541 * If ref is non-zero, then decrement the refcount too.
542 * Returns dentry requiring refcount drop, or NULL if we're done.
543 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400544static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400545 __releases(dentry->d_lock)
546{
547 struct inode *inode = dentry->d_inode;
548 struct dentry *parent = NULL;
549
550 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
551 goto failed;
552
553 if (!IS_ROOT(dentry)) {
554 parent = dentry->d_parent;
555 if (unlikely(!spin_trylock(&parent->d_lock))) {
556 if (inode)
557 spin_unlock(&inode->i_lock);
558 goto failed;
559 }
560 }
561
562 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400563 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400564
565failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400566 spin_unlock(&dentry->d_lock);
567 cpu_relax();
Al Viroe55fd012014-05-28 13:51:12 -0400568 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100569}
570
Al Viro046b9612014-05-29 08:54:52 -0400571static inline struct dentry *lock_parent(struct dentry *dentry)
572{
573 struct dentry *parent = dentry->d_parent;
574 if (IS_ROOT(dentry))
575 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800576 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400577 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400578 if (likely(spin_trylock(&parent->d_lock)))
579 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400580 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400581 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400582again:
583 parent = ACCESS_ONCE(dentry->d_parent);
584 spin_lock(&parent->d_lock);
585 /*
586 * We can't blindly lock dentry until we are sure
587 * that we won't violate the locking order.
588 * Any changes of dentry->d_parent must have
589 * been done with parent->d_lock held, so
590 * spin_lock() above is enough of a barrier
591 * for checking if it's still our child.
592 */
593 if (unlikely(parent != dentry->d_parent)) {
594 spin_unlock(&parent->d_lock);
595 goto again;
596 }
597 rcu_read_unlock();
598 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700599 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400600 else
601 parent = NULL;
602 return parent;
603}
604
Linus Torvalds360f5472015-01-09 15:19:03 -0800605/*
606 * Try to do a lockless dput(), and return whether that was successful.
607 *
608 * If unsuccessful, we return false, having already taken the dentry lock.
609 *
610 * The caller needs to hold the RCU read lock, so that the dentry is
611 * guaranteed to stay around even if the refcount goes down to zero!
612 */
613static inline bool fast_dput(struct dentry *dentry)
614{
615 int ret;
616 unsigned int d_flags;
617
618 /*
619 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100620 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800621 */
622 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
623 return lockref_put_or_lock(&dentry->d_lockref);
624
625 /*
626 * .. otherwise, we can try to just decrement the
627 * lockref optimistically.
628 */
629 ret = lockref_put_return(&dentry->d_lockref);
630
631 /*
632 * If the lockref_put_return() failed due to the lock being held
633 * by somebody else, the fast path has failed. We will need to
634 * get the lock, and then check the count again.
635 */
636 if (unlikely(ret < 0)) {
637 spin_lock(&dentry->d_lock);
638 if (dentry->d_lockref.count > 1) {
639 dentry->d_lockref.count--;
640 spin_unlock(&dentry->d_lock);
641 return 1;
642 }
643 return 0;
644 }
645
646 /*
647 * If we weren't the last ref, we're done.
648 */
649 if (ret)
650 return 1;
651
652 /*
653 * Careful, careful. The reference count went down
654 * to zero, but we don't hold the dentry lock, so
655 * somebody else could get it again, and do another
656 * dput(), and we need to not race with that.
657 *
658 * However, there is a very special and common case
659 * where we don't care, because there is nothing to
660 * do: the dentry is still hashed, it does not have
661 * a 'delete' op, and it's referenced and already on
662 * the LRU list.
663 *
664 * NOTE! Since we aren't locked, these values are
665 * not "stable". However, it is sufficient that at
666 * some point after we dropped the reference the
667 * dentry was hashed and the flags had the proper
668 * value. Other dentry users may have re-gotten
669 * a reference to the dentry and change that, but
670 * our work is done - we can leave the dentry
671 * around with a zero refcount.
672 */
673 smp_rmb();
674 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100675 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800676
677 /* Nothing to do? Dropping the reference was all we needed? */
678 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
679 return 1;
680
681 /*
682 * Not the fast normal case? Get the lock. We've already decremented
683 * the refcount, but we'll need to re-check the situation after
684 * getting the lock.
685 */
686 spin_lock(&dentry->d_lock);
687
688 /*
689 * Did somebody else grab a reference to it in the meantime, and
690 * we're no longer the last user after all? Alternatively, somebody
691 * else could have killed it and marked it dead. Either way, we
692 * don't need to do anything else.
693 */
694 if (dentry->d_lockref.count) {
695 spin_unlock(&dentry->d_lock);
696 return 1;
697 }
698
699 /*
700 * Re-get the reference we optimistically dropped. We hold the
701 * lock, and we just tested that it was zero, so we can just
702 * set it to 1.
703 */
704 dentry->d_lockref.count = 1;
705 return 0;
706}
707
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/*
710 * This is dput
711 *
712 * This is complicated by the fact that we do not want to put
713 * dentries that are no longer on any hash chain on the unused
714 * list: we'd much rather just get rid of them immediately.
715 *
716 * However, that implies that we have to traverse the dentry
717 * tree upwards to the parents which might _also_ now be
718 * scheduled for deletion (it may have been only waiting for
719 * its last child to go away).
720 *
721 * This tail recursion is done by hand as we don't want to depend
722 * on the compiler to always get this right (gcc generally doesn't).
723 * Real recursion would eat up our stack space.
724 */
725
726/*
727 * dput - release a dentry
728 * @dentry: dentry to release
729 *
730 * Release a dentry. This will drop the usage count and if appropriate
731 * call the dentry unlink method as well as removing it from the queues and
732 * releasing its resources. If the parent dentries were scheduled for release
733 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735void dput(struct dentry *dentry)
736{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700737 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return;
739
740repeat:
Linus Torvalds360f5472015-01-09 15:19:03 -0800741 rcu_read_lock();
742 if (likely(fast_dput(dentry))) {
743 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800745 }
746
747 /* Slow case: now with the dentry lock held */
748 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Al Viro85c7f812016-04-14 19:52:13 -0400750 WARN_ON(d_in_lookup(dentry));
751
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700752 /* Unreachable? Get rid of it */
753 if (unlikely(d_unhashed(dentry)))
754 goto kill_it;
755
Al Viro75a6f822015-07-08 02:42:38 +0100756 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
757 goto kill_it;
758
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700759 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100761 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
Nick Piggin265ac902010-10-10 05:36:24 -0400763
Linus Torvalds358eec12013-10-31 15:43:02 -0700764 if (!(dentry->d_flags & DCACHE_REFERENCED))
765 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400766 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400767
Waiman Long98474232013-08-28 18:24:59 -0700768 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100769 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return;
771
Miklos Szeredid52b9082007-05-08 00:23:46 -0700772kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400773 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700774 if (dentry)
775 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700777EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100780/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100781static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782{
Waiman Long98474232013-08-28 18:24:59 -0700783 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784}
785
Nick Piggindc0474b2011-01-07 17:49:43 +1100786static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100787{
Waiman Long98474232013-08-28 18:24:59 -0700788 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100789}
790
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100791struct dentry *dget_parent(struct dentry *dentry)
792{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700793 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100794 struct dentry *ret;
795
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700796 /*
797 * Do optimistic parent lookup without any
798 * locking.
799 */
800 rcu_read_lock();
801 ret = ACCESS_ONCE(dentry->d_parent);
802 gotref = lockref_get_not_zero(&ret->d_lockref);
803 rcu_read_unlock();
804 if (likely(gotref)) {
805 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
806 return ret;
807 dput(ret);
808 }
809
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100810repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100811 /*
812 * Don't need rcu_dereference because we re-check it was correct under
813 * the lock.
814 */
815 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100816 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100817 spin_lock(&ret->d_lock);
818 if (unlikely(ret != dentry->d_parent)) {
819 spin_unlock(&ret->d_lock);
820 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100821 goto repeat;
822 }
Nick Piggina734eb42011-01-07 17:49:44 +1100823 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700824 BUG_ON(!ret->d_lockref.count);
825 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100826 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100827 return ret;
828}
829EXPORT_SYMBOL(dget_parent);
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831/**
832 * d_find_alias - grab a hashed alias of inode
833 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 *
835 * If inode has a hashed alias, or is a directory and has any alias,
836 * acquire the reference to alias and return it. Otherwise return NULL.
837 * Notice that if inode is a directory there can be only one alias and
838 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800839 * of a filesystem, or if the directory was renamed and d_revalidate
840 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700842 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500843 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500845static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846{
Nick Pigginda502952011-01-07 17:49:33 +1100847 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Nick Pigginda502952011-01-07 17:49:33 +1100849again:
850 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400851 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100852 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700854 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100855 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500857 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100858 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100859 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 return alias;
861 }
862 }
Nick Pigginda502952011-01-07 17:49:33 +1100863 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 }
Nick Pigginda502952011-01-07 17:49:33 +1100865 if (discon_alias) {
866 alias = discon_alias;
867 spin_lock(&alias->d_lock);
868 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500869 __dget_dlock(alias);
870 spin_unlock(&alias->d_lock);
871 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100872 }
873 spin_unlock(&alias->d_lock);
874 goto again;
875 }
876 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877}
878
Nick Pigginda502952011-01-07 17:49:33 +1100879struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
David Howells214fda12006-03-25 03:06:36 -0800881 struct dentry *de = NULL;
882
Al Virob3d9b7a2012-06-09 13:51:19 -0400883 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100884 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500885 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100886 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800887 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 return de;
889}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700890EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892/*
893 * Try to kill dentries associated with this inode.
894 * WARNING: you must own a reference to inode.
895 */
896void d_prune_aliases(struct inode *inode)
897{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700898 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100900 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400901 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700903 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400904 struct dentry *parent = lock_parent(dentry);
905 if (likely(!dentry->d_lockref.count)) {
906 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800907 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400908 goto restart;
909 }
910 if (parent)
911 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 }
913 spin_unlock(&dentry->d_lock);
914 }
Nick Piggin873feea2011-01-07 17:50:06 +1100915 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700917EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400919static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
Al Viro5c47e6d2014-04-29 16:13:18 -0400921 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700922
Miklos Szeredi60942f22014-05-02 15:38:39 -0400923 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400924 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400925 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100926 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400927 parent = lock_parent(dentry);
928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000930 * The dispose list is isolated and dentries are not accounted
931 * to the LRU here, so we can simply remove it from the list
932 * here regardless of whether it is referenced or not.
933 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400934 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000935
936 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000938 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800940 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700941 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400942 if (parent)
943 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 continue;
945 }
Nick Piggin77812a12011-01-07 17:49:48 +1100946
Al Viro64fd72e2014-05-28 09:48:44 -0400947
948 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
949 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
950 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400951 if (parent)
952 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400953 if (can_free)
954 dentry_free(dentry);
955 continue;
956 }
957
Al Viroff2fde92014-05-28 13:59:13 -0400958 inode = dentry->d_inode;
959 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400960 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000961 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400962 if (parent)
963 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400964 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000965 }
Al Viroff2fde92014-05-28 13:59:13 -0400966
Al Viroff2fde92014-05-28 13:59:13 -0400967 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400968
Al Viro5c47e6d2014-04-29 16:13:18 -0400969 /*
970 * We need to prune ancestors too. This is necessary to prevent
971 * quadratic behavior of shrink_dcache_parent(), but is also
972 * expected to be beneficial in reducing dentry cache
973 * fragmentation.
974 */
975 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400976 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
977 parent = lock_parent(dentry);
978 if (dentry->d_lockref.count != 1) {
979 dentry->d_lockref.count--;
980 spin_unlock(&dentry->d_lock);
981 if (parent)
982 spin_unlock(&parent->d_lock);
983 break;
984 }
985 inode = dentry->d_inode; /* can't be NULL */
986 if (unlikely(!spin_trylock(&inode->i_lock))) {
987 spin_unlock(&dentry->d_lock);
988 if (parent)
989 spin_unlock(&parent->d_lock);
990 cpu_relax();
991 continue;
992 }
993 __dentry_kill(dentry);
994 dentry = parent;
995 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400997}
998
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800999static enum lru_status dentry_lru_isolate(struct list_head *item,
1000 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001001{
1002 struct list_head *freeable = arg;
1003 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1004
1005
1006 /*
1007 * we are inverting the lru lock/dentry->d_lock here,
1008 * so use a trylock. If we fail to get the lock, just skip
1009 * it
1010 */
1011 if (!spin_trylock(&dentry->d_lock))
1012 return LRU_SKIP;
1013
1014 /*
1015 * Referenced dentries are still in use. If they have active
1016 * counts, just remove them from the LRU. Otherwise give them
1017 * another pass through the LRU.
1018 */
1019 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001020 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001021 spin_unlock(&dentry->d_lock);
1022 return LRU_REMOVED;
1023 }
1024
1025 if (dentry->d_flags & DCACHE_REFERENCED) {
1026 dentry->d_flags &= ~DCACHE_REFERENCED;
1027 spin_unlock(&dentry->d_lock);
1028
1029 /*
1030 * The list move itself will be made by the common LRU code. At
1031 * this point, we've dropped the dentry->d_lock but keep the
1032 * lru lock. This is safe to do, since every list movement is
1033 * protected by the lru lock even if both locks are held.
1034 *
1035 * This is guaranteed by the fact that all LRU management
1036 * functions are intermediated by the LRU API calls like
1037 * list_lru_add and list_lru_del. List movement in this file
1038 * only ever occur through this functions or through callbacks
1039 * like this one, that are called from the LRU API.
1040 *
1041 * The only exceptions to this are functions like
1042 * shrink_dentry_list, and code that first checks for the
1043 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1044 * operating only with stack provided lists after they are
1045 * properly isolated from the main list. It is thus, always a
1046 * local access.
1047 */
1048 return LRU_ROTATE;
1049 }
1050
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001051 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001052 spin_unlock(&dentry->d_lock);
1053
1054 return LRU_REMOVED;
1055}
1056
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001057/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001058 * prune_dcache_sb - shrink the dcache
1059 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001060 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001061 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001062 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1063 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001064 * function.
1065 *
1066 * This function may fail to free any resources if all the dentries are in
1067 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001068 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001069long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001070{
Dave Chinnerf6041562013-08-28 10:18:00 +10001071 LIST_HEAD(dispose);
1072 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001073
Vladimir Davydov503c3582015-02-12 14:58:47 -08001074 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1075 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001076 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001077 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078}
1079
Glauber Costa4e717f52013-08-28 10:18:03 +10001080static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001081 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001082{
Glauber Costa4e717f52013-08-28 10:18:03 +10001083 struct list_head *freeable = arg;
1084 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001085
Glauber Costa4e717f52013-08-28 10:18:03 +10001086 /*
1087 * we are inverting the lru lock/dentry->d_lock here,
1088 * so use a trylock. If we fail to get the lock, just skip
1089 * it
1090 */
1091 if (!spin_trylock(&dentry->d_lock))
1092 return LRU_SKIP;
1093
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001094 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001095 spin_unlock(&dentry->d_lock);
1096
1097 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001098}
1099
Glauber Costa4e717f52013-08-28 10:18:03 +10001100
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001101/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 * shrink_dcache_sb - shrink dcache for a superblock
1103 * @sb: superblock
1104 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001105 * Shrink the dcache for the specified super block. This is used to free
1106 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001108void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109{
Glauber Costa4e717f52013-08-28 10:18:03 +10001110 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001111
Glauber Costa4e717f52013-08-28 10:18:03 +10001112 do {
1113 LIST_HEAD(dispose);
1114
1115 freed = list_lru_walk(&sb->s_dentry_lru,
1116 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1117
1118 this_cpu_sub(nr_dentry_unused, freed);
1119 shrink_dentry_list(&dispose);
1120 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001122EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001125 * enum d_walk_ret - action to talke during tree walk
1126 * @D_WALK_CONTINUE: contrinue walk
1127 * @D_WALK_QUIT: quit walk
1128 * @D_WALK_NORETRY: quit when retry is needed
1129 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001131enum d_walk_ret {
1132 D_WALK_CONTINUE,
1133 D_WALK_QUIT,
1134 D_WALK_NORETRY,
1135 D_WALK_SKIP,
1136};
1137
1138/**
1139 * d_walk - walk the dentry tree
1140 * @parent: start of walk
1141 * @data: data passed to @enter() and @finish()
1142 * @enter: callback when first entering the dentry
1143 * @finish: callback when successfully finished the walk
1144 *
1145 * The @enter() and @finish() callbacks are called with d_lock held.
1146 */
1147static void d_walk(struct dentry *parent, void *data,
1148 enum d_walk_ret (*enter)(void *, struct dentry *),
1149 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150{
Nick Piggin949854d2011-01-07 17:49:37 +11001151 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001153 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001154 enum d_walk_ret ret;
1155 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001156
Nick Piggin58db63d2011-01-07 17:49:39 +11001157again:
Al Viro48f5ec22013-09-09 15:22:25 -04001158 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001159 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001160 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001161
1162 ret = enter(data, this_parent);
1163 switch (ret) {
1164 case D_WALK_CONTINUE:
1165 break;
1166 case D_WALK_QUIT:
1167 case D_WALK_SKIP:
1168 goto out_unlock;
1169 case D_WALK_NORETRY:
1170 retry = false;
1171 break;
1172 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173repeat:
1174 next = this_parent->d_subdirs.next;
1175resume:
1176 while (next != &this_parent->d_subdirs) {
1177 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001178 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001180
1181 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182
1183 ret = enter(data, dentry);
1184 switch (ret) {
1185 case D_WALK_CONTINUE:
1186 break;
1187 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001188 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001189 goto out_unlock;
1190 case D_WALK_NORETRY:
1191 retry = false;
1192 break;
1193 case D_WALK_SKIP:
1194 spin_unlock(&dentry->d_lock);
1195 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001196 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001199 spin_unlock(&this_parent->d_lock);
1200 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001202 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 goto repeat;
1204 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001205 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 }
1207 /*
1208 * All done at this level ... ascend and resume the search.
1209 */
Al Viroca5358e2014-10-26 19:31:10 -04001210 rcu_read_lock();
1211ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001213 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001214 this_parent = child->d_parent;
1215
Al Viro31dec132013-10-25 17:04:27 -04001216 spin_unlock(&child->d_lock);
1217 spin_lock(&this_parent->d_lock);
1218
Al Viroca5358e2014-10-26 19:31:10 -04001219 /* might go back up the wrong parent if we have had a rename. */
1220 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001221 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001222 /* go into the first sibling still alive */
1223 do {
1224 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001225 if (next == &this_parent->d_subdirs)
1226 goto ascend;
1227 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001228 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001229 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 goto resume;
1231 }
Al Viroca5358e2014-10-26 19:31:10 -04001232 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001233 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001234 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001235 if (finish)
1236 finish(data);
1237
1238out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001239 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001240 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001241 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001242
1243rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001244 spin_unlock(&this_parent->d_lock);
1245 rcu_read_unlock();
1246 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001247 if (!retry)
1248 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001249 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001250 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001252
1253/*
1254 * Search for at least 1 mount point in the dentry's subdirs.
1255 * We descend to the next level whenever the d_subdirs
1256 * list is non-empty and continue searching.
1257 */
1258
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001259static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1260{
1261 int *ret = data;
1262 if (d_mountpoint(dentry)) {
1263 *ret = 1;
1264 return D_WALK_QUIT;
1265 }
1266 return D_WALK_CONTINUE;
1267}
1268
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001269/**
1270 * have_submounts - check for mounts over a dentry
1271 * @parent: dentry to check.
1272 *
1273 * Return true if the parent or its subdirectories contain
1274 * a mount point
1275 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001276int have_submounts(struct dentry *parent)
1277{
1278 int ret = 0;
1279
1280 d_walk(parent, &ret, check_mount, NULL);
1281
1282 return ret;
1283}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001284EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285
1286/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001287 * Called by mount code to set a mountpoint and check if the mountpoint is
1288 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1289 * subtree can become unreachable).
1290 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001291 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001292 * this reason take rename_lock and d_lock on dentry and ancestors.
1293 */
1294int d_set_mounted(struct dentry *dentry)
1295{
1296 struct dentry *p;
1297 int ret = -ENOENT;
1298 write_seqlock(&rename_lock);
1299 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001300 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001301 spin_lock(&p->d_lock);
1302 if (unlikely(d_unhashed(p))) {
1303 spin_unlock(&p->d_lock);
1304 goto out;
1305 }
1306 spin_unlock(&p->d_lock);
1307 }
1308 spin_lock(&dentry->d_lock);
1309 if (!d_unlinked(dentry)) {
1310 dentry->d_flags |= DCACHE_MOUNTED;
1311 ret = 0;
1312 }
1313 spin_unlock(&dentry->d_lock);
1314out:
1315 write_sequnlock(&rename_lock);
1316 return ret;
1317}
1318
1319/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001320 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 * and move any unused dentries to the end of the unused
1322 * list for prune_dcache(). We descend to the next level
1323 * whenever the d_subdirs list is non-empty and continue
1324 * searching.
1325 *
1326 * It returns zero iff there are no unused children,
1327 * otherwise it returns the number of children moved to
1328 * the end of the unused list. This may not be the total
1329 * number of unused children, because select_parent can
1330 * drop the lock and return early due to latency
1331 * constraints.
1332 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001333
1334struct select_data {
1335 struct dentry *start;
1336 struct list_head dispose;
1337 int found;
1338};
1339
1340static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001342 struct select_data *data = _data;
1343 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001345 if (data->start == dentry)
1346 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
Al Virofe915222014-05-03 00:02:25 -04001348 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001349 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001350 } else {
1351 if (dentry->d_flags & DCACHE_LRU_LIST)
1352 d_lru_del(dentry);
1353 if (!dentry->d_lockref.count) {
1354 d_shrink_add(dentry, &data->dispose);
1355 data->found++;
1356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
1358 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001359 * We can return to the caller if we have found some (this
1360 * ensures forward progress). We'll be coming back to find
1361 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 */
Al Virofe915222014-05-03 00:02:25 -04001363 if (!list_empty(&data->dispose))
1364 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001366 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367}
1368
1369/**
1370 * shrink_dcache_parent - prune dcache
1371 * @parent: parent of entries to prune
1372 *
1373 * Prune the dcache to remove unused children of the parent dentry.
1374 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001375void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001377 for (;;) {
1378 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001380 INIT_LIST_HEAD(&data.dispose);
1381 data.start = parent;
1382 data.found = 0;
1383
1384 d_walk(parent, &data, select_collect, NULL);
1385 if (!data.found)
1386 break;
1387
1388 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001389 cond_resched();
1390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001392EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Al Viro9c8c10e2014-05-02 20:36:10 -04001394static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001395{
Al Viro9c8c10e2014-05-02 20:36:10 -04001396 /* it has busy descendents; complain about those instead */
1397 if (!list_empty(&dentry->d_subdirs))
1398 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001399
Al Viro9c8c10e2014-05-02 20:36:10 -04001400 /* root with refcount 1 is fine */
1401 if (dentry == _data && dentry->d_lockref.count == 1)
1402 return D_WALK_CONTINUE;
1403
1404 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1405 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001406 dentry,
1407 dentry->d_inode ?
1408 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001409 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001410 dentry->d_lockref.count,
1411 dentry->d_sb->s_type->name,
1412 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001413 WARN_ON(1);
1414 return D_WALK_CONTINUE;
1415}
1416
1417static void do_one_tree(struct dentry *dentry)
1418{
1419 shrink_dcache_parent(dentry);
1420 d_walk(dentry, dentry, umount_check, NULL);
1421 d_drop(dentry);
1422 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001423}
1424
1425/*
1426 * destroy the dentries attached to a superblock on unmounting
1427 */
1428void shrink_dcache_for_umount(struct super_block *sb)
1429{
1430 struct dentry *dentry;
1431
Al Viro9c8c10e2014-05-02 20:36:10 -04001432 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001433
1434 dentry = sb->s_root;
1435 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001436 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001437
1438 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001439 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1440 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001441 }
1442}
1443
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001444struct detach_data {
1445 struct select_data select;
1446 struct dentry *mountpoint;
1447};
1448static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001449{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001450 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001451
1452 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001453 __dget_dlock(dentry);
1454 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001455 return D_WALK_QUIT;
1456 }
1457
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001458 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001459}
1460
1461static void check_and_drop(void *_data)
1462{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001463 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001464
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001465 if (!data->mountpoint && !data->select.found)
1466 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001467}
1468
1469/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001470 * d_invalidate - detach submounts, prune dcache, and drop
1471 * @dentry: dentry to invalidate (aka detach, prune and drop)
1472 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001473 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001474 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001475 * The final d_drop is done as an atomic operation relative to
1476 * rename_lock ensuring there are no races with d_set_mounted. This
1477 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001478 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001479void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001480{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001481 /*
1482 * If it's already been dropped, return OK.
1483 */
1484 spin_lock(&dentry->d_lock);
1485 if (d_unhashed(dentry)) {
1486 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001487 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001488 }
1489 spin_unlock(&dentry->d_lock);
1490
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001491 /* Negative dentries can be dropped without further checks */
1492 if (!dentry->d_inode) {
1493 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001494 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001495 }
1496
1497 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001498 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001499
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001500 data.mountpoint = NULL;
1501 INIT_LIST_HEAD(&data.select.dispose);
1502 data.select.start = dentry;
1503 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001504
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001505 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001506
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001507 if (data.select.found)
1508 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001509
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001510 if (data.mountpoint) {
1511 detach_mounts(data.mountpoint);
1512 dput(data.mountpoint);
1513 }
1514
1515 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001516 break;
1517
1518 cond_resched();
1519 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001520}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001521EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001522
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523/**
Al Viroa4464db2011-07-07 15:03:58 -04001524 * __d_alloc - allocate a dcache entry
1525 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 * @name: qstr of the name
1527 *
1528 * Allocates a dentry. It returns %NULL if there is insufficient memory
1529 * available. On a success the dentry is returned. The name passed in is
1530 * copied and the copy passed in may be reused after this call.
1531 */
1532
Al Viroa4464db2011-07-07 15:03:58 -04001533struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534{
1535 struct dentry *dentry;
1536 char *dname;
1537
Mel Gormane12ba742007-10-16 01:25:52 -07001538 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 if (!dentry)
1540 return NULL;
1541
Linus Torvalds6326c712012-05-21 16:14:04 -07001542 /*
1543 * We guarantee that the inline name is always NUL-terminated.
1544 * This way the memcpy() done by the name switching in rename
1545 * will still always have a NUL at the end, even if we might
1546 * be overwriting an internal NUL character
1547 */
1548 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001549 if (unlikely(!name)) {
1550 static const struct qstr anon = QSTR_INIT("/", 1);
1551 name = &anon;
1552 dname = dentry->d_iname;
1553 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001554 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001555 struct external_name *p = kmalloc(size + name->len,
1556 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001557 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 kmem_cache_free(dentry_cache, dentry);
1559 return NULL;
1560 }
Al Viro8d85b482014-09-29 14:54:27 -04001561 atomic_set(&p->u.count, 1);
1562 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001563 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1564 kasan_unpoison_shadow(dname,
1565 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 } else {
1567 dname = dentry->d_iname;
1568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
1570 dentry->d_name.len = name->len;
1571 dentry->d_name.hash = name->hash;
1572 memcpy(dname, name->name, name->len);
1573 dname[name->len] = 0;
1574
Linus Torvalds6326c712012-05-21 16:14:04 -07001575 /* Make sure we always see the terminating NUL character */
1576 smp_wmb();
1577 dentry->d_name.name = dname;
1578
Waiman Long98474232013-08-28 18:24:59 -07001579 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001580 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001582 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001584 dentry->d_parent = dentry;
1585 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 dentry->d_op = NULL;
1587 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001588 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 INIT_LIST_HEAD(&dentry->d_lru);
1590 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001591 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1592 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001593 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Nick Piggin3e880fb2011-01-07 17:49:19 +11001595 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001596
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 return dentry;
1598}
Al Viroa4464db2011-07-07 15:03:58 -04001599
1600/**
1601 * d_alloc - allocate a dcache entry
1602 * @parent: parent of entry to allocate
1603 * @name: qstr of the name
1604 *
1605 * Allocates a dentry. It returns %NULL if there is insufficient memory
1606 * available. On a success the dentry is returned. The name passed in is
1607 * copied and the copy passed in may be reused after this call.
1608 */
1609struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1610{
1611 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1612 if (!dentry)
1613 return NULL;
1614
1615 spin_lock(&parent->d_lock);
1616 /*
1617 * don't need child lock because it is not subject
1618 * to concurrency here
1619 */
1620 __dget_dlock(parent);
1621 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001622 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001623 spin_unlock(&parent->d_lock);
1624
1625 return dentry;
1626}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001627EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001629/**
1630 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1631 * @sb: the superblock
1632 * @name: qstr of the name
1633 *
1634 * For a filesystem that just pins its dentries in memory and never
1635 * performs lookups at all, return an unhashed IS_ROOT dentry.
1636 */
Nick Piggin4b936882011-01-07 17:50:07 +11001637struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1638{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001639 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001640}
1641EXPORT_SYMBOL(d_alloc_pseudo);
1642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1644{
1645 struct qstr q;
1646
1647 q.name = name;
George Spelvinfcfd2fb2016-05-20 08:41:37 -04001648 q.hash_len = hashlen_string(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 return d_alloc(parent, &q);
1650}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001651EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Nick Pigginfb045ad2011-01-07 17:49:55 +11001653void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1654{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001655 WARN_ON_ONCE(dentry->d_op);
1656 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001657 DCACHE_OP_COMPARE |
1658 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001659 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001660 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001661 DCACHE_OP_SELECT_INODE |
1662 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001663 dentry->d_op = op;
1664 if (!op)
1665 return;
1666 if (op->d_hash)
1667 dentry->d_flags |= DCACHE_OP_HASH;
1668 if (op->d_compare)
1669 dentry->d_flags |= DCACHE_OP_COMPARE;
1670 if (op->d_revalidate)
1671 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001672 if (op->d_weak_revalidate)
1673 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001674 if (op->d_delete)
1675 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001676 if (op->d_prune)
1677 dentry->d_flags |= DCACHE_OP_PRUNE;
David Howells4bacc9c2015-06-18 14:32:31 +01001678 if (op->d_select_inode)
1679 dentry->d_flags |= DCACHE_OP_SELECT_INODE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001680 if (op->d_real)
1681 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001682
1683}
1684EXPORT_SYMBOL(d_set_d_op);
1685
David Howellsdf1a0852015-01-29 12:02:28 +00001686
1687/*
1688 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1689 * @dentry - The dentry to mark
1690 *
1691 * Mark a dentry as falling through to the lower layer (as set with
1692 * d_pin_lower()). This flag may be recorded on the medium.
1693 */
1694void d_set_fallthru(struct dentry *dentry)
1695{
1696 spin_lock(&dentry->d_lock);
1697 dentry->d_flags |= DCACHE_FALLTHRU;
1698 spin_unlock(&dentry->d_lock);
1699}
1700EXPORT_SYMBOL(d_set_fallthru);
1701
David Howellsb18825a2013-09-12 19:22:53 +01001702static unsigned d_flags_for_inode(struct inode *inode)
1703{
David Howells44bdb5e2015-01-29 12:02:29 +00001704 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001705
1706 if (!inode)
1707 return DCACHE_MISS_TYPE;
1708
1709 if (S_ISDIR(inode->i_mode)) {
1710 add_flags = DCACHE_DIRECTORY_TYPE;
1711 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1712 if (unlikely(!inode->i_op->lookup))
1713 add_flags = DCACHE_AUTODIR_TYPE;
1714 else
1715 inode->i_opflags |= IOP_LOOKUP;
1716 }
David Howells44bdb5e2015-01-29 12:02:29 +00001717 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001718 }
1719
David Howells44bdb5e2015-01-29 12:02:29 +00001720 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001721 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001722 add_flags = DCACHE_SYMLINK_TYPE;
1723 goto type_determined;
1724 }
1725 inode->i_opflags |= IOP_NOFOLLOW;
1726 }
1727
1728 if (unlikely(!S_ISREG(inode->i_mode)))
1729 add_flags = DCACHE_SPECIAL_TYPE;
1730
1731type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001732 if (unlikely(IS_AUTOMOUNT(inode)))
1733 add_flags |= DCACHE_NEED_AUTOMOUNT;
1734 return add_flags;
1735}
1736
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001737static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1738{
David Howellsb18825a2013-09-12 19:22:53 +01001739 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001740 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001741
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001742 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001743 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001744 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001745 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001746 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001747 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001748 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001749}
1750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751/**
1752 * d_instantiate - fill in inode information for a dentry
1753 * @entry: dentry to complete
1754 * @inode: inode to attach to this dentry
1755 *
1756 * Fill in inode information in the entry.
1757 *
1758 * This turns negative dentries into productive full members
1759 * of society.
1760 *
1761 * NOTE! This assumes that the inode count has been incremented
1762 * (or otherwise set) by the caller to indicate that it is now
1763 * in use by the dcache.
1764 */
1765
1766void d_instantiate(struct dentry *entry, struct inode * inode)
1767{
Al Viro946e51f2014-10-26 19:19:16 -04001768 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001769 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001770 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001771 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001772 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001773 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001774 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001776EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001779 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1780 * @entry: dentry to complete
1781 * @inode: inode to attach to this dentry
1782 *
1783 * Fill in inode information in the entry. If a directory alias is found, then
1784 * return an error (and drop inode). Together with d_materialise_unique() this
1785 * guarantees that a directory inode may never have more than one alias.
1786 */
1787int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1788{
Al Viro946e51f2014-10-26 19:19:16 -04001789 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001790
Al Virob9680912016-04-11 00:53:26 -04001791 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001792 spin_lock(&inode->i_lock);
1793 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1794 spin_unlock(&inode->i_lock);
1795 iput(inode);
1796 return -EBUSY;
1797 }
1798 __d_instantiate(entry, inode);
1799 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001800
1801 return 0;
1802}
1803EXPORT_SYMBOL(d_instantiate_no_diralias);
1804
Al Viroadc0e912012-01-08 16:49:21 -05001805struct dentry *d_make_root(struct inode *root_inode)
1806{
1807 struct dentry *res = NULL;
1808
1809 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001810 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001811 if (res)
1812 d_instantiate(res, root_inode);
1813 else
1814 iput(root_inode);
1815 }
1816 return res;
1817}
1818EXPORT_SYMBOL(d_make_root);
1819
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001820static struct dentry * __d_find_any_alias(struct inode *inode)
1821{
1822 struct dentry *alias;
1823
Al Virob3d9b7a2012-06-09 13:51:19 -04001824 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001825 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001826 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001827 __dget(alias);
1828 return alias;
1829}
1830
Sage Weil46f72b32012-01-10 09:04:37 -08001831/**
1832 * d_find_any_alias - find any alias for a given inode
1833 * @inode: inode to find an alias for
1834 *
1835 * If any aliases exist for the given inode, take and return a
1836 * reference for one of them. If no aliases exist, return %NULL.
1837 */
1838struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001839{
1840 struct dentry *de;
1841
1842 spin_lock(&inode->i_lock);
1843 de = __d_find_any_alias(inode);
1844 spin_unlock(&inode->i_lock);
1845 return de;
1846}
Sage Weil46f72b32012-01-10 09:04:37 -08001847EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001848
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001849static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001850{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001851 struct dentry *tmp;
1852 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001853 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001854
1855 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001856 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001857 if (IS_ERR(inode))
1858 return ERR_CAST(inode);
1859
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001860 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001861 if (res)
1862 goto out_iput;
1863
Al Viro798434b2016-03-24 20:38:43 -04001864 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001865 if (!tmp) {
1866 res = ERR_PTR(-ENOMEM);
1867 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001868 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001869
Al Virob9680912016-04-11 00:53:26 -04001870 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001871 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001872 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001873 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001874 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001875 dput(tmp);
1876 goto out_iput;
1877 }
1878
1879 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001880 add_flags = d_flags_for_inode(inode);
1881
1882 if (disconnected)
1883 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001884
Christoph Hellwig9308a612008-08-11 15:49:12 +02001885 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001886 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001887 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001888 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001889 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001890 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001891 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001892 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001893
Christoph Hellwig9308a612008-08-11 15:49:12 +02001894 return tmp;
1895
1896 out_iput:
1897 iput(inode);
1898 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001899}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001900
1901/**
1902 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1903 * @inode: inode to allocate the dentry for
1904 *
1905 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1906 * similar open by handle operations. The returned dentry may be anonymous,
1907 * or may have a full name (if the inode was already in the cache).
1908 *
1909 * When called on a directory inode, we must ensure that the inode only ever
1910 * has one dentry. If a dentry is found, that is returned instead of
1911 * allocating a new one.
1912 *
1913 * On successful return, the reference to the inode has been transferred
1914 * to the dentry. In case of an error the reference on the inode is released.
1915 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1916 * be passed in and the error will be propagated to the return value,
1917 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1918 */
1919struct dentry *d_obtain_alias(struct inode *inode)
1920{
1921 return __d_obtain_alias(inode, 1);
1922}
Benny Halevyadc48722009-02-27 14:02:59 -08001923EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
1925/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001926 * d_obtain_root - find or allocate a dentry for a given inode
1927 * @inode: inode to allocate the dentry for
1928 *
1929 * Obtain an IS_ROOT dentry for the root of a filesystem.
1930 *
1931 * We must ensure that directory inodes only ever have one dentry. If a
1932 * dentry is found, that is returned instead of allocating a new one.
1933 *
1934 * On successful return, the reference to the inode has been transferred
1935 * to the dentry. In case of an error the reference on the inode is
1936 * released. A %NULL or IS_ERR inode may be passed in and will be the
1937 * error will be propagate to the return value, with a %NULL @inode
1938 * replaced by ERR_PTR(-ESTALE).
1939 */
1940struct dentry *d_obtain_root(struct inode *inode)
1941{
1942 return __d_obtain_alias(inode, 0);
1943}
1944EXPORT_SYMBOL(d_obtain_root);
1945
1946/**
Barry Naujok94035402008-05-21 16:50:46 +10001947 * d_add_ci - lookup or allocate new dentry with case-exact name
1948 * @inode: the inode case-insensitive lookup has found
1949 * @dentry: the negative dentry that was passed to the parent's lookup func
1950 * @name: the case-exact name to be associated with the returned dentry
1951 *
1952 * This is to avoid filling the dcache with case-insensitive names to the
1953 * same inode, only the actual correct case is stored in the dcache for
1954 * case-insensitive filesystems.
1955 *
1956 * For a case-insensitive lookup match and if the the case-exact dentry
1957 * already exists in in the dcache, use it and return it.
1958 *
1959 * If no entry exists with the exact case name, allocate new dentry with
1960 * the exact case, and return the spliced entry.
1961 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001962struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001963 struct qstr *name)
1964{
Al Virod9171b92016-04-15 03:33:13 -04001965 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10001966
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001967 /*
1968 * First check if a dentry matching the name already exists,
1969 * if not go ahead and create it now.
1970 */
Barry Naujok94035402008-05-21 16:50:46 +10001971 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04001972 if (found) {
1973 iput(inode);
1974 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001975 }
Al Virod9171b92016-04-15 03:33:13 -04001976 if (d_in_lookup(dentry)) {
1977 found = d_alloc_parallel(dentry->d_parent, name,
1978 dentry->d_wait);
1979 if (IS_ERR(found) || !d_in_lookup(found)) {
1980 iput(inode);
1981 return found;
1982 }
1983 } else {
1984 found = d_alloc(dentry->d_parent, name);
1985 if (!found) {
1986 iput(inode);
1987 return ERR_PTR(-ENOMEM);
1988 }
1989 }
1990 res = d_splice_alias(inode, found);
1991 if (res) {
1992 dput(found);
1993 return res;
1994 }
Al Viro4f522a22013-02-11 23:20:37 -05001995 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001996}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001997EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001999/*
2000 * Do the slow-case of the dentry name compare.
2001 *
2002 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07002003 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002004 * filesystem can rely on them, and can use the 'name' and
2005 * 'len' information without worrying about walking off the
2006 * end of memory etc.
2007 *
2008 * Thus the read_seqcount_retry() and the "duplicate" info
2009 * in arguments (the low-level filesystem should not look
2010 * at the dentry inode or name contents directly, since
2011 * rename can change them while we're in RCU mode).
2012 */
2013enum slow_d_compare {
2014 D_COMP_OK,
2015 D_COMP_NOMATCH,
2016 D_COMP_SEQRETRY,
2017};
2018
2019static noinline enum slow_d_compare slow_dentry_cmp(
2020 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002021 struct dentry *dentry,
2022 unsigned int seq,
2023 const struct qstr *name)
2024{
2025 int tlen = dentry->d_name.len;
2026 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002027
2028 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2029 cpu_relax();
2030 return D_COMP_SEQRETRY;
2031 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002032 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002033 return D_COMP_NOMATCH;
2034 return D_COMP_OK;
2035}
2036
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002038 * __d_lookup_rcu - search for a dentry (racy, store-free)
2039 * @parent: parent dentry
2040 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002041 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002042 * Returns: dentry, or NULL
2043 *
2044 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2045 * resolution (store-free path walking) design described in
2046 * Documentation/filesystems/path-lookup.txt.
2047 *
2048 * This is not to be used outside core vfs.
2049 *
2050 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2051 * held, and rcu_read_lock held. The returned dentry must not be stored into
2052 * without taking d_lock and checking d_seq sequence count against @seq
2053 * returned here.
2054 *
Linus Torvalds15570082013-09-02 11:38:06 -07002055 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002056 * function.
2057 *
2058 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2059 * the returned dentry, so long as its parent's seqlock is checked after the
2060 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2061 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002062 *
2063 * NOTE! The caller *has* to check the resulting dentry against the sequence
2064 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002065 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002066struct dentry *__d_lookup_rcu(const struct dentry *parent,
2067 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002068 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002069{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002070 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002071 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002072 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002073 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002074 struct dentry *dentry;
2075
2076 /*
2077 * Note: There is significant duplication with __d_lookup_rcu which is
2078 * required to prevent single threaded performance regressions
2079 * especially on architectures where smp_rmb (in seqcounts) are costly.
2080 * Keep the two functions in sync.
2081 */
2082
2083 /*
2084 * The hash list is protected using RCU.
2085 *
2086 * Carefully use d_seq when comparing a candidate dentry, to avoid
2087 * races with d_move().
2088 *
2089 * It is possible that concurrent renames can mess up our list
2090 * walk here and result in missing our dentry, resulting in the
2091 * false-negative result. d_lookup() protects against concurrent
2092 * renames using rename_lock seqlock.
2093 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002094 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002095 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002096 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002097 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002098
Nick Piggin31e6b012011-01-07 17:49:52 +11002099seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002100 /*
2101 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002102 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002103 *
2104 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002105 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002106 *
2107 * NOTE! We do a "raw" seqcount_begin here. That means that
2108 * we don't wait for the sequence count to stabilize if it
2109 * is in the middle of a sequence change. If we do the slow
2110 * dentry compare, we will do seqretries until it is stable,
2111 * and if we end up with a successful lookup, we actually
2112 * want to exit RCU lookup anyway.
2113 */
2114 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002115 if (dentry->d_parent != parent)
2116 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002117 if (d_unhashed(dentry))
2118 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002119
2120 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002121 if (dentry->d_name.hash != hashlen_hash(hashlen))
2122 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002123 *seqp = seq;
2124 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002125 case D_COMP_OK:
2126 return dentry;
2127 case D_COMP_NOMATCH:
2128 continue;
2129 default:
2130 goto seqretry;
2131 }
2132 }
2133
Linus Torvalds26fe5752012-05-10 13:14:12 -07002134 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002135 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002136 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002137 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002138 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002139 }
2140 return NULL;
2141}
2142
2143/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 * d_lookup - search for a dentry
2145 * @parent: parent dentry
2146 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002147 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002149 * d_lookup searches the children of the parent dentry for the name in
2150 * question. If the dentry is found its reference count is incremented and the
2151 * dentry is returned. The caller must use dput to free the entry when it has
2152 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 */
Al Viroda2d8452013-01-24 18:29:34 -05002154struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155{
Nick Piggin31e6b012011-01-07 17:49:52 +11002156 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002157 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158
Daeseok Younb8314f92014-08-11 11:46:53 +09002159 do {
2160 seq = read_seqbegin(&rename_lock);
2161 dentry = __d_lookup(parent, name);
2162 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 break;
2164 } while (read_seqretry(&rename_lock, seq));
2165 return dentry;
2166}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002167EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
Nick Piggin31e6b012011-01-07 17:49:52 +11002169/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002170 * __d_lookup - search for a dentry (racy)
2171 * @parent: parent dentry
2172 * @name: qstr of name we wish to find
2173 * Returns: dentry, or NULL
2174 *
2175 * __d_lookup is like d_lookup, however it may (rarely) return a
2176 * false-negative result due to unrelated rename activity.
2177 *
2178 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2179 * however it must be used carefully, eg. with a following d_lookup in
2180 * the case of failure.
2181 *
2182 * __d_lookup callers must be commented.
2183 */
Al Viroa713ca22013-01-24 18:27:00 -05002184struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185{
2186 unsigned int len = name->len;
2187 unsigned int hash = name->hash;
2188 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002189 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002190 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002191 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002192 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
Nick Pigginb04f7842010-08-18 04:37:34 +10002194 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002195 * Note: There is significant duplication with __d_lookup_rcu which is
2196 * required to prevent single threaded performance regressions
2197 * especially on architectures where smp_rmb (in seqcounts) are costly.
2198 * Keep the two functions in sync.
2199 */
2200
2201 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002202 * The hash list is protected using RCU.
2203 *
2204 * Take d_lock when comparing a candidate dentry, to avoid races
2205 * with d_move().
2206 *
2207 * It is possible that concurrent renames can mess up our list
2208 * walk here and result in missing our dentry, resulting in the
2209 * false-negative result. d_lookup() protects against concurrent
2210 * renames using rename_lock seqlock.
2211 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002212 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002213 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 rcu_read_lock();
2215
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002216 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 if (dentry->d_name.hash != hash)
2219 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220
2221 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 if (dentry->d_parent != parent)
2223 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002224 if (d_unhashed(dentry))
2225 goto next;
2226
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 /*
2228 * It is safe to compare names since d_move() cannot
2229 * change the qstr (protected by d_lock).
2230 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002231 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002232 int tlen = dentry->d_name.len;
2233 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002234 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 goto next;
2236 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002237 if (dentry->d_name.len != len)
2238 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002239 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 goto next;
2241 }
2242
Waiman Long98474232013-08-28 18:24:59 -07002243 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002244 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 spin_unlock(&dentry->d_lock);
2246 break;
2247next:
2248 spin_unlock(&dentry->d_lock);
2249 }
2250 rcu_read_unlock();
2251
2252 return found;
2253}
2254
2255/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002256 * d_hash_and_lookup - hash the qstr then search for a dentry
2257 * @dir: Directory to search in
2258 * @name: qstr of name we wish to find
2259 *
Al Viro4f522a22013-02-11 23:20:37 -05002260 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002261 */
2262struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2263{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002264 /*
2265 * Check for a fs-specific hash function. Note that we must
2266 * calculate the standard hash first, as the d_op->d_hash()
2267 * routine may choose to leave the hash value unchanged.
2268 */
2269 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002270 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002271 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002272 if (unlikely(err < 0))
2273 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002274 }
Al Viro4f522a22013-02-11 23:20:37 -05002275 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002276}
Al Viro4f522a22013-02-11 23:20:37 -05002277EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002278
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279/*
2280 * When a file is deleted, we have two options:
2281 * - turn this dentry into a negative dentry
2282 * - unhash this dentry and free it.
2283 *
2284 * Usually, we want to just turn this into
2285 * a negative dentry, but if anybody else is
2286 * currently using the dentry or the inode
2287 * we can't do that and we fall back on removing
2288 * it from the hash queues and waiting for
2289 * it to be deleted later when it has no users
2290 */
2291
2292/**
2293 * d_delete - delete a dentry
2294 * @dentry: The dentry to delete
2295 *
2296 * Turn the dentry into a negative dentry if possible, otherwise
2297 * remove it from the hash queues so it can be deleted later
2298 */
2299
2300void d_delete(struct dentry * dentry)
2301{
Nick Piggin873feea2011-01-07 17:50:06 +11002302 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002303 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 /*
2305 * Are we the only user?
2306 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002307again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002309 inode = dentry->d_inode;
2310 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002311 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002312 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002313 spin_unlock(&dentry->d_lock);
2314 cpu_relax();
2315 goto again;
2316 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002317 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002318 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002319 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 return;
2321 }
2322
2323 if (!d_unhashed(dentry))
2324 __d_drop(dentry);
2325
2326 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002327
2328 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002330EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002332static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002334 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002335 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002336 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002337 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002338 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339}
2340
David Howells770bfad2006-08-22 20:06:07 -04002341static void _d_rehash(struct dentry * entry)
2342{
2343 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2344}
2345
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346/**
2347 * d_rehash - add an entry back to the hash
2348 * @entry: dentry to add to the hash
2349 *
2350 * Adds a dentry to the hash according to its name.
2351 */
2352
2353void d_rehash(struct dentry * entry)
2354{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002356 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002359EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360
Al Viro84e710d2016-04-15 00:58:55 -04002361static inline unsigned start_dir_add(struct inode *dir)
2362{
2363
2364 for (;;) {
2365 unsigned n = dir->i_dir_seq;
2366 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2367 return n;
2368 cpu_relax();
2369 }
2370}
2371
2372static inline void end_dir_add(struct inode *dir, unsigned n)
2373{
2374 smp_store_release(&dir->i_dir_seq, n + 2);
2375}
2376
Al Virod9171b92016-04-15 03:33:13 -04002377static void d_wait_lookup(struct dentry *dentry)
2378{
2379 if (d_in_lookup(dentry)) {
2380 DECLARE_WAITQUEUE(wait, current);
2381 add_wait_queue(dentry->d_wait, &wait);
2382 do {
2383 set_current_state(TASK_UNINTERRUPTIBLE);
2384 spin_unlock(&dentry->d_lock);
2385 schedule();
2386 spin_lock(&dentry->d_lock);
2387 } while (d_in_lookup(dentry));
2388 }
2389}
2390
Al Viro94bdd652016-04-15 02:42:04 -04002391struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002392 const struct qstr *name,
2393 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002394{
2395 unsigned int len = name->len;
2396 unsigned int hash = name->hash;
2397 const unsigned char *str = name->name;
2398 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2399 struct hlist_bl_node *node;
2400 struct dentry *new = d_alloc(parent, name);
2401 struct dentry *dentry;
2402 unsigned seq, r_seq, d_seq;
2403
2404 if (unlikely(!new))
2405 return ERR_PTR(-ENOMEM);
2406
2407retry:
2408 rcu_read_lock();
2409 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2410 r_seq = read_seqbegin(&rename_lock);
2411 dentry = __d_lookup_rcu(parent, name, &d_seq);
2412 if (unlikely(dentry)) {
2413 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2414 rcu_read_unlock();
2415 goto retry;
2416 }
2417 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2418 rcu_read_unlock();
2419 dput(dentry);
2420 goto retry;
2421 }
2422 rcu_read_unlock();
2423 dput(new);
2424 return dentry;
2425 }
2426 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2427 rcu_read_unlock();
2428 goto retry;
2429 }
2430 hlist_bl_lock(b);
2431 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2432 hlist_bl_unlock(b);
2433 rcu_read_unlock();
2434 goto retry;
2435 }
2436 rcu_read_unlock();
2437 /*
2438 * No changes for the parent since the beginning of d_lookup().
2439 * Since all removals from the chain happen with hlist_bl_lock(),
2440 * any potential in-lookup matches are going to stay here until
2441 * we unlock the chain. All fields are stable in everything
2442 * we encounter.
2443 */
2444 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2445 if (dentry->d_name.hash != hash)
2446 continue;
2447 if (dentry->d_parent != parent)
2448 continue;
2449 if (d_unhashed(dentry))
2450 continue;
2451 if (parent->d_flags & DCACHE_OP_COMPARE) {
2452 int tlen = dentry->d_name.len;
2453 const char *tname = dentry->d_name.name;
2454 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2455 continue;
2456 } else {
2457 if (dentry->d_name.len != len)
2458 continue;
2459 if (dentry_cmp(dentry, str, len))
2460 continue;
2461 }
2462 dget(dentry);
2463 hlist_bl_unlock(b);
Al Virod9171b92016-04-15 03:33:13 -04002464 /* somebody is doing lookup for it right now; wait for it */
2465 spin_lock(&dentry->d_lock);
2466 d_wait_lookup(dentry);
2467 /*
2468 * it's not in-lookup anymore; in principle we should repeat
2469 * everything from dcache lookup, but it's likely to be what
2470 * d_lookup() would've found anyway. If it is, just return it;
2471 * otherwise we really have to repeat the whole thing.
2472 */
2473 if (unlikely(dentry->d_name.hash != hash))
2474 goto mismatch;
2475 if (unlikely(dentry->d_parent != parent))
2476 goto mismatch;
2477 if (unlikely(d_unhashed(dentry)))
2478 goto mismatch;
2479 if (parent->d_flags & DCACHE_OP_COMPARE) {
2480 int tlen = dentry->d_name.len;
2481 const char *tname = dentry->d_name.name;
2482 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2483 goto mismatch;
2484 } else {
2485 if (unlikely(dentry->d_name.len != len))
2486 goto mismatch;
2487 if (unlikely(dentry_cmp(dentry, str, len)))
2488 goto mismatch;
2489 }
2490 /* OK, it *is* a hashed match; return it */
2491 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002492 dput(new);
2493 return dentry;
2494 }
2495 /* we can't take ->d_lock here; it's OK, though. */
2496 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002497 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002498 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2499 hlist_bl_unlock(b);
2500 return new;
Al Virod9171b92016-04-15 03:33:13 -04002501mismatch:
2502 spin_unlock(&dentry->d_lock);
2503 dput(dentry);
2504 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002505}
2506EXPORT_SYMBOL(d_alloc_parallel);
2507
Al Viro85c7f812016-04-14 19:52:13 -04002508void __d_lookup_done(struct dentry *dentry)
2509{
Al Viro94bdd652016-04-15 02:42:04 -04002510 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2511 dentry->d_name.hash);
2512 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002513 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002514 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002515 wake_up_all(dentry->d_wait);
2516 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002517 hlist_bl_unlock(b);
2518 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002519 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002520}
2521EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002522
2523/* inode->i_lock held if inode is non-NULL */
2524
2525static inline void __d_add(struct dentry *dentry, struct inode *inode)
2526{
Al Viro84e710d2016-04-15 00:58:55 -04002527 struct inode *dir = NULL;
2528 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002529 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002530 if (unlikely(d_in_lookup(dentry))) {
2531 dir = dentry->d_parent->d_inode;
2532 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002533 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002534 }
Al Viroed782b52016-03-09 19:52:39 -05002535 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002536 unsigned add_flags = d_flags_for_inode(inode);
2537 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2538 raw_write_seqcount_begin(&dentry->d_seq);
2539 __d_set_inode_and_type(dentry, inode, add_flags);
2540 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002541 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002542 }
Al Viro0568d702016-04-14 19:40:56 -04002543 _d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002544 if (dir)
2545 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002546 spin_unlock(&dentry->d_lock);
2547 if (inode)
2548 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002549}
2550
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002551/**
Al Viro34d0d192016-03-08 21:01:03 -05002552 * d_add - add dentry to hash queues
2553 * @entry: dentry to add
2554 * @inode: The inode to attach to this dentry
2555 *
2556 * This adds the entry to the hash queues and initializes @inode.
2557 * The entry was actually filled in earlier during d_alloc().
2558 */
2559
2560void d_add(struct dentry *entry, struct inode *inode)
2561{
Al Virob9680912016-04-11 00:53:26 -04002562 if (inode) {
2563 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002564 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002565 }
Al Viroed782b52016-03-09 19:52:39 -05002566 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002567}
2568EXPORT_SYMBOL(d_add);
2569
2570/**
Al Viro668d0cd2016-03-08 12:44:17 -05002571 * d_exact_alias - find and hash an exact unhashed alias
2572 * @entry: dentry to add
2573 * @inode: The inode to go with this dentry
2574 *
2575 * If an unhashed dentry with the same name/parent and desired
2576 * inode already exists, hash and return it. Otherwise, return
2577 * NULL.
2578 *
2579 * Parent directory should be locked.
2580 */
2581struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2582{
2583 struct dentry *alias;
2584 int len = entry->d_name.len;
2585 const char *name = entry->d_name.name;
2586 unsigned int hash = entry->d_name.hash;
2587
2588 spin_lock(&inode->i_lock);
2589 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2590 /*
2591 * Don't need alias->d_lock here, because aliases with
2592 * d_parent == entry->d_parent are not subject to name or
2593 * parent changes, because the parent inode i_mutex is held.
2594 */
2595 if (alias->d_name.hash != hash)
2596 continue;
2597 if (alias->d_parent != entry->d_parent)
2598 continue;
2599 if (alias->d_name.len != len)
2600 continue;
2601 if (dentry_cmp(alias, name, len))
2602 continue;
2603 spin_lock(&alias->d_lock);
2604 if (!d_unhashed(alias)) {
2605 spin_unlock(&alias->d_lock);
2606 alias = NULL;
2607 } else {
2608 __dget_dlock(alias);
2609 _d_rehash(alias);
2610 spin_unlock(&alias->d_lock);
2611 }
2612 spin_unlock(&inode->i_lock);
2613 return alias;
2614 }
2615 spin_unlock(&inode->i_lock);
2616 return NULL;
2617}
2618EXPORT_SYMBOL(d_exact_alias);
2619
2620/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002621 * dentry_update_name_case - update case insensitive dentry with a new name
2622 * @dentry: dentry to be updated
2623 * @name: new name
2624 *
2625 * Update a case insensitive dentry with new case of name.
2626 *
2627 * dentry must have been returned by d_lookup with name @name. Old and new
2628 * name lengths must match (ie. no d_compare which allows mismatched name
2629 * lengths).
2630 *
2631 * Parent inode i_mutex must be held over d_lookup and into this call (to
2632 * keep renames and concurrent inserts, and readdir(2) away).
2633 */
2634void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2635{
Al Viro59551022016-01-22 15:40:57 -05002636 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002637 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2638
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002639 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002640 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002641 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002642 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002643 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002644}
2645EXPORT_SYMBOL(dentry_update_name_case);
2646
Al Viro8d85b482014-09-29 14:54:27 -04002647static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648{
Al Viro8d85b482014-09-29 14:54:27 -04002649 if (unlikely(dname_external(target))) {
2650 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 /*
2652 * Both external: swap the pointers
2653 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002654 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 } else {
2656 /*
2657 * dentry:internal, target:external. Steal target's
2658 * storage and make target internal.
2659 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002660 memcpy(target->d_iname, dentry->d_name.name,
2661 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 dentry->d_name.name = target->d_name.name;
2663 target->d_name.name = target->d_iname;
2664 }
2665 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002666 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 /*
2668 * dentry:external, target:internal. Give dentry's
2669 * storage to target and make dentry internal
2670 */
2671 memcpy(dentry->d_iname, target->d_name.name,
2672 target->d_name.len + 1);
2673 target->d_name.name = dentry->d_name.name;
2674 dentry->d_name.name = dentry->d_iname;
2675 } else {
2676 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002677 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002679 unsigned int i;
2680 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002681 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2682 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002683 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2684 swap(((long *) &dentry->d_iname)[i],
2685 ((long *) &target->d_iname)[i]);
2686 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 }
2688 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002689 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690}
2691
Al Viro8d85b482014-09-29 14:54:27 -04002692static void copy_name(struct dentry *dentry, struct dentry *target)
2693{
2694 struct external_name *old_name = NULL;
2695 if (unlikely(dname_external(dentry)))
2696 old_name = external_name(dentry);
2697 if (unlikely(dname_external(target))) {
2698 atomic_inc(&external_name(target)->u.count);
2699 dentry->d_name = target->d_name;
2700 } else {
2701 memcpy(dentry->d_iname, target->d_name.name,
2702 target->d_name.len + 1);
2703 dentry->d_name.name = dentry->d_iname;
2704 dentry->d_name.hash_len = target->d_name.hash_len;
2705 }
2706 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2707 kfree_rcu(old_name, u.head);
2708}
2709
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002710static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2711{
2712 /*
2713 * XXXX: do we really need to take target->d_lock?
2714 */
2715 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2716 spin_lock(&target->d_parent->d_lock);
2717 else {
2718 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2719 spin_lock(&dentry->d_parent->d_lock);
2720 spin_lock_nested(&target->d_parent->d_lock,
2721 DENTRY_D_LOCK_NESTED);
2722 } else {
2723 spin_lock(&target->d_parent->d_lock);
2724 spin_lock_nested(&dentry->d_parent->d_lock,
2725 DENTRY_D_LOCK_NESTED);
2726 }
2727 }
2728 if (target < dentry) {
2729 spin_lock_nested(&target->d_lock, 2);
2730 spin_lock_nested(&dentry->d_lock, 3);
2731 } else {
2732 spin_lock_nested(&dentry->d_lock, 2);
2733 spin_lock_nested(&target->d_lock, 3);
2734 }
2735}
2736
Al Viro986c0192014-09-26 23:11:15 -04002737static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002738{
2739 if (target->d_parent != dentry->d_parent)
2740 spin_unlock(&dentry->d_parent->d_lock);
2741 if (target->d_parent != target)
2742 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002743 spin_unlock(&target->d_lock);
2744 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002745}
2746
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002748 * When switching names, the actual string doesn't strictly have to
2749 * be preserved in the target - because we're dropping the target
2750 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002751 * the new name before we switch, unless we are going to rehash
2752 * it. Note that if we *do* unhash the target, we are not allowed
2753 * to rehash it without giving it a new name/hash key - whether
2754 * we swap or overwrite the names here, resulting name won't match
2755 * the reality in filesystem; it's only there for d_path() purposes.
2756 * Note that all of this is happening under rename_lock, so the
2757 * any hash lookup seeing it in the middle of manipulations will
2758 * be discarded anyway. So we do not care what happens to the hash
2759 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002761/*
Al Viro18367502011-07-12 21:42:24 -04002762 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 * @dentry: entry to move
2764 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002765 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 *
2767 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002768 * dcache entries should not be moved in this way. Caller must hold
2769 * rename_lock, the i_mutex of the source and target directories,
2770 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002772static void __d_move(struct dentry *dentry, struct dentry *target,
2773 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774{
Al Viro84e710d2016-04-15 00:58:55 -04002775 struct inode *dir = NULL;
2776 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 if (!dentry->d_inode)
2778 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2779
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002780 BUG_ON(d_ancestor(dentry, target));
2781 BUG_ON(d_ancestor(target, dentry));
2782
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002783 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002784 if (unlikely(d_in_lookup(target))) {
2785 dir = target->d_parent->d_inode;
2786 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002787 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789
Nick Piggin31e6b012011-01-07 17:49:52 +11002790 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002791 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002792
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002793 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2794
2795 /*
2796 * Move the dentry to the target hash queue. Don't bother checking
2797 * for the same hash queue because of how unlikely it is.
2798 */
2799 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002800 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801
Miklos Szeredida1ce062014-04-01 17:08:43 +02002802 /*
2803 * Unhash the target (d_delete() is not usable here). If exchanging
2804 * the two dentries, then rehash onto the other's hash queue.
2805 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002807 if (exchange) {
2808 __d_rehash(target,
2809 d_hash(dentry->d_parent, dentry->d_name.hash));
2810 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002813 if (exchange)
2814 swap_names(dentry, target);
2815 else
2816 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817
Al Viro63cf4272014-09-26 23:06:14 -04002818 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002820 /* splicing a tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 dentry->d_parent = target->d_parent;
2822 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002823 list_del_init(&target->d_child);
2824 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002826 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002827 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002828 list_move(&target->d_child, &target->d_parent->d_subdirs);
2829 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002830 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002831 fsnotify_update_flags(target);
2832 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 }
2834
Nick Piggin31e6b012011-01-07 17:49:52 +11002835 write_seqcount_end(&target->d_seq);
2836 write_seqcount_end(&dentry->d_seq);
2837
Al Viro84e710d2016-04-15 00:58:55 -04002838 if (dir)
2839 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002840 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002841}
2842
2843/*
2844 * d_move - move a dentry
2845 * @dentry: entry to move
2846 * @target: new dentry
2847 *
2848 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002849 * dcache entries should not be moved in this way. See the locking
2850 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002851 */
2852void d_move(struct dentry *dentry, struct dentry *target)
2853{
2854 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002855 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002857}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002858EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859
Miklos Szeredida1ce062014-04-01 17:08:43 +02002860/*
2861 * d_exchange - exchange two dentries
2862 * @dentry1: first dentry
2863 * @dentry2: second dentry
2864 */
2865void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2866{
2867 write_seqlock(&rename_lock);
2868
2869 WARN_ON(!dentry1->d_inode);
2870 WARN_ON(!dentry2->d_inode);
2871 WARN_ON(IS_ROOT(dentry1));
2872 WARN_ON(IS_ROOT(dentry2));
2873
2874 __d_move(dentry1, dentry2, true);
2875
2876 write_sequnlock(&rename_lock);
2877}
2878
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002879/**
2880 * d_ancestor - search for an ancestor
2881 * @p1: ancestor dentry
2882 * @p2: child dentry
2883 *
2884 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2885 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002886 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002887struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002888{
2889 struct dentry *p;
2890
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002891 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002892 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002893 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002894 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002895 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002896}
2897
2898/*
2899 * This helper attempts to cope with remotely renamed directories
2900 *
2901 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002902 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002903 *
2904 * Note: If ever the locking in lock_rename() changes, then please
2905 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002906 */
Al Virob5ae6b12014-10-12 22:16:02 -04002907static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002908 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002909{
Al Viro9902af72016-04-15 15:08:36 -04002910 struct mutex *m1 = NULL;
2911 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002912 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002913
2914 /* If alias and dentry share a parent, then no extra locks required */
2915 if (alias->d_parent == dentry->d_parent)
2916 goto out_unalias;
2917
Trond Myklebust9eaef272006-10-21 10:24:20 -07002918 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002919 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2920 goto out_err;
2921 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002922 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002923 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002924 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002925out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002926 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002927 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002928out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002929 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002930 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002931 if (m1)
2932 mutex_unlock(m1);
2933 return ret;
2934}
2935
David Howells770bfad2006-08-22 20:06:07 -04002936/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002937 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2938 * @inode: the inode which may have a disconnected dentry
2939 * @dentry: a negative dentry which we want to point to the inode.
2940 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002941 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2942 * place of the given dentry and return it, else simply d_add the inode
2943 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002944 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002945 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2946 * we should error out: directories can't have multiple aliases.
2947 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002948 * This is needed in the lookup routine of any filesystem that is exportable
2949 * (via knfsd) so that we can build dcache paths to directories effectively.
2950 *
2951 * If a dentry was found and moved, then it is returned. Otherwise NULL
2952 * is returned. This matches the expected return value of ->lookup.
2953 *
2954 * Cluster filesystems may call this function with a negative, hashed dentry.
2955 * In that case, we know that the inode will be a regular file, and also this
2956 * will only occur during atomic_open. So we need to check for the dentry
2957 * being already hashed only in the final case.
2958 */
2959struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2960{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002961 if (IS_ERR(inode))
2962 return ERR_CAST(inode);
2963
David Howells770bfad2006-08-22 20:06:07 -04002964 BUG_ON(!d_unhashed(dentry));
2965
Al Virode689f52016-03-09 18:05:42 -05002966 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002967 goto out;
Al Virode689f52016-03-09 18:05:42 -05002968
Al Virob9680912016-04-11 00:53:26 -04002969 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002970 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002971 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002972 struct dentry *new = __d_find_any_alias(inode);
2973 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002974 /* The reference to new ensures it remains an alias */
2975 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002976 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002977 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002978 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002979 dput(new);
2980 new = ERR_PTR(-ELOOP);
2981 pr_warn_ratelimited(
2982 "VFS: Lookup of '%s' in %s %s"
2983 " would have caused loop\n",
2984 dentry->d_name.name,
2985 inode->i_sb->s_type->name,
2986 inode->i_sb->s_id);
2987 } else if (!IS_ROOT(new)) {
2988 int err = __d_unalias(inode, dentry, new);
2989 write_sequnlock(&rename_lock);
2990 if (err) {
2991 dput(new);
2992 new = ERR_PTR(err);
2993 }
Al Viro18367502011-07-12 21:42:24 -04002994 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002995 __d_move(new, dentry, false);
2996 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002997 }
Al Virob5ae6b12014-10-12 22:16:02 -04002998 iput(inode);
2999 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003000 }
David Howells770bfad2006-08-22 20:06:07 -04003001 }
Al Virob5ae6b12014-10-12 22:16:02 -04003002out:
Al Viroed782b52016-03-09 19:52:39 -05003003 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003004 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003005}
Al Virob5ae6b12014-10-12 22:16:02 -04003006EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003007
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003008static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003009{
3010 *buflen -= namelen;
3011 if (*buflen < 0)
3012 return -ENAMETOOLONG;
3013 *buffer -= namelen;
3014 memcpy(*buffer, str, namelen);
3015 return 0;
3016}
3017
Waiman Long232d2d62013-09-09 12:18:13 -04003018/**
3019 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003020 * @buffer: buffer pointer
3021 * @buflen: allocated length of the buffer
3022 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003023 *
3024 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3025 * make sure that either the old or the new name pointer and length are
3026 * fetched. However, there may be mismatch between length and pointer.
3027 * The length cannot be trusted, we need to copy it byte-by-byte until
3028 * the length is reached or a null byte is found. It also prepends "/" at
3029 * the beginning of the name. The sequence number check at the caller will
3030 * retry it again when a d_move() does happen. So any garbage in the buffer
3031 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003032 *
3033 * Data dependency barrier is needed to make sure that we see that terminating
3034 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003035 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003036static int prepend_name(char **buffer, int *buflen, struct qstr *name)
3037{
Waiman Long232d2d62013-09-09 12:18:13 -04003038 const char *dname = ACCESS_ONCE(name->name);
3039 u32 dlen = ACCESS_ONCE(name->len);
3040 char *p;
3041
Al Viro6d13f692014-09-29 14:46:30 -04003042 smp_read_barrier_depends();
3043
Waiman Long232d2d62013-09-09 12:18:13 -04003044 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003045 if (*buflen < 0)
3046 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003047 p = *buffer -= dlen + 1;
3048 *p++ = '/';
3049 while (dlen--) {
3050 char c = *dname++;
3051 if (!c)
3052 break;
3053 *p++ = c;
3054 }
3055 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003056}
3057
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003059 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003060 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003061 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003062 * @buffer: pointer to the end of the buffer
3063 * @buflen: pointer to buffer length
3064 *
Waiman Long18129972013-09-12 10:55:35 -04003065 * The function will first try to write out the pathname without taking any
3066 * lock other than the RCU read lock to make sure that dentries won't go away.
3067 * It only checks the sequence number of the global rename_lock as any change
3068 * in the dentry's d_seq will be preceded by changes in the rename_lock
3069 * sequence number. If the sequence number had been changed, it will restart
3070 * the whole pathname back-tracing sequence again by taking the rename_lock.
3071 * In this case, there is no need to take the RCU read lock as the recursive
3072 * parent pointer references will keep the dentry chain alive as long as no
3073 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003074 */
Al Viro02125a82011-12-05 08:43:34 -05003075static int prepend_path(const struct path *path,
3076 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003077 char **buffer, int *buflen)
3078{
Al Viroede4ceb2013-11-13 07:45:40 -05003079 struct dentry *dentry;
3080 struct vfsmount *vfsmnt;
3081 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003082 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003083 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003084 char *bptr;
3085 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003086
Al Viro48f5ec22013-09-09 15:22:25 -04003087 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003088restart_mnt:
3089 read_seqbegin_or_lock(&mount_lock, &m_seq);
3090 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003091 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003092restart:
3093 bptr = *buffer;
3094 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003095 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003096 dentry = path->dentry;
3097 vfsmnt = path->mnt;
3098 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003099 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003100 while (dentry != root->dentry || vfsmnt != root->mnt) {
3101 struct dentry * parent;
3102
3103 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003104 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003105 /* Escaped? */
3106 if (dentry != vfsmnt->mnt_root) {
3107 bptr = *buffer;
3108 blen = *buflen;
3109 error = 3;
3110 break;
3111 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003112 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003113 if (mnt != parent) {
3114 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3115 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003116 vfsmnt = &mnt->mnt;
3117 continue;
3118 }
Waiman Long232d2d62013-09-09 12:18:13 -04003119 if (!error)
3120 error = is_mounted(vfsmnt) ? 1 : 2;
3121 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003122 }
3123 parent = dentry->d_parent;
3124 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003125 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003126 if (error)
3127 break;
3128
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003129 dentry = parent;
3130 }
Al Viro48f5ec22013-09-09 15:22:25 -04003131 if (!(seq & 1))
3132 rcu_read_unlock();
3133 if (need_seqretry(&rename_lock, seq)) {
3134 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003135 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003136 }
Al Viro48f5ec22013-09-09 15:22:25 -04003137 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003138
3139 if (!(m_seq & 1))
3140 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003141 if (need_seqretry(&mount_lock, m_seq)) {
3142 m_seq = 1;
3143 goto restart_mnt;
3144 }
3145 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003146
Waiman Long232d2d62013-09-09 12:18:13 -04003147 if (error >= 0 && bptr == *buffer) {
3148 if (--blen < 0)
3149 error = -ENAMETOOLONG;
3150 else
3151 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003152 }
Waiman Long232d2d62013-09-09 12:18:13 -04003153 *buffer = bptr;
3154 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003155 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003156}
3157
3158/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003159 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003160 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003161 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003162 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 * @buflen: buffer length
3164 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003165 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003167 * Returns a pointer into the buffer or an error code if the
3168 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003169 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003170 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003171 *
Al Viro02125a82011-12-05 08:43:34 -05003172 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 */
Al Viro02125a82011-12-05 08:43:34 -05003174char *__d_path(const struct path *path,
3175 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003176 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003177{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003178 char *res = buf + buflen;
3179 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003181 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003182 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003183
Al Viro02125a82011-12-05 08:43:34 -05003184 if (error < 0)
3185 return ERR_PTR(error);
3186 if (error > 0)
3187 return NULL;
3188 return res;
3189}
3190
3191char *d_absolute_path(const struct path *path,
3192 char *buf, int buflen)
3193{
3194 struct path root = {};
3195 char *res = buf + buflen;
3196 int error;
3197
3198 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003199 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003200
3201 if (error > 1)
3202 error = -EINVAL;
3203 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003204 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003205 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206}
3207
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003208/*
3209 * same as __d_path but appends "(deleted)" for unlinked files.
3210 */
Al Viro02125a82011-12-05 08:43:34 -05003211static int path_with_deleted(const struct path *path,
3212 const struct path *root,
3213 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003214{
3215 prepend(buf, buflen, "\0", 1);
3216 if (d_unlinked(path->dentry)) {
3217 int error = prepend(buf, buflen, " (deleted)", 10);
3218 if (error)
3219 return error;
3220 }
3221
3222 return prepend_path(path, root, buf, buflen);
3223}
3224
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003225static int prepend_unreachable(char **buffer, int *buflen)
3226{
3227 return prepend(buffer, buflen, "(unreachable)", 13);
3228}
3229
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003230static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3231{
3232 unsigned seq;
3233
3234 do {
3235 seq = read_seqcount_begin(&fs->seq);
3236 *root = fs->root;
3237 } while (read_seqcount_retry(&fs->seq, seq));
3238}
3239
Jan Bluncka03a8a702008-02-14 19:38:32 -08003240/**
3241 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003242 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003243 * @buf: buffer to return value in
3244 * @buflen: buffer length
3245 *
3246 * Convert a dentry into an ASCII path name. If the entry has been deleted
3247 * the string " (deleted)" is appended. Note that this is ambiguous.
3248 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003249 * Returns a pointer into the buffer or an error code if the path was
3250 * too long. Note: Callers should use the returned pointer, not the passed
3251 * in buffer, to use the name! The implementation often starts at an offset
3252 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003253 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003254 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003255 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003256char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003258 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003259 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003260 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003262 /*
3263 * We have various synthetic filesystems that never get mounted. On
3264 * these filesystems dentries are never used for lookup purposes, and
3265 * thus don't need to be hashed. They also don't need a name until a
3266 * user wants to identify the object in /proc/pid/fd/. The little hack
3267 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003268 *
3269 * Some pseudo inodes are mountable. When they are mounted
3270 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3271 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003272 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003273 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3274 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003275 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003276
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003277 rcu_read_lock();
3278 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003279 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003280 rcu_read_unlock();
3281
Al Viro02125a82011-12-05 08:43:34 -05003282 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003283 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284 return res;
3285}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003286EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287
3288/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003289 * Helper function for dentry_operations.d_dname() members
3290 */
3291char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3292 const char *fmt, ...)
3293{
3294 va_list args;
3295 char temp[64];
3296 int sz;
3297
3298 va_start(args, fmt);
3299 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3300 va_end(args);
3301
3302 if (sz > sizeof(temp) || sz > buflen)
3303 return ERR_PTR(-ENAMETOOLONG);
3304
3305 buffer += buflen - sz;
3306 return memcpy(buffer, temp, sz);
3307}
3308
Al Viro118b2302013-08-24 12:08:17 -04003309char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3310{
3311 char *end = buffer + buflen;
3312 /* these dentries are never renamed, so d_lock is not needed */
3313 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003314 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003315 prepend(&end, &buflen, "/", 1))
3316 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003317 return end;
Al Viro118b2302013-08-24 12:08:17 -04003318}
David Herrmann31bbe162014-01-03 14:09:47 +01003319EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003320
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003321/*
Ram Pai6092d042008-03-27 13:06:20 +01003322 * Write full pathname from the root of the filesystem into the buffer.
3323 */
Al Virof6500802014-01-26 12:37:55 -05003324static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003325{
Al Virof6500802014-01-26 12:37:55 -05003326 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003327 char *end, *retval;
3328 int len, seq = 0;
3329 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003330
Al Virof6500802014-01-26 12:37:55 -05003331 if (buflen < 2)
3332 goto Elong;
3333
Al Viro48f5ec22013-09-09 15:22:25 -04003334 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003335restart:
Al Virof6500802014-01-26 12:37:55 -05003336 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003337 end = buf + buflen;
3338 len = buflen;
3339 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003340 /* Get '/' right */
3341 retval = end-1;
3342 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003343 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003344 while (!IS_ROOT(dentry)) {
3345 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003346
Ram Pai6092d042008-03-27 13:06:20 +01003347 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003348 error = prepend_name(&end, &len, &dentry->d_name);
3349 if (error)
3350 break;
Ram Pai6092d042008-03-27 13:06:20 +01003351
3352 retval = end;
3353 dentry = parent;
3354 }
Al Viro48f5ec22013-09-09 15:22:25 -04003355 if (!(seq & 1))
3356 rcu_read_unlock();
3357 if (need_seqretry(&rename_lock, seq)) {
3358 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003359 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003360 }
3361 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003362 if (error)
3363 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003364 return retval;
3365Elong:
3366 return ERR_PTR(-ENAMETOOLONG);
3367}
Nick Pigginec2447c2011-01-07 17:49:29 +11003368
3369char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3370{
Waiman Long232d2d62013-09-09 12:18:13 -04003371 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003372}
3373EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003374
3375char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3376{
3377 char *p = NULL;
3378 char *retval;
3379
Al Viroc1031352010-06-06 22:31:14 -04003380 if (d_unlinked(dentry)) {
3381 p = buf + buflen;
3382 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3383 goto Elong;
3384 buflen++;
3385 }
3386 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003387 if (!IS_ERR(retval) && p)
3388 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003389 return retval;
3390Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003391 return ERR_PTR(-ENAMETOOLONG);
3392}
3393
Linus Torvalds8b19e342013-09-12 10:35:47 -07003394static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3395 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003396{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003397 unsigned seq;
3398
3399 do {
3400 seq = read_seqcount_begin(&fs->seq);
3401 *root = fs->root;
3402 *pwd = fs->pwd;
3403 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003404}
3405
Ram Pai6092d042008-03-27 13:06:20 +01003406/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407 * NOTE! The user-level library version returns a
3408 * character pointer. The kernel system call just
3409 * returns the length of the buffer filled (which
3410 * includes the ending '\0' character), or a negative
3411 * error value. So libc would do something like
3412 *
3413 * char *getcwd(char * buf, size_t size)
3414 * {
3415 * int retval;
3416 *
3417 * retval = sys_getcwd(buf, size);
3418 * if (retval >= 0)
3419 * return buf;
3420 * errno = -retval;
3421 * return NULL;
3422 * }
3423 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003424SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425{
Linus Torvalds552ce542007-02-13 12:08:18 -08003426 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003427 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003428 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429
3430 if (!page)
3431 return -ENOMEM;
3432
Linus Torvalds8b19e342013-09-12 10:35:47 -07003433 rcu_read_lock();
3434 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435
Linus Torvalds552ce542007-02-13 12:08:18 -08003436 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003437 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003438 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003439 char *cwd = page + PATH_MAX;
3440 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003442 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003443 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003444 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003445
Al Viro02125a82011-12-05 08:43:34 -05003446 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003447 goto out;
3448
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003449 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003450 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003451 error = prepend_unreachable(&cwd, &buflen);
3452 if (error)
3453 goto out;
3454 }
3455
Linus Torvalds552ce542007-02-13 12:08:18 -08003456 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003457 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003458 if (len <= size) {
3459 error = len;
3460 if (copy_to_user(buf, cwd, len))
3461 error = -EFAULT;
3462 }
Nick Piggin949854d2011-01-07 17:49:37 +11003463 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003464 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003465 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
3467out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003468 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469 return error;
3470}
3471
3472/*
3473 * Test whether new_dentry is a subdirectory of old_dentry.
3474 *
3475 * Trivially implemented using the dcache structure
3476 */
3477
3478/**
3479 * is_subdir - is new dentry a subdirectory of old_dentry
3480 * @new_dentry: new dentry
3481 * @old_dentry: old dentry
3482 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003483 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3484 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3486 */
3487
Yaowei Baia6e57872015-11-17 14:40:11 +08003488bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489{
Yaowei Baia6e57872015-11-17 14:40:11 +08003490 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003491 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003493 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003494 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003495
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003496 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003499 /*
3500 * Need rcu_readlock to protect against the d_parent trashing
3501 * due to d_move
3502 */
3503 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003504 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003505 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003506 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003507 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003508 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510
3511 return result;
3512}
3513
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003514static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003516 struct dentry *root = data;
3517 if (dentry != root) {
3518 if (d_unhashed(dentry) || !dentry->d_inode)
3519 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003521 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3522 dentry->d_flags |= DCACHE_GENOCIDE;
3523 dentry->d_lockref.count--;
3524 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003526 return D_WALK_CONTINUE;
3527}
Nick Piggin58db63d2011-01-07 17:49:39 +11003528
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003529void d_genocide(struct dentry *parent)
3530{
3531 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532}
3533
Al Viro60545d02013-06-07 01:20:27 -04003534void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535{
Al Viro60545d02013-06-07 01:20:27 -04003536 inode_dec_link_count(inode);
3537 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003538 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003539 !d_unlinked(dentry));
3540 spin_lock(&dentry->d_parent->d_lock);
3541 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3542 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3543 (unsigned long long)inode->i_ino);
3544 spin_unlock(&dentry->d_lock);
3545 spin_unlock(&dentry->d_parent->d_lock);
3546 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547}
Al Viro60545d02013-06-07 01:20:27 -04003548EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549
3550static __initdata unsigned long dhash_entries;
3551static int __init set_dhash_entries(char *str)
3552{
3553 if (!str)
3554 return 0;
3555 dhash_entries = simple_strtoul(str, &str, 0);
3556 return 1;
3557}
3558__setup("dhash_entries=", set_dhash_entries);
3559
3560static void __init dcache_init_early(void)
3561{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003562 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563
3564 /* If hashes are distributed across NUMA nodes, defer
3565 * hash allocation until vmalloc space is available.
3566 */
3567 if (hashdist)
3568 return;
3569
3570 dentry_hashtable =
3571 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003572 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 dhash_entries,
3574 13,
3575 HASH_EARLY,
3576 &d_hash_shift,
3577 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003578 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003579 0);
3580
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003581 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003582 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583}
3584
Denis Cheng74bf17c2007-10-16 23:26:30 -07003585static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003587 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588
3589 /*
3590 * A constructor could be added for stable state like the lists,
3591 * but it is probably not worth it because of the cache nature
3592 * of the dcache.
3593 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003594 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003595 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003596
3597 /* Hash may have been set up in dcache_init_early */
3598 if (!hashdist)
3599 return;
3600
3601 dentry_hashtable =
3602 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003603 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604 dhash_entries,
3605 13,
3606 0,
3607 &d_hash_shift,
3608 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003609 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610 0);
3611
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003612 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003613 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614}
3615
3616/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003617struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003618EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619
Linus Torvalds1da177e2005-04-16 15:20:36 -07003620EXPORT_SYMBOL(d_genocide);
3621
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622void __init vfs_caches_init_early(void)
3623{
3624 dcache_init_early();
3625 inode_init_early();
3626}
3627
Mel Gorman4248b0d2015-08-06 15:46:20 -07003628void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003629{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003631 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632
Denis Cheng74bf17c2007-10-16 23:26:30 -07003633 dcache_init();
3634 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003635 files_init();
3636 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003637 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638 bdev_cache_init();
3639 chrdev_init();
3640}