blob: 435991eada1ef554a8f724a602dc951f14050c3e [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 Torvalds6326c712012-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 Torvalds6326c712012-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 Viro41edf272014-05-01 10:30:00 -0400475 struct dentry *parent = NULL;
476 bool can_free = true;
Al Viro41edf272014-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 */
511 BUG_ON((int)dentry->d_lockref.count > 0);
512 this_cpu_dec(nr_dentry);
513 if (dentry->d_op && dentry->d_op->d_release)
514 dentry->d_op->d_release(dentry);
515
Al Viro41edf272014-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 Viro41edf272014-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;
Al Viroc2338f22014-06-12 00:29:13 -0400564 if (unlikely((int)dentry->d_lockref.count < 0))
565 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 Torvalds1da177e2005-04-16 15:20:36 -0700593/*
594 * This is dput
595 *
596 * This is complicated by the fact that we do not want to put
597 * dentries that are no longer on any hash chain on the unused
598 * list: we'd much rather just get rid of them immediately.
599 *
600 * However, that implies that we have to traverse the dentry
601 * tree upwards to the parents which might _also_ now be
602 * scheduled for deletion (it may have been only waiting for
603 * its last child to go away).
604 *
605 * This tail recursion is done by hand as we don't want to depend
606 * on the compiler to always get this right (gcc generally doesn't).
607 * Real recursion would eat up our stack space.
608 */
609
610/*
611 * dput - release a dentry
612 * @dentry: dentry to release
613 *
614 * Release a dentry. This will drop the usage count and if appropriate
615 * call the dentry unlink method as well as removing it from the queues and
616 * releasing its resources. If the parent dentries were scheduled for release
617 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619void dput(struct dentry *dentry)
620{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700621 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return;
623
624repeat:
Waiman Long98474232013-08-28 18:24:59 -0700625 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700628 /* Unreachable? Get rid of it */
629 if (unlikely(d_unhashed(dentry)))
630 goto kill_it;
631
632 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100634 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 }
Nick Piggin265ac902010-10-10 05:36:24 -0400636
Linus Torvalds358eec12013-10-31 15:43:02 -0700637 if (!(dentry->d_flags & DCACHE_REFERENCED))
638 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400639 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400640
Waiman Long98474232013-08-28 18:24:59 -0700641 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100642 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 return;
644
Miklos Szeredid52b9082007-05-08 00:23:46 -0700645kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400646 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700647 if (dentry)
648 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700650EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100653/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100654static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
Waiman Long98474232013-08-28 18:24:59 -0700656 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657}
658
Nick Piggindc0474b2011-01-07 17:49:43 +1100659static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100660{
Waiman Long98474232013-08-28 18:24:59 -0700661 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100662}
663
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100664struct dentry *dget_parent(struct dentry *dentry)
665{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700666 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100667 struct dentry *ret;
668
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700669 /*
670 * Do optimistic parent lookup without any
671 * locking.
672 */
673 rcu_read_lock();
674 ret = ACCESS_ONCE(dentry->d_parent);
675 gotref = lockref_get_not_zero(&ret->d_lockref);
676 rcu_read_unlock();
677 if (likely(gotref)) {
678 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
679 return ret;
680 dput(ret);
681 }
682
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100683repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100684 /*
685 * Don't need rcu_dereference because we re-check it was correct under
686 * the lock.
687 */
688 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100689 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100690 spin_lock(&ret->d_lock);
691 if (unlikely(ret != dentry->d_parent)) {
692 spin_unlock(&ret->d_lock);
693 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100694 goto repeat;
695 }
Nick Piggina734eb42011-01-07 17:49:44 +1100696 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700697 BUG_ON(!ret->d_lockref.count);
698 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100699 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100700 return ret;
701}
702EXPORT_SYMBOL(dget_parent);
703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704/**
705 * d_find_alias - grab a hashed alias of inode
706 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 *
708 * If inode has a hashed alias, or is a directory and has any alias,
709 * acquire the reference to alias and return it. Otherwise return NULL.
710 * Notice that if inode is a directory there can be only one alias and
711 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800712 * of a filesystem, or if the directory was renamed and d_revalidate
713 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700715 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500716 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500718static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719{
Nick Pigginda502952011-01-07 17:49:33 +1100720 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Nick Pigginda502952011-01-07 17:49:33 +1100722again:
723 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400724 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100725 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700727 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100728 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500730 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100731 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100732 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return alias;
734 }
735 }
Nick Pigginda502952011-01-07 17:49:33 +1100736 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
Nick Pigginda502952011-01-07 17:49:33 +1100738 if (discon_alias) {
739 alias = discon_alias;
740 spin_lock(&alias->d_lock);
741 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500742 __dget_dlock(alias);
743 spin_unlock(&alias->d_lock);
744 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100745 }
746 spin_unlock(&alias->d_lock);
747 goto again;
748 }
749 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750}
751
Nick Pigginda502952011-01-07 17:49:33 +1100752struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
David Howells214fda12006-03-25 03:06:36 -0800754 struct dentry *de = NULL;
755
Al Virob3d9b7a2012-06-09 13:51:19 -0400756 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100757 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500758 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100759 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800760 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 return de;
762}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700763EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765/*
766 * Try to kill dentries associated with this inode.
767 * WARNING: you must own a reference to inode.
768 */
769void d_prune_aliases(struct inode *inode)
770{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700771 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100773 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400774 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700776 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400777 struct dentry *parent = lock_parent(dentry);
778 if (likely(!dentry->d_lockref.count)) {
779 __dentry_kill(dentry);
780 goto restart;
781 }
782 if (parent)
783 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 }
785 spin_unlock(&dentry->d_lock);
786 }
Nick Piggin873feea2011-01-07 17:50:06 +1100787 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700789EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400791static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792{
Al Viro5c47e6d2014-04-29 16:13:18 -0400793 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700794
Miklos Szeredi60942f22014-05-02 15:38:39 -0400795 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400796 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400797 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100798 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400799 parent = lock_parent(dentry);
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000802 * The dispose list is isolated and dentries are not accounted
803 * to the LRU here, so we can simply remove it from the list
804 * here regardless of whether it is referenced or not.
805 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400806 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000807
808 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000810 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 */
Al Viro41edf272014-05-01 10:30:00 -0400812 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700813 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400814 if (parent)
815 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 continue;
817 }
Nick Piggin77812a12011-01-07 17:49:48 +1100818
Al Viro64fd72e2014-05-28 09:48:44 -0400819
820 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
821 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
822 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400823 if (parent)
824 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400825 if (can_free)
826 dentry_free(dentry);
827 continue;
828 }
829
Al Viroff2fde92014-05-28 13:59:13 -0400830 inode = dentry->d_inode;
831 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400832 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000833 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400834 if (parent)
835 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400836 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000837 }
Al Viroff2fde92014-05-28 13:59:13 -0400838
Al Viroff2fde92014-05-28 13:59:13 -0400839 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400840
Al Viro5c47e6d2014-04-29 16:13:18 -0400841 /*
842 * We need to prune ancestors too. This is necessary to prevent
843 * quadratic behavior of shrink_dcache_parent(), but is also
844 * expected to be beneficial in reducing dentry cache
845 * fragmentation.
846 */
847 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400848 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
849 parent = lock_parent(dentry);
850 if (dentry->d_lockref.count != 1) {
851 dentry->d_lockref.count--;
852 spin_unlock(&dentry->d_lock);
853 if (parent)
854 spin_unlock(&parent->d_lock);
855 break;
856 }
857 inode = dentry->d_inode; /* can't be NULL */
858 if (unlikely(!spin_trylock(&inode->i_lock))) {
859 spin_unlock(&dentry->d_lock);
860 if (parent)
861 spin_unlock(&parent->d_lock);
862 cpu_relax();
863 continue;
864 }
865 __dentry_kill(dentry);
866 dentry = parent;
867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400869}
870
Dave Chinnerf6041562013-08-28 10:18:00 +1000871static enum lru_status
872dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
873{
874 struct list_head *freeable = arg;
875 struct dentry *dentry = container_of(item, struct dentry, d_lru);
876
877
878 /*
879 * we are inverting the lru lock/dentry->d_lock here,
880 * so use a trylock. If we fail to get the lock, just skip
881 * it
882 */
883 if (!spin_trylock(&dentry->d_lock))
884 return LRU_SKIP;
885
886 /*
887 * Referenced dentries are still in use. If they have active
888 * counts, just remove them from the LRU. Otherwise give them
889 * another pass through the LRU.
890 */
891 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400892 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000893 spin_unlock(&dentry->d_lock);
894 return LRU_REMOVED;
895 }
896
897 if (dentry->d_flags & DCACHE_REFERENCED) {
898 dentry->d_flags &= ~DCACHE_REFERENCED;
899 spin_unlock(&dentry->d_lock);
900
901 /*
902 * The list move itself will be made by the common LRU code. At
903 * this point, we've dropped the dentry->d_lock but keep the
904 * lru lock. This is safe to do, since every list movement is
905 * protected by the lru lock even if both locks are held.
906 *
907 * This is guaranteed by the fact that all LRU management
908 * functions are intermediated by the LRU API calls like
909 * list_lru_add and list_lru_del. List movement in this file
910 * only ever occur through this functions or through callbacks
911 * like this one, that are called from the LRU API.
912 *
913 * The only exceptions to this are functions like
914 * shrink_dentry_list, and code that first checks for the
915 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
916 * operating only with stack provided lists after they are
917 * properly isolated from the main list. It is thus, always a
918 * local access.
919 */
920 return LRU_ROTATE;
921 }
922
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400923 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000924 spin_unlock(&dentry->d_lock);
925
926 return LRU_REMOVED;
927}
928
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400929/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000930 * prune_dcache_sb - shrink the dcache
931 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000932 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000933 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400934 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000935 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000936 * done when we need more memory an called from the superblock shrinker
937 * function.
938 *
939 * This function may fail to free any resources if all the dentries are in
940 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400941 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000942long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
943 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400944{
Dave Chinnerf6041562013-08-28 10:18:00 +1000945 LIST_HEAD(dispose);
946 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400947
Dave Chinner9b17c622013-08-28 10:18:05 +1000948 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
949 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000950 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000951 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952}
953
Glauber Costa4e717f52013-08-28 10:18:03 +1000954static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
955 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000956{
Glauber Costa4e717f52013-08-28 10:18:03 +1000957 struct list_head *freeable = arg;
958 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000959
Glauber Costa4e717f52013-08-28 10:18:03 +1000960 /*
961 * we are inverting the lru lock/dentry->d_lock here,
962 * so use a trylock. If we fail to get the lock, just skip
963 * it
964 */
965 if (!spin_trylock(&dentry->d_lock))
966 return LRU_SKIP;
967
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400968 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000969 spin_unlock(&dentry->d_lock);
970
971 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000972}
973
Glauber Costa4e717f52013-08-28 10:18:03 +1000974
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700975/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 * shrink_dcache_sb - shrink dcache for a superblock
977 * @sb: superblock
978 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400979 * Shrink the dcache for the specified super block. This is used to free
980 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400982void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983{
Glauber Costa4e717f52013-08-28 10:18:03 +1000984 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400985
Glauber Costa4e717f52013-08-28 10:18:03 +1000986 do {
987 LIST_HEAD(dispose);
988
989 freed = list_lru_walk(&sb->s_dentry_lru,
990 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
991
992 this_cpu_sub(nr_dentry_unused, freed);
993 shrink_dentry_list(&dispose);
994 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700996EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200999 * enum d_walk_ret - action to talke during tree walk
1000 * @D_WALK_CONTINUE: contrinue walk
1001 * @D_WALK_QUIT: quit walk
1002 * @D_WALK_NORETRY: quit when retry is needed
1003 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001005enum d_walk_ret {
1006 D_WALK_CONTINUE,
1007 D_WALK_QUIT,
1008 D_WALK_NORETRY,
1009 D_WALK_SKIP,
1010};
1011
1012/**
1013 * d_walk - walk the dentry tree
1014 * @parent: start of walk
1015 * @data: data passed to @enter() and @finish()
1016 * @enter: callback when first entering the dentry
1017 * @finish: callback when successfully finished the walk
1018 *
1019 * The @enter() and @finish() callbacks are called with d_lock held.
1020 */
1021static void d_walk(struct dentry *parent, void *data,
1022 enum d_walk_ret (*enter)(void *, struct dentry *),
1023 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024{
Nick Piggin949854d2011-01-07 17:49:37 +11001025 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001027 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001028 enum d_walk_ret ret;
1029 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001030
Nick Piggin58db63d2011-01-07 17:49:39 +11001031again:
Al Viro48f5ec22013-09-09 15:22:25 -04001032 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001033 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001034 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001035
1036 ret = enter(data, this_parent);
1037 switch (ret) {
1038 case D_WALK_CONTINUE:
1039 break;
1040 case D_WALK_QUIT:
1041 case D_WALK_SKIP:
1042 goto out_unlock;
1043 case D_WALK_NORETRY:
1044 retry = false;
1045 break;
1046 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047repeat:
1048 next = this_parent->d_subdirs.next;
1049resume:
1050 while (next != &this_parent->d_subdirs) {
1051 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001052 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001054
1055 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001056
1057 ret = enter(data, dentry);
1058 switch (ret) {
1059 case D_WALK_CONTINUE:
1060 break;
1061 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001062 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001063 goto out_unlock;
1064 case D_WALK_NORETRY:
1065 retry = false;
1066 break;
1067 case D_WALK_SKIP:
1068 spin_unlock(&dentry->d_lock);
1069 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001070 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001073 spin_unlock(&this_parent->d_lock);
1074 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001076 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 goto repeat;
1078 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001079 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
1081 /*
1082 * All done at this level ... ascend and resume the search.
1083 */
Al Viroca5358e2014-10-26 19:31:10 -04001084 rcu_read_lock();
1085ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001087 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001088 this_parent = child->d_parent;
1089
Al Viro31dec132013-10-25 17:04:27 -04001090 spin_unlock(&child->d_lock);
1091 spin_lock(&this_parent->d_lock);
1092
Al Viroca5358e2014-10-26 19:31:10 -04001093 /* might go back up the wrong parent if we have had a rename. */
1094 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001095 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001096 next = child->d_child.next;
1097 while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED)) {
1098 if (next == &this_parent->d_subdirs)
1099 goto ascend;
1100 child = list_entry(next, struct dentry, d_child);
1101 next = next->next;
Al Viro31dec132013-10-25 17:04:27 -04001102 }
1103 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 goto resume;
1105 }
Al Viroca5358e2014-10-26 19:31:10 -04001106 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001107 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001108 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001109 if (finish)
1110 finish(data);
1111
1112out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001113 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001114 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001115 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001116
1117rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001118 spin_unlock(&this_parent->d_lock);
1119 rcu_read_unlock();
1120 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001121 if (!retry)
1122 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001123 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001124 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001126
1127/*
1128 * Search for at least 1 mount point in the dentry's subdirs.
1129 * We descend to the next level whenever the d_subdirs
1130 * list is non-empty and continue searching.
1131 */
1132
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001133static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1134{
1135 int *ret = data;
1136 if (d_mountpoint(dentry)) {
1137 *ret = 1;
1138 return D_WALK_QUIT;
1139 }
1140 return D_WALK_CONTINUE;
1141}
1142
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001143/**
1144 * have_submounts - check for mounts over a dentry
1145 * @parent: dentry to check.
1146 *
1147 * Return true if the parent or its subdirectories contain
1148 * a mount point
1149 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001150int have_submounts(struct dentry *parent)
1151{
1152 int ret = 0;
1153
1154 d_walk(parent, &ret, check_mount, NULL);
1155
1156 return ret;
1157}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001158EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001161 * Called by mount code to set a mountpoint and check if the mountpoint is
1162 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1163 * subtree can become unreachable).
1164 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001165 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001166 * this reason take rename_lock and d_lock on dentry and ancestors.
1167 */
1168int d_set_mounted(struct dentry *dentry)
1169{
1170 struct dentry *p;
1171 int ret = -ENOENT;
1172 write_seqlock(&rename_lock);
1173 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001174 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001175 spin_lock(&p->d_lock);
1176 if (unlikely(d_unhashed(p))) {
1177 spin_unlock(&p->d_lock);
1178 goto out;
1179 }
1180 spin_unlock(&p->d_lock);
1181 }
1182 spin_lock(&dentry->d_lock);
1183 if (!d_unlinked(dentry)) {
1184 dentry->d_flags |= DCACHE_MOUNTED;
1185 ret = 0;
1186 }
1187 spin_unlock(&dentry->d_lock);
1188out:
1189 write_sequnlock(&rename_lock);
1190 return ret;
1191}
1192
1193/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001194 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 * and move any unused dentries to the end of the unused
1196 * list for prune_dcache(). We descend to the next level
1197 * whenever the d_subdirs list is non-empty and continue
1198 * searching.
1199 *
1200 * It returns zero iff there are no unused children,
1201 * otherwise it returns the number of children moved to
1202 * the end of the unused list. This may not be the total
1203 * number of unused children, because select_parent can
1204 * drop the lock and return early due to latency
1205 * constraints.
1206 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001207
1208struct select_data {
1209 struct dentry *start;
1210 struct list_head dispose;
1211 int found;
1212};
1213
1214static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001216 struct select_data *data = _data;
1217 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001219 if (data->start == dentry)
1220 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Al Virofe915222014-05-03 00:02:25 -04001222 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001223 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001224 } else {
1225 if (dentry->d_flags & DCACHE_LRU_LIST)
1226 d_lru_del(dentry);
1227 if (!dentry->d_lockref.count) {
1228 d_shrink_add(dentry, &data->dispose);
1229 data->found++;
1230 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 }
1232 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001233 * We can return to the caller if we have found some (this
1234 * ensures forward progress). We'll be coming back to find
1235 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 */
Al Virofe915222014-05-03 00:02:25 -04001237 if (!list_empty(&data->dispose))
1238 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001240 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241}
1242
1243/**
1244 * shrink_dcache_parent - prune dcache
1245 * @parent: parent of entries to prune
1246 *
1247 * Prune the dcache to remove unused children of the parent dentry.
1248 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001249void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001251 for (;;) {
1252 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001254 INIT_LIST_HEAD(&data.dispose);
1255 data.start = parent;
1256 data.found = 0;
1257
1258 d_walk(parent, &data, select_collect, NULL);
1259 if (!data.found)
1260 break;
1261
1262 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001263 cond_resched();
1264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001266EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Al Viro9c8c10e2014-05-02 20:36:10 -04001268static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001269{
Al Viro9c8c10e2014-05-02 20:36:10 -04001270 /* it has busy descendents; complain about those instead */
1271 if (!list_empty(&dentry->d_subdirs))
1272 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001273
Al Viro9c8c10e2014-05-02 20:36:10 -04001274 /* root with refcount 1 is fine */
1275 if (dentry == _data && dentry->d_lockref.count == 1)
1276 return D_WALK_CONTINUE;
1277
1278 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1279 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001280 dentry,
1281 dentry->d_inode ?
1282 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001283 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001284 dentry->d_lockref.count,
1285 dentry->d_sb->s_type->name,
1286 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001287 WARN_ON(1);
1288 return D_WALK_CONTINUE;
1289}
1290
1291static void do_one_tree(struct dentry *dentry)
1292{
1293 shrink_dcache_parent(dentry);
1294 d_walk(dentry, dentry, umount_check, NULL);
1295 d_drop(dentry);
1296 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001297}
1298
1299/*
1300 * destroy the dentries attached to a superblock on unmounting
1301 */
1302void shrink_dcache_for_umount(struct super_block *sb)
1303{
1304 struct dentry *dentry;
1305
Al Viro9c8c10e2014-05-02 20:36:10 -04001306 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001307
1308 dentry = sb->s_root;
1309 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001310 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001311
1312 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001313 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1314 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001315 }
1316}
1317
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001318struct detach_data {
1319 struct select_data select;
1320 struct dentry *mountpoint;
1321};
1322static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001323{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001324 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001325
1326 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001327 __dget_dlock(dentry);
1328 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001329 return D_WALK_QUIT;
1330 }
1331
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001332 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001333}
1334
1335static void check_and_drop(void *_data)
1336{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001337 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001338
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001339 if (!data->mountpoint && !data->select.found)
1340 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001341}
1342
1343/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001344 * d_invalidate - detach submounts, prune dcache, and drop
1345 * @dentry: dentry to invalidate (aka detach, prune and drop)
1346 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001347 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001348 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001349 * The final d_drop is done as an atomic operation relative to
1350 * rename_lock ensuring there are no races with d_set_mounted. This
1351 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001352 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001353void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001354{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001355 /*
1356 * If it's already been dropped, return OK.
1357 */
1358 spin_lock(&dentry->d_lock);
1359 if (d_unhashed(dentry)) {
1360 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001361 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001362 }
1363 spin_unlock(&dentry->d_lock);
1364
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001365 /* Negative dentries can be dropped without further checks */
1366 if (!dentry->d_inode) {
1367 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001368 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001369 }
1370
1371 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001372 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001373
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001374 data.mountpoint = NULL;
1375 INIT_LIST_HEAD(&data.select.dispose);
1376 data.select.start = dentry;
1377 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001378
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001379 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001380
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001381 if (data.select.found)
1382 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001383
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001384 if (data.mountpoint) {
1385 detach_mounts(data.mountpoint);
1386 dput(data.mountpoint);
1387 }
1388
1389 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001390 break;
1391
1392 cond_resched();
1393 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001394}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001395EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397/**
Al Viroa4464db2011-07-07 15:03:58 -04001398 * __d_alloc - allocate a dcache entry
1399 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 * @name: qstr of the name
1401 *
1402 * Allocates a dentry. It returns %NULL if there is insufficient memory
1403 * available. On a success the dentry is returned. The name passed in is
1404 * copied and the copy passed in may be reused after this call.
1405 */
1406
Al Viroa4464db2011-07-07 15:03:58 -04001407struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408{
1409 struct dentry *dentry;
1410 char *dname;
1411
Mel Gormane12ba742007-10-16 01:25:52 -07001412 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 if (!dentry)
1414 return NULL;
1415
Linus Torvalds6326c712012-05-21 16:14:04 -07001416 /*
1417 * We guarantee that the inline name is always NUL-terminated.
1418 * This way the memcpy() done by the name switching in rename
1419 * will still always have a NUL at the end, even if we might
1420 * be overwriting an internal NUL character
1421 */
1422 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001424 size_t size = offsetof(struct external_name, name[1]);
1425 struct external_name *p = kmalloc(size + name->len, GFP_KERNEL);
1426 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 kmem_cache_free(dentry_cache, dentry);
1428 return NULL;
1429 }
Al Viro8d85b482014-09-29 14:54:27 -04001430 atomic_set(&p->u.count, 1);
1431 dname = p->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 } else {
1433 dname = dentry->d_iname;
1434 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 dentry->d_name.len = name->len;
1437 dentry->d_name.hash = name->hash;
1438 memcpy(dname, name->name, name->len);
1439 dname[name->len] = 0;
1440
Linus Torvalds6326c712012-05-21 16:14:04 -07001441 /* Make sure we always see the terminating NUL character */
1442 smp_wmb();
1443 dentry->d_name.name = dname;
1444
Waiman Long98474232013-08-28 18:24:59 -07001445 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001446 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001448 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001450 dentry->d_parent = dentry;
1451 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 dentry->d_op = NULL;
1453 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001454 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 INIT_LIST_HEAD(&dentry->d_lru);
1456 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001457 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1458 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001459 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
Nick Piggin3e880fb2011-01-07 17:49:19 +11001461 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 return dentry;
1464}
Al Viroa4464db2011-07-07 15:03:58 -04001465
1466/**
1467 * d_alloc - allocate a dcache entry
1468 * @parent: parent of entry to allocate
1469 * @name: qstr of the name
1470 *
1471 * Allocates a dentry. It returns %NULL if there is insufficient memory
1472 * available. On a success the dentry is returned. The name passed in is
1473 * copied and the copy passed in may be reused after this call.
1474 */
1475struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1476{
1477 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1478 if (!dentry)
1479 return NULL;
1480
1481 spin_lock(&parent->d_lock);
1482 /*
1483 * don't need child lock because it is not subject
1484 * to concurrency here
1485 */
1486 __dget_dlock(parent);
1487 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001488 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001489 spin_unlock(&parent->d_lock);
1490
1491 return dentry;
1492}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001493EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001495/**
1496 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1497 * @sb: the superblock
1498 * @name: qstr of the name
1499 *
1500 * For a filesystem that just pins its dentries in memory and never
1501 * performs lookups at all, return an unhashed IS_ROOT dentry.
1502 */
Nick Piggin4b936882011-01-07 17:50:07 +11001503struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1504{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001505 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001506}
1507EXPORT_SYMBOL(d_alloc_pseudo);
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1510{
1511 struct qstr q;
1512
1513 q.name = name;
1514 q.len = strlen(name);
1515 q.hash = full_name_hash(q.name, q.len);
1516 return d_alloc(parent, &q);
1517}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001518EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
Nick Pigginfb045ad2011-01-07 17:49:55 +11001520void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1521{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001522 WARN_ON_ONCE(dentry->d_op);
1523 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001524 DCACHE_OP_COMPARE |
1525 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001526 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001527 DCACHE_OP_DELETE ));
1528 dentry->d_op = op;
1529 if (!op)
1530 return;
1531 if (op->d_hash)
1532 dentry->d_flags |= DCACHE_OP_HASH;
1533 if (op->d_compare)
1534 dentry->d_flags |= DCACHE_OP_COMPARE;
1535 if (op->d_revalidate)
1536 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001537 if (op->d_weak_revalidate)
1538 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001539 if (op->d_delete)
1540 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001541 if (op->d_prune)
1542 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001543
1544}
1545EXPORT_SYMBOL(d_set_d_op);
1546
David Howellsb18825a2013-09-12 19:22:53 +01001547static unsigned d_flags_for_inode(struct inode *inode)
1548{
1549 unsigned add_flags = DCACHE_FILE_TYPE;
1550
1551 if (!inode)
1552 return DCACHE_MISS_TYPE;
1553
1554 if (S_ISDIR(inode->i_mode)) {
1555 add_flags = DCACHE_DIRECTORY_TYPE;
1556 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1557 if (unlikely(!inode->i_op->lookup))
1558 add_flags = DCACHE_AUTODIR_TYPE;
1559 else
1560 inode->i_opflags |= IOP_LOOKUP;
1561 }
1562 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1563 if (unlikely(inode->i_op->follow_link))
1564 add_flags = DCACHE_SYMLINK_TYPE;
1565 else
1566 inode->i_opflags |= IOP_NOFOLLOW;
1567 }
1568
1569 if (unlikely(IS_AUTOMOUNT(inode)))
1570 add_flags |= DCACHE_NEED_AUTOMOUNT;
1571 return add_flags;
1572}
1573
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001574static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1575{
David Howellsb18825a2013-09-12 19:22:53 +01001576 unsigned add_flags = d_flags_for_inode(inode);
1577
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001578 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001579 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001580 if (inode)
Al Viro946e51f2014-10-26 19:19:16 -04001581 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001582 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001583 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001584 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001585 fsnotify_d_instantiate(dentry, inode);
1586}
1587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588/**
1589 * d_instantiate - fill in inode information for a dentry
1590 * @entry: dentry to complete
1591 * @inode: inode to attach to this dentry
1592 *
1593 * Fill in inode information in the entry.
1594 *
1595 * This turns negative dentries into productive full members
1596 * of society.
1597 *
1598 * NOTE! This assumes that the inode count has been incremented
1599 * (or otherwise set) by the caller to indicate that it is now
1600 * in use by the dcache.
1601 */
1602
1603void d_instantiate(struct dentry *entry, struct inode * inode)
1604{
Al Viro946e51f2014-10-26 19:19:16 -04001605 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001606 if (inode)
1607 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001608 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001609 if (inode)
1610 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 security_d_instantiate(entry, inode);
1612}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001613EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
1615/**
1616 * d_instantiate_unique - instantiate a non-aliased dentry
1617 * @entry: dentry to instantiate
1618 * @inode: inode to attach to this dentry
1619 *
1620 * Fill in inode information in the entry. On success, it returns NULL.
1621 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001622 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 *
1624 * Note that in order to avoid conflicts with rename() etc, the caller
1625 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001626 *
1627 * This also assumes that the inode count has been incremented
1628 * (or otherwise set) by the caller to indicate that it is now
1629 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 */
David Howells770bfad2006-08-22 20:06:07 -04001631static struct dentry *__d_instantiate_unique(struct dentry *entry,
1632 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633{
1634 struct dentry *alias;
1635 int len = entry->d_name.len;
1636 const char *name = entry->d_name.name;
1637 unsigned int hash = entry->d_name.hash;
1638
David Howells770bfad2006-08-22 20:06:07 -04001639 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001640 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001641 return NULL;
1642 }
1643
Al Viro946e51f2014-10-26 19:19:16 -04001644 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001645 /*
1646 * Don't need alias->d_lock here, because aliases with
1647 * d_parent == entry->d_parent are not subject to name or
1648 * parent changes, because the parent inode i_mutex is held.
1649 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001650 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 continue;
1652 if (alias->d_parent != entry->d_parent)
1653 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001654 if (alias->d_name.len != len)
1655 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001656 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001658 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 return alias;
1660 }
David Howells770bfad2006-08-22 20:06:07 -04001661
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001662 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 return NULL;
1664}
David Howells770bfad2006-08-22 20:06:07 -04001665
1666struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1667{
1668 struct dentry *result;
1669
Al Viro946e51f2014-10-26 19:19:16 -04001670 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001671
Nick Piggin873feea2011-01-07 17:50:06 +11001672 if (inode)
1673 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001674 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001675 if (inode)
1676 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001677
1678 if (!result) {
1679 security_d_instantiate(entry, inode);
1680 return NULL;
1681 }
1682
1683 BUG_ON(!d_unhashed(result));
1684 iput(inode);
1685 return result;
1686}
1687
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688EXPORT_SYMBOL(d_instantiate_unique);
1689
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001690/**
1691 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1692 * @entry: dentry to complete
1693 * @inode: inode to attach to this dentry
1694 *
1695 * Fill in inode information in the entry. If a directory alias is found, then
1696 * return an error (and drop inode). Together with d_materialise_unique() this
1697 * guarantees that a directory inode may never have more than one alias.
1698 */
1699int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1700{
Al Viro946e51f2014-10-26 19:19:16 -04001701 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001702
1703 spin_lock(&inode->i_lock);
1704 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1705 spin_unlock(&inode->i_lock);
1706 iput(inode);
1707 return -EBUSY;
1708 }
1709 __d_instantiate(entry, inode);
1710 spin_unlock(&inode->i_lock);
1711 security_d_instantiate(entry, inode);
1712
1713 return 0;
1714}
1715EXPORT_SYMBOL(d_instantiate_no_diralias);
1716
Al Viroadc0e912012-01-08 16:49:21 -05001717struct dentry *d_make_root(struct inode *root_inode)
1718{
1719 struct dentry *res = NULL;
1720
1721 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001722 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001723
1724 res = __d_alloc(root_inode->i_sb, &name);
1725 if (res)
1726 d_instantiate(res, root_inode);
1727 else
1728 iput(root_inode);
1729 }
1730 return res;
1731}
1732EXPORT_SYMBOL(d_make_root);
1733
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001734static struct dentry * __d_find_any_alias(struct inode *inode)
1735{
1736 struct dentry *alias;
1737
Al Virob3d9b7a2012-06-09 13:51:19 -04001738 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001739 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001740 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001741 __dget(alias);
1742 return alias;
1743}
1744
Sage Weil46f72b32012-01-10 09:04:37 -08001745/**
1746 * d_find_any_alias - find any alias for a given inode
1747 * @inode: inode to find an alias for
1748 *
1749 * If any aliases exist for the given inode, take and return a
1750 * reference for one of them. If no aliases exist, return %NULL.
1751 */
1752struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001753{
1754 struct dentry *de;
1755
1756 spin_lock(&inode->i_lock);
1757 de = __d_find_any_alias(inode);
1758 spin_unlock(&inode->i_lock);
1759 return de;
1760}
Sage Weil46f72b32012-01-10 09:04:37 -08001761EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001762
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001763static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001764{
NeilBrownb911a6b2012-11-08 16:09:37 -08001765 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001766 struct dentry *tmp;
1767 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001768 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001769
1770 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001771 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001772 if (IS_ERR(inode))
1773 return ERR_CAST(inode);
1774
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001775 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001776 if (res)
1777 goto out_iput;
1778
Al Viroa4464db2011-07-07 15:03:58 -04001779 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001780 if (!tmp) {
1781 res = ERR_PTR(-ENOMEM);
1782 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001783 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001784
Nick Piggin873feea2011-01-07 17:50:06 +11001785 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001786 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001787 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001788 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001789 dput(tmp);
1790 goto out_iput;
1791 }
1792
1793 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001794 add_flags = d_flags_for_inode(inode);
1795
1796 if (disconnected)
1797 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001798
Christoph Hellwig9308a612008-08-11 15:49:12 +02001799 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001800 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001801 tmp->d_flags |= add_flags;
Al Viro946e51f2014-10-26 19:19:16 -04001802 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001803 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001804 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001805 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001806 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001807 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001808 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001809
Christoph Hellwig9308a612008-08-11 15:49:12 +02001810 return tmp;
1811
1812 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001813 if (res && !IS_ERR(res))
1814 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001815 iput(inode);
1816 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001817}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001818
1819/**
1820 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1821 * @inode: inode to allocate the dentry for
1822 *
1823 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1824 * similar open by handle operations. The returned dentry may be anonymous,
1825 * or may have a full name (if the inode was already in the cache).
1826 *
1827 * When called on a directory inode, we must ensure that the inode only ever
1828 * has one dentry. If a dentry is found, that is returned instead of
1829 * allocating a new one.
1830 *
1831 * On successful return, the reference to the inode has been transferred
1832 * to the dentry. In case of an error the reference on the inode is released.
1833 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1834 * be passed in and the error will be propagated to the return value,
1835 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1836 */
1837struct dentry *d_obtain_alias(struct inode *inode)
1838{
1839 return __d_obtain_alias(inode, 1);
1840}
Benny Halevyadc48722009-02-27 14:02:59 -08001841EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
1843/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001844 * d_obtain_root - find or allocate a dentry for a given inode
1845 * @inode: inode to allocate the dentry for
1846 *
1847 * Obtain an IS_ROOT dentry for the root of a filesystem.
1848 *
1849 * We must ensure that directory inodes only ever have one dentry. If a
1850 * dentry is found, that is returned instead of allocating a new one.
1851 *
1852 * On successful return, the reference to the inode has been transferred
1853 * to the dentry. In case of an error the reference on the inode is
1854 * released. A %NULL or IS_ERR inode may be passed in and will be the
1855 * error will be propagate to the return value, with a %NULL @inode
1856 * replaced by ERR_PTR(-ESTALE).
1857 */
1858struct dentry *d_obtain_root(struct inode *inode)
1859{
1860 return __d_obtain_alias(inode, 0);
1861}
1862EXPORT_SYMBOL(d_obtain_root);
1863
1864/**
Barry Naujok94035402008-05-21 16:50:46 +10001865 * d_add_ci - lookup or allocate new dentry with case-exact name
1866 * @inode: the inode case-insensitive lookup has found
1867 * @dentry: the negative dentry that was passed to the parent's lookup func
1868 * @name: the case-exact name to be associated with the returned dentry
1869 *
1870 * This is to avoid filling the dcache with case-insensitive names to the
1871 * same inode, only the actual correct case is stored in the dcache for
1872 * case-insensitive filesystems.
1873 *
1874 * For a case-insensitive lookup match and if the the case-exact dentry
1875 * already exists in in the dcache, use it and return it.
1876 *
1877 * If no entry exists with the exact case name, allocate new dentry with
1878 * the exact case, and return the spliced entry.
1879 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001880struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001881 struct qstr *name)
1882{
Barry Naujok94035402008-05-21 16:50:46 +10001883 struct dentry *found;
1884 struct dentry *new;
1885
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001886 /*
1887 * First check if a dentry matching the name already exists,
1888 * if not go ahead and create it now.
1889 */
Barry Naujok94035402008-05-21 16:50:46 +10001890 found = d_hash_and_lookup(dentry->d_parent, name);
Barry Naujok94035402008-05-21 16:50:46 +10001891 if (!found) {
1892 new = d_alloc(dentry->d_parent, name);
1893 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001894 found = ERR_PTR(-ENOMEM);
Al Viro427c77d2014-10-12 18:46:26 -04001895 } else {
1896 found = d_splice_alias(inode, new);
1897 if (found) {
1898 dput(new);
1899 return found;
1900 }
1901 return new;
Barry Naujok94035402008-05-21 16:50:46 +10001902 }
Barry Naujok94035402008-05-21 16:50:46 +10001903 }
Barry Naujok94035402008-05-21 16:50:46 +10001904 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001905 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001906}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001907EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001909/*
1910 * Do the slow-case of the dentry name compare.
1911 *
1912 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001913 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001914 * filesystem can rely on them, and can use the 'name' and
1915 * 'len' information without worrying about walking off the
1916 * end of memory etc.
1917 *
1918 * Thus the read_seqcount_retry() and the "duplicate" info
1919 * in arguments (the low-level filesystem should not look
1920 * at the dentry inode or name contents directly, since
1921 * rename can change them while we're in RCU mode).
1922 */
1923enum slow_d_compare {
1924 D_COMP_OK,
1925 D_COMP_NOMATCH,
1926 D_COMP_SEQRETRY,
1927};
1928
1929static noinline enum slow_d_compare slow_dentry_cmp(
1930 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001931 struct dentry *dentry,
1932 unsigned int seq,
1933 const struct qstr *name)
1934{
1935 int tlen = dentry->d_name.len;
1936 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001937
1938 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1939 cpu_relax();
1940 return D_COMP_SEQRETRY;
1941 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001942 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001943 return D_COMP_NOMATCH;
1944 return D_COMP_OK;
1945}
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001948 * __d_lookup_rcu - search for a dentry (racy, store-free)
1949 * @parent: parent dentry
1950 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001951 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001952 * Returns: dentry, or NULL
1953 *
1954 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1955 * resolution (store-free path walking) design described in
1956 * Documentation/filesystems/path-lookup.txt.
1957 *
1958 * This is not to be used outside core vfs.
1959 *
1960 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1961 * held, and rcu_read_lock held. The returned dentry must not be stored into
1962 * without taking d_lock and checking d_seq sequence count against @seq
1963 * returned here.
1964 *
Linus Torvalds15570082013-09-02 11:38:06 -07001965 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001966 * function.
1967 *
1968 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1969 * the returned dentry, so long as its parent's seqlock is checked after the
1970 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1971 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001972 *
1973 * NOTE! The caller *has* to check the resulting dentry against the sequence
1974 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001975 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001976struct dentry *__d_lookup_rcu(const struct dentry *parent,
1977 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001978 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001979{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001980 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001981 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001982 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001983 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11001984 struct dentry *dentry;
1985
1986 /*
1987 * Note: There is significant duplication with __d_lookup_rcu which is
1988 * required to prevent single threaded performance regressions
1989 * especially on architectures where smp_rmb (in seqcounts) are costly.
1990 * Keep the two functions in sync.
1991 */
1992
1993 /*
1994 * The hash list is protected using RCU.
1995 *
1996 * Carefully use d_seq when comparing a candidate dentry, to avoid
1997 * races with d_move().
1998 *
1999 * It is possible that concurrent renames can mess up our list
2000 * walk here and result in missing our dentry, resulting in the
2001 * false-negative result. d_lookup() protects against concurrent
2002 * renames using rename_lock seqlock.
2003 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002004 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002005 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002006 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002007 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002008
Nick Piggin31e6b012011-01-07 17:49:52 +11002009seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002010 /*
2011 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002012 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002013 *
2014 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002015 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002016 *
2017 * NOTE! We do a "raw" seqcount_begin here. That means that
2018 * we don't wait for the sequence count to stabilize if it
2019 * is in the middle of a sequence change. If we do the slow
2020 * dentry compare, we will do seqretries until it is stable,
2021 * and if we end up with a successful lookup, we actually
2022 * want to exit RCU lookup anyway.
2023 */
2024 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002025 if (dentry->d_parent != parent)
2026 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002027 if (d_unhashed(dentry))
2028 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002029
2030 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002031 if (dentry->d_name.hash != hashlen_hash(hashlen))
2032 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002033 *seqp = seq;
2034 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002035 case D_COMP_OK:
2036 return dentry;
2037 case D_COMP_NOMATCH:
2038 continue;
2039 default:
2040 goto seqretry;
2041 }
2042 }
2043
Linus Torvalds26fe5752012-05-10 13:14:12 -07002044 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002045 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002046 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002047 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002048 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002049 }
2050 return NULL;
2051}
2052
2053/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 * d_lookup - search for a dentry
2055 * @parent: parent dentry
2056 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002057 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002059 * d_lookup searches the children of the parent dentry for the name in
2060 * question. If the dentry is found its reference count is incremented and the
2061 * dentry is returned. The caller must use dput to free the entry when it has
2062 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 */
Al Viroda2d8452013-01-24 18:29:34 -05002064struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065{
Nick Piggin31e6b012011-01-07 17:49:52 +11002066 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002067 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
Daeseok Younb8314f92014-08-11 11:46:53 +09002069 do {
2070 seq = read_seqbegin(&rename_lock);
2071 dentry = __d_lookup(parent, name);
2072 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 break;
2074 } while (read_seqretry(&rename_lock, seq));
2075 return dentry;
2076}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002077EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
Nick Piggin31e6b012011-01-07 17:49:52 +11002079/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002080 * __d_lookup - search for a dentry (racy)
2081 * @parent: parent dentry
2082 * @name: qstr of name we wish to find
2083 * Returns: dentry, or NULL
2084 *
2085 * __d_lookup is like d_lookup, however it may (rarely) return a
2086 * false-negative result due to unrelated rename activity.
2087 *
2088 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2089 * however it must be used carefully, eg. with a following d_lookup in
2090 * the case of failure.
2091 *
2092 * __d_lookup callers must be commented.
2093 */
Al Viroa713ca22013-01-24 18:27:00 -05002094struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095{
2096 unsigned int len = name->len;
2097 unsigned int hash = name->hash;
2098 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002099 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002100 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002101 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002102 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
Nick Pigginb04f7842010-08-18 04:37:34 +10002104 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002105 * Note: There is significant duplication with __d_lookup_rcu which is
2106 * required to prevent single threaded performance regressions
2107 * especially on architectures where smp_rmb (in seqcounts) are costly.
2108 * Keep the two functions in sync.
2109 */
2110
2111 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002112 * The hash list is protected using RCU.
2113 *
2114 * Take d_lock when comparing a candidate dentry, to avoid races
2115 * with d_move().
2116 *
2117 * It is possible that concurrent renames can mess up our list
2118 * walk here and result in missing our dentry, resulting in the
2119 * false-negative result. d_lookup() protects against concurrent
2120 * renames using rename_lock seqlock.
2121 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002122 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002123 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 rcu_read_lock();
2125
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002126 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 if (dentry->d_name.hash != hash)
2129 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 if (dentry->d_parent != parent)
2133 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002134 if (d_unhashed(dentry))
2135 goto next;
2136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 /*
2138 * It is safe to compare names since d_move() cannot
2139 * change the qstr (protected by d_lock).
2140 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002141 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002142 int tlen = dentry->d_name.len;
2143 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002144 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 goto next;
2146 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002147 if (dentry->d_name.len != len)
2148 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002149 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 goto next;
2151 }
2152
Waiman Long98474232013-08-28 18:24:59 -07002153 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002154 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 spin_unlock(&dentry->d_lock);
2156 break;
2157next:
2158 spin_unlock(&dentry->d_lock);
2159 }
2160 rcu_read_unlock();
2161
2162 return found;
2163}
2164
2165/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002166 * d_hash_and_lookup - hash the qstr then search for a dentry
2167 * @dir: Directory to search in
2168 * @name: qstr of name we wish to find
2169 *
Al Viro4f522a22013-02-11 23:20:37 -05002170 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002171 */
2172struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2173{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002174 /*
2175 * Check for a fs-specific hash function. Note that we must
2176 * calculate the standard hash first, as the d_op->d_hash()
2177 * routine may choose to leave the hash value unchanged.
2178 */
2179 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002180 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002181 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002182 if (unlikely(err < 0))
2183 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002184 }
Al Viro4f522a22013-02-11 23:20:37 -05002185 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002186}
Al Viro4f522a22013-02-11 23:20:37 -05002187EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002188
2189/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002190 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002192 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 *
2194 * An insecure source has sent us a dentry, here we verify it and dget() it.
2195 * This is used by ncpfs in its readdir implementation.
2196 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002197 *
2198 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002200int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201{
Nick Piggin786a5e12011-01-07 17:49:16 +11002202 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002203
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002204 spin_lock(&dparent->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -04002205 list_for_each_entry(child, &dparent->d_subdirs, d_child) {
Nick Piggin786a5e12011-01-07 17:49:16 +11002206 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002207 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002208 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002209 spin_unlock(&dentry->d_lock);
2210 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 return 1;
2212 }
2213 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002214 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002215
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 return 0;
2217}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002218EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
2220/*
2221 * When a file is deleted, we have two options:
2222 * - turn this dentry into a negative dentry
2223 * - unhash this dentry and free it.
2224 *
2225 * Usually, we want to just turn this into
2226 * a negative dentry, but if anybody else is
2227 * currently using the dentry or the inode
2228 * we can't do that and we fall back on removing
2229 * it from the hash queues and waiting for
2230 * it to be deleted later when it has no users
2231 */
2232
2233/**
2234 * d_delete - delete a dentry
2235 * @dentry: The dentry to delete
2236 *
2237 * Turn the dentry into a negative dentry if possible, otherwise
2238 * remove it from the hash queues so it can be deleted later
2239 */
2240
2241void d_delete(struct dentry * dentry)
2242{
Nick Piggin873feea2011-01-07 17:50:06 +11002243 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002244 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 /*
2246 * Are we the only user?
2247 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002248again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002250 inode = dentry->d_inode;
2251 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002252 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002253 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002254 spin_unlock(&dentry->d_lock);
2255 cpu_relax();
2256 goto again;
2257 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002258 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002259 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002260 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 return;
2262 }
2263
2264 if (!d_unhashed(dentry))
2265 __d_drop(dentry);
2266
2267 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002268
2269 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002271EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002273static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002275 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002276 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002277 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002278 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002279 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280}
2281
David Howells770bfad2006-08-22 20:06:07 -04002282static void _d_rehash(struct dentry * entry)
2283{
2284 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2285}
2286
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287/**
2288 * d_rehash - add an entry back to the hash
2289 * @entry: dentry to add to the hash
2290 *
2291 * Adds a dentry to the hash according to its name.
2292 */
2293
2294void d_rehash(struct dentry * entry)
2295{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002297 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002300EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002302/**
2303 * dentry_update_name_case - update case insensitive dentry with a new name
2304 * @dentry: dentry to be updated
2305 * @name: new name
2306 *
2307 * Update a case insensitive dentry with new case of name.
2308 *
2309 * dentry must have been returned by d_lookup with name @name. Old and new
2310 * name lengths must match (ie. no d_compare which allows mismatched name
2311 * lengths).
2312 *
2313 * Parent inode i_mutex must be held over d_lookup and into this call (to
2314 * keep renames and concurrent inserts, and readdir(2) away).
2315 */
2316void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2317{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002318 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002319 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2320
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002321 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002322 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002323 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002324 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002325 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002326}
2327EXPORT_SYMBOL(dentry_update_name_case);
2328
Al Viro8d85b482014-09-29 14:54:27 -04002329static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330{
Al Viro8d85b482014-09-29 14:54:27 -04002331 if (unlikely(dname_external(target))) {
2332 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 /*
2334 * Both external: swap the pointers
2335 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002336 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 } else {
2338 /*
2339 * dentry:internal, target:external. Steal target's
2340 * storage and make target internal.
2341 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002342 memcpy(target->d_iname, dentry->d_name.name,
2343 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 dentry->d_name.name = target->d_name.name;
2345 target->d_name.name = target->d_iname;
2346 }
2347 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002348 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 /*
2350 * dentry:external, target:internal. Give dentry's
2351 * storage to target and make dentry internal
2352 */
2353 memcpy(dentry->d_iname, target->d_name.name,
2354 target->d_name.len + 1);
2355 target->d_name.name = dentry->d_name.name;
2356 dentry->d_name.name = dentry->d_iname;
2357 } else {
2358 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002359 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002361 unsigned int i;
2362 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2363 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2364 swap(((long *) &dentry->d_iname)[i],
2365 ((long *) &target->d_iname)[i]);
2366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 }
2368 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002369 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370}
2371
Al Viro8d85b482014-09-29 14:54:27 -04002372static void copy_name(struct dentry *dentry, struct dentry *target)
2373{
2374 struct external_name *old_name = NULL;
2375 if (unlikely(dname_external(dentry)))
2376 old_name = external_name(dentry);
2377 if (unlikely(dname_external(target))) {
2378 atomic_inc(&external_name(target)->u.count);
2379 dentry->d_name = target->d_name;
2380 } else {
2381 memcpy(dentry->d_iname, target->d_name.name,
2382 target->d_name.len + 1);
2383 dentry->d_name.name = dentry->d_iname;
2384 dentry->d_name.hash_len = target->d_name.hash_len;
2385 }
2386 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2387 kfree_rcu(old_name, u.head);
2388}
2389
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002390static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2391{
2392 /*
2393 * XXXX: do we really need to take target->d_lock?
2394 */
2395 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2396 spin_lock(&target->d_parent->d_lock);
2397 else {
2398 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2399 spin_lock(&dentry->d_parent->d_lock);
2400 spin_lock_nested(&target->d_parent->d_lock,
2401 DENTRY_D_LOCK_NESTED);
2402 } else {
2403 spin_lock(&target->d_parent->d_lock);
2404 spin_lock_nested(&dentry->d_parent->d_lock,
2405 DENTRY_D_LOCK_NESTED);
2406 }
2407 }
2408 if (target < dentry) {
2409 spin_lock_nested(&target->d_lock, 2);
2410 spin_lock_nested(&dentry->d_lock, 3);
2411 } else {
2412 spin_lock_nested(&dentry->d_lock, 2);
2413 spin_lock_nested(&target->d_lock, 3);
2414 }
2415}
2416
Al Viro986c0192014-09-26 23:11:15 -04002417static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002418{
2419 if (target->d_parent != dentry->d_parent)
2420 spin_unlock(&dentry->d_parent->d_lock);
2421 if (target->d_parent != target)
2422 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002423 spin_unlock(&target->d_lock);
2424 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002425}
2426
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002428 * When switching names, the actual string doesn't strictly have to
2429 * be preserved in the target - because we're dropping the target
2430 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002431 * the new name before we switch, unless we are going to rehash
2432 * it. Note that if we *do* unhash the target, we are not allowed
2433 * to rehash it without giving it a new name/hash key - whether
2434 * we swap or overwrite the names here, resulting name won't match
2435 * the reality in filesystem; it's only there for d_path() purposes.
2436 * Note that all of this is happening under rename_lock, so the
2437 * any hash lookup seeing it in the middle of manipulations will
2438 * be discarded anyway. So we do not care what happens to the hash
2439 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002441/*
Al Viro18367502011-07-12 21:42:24 -04002442 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 * @dentry: entry to move
2444 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002445 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 *
2447 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002448 * dcache entries should not be moved in this way. Caller must hold
2449 * rename_lock, the i_mutex of the source and target directories,
2450 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002452static void __d_move(struct dentry *dentry, struct dentry *target,
2453 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 if (!dentry->d_inode)
2456 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2457
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002458 BUG_ON(d_ancestor(dentry, target));
2459 BUG_ON(d_ancestor(target, dentry));
2460
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002461 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
Nick Piggin31e6b012011-01-07 17:49:52 +11002463 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002464 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002465
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002466 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2467
2468 /*
2469 * Move the dentry to the target hash queue. Don't bother checking
2470 * for the same hash queue because of how unlikely it is.
2471 */
2472 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002473 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
Miklos Szeredida1ce062014-04-01 17:08:43 +02002475 /*
2476 * Unhash the target (d_delete() is not usable here). If exchanging
2477 * the two dentries, then rehash onto the other's hash queue.
2478 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002480 if (exchange) {
2481 __d_rehash(target,
2482 d_hash(dentry->d_parent, dentry->d_name.hash));
2483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002486 if (exchange)
2487 swap_names(dentry, target);
2488 else
2489 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490
Al Viro63cf4272014-09-26 23:06:14 -04002491 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002493 /* splicing a tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 dentry->d_parent = target->d_parent;
2495 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002496 list_del_init(&target->d_child);
2497 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002499 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002500 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002501 list_move(&target->d_child, &target->d_parent->d_subdirs);
2502 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002503 if (exchange)
2504 fsnotify_d_move(target);
2505 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 }
2507
Nick Piggin31e6b012011-01-07 17:49:52 +11002508 write_seqcount_end(&target->d_seq);
2509 write_seqcount_end(&dentry->d_seq);
2510
Al Viro986c0192014-09-26 23:11:15 -04002511 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002512}
2513
2514/*
2515 * d_move - move a dentry
2516 * @dentry: entry to move
2517 * @target: new dentry
2518 *
2519 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002520 * dcache entries should not be moved in this way. See the locking
2521 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002522 */
2523void d_move(struct dentry *dentry, struct dentry *target)
2524{
2525 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002526 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002528}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002529EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530
Miklos Szeredida1ce062014-04-01 17:08:43 +02002531/*
2532 * d_exchange - exchange two dentries
2533 * @dentry1: first dentry
2534 * @dentry2: second dentry
2535 */
2536void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2537{
2538 write_seqlock(&rename_lock);
2539
2540 WARN_ON(!dentry1->d_inode);
2541 WARN_ON(!dentry2->d_inode);
2542 WARN_ON(IS_ROOT(dentry1));
2543 WARN_ON(IS_ROOT(dentry2));
2544
2545 __d_move(dentry1, dentry2, true);
2546
2547 write_sequnlock(&rename_lock);
2548}
2549
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002550/**
2551 * d_ancestor - search for an ancestor
2552 * @p1: ancestor dentry
2553 * @p2: child dentry
2554 *
2555 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2556 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002557 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002558struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002559{
2560 struct dentry *p;
2561
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002562 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002563 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002564 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002565 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002566 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002567}
2568
2569/*
2570 * This helper attempts to cope with remotely renamed directories
2571 *
2572 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002573 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574 *
2575 * Note: If ever the locking in lock_rename() changes, then please
2576 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577 */
Al Virob5ae6b12014-10-12 22:16:02 -04002578static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002579 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002580{
2581 struct mutex *m1 = NULL, *m2 = NULL;
Al Virob5ae6b12014-10-12 22:16:02 -04002582 int ret = -EBUSY;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002583
2584 /* If alias and dentry share a parent, then no extra locks required */
2585 if (alias->d_parent == dentry->d_parent)
2586 goto out_unalias;
2587
Trond Myklebust9eaef272006-10-21 10:24:20 -07002588 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002589 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2590 goto out_err;
2591 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2592 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2593 goto out_err;
2594 m2 = &alias->d_parent->d_inode->i_mutex;
2595out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002596 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002597 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002598out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002599 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002600 if (m2)
2601 mutex_unlock(m2);
2602 if (m1)
2603 mutex_unlock(m1);
2604 return ret;
2605}
2606
David Howells770bfad2006-08-22 20:06:07 -04002607/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002608 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2609 * @inode: the inode which may have a disconnected dentry
2610 * @dentry: a negative dentry which we want to point to the inode.
2611 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002612 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2613 * place of the given dentry and return it, else simply d_add the inode
2614 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002615 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002616 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2617 * we should error out: directories can't have multiple aliases.
2618 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002619 * This is needed in the lookup routine of any filesystem that is exportable
2620 * (via knfsd) so that we can build dcache paths to directories effectively.
2621 *
2622 * If a dentry was found and moved, then it is returned. Otherwise NULL
2623 * is returned. This matches the expected return value of ->lookup.
2624 *
2625 * Cluster filesystems may call this function with a negative, hashed dentry.
2626 * In that case, we know that the inode will be a regular file, and also this
2627 * will only occur during atomic_open. So we need to check for the dentry
2628 * being already hashed only in the final case.
2629 */
2630struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2631{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002632 if (IS_ERR(inode))
2633 return ERR_CAST(inode);
2634
David Howells770bfad2006-08-22 20:06:07 -04002635 BUG_ON(!d_unhashed(dentry));
2636
David Howells770bfad2006-08-22 20:06:07 -04002637 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002638 __d_instantiate(dentry, NULL);
Al Virob5ae6b12014-10-12 22:16:02 -04002639 goto out;
David Howells770bfad2006-08-22 20:06:07 -04002640 }
Nick Piggin873feea2011-01-07 17:50:06 +11002641 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002642 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002643 struct dentry *new = __d_find_any_alias(inode);
2644 if (unlikely(new)) {
Al Viro18367502011-07-12 21:42:24 -04002645 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002646 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002647 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002648 spin_unlock(&inode->i_lock);
2649 dput(new);
2650 new = ERR_PTR(-ELOOP);
2651 pr_warn_ratelimited(
2652 "VFS: Lookup of '%s' in %s %s"
2653 " would have caused loop\n",
2654 dentry->d_name.name,
2655 inode->i_sb->s_type->name,
2656 inode->i_sb->s_id);
2657 } else if (!IS_ROOT(new)) {
2658 int err = __d_unalias(inode, dentry, new);
2659 write_sequnlock(&rename_lock);
2660 if (err) {
2661 dput(new);
2662 new = ERR_PTR(err);
2663 }
Al Viro18367502011-07-12 21:42:24 -04002664 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002665 __d_move(new, dentry, false);
2666 write_sequnlock(&rename_lock);
2667 spin_unlock(&inode->i_lock);
2668 security_d_instantiate(new, inode);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002669 }
Al Virob5ae6b12014-10-12 22:16:02 -04002670 iput(inode);
2671 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002672 }
David Howells770bfad2006-08-22 20:06:07 -04002673 }
Al Virob5ae6b12014-10-12 22:16:02 -04002674 /* already taking inode->i_lock, so d_add() by hand */
2675 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002676 spin_unlock(&inode->i_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002677out:
2678 security_d_instantiate(dentry, inode);
2679 d_rehash(dentry);
2680 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002681}
Al Virob5ae6b12014-10-12 22:16:02 -04002682EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002683
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002684static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002685{
2686 *buflen -= namelen;
2687 if (*buflen < 0)
2688 return -ENAMETOOLONG;
2689 *buffer -= namelen;
2690 memcpy(*buffer, str, namelen);
2691 return 0;
2692}
2693
Waiman Long232d2d62013-09-09 12:18:13 -04002694/**
2695 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002696 * @buffer: buffer pointer
2697 * @buflen: allocated length of the buffer
2698 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002699 *
2700 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2701 * make sure that either the old or the new name pointer and length are
2702 * fetched. However, there may be mismatch between length and pointer.
2703 * The length cannot be trusted, we need to copy it byte-by-byte until
2704 * the length is reached or a null byte is found. It also prepends "/" at
2705 * the beginning of the name. The sequence number check at the caller will
2706 * retry it again when a d_move() does happen. So any garbage in the buffer
2707 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04002708 *
2709 * Data dependency barrier is needed to make sure that we see that terminating
2710 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04002711 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002712static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2713{
Waiman Long232d2d62013-09-09 12:18:13 -04002714 const char *dname = ACCESS_ONCE(name->name);
2715 u32 dlen = ACCESS_ONCE(name->len);
2716 char *p;
2717
Al Viro6d13f692014-09-29 14:46:30 -04002718 smp_read_barrier_depends();
2719
Waiman Long232d2d62013-09-09 12:18:13 -04002720 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002721 if (*buflen < 0)
2722 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002723 p = *buffer -= dlen + 1;
2724 *p++ = '/';
2725 while (dlen--) {
2726 char c = *dname++;
2727 if (!c)
2728 break;
2729 *p++ = c;
2730 }
2731 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002732}
2733
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002735 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002736 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002737 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002738 * @buffer: pointer to the end of the buffer
2739 * @buflen: pointer to buffer length
2740 *
Waiman Long18129972013-09-12 10:55:35 -04002741 * The function will first try to write out the pathname without taking any
2742 * lock other than the RCU read lock to make sure that dentries won't go away.
2743 * It only checks the sequence number of the global rename_lock as any change
2744 * in the dentry's d_seq will be preceded by changes in the rename_lock
2745 * sequence number. If the sequence number had been changed, it will restart
2746 * the whole pathname back-tracing sequence again by taking the rename_lock.
2747 * In this case, there is no need to take the RCU read lock as the recursive
2748 * parent pointer references will keep the dentry chain alive as long as no
2749 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002750 */
Al Viro02125a82011-12-05 08:43:34 -05002751static int prepend_path(const struct path *path,
2752 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002753 char **buffer, int *buflen)
2754{
Al Viroede4ceb2013-11-13 07:45:40 -05002755 struct dentry *dentry;
2756 struct vfsmount *vfsmnt;
2757 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002758 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002759 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002760 char *bptr;
2761 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002762
Al Viro48f5ec22013-09-09 15:22:25 -04002763 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002764restart_mnt:
2765 read_seqbegin_or_lock(&mount_lock, &m_seq);
2766 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002767 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002768restart:
2769 bptr = *buffer;
2770 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002771 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002772 dentry = path->dentry;
2773 vfsmnt = path->mnt;
2774 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002775 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002776 while (dentry != root->dentry || vfsmnt != root->mnt) {
2777 struct dentry * parent;
2778
2779 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002780 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002781 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002782 if (mnt != parent) {
2783 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2784 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002785 vfsmnt = &mnt->mnt;
2786 continue;
2787 }
2788 /*
2789 * Filesystems needing to implement special "root names"
2790 * should do so with ->d_dname()
2791 */
2792 if (IS_ROOT(dentry) &&
2793 (dentry->d_name.len != 1 ||
2794 dentry->d_name.name[0] != '/')) {
2795 WARN(1, "Root dentry has weird name <%.*s>\n",
2796 (int) dentry->d_name.len,
2797 dentry->d_name.name);
2798 }
2799 if (!error)
2800 error = is_mounted(vfsmnt) ? 1 : 2;
2801 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002802 }
2803 parent = dentry->d_parent;
2804 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002805 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002806 if (error)
2807 break;
2808
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002809 dentry = parent;
2810 }
Al Viro48f5ec22013-09-09 15:22:25 -04002811 if (!(seq & 1))
2812 rcu_read_unlock();
2813 if (need_seqretry(&rename_lock, seq)) {
2814 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002815 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002816 }
Al Viro48f5ec22013-09-09 15:22:25 -04002817 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002818
2819 if (!(m_seq & 1))
2820 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002821 if (need_seqretry(&mount_lock, m_seq)) {
2822 m_seq = 1;
2823 goto restart_mnt;
2824 }
2825 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002826
Waiman Long232d2d62013-09-09 12:18:13 -04002827 if (error >= 0 && bptr == *buffer) {
2828 if (--blen < 0)
2829 error = -ENAMETOOLONG;
2830 else
2831 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002832 }
Waiman Long232d2d62013-09-09 12:18:13 -04002833 *buffer = bptr;
2834 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002835 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002836}
2837
2838/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002839 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002840 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002841 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002842 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 * @buflen: buffer length
2844 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002845 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002847 * Returns a pointer into the buffer or an error code if the
2848 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002849 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002850 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002851 *
Al Viro02125a82011-12-05 08:43:34 -05002852 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 */
Al Viro02125a82011-12-05 08:43:34 -05002854char *__d_path(const struct path *path,
2855 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002856 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002858 char *res = buf + buflen;
2859 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002861 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002862 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002863
Al Viro02125a82011-12-05 08:43:34 -05002864 if (error < 0)
2865 return ERR_PTR(error);
2866 if (error > 0)
2867 return NULL;
2868 return res;
2869}
2870
2871char *d_absolute_path(const struct path *path,
2872 char *buf, int buflen)
2873{
2874 struct path root = {};
2875 char *res = buf + buflen;
2876 int error;
2877
2878 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002879 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002880
2881 if (error > 1)
2882 error = -EINVAL;
2883 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002884 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002885 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886}
2887
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002888/*
2889 * same as __d_path but appends "(deleted)" for unlinked files.
2890 */
Al Viro02125a82011-12-05 08:43:34 -05002891static int path_with_deleted(const struct path *path,
2892 const struct path *root,
2893 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002894{
2895 prepend(buf, buflen, "\0", 1);
2896 if (d_unlinked(path->dentry)) {
2897 int error = prepend(buf, buflen, " (deleted)", 10);
2898 if (error)
2899 return error;
2900 }
2901
2902 return prepend_path(path, root, buf, buflen);
2903}
2904
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002905static int prepend_unreachable(char **buffer, int *buflen)
2906{
2907 return prepend(buffer, buflen, "(unreachable)", 13);
2908}
2909
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002910static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2911{
2912 unsigned seq;
2913
2914 do {
2915 seq = read_seqcount_begin(&fs->seq);
2916 *root = fs->root;
2917 } while (read_seqcount_retry(&fs->seq, seq));
2918}
2919
Jan Bluncka03a8a702008-02-14 19:38:32 -08002920/**
2921 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002922 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002923 * @buf: buffer to return value in
2924 * @buflen: buffer length
2925 *
2926 * Convert a dentry into an ASCII path name. If the entry has been deleted
2927 * the string " (deleted)" is appended. Note that this is ambiguous.
2928 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002929 * Returns a pointer into the buffer or an error code if the path was
2930 * too long. Note: Callers should use the returned pointer, not the passed
2931 * in buffer, to use the name! The implementation often starts at an offset
2932 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002933 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002934 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002935 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002936char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002938 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002939 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002940 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002942 /*
2943 * We have various synthetic filesystems that never get mounted. On
2944 * these filesystems dentries are never used for lookup purposes, and
2945 * thus don't need to be hashed. They also don't need a name until a
2946 * user wants to identify the object in /proc/pid/fd/. The little hack
2947 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002948 *
2949 * Some pseudo inodes are mountable. When they are mounted
2950 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2951 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002952 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002953 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
2954 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08002955 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002956
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002957 rcu_read_lock();
2958 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05002959 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002960 rcu_read_unlock();
2961
Al Viro02125a82011-12-05 08:43:34 -05002962 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002963 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 return res;
2965}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002966EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967
2968/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002969 * Helper function for dentry_operations.d_dname() members
2970 */
2971char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2972 const char *fmt, ...)
2973{
2974 va_list args;
2975 char temp[64];
2976 int sz;
2977
2978 va_start(args, fmt);
2979 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2980 va_end(args);
2981
2982 if (sz > sizeof(temp) || sz > buflen)
2983 return ERR_PTR(-ENAMETOOLONG);
2984
2985 buffer += buflen - sz;
2986 return memcpy(buffer, temp, sz);
2987}
2988
Al Viro118b2302013-08-24 12:08:17 -04002989char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
2990{
2991 char *end = buffer + buflen;
2992 /* these dentries are never renamed, so d_lock is not needed */
2993 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04002994 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04002995 prepend(&end, &buflen, "/", 1))
2996 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04002997 return end;
Al Viro118b2302013-08-24 12:08:17 -04002998}
David Herrmann31bbe162014-01-03 14:09:47 +01002999EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003000
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003001/*
Ram Pai6092d042008-03-27 13:06:20 +01003002 * Write full pathname from the root of the filesystem into the buffer.
3003 */
Al Virof6500802014-01-26 12:37:55 -05003004static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003005{
Al Virof6500802014-01-26 12:37:55 -05003006 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003007 char *end, *retval;
3008 int len, seq = 0;
3009 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003010
Al Virof6500802014-01-26 12:37:55 -05003011 if (buflen < 2)
3012 goto Elong;
3013
Al Viro48f5ec22013-09-09 15:22:25 -04003014 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003015restart:
Al Virof6500802014-01-26 12:37:55 -05003016 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003017 end = buf + buflen;
3018 len = buflen;
3019 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003020 /* Get '/' right */
3021 retval = end-1;
3022 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003023 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003024 while (!IS_ROOT(dentry)) {
3025 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003026
Ram Pai6092d042008-03-27 13:06:20 +01003027 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003028 error = prepend_name(&end, &len, &dentry->d_name);
3029 if (error)
3030 break;
Ram Pai6092d042008-03-27 13:06:20 +01003031
3032 retval = end;
3033 dentry = parent;
3034 }
Al Viro48f5ec22013-09-09 15:22:25 -04003035 if (!(seq & 1))
3036 rcu_read_unlock();
3037 if (need_seqretry(&rename_lock, seq)) {
3038 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003039 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003040 }
3041 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003042 if (error)
3043 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003044 return retval;
3045Elong:
3046 return ERR_PTR(-ENAMETOOLONG);
3047}
Nick Pigginec2447c2011-01-07 17:49:29 +11003048
3049char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3050{
Waiman Long232d2d62013-09-09 12:18:13 -04003051 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003052}
3053EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003054
3055char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3056{
3057 char *p = NULL;
3058 char *retval;
3059
Al Viroc1031352010-06-06 22:31:14 -04003060 if (d_unlinked(dentry)) {
3061 p = buf + buflen;
3062 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3063 goto Elong;
3064 buflen++;
3065 }
3066 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003067 if (!IS_ERR(retval) && p)
3068 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003069 return retval;
3070Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003071 return ERR_PTR(-ENAMETOOLONG);
3072}
3073
Linus Torvalds8b19e342013-09-12 10:35:47 -07003074static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3075 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003076{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003077 unsigned seq;
3078
3079 do {
3080 seq = read_seqcount_begin(&fs->seq);
3081 *root = fs->root;
3082 *pwd = fs->pwd;
3083 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003084}
3085
Ram Pai6092d042008-03-27 13:06:20 +01003086/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087 * NOTE! The user-level library version returns a
3088 * character pointer. The kernel system call just
3089 * returns the length of the buffer filled (which
3090 * includes the ending '\0' character), or a negative
3091 * error value. So libc would do something like
3092 *
3093 * char *getcwd(char * buf, size_t size)
3094 * {
3095 * int retval;
3096 *
3097 * retval = sys_getcwd(buf, size);
3098 * if (retval >= 0)
3099 * return buf;
3100 * errno = -retval;
3101 * return NULL;
3102 * }
3103 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003104SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105{
Linus Torvalds552ce542007-02-13 12:08:18 -08003106 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003107 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003108 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109
3110 if (!page)
3111 return -ENOMEM;
3112
Linus Torvalds8b19e342013-09-12 10:35:47 -07003113 rcu_read_lock();
3114 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003115
Linus Torvalds552ce542007-02-13 12:08:18 -08003116 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003117 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003118 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003119 char *cwd = page + PATH_MAX;
3120 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003122 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003123 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003124 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003125
Al Viro02125a82011-12-05 08:43:34 -05003126 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003127 goto out;
3128
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003129 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003130 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003131 error = prepend_unreachable(&cwd, &buflen);
3132 if (error)
3133 goto out;
3134 }
3135
Linus Torvalds552ce542007-02-13 12:08:18 -08003136 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003137 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003138 if (len <= size) {
3139 error = len;
3140 if (copy_to_user(buf, cwd, len))
3141 error = -EFAULT;
3142 }
Nick Piggin949854d2011-01-07 17:49:37 +11003143 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003144 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003145 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146
3147out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003148 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149 return error;
3150}
3151
3152/*
3153 * Test whether new_dentry is a subdirectory of old_dentry.
3154 *
3155 * Trivially implemented using the dcache structure
3156 */
3157
3158/**
3159 * is_subdir - is new dentry a subdirectory of old_dentry
3160 * @new_dentry: new dentry
3161 * @old_dentry: old dentry
3162 *
3163 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3164 * Returns 0 otherwise.
3165 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3166 */
3167
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003168int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169{
3170 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003171 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003173 if (new_dentry == old_dentry)
3174 return 1;
3175
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003176 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003177 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003179 /*
3180 * Need rcu_readlock to protect against the d_parent trashing
3181 * due to d_move
3182 */
3183 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003184 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003186 else
3187 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003188 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190
3191 return result;
3192}
3193
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003194static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003196 struct dentry *root = data;
3197 if (dentry != root) {
3198 if (d_unhashed(dentry) || !dentry->d_inode)
3199 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003201 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3202 dentry->d_flags |= DCACHE_GENOCIDE;
3203 dentry->d_lockref.count--;
3204 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003206 return D_WALK_CONTINUE;
3207}
Nick Piggin58db63d2011-01-07 17:49:39 +11003208
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003209void d_genocide(struct dentry *parent)
3210{
3211 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212}
3213
Al Viro60545d02013-06-07 01:20:27 -04003214void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215{
Al Viro60545d02013-06-07 01:20:27 -04003216 inode_dec_link_count(inode);
3217 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003218 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003219 !d_unlinked(dentry));
3220 spin_lock(&dentry->d_parent->d_lock);
3221 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3222 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3223 (unsigned long long)inode->i_ino);
3224 spin_unlock(&dentry->d_lock);
3225 spin_unlock(&dentry->d_parent->d_lock);
3226 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003227}
Al Viro60545d02013-06-07 01:20:27 -04003228EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
3230static __initdata unsigned long dhash_entries;
3231static int __init set_dhash_entries(char *str)
3232{
3233 if (!str)
3234 return 0;
3235 dhash_entries = simple_strtoul(str, &str, 0);
3236 return 1;
3237}
3238__setup("dhash_entries=", set_dhash_entries);
3239
3240static void __init dcache_init_early(void)
3241{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003242 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243
3244 /* If hashes are distributed across NUMA nodes, defer
3245 * hash allocation until vmalloc space is available.
3246 */
3247 if (hashdist)
3248 return;
3249
3250 dentry_hashtable =
3251 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003252 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253 dhash_entries,
3254 13,
3255 HASH_EARLY,
3256 &d_hash_shift,
3257 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003258 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 0);
3260
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003261 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003262 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263}
3264
Denis Cheng74bf17c2007-10-16 23:26:30 -07003265static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003267 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268
3269 /*
3270 * A constructor could be added for stable state like the lists,
3271 * but it is probably not worth it because of the cache nature
3272 * of the dcache.
3273 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003274 dentry_cache = KMEM_CACHE(dentry,
3275 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276
3277 /* Hash may have been set up in dcache_init_early */
3278 if (!hashdist)
3279 return;
3280
3281 dentry_hashtable =
3282 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003283 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284 dhash_entries,
3285 13,
3286 0,
3287 &d_hash_shift,
3288 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003289 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290 0);
3291
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003292 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003293 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294}
3295
3296/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003297struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003298EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300EXPORT_SYMBOL(d_genocide);
3301
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302void __init vfs_caches_init_early(void)
3303{
3304 dcache_init_early();
3305 inode_init_early();
3306}
3307
3308void __init vfs_caches_init(unsigned long mempages)
3309{
3310 unsigned long reserve;
3311
3312 /* Base hash sizes on available memory, with a reserve equal to
3313 150% of current kernel size */
3314
3315 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3316 mempages -= reserve;
3317
3318 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003319 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320
Denis Cheng74bf17c2007-10-16 23:26:30 -07003321 dcache_init();
3322 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003324 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325 bdev_cache_init();
3326 chrdev_init();
3327}