blob: cab211e137446372cebaf11ffe522c703a3bd787 [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{
George Spelvin703b5fa2016-06-10 00:22:12 -0400113 return dentry_hashtable + (hash >> (32 - 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 *
NeilBrown61647822017-11-10 15:45:41 +1100470 * __d_drop requires dentry->d_lock
471 * ___d_drop doesn't mark dentry as "unhashed"
472 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100473 */
NeilBrown61647822017-11-10 15:45:41 +1100474static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100475{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700476 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400477 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400478 /*
479 * Hashed dentries are normally on the dentry hashtable,
480 * with the exception of those newly allocated by
NeilBrownf1ee6162017-12-21 09:45:40 +1100481 * d_obtain_root, which are always IS_ROOT:
J. Bruce Fields7632e462012-06-28 12:10:55 -0400482 */
483 if (unlikely(IS_ROOT(dentry)))
NeilBrownf1ee6162017-12-21 09:45:40 +1100484 b = &dentry->d_sb->s_roots;
Al Virob61625d2013-10-04 11:09:01 -0400485 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700486 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400487
488 hlist_bl_lock(b);
489 __hlist_bl_del(&dentry->d_hash);
Al Virob61625d2013-10-04 11:09:01 -0400490 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400491 /* After this call, in-progress rcu-walk path lookup will fail. */
492 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100493 }
494}
NeilBrown61647822017-11-10 15:45:41 +1100495
496void __d_drop(struct dentry *dentry)
497{
498 ___d_drop(dentry);
499 dentry->d_hash.pprev = NULL;
500}
Nick Piggin789680d2011-01-07 17:49:30 +1100501EXPORT_SYMBOL(__d_drop);
502
503void d_drop(struct dentry *dentry)
504{
Nick Piggin789680d2011-01-07 17:49:30 +1100505 spin_lock(&dentry->d_lock);
506 __d_drop(dentry);
507 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100508}
509EXPORT_SYMBOL(d_drop);
510
Al Viroba65dc52016-06-10 11:32:47 -0400511static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
512{
513 struct dentry *next;
514 /*
515 * Inform d_walk() and shrink_dentry_list() that we are no longer
516 * attached to the dentry tree
517 */
518 dentry->d_flags |= DCACHE_DENTRY_KILLED;
519 if (unlikely(list_empty(&dentry->d_child)))
520 return;
521 __list_del_entry(&dentry->d_child);
522 /*
523 * Cursors can move around the list of children. While we'd been
524 * a normal list member, it didn't matter - ->d_child.next would've
525 * been updated. However, from now on it won't be and for the
526 * things like d_walk() it might end up with a nasty surprise.
527 * Normally d_walk() doesn't care about cursors moving around -
528 * ->d_lock on parent prevents that and since a cursor has no children
529 * of its own, we get through it without ever unlocking the parent.
530 * There is one exception, though - if we ascend from a child that
531 * gets killed as soon as we unlock it, the next sibling is found
532 * using the value left in its ->d_child.next. And if _that_
533 * pointed to a cursor, and cursor got moved (e.g. by lseek())
534 * before d_walk() regains parent->d_lock, we'll end up skipping
535 * everything the cursor had been moved past.
536 *
537 * Solution: make sure that the pointer left behind in ->d_child.next
538 * points to something that won't be moving around. I.e. skip the
539 * cursors.
540 */
541 while (dentry->d_child.next != &parent->d_subdirs) {
542 next = list_entry(dentry->d_child.next, struct dentry, d_child);
543 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
544 break;
545 dentry->d_child.next = next->d_child.next;
546 }
547}
548
Al Viroe55fd012014-05-28 13:51:12 -0400549static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100550{
Al Viro41edf2782014-05-01 10:30:00 -0400551 struct dentry *parent = NULL;
552 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400553 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100554 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100555
Linus Torvalds0d984392013-09-08 13:46:52 -0700556 /*
557 * The dentry is now unrecoverably dead to the world.
558 */
559 lockref_mark_dead(&dentry->d_lockref);
560
Sage Weilf0023bc2011-10-28 10:02:42 -0700561 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700562 * inform the fs via d_prune that this dentry is about to be
563 * unhashed and destroyed.
564 */
Al Viro29266202014-05-30 11:39:02 -0400565 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800566 dentry->d_op->d_prune(dentry);
567
Al Viro01b60352014-04-29 23:42:52 -0400568 if (dentry->d_flags & DCACHE_LRU_LIST) {
569 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
570 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400571 }
Nick Piggin77812a12011-01-07 17:49:48 +1100572 /* if it was on the hash then remove it */
573 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400574 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400575 if (parent)
576 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400577 if (dentry->d_inode)
578 dentry_unlink_inode(dentry);
579 else
580 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400581 this_cpu_dec(nr_dentry);
582 if (dentry->d_op && dentry->d_op->d_release)
583 dentry->d_op->d_release(dentry);
584
Al Viro41edf2782014-05-01 10:30:00 -0400585 spin_lock(&dentry->d_lock);
586 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
587 dentry->d_flags |= DCACHE_MAY_FREE;
588 can_free = false;
589 }
590 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400591 if (likely(can_free))
592 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400593}
594
595/*
596 * Finish off a dentry we've decided to kill.
597 * dentry->d_lock must be held, returns with it unlocked.
598 * If ref is non-zero, then decrement the refcount too.
599 * Returns dentry requiring refcount drop, or NULL if we're done.
600 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400601static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400602 __releases(dentry->d_lock)
603{
604 struct inode *inode = dentry->d_inode;
605 struct dentry *parent = NULL;
606
607 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
608 goto failed;
609
610 if (!IS_ROOT(dentry)) {
611 parent = dentry->d_parent;
612 if (unlikely(!spin_trylock(&parent->d_lock))) {
613 if (inode)
614 spin_unlock(&inode->i_lock);
615 goto failed;
616 }
617 }
618
619 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400620 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400621
622failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400623 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400624 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100625}
626
Al Viro046b9612014-05-29 08:54:52 -0400627static inline struct dentry *lock_parent(struct dentry *dentry)
628{
629 struct dentry *parent = dentry->d_parent;
630 if (IS_ROOT(dentry))
631 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800632 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400633 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400634 if (likely(spin_trylock(&parent->d_lock)))
635 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400636 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400637 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400638again:
Mark Rutland66702eb2017-10-23 14:07:14 -0700639 parent = READ_ONCE(dentry->d_parent);
Al Viro046b9612014-05-29 08:54:52 -0400640 spin_lock(&parent->d_lock);
641 /*
642 * We can't blindly lock dentry until we are sure
643 * that we won't violate the locking order.
644 * Any changes of dentry->d_parent must have
645 * been done with parent->d_lock held, so
646 * spin_lock() above is enough of a barrier
647 * for checking if it's still our child.
648 */
649 if (unlikely(parent != dentry->d_parent)) {
650 spin_unlock(&parent->d_lock);
651 goto again;
652 }
653 rcu_read_unlock();
654 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700655 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400656 else
657 parent = NULL;
658 return parent;
659}
660
Linus Torvalds360f5472015-01-09 15:19:03 -0800661/*
662 * Try to do a lockless dput(), and return whether that was successful.
663 *
664 * If unsuccessful, we return false, having already taken the dentry lock.
665 *
666 * The caller needs to hold the RCU read lock, so that the dentry is
667 * guaranteed to stay around even if the refcount goes down to zero!
668 */
669static inline bool fast_dput(struct dentry *dentry)
670{
671 int ret;
672 unsigned int d_flags;
673
674 /*
675 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100676 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800677 */
678 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
679 return lockref_put_or_lock(&dentry->d_lockref);
680
681 /*
682 * .. otherwise, we can try to just decrement the
683 * lockref optimistically.
684 */
685 ret = lockref_put_return(&dentry->d_lockref);
686
687 /*
688 * If the lockref_put_return() failed due to the lock being held
689 * by somebody else, the fast path has failed. We will need to
690 * get the lock, and then check the count again.
691 */
692 if (unlikely(ret < 0)) {
693 spin_lock(&dentry->d_lock);
694 if (dentry->d_lockref.count > 1) {
695 dentry->d_lockref.count--;
696 spin_unlock(&dentry->d_lock);
697 return 1;
698 }
699 return 0;
700 }
701
702 /*
703 * If we weren't the last ref, we're done.
704 */
705 if (ret)
706 return 1;
707
708 /*
709 * Careful, careful. The reference count went down
710 * to zero, but we don't hold the dentry lock, so
711 * somebody else could get it again, and do another
712 * dput(), and we need to not race with that.
713 *
714 * However, there is a very special and common case
715 * where we don't care, because there is nothing to
716 * do: the dentry is still hashed, it does not have
717 * a 'delete' op, and it's referenced and already on
718 * the LRU list.
719 *
720 * NOTE! Since we aren't locked, these values are
721 * not "stable". However, it is sufficient that at
722 * some point after we dropped the reference the
723 * dentry was hashed and the flags had the proper
724 * value. Other dentry users may have re-gotten
725 * a reference to the dentry and change that, but
726 * our work is done - we can leave the dentry
727 * around with a zero refcount.
728 */
729 smp_rmb();
Mark Rutland66702eb2017-10-23 14:07:14 -0700730 d_flags = READ_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100731 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800732
733 /* Nothing to do? Dropping the reference was all we needed? */
734 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
735 return 1;
736
737 /*
738 * Not the fast normal case? Get the lock. We've already decremented
739 * the refcount, but we'll need to re-check the situation after
740 * getting the lock.
741 */
742 spin_lock(&dentry->d_lock);
743
744 /*
745 * Did somebody else grab a reference to it in the meantime, and
746 * we're no longer the last user after all? Alternatively, somebody
747 * else could have killed it and marked it dead. Either way, we
748 * don't need to do anything else.
749 */
750 if (dentry->d_lockref.count) {
751 spin_unlock(&dentry->d_lock);
752 return 1;
753 }
754
755 /*
756 * Re-get the reference we optimistically dropped. We hold the
757 * lock, and we just tested that it was zero, so we can just
758 * set it to 1.
759 */
760 dentry->d_lockref.count = 1;
761 return 0;
762}
763
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/*
766 * This is dput
767 *
768 * This is complicated by the fact that we do not want to put
769 * dentries that are no longer on any hash chain on the unused
770 * list: we'd much rather just get rid of them immediately.
771 *
772 * However, that implies that we have to traverse the dentry
773 * tree upwards to the parents which might _also_ now be
774 * scheduled for deletion (it may have been only waiting for
775 * its last child to go away).
776 *
777 * This tail recursion is done by hand as we don't want to depend
778 * on the compiler to always get this right (gcc generally doesn't).
779 * Real recursion would eat up our stack space.
780 */
781
782/*
783 * dput - release a dentry
784 * @dentry: dentry to release
785 *
786 * Release a dentry. This will drop the usage count and if appropriate
787 * call the dentry unlink method as well as removing it from the queues and
788 * releasing its resources. If the parent dentries were scheduled for release
789 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791void dput(struct dentry *dentry)
792{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700793 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 return;
795
796repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800797 might_sleep();
798
Linus Torvalds360f5472015-01-09 15:19:03 -0800799 rcu_read_lock();
800 if (likely(fast_dput(dentry))) {
801 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800803 }
804
805 /* Slow case: now with the dentry lock held */
806 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Al Viro85c7f812016-04-14 19:52:13 -0400808 WARN_ON(d_in_lookup(dentry));
809
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700810 /* Unreachable? Get rid of it */
811 if (unlikely(d_unhashed(dentry)))
812 goto kill_it;
813
Al Viro75a6f822015-07-08 02:42:38 +0100814 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
815 goto kill_it;
816
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700817 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100819 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 }
Nick Piggin265ac902010-10-10 05:36:24 -0400821
Christoph Hellwiga4633352010-10-10 05:36:26 -0400822 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400823
Waiman Long98474232013-08-28 18:24:59 -0700824 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100825 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return;
827
Miklos Szeredid52b9082007-05-08 00:23:46 -0700828kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400829 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800830 if (dentry) {
831 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700832 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700835EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100838/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100839static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Waiman Long98474232013-08-28 18:24:59 -0700841 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
843
Nick Piggindc0474b2011-01-07 17:49:43 +1100844static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100845{
Waiman Long98474232013-08-28 18:24:59 -0700846 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100847}
848
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100849struct dentry *dget_parent(struct dentry *dentry)
850{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700851 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100852 struct dentry *ret;
853
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700854 /*
855 * Do optimistic parent lookup without any
856 * locking.
857 */
858 rcu_read_lock();
Mark Rutland66702eb2017-10-23 14:07:14 -0700859 ret = READ_ONCE(dentry->d_parent);
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700860 gotref = lockref_get_not_zero(&ret->d_lockref);
861 rcu_read_unlock();
862 if (likely(gotref)) {
Mark Rutland66702eb2017-10-23 14:07:14 -0700863 if (likely(ret == READ_ONCE(dentry->d_parent)))
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700864 return ret;
865 dput(ret);
866 }
867
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100869 /*
870 * Don't need rcu_dereference because we re-check it was correct under
871 * the lock.
872 */
873 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100874 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100875 spin_lock(&ret->d_lock);
876 if (unlikely(ret != dentry->d_parent)) {
877 spin_unlock(&ret->d_lock);
878 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100879 goto repeat;
880 }
Nick Piggina734eb42011-01-07 17:49:44 +1100881 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700882 BUG_ON(!ret->d_lockref.count);
883 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100884 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100885 return ret;
886}
887EXPORT_SYMBOL(dget_parent);
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889/**
890 * d_find_alias - grab a hashed alias of inode
891 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 *
893 * If inode has a hashed alias, or is a directory and has any alias,
894 * acquire the reference to alias and return it. Otherwise return NULL.
895 * Notice that if inode is a directory there can be only one alias and
896 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800897 * of a filesystem, or if the directory was renamed and d_revalidate
898 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700900 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500901 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500903static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904{
Nick Pigginda502952011-01-07 17:49:33 +1100905 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Nick Pigginda502952011-01-07 17:49:33 +1100907again:
908 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400909 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100910 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700912 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100913 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500915 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100916 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100917 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 return alias;
919 }
920 }
Nick Pigginda502952011-01-07 17:49:33 +1100921 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 }
Nick Pigginda502952011-01-07 17:49:33 +1100923 if (discon_alias) {
924 alias = discon_alias;
925 spin_lock(&alias->d_lock);
926 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500927 __dget_dlock(alias);
928 spin_unlock(&alias->d_lock);
929 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100930 }
931 spin_unlock(&alias->d_lock);
932 goto again;
933 }
934 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935}
936
Nick Pigginda502952011-01-07 17:49:33 +1100937struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938{
David Howells214fda12006-03-25 03:06:36 -0800939 struct dentry *de = NULL;
940
Al Virob3d9b7a2012-06-09 13:51:19 -0400941 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100942 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500943 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100944 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 return de;
947}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700948EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
950/*
951 * Try to kill dentries associated with this inode.
952 * WARNING: you must own a reference to inode.
953 */
954void d_prune_aliases(struct inode *inode)
955{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700956 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100958 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400959 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700961 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400962 struct dentry *parent = lock_parent(dentry);
963 if (likely(!dentry->d_lockref.count)) {
964 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800965 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400966 goto restart;
967 }
968 if (parent)
969 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 }
971 spin_unlock(&dentry->d_lock);
972 }
Nick Piggin873feea2011-01-07 17:50:06 +1100973 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700975EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400977static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Al Viro5c47e6d2014-04-29 16:13:18 -0400979 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700980
Miklos Szeredi60942f22014-05-02 15:38:39 -0400981 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400982 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400983 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100984 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400985 parent = lock_parent(dentry);
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000988 * The dispose list is isolated and dentries are not accounted
989 * to the LRU here, so we can simply remove it from the list
990 * here regardless of whether it is referenced or not.
991 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400992 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000993
994 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000996 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800998 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700999 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001000 if (parent)
1001 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 continue;
1003 }
Nick Piggin77812a12011-01-07 17:49:48 +11001004
Al Viro64fd72e2014-05-28 09:48:44 -04001005
1006 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1007 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1008 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001009 if (parent)
1010 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001011 if (can_free)
1012 dentry_free(dentry);
1013 continue;
1014 }
1015
Al Viroff2fde92014-05-28 13:59:13 -04001016 inode = dentry->d_inode;
1017 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001018 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001019 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001020 if (parent)
1021 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001022 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001023 }
Al Viroff2fde92014-05-28 13:59:13 -04001024
Al Viroff2fde92014-05-28 13:59:13 -04001025 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001026
Al Viro5c47e6d2014-04-29 16:13:18 -04001027 /*
1028 * We need to prune ancestors too. This is necessary to prevent
1029 * quadratic behavior of shrink_dcache_parent(), but is also
1030 * expected to be beneficial in reducing dentry cache
1031 * fragmentation.
1032 */
1033 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001034 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1035 parent = lock_parent(dentry);
1036 if (dentry->d_lockref.count != 1) {
1037 dentry->d_lockref.count--;
1038 spin_unlock(&dentry->d_lock);
1039 if (parent)
1040 spin_unlock(&parent->d_lock);
1041 break;
1042 }
1043 inode = dentry->d_inode; /* can't be NULL */
1044 if (unlikely(!spin_trylock(&inode->i_lock))) {
1045 spin_unlock(&dentry->d_lock);
1046 if (parent)
1047 spin_unlock(&parent->d_lock);
1048 cpu_relax();
1049 continue;
1050 }
1051 __dentry_kill(dentry);
1052 dentry = parent;
1053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001055}
1056
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001057static enum lru_status dentry_lru_isolate(struct list_head *item,
1058 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001059{
1060 struct list_head *freeable = arg;
1061 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1062
1063
1064 /*
1065 * we are inverting the lru lock/dentry->d_lock here,
1066 * so use a trylock. If we fail to get the lock, just skip
1067 * it
1068 */
1069 if (!spin_trylock(&dentry->d_lock))
1070 return LRU_SKIP;
1071
1072 /*
1073 * Referenced dentries are still in use. If they have active
1074 * counts, just remove them from the LRU. Otherwise give them
1075 * another pass through the LRU.
1076 */
1077 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001078 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001079 spin_unlock(&dentry->d_lock);
1080 return LRU_REMOVED;
1081 }
1082
1083 if (dentry->d_flags & DCACHE_REFERENCED) {
1084 dentry->d_flags &= ~DCACHE_REFERENCED;
1085 spin_unlock(&dentry->d_lock);
1086
1087 /*
1088 * The list move itself will be made by the common LRU code. At
1089 * this point, we've dropped the dentry->d_lock but keep the
1090 * lru lock. This is safe to do, since every list movement is
1091 * protected by the lru lock even if both locks are held.
1092 *
1093 * This is guaranteed by the fact that all LRU management
1094 * functions are intermediated by the LRU API calls like
1095 * list_lru_add and list_lru_del. List movement in this file
1096 * only ever occur through this functions or through callbacks
1097 * like this one, that are called from the LRU API.
1098 *
1099 * The only exceptions to this are functions like
1100 * shrink_dentry_list, and code that first checks for the
1101 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1102 * operating only with stack provided lists after they are
1103 * properly isolated from the main list. It is thus, always a
1104 * local access.
1105 */
1106 return LRU_ROTATE;
1107 }
1108
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001109 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001110 spin_unlock(&dentry->d_lock);
1111
1112 return LRU_REMOVED;
1113}
1114
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001115/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001116 * prune_dcache_sb - shrink the dcache
1117 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001118 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001119 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001120 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1121 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001122 * function.
1123 *
1124 * This function may fail to free any resources if all the dentries are in
1125 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001126 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001127long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128{
Dave Chinnerf6041562013-08-28 10:18:00 +10001129 LIST_HEAD(dispose);
1130 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001131
Vladimir Davydov503c3582015-02-12 14:58:47 -08001132 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1133 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001134 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001135 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136}
1137
Glauber Costa4e717f52013-08-28 10:18:03 +10001138static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001139 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001140{
Glauber Costa4e717f52013-08-28 10:18:03 +10001141 struct list_head *freeable = arg;
1142 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001143
Glauber Costa4e717f52013-08-28 10:18:03 +10001144 /*
1145 * we are inverting the lru lock/dentry->d_lock here,
1146 * so use a trylock. If we fail to get the lock, just skip
1147 * it
1148 */
1149 if (!spin_trylock(&dentry->d_lock))
1150 return LRU_SKIP;
1151
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001152 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001153 spin_unlock(&dentry->d_lock);
1154
1155 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001156}
1157
Glauber Costa4e717f52013-08-28 10:18:03 +10001158
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001159/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 * shrink_dcache_sb - shrink dcache for a superblock
1161 * @sb: superblock
1162 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001163 * Shrink the dcache for the specified super block. This is used to free
1164 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001166void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167{
Glauber Costa4e717f52013-08-28 10:18:03 +10001168 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001169
Glauber Costa4e717f52013-08-28 10:18:03 +10001170 do {
1171 LIST_HEAD(dispose);
1172
1173 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001174 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001175
1176 this_cpu_sub(nr_dentry_unused, freed);
1177 shrink_dentry_list(&dispose);
Sahitya Tummalab17c0702017-07-10 15:50:00 -07001178 cond_resched();
1179 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001181EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001184 * enum d_walk_ret - action to talke during tree walk
1185 * @D_WALK_CONTINUE: contrinue walk
1186 * @D_WALK_QUIT: quit walk
1187 * @D_WALK_NORETRY: quit when retry is needed
1188 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001190enum d_walk_ret {
1191 D_WALK_CONTINUE,
1192 D_WALK_QUIT,
1193 D_WALK_NORETRY,
1194 D_WALK_SKIP,
1195};
1196
1197/**
1198 * d_walk - walk the dentry tree
1199 * @parent: start of walk
1200 * @data: data passed to @enter() and @finish()
1201 * @enter: callback when first entering the dentry
1202 * @finish: callback when successfully finished the walk
1203 *
1204 * The @enter() and @finish() callbacks are called with d_lock held.
1205 */
1206static void d_walk(struct dentry *parent, void *data,
1207 enum d_walk_ret (*enter)(void *, struct dentry *),
1208 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
Nick Piggin949854d2011-01-07 17:49:37 +11001210 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001212 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001213 enum d_walk_ret ret;
1214 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001215
Nick Piggin58db63d2011-01-07 17:49:39 +11001216again:
Al Viro48f5ec22013-09-09 15:22:25 -04001217 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001218 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001219 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001220
1221 ret = enter(data, this_parent);
1222 switch (ret) {
1223 case D_WALK_CONTINUE:
1224 break;
1225 case D_WALK_QUIT:
1226 case D_WALK_SKIP:
1227 goto out_unlock;
1228 case D_WALK_NORETRY:
1229 retry = false;
1230 break;
1231 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232repeat:
1233 next = this_parent->d_subdirs.next;
1234resume:
1235 while (next != &this_parent->d_subdirs) {
1236 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001237 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001239
Al Viroba65dc52016-06-10 11:32:47 -04001240 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1241 continue;
1242
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001243 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001244
1245 ret = enter(data, dentry);
1246 switch (ret) {
1247 case D_WALK_CONTINUE:
1248 break;
1249 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001250 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001251 goto out_unlock;
1252 case D_WALK_NORETRY:
1253 retry = false;
1254 break;
1255 case D_WALK_SKIP:
1256 spin_unlock(&dentry->d_lock);
1257 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001258 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001259
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001261 spin_unlock(&this_parent->d_lock);
1262 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001264 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 goto repeat;
1266 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001267 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 }
1269 /*
1270 * All done at this level ... ascend and resume the search.
1271 */
Al Viroca5358e2014-10-26 19:31:10 -04001272 rcu_read_lock();
1273ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001275 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001276 this_parent = child->d_parent;
1277
Al Viro31dec132013-10-25 17:04:27 -04001278 spin_unlock(&child->d_lock);
1279 spin_lock(&this_parent->d_lock);
1280
Al Viroca5358e2014-10-26 19:31:10 -04001281 /* might go back up the wrong parent if we have had a rename. */
1282 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001283 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001284 /* go into the first sibling still alive */
1285 do {
1286 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001287 if (next == &this_parent->d_subdirs)
1288 goto ascend;
1289 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001290 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001291 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 goto resume;
1293 }
Al Viroca5358e2014-10-26 19:31:10 -04001294 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001295 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001296 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001297 if (finish)
1298 finish(data);
1299
1300out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001301 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001302 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001303 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001304
1305rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001306 spin_unlock(&this_parent->d_lock);
1307 rcu_read_unlock();
1308 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001309 if (!retry)
1310 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001311 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001312 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001314
Ian Kent01619492016-11-24 08:03:41 +11001315struct check_mount {
1316 struct vfsmount *mnt;
1317 unsigned int mounted;
1318};
1319
1320static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1321{
1322 struct check_mount *info = data;
1323 struct path path = { .mnt = info->mnt, .dentry = dentry };
1324
1325 if (likely(!d_mountpoint(dentry)))
1326 return D_WALK_CONTINUE;
1327 if (__path_is_mountpoint(&path)) {
1328 info->mounted = 1;
1329 return D_WALK_QUIT;
1330 }
1331 return D_WALK_CONTINUE;
1332}
1333
1334/**
1335 * path_has_submounts - check for mounts over a dentry in the
1336 * current namespace.
1337 * @parent: path to check.
1338 *
1339 * Return true if the parent or its subdirectories contain
1340 * a mount point in the current namespace.
1341 */
1342int path_has_submounts(const struct path *parent)
1343{
1344 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1345
1346 read_seqlock_excl(&mount_lock);
1347 d_walk(parent->dentry, &data, path_check_mount, NULL);
1348 read_sequnlock_excl(&mount_lock);
1349
1350 return data.mounted;
1351}
1352EXPORT_SYMBOL(path_has_submounts);
1353
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001355 * Called by mount code to set a mountpoint and check if the mountpoint is
1356 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1357 * subtree can become unreachable).
1358 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001359 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001360 * this reason take rename_lock and d_lock on dentry and ancestors.
1361 */
1362int d_set_mounted(struct dentry *dentry)
1363{
1364 struct dentry *p;
1365 int ret = -ENOENT;
1366 write_seqlock(&rename_lock);
1367 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001368 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001369 spin_lock(&p->d_lock);
1370 if (unlikely(d_unhashed(p))) {
1371 spin_unlock(&p->d_lock);
1372 goto out;
1373 }
1374 spin_unlock(&p->d_lock);
1375 }
1376 spin_lock(&dentry->d_lock);
1377 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001378 ret = -EBUSY;
1379 if (!d_mountpoint(dentry)) {
1380 dentry->d_flags |= DCACHE_MOUNTED;
1381 ret = 0;
1382 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001383 }
1384 spin_unlock(&dentry->d_lock);
1385out:
1386 write_sequnlock(&rename_lock);
1387 return ret;
1388}
1389
1390/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001391 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 * and move any unused dentries to the end of the unused
1393 * list for prune_dcache(). We descend to the next level
1394 * whenever the d_subdirs list is non-empty and continue
1395 * searching.
1396 *
1397 * It returns zero iff there are no unused children,
1398 * otherwise it returns the number of children moved to
1399 * the end of the unused list. This may not be the total
1400 * number of unused children, because select_parent can
1401 * drop the lock and return early due to latency
1402 * constraints.
1403 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001404
1405struct select_data {
1406 struct dentry *start;
1407 struct list_head dispose;
1408 int found;
1409};
1410
1411static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001413 struct select_data *data = _data;
1414 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001416 if (data->start == dentry)
1417 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Al Virofe915222014-05-03 00:02:25 -04001419 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001420 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001421 } else {
1422 if (dentry->d_flags & DCACHE_LRU_LIST)
1423 d_lru_del(dentry);
1424 if (!dentry->d_lockref.count) {
1425 d_shrink_add(dentry, &data->dispose);
1426 data->found++;
1427 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 }
1429 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001430 * We can return to the caller if we have found some (this
1431 * ensures forward progress). We'll be coming back to find
1432 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 */
Al Virofe915222014-05-03 00:02:25 -04001434 if (!list_empty(&data->dispose))
1435 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001437 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438}
1439
1440/**
1441 * shrink_dcache_parent - prune dcache
1442 * @parent: parent of entries to prune
1443 *
1444 * Prune the dcache to remove unused children of the parent dentry.
1445 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001446void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001448 for (;;) {
1449 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001451 INIT_LIST_HEAD(&data.dispose);
1452 data.start = parent;
1453 data.found = 0;
1454
1455 d_walk(parent, &data, select_collect, NULL);
1456 if (!data.found)
1457 break;
1458
1459 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001460 cond_resched();
1461 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001463EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Al Viro9c8c10e2014-05-02 20:36:10 -04001465static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001466{
Al Viro9c8c10e2014-05-02 20:36:10 -04001467 /* it has busy descendents; complain about those instead */
1468 if (!list_empty(&dentry->d_subdirs))
1469 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001470
Al Viro9c8c10e2014-05-02 20:36:10 -04001471 /* root with refcount 1 is fine */
1472 if (dentry == _data && dentry->d_lockref.count == 1)
1473 return D_WALK_CONTINUE;
1474
1475 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1476 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001477 dentry,
1478 dentry->d_inode ?
1479 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001480 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001481 dentry->d_lockref.count,
1482 dentry->d_sb->s_type->name,
1483 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001484 WARN_ON(1);
1485 return D_WALK_CONTINUE;
1486}
1487
1488static void do_one_tree(struct dentry *dentry)
1489{
1490 shrink_dcache_parent(dentry);
1491 d_walk(dentry, dentry, umount_check, NULL);
1492 d_drop(dentry);
1493 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001494}
1495
1496/*
1497 * destroy the dentries attached to a superblock on unmounting
1498 */
1499void shrink_dcache_for_umount(struct super_block *sb)
1500{
1501 struct dentry *dentry;
1502
Al Viro9c8c10e2014-05-02 20:36:10 -04001503 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001504
1505 dentry = sb->s_root;
1506 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001507 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001508
NeilBrownf1ee6162017-12-21 09:45:40 +11001509 while (!hlist_bl_empty(&sb->s_roots)) {
1510 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_roots), struct dentry, d_hash));
Al Viro9c8c10e2014-05-02 20:36:10 -04001511 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001512 }
1513}
1514
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001515struct detach_data {
1516 struct select_data select;
1517 struct dentry *mountpoint;
1518};
1519static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001520{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001521 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001522
1523 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001524 __dget_dlock(dentry);
1525 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001526 return D_WALK_QUIT;
1527 }
1528
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001529 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001530}
1531
1532static void check_and_drop(void *_data)
1533{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001535
Al Viro81be24d2017-06-03 07:20:09 +01001536 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001537 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538}
1539
1540/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001541 * d_invalidate - detach submounts, prune dcache, and drop
1542 * @dentry: dentry to invalidate (aka detach, prune and drop)
1543 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001544 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001545 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001546 * The final d_drop is done as an atomic operation relative to
1547 * rename_lock ensuring there are no races with d_set_mounted. This
1548 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001549 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001550void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001551{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001552 /*
1553 * If it's already been dropped, return OK.
1554 */
1555 spin_lock(&dentry->d_lock);
1556 if (d_unhashed(dentry)) {
1557 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001558 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001559 }
1560 spin_unlock(&dentry->d_lock);
1561
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001562 /* Negative dentries can be dropped without further checks */
1563 if (!dentry->d_inode) {
1564 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001565 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001566 }
1567
1568 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001569 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001570
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001571 data.mountpoint = NULL;
1572 INIT_LIST_HEAD(&data.select.dispose);
1573 data.select.start = dentry;
1574 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001576 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001577
Al Viro81be24d2017-06-03 07:20:09 +01001578 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001579 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001580 else if (!data.mountpoint)
1581 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001582
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001583 if (data.mountpoint) {
1584 detach_mounts(data.mountpoint);
1585 dput(data.mountpoint);
1586 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001587 cond_resched();
1588 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001589}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001590EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001591
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592/**
Al Viroa4464db2011-07-07 15:03:58 -04001593 * __d_alloc - allocate a dcache entry
1594 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 * @name: qstr of the name
1596 *
1597 * Allocates a dentry. It returns %NULL if there is insufficient memory
1598 * available. On a success the dentry is returned. The name passed in is
1599 * copied and the copy passed in may be reused after this call.
1600 */
1601
Al Viroa4464db2011-07-07 15:03:58 -04001602struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603{
1604 struct dentry *dentry;
1605 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001606 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Mel Gormane12ba742007-10-16 01:25:52 -07001608 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 if (!dentry)
1610 return NULL;
1611
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001612 /*
1613 * We guarantee that the inline name is always NUL-terminated.
1614 * This way the memcpy() done by the name switching in rename
1615 * will still always have a NUL at the end, even if we might
1616 * be overwriting an internal NUL character
1617 */
1618 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001619 if (unlikely(!name)) {
David Howellscdf01222017-07-04 17:25:22 +01001620 name = &slash_name;
Al Viro798434b2016-03-24 20:38:43 -04001621 dname = dentry->d_iname;
1622 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001623 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001624 struct external_name *p = kmalloc(size + name->len,
1625 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001626 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 kmem_cache_free(dentry_cache, dentry);
1628 return NULL;
1629 }
Al Viro8d85b482014-09-29 14:54:27 -04001630 atomic_set(&p->u.count, 1);
1631 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001632 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1633 kasan_unpoison_shadow(dname,
1634 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 } else {
1636 dname = dentry->d_iname;
1637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
1639 dentry->d_name.len = name->len;
1640 dentry->d_name.hash = name->hash;
1641 memcpy(dname, name->name, name->len);
1642 dname[name->len] = 0;
1643
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001644 /* Make sure we always see the terminating NUL character */
1645 smp_wmb();
1646 dentry->d_name.name = dname;
1647
Waiman Long98474232013-08-28 18:24:59 -07001648 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001649 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001651 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001653 dentry->d_parent = dentry;
1654 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 dentry->d_op = NULL;
1656 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001657 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 INIT_LIST_HEAD(&dentry->d_lru);
1659 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001660 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1661 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001662 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Miklos Szeredi285b1022016-06-28 11:47:32 +02001664 if (dentry->d_op && dentry->d_op->d_init) {
1665 err = dentry->d_op->d_init(dentry);
1666 if (err) {
1667 if (dname_external(dentry))
1668 kfree(external_name(dentry));
1669 kmem_cache_free(dentry_cache, dentry);
1670 return NULL;
1671 }
1672 }
1673
Nick Piggin3e880fb2011-01-07 17:49:19 +11001674 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001675
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 return dentry;
1677}
Al Viroa4464db2011-07-07 15:03:58 -04001678
1679/**
1680 * d_alloc - allocate a dcache entry
1681 * @parent: parent of entry to allocate
1682 * @name: qstr of the name
1683 *
1684 * Allocates a dentry. It returns %NULL if there is insufficient memory
1685 * available. On a success the dentry is returned. The name passed in is
1686 * copied and the copy passed in may be reused after this call.
1687 */
1688struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1689{
1690 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1691 if (!dentry)
1692 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001693 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001694 spin_lock(&parent->d_lock);
1695 /*
1696 * don't need child lock because it is not subject
1697 * to concurrency here
1698 */
1699 __dget_dlock(parent);
1700 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001701 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001702 spin_unlock(&parent->d_lock);
1703
1704 return dentry;
1705}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001706EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
Al Viroba65dc52016-06-10 11:32:47 -04001708struct dentry *d_alloc_cursor(struct dentry * parent)
1709{
1710 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1711 if (dentry) {
1712 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1713 dentry->d_parent = dget(parent);
1714 }
1715 return dentry;
1716}
1717
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001718/**
1719 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1720 * @sb: the superblock
1721 * @name: qstr of the name
1722 *
1723 * For a filesystem that just pins its dentries in memory and never
1724 * performs lookups at all, return an unhashed IS_ROOT dentry.
1725 */
Nick Piggin4b936882011-01-07 17:50:07 +11001726struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1727{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001728 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001729}
1730EXPORT_SYMBOL(d_alloc_pseudo);
1731
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1733{
1734 struct qstr q;
1735
1736 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001737 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 return d_alloc(parent, &q);
1739}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001740EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Nick Pigginfb045ad2011-01-07 17:49:55 +11001742void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1743{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001744 WARN_ON_ONCE(dentry->d_op);
1745 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001746 DCACHE_OP_COMPARE |
1747 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001748 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001749 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001750 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001751 dentry->d_op = op;
1752 if (!op)
1753 return;
1754 if (op->d_hash)
1755 dentry->d_flags |= DCACHE_OP_HASH;
1756 if (op->d_compare)
1757 dentry->d_flags |= DCACHE_OP_COMPARE;
1758 if (op->d_revalidate)
1759 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001760 if (op->d_weak_revalidate)
1761 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001762 if (op->d_delete)
1763 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001764 if (op->d_prune)
1765 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001766 if (op->d_real)
1767 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001768
1769}
1770EXPORT_SYMBOL(d_set_d_op);
1771
David Howellsdf1a0852015-01-29 12:02:28 +00001772
1773/*
1774 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1775 * @dentry - The dentry to mark
1776 *
1777 * Mark a dentry as falling through to the lower layer (as set with
1778 * d_pin_lower()). This flag may be recorded on the medium.
1779 */
1780void d_set_fallthru(struct dentry *dentry)
1781{
1782 spin_lock(&dentry->d_lock);
1783 dentry->d_flags |= DCACHE_FALLTHRU;
1784 spin_unlock(&dentry->d_lock);
1785}
1786EXPORT_SYMBOL(d_set_fallthru);
1787
David Howellsb18825a2013-09-12 19:22:53 +01001788static unsigned d_flags_for_inode(struct inode *inode)
1789{
David Howells44bdb5e2015-01-29 12:02:29 +00001790 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001791
1792 if (!inode)
1793 return DCACHE_MISS_TYPE;
1794
1795 if (S_ISDIR(inode->i_mode)) {
1796 add_flags = DCACHE_DIRECTORY_TYPE;
1797 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1798 if (unlikely(!inode->i_op->lookup))
1799 add_flags = DCACHE_AUTODIR_TYPE;
1800 else
1801 inode->i_opflags |= IOP_LOOKUP;
1802 }
David Howells44bdb5e2015-01-29 12:02:29 +00001803 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001804 }
1805
David Howells44bdb5e2015-01-29 12:02:29 +00001806 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001807 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001808 add_flags = DCACHE_SYMLINK_TYPE;
1809 goto type_determined;
1810 }
1811 inode->i_opflags |= IOP_NOFOLLOW;
1812 }
1813
1814 if (unlikely(!S_ISREG(inode->i_mode)))
1815 add_flags = DCACHE_SPECIAL_TYPE;
1816
1817type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001818 if (unlikely(IS_AUTOMOUNT(inode)))
1819 add_flags |= DCACHE_NEED_AUTOMOUNT;
1820 return add_flags;
1821}
1822
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001823static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1824{
David Howellsb18825a2013-09-12 19:22:53 +01001825 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001826 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001827
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001828 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001829 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001830 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001831 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001832 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001833 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001834 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001835}
1836
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837/**
1838 * d_instantiate - fill in inode information for a dentry
1839 * @entry: dentry to complete
1840 * @inode: inode to attach to this dentry
1841 *
1842 * Fill in inode information in the entry.
1843 *
1844 * This turns negative dentries into productive full members
1845 * of society.
1846 *
1847 * NOTE! This assumes that the inode count has been incremented
1848 * (or otherwise set) by the caller to indicate that it is now
1849 * in use by the dcache.
1850 */
1851
1852void d_instantiate(struct dentry *entry, struct inode * inode)
1853{
Al Viro946e51f2014-10-26 19:19:16 -04001854 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001855 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001856 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001857 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001858 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001859 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001862EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
1864/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001865 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1866 * @entry: dentry to complete
1867 * @inode: inode to attach to this dentry
1868 *
1869 * Fill in inode information in the entry. If a directory alias is found, then
1870 * return an error (and drop inode). Together with d_materialise_unique() this
1871 * guarantees that a directory inode may never have more than one alias.
1872 */
1873int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1874{
Al Viro946e51f2014-10-26 19:19:16 -04001875 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001876
Al Virob9680912016-04-11 00:53:26 -04001877 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001878 spin_lock(&inode->i_lock);
1879 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1880 spin_unlock(&inode->i_lock);
1881 iput(inode);
1882 return -EBUSY;
1883 }
1884 __d_instantiate(entry, inode);
1885 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001886
1887 return 0;
1888}
1889EXPORT_SYMBOL(d_instantiate_no_diralias);
1890
Al Viroadc0e91a2012-01-08 16:49:21 -05001891struct dentry *d_make_root(struct inode *root_inode)
1892{
1893 struct dentry *res = NULL;
1894
1895 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001896 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e91a2012-01-08 16:49:21 -05001897 if (res)
1898 d_instantiate(res, root_inode);
1899 else
1900 iput(root_inode);
1901 }
1902 return res;
1903}
1904EXPORT_SYMBOL(d_make_root);
1905
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001906static struct dentry * __d_find_any_alias(struct inode *inode)
1907{
1908 struct dentry *alias;
1909
Al Virob3d9b7a2012-06-09 13:51:19 -04001910 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001911 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001912 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001913 __dget(alias);
1914 return alias;
1915}
1916
Sage Weil46f72b32012-01-10 09:04:37 -08001917/**
1918 * d_find_any_alias - find any alias for a given inode
1919 * @inode: inode to find an alias for
1920 *
1921 * If any aliases exist for the given inode, take and return a
1922 * reference for one of them. If no aliases exist, return %NULL.
1923 */
1924struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001925{
1926 struct dentry *de;
1927
1928 spin_lock(&inode->i_lock);
1929 de = __d_find_any_alias(inode);
1930 spin_unlock(&inode->i_lock);
1931 return de;
1932}
Sage Weil46f72b32012-01-10 09:04:37 -08001933EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001934
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001935static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001936{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001937 struct dentry *tmp;
1938 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001939 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001940
1941 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001942 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001943 if (IS_ERR(inode))
1944 return ERR_CAST(inode);
1945
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001946 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001947 if (res)
1948 goto out_iput;
1949
Al Viro798434b2016-03-24 20:38:43 -04001950 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001951 if (!tmp) {
1952 res = ERR_PTR(-ENOMEM);
1953 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001954 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001955
Al Virob9680912016-04-11 00:53:26 -04001956 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001957 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001958 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001959 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001960 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001961 dput(tmp);
1962 goto out_iput;
1963 }
1964
1965 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001966 add_flags = d_flags_for_inode(inode);
1967
1968 if (disconnected)
1969 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001970
Christoph Hellwig9308a612008-08-11 15:49:12 +02001971 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001972 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001973 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
NeilBrownf1ee6162017-12-21 09:45:40 +11001974 if (!disconnected) {
1975 hlist_bl_lock(&tmp->d_sb->s_roots);
1976 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_roots);
1977 hlist_bl_unlock(&tmp->d_sb->s_roots);
1978 }
Christoph Hellwig9308a612008-08-11 15:49:12 +02001979 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001980 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001981
Christoph Hellwig9308a612008-08-11 15:49:12 +02001982 return tmp;
1983
1984 out_iput:
1985 iput(inode);
1986 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001987}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001988
1989/**
1990 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1991 * @inode: inode to allocate the dentry for
1992 *
1993 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1994 * similar open by handle operations. The returned dentry may be anonymous,
1995 * or may have a full name (if the inode was already in the cache).
1996 *
1997 * When called on a directory inode, we must ensure that the inode only ever
1998 * has one dentry. If a dentry is found, that is returned instead of
1999 * allocating a new one.
2000 *
2001 * On successful return, the reference to the inode has been transferred
2002 * to the dentry. In case of an error the reference on the inode is released.
2003 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2004 * be passed in and the error will be propagated to the return value,
2005 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2006 */
2007struct dentry *d_obtain_alias(struct inode *inode)
2008{
2009 return __d_obtain_alias(inode, 1);
2010}
Benny Halevyadc48722009-02-27 14:02:59 -08002011EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002014 * d_obtain_root - find or allocate a dentry for a given inode
2015 * @inode: inode to allocate the dentry for
2016 *
2017 * Obtain an IS_ROOT dentry for the root of a filesystem.
2018 *
2019 * We must ensure that directory inodes only ever have one dentry. If a
2020 * dentry is found, that is returned instead of allocating a new one.
2021 *
2022 * On successful return, the reference to the inode has been transferred
2023 * to the dentry. In case of an error the reference on the inode is
2024 * released. A %NULL or IS_ERR inode may be passed in and will be the
2025 * error will be propagate to the return value, with a %NULL @inode
2026 * replaced by ERR_PTR(-ESTALE).
2027 */
2028struct dentry *d_obtain_root(struct inode *inode)
2029{
2030 return __d_obtain_alias(inode, 0);
2031}
2032EXPORT_SYMBOL(d_obtain_root);
2033
2034/**
Barry Naujok94035402008-05-21 16:50:46 +10002035 * d_add_ci - lookup or allocate new dentry with case-exact name
2036 * @inode: the inode case-insensitive lookup has found
2037 * @dentry: the negative dentry that was passed to the parent's lookup func
2038 * @name: the case-exact name to be associated with the returned dentry
2039 *
2040 * This is to avoid filling the dcache with case-insensitive names to the
2041 * same inode, only the actual correct case is stored in the dcache for
2042 * case-insensitive filesystems.
2043 *
2044 * For a case-insensitive lookup match and if the the case-exact dentry
2045 * already exists in in the dcache, use it and return it.
2046 *
2047 * If no entry exists with the exact case name, allocate new dentry with
2048 * the exact case, and return the spliced entry.
2049 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002050struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002051 struct qstr *name)
2052{
Al Virod9171b92016-04-15 03:33:13 -04002053 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002054
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002055 /*
2056 * First check if a dentry matching the name already exists,
2057 * if not go ahead and create it now.
2058 */
Barry Naujok94035402008-05-21 16:50:46 +10002059 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002060 if (found) {
2061 iput(inode);
2062 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002063 }
Al Virod9171b92016-04-15 03:33:13 -04002064 if (d_in_lookup(dentry)) {
2065 found = d_alloc_parallel(dentry->d_parent, name,
2066 dentry->d_wait);
2067 if (IS_ERR(found) || !d_in_lookup(found)) {
2068 iput(inode);
2069 return found;
2070 }
2071 } else {
2072 found = d_alloc(dentry->d_parent, name);
2073 if (!found) {
2074 iput(inode);
2075 return ERR_PTR(-ENOMEM);
2076 }
2077 }
2078 res = d_splice_alias(inode, found);
2079 if (res) {
2080 dput(found);
2081 return res;
2082 }
Al Viro4f522a22013-02-11 23:20:37 -05002083 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002084}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002085EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002087
Al Virod4c91a82016-06-25 23:33:49 -04002088static inline bool d_same_name(const struct dentry *dentry,
2089 const struct dentry *parent,
2090 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002091{
Al Virod4c91a82016-06-25 23:33:49 -04002092 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2093 if (dentry->d_name.len != name->len)
2094 return false;
2095 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002096 }
Al Viro6fa67e72016-07-31 16:37:25 -04002097 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002098 dentry->d_name.len, dentry->d_name.name,
2099 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002100}
2101
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002103 * __d_lookup_rcu - search for a dentry (racy, store-free)
2104 * @parent: parent dentry
2105 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002106 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002107 * Returns: dentry, or NULL
2108 *
2109 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2110 * resolution (store-free path walking) design described in
2111 * Documentation/filesystems/path-lookup.txt.
2112 *
2113 * This is not to be used outside core vfs.
2114 *
2115 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2116 * held, and rcu_read_lock held. The returned dentry must not be stored into
2117 * without taking d_lock and checking d_seq sequence count against @seq
2118 * returned here.
2119 *
Linus Torvalds15570082013-09-02 11:38:06 -07002120 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002121 * function.
2122 *
2123 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2124 * the returned dentry, so long as its parent's seqlock is checked after the
2125 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2126 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002127 *
2128 * NOTE! The caller *has* to check the resulting dentry against the sequence
2129 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002130 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002131struct dentry *__d_lookup_rcu(const struct dentry *parent,
2132 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002133 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002134{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002135 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002136 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002137 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002138 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002139 struct dentry *dentry;
2140
2141 /*
2142 * Note: There is significant duplication with __d_lookup_rcu which is
2143 * required to prevent single threaded performance regressions
2144 * especially on architectures where smp_rmb (in seqcounts) are costly.
2145 * Keep the two functions in sync.
2146 */
2147
2148 /*
2149 * The hash list is protected using RCU.
2150 *
2151 * Carefully use d_seq when comparing a candidate dentry, to avoid
2152 * races with d_move().
2153 *
2154 * It is possible that concurrent renames can mess up our list
2155 * walk here and result in missing our dentry, resulting in the
2156 * false-negative result. d_lookup() protects against concurrent
2157 * renames using rename_lock seqlock.
2158 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002159 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002160 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002161 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002162 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002163
Nick Piggin31e6b012011-01-07 17:49:52 +11002164seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002165 /*
2166 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002167 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002168 *
2169 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002170 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002171 *
2172 * NOTE! We do a "raw" seqcount_begin here. That means that
2173 * we don't wait for the sequence count to stabilize if it
2174 * is in the middle of a sequence change. If we do the slow
2175 * dentry compare, we will do seqretries until it is stable,
2176 * and if we end up with a successful lookup, we actually
2177 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002178 *
2179 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2180 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002181 */
2182 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002183 if (dentry->d_parent != parent)
2184 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002185 if (d_unhashed(dentry))
2186 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002187
2188 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002189 int tlen;
2190 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002191 if (dentry->d_name.hash != hashlen_hash(hashlen))
2192 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002193 tlen = dentry->d_name.len;
2194 tname = dentry->d_name.name;
2195 /* we want a consistent (name,len) pair */
2196 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2197 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002198 goto seqretry;
2199 }
Al Viro6fa67e72016-07-31 16:37:25 -04002200 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002201 tlen, tname, name) != 0)
2202 continue;
2203 } else {
2204 if (dentry->d_name.hash_len != hashlen)
2205 continue;
2206 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2207 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002208 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002209 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002210 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002211 }
2212 return NULL;
2213}
2214
2215/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 * d_lookup - search for a dentry
2217 * @parent: parent dentry
2218 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002219 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002221 * d_lookup searches the children of the parent dentry for the name in
2222 * question. If the dentry is found its reference count is incremented and the
2223 * dentry is returned. The caller must use dput to free the entry when it has
2224 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 */
Al Viroda2d8452013-01-24 18:29:34 -05002226struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227{
Nick Piggin31e6b012011-01-07 17:49:52 +11002228 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002229 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230
Daeseok Younb8314f92014-08-11 11:46:53 +09002231 do {
2232 seq = read_seqbegin(&rename_lock);
2233 dentry = __d_lookup(parent, name);
2234 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 break;
2236 } while (read_seqretry(&rename_lock, seq));
2237 return dentry;
2238}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002239EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
Nick Piggin31e6b012011-01-07 17:49:52 +11002241/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002242 * __d_lookup - search for a dentry (racy)
2243 * @parent: parent dentry
2244 * @name: qstr of name we wish to find
2245 * Returns: dentry, or NULL
2246 *
2247 * __d_lookup is like d_lookup, however it may (rarely) return a
2248 * false-negative result due to unrelated rename activity.
2249 *
2250 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2251 * however it must be used carefully, eg. with a following d_lookup in
2252 * the case of failure.
2253 *
2254 * __d_lookup callers must be commented.
2255 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002256struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002259 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002260 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002261 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002262 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Nick Pigginb04f7842010-08-18 04:37:34 +10002264 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002265 * Note: There is significant duplication with __d_lookup_rcu which is
2266 * required to prevent single threaded performance regressions
2267 * especially on architectures where smp_rmb (in seqcounts) are costly.
2268 * Keep the two functions in sync.
2269 */
2270
2271 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002272 * The hash list is protected using RCU.
2273 *
2274 * Take d_lock when comparing a candidate dentry, to avoid races
2275 * with d_move().
2276 *
2277 * It is possible that concurrent renames can mess up our list
2278 * walk here and result in missing our dentry, resulting in the
2279 * false-negative result. d_lookup() protects against concurrent
2280 * renames using rename_lock seqlock.
2281 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002282 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002283 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 rcu_read_lock();
2285
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002286 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 if (dentry->d_name.hash != hash)
2289 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290
2291 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 if (dentry->d_parent != parent)
2293 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002294 if (d_unhashed(dentry))
2295 goto next;
2296
Al Virod4c91a82016-06-25 23:33:49 -04002297 if (!d_same_name(dentry, parent, name))
2298 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299
Waiman Long98474232013-08-28 18:24:59 -07002300 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002301 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 spin_unlock(&dentry->d_lock);
2303 break;
2304next:
2305 spin_unlock(&dentry->d_lock);
2306 }
2307 rcu_read_unlock();
2308
2309 return found;
2310}
2311
2312/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002313 * d_hash_and_lookup - hash the qstr then search for a dentry
2314 * @dir: Directory to search in
2315 * @name: qstr of name we wish to find
2316 *
Al Viro4f522a22013-02-11 23:20:37 -05002317 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002318 */
2319struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2320{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002321 /*
2322 * Check for a fs-specific hash function. Note that we must
2323 * calculate the standard hash first, as the d_op->d_hash()
2324 * routine may choose to leave the hash value unchanged.
2325 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002326 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002327 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002328 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002329 if (unlikely(err < 0))
2330 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002331 }
Al Viro4f522a22013-02-11 23:20:37 -05002332 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002333}
Al Viro4f522a22013-02-11 23:20:37 -05002334EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002335
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336/*
2337 * When a file is deleted, we have two options:
2338 * - turn this dentry into a negative dentry
2339 * - unhash this dentry and free it.
2340 *
2341 * Usually, we want to just turn this into
2342 * a negative dentry, but if anybody else is
2343 * currently using the dentry or the inode
2344 * we can't do that and we fall back on removing
2345 * it from the hash queues and waiting for
2346 * it to be deleted later when it has no users
2347 */
2348
2349/**
2350 * d_delete - delete a dentry
2351 * @dentry: The dentry to delete
2352 *
2353 * Turn the dentry into a negative dentry if possible, otherwise
2354 * remove it from the hash queues so it can be deleted later
2355 */
2356
2357void d_delete(struct dentry * dentry)
2358{
Nick Piggin873feea2011-01-07 17:50:06 +11002359 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002360 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 /*
2362 * Are we the only user?
2363 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002364again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002366 inode = dentry->d_inode;
2367 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002368 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002369 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002370 spin_unlock(&dentry->d_lock);
2371 cpu_relax();
2372 goto again;
2373 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002374 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002375 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002376 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 return;
2378 }
2379
2380 if (!d_unhashed(dentry))
2381 __d_drop(dentry);
2382
2383 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002384
2385 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002387EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388
Al Viro15d3c582016-07-29 17:45:21 -04002389static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390{
Al Viro15d3c582016-07-29 17:45:21 -04002391 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown61647822017-11-10 15:45:41 +11002392
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002393 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002394 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002395 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396}
2397
2398/**
2399 * d_rehash - add an entry back to the hash
2400 * @entry: dentry to add to the hash
2401 *
2402 * Adds a dentry to the hash according to its name.
2403 */
2404
2405void d_rehash(struct dentry * entry)
2406{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002408 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002411EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412
Al Viro84e710d2016-04-15 00:58:55 -04002413static inline unsigned start_dir_add(struct inode *dir)
2414{
2415
2416 for (;;) {
2417 unsigned n = dir->i_dir_seq;
2418 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2419 return n;
2420 cpu_relax();
2421 }
2422}
2423
2424static inline void end_dir_add(struct inode *dir, unsigned n)
2425{
2426 smp_store_release(&dir->i_dir_seq, n + 2);
2427}
2428
Al Virod9171b92016-04-15 03:33:13 -04002429static void d_wait_lookup(struct dentry *dentry)
2430{
2431 if (d_in_lookup(dentry)) {
2432 DECLARE_WAITQUEUE(wait, current);
2433 add_wait_queue(dentry->d_wait, &wait);
2434 do {
2435 set_current_state(TASK_UNINTERRUPTIBLE);
2436 spin_unlock(&dentry->d_lock);
2437 schedule();
2438 spin_lock(&dentry->d_lock);
2439 } while (d_in_lookup(dentry));
2440 }
2441}
2442
Al Viro94bdd652016-04-15 02:42:04 -04002443struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002444 const struct qstr *name,
2445 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002446{
Al Viro94bdd652016-04-15 02:42:04 -04002447 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002448 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2449 struct hlist_bl_node *node;
2450 struct dentry *new = d_alloc(parent, name);
2451 struct dentry *dentry;
2452 unsigned seq, r_seq, d_seq;
2453
2454 if (unlikely(!new))
2455 return ERR_PTR(-ENOMEM);
2456
2457retry:
2458 rcu_read_lock();
2459 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2460 r_seq = read_seqbegin(&rename_lock);
2461 dentry = __d_lookup_rcu(parent, name, &d_seq);
2462 if (unlikely(dentry)) {
2463 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2464 rcu_read_unlock();
2465 goto retry;
2466 }
2467 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2468 rcu_read_unlock();
2469 dput(dentry);
2470 goto retry;
2471 }
2472 rcu_read_unlock();
2473 dput(new);
2474 return dentry;
2475 }
2476 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2477 rcu_read_unlock();
2478 goto retry;
2479 }
2480 hlist_bl_lock(b);
2481 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2482 hlist_bl_unlock(b);
2483 rcu_read_unlock();
2484 goto retry;
2485 }
Al Viro94bdd652016-04-15 02:42:04 -04002486 /*
2487 * No changes for the parent since the beginning of d_lookup().
2488 * Since all removals from the chain happen with hlist_bl_lock(),
2489 * any potential in-lookup matches are going to stay here until
2490 * we unlock the chain. All fields are stable in everything
2491 * we encounter.
2492 */
2493 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2494 if (dentry->d_name.hash != hash)
2495 continue;
2496 if (dentry->d_parent != parent)
2497 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002498 if (!d_same_name(dentry, parent, name))
2499 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002500 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002501 /* now we can try to grab a reference */
2502 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2503 rcu_read_unlock();
2504 goto retry;
2505 }
2506
2507 rcu_read_unlock();
2508 /*
2509 * somebody is likely to be still doing lookup for it;
2510 * wait for them to finish
2511 */
Al Virod9171b92016-04-15 03:33:13 -04002512 spin_lock(&dentry->d_lock);
2513 d_wait_lookup(dentry);
2514 /*
2515 * it's not in-lookup anymore; in principle we should repeat
2516 * everything from dcache lookup, but it's likely to be what
2517 * d_lookup() would've found anyway. If it is, just return it;
2518 * otherwise we really have to repeat the whole thing.
2519 */
2520 if (unlikely(dentry->d_name.hash != hash))
2521 goto mismatch;
2522 if (unlikely(dentry->d_parent != parent))
2523 goto mismatch;
2524 if (unlikely(d_unhashed(dentry)))
2525 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002526 if (unlikely(!d_same_name(dentry, parent, name)))
2527 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002528 /* OK, it *is* a hashed match; return it */
2529 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002530 dput(new);
2531 return dentry;
2532 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002533 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002534 /* we can't take ->d_lock here; it's OK, though. */
2535 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002536 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002537 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2538 hlist_bl_unlock(b);
2539 return new;
Al Virod9171b92016-04-15 03:33:13 -04002540mismatch:
2541 spin_unlock(&dentry->d_lock);
2542 dput(dentry);
2543 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002544}
2545EXPORT_SYMBOL(d_alloc_parallel);
2546
Al Viro85c7f812016-04-14 19:52:13 -04002547void __d_lookup_done(struct dentry *dentry)
2548{
Al Viro94bdd652016-04-15 02:42:04 -04002549 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2550 dentry->d_name.hash);
2551 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002552 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002553 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002554 wake_up_all(dentry->d_wait);
2555 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002556 hlist_bl_unlock(b);
2557 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002558 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002559}
2560EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002561
2562/* inode->i_lock held if inode is non-NULL */
2563
2564static inline void __d_add(struct dentry *dentry, struct inode *inode)
2565{
Al Viro84e710d2016-04-15 00:58:55 -04002566 struct inode *dir = NULL;
2567 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002568 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002569 if (unlikely(d_in_lookup(dentry))) {
2570 dir = dentry->d_parent->d_inode;
2571 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002572 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002573 }
Al Viroed782b52016-03-09 19:52:39 -05002574 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002575 unsigned add_flags = d_flags_for_inode(inode);
2576 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2577 raw_write_seqcount_begin(&dentry->d_seq);
2578 __d_set_inode_and_type(dentry, inode, add_flags);
2579 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002580 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002581 }
Al Viro15d3c582016-07-29 17:45:21 -04002582 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002583 if (dir)
2584 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002585 spin_unlock(&dentry->d_lock);
2586 if (inode)
2587 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002588}
2589
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002590/**
Al Viro34d0d192016-03-08 21:01:03 -05002591 * d_add - add dentry to hash queues
2592 * @entry: dentry to add
2593 * @inode: The inode to attach to this dentry
2594 *
2595 * This adds the entry to the hash queues and initializes @inode.
2596 * The entry was actually filled in earlier during d_alloc().
2597 */
2598
2599void d_add(struct dentry *entry, struct inode *inode)
2600{
Al Virob9680912016-04-11 00:53:26 -04002601 if (inode) {
2602 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002603 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002604 }
Al Viroed782b52016-03-09 19:52:39 -05002605 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002606}
2607EXPORT_SYMBOL(d_add);
2608
2609/**
Al Viro668d0cd2016-03-08 12:44:17 -05002610 * d_exact_alias - find and hash an exact unhashed alias
2611 * @entry: dentry to add
2612 * @inode: The inode to go with this dentry
2613 *
2614 * If an unhashed dentry with the same name/parent and desired
2615 * inode already exists, hash and return it. Otherwise, return
2616 * NULL.
2617 *
2618 * Parent directory should be locked.
2619 */
2620struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2621{
2622 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002623 unsigned int hash = entry->d_name.hash;
2624
2625 spin_lock(&inode->i_lock);
2626 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2627 /*
2628 * Don't need alias->d_lock here, because aliases with
2629 * d_parent == entry->d_parent are not subject to name or
2630 * parent changes, because the parent inode i_mutex is held.
2631 */
2632 if (alias->d_name.hash != hash)
2633 continue;
2634 if (alias->d_parent != entry->d_parent)
2635 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002636 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002637 continue;
2638 spin_lock(&alias->d_lock);
2639 if (!d_unhashed(alias)) {
2640 spin_unlock(&alias->d_lock);
2641 alias = NULL;
2642 } else {
2643 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002644 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002645 spin_unlock(&alias->d_lock);
2646 }
2647 spin_unlock(&inode->i_lock);
2648 return alias;
2649 }
2650 spin_unlock(&inode->i_lock);
2651 return NULL;
2652}
2653EXPORT_SYMBOL(d_exact_alias);
2654
2655/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002656 * dentry_update_name_case - update case insensitive dentry with a new name
2657 * @dentry: dentry to be updated
2658 * @name: new name
2659 *
2660 * Update a case insensitive dentry with new case of name.
2661 *
2662 * dentry must have been returned by d_lookup with name @name. Old and new
2663 * name lengths must match (ie. no d_compare which allows mismatched name
2664 * lengths).
2665 *
2666 * Parent inode i_mutex must be held over d_lookup and into this call (to
2667 * keep renames and concurrent inserts, and readdir(2) away).
2668 */
Al Viro9aba36d2016-07-20 22:28:45 -04002669void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002670{
Al Viro59551022016-01-22 15:40:57 -05002671 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002672 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2673
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002674 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002675 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002676 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002677 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002678 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002679}
2680EXPORT_SYMBOL(dentry_update_name_case);
2681
Al Viro8d85b482014-09-29 14:54:27 -04002682static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683{
Al Viro8d85b482014-09-29 14:54:27 -04002684 if (unlikely(dname_external(target))) {
2685 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 /*
2687 * Both external: swap the pointers
2688 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002689 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 } else {
2691 /*
2692 * dentry:internal, target:external. Steal target's
2693 * storage and make target internal.
2694 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002695 memcpy(target->d_iname, dentry->d_name.name,
2696 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 dentry->d_name.name = target->d_name.name;
2698 target->d_name.name = target->d_iname;
2699 }
2700 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002701 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 /*
2703 * dentry:external, target:internal. Give dentry's
2704 * storage to target and make dentry internal
2705 */
2706 memcpy(dentry->d_iname, target->d_name.name,
2707 target->d_name.len + 1);
2708 target->d_name.name = dentry->d_name.name;
2709 dentry->d_name.name = dentry->d_iname;
2710 } else {
2711 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002712 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002714 unsigned int i;
2715 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2716 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2717 swap(((long *) &dentry->d_iname)[i],
2718 ((long *) &target->d_iname)[i]);
2719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 }
2721 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002722 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723}
2724
Al Viro8d85b482014-09-29 14:54:27 -04002725static void copy_name(struct dentry *dentry, struct dentry *target)
2726{
2727 struct external_name *old_name = NULL;
2728 if (unlikely(dname_external(dentry)))
2729 old_name = external_name(dentry);
2730 if (unlikely(dname_external(target))) {
2731 atomic_inc(&external_name(target)->u.count);
2732 dentry->d_name = target->d_name;
2733 } else {
2734 memcpy(dentry->d_iname, target->d_name.name,
2735 target->d_name.len + 1);
2736 dentry->d_name.name = dentry->d_iname;
2737 dentry->d_name.hash_len = target->d_name.hash_len;
2738 }
2739 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2740 kfree_rcu(old_name, u.head);
2741}
2742
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002743static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2744{
2745 /*
2746 * XXXX: do we really need to take target->d_lock?
2747 */
2748 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2749 spin_lock(&target->d_parent->d_lock);
2750 else {
2751 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2752 spin_lock(&dentry->d_parent->d_lock);
2753 spin_lock_nested(&target->d_parent->d_lock,
2754 DENTRY_D_LOCK_NESTED);
2755 } else {
2756 spin_lock(&target->d_parent->d_lock);
2757 spin_lock_nested(&dentry->d_parent->d_lock,
2758 DENTRY_D_LOCK_NESTED);
2759 }
2760 }
2761 if (target < dentry) {
2762 spin_lock_nested(&target->d_lock, 2);
2763 spin_lock_nested(&dentry->d_lock, 3);
2764 } else {
2765 spin_lock_nested(&dentry->d_lock, 2);
2766 spin_lock_nested(&target->d_lock, 3);
2767 }
2768}
2769
Al Viro986c01942014-09-26 23:11:15 -04002770static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002771{
2772 if (target->d_parent != dentry->d_parent)
2773 spin_unlock(&dentry->d_parent->d_lock);
2774 if (target->d_parent != target)
2775 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002776 spin_unlock(&target->d_lock);
2777 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002778}
2779
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002781 * When switching names, the actual string doesn't strictly have to
2782 * be preserved in the target - because we're dropping the target
2783 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002784 * the new name before we switch, unless we are going to rehash
2785 * it. Note that if we *do* unhash the target, we are not allowed
2786 * to rehash it without giving it a new name/hash key - whether
2787 * we swap or overwrite the names here, resulting name won't match
2788 * the reality in filesystem; it's only there for d_path() purposes.
2789 * Note that all of this is happening under rename_lock, so the
2790 * any hash lookup seeing it in the middle of manipulations will
2791 * be discarded anyway. So we do not care what happens to the hash
2792 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002794/*
Al Viro18367502011-07-12 21:42:24 -04002795 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 * @dentry: entry to move
2797 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002798 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 *
2800 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002801 * dcache entries should not be moved in this way. Caller must hold
2802 * rename_lock, the i_mutex of the source and target directories,
2803 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002805static void __d_move(struct dentry *dentry, struct dentry *target,
2806 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807{
Al Viro84e710d2016-04-15 00:58:55 -04002808 struct inode *dir = NULL;
2809 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810 if (!dentry->d_inode)
2811 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2812
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002813 BUG_ON(d_ancestor(dentry, target));
2814 BUG_ON(d_ancestor(target, dentry));
2815
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002816 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002817 if (unlikely(d_in_lookup(target))) {
2818 dir = target->d_parent->d_inode;
2819 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002820 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002821 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822
Nick Piggin31e6b012011-01-07 17:49:52 +11002823 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002824 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002825
Al Viro15d3c582016-07-29 17:45:21 -04002826 /* unhash both */
NeilBrown61647822017-11-10 15:45:41 +11002827 /* ___d_drop does write_seqcount_barrier, but they're OK to nest. */
2828 ___d_drop(dentry);
2829 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002832 if (exchange)
2833 swap_names(dentry, target);
2834 else
2835 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836
Al Viro15d3c582016-07-29 17:45:21 -04002837 /* rehash in new place(s) */
2838 __d_rehash(dentry);
2839 if (exchange)
2840 __d_rehash(target);
NeilBrown61647822017-11-10 15:45:41 +11002841 else
2842 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002843
Al Viro63cf4272014-09-26 23:06:14 -04002844 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002846 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002847 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848 dentry->d_parent = target->d_parent;
2849 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002850 list_del_init(&target->d_child);
2851 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002853 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002854 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002855 list_move(&target->d_child, &target->d_parent->d_subdirs);
2856 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002857 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002858 fsnotify_update_flags(target);
2859 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860 }
2861
Nick Piggin31e6b012011-01-07 17:49:52 +11002862 write_seqcount_end(&target->d_seq);
2863 write_seqcount_end(&dentry->d_seq);
2864
Al Viro84e710d2016-04-15 00:58:55 -04002865 if (dir)
2866 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002867 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002868}
2869
2870/*
2871 * d_move - move a dentry
2872 * @dentry: entry to move
2873 * @target: new dentry
2874 *
2875 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002876 * dcache entries should not be moved in this way. See the locking
2877 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002878 */
2879void d_move(struct dentry *dentry, struct dentry *target)
2880{
2881 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002882 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002884}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002885EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886
Miklos Szeredida1ce062014-04-01 17:08:43 +02002887/*
2888 * d_exchange - exchange two dentries
2889 * @dentry1: first dentry
2890 * @dentry2: second dentry
2891 */
2892void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2893{
2894 write_seqlock(&rename_lock);
2895
2896 WARN_ON(!dentry1->d_inode);
2897 WARN_ON(!dentry2->d_inode);
2898 WARN_ON(IS_ROOT(dentry1));
2899 WARN_ON(IS_ROOT(dentry2));
2900
2901 __d_move(dentry1, dentry2, true);
2902
2903 write_sequnlock(&rename_lock);
2904}
2905
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002906/**
2907 * d_ancestor - search for an ancestor
2908 * @p1: ancestor dentry
2909 * @p2: child dentry
2910 *
2911 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2912 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002913 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002914struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002915{
2916 struct dentry *p;
2917
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002918 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002919 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002920 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002921 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002922 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002923}
2924
2925/*
2926 * This helper attempts to cope with remotely renamed directories
2927 *
2928 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002929 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002930 *
2931 * Note: If ever the locking in lock_rename() changes, then please
2932 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002933 */
Al Virob5ae6b12014-10-12 22:16:02 -04002934static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002935 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002936{
Al Viro9902af72016-04-15 15:08:36 -04002937 struct mutex *m1 = NULL;
2938 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002939 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002940
2941 /* If alias and dentry share a parent, then no extra locks required */
2942 if (alias->d_parent == dentry->d_parent)
2943 goto out_unalias;
2944
Trond Myklebust9eaef272006-10-21 10:24:20 -07002945 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002946 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2947 goto out_err;
2948 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002949 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002950 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002951 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002952out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002953 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002954 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002955out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002956 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002957 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958 if (m1)
2959 mutex_unlock(m1);
2960 return ret;
2961}
2962
David Howells770bfad2006-08-22 20:06:07 -04002963/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002964 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2965 * @inode: the inode which may have a disconnected dentry
2966 * @dentry: a negative dentry which we want to point to the inode.
2967 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002968 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2969 * place of the given dentry and return it, else simply d_add the inode
2970 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002971 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002972 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2973 * we should error out: directories can't have multiple aliases.
2974 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002975 * This is needed in the lookup routine of any filesystem that is exportable
2976 * (via knfsd) so that we can build dcache paths to directories effectively.
2977 *
2978 * If a dentry was found and moved, then it is returned. Otherwise NULL
2979 * is returned. This matches the expected return value of ->lookup.
2980 *
2981 * Cluster filesystems may call this function with a negative, hashed dentry.
2982 * In that case, we know that the inode will be a regular file, and also this
2983 * will only occur during atomic_open. So we need to check for the dentry
2984 * being already hashed only in the final case.
2985 */
2986struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2987{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002988 if (IS_ERR(inode))
2989 return ERR_CAST(inode);
2990
David Howells770bfad2006-08-22 20:06:07 -04002991 BUG_ON(!d_unhashed(dentry));
2992
Al Virode689f52016-03-09 18:05:42 -05002993 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002994 goto out;
Al Virode689f52016-03-09 18:05:42 -05002995
Al Virob9680912016-04-11 00:53:26 -04002996 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002997 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002998 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002999 struct dentry *new = __d_find_any_alias(inode);
3000 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003001 /* The reference to new ensures it remains an alias */
3002 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003003 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003004 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003005 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003006 dput(new);
3007 new = ERR_PTR(-ELOOP);
3008 pr_warn_ratelimited(
3009 "VFS: Lookup of '%s' in %s %s"
3010 " would have caused loop\n",
3011 dentry->d_name.name,
3012 inode->i_sb->s_type->name,
3013 inode->i_sb->s_id);
3014 } else if (!IS_ROOT(new)) {
3015 int err = __d_unalias(inode, dentry, new);
3016 write_sequnlock(&rename_lock);
3017 if (err) {
3018 dput(new);
3019 new = ERR_PTR(err);
3020 }
Al Viro18367502011-07-12 21:42:24 -04003021 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003022 __d_move(new, dentry, false);
3023 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003024 }
Al Virob5ae6b12014-10-12 22:16:02 -04003025 iput(inode);
3026 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003027 }
David Howells770bfad2006-08-22 20:06:07 -04003028 }
Al Virob5ae6b12014-10-12 22:16:02 -04003029out:
Al Viroed782b52016-03-09 19:52:39 -05003030 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003031 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003032}
Al Virob5ae6b12014-10-12 22:16:02 -04003033EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003034
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003035static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003036{
3037 *buflen -= namelen;
3038 if (*buflen < 0)
3039 return -ENAMETOOLONG;
3040 *buffer -= namelen;
3041 memcpy(*buffer, str, namelen);
3042 return 0;
3043}
3044
Waiman Long232d2d62013-09-09 12:18:13 -04003045/**
3046 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003047 * @buffer: buffer pointer
3048 * @buflen: allocated length of the buffer
3049 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003050 *
Mark Rutland66702eb2017-10-23 14:07:14 -07003051 * With RCU path tracing, it may race with d_move(). Use READ_ONCE() to
Waiman Long232d2d62013-09-09 12:18:13 -04003052 * make sure that either the old or the new name pointer and length are
3053 * fetched. However, there may be mismatch between length and pointer.
3054 * The length cannot be trusted, we need to copy it byte-by-byte until
3055 * the length is reached or a null byte is found. It also prepends "/" at
3056 * the beginning of the name. The sequence number check at the caller will
3057 * retry it again when a d_move() does happen. So any garbage in the buffer
3058 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003059 *
3060 * Data dependency barrier is needed to make sure that we see that terminating
3061 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003062 */
Al Viro9aba36d2016-07-20 22:28:45 -04003063static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003064{
Mark Rutland66702eb2017-10-23 14:07:14 -07003065 const char *dname = READ_ONCE(name->name);
3066 u32 dlen = READ_ONCE(name->len);
Waiman Long232d2d62013-09-09 12:18:13 -04003067 char *p;
3068
Al Viro6d13f692014-09-29 14:46:30 -04003069 smp_read_barrier_depends();
3070
Waiman Long232d2d62013-09-09 12:18:13 -04003071 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003072 if (*buflen < 0)
3073 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003074 p = *buffer -= dlen + 1;
3075 *p++ = '/';
3076 while (dlen--) {
3077 char c = *dname++;
3078 if (!c)
3079 break;
3080 *p++ = c;
3081 }
3082 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003083}
3084
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003086 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003087 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003088 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003089 * @buffer: pointer to the end of the buffer
3090 * @buflen: pointer to buffer length
3091 *
Waiman Long18129972013-09-12 10:55:35 -04003092 * The function will first try to write out the pathname without taking any
3093 * lock other than the RCU read lock to make sure that dentries won't go away.
3094 * It only checks the sequence number of the global rename_lock as any change
3095 * in the dentry's d_seq will be preceded by changes in the rename_lock
3096 * sequence number. If the sequence number had been changed, it will restart
3097 * the whole pathname back-tracing sequence again by taking the rename_lock.
3098 * In this case, there is no need to take the RCU read lock as the recursive
3099 * parent pointer references will keep the dentry chain alive as long as no
3100 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003101 */
Al Viro02125a82011-12-05 08:43:34 -05003102static int prepend_path(const struct path *path,
3103 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003104 char **buffer, int *buflen)
3105{
Al Viroede4ceb2013-11-13 07:45:40 -05003106 struct dentry *dentry;
3107 struct vfsmount *vfsmnt;
3108 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003109 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003110 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003111 char *bptr;
3112 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003113
Al Viro48f5ec22013-09-09 15:22:25 -04003114 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003115restart_mnt:
3116 read_seqbegin_or_lock(&mount_lock, &m_seq);
3117 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003118 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003119restart:
3120 bptr = *buffer;
3121 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003122 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003123 dentry = path->dentry;
3124 vfsmnt = path->mnt;
3125 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003126 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003127 while (dentry != root->dentry || vfsmnt != root->mnt) {
3128 struct dentry * parent;
3129
3130 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003131 struct mount *parent = READ_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003132 /* Escaped? */
3133 if (dentry != vfsmnt->mnt_root) {
3134 bptr = *buffer;
3135 blen = *buflen;
3136 error = 3;
3137 break;
3138 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003139 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003140 if (mnt != parent) {
Mark Rutland66702eb2017-10-23 14:07:14 -07003141 dentry = READ_ONCE(mnt->mnt_mountpoint);
Al Viro48a066e2013-09-29 22:06:07 -04003142 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003143 vfsmnt = &mnt->mnt;
3144 continue;
3145 }
Waiman Long232d2d62013-09-09 12:18:13 -04003146 if (!error)
3147 error = is_mounted(vfsmnt) ? 1 : 2;
3148 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003149 }
3150 parent = dentry->d_parent;
3151 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003152 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003153 if (error)
3154 break;
3155
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003156 dentry = parent;
3157 }
Al Viro48f5ec22013-09-09 15:22:25 -04003158 if (!(seq & 1))
3159 rcu_read_unlock();
3160 if (need_seqretry(&rename_lock, seq)) {
3161 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003162 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003163 }
Al Viro48f5ec22013-09-09 15:22:25 -04003164 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003165
3166 if (!(m_seq & 1))
3167 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003168 if (need_seqretry(&mount_lock, m_seq)) {
3169 m_seq = 1;
3170 goto restart_mnt;
3171 }
3172 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003173
Waiman Long232d2d62013-09-09 12:18:13 -04003174 if (error >= 0 && bptr == *buffer) {
3175 if (--blen < 0)
3176 error = -ENAMETOOLONG;
3177 else
3178 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003179 }
Waiman Long232d2d62013-09-09 12:18:13 -04003180 *buffer = bptr;
3181 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003182 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003183}
3184
3185/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003186 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003187 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003188 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003189 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190 * @buflen: buffer length
3191 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003192 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003194 * Returns a pointer into the buffer or an error code if the
3195 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003196 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003197 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003198 *
Al Viro02125a82011-12-05 08:43:34 -05003199 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 */
Al Viro02125a82011-12-05 08:43:34 -05003201char *__d_path(const struct path *path,
3202 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003203 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003205 char *res = buf + buflen;
3206 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003208 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003209 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003210
Al Viro02125a82011-12-05 08:43:34 -05003211 if (error < 0)
3212 return ERR_PTR(error);
3213 if (error > 0)
3214 return NULL;
3215 return res;
3216}
3217
3218char *d_absolute_path(const struct path *path,
3219 char *buf, int buflen)
3220{
3221 struct path root = {};
3222 char *res = buf + buflen;
3223 int error;
3224
3225 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003226 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003227
3228 if (error > 1)
3229 error = -EINVAL;
3230 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003231 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003232 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233}
3234
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003235/*
3236 * same as __d_path but appends "(deleted)" for unlinked files.
3237 */
Al Viro02125a82011-12-05 08:43:34 -05003238static int path_with_deleted(const struct path *path,
3239 const struct path *root,
3240 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003241{
3242 prepend(buf, buflen, "\0", 1);
3243 if (d_unlinked(path->dentry)) {
3244 int error = prepend(buf, buflen, " (deleted)", 10);
3245 if (error)
3246 return error;
3247 }
3248
3249 return prepend_path(path, root, buf, buflen);
3250}
3251
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003252static int prepend_unreachable(char **buffer, int *buflen)
3253{
3254 return prepend(buffer, buflen, "(unreachable)", 13);
3255}
3256
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003257static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3258{
3259 unsigned seq;
3260
3261 do {
3262 seq = read_seqcount_begin(&fs->seq);
3263 *root = fs->root;
3264 } while (read_seqcount_retry(&fs->seq, seq));
3265}
3266
Jan Bluncka03a8a702008-02-14 19:38:32 -08003267/**
3268 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003269 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003270 * @buf: buffer to return value in
3271 * @buflen: buffer length
3272 *
3273 * Convert a dentry into an ASCII path name. If the entry has been deleted
3274 * the string " (deleted)" is appended. Note that this is ambiguous.
3275 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003276 * Returns a pointer into the buffer or an error code if the path was
3277 * too long. Note: Callers should use the returned pointer, not the passed
3278 * in buffer, to use the name! The implementation often starts at an offset
3279 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003280 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003281 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003282 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003283char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003285 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003286 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003287 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003289 /*
3290 * We have various synthetic filesystems that never get mounted. On
3291 * these filesystems dentries are never used for lookup purposes, and
3292 * thus don't need to be hashed. They also don't need a name until a
3293 * user wants to identify the object in /proc/pid/fd/. The little hack
3294 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003295 *
3296 * Some pseudo inodes are mountable. When they are mounted
3297 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3298 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003299 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003300 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3301 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003302 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003303
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003304 rcu_read_lock();
3305 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003306 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003307 rcu_read_unlock();
3308
Al Viro02125a82011-12-05 08:43:34 -05003309 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003310 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311 return res;
3312}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003313EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314
3315/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003316 * Helper function for dentry_operations.d_dname() members
3317 */
3318char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3319 const char *fmt, ...)
3320{
3321 va_list args;
3322 char temp[64];
3323 int sz;
3324
3325 va_start(args, fmt);
3326 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3327 va_end(args);
3328
3329 if (sz > sizeof(temp) || sz > buflen)
3330 return ERR_PTR(-ENAMETOOLONG);
3331
3332 buffer += buflen - sz;
3333 return memcpy(buffer, temp, sz);
3334}
3335
Al Viro118b2302013-08-24 12:08:17 -04003336char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3337{
3338 char *end = buffer + buflen;
3339 /* these dentries are never renamed, so d_lock is not needed */
3340 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003341 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003342 prepend(&end, &buflen, "/", 1))
3343 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003344 return end;
Al Viro118b2302013-08-24 12:08:17 -04003345}
David Herrmann31bbe162014-01-03 14:09:47 +01003346EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003347
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003348/*
Ram Pai6092d042008-03-27 13:06:20 +01003349 * Write full pathname from the root of the filesystem into the buffer.
3350 */
Al Virof6500802014-01-26 12:37:55 -05003351static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003352{
Al Virof6500802014-01-26 12:37:55 -05003353 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003354 char *end, *retval;
3355 int len, seq = 0;
3356 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003357
Al Virof6500802014-01-26 12:37:55 -05003358 if (buflen < 2)
3359 goto Elong;
3360
Al Viro48f5ec22013-09-09 15:22:25 -04003361 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003362restart:
Al Virof6500802014-01-26 12:37:55 -05003363 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003364 end = buf + buflen;
3365 len = buflen;
3366 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003367 /* Get '/' right */
3368 retval = end-1;
3369 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003370 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003371 while (!IS_ROOT(dentry)) {
3372 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003373
Ram Pai6092d042008-03-27 13:06:20 +01003374 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003375 error = prepend_name(&end, &len, &dentry->d_name);
3376 if (error)
3377 break;
Ram Pai6092d042008-03-27 13:06:20 +01003378
3379 retval = end;
3380 dentry = parent;
3381 }
Al Viro48f5ec22013-09-09 15:22:25 -04003382 if (!(seq & 1))
3383 rcu_read_unlock();
3384 if (need_seqretry(&rename_lock, seq)) {
3385 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003386 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003387 }
3388 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003389 if (error)
3390 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003391 return retval;
3392Elong:
3393 return ERR_PTR(-ENAMETOOLONG);
3394}
Nick Pigginec2447c2011-01-07 17:49:29 +11003395
3396char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3397{
Waiman Long232d2d62013-09-09 12:18:13 -04003398 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003399}
3400EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003401
3402char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3403{
3404 char *p = NULL;
3405 char *retval;
3406
Al Viroc1031352010-06-06 22:31:14 -04003407 if (d_unlinked(dentry)) {
3408 p = buf + buflen;
3409 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3410 goto Elong;
3411 buflen++;
3412 }
3413 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003414 if (!IS_ERR(retval) && p)
3415 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003416 return retval;
3417Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003418 return ERR_PTR(-ENAMETOOLONG);
3419}
3420
Linus Torvalds8b19e342013-09-12 10:35:47 -07003421static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3422 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003423{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003424 unsigned seq;
3425
3426 do {
3427 seq = read_seqcount_begin(&fs->seq);
3428 *root = fs->root;
3429 *pwd = fs->pwd;
3430 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003431}
3432
Ram Pai6092d042008-03-27 13:06:20 +01003433/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003434 * NOTE! The user-level library version returns a
3435 * character pointer. The kernel system call just
3436 * returns the length of the buffer filled (which
3437 * includes the ending '\0' character), or a negative
3438 * error value. So libc would do something like
3439 *
3440 * char *getcwd(char * buf, size_t size)
3441 * {
3442 * int retval;
3443 *
3444 * retval = sys_getcwd(buf, size);
3445 * if (retval >= 0)
3446 * return buf;
3447 * errno = -retval;
3448 * return NULL;
3449 * }
3450 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003451SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452{
Linus Torvalds552ce542007-02-13 12:08:18 -08003453 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003454 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003455 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456
3457 if (!page)
3458 return -ENOMEM;
3459
Linus Torvalds8b19e342013-09-12 10:35:47 -07003460 rcu_read_lock();
3461 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462
Linus Torvalds552ce542007-02-13 12:08:18 -08003463 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003464 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003465 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003466 char *cwd = page + PATH_MAX;
3467 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003468
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003469 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003470 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003471 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003472
Al Viro02125a82011-12-05 08:43:34 -05003473 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003474 goto out;
3475
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003476 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003477 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003478 error = prepend_unreachable(&cwd, &buflen);
3479 if (error)
3480 goto out;
3481 }
3482
Linus Torvalds552ce542007-02-13 12:08:18 -08003483 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003484 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003485 if (len <= size) {
3486 error = len;
3487 if (copy_to_user(buf, cwd, len))
3488 error = -EFAULT;
3489 }
Nick Piggin949854d2011-01-07 17:49:37 +11003490 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003491 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003492 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493
3494out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003495 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496 return error;
3497}
3498
3499/*
3500 * Test whether new_dentry is a subdirectory of old_dentry.
3501 *
3502 * Trivially implemented using the dcache structure
3503 */
3504
3505/**
3506 * is_subdir - is new dentry a subdirectory of old_dentry
3507 * @new_dentry: new dentry
3508 * @old_dentry: old dentry
3509 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003510 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3511 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3513 */
3514
Yaowei Baia6e57872015-11-17 14:40:11 +08003515bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516{
Yaowei Baia6e57872015-11-17 14:40:11 +08003517 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003518 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003520 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003521 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003522
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003523 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003524 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003526 /*
3527 * Need rcu_readlock to protect against the d_parent trashing
3528 * due to d_move
3529 */
3530 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003531 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003532 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003533 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003534 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003535 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537
3538 return result;
3539}
3540
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003541static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003543 struct dentry *root = data;
3544 if (dentry != root) {
3545 if (d_unhashed(dentry) || !dentry->d_inode)
3546 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003548 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3549 dentry->d_flags |= DCACHE_GENOCIDE;
3550 dentry->d_lockref.count--;
3551 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003553 return D_WALK_CONTINUE;
3554}
Nick Piggin58db63d2011-01-07 17:49:39 +11003555
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003556void d_genocide(struct dentry *parent)
3557{
3558 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003559}
3560
Al Viro60545d02013-06-07 01:20:27 -04003561void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562{
Al Viro60545d02013-06-07 01:20:27 -04003563 inode_dec_link_count(inode);
3564 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003565 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003566 !d_unlinked(dentry));
3567 spin_lock(&dentry->d_parent->d_lock);
3568 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3569 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3570 (unsigned long long)inode->i_ino);
3571 spin_unlock(&dentry->d_lock);
3572 spin_unlock(&dentry->d_parent->d_lock);
3573 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574}
Al Viro60545d02013-06-07 01:20:27 -04003575EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003576
3577static __initdata unsigned long dhash_entries;
3578static int __init set_dhash_entries(char *str)
3579{
3580 if (!str)
3581 return 0;
3582 dhash_entries = simple_strtoul(str, &str, 0);
3583 return 1;
3584}
3585__setup("dhash_entries=", set_dhash_entries);
3586
3587static void __init dcache_init_early(void)
3588{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 /* If hashes are distributed across NUMA nodes, defer
3590 * hash allocation until vmalloc space is available.
3591 */
3592 if (hashdist)
3593 return;
3594
3595 dentry_hashtable =
3596 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003597 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 dhash_entries,
3599 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003600 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601 &d_hash_shift,
3602 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003603 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605}
3606
Denis Cheng74bf17c2007-10-16 23:26:30 -07003607static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608{
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003609 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610 * A constructor could be added for stable state like the lists,
3611 * but it is probably not worth it because of the cache nature
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003612 * of the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003614 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003615 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616
3617 /* Hash may have been set up in dcache_init_early */
3618 if (!hashdist)
3619 return;
3620
3621 dentry_hashtable =
3622 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003623 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624 dhash_entries,
3625 13,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07003626 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627 &d_hash_shift,
3628 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003629 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003631}
3632
3633/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003634struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003635EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636
Linus Torvalds1da177e2005-04-16 15:20:36 -07003637EXPORT_SYMBOL(d_genocide);
3638
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639void __init vfs_caches_init_early(void)
3640{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003641 int i;
3642
3643 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3644 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3645
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646 dcache_init_early();
3647 inode_init_early();
3648}
3649
Mel Gorman4248b0d2015-08-06 15:46:20 -07003650void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003652 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003653 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654
Denis Cheng74bf17c2007-10-16 23:26:30 -07003655 dcache_init();
3656 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003657 files_init();
3658 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003659 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660 bdev_cache_init();
3661 chrdev_init();
3662}