blob: b85da8897ffacbd62fd2531f981c01ed2202f518 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
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 Torvalds6326c71f2012-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
David Howells4bf46a22015-03-05 14:09:22 +0000280static inline void __d_set_inode_and_type(struct dentry *dentry,
281 struct inode *inode,
282 unsigned type_flags)
283{
284 unsigned flags;
285
286 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000287 flags = READ_ONCE(dentry->d_flags);
288 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
289 flags |= type_flags;
290 WRITE_ONCE(dentry->d_flags, flags);
291}
292
David Howells4bf46a22015-03-05 14:09:22 +0000293static inline void __d_clear_type_and_inode(struct dentry *dentry)
294{
295 unsigned flags = READ_ONCE(dentry->d_flags);
296
297 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
298 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000299 dentry->d_inode = NULL;
300}
301
Al Virob4f03542014-04-29 23:40:14 -0400302static void dentry_free(struct dentry *dentry)
303{
Al Viro946e51f2014-10-26 19:19:16 -0400304 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400305 if (unlikely(dname_external(dentry))) {
306 struct external_name *p = external_name(dentry);
307 if (likely(atomic_dec_and_test(&p->u.count))) {
308 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
309 return;
310 }
311 }
Al Virob4f03542014-04-29 23:40:14 -0400312 /* if dentry was never visible to RCU, immediate free is OK */
313 if (!(dentry->d_flags & DCACHE_RCUACCESS))
314 __d_free(&dentry->d_u.d_rcu);
315 else
316 call_rcu(&dentry->d_u.d_rcu, __d_free);
317}
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319/*
320 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400321 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100322 */
323static void dentry_unlink_inode(struct dentry * dentry)
324 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100325 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100326{
327 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400328 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500329
Al Viro550dce02016-05-29 20:13:30 -0400330 if (hashed)
331 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000332 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400333 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400334 if (hashed)
335 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100336 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100337 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100338 if (!inode->i_nlink)
339 fsnotify_inoderemove(inode);
340 if (dentry->d_op && dentry->d_op->d_iput)
341 dentry->d_op->d_iput(dentry, inode);
342 else
343 iput(inode);
344}
345
346/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400347 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
348 * is in use - which includes both the "real" per-superblock
349 * LRU list _and_ the DCACHE_SHRINK_LIST use.
350 *
351 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
352 * on the shrink list (ie not on the superblock LRU list).
353 *
354 * The per-cpu "nr_dentry_unused" counters are updated with
355 * the DCACHE_LRU_LIST bit.
356 *
357 * These helper functions make sure we always follow the
358 * rules. d_lock must be held by the caller.
359 */
360#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
361static void d_lru_add(struct dentry *dentry)
362{
363 D_FLAG_VERIFY(dentry, 0);
364 dentry->d_flags |= DCACHE_LRU_LIST;
365 this_cpu_inc(nr_dentry_unused);
366 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
367}
368
369static void d_lru_del(struct dentry *dentry)
370{
371 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
372 dentry->d_flags &= ~DCACHE_LRU_LIST;
373 this_cpu_dec(nr_dentry_unused);
374 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
375}
376
377static void d_shrink_del(struct dentry *dentry)
378{
379 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
380 list_del_init(&dentry->d_lru);
381 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
382 this_cpu_dec(nr_dentry_unused);
383}
384
385static void d_shrink_add(struct dentry *dentry, struct list_head *list)
386{
387 D_FLAG_VERIFY(dentry, 0);
388 list_add(&dentry->d_lru, list);
389 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
390 this_cpu_inc(nr_dentry_unused);
391}
392
393/*
394 * These can only be called under the global LRU lock, ie during the
395 * callback for freeing the LRU list. "isolate" removes it from the
396 * LRU lists entirely, while shrink_move moves it to the indicated
397 * private list.
398 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800399static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400400{
401 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
402 dentry->d_flags &= ~DCACHE_LRU_LIST;
403 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800404 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400405}
406
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800407static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
408 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400409{
410 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
411 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800412 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400413}
414
415/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000416 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700417 */
418static void dentry_lru_add(struct dentry *dentry)
419{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400420 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
421 d_lru_add(dentry);
Josef Bacik563f4002017-04-18 16:04:17 -0400422 else if (unlikely(!(dentry->d_flags & DCACHE_REFERENCED)))
423 dentry->d_flags |= DCACHE_REFERENCED;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700424}
425
Miklos Szeredid52b9082007-05-08 00:23:46 -0700426/**
Nick Piggin789680d2011-01-07 17:49:30 +1100427 * d_drop - drop a dentry
428 * @dentry: dentry to drop
429 *
430 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
431 * be found through a VFS lookup any more. Note that this is different from
432 * deleting the dentry - d_delete will try to mark the dentry negative if
433 * possible, giving a successful _negative_ lookup, while d_drop will
434 * just make the cache lookup fail.
435 *
436 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
437 * reason (NFS timeouts or autofs deletes).
438 *
439 * __d_drop requires dentry->d_lock.
440 */
441void __d_drop(struct dentry *dentry)
442{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700443 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400444 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400445 /*
446 * Hashed dentries are normally on the dentry hashtable,
447 * with the exception of those newly allocated by
448 * d_obtain_alias, which are always IS_ROOT:
449 */
450 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400451 b = &dentry->d_sb->s_anon;
452 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700453 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400454
455 hlist_bl_lock(b);
456 __hlist_bl_del(&dentry->d_hash);
457 dentry->d_hash.pprev = NULL;
458 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400459 /* After this call, in-progress rcu-walk path lookup will fail. */
460 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100461 }
462}
463EXPORT_SYMBOL(__d_drop);
464
465void d_drop(struct dentry *dentry)
466{
Nick Piggin789680d2011-01-07 17:49:30 +1100467 spin_lock(&dentry->d_lock);
468 __d_drop(dentry);
469 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100470}
471EXPORT_SYMBOL(d_drop);
472
Al Viroba65dc52016-06-10 11:32:47 -0400473static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
474{
475 struct dentry *next;
476 /*
477 * Inform d_walk() and shrink_dentry_list() that we are no longer
478 * attached to the dentry tree
479 */
480 dentry->d_flags |= DCACHE_DENTRY_KILLED;
481 if (unlikely(list_empty(&dentry->d_child)))
482 return;
483 __list_del_entry(&dentry->d_child);
484 /*
485 * Cursors can move around the list of children. While we'd been
486 * a normal list member, it didn't matter - ->d_child.next would've
487 * been updated. However, from now on it won't be and for the
488 * things like d_walk() it might end up with a nasty surprise.
489 * Normally d_walk() doesn't care about cursors moving around -
490 * ->d_lock on parent prevents that and since a cursor has no children
491 * of its own, we get through it without ever unlocking the parent.
492 * There is one exception, though - if we ascend from a child that
493 * gets killed as soon as we unlock it, the next sibling is found
494 * using the value left in its ->d_child.next. And if _that_
495 * pointed to a cursor, and cursor got moved (e.g. by lseek())
496 * before d_walk() regains parent->d_lock, we'll end up skipping
497 * everything the cursor had been moved past.
498 *
499 * Solution: make sure that the pointer left behind in ->d_child.next
500 * points to something that won't be moving around. I.e. skip the
501 * cursors.
502 */
503 while (dentry->d_child.next != &parent->d_subdirs) {
504 next = list_entry(dentry->d_child.next, struct dentry, d_child);
505 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
506 break;
507 dentry->d_child.next = next->d_child.next;
508 }
509}
510
Al Viroe55fd012014-05-28 13:51:12 -0400511static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100512{
Al Viro41edf2782014-05-01 10:30:00 -0400513 struct dentry *parent = NULL;
514 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400515 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100516 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100517
Linus Torvalds0d984392013-09-08 13:46:52 -0700518 /*
519 * The dentry is now unrecoverably dead to the world.
520 */
521 lockref_mark_dead(&dentry->d_lockref);
522
Sage Weilf0023bc2011-10-28 10:02:42 -0700523 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700524 * inform the fs via d_prune that this dentry is about to be
525 * unhashed and destroyed.
526 */
Al Viro29266202014-05-30 11:39:02 -0400527 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800528 dentry->d_op->d_prune(dentry);
529
Al Viro01b60352014-04-29 23:42:52 -0400530 if (dentry->d_flags & DCACHE_LRU_LIST) {
531 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
532 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400533 }
Nick Piggin77812a12011-01-07 17:49:48 +1100534 /* if it was on the hash then remove it */
535 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400536 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400537 if (parent)
538 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400539 if (dentry->d_inode)
540 dentry_unlink_inode(dentry);
541 else
542 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400543 this_cpu_dec(nr_dentry);
544 if (dentry->d_op && dentry->d_op->d_release)
545 dentry->d_op->d_release(dentry);
546
Al Viro41edf2782014-05-01 10:30:00 -0400547 spin_lock(&dentry->d_lock);
548 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
549 dentry->d_flags |= DCACHE_MAY_FREE;
550 can_free = false;
551 }
552 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400553 if (likely(can_free))
554 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400555}
556
557/*
558 * Finish off a dentry we've decided to kill.
559 * dentry->d_lock must be held, returns with it unlocked.
560 * If ref is non-zero, then decrement the refcount too.
561 * Returns dentry requiring refcount drop, or NULL if we're done.
562 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400563static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400564 __releases(dentry->d_lock)
565{
566 struct inode *inode = dentry->d_inode;
567 struct dentry *parent = NULL;
568
569 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
570 goto failed;
571
572 if (!IS_ROOT(dentry)) {
573 parent = dentry->d_parent;
574 if (unlikely(!spin_trylock(&parent->d_lock))) {
575 if (inode)
576 spin_unlock(&inode->i_lock);
577 goto failed;
578 }
579 }
580
581 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400582 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400583
584failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400585 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400586 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100587}
588
Al Viro046b9612014-05-29 08:54:52 -0400589static inline struct dentry *lock_parent(struct dentry *dentry)
590{
591 struct dentry *parent = dentry->d_parent;
592 if (IS_ROOT(dentry))
593 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800594 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400595 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400596 if (likely(spin_trylock(&parent->d_lock)))
597 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400598 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400599 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400600again:
601 parent = ACCESS_ONCE(dentry->d_parent);
602 spin_lock(&parent->d_lock);
603 /*
604 * We can't blindly lock dentry until we are sure
605 * that we won't violate the locking order.
606 * Any changes of dentry->d_parent must have
607 * been done with parent->d_lock held, so
608 * spin_lock() above is enough of a barrier
609 * for checking if it's still our child.
610 */
611 if (unlikely(parent != dentry->d_parent)) {
612 spin_unlock(&parent->d_lock);
613 goto again;
614 }
615 rcu_read_unlock();
616 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700617 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400618 else
619 parent = NULL;
620 return parent;
621}
622
Linus Torvalds360f5472015-01-09 15:19:03 -0800623/*
624 * Try to do a lockless dput(), and return whether that was successful.
625 *
626 * If unsuccessful, we return false, having already taken the dentry lock.
627 *
628 * The caller needs to hold the RCU read lock, so that the dentry is
629 * guaranteed to stay around even if the refcount goes down to zero!
630 */
631static inline bool fast_dput(struct dentry *dentry)
632{
633 int ret;
634 unsigned int d_flags;
635
636 /*
637 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100638 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800639 */
640 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
641 return lockref_put_or_lock(&dentry->d_lockref);
642
643 /*
644 * .. otherwise, we can try to just decrement the
645 * lockref optimistically.
646 */
647 ret = lockref_put_return(&dentry->d_lockref);
648
649 /*
650 * If the lockref_put_return() failed due to the lock being held
651 * by somebody else, the fast path has failed. We will need to
652 * get the lock, and then check the count again.
653 */
654 if (unlikely(ret < 0)) {
655 spin_lock(&dentry->d_lock);
656 if (dentry->d_lockref.count > 1) {
657 dentry->d_lockref.count--;
658 spin_unlock(&dentry->d_lock);
659 return 1;
660 }
661 return 0;
662 }
663
664 /*
665 * If we weren't the last ref, we're done.
666 */
667 if (ret)
668 return 1;
669
670 /*
671 * Careful, careful. The reference count went down
672 * to zero, but we don't hold the dentry lock, so
673 * somebody else could get it again, and do another
674 * dput(), and we need to not race with that.
675 *
676 * However, there is a very special and common case
677 * where we don't care, because there is nothing to
678 * do: the dentry is still hashed, it does not have
679 * a 'delete' op, and it's referenced and already on
680 * the LRU list.
681 *
682 * NOTE! Since we aren't locked, these values are
683 * not "stable". However, it is sufficient that at
684 * some point after we dropped the reference the
685 * dentry was hashed and the flags had the proper
686 * value. Other dentry users may have re-gotten
687 * a reference to the dentry and change that, but
688 * our work is done - we can leave the dentry
689 * around with a zero refcount.
690 */
691 smp_rmb();
692 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100693 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800694
695 /* Nothing to do? Dropping the reference was all we needed? */
696 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
697 return 1;
698
699 /*
700 * Not the fast normal case? Get the lock. We've already decremented
701 * the refcount, but we'll need to re-check the situation after
702 * getting the lock.
703 */
704 spin_lock(&dentry->d_lock);
705
706 /*
707 * Did somebody else grab a reference to it in the meantime, and
708 * we're no longer the last user after all? Alternatively, somebody
709 * else could have killed it and marked it dead. Either way, we
710 * don't need to do anything else.
711 */
712 if (dentry->d_lockref.count) {
713 spin_unlock(&dentry->d_lock);
714 return 1;
715 }
716
717 /*
718 * Re-get the reference we optimistically dropped. We hold the
719 * lock, and we just tested that it was zero, so we can just
720 * set it to 1.
721 */
722 dentry->d_lockref.count = 1;
723 return 0;
724}
725
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/*
728 * This is dput
729 *
730 * This is complicated by the fact that we do not want to put
731 * dentries that are no longer on any hash chain on the unused
732 * list: we'd much rather just get rid of them immediately.
733 *
734 * However, that implies that we have to traverse the dentry
735 * tree upwards to the parents which might _also_ now be
736 * scheduled for deletion (it may have been only waiting for
737 * its last child to go away).
738 *
739 * This tail recursion is done by hand as we don't want to depend
740 * on the compiler to always get this right (gcc generally doesn't).
741 * Real recursion would eat up our stack space.
742 */
743
744/*
745 * dput - release a dentry
746 * @dentry: dentry to release
747 *
748 * Release a dentry. This will drop the usage count and if appropriate
749 * call the dentry unlink method as well as removing it from the queues and
750 * releasing its resources. If the parent dentries were scheduled for release
751 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753void dput(struct dentry *dentry)
754{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700755 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return;
757
758repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800759 might_sleep();
760
Linus Torvalds360f5472015-01-09 15:19:03 -0800761 rcu_read_lock();
762 if (likely(fast_dput(dentry))) {
763 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800765 }
766
767 /* Slow case: now with the dentry lock held */
768 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Al Viro85c7f812016-04-14 19:52:13 -0400770 WARN_ON(d_in_lookup(dentry));
771
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700772 /* Unreachable? Get rid of it */
773 if (unlikely(d_unhashed(dentry)))
774 goto kill_it;
775
Al Viro75a6f822015-07-08 02:42:38 +0100776 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
777 goto kill_it;
778
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700779 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100781 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 }
Nick Piggin265ac902010-10-10 05:36:24 -0400783
Christoph Hellwiga4633352010-10-10 05:36:26 -0400784 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400785
Waiman Long98474232013-08-28 18:24:59 -0700786 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100787 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return;
789
Miklos Szeredid52b9082007-05-08 00:23:46 -0700790kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400791 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800792 if (dentry) {
793 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700794 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700797EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100800/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100801static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
Waiman Long98474232013-08-28 18:24:59 -0700803 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
Nick Piggindc0474b2011-01-07 17:49:43 +1100806static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100807{
Waiman Long98474232013-08-28 18:24:59 -0700808 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100809}
810
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100811struct dentry *dget_parent(struct dentry *dentry)
812{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700813 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100814 struct dentry *ret;
815
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700816 /*
817 * Do optimistic parent lookup without any
818 * locking.
819 */
820 rcu_read_lock();
821 ret = ACCESS_ONCE(dentry->d_parent);
822 gotref = lockref_get_not_zero(&ret->d_lockref);
823 rcu_read_unlock();
824 if (likely(gotref)) {
825 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
826 return ret;
827 dput(ret);
828 }
829
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100830repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100831 /*
832 * Don't need rcu_dereference because we re-check it was correct under
833 * the lock.
834 */
835 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100836 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100837 spin_lock(&ret->d_lock);
838 if (unlikely(ret != dentry->d_parent)) {
839 spin_unlock(&ret->d_lock);
840 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100841 goto repeat;
842 }
Nick Piggina734eb42011-01-07 17:49:44 +1100843 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700844 BUG_ON(!ret->d_lockref.count);
845 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100846 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100847 return ret;
848}
849EXPORT_SYMBOL(dget_parent);
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851/**
852 * d_find_alias - grab a hashed alias of inode
853 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 *
855 * If inode has a hashed alias, or is a directory and has any alias,
856 * acquire the reference to alias and return it. Otherwise return NULL.
857 * Notice that if inode is a directory there can be only one alias and
858 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800859 * of a filesystem, or if the directory was renamed and d_revalidate
860 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700862 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500863 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500865static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Nick Pigginda502952011-01-07 17:49:33 +1100867 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Nick Pigginda502952011-01-07 17:49:33 +1100869again:
870 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400871 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100872 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700874 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100875 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500877 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100878 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100879 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 return alias;
881 }
882 }
Nick Pigginda502952011-01-07 17:49:33 +1100883 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 }
Nick Pigginda502952011-01-07 17:49:33 +1100885 if (discon_alias) {
886 alias = discon_alias;
887 spin_lock(&alias->d_lock);
888 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500889 __dget_dlock(alias);
890 spin_unlock(&alias->d_lock);
891 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100892 }
893 spin_unlock(&alias->d_lock);
894 goto again;
895 }
896 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897}
898
Nick Pigginda502952011-01-07 17:49:33 +1100899struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900{
David Howells214fda12006-03-25 03:06:36 -0800901 struct dentry *de = NULL;
902
Al Virob3d9b7a2012-06-09 13:51:19 -0400903 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100904 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500905 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100906 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800907 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 return de;
909}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700910EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912/*
913 * Try to kill dentries associated with this inode.
914 * WARNING: you must own a reference to inode.
915 */
916void d_prune_aliases(struct inode *inode)
917{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700918 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100920 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400921 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700923 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400924 struct dentry *parent = lock_parent(dentry);
925 if (likely(!dentry->d_lockref.count)) {
926 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800927 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400928 goto restart;
929 }
930 if (parent)
931 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 }
933 spin_unlock(&dentry->d_lock);
934 }
Nick Piggin873feea2011-01-07 17:50:06 +1100935 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700937EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400939static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
Al Viro5c47e6d2014-04-29 16:13:18 -0400941 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700942
Miklos Szeredi60942f22014-05-02 15:38:39 -0400943 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400944 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400945 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100946 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400947 parent = lock_parent(dentry);
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000950 * The dispose list is isolated and dentries are not accounted
951 * to the LRU here, so we can simply remove it from the list
952 * here regardless of whether it is referenced or not.
953 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400954 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000955
956 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000958 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800960 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700961 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400962 if (parent)
963 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 continue;
965 }
Nick Piggin77812a12011-01-07 17:49:48 +1100966
Al Viro64fd72e2014-05-28 09:48:44 -0400967
968 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
969 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
970 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400971 if (parent)
972 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400973 if (can_free)
974 dentry_free(dentry);
975 continue;
976 }
977
Al Viroff2fde92014-05-28 13:59:13 -0400978 inode = dentry->d_inode;
979 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400980 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000981 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400982 if (parent)
983 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400984 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000985 }
Al Viroff2fde92014-05-28 13:59:13 -0400986
Al Viroff2fde92014-05-28 13:59:13 -0400987 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400988
Al Viro5c47e6d2014-04-29 16:13:18 -0400989 /*
990 * We need to prune ancestors too. This is necessary to prevent
991 * quadratic behavior of shrink_dcache_parent(), but is also
992 * expected to be beneficial in reducing dentry cache
993 * fragmentation.
994 */
995 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400996 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
997 parent = lock_parent(dentry);
998 if (dentry->d_lockref.count != 1) {
999 dentry->d_lockref.count--;
1000 spin_unlock(&dentry->d_lock);
1001 if (parent)
1002 spin_unlock(&parent->d_lock);
1003 break;
1004 }
1005 inode = dentry->d_inode; /* can't be NULL */
1006 if (unlikely(!spin_trylock(&inode->i_lock))) {
1007 spin_unlock(&dentry->d_lock);
1008 if (parent)
1009 spin_unlock(&parent->d_lock);
1010 cpu_relax();
1011 continue;
1012 }
1013 __dentry_kill(dentry);
1014 dentry = parent;
1015 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001017}
1018
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001019static enum lru_status dentry_lru_isolate(struct list_head *item,
1020 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001021{
1022 struct list_head *freeable = arg;
1023 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1024
1025
1026 /*
1027 * we are inverting the lru lock/dentry->d_lock here,
1028 * so use a trylock. If we fail to get the lock, just skip
1029 * it
1030 */
1031 if (!spin_trylock(&dentry->d_lock))
1032 return LRU_SKIP;
1033
1034 /*
1035 * Referenced dentries are still in use. If they have active
1036 * counts, just remove them from the LRU. Otherwise give them
1037 * another pass through the LRU.
1038 */
1039 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001040 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001041 spin_unlock(&dentry->d_lock);
1042 return LRU_REMOVED;
1043 }
1044
1045 if (dentry->d_flags & DCACHE_REFERENCED) {
1046 dentry->d_flags &= ~DCACHE_REFERENCED;
1047 spin_unlock(&dentry->d_lock);
1048
1049 /*
1050 * The list move itself will be made by the common LRU code. At
1051 * this point, we've dropped the dentry->d_lock but keep the
1052 * lru lock. This is safe to do, since every list movement is
1053 * protected by the lru lock even if both locks are held.
1054 *
1055 * This is guaranteed by the fact that all LRU management
1056 * functions are intermediated by the LRU API calls like
1057 * list_lru_add and list_lru_del. List movement in this file
1058 * only ever occur through this functions or through callbacks
1059 * like this one, that are called from the LRU API.
1060 *
1061 * The only exceptions to this are functions like
1062 * shrink_dentry_list, and code that first checks for the
1063 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1064 * operating only with stack provided lists after they are
1065 * properly isolated from the main list. It is thus, always a
1066 * local access.
1067 */
1068 return LRU_ROTATE;
1069 }
1070
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001071 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001072 spin_unlock(&dentry->d_lock);
1073
1074 return LRU_REMOVED;
1075}
1076
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001077/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001078 * prune_dcache_sb - shrink the dcache
1079 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001080 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001081 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001082 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1083 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001084 * function.
1085 *
1086 * This function may fail to free any resources if all the dentries are in
1087 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001088 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001089long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001090{
Dave Chinnerf6041562013-08-28 10:18:00 +10001091 LIST_HEAD(dispose);
1092 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093
Vladimir Davydov503c3582015-02-12 14:58:47 -08001094 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1095 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001096 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001097 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
1099
Glauber Costa4e717f52013-08-28 10:18:03 +10001100static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001101 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001102{
Glauber Costa4e717f52013-08-28 10:18:03 +10001103 struct list_head *freeable = arg;
1104 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001105
Glauber Costa4e717f52013-08-28 10:18:03 +10001106 /*
1107 * we are inverting the lru lock/dentry->d_lock here,
1108 * so use a trylock. If we fail to get the lock, just skip
1109 * it
1110 */
1111 if (!spin_trylock(&dentry->d_lock))
1112 return LRU_SKIP;
1113
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001114 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001115 spin_unlock(&dentry->d_lock);
1116
1117 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001118}
1119
Glauber Costa4e717f52013-08-28 10:18:03 +10001120
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001121/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 * shrink_dcache_sb - shrink dcache for a superblock
1123 * @sb: superblock
1124 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001125 * Shrink the dcache for the specified super block. This is used to free
1126 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129{
Glauber Costa4e717f52013-08-28 10:18:03 +10001130 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001131
Glauber Costa4e717f52013-08-28 10:18:03 +10001132 do {
1133 LIST_HEAD(dispose);
1134
1135 freed = list_lru_walk(&sb->s_dentry_lru,
1136 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1137
1138 this_cpu_sub(nr_dentry_unused, freed);
1139 shrink_dentry_list(&dispose);
1140 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001142EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001145 * enum d_walk_ret - action to talke during tree walk
1146 * @D_WALK_CONTINUE: contrinue walk
1147 * @D_WALK_QUIT: quit walk
1148 * @D_WALK_NORETRY: quit when retry is needed
1149 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001151enum d_walk_ret {
1152 D_WALK_CONTINUE,
1153 D_WALK_QUIT,
1154 D_WALK_NORETRY,
1155 D_WALK_SKIP,
1156};
1157
1158/**
1159 * d_walk - walk the dentry tree
1160 * @parent: start of walk
1161 * @data: data passed to @enter() and @finish()
1162 * @enter: callback when first entering the dentry
1163 * @finish: callback when successfully finished the walk
1164 *
1165 * The @enter() and @finish() callbacks are called with d_lock held.
1166 */
1167static void d_walk(struct dentry *parent, void *data,
1168 enum d_walk_ret (*enter)(void *, struct dentry *),
1169 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
Nick Piggin949854d2011-01-07 17:49:37 +11001171 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001173 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001174 enum d_walk_ret ret;
1175 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001176
Nick Piggin58db63d2011-01-07 17:49:39 +11001177again:
Al Viro48f5ec22013-09-09 15:22:25 -04001178 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001179 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001180 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001181
1182 ret = enter(data, this_parent);
1183 switch (ret) {
1184 case D_WALK_CONTINUE:
1185 break;
1186 case D_WALK_QUIT:
1187 case D_WALK_SKIP:
1188 goto out_unlock;
1189 case D_WALK_NORETRY:
1190 retry = false;
1191 break;
1192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193repeat:
1194 next = this_parent->d_subdirs.next;
1195resume:
1196 while (next != &this_parent->d_subdirs) {
1197 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001198 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001200
Al Viroba65dc52016-06-10 11:32:47 -04001201 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1202 continue;
1203
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001204 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001205
1206 ret = enter(data, dentry);
1207 switch (ret) {
1208 case D_WALK_CONTINUE:
1209 break;
1210 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001211 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001212 goto out_unlock;
1213 case D_WALK_NORETRY:
1214 retry = false;
1215 break;
1216 case D_WALK_SKIP:
1217 spin_unlock(&dentry->d_lock);
1218 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001219 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001222 spin_unlock(&this_parent->d_lock);
1223 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001225 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 goto repeat;
1227 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001228 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230 /*
1231 * All done at this level ... ascend and resume the search.
1232 */
Al Viroca5358e2014-10-26 19:31:10 -04001233 rcu_read_lock();
1234ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001236 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001237 this_parent = child->d_parent;
1238
Al Viro31dec132013-10-25 17:04:27 -04001239 spin_unlock(&child->d_lock);
1240 spin_lock(&this_parent->d_lock);
1241
Al Viroca5358e2014-10-26 19:31:10 -04001242 /* might go back up the wrong parent if we have had a rename. */
1243 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001244 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001245 /* go into the first sibling still alive */
1246 do {
1247 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001248 if (next == &this_parent->d_subdirs)
1249 goto ascend;
1250 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001251 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001252 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 goto resume;
1254 }
Al Viroca5358e2014-10-26 19:31:10 -04001255 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001257 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001258 if (finish)
1259 finish(data);
1260
1261out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001262 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001263 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001264 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001265
1266rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001267 spin_unlock(&this_parent->d_lock);
1268 rcu_read_unlock();
1269 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001270 if (!retry)
1271 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001272 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001273 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001275
Ian Kent01619492016-11-24 08:03:41 +11001276struct check_mount {
1277 struct vfsmount *mnt;
1278 unsigned int mounted;
1279};
1280
1281static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1282{
1283 struct check_mount *info = data;
1284 struct path path = { .mnt = info->mnt, .dentry = dentry };
1285
1286 if (likely(!d_mountpoint(dentry)))
1287 return D_WALK_CONTINUE;
1288 if (__path_is_mountpoint(&path)) {
1289 info->mounted = 1;
1290 return D_WALK_QUIT;
1291 }
1292 return D_WALK_CONTINUE;
1293}
1294
1295/**
1296 * path_has_submounts - check for mounts over a dentry in the
1297 * current namespace.
1298 * @parent: path to check.
1299 *
1300 * Return true if the parent or its subdirectories contain
1301 * a mount point in the current namespace.
1302 */
1303int path_has_submounts(const struct path *parent)
1304{
1305 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1306
1307 read_seqlock_excl(&mount_lock);
1308 d_walk(parent->dentry, &data, path_check_mount, NULL);
1309 read_sequnlock_excl(&mount_lock);
1310
1311 return data.mounted;
1312}
1313EXPORT_SYMBOL(path_has_submounts);
1314
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001316 * Called by mount code to set a mountpoint and check if the mountpoint is
1317 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1318 * subtree can become unreachable).
1319 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001320 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001321 * this reason take rename_lock and d_lock on dentry and ancestors.
1322 */
1323int d_set_mounted(struct dentry *dentry)
1324{
1325 struct dentry *p;
1326 int ret = -ENOENT;
1327 write_seqlock(&rename_lock);
1328 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001329 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001330 spin_lock(&p->d_lock);
1331 if (unlikely(d_unhashed(p))) {
1332 spin_unlock(&p->d_lock);
1333 goto out;
1334 }
1335 spin_unlock(&p->d_lock);
1336 }
1337 spin_lock(&dentry->d_lock);
1338 if (!d_unlinked(dentry)) {
Eric W. Biederman3895dbf2017-01-03 14:18:43 +13001339 ret = -EBUSY;
1340 if (!d_mountpoint(dentry)) {
1341 dentry->d_flags |= DCACHE_MOUNTED;
1342 ret = 0;
1343 }
Miklos Szeredieed81002013-09-05 14:39:11 +02001344 }
1345 spin_unlock(&dentry->d_lock);
1346out:
1347 write_sequnlock(&rename_lock);
1348 return ret;
1349}
1350
1351/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001352 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 * and move any unused dentries to the end of the unused
1354 * list for prune_dcache(). We descend to the next level
1355 * whenever the d_subdirs list is non-empty and continue
1356 * searching.
1357 *
1358 * It returns zero iff there are no unused children,
1359 * otherwise it returns the number of children moved to
1360 * the end of the unused list. This may not be the total
1361 * number of unused children, because select_parent can
1362 * drop the lock and return early due to latency
1363 * constraints.
1364 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001365
1366struct select_data {
1367 struct dentry *start;
1368 struct list_head dispose;
1369 int found;
1370};
1371
1372static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001374 struct select_data *data = _data;
1375 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001377 if (data->start == dentry)
1378 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Al Virofe915222014-05-03 00:02:25 -04001380 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001381 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001382 } else {
1383 if (dentry->d_flags & DCACHE_LRU_LIST)
1384 d_lru_del(dentry);
1385 if (!dentry->d_lockref.count) {
1386 d_shrink_add(dentry, &data->dispose);
1387 data->found++;
1388 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 }
1390 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001391 * We can return to the caller if we have found some (this
1392 * ensures forward progress). We'll be coming back to find
1393 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 */
Al Virofe915222014-05-03 00:02:25 -04001395 if (!list_empty(&data->dispose))
1396 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001398 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399}
1400
1401/**
1402 * shrink_dcache_parent - prune dcache
1403 * @parent: parent of entries to prune
1404 *
1405 * Prune the dcache to remove unused children of the parent dentry.
1406 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001407void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001409 for (;;) {
1410 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001412 INIT_LIST_HEAD(&data.dispose);
1413 data.start = parent;
1414 data.found = 0;
1415
1416 d_walk(parent, &data, select_collect, NULL);
1417 if (!data.found)
1418 break;
1419
1420 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001421 cond_resched();
1422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001424EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Al Viro9c8c10e2014-05-02 20:36:10 -04001426static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001427{
Al Viro9c8c10e2014-05-02 20:36:10 -04001428 /* it has busy descendents; complain about those instead */
1429 if (!list_empty(&dentry->d_subdirs))
1430 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001431
Al Viro9c8c10e2014-05-02 20:36:10 -04001432 /* root with refcount 1 is fine */
1433 if (dentry == _data && dentry->d_lockref.count == 1)
1434 return D_WALK_CONTINUE;
1435
1436 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1437 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001438 dentry,
1439 dentry->d_inode ?
1440 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001441 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001442 dentry->d_lockref.count,
1443 dentry->d_sb->s_type->name,
1444 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001445 WARN_ON(1);
1446 return D_WALK_CONTINUE;
1447}
1448
1449static void do_one_tree(struct dentry *dentry)
1450{
1451 shrink_dcache_parent(dentry);
1452 d_walk(dentry, dentry, umount_check, NULL);
1453 d_drop(dentry);
1454 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001455}
1456
1457/*
1458 * destroy the dentries attached to a superblock on unmounting
1459 */
1460void shrink_dcache_for_umount(struct super_block *sb)
1461{
1462 struct dentry *dentry;
1463
Al Viro9c8c10e2014-05-02 20:36:10 -04001464 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001465
1466 dentry = sb->s_root;
1467 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001468 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001469
1470 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001471 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1472 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001473 }
1474}
1475
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001476struct detach_data {
1477 struct select_data select;
1478 struct dentry *mountpoint;
1479};
1480static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001481{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001482 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001483
1484 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001485 __dget_dlock(dentry);
1486 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001487 return D_WALK_QUIT;
1488 }
1489
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001490 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001491}
1492
1493static void check_and_drop(void *_data)
1494{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001495 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001496
Al Viro81be24d2017-06-03 07:20:09 +01001497 if (!data->mountpoint && list_empty(&data->select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001498 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001499}
1500
1501/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001502 * d_invalidate - detach submounts, prune dcache, and drop
1503 * @dentry: dentry to invalidate (aka detach, prune and drop)
1504 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001505 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001506 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001507 * The final d_drop is done as an atomic operation relative to
1508 * rename_lock ensuring there are no races with d_set_mounted. This
1509 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001510 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001511void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001512{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001513 /*
1514 * If it's already been dropped, return OK.
1515 */
1516 spin_lock(&dentry->d_lock);
1517 if (d_unhashed(dentry)) {
1518 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001519 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001520 }
1521 spin_unlock(&dentry->d_lock);
1522
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001523 /* Negative dentries can be dropped without further checks */
1524 if (!dentry->d_inode) {
1525 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001526 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527 }
1528
1529 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001530 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001531
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001532 data.mountpoint = NULL;
1533 INIT_LIST_HEAD(&data.select.dispose);
1534 data.select.start = dentry;
1535 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001536
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001537 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538
Al Viro81be24d2017-06-03 07:20:09 +01001539 if (!list_empty(&data.select.dispose))
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001540 shrink_dentry_list(&data.select.dispose);
Al Viro81be24d2017-06-03 07:20:09 +01001541 else if (!data.mountpoint)
1542 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001543
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001544 if (data.mountpoint) {
1545 detach_mounts(data.mountpoint);
1546 dput(data.mountpoint);
1547 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001548 cond_resched();
1549 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001550}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001551EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001552
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553/**
Al Viroa4464db2011-07-07 15:03:58 -04001554 * __d_alloc - allocate a dcache entry
1555 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 * @name: qstr of the name
1557 *
1558 * Allocates a dentry. It returns %NULL if there is insufficient memory
1559 * available. On a success the dentry is returned. The name passed in is
1560 * copied and the copy passed in may be reused after this call.
1561 */
1562
Al Viroa4464db2011-07-07 15:03:58 -04001563struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564{
1565 struct dentry *dentry;
1566 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001567 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
Mel Gormane12ba742007-10-16 01:25:52 -07001569 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 if (!dentry)
1571 return NULL;
1572
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001573 /*
1574 * We guarantee that the inline name is always NUL-terminated.
1575 * This way the memcpy() done by the name switching in rename
1576 * will still always have a NUL at the end, even if we might
1577 * be overwriting an internal NUL character
1578 */
1579 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001580 if (unlikely(!name)) {
1581 static const struct qstr anon = QSTR_INIT("/", 1);
1582 name = &anon;
1583 dname = dentry->d_iname;
1584 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001585 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001586 struct external_name *p = kmalloc(size + name->len,
1587 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001588 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 kmem_cache_free(dentry_cache, dentry);
1590 return NULL;
1591 }
Al Viro8d85b482014-09-29 14:54:27 -04001592 atomic_set(&p->u.count, 1);
1593 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001594 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1595 kasan_unpoison_shadow(dname,
1596 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 } else {
1598 dname = dentry->d_iname;
1599 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
1601 dentry->d_name.len = name->len;
1602 dentry->d_name.hash = name->hash;
1603 memcpy(dname, name->name, name->len);
1604 dname[name->len] = 0;
1605
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001606 /* Make sure we always see the terminating NUL character */
1607 smp_wmb();
1608 dentry->d_name.name = dname;
1609
Waiman Long98474232013-08-28 18:24:59 -07001610 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001611 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001613 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001615 dentry->d_parent = dentry;
1616 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 dentry->d_op = NULL;
1618 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001619 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 INIT_LIST_HEAD(&dentry->d_lru);
1621 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001622 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1623 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001624 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Miklos Szeredi285b1022016-06-28 11:47:32 +02001626 if (dentry->d_op && dentry->d_op->d_init) {
1627 err = dentry->d_op->d_init(dentry);
1628 if (err) {
1629 if (dname_external(dentry))
1630 kfree(external_name(dentry));
1631 kmem_cache_free(dentry_cache, dentry);
1632 return NULL;
1633 }
1634 }
1635
Nick Piggin3e880fb2011-01-07 17:49:19 +11001636 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 return dentry;
1639}
Al Viroa4464db2011-07-07 15:03:58 -04001640
1641/**
1642 * d_alloc - allocate a dcache entry
1643 * @parent: parent of entry to allocate
1644 * @name: qstr of the name
1645 *
1646 * Allocates a dentry. It returns %NULL if there is insufficient memory
1647 * available. On a success the dentry is returned. The name passed in is
1648 * copied and the copy passed in may be reused after this call.
1649 */
1650struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1651{
1652 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1653 if (!dentry)
1654 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001655 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001656 spin_lock(&parent->d_lock);
1657 /*
1658 * don't need child lock because it is not subject
1659 * to concurrency here
1660 */
1661 __dget_dlock(parent);
1662 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001663 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001664 spin_unlock(&parent->d_lock);
1665
1666 return dentry;
1667}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001668EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Al Viroba65dc52016-06-10 11:32:47 -04001670struct dentry *d_alloc_cursor(struct dentry * parent)
1671{
1672 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1673 if (dentry) {
1674 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1675 dentry->d_parent = dget(parent);
1676 }
1677 return dentry;
1678}
1679
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001680/**
1681 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1682 * @sb: the superblock
1683 * @name: qstr of the name
1684 *
1685 * For a filesystem that just pins its dentries in memory and never
1686 * performs lookups at all, return an unhashed IS_ROOT dentry.
1687 */
Nick Piggin4b936882011-01-07 17:50:07 +11001688struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1689{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001690 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001691}
1692EXPORT_SYMBOL(d_alloc_pseudo);
1693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1695{
1696 struct qstr q;
1697
1698 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001699 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 return d_alloc(parent, &q);
1701}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001702EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Nick Pigginfb045ad2011-01-07 17:49:55 +11001704void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1705{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001706 WARN_ON_ONCE(dentry->d_op);
1707 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001708 DCACHE_OP_COMPARE |
1709 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001710 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001711 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001712 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001713 dentry->d_op = op;
1714 if (!op)
1715 return;
1716 if (op->d_hash)
1717 dentry->d_flags |= DCACHE_OP_HASH;
1718 if (op->d_compare)
1719 dentry->d_flags |= DCACHE_OP_COMPARE;
1720 if (op->d_revalidate)
1721 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001722 if (op->d_weak_revalidate)
1723 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001724 if (op->d_delete)
1725 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001726 if (op->d_prune)
1727 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001728 if (op->d_real)
1729 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001730
1731}
1732EXPORT_SYMBOL(d_set_d_op);
1733
David Howellsdf1a0852015-01-29 12:02:28 +00001734
1735/*
1736 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1737 * @dentry - The dentry to mark
1738 *
1739 * Mark a dentry as falling through to the lower layer (as set with
1740 * d_pin_lower()). This flag may be recorded on the medium.
1741 */
1742void d_set_fallthru(struct dentry *dentry)
1743{
1744 spin_lock(&dentry->d_lock);
1745 dentry->d_flags |= DCACHE_FALLTHRU;
1746 spin_unlock(&dentry->d_lock);
1747}
1748EXPORT_SYMBOL(d_set_fallthru);
1749
David Howellsb18825a2013-09-12 19:22:53 +01001750static unsigned d_flags_for_inode(struct inode *inode)
1751{
David Howells44bdb5e2015-01-29 12:02:29 +00001752 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001753
1754 if (!inode)
1755 return DCACHE_MISS_TYPE;
1756
1757 if (S_ISDIR(inode->i_mode)) {
1758 add_flags = DCACHE_DIRECTORY_TYPE;
1759 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1760 if (unlikely(!inode->i_op->lookup))
1761 add_flags = DCACHE_AUTODIR_TYPE;
1762 else
1763 inode->i_opflags |= IOP_LOOKUP;
1764 }
David Howells44bdb5e2015-01-29 12:02:29 +00001765 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001766 }
1767
David Howells44bdb5e2015-01-29 12:02:29 +00001768 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001769 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001770 add_flags = DCACHE_SYMLINK_TYPE;
1771 goto type_determined;
1772 }
1773 inode->i_opflags |= IOP_NOFOLLOW;
1774 }
1775
1776 if (unlikely(!S_ISREG(inode->i_mode)))
1777 add_flags = DCACHE_SPECIAL_TYPE;
1778
1779type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001780 if (unlikely(IS_AUTOMOUNT(inode)))
1781 add_flags |= DCACHE_NEED_AUTOMOUNT;
1782 return add_flags;
1783}
1784
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001785static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1786{
David Howellsb18825a2013-09-12 19:22:53 +01001787 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001788 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001789
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001790 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001791 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001792 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001793 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001794 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001795 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001796 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001797}
1798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799/**
1800 * d_instantiate - fill in inode information for a dentry
1801 * @entry: dentry to complete
1802 * @inode: inode to attach to this dentry
1803 *
1804 * Fill in inode information in the entry.
1805 *
1806 * This turns negative dentries into productive full members
1807 * of society.
1808 *
1809 * NOTE! This assumes that the inode count has been incremented
1810 * (or otherwise set) by the caller to indicate that it is now
1811 * in use by the dcache.
1812 */
1813
1814void d_instantiate(struct dentry *entry, struct inode * inode)
1815{
Al Viro946e51f2014-10-26 19:19:16 -04001816 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001817 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001818 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001819 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001820 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001821 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001824EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
1826/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001827 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1828 * @entry: dentry to complete
1829 * @inode: inode to attach to this dentry
1830 *
1831 * Fill in inode information in the entry. If a directory alias is found, then
1832 * return an error (and drop inode). Together with d_materialise_unique() this
1833 * guarantees that a directory inode may never have more than one alias.
1834 */
1835int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1836{
Al Viro946e51f2014-10-26 19:19:16 -04001837 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001838
Al Virob9680912016-04-11 00:53:26 -04001839 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001840 spin_lock(&inode->i_lock);
1841 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1842 spin_unlock(&inode->i_lock);
1843 iput(inode);
1844 return -EBUSY;
1845 }
1846 __d_instantiate(entry, inode);
1847 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001848
1849 return 0;
1850}
1851EXPORT_SYMBOL(d_instantiate_no_diralias);
1852
Al Viroadc0e91a2012-01-08 16:49:21 -05001853struct dentry *d_make_root(struct inode *root_inode)
1854{
1855 struct dentry *res = NULL;
1856
1857 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001858 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e91a2012-01-08 16:49:21 -05001859 if (res)
1860 d_instantiate(res, root_inode);
1861 else
1862 iput(root_inode);
1863 }
1864 return res;
1865}
1866EXPORT_SYMBOL(d_make_root);
1867
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001868static struct dentry * __d_find_any_alias(struct inode *inode)
1869{
1870 struct dentry *alias;
1871
Al Virob3d9b7a2012-06-09 13:51:19 -04001872 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001873 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001874 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001875 __dget(alias);
1876 return alias;
1877}
1878
Sage Weil46f72b32012-01-10 09:04:37 -08001879/**
1880 * d_find_any_alias - find any alias for a given inode
1881 * @inode: inode to find an alias for
1882 *
1883 * If any aliases exist for the given inode, take and return a
1884 * reference for one of them. If no aliases exist, return %NULL.
1885 */
1886struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001887{
1888 struct dentry *de;
1889
1890 spin_lock(&inode->i_lock);
1891 de = __d_find_any_alias(inode);
1892 spin_unlock(&inode->i_lock);
1893 return de;
1894}
Sage Weil46f72b32012-01-10 09:04:37 -08001895EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001896
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001897static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001898{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001899 struct dentry *tmp;
1900 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001901 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001902
1903 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001904 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001905 if (IS_ERR(inode))
1906 return ERR_CAST(inode);
1907
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001908 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001909 if (res)
1910 goto out_iput;
1911
Al Viro798434b2016-03-24 20:38:43 -04001912 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001913 if (!tmp) {
1914 res = ERR_PTR(-ENOMEM);
1915 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001916 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001917
Al Virob9680912016-04-11 00:53:26 -04001918 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001919 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001920 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001921 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001922 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001923 dput(tmp);
1924 goto out_iput;
1925 }
1926
1927 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001928 add_flags = d_flags_for_inode(inode);
1929
1930 if (disconnected)
1931 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001932
Christoph Hellwig9308a612008-08-11 15:49:12 +02001933 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001934 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001935 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001936 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001937 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001938 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001939 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001940 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001941
Christoph Hellwig9308a612008-08-11 15:49:12 +02001942 return tmp;
1943
1944 out_iput:
1945 iput(inode);
1946 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001947}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001948
1949/**
1950 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1951 * @inode: inode to allocate the dentry for
1952 *
1953 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1954 * similar open by handle operations. The returned dentry may be anonymous,
1955 * or may have a full name (if the inode was already in the cache).
1956 *
1957 * When called on a directory inode, we must ensure that the inode only ever
1958 * has one dentry. If a dentry is found, that is returned instead of
1959 * allocating a new one.
1960 *
1961 * On successful return, the reference to the inode has been transferred
1962 * to the dentry. In case of an error the reference on the inode is released.
1963 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1964 * be passed in and the error will be propagated to the return value,
1965 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1966 */
1967struct dentry *d_obtain_alias(struct inode *inode)
1968{
1969 return __d_obtain_alias(inode, 1);
1970}
Benny Halevyadc48722009-02-27 14:02:59 -08001971EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001974 * d_obtain_root - find or allocate a dentry for a given inode
1975 * @inode: inode to allocate the dentry for
1976 *
1977 * Obtain an IS_ROOT dentry for the root of a filesystem.
1978 *
1979 * We must ensure that directory inodes only ever have one dentry. If a
1980 * dentry is found, that is returned instead of allocating a new one.
1981 *
1982 * On successful return, the reference to the inode has been transferred
1983 * to the dentry. In case of an error the reference on the inode is
1984 * released. A %NULL or IS_ERR inode may be passed in and will be the
1985 * error will be propagate to the return value, with a %NULL @inode
1986 * replaced by ERR_PTR(-ESTALE).
1987 */
1988struct dentry *d_obtain_root(struct inode *inode)
1989{
1990 return __d_obtain_alias(inode, 0);
1991}
1992EXPORT_SYMBOL(d_obtain_root);
1993
1994/**
Barry Naujok94035402008-05-21 16:50:46 +10001995 * d_add_ci - lookup or allocate new dentry with case-exact name
1996 * @inode: the inode case-insensitive lookup has found
1997 * @dentry: the negative dentry that was passed to the parent's lookup func
1998 * @name: the case-exact name to be associated with the returned dentry
1999 *
2000 * This is to avoid filling the dcache with case-insensitive names to the
2001 * same inode, only the actual correct case is stored in the dcache for
2002 * case-insensitive filesystems.
2003 *
2004 * For a case-insensitive lookup match and if the the case-exact dentry
2005 * already exists in in the dcache, use it and return it.
2006 *
2007 * If no entry exists with the exact case name, allocate new dentry with
2008 * the exact case, and return the spliced entry.
2009 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002010struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002011 struct qstr *name)
2012{
Al Virod9171b92016-04-15 03:33:13 -04002013 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002014
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002015 /*
2016 * First check if a dentry matching the name already exists,
2017 * if not go ahead and create it now.
2018 */
Barry Naujok94035402008-05-21 16:50:46 +10002019 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002020 if (found) {
2021 iput(inode);
2022 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002023 }
Al Virod9171b92016-04-15 03:33:13 -04002024 if (d_in_lookup(dentry)) {
2025 found = d_alloc_parallel(dentry->d_parent, name,
2026 dentry->d_wait);
2027 if (IS_ERR(found) || !d_in_lookup(found)) {
2028 iput(inode);
2029 return found;
2030 }
2031 } else {
2032 found = d_alloc(dentry->d_parent, name);
2033 if (!found) {
2034 iput(inode);
2035 return ERR_PTR(-ENOMEM);
2036 }
2037 }
2038 res = d_splice_alias(inode, found);
2039 if (res) {
2040 dput(found);
2041 return res;
2042 }
Al Viro4f522a22013-02-11 23:20:37 -05002043 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002044}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002045EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002047
Al Virod4c91a82016-06-25 23:33:49 -04002048static inline bool d_same_name(const struct dentry *dentry,
2049 const struct dentry *parent,
2050 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002051{
Al Virod4c91a82016-06-25 23:33:49 -04002052 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2053 if (dentry->d_name.len != name->len)
2054 return false;
2055 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002056 }
Al Viro6fa67e72016-07-31 16:37:25 -04002057 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002058 dentry->d_name.len, dentry->d_name.name,
2059 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002060}
2061
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002063 * __d_lookup_rcu - search for a dentry (racy, store-free)
2064 * @parent: parent dentry
2065 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002066 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002067 * Returns: dentry, or NULL
2068 *
2069 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2070 * resolution (store-free path walking) design described in
2071 * Documentation/filesystems/path-lookup.txt.
2072 *
2073 * This is not to be used outside core vfs.
2074 *
2075 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2076 * held, and rcu_read_lock held. The returned dentry must not be stored into
2077 * without taking d_lock and checking d_seq sequence count against @seq
2078 * returned here.
2079 *
Linus Torvalds15570082013-09-02 11:38:06 -07002080 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002081 * function.
2082 *
2083 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2084 * the returned dentry, so long as its parent's seqlock is checked after the
2085 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2086 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002087 *
2088 * NOTE! The caller *has* to check the resulting dentry against the sequence
2089 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002090 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002091struct dentry *__d_lookup_rcu(const struct dentry *parent,
2092 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002093 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002094{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002095 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002097 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002098 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002099 struct dentry *dentry;
2100
2101 /*
2102 * Note: There is significant duplication with __d_lookup_rcu which is
2103 * required to prevent single threaded performance regressions
2104 * especially on architectures where smp_rmb (in seqcounts) are costly.
2105 * Keep the two functions in sync.
2106 */
2107
2108 /*
2109 * The hash list is protected using RCU.
2110 *
2111 * Carefully use d_seq when comparing a candidate dentry, to avoid
2112 * races with d_move().
2113 *
2114 * It is possible that concurrent renames can mess up our list
2115 * walk here and result in missing our dentry, resulting in the
2116 * false-negative result. d_lookup() protects against concurrent
2117 * renames using rename_lock seqlock.
2118 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002119 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002120 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002121 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002122 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002123
Nick Piggin31e6b012011-01-07 17:49:52 +11002124seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002125 /*
2126 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002127 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002128 *
2129 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002130 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002131 *
2132 * NOTE! We do a "raw" seqcount_begin here. That means that
2133 * we don't wait for the sequence count to stabilize if it
2134 * is in the middle of a sequence change. If we do the slow
2135 * dentry compare, we will do seqretries until it is stable,
2136 * and if we end up with a successful lookup, we actually
2137 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002138 *
2139 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2140 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002141 */
2142 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002143 if (dentry->d_parent != parent)
2144 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002145 if (d_unhashed(dentry))
2146 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002147
2148 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002149 int tlen;
2150 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002151 if (dentry->d_name.hash != hashlen_hash(hashlen))
2152 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002153 tlen = dentry->d_name.len;
2154 tname = dentry->d_name.name;
2155 /* we want a consistent (name,len) pair */
2156 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2157 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002158 goto seqretry;
2159 }
Al Viro6fa67e72016-07-31 16:37:25 -04002160 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002161 tlen, tname, name) != 0)
2162 continue;
2163 } else {
2164 if (dentry->d_name.hash_len != hashlen)
2165 continue;
2166 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2167 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002168 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002169 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002170 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002171 }
2172 return NULL;
2173}
2174
2175/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 * d_lookup - search for a dentry
2177 * @parent: parent dentry
2178 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002179 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002181 * d_lookup searches the children of the parent dentry for the name in
2182 * question. If the dentry is found its reference count is incremented and the
2183 * dentry is returned. The caller must use dput to free the entry when it has
2184 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 */
Al Viroda2d8452013-01-24 18:29:34 -05002186struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187{
Nick Piggin31e6b012011-01-07 17:49:52 +11002188 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002189 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190
Daeseok Younb8314f92014-08-11 11:46:53 +09002191 do {
2192 seq = read_seqbegin(&rename_lock);
2193 dentry = __d_lookup(parent, name);
2194 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 break;
2196 } while (read_seqretry(&rename_lock, seq));
2197 return dentry;
2198}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002199EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
Nick Piggin31e6b012011-01-07 17:49:52 +11002201/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002202 * __d_lookup - search for a dentry (racy)
2203 * @parent: parent dentry
2204 * @name: qstr of name we wish to find
2205 * Returns: dentry, or NULL
2206 *
2207 * __d_lookup is like d_lookup, however it may (rarely) return a
2208 * false-negative result due to unrelated rename activity.
2209 *
2210 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2211 * however it must be used carefully, eg. with a following d_lookup in
2212 * the case of failure.
2213 *
2214 * __d_lookup callers must be commented.
2215 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002216struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002219 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002220 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002221 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002222 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
Nick Pigginb04f7842010-08-18 04:37:34 +10002224 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002225 * Note: There is significant duplication with __d_lookup_rcu which is
2226 * required to prevent single threaded performance regressions
2227 * especially on architectures where smp_rmb (in seqcounts) are costly.
2228 * Keep the two functions in sync.
2229 */
2230
2231 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002232 * The hash list is protected using RCU.
2233 *
2234 * Take d_lock when comparing a candidate dentry, to avoid races
2235 * with d_move().
2236 *
2237 * It is possible that concurrent renames can mess up our list
2238 * walk here and result in missing our dentry, resulting in the
2239 * false-negative result. d_lookup() protects against concurrent
2240 * renames using rename_lock seqlock.
2241 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002242 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002243 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 rcu_read_lock();
2245
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002246 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if (dentry->d_name.hash != hash)
2249 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250
2251 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 if (dentry->d_parent != parent)
2253 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002254 if (d_unhashed(dentry))
2255 goto next;
2256
Al Virod4c91a82016-06-25 23:33:49 -04002257 if (!d_same_name(dentry, parent, name))
2258 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259
Waiman Long98474232013-08-28 18:24:59 -07002260 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002261 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 spin_unlock(&dentry->d_lock);
2263 break;
2264next:
2265 spin_unlock(&dentry->d_lock);
2266 }
2267 rcu_read_unlock();
2268
2269 return found;
2270}
2271
2272/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002273 * d_hash_and_lookup - hash the qstr then search for a dentry
2274 * @dir: Directory to search in
2275 * @name: qstr of name we wish to find
2276 *
Al Viro4f522a22013-02-11 23:20:37 -05002277 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002278 */
2279struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2280{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002281 /*
2282 * Check for a fs-specific hash function. Note that we must
2283 * calculate the standard hash first, as the d_op->d_hash()
2284 * routine may choose to leave the hash value unchanged.
2285 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002286 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002287 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002288 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002289 if (unlikely(err < 0))
2290 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002291 }
Al Viro4f522a22013-02-11 23:20:37 -05002292 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002293}
Al Viro4f522a22013-02-11 23:20:37 -05002294EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002295
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296/*
2297 * When a file is deleted, we have two options:
2298 * - turn this dentry into a negative dentry
2299 * - unhash this dentry and free it.
2300 *
2301 * Usually, we want to just turn this into
2302 * a negative dentry, but if anybody else is
2303 * currently using the dentry or the inode
2304 * we can't do that and we fall back on removing
2305 * it from the hash queues and waiting for
2306 * it to be deleted later when it has no users
2307 */
2308
2309/**
2310 * d_delete - delete a dentry
2311 * @dentry: The dentry to delete
2312 *
2313 * Turn the dentry into a negative dentry if possible, otherwise
2314 * remove it from the hash queues so it can be deleted later
2315 */
2316
2317void d_delete(struct dentry * dentry)
2318{
Nick Piggin873feea2011-01-07 17:50:06 +11002319 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002320 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 /*
2322 * Are we the only user?
2323 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002324again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002326 inode = dentry->d_inode;
2327 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002328 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002329 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002330 spin_unlock(&dentry->d_lock);
2331 cpu_relax();
2332 goto again;
2333 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002334 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002335 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002336 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 return;
2338 }
2339
2340 if (!d_unhashed(dentry))
2341 __d_drop(dentry);
2342
2343 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002344
2345 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002347EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348
Al Viro15d3c582016-07-29 17:45:21 -04002349static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350{
Al Viro15d3c582016-07-29 17:45:21 -04002351 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002352 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002353 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002354 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002355 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356}
2357
2358/**
2359 * d_rehash - add an entry back to the hash
2360 * @entry: dentry to add to the hash
2361 *
2362 * Adds a dentry to the hash according to its name.
2363 */
2364
2365void d_rehash(struct dentry * entry)
2366{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002368 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002371EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
Al Viro84e710d2016-04-15 00:58:55 -04002373static inline unsigned start_dir_add(struct inode *dir)
2374{
2375
2376 for (;;) {
2377 unsigned n = dir->i_dir_seq;
2378 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2379 return n;
2380 cpu_relax();
2381 }
2382}
2383
2384static inline void end_dir_add(struct inode *dir, unsigned n)
2385{
2386 smp_store_release(&dir->i_dir_seq, n + 2);
2387}
2388
Al Virod9171b92016-04-15 03:33:13 -04002389static void d_wait_lookup(struct dentry *dentry)
2390{
2391 if (d_in_lookup(dentry)) {
2392 DECLARE_WAITQUEUE(wait, current);
2393 add_wait_queue(dentry->d_wait, &wait);
2394 do {
2395 set_current_state(TASK_UNINTERRUPTIBLE);
2396 spin_unlock(&dentry->d_lock);
2397 schedule();
2398 spin_lock(&dentry->d_lock);
2399 } while (d_in_lookup(dentry));
2400 }
2401}
2402
Al Viro94bdd652016-04-15 02:42:04 -04002403struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002404 const struct qstr *name,
2405 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002406{
Al Viro94bdd652016-04-15 02:42:04 -04002407 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002408 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2409 struct hlist_bl_node *node;
2410 struct dentry *new = d_alloc(parent, name);
2411 struct dentry *dentry;
2412 unsigned seq, r_seq, d_seq;
2413
2414 if (unlikely(!new))
2415 return ERR_PTR(-ENOMEM);
2416
2417retry:
2418 rcu_read_lock();
2419 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2420 r_seq = read_seqbegin(&rename_lock);
2421 dentry = __d_lookup_rcu(parent, name, &d_seq);
2422 if (unlikely(dentry)) {
2423 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2424 rcu_read_unlock();
2425 goto retry;
2426 }
2427 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2428 rcu_read_unlock();
2429 dput(dentry);
2430 goto retry;
2431 }
2432 rcu_read_unlock();
2433 dput(new);
2434 return dentry;
2435 }
2436 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2437 rcu_read_unlock();
2438 goto retry;
2439 }
2440 hlist_bl_lock(b);
2441 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2442 hlist_bl_unlock(b);
2443 rcu_read_unlock();
2444 goto retry;
2445 }
Al Viro94bdd652016-04-15 02:42:04 -04002446 /*
2447 * No changes for the parent since the beginning of d_lookup().
2448 * Since all removals from the chain happen with hlist_bl_lock(),
2449 * any potential in-lookup matches are going to stay here until
2450 * we unlock the chain. All fields are stable in everything
2451 * we encounter.
2452 */
2453 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2454 if (dentry->d_name.hash != hash)
2455 continue;
2456 if (dentry->d_parent != parent)
2457 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002458 if (!d_same_name(dentry, parent, name))
2459 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002460 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002461 /* now we can try to grab a reference */
2462 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2463 rcu_read_unlock();
2464 goto retry;
2465 }
2466
2467 rcu_read_unlock();
2468 /*
2469 * somebody is likely to be still doing lookup for it;
2470 * wait for them to finish
2471 */
Al Virod9171b92016-04-15 03:33:13 -04002472 spin_lock(&dentry->d_lock);
2473 d_wait_lookup(dentry);
2474 /*
2475 * it's not in-lookup anymore; in principle we should repeat
2476 * everything from dcache lookup, but it's likely to be what
2477 * d_lookup() would've found anyway. If it is, just return it;
2478 * otherwise we really have to repeat the whole thing.
2479 */
2480 if (unlikely(dentry->d_name.hash != hash))
2481 goto mismatch;
2482 if (unlikely(dentry->d_parent != parent))
2483 goto mismatch;
2484 if (unlikely(d_unhashed(dentry)))
2485 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002486 if (unlikely(!d_same_name(dentry, parent, name)))
2487 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002488 /* OK, it *is* a hashed match; return it */
2489 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002490 dput(new);
2491 return dentry;
2492 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002493 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002494 /* we can't take ->d_lock here; it's OK, though. */
2495 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002496 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002497 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2498 hlist_bl_unlock(b);
2499 return new;
Al Virod9171b92016-04-15 03:33:13 -04002500mismatch:
2501 spin_unlock(&dentry->d_lock);
2502 dput(dentry);
2503 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002504}
2505EXPORT_SYMBOL(d_alloc_parallel);
2506
Al Viro85c7f812016-04-14 19:52:13 -04002507void __d_lookup_done(struct dentry *dentry)
2508{
Al Viro94bdd652016-04-15 02:42:04 -04002509 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2510 dentry->d_name.hash);
2511 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002512 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002513 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002514 wake_up_all(dentry->d_wait);
2515 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002516 hlist_bl_unlock(b);
2517 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002518 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002519}
2520EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002521
2522/* inode->i_lock held if inode is non-NULL */
2523
2524static inline void __d_add(struct dentry *dentry, struct inode *inode)
2525{
Al Viro84e710d2016-04-15 00:58:55 -04002526 struct inode *dir = NULL;
2527 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002528 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002529 if (unlikely(d_in_lookup(dentry))) {
2530 dir = dentry->d_parent->d_inode;
2531 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002532 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002533 }
Al Viroed782b52016-03-09 19:52:39 -05002534 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002535 unsigned add_flags = d_flags_for_inode(inode);
2536 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2537 raw_write_seqcount_begin(&dentry->d_seq);
2538 __d_set_inode_and_type(dentry, inode, add_flags);
2539 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002540 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002541 }
Al Viro15d3c582016-07-29 17:45:21 -04002542 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002543 if (dir)
2544 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002545 spin_unlock(&dentry->d_lock);
2546 if (inode)
2547 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002548}
2549
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002550/**
Al Viro34d0d192016-03-08 21:01:03 -05002551 * d_add - add dentry to hash queues
2552 * @entry: dentry to add
2553 * @inode: The inode to attach to this dentry
2554 *
2555 * This adds the entry to the hash queues and initializes @inode.
2556 * The entry was actually filled in earlier during d_alloc().
2557 */
2558
2559void d_add(struct dentry *entry, struct inode *inode)
2560{
Al Virob9680912016-04-11 00:53:26 -04002561 if (inode) {
2562 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002563 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002564 }
Al Viroed782b52016-03-09 19:52:39 -05002565 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002566}
2567EXPORT_SYMBOL(d_add);
2568
2569/**
Al Viro668d0cd2016-03-08 12:44:17 -05002570 * d_exact_alias - find and hash an exact unhashed alias
2571 * @entry: dentry to add
2572 * @inode: The inode to go with this dentry
2573 *
2574 * If an unhashed dentry with the same name/parent and desired
2575 * inode already exists, hash and return it. Otherwise, return
2576 * NULL.
2577 *
2578 * Parent directory should be locked.
2579 */
2580struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2581{
2582 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002583 unsigned int hash = entry->d_name.hash;
2584
2585 spin_lock(&inode->i_lock);
2586 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2587 /*
2588 * Don't need alias->d_lock here, because aliases with
2589 * d_parent == entry->d_parent are not subject to name or
2590 * parent changes, because the parent inode i_mutex is held.
2591 */
2592 if (alias->d_name.hash != hash)
2593 continue;
2594 if (alias->d_parent != entry->d_parent)
2595 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002596 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002597 continue;
2598 spin_lock(&alias->d_lock);
2599 if (!d_unhashed(alias)) {
2600 spin_unlock(&alias->d_lock);
2601 alias = NULL;
2602 } else {
2603 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002604 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002605 spin_unlock(&alias->d_lock);
2606 }
2607 spin_unlock(&inode->i_lock);
2608 return alias;
2609 }
2610 spin_unlock(&inode->i_lock);
2611 return NULL;
2612}
2613EXPORT_SYMBOL(d_exact_alias);
2614
2615/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002616 * dentry_update_name_case - update case insensitive dentry with a new name
2617 * @dentry: dentry to be updated
2618 * @name: new name
2619 *
2620 * Update a case insensitive dentry with new case of name.
2621 *
2622 * dentry must have been returned by d_lookup with name @name. Old and new
2623 * name lengths must match (ie. no d_compare which allows mismatched name
2624 * lengths).
2625 *
2626 * Parent inode i_mutex must be held over d_lookup and into this call (to
2627 * keep renames and concurrent inserts, and readdir(2) away).
2628 */
Al Viro9aba36d2016-07-20 22:28:45 -04002629void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002630{
Al Viro59551022016-01-22 15:40:57 -05002631 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002632 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2633
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002634 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002635 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002636 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002637 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002638 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002639}
2640EXPORT_SYMBOL(dentry_update_name_case);
2641
Al Viro8d85b482014-09-29 14:54:27 -04002642static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643{
Al Viro8d85b482014-09-29 14:54:27 -04002644 if (unlikely(dname_external(target))) {
2645 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 /*
2647 * Both external: swap the pointers
2648 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002649 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 } else {
2651 /*
2652 * dentry:internal, target:external. Steal target's
2653 * storage and make target internal.
2654 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002655 memcpy(target->d_iname, dentry->d_name.name,
2656 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 dentry->d_name.name = target->d_name.name;
2658 target->d_name.name = target->d_iname;
2659 }
2660 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002661 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 /*
2663 * dentry:external, target:internal. Give dentry's
2664 * storage to target and make dentry internal
2665 */
2666 memcpy(dentry->d_iname, target->d_name.name,
2667 target->d_name.len + 1);
2668 target->d_name.name = dentry->d_name.name;
2669 dentry->d_name.name = dentry->d_iname;
2670 } else {
2671 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002672 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002674 unsigned int i;
2675 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002676 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2677 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002678 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2679 swap(((long *) &dentry->d_iname)[i],
2680 ((long *) &target->d_iname)[i]);
2681 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 }
2683 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002684 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685}
2686
Al Viro8d85b482014-09-29 14:54:27 -04002687static void copy_name(struct dentry *dentry, struct dentry *target)
2688{
2689 struct external_name *old_name = NULL;
2690 if (unlikely(dname_external(dentry)))
2691 old_name = external_name(dentry);
2692 if (unlikely(dname_external(target))) {
2693 atomic_inc(&external_name(target)->u.count);
2694 dentry->d_name = target->d_name;
2695 } else {
2696 memcpy(dentry->d_iname, target->d_name.name,
2697 target->d_name.len + 1);
2698 dentry->d_name.name = dentry->d_iname;
2699 dentry->d_name.hash_len = target->d_name.hash_len;
2700 }
2701 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2702 kfree_rcu(old_name, u.head);
2703}
2704
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002705static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2706{
2707 /*
2708 * XXXX: do we really need to take target->d_lock?
2709 */
2710 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2711 spin_lock(&target->d_parent->d_lock);
2712 else {
2713 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2714 spin_lock(&dentry->d_parent->d_lock);
2715 spin_lock_nested(&target->d_parent->d_lock,
2716 DENTRY_D_LOCK_NESTED);
2717 } else {
2718 spin_lock(&target->d_parent->d_lock);
2719 spin_lock_nested(&dentry->d_parent->d_lock,
2720 DENTRY_D_LOCK_NESTED);
2721 }
2722 }
2723 if (target < dentry) {
2724 spin_lock_nested(&target->d_lock, 2);
2725 spin_lock_nested(&dentry->d_lock, 3);
2726 } else {
2727 spin_lock_nested(&dentry->d_lock, 2);
2728 spin_lock_nested(&target->d_lock, 3);
2729 }
2730}
2731
Al Viro986c01942014-09-26 23:11:15 -04002732static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002733{
2734 if (target->d_parent != dentry->d_parent)
2735 spin_unlock(&dentry->d_parent->d_lock);
2736 if (target->d_parent != target)
2737 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002738 spin_unlock(&target->d_lock);
2739 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002740}
2741
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002743 * When switching names, the actual string doesn't strictly have to
2744 * be preserved in the target - because we're dropping the target
2745 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002746 * the new name before we switch, unless we are going to rehash
2747 * it. Note that if we *do* unhash the target, we are not allowed
2748 * to rehash it without giving it a new name/hash key - whether
2749 * we swap or overwrite the names here, resulting name won't match
2750 * the reality in filesystem; it's only there for d_path() purposes.
2751 * Note that all of this is happening under rename_lock, so the
2752 * any hash lookup seeing it in the middle of manipulations will
2753 * be discarded anyway. So we do not care what happens to the hash
2754 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002756/*
Al Viro18367502011-07-12 21:42:24 -04002757 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 * @dentry: entry to move
2759 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002760 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 *
2762 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002763 * dcache entries should not be moved in this way. Caller must hold
2764 * rename_lock, the i_mutex of the source and target directories,
2765 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002767static void __d_move(struct dentry *dentry, struct dentry *target,
2768 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769{
Al Viro84e710d2016-04-15 00:58:55 -04002770 struct inode *dir = NULL;
2771 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 if (!dentry->d_inode)
2773 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2774
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002775 BUG_ON(d_ancestor(dentry, target));
2776 BUG_ON(d_ancestor(target, dentry));
2777
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002778 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002779 if (unlikely(d_in_lookup(target))) {
2780 dir = target->d_parent->d_inode;
2781 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002782 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002783 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784
Nick Piggin31e6b012011-01-07 17:49:52 +11002785 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002786 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002787
Al Viro15d3c582016-07-29 17:45:21 -04002788 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002789 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002790 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791 __d_drop(target);
2792
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002794 if (exchange)
2795 swap_names(dentry, target);
2796 else
2797 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798
Al Viro15d3c582016-07-29 17:45:21 -04002799 /* rehash in new place(s) */
2800 __d_rehash(dentry);
2801 if (exchange)
2802 __d_rehash(target);
2803
Al Viro63cf4272014-09-26 23:06:14 -04002804 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002806 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002807 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 dentry->d_parent = target->d_parent;
2809 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002810 list_del_init(&target->d_child);
2811 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002813 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002814 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002815 list_move(&target->d_child, &target->d_parent->d_subdirs);
2816 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002817 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002818 fsnotify_update_flags(target);
2819 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 }
2821
Nick Piggin31e6b012011-01-07 17:49:52 +11002822 write_seqcount_end(&target->d_seq);
2823 write_seqcount_end(&dentry->d_seq);
2824
Al Viro84e710d2016-04-15 00:58:55 -04002825 if (dir)
2826 end_dir_add(dir, n);
Al Viro986c01942014-09-26 23:11:15 -04002827 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002828}
2829
2830/*
2831 * d_move - move a dentry
2832 * @dentry: entry to move
2833 * @target: new dentry
2834 *
2835 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002836 * dcache entries should not be moved in this way. See the locking
2837 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002838 */
2839void d_move(struct dentry *dentry, struct dentry *target)
2840{
2841 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002842 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002844}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002845EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846
Miklos Szeredida1ce062014-04-01 17:08:43 +02002847/*
2848 * d_exchange - exchange two dentries
2849 * @dentry1: first dentry
2850 * @dentry2: second dentry
2851 */
2852void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2853{
2854 write_seqlock(&rename_lock);
2855
2856 WARN_ON(!dentry1->d_inode);
2857 WARN_ON(!dentry2->d_inode);
2858 WARN_ON(IS_ROOT(dentry1));
2859 WARN_ON(IS_ROOT(dentry2));
2860
2861 __d_move(dentry1, dentry2, true);
2862
2863 write_sequnlock(&rename_lock);
2864}
2865
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002866/**
2867 * d_ancestor - search for an ancestor
2868 * @p1: ancestor dentry
2869 * @p2: child dentry
2870 *
2871 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2872 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002873 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002874struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002875{
2876 struct dentry *p;
2877
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002878 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002879 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002880 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002881 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002882 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002883}
2884
2885/*
2886 * This helper attempts to cope with remotely renamed directories
2887 *
2888 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002889 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002890 *
2891 * Note: If ever the locking in lock_rename() changes, then please
2892 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002893 */
Al Virob5ae6b12014-10-12 22:16:02 -04002894static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002895 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002896{
Al Viro9902af72016-04-15 15:08:36 -04002897 struct mutex *m1 = NULL;
2898 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002899 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002900
2901 /* If alias and dentry share a parent, then no extra locks required */
2902 if (alias->d_parent == dentry->d_parent)
2903 goto out_unalias;
2904
Trond Myklebust9eaef272006-10-21 10:24:20 -07002905 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002906 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2907 goto out_err;
2908 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002909 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002910 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002911 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002912out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002913 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002914 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002915out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002916 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002917 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002918 if (m1)
2919 mutex_unlock(m1);
2920 return ret;
2921}
2922
David Howells770bfad2006-08-22 20:06:07 -04002923/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002924 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2925 * @inode: the inode which may have a disconnected dentry
2926 * @dentry: a negative dentry which we want to point to the inode.
2927 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002928 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2929 * place of the given dentry and return it, else simply d_add the inode
2930 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002931 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002932 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2933 * we should error out: directories can't have multiple aliases.
2934 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002935 * This is needed in the lookup routine of any filesystem that is exportable
2936 * (via knfsd) so that we can build dcache paths to directories effectively.
2937 *
2938 * If a dentry was found and moved, then it is returned. Otherwise NULL
2939 * is returned. This matches the expected return value of ->lookup.
2940 *
2941 * Cluster filesystems may call this function with a negative, hashed dentry.
2942 * In that case, we know that the inode will be a regular file, and also this
2943 * will only occur during atomic_open. So we need to check for the dentry
2944 * being already hashed only in the final case.
2945 */
2946struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2947{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002948 if (IS_ERR(inode))
2949 return ERR_CAST(inode);
2950
David Howells770bfad2006-08-22 20:06:07 -04002951 BUG_ON(!d_unhashed(dentry));
2952
Al Virode689f52016-03-09 18:05:42 -05002953 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002954 goto out;
Al Virode689f52016-03-09 18:05:42 -05002955
Al Virob9680912016-04-11 00:53:26 -04002956 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002957 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002958 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002959 struct dentry *new = __d_find_any_alias(inode);
2960 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002961 /* The reference to new ensures it remains an alias */
2962 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002963 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002964 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002965 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002966 dput(new);
2967 new = ERR_PTR(-ELOOP);
2968 pr_warn_ratelimited(
2969 "VFS: Lookup of '%s' in %s %s"
2970 " would have caused loop\n",
2971 dentry->d_name.name,
2972 inode->i_sb->s_type->name,
2973 inode->i_sb->s_id);
2974 } else if (!IS_ROOT(new)) {
2975 int err = __d_unalias(inode, dentry, new);
2976 write_sequnlock(&rename_lock);
2977 if (err) {
2978 dput(new);
2979 new = ERR_PTR(err);
2980 }
Al Viro18367502011-07-12 21:42:24 -04002981 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002982 __d_move(new, dentry, false);
2983 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002984 }
Al Virob5ae6b12014-10-12 22:16:02 -04002985 iput(inode);
2986 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002987 }
David Howells770bfad2006-08-22 20:06:07 -04002988 }
Al Virob5ae6b12014-10-12 22:16:02 -04002989out:
Al Viroed782b52016-03-09 19:52:39 -05002990 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002991 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002992}
Al Virob5ae6b12014-10-12 22:16:02 -04002993EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002994
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002995static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002996{
2997 *buflen -= namelen;
2998 if (*buflen < 0)
2999 return -ENAMETOOLONG;
3000 *buffer -= namelen;
3001 memcpy(*buffer, str, namelen);
3002 return 0;
3003}
3004
Waiman Long232d2d62013-09-09 12:18:13 -04003005/**
3006 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003007 * @buffer: buffer pointer
3008 * @buflen: allocated length of the buffer
3009 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003010 *
3011 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3012 * make sure that either the old or the new name pointer and length are
3013 * fetched. However, there may be mismatch between length and pointer.
3014 * The length cannot be trusted, we need to copy it byte-by-byte until
3015 * the length is reached or a null byte is found. It also prepends "/" at
3016 * the beginning of the name. The sequence number check at the caller will
3017 * retry it again when a d_move() does happen. So any garbage in the buffer
3018 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003019 *
3020 * Data dependency barrier is needed to make sure that we see that terminating
3021 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003022 */
Al Viro9aba36d2016-07-20 22:28:45 -04003023static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003024{
Waiman Long232d2d62013-09-09 12:18:13 -04003025 const char *dname = ACCESS_ONCE(name->name);
3026 u32 dlen = ACCESS_ONCE(name->len);
3027 char *p;
3028
Al Viro6d13f692014-09-29 14:46:30 -04003029 smp_read_barrier_depends();
3030
Waiman Long232d2d62013-09-09 12:18:13 -04003031 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003032 if (*buflen < 0)
3033 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003034 p = *buffer -= dlen + 1;
3035 *p++ = '/';
3036 while (dlen--) {
3037 char c = *dname++;
3038 if (!c)
3039 break;
3040 *p++ = c;
3041 }
3042 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003043}
3044
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003046 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003047 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003048 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003049 * @buffer: pointer to the end of the buffer
3050 * @buflen: pointer to buffer length
3051 *
Waiman Long18129972013-09-12 10:55:35 -04003052 * The function will first try to write out the pathname without taking any
3053 * lock other than the RCU read lock to make sure that dentries won't go away.
3054 * It only checks the sequence number of the global rename_lock as any change
3055 * in the dentry's d_seq will be preceded by changes in the rename_lock
3056 * sequence number. If the sequence number had been changed, it will restart
3057 * the whole pathname back-tracing sequence again by taking the rename_lock.
3058 * In this case, there is no need to take the RCU read lock as the recursive
3059 * parent pointer references will keep the dentry chain alive as long as no
3060 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003061 */
Al Viro02125a82011-12-05 08:43:34 -05003062static int prepend_path(const struct path *path,
3063 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003064 char **buffer, int *buflen)
3065{
Al Viroede4ceb2013-11-13 07:45:40 -05003066 struct dentry *dentry;
3067 struct vfsmount *vfsmnt;
3068 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003069 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003070 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003071 char *bptr;
3072 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003073
Al Viro48f5ec22013-09-09 15:22:25 -04003074 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003075restart_mnt:
3076 read_seqbegin_or_lock(&mount_lock, &m_seq);
3077 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003078 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003079restart:
3080 bptr = *buffer;
3081 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003082 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003083 dentry = path->dentry;
3084 vfsmnt = path->mnt;
3085 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003086 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003087 while (dentry != root->dentry || vfsmnt != root->mnt) {
3088 struct dentry * parent;
3089
3090 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003091 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003092 /* Escaped? */
3093 if (dentry != vfsmnt->mnt_root) {
3094 bptr = *buffer;
3095 blen = *buflen;
3096 error = 3;
3097 break;
3098 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003099 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003100 if (mnt != parent) {
3101 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3102 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003103 vfsmnt = &mnt->mnt;
3104 continue;
3105 }
Waiman Long232d2d62013-09-09 12:18:13 -04003106 if (!error)
3107 error = is_mounted(vfsmnt) ? 1 : 2;
3108 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003109 }
3110 parent = dentry->d_parent;
3111 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003112 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003113 if (error)
3114 break;
3115
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003116 dentry = parent;
3117 }
Al Viro48f5ec22013-09-09 15:22:25 -04003118 if (!(seq & 1))
3119 rcu_read_unlock();
3120 if (need_seqretry(&rename_lock, seq)) {
3121 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003122 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003123 }
Al Viro48f5ec22013-09-09 15:22:25 -04003124 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003125
3126 if (!(m_seq & 1))
3127 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003128 if (need_seqretry(&mount_lock, m_seq)) {
3129 m_seq = 1;
3130 goto restart_mnt;
3131 }
3132 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003133
Waiman Long232d2d62013-09-09 12:18:13 -04003134 if (error >= 0 && bptr == *buffer) {
3135 if (--blen < 0)
3136 error = -ENAMETOOLONG;
3137 else
3138 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003139 }
Waiman Long232d2d62013-09-09 12:18:13 -04003140 *buffer = bptr;
3141 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003142 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003143}
3144
3145/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003146 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003147 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003148 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003149 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003150 * @buflen: buffer length
3151 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003152 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003154 * Returns a pointer into the buffer or an error code if the
3155 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003156 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003157 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003158 *
Al Viro02125a82011-12-05 08:43:34 -05003159 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160 */
Al Viro02125a82011-12-05 08:43:34 -05003161char *__d_path(const struct path *path,
3162 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003163 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003165 char *res = buf + buflen;
3166 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003169 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003170
Al Viro02125a82011-12-05 08:43:34 -05003171 if (error < 0)
3172 return ERR_PTR(error);
3173 if (error > 0)
3174 return NULL;
3175 return res;
3176}
3177
3178char *d_absolute_path(const struct path *path,
3179 char *buf, int buflen)
3180{
3181 struct path root = {};
3182 char *res = buf + buflen;
3183 int error;
3184
3185 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003186 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003187
3188 if (error > 1)
3189 error = -EINVAL;
3190 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003191 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003192 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193}
3194
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003195/*
3196 * same as __d_path but appends "(deleted)" for unlinked files.
3197 */
Al Viro02125a82011-12-05 08:43:34 -05003198static int path_with_deleted(const struct path *path,
3199 const struct path *root,
3200 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003201{
3202 prepend(buf, buflen, "\0", 1);
3203 if (d_unlinked(path->dentry)) {
3204 int error = prepend(buf, buflen, " (deleted)", 10);
3205 if (error)
3206 return error;
3207 }
3208
3209 return prepend_path(path, root, buf, buflen);
3210}
3211
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003212static int prepend_unreachable(char **buffer, int *buflen)
3213{
3214 return prepend(buffer, buflen, "(unreachable)", 13);
3215}
3216
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003217static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3218{
3219 unsigned seq;
3220
3221 do {
3222 seq = read_seqcount_begin(&fs->seq);
3223 *root = fs->root;
3224 } while (read_seqcount_retry(&fs->seq, seq));
3225}
3226
Jan Bluncka03a8a702008-02-14 19:38:32 -08003227/**
3228 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003229 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003230 * @buf: buffer to return value in
3231 * @buflen: buffer length
3232 *
3233 * Convert a dentry into an ASCII path name. If the entry has been deleted
3234 * the string " (deleted)" is appended. Note that this is ambiguous.
3235 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003236 * Returns a pointer into the buffer or an error code if the path was
3237 * too long. Note: Callers should use the returned pointer, not the passed
3238 * in buffer, to use the name! The implementation often starts at an offset
3239 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003240 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003241 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003242 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003243char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003245 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003246 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003247 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003249 /*
3250 * We have various synthetic filesystems that never get mounted. On
3251 * these filesystems dentries are never used for lookup purposes, and
3252 * thus don't need to be hashed. They also don't need a name until a
3253 * user wants to identify the object in /proc/pid/fd/. The little hack
3254 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003255 *
3256 * Some pseudo inodes are mountable. When they are mounted
3257 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3258 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003259 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003260 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3261 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003262 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003263
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003264 rcu_read_lock();
3265 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003266 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003267 rcu_read_unlock();
3268
Al Viro02125a82011-12-05 08:43:34 -05003269 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003270 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 return res;
3272}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003273EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274
3275/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003276 * Helper function for dentry_operations.d_dname() members
3277 */
3278char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3279 const char *fmt, ...)
3280{
3281 va_list args;
3282 char temp[64];
3283 int sz;
3284
3285 va_start(args, fmt);
3286 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3287 va_end(args);
3288
3289 if (sz > sizeof(temp) || sz > buflen)
3290 return ERR_PTR(-ENAMETOOLONG);
3291
3292 buffer += buflen - sz;
3293 return memcpy(buffer, temp, sz);
3294}
3295
Al Viro118b2302013-08-24 12:08:17 -04003296char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3297{
3298 char *end = buffer + buflen;
3299 /* these dentries are never renamed, so d_lock is not needed */
3300 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003301 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003302 prepend(&end, &buflen, "/", 1))
3303 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003304 return end;
Al Viro118b2302013-08-24 12:08:17 -04003305}
David Herrmann31bbe162014-01-03 14:09:47 +01003306EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003307
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003308/*
Ram Pai6092d042008-03-27 13:06:20 +01003309 * Write full pathname from the root of the filesystem into the buffer.
3310 */
Al Virof6500802014-01-26 12:37:55 -05003311static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003312{
Al Virof6500802014-01-26 12:37:55 -05003313 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003314 char *end, *retval;
3315 int len, seq = 0;
3316 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003317
Al Virof6500802014-01-26 12:37:55 -05003318 if (buflen < 2)
3319 goto Elong;
3320
Al Viro48f5ec22013-09-09 15:22:25 -04003321 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003322restart:
Al Virof6500802014-01-26 12:37:55 -05003323 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003324 end = buf + buflen;
3325 len = buflen;
3326 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003327 /* Get '/' right */
3328 retval = end-1;
3329 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003330 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003331 while (!IS_ROOT(dentry)) {
3332 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003333
Ram Pai6092d042008-03-27 13:06:20 +01003334 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003335 error = prepend_name(&end, &len, &dentry->d_name);
3336 if (error)
3337 break;
Ram Pai6092d042008-03-27 13:06:20 +01003338
3339 retval = end;
3340 dentry = parent;
3341 }
Al Viro48f5ec22013-09-09 15:22:25 -04003342 if (!(seq & 1))
3343 rcu_read_unlock();
3344 if (need_seqretry(&rename_lock, seq)) {
3345 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003346 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003347 }
3348 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003349 if (error)
3350 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003351 return retval;
3352Elong:
3353 return ERR_PTR(-ENAMETOOLONG);
3354}
Nick Pigginec2447c2011-01-07 17:49:29 +11003355
3356char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3357{
Waiman Long232d2d62013-09-09 12:18:13 -04003358 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003359}
3360EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003361
3362char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3363{
3364 char *p = NULL;
3365 char *retval;
3366
Al Viroc1031352010-06-06 22:31:14 -04003367 if (d_unlinked(dentry)) {
3368 p = buf + buflen;
3369 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3370 goto Elong;
3371 buflen++;
3372 }
3373 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003374 if (!IS_ERR(retval) && p)
3375 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003376 return retval;
3377Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003378 return ERR_PTR(-ENAMETOOLONG);
3379}
3380
Linus Torvalds8b19e342013-09-12 10:35:47 -07003381static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3382 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003383{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003384 unsigned seq;
3385
3386 do {
3387 seq = read_seqcount_begin(&fs->seq);
3388 *root = fs->root;
3389 *pwd = fs->pwd;
3390 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003391}
3392
Ram Pai6092d042008-03-27 13:06:20 +01003393/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003394 * NOTE! The user-level library version returns a
3395 * character pointer. The kernel system call just
3396 * returns the length of the buffer filled (which
3397 * includes the ending '\0' character), or a negative
3398 * error value. So libc would do something like
3399 *
3400 * char *getcwd(char * buf, size_t size)
3401 * {
3402 * int retval;
3403 *
3404 * retval = sys_getcwd(buf, size);
3405 * if (retval >= 0)
3406 * return buf;
3407 * errno = -retval;
3408 * return NULL;
3409 * }
3410 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003411SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003412{
Linus Torvalds552ce542007-02-13 12:08:18 -08003413 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003414 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003415 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003416
3417 if (!page)
3418 return -ENOMEM;
3419
Linus Torvalds8b19e342013-09-12 10:35:47 -07003420 rcu_read_lock();
3421 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003422
Linus Torvalds552ce542007-02-13 12:08:18 -08003423 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003424 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003425 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003426 char *cwd = page + PATH_MAX;
3427 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003429 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003430 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003431 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003432
Al Viro02125a82011-12-05 08:43:34 -05003433 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003434 goto out;
3435
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003436 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003437 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003438 error = prepend_unreachable(&cwd, &buflen);
3439 if (error)
3440 goto out;
3441 }
3442
Linus Torvalds552ce542007-02-13 12:08:18 -08003443 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003444 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003445 if (len <= size) {
3446 error = len;
3447 if (copy_to_user(buf, cwd, len))
3448 error = -EFAULT;
3449 }
Nick Piggin949854d2011-01-07 17:49:37 +11003450 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003451 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453
3454out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003455 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456 return error;
3457}
3458
3459/*
3460 * Test whether new_dentry is a subdirectory of old_dentry.
3461 *
3462 * Trivially implemented using the dcache structure
3463 */
3464
3465/**
3466 * is_subdir - is new dentry a subdirectory of old_dentry
3467 * @new_dentry: new dentry
3468 * @old_dentry: old dentry
3469 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003470 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3471 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003472 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3473 */
3474
Yaowei Baia6e57872015-11-17 14:40:11 +08003475bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476{
Yaowei Baia6e57872015-11-17 14:40:11 +08003477 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003478 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003480 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003481 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003482
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003483 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003484 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003486 /*
3487 * Need rcu_readlock to protect against the d_parent trashing
3488 * due to d_move
3489 */
3490 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003491 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003492 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003493 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003494 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003495 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497
3498 return result;
3499}
3500
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003501static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003503 struct dentry *root = data;
3504 if (dentry != root) {
3505 if (d_unhashed(dentry) || !dentry->d_inode)
3506 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003507
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003508 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3509 dentry->d_flags |= DCACHE_GENOCIDE;
3510 dentry->d_lockref.count--;
3511 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003513 return D_WALK_CONTINUE;
3514}
Nick Piggin58db63d2011-01-07 17:49:39 +11003515
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003516void d_genocide(struct dentry *parent)
3517{
3518 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519}
3520
Al Viro60545d02013-06-07 01:20:27 -04003521void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003522{
Al Viro60545d02013-06-07 01:20:27 -04003523 inode_dec_link_count(inode);
3524 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003525 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003526 !d_unlinked(dentry));
3527 spin_lock(&dentry->d_parent->d_lock);
3528 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3529 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3530 (unsigned long long)inode->i_ino);
3531 spin_unlock(&dentry->d_lock);
3532 spin_unlock(&dentry->d_parent->d_lock);
3533 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534}
Al Viro60545d02013-06-07 01:20:27 -04003535EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536
3537static __initdata unsigned long dhash_entries;
3538static int __init set_dhash_entries(char *str)
3539{
3540 if (!str)
3541 return 0;
3542 dhash_entries = simple_strtoul(str, &str, 0);
3543 return 1;
3544}
3545__setup("dhash_entries=", set_dhash_entries);
3546
3547static void __init dcache_init_early(void)
3548{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003549 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550
3551 /* If hashes are distributed across NUMA nodes, defer
3552 * hash allocation until vmalloc space is available.
3553 */
3554 if (hashdist)
3555 return;
3556
3557 dentry_hashtable =
3558 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003559 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003560 dhash_entries,
3561 13,
3562 HASH_EARLY,
3563 &d_hash_shift,
3564 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003565 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003566 0);
3567
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003568 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003569 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570}
3571
Denis Cheng74bf17c2007-10-16 23:26:30 -07003572static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003574 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575
3576 /*
3577 * A constructor could be added for stable state like the lists,
3578 * but it is probably not worth it because of the cache nature
3579 * of the dcache.
3580 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003581 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003582 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583
3584 /* Hash may have been set up in dcache_init_early */
3585 if (!hashdist)
3586 return;
3587
3588 dentry_hashtable =
3589 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003590 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003591 dhash_entries,
3592 13,
3593 0,
3594 &d_hash_shift,
3595 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003596 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597 0);
3598
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003599 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003600 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003601}
3602
3603/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003604struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003605EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003606
Linus Torvalds1da177e2005-04-16 15:20:36 -07003607EXPORT_SYMBOL(d_genocide);
3608
Linus Torvalds1da177e2005-04-16 15:20:36 -07003609void __init vfs_caches_init_early(void)
3610{
Sebastian Andrzej Siewior69163632017-06-27 18:19:11 +02003611 int i;
3612
3613 for (i = 0; i < ARRAY_SIZE(in_lookup_hashtable); i++)
3614 INIT_HLIST_BL_HEAD(&in_lookup_hashtable[i]);
3615
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616 dcache_init_early();
3617 inode_init_early();
3618}
3619
Mel Gorman4248b0d2015-08-06 15:46:20 -07003620void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003623 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624
Denis Cheng74bf17c2007-10-16 23:26:30 -07003625 dcache_init();
3626 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003627 files_init();
3628 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003629 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630 bdev_cache_init();
3631 chrdev_init();
3632}