blob: dc37c0238b46adf9e46465e8606365118b3327fc [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
Nick Piggin31e6b012011-01-07 17:49:52 +1100337 * d_iput() operation if defined. Dentry has no refcount
338 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800340static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200341 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100342 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
344 struct inode *inode = dentry->d_inode;
345 if (inode) {
David Howells4bf46a22015-03-05 14:09:22 +0000346 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400347 hlist_del_init(&dentry->d_u.d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100349 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700350 if (!inode->i_nlink)
351 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 if (dentry->d_op && dentry->d_op->d_iput)
353 dentry->d_op->d_iput(dentry, inode);
354 else
355 iput(inode);
356 } else {
357 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 }
359}
360
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700361/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100362 * Release the dentry's inode, using the filesystem
363 * d_iput() operation if defined. dentry remains in-use.
364 */
365static void dentry_unlink_inode(struct dentry * dentry)
366 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100367 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100368{
369 struct inode *inode = dentry->d_inode;
Al Viroa528aca2016-02-29 12:12:46 -0500370
371 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000372 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400373 hlist_del_init(&dentry->d_u.d_alias);
Al Viroa528aca2016-02-29 12:12:46 -0500374 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100375 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100376 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100377 if (!inode->i_nlink)
378 fsnotify_inoderemove(inode);
379 if (dentry->d_op && dentry->d_op->d_iput)
380 dentry->d_op->d_iput(dentry, inode);
381 else
382 iput(inode);
383}
384
385/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400386 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
387 * is in use - which includes both the "real" per-superblock
388 * LRU list _and_ the DCACHE_SHRINK_LIST use.
389 *
390 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
391 * on the shrink list (ie not on the superblock LRU list).
392 *
393 * The per-cpu "nr_dentry_unused" counters are updated with
394 * the DCACHE_LRU_LIST bit.
395 *
396 * These helper functions make sure we always follow the
397 * rules. d_lock must be held by the caller.
398 */
399#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
400static void d_lru_add(struct dentry *dentry)
401{
402 D_FLAG_VERIFY(dentry, 0);
403 dentry->d_flags |= DCACHE_LRU_LIST;
404 this_cpu_inc(nr_dentry_unused);
405 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
406}
407
408static void d_lru_del(struct dentry *dentry)
409{
410 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
411 dentry->d_flags &= ~DCACHE_LRU_LIST;
412 this_cpu_dec(nr_dentry_unused);
413 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
414}
415
416static void d_shrink_del(struct dentry *dentry)
417{
418 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
419 list_del_init(&dentry->d_lru);
420 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
421 this_cpu_dec(nr_dentry_unused);
422}
423
424static void d_shrink_add(struct dentry *dentry, struct list_head *list)
425{
426 D_FLAG_VERIFY(dentry, 0);
427 list_add(&dentry->d_lru, list);
428 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
429 this_cpu_inc(nr_dentry_unused);
430}
431
432/*
433 * These can only be called under the global LRU lock, ie during the
434 * callback for freeing the LRU list. "isolate" removes it from the
435 * LRU lists entirely, while shrink_move moves it to the indicated
436 * private list.
437 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800438static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400439{
440 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
441 dentry->d_flags &= ~DCACHE_LRU_LIST;
442 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800443 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400444}
445
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800446static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
447 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400448{
449 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
450 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800451 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400452}
453
454/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000455 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700456 */
457static void dentry_lru_add(struct dentry *dentry)
458{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400459 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
460 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700461}
462
Miklos Szeredid52b9082007-05-08 00:23:46 -0700463/**
Nick Piggin789680d2011-01-07 17:49:30 +1100464 * d_drop - drop a dentry
465 * @dentry: dentry to drop
466 *
467 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
468 * be found through a VFS lookup any more. Note that this is different from
469 * deleting the dentry - d_delete will try to mark the dentry negative if
470 * possible, giving a successful _negative_ lookup, while d_drop will
471 * just make the cache lookup fail.
472 *
473 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
474 * reason (NFS timeouts or autofs deletes).
475 *
476 * __d_drop requires dentry->d_lock.
477 */
478void __d_drop(struct dentry *dentry)
479{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700480 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400481 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400482 /*
483 * Hashed dentries are normally on the dentry hashtable,
484 * with the exception of those newly allocated by
485 * d_obtain_alias, which are always IS_ROOT:
486 */
487 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400488 b = &dentry->d_sb->s_anon;
489 else
490 b = d_hash(dentry->d_parent, dentry->d_name.hash);
491
492 hlist_bl_lock(b);
493 __hlist_bl_del(&dentry->d_hash);
494 dentry->d_hash.pprev = NULL;
495 hlist_bl_unlock(b);
Peter Zijlstraa7c6f572015-06-11 14:46:46 +0200496 dentry_rcuwalk_invalidate(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100497 }
498}
499EXPORT_SYMBOL(__d_drop);
500
501void d_drop(struct dentry *dentry)
502{
Nick Piggin789680d2011-01-07 17:49:30 +1100503 spin_lock(&dentry->d_lock);
504 __d_drop(dentry);
505 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100506}
507EXPORT_SYMBOL(d_drop);
508
Al Viroba65dc52016-06-10 11:32:47 -0400509static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
510{
511 struct dentry *next;
512 /*
513 * Inform d_walk() and shrink_dentry_list() that we are no longer
514 * attached to the dentry tree
515 */
516 dentry->d_flags |= DCACHE_DENTRY_KILLED;
517 if (unlikely(list_empty(&dentry->d_child)))
518 return;
519 __list_del_entry(&dentry->d_child);
520 /*
521 * Cursors can move around the list of children. While we'd been
522 * a normal list member, it didn't matter - ->d_child.next would've
523 * been updated. However, from now on it won't be and for the
524 * things like d_walk() it might end up with a nasty surprise.
525 * Normally d_walk() doesn't care about cursors moving around -
526 * ->d_lock on parent prevents that and since a cursor has no children
527 * of its own, we get through it without ever unlocking the parent.
528 * There is one exception, though - if we ascend from a child that
529 * gets killed as soon as we unlock it, the next sibling is found
530 * using the value left in its ->d_child.next. And if _that_
531 * pointed to a cursor, and cursor got moved (e.g. by lseek())
532 * before d_walk() regains parent->d_lock, we'll end up skipping
533 * everything the cursor had been moved past.
534 *
535 * Solution: make sure that the pointer left behind in ->d_child.next
536 * points to something that won't be moving around. I.e. skip the
537 * cursors.
538 */
539 while (dentry->d_child.next != &parent->d_subdirs) {
540 next = list_entry(dentry->d_child.next, struct dentry, d_child);
541 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
542 break;
543 dentry->d_child.next = next->d_child.next;
544 }
545}
546
Al Viroe55fd012014-05-28 13:51:12 -0400547static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100548{
Al Viro41edf272014-05-01 10:30:00 -0400549 struct dentry *parent = NULL;
550 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400551 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100552 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100553
Linus Torvalds0d984392013-09-08 13:46:52 -0700554 /*
555 * The dentry is now unrecoverably dead to the world.
556 */
557 lockref_mark_dead(&dentry->d_lockref);
558
Sage Weilf0023bc2011-10-28 10:02:42 -0700559 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700560 * inform the fs via d_prune that this dentry is about to be
561 * unhashed and destroyed.
562 */
Al Viro29266202014-05-30 11:39:02 -0400563 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800564 dentry->d_op->d_prune(dentry);
565
Al Viro01b60352014-04-29 23:42:52 -0400566 if (dentry->d_flags & DCACHE_LRU_LIST) {
567 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
568 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400569 }
Nick Piggin77812a12011-01-07 17:49:48 +1100570 /* if it was on the hash then remove it */
571 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400572 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400573 if (parent)
574 spin_unlock(&parent->d_lock);
575 dentry_iput(dentry);
576 /*
577 * dentry_iput drops the locks, at which point nobody (except
578 * transient RCU lookups) can reach this dentry.
579 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800580 BUG_ON(dentry->d_lockref.count > 0);
Al Viro03b3b882014-04-29 15:45:28 -0400581 this_cpu_dec(nr_dentry);
582 if (dentry->d_op && dentry->d_op->d_release)
583 dentry->d_op->d_release(dentry);
584
Al Viro41edf272014-05-01 10:30:00 -0400585 spin_lock(&dentry->d_lock);
586 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
587 dentry->d_flags |= DCACHE_MAY_FREE;
588 can_free = false;
589 }
590 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400591 if (likely(can_free))
592 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400593}
594
595/*
596 * Finish off a dentry we've decided to kill.
597 * dentry->d_lock must be held, returns with it unlocked.
598 * If ref is non-zero, then decrement the refcount too.
599 * Returns dentry requiring refcount drop, or NULL if we're done.
600 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400601static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400602 __releases(dentry->d_lock)
603{
604 struct inode *inode = dentry->d_inode;
605 struct dentry *parent = NULL;
606
607 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
608 goto failed;
609
610 if (!IS_ROOT(dentry)) {
611 parent = dentry->d_parent;
612 if (unlikely(!spin_trylock(&parent->d_lock))) {
613 if (inode)
614 spin_unlock(&inode->i_lock);
615 goto failed;
616 }
617 }
618
619 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400620 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400621
622failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400623 spin_unlock(&dentry->d_lock);
624 cpu_relax();
Al Viroe55fd012014-05-28 13:51:12 -0400625 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100626}
627
Al Viro046b9612014-05-29 08:54:52 -0400628static inline struct dentry *lock_parent(struct dentry *dentry)
629{
630 struct dentry *parent = dentry->d_parent;
631 if (IS_ROOT(dentry))
632 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800633 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400634 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400635 if (likely(spin_trylock(&parent->d_lock)))
636 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400637 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400638 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400639again:
640 parent = ACCESS_ONCE(dentry->d_parent);
641 spin_lock(&parent->d_lock);
642 /*
643 * We can't blindly lock dentry until we are sure
644 * that we won't violate the locking order.
645 * Any changes of dentry->d_parent must have
646 * been done with parent->d_lock held, so
647 * spin_lock() above is enough of a barrier
648 * for checking if it's still our child.
649 */
650 if (unlikely(parent != dentry->d_parent)) {
651 spin_unlock(&parent->d_lock);
652 goto again;
653 }
654 rcu_read_unlock();
655 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700656 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400657 else
658 parent = NULL;
659 return parent;
660}
661
Linus Torvalds360f5472015-01-09 15:19:03 -0800662/*
663 * Try to do a lockless dput(), and return whether that was successful.
664 *
665 * If unsuccessful, we return false, having already taken the dentry lock.
666 *
667 * The caller needs to hold the RCU read lock, so that the dentry is
668 * guaranteed to stay around even if the refcount goes down to zero!
669 */
670static inline bool fast_dput(struct dentry *dentry)
671{
672 int ret;
673 unsigned int d_flags;
674
675 /*
676 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100677 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800678 */
679 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
680 return lockref_put_or_lock(&dentry->d_lockref);
681
682 /*
683 * .. otherwise, we can try to just decrement the
684 * lockref optimistically.
685 */
686 ret = lockref_put_return(&dentry->d_lockref);
687
688 /*
689 * If the lockref_put_return() failed due to the lock being held
690 * by somebody else, the fast path has failed. We will need to
691 * get the lock, and then check the count again.
692 */
693 if (unlikely(ret < 0)) {
694 spin_lock(&dentry->d_lock);
695 if (dentry->d_lockref.count > 1) {
696 dentry->d_lockref.count--;
697 spin_unlock(&dentry->d_lock);
698 return 1;
699 }
700 return 0;
701 }
702
703 /*
704 * If we weren't the last ref, we're done.
705 */
706 if (ret)
707 return 1;
708
709 /*
710 * Careful, careful. The reference count went down
711 * to zero, but we don't hold the dentry lock, so
712 * somebody else could get it again, and do another
713 * dput(), and we need to not race with that.
714 *
715 * However, there is a very special and common case
716 * where we don't care, because there is nothing to
717 * do: the dentry is still hashed, it does not have
718 * a 'delete' op, and it's referenced and already on
719 * the LRU list.
720 *
721 * NOTE! Since we aren't locked, these values are
722 * not "stable". However, it is sufficient that at
723 * some point after we dropped the reference the
724 * dentry was hashed and the flags had the proper
725 * value. Other dentry users may have re-gotten
726 * a reference to the dentry and change that, but
727 * our work is done - we can leave the dentry
728 * around with a zero refcount.
729 */
730 smp_rmb();
731 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100732 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800733
734 /* Nothing to do? Dropping the reference was all we needed? */
735 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
736 return 1;
737
738 /*
739 * Not the fast normal case? Get the lock. We've already decremented
740 * the refcount, but we'll need to re-check the situation after
741 * getting the lock.
742 */
743 spin_lock(&dentry->d_lock);
744
745 /*
746 * Did somebody else grab a reference to it in the meantime, and
747 * we're no longer the last user after all? Alternatively, somebody
748 * else could have killed it and marked it dead. Either way, we
749 * don't need to do anything else.
750 */
751 if (dentry->d_lockref.count) {
752 spin_unlock(&dentry->d_lock);
753 return 1;
754 }
755
756 /*
757 * Re-get the reference we optimistically dropped. We hold the
758 * lock, and we just tested that it was zero, so we can just
759 * set it to 1.
760 */
761 dentry->d_lockref.count = 1;
762 return 0;
763}
764
765
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766/*
767 * This is dput
768 *
769 * This is complicated by the fact that we do not want to put
770 * dentries that are no longer on any hash chain on the unused
771 * list: we'd much rather just get rid of them immediately.
772 *
773 * However, that implies that we have to traverse the dentry
774 * tree upwards to the parents which might _also_ now be
775 * scheduled for deletion (it may have been only waiting for
776 * its last child to go away).
777 *
778 * This tail recursion is done by hand as we don't want to depend
779 * on the compiler to always get this right (gcc generally doesn't).
780 * Real recursion would eat up our stack space.
781 */
782
783/*
784 * dput - release a dentry
785 * @dentry: dentry to release
786 *
787 * Release a dentry. This will drop the usage count and if appropriate
788 * call the dentry unlink method as well as removing it from the queues and
789 * releasing its resources. If the parent dentries were scheduled for release
790 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792void dput(struct dentry *dentry)
793{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700794 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 return;
796
797repeat:
Linus Torvalds360f5472015-01-09 15:19:03 -0800798 rcu_read_lock();
799 if (likely(fast_dput(dentry))) {
800 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800802 }
803
804 /* Slow case: now with the dentry lock held */
805 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Al Viro85c7f812016-04-14 19:52:13 -0400807 WARN_ON(d_in_lookup(dentry));
808
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700809 /* Unreachable? Get rid of it */
810 if (unlikely(d_unhashed(dentry)))
811 goto kill_it;
812
Al Viro75a6f822015-07-08 02:42:38 +0100813 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
814 goto kill_it;
815
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700816 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100818 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 }
Nick Piggin265ac902010-10-10 05:36:24 -0400820
Linus Torvalds358eec12013-10-31 15:43:02 -0700821 if (!(dentry->d_flags & DCACHE_REFERENCED))
822 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400823 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400824
Waiman Long98474232013-08-28 18:24:59 -0700825 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100826 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 return;
828
Miklos Szeredid52b9082007-05-08 00:23:46 -0700829kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400830 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700831 if (dentry)
832 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700834EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100837/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100838static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839{
Waiman Long98474232013-08-28 18:24:59 -0700840 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
Nick Piggindc0474b2011-01-07 17:49:43 +1100843static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100844{
Waiman Long98474232013-08-28 18:24:59 -0700845 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100846}
847
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100848struct dentry *dget_parent(struct dentry *dentry)
849{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700850 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100851 struct dentry *ret;
852
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700853 /*
854 * Do optimistic parent lookup without any
855 * locking.
856 */
857 rcu_read_lock();
858 ret = ACCESS_ONCE(dentry->d_parent);
859 gotref = lockref_get_not_zero(&ret->d_lockref);
860 rcu_read_unlock();
861 if (likely(gotref)) {
862 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
863 return ret;
864 dput(ret);
865 }
866
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100867repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100868 /*
869 * Don't need rcu_dereference because we re-check it was correct under
870 * the lock.
871 */
872 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100873 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100874 spin_lock(&ret->d_lock);
875 if (unlikely(ret != dentry->d_parent)) {
876 spin_unlock(&ret->d_lock);
877 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100878 goto repeat;
879 }
Nick Piggina734eb42011-01-07 17:49:44 +1100880 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700881 BUG_ON(!ret->d_lockref.count);
882 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100883 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100884 return ret;
885}
886EXPORT_SYMBOL(dget_parent);
887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888/**
889 * d_find_alias - grab a hashed alias of inode
890 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 *
892 * If inode has a hashed alias, or is a directory and has any alias,
893 * acquire the reference to alias and return it. Otherwise return NULL.
894 * Notice that if inode is a directory there can be only one alias and
895 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800896 * of a filesystem, or if the directory was renamed and d_revalidate
897 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700899 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500900 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500902static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Nick Pigginda502952011-01-07 17:49:33 +1100904 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Nick Pigginda502952011-01-07 17:49:33 +1100906again:
907 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400908 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100909 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700911 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100912 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500914 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100915 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100916 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 return alias;
918 }
919 }
Nick Pigginda502952011-01-07 17:49:33 +1100920 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 }
Nick Pigginda502952011-01-07 17:49:33 +1100922 if (discon_alias) {
923 alias = discon_alias;
924 spin_lock(&alias->d_lock);
925 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500926 __dget_dlock(alias);
927 spin_unlock(&alias->d_lock);
928 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100929 }
930 spin_unlock(&alias->d_lock);
931 goto again;
932 }
933 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934}
935
Nick Pigginda502952011-01-07 17:49:33 +1100936struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937{
David Howells214fda12006-03-25 03:06:36 -0800938 struct dentry *de = NULL;
939
Al Virob3d9b7a2012-06-09 13:51:19 -0400940 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100941 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500942 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100943 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800944 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 return de;
946}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700947EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
949/*
950 * Try to kill dentries associated with this inode.
951 * WARNING: you must own a reference to inode.
952 */
953void d_prune_aliases(struct inode *inode)
954{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700955 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100957 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400958 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700960 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400961 struct dentry *parent = lock_parent(dentry);
962 if (likely(!dentry->d_lockref.count)) {
963 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800964 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400965 goto restart;
966 }
967 if (parent)
968 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 }
970 spin_unlock(&dentry->d_lock);
971 }
Nick Piggin873feea2011-01-07 17:50:06 +1100972 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700974EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400976static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Al Viro5c47e6d2014-04-29 16:13:18 -0400978 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700979
Miklos Szeredi60942f22014-05-02 15:38:39 -0400980 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400981 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400982 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100983 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400984 parent = lock_parent(dentry);
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000987 * The dispose list is isolated and dentries are not accounted
988 * to the LRU here, so we can simply remove it from the list
989 * here regardless of whether it is referenced or not.
990 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400991 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000992
993 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000995 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800997 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700998 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400999 if (parent)
1000 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 continue;
1002 }
Nick Piggin77812a12011-01-07 17:49:48 +11001003
Al Viro64fd72e2014-05-28 09:48:44 -04001004
1005 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
1006 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
1007 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001008 if (parent)
1009 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -04001010 if (can_free)
1011 dentry_free(dentry);
1012 continue;
1013 }
1014
Al Viroff2fde92014-05-28 13:59:13 -04001015 inode = dentry->d_inode;
1016 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001017 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001018 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -04001019 if (parent)
1020 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -04001021 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001022 }
Al Viroff2fde92014-05-28 13:59:13 -04001023
Al Viroff2fde92014-05-28 13:59:13 -04001024 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -04001025
Al Viro5c47e6d2014-04-29 16:13:18 -04001026 /*
1027 * We need to prune ancestors too. This is necessary to prevent
1028 * quadratic behavior of shrink_dcache_parent(), but is also
1029 * expected to be beneficial in reducing dentry cache
1030 * fragmentation.
1031 */
1032 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -04001033 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
1034 parent = lock_parent(dentry);
1035 if (dentry->d_lockref.count != 1) {
1036 dentry->d_lockref.count--;
1037 spin_unlock(&dentry->d_lock);
1038 if (parent)
1039 spin_unlock(&parent->d_lock);
1040 break;
1041 }
1042 inode = dentry->d_inode; /* can't be NULL */
1043 if (unlikely(!spin_trylock(&inode->i_lock))) {
1044 spin_unlock(&dentry->d_lock);
1045 if (parent)
1046 spin_unlock(&parent->d_lock);
1047 cpu_relax();
1048 continue;
1049 }
1050 __dentry_kill(dentry);
1051 dentry = parent;
1052 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001054}
1055
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001056static enum lru_status dentry_lru_isolate(struct list_head *item,
1057 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001058{
1059 struct list_head *freeable = arg;
1060 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1061
1062
1063 /*
1064 * we are inverting the lru lock/dentry->d_lock here,
1065 * so use a trylock. If we fail to get the lock, just skip
1066 * it
1067 */
1068 if (!spin_trylock(&dentry->d_lock))
1069 return LRU_SKIP;
1070
1071 /*
1072 * Referenced dentries are still in use. If they have active
1073 * counts, just remove them from the LRU. Otherwise give them
1074 * another pass through the LRU.
1075 */
1076 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001077 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001078 spin_unlock(&dentry->d_lock);
1079 return LRU_REMOVED;
1080 }
1081
1082 if (dentry->d_flags & DCACHE_REFERENCED) {
1083 dentry->d_flags &= ~DCACHE_REFERENCED;
1084 spin_unlock(&dentry->d_lock);
1085
1086 /*
1087 * The list move itself will be made by the common LRU code. At
1088 * this point, we've dropped the dentry->d_lock but keep the
1089 * lru lock. This is safe to do, since every list movement is
1090 * protected by the lru lock even if both locks are held.
1091 *
1092 * This is guaranteed by the fact that all LRU management
1093 * functions are intermediated by the LRU API calls like
1094 * list_lru_add and list_lru_del. List movement in this file
1095 * only ever occur through this functions or through callbacks
1096 * like this one, that are called from the LRU API.
1097 *
1098 * The only exceptions to this are functions like
1099 * shrink_dentry_list, and code that first checks for the
1100 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1101 * operating only with stack provided lists after they are
1102 * properly isolated from the main list. It is thus, always a
1103 * local access.
1104 */
1105 return LRU_ROTATE;
1106 }
1107
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001108 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001109 spin_unlock(&dentry->d_lock);
1110
1111 return LRU_REMOVED;
1112}
1113
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001114/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001115 * prune_dcache_sb - shrink the dcache
1116 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001117 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001118 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001119 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1120 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001121 * function.
1122 *
1123 * This function may fail to free any resources if all the dentries are in
1124 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001125 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001126long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001127{
Dave Chinnerf6041562013-08-28 10:18:00 +10001128 LIST_HEAD(dispose);
1129 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001130
Vladimir Davydov503c3582015-02-12 14:58:47 -08001131 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1132 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001133 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001134 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135}
1136
Glauber Costa4e717f52013-08-28 10:18:03 +10001137static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001138 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001139{
Glauber Costa4e717f52013-08-28 10:18:03 +10001140 struct list_head *freeable = arg;
1141 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001142
Glauber Costa4e717f52013-08-28 10:18:03 +10001143 /*
1144 * we are inverting the lru lock/dentry->d_lock here,
1145 * so use a trylock. If we fail to get the lock, just skip
1146 * it
1147 */
1148 if (!spin_trylock(&dentry->d_lock))
1149 return LRU_SKIP;
1150
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001151 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001152 spin_unlock(&dentry->d_lock);
1153
1154 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001155}
1156
Glauber Costa4e717f52013-08-28 10:18:03 +10001157
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001158/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 * shrink_dcache_sb - shrink dcache for a superblock
1160 * @sb: superblock
1161 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001162 * Shrink the dcache for the specified super block. This is used to free
1163 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001165void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166{
Glauber Costa4e717f52013-08-28 10:18:03 +10001167 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001168
Glauber Costa4e717f52013-08-28 10:18:03 +10001169 do {
1170 LIST_HEAD(dispose);
1171
1172 freed = list_lru_walk(&sb->s_dentry_lru,
1173 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1174
1175 this_cpu_sub(nr_dentry_unused, freed);
1176 shrink_dentry_list(&dispose);
1177 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001179EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182 * enum d_walk_ret - action to talke during tree walk
1183 * @D_WALK_CONTINUE: contrinue walk
1184 * @D_WALK_QUIT: quit walk
1185 * @D_WALK_NORETRY: quit when retry is needed
1186 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001188enum d_walk_ret {
1189 D_WALK_CONTINUE,
1190 D_WALK_QUIT,
1191 D_WALK_NORETRY,
1192 D_WALK_SKIP,
1193};
1194
1195/**
1196 * d_walk - walk the dentry tree
1197 * @parent: start of walk
1198 * @data: data passed to @enter() and @finish()
1199 * @enter: callback when first entering the dentry
1200 * @finish: callback when successfully finished the walk
1201 *
1202 * The @enter() and @finish() callbacks are called with d_lock held.
1203 */
1204static void d_walk(struct dentry *parent, void *data,
1205 enum d_walk_ret (*enter)(void *, struct dentry *),
1206 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Nick Piggin949854d2011-01-07 17:49:37 +11001208 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001210 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 enum d_walk_ret ret;
1212 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001213
Nick Piggin58db63d2011-01-07 17:49:39 +11001214again:
Al Viro48f5ec22013-09-09 15:22:25 -04001215 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001216 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001217 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218
1219 ret = enter(data, this_parent);
1220 switch (ret) {
1221 case D_WALK_CONTINUE:
1222 break;
1223 case D_WALK_QUIT:
1224 case D_WALK_SKIP:
1225 goto out_unlock;
1226 case D_WALK_NORETRY:
1227 retry = false;
1228 break;
1229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230repeat:
1231 next = this_parent->d_subdirs.next;
1232resume:
1233 while (next != &this_parent->d_subdirs) {
1234 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001235 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001237
Al Viroba65dc52016-06-10 11:32:47 -04001238 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1239 continue;
1240
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001241 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242
1243 ret = enter(data, dentry);
1244 switch (ret) {
1245 case D_WALK_CONTINUE:
1246 break;
1247 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001248 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001249 goto out_unlock;
1250 case D_WALK_NORETRY:
1251 retry = false;
1252 break;
1253 case D_WALK_SKIP:
1254 spin_unlock(&dentry->d_lock);
1255 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001256 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001259 spin_unlock(&this_parent->d_lock);
1260 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001262 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 goto repeat;
1264 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001265 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 }
1267 /*
1268 * All done at this level ... ascend and resume the search.
1269 */
Al Viroca5358e2014-10-26 19:31:10 -04001270 rcu_read_lock();
1271ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001273 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001274 this_parent = child->d_parent;
1275
Al Viro31dec132013-10-25 17:04:27 -04001276 spin_unlock(&child->d_lock);
1277 spin_lock(&this_parent->d_lock);
1278
Al Viroca5358e2014-10-26 19:31:10 -04001279 /* might go back up the wrong parent if we have had a rename. */
1280 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001281 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001282 /* go into the first sibling still alive */
1283 do {
1284 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001285 if (next == &this_parent->d_subdirs)
1286 goto ascend;
1287 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001288 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001289 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 goto resume;
1291 }
Al Viroca5358e2014-10-26 19:31:10 -04001292 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001293 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001294 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001295 if (finish)
1296 finish(data);
1297
1298out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001299 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001300 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001301 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001302
1303rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001304 spin_unlock(&this_parent->d_lock);
1305 rcu_read_unlock();
1306 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001307 if (!retry)
1308 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001309 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001310 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001312
1313/*
1314 * Search for at least 1 mount point in the dentry's subdirs.
1315 * We descend to the next level whenever the d_subdirs
1316 * list is non-empty and continue searching.
1317 */
1318
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001319static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1320{
1321 int *ret = data;
1322 if (d_mountpoint(dentry)) {
1323 *ret = 1;
1324 return D_WALK_QUIT;
1325 }
1326 return D_WALK_CONTINUE;
1327}
1328
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001329/**
1330 * have_submounts - check for mounts over a dentry
1331 * @parent: dentry to check.
1332 *
1333 * Return true if the parent or its subdirectories contain
1334 * a mount point
1335 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336int have_submounts(struct dentry *parent)
1337{
1338 int ret = 0;
1339
1340 d_walk(parent, &ret, check_mount, NULL);
1341
1342 return ret;
1343}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001344EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001347 * Called by mount code to set a mountpoint and check if the mountpoint is
1348 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1349 * subtree can become unreachable).
1350 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001351 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001352 * this reason take rename_lock and d_lock on dentry and ancestors.
1353 */
1354int d_set_mounted(struct dentry *dentry)
1355{
1356 struct dentry *p;
1357 int ret = -ENOENT;
1358 write_seqlock(&rename_lock);
1359 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001360 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001361 spin_lock(&p->d_lock);
1362 if (unlikely(d_unhashed(p))) {
1363 spin_unlock(&p->d_lock);
1364 goto out;
1365 }
1366 spin_unlock(&p->d_lock);
1367 }
1368 spin_lock(&dentry->d_lock);
1369 if (!d_unlinked(dentry)) {
1370 dentry->d_flags |= DCACHE_MOUNTED;
1371 ret = 0;
1372 }
1373 spin_unlock(&dentry->d_lock);
1374out:
1375 write_sequnlock(&rename_lock);
1376 return ret;
1377}
1378
1379/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001380 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 * and move any unused dentries to the end of the unused
1382 * list for prune_dcache(). We descend to the next level
1383 * whenever the d_subdirs list is non-empty and continue
1384 * searching.
1385 *
1386 * It returns zero iff there are no unused children,
1387 * otherwise it returns the number of children moved to
1388 * the end of the unused list. This may not be the total
1389 * number of unused children, because select_parent can
1390 * drop the lock and return early due to latency
1391 * constraints.
1392 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001393
1394struct select_data {
1395 struct dentry *start;
1396 struct list_head dispose;
1397 int found;
1398};
1399
1400static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001402 struct select_data *data = _data;
1403 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001405 if (data->start == dentry)
1406 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Al Virofe915222014-05-03 00:02:25 -04001408 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001409 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001410 } else {
1411 if (dentry->d_flags & DCACHE_LRU_LIST)
1412 d_lru_del(dentry);
1413 if (!dentry->d_lockref.count) {
1414 d_shrink_add(dentry, &data->dispose);
1415 data->found++;
1416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 }
1418 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001419 * We can return to the caller if we have found some (this
1420 * ensures forward progress). We'll be coming back to find
1421 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 */
Al Virofe915222014-05-03 00:02:25 -04001423 if (!list_empty(&data->dispose))
1424 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001426 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
1428
1429/**
1430 * shrink_dcache_parent - prune dcache
1431 * @parent: parent of entries to prune
1432 *
1433 * Prune the dcache to remove unused children of the parent dentry.
1434 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001435void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001437 for (;;) {
1438 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001440 INIT_LIST_HEAD(&data.dispose);
1441 data.start = parent;
1442 data.found = 0;
1443
1444 d_walk(parent, &data, select_collect, NULL);
1445 if (!data.found)
1446 break;
1447
1448 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001449 cond_resched();
1450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001452EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Al Viro9c8c10e2014-05-02 20:36:10 -04001454static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001455{
Al Viro9c8c10e2014-05-02 20:36:10 -04001456 /* it has busy descendents; complain about those instead */
1457 if (!list_empty(&dentry->d_subdirs))
1458 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001459
Al Viro9c8c10e2014-05-02 20:36:10 -04001460 /* root with refcount 1 is fine */
1461 if (dentry == _data && dentry->d_lockref.count == 1)
1462 return D_WALK_CONTINUE;
1463
1464 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1465 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001466 dentry,
1467 dentry->d_inode ?
1468 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001469 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001470 dentry->d_lockref.count,
1471 dentry->d_sb->s_type->name,
1472 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001473 WARN_ON(1);
1474 return D_WALK_CONTINUE;
1475}
1476
1477static void do_one_tree(struct dentry *dentry)
1478{
1479 shrink_dcache_parent(dentry);
1480 d_walk(dentry, dentry, umount_check, NULL);
1481 d_drop(dentry);
1482 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001483}
1484
1485/*
1486 * destroy the dentries attached to a superblock on unmounting
1487 */
1488void shrink_dcache_for_umount(struct super_block *sb)
1489{
1490 struct dentry *dentry;
1491
Al Viro9c8c10e2014-05-02 20:36:10 -04001492 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001493
1494 dentry = sb->s_root;
1495 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001496 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001497
1498 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001499 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1500 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001501 }
1502}
1503
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001504struct detach_data {
1505 struct select_data select;
1506 struct dentry *mountpoint;
1507};
1508static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001509{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001510 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001511
1512 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001513 __dget_dlock(dentry);
1514 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001515 return D_WALK_QUIT;
1516 }
1517
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001518 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001519}
1520
1521static void check_and_drop(void *_data)
1522{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001523 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001524
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001525 if (!data->mountpoint && !data->select.found)
1526 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001527}
1528
1529/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001530 * d_invalidate - detach submounts, prune dcache, and drop
1531 * @dentry: dentry to invalidate (aka detach, prune and drop)
1532 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001533 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001534 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001535 * The final d_drop is done as an atomic operation relative to
1536 * rename_lock ensuring there are no races with d_set_mounted. This
1537 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001539void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001540{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001541 /*
1542 * If it's already been dropped, return OK.
1543 */
1544 spin_lock(&dentry->d_lock);
1545 if (d_unhashed(dentry)) {
1546 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001547 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001548 }
1549 spin_unlock(&dentry->d_lock);
1550
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001551 /* Negative dentries can be dropped without further checks */
1552 if (!dentry->d_inode) {
1553 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001554 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001555 }
1556
1557 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001558 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001559
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001560 data.mountpoint = NULL;
1561 INIT_LIST_HEAD(&data.select.dispose);
1562 data.select.start = dentry;
1563 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001564
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001565 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001566
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001567 if (data.select.found)
1568 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001569
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001570 if (data.mountpoint) {
1571 detach_mounts(data.mountpoint);
1572 dput(data.mountpoint);
1573 }
1574
1575 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001576 break;
1577
1578 cond_resched();
1579 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001580}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001581EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583/**
Al Viroa4464db2011-07-07 15:03:58 -04001584 * __d_alloc - allocate a dcache entry
1585 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 * @name: qstr of the name
1587 *
1588 * Allocates a dentry. It returns %NULL if there is insufficient memory
1589 * available. On a success the dentry is returned. The name passed in is
1590 * copied and the copy passed in may be reused after this call.
1591 */
1592
Al Viroa4464db2011-07-07 15:03:58 -04001593struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594{
1595 struct dentry *dentry;
1596 char *dname;
1597
Mel Gormane12ba742007-10-16 01:25:52 -07001598 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 if (!dentry)
1600 return NULL;
1601
Linus Torvalds6326c712012-05-21 16:14:04 -07001602 /*
1603 * We guarantee that the inline name is always NUL-terminated.
1604 * This way the memcpy() done by the name switching in rename
1605 * will still always have a NUL at the end, even if we might
1606 * be overwriting an internal NUL character
1607 */
1608 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001609 if (unlikely(!name)) {
1610 static const struct qstr anon = QSTR_INIT("/", 1);
1611 name = &anon;
1612 dname = dentry->d_iname;
1613 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001614 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001615 struct external_name *p = kmalloc(size + name->len,
1616 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001617 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 kmem_cache_free(dentry_cache, dentry);
1619 return NULL;
1620 }
Al Viro8d85b482014-09-29 14:54:27 -04001621 atomic_set(&p->u.count, 1);
1622 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001623 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1624 kasan_unpoison_shadow(dname,
1625 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 } else {
1627 dname = dentry->d_iname;
1628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 dentry->d_name.len = name->len;
1631 dentry->d_name.hash = name->hash;
1632 memcpy(dname, name->name, name->len);
1633 dname[name->len] = 0;
1634
Linus Torvalds6326c712012-05-21 16:14:04 -07001635 /* Make sure we always see the terminating NUL character */
1636 smp_wmb();
1637 dentry->d_name.name = dname;
1638
Waiman Long98474232013-08-28 18:24:59 -07001639 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001640 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001642 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001644 dentry->d_parent = dentry;
1645 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 dentry->d_op = NULL;
1647 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001648 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 INIT_LIST_HEAD(&dentry->d_lru);
1650 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001651 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1652 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001653 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Nick Piggin3e880fb2011-01-07 17:49:19 +11001655 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 return dentry;
1658}
Al Viroa4464db2011-07-07 15:03:58 -04001659
1660/**
1661 * d_alloc - allocate a dcache entry
1662 * @parent: parent of entry to allocate
1663 * @name: qstr of the name
1664 *
1665 * Allocates a dentry. It returns %NULL if there is insufficient memory
1666 * available. On a success the dentry is returned. The name passed in is
1667 * copied and the copy passed in may be reused after this call.
1668 */
1669struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1670{
1671 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1672 if (!dentry)
1673 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001674 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001675 spin_lock(&parent->d_lock);
1676 /*
1677 * don't need child lock because it is not subject
1678 * to concurrency here
1679 */
1680 __dget_dlock(parent);
1681 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001682 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001683 spin_unlock(&parent->d_lock);
1684
1685 return dentry;
1686}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001687EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Al Viroba65dc52016-06-10 11:32:47 -04001689struct dentry *d_alloc_cursor(struct dentry * parent)
1690{
1691 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1692 if (dentry) {
1693 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1694 dentry->d_parent = dget(parent);
1695 }
1696 return dentry;
1697}
1698
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001699/**
1700 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1701 * @sb: the superblock
1702 * @name: qstr of the name
1703 *
1704 * For a filesystem that just pins its dentries in memory and never
1705 * performs lookups at all, return an unhashed IS_ROOT dentry.
1706 */
Nick Piggin4b936882011-01-07 17:50:07 +11001707struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1708{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001709 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001710}
1711EXPORT_SYMBOL(d_alloc_pseudo);
1712
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1714{
1715 struct qstr q;
1716
1717 q.name = name;
George Spelvinfcfd2fb2016-05-20 08:41:37 -04001718 q.hash_len = hashlen_string(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return d_alloc(parent, &q);
1720}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001721EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
Nick Pigginfb045ad2011-01-07 17:49:55 +11001723void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1724{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001725 WARN_ON_ONCE(dentry->d_op);
1726 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001727 DCACHE_OP_COMPARE |
1728 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001729 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001730 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001731 DCACHE_OP_SELECT_INODE |
1732 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001733 dentry->d_op = op;
1734 if (!op)
1735 return;
1736 if (op->d_hash)
1737 dentry->d_flags |= DCACHE_OP_HASH;
1738 if (op->d_compare)
1739 dentry->d_flags |= DCACHE_OP_COMPARE;
1740 if (op->d_revalidate)
1741 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001742 if (op->d_weak_revalidate)
1743 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001744 if (op->d_delete)
1745 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001746 if (op->d_prune)
1747 dentry->d_flags |= DCACHE_OP_PRUNE;
David Howells4bacc9c2015-06-18 14:32:31 +01001748 if (op->d_select_inode)
1749 dentry->d_flags |= DCACHE_OP_SELECT_INODE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001750 if (op->d_real)
1751 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001752
1753}
1754EXPORT_SYMBOL(d_set_d_op);
1755
David Howellsdf1a0852015-01-29 12:02:28 +00001756
1757/*
1758 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1759 * @dentry - The dentry to mark
1760 *
1761 * Mark a dentry as falling through to the lower layer (as set with
1762 * d_pin_lower()). This flag may be recorded on the medium.
1763 */
1764void d_set_fallthru(struct dentry *dentry)
1765{
1766 spin_lock(&dentry->d_lock);
1767 dentry->d_flags |= DCACHE_FALLTHRU;
1768 spin_unlock(&dentry->d_lock);
1769}
1770EXPORT_SYMBOL(d_set_fallthru);
1771
David Howellsb18825a2013-09-12 19:22:53 +01001772static unsigned d_flags_for_inode(struct inode *inode)
1773{
David Howells44bdb5e2015-01-29 12:02:29 +00001774 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001775
1776 if (!inode)
1777 return DCACHE_MISS_TYPE;
1778
1779 if (S_ISDIR(inode->i_mode)) {
1780 add_flags = DCACHE_DIRECTORY_TYPE;
1781 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1782 if (unlikely(!inode->i_op->lookup))
1783 add_flags = DCACHE_AUTODIR_TYPE;
1784 else
1785 inode->i_opflags |= IOP_LOOKUP;
1786 }
David Howells44bdb5e2015-01-29 12:02:29 +00001787 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001788 }
1789
David Howells44bdb5e2015-01-29 12:02:29 +00001790 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001791 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001792 add_flags = DCACHE_SYMLINK_TYPE;
1793 goto type_determined;
1794 }
1795 inode->i_opflags |= IOP_NOFOLLOW;
1796 }
1797
1798 if (unlikely(!S_ISREG(inode->i_mode)))
1799 add_flags = DCACHE_SPECIAL_TYPE;
1800
1801type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001802 if (unlikely(IS_AUTOMOUNT(inode)))
1803 add_flags |= DCACHE_NEED_AUTOMOUNT;
1804 return add_flags;
1805}
1806
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001807static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1808{
David Howellsb18825a2013-09-12 19:22:53 +01001809 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001810 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001811
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001812 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001813 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001814 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001815 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001816 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001817 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001818 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001819}
1820
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821/**
1822 * d_instantiate - fill in inode information for a dentry
1823 * @entry: dentry to complete
1824 * @inode: inode to attach to this dentry
1825 *
1826 * Fill in inode information in the entry.
1827 *
1828 * This turns negative dentries into productive full members
1829 * of society.
1830 *
1831 * NOTE! This assumes that the inode count has been incremented
1832 * (or otherwise set) by the caller to indicate that it is now
1833 * in use by the dcache.
1834 */
1835
1836void d_instantiate(struct dentry *entry, struct inode * inode)
1837{
Al Viro946e51f2014-10-26 19:19:16 -04001838 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001839 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001840 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001841 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001842 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001843 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001846EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
1848/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001849 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1850 * @entry: dentry to complete
1851 * @inode: inode to attach to this dentry
1852 *
1853 * Fill in inode information in the entry. If a directory alias is found, then
1854 * return an error (and drop inode). Together with d_materialise_unique() this
1855 * guarantees that a directory inode may never have more than one alias.
1856 */
1857int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1858{
Al Viro946e51f2014-10-26 19:19:16 -04001859 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001860
Al Virob9680912016-04-11 00:53:26 -04001861 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001862 spin_lock(&inode->i_lock);
1863 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1864 spin_unlock(&inode->i_lock);
1865 iput(inode);
1866 return -EBUSY;
1867 }
1868 __d_instantiate(entry, inode);
1869 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001870
1871 return 0;
1872}
1873EXPORT_SYMBOL(d_instantiate_no_diralias);
1874
Al Viroadc0e912012-01-08 16:49:21 -05001875struct dentry *d_make_root(struct inode *root_inode)
1876{
1877 struct dentry *res = NULL;
1878
1879 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001880 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001881 if (res)
1882 d_instantiate(res, root_inode);
1883 else
1884 iput(root_inode);
1885 }
1886 return res;
1887}
1888EXPORT_SYMBOL(d_make_root);
1889
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001890static struct dentry * __d_find_any_alias(struct inode *inode)
1891{
1892 struct dentry *alias;
1893
Al Virob3d9b7a2012-06-09 13:51:19 -04001894 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001895 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001896 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001897 __dget(alias);
1898 return alias;
1899}
1900
Sage Weil46f72b32012-01-10 09:04:37 -08001901/**
1902 * d_find_any_alias - find any alias for a given inode
1903 * @inode: inode to find an alias for
1904 *
1905 * If any aliases exist for the given inode, take and return a
1906 * reference for one of them. If no aliases exist, return %NULL.
1907 */
1908struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001909{
1910 struct dentry *de;
1911
1912 spin_lock(&inode->i_lock);
1913 de = __d_find_any_alias(inode);
1914 spin_unlock(&inode->i_lock);
1915 return de;
1916}
Sage Weil46f72b32012-01-10 09:04:37 -08001917EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001918
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001919static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001920{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001921 struct dentry *tmp;
1922 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001923 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001924
1925 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001926 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001927 if (IS_ERR(inode))
1928 return ERR_CAST(inode);
1929
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001930 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001931 if (res)
1932 goto out_iput;
1933
Al Viro798434b2016-03-24 20:38:43 -04001934 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001935 if (!tmp) {
1936 res = ERR_PTR(-ENOMEM);
1937 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001938 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001939
Al Virob9680912016-04-11 00:53:26 -04001940 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001941 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001942 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001943 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001944 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001945 dput(tmp);
1946 goto out_iput;
1947 }
1948
1949 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001950 add_flags = d_flags_for_inode(inode);
1951
1952 if (disconnected)
1953 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001954
Christoph Hellwig9308a612008-08-11 15:49:12 +02001955 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001956 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001957 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001958 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001959 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001960 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001961 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001962 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001963
Christoph Hellwig9308a612008-08-11 15:49:12 +02001964 return tmp;
1965
1966 out_iput:
1967 iput(inode);
1968 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001969}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001970
1971/**
1972 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1973 * @inode: inode to allocate the dentry for
1974 *
1975 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1976 * similar open by handle operations. The returned dentry may be anonymous,
1977 * or may have a full name (if the inode was already in the cache).
1978 *
1979 * When called on a directory inode, we must ensure that the inode only ever
1980 * has one dentry. If a dentry is found, that is returned instead of
1981 * allocating a new one.
1982 *
1983 * On successful return, the reference to the inode has been transferred
1984 * to the dentry. In case of an error the reference on the inode is released.
1985 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1986 * be passed in and the error will be propagated to the return value,
1987 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1988 */
1989struct dentry *d_obtain_alias(struct inode *inode)
1990{
1991 return __d_obtain_alias(inode, 1);
1992}
Benny Halevyadc48722009-02-27 14:02:59 -08001993EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994
1995/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001996 * d_obtain_root - find or allocate a dentry for a given inode
1997 * @inode: inode to allocate the dentry for
1998 *
1999 * Obtain an IS_ROOT dentry for the root of a filesystem.
2000 *
2001 * We must ensure that directory inodes only ever have one dentry. If a
2002 * dentry is found, that is returned instead of allocating a new one.
2003 *
2004 * On successful return, the reference to the inode has been transferred
2005 * to the dentry. In case of an error the reference on the inode is
2006 * released. A %NULL or IS_ERR inode may be passed in and will be the
2007 * error will be propagate to the return value, with a %NULL @inode
2008 * replaced by ERR_PTR(-ESTALE).
2009 */
2010struct dentry *d_obtain_root(struct inode *inode)
2011{
2012 return __d_obtain_alias(inode, 0);
2013}
2014EXPORT_SYMBOL(d_obtain_root);
2015
2016/**
Barry Naujok94035402008-05-21 16:50:46 +10002017 * d_add_ci - lookup or allocate new dentry with case-exact name
2018 * @inode: the inode case-insensitive lookup has found
2019 * @dentry: the negative dentry that was passed to the parent's lookup func
2020 * @name: the case-exact name to be associated with the returned dentry
2021 *
2022 * This is to avoid filling the dcache with case-insensitive names to the
2023 * same inode, only the actual correct case is stored in the dcache for
2024 * case-insensitive filesystems.
2025 *
2026 * For a case-insensitive lookup match and if the the case-exact dentry
2027 * already exists in in the dcache, use it and return it.
2028 *
2029 * If no entry exists with the exact case name, allocate new dentry with
2030 * the exact case, and return the spliced entry.
2031 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002032struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002033 struct qstr *name)
2034{
Al Virod9171b92016-04-15 03:33:13 -04002035 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002036
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002037 /*
2038 * First check if a dentry matching the name already exists,
2039 * if not go ahead and create it now.
2040 */
Barry Naujok94035402008-05-21 16:50:46 +10002041 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002042 if (found) {
2043 iput(inode);
2044 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002045 }
Al Virod9171b92016-04-15 03:33:13 -04002046 if (d_in_lookup(dentry)) {
2047 found = d_alloc_parallel(dentry->d_parent, name,
2048 dentry->d_wait);
2049 if (IS_ERR(found) || !d_in_lookup(found)) {
2050 iput(inode);
2051 return found;
2052 }
2053 } else {
2054 found = d_alloc(dentry->d_parent, name);
2055 if (!found) {
2056 iput(inode);
2057 return ERR_PTR(-ENOMEM);
2058 }
2059 }
2060 res = d_splice_alias(inode, found);
2061 if (res) {
2062 dput(found);
2063 return res;
2064 }
Al Viro4f522a22013-02-11 23:20:37 -05002065 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002066}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002067EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002069/*
2070 * Do the slow-case of the dentry name compare.
2071 *
2072 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07002073 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002074 * filesystem can rely on them, and can use the 'name' and
2075 * 'len' information without worrying about walking off the
2076 * end of memory etc.
2077 *
2078 * Thus the read_seqcount_retry() and the "duplicate" info
2079 * in arguments (the low-level filesystem should not look
2080 * at the dentry inode or name contents directly, since
2081 * rename can change them while we're in RCU mode).
2082 */
2083enum slow_d_compare {
2084 D_COMP_OK,
2085 D_COMP_NOMATCH,
2086 D_COMP_SEQRETRY,
2087};
2088
2089static noinline enum slow_d_compare slow_dentry_cmp(
2090 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002091 struct dentry *dentry,
2092 unsigned int seq,
2093 const struct qstr *name)
2094{
2095 int tlen = dentry->d_name.len;
2096 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002097
2098 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2099 cpu_relax();
2100 return D_COMP_SEQRETRY;
2101 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002102 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002103 return D_COMP_NOMATCH;
2104 return D_COMP_OK;
2105}
2106
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002108 * __d_lookup_rcu - search for a dentry (racy, store-free)
2109 * @parent: parent dentry
2110 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002111 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002112 * Returns: dentry, or NULL
2113 *
2114 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2115 * resolution (store-free path walking) design described in
2116 * Documentation/filesystems/path-lookup.txt.
2117 *
2118 * This is not to be used outside core vfs.
2119 *
2120 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2121 * held, and rcu_read_lock held. The returned dentry must not be stored into
2122 * without taking d_lock and checking d_seq sequence count against @seq
2123 * returned here.
2124 *
Linus Torvalds15570082013-09-02 11:38:06 -07002125 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002126 * function.
2127 *
2128 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2129 * the returned dentry, so long as its parent's seqlock is checked after the
2130 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2131 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002132 *
2133 * NOTE! The caller *has* to check the resulting dentry against the sequence
2134 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002135 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002136struct dentry *__d_lookup_rcu(const struct dentry *parent,
2137 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002138 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002139{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002140 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002141 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002142 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002143 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002144 struct dentry *dentry;
2145
2146 /*
2147 * Note: There is significant duplication with __d_lookup_rcu which is
2148 * required to prevent single threaded performance regressions
2149 * especially on architectures where smp_rmb (in seqcounts) are costly.
2150 * Keep the two functions in sync.
2151 */
2152
2153 /*
2154 * The hash list is protected using RCU.
2155 *
2156 * Carefully use d_seq when comparing a candidate dentry, to avoid
2157 * races with d_move().
2158 *
2159 * It is possible that concurrent renames can mess up our list
2160 * walk here and result in missing our dentry, resulting in the
2161 * false-negative result. d_lookup() protects against concurrent
2162 * renames using rename_lock seqlock.
2163 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002164 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002165 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002166 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002167 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002168
Nick Piggin31e6b012011-01-07 17:49:52 +11002169seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002170 /*
2171 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002172 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002173 *
2174 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002175 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002176 *
2177 * NOTE! We do a "raw" seqcount_begin here. That means that
2178 * we don't wait for the sequence count to stabilize if it
2179 * is in the middle of a sequence change. If we do the slow
2180 * dentry compare, we will do seqretries until it is stable,
2181 * and if we end up with a successful lookup, we actually
2182 * want to exit RCU lookup anyway.
2183 */
2184 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002185 if (dentry->d_parent != parent)
2186 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002187 if (d_unhashed(dentry))
2188 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002189
2190 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002191 if (dentry->d_name.hash != hashlen_hash(hashlen))
2192 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002193 *seqp = seq;
2194 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002195 case D_COMP_OK:
2196 return dentry;
2197 case D_COMP_NOMATCH:
2198 continue;
2199 default:
2200 goto seqretry;
2201 }
2202 }
2203
Linus Torvalds26fe5752012-05-10 13:14:12 -07002204 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002205 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002206 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002207 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002208 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002209 }
2210 return NULL;
2211}
2212
2213/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 * d_lookup - search for a dentry
2215 * @parent: parent dentry
2216 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002217 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002219 * d_lookup searches the children of the parent dentry for the name in
2220 * question. If the dentry is found its reference count is incremented and the
2221 * dentry is returned. The caller must use dput to free the entry when it has
2222 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 */
Al Viroda2d8452013-01-24 18:29:34 -05002224struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225{
Nick Piggin31e6b012011-01-07 17:49:52 +11002226 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002227 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228
Daeseok Younb8314f92014-08-11 11:46:53 +09002229 do {
2230 seq = read_seqbegin(&rename_lock);
2231 dentry = __d_lookup(parent, name);
2232 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 break;
2234 } while (read_seqretry(&rename_lock, seq));
2235 return dentry;
2236}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002237EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238
Nick Piggin31e6b012011-01-07 17:49:52 +11002239/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002240 * __d_lookup - search for a dentry (racy)
2241 * @parent: parent dentry
2242 * @name: qstr of name we wish to find
2243 * Returns: dentry, or NULL
2244 *
2245 * __d_lookup is like d_lookup, however it may (rarely) return a
2246 * false-negative result due to unrelated rename activity.
2247 *
2248 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2249 * however it must be used carefully, eg. with a following d_lookup in
2250 * the case of failure.
2251 *
2252 * __d_lookup callers must be commented.
2253 */
Al Viroa713ca22013-01-24 18:27:00 -05002254struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255{
2256 unsigned int len = name->len;
2257 unsigned int hash = name->hash;
2258 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002259 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002260 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002261 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002262 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Nick Pigginb04f7842010-08-18 04:37:34 +10002264 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002265 * Note: There is significant duplication with __d_lookup_rcu which is
2266 * required to prevent single threaded performance regressions
2267 * especially on architectures where smp_rmb (in seqcounts) are costly.
2268 * Keep the two functions in sync.
2269 */
2270
2271 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002272 * The hash list is protected using RCU.
2273 *
2274 * Take d_lock when comparing a candidate dentry, to avoid races
2275 * with d_move().
2276 *
2277 * It is possible that concurrent renames can mess up our list
2278 * walk here and result in missing our dentry, resulting in the
2279 * false-negative result. d_lookup() protects against concurrent
2280 * renames using rename_lock seqlock.
2281 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002282 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002283 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 rcu_read_lock();
2285
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002286 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 if (dentry->d_name.hash != hash)
2289 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290
2291 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 if (dentry->d_parent != parent)
2293 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002294 if (d_unhashed(dentry))
2295 goto next;
2296
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 /*
2298 * It is safe to compare names since d_move() cannot
2299 * change the qstr (protected by d_lock).
2300 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002301 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002302 int tlen = dentry->d_name.len;
2303 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002304 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 goto next;
2306 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002307 if (dentry->d_name.len != len)
2308 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002309 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 goto next;
2311 }
2312
Waiman Long98474232013-08-28 18:24:59 -07002313 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002314 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 spin_unlock(&dentry->d_lock);
2316 break;
2317next:
2318 spin_unlock(&dentry->d_lock);
2319 }
2320 rcu_read_unlock();
2321
2322 return found;
2323}
2324
2325/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002326 * d_hash_and_lookup - hash the qstr then search for a dentry
2327 * @dir: Directory to search in
2328 * @name: qstr of name we wish to find
2329 *
Al Viro4f522a22013-02-11 23:20:37 -05002330 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002331 */
2332struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2333{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002334 /*
2335 * Check for a fs-specific hash function. Note that we must
2336 * calculate the standard hash first, as the d_op->d_hash()
2337 * routine may choose to leave the hash value unchanged.
2338 */
2339 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002340 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002341 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002342 if (unlikely(err < 0))
2343 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002344 }
Al Viro4f522a22013-02-11 23:20:37 -05002345 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002346}
Al Viro4f522a22013-02-11 23:20:37 -05002347EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002348
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349/*
2350 * When a file is deleted, we have two options:
2351 * - turn this dentry into a negative dentry
2352 * - unhash this dentry and free it.
2353 *
2354 * Usually, we want to just turn this into
2355 * a negative dentry, but if anybody else is
2356 * currently using the dentry or the inode
2357 * we can't do that and we fall back on removing
2358 * it from the hash queues and waiting for
2359 * it to be deleted later when it has no users
2360 */
2361
2362/**
2363 * d_delete - delete a dentry
2364 * @dentry: The dentry to delete
2365 *
2366 * Turn the dentry into a negative dentry if possible, otherwise
2367 * remove it from the hash queues so it can be deleted later
2368 */
2369
2370void d_delete(struct dentry * dentry)
2371{
Nick Piggin873feea2011-01-07 17:50:06 +11002372 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002373 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 /*
2375 * Are we the only user?
2376 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002377again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002379 inode = dentry->d_inode;
2380 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002381 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002382 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002383 spin_unlock(&dentry->d_lock);
2384 cpu_relax();
2385 goto again;
2386 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002387 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002388 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002389 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 return;
2391 }
2392
2393 if (!d_unhashed(dentry))
2394 __d_drop(dentry);
2395
2396 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002397
2398 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002400EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002402static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002404 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002405 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002406 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002407 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408}
2409
David Howells770bfad2006-08-22 20:06:07 -04002410static void _d_rehash(struct dentry * entry)
2411{
2412 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2413}
2414
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415/**
2416 * d_rehash - add an entry back to the hash
2417 * @entry: dentry to add to the hash
2418 *
2419 * Adds a dentry to the hash according to its name.
2420 */
2421
2422void d_rehash(struct dentry * entry)
2423{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002425 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002428EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429
Al Viro84e710d2016-04-15 00:58:55 -04002430static inline unsigned start_dir_add(struct inode *dir)
2431{
2432
2433 for (;;) {
2434 unsigned n = dir->i_dir_seq;
2435 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2436 return n;
2437 cpu_relax();
2438 }
2439}
2440
2441static inline void end_dir_add(struct inode *dir, unsigned n)
2442{
2443 smp_store_release(&dir->i_dir_seq, n + 2);
2444}
2445
Al Virod9171b92016-04-15 03:33:13 -04002446static void d_wait_lookup(struct dentry *dentry)
2447{
2448 if (d_in_lookup(dentry)) {
2449 DECLARE_WAITQUEUE(wait, current);
2450 add_wait_queue(dentry->d_wait, &wait);
2451 do {
2452 set_current_state(TASK_UNINTERRUPTIBLE);
2453 spin_unlock(&dentry->d_lock);
2454 schedule();
2455 spin_lock(&dentry->d_lock);
2456 } while (d_in_lookup(dentry));
2457 }
2458}
2459
Al Viro94bdd652016-04-15 02:42:04 -04002460struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002461 const struct qstr *name,
2462 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002463{
2464 unsigned int len = name->len;
2465 unsigned int hash = name->hash;
2466 const unsigned char *str = name->name;
2467 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2468 struct hlist_bl_node *node;
2469 struct dentry *new = d_alloc(parent, name);
2470 struct dentry *dentry;
2471 unsigned seq, r_seq, d_seq;
2472
2473 if (unlikely(!new))
2474 return ERR_PTR(-ENOMEM);
2475
2476retry:
2477 rcu_read_lock();
2478 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2479 r_seq = read_seqbegin(&rename_lock);
2480 dentry = __d_lookup_rcu(parent, name, &d_seq);
2481 if (unlikely(dentry)) {
2482 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2483 rcu_read_unlock();
2484 goto retry;
2485 }
2486 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2487 rcu_read_unlock();
2488 dput(dentry);
2489 goto retry;
2490 }
2491 rcu_read_unlock();
2492 dput(new);
2493 return dentry;
2494 }
2495 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2496 rcu_read_unlock();
2497 goto retry;
2498 }
2499 hlist_bl_lock(b);
2500 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2501 hlist_bl_unlock(b);
2502 rcu_read_unlock();
2503 goto retry;
2504 }
Al Viro94bdd652016-04-15 02:42:04 -04002505 /*
2506 * No changes for the parent since the beginning of d_lookup().
2507 * Since all removals from the chain happen with hlist_bl_lock(),
2508 * any potential in-lookup matches are going to stay here until
2509 * we unlock the chain. All fields are stable in everything
2510 * we encounter.
2511 */
2512 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2513 if (dentry->d_name.hash != hash)
2514 continue;
2515 if (dentry->d_parent != parent)
2516 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002517 if (parent->d_flags & DCACHE_OP_COMPARE) {
2518 int tlen = dentry->d_name.len;
2519 const char *tname = dentry->d_name.name;
2520 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2521 continue;
2522 } else {
2523 if (dentry->d_name.len != len)
2524 continue;
2525 if (dentry_cmp(dentry, str, len))
2526 continue;
2527 }
Al Viro94bdd652016-04-15 02:42:04 -04002528 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002529 /* now we can try to grab a reference */
2530 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2531 rcu_read_unlock();
2532 goto retry;
2533 }
2534
2535 rcu_read_unlock();
2536 /*
2537 * somebody is likely to be still doing lookup for it;
2538 * wait for them to finish
2539 */
Al Virod9171b92016-04-15 03:33:13 -04002540 spin_lock(&dentry->d_lock);
2541 d_wait_lookup(dentry);
2542 /*
2543 * it's not in-lookup anymore; in principle we should repeat
2544 * everything from dcache lookup, but it's likely to be what
2545 * d_lookup() would've found anyway. If it is, just return it;
2546 * otherwise we really have to repeat the whole thing.
2547 */
2548 if (unlikely(dentry->d_name.hash != hash))
2549 goto mismatch;
2550 if (unlikely(dentry->d_parent != parent))
2551 goto mismatch;
2552 if (unlikely(d_unhashed(dentry)))
2553 goto mismatch;
2554 if (parent->d_flags & DCACHE_OP_COMPARE) {
2555 int tlen = dentry->d_name.len;
2556 const char *tname = dentry->d_name.name;
2557 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
2558 goto mismatch;
2559 } else {
2560 if (unlikely(dentry->d_name.len != len))
2561 goto mismatch;
2562 if (unlikely(dentry_cmp(dentry, str, len)))
2563 goto mismatch;
2564 }
2565 /* OK, it *is* a hashed match; return it */
2566 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002567 dput(new);
2568 return dentry;
2569 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002570 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002571 /* we can't take ->d_lock here; it's OK, though. */
2572 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002573 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002574 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2575 hlist_bl_unlock(b);
2576 return new;
Al Virod9171b92016-04-15 03:33:13 -04002577mismatch:
2578 spin_unlock(&dentry->d_lock);
2579 dput(dentry);
2580 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002581}
2582EXPORT_SYMBOL(d_alloc_parallel);
2583
Al Viro85c7f812016-04-14 19:52:13 -04002584void __d_lookup_done(struct dentry *dentry)
2585{
Al Viro94bdd652016-04-15 02:42:04 -04002586 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2587 dentry->d_name.hash);
2588 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002589 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002590 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002591 wake_up_all(dentry->d_wait);
2592 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002593 hlist_bl_unlock(b);
2594 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002595 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002596}
2597EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002598
2599/* inode->i_lock held if inode is non-NULL */
2600
2601static inline void __d_add(struct dentry *dentry, struct inode *inode)
2602{
Al Viro84e710d2016-04-15 00:58:55 -04002603 struct inode *dir = NULL;
2604 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002605 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002606 if (unlikely(d_in_lookup(dentry))) {
2607 dir = dentry->d_parent->d_inode;
2608 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002609 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002610 }
Al Viroed782b52016-03-09 19:52:39 -05002611 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002612 unsigned add_flags = d_flags_for_inode(inode);
2613 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2614 raw_write_seqcount_begin(&dentry->d_seq);
2615 __d_set_inode_and_type(dentry, inode, add_flags);
2616 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002617 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002618 }
Al Viro0568d702016-04-14 19:40:56 -04002619 _d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002620 if (dir)
2621 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002622 spin_unlock(&dentry->d_lock);
2623 if (inode)
2624 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002625}
2626
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002627/**
Al Viro34d0d192016-03-08 21:01:03 -05002628 * d_add - add dentry to hash queues
2629 * @entry: dentry to add
2630 * @inode: The inode to attach to this dentry
2631 *
2632 * This adds the entry to the hash queues and initializes @inode.
2633 * The entry was actually filled in earlier during d_alloc().
2634 */
2635
2636void d_add(struct dentry *entry, struct inode *inode)
2637{
Al Virob9680912016-04-11 00:53:26 -04002638 if (inode) {
2639 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002640 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002641 }
Al Viroed782b52016-03-09 19:52:39 -05002642 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002643}
2644EXPORT_SYMBOL(d_add);
2645
2646/**
Al Viro668d0cd2016-03-08 12:44:17 -05002647 * d_exact_alias - find and hash an exact unhashed alias
2648 * @entry: dentry to add
2649 * @inode: The inode to go with this dentry
2650 *
2651 * If an unhashed dentry with the same name/parent and desired
2652 * inode already exists, hash and return it. Otherwise, return
2653 * NULL.
2654 *
2655 * Parent directory should be locked.
2656 */
2657struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2658{
2659 struct dentry *alias;
2660 int len = entry->d_name.len;
2661 const char *name = entry->d_name.name;
2662 unsigned int hash = entry->d_name.hash;
2663
2664 spin_lock(&inode->i_lock);
2665 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2666 /*
2667 * Don't need alias->d_lock here, because aliases with
2668 * d_parent == entry->d_parent are not subject to name or
2669 * parent changes, because the parent inode i_mutex is held.
2670 */
2671 if (alias->d_name.hash != hash)
2672 continue;
2673 if (alias->d_parent != entry->d_parent)
2674 continue;
2675 if (alias->d_name.len != len)
2676 continue;
2677 if (dentry_cmp(alias, name, len))
2678 continue;
2679 spin_lock(&alias->d_lock);
2680 if (!d_unhashed(alias)) {
2681 spin_unlock(&alias->d_lock);
2682 alias = NULL;
2683 } else {
2684 __dget_dlock(alias);
2685 _d_rehash(alias);
2686 spin_unlock(&alias->d_lock);
2687 }
2688 spin_unlock(&inode->i_lock);
2689 return alias;
2690 }
2691 spin_unlock(&inode->i_lock);
2692 return NULL;
2693}
2694EXPORT_SYMBOL(d_exact_alias);
2695
2696/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002697 * dentry_update_name_case - update case insensitive dentry with a new name
2698 * @dentry: dentry to be updated
2699 * @name: new name
2700 *
2701 * Update a case insensitive dentry with new case of name.
2702 *
2703 * dentry must have been returned by d_lookup with name @name. Old and new
2704 * name lengths must match (ie. no d_compare which allows mismatched name
2705 * lengths).
2706 *
2707 * Parent inode i_mutex must be held over d_lookup and into this call (to
2708 * keep renames and concurrent inserts, and readdir(2) away).
2709 */
2710void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2711{
Al Viro59551022016-01-22 15:40:57 -05002712 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002713 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2714
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002715 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002716 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002717 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002718 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002719 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002720}
2721EXPORT_SYMBOL(dentry_update_name_case);
2722
Al Viro8d85b482014-09-29 14:54:27 -04002723static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724{
Al Viro8d85b482014-09-29 14:54:27 -04002725 if (unlikely(dname_external(target))) {
2726 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 /*
2728 * Both external: swap the pointers
2729 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002730 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 } else {
2732 /*
2733 * dentry:internal, target:external. Steal target's
2734 * storage and make target internal.
2735 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002736 memcpy(target->d_iname, dentry->d_name.name,
2737 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 dentry->d_name.name = target->d_name.name;
2739 target->d_name.name = target->d_iname;
2740 }
2741 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002742 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 /*
2744 * dentry:external, target:internal. Give dentry's
2745 * storage to target and make dentry internal
2746 */
2747 memcpy(dentry->d_iname, target->d_name.name,
2748 target->d_name.len + 1);
2749 target->d_name.name = dentry->d_name.name;
2750 dentry->d_name.name = dentry->d_iname;
2751 } else {
2752 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002753 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002755 unsigned int i;
2756 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002757 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2758 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002759 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2760 swap(((long *) &dentry->d_iname)[i],
2761 ((long *) &target->d_iname)[i]);
2762 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763 }
2764 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002765 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
2767
Al Viro8d85b482014-09-29 14:54:27 -04002768static void copy_name(struct dentry *dentry, struct dentry *target)
2769{
2770 struct external_name *old_name = NULL;
2771 if (unlikely(dname_external(dentry)))
2772 old_name = external_name(dentry);
2773 if (unlikely(dname_external(target))) {
2774 atomic_inc(&external_name(target)->u.count);
2775 dentry->d_name = target->d_name;
2776 } else {
2777 memcpy(dentry->d_iname, target->d_name.name,
2778 target->d_name.len + 1);
2779 dentry->d_name.name = dentry->d_iname;
2780 dentry->d_name.hash_len = target->d_name.hash_len;
2781 }
2782 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2783 kfree_rcu(old_name, u.head);
2784}
2785
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002786static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2787{
2788 /*
2789 * XXXX: do we really need to take target->d_lock?
2790 */
2791 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2792 spin_lock(&target->d_parent->d_lock);
2793 else {
2794 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2795 spin_lock(&dentry->d_parent->d_lock);
2796 spin_lock_nested(&target->d_parent->d_lock,
2797 DENTRY_D_LOCK_NESTED);
2798 } else {
2799 spin_lock(&target->d_parent->d_lock);
2800 spin_lock_nested(&dentry->d_parent->d_lock,
2801 DENTRY_D_LOCK_NESTED);
2802 }
2803 }
2804 if (target < dentry) {
2805 spin_lock_nested(&target->d_lock, 2);
2806 spin_lock_nested(&dentry->d_lock, 3);
2807 } else {
2808 spin_lock_nested(&dentry->d_lock, 2);
2809 spin_lock_nested(&target->d_lock, 3);
2810 }
2811}
2812
Al Viro986c0192014-09-26 23:11:15 -04002813static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002814{
2815 if (target->d_parent != dentry->d_parent)
2816 spin_unlock(&dentry->d_parent->d_lock);
2817 if (target->d_parent != target)
2818 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002819 spin_unlock(&target->d_lock);
2820 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002821}
2822
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002824 * When switching names, the actual string doesn't strictly have to
2825 * be preserved in the target - because we're dropping the target
2826 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002827 * the new name before we switch, unless we are going to rehash
2828 * it. Note that if we *do* unhash the target, we are not allowed
2829 * to rehash it without giving it a new name/hash key - whether
2830 * we swap or overwrite the names here, resulting name won't match
2831 * the reality in filesystem; it's only there for d_path() purposes.
2832 * Note that all of this is happening under rename_lock, so the
2833 * any hash lookup seeing it in the middle of manipulations will
2834 * be discarded anyway. So we do not care what happens to the hash
2835 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002837/*
Al Viro18367502011-07-12 21:42:24 -04002838 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002839 * @dentry: entry to move
2840 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002841 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 *
2843 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002844 * dcache entries should not be moved in this way. Caller must hold
2845 * rename_lock, the i_mutex of the source and target directories,
2846 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002848static void __d_move(struct dentry *dentry, struct dentry *target,
2849 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850{
Al Viro84e710d2016-04-15 00:58:55 -04002851 struct inode *dir = NULL;
2852 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 if (!dentry->d_inode)
2854 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2855
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002856 BUG_ON(d_ancestor(dentry, target));
2857 BUG_ON(d_ancestor(target, dentry));
2858
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002859 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002860 if (unlikely(d_in_lookup(target))) {
2861 dir = target->d_parent->d_inode;
2862 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002863 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002864 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865
Nick Piggin31e6b012011-01-07 17:49:52 +11002866 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002867 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002868
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002869 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2870
2871 /*
2872 * Move the dentry to the target hash queue. Don't bother checking
2873 * for the same hash queue because of how unlikely it is.
2874 */
2875 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002876 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877
Miklos Szeredida1ce062014-04-01 17:08:43 +02002878 /*
2879 * Unhash the target (d_delete() is not usable here). If exchanging
2880 * the two dentries, then rehash onto the other's hash queue.
2881 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002883 if (exchange) {
2884 __d_rehash(target,
2885 d_hash(dentry->d_parent, dentry->d_name.hash));
2886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002889 if (exchange)
2890 swap_names(dentry, target);
2891 else
2892 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893
Al Viro63cf4272014-09-26 23:06:14 -04002894 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002896 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002897 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 dentry->d_parent = target->d_parent;
2899 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002900 list_del_init(&target->d_child);
2901 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002903 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002904 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002905 list_move(&target->d_child, &target->d_parent->d_subdirs);
2906 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002907 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002908 fsnotify_update_flags(target);
2909 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910 }
2911
Nick Piggin31e6b012011-01-07 17:49:52 +11002912 write_seqcount_end(&target->d_seq);
2913 write_seqcount_end(&dentry->d_seq);
2914
Al Viro84e710d2016-04-15 00:58:55 -04002915 if (dir)
2916 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002917 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002918}
2919
2920/*
2921 * d_move - move a dentry
2922 * @dentry: entry to move
2923 * @target: new dentry
2924 *
2925 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002926 * dcache entries should not be moved in this way. See the locking
2927 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002928 */
2929void d_move(struct dentry *dentry, struct dentry *target)
2930{
2931 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002932 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002934}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002935EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936
Miklos Szeredida1ce062014-04-01 17:08:43 +02002937/*
2938 * d_exchange - exchange two dentries
2939 * @dentry1: first dentry
2940 * @dentry2: second dentry
2941 */
2942void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2943{
2944 write_seqlock(&rename_lock);
2945
2946 WARN_ON(!dentry1->d_inode);
2947 WARN_ON(!dentry2->d_inode);
2948 WARN_ON(IS_ROOT(dentry1));
2949 WARN_ON(IS_ROOT(dentry2));
2950
2951 __d_move(dentry1, dentry2, true);
2952
2953 write_sequnlock(&rename_lock);
2954}
2955
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002956/**
2957 * d_ancestor - search for an ancestor
2958 * @p1: ancestor dentry
2959 * @p2: child dentry
2960 *
2961 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2962 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002963 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002964struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002965{
2966 struct dentry *p;
2967
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002968 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002969 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002970 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002971 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002972 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002973}
2974
2975/*
2976 * This helper attempts to cope with remotely renamed directories
2977 *
2978 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002979 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002980 *
2981 * Note: If ever the locking in lock_rename() changes, then please
2982 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002983 */
Al Virob5ae6b12014-10-12 22:16:02 -04002984static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002985 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002986{
Al Viro9902af72016-04-15 15:08:36 -04002987 struct mutex *m1 = NULL;
2988 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002989 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002990
2991 /* If alias and dentry share a parent, then no extra locks required */
2992 if (alias->d_parent == dentry->d_parent)
2993 goto out_unalias;
2994
Trond Myklebust9eaef272006-10-21 10:24:20 -07002995 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002996 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2997 goto out_err;
2998 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002999 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07003000 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04003001 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003002out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07003003 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04003004 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003005out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07003006 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04003007 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003008 if (m1)
3009 mutex_unlock(m1);
3010 return ret;
3011}
3012
David Howells770bfad2006-08-22 20:06:07 -04003013/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003014 * d_splice_alias - splice a disconnected dentry into the tree if one exists
3015 * @inode: the inode which may have a disconnected dentry
3016 * @dentry: a negative dentry which we want to point to the inode.
3017 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05003018 * If inode is a directory and has an IS_ROOT alias, then d_move that in
3019 * place of the given dentry and return it, else simply d_add the inode
3020 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003021 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05003022 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
3023 * we should error out: directories can't have multiple aliases.
3024 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003025 * This is needed in the lookup routine of any filesystem that is exportable
3026 * (via knfsd) so that we can build dcache paths to directories effectively.
3027 *
3028 * If a dentry was found and moved, then it is returned. Otherwise NULL
3029 * is returned. This matches the expected return value of ->lookup.
3030 *
3031 * Cluster filesystems may call this function with a negative, hashed dentry.
3032 * In that case, we know that the inode will be a regular file, and also this
3033 * will only occur during atomic_open. So we need to check for the dentry
3034 * being already hashed only in the final case.
3035 */
3036struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
3037{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05003038 if (IS_ERR(inode))
3039 return ERR_CAST(inode);
3040
David Howells770bfad2006-08-22 20:06:07 -04003041 BUG_ON(!d_unhashed(dentry));
3042
Al Virode689f52016-03-09 18:05:42 -05003043 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04003044 goto out;
Al Virode689f52016-03-09 18:05:42 -05003045
Al Virob9680912016-04-11 00:53:26 -04003046 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11003047 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003048 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04003049 struct dentry *new = __d_find_any_alias(inode);
3050 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05003051 /* The reference to new ensures it remains an alias */
3052 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04003053 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003054 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04003055 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04003056 dput(new);
3057 new = ERR_PTR(-ELOOP);
3058 pr_warn_ratelimited(
3059 "VFS: Lookup of '%s' in %s %s"
3060 " would have caused loop\n",
3061 dentry->d_name.name,
3062 inode->i_sb->s_type->name,
3063 inode->i_sb->s_id);
3064 } else if (!IS_ROOT(new)) {
3065 int err = __d_unalias(inode, dentry, new);
3066 write_sequnlock(&rename_lock);
3067 if (err) {
3068 dput(new);
3069 new = ERR_PTR(err);
3070 }
Al Viro18367502011-07-12 21:42:24 -04003071 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04003072 __d_move(new, dentry, false);
3073 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07003074 }
Al Virob5ae6b12014-10-12 22:16:02 -04003075 iput(inode);
3076 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07003077 }
David Howells770bfad2006-08-22 20:06:07 -04003078 }
Al Virob5ae6b12014-10-12 22:16:02 -04003079out:
Al Viroed782b52016-03-09 19:52:39 -05003080 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04003081 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04003082}
Al Virob5ae6b12014-10-12 22:16:02 -04003083EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04003084
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003085static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01003086{
3087 *buflen -= namelen;
3088 if (*buflen < 0)
3089 return -ENAMETOOLONG;
3090 *buffer -= namelen;
3091 memcpy(*buffer, str, namelen);
3092 return 0;
3093}
3094
Waiman Long232d2d62013-09-09 12:18:13 -04003095/**
3096 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003097 * @buffer: buffer pointer
3098 * @buflen: allocated length of the buffer
3099 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003100 *
3101 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3102 * make sure that either the old or the new name pointer and length are
3103 * fetched. However, there may be mismatch between length and pointer.
3104 * The length cannot be trusted, we need to copy it byte-by-byte until
3105 * the length is reached or a null byte is found. It also prepends "/" at
3106 * the beginning of the name. The sequence number check at the caller will
3107 * retry it again when a d_move() does happen. So any garbage in the buffer
3108 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003109 *
3110 * Data dependency barrier is needed to make sure that we see that terminating
3111 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003112 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003113static int prepend_name(char **buffer, int *buflen, struct qstr *name)
3114{
Waiman Long232d2d62013-09-09 12:18:13 -04003115 const char *dname = ACCESS_ONCE(name->name);
3116 u32 dlen = ACCESS_ONCE(name->len);
3117 char *p;
3118
Al Viro6d13f692014-09-29 14:46:30 -04003119 smp_read_barrier_depends();
3120
Waiman Long232d2d62013-09-09 12:18:13 -04003121 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003122 if (*buflen < 0)
3123 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003124 p = *buffer -= dlen + 1;
3125 *p++ = '/';
3126 while (dlen--) {
3127 char c = *dname++;
3128 if (!c)
3129 break;
3130 *p++ = c;
3131 }
3132 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003133}
3134
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003136 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003137 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003138 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003139 * @buffer: pointer to the end of the buffer
3140 * @buflen: pointer to buffer length
3141 *
Waiman Long18129972013-09-12 10:55:35 -04003142 * The function will first try to write out the pathname without taking any
3143 * lock other than the RCU read lock to make sure that dentries won't go away.
3144 * It only checks the sequence number of the global rename_lock as any change
3145 * in the dentry's d_seq will be preceded by changes in the rename_lock
3146 * sequence number. If the sequence number had been changed, it will restart
3147 * the whole pathname back-tracing sequence again by taking the rename_lock.
3148 * In this case, there is no need to take the RCU read lock as the recursive
3149 * parent pointer references will keep the dentry chain alive as long as no
3150 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003151 */
Al Viro02125a82011-12-05 08:43:34 -05003152static int prepend_path(const struct path *path,
3153 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003154 char **buffer, int *buflen)
3155{
Al Viroede4ceb2013-11-13 07:45:40 -05003156 struct dentry *dentry;
3157 struct vfsmount *vfsmnt;
3158 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003159 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003160 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003161 char *bptr;
3162 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003163
Al Viro48f5ec22013-09-09 15:22:25 -04003164 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003165restart_mnt:
3166 read_seqbegin_or_lock(&mount_lock, &m_seq);
3167 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003168 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003169restart:
3170 bptr = *buffer;
3171 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003172 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003173 dentry = path->dentry;
3174 vfsmnt = path->mnt;
3175 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003176 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003177 while (dentry != root->dentry || vfsmnt != root->mnt) {
3178 struct dentry * parent;
3179
3180 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003181 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003182 /* Escaped? */
3183 if (dentry != vfsmnt->mnt_root) {
3184 bptr = *buffer;
3185 blen = *buflen;
3186 error = 3;
3187 break;
3188 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003189 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003190 if (mnt != parent) {
3191 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3192 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003193 vfsmnt = &mnt->mnt;
3194 continue;
3195 }
Waiman Long232d2d62013-09-09 12:18:13 -04003196 if (!error)
3197 error = is_mounted(vfsmnt) ? 1 : 2;
3198 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003199 }
3200 parent = dentry->d_parent;
3201 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003202 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003203 if (error)
3204 break;
3205
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003206 dentry = parent;
3207 }
Al Viro48f5ec22013-09-09 15:22:25 -04003208 if (!(seq & 1))
3209 rcu_read_unlock();
3210 if (need_seqretry(&rename_lock, seq)) {
3211 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003212 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003213 }
Al Viro48f5ec22013-09-09 15:22:25 -04003214 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003215
3216 if (!(m_seq & 1))
3217 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003218 if (need_seqretry(&mount_lock, m_seq)) {
3219 m_seq = 1;
3220 goto restart_mnt;
3221 }
3222 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003223
Waiman Long232d2d62013-09-09 12:18:13 -04003224 if (error >= 0 && bptr == *buffer) {
3225 if (--blen < 0)
3226 error = -ENAMETOOLONG;
3227 else
3228 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003229 }
Waiman Long232d2d62013-09-09 12:18:13 -04003230 *buffer = bptr;
3231 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003232 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003233}
3234
3235/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003236 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003237 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003238 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003239 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240 * @buflen: buffer length
3241 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003242 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003244 * Returns a pointer into the buffer or an error code if the
3245 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003246 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003247 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003248 *
Al Viro02125a82011-12-05 08:43:34 -05003249 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003250 */
Al Viro02125a82011-12-05 08:43:34 -05003251char *__d_path(const struct path *path,
3252 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003253 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003255 char *res = buf + buflen;
3256 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003258 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003259 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003260
Al Viro02125a82011-12-05 08:43:34 -05003261 if (error < 0)
3262 return ERR_PTR(error);
3263 if (error > 0)
3264 return NULL;
3265 return res;
3266}
3267
3268char *d_absolute_path(const struct path *path,
3269 char *buf, int buflen)
3270{
3271 struct path root = {};
3272 char *res = buf + buflen;
3273 int error;
3274
3275 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003276 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003277
3278 if (error > 1)
3279 error = -EINVAL;
3280 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003281 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003282 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003283}
3284
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003285/*
3286 * same as __d_path but appends "(deleted)" for unlinked files.
3287 */
Al Viro02125a82011-12-05 08:43:34 -05003288static int path_with_deleted(const struct path *path,
3289 const struct path *root,
3290 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003291{
3292 prepend(buf, buflen, "\0", 1);
3293 if (d_unlinked(path->dentry)) {
3294 int error = prepend(buf, buflen, " (deleted)", 10);
3295 if (error)
3296 return error;
3297 }
3298
3299 return prepend_path(path, root, buf, buflen);
3300}
3301
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003302static int prepend_unreachable(char **buffer, int *buflen)
3303{
3304 return prepend(buffer, buflen, "(unreachable)", 13);
3305}
3306
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003307static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3308{
3309 unsigned seq;
3310
3311 do {
3312 seq = read_seqcount_begin(&fs->seq);
3313 *root = fs->root;
3314 } while (read_seqcount_retry(&fs->seq, seq));
3315}
3316
Jan Bluncka03a8a702008-02-14 19:38:32 -08003317/**
3318 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003319 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003320 * @buf: buffer to return value in
3321 * @buflen: buffer length
3322 *
3323 * Convert a dentry into an ASCII path name. If the entry has been deleted
3324 * the string " (deleted)" is appended. Note that this is ambiguous.
3325 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003326 * Returns a pointer into the buffer or an error code if the path was
3327 * too long. Note: Callers should use the returned pointer, not the passed
3328 * in buffer, to use the name! The implementation often starts at an offset
3329 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003330 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003331 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003332 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003333char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003334{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003335 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003336 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003337 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003339 /*
3340 * We have various synthetic filesystems that never get mounted. On
3341 * these filesystems dentries are never used for lookup purposes, and
3342 * thus don't need to be hashed. They also don't need a name until a
3343 * user wants to identify the object in /proc/pid/fd/. The little hack
3344 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003345 *
3346 * Some pseudo inodes are mountable. When they are mounted
3347 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3348 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003349 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003350 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3351 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003352 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003353
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003354 rcu_read_lock();
3355 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003356 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003357 rcu_read_unlock();
3358
Al Viro02125a82011-12-05 08:43:34 -05003359 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003360 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003361 return res;
3362}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003363EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003364
3365/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003366 * Helper function for dentry_operations.d_dname() members
3367 */
3368char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3369 const char *fmt, ...)
3370{
3371 va_list args;
3372 char temp[64];
3373 int sz;
3374
3375 va_start(args, fmt);
3376 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3377 va_end(args);
3378
3379 if (sz > sizeof(temp) || sz > buflen)
3380 return ERR_PTR(-ENAMETOOLONG);
3381
3382 buffer += buflen - sz;
3383 return memcpy(buffer, temp, sz);
3384}
3385
Al Viro118b2302013-08-24 12:08:17 -04003386char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3387{
3388 char *end = buffer + buflen;
3389 /* these dentries are never renamed, so d_lock is not needed */
3390 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003391 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003392 prepend(&end, &buflen, "/", 1))
3393 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003394 return end;
Al Viro118b2302013-08-24 12:08:17 -04003395}
David Herrmann31bbe162014-01-03 14:09:47 +01003396EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003397
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003398/*
Ram Pai6092d042008-03-27 13:06:20 +01003399 * Write full pathname from the root of the filesystem into the buffer.
3400 */
Al Virof6500802014-01-26 12:37:55 -05003401static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003402{
Al Virof6500802014-01-26 12:37:55 -05003403 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003404 char *end, *retval;
3405 int len, seq = 0;
3406 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003407
Al Virof6500802014-01-26 12:37:55 -05003408 if (buflen < 2)
3409 goto Elong;
3410
Al Viro48f5ec22013-09-09 15:22:25 -04003411 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003412restart:
Al Virof6500802014-01-26 12:37:55 -05003413 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003414 end = buf + buflen;
3415 len = buflen;
3416 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003417 /* Get '/' right */
3418 retval = end-1;
3419 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003420 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003421 while (!IS_ROOT(dentry)) {
3422 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003423
Ram Pai6092d042008-03-27 13:06:20 +01003424 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003425 error = prepend_name(&end, &len, &dentry->d_name);
3426 if (error)
3427 break;
Ram Pai6092d042008-03-27 13:06:20 +01003428
3429 retval = end;
3430 dentry = parent;
3431 }
Al Viro48f5ec22013-09-09 15:22:25 -04003432 if (!(seq & 1))
3433 rcu_read_unlock();
3434 if (need_seqretry(&rename_lock, seq)) {
3435 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003436 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003437 }
3438 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003439 if (error)
3440 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003441 return retval;
3442Elong:
3443 return ERR_PTR(-ENAMETOOLONG);
3444}
Nick Pigginec2447c2011-01-07 17:49:29 +11003445
3446char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3447{
Waiman Long232d2d62013-09-09 12:18:13 -04003448 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003449}
3450EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003451
3452char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3453{
3454 char *p = NULL;
3455 char *retval;
3456
Al Viroc1031352010-06-06 22:31:14 -04003457 if (d_unlinked(dentry)) {
3458 p = buf + buflen;
3459 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3460 goto Elong;
3461 buflen++;
3462 }
3463 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003464 if (!IS_ERR(retval) && p)
3465 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003466 return retval;
3467Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003468 return ERR_PTR(-ENAMETOOLONG);
3469}
3470
Linus Torvalds8b19e342013-09-12 10:35:47 -07003471static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3472 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003473{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003474 unsigned seq;
3475
3476 do {
3477 seq = read_seqcount_begin(&fs->seq);
3478 *root = fs->root;
3479 *pwd = fs->pwd;
3480 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003481}
3482
Ram Pai6092d042008-03-27 13:06:20 +01003483/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003484 * NOTE! The user-level library version returns a
3485 * character pointer. The kernel system call just
3486 * returns the length of the buffer filled (which
3487 * includes the ending '\0' character), or a negative
3488 * error value. So libc would do something like
3489 *
3490 * char *getcwd(char * buf, size_t size)
3491 * {
3492 * int retval;
3493 *
3494 * retval = sys_getcwd(buf, size);
3495 * if (retval >= 0)
3496 * return buf;
3497 * errno = -retval;
3498 * return NULL;
3499 * }
3500 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003501SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502{
Linus Torvalds552ce542007-02-13 12:08:18 -08003503 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003504 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003505 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506
3507 if (!page)
3508 return -ENOMEM;
3509
Linus Torvalds8b19e342013-09-12 10:35:47 -07003510 rcu_read_lock();
3511 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512
Linus Torvalds552ce542007-02-13 12:08:18 -08003513 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003514 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003515 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003516 char *cwd = page + PATH_MAX;
3517 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003519 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003520 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003521 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003522
Al Viro02125a82011-12-05 08:43:34 -05003523 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003524 goto out;
3525
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003526 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003527 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003528 error = prepend_unreachable(&cwd, &buflen);
3529 if (error)
3530 goto out;
3531 }
3532
Linus Torvalds552ce542007-02-13 12:08:18 -08003533 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003534 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003535 if (len <= size) {
3536 error = len;
3537 if (copy_to_user(buf, cwd, len))
3538 error = -EFAULT;
3539 }
Nick Piggin949854d2011-01-07 17:49:37 +11003540 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003541 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003542 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003543
3544out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003545 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003546 return error;
3547}
3548
3549/*
3550 * Test whether new_dentry is a subdirectory of old_dentry.
3551 *
3552 * Trivially implemented using the dcache structure
3553 */
3554
3555/**
3556 * is_subdir - is new dentry a subdirectory of old_dentry
3557 * @new_dentry: new dentry
3558 * @old_dentry: old dentry
3559 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003560 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3561 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3563 */
3564
Yaowei Baia6e57872015-11-17 14:40:11 +08003565bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003566{
Yaowei Baia6e57872015-11-17 14:40:11 +08003567 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003568 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003569
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003570 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003571 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003572
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003573 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003576 /*
3577 * Need rcu_readlock to protect against the d_parent trashing
3578 * due to d_move
3579 */
3580 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003581 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003582 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003583 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003584 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003585 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587
3588 return result;
3589}
3590
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003591static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003592{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003593 struct dentry *root = data;
3594 if (dentry != root) {
3595 if (d_unhashed(dentry) || !dentry->d_inode)
3596 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003598 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3599 dentry->d_flags |= DCACHE_GENOCIDE;
3600 dentry->d_lockref.count--;
3601 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003603 return D_WALK_CONTINUE;
3604}
Nick Piggin58db63d2011-01-07 17:49:39 +11003605
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003606void d_genocide(struct dentry *parent)
3607{
3608 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003609}
3610
Al Viro60545d02013-06-07 01:20:27 -04003611void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612{
Al Viro60545d02013-06-07 01:20:27 -04003613 inode_dec_link_count(inode);
3614 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003615 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003616 !d_unlinked(dentry));
3617 spin_lock(&dentry->d_parent->d_lock);
3618 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3619 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3620 (unsigned long long)inode->i_ino);
3621 spin_unlock(&dentry->d_lock);
3622 spin_unlock(&dentry->d_parent->d_lock);
3623 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624}
Al Viro60545d02013-06-07 01:20:27 -04003625EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003626
3627static __initdata unsigned long dhash_entries;
3628static int __init set_dhash_entries(char *str)
3629{
3630 if (!str)
3631 return 0;
3632 dhash_entries = simple_strtoul(str, &str, 0);
3633 return 1;
3634}
3635__setup("dhash_entries=", set_dhash_entries);
3636
3637static void __init dcache_init_early(void)
3638{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003639 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640
3641 /* If hashes are distributed across NUMA nodes, defer
3642 * hash allocation until vmalloc space is available.
3643 */
3644 if (hashdist)
3645 return;
3646
3647 dentry_hashtable =
3648 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003649 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003650 dhash_entries,
3651 13,
3652 HASH_EARLY,
3653 &d_hash_shift,
3654 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003655 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003656 0);
3657
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003658 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003659 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660}
3661
Denis Cheng74bf17c2007-10-16 23:26:30 -07003662static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003663{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003664 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003665
3666 /*
3667 * A constructor could be added for stable state like the lists,
3668 * but it is probably not worth it because of the cache nature
3669 * of the dcache.
3670 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003671 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003672 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003673
3674 /* Hash may have been set up in dcache_init_early */
3675 if (!hashdist)
3676 return;
3677
3678 dentry_hashtable =
3679 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003680 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003681 dhash_entries,
3682 13,
3683 0,
3684 &d_hash_shift,
3685 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003686 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003687 0);
3688
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003689 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003690 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003691}
3692
3693/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003694struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003695EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003696
Linus Torvalds1da177e2005-04-16 15:20:36 -07003697EXPORT_SYMBOL(d_genocide);
3698
Linus Torvalds1da177e2005-04-16 15:20:36 -07003699void __init vfs_caches_init_early(void)
3700{
3701 dcache_init_early();
3702 inode_init_early();
3703}
3704
Mel Gorman4248b0d2015-08-06 15:46:20 -07003705void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003706{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003707 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003708 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003709
Denis Cheng74bf17c2007-10-16 23:26:30 -07003710 dcache_init();
3711 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003712 files_init();
3713 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003714 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003715 bdev_cache_init();
3716 chrdev_init();
3717}