blob: 509b49410943ef3e19dda508ffc78e05a60a114e [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>
David Howells07f3f052006-09-30 20:52:18 +020040#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050041#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Nick Piggin789680d2011-01-07 17:49:30 +110043/*
44 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110045 * dcache->d_inode->i_lock protects:
46 * - i_dentry, d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110047 * dcache_hash_bucket lock protects:
48 * - the dcache hash table
49 * s_anon bl list spinlock protects:
50 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100051 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110052 * - the dcache lru lists and counters
53 * d_lock protects:
54 * - d_flags
55 * - d_name
56 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110057 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110058 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110059 * - d_parent and d_subdirs
60 * - childrens' d_child and d_parent
Nick Pigginb23fb0a2011-01-07 17:49:35 +110061 * - d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110062 *
63 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110064 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110065 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100066 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110067 * dcache_hash_bucket lock
68 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110069 *
Nick Pigginda502952011-01-07 17:49:33 +110070 * If there is an ancestor relationship:
71 * dentry->d_parent->...->d_parent->d_lock
72 * ...
73 * dentry->d_parent->d_lock
74 * dentry->d_lock
75 *
76 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110077 * if (dentry1 < dentry2)
78 * dentry1->d_lock
79 * dentry2->d_lock
80 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080081int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
83
Al Viro74c3cbe2007-07-22 08:04:18 -040084__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Nick Piggin949854d2011-01-07 17:49:37 +110086EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Christoph Lametere18b8902006-12-06 20:33:20 -080088static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Waiman Long232d2d62013-09-09 12:18:13 -040090/**
91 * read_seqbegin_or_lock - begin a sequence number check or locking block
92 * lock: sequence lock
93 * seq : sequence number to be checked
94 *
95 * First try it once optimistically without taking the lock. If that fails,
96 * take the lock. The sequence number is also used as a marker for deciding
97 * whether to be a reader (even) or writer (odd).
98 * N.B. seq must be initialized to an even number to begin with.
99 */
100static inline void read_seqbegin_or_lock(seqlock_t *lock, int *seq)
101{
Al Viro48f5ec22013-09-09 15:22:25 -0400102 if (!(*seq & 1)) /* Even */
Waiman Long232d2d62013-09-09 12:18:13 -0400103 *seq = read_seqbegin(lock);
Al Viro48f5ec22013-09-09 15:22:25 -0400104 else /* Odd */
Waiman Long232d2d62013-09-09 12:18:13 -0400105 write_seqlock(lock);
106}
107
Al Viro48f5ec22013-09-09 15:22:25 -0400108static inline int need_seqretry(seqlock_t *lock, int seq)
Waiman Long232d2d62013-09-09 12:18:13 -0400109{
Al Viro48f5ec22013-09-09 15:22:25 -0400110 return !(seq & 1) && read_seqretry(lock, seq);
111}
112
113static inline void done_seqretry(seqlock_t *lock, int seq)
114{
115 if (seq & 1)
Waiman Long232d2d62013-09-09 12:18:13 -0400116 write_sequnlock(lock);
Waiman Long232d2d62013-09-09 12:18:13 -0400117}
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119/*
120 * This is the single most critical data structure when it comes
121 * to the dcache: the hashtable for lookups. Somebody should try
122 * to make this good - I've just made it work.
123 *
124 * This hash-function tries to avoid losing too many bits of hash
125 * information, yet avoid using a prime hash-size or similar.
126 */
127#define D_HASHBITS d_hash_shift
128#define D_HASHMASK d_hash_mask
129
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800130static unsigned int d_hash_mask __read_mostly;
131static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100132
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700133static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100134
Linus Torvalds8966be92012-03-02 14:23:30 -0800135static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700136 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100137{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700138 hash += (unsigned long) parent / L1_CACHE_BYTES;
139 hash = hash + (hash >> D_HASHBITS);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100140 return dentry_hashtable + (hash & D_HASHMASK);
141}
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/* Statistics gathering. */
144struct dentry_stat_t dentry_stat = {
145 .age_limit = 45,
146};
147
Glauber Costa3942c072013-08-28 10:17:53 +1000148static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000149static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400150
151#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000152
153/*
154 * Here we resort to our own counters instead of using generic per-cpu counters
155 * for consistency with what the vfs inode code does. We are expected to harvest
156 * better code and performance by having our own specialized counters.
157 *
158 * Please note that the loop is done over all possible CPUs, not over all online
159 * CPUs. The reason for this is that we don't want to play games with CPUs going
160 * on and off. If one of them goes off, we will just keep their counters.
161 *
162 * glommer: See cffbc8a for details, and if you ever intend to change this,
163 * please update all vfs counters to match.
164 */
Glauber Costa3942c072013-08-28 10:17:53 +1000165static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166{
167 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000168 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100169 for_each_possible_cpu(i)
170 sum += per_cpu(nr_dentry, i);
171 return sum < 0 ? 0 : sum;
172}
173
Dave Chinner62d36c72013-08-28 10:17:54 +1000174static long get_nr_dentry_unused(void)
175{
176 int i;
177 long sum = 0;
178 for_each_possible_cpu(i)
179 sum += per_cpu(nr_dentry_unused, i);
180 return sum < 0 ? 0 : sum;
181}
182
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400183int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
184 size_t *lenp, loff_t *ppos)
185{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100186 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000187 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000188 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400189}
190#endif
191
Linus Torvalds5483f182012-03-04 15:51:42 -0800192/*
193 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
194 * The strings are both count bytes long, and count is non-zero.
195 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700196#ifdef CONFIG_DCACHE_WORD_ACCESS
197
198#include <asm/word-at-a-time.h>
199/*
200 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
201 * aligned allocation for this particular component. We don't
202 * strictly need the load_unaligned_zeropad() safety, but it
203 * doesn't hurt either.
204 *
205 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
206 * need the careful unaligned handling.
207 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700208static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800209{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800210 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800211
212 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700213 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700214 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800215 if (tcount < sizeof(unsigned long))
216 break;
217 if (unlikely(a != b))
218 return 1;
219 cs += sizeof(unsigned long);
220 ct += sizeof(unsigned long);
221 tcount -= sizeof(unsigned long);
222 if (!tcount)
223 return 0;
224 }
225 mask = ~(~0ul << tcount*8);
226 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700227}
228
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800229#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700230
Linus Torvalds94753db52012-05-10 12:19:19 -0700231static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700232{
Linus Torvalds5483f182012-03-04 15:51:42 -0800233 do {
234 if (*cs != *ct)
235 return 1;
236 cs++;
237 ct++;
238 tcount--;
239 } while (tcount);
240 return 0;
241}
242
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700243#endif
244
Linus Torvalds94753db52012-05-10 12:19:19 -0700245static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
246{
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700247 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700248 /*
249 * Be careful about RCU walk racing with rename:
250 * use ACCESS_ONCE to fetch the name pointer.
251 *
252 * NOTE! Even if a rename will mean that the length
253 * was not loaded atomically, we don't care. The
254 * RCU walk will check the sequence count eventually,
255 * and catch it. And we won't overrun the buffer,
256 * because we're reading the name pointer atomically,
257 * and a dentry name is guaranteed to be properly
258 * terminated with a NUL byte.
259 *
260 * End result: even if 'len' is wrong, we'll exit
261 * early because the data cannot match (there can
262 * be no NUL in the ct/tcount data)
263 */
Linus Torvalds6326c71f2012-05-21 16:14:04 -0700264 cs = ACCESS_ONCE(dentry->d_name.name);
265 smp_read_barrier_depends();
266 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700267}
268
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400269static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400271 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
272
Al Virob3d9b7a2012-06-09 13:51:19 -0400273 WARN_ON(!hlist_unhashed(&dentry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 if (dname_external(dentry))
275 kfree(dentry->d_name.name);
276 kmem_cache_free(dentry_cache, dentry);
277}
278
279/*
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100280 * no locks, please.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 */
282static void d_free(struct dentry *dentry)
283{
Linus Torvalds0d984392013-09-08 13:46:52 -0700284 BUG_ON((int)dentry->d_lockref.count > 0);
Nick Piggin3e880fb2011-01-07 17:49:19 +1100285 this_cpu_dec(nr_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 if (dentry->d_op && dentry->d_op->d_release)
287 dentry->d_op->d_release(dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400288
Linus Torvaldsdea36672011-04-24 07:58:46 -0700289 /* if dentry was never visible to RCU, immediate free is OK */
290 if (!(dentry->d_flags & DCACHE_RCUACCESS))
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400291 __d_free(&dentry->d_u.d_rcu);
Eric Dumazetb3423412006-12-06 20:38:48 -0800292 else
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400293 call_rcu(&dentry->d_u.d_rcu, __d_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294}
295
Nick Piggin31e6b012011-01-07 17:49:52 +1100296/**
297 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800298 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100299 * After this call, in-progress rcu-walk path lookup will fail. This
300 * should be called after unhashing, and after changing d_inode (if
301 * the dentry has not already been unhashed).
302 */
303static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
304{
305 assert_spin_locked(&dentry->d_lock);
306 /* Go through a barrier */
307 write_seqcount_barrier(&dentry->d_seq);
308}
309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310/*
311 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100312 * d_iput() operation if defined. Dentry has no refcount
313 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800315static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200316 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100317 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
319 struct inode *inode = dentry->d_inode;
320 if (inode) {
321 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400322 hlist_del_init(&dentry->d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100324 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700325 if (!inode->i_nlink)
326 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 if (dentry->d_op && dentry->d_op->d_iput)
328 dentry->d_op->d_iput(dentry, inode);
329 else
330 iput(inode);
331 } else {
332 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 }
334}
335
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700336/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100337 * Release the dentry's inode, using the filesystem
338 * d_iput() operation if defined. dentry remains in-use.
339 */
340static void dentry_unlink_inode(struct dentry * dentry)
341 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100342 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100343{
344 struct inode *inode = dentry->d_inode;
345 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400346 hlist_del_init(&dentry->d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100347 dentry_rcuwalk_barrier(dentry);
348 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100349 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100350 if (!inode->i_nlink)
351 fsnotify_inoderemove(inode);
352 if (dentry->d_op && dentry->d_op->d_iput)
353 dentry->d_op->d_iput(dentry, inode);
354 else
355 iput(inode);
356}
357
358/*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000359 * dentry_lru_(add|del|move_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700360 */
361static void dentry_lru_add(struct dentry *dentry)
362{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700363 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST))) {
Dave Chinner19156842013-08-28 10:17:55 +1000364 spin_lock(&dentry->d_sb->s_dentry_lru_lock);
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700365 dentry->d_flags |= DCACHE_LRU_LIST;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400366 list_add(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
367 dentry->d_sb->s_nr_dentry_unused++;
Dave Chinner62d36c72013-08-28 10:17:54 +1000368 this_cpu_inc(nr_dentry_unused);
Dave Chinner19156842013-08-28 10:17:55 +1000369 spin_unlock(&dentry->d_sb->s_dentry_lru_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400370 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700371}
372
Nick Piggin23044502011-01-07 17:49:31 +1100373static void __dentry_lru_del(struct dentry *dentry)
374{
375 list_del_init(&dentry->d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000376 dentry->d_flags &= ~DCACHE_LRU_LIST;
Nick Piggin23044502011-01-07 17:49:31 +1100377 dentry->d_sb->s_nr_dentry_unused--;
Dave Chinner62d36c72013-08-28 10:17:54 +1000378 this_cpu_dec(nr_dentry_unused);
Nick Piggin23044502011-01-07 17:49:31 +1100379}
380
Sage Weilf0023bc2011-10-28 10:02:42 -0700381/*
382 * Remove a dentry with references from the LRU.
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000383 *
384 * If we are on the shrink list, then we can get to try_prune_one_dentry() and
385 * lose our last reference through the parent walk. In this case, we need to
386 * remove ourselves from the shrink list, not the LRU.
Sage Weilf0023bc2011-10-28 10:02:42 -0700387 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700388static void dentry_lru_del(struct dentry *dentry)
389{
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000390 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
391 list_del_init(&dentry->d_lru);
392 dentry->d_flags &= ~DCACHE_SHRINK_LIST;
393 return;
394 }
395
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700396 if (!list_empty(&dentry->d_lru)) {
Dave Chinner19156842013-08-28 10:17:55 +1000397 spin_lock(&dentry->d_sb->s_dentry_lru_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100398 __dentry_lru_del(dentry);
Dave Chinner19156842013-08-28 10:17:55 +1000399 spin_unlock(&dentry->d_sb->s_dentry_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700400 }
401}
402
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000403static void dentry_lru_move_list(struct dentry *dentry, struct list_head *list)
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700404{
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000405 BUG_ON(dentry->d_flags & DCACHE_SHRINK_LIST);
406
Dave Chinner19156842013-08-28 10:17:55 +1000407 spin_lock(&dentry->d_sb->s_dentry_lru_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400408 if (list_empty(&dentry->d_lru)) {
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700409 dentry->d_flags |= DCACHE_LRU_LIST;
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000410 list_add_tail(&dentry->d_lru, list);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400411 } else {
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000412 list_move_tail(&dentry->d_lru, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000413 dentry->d_sb->s_nr_dentry_unused--;
414 this_cpu_dec(nr_dentry_unused);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700415 }
Dave Chinner19156842013-08-28 10:17:55 +1000416 spin_unlock(&dentry->d_sb->s_dentry_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700417}
418
Miklos Szeredid52b9082007-05-08 00:23:46 -0700419/**
420 * d_kill - kill dentry and return parent
421 * @dentry: dentry to kill
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800422 * @parent: parent dentry
Miklos Szeredid52b9082007-05-08 00:23:46 -0700423 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200424 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700425 *
426 * If this is the root of the dentry tree, return NULL.
Nick Piggin23044502011-01-07 17:49:31 +1100427 *
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100428 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
429 * d_kill.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700430 */
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100431static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200432 __releases(dentry->d_lock)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100433 __releases(parent->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100434 __releases(dentry->d_inode->i_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700435{
Miklos Szeredid52b9082007-05-08 00:23:46 -0700436 list_del(&dentry->d_u.d_child);
Trond Myklebustc83ce982011-03-15 13:36:43 -0400437 /*
438 * Inform try_to_ascend() that we are no longer attached to the
439 * dentry tree
440 */
Miklos Szeredib161dfa62012-09-17 22:31:38 +0200441 dentry->d_flags |= DCACHE_DENTRY_KILLED;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100442 if (parent)
443 spin_unlock(&parent->d_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700444 dentry_iput(dentry);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100445 /*
446 * dentry_iput drops the locks, at which point nobody (except
447 * transient RCU lookups) can reach this dentry.
448 */
Miklos Szeredid52b9082007-05-08 00:23:46 -0700449 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900450 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700451}
452
David Howellsc6627c62011-06-07 14:09:20 +0100453/*
454 * Unhash a dentry without inserting an RCU walk barrier or checking that
455 * dentry->d_lock is locked. The caller must take care of that, if
456 * appropriate.
457 */
458static void __d_shrink(struct dentry *dentry)
459{
460 if (!d_unhashed(dentry)) {
461 struct hlist_bl_head *b;
462 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
463 b = &dentry->d_sb->s_anon;
464 else
465 b = d_hash(dentry->d_parent, dentry->d_name.hash);
466
467 hlist_bl_lock(b);
468 __hlist_bl_del(&dentry->d_hash);
469 dentry->d_hash.pprev = NULL;
470 hlist_bl_unlock(b);
471 }
472}
473
Nick Piggin789680d2011-01-07 17:49:30 +1100474/**
475 * d_drop - drop a dentry
476 * @dentry: dentry to drop
477 *
478 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
479 * be found through a VFS lookup any more. Note that this is different from
480 * deleting the dentry - d_delete will try to mark the dentry negative if
481 * possible, giving a successful _negative_ lookup, while d_drop will
482 * just make the cache lookup fail.
483 *
484 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
485 * reason (NFS timeouts or autofs deletes).
486 *
487 * __d_drop requires dentry->d_lock.
488 */
489void __d_drop(struct dentry *dentry)
490{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700491 if (!d_unhashed(dentry)) {
David Howellsc6627c62011-06-07 14:09:20 +0100492 __d_shrink(dentry);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700493 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100494 }
495}
496EXPORT_SYMBOL(__d_drop);
497
498void d_drop(struct dentry *dentry)
499{
Nick Piggin789680d2011-01-07 17:49:30 +1100500 spin_lock(&dentry->d_lock);
501 __d_drop(dentry);
502 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100503}
504EXPORT_SYMBOL(d_drop);
505
Nick Piggin77812a12011-01-07 17:49:48 +1100506/*
507 * Finish off a dentry we've decided to kill.
508 * dentry->d_lock must be held, returns with it unlocked.
509 * If ref is non-zero, then decrement the refcount too.
510 * Returns dentry requiring refcount drop, or NULL if we're done.
511 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000512static inline struct dentry *
513dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100514 __releases(dentry->d_lock)
515{
Nick Piggin873feea2011-01-07 17:50:06 +1100516 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100517 struct dentry *parent;
518
Nick Piggin873feea2011-01-07 17:50:06 +1100519 inode = dentry->d_inode;
520 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100521relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000522 if (unlock_on_failure) {
523 spin_unlock(&dentry->d_lock);
524 cpu_relax();
525 }
Nick Piggin77812a12011-01-07 17:49:48 +1100526 return dentry; /* try again with same dentry */
527 }
528 if (IS_ROOT(dentry))
529 parent = NULL;
530 else
531 parent = dentry->d_parent;
532 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100533 if (inode)
534 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100535 goto relock;
536 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100537
Linus Torvalds0d984392013-09-08 13:46:52 -0700538 /*
539 * The dentry is now unrecoverably dead to the world.
540 */
541 lockref_mark_dead(&dentry->d_lockref);
542
Sage Weilf0023bc2011-10-28 10:02:42 -0700543 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700544 * inform the fs via d_prune that this dentry is about to be
545 * unhashed and destroyed.
546 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800547 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800548 dentry->d_op->d_prune(dentry);
549
550 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100551 /* if it was on the hash then remove it */
552 __d_drop(dentry);
553 return d_kill(dentry, parent);
554}
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556/*
557 * This is dput
558 *
559 * This is complicated by the fact that we do not want to put
560 * dentries that are no longer on any hash chain on the unused
561 * list: we'd much rather just get rid of them immediately.
562 *
563 * However, that implies that we have to traverse the dentry
564 * tree upwards to the parents which might _also_ now be
565 * scheduled for deletion (it may have been only waiting for
566 * its last child to go away).
567 *
568 * This tail recursion is done by hand as we don't want to depend
569 * on the compiler to always get this right (gcc generally doesn't).
570 * Real recursion would eat up our stack space.
571 */
572
573/*
574 * dput - release a dentry
575 * @dentry: dentry to release
576 *
577 * Release a dentry. This will drop the usage count and if appropriate
578 * call the dentry unlink method as well as removing it from the queues and
579 * releasing its resources. If the parent dentries were scheduled for release
580 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582void dput(struct dentry *dentry)
583{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700584 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 return;
586
587repeat:
Waiman Long98474232013-08-28 18:24:59 -0700588 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700591 /* Unreachable? Get rid of it */
592 if (unlikely(d_unhashed(dentry)))
593 goto kill_it;
594
595 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100597 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 }
Nick Piggin265ac902010-10-10 05:36:24 -0400599
Jeff Layton39e3c952012-11-28 11:30:53 -0500600 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400601 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400602
Waiman Long98474232013-08-28 18:24:59 -0700603 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100604 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return;
606
Miklos Szeredid52b9082007-05-08 00:23:46 -0700607kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000608 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700609 if (dentry)
610 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700612EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614/**
615 * d_invalidate - invalidate a dentry
616 * @dentry: dentry to invalidate
617 *
618 * Try to invalidate the dentry if it turns out to be
619 * possible. If there are other dentries that can be
620 * reached through this one we can't delete it and we
621 * return -EBUSY. On success we return 0.
622 *
623 * no dcache lock.
624 */
625
626int d_invalidate(struct dentry * dentry)
627{
628 /*
629 * If it's already been dropped, return OK.
630 */
Nick Pigginda502952011-01-07 17:49:33 +1100631 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100633 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 return 0;
635 }
636 /*
637 * Check whether to do a partial shrink_dcache
638 * to get rid of unused child entries.
639 */
640 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100641 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100643 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 }
645
646 /*
647 * Somebody else still using it?
648 *
649 * If it's a directory, we can't drop it
650 * for fear of somebody re-populating it
651 * with children (even though dropping it
652 * would make it unreachable from the root,
653 * we might still populate it if it was a
654 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000655 * We also need to leave mountpoints alone,
656 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 */
Waiman Long98474232013-08-28 18:24:59 -0700658 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000659 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return -EBUSY;
662 }
663 }
664
665 __d_drop(dentry);
666 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return 0;
668}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700669EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100671/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100672static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673{
Waiman Long98474232013-08-28 18:24:59 -0700674 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
676
Nick Piggindc0474b2011-01-07 17:49:43 +1100677static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100678{
Waiman Long98474232013-08-28 18:24:59 -0700679 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100680}
681
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100682struct dentry *dget_parent(struct dentry *dentry)
683{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700684 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100685 struct dentry *ret;
686
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700687 /*
688 * Do optimistic parent lookup without any
689 * locking.
690 */
691 rcu_read_lock();
692 ret = ACCESS_ONCE(dentry->d_parent);
693 gotref = lockref_get_not_zero(&ret->d_lockref);
694 rcu_read_unlock();
695 if (likely(gotref)) {
696 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
697 return ret;
698 dput(ret);
699 }
700
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100701repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100702 /*
703 * Don't need rcu_dereference because we re-check it was correct under
704 * the lock.
705 */
706 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100707 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100708 spin_lock(&ret->d_lock);
709 if (unlikely(ret != dentry->d_parent)) {
710 spin_unlock(&ret->d_lock);
711 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100712 goto repeat;
713 }
Nick Piggina734eb42011-01-07 17:49:44 +1100714 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700715 BUG_ON(!ret->d_lockref.count);
716 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100717 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100718 return ret;
719}
720EXPORT_SYMBOL(dget_parent);
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722/**
723 * d_find_alias - grab a hashed alias of inode
724 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700725 * @want_discon: flag, used by d_splice_alias, to request
726 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 *
728 * If inode has a hashed alias, or is a directory and has any alias,
729 * acquire the reference to alias and return it. Otherwise return NULL.
730 * Notice that if inode is a directory there can be only one alias and
731 * it can be unhashed only if it has no children, or if it is the root
732 * of a filesystem.
733 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700734 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700735 * any other hashed alias over that one unless @want_discon is set,
736 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700738static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
Nick Pigginda502952011-01-07 17:49:33 +1100740 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Nick Pigginda502952011-01-07 17:49:33 +1100742again:
743 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800744 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100745 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700747 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100748 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700750 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100751 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100752 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 return alias;
754 }
755 }
Nick Pigginda502952011-01-07 17:49:33 +1100756 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 }
Nick Pigginda502952011-01-07 17:49:33 +1100758 if (discon_alias) {
759 alias = discon_alias;
760 spin_lock(&alias->d_lock);
761 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
762 if (IS_ROOT(alias) &&
763 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100764 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100765 spin_unlock(&alias->d_lock);
766 return alias;
767 }
768 }
769 spin_unlock(&alias->d_lock);
770 goto again;
771 }
772 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
Nick Pigginda502952011-01-07 17:49:33 +1100775struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
David Howells214fda12006-03-25 03:06:36 -0800777 struct dentry *de = NULL;
778
Al Virob3d9b7a2012-06-09 13:51:19 -0400779 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100780 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700781 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100782 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800783 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 return de;
785}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700786EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788/*
789 * Try to kill dentries associated with this inode.
790 * WARNING: you must own a reference to inode.
791 */
792void d_prune_aliases(struct inode *inode)
793{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700794 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100796 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800797 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700799 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800800 /*
801 * inform the fs via d_prune that this dentry
802 * is about to be unhashed and destroyed.
803 */
804 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
805 !d_unhashed(dentry))
806 dentry->d_op->d_prune(dentry);
807
Nick Piggindc0474b2011-01-07 17:49:43 +1100808 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 __d_drop(dentry);
810 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100811 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 dput(dentry);
813 goto restart;
814 }
815 spin_unlock(&dentry->d_lock);
816 }
Nick Piggin873feea2011-01-07 17:50:06 +1100817 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700819EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821/*
Nick Piggin77812a12011-01-07 17:49:48 +1100822 * Try to throw away a dentry - free the inode, dput the parent.
823 * Requires dentry->d_lock is held, and dentry->d_count == 0.
824 * Releases dentry->d_lock.
Andrew Mortond702ccb2006-06-22 14:47:31 -0700825 *
Nick Piggin77812a12011-01-07 17:49:48 +1100826 * This may fail if locks cannot be acquired no problem, just try again.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000828static struct dentry * try_prune_one_dentry(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200829 __releases(dentry->d_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Nick Piggin77812a12011-01-07 17:49:48 +1100831 struct dentry *parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700832
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000833 parent = dentry_kill(dentry, 0);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700834 /*
Nick Piggin77812a12011-01-07 17:49:48 +1100835 * If dentry_kill returns NULL, we have nothing more to do.
836 * if it returns the same dentry, trylocks failed. In either
837 * case, just loop again.
838 *
839 * Otherwise, we need to prune ancestors too. This is necessary
840 * to prevent quadratic behavior of shrink_dcache_parent(), but
841 * is also expected to be beneficial in reducing dentry cache
842 * fragmentation.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700843 */
Nick Piggin77812a12011-01-07 17:49:48 +1100844 if (!parent)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000845 return NULL;
Nick Piggin77812a12011-01-07 17:49:48 +1100846 if (parent == dentry)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000847 return dentry;
Nick Piggin77812a12011-01-07 17:49:48 +1100848
849 /* Prune ancestors. */
850 dentry = parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700851 while (dentry) {
Waiman Long98474232013-08-28 18:24:59 -0700852 if (lockref_put_or_lock(&dentry->d_lockref))
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000853 return NULL;
854 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700855 }
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000856 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857}
858
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400859static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700861 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700862
Nick Pigginec336792011-01-07 17:49:47 +1100863 rcu_read_lock();
864 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100865 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
866 if (&dentry->d_lru == list)
867 break; /* empty */
868 spin_lock(&dentry->d_lock);
869 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
870 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100871 continue;
872 }
873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000875 * The dispose list is isolated and dentries are not accounted
876 * to the LRU here, so we can simply remove it from the list
877 * here regardless of whether it is referenced or not.
878 */
879 list_del_init(&dentry->d_lru);
880 dentry->d_flags &= ~DCACHE_SHRINK_LIST;
881
882 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000884 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 */
Waiman Long98474232013-08-28 18:24:59 -0700886 if (dentry->d_lockref.count) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700887 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 continue;
889 }
Nick Pigginec336792011-01-07 17:49:47 +1100890 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100891
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000892 dentry = try_prune_one_dentry(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100893
Nick Pigginec336792011-01-07 17:49:47 +1100894 rcu_read_lock();
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000895 if (dentry) {
896 dentry->d_flags |= DCACHE_SHRINK_LIST;
897 list_add(&dentry->d_lru, list);
898 spin_unlock(&dentry->d_lock);
899 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 }
Nick Pigginec336792011-01-07 17:49:47 +1100901 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400902}
903
904/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000905 * prune_dcache_sb - shrink the dcache
906 * @sb: superblock
907 * @count: number of entries to try to free
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400908 *
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000909 * Attempt to shrink the superblock dcache LRU by @count entries. This is
910 * done when we need more memory an called from the superblock shrinker
911 * function.
912 *
913 * This function may fail to free any resources if all the dentries are in
914 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400915 */
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000916void prune_dcache_sb(struct super_block *sb, int count)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400917{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400918 struct dentry *dentry;
919 LIST_HEAD(referenced);
920 LIST_HEAD(tmp);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400921
Nick Piggin23044502011-01-07 17:49:31 +1100922relock:
Dave Chinner19156842013-08-28 10:17:55 +1000923 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400924 while (!list_empty(&sb->s_dentry_lru)) {
925 dentry = list_entry(sb->s_dentry_lru.prev,
926 struct dentry, d_lru);
927 BUG_ON(dentry->d_sb != sb);
928
Nick Piggin23044502011-01-07 17:49:31 +1100929 if (!spin_trylock(&dentry->d_lock)) {
Dave Chinner19156842013-08-28 10:17:55 +1000930 spin_unlock(&sb->s_dentry_lru_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100931 cpu_relax();
932 goto relock;
933 }
934
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000935 if (dentry->d_flags & DCACHE_REFERENCED) {
Nick Piggin23044502011-01-07 17:49:31 +1100936 dentry->d_flags &= ~DCACHE_REFERENCED;
937 list_move(&dentry->d_lru, &referenced);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400938 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100939 } else {
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000940 list_move(&dentry->d_lru, &tmp);
Miklos Szeredieaf5f902012-01-10 18:22:25 +0100941 dentry->d_flags |= DCACHE_SHRINK_LIST;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000942 this_cpu_dec(nr_dentry_unused);
943 sb->s_nr_dentry_unused--;
Nick Piggin23044502011-01-07 17:49:31 +1100944 spin_unlock(&dentry->d_lock);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000945 if (!--count)
Nick Piggin23044502011-01-07 17:49:31 +1100946 break;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400947 }
Dave Chinner19156842013-08-28 10:17:55 +1000948 cond_resched_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400949 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700950 if (!list_empty(&referenced))
951 list_splice(&referenced, &sb->s_dentry_lru);
Dave Chinner19156842013-08-28 10:17:55 +1000952 spin_unlock(&sb->s_dentry_lru_lock);
Nick Pigginec336792011-01-07 17:49:47 +1100953
954 shrink_dentry_list(&tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955}
956
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000957/*
958 * Mark all the dentries as on being the dispose list so we don't think they are
959 * still on the LRU if we try to kill them from ascending the parent chain in
960 * try_prune_one_dentry() rather than directly from the dispose list.
961 */
962static void
963shrink_dcache_list(
964 struct list_head *dispose)
965{
966 struct dentry *dentry;
967
968 rcu_read_lock();
969 list_for_each_entry_rcu(dentry, dispose, d_lru) {
970 spin_lock(&dentry->d_lock);
971 dentry->d_flags |= DCACHE_SHRINK_LIST;
972 spin_unlock(&dentry->d_lock);
973 }
974 rcu_read_unlock();
975 shrink_dentry_list(dispose);
976}
977
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700978/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 * shrink_dcache_sb - shrink dcache for a superblock
980 * @sb: superblock
981 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400982 * Shrink the dcache for the specified super block. This is used to free
983 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400985void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400987 LIST_HEAD(tmp);
988
Dave Chinner19156842013-08-28 10:17:55 +1000989 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400990 while (!list_empty(&sb->s_dentry_lru)) {
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000991 /*
992 * account for removal here so we don't need to handle it later
993 * even though the dentry is no longer on the lru list.
994 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400995 list_splice_init(&sb->s_dentry_lru, &tmp);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000996 this_cpu_sub(nr_dentry_unused, sb->s_nr_dentry_unused);
997 sb->s_nr_dentry_unused = 0;
Dave Chinner19156842013-08-28 10:17:55 +1000998 spin_unlock(&sb->s_dentry_lru_lock);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000999
1000 shrink_dcache_list(&tmp);
1001
Dave Chinner19156842013-08-28 10:17:55 +10001002 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001003 }
Dave Chinner19156842013-08-28 10:17:55 +10001004 spin_unlock(&sb->s_dentry_lru_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001006EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
1008/*
David Howellsc636ebd2006-10-11 01:22:19 -07001009 * destroy a single subtree of dentries for unmount
1010 * - see the comments on shrink_dcache_for_umount() for a description of the
1011 * locking
1012 */
1013static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
1014{
1015 struct dentry *parent;
1016
1017 BUG_ON(!IS_ROOT(dentry));
1018
David Howellsc636ebd2006-10-11 01:22:19 -07001019 for (;;) {
1020 /* descend to the first leaf in the current subtree */
David Howells43c1c9c2011-06-07 14:09:30 +01001021 while (!list_empty(&dentry->d_subdirs))
David Howellsc636ebd2006-10-11 01:22:19 -07001022 dentry = list_entry(dentry->d_subdirs.next,
1023 struct dentry, d_u.d_child);
David Howellsc636ebd2006-10-11 01:22:19 -07001024
1025 /* consume the dentries from this leaf up through its parents
1026 * until we find one with children or run out altogether */
1027 do {
1028 struct inode *inode;
1029
Sage Weilf0023bc2011-10-28 10:02:42 -07001030 /*
Yan, Zheng61572bb2013-04-15 14:13:21 +08001031 * inform the fs that this dentry is about to be
Sage Weilf0023bc2011-10-28 10:02:42 -07001032 * unhashed and destroyed.
1033 */
Yan, Zheng590fb512013-08-13 15:42:02 +08001034 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
1035 !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +08001036 dentry->d_op->d_prune(dentry);
1037
1038 dentry_lru_del(dentry);
David Howells43c1c9c2011-06-07 14:09:30 +01001039 __d_shrink(dentry);
1040
Waiman Long98474232013-08-28 18:24:59 -07001041 if (dentry->d_lockref.count != 0) {
David Howellsc636ebd2006-10-11 01:22:19 -07001042 printk(KERN_ERR
1043 "BUG: Dentry %p{i=%lx,n=%s}"
1044 " still in use (%d)"
1045 " [unmount of %s %s]\n",
1046 dentry,
1047 dentry->d_inode ?
1048 dentry->d_inode->i_ino : 0UL,
1049 dentry->d_name.name,
Waiman Long98474232013-08-28 18:24:59 -07001050 dentry->d_lockref.count,
David Howellsc636ebd2006-10-11 01:22:19 -07001051 dentry->d_sb->s_type->name,
1052 dentry->d_sb->s_id);
1053 BUG();
1054 }
1055
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001056 if (IS_ROOT(dentry)) {
David Howellsc636ebd2006-10-11 01:22:19 -07001057 parent = NULL;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001058 list_del(&dentry->d_u.d_child);
1059 } else {
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001060 parent = dentry->d_parent;
Waiman Long98474232013-08-28 18:24:59 -07001061 parent->d_lockref.count--;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001062 list_del(&dentry->d_u.d_child);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001063 }
David Howellsc636ebd2006-10-11 01:22:19 -07001064
David Howellsc636ebd2006-10-11 01:22:19 -07001065 inode = dentry->d_inode;
1066 if (inode) {
1067 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001068 hlist_del_init(&dentry->d_alias);
David Howellsc636ebd2006-10-11 01:22:19 -07001069 if (dentry->d_op && dentry->d_op->d_iput)
1070 dentry->d_op->d_iput(dentry, inode);
1071 else
1072 iput(inode);
1073 }
1074
1075 d_free(dentry);
1076
1077 /* finished when we fall off the top of the tree,
1078 * otherwise we ascend to the parent and move to the
1079 * next sibling if there is one */
1080 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001081 return;
David Howellsc636ebd2006-10-11 01:22:19 -07001082 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -07001083 } while (list_empty(&dentry->d_subdirs));
1084
1085 dentry = list_entry(dentry->d_subdirs.next,
1086 struct dentry, d_u.d_child);
1087 }
1088}
1089
1090/*
1091 * destroy the dentries attached to a superblock on unmounting
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001092 * - we don't need to use dentry->d_lock because:
David Howellsc636ebd2006-10-11 01:22:19 -07001093 * - the superblock is detached from all mountings and open files, so the
1094 * dentry trees will not be rearranged by the VFS
1095 * - s_umount is write-locked, so the memory pressure shrinker will ignore
1096 * any dentries belonging to this superblock that it comes across
1097 * - the filesystem itself is no longer permitted to rearrange the dentries
1098 * in this superblock
1099 */
1100void shrink_dcache_for_umount(struct super_block *sb)
1101{
1102 struct dentry *dentry;
1103
1104 if (down_read_trylock(&sb->s_umount))
1105 BUG();
1106
1107 dentry = sb->s_root;
1108 sb->s_root = NULL;
Waiman Long98474232013-08-28 18:24:59 -07001109 dentry->d_lockref.count--;
David Howellsc636ebd2006-10-11 01:22:19 -07001110 shrink_dcache_for_umount_subtree(dentry);
1111
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001112 while (!hlist_bl_empty(&sb->s_anon)) {
1113 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
David Howellsc636ebd2006-10-11 01:22:19 -07001114 shrink_dcache_for_umount_subtree(dentry);
1115 }
1116}
1117
1118/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001119 * This tries to ascend one level of parenthood, but
1120 * we can race with renaming, so we need to re-check
1121 * the parenthood after dropping the lock and check
1122 * that the sequence number still matches.
1123 */
Al Viro48f5ec22013-09-09 15:22:25 -04001124static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001125{
1126 struct dentry *new = old->d_parent;
1127
1128 rcu_read_lock();
1129 spin_unlock(&old->d_lock);
1130 spin_lock(&new->d_lock);
1131
1132 /*
1133 * might go back up the wrong parent if we have had a rename
1134 * or deletion
1135 */
1136 if (new != old->d_parent ||
Miklos Szeredib161dfa62012-09-17 22:31:38 +02001137 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001138 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001139 spin_unlock(&new->d_lock);
1140 new = NULL;
1141 }
1142 rcu_read_unlock();
1143 return new;
1144}
1145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001147 * enum d_walk_ret - action to talke during tree walk
1148 * @D_WALK_CONTINUE: contrinue walk
1149 * @D_WALK_QUIT: quit walk
1150 * @D_WALK_NORETRY: quit when retry is needed
1151 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001153enum d_walk_ret {
1154 D_WALK_CONTINUE,
1155 D_WALK_QUIT,
1156 D_WALK_NORETRY,
1157 D_WALK_SKIP,
1158};
1159
1160/**
1161 * d_walk - walk the dentry tree
1162 * @parent: start of walk
1163 * @data: data passed to @enter() and @finish()
1164 * @enter: callback when first entering the dentry
1165 * @finish: callback when successfully finished the walk
1166 *
1167 * The @enter() and @finish() callbacks are called with d_lock held.
1168 */
1169static void d_walk(struct dentry *parent, void *data,
1170 enum d_walk_ret (*enter)(void *, struct dentry *),
1171 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172{
Nick Piggin949854d2011-01-07 17:49:37 +11001173 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001175 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001176 enum d_walk_ret ret;
1177 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001178
Nick Piggin58db63d2011-01-07 17:49:39 +11001179again:
Al Viro48f5ec22013-09-09 15:22:25 -04001180 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001181 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001182 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001183
1184 ret = enter(data, this_parent);
1185 switch (ret) {
1186 case D_WALK_CONTINUE:
1187 break;
1188 case D_WALK_QUIT:
1189 case D_WALK_SKIP:
1190 goto out_unlock;
1191 case D_WALK_NORETRY:
1192 retry = false;
1193 break;
1194 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195repeat:
1196 next = this_parent->d_subdirs.next;
1197resume:
1198 while (next != &this_parent->d_subdirs) {
1199 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001200 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001202
1203 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001204
1205 ret = enter(data, dentry);
1206 switch (ret) {
1207 case D_WALK_CONTINUE:
1208 break;
1209 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001210 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 goto out_unlock;
1212 case D_WALK_NORETRY:
1213 retry = false;
1214 break;
1215 case D_WALK_SKIP:
1216 spin_unlock(&dentry->d_lock);
1217 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001218 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001219
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001221 spin_unlock(&this_parent->d_lock);
1222 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001224 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 goto repeat;
1226 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001227 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 }
1229 /*
1230 * All done at this level ... ascend and resume the search.
1231 */
1232 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001233 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001234 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001235 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001236 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001237 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 goto resume;
1239 }
Al Viro48f5ec22013-09-09 15:22:25 -04001240 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001241 spin_unlock(&this_parent->d_lock);
1242 goto rename_retry;
1243 }
1244 if (finish)
1245 finish(data);
1246
1247out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001248 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001249 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001250 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001251
1252rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001253 if (!retry)
1254 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001255 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001256 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001258
1259/*
1260 * Search for at least 1 mount point in the dentry's subdirs.
1261 * We descend to the next level whenever the d_subdirs
1262 * list is non-empty and continue searching.
1263 */
1264
1265/**
1266 * have_submounts - check for mounts over a dentry
1267 * @parent: dentry to check.
1268 *
1269 * Return true if the parent or its subdirectories contain
1270 * a mount point
1271 */
1272
1273static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1274{
1275 int *ret = data;
1276 if (d_mountpoint(dentry)) {
1277 *ret = 1;
1278 return D_WALK_QUIT;
1279 }
1280 return D_WALK_CONTINUE;
1281}
1282
1283int have_submounts(struct dentry *parent)
1284{
1285 int ret = 0;
1286
1287 d_walk(parent, &ret, check_mount, NULL);
1288
1289 return ret;
1290}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001291EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001294 * Called by mount code to set a mountpoint and check if the mountpoint is
1295 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1296 * subtree can become unreachable).
1297 *
1298 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1299 * this reason take rename_lock and d_lock on dentry and ancestors.
1300 */
1301int d_set_mounted(struct dentry *dentry)
1302{
1303 struct dentry *p;
1304 int ret = -ENOENT;
1305 write_seqlock(&rename_lock);
1306 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1307 /* Need exclusion wrt. check_submounts_and_drop() */
1308 spin_lock(&p->d_lock);
1309 if (unlikely(d_unhashed(p))) {
1310 spin_unlock(&p->d_lock);
1311 goto out;
1312 }
1313 spin_unlock(&p->d_lock);
1314 }
1315 spin_lock(&dentry->d_lock);
1316 if (!d_unlinked(dentry)) {
1317 dentry->d_flags |= DCACHE_MOUNTED;
1318 ret = 0;
1319 }
1320 spin_unlock(&dentry->d_lock);
1321out:
1322 write_sequnlock(&rename_lock);
1323 return ret;
1324}
1325
1326/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001327 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 * and move any unused dentries to the end of the unused
1329 * list for prune_dcache(). We descend to the next level
1330 * whenever the d_subdirs list is non-empty and continue
1331 * searching.
1332 *
1333 * It returns zero iff there are no unused children,
1334 * otherwise it returns the number of children moved to
1335 * the end of the unused list. This may not be the total
1336 * number of unused children, because select_parent can
1337 * drop the lock and return early due to latency
1338 * constraints.
1339 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001340
1341struct select_data {
1342 struct dentry *start;
1343 struct list_head dispose;
1344 int found;
1345};
1346
1347static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001349 struct select_data *data = _data;
1350 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001352 if (data->start == dentry)
1353 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001355 /*
1356 * move only zero ref count dentries to the dispose list.
1357 *
1358 * Those which are presently on the shrink list, being processed
1359 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1360 * loop in shrink_dcache_parent() might not make any progress
1361 * and loop forever.
1362 */
1363 if (dentry->d_lockref.count) {
1364 dentry_lru_del(dentry);
1365 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1366 dentry_lru_move_list(dentry, &data->dispose);
1367 dentry->d_flags |= DCACHE_SHRINK_LIST;
1368 data->found++;
1369 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 }
1371 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001372 * We can return to the caller if we have found some (this
1373 * ensures forward progress). We'll be coming back to find
1374 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001376 if (data->found && need_resched())
1377 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001379 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
1382/**
1383 * shrink_dcache_parent - prune dcache
1384 * @parent: parent of entries to prune
1385 *
1386 * Prune the dcache to remove unused children of the parent dentry.
1387 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001388void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001390 for (;;) {
1391 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001393 INIT_LIST_HEAD(&data.dispose);
1394 data.start = parent;
1395 data.found = 0;
1396
1397 d_walk(parent, &data, select_collect, NULL);
1398 if (!data.found)
1399 break;
1400
1401 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001402 cond_resched();
1403 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001405EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001407static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1408{
1409 struct select_data *data = _data;
1410
1411 if (d_mountpoint(dentry)) {
1412 data->found = -EBUSY;
1413 return D_WALK_QUIT;
1414 }
1415
1416 return select_collect(_data, dentry);
1417}
1418
1419static void check_and_drop(void *_data)
1420{
1421 struct select_data *data = _data;
1422
1423 if (d_mountpoint(data->start))
1424 data->found = -EBUSY;
1425 if (!data->found)
1426 __d_drop(data->start);
1427}
1428
1429/**
1430 * check_submounts_and_drop - prune dcache, check for submounts and drop
1431 *
1432 * All done as a single atomic operation relative to has_unlinked_ancestor().
1433 * Returns 0 if successfully unhashed @parent. If there were submounts then
1434 * return -EBUSY.
1435 *
1436 * @dentry: dentry to prune and drop
1437 */
1438int check_submounts_and_drop(struct dentry *dentry)
1439{
1440 int ret = 0;
1441
1442 /* Negative dentries can be dropped without further checks */
1443 if (!dentry->d_inode) {
1444 d_drop(dentry);
1445 goto out;
1446 }
1447
1448 for (;;) {
1449 struct select_data data;
1450
1451 INIT_LIST_HEAD(&data.dispose);
1452 data.start = dentry;
1453 data.found = 0;
1454
1455 d_walk(dentry, &data, check_and_collect, check_and_drop);
1456 ret = data.found;
1457
1458 if (!list_empty(&data.dispose))
1459 shrink_dentry_list(&data.dispose);
1460
1461 if (ret <= 0)
1462 break;
1463
1464 cond_resched();
1465 }
1466
1467out:
1468 return ret;
1469}
1470EXPORT_SYMBOL(check_submounts_and_drop);
1471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472/**
Al Viroa4464db2011-07-07 15:03:58 -04001473 * __d_alloc - allocate a dcache entry
1474 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 * @name: qstr of the name
1476 *
1477 * Allocates a dentry. It returns %NULL if there is insufficient memory
1478 * available. On a success the dentry is returned. The name passed in is
1479 * copied and the copy passed in may be reused after this call.
1480 */
1481
Al Viroa4464db2011-07-07 15:03:58 -04001482struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483{
1484 struct dentry *dentry;
1485 char *dname;
1486
Mel Gormane12ba742007-10-16 01:25:52 -07001487 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 if (!dentry)
1489 return NULL;
1490
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001491 /*
1492 * We guarantee that the inline name is always NUL-terminated.
1493 * This way the memcpy() done by the name switching in rename
1494 * will still always have a NUL at the end, even if we might
1495 * be overwriting an internal NUL character
1496 */
1497 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 if (name->len > DNAME_INLINE_LEN-1) {
1499 dname = kmalloc(name->len + 1, GFP_KERNEL);
1500 if (!dname) {
1501 kmem_cache_free(dentry_cache, dentry);
1502 return NULL;
1503 }
1504 } else {
1505 dname = dentry->d_iname;
1506 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
1508 dentry->d_name.len = name->len;
1509 dentry->d_name.hash = name->hash;
1510 memcpy(dname, name->name, name->len);
1511 dname[name->len] = 0;
1512
Linus Torvalds6326c71f2012-05-21 16:14:04 -07001513 /* Make sure we always see the terminating NUL character */
1514 smp_wmb();
1515 dentry->d_name.name = dname;
1516
Waiman Long98474232013-08-28 18:24:59 -07001517 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001518 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001520 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001522 dentry->d_parent = dentry;
1523 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 dentry->d_op = NULL;
1525 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001526 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 INIT_LIST_HEAD(&dentry->d_lru);
1528 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001529 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001530 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001531 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Nick Piggin3e880fb2011-01-07 17:49:19 +11001533 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 return dentry;
1536}
Al Viroa4464db2011-07-07 15:03:58 -04001537
1538/**
1539 * d_alloc - allocate a dcache entry
1540 * @parent: parent of entry to allocate
1541 * @name: qstr of the name
1542 *
1543 * Allocates a dentry. It returns %NULL if there is insufficient memory
1544 * available. On a success the dentry is returned. The name passed in is
1545 * copied and the copy passed in may be reused after this call.
1546 */
1547struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1548{
1549 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1550 if (!dentry)
1551 return NULL;
1552
1553 spin_lock(&parent->d_lock);
1554 /*
1555 * don't need child lock because it is not subject
1556 * to concurrency here
1557 */
1558 __dget_dlock(parent);
1559 dentry->d_parent = parent;
1560 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1561 spin_unlock(&parent->d_lock);
1562
1563 return dentry;
1564}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001565EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Nick Piggin4b936882011-01-07 17:50:07 +11001567struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1568{
Al Viroa4464db2011-07-07 15:03:58 -04001569 struct dentry *dentry = __d_alloc(sb, name);
1570 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001571 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001572 return dentry;
1573}
1574EXPORT_SYMBOL(d_alloc_pseudo);
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1577{
1578 struct qstr q;
1579
1580 q.name = name;
1581 q.len = strlen(name);
1582 q.hash = full_name_hash(q.name, q.len);
1583 return d_alloc(parent, &q);
1584}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001585EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Nick Pigginfb045ad2011-01-07 17:49:55 +11001587void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1588{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001589 WARN_ON_ONCE(dentry->d_op);
1590 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001591 DCACHE_OP_COMPARE |
1592 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001593 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001594 DCACHE_OP_DELETE ));
1595 dentry->d_op = op;
1596 if (!op)
1597 return;
1598 if (op->d_hash)
1599 dentry->d_flags |= DCACHE_OP_HASH;
1600 if (op->d_compare)
1601 dentry->d_flags |= DCACHE_OP_COMPARE;
1602 if (op->d_revalidate)
1603 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001604 if (op->d_weak_revalidate)
1605 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001606 if (op->d_delete)
1607 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001608 if (op->d_prune)
1609 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001610
1611}
1612EXPORT_SYMBOL(d_set_d_op);
1613
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001614static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1615{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001616 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001617 if (inode) {
1618 if (unlikely(IS_AUTOMOUNT(inode)))
1619 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001620 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001621 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001622 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001623 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001624 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001625 fsnotify_d_instantiate(dentry, inode);
1626}
1627
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628/**
1629 * d_instantiate - fill in inode information for a dentry
1630 * @entry: dentry to complete
1631 * @inode: inode to attach to this dentry
1632 *
1633 * Fill in inode information in the entry.
1634 *
1635 * This turns negative dentries into productive full members
1636 * of society.
1637 *
1638 * NOTE! This assumes that the inode count has been incremented
1639 * (or otherwise set) by the caller to indicate that it is now
1640 * in use by the dcache.
1641 */
1642
1643void d_instantiate(struct dentry *entry, struct inode * inode)
1644{
Al Virob3d9b7a2012-06-09 13:51:19 -04001645 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001646 if (inode)
1647 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001648 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001649 if (inode)
1650 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 security_d_instantiate(entry, inode);
1652}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001653EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655/**
1656 * d_instantiate_unique - instantiate a non-aliased dentry
1657 * @entry: dentry to instantiate
1658 * @inode: inode to attach to this dentry
1659 *
1660 * Fill in inode information in the entry. On success, it returns NULL.
1661 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001662 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 *
1664 * Note that in order to avoid conflicts with rename() etc, the caller
1665 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001666 *
1667 * This also assumes that the inode count has been incremented
1668 * (or otherwise set) by the caller to indicate that it is now
1669 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 */
David Howells770bfad2006-08-22 20:06:07 -04001671static struct dentry *__d_instantiate_unique(struct dentry *entry,
1672 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673{
1674 struct dentry *alias;
1675 int len = entry->d_name.len;
1676 const char *name = entry->d_name.name;
1677 unsigned int hash = entry->d_name.hash;
1678
David Howells770bfad2006-08-22 20:06:07 -04001679 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001680 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001681 return NULL;
1682 }
1683
Sasha Levinb67bfe02013-02-27 17:06:00 -08001684 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001685 /*
1686 * Don't need alias->d_lock here, because aliases with
1687 * d_parent == entry->d_parent are not subject to name or
1688 * parent changes, because the parent inode i_mutex is held.
1689 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001690 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 continue;
1692 if (alias->d_parent != entry->d_parent)
1693 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001694 if (alias->d_name.len != len)
1695 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001696 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001698 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 return alias;
1700 }
David Howells770bfad2006-08-22 20:06:07 -04001701
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001702 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 return NULL;
1704}
David Howells770bfad2006-08-22 20:06:07 -04001705
1706struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1707{
1708 struct dentry *result;
1709
Al Virob3d9b7a2012-06-09 13:51:19 -04001710 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001711
Nick Piggin873feea2011-01-07 17:50:06 +11001712 if (inode)
1713 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001714 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001715 if (inode)
1716 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001717
1718 if (!result) {
1719 security_d_instantiate(entry, inode);
1720 return NULL;
1721 }
1722
1723 BUG_ON(!d_unhashed(result));
1724 iput(inode);
1725 return result;
1726}
1727
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728EXPORT_SYMBOL(d_instantiate_unique);
1729
Al Viroadc0e91a2012-01-08 16:49:21 -05001730struct dentry *d_make_root(struct inode *root_inode)
1731{
1732 struct dentry *res = NULL;
1733
1734 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001735 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e91a2012-01-08 16:49:21 -05001736
1737 res = __d_alloc(root_inode->i_sb, &name);
1738 if (res)
1739 d_instantiate(res, root_inode);
1740 else
1741 iput(root_inode);
1742 }
1743 return res;
1744}
1745EXPORT_SYMBOL(d_make_root);
1746
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001747static struct dentry * __d_find_any_alias(struct inode *inode)
1748{
1749 struct dentry *alias;
1750
Al Virob3d9b7a2012-06-09 13:51:19 -04001751 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001752 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001753 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001754 __dget(alias);
1755 return alias;
1756}
1757
Sage Weil46f72b32012-01-10 09:04:37 -08001758/**
1759 * d_find_any_alias - find any alias for a given inode
1760 * @inode: inode to find an alias for
1761 *
1762 * If any aliases exist for the given inode, take and return a
1763 * reference for one of them. If no aliases exist, return %NULL.
1764 */
1765struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001766{
1767 struct dentry *de;
1768
1769 spin_lock(&inode->i_lock);
1770 de = __d_find_any_alias(inode);
1771 spin_unlock(&inode->i_lock);
1772 return de;
1773}
Sage Weil46f72b32012-01-10 09:04:37 -08001774EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001775
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001777 * d_obtain_alias - find or allocate a dentry for a given inode
1778 * @inode: inode to allocate the dentry for
1779 *
1780 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1781 * similar open by handle operations. The returned dentry may be anonymous,
1782 * or may have a full name (if the inode was already in the cache).
1783 *
1784 * When called on a directory inode, we must ensure that the inode only ever
1785 * has one dentry. If a dentry is found, that is returned instead of
1786 * allocating a new one.
1787 *
1788 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001789 * to the dentry. In case of an error the reference on the inode is released.
1790 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1791 * be passed in and will be the error will be propagate to the return value,
1792 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001793 */
1794struct dentry *d_obtain_alias(struct inode *inode)
1795{
NeilBrownb911a6b2012-11-08 16:09:37 -08001796 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001797 struct dentry *tmp;
1798 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001799
1800 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001801 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001802 if (IS_ERR(inode))
1803 return ERR_CAST(inode);
1804
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001805 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001806 if (res)
1807 goto out_iput;
1808
Al Viroa4464db2011-07-07 15:03:58 -04001809 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001810 if (!tmp) {
1811 res = ERR_PTR(-ENOMEM);
1812 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001813 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001814
Nick Piggin873feea2011-01-07 17:50:06 +11001815 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001816 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001817 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001818 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001819 dput(tmp);
1820 goto out_iput;
1821 }
1822
1823 /* attach a disconnected dentry */
1824 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001825 tmp->d_inode = inode;
1826 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001827 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001828 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001829 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001830 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001831 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001832 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001833 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001834
Christoph Hellwig9308a612008-08-11 15:49:12 +02001835 return tmp;
1836
1837 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001838 if (res && !IS_ERR(res))
1839 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001840 iput(inode);
1841 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001842}
Benny Halevyadc48722009-02-27 14:02:59 -08001843EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845/**
1846 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1847 * @inode: the inode which may have a disconnected dentry
1848 * @dentry: a negative dentry which we want to point to the inode.
1849 *
1850 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1851 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1852 * and return it, else simply d_add the inode to the dentry and return NULL.
1853 *
1854 * This is needed in the lookup routine of any filesystem that is exportable
1855 * (via knfsd) so that we can build dcache paths to directories effectively.
1856 *
1857 * If a dentry was found and moved, then it is returned. Otherwise NULL
1858 * is returned. This matches the expected return value of ->lookup.
1859 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001860 * Cluster filesystems may call this function with a negative, hashed dentry.
1861 * In that case, we know that the inode will be a regular file, and also this
1862 * will only occur during atomic_open. So we need to check for the dentry
1863 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 */
1865struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1866{
1867 struct dentry *new = NULL;
1868
Al Viroa9049372011-07-08 21:20:11 -04001869 if (IS_ERR(inode))
1870 return ERR_CAST(inode);
1871
NeilBrown21c0d8f2006-10-04 02:16:16 -07001872 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001873 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001874 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001876 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001877 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 d_move(new, dentry);
1880 iput(inode);
1881 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001882 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001883 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001884 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 security_d_instantiate(dentry, inode);
1886 d_rehash(dentry);
1887 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001888 } else {
1889 d_instantiate(dentry, inode);
1890 if (d_unhashed(dentry))
1891 d_rehash(dentry);
1892 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 return new;
1894}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001895EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
Barry Naujok94035402008-05-21 16:50:46 +10001897/**
1898 * d_add_ci - lookup or allocate new dentry with case-exact name
1899 * @inode: the inode case-insensitive lookup has found
1900 * @dentry: the negative dentry that was passed to the parent's lookup func
1901 * @name: the case-exact name to be associated with the returned dentry
1902 *
1903 * This is to avoid filling the dcache with case-insensitive names to the
1904 * same inode, only the actual correct case is stored in the dcache for
1905 * case-insensitive filesystems.
1906 *
1907 * For a case-insensitive lookup match and if the the case-exact dentry
1908 * already exists in in the dcache, use it and return it.
1909 *
1910 * If no entry exists with the exact case name, allocate new dentry with
1911 * the exact case, and return the spliced entry.
1912 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001913struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001914 struct qstr *name)
1915{
Barry Naujok94035402008-05-21 16:50:46 +10001916 struct dentry *found;
1917 struct dentry *new;
1918
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001919 /*
1920 * First check if a dentry matching the name already exists,
1921 * if not go ahead and create it now.
1922 */
Barry Naujok94035402008-05-21 16:50:46 +10001923 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001924 if (unlikely(IS_ERR(found)))
1925 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001926 if (!found) {
1927 new = d_alloc(dentry->d_parent, name);
1928 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001929 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001930 goto err_out;
1931 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001932
Barry Naujok94035402008-05-21 16:50:46 +10001933 found = d_splice_alias(inode, new);
1934 if (found) {
1935 dput(new);
1936 return found;
1937 }
1938 return new;
1939 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001940
1941 /*
1942 * If a matching dentry exists, and it's not negative use it.
1943 *
1944 * Decrement the reference count to balance the iget() done
1945 * earlier on.
1946 */
Barry Naujok94035402008-05-21 16:50:46 +10001947 if (found->d_inode) {
1948 if (unlikely(found->d_inode != inode)) {
1949 /* This can't happen because bad inodes are unhashed. */
1950 BUG_ON(!is_bad_inode(inode));
1951 BUG_ON(!is_bad_inode(found->d_inode));
1952 }
Barry Naujok94035402008-05-21 16:50:46 +10001953 iput(inode);
1954 return found;
1955 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001956
Barry Naujok94035402008-05-21 16:50:46 +10001957 /*
1958 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001959 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001960 */
Al Viro4513d892011-07-17 10:52:14 -04001961 new = d_splice_alias(inode, found);
1962 if (new) {
1963 dput(found);
1964 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001965 }
Al Viro4513d892011-07-17 10:52:14 -04001966 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001967
1968err_out:
1969 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001970 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001971}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001972EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001974/*
1975 * Do the slow-case of the dentry name compare.
1976 *
1977 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001978 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001979 * filesystem can rely on them, and can use the 'name' and
1980 * 'len' information without worrying about walking off the
1981 * end of memory etc.
1982 *
1983 * Thus the read_seqcount_retry() and the "duplicate" info
1984 * in arguments (the low-level filesystem should not look
1985 * at the dentry inode or name contents directly, since
1986 * rename can change them while we're in RCU mode).
1987 */
1988enum slow_d_compare {
1989 D_COMP_OK,
1990 D_COMP_NOMATCH,
1991 D_COMP_SEQRETRY,
1992};
1993
1994static noinline enum slow_d_compare slow_dentry_cmp(
1995 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001996 struct dentry *dentry,
1997 unsigned int seq,
1998 const struct qstr *name)
1999{
2000 int tlen = dentry->d_name.len;
2001 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002002
2003 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2004 cpu_relax();
2005 return D_COMP_SEQRETRY;
2006 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002007 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002008 return D_COMP_NOMATCH;
2009 return D_COMP_OK;
2010}
2011
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002013 * __d_lookup_rcu - search for a dentry (racy, store-free)
2014 * @parent: parent dentry
2015 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002016 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002017 * Returns: dentry, or NULL
2018 *
2019 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2020 * resolution (store-free path walking) design described in
2021 * Documentation/filesystems/path-lookup.txt.
2022 *
2023 * This is not to be used outside core vfs.
2024 *
2025 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2026 * held, and rcu_read_lock held. The returned dentry must not be stored into
2027 * without taking d_lock and checking d_seq sequence count against @seq
2028 * returned here.
2029 *
Linus Torvalds15570082013-09-02 11:38:06 -07002030 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002031 * function.
2032 *
2033 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2034 * the returned dentry, so long as its parent's seqlock is checked after the
2035 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2036 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002037 *
2038 * NOTE! The caller *has* to check the resulting dentry against the sequence
2039 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002040 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002041struct dentry *__d_lookup_rcu(const struct dentry *parent,
2042 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002043 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002044{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002045 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002046 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002047 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002048 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002049 struct dentry *dentry;
2050
2051 /*
2052 * Note: There is significant duplication with __d_lookup_rcu which is
2053 * required to prevent single threaded performance regressions
2054 * especially on architectures where smp_rmb (in seqcounts) are costly.
2055 * Keep the two functions in sync.
2056 */
2057
2058 /*
2059 * The hash list is protected using RCU.
2060 *
2061 * Carefully use d_seq when comparing a candidate dentry, to avoid
2062 * races with d_move().
2063 *
2064 * It is possible that concurrent renames can mess up our list
2065 * walk here and result in missing our dentry, resulting in the
2066 * false-negative result. d_lookup() protects against concurrent
2067 * renames using rename_lock seqlock.
2068 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002069 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002070 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002071 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002072 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002073
Nick Piggin31e6b012011-01-07 17:49:52 +11002074seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002075 /*
2076 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002077 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002078 *
2079 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002080 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002081 *
2082 * NOTE! We do a "raw" seqcount_begin here. That means that
2083 * we don't wait for the sequence count to stabilize if it
2084 * is in the middle of a sequence change. If we do the slow
2085 * dentry compare, we will do seqretries until it is stable,
2086 * and if we end up with a successful lookup, we actually
2087 * want to exit RCU lookup anyway.
2088 */
2089 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002090 if (dentry->d_parent != parent)
2091 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002092 if (d_unhashed(dentry))
2093 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002094
2095 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002096 if (dentry->d_name.hash != hashlen_hash(hashlen))
2097 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002098 *seqp = seq;
2099 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002100 case D_COMP_OK:
2101 return dentry;
2102 case D_COMP_NOMATCH:
2103 continue;
2104 default:
2105 goto seqretry;
2106 }
2107 }
2108
Linus Torvalds26fe5752012-05-10 13:14:12 -07002109 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002110 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002111 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002112 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002113 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002114 }
2115 return NULL;
2116}
2117
2118/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 * d_lookup - search for a dentry
2120 * @parent: parent dentry
2121 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002122 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002124 * d_lookup searches the children of the parent dentry for the name in
2125 * question. If the dentry is found its reference count is incremented and the
2126 * dentry is returned. The caller must use dput to free the entry when it has
2127 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 */
Al Viroda2d8452013-01-24 18:29:34 -05002129struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130{
Nick Piggin31e6b012011-01-07 17:49:52 +11002131 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002132 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
2134 do {
2135 seq = read_seqbegin(&rename_lock);
2136 dentry = __d_lookup(parent, name);
2137 if (dentry)
2138 break;
2139 } while (read_seqretry(&rename_lock, seq));
2140 return dentry;
2141}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002142EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
Nick Piggin31e6b012011-01-07 17:49:52 +11002144/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002145 * __d_lookup - search for a dentry (racy)
2146 * @parent: parent dentry
2147 * @name: qstr of name we wish to find
2148 * Returns: dentry, or NULL
2149 *
2150 * __d_lookup is like d_lookup, however it may (rarely) return a
2151 * false-negative result due to unrelated rename activity.
2152 *
2153 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2154 * however it must be used carefully, eg. with a following d_lookup in
2155 * the case of failure.
2156 *
2157 * __d_lookup callers must be commented.
2158 */
Al Viroa713ca2a2013-01-24 18:27:00 -05002159struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160{
2161 unsigned int len = name->len;
2162 unsigned int hash = name->hash;
2163 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002164 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002165 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002166 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002167 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
Nick Pigginb04f7842010-08-18 04:37:34 +10002169 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002170 * Note: There is significant duplication with __d_lookup_rcu which is
2171 * required to prevent single threaded performance regressions
2172 * especially on architectures where smp_rmb (in seqcounts) are costly.
2173 * Keep the two functions in sync.
2174 */
2175
2176 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002177 * The hash list is protected using RCU.
2178 *
2179 * Take d_lock when comparing a candidate dentry, to avoid races
2180 * with d_move().
2181 *
2182 * It is possible that concurrent renames can mess up our list
2183 * walk here and result in missing our dentry, resulting in the
2184 * false-negative result. d_lookup() protects against concurrent
2185 * renames using rename_lock seqlock.
2186 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002187 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002188 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 rcu_read_lock();
2190
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002191 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 if (dentry->d_name.hash != hash)
2194 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195
2196 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 if (dentry->d_parent != parent)
2198 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002199 if (d_unhashed(dentry))
2200 goto next;
2201
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 /*
2203 * It is safe to compare names since d_move() cannot
2204 * change the qstr (protected by d_lock).
2205 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002206 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002207 int tlen = dentry->d_name.len;
2208 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002209 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 goto next;
2211 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002212 if (dentry->d_name.len != len)
2213 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002214 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 goto next;
2216 }
2217
Waiman Long98474232013-08-28 18:24:59 -07002218 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002219 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 spin_unlock(&dentry->d_lock);
2221 break;
2222next:
2223 spin_unlock(&dentry->d_lock);
2224 }
2225 rcu_read_unlock();
2226
2227 return found;
2228}
2229
2230/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002231 * d_hash_and_lookup - hash the qstr then search for a dentry
2232 * @dir: Directory to search in
2233 * @name: qstr of name we wish to find
2234 *
Al Viro4f522a22013-02-11 23:20:37 -05002235 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002236 */
2237struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2238{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002239 /*
2240 * Check for a fs-specific hash function. Note that we must
2241 * calculate the standard hash first, as the d_op->d_hash()
2242 * routine may choose to leave the hash value unchanged.
2243 */
2244 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002245 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002246 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002247 if (unlikely(err < 0))
2248 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002249 }
Al Viro4f522a22013-02-11 23:20:37 -05002250 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002251}
Al Viro4f522a22013-02-11 23:20:37 -05002252EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002253
2254/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002255 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002257 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 *
2259 * An insecure source has sent us a dentry, here we verify it and dget() it.
2260 * This is used by ncpfs in its readdir implementation.
2261 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002262 *
2263 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002265int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266{
Nick Piggin786a5e12011-01-07 17:49:16 +11002267 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002268
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002269 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002270 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2271 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002272 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002273 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002274 spin_unlock(&dentry->d_lock);
2275 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 return 1;
2277 }
2278 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002279 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002280
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 return 0;
2282}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002283EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284
2285/*
2286 * When a file is deleted, we have two options:
2287 * - turn this dentry into a negative dentry
2288 * - unhash this dentry and free it.
2289 *
2290 * Usually, we want to just turn this into
2291 * a negative dentry, but if anybody else is
2292 * currently using the dentry or the inode
2293 * we can't do that and we fall back on removing
2294 * it from the hash queues and waiting for
2295 * it to be deleted later when it has no users
2296 */
2297
2298/**
2299 * d_delete - delete a dentry
2300 * @dentry: The dentry to delete
2301 *
2302 * Turn the dentry into a negative dentry if possible, otherwise
2303 * remove it from the hash queues so it can be deleted later
2304 */
2305
2306void d_delete(struct dentry * dentry)
2307{
Nick Piggin873feea2011-01-07 17:50:06 +11002308 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002309 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 /*
2311 * Are we the only user?
2312 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002313again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002315 inode = dentry->d_inode;
2316 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002317 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002318 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002319 spin_unlock(&dentry->d_lock);
2320 cpu_relax();
2321 goto again;
2322 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002323 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002324 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002325 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 return;
2327 }
2328
2329 if (!d_unhashed(dentry))
2330 __d_drop(dentry);
2331
2332 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002333
2334 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002336EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002338static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002340 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002341 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002342 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002343 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002344 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345}
2346
David Howells770bfad2006-08-22 20:06:07 -04002347static void _d_rehash(struct dentry * entry)
2348{
2349 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2350}
2351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352/**
2353 * d_rehash - add an entry back to the hash
2354 * @entry: dentry to add to the hash
2355 *
2356 * Adds a dentry to the hash according to its name.
2357 */
2358
2359void d_rehash(struct dentry * entry)
2360{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002362 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002365EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002367/**
2368 * dentry_update_name_case - update case insensitive dentry with a new name
2369 * @dentry: dentry to be updated
2370 * @name: new name
2371 *
2372 * Update a case insensitive dentry with new case of name.
2373 *
2374 * dentry must have been returned by d_lookup with name @name. Old and new
2375 * name lengths must match (ie. no d_compare which allows mismatched name
2376 * lengths).
2377 *
2378 * Parent inode i_mutex must be held over d_lookup and into this call (to
2379 * keep renames and concurrent inserts, and readdir(2) away).
2380 */
2381void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2382{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002383 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002384 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2385
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002386 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002387 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002388 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002389 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002390 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002391}
2392EXPORT_SYMBOL(dentry_update_name_case);
2393
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394static void switch_names(struct dentry *dentry, struct dentry *target)
2395{
2396 if (dname_external(target)) {
2397 if (dname_external(dentry)) {
2398 /*
2399 * Both external: swap the pointers
2400 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002401 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 } else {
2403 /*
2404 * dentry:internal, target:external. Steal target's
2405 * storage and make target internal.
2406 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002407 memcpy(target->d_iname, dentry->d_name.name,
2408 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 dentry->d_name.name = target->d_name.name;
2410 target->d_name.name = target->d_iname;
2411 }
2412 } else {
2413 if (dname_external(dentry)) {
2414 /*
2415 * dentry:external, target:internal. Give dentry's
2416 * storage to target and make dentry internal
2417 */
2418 memcpy(dentry->d_iname, target->d_name.name,
2419 target->d_name.len + 1);
2420 target->d_name.name = dentry->d_name.name;
2421 dentry->d_name.name = dentry->d_iname;
2422 } else {
2423 /*
2424 * Both are internal. Just copy target to dentry
2425 */
2426 memcpy(dentry->d_iname, target->d_name.name,
2427 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002428 dentry->d_name.len = target->d_name.len;
2429 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 }
2431 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002432 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433}
2434
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002435static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2436{
2437 /*
2438 * XXXX: do we really need to take target->d_lock?
2439 */
2440 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2441 spin_lock(&target->d_parent->d_lock);
2442 else {
2443 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2444 spin_lock(&dentry->d_parent->d_lock);
2445 spin_lock_nested(&target->d_parent->d_lock,
2446 DENTRY_D_LOCK_NESTED);
2447 } else {
2448 spin_lock(&target->d_parent->d_lock);
2449 spin_lock_nested(&dentry->d_parent->d_lock,
2450 DENTRY_D_LOCK_NESTED);
2451 }
2452 }
2453 if (target < dentry) {
2454 spin_lock_nested(&target->d_lock, 2);
2455 spin_lock_nested(&dentry->d_lock, 3);
2456 } else {
2457 spin_lock_nested(&dentry->d_lock, 2);
2458 spin_lock_nested(&target->d_lock, 3);
2459 }
2460}
2461
2462static void dentry_unlock_parents_for_move(struct dentry *dentry,
2463 struct dentry *target)
2464{
2465 if (target->d_parent != dentry->d_parent)
2466 spin_unlock(&dentry->d_parent->d_lock);
2467 if (target->d_parent != target)
2468 spin_unlock(&target->d_parent->d_lock);
2469}
2470
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002472 * When switching names, the actual string doesn't strictly have to
2473 * be preserved in the target - because we're dropping the target
2474 * anyway. As such, we can just do a simple memcpy() to copy over
2475 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002477 * Note that we have to be a lot more careful about getting the hash
2478 * switched - we have to switch the hash value properly even if it
2479 * then no longer matches the actual (corrupted) string of the target.
2480 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002482/*
Al Viro18367502011-07-12 21:42:24 -04002483 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 * @dentry: entry to move
2485 * @target: new dentry
2486 *
2487 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002488 * dcache entries should not be moved in this way. Caller must hold
2489 * rename_lock, the i_mutex of the source and target directories,
2490 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 */
Al Viro18367502011-07-12 21:42:24 -04002492static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 if (!dentry->d_inode)
2495 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2496
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002497 BUG_ON(d_ancestor(dentry, target));
2498 BUG_ON(d_ancestor(target, dentry));
2499
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002500 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501
Nick Piggin31e6b012011-01-07 17:49:52 +11002502 write_seqcount_begin(&dentry->d_seq);
2503 write_seqcount_begin(&target->d_seq);
2504
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002505 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2506
2507 /*
2508 * Move the dentry to the target hash queue. Don't bother checking
2509 * for the same hash queue because of how unlikely it is.
2510 */
2511 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002512 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513
2514 /* Unhash the target: dput() will then get rid of it */
2515 __d_drop(target);
2516
Eric Dumazet5160ee62006-01-08 01:03:32 -08002517 list_del(&dentry->d_u.d_child);
2518 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519
2520 /* Switch the names.. */
2521 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002522 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523
2524 /* ... and switch the parents */
2525 if (IS_ROOT(dentry)) {
2526 dentry->d_parent = target->d_parent;
2527 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002528 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002530 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531
2532 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002533 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 }
2535
Eric Dumazet5160ee62006-01-08 01:03:32 -08002536 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002537
Nick Piggin31e6b012011-01-07 17:49:52 +11002538 write_seqcount_end(&target->d_seq);
2539 write_seqcount_end(&dentry->d_seq);
2540
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002541 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002543 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002545}
2546
2547/*
2548 * d_move - move a dentry
2549 * @dentry: entry to move
2550 * @target: new dentry
2551 *
2552 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002553 * dcache entries should not be moved in this way. See the locking
2554 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002555 */
2556void d_move(struct dentry *dentry, struct dentry *target)
2557{
2558 write_seqlock(&rename_lock);
2559 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002561}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002562EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002564/**
2565 * d_ancestor - search for an ancestor
2566 * @p1: ancestor dentry
2567 * @p2: child dentry
2568 *
2569 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2570 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002571 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002572struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002573{
2574 struct dentry *p;
2575
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002576 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002578 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002579 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002580 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002581}
2582
2583/*
2584 * This helper attempts to cope with remotely renamed directories
2585 *
2586 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002587 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002588 *
2589 * Note: If ever the locking in lock_rename() changes, then please
2590 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002591 */
Nick Piggin873feea2011-01-07 17:50:06 +11002592static struct dentry *__d_unalias(struct inode *inode,
2593 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002594{
2595 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002596 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002597
2598 /* If alias and dentry share a parent, then no extra locks required */
2599 if (alias->d_parent == dentry->d_parent)
2600 goto out_unalias;
2601
Trond Myklebust9eaef272006-10-21 10:24:20 -07002602 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002603 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2604 goto out_err;
2605 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2606 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2607 goto out_err;
2608 m2 = &alias->d_parent->d_inode->i_mutex;
2609out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002610 if (likely(!d_mountpoint(alias))) {
2611 __d_move(alias, dentry);
2612 ret = alias;
2613 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002614out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002615 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002616 if (m2)
2617 mutex_unlock(m2);
2618 if (m1)
2619 mutex_unlock(m1);
2620 return ret;
2621}
2622
2623/*
David Howells770bfad2006-08-22 20:06:07 -04002624 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2625 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002626 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002627 */
2628static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2629{
Al Viro740da422013-01-30 10:13:38 -05002630 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002631
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002632 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002633
Nick Piggin31e6b012011-01-07 17:49:52 +11002634 write_seqcount_begin(&dentry->d_seq);
2635 write_seqcount_begin(&anon->d_seq);
2636
David Howells770bfad2006-08-22 20:06:07 -04002637 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002638
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002639 switch_names(dentry, anon);
2640 swap(dentry->d_name.hash, anon->d_name.hash);
2641
Al Viro740da422013-01-30 10:13:38 -05002642 dentry->d_parent = dentry;
2643 list_del_init(&dentry->d_u.d_child);
2644 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002645 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002646
Nick Piggin31e6b012011-01-07 17:49:52 +11002647 write_seqcount_end(&dentry->d_seq);
2648 write_seqcount_end(&anon->d_seq);
2649
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002650 dentry_unlock_parents_for_move(anon, dentry);
2651 spin_unlock(&dentry->d_lock);
2652
2653 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002654 anon->d_flags &= ~DCACHE_DISCONNECTED;
2655}
2656
2657/**
2658 * d_materialise_unique - introduce an inode into the tree
2659 * @dentry: candidate dentry
2660 * @inode: inode to bind to the dentry, to which aliases may be attached
2661 *
2662 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002663 * root directory alias in its place if there is one. Caller must hold the
2664 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002665 */
2666struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2667{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002668 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002669
2670 BUG_ON(!d_unhashed(dentry));
2671
David Howells770bfad2006-08-22 20:06:07 -04002672 if (!inode) {
2673 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002674 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002675 d_rehash(actual);
2676 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002677 }
2678
Nick Piggin873feea2011-01-07 17:50:06 +11002679 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002680
Trond Myklebust9eaef272006-10-21 10:24:20 -07002681 if (S_ISDIR(inode->i_mode)) {
2682 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002683
Trond Myklebust9eaef272006-10-21 10:24:20 -07002684 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002685 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002686 if (alias) {
2687 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002688 write_seqlock(&rename_lock);
2689
2690 if (d_ancestor(alias, dentry)) {
2691 /* Check for loops */
2692 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002693 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002694 } else if (IS_ROOT(alias)) {
2695 /* Is this an anonymous mountpoint that we
2696 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002697 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002698 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002699 __d_drop(alias);
2700 goto found;
Al Viro18367502011-07-12 21:42:24 -04002701 } else {
2702 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002703 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002704 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002705 }
Al Viro18367502011-07-12 21:42:24 -04002706 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002707 if (IS_ERR(actual)) {
2708 if (PTR_ERR(actual) == -ELOOP)
2709 pr_warn_ratelimited(
2710 "VFS: Lookup of '%s' in %s %s"
2711 " would have caused loop\n",
2712 dentry->d_name.name,
2713 inode->i_sb->s_type->name,
2714 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002715 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002716 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002717 goto out_nolock;
2718 }
David Howells770bfad2006-08-22 20:06:07 -04002719 }
2720
2721 /* Add a unique reference */
2722 actual = __d_instantiate_unique(dentry, inode);
2723 if (!actual)
2724 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002725 else
2726 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002727
David Howells770bfad2006-08-22 20:06:07 -04002728 spin_lock(&actual->d_lock);
2729found:
2730 _d_rehash(actual);
2731 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002732 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002733out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002734 if (actual == dentry) {
2735 security_d_instantiate(dentry, inode);
2736 return NULL;
2737 }
2738
2739 iput(inode);
2740 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002741}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002742EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002743
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002744static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002745{
2746 *buflen -= namelen;
2747 if (*buflen < 0)
2748 return -ENAMETOOLONG;
2749 *buffer -= namelen;
2750 memcpy(*buffer, str, namelen);
2751 return 0;
2752}
2753
Waiman Long232d2d62013-09-09 12:18:13 -04002754/**
2755 * prepend_name - prepend a pathname in front of current buffer pointer
2756 * buffer: buffer pointer
2757 * buflen: allocated length of the buffer
2758 * name: name string and length qstr structure
2759 *
2760 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2761 * make sure that either the old or the new name pointer and length are
2762 * fetched. However, there may be mismatch between length and pointer.
2763 * The length cannot be trusted, we need to copy it byte-by-byte until
2764 * the length is reached or a null byte is found. It also prepends "/" at
2765 * the beginning of the name. The sequence number check at the caller will
2766 * retry it again when a d_move() does happen. So any garbage in the buffer
2767 * due to mismatched pointer and length will be discarded.
2768 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002769static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2770{
Waiman Long232d2d62013-09-09 12:18:13 -04002771 const char *dname = ACCESS_ONCE(name->name);
2772 u32 dlen = ACCESS_ONCE(name->len);
2773 char *p;
2774
2775 if (*buflen < dlen + 1)
2776 return -ENAMETOOLONG;
2777 *buflen -= dlen + 1;
2778 p = *buffer -= dlen + 1;
2779 *p++ = '/';
2780 while (dlen--) {
2781 char c = *dname++;
2782 if (!c)
2783 break;
2784 *p++ = c;
2785 }
2786 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002787}
2788
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002790 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002791 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002792 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002793 * @buffer: pointer to the end of the buffer
2794 * @buflen: pointer to buffer length
2795 *
Waiman Long232d2d62013-09-09 12:18:13 -04002796 * The function tries to write out the pathname without taking any lock other
2797 * than the RCU read lock to make sure that dentries won't go away. It only
2798 * checks the sequence number of the global rename_lock as any change in the
2799 * dentry's d_seq will be preceded by changes in the rename_lock sequence
2800 * number. If the sequence number had been change, it will restart the whole
2801 * pathname back-tracing sequence again. It performs a total of 3 trials of
2802 * lockless back-tracing sequences before falling back to take the
2803 * rename_lock.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002804 */
Al Viro02125a82011-12-05 08:43:34 -05002805static int prepend_path(const struct path *path,
2806 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002807 char **buffer, int *buflen)
2808{
2809 struct dentry *dentry = path->dentry;
2810 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002811 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002812 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002813 unsigned seq = 0;
2814 char *bptr;
2815 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002816
Al Viro48f5ec22013-09-09 15:22:25 -04002817 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002818restart:
2819 bptr = *buffer;
2820 blen = *buflen;
2821 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002822 while (dentry != root->dentry || vfsmnt != root->mnt) {
2823 struct dentry * parent;
2824
2825 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2826 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002827 if (mnt_has_parent(mnt)) {
2828 dentry = mnt->mnt_mountpoint;
2829 mnt = mnt->mnt_parent;
2830 vfsmnt = &mnt->mnt;
2831 continue;
2832 }
2833 /*
2834 * Filesystems needing to implement special "root names"
2835 * should do so with ->d_dname()
2836 */
2837 if (IS_ROOT(dentry) &&
2838 (dentry->d_name.len != 1 ||
2839 dentry->d_name.name[0] != '/')) {
2840 WARN(1, "Root dentry has weird name <%.*s>\n",
2841 (int) dentry->d_name.len,
2842 dentry->d_name.name);
2843 }
2844 if (!error)
2845 error = is_mounted(vfsmnt) ? 1 : 2;
2846 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002847 }
2848 parent = dentry->d_parent;
2849 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002850 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002851 if (error)
2852 break;
2853
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002854 dentry = parent;
2855 }
Al Viro48f5ec22013-09-09 15:22:25 -04002856 if (!(seq & 1))
2857 rcu_read_unlock();
2858 if (need_seqretry(&rename_lock, seq)) {
2859 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002860 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002861 }
Al Viro48f5ec22013-09-09 15:22:25 -04002862 done_seqretry(&rename_lock, seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002863
Waiman Long232d2d62013-09-09 12:18:13 -04002864 if (error >= 0 && bptr == *buffer) {
2865 if (--blen < 0)
2866 error = -ENAMETOOLONG;
2867 else
2868 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 }
Waiman Long232d2d62013-09-09 12:18:13 -04002870 *buffer = bptr;
2871 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002872 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002873}
2874
2875/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002876 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002877 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002878 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002879 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 * @buflen: buffer length
2881 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002882 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002884 * Returns a pointer into the buffer or an error code if the
2885 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002886 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002887 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002888 *
Al Viro02125a82011-12-05 08:43:34 -05002889 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 */
Al Viro02125a82011-12-05 08:43:34 -05002891char *__d_path(const struct path *path,
2892 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002893 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002895 char *res = buf + buflen;
2896 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002898 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002899 br_read_lock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002900 error = prepend_path(path, root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002901 br_read_unlock(&vfsmount_lock);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002902
Al Viro02125a82011-12-05 08:43:34 -05002903 if (error < 0)
2904 return ERR_PTR(error);
2905 if (error > 0)
2906 return NULL;
2907 return res;
2908}
2909
2910char *d_absolute_path(const struct path *path,
2911 char *buf, int buflen)
2912{
2913 struct path root = {};
2914 char *res = buf + buflen;
2915 int error;
2916
2917 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002918 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002919 error = prepend_path(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002920 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002921
2922 if (error > 1)
2923 error = -EINVAL;
2924 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002925 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002926 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927}
2928
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002929/*
2930 * same as __d_path but appends "(deleted)" for unlinked files.
2931 */
Al Viro02125a82011-12-05 08:43:34 -05002932static int path_with_deleted(const struct path *path,
2933 const struct path *root,
2934 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002935{
2936 prepend(buf, buflen, "\0", 1);
2937 if (d_unlinked(path->dentry)) {
2938 int error = prepend(buf, buflen, " (deleted)", 10);
2939 if (error)
2940 return error;
2941 }
2942
2943 return prepend_path(path, root, buf, buflen);
2944}
2945
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002946static int prepend_unreachable(char **buffer, int *buflen)
2947{
2948 return prepend(buffer, buflen, "(unreachable)", 13);
2949}
2950
Jan Bluncka03a8a702008-02-14 19:38:32 -08002951/**
2952 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002953 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002954 * @buf: buffer to return value in
2955 * @buflen: buffer length
2956 *
2957 * Convert a dentry into an ASCII path name. If the entry has been deleted
2958 * the string " (deleted)" is appended. Note that this is ambiguous.
2959 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002960 * Returns a pointer into the buffer or an error code if the path was
2961 * too long. Note: Callers should use the returned pointer, not the passed
2962 * in buffer, to use the name! The implementation often starts at an offset
2963 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002964 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002965 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002966 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002967char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002969 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002970 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002971 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002973 /*
2974 * We have various synthetic filesystems that never get mounted. On
2975 * these filesystems dentries are never used for lookup purposes, and
2976 * thus don't need to be hashed. They also don't need a name until a
2977 * user wants to identify the object in /proc/pid/fd/. The little hack
2978 * below allows us to generate a name for these objects on demand:
2979 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002980 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2981 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002982
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002983 get_fs_root(current->fs, &root);
Al Viro7ea600b2013-03-26 18:25:57 -04002984 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002985 error = path_with_deleted(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002986 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002987 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002988 res = ERR_PTR(error);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002989 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990 return res;
2991}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002992EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993
2994/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002995 * Helper function for dentry_operations.d_dname() members
2996 */
2997char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2998 const char *fmt, ...)
2999{
3000 va_list args;
3001 char temp[64];
3002 int sz;
3003
3004 va_start(args, fmt);
3005 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3006 va_end(args);
3007
3008 if (sz > sizeof(temp) || sz > buflen)
3009 return ERR_PTR(-ENAMETOOLONG);
3010
3011 buffer += buflen - sz;
3012 return memcpy(buffer, temp, sz);
3013}
3014
Al Viro118b2302013-08-24 12:08:17 -04003015char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3016{
3017 char *end = buffer + buflen;
3018 /* these dentries are never renamed, so d_lock is not needed */
3019 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003020 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003021 prepend(&end, &buflen, "/", 1))
3022 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003023 return end;
Al Viro118b2302013-08-24 12:08:17 -04003024}
3025
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003026/*
Ram Pai6092d042008-03-27 13:06:20 +01003027 * Write full pathname from the root of the filesystem into the buffer.
3028 */
Nick Pigginec2447c2011-01-07 17:49:29 +11003029static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003030{
Waiman Long232d2d62013-09-09 12:18:13 -04003031 char *end, *retval;
3032 int len, seq = 0;
3033 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003034
Al Viro48f5ec22013-09-09 15:22:25 -04003035 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003036restart:
3037 end = buf + buflen;
3038 len = buflen;
3039 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003040 if (buflen < 1)
3041 goto Elong;
3042 /* Get '/' right */
3043 retval = end-1;
3044 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003045 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003046 while (!IS_ROOT(dentry)) {
3047 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11003048 int error;
Ram Pai6092d042008-03-27 13:06:20 +01003049
Ram Pai6092d042008-03-27 13:06:20 +01003050 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003051 error = prepend_name(&end, &len, &dentry->d_name);
3052 if (error)
3053 break;
Ram Pai6092d042008-03-27 13:06:20 +01003054
3055 retval = end;
3056 dentry = parent;
3057 }
Al Viro48f5ec22013-09-09 15:22:25 -04003058 if (!(seq & 1))
3059 rcu_read_unlock();
3060 if (need_seqretry(&rename_lock, seq)) {
3061 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003062 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003063 }
3064 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003065 if (error)
3066 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003067 return retval;
3068Elong:
3069 return ERR_PTR(-ENAMETOOLONG);
3070}
Nick Pigginec2447c2011-01-07 17:49:29 +11003071
3072char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3073{
Waiman Long232d2d62013-09-09 12:18:13 -04003074 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003075}
3076EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003077
3078char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3079{
3080 char *p = NULL;
3081 char *retval;
3082
Al Viroc1031352010-06-06 22:31:14 -04003083 if (d_unlinked(dentry)) {
3084 p = buf + buflen;
3085 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3086 goto Elong;
3087 buflen++;
3088 }
3089 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003090 if (!IS_ERR(retval) && p)
3091 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003092 return retval;
3093Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003094 return ERR_PTR(-ENAMETOOLONG);
3095}
3096
3097/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003098 * NOTE! The user-level library version returns a
3099 * character pointer. The kernel system call just
3100 * returns the length of the buffer filled (which
3101 * includes the ending '\0' character), or a negative
3102 * error value. So libc would do something like
3103 *
3104 * char *getcwd(char * buf, size_t size)
3105 * {
3106 * int retval;
3107 *
3108 * retval = sys_getcwd(buf, size);
3109 * if (retval >= 0)
3110 * return buf;
3111 * errno = -retval;
3112 * return NULL;
3113 * }
3114 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003115SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003116{
Linus Torvalds552ce542007-02-13 12:08:18 -08003117 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003118 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08003119 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003120
3121 if (!page)
3122 return -ENOMEM;
3123
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02003124 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125
Linus Torvalds552ce542007-02-13 12:08:18 -08003126 error = -ENOENT;
Al Viro7ea600b2013-03-26 18:25:57 -04003127 br_read_lock(&vfsmount_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003128 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003129 unsigned long len;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003130 char *cwd = page + PAGE_SIZE;
3131 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003133 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003134 error = prepend_path(&pwd, &root, &cwd, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04003135 br_read_unlock(&vfsmount_lock);
Linus Torvalds552ce542007-02-13 12:08:18 -08003136
Al Viro02125a82011-12-05 08:43:34 -05003137 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003138 goto out;
3139
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003140 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003141 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003142 error = prepend_unreachable(&cwd, &buflen);
3143 if (error)
3144 goto out;
3145 }
3146
Linus Torvalds552ce542007-02-13 12:08:18 -08003147 error = -ERANGE;
3148 len = PAGE_SIZE + page - cwd;
3149 if (len <= size) {
3150 error = len;
3151 if (copy_to_user(buf, cwd, len))
3152 error = -EFAULT;
3153 }
Nick Piggin949854d2011-01-07 17:49:37 +11003154 } else {
Al Viro7ea600b2013-03-26 18:25:57 -04003155 br_read_unlock(&vfsmount_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
3158out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08003159 path_put(&pwd);
3160 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161 free_page((unsigned long) page);
3162 return error;
3163}
3164
3165/*
3166 * Test whether new_dentry is a subdirectory of old_dentry.
3167 *
3168 * Trivially implemented using the dcache structure
3169 */
3170
3171/**
3172 * is_subdir - is new dentry a subdirectory of old_dentry
3173 * @new_dentry: new dentry
3174 * @old_dentry: old dentry
3175 *
3176 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3177 * Returns 0 otherwise.
3178 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3179 */
3180
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003181int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182{
3183 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003184 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003186 if (new_dentry == old_dentry)
3187 return 1;
3188
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003189 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003192 /*
3193 * Need rcu_readlock to protect against the d_parent trashing
3194 * due to d_move
3195 */
3196 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003197 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003199 else
3200 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003201 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003203
3204 return result;
3205}
3206
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003207static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003209 struct dentry *root = data;
3210 if (dentry != root) {
3211 if (d_unhashed(dentry) || !dentry->d_inode)
3212 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003214 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3215 dentry->d_flags |= DCACHE_GENOCIDE;
3216 dentry->d_lockref.count--;
3217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003219 return D_WALK_CONTINUE;
3220}
Nick Piggin58db63d2011-01-07 17:49:39 +11003221
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003222void d_genocide(struct dentry *parent)
3223{
3224 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225}
3226
Al Viro60545d02013-06-07 01:20:27 -04003227void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228{
Al Viro60545d02013-06-07 01:20:27 -04003229 inode_dec_link_count(inode);
3230 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3231 !hlist_unhashed(&dentry->d_alias) ||
3232 !d_unlinked(dentry));
3233 spin_lock(&dentry->d_parent->d_lock);
3234 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3235 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3236 (unsigned long long)inode->i_ino);
3237 spin_unlock(&dentry->d_lock);
3238 spin_unlock(&dentry->d_parent->d_lock);
3239 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240}
Al Viro60545d02013-06-07 01:20:27 -04003241EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242
3243static __initdata unsigned long dhash_entries;
3244static int __init set_dhash_entries(char *str)
3245{
3246 if (!str)
3247 return 0;
3248 dhash_entries = simple_strtoul(str, &str, 0);
3249 return 1;
3250}
3251__setup("dhash_entries=", set_dhash_entries);
3252
3253static void __init dcache_init_early(void)
3254{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003255 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256
3257 /* If hashes are distributed across NUMA nodes, defer
3258 * hash allocation until vmalloc space is available.
3259 */
3260 if (hashdist)
3261 return;
3262
3263 dentry_hashtable =
3264 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003265 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266 dhash_entries,
3267 13,
3268 HASH_EARLY,
3269 &d_hash_shift,
3270 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003271 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003272 0);
3273
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003274 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003275 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276}
3277
Denis Cheng74bf17c2007-10-16 23:26:30 -07003278static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003280 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281
3282 /*
3283 * A constructor could be added for stable state like the lists,
3284 * but it is probably not worth it because of the cache nature
3285 * of the dcache.
3286 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003287 dentry_cache = KMEM_CACHE(dentry,
3288 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289
3290 /* Hash may have been set up in dcache_init_early */
3291 if (!hashdist)
3292 return;
3293
3294 dentry_hashtable =
3295 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003296 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297 dhash_entries,
3298 13,
3299 0,
3300 &d_hash_shift,
3301 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003302 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303 0);
3304
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003305 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003306 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307}
3308
3309/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003310struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003311EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313EXPORT_SYMBOL(d_genocide);
3314
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315void __init vfs_caches_init_early(void)
3316{
3317 dcache_init_early();
3318 inode_init_early();
3319}
3320
3321void __init vfs_caches_init(unsigned long mempages)
3322{
3323 unsigned long reserve;
3324
3325 /* Base hash sizes on available memory, with a reserve equal to
3326 150% of current kernel size */
3327
3328 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3329 mempages -= reserve;
3330
3331 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003332 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333
Denis Cheng74bf17c2007-10-16 23:26:30 -07003334 dcache_init();
3335 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003337 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338 bdev_cache_init();
3339 chrdev_init();
3340}