blob: f2f116d7e4a09b83b69e868ad2313f7d37d0150a [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>
Eric Biggers7bc138e2019-03-20 11:39:11 -070021#include <linux/fscrypt.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040022#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/slab.h>
24#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/hash.h>
26#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/mount.h>
29#include <linux/file.h>
30#include <asm/uaccess.h>
31#include <linux/security.h>
32#include <linux/seqlock.h>
33#include <linux/swap.h>
34#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040035#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020036#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110037#include <linux/bit_spinlock.h>
38#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070039#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010040#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100041#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080042#include <linux/kasan.h>
43
David Howells07f3f052006-09-30 20:52:18 +020044#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050045#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Nick Piggin789680d2011-01-07 17:49:30 +110047/*
48 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110049 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040050 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110051 * dcache_hash_bucket lock protects:
52 * - the dcache hash table
53 * s_anon bl list spinlock protects:
54 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100055 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110056 * - the dcache lru lists and counters
57 * d_lock protects:
58 * - d_flags
59 * - d_name
60 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110061 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110062 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110063 * - d_parent and d_subdirs
64 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040065 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110066 *
67 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110068 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110069 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100070 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110071 * dcache_hash_bucket lock
72 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110073 *
Nick Pigginda502952011-01-07 17:49:33 +110074 * If there is an ancestor relationship:
75 * dentry->d_parent->...->d_parent->d_lock
76 * ...
77 * dentry->d_parent->d_lock
78 * dentry->d_lock
79 *
80 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110081 * if (dentry1 < dentry2)
82 * dentry1->d_lock
83 * dentry2->d_lock
84 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080085int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
87
Al Viro74c3cbe2007-07-22 08:04:18 -040088__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Nick Piggin949854d2011-01-07 17:49:37 +110090EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Christoph Lametere18b8902006-12-06 20:33:20 -080092static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*
95 * This is the single most critical data structure when it comes
96 * to the dcache: the hashtable for lookups. Somebody should try
97 * to make this good - I've just made it work.
98 *
99 * This hash-function tries to avoid losing too many bits of hash
100 * information, yet avoid using a prime hash-size or similar.
101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800103static unsigned int d_hash_mask __read_mostly;
104static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100105
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700106static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107
Linus Torvalds8387ff22016-06-10 07:51:30 -0700108static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
George Spelvin703b5fa2016-06-10 00:22:12 -0400110 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111}
112
Al Viro94bdd652016-04-15 02:42:04 -0400113#define IN_LOOKUP_SHIFT 10
114static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
115
116static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
117 unsigned int hash)
118{
119 hash += (unsigned long) parent / L1_CACHE_BYTES;
120 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
121}
122
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124/* Statistics gathering. */
125struct dentry_stat_t dentry_stat = {
126 .age_limit = 45,
127};
128
Glauber Costa3942c072013-08-28 10:17:53 +1000129static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000130static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400131
132#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000133
134/*
135 * Here we resort to our own counters instead of using generic per-cpu counters
136 * for consistency with what the vfs inode code does. We are expected to harvest
137 * better code and performance by having our own specialized counters.
138 *
139 * Please note that the loop is done over all possible CPUs, not over all online
140 * CPUs. The reason for this is that we don't want to play games with CPUs going
141 * on and off. If one of them goes off, we will just keep their counters.
142 *
143 * glommer: See cffbc8a for details, and if you ever intend to change this,
144 * please update all vfs counters to match.
145 */
Glauber Costa3942c072013-08-28 10:17:53 +1000146static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100147{
148 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000149 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100150 for_each_possible_cpu(i)
151 sum += per_cpu(nr_dentry, i);
152 return sum < 0 ? 0 : sum;
153}
154
Dave Chinner62d36c72013-08-28 10:17:54 +1000155static long get_nr_dentry_unused(void)
156{
157 int i;
158 long sum = 0;
159 for_each_possible_cpu(i)
160 sum += per_cpu(nr_dentry_unused, i);
161 return sum < 0 ? 0 : sum;
162}
163
Joe Perches1f7e0612014-06-06 14:38:05 -0700164int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400165 size_t *lenp, loff_t *ppos)
166{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100167 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000168 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000169 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400170}
171#endif
172
Linus Torvalds5483f182012-03-04 15:51:42 -0800173/*
174 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
175 * The strings are both count bytes long, and count is non-zero.
176 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700177#ifdef CONFIG_DCACHE_WORD_ACCESS
178
179#include <asm/word-at-a-time.h>
180/*
181 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
182 * aligned allocation for this particular component. We don't
183 * strictly need the load_unaligned_zeropad() safety, but it
184 * doesn't hurt either.
185 *
186 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
187 * need the careful unaligned handling.
188 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700189static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800190{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800192
193 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700194 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700195 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 if (tcount < sizeof(unsigned long))
197 break;
198 if (unlikely(a != b))
199 return 1;
200 cs += sizeof(unsigned long);
201 ct += sizeof(unsigned long);
202 tcount -= sizeof(unsigned long);
203 if (!tcount)
204 return 0;
205 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000206 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800207 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700208}
209
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800210#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700211
Linus Torvalds94753db52012-05-10 12:19:19 -0700212static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213{
Linus Torvalds5483f182012-03-04 15:51:42 -0800214 do {
215 if (*cs != *ct)
216 return 1;
217 cs++;
218 ct++;
219 tcount--;
220 } while (tcount);
221 return 0;
222}
223
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700224#endif
225
Linus Torvalds94753db52012-05-10 12:19:19 -0700226static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
227{
Linus Torvalds94753db52012-05-10 12:19:19 -0700228 /*
229 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000230 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700231 *
232 * NOTE! Even if a rename will mean that the length
233 * was not loaded atomically, we don't care. The
234 * RCU walk will check the sequence count eventually,
235 * and catch it. And we won't overrun the buffer,
236 * because we're reading the name pointer atomically,
237 * and a dentry name is guaranteed to be properly
238 * terminated with a NUL byte.
239 *
240 * End result: even if 'len' is wrong, we'll exit
241 * early because the data cannot match (there can
242 * be no NUL in the ct/tcount data)
243 */
He Kuangae0a8432016-03-26 09:12:10 +0000244 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
245
Linus Torvalds6326c712012-05-21 16:14:04 -0700246 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700247}
248
Al Viro8d85b482014-09-29 14:54:27 -0400249struct external_name {
250 union {
251 atomic_t count;
252 struct rcu_head head;
253 } u;
254 unsigned char name[];
255};
256
257static inline struct external_name *external_name(struct dentry *dentry)
258{
259 return container_of(dentry->d_name.name, struct external_name, name[0]);
260}
261
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400262static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400264 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
265
Al Viro8d85b482014-09-29 14:54:27 -0400266 kmem_cache_free(dentry_cache, dentry);
267}
268
269static void __d_free_external(struct rcu_head *head)
270{
271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400272 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 kmem_cache_free(dentry_cache, dentry);
274}
275
Al Viro810bb172014-10-12 12:45:37 -0400276static inline int dname_external(const struct dentry *dentry)
277{
278 return dentry->d_name.name != dentry->d_iname;
279}
280
David Howells4bf46a22015-03-05 14:09:22 +0000281static inline void __d_set_inode_and_type(struct dentry *dentry,
282 struct inode *inode,
283 unsigned type_flags)
284{
285 unsigned flags;
286
287 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000288 flags = READ_ONCE(dentry->d_flags);
289 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
290 flags |= type_flags;
291 WRITE_ONCE(dentry->d_flags, flags);
292}
293
David Howells4bf46a22015-03-05 14:09:22 +0000294static inline void __d_clear_type_and_inode(struct dentry *dentry)
295{
296 unsigned flags = READ_ONCE(dentry->d_flags);
297
298 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
299 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000300 dentry->d_inode = NULL;
301}
302
Al Virob4f03542014-04-29 23:40:14 -0400303static void dentry_free(struct dentry *dentry)
304{
Al Viro946e51f2014-10-26 19:19:16 -0400305 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400306 if (unlikely(dname_external(dentry))) {
307 struct external_name *p = external_name(dentry);
308 if (likely(atomic_dec_and_test(&p->u.count))) {
309 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
310 return;
311 }
312 }
Al Virob4f03542014-04-29 23:40:14 -0400313 /* if dentry was never visible to RCU, immediate free is OK */
314 if (!(dentry->d_flags & DCACHE_RCUACCESS))
315 __d_free(&dentry->d_u.d_rcu);
316 else
317 call_rcu(&dentry->d_u.d_rcu, __d_free);
318}
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/*
321 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400322 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100323 */
324static void dentry_unlink_inode(struct dentry * dentry)
325 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100326 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100327{
328 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400329 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500330
Al Viro550dce02016-05-29 20:13:30 -0400331 if (hashed)
332 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000333 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400334 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400335 if (hashed)
336 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100337 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100338 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100339 if (!inode->i_nlink)
340 fsnotify_inoderemove(inode);
341 if (dentry->d_op && dentry->d_op->d_iput)
342 dentry->d_op->d_iput(dentry, inode);
343 else
344 iput(inode);
345}
346
347/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400348 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
349 * is in use - which includes both the "real" per-superblock
350 * LRU list _and_ the DCACHE_SHRINK_LIST use.
351 *
352 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
353 * on the shrink list (ie not on the superblock LRU list).
354 *
355 * The per-cpu "nr_dentry_unused" counters are updated with
356 * the DCACHE_LRU_LIST bit.
357 *
358 * These helper functions make sure we always follow the
359 * rules. d_lock must be held by the caller.
360 */
361#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
362static void d_lru_add(struct dentry *dentry)
363{
364 D_FLAG_VERIFY(dentry, 0);
365 dentry->d_flags |= DCACHE_LRU_LIST;
366 this_cpu_inc(nr_dentry_unused);
367 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
368}
369
370static void d_lru_del(struct dentry *dentry)
371{
372 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
373 dentry->d_flags &= ~DCACHE_LRU_LIST;
374 this_cpu_dec(nr_dentry_unused);
375 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
376}
377
378static void d_shrink_del(struct dentry *dentry)
379{
380 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
381 list_del_init(&dentry->d_lru);
382 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
383 this_cpu_dec(nr_dentry_unused);
384}
385
386static void d_shrink_add(struct dentry *dentry, struct list_head *list)
387{
388 D_FLAG_VERIFY(dentry, 0);
389 list_add(&dentry->d_lru, list);
390 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
391 this_cpu_inc(nr_dentry_unused);
392}
393
394/*
395 * These can only be called under the global LRU lock, ie during the
396 * callback for freeing the LRU list. "isolate" removes it from the
397 * LRU lists entirely, while shrink_move moves it to the indicated
398 * private list.
399 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800400static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400401{
402 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
403 dentry->d_flags &= ~DCACHE_LRU_LIST;
404 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800405 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400406}
407
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800408static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
409 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400410{
411 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
412 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800413 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400414}
415
416/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000417 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700418 */
419static void dentry_lru_add(struct dentry *dentry)
420{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400421 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
422 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700423}
424
Miklos Szeredid52b9082007-05-08 00:23:46 -0700425/**
Nick Piggin789680d2011-01-07 17:49:30 +1100426 * d_drop - drop a dentry
427 * @dentry: dentry to drop
428 *
429 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
430 * be found through a VFS lookup any more. Note that this is different from
431 * deleting the dentry - d_delete will try to mark the dentry negative if
432 * possible, giving a successful _negative_ lookup, while d_drop will
433 * just make the cache lookup fail.
434 *
435 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
436 * reason (NFS timeouts or autofs deletes).
437 *
438 * __d_drop requires dentry->d_lock.
439 */
440void __d_drop(struct dentry *dentry)
441{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700442 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400443 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400444 /*
445 * Hashed dentries are normally on the dentry hashtable,
446 * with the exception of those newly allocated by
447 * d_obtain_alias, which are always IS_ROOT:
448 */
449 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400450 b = &dentry->d_sb->s_anon;
451 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700452 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400453
454 hlist_bl_lock(b);
455 __hlist_bl_del(&dentry->d_hash);
456 dentry->d_hash.pprev = NULL;
457 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400458 /* After this call, in-progress rcu-walk path lookup will fail. */
459 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100460 }
461}
462EXPORT_SYMBOL(__d_drop);
463
464void d_drop(struct dentry *dentry)
465{
Nick Piggin789680d2011-01-07 17:49:30 +1100466 spin_lock(&dentry->d_lock);
467 __d_drop(dentry);
468 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100469}
470EXPORT_SYMBOL(d_drop);
471
Al Viroba65dc52016-06-10 11:32:47 -0400472static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
473{
474 struct dentry *next;
475 /*
476 * Inform d_walk() and shrink_dentry_list() that we are no longer
477 * attached to the dentry tree
478 */
479 dentry->d_flags |= DCACHE_DENTRY_KILLED;
480 if (unlikely(list_empty(&dentry->d_child)))
481 return;
482 __list_del_entry(&dentry->d_child);
483 /*
484 * Cursors can move around the list of children. While we'd been
485 * a normal list member, it didn't matter - ->d_child.next would've
486 * been updated. However, from now on it won't be and for the
487 * things like d_walk() it might end up with a nasty surprise.
488 * Normally d_walk() doesn't care about cursors moving around -
489 * ->d_lock on parent prevents that and since a cursor has no children
490 * of its own, we get through it without ever unlocking the parent.
491 * There is one exception, though - if we ascend from a child that
492 * gets killed as soon as we unlock it, the next sibling is found
493 * using the value left in its ->d_child.next. And if _that_
494 * pointed to a cursor, and cursor got moved (e.g. by lseek())
495 * before d_walk() regains parent->d_lock, we'll end up skipping
496 * everything the cursor had been moved past.
497 *
498 * Solution: make sure that the pointer left behind in ->d_child.next
499 * points to something that won't be moving around. I.e. skip the
500 * cursors.
501 */
502 while (dentry->d_child.next != &parent->d_subdirs) {
503 next = list_entry(dentry->d_child.next, struct dentry, d_child);
504 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
505 break;
506 dentry->d_child.next = next->d_child.next;
507 }
508}
509
Al Viroe55fd012014-05-28 13:51:12 -0400510static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100511{
Al Viro41edf272014-05-01 10:30:00 -0400512 struct dentry *parent = NULL;
513 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400514 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100515 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100516
Linus Torvalds0d984392013-09-08 13:46:52 -0700517 /*
518 * The dentry is now unrecoverably dead to the world.
519 */
520 lockref_mark_dead(&dentry->d_lockref);
521
Sage Weilf0023bc2011-10-28 10:02:42 -0700522 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700523 * inform the fs via d_prune that this dentry is about to be
524 * unhashed and destroyed.
525 */
Al Viro29266202014-05-30 11:39:02 -0400526 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800527 dentry->d_op->d_prune(dentry);
528
Al Viro01b60352014-04-29 23:42:52 -0400529 if (dentry->d_flags & DCACHE_LRU_LIST) {
530 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
531 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400532 }
Nick Piggin77812a12011-01-07 17:49:48 +1100533 /* if it was on the hash then remove it */
534 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400535 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400536 if (parent)
537 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400538 if (dentry->d_inode)
539 dentry_unlink_inode(dentry);
540 else
541 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400542 this_cpu_dec(nr_dentry);
543 if (dentry->d_op && dentry->d_op->d_release)
544 dentry->d_op->d_release(dentry);
545
Al Viro41edf272014-05-01 10:30:00 -0400546 spin_lock(&dentry->d_lock);
547 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
548 dentry->d_flags |= DCACHE_MAY_FREE;
549 can_free = false;
550 }
551 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400552 if (likely(can_free))
553 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400554}
555
556/*
557 * Finish off a dentry we've decided to kill.
558 * dentry->d_lock must be held, returns with it unlocked.
559 * If ref is non-zero, then decrement the refcount too.
560 * Returns dentry requiring refcount drop, or NULL if we're done.
561 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400562static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400563 __releases(dentry->d_lock)
564{
565 struct inode *inode = dentry->d_inode;
566 struct dentry *parent = NULL;
567
568 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
569 goto failed;
570
571 if (!IS_ROOT(dentry)) {
572 parent = dentry->d_parent;
573 if (unlikely(!spin_trylock(&parent->d_lock))) {
574 if (inode)
575 spin_unlock(&inode->i_lock);
576 goto failed;
577 }
578 }
579
580 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400581 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400582
583failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400584 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400585 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100586}
587
Al Viro046b9612014-05-29 08:54:52 -0400588static inline struct dentry *lock_parent(struct dentry *dentry)
589{
590 struct dentry *parent = dentry->d_parent;
591 if (IS_ROOT(dentry))
592 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800593 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400594 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400595 if (likely(spin_trylock(&parent->d_lock)))
596 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400597 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400598 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400599again:
600 parent = ACCESS_ONCE(dentry->d_parent);
601 spin_lock(&parent->d_lock);
602 /*
603 * We can't blindly lock dentry until we are sure
604 * that we won't violate the locking order.
605 * Any changes of dentry->d_parent must have
606 * been done with parent->d_lock held, so
607 * spin_lock() above is enough of a barrier
608 * for checking if it's still our child.
609 */
610 if (unlikely(parent != dentry->d_parent)) {
611 spin_unlock(&parent->d_lock);
612 goto again;
613 }
614 rcu_read_unlock();
615 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700616 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400617 else
618 parent = NULL;
619 return parent;
620}
621
Linus Torvalds360f5472015-01-09 15:19:03 -0800622/*
623 * Try to do a lockless dput(), and return whether that was successful.
624 *
625 * If unsuccessful, we return false, having already taken the dentry lock.
626 *
627 * The caller needs to hold the RCU read lock, so that the dentry is
628 * guaranteed to stay around even if the refcount goes down to zero!
629 */
630static inline bool fast_dput(struct dentry *dentry)
631{
632 int ret;
633 unsigned int d_flags;
634
635 /*
636 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100637 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800638 */
639 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
640 return lockref_put_or_lock(&dentry->d_lockref);
641
642 /*
643 * .. otherwise, we can try to just decrement the
644 * lockref optimistically.
645 */
646 ret = lockref_put_return(&dentry->d_lockref);
647
648 /*
649 * If the lockref_put_return() failed due to the lock being held
650 * by somebody else, the fast path has failed. We will need to
651 * get the lock, and then check the count again.
652 */
653 if (unlikely(ret < 0)) {
654 spin_lock(&dentry->d_lock);
655 if (dentry->d_lockref.count > 1) {
656 dentry->d_lockref.count--;
657 spin_unlock(&dentry->d_lock);
658 return 1;
659 }
660 return 0;
661 }
662
663 /*
664 * If we weren't the last ref, we're done.
665 */
666 if (ret)
667 return 1;
668
669 /*
670 * Careful, careful. The reference count went down
671 * to zero, but we don't hold the dentry lock, so
672 * somebody else could get it again, and do another
673 * dput(), and we need to not race with that.
674 *
675 * However, there is a very special and common case
676 * where we don't care, because there is nothing to
677 * do: the dentry is still hashed, it does not have
678 * a 'delete' op, and it's referenced and already on
679 * the LRU list.
680 *
681 * NOTE! Since we aren't locked, these values are
682 * not "stable". However, it is sufficient that at
683 * some point after we dropped the reference the
684 * dentry was hashed and the flags had the proper
685 * value. Other dentry users may have re-gotten
686 * a reference to the dentry and change that, but
687 * our work is done - we can leave the dentry
688 * around with a zero refcount.
689 */
690 smp_rmb();
691 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100692 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800693
694 /* Nothing to do? Dropping the reference was all we needed? */
695 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
696 return 1;
697
698 /*
699 * Not the fast normal case? Get the lock. We've already decremented
700 * the refcount, but we'll need to re-check the situation after
701 * getting the lock.
702 */
703 spin_lock(&dentry->d_lock);
704
705 /*
706 * Did somebody else grab a reference to it in the meantime, and
707 * we're no longer the last user after all? Alternatively, somebody
708 * else could have killed it and marked it dead. Either way, we
709 * don't need to do anything else.
710 */
711 if (dentry->d_lockref.count) {
712 spin_unlock(&dentry->d_lock);
713 return 1;
714 }
715
716 /*
717 * Re-get the reference we optimistically dropped. We hold the
718 * lock, and we just tested that it was zero, so we can just
719 * set it to 1.
720 */
721 dentry->d_lockref.count = 1;
722 return 0;
723}
724
725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726/*
727 * This is dput
728 *
729 * This is complicated by the fact that we do not want to put
730 * dentries that are no longer on any hash chain on the unused
731 * list: we'd much rather just get rid of them immediately.
732 *
733 * However, that implies that we have to traverse the dentry
734 * tree upwards to the parents which might _also_ now be
735 * scheduled for deletion (it may have been only waiting for
736 * its last child to go away).
737 *
738 * This tail recursion is done by hand as we don't want to depend
739 * on the compiler to always get this right (gcc generally doesn't).
740 * Real recursion would eat up our stack space.
741 */
742
743/*
744 * dput - release a dentry
745 * @dentry: dentry to release
746 *
747 * Release a dentry. This will drop the usage count and if appropriate
748 * call the dentry unlink method as well as removing it from the queues and
749 * releasing its resources. If the parent dentries were scheduled for release
750 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752void dput(struct dentry *dentry)
753{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700754 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 return;
756
757repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800758 might_sleep();
759
Linus Torvalds360f5472015-01-09 15:19:03 -0800760 rcu_read_lock();
761 if (likely(fast_dput(dentry))) {
762 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800764 }
765
766 /* Slow case: now with the dentry lock held */
767 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Al Viro85c7f812016-04-14 19:52:13 -0400769 WARN_ON(d_in_lookup(dentry));
770
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700771 /* Unreachable? Get rid of it */
772 if (unlikely(d_unhashed(dentry)))
773 goto kill_it;
774
Al Viro75a6f822015-07-08 02:42:38 +0100775 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
776 goto kill_it;
777
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700778 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100780 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 }
Nick Piggin265ac902010-10-10 05:36:24 -0400782
Linus Torvalds358eec12013-10-31 15:43:02 -0700783 if (!(dentry->d_flags & DCACHE_REFERENCED))
784 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400785 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400786
Waiman Long98474232013-08-28 18:24:59 -0700787 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100788 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 return;
790
Miklos Szeredid52b9082007-05-08 00:23:46 -0700791kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400792 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800793 if (dentry) {
794 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700795 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800796 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700798EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100801/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100802static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
Waiman Long98474232013-08-28 18:24:59 -0700804 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805}
806
Nick Piggindc0474b2011-01-07 17:49:43 +1100807static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100808{
Waiman Long98474232013-08-28 18:24:59 -0700809 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100810}
811
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100812struct dentry *dget_parent(struct dentry *dentry)
813{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700814 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100815 struct dentry *ret;
816
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700817 /*
818 * Do optimistic parent lookup without any
819 * locking.
820 */
821 rcu_read_lock();
822 ret = ACCESS_ONCE(dentry->d_parent);
823 gotref = lockref_get_not_zero(&ret->d_lockref);
824 rcu_read_unlock();
825 if (likely(gotref)) {
826 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
827 return ret;
828 dput(ret);
829 }
830
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100831repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100832 /*
833 * Don't need rcu_dereference because we re-check it was correct under
834 * the lock.
835 */
836 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100837 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100838 spin_lock(&ret->d_lock);
839 if (unlikely(ret != dentry->d_parent)) {
840 spin_unlock(&ret->d_lock);
841 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100842 goto repeat;
843 }
Nick Piggina734eb42011-01-07 17:49:44 +1100844 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700845 BUG_ON(!ret->d_lockref.count);
846 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100847 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100848 return ret;
849}
850EXPORT_SYMBOL(dget_parent);
851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852/**
853 * d_find_alias - grab a hashed alias of inode
854 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 *
856 * If inode has a hashed alias, or is a directory and has any alias,
857 * acquire the reference to alias and return it. Otherwise return NULL.
858 * Notice that if inode is a directory there can be only one alias and
859 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800860 * of a filesystem, or if the directory was renamed and d_revalidate
861 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700863 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500864 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500866static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Nick Pigginda502952011-01-07 17:49:33 +1100868 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Nick Pigginda502952011-01-07 17:49:33 +1100870again:
871 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400872 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100873 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700875 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100876 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500878 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100879 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100880 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 return alias;
882 }
883 }
Nick Pigginda502952011-01-07 17:49:33 +1100884 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
Nick Pigginda502952011-01-07 17:49:33 +1100886 if (discon_alias) {
887 alias = discon_alias;
888 spin_lock(&alias->d_lock);
889 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500890 __dget_dlock(alias);
891 spin_unlock(&alias->d_lock);
892 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100893 }
894 spin_unlock(&alias->d_lock);
895 goto again;
896 }
897 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898}
899
Nick Pigginda502952011-01-07 17:49:33 +1100900struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901{
David Howells214fda12006-03-25 03:06:36 -0800902 struct dentry *de = NULL;
903
Al Virob3d9b7a2012-06-09 13:51:19 -0400904 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100905 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500906 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100907 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 return de;
910}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700911EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
913/*
914 * Try to kill dentries associated with this inode.
915 * WARNING: you must own a reference to inode.
916 */
917void d_prune_aliases(struct inode *inode)
918{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700919 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100921 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400922 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700924 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400925 struct dentry *parent = lock_parent(dentry);
926 if (likely(!dentry->d_lockref.count)) {
927 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800928 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400929 goto restart;
930 }
931 if (parent)
932 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 }
934 spin_unlock(&dentry->d_lock);
935 }
Nick Piggin873feea2011-01-07 17:50:06 +1100936 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700938EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400940static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941{
Al Viro5c47e6d2014-04-29 16:13:18 -0400942 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700943
Miklos Szeredi60942f22014-05-02 15:38:39 -0400944 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400945 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400946 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100947 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400948 parent = lock_parent(dentry);
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000951 * The dispose list is isolated and dentries are not accounted
952 * to the LRU here, so we can simply remove it from the list
953 * here regardless of whether it is referenced or not.
954 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400955 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000956
957 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000959 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800961 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700962 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400963 if (parent)
964 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 continue;
966 }
Nick Piggin77812a12011-01-07 17:49:48 +1100967
Al Viro64fd72e2014-05-28 09:48:44 -0400968
969 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
970 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
971 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400972 if (parent)
973 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400974 if (can_free)
975 dentry_free(dentry);
976 continue;
977 }
978
Al Viroff2fde92014-05-28 13:59:13 -0400979 inode = dentry->d_inode;
980 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400981 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000982 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400983 if (parent)
984 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400985 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000986 }
Al Viroff2fde92014-05-28 13:59:13 -0400987
Al Viroff2fde92014-05-28 13:59:13 -0400988 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400989
Al Viro5c47e6d2014-04-29 16:13:18 -0400990 /*
991 * We need to prune ancestors too. This is necessary to prevent
992 * quadratic behavior of shrink_dcache_parent(), but is also
993 * expected to be beneficial in reducing dentry cache
994 * fragmentation.
995 */
996 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400997 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
998 parent = lock_parent(dentry);
999 if (dentry->d_lockref.count != 1) {
1000 dentry->d_lockref.count--;
1001 spin_unlock(&dentry->d_lock);
1002 if (parent)
1003 spin_unlock(&parent->d_lock);
1004 break;
1005 }
1006 inode = dentry->d_inode; /* can't be NULL */
1007 if (unlikely(!spin_trylock(&inode->i_lock))) {
1008 spin_unlock(&dentry->d_lock);
1009 if (parent)
1010 spin_unlock(&parent->d_lock);
1011 cpu_relax();
1012 continue;
1013 }
1014 __dentry_kill(dentry);
1015 dentry = parent;
1016 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001018}
1019
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001020static enum lru_status dentry_lru_isolate(struct list_head *item,
1021 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001022{
1023 struct list_head *freeable = arg;
1024 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1025
1026
1027 /*
1028 * we are inverting the lru lock/dentry->d_lock here,
1029 * so use a trylock. If we fail to get the lock, just skip
1030 * it
1031 */
1032 if (!spin_trylock(&dentry->d_lock))
1033 return LRU_SKIP;
1034
1035 /*
1036 * Referenced dentries are still in use. If they have active
1037 * counts, just remove them from the LRU. Otherwise give them
1038 * another pass through the LRU.
1039 */
1040 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001041 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001042 spin_unlock(&dentry->d_lock);
1043 return LRU_REMOVED;
1044 }
1045
1046 if (dentry->d_flags & DCACHE_REFERENCED) {
1047 dentry->d_flags &= ~DCACHE_REFERENCED;
1048 spin_unlock(&dentry->d_lock);
1049
1050 /*
1051 * The list move itself will be made by the common LRU code. At
1052 * this point, we've dropped the dentry->d_lock but keep the
1053 * lru lock. This is safe to do, since every list movement is
1054 * protected by the lru lock even if both locks are held.
1055 *
1056 * This is guaranteed by the fact that all LRU management
1057 * functions are intermediated by the LRU API calls like
1058 * list_lru_add and list_lru_del. List movement in this file
1059 * only ever occur through this functions or through callbacks
1060 * like this one, that are called from the LRU API.
1061 *
1062 * The only exceptions to this are functions like
1063 * shrink_dentry_list, and code that first checks for the
1064 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1065 * operating only with stack provided lists after they are
1066 * properly isolated from the main list. It is thus, always a
1067 * local access.
1068 */
1069 return LRU_ROTATE;
1070 }
1071
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001072 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001073 spin_unlock(&dentry->d_lock);
1074
1075 return LRU_REMOVED;
1076}
1077
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001078/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001079 * prune_dcache_sb - shrink the dcache
1080 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001081 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001082 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001083 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1084 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001085 * function.
1086 *
1087 * This function may fail to free any resources if all the dentries are in
1088 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001089 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001090long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001091{
Dave Chinnerf6041562013-08-28 10:18:00 +10001092 LIST_HEAD(dispose);
1093 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001094
Vladimir Davydov503c3582015-02-12 14:58:47 -08001095 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1096 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001097 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001098 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099}
1100
Glauber Costa4e717f52013-08-28 10:18:03 +10001101static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001102 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001103{
Glauber Costa4e717f52013-08-28 10:18:03 +10001104 struct list_head *freeable = arg;
1105 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001106
Glauber Costa4e717f52013-08-28 10:18:03 +10001107 /*
1108 * we are inverting the lru lock/dentry->d_lock here,
1109 * so use a trylock. If we fail to get the lock, just skip
1110 * it
1111 */
1112 if (!spin_trylock(&dentry->d_lock))
1113 return LRU_SKIP;
1114
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001115 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001116 spin_unlock(&dentry->d_lock);
1117
1118 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001119}
1120
Glauber Costa4e717f52013-08-28 10:18:03 +10001121
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001122/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 * shrink_dcache_sb - shrink dcache for a superblock
1124 * @sb: superblock
1125 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001126 * Shrink the dcache for the specified super block. This is used to free
1127 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001129void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130{
Glauber Costa4e717f52013-08-28 10:18:03 +10001131 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001132
Glauber Costa4e717f52013-08-28 10:18:03 +10001133 do {
1134 LIST_HEAD(dispose);
1135
1136 freed = list_lru_walk(&sb->s_dentry_lru,
1137 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1138
1139 this_cpu_sub(nr_dentry_unused, freed);
1140 shrink_dentry_list(&dispose);
1141 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001143EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001146 * enum d_walk_ret - action to talke during tree walk
1147 * @D_WALK_CONTINUE: contrinue walk
1148 * @D_WALK_QUIT: quit walk
1149 * @D_WALK_NORETRY: quit when retry is needed
1150 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001152enum d_walk_ret {
1153 D_WALK_CONTINUE,
1154 D_WALK_QUIT,
1155 D_WALK_NORETRY,
1156 D_WALK_SKIP,
1157};
1158
1159/**
1160 * d_walk - walk the dentry tree
1161 * @parent: start of walk
1162 * @data: data passed to @enter() and @finish()
1163 * @enter: callback when first entering the dentry
1164 * @finish: callback when successfully finished the walk
1165 *
1166 * The @enter() and @finish() callbacks are called with d_lock held.
1167 */
1168static void d_walk(struct dentry *parent, void *data,
1169 enum d_walk_ret (*enter)(void *, struct dentry *),
1170 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171{
Nick Piggin949854d2011-01-07 17:49:37 +11001172 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001174 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001175 enum d_walk_ret ret;
1176 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001177
Nick Piggin58db63d2011-01-07 17:49:39 +11001178again:
Al Viro48f5ec22013-09-09 15:22:25 -04001179 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001180 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001181 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182
1183 ret = enter(data, this_parent);
1184 switch (ret) {
1185 case D_WALK_CONTINUE:
1186 break;
1187 case D_WALK_QUIT:
1188 case D_WALK_SKIP:
1189 goto out_unlock;
1190 case D_WALK_NORETRY:
1191 retry = false;
1192 break;
1193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194repeat:
1195 next = this_parent->d_subdirs.next;
1196resume:
1197 while (next != &this_parent->d_subdirs) {
1198 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001199 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001201
Al Viroba65dc52016-06-10 11:32:47 -04001202 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1203 continue;
1204
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001205 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001206
1207 ret = enter(data, dentry);
1208 switch (ret) {
1209 case D_WALK_CONTINUE:
1210 break;
1211 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001212 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001213 goto out_unlock;
1214 case D_WALK_NORETRY:
1215 retry = false;
1216 break;
1217 case D_WALK_SKIP:
1218 spin_unlock(&dentry->d_lock);
1219 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001220 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001223 spin_unlock(&this_parent->d_lock);
1224 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001226 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 goto repeat;
1228 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001229 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 }
1231 /*
1232 * All done at this level ... ascend and resume the search.
1233 */
Al Viroca5358e2014-10-26 19:31:10 -04001234 rcu_read_lock();
1235ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001237 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001238 this_parent = child->d_parent;
1239
Al Viro31dec132013-10-25 17:04:27 -04001240 spin_unlock(&child->d_lock);
1241 spin_lock(&this_parent->d_lock);
1242
Al Viroca5358e2014-10-26 19:31:10 -04001243 /* might go back up the wrong parent if we have had a rename. */
1244 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001245 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001246 /* go into the first sibling still alive */
1247 do {
1248 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001249 if (next == &this_parent->d_subdirs)
1250 goto ascend;
1251 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001252 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001253 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 goto resume;
1255 }
Al Viroca5358e2014-10-26 19:31:10 -04001256 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001257 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001258 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001259 if (finish)
1260 finish(data);
1261
1262out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001263 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001264 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001265 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001266
1267rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001268 spin_unlock(&this_parent->d_lock);
1269 rcu_read_unlock();
1270 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001271 if (!retry)
1272 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001273 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001274 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001276
1277/*
1278 * Search for at least 1 mount point in the dentry's subdirs.
1279 * We descend to the next level whenever the d_subdirs
1280 * list is non-empty and continue searching.
1281 */
1282
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001283static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1284{
1285 int *ret = data;
1286 if (d_mountpoint(dentry)) {
1287 *ret = 1;
1288 return D_WALK_QUIT;
1289 }
1290 return D_WALK_CONTINUE;
1291}
1292
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001293/**
1294 * have_submounts - check for mounts over a dentry
1295 * @parent: dentry to check.
1296 *
1297 * Return true if the parent or its subdirectories contain
1298 * a mount point
1299 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001300int have_submounts(struct dentry *parent)
1301{
1302 int ret = 0;
1303
1304 d_walk(parent, &ret, check_mount, NULL);
1305
1306 return ret;
1307}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001308EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001311 * Called by mount code to set a mountpoint and check if the mountpoint is
1312 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1313 * subtree can become unreachable).
1314 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001315 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001316 * this reason take rename_lock and d_lock on dentry and ancestors.
1317 */
1318int d_set_mounted(struct dentry *dentry)
1319{
1320 struct dentry *p;
1321 int ret = -ENOENT;
1322 write_seqlock(&rename_lock);
1323 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001324 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001325 spin_lock(&p->d_lock);
1326 if (unlikely(d_unhashed(p))) {
1327 spin_unlock(&p->d_lock);
1328 goto out;
1329 }
1330 spin_unlock(&p->d_lock);
1331 }
1332 spin_lock(&dentry->d_lock);
1333 if (!d_unlinked(dentry)) {
Eric W. Biederman1a62a0f2017-01-03 14:18:43 +13001334 ret = -EBUSY;
1335 if (!d_mountpoint(dentry)) {
1336 dentry->d_flags |= DCACHE_MOUNTED;
1337 ret = 0;
1338 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001339 }
1340 spin_unlock(&dentry->d_lock);
1341out:
1342 write_sequnlock(&rename_lock);
1343 return ret;
1344}
1345
1346/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001347 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 * and move any unused dentries to the end of the unused
1349 * list for prune_dcache(). We descend to the next level
1350 * whenever the d_subdirs list is non-empty and continue
1351 * searching.
1352 *
1353 * It returns zero iff there are no unused children,
1354 * otherwise it returns the number of children moved to
1355 * the end of the unused list. This may not be the total
1356 * number of unused children, because select_parent can
1357 * drop the lock and return early due to latency
1358 * constraints.
1359 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001360
1361struct select_data {
1362 struct dentry *start;
1363 struct list_head dispose;
1364 int found;
1365};
1366
1367static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001369 struct select_data *data = _data;
1370 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001372 if (data->start == dentry)
1373 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Al Virofe915222014-05-03 00:02:25 -04001375 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001376 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001377 } else {
1378 if (dentry->d_flags & DCACHE_LRU_LIST)
1379 d_lru_del(dentry);
1380 if (!dentry->d_lockref.count) {
1381 d_shrink_add(dentry, &data->dispose);
1382 data->found++;
1383 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 }
1385 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001386 * We can return to the caller if we have found some (this
1387 * ensures forward progress). We'll be coming back to find
1388 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 */
Al Virofe915222014-05-03 00:02:25 -04001390 if (!list_empty(&data->dispose))
1391 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001393 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394}
1395
1396/**
1397 * shrink_dcache_parent - prune dcache
1398 * @parent: parent of entries to prune
1399 *
1400 * Prune the dcache to remove unused children of the parent dentry.
1401 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001402void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001404 for (;;) {
1405 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001407 INIT_LIST_HEAD(&data.dispose);
1408 data.start = parent;
1409 data.found = 0;
1410
1411 d_walk(parent, &data, select_collect, NULL);
1412 if (!data.found)
1413 break;
1414
1415 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001416 cond_resched();
1417 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001419EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Al Viro9c8c10e2014-05-02 20:36:10 -04001421static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001422{
Al Viro9c8c10e2014-05-02 20:36:10 -04001423 /* it has busy descendents; complain about those instead */
1424 if (!list_empty(&dentry->d_subdirs))
1425 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001426
Al Viro9c8c10e2014-05-02 20:36:10 -04001427 /* root with refcount 1 is fine */
1428 if (dentry == _data && dentry->d_lockref.count == 1)
1429 return D_WALK_CONTINUE;
1430
1431 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1432 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001433 dentry,
1434 dentry->d_inode ?
1435 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001436 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001437 dentry->d_lockref.count,
1438 dentry->d_sb->s_type->name,
1439 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001440 WARN_ON(1);
1441 return D_WALK_CONTINUE;
1442}
1443
1444static void do_one_tree(struct dentry *dentry)
1445{
1446 shrink_dcache_parent(dentry);
1447 d_walk(dentry, dentry, umount_check, NULL);
1448 d_drop(dentry);
1449 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001450}
1451
1452/*
1453 * destroy the dentries attached to a superblock on unmounting
1454 */
1455void shrink_dcache_for_umount(struct super_block *sb)
1456{
1457 struct dentry *dentry;
1458
Al Viro9c8c10e2014-05-02 20:36:10 -04001459 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001460
1461 dentry = sb->s_root;
1462 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001463 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001464
1465 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001466 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1467 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001468 }
1469}
1470
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001471struct detach_data {
1472 struct select_data select;
1473 struct dentry *mountpoint;
1474};
1475static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001476{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001477 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001478
1479 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001480 __dget_dlock(dentry);
1481 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001482 return D_WALK_QUIT;
1483 }
1484
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001485 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001486}
1487
1488static void check_and_drop(void *_data)
1489{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001490 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001491
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001492 if (!data->mountpoint && !data->select.found)
1493 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001494}
1495
1496/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001497 * d_invalidate - detach submounts, prune dcache, and drop
1498 * @dentry: dentry to invalidate (aka detach, prune and drop)
1499 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001500 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001501 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001502 * The final d_drop is done as an atomic operation relative to
1503 * rename_lock ensuring there are no races with d_set_mounted. This
1504 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001505 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001506void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001507{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001508 /*
1509 * If it's already been dropped, return OK.
1510 */
1511 spin_lock(&dentry->d_lock);
1512 if (d_unhashed(dentry)) {
1513 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001514 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001515 }
1516 spin_unlock(&dentry->d_lock);
1517
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001518 /* Negative dentries can be dropped without further checks */
1519 if (!dentry->d_inode) {
1520 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001521 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001522 }
1523
1524 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001525 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001526
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001527 data.mountpoint = NULL;
1528 INIT_LIST_HEAD(&data.select.dispose);
1529 data.select.start = dentry;
1530 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001531
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001532 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001533
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 if (data.select.found)
1535 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001536
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001537 if (data.mountpoint) {
1538 detach_mounts(data.mountpoint);
1539 dput(data.mountpoint);
1540 }
1541
1542 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001543 break;
1544
1545 cond_resched();
1546 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001547}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001548EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550/**
Al Viroa4464db2011-07-07 15:03:58 -04001551 * __d_alloc - allocate a dcache entry
1552 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 * @name: qstr of the name
1554 *
1555 * Allocates a dentry. It returns %NULL if there is insufficient memory
1556 * available. On a success the dentry is returned. The name passed in is
1557 * copied and the copy passed in may be reused after this call.
1558 */
1559
Al Viroa4464db2011-07-07 15:03:58 -04001560struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561{
1562 struct dentry *dentry;
1563 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001564 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Mel Gormane12ba742007-10-16 01:25:52 -07001566 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 if (!dentry)
1568 return NULL;
1569
Linus Torvalds6326c712012-05-21 16:14:04 -07001570 /*
1571 * We guarantee that the inline name is always NUL-terminated.
1572 * This way the memcpy() done by the name switching in rename
1573 * will still always have a NUL at the end, even if we might
1574 * be overwriting an internal NUL character
1575 */
1576 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001577 if (unlikely(!name)) {
1578 static const struct qstr anon = QSTR_INIT("/", 1);
1579 name = &anon;
1580 dname = dentry->d_iname;
1581 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001582 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001583 struct external_name *p = kmalloc(size + name->len,
1584 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001585 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 kmem_cache_free(dentry_cache, dentry);
1587 return NULL;
1588 }
Al Viro8d85b482014-09-29 14:54:27 -04001589 atomic_set(&p->u.count, 1);
1590 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001591 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1592 kasan_unpoison_shadow(dname,
1593 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 } else {
1595 dname = dentry->d_iname;
1596 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
1598 dentry->d_name.len = name->len;
1599 dentry->d_name.hash = name->hash;
1600 memcpy(dname, name->name, name->len);
1601 dname[name->len] = 0;
1602
Linus Torvalds6326c712012-05-21 16:14:04 -07001603 /* Make sure we always see the terminating NUL character */
1604 smp_wmb();
1605 dentry->d_name.name = dname;
1606
Waiman Long98474232013-08-28 18:24:59 -07001607 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001608 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001610 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001612 dentry->d_parent = dentry;
1613 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 dentry->d_op = NULL;
1615 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001616 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 INIT_LIST_HEAD(&dentry->d_lru);
1618 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001619 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1620 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001621 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Miklos Szeredi285b1022016-06-28 11:47:32 +02001623 if (dentry->d_op && dentry->d_op->d_init) {
1624 err = dentry->d_op->d_init(dentry);
1625 if (err) {
1626 if (dname_external(dentry))
1627 kfree(external_name(dentry));
1628 kmem_cache_free(dentry_cache, dentry);
1629 return NULL;
1630 }
1631 }
1632
Nick Piggin3e880fb2011-01-07 17:49:19 +11001633 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001634
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 return dentry;
1636}
Al Viroa4464db2011-07-07 15:03:58 -04001637
1638/**
1639 * d_alloc - allocate a dcache entry
1640 * @parent: parent of entry to allocate
1641 * @name: qstr of the name
1642 *
1643 * Allocates a dentry. It returns %NULL if there is insufficient memory
1644 * available. On a success the dentry is returned. The name passed in is
1645 * copied and the copy passed in may be reused after this call.
1646 */
1647struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1648{
1649 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1650 if (!dentry)
1651 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001652 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001653 spin_lock(&parent->d_lock);
1654 /*
1655 * don't need child lock because it is not subject
1656 * to concurrency here
1657 */
1658 __dget_dlock(parent);
1659 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001660 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001661 spin_unlock(&parent->d_lock);
1662
1663 return dentry;
1664}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001665EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Al Viroba65dc52016-06-10 11:32:47 -04001667struct dentry *d_alloc_cursor(struct dentry * parent)
1668{
1669 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1670 if (dentry) {
1671 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1672 dentry->d_parent = dget(parent);
1673 }
1674 return dentry;
1675}
1676
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001677/**
1678 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1679 * @sb: the superblock
1680 * @name: qstr of the name
1681 *
1682 * For a filesystem that just pins its dentries in memory and never
1683 * performs lookups at all, return an unhashed IS_ROOT dentry.
1684 */
Nick Piggin4b936882011-01-07 17:50:07 +11001685struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1686{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001687 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001688}
1689EXPORT_SYMBOL(d_alloc_pseudo);
1690
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1692{
1693 struct qstr q;
1694
1695 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001696 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 return d_alloc(parent, &q);
1698}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001699EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Nick Pigginfb045ad2011-01-07 17:49:55 +11001701void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1702{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001703 WARN_ON_ONCE(dentry->d_op);
1704 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001705 DCACHE_OP_COMPARE |
1706 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001707 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001708 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001709 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001710 dentry->d_op = op;
1711 if (!op)
1712 return;
1713 if (op->d_hash)
1714 dentry->d_flags |= DCACHE_OP_HASH;
1715 if (op->d_compare)
1716 dentry->d_flags |= DCACHE_OP_COMPARE;
1717 if (op->d_revalidate)
1718 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001719 if (op->d_weak_revalidate)
1720 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001721 if (op->d_delete)
1722 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001723 if (op->d_prune)
1724 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001725 if (op->d_real)
1726 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001727
1728}
1729EXPORT_SYMBOL(d_set_d_op);
1730
David Howellsdf1a0852015-01-29 12:02:28 +00001731
1732/*
1733 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1734 * @dentry - The dentry to mark
1735 *
1736 * Mark a dentry as falling through to the lower layer (as set with
1737 * d_pin_lower()). This flag may be recorded on the medium.
1738 */
1739void d_set_fallthru(struct dentry *dentry)
1740{
1741 spin_lock(&dentry->d_lock);
1742 dentry->d_flags |= DCACHE_FALLTHRU;
1743 spin_unlock(&dentry->d_lock);
1744}
1745EXPORT_SYMBOL(d_set_fallthru);
1746
David Howellsb18825a2013-09-12 19:22:53 +01001747static unsigned d_flags_for_inode(struct inode *inode)
1748{
David Howells44bdb5e2015-01-29 12:02:29 +00001749 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001750
1751 if (!inode)
1752 return DCACHE_MISS_TYPE;
1753
1754 if (S_ISDIR(inode->i_mode)) {
1755 add_flags = DCACHE_DIRECTORY_TYPE;
1756 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1757 if (unlikely(!inode->i_op->lookup))
1758 add_flags = DCACHE_AUTODIR_TYPE;
1759 else
1760 inode->i_opflags |= IOP_LOOKUP;
1761 }
David Howells44bdb5e2015-01-29 12:02:29 +00001762 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001763 }
1764
David Howells44bdb5e2015-01-29 12:02:29 +00001765 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001766 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001767 add_flags = DCACHE_SYMLINK_TYPE;
1768 goto type_determined;
1769 }
1770 inode->i_opflags |= IOP_NOFOLLOW;
1771 }
1772
1773 if (unlikely(!S_ISREG(inode->i_mode)))
1774 add_flags = DCACHE_SPECIAL_TYPE;
1775
1776type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001777 if (unlikely(IS_AUTOMOUNT(inode)))
1778 add_flags |= DCACHE_NEED_AUTOMOUNT;
1779 return add_flags;
1780}
1781
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001782static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1783{
David Howellsb18825a2013-09-12 19:22:53 +01001784 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001785 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001786
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001787 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001788 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001789 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001790 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001791 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001792 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001793 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001794}
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796/**
1797 * d_instantiate - fill in inode information for a dentry
1798 * @entry: dentry to complete
1799 * @inode: inode to attach to this dentry
1800 *
1801 * Fill in inode information in the entry.
1802 *
1803 * This turns negative dentries into productive full members
1804 * of society.
1805 *
1806 * NOTE! This assumes that the inode count has been incremented
1807 * (or otherwise set) by the caller to indicate that it is now
1808 * in use by the dcache.
1809 */
1810
1811void d_instantiate(struct dentry *entry, struct inode * inode)
1812{
Al Viro946e51f2014-10-26 19:19:16 -04001813 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001814 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001815 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001816 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001817 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001818 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001821EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001824 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1825 * @entry: dentry to complete
1826 * @inode: inode to attach to this dentry
1827 *
1828 * Fill in inode information in the entry. If a directory alias is found, then
1829 * return an error (and drop inode). Together with d_materialise_unique() this
1830 * guarantees that a directory inode may never have more than one alias.
1831 */
1832int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1833{
Al Viro946e51f2014-10-26 19:19:16 -04001834 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001835
Al Virob9680912016-04-11 00:53:26 -04001836 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001837 spin_lock(&inode->i_lock);
1838 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1839 spin_unlock(&inode->i_lock);
1840 iput(inode);
1841 return -EBUSY;
1842 }
1843 __d_instantiate(entry, inode);
1844 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001845
1846 return 0;
1847}
1848EXPORT_SYMBOL(d_instantiate_no_diralias);
1849
Al Viroadc0e912012-01-08 16:49:21 -05001850struct dentry *d_make_root(struct inode *root_inode)
1851{
1852 struct dentry *res = NULL;
1853
1854 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001855 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001856 if (res)
1857 d_instantiate(res, root_inode);
1858 else
1859 iput(root_inode);
1860 }
1861 return res;
1862}
1863EXPORT_SYMBOL(d_make_root);
1864
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001865static struct dentry * __d_find_any_alias(struct inode *inode)
1866{
1867 struct dentry *alias;
1868
Al Virob3d9b7a2012-06-09 13:51:19 -04001869 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001870 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001871 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001872 __dget(alias);
1873 return alias;
1874}
1875
Sage Weil46f72b32012-01-10 09:04:37 -08001876/**
1877 * d_find_any_alias - find any alias for a given inode
1878 * @inode: inode to find an alias for
1879 *
1880 * If any aliases exist for the given inode, take and return a
1881 * reference for one of them. If no aliases exist, return %NULL.
1882 */
1883struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001884{
1885 struct dentry *de;
1886
1887 spin_lock(&inode->i_lock);
1888 de = __d_find_any_alias(inode);
1889 spin_unlock(&inode->i_lock);
1890 return de;
1891}
Sage Weil46f72b32012-01-10 09:04:37 -08001892EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001893
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001894static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001895{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001896 struct dentry *tmp;
1897 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001898 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001899
1900 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001901 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001902 if (IS_ERR(inode))
1903 return ERR_CAST(inode);
1904
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001905 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001906 if (res)
1907 goto out_iput;
1908
Al Viro798434b2016-03-24 20:38:43 -04001909 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001910 if (!tmp) {
1911 res = ERR_PTR(-ENOMEM);
1912 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001913 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001914
Al Virob9680912016-04-11 00:53:26 -04001915 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001916 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001917 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001918 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001919 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001920 dput(tmp);
1921 goto out_iput;
1922 }
1923
1924 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001925 add_flags = d_flags_for_inode(inode);
1926
1927 if (disconnected)
1928 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001929
Christoph Hellwig9308a612008-08-11 15:49:12 +02001930 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001931 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001932 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001933 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001934 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001935 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001936 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001937 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001938
Christoph Hellwig9308a612008-08-11 15:49:12 +02001939 return tmp;
1940
1941 out_iput:
1942 iput(inode);
1943 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001944}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001945
1946/**
1947 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1948 * @inode: inode to allocate the dentry for
1949 *
1950 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1951 * similar open by handle operations. The returned dentry may be anonymous,
1952 * or may have a full name (if the inode was already in the cache).
1953 *
1954 * When called on a directory inode, we must ensure that the inode only ever
1955 * has one dentry. If a dentry is found, that is returned instead of
1956 * allocating a new one.
1957 *
1958 * On successful return, the reference to the inode has been transferred
1959 * to the dentry. In case of an error the reference on the inode is released.
1960 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1961 * be passed in and the error will be propagated to the return value,
1962 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1963 */
1964struct dentry *d_obtain_alias(struct inode *inode)
1965{
1966 return __d_obtain_alias(inode, 1);
1967}
Benny Halevyadc48722009-02-27 14:02:59 -08001968EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
1970/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001971 * d_obtain_root - find or allocate a dentry for a given inode
1972 * @inode: inode to allocate the dentry for
1973 *
1974 * Obtain an IS_ROOT dentry for the root of a filesystem.
1975 *
1976 * We must ensure that directory inodes only ever have one dentry. If a
1977 * dentry is found, that is returned instead of allocating a new one.
1978 *
1979 * On successful return, the reference to the inode has been transferred
1980 * to the dentry. In case of an error the reference on the inode is
1981 * released. A %NULL or IS_ERR inode may be passed in and will be the
1982 * error will be propagate to the return value, with a %NULL @inode
1983 * replaced by ERR_PTR(-ESTALE).
1984 */
1985struct dentry *d_obtain_root(struct inode *inode)
1986{
1987 return __d_obtain_alias(inode, 0);
1988}
1989EXPORT_SYMBOL(d_obtain_root);
1990
1991/**
Barry Naujok94035402008-05-21 16:50:46 +10001992 * d_add_ci - lookup or allocate new dentry with case-exact name
1993 * @inode: the inode case-insensitive lookup has found
1994 * @dentry: the negative dentry that was passed to the parent's lookup func
1995 * @name: the case-exact name to be associated with the returned dentry
1996 *
1997 * This is to avoid filling the dcache with case-insensitive names to the
1998 * same inode, only the actual correct case is stored in the dcache for
1999 * case-insensitive filesystems.
2000 *
2001 * For a case-insensitive lookup match and if the the case-exact dentry
2002 * already exists in in the dcache, use it and return it.
2003 *
2004 * If no entry exists with the exact case name, allocate new dentry with
2005 * the exact case, and return the spliced entry.
2006 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002007struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002008 struct qstr *name)
2009{
Al Virod9171b92016-04-15 03:33:13 -04002010 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002011
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002012 /*
2013 * First check if a dentry matching the name already exists,
2014 * if not go ahead and create it now.
2015 */
Barry Naujok94035402008-05-21 16:50:46 +10002016 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002017 if (found) {
2018 iput(inode);
2019 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002020 }
Al Virod9171b92016-04-15 03:33:13 -04002021 if (d_in_lookup(dentry)) {
2022 found = d_alloc_parallel(dentry->d_parent, name,
2023 dentry->d_wait);
2024 if (IS_ERR(found) || !d_in_lookup(found)) {
2025 iput(inode);
2026 return found;
2027 }
2028 } else {
2029 found = d_alloc(dentry->d_parent, name);
2030 if (!found) {
2031 iput(inode);
2032 return ERR_PTR(-ENOMEM);
2033 }
2034 }
2035 res = d_splice_alias(inode, found);
2036 if (res) {
2037 dput(found);
2038 return res;
2039 }
Al Viro4f522a22013-02-11 23:20:37 -05002040 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002041}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002042EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002044
Al Virod4c91a82016-06-25 23:33:49 -04002045static inline bool d_same_name(const struct dentry *dentry,
2046 const struct dentry *parent,
2047 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002048{
Al Virod4c91a82016-06-25 23:33:49 -04002049 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2050 if (dentry->d_name.len != name->len)
2051 return false;
2052 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002053 }
Al Viro6fa67e72016-07-31 16:37:25 -04002054 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002055 dentry->d_name.len, dentry->d_name.name,
2056 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002057}
2058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002060 * __d_lookup_rcu - search for a dentry (racy, store-free)
2061 * @parent: parent dentry
2062 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002063 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002064 * Returns: dentry, or NULL
2065 *
2066 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2067 * resolution (store-free path walking) design described in
2068 * Documentation/filesystems/path-lookup.txt.
2069 *
2070 * This is not to be used outside core vfs.
2071 *
2072 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2073 * held, and rcu_read_lock held. The returned dentry must not be stored into
2074 * without taking d_lock and checking d_seq sequence count against @seq
2075 * returned here.
2076 *
Linus Torvalds15570082013-09-02 11:38:06 -07002077 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002078 * function.
2079 *
2080 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2081 * the returned dentry, so long as its parent's seqlock is checked after the
2082 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2083 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002084 *
2085 * NOTE! The caller *has* to check the resulting dentry against the sequence
2086 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002087 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002088struct dentry *__d_lookup_rcu(const struct dentry *parent,
2089 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002090 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002091{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002092 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002093 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002094 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002095 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 struct dentry *dentry;
2097
2098 /*
2099 * Note: There is significant duplication with __d_lookup_rcu which is
2100 * required to prevent single threaded performance regressions
2101 * especially on architectures where smp_rmb (in seqcounts) are costly.
2102 * Keep the two functions in sync.
2103 */
2104
2105 /*
2106 * The hash list is protected using RCU.
2107 *
2108 * Carefully use d_seq when comparing a candidate dentry, to avoid
2109 * races with d_move().
2110 *
2111 * It is possible that concurrent renames can mess up our list
2112 * walk here and result in missing our dentry, resulting in the
2113 * false-negative result. d_lookup() protects against concurrent
2114 * renames using rename_lock seqlock.
2115 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002116 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002117 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002118 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002119 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002120
Nick Piggin31e6b012011-01-07 17:49:52 +11002121seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002122 /*
2123 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002124 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002125 *
2126 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002127 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002128 *
2129 * NOTE! We do a "raw" seqcount_begin here. That means that
2130 * we don't wait for the sequence count to stabilize if it
2131 * is in the middle of a sequence change. If we do the slow
2132 * dentry compare, we will do seqretries until it is stable,
2133 * and if we end up with a successful lookup, we actually
2134 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002135 *
2136 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2137 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002138 */
2139 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002140 if (dentry->d_parent != parent)
2141 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002142 if (d_unhashed(dentry))
2143 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002144
2145 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002146 int tlen;
2147 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002148 if (dentry->d_name.hash != hashlen_hash(hashlen))
2149 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002150 tlen = dentry->d_name.len;
2151 tname = dentry->d_name.name;
2152 /* we want a consistent (name,len) pair */
2153 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2154 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002155 goto seqretry;
2156 }
Al Viro6fa67e72016-07-31 16:37:25 -04002157 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002158 tlen, tname, name) != 0)
2159 continue;
2160 } else {
2161 if (dentry->d_name.hash_len != hashlen)
2162 continue;
2163 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2164 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002165 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002166 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002167 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002168 }
2169 return NULL;
2170}
2171
2172/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 * d_lookup - search for a dentry
2174 * @parent: parent dentry
2175 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002176 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002178 * d_lookup searches the children of the parent dentry for the name in
2179 * question. If the dentry is found its reference count is incremented and the
2180 * dentry is returned. The caller must use dput to free the entry when it has
2181 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 */
Al Viroda2d8452013-01-24 18:29:34 -05002183struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184{
Nick Piggin31e6b012011-01-07 17:49:52 +11002185 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002186 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187
Daeseok Younb8314f92014-08-11 11:46:53 +09002188 do {
2189 seq = read_seqbegin(&rename_lock);
2190 dentry = __d_lookup(parent, name);
2191 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 break;
2193 } while (read_seqretry(&rename_lock, seq));
2194 return dentry;
2195}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002196EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197
Nick Piggin31e6b012011-01-07 17:49:52 +11002198/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002199 * __d_lookup - search for a dentry (racy)
2200 * @parent: parent dentry
2201 * @name: qstr of name we wish to find
2202 * Returns: dentry, or NULL
2203 *
2204 * __d_lookup is like d_lookup, however it may (rarely) return a
2205 * false-negative result due to unrelated rename activity.
2206 *
2207 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2208 * however it must be used carefully, eg. with a following d_lookup in
2209 * the case of failure.
2210 *
2211 * __d_lookup callers must be commented.
2212 */
Al Viroa713ca22013-01-24 18:27:00 -05002213struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002216 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002217 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002218 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002219 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220
Nick Pigginb04f7842010-08-18 04:37:34 +10002221 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002222 * Note: There is significant duplication with __d_lookup_rcu which is
2223 * required to prevent single threaded performance regressions
2224 * especially on architectures where smp_rmb (in seqcounts) are costly.
2225 * Keep the two functions in sync.
2226 */
2227
2228 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002229 * The hash list is protected using RCU.
2230 *
2231 * Take d_lock when comparing a candidate dentry, to avoid races
2232 * with d_move().
2233 *
2234 * It is possible that concurrent renames can mess up our list
2235 * walk here and result in missing our dentry, resulting in the
2236 * false-negative result. d_lookup() protects against concurrent
2237 * renames using rename_lock seqlock.
2238 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002239 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002240 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 rcu_read_lock();
2242
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002243 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 if (dentry->d_name.hash != hash)
2246 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
2248 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 if (dentry->d_parent != parent)
2250 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002251 if (d_unhashed(dentry))
2252 goto next;
2253
Al Virod4c91a82016-06-25 23:33:49 -04002254 if (!d_same_name(dentry, parent, name))
2255 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
Waiman Long98474232013-08-28 18:24:59 -07002257 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002258 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 spin_unlock(&dentry->d_lock);
2260 break;
2261next:
2262 spin_unlock(&dentry->d_lock);
2263 }
2264 rcu_read_unlock();
2265
2266 return found;
2267}
2268
2269/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002270 * d_hash_and_lookup - hash the qstr then search for a dentry
2271 * @dir: Directory to search in
2272 * @name: qstr of name we wish to find
2273 *
Al Viro4f522a22013-02-11 23:20:37 -05002274 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002275 */
2276struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2277{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002278 /*
2279 * Check for a fs-specific hash function. Note that we must
2280 * calculate the standard hash first, as the d_op->d_hash()
2281 * routine may choose to leave the hash value unchanged.
2282 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002283 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002284 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002285 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002286 if (unlikely(err < 0))
2287 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002288 }
Al Viro4f522a22013-02-11 23:20:37 -05002289 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002290}
Al Viro4f522a22013-02-11 23:20:37 -05002291EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002292
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293/*
2294 * When a file is deleted, we have two options:
2295 * - turn this dentry into a negative dentry
2296 * - unhash this dentry and free it.
2297 *
2298 * Usually, we want to just turn this into
2299 * a negative dentry, but if anybody else is
2300 * currently using the dentry or the inode
2301 * we can't do that and we fall back on removing
2302 * it from the hash queues and waiting for
2303 * it to be deleted later when it has no users
2304 */
2305
2306/**
2307 * d_delete - delete a dentry
2308 * @dentry: The dentry to delete
2309 *
2310 * Turn the dentry into a negative dentry if possible, otherwise
2311 * remove it from the hash queues so it can be deleted later
2312 */
2313
2314void d_delete(struct dentry * dentry)
2315{
Nick Piggin873feea2011-01-07 17:50:06 +11002316 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002317 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 /*
2319 * Are we the only user?
2320 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002321again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002323 inode = dentry->d_inode;
2324 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002325 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002326 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002327 spin_unlock(&dentry->d_lock);
2328 cpu_relax();
2329 goto again;
2330 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002331 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002332 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002333 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 return;
2335 }
2336
2337 if (!d_unhashed(dentry))
2338 __d_drop(dentry);
2339
2340 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002341
2342 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002344EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345
Al Viro15d3c582016-07-29 17:45:21 -04002346static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347{
Al Viro15d3c582016-07-29 17:45:21 -04002348 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002349 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002350 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002351 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002352 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353}
2354
2355/**
2356 * d_rehash - add an entry back to the hash
2357 * @entry: dentry to add to the hash
2358 *
2359 * Adds a dentry to the hash according to its name.
2360 */
2361
2362void d_rehash(struct dentry * entry)
2363{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002365 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002368EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Al Viro84e710d2016-04-15 00:58:55 -04002370static inline unsigned start_dir_add(struct inode *dir)
2371{
2372
2373 for (;;) {
2374 unsigned n = dir->i_dir_seq;
2375 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2376 return n;
2377 cpu_relax();
2378 }
2379}
2380
2381static inline void end_dir_add(struct inode *dir, unsigned n)
2382{
2383 smp_store_release(&dir->i_dir_seq, n + 2);
2384}
2385
Al Virod9171b92016-04-15 03:33:13 -04002386static void d_wait_lookup(struct dentry *dentry)
2387{
2388 if (d_in_lookup(dentry)) {
2389 DECLARE_WAITQUEUE(wait, current);
2390 add_wait_queue(dentry->d_wait, &wait);
2391 do {
2392 set_current_state(TASK_UNINTERRUPTIBLE);
2393 spin_unlock(&dentry->d_lock);
2394 schedule();
2395 spin_lock(&dentry->d_lock);
2396 } while (d_in_lookup(dentry));
2397 }
2398}
2399
Al Viro94bdd652016-04-15 02:42:04 -04002400struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002401 const struct qstr *name,
2402 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002403{
Al Viro94bdd652016-04-15 02:42:04 -04002404 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002405 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2406 struct hlist_bl_node *node;
2407 struct dentry *new = d_alloc(parent, name);
2408 struct dentry *dentry;
2409 unsigned seq, r_seq, d_seq;
2410
2411 if (unlikely(!new))
2412 return ERR_PTR(-ENOMEM);
2413
2414retry:
2415 rcu_read_lock();
2416 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2417 r_seq = read_seqbegin(&rename_lock);
2418 dentry = __d_lookup_rcu(parent, name, &d_seq);
2419 if (unlikely(dentry)) {
2420 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2421 rcu_read_unlock();
2422 goto retry;
2423 }
2424 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2425 rcu_read_unlock();
2426 dput(dentry);
2427 goto retry;
2428 }
2429 rcu_read_unlock();
2430 dput(new);
2431 return dentry;
2432 }
2433 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2434 rcu_read_unlock();
2435 goto retry;
2436 }
2437 hlist_bl_lock(b);
2438 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2439 hlist_bl_unlock(b);
2440 rcu_read_unlock();
2441 goto retry;
2442 }
Al Viro94bdd652016-04-15 02:42:04 -04002443 /*
2444 * No changes for the parent since the beginning of d_lookup().
2445 * Since all removals from the chain happen with hlist_bl_lock(),
2446 * any potential in-lookup matches are going to stay here until
2447 * we unlock the chain. All fields are stable in everything
2448 * we encounter.
2449 */
2450 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2451 if (dentry->d_name.hash != hash)
2452 continue;
2453 if (dentry->d_parent != parent)
2454 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002455 if (!d_same_name(dentry, parent, name))
2456 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002457 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002458 /* now we can try to grab a reference */
2459 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2460 rcu_read_unlock();
2461 goto retry;
2462 }
2463
2464 rcu_read_unlock();
2465 /*
2466 * somebody is likely to be still doing lookup for it;
2467 * wait for them to finish
2468 */
Al Virod9171b92016-04-15 03:33:13 -04002469 spin_lock(&dentry->d_lock);
2470 d_wait_lookup(dentry);
2471 /*
2472 * it's not in-lookup anymore; in principle we should repeat
2473 * everything from dcache lookup, but it's likely to be what
2474 * d_lookup() would've found anyway. If it is, just return it;
2475 * otherwise we really have to repeat the whole thing.
2476 */
2477 if (unlikely(dentry->d_name.hash != hash))
2478 goto mismatch;
2479 if (unlikely(dentry->d_parent != parent))
2480 goto mismatch;
2481 if (unlikely(d_unhashed(dentry)))
2482 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002483 if (unlikely(!d_same_name(dentry, parent, name)))
2484 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002485 /* OK, it *is* a hashed match; return it */
2486 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002487 dput(new);
2488 return dentry;
2489 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002490 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002491 /* we can't take ->d_lock here; it's OK, though. */
2492 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002493 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002494 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2495 hlist_bl_unlock(b);
2496 return new;
Al Virod9171b92016-04-15 03:33:13 -04002497mismatch:
2498 spin_unlock(&dentry->d_lock);
2499 dput(dentry);
2500 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002501}
2502EXPORT_SYMBOL(d_alloc_parallel);
2503
Al Viro85c7f812016-04-14 19:52:13 -04002504void __d_lookup_done(struct dentry *dentry)
2505{
Al Viro94bdd652016-04-15 02:42:04 -04002506 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2507 dentry->d_name.hash);
2508 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002509 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002510 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002511 wake_up_all(dentry->d_wait);
2512 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002513 hlist_bl_unlock(b);
2514 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002515 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002516}
2517EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002518
2519/* inode->i_lock held if inode is non-NULL */
2520
2521static inline void __d_add(struct dentry *dentry, struct inode *inode)
2522{
Al Viro84e710d2016-04-15 00:58:55 -04002523 struct inode *dir = NULL;
2524 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002525 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002526 if (unlikely(d_in_lookup(dentry))) {
2527 dir = dentry->d_parent->d_inode;
2528 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002529 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002530 }
Al Viroed782b52016-03-09 19:52:39 -05002531 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002532 unsigned add_flags = d_flags_for_inode(inode);
2533 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2534 raw_write_seqcount_begin(&dentry->d_seq);
2535 __d_set_inode_and_type(dentry, inode, add_flags);
2536 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002537 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002538 }
Al Viro15d3c582016-07-29 17:45:21 -04002539 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002540 if (dir)
2541 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002542 spin_unlock(&dentry->d_lock);
2543 if (inode)
2544 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002545}
2546
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002547/**
Al Viro34d0d192016-03-08 21:01:03 -05002548 * d_add - add dentry to hash queues
2549 * @entry: dentry to add
2550 * @inode: The inode to attach to this dentry
2551 *
2552 * This adds the entry to the hash queues and initializes @inode.
2553 * The entry was actually filled in earlier during d_alloc().
2554 */
2555
2556void d_add(struct dentry *entry, struct inode *inode)
2557{
Al Virob9680912016-04-11 00:53:26 -04002558 if (inode) {
2559 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002560 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002561 }
Al Viroed782b52016-03-09 19:52:39 -05002562 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002563}
2564EXPORT_SYMBOL(d_add);
2565
2566/**
Al Viro668d0cd2016-03-08 12:44:17 -05002567 * d_exact_alias - find and hash an exact unhashed alias
2568 * @entry: dentry to add
2569 * @inode: The inode to go with this dentry
2570 *
2571 * If an unhashed dentry with the same name/parent and desired
2572 * inode already exists, hash and return it. Otherwise, return
2573 * NULL.
2574 *
2575 * Parent directory should be locked.
2576 */
2577struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2578{
2579 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002580 unsigned int hash = entry->d_name.hash;
2581
2582 spin_lock(&inode->i_lock);
2583 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2584 /*
2585 * Don't need alias->d_lock here, because aliases with
2586 * d_parent == entry->d_parent are not subject to name or
2587 * parent changes, because the parent inode i_mutex is held.
2588 */
2589 if (alias->d_name.hash != hash)
2590 continue;
2591 if (alias->d_parent != entry->d_parent)
2592 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002593 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002594 continue;
2595 spin_lock(&alias->d_lock);
2596 if (!d_unhashed(alias)) {
2597 spin_unlock(&alias->d_lock);
2598 alias = NULL;
2599 } else {
2600 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002601 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002602 spin_unlock(&alias->d_lock);
2603 }
2604 spin_unlock(&inode->i_lock);
2605 return alias;
2606 }
2607 spin_unlock(&inode->i_lock);
2608 return NULL;
2609}
2610EXPORT_SYMBOL(d_exact_alias);
2611
2612/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002613 * dentry_update_name_case - update case insensitive dentry with a new name
2614 * @dentry: dentry to be updated
2615 * @name: new name
2616 *
2617 * Update a case insensitive dentry with new case of name.
2618 *
2619 * dentry must have been returned by d_lookup with name @name. Old and new
2620 * name lengths must match (ie. no d_compare which allows mismatched name
2621 * lengths).
2622 *
2623 * Parent inode i_mutex must be held over d_lookup and into this call (to
2624 * keep renames and concurrent inserts, and readdir(2) away).
2625 */
Al Viro9aba36d2016-07-20 22:28:45 -04002626void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002627{
Al Viro59551022016-01-22 15:40:57 -05002628 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002629 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2630
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002631 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002632 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002633 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002634 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002635 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002636}
2637EXPORT_SYMBOL(dentry_update_name_case);
2638
Al Viro8d85b482014-09-29 14:54:27 -04002639static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640{
Al Viro8d85b482014-09-29 14:54:27 -04002641 if (unlikely(dname_external(target))) {
2642 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 /*
2644 * Both external: swap the pointers
2645 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002646 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 } else {
2648 /*
2649 * dentry:internal, target:external. Steal target's
2650 * storage and make target internal.
2651 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002652 memcpy(target->d_iname, dentry->d_name.name,
2653 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 dentry->d_name.name = target->d_name.name;
2655 target->d_name.name = target->d_iname;
2656 }
2657 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002658 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 /*
2660 * dentry:external, target:internal. Give dentry's
2661 * storage to target and make dentry internal
2662 */
2663 memcpy(dentry->d_iname, target->d_name.name,
2664 target->d_name.len + 1);
2665 target->d_name.name = dentry->d_name.name;
2666 dentry->d_name.name = dentry->d_iname;
2667 } else {
2668 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002669 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002671 unsigned int i;
2672 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002673 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2674 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002675 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2676 swap(((long *) &dentry->d_iname)[i],
2677 ((long *) &target->d_iname)[i]);
2678 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 }
2680 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002681 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682}
2683
Al Viro8d85b482014-09-29 14:54:27 -04002684static void copy_name(struct dentry *dentry, struct dentry *target)
2685{
2686 struct external_name *old_name = NULL;
2687 if (unlikely(dname_external(dentry)))
2688 old_name = external_name(dentry);
2689 if (unlikely(dname_external(target))) {
2690 atomic_inc(&external_name(target)->u.count);
2691 dentry->d_name = target->d_name;
2692 } else {
2693 memcpy(dentry->d_iname, target->d_name.name,
2694 target->d_name.len + 1);
2695 dentry->d_name.name = dentry->d_iname;
2696 dentry->d_name.hash_len = target->d_name.hash_len;
2697 }
2698 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2699 kfree_rcu(old_name, u.head);
2700}
2701
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002702static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2703{
2704 /*
2705 * XXXX: do we really need to take target->d_lock?
2706 */
2707 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2708 spin_lock(&target->d_parent->d_lock);
2709 else {
2710 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2711 spin_lock(&dentry->d_parent->d_lock);
2712 spin_lock_nested(&target->d_parent->d_lock,
2713 DENTRY_D_LOCK_NESTED);
2714 } else {
2715 spin_lock(&target->d_parent->d_lock);
2716 spin_lock_nested(&dentry->d_parent->d_lock,
2717 DENTRY_D_LOCK_NESTED);
2718 }
2719 }
2720 if (target < dentry) {
2721 spin_lock_nested(&target->d_lock, 2);
2722 spin_lock_nested(&dentry->d_lock, 3);
2723 } else {
2724 spin_lock_nested(&dentry->d_lock, 2);
2725 spin_lock_nested(&target->d_lock, 3);
2726 }
2727}
2728
Al Viro986c0192014-09-26 23:11:15 -04002729static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002730{
2731 if (target->d_parent != dentry->d_parent)
2732 spin_unlock(&dentry->d_parent->d_lock);
2733 if (target->d_parent != target)
2734 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002735 spin_unlock(&target->d_lock);
2736 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002737}
2738
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002740 * When switching names, the actual string doesn't strictly have to
2741 * be preserved in the target - because we're dropping the target
2742 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002743 * the new name before we switch, unless we are going to rehash
2744 * it. Note that if we *do* unhash the target, we are not allowed
2745 * to rehash it without giving it a new name/hash key - whether
2746 * we swap or overwrite the names here, resulting name won't match
2747 * the reality in filesystem; it's only there for d_path() purposes.
2748 * Note that all of this is happening under rename_lock, so the
2749 * any hash lookup seeing it in the middle of manipulations will
2750 * be discarded anyway. So we do not care what happens to the hash
2751 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002753/*
Al Viro18367502011-07-12 21:42:24 -04002754 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 * @dentry: entry to move
2756 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002757 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 *
2759 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002760 * dcache entries should not be moved in this way. Caller must hold
2761 * rename_lock, the i_mutex of the source and target directories,
2762 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002764static void __d_move(struct dentry *dentry, struct dentry *target,
2765 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766{
Al Viro84e710d2016-04-15 00:58:55 -04002767 struct inode *dir = NULL;
2768 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 if (!dentry->d_inode)
2770 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2771
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002772 BUG_ON(d_ancestor(dentry, target));
2773 BUG_ON(d_ancestor(target, dentry));
2774
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002775 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002776 if (unlikely(d_in_lookup(target))) {
2777 dir = target->d_parent->d_inode;
2778 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002779 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781
Nick Piggin31e6b012011-01-07 17:49:52 +11002782 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002783 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002784
Al Viro15d3c582016-07-29 17:45:21 -04002785 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002786 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002787 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 __d_drop(target);
2789
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002791 if (exchange)
2792 swap_names(dentry, target);
2793 else
2794 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795
Al Viro15d3c582016-07-29 17:45:21 -04002796 /* rehash in new place(s) */
2797 __d_rehash(dentry);
2798 if (exchange)
2799 __d_rehash(target);
2800
Al Viro63cf4272014-09-26 23:06:14 -04002801 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002803 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002804 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 dentry->d_parent = target->d_parent;
2806 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002807 list_del_init(&target->d_child);
2808 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002810 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002811 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002812 list_move(&target->d_child, &target->d_parent->d_subdirs);
2813 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002814 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002815 fsnotify_update_flags(target);
2816 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 }
Eric Biggers7bc138e2019-03-20 11:39:11 -07002818 fscrypt_handle_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819
Nick Piggin31e6b012011-01-07 17:49:52 +11002820 write_seqcount_end(&target->d_seq);
2821 write_seqcount_end(&dentry->d_seq);
2822
Al Viro84e710d2016-04-15 00:58:55 -04002823 if (dir)
2824 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002825 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002826}
2827
2828/*
2829 * d_move - move a dentry
2830 * @dentry: entry to move
2831 * @target: new dentry
2832 *
2833 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002834 * dcache entries should not be moved in this way. See the locking
2835 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002836 */
2837void d_move(struct dentry *dentry, struct dentry *target)
2838{
2839 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002840 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002842}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002843EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844
Miklos Szeredida1ce062014-04-01 17:08:43 +02002845/*
2846 * d_exchange - exchange two dentries
2847 * @dentry1: first dentry
2848 * @dentry2: second dentry
2849 */
2850void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2851{
2852 write_seqlock(&rename_lock);
2853
2854 WARN_ON(!dentry1->d_inode);
2855 WARN_ON(!dentry2->d_inode);
2856 WARN_ON(IS_ROOT(dentry1));
2857 WARN_ON(IS_ROOT(dentry2));
2858
2859 __d_move(dentry1, dentry2, true);
2860
2861 write_sequnlock(&rename_lock);
2862}
2863
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002864/**
2865 * d_ancestor - search for an ancestor
2866 * @p1: ancestor dentry
2867 * @p2: child dentry
2868 *
2869 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2870 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002871 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002872struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002873{
2874 struct dentry *p;
2875
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002876 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002877 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002878 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002879 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002880 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002881}
2882
2883/*
2884 * This helper attempts to cope with remotely renamed directories
2885 *
2886 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002887 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002888 *
2889 * Note: If ever the locking in lock_rename() changes, then please
2890 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002891 */
Al Virob5ae6b12014-10-12 22:16:02 -04002892static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002893 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002894{
Al Viro9902af72016-04-15 15:08:36 -04002895 struct mutex *m1 = NULL;
2896 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002897 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002898
2899 /* If alias and dentry share a parent, then no extra locks required */
2900 if (alias->d_parent == dentry->d_parent)
2901 goto out_unalias;
2902
Trond Myklebust9eaef272006-10-21 10:24:20 -07002903 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002904 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2905 goto out_err;
2906 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002907 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002908 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002909 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002911 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002912 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002913out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002915 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002916 if (m1)
2917 mutex_unlock(m1);
2918 return ret;
2919}
2920
David Howells770bfad2006-08-22 20:06:07 -04002921/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002922 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2923 * @inode: the inode which may have a disconnected dentry
2924 * @dentry: a negative dentry which we want to point to the inode.
2925 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002926 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2927 * place of the given dentry and return it, else simply d_add the inode
2928 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002929 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002930 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2931 * we should error out: directories can't have multiple aliases.
2932 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002933 * This is needed in the lookup routine of any filesystem that is exportable
2934 * (via knfsd) so that we can build dcache paths to directories effectively.
2935 *
2936 * If a dentry was found and moved, then it is returned. Otherwise NULL
2937 * is returned. This matches the expected return value of ->lookup.
2938 *
2939 * Cluster filesystems may call this function with a negative, hashed dentry.
2940 * In that case, we know that the inode will be a regular file, and also this
2941 * will only occur during atomic_open. So we need to check for the dentry
2942 * being already hashed only in the final case.
2943 */
2944struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2945{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002946 if (IS_ERR(inode))
2947 return ERR_CAST(inode);
2948
David Howells770bfad2006-08-22 20:06:07 -04002949 BUG_ON(!d_unhashed(dentry));
2950
Al Virode689f52016-03-09 18:05:42 -05002951 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002952 goto out;
Al Virode689f52016-03-09 18:05:42 -05002953
Al Virob9680912016-04-11 00:53:26 -04002954 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002955 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002956 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002957 struct dentry *new = __d_find_any_alias(inode);
2958 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002959 /* The reference to new ensures it remains an alias */
2960 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002961 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002962 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002963 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002964 dput(new);
2965 new = ERR_PTR(-ELOOP);
2966 pr_warn_ratelimited(
2967 "VFS: Lookup of '%s' in %s %s"
2968 " would have caused loop\n",
2969 dentry->d_name.name,
2970 inode->i_sb->s_type->name,
2971 inode->i_sb->s_id);
2972 } else if (!IS_ROOT(new)) {
2973 int err = __d_unalias(inode, dentry, new);
2974 write_sequnlock(&rename_lock);
2975 if (err) {
2976 dput(new);
2977 new = ERR_PTR(err);
2978 }
Al Viro18367502011-07-12 21:42:24 -04002979 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002980 __d_move(new, dentry, false);
2981 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002982 }
Al Virob5ae6b12014-10-12 22:16:02 -04002983 iput(inode);
2984 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002985 }
David Howells770bfad2006-08-22 20:06:07 -04002986 }
Al Virob5ae6b12014-10-12 22:16:02 -04002987out:
Al Viroed782b52016-03-09 19:52:39 -05002988 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002989 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002990}
Al Virob5ae6b12014-10-12 22:16:02 -04002991EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002992
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002993static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002994{
2995 *buflen -= namelen;
2996 if (*buflen < 0)
2997 return -ENAMETOOLONG;
2998 *buffer -= namelen;
2999 memcpy(*buffer, str, namelen);
3000 return 0;
3001}
3002
Waiman Long232d2d62013-09-09 12:18:13 -04003003/**
3004 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003005 * @buffer: buffer pointer
3006 * @buflen: allocated length of the buffer
3007 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003008 *
3009 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3010 * make sure that either the old or the new name pointer and length are
3011 * fetched. However, there may be mismatch between length and pointer.
3012 * The length cannot be trusted, we need to copy it byte-by-byte until
3013 * the length is reached or a null byte is found. It also prepends "/" at
3014 * the beginning of the name. The sequence number check at the caller will
3015 * retry it again when a d_move() does happen. So any garbage in the buffer
3016 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003017 *
3018 * Data dependency barrier is needed to make sure that we see that terminating
3019 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003020 */
Al Viro9aba36d2016-07-20 22:28:45 -04003021static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003022{
Waiman Long232d2d62013-09-09 12:18:13 -04003023 const char *dname = ACCESS_ONCE(name->name);
3024 u32 dlen = ACCESS_ONCE(name->len);
3025 char *p;
3026
Al Viro6d13f692014-09-29 14:46:30 -04003027 smp_read_barrier_depends();
3028
Waiman Long232d2d62013-09-09 12:18:13 -04003029 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003030 if (*buflen < 0)
3031 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003032 p = *buffer -= dlen + 1;
3033 *p++ = '/';
3034 while (dlen--) {
3035 char c = *dname++;
3036 if (!c)
3037 break;
3038 *p++ = c;
3039 }
3040 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003041}
3042
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003044 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003045 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003046 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003047 * @buffer: pointer to the end of the buffer
3048 * @buflen: pointer to buffer length
3049 *
Waiman Long18129972013-09-12 10:55:35 -04003050 * The function will first try to write out the pathname without taking any
3051 * lock other than the RCU read lock to make sure that dentries won't go away.
3052 * It only checks the sequence number of the global rename_lock as any change
3053 * in the dentry's d_seq will be preceded by changes in the rename_lock
3054 * sequence number. If the sequence number had been changed, it will restart
3055 * the whole pathname back-tracing sequence again by taking the rename_lock.
3056 * In this case, there is no need to take the RCU read lock as the recursive
3057 * parent pointer references will keep the dentry chain alive as long as no
3058 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003059 */
Al Viro02125a82011-12-05 08:43:34 -05003060static int prepend_path(const struct path *path,
3061 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003062 char **buffer, int *buflen)
3063{
Al Viroede4ceb2013-11-13 07:45:40 -05003064 struct dentry *dentry;
3065 struct vfsmount *vfsmnt;
3066 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003067 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003068 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003069 char *bptr;
3070 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003071
Al Viro48f5ec22013-09-09 15:22:25 -04003072 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003073restart_mnt:
3074 read_seqbegin_or_lock(&mount_lock, &m_seq);
3075 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003076 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003077restart:
3078 bptr = *buffer;
3079 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003080 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003081 dentry = path->dentry;
3082 vfsmnt = path->mnt;
3083 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003084 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003085 while (dentry != root->dentry || vfsmnt != root->mnt) {
3086 struct dentry * parent;
3087
3088 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003089 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003090 /* Escaped? */
3091 if (dentry != vfsmnt->mnt_root) {
3092 bptr = *buffer;
3093 blen = *buflen;
3094 error = 3;
3095 break;
3096 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003097 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003098 if (mnt != parent) {
3099 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3100 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003101 vfsmnt = &mnt->mnt;
3102 continue;
3103 }
Waiman Long232d2d62013-09-09 12:18:13 -04003104 if (!error)
3105 error = is_mounted(vfsmnt) ? 1 : 2;
3106 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003107 }
3108 parent = dentry->d_parent;
3109 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003110 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003111 if (error)
3112 break;
3113
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003114 dentry = parent;
3115 }
Al Viro48f5ec22013-09-09 15:22:25 -04003116 if (!(seq & 1))
3117 rcu_read_unlock();
3118 if (need_seqretry(&rename_lock, seq)) {
3119 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003120 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003121 }
Al Viro48f5ec22013-09-09 15:22:25 -04003122 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003123
3124 if (!(m_seq & 1))
3125 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003126 if (need_seqretry(&mount_lock, m_seq)) {
3127 m_seq = 1;
3128 goto restart_mnt;
3129 }
3130 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003131
Waiman Long232d2d62013-09-09 12:18:13 -04003132 if (error >= 0 && bptr == *buffer) {
3133 if (--blen < 0)
3134 error = -ENAMETOOLONG;
3135 else
3136 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003137 }
Waiman Long232d2d62013-09-09 12:18:13 -04003138 *buffer = bptr;
3139 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003140 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003141}
3142
3143/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003144 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003145 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003146 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003147 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003148 * @buflen: buffer length
3149 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003150 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003152 * Returns a pointer into the buffer or an error code if the
3153 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003154 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003155 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003156 *
Al Viro02125a82011-12-05 08:43:34 -05003157 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158 */
Al Viro02125a82011-12-05 08:43:34 -05003159char *__d_path(const struct path *path,
3160 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003161 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003163 char *res = buf + buflen;
3164 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003166 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003167 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003168
Al Viro02125a82011-12-05 08:43:34 -05003169 if (error < 0)
3170 return ERR_PTR(error);
3171 if (error > 0)
3172 return NULL;
3173 return res;
3174}
3175
3176char *d_absolute_path(const struct path *path,
3177 char *buf, int buflen)
3178{
3179 struct path root = {};
3180 char *res = buf + buflen;
3181 int error;
3182
3183 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003184 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003185
3186 if (error > 1)
3187 error = -EINVAL;
3188 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003189 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003190 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191}
3192
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003193/*
3194 * same as __d_path but appends "(deleted)" for unlinked files.
3195 */
Al Viro02125a82011-12-05 08:43:34 -05003196static int path_with_deleted(const struct path *path,
3197 const struct path *root,
3198 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003199{
3200 prepend(buf, buflen, "\0", 1);
3201 if (d_unlinked(path->dentry)) {
3202 int error = prepend(buf, buflen, " (deleted)", 10);
3203 if (error)
3204 return error;
3205 }
3206
3207 return prepend_path(path, root, buf, buflen);
3208}
3209
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003210static int prepend_unreachable(char **buffer, int *buflen)
3211{
3212 return prepend(buffer, buflen, "(unreachable)", 13);
3213}
3214
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003215static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3216{
3217 unsigned seq;
3218
3219 do {
3220 seq = read_seqcount_begin(&fs->seq);
3221 *root = fs->root;
3222 } while (read_seqcount_retry(&fs->seq, seq));
3223}
3224
Jan Bluncka03a8a702008-02-14 19:38:32 -08003225/**
3226 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003227 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003228 * @buf: buffer to return value in
3229 * @buflen: buffer length
3230 *
3231 * Convert a dentry into an ASCII path name. If the entry has been deleted
3232 * the string " (deleted)" is appended. Note that this is ambiguous.
3233 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003234 * Returns a pointer into the buffer or an error code if the path was
3235 * too long. Note: Callers should use the returned pointer, not the passed
3236 * in buffer, to use the name! The implementation often starts at an offset
3237 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003238 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003239 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003240 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003241char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003243 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003244 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003245 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003246
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003247 /*
3248 * We have various synthetic filesystems that never get mounted. On
3249 * these filesystems dentries are never used for lookup purposes, and
3250 * thus don't need to be hashed. They also don't need a name until a
3251 * user wants to identify the object in /proc/pid/fd/. The little hack
3252 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003253 *
3254 * Some pseudo inodes are mountable. When they are mounted
3255 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3256 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003257 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003258 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3259 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003260 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003261
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003262 rcu_read_lock();
3263 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003264 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003265 rcu_read_unlock();
3266
Al Viro02125a82011-12-05 08:43:34 -05003267 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003268 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003269 return res;
3270}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003271EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003272
3273/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003274 * Helper function for dentry_operations.d_dname() members
3275 */
3276char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3277 const char *fmt, ...)
3278{
3279 va_list args;
3280 char temp[64];
3281 int sz;
3282
3283 va_start(args, fmt);
3284 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3285 va_end(args);
3286
3287 if (sz > sizeof(temp) || sz > buflen)
3288 return ERR_PTR(-ENAMETOOLONG);
3289
3290 buffer += buflen - sz;
3291 return memcpy(buffer, temp, sz);
3292}
3293
Al Viro118b2302013-08-24 12:08:17 -04003294char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3295{
3296 char *end = buffer + buflen;
3297 /* these dentries are never renamed, so d_lock is not needed */
3298 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003299 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003300 prepend(&end, &buflen, "/", 1))
3301 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003302 return end;
Al Viro118b2302013-08-24 12:08:17 -04003303}
David Herrmann31bbe162014-01-03 14:09:47 +01003304EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003305
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003306/*
Ram Pai6092d042008-03-27 13:06:20 +01003307 * Write full pathname from the root of the filesystem into the buffer.
3308 */
Al Virof6500802014-01-26 12:37:55 -05003309static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003310{
Al Virof6500802014-01-26 12:37:55 -05003311 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003312 char *end, *retval;
3313 int len, seq = 0;
3314 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003315
Al Virof6500802014-01-26 12:37:55 -05003316 if (buflen < 2)
3317 goto Elong;
3318
Al Viro48f5ec22013-09-09 15:22:25 -04003319 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003320restart:
Al Virof6500802014-01-26 12:37:55 -05003321 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003322 end = buf + buflen;
3323 len = buflen;
3324 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003325 /* Get '/' right */
3326 retval = end-1;
3327 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003328 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003329 while (!IS_ROOT(dentry)) {
3330 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003331
Ram Pai6092d042008-03-27 13:06:20 +01003332 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003333 error = prepend_name(&end, &len, &dentry->d_name);
3334 if (error)
3335 break;
Ram Pai6092d042008-03-27 13:06:20 +01003336
3337 retval = end;
3338 dentry = parent;
3339 }
Al Viro48f5ec22013-09-09 15:22:25 -04003340 if (!(seq & 1))
3341 rcu_read_unlock();
3342 if (need_seqretry(&rename_lock, seq)) {
3343 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003344 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003345 }
3346 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003347 if (error)
3348 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003349 return retval;
3350Elong:
3351 return ERR_PTR(-ENAMETOOLONG);
3352}
Nick Pigginec2447c2011-01-07 17:49:29 +11003353
3354char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3355{
Waiman Long232d2d62013-09-09 12:18:13 -04003356 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003357}
3358EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003359
3360char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3361{
3362 char *p = NULL;
3363 char *retval;
3364
Al Viroc1031352010-06-06 22:31:14 -04003365 if (d_unlinked(dentry)) {
3366 p = buf + buflen;
3367 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3368 goto Elong;
3369 buflen++;
3370 }
3371 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003372 if (!IS_ERR(retval) && p)
3373 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003374 return retval;
3375Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003376 return ERR_PTR(-ENAMETOOLONG);
3377}
3378
Linus Torvalds8b19e342013-09-12 10:35:47 -07003379static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3380 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003381{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003382 unsigned seq;
3383
3384 do {
3385 seq = read_seqcount_begin(&fs->seq);
3386 *root = fs->root;
3387 *pwd = fs->pwd;
3388 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003389}
3390
Ram Pai6092d042008-03-27 13:06:20 +01003391/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 * NOTE! The user-level library version returns a
3393 * character pointer. The kernel system call just
3394 * returns the length of the buffer filled (which
3395 * includes the ending '\0' character), or a negative
3396 * error value. So libc would do something like
3397 *
3398 * char *getcwd(char * buf, size_t size)
3399 * {
3400 * int retval;
3401 *
3402 * retval = sys_getcwd(buf, size);
3403 * if (retval >= 0)
3404 * return buf;
3405 * errno = -retval;
3406 * return NULL;
3407 * }
3408 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003409SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003410{
Linus Torvalds552ce542007-02-13 12:08:18 -08003411 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003412 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003413 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414
3415 if (!page)
3416 return -ENOMEM;
3417
Linus Torvalds8b19e342013-09-12 10:35:47 -07003418 rcu_read_lock();
3419 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420
Linus Torvalds552ce542007-02-13 12:08:18 -08003421 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003422 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003423 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003424 char *cwd = page + PATH_MAX;
3425 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003426
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003427 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003428 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003429 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003430
Al Viro02125a82011-12-05 08:43:34 -05003431 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003432 goto out;
3433
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003434 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003435 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003436 error = prepend_unreachable(&cwd, &buflen);
3437 if (error)
3438 goto out;
3439 }
3440
Linus Torvalds552ce542007-02-13 12:08:18 -08003441 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003442 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003443 if (len <= size) {
3444 error = len;
3445 if (copy_to_user(buf, cwd, len))
3446 error = -EFAULT;
3447 }
Nick Piggin949854d2011-01-07 17:49:37 +11003448 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003449 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451
3452out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003453 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003454 return error;
3455}
3456
3457/*
3458 * Test whether new_dentry is a subdirectory of old_dentry.
3459 *
3460 * Trivially implemented using the dcache structure
3461 */
3462
3463/**
3464 * is_subdir - is new dentry a subdirectory of old_dentry
3465 * @new_dentry: new dentry
3466 * @old_dentry: old dentry
3467 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003468 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3469 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3471 */
3472
Yaowei Baia6e57872015-11-17 14:40:11 +08003473bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474{
Yaowei Baia6e57872015-11-17 14:40:11 +08003475 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003476 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003477
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003478 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003479 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003480
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003481 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003482 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003484 /*
3485 * Need rcu_readlock to protect against the d_parent trashing
3486 * due to d_move
3487 */
3488 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003489 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003490 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003491 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003492 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003493 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003495
3496 return result;
3497}
3498
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003499static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003501 struct dentry *root = data;
3502 if (dentry != root) {
3503 if (d_unhashed(dentry) || !dentry->d_inode)
3504 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003506 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3507 dentry->d_flags |= DCACHE_GENOCIDE;
3508 dentry->d_lockref.count--;
3509 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003511 return D_WALK_CONTINUE;
3512}
Nick Piggin58db63d2011-01-07 17:49:39 +11003513
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003514void d_genocide(struct dentry *parent)
3515{
3516 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003517}
3518
Al Viro60545d02013-06-07 01:20:27 -04003519void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520{
Al Viro60545d02013-06-07 01:20:27 -04003521 inode_dec_link_count(inode);
3522 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003523 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003524 !d_unlinked(dentry));
3525 spin_lock(&dentry->d_parent->d_lock);
3526 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3527 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3528 (unsigned long long)inode->i_ino);
3529 spin_unlock(&dentry->d_lock);
3530 spin_unlock(&dentry->d_parent->d_lock);
3531 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532}
Al Viro60545d02013-06-07 01:20:27 -04003533EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534
3535static __initdata unsigned long dhash_entries;
3536static int __init set_dhash_entries(char *str)
3537{
3538 if (!str)
3539 return 0;
3540 dhash_entries = simple_strtoul(str, &str, 0);
3541 return 1;
3542}
3543__setup("dhash_entries=", set_dhash_entries);
3544
3545static void __init dcache_init_early(void)
3546{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003547 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548
3549 /* If hashes are distributed across NUMA nodes, defer
3550 * hash allocation until vmalloc space is available.
3551 */
3552 if (hashdist)
3553 return;
3554
3555 dentry_hashtable =
3556 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003557 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003558 dhash_entries,
3559 13,
3560 HASH_EARLY,
3561 &d_hash_shift,
3562 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003563 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564 0);
3565
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003566 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003567 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003568}
3569
Denis Cheng74bf17c2007-10-16 23:26:30 -07003570static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003571{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003572 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573
3574 /*
3575 * A constructor could be added for stable state like the lists,
3576 * but it is probably not worth it because of the cache nature
3577 * of the dcache.
3578 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003579 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003580 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003581
3582 /* Hash may have been set up in dcache_init_early */
3583 if (!hashdist)
3584 return;
3585
3586 dentry_hashtable =
3587 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003588 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 dhash_entries,
3590 13,
3591 0,
3592 &d_hash_shift,
3593 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003594 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003595 0);
3596
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003597 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003598 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003599}
3600
3601/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003602struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003603EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605EXPORT_SYMBOL(d_genocide);
3606
Linus Torvalds1da177e2005-04-16 15:20:36 -07003607void __init vfs_caches_init_early(void)
3608{
3609 dcache_init_early();
3610 inode_init_early();
3611}
3612
Mel Gorman4248b0d2015-08-06 15:46:20 -07003613void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003616 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617
Denis Cheng74bf17c2007-10-16 23:26:30 -07003618 dcache_init();
3619 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003620 files_init();
3621 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003622 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003623 bdev_cache_init();
3624 chrdev_init();
3625}