blob: c0c7fa8224bad297bafe331529f8cad9fd2b4d15 [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 Viro550dce02016-05-29 20:13:30 -0400355 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500356
Al Viro550dce02016-05-29 20:13:30 -0400357 if (hashed)
358 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000359 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400360 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400361 if (hashed)
362 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100363 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100364 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100365 if (!inode->i_nlink)
366 fsnotify_inoderemove(inode);
367 if (dentry->d_op && dentry->d_op->d_iput)
368 dentry->d_op->d_iput(dentry, inode);
369 else
370 iput(inode);
371}
372
373/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400374 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
375 * is in use - which includes both the "real" per-superblock
376 * LRU list _and_ the DCACHE_SHRINK_LIST use.
377 *
378 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
379 * on the shrink list (ie not on the superblock LRU list).
380 *
381 * The per-cpu "nr_dentry_unused" counters are updated with
382 * the DCACHE_LRU_LIST bit.
383 *
384 * These helper functions make sure we always follow the
385 * rules. d_lock must be held by the caller.
386 */
387#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
388static void d_lru_add(struct dentry *dentry)
389{
390 D_FLAG_VERIFY(dentry, 0);
391 dentry->d_flags |= DCACHE_LRU_LIST;
392 this_cpu_inc(nr_dentry_unused);
393 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
394}
395
396static void d_lru_del(struct dentry *dentry)
397{
398 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
399 dentry->d_flags &= ~DCACHE_LRU_LIST;
400 this_cpu_dec(nr_dentry_unused);
401 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
402}
403
404static void d_shrink_del(struct dentry *dentry)
405{
406 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
407 list_del_init(&dentry->d_lru);
408 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
409 this_cpu_dec(nr_dentry_unused);
410}
411
412static void d_shrink_add(struct dentry *dentry, struct list_head *list)
413{
414 D_FLAG_VERIFY(dentry, 0);
415 list_add(&dentry->d_lru, list);
416 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
417 this_cpu_inc(nr_dentry_unused);
418}
419
420/*
421 * These can only be called under the global LRU lock, ie during the
422 * callback for freeing the LRU list. "isolate" removes it from the
423 * LRU lists entirely, while shrink_move moves it to the indicated
424 * private list.
425 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800426static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400427{
428 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
429 dentry->d_flags &= ~DCACHE_LRU_LIST;
430 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800431 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400432}
433
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800434static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
435 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400436{
437 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
438 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800439 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400440}
441
442/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000443 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700444 */
445static void dentry_lru_add(struct dentry *dentry)
446{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400447 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
448 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700449}
450
Miklos Szeredid52b9082007-05-08 00:23:46 -0700451/**
Nick Piggin789680d2011-01-07 17:49:30 +1100452 * d_drop - drop a dentry
453 * @dentry: dentry to drop
454 *
455 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
456 * be found through a VFS lookup any more. Note that this is different from
457 * deleting the dentry - d_delete will try to mark the dentry negative if
458 * possible, giving a successful _negative_ lookup, while d_drop will
459 * just make the cache lookup fail.
460 *
461 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
462 * reason (NFS timeouts or autofs deletes).
463 *
464 * __d_drop requires dentry->d_lock.
465 */
466void __d_drop(struct dentry *dentry)
467{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700468 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400469 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400470 /*
471 * Hashed dentries are normally on the dentry hashtable,
472 * with the exception of those newly allocated by
473 * d_obtain_alias, which are always IS_ROOT:
474 */
475 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400476 b = &dentry->d_sb->s_anon;
477 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700478 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400479
480 hlist_bl_lock(b);
481 __hlist_bl_del(&dentry->d_hash);
482 dentry->d_hash.pprev = NULL;
483 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400484 /* After this call, in-progress rcu-walk path lookup will fail. */
485 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100486 }
487}
488EXPORT_SYMBOL(__d_drop);
489
490void d_drop(struct dentry *dentry)
491{
Nick Piggin789680d2011-01-07 17:49:30 +1100492 spin_lock(&dentry->d_lock);
493 __d_drop(dentry);
494 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100495}
496EXPORT_SYMBOL(d_drop);
497
Al Viroba65dc52016-06-10 11:32:47 -0400498static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
499{
500 struct dentry *next;
501 /*
502 * Inform d_walk() and shrink_dentry_list() that we are no longer
503 * attached to the dentry tree
504 */
505 dentry->d_flags |= DCACHE_DENTRY_KILLED;
506 if (unlikely(list_empty(&dentry->d_child)))
507 return;
508 __list_del_entry(&dentry->d_child);
509 /*
510 * Cursors can move around the list of children. While we'd been
511 * a normal list member, it didn't matter - ->d_child.next would've
512 * been updated. However, from now on it won't be and for the
513 * things like d_walk() it might end up with a nasty surprise.
514 * Normally d_walk() doesn't care about cursors moving around -
515 * ->d_lock on parent prevents that and since a cursor has no children
516 * of its own, we get through it without ever unlocking the parent.
517 * There is one exception, though - if we ascend from a child that
518 * gets killed as soon as we unlock it, the next sibling is found
519 * using the value left in its ->d_child.next. And if _that_
520 * pointed to a cursor, and cursor got moved (e.g. by lseek())
521 * before d_walk() regains parent->d_lock, we'll end up skipping
522 * everything the cursor had been moved past.
523 *
524 * Solution: make sure that the pointer left behind in ->d_child.next
525 * points to something that won't be moving around. I.e. skip the
526 * cursors.
527 */
528 while (dentry->d_child.next != &parent->d_subdirs) {
529 next = list_entry(dentry->d_child.next, struct dentry, d_child);
530 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
531 break;
532 dentry->d_child.next = next->d_child.next;
533 }
534}
535
Al Viroe55fd012014-05-28 13:51:12 -0400536static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100537{
Al Viro41edf272014-05-01 10:30:00 -0400538 struct dentry *parent = NULL;
539 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400540 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100541 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100542
Linus Torvalds0d984392013-09-08 13:46:52 -0700543 /*
544 * The dentry is now unrecoverably dead to the world.
545 */
546 lockref_mark_dead(&dentry->d_lockref);
547
Sage Weilf0023bc2011-10-28 10:02:42 -0700548 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700549 * inform the fs via d_prune that this dentry is about to be
550 * unhashed and destroyed.
551 */
Al Viro29266202014-05-30 11:39:02 -0400552 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800553 dentry->d_op->d_prune(dentry);
554
Al Viro01b60352014-04-29 23:42:52 -0400555 if (dentry->d_flags & DCACHE_LRU_LIST) {
556 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
557 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400558 }
Nick Piggin77812a12011-01-07 17:49:48 +1100559 /* if it was on the hash then remove it */
560 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400561 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400562 if (parent)
563 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400564 if (dentry->d_inode)
565 dentry_unlink_inode(dentry);
566 else
567 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400568 this_cpu_dec(nr_dentry);
569 if (dentry->d_op && dentry->d_op->d_release)
570 dentry->d_op->d_release(dentry);
571
Al Viro41edf272014-05-01 10:30:00 -0400572 spin_lock(&dentry->d_lock);
573 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
574 dentry->d_flags |= DCACHE_MAY_FREE;
575 can_free = false;
576 }
577 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400578 if (likely(can_free))
579 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400580}
581
582/*
583 * Finish off a dentry we've decided to kill.
584 * dentry->d_lock must be held, returns with it unlocked.
585 * If ref is non-zero, then decrement the refcount too.
586 * Returns dentry requiring refcount drop, or NULL if we're done.
587 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400588static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400589 __releases(dentry->d_lock)
590{
591 struct inode *inode = dentry->d_inode;
592 struct dentry *parent = NULL;
593
594 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
595 goto failed;
596
597 if (!IS_ROOT(dentry)) {
598 parent = dentry->d_parent;
599 if (unlikely(!spin_trylock(&parent->d_lock))) {
600 if (inode)
601 spin_unlock(&inode->i_lock);
602 goto failed;
603 }
604 }
605
606 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400607 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400608
609failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400610 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400611 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100612}
613
Al Viro046b9612014-05-29 08:54:52 -0400614static inline struct dentry *lock_parent(struct dentry *dentry)
615{
616 struct dentry *parent = dentry->d_parent;
617 if (IS_ROOT(dentry))
618 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800619 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400620 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400621 if (likely(spin_trylock(&parent->d_lock)))
622 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400623 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400624 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400625again:
626 parent = ACCESS_ONCE(dentry->d_parent);
627 spin_lock(&parent->d_lock);
628 /*
629 * We can't blindly lock dentry until we are sure
630 * that we won't violate the locking order.
631 * Any changes of dentry->d_parent must have
632 * been done with parent->d_lock held, so
633 * spin_lock() above is enough of a barrier
634 * for checking if it's still our child.
635 */
636 if (unlikely(parent != dentry->d_parent)) {
637 spin_unlock(&parent->d_lock);
638 goto again;
639 }
Al Viro05f16fe2018-02-23 20:47:17 -0500640 if (parent != dentry) {
Linus Torvalds9f126002014-05-31 09:13:21 -0700641 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro05f16fe2018-02-23 20:47:17 -0500642 if (unlikely(dentry->d_lockref.count < 0)) {
643 spin_unlock(&parent->d_lock);
644 parent = NULL;
645 }
646 } else {
Al Viro046b9612014-05-29 08:54:52 -0400647 parent = NULL;
Al Viro05f16fe2018-02-23 20:47:17 -0500648 }
649 rcu_read_unlock();
Al Viro046b9612014-05-29 08:54:52 -0400650 return parent;
651}
652
Linus Torvalds360f5472015-01-09 15:19:03 -0800653/*
654 * Try to do a lockless dput(), and return whether that was successful.
655 *
656 * If unsuccessful, we return false, having already taken the dentry lock.
657 *
658 * The caller needs to hold the RCU read lock, so that the dentry is
659 * guaranteed to stay around even if the refcount goes down to zero!
660 */
661static inline bool fast_dput(struct dentry *dentry)
662{
663 int ret;
664 unsigned int d_flags;
665
666 /*
667 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100668 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800669 */
670 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
671 return lockref_put_or_lock(&dentry->d_lockref);
672
673 /*
674 * .. otherwise, we can try to just decrement the
675 * lockref optimistically.
676 */
677 ret = lockref_put_return(&dentry->d_lockref);
678
679 /*
680 * If the lockref_put_return() failed due to the lock being held
681 * by somebody else, the fast path has failed. We will need to
682 * get the lock, and then check the count again.
683 */
684 if (unlikely(ret < 0)) {
685 spin_lock(&dentry->d_lock);
686 if (dentry->d_lockref.count > 1) {
687 dentry->d_lockref.count--;
688 spin_unlock(&dentry->d_lock);
689 return 1;
690 }
691 return 0;
692 }
693
694 /*
695 * If we weren't the last ref, we're done.
696 */
697 if (ret)
698 return 1;
699
700 /*
701 * Careful, careful. The reference count went down
702 * to zero, but we don't hold the dentry lock, so
703 * somebody else could get it again, and do another
704 * dput(), and we need to not race with that.
705 *
706 * However, there is a very special and common case
707 * where we don't care, because there is nothing to
708 * do: the dentry is still hashed, it does not have
709 * a 'delete' op, and it's referenced and already on
710 * the LRU list.
711 *
712 * NOTE! Since we aren't locked, these values are
713 * not "stable". However, it is sufficient that at
714 * some point after we dropped the reference the
715 * dentry was hashed and the flags had the proper
716 * value. Other dentry users may have re-gotten
717 * a reference to the dentry and change that, but
718 * our work is done - we can leave the dentry
719 * around with a zero refcount.
720 */
721 smp_rmb();
722 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100723 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800724
725 /* Nothing to do? Dropping the reference was all we needed? */
726 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
727 return 1;
728
729 /*
730 * Not the fast normal case? Get the lock. We've already decremented
731 * the refcount, but we'll need to re-check the situation after
732 * getting the lock.
733 */
734 spin_lock(&dentry->d_lock);
735
736 /*
737 * Did somebody else grab a reference to it in the meantime, and
738 * we're no longer the last user after all? Alternatively, somebody
739 * else could have killed it and marked it dead. Either way, we
740 * don't need to do anything else.
741 */
742 if (dentry->d_lockref.count) {
743 spin_unlock(&dentry->d_lock);
744 return 1;
745 }
746
747 /*
748 * Re-get the reference we optimistically dropped. We hold the
749 * lock, and we just tested that it was zero, so we can just
750 * set it to 1.
751 */
752 dentry->d_lockref.count = 1;
753 return 0;
754}
755
756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757/*
758 * This is dput
759 *
760 * This is complicated by the fact that we do not want to put
761 * dentries that are no longer on any hash chain on the unused
762 * list: we'd much rather just get rid of them immediately.
763 *
764 * However, that implies that we have to traverse the dentry
765 * tree upwards to the parents which might _also_ now be
766 * scheduled for deletion (it may have been only waiting for
767 * its last child to go away).
768 *
769 * This tail recursion is done by hand as we don't want to depend
770 * on the compiler to always get this right (gcc generally doesn't).
771 * Real recursion would eat up our stack space.
772 */
773
774/*
775 * dput - release a dentry
776 * @dentry: dentry to release
777 *
778 * Release a dentry. This will drop the usage count and if appropriate
779 * call the dentry unlink method as well as removing it from the queues and
780 * releasing its resources. If the parent dentries were scheduled for release
781 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783void dput(struct dentry *dentry)
784{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700785 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return;
787
788repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800789 might_sleep();
790
Linus Torvalds360f5472015-01-09 15:19:03 -0800791 rcu_read_lock();
792 if (likely(fast_dput(dentry))) {
793 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800795 }
796
797 /* Slow case: now with the dentry lock held */
798 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Al Viro85c7f812016-04-14 19:52:13 -0400800 WARN_ON(d_in_lookup(dentry));
801
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700802 /* Unreachable? Get rid of it */
803 if (unlikely(d_unhashed(dentry)))
804 goto kill_it;
805
Al Viro75a6f822015-07-08 02:42:38 +0100806 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
807 goto kill_it;
808
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700809 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100811 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
Nick Piggin265ac902010-10-10 05:36:24 -0400813
Linus Torvalds358eec12013-10-31 15:43:02 -0700814 if (!(dentry->d_flags & DCACHE_REFERENCED))
815 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400816 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400817
Waiman Long98474232013-08-28 18:24:59 -0700818 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100819 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return;
821
Miklos Szeredid52b9082007-05-08 00:23:46 -0700822kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400823 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800824 if (dentry) {
825 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700826 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800827 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700829EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100832/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100833static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Waiman Long98474232013-08-28 18:24:59 -0700835 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
837
Nick Piggindc0474b2011-01-07 17:49:43 +1100838static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100839{
Waiman Long98474232013-08-28 18:24:59 -0700840 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100841}
842
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100843struct dentry *dget_parent(struct dentry *dentry)
844{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700845 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100846 struct dentry *ret;
847
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700848 /*
849 * Do optimistic parent lookup without any
850 * locking.
851 */
852 rcu_read_lock();
853 ret = ACCESS_ONCE(dentry->d_parent);
854 gotref = lockref_get_not_zero(&ret->d_lockref);
855 rcu_read_unlock();
856 if (likely(gotref)) {
857 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
858 return ret;
859 dput(ret);
860 }
861
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100862repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100863 /*
864 * Don't need rcu_dereference because we re-check it was correct under
865 * the lock.
866 */
867 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100868 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100869 spin_lock(&ret->d_lock);
870 if (unlikely(ret != dentry->d_parent)) {
871 spin_unlock(&ret->d_lock);
872 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100873 goto repeat;
874 }
Nick Piggina734eb42011-01-07 17:49:44 +1100875 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700876 BUG_ON(!ret->d_lockref.count);
877 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100878 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100879 return ret;
880}
881EXPORT_SYMBOL(dget_parent);
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883/**
884 * d_find_alias - grab a hashed alias of inode
885 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 *
887 * If inode has a hashed alias, or is a directory and has any alias,
888 * acquire the reference to alias and return it. Otherwise return NULL.
889 * Notice that if inode is a directory there can be only one alias and
890 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800891 * of a filesystem, or if the directory was renamed and d_revalidate
892 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700894 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500895 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500897static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898{
Nick Pigginda502952011-01-07 17:49:33 +1100899 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Nick Pigginda502952011-01-07 17:49:33 +1100901again:
902 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400903 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100904 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700906 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100907 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500909 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100910 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100911 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 return alias;
913 }
914 }
Nick Pigginda502952011-01-07 17:49:33 +1100915 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 }
Nick Pigginda502952011-01-07 17:49:33 +1100917 if (discon_alias) {
918 alias = discon_alias;
919 spin_lock(&alias->d_lock);
920 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500921 __dget_dlock(alias);
922 spin_unlock(&alias->d_lock);
923 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100924 }
925 spin_unlock(&alias->d_lock);
926 goto again;
927 }
928 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929}
930
Nick Pigginda502952011-01-07 17:49:33 +1100931struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932{
David Howells214fda12006-03-25 03:06:36 -0800933 struct dentry *de = NULL;
934
Al Virob3d9b7a2012-06-09 13:51:19 -0400935 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100936 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500937 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100938 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800939 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 return de;
941}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700942EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944/*
945 * Try to kill dentries associated with this inode.
946 * WARNING: you must own a reference to inode.
947 */
948void d_prune_aliases(struct inode *inode)
949{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700950 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100952 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400953 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700955 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400956 struct dentry *parent = lock_parent(dentry);
957 if (likely(!dentry->d_lockref.count)) {
958 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800959 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400960 goto restart;
961 }
962 if (parent)
963 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 }
965 spin_unlock(&dentry->d_lock);
966 }
Nick Piggin873feea2011-01-07 17:50:06 +1100967 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700969EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400971static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972{
Al Viro5c47e6d2014-04-29 16:13:18 -0400973 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700974
Miklos Szeredi60942f22014-05-02 15:38:39 -0400975 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400976 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400977 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100978 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400979 parent = lock_parent(dentry);
980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000982 * The dispose list is isolated and dentries are not accounted
983 * to the LRU here, so we can simply remove it from the list
984 * here regardless of whether it is referenced or not.
985 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400986 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000987
988 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000990 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800992 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700993 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400994 if (parent)
995 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 continue;
997 }
Nick Piggin77812a12011-01-07 17:49:48 +1100998
Al Viro64fd72e2014-05-28 09:48:44 -0400999
1000 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1001 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1002 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001003 if (parent)
1004 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001005 if (can_free)
1006 dentry_free(dentry);
1007 continue;
1008 }
1009
Al Viroff2fde92014-05-28 13:59:13 -04001010 inode = dentry->d_inode;
1011 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001012 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001013 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001014 if (parent)
1015 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001016 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001017 }
Al Viroff2fde92014-05-28 13:59:13 -04001018
Al Viroff2fde92014-05-28 13:59:13 -04001019 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001020
Al Viro5c47e6d2014-04-29 16:13:18 -04001021 /*
1022 * We need to prune ancestors too. This is necessary to prevent
1023 * quadratic behavior of shrink_dcache_parent(), but is also
1024 * expected to be beneficial in reducing dentry cache
1025 * fragmentation.
1026 */
1027 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001028 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1029 parent = lock_parent(dentry);
1030 if (dentry->d_lockref.count != 1) {
1031 dentry->d_lockref.count--;
1032 spin_unlock(&dentry->d_lock);
1033 if (parent)
1034 spin_unlock(&parent->d_lock);
1035 break;
1036 }
1037 inode = dentry->d_inode; /* can't be NULL */
1038 if (unlikely(!spin_trylock(&inode->i_lock))) {
1039 spin_unlock(&dentry->d_lock);
1040 if (parent)
1041 spin_unlock(&parent->d_lock);
1042 cpu_relax();
1043 continue;
1044 }
1045 __dentry_kill(dentry);
1046 dentry = parent;
1047 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001049}
1050
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001051static enum lru_status dentry_lru_isolate(struct list_head *item,
1052 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001053{
1054 struct list_head *freeable = arg;
1055 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1056
1057
1058 /*
1059 * we are inverting the lru lock/dentry->d_lock here,
1060 * so use a trylock. If we fail to get the lock, just skip
1061 * it
1062 */
1063 if (!spin_trylock(&dentry->d_lock))
1064 return LRU_SKIP;
1065
1066 /*
1067 * Referenced dentries are still in use. If they have active
1068 * counts, just remove them from the LRU. Otherwise give them
1069 * another pass through the LRU.
1070 */
1071 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001072 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001073 spin_unlock(&dentry->d_lock);
1074 return LRU_REMOVED;
1075 }
1076
1077 if (dentry->d_flags & DCACHE_REFERENCED) {
1078 dentry->d_flags &= ~DCACHE_REFERENCED;
1079 spin_unlock(&dentry->d_lock);
1080
1081 /*
1082 * The list move itself will be made by the common LRU code. At
1083 * this point, we've dropped the dentry->d_lock but keep the
1084 * lru lock. This is safe to do, since every list movement is
1085 * protected by the lru lock even if both locks are held.
1086 *
1087 * This is guaranteed by the fact that all LRU management
1088 * functions are intermediated by the LRU API calls like
1089 * list_lru_add and list_lru_del. List movement in this file
1090 * only ever occur through this functions or through callbacks
1091 * like this one, that are called from the LRU API.
1092 *
1093 * The only exceptions to this are functions like
1094 * shrink_dentry_list, and code that first checks for the
1095 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1096 * operating only with stack provided lists after they are
1097 * properly isolated from the main list. It is thus, always a
1098 * local access.
1099 */
1100 return LRU_ROTATE;
1101 }
1102
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001103 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001104 spin_unlock(&dentry->d_lock);
1105
1106 return LRU_REMOVED;
1107}
1108
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001109/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001110 * prune_dcache_sb - shrink the dcache
1111 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001112 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001113 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001114 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1115 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001116 * function.
1117 *
1118 * This function may fail to free any resources if all the dentries are in
1119 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001120 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001121long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001122{
Dave Chinnerf6041562013-08-28 10:18:00 +10001123 LIST_HEAD(dispose);
1124 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001125
Vladimir Davydov503c3582015-02-12 14:58:47 -08001126 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1127 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001128 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001129 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130}
1131
Glauber Costa4e717f52013-08-28 10:18:03 +10001132static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001133 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001134{
Glauber Costa4e717f52013-08-28 10:18:03 +10001135 struct list_head *freeable = arg;
1136 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001137
Glauber Costa4e717f52013-08-28 10:18:03 +10001138 /*
1139 * we are inverting the lru lock/dentry->d_lock here,
1140 * so use a trylock. If we fail to get the lock, just skip
1141 * it
1142 */
1143 if (!spin_trylock(&dentry->d_lock))
1144 return LRU_SKIP;
1145
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001146 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001147 spin_unlock(&dentry->d_lock);
1148
1149 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001150}
1151
Glauber Costa4e717f52013-08-28 10:18:03 +10001152
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001153/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 * shrink_dcache_sb - shrink dcache for a superblock
1155 * @sb: superblock
1156 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001157 * Shrink the dcache for the specified super block. This is used to free
1158 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001160void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161{
Glauber Costa4e717f52013-08-28 10:18:03 +10001162 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001163
Glauber Costa4e717f52013-08-28 10:18:03 +10001164 do {
1165 LIST_HEAD(dispose);
1166
1167 freed = list_lru_walk(&sb->s_dentry_lru,
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001168 dentry_lru_isolate_shrink, &dispose, 1024);
Glauber Costa4e717f52013-08-28 10:18:03 +10001169
1170 this_cpu_sub(nr_dentry_unused, freed);
1171 shrink_dentry_list(&dispose);
Sahitya Tummalaa9aa6522a2017-07-10 15:50:00 -07001172 cond_resched();
1173 } while (list_lru_count(&sb->s_dentry_lru) > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001175EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001178 * enum d_walk_ret - action to talke during tree walk
1179 * @D_WALK_CONTINUE: contrinue walk
1180 * @D_WALK_QUIT: quit walk
1181 * @D_WALK_NORETRY: quit when retry is needed
1182 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001184enum d_walk_ret {
1185 D_WALK_CONTINUE,
1186 D_WALK_QUIT,
1187 D_WALK_NORETRY,
1188 D_WALK_SKIP,
1189};
1190
1191/**
1192 * d_walk - walk the dentry tree
1193 * @parent: start of walk
1194 * @data: data passed to @enter() and @finish()
1195 * @enter: callback when first entering the dentry
1196 * @finish: callback when successfully finished the walk
1197 *
1198 * The @enter() and @finish() callbacks are called with d_lock held.
1199 */
1200static void d_walk(struct dentry *parent, void *data,
1201 enum d_walk_ret (*enter)(void *, struct dentry *),
1202 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203{
Nick Piggin949854d2011-01-07 17:49:37 +11001204 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001206 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001207 enum d_walk_ret ret;
1208 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001209
Nick Piggin58db63d2011-01-07 17:49:39 +11001210again:
Al Viro48f5ec22013-09-09 15:22:25 -04001211 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001212 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001213 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001214
1215 ret = enter(data, this_parent);
1216 switch (ret) {
1217 case D_WALK_CONTINUE:
1218 break;
1219 case D_WALK_QUIT:
1220 case D_WALK_SKIP:
1221 goto out_unlock;
1222 case D_WALK_NORETRY:
1223 retry = false;
1224 break;
1225 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226repeat:
1227 next = this_parent->d_subdirs.next;
1228resume:
1229 while (next != &this_parent->d_subdirs) {
1230 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001231 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001233
Al Viroba65dc52016-06-10 11:32:47 -04001234 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1235 continue;
1236
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001237 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001238
1239 ret = enter(data, dentry);
1240 switch (ret) {
1241 case D_WALK_CONTINUE:
1242 break;
1243 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001244 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001245 goto out_unlock;
1246 case D_WALK_NORETRY:
1247 retry = false;
1248 break;
1249 case D_WALK_SKIP:
1250 spin_unlock(&dentry->d_lock);
1251 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001252 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001255 spin_unlock(&this_parent->d_lock);
1256 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001258 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 goto repeat;
1260 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001261 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
1263 /*
1264 * All done at this level ... ascend and resume the search.
1265 */
Al Viroca5358e2014-10-26 19:31:10 -04001266 rcu_read_lock();
1267ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001269 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001270 this_parent = child->d_parent;
1271
Al Viro31dec132013-10-25 17:04:27 -04001272 spin_unlock(&child->d_lock);
1273 spin_lock(&this_parent->d_lock);
1274
Al Viroca5358e2014-10-26 19:31:10 -04001275 /* might go back up the wrong parent if we have had a rename. */
1276 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001277 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001278 /* go into the first sibling still alive */
1279 do {
1280 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001281 if (next == &this_parent->d_subdirs)
1282 goto ascend;
1283 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001284 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001285 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 goto resume;
1287 }
Al Viroca5358e2014-10-26 19:31:10 -04001288 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001289 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001290 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001291 if (finish)
1292 finish(data);
1293
1294out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001295 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001296 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001297 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001298
1299rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001300 spin_unlock(&this_parent->d_lock);
1301 rcu_read_unlock();
1302 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001303 if (!retry)
1304 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001305 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001306 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001308
1309/*
1310 * Search for at least 1 mount point in the dentry's subdirs.
1311 * We descend to the next level whenever the d_subdirs
1312 * list is non-empty and continue searching.
1313 */
1314
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001315static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1316{
1317 int *ret = data;
1318 if (d_mountpoint(dentry)) {
1319 *ret = 1;
1320 return D_WALK_QUIT;
1321 }
1322 return D_WALK_CONTINUE;
1323}
1324
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001325/**
1326 * have_submounts - check for mounts over a dentry
1327 * @parent: dentry to check.
1328 *
1329 * Return true if the parent or its subdirectories contain
1330 * a mount point
1331 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001332int have_submounts(struct dentry *parent)
1333{
1334 int ret = 0;
1335
1336 d_walk(parent, &ret, check_mount, NULL);
1337
1338 return ret;
1339}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001340EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
1342/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001343 * Called by mount code to set a mountpoint and check if the mountpoint is
1344 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1345 * subtree can become unreachable).
1346 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001347 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001348 * this reason take rename_lock and d_lock on dentry and ancestors.
1349 */
1350int d_set_mounted(struct dentry *dentry)
1351{
1352 struct dentry *p;
1353 int ret = -ENOENT;
1354 write_seqlock(&rename_lock);
1355 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001356 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001357 spin_lock(&p->d_lock);
1358 if (unlikely(d_unhashed(p))) {
1359 spin_unlock(&p->d_lock);
1360 goto out;
1361 }
1362 spin_unlock(&p->d_lock);
1363 }
1364 spin_lock(&dentry->d_lock);
1365 if (!d_unlinked(dentry)) {
Eric W. Biederman1a62a0f2017-01-03 14:18:43 +13001366 ret = -EBUSY;
1367 if (!d_mountpoint(dentry)) {
1368 dentry->d_flags |= DCACHE_MOUNTED;
1369 ret = 0;
1370 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001371 }
1372 spin_unlock(&dentry->d_lock);
1373out:
1374 write_sequnlock(&rename_lock);
1375 return ret;
1376}
1377
1378/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001379 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 * and move any unused dentries to the end of the unused
1381 * list for prune_dcache(). We descend to the next level
1382 * whenever the d_subdirs list is non-empty and continue
1383 * searching.
1384 *
1385 * It returns zero iff there are no unused children,
1386 * otherwise it returns the number of children moved to
1387 * the end of the unused list. This may not be the total
1388 * number of unused children, because select_parent can
1389 * drop the lock and return early due to latency
1390 * constraints.
1391 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001392
1393struct select_data {
1394 struct dentry *start;
1395 struct list_head dispose;
1396 int found;
1397};
1398
1399static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001401 struct select_data *data = _data;
1402 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001404 if (data->start == dentry)
1405 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
Al Virofe915222014-05-03 00:02:25 -04001407 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001408 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001409 } else {
1410 if (dentry->d_flags & DCACHE_LRU_LIST)
1411 d_lru_del(dentry);
1412 if (!dentry->d_lockref.count) {
1413 d_shrink_add(dentry, &data->dispose);
1414 data->found++;
1415 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 }
1417 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001418 * We can return to the caller if we have found some (this
1419 * ensures forward progress). We'll be coming back to find
1420 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 */
Al Virofe915222014-05-03 00:02:25 -04001422 if (!list_empty(&data->dispose))
1423 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001425 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
1427
1428/**
1429 * shrink_dcache_parent - prune dcache
1430 * @parent: parent of entries to prune
1431 *
1432 * Prune the dcache to remove unused children of the parent dentry.
1433 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001434void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001436 for (;;) {
1437 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001439 INIT_LIST_HEAD(&data.dispose);
1440 data.start = parent;
1441 data.found = 0;
1442
1443 d_walk(parent, &data, select_collect, NULL);
1444 if (!data.found)
1445 break;
1446
1447 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001448 cond_resched();
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001451EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
Al Viro9c8c10e2014-05-02 20:36:10 -04001453static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001454{
Al Viro9c8c10e2014-05-02 20:36:10 -04001455 /* it has busy descendents; complain about those instead */
1456 if (!list_empty(&dentry->d_subdirs))
1457 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001458
Al Viro9c8c10e2014-05-02 20:36:10 -04001459 /* root with refcount 1 is fine */
1460 if (dentry == _data && dentry->d_lockref.count == 1)
1461 return D_WALK_CONTINUE;
1462
1463 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1464 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001465 dentry,
1466 dentry->d_inode ?
1467 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001468 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001469 dentry->d_lockref.count,
1470 dentry->d_sb->s_type->name,
1471 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001472 WARN_ON(1);
1473 return D_WALK_CONTINUE;
1474}
1475
1476static void do_one_tree(struct dentry *dentry)
1477{
1478 shrink_dcache_parent(dentry);
1479 d_walk(dentry, dentry, umount_check, NULL);
1480 d_drop(dentry);
1481 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001482}
1483
1484/*
1485 * destroy the dentries attached to a superblock on unmounting
1486 */
1487void shrink_dcache_for_umount(struct super_block *sb)
1488{
1489 struct dentry *dentry;
1490
Al Viro9c8c10e2014-05-02 20:36:10 -04001491 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001492
1493 dentry = sb->s_root;
1494 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001495 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001496
1497 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001498 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1499 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001500 }
1501}
1502
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001503struct detach_data {
1504 struct select_data select;
1505 struct dentry *mountpoint;
1506};
1507static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001508{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001509 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001510
1511 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001512 __dget_dlock(dentry);
1513 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001514 return D_WALK_QUIT;
1515 }
1516
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001517 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001518}
1519
1520static void check_and_drop(void *_data)
1521{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001522 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001523
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001524 if (!data->mountpoint && !data->select.found)
1525 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001526}
1527
1528/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001529 * d_invalidate - detach submounts, prune dcache, and drop
1530 * @dentry: dentry to invalidate (aka detach, prune and drop)
1531 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001532 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001533 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 * The final d_drop is done as an atomic operation relative to
1535 * rename_lock ensuring there are no races with d_set_mounted. This
1536 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001537 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001538void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001539{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001540 /*
1541 * If it's already been dropped, return OK.
1542 */
1543 spin_lock(&dentry->d_lock);
1544 if (d_unhashed(dentry)) {
1545 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001546 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001547 }
1548 spin_unlock(&dentry->d_lock);
1549
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001550 /* Negative dentries can be dropped without further checks */
1551 if (!dentry->d_inode) {
1552 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001553 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001554 }
1555
1556 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001557 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001558
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001559 data.mountpoint = NULL;
1560 INIT_LIST_HEAD(&data.select.dispose);
1561 data.select.start = dentry;
1562 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001563
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001564 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001565
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001566 if (data.select.found)
1567 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001568
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001569 if (data.mountpoint) {
1570 detach_mounts(data.mountpoint);
1571 dput(data.mountpoint);
1572 }
1573
1574 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001575 break;
1576
1577 cond_resched();
1578 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001579}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001580EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582/**
Al Viroa4464db2011-07-07 15:03:58 -04001583 * __d_alloc - allocate a dcache entry
1584 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 * @name: qstr of the name
1586 *
1587 * Allocates a dentry. It returns %NULL if there is insufficient memory
1588 * available. On a success the dentry is returned. The name passed in is
1589 * copied and the copy passed in may be reused after this call.
1590 */
1591
Al Viroa4464db2011-07-07 15:03:58 -04001592struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593{
1594 struct dentry *dentry;
1595 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001596 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
Mel Gormane12ba742007-10-16 01:25:52 -07001598 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 if (!dentry)
1600 return NULL;
1601
Linus Torvalds6326c712012-05-21 16:14:04 -07001602 /*
1603 * We guarantee that the inline name is always NUL-terminated.
1604 * This way the memcpy() done by the name switching in rename
1605 * will still always have a NUL at the end, even if we might
1606 * be overwriting an internal NUL character
1607 */
1608 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001609 if (unlikely(!name)) {
1610 static const struct qstr anon = QSTR_INIT("/", 1);
1611 name = &anon;
1612 dname = dentry->d_iname;
1613 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001614 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001615 struct external_name *p = kmalloc(size + name->len,
1616 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001617 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 kmem_cache_free(dentry_cache, dentry);
1619 return NULL;
1620 }
Al Viro8d85b482014-09-29 14:54:27 -04001621 atomic_set(&p->u.count, 1);
1622 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001623 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1624 kasan_unpoison_shadow(dname,
1625 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 } else {
1627 dname = dentry->d_iname;
1628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 dentry->d_name.len = name->len;
1631 dentry->d_name.hash = name->hash;
1632 memcpy(dname, name->name, name->len);
1633 dname[name->len] = 0;
1634
Linus Torvalds6326c712012-05-21 16:14:04 -07001635 /* Make sure we always see the terminating NUL character */
1636 smp_wmb();
1637 dentry->d_name.name = dname;
1638
Waiman Long98474232013-08-28 18:24:59 -07001639 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001640 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001642 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001644 dentry->d_parent = dentry;
1645 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 dentry->d_op = NULL;
1647 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001648 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 INIT_LIST_HEAD(&dentry->d_lru);
1650 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001651 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1652 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001653 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Miklos Szeredi285b1022016-06-28 11:47:32 +02001655 if (dentry->d_op && dentry->d_op->d_init) {
1656 err = dentry->d_op->d_init(dentry);
1657 if (err) {
1658 if (dname_external(dentry))
1659 kfree(external_name(dentry));
1660 kmem_cache_free(dentry_cache, dentry);
1661 return NULL;
1662 }
1663 }
1664
Nick Piggin3e880fb2011-01-07 17:49:19 +11001665 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001666
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 return dentry;
1668}
Al Viroa4464db2011-07-07 15:03:58 -04001669
1670/**
1671 * d_alloc - allocate a dcache entry
1672 * @parent: parent of entry to allocate
1673 * @name: qstr of the name
1674 *
1675 * Allocates a dentry. It returns %NULL if there is insufficient memory
1676 * available. On a success the dentry is returned. The name passed in is
1677 * copied and the copy passed in may be reused after this call.
1678 */
1679struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1680{
1681 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1682 if (!dentry)
1683 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001684 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001685 spin_lock(&parent->d_lock);
1686 /*
1687 * don't need child lock because it is not subject
1688 * to concurrency here
1689 */
1690 __dget_dlock(parent);
1691 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001692 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001693 spin_unlock(&parent->d_lock);
1694
1695 return dentry;
1696}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001697EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
Al Viroba65dc52016-06-10 11:32:47 -04001699struct dentry *d_alloc_cursor(struct dentry * parent)
1700{
1701 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1702 if (dentry) {
1703 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1704 dentry->d_parent = dget(parent);
1705 }
1706 return dentry;
1707}
1708
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001709/**
1710 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1711 * @sb: the superblock
1712 * @name: qstr of the name
1713 *
1714 * For a filesystem that just pins its dentries in memory and never
1715 * performs lookups at all, return an unhashed IS_ROOT dentry.
1716 */
Nick Piggin4b936882011-01-07 17:50:07 +11001717struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1718{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001719 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001720}
1721EXPORT_SYMBOL(d_alloc_pseudo);
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1724{
1725 struct qstr q;
1726
1727 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001728 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 return d_alloc(parent, &q);
1730}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001731EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732
Nick Pigginfb045ad2011-01-07 17:49:55 +11001733void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1734{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001735 WARN_ON_ONCE(dentry->d_op);
1736 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001737 DCACHE_OP_COMPARE |
1738 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001739 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001740 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001741 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001742 dentry->d_op = op;
1743 if (!op)
1744 return;
1745 if (op->d_hash)
1746 dentry->d_flags |= DCACHE_OP_HASH;
1747 if (op->d_compare)
1748 dentry->d_flags |= DCACHE_OP_COMPARE;
1749 if (op->d_revalidate)
1750 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001751 if (op->d_weak_revalidate)
1752 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001753 if (op->d_delete)
1754 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001755 if (op->d_prune)
1756 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001757 if (op->d_real)
1758 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001759
1760}
1761EXPORT_SYMBOL(d_set_d_op);
1762
David Howellsdf1a0852015-01-29 12:02:28 +00001763
1764/*
1765 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1766 * @dentry - The dentry to mark
1767 *
1768 * Mark a dentry as falling through to the lower layer (as set with
1769 * d_pin_lower()). This flag may be recorded on the medium.
1770 */
1771void d_set_fallthru(struct dentry *dentry)
1772{
1773 spin_lock(&dentry->d_lock);
1774 dentry->d_flags |= DCACHE_FALLTHRU;
1775 spin_unlock(&dentry->d_lock);
1776}
1777EXPORT_SYMBOL(d_set_fallthru);
1778
David Howellsb18825a2013-09-12 19:22:53 +01001779static unsigned d_flags_for_inode(struct inode *inode)
1780{
David Howells44bdb5e2015-01-29 12:02:29 +00001781 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001782
1783 if (!inode)
1784 return DCACHE_MISS_TYPE;
1785
1786 if (S_ISDIR(inode->i_mode)) {
1787 add_flags = DCACHE_DIRECTORY_TYPE;
1788 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1789 if (unlikely(!inode->i_op->lookup))
1790 add_flags = DCACHE_AUTODIR_TYPE;
1791 else
1792 inode->i_opflags |= IOP_LOOKUP;
1793 }
David Howells44bdb5e2015-01-29 12:02:29 +00001794 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001795 }
1796
David Howells44bdb5e2015-01-29 12:02:29 +00001797 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001798 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001799 add_flags = DCACHE_SYMLINK_TYPE;
1800 goto type_determined;
1801 }
1802 inode->i_opflags |= IOP_NOFOLLOW;
1803 }
1804
1805 if (unlikely(!S_ISREG(inode->i_mode)))
1806 add_flags = DCACHE_SPECIAL_TYPE;
1807
1808type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001809 if (unlikely(IS_AUTOMOUNT(inode)))
1810 add_flags |= DCACHE_NEED_AUTOMOUNT;
1811 return add_flags;
1812}
1813
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001814static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1815{
David Howellsb18825a2013-09-12 19:22:53 +01001816 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001817 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001818
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001819 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001820 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001821 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001822 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001823 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001824 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001825 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001826}
1827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828/**
1829 * d_instantiate - fill in inode information for a dentry
1830 * @entry: dentry to complete
1831 * @inode: inode to attach to this dentry
1832 *
1833 * Fill in inode information in the entry.
1834 *
1835 * This turns negative dentries into productive full members
1836 * of society.
1837 *
1838 * NOTE! This assumes that the inode count has been incremented
1839 * (or otherwise set) by the caller to indicate that it is now
1840 * in use by the dcache.
1841 */
1842
1843void d_instantiate(struct dentry *entry, struct inode * inode)
1844{
Al Viro946e51f2014-10-26 19:19:16 -04001845 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001846 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001847 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001848 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001849 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001850 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001851 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001853EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
1855/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001856 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1857 * @entry: dentry to complete
1858 * @inode: inode to attach to this dentry
1859 *
1860 * Fill in inode information in the entry. If a directory alias is found, then
1861 * return an error (and drop inode). Together with d_materialise_unique() this
1862 * guarantees that a directory inode may never have more than one alias.
1863 */
1864int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1865{
Al Viro946e51f2014-10-26 19:19:16 -04001866 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001867
Al Virob9680912016-04-11 00:53:26 -04001868 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001869 spin_lock(&inode->i_lock);
1870 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1871 spin_unlock(&inode->i_lock);
1872 iput(inode);
1873 return -EBUSY;
1874 }
1875 __d_instantiate(entry, inode);
1876 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001877
1878 return 0;
1879}
1880EXPORT_SYMBOL(d_instantiate_no_diralias);
1881
Al Viroadc0e912012-01-08 16:49:21 -05001882struct dentry *d_make_root(struct inode *root_inode)
1883{
1884 struct dentry *res = NULL;
1885
1886 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001887 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001888 if (res)
1889 d_instantiate(res, root_inode);
1890 else
1891 iput(root_inode);
1892 }
1893 return res;
1894}
1895EXPORT_SYMBOL(d_make_root);
1896
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001897static struct dentry * __d_find_any_alias(struct inode *inode)
1898{
1899 struct dentry *alias;
1900
Al Virob3d9b7a2012-06-09 13:51:19 -04001901 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001902 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001903 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001904 __dget(alias);
1905 return alias;
1906}
1907
Sage Weil46f72b32012-01-10 09:04:37 -08001908/**
1909 * d_find_any_alias - find any alias for a given inode
1910 * @inode: inode to find an alias for
1911 *
1912 * If any aliases exist for the given inode, take and return a
1913 * reference for one of them. If no aliases exist, return %NULL.
1914 */
1915struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001916{
1917 struct dentry *de;
1918
1919 spin_lock(&inode->i_lock);
1920 de = __d_find_any_alias(inode);
1921 spin_unlock(&inode->i_lock);
1922 return de;
1923}
Sage Weil46f72b32012-01-10 09:04:37 -08001924EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001925
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001926static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001927{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001928 struct dentry *tmp;
1929 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001930 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001931
1932 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001933 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001934 if (IS_ERR(inode))
1935 return ERR_CAST(inode);
1936
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001937 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001938 if (res)
1939 goto out_iput;
1940
Al Viro798434b2016-03-24 20:38:43 -04001941 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001942 if (!tmp) {
1943 res = ERR_PTR(-ENOMEM);
1944 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001945 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001946
Al Virob9680912016-04-11 00:53:26 -04001947 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001948 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001949 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001950 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001951 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001952 dput(tmp);
1953 goto out_iput;
1954 }
1955
1956 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001957 add_flags = d_flags_for_inode(inode);
1958
1959 if (disconnected)
1960 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001961
Christoph Hellwig9308a612008-08-11 15:49:12 +02001962 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001963 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001964 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001965 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001966 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001967 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001968 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001969 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001970
Christoph Hellwig9308a612008-08-11 15:49:12 +02001971 return tmp;
1972
1973 out_iput:
1974 iput(inode);
1975 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001976}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001977
1978/**
1979 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1980 * @inode: inode to allocate the dentry for
1981 *
1982 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1983 * similar open by handle operations. The returned dentry may be anonymous,
1984 * or may have a full name (if the inode was already in the cache).
1985 *
1986 * When called on a directory inode, we must ensure that the inode only ever
1987 * has one dentry. If a dentry is found, that is returned instead of
1988 * allocating a new one.
1989 *
1990 * On successful return, the reference to the inode has been transferred
1991 * to the dentry. In case of an error the reference on the inode is released.
1992 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1993 * be passed in and the error will be propagated to the return value,
1994 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1995 */
1996struct dentry *d_obtain_alias(struct inode *inode)
1997{
1998 return __d_obtain_alias(inode, 1);
1999}
Benny Halevyadc48722009-02-27 14:02:59 -08002000EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
2002/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05002003 * d_obtain_root - find or allocate a dentry for a given inode
2004 * @inode: inode to allocate the dentry for
2005 *
2006 * Obtain an IS_ROOT dentry for the root of a filesystem.
2007 *
2008 * We must ensure that directory inodes only ever have one dentry. If a
2009 * dentry is found, that is returned instead of allocating a new one.
2010 *
2011 * On successful return, the reference to the inode has been transferred
2012 * to the dentry. In case of an error the reference on the inode is
2013 * released. A %NULL or IS_ERR inode may be passed in and will be the
2014 * error will be propagate to the return value, with a %NULL @inode
2015 * replaced by ERR_PTR(-ESTALE).
2016 */
2017struct dentry *d_obtain_root(struct inode *inode)
2018{
2019 return __d_obtain_alias(inode, 0);
2020}
2021EXPORT_SYMBOL(d_obtain_root);
2022
2023/**
Barry Naujok94035402008-05-21 16:50:46 +10002024 * d_add_ci - lookup or allocate new dentry with case-exact name
2025 * @inode: the inode case-insensitive lookup has found
2026 * @dentry: the negative dentry that was passed to the parent's lookup func
2027 * @name: the case-exact name to be associated with the returned dentry
2028 *
2029 * This is to avoid filling the dcache with case-insensitive names to the
2030 * same inode, only the actual correct case is stored in the dcache for
2031 * case-insensitive filesystems.
2032 *
2033 * For a case-insensitive lookup match and if the the case-exact dentry
2034 * already exists in in the dcache, use it and return it.
2035 *
2036 * If no entry exists with the exact case name, allocate new dentry with
2037 * the exact case, and return the spliced entry.
2038 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002039struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002040 struct qstr *name)
2041{
Al Virod9171b92016-04-15 03:33:13 -04002042 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002043
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002044 /*
2045 * First check if a dentry matching the name already exists,
2046 * if not go ahead and create it now.
2047 */
Barry Naujok94035402008-05-21 16:50:46 +10002048 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002049 if (found) {
2050 iput(inode);
2051 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002052 }
Al Virod9171b92016-04-15 03:33:13 -04002053 if (d_in_lookup(dentry)) {
2054 found = d_alloc_parallel(dentry->d_parent, name,
2055 dentry->d_wait);
2056 if (IS_ERR(found) || !d_in_lookup(found)) {
2057 iput(inode);
2058 return found;
2059 }
2060 } else {
2061 found = d_alloc(dentry->d_parent, name);
2062 if (!found) {
2063 iput(inode);
2064 return ERR_PTR(-ENOMEM);
2065 }
2066 }
2067 res = d_splice_alias(inode, found);
2068 if (res) {
2069 dput(found);
2070 return res;
2071 }
Al Viro4f522a22013-02-11 23:20:37 -05002072 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002073}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002074EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002076
Al Virod4c91a82016-06-25 23:33:49 -04002077static inline bool d_same_name(const struct dentry *dentry,
2078 const struct dentry *parent,
2079 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002080{
Al Virod4c91a82016-06-25 23:33:49 -04002081 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2082 if (dentry->d_name.len != name->len)
2083 return false;
2084 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002085 }
Al Viro6fa67e72016-07-31 16:37:25 -04002086 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002087 dentry->d_name.len, dentry->d_name.name,
2088 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002089}
2090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002092 * __d_lookup_rcu - search for a dentry (racy, store-free)
2093 * @parent: parent dentry
2094 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002095 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 * Returns: dentry, or NULL
2097 *
2098 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2099 * resolution (store-free path walking) design described in
2100 * Documentation/filesystems/path-lookup.txt.
2101 *
2102 * This is not to be used outside core vfs.
2103 *
2104 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2105 * held, and rcu_read_lock held. The returned dentry must not be stored into
2106 * without taking d_lock and checking d_seq sequence count against @seq
2107 * returned here.
2108 *
Linus Torvalds15570082013-09-02 11:38:06 -07002109 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002110 * function.
2111 *
2112 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2113 * the returned dentry, so long as its parent's seqlock is checked after the
2114 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2115 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002116 *
2117 * NOTE! The caller *has* to check the resulting dentry against the sequence
2118 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002119 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002120struct dentry *__d_lookup_rcu(const struct dentry *parent,
2121 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002122 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002123{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002124 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002125 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002126 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002127 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002128 struct dentry *dentry;
2129
2130 /*
2131 * Note: There is significant duplication with __d_lookup_rcu which is
2132 * required to prevent single threaded performance regressions
2133 * especially on architectures where smp_rmb (in seqcounts) are costly.
2134 * Keep the two functions in sync.
2135 */
2136
2137 /*
2138 * The hash list is protected using RCU.
2139 *
2140 * Carefully use d_seq when comparing a candidate dentry, to avoid
2141 * races with d_move().
2142 *
2143 * It is possible that concurrent renames can mess up our list
2144 * walk here and result in missing our dentry, resulting in the
2145 * false-negative result. d_lookup() protects against concurrent
2146 * renames using rename_lock seqlock.
2147 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002148 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002149 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002150 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002151 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002152
Nick Piggin31e6b012011-01-07 17:49:52 +11002153seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002154 /*
2155 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002156 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002157 *
2158 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002159 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002160 *
2161 * NOTE! We do a "raw" seqcount_begin here. That means that
2162 * we don't wait for the sequence count to stabilize if it
2163 * is in the middle of a sequence change. If we do the slow
2164 * dentry compare, we will do seqretries until it is stable,
2165 * and if we end up with a successful lookup, we actually
2166 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002167 *
2168 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2169 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002170 */
2171 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002172 if (dentry->d_parent != parent)
2173 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002174 if (d_unhashed(dentry))
2175 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002176
2177 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002178 int tlen;
2179 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002180 if (dentry->d_name.hash != hashlen_hash(hashlen))
2181 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002182 tlen = dentry->d_name.len;
2183 tname = dentry->d_name.name;
2184 /* we want a consistent (name,len) pair */
2185 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2186 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002187 goto seqretry;
2188 }
Al Viro6fa67e72016-07-31 16:37:25 -04002189 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002190 tlen, tname, name) != 0)
2191 continue;
2192 } else {
2193 if (dentry->d_name.hash_len != hashlen)
2194 continue;
2195 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2196 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002197 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002198 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002199 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002200 }
2201 return NULL;
2202}
2203
2204/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 * d_lookup - search for a dentry
2206 * @parent: parent dentry
2207 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002208 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002210 * d_lookup searches the children of the parent dentry for the name in
2211 * question. If the dentry is found its reference count is incremented and the
2212 * dentry is returned. The caller must use dput to free the entry when it has
2213 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 */
Al Viroda2d8452013-01-24 18:29:34 -05002215struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216{
Nick Piggin31e6b012011-01-07 17:49:52 +11002217 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002218 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
Daeseok Younb8314f92014-08-11 11:46:53 +09002220 do {
2221 seq = read_seqbegin(&rename_lock);
2222 dentry = __d_lookup(parent, name);
2223 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 break;
2225 } while (read_seqretry(&rename_lock, seq));
2226 return dentry;
2227}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002228EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
Nick Piggin31e6b012011-01-07 17:49:52 +11002230/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002231 * __d_lookup - search for a dentry (racy)
2232 * @parent: parent dentry
2233 * @name: qstr of name we wish to find
2234 * Returns: dentry, or NULL
2235 *
2236 * __d_lookup is like d_lookup, however it may (rarely) return a
2237 * false-negative result due to unrelated rename activity.
2238 *
2239 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2240 * however it must be used carefully, eg. with a following d_lookup in
2241 * the case of failure.
2242 *
2243 * __d_lookup callers must be commented.
2244 */
Al Viroa713ca22013-01-24 18:27:00 -05002245struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002248 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002249 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002250 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002251 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252
Nick Pigginb04f7842010-08-18 04:37:34 +10002253 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002254 * Note: There is significant duplication with __d_lookup_rcu which is
2255 * required to prevent single threaded performance regressions
2256 * especially on architectures where smp_rmb (in seqcounts) are costly.
2257 * Keep the two functions in sync.
2258 */
2259
2260 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002261 * The hash list is protected using RCU.
2262 *
2263 * Take d_lock when comparing a candidate dentry, to avoid races
2264 * with d_move().
2265 *
2266 * It is possible that concurrent renames can mess up our list
2267 * walk here and result in missing our dentry, resulting in the
2268 * false-negative result. d_lookup() protects against concurrent
2269 * renames using rename_lock seqlock.
2270 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002271 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002272 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 rcu_read_lock();
2274
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002275 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 if (dentry->d_name.hash != hash)
2278 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
2280 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 if (dentry->d_parent != parent)
2282 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002283 if (d_unhashed(dentry))
2284 goto next;
2285
Al Virod4c91a82016-06-25 23:33:49 -04002286 if (!d_same_name(dentry, parent, name))
2287 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288
Waiman Long98474232013-08-28 18:24:59 -07002289 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002290 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 spin_unlock(&dentry->d_lock);
2292 break;
2293next:
2294 spin_unlock(&dentry->d_lock);
2295 }
2296 rcu_read_unlock();
2297
2298 return found;
2299}
2300
2301/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002302 * d_hash_and_lookup - hash the qstr then search for a dentry
2303 * @dir: Directory to search in
2304 * @name: qstr of name we wish to find
2305 *
Al Viro4f522a22013-02-11 23:20:37 -05002306 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002307 */
2308struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2309{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002310 /*
2311 * Check for a fs-specific hash function. Note that we must
2312 * calculate the standard hash first, as the d_op->d_hash()
2313 * routine may choose to leave the hash value unchanged.
2314 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002315 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002316 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002317 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002318 if (unlikely(err < 0))
2319 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002320 }
Al Viro4f522a22013-02-11 23:20:37 -05002321 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002322}
Al Viro4f522a22013-02-11 23:20:37 -05002323EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002324
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325/*
2326 * When a file is deleted, we have two options:
2327 * - turn this dentry into a negative dentry
2328 * - unhash this dentry and free it.
2329 *
2330 * Usually, we want to just turn this into
2331 * a negative dentry, but if anybody else is
2332 * currently using the dentry or the inode
2333 * we can't do that and we fall back on removing
2334 * it from the hash queues and waiting for
2335 * it to be deleted later when it has no users
2336 */
2337
2338/**
2339 * d_delete - delete a dentry
2340 * @dentry: The dentry to delete
2341 *
2342 * Turn the dentry into a negative dentry if possible, otherwise
2343 * remove it from the hash queues so it can be deleted later
2344 */
2345
2346void d_delete(struct dentry * dentry)
2347{
Nick Piggin873feea2011-01-07 17:50:06 +11002348 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002349 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 /*
2351 * Are we the only user?
2352 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002353again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002355 inode = dentry->d_inode;
2356 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002357 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002358 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002359 spin_unlock(&dentry->d_lock);
2360 cpu_relax();
2361 goto again;
2362 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002363 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002364 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002365 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 return;
2367 }
2368
2369 if (!d_unhashed(dentry))
2370 __d_drop(dentry);
2371
2372 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002373
2374 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002376EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377
Al Viro15d3c582016-07-29 17:45:21 -04002378static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379{
Al Viro15d3c582016-07-29 17:45:21 -04002380 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002381 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002382 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002383 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002384 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385}
2386
2387/**
2388 * d_rehash - add an entry back to the hash
2389 * @entry: dentry to add to the hash
2390 *
2391 * Adds a dentry to the hash according to its name.
2392 */
2393
2394void d_rehash(struct dentry * entry)
2395{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002397 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002400EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401
Al Viro84e710d2016-04-15 00:58:55 -04002402static inline unsigned start_dir_add(struct inode *dir)
2403{
2404
2405 for (;;) {
2406 unsigned n = dir->i_dir_seq;
2407 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2408 return n;
2409 cpu_relax();
2410 }
2411}
2412
2413static inline void end_dir_add(struct inode *dir, unsigned n)
2414{
2415 smp_store_release(&dir->i_dir_seq, n + 2);
2416}
2417
Al Virod9171b92016-04-15 03:33:13 -04002418static void d_wait_lookup(struct dentry *dentry)
2419{
2420 if (d_in_lookup(dentry)) {
2421 DECLARE_WAITQUEUE(wait, current);
2422 add_wait_queue(dentry->d_wait, &wait);
2423 do {
2424 set_current_state(TASK_UNINTERRUPTIBLE);
2425 spin_unlock(&dentry->d_lock);
2426 schedule();
2427 spin_lock(&dentry->d_lock);
2428 } while (d_in_lookup(dentry));
2429 }
2430}
2431
Al Viro94bdd652016-04-15 02:42:04 -04002432struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002433 const struct qstr *name,
2434 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002435{
Al Viro94bdd652016-04-15 02:42:04 -04002436 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002437 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2438 struct hlist_bl_node *node;
2439 struct dentry *new = d_alloc(parent, name);
2440 struct dentry *dentry;
2441 unsigned seq, r_seq, d_seq;
2442
2443 if (unlikely(!new))
2444 return ERR_PTR(-ENOMEM);
2445
2446retry:
2447 rcu_read_lock();
2448 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2449 r_seq = read_seqbegin(&rename_lock);
2450 dentry = __d_lookup_rcu(parent, name, &d_seq);
2451 if (unlikely(dentry)) {
2452 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2453 rcu_read_unlock();
2454 goto retry;
2455 }
2456 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2457 rcu_read_unlock();
2458 dput(dentry);
2459 goto retry;
2460 }
2461 rcu_read_unlock();
2462 dput(new);
2463 return dentry;
2464 }
2465 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2466 rcu_read_unlock();
2467 goto retry;
2468 }
2469 hlist_bl_lock(b);
2470 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2471 hlist_bl_unlock(b);
2472 rcu_read_unlock();
2473 goto retry;
2474 }
Al Viro94bdd652016-04-15 02:42:04 -04002475 /*
2476 * No changes for the parent since the beginning of d_lookup().
2477 * Since all removals from the chain happen with hlist_bl_lock(),
2478 * any potential in-lookup matches are going to stay here until
2479 * we unlock the chain. All fields are stable in everything
2480 * we encounter.
2481 */
2482 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2483 if (dentry->d_name.hash != hash)
2484 continue;
2485 if (dentry->d_parent != parent)
2486 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002487 if (!d_same_name(dentry, parent, name))
2488 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002489 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002490 /* now we can try to grab a reference */
2491 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2492 rcu_read_unlock();
2493 goto retry;
2494 }
2495
2496 rcu_read_unlock();
2497 /*
2498 * somebody is likely to be still doing lookup for it;
2499 * wait for them to finish
2500 */
Al Virod9171b92016-04-15 03:33:13 -04002501 spin_lock(&dentry->d_lock);
2502 d_wait_lookup(dentry);
2503 /*
2504 * it's not in-lookup anymore; in principle we should repeat
2505 * everything from dcache lookup, but it's likely to be what
2506 * d_lookup() would've found anyway. If it is, just return it;
2507 * otherwise we really have to repeat the whole thing.
2508 */
2509 if (unlikely(dentry->d_name.hash != hash))
2510 goto mismatch;
2511 if (unlikely(dentry->d_parent != parent))
2512 goto mismatch;
2513 if (unlikely(d_unhashed(dentry)))
2514 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002515 if (unlikely(!d_same_name(dentry, parent, name)))
2516 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002517 /* OK, it *is* a hashed match; return it */
2518 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002519 dput(new);
2520 return dentry;
2521 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002522 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002523 /* we can't take ->d_lock here; it's OK, though. */
2524 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002525 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002526 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2527 hlist_bl_unlock(b);
2528 return new;
Al Virod9171b92016-04-15 03:33:13 -04002529mismatch:
2530 spin_unlock(&dentry->d_lock);
2531 dput(dentry);
2532 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002533}
2534EXPORT_SYMBOL(d_alloc_parallel);
2535
Al Viro85c7f812016-04-14 19:52:13 -04002536void __d_lookup_done(struct dentry *dentry)
2537{
Al Viro94bdd652016-04-15 02:42:04 -04002538 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2539 dentry->d_name.hash);
2540 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002541 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002542 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002543 wake_up_all(dentry->d_wait);
2544 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002545 hlist_bl_unlock(b);
2546 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002547 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002548}
2549EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002550
2551/* inode->i_lock held if inode is non-NULL */
2552
2553static inline void __d_add(struct dentry *dentry, struct inode *inode)
2554{
Al Viro84e710d2016-04-15 00:58:55 -04002555 struct inode *dir = NULL;
2556 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002557 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002558 if (unlikely(d_in_lookup(dentry))) {
2559 dir = dentry->d_parent->d_inode;
2560 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002561 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002562 }
Al Viroed782b52016-03-09 19:52:39 -05002563 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002564 unsigned add_flags = d_flags_for_inode(inode);
2565 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2566 raw_write_seqcount_begin(&dentry->d_seq);
2567 __d_set_inode_and_type(dentry, inode, add_flags);
2568 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002569 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002570 }
Al Viro15d3c582016-07-29 17:45:21 -04002571 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002572 if (dir)
2573 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002574 spin_unlock(&dentry->d_lock);
2575 if (inode)
2576 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002577}
2578
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002579/**
Al Viro34d0d192016-03-08 21:01:03 -05002580 * d_add - add dentry to hash queues
2581 * @entry: dentry to add
2582 * @inode: The inode to attach to this dentry
2583 *
2584 * This adds the entry to the hash queues and initializes @inode.
2585 * The entry was actually filled in earlier during d_alloc().
2586 */
2587
2588void d_add(struct dentry *entry, struct inode *inode)
2589{
Al Virob9680912016-04-11 00:53:26 -04002590 if (inode) {
2591 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002592 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002593 }
Al Viroed782b52016-03-09 19:52:39 -05002594 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002595}
2596EXPORT_SYMBOL(d_add);
2597
2598/**
Al Viro668d0cd2016-03-08 12:44:17 -05002599 * d_exact_alias - find and hash an exact unhashed alias
2600 * @entry: dentry to add
2601 * @inode: The inode to go with this dentry
2602 *
2603 * If an unhashed dentry with the same name/parent and desired
2604 * inode already exists, hash and return it. Otherwise, return
2605 * NULL.
2606 *
2607 * Parent directory should be locked.
2608 */
2609struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2610{
2611 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002612 unsigned int hash = entry->d_name.hash;
2613
2614 spin_lock(&inode->i_lock);
2615 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2616 /*
2617 * Don't need alias->d_lock here, because aliases with
2618 * d_parent == entry->d_parent are not subject to name or
2619 * parent changes, because the parent inode i_mutex is held.
2620 */
2621 if (alias->d_name.hash != hash)
2622 continue;
2623 if (alias->d_parent != entry->d_parent)
2624 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002625 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002626 continue;
2627 spin_lock(&alias->d_lock);
2628 if (!d_unhashed(alias)) {
2629 spin_unlock(&alias->d_lock);
2630 alias = NULL;
2631 } else {
2632 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002633 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002634 spin_unlock(&alias->d_lock);
2635 }
2636 spin_unlock(&inode->i_lock);
2637 return alias;
2638 }
2639 spin_unlock(&inode->i_lock);
2640 return NULL;
2641}
2642EXPORT_SYMBOL(d_exact_alias);
2643
2644/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002645 * dentry_update_name_case - update case insensitive dentry with a new name
2646 * @dentry: dentry to be updated
2647 * @name: new name
2648 *
2649 * Update a case insensitive dentry with new case of name.
2650 *
2651 * dentry must have been returned by d_lookup with name @name. Old and new
2652 * name lengths must match (ie. no d_compare which allows mismatched name
2653 * lengths).
2654 *
2655 * Parent inode i_mutex must be held over d_lookup and into this call (to
2656 * keep renames and concurrent inserts, and readdir(2) away).
2657 */
Al Viro9aba36d2016-07-20 22:28:45 -04002658void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002659{
Al Viro59551022016-01-22 15:40:57 -05002660 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002661 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2662
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002663 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002664 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002665 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002666 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002667 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002668}
2669EXPORT_SYMBOL(dentry_update_name_case);
2670
Al Viro8d85b482014-09-29 14:54:27 -04002671static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672{
Al Viro8d85b482014-09-29 14:54:27 -04002673 if (unlikely(dname_external(target))) {
2674 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 /*
2676 * Both external: swap the pointers
2677 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002678 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 } else {
2680 /*
2681 * dentry:internal, target:external. Steal target's
2682 * storage and make target internal.
2683 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002684 memcpy(target->d_iname, dentry->d_name.name,
2685 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 dentry->d_name.name = target->d_name.name;
2687 target->d_name.name = target->d_iname;
2688 }
2689 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002690 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691 /*
2692 * dentry:external, target:internal. Give dentry's
2693 * storage to target and make dentry internal
2694 */
2695 memcpy(dentry->d_iname, target->d_name.name,
2696 target->d_name.len + 1);
2697 target->d_name.name = dentry->d_name.name;
2698 dentry->d_name.name = dentry->d_iname;
2699 } else {
2700 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002701 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002703 unsigned int i;
2704 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002705 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2706 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002707 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2708 swap(((long *) &dentry->d_iname)[i],
2709 ((long *) &target->d_iname)[i]);
2710 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711 }
2712 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002713 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714}
2715
Al Viro8d85b482014-09-29 14:54:27 -04002716static void copy_name(struct dentry *dentry, struct dentry *target)
2717{
2718 struct external_name *old_name = NULL;
2719 if (unlikely(dname_external(dentry)))
2720 old_name = external_name(dentry);
2721 if (unlikely(dname_external(target))) {
2722 atomic_inc(&external_name(target)->u.count);
2723 dentry->d_name = target->d_name;
2724 } else {
2725 memcpy(dentry->d_iname, target->d_name.name,
2726 target->d_name.len + 1);
2727 dentry->d_name.name = dentry->d_iname;
2728 dentry->d_name.hash_len = target->d_name.hash_len;
2729 }
2730 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2731 kfree_rcu(old_name, u.head);
2732}
2733
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002734static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2735{
2736 /*
2737 * XXXX: do we really need to take target->d_lock?
2738 */
2739 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2740 spin_lock(&target->d_parent->d_lock);
2741 else {
2742 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2743 spin_lock(&dentry->d_parent->d_lock);
2744 spin_lock_nested(&target->d_parent->d_lock,
2745 DENTRY_D_LOCK_NESTED);
2746 } else {
2747 spin_lock(&target->d_parent->d_lock);
2748 spin_lock_nested(&dentry->d_parent->d_lock,
2749 DENTRY_D_LOCK_NESTED);
2750 }
2751 }
2752 if (target < dentry) {
2753 spin_lock_nested(&target->d_lock, 2);
2754 spin_lock_nested(&dentry->d_lock, 3);
2755 } else {
2756 spin_lock_nested(&dentry->d_lock, 2);
2757 spin_lock_nested(&target->d_lock, 3);
2758 }
2759}
2760
Al Viro986c0192014-09-26 23:11:15 -04002761static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002762{
2763 if (target->d_parent != dentry->d_parent)
2764 spin_unlock(&dentry->d_parent->d_lock);
2765 if (target->d_parent != target)
2766 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002767 spin_unlock(&target->d_lock);
2768 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002769}
2770
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002772 * When switching names, the actual string doesn't strictly have to
2773 * be preserved in the target - because we're dropping the target
2774 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002775 * the new name before we switch, unless we are going to rehash
2776 * it. Note that if we *do* unhash the target, we are not allowed
2777 * to rehash it without giving it a new name/hash key - whether
2778 * we swap or overwrite the names here, resulting name won't match
2779 * the reality in filesystem; it's only there for d_path() purposes.
2780 * Note that all of this is happening under rename_lock, so the
2781 * any hash lookup seeing it in the middle of manipulations will
2782 * be discarded anyway. So we do not care what happens to the hash
2783 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002785/*
Al Viro18367502011-07-12 21:42:24 -04002786 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 * @dentry: entry to move
2788 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002789 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 *
2791 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002792 * dcache entries should not be moved in this way. Caller must hold
2793 * rename_lock, the i_mutex of the source and target directories,
2794 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002796static void __d_move(struct dentry *dentry, struct dentry *target,
2797 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798{
Al Viro84e710d2016-04-15 00:58:55 -04002799 struct inode *dir = NULL;
2800 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 if (!dentry->d_inode)
2802 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2803
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002804 BUG_ON(d_ancestor(dentry, target));
2805 BUG_ON(d_ancestor(target, dentry));
2806
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002807 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002808 if (unlikely(d_in_lookup(target))) {
2809 dir = target->d_parent->d_inode;
2810 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002811 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002812 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813
Nick Piggin31e6b012011-01-07 17:49:52 +11002814 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002815 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002816
Al Viro15d3c582016-07-29 17:45:21 -04002817 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002818 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002819 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 __d_drop(target);
2821
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002823 if (exchange)
2824 swap_names(dentry, target);
2825 else
2826 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827
Al Viro15d3c582016-07-29 17:45:21 -04002828 /* rehash in new place(s) */
2829 __d_rehash(dentry);
2830 if (exchange)
2831 __d_rehash(target);
2832
Al Viro63cf4272014-09-26 23:06:14 -04002833 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002835 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002836 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837 dentry->d_parent = target->d_parent;
2838 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002839 list_del_init(&target->d_child);
2840 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002842 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002843 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002844 list_move(&target->d_child, &target->d_parent->d_subdirs);
2845 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002846 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002847 fsnotify_update_flags(target);
2848 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849 }
2850
Nick Piggin31e6b012011-01-07 17:49:52 +11002851 write_seqcount_end(&target->d_seq);
2852 write_seqcount_end(&dentry->d_seq);
2853
Al Viro84e710d2016-04-15 00:58:55 -04002854 if (dir)
2855 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002856 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002857}
2858
2859/*
2860 * d_move - move a dentry
2861 * @dentry: entry to move
2862 * @target: new dentry
2863 *
2864 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002865 * dcache entries should not be moved in this way. See the locking
2866 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002867 */
2868void d_move(struct dentry *dentry, struct dentry *target)
2869{
2870 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002871 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002873}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002874EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875
Miklos Szeredida1ce062014-04-01 17:08:43 +02002876/*
2877 * d_exchange - exchange two dentries
2878 * @dentry1: first dentry
2879 * @dentry2: second dentry
2880 */
2881void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2882{
2883 write_seqlock(&rename_lock);
2884
2885 WARN_ON(!dentry1->d_inode);
2886 WARN_ON(!dentry2->d_inode);
2887 WARN_ON(IS_ROOT(dentry1));
2888 WARN_ON(IS_ROOT(dentry2));
2889
2890 __d_move(dentry1, dentry2, true);
2891
2892 write_sequnlock(&rename_lock);
2893}
2894
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002895/**
2896 * d_ancestor - search for an ancestor
2897 * @p1: ancestor dentry
2898 * @p2: child dentry
2899 *
2900 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2901 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002902 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002903struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002904{
2905 struct dentry *p;
2906
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002907 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002908 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002909 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002911 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002912}
2913
2914/*
2915 * This helper attempts to cope with remotely renamed directories
2916 *
2917 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002918 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002919 *
2920 * Note: If ever the locking in lock_rename() changes, then please
2921 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002922 */
Al Virob5ae6b12014-10-12 22:16:02 -04002923static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002924 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002925{
Al Viro9902af72016-04-15 15:08:36 -04002926 struct mutex *m1 = NULL;
2927 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002928 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002929
2930 /* If alias and dentry share a parent, then no extra locks required */
2931 if (alias->d_parent == dentry->d_parent)
2932 goto out_unalias;
2933
Trond Myklebust9eaef272006-10-21 10:24:20 -07002934 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002935 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2936 goto out_err;
2937 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002938 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002939 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002940 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002941out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002942 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002943 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002944out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002945 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002946 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002947 if (m1)
2948 mutex_unlock(m1);
2949 return ret;
2950}
2951
David Howells770bfad2006-08-22 20:06:07 -04002952/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002953 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2954 * @inode: the inode which may have a disconnected dentry
2955 * @dentry: a negative dentry which we want to point to the inode.
2956 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002957 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2958 * place of the given dentry and return it, else simply d_add the inode
2959 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002960 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002961 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2962 * we should error out: directories can't have multiple aliases.
2963 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002964 * This is needed in the lookup routine of any filesystem that is exportable
2965 * (via knfsd) so that we can build dcache paths to directories effectively.
2966 *
2967 * If a dentry was found and moved, then it is returned. Otherwise NULL
2968 * is returned. This matches the expected return value of ->lookup.
2969 *
2970 * Cluster filesystems may call this function with a negative, hashed dentry.
2971 * In that case, we know that the inode will be a regular file, and also this
2972 * will only occur during atomic_open. So we need to check for the dentry
2973 * being already hashed only in the final case.
2974 */
2975struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2976{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002977 if (IS_ERR(inode))
2978 return ERR_CAST(inode);
2979
David Howells770bfad2006-08-22 20:06:07 -04002980 BUG_ON(!d_unhashed(dentry));
2981
Al Virode689f52016-03-09 18:05:42 -05002982 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002983 goto out;
Al Virode689f52016-03-09 18:05:42 -05002984
Al Virob9680912016-04-11 00:53:26 -04002985 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002986 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002987 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002988 struct dentry *new = __d_find_any_alias(inode);
2989 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002990 /* The reference to new ensures it remains an alias */
2991 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002992 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002993 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002994 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002995 dput(new);
2996 new = ERR_PTR(-ELOOP);
2997 pr_warn_ratelimited(
2998 "VFS: Lookup of '%s' in %s %s"
2999 " would have caused loop\n",
3000 dentry->d_name.name,
3001 inode->i_sb->s_type->name,
3002 inode->i_sb->s_id);
3003 } else if (!IS_ROOT(new)) {
3004 int err = __d_unalias(inode, dentry, new);
3005 write_sequnlock(&rename_lock);
3006 if (err) {
3007 dput(new);
3008 new = ERR_PTR(err);
3009 }
Al Viro18367502011-07-12 21:42:24 -04003010 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003011 __d_move(new, dentry, false);
3012 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003013 }
Al Virob5ae6b12014-10-12 22:16:02 -04003014 iput(inode);
3015 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003016 }
David Howells770bfad2006-08-22 20:06:07 -04003017 }
Al Virob5ae6b12014-10-12 22:16:02 -04003018out:
Al Viroed782b52016-03-09 19:52:39 -05003019 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003020 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003021}
Al Virob5ae6b12014-10-12 22:16:02 -04003022EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003023
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003024static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003025{
3026 *buflen -= namelen;
3027 if (*buflen < 0)
3028 return -ENAMETOOLONG;
3029 *buffer -= namelen;
3030 memcpy(*buffer, str, namelen);
3031 return 0;
3032}
3033
Waiman Long232d2d62013-09-09 12:18:13 -04003034/**
3035 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003036 * @buffer: buffer pointer
3037 * @buflen: allocated length of the buffer
3038 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003039 *
3040 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3041 * make sure that either the old or the new name pointer and length are
3042 * fetched. However, there may be mismatch between length and pointer.
3043 * The length cannot be trusted, we need to copy it byte-by-byte until
3044 * the length is reached or a null byte is found. It also prepends "/" at
3045 * the beginning of the name. The sequence number check at the caller will
3046 * retry it again when a d_move() does happen. So any garbage in the buffer
3047 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003048 *
3049 * Data dependency barrier is needed to make sure that we see that terminating
3050 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003051 */
Al Viro9aba36d2016-07-20 22:28:45 -04003052static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003053{
Waiman Long232d2d62013-09-09 12:18:13 -04003054 const char *dname = ACCESS_ONCE(name->name);
3055 u32 dlen = ACCESS_ONCE(name->len);
3056 char *p;
3057
Al Viro6d13f692014-09-29 14:46:30 -04003058 smp_read_barrier_depends();
3059
Waiman Long232d2d62013-09-09 12:18:13 -04003060 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003061 if (*buflen < 0)
3062 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003063 p = *buffer -= dlen + 1;
3064 *p++ = '/';
3065 while (dlen--) {
3066 char c = *dname++;
3067 if (!c)
3068 break;
3069 *p++ = c;
3070 }
3071 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003072}
3073
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003075 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003076 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003077 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003078 * @buffer: pointer to the end of the buffer
3079 * @buflen: pointer to buffer length
3080 *
Waiman Long18129972013-09-12 10:55:35 -04003081 * The function will first try to write out the pathname without taking any
3082 * lock other than the RCU read lock to make sure that dentries won't go away.
3083 * It only checks the sequence number of the global rename_lock as any change
3084 * in the dentry's d_seq will be preceded by changes in the rename_lock
3085 * sequence number. If the sequence number had been changed, it will restart
3086 * the whole pathname back-tracing sequence again by taking the rename_lock.
3087 * In this case, there is no need to take the RCU read lock as the recursive
3088 * parent pointer references will keep the dentry chain alive as long as no
3089 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003090 */
Al Viro02125a82011-12-05 08:43:34 -05003091static int prepend_path(const struct path *path,
3092 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003093 char **buffer, int *buflen)
3094{
Al Viroede4ceb2013-11-13 07:45:40 -05003095 struct dentry *dentry;
3096 struct vfsmount *vfsmnt;
3097 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003098 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003099 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003100 char *bptr;
3101 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003102
Al Viro48f5ec22013-09-09 15:22:25 -04003103 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003104restart_mnt:
3105 read_seqbegin_or_lock(&mount_lock, &m_seq);
3106 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003107 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003108restart:
3109 bptr = *buffer;
3110 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003111 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003112 dentry = path->dentry;
3113 vfsmnt = path->mnt;
3114 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003115 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003116 while (dentry != root->dentry || vfsmnt != root->mnt) {
3117 struct dentry * parent;
3118
3119 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003120 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003121 /* Escaped? */
3122 if (dentry != vfsmnt->mnt_root) {
3123 bptr = *buffer;
3124 blen = *buflen;
3125 error = 3;
3126 break;
3127 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003128 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003129 if (mnt != parent) {
3130 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3131 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003132 vfsmnt = &mnt->mnt;
3133 continue;
3134 }
Waiman Long232d2d62013-09-09 12:18:13 -04003135 if (!error)
3136 error = is_mounted(vfsmnt) ? 1 : 2;
3137 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003138 }
3139 parent = dentry->d_parent;
3140 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003141 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003142 if (error)
3143 break;
3144
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003145 dentry = parent;
3146 }
Al Viro48f5ec22013-09-09 15:22:25 -04003147 if (!(seq & 1))
3148 rcu_read_unlock();
3149 if (need_seqretry(&rename_lock, seq)) {
3150 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003151 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003152 }
Al Viro48f5ec22013-09-09 15:22:25 -04003153 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003154
3155 if (!(m_seq & 1))
3156 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003157 if (need_seqretry(&mount_lock, m_seq)) {
3158 m_seq = 1;
3159 goto restart_mnt;
3160 }
3161 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003162
Waiman Long232d2d62013-09-09 12:18:13 -04003163 if (error >= 0 && bptr == *buffer) {
3164 if (--blen < 0)
3165 error = -ENAMETOOLONG;
3166 else
3167 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168 }
Waiman Long232d2d62013-09-09 12:18:13 -04003169 *buffer = bptr;
3170 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003171 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003172}
3173
3174/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003175 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003176 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003177 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003178 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 * @buflen: buffer length
3180 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003181 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003183 * Returns a pointer into the buffer or an error code if the
3184 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003185 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003186 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003187 *
Al Viro02125a82011-12-05 08:43:34 -05003188 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189 */
Al Viro02125a82011-12-05 08:43:34 -05003190char *__d_path(const struct path *path,
3191 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003192 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003194 char *res = buf + buflen;
3195 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003197 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003198 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003199
Al Viro02125a82011-12-05 08:43:34 -05003200 if (error < 0)
3201 return ERR_PTR(error);
3202 if (error > 0)
3203 return NULL;
3204 return res;
3205}
3206
3207char *d_absolute_path(const struct path *path,
3208 char *buf, int buflen)
3209{
3210 struct path root = {};
3211 char *res = buf + buflen;
3212 int error;
3213
3214 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003215 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003216
3217 if (error > 1)
3218 error = -EINVAL;
3219 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003220 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003221 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222}
3223
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003224/*
3225 * same as __d_path but appends "(deleted)" for unlinked files.
3226 */
Al Viro02125a82011-12-05 08:43:34 -05003227static int path_with_deleted(const struct path *path,
3228 const struct path *root,
3229 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003230{
3231 prepend(buf, buflen, "\0", 1);
3232 if (d_unlinked(path->dentry)) {
3233 int error = prepend(buf, buflen, " (deleted)", 10);
3234 if (error)
3235 return error;
3236 }
3237
3238 return prepend_path(path, root, buf, buflen);
3239}
3240
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003241static int prepend_unreachable(char **buffer, int *buflen)
3242{
3243 return prepend(buffer, buflen, "(unreachable)", 13);
3244}
3245
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003246static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3247{
3248 unsigned seq;
3249
3250 do {
3251 seq = read_seqcount_begin(&fs->seq);
3252 *root = fs->root;
3253 } while (read_seqcount_retry(&fs->seq, seq));
3254}
3255
Jan Bluncka03a8a702008-02-14 19:38:32 -08003256/**
3257 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003258 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003259 * @buf: buffer to return value in
3260 * @buflen: buffer length
3261 *
3262 * Convert a dentry into an ASCII path name. If the entry has been deleted
3263 * the string " (deleted)" is appended. Note that this is ambiguous.
3264 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003265 * Returns a pointer into the buffer or an error code if the path was
3266 * too long. Note: Callers should use the returned pointer, not the passed
3267 * in buffer, to use the name! The implementation often starts at an offset
3268 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003269 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003270 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003271 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003272char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003274 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003275 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003276 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003278 /*
3279 * We have various synthetic filesystems that never get mounted. On
3280 * these filesystems dentries are never used for lookup purposes, and
3281 * thus don't need to be hashed. They also don't need a name until a
3282 * user wants to identify the object in /proc/pid/fd/. The little hack
3283 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003284 *
3285 * Some pseudo inodes are mountable. When they are mounted
3286 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3287 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003288 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003289 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3290 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003291 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003292
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003293 rcu_read_lock();
3294 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003295 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003296 rcu_read_unlock();
3297
Al Viro02125a82011-12-05 08:43:34 -05003298 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003299 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300 return res;
3301}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003302EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303
3304/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003305 * Helper function for dentry_operations.d_dname() members
3306 */
3307char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3308 const char *fmt, ...)
3309{
3310 va_list args;
3311 char temp[64];
3312 int sz;
3313
3314 va_start(args, fmt);
3315 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3316 va_end(args);
3317
3318 if (sz > sizeof(temp) || sz > buflen)
3319 return ERR_PTR(-ENAMETOOLONG);
3320
3321 buffer += buflen - sz;
3322 return memcpy(buffer, temp, sz);
3323}
3324
Al Viro118b2302013-08-24 12:08:17 -04003325char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3326{
3327 char *end = buffer + buflen;
3328 /* these dentries are never renamed, so d_lock is not needed */
3329 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003330 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003331 prepend(&end, &buflen, "/", 1))
3332 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003333 return end;
Al Viro118b2302013-08-24 12:08:17 -04003334}
David Herrmann31bbe162014-01-03 14:09:47 +01003335EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003336
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003337/*
Ram Pai6092d042008-03-27 13:06:20 +01003338 * Write full pathname from the root of the filesystem into the buffer.
3339 */
Al Virof6500802014-01-26 12:37:55 -05003340static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003341{
Al Virof6500802014-01-26 12:37:55 -05003342 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003343 char *end, *retval;
3344 int len, seq = 0;
3345 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003346
Al Virof6500802014-01-26 12:37:55 -05003347 if (buflen < 2)
3348 goto Elong;
3349
Al Viro48f5ec22013-09-09 15:22:25 -04003350 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003351restart:
Al Virof6500802014-01-26 12:37:55 -05003352 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003353 end = buf + buflen;
3354 len = buflen;
3355 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003356 /* Get '/' right */
3357 retval = end-1;
3358 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003359 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003360 while (!IS_ROOT(dentry)) {
3361 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003362
Ram Pai6092d042008-03-27 13:06:20 +01003363 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003364 error = prepend_name(&end, &len, &dentry->d_name);
3365 if (error)
3366 break;
Ram Pai6092d042008-03-27 13:06:20 +01003367
3368 retval = end;
3369 dentry = parent;
3370 }
Al Viro48f5ec22013-09-09 15:22:25 -04003371 if (!(seq & 1))
3372 rcu_read_unlock();
3373 if (need_seqretry(&rename_lock, seq)) {
3374 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003375 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003376 }
3377 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003378 if (error)
3379 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003380 return retval;
3381Elong:
3382 return ERR_PTR(-ENAMETOOLONG);
3383}
Nick Pigginec2447c2011-01-07 17:49:29 +11003384
3385char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3386{
Waiman Long232d2d62013-09-09 12:18:13 -04003387 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003388}
3389EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003390
3391char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3392{
3393 char *p = NULL;
3394 char *retval;
3395
Al Viroc1031352010-06-06 22:31:14 -04003396 if (d_unlinked(dentry)) {
3397 p = buf + buflen;
3398 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3399 goto Elong;
3400 buflen++;
3401 }
3402 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003403 if (!IS_ERR(retval) && p)
3404 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003405 return retval;
3406Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003407 return ERR_PTR(-ENAMETOOLONG);
3408}
3409
Linus Torvalds8b19e342013-09-12 10:35:47 -07003410static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3411 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003412{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003413 unsigned seq;
3414
3415 do {
3416 seq = read_seqcount_begin(&fs->seq);
3417 *root = fs->root;
3418 *pwd = fs->pwd;
3419 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003420}
3421
Ram Pai6092d042008-03-27 13:06:20 +01003422/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003423 * NOTE! The user-level library version returns a
3424 * character pointer. The kernel system call just
3425 * returns the length of the buffer filled (which
3426 * includes the ending '\0' character), or a negative
3427 * error value. So libc would do something like
3428 *
3429 * char *getcwd(char * buf, size_t size)
3430 * {
3431 * int retval;
3432 *
3433 * retval = sys_getcwd(buf, size);
3434 * if (retval >= 0)
3435 * return buf;
3436 * errno = -retval;
3437 * return NULL;
3438 * }
3439 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003440SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441{
Linus Torvalds552ce542007-02-13 12:08:18 -08003442 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003443 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003444 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003445
3446 if (!page)
3447 return -ENOMEM;
3448
Linus Torvalds8b19e342013-09-12 10:35:47 -07003449 rcu_read_lock();
3450 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451
Linus Torvalds552ce542007-02-13 12:08:18 -08003452 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003453 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003454 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003455 char *cwd = page + PATH_MAX;
3456 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003458 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003459 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003460 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003461
Al Viro02125a82011-12-05 08:43:34 -05003462 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003463 goto out;
3464
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003465 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003466 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003467 error = prepend_unreachable(&cwd, &buflen);
3468 if (error)
3469 goto out;
3470 }
3471
Linus Torvalds552ce542007-02-13 12:08:18 -08003472 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003473 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003474 if (len <= size) {
3475 error = len;
3476 if (copy_to_user(buf, cwd, len))
3477 error = -EFAULT;
3478 }
Nick Piggin949854d2011-01-07 17:49:37 +11003479 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003480 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003481 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003482
3483out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003484 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 return error;
3486}
3487
3488/*
3489 * Test whether new_dentry is a subdirectory of old_dentry.
3490 *
3491 * Trivially implemented using the dcache structure
3492 */
3493
3494/**
3495 * is_subdir - is new dentry a subdirectory of old_dentry
3496 * @new_dentry: new dentry
3497 * @old_dentry: old dentry
3498 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003499 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3500 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3502 */
3503
Yaowei Baia6e57872015-11-17 14:40:11 +08003504bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505{
Yaowei Baia6e57872015-11-17 14:40:11 +08003506 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003507 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003508
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003509 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003510 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003511
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003512 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003515 /*
3516 * Need rcu_readlock to protect against the d_parent trashing
3517 * due to d_move
3518 */
3519 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003520 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003521 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003522 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003523 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003524 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526
3527 return result;
3528}
3529
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003530static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003532 struct dentry *root = data;
3533 if (dentry != root) {
3534 if (d_unhashed(dentry) || !dentry->d_inode)
3535 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003537 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3538 dentry->d_flags |= DCACHE_GENOCIDE;
3539 dentry->d_lockref.count--;
3540 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003541 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003542 return D_WALK_CONTINUE;
3543}
Nick Piggin58db63d2011-01-07 17:49:39 +11003544
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003545void d_genocide(struct dentry *parent)
3546{
3547 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548}
3549
Al Viro60545d02013-06-07 01:20:27 -04003550void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551{
Al Viro60545d02013-06-07 01:20:27 -04003552 inode_dec_link_count(inode);
3553 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003554 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003555 !d_unlinked(dentry));
3556 spin_lock(&dentry->d_parent->d_lock);
3557 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3558 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3559 (unsigned long long)inode->i_ino);
3560 spin_unlock(&dentry->d_lock);
3561 spin_unlock(&dentry->d_parent->d_lock);
3562 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563}
Al Viro60545d02013-06-07 01:20:27 -04003564EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565
3566static __initdata unsigned long dhash_entries;
3567static int __init set_dhash_entries(char *str)
3568{
3569 if (!str)
3570 return 0;
3571 dhash_entries = simple_strtoul(str, &str, 0);
3572 return 1;
3573}
3574__setup("dhash_entries=", set_dhash_entries);
3575
3576static void __init dcache_init_early(void)
3577{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003578 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003579
3580 /* If hashes are distributed across NUMA nodes, defer
3581 * hash allocation until vmalloc space is available.
3582 */
3583 if (hashdist)
3584 return;
3585
3586 dentry_hashtable =
3587 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003588 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 dhash_entries,
3590 13,
3591 HASH_EARLY,
3592 &d_hash_shift,
3593 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003594 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003595 0);
3596
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003597 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003598 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003599}
3600
Denis Cheng74bf17c2007-10-16 23:26:30 -07003601static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003603 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604
3605 /*
3606 * A constructor could be added for stable state like the lists,
3607 * but it is probably not worth it because of the cache nature
3608 * of the dcache.
3609 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003610 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003611 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612
3613 /* Hash may have been set up in dcache_init_early */
3614 if (!hashdist)
3615 return;
3616
3617 dentry_hashtable =
3618 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003619 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003620 dhash_entries,
3621 13,
3622 0,
3623 &d_hash_shift,
3624 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003625 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003626 0);
3627
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003628 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003629 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630}
3631
3632/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003633struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003634EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003635
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636EXPORT_SYMBOL(d_genocide);
3637
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638void __init vfs_caches_init_early(void)
3639{
3640 dcache_init_early();
3641 inode_init_early();
3642}
3643
Mel Gorman4248b0d2015-08-06 15:46:20 -07003644void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003645{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003647 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003648
Denis Cheng74bf17c2007-10-16 23:26:30 -07003649 dcache_init();
3650 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003651 files_init();
3652 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003653 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654 bdev_cache_init();
3655 chrdev_init();
3656}