blob: a14d00e9839e48569e503312417247f588e39d4d [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>
David Howells07f3f052006-09-30 20:52:18 +020041#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050042#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nick Piggin789680d2011-01-07 17:49:30 +110044/*
45 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110046 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040047 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110048 * dcache_hash_bucket lock protects:
49 * - the dcache hash table
50 * s_anon bl list spinlock protects:
51 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100052 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110053 * - the dcache lru lists and counters
54 * d_lock protects:
55 * - d_flags
56 * - d_name
57 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110058 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110059 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110060 * - d_parent and d_subdirs
61 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040062 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110063 *
64 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110065 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110066 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100067 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110068 * dcache_hash_bucket lock
69 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110070 *
Nick Pigginda502952011-01-07 17:49:33 +110071 * If there is an ancestor relationship:
72 * dentry->d_parent->...->d_parent->d_lock
73 * ...
74 * dentry->d_parent->d_lock
75 * dentry->d_lock
76 *
77 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110078 * if (dentry1 < dentry2)
79 * dentry1->d_lock
80 * dentry2->d_lock
81 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080082int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
84
Al Viro74c3cbe2007-07-22 08:04:18 -040085__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Nick Piggin949854d2011-01-07 17:49:37 +110087EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Christoph Lametere18b8902006-12-06 20:33:20 -080089static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091/*
92 * This is the single most critical data structure when it comes
93 * to the dcache: the hashtable for lookups. Somebody should try
94 * to make this good - I've just made it work.
95 *
96 * This hash-function tries to avoid losing too many bits of hash
97 * information, yet avoid using a prime hash-size or similar.
98 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800100static unsigned int d_hash_mask __read_mostly;
101static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700103static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvalds8966be92012-03-02 14:23:30 -0800105static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700106 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 hash += (unsigned long) parent / L1_CACHE_BYTES;
Linus Torvalds99d263d2014-09-13 11:30:10 -0700109 return dentry_hashtable + hash_32(hash, d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/* Statistics gathering. */
113struct dentry_stat_t dentry_stat = {
114 .age_limit = 45,
115};
116
Glauber Costa3942c072013-08-28 10:17:53 +1000117static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000118static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400119
120#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000121
122/*
123 * Here we resort to our own counters instead of using generic per-cpu counters
124 * for consistency with what the vfs inode code does. We are expected to harvest
125 * better code and performance by having our own specialized counters.
126 *
127 * Please note that the loop is done over all possible CPUs, not over all online
128 * CPUs. The reason for this is that we don't want to play games with CPUs going
129 * on and off. If one of them goes off, we will just keep their counters.
130 *
131 * glommer: See cffbc8a for details, and if you ever intend to change this,
132 * please update all vfs counters to match.
133 */
Glauber Costa3942c072013-08-28 10:17:53 +1000134static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100135{
136 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000137 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100138 for_each_possible_cpu(i)
139 sum += per_cpu(nr_dentry, i);
140 return sum < 0 ? 0 : sum;
141}
142
Dave Chinner62d36c72013-08-28 10:17:54 +1000143static long get_nr_dentry_unused(void)
144{
145 int i;
146 long sum = 0;
147 for_each_possible_cpu(i)
148 sum += per_cpu(nr_dentry_unused, i);
149 return sum < 0 ? 0 : sum;
150}
151
Joe Perches1f7e0612014-06-06 14:38:05 -0700152int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400153 size_t *lenp, loff_t *ppos)
154{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100155 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000156 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000157 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400158}
159#endif
160
Linus Torvalds5483f182012-03-04 15:51:42 -0800161/*
162 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
163 * The strings are both count bytes long, and count is non-zero.
164 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700165#ifdef CONFIG_DCACHE_WORD_ACCESS
166
167#include <asm/word-at-a-time.h>
168/*
169 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
170 * aligned allocation for this particular component. We don't
171 * strictly need the load_unaligned_zeropad() safety, but it
172 * doesn't hurt either.
173 *
174 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
175 * need the careful unaligned handling.
176 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700177static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800178{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800179 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800180
181 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700182 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700183 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800184 if (tcount < sizeof(unsigned long))
185 break;
186 if (unlikely(a != b))
187 return 1;
188 cs += sizeof(unsigned long);
189 ct += sizeof(unsigned long);
190 tcount -= sizeof(unsigned long);
191 if (!tcount)
192 return 0;
193 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000194 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700196}
197
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800198#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700199
Linus Torvalds94753db52012-05-10 12:19:19 -0700200static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700201{
Linus Torvalds5483f182012-03-04 15:51:42 -0800202 do {
203 if (*cs != *ct)
204 return 1;
205 cs++;
206 ct++;
207 tcount--;
208 } while (tcount);
209 return 0;
210}
211
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212#endif
213
Linus Torvalds94753db52012-05-10 12:19:19 -0700214static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
215{
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700216 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700217 /*
218 * Be careful about RCU walk racing with rename:
219 * use ACCESS_ONCE to fetch the name pointer.
220 *
221 * NOTE! Even if a rename will mean that the length
222 * was not loaded atomically, we don't care. The
223 * RCU walk will check the sequence count eventually,
224 * and catch it. And we won't overrun the buffer,
225 * because we're reading the name pointer atomically,
226 * and a dentry name is guaranteed to be properly
227 * terminated with a NUL byte.
228 *
229 * End result: even if 'len' is wrong, we'll exit
230 * early because the data cannot match (there can
231 * be no NUL in the ct/tcount data)
232 */
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700233 cs = ACCESS_ONCE(dentry->d_name.name);
234 smp_read_barrier_depends();
235 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700236}
237
Al Viro8d85b482014-09-29 14:54:27 -0400238struct external_name {
239 union {
240 atomic_t count;
241 struct rcu_head head;
242 } u;
243 unsigned char name[];
244};
245
246static inline struct external_name *external_name(struct dentry *dentry)
247{
248 return container_of(dentry->d_name.name, struct external_name, name[0]);
249}
250
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400251static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400253 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
254
Al Viro8d85b482014-09-29 14:54:27 -0400255 kmem_cache_free(dentry_cache, dentry);
256}
257
258static void __d_free_external(struct rcu_head *head)
259{
260 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400261 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 kmem_cache_free(dentry_cache, dentry);
263}
264
Al Viro810bb172014-10-12 12:45:37 -0400265static inline int dname_external(const struct dentry *dentry)
266{
267 return dentry->d_name.name != dentry->d_iname;
268}
269
Al Virob4f03542014-04-29 23:40:14 -0400270static void dentry_free(struct dentry *dentry)
271{
Al Viro946e51f2014-10-26 19:19:16 -0400272 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400273 if (unlikely(dname_external(dentry))) {
274 struct external_name *p = external_name(dentry);
275 if (likely(atomic_dec_and_test(&p->u.count))) {
276 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
277 return;
278 }
279 }
Al Virob4f03542014-04-29 23:40:14 -0400280 /* if dentry was never visible to RCU, immediate free is OK */
281 if (!(dentry->d_flags & DCACHE_RCUACCESS))
282 __d_free(&dentry->d_u.d_rcu);
283 else
284 call_rcu(&dentry->d_u.d_rcu, __d_free);
285}
286
Nick Piggin31e6b012011-01-07 17:49:52 +1100287/**
288 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800289 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100290 * After this call, in-progress rcu-walk path lookup will fail. This
291 * should be called after unhashing, and after changing d_inode (if
292 * the dentry has not already been unhashed).
293 */
294static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
295{
296 assert_spin_locked(&dentry->d_lock);
297 /* Go through a barrier */
298 write_seqcount_barrier(&dentry->d_seq);
299}
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301/*
302 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100303 * d_iput() operation if defined. Dentry has no refcount
304 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800306static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200307 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100308 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309{
310 struct inode *inode = dentry->d_inode;
311 if (inode) {
312 dentry->d_inode = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400313 hlist_del_init(&dentry->d_u.d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100315 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700316 if (!inode->i_nlink)
317 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (dentry->d_op && dentry->d_op->d_iput)
319 dentry->d_op->d_iput(dentry, inode);
320 else
321 iput(inode);
322 } else {
323 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 }
325}
326
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700327/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100328 * Release the dentry's inode, using the filesystem
329 * d_iput() operation if defined. dentry remains in-use.
330 */
331static void dentry_unlink_inode(struct dentry * dentry)
332 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100333 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100334{
335 struct inode *inode = dentry->d_inode;
David Howellsb18825a2013-09-12 19:22:53 +0100336 __d_clear_type(dentry);
Nick Piggin31e6b012011-01-07 17:49:52 +1100337 dentry->d_inode = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400338 hlist_del_init(&dentry->d_u.d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100339 dentry_rcuwalk_barrier(dentry);
340 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100341 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100342 if (!inode->i_nlink)
343 fsnotify_inoderemove(inode);
344 if (dentry->d_op && dentry->d_op->d_iput)
345 dentry->d_op->d_iput(dentry, inode);
346 else
347 iput(inode);
348}
349
350/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400351 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
352 * is in use - which includes both the "real" per-superblock
353 * LRU list _and_ the DCACHE_SHRINK_LIST use.
354 *
355 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
356 * on the shrink list (ie not on the superblock LRU list).
357 *
358 * The per-cpu "nr_dentry_unused" counters are updated with
359 * the DCACHE_LRU_LIST bit.
360 *
361 * These helper functions make sure we always follow the
362 * rules. d_lock must be held by the caller.
363 */
364#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
365static void d_lru_add(struct dentry *dentry)
366{
367 D_FLAG_VERIFY(dentry, 0);
368 dentry->d_flags |= DCACHE_LRU_LIST;
369 this_cpu_inc(nr_dentry_unused);
370 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
371}
372
373static void d_lru_del(struct dentry *dentry)
374{
375 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
376 dentry->d_flags &= ~DCACHE_LRU_LIST;
377 this_cpu_dec(nr_dentry_unused);
378 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
379}
380
381static void d_shrink_del(struct dentry *dentry)
382{
383 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
384 list_del_init(&dentry->d_lru);
385 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
386 this_cpu_dec(nr_dentry_unused);
387}
388
389static void d_shrink_add(struct dentry *dentry, struct list_head *list)
390{
391 D_FLAG_VERIFY(dentry, 0);
392 list_add(&dentry->d_lru, list);
393 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
394 this_cpu_inc(nr_dentry_unused);
395}
396
397/*
398 * These can only be called under the global LRU lock, ie during the
399 * callback for freeing the LRU list. "isolate" removes it from the
400 * LRU lists entirely, while shrink_move moves it to the indicated
401 * private list.
402 */
403static void d_lru_isolate(struct dentry *dentry)
404{
405 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
406 dentry->d_flags &= ~DCACHE_LRU_LIST;
407 this_cpu_dec(nr_dentry_unused);
408 list_del_init(&dentry->d_lru);
409}
410
411static void d_lru_shrink_move(struct dentry *dentry, struct list_head *list)
412{
413 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
414 dentry->d_flags |= DCACHE_SHRINK_LIST;
415 list_move_tail(&dentry->d_lru, list);
416}
417
418/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000419 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700420 */
421static void dentry_lru_add(struct dentry *dentry)
422{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400423 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
424 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700425}
426
Miklos Szeredid52b9082007-05-08 00:23:46 -0700427/**
Nick Piggin789680d2011-01-07 17:49:30 +1100428 * d_drop - drop a dentry
429 * @dentry: dentry to drop
430 *
431 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
432 * be found through a VFS lookup any more. Note that this is different from
433 * deleting the dentry - d_delete will try to mark the dentry negative if
434 * possible, giving a successful _negative_ lookup, while d_drop will
435 * just make the cache lookup fail.
436 *
437 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
438 * reason (NFS timeouts or autofs deletes).
439 *
440 * __d_drop requires dentry->d_lock.
441 */
442void __d_drop(struct dentry *dentry)
443{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700444 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400445 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400446 /*
447 * Hashed dentries are normally on the dentry hashtable,
448 * with the exception of those newly allocated by
449 * d_obtain_alias, which are always IS_ROOT:
450 */
451 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400452 b = &dentry->d_sb->s_anon;
453 else
454 b = d_hash(dentry->d_parent, dentry->d_name.hash);
455
456 hlist_bl_lock(b);
457 __hlist_bl_del(&dentry->d_hash);
458 dentry->d_hash.pprev = NULL;
459 hlist_bl_unlock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700460 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100461 }
462}
463EXPORT_SYMBOL(__d_drop);
464
465void d_drop(struct dentry *dentry)
466{
Nick Piggin789680d2011-01-07 17:49:30 +1100467 spin_lock(&dentry->d_lock);
468 __d_drop(dentry);
469 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100470}
471EXPORT_SYMBOL(d_drop);
472
Al Viroe55fd012014-05-28 13:51:12 -0400473static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100474{
Al Viro41edf2782014-05-01 10:30:00 -0400475 struct dentry *parent = NULL;
476 bool can_free = true;
Al Viro41edf2782014-05-01 10:30:00 -0400477 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100478 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100479
Linus Torvalds0d984392013-09-08 13:46:52 -0700480 /*
481 * The dentry is now unrecoverably dead to the world.
482 */
483 lockref_mark_dead(&dentry->d_lockref);
484
Sage Weilf0023bc2011-10-28 10:02:42 -0700485 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700486 * inform the fs via d_prune that this dentry is about to be
487 * unhashed and destroyed.
488 */
Al Viro29266202014-05-30 11:39:02 -0400489 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800490 dentry->d_op->d_prune(dentry);
491
Al Viro01b60352014-04-29 23:42:52 -0400492 if (dentry->d_flags & DCACHE_LRU_LIST) {
493 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
494 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400495 }
Nick Piggin77812a12011-01-07 17:49:48 +1100496 /* if it was on the hash then remove it */
497 __d_drop(dentry);
Al Viroca5358e2014-10-26 19:31:10 -0400498 __list_del_entry(&dentry->d_child);
Al Viro03b3b882014-04-29 15:45:28 -0400499 /*
500 * Inform d_walk() that we are no longer attached to the
501 * dentry tree
502 */
503 dentry->d_flags |= DCACHE_DENTRY_KILLED;
504 if (parent)
505 spin_unlock(&parent->d_lock);
506 dentry_iput(dentry);
507 /*
508 * dentry_iput drops the locks, at which point nobody (except
509 * transient RCU lookups) can reach this dentry.
510 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800511 BUG_ON(dentry->d_lockref.count > 0);
Al Viro03b3b882014-04-29 15:45:28 -0400512 this_cpu_dec(nr_dentry);
513 if (dentry->d_op && dentry->d_op->d_release)
514 dentry->d_op->d_release(dentry);
515
Al Viro41edf2782014-05-01 10:30:00 -0400516 spin_lock(&dentry->d_lock);
517 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
518 dentry->d_flags |= DCACHE_MAY_FREE;
519 can_free = false;
520 }
521 spin_unlock(&dentry->d_lock);
Al Viro41edf2782014-05-01 10:30:00 -0400522 if (likely(can_free))
523 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400524}
525
526/*
527 * Finish off a dentry we've decided to kill.
528 * dentry->d_lock must be held, returns with it unlocked.
529 * If ref is non-zero, then decrement the refcount too.
530 * Returns dentry requiring refcount drop, or NULL if we're done.
531 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400532static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400533 __releases(dentry->d_lock)
534{
535 struct inode *inode = dentry->d_inode;
536 struct dentry *parent = NULL;
537
538 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
539 goto failed;
540
541 if (!IS_ROOT(dentry)) {
542 parent = dentry->d_parent;
543 if (unlikely(!spin_trylock(&parent->d_lock))) {
544 if (inode)
545 spin_unlock(&inode->i_lock);
546 goto failed;
547 }
548 }
549
550 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400551 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400552
553failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400554 spin_unlock(&dentry->d_lock);
555 cpu_relax();
Al Viroe55fd012014-05-28 13:51:12 -0400556 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100557}
558
Al Viro046b9612014-05-29 08:54:52 -0400559static inline struct dentry *lock_parent(struct dentry *dentry)
560{
561 struct dentry *parent = dentry->d_parent;
562 if (IS_ROOT(dentry))
563 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800564 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400565 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400566 if (likely(spin_trylock(&parent->d_lock)))
567 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400568 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400569 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400570again:
571 parent = ACCESS_ONCE(dentry->d_parent);
572 spin_lock(&parent->d_lock);
573 /*
574 * We can't blindly lock dentry until we are sure
575 * that we won't violate the locking order.
576 * Any changes of dentry->d_parent must have
577 * been done with parent->d_lock held, so
578 * spin_lock() above is enough of a barrier
579 * for checking if it's still our child.
580 */
581 if (unlikely(parent != dentry->d_parent)) {
582 spin_unlock(&parent->d_lock);
583 goto again;
584 }
585 rcu_read_unlock();
586 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700587 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400588 else
589 parent = NULL;
590 return parent;
591}
592
Linus Torvalds360f5472015-01-09 15:19:03 -0800593/*
594 * Try to do a lockless dput(), and return whether that was successful.
595 *
596 * If unsuccessful, we return false, having already taken the dentry lock.
597 *
598 * The caller needs to hold the RCU read lock, so that the dentry is
599 * guaranteed to stay around even if the refcount goes down to zero!
600 */
601static inline bool fast_dput(struct dentry *dentry)
602{
603 int ret;
604 unsigned int d_flags;
605
606 /*
607 * If we have a d_op->d_delete() operation, we sould not
608 * let the dentry count go to zero, so use "put__or_lock".
609 */
610 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
611 return lockref_put_or_lock(&dentry->d_lockref);
612
613 /*
614 * .. otherwise, we can try to just decrement the
615 * lockref optimistically.
616 */
617 ret = lockref_put_return(&dentry->d_lockref);
618
619 /*
620 * If the lockref_put_return() failed due to the lock being held
621 * by somebody else, the fast path has failed. We will need to
622 * get the lock, and then check the count again.
623 */
624 if (unlikely(ret < 0)) {
625 spin_lock(&dentry->d_lock);
626 if (dentry->d_lockref.count > 1) {
627 dentry->d_lockref.count--;
628 spin_unlock(&dentry->d_lock);
629 return 1;
630 }
631 return 0;
632 }
633
634 /*
635 * If we weren't the last ref, we're done.
636 */
637 if (ret)
638 return 1;
639
640 /*
641 * Careful, careful. The reference count went down
642 * to zero, but we don't hold the dentry lock, so
643 * somebody else could get it again, and do another
644 * dput(), and we need to not race with that.
645 *
646 * However, there is a very special and common case
647 * where we don't care, because there is nothing to
648 * do: the dentry is still hashed, it does not have
649 * a 'delete' op, and it's referenced and already on
650 * the LRU list.
651 *
652 * NOTE! Since we aren't locked, these values are
653 * not "stable". However, it is sufficient that at
654 * some point after we dropped the reference the
655 * dentry was hashed and the flags had the proper
656 * value. Other dentry users may have re-gotten
657 * a reference to the dentry and change that, but
658 * our work is done - we can leave the dentry
659 * around with a zero refcount.
660 */
661 smp_rmb();
662 d_flags = ACCESS_ONCE(dentry->d_flags);
663 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST;
664
665 /* Nothing to do? Dropping the reference was all we needed? */
666 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
667 return 1;
668
669 /*
670 * Not the fast normal case? Get the lock. We've already decremented
671 * the refcount, but we'll need to re-check the situation after
672 * getting the lock.
673 */
674 spin_lock(&dentry->d_lock);
675
676 /*
677 * Did somebody else grab a reference to it in the meantime, and
678 * we're no longer the last user after all? Alternatively, somebody
679 * else could have killed it and marked it dead. Either way, we
680 * don't need to do anything else.
681 */
682 if (dentry->d_lockref.count) {
683 spin_unlock(&dentry->d_lock);
684 return 1;
685 }
686
687 /*
688 * Re-get the reference we optimistically dropped. We hold the
689 * lock, and we just tested that it was zero, so we can just
690 * set it to 1.
691 */
692 dentry->d_lockref.count = 1;
693 return 0;
694}
695
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
698 * This is dput
699 *
700 * This is complicated by the fact that we do not want to put
701 * dentries that are no longer on any hash chain on the unused
702 * list: we'd much rather just get rid of them immediately.
703 *
704 * However, that implies that we have to traverse the dentry
705 * tree upwards to the parents which might _also_ now be
706 * scheduled for deletion (it may have been only waiting for
707 * its last child to go away).
708 *
709 * This tail recursion is done by hand as we don't want to depend
710 * on the compiler to always get this right (gcc generally doesn't).
711 * Real recursion would eat up our stack space.
712 */
713
714/*
715 * dput - release a dentry
716 * @dentry: dentry to release
717 *
718 * Release a dentry. This will drop the usage count and if appropriate
719 * call the dentry unlink method as well as removing it from the queues and
720 * releasing its resources. If the parent dentries were scheduled for release
721 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723void dput(struct dentry *dentry)
724{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700725 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 return;
727
728repeat:
Linus Torvalds360f5472015-01-09 15:19:03 -0800729 rcu_read_lock();
730 if (likely(fast_dput(dentry))) {
731 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800733 }
734
735 /* Slow case: now with the dentry lock held */
736 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700738 /* Unreachable? Get rid of it */
739 if (unlikely(d_unhashed(dentry)))
740 goto kill_it;
741
742 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100744 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 }
Nick Piggin265ac902010-10-10 05:36:24 -0400746
Linus Torvalds358eec12013-10-31 15:43:02 -0700747 if (!(dentry->d_flags & DCACHE_REFERENCED))
748 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400749 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400750
Waiman Long98474232013-08-28 18:24:59 -0700751 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100752 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 return;
754
Miklos Szeredid52b9082007-05-08 00:23:46 -0700755kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400756 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700757 if (dentry)
758 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700760EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100763/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100764static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
Waiman Long98474232013-08-28 18:24:59 -0700766 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
768
Nick Piggindc0474b2011-01-07 17:49:43 +1100769static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100770{
Waiman Long98474232013-08-28 18:24:59 -0700771 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100772}
773
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100774struct dentry *dget_parent(struct dentry *dentry)
775{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700776 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100777 struct dentry *ret;
778
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700779 /*
780 * Do optimistic parent lookup without any
781 * locking.
782 */
783 rcu_read_lock();
784 ret = ACCESS_ONCE(dentry->d_parent);
785 gotref = lockref_get_not_zero(&ret->d_lockref);
786 rcu_read_unlock();
787 if (likely(gotref)) {
788 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
789 return ret;
790 dput(ret);
791 }
792
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100793repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100794 /*
795 * Don't need rcu_dereference because we re-check it was correct under
796 * the lock.
797 */
798 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100799 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100800 spin_lock(&ret->d_lock);
801 if (unlikely(ret != dentry->d_parent)) {
802 spin_unlock(&ret->d_lock);
803 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100804 goto repeat;
805 }
Nick Piggina734eb42011-01-07 17:49:44 +1100806 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700807 BUG_ON(!ret->d_lockref.count);
808 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100809 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100810 return ret;
811}
812EXPORT_SYMBOL(dget_parent);
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814/**
815 * d_find_alias - grab a hashed alias of inode
816 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 *
818 * If inode has a hashed alias, or is a directory and has any alias,
819 * acquire the reference to alias and return it. Otherwise return NULL.
820 * Notice that if inode is a directory there can be only one alias and
821 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800822 * of a filesystem, or if the directory was renamed and d_revalidate
823 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700825 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500826 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500828static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829{
Nick Pigginda502952011-01-07 17:49:33 +1100830 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Nick Pigginda502952011-01-07 17:49:33 +1100832again:
833 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400834 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100835 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700837 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100838 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500840 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100841 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100842 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 return alias;
844 }
845 }
Nick Pigginda502952011-01-07 17:49:33 +1100846 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 }
Nick Pigginda502952011-01-07 17:49:33 +1100848 if (discon_alias) {
849 alias = discon_alias;
850 spin_lock(&alias->d_lock);
851 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500852 __dget_dlock(alias);
853 spin_unlock(&alias->d_lock);
854 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100855 }
856 spin_unlock(&alias->d_lock);
857 goto again;
858 }
859 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860}
861
Nick Pigginda502952011-01-07 17:49:33 +1100862struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
David Howells214fda12006-03-25 03:06:36 -0800864 struct dentry *de = NULL;
865
Al Virob3d9b7a2012-06-09 13:51:19 -0400866 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100867 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500868 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100869 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800870 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 return de;
872}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700873EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875/*
876 * Try to kill dentries associated with this inode.
877 * WARNING: you must own a reference to inode.
878 */
879void d_prune_aliases(struct inode *inode)
880{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700881 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100883 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400884 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700886 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400887 struct dentry *parent = lock_parent(dentry);
888 if (likely(!dentry->d_lockref.count)) {
889 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800890 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400891 goto restart;
892 }
893 if (parent)
894 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 }
896 spin_unlock(&dentry->d_lock);
897 }
Nick Piggin873feea2011-01-07 17:50:06 +1100898 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700900EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400902static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Al Viro5c47e6d2014-04-29 16:13:18 -0400904 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700905
Miklos Szeredi60942f22014-05-02 15:38:39 -0400906 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400907 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400908 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100909 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400910 parent = lock_parent(dentry);
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000913 * The dispose list is isolated and dentries are not accounted
914 * to the LRU here, so we can simply remove it from the list
915 * here regardless of whether it is referenced or not.
916 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400917 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000918
919 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000921 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800923 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700924 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400925 if (parent)
926 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 continue;
928 }
Nick Piggin77812a12011-01-07 17:49:48 +1100929
Al Viro64fd72e2014-05-28 09:48:44 -0400930
931 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
932 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
933 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400934 if (parent)
935 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400936 if (can_free)
937 dentry_free(dentry);
938 continue;
939 }
940
Al Viroff2fde92014-05-28 13:59:13 -0400941 inode = dentry->d_inode;
942 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400943 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000944 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400945 if (parent)
946 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400947 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000948 }
Al Viroff2fde92014-05-28 13:59:13 -0400949
Al Viroff2fde92014-05-28 13:59:13 -0400950 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400951
Al Viro5c47e6d2014-04-29 16:13:18 -0400952 /*
953 * We need to prune ancestors too. This is necessary to prevent
954 * quadratic behavior of shrink_dcache_parent(), but is also
955 * expected to be beneficial in reducing dentry cache
956 * fragmentation.
957 */
958 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400959 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
960 parent = lock_parent(dentry);
961 if (dentry->d_lockref.count != 1) {
962 dentry->d_lockref.count--;
963 spin_unlock(&dentry->d_lock);
964 if (parent)
965 spin_unlock(&parent->d_lock);
966 break;
967 }
968 inode = dentry->d_inode; /* can't be NULL */
969 if (unlikely(!spin_trylock(&inode->i_lock))) {
970 spin_unlock(&dentry->d_lock);
971 if (parent)
972 spin_unlock(&parent->d_lock);
973 cpu_relax();
974 continue;
975 }
976 __dentry_kill(dentry);
977 dentry = parent;
978 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400980}
981
Dave Chinnerf6041562013-08-28 10:18:00 +1000982static enum lru_status
983dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
984{
985 struct list_head *freeable = arg;
986 struct dentry *dentry = container_of(item, struct dentry, d_lru);
987
988
989 /*
990 * we are inverting the lru lock/dentry->d_lock here,
991 * so use a trylock. If we fail to get the lock, just skip
992 * it
993 */
994 if (!spin_trylock(&dentry->d_lock))
995 return LRU_SKIP;
996
997 /*
998 * Referenced dentries are still in use. If they have active
999 * counts, just remove them from the LRU. Otherwise give them
1000 * another pass through the LRU.
1001 */
1002 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001003 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001004 spin_unlock(&dentry->d_lock);
1005 return LRU_REMOVED;
1006 }
1007
1008 if (dentry->d_flags & DCACHE_REFERENCED) {
1009 dentry->d_flags &= ~DCACHE_REFERENCED;
1010 spin_unlock(&dentry->d_lock);
1011
1012 /*
1013 * The list move itself will be made by the common LRU code. At
1014 * this point, we've dropped the dentry->d_lock but keep the
1015 * lru lock. This is safe to do, since every list movement is
1016 * protected by the lru lock even if both locks are held.
1017 *
1018 * This is guaranteed by the fact that all LRU management
1019 * functions are intermediated by the LRU API calls like
1020 * list_lru_add and list_lru_del. List movement in this file
1021 * only ever occur through this functions or through callbacks
1022 * like this one, that are called from the LRU API.
1023 *
1024 * The only exceptions to this are functions like
1025 * shrink_dentry_list, and code that first checks for the
1026 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1027 * operating only with stack provided lists after they are
1028 * properly isolated from the main list. It is thus, always a
1029 * local access.
1030 */
1031 return LRU_ROTATE;
1032 }
1033
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001034 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001035 spin_unlock(&dentry->d_lock);
1036
1037 return LRU_REMOVED;
1038}
1039
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001040/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001041 * prune_dcache_sb - shrink the dcache
1042 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +10001043 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +10001044 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001045 *
Dave Chinnerf6041562013-08-28 10:18:00 +10001046 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001047 * done when we need more memory an called from the superblock shrinker
1048 * function.
1049 *
1050 * This function may fail to free any resources if all the dentries are in
1051 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001052 */
Dave Chinner9b17c622013-08-28 10:18:05 +10001053long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
1054 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001055{
Dave Chinnerf6041562013-08-28 10:18:00 +10001056 LIST_HEAD(dispose);
1057 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001058
Dave Chinner9b17c622013-08-28 10:18:05 +10001059 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
1060 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +10001061 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001062 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063}
1064
Glauber Costa4e717f52013-08-28 10:18:03 +10001065static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
1066 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001067{
Glauber Costa4e717f52013-08-28 10:18:03 +10001068 struct list_head *freeable = arg;
1069 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001070
Glauber Costa4e717f52013-08-28 10:18:03 +10001071 /*
1072 * we are inverting the lru lock/dentry->d_lock here,
1073 * so use a trylock. If we fail to get the lock, just skip
1074 * it
1075 */
1076 if (!spin_trylock(&dentry->d_lock))
1077 return LRU_SKIP;
1078
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001079 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001080 spin_unlock(&dentry->d_lock);
1081
1082 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001083}
1084
Glauber Costa4e717f52013-08-28 10:18:03 +10001085
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001086/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 * shrink_dcache_sb - shrink dcache for a superblock
1088 * @sb: superblock
1089 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001090 * Shrink the dcache for the specified super block. This is used to free
1091 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094{
Glauber Costa4e717f52013-08-28 10:18:03 +10001095 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001096
Glauber Costa4e717f52013-08-28 10:18:03 +10001097 do {
1098 LIST_HEAD(dispose);
1099
1100 freed = list_lru_walk(&sb->s_dentry_lru,
1101 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1102
1103 this_cpu_sub(nr_dentry_unused, freed);
1104 shrink_dentry_list(&dispose);
1105 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001107EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001110 * enum d_walk_ret - action to talke during tree walk
1111 * @D_WALK_CONTINUE: contrinue walk
1112 * @D_WALK_QUIT: quit walk
1113 * @D_WALK_NORETRY: quit when retry is needed
1114 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001116enum d_walk_ret {
1117 D_WALK_CONTINUE,
1118 D_WALK_QUIT,
1119 D_WALK_NORETRY,
1120 D_WALK_SKIP,
1121};
1122
1123/**
1124 * d_walk - walk the dentry tree
1125 * @parent: start of walk
1126 * @data: data passed to @enter() and @finish()
1127 * @enter: callback when first entering the dentry
1128 * @finish: callback when successfully finished the walk
1129 *
1130 * The @enter() and @finish() callbacks are called with d_lock held.
1131 */
1132static void d_walk(struct dentry *parent, void *data,
1133 enum d_walk_ret (*enter)(void *, struct dentry *),
1134 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135{
Nick Piggin949854d2011-01-07 17:49:37 +11001136 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001138 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001139 enum d_walk_ret ret;
1140 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001141
Nick Piggin58db63d2011-01-07 17:49:39 +11001142again:
Al Viro48f5ec22013-09-09 15:22:25 -04001143 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001144 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001145 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001146
1147 ret = enter(data, this_parent);
1148 switch (ret) {
1149 case D_WALK_CONTINUE:
1150 break;
1151 case D_WALK_QUIT:
1152 case D_WALK_SKIP:
1153 goto out_unlock;
1154 case D_WALK_NORETRY:
1155 retry = false;
1156 break;
1157 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158repeat:
1159 next = this_parent->d_subdirs.next;
1160resume:
1161 while (next != &this_parent->d_subdirs) {
1162 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001163 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001165
1166 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001167
1168 ret = enter(data, dentry);
1169 switch (ret) {
1170 case D_WALK_CONTINUE:
1171 break;
1172 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001173 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001174 goto out_unlock;
1175 case D_WALK_NORETRY:
1176 retry = false;
1177 break;
1178 case D_WALK_SKIP:
1179 spin_unlock(&dentry->d_lock);
1180 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001181 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001184 spin_unlock(&this_parent->d_lock);
1185 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001187 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 goto repeat;
1189 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001190 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 }
1192 /*
1193 * All done at this level ... ascend and resume the search.
1194 */
Al Viroca5358e2014-10-26 19:31:10 -04001195 rcu_read_lock();
1196ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001198 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001199 this_parent = child->d_parent;
1200
Al Viro31dec132013-10-25 17:04:27 -04001201 spin_unlock(&child->d_lock);
1202 spin_lock(&this_parent->d_lock);
1203
Al Viroca5358e2014-10-26 19:31:10 -04001204 /* might go back up the wrong parent if we have had a rename. */
1205 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001206 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001207 next = child->d_child.next;
1208 while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED)) {
1209 if (next == &this_parent->d_subdirs)
1210 goto ascend;
1211 child = list_entry(next, struct dentry, d_child);
1212 next = next->next;
Al Viro31dec132013-10-25 17:04:27 -04001213 }
1214 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 goto resume;
1216 }
Al Viroca5358e2014-10-26 19:31:10 -04001217 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001219 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001220 if (finish)
1221 finish(data);
1222
1223out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001224 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001225 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001226 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001227
1228rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001229 spin_unlock(&this_parent->d_lock);
1230 rcu_read_unlock();
1231 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001232 if (!retry)
1233 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001234 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001235 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001237
1238/*
1239 * Search for at least 1 mount point in the dentry's subdirs.
1240 * We descend to the next level whenever the d_subdirs
1241 * list is non-empty and continue searching.
1242 */
1243
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001244static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1245{
1246 int *ret = data;
1247 if (d_mountpoint(dentry)) {
1248 *ret = 1;
1249 return D_WALK_QUIT;
1250 }
1251 return D_WALK_CONTINUE;
1252}
1253
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001254/**
1255 * have_submounts - check for mounts over a dentry
1256 * @parent: dentry to check.
1257 *
1258 * Return true if the parent or its subdirectories contain
1259 * a mount point
1260 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001261int have_submounts(struct dentry *parent)
1262{
1263 int ret = 0;
1264
1265 d_walk(parent, &ret, check_mount, NULL);
1266
1267 return ret;
1268}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001269EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
1271/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001272 * Called by mount code to set a mountpoint and check if the mountpoint is
1273 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1274 * subtree can become unreachable).
1275 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001276 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001277 * this reason take rename_lock and d_lock on dentry and ancestors.
1278 */
1279int d_set_mounted(struct dentry *dentry)
1280{
1281 struct dentry *p;
1282 int ret = -ENOENT;
1283 write_seqlock(&rename_lock);
1284 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001285 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001286 spin_lock(&p->d_lock);
1287 if (unlikely(d_unhashed(p))) {
1288 spin_unlock(&p->d_lock);
1289 goto out;
1290 }
1291 spin_unlock(&p->d_lock);
1292 }
1293 spin_lock(&dentry->d_lock);
1294 if (!d_unlinked(dentry)) {
1295 dentry->d_flags |= DCACHE_MOUNTED;
1296 ret = 0;
1297 }
1298 spin_unlock(&dentry->d_lock);
1299out:
1300 write_sequnlock(&rename_lock);
1301 return ret;
1302}
1303
1304/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001305 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 * and move any unused dentries to the end of the unused
1307 * list for prune_dcache(). We descend to the next level
1308 * whenever the d_subdirs list is non-empty and continue
1309 * searching.
1310 *
1311 * It returns zero iff there are no unused children,
1312 * otherwise it returns the number of children moved to
1313 * the end of the unused list. This may not be the total
1314 * number of unused children, because select_parent can
1315 * drop the lock and return early due to latency
1316 * constraints.
1317 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001318
1319struct select_data {
1320 struct dentry *start;
1321 struct list_head dispose;
1322 int found;
1323};
1324
1325static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001327 struct select_data *data = _data;
1328 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001330 if (data->start == dentry)
1331 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
Al Virofe915222014-05-03 00:02:25 -04001333 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001334 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001335 } else {
1336 if (dentry->d_flags & DCACHE_LRU_LIST)
1337 d_lru_del(dentry);
1338 if (!dentry->d_lockref.count) {
1339 d_shrink_add(dentry, &data->dispose);
1340 data->found++;
1341 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 }
1343 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001344 * We can return to the caller if we have found some (this
1345 * ensures forward progress). We'll be coming back to find
1346 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 */
Al Virofe915222014-05-03 00:02:25 -04001348 if (!list_empty(&data->dispose))
1349 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001351 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352}
1353
1354/**
1355 * shrink_dcache_parent - prune dcache
1356 * @parent: parent of entries to prune
1357 *
1358 * Prune the dcache to remove unused children of the parent dentry.
1359 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001360void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001362 for (;;) {
1363 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001365 INIT_LIST_HEAD(&data.dispose);
1366 data.start = parent;
1367 data.found = 0;
1368
1369 d_walk(parent, &data, select_collect, NULL);
1370 if (!data.found)
1371 break;
1372
1373 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001374 cond_resched();
1375 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001377EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Al Viro9c8c10e2014-05-02 20:36:10 -04001379static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001380{
Al Viro9c8c10e2014-05-02 20:36:10 -04001381 /* it has busy descendents; complain about those instead */
1382 if (!list_empty(&dentry->d_subdirs))
1383 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001384
Al Viro9c8c10e2014-05-02 20:36:10 -04001385 /* root with refcount 1 is fine */
1386 if (dentry == _data && dentry->d_lockref.count == 1)
1387 return D_WALK_CONTINUE;
1388
1389 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1390 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001391 dentry,
1392 dentry->d_inode ?
1393 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001394 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001395 dentry->d_lockref.count,
1396 dentry->d_sb->s_type->name,
1397 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001398 WARN_ON(1);
1399 return D_WALK_CONTINUE;
1400}
1401
1402static void do_one_tree(struct dentry *dentry)
1403{
1404 shrink_dcache_parent(dentry);
1405 d_walk(dentry, dentry, umount_check, NULL);
1406 d_drop(dentry);
1407 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001408}
1409
1410/*
1411 * destroy the dentries attached to a superblock on unmounting
1412 */
1413void shrink_dcache_for_umount(struct super_block *sb)
1414{
1415 struct dentry *dentry;
1416
Al Viro9c8c10e2014-05-02 20:36:10 -04001417 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001418
1419 dentry = sb->s_root;
1420 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001421 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001422
1423 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001424 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1425 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001426 }
1427}
1428
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001429struct detach_data {
1430 struct select_data select;
1431 struct dentry *mountpoint;
1432};
1433static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001434{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001435 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001436
1437 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001438 __dget_dlock(dentry);
1439 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001440 return D_WALK_QUIT;
1441 }
1442
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001443 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001444}
1445
1446static void check_and_drop(void *_data)
1447{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001448 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001449
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001450 if (!data->mountpoint && !data->select.found)
1451 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001452}
1453
1454/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001455 * d_invalidate - detach submounts, prune dcache, and drop
1456 * @dentry: dentry to invalidate (aka detach, prune and drop)
1457 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001458 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001459 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001460 * The final d_drop is done as an atomic operation relative to
1461 * rename_lock ensuring there are no races with d_set_mounted. This
1462 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001463 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001464void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001465{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001466 /*
1467 * If it's already been dropped, return OK.
1468 */
1469 spin_lock(&dentry->d_lock);
1470 if (d_unhashed(dentry)) {
1471 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001472 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001473 }
1474 spin_unlock(&dentry->d_lock);
1475
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001476 /* Negative dentries can be dropped without further checks */
1477 if (!dentry->d_inode) {
1478 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001479 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001480 }
1481
1482 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001483 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001484
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001485 data.mountpoint = NULL;
1486 INIT_LIST_HEAD(&data.select.dispose);
1487 data.select.start = dentry;
1488 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001489
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001490 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001491
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001492 if (data.select.found)
1493 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001494
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001495 if (data.mountpoint) {
1496 detach_mounts(data.mountpoint);
1497 dput(data.mountpoint);
1498 }
1499
1500 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001501 break;
1502
1503 cond_resched();
1504 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001505}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001506EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508/**
Al Viroa4464db2011-07-07 15:03:58 -04001509 * __d_alloc - allocate a dcache entry
1510 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 * @name: qstr of the name
1512 *
1513 * Allocates a dentry. It returns %NULL if there is insufficient memory
1514 * available. On a success the dentry is returned. The name passed in is
1515 * copied and the copy passed in may be reused after this call.
1516 */
1517
Al Viroa4464db2011-07-07 15:03:58 -04001518struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519{
1520 struct dentry *dentry;
1521 char *dname;
1522
Mel Gormane12ba742007-10-16 01:25:52 -07001523 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 if (!dentry)
1525 return NULL;
1526
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001527 /*
1528 * We guarantee that the inline name is always NUL-terminated.
1529 * This way the memcpy() done by the name switching in rename
1530 * will still always have a NUL at the end, even if we might
1531 * be overwriting an internal NUL character
1532 */
1533 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001535 size_t size = offsetof(struct external_name, name[1]);
1536 struct external_name *p = kmalloc(size + name->len, GFP_KERNEL);
1537 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 kmem_cache_free(dentry_cache, dentry);
1539 return NULL;
1540 }
Al Viro8d85b482014-09-29 14:54:27 -04001541 atomic_set(&p->u.count, 1);
1542 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 } else {
1544 dname = dentry->d_iname;
1545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
1547 dentry->d_name.len = name->len;
1548 dentry->d_name.hash = name->hash;
1549 memcpy(dname, name->name, name->len);
1550 dname[name->len] = 0;
1551
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001552 /* Make sure we always see the terminating NUL character */
1553 smp_wmb();
1554 dentry->d_name.name = dname;
1555
Waiman Long98474232013-08-28 18:24:59 -07001556 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001557 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001559 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001561 dentry->d_parent = dentry;
1562 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 dentry->d_op = NULL;
1564 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001565 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 INIT_LIST_HEAD(&dentry->d_lru);
1567 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001568 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1569 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001570 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Nick Piggin3e880fb2011-01-07 17:49:19 +11001572 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 return dentry;
1575}
Al Viroa4464db2011-07-07 15:03:58 -04001576
1577/**
1578 * d_alloc - allocate a dcache entry
1579 * @parent: parent of entry to allocate
1580 * @name: qstr of the name
1581 *
1582 * Allocates a dentry. It returns %NULL if there is insufficient memory
1583 * available. On a success the dentry is returned. The name passed in is
1584 * copied and the copy passed in may be reused after this call.
1585 */
1586struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1587{
1588 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1589 if (!dentry)
1590 return NULL;
1591
1592 spin_lock(&parent->d_lock);
1593 /*
1594 * don't need child lock because it is not subject
1595 * to concurrency here
1596 */
1597 __dget_dlock(parent);
1598 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001599 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001600 spin_unlock(&parent->d_lock);
1601
1602 return dentry;
1603}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001604EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001606/**
1607 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1608 * @sb: the superblock
1609 * @name: qstr of the name
1610 *
1611 * For a filesystem that just pins its dentries in memory and never
1612 * performs lookups at all, return an unhashed IS_ROOT dentry.
1613 */
Nick Piggin4b936882011-01-07 17:50:07 +11001614struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1615{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001616 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001617}
1618EXPORT_SYMBOL(d_alloc_pseudo);
1619
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1621{
1622 struct qstr q;
1623
1624 q.name = name;
1625 q.len = strlen(name);
1626 q.hash = full_name_hash(q.name, q.len);
1627 return d_alloc(parent, &q);
1628}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001629EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Nick Pigginfb045ad2011-01-07 17:49:55 +11001631void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1632{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001633 WARN_ON_ONCE(dentry->d_op);
1634 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001635 DCACHE_OP_COMPARE |
1636 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001637 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001638 DCACHE_OP_DELETE ));
1639 dentry->d_op = op;
1640 if (!op)
1641 return;
1642 if (op->d_hash)
1643 dentry->d_flags |= DCACHE_OP_HASH;
1644 if (op->d_compare)
1645 dentry->d_flags |= DCACHE_OP_COMPARE;
1646 if (op->d_revalidate)
1647 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001648 if (op->d_weak_revalidate)
1649 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001650 if (op->d_delete)
1651 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001652 if (op->d_prune)
1653 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001654
1655}
1656EXPORT_SYMBOL(d_set_d_op);
1657
David Howellsb18825a2013-09-12 19:22:53 +01001658static unsigned d_flags_for_inode(struct inode *inode)
1659{
1660 unsigned add_flags = DCACHE_FILE_TYPE;
1661
1662 if (!inode)
1663 return DCACHE_MISS_TYPE;
1664
1665 if (S_ISDIR(inode->i_mode)) {
1666 add_flags = DCACHE_DIRECTORY_TYPE;
1667 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1668 if (unlikely(!inode->i_op->lookup))
1669 add_flags = DCACHE_AUTODIR_TYPE;
1670 else
1671 inode->i_opflags |= IOP_LOOKUP;
1672 }
1673 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1674 if (unlikely(inode->i_op->follow_link))
1675 add_flags = DCACHE_SYMLINK_TYPE;
1676 else
1677 inode->i_opflags |= IOP_NOFOLLOW;
1678 }
1679
1680 if (unlikely(IS_AUTOMOUNT(inode)))
1681 add_flags |= DCACHE_NEED_AUTOMOUNT;
1682 return add_flags;
1683}
1684
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001685static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1686{
David Howellsb18825a2013-09-12 19:22:53 +01001687 unsigned add_flags = d_flags_for_inode(inode);
1688
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001689 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001690 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001691 if (inode)
Al Viro946e51f2014-10-26 19:19:16 -04001692 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001693 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001694 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001695 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001696 fsnotify_d_instantiate(dentry, inode);
1697}
1698
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699/**
1700 * d_instantiate - fill in inode information for a dentry
1701 * @entry: dentry to complete
1702 * @inode: inode to attach to this dentry
1703 *
1704 * Fill in inode information in the entry.
1705 *
1706 * This turns negative dentries into productive full members
1707 * of society.
1708 *
1709 * NOTE! This assumes that the inode count has been incremented
1710 * (or otherwise set) by the caller to indicate that it is now
1711 * in use by the dcache.
1712 */
1713
1714void d_instantiate(struct dentry *entry, struct inode * inode)
1715{
Al Viro946e51f2014-10-26 19:19:16 -04001716 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001717 if (inode)
1718 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001719 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001720 if (inode)
1721 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 security_d_instantiate(entry, inode);
1723}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001724EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726/**
1727 * d_instantiate_unique - instantiate a non-aliased dentry
1728 * @entry: dentry to instantiate
1729 * @inode: inode to attach to this dentry
1730 *
1731 * Fill in inode information in the entry. On success, it returns NULL.
1732 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001733 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 *
1735 * Note that in order to avoid conflicts with rename() etc, the caller
1736 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001737 *
1738 * This also assumes that the inode count has been incremented
1739 * (or otherwise set) by the caller to indicate that it is now
1740 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 */
David Howells770bfad2006-08-22 20:06:07 -04001742static struct dentry *__d_instantiate_unique(struct dentry *entry,
1743 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744{
1745 struct dentry *alias;
1746 int len = entry->d_name.len;
1747 const char *name = entry->d_name.name;
1748 unsigned int hash = entry->d_name.hash;
1749
David Howells770bfad2006-08-22 20:06:07 -04001750 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001751 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001752 return NULL;
1753 }
1754
Al Viro946e51f2014-10-26 19:19:16 -04001755 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001756 /*
1757 * Don't need alias->d_lock here, because aliases with
1758 * d_parent == entry->d_parent are not subject to name or
1759 * parent changes, because the parent inode i_mutex is held.
1760 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001761 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 continue;
1763 if (alias->d_parent != entry->d_parent)
1764 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001765 if (alias->d_name.len != len)
1766 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001767 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001769 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 return alias;
1771 }
David Howells770bfad2006-08-22 20:06:07 -04001772
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001773 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 return NULL;
1775}
David Howells770bfad2006-08-22 20:06:07 -04001776
1777struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1778{
1779 struct dentry *result;
1780
Al Viro946e51f2014-10-26 19:19:16 -04001781 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001782
Nick Piggin873feea2011-01-07 17:50:06 +11001783 if (inode)
1784 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001785 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001786 if (inode)
1787 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001788
1789 if (!result) {
1790 security_d_instantiate(entry, inode);
1791 return NULL;
1792 }
1793
1794 BUG_ON(!d_unhashed(result));
1795 iput(inode);
1796 return result;
1797}
1798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799EXPORT_SYMBOL(d_instantiate_unique);
1800
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001801/**
1802 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1803 * @entry: dentry to complete
1804 * @inode: inode to attach to this dentry
1805 *
1806 * Fill in inode information in the entry. If a directory alias is found, then
1807 * return an error (and drop inode). Together with d_materialise_unique() this
1808 * guarantees that a directory inode may never have more than one alias.
1809 */
1810int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1811{
Al Viro946e51f2014-10-26 19:19:16 -04001812 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001813
1814 spin_lock(&inode->i_lock);
1815 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1816 spin_unlock(&inode->i_lock);
1817 iput(inode);
1818 return -EBUSY;
1819 }
1820 __d_instantiate(entry, inode);
1821 spin_unlock(&inode->i_lock);
1822 security_d_instantiate(entry, inode);
1823
1824 return 0;
1825}
1826EXPORT_SYMBOL(d_instantiate_no_diralias);
1827
Al Viroadc0e91a2012-01-08 16:49:21 -05001828struct dentry *d_make_root(struct inode *root_inode)
1829{
1830 struct dentry *res = NULL;
1831
1832 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001833 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e91a2012-01-08 16:49:21 -05001834
1835 res = __d_alloc(root_inode->i_sb, &name);
1836 if (res)
1837 d_instantiate(res, root_inode);
1838 else
1839 iput(root_inode);
1840 }
1841 return res;
1842}
1843EXPORT_SYMBOL(d_make_root);
1844
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001845static struct dentry * __d_find_any_alias(struct inode *inode)
1846{
1847 struct dentry *alias;
1848
Al Virob3d9b7a2012-06-09 13:51:19 -04001849 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001850 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001851 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001852 __dget(alias);
1853 return alias;
1854}
1855
Sage Weil46f72b32012-01-10 09:04:37 -08001856/**
1857 * d_find_any_alias - find any alias for a given inode
1858 * @inode: inode to find an alias for
1859 *
1860 * If any aliases exist for the given inode, take and return a
1861 * reference for one of them. If no aliases exist, return %NULL.
1862 */
1863struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001864{
1865 struct dentry *de;
1866
1867 spin_lock(&inode->i_lock);
1868 de = __d_find_any_alias(inode);
1869 spin_unlock(&inode->i_lock);
1870 return de;
1871}
Sage Weil46f72b32012-01-10 09:04:37 -08001872EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001873
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001874static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001875{
NeilBrownb911a6b2012-11-08 16:09:37 -08001876 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001877 struct dentry *tmp;
1878 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001879 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001880
1881 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001882 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001883 if (IS_ERR(inode))
1884 return ERR_CAST(inode);
1885
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001886 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001887 if (res)
1888 goto out_iput;
1889
Al Viroa4464db2011-07-07 15:03:58 -04001890 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001891 if (!tmp) {
1892 res = ERR_PTR(-ENOMEM);
1893 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001894 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001895
Nick Piggin873feea2011-01-07 17:50:06 +11001896 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001897 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001898 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001899 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001900 dput(tmp);
1901 goto out_iput;
1902 }
1903
1904 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001905 add_flags = d_flags_for_inode(inode);
1906
1907 if (disconnected)
1908 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001909
Christoph Hellwig9308a612008-08-11 15:49:12 +02001910 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001911 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001912 tmp->d_flags |= add_flags;
Al Viro946e51f2014-10-26 19:19:16 -04001913 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001914 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001915 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001916 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001917 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001918 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001919 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001920
Christoph Hellwig9308a612008-08-11 15:49:12 +02001921 return tmp;
1922
1923 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001924 if (res && !IS_ERR(res))
1925 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001926 iput(inode);
1927 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001928}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001929
1930/**
1931 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1932 * @inode: inode to allocate the dentry for
1933 *
1934 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1935 * similar open by handle operations. The returned dentry may be anonymous,
1936 * or may have a full name (if the inode was already in the cache).
1937 *
1938 * When called on a directory inode, we must ensure that the inode only ever
1939 * has one dentry. If a dentry is found, that is returned instead of
1940 * allocating a new one.
1941 *
1942 * On successful return, the reference to the inode has been transferred
1943 * to the dentry. In case of an error the reference on the inode is released.
1944 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1945 * be passed in and the error will be propagated to the return value,
1946 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1947 */
1948struct dentry *d_obtain_alias(struct inode *inode)
1949{
1950 return __d_obtain_alias(inode, 1);
1951}
Benny Halevyadc48722009-02-27 14:02:59 -08001952EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
1954/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001955 * d_obtain_root - find or allocate a dentry for a given inode
1956 * @inode: inode to allocate the dentry for
1957 *
1958 * Obtain an IS_ROOT dentry for the root of a filesystem.
1959 *
1960 * We must ensure that directory inodes only ever have one dentry. If a
1961 * dentry is found, that is returned instead of allocating a new one.
1962 *
1963 * On successful return, the reference to the inode has been transferred
1964 * to the dentry. In case of an error the reference on the inode is
1965 * released. A %NULL or IS_ERR inode may be passed in and will be the
1966 * error will be propagate to the return value, with a %NULL @inode
1967 * replaced by ERR_PTR(-ESTALE).
1968 */
1969struct dentry *d_obtain_root(struct inode *inode)
1970{
1971 return __d_obtain_alias(inode, 0);
1972}
1973EXPORT_SYMBOL(d_obtain_root);
1974
1975/**
Barry Naujok94035402008-05-21 16:50:46 +10001976 * d_add_ci - lookup or allocate new dentry with case-exact name
1977 * @inode: the inode case-insensitive lookup has found
1978 * @dentry: the negative dentry that was passed to the parent's lookup func
1979 * @name: the case-exact name to be associated with the returned dentry
1980 *
1981 * This is to avoid filling the dcache with case-insensitive names to the
1982 * same inode, only the actual correct case is stored in the dcache for
1983 * case-insensitive filesystems.
1984 *
1985 * For a case-insensitive lookup match and if the the case-exact dentry
1986 * already exists in in the dcache, use it and return it.
1987 *
1988 * If no entry exists with the exact case name, allocate new dentry with
1989 * the exact case, and return the spliced entry.
1990 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001991struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001992 struct qstr *name)
1993{
Barry Naujok94035402008-05-21 16:50:46 +10001994 struct dentry *found;
1995 struct dentry *new;
1996
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001997 /*
1998 * First check if a dentry matching the name already exists,
1999 * if not go ahead and create it now.
2000 */
Barry Naujok94035402008-05-21 16:50:46 +10002001 found = d_hash_and_lookup(dentry->d_parent, name);
Barry Naujok94035402008-05-21 16:50:46 +10002002 if (!found) {
2003 new = d_alloc(dentry->d_parent, name);
2004 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05002005 found = ERR_PTR(-ENOMEM);
Al Viro427c77d2014-10-12 18:46:26 -04002006 } else {
2007 found = d_splice_alias(inode, new);
2008 if (found) {
2009 dput(new);
2010 return found;
2011 }
2012 return new;
Barry Naujok94035402008-05-21 16:50:46 +10002013 }
Barry Naujok94035402008-05-21 16:50:46 +10002014 }
Barry Naujok94035402008-05-21 16:50:46 +10002015 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05002016 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002017}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002018EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002020/*
2021 * Do the slow-case of the dentry name compare.
2022 *
2023 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07002024 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002025 * filesystem can rely on them, and can use the 'name' and
2026 * 'len' information without worrying about walking off the
2027 * end of memory etc.
2028 *
2029 * Thus the read_seqcount_retry() and the "duplicate" info
2030 * in arguments (the low-level filesystem should not look
2031 * at the dentry inode or name contents directly, since
2032 * rename can change them while we're in RCU mode).
2033 */
2034enum slow_d_compare {
2035 D_COMP_OK,
2036 D_COMP_NOMATCH,
2037 D_COMP_SEQRETRY,
2038};
2039
2040static noinline enum slow_d_compare slow_dentry_cmp(
2041 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002042 struct dentry *dentry,
2043 unsigned int seq,
2044 const struct qstr *name)
2045{
2046 int tlen = dentry->d_name.len;
2047 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002048
2049 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2050 cpu_relax();
2051 return D_COMP_SEQRETRY;
2052 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002053 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002054 return D_COMP_NOMATCH;
2055 return D_COMP_OK;
2056}
2057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002059 * __d_lookup_rcu - search for a dentry (racy, store-free)
2060 * @parent: parent dentry
2061 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002062 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002063 * Returns: dentry, or NULL
2064 *
2065 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2066 * resolution (store-free path walking) design described in
2067 * Documentation/filesystems/path-lookup.txt.
2068 *
2069 * This is not to be used outside core vfs.
2070 *
2071 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2072 * held, and rcu_read_lock held. The returned dentry must not be stored into
2073 * without taking d_lock and checking d_seq sequence count against @seq
2074 * returned here.
2075 *
Linus Torvalds15570082013-09-02 11:38:06 -07002076 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002077 * function.
2078 *
2079 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2080 * the returned dentry, so long as its parent's seqlock is checked after the
2081 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2082 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002083 *
2084 * NOTE! The caller *has* to check the resulting dentry against the sequence
2085 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002086 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002087struct dentry *__d_lookup_rcu(const struct dentry *parent,
2088 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002089 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002090{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002091 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002092 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002093 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002094 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002095 struct dentry *dentry;
2096
2097 /*
2098 * Note: There is significant duplication with __d_lookup_rcu which is
2099 * required to prevent single threaded performance regressions
2100 * especially on architectures where smp_rmb (in seqcounts) are costly.
2101 * Keep the two functions in sync.
2102 */
2103
2104 /*
2105 * The hash list is protected using RCU.
2106 *
2107 * Carefully use d_seq when comparing a candidate dentry, to avoid
2108 * races with d_move().
2109 *
2110 * It is possible that concurrent renames can mess up our list
2111 * walk here and result in missing our dentry, resulting in the
2112 * false-negative result. d_lookup() protects against concurrent
2113 * renames using rename_lock seqlock.
2114 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002115 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002116 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002117 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002118 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002119
Nick Piggin31e6b012011-01-07 17:49:52 +11002120seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002121 /*
2122 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002123 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002124 *
2125 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002126 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002127 *
2128 * NOTE! We do a "raw" seqcount_begin here. That means that
2129 * we don't wait for the sequence count to stabilize if it
2130 * is in the middle of a sequence change. If we do the slow
2131 * dentry compare, we will do seqretries until it is stable,
2132 * and if we end up with a successful lookup, we actually
2133 * want to exit RCU lookup anyway.
2134 */
2135 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002136 if (dentry->d_parent != parent)
2137 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002138 if (d_unhashed(dentry))
2139 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002140
2141 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002142 if (dentry->d_name.hash != hashlen_hash(hashlen))
2143 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002144 *seqp = seq;
2145 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002146 case D_COMP_OK:
2147 return dentry;
2148 case D_COMP_NOMATCH:
2149 continue;
2150 default:
2151 goto seqretry;
2152 }
2153 }
2154
Linus Torvalds26fe5752012-05-10 13:14:12 -07002155 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002156 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002157 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002158 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002159 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002160 }
2161 return NULL;
2162}
2163
2164/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 * d_lookup - search for a dentry
2166 * @parent: parent dentry
2167 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002168 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002170 * d_lookup searches the children of the parent dentry for the name in
2171 * question. If the dentry is found its reference count is incremented and the
2172 * dentry is returned. The caller must use dput to free the entry when it has
2173 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 */
Al Viroda2d8452013-01-24 18:29:34 -05002175struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176{
Nick Piggin31e6b012011-01-07 17:49:52 +11002177 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002178 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
Daeseok Younb8314f92014-08-11 11:46:53 +09002180 do {
2181 seq = read_seqbegin(&rename_lock);
2182 dentry = __d_lookup(parent, name);
2183 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 break;
2185 } while (read_seqretry(&rename_lock, seq));
2186 return dentry;
2187}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002188EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
Nick Piggin31e6b012011-01-07 17:49:52 +11002190/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002191 * __d_lookup - search for a dentry (racy)
2192 * @parent: parent dentry
2193 * @name: qstr of name we wish to find
2194 * Returns: dentry, or NULL
2195 *
2196 * __d_lookup is like d_lookup, however it may (rarely) return a
2197 * false-negative result due to unrelated rename activity.
2198 *
2199 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2200 * however it must be used carefully, eg. with a following d_lookup in
2201 * the case of failure.
2202 *
2203 * __d_lookup callers must be commented.
2204 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002205struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206{
2207 unsigned int len = name->len;
2208 unsigned int hash = name->hash;
2209 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002210 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002211 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002212 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002213 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
Nick Pigginb04f7842010-08-18 04:37:34 +10002215 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002216 * Note: There is significant duplication with __d_lookup_rcu which is
2217 * required to prevent single threaded performance regressions
2218 * especially on architectures where smp_rmb (in seqcounts) are costly.
2219 * Keep the two functions in sync.
2220 */
2221
2222 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002223 * The hash list is protected using RCU.
2224 *
2225 * Take d_lock when comparing a candidate dentry, to avoid races
2226 * with d_move().
2227 *
2228 * It is possible that concurrent renames can mess up our list
2229 * walk here and result in missing our dentry, resulting in the
2230 * false-negative result. d_lookup() protects against concurrent
2231 * renames using rename_lock seqlock.
2232 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002233 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002234 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 rcu_read_lock();
2236
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002237 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 if (dentry->d_name.hash != hash)
2240 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241
2242 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 if (dentry->d_parent != parent)
2244 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002245 if (d_unhashed(dentry))
2246 goto next;
2247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 /*
2249 * It is safe to compare names since d_move() cannot
2250 * change the qstr (protected by d_lock).
2251 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002252 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002253 int tlen = dentry->d_name.len;
2254 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002255 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 goto next;
2257 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002258 if (dentry->d_name.len != len)
2259 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002260 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 goto next;
2262 }
2263
Waiman Long98474232013-08-28 18:24:59 -07002264 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002265 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 spin_unlock(&dentry->d_lock);
2267 break;
2268next:
2269 spin_unlock(&dentry->d_lock);
2270 }
2271 rcu_read_unlock();
2272
2273 return found;
2274}
2275
2276/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002277 * d_hash_and_lookup - hash the qstr then search for a dentry
2278 * @dir: Directory to search in
2279 * @name: qstr of name we wish to find
2280 *
Al Viro4f522a22013-02-11 23:20:37 -05002281 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002282 */
2283struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2284{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002285 /*
2286 * Check for a fs-specific hash function. Note that we must
2287 * calculate the standard hash first, as the d_op->d_hash()
2288 * routine may choose to leave the hash value unchanged.
2289 */
2290 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002291 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002292 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002293 if (unlikely(err < 0))
2294 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002295 }
Al Viro4f522a22013-02-11 23:20:37 -05002296 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002297}
Al Viro4f522a22013-02-11 23:20:37 -05002298EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002299
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300/*
2301 * When a file is deleted, we have two options:
2302 * - turn this dentry into a negative dentry
2303 * - unhash this dentry and free it.
2304 *
2305 * Usually, we want to just turn this into
2306 * a negative dentry, but if anybody else is
2307 * currently using the dentry or the inode
2308 * we can't do that and we fall back on removing
2309 * it from the hash queues and waiting for
2310 * it to be deleted later when it has no users
2311 */
2312
2313/**
2314 * d_delete - delete a dentry
2315 * @dentry: The dentry to delete
2316 *
2317 * Turn the dentry into a negative dentry if possible, otherwise
2318 * remove it from the hash queues so it can be deleted later
2319 */
2320
2321void d_delete(struct dentry * dentry)
2322{
Nick Piggin873feea2011-01-07 17:50:06 +11002323 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002324 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 /*
2326 * Are we the only user?
2327 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002328again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002330 inode = dentry->d_inode;
2331 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002332 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002333 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002334 spin_unlock(&dentry->d_lock);
2335 cpu_relax();
2336 goto again;
2337 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002338 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002339 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002340 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 return;
2342 }
2343
2344 if (!d_unhashed(dentry))
2345 __d_drop(dentry);
2346
2347 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002348
2349 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002351EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002353static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002355 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002356 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002357 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002358 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002359 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360}
2361
David Howells770bfad2006-08-22 20:06:07 -04002362static void _d_rehash(struct dentry * entry)
2363{
2364 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2365}
2366
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367/**
2368 * d_rehash - add an entry back to the hash
2369 * @entry: dentry to add to the hash
2370 *
2371 * Adds a dentry to the hash according to its name.
2372 */
2373
2374void d_rehash(struct dentry * entry)
2375{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002377 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002380EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002382/**
2383 * dentry_update_name_case - update case insensitive dentry with a new name
2384 * @dentry: dentry to be updated
2385 * @name: new name
2386 *
2387 * Update a case insensitive dentry with new case of name.
2388 *
2389 * dentry must have been returned by d_lookup with name @name. Old and new
2390 * name lengths must match (ie. no d_compare which allows mismatched name
2391 * lengths).
2392 *
2393 * Parent inode i_mutex must be held over d_lookup and into this call (to
2394 * keep renames and concurrent inserts, and readdir(2) away).
2395 */
2396void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2397{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002398 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002399 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2400
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002401 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002402 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002403 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002404 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002405 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002406}
2407EXPORT_SYMBOL(dentry_update_name_case);
2408
Al Viro8d85b482014-09-29 14:54:27 -04002409static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410{
Al Viro8d85b482014-09-29 14:54:27 -04002411 if (unlikely(dname_external(target))) {
2412 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 /*
2414 * Both external: swap the pointers
2415 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002416 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 } else {
2418 /*
2419 * dentry:internal, target:external. Steal target's
2420 * storage and make target internal.
2421 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002422 memcpy(target->d_iname, dentry->d_name.name,
2423 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 dentry->d_name.name = target->d_name.name;
2425 target->d_name.name = target->d_iname;
2426 }
2427 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002428 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 /*
2430 * dentry:external, target:internal. Give dentry's
2431 * storage to target and make dentry internal
2432 */
2433 memcpy(dentry->d_iname, target->d_name.name,
2434 target->d_name.len + 1);
2435 target->d_name.name = dentry->d_name.name;
2436 dentry->d_name.name = dentry->d_iname;
2437 } else {
2438 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002439 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002441 unsigned int i;
2442 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002443 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2444 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002445 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2446 swap(((long *) &dentry->d_iname)[i],
2447 ((long *) &target->d_iname)[i]);
2448 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 }
2450 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002451 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452}
2453
Al Viro8d85b482014-09-29 14:54:27 -04002454static void copy_name(struct dentry *dentry, struct dentry *target)
2455{
2456 struct external_name *old_name = NULL;
2457 if (unlikely(dname_external(dentry)))
2458 old_name = external_name(dentry);
2459 if (unlikely(dname_external(target))) {
2460 atomic_inc(&external_name(target)->u.count);
2461 dentry->d_name = target->d_name;
2462 } else {
2463 memcpy(dentry->d_iname, target->d_name.name,
2464 target->d_name.len + 1);
2465 dentry->d_name.name = dentry->d_iname;
2466 dentry->d_name.hash_len = target->d_name.hash_len;
2467 }
2468 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2469 kfree_rcu(old_name, u.head);
2470}
2471
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002472static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2473{
2474 /*
2475 * XXXX: do we really need to take target->d_lock?
2476 */
2477 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2478 spin_lock(&target->d_parent->d_lock);
2479 else {
2480 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2481 spin_lock(&dentry->d_parent->d_lock);
2482 spin_lock_nested(&target->d_parent->d_lock,
2483 DENTRY_D_LOCK_NESTED);
2484 } else {
2485 spin_lock(&target->d_parent->d_lock);
2486 spin_lock_nested(&dentry->d_parent->d_lock,
2487 DENTRY_D_LOCK_NESTED);
2488 }
2489 }
2490 if (target < dentry) {
2491 spin_lock_nested(&target->d_lock, 2);
2492 spin_lock_nested(&dentry->d_lock, 3);
2493 } else {
2494 spin_lock_nested(&dentry->d_lock, 2);
2495 spin_lock_nested(&target->d_lock, 3);
2496 }
2497}
2498
Al Viro986c01942014-09-26 23:11:15 -04002499static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002500{
2501 if (target->d_parent != dentry->d_parent)
2502 spin_unlock(&dentry->d_parent->d_lock);
2503 if (target->d_parent != target)
2504 spin_unlock(&target->d_parent->d_lock);
Al Viro986c01942014-09-26 23:11:15 -04002505 spin_unlock(&target->d_lock);
2506 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002507}
2508
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002510 * When switching names, the actual string doesn't strictly have to
2511 * be preserved in the target - because we're dropping the target
2512 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002513 * the new name before we switch, unless we are going to rehash
2514 * it. Note that if we *do* unhash the target, we are not allowed
2515 * to rehash it without giving it a new name/hash key - whether
2516 * we swap or overwrite the names here, resulting name won't match
2517 * the reality in filesystem; it's only there for d_path() purposes.
2518 * Note that all of this is happening under rename_lock, so the
2519 * any hash lookup seeing it in the middle of manipulations will
2520 * be discarded anyway. So we do not care what happens to the hash
2521 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002523/*
Al Viro18367502011-07-12 21:42:24 -04002524 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 * @dentry: entry to move
2526 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002527 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 *
2529 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002530 * dcache entries should not be moved in this way. Caller must hold
2531 * rename_lock, the i_mutex of the source and target directories,
2532 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002534static void __d_move(struct dentry *dentry, struct dentry *target,
2535 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 if (!dentry->d_inode)
2538 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2539
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002540 BUG_ON(d_ancestor(dentry, target));
2541 BUG_ON(d_ancestor(target, dentry));
2542
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002543 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544
Nick Piggin31e6b012011-01-07 17:49:52 +11002545 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002546 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002547
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002548 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2549
2550 /*
2551 * Move the dentry to the target hash queue. Don't bother checking
2552 * for the same hash queue because of how unlikely it is.
2553 */
2554 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002555 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
Miklos Szeredida1ce062014-04-01 17:08:43 +02002557 /*
2558 * Unhash the target (d_delete() is not usable here). If exchanging
2559 * the two dentries, then rehash onto the other's hash queue.
2560 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002562 if (exchange) {
2563 __d_rehash(target,
2564 d_hash(dentry->d_parent, dentry->d_name.hash));
2565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002568 if (exchange)
2569 swap_names(dentry, target);
2570 else
2571 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572
Al Viro63cf4272014-09-26 23:06:14 -04002573 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002575 /* splicing a tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 dentry->d_parent = target->d_parent;
2577 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002578 list_del_init(&target->d_child);
2579 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002581 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002582 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002583 list_move(&target->d_child, &target->d_parent->d_subdirs);
2584 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002585 if (exchange)
2586 fsnotify_d_move(target);
2587 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 }
2589
Nick Piggin31e6b012011-01-07 17:49:52 +11002590 write_seqcount_end(&target->d_seq);
2591 write_seqcount_end(&dentry->d_seq);
2592
Al Viro986c01942014-09-26 23:11:15 -04002593 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002594}
2595
2596/*
2597 * d_move - move a dentry
2598 * @dentry: entry to move
2599 * @target: new dentry
2600 *
2601 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002602 * dcache entries should not be moved in this way. See the locking
2603 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002604 */
2605void d_move(struct dentry *dentry, struct dentry *target)
2606{
2607 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002608 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002610}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002611EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
Miklos Szeredida1ce062014-04-01 17:08:43 +02002613/*
2614 * d_exchange - exchange two dentries
2615 * @dentry1: first dentry
2616 * @dentry2: second dentry
2617 */
2618void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2619{
2620 write_seqlock(&rename_lock);
2621
2622 WARN_ON(!dentry1->d_inode);
2623 WARN_ON(!dentry2->d_inode);
2624 WARN_ON(IS_ROOT(dentry1));
2625 WARN_ON(IS_ROOT(dentry2));
2626
2627 __d_move(dentry1, dentry2, true);
2628
2629 write_sequnlock(&rename_lock);
2630}
2631
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002632/**
2633 * d_ancestor - search for an ancestor
2634 * @p1: ancestor dentry
2635 * @p2: child dentry
2636 *
2637 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2638 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002639 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002640struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002641{
2642 struct dentry *p;
2643
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002644 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002645 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002646 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002647 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002648 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002649}
2650
2651/*
2652 * This helper attempts to cope with remotely renamed directories
2653 *
2654 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002655 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002656 *
2657 * Note: If ever the locking in lock_rename() changes, then please
2658 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002659 */
Al Virob5ae6b12014-10-12 22:16:02 -04002660static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002661 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002662{
2663 struct mutex *m1 = NULL, *m2 = NULL;
Al Virob5ae6b12014-10-12 22:16:02 -04002664 int ret = -EBUSY;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002665
2666 /* If alias and dentry share a parent, then no extra locks required */
2667 if (alias->d_parent == dentry->d_parent)
2668 goto out_unalias;
2669
Trond Myklebust9eaef272006-10-21 10:24:20 -07002670 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002671 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2672 goto out_err;
2673 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2674 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2675 goto out_err;
2676 m2 = &alias->d_parent->d_inode->i_mutex;
2677out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002678 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002679 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002680out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002681 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002682 if (m2)
2683 mutex_unlock(m2);
2684 if (m1)
2685 mutex_unlock(m1);
2686 return ret;
2687}
2688
David Howells770bfad2006-08-22 20:06:07 -04002689/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002690 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2691 * @inode: the inode which may have a disconnected dentry
2692 * @dentry: a negative dentry which we want to point to the inode.
2693 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002694 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2695 * place of the given dentry and return it, else simply d_add the inode
2696 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002697 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002698 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2699 * we should error out: directories can't have multiple aliases.
2700 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002701 * This is needed in the lookup routine of any filesystem that is exportable
2702 * (via knfsd) so that we can build dcache paths to directories effectively.
2703 *
2704 * If a dentry was found and moved, then it is returned. Otherwise NULL
2705 * is returned. This matches the expected return value of ->lookup.
2706 *
2707 * Cluster filesystems may call this function with a negative, hashed dentry.
2708 * In that case, we know that the inode will be a regular file, and also this
2709 * will only occur during atomic_open. So we need to check for the dentry
2710 * being already hashed only in the final case.
2711 */
2712struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2713{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002714 if (IS_ERR(inode))
2715 return ERR_CAST(inode);
2716
David Howells770bfad2006-08-22 20:06:07 -04002717 BUG_ON(!d_unhashed(dentry));
2718
David Howells770bfad2006-08-22 20:06:07 -04002719 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002720 __d_instantiate(dentry, NULL);
Al Virob5ae6b12014-10-12 22:16:02 -04002721 goto out;
David Howells770bfad2006-08-22 20:06:07 -04002722 }
Nick Piggin873feea2011-01-07 17:50:06 +11002723 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002724 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002725 struct dentry *new = __d_find_any_alias(inode);
2726 if (unlikely(new)) {
Al Viro18367502011-07-12 21:42:24 -04002727 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002728 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002729 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002730 spin_unlock(&inode->i_lock);
2731 dput(new);
2732 new = ERR_PTR(-ELOOP);
2733 pr_warn_ratelimited(
2734 "VFS: Lookup of '%s' in %s %s"
2735 " would have caused loop\n",
2736 dentry->d_name.name,
2737 inode->i_sb->s_type->name,
2738 inode->i_sb->s_id);
2739 } else if (!IS_ROOT(new)) {
2740 int err = __d_unalias(inode, dentry, new);
2741 write_sequnlock(&rename_lock);
2742 if (err) {
2743 dput(new);
2744 new = ERR_PTR(err);
2745 }
Al Viro18367502011-07-12 21:42:24 -04002746 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002747 __d_move(new, dentry, false);
2748 write_sequnlock(&rename_lock);
2749 spin_unlock(&inode->i_lock);
2750 security_d_instantiate(new, inode);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002751 }
Al Virob5ae6b12014-10-12 22:16:02 -04002752 iput(inode);
2753 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002754 }
David Howells770bfad2006-08-22 20:06:07 -04002755 }
Al Virob5ae6b12014-10-12 22:16:02 -04002756 /* already taking inode->i_lock, so d_add() by hand */
2757 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002758 spin_unlock(&inode->i_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002759out:
2760 security_d_instantiate(dentry, inode);
2761 d_rehash(dentry);
2762 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002763}
Al Virob5ae6b12014-10-12 22:16:02 -04002764EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002765
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002766static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002767{
2768 *buflen -= namelen;
2769 if (*buflen < 0)
2770 return -ENAMETOOLONG;
2771 *buffer -= namelen;
2772 memcpy(*buffer, str, namelen);
2773 return 0;
2774}
2775
Waiman Long232d2d62013-09-09 12:18:13 -04002776/**
2777 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002778 * @buffer: buffer pointer
2779 * @buflen: allocated length of the buffer
2780 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002781 *
2782 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2783 * make sure that either the old or the new name pointer and length are
2784 * fetched. However, there may be mismatch between length and pointer.
2785 * The length cannot be trusted, we need to copy it byte-by-byte until
2786 * the length is reached or a null byte is found. It also prepends "/" at
2787 * the beginning of the name. The sequence number check at the caller will
2788 * retry it again when a d_move() does happen. So any garbage in the buffer
2789 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04002790 *
2791 * Data dependency barrier is needed to make sure that we see that terminating
2792 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04002793 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002794static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2795{
Waiman Long232d2d62013-09-09 12:18:13 -04002796 const char *dname = ACCESS_ONCE(name->name);
2797 u32 dlen = ACCESS_ONCE(name->len);
2798 char *p;
2799
Al Viro6d13f692014-09-29 14:46:30 -04002800 smp_read_barrier_depends();
2801
Waiman Long232d2d62013-09-09 12:18:13 -04002802 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002803 if (*buflen < 0)
2804 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002805 p = *buffer -= dlen + 1;
2806 *p++ = '/';
2807 while (dlen--) {
2808 char c = *dname++;
2809 if (!c)
2810 break;
2811 *p++ = c;
2812 }
2813 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002814}
2815
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002817 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002818 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002819 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002820 * @buffer: pointer to the end of the buffer
2821 * @buflen: pointer to buffer length
2822 *
Waiman Long18129972013-09-12 10:55:35 -04002823 * The function will first try to write out the pathname without taking any
2824 * lock other than the RCU read lock to make sure that dentries won't go away.
2825 * It only checks the sequence number of the global rename_lock as any change
2826 * in the dentry's d_seq will be preceded by changes in the rename_lock
2827 * sequence number. If the sequence number had been changed, it will restart
2828 * the whole pathname back-tracing sequence again by taking the rename_lock.
2829 * In this case, there is no need to take the RCU read lock as the recursive
2830 * parent pointer references will keep the dentry chain alive as long as no
2831 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002832 */
Al Viro02125a82011-12-05 08:43:34 -05002833static int prepend_path(const struct path *path,
2834 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002835 char **buffer, int *buflen)
2836{
Al Viroede4ceb2013-11-13 07:45:40 -05002837 struct dentry *dentry;
2838 struct vfsmount *vfsmnt;
2839 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002840 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002841 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002842 char *bptr;
2843 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002844
Al Viro48f5ec22013-09-09 15:22:25 -04002845 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002846restart_mnt:
2847 read_seqbegin_or_lock(&mount_lock, &m_seq);
2848 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002849 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002850restart:
2851 bptr = *buffer;
2852 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002853 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002854 dentry = path->dentry;
2855 vfsmnt = path->mnt;
2856 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002857 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002858 while (dentry != root->dentry || vfsmnt != root->mnt) {
2859 struct dentry * parent;
2860
2861 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002862 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002863 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002864 if (mnt != parent) {
2865 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2866 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002867 vfsmnt = &mnt->mnt;
2868 continue;
2869 }
2870 /*
2871 * Filesystems needing to implement special "root names"
2872 * should do so with ->d_dname()
2873 */
2874 if (IS_ROOT(dentry) &&
2875 (dentry->d_name.len != 1 ||
2876 dentry->d_name.name[0] != '/')) {
2877 WARN(1, "Root dentry has weird name <%.*s>\n",
2878 (int) dentry->d_name.len,
2879 dentry->d_name.name);
2880 }
2881 if (!error)
2882 error = is_mounted(vfsmnt) ? 1 : 2;
2883 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002884 }
2885 parent = dentry->d_parent;
2886 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002887 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002888 if (error)
2889 break;
2890
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002891 dentry = parent;
2892 }
Al Viro48f5ec22013-09-09 15:22:25 -04002893 if (!(seq & 1))
2894 rcu_read_unlock();
2895 if (need_seqretry(&rename_lock, seq)) {
2896 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002897 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002898 }
Al Viro48f5ec22013-09-09 15:22:25 -04002899 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002900
2901 if (!(m_seq & 1))
2902 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002903 if (need_seqretry(&mount_lock, m_seq)) {
2904 m_seq = 1;
2905 goto restart_mnt;
2906 }
2907 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002908
Waiman Long232d2d62013-09-09 12:18:13 -04002909 if (error >= 0 && bptr == *buffer) {
2910 if (--blen < 0)
2911 error = -ENAMETOOLONG;
2912 else
2913 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002914 }
Waiman Long232d2d62013-09-09 12:18:13 -04002915 *buffer = bptr;
2916 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002917 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002918}
2919
2920/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002921 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002922 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002923 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002924 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925 * @buflen: buffer length
2926 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002927 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002929 * Returns a pointer into the buffer or an error code if the
2930 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002931 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002932 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002933 *
Al Viro02125a82011-12-05 08:43:34 -05002934 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 */
Al Viro02125a82011-12-05 08:43:34 -05002936char *__d_path(const struct path *path,
2937 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002938 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002940 char *res = buf + buflen;
2941 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002943 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002944 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002945
Al Viro02125a82011-12-05 08:43:34 -05002946 if (error < 0)
2947 return ERR_PTR(error);
2948 if (error > 0)
2949 return NULL;
2950 return res;
2951}
2952
2953char *d_absolute_path(const struct path *path,
2954 char *buf, int buflen)
2955{
2956 struct path root = {};
2957 char *res = buf + buflen;
2958 int error;
2959
2960 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002961 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002962
2963 if (error > 1)
2964 error = -EINVAL;
2965 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002966 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002967 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968}
2969
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002970/*
2971 * same as __d_path but appends "(deleted)" for unlinked files.
2972 */
Al Viro02125a82011-12-05 08:43:34 -05002973static int path_with_deleted(const struct path *path,
2974 const struct path *root,
2975 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002976{
2977 prepend(buf, buflen, "\0", 1);
2978 if (d_unlinked(path->dentry)) {
2979 int error = prepend(buf, buflen, " (deleted)", 10);
2980 if (error)
2981 return error;
2982 }
2983
2984 return prepend_path(path, root, buf, buflen);
2985}
2986
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002987static int prepend_unreachable(char **buffer, int *buflen)
2988{
2989 return prepend(buffer, buflen, "(unreachable)", 13);
2990}
2991
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002992static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2993{
2994 unsigned seq;
2995
2996 do {
2997 seq = read_seqcount_begin(&fs->seq);
2998 *root = fs->root;
2999 } while (read_seqcount_retry(&fs->seq, seq));
3000}
3001
Jan Bluncka03a8a702008-02-14 19:38:32 -08003002/**
3003 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003004 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003005 * @buf: buffer to return value in
3006 * @buflen: buffer length
3007 *
3008 * Convert a dentry into an ASCII path name. If the entry has been deleted
3009 * the string " (deleted)" is appended. Note that this is ambiguous.
3010 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003011 * Returns a pointer into the buffer or an error code if the path was
3012 * too long. Note: Callers should use the returned pointer, not the passed
3013 * in buffer, to use the name! The implementation often starts at an offset
3014 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003015 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003016 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003017 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003018char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003020 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003021 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003022 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003024 /*
3025 * We have various synthetic filesystems that never get mounted. On
3026 * these filesystems dentries are never used for lookup purposes, and
3027 * thus don't need to be hashed. They also don't need a name until a
3028 * user wants to identify the object in /proc/pid/fd/. The little hack
3029 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003030 *
3031 * Some pseudo inodes are mountable. When they are mounted
3032 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3033 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003034 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003035 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3036 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003037 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003038
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003039 rcu_read_lock();
3040 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003041 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003042 rcu_read_unlock();
3043
Al Viro02125a82011-12-05 08:43:34 -05003044 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003045 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046 return res;
3047}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003048EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049
3050/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003051 * Helper function for dentry_operations.d_dname() members
3052 */
3053char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3054 const char *fmt, ...)
3055{
3056 va_list args;
3057 char temp[64];
3058 int sz;
3059
3060 va_start(args, fmt);
3061 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3062 va_end(args);
3063
3064 if (sz > sizeof(temp) || sz > buflen)
3065 return ERR_PTR(-ENAMETOOLONG);
3066
3067 buffer += buflen - sz;
3068 return memcpy(buffer, temp, sz);
3069}
3070
Al Viro118b2302013-08-24 12:08:17 -04003071char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3072{
3073 char *end = buffer + buflen;
3074 /* these dentries are never renamed, so d_lock is not needed */
3075 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003076 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003077 prepend(&end, &buflen, "/", 1))
3078 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003079 return end;
Al Viro118b2302013-08-24 12:08:17 -04003080}
David Herrmann31bbe162014-01-03 14:09:47 +01003081EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003082
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003083/*
Ram Pai6092d042008-03-27 13:06:20 +01003084 * Write full pathname from the root of the filesystem into the buffer.
3085 */
Al Virof6500802014-01-26 12:37:55 -05003086static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003087{
Al Virof6500802014-01-26 12:37:55 -05003088 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003089 char *end, *retval;
3090 int len, seq = 0;
3091 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003092
Al Virof6500802014-01-26 12:37:55 -05003093 if (buflen < 2)
3094 goto Elong;
3095
Al Viro48f5ec22013-09-09 15:22:25 -04003096 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003097restart:
Al Virof6500802014-01-26 12:37:55 -05003098 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003099 end = buf + buflen;
3100 len = buflen;
3101 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003102 /* Get '/' right */
3103 retval = end-1;
3104 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003105 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003106 while (!IS_ROOT(dentry)) {
3107 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003108
Ram Pai6092d042008-03-27 13:06:20 +01003109 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003110 error = prepend_name(&end, &len, &dentry->d_name);
3111 if (error)
3112 break;
Ram Pai6092d042008-03-27 13:06:20 +01003113
3114 retval = end;
3115 dentry = parent;
3116 }
Al Viro48f5ec22013-09-09 15:22:25 -04003117 if (!(seq & 1))
3118 rcu_read_unlock();
3119 if (need_seqretry(&rename_lock, seq)) {
3120 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003121 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003122 }
3123 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003124 if (error)
3125 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003126 return retval;
3127Elong:
3128 return ERR_PTR(-ENAMETOOLONG);
3129}
Nick Pigginec2447c2011-01-07 17:49:29 +11003130
3131char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3132{
Waiman Long232d2d62013-09-09 12:18:13 -04003133 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003134}
3135EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003136
3137char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3138{
3139 char *p = NULL;
3140 char *retval;
3141
Al Viroc1031352010-06-06 22:31:14 -04003142 if (d_unlinked(dentry)) {
3143 p = buf + buflen;
3144 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3145 goto Elong;
3146 buflen++;
3147 }
3148 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003149 if (!IS_ERR(retval) && p)
3150 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003151 return retval;
3152Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003153 return ERR_PTR(-ENAMETOOLONG);
3154}
3155
Linus Torvalds8b19e342013-09-12 10:35:47 -07003156static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3157 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003158{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003159 unsigned seq;
3160
3161 do {
3162 seq = read_seqcount_begin(&fs->seq);
3163 *root = fs->root;
3164 *pwd = fs->pwd;
3165 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003166}
3167
Ram Pai6092d042008-03-27 13:06:20 +01003168/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169 * NOTE! The user-level library version returns a
3170 * character pointer. The kernel system call just
3171 * returns the length of the buffer filled (which
3172 * includes the ending '\0' character), or a negative
3173 * error value. So libc would do something like
3174 *
3175 * char *getcwd(char * buf, size_t size)
3176 * {
3177 * int retval;
3178 *
3179 * retval = sys_getcwd(buf, size);
3180 * if (retval >= 0)
3181 * return buf;
3182 * errno = -retval;
3183 * return NULL;
3184 * }
3185 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003186SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187{
Linus Torvalds552ce542007-02-13 12:08:18 -08003188 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003189 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003190 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191
3192 if (!page)
3193 return -ENOMEM;
3194
Linus Torvalds8b19e342013-09-12 10:35:47 -07003195 rcu_read_lock();
3196 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197
Linus Torvalds552ce542007-02-13 12:08:18 -08003198 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003199 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003200 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003201 char *cwd = page + PATH_MAX;
3202 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003203
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003204 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003205 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003206 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003207
Al Viro02125a82011-12-05 08:43:34 -05003208 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003209 goto out;
3210
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003211 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003212 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003213 error = prepend_unreachable(&cwd, &buflen);
3214 if (error)
3215 goto out;
3216 }
3217
Linus Torvalds552ce542007-02-13 12:08:18 -08003218 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003219 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003220 if (len <= size) {
3221 error = len;
3222 if (copy_to_user(buf, cwd, len))
3223 error = -EFAULT;
3224 }
Nick Piggin949854d2011-01-07 17:49:37 +11003225 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003226 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228
3229out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003230 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231 return error;
3232}
3233
3234/*
3235 * Test whether new_dentry is a subdirectory of old_dentry.
3236 *
3237 * Trivially implemented using the dcache structure
3238 */
3239
3240/**
3241 * is_subdir - is new dentry a subdirectory of old_dentry
3242 * @new_dentry: new dentry
3243 * @old_dentry: old dentry
3244 *
3245 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3246 * Returns 0 otherwise.
3247 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3248 */
3249
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003250int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251{
3252 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003253 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003255 if (new_dentry == old_dentry)
3256 return 1;
3257
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003258 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003260 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003261 /*
3262 * Need rcu_readlock to protect against the d_parent trashing
3263 * due to d_move
3264 */
3265 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003266 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003268 else
3269 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003270 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003272
3273 return result;
3274}
3275
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003276static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003278 struct dentry *root = data;
3279 if (dentry != root) {
3280 if (d_unhashed(dentry) || !dentry->d_inode)
3281 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003283 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3284 dentry->d_flags |= DCACHE_GENOCIDE;
3285 dentry->d_lockref.count--;
3286 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003288 return D_WALK_CONTINUE;
3289}
Nick Piggin58db63d2011-01-07 17:49:39 +11003290
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003291void d_genocide(struct dentry *parent)
3292{
3293 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294}
3295
Al Viro60545d02013-06-07 01:20:27 -04003296void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297{
Al Viro60545d02013-06-07 01:20:27 -04003298 inode_dec_link_count(inode);
3299 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003300 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003301 !d_unlinked(dentry));
3302 spin_lock(&dentry->d_parent->d_lock);
3303 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3304 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3305 (unsigned long long)inode->i_ino);
3306 spin_unlock(&dentry->d_lock);
3307 spin_unlock(&dentry->d_parent->d_lock);
3308 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003309}
Al Viro60545d02013-06-07 01:20:27 -04003310EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311
3312static __initdata unsigned long dhash_entries;
3313static int __init set_dhash_entries(char *str)
3314{
3315 if (!str)
3316 return 0;
3317 dhash_entries = simple_strtoul(str, &str, 0);
3318 return 1;
3319}
3320__setup("dhash_entries=", set_dhash_entries);
3321
3322static void __init dcache_init_early(void)
3323{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003324 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325
3326 /* If hashes are distributed across NUMA nodes, defer
3327 * hash allocation until vmalloc space is available.
3328 */
3329 if (hashdist)
3330 return;
3331
3332 dentry_hashtable =
3333 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003334 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003335 dhash_entries,
3336 13,
3337 HASH_EARLY,
3338 &d_hash_shift,
3339 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003340 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003341 0);
3342
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003343 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003344 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345}
3346
Denis Cheng74bf17c2007-10-16 23:26:30 -07003347static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003349 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003350
3351 /*
3352 * A constructor could be added for stable state like the lists,
3353 * but it is probably not worth it because of the cache nature
3354 * of the dcache.
3355 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003356 dentry_cache = KMEM_CACHE(dentry,
3357 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003358
3359 /* Hash may have been set up in dcache_init_early */
3360 if (!hashdist)
3361 return;
3362
3363 dentry_hashtable =
3364 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003365 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003366 dhash_entries,
3367 13,
3368 0,
3369 &d_hash_shift,
3370 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003371 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 0);
3373
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003374 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003375 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376}
3377
3378/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003379struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003380EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381
Linus Torvalds1da177e2005-04-16 15:20:36 -07003382EXPORT_SYMBOL(d_genocide);
3383
Linus Torvalds1da177e2005-04-16 15:20:36 -07003384void __init vfs_caches_init_early(void)
3385{
3386 dcache_init_early();
3387 inode_init_early();
3388}
3389
3390void __init vfs_caches_init(unsigned long mempages)
3391{
3392 unsigned long reserve;
3393
3394 /* Base hash sizes on available memory, with a reserve equal to
3395 150% of current kernel size */
3396
3397 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3398 mempages -= reserve;
3399
3400 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003401 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003402
Denis Cheng74bf17c2007-10-16 23:26:30 -07003403 dcache_init();
3404 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003405 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003406 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407 bdev_cache_init();
3408 chrdev_init();
3409}