blob: d4f5b52d99bea2cfffcefb4a821d7277b7f9a694 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110035#include <linux/bit_spinlock.h>
36#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070037#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010038#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100039#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080040#include <linux/kasan.h>
41
David Howells07f3f052006-09-30 20:52:18 +020042#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050043#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Nick Piggin789680d2011-01-07 17:49:30 +110045/*
46 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110047 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040048 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110049 * dcache_hash_bucket lock protects:
50 * - the dcache hash table
NeilBrownf1ee6162017-12-21 09:45:40 +110051 * s_roots bl list spinlock protects:
52 * - the s_roots list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100053 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110054 * - the dcache lru lists and counters
55 * d_lock protects:
56 * - d_flags
57 * - d_name
58 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110059 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110060 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110061 * - d_parent and d_subdirs
62 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040063 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110064 *
65 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110066 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110067 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100068 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110069 * dcache_hash_bucket lock
NeilBrownf1ee6162017-12-21 09:45:40 +110070 * s_roots lock
Nick Piggin789680d2011-01-07 17:49:30 +110071 *
Nick Pigginda502952011-01-07 17:49:33 +110072 * If there is an ancestor relationship:
73 * dentry->d_parent->...->d_parent->d_lock
74 * ...
75 * dentry->d_parent->d_lock
76 * dentry->d_lock
77 *
78 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110079 * if (dentry1 < dentry2)
80 * dentry1->d_lock
81 * dentry2->d_lock
82 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080083int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
85
Al Viro74c3cbe2007-07-22 08:04:18 -040086__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Nick Piggin949854d2011-01-07 17:49:37 +110088EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Christoph Lametere18b8902006-12-06 20:33:20 -080090static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
David Howellscdf01222017-07-04 17:25:22 +010092const struct qstr empty_name = QSTR_INIT("", 0);
93EXPORT_SYMBOL(empty_name);
94const struct qstr slash_name = QSTR_INIT("/", 1);
95EXPORT_SYMBOL(slash_name);
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/*
98 * This is the single most critical data structure when it comes
99 * to the dcache: the hashtable for lookups. Somebody should try
100 * to make this good - I've just made it work.
101 *
102 * This hash-function tries to avoid losing too many bits of hash
103 * information, yet avoid using a prime hash-size or similar.
104 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800106static unsigned int d_hash_mask __read_mostly;
107static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700109static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110
Linus Torvalds8387ff22016-06-10 07:51:30 -0700111static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100112{
Alexey Dobriyan854d3e62017-11-20 18:05:07 +0300113 return dentry_hashtable + (hash >> d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100114}
115
Al Viro94bdd652016-04-15 02:42:04 -0400116#define IN_LOOKUP_SHIFT 10
117static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
118
119static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
120 unsigned int hash)
121{
122 hash += (unsigned long) parent / L1_CACHE_BYTES;
123 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
124}
125
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/* Statistics gathering. */
128struct dentry_stat_t dentry_stat = {
129 .age_limit = 45,
130};
131
Glauber Costa3942c072013-08-28 10:17:53 +1000132static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000133static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400134
135#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000136
137/*
138 * Here we resort to our own counters instead of using generic per-cpu counters
139 * for consistency with what the vfs inode code does. We are expected to harvest
140 * better code and performance by having our own specialized counters.
141 *
142 * Please note that the loop is done over all possible CPUs, not over all online
143 * CPUs. The reason for this is that we don't want to play games with CPUs going
144 * on and off. If one of them goes off, we will just keep their counters.
145 *
146 * glommer: See cffbc8a for details, and if you ever intend to change this,
147 * please update all vfs counters to match.
148 */
Glauber Costa3942c072013-08-28 10:17:53 +1000149static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100150{
151 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000152 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100153 for_each_possible_cpu(i)
154 sum += per_cpu(nr_dentry, i);
155 return sum < 0 ? 0 : sum;
156}
157
Dave Chinner62d36c72013-08-28 10:17:54 +1000158static long get_nr_dentry_unused(void)
159{
160 int i;
161 long sum = 0;
162 for_each_possible_cpu(i)
163 sum += per_cpu(nr_dentry_unused, i);
164 return sum < 0 ? 0 : sum;
165}
166
Joe Perches1f7e0612014-06-06 14:38:05 -0700167int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400168 size_t *lenp, loff_t *ppos)
169{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100170 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000171 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000172 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400173}
174#endif
175
Linus Torvalds5483f182012-03-04 15:51:42 -0800176/*
177 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
178 * The strings are both count bytes long, and count is non-zero.
179 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700180#ifdef CONFIG_DCACHE_WORD_ACCESS
181
182#include <asm/word-at-a-time.h>
183/*
184 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
185 * aligned allocation for this particular component. We don't
186 * strictly need the load_unaligned_zeropad() safety, but it
187 * doesn't hurt either.
188 *
189 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
190 * need the careful unaligned handling.
191 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700192static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800193{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800194 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195
196 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700197 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700198 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800199 if (tcount < sizeof(unsigned long))
200 break;
201 if (unlikely(a != b))
202 return 1;
203 cs += sizeof(unsigned long);
204 ct += sizeof(unsigned long);
205 tcount -= sizeof(unsigned long);
206 if (!tcount)
207 return 0;
208 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000209 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800210 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700211}
212
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800213#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700214
Linus Torvalds94753db52012-05-10 12:19:19 -0700215static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700216{
Linus Torvalds5483f182012-03-04 15:51:42 -0800217 do {
218 if (*cs != *ct)
219 return 1;
220 cs++;
221 ct++;
222 tcount--;
223 } while (tcount);
224 return 0;
225}
226
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700227#endif
228
Linus Torvalds94753db52012-05-10 12:19:19 -0700229static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
230{
Linus Torvalds94753db52012-05-10 12:19:19 -0700231 /*
232 * Be careful about RCU walk racing with rename:
Will Deacon506458e2017-10-24 11:22:48 +0100233 * use 'READ_ONCE' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700234 *
235 * NOTE! Even if a rename will mean that the length
236 * was not loaded atomically, we don't care. The
237 * RCU walk will check the sequence count eventually,
238 * and catch it. And we won't overrun the buffer,
239 * because we're reading the name pointer atomically,
240 * and a dentry name is guaranteed to be properly
241 * terminated with a NUL byte.
242 *
243 * End result: even if 'len' is wrong, we'll exit
244 * early because the data cannot match (there can
245 * be no NUL in the ct/tcount data)
246 */
Will Deacon506458e2017-10-24 11:22:48 +0100247 const unsigned char *cs = READ_ONCE(dentry->d_name.name);
He Kuangae0a8432016-03-26 09:12:10 +0000248
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700249 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700250}
251
Al Viro8d85b482014-09-29 14:54:27 -0400252struct external_name {
253 union {
254 atomic_t count;
255 struct rcu_head head;
256 } u;
257 unsigned char name[];
258};
259
260static inline struct external_name *external_name(struct dentry *dentry)
261{
262 return container_of(dentry->d_name.name, struct external_name, name[0]);
263}
264
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400265static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400267 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
268
Al Viro8d85b482014-09-29 14:54:27 -0400269 kmem_cache_free(dentry_cache, dentry);
270}
271
272static void __d_free_external(struct rcu_head *head)
273{
274 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400275 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 kmem_cache_free(dentry_cache, dentry);
277}
278
Al Viro810bb172014-10-12 12:45:37 -0400279static inline int dname_external(const struct dentry *dentry)
280{
281 return dentry->d_name.name != dentry->d_iname;
282}
283
Al Viro49d31c22017-07-07 14:51:19 -0400284void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
285{
286 spin_lock(&dentry->d_lock);
287 if (unlikely(dname_external(dentry))) {
288 struct external_name *p = external_name(dentry);
289 atomic_inc(&p->u.count);
290 spin_unlock(&dentry->d_lock);
291 name->name = p->name;
292 } else {
293 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
294 spin_unlock(&dentry->d_lock);
295 name->name = name->inline_name;
296 }
297}
298EXPORT_SYMBOL(take_dentry_name_snapshot);
299
300void release_dentry_name_snapshot(struct name_snapshot *name)
301{
302 if (unlikely(name->name != name->inline_name)) {
303 struct external_name *p;
304 p = container_of(name->name, struct external_name, name[0]);
305 if (unlikely(atomic_dec_and_test(&p->u.count)))
306 kfree_rcu(p, u.head);
307 }
308}
309EXPORT_SYMBOL(release_dentry_name_snapshot);
310
David Howells4bf46a22015-03-05 14:09:22 +0000311static inline void __d_set_inode_and_type(struct dentry *dentry,
312 struct inode *inode,
313 unsigned type_flags)
314{
315 unsigned flags;
316
317 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000318 flags = READ_ONCE(dentry->d_flags);
319 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
320 flags |= type_flags;
321 WRITE_ONCE(dentry->d_flags, flags);
322}
323
David Howells4bf46a22015-03-05 14:09:22 +0000324static inline void __d_clear_type_and_inode(struct dentry *dentry)
325{
326 unsigned flags = READ_ONCE(dentry->d_flags);
327
328 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
329 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000330 dentry->d_inode = NULL;
331}
332
Al Virob4f03542014-04-29 23:40:14 -0400333static void dentry_free(struct dentry *dentry)
334{
Al Viro946e51f2014-10-26 19:19:16 -0400335 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400336 if (unlikely(dname_external(dentry))) {
337 struct external_name *p = external_name(dentry);
338 if (likely(atomic_dec_and_test(&p->u.count))) {
339 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
340 return;
341 }
342 }
Al Virob4f03542014-04-29 23:40:14 -0400343 /* if dentry was never visible to RCU, immediate free is OK */
344 if (!(dentry->d_flags & DCACHE_RCUACCESS))
345 __d_free(&dentry->d_u.d_rcu);
346 else
347 call_rcu(&dentry->d_u.d_rcu, __d_free);
348}
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350/*
351 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400352 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100353 */
354static void dentry_unlink_inode(struct dentry * dentry)
355 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100356 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100357{
358 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400359 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500360
Al Viro550dce02016-05-29 20:13:30 -0400361 if (hashed)
362 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000363 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400364 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400365 if (hashed)
366 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100367 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100368 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100369 if (!inode->i_nlink)
370 fsnotify_inoderemove(inode);
371 if (dentry->d_op && dentry->d_op->d_iput)
372 dentry->d_op->d_iput(dentry, inode);
373 else
374 iput(inode);
375}
376
377/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400378 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
379 * is in use - which includes both the "real" per-superblock
380 * LRU list _and_ the DCACHE_SHRINK_LIST use.
381 *
382 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
383 * on the shrink list (ie not on the superblock LRU list).
384 *
385 * The per-cpu "nr_dentry_unused" counters are updated with
386 * the DCACHE_LRU_LIST bit.
387 *
388 * These helper functions make sure we always follow the
389 * rules. d_lock must be held by the caller.
390 */
391#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
392static void d_lru_add(struct dentry *dentry)
393{
394 D_FLAG_VERIFY(dentry, 0);
395 dentry->d_flags |= DCACHE_LRU_LIST;
396 this_cpu_inc(nr_dentry_unused);
397 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
398}
399
400static void d_lru_del(struct dentry *dentry)
401{
402 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
403 dentry->d_flags &= ~DCACHE_LRU_LIST;
404 this_cpu_dec(nr_dentry_unused);
405 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
406}
407
408static void d_shrink_del(struct dentry *dentry)
409{
410 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
411 list_del_init(&dentry->d_lru);
412 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
413 this_cpu_dec(nr_dentry_unused);
414}
415
416static void d_shrink_add(struct dentry *dentry, struct list_head *list)
417{
418 D_FLAG_VERIFY(dentry, 0);
419 list_add(&dentry->d_lru, list);
420 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
421 this_cpu_inc(nr_dentry_unused);
422}
423
424/*
425 * These can only be called under the global LRU lock, ie during the
426 * callback for freeing the LRU list. "isolate" removes it from the
427 * LRU lists entirely, while shrink_move moves it to the indicated
428 * private list.
429 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800430static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400431{
432 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
433 dentry->d_flags &= ~DCACHE_LRU_LIST;
434 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800435 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400436}
437
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800438static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
439 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400440{
441 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
442 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800443 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400444}
445
446/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000447 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700448 */
449static void dentry_lru_add(struct dentry *dentry)
450{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400451 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
452 d_lru_add(dentry);
Josef Bacik563f4002017-04-18 16:04:17 -0400453 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
454 dentry->d_flags |= DCACHE_REFERENCED;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700455}
456
Miklos Szeredid52b9082007-05-08 00:23:46 -0700457/**
Nick Piggin789680d2011-01-07 17:49:30 +1100458 * d_drop - drop a dentry
459 * @dentry: dentry to drop
460 *
461 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
462 * be found through a VFS lookup any more. Note that this is different from
463 * deleting the dentry - d_delete will try to mark the dentry negative if
464 * possible, giving a successful _negative_ lookup, while d_drop will
465 * just make the cache lookup fail.
466 *
467 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
468 * reason (NFS timeouts or autofs deletes).
469 *
470 * __d_drop requires dentry->d_lock.
471 */
472void __d_drop(struct dentry *dentry)
473{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700474 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400475 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400476 /*
477 * Hashed dentries are normally on the dentry hashtable,
478 * with the exception of those newly allocated by
NeilBrownf1ee6162017-12-21 09:45:40 +1100479 * d_obtain_root, which are always IS_ROOT:
J. Bruce Fields7632e462012-06-28 12:10:55 -0400480 */
481 if (unlikely(IS_ROOT(dentry)))
NeilBrownf1ee6162017-12-21 09:45:40 +1100482 b = &dentry->d_sb->s_roots;
Al Virob61625d2013-10-04 11:09:01 -0400483 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700484 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400485
486 hlist_bl_lock(b);
487 __hlist_bl_del(&dentry->d_hash);
488 dentry->d_hash.pprev = NULL;
489 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400490 /* After this call, in-progress rcu-walk path lookup will fail. */
491 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100492 }
493}
494EXPORT_SYMBOL(__d_drop);
495
496void d_drop(struct dentry *dentry)
497{
Nick Piggin789680d2011-01-07 17:49:30 +1100498 spin_lock(&dentry->d_lock);
499 __d_drop(dentry);
500 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100501}
502EXPORT_SYMBOL(d_drop);
503
Al Viroba65dc52016-06-10 11:32:47 -0400504static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
505{
506 struct dentry *next;
507 /*
508 * Inform d_walk() and shrink_dentry_list() that we are no longer
509 * attached to the dentry tree
510 */
511 dentry->d_flags |= DCACHE_DENTRY_KILLED;
512 if (unlikely(list_empty(&dentry->d_child)))
513 return;
514 __list_del_entry(&dentry->d_child);
515 /*
516 * Cursors can move around the list of children. While we'd been
517 * a normal list member, it didn't matter - ->d_child.next would've
518 * been updated. However, from now on it won't be and for the
519 * things like d_walk() it might end up with a nasty surprise.
520 * Normally d_walk() doesn't care about cursors moving around -
521 * ->d_lock on parent prevents that and since a cursor has no children
522 * of its own, we get through it without ever unlocking the parent.
523 * There is one exception, though - if we ascend from a child that
524 * gets killed as soon as we unlock it, the next sibling is found
525 * using the value left in its ->d_child.next. And if _that_
526 * pointed to a cursor, and cursor got moved (e.g. by lseek())
527 * before d_walk() regains parent->d_lock, we'll end up skipping
528 * everything the cursor had been moved past.
529 *
530 * Solution: make sure that the pointer left behind in ->d_child.next
531 * points to something that won't be moving around. I.e. skip the
532 * cursors.
533 */
534 while (dentry->d_child.next != &parent->d_subdirs) {
535 next = list_entry(dentry->d_child.next, struct dentry, d_child);
536 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
537 break;
538 dentry->d_child.next = next->d_child.next;
539 }
540}
541
Al Viroe55fd012014-05-28 13:51:12 -0400542static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100543{
Al Viro41edf2782014-05-01 10:30:00 -0400544 struct dentry *parent = NULL;
545 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400546 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100547 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100548
Linus Torvalds0d984392013-09-08 13:46:52 -0700549 /*
550 * The dentry is now unrecoverably dead to the world.
551 */
552 lockref_mark_dead(&dentry->d_lockref);
553
Sage Weilf0023bc2011-10-28 10:02:42 -0700554 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700555 * inform the fs via d_prune that this dentry is about to be
556 * unhashed and destroyed.
557 */
Al Viro29266202014-05-30 11:39:02 -0400558 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800559 dentry->d_op->d_prune(dentry);
560
Al Viro01b60352014-04-29 23:42:52 -0400561 if (dentry->d_flags & DCACHE_LRU_LIST) {
562 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
563 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400564 }
Nick Piggin77812a12011-01-07 17:49:48 +1100565 /* if it was on the hash then remove it */
566 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400567 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400568 if (parent)
569 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400570 if (dentry->d_inode)
571 dentry_unlink_inode(dentry);
572 else
573 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400574 this_cpu_dec(nr_dentry);
575 if (dentry->d_op && dentry->d_op->d_release)
576 dentry->d_op->d_release(dentry);
577
Al Viro41edf2782014-05-01 10:30:00 -0400578 spin_lock(&dentry->d_lock);
579 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
580 dentry->d_flags |= DCACHE_MAY_FREE;
581 can_free = false;
582 }
583 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400584 if (likely(can_free))
585 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400586}
587
588/*
589 * Finish off a dentry we've decided to kill.
590 * dentry->d_lock must be held, returns with it unlocked.
591 * If ref is non-zero, then decrement the refcount too.
592 * Returns dentry requiring refcount drop, or NULL if we're done.
593 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400594static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400595 __releases(dentry->d_lock)
596{
597 struct inode *inode = dentry->d_inode;
598 struct dentry *parent = NULL;
599
600 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
601 goto failed;
602
603 if (!IS_ROOT(dentry)) {
604 parent = dentry->d_parent;
605 if (unlikely(!spin_trylock(&parent->d_lock))) {
606 if (inode)
607 spin_unlock(&inode->i_lock);
608 goto failed;
609 }
610 }
611
612 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400613 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400614
615failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400616 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400617 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100618}
619
Al Viro046b9612014-05-29 08:54:52 -0400620static inline struct dentry *lock_parent(struct dentry *dentry)
621{
622 struct dentry *parent = dentry->d_parent;
623 if (IS_ROOT(dentry))
624 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800625 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400626 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400627 if (likely(spin_trylock(&parent->d_lock)))
628 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400629 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400630 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400631again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700632 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400633 spin_lock(&parent->d_lock);
634 /*
635 * We can't blindly lock dentry until we are sure
636 * that we won't violate the locking order.
637 * Any changes of dentry->d_parent must have
638 * been done with parent->d_lock held, so
639 * spin_lock() above is enough of a barrier
640 * for checking if it's still our child.
641 */
642 if (unlikely(parent != dentry->d_parent)) {
643 spin_unlock(&parent->d_lock);
644 goto again;
645 }
646 rcu_read_unlock();
647 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700648 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400649 else
650 parent = NULL;
651 return parent;
652}
653
Linus Torvalds360f5472015-01-09 15:19:03 -0800654/*
655 * Try to do a lockless dput(), and return whether that was successful.
656 *
657 * If unsuccessful, we return false, having already taken the dentry lock.
658 *
659 * The caller needs to hold the RCU read lock, so that the dentry is
660 * guaranteed to stay around even if the refcount goes down to zero!
661 */
662static inline bool fast_dput(struct dentry *dentry)
663{
664 int ret;
665 unsigned int d_flags;
666
667 /*
668 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100669 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800670 */
671 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
672 return lockref_put_or_lock(&dentry->d_lockref);
673
674 /*
675 * .. otherwise, we can try to just decrement the
676 * lockref optimistically.
677 */
678 ret = lockref_put_return(&dentry->d_lockref);
679
680 /*
681 * If the lockref_put_return() failed due to the lock being held
682 * by somebody else, the fast path has failed. We will need to
683 * get the lock, and then check the count again.
684 */
685 if (unlikely(ret < 0)) {
686 spin_lock(&dentry->d_lock);
687 if (dentry->d_lockref.count > 1) {
688 dentry->d_lockref.count--;
689 spin_unlock(&dentry->d_lock);
690 return 1;
691 }
692 return 0;
693 }
694
695 /*
696 * If we weren't the last ref, we're done.
697 */
698 if (ret)
699 return 1;
700
701 /*
702 * Careful, careful. The reference count went down
703 * to zero, but we don't hold the dentry lock, so
704 * somebody else could get it again, and do another
705 * dput(), and we need to not race with that.
706 *
707 * However, there is a very special and common case
708 * where we don't care, because there is nothing to
709 * do: the dentry is still hashed, it does not have
710 * a 'delete' op, and it's referenced and already on
711 * the LRU list.
712 *
713 * NOTE! Since we aren't locked, these values are
714 * not "stable". However, it is sufficient that at
715 * some point after we dropped the reference the
716 * dentry was hashed and the flags had the proper
717 * value. Other dentry users may have re-gotten
718 * a reference to the dentry and change that, but
719 * our work is done - we can leave the dentry
720 * around with a zero refcount.
721 */
722 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700723 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100724 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800725
726 /* Nothing to do? Dropping the reference was all we needed? */
727 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
728 return 1;
729
730 /*
731 * Not the fast normal case? Get the lock. We've already decremented
732 * the refcount, but we'll need to re-check the situation after
733 * getting the lock.
734 */
735 spin_lock(&dentry->d_lock);
736
737 /*
738 * Did somebody else grab a reference to it in the meantime, and
739 * we're no longer the last user after all? Alternatively, somebody
740 * else could have killed it and marked it dead. Either way, we
741 * don't need to do anything else.
742 */
743 if (dentry->d_lockref.count) {
744 spin_unlock(&dentry->d_lock);
745 return 1;
746 }
747
748 /*
749 * Re-get the reference we optimistically dropped. We hold the
750 * lock, and we just tested that it was zero, so we can just
751 * set it to 1.
752 */
753 dentry->d_lockref.count = 1;
754 return 0;
755}
756
757
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758/*
759 * This is dput
760 *
761 * This is complicated by the fact that we do not want to put
762 * dentries that are no longer on any hash chain on the unused
763 * list: we'd much rather just get rid of them immediately.
764 *
765 * However, that implies that we have to traverse the dentry
766 * tree upwards to the parents which might _also_ now be
767 * scheduled for deletion (it may have been only waiting for
768 * its last child to go away).
769 *
770 * This tail recursion is done by hand as we don't want to depend
771 * on the compiler to always get this right (gcc generally doesn't).
772 * Real recursion would eat up our stack space.
773 */
774
775/*
776 * dput - release a dentry
777 * @dentry: dentry to release
778 *
779 * Release a dentry. This will drop the usage count and if appropriate
780 * call the dentry unlink method as well as removing it from the queues and
781 * releasing its resources. If the parent dentries were scheduled for release
782 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784void dput(struct dentry *dentry)
785{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700786 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 return;
788
789repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800790 might_sleep();
791
Linus Torvalds360f5472015-01-09 15:19:03 -0800792 rcu_read_lock();
793 if (likely(fast_dput(dentry))) {
794 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800796 }
797
798 /* Slow case: now with the dentry lock held */
799 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Al Viro85c7f812016-04-14 19:52:13 -0400801 WARN_ON(d_in_lookup(dentry));
802
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700803 /* Unreachable? Get rid of it */
804 if (unlikely(d_unhashed(dentry)))
805 goto kill_it;
806
Al Viro75a6f822015-07-08 02:42:38 +0100807 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
808 goto kill_it;
809
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700810 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100812 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 }
Nick Piggin265ac902010-10-10 05:36:24 -0400814
Christoph Hellwiga4633352010-10-10 05:36:26 -0400815 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400816
Waiman Long98474232013-08-28 18:24:59 -0700817 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100818 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 return;
820
Miklos Szeredid52b9082007-05-08 00:23:46 -0700821kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400822 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800823 if (dentry) {
824 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700825 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800826 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700828EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100831/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100832static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
Waiman Long98474232013-08-28 18:24:59 -0700834 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Nick Piggindc0474b2011-01-07 17:49:43 +1100837static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100838{
Waiman Long98474232013-08-28 18:24:59 -0700839 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100840}
841
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100842struct dentry *dget_parent(struct dentry *dentry)
843{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700844 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100845 struct dentry *ret;
846
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700847 /*
848 * Do optimistic parent lookup without any
849 * locking.
850 */
851 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700852 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700853 gotref = lockref_get_not_zero(&ret->d_lockref);
854 rcu_read_unlock();
855 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700856 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700857 return ret;
858 dput(ret);
859 }
860
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100861repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100862 /*
863 * Don't need rcu_dereference because we re-check it was correct under
864 * the lock.
865 */
866 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100867 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100868 spin_lock(&ret->d_lock);
869 if (unlikely(ret != dentry->d_parent)) {
870 spin_unlock(&ret->d_lock);
871 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100872 goto repeat;
873 }
Nick Piggina734eb42011-01-07 17:49:44 +1100874 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700875 BUG_ON(!ret->d_lockref.count);
876 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100877 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100878 return ret;
879}
880EXPORT_SYMBOL(dget_parent);
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882/**
883 * d_find_alias - grab a hashed alias of inode
884 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 *
886 * If inode has a hashed alias, or is a directory and has any alias,
887 * acquire the reference to alias and return it. Otherwise return NULL.
888 * Notice that if inode is a directory there can be only one alias and
889 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800890 * of a filesystem, or if the directory was renamed and d_revalidate
891 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700893 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500894 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500896static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897{
Nick Pigginda502952011-01-07 17:49:33 +1100898 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Nick Pigginda502952011-01-07 17:49:33 +1100900again:
901 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400902 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100903 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700905 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100906 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500908 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100909 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100910 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 return alias;
912 }
913 }
Nick Pigginda502952011-01-07 17:49:33 +1100914 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 }
Nick Pigginda502952011-01-07 17:49:33 +1100916 if (discon_alias) {
917 alias = discon_alias;
918 spin_lock(&alias->d_lock);
919 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500920 __dget_dlock(alias);
921 spin_unlock(&alias->d_lock);
922 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100923 }
924 spin_unlock(&alias->d_lock);
925 goto again;
926 }
927 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928}
929
Nick Pigginda502952011-01-07 17:49:33 +1100930struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931{
David Howells214fda12006-03-25 03:06:36 -0800932 struct dentry *de = NULL;
933
Al Virob3d9b7a2012-06-09 13:51:19 -0400934 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100935 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500936 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100937 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800938 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 return de;
940}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700941EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
943/*
944 * Try to kill dentries associated with this inode.
945 * WARNING: you must own a reference to inode.
946 */
947void d_prune_aliases(struct inode *inode)
948{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700949 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100951 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400952 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700954 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400955 struct dentry *parent = lock_parent(dentry);
956 if (likely(!dentry->d_lockref.count)) {
957 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800958 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400959 goto restart;
960 }
961 if (parent)
962 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 }
964 spin_unlock(&dentry->d_lock);
965 }
Nick Piggin873feea2011-01-07 17:50:06 +1100966 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700968EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400970static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971{
Al Viro5c47e6d2014-04-29 16:13:18 -0400972 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700973
Miklos Szeredi60942f22014-05-02 15:38:39 -0400974 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400975 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400976 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100977 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400978 parent = lock_parent(dentry);
979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000981 * The dispose list is isolated and dentries are not accounted
982 * to the LRU here, so we can simply remove it from the list
983 * here regardless of whether it is referenced or not.
984 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400985 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000986
987 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000989 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800991 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700992 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400993 if (parent)
994 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 continue;
996 }
Nick Piggin77812a12011-01-07 17:49:48 +1100997
Al Viro64fd72e2014-05-28 09:48:44 -0400998
999 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1000 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1001 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001002 if (parent)
1003 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001004 if (can_free)
1005 dentry_free(dentry);
1006 continue;
1007 }
1008
Al Viroff2fde92014-05-28 13:59:13 -04001009 inode = dentry->d_inode;
1010 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001011 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001012 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001013 if (parent)
1014 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001015 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001016 }
Al Viroff2fde92014-05-28 13:59:13 -04001017
Al Viroff2fde92014-05-28 13:59:13 -04001018 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001019
Al Viro5c47e6d2014-04-29 16:13:18 -04001020 /*
1021 * We need to prune ancestors too. This is necessary to prevent
1022 * quadratic behavior of shrink_dcache_parent(), but is also
1023 * expected to be beneficial in reducing dentry cache
1024 * fragmentation.
1025 */
1026 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001027 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1028 parent = lock_parent(dentry);
1029 if (dentry->d_lockref.count != 1) {
1030 dentry->d_lockref.count--;
1031 spin_unlock(&dentry->d_lock);
1032 if (parent)
1033 spin_unlock(&parent->d_lock);
1034 break;
1035 }
1036 inode = dentry->d_inode; /* can't be NULL */
1037 if (unlikely(!spin_trylock(&inode->i_lock))) {
1038 spin_unlock(&dentry->d_lock);
1039 if (parent)
1040 spin_unlock(&parent->d_lock);
1041 cpu_relax();
1042 continue;
1043 }
1044 __dentry_kill(dentry);
1045 dentry = parent;
1046 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001048}
1049
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001050static enum lru_status dentry_lru_isolate(struct list_head *item,
1051 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001052{
1053 struct list_head *freeable = arg;
1054 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1055
1056
1057 /*
1058 * we are inverting the lru lock/dentry->d_lock here,
1059 * so use a trylock. If we fail to get the lock, just skip
1060 * it
1061 */
1062 if (!spin_trylock(&dentry->d_lock))
1063 return LRU_SKIP;
1064
1065 /*
1066 * Referenced dentries are still in use. If they have active
1067 * counts, just remove them from the LRU. Otherwise give them
1068 * another pass through the LRU.
1069 */
1070 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001071 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001072 spin_unlock(&dentry->d_lock);
1073 return LRU_REMOVED;
1074 }
1075
1076 if (dentry->d_flags & DCACHE_REFERENCED) {
1077 dentry->d_flags &= ~DCACHE_REFERENCED;
1078 spin_unlock(&dentry->d_lock);
1079
1080 /*
1081 * The list move itself will be made by the common LRU code. At
1082 * this point, we've dropped the dentry->d_lock but keep the
1083 * lru lock. This is safe to do, since every list movement is
1084 * protected by the lru lock even if both locks are held.
1085 *
1086 * This is guaranteed by the fact that all LRU management
1087 * functions are intermediated by the LRU API calls like
1088 * list_lru_add and list_lru_del. List movement in this file
1089 * only ever occur through this functions or through callbacks
1090 * like this one, that are called from the LRU API.
1091 *
1092 * The only exceptions to this are functions like
1093 * shrink_dentry_list, and code that first checks for the
1094 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1095 * operating only with stack provided lists after they are
1096 * properly isolated from the main list. It is thus, always a
1097 * local access.
1098 */
1099 return LRU_ROTATE;
1100 }
1101
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001102 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001103 spin_unlock(&dentry->d_lock);
1104
1105 return LRU_REMOVED;
1106}
1107
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001108/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001109 * prune_dcache_sb - shrink the dcache
1110 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001111 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001112 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001113 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1114 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001115 * function.
1116 *
1117 * This function may fail to free any resources if all the dentries are in
1118 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001119 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001120long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001121{
Dave Chinnerf6041562013-08-28 10:18:00 +10001122 LIST_HEAD(dispose);
1123 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001124
Vladimir Davydov503c3582015-02-12 14:58:47 -08001125 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1126 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001127 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001128 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129}
1130
Glauber Costa4e717f52013-08-28 10:18:03 +10001131static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001132 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001133{
Glauber Costa4e717f52013-08-28 10:18:03 +10001134 struct list_head *freeable = arg;
1135 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001136
Glauber Costa4e717f52013-08-28 10:18:03 +10001137 /*
1138 * we are inverting the lru lock/dentry->d_lock here,
1139 * so use a trylock. If we fail to get the lock, just skip
1140 * it
1141 */
1142 if (!spin_trylock(&dentry->d_lock))
1143 return LRU_SKIP;
1144
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001145 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001146 spin_unlock(&dentry->d_lock);
1147
1148 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001149}
1150
Glauber Costa4e717f52013-08-28 10:18:03 +10001151
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001152/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 * shrink_dcache_sb - shrink dcache for a superblock
1154 * @sb: superblock
1155 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001156 * Shrink the dcache for the specified super block. This is used to free
1157 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001159void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Glauber Costa4e717f52013-08-28 10:18:03 +10001161 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001162
Glauber Costa4e717f52013-08-28 10:18:03 +10001163 do {
1164 LIST_HEAD(dispose);
1165
1166 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001167 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001168
1169 this_cpu_sub(nr_dentry_unused, freed);
1170 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001171 cond_resched();
1172 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001174EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001177 * enum d_walk_ret - action to talke during tree walk
1178 * @D_WALK_CONTINUE: contrinue walk
1179 * @D_WALK_QUIT: quit walk
1180 * @D_WALK_NORETRY: quit when retry is needed
1181 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001183enum d_walk_ret {
1184 D_WALK_CONTINUE,
1185 D_WALK_QUIT,
1186 D_WALK_NORETRY,
1187 D_WALK_SKIP,
1188};
1189
1190/**
1191 * d_walk - walk the dentry tree
1192 * @parent: start of walk
1193 * @data: data passed to @enter() and @finish()
1194 * @enter: callback when first entering the dentry
1195 * @finish: callback when successfully finished the walk
1196 *
1197 * The @enter() and @finish() callbacks are called with d_lock held.
1198 */
1199static void d_walk(struct dentry *parent, void *data,
1200 enum d_walk_ret (*enter)(void *, struct dentry *),
1201 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Nick Piggin949854d2011-01-07 17:49:37 +11001203 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001205 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001206 enum d_walk_ret ret;
1207 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001208
Nick Piggin58db63d2011-01-07 17:49:39 +11001209again:
Al Viro48f5ec22013-09-09 15:22:25 -04001210 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001211 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001212 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001213
1214 ret = enter(data, this_parent);
1215 switch (ret) {
1216 case D_WALK_CONTINUE:
1217 break;
1218 case D_WALK_QUIT:
1219 case D_WALK_SKIP:
1220 goto out_unlock;
1221 case D_WALK_NORETRY:
1222 retry = false;
1223 break;
1224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225repeat:
1226 next = this_parent->d_subdirs.next;
1227resume:
1228 while (next != &this_parent->d_subdirs) {
1229 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001230 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001232
Al Viroba65dc52016-06-10 11:32:47 -04001233 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1234 continue;
1235
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001236 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001237
1238 ret = enter(data, dentry);
1239 switch (ret) {
1240 case D_WALK_CONTINUE:
1241 break;
1242 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001243 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001244 goto out_unlock;
1245 case D_WALK_NORETRY:
1246 retry = false;
1247 break;
1248 case D_WALK_SKIP:
1249 spin_unlock(&dentry->d_lock);
1250 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001251 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001254 spin_unlock(&this_parent->d_lock);
1255 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001257 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 goto repeat;
1259 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001260 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 }
1262 /*
1263 * All done at this level ... ascend and resume the search.
1264 */
Al Viroca5358e2014-10-26 19:31:10 -04001265 rcu_read_lock();
1266ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001268 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001269 this_parent = child->d_parent;
1270
Al Viro31dec132013-10-25 17:04:27 -04001271 spin_unlock(&child->d_lock);
1272 spin_lock(&this_parent->d_lock);
1273
Al Viroca5358e2014-10-26 19:31:10 -04001274 /* might go back up the wrong parent if we have had a rename. */
1275 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001276 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001277 /* go into the first sibling still alive */
1278 do {
1279 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001280 if (next == &this_parent->d_subdirs)
1281 goto ascend;
1282 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001283 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001284 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 goto resume;
1286 }
Al Viroca5358e2014-10-26 19:31:10 -04001287 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001288 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001289 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001290 if (finish)
1291 finish(data);
1292
1293out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001294 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001295 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001296 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001297
1298rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001299 spin_unlock(&this_parent->d_lock);
1300 rcu_read_unlock();
1301 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001302 if (!retry)
1303 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001304 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001305 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001307
Ian Kent01619492016-11-24 08:03:41 +11001308struct check_mount {
1309 struct vfsmount *mnt;
1310 unsigned int mounted;
1311};
1312
1313static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1314{
1315 struct check_mount *info = data;
1316 struct path path = { .mnt = info->mnt, .dentry = dentry };
1317
1318 if (likely(!d_mountpoint(dentry)))
1319 return D_WALK_CONTINUE;
1320 if (__path_is_mountpoint(&path)) {
1321 info->mounted = 1;
1322 return D_WALK_QUIT;
1323 }
1324 return D_WALK_CONTINUE;
1325}
1326
1327/**
1328 * path_has_submounts - check for mounts over a dentry in the
1329 * current namespace.
1330 * @parent: path to check.
1331 *
1332 * Return true if the parent or its subdirectories contain
1333 * a mount point in the current namespace.
1334 */
1335int path_has_submounts(const struct path *parent)
1336{
1337 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1338
1339 read_seqlock_excl(&mount_lock);
1340 d_walk(parent->dentry, &data, path_check_mount, NULL);
1341 read_sequnlock_excl(&mount_lock);
1342
1343 return data.mounted;
1344}
1345EXPORT_SYMBOL(path_has_submounts);
1346
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001348 * Called by mount code to set a mountpoint and check if the mountpoint is
1349 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1350 * subtree can become unreachable).
1351 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001352 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001353 * this reason take rename_lock and d_lock on dentry and ancestors.
1354 */
1355int d_set_mounted(struct dentry *dentry)
1356{
1357 struct dentry *p;
1358 int ret = -ENOENT;
1359 write_seqlock(&rename_lock);
1360 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001361 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001362 spin_lock(&p->d_lock);
1363 if (unlikely(d_unhashed(p))) {
1364 spin_unlock(&p->d_lock);
1365 goto out;
1366 }
1367 spin_unlock(&p->d_lock);
1368 }
1369 spin_lock(&dentry->d_lock);
1370 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001371 ret = -EBUSY;
1372 if (!d_mountpoint(dentry)) {
1373 dentry->d_flags |= DCACHE_MOUNTED;
1374 ret = 0;
1375 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001376 }
1377 spin_unlock(&dentry->d_lock);
1378out:
1379 write_sequnlock(&rename_lock);
1380 return ret;
1381}
1382
1383/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001384 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 * and move any unused dentries to the end of the unused
1386 * list for prune_dcache(). We descend to the next level
1387 * whenever the d_subdirs list is non-empty and continue
1388 * searching.
1389 *
1390 * It returns zero iff there are no unused children,
1391 * otherwise it returns the number of children moved to
1392 * the end of the unused list. This may not be the total
1393 * number of unused children, because select_parent can
1394 * drop the lock and return early due to latency
1395 * constraints.
1396 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001397
1398struct select_data {
1399 struct dentry *start;
1400 struct list_head dispose;
1401 int found;
1402};
1403
1404static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001406 struct select_data *data = _data;
1407 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001409 if (data->start == dentry)
1410 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Al Virofe915222014-05-03 00:02:25 -04001412 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001413 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001414 } else {
1415 if (dentry->d_flags & DCACHE_LRU_LIST)
1416 d_lru_del(dentry);
1417 if (!dentry->d_lockref.count) {
1418 d_shrink_add(dentry, &data->dispose);
1419 data->found++;
1420 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 }
1422 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001423 * We can return to the caller if we have found some (this
1424 * ensures forward progress). We'll be coming back to find
1425 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 */
Al Virofe915222014-05-03 00:02:25 -04001427 if (!list_empty(&data->dispose))
1428 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001430 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431}
1432
1433/**
1434 * shrink_dcache_parent - prune dcache
1435 * @parent: parent of entries to prune
1436 *
1437 * Prune the dcache to remove unused children of the parent dentry.
1438 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001439void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001441 for (;;) {
1442 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001444 INIT_LIST_HEAD(&data.dispose);
1445 data.start = parent;
1446 data.found = 0;
1447
1448 d_walk(parent, &data, select_collect, NULL);
1449 if (!data.found)
1450 break;
1451
1452 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001453 cond_resched();
1454 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001456EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Al Viro9c8c10e2014-05-02 20:36:10 -04001458static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001459{
Al Viro9c8c10e2014-05-02 20:36:10 -04001460 /* it has busy descendents; complain about those instead */
1461 if (!list_empty(&dentry->d_subdirs))
1462 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001463
Al Viro9c8c10e2014-05-02 20:36:10 -04001464 /* root with refcount 1 is fine */
1465 if (dentry == _data && dentry->d_lockref.count == 1)
1466 return D_WALK_CONTINUE;
1467
1468 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1469 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001470 dentry,
1471 dentry->d_inode ?
1472 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001473 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001474 dentry->d_lockref.count,
1475 dentry->d_sb->s_type->name,
1476 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001477 WARN_ON(1);
1478 return D_WALK_CONTINUE;
1479}
1480
1481static void do_one_tree(struct dentry *dentry)
1482{
1483 shrink_dcache_parent(dentry);
1484 d_walk(dentry, dentry, umount_check, NULL);
1485 d_drop(dentry);
1486 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001487}
1488
1489/*
1490 * destroy the dentries attached to a superblock on unmounting
1491 */
1492void shrink_dcache_for_umount(struct super_block *sb)
1493{
1494 struct dentry *dentry;
1495
Al Viro9c8c10e2014-05-02 20:36:10 -04001496 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001497
1498 dentry = sb->s_root;
1499 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001500 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001501
NeilBrownf1ee6162017-12-21 09:45:40 +11001502 while (!hlist_bl_empty(&sb->s_roots)) {
1503 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001504 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001505 }
1506}
1507
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001508struct detach_data {
1509 struct select_data select;
1510 struct dentry *mountpoint;
1511};
1512static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001513{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001514 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001515
1516 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001517 __dget_dlock(dentry);
1518 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001519 return D_WALK_QUIT;
1520 }
1521
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001522 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001523}
1524
1525static void check_and_drop(void *_data)
1526{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001527 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001528
Al Viro81be24d2017-06-03 07:20:09 +01001529 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001530 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001531}
1532
1533/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001534 * d_invalidate - detach submounts, prune dcache, and drop
1535 * @dentry: dentry to invalidate (aka detach, prune and drop)
1536 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001537 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001539 * The final d_drop is done as an atomic operation relative to
1540 * rename_lock ensuring there are no races with d_set_mounted. This
1541 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001542 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001543void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001544{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001545 /*
1546 * If it's already been dropped, return OK.
1547 */
1548 spin_lock(&dentry->d_lock);
1549 if (d_unhashed(dentry)) {
1550 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001551 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001552 }
1553 spin_unlock(&dentry->d_lock);
1554
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555 /* Negative dentries can be dropped without further checks */
1556 if (!dentry->d_inode) {
1557 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001558 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001559 }
1560
1561 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001562 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001563
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001564 data.mountpoint = NULL;
1565 INIT_LIST_HEAD(&data.select.dispose);
1566 data.select.start = dentry;
1567 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001568
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001569 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001570
Al Viro81be24d2017-06-03 07:20:09 +01001571 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001572 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001573 else if (!data.mountpoint)
1574 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001576 if (data.mountpoint) {
1577 detach_mounts(data.mountpoint);
1578 dput(data.mountpoint);
1579 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001580 cond_resched();
1581 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001582}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001583EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001584
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585/**
Al Viroa4464db2011-07-07 15:03:58 -04001586 * __d_alloc - allocate a dcache entry
1587 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 * @name: qstr of the name
1589 *
1590 * Allocates a dentry. It returns %NULL if there is insufficient memory
1591 * available. On a success the dentry is returned. The name passed in is
1592 * copied and the copy passed in may be reused after this call.
1593 */
1594
Al Viroa4464db2011-07-07 15:03:58 -04001595struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
1597 struct dentry *dentry;
1598 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001599 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Mel Gormane12ba742007-10-16 01:25:52 -07001601 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 if (!dentry)
1603 return NULL;
1604
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001605 /*
1606 * We guarantee that the inline name is always NUL-terminated.
1607 * This way the memcpy() done by the name switching in rename
1608 * will still always have a NUL at the end, even if we might
1609 * be overwriting an internal NUL character
1610 */
1611 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001612 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001613 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001614 dname = dentry->d_iname;
1615 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001616 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001617 struct external_name *p = kmalloc(size + name->len,
1618 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001619 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 kmem_cache_free(dentry_cache, dentry);
1621 return NULL;
1622 }
Al Viro8d85b482014-09-29 14:54:27 -04001623 atomic_set(&p->u.count, 1);
1624 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001625 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1626 kasan_unpoison_shadow(dname,
1627 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 } else {
1629 dname = dentry->d_iname;
1630 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
1632 dentry->d_name.len = name->len;
1633 dentry->d_name.hash = name->hash;
1634 memcpy(dname, name->name, name->len);
1635 dname[name->len] = 0;
1636
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001637 /* Make sure we always see the terminating NUL character */
1638 smp_wmb();
1639 dentry->d_name.name = dname;
1640
Waiman Long98474232013-08-28 18:24:59 -07001641 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001642 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001644 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001646 dentry->d_parent = dentry;
1647 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 dentry->d_op = NULL;
1649 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001650 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 INIT_LIST_HEAD(&dentry->d_lru);
1652 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001653 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1654 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001655 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Miklos Szeredi285b1022016-06-28 11:47:32 +02001657 if (dentry->d_op && dentry->d_op->d_init) {
1658 err = dentry->d_op->d_init(dentry);
1659 if (err) {
1660 if (dname_external(dentry))
1661 kfree(external_name(dentry));
1662 kmem_cache_free(dentry_cache, dentry);
1663 return NULL;
1664 }
1665 }
1666
Nick Piggin3e880fb2011-01-07 17:49:19 +11001667 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 return dentry;
1670}
Al Viroa4464db2011-07-07 15:03:58 -04001671
1672/**
1673 * d_alloc - allocate a dcache entry
1674 * @parent: parent of entry to allocate
1675 * @name: qstr of the name
1676 *
1677 * Allocates a dentry. It returns %NULL if there is insufficient memory
1678 * available. On a success the dentry is returned. The name passed in is
1679 * copied and the copy passed in may be reused after this call.
1680 */
1681struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1682{
1683 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1684 if (!dentry)
1685 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001686 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001687 spin_lock(&parent->d_lock);
1688 /*
1689 * don't need child lock because it is not subject
1690 * to concurrency here
1691 */
1692 __dget_dlock(parent);
1693 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001694 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001695 spin_unlock(&parent->d_lock);
1696
1697 return dentry;
1698}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001699EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Al Viroba65dc52016-06-10 11:32:47 -04001701struct dentry *d_alloc_cursor(struct dentry * parent)
1702{
1703 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1704 if (dentry) {
1705 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1706 dentry->d_parent = dget(parent);
1707 }
1708 return dentry;
1709}
1710
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001711/**
1712 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1713 * @sb: the superblock
1714 * @name: qstr of the name
1715 *
1716 * For a filesystem that just pins its dentries in memory and never
1717 * performs lookups at all, return an unhashed IS_ROOT dentry.
1718 */
Nick Piggin4b936882011-01-07 17:50:07 +11001719struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1720{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001721 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001722}
1723EXPORT_SYMBOL(d_alloc_pseudo);
1724
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1726{
1727 struct qstr q;
1728
1729 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001730 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 return d_alloc(parent, &q);
1732}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001733EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Nick Pigginfb045ad2011-01-07 17:49:55 +11001735void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1736{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001737 WARN_ON_ONCE(dentry->d_op);
1738 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001739 DCACHE_OP_COMPARE |
1740 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001741 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001742 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001743 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001744 dentry->d_op = op;
1745 if (!op)
1746 return;
1747 if (op->d_hash)
1748 dentry->d_flags |= DCACHE_OP_HASH;
1749 if (op->d_compare)
1750 dentry->d_flags |= DCACHE_OP_COMPARE;
1751 if (op->d_revalidate)
1752 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001753 if (op->d_weak_revalidate)
1754 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001755 if (op->d_delete)
1756 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001757 if (op->d_prune)
1758 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001759 if (op->d_real)
1760 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001761
1762}
1763EXPORT_SYMBOL(d_set_d_op);
1764
David Howellsdf1a0852015-01-29 12:02:28 +00001765
1766/*
1767 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1768 * @dentry - The dentry to mark
1769 *
1770 * Mark a dentry as falling through to the lower layer (as set with
1771 * d_pin_lower()). This flag may be recorded on the medium.
1772 */
1773void d_set_fallthru(struct dentry *dentry)
1774{
1775 spin_lock(&dentry->d_lock);
1776 dentry->d_flags |= DCACHE_FALLTHRU;
1777 spin_unlock(&dentry->d_lock);
1778}
1779EXPORT_SYMBOL(d_set_fallthru);
1780
David Howellsb18825a2013-09-12 19:22:53 +01001781static unsigned d_flags_for_inode(struct inode *inode)
1782{
David Howells44bdb5e2015-01-29 12:02:29 +00001783 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001784
1785 if (!inode)
1786 return DCACHE_MISS_TYPE;
1787
1788 if (S_ISDIR(inode->i_mode)) {
1789 add_flags = DCACHE_DIRECTORY_TYPE;
1790 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1791 if (unlikely(!inode->i_op->lookup))
1792 add_flags = DCACHE_AUTODIR_TYPE;
1793 else
1794 inode->i_opflags |= IOP_LOOKUP;
1795 }
David Howells44bdb5e2015-01-29 12:02:29 +00001796 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001797 }
1798
David Howells44bdb5e2015-01-29 12:02:29 +00001799 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001800 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001801 add_flags = DCACHE_SYMLINK_TYPE;
1802 goto type_determined;
1803 }
1804 inode->i_opflags |= IOP_NOFOLLOW;
1805 }
1806
1807 if (unlikely(!S_ISREG(inode->i_mode)))
1808 add_flags = DCACHE_SPECIAL_TYPE;
1809
1810type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001811 if (unlikely(IS_AUTOMOUNT(inode)))
1812 add_flags |= DCACHE_NEED_AUTOMOUNT;
1813 return add_flags;
1814}
1815
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001816static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1817{
David Howellsb18825a2013-09-12 19:22:53 +01001818 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001819 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001820
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001821 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001822 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001823 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001824 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001825 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001826 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001827 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001828}
1829
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830/**
1831 * d_instantiate - fill in inode information for a dentry
1832 * @entry: dentry to complete
1833 * @inode: inode to attach to this dentry
1834 *
1835 * Fill in inode information in the entry.
1836 *
1837 * This turns negative dentries into productive full members
1838 * of society.
1839 *
1840 * NOTE! This assumes that the inode count has been incremented
1841 * (or otherwise set) by the caller to indicate that it is now
1842 * in use by the dcache.
1843 */
1844
1845void d_instantiate(struct dentry *entry, struct inode * inode)
1846{
Al Viro946e51f2014-10-26 19:19:16 -04001847 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001848 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001849 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001850 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001851 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001852 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001853 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001855EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
1857/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001858 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1859 * @entry: dentry to complete
1860 * @inode: inode to attach to this dentry
1861 *
1862 * Fill in inode information in the entry. If a directory alias is found, then
1863 * return an error (and drop inode). Together with d_materialise_unique() this
1864 * guarantees that a directory inode may never have more than one alias.
1865 */
1866int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1867{
Al Viro946e51f2014-10-26 19:19:16 -04001868 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001869
Al Virob9680912016-04-11 00:53:26 -04001870 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001871 spin_lock(&inode->i_lock);
1872 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1873 spin_unlock(&inode->i_lock);
1874 iput(inode);
1875 return -EBUSY;
1876 }
1877 __d_instantiate(entry, inode);
1878 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001879
1880 return 0;
1881}
1882EXPORT_SYMBOL(d_instantiate_no_diralias);
1883
Al Viroadc0e91a2012-01-08 16:49:21 -05001884struct dentry *d_make_root(struct inode *root_inode)
1885{
1886 struct dentry *res = NULL;
1887
1888 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001889 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e91a2012-01-08 16:49:21 -05001890 if (res)
1891 d_instantiate(res, root_inode);
1892 else
1893 iput(root_inode);
1894 }
1895 return res;
1896}
1897EXPORT_SYMBOL(d_make_root);
1898
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001899static struct dentry * __d_find_any_alias(struct inode *inode)
1900{
1901 struct dentry *alias;
1902
Al Virob3d9b7a2012-06-09 13:51:19 -04001903 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001904 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001905 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001906 __dget(alias);
1907 return alias;
1908}
1909
Sage Weil46f72b32012-01-10 09:04:37 -08001910/**
1911 * d_find_any_alias - find any alias for a given inode
1912 * @inode: inode to find an alias for
1913 *
1914 * If any aliases exist for the given inode, take and return a
1915 * reference for one of them. If no aliases exist, return %NULL.
1916 */
1917struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001918{
1919 struct dentry *de;
1920
1921 spin_lock(&inode->i_lock);
1922 de = __d_find_any_alias(inode);
1923 spin_unlock(&inode->i_lock);
1924 return de;
1925}
Sage Weil46f72b32012-01-10 09:04:37 -08001926EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001927
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001928static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001929{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001930 struct dentry *tmp;
1931 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001932 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001933
1934 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001935 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001936 if (IS_ERR(inode))
1937 return ERR_CAST(inode);
1938
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001939 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001940 if (res)
1941 goto out_iput;
1942
Al Viro798434b2016-03-24 20:38:43 -04001943 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001944 if (!tmp) {
1945 res = ERR_PTR(-ENOMEM);
1946 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001947 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001948
Al Virob9680912016-04-11 00:53:26 -04001949 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001950 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001951 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001952 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001953 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001954 dput(tmp);
1955 goto out_iput;
1956 }
1957
1958 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001959 add_flags = d_flags_for_inode(inode);
1960
1961 if (disconnected)
1962 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001963
Christoph Hellwig9308a612008-08-11 15:49:12 +02001964 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001965 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001966 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
NeilBrownf1ee6162017-12-21 09:45:40 +11001967 if (!disconnected) {
1968 hlist_bl_lock(&tmp->d_sb->s_roots);
1969 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_roots);
1970 hlist_bl_unlock(&tmp->d_sb->s_roots);
1971 }
Christoph Hellwig9308a612008-08-11 15:49:12 +02001972 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001973 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001974
Christoph Hellwig9308a612008-08-11 15:49:12 +02001975 return tmp;
1976
1977 out_iput:
1978 iput(inode);
1979 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001980}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001981
1982/**
1983 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1984 * @inode: inode to allocate the dentry for
1985 *
1986 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1987 * similar open by handle operations. The returned dentry may be anonymous,
1988 * or may have a full name (if the inode was already in the cache).
1989 *
1990 * When called on a directory inode, we must ensure that the inode only ever
1991 * has one dentry. If a dentry is found, that is returned instead of
1992 * allocating a new one.
1993 *
1994 * On successful return, the reference to the inode has been transferred
1995 * to the dentry. In case of an error the reference on the inode is released.
1996 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1997 * be passed in and the error will be propagated to the return value,
1998 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1999 */
2000struct dentry *d_obtain_alias(struct inode *inode)
2001{
2002 return __d_obtain_alias(inode, 1);
2003}
Benny Halevyadc48722009-02-27 14:02:59 -08002004EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
2006/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002007 * d_obtain_root - find or allocate a dentry for a given inode
2008 * @inode: inode to allocate the dentry for
2009 *
2010 * Obtain an IS_ROOT dentry for the root of a filesystem.
2011 *
2012 * We must ensure that directory inodes only ever have one dentry. If a
2013 * dentry is found, that is returned instead of allocating a new one.
2014 *
2015 * On successful return, the reference to the inode has been transferred
2016 * to the dentry. In case of an error the reference on the inode is
2017 * released. A %NULL or IS_ERR inode may be passed in and will be the
2018 * error will be propagate to the return value, with a %NULL @inode
2019 * replaced by ERR_PTR(-ESTALE).
2020 */
2021struct dentry *d_obtain_root(struct inode *inode)
2022{
2023 return __d_obtain_alias(inode, 0);
2024}
2025EXPORT_SYMBOL(d_obtain_root);
2026
2027/**
Barry Naujok94035402008-05-21 16:50:46 +10002028 * d_add_ci - lookup or allocate new dentry with case-exact name
2029 * @inode: the inode case-insensitive lookup has found
2030 * @dentry: the negative dentry that was passed to the parent's lookup func
2031 * @name: the case-exact name to be associated with the returned dentry
2032 *
2033 * This is to avoid filling the dcache with case-insensitive names to the
2034 * same inode, only the actual correct case is stored in the dcache for
2035 * case-insensitive filesystems.
2036 *
2037 * For a case-insensitive lookup match and if the the case-exact dentry
2038 * already exists in in the dcache, use it and return it.
2039 *
2040 * If no entry exists with the exact case name, allocate new dentry with
2041 * the exact case, and return the spliced entry.
2042 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002043struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002044 struct qstr *name)
2045{
Al Virod9171b92016-04-15 03:33:13 -04002046 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002047
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002048 /*
2049 * First check if a dentry matching the name already exists,
2050 * if not go ahead and create it now.
2051 */
Barry Naujok94035402008-05-21 16:50:46 +10002052 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002053 if (found) {
2054 iput(inode);
2055 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002056 }
Al Virod9171b92016-04-15 03:33:13 -04002057 if (d_in_lookup(dentry)) {
2058 found = d_alloc_parallel(dentry->d_parent, name,
2059 dentry->d_wait);
2060 if (IS_ERR(found) || !d_in_lookup(found)) {
2061 iput(inode);
2062 return found;
2063 }
2064 } else {
2065 found = d_alloc(dentry->d_parent, name);
2066 if (!found) {
2067 iput(inode);
2068 return ERR_PTR(-ENOMEM);
2069 }
2070 }
2071 res = d_splice_alias(inode, found);
2072 if (res) {
2073 dput(found);
2074 return res;
2075 }
Al Viro4f522a22013-02-11 23:20:37 -05002076 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002077}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002078EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002080
Al Virod4c91a82016-06-25 23:33:49 -04002081static inline bool d_same_name(const struct dentry *dentry,
2082 const struct dentry *parent,
2083 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002084{
Al Virod4c91a82016-06-25 23:33:49 -04002085 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2086 if (dentry->d_name.len != name->len)
2087 return false;
2088 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002089 }
Al Viro6fa67e72016-07-31 16:37:25 -04002090 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002091 dentry->d_name.len, dentry->d_name.name,
2092 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002093}
2094
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 * __d_lookup_rcu - search for a dentry (racy, store-free)
2097 * @parent: parent dentry
2098 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002099 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002100 * Returns: dentry, or NULL
2101 *
2102 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2103 * resolution (store-free path walking) design described in
2104 * Documentation/filesystems/path-lookup.txt.
2105 *
2106 * This is not to be used outside core vfs.
2107 *
2108 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2109 * held, and rcu_read_lock held. The returned dentry must not be stored into
2110 * without taking d_lock and checking d_seq sequence count against @seq
2111 * returned here.
2112 *
Linus Torvalds15570082013-09-02 11:38:06 -07002113 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002114 * function.
2115 *
2116 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2117 * the returned dentry, so long as its parent's seqlock is checked after the
2118 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2119 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002120 *
2121 * NOTE! The caller *has* to check the resulting dentry against the sequence
2122 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002123 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002124struct dentry *__d_lookup_rcu(const struct dentry *parent,
2125 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002126 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002127{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002128 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002129 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002130 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002131 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002132 struct dentry *dentry;
2133
2134 /*
2135 * Note: There is significant duplication with __d_lookup_rcu which is
2136 * required to prevent single threaded performance regressions
2137 * especially on architectures where smp_rmb (in seqcounts) are costly.
2138 * Keep the two functions in sync.
2139 */
2140
2141 /*
2142 * The hash list is protected using RCU.
2143 *
2144 * Carefully use d_seq when comparing a candidate dentry, to avoid
2145 * races with d_move().
2146 *
2147 * It is possible that concurrent renames can mess up our list
2148 * walk here and result in missing our dentry, resulting in the
2149 * false-negative result. d_lookup() protects against concurrent
2150 * renames using rename_lock seqlock.
2151 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002152 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002153 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002154 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002155 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002156
Nick Piggin31e6b012011-01-07 17:49:52 +11002157seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002158 /*
2159 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002160 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002161 *
2162 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002163 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002164 *
2165 * NOTE! We do a "raw" seqcount_begin here. That means that
2166 * we don't wait for the sequence count to stabilize if it
2167 * is in the middle of a sequence change. If we do the slow
2168 * dentry compare, we will do seqretries until it is stable,
2169 * and if we end up with a successful lookup, we actually
2170 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002171 *
2172 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2173 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002174 */
2175 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002176 if (dentry->d_parent != parent)
2177 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002178 if (d_unhashed(dentry))
2179 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002180
2181 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002182 int tlen;
2183 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002184 if (dentry->d_name.hash != hashlen_hash(hashlen))
2185 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002186 tlen = dentry->d_name.len;
2187 tname = dentry->d_name.name;
2188 /* we want a consistent (name,len) pair */
2189 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2190 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002191 goto seqretry;
2192 }
Al Viro6fa67e72016-07-31 16:37:25 -04002193 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002194 tlen, tname, name) != 0)
2195 continue;
2196 } else {
2197 if (dentry->d_name.hash_len != hashlen)
2198 continue;
2199 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2200 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002201 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002202 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002203 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002204 }
2205 return NULL;
2206}
2207
2208/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 * d_lookup - search for a dentry
2210 * @parent: parent dentry
2211 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002212 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002214 * d_lookup searches the children of the parent dentry for the name in
2215 * question. If the dentry is found its reference count is incremented and the
2216 * dentry is returned. The caller must use dput to free the entry when it has
2217 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 */
Al Viroda2d8452013-01-24 18:29:34 -05002219struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220{
Nick Piggin31e6b012011-01-07 17:49:52 +11002221 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002222 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
Daeseok Younb8314f92014-08-11 11:46:53 +09002224 do {
2225 seq = read_seqbegin(&rename_lock);
2226 dentry = __d_lookup(parent, name);
2227 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 break;
2229 } while (read_seqretry(&rename_lock, seq));
2230 return dentry;
2231}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002232EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233
Nick Piggin31e6b012011-01-07 17:49:52 +11002234/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002235 * __d_lookup - search for a dentry (racy)
2236 * @parent: parent dentry
2237 * @name: qstr of name we wish to find
2238 * Returns: dentry, or NULL
2239 *
2240 * __d_lookup is like d_lookup, however it may (rarely) return a
2241 * false-negative result due to unrelated rename activity.
2242 *
2243 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2244 * however it must be used carefully, eg. with a following d_lookup in
2245 * the case of failure.
2246 *
2247 * __d_lookup callers must be commented.
2248 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002249struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002252 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002253 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002254 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002255 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
Nick Pigginb04f7842010-08-18 04:37:34 +10002257 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002258 * Note: There is significant duplication with __d_lookup_rcu which is
2259 * required to prevent single threaded performance regressions
2260 * especially on architectures where smp_rmb (in seqcounts) are costly.
2261 * Keep the two functions in sync.
2262 */
2263
2264 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002265 * The hash list is protected using RCU.
2266 *
2267 * Take d_lock when comparing a candidate dentry, to avoid races
2268 * with d_move().
2269 *
2270 * It is possible that concurrent renames can mess up our list
2271 * walk here and result in missing our dentry, resulting in the
2272 * false-negative result. d_lookup() protects against concurrent
2273 * renames using rename_lock seqlock.
2274 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002275 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002276 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 rcu_read_lock();
2278
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002279 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 if (dentry->d_name.hash != hash)
2282 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
2284 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 if (dentry->d_parent != parent)
2286 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002287 if (d_unhashed(dentry))
2288 goto next;
2289
Al Virod4c91a82016-06-25 23:33:49 -04002290 if (!d_same_name(dentry, parent, name))
2291 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292
Waiman Long98474232013-08-28 18:24:59 -07002293 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002294 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 spin_unlock(&dentry->d_lock);
2296 break;
2297next:
2298 spin_unlock(&dentry->d_lock);
2299 }
2300 rcu_read_unlock();
2301
2302 return found;
2303}
2304
2305/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002306 * d_hash_and_lookup - hash the qstr then search for a dentry
2307 * @dir: Directory to search in
2308 * @name: qstr of name we wish to find
2309 *
Al Viro4f522a22013-02-11 23:20:37 -05002310 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002311 */
2312struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2313{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002314 /*
2315 * Check for a fs-specific hash function. Note that we must
2316 * calculate the standard hash first, as the d_op->d_hash()
2317 * routine may choose to leave the hash value unchanged.
2318 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002319 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002320 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002321 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002322 if (unlikely(err < 0))
2323 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002324 }
Al Viro4f522a22013-02-11 23:20:37 -05002325 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002326}
Al Viro4f522a22013-02-11 23:20:37 -05002327EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002328
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329/*
2330 * When a file is deleted, we have two options:
2331 * - turn this dentry into a negative dentry
2332 * - unhash this dentry and free it.
2333 *
2334 * Usually, we want to just turn this into
2335 * a negative dentry, but if anybody else is
2336 * currently using the dentry or the inode
2337 * we can't do that and we fall back on removing
2338 * it from the hash queues and waiting for
2339 * it to be deleted later when it has no users
2340 */
2341
2342/**
2343 * d_delete - delete a dentry
2344 * @dentry: The dentry to delete
2345 *
2346 * Turn the dentry into a negative dentry if possible, otherwise
2347 * remove it from the hash queues so it can be deleted later
2348 */
2349
2350void d_delete(struct dentry * dentry)
2351{
Nick Piggin873feea2011-01-07 17:50:06 +11002352 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002353 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 /*
2355 * Are we the only user?
2356 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002357again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002359 inode = dentry->d_inode;
2360 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002361 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002362 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002363 spin_unlock(&dentry->d_lock);
2364 cpu_relax();
2365 goto again;
2366 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002367 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002368 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002369 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 return;
2371 }
2372
2373 if (!d_unhashed(dentry))
2374 __d_drop(dentry);
2375
2376 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002377
2378 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002380EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381
Al Viro15d3c582016-07-29 17:45:21 -04002382static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383{
Al Viro15d3c582016-07-29 17:45:21 -04002384 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002385 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002386 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002387 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002388 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389}
2390
2391/**
2392 * d_rehash - add an entry back to the hash
2393 * @entry: dentry to add to the hash
2394 *
2395 * Adds a dentry to the hash according to its name.
2396 */
2397
2398void d_rehash(struct dentry * entry)
2399{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002401 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002404EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
Al Viro84e710d2016-04-15 00:58:55 -04002406static inline unsigned start_dir_add(struct inode *dir)
2407{
2408
2409 for (;;) {
2410 unsigned n = dir->i_dir_seq;
2411 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2412 return n;
2413 cpu_relax();
2414 }
2415}
2416
2417static inline void end_dir_add(struct inode *dir, unsigned n)
2418{
2419 smp_store_release(&dir->i_dir_seq, n + 2);
2420}
2421
Al Virod9171b92016-04-15 03:33:13 -04002422static void d_wait_lookup(struct dentry *dentry)
2423{
2424 if (d_in_lookup(dentry)) {
2425 DECLARE_WAITQUEUE(wait, current);
2426 add_wait_queue(dentry->d_wait, &wait);
2427 do {
2428 set_current_state(TASK_UNINTERRUPTIBLE);
2429 spin_unlock(&dentry->d_lock);
2430 schedule();
2431 spin_lock(&dentry->d_lock);
2432 } while (d_in_lookup(dentry));
2433 }
2434}
2435
Al Viro94bdd652016-04-15 02:42:04 -04002436struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002437 const struct qstr *name,
2438 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002439{
Al Viro94bdd652016-04-15 02:42:04 -04002440 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002441 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2442 struct hlist_bl_node *node;
2443 struct dentry *new = d_alloc(parent, name);
2444 struct dentry *dentry;
2445 unsigned seq, r_seq, d_seq;
2446
2447 if (unlikely(!new))
2448 return ERR_PTR(-ENOMEM);
2449
2450retry:
2451 rcu_read_lock();
2452 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2453 r_seq = read_seqbegin(&rename_lock);
2454 dentry = __d_lookup_rcu(parent, name, &d_seq);
2455 if (unlikely(dentry)) {
2456 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2457 rcu_read_unlock();
2458 goto retry;
2459 }
2460 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2461 rcu_read_unlock();
2462 dput(dentry);
2463 goto retry;
2464 }
2465 rcu_read_unlock();
2466 dput(new);
2467 return dentry;
2468 }
2469 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2470 rcu_read_unlock();
2471 goto retry;
2472 }
2473 hlist_bl_lock(b);
2474 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2475 hlist_bl_unlock(b);
2476 rcu_read_unlock();
2477 goto retry;
2478 }
Al Viro94bdd652016-04-15 02:42:04 -04002479 /*
2480 * No changes for the parent since the beginning of d_lookup().
2481 * Since all removals from the chain happen with hlist_bl_lock(),
2482 * any potential in-lookup matches are going to stay here until
2483 * we unlock the chain. All fields are stable in everything
2484 * we encounter.
2485 */
2486 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2487 if (dentry->d_name.hash != hash)
2488 continue;
2489 if (dentry->d_parent != parent)
2490 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002491 if (!d_same_name(dentry, parent, name))
2492 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002493 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002494 /* now we can try to grab a reference */
2495 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2496 rcu_read_unlock();
2497 goto retry;
2498 }
2499
2500 rcu_read_unlock();
2501 /*
2502 * somebody is likely to be still doing lookup for it;
2503 * wait for them to finish
2504 */
Al Virod9171b92016-04-15 03:33:13 -04002505 spin_lock(&dentry->d_lock);
2506 d_wait_lookup(dentry);
2507 /*
2508 * it's not in-lookup anymore; in principle we should repeat
2509 * everything from dcache lookup, but it's likely to be what
2510 * d_lookup() would've found anyway. If it is, just return it;
2511 * otherwise we really have to repeat the whole thing.
2512 */
2513 if (unlikely(dentry->d_name.hash != hash))
2514 goto mismatch;
2515 if (unlikely(dentry->d_parent != parent))
2516 goto mismatch;
2517 if (unlikely(d_unhashed(dentry)))
2518 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002519 if (unlikely(!d_same_name(dentry, parent, name)))
2520 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002521 /* OK, it *is* a hashed match; return it */
2522 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002523 dput(new);
2524 return dentry;
2525 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002526 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002527 /* we can't take ->d_lock here; it's OK, though. */
2528 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002529 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002530 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2531 hlist_bl_unlock(b);
2532 return new;
Al Virod9171b92016-04-15 03:33:13 -04002533mismatch:
2534 spin_unlock(&dentry->d_lock);
2535 dput(dentry);
2536 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002537}
2538EXPORT_SYMBOL(d_alloc_parallel);
2539
Al Viro85c7f812016-04-14 19:52:13 -04002540void __d_lookup_done(struct dentry *dentry)
2541{
Al Viro94bdd652016-04-15 02:42:04 -04002542 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2543 dentry->d_name.hash);
2544 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002545 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002546 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002547 wake_up_all(dentry->d_wait);
2548 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002549 hlist_bl_unlock(b);
2550 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002551 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002552}
2553EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002554
2555/* inode->i_lock held if inode is non-NULL */
2556
2557static inline void __d_add(struct dentry *dentry, struct inode *inode)
2558{
Al Viro84e710d2016-04-15 00:58:55 -04002559 struct inode *dir = NULL;
2560 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002561 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002562 if (unlikely(d_in_lookup(dentry))) {
2563 dir = dentry->d_parent->d_inode;
2564 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002565 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002566 }
Al Viroed782b52016-03-09 19:52:39 -05002567 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002568 unsigned add_flags = d_flags_for_inode(inode);
2569 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2570 raw_write_seqcount_begin(&dentry->d_seq);
2571 __d_set_inode_and_type(dentry, inode, add_flags);
2572 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002573 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002574 }
Al Viro15d3c582016-07-29 17:45:21 -04002575 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002576 if (dir)
2577 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002578 spin_unlock(&dentry->d_lock);
2579 if (inode)
2580 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002581}
2582
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002583/**
Al Viro34d0d192016-03-08 21:01:03 -05002584 * d_add - add dentry to hash queues
2585 * @entry: dentry to add
2586 * @inode: The inode to attach to this dentry
2587 *
2588 * This adds the entry to the hash queues and initializes @inode.
2589 * The entry was actually filled in earlier during d_alloc().
2590 */
2591
2592void d_add(struct dentry *entry, struct inode *inode)
2593{
Al Virob9680912016-04-11 00:53:26 -04002594 if (inode) {
2595 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002596 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002597 }
Al Viroed782b52016-03-09 19:52:39 -05002598 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002599}
2600EXPORT_SYMBOL(d_add);
2601
2602/**
Al Viro668d0cd2016-03-08 12:44:17 -05002603 * d_exact_alias - find and hash an exact unhashed alias
2604 * @entry: dentry to add
2605 * @inode: The inode to go with this dentry
2606 *
2607 * If an unhashed dentry with the same name/parent and desired
2608 * inode already exists, hash and return it. Otherwise, return
2609 * NULL.
2610 *
2611 * Parent directory should be locked.
2612 */
2613struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2614{
2615 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002616 unsigned int hash = entry->d_name.hash;
2617
2618 spin_lock(&inode->i_lock);
2619 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2620 /*
2621 * Don't need alias->d_lock here, because aliases with
2622 * d_parent == entry->d_parent are not subject to name or
2623 * parent changes, because the parent inode i_mutex is held.
2624 */
2625 if (alias->d_name.hash != hash)
2626 continue;
2627 if (alias->d_parent != entry->d_parent)
2628 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002629 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002630 continue;
2631 spin_lock(&alias->d_lock);
2632 if (!d_unhashed(alias)) {
2633 spin_unlock(&alias->d_lock);
2634 alias = NULL;
2635 } else {
2636 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002637 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002638 spin_unlock(&alias->d_lock);
2639 }
2640 spin_unlock(&inode->i_lock);
2641 return alias;
2642 }
2643 spin_unlock(&inode->i_lock);
2644 return NULL;
2645}
2646EXPORT_SYMBOL(d_exact_alias);
2647
2648/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002649 * dentry_update_name_case - update case insensitive dentry with a new name
2650 * @dentry: dentry to be updated
2651 * @name: new name
2652 *
2653 * Update a case insensitive dentry with new case of name.
2654 *
2655 * dentry must have been returned by d_lookup with name @name. Old and new
2656 * name lengths must match (ie. no d_compare which allows mismatched name
2657 * lengths).
2658 *
2659 * Parent inode i_mutex must be held over d_lookup and into this call (to
2660 * keep renames and concurrent inserts, and readdir(2) away).
2661 */
Al Viro9aba36d2016-07-20 22:28:45 -04002662void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002663{
Al Viro59551022016-01-22 15:40:57 -05002664 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002665 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2666
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002667 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002668 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002669 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002670 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002671 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002672}
2673EXPORT_SYMBOL(dentry_update_name_case);
2674
Al Viro8d85b482014-09-29 14:54:27 -04002675static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676{
Al Viro8d85b482014-09-29 14:54:27 -04002677 if (unlikely(dname_external(target))) {
2678 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 /*
2680 * Both external: swap the pointers
2681 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002682 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 } else {
2684 /*
2685 * dentry:internal, target:external. Steal target's
2686 * storage and make target internal.
2687 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002688 memcpy(target->d_iname, dentry->d_name.name,
2689 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 dentry->d_name.name = target->d_name.name;
2691 target->d_name.name = target->d_iname;
2692 }
2693 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002694 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695 /*
2696 * dentry:external, target:internal. Give dentry's
2697 * storage to target and make dentry internal
2698 */
2699 memcpy(dentry->d_iname, target->d_name.name,
2700 target->d_name.len + 1);
2701 target->d_name.name = dentry->d_name.name;
2702 dentry->d_name.name = dentry->d_iname;
2703 } else {
2704 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002705 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002707 unsigned int i;
2708 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2709 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2710 swap(((long *) &dentry->d_iname)[i],
2711 ((long *) &target->d_iname)[i]);
2712 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 }
2714 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002715 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716}
2717
Al Viro8d85b482014-09-29 14:54:27 -04002718static void copy_name(struct dentry *dentry, struct dentry *target)
2719{
2720 struct external_name *old_name = NULL;
2721 if (unlikely(dname_external(dentry)))
2722 old_name = external_name(dentry);
2723 if (unlikely(dname_external(target))) {
2724 atomic_inc(&external_name(target)->u.count);
2725 dentry->d_name = target->d_name;
2726 } else {
2727 memcpy(dentry->d_iname, target->d_name.name,
2728 target->d_name.len + 1);
2729 dentry->d_name.name = dentry->d_iname;
2730 dentry->d_name.hash_len = target->d_name.hash_len;
2731 }
2732 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2733 kfree_rcu(old_name, u.head);
2734}
2735
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002736static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2737{
2738 /*
2739 * XXXX: do we really need to take target->d_lock?
2740 */
2741 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2742 spin_lock(&target->d_parent->d_lock);
2743 else {
2744 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2745 spin_lock(&dentry->d_parent->d_lock);
2746 spin_lock_nested(&target->d_parent->d_lock,
2747 DENTRY_D_LOCK_NESTED);
2748 } else {
2749 spin_lock(&target->d_parent->d_lock);
2750 spin_lock_nested(&dentry->d_parent->d_lock,
2751 DENTRY_D_LOCK_NESTED);
2752 }
2753 }
2754 if (target < dentry) {
2755 spin_lock_nested(&target->d_lock, 2);
2756 spin_lock_nested(&dentry->d_lock, 3);
2757 } else {
2758 spin_lock_nested(&dentry->d_lock, 2);
2759 spin_lock_nested(&target->d_lock, 3);
2760 }
2761}
2762
Al Viro986c01942014-09-26 23:11:15 -04002763static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002764{
2765 if (target->d_parent != dentry->d_parent)
2766 spin_unlock(&dentry->d_parent->d_lock);
2767 if (target->d_parent != target)
2768 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002769 spin_unlock(&target->d_lock);
2770 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002771}
2772
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002774 * When switching names, the actual string doesn't strictly have to
2775 * be preserved in the target - because we're dropping the target
2776 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002777 * the new name before we switch, unless we are going to rehash
2778 * it. Note that if we *do* unhash the target, we are not allowed
2779 * to rehash it without giving it a new name/hash key - whether
2780 * we swap or overwrite the names here, resulting name won't match
2781 * the reality in filesystem; it's only there for d_path() purposes.
2782 * Note that all of this is happening under rename_lock, so the
2783 * any hash lookup seeing it in the middle of manipulations will
2784 * be discarded anyway. So we do not care what happens to the hash
2785 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002787/*
Al Viro18367502011-07-12 21:42:24 -04002788 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 * @dentry: entry to move
2790 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002791 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 *
2793 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002794 * dcache entries should not be moved in this way. Caller must hold
2795 * rename_lock, the i_mutex of the source and target directories,
2796 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002798static void __d_move(struct dentry *dentry, struct dentry *target,
2799 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800{
Al Viro84e710d2016-04-15 00:58:55 -04002801 struct inode *dir = NULL;
2802 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 if (!dentry->d_inode)
2804 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2805
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002806 BUG_ON(d_ancestor(dentry, target));
2807 BUG_ON(d_ancestor(target, dentry));
2808
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002809 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002810 if (unlikely(d_in_lookup(target))) {
2811 dir = target->d_parent->d_inode;
2812 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002813 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815
Nick Piggin31e6b012011-01-07 17:49:52 +11002816 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002817 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002818
Al Viro15d3c582016-07-29 17:45:21 -04002819 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002820 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002821 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 __d_drop(target);
2823
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002825 if (exchange)
2826 swap_names(dentry, target);
2827 else
2828 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829
Al Viro15d3c582016-07-29 17:45:21 -04002830 /* rehash in new place(s) */
2831 __d_rehash(dentry);
2832 if (exchange)
2833 __d_rehash(target);
2834
Al Viro63cf4272014-09-26 23:06:14 -04002835 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002837 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002838 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839 dentry->d_parent = target->d_parent;
2840 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002841 list_del_init(&target->d_child);
2842 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002844 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002845 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002846 list_move(&target->d_child, &target->d_parent->d_subdirs);
2847 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002848 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002849 fsnotify_update_flags(target);
2850 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851 }
2852
Nick Piggin31e6b012011-01-07 17:49:52 +11002853 write_seqcount_end(&target->d_seq);
2854 write_seqcount_end(&dentry->d_seq);
2855
Al Viro84e710d2016-04-15 00:58:55 -04002856 if (dir)
2857 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002858 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002859}
2860
2861/*
2862 * d_move - move a dentry
2863 * @dentry: entry to move
2864 * @target: new dentry
2865 *
2866 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002867 * dcache entries should not be moved in this way. See the locking
2868 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002869 */
2870void d_move(struct dentry *dentry, struct dentry *target)
2871{
2872 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002873 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002875}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002876EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877
Miklos Szeredida1ce062014-04-01 17:08:43 +02002878/*
2879 * d_exchange - exchange two dentries
2880 * @dentry1: first dentry
2881 * @dentry2: second dentry
2882 */
2883void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2884{
2885 write_seqlock(&rename_lock);
2886
2887 WARN_ON(!dentry1->d_inode);
2888 WARN_ON(!dentry2->d_inode);
2889 WARN_ON(IS_ROOT(dentry1));
2890 WARN_ON(IS_ROOT(dentry2));
2891
2892 __d_move(dentry1, dentry2, true);
2893
2894 write_sequnlock(&rename_lock);
2895}
2896
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002897/**
2898 * d_ancestor - search for an ancestor
2899 * @p1: ancestor dentry
2900 * @p2: child dentry
2901 *
2902 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2903 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002904 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002905struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002906{
2907 struct dentry *p;
2908
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002909 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002911 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002912 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002913 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914}
2915
2916/*
2917 * This helper attempts to cope with remotely renamed directories
2918 *
2919 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002920 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002921 *
2922 * Note: If ever the locking in lock_rename() changes, then please
2923 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002924 */
Al Virob5ae6b12014-10-12 22:16:02 -04002925static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002926 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002927{
Al Viro9902af72016-04-15 15:08:36 -04002928 struct mutex *m1 = NULL;
2929 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002930 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002931
2932 /* If alias and dentry share a parent, then no extra locks required */
2933 if (alias->d_parent == dentry->d_parent)
2934 goto out_unalias;
2935
Trond Myklebust9eaef272006-10-21 10:24:20 -07002936 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002937 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2938 goto out_err;
2939 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002940 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002941 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002942 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002943out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002944 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002945 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002946out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002947 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002948 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002949 if (m1)
2950 mutex_unlock(m1);
2951 return ret;
2952}
2953
David Howells770bfad2006-08-22 20:06:07 -04002954/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002955 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2956 * @inode: the inode which may have a disconnected dentry
2957 * @dentry: a negative dentry which we want to point to the inode.
2958 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002959 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2960 * place of the given dentry and return it, else simply d_add the inode
2961 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002962 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002963 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2964 * we should error out: directories can't have multiple aliases.
2965 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002966 * This is needed in the lookup routine of any filesystem that is exportable
2967 * (via knfsd) so that we can build dcache paths to directories effectively.
2968 *
2969 * If a dentry was found and moved, then it is returned. Otherwise NULL
2970 * is returned. This matches the expected return value of ->lookup.
2971 *
2972 * Cluster filesystems may call this function with a negative, hashed dentry.
2973 * In that case, we know that the inode will be a regular file, and also this
2974 * will only occur during atomic_open. So we need to check for the dentry
2975 * being already hashed only in the final case.
2976 */
2977struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2978{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002979 if (IS_ERR(inode))
2980 return ERR_CAST(inode);
2981
David Howells770bfad2006-08-22 20:06:07 -04002982 BUG_ON(!d_unhashed(dentry));
2983
Al Virode689f52016-03-09 18:05:42 -05002984 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002985 goto out;
Al Virode689f52016-03-09 18:05:42 -05002986
Al Virob9680912016-04-11 00:53:26 -04002987 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002988 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002989 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002990 struct dentry *new = __d_find_any_alias(inode);
2991 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002992 /* The reference to new ensures it remains an alias */
2993 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002994 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002995 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002996 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002997 dput(new);
2998 new = ERR_PTR(-ELOOP);
2999 pr_warn_ratelimited(
3000 "VFS: Lookup of '%s' in %s %s"
3001 " would have caused loop\n",
3002 dentry->d_name.name,
3003 inode->i_sb->s_type->name,
3004 inode->i_sb->s_id);
3005 } else if (!IS_ROOT(new)) {
3006 int err = __d_unalias(inode, dentry, new);
3007 write_sequnlock(&rename_lock);
3008 if (err) {
3009 dput(new);
3010 new = ERR_PTR(err);
3011 }
Al Viro18367502011-07-12 21:42:24 -04003012 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003013 __d_move(new, dentry, false);
3014 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003015 }
Al Virob5ae6b12014-10-12 22:16:02 -04003016 iput(inode);
3017 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003018 }
David Howells770bfad2006-08-22 20:06:07 -04003019 }
Al Virob5ae6b12014-10-12 22:16:02 -04003020out:
Al Viroed782b52016-03-09 19:52:39 -05003021 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003022 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003023}
Al Virob5ae6b12014-10-12 22:16:02 -04003024EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003025
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003026static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003027{
3028 *buflen -= namelen;
3029 if (*buflen < 0)
3030 return -ENAMETOOLONG;
3031 *buffer -= namelen;
3032 memcpy(*buffer, str, namelen);
3033 return 0;
3034}
3035
Waiman Long232d2d62013-09-09 12:18:13 -04003036/**
3037 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003038 * @buffer: buffer pointer
3039 * @buflen: allocated length of the buffer
3040 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003041 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003042 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003043 * make sure that either the old or the new name pointer and length are
3044 * fetched. However, there may be mismatch between length and pointer.
3045 * The length cannot be trusted, we need to copy it byte-by-byte until
3046 * the length is reached or a null byte is found. It also prepends "/" at
3047 * the beginning of the name. The sequence number check at the caller will
3048 * retry it again when a d_move() does happen. So any garbage in the buffer
3049 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003050 *
3051 * Data dependency barrier is needed to make sure that we see that terminating
3052 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003053 */
Al Viro9aba36d2016-07-20 22:28:45 -04003054static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003055{
Mark Rutland66702eb2017-10-23 14:07:14 -07003056 const char *dname = READ_ONCE(name->name);
3057 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003058 char *p;
3059
Al Viro6d13f692014-09-29 14:46:30 -04003060 smp_read_barrier_depends();
3061
Waiman Long232d2d62013-09-09 12:18:13 -04003062 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003063 if (*buflen < 0)
3064 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003065 p = *buffer -= dlen + 1;
3066 *p++ = '/';
3067 while (dlen--) {
3068 char c = *dname++;
3069 if (!c)
3070 break;
3071 *p++ = c;
3072 }
3073 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003074}
3075
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003077 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003078 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003079 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003080 * @buffer: pointer to the end of the buffer
3081 * @buflen: pointer to buffer length
3082 *
Waiman Long18129972013-09-12 10:55:35 -04003083 * The function will first try to write out the pathname without taking any
3084 * lock other than the RCU read lock to make sure that dentries won't go away.
3085 * It only checks the sequence number of the global rename_lock as any change
3086 * in the dentry's d_seq will be preceded by changes in the rename_lock
3087 * sequence number. If the sequence number had been changed, it will restart
3088 * the whole pathname back-tracing sequence again by taking the rename_lock.
3089 * In this case, there is no need to take the RCU read lock as the recursive
3090 * parent pointer references will keep the dentry chain alive as long as no
3091 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003092 */
Al Viro02125a82011-12-05 08:43:34 -05003093static int prepend_path(const struct path *path,
3094 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003095 char **buffer, int *buflen)
3096{
Al Viroede4ceb2013-11-13 07:45:40 -05003097 struct dentry *dentry;
3098 struct vfsmount *vfsmnt;
3099 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003100 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003101 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003102 char *bptr;
3103 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003104
Al Viro48f5ec22013-09-09 15:22:25 -04003105 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003106restart_mnt:
3107 read_seqbegin_or_lock(&mount_lock, &m_seq);
3108 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003109 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003110restart:
3111 bptr = *buffer;
3112 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003113 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003114 dentry = path->dentry;
3115 vfsmnt = path->mnt;
3116 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003117 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003118 while (dentry != root->dentry || vfsmnt != root->mnt) {
3119 struct dentry * parent;
3120
3121 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003122 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003123 /* Escaped? */
3124 if (dentry != vfsmnt->mnt_root) {
3125 bptr = *buffer;
3126 blen = *buflen;
3127 error = 3;
3128 break;
3129 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003130 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003131 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003132 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003133 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003134 vfsmnt = &mnt->mnt;
3135 continue;
3136 }
Waiman Long232d2d62013-09-09 12:18:13 -04003137 if (!error)
3138 error = is_mounted(vfsmnt) ? 1 : 2;
3139 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003140 }
3141 parent = dentry->d_parent;
3142 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003143 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003144 if (error)
3145 break;
3146
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003147 dentry = parent;
3148 }
Al Viro48f5ec22013-09-09 15:22:25 -04003149 if (!(seq & 1))
3150 rcu_read_unlock();
3151 if (need_seqretry(&rename_lock, seq)) {
3152 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003153 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003154 }
Al Viro48f5ec22013-09-09 15:22:25 -04003155 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003156
3157 if (!(m_seq & 1))
3158 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003159 if (need_seqretry(&mount_lock, m_seq)) {
3160 m_seq = 1;
3161 goto restart_mnt;
3162 }
3163 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003164
Waiman Long232d2d62013-09-09 12:18:13 -04003165 if (error >= 0 && bptr == *buffer) {
3166 if (--blen < 0)
3167 error = -ENAMETOOLONG;
3168 else
3169 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003170 }
Waiman Long232d2d62013-09-09 12:18:13 -04003171 *buffer = bptr;
3172 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003173 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003174}
3175
3176/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003177 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003178 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003179 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003180 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003181 * @buflen: buffer length
3182 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003183 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003185 * Returns a pointer into the buffer or an error code if the
3186 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003187 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003188 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003189 *
Al Viro02125a82011-12-05 08:43:34 -05003190 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191 */
Al Viro02125a82011-12-05 08:43:34 -05003192char *__d_path(const struct path *path,
3193 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003194 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003196 char *res = buf + buflen;
3197 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003199 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003200 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003201
Al Viro02125a82011-12-05 08:43:34 -05003202 if (error < 0)
3203 return ERR_PTR(error);
3204 if (error > 0)
3205 return NULL;
3206 return res;
3207}
3208
3209char *d_absolute_path(const struct path *path,
3210 char *buf, int buflen)
3211{
3212 struct path root = {};
3213 char *res = buf + buflen;
3214 int error;
3215
3216 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003217 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003218
3219 if (error > 1)
3220 error = -EINVAL;
3221 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003222 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003223 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224}
3225
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003226/*
3227 * same as __d_path but appends "(deleted)" for unlinked files.
3228 */
Al Viro02125a82011-12-05 08:43:34 -05003229static int path_with_deleted(const struct path *path,
3230 const struct path *root,
3231 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003232{
3233 prepend(buf, buflen, "\0", 1);
3234 if (d_unlinked(path->dentry)) {
3235 int error = prepend(buf, buflen, " (deleted)", 10);
3236 if (error)
3237 return error;
3238 }
3239
3240 return prepend_path(path, root, buf, buflen);
3241}
3242
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003243static int prepend_unreachable(char **buffer, int *buflen)
3244{
3245 return prepend(buffer, buflen, "(unreachable)", 13);
3246}
3247
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003248static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3249{
3250 unsigned seq;
3251
3252 do {
3253 seq = read_seqcount_begin(&fs->seq);
3254 *root = fs->root;
3255 } while (read_seqcount_retry(&fs->seq, seq));
3256}
3257
Jan Bluncka03a8a702008-02-14 19:38:32 -08003258/**
3259 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003260 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003261 * @buf: buffer to return value in
3262 * @buflen: buffer length
3263 *
3264 * Convert a dentry into an ASCII path name. If the entry has been deleted
3265 * the string " (deleted)" is appended. Note that this is ambiguous.
3266 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003267 * Returns a pointer into the buffer or an error code if the path was
3268 * too long. Note: Callers should use the returned pointer, not the passed
3269 * in buffer, to use the name! The implementation often starts at an offset
3270 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003271 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003272 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003273 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003274char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003276 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003277 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003278 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003280 /*
3281 * We have various synthetic filesystems that never get mounted. On
3282 * these filesystems dentries are never used for lookup purposes, and
3283 * thus don't need to be hashed. They also don't need a name until a
3284 * user wants to identify the object in /proc/pid/fd/. The little hack
3285 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003286 *
3287 * Some pseudo inodes are mountable. When they are mounted
3288 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3289 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003290 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003291 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3292 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003293 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003294
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003295 rcu_read_lock();
3296 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003297 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003298 rcu_read_unlock();
3299
Al Viro02125a82011-12-05 08:43:34 -05003300 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003301 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302 return res;
3303}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003304EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305
3306/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003307 * Helper function for dentry_operations.d_dname() members
3308 */
3309char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3310 const char *fmt, ...)
3311{
3312 va_list args;
3313 char temp[64];
3314 int sz;
3315
3316 va_start(args, fmt);
3317 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3318 va_end(args);
3319
3320 if (sz > sizeof(temp) || sz > buflen)
3321 return ERR_PTR(-ENAMETOOLONG);
3322
3323 buffer += buflen - sz;
3324 return memcpy(buffer, temp, sz);
3325}
3326
Al Viro118b2302013-08-24 12:08:17 -04003327char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3328{
3329 char *end = buffer + buflen;
3330 /* these dentries are never renamed, so d_lock is not needed */
3331 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003332 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003333 prepend(&end, &buflen, "/", 1))
3334 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003335 return end;
Al Viro118b2302013-08-24 12:08:17 -04003336}
David Herrmann31bbe162014-01-03 14:09:47 +01003337EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003338
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003339/*
Ram Pai6092d042008-03-27 13:06:20 +01003340 * Write full pathname from the root of the filesystem into the buffer.
3341 */
Al Virof6500802014-01-26 12:37:55 -05003342static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003343{
Al Virof6500802014-01-26 12:37:55 -05003344 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003345 char *end, *retval;
3346 int len, seq = 0;
3347 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003348
Al Virof6500802014-01-26 12:37:55 -05003349 if (buflen < 2)
3350 goto Elong;
3351
Al Viro48f5ec22013-09-09 15:22:25 -04003352 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003353restart:
Al Virof6500802014-01-26 12:37:55 -05003354 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003355 end = buf + buflen;
3356 len = buflen;
3357 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003358 /* Get '/' right */
3359 retval = end-1;
3360 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003361 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003362 while (!IS_ROOT(dentry)) {
3363 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003364
Ram Pai6092d042008-03-27 13:06:20 +01003365 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003366 error = prepend_name(&end, &len, &dentry->d_name);
3367 if (error)
3368 break;
Ram Pai6092d042008-03-27 13:06:20 +01003369
3370 retval = end;
3371 dentry = parent;
3372 }
Al Viro48f5ec22013-09-09 15:22:25 -04003373 if (!(seq & 1))
3374 rcu_read_unlock();
3375 if (need_seqretry(&rename_lock, seq)) {
3376 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003377 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003378 }
3379 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003380 if (error)
3381 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003382 return retval;
3383Elong:
3384 return ERR_PTR(-ENAMETOOLONG);
3385}
Nick Pigginec2447c2011-01-07 17:49:29 +11003386
3387char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3388{
Waiman Long232d2d62013-09-09 12:18:13 -04003389 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003390}
3391EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003392
3393char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3394{
3395 char *p = NULL;
3396 char *retval;
3397
Al Viroc1031352010-06-06 22:31:14 -04003398 if (d_unlinked(dentry)) {
3399 p = buf + buflen;
3400 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3401 goto Elong;
3402 buflen++;
3403 }
3404 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003405 if (!IS_ERR(retval) && p)
3406 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003407 return retval;
3408Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003409 return ERR_PTR(-ENAMETOOLONG);
3410}
3411
Linus Torvalds8b19e342013-09-12 10:35:47 -07003412static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3413 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003414{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003415 unsigned seq;
3416
3417 do {
3418 seq = read_seqcount_begin(&fs->seq);
3419 *root = fs->root;
3420 *pwd = fs->pwd;
3421 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003422}
3423
Ram Pai6092d042008-03-27 13:06:20 +01003424/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425 * NOTE! The user-level library version returns a
3426 * character pointer. The kernel system call just
3427 * returns the length of the buffer filled (which
3428 * includes the ending '\0' character), or a negative
3429 * error value. So libc would do something like
3430 *
3431 * char *getcwd(char * buf, size_t size)
3432 * {
3433 * int retval;
3434 *
3435 * retval = sys_getcwd(buf, size);
3436 * if (retval >= 0)
3437 * return buf;
3438 * errno = -retval;
3439 * return NULL;
3440 * }
3441 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003442SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003443{
Linus Torvalds552ce542007-02-13 12:08:18 -08003444 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003445 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003446 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003447
3448 if (!page)
3449 return -ENOMEM;
3450
Linus Torvalds8b19e342013-09-12 10:35:47 -07003451 rcu_read_lock();
3452 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453
Linus Torvalds552ce542007-02-13 12:08:18 -08003454 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003455 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003456 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003457 char *cwd = page + PATH_MAX;
3458 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003459
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003460 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003461 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003462 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003463
Al Viro02125a82011-12-05 08:43:34 -05003464 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003465 goto out;
3466
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003467 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003468 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003469 error = prepend_unreachable(&cwd, &buflen);
3470 if (error)
3471 goto out;
3472 }
3473
Linus Torvalds552ce542007-02-13 12:08:18 -08003474 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003475 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003476 if (len <= size) {
3477 error = len;
3478 if (copy_to_user(buf, cwd, len))
3479 error = -EFAULT;
3480 }
Nick Piggin949854d2011-01-07 17:49:37 +11003481 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003482 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003484
3485out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003486 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487 return error;
3488}
3489
3490/*
3491 * Test whether new_dentry is a subdirectory of old_dentry.
3492 *
3493 * Trivially implemented using the dcache structure
3494 */
3495
3496/**
3497 * is_subdir - is new dentry a subdirectory of old_dentry
3498 * @new_dentry: new dentry
3499 * @old_dentry: old dentry
3500 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003501 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3502 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3504 */
3505
Yaowei Baia6e57872015-11-17 14:40:11 +08003506bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507{
Yaowei Baia6e57872015-11-17 14:40:11 +08003508 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003509 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003511 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003512 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003513
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003514 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003517 /*
3518 * Need rcu_readlock to protect against the d_parent trashing
3519 * due to d_move
3520 */
3521 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003522 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003523 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003524 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003525 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003526 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003528
3529 return result;
3530}
3531
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003532static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003533{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003534 struct dentry *root = data;
3535 if (dentry != root) {
3536 if (d_unhashed(dentry) || !dentry->d_inode)
3537 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003538
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003539 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3540 dentry->d_flags |= DCACHE_GENOCIDE;
3541 dentry->d_lockref.count--;
3542 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003543 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003544 return D_WALK_CONTINUE;
3545}
Nick Piggin58db63d2011-01-07 17:49:39 +11003546
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003547void d_genocide(struct dentry *parent)
3548{
3549 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550}
3551
Al Viro60545d02013-06-07 01:20:27 -04003552void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553{
Al Viro60545d02013-06-07 01:20:27 -04003554 inode_dec_link_count(inode);
3555 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003556 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003557 !d_unlinked(dentry));
3558 spin_lock(&dentry->d_parent->d_lock);
3559 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3560 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3561 (unsigned long long)inode->i_ino);
3562 spin_unlock(&dentry->d_lock);
3563 spin_unlock(&dentry->d_parent->d_lock);
3564 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565}
Al Viro60545d02013-06-07 01:20:27 -04003566EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003567
3568static __initdata unsigned long dhash_entries;
3569static int __init set_dhash_entries(char *str)
3570{
3571 if (!str)
3572 return 0;
3573 dhash_entries = simple_strtoul(str, &str, 0);
3574 return 1;
3575}
3576__setup("dhash_entries=", set_dhash_entries);
3577
3578static void __init dcache_init_early(void)
3579{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580 /* If hashes are distributed across NUMA nodes, defer
3581 * hash allocation until vmalloc space is available.
3582 */
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,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003591 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003592 &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);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003596 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597}
3598
Denis Cheng74bf17c2007-10-16 23:26:30 -07003599static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003601 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602 * A constructor could be added for stable state like the lists,
3603 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003604 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003606 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003607 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608
3609 /* Hash may have been set up in dcache_init_early */
3610 if (!hashdist)
3611 return;
3612
3613 dentry_hashtable =
3614 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003615 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616 dhash_entries,
3617 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003618 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619 &d_hash_shift,
3620 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003621 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622 0);
Alexey Dobriyan854d3e62017-11-20 18:05:07 +03003623 d_hash_shift = 32 - d_hash_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624}
3625
3626/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003627struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003628EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003629
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630EXPORT_SYMBOL(d_genocide);
3631
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632void __init vfs_caches_init_early(void)
3633{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003634 int i;
3635
3636 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3637 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3638
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639 dcache_init_early();
3640 inode_init_early();
3641}
3642
Mel Gorman4248b0d2015-08-06 15:46:20 -07003643void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003644{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003645 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003646 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003647
Denis Cheng74bf17c2007-10-16 23:26:30 -07003648 dcache_init();
3649 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003650 files_init();
3651 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003652 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003653 bdev_cache_init();
3654 chrdev_init();
3655}