blob: d5beef01cdfc25ab190e399b7827d8dec99179ad [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080041#include <linux/kasan.h>
42
David Howells07f3f052006-09-30 20:52:18 +020043#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050044#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nick Piggin789680d2011-01-07 17:49:30 +110046/*
47 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110048 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040049 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110050 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100054 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110055 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110060 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110061 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110062 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040064 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110065 *
66 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110067 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110068 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100069 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110070 * dcache_hash_bucket lock
71 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110072 *
Nick Pigginda502952011-01-07 17:49:33 +110073 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110080 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080084int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
Al Viro74c3cbe2007-07-22 08:04:18 -040087__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Nick Piggin949854d2011-01-07 17:49:37 +110089EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Christoph Lametere18b8902006-12-06 20:33:20 -080091static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700105static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106
Linus Torvalds8966be92012-03-02 14:23:30 -0800107static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700110 hash += (unsigned long) parent / L1_CACHE_BYTES;
Linus Torvalds99d263d2014-09-13 11:30:10 -0700111 return dentry_hashtable + hash_32(hash, d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100112}
113
Al Viro94bdd652016-04-15 02:42:04 -0400114#define IN_LOOKUP_SHIFT 10
115static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
116
117static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
118 unsigned int hash)
119{
120 hash += (unsigned long) parent / L1_CACHE_BYTES;
121 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
122}
123
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125/* Statistics gathering. */
126struct dentry_stat_t dentry_stat = {
127 .age_limit = 45,
128};
129
Glauber Costa3942c072013-08-28 10:17:53 +1000130static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000131static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400132
133#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000134
135/*
136 * Here we resort to our own counters instead of using generic per-cpu counters
137 * for consistency with what the vfs inode code does. We are expected to harvest
138 * better code and performance by having our own specialized counters.
139 *
140 * Please note that the loop is done over all possible CPUs, not over all online
141 * CPUs. The reason for this is that we don't want to play games with CPUs going
142 * on and off. If one of them goes off, we will just keep their counters.
143 *
144 * glommer: See cffbc8a for details, and if you ever intend to change this,
145 * please update all vfs counters to match.
146 */
Glauber Costa3942c072013-08-28 10:17:53 +1000147static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100148{
149 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000150 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100151 for_each_possible_cpu(i)
152 sum += per_cpu(nr_dentry, i);
153 return sum < 0 ? 0 : sum;
154}
155
Dave Chinner62d36c72013-08-28 10:17:54 +1000156static long get_nr_dentry_unused(void)
157{
158 int i;
159 long sum = 0;
160 for_each_possible_cpu(i)
161 sum += per_cpu(nr_dentry_unused, i);
162 return sum < 0 ? 0 : sum;
163}
164
Joe Perches1f7e0612014-06-06 14:38:05 -0700165int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400166 size_t *lenp, loff_t *ppos)
167{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100168 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000169 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000170 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400171}
172#endif
173
Linus Torvalds5483f182012-03-04 15:51:42 -0800174/*
175 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
176 * The strings are both count bytes long, and count is non-zero.
177 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700178#ifdef CONFIG_DCACHE_WORD_ACCESS
179
180#include <asm/word-at-a-time.h>
181/*
182 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
183 * aligned allocation for this particular component. We don't
184 * strictly need the load_unaligned_zeropad() safety, but it
185 * doesn't hurt either.
186 *
187 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
188 * need the careful unaligned handling.
189 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700190static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800191{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800192 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800193
194 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700195 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700196 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800197 if (tcount < sizeof(unsigned long))
198 break;
199 if (unlikely(a != b))
200 return 1;
201 cs += sizeof(unsigned long);
202 ct += sizeof(unsigned long);
203 tcount -= sizeof(unsigned long);
204 if (!tcount)
205 return 0;
206 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000207 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800208 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700209}
210
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800211#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212
Linus Torvalds94753db52012-05-10 12:19:19 -0700213static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700214{
Linus Torvalds5483f182012-03-04 15:51:42 -0800215 do {
216 if (*cs != *ct)
217 return 1;
218 cs++;
219 ct++;
220 tcount--;
221 } while (tcount);
222 return 0;
223}
224
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700225#endif
226
Linus Torvalds94753db52012-05-10 12:19:19 -0700227static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
228{
Linus Torvalds94753db52012-05-10 12:19:19 -0700229 /*
230 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000231 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700232 *
233 * NOTE! Even if a rename will mean that the length
234 * was not loaded atomically, we don't care. The
235 * RCU walk will check the sequence count eventually,
236 * and catch it. And we won't overrun the buffer,
237 * because we're reading the name pointer atomically,
238 * and a dentry name is guaranteed to be properly
239 * terminated with a NUL byte.
240 *
241 * End result: even if 'len' is wrong, we'll exit
242 * early because the data cannot match (there can
243 * be no NUL in the ct/tcount data)
244 */
He Kuangae0a8432016-03-26 09:12:10 +0000245 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
246
Linus Torvalds6326c712012-05-21 16:14:04 -0700247 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700248}
249
Al Viro8d85b482014-09-29 14:54:27 -0400250struct external_name {
251 union {
252 atomic_t count;
253 struct rcu_head head;
254 } u;
255 unsigned char name[];
256};
257
258static inline struct external_name *external_name(struct dentry *dentry)
259{
260 return container_of(dentry->d_name.name, struct external_name, name[0]);
261}
262
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400263static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400265 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
266
Al Viro8d85b482014-09-29 14:54:27 -0400267 kmem_cache_free(dentry_cache, dentry);
268}
269
270static void __d_free_external(struct rcu_head *head)
271{
272 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400273 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 kmem_cache_free(dentry_cache, dentry);
275}
276
Al Viro810bb172014-10-12 12:45:37 -0400277static inline int dname_external(const struct dentry *dentry)
278{
279 return dentry->d_name.name != dentry->d_iname;
280}
281
David Howells4bf46a22015-03-05 14:09:22 +0000282static inline void __d_set_inode_and_type(struct dentry *dentry,
283 struct inode *inode,
284 unsigned type_flags)
285{
286 unsigned flags;
287
288 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000289 flags = READ_ONCE(dentry->d_flags);
290 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
291 flags |= type_flags;
292 WRITE_ONCE(dentry->d_flags, flags);
293}
294
David Howells4bf46a22015-03-05 14:09:22 +0000295static inline void __d_clear_type_and_inode(struct dentry *dentry)
296{
297 unsigned flags = READ_ONCE(dentry->d_flags);
298
299 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
300 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000301 dentry->d_inode = NULL;
302}
303
Al Virob4f03542014-04-29 23:40:14 -0400304static void dentry_free(struct dentry *dentry)
305{
Al Viro946e51f2014-10-26 19:19:16 -0400306 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400307 if (unlikely(dname_external(dentry))) {
308 struct external_name *p = external_name(dentry);
309 if (likely(atomic_dec_and_test(&p->u.count))) {
310 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
311 return;
312 }
313 }
Al Virob4f03542014-04-29 23:40:14 -0400314 /* if dentry was never visible to RCU, immediate free is OK */
315 if (!(dentry->d_flags & DCACHE_RCUACCESS))
316 __d_free(&dentry->d_u.d_rcu);
317 else
318 call_rcu(&dentry->d_u.d_rcu, __d_free);
319}
320
Nick Piggin31e6b012011-01-07 17:49:52 +1100321/**
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200322 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800323 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100324 * After this call, in-progress rcu-walk path lookup will fail. This
325 * should be called after unhashing, and after changing d_inode (if
326 * the dentry has not already been unhashed).
327 */
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200328static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
Nick Piggin31e6b012011-01-07 17:49:52 +1100329{
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200330 lockdep_assert_held(&dentry->d_lock);
331 /* Go through am invalidation barrier */
332 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100333}
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335/*
336 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400337 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100338 */
339static void dentry_unlink_inode(struct dentry * dentry)
340 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100341 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100342{
343 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400344 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500345
Al Viro550dce02016-05-29 20:13:30 -0400346 if (hashed)
347 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000348 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400349 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400350 if (hashed)
351 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100352 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100353 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100354 if (!inode->i_nlink)
355 fsnotify_inoderemove(inode);
356 if (dentry->d_op && dentry->d_op->d_iput)
357 dentry->d_op->d_iput(dentry, inode);
358 else
359 iput(inode);
360}
361
362/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400363 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
364 * is in use - which includes both the "real" per-superblock
365 * LRU list _and_ the DCACHE_SHRINK_LIST use.
366 *
367 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
368 * on the shrink list (ie not on the superblock LRU list).
369 *
370 * The per-cpu "nr_dentry_unused" counters are updated with
371 * the DCACHE_LRU_LIST bit.
372 *
373 * These helper functions make sure we always follow the
374 * rules. d_lock must be held by the caller.
375 */
376#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
377static void d_lru_add(struct dentry *dentry)
378{
379 D_FLAG_VERIFY(dentry, 0);
380 dentry->d_flags |= DCACHE_LRU_LIST;
381 this_cpu_inc(nr_dentry_unused);
382 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
383}
384
385static void d_lru_del(struct dentry *dentry)
386{
387 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
388 dentry->d_flags &= ~DCACHE_LRU_LIST;
389 this_cpu_dec(nr_dentry_unused);
390 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
391}
392
393static void d_shrink_del(struct dentry *dentry)
394{
395 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
396 list_del_init(&dentry->d_lru);
397 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
398 this_cpu_dec(nr_dentry_unused);
399}
400
401static void d_shrink_add(struct dentry *dentry, struct list_head *list)
402{
403 D_FLAG_VERIFY(dentry, 0);
404 list_add(&dentry->d_lru, list);
405 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
406 this_cpu_inc(nr_dentry_unused);
407}
408
409/*
410 * These can only be called under the global LRU lock, ie during the
411 * callback for freeing the LRU list. "isolate" removes it from the
412 * LRU lists entirely, while shrink_move moves it to the indicated
413 * private list.
414 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800415static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400416{
417 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
418 dentry->d_flags &= ~DCACHE_LRU_LIST;
419 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800420 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400421}
422
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800423static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
424 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400425{
426 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
427 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800428 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400429}
430
431/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000432 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700433 */
434static void dentry_lru_add(struct dentry *dentry)
435{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400436 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
437 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700438}
439
Miklos Szeredid52b9082007-05-08 00:23:46 -0700440/**
Nick Piggin789680d2011-01-07 17:49:30 +1100441 * d_drop - drop a dentry
442 * @dentry: dentry to drop
443 *
444 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
445 * be found through a VFS lookup any more. Note that this is different from
446 * deleting the dentry - d_delete will try to mark the dentry negative if
447 * possible, giving a successful _negative_ lookup, while d_drop will
448 * just make the cache lookup fail.
449 *
450 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
451 * reason (NFS timeouts or autofs deletes).
452 *
453 * __d_drop requires dentry->d_lock.
454 */
455void __d_drop(struct dentry *dentry)
456{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700457 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400458 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400459 /*
460 * Hashed dentries are normally on the dentry hashtable,
461 * with the exception of those newly allocated by
462 * d_obtain_alias, which are always IS_ROOT:
463 */
464 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400465 b = &dentry->d_sb->s_anon;
466 else
467 b = d_hash(dentry->d_parent, dentry->d_name.hash);
468
469 hlist_bl_lock(b);
470 __hlist_bl_del(&dentry->d_hash);
471 dentry->d_hash.pprev = NULL;
472 hlist_bl_unlock(b);
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200473 dentry_rcuwalk_invalidate(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100474 }
475}
476EXPORT_SYMBOL(__d_drop);
477
478void d_drop(struct dentry *dentry)
479{
Nick Piggin789680d2011-01-07 17:49:30 +1100480 spin_lock(&dentry->d_lock);
481 __d_drop(dentry);
482 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100483}
484EXPORT_SYMBOL(d_drop);
485
Al Viroba65dc52016-06-10 11:32:47 -0400486static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
487{
488 struct dentry *next;
489 /*
490 * Inform d_walk() and shrink_dentry_list() that we are no longer
491 * attached to the dentry tree
492 */
493 dentry->d_flags |= DCACHE_DENTRY_KILLED;
494 if (unlikely(list_empty(&dentry->d_child)))
495 return;
496 __list_del_entry(&dentry->d_child);
497 /*
498 * Cursors can move around the list of children. While we'd been
499 * a normal list member, it didn't matter - ->d_child.next would've
500 * been updated. However, from now on it won't be and for the
501 * things like d_walk() it might end up with a nasty surprise.
502 * Normally d_walk() doesn't care about cursors moving around -
503 * ->d_lock on parent prevents that and since a cursor has no children
504 * of its own, we get through it without ever unlocking the parent.
505 * There is one exception, though - if we ascend from a child that
506 * gets killed as soon as we unlock it, the next sibling is found
507 * using the value left in its ->d_child.next. And if _that_
508 * pointed to a cursor, and cursor got moved (e.g. by lseek())
509 * before d_walk() regains parent->d_lock, we'll end up skipping
510 * everything the cursor had been moved past.
511 *
512 * Solution: make sure that the pointer left behind in ->d_child.next
513 * points to something that won't be moving around. I.e. skip the
514 * cursors.
515 */
516 while (dentry->d_child.next != &parent->d_subdirs) {
517 next = list_entry(dentry->d_child.next, struct dentry, d_child);
518 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
519 break;
520 dentry->d_child.next = next->d_child.next;
521 }
522}
523
Al Viroe55fd012014-05-28 13:51:12 -0400524static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100525{
Al Viro41edf272014-05-01 10:30:00 -0400526 struct dentry *parent = NULL;
527 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400528 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100529 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100530
Linus Torvalds0d984392013-09-08 13:46:52 -0700531 /*
532 * The dentry is now unrecoverably dead to the world.
533 */
534 lockref_mark_dead(&dentry->d_lockref);
535
Sage Weilf0023bc2011-10-28 10:02:42 -0700536 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700537 * inform the fs via d_prune that this dentry is about to be
538 * unhashed and destroyed.
539 */
Al Viro29266202014-05-30 11:39:02 -0400540 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800541 dentry->d_op->d_prune(dentry);
542
Al Viro01b60352014-04-29 23:42:52 -0400543 if (dentry->d_flags & DCACHE_LRU_LIST) {
544 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
545 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400546 }
Nick Piggin77812a12011-01-07 17:49:48 +1100547 /* if it was on the hash then remove it */
548 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400549 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400550 if (parent)
551 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400552 if (dentry->d_inode)
553 dentry_unlink_inode(dentry);
554 else
555 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400556 this_cpu_dec(nr_dentry);
557 if (dentry->d_op && dentry->d_op->d_release)
558 dentry->d_op->d_release(dentry);
559
Al Viro41edf272014-05-01 10:30:00 -0400560 spin_lock(&dentry->d_lock);
561 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
562 dentry->d_flags |= DCACHE_MAY_FREE;
563 can_free = false;
564 }
565 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400566 if (likely(can_free))
567 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400568}
569
570/*
571 * Finish off a dentry we've decided to kill.
572 * dentry->d_lock must be held, returns with it unlocked.
573 * If ref is non-zero, then decrement the refcount too.
574 * Returns dentry requiring refcount drop, or NULL if we're done.
575 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400576static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400577 __releases(dentry->d_lock)
578{
579 struct inode *inode = dentry->d_inode;
580 struct dentry *parent = NULL;
581
582 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
583 goto failed;
584
585 if (!IS_ROOT(dentry)) {
586 parent = dentry->d_parent;
587 if (unlikely(!spin_trylock(&parent->d_lock))) {
588 if (inode)
589 spin_unlock(&inode->i_lock);
590 goto failed;
591 }
592 }
593
594 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400595 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400596
597failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400598 spin_unlock(&dentry->d_lock);
599 cpu_relax();
Al Viroe55fd012014-05-28 13:51:12 -0400600 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100601}
602
Al Viro046b9612014-05-29 08:54:52 -0400603static inline struct dentry *lock_parent(struct dentry *dentry)
604{
605 struct dentry *parent = dentry->d_parent;
606 if (IS_ROOT(dentry))
607 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800608 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400609 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400610 if (likely(spin_trylock(&parent->d_lock)))
611 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400612 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400613 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400614again:
615 parent = ACCESS_ONCE(dentry->d_parent);
616 spin_lock(&parent->d_lock);
617 /*
618 * We can't blindly lock dentry until we are sure
619 * that we won't violate the locking order.
620 * Any changes of dentry->d_parent must have
621 * been done with parent->d_lock held, so
622 * spin_lock() above is enough of a barrier
623 * for checking if it's still our child.
624 */
625 if (unlikely(parent != dentry->d_parent)) {
626 spin_unlock(&parent->d_lock);
627 goto again;
628 }
629 rcu_read_unlock();
630 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700631 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400632 else
633 parent = NULL;
634 return parent;
635}
636
Linus Torvalds360f5472015-01-09 15:19:03 -0800637/*
638 * Try to do a lockless dput(), and return whether that was successful.
639 *
640 * If unsuccessful, we return false, having already taken the dentry lock.
641 *
642 * The caller needs to hold the RCU read lock, so that the dentry is
643 * guaranteed to stay around even if the refcount goes down to zero!
644 */
645static inline bool fast_dput(struct dentry *dentry)
646{
647 int ret;
648 unsigned int d_flags;
649
650 /*
651 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100652 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800653 */
654 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
655 return lockref_put_or_lock(&dentry->d_lockref);
656
657 /*
658 * .. otherwise, we can try to just decrement the
659 * lockref optimistically.
660 */
661 ret = lockref_put_return(&dentry->d_lockref);
662
663 /*
664 * If the lockref_put_return() failed due to the lock being held
665 * by somebody else, the fast path has failed. We will need to
666 * get the lock, and then check the count again.
667 */
668 if (unlikely(ret < 0)) {
669 spin_lock(&dentry->d_lock);
670 if (dentry->d_lockref.count > 1) {
671 dentry->d_lockref.count--;
672 spin_unlock(&dentry->d_lock);
673 return 1;
674 }
675 return 0;
676 }
677
678 /*
679 * If we weren't the last ref, we're done.
680 */
681 if (ret)
682 return 1;
683
684 /*
685 * Careful, careful. The reference count went down
686 * to zero, but we don't hold the dentry lock, so
687 * somebody else could get it again, and do another
688 * dput(), and we need to not race with that.
689 *
690 * However, there is a very special and common case
691 * where we don't care, because there is nothing to
692 * do: the dentry is still hashed, it does not have
693 * a 'delete' op, and it's referenced and already on
694 * the LRU list.
695 *
696 * NOTE! Since we aren't locked, these values are
697 * not "stable". However, it is sufficient that at
698 * some point after we dropped the reference the
699 * dentry was hashed and the flags had the proper
700 * value. Other dentry users may have re-gotten
701 * a reference to the dentry and change that, but
702 * our work is done - we can leave the dentry
703 * around with a zero refcount.
704 */
705 smp_rmb();
706 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100707 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800708
709 /* Nothing to do? Dropping the reference was all we needed? */
710 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
711 return 1;
712
713 /*
714 * Not the fast normal case? Get the lock. We've already decremented
715 * the refcount, but we'll need to re-check the situation after
716 * getting the lock.
717 */
718 spin_lock(&dentry->d_lock);
719
720 /*
721 * Did somebody else grab a reference to it in the meantime, and
722 * we're no longer the last user after all? Alternatively, somebody
723 * else could have killed it and marked it dead. Either way, we
724 * don't need to do anything else.
725 */
726 if (dentry->d_lockref.count) {
727 spin_unlock(&dentry->d_lock);
728 return 1;
729 }
730
731 /*
732 * Re-get the reference we optimistically dropped. We hold the
733 * lock, and we just tested that it was zero, so we can just
734 * set it to 1.
735 */
736 dentry->d_lockref.count = 1;
737 return 0;
738}
739
740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741/*
742 * This is dput
743 *
744 * This is complicated by the fact that we do not want to put
745 * dentries that are no longer on any hash chain on the unused
746 * list: we'd much rather just get rid of them immediately.
747 *
748 * However, that implies that we have to traverse the dentry
749 * tree upwards to the parents which might _also_ now be
750 * scheduled for deletion (it may have been only waiting for
751 * its last child to go away).
752 *
753 * This tail recursion is done by hand as we don't want to depend
754 * on the compiler to always get this right (gcc generally doesn't).
755 * Real recursion would eat up our stack space.
756 */
757
758/*
759 * dput - release a dentry
760 * @dentry: dentry to release
761 *
762 * Release a dentry. This will drop the usage count and if appropriate
763 * call the dentry unlink method as well as removing it from the queues and
764 * releasing its resources. If the parent dentries were scheduled for release
765 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767void dput(struct dentry *dentry)
768{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700769 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return;
771
772repeat:
Linus Torvalds360f5472015-01-09 15:19:03 -0800773 rcu_read_lock();
774 if (likely(fast_dput(dentry))) {
775 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800777 }
778
779 /* Slow case: now with the dentry lock held */
780 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Al Viro85c7f812016-04-14 19:52:13 -0400782 WARN_ON(d_in_lookup(dentry));
783
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700784 /* Unreachable? Get rid of it */
785 if (unlikely(d_unhashed(dentry)))
786 goto kill_it;
787
Al Viro75a6f822015-07-08 02:42:38 +0100788 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
789 goto kill_it;
790
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700791 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100793 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 }
Nick Piggin265ac902010-10-10 05:36:24 -0400795
Linus Torvalds358eec12013-10-31 15:43:02 -0700796 if (!(dentry->d_flags & DCACHE_REFERENCED))
797 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400798 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400799
Waiman Long98474232013-08-28 18:24:59 -0700800 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100801 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 return;
803
Miklos Szeredid52b9082007-05-08 00:23:46 -0700804kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400805 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700806 if (dentry)
807 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700809EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100812/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100813static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814{
Waiman Long98474232013-08-28 18:24:59 -0700815 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
817
Nick Piggindc0474b2011-01-07 17:49:43 +1100818static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100819{
Waiman Long98474232013-08-28 18:24:59 -0700820 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100821}
822
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100823struct dentry *dget_parent(struct dentry *dentry)
824{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700825 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100826 struct dentry *ret;
827
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700828 /*
829 * Do optimistic parent lookup without any
830 * locking.
831 */
832 rcu_read_lock();
833 ret = ACCESS_ONCE(dentry->d_parent);
834 gotref = lockref_get_not_zero(&ret->d_lockref);
835 rcu_read_unlock();
836 if (likely(gotref)) {
837 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
838 return ret;
839 dput(ret);
840 }
841
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100842repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100843 /*
844 * Don't need rcu_dereference because we re-check it was correct under
845 * the lock.
846 */
847 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100848 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100849 spin_lock(&ret->d_lock);
850 if (unlikely(ret != dentry->d_parent)) {
851 spin_unlock(&ret->d_lock);
852 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100853 goto repeat;
854 }
Nick Piggina734eb42011-01-07 17:49:44 +1100855 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700856 BUG_ON(!ret->d_lockref.count);
857 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100858 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100859 return ret;
860}
861EXPORT_SYMBOL(dget_parent);
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863/**
864 * d_find_alias - grab a hashed alias of inode
865 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 *
867 * If inode has a hashed alias, or is a directory and has any alias,
868 * acquire the reference to alias and return it. Otherwise return NULL.
869 * Notice that if inode is a directory there can be only one alias and
870 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800871 * of a filesystem, or if the directory was renamed and d_revalidate
872 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700874 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500875 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500877static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878{
Nick Pigginda502952011-01-07 17:49:33 +1100879 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Nick Pigginda502952011-01-07 17:49:33 +1100881again:
882 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400883 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100884 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700886 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100887 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500889 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100890 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100891 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 return alias;
893 }
894 }
Nick Pigginda502952011-01-07 17:49:33 +1100895 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 }
Nick Pigginda502952011-01-07 17:49:33 +1100897 if (discon_alias) {
898 alias = discon_alias;
899 spin_lock(&alias->d_lock);
900 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500901 __dget_dlock(alias);
902 spin_unlock(&alias->d_lock);
903 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100904 }
905 spin_unlock(&alias->d_lock);
906 goto again;
907 }
908 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909}
910
Nick Pigginda502952011-01-07 17:49:33 +1100911struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
David Howells214fda12006-03-25 03:06:36 -0800913 struct dentry *de = NULL;
914
Al Virob3d9b7a2012-06-09 13:51:19 -0400915 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100916 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500917 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100918 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800919 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 return de;
921}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700922EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
924/*
925 * Try to kill dentries associated with this inode.
926 * WARNING: you must own a reference to inode.
927 */
928void d_prune_aliases(struct inode *inode)
929{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700930 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100932 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400933 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700935 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400936 struct dentry *parent = lock_parent(dentry);
937 if (likely(!dentry->d_lockref.count)) {
938 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800939 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400940 goto restart;
941 }
942 if (parent)
943 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 }
945 spin_unlock(&dentry->d_lock);
946 }
Nick Piggin873feea2011-01-07 17:50:06 +1100947 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700949EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400951static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952{
Al Viro5c47e6d2014-04-29 16:13:18 -0400953 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700954
Miklos Szeredi60942f22014-05-02 15:38:39 -0400955 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400956 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400957 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100958 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400959 parent = lock_parent(dentry);
960
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000962 * The dispose list is isolated and dentries are not accounted
963 * to the LRU here, so we can simply remove it from the list
964 * here regardless of whether it is referenced or not.
965 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400966 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000967
968 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000970 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800972 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700973 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400974 if (parent)
975 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 continue;
977 }
Nick Piggin77812a12011-01-07 17:49:48 +1100978
Al Viro64fd72e2014-05-28 09:48:44 -0400979
980 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
981 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
982 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400983 if (parent)
984 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400985 if (can_free)
986 dentry_free(dentry);
987 continue;
988 }
989
Al Viroff2fde92014-05-28 13:59:13 -0400990 inode = dentry->d_inode;
991 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400992 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000993 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400994 if (parent)
995 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400996 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000997 }
Al Viroff2fde92014-05-28 13:59:13 -0400998
Al Viroff2fde92014-05-28 13:59:13 -0400999 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001000
Al Viro5c47e6d2014-04-29 16:13:18 -04001001 /*
1002 * We need to prune ancestors too. This is necessary to prevent
1003 * quadratic behavior of shrink_dcache_parent(), but is also
1004 * expected to be beneficial in reducing dentry cache
1005 * fragmentation.
1006 */
1007 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001008 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1009 parent = lock_parent(dentry);
1010 if (dentry->d_lockref.count != 1) {
1011 dentry->d_lockref.count--;
1012 spin_unlock(&dentry->d_lock);
1013 if (parent)
1014 spin_unlock(&parent->d_lock);
1015 break;
1016 }
1017 inode = dentry->d_inode; /* can't be NULL */
1018 if (unlikely(!spin_trylock(&inode->i_lock))) {
1019 spin_unlock(&dentry->d_lock);
1020 if (parent)
1021 spin_unlock(&parent->d_lock);
1022 cpu_relax();
1023 continue;
1024 }
1025 __dentry_kill(dentry);
1026 dentry = parent;
1027 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001029}
1030
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001031static enum lru_status dentry_lru_isolate(struct list_head *item,
1032 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001033{
1034 struct list_head *freeable = arg;
1035 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1036
1037
1038 /*
1039 * we are inverting the lru lock/dentry->d_lock here,
1040 * so use a trylock. If we fail to get the lock, just skip
1041 * it
1042 */
1043 if (!spin_trylock(&dentry->d_lock))
1044 return LRU_SKIP;
1045
1046 /*
1047 * Referenced dentries are still in use. If they have active
1048 * counts, just remove them from the LRU. Otherwise give them
1049 * another pass through the LRU.
1050 */
1051 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001052 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001053 spin_unlock(&dentry->d_lock);
1054 return LRU_REMOVED;
1055 }
1056
1057 if (dentry->d_flags & DCACHE_REFERENCED) {
1058 dentry->d_flags &= ~DCACHE_REFERENCED;
1059 spin_unlock(&dentry->d_lock);
1060
1061 /*
1062 * The list move itself will be made by the common LRU code. At
1063 * this point, we've dropped the dentry->d_lock but keep the
1064 * lru lock. This is safe to do, since every list movement is
1065 * protected by the lru lock even if both locks are held.
1066 *
1067 * This is guaranteed by the fact that all LRU management
1068 * functions are intermediated by the LRU API calls like
1069 * list_lru_add and list_lru_del. List movement in this file
1070 * only ever occur through this functions or through callbacks
1071 * like this one, that are called from the LRU API.
1072 *
1073 * The only exceptions to this are functions like
1074 * shrink_dentry_list, and code that first checks for the
1075 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1076 * operating only with stack provided lists after they are
1077 * properly isolated from the main list. It is thus, always a
1078 * local access.
1079 */
1080 return LRU_ROTATE;
1081 }
1082
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001083 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001084 spin_unlock(&dentry->d_lock);
1085
1086 return LRU_REMOVED;
1087}
1088
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001089/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001090 * prune_dcache_sb - shrink the dcache
1091 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001092 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001094 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1095 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001096 * function.
1097 *
1098 * This function may fail to free any resources if all the dentries are in
1099 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001100 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001101long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001102{
Dave Chinnerf6041562013-08-28 10:18:00 +10001103 LIST_HEAD(dispose);
1104 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001105
Vladimir Davydov503c3582015-02-12 14:58:47 -08001106 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1107 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001108 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001109 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110}
1111
Glauber Costa4e717f52013-08-28 10:18:03 +10001112static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001113 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001114{
Glauber Costa4e717f52013-08-28 10:18:03 +10001115 struct list_head *freeable = arg;
1116 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001117
Glauber Costa4e717f52013-08-28 10:18:03 +10001118 /*
1119 * we are inverting the lru lock/dentry->d_lock here,
1120 * so use a trylock. If we fail to get the lock, just skip
1121 * it
1122 */
1123 if (!spin_trylock(&dentry->d_lock))
1124 return LRU_SKIP;
1125
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001126 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001127 spin_unlock(&dentry->d_lock);
1128
1129 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001130}
1131
Glauber Costa4e717f52013-08-28 10:18:03 +10001132
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001133/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 * shrink_dcache_sb - shrink dcache for a superblock
1135 * @sb: superblock
1136 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001137 * Shrink the dcache for the specified super block. This is used to free
1138 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001140void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141{
Glauber Costa4e717f52013-08-28 10:18:03 +10001142 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001143
Glauber Costa4e717f52013-08-28 10:18:03 +10001144 do {
1145 LIST_HEAD(dispose);
1146
1147 freed = list_lru_walk(&sb->s_dentry_lru,
1148 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1149
1150 this_cpu_sub(nr_dentry_unused, freed);
1151 shrink_dentry_list(&dispose);
1152 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001154EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001157 * enum d_walk_ret - action to talke during tree walk
1158 * @D_WALK_CONTINUE: contrinue walk
1159 * @D_WALK_QUIT: quit walk
1160 * @D_WALK_NORETRY: quit when retry is needed
1161 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001163enum d_walk_ret {
1164 D_WALK_CONTINUE,
1165 D_WALK_QUIT,
1166 D_WALK_NORETRY,
1167 D_WALK_SKIP,
1168};
1169
1170/**
1171 * d_walk - walk the dentry tree
1172 * @parent: start of walk
1173 * @data: data passed to @enter() and @finish()
1174 * @enter: callback when first entering the dentry
1175 * @finish: callback when successfully finished the walk
1176 *
1177 * The @enter() and @finish() callbacks are called with d_lock held.
1178 */
1179static void d_walk(struct dentry *parent, void *data,
1180 enum d_walk_ret (*enter)(void *, struct dentry *),
1181 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182{
Nick Piggin949854d2011-01-07 17:49:37 +11001183 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001185 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001186 enum d_walk_ret ret;
1187 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001188
Nick Piggin58db63d2011-01-07 17:49:39 +11001189again:
Al Viro48f5ec22013-09-09 15:22:25 -04001190 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001191 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001192 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001193
1194 ret = enter(data, this_parent);
1195 switch (ret) {
1196 case D_WALK_CONTINUE:
1197 break;
1198 case D_WALK_QUIT:
1199 case D_WALK_SKIP:
1200 goto out_unlock;
1201 case D_WALK_NORETRY:
1202 retry = false;
1203 break;
1204 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205repeat:
1206 next = this_parent->d_subdirs.next;
1207resume:
1208 while (next != &this_parent->d_subdirs) {
1209 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001210 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001212
Al Viroba65dc52016-06-10 11:32:47 -04001213 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1214 continue;
1215
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001216 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001217
1218 ret = enter(data, dentry);
1219 switch (ret) {
1220 case D_WALK_CONTINUE:
1221 break;
1222 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001223 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001224 goto out_unlock;
1225 case D_WALK_NORETRY:
1226 retry = false;
1227 break;
1228 case D_WALK_SKIP:
1229 spin_unlock(&dentry->d_lock);
1230 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001231 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001232
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001234 spin_unlock(&this_parent->d_lock);
1235 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001237 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 goto repeat;
1239 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001240 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 }
1242 /*
1243 * All done at this level ... ascend and resume the search.
1244 */
Al Viroca5358e2014-10-26 19:31:10 -04001245 rcu_read_lock();
1246ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001248 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001249 this_parent = child->d_parent;
1250
Al Viro31dec132013-10-25 17:04:27 -04001251 spin_unlock(&child->d_lock);
1252 spin_lock(&this_parent->d_lock);
1253
Al Viroca5358e2014-10-26 19:31:10 -04001254 /* might go back up the wrong parent if we have had a rename. */
1255 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001256 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001257 /* go into the first sibling still alive */
1258 do {
1259 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001260 if (next == &this_parent->d_subdirs)
1261 goto ascend;
1262 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001263 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001264 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 goto resume;
1266 }
Al Viroca5358e2014-10-26 19:31:10 -04001267 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001268 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001269 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001270 if (finish)
1271 finish(data);
1272
1273out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001274 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001275 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001276 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001277
1278rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001279 spin_unlock(&this_parent->d_lock);
1280 rcu_read_unlock();
1281 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001282 if (!retry)
1283 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001284 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001285 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001287
1288/*
1289 * Search for at least 1 mount point in the dentry's subdirs.
1290 * We descend to the next level whenever the d_subdirs
1291 * list is non-empty and continue searching.
1292 */
1293
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001294static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1295{
1296 int *ret = data;
1297 if (d_mountpoint(dentry)) {
1298 *ret = 1;
1299 return D_WALK_QUIT;
1300 }
1301 return D_WALK_CONTINUE;
1302}
1303
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001304/**
1305 * have_submounts - check for mounts over a dentry
1306 * @parent: dentry to check.
1307 *
1308 * Return true if the parent or its subdirectories contain
1309 * a mount point
1310 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001311int have_submounts(struct dentry *parent)
1312{
1313 int ret = 0;
1314
1315 d_walk(parent, &ret, check_mount, NULL);
1316
1317 return ret;
1318}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001319EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
1321/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001322 * Called by mount code to set a mountpoint and check if the mountpoint is
1323 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1324 * subtree can become unreachable).
1325 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001326 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001327 * this reason take rename_lock and d_lock on dentry and ancestors.
1328 */
1329int d_set_mounted(struct dentry *dentry)
1330{
1331 struct dentry *p;
1332 int ret = -ENOENT;
1333 write_seqlock(&rename_lock);
1334 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001335 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001336 spin_lock(&p->d_lock);
1337 if (unlikely(d_unhashed(p))) {
1338 spin_unlock(&p->d_lock);
1339 goto out;
1340 }
1341 spin_unlock(&p->d_lock);
1342 }
1343 spin_lock(&dentry->d_lock);
1344 if (!d_unlinked(dentry)) {
1345 dentry->d_flags |= DCACHE_MOUNTED;
1346 ret = 0;
1347 }
1348 spin_unlock(&dentry->d_lock);
1349out:
1350 write_sequnlock(&rename_lock);
1351 return ret;
1352}
1353
1354/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001355 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 * and move any unused dentries to the end of the unused
1357 * list for prune_dcache(). We descend to the next level
1358 * whenever the d_subdirs list is non-empty and continue
1359 * searching.
1360 *
1361 * It returns zero iff there are no unused children,
1362 * otherwise it returns the number of children moved to
1363 * the end of the unused list. This may not be the total
1364 * number of unused children, because select_parent can
1365 * drop the lock and return early due to latency
1366 * constraints.
1367 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001368
1369struct select_data {
1370 struct dentry *start;
1371 struct list_head dispose;
1372 int found;
1373};
1374
1375static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001377 struct select_data *data = _data;
1378 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001380 if (data->start == dentry)
1381 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
Al Virofe915222014-05-03 00:02:25 -04001383 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001384 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001385 } else {
1386 if (dentry->d_flags & DCACHE_LRU_LIST)
1387 d_lru_del(dentry);
1388 if (!dentry->d_lockref.count) {
1389 d_shrink_add(dentry, &data->dispose);
1390 data->found++;
1391 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 }
1393 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001394 * We can return to the caller if we have found some (this
1395 * ensures forward progress). We'll be coming back to find
1396 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 */
Al Virofe915222014-05-03 00:02:25 -04001398 if (!list_empty(&data->dispose))
1399 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001401 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
1403
1404/**
1405 * shrink_dcache_parent - prune dcache
1406 * @parent: parent of entries to prune
1407 *
1408 * Prune the dcache to remove unused children of the parent dentry.
1409 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001410void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001412 for (;;) {
1413 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001415 INIT_LIST_HEAD(&data.dispose);
1416 data.start = parent;
1417 data.found = 0;
1418
1419 d_walk(parent, &data, select_collect, NULL);
1420 if (!data.found)
1421 break;
1422
1423 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001424 cond_resched();
1425 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001427EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Al Viro9c8c10e2014-05-02 20:36:10 -04001429static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001430{
Al Viro9c8c10e2014-05-02 20:36:10 -04001431 /* it has busy descendents; complain about those instead */
1432 if (!list_empty(&dentry->d_subdirs))
1433 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001434
Al Viro9c8c10e2014-05-02 20:36:10 -04001435 /* root with refcount 1 is fine */
1436 if (dentry == _data && dentry->d_lockref.count == 1)
1437 return D_WALK_CONTINUE;
1438
1439 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1440 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001441 dentry,
1442 dentry->d_inode ?
1443 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001444 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001445 dentry->d_lockref.count,
1446 dentry->d_sb->s_type->name,
1447 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001448 WARN_ON(1);
1449 return D_WALK_CONTINUE;
1450}
1451
1452static void do_one_tree(struct dentry *dentry)
1453{
1454 shrink_dcache_parent(dentry);
1455 d_walk(dentry, dentry, umount_check, NULL);
1456 d_drop(dentry);
1457 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001458}
1459
1460/*
1461 * destroy the dentries attached to a superblock on unmounting
1462 */
1463void shrink_dcache_for_umount(struct super_block *sb)
1464{
1465 struct dentry *dentry;
1466
Al Viro9c8c10e2014-05-02 20:36:10 -04001467 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001468
1469 dentry = sb->s_root;
1470 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001471 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001472
1473 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001474 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1475 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001476 }
1477}
1478
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001479struct detach_data {
1480 struct select_data select;
1481 struct dentry *mountpoint;
1482};
1483static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001484{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001485 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001486
1487 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001488 __dget_dlock(dentry);
1489 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001490 return D_WALK_QUIT;
1491 }
1492
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001493 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001494}
1495
1496static void check_and_drop(void *_data)
1497{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001498 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001499
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001500 if (!data->mountpoint && !data->select.found)
1501 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001502}
1503
1504/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001505 * d_invalidate - detach submounts, prune dcache, and drop
1506 * @dentry: dentry to invalidate (aka detach, prune and drop)
1507 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001508 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001509 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001510 * The final d_drop is done as an atomic operation relative to
1511 * rename_lock ensuring there are no races with d_set_mounted. This
1512 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001513 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001514void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001515{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001516 /*
1517 * If it's already been dropped, return OK.
1518 */
1519 spin_lock(&dentry->d_lock);
1520 if (d_unhashed(dentry)) {
1521 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001522 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001523 }
1524 spin_unlock(&dentry->d_lock);
1525
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001526 /* Negative dentries can be dropped without further checks */
1527 if (!dentry->d_inode) {
1528 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001529 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001530 }
1531
1532 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001533 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001534
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001535 data.mountpoint = NULL;
1536 INIT_LIST_HEAD(&data.select.dispose);
1537 data.select.start = dentry;
1538 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001539
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001540 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001541
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001542 if (data.select.found)
1543 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001544
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001545 if (data.mountpoint) {
1546 detach_mounts(data.mountpoint);
1547 dput(data.mountpoint);
1548 }
1549
1550 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001551 break;
1552
1553 cond_resched();
1554 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001556EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558/**
Al Viroa4464db2011-07-07 15:03:58 -04001559 * __d_alloc - allocate a dcache entry
1560 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 * @name: qstr of the name
1562 *
1563 * Allocates a dentry. It returns %NULL if there is insufficient memory
1564 * available. On a success the dentry is returned. The name passed in is
1565 * copied and the copy passed in may be reused after this call.
1566 */
1567
Al Viroa4464db2011-07-07 15:03:58 -04001568struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569{
1570 struct dentry *dentry;
1571 char *dname;
1572
Mel Gormane12ba742007-10-16 01:25:52 -07001573 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 if (!dentry)
1575 return NULL;
1576
Linus Torvalds6326c712012-05-21 16:14:04 -07001577 /*
1578 * We guarantee that the inline name is always NUL-terminated.
1579 * This way the memcpy() done by the name switching in rename
1580 * will still always have a NUL at the end, even if we might
1581 * be overwriting an internal NUL character
1582 */
1583 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001584 if (unlikely(!name)) {
1585 static const struct qstr anon = QSTR_INIT("/", 1);
1586 name = &anon;
1587 dname = dentry->d_iname;
1588 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001589 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001590 struct external_name *p = kmalloc(size + name->len,
1591 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001592 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 kmem_cache_free(dentry_cache, dentry);
1594 return NULL;
1595 }
Al Viro8d85b482014-09-29 14:54:27 -04001596 atomic_set(&p->u.count, 1);
1597 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001598 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1599 kasan_unpoison_shadow(dname,
1600 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 } else {
1602 dname = dentry->d_iname;
1603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605 dentry->d_name.len = name->len;
1606 dentry->d_name.hash = name->hash;
1607 memcpy(dname, name->name, name->len);
1608 dname[name->len] = 0;
1609
Linus Torvalds6326c712012-05-21 16:14:04 -07001610 /* Make sure we always see the terminating NUL character */
1611 smp_wmb();
1612 dentry->d_name.name = dname;
1613
Waiman Long98474232013-08-28 18:24:59 -07001614 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001615 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001617 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001619 dentry->d_parent = dentry;
1620 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 dentry->d_op = NULL;
1622 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001623 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 INIT_LIST_HEAD(&dentry->d_lru);
1625 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001626 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1627 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001628 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Nick Piggin3e880fb2011-01-07 17:49:19 +11001630 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 return dentry;
1633}
Al Viroa4464db2011-07-07 15:03:58 -04001634
1635/**
1636 * d_alloc - allocate a dcache entry
1637 * @parent: parent of entry to allocate
1638 * @name: qstr of the name
1639 *
1640 * Allocates a dentry. It returns %NULL if there is insufficient memory
1641 * available. On a success the dentry is returned. The name passed in is
1642 * copied and the copy passed in may be reused after this call.
1643 */
1644struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1645{
1646 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1647 if (!dentry)
1648 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001649 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001650 spin_lock(&parent->d_lock);
1651 /*
1652 * don't need child lock because it is not subject
1653 * to concurrency here
1654 */
1655 __dget_dlock(parent);
1656 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001657 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001658 spin_unlock(&parent->d_lock);
1659
1660 return dentry;
1661}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001662EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Al Viroba65dc52016-06-10 11:32:47 -04001664struct dentry *d_alloc_cursor(struct dentry * parent)
1665{
1666 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1667 if (dentry) {
1668 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1669 dentry->d_parent = dget(parent);
1670 }
1671 return dentry;
1672}
1673
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001674/**
1675 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1676 * @sb: the superblock
1677 * @name: qstr of the name
1678 *
1679 * For a filesystem that just pins its dentries in memory and never
1680 * performs lookups at all, return an unhashed IS_ROOT dentry.
1681 */
Nick Piggin4b936882011-01-07 17:50:07 +11001682struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1683{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001684 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001685}
1686EXPORT_SYMBOL(d_alloc_pseudo);
1687
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1689{
1690 struct qstr q;
1691
1692 q.name = name;
George Spelvinfcfd2fb2016-05-20 08:41:37 -04001693 q.hash_len = hashlen_string(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 return d_alloc(parent, &q);
1695}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001696EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
Nick Pigginfb045ad2011-01-07 17:49:55 +11001698void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1699{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001700 WARN_ON_ONCE(dentry->d_op);
1701 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001702 DCACHE_OP_COMPARE |
1703 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001704 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001705 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001706 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001707 dentry->d_op = op;
1708 if (!op)
1709 return;
1710 if (op->d_hash)
1711 dentry->d_flags |= DCACHE_OP_HASH;
1712 if (op->d_compare)
1713 dentry->d_flags |= DCACHE_OP_COMPARE;
1714 if (op->d_revalidate)
1715 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001716 if (op->d_weak_revalidate)
1717 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001718 if (op->d_delete)
1719 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001720 if (op->d_prune)
1721 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001722 if (op->d_real)
1723 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001724
1725}
1726EXPORT_SYMBOL(d_set_d_op);
1727
David Howellsdf1a0852015-01-29 12:02:28 +00001728
1729/*
1730 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1731 * @dentry - The dentry to mark
1732 *
1733 * Mark a dentry as falling through to the lower layer (as set with
1734 * d_pin_lower()). This flag may be recorded on the medium.
1735 */
1736void d_set_fallthru(struct dentry *dentry)
1737{
1738 spin_lock(&dentry->d_lock);
1739 dentry->d_flags |= DCACHE_FALLTHRU;
1740 spin_unlock(&dentry->d_lock);
1741}
1742EXPORT_SYMBOL(d_set_fallthru);
1743
David Howellsb18825a2013-09-12 19:22:53 +01001744static unsigned d_flags_for_inode(struct inode *inode)
1745{
David Howells44bdb5e2015-01-29 12:02:29 +00001746 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001747
1748 if (!inode)
1749 return DCACHE_MISS_TYPE;
1750
1751 if (S_ISDIR(inode->i_mode)) {
1752 add_flags = DCACHE_DIRECTORY_TYPE;
1753 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1754 if (unlikely(!inode->i_op->lookup))
1755 add_flags = DCACHE_AUTODIR_TYPE;
1756 else
1757 inode->i_opflags |= IOP_LOOKUP;
1758 }
David Howells44bdb5e2015-01-29 12:02:29 +00001759 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001760 }
1761
David Howells44bdb5e2015-01-29 12:02:29 +00001762 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001763 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001764 add_flags = DCACHE_SYMLINK_TYPE;
1765 goto type_determined;
1766 }
1767 inode->i_opflags |= IOP_NOFOLLOW;
1768 }
1769
1770 if (unlikely(!S_ISREG(inode->i_mode)))
1771 add_flags = DCACHE_SPECIAL_TYPE;
1772
1773type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001774 if (unlikely(IS_AUTOMOUNT(inode)))
1775 add_flags |= DCACHE_NEED_AUTOMOUNT;
1776 return add_flags;
1777}
1778
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001779static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1780{
David Howellsb18825a2013-09-12 19:22:53 +01001781 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001782 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001783
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001784 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001785 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001786 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001787 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001788 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001789 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001790 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001791}
1792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793/**
1794 * d_instantiate - fill in inode information for a dentry
1795 * @entry: dentry to complete
1796 * @inode: inode to attach to this dentry
1797 *
1798 * Fill in inode information in the entry.
1799 *
1800 * This turns negative dentries into productive full members
1801 * of society.
1802 *
1803 * NOTE! This assumes that the inode count has been incremented
1804 * (or otherwise set) by the caller to indicate that it is now
1805 * in use by the dcache.
1806 */
1807
1808void d_instantiate(struct dentry *entry, struct inode * inode)
1809{
Al Viro946e51f2014-10-26 19:19:16 -04001810 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001811 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001812 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001813 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001814 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001815 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001818EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819
1820/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001821 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1822 * @entry: dentry to complete
1823 * @inode: inode to attach to this dentry
1824 *
1825 * Fill in inode information in the entry. If a directory alias is found, then
1826 * return an error (and drop inode). Together with d_materialise_unique() this
1827 * guarantees that a directory inode may never have more than one alias.
1828 */
1829int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1830{
Al Viro946e51f2014-10-26 19:19:16 -04001831 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001832
Al Virob9680912016-04-11 00:53:26 -04001833 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001834 spin_lock(&inode->i_lock);
1835 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1836 spin_unlock(&inode->i_lock);
1837 iput(inode);
1838 return -EBUSY;
1839 }
1840 __d_instantiate(entry, inode);
1841 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001842
1843 return 0;
1844}
1845EXPORT_SYMBOL(d_instantiate_no_diralias);
1846
Al Viroadc0e912012-01-08 16:49:21 -05001847struct dentry *d_make_root(struct inode *root_inode)
1848{
1849 struct dentry *res = NULL;
1850
1851 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001852 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001853 if (res)
1854 d_instantiate(res, root_inode);
1855 else
1856 iput(root_inode);
1857 }
1858 return res;
1859}
1860EXPORT_SYMBOL(d_make_root);
1861
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001862static struct dentry * __d_find_any_alias(struct inode *inode)
1863{
1864 struct dentry *alias;
1865
Al Virob3d9b7a2012-06-09 13:51:19 -04001866 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001867 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001868 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001869 __dget(alias);
1870 return alias;
1871}
1872
Sage Weil46f72b32012-01-10 09:04:37 -08001873/**
1874 * d_find_any_alias - find any alias for a given inode
1875 * @inode: inode to find an alias for
1876 *
1877 * If any aliases exist for the given inode, take and return a
1878 * reference for one of them. If no aliases exist, return %NULL.
1879 */
1880struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001881{
1882 struct dentry *de;
1883
1884 spin_lock(&inode->i_lock);
1885 de = __d_find_any_alias(inode);
1886 spin_unlock(&inode->i_lock);
1887 return de;
1888}
Sage Weil46f72b32012-01-10 09:04:37 -08001889EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001890
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001891static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001892{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001893 struct dentry *tmp;
1894 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001895 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001896
1897 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001898 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001899 if (IS_ERR(inode))
1900 return ERR_CAST(inode);
1901
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001902 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001903 if (res)
1904 goto out_iput;
1905
Al Viro798434b2016-03-24 20:38:43 -04001906 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001907 if (!tmp) {
1908 res = ERR_PTR(-ENOMEM);
1909 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001910 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001911
Al Virob9680912016-04-11 00:53:26 -04001912 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001913 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001914 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001915 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001916 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001917 dput(tmp);
1918 goto out_iput;
1919 }
1920
1921 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001922 add_flags = d_flags_for_inode(inode);
1923
1924 if (disconnected)
1925 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001926
Christoph Hellwig9308a612008-08-11 15:49:12 +02001927 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001928 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001929 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001930 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001931 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001932 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001933 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001934 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001935
Christoph Hellwig9308a612008-08-11 15:49:12 +02001936 return tmp;
1937
1938 out_iput:
1939 iput(inode);
1940 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001941}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001942
1943/**
1944 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1945 * @inode: inode to allocate the dentry for
1946 *
1947 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1948 * similar open by handle operations. The returned dentry may be anonymous,
1949 * or may have a full name (if the inode was already in the cache).
1950 *
1951 * When called on a directory inode, we must ensure that the inode only ever
1952 * has one dentry. If a dentry is found, that is returned instead of
1953 * allocating a new one.
1954 *
1955 * On successful return, the reference to the inode has been transferred
1956 * to the dentry. In case of an error the reference on the inode is released.
1957 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1958 * be passed in and the error will be propagated to the return value,
1959 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1960 */
1961struct dentry *d_obtain_alias(struct inode *inode)
1962{
1963 return __d_obtain_alias(inode, 1);
1964}
Benny Halevyadc48722009-02-27 14:02:59 -08001965EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966
1967/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001968 * d_obtain_root - find or allocate a dentry for a given inode
1969 * @inode: inode to allocate the dentry for
1970 *
1971 * Obtain an IS_ROOT dentry for the root of a filesystem.
1972 *
1973 * We must ensure that directory inodes only ever have one dentry. If a
1974 * dentry is found, that is returned instead of allocating a new one.
1975 *
1976 * On successful return, the reference to the inode has been transferred
1977 * to the dentry. In case of an error the reference on the inode is
1978 * released. A %NULL or IS_ERR inode may be passed in and will be the
1979 * error will be propagate to the return value, with a %NULL @inode
1980 * replaced by ERR_PTR(-ESTALE).
1981 */
1982struct dentry *d_obtain_root(struct inode *inode)
1983{
1984 return __d_obtain_alias(inode, 0);
1985}
1986EXPORT_SYMBOL(d_obtain_root);
1987
1988/**
Barry Naujok94035402008-05-21 16:50:46 +10001989 * d_add_ci - lookup or allocate new dentry with case-exact name
1990 * @inode: the inode case-insensitive lookup has found
1991 * @dentry: the negative dentry that was passed to the parent's lookup func
1992 * @name: the case-exact name to be associated with the returned dentry
1993 *
1994 * This is to avoid filling the dcache with case-insensitive names to the
1995 * same inode, only the actual correct case is stored in the dcache for
1996 * case-insensitive filesystems.
1997 *
1998 * For a case-insensitive lookup match and if the the case-exact dentry
1999 * already exists in in the dcache, use it and return it.
2000 *
2001 * If no entry exists with the exact case name, allocate new dentry with
2002 * the exact case, and return the spliced entry.
2003 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002004struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002005 struct qstr *name)
2006{
Al Virod9171b92016-04-15 03:33:13 -04002007 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002008
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002009 /*
2010 * First check if a dentry matching the name already exists,
2011 * if not go ahead and create it now.
2012 */
Barry Naujok94035402008-05-21 16:50:46 +10002013 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002014 if (found) {
2015 iput(inode);
2016 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002017 }
Al Virod9171b92016-04-15 03:33:13 -04002018 if (d_in_lookup(dentry)) {
2019 found = d_alloc_parallel(dentry->d_parent, name,
2020 dentry->d_wait);
2021 if (IS_ERR(found) || !d_in_lookup(found)) {
2022 iput(inode);
2023 return found;
2024 }
2025 } else {
2026 found = d_alloc(dentry->d_parent, name);
2027 if (!found) {
2028 iput(inode);
2029 return ERR_PTR(-ENOMEM);
2030 }
2031 }
2032 res = d_splice_alias(inode, found);
2033 if (res) {
2034 dput(found);
2035 return res;
2036 }
Al Viro4f522a22013-02-11 23:20:37 -05002037 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002038}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002039EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002041
Al Virod4c91a82016-06-25 23:33:49 -04002042static inline bool d_same_name(const struct dentry *dentry,
2043 const struct dentry *parent,
2044 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002045{
Al Virod4c91a82016-06-25 23:33:49 -04002046 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2047 if (dentry->d_name.len != name->len)
2048 return false;
2049 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002050 }
Al Virod4c91a82016-06-25 23:33:49 -04002051 return parent->d_op->d_compare(parent, dentry,
2052 dentry->d_name.len, dentry->d_name.name,
2053 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002054}
2055
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002057 * __d_lookup_rcu - search for a dentry (racy, store-free)
2058 * @parent: parent dentry
2059 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002060 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002061 * Returns: dentry, or NULL
2062 *
2063 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2064 * resolution (store-free path walking) design described in
2065 * Documentation/filesystems/path-lookup.txt.
2066 *
2067 * This is not to be used outside core vfs.
2068 *
2069 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2070 * held, and rcu_read_lock held. The returned dentry must not be stored into
2071 * without taking d_lock and checking d_seq sequence count against @seq
2072 * returned here.
2073 *
Linus Torvalds15570082013-09-02 11:38:06 -07002074 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002075 * function.
2076 *
2077 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2078 * the returned dentry, so long as its parent's seqlock is checked after the
2079 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2080 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002081 *
2082 * NOTE! The caller *has* to check the resulting dentry against the sequence
2083 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002084 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002085struct dentry *__d_lookup_rcu(const struct dentry *parent,
2086 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002087 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002088{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002089 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002090 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002091 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002092 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002093 struct dentry *dentry;
2094
2095 /*
2096 * Note: There is significant duplication with __d_lookup_rcu which is
2097 * required to prevent single threaded performance regressions
2098 * especially on architectures where smp_rmb (in seqcounts) are costly.
2099 * Keep the two functions in sync.
2100 */
2101
2102 /*
2103 * The hash list is protected using RCU.
2104 *
2105 * Carefully use d_seq when comparing a candidate dentry, to avoid
2106 * races with d_move().
2107 *
2108 * It is possible that concurrent renames can mess up our list
2109 * walk here and result in missing our dentry, resulting in the
2110 * false-negative result. d_lookup() protects against concurrent
2111 * renames using rename_lock seqlock.
2112 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002113 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002114 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002115 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002116 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002117
Nick Piggin31e6b012011-01-07 17:49:52 +11002118seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002119 /*
2120 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002121 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002122 *
2123 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002124 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002125 *
2126 * NOTE! We do a "raw" seqcount_begin here. That means that
2127 * we don't wait for the sequence count to stabilize if it
2128 * is in the middle of a sequence change. If we do the slow
2129 * dentry compare, we will do seqretries until it is stable,
2130 * and if we end up with a successful lookup, we actually
2131 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002132 *
2133 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2134 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002135 */
2136 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002137 if (dentry->d_parent != parent)
2138 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002139 if (d_unhashed(dentry))
2140 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002141
2142 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002143 int tlen;
2144 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002145 if (dentry->d_name.hash != hashlen_hash(hashlen))
2146 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002147 tlen = dentry->d_name.len;
2148 tname = dentry->d_name.name;
2149 /* we want a consistent (name,len) pair */
2150 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2151 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002152 goto seqretry;
2153 }
Al Virod4c91a82016-06-25 23:33:49 -04002154 if (parent->d_op->d_compare(parent, dentry,
2155 tlen, tname, name) != 0)
2156 continue;
2157 } else {
2158 if (dentry->d_name.hash_len != hashlen)
2159 continue;
2160 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2161 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002162 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002163 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002164 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002165 }
2166 return NULL;
2167}
2168
2169/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 * d_lookup - search for a dentry
2171 * @parent: parent dentry
2172 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002173 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002175 * d_lookup searches the children of the parent dentry for the name in
2176 * question. If the dentry is found its reference count is incremented and the
2177 * dentry is returned. The caller must use dput to free the entry when it has
2178 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 */
Al Viroda2d8452013-01-24 18:29:34 -05002180struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181{
Nick Piggin31e6b012011-01-07 17:49:52 +11002182 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002183 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
Daeseok Younb8314f92014-08-11 11:46:53 +09002185 do {
2186 seq = read_seqbegin(&rename_lock);
2187 dentry = __d_lookup(parent, name);
2188 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 break;
2190 } while (read_seqretry(&rename_lock, seq));
2191 return dentry;
2192}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002193EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
Nick Piggin31e6b012011-01-07 17:49:52 +11002195/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002196 * __d_lookup - search for a dentry (racy)
2197 * @parent: parent dentry
2198 * @name: qstr of name we wish to find
2199 * Returns: dentry, or NULL
2200 *
2201 * __d_lookup is like d_lookup, however it may (rarely) return a
2202 * false-negative result due to unrelated rename activity.
2203 *
2204 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2205 * however it must be used carefully, eg. with a following d_lookup in
2206 * the case of failure.
2207 *
2208 * __d_lookup callers must be commented.
2209 */
Al Viroa713ca22013-01-24 18:27:00 -05002210struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 unsigned int hash = name->hash;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002213 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002214 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002215 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002216 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217
Nick Pigginb04f7842010-08-18 04:37:34 +10002218 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002219 * Note: There is significant duplication with __d_lookup_rcu which is
2220 * required to prevent single threaded performance regressions
2221 * especially on architectures where smp_rmb (in seqcounts) are costly.
2222 * Keep the two functions in sync.
2223 */
2224
2225 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002226 * The hash list is protected using RCU.
2227 *
2228 * Take d_lock when comparing a candidate dentry, to avoid races
2229 * with d_move().
2230 *
2231 * It is possible that concurrent renames can mess up our list
2232 * walk here and result in missing our dentry, resulting in the
2233 * false-negative result. d_lookup() protects against concurrent
2234 * renames using rename_lock seqlock.
2235 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002236 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002237 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 rcu_read_lock();
2239
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002240 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 if (dentry->d_name.hash != hash)
2243 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
2245 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 if (dentry->d_parent != parent)
2247 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002248 if (d_unhashed(dentry))
2249 goto next;
2250
Al Virod4c91a82016-06-25 23:33:49 -04002251 if (!d_same_name(dentry, parent, name))
2252 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Waiman Long98474232013-08-28 18:24:59 -07002254 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002255 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 spin_unlock(&dentry->d_lock);
2257 break;
2258next:
2259 spin_unlock(&dentry->d_lock);
2260 }
2261 rcu_read_unlock();
2262
2263 return found;
2264}
2265
2266/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002267 * d_hash_and_lookup - hash the qstr then search for a dentry
2268 * @dir: Directory to search in
2269 * @name: qstr of name we wish to find
2270 *
Al Viro4f522a22013-02-11 23:20:37 -05002271 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002272 */
2273struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2274{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002275 /*
2276 * Check for a fs-specific hash function. Note that we must
2277 * calculate the standard hash first, as the d_op->d_hash()
2278 * routine may choose to leave the hash value unchanged.
2279 */
2280 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002281 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002282 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002283 if (unlikely(err < 0))
2284 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002285 }
Al Viro4f522a22013-02-11 23:20:37 -05002286 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002287}
Al Viro4f522a22013-02-11 23:20:37 -05002288EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002289
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290/*
2291 * When a file is deleted, we have two options:
2292 * - turn this dentry into a negative dentry
2293 * - unhash this dentry and free it.
2294 *
2295 * Usually, we want to just turn this into
2296 * a negative dentry, but if anybody else is
2297 * currently using the dentry or the inode
2298 * we can't do that and we fall back on removing
2299 * it from the hash queues and waiting for
2300 * it to be deleted later when it has no users
2301 */
2302
2303/**
2304 * d_delete - delete a dentry
2305 * @dentry: The dentry to delete
2306 *
2307 * Turn the dentry into a negative dentry if possible, otherwise
2308 * remove it from the hash queues so it can be deleted later
2309 */
2310
2311void d_delete(struct dentry * dentry)
2312{
Nick Piggin873feea2011-01-07 17:50:06 +11002313 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002314 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 /*
2316 * Are we the only user?
2317 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002318again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002320 inode = dentry->d_inode;
2321 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002322 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002323 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002324 spin_unlock(&dentry->d_lock);
2325 cpu_relax();
2326 goto again;
2327 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002328 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002329 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002330 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 return;
2332 }
2333
2334 if (!d_unhashed(dentry))
2335 __d_drop(dentry);
2336
2337 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002338
2339 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002341EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002343static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002345 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002346 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002347 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002348 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349}
2350
David Howells770bfad2006-08-22 20:06:07 -04002351static void _d_rehash(struct dentry * entry)
2352{
2353 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2354}
2355
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356/**
2357 * d_rehash - add an entry back to the hash
2358 * @entry: dentry to add to the hash
2359 *
2360 * Adds a dentry to the hash according to its name.
2361 */
2362
2363void d_rehash(struct dentry * entry)
2364{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002366 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002369EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
Al Viro84e710d2016-04-15 00:58:55 -04002371static inline unsigned start_dir_add(struct inode *dir)
2372{
2373
2374 for (;;) {
2375 unsigned n = dir->i_dir_seq;
2376 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2377 return n;
2378 cpu_relax();
2379 }
2380}
2381
2382static inline void end_dir_add(struct inode *dir, unsigned n)
2383{
2384 smp_store_release(&dir->i_dir_seq, n + 2);
2385}
2386
Al Virod9171b92016-04-15 03:33:13 -04002387static void d_wait_lookup(struct dentry *dentry)
2388{
2389 if (d_in_lookup(dentry)) {
2390 DECLARE_WAITQUEUE(wait, current);
2391 add_wait_queue(dentry->d_wait, &wait);
2392 do {
2393 set_current_state(TASK_UNINTERRUPTIBLE);
2394 spin_unlock(&dentry->d_lock);
2395 schedule();
2396 spin_lock(&dentry->d_lock);
2397 } while (d_in_lookup(dentry));
2398 }
2399}
2400
Al Viro94bdd652016-04-15 02:42:04 -04002401struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002402 const struct qstr *name,
2403 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002404{
Al Viro94bdd652016-04-15 02:42:04 -04002405 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002406 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2407 struct hlist_bl_node *node;
2408 struct dentry *new = d_alloc(parent, name);
2409 struct dentry *dentry;
2410 unsigned seq, r_seq, d_seq;
2411
2412 if (unlikely(!new))
2413 return ERR_PTR(-ENOMEM);
2414
2415retry:
2416 rcu_read_lock();
2417 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2418 r_seq = read_seqbegin(&rename_lock);
2419 dentry = __d_lookup_rcu(parent, name, &d_seq);
2420 if (unlikely(dentry)) {
2421 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2422 rcu_read_unlock();
2423 goto retry;
2424 }
2425 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2426 rcu_read_unlock();
2427 dput(dentry);
2428 goto retry;
2429 }
2430 rcu_read_unlock();
2431 dput(new);
2432 return dentry;
2433 }
2434 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2435 rcu_read_unlock();
2436 goto retry;
2437 }
2438 hlist_bl_lock(b);
2439 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2440 hlist_bl_unlock(b);
2441 rcu_read_unlock();
2442 goto retry;
2443 }
Al Viro94bdd652016-04-15 02:42:04 -04002444 /*
2445 * No changes for the parent since the beginning of d_lookup().
2446 * Since all removals from the chain happen with hlist_bl_lock(),
2447 * any potential in-lookup matches are going to stay here until
2448 * we unlock the chain. All fields are stable in everything
2449 * we encounter.
2450 */
2451 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2452 if (dentry->d_name.hash != hash)
2453 continue;
2454 if (dentry->d_parent != parent)
2455 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002456 if (!d_same_name(dentry, parent, name))
2457 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002458 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002459 /* now we can try to grab a reference */
2460 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2461 rcu_read_unlock();
2462 goto retry;
2463 }
2464
2465 rcu_read_unlock();
2466 /*
2467 * somebody is likely to be still doing lookup for it;
2468 * wait for them to finish
2469 */
Al Virod9171b92016-04-15 03:33:13 -04002470 spin_lock(&dentry->d_lock);
2471 d_wait_lookup(dentry);
2472 /*
2473 * it's not in-lookup anymore; in principle we should repeat
2474 * everything from dcache lookup, but it's likely to be what
2475 * d_lookup() would've found anyway. If it is, just return it;
2476 * otherwise we really have to repeat the whole thing.
2477 */
2478 if (unlikely(dentry->d_name.hash != hash))
2479 goto mismatch;
2480 if (unlikely(dentry->d_parent != parent))
2481 goto mismatch;
2482 if (unlikely(d_unhashed(dentry)))
2483 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002484 if (unlikely(!d_same_name(dentry, parent, name)))
2485 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002486 /* OK, it *is* a hashed match; return it */
2487 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002488 dput(new);
2489 return dentry;
2490 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002491 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002492 /* we can't take ->d_lock here; it's OK, though. */
2493 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002494 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002495 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2496 hlist_bl_unlock(b);
2497 return new;
Al Virod9171b92016-04-15 03:33:13 -04002498mismatch:
2499 spin_unlock(&dentry->d_lock);
2500 dput(dentry);
2501 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002502}
2503EXPORT_SYMBOL(d_alloc_parallel);
2504
Al Viro85c7f812016-04-14 19:52:13 -04002505void __d_lookup_done(struct dentry *dentry)
2506{
Al Viro94bdd652016-04-15 02:42:04 -04002507 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2508 dentry->d_name.hash);
2509 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002510 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002511 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002512 wake_up_all(dentry->d_wait);
2513 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002514 hlist_bl_unlock(b);
2515 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002516 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002517}
2518EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002519
2520/* inode->i_lock held if inode is non-NULL */
2521
2522static inline void __d_add(struct dentry *dentry, struct inode *inode)
2523{
Al Viro84e710d2016-04-15 00:58:55 -04002524 struct inode *dir = NULL;
2525 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002526 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002527 if (unlikely(d_in_lookup(dentry))) {
2528 dir = dentry->d_parent->d_inode;
2529 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002530 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002531 }
Al Viroed782b52016-03-09 19:52:39 -05002532 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002533 unsigned add_flags = d_flags_for_inode(inode);
2534 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2535 raw_write_seqcount_begin(&dentry->d_seq);
2536 __d_set_inode_and_type(dentry, inode, add_flags);
2537 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002538 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002539 }
Al Viro0568d702016-04-14 19:40:56 -04002540 _d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002541 if (dir)
2542 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002543 spin_unlock(&dentry->d_lock);
2544 if (inode)
2545 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002546}
2547
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002548/**
Al Viro34d0d192016-03-08 21:01:03 -05002549 * d_add - add dentry to hash queues
2550 * @entry: dentry to add
2551 * @inode: The inode to attach to this dentry
2552 *
2553 * This adds the entry to the hash queues and initializes @inode.
2554 * The entry was actually filled in earlier during d_alloc().
2555 */
2556
2557void d_add(struct dentry *entry, struct inode *inode)
2558{
Al Virob9680912016-04-11 00:53:26 -04002559 if (inode) {
2560 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002561 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002562 }
Al Viroed782b52016-03-09 19:52:39 -05002563 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002564}
2565EXPORT_SYMBOL(d_add);
2566
2567/**
Al Viro668d0cd2016-03-08 12:44:17 -05002568 * d_exact_alias - find and hash an exact unhashed alias
2569 * @entry: dentry to add
2570 * @inode: The inode to go with this dentry
2571 *
2572 * If an unhashed dentry with the same name/parent and desired
2573 * inode already exists, hash and return it. Otherwise, return
2574 * NULL.
2575 *
2576 * Parent directory should be locked.
2577 */
2578struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2579{
2580 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002581 unsigned int hash = entry->d_name.hash;
2582
2583 spin_lock(&inode->i_lock);
2584 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2585 /*
2586 * Don't need alias->d_lock here, because aliases with
2587 * d_parent == entry->d_parent are not subject to name or
2588 * parent changes, because the parent inode i_mutex is held.
2589 */
2590 if (alias->d_name.hash != hash)
2591 continue;
2592 if (alias->d_parent != entry->d_parent)
2593 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002594 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002595 continue;
2596 spin_lock(&alias->d_lock);
2597 if (!d_unhashed(alias)) {
2598 spin_unlock(&alias->d_lock);
2599 alias = NULL;
2600 } else {
2601 __dget_dlock(alias);
2602 _d_rehash(alias);
2603 spin_unlock(&alias->d_lock);
2604 }
2605 spin_unlock(&inode->i_lock);
2606 return alias;
2607 }
2608 spin_unlock(&inode->i_lock);
2609 return NULL;
2610}
2611EXPORT_SYMBOL(d_exact_alias);
2612
2613/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002614 * dentry_update_name_case - update case insensitive dentry with a new name
2615 * @dentry: dentry to be updated
2616 * @name: new name
2617 *
2618 * Update a case insensitive dentry with new case of name.
2619 *
2620 * dentry must have been returned by d_lookup with name @name. Old and new
2621 * name lengths must match (ie. no d_compare which allows mismatched name
2622 * lengths).
2623 *
2624 * Parent inode i_mutex must be held over d_lookup and into this call (to
2625 * keep renames and concurrent inserts, and readdir(2) away).
2626 */
2627void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2628{
Al Viro59551022016-01-22 15:40:57 -05002629 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002630 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2631
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002632 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002633 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002634 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002635 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002636 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002637}
2638EXPORT_SYMBOL(dentry_update_name_case);
2639
Al Viro8d85b482014-09-29 14:54:27 -04002640static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641{
Al Viro8d85b482014-09-29 14:54:27 -04002642 if (unlikely(dname_external(target))) {
2643 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 /*
2645 * Both external: swap the pointers
2646 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002647 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 } else {
2649 /*
2650 * dentry:internal, target:external. Steal target's
2651 * storage and make target internal.
2652 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002653 memcpy(target->d_iname, dentry->d_name.name,
2654 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 dentry->d_name.name = target->d_name.name;
2656 target->d_name.name = target->d_iname;
2657 }
2658 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002659 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 /*
2661 * dentry:external, target:internal. Give dentry's
2662 * storage to target and make dentry internal
2663 */
2664 memcpy(dentry->d_iname, target->d_name.name,
2665 target->d_name.len + 1);
2666 target->d_name.name = dentry->d_name.name;
2667 dentry->d_name.name = dentry->d_iname;
2668 } else {
2669 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002670 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002672 unsigned int i;
2673 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002674 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2675 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002676 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2677 swap(((long *) &dentry->d_iname)[i],
2678 ((long *) &target->d_iname)[i]);
2679 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 }
2681 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002682 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683}
2684
Al Viro8d85b482014-09-29 14:54:27 -04002685static void copy_name(struct dentry *dentry, struct dentry *target)
2686{
2687 struct external_name *old_name = NULL;
2688 if (unlikely(dname_external(dentry)))
2689 old_name = external_name(dentry);
2690 if (unlikely(dname_external(target))) {
2691 atomic_inc(&external_name(target)->u.count);
2692 dentry->d_name = target->d_name;
2693 } else {
2694 memcpy(dentry->d_iname, target->d_name.name,
2695 target->d_name.len + 1);
2696 dentry->d_name.name = dentry->d_iname;
2697 dentry->d_name.hash_len = target->d_name.hash_len;
2698 }
2699 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2700 kfree_rcu(old_name, u.head);
2701}
2702
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002703static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2704{
2705 /*
2706 * XXXX: do we really need to take target->d_lock?
2707 */
2708 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2709 spin_lock(&target->d_parent->d_lock);
2710 else {
2711 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2712 spin_lock(&dentry->d_parent->d_lock);
2713 spin_lock_nested(&target->d_parent->d_lock,
2714 DENTRY_D_LOCK_NESTED);
2715 } else {
2716 spin_lock(&target->d_parent->d_lock);
2717 spin_lock_nested(&dentry->d_parent->d_lock,
2718 DENTRY_D_LOCK_NESTED);
2719 }
2720 }
2721 if (target < dentry) {
2722 spin_lock_nested(&target->d_lock, 2);
2723 spin_lock_nested(&dentry->d_lock, 3);
2724 } else {
2725 spin_lock_nested(&dentry->d_lock, 2);
2726 spin_lock_nested(&target->d_lock, 3);
2727 }
2728}
2729
Al Viro986c0192014-09-26 23:11:15 -04002730static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002731{
2732 if (target->d_parent != dentry->d_parent)
2733 spin_unlock(&dentry->d_parent->d_lock);
2734 if (target->d_parent != target)
2735 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002736 spin_unlock(&target->d_lock);
2737 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002738}
2739
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002741 * When switching names, the actual string doesn't strictly have to
2742 * be preserved in the target - because we're dropping the target
2743 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002744 * the new name before we switch, unless we are going to rehash
2745 * it. Note that if we *do* unhash the target, we are not allowed
2746 * to rehash it without giving it a new name/hash key - whether
2747 * we swap or overwrite the names here, resulting name won't match
2748 * the reality in filesystem; it's only there for d_path() purposes.
2749 * Note that all of this is happening under rename_lock, so the
2750 * any hash lookup seeing it in the middle of manipulations will
2751 * be discarded anyway. So we do not care what happens to the hash
2752 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002754/*
Al Viro18367502011-07-12 21:42:24 -04002755 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 * @dentry: entry to move
2757 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002758 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 *
2760 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002761 * dcache entries should not be moved in this way. Caller must hold
2762 * rename_lock, the i_mutex of the source and target directories,
2763 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002765static void __d_move(struct dentry *dentry, struct dentry *target,
2766 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767{
Al Viro84e710d2016-04-15 00:58:55 -04002768 struct inode *dir = NULL;
2769 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 if (!dentry->d_inode)
2771 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2772
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002773 BUG_ON(d_ancestor(dentry, target));
2774 BUG_ON(d_ancestor(target, dentry));
2775
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002776 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002777 if (unlikely(d_in_lookup(target))) {
2778 dir = target->d_parent->d_inode;
2779 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002780 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002781 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782
Nick Piggin31e6b012011-01-07 17:49:52 +11002783 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002784 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002785
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002786 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2787
2788 /*
2789 * Move the dentry to the target hash queue. Don't bother checking
2790 * for the same hash queue because of how unlikely it is.
2791 */
2792 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002793 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794
Miklos Szeredida1ce062014-04-01 17:08:43 +02002795 /*
2796 * Unhash the target (d_delete() is not usable here). If exchanging
2797 * the two dentries, then rehash onto the other's hash queue.
2798 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002800 if (exchange) {
2801 __d_rehash(target,
2802 d_hash(dentry->d_parent, dentry->d_name.hash));
2803 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002806 if (exchange)
2807 swap_names(dentry, target);
2808 else
2809 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810
Al Viro63cf4272014-09-26 23:06:14 -04002811 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002813 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002814 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 dentry->d_parent = target->d_parent;
2816 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002817 list_del_init(&target->d_child);
2818 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002820 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002821 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002822 list_move(&target->d_child, &target->d_parent->d_subdirs);
2823 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002824 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002825 fsnotify_update_flags(target);
2826 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 }
2828
Nick Piggin31e6b012011-01-07 17:49:52 +11002829 write_seqcount_end(&target->d_seq);
2830 write_seqcount_end(&dentry->d_seq);
2831
Al Viro84e710d2016-04-15 00:58:55 -04002832 if (dir)
2833 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002834 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002835}
2836
2837/*
2838 * d_move - move a dentry
2839 * @dentry: entry to move
2840 * @target: new dentry
2841 *
2842 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002843 * dcache entries should not be moved in this way. See the locking
2844 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002845 */
2846void d_move(struct dentry *dentry, struct dentry *target)
2847{
2848 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002849 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002851}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002852EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853
Miklos Szeredida1ce062014-04-01 17:08:43 +02002854/*
2855 * d_exchange - exchange two dentries
2856 * @dentry1: first dentry
2857 * @dentry2: second dentry
2858 */
2859void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2860{
2861 write_seqlock(&rename_lock);
2862
2863 WARN_ON(!dentry1->d_inode);
2864 WARN_ON(!dentry2->d_inode);
2865 WARN_ON(IS_ROOT(dentry1));
2866 WARN_ON(IS_ROOT(dentry2));
2867
2868 __d_move(dentry1, dentry2, true);
2869
2870 write_sequnlock(&rename_lock);
2871}
2872
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002873/**
2874 * d_ancestor - search for an ancestor
2875 * @p1: ancestor dentry
2876 * @p2: child dentry
2877 *
2878 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2879 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002880 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002881struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002882{
2883 struct dentry *p;
2884
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002885 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002886 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002887 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002888 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002889 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002890}
2891
2892/*
2893 * This helper attempts to cope with remotely renamed directories
2894 *
2895 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002896 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002897 *
2898 * Note: If ever the locking in lock_rename() changes, then please
2899 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002900 */
Al Virob5ae6b12014-10-12 22:16:02 -04002901static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002902 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002903{
Al Viro9902af72016-04-15 15:08:36 -04002904 struct mutex *m1 = NULL;
2905 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002906 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002907
2908 /* If alias and dentry share a parent, then no extra locks required */
2909 if (alias->d_parent == dentry->d_parent)
2910 goto out_unalias;
2911
Trond Myklebust9eaef272006-10-21 10:24:20 -07002912 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002913 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2914 goto out_err;
2915 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002916 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002917 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002918 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002919out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002920 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002921 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002922out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002923 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002924 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002925 if (m1)
2926 mutex_unlock(m1);
2927 return ret;
2928}
2929
David Howells770bfad2006-08-22 20:06:07 -04002930/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002931 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2932 * @inode: the inode which may have a disconnected dentry
2933 * @dentry: a negative dentry which we want to point to the inode.
2934 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002935 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2936 * place of the given dentry and return it, else simply d_add the inode
2937 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002938 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002939 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2940 * we should error out: directories can't have multiple aliases.
2941 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002942 * This is needed in the lookup routine of any filesystem that is exportable
2943 * (via knfsd) so that we can build dcache paths to directories effectively.
2944 *
2945 * If a dentry was found and moved, then it is returned. Otherwise NULL
2946 * is returned. This matches the expected return value of ->lookup.
2947 *
2948 * Cluster filesystems may call this function with a negative, hashed dentry.
2949 * In that case, we know that the inode will be a regular file, and also this
2950 * will only occur during atomic_open. So we need to check for the dentry
2951 * being already hashed only in the final case.
2952 */
2953struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2954{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002955 if (IS_ERR(inode))
2956 return ERR_CAST(inode);
2957
David Howells770bfad2006-08-22 20:06:07 -04002958 BUG_ON(!d_unhashed(dentry));
2959
Al Virode689f52016-03-09 18:05:42 -05002960 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002961 goto out;
Al Virode689f52016-03-09 18:05:42 -05002962
Al Virob9680912016-04-11 00:53:26 -04002963 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002964 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002965 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002966 struct dentry *new = __d_find_any_alias(inode);
2967 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002968 /* The reference to new ensures it remains an alias */
2969 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002970 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002971 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002972 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002973 dput(new);
2974 new = ERR_PTR(-ELOOP);
2975 pr_warn_ratelimited(
2976 "VFS: Lookup of '%s' in %s %s"
2977 " would have caused loop\n",
2978 dentry->d_name.name,
2979 inode->i_sb->s_type->name,
2980 inode->i_sb->s_id);
2981 } else if (!IS_ROOT(new)) {
2982 int err = __d_unalias(inode, dentry, new);
2983 write_sequnlock(&rename_lock);
2984 if (err) {
2985 dput(new);
2986 new = ERR_PTR(err);
2987 }
Al Viro18367502011-07-12 21:42:24 -04002988 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002989 __d_move(new, dentry, false);
2990 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002991 }
Al Virob5ae6b12014-10-12 22:16:02 -04002992 iput(inode);
2993 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002994 }
David Howells770bfad2006-08-22 20:06:07 -04002995 }
Al Virob5ae6b12014-10-12 22:16:02 -04002996out:
Al Viroed782b52016-03-09 19:52:39 -05002997 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002998 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002999}
Al Virob5ae6b12014-10-12 22:16:02 -04003000EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003001
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003002static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003003{
3004 *buflen -= namelen;
3005 if (*buflen < 0)
3006 return -ENAMETOOLONG;
3007 *buffer -= namelen;
3008 memcpy(*buffer, str, namelen);
3009 return 0;
3010}
3011
Waiman Long232d2d62013-09-09 12:18:13 -04003012/**
3013 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003014 * @buffer: buffer pointer
3015 * @buflen: allocated length of the buffer
3016 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003017 *
3018 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3019 * make sure that either the old or the new name pointer and length are
3020 * fetched. However, there may be mismatch between length and pointer.
3021 * The length cannot be trusted, we need to copy it byte-by-byte until
3022 * the length is reached or a null byte is found. It also prepends "/" at
3023 * the beginning of the name. The sequence number check at the caller will
3024 * retry it again when a d_move() does happen. So any garbage in the buffer
3025 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003026 *
3027 * Data dependency barrier is needed to make sure that we see that terminating
3028 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003029 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003030static int prepend_name(char **buffer, int *buflen, struct qstr *name)
3031{
Waiman Long232d2d62013-09-09 12:18:13 -04003032 const char *dname = ACCESS_ONCE(name->name);
3033 u32 dlen = ACCESS_ONCE(name->len);
3034 char *p;
3035
Al Viro6d13f692014-09-29 14:46:30 -04003036 smp_read_barrier_depends();
3037
Waiman Long232d2d62013-09-09 12:18:13 -04003038 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003039 if (*buflen < 0)
3040 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003041 p = *buffer -= dlen + 1;
3042 *p++ = '/';
3043 while (dlen--) {
3044 char c = *dname++;
3045 if (!c)
3046 break;
3047 *p++ = c;
3048 }
3049 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003050}
3051
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003053 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003054 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003055 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003056 * @buffer: pointer to the end of the buffer
3057 * @buflen: pointer to buffer length
3058 *
Waiman Long18129972013-09-12 10:55:35 -04003059 * The function will first try to write out the pathname without taking any
3060 * lock other than the RCU read lock to make sure that dentries won't go away.
3061 * It only checks the sequence number of the global rename_lock as any change
3062 * in the dentry's d_seq will be preceded by changes in the rename_lock
3063 * sequence number. If the sequence number had been changed, it will restart
3064 * the whole pathname back-tracing sequence again by taking the rename_lock.
3065 * In this case, there is no need to take the RCU read lock as the recursive
3066 * parent pointer references will keep the dentry chain alive as long as no
3067 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003068 */
Al Viro02125a82011-12-05 08:43:34 -05003069static int prepend_path(const struct path *path,
3070 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003071 char **buffer, int *buflen)
3072{
Al Viroede4ceb2013-11-13 07:45:40 -05003073 struct dentry *dentry;
3074 struct vfsmount *vfsmnt;
3075 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003076 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003077 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003078 char *bptr;
3079 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003080
Al Viro48f5ec22013-09-09 15:22:25 -04003081 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003082restart_mnt:
3083 read_seqbegin_or_lock(&mount_lock, &m_seq);
3084 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003085 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003086restart:
3087 bptr = *buffer;
3088 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003089 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003090 dentry = path->dentry;
3091 vfsmnt = path->mnt;
3092 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003093 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003094 while (dentry != root->dentry || vfsmnt != root->mnt) {
3095 struct dentry * parent;
3096
3097 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003098 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003099 /* Escaped? */
3100 if (dentry != vfsmnt->mnt_root) {
3101 bptr = *buffer;
3102 blen = *buflen;
3103 error = 3;
3104 break;
3105 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003106 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003107 if (mnt != parent) {
3108 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3109 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003110 vfsmnt = &mnt->mnt;
3111 continue;
3112 }
Waiman Long232d2d62013-09-09 12:18:13 -04003113 if (!error)
3114 error = is_mounted(vfsmnt) ? 1 : 2;
3115 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003116 }
3117 parent = dentry->d_parent;
3118 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003119 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003120 if (error)
3121 break;
3122
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003123 dentry = parent;
3124 }
Al Viro48f5ec22013-09-09 15:22:25 -04003125 if (!(seq & 1))
3126 rcu_read_unlock();
3127 if (need_seqretry(&rename_lock, seq)) {
3128 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003129 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003130 }
Al Viro48f5ec22013-09-09 15:22:25 -04003131 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003132
3133 if (!(m_seq & 1))
3134 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003135 if (need_seqretry(&mount_lock, m_seq)) {
3136 m_seq = 1;
3137 goto restart_mnt;
3138 }
3139 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003140
Waiman Long232d2d62013-09-09 12:18:13 -04003141 if (error >= 0 && bptr == *buffer) {
3142 if (--blen < 0)
3143 error = -ENAMETOOLONG;
3144 else
3145 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003146 }
Waiman Long232d2d62013-09-09 12:18:13 -04003147 *buffer = bptr;
3148 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003149 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003150}
3151
3152/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003153 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003154 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003155 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003156 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157 * @buflen: buffer length
3158 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003159 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003161 * Returns a pointer into the buffer or an error code if the
3162 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003163 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003164 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003165 *
Al Viro02125a82011-12-05 08:43:34 -05003166 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167 */
Al Viro02125a82011-12-05 08:43:34 -05003168char *__d_path(const struct path *path,
3169 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003170 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003172 char *res = buf + buflen;
3173 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003175 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003176 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003177
Al Viro02125a82011-12-05 08:43:34 -05003178 if (error < 0)
3179 return ERR_PTR(error);
3180 if (error > 0)
3181 return NULL;
3182 return res;
3183}
3184
3185char *d_absolute_path(const struct path *path,
3186 char *buf, int buflen)
3187{
3188 struct path root = {};
3189 char *res = buf + buflen;
3190 int error;
3191
3192 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003193 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003194
3195 if (error > 1)
3196 error = -EINVAL;
3197 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003198 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003199 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200}
3201
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003202/*
3203 * same as __d_path but appends "(deleted)" for unlinked files.
3204 */
Al Viro02125a82011-12-05 08:43:34 -05003205static int path_with_deleted(const struct path *path,
3206 const struct path *root,
3207 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003208{
3209 prepend(buf, buflen, "\0", 1);
3210 if (d_unlinked(path->dentry)) {
3211 int error = prepend(buf, buflen, " (deleted)", 10);
3212 if (error)
3213 return error;
3214 }
3215
3216 return prepend_path(path, root, buf, buflen);
3217}
3218
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003219static int prepend_unreachable(char **buffer, int *buflen)
3220{
3221 return prepend(buffer, buflen, "(unreachable)", 13);
3222}
3223
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003224static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3225{
3226 unsigned seq;
3227
3228 do {
3229 seq = read_seqcount_begin(&fs->seq);
3230 *root = fs->root;
3231 } while (read_seqcount_retry(&fs->seq, seq));
3232}
3233
Jan Bluncka03a8a702008-02-14 19:38:32 -08003234/**
3235 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003236 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003237 * @buf: buffer to return value in
3238 * @buflen: buffer length
3239 *
3240 * Convert a dentry into an ASCII path name. If the entry has been deleted
3241 * the string " (deleted)" is appended. Note that this is ambiguous.
3242 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003243 * Returns a pointer into the buffer or an error code if the path was
3244 * too long. Note: Callers should use the returned pointer, not the passed
3245 * in buffer, to use the name! The implementation often starts at an offset
3246 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003247 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003248 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003249 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003250char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003252 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003253 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003254 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003256 /*
3257 * We have various synthetic filesystems that never get mounted. On
3258 * these filesystems dentries are never used for lookup purposes, and
3259 * thus don't need to be hashed. They also don't need a name until a
3260 * user wants to identify the object in /proc/pid/fd/. The little hack
3261 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003262 *
3263 * Some pseudo inodes are mountable. When they are mounted
3264 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3265 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003266 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003267 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3268 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003269 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003270
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003271 rcu_read_lock();
3272 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003273 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003274 rcu_read_unlock();
3275
Al Viro02125a82011-12-05 08:43:34 -05003276 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003277 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278 return res;
3279}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003280EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281
3282/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003283 * Helper function for dentry_operations.d_dname() members
3284 */
3285char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3286 const char *fmt, ...)
3287{
3288 va_list args;
3289 char temp[64];
3290 int sz;
3291
3292 va_start(args, fmt);
3293 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3294 va_end(args);
3295
3296 if (sz > sizeof(temp) || sz > buflen)
3297 return ERR_PTR(-ENAMETOOLONG);
3298
3299 buffer += buflen - sz;
3300 return memcpy(buffer, temp, sz);
3301}
3302
Al Viro118b2302013-08-24 12:08:17 -04003303char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3304{
3305 char *end = buffer + buflen;
3306 /* these dentries are never renamed, so d_lock is not needed */
3307 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003308 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003309 prepend(&end, &buflen, "/", 1))
3310 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003311 return end;
Al Viro118b2302013-08-24 12:08:17 -04003312}
David Herrmann31bbe162014-01-03 14:09:47 +01003313EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003314
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003315/*
Ram Pai6092d042008-03-27 13:06:20 +01003316 * Write full pathname from the root of the filesystem into the buffer.
3317 */
Al Virof6500802014-01-26 12:37:55 -05003318static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003319{
Al Virof6500802014-01-26 12:37:55 -05003320 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003321 char *end, *retval;
3322 int len, seq = 0;
3323 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003324
Al Virof6500802014-01-26 12:37:55 -05003325 if (buflen < 2)
3326 goto Elong;
3327
Al Viro48f5ec22013-09-09 15:22:25 -04003328 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003329restart:
Al Virof6500802014-01-26 12:37:55 -05003330 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003331 end = buf + buflen;
3332 len = buflen;
3333 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003334 /* Get '/' right */
3335 retval = end-1;
3336 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003337 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003338 while (!IS_ROOT(dentry)) {
3339 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003340
Ram Pai6092d042008-03-27 13:06:20 +01003341 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003342 error = prepend_name(&end, &len, &dentry->d_name);
3343 if (error)
3344 break;
Ram Pai6092d042008-03-27 13:06:20 +01003345
3346 retval = end;
3347 dentry = parent;
3348 }
Al Viro48f5ec22013-09-09 15:22:25 -04003349 if (!(seq & 1))
3350 rcu_read_unlock();
3351 if (need_seqretry(&rename_lock, seq)) {
3352 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003353 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003354 }
3355 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003356 if (error)
3357 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003358 return retval;
3359Elong:
3360 return ERR_PTR(-ENAMETOOLONG);
3361}
Nick Pigginec2447c2011-01-07 17:49:29 +11003362
3363char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3364{
Waiman Long232d2d62013-09-09 12:18:13 -04003365 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003366}
3367EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003368
3369char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3370{
3371 char *p = NULL;
3372 char *retval;
3373
Al Viroc1031352010-06-06 22:31:14 -04003374 if (d_unlinked(dentry)) {
3375 p = buf + buflen;
3376 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3377 goto Elong;
3378 buflen++;
3379 }
3380 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003381 if (!IS_ERR(retval) && p)
3382 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003383 return retval;
3384Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003385 return ERR_PTR(-ENAMETOOLONG);
3386}
3387
Linus Torvalds8b19e342013-09-12 10:35:47 -07003388static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3389 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003390{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003391 unsigned seq;
3392
3393 do {
3394 seq = read_seqcount_begin(&fs->seq);
3395 *root = fs->root;
3396 *pwd = fs->pwd;
3397 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003398}
3399
Ram Pai6092d042008-03-27 13:06:20 +01003400/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401 * NOTE! The user-level library version returns a
3402 * character pointer. The kernel system call just
3403 * returns the length of the buffer filled (which
3404 * includes the ending '\0' character), or a negative
3405 * error value. So libc would do something like
3406 *
3407 * char *getcwd(char * buf, size_t size)
3408 * {
3409 * int retval;
3410 *
3411 * retval = sys_getcwd(buf, size);
3412 * if (retval >= 0)
3413 * return buf;
3414 * errno = -retval;
3415 * return NULL;
3416 * }
3417 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003418SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419{
Linus Torvalds552ce542007-02-13 12:08:18 -08003420 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003421 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003422 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003423
3424 if (!page)
3425 return -ENOMEM;
3426
Linus Torvalds8b19e342013-09-12 10:35:47 -07003427 rcu_read_lock();
3428 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429
Linus Torvalds552ce542007-02-13 12:08:18 -08003430 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003431 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003432 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003433 char *cwd = page + PATH_MAX;
3434 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003436 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003437 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003438 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003439
Al Viro02125a82011-12-05 08:43:34 -05003440 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003441 goto out;
3442
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003443 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003444 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003445 error = prepend_unreachable(&cwd, &buflen);
3446 if (error)
3447 goto out;
3448 }
3449
Linus Torvalds552ce542007-02-13 12:08:18 -08003450 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003451 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003452 if (len <= size) {
3453 error = len;
3454 if (copy_to_user(buf, cwd, len))
3455 error = -EFAULT;
3456 }
Nick Piggin949854d2011-01-07 17:49:37 +11003457 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003458 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003459 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460
3461out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003462 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 return error;
3464}
3465
3466/*
3467 * Test whether new_dentry is a subdirectory of old_dentry.
3468 *
3469 * Trivially implemented using the dcache structure
3470 */
3471
3472/**
3473 * is_subdir - is new dentry a subdirectory of old_dentry
3474 * @new_dentry: new dentry
3475 * @old_dentry: old dentry
3476 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003477 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3478 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3480 */
3481
Yaowei Baia6e57872015-11-17 14:40:11 +08003482bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483{
Yaowei Baia6e57872015-11-17 14:40:11 +08003484 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003485 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003486
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003487 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003488 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003489
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003490 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003491 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003493 /*
3494 * Need rcu_readlock to protect against the d_parent trashing
3495 * due to d_move
3496 */
3497 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003498 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003499 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003500 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003501 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003502 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003504
3505 return result;
3506}
3507
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003508static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003510 struct dentry *root = data;
3511 if (dentry != root) {
3512 if (d_unhashed(dentry) || !dentry->d_inode)
3513 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003515 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3516 dentry->d_flags |= DCACHE_GENOCIDE;
3517 dentry->d_lockref.count--;
3518 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003520 return D_WALK_CONTINUE;
3521}
Nick Piggin58db63d2011-01-07 17:49:39 +11003522
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003523void d_genocide(struct dentry *parent)
3524{
3525 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526}
3527
Al Viro60545d02013-06-07 01:20:27 -04003528void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003529{
Al Viro60545d02013-06-07 01:20:27 -04003530 inode_dec_link_count(inode);
3531 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003532 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003533 !d_unlinked(dentry));
3534 spin_lock(&dentry->d_parent->d_lock);
3535 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3536 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3537 (unsigned long long)inode->i_ino);
3538 spin_unlock(&dentry->d_lock);
3539 spin_unlock(&dentry->d_parent->d_lock);
3540 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003541}
Al Viro60545d02013-06-07 01:20:27 -04003542EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003543
3544static __initdata unsigned long dhash_entries;
3545static int __init set_dhash_entries(char *str)
3546{
3547 if (!str)
3548 return 0;
3549 dhash_entries = simple_strtoul(str, &str, 0);
3550 return 1;
3551}
3552__setup("dhash_entries=", set_dhash_entries);
3553
3554static void __init dcache_init_early(void)
3555{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003556 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557
3558 /* If hashes are distributed across NUMA nodes, defer
3559 * hash allocation until vmalloc space is available.
3560 */
3561 if (hashdist)
3562 return;
3563
3564 dentry_hashtable =
3565 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003566 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003567 dhash_entries,
3568 13,
3569 HASH_EARLY,
3570 &d_hash_shift,
3571 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003572 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 0);
3574
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003575 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003576 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577}
3578
Denis Cheng74bf17c2007-10-16 23:26:30 -07003579static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003581 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582
3583 /*
3584 * A constructor could be added for stable state like the lists,
3585 * but it is probably not worth it because of the cache nature
3586 * of the dcache.
3587 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003588 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003589 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590
3591 /* Hash may have been set up in dcache_init_early */
3592 if (!hashdist)
3593 return;
3594
3595 dentry_hashtable =
3596 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003597 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 dhash_entries,
3599 13,
3600 0,
3601 &d_hash_shift,
3602 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003603 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604 0);
3605
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003606 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003607 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608}
3609
3610/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003611struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003612EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003613
Linus Torvalds1da177e2005-04-16 15:20:36 -07003614EXPORT_SYMBOL(d_genocide);
3615
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616void __init vfs_caches_init_early(void)
3617{
3618 dcache_init_early();
3619 inode_init_early();
3620}
3621
Mel Gorman4248b0d2015-08-06 15:46:20 -07003622void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003623{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003625 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003626
Denis Cheng74bf17c2007-10-16 23:26:30 -07003627 dcache_init();
3628 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003629 files_init();
3630 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003631 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632 bdev_cache_init();
3633 chrdev_init();
3634}