blob: 461ff8f234e3d270cfd97443eee9439df988bb5a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080041#include <linux/kasan.h>
42
David Howells07f3f052006-09-30 20:52:18 +020043#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050044#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nick Piggin789680d2011-01-07 17:49:30 +110046/*
47 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110048 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040049 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110050 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100054 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110055 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110060 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110061 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110062 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040064 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110065 *
66 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110067 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110068 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100069 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110070 * dcache_hash_bucket lock
71 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110072 *
Nick Pigginda502952011-01-07 17:49:33 +110073 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110080 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080084int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
Al Viro74c3cbe2007-07-22 08:04:18 -040087__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Nick Piggin949854d2011-01-07 17:49:37 +110089EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Christoph Lametere18b8902006-12-06 20:33:20 -080091static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700105static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106
Linus Torvalds8387ff22016-06-10 07:51:30 -0700107static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108{
George Spelvin703b5fa2016-06-10 00:22:12 -0400109 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Al Viro94bdd652016-04-15 02:42:04 -0400112#define IN_LOOKUP_SHIFT 10
113static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
114
115static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
116 unsigned int hash)
117{
118 hash += (unsigned long) parent / L1_CACHE_BYTES;
119 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
120}
121
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Statistics gathering. */
124struct dentry_stat_t dentry_stat = {
125 .age_limit = 45,
126};
127
Glauber Costa3942c072013-08-28 10:17:53 +1000128static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000129static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400130
131#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000132
133/*
134 * Here we resort to our own counters instead of using generic per-cpu counters
135 * for consistency with what the vfs inode code does. We are expected to harvest
136 * better code and performance by having our own specialized counters.
137 *
138 * Please note that the loop is done over all possible CPUs, not over all online
139 * CPUs. The reason for this is that we don't want to play games with CPUs going
140 * on and off. If one of them goes off, we will just keep their counters.
141 *
142 * glommer: See cffbc8a for details, and if you ever intend to change this,
143 * please update all vfs counters to match.
144 */
Glauber Costa3942c072013-08-28 10:17:53 +1000145static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146{
147 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000148 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry, i);
151 return sum < 0 ? 0 : sum;
152}
153
Dave Chinner62d36c72013-08-28 10:17:54 +1000154static long get_nr_dentry_unused(void)
155{
156 int i;
157 long sum = 0;
158 for_each_possible_cpu(i)
159 sum += per_cpu(nr_dentry_unused, i);
160 return sum < 0 ? 0 : sum;
161}
162
Joe Perches1f7e0612014-06-06 14:38:05 -0700163int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400164 size_t *lenp, loff_t *ppos)
165{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000167 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000168 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169}
170#endif
171
Linus Torvalds5483f182012-03-04 15:51:42 -0800172/*
173 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
174 * The strings are both count bytes long, and count is non-zero.
175 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700176#ifdef CONFIG_DCACHE_WORD_ACCESS
177
178#include <asm/word-at-a-time.h>
179/*
180 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
181 * aligned allocation for this particular component. We don't
182 * strictly need the load_unaligned_zeropad() safety, but it
183 * doesn't hurt either.
184 *
185 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
186 * need the careful unaligned handling.
187 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700188static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800189{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800190 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191
192 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700193 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700194 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 if (tcount < sizeof(unsigned long))
196 break;
197 if (unlikely(a != b))
198 return 1;
199 cs += sizeof(unsigned long);
200 ct += sizeof(unsigned long);
201 tcount -= sizeof(unsigned long);
202 if (!tcount)
203 return 0;
204 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000205 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800206 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700207}
208
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800209#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210
Linus Torvalds94753db52012-05-10 12:19:19 -0700211static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212{
Linus Torvalds5483f182012-03-04 15:51:42 -0800213 do {
214 if (*cs != *ct)
215 return 1;
216 cs++;
217 ct++;
218 tcount--;
219 } while (tcount);
220 return 0;
221}
222
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700223#endif
224
Linus Torvalds94753db52012-05-10 12:19:19 -0700225static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
226{
Linus Torvalds94753db52012-05-10 12:19:19 -0700227 /*
228 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000229 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700230 *
231 * NOTE! Even if a rename will mean that the length
232 * was not loaded atomically, we don't care. The
233 * RCU walk will check the sequence count eventually,
234 * and catch it. And we won't overrun the buffer,
235 * because we're reading the name pointer atomically,
236 * and a dentry name is guaranteed to be properly
237 * terminated with a NUL byte.
238 *
239 * End result: even if 'len' is wrong, we'll exit
240 * early because the data cannot match (there can
241 * be no NUL in the ct/tcount data)
242 */
He Kuangae0a8432016-03-26 09:12:10 +0000243 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
244
Linus Torvalds6326c712012-05-21 16:14:04 -0700245 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700246}
247
Al Viro8d85b482014-09-29 14:54:27 -0400248struct external_name {
249 union {
250 atomic_t count;
251 struct rcu_head head;
252 } u;
253 unsigned char name[];
254};
255
256static inline struct external_name *external_name(struct dentry *dentry)
257{
258 return container_of(dentry->d_name.name, struct external_name, name[0]);
259}
260
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400261static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400263 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
264
Al Viro8d85b482014-09-29 14:54:27 -0400265 kmem_cache_free(dentry_cache, dentry);
266}
267
268static void __d_free_external(struct rcu_head *head)
269{
270 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400271 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 kmem_cache_free(dentry_cache, dentry);
273}
274
Al Viro810bb172014-10-12 12:45:37 -0400275static inline int dname_external(const struct dentry *dentry)
276{
277 return dentry->d_name.name != dentry->d_iname;
278}
279
Al Viroad25f112017-07-07 14:51:19 -0400280void take_dentry_name_snapshot(struct name_snapshot *name, struct dentry *dentry)
281{
282 spin_lock(&dentry->d_lock);
283 if (unlikely(dname_external(dentry))) {
284 struct external_name *p = external_name(dentry);
285 atomic_inc(&p->u.count);
286 spin_unlock(&dentry->d_lock);
287 name->name = p->name;
288 } else {
289 memcpy(name->inline_name, dentry->d_iname, DNAME_INLINE_LEN);
290 spin_unlock(&dentry->d_lock);
291 name->name = name->inline_name;
292 }
293}
294EXPORT_SYMBOL(take_dentry_name_snapshot);
295
296void release_dentry_name_snapshot(struct name_snapshot *name)
297{
298 if (unlikely(name->name != name->inline_name)) {
299 struct external_name *p;
300 p = container_of(name->name, struct external_name, name[0]);
301 if (unlikely(atomic_dec_and_test(&p->u.count)))
302 kfree_rcu(p, u.head);
303 }
304}
305EXPORT_SYMBOL(release_dentry_name_snapshot);
306
David Howells4bf46a22015-03-05 14:09:22 +0000307static inline void __d_set_inode_and_type(struct dentry *dentry,
308 struct inode *inode,
309 unsigned type_flags)
310{
311 unsigned flags;
312
313 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000314 flags = READ_ONCE(dentry->d_flags);
315 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
316 flags |= type_flags;
317 WRITE_ONCE(dentry->d_flags, flags);
318}
319
David Howells4bf46a22015-03-05 14:09:22 +0000320static inline void __d_clear_type_and_inode(struct dentry *dentry)
321{
322 unsigned flags = READ_ONCE(dentry->d_flags);
323
324 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
325 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000326 dentry->d_inode = NULL;
327}
328
Al Virob4f03542014-04-29 23:40:14 -0400329static void dentry_free(struct dentry *dentry)
330{
Al Viro946e51f2014-10-26 19:19:16 -0400331 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400332 if (unlikely(dname_external(dentry))) {
333 struct external_name *p = external_name(dentry);
334 if (likely(atomic_dec_and_test(&p->u.count))) {
335 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
336 return;
337 }
338 }
Al Virob4f03542014-04-29 23:40:14 -0400339 /* if dentry was never visible to RCU, immediate free is OK */
340 if (!(dentry->d_flags & DCACHE_RCUACCESS))
341 __d_free(&dentry->d_u.d_rcu);
342 else
343 call_rcu(&dentry->d_u.d_rcu, __d_free);
344}
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346/*
347 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400348 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100349 */
350static void dentry_unlink_inode(struct dentry * dentry)
351 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100352 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100353{
354 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500355
Al Viro59199c02018-08-09 10:15:54 -0400356 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000357 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400358 hlist_del_init(&dentry->d_u.d_alias);
Al Viro59199c02018-08-09 10:15:54 -0400359 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100360 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100361 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100362 if (!inode->i_nlink)
363 fsnotify_inoderemove(inode);
364 if (dentry->d_op && dentry->d_op->d_iput)
365 dentry->d_op->d_iput(dentry, inode);
366 else
367 iput(inode);
368}
369
370/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400371 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
372 * is in use - which includes both the "real" per-superblock
373 * LRU list _and_ the DCACHE_SHRINK_LIST use.
374 *
375 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
376 * on the shrink list (ie not on the superblock LRU list).
377 *
378 * The per-cpu "nr_dentry_unused" counters are updated with
379 * the DCACHE_LRU_LIST bit.
380 *
381 * These helper functions make sure we always follow the
382 * rules. d_lock must be held by the caller.
383 */
384#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
385static void d_lru_add(struct dentry *dentry)
386{
387 D_FLAG_VERIFY(dentry, 0);
388 dentry->d_flags |= DCACHE_LRU_LIST;
389 this_cpu_inc(nr_dentry_unused);
390 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
391}
392
393static void d_lru_del(struct dentry *dentry)
394{
395 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
396 dentry->d_flags &= ~DCACHE_LRU_LIST;
397 this_cpu_dec(nr_dentry_unused);
398 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
399}
400
401static void d_shrink_del(struct dentry *dentry)
402{
403 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
404 list_del_init(&dentry->d_lru);
405 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
406 this_cpu_dec(nr_dentry_unused);
407}
408
409static void d_shrink_add(struct dentry *dentry, struct list_head *list)
410{
411 D_FLAG_VERIFY(dentry, 0);
412 list_add(&dentry->d_lru, list);
413 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
414 this_cpu_inc(nr_dentry_unused);
415}
416
417/*
418 * These can only be called under the global LRU lock, ie during the
419 * callback for freeing the LRU list. "isolate" removes it from the
420 * LRU lists entirely, while shrink_move moves it to the indicated
421 * private list.
422 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800423static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400424{
425 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
426 dentry->d_flags &= ~DCACHE_LRU_LIST;
427 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800428 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400429}
430
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800431static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
432 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400433{
434 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
435 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800436 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400437}
438
439/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000440 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700441 */
442static void dentry_lru_add(struct dentry *dentry)
443{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400444 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
445 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700446}
447
Miklos Szeredid52b9082007-05-08 00:23:46 -0700448/**
Nick Piggin789680d2011-01-07 17:49:30 +1100449 * d_drop - drop a dentry
450 * @dentry: dentry to drop
451 *
452 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
453 * be found through a VFS lookup any more. Note that this is different from
454 * deleting the dentry - d_delete will try to mark the dentry negative if
455 * possible, giving a successful _negative_ lookup, while d_drop will
456 * just make the cache lookup fail.
457 *
458 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
459 * reason (NFS timeouts or autofs deletes).
460 *
NeilBrown3aa66ba2017-11-10 15:45:41 +1100461 * __d_drop requires dentry->d_lock
462 * ___d_drop doesn't mark dentry as "unhashed"
463 * (dentry->d_hash.pprev will be LIST_POISON2, not NULL).
Nick Piggin789680d2011-01-07 17:49:30 +1100464 */
NeilBrown3aa66ba2017-11-10 15:45:41 +1100465static void ___d_drop(struct dentry *dentry)
Nick Piggin789680d2011-01-07 17:49:30 +1100466{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700467 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400468 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400469 /*
470 * Hashed dentries are normally on the dentry hashtable,
471 * with the exception of those newly allocated by
472 * d_obtain_alias, which are always IS_ROOT:
473 */
474 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400475 b = &dentry->d_sb->s_anon;
476 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700477 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400478
479 hlist_bl_lock(b);
480 __hlist_bl_del(&dentry->d_hash);
Al Virob61625d2013-10-04 11:09:01 -0400481 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400482 /* After this call, in-progress rcu-walk path lookup will fail. */
483 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100484 }
485}
NeilBrown3aa66ba2017-11-10 15:45:41 +1100486
487void __d_drop(struct dentry *dentry)
488{
489 ___d_drop(dentry);
490 dentry->d_hash.pprev = NULL;
491}
Nick Piggin789680d2011-01-07 17:49:30 +1100492EXPORT_SYMBOL(__d_drop);
493
494void d_drop(struct dentry *dentry)
495{
Nick Piggin789680d2011-01-07 17:49:30 +1100496 spin_lock(&dentry->d_lock);
497 __d_drop(dentry);
498 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100499}
500EXPORT_SYMBOL(d_drop);
501
Al Viroba65dc52016-06-10 11:32:47 -0400502static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
503{
504 struct dentry *next;
505 /*
506 * Inform d_walk() and shrink_dentry_list() that we are no longer
507 * attached to the dentry tree
508 */
509 dentry->d_flags |= DCACHE_DENTRY_KILLED;
510 if (unlikely(list_empty(&dentry->d_child)))
511 return;
512 __list_del_entry(&dentry->d_child);
513 /*
514 * Cursors can move around the list of children. While we'd been
515 * a normal list member, it didn't matter - ->d_child.next would've
516 * been updated. However, from now on it won't be and for the
517 * things like d_walk() it might end up with a nasty surprise.
518 * Normally d_walk() doesn't care about cursors moving around -
519 * ->d_lock on parent prevents that and since a cursor has no children
520 * of its own, we get through it without ever unlocking the parent.
521 * There is one exception, though - if we ascend from a child that
522 * gets killed as soon as we unlock it, the next sibling is found
523 * using the value left in its ->d_child.next. And if _that_
524 * pointed to a cursor, and cursor got moved (e.g. by lseek())
525 * before d_walk() regains parent->d_lock, we'll end up skipping
526 * everything the cursor had been moved past.
527 *
528 * Solution: make sure that the pointer left behind in ->d_child.next
529 * points to something that won't be moving around. I.e. skip the
530 * cursors.
531 */
532 while (dentry->d_child.next != &parent->d_subdirs) {
533 next = list_entry(dentry->d_child.next, struct dentry, d_child);
534 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
535 break;
536 dentry->d_child.next = next->d_child.next;
537 }
538}
539
Al Viroe55fd012014-05-28 13:51:12 -0400540static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100541{
Al Viro41edf272014-05-01 10:30:00 -0400542 struct dentry *parent = NULL;
543 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400544 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100545 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100546
Linus Torvalds0d984392013-09-08 13:46:52 -0700547 /*
548 * The dentry is now unrecoverably dead to the world.
549 */
550 lockref_mark_dead(&dentry->d_lockref);
551
Sage Weilf0023bc2011-10-28 10:02:42 -0700552 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700553 * inform the fs via d_prune that this dentry is about to be
554 * unhashed and destroyed.
555 */
Al Viro29266202014-05-30 11:39:02 -0400556 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800557 dentry->d_op->d_prune(dentry);
558
Al Viro01b60352014-04-29 23:42:52 -0400559 if (dentry->d_flags & DCACHE_LRU_LIST) {
560 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
561 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400562 }
Nick Piggin77812a12011-01-07 17:49:48 +1100563 /* if it was on the hash then remove it */
564 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400565 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400566 if (parent)
567 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400568 if (dentry->d_inode)
569 dentry_unlink_inode(dentry);
570 else
571 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400572 this_cpu_dec(nr_dentry);
573 if (dentry->d_op && dentry->d_op->d_release)
574 dentry->d_op->d_release(dentry);
575
Al Viro41edf272014-05-01 10:30:00 -0400576 spin_lock(&dentry->d_lock);
577 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
578 dentry->d_flags |= DCACHE_MAY_FREE;
579 can_free = false;
580 }
581 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400582 if (likely(can_free))
583 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400584}
585
586/*
587 * Finish off a dentry we've decided to kill.
588 * dentry->d_lock must be held, returns with it unlocked.
589 * If ref is non-zero, then decrement the refcount too.
590 * Returns dentry requiring refcount drop, or NULL if we're done.
591 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400592static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400593 __releases(dentry->d_lock)
594{
595 struct inode *inode = dentry->d_inode;
596 struct dentry *parent = NULL;
597
598 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
599 goto failed;
600
601 if (!IS_ROOT(dentry)) {
602 parent = dentry->d_parent;
603 if (unlikely(!spin_trylock(&parent->d_lock))) {
604 if (inode)
605 spin_unlock(&inode->i_lock);
606 goto failed;
607 }
608 }
609
610 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400611 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400612
613failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400614 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400615 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100616}
617
Al Viro046b9612014-05-29 08:54:52 -0400618static inline struct dentry *lock_parent(struct dentry *dentry)
619{
620 struct dentry *parent = dentry->d_parent;
621 if (IS_ROOT(dentry))
622 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800623 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400624 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400625 if (likely(spin_trylock(&parent->d_lock)))
626 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400627 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400628 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400629again:
630 parent = ACCESS_ONCE(dentry->d_parent);
631 spin_lock(&parent->d_lock);
632 /*
633 * We can't blindly lock dentry until we are sure
634 * that we won't violate the locking order.
635 * Any changes of dentry->d_parent must have
636 * been done with parent->d_lock held, so
637 * spin_lock() above is enough of a barrier
638 * for checking if it's still our child.
639 */
640 if (unlikely(parent != dentry->d_parent)) {
641 spin_unlock(&parent->d_lock);
642 goto again;
643 }
Al Viro05f16fe2018-02-23 20:47:17 -0500644 if (parent != dentry) {
Linus Torvalds9f126002014-05-31 09:13:21 -0700645 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro05f16fe2018-02-23 20:47:17 -0500646 if (unlikely(dentry->d_lockref.count < 0)) {
647 spin_unlock(&parent->d_lock);
648 parent = NULL;
649 }
650 } else {
Al Viro046b9612014-05-29 08:54:52 -0400651 parent = NULL;
Al Viro05f16fe2018-02-23 20:47:17 -0500652 }
653 rcu_read_unlock();
Al Viro046b9612014-05-29 08:54:52 -0400654 return parent;
655}
656
Linus Torvalds360f5472015-01-09 15:19:03 -0800657/*
658 * Try to do a lockless dput(), and return whether that was successful.
659 *
660 * If unsuccessful, we return false, having already taken the dentry lock.
661 *
662 * The caller needs to hold the RCU read lock, so that the dentry is
663 * guaranteed to stay around even if the refcount goes down to zero!
664 */
665static inline bool fast_dput(struct dentry *dentry)
666{
667 int ret;
668 unsigned int d_flags;
669
670 /*
671 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100672 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800673 */
674 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
675 return lockref_put_or_lock(&dentry->d_lockref);
676
677 /*
678 * .. otherwise, we can try to just decrement the
679 * lockref optimistically.
680 */
681 ret = lockref_put_return(&dentry->d_lockref);
682
683 /*
684 * If the lockref_put_return() failed due to the lock being held
685 * by somebody else, the fast path has failed. We will need to
686 * get the lock, and then check the count again.
687 */
688 if (unlikely(ret < 0)) {
689 spin_lock(&dentry->d_lock);
690 if (dentry->d_lockref.count > 1) {
691 dentry->d_lockref.count--;
692 spin_unlock(&dentry->d_lock);
693 return 1;
694 }
695 return 0;
696 }
697
698 /*
699 * If we weren't the last ref, we're done.
700 */
701 if (ret)
702 return 1;
703
704 /*
705 * Careful, careful. The reference count went down
706 * to zero, but we don't hold the dentry lock, so
707 * somebody else could get it again, and do another
708 * dput(), and we need to not race with that.
709 *
710 * However, there is a very special and common case
711 * where we don't care, because there is nothing to
712 * do: the dentry is still hashed, it does not have
713 * a 'delete' op, and it's referenced and already on
714 * the LRU list.
715 *
716 * NOTE! Since we aren't locked, these values are
717 * not "stable". However, it is sufficient that at
718 * some point after we dropped the reference the
719 * dentry was hashed and the flags had the proper
720 * value. Other dentry users may have re-gotten
721 * a reference to the dentry and change that, but
722 * our work is done - we can leave the dentry
723 * around with a zero refcount.
724 */
725 smp_rmb();
726 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100727 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800728
729 /* Nothing to do? Dropping the reference was all we needed? */
730 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
731 return 1;
732
733 /*
734 * Not the fast normal case? Get the lock. We've already decremented
735 * the refcount, but we'll need to re-check the situation after
736 * getting the lock.
737 */
738 spin_lock(&dentry->d_lock);
739
740 /*
741 * Did somebody else grab a reference to it in the meantime, and
742 * we're no longer the last user after all? Alternatively, somebody
743 * else could have killed it and marked it dead. Either way, we
744 * don't need to do anything else.
745 */
746 if (dentry->d_lockref.count) {
747 spin_unlock(&dentry->d_lock);
748 return 1;
749 }
750
751 /*
752 * Re-get the reference we optimistically dropped. We hold the
753 * lock, and we just tested that it was zero, so we can just
754 * set it to 1.
755 */
756 dentry->d_lockref.count = 1;
757 return 0;
758}
759
760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761/*
762 * This is dput
763 *
764 * This is complicated by the fact that we do not want to put
765 * dentries that are no longer on any hash chain on the unused
766 * list: we'd much rather just get rid of them immediately.
767 *
768 * However, that implies that we have to traverse the dentry
769 * tree upwards to the parents which might _also_ now be
770 * scheduled for deletion (it may have been only waiting for
771 * its last child to go away).
772 *
773 * This tail recursion is done by hand as we don't want to depend
774 * on the compiler to always get this right (gcc generally doesn't).
775 * Real recursion would eat up our stack space.
776 */
777
778/*
779 * dput - release a dentry
780 * @dentry: dentry to release
781 *
782 * Release a dentry. This will drop the usage count and if appropriate
783 * call the dentry unlink method as well as removing it from the queues and
784 * releasing its resources. If the parent dentries were scheduled for release
785 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787void dput(struct dentry *dentry)
788{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700789 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 return;
791
792repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800793 might_sleep();
794
Linus Torvalds360f5472015-01-09 15:19:03 -0800795 rcu_read_lock();
796 if (likely(fast_dput(dentry))) {
797 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800799 }
800
801 /* Slow case: now with the dentry lock held */
802 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Al Viro85c7f812016-04-14 19:52:13 -0400804 WARN_ON(d_in_lookup(dentry));
805
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700806 /* Unreachable? Get rid of it */
807 if (unlikely(d_unhashed(dentry)))
808 goto kill_it;
809
Al Viro75a6f822015-07-08 02:42:38 +0100810 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
811 goto kill_it;
812
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700813 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100815 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 }
Nick Piggin265ac902010-10-10 05:36:24 -0400817
Linus Torvalds358eec12013-10-31 15:43:02 -0700818 if (!(dentry->d_flags & DCACHE_REFERENCED))
819 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400820 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400821
Waiman Long98474232013-08-28 18:24:59 -0700822 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100823 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 return;
825
Miklos Szeredid52b9082007-05-08 00:23:46 -0700826kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400827 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800828 if (dentry) {
829 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700830 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700833EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100836/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100837static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838{
Waiman Long98474232013-08-28 18:24:59 -0700839 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
Nick Piggindc0474b2011-01-07 17:49:43 +1100842static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100843{
Waiman Long98474232013-08-28 18:24:59 -0700844 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100845}
846
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100847struct dentry *dget_parent(struct dentry *dentry)
848{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700849 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100850 struct dentry *ret;
851
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700852 /*
853 * Do optimistic parent lookup without any
854 * locking.
855 */
856 rcu_read_lock();
857 ret = ACCESS_ONCE(dentry->d_parent);
858 gotref = lockref_get_not_zero(&ret->d_lockref);
859 rcu_read_unlock();
860 if (likely(gotref)) {
861 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
862 return ret;
863 dput(ret);
864 }
865
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100866repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100867 /*
868 * Don't need rcu_dereference because we re-check it was correct under
869 * the lock.
870 */
871 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100872 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100873 spin_lock(&ret->d_lock);
874 if (unlikely(ret != dentry->d_parent)) {
875 spin_unlock(&ret->d_lock);
876 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100877 goto repeat;
878 }
Nick Piggina734eb42011-01-07 17:49:44 +1100879 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700880 BUG_ON(!ret->d_lockref.count);
881 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100882 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100883 return ret;
884}
885EXPORT_SYMBOL(dget_parent);
886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887/**
888 * d_find_alias - grab a hashed alias of inode
889 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 *
891 * If inode has a hashed alias, or is a directory and has any alias,
892 * acquire the reference to alias and return it. Otherwise return NULL.
893 * Notice that if inode is a directory there can be only one alias and
894 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800895 * of a filesystem, or if the directory was renamed and d_revalidate
896 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700898 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500899 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500901static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902{
Nick Pigginda502952011-01-07 17:49:33 +1100903 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Nick Pigginda502952011-01-07 17:49:33 +1100905again:
906 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400907 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100908 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700910 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100911 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500913 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100914 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100915 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 return alias;
917 }
918 }
Nick Pigginda502952011-01-07 17:49:33 +1100919 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 }
Nick Pigginda502952011-01-07 17:49:33 +1100921 if (discon_alias) {
922 alias = discon_alias;
923 spin_lock(&alias->d_lock);
924 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500925 __dget_dlock(alias);
926 spin_unlock(&alias->d_lock);
927 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100928 }
929 spin_unlock(&alias->d_lock);
930 goto again;
931 }
932 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933}
934
Nick Pigginda502952011-01-07 17:49:33 +1100935struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
David Howells214fda12006-03-25 03:06:36 -0800937 struct dentry *de = NULL;
938
Al Virob3d9b7a2012-06-09 13:51:19 -0400939 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100940 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500941 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100942 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800943 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 return de;
945}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700946EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
948/*
949 * Try to kill dentries associated with this inode.
950 * WARNING: you must own a reference to inode.
951 */
952void d_prune_aliases(struct inode *inode)
953{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700954 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100956 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400957 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700959 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400960 struct dentry *parent = lock_parent(dentry);
961 if (likely(!dentry->d_lockref.count)) {
962 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800963 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400964 goto restart;
965 }
966 if (parent)
967 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 }
969 spin_unlock(&dentry->d_lock);
970 }
Nick Piggin873feea2011-01-07 17:50:06 +1100971 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700973EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400975static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
Al Viro5c47e6d2014-04-29 16:13:18 -0400977 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700978
Miklos Szeredi60942f22014-05-02 15:38:39 -0400979 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400980 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400981 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100982 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400983 parent = lock_parent(dentry);
984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000986 * The dispose list is isolated and dentries are not accounted
987 * to the LRU here, so we can simply remove it from the list
988 * here regardless of whether it is referenced or not.
989 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400990 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000991
992 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000994 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800996 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700997 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400998 if (parent)
999 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 continue;
1001 }
Nick Piggin77812a12011-01-07 17:49:48 +11001002
Al Viro64fd72e2014-05-28 09:48:44 -04001003
1004 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1005 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1006 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001007 if (parent)
1008 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001009 if (can_free)
1010 dentry_free(dentry);
1011 continue;
1012 }
1013
Al Viroff2fde92014-05-28 13:59:13 -04001014 inode = dentry->d_inode;
1015 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001016 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001017 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001018 if (parent)
1019 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001020 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001021 }
Al Viroff2fde92014-05-28 13:59:13 -04001022
Al Viroff2fde92014-05-28 13:59:13 -04001023 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001024
Al Viro5c47e6d2014-04-29 16:13:18 -04001025 /*
1026 * We need to prune ancestors too. This is necessary to prevent
1027 * quadratic behavior of shrink_dcache_parent(), but is also
1028 * expected to be beneficial in reducing dentry cache
1029 * fragmentation.
1030 */
1031 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001032 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1033 parent = lock_parent(dentry);
1034 if (dentry->d_lockref.count != 1) {
1035 dentry->d_lockref.count--;
1036 spin_unlock(&dentry->d_lock);
1037 if (parent)
1038 spin_unlock(&parent->d_lock);
1039 break;
1040 }
1041 inode = dentry->d_inode; /* can't be NULL */
1042 if (unlikely(!spin_trylock(&inode->i_lock))) {
1043 spin_unlock(&dentry->d_lock);
1044 if (parent)
1045 spin_unlock(&parent->d_lock);
1046 cpu_relax();
1047 continue;
1048 }
1049 __dentry_kill(dentry);
1050 dentry = parent;
1051 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001053}
1054
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001055static enum lru_status dentry_lru_isolate(struct list_head *item,
1056 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001057{
1058 struct list_head *freeable = arg;
1059 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1060
1061
1062 /*
1063 * we are inverting the lru lock/dentry->d_lock here,
1064 * so use a trylock. If we fail to get the lock, just skip
1065 * it
1066 */
1067 if (!spin_trylock(&dentry->d_lock))
1068 return LRU_SKIP;
1069
1070 /*
1071 * Referenced dentries are still in use. If they have active
1072 * counts, just remove them from the LRU. Otherwise give them
1073 * another pass through the LRU.
1074 */
1075 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001076 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001077 spin_unlock(&dentry->d_lock);
1078 return LRU_REMOVED;
1079 }
1080
1081 if (dentry->d_flags & DCACHE_REFERENCED) {
1082 dentry->d_flags &= ~DCACHE_REFERENCED;
1083 spin_unlock(&dentry->d_lock);
1084
1085 /*
1086 * The list move itself will be made by the common LRU code. At
1087 * this point, we've dropped the dentry->d_lock but keep the
1088 * lru lock. This is safe to do, since every list movement is
1089 * protected by the lru lock even if both locks are held.
1090 *
1091 * This is guaranteed by the fact that all LRU management
1092 * functions are intermediated by the LRU API calls like
1093 * list_lru_add and list_lru_del. List movement in this file
1094 * only ever occur through this functions or through callbacks
1095 * like this one, that are called from the LRU API.
1096 *
1097 * The only exceptions to this are functions like
1098 * shrink_dentry_list, and code that first checks for the
1099 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1100 * operating only with stack provided lists after they are
1101 * properly isolated from the main list. It is thus, always a
1102 * local access.
1103 */
1104 return LRU_ROTATE;
1105 }
1106
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001107 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001108 spin_unlock(&dentry->d_lock);
1109
1110 return LRU_REMOVED;
1111}
1112
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001113/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001114 * prune_dcache_sb - shrink the dcache
1115 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001116 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001117 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001118 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1119 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001120 * function.
1121 *
1122 * This function may fail to free any resources if all the dentries are in
1123 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001124 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001125long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001126{
Dave Chinnerf6041562013-08-28 10:18:00 +10001127 LIST_HEAD(dispose);
1128 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001129
Vladimir Davydov503c3582015-02-12 14:58:47 -08001130 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1131 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001132 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001133 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134}
1135
Glauber Costa4e717f52013-08-28 10:18:03 +10001136static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001137 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001138{
Glauber Costa4e717f52013-08-28 10:18:03 +10001139 struct list_head *freeable = arg;
1140 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001141
Glauber Costa4e717f52013-08-28 10:18:03 +10001142 /*
1143 * we are inverting the lru lock/dentry->d_lock here,
1144 * so use a trylock. If we fail to get the lock, just skip
1145 * it
1146 */
1147 if (!spin_trylock(&dentry->d_lock))
1148 return LRU_SKIP;
1149
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001150 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001151 spin_unlock(&dentry->d_lock);
1152
1153 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001154}
1155
Glauber Costa4e717f52013-08-28 10:18:03 +10001156
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001157/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 * shrink_dcache_sb - shrink dcache for a superblock
1159 * @sb: superblock
1160 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001161 * Shrink the dcache for the specified super block. This is used to free
1162 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001164void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165{
Glauber Costa4e717f52013-08-28 10:18:03 +10001166 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001167
Glauber Costa4e717f52013-08-28 10:18:03 +10001168 do {
1169 LIST_HEAD(dispose);
1170
1171 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001172 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001173
1174 this_cpu_sub(nr_dentry_unused, freed);
1175 shrink_dentry_list(&dispose);
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001176 cond_resched();
1177 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001179EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182 * enum d_walk_ret - action to talke during tree walk
1183 * @D_WALK_CONTINUE: contrinue walk
1184 * @D_WALK_QUIT: quit walk
1185 * @D_WALK_NORETRY: quit when retry is needed
1186 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001188enum d_walk_ret {
1189 D_WALK_CONTINUE,
1190 D_WALK_QUIT,
1191 D_WALK_NORETRY,
1192 D_WALK_SKIP,
1193};
1194
1195/**
1196 * d_walk - walk the dentry tree
1197 * @parent: start of walk
1198 * @data: data passed to @enter() and @finish()
1199 * @enter: callback when first entering the dentry
1200 * @finish: callback when successfully finished the walk
1201 *
1202 * The @enter() and @finish() callbacks are called with d_lock held.
1203 */
1204static void d_walk(struct dentry *parent, void *data,
1205 enum d_walk_ret (*enter)(void *, struct dentry *),
1206 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Nick Piggin949854d2011-01-07 17:49:37 +11001208 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001210 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 enum d_walk_ret ret;
1212 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001213
Nick Piggin58db63d2011-01-07 17:49:39 +11001214again:
Al Viro48f5ec22013-09-09 15:22:25 -04001215 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001216 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001217 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218
1219 ret = enter(data, this_parent);
1220 switch (ret) {
1221 case D_WALK_CONTINUE:
1222 break;
1223 case D_WALK_QUIT:
1224 case D_WALK_SKIP:
1225 goto out_unlock;
1226 case D_WALK_NORETRY:
1227 retry = false;
1228 break;
1229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230repeat:
1231 next = this_parent->d_subdirs.next;
1232resume:
1233 while (next != &this_parent->d_subdirs) {
1234 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001235 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001237
Al Viroba65dc52016-06-10 11:32:47 -04001238 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1239 continue;
1240
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001241 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242
1243 ret = enter(data, dentry);
1244 switch (ret) {
1245 case D_WALK_CONTINUE:
1246 break;
1247 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001248 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001249 goto out_unlock;
1250 case D_WALK_NORETRY:
1251 retry = false;
1252 break;
1253 case D_WALK_SKIP:
1254 spin_unlock(&dentry->d_lock);
1255 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001256 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001259 spin_unlock(&this_parent->d_lock);
1260 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001262 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 goto repeat;
1264 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001265 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 }
1267 /*
1268 * All done at this level ... ascend and resume the search.
1269 */
Al Viroca5358e2014-10-26 19:31:10 -04001270 rcu_read_lock();
1271ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001273 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001274 this_parent = child->d_parent;
1275
Al Viro31dec132013-10-25 17:04:27 -04001276 spin_unlock(&child->d_lock);
1277 spin_lock(&this_parent->d_lock);
1278
Al Viroca5358e2014-10-26 19:31:10 -04001279 /* might go back up the wrong parent if we have had a rename. */
1280 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001281 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001282 /* go into the first sibling still alive */
1283 do {
1284 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001285 if (next == &this_parent->d_subdirs)
1286 goto ascend;
1287 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001288 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001289 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 goto resume;
1291 }
Al Viroca5358e2014-10-26 19:31:10 -04001292 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001293 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001294 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001295 if (finish)
1296 finish(data);
1297
1298out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001299 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001300 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001301 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001302
1303rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001304 spin_unlock(&this_parent->d_lock);
1305 rcu_read_unlock();
1306 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001307 if (!retry)
1308 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001309 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001310 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001312
1313/*
1314 * Search for at least 1 mount point in the dentry's subdirs.
1315 * We descend to the next level whenever the d_subdirs
1316 * list is non-empty and continue searching.
1317 */
1318
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001319static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1320{
1321 int *ret = data;
1322 if (d_mountpoint(dentry)) {
1323 *ret = 1;
1324 return D_WALK_QUIT;
1325 }
1326 return D_WALK_CONTINUE;
1327}
1328
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001329/**
1330 * have_submounts - check for mounts over a dentry
1331 * @parent: dentry to check.
1332 *
1333 * Return true if the parent or its subdirectories contain
1334 * a mount point
1335 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336int have_submounts(struct dentry *parent)
1337{
1338 int ret = 0;
1339
1340 d_walk(parent, &ret, check_mount, NULL);
1341
1342 return ret;
1343}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001344EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001347 * Called by mount code to set a mountpoint and check if the mountpoint is
1348 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1349 * subtree can become unreachable).
1350 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001351 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001352 * this reason take rename_lock and d_lock on dentry and ancestors.
1353 */
1354int d_set_mounted(struct dentry *dentry)
1355{
1356 struct dentry *p;
1357 int ret = -ENOENT;
1358 write_seqlock(&rename_lock);
1359 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001360 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001361 spin_lock(&p->d_lock);
1362 if (unlikely(d_unhashed(p))) {
1363 spin_unlock(&p->d_lock);
1364 goto out;
1365 }
1366 spin_unlock(&p->d_lock);
1367 }
1368 spin_lock(&dentry->d_lock);
1369 if (!d_unlinked(dentry)) {
Eric W. Biederman1a62a0f2017-01-03 14:18:43 +13001370 ret = -EBUSY;
1371 if (!d_mountpoint(dentry)) {
1372 dentry->d_flags |= DCACHE_MOUNTED;
1373 ret = 0;
1374 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001375 }
1376 spin_unlock(&dentry->d_lock);
1377out:
1378 write_sequnlock(&rename_lock);
1379 return ret;
1380}
1381
1382/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001383 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 * and move any unused dentries to the end of the unused
1385 * list for prune_dcache(). We descend to the next level
1386 * whenever the d_subdirs list is non-empty and continue
1387 * searching.
1388 *
1389 * It returns zero iff there are no unused children,
1390 * otherwise it returns the number of children moved to
1391 * the end of the unused list. This may not be the total
1392 * number of unused children, because select_parent can
1393 * drop the lock and return early due to latency
1394 * constraints.
1395 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001396
1397struct select_data {
1398 struct dentry *start;
1399 struct list_head dispose;
1400 int found;
1401};
1402
1403static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001405 struct select_data *data = _data;
1406 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001408 if (data->start == dentry)
1409 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Al Virofe915222014-05-03 00:02:25 -04001411 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001412 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001413 } else {
1414 if (dentry->d_flags & DCACHE_LRU_LIST)
1415 d_lru_del(dentry);
1416 if (!dentry->d_lockref.count) {
1417 d_shrink_add(dentry, &data->dispose);
1418 data->found++;
1419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 }
1421 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001422 * We can return to the caller if we have found some (this
1423 * ensures forward progress). We'll be coming back to find
1424 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 */
Al Virofe915222014-05-03 00:02:25 -04001426 if (!list_empty(&data->dispose))
1427 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001429 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430}
1431
1432/**
1433 * shrink_dcache_parent - prune dcache
1434 * @parent: parent of entries to prune
1435 *
1436 * Prune the dcache to remove unused children of the parent dentry.
1437 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001438void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001440 for (;;) {
1441 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001443 INIT_LIST_HEAD(&data.dispose);
1444 data.start = parent;
1445 data.found = 0;
1446
1447 d_walk(parent, &data, select_collect, NULL);
1448 if (!data.found)
1449 break;
1450
1451 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001452 cond_resched();
1453 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001455EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Al Viro9c8c10e2014-05-02 20:36:10 -04001457static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001458{
Al Viro9c8c10e2014-05-02 20:36:10 -04001459 /* it has busy descendents; complain about those instead */
1460 if (!list_empty(&dentry->d_subdirs))
1461 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001462
Al Viro9c8c10e2014-05-02 20:36:10 -04001463 /* root with refcount 1 is fine */
1464 if (dentry == _data && dentry->d_lockref.count == 1)
1465 return D_WALK_CONTINUE;
1466
1467 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1468 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001469 dentry,
1470 dentry->d_inode ?
1471 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001472 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001473 dentry->d_lockref.count,
1474 dentry->d_sb->s_type->name,
1475 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001476 WARN_ON(1);
1477 return D_WALK_CONTINUE;
1478}
1479
1480static void do_one_tree(struct dentry *dentry)
1481{
1482 shrink_dcache_parent(dentry);
1483 d_walk(dentry, dentry, umount_check, NULL);
1484 d_drop(dentry);
1485 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001486}
1487
1488/*
1489 * destroy the dentries attached to a superblock on unmounting
1490 */
1491void shrink_dcache_for_umount(struct super_block *sb)
1492{
1493 struct dentry *dentry;
1494
Al Viro9c8c10e2014-05-02 20:36:10 -04001495 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001496
1497 dentry = sb->s_root;
1498 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001499 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001500
1501 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001502 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1503 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001504 }
1505}
1506
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001507struct detach_data {
1508 struct select_data select;
1509 struct dentry *mountpoint;
1510};
1511static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001512{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001513 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001514
1515 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001516 __dget_dlock(dentry);
1517 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001518 return D_WALK_QUIT;
1519 }
1520
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001521 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001522}
1523
1524static void check_and_drop(void *_data)
1525{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001526 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001528 if (!data->mountpoint && !data->select.found)
1529 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001530}
1531
1532/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001533 * d_invalidate - detach submounts, prune dcache, and drop
1534 * @dentry: dentry to invalidate (aka detach, prune and drop)
1535 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001536 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001537 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001538 * The final d_drop is done as an atomic operation relative to
1539 * rename_lock ensuring there are no races with d_set_mounted. This
1540 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001541 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001542void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001543{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001544 /*
1545 * If it's already been dropped, return OK.
1546 */
1547 spin_lock(&dentry->d_lock);
1548 if (d_unhashed(dentry)) {
1549 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001550 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001551 }
1552 spin_unlock(&dentry->d_lock);
1553
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001554 /* Negative dentries can be dropped without further checks */
1555 if (!dentry->d_inode) {
1556 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001557 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001558 }
1559
1560 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001561 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001562
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001563 data.mountpoint = NULL;
1564 INIT_LIST_HEAD(&data.select.dispose);
1565 data.select.start = dentry;
1566 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001567
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001568 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001569
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001570 if (data.select.found)
1571 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001572
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001573 if (data.mountpoint) {
1574 detach_mounts(data.mountpoint);
1575 dput(data.mountpoint);
1576 }
1577
1578 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001579 break;
1580
1581 cond_resched();
1582 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001583}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001584EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586/**
Al Viroa4464db2011-07-07 15:03:58 -04001587 * __d_alloc - allocate a dcache entry
1588 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 * @name: qstr of the name
1590 *
1591 * Allocates a dentry. It returns %NULL if there is insufficient memory
1592 * available. On a success the dentry is returned. The name passed in is
1593 * copied and the copy passed in may be reused after this call.
1594 */
1595
Al Viroa4464db2011-07-07 15:03:58 -04001596struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597{
1598 struct dentry *dentry;
1599 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001600 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Mel Gormane12ba742007-10-16 01:25:52 -07001602 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 if (!dentry)
1604 return NULL;
1605
Linus Torvalds6326c712012-05-21 16:14:04 -07001606 /*
1607 * We guarantee that the inline name is always NUL-terminated.
1608 * This way the memcpy() done by the name switching in rename
1609 * will still always have a NUL at the end, even if we might
1610 * be overwriting an internal NUL character
1611 */
1612 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001613 if (unlikely(!name)) {
1614 static const struct qstr anon = QSTR_INIT("/", 1);
1615 name = &anon;
1616 dname = dentry->d_iname;
1617 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001618 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001619 struct external_name *p = kmalloc(size + name->len,
1620 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001621 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 kmem_cache_free(dentry_cache, dentry);
1623 return NULL;
1624 }
Al Viro8d85b482014-09-29 14:54:27 -04001625 atomic_set(&p->u.count, 1);
1626 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001627 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1628 kasan_unpoison_shadow(dname,
1629 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 } else {
1631 dname = dentry->d_iname;
1632 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
1634 dentry->d_name.len = name->len;
1635 dentry->d_name.hash = name->hash;
1636 memcpy(dname, name->name, name->len);
1637 dname[name->len] = 0;
1638
Linus Torvalds6326c712012-05-21 16:14:04 -07001639 /* Make sure we always see the terminating NUL character */
1640 smp_wmb();
1641 dentry->d_name.name = dname;
1642
Waiman Long98474232013-08-28 18:24:59 -07001643 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001644 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001646 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001648 dentry->d_parent = dentry;
1649 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 dentry->d_op = NULL;
1651 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001652 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 INIT_LIST_HEAD(&dentry->d_lru);
1654 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001655 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1656 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001657 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Miklos Szeredi285b1022016-06-28 11:47:32 +02001659 if (dentry->d_op && dentry->d_op->d_init) {
1660 err = dentry->d_op->d_init(dentry);
1661 if (err) {
1662 if (dname_external(dentry))
1663 kfree(external_name(dentry));
1664 kmem_cache_free(dentry_cache, dentry);
1665 return NULL;
1666 }
1667 }
1668
Nick Piggin3e880fb2011-01-07 17:49:19 +11001669 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 return dentry;
1672}
Al Viroa4464db2011-07-07 15:03:58 -04001673
1674/**
1675 * d_alloc - allocate a dcache entry
1676 * @parent: parent of entry to allocate
1677 * @name: qstr of the name
1678 *
1679 * Allocates a dentry. It returns %NULL if there is insufficient memory
1680 * available. On a success the dentry is returned. The name passed in is
1681 * copied and the copy passed in may be reused after this call.
1682 */
1683struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1684{
1685 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1686 if (!dentry)
1687 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001688 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001689 spin_lock(&parent->d_lock);
1690 /*
1691 * don't need child lock because it is not subject
1692 * to concurrency here
1693 */
1694 __dget_dlock(parent);
1695 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001696 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001697 spin_unlock(&parent->d_lock);
1698
1699 return dentry;
1700}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001701EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
Al Viroba65dc52016-06-10 11:32:47 -04001703struct dentry *d_alloc_cursor(struct dentry * parent)
1704{
1705 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1706 if (dentry) {
1707 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1708 dentry->d_parent = dget(parent);
1709 }
1710 return dentry;
1711}
1712
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001713/**
1714 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1715 * @sb: the superblock
1716 * @name: qstr of the name
1717 *
1718 * For a filesystem that just pins its dentries in memory and never
1719 * performs lookups at all, return an unhashed IS_ROOT dentry.
1720 */
Nick Piggin4b936882011-01-07 17:50:07 +11001721struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1722{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001723 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001724}
1725EXPORT_SYMBOL(d_alloc_pseudo);
1726
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1728{
1729 struct qstr q;
1730
1731 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001732 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 return d_alloc(parent, &q);
1734}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001735EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Nick Pigginfb045ad2011-01-07 17:49:55 +11001737void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1738{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001739 WARN_ON_ONCE(dentry->d_op);
1740 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001741 DCACHE_OP_COMPARE |
1742 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001743 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001744 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001745 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001746 dentry->d_op = op;
1747 if (!op)
1748 return;
1749 if (op->d_hash)
1750 dentry->d_flags |= DCACHE_OP_HASH;
1751 if (op->d_compare)
1752 dentry->d_flags |= DCACHE_OP_COMPARE;
1753 if (op->d_revalidate)
1754 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001755 if (op->d_weak_revalidate)
1756 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001757 if (op->d_delete)
1758 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001759 if (op->d_prune)
1760 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001761 if (op->d_real)
1762 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001763
1764}
1765EXPORT_SYMBOL(d_set_d_op);
1766
David Howellsdf1a0852015-01-29 12:02:28 +00001767
1768/*
1769 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1770 * @dentry - The dentry to mark
1771 *
1772 * Mark a dentry as falling through to the lower layer (as set with
1773 * d_pin_lower()). This flag may be recorded on the medium.
1774 */
1775void d_set_fallthru(struct dentry *dentry)
1776{
1777 spin_lock(&dentry->d_lock);
1778 dentry->d_flags |= DCACHE_FALLTHRU;
1779 spin_unlock(&dentry->d_lock);
1780}
1781EXPORT_SYMBOL(d_set_fallthru);
1782
David Howellsb18825a2013-09-12 19:22:53 +01001783static unsigned d_flags_for_inode(struct inode *inode)
1784{
David Howells44bdb5e2015-01-29 12:02:29 +00001785 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001786
1787 if (!inode)
1788 return DCACHE_MISS_TYPE;
1789
1790 if (S_ISDIR(inode->i_mode)) {
1791 add_flags = DCACHE_DIRECTORY_TYPE;
1792 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1793 if (unlikely(!inode->i_op->lookup))
1794 add_flags = DCACHE_AUTODIR_TYPE;
1795 else
1796 inode->i_opflags |= IOP_LOOKUP;
1797 }
David Howells44bdb5e2015-01-29 12:02:29 +00001798 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001799 }
1800
David Howells44bdb5e2015-01-29 12:02:29 +00001801 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001802 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001803 add_flags = DCACHE_SYMLINK_TYPE;
1804 goto type_determined;
1805 }
1806 inode->i_opflags |= IOP_NOFOLLOW;
1807 }
1808
1809 if (unlikely(!S_ISREG(inode->i_mode)))
1810 add_flags = DCACHE_SPECIAL_TYPE;
1811
1812type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001813 if (unlikely(IS_AUTOMOUNT(inode)))
1814 add_flags |= DCACHE_NEED_AUTOMOUNT;
1815 return add_flags;
1816}
1817
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001818static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1819{
David Howellsb18825a2013-09-12 19:22:53 +01001820 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001821 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001822
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001823 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001824 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001825 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001826 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001827 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001828 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001829 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001830}
1831
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832/**
1833 * d_instantiate - fill in inode information for a dentry
1834 * @entry: dentry to complete
1835 * @inode: inode to attach to this dentry
1836 *
1837 * Fill in inode information in the entry.
1838 *
1839 * This turns negative dentries into productive full members
1840 * of society.
1841 *
1842 * NOTE! This assumes that the inode count has been incremented
1843 * (or otherwise set) by the caller to indicate that it is now
1844 * in use by the dcache.
1845 */
1846
1847void d_instantiate(struct dentry *entry, struct inode * inode)
1848{
Al Viro946e51f2014-10-26 19:19:16 -04001849 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001850 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001851 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001852 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001853 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001854 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001855 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001857EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Al Viro2d2d3f12018-05-04 08:23:01 -04001859/*
1860 * This should be equivalent to d_instantiate() + unlock_new_inode(),
1861 * with lockdep-related part of unlock_new_inode() done before
1862 * anything else. Use that instead of open-coding d_instantiate()/
1863 * unlock_new_inode() combinations.
1864 */
1865void d_instantiate_new(struct dentry *entry, struct inode *inode)
1866{
1867 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1868 BUG_ON(!inode);
1869 lockdep_annotate_inode_mutex_key(inode);
1870 security_d_instantiate(entry, inode);
1871 spin_lock(&inode->i_lock);
1872 __d_instantiate(entry, inode);
1873 WARN_ON(!(inode->i_state & I_NEW));
1874 inode->i_state &= ~I_NEW;
1875 smp_mb();
1876 wake_up_bit(&inode->i_state, __I_NEW);
1877 spin_unlock(&inode->i_lock);
1878}
1879EXPORT_SYMBOL(d_instantiate_new);
1880
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001882 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1883 * @entry: dentry to complete
1884 * @inode: inode to attach to this dentry
1885 *
1886 * Fill in inode information in the entry. If a directory alias is found, then
1887 * return an error (and drop inode). Together with d_materialise_unique() this
1888 * guarantees that a directory inode may never have more than one alias.
1889 */
1890int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1891{
Al Viro946e51f2014-10-26 19:19:16 -04001892 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001893
Al Virob9680912016-04-11 00:53:26 -04001894 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001895 spin_lock(&inode->i_lock);
1896 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1897 spin_unlock(&inode->i_lock);
1898 iput(inode);
1899 return -EBUSY;
1900 }
1901 __d_instantiate(entry, inode);
1902 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001903
1904 return 0;
1905}
1906EXPORT_SYMBOL(d_instantiate_no_diralias);
1907
Al Viroadc0e912012-01-08 16:49:21 -05001908struct dentry *d_make_root(struct inode *root_inode)
1909{
1910 struct dentry *res = NULL;
1911
1912 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001913 res = __d_alloc(root_inode->i_sb, NULL);
Al Virocfac7df2018-08-06 09:03:58 -04001914 if (res) {
1915 res->d_flags |= DCACHE_RCUACCESS;
Al Viroadc0e912012-01-08 16:49:21 -05001916 d_instantiate(res, root_inode);
Al Virocfac7df2018-08-06 09:03:58 -04001917 } else {
Al Viroadc0e912012-01-08 16:49:21 -05001918 iput(root_inode);
Al Virocfac7df2018-08-06 09:03:58 -04001919 }
Al Viroadc0e912012-01-08 16:49:21 -05001920 }
1921 return res;
1922}
1923EXPORT_SYMBOL(d_make_root);
1924
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001925static struct dentry * __d_find_any_alias(struct inode *inode)
1926{
1927 struct dentry *alias;
1928
Al Virob3d9b7a2012-06-09 13:51:19 -04001929 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001930 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001931 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001932 __dget(alias);
1933 return alias;
1934}
1935
Sage Weil46f72b32012-01-10 09:04:37 -08001936/**
1937 * d_find_any_alias - find any alias for a given inode
1938 * @inode: inode to find an alias for
1939 *
1940 * If any aliases exist for the given inode, take and return a
1941 * reference for one of them. If no aliases exist, return %NULL.
1942 */
1943struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001944{
1945 struct dentry *de;
1946
1947 spin_lock(&inode->i_lock);
1948 de = __d_find_any_alias(inode);
1949 spin_unlock(&inode->i_lock);
1950 return de;
1951}
Sage Weil46f72b32012-01-10 09:04:37 -08001952EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001953
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001954static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001955{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001956 struct dentry *tmp;
1957 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001958 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001959
1960 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001961 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001962 if (IS_ERR(inode))
1963 return ERR_CAST(inode);
1964
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001965 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001966 if (res)
1967 goto out_iput;
1968
Al Viro798434b2016-03-24 20:38:43 -04001969 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001970 if (!tmp) {
1971 res = ERR_PTR(-ENOMEM);
1972 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001973 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001974
Al Virob9680912016-04-11 00:53:26 -04001975 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001976 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001977 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001978 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001979 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001980 dput(tmp);
1981 goto out_iput;
1982 }
1983
1984 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001985 add_flags = d_flags_for_inode(inode);
1986
1987 if (disconnected)
1988 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001989
Christoph Hellwig9308a612008-08-11 15:49:12 +02001990 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001991 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001992 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001993 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001994 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001995 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001996 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001997 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001998
Christoph Hellwig9308a612008-08-11 15:49:12 +02001999 return tmp;
2000
2001 out_iput:
2002 iput(inode);
2003 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02002004}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002005
2006/**
2007 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
2008 * @inode: inode to allocate the dentry for
2009 *
2010 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
2011 * similar open by handle operations. The returned dentry may be anonymous,
2012 * or may have a full name (if the inode was already in the cache).
2013 *
2014 * When called on a directory inode, we must ensure that the inode only ever
2015 * has one dentry. If a dentry is found, that is returned instead of
2016 * allocating a new one.
2017 *
2018 * On successful return, the reference to the inode has been transferred
2019 * to the dentry. In case of an error the reference on the inode is released.
2020 * To make it easier to use in export operations a %NULL or IS_ERR inode may
2021 * be passed in and the error will be propagated to the return value,
2022 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
2023 */
2024struct dentry *d_obtain_alias(struct inode *inode)
2025{
2026 return __d_obtain_alias(inode, 1);
2027}
Benny Halevyadc48722009-02-27 14:02:59 -08002028EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
2030/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002031 * d_obtain_root - find or allocate a dentry for a given inode
2032 * @inode: inode to allocate the dentry for
2033 *
2034 * Obtain an IS_ROOT dentry for the root of a filesystem.
2035 *
2036 * We must ensure that directory inodes only ever have one dentry. If a
2037 * dentry is found, that is returned instead of allocating a new one.
2038 *
2039 * On successful return, the reference to the inode has been transferred
2040 * to the dentry. In case of an error the reference on the inode is
2041 * released. A %NULL or IS_ERR inode may be passed in and will be the
2042 * error will be propagate to the return value, with a %NULL @inode
2043 * replaced by ERR_PTR(-ESTALE).
2044 */
2045struct dentry *d_obtain_root(struct inode *inode)
2046{
2047 return __d_obtain_alias(inode, 0);
2048}
2049EXPORT_SYMBOL(d_obtain_root);
2050
2051/**
Barry Naujok94035402008-05-21 16:50:46 +10002052 * d_add_ci - lookup or allocate new dentry with case-exact name
2053 * @inode: the inode case-insensitive lookup has found
2054 * @dentry: the negative dentry that was passed to the parent's lookup func
2055 * @name: the case-exact name to be associated with the returned dentry
2056 *
2057 * This is to avoid filling the dcache with case-insensitive names to the
2058 * same inode, only the actual correct case is stored in the dcache for
2059 * case-insensitive filesystems.
2060 *
2061 * For a case-insensitive lookup match and if the the case-exact dentry
2062 * already exists in in the dcache, use it and return it.
2063 *
2064 * If no entry exists with the exact case name, allocate new dentry with
2065 * the exact case, and return the spliced entry.
2066 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002067struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002068 struct qstr *name)
2069{
Al Virod9171b92016-04-15 03:33:13 -04002070 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002071
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002072 /*
2073 * First check if a dentry matching the name already exists,
2074 * if not go ahead and create it now.
2075 */
Barry Naujok94035402008-05-21 16:50:46 +10002076 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002077 if (found) {
2078 iput(inode);
2079 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002080 }
Al Virod9171b92016-04-15 03:33:13 -04002081 if (d_in_lookup(dentry)) {
2082 found = d_alloc_parallel(dentry->d_parent, name,
2083 dentry->d_wait);
2084 if (IS_ERR(found) || !d_in_lookup(found)) {
2085 iput(inode);
2086 return found;
2087 }
2088 } else {
2089 found = d_alloc(dentry->d_parent, name);
2090 if (!found) {
2091 iput(inode);
2092 return ERR_PTR(-ENOMEM);
2093 }
2094 }
2095 res = d_splice_alias(inode, found);
2096 if (res) {
2097 dput(found);
2098 return res;
2099 }
Al Viro4f522a22013-02-11 23:20:37 -05002100 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002101}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002102EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002104
Al Virod4c91a82016-06-25 23:33:49 -04002105static inline bool d_same_name(const struct dentry *dentry,
2106 const struct dentry *parent,
2107 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002108{
Al Virod4c91a82016-06-25 23:33:49 -04002109 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2110 if (dentry->d_name.len != name->len)
2111 return false;
2112 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002113 }
Al Viro6fa67e72016-07-31 16:37:25 -04002114 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002115 dentry->d_name.len, dentry->d_name.name,
2116 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002117}
2118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002120 * __d_lookup_rcu - search for a dentry (racy, store-free)
2121 * @parent: parent dentry
2122 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002123 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002124 * Returns: dentry, or NULL
2125 *
2126 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2127 * resolution (store-free path walking) design described in
2128 * Documentation/filesystems/path-lookup.txt.
2129 *
2130 * This is not to be used outside core vfs.
2131 *
2132 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2133 * held, and rcu_read_lock held. The returned dentry must not be stored into
2134 * without taking d_lock and checking d_seq sequence count against @seq
2135 * returned here.
2136 *
Linus Torvalds15570082013-09-02 11:38:06 -07002137 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002138 * function.
2139 *
2140 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2141 * the returned dentry, so long as its parent's seqlock is checked after the
2142 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2143 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002144 *
2145 * NOTE! The caller *has* to check the resulting dentry against the sequence
2146 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002147 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002148struct dentry *__d_lookup_rcu(const struct dentry *parent,
2149 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002150 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002151{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002152 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002153 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002154 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002155 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002156 struct dentry *dentry;
2157
2158 /*
2159 * Note: There is significant duplication with __d_lookup_rcu which is
2160 * required to prevent single threaded performance regressions
2161 * especially on architectures where smp_rmb (in seqcounts) are costly.
2162 * Keep the two functions in sync.
2163 */
2164
2165 /*
2166 * The hash list is protected using RCU.
2167 *
2168 * Carefully use d_seq when comparing a candidate dentry, to avoid
2169 * races with d_move().
2170 *
2171 * It is possible that concurrent renames can mess up our list
2172 * walk here and result in missing our dentry, resulting in the
2173 * false-negative result. d_lookup() protects against concurrent
2174 * renames using rename_lock seqlock.
2175 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002176 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002177 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002178 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002179 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002180
Nick Piggin31e6b012011-01-07 17:49:52 +11002181seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002182 /*
2183 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002184 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002185 *
2186 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002187 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002188 *
2189 * NOTE! We do a "raw" seqcount_begin here. That means that
2190 * we don't wait for the sequence count to stabilize if it
2191 * is in the middle of a sequence change. If we do the slow
2192 * dentry compare, we will do seqretries until it is stable,
2193 * and if we end up with a successful lookup, we actually
2194 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002195 *
2196 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2197 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002198 */
2199 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002200 if (dentry->d_parent != parent)
2201 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002202 if (d_unhashed(dentry))
2203 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002204
2205 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002206 int tlen;
2207 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002208 if (dentry->d_name.hash != hashlen_hash(hashlen))
2209 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002210 tlen = dentry->d_name.len;
2211 tname = dentry->d_name.name;
2212 /* we want a consistent (name,len) pair */
2213 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2214 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002215 goto seqretry;
2216 }
Al Viro6fa67e72016-07-31 16:37:25 -04002217 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002218 tlen, tname, name) != 0)
2219 continue;
2220 } else {
2221 if (dentry->d_name.hash_len != hashlen)
2222 continue;
2223 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2224 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002225 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002226 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002227 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002228 }
2229 return NULL;
2230}
2231
2232/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 * d_lookup - search for a dentry
2234 * @parent: parent dentry
2235 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002236 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002238 * d_lookup searches the children of the parent dentry for the name in
2239 * question. If the dentry is found its reference count is incremented and the
2240 * dentry is returned. The caller must use dput to free the entry when it has
2241 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 */
Al Viroda2d8452013-01-24 18:29:34 -05002243struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244{
Nick Piggin31e6b012011-01-07 17:49:52 +11002245 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002246 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Daeseok Younb8314f92014-08-11 11:46:53 +09002248 do {
2249 seq = read_seqbegin(&rename_lock);
2250 dentry = __d_lookup(parent, name);
2251 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 break;
2253 } while (read_seqretry(&rename_lock, seq));
2254 return dentry;
2255}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002256EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257
Nick Piggin31e6b012011-01-07 17:49:52 +11002258/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002259 * __d_lookup - search for a dentry (racy)
2260 * @parent: parent dentry
2261 * @name: qstr of name we wish to find
2262 * Returns: dentry, or NULL
2263 *
2264 * __d_lookup is like d_lookup, however it may (rarely) return a
2265 * false-negative result due to unrelated rename activity.
2266 *
2267 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2268 * however it must be used carefully, eg. with a following d_lookup in
2269 * the case of failure.
2270 *
2271 * __d_lookup callers must be commented.
2272 */
Al Viroa713ca22013-01-24 18:27:00 -05002273struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002276 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002277 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002278 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002279 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
Nick Pigginb04f7842010-08-18 04:37:34 +10002281 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002282 * Note: There is significant duplication with __d_lookup_rcu which is
2283 * required to prevent single threaded performance regressions
2284 * especially on architectures where smp_rmb (in seqcounts) are costly.
2285 * Keep the two functions in sync.
2286 */
2287
2288 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002289 * The hash list is protected using RCU.
2290 *
2291 * Take d_lock when comparing a candidate dentry, to avoid races
2292 * with d_move().
2293 *
2294 * It is possible that concurrent renames can mess up our list
2295 * walk here and result in missing our dentry, resulting in the
2296 * false-negative result. d_lookup() protects against concurrent
2297 * renames using rename_lock seqlock.
2298 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002299 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002300 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 rcu_read_lock();
2302
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002303 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 if (dentry->d_name.hash != hash)
2306 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307
2308 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 if (dentry->d_parent != parent)
2310 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002311 if (d_unhashed(dentry))
2312 goto next;
2313
Al Virod4c91a82016-06-25 23:33:49 -04002314 if (!d_same_name(dentry, parent, name))
2315 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316
Waiman Long98474232013-08-28 18:24:59 -07002317 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002318 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 spin_unlock(&dentry->d_lock);
2320 break;
2321next:
2322 spin_unlock(&dentry->d_lock);
2323 }
2324 rcu_read_unlock();
2325
2326 return found;
2327}
2328
2329/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002330 * d_hash_and_lookup - hash the qstr then search for a dentry
2331 * @dir: Directory to search in
2332 * @name: qstr of name we wish to find
2333 *
Al Viro4f522a22013-02-11 23:20:37 -05002334 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002335 */
2336struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2337{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002338 /*
2339 * Check for a fs-specific hash function. Note that we must
2340 * calculate the standard hash first, as the d_op->d_hash()
2341 * routine may choose to leave the hash value unchanged.
2342 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002343 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002344 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002345 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002346 if (unlikely(err < 0))
2347 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002348 }
Al Viro4f522a22013-02-11 23:20:37 -05002349 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002350}
Al Viro4f522a22013-02-11 23:20:37 -05002351EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002352
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353/*
2354 * When a file is deleted, we have two options:
2355 * - turn this dentry into a negative dentry
2356 * - unhash this dentry and free it.
2357 *
2358 * Usually, we want to just turn this into
2359 * a negative dentry, but if anybody else is
2360 * currently using the dentry or the inode
2361 * we can't do that and we fall back on removing
2362 * it from the hash queues and waiting for
2363 * it to be deleted later when it has no users
2364 */
2365
2366/**
2367 * d_delete - delete a dentry
2368 * @dentry: The dentry to delete
2369 *
2370 * Turn the dentry into a negative dentry if possible, otherwise
2371 * remove it from the hash queues so it can be deleted later
2372 */
2373
2374void d_delete(struct dentry * dentry)
2375{
Nick Piggin873feea2011-01-07 17:50:06 +11002376 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002377 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 /*
2379 * Are we the only user?
2380 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002381again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002383 inode = dentry->d_inode;
2384 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002385 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002386 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002387 spin_unlock(&dentry->d_lock);
2388 cpu_relax();
2389 goto again;
2390 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002391 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002392 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002393 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 return;
2395 }
2396
2397 if (!d_unhashed(dentry))
2398 __d_drop(dentry);
2399
2400 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002401
2402 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002404EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
Al Viro15d3c582016-07-29 17:45:21 -04002406static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407{
Al Viro15d3c582016-07-29 17:45:21 -04002408 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
NeilBrown3aa66ba2017-11-10 15:45:41 +11002409
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002410 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002411 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002412 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413}
2414
2415/**
2416 * d_rehash - add an entry back to the hash
2417 * @entry: dentry to add to the hash
2418 *
2419 * Adds a dentry to the hash according to its name.
2420 */
2421
2422void d_rehash(struct dentry * entry)
2423{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002425 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002428EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429
Al Viro84e710d2016-04-15 00:58:55 -04002430static inline unsigned start_dir_add(struct inode *dir)
2431{
2432
2433 for (;;) {
2434 unsigned n = dir->i_dir_seq;
2435 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2436 return n;
2437 cpu_relax();
2438 }
2439}
2440
2441static inline void end_dir_add(struct inode *dir, unsigned n)
2442{
2443 smp_store_release(&dir->i_dir_seq, n + 2);
2444}
2445
Al Virod9171b92016-04-15 03:33:13 -04002446static void d_wait_lookup(struct dentry *dentry)
2447{
2448 if (d_in_lookup(dentry)) {
2449 DECLARE_WAITQUEUE(wait, current);
2450 add_wait_queue(dentry->d_wait, &wait);
2451 do {
2452 set_current_state(TASK_UNINTERRUPTIBLE);
2453 spin_unlock(&dentry->d_lock);
2454 schedule();
2455 spin_lock(&dentry->d_lock);
2456 } while (d_in_lookup(dentry));
2457 }
2458}
2459
Al Viro94bdd652016-04-15 02:42:04 -04002460struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002461 const struct qstr *name,
2462 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002463{
Al Viro94bdd652016-04-15 02:42:04 -04002464 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002465 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2466 struct hlist_bl_node *node;
2467 struct dentry *new = d_alloc(parent, name);
2468 struct dentry *dentry;
2469 unsigned seq, r_seq, d_seq;
2470
2471 if (unlikely(!new))
2472 return ERR_PTR(-ENOMEM);
2473
2474retry:
2475 rcu_read_lock();
Will Deaconbcefedb2018-02-19 14:55:54 +00002476 seq = smp_load_acquire(&parent->d_inode->i_dir_seq);
Al Viro94bdd652016-04-15 02:42:04 -04002477 r_seq = read_seqbegin(&rename_lock);
2478 dentry = __d_lookup_rcu(parent, name, &d_seq);
2479 if (unlikely(dentry)) {
2480 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2481 rcu_read_unlock();
2482 goto retry;
2483 }
2484 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2485 rcu_read_unlock();
2486 dput(dentry);
2487 goto retry;
2488 }
2489 rcu_read_unlock();
2490 dput(new);
2491 return dentry;
2492 }
2493 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2494 rcu_read_unlock();
2495 goto retry;
2496 }
Will Deaconbcefedb2018-02-19 14:55:54 +00002497
2498 if (unlikely(seq & 1)) {
2499 rcu_read_unlock();
2500 goto retry;
2501 }
2502
Al Viro94bdd652016-04-15 02:42:04 -04002503 hlist_bl_lock(b);
Will Deacon527ed412018-02-19 14:55:55 +00002504 if (unlikely(READ_ONCE(parent->d_inode->i_dir_seq) != seq)) {
Al Viro94bdd652016-04-15 02:42:04 -04002505 hlist_bl_unlock(b);
2506 rcu_read_unlock();
2507 goto retry;
2508 }
Al Viro94bdd652016-04-15 02:42:04 -04002509 /*
2510 * No changes for the parent since the beginning of d_lookup().
2511 * Since all removals from the chain happen with hlist_bl_lock(),
2512 * any potential in-lookup matches are going to stay here until
2513 * we unlock the chain. All fields are stable in everything
2514 * we encounter.
2515 */
2516 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2517 if (dentry->d_name.hash != hash)
2518 continue;
2519 if (dentry->d_parent != parent)
2520 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002521 if (!d_same_name(dentry, parent, name))
2522 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002523 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002524 /* now we can try to grab a reference */
2525 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2526 rcu_read_unlock();
2527 goto retry;
2528 }
2529
2530 rcu_read_unlock();
2531 /*
2532 * somebody is likely to be still doing lookup for it;
2533 * wait for them to finish
2534 */
Al Virod9171b92016-04-15 03:33:13 -04002535 spin_lock(&dentry->d_lock);
2536 d_wait_lookup(dentry);
2537 /*
2538 * it's not in-lookup anymore; in principle we should repeat
2539 * everything from dcache lookup, but it's likely to be what
2540 * d_lookup() would've found anyway. If it is, just return it;
2541 * otherwise we really have to repeat the whole thing.
2542 */
2543 if (unlikely(dentry->d_name.hash != hash))
2544 goto mismatch;
2545 if (unlikely(dentry->d_parent != parent))
2546 goto mismatch;
2547 if (unlikely(d_unhashed(dentry)))
2548 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002549 if (unlikely(!d_same_name(dentry, parent, name)))
2550 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002551 /* OK, it *is* a hashed match; return it */
2552 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002553 dput(new);
2554 return dentry;
2555 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002556 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002557 /* we can't take ->d_lock here; it's OK, though. */
2558 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002559 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002560 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2561 hlist_bl_unlock(b);
2562 return new;
Al Virod9171b92016-04-15 03:33:13 -04002563mismatch:
2564 spin_unlock(&dentry->d_lock);
2565 dput(dentry);
2566 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002567}
2568EXPORT_SYMBOL(d_alloc_parallel);
2569
Al Viro85c7f812016-04-14 19:52:13 -04002570void __d_lookup_done(struct dentry *dentry)
2571{
Al Viro94bdd652016-04-15 02:42:04 -04002572 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2573 dentry->d_name.hash);
2574 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002575 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002576 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002577 wake_up_all(dentry->d_wait);
2578 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002579 hlist_bl_unlock(b);
2580 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002581 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002582}
2583EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002584
2585/* inode->i_lock held if inode is non-NULL */
2586
2587static inline void __d_add(struct dentry *dentry, struct inode *inode)
2588{
Al Viro84e710d2016-04-15 00:58:55 -04002589 struct inode *dir = NULL;
2590 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002591 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002592 if (unlikely(d_in_lookup(dentry))) {
2593 dir = dentry->d_parent->d_inode;
2594 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002595 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002596 }
Al Viroed782b52016-03-09 19:52:39 -05002597 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002598 unsigned add_flags = d_flags_for_inode(inode);
2599 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2600 raw_write_seqcount_begin(&dentry->d_seq);
2601 __d_set_inode_and_type(dentry, inode, add_flags);
2602 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002603 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002604 }
Al Viro15d3c582016-07-29 17:45:21 -04002605 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002606 if (dir)
2607 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002608 spin_unlock(&dentry->d_lock);
2609 if (inode)
2610 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002611}
2612
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002613/**
Al Viro34d0d192016-03-08 21:01:03 -05002614 * d_add - add dentry to hash queues
2615 * @entry: dentry to add
2616 * @inode: The inode to attach to this dentry
2617 *
2618 * This adds the entry to the hash queues and initializes @inode.
2619 * The entry was actually filled in earlier during d_alloc().
2620 */
2621
2622void d_add(struct dentry *entry, struct inode *inode)
2623{
Al Virob9680912016-04-11 00:53:26 -04002624 if (inode) {
2625 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002626 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002627 }
Al Viroed782b52016-03-09 19:52:39 -05002628 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002629}
2630EXPORT_SYMBOL(d_add);
2631
2632/**
Al Viro668d0cd2016-03-08 12:44:17 -05002633 * d_exact_alias - find and hash an exact unhashed alias
2634 * @entry: dentry to add
2635 * @inode: The inode to go with this dentry
2636 *
2637 * If an unhashed dentry with the same name/parent and desired
2638 * inode already exists, hash and return it. Otherwise, return
2639 * NULL.
2640 *
2641 * Parent directory should be locked.
2642 */
2643struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2644{
2645 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002646 unsigned int hash = entry->d_name.hash;
2647
2648 spin_lock(&inode->i_lock);
2649 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2650 /*
2651 * Don't need alias->d_lock here, because aliases with
2652 * d_parent == entry->d_parent are not subject to name or
2653 * parent changes, because the parent inode i_mutex is held.
2654 */
2655 if (alias->d_name.hash != hash)
2656 continue;
2657 if (alias->d_parent != entry->d_parent)
2658 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002659 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002660 continue;
2661 spin_lock(&alias->d_lock);
2662 if (!d_unhashed(alias)) {
2663 spin_unlock(&alias->d_lock);
2664 alias = NULL;
2665 } else {
2666 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002667 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002668 spin_unlock(&alias->d_lock);
2669 }
2670 spin_unlock(&inode->i_lock);
2671 return alias;
2672 }
2673 spin_unlock(&inode->i_lock);
2674 return NULL;
2675}
2676EXPORT_SYMBOL(d_exact_alias);
2677
2678/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002679 * dentry_update_name_case - update case insensitive dentry with a new name
2680 * @dentry: dentry to be updated
2681 * @name: new name
2682 *
2683 * Update a case insensitive dentry with new case of name.
2684 *
2685 * dentry must have been returned by d_lookup with name @name. Old and new
2686 * name lengths must match (ie. no d_compare which allows mismatched name
2687 * lengths).
2688 *
2689 * Parent inode i_mutex must be held over d_lookup and into this call (to
2690 * keep renames and concurrent inserts, and readdir(2) away).
2691 */
Al Viro9aba36d2016-07-20 22:28:45 -04002692void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002693{
Al Viro59551022016-01-22 15:40:57 -05002694 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002695 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2696
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002697 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002698 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002699 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002700 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002701 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002702}
2703EXPORT_SYMBOL(dentry_update_name_case);
2704
Al Viro8d85b482014-09-29 14:54:27 -04002705static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706{
Al Viro8d85b482014-09-29 14:54:27 -04002707 if (unlikely(dname_external(target))) {
2708 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 /*
2710 * Both external: swap the pointers
2711 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002712 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 } else {
2714 /*
2715 * dentry:internal, target:external. Steal target's
2716 * storage and make target internal.
2717 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002718 memcpy(target->d_iname, dentry->d_name.name,
2719 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 dentry->d_name.name = target->d_name.name;
2721 target->d_name.name = target->d_iname;
2722 }
2723 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002724 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 /*
2726 * dentry:external, target:internal. Give dentry's
2727 * storage to target and make dentry internal
2728 */
2729 memcpy(dentry->d_iname, target->d_name.name,
2730 target->d_name.len + 1);
2731 target->d_name.name = dentry->d_name.name;
2732 dentry->d_name.name = dentry->d_iname;
2733 } else {
2734 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002735 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002737 unsigned int i;
2738 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002739 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2740 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002741 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2742 swap(((long *) &dentry->d_iname)[i],
2743 ((long *) &target->d_iname)[i]);
2744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 }
2746 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002747 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748}
2749
Al Viro8d85b482014-09-29 14:54:27 -04002750static void copy_name(struct dentry *dentry, struct dentry *target)
2751{
2752 struct external_name *old_name = NULL;
2753 if (unlikely(dname_external(dentry)))
2754 old_name = external_name(dentry);
2755 if (unlikely(dname_external(target))) {
2756 atomic_inc(&external_name(target)->u.count);
2757 dentry->d_name = target->d_name;
2758 } else {
2759 memcpy(dentry->d_iname, target->d_name.name,
2760 target->d_name.len + 1);
2761 dentry->d_name.name = dentry->d_iname;
2762 dentry->d_name.hash_len = target->d_name.hash_len;
2763 }
2764 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2765 kfree_rcu(old_name, u.head);
2766}
2767
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002768static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2769{
2770 /*
2771 * XXXX: do we really need to take target->d_lock?
2772 */
2773 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2774 spin_lock(&target->d_parent->d_lock);
2775 else {
2776 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2777 spin_lock(&dentry->d_parent->d_lock);
2778 spin_lock_nested(&target->d_parent->d_lock,
2779 DENTRY_D_LOCK_NESTED);
2780 } else {
2781 spin_lock(&target->d_parent->d_lock);
2782 spin_lock_nested(&dentry->d_parent->d_lock,
2783 DENTRY_D_LOCK_NESTED);
2784 }
2785 }
2786 if (target < dentry) {
2787 spin_lock_nested(&target->d_lock, 2);
2788 spin_lock_nested(&dentry->d_lock, 3);
2789 } else {
2790 spin_lock_nested(&dentry->d_lock, 2);
2791 spin_lock_nested(&target->d_lock, 3);
2792 }
2793}
2794
Al Viro986c0192014-09-26 23:11:15 -04002795static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002796{
2797 if (target->d_parent != dentry->d_parent)
2798 spin_unlock(&dentry->d_parent->d_lock);
2799 if (target->d_parent != target)
2800 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002801 spin_unlock(&target->d_lock);
2802 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002803}
2804
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002806 * When switching names, the actual string doesn't strictly have to
2807 * be preserved in the target - because we're dropping the target
2808 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002809 * the new name before we switch, unless we are going to rehash
2810 * it. Note that if we *do* unhash the target, we are not allowed
2811 * to rehash it without giving it a new name/hash key - whether
2812 * we swap or overwrite the names here, resulting name won't match
2813 * the reality in filesystem; it's only there for d_path() purposes.
2814 * Note that all of this is happening under rename_lock, so the
2815 * any hash lookup seeing it in the middle of manipulations will
2816 * be discarded anyway. So we do not care what happens to the hash
2817 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002819/*
Al Viro18367502011-07-12 21:42:24 -04002820 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 * @dentry: entry to move
2822 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002823 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 *
2825 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002826 * dcache entries should not be moved in this way. Caller must hold
2827 * rename_lock, the i_mutex of the source and target directories,
2828 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002830static void __d_move(struct dentry *dentry, struct dentry *target,
2831 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832{
Al Viro84e710d2016-04-15 00:58:55 -04002833 struct inode *dir = NULL;
2834 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835 if (!dentry->d_inode)
2836 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2837
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002838 BUG_ON(d_ancestor(dentry, target));
2839 BUG_ON(d_ancestor(target, dentry));
2840
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002841 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002842 if (unlikely(d_in_lookup(target))) {
2843 dir = target->d_parent->d_inode;
2844 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002845 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847
Nick Piggin31e6b012011-01-07 17:49:52 +11002848 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002849 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002850
Al Viro15d3c582016-07-29 17:45:21 -04002851 /* unhash both */
NeilBrown3aa66ba2017-11-10 15:45:41 +11002852 /* ___d_drop does write_seqcount_barrier, but they're OK to nest. */
2853 ___d_drop(dentry);
2854 ___d_drop(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002857 if (exchange)
2858 swap_names(dentry, target);
2859 else
2860 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861
Al Viro15d3c582016-07-29 17:45:21 -04002862 /* rehash in new place(s) */
2863 __d_rehash(dentry);
2864 if (exchange)
2865 __d_rehash(target);
NeilBrown3aa66ba2017-11-10 15:45:41 +11002866 else
2867 target->d_hash.pprev = NULL;
Al Viro15d3c582016-07-29 17:45:21 -04002868
Al Viro63cf4272014-09-26 23:06:14 -04002869 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002871 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002872 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 dentry->d_parent = target->d_parent;
2874 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002875 list_del_init(&target->d_child);
2876 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002878 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002879 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002880 list_move(&target->d_child, &target->d_parent->d_subdirs);
2881 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002882 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002883 fsnotify_update_flags(target);
2884 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885 }
2886
Nick Piggin31e6b012011-01-07 17:49:52 +11002887 write_seqcount_end(&target->d_seq);
2888 write_seqcount_end(&dentry->d_seq);
2889
Al Viro84e710d2016-04-15 00:58:55 -04002890 if (dir)
2891 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002892 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002893}
2894
2895/*
2896 * d_move - move a dentry
2897 * @dentry: entry to move
2898 * @target: new dentry
2899 *
2900 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002901 * dcache entries should not be moved in this way. See the locking
2902 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002903 */
2904void d_move(struct dentry *dentry, struct dentry *target)
2905{
2906 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002907 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002909}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002910EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911
Miklos Szeredida1ce062014-04-01 17:08:43 +02002912/*
2913 * d_exchange - exchange two dentries
2914 * @dentry1: first dentry
2915 * @dentry2: second dentry
2916 */
2917void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2918{
2919 write_seqlock(&rename_lock);
2920
2921 WARN_ON(!dentry1->d_inode);
2922 WARN_ON(!dentry2->d_inode);
2923 WARN_ON(IS_ROOT(dentry1));
2924 WARN_ON(IS_ROOT(dentry2));
2925
2926 __d_move(dentry1, dentry2, true);
2927
2928 write_sequnlock(&rename_lock);
2929}
2930
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002931/**
2932 * d_ancestor - search for an ancestor
2933 * @p1: ancestor dentry
2934 * @p2: child dentry
2935 *
2936 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2937 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002938 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002939struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002940{
2941 struct dentry *p;
2942
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002943 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002944 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002945 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002946 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002947 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002948}
2949
2950/*
2951 * This helper attempts to cope with remotely renamed directories
2952 *
2953 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002954 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002955 *
2956 * Note: If ever the locking in lock_rename() changes, then please
2957 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958 */
Al Virob5ae6b12014-10-12 22:16:02 -04002959static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002960 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002961{
Al Viro9902af72016-04-15 15:08:36 -04002962 struct mutex *m1 = NULL;
2963 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002964 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002965
2966 /* If alias and dentry share a parent, then no extra locks required */
2967 if (alias->d_parent == dentry->d_parent)
2968 goto out_unalias;
2969
Trond Myklebust9eaef272006-10-21 10:24:20 -07002970 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002971 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2972 goto out_err;
2973 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002974 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002975 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002976 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002977out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002978 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002979 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002981 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002982 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002983 if (m1)
2984 mutex_unlock(m1);
2985 return ret;
2986}
2987
David Howells770bfad2006-08-22 20:06:07 -04002988/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002989 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2990 * @inode: the inode which may have a disconnected dentry
2991 * @dentry: a negative dentry which we want to point to the inode.
2992 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002993 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2994 * place of the given dentry and return it, else simply d_add the inode
2995 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002996 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002997 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2998 * we should error out: directories can't have multiple aliases.
2999 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003000 * This is needed in the lookup routine of any filesystem that is exportable
3001 * (via knfsd) so that we can build dcache paths to directories effectively.
3002 *
3003 * If a dentry was found and moved, then it is returned. Otherwise NULL
3004 * is returned. This matches the expected return value of ->lookup.
3005 *
3006 * Cluster filesystems may call this function with a negative, hashed dentry.
3007 * In that case, we know that the inode will be a regular file, and also this
3008 * will only occur during atomic_open. So we need to check for the dentry
3009 * being already hashed only in the final case.
3010 */
3011struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3012{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003013 if (IS_ERR(inode))
3014 return ERR_CAST(inode);
3015
David Howells770bfad2006-08-22 20:06:07 -04003016 BUG_ON(!d_unhashed(dentry));
3017
Al Virode689f52016-03-09 18:05:42 -05003018 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003019 goto out;
Al Virode689f52016-03-09 18:05:42 -05003020
Al Virob9680912016-04-11 00:53:26 -04003021 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003022 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003023 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003024 struct dentry *new = __d_find_any_alias(inode);
3025 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003026 /* The reference to new ensures it remains an alias */
3027 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003028 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003029 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003030 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003031 dput(new);
3032 new = ERR_PTR(-ELOOP);
3033 pr_warn_ratelimited(
3034 "VFS: Lookup of '%s' in %s %s"
3035 " would have caused loop\n",
3036 dentry->d_name.name,
3037 inode->i_sb->s_type->name,
3038 inode->i_sb->s_id);
3039 } else if (!IS_ROOT(new)) {
3040 int err = __d_unalias(inode, dentry, new);
3041 write_sequnlock(&rename_lock);
3042 if (err) {
3043 dput(new);
3044 new = ERR_PTR(err);
3045 }
Al Viro18367502011-07-12 21:42:24 -04003046 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003047 __d_move(new, dentry, false);
3048 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003049 }
Al Virob5ae6b12014-10-12 22:16:02 -04003050 iput(inode);
3051 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003052 }
David Howells770bfad2006-08-22 20:06:07 -04003053 }
Al Virob5ae6b12014-10-12 22:16:02 -04003054out:
Al Viroed782b52016-03-09 19:52:39 -05003055 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003056 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003057}
Al Virob5ae6b12014-10-12 22:16:02 -04003058EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003059
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003060static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003061{
3062 *buflen -= namelen;
3063 if (*buflen < 0)
3064 return -ENAMETOOLONG;
3065 *buffer -= namelen;
3066 memcpy(*buffer, str, namelen);
3067 return 0;
3068}
3069
Waiman Long232d2d62013-09-09 12:18:13 -04003070/**
3071 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003072 * @buffer: buffer pointer
3073 * @buflen: allocated length of the buffer
3074 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003075 *
3076 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3077 * make sure that either the old or the new name pointer and length are
3078 * fetched. However, there may be mismatch between length and pointer.
3079 * The length cannot be trusted, we need to copy it byte-by-byte until
3080 * the length is reached or a null byte is found. It also prepends "/" at
3081 * the beginning of the name. The sequence number check at the caller will
3082 * retry it again when a d_move() does happen. So any garbage in the buffer
3083 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003084 *
3085 * Data dependency barrier is needed to make sure that we see that terminating
3086 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003087 */
Al Viro9aba36d2016-07-20 22:28:45 -04003088static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003089{
Waiman Long232d2d62013-09-09 12:18:13 -04003090 const char *dname = ACCESS_ONCE(name->name);
3091 u32 dlen = ACCESS_ONCE(name->len);
3092 char *p;
3093
Al Viro6d13f692014-09-29 14:46:30 -04003094 smp_read_barrier_depends();
3095
Waiman Long232d2d62013-09-09 12:18:13 -04003096 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003097 if (*buflen < 0)
3098 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003099 p = *buffer -= dlen + 1;
3100 *p++ = '/';
3101 while (dlen--) {
3102 char c = *dname++;
3103 if (!c)
3104 break;
3105 *p++ = c;
3106 }
3107 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003108}
3109
Linus Torvalds1da177e2005-04-16 15:20:36 -07003110/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003111 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003112 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003113 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003114 * @buffer: pointer to the end of the buffer
3115 * @buflen: pointer to buffer length
3116 *
Waiman Long18129972013-09-12 10:55:35 -04003117 * The function will first try to write out the pathname without taking any
3118 * lock other than the RCU read lock to make sure that dentries won't go away.
3119 * It only checks the sequence number of the global rename_lock as any change
3120 * in the dentry's d_seq will be preceded by changes in the rename_lock
3121 * sequence number. If the sequence number had been changed, it will restart
3122 * the whole pathname back-tracing sequence again by taking the rename_lock.
3123 * In this case, there is no need to take the RCU read lock as the recursive
3124 * parent pointer references will keep the dentry chain alive as long as no
3125 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003126 */
Al Viro02125a82011-12-05 08:43:34 -05003127static int prepend_path(const struct path *path,
3128 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003129 char **buffer, int *buflen)
3130{
Al Viroede4ceb2013-11-13 07:45:40 -05003131 struct dentry *dentry;
3132 struct vfsmount *vfsmnt;
3133 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003134 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003135 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003136 char *bptr;
3137 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003138
Al Viro48f5ec22013-09-09 15:22:25 -04003139 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003140restart_mnt:
3141 read_seqbegin_or_lock(&mount_lock, &m_seq);
3142 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003143 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003144restart:
3145 bptr = *buffer;
3146 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003147 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003148 dentry = path->dentry;
3149 vfsmnt = path->mnt;
3150 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003151 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003152 while (dentry != root->dentry || vfsmnt != root->mnt) {
3153 struct dentry * parent;
3154
3155 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003156 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003157 /* Escaped? */
3158 if (dentry != vfsmnt->mnt_root) {
3159 bptr = *buffer;
3160 blen = *buflen;
3161 error = 3;
3162 break;
3163 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003164 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003165 if (mnt != parent) {
3166 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3167 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003168 vfsmnt = &mnt->mnt;
3169 continue;
3170 }
Waiman Long232d2d62013-09-09 12:18:13 -04003171 if (!error)
3172 error = is_mounted(vfsmnt) ? 1 : 2;
3173 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003174 }
3175 parent = dentry->d_parent;
3176 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003177 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003178 if (error)
3179 break;
3180
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003181 dentry = parent;
3182 }
Al Viro48f5ec22013-09-09 15:22:25 -04003183 if (!(seq & 1))
3184 rcu_read_unlock();
3185 if (need_seqretry(&rename_lock, seq)) {
3186 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003187 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003188 }
Al Viro48f5ec22013-09-09 15:22:25 -04003189 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003190
3191 if (!(m_seq & 1))
3192 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003193 if (need_seqretry(&mount_lock, m_seq)) {
3194 m_seq = 1;
3195 goto restart_mnt;
3196 }
3197 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003198
Waiman Long232d2d62013-09-09 12:18:13 -04003199 if (error >= 0 && bptr == *buffer) {
3200 if (--blen < 0)
3201 error = -ENAMETOOLONG;
3202 else
3203 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003204 }
Waiman Long232d2d62013-09-09 12:18:13 -04003205 *buffer = bptr;
3206 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003207 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003208}
3209
3210/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003211 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003212 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003213 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003214 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 * @buflen: buffer length
3216 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003217 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003219 * Returns a pointer into the buffer or an error code if the
3220 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003221 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003222 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003223 *
Al Viro02125a82011-12-05 08:43:34 -05003224 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 */
Al Viro02125a82011-12-05 08:43:34 -05003226char *__d_path(const struct path *path,
3227 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003228 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003230 char *res = buf + buflen;
3231 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003233 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003234 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003235
Al Viro02125a82011-12-05 08:43:34 -05003236 if (error < 0)
3237 return ERR_PTR(error);
3238 if (error > 0)
3239 return NULL;
3240 return res;
3241}
3242
3243char *d_absolute_path(const struct path *path,
3244 char *buf, int buflen)
3245{
3246 struct path root = {};
3247 char *res = buf + buflen;
3248 int error;
3249
3250 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003251 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003252
3253 if (error > 1)
3254 error = -EINVAL;
3255 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003256 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003257 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258}
3259
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003260/*
3261 * same as __d_path but appends "(deleted)" for unlinked files.
3262 */
Al Viro02125a82011-12-05 08:43:34 -05003263static int path_with_deleted(const struct path *path,
3264 const struct path *root,
3265 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003266{
3267 prepend(buf, buflen, "\0", 1);
3268 if (d_unlinked(path->dentry)) {
3269 int error = prepend(buf, buflen, " (deleted)", 10);
3270 if (error)
3271 return error;
3272 }
3273
3274 return prepend_path(path, root, buf, buflen);
3275}
3276
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003277static int prepend_unreachable(char **buffer, int *buflen)
3278{
3279 return prepend(buffer, buflen, "(unreachable)", 13);
3280}
3281
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003282static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3283{
3284 unsigned seq;
3285
3286 do {
3287 seq = read_seqcount_begin(&fs->seq);
3288 *root = fs->root;
3289 } while (read_seqcount_retry(&fs->seq, seq));
3290}
3291
Jan Bluncka03a8a702008-02-14 19:38:32 -08003292/**
3293 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003294 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003295 * @buf: buffer to return value in
3296 * @buflen: buffer length
3297 *
3298 * Convert a dentry into an ASCII path name. If the entry has been deleted
3299 * the string " (deleted)" is appended. Note that this is ambiguous.
3300 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003301 * Returns a pointer into the buffer or an error code if the path was
3302 * too long. Note: Callers should use the returned pointer, not the passed
3303 * in buffer, to use the name! The implementation often starts at an offset
3304 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003305 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003306 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003307 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003308char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003309{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003310 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003311 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003312 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003314 /*
3315 * We have various synthetic filesystems that never get mounted. On
3316 * these filesystems dentries are never used for lookup purposes, and
3317 * thus don't need to be hashed. They also don't need a name until a
3318 * user wants to identify the object in /proc/pid/fd/. The little hack
3319 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003320 *
3321 * Some pseudo inodes are mountable. When they are mounted
3322 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3323 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003324 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003325 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3326 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003327 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003328
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003329 rcu_read_lock();
3330 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003331 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003332 rcu_read_unlock();
3333
Al Viro02125a82011-12-05 08:43:34 -05003334 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003335 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336 return res;
3337}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003338EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339
3340/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003341 * Helper function for dentry_operations.d_dname() members
3342 */
3343char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3344 const char *fmt, ...)
3345{
3346 va_list args;
3347 char temp[64];
3348 int sz;
3349
3350 va_start(args, fmt);
3351 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3352 va_end(args);
3353
3354 if (sz > sizeof(temp) || sz > buflen)
3355 return ERR_PTR(-ENAMETOOLONG);
3356
3357 buffer += buflen - sz;
3358 return memcpy(buffer, temp, sz);
3359}
3360
Al Viro118b2302013-08-24 12:08:17 -04003361char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3362{
3363 char *end = buffer + buflen;
3364 /* these dentries are never renamed, so d_lock is not needed */
3365 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003366 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003367 prepend(&end, &buflen, "/", 1))
3368 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003369 return end;
Al Viro118b2302013-08-24 12:08:17 -04003370}
David Herrmann31bbe162014-01-03 14:09:47 +01003371EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003372
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003373/*
Ram Pai6092d042008-03-27 13:06:20 +01003374 * Write full pathname from the root of the filesystem into the buffer.
3375 */
Al Virof6500802014-01-26 12:37:55 -05003376static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003377{
Al Virof6500802014-01-26 12:37:55 -05003378 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003379 char *end, *retval;
3380 int len, seq = 0;
3381 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003382
Al Virof6500802014-01-26 12:37:55 -05003383 if (buflen < 2)
3384 goto Elong;
3385
Al Viro48f5ec22013-09-09 15:22:25 -04003386 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003387restart:
Al Virof6500802014-01-26 12:37:55 -05003388 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003389 end = buf + buflen;
3390 len = buflen;
3391 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003392 /* Get '/' right */
3393 retval = end-1;
3394 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003395 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003396 while (!IS_ROOT(dentry)) {
3397 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003398
Ram Pai6092d042008-03-27 13:06:20 +01003399 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003400 error = prepend_name(&end, &len, &dentry->d_name);
3401 if (error)
3402 break;
Ram Pai6092d042008-03-27 13:06:20 +01003403
3404 retval = end;
3405 dentry = parent;
3406 }
Al Viro48f5ec22013-09-09 15:22:25 -04003407 if (!(seq & 1))
3408 rcu_read_unlock();
3409 if (need_seqretry(&rename_lock, seq)) {
3410 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003411 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003412 }
3413 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003414 if (error)
3415 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003416 return retval;
3417Elong:
3418 return ERR_PTR(-ENAMETOOLONG);
3419}
Nick Pigginec2447c2011-01-07 17:49:29 +11003420
3421char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3422{
Waiman Long232d2d62013-09-09 12:18:13 -04003423 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003424}
3425EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003426
3427char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3428{
3429 char *p = NULL;
3430 char *retval;
3431
Al Viroc1031352010-06-06 22:31:14 -04003432 if (d_unlinked(dentry)) {
3433 p = buf + buflen;
3434 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3435 goto Elong;
3436 buflen++;
3437 }
3438 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003439 if (!IS_ERR(retval) && p)
3440 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003441 return retval;
3442Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003443 return ERR_PTR(-ENAMETOOLONG);
3444}
3445
Linus Torvalds8b19e342013-09-12 10:35:47 -07003446static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3447 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003448{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003449 unsigned seq;
3450
3451 do {
3452 seq = read_seqcount_begin(&fs->seq);
3453 *root = fs->root;
3454 *pwd = fs->pwd;
3455 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003456}
3457
Ram Pai6092d042008-03-27 13:06:20 +01003458/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003459 * NOTE! The user-level library version returns a
3460 * character pointer. The kernel system call just
3461 * returns the length of the buffer filled (which
3462 * includes the ending '\0' character), or a negative
3463 * error value. So libc would do something like
3464 *
3465 * char *getcwd(char * buf, size_t size)
3466 * {
3467 * int retval;
3468 *
3469 * retval = sys_getcwd(buf, size);
3470 * if (retval >= 0)
3471 * return buf;
3472 * errno = -retval;
3473 * return NULL;
3474 * }
3475 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003476SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003477{
Linus Torvalds552ce542007-02-13 12:08:18 -08003478 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003479 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003480 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481
3482 if (!page)
3483 return -ENOMEM;
3484
Linus Torvalds8b19e342013-09-12 10:35:47 -07003485 rcu_read_lock();
3486 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487
Linus Torvalds552ce542007-02-13 12:08:18 -08003488 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003489 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003490 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003491 char *cwd = page + PATH_MAX;
3492 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003494 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003495 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003496 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003497
Al Viro02125a82011-12-05 08:43:34 -05003498 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003499 goto out;
3500
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003501 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003502 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003503 error = prepend_unreachable(&cwd, &buflen);
3504 if (error)
3505 goto out;
3506 }
3507
Linus Torvalds552ce542007-02-13 12:08:18 -08003508 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003509 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003510 if (len <= size) {
3511 error = len;
3512 if (copy_to_user(buf, cwd, len))
3513 error = -EFAULT;
3514 }
Nick Piggin949854d2011-01-07 17:49:37 +11003515 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003516 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518
3519out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003520 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521 return error;
3522}
3523
3524/*
3525 * Test whether new_dentry is a subdirectory of old_dentry.
3526 *
3527 * Trivially implemented using the dcache structure
3528 */
3529
3530/**
3531 * is_subdir - is new dentry a subdirectory of old_dentry
3532 * @new_dentry: new dentry
3533 * @old_dentry: old dentry
3534 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003535 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3536 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3538 */
3539
Yaowei Baia6e57872015-11-17 14:40:11 +08003540bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003541{
Yaowei Baia6e57872015-11-17 14:40:11 +08003542 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003543 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003544
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003545 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003546 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003547
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003548 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003551 /*
3552 * Need rcu_readlock to protect against the d_parent trashing
3553 * due to d_move
3554 */
3555 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003556 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003557 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003558 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003559 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003560 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562
3563 return result;
3564}
3565
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003566static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003567{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003568 struct dentry *root = data;
3569 if (dentry != root) {
3570 if (d_unhashed(dentry) || !dentry->d_inode)
3571 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003572
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003573 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3574 dentry->d_flags |= DCACHE_GENOCIDE;
3575 dentry->d_lockref.count--;
3576 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003578 return D_WALK_CONTINUE;
3579}
Nick Piggin58db63d2011-01-07 17:49:39 +11003580
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003581void d_genocide(struct dentry *parent)
3582{
3583 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003584}
3585
Al Viro60545d02013-06-07 01:20:27 -04003586void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587{
Al Viro60545d02013-06-07 01:20:27 -04003588 inode_dec_link_count(inode);
3589 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003590 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003591 !d_unlinked(dentry));
3592 spin_lock(&dentry->d_parent->d_lock);
3593 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3594 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3595 (unsigned long long)inode->i_ino);
3596 spin_unlock(&dentry->d_lock);
3597 spin_unlock(&dentry->d_parent->d_lock);
3598 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003599}
Al Viro60545d02013-06-07 01:20:27 -04003600EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601
3602static __initdata unsigned long dhash_entries;
3603static int __init set_dhash_entries(char *str)
3604{
3605 if (!str)
3606 return 0;
3607 dhash_entries = simple_strtoul(str, &str, 0);
3608 return 1;
3609}
3610__setup("dhash_entries=", set_dhash_entries);
3611
3612static void __init dcache_init_early(void)
3613{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003614 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615
3616 /* If hashes are distributed across NUMA nodes, defer
3617 * hash allocation until vmalloc space is available.
3618 */
3619 if (hashdist)
3620 return;
3621
3622 dentry_hashtable =
3623 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003624 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003625 dhash_entries,
3626 13,
3627 HASH_EARLY,
3628 &d_hash_shift,
3629 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003630 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003631 0);
3632
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003633 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003634 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003635}
3636
Denis Cheng74bf17c2007-10-16 23:26:30 -07003637static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003639 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640
3641 /*
3642 * A constructor could be added for stable state like the lists,
3643 * but it is probably not worth it because of the cache nature
3644 * of the dcache.
3645 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003646 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003647 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648
3649 /* Hash may have been set up in dcache_init_early */
3650 if (!hashdist)
3651 return;
3652
3653 dentry_hashtable =
3654 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003655 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003656 dhash_entries,
3657 13,
3658 0,
3659 &d_hash_shift,
3660 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003661 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003662 0);
3663
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003664 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003665 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003666}
3667
3668/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003669struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003670EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003671
Linus Torvalds1da177e2005-04-16 15:20:36 -07003672EXPORT_SYMBOL(d_genocide);
3673
Linus Torvalds1da177e2005-04-16 15:20:36 -07003674void __init vfs_caches_init_early(void)
3675{
3676 dcache_init_early();
3677 inode_init_early();
3678}
3679
Mel Gorman4248b0d2015-08-06 15:46:20 -07003680void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003681{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003682 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003683 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003684
Denis Cheng74bf17c2007-10-16 23:26:30 -07003685 dcache_init();
3686 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003687 files_init();
3688 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003689 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003690 bdev_cache_init();
3691 chrdev_init();
3692}